xref: /illumos-gate/usr/src/lib/libzfs/common/libzfs_impl.h (revision 3893cb7fe5bfa1c9a4f7954517a917367f6cf081)
1 /*
2  * CDDL HEADER START
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 2007 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_log_type;
60 	int libzfs_printerr;
61 	void *libzfs_sharehdl; /* libshare handle */
62 };
63 
64 struct zfs_handle {
65 	libzfs_handle_t *zfs_hdl;
66 	char zfs_name[ZFS_MAXNAMELEN];
67 	zfs_type_t zfs_type; /* type including snapshot */
68 	zfs_type_t zfs_head_type; /* type excluding snapshot */
69 	dmu_objset_stats_t zfs_dmustats;
70 	nvlist_t *zfs_props;
71 	nvlist_t *zfs_user_props;
72 	boolean_t zfs_mntcheck;
73 	char *zfs_mntopts;
74 	char zfs_root[MAXPATHLEN];
75 };
76 
77 /*
78  * This is different from checking zfs_type, because it will also catch
79  * snapshots of volumes.
80  */
81 #define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
82 
83 struct zpool_handle {
84 	libzfs_handle_t *zpool_hdl;
85 	char zpool_name[ZPOOL_MAXNAMELEN];
86 	int zpool_state;
87 	size_t zpool_config_size;
88 	nvlist_t *zpool_config;
89 	nvlist_t *zpool_old_config;
90 	nvlist_t *zpool_props;
91 	diskaddr_t zpool_start_block;
92 };
93 
94 int zfs_error(libzfs_handle_t *, int, const char *);
95 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
96 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
97 void *zfs_alloc(libzfs_handle_t *, size_t);
98 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
99 char *zfs_strdup(libzfs_handle_t *, const char *);
100 int no_memory(libzfs_handle_t *);
101 
102 int zfs_standard_error(libzfs_handle_t *, int, const char *);
103 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
104 int zpool_standard_error(libzfs_handle_t *, int, const char *);
105 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
106 
107 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
108     size_t *);
109 
110 int zfs_expand_proplist_common(libzfs_handle_t *, zfs_proplist_t **,
111     zfs_type_t);
112 int zfs_get_proplist_common(libzfs_handle_t *, char *, zfs_proplist_t **,
113     zfs_type_t);
114 zfs_prop_t zfs_prop_iter_common(zfs_prop_f, void *, zfs_type_t, boolean_t,
115     boolean_t);
116 zfs_prop_t zfs_name_to_prop_common(const char *, zfs_type_t);
117 
118 nvlist_t *zfs_validate_properties(libzfs_handle_t *, zfs_type_t, char *,
119 	nvlist_t *, uint64_t, zfs_handle_t *zhp, const char *errbuf);
120 
121 typedef struct prop_changelist prop_changelist_t;
122 
123 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
124 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *, size_t *);
125 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
126 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
127 void zcmd_free_nvlists(zfs_cmd_t *);
128 
129 int changelist_prefix(prop_changelist_t *);
130 int changelist_postfix(prop_changelist_t *);
131 void changelist_rename(prop_changelist_t *, const char *, const char *);
132 void changelist_remove(zfs_handle_t *, prop_changelist_t *);
133 void changelist_free(prop_changelist_t *);
134 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int);
135 int changelist_unshare(prop_changelist_t *);
136 int changelist_haszonedchild(prop_changelist_t *);
137 
138 void remove_mountpoint(zfs_handle_t *);
139 
140 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
141 
142 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
143 
144 int zvol_create_link(libzfs_handle_t *, const char *);
145 int zvol_remove_link(libzfs_handle_t *, const char *);
146 int zpool_iter_zvol(zpool_handle_t *, int (*)(const char *, void *), void *);
147 
148 void namespace_clear(libzfs_handle_t *);
149 
150 /*
151  * libshare (sharemgr) interfaces used internally.
152  */
153 
154 extern int zfs_init_libshare(libzfs_handle_t *, int);
155 extern void zfs_uninit_libshare(libzfs_handle_t *);
156 extern int zfs_parse_options(char *, char *);
157 
158 #ifdef	__cplusplus
159 }
160 #endif
161 
162 #endif	/* _LIBFS_IMPL_H */
163