cddl/contrib/opensolaris/lib/libzfs/common/libzfs_impl.h

   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  */
  25
  26 #ifndef _LIBFS_IMPL_H
  27 #define _LIBFS_IMPL_H
  28
  29 #include <sys/dmu.h>
  30 #include <sys/fs/zfs.h>
  31 #include <sys/zfs_ioctl.h>
  32 #include <sys/spa.h>
  33 #include <sys/nvpair.h>
  34
  35 #include <libshare.h>
  36 #include <libuutil.h>
  37 #include <libzfs.h>
  38
  39 #include "zfs_ioctl_compat.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 typedef struct libzfs_fru {
  51         char *zf_device;
  52         char *zf_fru;
  53         struct libzfs_fru *zf_chain;
  54         struct libzfs_fru *zf_next;
  55 } libzfs_fru_t;
  56
  57 struct libzfs_handle {
  58         int libzfs_error;
  59         int libzfs_fd;
  60         FILE *libzfs_mnttab;
  61         FILE *libzfs_sharetab;
  62         zpool_handle_t *libzfs_pool_handles;
  63         uu_avl_pool_t *libzfs_ns_avlpool;
  64         uu_avl_t *libzfs_ns_avl;
  65         uint64_t libzfs_ns_gen;
  66         int libzfs_desc_active;
  67         char libzfs_action[1024];
  68         char libzfs_desc[1024];
  69         char *libzfs_log_str;
  70         int libzfs_printerr;
  71         int libzfs_storeerr; /* stuff error messages into buffer */
  72         void *libzfs_sharehdl; /* libshare handle */
  73         uint_t libzfs_shareflags;
  74         boolean_t libzfs_mnttab_enable;
  75         avl_tree_t libzfs_mnttab_cache;
  76         int libzfs_pool_iter;
  77         libzfs_fru_t **libzfs_fru_hash;
  78         libzfs_fru_t *libzfs_fru_list;
  79         char libzfs_chassis_id[256];
  80 };
  81
  82 #define ZFSSHARE_MISS   0x01    /* Didn't find entry in cache */
  83
  84 struct zfs_handle {
  85         libzfs_handle_t *zfs_hdl;
  86         zpool_handle_t *zpool_hdl;
  87         char zfs_name[ZFS_MAXNAMELEN];
  88         zfs_type_t zfs_type; /* type including snapshot */
  89         zfs_type_t zfs_head_type; /* type excluding snapshot */
  90         dmu_objset_stats_t zfs_dmustats;
  91         nvlist_t *zfs_props;
  92         nvlist_t *zfs_user_props;
  93         nvlist_t *zfs_recvd_props;
  94         boolean_t zfs_mntcheck;
  95         char *zfs_mntopts;
  96         uint8_t *zfs_props_table;
  97 };
  98
  99 /*
 100  * This is different from checking zfs_type, because it will also catch
 101  * snapshots of volumes.
 102  */
 103 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
 104
 105 struct zpool_handle {
 106         libzfs_handle_t *zpool_hdl;
 107         zpool_handle_t *zpool_next;
 108         char zpool_name[ZPOOL_MAXNAMELEN];
 109         int zpool_state;
 110         size_t zpool_config_size;
 111         nvlist_t *zpool_config;
 112         nvlist_t *zpool_old_config;
 113         nvlist_t *zpool_props;
 114         diskaddr_t zpool_start_block;
 115 };
 116
 117 typedef  enum {
 118         PROTO_NFS = 0,
 119         PROTO_SMB = 1,
 120         PROTO_END = 2
 121 } zfs_share_proto_t;
 122
 123 /*
 124  * The following can be used as a bitmask and any new values
 125  * added must preserve that capability.
 126  */
 127 typedef enum {
 128         SHARED_NOT_SHARED = 0x0,
 129         SHARED_NFS = 0x2,
 130         SHARED_SMB = 0x4
 131 } zfs_share_type_t;
 132
 133 int zfs_error(libzfs_handle_t *, int, const char *);
 134 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
 135 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
 136 void *zfs_alloc(libzfs_handle_t *, size_t);
 137 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
 138 char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
 139 char *zfs_strdup(libzfs_handle_t *, const char *);
 140 int no_memory(libzfs_handle_t *);
 141
 142 int zfs_standard_error(libzfs_handle_t *, int, const char *);
 143 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 144 int zpool_standard_error(libzfs_handle_t *, int, const char *);
 145 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 146
 147 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
 148     size_t *);
 149
 150
 151 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
 152     nvlist_t *, char **, uint64_t *, const char *);
 153 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
 154     zfs_type_t type);
 155
 156 /*
 157  * Use this changelist_gather() flag to force attempting mounts
 158  * on each change node regardless of whether or not it is currently
 159  * mounted.
 160  */
 161 #define CL_GATHER_MOUNT_ALWAYS  1
 162
 163 typedef struct prop_changelist prop_changelist_t;
 164
 165 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
 166 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 167 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 168 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
 169 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
 170 void zcmd_free_nvlists(zfs_cmd_t *);
 171
 172 int changelist_prefix(prop_changelist_t *);
 173 int changelist_postfix(prop_changelist_t *);
 174 void changelist_rename(prop_changelist_t *, const char *, const char *);
 175 void changelist_remove(prop_changelist_t *, const char *);
 176 void changelist_free(prop_changelist_t *);
 177 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
 178 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
 179 int changelist_haszonedchild(prop_changelist_t *);
 180
 181 void remove_mountpoint(zfs_handle_t *);
 182 int create_parents(libzfs_handle_t *, char *, int);
 183 boolean_t isa_child_of(const char *dataset, const char *parent);
 184
 185 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
 186
 187 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
 188
 189 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
 190
 191 int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
 192     boolean_t modifying);
 193
 194 void namespace_clear(libzfs_handle_t *);
 195
 196 /*
 197  * libshare (sharemgr) interfaces used internally.
 198  */
 199
 200 extern int zfs_init_libshare(libzfs_handle_t *, int);
 201 extern void zfs_uninit_libshare(libzfs_handle_t *);
 202 extern int zfs_parse_options(char *, zfs_share_proto_t);
 203
 204 extern int zfs_unshare_proto(zfs_handle_t *,
 205     const char *, zfs_share_proto_t *);
 206
 207 extern void libzfs_fru_clear(libzfs_handle_t *, boolean_t);
 208
 209 #ifndef sun
 210 static int zfs_kernel_version = 0;
 211
 212 /*
 213  * This is FreeBSD version of ioctl, because Solaris' ioctl() updates
 214  * zc_nvlist_dst_size even if an error is returned, on FreeBSD if an
 215  * error is returned zc_nvlist_dst_size won't be updated.
 216  */
 217 static __inline int
 218 zcmd_ioctl(int fd, unsigned long cmd, zfs_cmd_t *zc)
 219 {
 220         size_t oldsize, zfs_kernel_version_size;
 221         int version, ret, cflag = ZFS_CMD_COMPAT_NONE;
 222
 223         zfs_kernel_version_size = sizeof(zfs_kernel_version);
 224         if (zfs_kernel_version == 0) {
 225                 sysctlbyname("vfs.zfs.version.spa", &zfs_kernel_version,
 226                     &zfs_kernel_version_size, NULL, 0);
 227         }
 228
 229         if (zfs_kernel_version == SPA_VERSION_15 ||
 230             zfs_kernel_version == SPA_VERSION_14 ||
 231             zfs_kernel_version == SPA_VERSION_13)
 232                 cflag = ZFS_CMD_COMPAT_V15;
 233
 234         oldsize = zc->zc_nvlist_dst_size;
 235         ret = zcmd_ioctl_compat(fd, cmd, zc, cflag);
 236
 237         if (ret == 0 && oldsize < zc->zc_nvlist_dst_size) {
 238                 ret = -1;
 239                 errno = ENOMEM;
 240         }
 241
 242         return (ret);
 243 }
 244 #define ioctl(fd, cmd, zc)      zcmd_ioctl((fd), (cmd), (zc))
 245 #endif  /* !sun */
 246
 247 #ifdef  __cplusplus
 248 }
 249 #endif
 250
 251 #endif  /* _LIBFS_IMPL_H */