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