xref: /freebsd/sys/contrib/openzfs/lib/libzfs/libzfs_impl.h (revision cc1a53bc1aea0675d64e9547cdca241612906592)
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Copyright (c) 2011, 2020 by Delphix. All rights reserved.
25  * Copyright (c) 2018 Datto Inc.
26  * Copyright 2020 Joyent, Inc.
27  */
28 
29 #ifndef	_LIBZFS_IMPL_H
30 #define	_LIBZFS_IMPL_H
31 
32 #include <sys/fs/zfs.h>
33 #include <sys/nvpair.h>
34 #include <sys/dmu.h>
35 #include <sys/zfs_ioctl.h>
36 #include <regex.h>
37 
38 #include <libuutil.h>
39 #include <libzfs.h>
40 #include <libshare.h>
41 #include <libzfs_core.h>
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 struct libzfs_handle {
48 	int libzfs_error;
49 	int libzfs_fd;
50 	zpool_handle_t *libzfs_pool_handles;
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 	boolean_t libzfs_mnttab_enable;
59 	/*
60 	 * We need a lock to handle the case where parallel mount
61 	 * threads are populating the mnttab cache simultaneously. The
62 	 * lock only protects the integrity of the avl tree, and does
63 	 * not protect the contents of the mnttab entries themselves.
64 	 */
65 	pthread_mutex_t libzfs_mnttab_cache_lock;
66 	avl_tree_t libzfs_mnttab_cache;
67 	int libzfs_pool_iter;
68 	boolean_t libzfs_prop_debug;
69 	regex_t libzfs_urire;
70 	uint64_t libzfs_max_nvlist;
71 	void *libfetch;
72 	char *libfetch_load_error;
73 };
74 
75 struct zfs_handle {
76 	libzfs_handle_t *zfs_hdl;
77 	zpool_handle_t *zpool_hdl;
78 	char zfs_name[ZFS_MAX_DATASET_NAME_LEN];
79 	zfs_type_t zfs_type; /* type including snapshot */
80 	zfs_type_t zfs_head_type; /* type excluding snapshot */
81 	dmu_objset_stats_t zfs_dmustats;
82 	nvlist_t *zfs_props;
83 	nvlist_t *zfs_user_props;
84 	nvlist_t *zfs_recvd_props;
85 	boolean_t zfs_mntcheck;
86 	char *zfs_mntopts;
87 	uint8_t *zfs_props_table;
88 };
89 
90 /*
91  * This is different from checking zfs_type, because it will also catch
92  * snapshots of volumes.
93  */
94 #define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
95 
96 struct zpool_handle {
97 	libzfs_handle_t *zpool_hdl;
98 	zpool_handle_t *zpool_next;
99 	char zpool_name[ZFS_MAX_DATASET_NAME_LEN];
100 	int zpool_state;
101 	size_t zpool_config_size;
102 	nvlist_t *zpool_config;
103 	nvlist_t *zpool_old_config;
104 	nvlist_t *zpool_props;
105 	diskaddr_t zpool_start_block;
106 };
107 
108 typedef enum {
109 	PROTO_NFS = 0,
110 	PROTO_SMB = 1,
111 	PROTO_END = 2
112 } zfs_share_proto_t;
113 
114 /*
115  * The following can be used as a bitmask and any new values
116  * added must preserve that capability.
117  */
118 typedef enum {
119 	SHARED_NOT_SHARED = 0x0,
120 	SHARED_NFS = 0x2,
121 	SHARED_SMB = 0x4
122 } zfs_share_type_t;
123 
124 typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *,
125     const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *);
126 
127 typedef struct zfs_uri_handler {
128 	const char *zuh_scheme;
129 	zfs_uri_handler_fn_t zuh_handler;
130 } zfs_uri_handler_t;
131 
132 #define	CONFIG_BUF_MINSIZE	262144
133 
134 extern int zfs_error(libzfs_handle_t *, int, const char *);
135 extern int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...)
136     __attribute__((format(printf, 3, 4)));
137 extern void zfs_error_aux(libzfs_handle_t *, const char *, ...)
138     __attribute__((format(printf, 2, 3)));
139 extern void *zfs_alloc(libzfs_handle_t *, size_t);
140 extern void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
141 extern char *zfs_asprintf(libzfs_handle_t *, const char *, ...)
142     __attribute__((format(printf, 2, 3)));
143 extern char *zfs_strdup(libzfs_handle_t *, const char *);
144 extern int no_memory(libzfs_handle_t *);
145 
146 extern int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...)
147     __attribute__((format(printf, 3, 4)));
148 extern void zfs_setprop_error(libzfs_handle_t *, zfs_prop_t, int, char *);
149 extern int zpool_standard_error(libzfs_handle_t *, int, const char *);
150 extern int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...)
151     __attribute__((format(printf, 3, 4)));
152 
153 extern zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
154 extern zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
155 
156 extern int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
157     nvlist_t *, char **, uint64_t *, const char *);
158 extern int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
159     zfs_type_t type);
160 
161 /*
162  * Use this changelist_gather() flag to force attempting mounts
163  * on each change node regardless of whether or not it is currently
164  * mounted.
165  */
166 #define	CL_GATHER_MOUNT_ALWAYS	1
167 /*
168  * changelist_gather() flag to force it to iterate on mounted datasets only
169  */
170 #define	CL_GATHER_ITER_MOUNTED	2
171 /*
172  * Use this changelist_gather() flag to prevent unmounting of file systems.
173  */
174 #define	CL_GATHER_DONT_UNMOUNT	4
175 
176 typedef struct prop_changelist prop_changelist_t;
177 
178 extern int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
179 extern int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
180 extern int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
181 extern int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
182 extern int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
183 extern void zcmd_free_nvlists(zfs_cmd_t *);
184 
185 extern int changelist_prefix(prop_changelist_t *);
186 extern int changelist_postfix(prop_changelist_t *);
187 extern void changelist_rename(prop_changelist_t *, const char *, const char *);
188 extern void changelist_remove(prop_changelist_t *, const char *);
189 extern void changelist_free(prop_changelist_t *);
190 extern prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int,
191     int);
192 extern int changelist_unshare(prop_changelist_t *, const zfs_share_proto_t *);
193 extern int changelist_haszonedchild(prop_changelist_t *);
194 
195 extern void remove_mountpoint(zfs_handle_t *);
196 extern int create_parents(libzfs_handle_t *, char *, int);
197 
198 extern zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
199 extern zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
200     nvlist_t *props);
201 
202 extern int zpool_open_silent(libzfs_handle_t *, const char *,
203     zpool_handle_t **);
204 
205 extern boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
206 
207 extern int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
208     boolean_t modifying);
209 
210 extern void namespace_clear(libzfs_handle_t *);
211 
212 extern int zfs_parse_options(char *, zfs_share_proto_t);
213 
214 typedef struct {
215 	zfs_prop_t p_prop;
216 	char *p_name;
217 	int p_share_err;
218 	int p_unshare_err;
219 } proto_table_t;
220 
221 typedef struct differ_info {
222 	zfs_handle_t *zhp;
223 	char *fromsnap;
224 	char *frommnt;
225 	char *tosnap;
226 	char *tomnt;
227 	char *ds;
228 	char *dsmnt;
229 	char *tmpsnap;
230 	char errbuf[1024];
231 	boolean_t isclone;
232 	boolean_t scripted;
233 	boolean_t classify;
234 	boolean_t timestamped;
235 	boolean_t no_mangle;
236 	uint64_t shares;
237 	int zerr;
238 	int cleanupfd;
239 	int outputfd;
240 	int datafd;
241 } differ_info_t;
242 
243 extern int do_mount(zfs_handle_t *zhp, const char *mntpt, char *opts,
244     int flags);
245 extern int do_unmount(zfs_handle_t *zhp, const char *mntpt, int flags);
246 extern int zfs_mount_delegation_check(void);
247 extern int zfs_share_proto(zfs_handle_t *zhp, const zfs_share_proto_t *proto);
248 extern int zfs_unshare_proto(zfs_handle_t *, const char *,
249     const zfs_share_proto_t *);
250 extern int unshare_one(libzfs_handle_t *hdl, const char *name,
251     const char *mountpoint, zfs_share_proto_t proto);
252 extern boolean_t zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
253     zprop_source_t *source, int flags);
254 extern zfs_share_type_t is_shared(const char *mountpoint,
255     zfs_share_proto_t proto);
256 extern int libzfs_load_module(void);
257 extern int zpool_relabel_disk(libzfs_handle_t *hdl, const char *path,
258     const char *msg);
259 extern int find_shares_object(differ_info_t *di);
260 extern void zfs_commit_proto(const zfs_share_proto_t *);
261 
262 #ifdef	__cplusplus
263 }
264 #endif
265 
266 #endif	/* _LIBZFS_IMPL_H */
267