xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs_impl.h (revision d4517e84e3ffaa7bc4207a17f694c309904e7c48)
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 2008 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_LIBFS_IMPL_H
28 #define	_LIBFS_IMPL_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #include <sys/dmu.h>
33 #include <sys/fs/zfs.h>
34 #include <sys/zfs_ioctl.h>
35 #include <sys/zfs_acl.h>
36 #include <sys/spa.h>
37 #include <sys/nvpair.h>
38 
39 #include <libuutil.h>
40 #include <libzfs.h>
41 #include <libshare.h>
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 struct libzfs_handle {
48 	int libzfs_error;
49 	int libzfs_fd;
50 	FILE *libzfs_mnttab;
51 	FILE *libzfs_sharetab;
52 	uu_avl_pool_t *libzfs_ns_avlpool;
53 	uu_avl_t *libzfs_ns_avl;
54 	uint64_t libzfs_ns_gen;
55 	int libzfs_desc_active;
56 	char libzfs_action[1024];
57 	char libzfs_desc[1024];
58 	char *libzfs_log_str;
59 	int libzfs_printerr;
60 	void *libzfs_sharehdl; /* libshare handle */
61 	uint_t libzfs_shareflags;
62 };
63 #define	ZFSSHARE_MISS	0x01	/* Didn't find entry in cache */
64 
65 struct zfs_handle {
66 	libzfs_handle_t *zfs_hdl;
67 	char zfs_name[ZFS_MAXNAMELEN];
68 	zfs_type_t zfs_type; /* type including snapshot */
69 	zfs_type_t zfs_head_type; /* type excluding snapshot */
70 	dmu_objset_stats_t zfs_dmustats;
71 	nvlist_t *zfs_props;
72 	nvlist_t *zfs_user_props;
73 	boolean_t zfs_mntcheck;
74 	char *zfs_mntopts;
75 	char zfs_root[MAXPATHLEN];
76 };
77 
78 /*
79  * This is different from checking zfs_type, because it will also catch
80  * snapshots of volumes.
81  */
82 #define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
83 
84 struct zpool_handle {
85 	libzfs_handle_t *zpool_hdl;
86 	char zpool_name[ZPOOL_MAXNAMELEN];
87 	int zpool_state;
88 	size_t zpool_config_size;
89 	nvlist_t *zpool_config;
90 	nvlist_t *zpool_old_config;
91 	nvlist_t *zpool_props;
92 	diskaddr_t zpool_start_block;
93 };
94 
95 typedef  enum {
96 	PROTO_NFS = 0,
97 	PROTO_SMB = 1,
98 	PROTO_END = 2
99 } zfs_share_proto_t;
100 
101 /*
102  * The following can be used as a bitmask and any new values
103  * added must preserve that capability.
104  */
105 typedef enum {
106 	SHARED_NOT_SHARED = 0x0,
107 	SHARED_ISCSI = 0x1,
108 	SHARED_NFS = 0x2,
109 	SHARED_SMB = 0x4
110 } zfs_share_type_t;
111 
112 int zfs_error(libzfs_handle_t *, int, const char *);
113 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
114 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
115 void *zfs_alloc(libzfs_handle_t *, size_t);
116 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
117 char *zfs_strdup(libzfs_handle_t *, const char *);
118 int no_memory(libzfs_handle_t *);
119 
120 int zfs_standard_error(libzfs_handle_t *, int, const char *);
121 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
122 int zpool_standard_error(libzfs_handle_t *, int, const char *);
123 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
124 
125 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
126     size_t *);
127 
128 
129 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
130     nvlist_t *, char **, uint64_t *, const char *);
131 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
132     zfs_type_t type);
133 
134 typedef struct prop_changelist prop_changelist_t;
135 
136 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
137 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
138 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
139 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
140 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
141 void zcmd_free_nvlists(zfs_cmd_t *);
142 
143 int changelist_prefix(prop_changelist_t *);
144 int changelist_postfix(prop_changelist_t *);
145 void changelist_rename(prop_changelist_t *, const char *, const char *);
146 void changelist_remove(prop_changelist_t *, const char *);
147 void changelist_free(prop_changelist_t *);
148 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int);
149 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
150 int changelist_haszonedchild(prop_changelist_t *);
151 
152 void remove_mountpoint(zfs_handle_t *);
153 int create_parents(libzfs_handle_t *, char *, int);
154 
155 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
156 
157 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
158 
159 int zvol_create_link(libzfs_handle_t *, const char *);
160 int zvol_remove_link(libzfs_handle_t *, const char *);
161 int zpool_iter_zvol(zpool_handle_t *, int (*)(const char *, void *), void *);
162 
163 void namespace_clear(libzfs_handle_t *);
164 
165 /*
166  * libshare (sharemgr) interfaces used internally.
167  */
168 
169 extern int zfs_init_libshare(libzfs_handle_t *, int);
170 extern void zfs_uninit_libshare(libzfs_handle_t *);
171 extern int zfs_parse_options(char *, zfs_share_proto_t);
172 
173 extern int zfs_unshare_proto(zfs_handle_t *zhp,
174     const char *, zfs_share_proto_t *);
175 #ifdef	__cplusplus
176 }
177 #endif
178 
179 #endif	/* _LIBFS_IMPL_H */
180