zfs_iter.c revision 168404
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/* 22168404Spjd * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23168404Spjd * Use is subject to license terms. 24168404Spjd */ 25168404Spjd 26168404Spjd#pragma ident "%Z%%M% %I% %E% SMI" 27168404Spjd 28168404Spjd#include <libintl.h> 29168404Spjd#include <libuutil.h> 30168404Spjd#include <stddef.h> 31168404Spjd#include <stdio.h> 32168404Spjd#include <stdlib.h> 33168404Spjd#include <strings.h> 34168404Spjd 35168404Spjd#include <libzfs.h> 36168404Spjd 37168404Spjd#include "zfs_util.h" 38168404Spjd#include "zfs_iter.h" 39168404Spjd 40168404Spjd/* 41168404Spjd * This is a private interface used to gather up all the datasets specified on 42168404Spjd * the command line so that we can iterate over them in order. 43168404Spjd * 44168404Spjd * First, we iterate over all filesystems, gathering them together into an 45168404Spjd * AVL tree. We report errors for any explicitly specified datasets 46168404Spjd * that we couldn't open. 47168404Spjd * 48168404Spjd * When finished, we have an AVL tree of ZFS handles. We go through and execute 49168404Spjd * the provided callback for each one, passing whatever data the user supplied. 50168404Spjd */ 51168404Spjd 52168404Spjdtypedef struct zfs_node { 53168404Spjd zfs_handle_t *zn_handle; 54168404Spjd uu_avl_node_t zn_avlnode; 55168404Spjd} zfs_node_t; 56168404Spjd 57168404Spjdtypedef struct callback_data { 58168404Spjd uu_avl_t *cb_avl; 59168404Spjd int cb_recurse; 60168404Spjd zfs_type_t cb_types; 61168404Spjd zfs_sort_column_t *cb_sortcol; 62168404Spjd zfs_proplist_t **cb_proplist; 63168404Spjd} callback_data_t; 64168404Spjd 65168404Spjduu_avl_pool_t *avl_pool; 66168404Spjd 67168404Spjd/* 68168404Spjd * Called for each dataset. If the object the object is of an appropriate type, 69168404Spjd * add it to the avl tree and recurse over any children as necessary. 70168404Spjd */ 71168404Spjdint 72168404Spjdzfs_callback(zfs_handle_t *zhp, void *data) 73168404Spjd{ 74168404Spjd callback_data_t *cb = data; 75168404Spjd int dontclose = 0; 76168404Spjd 77168404Spjd /* 78168404Spjd * If this object is of the appropriate type, add it to the AVL tree. 79168404Spjd */ 80168404Spjd if (zfs_get_type(zhp) & cb->cb_types) { 81168404Spjd uu_avl_index_t idx; 82168404Spjd zfs_node_t *node = safe_malloc(sizeof (zfs_node_t)); 83168404Spjd 84168404Spjd node->zn_handle = zhp; 85168404Spjd uu_avl_node_init(node, &node->zn_avlnode, avl_pool); 86168404Spjd if (uu_avl_find(cb->cb_avl, node, cb->cb_sortcol, 87168404Spjd &idx) == NULL) { 88168404Spjd if (cb->cb_proplist && 89168404Spjd zfs_expand_proplist(zhp, cb->cb_proplist) != 0) { 90168404Spjd free(node); 91168404Spjd return (-1); 92168404Spjd } 93168404Spjd uu_avl_insert(cb->cb_avl, node, idx); 94168404Spjd dontclose = 1; 95168404Spjd } else { 96168404Spjd free(node); 97168404Spjd } 98168404Spjd } 99168404Spjd 100168404Spjd /* 101168404Spjd * Recurse if necessary. 102168404Spjd */ 103168404Spjd if (cb->cb_recurse && (zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM || 104168404Spjd (zfs_get_type(zhp) == ZFS_TYPE_VOLUME && (cb->cb_types & 105168404Spjd ZFS_TYPE_SNAPSHOT)))) 106168404Spjd (void) zfs_iter_children(zhp, zfs_callback, data); 107168404Spjd 108168404Spjd if (!dontclose) 109168404Spjd zfs_close(zhp); 110168404Spjd 111168404Spjd return (0); 112168404Spjd} 113168404Spjd 114168404Spjdint 115168404Spjdzfs_add_sort_column(zfs_sort_column_t **sc, const char *name, 116168404Spjd boolean_t reverse) 117168404Spjd{ 118168404Spjd zfs_sort_column_t *col; 119168404Spjd zfs_prop_t prop; 120168404Spjd 121168404Spjd if ((prop = zfs_name_to_prop(name)) == ZFS_PROP_INVAL && 122168404Spjd !zfs_prop_user(name)) 123168404Spjd return (-1); 124168404Spjd 125168404Spjd col = safe_malloc(sizeof (zfs_sort_column_t)); 126168404Spjd 127168404Spjd col->sc_prop = prop; 128168404Spjd col->sc_reverse = reverse; 129168404Spjd if (prop == ZFS_PROP_INVAL) { 130168404Spjd col->sc_user_prop = safe_malloc(strlen(name) + 1); 131168404Spjd (void) strcpy(col->sc_user_prop, name); 132168404Spjd } 133168404Spjd 134168404Spjd if (*sc == NULL) { 135168404Spjd col->sc_last = col; 136168404Spjd *sc = col; 137168404Spjd } else { 138168404Spjd (*sc)->sc_last->sc_next = col; 139168404Spjd (*sc)->sc_last = col; 140168404Spjd } 141168404Spjd 142168404Spjd return (0); 143168404Spjd} 144168404Spjd 145168404Spjdvoid 146168404Spjdzfs_free_sort_columns(zfs_sort_column_t *sc) 147168404Spjd{ 148168404Spjd zfs_sort_column_t *col; 149168404Spjd 150168404Spjd while (sc != NULL) { 151168404Spjd col = sc->sc_next; 152168404Spjd free(sc->sc_user_prop); 153168404Spjd free(sc); 154168404Spjd sc = col; 155168404Spjd } 156168404Spjd} 157168404Spjd 158168404Spjd/* ARGSUSED */ 159168404Spjdstatic int 160168404Spjdzfs_compare(const void *larg, const void *rarg, void *unused) 161168404Spjd{ 162168404Spjd zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle; 163168404Spjd zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle; 164168404Spjd const char *lname = zfs_get_name(l); 165168404Spjd const char *rname = zfs_get_name(r); 166168404Spjd char *lat, *rat; 167168404Spjd uint64_t lcreate, rcreate; 168168404Spjd int ret; 169168404Spjd 170168404Spjd lat = (char *)strchr(lname, '@'); 171168404Spjd rat = (char *)strchr(rname, '@'); 172168404Spjd 173168404Spjd if (lat != NULL) 174168404Spjd *lat = '\0'; 175168404Spjd if (rat != NULL) 176168404Spjd *rat = '\0'; 177168404Spjd 178168404Spjd ret = strcmp(lname, rname); 179168404Spjd if (ret == 0) { 180168404Spjd /* 181168404Spjd * If we're comparing a dataset to one of its snapshots, we 182168404Spjd * always make the full dataset first. 183168404Spjd */ 184168404Spjd if (lat == NULL) { 185168404Spjd ret = -1; 186168404Spjd } else if (rat == NULL) { 187168404Spjd ret = 1; 188168404Spjd } else { 189168404Spjd /* 190168404Spjd * If we have two snapshots from the same dataset, then 191168404Spjd * we want to sort them according to creation time. We 192168404Spjd * use the hidden CREATETXG property to get an absolute 193168404Spjd * ordering of snapshots. 194168404Spjd */ 195168404Spjd lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG); 196168404Spjd rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG); 197168404Spjd 198168404Spjd if (lcreate < rcreate) 199168404Spjd ret = -1; 200168404Spjd else if (lcreate > rcreate) 201168404Spjd ret = 1; 202168404Spjd } 203168404Spjd } 204168404Spjd 205168404Spjd if (lat != NULL) 206168404Spjd *lat = '@'; 207168404Spjd if (rat != NULL) 208168404Spjd *rat = '@'; 209168404Spjd 210168404Spjd return (ret); 211168404Spjd} 212168404Spjd 213168404Spjd/* 214168404Spjd * Sort datasets by specified columns. 215168404Spjd * 216168404Spjd * o Numeric types sort in ascending order. 217168404Spjd * o String types sort in alphabetical order. 218168404Spjd * o Types inappropriate for a row sort that row to the literal 219168404Spjd * bottom, regardless of the specified ordering. 220168404Spjd * 221168404Spjd * If no sort columns are specified, or two datasets compare equally 222168404Spjd * across all specified columns, they are sorted alphabetically by name 223168404Spjd * with snapshots grouped under their parents. 224168404Spjd */ 225168404Spjdstatic int 226168404Spjdzfs_sort(const void *larg, const void *rarg, void *data) 227168404Spjd{ 228168404Spjd zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle; 229168404Spjd zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle; 230168404Spjd zfs_sort_column_t *sc = (zfs_sort_column_t *)data; 231168404Spjd zfs_sort_column_t *psc; 232168404Spjd 233168404Spjd for (psc = sc; psc != NULL; psc = psc->sc_next) { 234168404Spjd char lbuf[ZFS_MAXPROPLEN], rbuf[ZFS_MAXPROPLEN]; 235168404Spjd char *lstr, *rstr; 236168404Spjd uint64_t lnum, rnum; 237168404Spjd boolean_t lvalid, rvalid; 238168404Spjd int ret = 0; 239168404Spjd 240168404Spjd /* 241168404Spjd * We group the checks below the generic code. If 'lstr' and 242168404Spjd * 'rstr' are non-NULL, then we do a string based comparison. 243168404Spjd * Otherwise, we compare 'lnum' and 'rnum'. 244168404Spjd */ 245168404Spjd lstr = rstr = NULL; 246168404Spjd if (psc->sc_prop == ZFS_PROP_INVAL) { 247168404Spjd nvlist_t *luser, *ruser; 248168404Spjd nvlist_t *lval, *rval; 249168404Spjd 250168404Spjd luser = zfs_get_user_props(l); 251168404Spjd ruser = zfs_get_user_props(r); 252168404Spjd 253168404Spjd lvalid = (nvlist_lookup_nvlist(luser, 254168404Spjd psc->sc_user_prop, &lval) == 0); 255168404Spjd rvalid = (nvlist_lookup_nvlist(ruser, 256168404Spjd psc->sc_user_prop, &rval) == 0); 257168404Spjd 258168404Spjd if (lvalid) 259168404Spjd verify(nvlist_lookup_string(lval, 260168404Spjd ZFS_PROP_VALUE, &lstr) == 0); 261168404Spjd if (rvalid) 262168404Spjd verify(nvlist_lookup_string(rval, 263168404Spjd ZFS_PROP_VALUE, &rstr) == 0); 264168404Spjd 265168404Spjd } else if (zfs_prop_is_string(psc->sc_prop)) { 266168404Spjd lvalid = (zfs_prop_get(l, psc->sc_prop, lbuf, 267168404Spjd sizeof (lbuf), NULL, NULL, 0, B_TRUE) == 0); 268168404Spjd rvalid = (zfs_prop_get(r, psc->sc_prop, rbuf, 269168404Spjd sizeof (rbuf), NULL, NULL, 0, B_TRUE) == 0); 270168404Spjd 271168404Spjd lstr = lbuf; 272168404Spjd rstr = rbuf; 273168404Spjd } else { 274168404Spjd lvalid = zfs_prop_valid_for_type(psc->sc_prop, 275168404Spjd zfs_get_type(l)); 276168404Spjd rvalid = zfs_prop_valid_for_type(psc->sc_prop, 277168404Spjd zfs_get_type(r)); 278168404Spjd 279168404Spjd if (lvalid) 280168404Spjd (void) zfs_prop_get_numeric(l, psc->sc_prop, 281168404Spjd &lnum, NULL, NULL, 0); 282168404Spjd if (rvalid) 283168404Spjd (void) zfs_prop_get_numeric(r, psc->sc_prop, 284168404Spjd &rnum, NULL, NULL, 0); 285168404Spjd } 286168404Spjd 287168404Spjd if (!lvalid && !rvalid) 288168404Spjd continue; 289168404Spjd else if (!lvalid) 290168404Spjd return (1); 291168404Spjd else if (!rvalid) 292168404Spjd return (-1); 293168404Spjd 294168404Spjd if (lstr) 295168404Spjd ret = strcmp(lstr, rstr); 296168404Spjd if (lnum < rnum) 297168404Spjd ret = -1; 298168404Spjd else if (lnum > rnum) 299168404Spjd ret = 1; 300168404Spjd 301168404Spjd if (ret != 0) { 302168404Spjd if (psc->sc_reverse == B_TRUE) 303168404Spjd ret = (ret < 0) ? 1 : -1; 304168404Spjd return (ret); 305168404Spjd } 306168404Spjd } 307168404Spjd 308168404Spjd return (zfs_compare(larg, rarg, NULL)); 309168404Spjd} 310168404Spjd 311168404Spjdint 312168404Spjdzfs_for_each(int argc, char **argv, boolean_t recurse, zfs_type_t types, 313168404Spjd zfs_sort_column_t *sortcol, zfs_proplist_t **proplist, zfs_iter_f callback, 314168404Spjd void *data, boolean_t args_can_be_paths) 315168404Spjd{ 316168404Spjd callback_data_t cb; 317168404Spjd int ret = 0; 318168404Spjd zfs_node_t *node; 319168404Spjd uu_avl_walk_t *walk; 320168404Spjd 321168404Spjd avl_pool = uu_avl_pool_create("zfs_pool", sizeof (zfs_node_t), 322168404Spjd offsetof(zfs_node_t, zn_avlnode), zfs_sort, UU_DEFAULT); 323168404Spjd 324168404Spjd if (avl_pool == NULL) { 325168404Spjd (void) fprintf(stderr, 326168404Spjd gettext("internal error: out of memory\n")); 327168404Spjd exit(1); 328168404Spjd } 329168404Spjd 330168404Spjd cb.cb_sortcol = sortcol; 331168404Spjd cb.cb_recurse = recurse; 332168404Spjd cb.cb_proplist = proplist; 333168404Spjd cb.cb_types = types; 334168404Spjd if ((cb.cb_avl = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL) { 335168404Spjd (void) fprintf(stderr, 336168404Spjd gettext("internal error: out of memory\n")); 337168404Spjd exit(1); 338168404Spjd } 339168404Spjd 340168404Spjd if (argc == 0) { 341168404Spjd /* 342168404Spjd * If given no arguments, iterate over all datasets. 343168404Spjd */ 344168404Spjd cb.cb_recurse = 1; 345168404Spjd ret = zfs_iter_root(g_zfs, zfs_callback, &cb); 346168404Spjd } else { 347168404Spjd int i; 348168404Spjd zfs_handle_t *zhp; 349168404Spjd zfs_type_t argtype; 350168404Spjd 351168404Spjd /* 352168404Spjd * If we're recursive, then we always allow filesystems as 353168404Spjd * arguments. If we also are interested in snapshots, then we 354168404Spjd * can take volumes as well. 355168404Spjd */ 356168404Spjd argtype = types; 357168404Spjd if (recurse) { 358168404Spjd argtype |= ZFS_TYPE_FILESYSTEM; 359168404Spjd if (types & ZFS_TYPE_SNAPSHOT) 360168404Spjd argtype |= ZFS_TYPE_VOLUME; 361168404Spjd } 362168404Spjd 363168404Spjd for (i = 0; i < argc; i++) { 364168404Spjd if (args_can_be_paths) { 365168404Spjd zhp = zfs_path_to_zhandle(g_zfs, argv[i], 366168404Spjd argtype); 367168404Spjd } else { 368168404Spjd zhp = zfs_open(g_zfs, argv[i], argtype); 369168404Spjd } 370168404Spjd if (zhp != NULL) 371168404Spjd ret |= zfs_callback(zhp, &cb); 372168404Spjd else 373168404Spjd ret = 1; 374168404Spjd } 375168404Spjd } 376168404Spjd 377168404Spjd /* 378168404Spjd * At this point we've got our AVL tree full of zfs handles, so iterate 379168404Spjd * over each one and execute the real user callback. 380168404Spjd */ 381168404Spjd for (node = uu_avl_first(cb.cb_avl); node != NULL; 382168404Spjd node = uu_avl_next(cb.cb_avl, node)) 383168404Spjd ret |= callback(node->zn_handle, data); 384168404Spjd 385168404Spjd /* 386168404Spjd * Finally, clean up the AVL tree. 387168404Spjd */ 388168404Spjd if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL) { 389168404Spjd (void) fprintf(stderr, 390168404Spjd gettext("internal error: out of memory")); 391168404Spjd exit(1); 392168404Spjd } 393168404Spjd 394168404Spjd while ((node = uu_avl_walk_next(walk)) != NULL) { 395168404Spjd uu_avl_remove(cb.cb_avl, node); 396168404Spjd zfs_close(node->zn_handle); 397168404Spjd free(node); 398168404Spjd } 399168404Spjd 400168404Spjd uu_avl_walk_end(walk); 401168404Spjd uu_avl_destroy(cb.cb_avl); 402168404Spjd uu_avl_pool_destroy(avl_pool); 403168404Spjd 404168404Spjd return (ret); 405168404Spjd} 406