xref: /illumos-gate/usr/src/cmd/zfs/zfs_iter.h (revision 8b80e8cb6855118d46f605e91b5ed4ce83417395)
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  * Copyright 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	ZFS_ITER_H
27 #define	ZFS_ITER_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 typedef struct zfs_sort_column {
34 	struct zfs_sort_column	*sc_next;
35 	struct zfs_sort_column	*sc_last;
36 	zfs_prop_t		sc_prop;
37 	char			*sc_user_prop;
38 	boolean_t		sc_reverse;
39 } zfs_sort_column_t;
40 
41 #define	ZFS_ITER_RECURSE	   (1 << 0)
42 #define	ZFS_ITER_ARGS_CAN_BE_PATHS (1 << 1)
43 #define	ZFS_ITER_PROP_LISTSNAPS    (1 << 2)
44 
45 int zfs_for_each(int, char **, int options, zfs_type_t,
46     zfs_sort_column_t *, zprop_list_t **, zfs_iter_f, void *);
47 int zfs_add_sort_column(zfs_sort_column_t **, const char *, boolean_t);
48 void zfs_free_sort_columns(zfs_sort_column_t *);
49 
50 #ifdef	__cplusplus
51 }
52 #endif
53 
54 #endif	/* ZFS_ITER_H */
55