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.
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.
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]
23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
30 #pragma ident "@(#)libzfs.h 1.51 08/04/01 SMI"
33 #include <libnvpair.h>
34 #include <sys/param.h>
35 #include <sys/types.h>
36 #include <sys/varargs.h>
37 #include <sys/fs/zfs.h>
46 * Miscellaneous ZFS constants
48 #define ZFS_MAXNAMELEN MAXNAMELEN
49 #define ZPOOL_MAXNAMELEN MAXNAMELEN
50 #define ZFS_MAXPROPLEN MAXPATHLEN
51 #define ZPOOL_MAXPROPLEN MAXPATHLEN
57 EZFS_NOMEM = 2000, /* out of memory */
58 EZFS_BADPROP, /* invalid property value */
59 EZFS_PROPREADONLY, /* cannot set readonly property */
60 EZFS_PROPTYPE, /* property does not apply to dataset type */
61 EZFS_PROPNONINHERIT, /* property is not inheritable */
62 EZFS_PROPSPACE, /* bad quota or reservation */
63 EZFS_BADTYPE, /* dataset is not of appropriate type */
64 EZFS_BUSY, /* pool or dataset is busy */
65 EZFS_EXISTS, /* pool or dataset already exists */
66 EZFS_NOENT, /* no such pool or dataset */
67 EZFS_BADSTREAM, /* bad backup stream */
68 EZFS_DSREADONLY, /* dataset is readonly */
69 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
70 EZFS_VOLHASDATA, /* volume already contains data */
71 EZFS_INVALIDNAME, /* invalid dataset name */
72 EZFS_BADRESTORE, /* unable to restore to destination */
73 EZFS_BADBACKUP, /* backup failed */
74 EZFS_BADTARGET, /* bad attach/detach/replace target */
75 EZFS_NODEVICE, /* no such device in pool */
76 EZFS_BADDEV, /* invalid device to add */
77 EZFS_NOREPLICAS, /* no valid replicas */
78 EZFS_RESILVERING, /* currently resilvering */
79 EZFS_BADVERSION, /* unsupported version */
80 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
81 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
82 EZFS_BADPATH, /* must be an absolute path */
83 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
84 EZFS_ZONED, /* used improperly in local zone */
85 EZFS_MOUNTFAILED, /* failed to mount dataset */
86 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
87 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
88 EZFS_SHARENFSFAILED, /* share(1M) failed */
89 EZFS_DEVLINKS, /* failed to create zvol links */
90 EZFS_PERM, /* permission denied */
91 EZFS_NOSPC, /* out of space */
92 EZFS_IO, /* I/O error */
93 EZFS_INTR, /* signal received */
94 EZFS_ISSPARE, /* device is a hot spare */
95 EZFS_INVALCONFIG, /* invalid vdev configuration */
96 EZFS_RECURSIVE, /* recursive dependency */
97 EZFS_NOHISTORY, /* no history object */
98 EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */
99 EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */
100 EZFS_POOLPROPS, /* couldn't retrieve pool props */
101 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
102 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
103 EZFS_NAMETOOLONG, /* dataset name is too long */
104 EZFS_OPENFAILED, /* open of device failed */
105 EZFS_NOCAP, /* couldn't get capacity */
106 EZFS_LABELFAILED, /* write of label failed */
107 EZFS_ISCSISVCUNAVAIL, /* iscsi service unavailable */
108 EZFS_BADWHO, /* invalid permission who */
109 EZFS_BADPERM, /* invalid permission */
110 EZFS_BADPERMSET, /* invalid permission set name */
111 EZFS_NODELEGATION, /* delegated administration is disabled */
112 EZFS_PERMRDONLY, /* pemissions are readonly */
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 */
122 * The following data structures are all part
123 * of the zfs_allow_t data structure which is
124 * used for printing 'allow' permissions.
125 * It is a linked list of zfs_allow_t's which
126 * then contain avl tree's for user/group/sets/...
127 * and each one of the entries in those trees have
128 * avl tree's for the permissions they belong to and
129 * whether they are local,descendent or local+descendent
130 * permissions. The AVL trees are used primarily for
131 * sorting purposes, but also so that we can quickly find
132 * a given user and or permission.
134 typedef struct zfs_perm_node {
136 char z_pname[MAXPATHLEN];
139 typedef struct zfs_allow_node {
141 char z_key[MAXPATHLEN]; /* name, such as joe */
142 avl_tree_t z_localdescend; /* local+descendent perms */
143 avl_tree_t z_local; /* local permissions */
144 avl_tree_t z_descend; /* descendent permissions */
147 typedef struct zfs_allow {
148 struct zfs_allow *z_next;
149 char z_setpoint[MAXPATHLEN];
151 avl_tree_t z_crperms;
154 avl_tree_t z_everyone;
160 typedef struct zfs_handle zfs_handle_t;
161 typedef struct zpool_handle zpool_handle_t;
162 typedef struct libzfs_handle libzfs_handle_t;
165 * Library initialization
167 extern libzfs_handle_t *libzfs_init(void);
168 extern void libzfs_fini(libzfs_handle_t *);
170 extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
171 extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
173 extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
175 extern int libzfs_errno(libzfs_handle_t *);
176 extern const char *libzfs_error_action(libzfs_handle_t *);
177 extern const char *libzfs_error_description(libzfs_handle_t *);
180 * Basic handle functions
182 extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
183 extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
184 extern void zpool_close(zpool_handle_t *);
185 extern const char *zpool_get_name(zpool_handle_t *);
186 extern int zpool_get_state(zpool_handle_t *);
187 extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
190 * Iterate over all active pools in the system.
192 typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
193 extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
196 * Functions to create and destroy pools
198 extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
200 extern int zpool_destroy(zpool_handle_t *);
201 extern int zpool_add(zpool_handle_t *, nvlist_t *);
204 * Functions to manipulate pool and vdev state
206 extern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
207 extern int zpool_clear(zpool_handle_t *, const char *);
209 extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
211 extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
212 extern int zpool_vdev_attach(zpool_handle_t *, const char *,
213 const char *, nvlist_t *, int);
214 extern int zpool_vdev_detach(zpool_handle_t *, const char *);
215 extern int zpool_vdev_remove(zpool_handle_t *, const char *);
217 extern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
218 extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
219 extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
221 extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
223 extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
226 * Functions to manage pool properties
228 extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
229 extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
230 size_t proplen, zprop_source_t *);
231 extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
234 extern const char *zpool_prop_to_name(zpool_prop_t);
235 extern const char *zpool_prop_values(zpool_prop_t);
238 * Pool health statistics.
242 * The following correspond to faults as defined in the (fault.fs.zfs.*)
243 * event namespace. Each is associated with a corresponding message ID.
245 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
246 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
247 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
248 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
249 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
250 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
251 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
252 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
253 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
254 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
255 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
256 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
257 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
260 * The following are not faults per se, but still an error possibly
261 * requiring administrative attention. There is no corresponding
264 ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
265 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
266 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
269 * Finally, the following indicates a healthy pool.
274 extern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
275 extern zpool_status_t zpool_import_status(nvlist_t *, char **);
278 * Statistics and configuration functions.
280 extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
281 extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
282 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
285 * Import and export functions
287 extern int zpool_export(zpool_handle_t *);
288 extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
290 extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
294 * Search for pools to import
296 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **, boolean_t);
297 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
301 * Miscellaneous pool functions
305 extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
306 extern int zpool_upgrade(zpool_handle_t *, uint64_t);
307 extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
308 extern void zpool_set_history_str(const char *subcommand, int argc,
309 char **argv, char *history_str);
310 extern int zpool_stage_history(libzfs_handle_t *, const char *);
311 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
313 extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
315 * Basic handle manipulations. These functions do not create or destroy the
316 * underlying datasets, only the references to them.
318 extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
319 extern void zfs_close(zfs_handle_t *);
320 extern zfs_type_t zfs_get_type(const zfs_handle_t *);
321 extern const char *zfs_get_name(const zfs_handle_t *);
324 * Property management functions. Some functions are shared with the kernel,
325 * and are found in sys/fs/zfs.h.
329 * zfs dataset property management
331 extern const char *zfs_prop_default_string(zfs_prop_t);
332 extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
333 extern const char *zfs_prop_column_name(zfs_prop_t);
334 extern boolean_t zfs_prop_align_right(zfs_prop_t);
336 extern const char *zfs_prop_to_name(zfs_prop_t);
337 extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
338 extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
339 zprop_source_t *, char *, size_t, boolean_t);
340 extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
341 zprop_source_t *, char *, size_t);
342 extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
343 extern int zfs_prop_inherit(zfs_handle_t *, const char *);
344 extern const char *zfs_prop_values(zfs_prop_t);
345 extern int zfs_prop_is_string(zfs_prop_t prop);
346 extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
348 typedef struct zprop_list {
351 struct zprop_list *pl_next;
357 extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **);
359 #define ZFS_MOUNTPOINT_NONE "none"
360 #define ZFS_MOUNTPOINT_LEGACY "legacy"
363 * zpool property management
365 extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
366 extern const char *zpool_prop_default_string(zpool_prop_t);
367 extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
368 extern const char *zpool_prop_column_name(zpool_prop_t);
369 extern boolean_t zpool_prop_align_right(zpool_prop_t);
372 * Functions shared by zfs and zpool property management.
374 extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
375 boolean_t ordered, zfs_type_t type);
376 extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
378 extern void zprop_free_list(zprop_list_t *);
381 * Functions for printing zfs or zpool properties
383 typedef struct zprop_get_cbdata {
387 boolean_t cb_scripted;
388 boolean_t cb_literal;
390 zprop_list_t *cb_proplist;
392 } zprop_get_cbdata_t;
394 void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
395 const char *, const char *, zprop_source_t, const char *);
397 #define GET_COL_NAME 1
398 #define GET_COL_PROPERTY 2
399 #define GET_COL_VALUE 3
400 #define GET_COL_SOURCE 4
403 * Iterator functions.
405 typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
406 extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
407 extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
408 extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
409 extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
410 extern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
413 * Functions to create and destroy datasets.
415 extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
417 extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
418 extern int zfs_destroy(zfs_handle_t *);
419 extern int zfs_destroy_snaps(zfs_handle_t *, char *);
420 extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
421 extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t);
422 extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
423 extern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
424 extern int zfs_send(zfs_handle_t *, const char *, const char *,
425 boolean_t, boolean_t, boolean_t, boolean_t, int);
426 extern int zfs_promote(zfs_handle_t *);
428 typedef struct recvflags {
429 /* print informational messages (ie, -v was specified) */
432 /* the destination is a prefix, not the exact fs (ie, -d) */
435 /* do not actually do the recv, just check if it would work (ie, -n) */
438 /* rollback/destroy filesystems as necessary (eg, -F) */
441 /* set "canmount=off" on all modified filesystems */
444 /* byteswap flag is used internally; callers need not specify */
448 extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t,
452 * Miscellaneous functions.
454 extern const char *zfs_type_to_name(zfs_type_t);
455 extern void zfs_refresh_properties(zfs_handle_t *);
456 extern int zfs_name_valid(const char *, zfs_type_t);
457 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
458 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
460 extern int zfs_spa_version(zfs_handle_t *, int *);
463 * dataset permission functions.
465 extern int zfs_perm_set(zfs_handle_t *, nvlist_t *);
466 extern int zfs_perm_remove(zfs_handle_t *, nvlist_t *);
467 extern int zfs_build_perms(zfs_handle_t *, char *, char *,
468 zfs_deleg_who_type_t, zfs_deleg_inherit_t, nvlist_t **nvlist_t);
469 extern int zfs_perm_get(zfs_handle_t *, zfs_allow_t **);
470 extern void zfs_free_allows(zfs_allow_t *);
471 extern void zfs_deleg_permissions(void);
474 * Mount support functions.
476 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
477 extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
478 extern int zfs_mount(zfs_handle_t *, const char *, int);
479 extern int zfs_unmount(zfs_handle_t *, const char *, int);
480 extern int zfs_unmountall(zfs_handle_t *, int);
483 * Share support functions.
485 extern boolean_t zfs_is_shared(zfs_handle_t *);
486 extern int zfs_share(zfs_handle_t *);
487 extern int zfs_unshare(zfs_handle_t *);
490 * Protocol-specific share support functions.
492 extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
493 extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
494 extern int zfs_share_nfs(zfs_handle_t *);
495 extern int zfs_share_smb(zfs_handle_t *);
496 extern int zfs_shareall(zfs_handle_t *);
497 extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
498 extern int zfs_unshare_smb(zfs_handle_t *, const char *);
499 extern int zfs_unshareall_nfs(zfs_handle_t *);
500 extern int zfs_unshareall_smb(zfs_handle_t *);
501 extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
502 extern int zfs_unshareall(zfs_handle_t *);
503 extern boolean_t zfs_is_shared_iscsi(zfs_handle_t *);
504 extern int zfs_share_iscsi(zfs_handle_t *);
505 extern int zfs_unshare_iscsi(zfs_handle_t *);
506 extern int zfs_iscsi_perm_check(libzfs_handle_t *, char *, ucred_t *);
507 extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *,
508 void *, void *, int, zfs_share_op_t);
511 * When dealing with nvlists, verify() is extremely useful
514 #define verify(EX) ((void)(EX))
516 #define verify(EX) assert(EX)
520 * Utility function to convert a number to a human-readable form.
522 extern void zfs_nicenum(uint64_t, char *, size_t);
523 extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
526 * Given a device or file, determine if it is part of a pool.
528 extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
532 * ftyp special. Read the label from a given device.
534 extern int zpool_read_label(int, nvlist_t **);
537 * Create and remove zvol /dev links.
539 extern int zpool_create_zvol_links(zpool_handle_t *);
540 extern int zpool_remove_zvol_links(zpool_handle_t *);
542 /* is this zvol valid for use as a dump device? */
543 extern int zvol_check_dump_config(char *);
546 * Enable and disable datasets within a pool by mounting/unmounting and
547 * sharing/unsharing them.
549 extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
550 extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
556 #endif /* _LIBZFS_H */