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 2009 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 <libshare.h>
  38 #include <libuutil.h>
  39 #include <libzfs.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         uint8_t *zfs_props_table;
  81 };
  82
  83 /*
  84  * This is different from checking zfs_type, because it will also catch
  85  * snapshots of volumes.
  86  */
  87 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
  88
  89 struct zpool_handle {
  90         libzfs_handle_t *zpool_hdl;
  91         zpool_handle_t *zpool_next;
  92         char zpool_name[ZPOOL_MAXNAMELEN];
  93         int zpool_state;
  94         size_t zpool_config_size;
  95         nvlist_t *zpool_config;
  96         nvlist_t *zpool_old_config;
  97         nvlist_t *zpool_props;
  98         diskaddr_t zpool_start_block;
  99 };
 100
 101 typedef  enum {
 102         PROTO_NFS = 0,
 103         PROTO_SMB = 1,
 104         PROTO_END = 2
 105 } zfs_share_proto_t;
 106
 107 /*
 108  * The following can be used as a bitmask and any new values
 109  * added must preserve that capability.
 110  */
 111 typedef enum {
 112         SHARED_NOT_SHARED = 0x0,
 113         SHARED_ISCSI = 0x1,
 114         SHARED_NFS = 0x2,
 115         SHARED_SMB = 0x4
 116 } zfs_share_type_t;
 117
 118 int zfs_error(libzfs_handle_t *, int, const char *);
 119 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
 120 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
 121 void *zfs_alloc(libzfs_handle_t *, size_t);
 122 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
 123 char *zfs_strdup(libzfs_handle_t *, const char *);
 124 int no_memory(libzfs_handle_t *);
 125
 126 int zfs_standard_error(libzfs_handle_t *, int, const char *);
 127 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 128 int zpool_standard_error(libzfs_handle_t *, int, const char *);
 129 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 130
 131 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
 132     size_t *);
 133
 134
 135 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
 136     nvlist_t *, char **, uint64_t *, const char *);
 137 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
 138     zfs_type_t type);
 139
 140 /*
 141  * Use this changelist_gather() flag to force attempting mounts
 142  * on each change node regardless of whether or not it is currently
 143  * mounted.
 144  */
 145 #define CL_GATHER_MOUNT_ALWAYS  1
 146
 147 typedef struct prop_changelist prop_changelist_t;
 148
 149 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
 150 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 151 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 152 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
 153 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
 154 void zcmd_free_nvlists(zfs_cmd_t *);
 155
 156 int changelist_prefix(prop_changelist_t *);
 157 int changelist_postfix(prop_changelist_t *);
 158 void changelist_rename(prop_changelist_t *, const char *, const char *);
 159 void changelist_remove(prop_changelist_t *, const char *);
 160 void changelist_free(prop_changelist_t *);
 161 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
 162 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
 163 int changelist_haszonedchild(prop_changelist_t *);
 164
 165 void remove_mountpoint(zfs_handle_t *);
 166 int create_parents(libzfs_handle_t *, char *, int);
 167 boolean_t isa_child_of(const char *dataset, const char *parent);
 168
 169 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
 170
 171 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
 172
 173 int zvol_create_link(libzfs_handle_t *, const char *);
 174 int zvol_remove_link(libzfs_handle_t *, const char *);
 175 int zpool_iter_zvol(zpool_handle_t *, int (*)(const char *, void *), void *);
 176 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
 177
 178 void namespace_clear(libzfs_handle_t *);
 179
 180 /*
 181  * libshare (sharemgr) interfaces used internally.
 182  */
 183
 184 extern int zfs_init_libshare(libzfs_handle_t *, int);
 185 extern void zfs_uninit_libshare(libzfs_handle_t *);
 186 extern int zfs_parse_options(char *, zfs_share_proto_t);
 187
 188 extern int zfs_unshare_proto(zfs_handle_t *zhp,
 189     const char *, zfs_share_proto_t *);
 190
 191 #ifdef  __FreeBSD__
 192
 193 /*
 194  * This is FreeBSD version of ioctl, because Solaris' ioctl() updates
 195  * zc_nvlist_dst_size even if an error is returned, on FreeBSD if an
 196  * error is returned zc_nvlist_dst_size won't be updated.
 197  */
 198 static __inline int
 199 zcmd_ioctl(int fd, unsigned long cmd, zfs_cmd_t *zc)
 200 {
 201         size_t oldsize;
 202         int ret;
 203
 204         oldsize = zc->zc_nvlist_dst_size;
 205         ret = ioctl(fd, cmd, zc);
 206         if (ret == 0 && oldsize < zc->zc_nvlist_dst_size) {
 207                 ret = -1;
 208                 errno = ENOMEM;
 209         }
 210
 211         return (ret);
 212 }
 213 #define ioctl(fd, cmd, zc)      zcmd_ioctl((fd), (cmd), (zc))
 214 #endif
 215
 216 #ifdef  __cplusplus
 217 }
 218 #endif
 219
 220 #endif  /* _LIBFS_IMPL_H */