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, 2017 by Delphix. All rights reserved.
25 * Copyright (c) 2018 Datto Inc.
28 #ifndef _LIBZFS_IMPL_H
29 #define _LIBZFS_IMPL_H
31 #include <sys/fs/zfs.h>
33 #include <sys/nvpair.h>
35 #include <sys/zfs_ioctl.h>
40 #include <libzfs_core.h>
46 struct libzfs_handle
{
50 FILE *libzfs_sharetab
;
51 zpool_handle_t
*libzfs_pool_handles
;
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];
59 int libzfs_storeerr
; /* stuff error messages into buffer */
60 void *libzfs_sharehdl
; /* libshare handle */
61 uint_t libzfs_shareflags
;
62 boolean_t libzfs_mnttab_enable
;
64 * We need a lock to handle the case where parallel mount
65 * threads are populating the mnttab cache simultaneously. The
66 * lock only protects the integrity of the avl tree, and does
67 * not protect the contents of the mnttab entries themselves.
69 pthread_mutex_t libzfs_mnttab_cache_lock
;
70 avl_tree_t libzfs_mnttab_cache
;
72 char libzfs_chassis_id
[256];
73 boolean_t libzfs_prop_debug
;
76 #define ZFSSHARE_MISS 0x01 /* Didn't find entry in cache */
79 libzfs_handle_t
*zfs_hdl
;
80 zpool_handle_t
*zpool_hdl
;
81 char zfs_name
[ZFS_MAX_DATASET_NAME_LEN
];
82 zfs_type_t zfs_type
; /* type including snapshot */
83 zfs_type_t zfs_head_type
; /* type excluding snapshot */
84 dmu_objset_stats_t zfs_dmustats
;
86 nvlist_t
*zfs_user_props
;
87 nvlist_t
*zfs_recvd_props
;
88 boolean_t zfs_mntcheck
;
90 uint8_t *zfs_props_table
;
94 * This is different from checking zfs_type, because it will also catch
95 * snapshots of volumes.
97 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
100 libzfs_handle_t
*zpool_hdl
;
101 zpool_handle_t
*zpool_next
;
102 char zpool_name
[ZFS_MAX_DATASET_NAME_LEN
];
104 size_t zpool_config_size
;
105 nvlist_t
*zpool_config
;
106 nvlist_t
*zpool_old_config
;
107 nvlist_t
*zpool_props
;
108 diskaddr_t zpool_start_block
;
118 * The following can be used as a bitmask and any new values
119 * added must preserve that capability.
122 SHARED_NOT_SHARED
= 0x0,
127 #define CONFIG_BUF_MINSIZE 262144
129 int zfs_error(libzfs_handle_t
*, int, const char *);
130 int zfs_error_fmt(libzfs_handle_t
*, int, const char *, ...);
131 void zfs_error_aux(libzfs_handle_t
*, const char *, ...);
132 void *zfs_alloc(libzfs_handle_t
*, size_t);
133 void *zfs_realloc(libzfs_handle_t
*, void *, size_t, size_t);
134 char *zfs_asprintf(libzfs_handle_t
*, const char *, ...);
135 char *zfs_strdup(libzfs_handle_t
*, const char *);
136 int no_memory(libzfs_handle_t
*);
138 int zfs_standard_error(libzfs_handle_t
*, int, const char *);
139 int zfs_standard_error_fmt(libzfs_handle_t
*, int, const char *, ...);
140 int zpool_standard_error(libzfs_handle_t
*, int, const char *);
141 int zpool_standard_error_fmt(libzfs_handle_t
*, int, const char *, ...);
143 zfs_handle_t
*make_dataset_handle_zc(libzfs_handle_t
*, zfs_cmd_t
*);
144 zfs_handle_t
*make_dataset_simple_handle_zc(zfs_handle_t
*, zfs_cmd_t
*);
146 int zprop_parse_value(libzfs_handle_t
*, nvpair_t
*, int, zfs_type_t
,
147 nvlist_t
*, char **, uint64_t *, const char *);
148 int zprop_expand_list(libzfs_handle_t
*hdl
, zprop_list_t
**plp
,
152 * Use this changelist_gather() flag to force attempting mounts
153 * on each change node regardless of whether or not it is currently
156 #define CL_GATHER_MOUNT_ALWAYS 1
158 * changelist_gather() flag to force it to iterate on mounted datasets only
160 #define CL_GATHER_ITER_MOUNTED 2
162 typedef struct prop_changelist prop_changelist_t
;
164 int zcmd_alloc_dst_nvlist(libzfs_handle_t
*, zfs_cmd_t
*, size_t);
165 int zcmd_write_src_nvlist(libzfs_handle_t
*, zfs_cmd_t
*, nvlist_t
*);
166 int zcmd_write_conf_nvlist(libzfs_handle_t
*, zfs_cmd_t
*, nvlist_t
*);
167 int zcmd_expand_dst_nvlist(libzfs_handle_t
*, zfs_cmd_t
*);
168 int zcmd_read_dst_nvlist(libzfs_handle_t
*, zfs_cmd_t
*, nvlist_t
**);
169 void zcmd_free_nvlists(zfs_cmd_t
*);
171 int changelist_prefix(prop_changelist_t
*);
172 int changelist_postfix(prop_changelist_t
*);
173 void changelist_rename(prop_changelist_t
*, const char *, const char *);
174 void changelist_remove(prop_changelist_t
*, const char *);
175 void changelist_free(prop_changelist_t
*);
176 prop_changelist_t
*changelist_gather(zfs_handle_t
*, zfs_prop_t
, int, int);
177 int changelist_unshare(prop_changelist_t
*, zfs_share_proto_t
*);
178 int changelist_haszonedchild(prop_changelist_t
*);
180 void remove_mountpoint(zfs_handle_t
*);
181 int create_parents(libzfs_handle_t
*, char *, int);
182 boolean_t
isa_child_of(const char *dataset
, const char *parent
);
184 zfs_handle_t
*make_dataset_handle(libzfs_handle_t
*, const char *);
185 zfs_handle_t
*make_bookmark_handle(zfs_handle_t
*, const char *,
188 int zpool_open_silent(libzfs_handle_t
*, const char *, zpool_handle_t
**);
190 boolean_t
zpool_name_valid(libzfs_handle_t
*, boolean_t
, const char *);
192 int zfs_validate_name(libzfs_handle_t
*hdl
, const char *path
, int type
,
193 boolean_t modifying
);
195 void namespace_clear(libzfs_handle_t
*);
198 * libshare (sharemgr) interfaces used internally.
201 extern int zfs_init_libshare(libzfs_handle_t
*, int);
202 extern void zfs_uninit_libshare(libzfs_handle_t
*);
203 extern int zfs_parse_options(char *, zfs_share_proto_t
);
205 extern int zfs_unshare_proto(zfs_handle_t
*,
206 const char *, zfs_share_proto_t
*);
212 #endif /* _LIBZFS_IMPL_H */