libzfs_impl.h revision 307053 
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) 2013 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/dmu.h>
33#include <sys/fs/zfs.h>
34#include <sys/zfs_ioctl.h>
35#include <sys/spa.h>
36#include <sys/nvpair.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};
83
84#define	ZFSSHARE_MISS	0x01	/* Didn't find entry in cache */
85
86struct zfs_handle {
87	libzfs_handle_t *zfs_hdl;
88	zpool_handle_t *zpool_hdl;
89	char zfs_name[ZFS_MAXNAMELEN];
90	zfs_type_t zfs_type; /* type including snapshot */
91	zfs_type_t zfs_head_type; /* type excluding snapshot */
92	dmu_objset_stats_t zfs_dmustats;
93	nvlist_t *zfs_props;
94	nvlist_t *zfs_user_props;
95	nvlist_t *zfs_recvd_props;
96	boolean_t zfs_mntcheck;
97	char *zfs_mntopts;
98	uint8_t *zfs_props_table;
99};
100
101/*
102 * This is different from checking zfs_type, because it will also catch
103 * snapshots of volumes.
104 */
105#define	ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
106
107struct zpool_handle {
108	libzfs_handle_t *zpool_hdl;
109	zpool_handle_t *zpool_next;
110	char zpool_name[ZPOOL_MAXNAMELEN];
111	int zpool_state;
112	size_t zpool_config_size;
113	nvlist_t *zpool_config;
114	nvlist_t *zpool_old_config;
115	nvlist_t *zpool_props;
116	diskaddr_t zpool_start_block;
117};
118
119typedef enum {
120	PROTO_NFS = 0,
121	PROTO_SMB = 1,
122	PROTO_END = 2
123} zfs_share_proto_t;
124
125/*
126 * The following can be used as a bitmask and any new values
127 * added must preserve that capability.
128 */
129typedef enum {
130	SHARED_NOT_SHARED = 0x0,
131	SHARED_NFS = 0x2,
132	SHARED_SMB = 0x4
133} zfs_share_type_t;
134
135int zfs_error(libzfs_handle_t *, int, const char *);
136int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
137void zfs_error_aux(libzfs_handle_t *, const char *, ...);
138void *zfs_alloc(libzfs_handle_t *, size_t);
139void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
140char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
141char *zfs_strdup(libzfs_handle_t *, const char *);
142int no_memory(libzfs_handle_t *);
143
144int zfs_standard_error(libzfs_handle_t *, int, const char *);
145int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
146int zpool_standard_error(libzfs_handle_t *, int, const char *);
147int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
148
149int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
150    size_t *);
151zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
152zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
153
154int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
155    nvlist_t *, char **, uint64_t *, const char *);
156int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
157    zfs_type_t type);
158
159/*
160 * Use this changelist_gather() flag to force attempting mounts
161 * on each change node regardless of whether or not it is currently
162 * mounted.
163 */
164#define	CL_GATHER_MOUNT_ALWAYS	0x01
165/*
166 * Use this changelist_gather() flag to prevent unmounting of file systems.
167 */
168#define	CL_GATHER_DONT_UNMOUNT	0x02
169
170typedef struct prop_changelist prop_changelist_t;
171
172int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
173int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
174int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
175int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
176int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
177void zcmd_free_nvlists(zfs_cmd_t *);
178
179int changelist_prefix(prop_changelist_t *);
180int changelist_postfix(prop_changelist_t *);
181void changelist_rename(prop_changelist_t *, const char *, const char *);
182void changelist_remove(prop_changelist_t *, const char *);
183void changelist_free(prop_changelist_t *);
184prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
185int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
186int changelist_haszonedchild(prop_changelist_t *);
187
188void remove_mountpoint(zfs_handle_t *);
189int create_parents(libzfs_handle_t *, char *, int);
190boolean_t isa_child_of(const char *dataset, const char *parent);
191
192zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
193zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
194    nvlist_t *props);
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#ifdef	__cplusplus
219}
220#endif
221
222#endif	/* _LIBZFS_IMPL_H */
223