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