]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - zfs/include/libzfs.h
projects / mirror_ubuntu-artful-kernel.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
KVM: SVM: Move spec control call after restore of GS
[mirror_ubuntu-artful-kernel.git] / zfs / include / libzfs.h
CommitLineData
87d546d8
TG		 1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013 by Delphix. All rights reserved.
25 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
26 * Copyright (c) 2013 Steven Hartland. All rights reserved.
27 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
28 */
29
30#ifndef _LIBZFS_H
31#define _LIBZFS_H
32
33#include <assert.h>
34#include <libnvpair.h>
35#include <sys/mnttab.h>
36#include <sys/param.h>
37#include <sys/types.h>
38#include <sys/varargs.h>
39#include <sys/fs/zfs.h>
40#include <sys/avl.h>
41#include <ucred.h>
42#include <libzfs_core.h>
43
44#ifdef __cplusplus
45extern "C" {
46#endif
47
48/*
49 * Miscellaneous ZFS constants
50 */
51#define ZFS_MAXNAMELEN MAXNAMELEN
52#define ZPOOL_MAXNAMELEN MAXNAMELEN
53#define ZFS_MAXPROPLEN MAXPATHLEN
54#define ZPOOL_MAXPROPLEN MAXPATHLEN
55
56/*
57 * Default device paths
58 */
59#define DISK_ROOT "/dev"
60#define UDISK_ROOT "/dev/disk"
61
62/*
63 * Default wait time for a device name to be created.
64 */
65#define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */
66
67#define DEFAULT_IMPORT_PATH_SIZE 7
68extern char *zpool_default_import_path[DEFAULT_IMPORT_PATH_SIZE];
69
70/*
71 * libzfs errors
72 */
73typedef enum zfs_error {
74 EZFS_SUCCESS = 0, /* no error -- success */
75 EZFS_NOMEM = 2000, /* out of memory */
76 EZFS_BADPROP, /* invalid property value */
77 EZFS_PROPREADONLY, /* cannot set readonly property */
78 EZFS_PROPTYPE, /* property does not apply to dataset type */
79 EZFS_PROPNONINHERIT, /* property is not inheritable */
80 EZFS_PROPSPACE, /* bad quota or reservation */
81 EZFS_BADTYPE, /* dataset is not of appropriate type */
82 EZFS_BUSY, /* pool or dataset is busy */
83 EZFS_EXISTS, /* pool or dataset already exists */
84 EZFS_NOENT, /* no such pool or dataset */
85 EZFS_BADSTREAM, /* bad backup stream */
86 EZFS_DSREADONLY, /* dataset is readonly */
87 EZFS_VOLTOOBIG, /* volume is too large for 32-bit system */
88 EZFS_INVALIDNAME, /* invalid dataset name */
89 EZFS_BADRESTORE, /* unable to restore to destination */
90 EZFS_BADBACKUP, /* backup failed */
91 EZFS_BADTARGET, /* bad attach/detach/replace target */
92 EZFS_NODEVICE, /* no such device in pool */
93 EZFS_BADDEV, /* invalid device to add */
94 EZFS_NOREPLICAS, /* no valid replicas */
95 EZFS_RESILVERING, /* currently resilvering */
96 EZFS_BADVERSION, /* unsupported version */
97 EZFS_POOLUNAVAIL, /* pool is currently unavailable */
98 EZFS_DEVOVERFLOW, /* too many devices in one vdev */
99 EZFS_BADPATH, /* must be an absolute path */
100 EZFS_CROSSTARGET, /* rename or clone across pool or dataset */
101 EZFS_ZONED, /* used improperly in local zone */
102 EZFS_MOUNTFAILED, /* failed to mount dataset */
103 EZFS_UMOUNTFAILED, /* failed to unmount dataset */
104 EZFS_UNSHARENFSFAILED, /* unshare(1M) failed */
105 EZFS_SHARENFSFAILED, /* share(1M) failed */
106 EZFS_PERM, /* permission denied */
107 EZFS_NOSPC, /* out of space */
108 EZFS_FAULT, /* bad address */
109 EZFS_IO, /* I/O error */
110 EZFS_INTR, /* signal received */
111 EZFS_ISSPARE, /* device is a hot spare */
112 EZFS_INVALCONFIG, /* invalid vdev configuration */
113 EZFS_RECURSIVE, /* recursive dependency */
114 EZFS_NOHISTORY, /* no history object */
115 EZFS_POOLPROPS, /* couldn't retrieve pool props */
116 EZFS_POOL_NOTSUP, /* ops not supported for this type of pool */
117 EZFS_POOL_INVALARG, /* invalid argument for this pool operation */
118 EZFS_NAMETOOLONG, /* dataset name is too long */
119 EZFS_OPENFAILED, /* open of device failed */
120 EZFS_NOCAP, /* couldn't get capacity */
121 EZFS_LABELFAILED, /* write of label failed */
122 EZFS_BADWHO, /* invalid permission who */
123 EZFS_BADPERM, /* invalid permission */
124 EZFS_BADPERMSET, /* invalid permission set name */
125 EZFS_NODELEGATION, /* delegated administration is disabled */
126 EZFS_UNSHARESMBFAILED, /* failed to unshare over smb */
127 EZFS_SHARESMBFAILED, /* failed to share over smb */
128 EZFS_BADCACHE, /* bad cache file */
129 EZFS_ISL2CACHE, /* device is for the level 2 ARC */
130 EZFS_VDEVNOTSUP, /* unsupported vdev type */
131 EZFS_NOTSUP, /* ops not supported on this dataset */
132 EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */
133 EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */
134 EZFS_REFTAG_RELE, /* snapshot release: tag not found */
135 EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */
136 EZFS_TAGTOOLONG, /* snapshot hold/rele: tag too long */
137 EZFS_PIPEFAILED, /* pipe create failed */
138 EZFS_THREADCREATEFAILED, /* thread create failed */
139 EZFS_POSTSPLIT_ONLINE, /* onlining a disk after splitting it */
140 EZFS_SCRUBBING, /* currently scrubbing */
141 EZFS_NO_SCRUB, /* no active scrub */
142 EZFS_DIFF, /* general failure of zfs diff */
143 EZFS_DIFFDATA, /* bad zfs diff data */
144 EZFS_POOLREADONLY, /* pool is in read-only mode */
145 EZFS_UNKNOWN
146} zfs_error_t;
147
148/*
149 * The following data structures are all part
150 * of the zfs_allow_t data structure which is
151 * used for printing 'allow' permissions.
152 * It is a linked list of zfs_allow_t's which
153 * then contain avl tree's for user/group/sets/...
154 * and each one of the entries in those trees have
155 * avl tree's for the permissions they belong to and
156 * whether they are local,descendent or local+descendent
157 * permissions. The AVL trees are used primarily for
158 * sorting purposes, but also so that we can quickly find
159 * a given user and or permission.
160 */
161typedef struct zfs_perm_node {
162 avl_node_t z_node;
163 char z_pname[MAXPATHLEN];
164} zfs_perm_node_t;
165
166typedef struct zfs_allow_node {
167 avl_node_t z_node;
168 char z_key[MAXPATHLEN]; /* name, such as joe */
169 avl_tree_t z_localdescend; /* local+descendent perms */
170 avl_tree_t z_local; /* local permissions */
171 avl_tree_t z_descend; /* descendent permissions */
172} zfs_allow_node_t;
173
174typedef struct zfs_allow {
175 struct zfs_allow *z_next;
176 char z_setpoint[MAXPATHLEN];
177 avl_tree_t z_sets;
178 avl_tree_t z_crperms;
179 avl_tree_t z_user;
180 avl_tree_t z_group;
181 avl_tree_t z_everyone;
182} zfs_allow_t;
183
184/*
185 * Basic handle types
186 */
187typedef struct zfs_handle zfs_handle_t;
188typedef struct zpool_handle zpool_handle_t;
189typedef struct libzfs_handle libzfs_handle_t;
190
191/*
192 * Library initialization
193 */
194extern libzfs_handle_t *libzfs_init(void);
195extern void libzfs_fini(libzfs_handle_t *);
196
197extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *);
198extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *);
199
200extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t);
201
202extern void zfs_save_arguments(int argc, char **, char *, int);
203extern int zpool_log_history(libzfs_handle_t *, const char *);
204
205extern int libzfs_errno(libzfs_handle_t *);
206extern const char *libzfs_error_init(int);
207extern const char *libzfs_error_action(libzfs_handle_t *);
208extern const char *libzfs_error_description(libzfs_handle_t *);
209extern int zfs_standard_error(libzfs_handle_t *, int, const char *);
210extern void libzfs_mnttab_init(libzfs_handle_t *);
211extern void libzfs_mnttab_fini(libzfs_handle_t *);
212extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t);
213extern int libzfs_mnttab_find(libzfs_handle_t *, const char *,
214 struct mnttab *);
215extern void libzfs_mnttab_add(libzfs_handle_t *, const char *,
216 const char *, const char *);
217extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *);
218
219/*
220 * Basic handle functions
221 */
222extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *);
223extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *);
224extern void zpool_close(zpool_handle_t *);
225extern const char *zpool_get_name(zpool_handle_t *);
226extern int zpool_get_state(zpool_handle_t *);
227extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t);
228extern const char *zpool_pool_state_to_name(pool_state_t);
229extern void zpool_free_handles(libzfs_handle_t *);
230
231/*
232 * Iterate over all active pools in the system.
233 */
234typedef int (*zpool_iter_f)(zpool_handle_t *, void *);
235extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *);
236
237/*
238 * Functions to create and destroy pools
239 */
240extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *,
241 nvlist_t *, nvlist_t *);
242extern int zpool_destroy(zpool_handle_t *, const char *);
243extern int zpool_add(zpool_handle_t *, nvlist_t *);
244
245typedef struct splitflags {
246 /* do not split, but return the config that would be split off */
247 int dryrun : 1;
248
249 /* after splitting, import the pool */
250 int import : 1;
251 int name_flags;
252} splitflags_t;
253
254/*
255 * Functions to manipulate pool and vdev state
256 */
257extern int zpool_scan(zpool_handle_t *, pool_scan_func_t);
258extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *);
259extern int zpool_reguid(zpool_handle_t *);
260extern int zpool_reopen(zpool_handle_t *);
261
262extern int zpool_vdev_online(zpool_handle_t *, const char *, int,
263 vdev_state_t *);
264extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t);
265extern int zpool_vdev_attach(zpool_handle_t *, const char *,
266 const char *, nvlist_t *, int);
267extern int zpool_vdev_detach(zpool_handle_t *, const char *);
268extern int zpool_vdev_remove(zpool_handle_t *, const char *);
269extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *,
270 splitflags_t);
271
272extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t);
273extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t);
274extern int zpool_vdev_clear(zpool_handle_t *, uint64_t);
275
276extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *,
277 boolean_t *, boolean_t *);
278extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *,
279 boolean_t *, boolean_t *, boolean_t *);
280extern int zpool_label_disk_wait(char *, int);
281extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *);
282
283/*
284 * Functions to manage pool properties
285 */
286extern int zpool_set_prop(zpool_handle_t *, const char *, const char *);
287extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *,
288 size_t proplen, zprop_source_t *);
289extern int zpool_get_prop_literal(zpool_handle_t *, zpool_prop_t, char *,
290 size_t proplen, zprop_source_t *, boolean_t literal);
291extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t,
292 zprop_source_t *);
293
294extern const char *zpool_prop_to_name(zpool_prop_t);
295extern const char *zpool_prop_values(zpool_prop_t);
296
297/*
298 * Pool health statistics.
299 */
300typedef enum {
301 /*
302 * The following correspond to faults as defined in the (fault.fs.zfs.*)
303 * event namespace. Each is associated with a corresponding message ID.
304 */
305 ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */
306 ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */
307 ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */
308 ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */
309 ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */
310 ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */
311 ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */
312 ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */
313 ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */
314 ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */
315 ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */
316 ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */
317 ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */
318 ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */
319 ZPOOL_STATUS_ERRATA, /* informational errata available */
320
321 /*
322 * If the pool has unsupported features but can still be opened in
323 * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the
324 * pool has unsupported features but cannot be opened at all, its
325 * status is ZPOOL_STATUS_UNSUP_FEAT_READ.
326 */
327 ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */
328 ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */
329
330 /*
331 * These faults have no corresponding message ID. At the time we are
332 * checking the status, the original reason for the FMA fault (I/O or
333 * checksum errors) has been lost.
334 */
335 ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */
336 ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */
337
338 /*
339 * The following are not faults per se, but still an error possibly
340 * requiring administrative attention. There is no corresponding
341 * message ID.
342 */
343 ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */
344 ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */
345 ZPOOL_STATUS_RESILVERING, /* device being resilvered */
346 ZPOOL_STATUS_OFFLINE_DEV, /* device online */
347 ZPOOL_STATUS_REMOVED_DEV, /* removed device */
348
349 /*
350 * Finally, the following indicates a healthy pool.
351 */
352 ZPOOL_STATUS_OK
353} zpool_status_t;
354
355extern unsigned long get_system_hostid(void);
356extern zpool_status_t zpool_get_status(zpool_handle_t *, char **,
357 zpool_errata_t *);
358extern zpool_status_t zpool_import_status(nvlist_t *, char **,
359 zpool_errata_t *);
360extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh);
361
362/*
363 * Statistics and configuration functions.
364 */
365extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **);
366extern nvlist_t *zpool_get_features(zpool_handle_t *);
367extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *);
368extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **);
369
370/*
371 * Import and export functions
372 */
373extern int zpool_export(zpool_handle_t *, boolean_t, const char *);
374extern int zpool_export_force(zpool_handle_t *, const char *);
375extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *,
376 char *altroot);
377extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *,
378 nvlist_t *, int);
379extern void zpool_print_unsup_feat(nvlist_t *config);
380
381/*
382 * Search for pools to import
383 */
384
385typedef struct importargs {
386 char **path; /* a list of paths to search */
387 int paths; /* number of paths to search */
388 char *poolname; /* name of a pool to find */
389 uint64_t guid; /* guid of a pool to find */
390 char *cachefile; /* cachefile to use for import */
391 int can_be_active : 1; /* can the pool be active? */
392 int unique : 1; /* does 'poolname' already exist? */
393 int exists : 1; /* set on return if pool already exists */
394} importargs_t;
395
396extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *);
397
398/* legacy pool search routines */
399extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **);
400extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *,
401 char *, uint64_t);
402
403/*
404 * Miscellaneous pool functions
405 */
406struct zfs_cmd;
407
408extern const char *zfs_history_event_names[];
409
410typedef enum {
411 VDEV_NAME_PATH = 1 << 0,
412 VDEV_NAME_GUID = 1 << 1,
413 VDEV_NAME_FOLLOW_LINKS = 1 << 2,
414 VDEV_NAME_TYPE_ID = 1 << 3,
415} vdev_name_t;
416
417extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *,
418 int name_flags);
419extern int zpool_upgrade(zpool_handle_t *, uint64_t);
420extern int zpool_get_history(zpool_handle_t *, nvlist_t **);
421extern int zpool_history_unpack(char *, uint64_t, uint64_t *,
422 nvlist_t ***, uint_t *);
423extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned,
424 int);
425extern int zpool_events_clear(libzfs_handle_t *, int *);
426extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int);
427extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *,
428 size_t len);
429extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *);
430extern int zpool_get_physpath(zpool_handle_t *, char *, size_t);
431extern void zpool_explain_recover(libzfs_handle_t *, const char *, int,
432 nvlist_t *);
433
434/*
435 * Basic handle manipulations. These functions do not create or destroy the
436 * underlying datasets, only the references to them.
437 */
438extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int);
439extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *);
440extern void zfs_close(zfs_handle_t *);
441extern zfs_type_t zfs_get_type(const zfs_handle_t *);
442extern const char *zfs_get_name(const zfs_handle_t *);
443extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *);
444
445/*
446 * Property management functions. Some functions are shared with the kernel,
447 * and are found in sys/fs/zfs.h.
448 */
449
450/*
451 * zfs dataset property management
452 */
453extern const char *zfs_prop_default_string(zfs_prop_t);
454extern uint64_t zfs_prop_default_numeric(zfs_prop_t);
455extern const char *zfs_prop_column_name(zfs_prop_t);
456extern boolean_t zfs_prop_align_right(zfs_prop_t);
457
458extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t,
459 nvlist_t *, uint64_t, zfs_handle_t *, const char *);
460
461extern const char *zfs_prop_to_name(zfs_prop_t);
462extern int zfs_prop_set(zfs_handle_t *, const char *, const char *);
463extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t,
464 zprop_source_t *, char *, size_t, boolean_t);
465extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t,
466 boolean_t);
467extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *,
468 zprop_source_t *, char *, size_t);
469extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
470 uint64_t *propvalue);
471extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
472 char *propbuf, int proplen, boolean_t literal);
473extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
474 uint64_t *propvalue);
475extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
476 char *propbuf, int proplen, boolean_t literal);
477extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname,
478 char *buf, size_t len);
479extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **);
480extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t);
481extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t);
482extern const char *zfs_prop_values(zfs_prop_t);
483extern int zfs_prop_is_string(zfs_prop_t prop);
484extern nvlist_t *zfs_get_user_props(zfs_handle_t *);
485extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *);
486extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *);
487
488typedef struct zprop_list {
489 int pl_prop;
490 char *pl_user_prop;
491 struct zprop_list *pl_next;
492 boolean_t pl_all;
493 size_t pl_width;
494 size_t pl_recvd_width;
495 boolean_t pl_fixed;
496} zprop_list_t;
497
498extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t,
499 boolean_t);
500extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *);
501
502#define ZFS_MOUNTPOINT_NONE "none"
503#define ZFS_MOUNTPOINT_LEGACY "legacy"
504
505#define ZFS_FEATURE_DISABLED "disabled"
506#define ZFS_FEATURE_ENABLED "enabled"
507#define ZFS_FEATURE_ACTIVE "active"
508
509#define ZFS_UNSUPPORTED_INACTIVE "inactive"
510#define ZFS_UNSUPPORTED_READONLY "readonly"
511
512/*
513 * zpool property management
514 */
515extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **);
516extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *,
517 size_t);
518extern const char *zpool_prop_default_string(zpool_prop_t);
519extern uint64_t zpool_prop_default_numeric(zpool_prop_t);
520extern const char *zpool_prop_column_name(zpool_prop_t);
521extern boolean_t zpool_prop_align_right(zpool_prop_t);
522
523/*
524 * Functions shared by zfs and zpool property management.
525 */
526extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all,
527 boolean_t ordered, zfs_type_t type);
528extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **,
529 zfs_type_t);
530extern void zprop_free_list(zprop_list_t *);
531
532#define ZFS_GET_NCOLS 5
533
534typedef enum {
535 GET_COL_NONE,
536 GET_COL_NAME,
537 GET_COL_PROPERTY,
538 GET_COL_VALUE,
539 GET_COL_RECVD,
540 GET_COL_SOURCE
541} zfs_get_column_t;
542
543/*
544 * Functions for printing zfs or zpool properties
545 */
546typedef struct zprop_get_cbdata {
547 int cb_sources;
548 zfs_get_column_t cb_columns[ZFS_GET_NCOLS];
549 int cb_colwidths[ZFS_GET_NCOLS + 1];
550 boolean_t cb_scripted;
551 boolean_t cb_literal;
552 boolean_t cb_first;
553 zprop_list_t *cb_proplist;
554 zfs_type_t cb_type;
555} zprop_get_cbdata_t;
556
557void zprop_print_one_property(const char *, zprop_get_cbdata_t *,
558 const char *, const char *, zprop_source_t, const char *,
559 const char *);
560
561/*
562 * Iterator functions.
563 */
564typedef int (*zfs_iter_f)(zfs_handle_t *, void *);
565extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *);
566extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *);
567extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
568extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *);
569extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *);
570extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *);
571extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *);
572extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *);
573
574typedef struct get_all_cb {
575 zfs_handle_t **cb_handles;
576 size_t cb_alloc;
577 size_t cb_used;
578 boolean_t cb_verbose;
579 int (*cb_getone)(zfs_handle_t *, void *);
580} get_all_cb_t;
581
582void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *);
583int libzfs_dataset_cmp(const void *, const void *);
584
585/*
586 * Functions to create and destroy datasets.
587 */
588extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t,
589 nvlist_t *);
590extern int zfs_create_ancestors(libzfs_handle_t *, const char *);
591extern int zfs_destroy(zfs_handle_t *, boolean_t);
592extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t);
593extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t);
594extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *);
595extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *);
596extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps,
597 nvlist_t *props);
598extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t);
599extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t);
600
601typedef struct sendflags {
602 /* print informational messages (ie, -v was specified) */
603 boolean_t verbose;
604
605 /* recursive send (ie, -R) */
606 boolean_t replicate;
607
608 /* for incrementals, do all intermediate snapshots */
609 boolean_t doall;
610
611 /* if dataset is a clone, do incremental from its origin */
612 boolean_t fromorigin;
613
614 /* do deduplication */
615 boolean_t dedup;
616
617 /* send properties (ie, -p) */
618 boolean_t props;
619
620 /* do not send (no-op, ie. -n) */
621 boolean_t dryrun;
622
623 /* parsable verbose output (ie. -P) */
624 boolean_t parsable;
625
626 /* show progress (ie. -v) */
627 boolean_t progress;
628
629 /* large blocks (>128K) are permitted */
630 boolean_t largeblock;
631
632 /* WRITE_EMBEDDED records of type DATA are permitted */
633 boolean_t embed_data;
634} sendflags_t;
635
636typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *);
637
638extern int zfs_send(zfs_handle_t *, const char *, const char *,
639 sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **);
640extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags);
641
642extern int zfs_promote(zfs_handle_t *);
643extern int zfs_hold(zfs_handle_t *, const char *, const char *,
644 boolean_t, int);
645extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *);
646extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t);
647extern int zfs_get_holds(zfs_handle_t *, nvlist_t **);
648extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *);
649
650typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain,
651 uid_t rid, uint64_t space);
652
653extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t,
654 zfs_userspace_cb_t, void *);
655
656extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **);
657extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *);
658
659typedef struct recvflags {
660 /* print informational messages (ie, -v was specified) */
661 boolean_t verbose;
662
663 /* the destination is a prefix, not the exact fs (ie, -d) */
664 boolean_t isprefix;
665
666 /*
667 * Only the tail of the sent snapshot path is appended to the
668 * destination to determine the received snapshot name (ie, -e).
669 */
670 boolean_t istail;
671
672 /* do not actually do the recv, just check if it would work (ie, -n) */
673 boolean_t dryrun;
674
675 /* rollback/destroy filesystems as necessary (eg, -F) */
676 boolean_t force;
677
678 /* set "canmount=off" on all modified filesystems */
679 boolean_t canmountoff;
680
681 /* byteswap flag is used internally; callers need not specify */
682 boolean_t byteswap;
683
684 /* do not mount file systems as they are extracted (private) */
685 boolean_t nomount;
686} recvflags_t;
687
688extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *,
689 int, avl_tree_t *);
690
691typedef enum diff_flags {
692 ZFS_DIFF_PARSEABLE = 0x1,
693 ZFS_DIFF_TIMESTAMP = 0x2,
694 ZFS_DIFF_CLASSIFY = 0x4
695} diff_flags_t;
696
697extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *,
698 int);
699
700/*
701 * Miscellaneous functions.
702 */
703extern const char *zfs_type_to_name(zfs_type_t);
704extern void zfs_refresh_properties(zfs_handle_t *);
705extern int zfs_name_valid(const char *, zfs_type_t);
706extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t);
707extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *,
708 zfs_type_t);
709extern int zfs_spa_version(zfs_handle_t *, int *);
710extern boolean_t zfs_bookmark_exists(const char *path);
711extern int zfs_append_partition(char *path, size_t max_len);
712extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen);
713extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk);
714
715/*
716 * Mount support functions.
717 */
718extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **);
719extern boolean_t zfs_is_mounted(zfs_handle_t *, char **);
720extern int zfs_mount(zfs_handle_t *, const char *, int);
721extern int zfs_unmount(zfs_handle_t *, const char *, int);
722extern int zfs_unmountall(zfs_handle_t *, int);
723
724/*
725 * Share support functions.
726 */
727extern boolean_t zfs_is_shared(zfs_handle_t *);
728extern int zfs_share(zfs_handle_t *);
729extern int zfs_unshare(zfs_handle_t *);
730
731/*
732 * Protocol-specific share support functions.
733 */
734extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **);
735extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **);
736extern int zfs_share_nfs(zfs_handle_t *);
737extern int zfs_share_smb(zfs_handle_t *);
738extern int zfs_shareall(zfs_handle_t *);
739extern int zfs_unshare_nfs(zfs_handle_t *, const char *);
740extern int zfs_unshare_smb(zfs_handle_t *, const char *);
741extern int zfs_unshareall_nfs(zfs_handle_t *);
742extern int zfs_unshareall_smb(zfs_handle_t *);
743extern int zfs_unshareall_bypath(zfs_handle_t *, const char *);
744extern int zfs_unshareall(zfs_handle_t *);
745extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *,
746 void *, void *, int, zfs_share_op_t);
747
748/*
749 * Utility function to convert a number to a human-readable form.
750 */
751extern void zfs_nicenum(uint64_t, char *, size_t);
752extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *);
753
754/*
755 * Utility functions to run an external process.
756 */
757#define STDOUT_VERBOSE 0x01
758#define STDERR_VERBOSE 0x02
759
760int libzfs_run_process(const char *, char **, int flags);
761
762/*
763 * Given a device or file, determine if it is part of a pool.
764 */
765extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **,
766 boolean_t *);
767
768/*
769 * Label manipulation.
770 */
771extern int zpool_read_label(int, nvlist_t **, int *);
772extern int zpool_clear_label(int);
773
774/*
775 * Management interfaces for SMB ACL files
776 */
777
778int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *);
779int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *);
780int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *);
781int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *);
782
783/*
784 * Enable and disable datasets within a pool by mounting/unmounting and
785 * sharing/unsharing them.
786 */
787extern int zpool_enable_datasets(zpool_handle_t *, const char *, int);
788extern int zpool_disable_datasets(zpool_handle_t *, boolean_t);
789
790/*
791 * Mappings between vdev and FRU.
792 */
793extern void libzfs_fru_refresh(libzfs_handle_t *);
794extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *);
795extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *);
796extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *,
797 const char *);
798extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *);
799extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *);
800
801#ifdef __cplusplus
802}
803#endif
804
805#endif /* _LIBZFS_H */
Ubuntu Artful kernel mirror