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