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