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