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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2012 Pawel Jakub Dawidek. All rights reserved.
25 * Copyright 2013 Nexenta Systems, Inc. All rights reserved.
26 * Copyright (c) 2013 by Delphix. All rights reserved.
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.
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.
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.
53 typedef struct zfs_node {
54 zfs_handle_t *zn_handle;
55 uu_avl_node_t zn_avlnode;
58 typedef struct callback_data {
62 zfs_sort_column_t *cb_sortcol;
63 zprop_list_t **cb_proplist;
66 uint8_t cb_props_table[ZFS_NUM_PROPS];
69 uu_avl_pool_t *avl_pool;
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.
76 zfs_include_snapshots(zfs_handle_t *zhp, callback_data_t *cb)
80 if ((cb->cb_flags & ZFS_ITER_PROP_LISTSNAPS) == 0)
81 return (cb->cb_types & ZFS_TYPE_SNAPSHOT);
83 zph = zfs_get_pool_handle(zhp);
84 return (zpool_get_prop_int(zph, ZPOOL_PROP_LISTSNAPS, NULL));
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.
92 zfs_callback(zfs_handle_t *zhp, void *data)
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);
99 if ((zfs_get_type(zhp) & cb->cb_types) ||
100 ((zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT) && include_snaps)) {
102 zfs_node_t *node = safe_malloc(sizeof (zfs_node_t));
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,
108 if (cb->cb_proplist) {
109 if ((*cb->cb_proplist) &&
110 !(*cb->cb_proplist)->pl_all)
111 zfs_prune_proplist(zhp,
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))
122 uu_avl_insert(cb->cb_avl, node, idx);
123 should_close = B_FALSE;
130 * Recurse if necessary.
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)) {
136 if (zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM)
137 (void) zfs_iter_filesystems(zhp, zfs_callback, data);
138 if (((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT |
139 ZFS_TYPE_BOOKMARK)) == 0) && include_snaps)
140 (void) zfs_iter_snapshots(zhp,
141 (cb->cb_flags & ZFS_ITER_SIMPLE) != 0, zfs_callback,
143 if (((zfs_get_type(zhp) & (ZFS_TYPE_SNAPSHOT |
144 ZFS_TYPE_BOOKMARK)) == 0) && include_bmarks)
145 (void) zfs_iter_bookmarks(zhp, zfs_callback, data);
156 zfs_add_sort_column(zfs_sort_column_t **sc, const char *name,
159 zfs_sort_column_t *col;
162 if ((prop = zfs_name_to_prop(name)) == ZPROP_INVAL &&
163 !zfs_prop_user(name))
166 col = safe_malloc(sizeof (zfs_sort_column_t));
169 col->sc_reverse = reverse;
170 if (prop == ZPROP_INVAL) {
171 col->sc_user_prop = safe_malloc(strlen(name) + 1);
172 (void) strcpy(col->sc_user_prop, name);
179 (*sc)->sc_last->sc_next = col;
180 (*sc)->sc_last = col;
187 zfs_free_sort_columns(zfs_sort_column_t *sc)
189 zfs_sort_column_t *col;
193 free(sc->sc_user_prop);
200 zfs_sort_only_by_name(const zfs_sort_column_t *sc)
203 return (sc != NULL && sc->sc_next == NULL &&
204 sc->sc_prop == ZFS_PROP_NAME);
209 zfs_compare(const void *larg, const void *rarg, void *unused)
211 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
212 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
213 const char *lname = zfs_get_name(l);
214 const char *rname = zfs_get_name(r);
216 uint64_t lcreate, rcreate;
219 lat = (char *)strchr(lname, '@');
220 rat = (char *)strchr(rname, '@');
227 ret = strcmp(lname, rname);
230 * If we're comparing a dataset to one of its snapshots, we
231 * always make the full dataset first.
235 } else if (rat == NULL) {
239 * If we have two snapshots from the same dataset, then
240 * we want to sort them according to creation time. We
241 * use the hidden CREATETXG property to get an absolute
242 * ordering of snapshots.
244 lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG);
245 rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG);
248 * Both lcreate and rcreate being 0 means we don't have
249 * properties and we should compare full name.
251 if (lcreate == 0 && rcreate == 0)
252 ret = strcmp(lat + 1, rat + 1);
253 else if (lcreate < rcreate)
255 else if (lcreate > rcreate)
269 * Sort datasets by specified columns.
271 * o Numeric types sort in ascending order.
272 * o String types sort in alphabetical order.
273 * o Types inappropriate for a row sort that row to the literal
274 * bottom, regardless of the specified ordering.
276 * If no sort columns are specified, or two datasets compare equally
277 * across all specified columns, they are sorted alphabetically by name
278 * with snapshots grouped under their parents.
281 zfs_sort(const void *larg, const void *rarg, void *data)
283 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
284 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
285 zfs_sort_column_t *sc = (zfs_sort_column_t *)data;
286 zfs_sort_column_t *psc;
288 for (psc = sc; psc != NULL; psc = psc->sc_next) {
289 char lbuf[ZFS_MAXPROPLEN], rbuf[ZFS_MAXPROPLEN];
292 boolean_t lvalid, rvalid;
296 * We group the checks below the generic code. If 'lstr' and
297 * 'rstr' are non-NULL, then we do a string based comparison.
298 * Otherwise, we compare 'lnum' and 'rnum'.
301 if (psc->sc_prop == ZPROP_INVAL) {
302 nvlist_t *luser, *ruser;
303 nvlist_t *lval, *rval;
305 luser = zfs_get_user_props(l);
306 ruser = zfs_get_user_props(r);
308 lvalid = (nvlist_lookup_nvlist(luser,
309 psc->sc_user_prop, &lval) == 0);
310 rvalid = (nvlist_lookup_nvlist(ruser,
311 psc->sc_user_prop, &rval) == 0);
314 verify(nvlist_lookup_string(lval,
315 ZPROP_VALUE, &lstr) == 0);
317 verify(nvlist_lookup_string(rval,
318 ZPROP_VALUE, &rstr) == 0);
319 } else if (psc->sc_prop == ZFS_PROP_NAME) {
320 lvalid = rvalid = B_TRUE;
322 (void) strlcpy(lbuf, zfs_get_name(l), sizeof (lbuf));
323 (void) strlcpy(rbuf, zfs_get_name(r), sizeof (rbuf));
327 } else if (zfs_prop_is_string(psc->sc_prop)) {
328 lvalid = (zfs_prop_get(l, psc->sc_prop, lbuf,
329 sizeof (lbuf), NULL, NULL, 0, B_TRUE) == 0);
330 rvalid = (zfs_prop_get(r, psc->sc_prop, rbuf,
331 sizeof (rbuf), NULL, NULL, 0, B_TRUE) == 0);
336 lvalid = zfs_prop_valid_for_type(psc->sc_prop,
338 rvalid = zfs_prop_valid_for_type(psc->sc_prop,
342 (void) zfs_prop_get_numeric(l, psc->sc_prop,
343 &lnum, NULL, NULL, 0);
345 (void) zfs_prop_get_numeric(r, psc->sc_prop,
346 &rnum, NULL, NULL, 0);
349 if (!lvalid && !rvalid)
357 ret = strcmp(lstr, rstr);
358 else if (lnum < rnum)
360 else if (lnum > rnum)
364 if (psc->sc_reverse == B_TRUE)
365 ret = (ret < 0) ? 1 : -1;
370 return (zfs_compare(larg, rarg, NULL));
374 zfs_for_each(int argc, char **argv, int flags, zfs_type_t types,
375 zfs_sort_column_t *sortcol, zprop_list_t **proplist, int limit,
376 zfs_iter_f callback, void *data)
378 callback_data_t cb = {0};
383 avl_pool = uu_avl_pool_create("zfs_pool", sizeof (zfs_node_t),
384 offsetof(zfs_node_t, zn_avlnode), zfs_sort, UU_DEFAULT);
386 if (avl_pool == NULL)
389 cb.cb_sortcol = sortcol;
391 cb.cb_proplist = proplist;
393 cb.cb_depth_limit = limit;
395 * If cb_proplist is provided then in the zfs_handles created we
396 * retain only those properties listed in cb_proplist and sortcol.
397 * The rest are pruned. So, the caller should make sure that no other
398 * properties other than those listed in cb_proplist/sortcol are
401 * If cb_proplist is NULL then we retain all the properties. We
402 * always retain the zoned property, which some other properties
403 * need (userquota & friends), and the createtxg property, which
404 * we need to sort snapshots.
406 if (cb.cb_proplist && *cb.cb_proplist) {
407 zprop_list_t *p = *cb.cb_proplist;
410 if (p->pl_prop >= ZFS_PROP_TYPE &&
411 p->pl_prop < ZFS_NUM_PROPS) {
412 cb.cb_props_table[p->pl_prop] = B_TRUE;
418 if (sortcol->sc_prop >= ZFS_PROP_TYPE &&
419 sortcol->sc_prop < ZFS_NUM_PROPS) {
420 cb.cb_props_table[sortcol->sc_prop] = B_TRUE;
422 sortcol = sortcol->sc_next;
425 cb.cb_props_table[ZFS_PROP_ZONED] = B_TRUE;
426 cb.cb_props_table[ZFS_PROP_CREATETXG] = B_TRUE;
428 (void) memset(cb.cb_props_table, B_TRUE,
429 sizeof (cb.cb_props_table));
432 if ((cb.cb_avl = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL)
437 * If given no arguments, iterate over all datasets.
439 cb.cb_flags |= ZFS_ITER_RECURSE;
440 ret = zfs_iter_root(g_zfs, zfs_callback, &cb);
447 * If we're recursive, then we always allow filesystems as
448 * arguments. If we also are interested in snapshots, then we
449 * can take volumes as well.
452 if (flags & ZFS_ITER_RECURSE) {
453 argtype |= ZFS_TYPE_FILESYSTEM;
454 if (types & ZFS_TYPE_SNAPSHOT)
455 argtype |= ZFS_TYPE_VOLUME;
458 for (i = 0; i < argc; i++) {
459 if (flags & ZFS_ITER_ARGS_CAN_BE_PATHS) {
460 zhp = zfs_path_to_zhandle(g_zfs, argv[i],
463 zhp = zfs_open(g_zfs, argv[i], argtype);
466 ret |= zfs_callback(zhp, &cb);
473 * At this point we've got our AVL tree full of zfs handles, so iterate
474 * over each one and execute the real user callback.
476 for (node = uu_avl_first(cb.cb_avl); node != NULL;
477 node = uu_avl_next(cb.cb_avl, node))
478 ret |= callback(node->zn_handle, data);
481 * Finally, clean up the AVL tree.
483 if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL)
486 while ((node = uu_avl_walk_next(walk)) != NULL) {
487 uu_avl_remove(cb.cb_avl, node);
488 zfs_close(node->zn_handle);
492 uu_avl_walk_end(walk);
493 uu_avl_destroy(cb.cb_avl);
494 uu_avl_pool_destroy(avl_pool);