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