1228103Smm/* 2228103Smm * CDDL HEADER START 3228103Smm * 4228103Smm * The contents of this file are subject to the terms of the 5228103Smm * Common Development and Distribution License (the "License"). 6228103Smm * You may not use this file except in compliance with the License. 7228103Smm * 8228103Smm * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9228103Smm * or http://www.opensolaris.org/os/licensing. 10228103Smm * See the License for the specific language governing permissions 11228103Smm * and limitations under the License. 12228103Smm * 13228103Smm * When distributing Covered Code, include this CDDL HEADER in each 14228103Smm * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15228103Smm * If applicable, add the following below this CDDL HEADER, with the 16228103Smm * fields enclosed by brackets "[]" replaced with your own identifying 17228103Smm * information: Portions Copyright [yyyy] [name of copyright owner] 18228103Smm * 19228103Smm * CDDL HEADER END 20228103Smm */ 21228103Smm 22228103Smm/* 23228103Smm * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 24290765Smav * Copyright (c) 2013, 2015 by Delphix. All rights reserved. 25307053Smav * Copyright (c) 2012 Pawel Jakub Dawidek. All rights reserved. 26277587Sdelphij * Copyright 2014 Nexenta Systems, Inc. All rights reserved. 27228103Smm */ 28228103Smm 29228103Smm#include <stdio.h> 30228103Smm#include <stdlib.h> 31228103Smm#include <strings.h> 32228103Smm#include <unistd.h> 33228103Smm#include <stddef.h> 34228103Smm#include <libintl.h> 35228103Smm#include <libzfs.h> 36228103Smm 37228103Smm#include "libzfs_impl.h" 38228103Smm 39228103Smmint 40228103Smmzfs_iter_clones(zfs_handle_t *zhp, zfs_iter_f func, void *data) 41228103Smm{ 42228103Smm nvlist_t *nvl = zfs_get_clones_nvl(zhp); 43228103Smm nvpair_t *pair; 44228103Smm 45228103Smm if (nvl == NULL) 46228103Smm return (0); 47228103Smm 48228103Smm for (pair = nvlist_next_nvpair(nvl, NULL); pair != NULL; 49228103Smm pair = nvlist_next_nvpair(nvl, pair)) { 50228103Smm zfs_handle_t *clone = zfs_open(zhp->zfs_hdl, nvpair_name(pair), 51228103Smm ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME); 52228103Smm if (clone != NULL) { 53228103Smm int err = func(clone, data); 54228103Smm if (err != 0) 55228103Smm return (err); 56228103Smm } 57228103Smm } 58228103Smm return (0); 59228103Smm} 60228103Smm 61228103Smmstatic int 62228103Smmzfs_do_list_ioctl(zfs_handle_t *zhp, unsigned long arg, zfs_cmd_t *zc) 63228103Smm{ 64228103Smm int rc; 65228103Smm uint64_t orig_cookie; 66228103Smm 67228103Smm orig_cookie = zc->zc_cookie; 68228103Smmtop: 69228103Smm (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name)); 70228103Smm rc = ioctl(zhp->zfs_hdl->libzfs_fd, arg, zc); 71228103Smm 72228103Smm if (rc == -1) { 73228103Smm switch (errno) { 74228103Smm case ENOMEM: 75228103Smm /* expand nvlist memory and try again */ 76228103Smm if (zcmd_expand_dst_nvlist(zhp->zfs_hdl, zc) != 0) { 77228103Smm zcmd_free_nvlists(zc); 78228103Smm return (-1); 79228103Smm } 80228103Smm zc->zc_cookie = orig_cookie; 81228103Smm goto top; 82228103Smm /* 83228103Smm * An errno value of ESRCH indicates normal completion. 84228103Smm * If ENOENT is returned, then the underlying dataset 85228103Smm * has been removed since we obtained the handle. 86228103Smm */ 87228103Smm case ESRCH: 88228103Smm case ENOENT: 89228103Smm rc = 1; 90228103Smm break; 91228103Smm default: 92228103Smm rc = zfs_standard_error(zhp->zfs_hdl, errno, 93228103Smm dgettext(TEXT_DOMAIN, 94228103Smm "cannot iterate filesystems")); 95228103Smm break; 96228103Smm } 97228103Smm } 98228103Smm return (rc); 99228103Smm} 100228103Smm 101228103Smm/* 102228103Smm * Iterate over all child filesystems 103228103Smm */ 104228103Smmint 105228103Smmzfs_iter_filesystems(zfs_handle_t *zhp, zfs_iter_f func, void *data) 106228103Smm{ 107228103Smm zfs_cmd_t zc = { 0 }; 108228103Smm zfs_handle_t *nzhp; 109228103Smm int ret; 110228103Smm 111228103Smm if (zhp->zfs_type != ZFS_TYPE_FILESYSTEM) 112228103Smm return (0); 113228103Smm 114228103Smm if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0) 115228103Smm return (-1); 116228103Smm 117228103Smm while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_DATASET_LIST_NEXT, 118228103Smm &zc)) == 0) { 119228103Smm /* 120228103Smm * Silently ignore errors, as the only plausible explanation is 121228103Smm * that the pool has since been removed. 122228103Smm */ 123228103Smm if ((nzhp = make_dataset_handle_zc(zhp->zfs_hdl, 124228103Smm &zc)) == NULL) { 125228103Smm continue; 126228103Smm } 127228103Smm 128228103Smm if ((ret = func(nzhp, data)) != 0) { 129228103Smm zcmd_free_nvlists(&zc); 130228103Smm return (ret); 131228103Smm } 132228103Smm } 133228103Smm zcmd_free_nvlists(&zc); 134228103Smm return ((ret < 0) ? ret : 0); 135228103Smm} 136228103Smm 137228103Smm/* 138228103Smm * Iterate over all snapshots 139228103Smm */ 140228103Smmint 141230438Spjdzfs_iter_snapshots(zfs_handle_t *zhp, boolean_t simple, zfs_iter_f func, 142230438Spjd void *data) 143228103Smm{ 144228103Smm zfs_cmd_t zc = { 0 }; 145228103Smm zfs_handle_t *nzhp; 146228103Smm int ret; 147228103Smm 148263407Sdelphij if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT || 149263407Sdelphij zhp->zfs_type == ZFS_TYPE_BOOKMARK) 150228103Smm return (0); 151228103Smm 152230438Spjd zc.zc_simple = simple; 153230438Spjd 154228103Smm if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0) 155228103Smm return (-1); 156228103Smm while ((ret = zfs_do_list_ioctl(zhp, ZFS_IOC_SNAPSHOT_LIST_NEXT, 157228103Smm &zc)) == 0) { 158228103Smm 159230438Spjd if (simple) 160230438Spjd nzhp = make_dataset_simple_handle_zc(zhp, &zc); 161230438Spjd else 162230438Spjd nzhp = make_dataset_handle_zc(zhp->zfs_hdl, &zc); 163230438Spjd if (nzhp == NULL) 164228103Smm continue; 165228103Smm 166228103Smm if ((ret = func(nzhp, data)) != 0) { 167228103Smm zcmd_free_nvlists(&zc); 168228103Smm return (ret); 169228103Smm } 170228103Smm } 171228103Smm zcmd_free_nvlists(&zc); 172228103Smm return ((ret < 0) ? ret : 0); 173228103Smm} 174228103Smm 175228103Smm/* 176263407Sdelphij * Iterate over all bookmarks 177263407Sdelphij */ 178263407Sdelphijint 179263407Sdelphijzfs_iter_bookmarks(zfs_handle_t *zhp, zfs_iter_f func, void *data) 180263407Sdelphij{ 181263407Sdelphij zfs_handle_t *nzhp; 182263407Sdelphij nvlist_t *props = NULL; 183263407Sdelphij nvlist_t *bmarks = NULL; 184263407Sdelphij int err; 185263407Sdelphij 186263407Sdelphij if ((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT | ZFS_TYPE_BOOKMARK)) != 0) 187263407Sdelphij return (0); 188263407Sdelphij 189263407Sdelphij /* Setup the requested properties nvlist. */ 190263407Sdelphij props = fnvlist_alloc(); 191263407Sdelphij fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_GUID)); 192263407Sdelphij fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_CREATETXG)); 193263407Sdelphij fnvlist_add_boolean(props, zfs_prop_to_name(ZFS_PROP_CREATION)); 194263407Sdelphij 195263407Sdelphij if ((err = lzc_get_bookmarks(zhp->zfs_name, props, &bmarks)) != 0) 196263407Sdelphij goto out; 197263407Sdelphij 198263407Sdelphij for (nvpair_t *pair = nvlist_next_nvpair(bmarks, NULL); 199263407Sdelphij pair != NULL; pair = nvlist_next_nvpair(bmarks, pair)) { 200307122Smav char name[ZFS_MAX_DATASET_NAME_LEN]; 201263407Sdelphij char *bmark_name; 202263407Sdelphij nvlist_t *bmark_props; 203263407Sdelphij 204263407Sdelphij bmark_name = nvpair_name(pair); 205263407Sdelphij bmark_props = fnvpair_value_nvlist(pair); 206263407Sdelphij 207263407Sdelphij (void) snprintf(name, sizeof (name), "%s#%s", zhp->zfs_name, 208263407Sdelphij bmark_name); 209263407Sdelphij 210263407Sdelphij nzhp = make_bookmark_handle(zhp, name, bmark_props); 211263407Sdelphij if (nzhp == NULL) 212263407Sdelphij continue; 213263407Sdelphij 214263407Sdelphij if ((err = func(nzhp, data)) != 0) 215263407Sdelphij goto out; 216263407Sdelphij } 217263407Sdelphij 218263407Sdelphijout: 219263407Sdelphij fnvlist_free(props); 220263407Sdelphij fnvlist_free(bmarks); 221263407Sdelphij 222263407Sdelphij return (err); 223263407Sdelphij} 224263407Sdelphij 225263407Sdelphij/* 226228103Smm * Routines for dealing with the sorted snapshot functionality 227228103Smm */ 228228103Smmtypedef struct zfs_node { 229228103Smm zfs_handle_t *zn_handle; 230228103Smm avl_node_t zn_avlnode; 231228103Smm} zfs_node_t; 232228103Smm 233228103Smmstatic int 234228103Smmzfs_sort_snaps(zfs_handle_t *zhp, void *data) 235228103Smm{ 236228103Smm avl_tree_t *avl = data; 237228103Smm zfs_node_t *node; 238228103Smm zfs_node_t search; 239228103Smm 240228103Smm search.zn_handle = zhp; 241228103Smm node = avl_find(avl, &search, NULL); 242228103Smm if (node) { 243228103Smm /* 244228103Smm * If this snapshot was renamed while we were creating the 245228103Smm * AVL tree, it's possible that we already inserted it under 246228103Smm * its old name. Remove the old handle before adding the new 247228103Smm * one. 248228103Smm */ 249228103Smm zfs_close(node->zn_handle); 250228103Smm avl_remove(avl, node); 251228103Smm free(node); 252228103Smm } 253228103Smm 254228103Smm node = zfs_alloc(zhp->zfs_hdl, sizeof (zfs_node_t)); 255228103Smm node->zn_handle = zhp; 256228103Smm avl_add(avl, node); 257228103Smm 258228103Smm return (0); 259228103Smm} 260228103Smm 261228103Smmstatic int 262228103Smmzfs_snapshot_compare(const void *larg, const void *rarg) 263228103Smm{ 264228103Smm zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle; 265228103Smm zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle; 266228103Smm uint64_t lcreate, rcreate; 267228103Smm 268228103Smm /* 269228103Smm * Sort them according to creation time. We use the hidden 270228103Smm * CREATETXG property to get an absolute ordering of snapshots. 271228103Smm */ 272228103Smm lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG); 273228103Smm rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG); 274228103Smm 275228103Smm if (lcreate < rcreate) 276228103Smm return (-1); 277228103Smm else if (lcreate > rcreate) 278228103Smm return (+1); 279228103Smm else 280228103Smm return (0); 281228103Smm} 282228103Smm 283228103Smmint 284228103Smmzfs_iter_snapshots_sorted(zfs_handle_t *zhp, zfs_iter_f callback, void *data) 285228103Smm{ 286228103Smm int ret = 0; 287228103Smm zfs_node_t *node; 288228103Smm avl_tree_t avl; 289228103Smm void *cookie = NULL; 290228103Smm 291228103Smm avl_create(&avl, zfs_snapshot_compare, 292228103Smm sizeof (zfs_node_t), offsetof(zfs_node_t, zn_avlnode)); 293228103Smm 294230438Spjd ret = zfs_iter_snapshots(zhp, B_FALSE, zfs_sort_snaps, &avl); 295228103Smm 296228103Smm for (node = avl_first(&avl); node != NULL; node = AVL_NEXT(&avl, node)) 297228103Smm ret |= callback(node->zn_handle, data); 298228103Smm 299228103Smm while ((node = avl_destroy_nodes(&avl, &cookie)) != NULL) 300228103Smm free(node); 301228103Smm 302228103Smm avl_destroy(&avl); 303228103Smm 304228103Smm return (ret); 305228103Smm} 306228103Smm 307228103Smmtypedef struct { 308228103Smm char *ssa_first; 309228103Smm char *ssa_last; 310228103Smm boolean_t ssa_seenfirst; 311228103Smm boolean_t ssa_seenlast; 312228103Smm zfs_iter_f ssa_func; 313228103Smm void *ssa_arg; 314228103Smm} snapspec_arg_t; 315228103Smm 316228103Smmstatic int 317290765Smavsnapspec_cb(zfs_handle_t *zhp, void *arg) 318290765Smav{ 319228103Smm snapspec_arg_t *ssa = arg; 320228103Smm char *shortsnapname; 321228103Smm int err = 0; 322228103Smm 323228103Smm if (ssa->ssa_seenlast) 324228103Smm return (0); 325228103Smm shortsnapname = zfs_strdup(zhp->zfs_hdl, 326228103Smm strchr(zfs_get_name(zhp), '@') + 1); 327228103Smm 328228103Smm if (!ssa->ssa_seenfirst && strcmp(shortsnapname, ssa->ssa_first) == 0) 329228103Smm ssa->ssa_seenfirst = B_TRUE; 330228103Smm 331228103Smm if (ssa->ssa_seenfirst) { 332228103Smm err = ssa->ssa_func(zhp, ssa->ssa_arg); 333228103Smm } else { 334228103Smm zfs_close(zhp); 335228103Smm } 336228103Smm 337228103Smm if (strcmp(shortsnapname, ssa->ssa_last) == 0) 338228103Smm ssa->ssa_seenlast = B_TRUE; 339228103Smm free(shortsnapname); 340228103Smm 341228103Smm return (err); 342228103Smm} 343228103Smm 344228103Smm/* 345228103Smm * spec is a string like "A,B%C,D" 346228103Smm * 347228103Smm * <snaps>, where <snaps> can be: 348228103Smm * <snap> (single snapshot) 349228103Smm * <snap>%<snap> (range of snapshots, inclusive) 350228103Smm * %<snap> (range of snapshots, starting with earliest) 351228103Smm * <snap>% (range of snapshots, ending with last) 352228103Smm * % (all snapshots) 353228103Smm * <snaps>[,...] (comma separated list of the above) 354228103Smm * 355228103Smm * If a snapshot can not be opened, continue trying to open the others, but 356228103Smm * return ENOENT at the end. 357228103Smm */ 358228103Smmint 359228103Smmzfs_iter_snapspec(zfs_handle_t *fs_zhp, const char *spec_orig, 360228103Smm zfs_iter_f func, void *arg) 361228103Smm{ 362248571Smm char *buf, *comma_separated, *cp; 363228103Smm int err = 0; 364228103Smm int ret = 0; 365228103Smm 366248571Smm buf = zfs_strdup(fs_zhp->zfs_hdl, spec_orig); 367228103Smm cp = buf; 368228103Smm 369228103Smm while ((comma_separated = strsep(&cp, ",")) != NULL) { 370228103Smm char *pct = strchr(comma_separated, '%'); 371228103Smm if (pct != NULL) { 372228103Smm snapspec_arg_t ssa = { 0 }; 373228103Smm ssa.ssa_func = func; 374228103Smm ssa.ssa_arg = arg; 375228103Smm 376228103Smm if (pct == comma_separated) 377228103Smm ssa.ssa_seenfirst = B_TRUE; 378228103Smm else 379228103Smm ssa.ssa_first = comma_separated; 380228103Smm *pct = '\0'; 381228103Smm ssa.ssa_last = pct + 1; 382228103Smm 383228103Smm /* 384228103Smm * If there is a lastname specified, make sure it 385228103Smm * exists. 386228103Smm */ 387228103Smm if (ssa.ssa_last[0] != '\0') { 388307122Smav char snapname[ZFS_MAX_DATASET_NAME_LEN]; 389228103Smm (void) snprintf(snapname, sizeof (snapname), 390228103Smm "%s@%s", zfs_get_name(fs_zhp), 391228103Smm ssa.ssa_last); 392228103Smm if (!zfs_dataset_exists(fs_zhp->zfs_hdl, 393228103Smm snapname, ZFS_TYPE_SNAPSHOT)) { 394228103Smm ret = ENOENT; 395228103Smm continue; 396228103Smm } 397228103Smm } 398228103Smm 399228103Smm err = zfs_iter_snapshots_sorted(fs_zhp, 400228103Smm snapspec_cb, &ssa); 401228103Smm if (ret == 0) 402228103Smm ret = err; 403228103Smm if (ret == 0 && (!ssa.ssa_seenfirst || 404228103Smm (ssa.ssa_last[0] != '\0' && !ssa.ssa_seenlast))) { 405228103Smm ret = ENOENT; 406228103Smm } 407228103Smm } else { 408307122Smav char snapname[ZFS_MAX_DATASET_NAME_LEN]; 409228103Smm zfs_handle_t *snap_zhp; 410228103Smm (void) snprintf(snapname, sizeof (snapname), "%s@%s", 411228103Smm zfs_get_name(fs_zhp), comma_separated); 412228103Smm snap_zhp = make_dataset_handle(fs_zhp->zfs_hdl, 413228103Smm snapname); 414228103Smm if (snap_zhp == NULL) { 415228103Smm ret = ENOENT; 416228103Smm continue; 417228103Smm } 418228103Smm err = func(snap_zhp, arg); 419228103Smm if (ret == 0) 420228103Smm ret = err; 421228103Smm } 422228103Smm } 423228103Smm 424248571Smm free(buf); 425228103Smm return (ret); 426228103Smm} 427228103Smm 428228103Smm/* 429228103Smm * Iterate over all children, snapshots and filesystems 430228103Smm */ 431228103Smmint 432228103Smmzfs_iter_children(zfs_handle_t *zhp, zfs_iter_f func, void *data) 433228103Smm{ 434228103Smm int ret; 435228103Smm 436228103Smm if ((ret = zfs_iter_filesystems(zhp, func, data)) != 0) 437228103Smm return (ret); 438228103Smm 439230438Spjd return (zfs_iter_snapshots(zhp, B_FALSE, func, data)); 440228103Smm} 441228103Smm 442228103Smm 443228103Smmtypedef struct iter_stack_frame { 444228103Smm struct iter_stack_frame *next; 445228103Smm zfs_handle_t *zhp; 446228103Smm} iter_stack_frame_t; 447228103Smm 448228103Smmtypedef struct iter_dependents_arg { 449228103Smm boolean_t first; 450228103Smm boolean_t allowrecursion; 451228103Smm iter_stack_frame_t *stack; 452228103Smm zfs_iter_f func; 453228103Smm void *data; 454228103Smm} iter_dependents_arg_t; 455228103Smm 456228103Smmstatic int 457228103Smmiter_dependents_cb(zfs_handle_t *zhp, void *arg) 458228103Smm{ 459228103Smm iter_dependents_arg_t *ida = arg; 460263407Sdelphij int err = 0; 461228103Smm boolean_t first = ida->first; 462228103Smm ida->first = B_FALSE; 463228103Smm 464228103Smm if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) { 465228103Smm err = zfs_iter_clones(zhp, iter_dependents_cb, ida); 466263407Sdelphij } else if (zhp->zfs_type != ZFS_TYPE_BOOKMARK) { 467228103Smm iter_stack_frame_t isf; 468228103Smm iter_stack_frame_t *f; 469228103Smm 470228103Smm /* 471228103Smm * check if there is a cycle by seeing if this fs is already 472228103Smm * on the stack. 473228103Smm */ 474228103Smm for (f = ida->stack; f != NULL; f = f->next) { 475228103Smm if (f->zhp->zfs_dmustats.dds_guid == 476228103Smm zhp->zfs_dmustats.dds_guid) { 477228103Smm if (ida->allowrecursion) { 478228103Smm zfs_close(zhp); 479228103Smm return (0); 480228103Smm } else { 481228103Smm zfs_error_aux(zhp->zfs_hdl, 482228103Smm dgettext(TEXT_DOMAIN, 483228103Smm "recursive dependency at '%s'"), 484228103Smm zfs_get_name(zhp)); 485228103Smm err = zfs_error(zhp->zfs_hdl, 486228103Smm EZFS_RECURSIVE, 487228103Smm dgettext(TEXT_DOMAIN, 488228103Smm "cannot determine dependent " 489228103Smm "datasets")); 490228103Smm zfs_close(zhp); 491228103Smm return (err); 492228103Smm } 493228103Smm } 494228103Smm } 495228103Smm 496228103Smm isf.zhp = zhp; 497228103Smm isf.next = ida->stack; 498228103Smm ida->stack = &isf; 499228103Smm err = zfs_iter_filesystems(zhp, iter_dependents_cb, ida); 500230438Spjd if (err == 0) { 501230438Spjd err = zfs_iter_snapshots(zhp, B_FALSE, 502230438Spjd iter_dependents_cb, ida); 503230438Spjd } 504228103Smm ida->stack = isf.next; 505228103Smm } 506254755Sdelphij 507228103Smm if (!first && err == 0) 508228103Smm err = ida->func(zhp, ida->data); 509254755Sdelphij else 510254755Sdelphij zfs_close(zhp); 511254755Sdelphij 512228103Smm return (err); 513228103Smm} 514228103Smm 515228103Smmint 516228103Smmzfs_iter_dependents(zfs_handle_t *zhp, boolean_t allowrecursion, 517228103Smm zfs_iter_f func, void *data) 518228103Smm{ 519228103Smm iter_dependents_arg_t ida; 520228103Smm ida.allowrecursion = allowrecursion; 521228103Smm ida.stack = NULL; 522228103Smm ida.func = func; 523228103Smm ida.data = data; 524228103Smm ida.first = B_TRUE; 525228103Smm return (iter_dependents_cb(zfs_handle_dup(zhp), &ida)); 526228103Smm} 527