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 2019 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 39 #include <libuutil.h> 40 #include <libzfs.h> 41 #include <libshare.h> 42 #include <libzfs_core.h> 43 #include <libdevinfo.h> 44 45 #include <fm/libtopo.h> 46 47 #ifdef __cplusplus 48 extern "C" { 49 #endif 50 51 #ifdef VERIFY 52 #undef VERIFY 53 #endif 54 #define VERIFY verify 55 56 typedef struct libzfs_fru { 57 char *zf_device; 58 char *zf_fru; 59 struct libzfs_fru *zf_chain; 60 struct libzfs_fru *zf_next; 61 } libzfs_fru_t; 62 63 struct libzfs_handle { 64 int libzfs_error; 65 int libzfs_fd; 66 FILE *libzfs_mnttab; 67 FILE *libzfs_sharetab; 68 zpool_handle_t *libzfs_pool_handles; 69 uu_avl_pool_t *libzfs_ns_avlpool; 70 uu_avl_t *libzfs_ns_avl; 71 uint64_t libzfs_ns_gen; 72 int libzfs_desc_active; 73 char libzfs_action[1024]; 74 char libzfs_desc[1024]; 75 int libzfs_printerr; 76 int libzfs_storeerr; /* stuff error messages into buffer */ 77 void *libzfs_sharehdl; /* libshare handle */ 78 boolean_t libzfs_mnttab_enable; 79 /* 80 * We need a lock to handle the case where parallel mount 81 * threads are populating the mnttab cache simultaneously. The 82 * lock only protects the integrity of the avl tree, and does 83 * not protect the contents of the mnttab entries themselves. 84 */ 85 mutex_t libzfs_mnttab_cache_lock; 86 avl_tree_t libzfs_mnttab_cache; 87 int libzfs_pool_iter; 88 topo_hdl_t *libzfs_topo_hdl; 89 libzfs_fru_t **libzfs_fru_hash; 90 libzfs_fru_t *libzfs_fru_list; 91 char libzfs_chassis_id[256]; 92 boolean_t libzfs_prop_debug; 93 di_devlink_handle_t libzfs_devlink; 94 }; 95 96 struct zfs_handle { 97 libzfs_handle_t *zfs_hdl; 98 zpool_handle_t *zpool_hdl; 99 char zfs_name[ZFS_MAX_DATASET_NAME_LEN]; 100 zfs_type_t zfs_type; /* type including snapshot */ 101 zfs_type_t zfs_head_type; /* type excluding snapshot */ 102 dmu_objset_stats_t zfs_dmustats; 103 nvlist_t *zfs_props; 104 nvlist_t *zfs_user_props; 105 nvlist_t *zfs_recvd_props; 106 boolean_t zfs_mntcheck; 107 char *zfs_mntopts; 108 uint8_t *zfs_props_table; 109 }; 110 111 /* 112 * This is different from checking zfs_type, because it will also catch 113 * snapshots of volumes. 114 */ 115 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME) 116 117 struct zpool_handle { 118 libzfs_handle_t *zpool_hdl; 119 zpool_handle_t *zpool_next; 120 char zpool_name[ZFS_MAX_DATASET_NAME_LEN]; 121 int zpool_state; 122 size_t zpool_config_size; 123 nvlist_t *zpool_config; 124 nvlist_t *zpool_old_config; 125 nvlist_t *zpool_props; 126 diskaddr_t zpool_start_block; 127 }; 128 129 typedef enum { 130 PROTO_NFS = 0, 131 PROTO_SMB = 1, 132 PROTO_END = 2 133 } zfs_share_proto_t; 134 135 /* 136 * The following can be used as a bitmask and any new values 137 * added must preserve that capability. 138 */ 139 typedef enum { 140 SHARED_NOT_SHARED = 0x0, 141 SHARED_NFS = 0x2, 142 SHARED_SMB = 0x4 143 } zfs_share_type_t; 144 145 #define CONFIG_BUF_MINSIZE 262144 146 147 int zfs_error(libzfs_handle_t *, int, const char *); 148 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...); 149 void zfs_error_aux(libzfs_handle_t *, const char *, ...); 150 void *zfs_alloc(libzfs_handle_t *, size_t); 151 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t); 152 char *zfs_asprintf(libzfs_handle_t *, const char *, ...); 153 char *zfs_strdup(libzfs_handle_t *, const char *); 154 int no_memory(libzfs_handle_t *); 155 156 int zfs_standard_error(libzfs_handle_t *, int, const char *); 157 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 158 int zpool_standard_error(libzfs_handle_t *, int, const char *); 159 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 160 161 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***, 162 size_t *); 163 zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *); 164 zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *); 165 166 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t, 167 nvlist_t *, char **, uint64_t *, const char *); 168 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, 169 zfs_type_t type); 170 171 /* 172 * Use this changelist_gather() flag to force attempting mounts 173 * on each change node regardless of whether or not it is currently 174 * mounted. 175 */ 176 #define CL_GATHER_MOUNT_ALWAYS 1 177 178 typedef struct prop_changelist prop_changelist_t; 179 180 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t); 181 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 182 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 183 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *); 184 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **); 185 void zcmd_free_nvlists(zfs_cmd_t *); 186 187 int changelist_prefix(prop_changelist_t *); 188 int changelist_postfix(prop_changelist_t *); 189 void changelist_rename(prop_changelist_t *, const char *, const char *); 190 void changelist_remove(prop_changelist_t *, const char *); 191 void changelist_free(prop_changelist_t *); 192 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int); 193 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *); 194 int changelist_haszonedchild(prop_changelist_t *); 195 196 void remove_mountpoint(zfs_handle_t *); 197 int create_parents(libzfs_handle_t *, char *, int); 198 boolean_t isa_child_of(const char *dataset, const char *parent); 199 200 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *); 201 zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *, 202 nvlist_t *props); 203 204 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **); 205 206 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *); 207 208 int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type, 209 boolean_t modifying); 210 211 void namespace_clear(libzfs_handle_t *); 212 213 /* 214 * libshare (sharemgr) interfaces used internally. 215 */ 216 217 extern int zfs_init_libshare(libzfs_handle_t *, int); 218 extern int zfs_parse_options(char *, zfs_share_proto_t); 219 220 extern int zfs_unshare_proto(zfs_handle_t *, 221 const char *, zfs_share_proto_t *); 222 223 extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t); 224 225 #ifdef __cplusplus 226 } 227 #endif 228 229 #endif /* _LIBZFS_IMPL_H */ 230