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