4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or http://www.opensolaris.org/os/licensing.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2013 by Delphix. All rights reserved.
25 * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
26 * All rights reserved.
27 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
38 #include "libzfs_impl.h"
41 zfs_iter_clones(zfs_handle_t *zhp, zfs_iter_f func, void *data)
43 nvlist_t *nvl = zfs_get_clones_nvl(zhp);
49 for (pair = nvlist_next_nvpair(nvl, NULL); pair != NULL;
50 pair = nvlist_next_nvpair(nvl, pair)) {
51 zfs_handle_t *clone = zfs_open(zhp->zfs_hdl, nvpair_name(pair),
52 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
54 int err = func(clone, data);
63 zfs_do_list_ioctl(zfs_handle_t *zhp, unsigned long arg, zfs_cmd_t *zc)
68 orig_cookie = zc->zc_cookie;
70 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
71 rc = ioctl(zhp->zfs_hdl->libzfs_fd, arg, zc);
76 /* expand nvlist memory and try again */
77 if (zcmd_expand_dst_nvlist(zhp->zfs_hdl, zc) != 0) {
78 zcmd_free_nvlists(zc);
81 zc->zc_cookie = orig_cookie;
84 * An errno value of ESRCH indicates normal completion.
85 * If ENOENT is returned, then the underlying dataset
86 * has been removed since we obtained the handle.
93 rc = zfs_standard_error(zhp->zfs_hdl, errno,
95 "cannot iterate filesystems"));
103 * Iterate over all child filesystems
106 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data)
108 zfs_cmd_t zc = { 0 };
112 if (zhp->zfs_type != ZFS_TYPE_FILESYSTEM)
115 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
118 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_DATASET_LIST_NEXT,
121 * Silently ignore errors, as the only plausible explanation is
122 * that the pool has since been removed.
124 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
129 if ((ret = func(nzhp, data)) != 0) {
130 zcmd_free_nvlists(&zc);
134 zcmd_free_nvlists(&zc);
135 return ((ret < 0) ? ret : 0);
139 * Iterate over all snapshots
142 zfs_iter_snapshots(zfs_handle_t *zhp, boolean_t simple, zfs_iter_f func,
145 zfs_cmd_t zc = { 0 };
149 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT ||
150 zhp->zfs_type == ZFS_TYPE_BOOKMARK)
153 zc.zc_simple = simple;
155 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
157 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_SNAPSHOT_LIST_NEXT,
161 nzhp = make_dataset_simple_handle_zc(zhp, &zc);
163 nzhp = make_dataset_handle_zc(zhp->zfs_hdl, &zc);
167 if ((ret = func(nzhp, data)) != 0) {
168 zcmd_free_nvlists(&zc);
172 zcmd_free_nvlists(&zc);
173 return ((ret < 0) ? ret : 0);
177 * Iterate over all bookmarks
180 zfs_iter_bookmarks(zfs_handle_t *zhp, zfs_iter_f func, void *data)
183 nvlist_t *props = NULL;
184 nvlist_t *bmarks = NULL;
187 if ((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT | ZFS_TYPE_BOOKMARK)) != 0)
190 /* Setup the requested properties nvlist. */
191 props = fnvlist_alloc();
192 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_GUID));
193 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_CREATETXG));
194 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_CREATION));
196 /* Allocate an nvlist to hold the bookmarks. */
197 bmarks = fnvlist_alloc();
199 if ((err = lzc_get_bookmarks(zhp->zfs_name, props, &bmarks)) != 0)
202 for (nvpair_t *pair = nvlist_next_nvpair(bmarks, NULL);
203 pair != NULL; pair = nvlist_next_nvpair(bmarks, pair)) {
204 char name[ZFS_MAXNAMELEN];
206 nvlist_t *bmark_props;
208 bmark_name = nvpair_name(pair);
209 bmark_props = fnvpair_value_nvlist(pair);
211 (void) snprintf(name, sizeof (name), "%s#%s", zhp->zfs_name,
214 nzhp = make_bookmark_handle(zhp, name, bmark_props);
218 if ((err = func(nzhp, data)) != 0)
224 fnvlist_free(bmarks);
230 * Routines for dealing with the sorted snapshot functionality
232 typedef struct zfs_node {
233 zfs_handle_t *zn_handle;
234 avl_node_t zn_avlnode;
238 zfs_sort_snaps(zfs_handle_t *zhp, void *data)
240 avl_tree_t *avl = data;
244 search.zn_handle = zhp;
245 node = avl_find(avl, &search, NULL);
248 * If this snapshot was renamed while we were creating the
249 * AVL tree, it's possible that we already inserted it under
250 * its old name. Remove the old handle before adding the new
253 zfs_close(node->zn_handle);
254 avl_remove(avl, node);
258 node = zfs_alloc(zhp->zfs_hdl, sizeof (zfs_node_t));
259 node->zn_handle = zhp;
266 zfs_snapshot_compare(const void *larg, const void *rarg)
268 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
269 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
270 uint64_t lcreate, rcreate;
273 * Sort them according to creation time. We use the hidden
274 * CREATETXG property to get an absolute ordering of snapshots.
276 lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG);
277 rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG);
279 if (lcreate < rcreate)
281 else if (lcreate > rcreate)
288 zfs_iter_snapshots_sorted(zfs_handle_t *zhp, zfs_iter_f callback, void *data)
295 avl_create(&avl, zfs_snapshot_compare,
296 sizeof (zfs_node_t), offsetof(zfs_node_t, zn_avlnode));
298 ret = zfs_iter_snapshots(zhp, B_FALSE, zfs_sort_snaps, &avl);
300 for (node = avl_first(&avl); node != NULL; node = AVL_NEXT(&avl, node))
301 ret |= callback(node->zn_handle, data);
303 while ((node = avl_destroy_nodes(&avl, &cookie)) != NULL)
314 boolean_t ssa_seenfirst;
315 boolean_t ssa_seenlast;
321 snapspec_cb(zfs_handle_t *zhp, void *arg) {
322 snapspec_arg_t *ssa = arg;
326 if (ssa->ssa_seenlast)
328 shortsnapname = zfs_strdup(zhp->zfs_hdl,
329 strchr(zfs_get_name(zhp), '@') + 1);
331 if (!ssa->ssa_seenfirst && strcmp(shortsnapname, ssa->ssa_first) == 0)
332 ssa->ssa_seenfirst = B_TRUE;
334 if (ssa->ssa_seenfirst) {
335 err = ssa->ssa_func(zhp, ssa->ssa_arg);
340 if (strcmp(shortsnapname, ssa->ssa_last) == 0)
341 ssa->ssa_seenlast = B_TRUE;
348 * spec is a string like "A,B%C,D"
350 * <snaps>, where <snaps> can be:
351 * <snap> (single snapshot)
352 * <snap>%<snap> (range of snapshots, inclusive)
353 * %<snap> (range of snapshots, starting with earliest)
354 * <snap>% (range of snapshots, ending with last)
356 * <snaps>[,...] (comma separated list of the above)
358 * If a snapshot can not be opened, continue trying to open the others, but
359 * return ENOENT at the end.
362 zfs_iter_snapspec(zfs_handle_t *fs_zhp, const char *spec_orig,
363 zfs_iter_f func, void *arg)
365 char *buf, *comma_separated, *cp;
369 buf = zfs_strdup(fs_zhp->zfs_hdl, spec_orig);
372 while ((comma_separated = strsep(&cp, ",")) != NULL) {
373 char *pct = strchr(comma_separated, '%');
375 snapspec_arg_t ssa = { 0 };
379 if (pct == comma_separated)
380 ssa.ssa_seenfirst = B_TRUE;
382 ssa.ssa_first = comma_separated;
384 ssa.ssa_last = pct + 1;
387 * If there is a lastname specified, make sure it
390 if (ssa.ssa_last[0] != '\0') {
391 char snapname[ZFS_MAXNAMELEN];
392 (void) snprintf(snapname, sizeof (snapname),
393 "%s@%s", zfs_get_name(fs_zhp),
395 if (!zfs_dataset_exists(fs_zhp->zfs_hdl,
396 snapname, ZFS_TYPE_SNAPSHOT)) {
402 err = zfs_iter_snapshots_sorted(fs_zhp,
406 if (ret == 0 && (!ssa.ssa_seenfirst ||
407 (ssa.ssa_last[0] != '\0' && !ssa.ssa_seenlast))) {
411 char snapname[ZFS_MAXNAMELEN];
412 zfs_handle_t *snap_zhp;
413 (void) snprintf(snapname, sizeof (snapname), "%s@%s",
414 zfs_get_name(fs_zhp), comma_separated);
415 snap_zhp = make_dataset_handle(fs_zhp->zfs_hdl,
417 if (snap_zhp == NULL) {
421 err = func(snap_zhp, arg);
432 * Iterate over all children, snapshots and filesystems
435 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data)
439 if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0)
442 return (zfs_iter_snapshots(zhp, B_FALSE, func, data));
446 typedef struct iter_stack_frame {
447 struct iter_stack_frame *next;
449 } iter_stack_frame_t;
451 typedef struct iter_dependents_arg {
453 boolean_t allowrecursion;
454 iter_stack_frame_t *stack;
457 } iter_dependents_arg_t;
460 iter_dependents_cb(zfs_handle_t *zhp, void *arg)
462 iter_dependents_arg_t *ida = arg;
464 boolean_t first = ida->first;
465 ida->first = B_FALSE;
467 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
468 err = zfs_iter_clones(zhp, iter_dependents_cb, ida);
469 } else if (zhp->zfs_type != ZFS_TYPE_BOOKMARK) {
470 iter_stack_frame_t isf;
471 iter_stack_frame_t *f;
474 * check if there is a cycle by seeing if this fs is already
477 for (f = ida->stack; f != NULL; f = f->next) {
478 if (f->zhp->zfs_dmustats.dds_guid ==
479 zhp->zfs_dmustats.dds_guid) {
480 if (ida->allowrecursion) {
484 zfs_error_aux(zhp->zfs_hdl,
485 dgettext(TEXT_DOMAIN,
486 "recursive dependency at '%s'"),
488 err = zfs_error(zhp->zfs_hdl,
490 dgettext(TEXT_DOMAIN,
491 "cannot determine dependent "
500 isf.next = ida->stack;
502 err = zfs_iter_filesystems(zhp, iter_dependents_cb, ida);
504 err = zfs_iter_snapshots(zhp, B_FALSE,
505 iter_dependents_cb, ida);
507 ida->stack = isf.next;
510 if (!first && err == 0)
511 err = ida->func(zhp, ida->data);
519 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion,
520 zfs_iter_f func, void *data)
522 iter_dependents_arg_t ida;
523 ida.allowrecursion = allowrecursion;
528 return (iter_dependents_cb(zfs_handle_dup(zhp), &ida));