sys/contrib/openzfs/cmd/zfs/zfs_iter.c

   1 /*
   2  * CDDL HEADER START
   3  *
   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.
   7  *
   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.
  12  *
  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]
  18  *
  19  * CDDL HEADER END
  20  */
  21
  22 /*
  23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  24  * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
  25  * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
  26  * Copyright (c) 2013 by Delphix. All rights reserved.
  27  */
  28
  29 #include <libintl.h>
  30 #include <libuutil.h>
  31 #include <stddef.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34 #include <string.h>
  35
  36 #include <libzfs.h>
  37
  38 #include "zfs_util.h"
  39 #include "zfs_iter.h"
  40
  41 /*
  42  * This is a private interface used to gather up all the datasets specified on
  43  * the command line so that we can iterate over them in order.
  44  *
  45  * First, we iterate over all filesystems, gathering them together into an
  46  * AVL tree.  We report errors for any explicitly specified datasets
  47  * that we couldn't open.
  48  *
  49  * When finished, we have an AVL tree of ZFS handles.  We go through and execute
  50  * the provided callback for each one, passing whatever data the user supplied.
  51  */
  52
  53 typedef struct zfs_node {
  54         zfs_handle_t    *zn_handle;
  55         uu_avl_node_t   zn_avlnode;
  56 } zfs_node_t;
  57
  58 typedef struct callback_data {
  59         uu_avl_t                *cb_avl;
  60         int                     cb_flags;
  61         zfs_type_t              cb_types;
  62         zfs_sort_column_t       *cb_sortcol;
  63         zprop_list_t            **cb_proplist;
  64         int                     cb_depth_limit;
  65         int                     cb_depth;
  66         uint8_t                 cb_props_table[ZFS_NUM_PROPS];
  67 } callback_data_t;
  68
  69 uu_avl_pool_t *avl_pool;
  70
  71 /*
  72  * Include snaps if they were requested or if this a zfs list where types
  73  * were not specified and the "listsnapshots" property is set on this pool.
  74  */
  75 static boolean_t
  76 zfs_include_snapshots(zfs_handle_t *zhp, callback_data_t *cb)
  77 {
  78         zpool_handle_t *zph;
  79
  80         if ((cb->cb_flags & ZFS_ITER_PROP_LISTSNAPS) == 0)
  81                 return (cb->cb_types & ZFS_TYPE_SNAPSHOT);
  82
  83         zph = zfs_get_pool_handle(zhp);
  84         return (zpool_get_prop_int(zph, ZPOOL_PROP_LISTSNAPS, NULL));
  85 }
  86
  87 /*
  88  * Called for each dataset.  If the object is of an appropriate type,
  89  * add it to the avl tree and recurse over any children as necessary.
  90  */
  91 static int
  92 zfs_callback(zfs_handle_t *zhp, void *data)
  93 {
  94         callback_data_t *cb = data;
  95         boolean_t should_close = B_TRUE;
  96         boolean_t include_snaps = zfs_include_snapshots(zhp, cb);
  97         boolean_t include_bmarks = (cb->cb_types & ZFS_TYPE_BOOKMARK);
  98
  99         if ((zfs_get_type(zhp) & cb->cb_types) ||
 100             ((zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT) && include_snaps)) {
 101                 uu_avl_index_t idx;
 102                 zfs_node_t *node = safe_malloc(sizeof (zfs_node_t));
 103
 104                 node->zn_handle = zhp;
 105                 uu_avl_node_init(node, &node->zn_avlnode, avl_pool);
 106                 if (uu_avl_find(cb->cb_avl, node, cb->cb_sortcol,
 107                     &idx) == NULL) {
 108                         if (cb->cb_proplist) {
 109                                 if ((*cb->cb_proplist) &&
 110                                     !(*cb->cb_proplist)->pl_all)
 111                                         zfs_prune_proplist(zhp,
 112                                             cb->cb_props_table);
 113
 114                                 if (zfs_expand_proplist(zhp, cb->cb_proplist,
 115                                     (cb->cb_flags & ZFS_ITER_RECVD_PROPS),
 116                                     (cb->cb_flags & ZFS_ITER_LITERAL_PROPS))
 117                                     != 0) {
 118                                         free(node);
 119                                         return (-1);
 120                                 }
 121                         }
 122                         uu_avl_insert(cb->cb_avl, node, idx);
 123                         should_close = B_FALSE;
 124                 } else {
 125                         free(node);
 126                 }
 127         }
 128
 129         /*
 130          * Recurse if necessary.
 131          */
 132         if (cb->cb_flags & ZFS_ITER_RECURSE &&
 133             ((cb->cb_flags & ZFS_ITER_DEPTH_LIMIT) == 0 ||
 134             cb->cb_depth < cb->cb_depth_limit)) {
 135                 cb->cb_depth++;
 136
 137                 /*
 138                  * If we are not looking for filesystems, we don't need to
 139                  * recurse into filesystems when we are at our depth limit.
 140                  */
 141                 if ((cb->cb_depth < cb->cb_depth_limit ||
 142                     (cb->cb_flags & ZFS_ITER_DEPTH_LIMIT) == 0 ||
 143                     (cb->cb_types &
 144                     (ZFS_TYPE_FILESYSTEM | ZFS_TYPE_VOLUME))) &&
 145                     zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) {
 146                         (void) zfs_iter_filesystems(zhp, zfs_callback, data);
 147                 }
 148
 149                 if (((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT |
 150                     ZFS_TYPE_BOOKMARK)) == 0) && include_snaps) {
 151                         (void) zfs_iter_snapshots(zhp,
 152                             (cb->cb_flags & ZFS_ITER_SIMPLE) != 0,
 153                             zfs_callback, data, 0, 0);
 154                 }
 155
 156                 if (((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT |
 157                     ZFS_TYPE_BOOKMARK)) == 0) && include_bmarks) {
 158                         (void) zfs_iter_bookmarks(zhp, zfs_callback, data);
 159                 }
 160
 161                 cb->cb_depth--;
 162         }
 163
 164         if (should_close)
 165                 zfs_close(zhp);
 166
 167         return (0);
 168 }
 169
 170 int
 171 zfs_add_sort_column(zfs_sort_column_t **sc, const char *name,
 172     boolean_t reverse)
 173 {
 174         zfs_sort_column_t *col;
 175         zfs_prop_t prop;
 176
 177         if ((prop = zfs_name_to_prop(name)) == ZPROP_INVAL &&
 178             !zfs_prop_user(name))
 179                 return (-1);
 180
 181         col = safe_malloc(sizeof (zfs_sort_column_t));
 182
 183         col->sc_prop = prop;
 184         col->sc_reverse = reverse;
 185         if (prop == ZPROP_INVAL) {
 186                 col->sc_user_prop = safe_malloc(strlen(name) + 1);
 187                 (void) strcpy(col->sc_user_prop, name);
 188         }
 189
 190         if (*sc == NULL) {
 191                 col->sc_last = col;
 192                 *sc = col;
 193         } else {
 194                 (*sc)->sc_last->sc_next = col;
 195                 (*sc)->sc_last = col;
 196         }
 197
 198         return (0);
 199 }
 200
 201 void
 202 zfs_free_sort_columns(zfs_sort_column_t *sc)
 203 {
 204         zfs_sort_column_t *col;
 205
 206         while (sc != NULL) {
 207                 col = sc->sc_next;
 208                 free(sc->sc_user_prop);
 209                 free(sc);
 210                 sc = col;
 211         }
 212 }
 213
 214 int
 215 zfs_sort_only_by_name(const zfs_sort_column_t *sc)
 216 {
 217         return (sc != NULL && sc->sc_next == NULL &&
 218             sc->sc_prop == ZFS_PROP_NAME);
 219 }
 220
 221 static int
 222 zfs_compare(const void *larg, const void *rarg)
 223 {
 224         zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
 225         zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
 226         const char *lname = zfs_get_name(l);
 227         const char *rname = zfs_get_name(r);
 228         char *lat, *rat;
 229         uint64_t lcreate, rcreate;
 230         int ret;
 231
 232         lat = (char *)strchr(lname, '@');
 233         rat = (char *)strchr(rname, '@');
 234
 235         if (lat != NULL)
 236                 *lat = '\0';
 237         if (rat != NULL)
 238                 *rat = '\0';
 239
 240         ret = strcmp(lname, rname);
 241         if (ret == 0 && (lat != NULL || rat != NULL)) {
 242                 /*
 243                  * If we're comparing a dataset to one of its snapshots, we
 244                  * always make the full dataset first.
 245                  */
 246                 if (lat == NULL) {
 247                         ret = -1;
 248                 } else if (rat == NULL) {
 249                         ret = 1;
 250                 } else {
 251                         /*
 252                          * If we have two snapshots from the same dataset, then
 253                          * we want to sort them according to creation time.  We
 254                          * use the hidden CREATETXG property to get an absolute
 255                          * ordering of snapshots.
 256                          */
 257                         lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG);
 258                         rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG);
 259
 260                         /*
 261                          * Both lcreate and rcreate being 0 means we don't have
 262                          * properties and we should compare full name.
 263                          */
 264                         if (lcreate == 0 && rcreate == 0)
 265                                 ret = strcmp(lat + 1, rat + 1);
 266                         else if (lcreate < rcreate)
 267                                 ret = -1;
 268                         else if (lcreate > rcreate)
 269                                 ret = 1;
 270                 }
 271         }
 272
 273         if (lat != NULL)
 274                 *lat = '@';
 275         if (rat != NULL)
 276                 *rat = '@';
 277
 278         return (ret);
 279 }
 280
 281 /*
 282  * Sort datasets by specified columns.
 283  *
 284  * o  Numeric types sort in ascending order.
 285  * o  String types sort in alphabetical order.
 286  * o  Types inappropriate for a row sort that row to the literal
 287  *    bottom, regardless of the specified ordering.
 288  *
 289  * If no sort columns are specified, or two datasets compare equally
 290  * across all specified columns, they are sorted alphabetically by name
 291  * with snapshots grouped under their parents.
 292  */
 293 static int
 294 zfs_sort(const void *larg, const void *rarg, void *data)
 295 {
 296         zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
 297         zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
 298         zfs_sort_column_t *sc = (zfs_sort_column_t *)data;
 299         zfs_sort_column_t *psc;
 300
 301         for (psc = sc; psc != NULL; psc = psc->sc_next) {
 302                 char lbuf[ZFS_MAXPROPLEN], rbuf[ZFS_MAXPROPLEN];
 303                 char *lstr, *rstr;
 304                 uint64_t lnum, rnum;
 305                 boolean_t lvalid, rvalid;
 306                 int ret = 0;
 307
 308                 /*
 309                  * We group the checks below the generic code.  If 'lstr' and
 310                  * 'rstr' are non-NULL, then we do a string based comparison.
 311                  * Otherwise, we compare 'lnum' and 'rnum'.
 312                  */
 313                 lstr = rstr = NULL;
 314                 if (psc->sc_prop == ZPROP_INVAL) {
 315                         nvlist_t *luser, *ruser;
 316                         nvlist_t *lval, *rval;
 317
 318                         luser = zfs_get_user_props(l);
 319                         ruser = zfs_get_user_props(r);
 320
 321                         lvalid = (nvlist_lookup_nvlist(luser,
 322                             psc->sc_user_prop, &lval) == 0);
 323                         rvalid = (nvlist_lookup_nvlist(ruser,
 324                             psc->sc_user_prop, &rval) == 0);
 325
 326                         if (lvalid)
 327                                 verify(nvlist_lookup_string(lval,
 328                                     ZPROP_VALUE, &lstr) == 0);
 329                         if (rvalid)
 330                                 verify(nvlist_lookup_string(rval,
 331                                     ZPROP_VALUE, &rstr) == 0);
 332                 } else if (psc->sc_prop == ZFS_PROP_NAME) {
 333                         lvalid = rvalid = B_TRUE;
 334
 335                         (void) strlcpy(lbuf, zfs_get_name(l), sizeof (lbuf));
 336                         (void) strlcpy(rbuf, zfs_get_name(r), sizeof (rbuf));
 337
 338                         lstr = lbuf;
 339                         rstr = rbuf;
 340                 } else if (zfs_prop_is_string(psc->sc_prop)) {
 341                         lvalid = (zfs_prop_get(l, psc->sc_prop, lbuf,
 342                             sizeof (lbuf), NULL, NULL, 0, B_TRUE) == 0);
 343                         rvalid = (zfs_prop_get(r, psc->sc_prop, rbuf,
 344                             sizeof (rbuf), NULL, NULL, 0, B_TRUE) == 0);
 345
 346                         lstr = lbuf;
 347                         rstr = rbuf;
 348                 } else {
 349                         lvalid = zfs_prop_valid_for_type(psc->sc_prop,
 350                             zfs_get_type(l), B_FALSE);
 351                         rvalid = zfs_prop_valid_for_type(psc->sc_prop,
 352                             zfs_get_type(r), B_FALSE);
 353
 354                         if (lvalid)
 355                                 (void) zfs_prop_get_numeric(l, psc->sc_prop,
 356                                     &lnum, NULL, NULL, 0);
 357                         if (rvalid)
 358                                 (void) zfs_prop_get_numeric(r, psc->sc_prop,
 359                                     &rnum, NULL, NULL, 0);
 360                 }
 361
 362                 if (!lvalid && !rvalid)
 363                         continue;
 364                 else if (!lvalid)
 365                         return (1);
 366                 else if (!rvalid)
 367                         return (-1);
 368
 369                 if (lstr)
 370                         ret = strcmp(lstr, rstr);
 371                 else if (lnum < rnum)
 372                         ret = -1;
 373                 else if (lnum > rnum)
 374                         ret = 1;
 375
 376                 if (ret != 0) {
 377                         if (psc->sc_reverse == B_TRUE)
 378                                 ret = (ret < 0) ? 1 : -1;
 379                         return (ret);
 380                 }
 381         }
 382
 383         return (zfs_compare(larg, rarg));
 384 }
 385
 386 int
 387 zfs_for_each(int argc, char **argv, int flags, zfs_type_t types,
 388     zfs_sort_column_t *sortcol, zprop_list_t **proplist, int limit,
 389     zfs_iter_f callback, void *data)
 390 {
 391         callback_data_t cb = {0};
 392         int ret = 0;
 393         zfs_node_t *node;
 394         uu_avl_walk_t *walk;
 395
 396         avl_pool = uu_avl_pool_create("zfs_pool", sizeof (zfs_node_t),
 397             offsetof(zfs_node_t, zn_avlnode), zfs_sort, UU_DEFAULT);
 398
 399         if (avl_pool == NULL)
 400                 nomem();
 401
 402         cb.cb_sortcol = sortcol;
 403         cb.cb_flags = flags;
 404         cb.cb_proplist = proplist;
 405         cb.cb_types = types;
 406         cb.cb_depth_limit = limit;
 407         /*
 408          * If cb_proplist is provided then in the zfs_handles created we
 409          * retain only those properties listed in cb_proplist and sortcol.
 410          * The rest are pruned. So, the caller should make sure that no other
 411          * properties other than those listed in cb_proplist/sortcol are
 412          * accessed.
 413          *
 414          * If cb_proplist is NULL then we retain all the properties.  We
 415          * always retain the zoned property, which some other properties
 416          * need (userquota & friends), and the createtxg property, which
 417          * we need to sort snapshots.
 418          */
 419         if (cb.cb_proplist && *cb.cb_proplist) {
 420                 zprop_list_t *p = *cb.cb_proplist;
 421
 422                 while (p) {
 423                         if (p->pl_prop >= ZFS_PROP_TYPE &&
 424                             p->pl_prop < ZFS_NUM_PROPS) {
 425                                 cb.cb_props_table[p->pl_prop] = B_TRUE;
 426                         }
 427                         p = p->pl_next;
 428                 }
 429
 430                 while (sortcol) {
 431                         if (sortcol->sc_prop >= ZFS_PROP_TYPE &&
 432                             sortcol->sc_prop < ZFS_NUM_PROPS) {
 433                                 cb.cb_props_table[sortcol->sc_prop] = B_TRUE;
 434                         }
 435                         sortcol = sortcol->sc_next;
 436                 }
 437
 438                 cb.cb_props_table[ZFS_PROP_ZONED] = B_TRUE;
 439                 cb.cb_props_table[ZFS_PROP_CREATETXG] = B_TRUE;
 440         } else {
 441                 (void) memset(cb.cb_props_table, B_TRUE,
 442                     sizeof (cb.cb_props_table));
 443         }
 444
 445         if ((cb.cb_avl = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL)
 446                 nomem();
 447
 448         if (argc == 0) {
 449                 /*
 450                  * If given no arguments, iterate over all datasets.
 451                  */
 452                 cb.cb_flags |= ZFS_ITER_RECURSE;
 453                 ret = zfs_iter_root(g_zfs, zfs_callback, &cb);
 454         } else {
 455                 zfs_handle_t *zhp = NULL;
 456                 zfs_type_t argtype = types;
 457
 458                 /*
 459                  * If we're recursive, then we always allow filesystems as
 460                  * arguments.  If we also are interested in snapshots or
 461                  * bookmarks, then we can take volumes as well.
 462                  */
 463                 if (flags & ZFS_ITER_RECURSE) {
 464                         argtype |= ZFS_TYPE_FILESYSTEM;
 465                         if (types & (ZFS_TYPE_SNAPSHOT | ZFS_TYPE_BOOKMARK))
 466                                 argtype |= ZFS_TYPE_VOLUME;
 467                 }
 468
 469                 for (int i = 0; i < argc; i++) {
 470                         if (flags & ZFS_ITER_ARGS_CAN_BE_PATHS) {
 471                                 zhp = zfs_path_to_zhandle(g_zfs, argv[i],
 472                                     argtype);
 473                         } else {
 474                                 zhp = zfs_open(g_zfs, argv[i], argtype);
 475                         }
 476                         if (zhp != NULL)
 477                                 ret |= zfs_callback(zhp, &cb);
 478                         else
 479                                 ret = 1;
 480                 }
 481         }
 482
 483         /*
 484          * At this point we've got our AVL tree full of zfs handles, so iterate
 485          * over each one and execute the real user callback.
 486          */
 487         for (node = uu_avl_first(cb.cb_avl); node != NULL;
 488             node = uu_avl_next(cb.cb_avl, node))
 489                 ret |= callback(node->zn_handle, data);
 490
 491         /*
 492          * Finally, clean up the AVL tree.
 493          */
 494         if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL)
 495                 nomem();
 496
 497         while ((node = uu_avl_walk_next(walk)) != NULL) {
 498                 uu_avl_remove(cb.cb_avl, node);
 499                 zfs_close(node->zn_handle);
 500                 free(node);
 501         }
 502
 503         uu_avl_walk_end(walk);
 504         uu_avl_destroy(cb.cb_avl);
 505         uu_avl_pool_destroy(avl_pool);
 506
 507         return (ret);
 508 }