1 // SPDX-License-Identifier: CDDL-1.0 2 /* 3 * CDDL HEADER START 4 * 5 * The contents of this file are subject to the terms of the 6 * Common Development and Distribution License (the "License"). 7 * You may not use this file except in compliance with the License. 8 * 9 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 10 * or https://opensource.org/licenses/CDDL-1.0. 11 * See the License for the specific language governing permissions 12 * and limitations under the License. 13 * 14 * When distributing Covered Code, include this CDDL HEADER in each 15 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 16 * If applicable, add the following below this CDDL HEADER, with the 17 * fields enclosed by brackets "[]" replaced with your own identifying 18 * information: Portions Copyright [yyyy] [name of copyright owner] 19 * 20 * CDDL HEADER END 21 */ 22 23 /* 24 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 25 * Copyright (c) 2011, 2020 by Delphix. All rights reserved. 26 * Copyright (c) 2018 Datto Inc. 27 * Copyright 2020 Joyent, Inc. 28 */ 29 30 #ifndef _LIBZFS_IMPL_H 31 #define _LIBZFS_IMPL_H 32 33 #include <sys/fs/zfs.h> 34 #include <sys/nvpair.h> 35 #include <sys/dmu.h> 36 #include <sys/zfs_ioctl.h> 37 #include <regex.h> 38 39 #include <libuutil.h> 40 #include <libzfs.h> 41 #include <libshare.h> 42 #include <libzfs_core.h> 43 44 #ifdef __cplusplus 45 extern "C" { 46 #endif 47 48 #define ERRBUFLEN 1024 49 50 struct libzfs_handle { 51 int libzfs_error; 52 int libzfs_fd; 53 zpool_handle_t *libzfs_pool_handles; 54 uu_avl_pool_t *libzfs_ns_avlpool; 55 uu_avl_t *libzfs_ns_avl; 56 uint64_t libzfs_ns_gen; 57 int libzfs_desc_active; 58 char libzfs_action[1024]; 59 char libzfs_desc[1024]; 60 int libzfs_printerr; 61 boolean_t libzfs_mnttab_enable; 62 /* 63 * We need a lock to handle the case where parallel mount 64 * threads are populating the mnttab cache simultaneously. The 65 * lock only protects the integrity of the avl tree, and does 66 * not protect the contents of the mnttab entries themselves. 67 */ 68 pthread_mutex_t libzfs_mnttab_cache_lock; 69 avl_tree_t libzfs_mnttab_cache; 70 int libzfs_pool_iter; 71 boolean_t libzfs_prop_debug; 72 regex_t libzfs_urire; 73 uint64_t libzfs_max_nvlist; 74 void *libfetch; 75 char *libfetch_load_error; 76 }; 77 78 struct zfs_handle { 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; 85 nvlist_t *zfs_props; 86 nvlist_t *zfs_user_props; 87 nvlist_t *zfs_recvd_props; 88 boolean_t zfs_mntcheck; 89 char *zfs_mntopts; 90 uint8_t *zfs_props_table; 91 }; 92 93 /* 94 * This is different from checking zfs_type, because it will also catch 95 * snapshots of volumes. 96 */ 97 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME) 98 #define ZHP_MAX_PROPNAMES 4 99 100 struct zpool_handle { 101 libzfs_handle_t *zpool_hdl; 102 zpool_handle_t *zpool_next; 103 char zpool_name[ZFS_MAX_DATASET_NAME_LEN]; 104 int zpool_state; 105 unsigned int zpool_n_propnames; 106 const char *zpool_propnames[ZHP_MAX_PROPNAMES]; 107 size_t zpool_config_size; 108 nvlist_t *zpool_config; 109 nvlist_t *zpool_old_config; 110 nvlist_t *zpool_props; 111 diskaddr_t zpool_start_block; 112 }; 113 114 typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *, 115 const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *); 116 117 typedef struct zfs_uri_handler { 118 const char *zuh_scheme; 119 zfs_uri_handler_fn_t zuh_handler; 120 } zfs_uri_handler_t; 121 122 #define CONFIG_BUF_MINSIZE 262144 123 124 extern int zfs_error(libzfs_handle_t *, int, const char *); 125 extern int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...) 126 __attribute__((format(printf, 3, 4))); 127 extern void zfs_error_aux(libzfs_handle_t *, const char *, ...) 128 __attribute__((format(printf, 2, 3))); 129 extern void *zfs_alloc(libzfs_handle_t *, size_t); 130 extern void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t); 131 extern char *zfs_asprintf(libzfs_handle_t *, const char *, ...) 132 __attribute__((format(printf, 2, 3))); 133 extern char *zfs_strdup(libzfs_handle_t *, const char *); 134 extern int no_memory(libzfs_handle_t *); 135 136 extern int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...) 137 __attribute__((format(printf, 3, 4))); 138 extern void zfs_setprop_error(libzfs_handle_t *, zfs_prop_t, int, char *); 139 extern int zpool_standard_error(libzfs_handle_t *, int, const char *); 140 extern int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...) 141 __attribute__((format(printf, 3, 4))); 142 143 extern zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *); 144 extern zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *); 145 146 extern int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t, 147 nvlist_t *, const char **, uint64_t *, const char *); 148 extern int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, 149 zfs_type_t type); 150 151 /* 152 * Use this changelist_gather() flag to force attempting mounts 153 * on each change node regardless of whether or not it is currently 154 * mounted. 155 */ 156 #define CL_GATHER_MOUNT_ALWAYS 1 157 /* 158 * changelist_gather() flag to force it to iterate on mounted datasets only 159 */ 160 #define CL_GATHER_ITER_MOUNTED 2 161 /* 162 * Use this changelist_gather() flag to prevent unmounting of file systems. 163 */ 164 #define CL_GATHER_DONT_UNMOUNT 4 165 166 typedef struct prop_changelist prop_changelist_t; 167 168 extern void zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t); 169 extern void zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 170 extern void zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 171 extern void zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *); 172 extern int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **); 173 extern void zcmd_free_nvlists(zfs_cmd_t *); 174 175 extern int changelist_prefix(prop_changelist_t *); 176 extern int changelist_postfix(prop_changelist_t *); 177 extern void changelist_rename(prop_changelist_t *, const char *, const char *); 178 extern void changelist_remove(prop_changelist_t *, const char *); 179 extern void changelist_free(prop_changelist_t *); 180 extern prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, 181 int); 182 extern int changelist_unshare(prop_changelist_t *, const enum sa_protocol *); 183 extern int changelist_haszonedchild(prop_changelist_t *); 184 185 extern void remove_mountpoint(zfs_handle_t *); 186 extern int create_parents(libzfs_handle_t *, char *, int); 187 188 extern zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *); 189 extern zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *, 190 nvlist_t *props); 191 192 extern int zpool_open_silent(libzfs_handle_t *, const char *, 193 zpool_handle_t **); 194 195 extern boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *); 196 197 extern int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type, 198 boolean_t modifying); 199 200 extern void namespace_clear(libzfs_handle_t *); 201 202 typedef struct { 203 zfs_prop_t p_prop; 204 int p_share_err; 205 int p_unshare_err; 206 } proto_table_t; 207 208 typedef struct differ_info { 209 zfs_handle_t *zhp; 210 char *fromsnap; 211 char *frommnt; 212 char *tosnap; 213 char *tomnt; 214 char *ds; 215 char *dsmnt; 216 char *tmpsnap; 217 char errbuf[ERRBUFLEN]; 218 boolean_t isclone; 219 boolean_t scripted; 220 boolean_t classify; 221 boolean_t timestamped; 222 boolean_t no_mangle; 223 uint64_t shares; 224 int zerr; 225 int cleanupfd; 226 int outputfd; 227 int datafd; 228 } differ_info_t; 229 230 extern int do_mount(zfs_handle_t *zhp, const char *mntpt, const char *opts, 231 int flags); 232 extern int do_unmount(zfs_handle_t *zhp, const char *mntpt, int flags); 233 extern int libzfs_load_module(void); 234 extern int zpool_relabel_disk(libzfs_handle_t *hdl, const char *path, 235 const char *msg); 236 extern int find_shares_object(differ_info_t *di); 237 238 #ifdef __cplusplus 239 } 240 #endif 241 242 #endif /* _LIBZFS_IMPL_H */ 243