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