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 <libzfs.h> 40 #include <libshare.h> 41 #include <libzfs_core.h> 42 43 #ifdef __cplusplus 44 extern "C" { 45 #endif 46 47 #define ERRBUFLEN 1024 48 49 struct libzfs_handle { 50 int libzfs_error; 51 int libzfs_fd; 52 zpool_handle_t *libzfs_pool_handles; 53 avl_tree_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 int libzfs_printerr; 59 boolean_t libzfs_mnttab_enable; 60 /* 61 * We need a lock to handle the case where parallel mount 62 * threads are populating the mnttab cache simultaneously. The 63 * lock only protects the integrity of the avl tree, and does 64 * not protect the contents of the mnttab entries themselves. 65 */ 66 pthread_mutex_t libzfs_mnttab_cache_lock; 67 avl_tree_t libzfs_mnttab_cache; 68 int libzfs_pool_iter; 69 boolean_t libzfs_prop_debug; 70 regex_t libzfs_urire; 71 uint64_t libzfs_max_nvlist; 72 void *libfetch; 73 char *libfetch_load_error; 74 }; 75 76 struct zfs_handle { 77 libzfs_handle_t *zfs_hdl; 78 zpool_handle_t *zpool_hdl; 79 char zfs_name[ZFS_MAX_DATASET_NAME_LEN]; 80 zfs_type_t zfs_type; /* type including snapshot */ 81 zfs_type_t zfs_head_type; /* type excluding snapshot */ 82 dmu_objset_stats_t zfs_dmustats; 83 nvlist_t *zfs_props; 84 nvlist_t *zfs_user_props; 85 nvlist_t *zfs_recvd_props; 86 boolean_t zfs_mntcheck; 87 char *zfs_mntopts; 88 uint8_t *zfs_props_table; 89 }; 90 91 /* 92 * This is different from checking zfs_type, because it will also catch 93 * snapshots of volumes. 94 */ 95 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME) 96 #define ZHP_MAX_PROPNAMES 4 97 98 struct zpool_handle { 99 libzfs_handle_t *zpool_hdl; 100 zpool_handle_t *zpool_next; 101 char zpool_name[ZFS_MAX_DATASET_NAME_LEN]; 102 int zpool_state; 103 unsigned int zpool_n_propnames; 104 const char *zpool_propnames[ZHP_MAX_PROPNAMES]; 105 size_t zpool_config_size; 106 nvlist_t *zpool_config; 107 nvlist_t *zpool_old_config; 108 nvlist_t *zpool_props; 109 diskaddr_t zpool_start_block; 110 }; 111 112 typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *, 113 const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *); 114 115 typedef struct zfs_uri_handler { 116 const char *zuh_scheme; 117 zfs_uri_handler_fn_t zuh_handler; 118 } zfs_uri_handler_t; 119 120 #define CONFIG_BUF_MINSIZE 262144 121 122 extern int zfs_error(libzfs_handle_t *, int, const char *); 123 extern int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...) 124 __attribute__((format(printf, 3, 4))); 125 extern void zfs_error_aux(libzfs_handle_t *, const char *, ...) 126 __attribute__((format(printf, 2, 3))); 127 extern void *zfs_alloc(libzfs_handle_t *, size_t); 128 extern void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t); 129 extern char *zfs_asprintf(libzfs_handle_t *, const char *, ...) 130 __attribute__((format(printf, 2, 3))); 131 extern char *zfs_strdup(libzfs_handle_t *, const char *); 132 extern int no_memory(libzfs_handle_t *); 133 134 extern int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...) 135 __attribute__((format(printf, 3, 4))); 136 extern void zfs_setprop_error(libzfs_handle_t *, zfs_prop_t, int, char *); 137 extern int zpool_standard_error(libzfs_handle_t *, int, const char *); 138 extern int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...) 139 __attribute__((format(printf, 3, 4))); 140 141 extern zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *); 142 extern zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *); 143 144 extern int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t, 145 nvlist_t *, const char **, uint64_t *, const char *); 146 extern int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, 147 zfs_type_t type); 148 149 /* 150 * Use this changelist_gather() flag to force attempting mounts 151 * on each change node regardless of whether or not it is currently 152 * mounted. 153 */ 154 #define CL_GATHER_MOUNT_ALWAYS 1 155 /* 156 * changelist_gather() flag to force it to iterate on mounted datasets only 157 */ 158 #define CL_GATHER_ITER_MOUNTED 2 159 /* 160 * Use this changelist_gather() flag to prevent unmounting of file systems. 161 */ 162 #define CL_GATHER_DONT_UNMOUNT 4 163 164 typedef struct prop_changelist prop_changelist_t; 165 166 extern void zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t); 167 extern void zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 168 extern void zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 169 extern void zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *); 170 extern int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **); 171 extern void zcmd_free_nvlists(zfs_cmd_t *); 172 173 extern int changelist_prefix(prop_changelist_t *); 174 extern int changelist_postfix(prop_changelist_t *); 175 extern void changelist_rename(prop_changelist_t *, const char *, const char *); 176 extern void changelist_remove(prop_changelist_t *, const char *); 177 extern void changelist_free(prop_changelist_t *); 178 extern prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, 179 int); 180 extern int changelist_unshare(prop_changelist_t *, const enum sa_protocol *); 181 extern int changelist_haszonedchild(prop_changelist_t *); 182 183 extern void remove_mountpoint(zfs_handle_t *); 184 extern int create_parents(libzfs_handle_t *, char *, int); 185 186 extern zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *); 187 extern zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *, 188 nvlist_t *props); 189 190 extern int zpool_open_silent(libzfs_handle_t *, const char *, 191 zpool_handle_t **); 192 193 extern boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *); 194 195 extern int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type, 196 boolean_t modifying); 197 198 extern void namespace_clear(libzfs_handle_t *); 199 200 typedef struct { 201 zfs_prop_t p_prop; 202 int p_share_err; 203 int p_unshare_err; 204 } proto_table_t; 205 206 typedef struct differ_info { 207 zfs_handle_t *zhp; 208 char *fromsnap; 209 char *frommnt; 210 char *tosnap; 211 char *tomnt; 212 char *ds; 213 char *dsmnt; 214 char *tmpsnap; 215 char errbuf[ERRBUFLEN]; 216 boolean_t isclone; 217 boolean_t scripted; 218 boolean_t classify; 219 boolean_t timestamped; 220 boolean_t no_mangle; 221 uint64_t shares; 222 int zerr; 223 int cleanupfd; 224 int outputfd; 225 int datafd; 226 } differ_info_t; 227 228 extern int do_mount(zfs_handle_t *zhp, const char *mntpt, const char *opts, 229 int flags); 230 extern int do_unmount(zfs_handle_t *zhp, const char *mntpt, int flags); 231 extern int libzfs_load_module(void); 232 extern int zpool_relabel_disk(libzfs_handle_t *hdl, const char *path, 233 const char *msg); 234 extern int find_shares_object(differ_info_t *di); 235 236 #ifdef __cplusplus 237 } 238 #endif 239 240 #endif /* _LIBZFS_IMPL_H */ 241