zfs_iter.h revision 219089
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 2009 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
30extern "C" {
31#endif
32
33typedef 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#define	ZFS_ITER_DEPTH_LIMIT	   (1 << 3)
45#define	ZFS_ITER_RECVD_PROPS	   (1 << 4)
46
47int zfs_for_each(int, char **, int options, zfs_type_t,
48    zfs_sort_column_t *, zprop_list_t **, int, zfs_iter_f, void *);
49int zfs_add_sort_column(zfs_sort_column_t **, const char *, boolean_t);
50void zfs_free_sort_columns(zfs_sort_column_t *);
51
52#ifdef	__cplusplus
53}
54#endif
55
56#endif	/* ZFS_ITER_H */
57