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) 2011, 2017 by Delphix. All rights reserved. 26 * Copyright 2020 Joyent, Inc. 27 */ 28 29 #ifndef _LIBZFS_IMPL_H 30 #define _LIBZFS_IMPL_H 31 32 #include <sys/fs/zfs.h> 33 #include <sys/spa.h> 34 #include <sys/nvpair.h> 35 #include <sys/dmu.h> 36 #include <sys/zfs_ioctl.h> 37 #include <synch.h> 38 #include <regex.h> 39 40 #include <libuutil.h> 41 #include <libzfs.h> 42 #include <libshare.h> 43 #include <libzfs_core.h> 44 #include <libdevinfo.h> 45 46 #include <fm/libtopo.h> 47 48 #ifdef __cplusplus 49 extern "C" { 50 #endif 51 52 #ifdef VERIFY 53 #undef VERIFY 54 #endif 55 #define VERIFY verify 56 57 typedef struct libzfs_fru { 58 char *zf_device; 59 char *zf_fru; 60 struct libzfs_fru *zf_chain; 61 struct libzfs_fru *zf_next; 62 } libzfs_fru_t; 63 64 struct libzfs_handle { 65 int libzfs_error; 66 int libzfs_fd; 67 FILE *libzfs_mnttab; 68 FILE *libzfs_sharetab; 69 zpool_handle_t *libzfs_pool_handles; 70 uu_avl_pool_t *libzfs_ns_avlpool; 71 uu_avl_t *libzfs_ns_avl; 72 uint64_t libzfs_ns_gen; 73 int libzfs_desc_active; 74 char libzfs_action[1024]; 75 char libzfs_desc[1024]; 76 int libzfs_printerr; 77 int libzfs_storeerr; /* stuff error messages into buffer */ 78 void *libzfs_sharehdl; /* libshare handle */ 79 boolean_t libzfs_mnttab_enable; 80 /* 81 * We need a lock to handle the case where parallel mount 82 * threads are populating the mnttab cache simultaneously. The 83 * lock only protects the integrity of the avl tree, and does 84 * not protect the contents of the mnttab entries themselves. 85 */ 86 mutex_t libzfs_mnttab_cache_lock; 87 avl_tree_t libzfs_mnttab_cache; 88 int libzfs_pool_iter; 89 topo_hdl_t *libzfs_topo_hdl; 90 libzfs_fru_t **libzfs_fru_hash; 91 libzfs_fru_t *libzfs_fru_list; 92 char libzfs_chassis_id[256]; 93 boolean_t libzfs_prop_debug; 94 di_devlink_handle_t libzfs_devlink; 95 regex_t libzfs_urire; 96 uint64_t libzfs_max_nvlist; 97 }; 98 99 struct zfs_handle { 100 libzfs_handle_t *zfs_hdl; 101 zpool_handle_t *zpool_hdl; 102 char zfs_name[ZFS_MAX_DATASET_NAME_LEN]; 103 zfs_type_t zfs_type; /* type including snapshot */ 104 zfs_type_t zfs_head_type; /* type excluding snapshot */ 105 dmu_objset_stats_t zfs_dmustats; 106 nvlist_t *zfs_props; 107 nvlist_t *zfs_user_props; 108 nvlist_t *zfs_recvd_props; 109 boolean_t zfs_mntcheck; 110 char *zfs_mntopts; 111 uint8_t *zfs_props_table; 112 }; 113 114 /* 115 * This is different from checking zfs_type, because it will also catch 116 * snapshots of volumes. 117 */ 118 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME) 119 120 struct zpool_handle { 121 libzfs_handle_t *zpool_hdl; 122 zpool_handle_t *zpool_next; 123 char zpool_name[ZFS_MAX_DATASET_NAME_LEN]; 124 int zpool_state; 125 size_t zpool_config_size; 126 nvlist_t *zpool_config; 127 nvlist_t *zpool_old_config; 128 nvlist_t *zpool_props; 129 diskaddr_t zpool_start_block; 130 }; 131 132 typedef enum { 133 PROTO_NFS = 0, 134 PROTO_SMB = 1, 135 PROTO_END = 2 136 } zfs_share_proto_t; 137 138 /* 139 * The following can be used as a bitmask and any new values 140 * added must preserve that capability. 141 */ 142 typedef enum { 143 SHARED_NOT_SHARED = 0x0, 144 SHARED_NFS = 0x2, 145 SHARED_SMB = 0x4 146 } zfs_share_type_t; 147 148 149 /* 150 * From RFC3986 Appendix B. The regex is a bit of a beast, but with an 151 * example URI of: 152 * 153 * http://www.ics.uci.edu/pub/ietf/uri/#Related 154 * 155 * URI_REGEX should match with the following subexpressions: 156 * 157 * $1 = http: 158 * $2 = http 159 * $3 = //www.ics.uci.edu 160 * $4 = www.ics.uci.edu 161 * $5 = /pub/ietf/uri/ 162 * $6 = <undefined> 163 * $7 = <undefined> 164 * $8 = #Related 165 * $9 = Related 166 * 167 * More generally: 168 * 169 * scheme = $2 170 * authority = $4 171 * path = $5 172 * query = $7 173 * fragment = $9 174 * 175 * We only care about the value of the scheme component ($2) in order to 176 * invoke the correct handler. Each handler should do any additional URI 177 * validation as required. 178 */ 179 #define URI_REGEX \ 180 "^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?" 181 #define URI_NMATCH 10 /* whole URI match ($0) + 9 subexps */ 182 #define URI_SCHEMESUBEXP 2 /* '$2' */ 183 184 typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *, 185 const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *); 186 187 typedef struct zfs_uri_handler { 188 const char *zuh_scheme; 189 zfs_uri_handler_fn_t zuh_handler; 190 } zfs_uri_handler_t; 191 192 #define CONFIG_BUF_MINSIZE 262144 193 194 int zfs_error(libzfs_handle_t *, int, const char *); 195 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...); 196 void zfs_error_aux(libzfs_handle_t *, const char *, ...); 197 void *zfs_alloc(libzfs_handle_t *, size_t); 198 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t); 199 char *zfs_asprintf(libzfs_handle_t *, const char *, ...); 200 char *zfs_strdup(libzfs_handle_t *, const char *); 201 int no_memory(libzfs_handle_t *); 202 203 int zfs_standard_error(libzfs_handle_t *, int, const char *); 204 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 205 int zpool_standard_error(libzfs_handle_t *, int, const char *); 206 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 207 208 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***, 209 size_t *); 210 zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *); 211 zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *); 212 213 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t, 214 nvlist_t *, char **, uint64_t *, const char *); 215 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, 216 zfs_type_t type); 217 218 /* 219 * Use this changelist_gather() flag to force attempting mounts 220 * on each change node regardless of whether or not it is currently 221 * mounted. 222 */ 223 #define CL_GATHER_MOUNT_ALWAYS 1 224 225 typedef struct prop_changelist prop_changelist_t; 226 227 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t); 228 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 229 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 230 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *); 231 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **); 232 void zcmd_free_nvlists(zfs_cmd_t *); 233 234 int changelist_prefix(prop_changelist_t *); 235 int changelist_postfix(prop_changelist_t *); 236 void changelist_rename(prop_changelist_t *, const char *, const char *); 237 void changelist_remove(prop_changelist_t *, const char *); 238 void changelist_free(prop_changelist_t *); 239 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int); 240 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *); 241 int changelist_haszonedchild(prop_changelist_t *); 242 243 void remove_mountpoint(zfs_handle_t *); 244 int create_parents(libzfs_handle_t *, char *, int); 245 boolean_t isa_child_of(const char *dataset, const char *parent); 246 247 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *); 248 zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *, 249 nvlist_t *props); 250 251 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **); 252 253 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *); 254 255 int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type, 256 boolean_t modifying); 257 258 void namespace_clear(libzfs_handle_t *); 259 260 /* 261 * libshare (sharemgr) interfaces used internally. 262 */ 263 264 extern int zfs_init_libshare(libzfs_handle_t *, int); 265 extern int zfs_parse_options(char *, zfs_share_proto_t); 266 267 extern int zfs_unshare_proto(zfs_handle_t *, 268 const char *, zfs_share_proto_t *); 269 270 extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t); 271 272 #ifdef __cplusplus 273 } 274 #endif 275 276 #endif /* _LIBZFS_IMPL_H */ 277