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.
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.
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]
23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Copyright (c) 2011 Pawel Jakub Dawidek <pawel@dawidek.net>.
25 * All rights reserved.
26 * Copyright (c) 2013 by Delphix. All rights reserved.
27 * Copyright (c) 2013 Martin Matuska <mm@FreeBSD.org>. All rights reserved.
30 #ifndef _LIBZFS_IMPL_H
31 #define _LIBZFS_IMPL_H
34 #include <sys/fs/zfs.h>
35 #include <sys/zfs_ioctl.h>
37 #include <sys/nvpair.h>
42 #include <libzfs_core.h>
43 #include <libzfs_compat.h>
54 typedef struct libzfs_fru {
57 struct libzfs_fru *zf_chain;
58 struct libzfs_fru *zf_next;
61 struct libzfs_handle {
65 FILE *libzfs_sharetab;
66 zpool_handle_t *libzfs_pool_handles;
67 uu_avl_pool_t *libzfs_ns_avlpool;
68 uu_avl_t *libzfs_ns_avl;
69 uint64_t libzfs_ns_gen;
70 int libzfs_desc_active;
71 char libzfs_action[1024];
72 char libzfs_desc[1024];
74 int libzfs_storeerr; /* stuff error messages into buffer */
75 void *libzfs_sharehdl; /* libshare handle */
76 uint_t libzfs_shareflags;
77 boolean_t libzfs_mnttab_enable;
78 avl_tree_t libzfs_mnttab_cache;
80 libzfs_fru_t **libzfs_fru_hash;
81 libzfs_fru_t *libzfs_fru_list;
82 char libzfs_chassis_id[256];
85 #define ZFSSHARE_MISS 0x01 /* Didn't find entry in cache */
88 libzfs_handle_t *zfs_hdl;
89 zpool_handle_t *zpool_hdl;
90 char zfs_name[ZFS_MAXNAMELEN];
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;
95 nvlist_t *zfs_user_props;
96 nvlist_t *zfs_recvd_props;
97 boolean_t zfs_mntcheck;
99 uint8_t *zfs_props_table;
103 * This is different from checking zfs_type, because it will also catch
104 * snapshots of volumes.
106 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
108 struct zpool_handle {
109 libzfs_handle_t *zpool_hdl;
110 zpool_handle_t *zpool_next;
111 char zpool_name[ZPOOL_MAXNAMELEN];
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;
127 * The following can be used as a bitmask and any new values
128 * added must preserve that capability.
131 SHARED_NOT_SHARED = 0x0,
136 int zfs_error(libzfs_handle_t *, int, const char *);
137 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
138 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
139 void *zfs_alloc(libzfs_handle_t *, size_t);
140 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
141 char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
142 char *zfs_strdup(libzfs_handle_t *, const char *);
143 int no_memory(libzfs_handle_t *);
145 int zfs_standard_error(libzfs_handle_t *, int, const char *);
146 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
147 int zpool_standard_error(libzfs_handle_t *, int, const char *);
148 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
150 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
152 zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
153 zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
155 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
156 nvlist_t *, char **, uint64_t *, const char *);
157 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
161 * Use this changelist_gather() flag to force attempting mounts
162 * on each change node regardless of whether or not it is currently
165 #define CL_GATHER_MOUNT_ALWAYS 0x01
167 * Use this changelist_gather() flag to prevent unmounting of file systems.
169 #define CL_GATHER_DONT_UNMOUNT 0x02
171 typedef struct prop_changelist prop_changelist_t;
173 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
174 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
175 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
176 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
177 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
178 void zcmd_free_nvlists(zfs_cmd_t *);
180 int changelist_prefix(prop_changelist_t *);
181 int changelist_postfix(prop_changelist_t *);
182 void changelist_rename(prop_changelist_t *, const char *, const char *);
183 void changelist_remove(prop_changelist_t *, const char *);
184 void changelist_free(prop_changelist_t *);
185 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
186 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
187 int changelist_haszonedchild(prop_changelist_t *);
189 void remove_mountpoint(zfs_handle_t *);
190 int create_parents(libzfs_handle_t *, char *, int);
191 boolean_t isa_child_of(const char *dataset, const char *parent);
193 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
194 zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
197 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
199 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
201 int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
202 boolean_t modifying);
204 void namespace_clear(libzfs_handle_t *);
207 * libshare (sharemgr) interfaces used internally.
210 extern int zfs_init_libshare(libzfs_handle_t *, int);
211 extern void zfs_uninit_libshare(libzfs_handle_t *);
212 extern int zfs_parse_options(char *, zfs_share_proto_t);
214 extern int zfs_unshare_proto(zfs_handle_t *,
215 const char *, zfs_share_proto_t *);
217 extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t);
223 #endif /* _LIBZFS_IMPL_H */