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, 2015 by Delphix. All rights reserved.
25 * Copyright 2014 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2019 Datto Inc.
37 #include <sys/mntent.h>
39 #include "libzfs_impl.h"
42 zfs_iter_clones(zfs_handle_t *zhp, zfs_iter_f func, void *data)
44 nvlist_t *nvl = zfs_get_clones_nvl(zhp);
50 for (pair = nvlist_next_nvpair(nvl, NULL); pair != NULL;
51 pair = nvlist_next_nvpair(nvl, pair)) {
52 zfs_handle_t *clone = zfs_open(zhp->zfs_hdl, nvpair_name(pair),
53 ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME);
55 int err = func(clone, data);
64 zfs_do_list_ioctl(zfs_handle_t *zhp, int arg, zfs_cmd_t *zc)
69 orig_cookie = zc->zc_cookie;
71 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
72 rc = ioctl(zhp->zfs_hdl->libzfs_fd, arg, zc);
77 /* expand nvlist memory and try again */
78 if (zcmd_expand_dst_nvlist(zhp->zfs_hdl, zc) != 0) {
79 zcmd_free_nvlists(zc);
82 zc->zc_cookie = orig_cookie;
85 * An errno value of ESRCH indicates normal completion.
86 * If ENOENT is returned, then the underlying dataset
87 * has been removed since we obtained the handle.
94 rc = zfs_standard_error(zhp->zfs_hdl, errno,
96 "cannot iterate filesystems"));
104 * Iterate over all child filesystems
107 zfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data)
109 zfs_cmd_t zc = {"\0"};
113 if (zhp->zfs_type != ZFS_TYPE_FILESYSTEM)
116 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
119 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_DATASET_LIST_NEXT,
122 * Silently ignore errors, as the only plausible explanation is
123 * that the pool has since been removed.
125 if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl,
130 if ((ret = func(nzhp, data)) != 0) {
131 zcmd_free_nvlists(&zc);
135 zcmd_free_nvlists(&zc);
136 return ((ret < 0) ? ret : 0);
140 * Iterate over all snapshots
143 zfs_iter_snapshots(zfs_handle_t *zhp, boolean_t simple, zfs_iter_f func,
144 void *data, uint64_t min_txg, uint64_t max_txg)
146 zfs_cmd_t zc = {"\0"};
149 nvlist_t *range_nvl = NULL;
151 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT ||
152 zhp->zfs_type == ZFS_TYPE_BOOKMARK)
155 zc.zc_simple = simple;
157 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
161 range_nvl = fnvlist_alloc();
162 fnvlist_add_uint64(range_nvl, SNAP_ITER_MIN_TXG, min_txg);
165 if (range_nvl == NULL)
166 range_nvl = fnvlist_alloc();
167 fnvlist_add_uint64(range_nvl, SNAP_ITER_MAX_TXG, max_txg);
170 if (range_nvl != NULL &&
171 zcmd_write_src_nvlist(zhp->zfs_hdl, &zc, range_nvl) != 0) {
172 zcmd_free_nvlists(&zc);
173 fnvlist_free(range_nvl);
177 while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_SNAPSHOT_LIST_NEXT,
181 nzhp = make_dataset_simple_handle_zc(zhp, &zc);
183 nzhp = make_dataset_handle_zc(zhp->zfs_hdl, &zc);
187 if ((ret = func(nzhp, data)) != 0) {
188 zcmd_free_nvlists(&zc);
189 fnvlist_free(range_nvl);
193 zcmd_free_nvlists(&zc);
194 fnvlist_free(range_nvl);
195 return ((ret < 0) ? ret : 0);
199 * Iterate over all bookmarks
202 zfs_iter_bookmarks(zfs_handle_t *zhp, zfs_iter_f func, void *data)
205 nvlist_t *props = NULL;
206 nvlist_t *bmarks = NULL;
210 if ((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT | ZFS_TYPE_BOOKMARK)) != 0)
213 /* Setup the requested properties nvlist. */
214 props = fnvlist_alloc();
215 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_GUID));
216 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_CREATETXG));
217 fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_CREATION));
219 if ((err = lzc_get_bookmarks(zhp->zfs_name, props, &bmarks)) != 0)
222 for (pair = nvlist_next_nvpair(bmarks, NULL);
223 pair != NULL; pair = nvlist_next_nvpair(bmarks, pair)) {
224 char name[ZFS_MAX_DATASET_NAME_LEN];
226 nvlist_t *bmark_props;
228 bmark_name = nvpair_name(pair);
229 bmark_props = fnvpair_value_nvlist(pair);
231 if (snprintf(name, sizeof (name), "%s#%s", zhp->zfs_name,
232 bmark_name) >= sizeof (name)) {
237 nzhp = make_bookmark_handle(zhp, name, bmark_props);
241 if ((err = func(nzhp, data)) != 0)
247 fnvlist_free(bmarks);
253 * Routines for dealing with the sorted snapshot functionality
255 typedef struct zfs_node {
256 zfs_handle_t *zn_handle;
257 avl_node_t zn_avlnode;
261 zfs_sort_snaps(zfs_handle_t *zhp, void *data)
263 avl_tree_t *avl = data;
267 search.zn_handle = zhp;
268 node = avl_find(avl, &search, NULL);
271 * If this snapshot was renamed while we were creating the
272 * AVL tree, it's possible that we already inserted it under
273 * its old name. Remove the old handle before adding the new
276 zfs_close(node->zn_handle);
277 avl_remove(avl, node);
281 node = zfs_alloc(zhp->zfs_hdl, sizeof (zfs_node_t));
282 node->zn_handle = zhp;
289 zfs_snapshot_compare(const void *larg, const void *rarg)
291 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
292 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
293 uint64_t lcreate, rcreate;
296 * Sort them according to creation time. We use the hidden
297 * CREATETXG property to get an absolute ordering of snapshots.
299 lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG);
300 rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG);
302 return (AVL_CMP(lcreate, rcreate));
306 zfs_iter_snapshots_sorted(zfs_handle_t *zhp, zfs_iter_f callback, void *data,
307 uint64_t min_txg, uint64_t max_txg)
314 avl_create(&avl, zfs_snapshot_compare,
315 sizeof (zfs_node_t), offsetof(zfs_node_t, zn_avlnode));
317 ret = zfs_iter_snapshots(zhp, B_FALSE, zfs_sort_snaps, &avl, min_txg,
320 for (node = avl_first(&avl); node != NULL; node = AVL_NEXT(&avl, node))
321 ret |= callback(node->zn_handle, data);
323 while ((node = avl_destroy_nodes(&avl, &cookie)) != NULL)
334 boolean_t ssa_seenfirst;
335 boolean_t ssa_seenlast;
341 snapspec_cb(zfs_handle_t *zhp, void *arg)
343 snapspec_arg_t *ssa = arg;
344 const char *shortsnapname;
347 if (ssa->ssa_seenlast)
350 shortsnapname = strchr(zfs_get_name(zhp), '@') + 1;
351 if (!ssa->ssa_seenfirst && strcmp(shortsnapname, ssa->ssa_first) == 0)
352 ssa->ssa_seenfirst = B_TRUE;
353 if (strcmp(shortsnapname, ssa->ssa_last) == 0)
354 ssa->ssa_seenlast = B_TRUE;
356 if (ssa->ssa_seenfirst) {
357 err = ssa->ssa_func(zhp, ssa->ssa_arg);
366 * spec is a string like "A,B%C,D"
368 * <snaps>, where <snaps> can be:
369 * <snap> (single snapshot)
370 * <snap>%<snap> (range of snapshots, inclusive)
371 * %<snap> (range of snapshots, starting with earliest)
372 * <snap>% (range of snapshots, ending with last)
374 * <snaps>[,...] (comma separated list of the above)
376 * If a snapshot can not be opened, continue trying to open the others, but
377 * return ENOENT at the end.
380 zfs_iter_snapspec(zfs_handle_t *fs_zhp, const char *spec_orig,
381 zfs_iter_f func, void *arg)
383 char *buf, *comma_separated, *cp;
387 buf = zfs_strdup(fs_zhp->zfs_hdl, spec_orig);
390 while ((comma_separated = strsep(&cp, ",")) != NULL) {
391 char *pct = strchr(comma_separated, '%');
393 snapspec_arg_t ssa = { 0 };
397 if (pct == comma_separated)
398 ssa.ssa_seenfirst = B_TRUE;
400 ssa.ssa_first = comma_separated;
402 ssa.ssa_last = pct + 1;
405 * If there is a lastname specified, make sure it
408 if (ssa.ssa_last[0] != '\0') {
409 char snapname[ZFS_MAX_DATASET_NAME_LEN];
410 (void) snprintf(snapname, sizeof (snapname),
411 "%s@%s", zfs_get_name(fs_zhp),
413 if (!zfs_dataset_exists(fs_zhp->zfs_hdl,
414 snapname, ZFS_TYPE_SNAPSHOT)) {
420 err = zfs_iter_snapshots_sorted(fs_zhp,
421 snapspec_cb, &ssa, 0, 0);
424 if (ret == 0 && (!ssa.ssa_seenfirst ||
425 (ssa.ssa_last[0] != '\0' && !ssa.ssa_seenlast))) {
429 char snapname[ZFS_MAX_DATASET_NAME_LEN];
430 zfs_handle_t *snap_zhp;
431 (void) snprintf(snapname, sizeof (snapname), "%s@%s",
432 zfs_get_name(fs_zhp), comma_separated);
433 snap_zhp = make_dataset_handle(fs_zhp->zfs_hdl,
435 if (snap_zhp == NULL) {
439 err = func(snap_zhp, arg);
450 * Iterate over all children, snapshots and filesystems
451 * Process snapshots before filesystems because they are nearer the input
452 * handle: this is extremely important when used with zfs_iter_f functions
453 * looking for data, following the logic that we would like to find it as soon
454 * and as close as possible.
457 zfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data)
461 if ((ret = zfs_iter_snapshots(zhp, B_FALSE, func, data, 0, 0)) != 0)
464 return (zfs_iter_filesystems(zhp, func, data));
468 typedef struct iter_stack_frame {
469 struct iter_stack_frame *next;
471 } iter_stack_frame_t;
473 typedef struct iter_dependents_arg {
475 boolean_t allowrecursion;
476 iter_stack_frame_t *stack;
479 } iter_dependents_arg_t;
482 iter_dependents_cb(zfs_handle_t *zhp, void *arg)
484 iter_dependents_arg_t *ida = arg;
486 boolean_t first = ida->first;
487 ida->first = B_FALSE;
489 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
490 err = zfs_iter_clones(zhp, iter_dependents_cb, ida);
491 } else if (zhp->zfs_type != ZFS_TYPE_BOOKMARK) {
492 iter_stack_frame_t isf;
493 iter_stack_frame_t *f;
496 * check if there is a cycle by seeing if this fs is already
499 for (f = ida->stack; f != NULL; f = f->next) {
500 if (f->zhp->zfs_dmustats.dds_guid ==
501 zhp->zfs_dmustats.dds_guid) {
502 if (ida->allowrecursion) {
506 zfs_error_aux(zhp->zfs_hdl,
507 dgettext(TEXT_DOMAIN,
508 "recursive dependency at '%s'"),
510 err = zfs_error(zhp->zfs_hdl,
512 dgettext(TEXT_DOMAIN,
513 "cannot determine dependent "
522 isf.next = ida->stack;
524 err = zfs_iter_filesystems(zhp, iter_dependents_cb, ida);
526 err = zfs_iter_snapshots(zhp, B_FALSE,
527 iter_dependents_cb, ida, 0, 0);
528 ida->stack = isf.next;
531 if (!first && err == 0)
532 err = ida->func(zhp, ida->data);
540 zfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion,
541 zfs_iter_f func, void *data)
543 iter_dependents_arg_t ida;
544 ida.allowrecursion = allowrecursion;
549 return (iter_dependents_cb(zfs_handle_dup(zhp), &ida));
553 * Iterate over mounted children of the specified dataset
556 zfs_iter_mounted(zfs_handle_t *zhp, zfs_iter_f func, void *data)
558 char mnt_prop[ZFS_MAXPROPLEN];
560 zfs_handle_t *mtab_zhp;
561 size_t namelen = strlen(zhp->zfs_name);
565 if ((mnttab = fopen(MNTTAB, "r")) == NULL)
568 while (err == 0 && getmntent(mnttab, &entry) == 0) {
569 /* Ignore non-ZFS entries */
570 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
573 /* Ignore datasets not within the provided dataset */
574 if (strncmp(entry.mnt_special, zhp->zfs_name, namelen) != 0 ||
575 (entry.mnt_special[namelen] != '/' &&
576 entry.mnt_special[namelen] != '@'))
579 if ((mtab_zhp = zfs_open(zhp->zfs_hdl, entry.mnt_special,
580 ZFS_TYPE_FILESYSTEM)) == NULL)
583 /* Ignore legacy mounts as they are user managed */
584 verify(zfs_prop_get(mtab_zhp, ZFS_PROP_MOUNTPOINT, mnt_prop,
585 sizeof (mnt_prop), NULL, NULL, 0, B_FALSE) == 0);
586 if (strcmp(mnt_prop, "legacy") == 0) {
591 err = func(mtab_zhp, data);