1 /*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22 /*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved.
25 * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
26 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
27 * Copyright (c) 2013 Steven Hartland. All rights reserved.
28 * Copyright (c) 2014 Integros [integros.com]
29 * Copyright 2017 Nexenta Systems, Inc.
30 * Copyright (c) 2017 Datto Inc.
31 */
32
33 #ifndef _LIBZFS_H
34 #define _LIBZFS_H
35
36 #include <assert.h>
37 #include <libnvpair.h>
38 #include <sys/mnttab.h>
39 #include <sys/param.h>
40 #include <sys/types.h>
41 #include <sys/varargs.h>
42 #include <sys/fs/zfs.h>
43 #include <sys/avl.h>
44 #include <ucred.h>
45 #include <libzfs_core.h>
46
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50
51 /*
52 * Miscellaneous ZFS constants
53 */
54 #define ZFS_MAXPROPLEN (2 * MAXPATHLEN)
55 #define ZPOOL_MAXPROPLEN MAXPATHLEN
56
57 /*
58 * libzfs errors
59 */
60 typedef enum zfs_error {
61 EZFS_SUCCESS = 0, /* no error -- success */
62 EZFS_NOMEM = 2000, /* out of memory */
63 EZFS_BADPROP, /* invalid property value */
64 EZFS_PROPREADONLY, /* cannot set readonly property */
65 EZFS_PROPTYPE, /* property does not apply to dataset type */
66 EZFS_PROPNONINHERIT, /* property is not inheritable */
67 EZFS_PROPSPACE, /* bad quota or reservation */
68 EZFS_BADTYPE, /* dataset is not of appropriate type */
69 EZFS_BUSY, /* pool or dataset is busy */
70 EZFS_EXISTS, /* pool or dataset already exists */
71 EZFS_NOENT, /* no such pool or dataset */
72 EZFS_BADSTREAM, /* bad backup stream */
73 EZFS_DSREADONLY, /* dataset is readonly */
74 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
75 EZFS_INVALIDNAME, /* invalid dataset name */
76 EZFS_BADRESTORE, /* unable to restore to destination */
77 EZFS_BADBACKUP, /* backup failed */
78 EZFS_BADTARGET, /* bad attach/detach/replace target */
79 EZFS_NODEVICE, /* no such device in pool */
80 EZFS_BADDEV, /* invalid device to add */
81 EZFS_NOREPLICAS, /* no valid replicas */
82 EZFS_RESILVERING, /* currently resilvering */
83 EZFS_BADVERSION, /* unsupported version */
84 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
85 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
86 EZFS_BADPATH, /* must be an absolute path */
87 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
88 EZFS_ZONED, /* used improperly in local zone */
89 EZFS_MOUNTFAILED, /* failed to mount dataset */
90 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
91 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
92 EZFS_SHARENFSFAILED, /* share(1M) failed */
93 EZFS_PERM, /* permission denied */
94 EZFS_NOSPC, /* out of space */
95 EZFS_FAULT, /* bad address */
96 EZFS_IO, /* I/O error */
97 EZFS_INTR, /* signal received */
98 EZFS_ISSPARE, /* device is a hot spare */
99 EZFS_INVALCONFIG, /* invalid vdev configuration */
100 EZFS_RECURSIVE, /* recursive dependency */
101 EZFS_NOHISTORY, /* no history object */
102 EZFS_POOLPROPS, /* couldn't retrieve pool props */
103 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
104 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
105 EZFS_NAMETOOLONG, /* dataset name is too long */
106 EZFS_OPENFAILED, /* open of device failed */
107 EZFS_NOCAP, /* couldn't get capacity */
108 EZFS_LABELFAILED, /* write of label failed */
109 EZFS_BADWHO, /* invalid permission who */
110 EZFS_BADPERM, /* invalid permission */
111 EZFS_BADPERMSET, /* invalid permission set name */
112 EZFS_NODELEGATION, /* delegated administration is disabled */
113 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
114 EZFS_SHARESMBFAILED, /* failed to share over smb */
115 EZFS_BADCACHE, /* bad cache file */
116 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
117 EZFS_VDEVNOTSUP, /* unsupported vdev type */
118 EZFS_NOTSUP, /* ops not supported on this dataset */
119 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
120 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
121 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
122 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
123 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
124 EZFS_PIPEFAILED, /* pipe create failed */
125 EZFS_THREADCREATEFAILED, /* thread create failed */
126 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
127 EZFS_SCRUBBING, /* currently scrubbing */
128 EZFS_NO_SCRUB, /* no active scrub */
129 EZFS_DIFF, /* general failure of zfs diff */
130 EZFS_DIFFDATA, /* bad zfs diff data */
131 EZFS_POOLREADONLY, /* pool is in read-only mode */
132 EZFS_PROPNOTSUP, /* property not supported */
133 EZFS_COSNOTFOUND, /* no matching CoS descriptor found */
134 EZFS_COSEXIST, /* CoS descriptor already exists */
135 EZFS_COSREF, /* CoS descriptor still referenced */
136 EZFS_WBCNOTSUP, /* 'feature@wbc' is not enabled */
137 EZFS_WBCCHILD, /* child ds has enabled WBC */
138 EZFS_WBCPARENT, /* parent ds has enabled WBC */
139 EZFS_WBCALREADY, /* WBC already enabled or disabled */
140 EZFS_WBCINPROGRESS, /* WBC is disabling */
141 EZFS_SCRUB_PAUSED, /* scrub currently paused */
142 EZFS_UNKNOWN
143 } zfs_error_t;
144
145 /*
146 * UEFI boot support parameters. When creating whole disk boot pool,
147 * zpool create should allow to create EFI System partition for UEFI boot
148 * program. In case of BIOS, the EFI System partition is not used
149 * even if it does exist.
150 */
151 typedef enum zpool_boot_label {
152 ZPOOL_NO_BOOT_LABEL = 0,
153 ZPOOL_CREATE_BOOT_LABEL,
154 ZPOOL_COPY_BOOT_LABEL
155 } zpool_boot_label_t;
156
157 /*
158 * The following data structures are all part
159 * of the zfs_allow_t data structure which is
160 * used for printing 'allow' permissions.
161 * It is a linked list of zfs_allow_t's which
162 * then contain avl tree's for user/group/sets/...
163 * and each one of the entries in those trees have
164 * avl tree's for the permissions they belong to and
165 * whether they are local,descendent or local+descendent
166 * permissions. The AVL trees are used primarily for
167 * sorting purposes, but also so that we can quickly find
168 * a given user and or permission.
169 */
170 typedef struct zfs_perm_node {
171 avl_node_t z_node;
172 char z_pname[MAXPATHLEN];
173 } zfs_perm_node_t;
174
175 typedef struct zfs_allow_node {
176 avl_node_t z_node;
177 char z_key[MAXPATHLEN]; /* name, such as joe */
178 avl_tree_t z_localdescend; /* local+descendent perms */
179 avl_tree_t z_local; /* local permissions */
180 avl_tree_t z_descend; /* descendent permissions */
181 } zfs_allow_node_t;
182
183 typedef struct zfs_allow {
184 struct zfs_allow *z_next;
185 char z_setpoint[MAXPATHLEN];
186 avl_tree_t z_sets;
187 avl_tree_t z_crperms;
188 avl_tree_t z_user;
189 avl_tree_t z_group;
190 avl_tree_t z_everyone;
191 } zfs_allow_t;
192
193 /*
194 * Basic handle types
195 */
196 typedef struct zfs_handle zfs_handle_t;
197 typedef struct zpool_handle zpool_handle_t;
198 typedef struct libzfs_handle libzfs_handle_t;
199
200 /*
201 * Library initialization
202 */
203 extern libzfs_handle_t *libzfs_init(void);
204 extern void libzfs_fini(libzfs_handle_t *);
205
206 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
207 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
208
209 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
210
211 extern void zfs_save_arguments(int argc, char **, char *, int);
212 extern int zpool_log_history(libzfs_handle_t *, const char *);
213
214 extern int libzfs_errno(libzfs_handle_t *);
215 extern const char *libzfs_error_action(libzfs_handle_t *);
216 extern const char *libzfs_error_description(libzfs_handle_t *);
217 extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
218 extern void libzfs_mnttab_init(libzfs_handle_t *);
219 extern void libzfs_mnttab_fini(libzfs_handle_t *);
220 extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
221 extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
222 struct mnttab *);
223 extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
224 const char *, const char *);
225 extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
226
227 /*
228 * Basic handle functions
229 */
230 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
231 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
232 extern void zpool_close(zpool_handle_t *);
233 extern const char *zpool_get_name(zpool_handle_t *);
234 extern int zpool_get_state(zpool_handle_t *);
235 extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
236 extern const char *zpool_pool_state_to_name(pool_state_t);
237 extern void zpool_free_handles(libzfs_handle_t *);
238 extern int zpool_standard_error(libzfs_handle_t *, int, const char *);
239
240 /*
241 * Iterate over all active pools in the system.
242 */
243 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
244 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
245 extern boolean_t zpool_skip_pool(const char *);
246
247 /*
248 * Functions to create and destroy pools
249 */
250 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
251 nvlist_t *, nvlist_t *);
252 extern int zpool_destroy(zpool_handle_t *, const char *);
253 extern int zpool_add(zpool_handle_t *, nvlist_t *);
254
255 typedef struct splitflags {
256 /* do not split, but return the config that would be split off */
257 int dryrun : 1;
258
259 /* after splitting, import the pool */
260 int import : 1;
261 } splitflags_t;
262
263 /*
264 * Functions to manipulate pool and vdev state
265 */
266 extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t);
267 extern int zpool_trim(zpool_handle_t *, boolean_t start, uint64_t rate);
268 extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
269 extern int zpool_reguid(zpool_handle_t *);
270 extern int zpool_reopen(zpool_handle_t *);
271
272 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
273 vdev_state_t *);
274 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
275 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
276 const char *, nvlist_t *, int);
277 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
278 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
279 extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
280 splitflags_t);
281
282 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
283 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
284 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
285
286 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
287 boolean_t *, boolean_t *, boolean_t *);
288 extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
289 boolean_t *, boolean_t *, boolean_t *);
290 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *,
291 zpool_boot_label_t, uint64_t, int *);
292
293 /*
294 * Functions to manage pool properties
295 */
296 extern int zpool_set_proplist(zpool_handle_t *, nvlist_t *);
297 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
298 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
299 size_t proplen, zprop_source_t *, boolean_t);
300 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
301 zprop_source_t *);
302
303 extern const char *zpool_prop_to_name(zpool_prop_t);
304 extern const char *zpool_prop_values(zpool_prop_t);
305
306 /*
307 * Pool health statistics.
308 */
309 typedef enum {
310 /*
311 * The following correspond to faults as defined in the (fault.fs.zfs.*)
312 * event namespace. Each is associated with a corresponding message ID.
313 */
314 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
315 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
316 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
317 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
318 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
319 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
320 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
321 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
322 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
323 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
324 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
325 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
326 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
327 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
328
329 /*
330 * If the pool has unsupported features but can still be opened in
331 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
332 * pool has unsupported features but cannot be opened at all, its
333 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
334 */
335 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
336 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
337
338 /*
339 * These faults have no corresponding message ID. At the time we are
340 * checking the status, the original reason for the FMA fault (I/O or
341 * checksum errors) has been lost.
342 */
343 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
344 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
345
346 /*
347 * The following are not faults per se, but still an error possibly
348 * requiring administrative attention. There is no corresponding
349 * message ID.
350 */
351 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
352 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
353 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
354 ZPOOL_STATUS_OFFLINE_DEV, /* device offline */
355 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
356
357 /*
358 * Finally, the following indicates a healthy pool.
359 */
360 ZPOOL_STATUS_OK
361 } zpool_status_t;
362
363 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
364 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
365 extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
366
367 /*
368 * Statistics and configuration functions.
369 */
370 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
371 extern nvlist_t *zpool_get_features(zpool_handle_t *);
372 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
373 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
374 extern boolean_t zpool_is_bootable(zpool_handle_t *);
375
376 /*
377 * Import and export functions
378 */
379 extern int zpool_export(zpool_handle_t *, boolean_t, boolean_t, const char *);
380 extern int zpool_export_force(zpool_handle_t *, boolean_t, const char *);
381 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
382 char *altroot);
383 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
384 nvlist_t *, int);
385 extern void zpool_print_unsup_feat(nvlist_t *config);
386
387 /*
388 * Search for pools to import
389 */
390
391 typedef struct importargs {
392 char **path; /* a list of paths to search */
393 int paths; /* number of paths to search */
394 char *poolname; /* name of a pool to find */
395 uint64_t guid; /* guid of a pool to find */
396 char *cachefile; /* cachefile to use for import */
397 int can_be_active : 1; /* can the pool be active? */
398 int unique : 1; /* does 'poolname' already exist? */
399 int exists : 1; /* set on return if pool already exists */
400 } importargs_t;
401
402 extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
403
404 /* legacy pool search routines */
405 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
406 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
407 char *, uint64_t);
408
409 /*
410 * Miscellaneous pool functions
411 */
412 struct zfs_cmd;
413
414 extern const char *zfs_history_event_names[];
415
416 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
417 boolean_t verbose);
418 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
419 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
420 extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
421 nvlist_t ***, uint_t *);
422 extern int zpool_stage_history(libzfs_handle_t *, const char *);
423 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
424 size_t len);
425 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
426 extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
427 extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
428 nvlist_t *);
429
430 /*
431 * Basic handle manipulations. These functions do not create or destroy the
432 * underlying datasets, only the references to them.
433 */
434 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
435 extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
436 extern void zfs_close(zfs_handle_t *);
437 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
438 extern const char *zfs_get_name(const zfs_handle_t *);
439 extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
440 extern const char *zfs_get_pool_name(const zfs_handle_t *);
441
442 /*
443 * Property management functions. Some functions are shared with the kernel,
444 * and are found in sys/fs/zfs.h.
445 */
446
447 /*
448 * zfs dataset property management
449 */
450 extern const char *zfs_prop_default_string(zfs_prop_t);
451 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
452 extern const char *zfs_prop_column_name(zfs_prop_t);
453 extern boolean_t zfs_prop_align_right(zfs_prop_t);
454
455 extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
456 nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *);
457
458 extern const char *zfs_prop_to_name(zfs_prop_t);
459 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
460 extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *);
461 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
462 zprop_source_t *, char *, size_t, boolean_t);
463 extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
464 boolean_t);
465 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
466 zprop_source_t *, char *, size_t);
467 extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
468 uint64_t *propvalue);
469 extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
470 char *propbuf, int proplen, boolean_t literal);
471 extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
472 uint64_t *propvalue);
473 extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
474 char *propbuf, int proplen, boolean_t literal);
475 extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
476 char *buf, size_t len);
477 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
478 extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
479 extern const char *zfs_prop_values(zfs_prop_t);
480 extern int zfs_prop_is_string(zfs_prop_t prop);
481 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
482 extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
483 extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
484
485
486 typedef struct zprop_list {
487 int pl_prop;
488 char *pl_user_prop;
489 struct zprop_list *pl_next;
490 boolean_t pl_all;
491 size_t pl_width;
492 size_t pl_recvd_width;
493 boolean_t pl_fixed;
494 } zprop_list_t;
495
496 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
497 boolean_t);
498 extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
499
500 #define ZFS_MOUNTPOINT_NONE "none"
501 #define ZFS_MOUNTPOINT_LEGACY "legacy"
502
503 #define ZFS_FEATURE_DISABLED "disabled"
504 #define ZFS_FEATURE_ENABLED "enabled"
505 #define ZFS_FEATURE_ACTIVE "active"
506
507 #define ZFS_UNSUPPORTED_INACTIVE "inactive"
508 #define ZFS_UNSUPPORTED_READONLY "readonly"
509
510 /*
511 * zpool property management
512 */
513 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
514 extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
515 size_t);
516 extern const char *zpool_prop_default_string(zpool_prop_t);
517 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
518 extern const char *zpool_prop_column_name(zpool_prop_t);
519 extern boolean_t zpool_prop_align_right(zpool_prop_t);
520
521 /*
522 * Functions to manage vdev properties
523 */
524 extern int vdev_set_proplist(zpool_handle_t *, const char *, nvlist_t *);
525 extern int vdev_get_proplist(libzfs_handle_t *, char *, zprop_list_t **);
526 extern int vdev_get_prop(zpool_handle_t *, const char *, vdev_prop_t,
527 char *, size_t len);
528
529 /*
530 * Functions to manage cos properties
531 */
532 extern int cos_alloc(zpool_handle_t *, char *, nvlist_t *);
533 extern int cos_free(zpool_handle_t *, char *, uint64_t, boolean_t);
534 extern int cos_list(zpool_handle_t *, nvlist_t **);
535 extern int cos_set_proplist(zpool_handle_t *, const char *, nvlist_t *);
536 extern int cos_get_proplist(libzfs_handle_t *, char *, zprop_list_t **);
537 extern int cos_get_prop(zpool_handle_t *, const char *, cos_prop_t, char *,
538 size_t, nvlist_t **);
539
540 /*
541 * Functions shared by zfs and zpool property management.
542 */
543 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
544 boolean_t ordered, zfs_type_t type);
545 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
546 zfs_type_t);
547 extern void zprop_free_list(zprop_list_t *);
548
549 #define ZFS_GET_NCOLS 5
550
551 typedef enum {
552 GET_COL_NONE,
553 GET_COL_NAME,
554 GET_COL_PROPERTY,
555 GET_COL_VALUE,
556 GET_COL_RECVD,
557 GET_COL_SOURCE
558 } zfs_get_column_t;
559
560 /*
561 * Functions for printing zfs or zpool properties
562 */
563 typedef struct zprop_get_cbdata {
564 int cb_sources;
565 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
566 int cb_colwidths[ZFS_GET_NCOLS + 1];
567 boolean_t cb_scripted;
568 boolean_t cb_literal;
569 boolean_t cb_first;
570 zprop_list_t *cb_proplist;
571 zfs_type_t cb_type;
572 } zprop_get_cbdata_t;
573
574 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
575 const char *, const char *, zprop_source_t, const char *,
576 const char *);
577 void vdev_print_one_property(const char *, const char *,
578 zprop_get_cbdata_t *, const char *, const char *);
579 void cos_print_one_property(const char *, const char *,
580 zprop_get_cbdata_t *, const char *, const char *);
581
582 /*
583 * Iterator functions.
584 */
585 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
586 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
587 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
588 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
589 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
590 extern int zfs_iter_autosnapshots(zfs_handle_t *, boolean_t, zfs_iter_f,
591 void *);
592 extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
593 extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
594 extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
595 extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
596
597 typedef struct get_all_cb {
598 zfs_handle_t **cb_handles;
599 size_t cb_alloc;
600 size_t cb_used;
601 boolean_t cb_verbose;
602 int (*cb_getone)(zfs_handle_t *, void *);
603 } get_all_cb_t;
604
605 void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
606 int libzfs_dataset_cmp(const void *, const void *);
607
608 /*
609 * Functions to create and destroy datasets.
610 */
611 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
612 nvlist_t *);
613 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
614 extern int zfs_check_krrp(libzfs_handle_t *, const char *);
615 extern int zfs_destroy_atomically(zfs_handle_t *, boolean_t);
616 extern int zfs_destroy(zfs_handle_t *, boolean_t);
617 extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
618 extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
619 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
620 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
621 extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
622 nvlist_t *props);
623 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
624 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
625
626 typedef struct sendflags {
627 /* print informational messages (ie, -v was specified) */
628 boolean_t verbose;
629
630 /* recursive send (ie, -R) */
631 boolean_t replicate;
632
633 /* for incrementals, do all intermediate snapshots */
634 boolean_t doall;
635
636 /* if dataset is a clone, do incremental from its origin */
637 boolean_t fromorigin;
638
639 /* do deduplication */
640 boolean_t dedup;
641
642 /* send properties (ie, -p) */
643 boolean_t props;
644
645 /* do not send (no-op, ie. -n) */
646 boolean_t dryrun;
647
648 /* do not send (just calculate exact send stream size, ie. -s */
649 boolean_t sendsize;
650
651 /* parsable verbose output (ie. -P) */
652 boolean_t parsable;
653
654 /* show progress (ie. -v) */
655 boolean_t progress;
656
657 /* large blocks (>128K) are permitted */
658 boolean_t largeblock;
659
660 /* WRITE_EMBEDDED records of type DATA are permitted */
661 boolean_t embed_data;
662
663 /* compressed WRITE records are permitted */
664 boolean_t compress;
665 } sendflags_t;
666
667 typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
668
669 extern int zfs_send(zfs_handle_t *, const char *, const char *,
670 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
671 extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
672 extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd,
673 const char *);
674 extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl,
675 const char *token);
676
677 extern int zfs_promote(zfs_handle_t *);
678 extern int zfs_hold(zfs_handle_t *, const char *, const char *,
679 boolean_t, int);
680 extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
681 extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
682 extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
683 extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
684
685 typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
686 uid_t rid, uint64_t space);
687
688 extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
689 zfs_userspace_cb_t, void *);
690
691 extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
692 extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
693
694 typedef struct recvflags {
695 /* print informational messages (ie, -v was specified) */
696 boolean_t verbose;
697
698 /* the destination is a prefix, not the exact fs (ie, -d) */
699 boolean_t isprefix;
700
701 /*
702 * Only the tail of the sent snapshot path is appended to the
703 * destination to determine the received snapshot name (ie, -e).
704 */
705 boolean_t istail;
706
707 /* do not actually do the recv, just check if it would work (ie, -n) */
708 boolean_t dryrun;
709
710 /* rollback/destroy filesystems as necessary (eg, -F) */
711 boolean_t force;
712
713 /* when force-receiving, do not destroy snapshots (ie, -K) */
714 boolean_t keepsnap;
715
716 /* set "canmount=off" on all modified filesystems */
717 boolean_t canmountoff;
718
719 /*
720 * Mark the file systems as "resumable" and do not destroy them if the
721 * receive is interrupted
722 */
723 boolean_t resumable;
724
725 /* byteswap flag is used internally; callers need not specify */
726 boolean_t byteswap;
727
728 /* do not mount file systems as they are extracted (private) */
729 boolean_t nomount;
730 } recvflags_t;
731
732 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
733 int, nvlist_t *, nvlist_t *, avl_tree_t *);
734
735 typedef enum diff_flags {
736 ZFS_DIFF_PARSEABLE = 0x1,
737 ZFS_DIFF_TIMESTAMP = 0x2,
738 ZFS_DIFF_CLASSIFY = 0x4
739 } diff_flags_t;
740
741 extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
742 int);
743
744 /*
745 * Miscellaneous functions.
746 */
747 extern const char *zfs_type_to_name(zfs_type_t);
748 extern void zfs_refresh_properties(zfs_handle_t *);
749 extern int zfs_name_valid(const char *, zfs_type_t);
750 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
751 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
752 zfs_type_t);
753 extern int zfs_spa_version(zfs_handle_t *, int *);
754 extern boolean_t zfs_bookmark_exists(const char *path);
755
756 /*
757 * Mount support functions.
758 */
759 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
760 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
761 extern int zfs_mount(zfs_handle_t *, const char *, int);
762 extern int zfs_unmount(zfs_handle_t *, const char *, int);
763 extern int zfs_unmountall(zfs_handle_t *, int);
764
765 /*
766 * Share support functions.
767 */
768 extern boolean_t zfs_is_shared(zfs_handle_t *);
769 extern int zfs_share(zfs_handle_t *);
770 extern int zfs_unshare(zfs_handle_t *);
771
772 /*
773 * Protocol-specific share support functions.
774 */
775 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
776 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
777 extern int zfs_share_nfs(zfs_handle_t *);
778 extern int zfs_share_smb(zfs_handle_t *);
779 extern int zfs_shareall(zfs_handle_t *);
780 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
781 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
782 extern int zfs_unshareall_nfs(zfs_handle_t *);
783 extern int zfs_unshareall_smb(zfs_handle_t *);
784 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
785 extern int zfs_unshareall(zfs_handle_t *);
786 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
787 void *, void *, int, zfs_share_op_t);
788
789 /*
790 * When dealing with nvlists, verify() is extremely useful
791 */
792 #ifdef NDEBUG
793 #define verify(EX) ((void)(EX))
794 #else
795 #define verify(EX) assert(EX)
796 #endif
797
798 /*
799 * Utility function to convert a number to a human-readable form.
800 */
801 extern void zfs_nicenum(uint64_t, char *, size_t);
802 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
803
804 /*
805 * Given a device or file, determine if it is part of a pool.
806 */
807 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
808 boolean_t *);
809
810 /*
811 * Label manipulation.
812 */
813 extern int zpool_read_label(int, nvlist_t **);
814 extern int zpool_clear_label(int);
815
816 /* is this zvol valid for use as a dump device? */
817 extern int zvol_check_dump_config(char *);
818
819 /*
820 * Management interfaces for SMB ACL files
821 */
822
823 int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
824 int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
825 int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
826 int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
827
828 /*
829 * Enable and disable datasets within a pool by mounting/unmounting and
830 * sharing/unsharing them.
831 */
832 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
833 extern int zpool_enable_datasets_ex(zpool_handle_t *, const char *, int, int);
834 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
835 extern int zpool_disable_datasets_ex(zpool_handle_t *, boolean_t, int);
836
837 /*
838 * Mappings between vdev and FRU.
839 */
840 extern void libzfs_fru_refresh(libzfs_handle_t *);
841 extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
842 extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
843 extern boolean_t libzfs_fru_cmp_enclosure(const char *a, const char *b);
844 extern int libzfs_fru_cmp_slot(libzfs_handle_t *, const char *, const char *,
845 size_t);
846 extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
847 const char *);
848 extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
849 extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
850
851 extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *);
852
853 /* Allow consumers to initialize libshare externally for optimal performance */
854 extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *);
855 /*
856 * For most consumers, zfs_init_libshare_arg is sufficient on its own, and
857 * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called
858 * if the caller has already initialized libshare for one set of zfs handles,
859 * and wishes to share or unshare filesystems outside of that set. In that case,
860 * the caller should uninitialize libshare, and then re-initialize it with the
861 * new handles being shared or unshared.
862 */
863 extern void zfs_uninit_libshare(libzfs_handle_t *);
864 #ifdef __cplusplus
865 }
866 #endif
867
868 #endif /* _LIBZFS_H */