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. 255cabbc6bSPrashanth Sreenivasa * Copyright (c) 2011, 2017 by Delphix. All rights reserved. 26e0f1c0afSOlaf Faaland * Copyright 2019 Joyent, Inc. 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 5799653d4eSeschrock /* 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 */ 10106eeb2adSek 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 */ 117e7cbe64fSgw EZFS_VDEVNOTSUP, /* unsupported vdev type */ 11815e6edf1Sgw 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 */ 133e0f1c0afSOlaf Faaland EZFS_ACTIVE_POOL, /* pool is imported on a different system */ 1345cabbc6bSPrashanth Sreenivasa EZFS_NO_PENDING, /* cannot cancel, no operation is pending */ 13586714001SSerapheim Dimitropoulos EZFS_CHECKPOINT_EXISTS, /* checkpoint exists */ 13686714001SSerapheim Dimitropoulos EZFS_DISCARDING_CHECKPOINT, /* currently discarding a checkpoint */ 13786714001SSerapheim Dimitropoulos EZFS_NO_CHECKPOINT, /* pool has no checkpoint */ 13886714001SSerapheim Dimitropoulos EZFS_DEVRM_IN_PROGRESS, /* a device is currently being removed */ 13986714001SSerapheim Dimitropoulos EZFS_VDEV_TOO_BIG, /* a device is too big to be used */ 140094e47e9SGeorge Wilson EZFS_TOOMANY, /* argument list too long */ 141094e47e9SGeorge Wilson EZFS_INITIALIZING, /* currently initializing */ 142094e47e9SGeorge Wilson EZFS_NO_INITIALIZE, /* no active initialize */ 143*6ccda740Sloli EZFS_WRONG_PARENT, /* invalid parent dataset (e.g ZVOL) */ 144e4c795beSTom Caputi EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 145eb633035STom Caputi EZFS_CRYPTOFAILED, /* failed to setup encryption */ 146b1b8ab34Slling EZFS_UNKNOWN 1474445fffbSMatthew Ahrens } zfs_error_t; 14899653d4eSeschrock 1497855d95bSToomas Soome /* 1507855d95bSToomas Soome * UEFI boot support parameters. When creating whole disk boot pool, 1517855d95bSToomas Soome * zpool create should allow to create EFI System partition for UEFI boot 1527855d95bSToomas Soome * program. In case of BIOS, the EFI System partition is not used 1537855d95bSToomas Soome * even if it does exist. 1547855d95bSToomas Soome */ 1557855d95bSToomas Soome typedef enum zpool_boot_label { 1567855d95bSToomas Soome ZPOOL_NO_BOOT_LABEL = 0, 1577855d95bSToomas Soome ZPOOL_CREATE_BOOT_LABEL, 1587855d95bSToomas Soome ZPOOL_COPY_BOOT_LABEL 1597855d95bSToomas Soome } zpool_boot_label_t; 1607855d95bSToomas Soome 161ecd6cf80Smarks /* 162ecd6cf80Smarks * The following data structures are all part 163ecd6cf80Smarks * of the zfs_allow_t data structure which is 164ecd6cf80Smarks * used for printing 'allow' permissions. 165ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 166ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 167ecd6cf80Smarks * and each one of the entries in those trees have 168ecd6cf80Smarks * avl tree's for the permissions they belong to and 169ecd6cf80Smarks * whether they are local,descendent or local+descendent 170ecd6cf80Smarks * permissions. The AVL trees are used primarily for 171ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 172ecd6cf80Smarks * a given user and or permission. 173ecd6cf80Smarks */ 174ecd6cf80Smarks typedef struct zfs_perm_node { 175ecd6cf80Smarks avl_node_t z_node; 176ecd6cf80Smarks char z_pname[MAXPATHLEN]; 177ecd6cf80Smarks } zfs_perm_node_t; 178ecd6cf80Smarks 179ecd6cf80Smarks typedef struct zfs_allow_node { 180ecd6cf80Smarks avl_node_t z_node; 181ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 182ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 183ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 184ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 185ecd6cf80Smarks } zfs_allow_node_t; 186ecd6cf80Smarks 187ecd6cf80Smarks typedef struct zfs_allow { 188ecd6cf80Smarks struct zfs_allow *z_next; 189ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 190ecd6cf80Smarks avl_tree_t z_sets; 191ecd6cf80Smarks avl_tree_t z_crperms; 192ecd6cf80Smarks avl_tree_t z_user; 193ecd6cf80Smarks avl_tree_t z_group; 194ecd6cf80Smarks avl_tree_t z_everyone; 195ecd6cf80Smarks } zfs_allow_t; 196ecd6cf80Smarks 197fa9e4066Sahrens /* 198fa9e4066Sahrens * Basic handle types 199fa9e4066Sahrens */ 200fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 201fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 20299653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 20399653d4eSeschrock 20499653d4eSeschrock /* 20599653d4eSeschrock * Library initialization 20699653d4eSeschrock */ 20799653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 20899653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 20999653d4eSeschrock 21099653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 21199653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 21299653d4eSeschrock 21399653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 21499653d4eSeschrock 2154445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int); 2164445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *); 2174445fffbSMatthew Ahrens 21899653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 21999653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 22099653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 22178f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *); 222ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 223ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 224b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 225ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 226ebedde84SEric Taylor struct mnttab *); 227ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 228ebedde84SEric Taylor const char *, const char *); 229ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 230fa9e4066Sahrens 231fa9e4066Sahrens /* 232fa9e4066Sahrens * Basic handle functions 233fa9e4066Sahrens */ 23499653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 23599653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 236fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 237fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 238fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 2396401734dSWill Andrews extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 2406401734dSWill Andrews extern const char *zpool_pool_state_to_name(pool_state_t); 24129ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *); 242fa9e4066Sahrens 243fa9e4066Sahrens /* 244fa9e4066Sahrens * Iterate over all active pools in the system. 245fa9e4066Sahrens */ 246fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 24799653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 2488808ac5dSYuri Pankov extern boolean_t zpool_skip_pool(const char *); 249fa9e4066Sahrens 250fa9e4066Sahrens /* 251fa9e4066Sahrens * Functions to create and destroy pools 252fa9e4066Sahrens */ 25399653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2540a48a24eStimh nvlist_t *, nvlist_t *); 2554445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *); 256fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 257fa9e4066Sahrens 2581195e687SMark J Musante typedef struct splitflags { 2591195e687SMark J Musante /* do not split, but return the config that would be split off */ 2601195e687SMark J Musante int dryrun : 1; 2611195e687SMark J Musante 2621195e687SMark J Musante /* after splitting, import the pool */ 2631195e687SMark J Musante int import : 1; 264663207adSDon Brady int name_flags; 2651195e687SMark J Musante } splitflags_t; 2661195e687SMark J Musante 267fa9e4066Sahrens /* 268fa9e4066Sahrens * Functions to manipulate pool and vdev state 269fa9e4066Sahrens */ 2701702cce7SAlek Pinchuk extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 271094e47e9SGeorge Wilson extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 272094e47e9SGeorge Wilson nvlist_t *); 273468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 274e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *); 2754263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *); 276fa9e4066Sahrens 2779c2acf00SAlek Pinchuk extern int zpool_sync_one(zpool_handle_t *, void *); 2789c2acf00SAlek Pinchuk 2793d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2803d7072f8Seschrock vdev_state_t *); 2813d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2823d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2833d7072f8Seschrock const char *, nvlist_t *, int); 284fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 28599653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2865cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_remove_cancel(zpool_handle_t *); 2875cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); 2881195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2891195e687SMark J Musante splitflags_t); 2903d7072f8Seschrock 291069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 292069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2933d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2943d7072f8Seschrock 295fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 296ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 297573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 298573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2997855d95bSToomas Soome extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *, 3007855d95bSToomas Soome zpool_boot_label_t, uint64_t, int *); 301fa9e4066Sahrens 302b1b8ab34Slling /* 303b1b8ab34Slling * Functions to manage pool properties 304b1b8ab34Slling */ 305b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 3063d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 307c58b3526SAdam Stevko size_t proplen, zprop_source_t *, boolean_t); 308990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 309990b4856Slling zprop_source_t *); 310990b4856Slling 311b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 312b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 313b1b8ab34Slling 314fa9e4066Sahrens /* 315fa9e4066Sahrens * Pool health statistics. 316fa9e4066Sahrens */ 317fa9e4066Sahrens typedef enum { 318fa9e4066Sahrens /* 319fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 320b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 321e0f1c0afSOlaf Faaland * This must be kept in sync with the zfs_msgid_table in 322e0f1c0afSOlaf Faaland * lib/libzfs/libzfs_status.c. 323fa9e4066Sahrens */ 324fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 325fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 326fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 327fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 328b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 329fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 330fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 331fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 332fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 333eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 33495173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 335e0f1c0afSOlaf Faaland ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 336e0f1c0afSOlaf Faaland ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 33732b87932Sek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 33832b87932Sek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 339e0f1c0afSOlaf Faaland ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 340f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 341eb633035STom Caputi ZPOOL_STATUS_ERRATA, /* informational errata available */ 342f67f35c3SEric Schrock 343ad135b5dSChristopher Siden /* 344ad135b5dSChristopher Siden * If the pool has unsupported features but can still be opened in 345ad135b5dSChristopher Siden * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 346ad135b5dSChristopher Siden * pool has unsupported features but cannot be opened at all, its 347ad135b5dSChristopher Siden * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 348ad135b5dSChristopher Siden */ 349ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 350ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 351ad135b5dSChristopher Siden 352f67f35c3SEric Schrock /* 353f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 354f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 355f67f35c3SEric Schrock * checksum errors) has been lost. 356f67f35c3SEric Schrock */ 3573d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 3583d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 359fa9e4066Sahrens 360fa9e4066Sahrens /* 361fa9e4066Sahrens * The following are not faults per se, but still an error possibly 362b81d61a6Slling * requiring administrative attention. There is no corresponding 363fa9e4066Sahrens * message ID. 364fa9e4066Sahrens */ 36557221772SChristopher Siden ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 36657221772SChristopher Siden ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 367fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 368cb605c4dSGerhard Roethlin ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 369c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 370fa9e4066Sahrens 371fa9e4066Sahrens /* 372fa9e4066Sahrens * Finally, the following indicates a healthy pool. 373fa9e4066Sahrens */ 374fa9e4066Sahrens ZPOOL_STATUS_OK 375fa9e4066Sahrens } zpool_status_t; 376fa9e4066Sahrens 377eb633035STom Caputi extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, 378eb633035STom Caputi zpool_errata_t *); 379eb633035STom Caputi extern zpool_status_t zpool_import_status(nvlist_t *, char **, 380eb633035STom Caputi zpool_errata_t *); 3819eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 382fa9e4066Sahrens 383fa9e4066Sahrens /* 384fa9e4066Sahrens * Statistics and configuration functions. 385fa9e4066Sahrens */ 386ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 387ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *); 38894de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 38955434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3907855d95bSToomas Soome extern boolean_t zpool_is_bootable(zpool_handle_t *); 391ea8dc4b6Seschrock 392fa9e4066Sahrens /* 393fa9e4066Sahrens * Import and export functions 394fa9e4066Sahrens */ 3954445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 3964445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *); 39799653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 398990b4856Slling char *altroot); 399990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 4004b964adaSGeorge Wilson nvlist_t *, int); 401ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config); 402fa9e4066Sahrens 403fa9e4066Sahrens /* 404fa9e4066Sahrens * Search for pools to import 405fa9e4066Sahrens */ 406d41c4376SMark J Musante 407d41c4376SMark J Musante typedef struct importargs { 408d41c4376SMark J Musante char **path; /* a list of paths to search */ 409d41c4376SMark J Musante int paths; /* number of paths to search */ 410d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 411d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 412d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 413d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 414d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 415d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 4165dafeea3SPavel Zakharov nvlist_t *policy; /* load policy (max txg, rewind, etc.) */ 417d41c4376SMark J Musante } importargs_t; 418d41c4376SMark J Musante 419d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 420e0f1c0afSOlaf Faaland extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, 421e0f1c0afSOlaf Faaland nvlist_t **configp, importargs_t *args); 422d41c4376SMark J Musante 423d41c4376SMark J Musante /* legacy pool search routines */ 42424e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 4253a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 426e829d913Sck char *, uint64_t); 427fa9e4066Sahrens 428c67d9675Seschrock /* 429c67d9675Seschrock * Miscellaneous pool functions 430c67d9675Seschrock */ 431ecd6cf80Smarks struct zfs_cmd; 432ecd6cf80Smarks 4334445fffbSMatthew Ahrens extern const char *zfs_history_event_names[]; 4348f18d1faSGeorge Wilson 435663207adSDon Brady typedef enum { 436663207adSDon Brady VDEV_NAME_PATH = 1 << 0, 437663207adSDon Brady VDEV_NAME_GUID = 1 << 1, 438663207adSDon Brady VDEV_NAME_FOLLOW_LINKS = 1 << 2, 439663207adSDon Brady VDEV_NAME_TYPE_ID = 1 << 3, 440663207adSDon Brady } vdev_name_t; 441663207adSDon Brady 44288ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 443663207adSDon Brady int name_flags); 444990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 44506eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 4468f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 4478f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 44855434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 44955434c77Sek size_t len); 450ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 451753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 452468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 453468c413aSTim Haley nvlist_t *); 45486714001SSerapheim Dimitropoulos extern int zpool_checkpoint(zpool_handle_t *); 45586714001SSerapheim Dimitropoulos extern int zpool_discard_checkpoint(zpool_handle_t *); 456753a6d45SSherry Moore 457fa9e4066Sahrens /* 458fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 459fa9e4066Sahrens * underlying datasets, only the references to them. 460fa9e4066Sahrens */ 46199653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 46219b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 463fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 464fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 465fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 466d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 4678808ac5dSYuri Pankov extern const char *zfs_get_pool_name(const zfs_handle_t *); 468fa9e4066Sahrens 469fa9e4066Sahrens /* 470fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 471b81d61a6Slling * and are found in sys/fs/zfs.h. 472fa9e4066Sahrens */ 473990b4856Slling 474990b4856Slling /* 475990b4856Slling * zfs dataset property management 476990b4856Slling */ 477990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 478990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 479990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 480990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 481990b4856Slling 482eb633035STom Caputi extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *, 483eb633035STom Caputi uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *); 4840a48a24eStimh 485e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 486e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 48730925561SChris Williamson extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 488e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 489990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 49092241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 49192241e0bSTom Erickson boolean_t); 492e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 493990b4856Slling zprop_source_t *, char *, size_t); 494edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 495edea4b55SLin Ling uint64_t *propvalue); 49614843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 49714843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 49819b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 49919b94df9SMatthew Ahrens uint64_t *propvalue); 50019b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 50119b94df9SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 502ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 503ad135b5dSChristopher Siden char *buf, size_t len); 504e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 50592241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 506e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 507e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 508990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 50992241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 51019b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 51119b94df9SMatthew Ahrens 512e9dbad6fSeschrock 513eb633035STom Caputi /* 514eb633035STom Caputi * zfs encryption management 515eb633035STom Caputi */ 516eb633035STom Caputi extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *); 517eb633035STom Caputi extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *, 518*6ccda740Sloli boolean_t stdin_available, uint8_t **, uint_t *); 519eb633035STom Caputi extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 520eb633035STom Caputi nvlist_t *); 521eb633035STom Caputi extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *); 522eb633035STom Caputi extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *); 523eb633035STom Caputi extern int zfs_crypto_unload_key(zfs_handle_t *); 524eb633035STom Caputi extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 525eb633035STom Caputi 526990b4856Slling typedef struct zprop_list { 527990b4856Slling int pl_prop; 528e9dbad6fSeschrock char *pl_user_prop; 529990b4856Slling struct zprop_list *pl_next; 530e9dbad6fSeschrock boolean_t pl_all; 531e9dbad6fSeschrock size_t pl_width; 53292241e0bSTom Erickson size_t pl_recvd_width; 533e9dbad6fSeschrock boolean_t pl_fixed; 534990b4856Slling } zprop_list_t; 535e9dbad6fSeschrock 53643d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 53743d68d68SYuri Pankov boolean_t); 5382e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 539fa9e4066Sahrens 540fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 541fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 542fa9e4066Sahrens 543ad135b5dSChristopher Siden #define ZFS_FEATURE_DISABLED "disabled" 544ad135b5dSChristopher Siden #define ZFS_FEATURE_ENABLED "enabled" 545ad135b5dSChristopher Siden #define ZFS_FEATURE_ACTIVE "active" 546ad135b5dSChristopher Siden 547ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_INACTIVE "inactive" 548ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_READONLY "readonly" 549ad135b5dSChristopher Siden 550b1b8ab34Slling /* 551990b4856Slling * zpool property management 552990b4856Slling */ 553990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 554ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 555ad135b5dSChristopher Siden size_t); 556990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 557990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 558990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 559990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 560990b4856Slling 561990b4856Slling /* 562990b4856Slling * Functions shared by zfs and zpool property management. 563b1b8ab34Slling */ 564990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 565990b4856Slling boolean_t ordered, zfs_type_t type); 566990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 567990b4856Slling zfs_type_t); 568990b4856Slling extern void zprop_free_list(zprop_list_t *); 569990b4856Slling 57092241e0bSTom Erickson #define ZFS_GET_NCOLS 5 57192241e0bSTom Erickson 57292241e0bSTom Erickson typedef enum { 57392241e0bSTom Erickson GET_COL_NONE, 57492241e0bSTom Erickson GET_COL_NAME, 57592241e0bSTom Erickson GET_COL_PROPERTY, 57692241e0bSTom Erickson GET_COL_VALUE, 57792241e0bSTom Erickson GET_COL_RECVD, 57892241e0bSTom Erickson GET_COL_SOURCE 57992241e0bSTom Erickson } zfs_get_column_t; 58092241e0bSTom Erickson 581990b4856Slling /* 582990b4856Slling * Functions for printing zfs or zpool properties 583990b4856Slling */ 584990b4856Slling typedef struct zprop_get_cbdata { 585b1b8ab34Slling int cb_sources; 58692241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 58792241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 588b1b8ab34Slling boolean_t cb_scripted; 589b1b8ab34Slling boolean_t cb_literal; 590b1b8ab34Slling boolean_t cb_first; 591990b4856Slling zprop_list_t *cb_proplist; 592990b4856Slling zfs_type_t cb_type; 593990b4856Slling } zprop_get_cbdata_t; 594b1b8ab34Slling 595990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 59692241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 59792241e0bSTom Erickson const char *); 598b1b8ab34Slling 599fa9e4066Sahrens /* 600fa9e4066Sahrens * Iterator functions. 601fa9e4066Sahrens */ 602fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 60399653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 604fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 6053bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 6067f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 6070d8fa8f8SMartin Matuska extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 608ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 60919b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 61078f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 611fa9e4066Sahrens 6129d9a58e3SEric Taylor typedef struct get_all_cb { 6139d9a58e3SEric Taylor zfs_handle_t **cb_handles; 6149d9a58e3SEric Taylor size_t cb_alloc; 6159d9a58e3SEric Taylor size_t cb_used; 6169d9a58e3SEric Taylor } get_all_cb_t; 6179d9a58e3SEric Taylor 618591e0e13SSebastien Roy void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t, 619591e0e13SSebastien Roy zfs_iter_f, void *, boolean_t); 6209d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 6219d9a58e3SEric Taylor 622fa9e4066Sahrens /* 623fa9e4066Sahrens * Functions to create and destroy datasets. 624fa9e4066Sahrens */ 62599653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 626e9dbad6fSeschrock nvlist_t *); 6277f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 628842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 629842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 6303b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 631e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 632bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 6334445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 6344445fffbSMatthew Ahrens nvlist_t *props); 635c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 6366a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 6379e69d7d0SLori Alt 6389e69d7d0SLori Alt typedef struct sendflags { 6399e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 64019b94df9SMatthew Ahrens boolean_t verbose; 6419e69d7d0SLori Alt 64292241e0bSTom Erickson /* recursive send (ie, -R) */ 64319b94df9SMatthew Ahrens boolean_t replicate; 6449e69d7d0SLori Alt 6459e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 64619b94df9SMatthew Ahrens boolean_t doall; 6479e69d7d0SLori Alt 6489e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 64919b94df9SMatthew Ahrens boolean_t fromorigin; 6509e69d7d0SLori Alt 6519e69d7d0SLori Alt /* do deduplication */ 65219b94df9SMatthew Ahrens boolean_t dedup; 65392241e0bSTom Erickson 65492241e0bSTom Erickson /* send properties (ie, -p) */ 65519b94df9SMatthew Ahrens boolean_t props; 65619b94df9SMatthew Ahrens 65719b94df9SMatthew Ahrens /* do not send (no-op, ie. -n) */ 65819b94df9SMatthew Ahrens boolean_t dryrun; 65919b94df9SMatthew Ahrens 66019b94df9SMatthew Ahrens /* parsable verbose output (ie. -P) */ 66119b94df9SMatthew Ahrens boolean_t parsable; 6624e3c9f44SBill Pijewski 6634e3c9f44SBill Pijewski /* show progress (ie. -v) */ 6644e3c9f44SBill Pijewski boolean_t progress; 6655d7b4d43SMatthew Ahrens 666b5152584SMatthew Ahrens /* large blocks (>128K) are permitted */ 667b5152584SMatthew Ahrens boolean_t largeblock; 668b5152584SMatthew Ahrens 6695d7b4d43SMatthew Ahrens /* WRITE_EMBEDDED records of type DATA are permitted */ 6705d7b4d43SMatthew Ahrens boolean_t embed_data; 6715602294fSDan Kimmel 6725602294fSDan Kimmel /* compressed WRITE records are permitted */ 6735602294fSDan Kimmel boolean_t compress; 674eb633035STom Caputi 675eb633035STom Caputi /* raw encrypted records are permitted */ 676eb633035STom Caputi boolean_t raw; 677*6ccda740Sloli 678*6ccda740Sloli /* only send received properties (ie. -b) */ 679*6ccda740Sloli boolean_t backup; 680*6ccda740Sloli 681*6ccda740Sloli /* include snapshot holds in send stream */ 682*6ccda740Sloli boolean_t holds; 6839e69d7d0SLori Alt } sendflags_t; 6849e69d7d0SLori Alt 6859e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 6869e69d7d0SLori Alt 68719b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 68819b94df9SMatthew Ahrens sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 6895d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 6909c3fd121SMatthew Ahrens extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 6919c3fd121SMatthew Ahrens const char *); 6929c3fd121SMatthew Ahrens extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 6939c3fd121SMatthew Ahrens const char *token); 6949e69d7d0SLori Alt 69599653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 6963b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *, 697a7a845e4SSteven Hartland boolean_t, int); 698a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 699842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 7001af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 701b73ccab0SMike Gerdts extern uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 702b73ccab0SMike Gerdts nvlist_t *); 703fa9e4066Sahrens 7040aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 70514843421SMatthew Ahrens uid_t rid, uint64_t space); 70614843421SMatthew Ahrens 7071af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 7081af68beaSAlexander Stetsenko zfs_userspace_cb_t, void *); 7091af68beaSAlexander Stetsenko 7101af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 7111af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 71214843421SMatthew Ahrens 7133cb34c60Sahrens typedef struct recvflags { 7144ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 71519b94df9SMatthew Ahrens boolean_t verbose; 7164ccbb6e7Sahrens 7174ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 71819b94df9SMatthew Ahrens boolean_t isprefix; 7194ccbb6e7Sahrens 720f64930f5STom Erickson /* 721f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 722f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 723f64930f5STom Erickson */ 72419b94df9SMatthew Ahrens boolean_t istail; 725f64930f5STom Erickson 7264ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 72719b94df9SMatthew Ahrens boolean_t dryrun; 7284ccbb6e7Sahrens 7294ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 73019b94df9SMatthew Ahrens boolean_t force; 7314ccbb6e7Sahrens 7324ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 73319b94df9SMatthew Ahrens boolean_t canmountoff; 7344ccbb6e7Sahrens 7359c3fd121SMatthew Ahrens /* 7369c3fd121SMatthew Ahrens * Mark the file systems as "resumable" and do not destroy them if the 7379c3fd121SMatthew Ahrens * receive is interrupted 7389c3fd121SMatthew Ahrens */ 7399c3fd121SMatthew Ahrens boolean_t resumable; 7409c3fd121SMatthew Ahrens 7414ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 74219b94df9SMatthew Ahrens boolean_t byteswap; 74333408eefSLori Alt 74433408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 74519b94df9SMatthew Ahrens boolean_t nomount; 746*6ccda740Sloli 747*6ccda740Sloli /* Was holds flag set in the compound header? */ 748*6ccda740Sloli boolean_t holds; 749*6ccda740Sloli 750*6ccda740Sloli /* skip receive of snapshot holds */ 751*6ccda740Sloli boolean_t skipholds; 7523cb34c60Sahrens } recvflags_t; 7533cb34c60Sahrens 754a2cdcdd2SPaul Dagnelie extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 755a2cdcdd2SPaul Dagnelie recvflags_t *, int, avl_tree_t *); 7563cb34c60Sahrens 75799d5e173STim Haley typedef enum diff_flags { 75899d5e173STim Haley ZFS_DIFF_PARSEABLE = 0x1, 75999d5e173STim Haley ZFS_DIFF_TIMESTAMP = 0x2, 76099d5e173STim Haley ZFS_DIFF_CLASSIFY = 0x4 76199d5e173STim Haley } diff_flags_t; 76299d5e173STim Haley 76399d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 76499d5e173STim Haley int); 76599d5e173STim Haley 766fa9e4066Sahrens /* 767fa9e4066Sahrens * Miscellaneous functions. 768fa9e4066Sahrens */ 769fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 770fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 771fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 7725aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 773eb633035STom Caputi extern int zfs_parent_name(zfs_handle_t *, char *, size_t); 7747f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 7757f1f55eaSvb zfs_type_t); 7767b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *); 77778f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path); 778e0f1c0afSOlaf Faaland extern ulong_t get_system_hostid(void); 779fa9e4066Sahrens 780fa9e4066Sahrens /* 781fa9e4066Sahrens * Mount support functions. 782fa9e4066Sahrens */ 78355434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 78499653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 785fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 786fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 787fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 788fa9e4066Sahrens 789fa9e4066Sahrens /* 790fa9e4066Sahrens * Share support functions. 791fa9e4066Sahrens */ 792f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 793fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 794f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 795f3861e1aSahl 796f3861e1aSahl /* 7973d7072f8Seschrock * Protocol-specific share support functions. 798f3861e1aSahl */ 799f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 800da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 801f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 802da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 803da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 804f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 805da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 806f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 807da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 808da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 809da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 810743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 811da6c28aaSamw void *, void *, int, zfs_share_op_t); 812fa9e4066Sahrens 813fa9e4066Sahrens /* 814fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 815fa9e4066Sahrens */ 816fa9e4066Sahrens #ifdef NDEBUG 817fa9e4066Sahrens #define verify(EX) ((void)(EX)) 818fa9e4066Sahrens #else 819fa9e4066Sahrens #define verify(EX) assert(EX) 820fa9e4066Sahrens #endif 821fa9e4066Sahrens 822fa9e4066Sahrens /* 823fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 824fa9e4066Sahrens */ 825fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 826e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 827fa9e4066Sahrens 828fa9e4066Sahrens /* 829fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 830fa9e4066Sahrens */ 83199653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 83299653d4eSeschrock boolean_t *); 833fa9e4066Sahrens 834fa9e4066Sahrens /* 835096d22d4SEric Schrock * Label manipulation. 836fa9e4066Sahrens */ 83799653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 838096d22d4SEric Schrock extern int zpool_clear_label(int); 839fa9e4066Sahrens 840e7cbe64fSgw /* is this zvol valid for use as a dump device? */ 841e7cbe64fSgw extern int zvol_check_dump_config(char *); 842e7cbe64fSgw 843743a77edSAlan Wright /* 844743a77edSAlan Wright * Management interfaces for SMB ACL files 845743a77edSAlan Wright */ 846743a77edSAlan Wright 847743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 848743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 849743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 850743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 851743a77edSAlan Wright 8523bb79becSeschrock /* 853f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 854f3861e1aSahl * sharing/unsharing them. 8553bb79becSeschrock */ 856f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 857f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 8583bb79becSeschrock 859069f55e2SEric Schrock /* 860069f55e2SEric Schrock * Mappings between vdev and FRU. 861069f55e2SEric Schrock */ 862069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 863069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 864069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 865069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 866069f55e2SEric Schrock const char *); 867069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 868069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 869069f55e2SEric Schrock 8702bcf0248SMax Grossman extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *); 8715cabbc6bSPrashanth Sreenivasa extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *); 8722bcf0248SMax Grossman 8738a981c33SDaniel Hoffman /* Allow consumers to initialize libshare externally for optimal performance */ 8748a981c33SDaniel Hoffman extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *); 8758a981c33SDaniel Hoffman /* 8768a981c33SDaniel Hoffman * For most consumers, zfs_init_libshare_arg is sufficient on its own, and 8778a981c33SDaniel Hoffman * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called 8788a981c33SDaniel Hoffman * if the caller has already initialized libshare for one set of zfs handles, 8798a981c33SDaniel Hoffman * and wishes to share or unshare filesystems outside of that set. In that case, 8808a981c33SDaniel Hoffman * the caller should uninitialize libshare, and then re-initialize it with the 8818a981c33SDaniel Hoffman * new handles being shared or unshared. 8828a981c33SDaniel Hoffman */ 8838a981c33SDaniel Hoffman extern void zfs_uninit_libshare(libzfs_handle_t *); 884fa9e4066Sahrens #ifdef __cplusplus 885fa9e4066Sahrens } 886fa9e4066Sahrens #endif 887fa9e4066Sahrens 888fa9e4066Sahrens #endif /* _LIBZFS_H */ 889