xref: /illumos-gate/usr/src/cmd/zfs/zfs_iter.h (revision 4c28a617e3922d92a58e813a5b955eb526b9c386)
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 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  * Copyright (c) 2011-2012 Pawel Jakub Dawidek. All rights reserved.
26  * Copyright 2013 Nexenta Systems, Inc.  All rights reserved.
27  */
28 
29 #ifndef	ZFS_ITER_H
30 #define	ZFS_ITER_H
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 typedef struct zfs_sort_column {
37 	struct zfs_sort_column	*sc_next;
38 	struct zfs_sort_column	*sc_last;
39 	zfs_prop_t		sc_prop;
40 	char			*sc_user_prop;
41 	boolean_t		sc_reverse;
42 } zfs_sort_column_t;
43 
44 #define	ZFS_ITER_RECURSE	   (1 << 0)
45 #define	ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1)
46 #define	ZFS_ITER_PROP_LISTSNAPS    (1 << 2)
47 #define	ZFS_ITER_DEPTH_LIMIT	   (1 << 3)
48 #define	ZFS_ITER_RECVD_PROPS	   (1 << 4)
49 #define	ZFS_ITER_SIMPLE		   (1 << 5)
50 #define	ZFS_ITER_LITERAL_PROPS	   (1 << 6)
51 
52 int zfs_for_each(int, char **, int options, zfs_type_t,
53     zfs_sort_column_t *, zprop_list_t **, int, zfs_iter_f, void *);
54 int zfs_add_sort_column(zfs_sort_column_t **, const char *, boolean_t);
55 void zfs_free_sort_columns(zfs_sort_column_t *);
56 boolean_t zfs_sort_only_by_name(const zfs_sort_column_t *);
57 
58 #ifdef	__cplusplus
59 }
60 #endif
61 
62 #endif	/* ZFS_ITER_H */
63