libzfs_impl.h revision 247540 
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 <pawel@dawidek.net>.
25 * All rights reserved.
26 * Copyright (c) 2011 by Delphix. All rights reserved.
27 * Copyright (c) 2013 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
28 */
29
30#ifndef	_LIBFS_IMPL_H
31#define	_LIBFS_IMPL_H
32
33#include <sys/dmu.h>
34#include <sys/fs/zfs.h>
35#include <sys/zfs_ioctl.h>
36#include <sys/spa.h>
37#include <sys/nvpair.h>
38
39#include <libshare.h>
40#include <libuutil.h>
41#include <libzfs.h>
42
43#include "zfs_ioctl_compat.h"
44
45#ifdef	__cplusplus
46extern "C" {
47#endif
48
49#ifdef	VERIFY
50#undef	VERIFY
51#endif
52#define	VERIFY	verify
53
54typedef struct libzfs_fru {
55	char *zf_device;
56	char *zf_fru;
57	struct libzfs_fru *zf_chain;
58	struct libzfs_fru *zf_next;
59} libzfs_fru_t;
60
61struct libzfs_handle {
62	int libzfs_error;
63	int libzfs_fd;
64	FILE *libzfs_mnttab;
65	FILE *libzfs_sharetab;
66	zpool_handle_t *libzfs_pool_handles;
67	uu_avl_pool_t *libzfs_ns_avlpool;
68	uu_avl_t *libzfs_ns_avl;
69	uint64_t libzfs_ns_gen;
70	int libzfs_desc_active;
71	char libzfs_action[1024];
72	char libzfs_desc[1024];
73	char *libzfs_log_str;
74	int libzfs_printerr;
75	int libzfs_storeerr; /* stuff error messages into buffer */
76	void *libzfs_sharehdl; /* libshare handle */
77	uint_t libzfs_shareflags;
78	boolean_t libzfs_mnttab_enable;
79	avl_tree_t libzfs_mnttab_cache;
80	int libzfs_pool_iter;
81	libzfs_fru_t **libzfs_fru_hash;
82	libzfs_fru_t *libzfs_fru_list;
83	char libzfs_chassis_id[256];
84};
85
86#define	ZFSSHARE_MISS	0x01	/* Didn't find entry in cache */
87
88struct zfs_handle {
89	libzfs_handle_t *zfs_hdl;
90	zpool_handle_t *zpool_hdl;
91	char zfs_name[ZFS_MAXNAMELEN];
92	zfs_type_t zfs_type; /* type including snapshot */
93	zfs_type_t zfs_head_type; /* type excluding snapshot */
94	dmu_objset_stats_t zfs_dmustats;
95	nvlist_t *zfs_props;
96	nvlist_t *zfs_user_props;
97	nvlist_t *zfs_recvd_props;
98	boolean_t zfs_mntcheck;
99	char *zfs_mntopts;
100	uint8_t *zfs_props_table;
101};
102
103/*
104 * This is different from checking zfs_type, because it will also catch
105 * snapshots of volumes.
106 */
107#define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
108
109struct zpool_handle {
110	libzfs_handle_t *zpool_hdl;
111	zpool_handle_t *zpool_next;
112	char zpool_name[ZPOOL_MAXNAMELEN];
113	int zpool_state;
114	size_t zpool_config_size;
115	nvlist_t *zpool_config;
116	nvlist_t *zpool_old_config;
117	nvlist_t *zpool_props;
118	diskaddr_t zpool_start_block;
119};
120
121typedef enum {
122	PROTO_NFS = 0,
123	PROTO_SMB = 1,
124	PROTO_END = 2
125} zfs_share_proto_t;
126
127/*
128 * The following can be used as a bitmask and any new values
129 * added must preserve that capability.
130 */
131typedef enum {
132	SHARED_NOT_SHARED = 0x0,
133	SHARED_NFS = 0x2,
134	SHARED_SMB = 0x4
135} zfs_share_type_t;
136
137int zfs_error(libzfs_handle_t *, int, const char *);
138int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
139void zfs_error_aux(libzfs_handle_t *, const char *, ...);
140void *zfs_alloc(libzfs_handle_t *, size_t);
141void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
142char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
143char *zfs_strdup(libzfs_handle_t *, const char *);
144int no_memory(libzfs_handle_t *);
145
146int zfs_standard_error(libzfs_handle_t *, int, const char *);
147int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
148int zpool_standard_error(libzfs_handle_t *, int, const char *);
149int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
150
151int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
152    size_t *);
153zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
154zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
155
156int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
157    nvlist_t *, char **, uint64_t *, const char *);
158int 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	0x01
167/*
168 * Use this changelist_gather() flag to prevent unmounting of file systems.
169 */
170#define	CL_GATHER_DONT_UNMOUNT	0x02
171
172typedef struct prop_changelist prop_changelist_t;
173
174int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
175int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
176int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
177int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
178int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
179void zcmd_free_nvlists(zfs_cmd_t *);
180
181int changelist_prefix(prop_changelist_t *);
182int changelist_postfix(prop_changelist_t *);
183void changelist_rename(prop_changelist_t *, const char *, const char *);
184void changelist_remove(prop_changelist_t *, const char *);
185void changelist_free(prop_changelist_t *);
186prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
187int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
188int changelist_haszonedchild(prop_changelist_t *);
189
190void remove_mountpoint(zfs_handle_t *);
191int create_parents(libzfs_handle_t *, char *, int);
192boolean_t isa_child_of(const char *dataset, const char *parent);
193
194zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
195
196int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
197
198boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
199
200int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
201    boolean_t modifying);
202
203void namespace_clear(libzfs_handle_t *);
204
205/*
206 * libshare (sharemgr) interfaces used internally.
207 */
208
209extern int zfs_init_libshare(libzfs_handle_t *, int);
210extern void zfs_uninit_libshare(libzfs_handle_t *);
211extern int zfs_parse_options(char *, zfs_share_proto_t);
212
213extern int zfs_unshare_proto(zfs_handle_t *,
214    const char *, zfs_share_proto_t *);
215
216extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t);
217
218#ifndef sun
219static int zfs_kernel_version = 0;
220static int zfs_ioctl_version = 0;
221
222/*
223 * This is FreeBSD version of ioctl, because Solaris' ioctl() updates
224 * zc_nvlist_dst_size even if an error is returned, on FreeBSD if an
225 * error is returned zc_nvlist_dst_size won't be updated.
226 */
227static __inline int
228zcmd_ioctl(int fd, unsigned long cmd, zfs_cmd_t *zc)
229{
230	size_t oldsize, zfs_kernel_version_size, zfs_ioctl_version_size;
231	int version, ret, cflag = ZFS_CMD_COMPAT_NONE;
232
233	zfs_ioctl_version_size = sizeof(zfs_ioctl_version);
234	if (zfs_ioctl_version == 0) {
235		sysctlbyname("vfs.zfs.version.ioctl", &zfs_ioctl_version,
236		    &zfs_ioctl_version_size, NULL, 0);
237	}
238
239	/*
240	 * If vfs.zfs.version.ioctl is not defined, assume we have v28
241	 * compatible binaries and use vfs.zfs.version.spa to test for v15
242	 */
243	if (zfs_ioctl_version < ZFS_IOCVER_DEADMAN) {
244		cflag = ZFS_CMD_COMPAT_V28;
245		zfs_kernel_version_size = sizeof(zfs_kernel_version);
246
247		if (zfs_kernel_version == 0) {
248			sysctlbyname("vfs.zfs.version.spa",
249			    &zfs_kernel_version,
250			    &zfs_kernel_version_size, NULL, 0);
251		}
252
253		if (zfs_kernel_version == SPA_VERSION_15 ||
254		    zfs_kernel_version == SPA_VERSION_14 ||
255		    zfs_kernel_version == SPA_VERSION_13)
256			cflag = ZFS_CMD_COMPAT_V15;
257	}
258
259	oldsize = zc->zc_nvlist_dst_size;
260	ret = zcmd_ioctl_compat(fd, cmd, zc, cflag);
261
262	if (ret == 0 && oldsize < zc->zc_nvlist_dst_size) {
263		ret = -1;
264		errno = ENOMEM;
265	}
266
267	return (ret);
268}
269#define	ioctl(fd, cmd, zc)	zcmd_ioctl((fd), (cmd), (zc))
270#endif	/* !sun */
271
272#ifdef	__cplusplus
273}
274#endif
275
276#endif	/* _LIBFS_IMPL_H */
277