xref: /titanic_41/usr/src/lib/libzfs/common/libzfs_impl.h (revision 675fc291908baceb17f92b0b6d961439aaddafc9)
1 /*
2  * CDDL HEADER SART
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
25  */
26 
27 #ifndef	_LIBZFS_IMPL_H
28 #define	_LIBZFS_IMPL_H
29 
30 #include <sys/fs/zfs.h>
31 #include <sys/spa.h>
32 #include <sys/nvpair.h>
33 #include <sys/dmu.h>
34 #include <sys/zfs_ioctl.h>
35 
36 #include <libuutil.h>
37 #include <libzfs.h>
38 #include <libshare.h>
39 #include <libzfs_core.h>
40 
41 #include <fm/libtopo.h>
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 #ifdef	VERIFY
48 #undef	VERIFY
49 #endif
50 #define	VERIFY	verify
51 
52 typedef struct libzfs_fru {
53 	char *zf_device;
54 	char *zf_fru;
55 	struct libzfs_fru *zf_chain;
56 	struct libzfs_fru *zf_next;
57 } libzfs_fru_t;
58 
59 struct libzfs_handle {
60 	int libzfs_error;
61 	int libzfs_fd;
62 	FILE *libzfs_mnttab;
63 	FILE *libzfs_sharetab;
64 	zpool_handle_t *libzfs_pool_handles;
65 	uu_avl_pool_t *libzfs_ns_avlpool;
66 	uu_avl_t *libzfs_ns_avl;
67 	uint64_t libzfs_ns_gen;
68 	int libzfs_desc_active;
69 	char libzfs_action[1024];
70 	char libzfs_desc[1024];
71 	int libzfs_printerr;
72 	int libzfs_storeerr; /* stuff error messages into buffer */
73 	void *libzfs_sharehdl; /* libshare handle */
74 	uint_t libzfs_shareflags;
75 	boolean_t libzfs_mnttab_enable;
76 	avl_tree_t libzfs_mnttab_cache;
77 	int libzfs_pool_iter;
78 	topo_hdl_t *libzfs_topo_hdl;
79 	libzfs_fru_t **libzfs_fru_hash;
80 	libzfs_fru_t *libzfs_fru_list;
81 	char libzfs_chassis_id[256];
82 };
83 
84 #define	ZFSSHARE_MISS	0x01	/* Didn't find entry in cache */
85 
86 struct zfs_handle {
87 	libzfs_handle_t *zfs_hdl;
88 	zpool_handle_t *zpool_hdl;
89 	char zfs_name[ZFS_MAX_DATASET_NAME_LEN];
90 	zfs_type_t zfs_type; /* type including snapshot */
91 	zfs_type_t zfs_head_type; /* type excluding snapshot */
92 	dmu_objset_stats_t zfs_dmustats;
93 	nvlist_t *zfs_props;
94 	nvlist_t *zfs_user_props;
95 	nvlist_t *zfs_recvd_props;
96 	boolean_t zfs_mntcheck;
97 	char *zfs_mntopts;
98 	uint8_t *zfs_props_table;
99 };
100 
101 /*
102  * This is different from checking zfs_type, because it will also catch
103  * snapshots of volumes.
104  */
105 #define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
106 
107 struct zpool_handle {
108 	libzfs_handle_t *zpool_hdl;
109 	zpool_handle_t *zpool_next;
110 	char zpool_name[ZFS_MAX_DATASET_NAME_LEN];
111 	int zpool_state;
112 	size_t zpool_config_size;
113 	nvlist_t *zpool_config;
114 	nvlist_t *zpool_old_config;
115 	nvlist_t *zpool_props;
116 	diskaddr_t zpool_start_block;
117 };
118 
119 typedef enum {
120 	PROTO_NFS = 0,
121 	PROTO_SMB = 1,
122 	PROTO_END = 2
123 } zfs_share_proto_t;
124 
125 /*
126  * The following can be used as a bitmask and any new values
127  * added must preserve that capability.
128  */
129 typedef enum {
130 	SHARED_NOT_SHARED = 0x0,
131 	SHARED_NFS = 0x2,
132 	SHARED_SMB = 0x4
133 } zfs_share_type_t;
134 
135 int zfs_error(libzfs_handle_t *, int, const char *);
136 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
137 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
138 void *zfs_alloc(libzfs_handle_t *, size_t);
139 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
140 char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
141 char *zfs_strdup(libzfs_handle_t *, const char *);
142 int no_memory(libzfs_handle_t *);
143 
144 int zfs_standard_error(libzfs_handle_t *, int, const char *);
145 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
146 int zpool_standard_error(libzfs_handle_t *, int, const char *);
147 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
148 
149 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
150     size_t *);
151 zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
152 
153 
154 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
155     nvlist_t *, char **, uint64_t *, const char *);
156 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
157     zfs_type_t type);
158 
159 /*
160  * Use this changelist_gather() flag to force attempting mounts
161  * on each change node regardless of whether or not it is currently
162  * mounted.
163  */
164 #define	CL_GATHER_MOUNT_ALWAYS	1
165 
166 typedef struct prop_changelist prop_changelist_t;
167 
168 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
169 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
170 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
171 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
172 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
173 void zcmd_free_nvlists(zfs_cmd_t *);
174 
175 int changelist_prefix(prop_changelist_t *);
176 int changelist_postfix(prop_changelist_t *);
177 void changelist_rename(prop_changelist_t *, const char *, const char *);
178 void changelist_remove(prop_changelist_t *, const char *);
179 void changelist_free(prop_changelist_t *);
180 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
181 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
182 int changelist_haszonedchild(prop_changelist_t *);
183 
184 void remove_mountpoint(zfs_handle_t *);
185 int create_parents(libzfs_handle_t *, char *, int);
186 boolean_t isa_child_of(const char *dataset, const char *parent);
187 
188 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
189 zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
190     nvlist_t *props);
191 
192 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
193 
194 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
195 
196 int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
197     boolean_t modifying);
198 
199 void namespace_clear(libzfs_handle_t *);
200 
201 /*
202  * libshare (sharemgr) interfaces used internally.
203  */
204 
205 extern int zfs_init_libshare(libzfs_handle_t *, int);
206 extern void zfs_uninit_libshare(libzfs_handle_t *);
207 extern int zfs_parse_options(char *, zfs_share_proto_t);
208 
209 extern int zfs_unshare_proto(zfs_handle_t *,
210     const char *, zfs_share_proto_t *);
211 
212 extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t);
213 
214 #ifdef	__cplusplus
215 }
216 #endif
217 
218 #endif	/* _LIBZFS_IMPL_H */
219