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