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