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