zfs_iter.c revision 185029
1168404Spjd/* 2168404Spjd * CDDL HEADER START 3168404Spjd * 4168404Spjd * The contents of this file are subject to the terms of the 5168404Spjd * Common Development and Distribution License (the "License"). 6168404Spjd * You may not use this file except in compliance with the License. 7168404Spjd * 8168404Spjd * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9168404Spjd * or http://www.opensolaris.org/os/licensing. 10168404Spjd * See the License for the specific language governing permissions 11168404Spjd * and limitations under the License. 12168404Spjd * 13168404Spjd * When distributing Covered Code, include this CDDL HEADER in each 14168404Spjd * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15168404Spjd * If applicable, add the following below this CDDL HEADER, with the 16168404Spjd * fields enclosed by brackets "[]" replaced with your own identifying 17168404Spjd * information: Portions Copyright [yyyy] [name of copyright owner] 18168404Spjd * 19168404Spjd * CDDL HEADER END 20168404Spjd */ 21168404Spjd/* 22185029Spjd * Copyright 2008 Sun Microsystems, Inc. All rights reserved. 23168404Spjd * Use is subject to license terms. 24168404Spjd */ 25168404Spjd 26168404Spjd#include <libintl.h> 27168404Spjd#include <libuutil.h> 28168404Spjd#include <stddef.h> 29168404Spjd#include <stdio.h> 30168404Spjd#include <stdlib.h> 31168404Spjd#include <strings.h> 32168404Spjd 33168404Spjd#include <libzfs.h> 34168404Spjd 35168404Spjd#include "zfs_util.h" 36168404Spjd#include "zfs_iter.h" 37168404Spjd 38168404Spjd/* 39168404Spjd * This is a private interface used to gather up all the datasets specified on 40168404Spjd * the command line so that we can iterate over them in order. 41168404Spjd * 42168404Spjd * First, we iterate over all filesystems, gathering them together into an 43168404Spjd * AVL tree. We report errors for any explicitly specified datasets 44168404Spjd * that we couldn't open. 45168404Spjd * 46168404Spjd * When finished, we have an AVL tree of ZFS handles. We go through and execute 47168404Spjd * the provided callback for each one, passing whatever data the user supplied. 48168404Spjd */ 49168404Spjd 50168404Spjdtypedef struct zfs_node { 51168404Spjd zfs_handle_t *zn_handle; 52168404Spjd uu_avl_node_t zn_avlnode; 53168404Spjd} zfs_node_t; 54168404Spjd 55168404Spjdtypedef struct callback_data { 56168404Spjd uu_avl_t *cb_avl; 57185029Spjd int cb_flags; 58168404Spjd zfs_type_t cb_types; 59168404Spjd zfs_sort_column_t *cb_sortcol; 60185029Spjd zprop_list_t **cb_proplist; 61168404Spjd} callback_data_t; 62168404Spjd 63168404Spjduu_avl_pool_t *avl_pool; 64168404Spjd 65168404Spjd/* 66185029Spjd * Include snaps if they were requested or if this a zfs list where types 67185029Spjd * were not specified and the "listsnapshots" property is set on this pool. 68185029Spjd */ 69185029Spjdstatic int 70185029Spjdzfs_include_snapshots(zfs_handle_t *zhp, callback_data_t *cb) 71185029Spjd{ 72185029Spjd zpool_handle_t *zph; 73185029Spjd 74185029Spjd if ((cb->cb_flags & ZFS_ITER_PROP_LISTSNAPS) == 0) 75185029Spjd return (cb->cb_types & ZFS_TYPE_SNAPSHOT); 76185029Spjd 77185029Spjd zph = zfs_get_pool_handle(zhp); 78185029Spjd return (zpool_get_prop_int(zph, ZPOOL_PROP_LISTSNAPS, NULL)); 79185029Spjd} 80185029Spjd 81185029Spjd/* 82185029Spjd * Called for each dataset. If the object is of an appropriate type, 83168404Spjd * add it to the avl tree and recurse over any children as necessary. 84168404Spjd */ 85185029Spjdstatic int 86168404Spjdzfs_callback(zfs_handle_t *zhp, void *data) 87168404Spjd{ 88168404Spjd callback_data_t *cb = data; 89168404Spjd int dontclose = 0; 90185029Spjd int include_snaps = zfs_include_snapshots(zhp, cb); 91168404Spjd 92185029Spjd if ((zfs_get_type(zhp) & cb->cb_types) || 93185029Spjd ((zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT) && include_snaps)) { 94168404Spjd uu_avl_index_t idx; 95168404Spjd zfs_node_t *node = safe_malloc(sizeof (zfs_node_t)); 96168404Spjd 97168404Spjd node->zn_handle = zhp; 98168404Spjd uu_avl_node_init(node, &node->zn_avlnode, avl_pool); 99168404Spjd if (uu_avl_find(cb->cb_avl, node, cb->cb_sortcol, 100168404Spjd &idx) == NULL) { 101168404Spjd if (cb->cb_proplist && 102168404Spjd zfs_expand_proplist(zhp, cb->cb_proplist) != 0) { 103168404Spjd free(node); 104168404Spjd return (-1); 105168404Spjd } 106168404Spjd uu_avl_insert(cb->cb_avl, node, idx); 107168404Spjd dontclose = 1; 108168404Spjd } else { 109168404Spjd free(node); 110168404Spjd } 111168404Spjd } 112168404Spjd 113168404Spjd /* 114168404Spjd * Recurse if necessary. 115168404Spjd */ 116185029Spjd if (cb->cb_flags & ZFS_ITER_RECURSE) { 117185029Spjd if (zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) 118185029Spjd (void) zfs_iter_filesystems(zhp, zfs_callback, data); 119185029Spjd if ((zfs_get_type(zhp) != ZFS_TYPE_SNAPSHOT) && include_snaps) 120185029Spjd (void) zfs_iter_snapshots(zhp, zfs_callback, data); 121185029Spjd } 122168404Spjd 123168404Spjd if (!dontclose) 124168404Spjd zfs_close(zhp); 125168404Spjd 126168404Spjd return (0); 127168404Spjd} 128168404Spjd 129168404Spjdint 130168404Spjdzfs_add_sort_column(zfs_sort_column_t **sc, const char *name, 131168404Spjd boolean_t reverse) 132168404Spjd{ 133168404Spjd zfs_sort_column_t *col; 134168404Spjd zfs_prop_t prop; 135168404Spjd 136185029Spjd if ((prop = zfs_name_to_prop(name)) == ZPROP_INVAL && 137168404Spjd !zfs_prop_user(name)) 138168404Spjd return (-1); 139168404Spjd 140168404Spjd col = safe_malloc(sizeof (zfs_sort_column_t)); 141168404Spjd 142168404Spjd col->sc_prop = prop; 143168404Spjd col->sc_reverse = reverse; 144185029Spjd if (prop == ZPROP_INVAL) { 145168404Spjd col->sc_user_prop = safe_malloc(strlen(name) + 1); 146168404Spjd (void) strcpy(col->sc_user_prop, name); 147168404Spjd } 148168404Spjd 149168404Spjd if (*sc == NULL) { 150168404Spjd col->sc_last = col; 151168404Spjd *sc = col; 152168404Spjd } else { 153168404Spjd (*sc)->sc_last->sc_next = col; 154168404Spjd (*sc)->sc_last = col; 155168404Spjd } 156168404Spjd 157168404Spjd return (0); 158168404Spjd} 159168404Spjd 160168404Spjdvoid 161168404Spjdzfs_free_sort_columns(zfs_sort_column_t *sc) 162168404Spjd{ 163168404Spjd zfs_sort_column_t *col; 164168404Spjd 165168404Spjd while (sc != NULL) { 166168404Spjd col = sc->sc_next; 167168404Spjd free(sc->sc_user_prop); 168168404Spjd free(sc); 169168404Spjd sc = col; 170168404Spjd } 171168404Spjd} 172168404Spjd 173168404Spjd/* ARGSUSED */ 174168404Spjdstatic int 175168404Spjdzfs_compare(const void *larg, const void *rarg, void *unused) 176168404Spjd{ 177168404Spjd zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle; 178168404Spjd zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle; 179168404Spjd const char *lname = zfs_get_name(l); 180168404Spjd const char *rname = zfs_get_name(r); 181168404Spjd char *lat, *rat; 182168404Spjd uint64_t lcreate, rcreate; 183168404Spjd int ret; 184168404Spjd 185168404Spjd lat = (char *)strchr(lname, '@'); 186168404Spjd rat = (char *)strchr(rname, '@'); 187168404Spjd 188168404Spjd if (lat != NULL) 189168404Spjd *lat = '\0'; 190168404Spjd if (rat != NULL) 191168404Spjd *rat = '\0'; 192168404Spjd 193168404Spjd ret = strcmp(lname, rname); 194168404Spjd if (ret == 0) { 195168404Spjd /* 196168404Spjd * If we're comparing a dataset to one of its snapshots, we 197168404Spjd * always make the full dataset first. 198168404Spjd */ 199168404Spjd if (lat == NULL) { 200168404Spjd ret = -1; 201168404Spjd } else if (rat == NULL) { 202168404Spjd ret = 1; 203168404Spjd } else { 204168404Spjd /* 205168404Spjd * If we have two snapshots from the same dataset, then 206168404Spjd * we want to sort them according to creation time. We 207168404Spjd * use the hidden CREATETXG property to get an absolute 208168404Spjd * ordering of snapshots. 209168404Spjd */ 210168404Spjd lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG); 211168404Spjd rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG); 212168404Spjd 213168404Spjd if (lcreate < rcreate) 214168404Spjd ret = -1; 215168404Spjd else if (lcreate > rcreate) 216168404Spjd ret = 1; 217168404Spjd } 218168404Spjd } 219168404Spjd 220168404Spjd if (lat != NULL) 221168404Spjd *lat = '@'; 222168404Spjd if (rat != NULL) 223168404Spjd *rat = '@'; 224168404Spjd 225168404Spjd return (ret); 226168404Spjd} 227168404Spjd 228168404Spjd/* 229168404Spjd * Sort datasets by specified columns. 230168404Spjd * 231168404Spjd * o Numeric types sort in ascending order. 232168404Spjd * o String types sort in alphabetical order. 233168404Spjd * o Types inappropriate for a row sort that row to the literal 234168404Spjd * bottom, regardless of the specified ordering. 235168404Spjd * 236168404Spjd * If no sort columns are specified, or two datasets compare equally 237168404Spjd * across all specified columns, they are sorted alphabetically by name 238168404Spjd * with snapshots grouped under their parents. 239168404Spjd */ 240168404Spjdstatic int 241168404Spjdzfs_sort(const void *larg, const void *rarg, void *data) 242168404Spjd{ 243168404Spjd zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle; 244168404Spjd zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle; 245168404Spjd zfs_sort_column_t *sc = (zfs_sort_column_t *)data; 246168404Spjd zfs_sort_column_t *psc; 247168404Spjd 248168404Spjd for (psc = sc; psc != NULL; psc = psc->sc_next) { 249168404Spjd char lbuf[ZFS_MAXPROPLEN], rbuf[ZFS_MAXPROPLEN]; 250168404Spjd char *lstr, *rstr; 251168404Spjd uint64_t lnum, rnum; 252168404Spjd boolean_t lvalid, rvalid; 253168404Spjd int ret = 0; 254168404Spjd 255168404Spjd /* 256168404Spjd * We group the checks below the generic code. If 'lstr' and 257168404Spjd * 'rstr' are non-NULL, then we do a string based comparison. 258168404Spjd * Otherwise, we compare 'lnum' and 'rnum'. 259168404Spjd */ 260168404Spjd lstr = rstr = NULL; 261185029Spjd if (psc->sc_prop == ZPROP_INVAL) { 262168404Spjd nvlist_t *luser, *ruser; 263168404Spjd nvlist_t *lval, *rval; 264168404Spjd 265168404Spjd luser = zfs_get_user_props(l); 266168404Spjd ruser = zfs_get_user_props(r); 267168404Spjd 268168404Spjd lvalid = (nvlist_lookup_nvlist(luser, 269168404Spjd psc->sc_user_prop, &lval) == 0); 270168404Spjd rvalid = (nvlist_lookup_nvlist(ruser, 271168404Spjd psc->sc_user_prop, &rval) == 0); 272168404Spjd 273168404Spjd if (lvalid) 274168404Spjd verify(nvlist_lookup_string(lval, 275185029Spjd ZPROP_VALUE, &lstr) == 0); 276168404Spjd if (rvalid) 277168404Spjd verify(nvlist_lookup_string(rval, 278185029Spjd ZPROP_VALUE, &rstr) == 0); 279168404Spjd 280168404Spjd } else if (zfs_prop_is_string(psc->sc_prop)) { 281168404Spjd lvalid = (zfs_prop_get(l, psc->sc_prop, lbuf, 282168404Spjd sizeof (lbuf), NULL, NULL, 0, B_TRUE) == 0); 283168404Spjd rvalid = (zfs_prop_get(r, psc->sc_prop, rbuf, 284168404Spjd sizeof (rbuf), NULL, NULL, 0, B_TRUE) == 0); 285168404Spjd 286168404Spjd lstr = lbuf; 287168404Spjd rstr = rbuf; 288168404Spjd } else { 289168404Spjd lvalid = zfs_prop_valid_for_type(psc->sc_prop, 290168404Spjd zfs_get_type(l)); 291168404Spjd rvalid = zfs_prop_valid_for_type(psc->sc_prop, 292168404Spjd zfs_get_type(r)); 293168404Spjd 294168404Spjd if (lvalid) 295168404Spjd (void) zfs_prop_get_numeric(l, psc->sc_prop, 296168404Spjd &lnum, NULL, NULL, 0); 297168404Spjd if (rvalid) 298168404Spjd (void) zfs_prop_get_numeric(r, psc->sc_prop, 299168404Spjd &rnum, NULL, NULL, 0); 300168404Spjd } 301168404Spjd 302168404Spjd if (!lvalid && !rvalid) 303168404Spjd continue; 304168404Spjd else if (!lvalid) 305168404Spjd return (1); 306168404Spjd else if (!rvalid) 307168404Spjd return (-1); 308168404Spjd 309168404Spjd if (lstr) 310168404Spjd ret = strcmp(lstr, rstr); 311185029Spjd else if (lnum < rnum) 312168404Spjd ret = -1; 313168404Spjd else if (lnum > rnum) 314168404Spjd ret = 1; 315168404Spjd 316168404Spjd if (ret != 0) { 317168404Spjd if (psc->sc_reverse == B_TRUE) 318168404Spjd ret = (ret < 0) ? 1 : -1; 319168404Spjd return (ret); 320168404Spjd } 321168404Spjd } 322168404Spjd 323168404Spjd return (zfs_compare(larg, rarg, NULL)); 324168404Spjd} 325168404Spjd 326168404Spjdint 327185029Spjdzfs_for_each(int argc, char **argv, int flags, zfs_type_t types, 328185029Spjd zfs_sort_column_t *sortcol, zprop_list_t **proplist, 329185029Spjd zfs_iter_f callback, void *data) 330168404Spjd{ 331168404Spjd callback_data_t cb; 332168404Spjd int ret = 0; 333168404Spjd zfs_node_t *node; 334168404Spjd uu_avl_walk_t *walk; 335168404Spjd 336168404Spjd avl_pool = uu_avl_pool_create("zfs_pool", sizeof (zfs_node_t), 337168404Spjd offsetof(zfs_node_t, zn_avlnode), zfs_sort, UU_DEFAULT); 338168404Spjd 339168404Spjd if (avl_pool == NULL) { 340168404Spjd (void) fprintf(stderr, 341168404Spjd gettext("internal error: out of memory\n")); 342168404Spjd exit(1); 343168404Spjd } 344168404Spjd 345168404Spjd cb.cb_sortcol = sortcol; 346185029Spjd cb.cb_flags = flags; 347168404Spjd cb.cb_proplist = proplist; 348168404Spjd cb.cb_types = types; 349168404Spjd if ((cb.cb_avl = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL) { 350168404Spjd (void) fprintf(stderr, 351168404Spjd gettext("internal error: out of memory\n")); 352168404Spjd exit(1); 353168404Spjd } 354168404Spjd 355168404Spjd if (argc == 0) { 356168404Spjd /* 357168404Spjd * If given no arguments, iterate over all datasets. 358168404Spjd */ 359185029Spjd cb.cb_flags |= ZFS_ITER_RECURSE; 360168404Spjd ret = zfs_iter_root(g_zfs, zfs_callback, &cb); 361168404Spjd } else { 362168404Spjd int i; 363168404Spjd zfs_handle_t *zhp; 364168404Spjd zfs_type_t argtype; 365168404Spjd 366168404Spjd /* 367168404Spjd * If we're recursive, then we always allow filesystems as 368168404Spjd * arguments. If we also are interested in snapshots, then we 369168404Spjd * can take volumes as well. 370168404Spjd */ 371168404Spjd argtype = types; 372185029Spjd if (flags & ZFS_ITER_RECURSE) { 373168404Spjd argtype |= ZFS_TYPE_FILESYSTEM; 374168404Spjd if (types & ZFS_TYPE_SNAPSHOT) 375168404Spjd argtype |= ZFS_TYPE_VOLUME; 376168404Spjd } 377168404Spjd 378168404Spjd for (i = 0; i < argc; i++) { 379185029Spjd if (flags & ZFS_ITER_ARGS_CAN_BE_PATHS) { 380168404Spjd zhp = zfs_path_to_zhandle(g_zfs, argv[i], 381168404Spjd argtype); 382168404Spjd } else { 383168404Spjd zhp = zfs_open(g_zfs, argv[i], argtype); 384168404Spjd } 385168404Spjd if (zhp != NULL) 386168404Spjd ret |= zfs_callback(zhp, &cb); 387168404Spjd else 388168404Spjd ret = 1; 389168404Spjd } 390168404Spjd } 391168404Spjd 392168404Spjd /* 393168404Spjd * At this point we've got our AVL tree full of zfs handles, so iterate 394168404Spjd * over each one and execute the real user callback. 395168404Spjd */ 396168404Spjd for (node = uu_avl_first(cb.cb_avl); node != NULL; 397168404Spjd node = uu_avl_next(cb.cb_avl, node)) 398168404Spjd ret |= callback(node->zn_handle, data); 399168404Spjd 400168404Spjd /* 401168404Spjd * Finally, clean up the AVL tree. 402168404Spjd */ 403168404Spjd if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL) { 404168404Spjd (void) fprintf(stderr, 405168404Spjd gettext("internal error: out of memory")); 406168404Spjd exit(1); 407168404Spjd } 408168404Spjd 409168404Spjd while ((node = uu_avl_walk_next(walk)) != NULL) { 410168404Spjd uu_avl_remove(cb.cb_avl, node); 411168404Spjd zfs_close(node->zn_handle); 412168404Spjd free(node); 413168404Spjd } 414168404Spjd 415168404Spjd uu_avl_walk_end(walk); 416168404Spjd uu_avl_destroy(cb.cb_avl); 417168404Spjd uu_avl_pool_destroy(avl_pool); 418168404Spjd 419168404Spjd return (ret); 420168404Spjd} 421