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 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 */ 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 */ 143e4c795beSTom Caputi EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 144*eb633035STom Caputi EZFS_CRYPTOFAILED, /* failed to setup encryption */ 145b1b8ab34Slling EZFS_UNKNOWN 1464445fffbSMatthew Ahrens } zfs_error_t; 14799653d4eSeschrock 14899653d4eSeschrock /* 1497855d95bSToomas Soome * UEFI boot support parameters. When creating whole disk boot pool, 1507855d95bSToomas Soome * zpool create should allow to create EFI System partition for UEFI boot 1517855d95bSToomas Soome * program. In case of BIOS, the EFI System partition is not used 1527855d95bSToomas Soome * even if it does exist. 1537855d95bSToomas Soome */ 1547855d95bSToomas Soome typedef enum zpool_boot_label { 1557855d95bSToomas Soome ZPOOL_NO_BOOT_LABEL = 0, 1567855d95bSToomas Soome ZPOOL_CREATE_BOOT_LABEL, 1577855d95bSToomas Soome ZPOOL_COPY_BOOT_LABEL 1587855d95bSToomas Soome } zpool_boot_label_t; 1597855d95bSToomas Soome 1607855d95bSToomas Soome /* 161ecd6cf80Smarks * The following data structures are all part 162ecd6cf80Smarks * of the zfs_allow_t data structure which is 163ecd6cf80Smarks * used for printing 'allow' permissions. 164ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 165ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 166ecd6cf80Smarks * and each one of the entries in those trees have 167ecd6cf80Smarks * avl tree's for the permissions they belong to and 168ecd6cf80Smarks * whether they are local,descendent or local+descendent 169ecd6cf80Smarks * permissions. The AVL trees are used primarily for 170ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 171ecd6cf80Smarks * a given user and or permission. 172ecd6cf80Smarks */ 173ecd6cf80Smarks typedef struct zfs_perm_node { 174ecd6cf80Smarks avl_node_t z_node; 175ecd6cf80Smarks char z_pname[MAXPATHLEN]; 176ecd6cf80Smarks } zfs_perm_node_t; 177ecd6cf80Smarks 178ecd6cf80Smarks typedef struct zfs_allow_node { 179ecd6cf80Smarks avl_node_t z_node; 180ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 181ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 182ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 183ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 184ecd6cf80Smarks } zfs_allow_node_t; 185ecd6cf80Smarks 186ecd6cf80Smarks typedef struct zfs_allow { 187ecd6cf80Smarks struct zfs_allow *z_next; 188ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 189ecd6cf80Smarks avl_tree_t z_sets; 190ecd6cf80Smarks avl_tree_t z_crperms; 191ecd6cf80Smarks avl_tree_t z_user; 192ecd6cf80Smarks avl_tree_t z_group; 193ecd6cf80Smarks avl_tree_t z_everyone; 194ecd6cf80Smarks } zfs_allow_t; 195ecd6cf80Smarks 196ecd6cf80Smarks /* 197fa9e4066Sahrens * Basic handle types 198fa9e4066Sahrens */ 199fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 200fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 20199653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 20299653d4eSeschrock 20399653d4eSeschrock /* 20499653d4eSeschrock * Library initialization 20599653d4eSeschrock */ 20699653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 20799653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 20899653d4eSeschrock 20999653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 21099653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 21199653d4eSeschrock 21299653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 21399653d4eSeschrock 2144445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int); 2154445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *); 2164445fffbSMatthew Ahrens 21799653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 21899653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 21999653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 22078f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *); 221ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 222ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 223b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 224ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 225ebedde84SEric Taylor struct mnttab *); 226ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 227ebedde84SEric Taylor const char *, const char *); 228ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 229fa9e4066Sahrens 230fa9e4066Sahrens /* 231fa9e4066Sahrens * Basic handle functions 232fa9e4066Sahrens */ 23399653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 23499653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 235fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 236fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 237fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 2386401734dSWill Andrews extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 2396401734dSWill Andrews extern const char *zpool_pool_state_to_name(pool_state_t); 24029ab75c9Srm160521 extern void zpool_free_handles(libzfs_handle_t *); 241fa9e4066Sahrens 242fa9e4066Sahrens /* 243fa9e4066Sahrens * Iterate over all active pools in the system. 244fa9e4066Sahrens */ 245fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 24699653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 2478808ac5dSYuri Pankov extern boolean_t zpool_skip_pool(const char *); 248fa9e4066Sahrens 249fa9e4066Sahrens /* 250fa9e4066Sahrens * Functions to create and destroy pools 251fa9e4066Sahrens */ 25299653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2530a48a24eStimh nvlist_t *, nvlist_t *); 2544445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *); 255fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 256fa9e4066Sahrens 2571195e687SMark J Musante typedef struct splitflags { 2581195e687SMark J Musante /* do not split, but return the config that would be split off */ 2591195e687SMark J Musante int dryrun : 1; 2601195e687SMark J Musante 2611195e687SMark J Musante /* after splitting, import the pool */ 2621195e687SMark J Musante int import : 1; 263663207adSDon Brady int name_flags; 2641195e687SMark J Musante } splitflags_t; 2651195e687SMark J Musante 266fa9e4066Sahrens /* 267fa9e4066Sahrens * Functions to manipulate pool and vdev state 268fa9e4066Sahrens */ 2691702cce7SAlek Pinchuk extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 270094e47e9SGeorge Wilson extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 271094e47e9SGeorge Wilson nvlist_t *); 272468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 273e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *); 2744263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *); 275fa9e4066Sahrens 2769c2acf00SAlek Pinchuk extern int zpool_sync_one(zpool_handle_t *, void *); 2779c2acf00SAlek Pinchuk 2783d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2793d7072f8Seschrock vdev_state_t *); 2803d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2813d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2823d7072f8Seschrock const char *, nvlist_t *, int); 283fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 28499653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2855cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_remove_cancel(zpool_handle_t *); 2865cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); 2871195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2881195e687SMark J Musante splitflags_t); 2893d7072f8Seschrock 290069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 291069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2923d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2933d7072f8Seschrock 294fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 295ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 296573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 297573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2987855d95bSToomas Soome extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *, 2997855d95bSToomas Soome zpool_boot_label_t, uint64_t, int *); 300fa9e4066Sahrens 301fa9e4066Sahrens /* 302b1b8ab34Slling * Functions to manage pool properties 303b1b8ab34Slling */ 304b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 3053d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 306c58b3526SAdam Stevko size_t proplen, zprop_source_t *, boolean_t); 307990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 308990b4856Slling zprop_source_t *); 309990b4856Slling 310b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 311b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 312b1b8ab34Slling 313b1b8ab34Slling /* 314fa9e4066Sahrens * Pool health statistics. 315fa9e4066Sahrens */ 316fa9e4066Sahrens typedef enum { 317fa9e4066Sahrens /* 318fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 319b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 320e0f1c0afSOlaf Faaland * This must be kept in sync with the zfs_msgid_table in 321e0f1c0afSOlaf Faaland * lib/libzfs/libzfs_status.c. 322fa9e4066Sahrens */ 323fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 324fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 325fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 326fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 327b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 328fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 329fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 330fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 331fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 332eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 33395173954Sek110237 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 334e0f1c0afSOlaf Faaland ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 335e0f1c0afSOlaf Faaland ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 33632b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 33732b87932Sek110237 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 338e0f1c0afSOlaf Faaland ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 339f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 340*eb633035STom Caputi ZPOOL_STATUS_ERRATA, /* informational errata available */ 341f67f35c3SEric Schrock 342f67f35c3SEric Schrock /* 343ad135b5dSChristopher Siden * If the pool has unsupported features but can still be opened in 344ad135b5dSChristopher Siden * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 345ad135b5dSChristopher Siden * pool has unsupported features but cannot be opened at all, its 346ad135b5dSChristopher Siden * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 347ad135b5dSChristopher Siden */ 348ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 349ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 350ad135b5dSChristopher Siden 351ad135b5dSChristopher Siden /* 352f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 353f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 354f67f35c3SEric Schrock * checksum errors) has been lost. 355f67f35c3SEric Schrock */ 3563d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 3573d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 358fa9e4066Sahrens 359fa9e4066Sahrens /* 360fa9e4066Sahrens * The following are not faults per se, but still an error possibly 361b81d61a6Slling * requiring administrative attention. There is no corresponding 362fa9e4066Sahrens * message ID. 363fa9e4066Sahrens */ 36457221772SChristopher Siden ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 36557221772SChristopher Siden ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 366fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 367cb605c4dSGerhard Roethlin ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 368c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 369fa9e4066Sahrens 370fa9e4066Sahrens /* 371fa9e4066Sahrens * Finally, the following indicates a healthy pool. 372fa9e4066Sahrens */ 373fa9e4066Sahrens ZPOOL_STATUS_OK 374fa9e4066Sahrens } zpool_status_t; 375fa9e4066Sahrens 376*eb633035STom Caputi extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, 377*eb633035STom Caputi zpool_errata_t *); 378*eb633035STom Caputi extern zpool_status_t zpool_import_status(nvlist_t *, char **, 379*eb633035STom Caputi zpool_errata_t *); 3809eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 381fa9e4066Sahrens 382fa9e4066Sahrens /* 383fa9e4066Sahrens * Statistics and configuration functions. 384fa9e4066Sahrens */ 385ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 386ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *); 38794de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 38855434c77Sek110237 extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3897855d95bSToomas Soome extern boolean_t zpool_is_bootable(zpool_handle_t *); 390ea8dc4b6Seschrock 391fa9e4066Sahrens /* 392fa9e4066Sahrens * Import and export functions 393fa9e4066Sahrens */ 3944445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 3954445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *); 39699653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 397990b4856Slling char *altroot); 398990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3994b964adaSGeorge Wilson nvlist_t *, int); 400ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config); 401fa9e4066Sahrens 402fa9e4066Sahrens /* 403fa9e4066Sahrens * Search for pools to import 404fa9e4066Sahrens */ 405d41c4376SMark J Musante 406d41c4376SMark J Musante typedef struct importargs { 407d41c4376SMark J Musante char **path; /* a list of paths to search */ 408d41c4376SMark J Musante int paths; /* number of paths to search */ 409d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 410d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 411d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 412d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 413d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 414d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 4155dafeea3SPavel Zakharov nvlist_t *policy; /* load policy (max txg, rewind, etc.) */ 416d41c4376SMark J Musante } importargs_t; 417d41c4376SMark J Musante 418d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 419e0f1c0afSOlaf Faaland extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, 420e0f1c0afSOlaf Faaland nvlist_t **configp, importargs_t *args); 421d41c4376SMark J Musante 422d41c4376SMark J Musante /* legacy pool search routines */ 42324e697d4Sck153898 extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 4243a57275aSck153898 extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 425e829d913Sck153898 char *, uint64_t); 426fa9e4066Sahrens 427fa9e4066Sahrens /* 428c67d9675Seschrock * Miscellaneous pool functions 429c67d9675Seschrock */ 430ecd6cf80Smarks struct zfs_cmd; 431ecd6cf80Smarks 4324445fffbSMatthew Ahrens extern const char *zfs_history_event_names[]; 4338f18d1faSGeorge Wilson 434663207adSDon Brady typedef enum { 435663207adSDon Brady VDEV_NAME_PATH = 1 << 0, 436663207adSDon Brady VDEV_NAME_GUID = 1 << 1, 437663207adSDon Brady VDEV_NAME_FOLLOW_LINKS = 1 << 2, 438663207adSDon Brady VDEV_NAME_TYPE_ID = 1 << 3, 439663207adSDon Brady } vdev_name_t; 440663207adSDon Brady 44188ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 442663207adSDon Brady int name_flags); 443990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 44406eeb2adSek110237 extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 4458f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 4468f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 44755434c77Sek110237 extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 44855434c77Sek110237 size_t len); 449ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 450753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 451468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 452468c413aSTim Haley nvlist_t *); 45386714001SSerapheim Dimitropoulos extern int zpool_checkpoint(zpool_handle_t *); 45486714001SSerapheim Dimitropoulos extern int zpool_discard_checkpoint(zpool_handle_t *); 455753a6d45SSherry Moore 456c67d9675Seschrock /* 457fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 458fa9e4066Sahrens * underlying datasets, only the references to them. 459fa9e4066Sahrens */ 46099653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 46119b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 462fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 463fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 464fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 465d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 4668808ac5dSYuri Pankov extern const char *zfs_get_pool_name(const zfs_handle_t *); 467fa9e4066Sahrens 468fa9e4066Sahrens /* 469fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 470b81d61a6Slling * and are found in sys/fs/zfs.h. 471fa9e4066Sahrens */ 472990b4856Slling 473990b4856Slling /* 474990b4856Slling * zfs dataset property management 475990b4856Slling */ 476990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 477e9dbad6fSeschrock extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 478e9dbad6fSeschrock extern const char *zfs_prop_column_name(zfs_prop_t); 479e9dbad6fSeschrock extern boolean_t zfs_prop_align_right(zfs_prop_t); 480e9dbad6fSeschrock 481*eb633035STom Caputi extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, nvlist_t *, 482*eb633035STom Caputi uint64_t, zfs_handle_t *, zpool_handle_t *, boolean_t, const char *); 4830a48a24eStimh 484990b4856Slling extern const char *zfs_prop_to_name(zfs_prop_t); 485990b4856Slling extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 48630925561SChris Williamson extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 487990b4856Slling extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 488990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 48992241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 49092241e0bSTom Erickson boolean_t); 491990b4856Slling extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 492990b4856Slling zprop_source_t *, char *, size_t); 493edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 494edea4b55SLin Ling uint64_t *propvalue); 49514843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 49614843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 49719b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 49819b94df9SMatthew Ahrens uint64_t *propvalue); 49919b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 50019b94df9SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 501ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 502ad135b5dSChristopher Siden char *buf, size_t len); 503990b4856Slling extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 50492241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 505990b4856Slling extern const char *zfs_prop_values(zfs_prop_t); 506990b4856Slling extern int zfs_prop_is_string(zfs_prop_t prop); 507990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 50892241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 50919b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 51019b94df9SMatthew Ahrens 511990b4856Slling 512*eb633035STom Caputi /* 513*eb633035STom Caputi * zfs encryption management 514*eb633035STom Caputi */ 515*eb633035STom Caputi extern int zfs_crypto_get_encryption_root(zfs_handle_t *, boolean_t *, char *); 516*eb633035STom Caputi extern int zfs_crypto_create(libzfs_handle_t *, char *, nvlist_t *, nvlist_t *, 517*eb633035STom Caputi uint8_t **, uint_t *); 518*eb633035STom Caputi extern int zfs_crypto_clone_check(libzfs_handle_t *, zfs_handle_t *, char *, 519*eb633035STom Caputi nvlist_t *); 520*eb633035STom Caputi extern int zfs_crypto_attempt_load_keys(libzfs_handle_t *, char *); 521*eb633035STom Caputi extern int zfs_crypto_load_key(zfs_handle_t *, boolean_t, char *); 522*eb633035STom Caputi extern int zfs_crypto_unload_key(zfs_handle_t *); 523*eb633035STom Caputi extern int zfs_crypto_rewrap(zfs_handle_t *, nvlist_t *, boolean_t); 524*eb633035STom Caputi 525990b4856Slling typedef struct zprop_list { 526990b4856Slling int pl_prop; 527e9dbad6fSeschrock char *pl_user_prop; 528990b4856Slling struct zprop_list *pl_next; 529e9dbad6fSeschrock boolean_t pl_all; 530e9dbad6fSeschrock size_t pl_width; 53192241e0bSTom Erickson size_t pl_recvd_width; 532e9dbad6fSeschrock boolean_t pl_fixed; 533990b4856Slling } zprop_list_t; 534e9dbad6fSeschrock 53543d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 53643d68d68SYuri Pankov boolean_t); 5372e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 538fa9e4066Sahrens 539fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 540fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 541fa9e4066Sahrens 542ad135b5dSChristopher Siden #define ZFS_FEATURE_DISABLED "disabled" 543ad135b5dSChristopher Siden #define ZFS_FEATURE_ENABLED "enabled" 544ad135b5dSChristopher Siden #define ZFS_FEATURE_ACTIVE "active" 545ad135b5dSChristopher Siden 546ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_INACTIVE "inactive" 547ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_READONLY "readonly" 548ad135b5dSChristopher Siden 549fa9e4066Sahrens /* 550990b4856Slling * zpool property management 551b1b8ab34Slling */ 552990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 553ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 554ad135b5dSChristopher Siden size_t); 555990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 556990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 557990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 558990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 559990b4856Slling 560990b4856Slling /* 561990b4856Slling * Functions shared by zfs and zpool property management. 562990b4856Slling */ 563990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 564990b4856Slling boolean_t ordered, zfs_type_t type); 565990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 566990b4856Slling zfs_type_t); 567990b4856Slling extern void zprop_free_list(zprop_list_t *); 568990b4856Slling 56992241e0bSTom Erickson #define ZFS_GET_NCOLS 5 57092241e0bSTom Erickson 57192241e0bSTom Erickson typedef enum { 57292241e0bSTom Erickson GET_COL_NONE, 57392241e0bSTom Erickson GET_COL_NAME, 57492241e0bSTom Erickson GET_COL_PROPERTY, 57592241e0bSTom Erickson GET_COL_VALUE, 57692241e0bSTom Erickson GET_COL_RECVD, 57792241e0bSTom Erickson GET_COL_SOURCE 57892241e0bSTom Erickson } zfs_get_column_t; 57992241e0bSTom Erickson 580990b4856Slling /* 581990b4856Slling * Functions for printing zfs or zpool properties 582990b4856Slling */ 583990b4856Slling typedef struct zprop_get_cbdata { 584b1b8ab34Slling int cb_sources; 58592241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 58692241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 587b1b8ab34Slling boolean_t cb_scripted; 588b1b8ab34Slling boolean_t cb_literal; 589b1b8ab34Slling boolean_t cb_first; 590990b4856Slling zprop_list_t *cb_proplist; 591990b4856Slling zfs_type_t cb_type; 592990b4856Slling } zprop_get_cbdata_t; 593b1b8ab34Slling 594990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 59592241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 59692241e0bSTom Erickson const char *); 597b1b8ab34Slling 598b1b8ab34Slling /* 599fa9e4066Sahrens * Iterator functions. 600fa9e4066Sahrens */ 601fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 60299653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 603fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 6043bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 6057f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 6060d8fa8f8SMartin Matuska extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 607ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 60819b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 60978f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 610fa9e4066Sahrens 6119d9a58e3SEric Taylor typedef struct get_all_cb { 6129d9a58e3SEric Taylor zfs_handle_t **cb_handles; 6139d9a58e3SEric Taylor size_t cb_alloc; 6149d9a58e3SEric Taylor size_t cb_used; 6159d9a58e3SEric Taylor } get_all_cb_t; 6169d9a58e3SEric Taylor 617591e0e13SSebastien Roy void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t, 618591e0e13SSebastien Roy zfs_iter_f, void *, boolean_t); 6199d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 6209d9a58e3SEric Taylor 621fa9e4066Sahrens /* 622fa9e4066Sahrens * Functions to create and destroy datasets. 623fa9e4066Sahrens */ 62499653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 625e9dbad6fSeschrock nvlist_t *); 6267f1f55eaSvb160487 extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 627842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 628842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 6293b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 630e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 631bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 6324445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 6334445fffbSMatthew Ahrens nvlist_t *props); 634c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 6356a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 6369e69d7d0SLori Alt 6379e69d7d0SLori Alt typedef struct sendflags { 6389e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 63919b94df9SMatthew Ahrens boolean_t verbose; 6409e69d7d0SLori Alt 64192241e0bSTom Erickson /* recursive send (ie, -R) */ 64219b94df9SMatthew Ahrens boolean_t replicate; 6439e69d7d0SLori Alt 6449e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 64519b94df9SMatthew Ahrens boolean_t doall; 6469e69d7d0SLori Alt 6479e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 64819b94df9SMatthew Ahrens boolean_t fromorigin; 6499e69d7d0SLori Alt 6509e69d7d0SLori Alt /* do deduplication */ 65119b94df9SMatthew Ahrens boolean_t dedup; 65292241e0bSTom Erickson 65392241e0bSTom Erickson /* send properties (ie, -p) */ 65419b94df9SMatthew Ahrens boolean_t props; 65519b94df9SMatthew Ahrens 65619b94df9SMatthew Ahrens /* do not send (no-op, ie. -n) */ 65719b94df9SMatthew Ahrens boolean_t dryrun; 65819b94df9SMatthew Ahrens 65919b94df9SMatthew Ahrens /* parsable verbose output (ie. -P) */ 66019b94df9SMatthew Ahrens boolean_t parsable; 6614e3c9f44SBill Pijewski 6624e3c9f44SBill Pijewski /* show progress (ie. -v) */ 6634e3c9f44SBill Pijewski boolean_t progress; 6645d7b4d43SMatthew Ahrens 665b5152584SMatthew Ahrens /* large blocks (>128K) are permitted */ 666b5152584SMatthew Ahrens boolean_t largeblock; 667b5152584SMatthew Ahrens 6685d7b4d43SMatthew Ahrens /* WRITE_EMBEDDED records of type DATA are permitted */ 6695d7b4d43SMatthew Ahrens boolean_t embed_data; 6705602294fSDan Kimmel 6715602294fSDan Kimmel /* compressed WRITE records are permitted */ 6725602294fSDan Kimmel boolean_t compress; 673*eb633035STom Caputi 674*eb633035STom Caputi /* raw encrypted records are permitted */ 675*eb633035STom Caputi boolean_t raw; 6769e69d7d0SLori Alt } sendflags_t; 6779e69d7d0SLori Alt 6789e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 6799e69d7d0SLori Alt 68019b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 68119b94df9SMatthew Ahrens sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 6825d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 6839c3fd121SMatthew Ahrens extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 6849c3fd121SMatthew Ahrens const char *); 6859c3fd121SMatthew Ahrens extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 6869c3fd121SMatthew Ahrens const char *token); 6879e69d7d0SLori Alt 68899653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 6893b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *, 690a7a845e4SSteven Hartland boolean_t, int); 691a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 692842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 6931af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 694b73ccab0SMike Gerdts extern uint64_t zvol_volsize_to_reservation(zpool_handle_t *, uint64_t, 695b73ccab0SMike Gerdts nvlist_t *); 696fa9e4066Sahrens 6970aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 69814843421SMatthew Ahrens uid_t rid, uint64_t space); 69914843421SMatthew Ahrens 7001af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 7011af68beaSAlexander Stetsenko zfs_userspace_cb_t, void *); 7021af68beaSAlexander Stetsenko 7031af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 7041af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 70514843421SMatthew Ahrens 7063cb34c60Sahrens typedef struct recvflags { 7074ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 70819b94df9SMatthew Ahrens boolean_t verbose; 7094ccbb6e7Sahrens 7104ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 71119b94df9SMatthew Ahrens boolean_t isprefix; 7124ccbb6e7Sahrens 713f64930f5STom Erickson /* 714f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 715f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 716f64930f5STom Erickson */ 71719b94df9SMatthew Ahrens boolean_t istail; 718f64930f5STom Erickson 7194ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 72019b94df9SMatthew Ahrens boolean_t dryrun; 7214ccbb6e7Sahrens 7224ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 72319b94df9SMatthew Ahrens boolean_t force; 7244ccbb6e7Sahrens 7254ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 72619b94df9SMatthew Ahrens boolean_t canmountoff; 7274ccbb6e7Sahrens 7289c3fd121SMatthew Ahrens /* 7299c3fd121SMatthew Ahrens * Mark the file systems as "resumable" and do not destroy them if the 7309c3fd121SMatthew Ahrens * receive is interrupted 7319c3fd121SMatthew Ahrens */ 7329c3fd121SMatthew Ahrens boolean_t resumable; 7339c3fd121SMatthew Ahrens 7344ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 73519b94df9SMatthew Ahrens boolean_t byteswap; 73633408eefSLori Alt 73733408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 73819b94df9SMatthew Ahrens boolean_t nomount; 7393cb34c60Sahrens } recvflags_t; 7403cb34c60Sahrens 741a2cdcdd2SPaul Dagnelie extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 742a2cdcdd2SPaul Dagnelie recvflags_t *, int, avl_tree_t *); 7433cb34c60Sahrens 74499d5e173STim Haley typedef enum diff_flags { 74599d5e173STim Haley ZFS_DIFF_PARSEABLE = 0x1, 74699d5e173STim Haley ZFS_DIFF_TIMESTAMP = 0x2, 74799d5e173STim Haley ZFS_DIFF_CLASSIFY = 0x4 74899d5e173STim Haley } diff_flags_t; 74999d5e173STim Haley 75099d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 75199d5e173STim Haley int); 75299d5e173STim Haley 753fa9e4066Sahrens /* 754fa9e4066Sahrens * Miscellaneous functions. 755fa9e4066Sahrens */ 756fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 757fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 758fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 7595aba80dbSck153898 extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 760*eb633035STom Caputi extern int zfs_parent_name(zfs_handle_t *, char *, size_t); 7617f1f55eaSvb160487 extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 7627f1f55eaSvb160487 zfs_type_t); 7637b97dc1aSrm160521 extern int zfs_spa_version(zfs_handle_t *, int *); 76478f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path); 765e0f1c0afSOlaf Faaland extern ulong_t get_system_hostid(void); 766fa9e4066Sahrens 767fa9e4066Sahrens /* 768fa9e4066Sahrens * Mount support functions. 769fa9e4066Sahrens */ 77055434c77Sek110237 extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 77199653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 772fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 773fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 774fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 775fa9e4066Sahrens 776fa9e4066Sahrens /* 777fa9e4066Sahrens * Share support functions. 778fa9e4066Sahrens */ 779f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 780fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 781f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 782f3861e1aSahl 783f3861e1aSahl /* 7843d7072f8Seschrock * Protocol-specific share support functions. 785f3861e1aSahl */ 786f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 787da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 788f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 789da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 790da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 791f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 792da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 793f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 794da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 795da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 796da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 797743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 798da6c28aaSamw void *, void *, int, zfs_share_op_t); 799fa9e4066Sahrens 800fa9e4066Sahrens /* 801fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 802fa9e4066Sahrens */ 803fa9e4066Sahrens #ifdef NDEBUG 804fa9e4066Sahrens #define verify(EX) ((void)(EX)) 805fa9e4066Sahrens #else 806fa9e4066Sahrens #define verify(EX) assert(EX) 807fa9e4066Sahrens #endif 808fa9e4066Sahrens 809fa9e4066Sahrens /* 810fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 811fa9e4066Sahrens */ 812fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 813e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 814fa9e4066Sahrens 815fa9e4066Sahrens /* 816fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 817fa9e4066Sahrens */ 81899653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 81999653d4eSeschrock boolean_t *); 820fa9e4066Sahrens 821fa9e4066Sahrens /* 822096d22d4SEric Schrock * Label manipulation. 823fa9e4066Sahrens */ 82499653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 825096d22d4SEric Schrock extern int zpool_clear_label(int); 826fa9e4066Sahrens 827e7cbe64fSgw25295 /* is this zvol valid for use as a dump device? */ 828e7cbe64fSgw25295 extern int zvol_check_dump_config(char *); 829e7cbe64fSgw25295 8303bb79becSeschrock /* 831743a77edSAlan Wright * Management interfaces for SMB ACL files 832743a77edSAlan Wright */ 833743a77edSAlan Wright 834743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 835743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 836743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 837743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 838743a77edSAlan Wright 839743a77edSAlan Wright /* 840f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 841f3861e1aSahl * sharing/unsharing them. 8423bb79becSeschrock */ 843f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 844f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 8453bb79becSeschrock 846069f55e2SEric Schrock /* 847069f55e2SEric Schrock * Mappings between vdev and FRU. 848069f55e2SEric Schrock */ 849069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 850069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 851069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 852069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 853069f55e2SEric Schrock const char *); 854069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 855069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 856069f55e2SEric Schrock 8572bcf0248SMax Grossman extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *); 8585cabbc6bSPrashanth Sreenivasa extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *); 8592bcf0248SMax Grossman 8608a981c33SDaniel Hoffman /* Allow consumers to initialize libshare externally for optimal performance */ 8618a981c33SDaniel Hoffman extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *); 8628a981c33SDaniel Hoffman /* 8638a981c33SDaniel Hoffman * For most consumers, zfs_init_libshare_arg is sufficient on its own, and 8648a981c33SDaniel Hoffman * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called 8658a981c33SDaniel Hoffman * if the caller has already initialized libshare for one set of zfs handles, 8668a981c33SDaniel Hoffman * and wishes to share or unshare filesystems outside of that set. In that case, 8678a981c33SDaniel Hoffman * the caller should uninitialize libshare, and then re-initialize it with the 8688a981c33SDaniel Hoffman * new handles being shared or unshared. 8698a981c33SDaniel Hoffman */ 8708a981c33SDaniel Hoffman extern void zfs_uninit_libshare(libzfs_handle_t *); 871fa9e4066Sahrens #ifdef __cplusplus 872fa9e4066Sahrens } 873fa9e4066Sahrens #endif 874fa9e4066Sahrens 875fa9e4066Sahrens #endif /* _LIBZFS_H */ 876