libzfs.h revision 7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER START
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The contents of this file are subject to the terms of the
441d80aa4f613b6298fc8bd3151f4be02dbf84fclling * Common Development and Distribution License (the "License").
441d80aa4f613b6298fc8bd3151f4be02dbf84fclling * You may not use this file except in compliance with the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fa9e4066f08beec538e775443c5be79dd423fcabahrens * See the License for the specific language governing permissions
fa9e4066f08beec538e775443c5be79dd423fcabahrens * and limitations under the License.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When distributing Covered Code, include this CDDL HEADER in each
fa9e4066f08beec538e775443c5be79dd423fcabahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * If applicable, add the following below this CDDL HEADER, with the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * fields enclosed by brackets "[]" replaced with your own identifying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * information: Portions Copyright [yyyy] [name of copyright owner]
fa9e4066f08beec538e775443c5be79dd423fcabahrens * CDDL HEADER END
55434c770c89aa1b84474f2559a106803511aba0ek * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Use is subject to license terms.
fa9e4066f08beec538e775443c5be79dd423fcabahrens#pragma ident "%Z%%M% %I% %E% SMI"
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern "C" {
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous ZFS constants
99653d4ee642c6528e88224f12409a5f23060994eschrock * libzfs errors
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPREADONLY, /* cannot set readonly property */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPTYPE, /* property does not apply to dataset type */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_PROPNONINHERIT, /* property is not inheritable */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADTYPE, /* dataset is not of appropriate type */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_VOLHASDATA, /* volume already contains data */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADRESTORE, /* unable to restore to destination */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_BADTARGET, /* bad attach/detach/replace target */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */
99653d4ee642c6528e88224f12409a5f23060994eschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl EZFS_UNSHAREISCSIFAILED, /* iscsitgtd failed request to unshare */
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl EZFS_SHAREISCSIFAILED, /* iscsitgtd failed request to share */
b1b8ab34de515a5e83206da22c3d7e563241b021lling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
b1b8ab34de515a5e83206da22c3d7e563241b021lling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle types
99653d4ee642c6528e88224f12409a5f23060994eschrock * Library initialization
99653d4ee642c6528e88224f12409a5f23060994eschrockextern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern const char *libzfs_error_action(libzfs_handle_t *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern const char *libzfs_error_description(libzfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle functions
99653d4ee642c6528e88224f12409a5f23060994eschrockextern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern uint64_t zpool_get_space_used(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern uint64_t zpool_get_space_total(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_get_root(zpool_handle_t *, char *, size_t);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern uint64_t zpool_get_version(zpool_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Iterate over all active pools in the system.
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef int (*zpool_iter_f)(zpool_handle_t *, void *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy pools
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
99653d4ee642c6528e88224f12409a5f23060994eschrock const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to manipulate pool and vdev state
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_scrub(zpool_handle_t *, pool_scrub_type_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_clear(zpool_handle_t *, const char *);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_online(zpool_handle_t *, const char *, int,
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_attach(zpool_handle_t *, const char *,
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock const char *, nvlist_t *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zpool_vdev_detach(zpool_handle_t *, const char *);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_vdev_remove(zpool_handle_t *, const char *);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_fault(zpool_handle_t *, uint64_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_degrade(zpool_handle_t *, uint64_t);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *);
8488aeb5df27784d479c16cde06a9e25cd9a1152taylorextern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Functions to manage pool properties
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrockextern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Pool health statistics.
fa9e4066f08beec538e775443c5be79dd423fcabahrenstypedef enum {
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The following correspond to faults as defined in the (fault.fs.zfs.*)
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * event namespace. Each is associated with a corresponding message ID.
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
eaca9bbd5f5d1e4e554da4c7108e8a03c8c33481eschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
95173954d2b811ceb583a9012c3b16e1d0dd6438ek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
fa9e4066f08beec538e775443c5be79dd423fcabahrens * The following are not faults per se, but still an error possibly
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * requiring administrative attention. There is no corresponding
fa9e4066f08beec538e775443c5be79dd423fcabahrens * message ID.
eaca9bbd5f5d1e4e554da4c7108e8a03c8c33481eschrock ZPOOL_STATUS_VERSION_OLDER, /* older on-disk version */
fa9e4066f08beec538e775443c5be79dd423fcabahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Finally, the following indicates a healthy pool.
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern zpool_status_t zpool_get_status(zpool_handle_t *, char **);
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern zpool_status_t zpool_import_status(nvlist_t *, char **);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Statistics and configuration functions.
ea8dc4b6d2251b437950c0056bc626b311c73c27eschrockextern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
94de1d4cf6ec0a3bf040dcc4b8df107c4ed36b51eschrockextern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
55434c770c89aa1b84474f2559a106803511aba0ekextern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Import and export functions
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
99653d4ee642c6528e88224f12409a5f23060994eschrock const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Search for pools to import
99653d4ee642c6528e88224f12409a5f23060994eschrockextern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
c67d9675bbc8392fe45f3a7dfbda1ad4daa1eb07eschrock * Miscellaneous pool functions
99653d4ee642c6528e88224f12409a5f23060994eschrockextern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *);
06eeb2ad640ce72d394ac521094bed7681044408ekextern int zpool_get_history(zpool_handle_t *, nvlist_t **);
06eeb2ad640ce72d394ac521094bed7681044408ekextern void zpool_log_history(libzfs_handle_t *, int, char **, const char *,
55434c770c89aa1b84474f2559a106803511aba0ekextern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Basic handle manipulations. These functions do not create or destroy the
fa9e4066f08beec538e775443c5be79dd423fcabahrens * underlying datasets, only the references to them.
99653d4ee642c6528e88224f12409a5f23060994eschrockextern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern const char *zfs_get_name(const zfs_handle_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Property management functions. Some functions are shared with the kernel,
b81d61a68b235e0529ebadc18e14d9d1dd52a258lling * and are found in sys/fs/zfs.h.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_get_string(zfs_handle_t *, zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_inherit(zfs_handle_t *, const char *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_prop_valid_for_type(zfs_prop_t, int);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_default_string(zfs_prop_t prop);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern uint64_t zfs_prop_default_numeric(zfs_prop_t);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern const char *zfs_prop_column_name(zfs_prop_t);
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern void nicebool(int value, char *buf, size_t buflen);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrocktypedef struct zfs_proplist {
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_get_proplist(libzfs_handle_t *, char *, zfs_proplist_t **);
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern int zpool_get_proplist(libzfs_handle_t *, char *, zpool_proplist_t **);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_expand_proplist(zfs_handle_t *, zfs_proplist_t **);
b1b8ab34de515a5e83206da22c3d7e563241b021llingextern int zpool_expand_proplist(zpool_handle_t *, zpool_proplist_t **);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern nvlist_t *zfs_get_user_props(zfs_handle_t *);
b1b8ab34de515a5e83206da22c3d7e563241b021lling * Functions for printing properties from zfs/zpool
b1b8ab34de515a5e83206da22c3d7e563241b021llingtypedef struct libzfs_get_cbdata {
b1b8ab34de515a5e83206da22c3d7e563241b021llingvoid libzfs_print_one_property(const char *, libzfs_get_cbdata_t *,
b1b8ab34de515a5e83206da22c3d7e563241b021lling const char *, const char *, zfs_source_t, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Iterator functions.
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
3bb79bece53191f2cf27aa61a72ea1784a7ce700eschrockextern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
7f7322febbcfe774b7270abc3b191c094bfcc517eschrockextern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
7f7322febbcfe774b7270abc3b191c094bfcc517eschrockextern int zfs_iter_snapshots(zfs_handle_t *, zfs_iter_f, void *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Functions to create and destroy datasets.
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773vbextern int zfs_create_ancestors(libzfs_handle_t *, const char *);
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
1d452cf5123cb6ac0a013a4dbd4dcceeb0da314dahrensextern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t);
b12a1c38fc215cc54fa6014069fd2b8dbb496646llingextern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, int);
7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773vbextern int zfs_rename(zfs_handle_t *, const char *, boolean_t);
98579b20de8e05c5117968705a18979f8b75b863ndextern int zfs_receive(libzfs_handle_t *, const char *, int, int, int,
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Miscellaneous functions.
5aba80db367b061758a29154d304977d00d8e4f4ckextern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
7f1f55ea3af0e6153a8ee9316c7f0b8b4f1ba773vbextern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Mount support functions.
55434c770c89aa1b84474f2559a106803511aba0ekextern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
99653d4ee642c6528e88224f12409a5f23060994eschrockextern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_mount(zfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrensextern int zfs_unmount(zfs_handle_t *, const char *, int);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Share support functions.
3d7072f8bd27709dba14f6fe336f149d25d9e207eschrock * Protocol-specific share support functions.
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zfs_unshare_nfs(zfs_handle_t *, const char *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * When dealing with nvlists, verify() is extremely useful
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Utility function to convert a number to a human-readable form.
e9dbad6f263d5570ed7ff5443ec5b958af8c24d7eschrockextern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Pool destroy special. Remove the device information without destroying
fa9e4066f08beec538e775443c5be79dd423fcabahrens * the underlying dataset.
fa9e4066f08beec538e775443c5be79dd423fcabahrens * Given a device or file, determine if it is part of a pool.
99653d4ee642c6528e88224f12409a5f23060994eschrockextern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
fa9e4066f08beec538e775443c5be79dd423fcabahrens * ftyp special. Read the label from a given device.
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl * Create and remove zvol /dev links.
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahl * Enable and disable datasets within a pool by mounting/unmounting and
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
f3861e1a2ceec23a5b699c24d814b7775a9e0b52ahlextern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
fa9e4066f08beec538e775443c5be79dd423fcabahrens#endif /* _LIBZFS_H */