1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5441d80aaSlling * Common Development and Distribution License (the "License"). 6441d80aaSlling * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21f3861e1aSahl 22fa9e4066Sahrens /* 233f9d6ad7SLin Ling * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 240d8fa8f8SMartin Matuska * Copyright (c) 2011 Pawel Jakub Dawidek. All rights reserved. 25*5cabbc6bSPrashanth Sreenivasa * Copyright (c) 2011, 2017 by Delphix. All rights reserved. 264e3c9f44SBill Pijewski * Copyright (c) 2012, Joyent, Inc. All rights reserved. 27a7a845e4SSteven Hartland * Copyright (c) 2013 Steven Hartland. All rights reserved. 28c3d26abcSMatthew Ahrens * Copyright (c) 2014 Integros [integros.com] 298808ac5dSYuri Pankov * Copyright 2016 Nexenta Systems, Inc. 301702cce7SAlek Pinchuk * Copyright (c) 2017 Datto Inc. 31fa9e4066Sahrens */ 32fa9e4066Sahrens 33fa9e4066Sahrens #ifndef _LIBZFS_H 34fa9e4066Sahrens #define _LIBZFS_H 35fa9e4066Sahrens 36fa9e4066Sahrens #include <assert.h> 37fa9e4066Sahrens #include <libnvpair.h> 38ebedde84SEric Taylor #include <sys/mnttab.h> 39fa9e4066Sahrens #include <sys/param.h> 40fa9e4066Sahrens #include <sys/types.h> 41fa9e4066Sahrens #include <sys/varargs.h> 42fa9e4066Sahrens #include <sys/fs/zfs.h> 43ecd6cf80Smarks #include <sys/avl.h> 44ecd6cf80Smarks #include <ucred.h> 455d7b4d43SMatthew Ahrens #include <libzfs_core.h> 46fa9e4066Sahrens 47fa9e4066Sahrens #ifdef __cplusplus 48fa9e4066Sahrens extern "C" { 49fa9e4066Sahrens #endif 50fa9e4066Sahrens 51fa9e4066Sahrens /* 52fa9e4066Sahrens * Miscellaneous ZFS constants 53fa9e4066Sahrens */ 54fa9e4066Sahrens #define ZFS_MAXPROPLEN MAXPATHLEN 55990b4856Slling #define ZPOOL_MAXPROPLEN MAXPATHLEN 56fa9e4066Sahrens 57fa9e4066Sahrens /* 5899653d4eSeschrock * libzfs errors 5999653d4eSeschrock */ 604445fffbSMatthew Ahrens typedef enum zfs_error { 614445fffbSMatthew Ahrens EZFS_SUCCESS = 0, /* no error -- success */ 6299653d4eSeschrock EZFS_NOMEM = 2000, /* out of memory */ 6399653d4eSeschrock EZFS_BADPROP, /* invalid property value */ 6499653d4eSeschrock EZFS_PROPREADONLY, /* cannot set readonly property */ 6599653d4eSeschrock EZFS_PROPTYPE, /* property does not apply to dataset type */ 6699653d4eSeschrock EZFS_PROPNONINHERIT, /* property is not inheritable */ 6799653d4eSeschrock EZFS_PROPSPACE, /* bad quota or reservation */ 6899653d4eSeschrock EZFS_BADTYPE, /* dataset is not of appropriate type */ 6999653d4eSeschrock EZFS_BUSY, /* pool or dataset is busy */ 7099653d4eSeschrock EZFS_EXISTS, /* pool or dataset already exists */ 7199653d4eSeschrock EZFS_NOENT, /* no such pool or dataset */ 7299653d4eSeschrock EZFS_BADSTREAM, /* bad backup stream */ 7399653d4eSeschrock EZFS_DSREADONLY, /* dataset is readonly */ 7499653d4eSeschrock EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */ 7599653d4eSeschrock EZFS_INVALIDNAME, /* invalid dataset name */ 7699653d4eSeschrock EZFS_BADRESTORE, /* unable to restore to destination */ 7799653d4eSeschrock EZFS_BADBACKUP, /* backup failed */ 7899653d4eSeschrock EZFS_BADTARGET, /* bad attach/detach/replace target */ 7999653d4eSeschrock EZFS_NODEVICE, /* no such device in pool */ 8099653d4eSeschrock EZFS_BADDEV, /* invalid device to add */ 8199653d4eSeschrock EZFS_NOREPLICAS, /* no valid replicas */ 8299653d4eSeschrock EZFS_RESILVERING, /* currently resilvering */ 8399653d4eSeschrock EZFS_BADVERSION, /* unsupported version */ 8499653d4eSeschrock EZFS_POOLUNAVAIL, /* pool is currently unavailable */ 8599653d4eSeschrock EZFS_DEVOVERFLOW, /* too many devices in one vdev */ 8699653d4eSeschrock EZFS_BADPATH, /* must be an absolute path */ 8799653d4eSeschrock EZFS_CROSSTARGET, /* rename or clone across pool or dataset */ 8899653d4eSeschrock EZFS_ZONED, /* used improperly in local zone */ 8999653d4eSeschrock EZFS_MOUNTFAILED, /* failed to mount dataset */ 9099653d4eSeschrock EZFS_UMOUNTFAILED, /* failed to unmount dataset */ 91f3861e1aSahl EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */ 92f3861e1aSahl EZFS_SHARENFSFAILED, /* share(1M) failed */ 9399653d4eSeschrock EZFS_PERM, /* permission denied */ 9499653d4eSeschrock EZFS_NOSPC, /* out of space */ 956e27f868SSam Falkner EZFS_FAULT, /* bad address */ 9699653d4eSeschrock EZFS_IO, /* I/O error */ 9799653d4eSeschrock EZFS_INTR, /* signal received */ 9899653d4eSeschrock EZFS_ISSPARE, /* device is a hot spare */ 9999653d4eSeschrock EZFS_INVALCONFIG, /* invalid vdev configuration */ 1003bb79becSeschrock EZFS_RECURSIVE, /* recursive dependency */ 10106eeb2adSek110237 EZFS_NOHISTORY, /* no history object */ 102b1b8ab34Slling EZFS_POOLPROPS, /* couldn't retrieve pool props */ 103b1b8ab34Slling EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */ 104b1b8ab34Slling EZFS_POOL_INVALARG, /* invalid argument for this pool operation */ 105b7661cccSmmusante EZFS_NAMETOOLONG, /* dataset name is too long */ 1068488aeb5Staylor EZFS_OPENFAILED, /* open of device failed */ 1078488aeb5Staylor EZFS_NOCAP, /* couldn't get capacity */ 1088488aeb5Staylor EZFS_LABELFAILED, /* write of label failed */ 109ecd6cf80Smarks EZFS_BADWHO, /* invalid permission who */ 110ecd6cf80Smarks EZFS_BADPERM, /* invalid permission */ 111ecd6cf80Smarks EZFS_BADPERMSET, /* invalid permission set name */ 112ecd6cf80Smarks EZFS_NODELEGATION, /* delegated administration is disabled */ 113da6c28aaSamw EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */ 114da6c28aaSamw EZFS_SHARESMBFAILED, /* failed to share over smb */ 1152f8aaab3Seschrock EZFS_BADCACHE, /* bad cache file */ 116fa94a07fSbrendan EZFS_ISL2CACHE, /* device is for the level 2 ARC */ 117e7cbe64fSgw25295 EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11815e6edf1Sgw25295 EZFS_NOTSUP, /* ops not supported on this dataset */ 11989a89ebfSlling EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ 120e6ca193dSGeorge Wilson EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ 121842727c2SChris Kirby EZFS_REFTAG_RELE, /* snapshot release: tag not found */ 122842727c2SChris Kirby EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ 123ca45db41SChris Kirby EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */ 1249e69d7d0SLori Alt EZFS_PIPEFAILED, /* pipe create failed */ 1259e69d7d0SLori Alt EZFS_THREADCREATEFAILED, /* thread create failed */ 1261195e687SMark J Musante EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */ 1273f9d6ad7SLin Ling EZFS_SCRUBBING, /* currently scrubbing */ 1283f9d6ad7SLin Ling EZFS_NO_SCRUB, /* no active scrub */ 12999d5e173STim Haley EZFS_DIFF, /* general failure of zfs diff */ 13099d5e173STim Haley EZFS_DIFFDATA, /* bad zfs diff data */ 131f9af39baSGeorge Wilson EZFS_POOLREADONLY, /* pool is in read-only mode */ 1321702cce7SAlek Pinchuk EZFS_SCRUB_PAUSED, /* scrub currently paused */ 133*5cabbc6bSPrashanth Sreenivasa EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ 134b1b8ab34Slling EZFS_UNKNOWN 1354445fffbSMatthew Ahrens } zfs_error_t; 13699653d4eSeschrock 13799653d4eSeschrock /* 1387855d95bSToomas Soome * UEFI boot support parameters. When creating whole disk boot pool, 1397855d95bSToomas Soome * zpool create should allow to create EFI System partition for UEFI boot 1407855d95bSToomas Soome * program. In case of BIOS, the EFI System partition is not used 1417855d95bSToomas Soome * even if it does exist. 1427855d95bSToomas Soome */ 1437855d95bSToomas Soome typedef enum zpool_boot_label { 1447855d95bSToomas Soome ZPOOL_NO_BOOT_LABEL = 0, 1457855d95bSToomas Soome ZPOOL_CREATE_BOOT_LABEL, 1467855d95bSToomas Soome ZPOOL_COPY_BOOT_LABEL 1477855d95bSToomas Soome } zpool_boot_label_t; 1487855d95bSToomas Soome 1497855d95bSToomas Soome /* 150ecd6cf80Smarks * The following data structures are all part 151ecd6cf80Smarks * of the zfs_allow_t data structure which is 152ecd6cf80Smarks * used for printing 'allow' permissions. 153ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 154ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 155ecd6cf80Smarks * and each one of the entries in those trees have 156ecd6cf80Smarks * avl tree's for the permissions they belong to and 157ecd6cf80Smarks * whether they are local,descendent or local+descendent 158ecd6cf80Smarks * permissions. The AVL trees are used primarily for 159ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 160ecd6cf80Smarks * a given user and or permission. 161ecd6cf80Smarks */ 162ecd6cf80Smarks typedef struct zfs_perm_node { 163ecd6cf80Smarks avl_node_t z_node; 164ecd6cf80Smarks char z_pname[MAXPATHLEN]; 165ecd6cf80Smarks } zfs_perm_node_t; 166ecd6cf80Smarks 167ecd6cf80Smarks typedef struct zfs_allow_node { 168ecd6cf80Smarks avl_node_t z_node; 169ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 170ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 171ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 172ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 173ecd6cf80Smarks } zfs_allow_node_t; 174ecd6cf80Smarks 175ecd6cf80Smarks typedef struct zfs_allow { 176ecd6cf80Smarks struct zfs_allow *z_next; 177ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 178ecd6cf80Smarks avl_tree_t z_sets; 179ecd6cf80Smarks avl_tree_t z_crperms; 180ecd6cf80Smarks avl_tree_t z_user; 181ecd6cf80Smarks avl_tree_t z_group; 182ecd6cf80Smarks avl_tree_t z_everyone; 183ecd6cf80Smarks } zfs_allow_t; 184ecd6cf80Smarks 185ecd6cf80Smarks /* 186fa9e4066Sahrens * Basic handle types 187fa9e4066Sahrens */ 188fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 189fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 19099653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 19199653d4eSeschrock 19299653d4eSeschrock /* 19399653d4eSeschrock * Library initialization 19499653d4eSeschrock */ 19599653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 19699653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 19799653d4eSeschrock 19899653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 19999653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 20099653d4eSeschrock 20199653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 20299653d4eSeschrock 2034445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int); 2044445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *); 2054445fffbSMatthew Ahrens 20699653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 20799653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 20899653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 20978f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *); 210ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 211ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 212b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 213ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 214ebedde84SEric Taylor struct mnttab *); 215ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 216ebedde84SEric Taylor const char *, const char *); 217ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 218fa9e4066Sahrens 219fa9e4066Sahrens /* 220fa9e4066Sahrens * Basic handle functions 221fa9e4066Sahrens */ 22299653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 22399653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 224fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 225fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 226fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 2276401734dSWill Andrews extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 2286401734dSWill Andrews extern const char *zpool_pool_state_to_name(pool_state_t); 22929ab75c9Srm160521 extern void zpool_free_handles(libzfs_handle_t *); 230fa9e4066Sahrens 231fa9e4066Sahrens /* 232fa9e4066Sahrens * Iterate over all active pools in the system. 233fa9e4066Sahrens */ 234fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 23599653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 2368808ac5dSYuri Pankov extern boolean_t zpool_skip_pool(const char *); 237fa9e4066Sahrens 238fa9e4066Sahrens /* 239fa9e4066Sahrens * Functions to create and destroy pools 240fa9e4066Sahrens */ 24199653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2420a48a24eStimh nvlist_t *, nvlist_t *); 2434445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *); 244fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 245fa9e4066Sahrens 2461195e687SMark J Musante typedef struct splitflags { 2471195e687SMark J Musante /* do not split, but return the config that would be split off */ 2481195e687SMark J Musante int dryrun : 1; 2491195e687SMark J Musante 2501195e687SMark J Musante /* after splitting, import the pool */ 2511195e687SMark J Musante int import : 1; 2521195e687SMark J Musante } splitflags_t; 2531195e687SMark J Musante 254fa9e4066Sahrens /* 255fa9e4066Sahrens * Functions to manipulate pool and vdev state 256fa9e4066Sahrens */ 2571702cce7SAlek Pinchuk extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 258468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 259e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *); 2604263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *); 261fa9e4066Sahrens 2623d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2633d7072f8Seschrock vdev_state_t *); 2643d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2653d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2663d7072f8Seschrock const char *, nvlist_t *, int); 267fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 26899653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 269*5cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_remove_cancel(zpool_handle_t *); 270*5cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); 2711195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2721195e687SMark J Musante splitflags_t); 2733d7072f8Seschrock 274069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 275069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2763d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2773d7072f8Seschrock 278fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 279ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 280573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 281573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2827855d95bSToomas Soome extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *, 2837855d95bSToomas Soome zpool_boot_label_t, uint64_t, int *); 284fa9e4066Sahrens 285fa9e4066Sahrens /* 286b1b8ab34Slling * Functions to manage pool properties 287b1b8ab34Slling */ 288b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 2893d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 290c58b3526SAdam Stevko size_t proplen, zprop_source_t *, boolean_t); 291990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 292990b4856Slling zprop_source_t *); 293990b4856Slling 294b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 295b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 296b1b8ab34Slling 297b1b8ab34Slling /* 298fa9e4066Sahrens * Pool health statistics. 299fa9e4066Sahrens */ 300fa9e4066Sahrens typedef enum { 301fa9e4066Sahrens /* 302fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 303b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 304fa9e4066Sahrens */ 305fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 306fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 307fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 308fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 309b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 310fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 311fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 312fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 313fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 314eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 31595173954Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 31632b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 31732b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 318f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 319f67f35c3SEric Schrock 320f67f35c3SEric Schrock /* 321ad135b5dSChristopher Siden * If the pool has unsupported features but can still be opened in 322ad135b5dSChristopher Siden * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 323ad135b5dSChristopher Siden * pool has unsupported features but cannot be opened at all, its 324ad135b5dSChristopher Siden * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 325ad135b5dSChristopher Siden */ 326ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 327ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 328ad135b5dSChristopher Siden 329ad135b5dSChristopher Siden /* 330f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 331f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 332f67f35c3SEric Schrock * checksum errors) has been lost. 333f67f35c3SEric Schrock */ 3343d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 3353d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 336fa9e4066Sahrens 337fa9e4066Sahrens /* 338fa9e4066Sahrens * The following are not faults per se, but still an error possibly 339b81d61a6Slling * requiring administrative attention. There is no corresponding 340fa9e4066Sahrens * message ID. 341fa9e4066Sahrens */ 34257221772SChristopher Siden ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 34357221772SChristopher Siden ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 344fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 345cb605c4dSGerhard Roethlin ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 346c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 347fa9e4066Sahrens 348fa9e4066Sahrens /* 349fa9e4066Sahrens * Finally, the following indicates a healthy pool. 350fa9e4066Sahrens */ 351fa9e4066Sahrens ZPOOL_STATUS_OK 352fa9e4066Sahrens } zpool_status_t; 353fa9e4066Sahrens 354ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 355ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 3569eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 357fa9e4066Sahrens 358fa9e4066Sahrens /* 359fa9e4066Sahrens * Statistics and configuration functions. 360fa9e4066Sahrens */ 361ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 362ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *); 36394de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 36455434c77Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3657855d95bSToomas Soome extern boolean_t zpool_is_bootable(zpool_handle_t *); 366ea8dc4b6Seschrock 367fa9e4066Sahrens /* 368fa9e4066Sahrens * Import and export functions 369fa9e4066Sahrens */ 3704445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 3714445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *); 37299653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 373990b4856Slling char *altroot); 374990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3754b964adaSGeorge Wilson nvlist_t *, int); 376ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config); 377fa9e4066Sahrens 378fa9e4066Sahrens /* 379fa9e4066Sahrens * Search for pools to import 380fa9e4066Sahrens */ 381d41c4376SMark J Musante 382d41c4376SMark J Musante typedef struct importargs { 383d41c4376SMark J Musante char **path; /* a list of paths to search */ 384d41c4376SMark J Musante int paths; /* number of paths to search */ 385d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 386d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 387d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 388d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 389d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 390d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 391d41c4376SMark J Musante } importargs_t; 392d41c4376SMark J Musante 393d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 394d41c4376SMark J Musante 395d41c4376SMark J Musante /* legacy pool search routines */ 39624e697d4Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 3973a57275aSck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 398e829d913Sck153898 char *, uint64_t); 399fa9e4066Sahrens 400fa9e4066Sahrens /* 401c67d9675Seschrock * Miscellaneous pool functions 402c67d9675Seschrock */ 403ecd6cf80Smarks struct zfs_cmd; 404ecd6cf80Smarks 4054445fffbSMatthew Ahrens extern const char *zfs_history_event_names[]; 4068f18d1faSGeorge Wilson 40788ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 40888ecc943SGeorge Wilson boolean_t verbose); 409990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 41006eeb2adSek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 4118f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 4128f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 41355434c77Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 41455434c77Sek110237 size_t len); 415ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 416753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 417468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 418468c413aSTim Haley nvlist_t *); 419753a6d45SSherry Moore 420c67d9675Seschrock /* 421fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 422fa9e4066Sahrens * underlying datasets, only the references to them. 423fa9e4066Sahrens */ 42499653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 42519b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 426fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 427fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 428fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 429d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 4308808ac5dSYuri Pankov extern const char *zfs_get_pool_name(const zfs_handle_t *); 431fa9e4066Sahrens 432fa9e4066Sahrens /* 433fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 434b81d61a6Slling * and are found in sys/fs/zfs.h. 435fa9e4066Sahrens */ 436990b4856Slling 437990b4856Slling /* 438990b4856Slling * zfs dataset property management 439990b4856Slling */ 440990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 441e9dbad6fSeschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 442e9dbad6fSeschrock extern const char *zfs_prop_column_name(zfs_prop_t); 443e9dbad6fSeschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 444e9dbad6fSeschrock 4450a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 446e9316f76SJoe Stein nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *); 4470a48a24eStimh 448990b4856Slling extern const char *zfs_prop_to_name(zfs_prop_t); 449990b4856Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 45030925561SChris Williamson extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 451990b4856Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 452990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 45392241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 45492241e0bSTom Erickson boolean_t); 455990b4856Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 456990b4856Slling zprop_source_t *, char *, size_t); 457edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 458edea4b55SLin Ling uint64_t *propvalue); 45914843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 46014843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 46119b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 46219b94df9SMatthew Ahrens uint64_t *propvalue); 46319b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 46419b94df9SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 465ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 466ad135b5dSChristopher Siden char *buf, size_t len); 467990b4856Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 46892241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 469990b4856Slling extern const char *zfs_prop_values(zfs_prop_t); 470990b4856Slling extern int zfs_prop_is_string(zfs_prop_t prop); 471990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 47292241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 47319b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 47419b94df9SMatthew Ahrens 475990b4856Slling 476990b4856Slling typedef struct zprop_list { 477990b4856Slling int pl_prop; 478e9dbad6fSeschrock char *pl_user_prop; 479990b4856Slling struct zprop_list *pl_next; 480e9dbad6fSeschrock boolean_t pl_all; 481e9dbad6fSeschrock size_t pl_width; 48292241e0bSTom Erickson size_t pl_recvd_width; 483e9dbad6fSeschrock boolean_t pl_fixed; 484990b4856Slling } zprop_list_t; 485e9dbad6fSeschrock 48643d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 48743d68d68SYuri Pankov boolean_t); 4882e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 489fa9e4066Sahrens 490fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 491fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 492fa9e4066Sahrens 493ad135b5dSChristopher Siden #define ZFS_FEATURE_DISABLED "disabled" 494ad135b5dSChristopher Siden #define ZFS_FEATURE_ENABLED "enabled" 495ad135b5dSChristopher Siden #define ZFS_FEATURE_ACTIVE "active" 496ad135b5dSChristopher Siden 497ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_INACTIVE "inactive" 498ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_READONLY "readonly" 499ad135b5dSChristopher Siden 500fa9e4066Sahrens /* 501990b4856Slling * zpool property management 502b1b8ab34Slling */ 503990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 504ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 505ad135b5dSChristopher Siden size_t); 506990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 507990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 508990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 509990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 510990b4856Slling 511990b4856Slling /* 512990b4856Slling * Functions shared by zfs and zpool property management. 513990b4856Slling */ 514990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 515990b4856Slling boolean_t ordered, zfs_type_t type); 516990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 517990b4856Slling zfs_type_t); 518990b4856Slling extern void zprop_free_list(zprop_list_t *); 519990b4856Slling 52092241e0bSTom Erickson #define ZFS_GET_NCOLS 5 52192241e0bSTom Erickson 52292241e0bSTom Erickson typedef enum { 52392241e0bSTom Erickson GET_COL_NONE, 52492241e0bSTom Erickson GET_COL_NAME, 52592241e0bSTom Erickson GET_COL_PROPERTY, 52692241e0bSTom Erickson GET_COL_VALUE, 52792241e0bSTom Erickson GET_COL_RECVD, 52892241e0bSTom Erickson GET_COL_SOURCE 52992241e0bSTom Erickson } zfs_get_column_t; 53092241e0bSTom Erickson 531990b4856Slling /* 532990b4856Slling * Functions for printing zfs or zpool properties 533990b4856Slling */ 534990b4856Slling typedef struct zprop_get_cbdata { 535b1b8ab34Slling int cb_sources; 53692241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 53792241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 538b1b8ab34Slling boolean_t cb_scripted; 539b1b8ab34Slling boolean_t cb_literal; 540b1b8ab34Slling boolean_t cb_first; 541990b4856Slling zprop_list_t *cb_proplist; 542990b4856Slling zfs_type_t cb_type; 543990b4856Slling } zprop_get_cbdata_t; 544b1b8ab34Slling 545990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 54692241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 54792241e0bSTom Erickson const char *); 548b1b8ab34Slling 549b1b8ab34Slling /* 550fa9e4066Sahrens * Iterator functions. 551fa9e4066Sahrens */ 552fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 55399653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 554fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 5553bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 5567f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 5570d8fa8f8SMartin Matuska extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 558ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 55919b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 56078f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 561fa9e4066Sahrens 5629d9a58e3SEric Taylor typedef struct get_all_cb { 5639d9a58e3SEric Taylor zfs_handle_t **cb_handles; 5649d9a58e3SEric Taylor size_t cb_alloc; 5659d9a58e3SEric Taylor size_t cb_used; 5669d9a58e3SEric Taylor boolean_t cb_verbose; 5679d9a58e3SEric Taylor int (*cb_getone)(zfs_handle_t *, void *); 5689d9a58e3SEric Taylor } get_all_cb_t; 5699d9a58e3SEric Taylor 5709d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 5719d9a58e3SEric Taylor int libzfs_dataset_cmp(const void *, const void *); 5729d9a58e3SEric Taylor 573fa9e4066Sahrens /* 574fa9e4066Sahrens * Functions to create and destroy datasets. 575fa9e4066Sahrens */ 57699653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 577e9dbad6fSeschrock nvlist_t *); 5787f1f55eaSvb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 579842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 580842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 5813b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 582e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 583bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 5844445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 5854445fffbSMatthew Ahrens nvlist_t *props); 586c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 5876a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 5889e69d7d0SLori Alt 5899e69d7d0SLori Alt typedef struct sendflags { 5909e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 59119b94df9SMatthew Ahrens boolean_t verbose; 5929e69d7d0SLori Alt 59392241e0bSTom Erickson /* recursive send (ie, -R) */ 59419b94df9SMatthew Ahrens boolean_t replicate; 5959e69d7d0SLori Alt 5969e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 59719b94df9SMatthew Ahrens boolean_t doall; 5989e69d7d0SLori Alt 5999e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 60019b94df9SMatthew Ahrens boolean_t fromorigin; 6019e69d7d0SLori Alt 6029e69d7d0SLori Alt /* do deduplication */ 60319b94df9SMatthew Ahrens boolean_t dedup; 60492241e0bSTom Erickson 60592241e0bSTom Erickson /* send properties (ie, -p) */ 60619b94df9SMatthew Ahrens boolean_t props; 60719b94df9SMatthew Ahrens 60819b94df9SMatthew Ahrens /* do not send (no-op, ie. -n) */ 60919b94df9SMatthew Ahrens boolean_t dryrun; 61019b94df9SMatthew Ahrens 61119b94df9SMatthew Ahrens /* parsable verbose output (ie. -P) */ 61219b94df9SMatthew Ahrens boolean_t parsable; 6134e3c9f44SBill Pijewski 6144e3c9f44SBill Pijewski /* show progress (ie. -v) */ 6154e3c9f44SBill Pijewski boolean_t progress; 6165d7b4d43SMatthew Ahrens 617b5152584SMatthew Ahrens /* large blocks (>128K) are permitted */ 618b5152584SMatthew Ahrens boolean_t largeblock; 619b5152584SMatthew Ahrens 6205d7b4d43SMatthew Ahrens /* WRITE_EMBEDDED records of type DATA are permitted */ 6215d7b4d43SMatthew Ahrens boolean_t embed_data; 6225602294fSDan Kimmel 6235602294fSDan Kimmel /* compressed WRITE records are permitted */ 6245602294fSDan Kimmel boolean_t compress; 6259e69d7d0SLori Alt } sendflags_t; 6269e69d7d0SLori Alt 6279e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 6289e69d7d0SLori Alt 62919b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 63019b94df9SMatthew Ahrens sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 6315d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 6329c3fd121SMatthew Ahrens extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 6339c3fd121SMatthew Ahrens const char *); 6349c3fd121SMatthew Ahrens extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 6359c3fd121SMatthew Ahrens const char *token); 6369e69d7d0SLori Alt 63799653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 6383b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *, 639a7a845e4SSteven Hartland boolean_t, int); 640a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 641842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 6421af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 643c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 644fa9e4066Sahrens 6450aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 64614843421SMatthew Ahrens uid_t rid, uint64_t space); 64714843421SMatthew Ahrens 6481af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 6491af68beaSAlexander Stetsenko zfs_userspace_cb_t, void *); 6501af68beaSAlexander Stetsenko 6511af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 6521af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 65314843421SMatthew Ahrens 6543cb34c60Sahrens typedef struct recvflags { 6554ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 65619b94df9SMatthew Ahrens boolean_t verbose; 6574ccbb6e7Sahrens 6584ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 65919b94df9SMatthew Ahrens boolean_t isprefix; 6604ccbb6e7Sahrens 661f64930f5STom Erickson /* 662f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 663f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 664f64930f5STom Erickson */ 66519b94df9SMatthew Ahrens boolean_t istail; 666f64930f5STom Erickson 6674ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 66819b94df9SMatthew Ahrens boolean_t dryrun; 6694ccbb6e7Sahrens 6704ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 67119b94df9SMatthew Ahrens boolean_t force; 6724ccbb6e7Sahrens 6734ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 67419b94df9SMatthew Ahrens boolean_t canmountoff; 6754ccbb6e7Sahrens 6769c3fd121SMatthew Ahrens /* 6779c3fd121SMatthew Ahrens * Mark the file systems as "resumable" and do not destroy them if the 6789c3fd121SMatthew Ahrens * receive is interrupted 6799c3fd121SMatthew Ahrens */ 6809c3fd121SMatthew Ahrens boolean_t resumable; 6819c3fd121SMatthew Ahrens 6824ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 68319b94df9SMatthew Ahrens boolean_t byteswap; 68433408eefSLori Alt 68533408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 68619b94df9SMatthew Ahrens boolean_t nomount; 6873cb34c60Sahrens } recvflags_t; 6883cb34c60Sahrens 689a2cdcdd2SPaul Dagnelie extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 690a2cdcdd2SPaul Dagnelie recvflags_t *, int, avl_tree_t *); 6913cb34c60Sahrens 69299d5e173STim Haley typedef enum diff_flags { 69399d5e173STim Haley ZFS_DIFF_PARSEABLE = 0x1, 69499d5e173STim Haley ZFS_DIFF_TIMESTAMP = 0x2, 69599d5e173STim Haley ZFS_DIFF_CLASSIFY = 0x4 69699d5e173STim Haley } diff_flags_t; 69799d5e173STim Haley 69899d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 69999d5e173STim Haley int); 70099d5e173STim Haley 701fa9e4066Sahrens /* 702fa9e4066Sahrens * Miscellaneous functions. 703fa9e4066Sahrens */ 704fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 705fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 706fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 7075aba80dbSck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 7087f1f55eaSvb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 7097f1f55eaSvb160487 zfs_type_t); 7107b97dc1aSrm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 71178f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path); 712fa9e4066Sahrens 713fa9e4066Sahrens /* 714fa9e4066Sahrens * Mount support functions. 715fa9e4066Sahrens */ 71655434c77Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 71799653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 718fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 719fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 720fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 721fa9e4066Sahrens 722fa9e4066Sahrens /* 723fa9e4066Sahrens * Share support functions. 724fa9e4066Sahrens */ 725f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 726fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 727f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 728f3861e1aSahl 729f3861e1aSahl /* 7303d7072f8Seschrock * Protocol-specific share support functions. 731f3861e1aSahl */ 732f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 733da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 734f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 735da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 736da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 737f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 738da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 739f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 740da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 741da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 742da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 743743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 744da6c28aaSamw void *, void *, int, zfs_share_op_t); 745fa9e4066Sahrens 746fa9e4066Sahrens /* 747fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 748fa9e4066Sahrens */ 749fa9e4066Sahrens #ifdef NDEBUG 750fa9e4066Sahrens #define verify(EX) ((void)(EX)) 751fa9e4066Sahrens #else 752fa9e4066Sahrens #define verify(EX) assert(EX) 753fa9e4066Sahrens #endif 754fa9e4066Sahrens 755fa9e4066Sahrens /* 756fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 757fa9e4066Sahrens */ 758fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 759e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 760fa9e4066Sahrens 761fa9e4066Sahrens /* 762fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 763fa9e4066Sahrens */ 76499653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 76599653d4eSeschrock boolean_t *); 766fa9e4066Sahrens 767fa9e4066Sahrens /* 768096d22d4SEric Schrock * Label manipulation. 769fa9e4066Sahrens */ 77099653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 771096d22d4SEric Schrock extern int zpool_clear_label(int); 772fa9e4066Sahrens 773e7cbe64fSgw25295 /* is this zvol valid for use as a dump device? */ 774e7cbe64fSgw25295 extern int zvol_check_dump_config(char *); 775e7cbe64fSgw25295 7763bb79becSeschrock /* 777743a77edSAlan Wright * Management interfaces for SMB ACL files 778743a77edSAlan Wright */ 779743a77edSAlan Wright 780743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 781743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 782743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 783743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 784743a77edSAlan Wright 785743a77edSAlan Wright /* 786f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 787f3861e1aSahl * sharing/unsharing them. 7883bb79becSeschrock */ 789f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 790f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 7913bb79becSeschrock 792069f55e2SEric Schrock /* 793069f55e2SEric Schrock * Mappings between vdev and FRU. 794069f55e2SEric Schrock */ 795069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 796069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 797069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 798069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 799069f55e2SEric Schrock const char *); 800069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 801069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 802069f55e2SEric Schrock 8032bcf0248SMax Grossman extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *); 804*5cabbc6bSPrashanth Sreenivasa extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *); 8052bcf0248SMax Grossman 8068a981c33SDaniel Hoffman /* Allow consumers to initialize libshare externally for optimal performance */ 8078a981c33SDaniel Hoffman extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *); 8088a981c33SDaniel Hoffman /* 8098a981c33SDaniel Hoffman * For most consumers, zfs_init_libshare_arg is sufficient on its own, and 8108a981c33SDaniel Hoffman * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called 8118a981c33SDaniel Hoffman * if the caller has already initialized libshare for one set of zfs handles, 8128a981c33SDaniel Hoffman * and wishes to share or unshare filesystems outside of that set. In that case, 8138a981c33SDaniel Hoffman * the caller should uninitialize libshare, and then re-initialize it with the 8148a981c33SDaniel Hoffman * new handles being shared or unshared. 8158a981c33SDaniel Hoffman */ 8168a981c33SDaniel Hoffman extern void zfs_uninit_libshare(libzfs_handle_t *); 817fa9e4066Sahrens #ifdef __cplusplus 818fa9e4066Sahrens } 819fa9e4066Sahrens #endif 820fa9e4066Sahrens 821fa9e4066Sahrens #endif /* _LIBZFS_H */ 822