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