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