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  * Copyright (c) 2011, 2015 by Delphix. All rights reserved.
  25  */
  26
  27 #ifndef _LIBZFS_IMPL_H
  28 #define _LIBZFS_IMPL_H
  29
  30 #include <sys/fs/zfs.h>
  31 #include <sys/spa.h>
  32 #include <sys/nvpair.h>
  33 #include <sys/dmu.h>
  34 #include <sys/zfs_ioctl.h>
  35
  36 #include <libuutil.h>
  37 #include <libzfs.h>
  38 #include <libshare.h>
  39 #include <libzfs_core.h>
  40
  41 #if defined(HAVE_LIBTOPO)
  42 #include <fm/libtopo.h>
  43 #endif /* HAVE_LIBTOPO */
  44
  45 #ifdef  __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 typedef struct libzfs_fru {
  50         char *zf_device;
  51         char *zf_fru;
  52         struct libzfs_fru *zf_chain;
  53         struct libzfs_fru *zf_next;
  54 } libzfs_fru_t;
  55
  56 struct libzfs_handle {
  57         int libzfs_error;
  58         int libzfs_fd;
  59         FILE *libzfs_mnttab;
  60         FILE *libzfs_sharetab;
  61         zpool_handle_t *libzfs_pool_handles;
  62         uu_avl_pool_t *libzfs_ns_avlpool;
  63         uu_avl_t *libzfs_ns_avl;
  64         uint64_t libzfs_ns_gen;
  65         int libzfs_desc_active;
  66         char libzfs_action[1024];
  67         char libzfs_desc[1024];
  68         int libzfs_printerr;
  69         int libzfs_storeerr; /* stuff error messages into buffer */
  70         void *libzfs_sharehdl; /* libshare handle */
  71         uint_t libzfs_shareflags;
  72         boolean_t libzfs_mnttab_enable;
  73         avl_tree_t libzfs_mnttab_cache;
  74         int libzfs_pool_iter;
  75 #if defined(HAVE_LIBTOPO)
  76         topo_hdl_t *libzfs_topo_hdl;
  77         libzfs_fru_t **libzfs_fru_hash;
  78         libzfs_fru_t *libzfs_fru_list;
  79 #endif /* HAVE_LIBTOPO */
  80         char libzfs_chassis_id[256];
  81 };
  82
  83 #define ZFSSHARE_MISS   0x01    /* Didn't find entry in cache */
  84
  85 struct zfs_handle {
  86         libzfs_handle_t *zfs_hdl;
  87         zpool_handle_t *zpool_hdl;
  88         char zfs_name[ZFS_MAX_DATASET_NAME_LEN];
  89         zfs_type_t zfs_type; /* type including snapshot */
  90         zfs_type_t zfs_head_type; /* type excluding snapshot */
  91         dmu_objset_stats_t zfs_dmustats;
  92         nvlist_t *zfs_props;
  93         nvlist_t *zfs_user_props;
  94         nvlist_t *zfs_recvd_props;
  95         boolean_t zfs_mntcheck;
  96         char *zfs_mntopts;
  97         uint8_t *zfs_props_table;
  98 };
  99
 100 /*
 101  * This is different from checking zfs_type, because it will also catch
 102  * snapshots of volumes.
 103  */
 104 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
 105
 106 struct zpool_handle {
 107         libzfs_handle_t *zpool_hdl;
 108         zpool_handle_t *zpool_next;
 109         char zpool_name[ZFS_MAX_DATASET_NAME_LEN];
 110         int zpool_state;
 111         size_t zpool_config_size;
 112         nvlist_t *zpool_config;
 113         nvlist_t *zpool_old_config;
 114         nvlist_t *zpool_props;
 115         diskaddr_t zpool_start_block;
 116 };
 117
 118 typedef enum {
 119         PROTO_NFS = 0,
 120         PROTO_SMB = 1,
 121         PROTO_END = 2
 122 } zfs_share_proto_t;
 123
 124 /*
 125  * The following can be used as a bitmask and any new values
 126  * added must preserve that capability.
 127  */
 128 typedef enum {
 129         SHARED_NOT_SHARED = 0x0,
 130         SHARED_NFS = 0x2,
 131         SHARED_SMB = 0x4
 132 } zfs_share_type_t;
 133
 134 #define CONFIG_BUF_MINSIZE      65536
 135
 136 int zfs_error(libzfs_handle_t *, int, const char *);
 137 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
 138 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
 139 void *zfs_alloc(libzfs_handle_t *, size_t);
 140 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
 141 char *zfs_asprintf(libzfs_handle_t *, const char *, ...);
 142 char *zfs_strdup(libzfs_handle_t *, const char *);
 143 int no_memory(libzfs_handle_t *);
 144
 145 int zfs_standard_error(libzfs_handle_t *, int, const char *);
 146 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 147 int zpool_standard_error(libzfs_handle_t *, int, const char *);
 148 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 149
 150 zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
 151 zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
 152
 153 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
 154     nvlist_t *, char **, uint64_t *, const char *);
 155 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
 156     zfs_type_t type);
 157
 158 /*
 159  * Use this changelist_gather() flag to force attempting mounts
 160  * on each change node regardless of whether or not it is currently
 161  * mounted.
 162  */
 163 #define CL_GATHER_MOUNT_ALWAYS  1
 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 */