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