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 Pawel Jakub Dawidek. All rights reserved.
25 * Copyright (c) 2011, 2017 by Delphix. All rights reserved.
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/spa.h>
34#include <sys/nvpair.h>
35#include <sys/dmu.h>
36#include <sys/zfs_ioctl.h>
37#include <synch.h>
38#include <regex.h>
39
40#include <libuutil.h>
41#include <libzfs.h>
42#include <libshare.h>
43#include <libzfs_core.h>
44#include <libdevinfo.h>
45
46#include <fm/libtopo.h>
47
48#ifdef	__cplusplus
49extern "C" {
50#endif
51
52#ifdef	VERIFY
53#undef	VERIFY
54#endif
55#define	VERIFY	verify
56
57typedef struct libzfs_fru {
58	char *zf_device;
59	char *zf_fru;
60	struct libzfs_fru *zf_chain;
61	struct libzfs_fru *zf_next;
62} libzfs_fru_t;
63
64struct libzfs_handle {
65	int libzfs_error;
66	int libzfs_fd;
67	FILE *libzfs_mnttab;
68	FILE *libzfs_sharetab;
69	zpool_handle_t *libzfs_pool_handles;
70	uu_avl_pool_t *libzfs_ns_avlpool;
71	uu_avl_t *libzfs_ns_avl;
72	uint64_t libzfs_ns_gen;
73	int libzfs_desc_active;
74	char libzfs_action[1024];
75	char libzfs_desc[1024];
76	int libzfs_printerr;
77	int libzfs_storeerr; /* stuff error messages into buffer */
78	void *libzfs_sharehdl; /* libshare handle */
79	boolean_t libzfs_mnttab_enable;
80	/*
81	 * We need a lock to handle the case where parallel mount
82	 * threads are populating the mnttab cache simultaneously. The
83	 * lock only protects the integrity of the avl tree, and does
84	 * not protect the contents of the mnttab entries themselves.
85	 */
86	mutex_t libzfs_mnttab_cache_lock;
87	avl_tree_t libzfs_mnttab_cache;
88	int libzfs_pool_iter;
89	topo_hdl_t *libzfs_topo_hdl;
90	libzfs_fru_t **libzfs_fru_hash;
91	libzfs_fru_t *libzfs_fru_list;
92	char libzfs_chassis_id[256];
93	boolean_t libzfs_prop_debug;
94	di_devlink_handle_t libzfs_devlink;
95	regex_t libzfs_urire;
96};
97
98struct zfs_handle {
99	libzfs_handle_t *zfs_hdl;
100	zpool_handle_t *zpool_hdl;
101	char zfs_name[ZFS_MAX_DATASET_NAME_LEN];
102	zfs_type_t zfs_type; /* type including snapshot */
103	zfs_type_t zfs_head_type; /* type excluding snapshot */
104	dmu_objset_stats_t zfs_dmustats;
105	nvlist_t *zfs_props;
106	nvlist_t *zfs_user_props;
107	nvlist_t *zfs_recvd_props;
108	boolean_t zfs_mntcheck;
109	char *zfs_mntopts;
110	uint8_t *zfs_props_table;
111};
112
113/*
114 * This is different from checking zfs_type, because it will also catch
115 * snapshots of volumes.
116 */
117#define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
118
119struct zpool_handle {
120	libzfs_handle_t *zpool_hdl;
121	zpool_handle_t *zpool_next;
122	char zpool_name[ZFS_MAX_DATASET_NAME_LEN];
123	int zpool_state;
124	size_t zpool_config_size;
125	nvlist_t *zpool_config;
126	nvlist_t *zpool_old_config;
127	nvlist_t *zpool_props;
128	diskaddr_t zpool_start_block;
129};
130
131typedef enum {
132	PROTO_NFS = 0,
133	PROTO_SMB = 1,
134	PROTO_END = 2
135} zfs_share_proto_t;
136
137/*
138 * The following can be used as a bitmask and any new values
139 * added must preserve that capability.
140 */
141typedef enum {
142	SHARED_NOT_SHARED = 0x0,
143	SHARED_NFS = 0x2,
144	SHARED_SMB = 0x4
145} zfs_share_type_t;
146
147
148/*
149 * From RFC3986 Appendix B. The regex is a bit of a beast, but with an
150 * example URI of:
151 *
152 * http://www.ics.uci.edu/pub/ietf/uri/#Related
153 *
154 * URI_REGEX should match with the following subexpressions:
155 *
156 * $1 = http:
157 * $2 = http
158 * $3 = //www.ics.uci.edu
159 * $4 = www.ics.uci.edu
160 * $5 = /pub/ietf/uri/
161 * $6 = <undefined>
162 * $7 = <undefined>
163 * $8 = #Related
164 * $9 = Related
165 *
166 * More generally:
167 *
168 * scheme    = $2
169 * authority = $4
170 * path      = $5
171 * query     = $7
172 * fragment  = $9
173 *
174 * We only care about the value of the scheme component ($2) in order to
175 * invoke the correct handler. Each handler should do any additional URI
176 * validation as required.
177 */
178#define	URI_REGEX \
179	"^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?"
180#define	URI_NMATCH		10	/* whole URI match ($0) + 9 subexps */
181#define	URI_SCHEMESUBEXP	2	/* '$2' */
182
183typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *,
184    const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *);
185
186typedef struct zfs_uri_handler {
187	const char *zuh_scheme;
188	zfs_uri_handler_fn_t zuh_handler;
189} zfs_uri_handler_t;
190
191#define	CONFIG_BUF_MINSIZE	262144
192
193int zfs_error(libzfs_handle_t *, int, const char *);
194int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
195void zfs_error_aux(libzfs_handle_t *, const char *, ...);
196void *zfs_alloc(libzfs_handle_t *, size_t);
197void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
198char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
199char *zfs_strdup(libzfs_handle_t *, const char *);
200int no_memory(libzfs_handle_t *);
201
202int zfs_standard_error(libzfs_handle_t *, int, const char *);
203int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
204int zpool_standard_error(libzfs_handle_t *, int, const char *);
205int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
206
207int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
208    size_t *);
209zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
210zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
211
212int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
213    nvlist_t *, char **, uint64_t *, const char *);
214int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
215    zfs_type_t type);
216
217/*
218 * Use this changelist_gather() flag to force attempting mounts
219 * on each change node regardless of whether or not it is currently
220 * mounted.
221 */
222#define	CL_GATHER_MOUNT_ALWAYS	1
223
224typedef struct prop_changelist prop_changelist_t;
225
226int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
227int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
228int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
229int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
230int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
231void zcmd_free_nvlists(zfs_cmd_t *);
232
233int changelist_prefix(prop_changelist_t *);
234int changelist_postfix(prop_changelist_t *);
235void changelist_rename(prop_changelist_t *, const char *, const char *);
236void changelist_remove(prop_changelist_t *, const char *);
237void changelist_free(prop_changelist_t *);
238prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
239int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
240int changelist_haszonedchild(prop_changelist_t *);
241
242void remove_mountpoint(zfs_handle_t *);
243int create_parents(libzfs_handle_t *, char *, int);
244boolean_t isa_child_of(const char *dataset, const char *parent);
245
246zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
247zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
248    nvlist_t *props);
249
250int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
251
252boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
253
254int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
255    boolean_t modifying);
256
257void namespace_clear(libzfs_handle_t *);
258
259/*
260 * libshare (sharemgr) interfaces used internally.
261 */
262
263extern int zfs_init_libshare(libzfs_handle_t *, int);
264extern int zfs_parse_options(char *, zfs_share_proto_t);
265
266extern int zfs_unshare_proto(zfs_handle_t *,
267    const char *, zfs_share_proto_t *);
268
269extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t);
270
271#ifdef	__cplusplus
272}
273#endif
274
275#endif	/* _LIBZFS_IMPL_H */
276