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 2008 Sun Microsystems, Inc. All rights reserved. 24 * Use is subject to license terms. 25 */ 26 27 #ifndef _LIBFS_IMPL_H 28 #define _LIBFS_IMPL_H 29 30 #include <sys/dmu.h> 31 #include <sys/fs/zfs.h> 32 #include <sys/zfs_ioctl.h> 33 #include <sys/zfs_acl.h> 34 #include <sys/spa.h> 35 #include <sys/nvpair.h> 36 37 #include <libuutil.h> 38 #include <libzfs.h> 39 #include <libshare.h> 40 41 #ifdef __cplusplus 42 extern "C" { 43 #endif 44 45 #ifdef VERIFY 46 #undef VERIFY 47 #endif 48 #define VERIFY verify 49 50 struct libzfs_handle { 51 int libzfs_error; 52 int libzfs_fd; 53 FILE *libzfs_mnttab; 54 FILE *libzfs_sharetab; 55 zpool_handle_t *libzfs_pool_handles; 56 uu_avl_pool_t *libzfs_ns_avlpool; 57 uu_avl_t *libzfs_ns_avl; 58 uint64_t libzfs_ns_gen; 59 int libzfs_desc_active; 60 char libzfs_action[1024]; 61 char libzfs_desc[1024]; 62 char *libzfs_log_str; 63 int libzfs_printerr; 64 void *libzfs_sharehdl; /* libshare handle */ 65 uint_t libzfs_shareflags; 66 }; 67 #define ZFSSHARE_MISS 0x01 /* Didn't find entry in cache */ 68 69 struct zfs_handle { 70 libzfs_handle_t *zfs_hdl; 71 zpool_handle_t *zpool_hdl; 72 char zfs_name[ZFS_MAXNAMELEN]; 73 zfs_type_t zfs_type; /* type including snapshot */ 74 zfs_type_t zfs_head_type; /* type excluding snapshot */ 75 dmu_objset_stats_t zfs_dmustats; 76 nvlist_t *zfs_props; 77 nvlist_t *zfs_user_props; 78 boolean_t zfs_mntcheck; 79 char *zfs_mntopts; 80 }; 81 82 /* 83 * This is different from checking zfs_type, because it will also catch 84 * snapshots of volumes. 85 */ 86 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME) 87 88 struct zpool_handle { 89 libzfs_handle_t *zpool_hdl; 90 zpool_handle_t *zpool_next; 91 char zpool_name[ZPOOL_MAXNAMELEN]; 92 int zpool_state; 93 size_t zpool_config_size; 94 nvlist_t *zpool_config; 95 nvlist_t *zpool_old_config; 96 nvlist_t *zpool_props; 97 diskaddr_t zpool_start_block; 98 }; 99 100 typedef enum { 101 PROTO_NFS = 0, 102 PROTO_SMB = 1, 103 PROTO_END = 2 104 } zfs_share_proto_t; 105 106 /* 107 * The following can be used as a bitmask and any new values 108 * added must preserve that capability. 109 */ 110 typedef enum { 111 SHARED_NOT_SHARED = 0x0, 112 SHARED_ISCSI = 0x1, 113 SHARED_NFS = 0x2, 114 SHARED_SMB = 0x4 115 } zfs_share_type_t; 116 117 int zfs_error(libzfs_handle_t *, int, const char *); 118 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...); 119 void zfs_error_aux(libzfs_handle_t *, const char *, ...); 120 void *zfs_alloc(libzfs_handle_t *, size_t); 121 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t); 122 char *zfs_strdup(libzfs_handle_t *, const char *); 123 int no_memory(libzfs_handle_t *); 124 125 int zfs_standard_error(libzfs_handle_t *, int, const char *); 126 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 127 int zpool_standard_error(libzfs_handle_t *, int, const char *); 128 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...); 129 130 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***, 131 size_t *); 132 133 134 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t, 135 nvlist_t *, char **, uint64_t *, const char *); 136 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, 137 zfs_type_t type); 138 139 /* 140 * Use this changelist_gather() flag to force attempting mounts 141 * on each change node regardless of whether or not it is currently 142 * mounted. 143 */ 144 #define CL_GATHER_MOUNT_ALWAYS 1 145 146 typedef struct prop_changelist prop_changelist_t; 147 148 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t); 149 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 150 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *); 151 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *); 152 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **); 153 void zcmd_free_nvlists(zfs_cmd_t *); 154 155 int changelist_prefix(prop_changelist_t *); 156 int changelist_postfix(prop_changelist_t *); 157 void changelist_rename(prop_changelist_t *, const char *, const char *); 158 void changelist_remove(prop_changelist_t *, const char *); 159 void changelist_free(prop_changelist_t *); 160 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int); 161 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *); 162 int changelist_haszonedchild(prop_changelist_t *); 163 164 void remove_mountpoint(zfs_handle_t *); 165 int create_parents(libzfs_handle_t *, char *, int); 166 boolean_t isa_child_of(const char *dataset, const char *parent); 167 168 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *); 169 170 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **); 171 172 int zvol_create_link(libzfs_handle_t *, const char *); 173 int zvol_remove_link(libzfs_handle_t *, const char *); 174 int zpool_iter_zvol(zpool_handle_t *, int (*)(const char *, void *), void *); 175 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *); 176 177 void namespace_clear(libzfs_handle_t *); 178 179 /* 180 * libshare (sharemgr) interfaces used internally. 181 */ 182 183 extern int zfs_init_libshare(libzfs_handle_t *, int); 184 extern void zfs_uninit_libshare(libzfs_handle_t *); 185 extern int zfs_parse_options(char *, zfs_share_proto_t); 186 187 extern int zfs_unshare_proto(zfs_handle_t *zhp, 188 const char *, zfs_share_proto_t *); 189 #ifdef __cplusplus 190 } 191 #endif 192 193 #endif /* _LIBFS_IMPL_H */ 194