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