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 2010 Nexenta Systems, Inc. All rights reserved.
25 * Copyright (c) 2011 by Delphix. All rights reserved.
36 #include "libzfs_impl.h"
39 zfs_iter_clones(zfs_handle_t *zhp, zfs_iter_f func, void *data)
41 nvlist_t *nvl = zfs_get_clones_nvl(zhp);
47 for (pair = nvlist_next_nvpair(nvl, NULL); pair != NULL;
48 pair = nvlist_next_nvpair(nvl, pair)) {
49 zfs_handle_t *clone = zfs_open(zhp->zfs_hdl, nvpair_name(pair),
50 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
52 int err = func(clone, data);
61 zfs_do_list_ioctl(zfs_handle_t *zhp, int arg, zfs_cmd_t *zc)
66 orig_cookie = zc->zc_cookie;
68 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
69 rc = ioctl(zhp->zfs_hdl->libzfs_fd, arg, zc);
74 /* expand nvlist memory and try again */
75 if (zcmd_expand_dst_nvlist(zhp->zfs_hdl, zc) != 0) {
76 zcmd_free_nvlists(zc);
79 zc->zc_cookie = orig_cookie;
82 * An errno value of ESRCH indicates normal completion.
83 * If ENOENT is returned, then the underlying dataset
84 * has been removed since we obtained the handle.
91 rc = zfs_standard_error(zhp->zfs_hdl, errno,
93 "cannot iterate filesystems"));
101 * Iterate over all child filesystems
104 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data)
106 zfs_cmd_t zc = { "\0", "\0", "\0", "\0", 0 };
110 if (zhp->zfs_type != ZFS_TYPE_FILESYSTEM)
113 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
116 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_DATASET_LIST_NEXT,
119 * Silently ignore errors, as the only plausible explanation is
120 * that the pool has since been removed.
122 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
127 if ((ret = func(nzhp, data)) != 0) {
128 zcmd_free_nvlists(&zc);
132 zcmd_free_nvlists(&zc);
133 return ((ret < 0) ? ret : 0);
137 * Iterate over all snapshots
140 zfs_iter_snapshots(zfs_handle_t *zhp, boolean_t simple, zfs_iter_f func,
143 zfs_cmd_t zc = { "\0", "\0", "\0", "\0", 0 };
147 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT)
150 zc.zc_simple = simple;
152 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
154 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_SNAPSHOT_LIST_NEXT,
158 nzhp = make_dataset_simple_handle_zc(zhp, &zc);
160 nzhp = make_dataset_handle_zc(zhp->zfs_hdl, &zc);
164 if ((ret = func(nzhp, data)) != 0) {
165 zcmd_free_nvlists(&zc);
169 zcmd_free_nvlists(&zc);
170 return ((ret < 0) ? ret : 0);
174 * Routines for dealing with the sorted snapshot functionality
176 typedef struct zfs_node {
177 zfs_handle_t *zn_handle;
178 avl_node_t zn_avlnode;
182 zfs_sort_snaps(zfs_handle_t *zhp, void *data)
184 avl_tree_t *avl = data;
188 search.zn_handle = zhp;
189 node = avl_find(avl, &search, NULL);
192 * If this snapshot was renamed while we were creating the
193 * AVL tree, it's possible that we already inserted it under
194 * its old name. Remove the old handle before adding the new
197 zfs_close(node->zn_handle);
198 avl_remove(avl, node);
202 node = zfs_alloc(zhp->zfs_hdl, sizeof (zfs_node_t));
203 node->zn_handle = zhp;
210 zfs_snapshot_compare(const void *larg, const void *rarg)
212 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
213 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
214 uint64_t lcreate, rcreate;
217 * Sort them according to creation time. We use the hidden
218 * CREATETXG property to get an absolute ordering of snapshots.
220 lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG);
221 rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG);
223 if (lcreate < rcreate)
225 else if (lcreate > rcreate)
232 zfs_iter_snapshots_sorted(zfs_handle_t *zhp, zfs_iter_f callback, void *data)
239 avl_create(&avl, zfs_snapshot_compare,
240 sizeof (zfs_node_t), offsetof(zfs_node_t, zn_avlnode));
242 ret = zfs_iter_snapshots(zhp, B_FALSE, zfs_sort_snaps, &avl);
244 for (node = avl_first(&avl); node != NULL; node = AVL_NEXT(&avl, node))
245 ret |= callback(node->zn_handle, data);
247 while ((node = avl_destroy_nodes(&avl, &cookie)) != NULL)
258 boolean_t ssa_seenfirst;
259 boolean_t ssa_seenlast;
265 snapspec_cb(zfs_handle_t *zhp, void *arg) {
266 snapspec_arg_t *ssa = arg;
270 if (ssa->ssa_seenlast)
272 shortsnapname = zfs_strdup(zhp->zfs_hdl,
273 strchr(zfs_get_name(zhp), '@') + 1);
275 if (!ssa->ssa_seenfirst && strcmp(shortsnapname, ssa->ssa_first) == 0)
276 ssa->ssa_seenfirst = B_TRUE;
278 if (ssa->ssa_seenfirst) {
279 err = ssa->ssa_func(zhp, ssa->ssa_arg);
284 if (strcmp(shortsnapname, ssa->ssa_last) == 0)
285 ssa->ssa_seenlast = B_TRUE;
292 * spec is a string like "A,B%C,D"
294 * <snaps>, where <snaps> can be:
295 * <snap> (single snapshot)
296 * <snap>%<snap> (range of snapshots, inclusive)
297 * %<snap> (range of snapshots, starting with earliest)
298 * <snap>% (range of snapshots, ending with last)
300 * <snaps>[,...] (comma separated list of the above)
302 * If a snapshot can not be opened, continue trying to open the others, but
303 * return ENOENT at the end.
306 zfs_iter_snapspec(zfs_handle_t *fs_zhp, const char *spec_orig,
307 zfs_iter_f func, void *arg)
309 char buf[ZFS_MAXNAMELEN];
310 char *comma_separated, *cp;
314 (void) strlcpy(buf, spec_orig, sizeof (buf));
317 while ((comma_separated = strsep(&cp, ",")) != NULL) {
318 char *pct = strchr(comma_separated, '%');
320 snapspec_arg_t ssa = { 0 };
324 if (pct == comma_separated)
325 ssa.ssa_seenfirst = B_TRUE;
327 ssa.ssa_first = comma_separated;
329 ssa.ssa_last = pct + 1;
332 * If there is a lastname specified, make sure it
335 if (ssa.ssa_last[0] != '\0') {
336 char snapname[ZFS_MAXNAMELEN];
337 (void) snprintf(snapname, sizeof (snapname),
338 "%s@%s", zfs_get_name(fs_zhp),
340 if (!zfs_dataset_exists(fs_zhp->zfs_hdl,
341 snapname, ZFS_TYPE_SNAPSHOT)) {
347 err = zfs_iter_snapshots_sorted(fs_zhp,
351 if (ret == 0 && (!ssa.ssa_seenfirst ||
352 (ssa.ssa_last[0] != '\0' && !ssa.ssa_seenlast))) {
356 char snapname[ZFS_MAXNAMELEN];
357 zfs_handle_t *snap_zhp;
358 (void) snprintf(snapname, sizeof (snapname), "%s@%s",
359 zfs_get_name(fs_zhp), comma_separated);
360 snap_zhp = make_dataset_handle(fs_zhp->zfs_hdl,
362 if (snap_zhp == NULL) {
366 err = func(snap_zhp, arg);
376 * Iterate over all children, snapshots and filesystems
379 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data)
383 if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0)
386 return (zfs_iter_snapshots(zhp, B_FALSE, func, data));
390 typedef struct iter_stack_frame {
391 struct iter_stack_frame *next;
393 } iter_stack_frame_t;
395 typedef struct iter_dependents_arg {
397 boolean_t allowrecursion;
398 iter_stack_frame_t *stack;
401 } iter_dependents_arg_t;
404 iter_dependents_cb(zfs_handle_t *zhp, void *arg)
406 iter_dependents_arg_t *ida = arg;
408 boolean_t first = ida->first;
409 ida->first = B_FALSE;
411 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
412 err = zfs_iter_clones(zhp, iter_dependents_cb, ida);
414 iter_stack_frame_t isf;
415 iter_stack_frame_t *f;
418 * check if there is a cycle by seeing if this fs is already
421 for (f = ida->stack; f != NULL; f = f->next) {
422 if (f->zhp->zfs_dmustats.dds_guid ==
423 zhp->zfs_dmustats.dds_guid) {
424 if (ida->allowrecursion) {
428 zfs_error_aux(zhp->zfs_hdl,
429 dgettext(TEXT_DOMAIN,
430 "recursive dependency at '%s'"),
432 err = zfs_error(zhp->zfs_hdl,
434 dgettext(TEXT_DOMAIN,
435 "cannot determine dependent "
444 isf.next = ida->stack;
446 err = zfs_iter_filesystems(zhp, iter_dependents_cb, ida);
448 err = zfs_iter_snapshots(zhp, B_FALSE,
449 iter_dependents_cb, ida);
450 ida->stack = isf.next;
452 if (!first && err == 0)
453 err = ida->func(zhp, ida->data);
458 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion,
459 zfs_iter_f func, void *data)
461 iter_dependents_arg_t ida;
462 ida.allowrecursion = allowrecursion;
467 return (iter_dependents_cb(zfs_handle_dup(zhp), &ida));