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*e4c795beSTom Caputi EZFS_NO_RESILVER_DEFER, /* pool doesn't support resilver_defer */ 144b1b8ab34Slling EZFS_UNKNOWN 1454445fffbSMatthew Ahrens } zfs_error_t; 14699653d4eSeschrock 1477855d95bSToomas Soome /* 1487855d95bSToomas Soome * UEFI boot support parameters. When creating whole disk boot pool, 1497855d95bSToomas Soome * zpool create should allow to create EFI System partition for UEFI boot 1507855d95bSToomas Soome * program. In case of BIOS, the EFI System partition is not used 1517855d95bSToomas Soome * even if it does exist. 1527855d95bSToomas Soome */ 1537855d95bSToomas Soome typedef enum zpool_boot_label { 1547855d95bSToomas Soome ZPOOL_NO_BOOT_LABEL = 0, 1557855d95bSToomas Soome ZPOOL_CREATE_BOOT_LABEL, 1567855d95bSToomas Soome ZPOOL_COPY_BOOT_LABEL 1577855d95bSToomas Soome } zpool_boot_label_t; 1587855d95bSToomas Soome 159ecd6cf80Smarks /* 160ecd6cf80Smarks * The following data structures are all part 161ecd6cf80Smarks * of the zfs_allow_t data structure which is 162ecd6cf80Smarks * used for printing 'allow' permissions. 163ecd6cf80Smarks * It is a linked list of zfs_allow_t's which 164ecd6cf80Smarks * then contain avl tree's for user/group/sets/... 165ecd6cf80Smarks * and each one of the entries in those trees have 166ecd6cf80Smarks * avl tree's for the permissions they belong to and 167ecd6cf80Smarks * whether they are local,descendent or local+descendent 168ecd6cf80Smarks * permissions. The AVL trees are used primarily for 169ecd6cf80Smarks * sorting purposes, but also so that we can quickly find 170ecd6cf80Smarks * a given user and or permission. 171ecd6cf80Smarks */ 172ecd6cf80Smarks typedef struct zfs_perm_node { 173ecd6cf80Smarks avl_node_t z_node; 174ecd6cf80Smarks char z_pname[MAXPATHLEN]; 175ecd6cf80Smarks } zfs_perm_node_t; 176ecd6cf80Smarks 177ecd6cf80Smarks typedef struct zfs_allow_node { 178ecd6cf80Smarks avl_node_t z_node; 179ecd6cf80Smarks char z_key[MAXPATHLEN]; /* name, such as joe */ 180ecd6cf80Smarks avl_tree_t z_localdescend; /* local+descendent perms */ 181ecd6cf80Smarks avl_tree_t z_local; /* local permissions */ 182ecd6cf80Smarks avl_tree_t z_descend; /* descendent permissions */ 183ecd6cf80Smarks } zfs_allow_node_t; 184ecd6cf80Smarks 185ecd6cf80Smarks typedef struct zfs_allow { 186ecd6cf80Smarks struct zfs_allow *z_next; 187ecd6cf80Smarks char z_setpoint[MAXPATHLEN]; 188ecd6cf80Smarks avl_tree_t z_sets; 189ecd6cf80Smarks avl_tree_t z_crperms; 190ecd6cf80Smarks avl_tree_t z_user; 191ecd6cf80Smarks avl_tree_t z_group; 192ecd6cf80Smarks avl_tree_t z_everyone; 193ecd6cf80Smarks } zfs_allow_t; 194ecd6cf80Smarks 195fa9e4066Sahrens /* 196fa9e4066Sahrens * Basic handle types 197fa9e4066Sahrens */ 198fa9e4066Sahrens typedef struct zfs_handle zfs_handle_t; 199fa9e4066Sahrens typedef struct zpool_handle zpool_handle_t; 20099653d4eSeschrock typedef struct libzfs_handle libzfs_handle_t; 20199653d4eSeschrock 20299653d4eSeschrock /* 20399653d4eSeschrock * Library initialization 20499653d4eSeschrock */ 20599653d4eSeschrock extern libzfs_handle_t *libzfs_init(void); 20699653d4eSeschrock extern void libzfs_fini(libzfs_handle_t *); 20799653d4eSeschrock 20899653d4eSeschrock extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); 20999653d4eSeschrock extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); 21099653d4eSeschrock 21199653d4eSeschrock extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); 21299653d4eSeschrock 2134445fffbSMatthew Ahrens extern void zfs_save_arguments(int argc, char **, char *, int); 2144445fffbSMatthew Ahrens extern int zpool_log_history(libzfs_handle_t *, const char *); 2154445fffbSMatthew Ahrens 21699653d4eSeschrock extern int libzfs_errno(libzfs_handle_t *); 21799653d4eSeschrock extern const char *libzfs_error_action(libzfs_handle_t *); 21899653d4eSeschrock extern const char *libzfs_error_description(libzfs_handle_t *); 21978f17100SMatthew Ahrens extern int zfs_standard_error(libzfs_handle_t *, int, const char *); 220ebedde84SEric Taylor extern void libzfs_mnttab_init(libzfs_handle_t *); 221ebedde84SEric Taylor extern void libzfs_mnttab_fini(libzfs_handle_t *); 222b2634b9cSEric Taylor extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); 223ebedde84SEric Taylor extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, 224ebedde84SEric Taylor struct mnttab *); 225ebedde84SEric Taylor extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, 226ebedde84SEric Taylor const char *, const char *); 227ebedde84SEric Taylor extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); 228fa9e4066Sahrens 229fa9e4066Sahrens /* 230fa9e4066Sahrens * Basic handle functions 231fa9e4066Sahrens */ 23299653d4eSeschrock extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); 23399653d4eSeschrock extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); 234fa9e4066Sahrens extern void zpool_close(zpool_handle_t *); 235fa9e4066Sahrens extern const char *zpool_get_name(zpool_handle_t *); 236fa9e4066Sahrens extern int zpool_get_state(zpool_handle_t *); 2376401734dSWill Andrews extern const char *zpool_state_to_name(vdev_state_t, vdev_aux_t); 2386401734dSWill Andrews extern const char *zpool_pool_state_to_name(pool_state_t); 23929ab75c9Srm extern void zpool_free_handles(libzfs_handle_t *); 240fa9e4066Sahrens 241fa9e4066Sahrens /* 242fa9e4066Sahrens * Iterate over all active pools in the system. 243fa9e4066Sahrens */ 244fa9e4066Sahrens typedef int (*zpool_iter_f)(zpool_handle_t *, void *); 24599653d4eSeschrock extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); 2468808ac5dSYuri Pankov extern boolean_t zpool_skip_pool(const char *); 247fa9e4066Sahrens 248fa9e4066Sahrens /* 249fa9e4066Sahrens * Functions to create and destroy pools 250fa9e4066Sahrens */ 25199653d4eSeschrock extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, 2520a48a24eStimh nvlist_t *, nvlist_t *); 2534445fffbSMatthew Ahrens extern int zpool_destroy(zpool_handle_t *, const char *); 254fa9e4066Sahrens extern int zpool_add(zpool_handle_t *, nvlist_t *); 255fa9e4066Sahrens 2561195e687SMark J Musante typedef struct splitflags { 2571195e687SMark J Musante /* do not split, but return the config that would be split off */ 2581195e687SMark J Musante int dryrun : 1; 2591195e687SMark J Musante 2601195e687SMark J Musante /* after splitting, import the pool */ 2611195e687SMark J Musante int import : 1; 262663207adSDon Brady int name_flags; 2631195e687SMark J Musante } splitflags_t; 2641195e687SMark J Musante 265fa9e4066Sahrens /* 266fa9e4066Sahrens * Functions to manipulate pool and vdev state 267fa9e4066Sahrens */ 2681702cce7SAlek Pinchuk extern int zpool_scan(zpool_handle_t *, pool_scan_func_t, pool_scrub_cmd_t); 269094e47e9SGeorge Wilson extern int zpool_initialize(zpool_handle_t *, pool_initialize_func_t, 270094e47e9SGeorge Wilson nvlist_t *); 271468c413aSTim Haley extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); 272e9103aaeSGarrett D'Amore extern int zpool_reguid(zpool_handle_t *); 2734263d13fSGeorge Wilson extern int zpool_reopen(zpool_handle_t *); 274fa9e4066Sahrens 2759c2acf00SAlek Pinchuk extern int zpool_sync_one(zpool_handle_t *, void *); 2769c2acf00SAlek Pinchuk 2773d7072f8Seschrock extern int zpool_vdev_online(zpool_handle_t *, const char *, int, 2783d7072f8Seschrock vdev_state_t *); 2793d7072f8Seschrock extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); 2803d7072f8Seschrock extern int zpool_vdev_attach(zpool_handle_t *, const char *, 2813d7072f8Seschrock const char *, nvlist_t *, int); 282fa9e4066Sahrens extern int zpool_vdev_detach(zpool_handle_t *, const char *); 28399653d4eSeschrock extern int zpool_vdev_remove(zpool_handle_t *, const char *); 2845cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_remove_cancel(zpool_handle_t *); 2855cabbc6bSPrashanth Sreenivasa extern int zpool_vdev_indirect_size(zpool_handle_t *, const char *, uint64_t *); 2861195e687SMark J Musante extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, 2871195e687SMark J Musante splitflags_t); 2883d7072f8Seschrock 289069f55e2SEric Schrock extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); 290069f55e2SEric Schrock extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); 2913d7072f8Seschrock extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); 2923d7072f8Seschrock 293fa94a07fSbrendan extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, 294ee0eb9f2SEric Schrock boolean_t *, boolean_t *); 295573ca77eSGeorge Wilson extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, 296573ca77eSGeorge Wilson boolean_t *, boolean_t *, boolean_t *); 2977855d95bSToomas Soome extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, const char *, 2987855d95bSToomas Soome zpool_boot_label_t, uint64_t, int *); 299fa9e4066Sahrens 300b1b8ab34Slling /* 301b1b8ab34Slling * Functions to manage pool properties 302b1b8ab34Slling */ 303b1b8ab34Slling extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); 3043d7072f8Seschrock extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, 305c58b3526SAdam Stevko size_t proplen, zprop_source_t *, boolean_t); 306990b4856Slling extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, 307990b4856Slling zprop_source_t *); 308990b4856Slling 309b1b8ab34Slling extern const char *zpool_prop_to_name(zpool_prop_t); 310b1b8ab34Slling extern const char *zpool_prop_values(zpool_prop_t); 311b1b8ab34Slling 312fa9e4066Sahrens /* 313fa9e4066Sahrens * Pool health statistics. 314fa9e4066Sahrens */ 315fa9e4066Sahrens typedef enum { 316fa9e4066Sahrens /* 317fa9e4066Sahrens * The following correspond to faults as defined in the (fault.fs.zfs.*) 318b81d61a6Slling * event namespace. Each is associated with a corresponding message ID. 319e0f1c0afSOlaf Faaland * This must be kept in sync with the zfs_msgid_table in 320e0f1c0afSOlaf Faaland * lib/libzfs/libzfs_status.c. 321fa9e4066Sahrens */ 322fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ 323fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ 324fa9e4066Sahrens ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ 325fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ 326b81d61a6Slling ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ 327fa9e4066Sahrens ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ 328fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ 329fa9e4066Sahrens ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ 330fa9e4066Sahrens ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ 331eaca9bbdSeschrock ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ 33295173954Sek ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ 333e0f1c0afSOlaf Faaland ZPOOL_STATUS_HOSTID_ACTIVE, /* currently active on another system */ 334e0f1c0afSOlaf Faaland ZPOOL_STATUS_HOSTID_REQUIRED, /* multihost=on and hostid=0 */ 33532b87932Sek ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ 33632b87932Sek ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ 337e0f1c0afSOlaf Faaland ZPOOL_STATUS_IO_FAILURE_MMP, /* failed MMP, failmode not 'panic' */ 338f67f35c3SEric Schrock ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ 339f67f35c3SEric Schrock 340ad135b5dSChristopher Siden /* 341ad135b5dSChristopher Siden * If the pool has unsupported features but can still be opened in 342ad135b5dSChristopher Siden * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the 343ad135b5dSChristopher Siden * pool has unsupported features but cannot be opened at all, its 344ad135b5dSChristopher Siden * status is ZPOOL_STATUS_UNSUP_FEAT_READ. 345ad135b5dSChristopher Siden */ 346ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ 347ad135b5dSChristopher Siden ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ 348ad135b5dSChristopher Siden 349f67f35c3SEric Schrock /* 350f67f35c3SEric Schrock * These faults have no corresponding message ID. At the time we are 351f67f35c3SEric Schrock * checking the status, the original reason for the FMA fault (I/O or 352f67f35c3SEric Schrock * checksum errors) has been lost. 353f67f35c3SEric Schrock */ 3543d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ 3553d7072f8Seschrock ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ 356fa9e4066Sahrens 357fa9e4066Sahrens /* 358fa9e4066Sahrens * The following are not faults per se, but still an error possibly 359b81d61a6Slling * requiring administrative attention. There is no corresponding 360fa9e4066Sahrens * message ID. 361fa9e4066Sahrens */ 36257221772SChristopher Siden ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ 36357221772SChristopher Siden ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ 364fa9e4066Sahrens ZPOOL_STATUS_RESILVERING, /* device being resilvered */ 365cb605c4dSGerhard Roethlin ZPOOL_STATUS_OFFLINE_DEV, /* device offline */ 366c25309d4SGeorge Wilson ZPOOL_STATUS_REMOVED_DEV, /* removed device */ 367fa9e4066Sahrens 368fa9e4066Sahrens /* 369fa9e4066Sahrens * Finally, the following indicates a healthy pool. 370fa9e4066Sahrens */ 371fa9e4066Sahrens ZPOOL_STATUS_OK 372fa9e4066Sahrens } zpool_status_t; 373fa9e4066Sahrens 374ea8dc4b6Seschrock extern zpool_status_t zpool_get_status(zpool_handle_t *, char **); 375ea8dc4b6Seschrock extern zpool_status_t zpool_import_status(nvlist_t *, char **); 3769eb19f4dSGeorge Wilson extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); 377fa9e4066Sahrens 378fa9e4066Sahrens /* 379fa9e4066Sahrens * Statistics and configuration functions. 380fa9e4066Sahrens */ 381ea8dc4b6Seschrock extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); 382ad135b5dSChristopher Siden extern nvlist_t *zpool_get_features(zpool_handle_t *); 38394de1d4cSeschrock extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); 38455434c77Sek extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); 3857855d95bSToomas Soome extern boolean_t zpool_is_bootable(zpool_handle_t *); 386ea8dc4b6Seschrock 387fa9e4066Sahrens /* 388fa9e4066Sahrens * Import and export functions 389fa9e4066Sahrens */ 3904445fffbSMatthew Ahrens extern int zpool_export(zpool_handle_t *, boolean_t, const char *); 3914445fffbSMatthew Ahrens extern int zpool_export_force(zpool_handle_t *, const char *); 39299653d4eSeschrock extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, 393990b4856Slling char *altroot); 394990b4856Slling extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, 3954b964adaSGeorge Wilson nvlist_t *, int); 396ad135b5dSChristopher Siden extern void zpool_print_unsup_feat(nvlist_t *config); 397fa9e4066Sahrens 398fa9e4066Sahrens /* 399fa9e4066Sahrens * Search for pools to import 400fa9e4066Sahrens */ 401d41c4376SMark J Musante 402d41c4376SMark J Musante typedef struct importargs { 403d41c4376SMark J Musante char **path; /* a list of paths to search */ 404d41c4376SMark J Musante int paths; /* number of paths to search */ 405d41c4376SMark J Musante char *poolname; /* name of a pool to find */ 406d41c4376SMark J Musante uint64_t guid; /* guid of a pool to find */ 407d41c4376SMark J Musante char *cachefile; /* cachefile to use for import */ 408d41c4376SMark J Musante int can_be_active : 1; /* can the pool be active? */ 409d41c4376SMark J Musante int unique : 1; /* does 'poolname' already exist? */ 410d41c4376SMark J Musante int exists : 1; /* set on return if pool already exists */ 4115dafeea3SPavel Zakharov nvlist_t *policy; /* load policy (max txg, rewind, etc.) */ 412d41c4376SMark J Musante } importargs_t; 413d41c4376SMark J Musante 414d41c4376SMark J Musante extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); 415e0f1c0afSOlaf Faaland extern int zpool_tryimport(libzfs_handle_t *hdl, char *target, 416e0f1c0afSOlaf Faaland nvlist_t **configp, importargs_t *args); 417d41c4376SMark J Musante 418d41c4376SMark J Musante /* legacy pool search routines */ 41924e697d4Sck extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); 4203a57275aSck extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, 421e829d913Sck char *, uint64_t); 422fa9e4066Sahrens 423c67d9675Seschrock /* 424c67d9675Seschrock * Miscellaneous pool functions 425c67d9675Seschrock */ 426ecd6cf80Smarks struct zfs_cmd; 427ecd6cf80Smarks 4284445fffbSMatthew Ahrens extern const char *zfs_history_event_names[]; 4298f18d1faSGeorge Wilson 430663207adSDon Brady typedef enum { 431663207adSDon Brady VDEV_NAME_PATH = 1 << 0, 432663207adSDon Brady VDEV_NAME_GUID = 1 << 1, 433663207adSDon Brady VDEV_NAME_FOLLOW_LINKS = 1 << 2, 434663207adSDon Brady VDEV_NAME_TYPE_ID = 1 << 3, 435663207adSDon Brady } vdev_name_t; 436663207adSDon Brady 43788ecc943SGeorge Wilson extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, 438663207adSDon Brady int name_flags); 439990b4856Slling extern int zpool_upgrade(zpool_handle_t *, uint64_t); 44006eeb2adSek extern int zpool_get_history(zpool_handle_t *, nvlist_t **); 4418f18d1faSGeorge Wilson extern int zpool_history_unpack(char *, uint64_t, uint64_t *, 4428f18d1faSGeorge Wilson nvlist_t ***, uint_t *); 44355434c77Sek extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, 44455434c77Sek size_t len); 445ecd6cf80Smarks extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); 446753a6d45SSherry Moore extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); 447468c413aSTim Haley extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, 448468c413aSTim Haley nvlist_t *); 44986714001SSerapheim Dimitropoulos extern int zpool_checkpoint(zpool_handle_t *); 45086714001SSerapheim Dimitropoulos extern int zpool_discard_checkpoint(zpool_handle_t *); 451753a6d45SSherry Moore 452fa9e4066Sahrens /* 453fa9e4066Sahrens * Basic handle manipulations. These functions do not create or destroy the 454fa9e4066Sahrens * underlying datasets, only the references to them. 455fa9e4066Sahrens */ 45699653d4eSeschrock extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); 45719b94df9SMatthew Ahrens extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); 458fa9e4066Sahrens extern void zfs_close(zfs_handle_t *); 459fa9e4066Sahrens extern zfs_type_t zfs_get_type(const zfs_handle_t *); 460fa9e4066Sahrens extern const char *zfs_get_name(const zfs_handle_t *); 461d5b5bb25SRich Morris extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); 4628808ac5dSYuri Pankov extern const char *zfs_get_pool_name(const zfs_handle_t *); 463fa9e4066Sahrens 464fa9e4066Sahrens /* 465fa9e4066Sahrens * Property management functions. Some functions are shared with the kernel, 466b81d61a6Slling * and are found in sys/fs/zfs.h. 467fa9e4066Sahrens */ 468990b4856Slling 469990b4856Slling /* 470990b4856Slling * zfs dataset property management 471990b4856Slling */ 472990b4856Slling extern const char *zfs_prop_default_string(zfs_prop_t); 473990b4856Slling extern uint64_t zfs_prop_default_numeric(zfs_prop_t); 474990b4856Slling extern const char *zfs_prop_column_name(zfs_prop_t); 475990b4856Slling extern boolean_t zfs_prop_align_right(zfs_prop_t); 476990b4856Slling 4770a48a24eStimh extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, 478e9316f76SJoe Stein nvlist_t *, uint64_t, zfs_handle_t *, zpool_handle_t *, const char *); 4790a48a24eStimh 480e9dbad6fSeschrock extern const char *zfs_prop_to_name(zfs_prop_t); 481e9dbad6fSeschrock extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); 48230925561SChris Williamson extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); 483e9dbad6fSeschrock extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, 484990b4856Slling zprop_source_t *, char *, size_t, boolean_t); 48592241e0bSTom Erickson extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, 48692241e0bSTom Erickson boolean_t); 487e9dbad6fSeschrock extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, 488990b4856Slling zprop_source_t *, char *, size_t); 489edea4b55SLin Ling extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, 490edea4b55SLin Ling uint64_t *propvalue); 49114843421SMatthew Ahrens extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, 49214843421SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 49319b94df9SMatthew Ahrens extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, 49419b94df9SMatthew Ahrens uint64_t *propvalue); 49519b94df9SMatthew Ahrens extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, 49619b94df9SMatthew Ahrens char *propbuf, int proplen, boolean_t literal); 497ad135b5dSChristopher Siden extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, 498ad135b5dSChristopher Siden char *buf, size_t len); 499e9dbad6fSeschrock extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); 50092241e0bSTom Erickson extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); 501e9dbad6fSeschrock extern const char *zfs_prop_values(zfs_prop_t); 502e9dbad6fSeschrock extern int zfs_prop_is_string(zfs_prop_t prop); 503990b4856Slling extern nvlist_t *zfs_get_user_props(zfs_handle_t *); 50492241e0bSTom Erickson extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); 50519b94df9SMatthew Ahrens extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); 50619b94df9SMatthew Ahrens 507e9dbad6fSeschrock 508990b4856Slling typedef struct zprop_list { 509990b4856Slling int pl_prop; 510e9dbad6fSeschrock char *pl_user_prop; 511990b4856Slling struct zprop_list *pl_next; 512e9dbad6fSeschrock boolean_t pl_all; 513e9dbad6fSeschrock size_t pl_width; 51492241e0bSTom Erickson size_t pl_recvd_width; 515e9dbad6fSeschrock boolean_t pl_fixed; 516990b4856Slling } zprop_list_t; 517e9dbad6fSeschrock 51843d68d68SYuri Pankov extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, 51943d68d68SYuri Pankov boolean_t); 5202e5e9e19SSanjeev Bagewadi extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); 521fa9e4066Sahrens 522fa9e4066Sahrens #define ZFS_MOUNTPOINT_NONE "none" 523fa9e4066Sahrens #define ZFS_MOUNTPOINT_LEGACY "legacy" 524fa9e4066Sahrens 525ad135b5dSChristopher Siden #define ZFS_FEATURE_DISABLED "disabled" 526ad135b5dSChristopher Siden #define ZFS_FEATURE_ENABLED "enabled" 527ad135b5dSChristopher Siden #define ZFS_FEATURE_ACTIVE "active" 528ad135b5dSChristopher Siden 529ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_INACTIVE "inactive" 530ad135b5dSChristopher Siden #define ZFS_UNSUPPORTED_READONLY "readonly" 531ad135b5dSChristopher Siden 532b1b8ab34Slling /* 533990b4856Slling * zpool property management 534990b4856Slling */ 535990b4856Slling extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); 536ad135b5dSChristopher Siden extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, 537ad135b5dSChristopher Siden size_t); 538990b4856Slling extern const char *zpool_prop_default_string(zpool_prop_t); 539990b4856Slling extern uint64_t zpool_prop_default_numeric(zpool_prop_t); 540990b4856Slling extern const char *zpool_prop_column_name(zpool_prop_t); 541990b4856Slling extern boolean_t zpool_prop_align_right(zpool_prop_t); 542990b4856Slling 543990b4856Slling /* 544990b4856Slling * Functions shared by zfs and zpool property management. 545b1b8ab34Slling */ 546990b4856Slling extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, 547990b4856Slling boolean_t ordered, zfs_type_t type); 548990b4856Slling extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, 549990b4856Slling zfs_type_t); 550990b4856Slling extern void zprop_free_list(zprop_list_t *); 551990b4856Slling 55292241e0bSTom Erickson #define ZFS_GET_NCOLS 5 55392241e0bSTom Erickson 55492241e0bSTom Erickson typedef enum { 55592241e0bSTom Erickson GET_COL_NONE, 55692241e0bSTom Erickson GET_COL_NAME, 55792241e0bSTom Erickson GET_COL_PROPERTY, 55892241e0bSTom Erickson GET_COL_VALUE, 55992241e0bSTom Erickson GET_COL_RECVD, 56092241e0bSTom Erickson GET_COL_SOURCE 56192241e0bSTom Erickson } zfs_get_column_t; 56292241e0bSTom Erickson 563990b4856Slling /* 564990b4856Slling * Functions for printing zfs or zpool properties 565990b4856Slling */ 566990b4856Slling typedef struct zprop_get_cbdata { 567b1b8ab34Slling int cb_sources; 56892241e0bSTom Erickson zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; 56992241e0bSTom Erickson int cb_colwidths[ZFS_GET_NCOLS + 1]; 570b1b8ab34Slling boolean_t cb_scripted; 571b1b8ab34Slling boolean_t cb_literal; 572b1b8ab34Slling boolean_t cb_first; 573990b4856Slling zprop_list_t *cb_proplist; 574990b4856Slling zfs_type_t cb_type; 575990b4856Slling } zprop_get_cbdata_t; 576b1b8ab34Slling 577990b4856Slling void zprop_print_one_property(const char *, zprop_get_cbdata_t *, 57892241e0bSTom Erickson const char *, const char *, zprop_source_t, const char *, 57992241e0bSTom Erickson const char *); 580b1b8ab34Slling 581fa9e4066Sahrens /* 582fa9e4066Sahrens * Iterator functions. 583fa9e4066Sahrens */ 584fa9e4066Sahrens typedef int (*zfs_iter_f)(zfs_handle_t *, void *); 58599653d4eSeschrock extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); 586fa9e4066Sahrens extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); 5873bb79becSeschrock extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 5887f7322feSeschrock extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); 5890d8fa8f8SMartin Matuska extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); 590ca45db41SChris Kirby extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); 59119b94df9SMatthew Ahrens extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); 59278f17100SMatthew Ahrens extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); 593fa9e4066Sahrens 5949d9a58e3SEric Taylor typedef struct get_all_cb { 5959d9a58e3SEric Taylor zfs_handle_t **cb_handles; 5969d9a58e3SEric Taylor size_t cb_alloc; 5979d9a58e3SEric Taylor size_t cb_used; 5989d9a58e3SEric Taylor } get_all_cb_t; 5999d9a58e3SEric Taylor 600591e0e13SSebastien Roy void zfs_foreach_mountpoint(libzfs_handle_t *, zfs_handle_t **, size_t, 601591e0e13SSebastien Roy zfs_iter_f, void *, boolean_t); 6029d9a58e3SEric Taylor void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); 6039d9a58e3SEric Taylor 604fa9e4066Sahrens /* 605fa9e4066Sahrens * Functions to create and destroy datasets. 606fa9e4066Sahrens */ 60799653d4eSeschrock extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, 608e9dbad6fSeschrock nvlist_t *); 6097f1f55eaSvb extern int zfs_create_ancestors(libzfs_handle_t *, const char *); 610842727c2SChris Kirby extern int zfs_destroy(zfs_handle_t *, boolean_t); 611842727c2SChris Kirby extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); 6123b2aab18SMatthew Ahrens extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); 613e9dbad6fSeschrock extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); 614bb0ade09Sahrens extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); 6154445fffbSMatthew Ahrens extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, 6164445fffbSMatthew Ahrens nvlist_t *props); 617c391e322Sahrens extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); 6186a9cb0eaSEric Schrock extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); 6199e69d7d0SLori Alt 6209e69d7d0SLori Alt typedef struct sendflags { 6219e69d7d0SLori Alt /* print informational messages (ie, -v was specified) */ 62219b94df9SMatthew Ahrens boolean_t verbose; 6239e69d7d0SLori Alt 62492241e0bSTom Erickson /* recursive send (ie, -R) */ 62519b94df9SMatthew Ahrens boolean_t replicate; 6269e69d7d0SLori Alt 6279e69d7d0SLori Alt /* for incrementals, do all intermediate snapshots */ 62819b94df9SMatthew Ahrens boolean_t doall; 6299e69d7d0SLori Alt 6309e69d7d0SLori Alt /* if dataset is a clone, do incremental from its origin */ 63119b94df9SMatthew Ahrens boolean_t fromorigin; 6329e69d7d0SLori Alt 6339e69d7d0SLori Alt /* do deduplication */ 63419b94df9SMatthew Ahrens boolean_t dedup; 63592241e0bSTom Erickson 63692241e0bSTom Erickson /* send properties (ie, -p) */ 63719b94df9SMatthew Ahrens boolean_t props; 63819b94df9SMatthew Ahrens 63919b94df9SMatthew Ahrens /* do not send (no-op, ie. -n) */ 64019b94df9SMatthew Ahrens boolean_t dryrun; 64119b94df9SMatthew Ahrens 64219b94df9SMatthew Ahrens /* parsable verbose output (ie. -P) */ 64319b94df9SMatthew Ahrens boolean_t parsable; 6444e3c9f44SBill Pijewski 6454e3c9f44SBill Pijewski /* show progress (ie. -v) */ 6464e3c9f44SBill Pijewski boolean_t progress; 6475d7b4d43SMatthew Ahrens 648b5152584SMatthew Ahrens /* large blocks (>128K) are permitted */ 649b5152584SMatthew Ahrens boolean_t largeblock; 650b5152584SMatthew Ahrens 6515d7b4d43SMatthew Ahrens /* WRITE_EMBEDDED records of type DATA are permitted */ 6525d7b4d43SMatthew Ahrens boolean_t embed_data; 6535602294fSDan Kimmel 6545602294fSDan Kimmel /* compressed WRITE records are permitted */ 6555602294fSDan Kimmel boolean_t compress; 6569e69d7d0SLori Alt } sendflags_t; 6579e69d7d0SLori Alt 6589e69d7d0SLori Alt typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); 6599e69d7d0SLori Alt 66019b94df9SMatthew Ahrens extern int zfs_send(zfs_handle_t *, const char *, const char *, 66119b94df9SMatthew Ahrens sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); 6625d7b4d43SMatthew Ahrens extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); 6639c3fd121SMatthew Ahrens extern int zfs_send_resume(libzfs_handle_t *, sendflags_t *, int outfd, 6649c3fd121SMatthew Ahrens const char *); 6659c3fd121SMatthew Ahrens extern nvlist_t *zfs_send_resume_token_to_nvlist(libzfs_handle_t *hdl, 6669c3fd121SMatthew Ahrens const char *token); 6679e69d7d0SLori Alt 66899653d4eSeschrock extern int zfs_promote(zfs_handle_t *); 6693b2aab18SMatthew Ahrens extern int zfs_hold(zfs_handle_t *, const char *, const char *, 670a7a845e4SSteven Hartland boolean_t, int); 671a7a845e4SSteven Hartland extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); 672842727c2SChris Kirby extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); 6731af68beaSAlexander Stetsenko extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); 674c1449561SEric Taylor extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); 675fa9e4066Sahrens 6760aea4b19SMatthew Ahrens typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, 67714843421SMatthew Ahrens uid_t rid, uint64_t space); 67814843421SMatthew Ahrens 6791af68beaSAlexander Stetsenko extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, 6801af68beaSAlexander Stetsenko zfs_userspace_cb_t, void *); 6811af68beaSAlexander Stetsenko 6821af68beaSAlexander Stetsenko extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); 6831af68beaSAlexander Stetsenko extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); 68414843421SMatthew Ahrens 6853cb34c60Sahrens typedef struct recvflags { 6864ccbb6e7Sahrens /* print informational messages (ie, -v was specified) */ 68719b94df9SMatthew Ahrens boolean_t verbose; 6884ccbb6e7Sahrens 6894ccbb6e7Sahrens /* the destination is a prefix, not the exact fs (ie, -d) */ 69019b94df9SMatthew Ahrens boolean_t isprefix; 6914ccbb6e7Sahrens 692f64930f5STom Erickson /* 693f64930f5STom Erickson * Only the tail of the sent snapshot path is appended to the 694f64930f5STom Erickson * destination to determine the received snapshot name (ie, -e). 695f64930f5STom Erickson */ 69619b94df9SMatthew Ahrens boolean_t istail; 697f64930f5STom Erickson 6984ccbb6e7Sahrens /* do not actually do the recv, just check if it would work (ie, -n) */ 69919b94df9SMatthew Ahrens boolean_t dryrun; 7004ccbb6e7Sahrens 7014ccbb6e7Sahrens /* rollback/destroy filesystems as necessary (eg, -F) */ 70219b94df9SMatthew Ahrens boolean_t force; 7034ccbb6e7Sahrens 7044ccbb6e7Sahrens /* set "canmount=off" on all modified filesystems */ 70519b94df9SMatthew Ahrens boolean_t canmountoff; 7064ccbb6e7Sahrens 7079c3fd121SMatthew Ahrens /* 7089c3fd121SMatthew Ahrens * Mark the file systems as "resumable" and do not destroy them if the 7099c3fd121SMatthew Ahrens * receive is interrupted 7109c3fd121SMatthew Ahrens */ 7119c3fd121SMatthew Ahrens boolean_t resumable; 7129c3fd121SMatthew Ahrens 7134ccbb6e7Sahrens /* byteswap flag is used internally; callers need not specify */ 71419b94df9SMatthew Ahrens boolean_t byteswap; 71533408eefSLori Alt 71633408eefSLori Alt /* do not mount file systems as they are extracted (private) */ 71719b94df9SMatthew Ahrens boolean_t nomount; 7183cb34c60Sahrens } recvflags_t; 7193cb34c60Sahrens 720a2cdcdd2SPaul Dagnelie extern int zfs_receive(libzfs_handle_t *, const char *, nvlist_t *, 721a2cdcdd2SPaul Dagnelie recvflags_t *, int, avl_tree_t *); 7223cb34c60Sahrens 72399d5e173STim Haley typedef enum diff_flags { 72499d5e173STim Haley ZFS_DIFF_PARSEABLE = 0x1, 72599d5e173STim Haley ZFS_DIFF_TIMESTAMP = 0x2, 72699d5e173STim Haley ZFS_DIFF_CLASSIFY = 0x4 72799d5e173STim Haley } diff_flags_t; 72899d5e173STim Haley 72999d5e173STim Haley extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, 73099d5e173STim Haley int); 73199d5e173STim Haley 732fa9e4066Sahrens /* 733fa9e4066Sahrens * Miscellaneous functions. 734fa9e4066Sahrens */ 735fa9e4066Sahrens extern const char *zfs_type_to_name(zfs_type_t); 736fa9e4066Sahrens extern void zfs_refresh_properties(zfs_handle_t *); 737fa9e4066Sahrens extern int zfs_name_valid(const char *, zfs_type_t); 7385aba80dbSck extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); 7397f1f55eaSvb extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, 7407f1f55eaSvb zfs_type_t); 7417b97dc1aSrm extern int zfs_spa_version(zfs_handle_t *, int *); 74278f17100SMatthew Ahrens extern boolean_t zfs_bookmark_exists(const char *path); 743e0f1c0afSOlaf Faaland extern ulong_t get_system_hostid(void); 744fa9e4066Sahrens 745fa9e4066Sahrens /* 746fa9e4066Sahrens * Mount support functions. 747fa9e4066Sahrens */ 74855434c77Sek extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); 74999653d4eSeschrock extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); 750fa9e4066Sahrens extern int zfs_mount(zfs_handle_t *, const char *, int); 751fa9e4066Sahrens extern int zfs_unmount(zfs_handle_t *, const char *, int); 752fa9e4066Sahrens extern int zfs_unmountall(zfs_handle_t *, int); 753fa9e4066Sahrens 754fa9e4066Sahrens /* 755fa9e4066Sahrens * Share support functions. 756fa9e4066Sahrens */ 757f3861e1aSahl extern boolean_t zfs_is_shared(zfs_handle_t *); 758fa9e4066Sahrens extern int zfs_share(zfs_handle_t *); 759f3861e1aSahl extern int zfs_unshare(zfs_handle_t *); 760f3861e1aSahl 761f3861e1aSahl /* 7623d7072f8Seschrock * Protocol-specific share support functions. 763f3861e1aSahl */ 764f3861e1aSahl extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); 765da6c28aaSamw extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); 766f3861e1aSahl extern int zfs_share_nfs(zfs_handle_t *); 767da6c28aaSamw extern int zfs_share_smb(zfs_handle_t *); 768da6c28aaSamw extern int zfs_shareall(zfs_handle_t *); 769f3861e1aSahl extern int zfs_unshare_nfs(zfs_handle_t *, const char *); 770da6c28aaSamw extern int zfs_unshare_smb(zfs_handle_t *, const char *); 771f3861e1aSahl extern int zfs_unshareall_nfs(zfs_handle_t *); 772da6c28aaSamw extern int zfs_unshareall_smb(zfs_handle_t *); 773da6c28aaSamw extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); 774da6c28aaSamw extern int zfs_unshareall(zfs_handle_t *); 775743a77edSAlan Wright extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, 776da6c28aaSamw void *, void *, int, zfs_share_op_t); 777fa9e4066Sahrens 778fa9e4066Sahrens /* 779fa9e4066Sahrens * When dealing with nvlists, verify() is extremely useful 780fa9e4066Sahrens */ 781fa9e4066Sahrens #ifdef NDEBUG 782fa9e4066Sahrens #define verify(EX) ((void)(EX)) 783fa9e4066Sahrens #else 784fa9e4066Sahrens #define verify(EX) assert(EX) 785fa9e4066Sahrens #endif 786fa9e4066Sahrens 787fa9e4066Sahrens /* 788fa9e4066Sahrens * Utility function to convert a number to a human-readable form. 789fa9e4066Sahrens */ 790fa9e4066Sahrens extern void zfs_nicenum(uint64_t, char *, size_t); 791e9dbad6fSeschrock extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); 792fa9e4066Sahrens 793fa9e4066Sahrens /* 794fa9e4066Sahrens * Given a device or file, determine if it is part of a pool. 795fa9e4066Sahrens */ 79699653d4eSeschrock extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, 79799653d4eSeschrock boolean_t *); 798fa9e4066Sahrens 799fa9e4066Sahrens /* 800096d22d4SEric Schrock * Label manipulation. 801fa9e4066Sahrens */ 80299653d4eSeschrock extern int zpool_read_label(int, nvlist_t **); 803096d22d4SEric Schrock extern int zpool_clear_label(int); 804fa9e4066Sahrens 805e7cbe64fSgw /* is this zvol valid for use as a dump device? */ 806e7cbe64fSgw extern int zvol_check_dump_config(char *); 807e7cbe64fSgw 808743a77edSAlan Wright /* 809743a77edSAlan Wright * Management interfaces for SMB ACL files 810743a77edSAlan Wright */ 811743a77edSAlan Wright 812743a77edSAlan Wright int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); 813743a77edSAlan Wright int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); 814743a77edSAlan Wright int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); 815743a77edSAlan Wright int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); 816743a77edSAlan Wright 8173bb79becSeschrock /* 818f3861e1aSahl * Enable and disable datasets within a pool by mounting/unmounting and 819f3861e1aSahl * sharing/unsharing them. 8203bb79becSeschrock */ 821f3861e1aSahl extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); 822f3861e1aSahl extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); 8233bb79becSeschrock 824069f55e2SEric Schrock /* 825069f55e2SEric Schrock * Mappings between vdev and FRU. 826069f55e2SEric Schrock */ 827069f55e2SEric Schrock extern void libzfs_fru_refresh(libzfs_handle_t *); 828069f55e2SEric Schrock extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); 829069f55e2SEric Schrock extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); 830069f55e2SEric Schrock extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, 831069f55e2SEric Schrock const char *); 832069f55e2SEric Schrock extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); 833069f55e2SEric Schrock extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); 834069f55e2SEric Schrock 8352bcf0248SMax Grossman extern int zfs_get_hole_count(const char *, uint64_t *, uint64_t *); 8365cabbc6bSPrashanth Sreenivasa extern int zfs_remap_indirects(libzfs_handle_t *hdl, const char *); 8372bcf0248SMax Grossman 8388a981c33SDaniel Hoffman /* Allow consumers to initialize libshare externally for optimal performance */ 8398a981c33SDaniel Hoffman extern int zfs_init_libshare_arg(libzfs_handle_t *, int, void *); 8408a981c33SDaniel Hoffman /* 8418a981c33SDaniel Hoffman * For most consumers, zfs_init_libshare_arg is sufficient on its own, and 8428a981c33SDaniel Hoffman * zfs_uninit_libshare is unnecessary. zfs_uninit_libshare should only be called 8438a981c33SDaniel Hoffman * if the caller has already initialized libshare for one set of zfs handles, 8448a981c33SDaniel Hoffman * and wishes to share or unshare filesystems outside of that set. In that case, 8458a981c33SDaniel Hoffman * the caller should uninitialize libshare, and then re-initialize it with the 8468a981c33SDaniel Hoffman * new handles being shared or unshared. 8478a981c33SDaniel Hoffman */ 8488a981c33SDaniel Hoffman extern void zfs_uninit_libshare(libzfs_handle_t *); 849fa9e4066Sahrens #ifdef __cplusplus 850fa9e4066Sahrens } 851fa9e4066Sahrens #endif 852fa9e4066Sahrens 853fa9e4066Sahrens #endif /* _LIBZFS_H */ 854