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]
22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2012 Pawel Jakub Dawidek <pawel@dawidek.net>.
24 * All rights reserved.
40 * This is a private interface used to gather up all the datasets specified on
41 * the command line so that we can iterate over them in order.
43 * First, we iterate over all filesystems, gathering them together into an
44 * AVL tree. We report errors for any explicitly specified datasets
45 * that we couldn't open.
47 * When finished, we have an AVL tree of ZFS handles. We go through and execute
48 * the provided callback for each one, passing whatever data the user supplied.
51 typedef struct zfs_node {
52 zfs_handle_t *zn_handle;
53 uu_avl_node_t zn_avlnode;
56 typedef struct callback_data {
60 zfs_sort_column_t *cb_sortcol;
61 zprop_list_t **cb_proplist;
64 uint8_t cb_props_table[ZFS_NUM_PROPS];
67 uu_avl_pool_t *avl_pool;
70 * Include snaps if they were requested or if this a zfs list where types
71 * were not specified and the "listsnapshots" property is set on this pool.
74 zfs_include_snapshots(zfs_handle_t *zhp, callback_data_t *cb)
78 if ((cb->cb_flags & ZFS_ITER_PROP_LISTSNAPS) == 0)
79 return (cb->cb_types & ZFS_TYPE_SNAPSHOT);
81 zph = zfs_get_pool_handle(zhp);
82 return (zpool_get_prop_int(zph, ZPOOL_PROP_LISTSNAPS, NULL));
86 * Called for each dataset. If the object is of an appropriate type,
87 * add it to the avl tree and recurse over any children as necessary.
90 zfs_callback(zfs_handle_t *zhp, void *data)
92 callback_data_t *cb = data;
94 int include_snaps = zfs_include_snapshots(zhp, cb);
96 if ((zfs_get_type(zhp) & cb->cb_types) ||
97 ((zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT) && include_snaps)) {
99 zfs_node_t *node = safe_malloc(sizeof (zfs_node_t));
101 node->zn_handle = zhp;
102 uu_avl_node_init(node, &node->zn_avlnode, avl_pool);
103 if (uu_avl_find(cb->cb_avl, node, cb->cb_sortcol,
105 if (cb->cb_proplist) {
106 if ((*cb->cb_proplist) &&
107 !(*cb->cb_proplist)->pl_all)
108 zfs_prune_proplist(zhp,
111 if (zfs_expand_proplist(zhp, cb->cb_proplist,
112 (cb->cb_flags & ZFS_ITER_RECVD_PROPS))
118 uu_avl_insert(cb->cb_avl, node, idx);
126 * Recurse if necessary.
128 if (cb->cb_flags & ZFS_ITER_RECURSE &&
129 ((cb->cb_flags & ZFS_ITER_DEPTH_LIMIT) == 0 ||
130 cb->cb_depth < cb->cb_depth_limit)) {
132 if (zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM)
133 (void) zfs_iter_filesystems(zhp, zfs_callback, data);
134 if ((zfs_get_type(zhp) != ZFS_TYPE_SNAPSHOT) && include_snaps) {
135 (void) zfs_iter_snapshots(zhp,
136 (cb->cb_flags & ZFS_ITER_SIMPLE) != 0, zfs_callback,
149 zfs_add_sort_column(zfs_sort_column_t **sc, const char *name,
152 zfs_sort_column_t *col;
155 if ((prop = zfs_name_to_prop(name)) == ZPROP_INVAL &&
156 !zfs_prop_user(name))
159 col = safe_malloc(sizeof (zfs_sort_column_t));
162 col->sc_reverse = reverse;
163 if (prop == ZPROP_INVAL) {
164 col->sc_user_prop = safe_malloc(strlen(name) + 1);
165 (void) strcpy(col->sc_user_prop, name);
172 (*sc)->sc_last->sc_next = col;
173 (*sc)->sc_last = col;
180 zfs_free_sort_columns(zfs_sort_column_t *sc)
182 zfs_sort_column_t *col;
186 free(sc->sc_user_prop);
193 zfs_sort_only_by_name(const zfs_sort_column_t *sc)
196 return (sc != NULL && sc->sc_next == NULL &&
197 sc->sc_prop == ZFS_PROP_NAME);
202 zfs_compare(const void *larg, const void *rarg, void *unused)
204 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
205 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
206 const char *lname = zfs_get_name(l);
207 const char *rname = zfs_get_name(r);
209 uint64_t lcreate, rcreate;
212 lat = (char *)strchr(lname, '@');
213 rat = (char *)strchr(rname, '@');
220 ret = strcmp(lname, rname);
223 * If we're comparing a dataset to one of its snapshots, we
224 * always make the full dataset first.
228 } else if (rat == NULL) {
232 * If we have two snapshots from the same dataset, then
233 * we want to sort them according to creation time. We
234 * use the hidden CREATETXG property to get an absolute
235 * ordering of snapshots.
237 lcreate = zfs_prop_get_int(l, ZFS_PROP_CREATETXG);
238 rcreate = zfs_prop_get_int(r, ZFS_PROP_CREATETXG);
241 * Both lcreate and rcreate being 0 means we don't have
242 * properties and we should compare full name.
244 if (lcreate == 0 && rcreate == 0)
245 ret = strcmp(lat + 1, rat + 1);
246 else if (lcreate < rcreate)
248 else if (lcreate > rcreate)
262 * Sort datasets by specified columns.
264 * o Numeric types sort in ascending order.
265 * o String types sort in alphabetical order.
266 * o Types inappropriate for a row sort that row to the literal
267 * bottom, regardless of the specified ordering.
269 * If no sort columns are specified, or two datasets compare equally
270 * across all specified columns, they are sorted alphabetically by name
271 * with snapshots grouped under their parents.
274 zfs_sort(const void *larg, const void *rarg, void *data)
276 zfs_handle_t *l = ((zfs_node_t *)larg)->zn_handle;
277 zfs_handle_t *r = ((zfs_node_t *)rarg)->zn_handle;
278 zfs_sort_column_t *sc = (zfs_sort_column_t *)data;
279 zfs_sort_column_t *psc;
281 for (psc = sc; psc != NULL; psc = psc->sc_next) {
282 char lbuf[ZFS_MAXPROPLEN], rbuf[ZFS_MAXPROPLEN];
285 boolean_t lvalid, rvalid;
289 * We group the checks below the generic code. If 'lstr' and
290 * 'rstr' are non-NULL, then we do a string based comparison.
291 * Otherwise, we compare 'lnum' and 'rnum'.
294 if (psc->sc_prop == ZPROP_INVAL) {
295 nvlist_t *luser, *ruser;
296 nvlist_t *lval, *rval;
298 luser = zfs_get_user_props(l);
299 ruser = zfs_get_user_props(r);
301 lvalid = (nvlist_lookup_nvlist(luser,
302 psc->sc_user_prop, &lval) == 0);
303 rvalid = (nvlist_lookup_nvlist(ruser,
304 psc->sc_user_prop, &rval) == 0);
307 verify(nvlist_lookup_string(lval,
308 ZPROP_VALUE, &lstr) == 0);
310 verify(nvlist_lookup_string(rval,
311 ZPROP_VALUE, &rstr) == 0);
312 } else if (psc->sc_prop == ZFS_PROP_NAME) {
313 lvalid = rvalid = B_TRUE;
315 (void) strlcpy(lbuf, zfs_get_name(l), sizeof(lbuf));
316 (void) strlcpy(rbuf, zfs_get_name(r), sizeof(rbuf));
320 } else if (zfs_prop_is_string(psc->sc_prop)) {
321 lvalid = (zfs_prop_get(l, psc->sc_prop, lbuf,
322 sizeof (lbuf), NULL, NULL, 0, B_TRUE) == 0);
323 rvalid = (zfs_prop_get(r, psc->sc_prop, rbuf,
324 sizeof (rbuf), NULL, NULL, 0, B_TRUE) == 0);
329 lvalid = zfs_prop_valid_for_type(psc->sc_prop,
331 rvalid = zfs_prop_valid_for_type(psc->sc_prop,
335 (void) zfs_prop_get_numeric(l, psc->sc_prop,
336 &lnum, NULL, NULL, 0);
338 (void) zfs_prop_get_numeric(r, psc->sc_prop,
339 &rnum, NULL, NULL, 0);
342 if (!lvalid && !rvalid)
350 ret = strcmp(lstr, rstr);
351 else if (lnum < rnum)
353 else if (lnum > rnum)
357 if (psc->sc_reverse == B_TRUE)
358 ret = (ret < 0) ? 1 : -1;
363 return (zfs_compare(larg, rarg, NULL));
367 zfs_for_each(int argc, char **argv, int flags, zfs_type_t types,
368 zfs_sort_column_t *sortcol, zprop_list_t **proplist, int limit,
369 zfs_iter_f callback, void *data)
371 callback_data_t cb = {0};
376 avl_pool = uu_avl_pool_create("zfs_pool", sizeof (zfs_node_t),
377 offsetof(zfs_node_t, zn_avlnode), zfs_sort, UU_DEFAULT);
379 if (avl_pool == NULL)
382 cb.cb_sortcol = sortcol;
384 cb.cb_proplist = proplist;
386 cb.cb_depth_limit = limit;
388 * If cb_proplist is provided then in the zfs_handles created we
389 * retain only those properties listed in cb_proplist and sortcol.
390 * The rest are pruned. So, the caller should make sure that no other
391 * properties other than those listed in cb_proplist/sortcol are
394 * If cb_proplist is NULL then we retain all the properties. We
395 * always retain the zoned property, which some other properties
396 * need (userquota & friends), and the createtxg property, which
397 * we need to sort snapshots.
399 if (cb.cb_proplist && *cb.cb_proplist) {
400 zprop_list_t *p = *cb.cb_proplist;
403 if (p->pl_prop >= ZFS_PROP_TYPE &&
404 p->pl_prop < ZFS_NUM_PROPS) {
405 cb.cb_props_table[p->pl_prop] = B_TRUE;
411 if (sortcol->sc_prop >= ZFS_PROP_TYPE &&
412 sortcol->sc_prop < ZFS_NUM_PROPS) {
413 cb.cb_props_table[sortcol->sc_prop] = B_TRUE;
415 sortcol = sortcol->sc_next;
418 cb.cb_props_table[ZFS_PROP_ZONED] = B_TRUE;
419 cb.cb_props_table[ZFS_PROP_CREATETXG] = B_TRUE;
421 (void) memset(cb.cb_props_table, B_TRUE,
422 sizeof (cb.cb_props_table));
425 if ((cb.cb_avl = uu_avl_create(avl_pool, NULL, UU_DEFAULT)) == NULL)
430 * If given no arguments, iterate over all datasets.
432 cb.cb_flags |= ZFS_ITER_RECURSE;
433 ret = zfs_iter_root(g_zfs, zfs_callback, &cb);
440 * If we're recursive, then we always allow filesystems as
441 * arguments. If we also are interested in snapshots, then we
442 * can take volumes as well.
445 if (flags & ZFS_ITER_RECURSE) {
446 argtype |= ZFS_TYPE_FILESYSTEM;
447 if (types & ZFS_TYPE_SNAPSHOT)
448 argtype |= ZFS_TYPE_VOLUME;
451 for (i = 0; i < argc; i++) {
452 if (flags & ZFS_ITER_ARGS_CAN_BE_PATHS) {
453 zhp = zfs_path_to_zhandle(g_zfs, argv[i],
456 zhp = zfs_open(g_zfs, argv[i], argtype);
459 ret |= zfs_callback(zhp, &cb);
466 * At this point we've got our AVL tree full of zfs handles, so iterate
467 * over each one and execute the real user callback.
469 for (node = uu_avl_first(cb.cb_avl); node != NULL;
470 node = uu_avl_next(cb.cb_avl, node))
471 ret |= callback(node->zn_handle, data);
474 * Finally, clean up the AVL tree.
476 if ((walk = uu_avl_walk_start(cb.cb_avl, UU_WALK_ROBUST)) == NULL)
479 while ((node = uu_avl_walk_next(walk)) != NULL) {
480 uu_avl_remove(cb.cb_avl, node);
481 zfs_close(node->zn_handle);
485 uu_avl_walk_end(walk);
486 uu_avl_destroy(cb.cb_avl);
487 uu_avl_pool_destroy(avl_pool);