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