xref: /titanic_51/usr/src/lib/libzfs/common/libzfs_impl.h (revision dfb96a4f56fb431b915bc67e5d9d5c8d4f4f6679)
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 2007 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_LIBFS_IMPL_H
28 #define	_LIBFS_IMPL_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/dmu.h>
33 #include <sys/fs/zfs.h>
34 #include <sys/zfs_ioctl.h>
35 #include <sys/zfs_acl.h>
36 #include <sys/nvpair.h>
37 
38 #include <libuutil.h>
39 #include <libzfs.h>
40 #include <libshare.h>
41 
42 #ifdef	__cplusplus
43 extern "C" {
44 #endif
45 
46 struct libzfs_handle {
47 	int libzfs_error;
48 	int libzfs_fd;
49 	FILE *libzfs_mnttab;
50 	FILE *libzfs_sharetab;
51 	uu_avl_pool_t *libzfs_ns_avlpool;
52 	uu_avl_t *libzfs_ns_avl;
53 	uint64_t libzfs_ns_gen;
54 	int libzfs_desc_active;
55 	char libzfs_action[1024];
56 	char libzfs_desc[1024];
57 	int libzfs_printerr;
58 	void *libzfs_sharehdl; /* libshare handle */
59 };
60 
61 struct zfs_handle {
62 	libzfs_handle_t *zfs_hdl;
63 	char zfs_name[ZFS_MAXNAMELEN];
64 	zfs_type_t zfs_type; /* type including snapshot */
65 	zfs_type_t zfs_head_type; /* type excluding snapshot */
66 	dmu_objset_stats_t zfs_dmustats;
67 	nvlist_t *zfs_props;
68 	nvlist_t *zfs_user_props;
69 	boolean_t zfs_mntcheck;
70 	char *zfs_mntopts;
71 	char zfs_root[MAXPATHLEN];
72 };
73 
74 /*
75  * This is different from checking zfs_type, because it will also catch
76  * snapshots of volumes.
77  */
78 #define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
79 
80 struct zpool_handle {
81 	libzfs_handle_t *zpool_hdl;
82 	char zpool_name[ZPOOL_MAXNAMELEN];
83 	int zpool_state;
84 	size_t zpool_config_size;
85 	nvlist_t *zpool_config;
86 	nvlist_t *zpool_old_config;
87 	nvlist_t *zpool_props;
88 	diskaddr_t zpool_start_block;
89 };
90 
91 int zfs_error(libzfs_handle_t *, int, const char *);
92 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
93 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
94 void *zfs_alloc(libzfs_handle_t *, size_t);
95 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
96 char *zfs_strdup(libzfs_handle_t *, const char *);
97 int no_memory(libzfs_handle_t *);
98 
99 int zfs_standard_error(libzfs_handle_t *, int, const char *);
100 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
101 int zpool_standard_error(libzfs_handle_t *, int, const char *);
102 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
103 
104 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
105     size_t *);
106 
107 int zfs_expand_proplist_common(libzfs_handle_t *, zfs_proplist_t **,
108     zfs_type_t);
109 int zfs_get_proplist_common(libzfs_handle_t *, char *, zfs_proplist_t **,
110     zfs_type_t);
111 zfs_prop_t zfs_prop_iter_common(zfs_prop_f, void *, zfs_type_t, boolean_t);
112 zfs_prop_t zfs_name_to_prop_common(const char *, zfs_type_t);
113 
114 nvlist_t *zfs_validate_properties(libzfs_handle_t *, zfs_type_t, char *,
115 	nvlist_t *, uint64_t, zfs_handle_t *zhp, const char *errbuf);
116 
117 typedef struct prop_changelist prop_changelist_t;
118 
119 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
120 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *, size_t *);
121 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
122 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
123 void zcmd_free_nvlists(zfs_cmd_t *);
124 
125 int changelist_prefix(prop_changelist_t *);
126 int changelist_postfix(prop_changelist_t *);
127 void changelist_rename(prop_changelist_t *, const char *, const char *);
128 void changelist_remove(zfs_handle_t *, prop_changelist_t *);
129 void changelist_free(prop_changelist_t *);
130 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int);
131 int changelist_unshare(prop_changelist_t *);
132 int changelist_haszonedchild(prop_changelist_t *);
133 
134 void remove_mountpoint(zfs_handle_t *);
135 
136 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
137 
138 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
139 
140 int zvol_create_link(libzfs_handle_t *, const char *);
141 int zvol_remove_link(libzfs_handle_t *, const char *);
142 int zpool_iter_zvol(zpool_handle_t *, int (*)(const char *, void *), void *);
143 
144 void namespace_clear(libzfs_handle_t *);
145 
146 /*
147  * libshare (sharemgr) interfaces used internally.
148  */
149 
150 extern int zfs_init_libshare(libzfs_handle_t *, int);
151 extern void zfs_uninit_libshare(libzfs_handle_t *);
152 extern int zfs_parse_options(char *, char *);
153 
154 #ifdef	__cplusplus
155 }
156 #endif
157 
158 #endif	/* _LIBFS_IMPL_H */
159