]>
Commit | Line | Data |
---|---|---|
34dc7c2f BB |
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 | /* | |
428870ff | 23 | * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. |
23de906c | 24 | * Copyright (c) 2011, 2014 by Delphix. All rights reserved. |
37abac6d | 25 | * Copyright (c) 2012, Joyent, Inc. All rights reserved. |
95fd54a1 | 26 | * Copyright (c) 2013 Steven Hartland. All rights reserved. |
54d5378f | 27 | * Copyright 2013 Nexenta Systems, Inc. All rights reserved. |
34dc7c2f BB |
28 | */ |
29 | ||
30 | #ifndef _LIBZFS_H | |
31 | #define _LIBZFS_H | |
32 | ||
34dc7c2f BB |
33 | #include <assert.h> |
34 | #include <libnvpair.h> | |
fb5f0bc8 | 35 | #include <sys/mnttab.h> |
34dc7c2f BB |
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> | |
9b67f605 | 42 | #include <libzfs_core.h> |
34dc7c2f BB |
43 | |
44 | #ifdef __cplusplus | |
45 | extern "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 | ||
d603ed6c BB |
56 | /* |
57 | * Default device paths | |
58 | */ | |
eac47204 BB |
59 | #define DISK_ROOT "/dev" |
60 | #define UDISK_ROOT "/dev/disk" | |
d603ed6c | 61 | |
11cb9d77 BB |
62 | /* |
63 | * Default wait time for a device name to be created. | |
64 | */ | |
65 | #define DISK_LABEL_WAIT (30 * 1000) /* 30 seconds */ | |
66 | ||
dbf763b3 | 67 | #define DEFAULT_IMPORT_PATH_SIZE 7 |
eac47204 | 68 | extern char *zpool_default_import_path[DEFAULT_IMPORT_PATH_SIZE]; |
d603ed6c | 69 | |
34dc7c2f BB |
70 | /* |
71 | * libzfs errors | |
72 | */ | |
6f1ffb06 MA |
73 | typedef enum zfs_error { |
74 | EZFS_SUCCESS = 0, /* no error -- success */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
106 | EZFS_PERM, /* permission denied */ |
107 | EZFS_NOSPC, /* out of space */ | |
428870ff | 108 | EZFS_FAULT, /* bad address */ |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
34dc7c2f BB |
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 */ | |
b128c09f BB |
131 | EZFS_NOTSUP, /* ops not supported on this dataset */ |
132 | EZFS_ACTIVE_SPARE, /* pool has active shared spare devices */ | |
9babb374 | 133 | EZFS_UNPLAYED_LOGS, /* log device has unplayed logs */ |
45d1cae3 BB |
134 | EZFS_REFTAG_RELE, /* snapshot release: tag not found */ |
135 | EZFS_REFTAG_HOLD, /* snapshot hold: tag already exists */ | |
428870ff BB |
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 */ | |
572e2857 BB |
142 | EZFS_DIFF, /* general failure of zfs diff */ |
143 | EZFS_DIFFDATA, /* bad zfs diff data */ | |
144 | EZFS_POOLREADONLY, /* pool is in read-only mode */ | |
34dc7c2f | 145 | EZFS_UNKNOWN |
6f1ffb06 | 146 | } zfs_error_t; |
34dc7c2f BB |
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 | */ | |
161 | typedef struct zfs_perm_node { | |
162 | avl_node_t z_node; | |
163 | char z_pname[MAXPATHLEN]; | |
164 | } zfs_perm_node_t; | |
165 | ||
166 | typedef 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 | ||
174 | typedef 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 | */ | |
187 | typedef struct zfs_handle zfs_handle_t; | |
188 | typedef struct zpool_handle zpool_handle_t; | |
189 | typedef struct libzfs_handle libzfs_handle_t; | |
190 | ||
191 | /* | |
192 | * Library initialization | |
193 | */ | |
194 | extern libzfs_handle_t *libzfs_init(void); | |
195 | extern void libzfs_fini(libzfs_handle_t *); | |
196 | ||
197 | extern libzfs_handle_t *zpool_get_handle(zpool_handle_t *); | |
198 | extern libzfs_handle_t *zfs_get_handle(zfs_handle_t *); | |
199 | ||
200 | extern void libzfs_print_on_error(libzfs_handle_t *, boolean_t); | |
201 | ||
6f1ffb06 MA |
202 | extern void zfs_save_arguments(int argc, char **, char *, int); |
203 | extern int zpool_log_history(libzfs_handle_t *, const char *); | |
204 | ||
34dc7c2f | 205 | extern int libzfs_errno(libzfs_handle_t *); |
65037d9b | 206 | extern const char *libzfs_error_init(int); |
34dc7c2f BB |
207 | extern const char *libzfs_error_action(libzfs_handle_t *); |
208 | extern const char *libzfs_error_description(libzfs_handle_t *); | |
da536844 | 209 | extern int zfs_standard_error(libzfs_handle_t *, int, const char *); |
fb5f0bc8 BB |
210 | extern void libzfs_mnttab_init(libzfs_handle_t *); |
211 | extern void libzfs_mnttab_fini(libzfs_handle_t *); | |
9babb374 | 212 | extern void libzfs_mnttab_cache(libzfs_handle_t *, boolean_t); |
fb5f0bc8 BB |
213 | extern int libzfs_mnttab_find(libzfs_handle_t *, const char *, |
214 | struct mnttab *); | |
215 | extern void libzfs_mnttab_add(libzfs_handle_t *, const char *, | |
216 | const char *, const char *); | |
217 | extern void libzfs_mnttab_remove(libzfs_handle_t *, const char *); | |
34dc7c2f BB |
218 | |
219 | /* | |
220 | * Basic handle functions | |
221 | */ | |
222 | extern zpool_handle_t *zpool_open(libzfs_handle_t *, const char *); | |
223 | extern zpool_handle_t *zpool_open_canfail(libzfs_handle_t *, const char *); | |
224 | extern void zpool_close(zpool_handle_t *); | |
225 | extern const char *zpool_get_name(zpool_handle_t *); | |
226 | extern int zpool_get_state(zpool_handle_t *); | |
227 | extern char *zpool_state_to_name(vdev_state_t, vdev_aux_t); | |
131cc95c | 228 | extern const char *zpool_pool_state_to_name(pool_state_t); |
b128c09f | 229 | extern void zpool_free_handles(libzfs_handle_t *); |
34dc7c2f BB |
230 | |
231 | /* | |
232 | * Iterate over all active pools in the system. | |
233 | */ | |
234 | typedef int (*zpool_iter_f)(zpool_handle_t *, void *); | |
235 | extern int zpool_iter(libzfs_handle_t *, zpool_iter_f, void *); | |
236 | ||
237 | /* | |
238 | * Functions to create and destroy pools | |
239 | */ | |
240 | extern int zpool_create(libzfs_handle_t *, const char *, nvlist_t *, | |
b128c09f | 241 | nvlist_t *, nvlist_t *); |
6f1ffb06 | 242 | extern int zpool_destroy(zpool_handle_t *, const char *); |
34dc7c2f BB |
243 | extern int zpool_add(zpool_handle_t *, nvlist_t *); |
244 | ||
428870ff BB |
245 | typedef 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 | } splitflags_t; | |
252 | ||
34dc7c2f BB |
253 | /* |
254 | * Functions to manipulate pool and vdev state | |
255 | */ | |
428870ff BB |
256 | extern int zpool_scan(zpool_handle_t *, pool_scan_func_t); |
257 | extern int zpool_clear(zpool_handle_t *, const char *, nvlist_t *); | |
3541dc6d | 258 | extern int zpool_reguid(zpool_handle_t *); |
1bd201e7 | 259 | extern int zpool_reopen(zpool_handle_t *); |
34dc7c2f BB |
260 | |
261 | extern int zpool_vdev_online(zpool_handle_t *, const char *, int, | |
262 | vdev_state_t *); | |
263 | extern int zpool_vdev_offline(zpool_handle_t *, const char *, boolean_t); | |
264 | extern int zpool_vdev_attach(zpool_handle_t *, const char *, | |
265 | const char *, nvlist_t *, int); | |
266 | extern int zpool_vdev_detach(zpool_handle_t *, const char *); | |
267 | extern int zpool_vdev_remove(zpool_handle_t *, const char *); | |
428870ff BB |
268 | extern int zpool_vdev_split(zpool_handle_t *, char *, nvlist_t **, nvlist_t *, |
269 | splitflags_t); | |
34dc7c2f | 270 | |
428870ff BB |
271 | extern int zpool_vdev_fault(zpool_handle_t *, uint64_t, vdev_aux_t); |
272 | extern int zpool_vdev_degrade(zpool_handle_t *, uint64_t, vdev_aux_t); | |
34dc7c2f BB |
273 | extern int zpool_vdev_clear(zpool_handle_t *, uint64_t); |
274 | ||
275 | extern nvlist_t *zpool_find_vdev(zpool_handle_t *, const char *, boolean_t *, | |
b128c09f | 276 | boolean_t *, boolean_t *); |
9babb374 BB |
277 | extern nvlist_t *zpool_find_vdev_by_physpath(zpool_handle_t *, const char *, |
278 | boolean_t *, boolean_t *, boolean_t *); | |
d603ed6c | 279 | extern int zpool_label_disk_wait(char *, int); |
34dc7c2f BB |
280 | extern int zpool_label_disk(libzfs_handle_t *, zpool_handle_t *, char *); |
281 | ||
282 | /* | |
283 | * Functions to manage pool properties | |
284 | */ | |
285 | extern int zpool_set_prop(zpool_handle_t *, const char *, const char *); | |
286 | extern int zpool_get_prop(zpool_handle_t *, zpool_prop_t, char *, | |
287 | size_t proplen, zprop_source_t *); | |
8b921f66 RE |
288 | extern int zpool_get_prop_literal(zpool_handle_t *, zpool_prop_t, char *, |
289 | size_t proplen, zprop_source_t *, boolean_t literal); | |
34dc7c2f BB |
290 | extern uint64_t zpool_get_prop_int(zpool_handle_t *, zpool_prop_t, |
291 | zprop_source_t *); | |
292 | ||
293 | extern const char *zpool_prop_to_name(zpool_prop_t); | |
294 | extern const char *zpool_prop_values(zpool_prop_t); | |
295 | ||
296 | /* | |
297 | * Pool health statistics. | |
298 | */ | |
299 | typedef enum { | |
300 | /* | |
301 | * The following correspond to faults as defined in the (fault.fs.zfs.*) | |
302 | * event namespace. Each is associated with a corresponding message ID. | |
303 | */ | |
304 | ZPOOL_STATUS_CORRUPT_CACHE, /* corrupt /kernel/drv/zpool.cache */ | |
305 | ZPOOL_STATUS_MISSING_DEV_R, /* missing device with replicas */ | |
306 | ZPOOL_STATUS_MISSING_DEV_NR, /* missing device with no replicas */ | |
307 | ZPOOL_STATUS_CORRUPT_LABEL_R, /* bad device label with replicas */ | |
308 | ZPOOL_STATUS_CORRUPT_LABEL_NR, /* bad device label with no replicas */ | |
309 | ZPOOL_STATUS_BAD_GUID_SUM, /* sum of device guids didn't match */ | |
310 | ZPOOL_STATUS_CORRUPT_POOL, /* pool metadata is corrupted */ | |
311 | ZPOOL_STATUS_CORRUPT_DATA, /* data errors in user (meta)data */ | |
312 | ZPOOL_STATUS_FAILING_DEV, /* device experiencing errors */ | |
313 | ZPOOL_STATUS_VERSION_NEWER, /* newer on-disk version */ | |
314 | ZPOOL_STATUS_HOSTID_MISMATCH, /* last accessed by another system */ | |
b128c09f BB |
315 | ZPOOL_STATUS_IO_FAILURE_WAIT, /* failed I/O, failmode 'wait' */ |
316 | ZPOOL_STATUS_IO_FAILURE_CONTINUE, /* failed I/O, failmode 'continue' */ | |
d164b209 | 317 | ZPOOL_STATUS_BAD_LOG, /* cannot read log chain(s) */ |
ffe9d382 | 318 | ZPOOL_STATUS_ERRATA, /* informational errata available */ |
d164b209 | 319 | |
9ae529ec CS |
320 | /* |
321 | * If the pool has unsupported features but can still be opened in | |
322 | * read-only mode, its status is ZPOOL_STATUS_UNSUP_FEAT_WRITE. If the | |
323 | * pool has unsupported features but cannot be opened at all, its | |
324 | * status is ZPOOL_STATUS_UNSUP_FEAT_READ. | |
325 | */ | |
326 | ZPOOL_STATUS_UNSUP_FEAT_READ, /* unsupported features for read */ | |
327 | ZPOOL_STATUS_UNSUP_FEAT_WRITE, /* unsupported features for write */ | |
328 | ||
d164b209 BB |
329 | /* |
330 | * These faults have no corresponding message ID. At the time we are | |
331 | * checking the status, the original reason for the FMA fault (I/O or | |
332 | * checksum errors) has been lost. | |
333 | */ | |
34dc7c2f BB |
334 | ZPOOL_STATUS_FAULTED_DEV_R, /* faulted device with replicas */ |
335 | ZPOOL_STATUS_FAULTED_DEV_NR, /* faulted device with no replicas */ | |
336 | ||
337 | /* | |
338 | * The following are not faults per se, but still an error possibly | |
339 | * requiring administrative attention. There is no corresponding | |
340 | * message ID. | |
341 | */ | |
b9b24bb4 CS |
342 | ZPOOL_STATUS_VERSION_OLDER, /* older legacy on-disk version */ |
343 | ZPOOL_STATUS_FEAT_DISABLED, /* supported features are disabled */ | |
34dc7c2f BB |
344 | ZPOOL_STATUS_RESILVERING, /* device being resilvered */ |
345 | ZPOOL_STATUS_OFFLINE_DEV, /* device online */ | |
45d1cae3 | 346 | ZPOOL_STATUS_REMOVED_DEV, /* removed device */ |
34dc7c2f BB |
347 | |
348 | /* | |
349 | * Finally, the following indicates a healthy pool. | |
350 | */ | |
351 | ZPOOL_STATUS_OK | |
352 | } zpool_status_t; | |
353 | ||
53698a45 | 354 | extern unsigned long get_system_hostid(void); |
ffe9d382 BB |
355 | extern zpool_status_t zpool_get_status(zpool_handle_t *, char **, |
356 | zpool_errata_t *); | |
357 | extern zpool_status_t zpool_import_status(nvlist_t *, char **, | |
358 | zpool_errata_t *); | |
428870ff | 359 | extern void zpool_dump_ddt(const ddt_stat_t *dds, const ddt_histogram_t *ddh); |
34dc7c2f BB |
360 | |
361 | /* | |
362 | * Statistics and configuration functions. | |
363 | */ | |
364 | extern nvlist_t *zpool_get_config(zpool_handle_t *, nvlist_t **); | |
9ae529ec | 365 | extern nvlist_t *zpool_get_features(zpool_handle_t *); |
34dc7c2f BB |
366 | extern int zpool_refresh_stats(zpool_handle_t *, boolean_t *); |
367 | extern int zpool_get_errlog(zpool_handle_t *, nvlist_t **); | |
368 | ||
369 | /* | |
370 | * Import and export functions | |
371 | */ | |
6f1ffb06 MA |
372 | extern int zpool_export(zpool_handle_t *, boolean_t, const char *); |
373 | extern int zpool_export_force(zpool_handle_t *, const char *); | |
34dc7c2f BB |
374 | extern int zpool_import(libzfs_handle_t *, nvlist_t *, const char *, |
375 | char *altroot); | |
376 | extern int zpool_import_props(libzfs_handle_t *, nvlist_t *, const char *, | |
572e2857 | 377 | nvlist_t *, int); |
9ae529ec | 378 | extern void zpool_print_unsup_feat(nvlist_t *config); |
34dc7c2f BB |
379 | |
380 | /* | |
381 | * Search for pools to import | |
382 | */ | |
428870ff BB |
383 | |
384 | typedef struct importargs { | |
385 | char **path; /* a list of paths to search */ | |
386 | int paths; /* number of paths to search */ | |
387 | char *poolname; /* name of a pool to find */ | |
388 | uint64_t guid; /* guid of a pool to find */ | |
389 | char *cachefile; /* cachefile to use for import */ | |
390 | int can_be_active : 1; /* can the pool be active? */ | |
391 | int unique : 1; /* does 'poolname' already exist? */ | |
392 | int exists : 1; /* set on return if pool already exists */ | |
393 | } importargs_t; | |
394 | ||
395 | extern nvlist_t *zpool_search_import(libzfs_handle_t *, importargs_t *); | |
396 | ||
397 | /* legacy pool search routines */ | |
b128c09f | 398 | extern nvlist_t *zpool_find_import(libzfs_handle_t *, int, char **); |
34dc7c2f | 399 | extern nvlist_t *zpool_find_import_cached(libzfs_handle_t *, const char *, |
b128c09f | 400 | char *, uint64_t); |
34dc7c2f BB |
401 | |
402 | /* | |
403 | * Miscellaneous pool functions | |
404 | */ | |
405 | struct zfs_cmd; | |
406 | ||
6f1ffb06 | 407 | extern const char *zfs_history_event_names[]; |
428870ff BB |
408 | |
409 | extern char *zpool_vdev_name(libzfs_handle_t *, zpool_handle_t *, nvlist_t *, | |
410 | boolean_t verbose); | |
34dc7c2f BB |
411 | extern int zpool_upgrade(zpool_handle_t *, uint64_t); |
412 | extern int zpool_get_history(zpool_handle_t *, nvlist_t **); | |
428870ff BB |
413 | extern int zpool_history_unpack(char *, uint64_t, uint64_t *, |
414 | nvlist_t ***, uint_t *); | |
8c7aa0cf CD |
415 | extern int zpool_events_next(libzfs_handle_t *, nvlist_t **, int *, unsigned, |
416 | int); | |
26685276 | 417 | extern int zpool_events_clear(libzfs_handle_t *, int *); |
75e3ff58 | 418 | extern int zpool_events_seek(libzfs_handle_t *, uint64_t, int); |
34dc7c2f BB |
419 | extern void zpool_obj_to_path(zpool_handle_t *, uint64_t, uint64_t, char *, |
420 | size_t len); | |
421 | extern int zfs_ioctl(libzfs_handle_t *, int, struct zfs_cmd *); | |
9babb374 | 422 | extern int zpool_get_physpath(zpool_handle_t *, char *, size_t); |
428870ff BB |
423 | extern void zpool_explain_recover(libzfs_handle_t *, const char *, int, |
424 | nvlist_t *); | |
9babb374 | 425 | |
34dc7c2f BB |
426 | /* |
427 | * Basic handle manipulations. These functions do not create or destroy the | |
428 | * underlying datasets, only the references to them. | |
429 | */ | |
430 | extern zfs_handle_t *zfs_open(libzfs_handle_t *, const char *, int); | |
330d06f9 | 431 | extern zfs_handle_t *zfs_handle_dup(zfs_handle_t *); |
34dc7c2f BB |
432 | extern void zfs_close(zfs_handle_t *); |
433 | extern zfs_type_t zfs_get_type(const zfs_handle_t *); | |
434 | extern const char *zfs_get_name(const zfs_handle_t *); | |
b128c09f | 435 | extern zpool_handle_t *zfs_get_pool_handle(const zfs_handle_t *); |
34dc7c2f BB |
436 | |
437 | /* | |
438 | * Property management functions. Some functions are shared with the kernel, | |
439 | * and are found in sys/fs/zfs.h. | |
440 | */ | |
441 | ||
442 | /* | |
443 | * zfs dataset property management | |
444 | */ | |
445 | extern const char *zfs_prop_default_string(zfs_prop_t); | |
446 | extern uint64_t zfs_prop_default_numeric(zfs_prop_t); | |
447 | extern const char *zfs_prop_column_name(zfs_prop_t); | |
448 | extern boolean_t zfs_prop_align_right(zfs_prop_t); | |
449 | ||
b128c09f BB |
450 | extern nvlist_t *zfs_valid_proplist(libzfs_handle_t *, zfs_type_t, |
451 | nvlist_t *, uint64_t, zfs_handle_t *, const char *); | |
452 | ||
34dc7c2f BB |
453 | extern const char *zfs_prop_to_name(zfs_prop_t); |
454 | extern int zfs_prop_set(zfs_handle_t *, const char *, const char *); | |
23de906c | 455 | extern int zfs_prop_set_list(zfs_handle_t *, nvlist_t *); |
34dc7c2f BB |
456 | extern int zfs_prop_get(zfs_handle_t *, zfs_prop_t, char *, size_t, |
457 | zprop_source_t *, char *, size_t, boolean_t); | |
428870ff BB |
458 | extern int zfs_prop_get_recvd(zfs_handle_t *, const char *, char *, size_t, |
459 | boolean_t); | |
34dc7c2f BB |
460 | extern int zfs_prop_get_numeric(zfs_handle_t *, zfs_prop_t, uint64_t *, |
461 | zprop_source_t *, char *, size_t); | |
9babb374 BB |
462 | extern int zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname, |
463 | uint64_t *propvalue); | |
464 | extern int zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname, | |
465 | char *propbuf, int proplen, boolean_t literal); | |
330d06f9 MA |
466 | extern int zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname, |
467 | uint64_t *propvalue); | |
468 | extern int zfs_prop_get_written(zfs_handle_t *zhp, const char *propname, | |
469 | char *propbuf, int proplen, boolean_t literal); | |
9ae529ec CS |
470 | extern int zfs_prop_get_feature(zfs_handle_t *zhp, const char *propname, |
471 | char *buf, size_t len); | |
2cf7f52b | 472 | extern uint64_t getprop_uint64(zfs_handle_t *, zfs_prop_t, char **); |
34dc7c2f | 473 | extern uint64_t zfs_prop_get_int(zfs_handle_t *, zfs_prop_t); |
428870ff | 474 | extern int zfs_prop_inherit(zfs_handle_t *, const char *, boolean_t); |
34dc7c2f BB |
475 | extern const char *zfs_prop_values(zfs_prop_t); |
476 | extern int zfs_prop_is_string(zfs_prop_t prop); | |
477 | extern nvlist_t *zfs_get_user_props(zfs_handle_t *); | |
428870ff | 478 | extern nvlist_t *zfs_get_recvd_props(zfs_handle_t *); |
330d06f9 | 479 | extern nvlist_t *zfs_get_clones_nvl(zfs_handle_t *); |
34dc7c2f BB |
480 | |
481 | typedef struct zprop_list { | |
482 | int pl_prop; | |
483 | char *pl_user_prop; | |
484 | struct zprop_list *pl_next; | |
485 | boolean_t pl_all; | |
486 | size_t pl_width; | |
428870ff | 487 | size_t pl_recvd_width; |
34dc7c2f BB |
488 | boolean_t pl_fixed; |
489 | } zprop_list_t; | |
490 | ||
54d5378f YP |
491 | extern int zfs_expand_proplist(zfs_handle_t *, zprop_list_t **, boolean_t, |
492 | boolean_t); | |
9babb374 | 493 | extern void zfs_prune_proplist(zfs_handle_t *, uint8_t *); |
34dc7c2f BB |
494 | |
495 | #define ZFS_MOUNTPOINT_NONE "none" | |
496 | #define ZFS_MOUNTPOINT_LEGACY "legacy" | |
497 | ||
9ae529ec CS |
498 | #define ZFS_FEATURE_DISABLED "disabled" |
499 | #define ZFS_FEATURE_ENABLED "enabled" | |
500 | #define ZFS_FEATURE_ACTIVE "active" | |
501 | ||
502 | #define ZFS_UNSUPPORTED_INACTIVE "inactive" | |
503 | #define ZFS_UNSUPPORTED_READONLY "readonly" | |
504 | ||
34dc7c2f BB |
505 | /* |
506 | * zpool property management | |
507 | */ | |
508 | extern int zpool_expand_proplist(zpool_handle_t *, zprop_list_t **); | |
9ae529ec CS |
509 | extern int zpool_prop_get_feature(zpool_handle_t *, const char *, char *, |
510 | size_t); | |
34dc7c2f BB |
511 | extern const char *zpool_prop_default_string(zpool_prop_t); |
512 | extern uint64_t zpool_prop_default_numeric(zpool_prop_t); | |
513 | extern const char *zpool_prop_column_name(zpool_prop_t); | |
514 | extern boolean_t zpool_prop_align_right(zpool_prop_t); | |
515 | ||
516 | /* | |
517 | * Functions shared by zfs and zpool property management. | |
518 | */ | |
519 | extern int zprop_iter(zprop_func func, void *cb, boolean_t show_all, | |
520 | boolean_t ordered, zfs_type_t type); | |
521 | extern int zprop_get_list(libzfs_handle_t *, char *, zprop_list_t **, | |
522 | zfs_type_t); | |
523 | extern void zprop_free_list(zprop_list_t *); | |
524 | ||
428870ff BB |
525 | #define ZFS_GET_NCOLS 5 |
526 | ||
527 | typedef enum { | |
528 | GET_COL_NONE, | |
529 | GET_COL_NAME, | |
530 | GET_COL_PROPERTY, | |
531 | GET_COL_VALUE, | |
532 | GET_COL_RECVD, | |
533 | GET_COL_SOURCE | |
534 | } zfs_get_column_t; | |
535 | ||
34dc7c2f BB |
536 | /* |
537 | * Functions for printing zfs or zpool properties | |
538 | */ | |
539 | typedef struct zprop_get_cbdata { | |
540 | int cb_sources; | |
428870ff BB |
541 | zfs_get_column_t cb_columns[ZFS_GET_NCOLS]; |
542 | int cb_colwidths[ZFS_GET_NCOLS + 1]; | |
34dc7c2f BB |
543 | boolean_t cb_scripted; |
544 | boolean_t cb_literal; | |
545 | boolean_t cb_first; | |
546 | zprop_list_t *cb_proplist; | |
547 | zfs_type_t cb_type; | |
548 | } zprop_get_cbdata_t; | |
549 | ||
550 | void zprop_print_one_property(const char *, zprop_get_cbdata_t *, | |
428870ff BB |
551 | const char *, const char *, zprop_source_t, const char *, |
552 | const char *); | |
34dc7c2f BB |
553 | |
554 | /* | |
555 | * Iterator functions. | |
556 | */ | |
557 | typedef int (*zfs_iter_f)(zfs_handle_t *, void *); | |
558 | extern int zfs_iter_root(libzfs_handle_t *, zfs_iter_f, void *); | |
559 | extern int zfs_iter_children(zfs_handle_t *, zfs_iter_f, void *); | |
560 | extern int zfs_iter_dependents(zfs_handle_t *, boolean_t, zfs_iter_f, void *); | |
561 | extern int zfs_iter_filesystems(zfs_handle_t *, zfs_iter_f, void *); | |
0cee2406 | 562 | extern int zfs_iter_snapshots(zfs_handle_t *, boolean_t, zfs_iter_f, void *); |
428870ff | 563 | extern int zfs_iter_snapshots_sorted(zfs_handle_t *, zfs_iter_f, void *); |
330d06f9 | 564 | extern int zfs_iter_snapspec(zfs_handle_t *, const char *, zfs_iter_f, void *); |
da536844 | 565 | extern int zfs_iter_bookmarks(zfs_handle_t *, zfs_iter_f, void *); |
34dc7c2f | 566 | |
572e2857 BB |
567 | typedef struct get_all_cb { |
568 | zfs_handle_t **cb_handles; | |
569 | size_t cb_alloc; | |
570 | size_t cb_used; | |
571 | boolean_t cb_verbose; | |
572 | int (*cb_getone)(zfs_handle_t *, void *); | |
573 | } get_all_cb_t; | |
574 | ||
575 | void libzfs_add_handle(get_all_cb_t *, zfs_handle_t *); | |
576 | int libzfs_dataset_cmp(const void *, const void *); | |
577 | ||
34dc7c2f BB |
578 | /* |
579 | * Functions to create and destroy datasets. | |
580 | */ | |
581 | extern int zfs_create(libzfs_handle_t *, const char *, zfs_type_t, | |
582 | nvlist_t *); | |
583 | extern int zfs_create_ancestors(libzfs_handle_t *, const char *); | |
45d1cae3 BB |
584 | extern int zfs_destroy(zfs_handle_t *, boolean_t); |
585 | extern int zfs_destroy_snaps(zfs_handle_t *, char *, boolean_t); | |
13fe0198 | 586 | extern int zfs_destroy_snaps_nvl(libzfs_handle_t *, nvlist_t *, boolean_t); |
34dc7c2f | 587 | extern int zfs_clone(zfs_handle_t *, const char *, nvlist_t *); |
b128c09f | 588 | extern int zfs_snapshot(libzfs_handle_t *, const char *, boolean_t, nvlist_t *); |
6f1ffb06 MA |
589 | extern int zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, |
590 | nvlist_t *props); | |
34dc7c2f | 591 | extern int zfs_rollback(zfs_handle_t *, zfs_handle_t *, boolean_t); |
db49968e | 592 | extern int zfs_rename(zfs_handle_t *, const char *, boolean_t, boolean_t); |
428870ff BB |
593 | |
594 | typedef struct sendflags { | |
595 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 596 | boolean_t verbose; |
428870ff BB |
597 | |
598 | /* recursive send (ie, -R) */ | |
330d06f9 | 599 | boolean_t replicate; |
428870ff BB |
600 | |
601 | /* for incrementals, do all intermediate snapshots */ | |
330d06f9 | 602 | boolean_t doall; |
428870ff BB |
603 | |
604 | /* if dataset is a clone, do incremental from its origin */ | |
330d06f9 | 605 | boolean_t fromorigin; |
428870ff BB |
606 | |
607 | /* do deduplication */ | |
330d06f9 | 608 | boolean_t dedup; |
428870ff BB |
609 | |
610 | /* send properties (ie, -p) */ | |
330d06f9 MA |
611 | boolean_t props; |
612 | ||
613 | /* do not send (no-op, ie. -n) */ | |
614 | boolean_t dryrun; | |
615 | ||
616 | /* parsable verbose output (ie. -P) */ | |
617 | boolean_t parsable; | |
37abac6d BP |
618 | |
619 | /* show progress (ie. -v) */ | |
620 | boolean_t progress; | |
9b67f605 | 621 | |
f1512ee6 MA |
622 | /* large blocks (>128K) are permitted */ |
623 | boolean_t largeblock; | |
624 | ||
9b67f605 MA |
625 | /* WRITE_EMBEDDED records of type DATA are permitted */ |
626 | boolean_t embed_data; | |
428870ff BB |
627 | } sendflags_t; |
628 | ||
629 | typedef boolean_t (snapfilter_cb_t)(zfs_handle_t *, void *); | |
630 | ||
330d06f9 MA |
631 | extern int zfs_send(zfs_handle_t *, const char *, const char *, |
632 | sendflags_t *, int, snapfilter_cb_t, void *, nvlist_t **); | |
9b67f605 | 633 | extern int zfs_send_one(zfs_handle_t *, const char *, int, enum lzc_send_flags); |
428870ff | 634 | |
34dc7c2f | 635 | extern int zfs_promote(zfs_handle_t *); |
13fe0198 | 636 | extern int zfs_hold(zfs_handle_t *, const char *, const char *, |
95fd54a1 SH |
637 | boolean_t, int); |
638 | extern int zfs_hold_nvl(zfs_handle_t *, int, nvlist_t *); | |
45d1cae3 | 639 | extern int zfs_release(zfs_handle_t *, const char *, const char *, boolean_t); |
0b7936d5 | 640 | extern int zfs_get_holds(zfs_handle_t *, nvlist_t **); |
428870ff | 641 | extern uint64_t zvol_volsize_to_reservation(uint64_t, nvlist_t *); |
34dc7c2f | 642 | |
9babb374 BB |
643 | typedef int (*zfs_userspace_cb_t)(void *arg, const char *domain, |
644 | uid_t rid, uint64_t space); | |
645 | ||
0b7936d5 AS |
646 | extern int zfs_userspace(zfs_handle_t *, zfs_userquota_prop_t, |
647 | zfs_userspace_cb_t, void *); | |
648 | ||
649 | extern int zfs_get_fsacl(zfs_handle_t *, nvlist_t **); | |
650 | extern int zfs_set_fsacl(zfs_handle_t *, boolean_t, nvlist_t *); | |
9babb374 | 651 | |
34dc7c2f BB |
652 | typedef struct recvflags { |
653 | /* print informational messages (ie, -v was specified) */ | |
330d06f9 | 654 | boolean_t verbose; |
34dc7c2f BB |
655 | |
656 | /* the destination is a prefix, not the exact fs (ie, -d) */ | |
330d06f9 | 657 | boolean_t isprefix; |
34dc7c2f | 658 | |
428870ff BB |
659 | /* |
660 | * Only the tail of the sent snapshot path is appended to the | |
661 | * destination to determine the received snapshot name (ie, -e). | |
662 | */ | |
330d06f9 | 663 | boolean_t istail; |
428870ff | 664 | |
34dc7c2f | 665 | /* do not actually do the recv, just check if it would work (ie, -n) */ |
330d06f9 | 666 | boolean_t dryrun; |
34dc7c2f BB |
667 | |
668 | /* rollback/destroy filesystems as necessary (eg, -F) */ | |
330d06f9 | 669 | boolean_t force; |
34dc7c2f BB |
670 | |
671 | /* set "canmount=off" on all modified filesystems */ | |
330d06f9 | 672 | boolean_t canmountoff; |
34dc7c2f BB |
673 | |
674 | /* byteswap flag is used internally; callers need not specify */ | |
330d06f9 | 675 | boolean_t byteswap; |
d164b209 BB |
676 | |
677 | /* do not mount file systems as they are extracted (private) */ | |
330d06f9 | 678 | boolean_t nomount; |
34dc7c2f BB |
679 | } recvflags_t; |
680 | ||
330d06f9 | 681 | extern int zfs_receive(libzfs_handle_t *, const char *, recvflags_t *, |
34dc7c2f BB |
682 | int, avl_tree_t *); |
683 | ||
572e2857 BB |
684 | typedef enum diff_flags { |
685 | ZFS_DIFF_PARSEABLE = 0x1, | |
686 | ZFS_DIFF_TIMESTAMP = 0x2, | |
687 | ZFS_DIFF_CLASSIFY = 0x4 | |
688 | } diff_flags_t; | |
689 | ||
690 | extern int zfs_show_diffs(zfs_handle_t *, int, const char *, const char *, | |
691 | int); | |
692 | ||
34dc7c2f BB |
693 | /* |
694 | * Miscellaneous functions. | |
695 | */ | |
696 | extern const char *zfs_type_to_name(zfs_type_t); | |
697 | extern void zfs_refresh_properties(zfs_handle_t *); | |
698 | extern int zfs_name_valid(const char *, zfs_type_t); | |
699 | extern zfs_handle_t *zfs_path_to_zhandle(libzfs_handle_t *, char *, zfs_type_t); | |
700 | extern boolean_t zfs_dataset_exists(libzfs_handle_t *, const char *, | |
701 | zfs_type_t); | |
702 | extern int zfs_spa_version(zfs_handle_t *, int *); | |
da536844 | 703 | extern boolean_t zfs_bookmark_exists(const char *path); |
eac47204 | 704 | extern int zfs_append_partition(char *path, size_t max_len); |
79e7242a | 705 | extern int zfs_resolve_shortname(const char *name, char *path, size_t pathlen); |
eac47204 | 706 | extern int zfs_strcmp_pathname(char *name, char *cmp_name, int wholedisk); |
34dc7c2f | 707 | |
34dc7c2f BB |
708 | /* |
709 | * Mount support functions. | |
710 | */ | |
711 | extern boolean_t is_mounted(libzfs_handle_t *, const char *special, char **); | |
712 | extern boolean_t zfs_is_mounted(zfs_handle_t *, char **); | |
713 | extern int zfs_mount(zfs_handle_t *, const char *, int); | |
714 | extern int zfs_unmount(zfs_handle_t *, const char *, int); | |
715 | extern int zfs_unmountall(zfs_handle_t *, int); | |
716 | ||
717 | /* | |
718 | * Share support functions. | |
719 | */ | |
720 | extern boolean_t zfs_is_shared(zfs_handle_t *); | |
721 | extern int zfs_share(zfs_handle_t *); | |
722 | extern int zfs_unshare(zfs_handle_t *); | |
723 | ||
724 | /* | |
725 | * Protocol-specific share support functions. | |
726 | */ | |
727 | extern boolean_t zfs_is_shared_nfs(zfs_handle_t *, char **); | |
728 | extern boolean_t zfs_is_shared_smb(zfs_handle_t *, char **); | |
729 | extern int zfs_share_nfs(zfs_handle_t *); | |
730 | extern int zfs_share_smb(zfs_handle_t *); | |
731 | extern int zfs_shareall(zfs_handle_t *); | |
732 | extern int zfs_unshare_nfs(zfs_handle_t *, const char *); | |
733 | extern int zfs_unshare_smb(zfs_handle_t *, const char *); | |
734 | extern int zfs_unshareall_nfs(zfs_handle_t *); | |
735 | extern int zfs_unshareall_smb(zfs_handle_t *); | |
736 | extern int zfs_unshareall_bypath(zfs_handle_t *, const char *); | |
737 | extern int zfs_unshareall(zfs_handle_t *); | |
9babb374 | 738 | extern int zfs_deleg_share_nfs(libzfs_handle_t *, char *, char *, char *, |
34dc7c2f BB |
739 | void *, void *, int, zfs_share_op_t); |
740 | ||
34dc7c2f BB |
741 | /* |
742 | * Utility function to convert a number to a human-readable form. | |
743 | */ | |
744 | extern void zfs_nicenum(uint64_t, char *, size_t); | |
745 | extern int zfs_nicestrtonum(libzfs_handle_t *, const char *, uint64_t *); | |
746 | ||
feb46b92 BB |
747 | /* |
748 | * Utility functions to run an external process. | |
749 | */ | |
9ac97c2a BB |
750 | #define STDOUT_VERBOSE 0x01 |
751 | #define STDERR_VERBOSE 0x02 | |
752 | ||
753 | int libzfs_run_process(const char *, char **, int flags); | |
feb46b92 | 754 | |
34dc7c2f BB |
755 | /* |
756 | * Given a device or file, determine if it is part of a pool. | |
757 | */ | |
758 | extern int zpool_in_use(libzfs_handle_t *, int, pool_state_t *, char **, | |
759 | boolean_t *); | |
760 | ||
761 | /* | |
428870ff | 762 | * Label manipulation. |
34dc7c2f | 763 | */ |
7d90f569 | 764 | extern int zpool_read_label(int, nvlist_t **, int *); |
428870ff | 765 | extern int zpool_clear_label(int); |
34dc7c2f | 766 | |
9babb374 BB |
767 | /* |
768 | * Management interfaces for SMB ACL files | |
769 | */ | |
770 | ||
771 | int zfs_smb_acl_add(libzfs_handle_t *, char *, char *, char *); | |
772 | int zfs_smb_acl_remove(libzfs_handle_t *, char *, char *, char *); | |
773 | int zfs_smb_acl_purge(libzfs_handle_t *, char *, char *); | |
774 | int zfs_smb_acl_rename(libzfs_handle_t *, char *, char *, char *, char *); | |
775 | ||
34dc7c2f BB |
776 | /* |
777 | * Enable and disable datasets within a pool by mounting/unmounting and | |
778 | * sharing/unsharing them. | |
779 | */ | |
780 | extern int zpool_enable_datasets(zpool_handle_t *, const char *, int); | |
781 | extern int zpool_disable_datasets(zpool_handle_t *, boolean_t); | |
782 | ||
428870ff BB |
783 | /* |
784 | * Mappings between vdev and FRU. | |
785 | */ | |
786 | extern void libzfs_fru_refresh(libzfs_handle_t *); | |
787 | extern const char *libzfs_fru_lookup(libzfs_handle_t *, const char *); | |
788 | extern const char *libzfs_fru_devpath(libzfs_handle_t *, const char *); | |
789 | extern boolean_t libzfs_fru_compare(libzfs_handle_t *, const char *, | |
790 | const char *); | |
791 | extern boolean_t libzfs_fru_notself(libzfs_handle_t *, const char *); | |
792 | extern int zpool_fru_set(zpool_handle_t *, uint64_t, const char *); | |
793 | ||
34dc7c2f BB |
794 | #ifdef __cplusplus |
795 | } | |
796 | #endif | |
797 | ||
798 | #endif /* _LIBZFS_H */ |