lib/libzfs/libzfs_impl.h

   1 /*
   2  * CDDL HEADER START
   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 https://opensource.org/licenses/CDDL-1.0.
  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, 2020 by Delphix. All rights reserved.
  25  * Copyright (c) 2018 Datto Inc.
  26  * Copyright 2020 Joyent, Inc.
  27  */
  28
  29 #ifndef _LIBZFS_IMPL_H
  30 #define _LIBZFS_IMPL_H
  31
  32 #include <sys/fs/zfs.h>
  33 #include <sys/nvpair.h>
  34 #include <sys/dmu.h>
  35 #include <sys/zfs_ioctl.h>
  36 #include <regex.h>
  37
  38 #include <libuutil.h>
  39 #include <libzfs.h>
  40 #include <libshare.h>
  41 #include <libzfs_core.h>
  42
  43 #ifdef  __cplusplus
  44 extern "C" {
  45 #endif
  46
  47 #define ERRBUFLEN 1024
  48
  49 struct libzfs_handle {
  50         int libzfs_error;
  51         int libzfs_fd;
  52         zpool_handle_t *libzfs_pool_handles;
  53         uu_avl_pool_t *libzfs_ns_avlpool;
  54         uu_avl_t *libzfs_ns_avl;
  55         uint64_t libzfs_ns_gen;
  56         int libzfs_desc_active;
  57         char libzfs_action[1024];
  58         char libzfs_desc[1024];
  59         int libzfs_printerr;
  60         boolean_t libzfs_mnttab_enable;
  61         /*
  62          * We need a lock to handle the case where parallel mount
  63          * threads are populating the mnttab cache simultaneously. The
  64          * lock only protects the integrity of the avl tree, and does
  65          * not protect the contents of the mnttab entries themselves.
  66          */
  67         pthread_mutex_t libzfs_mnttab_cache_lock;
  68         avl_tree_t libzfs_mnttab_cache;
  69         int libzfs_pool_iter;
  70         boolean_t libzfs_prop_debug;
  71         regex_t libzfs_urire;
  72         uint64_t libzfs_max_nvlist;
  73         void *libfetch;
  74         char *libfetch_load_error;
  75 };
  76
  77 struct zfs_handle {
  78         libzfs_handle_t *zfs_hdl;
  79         zpool_handle_t *zpool_hdl;
  80         char zfs_name[ZFS_MAX_DATASET_NAME_LEN];
  81         zfs_type_t zfs_type; /* type including snapshot */
  82         zfs_type_t zfs_head_type; /* type excluding snapshot */
  83         dmu_objset_stats_t zfs_dmustats;
  84         nvlist_t *zfs_props;
  85         nvlist_t *zfs_user_props;
  86         nvlist_t *zfs_recvd_props;
  87         boolean_t zfs_mntcheck;
  88         char *zfs_mntopts;
  89         uint8_t *zfs_props_table;
  90 };
  91
  92 /*
  93  * This is different from checking zfs_type, because it will also catch
  94  * snapshots of volumes.
  95  */
  96 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
  97 #define ZHP_MAX_PROPNAMES 4
  98
  99 struct zpool_handle {
 100         libzfs_handle_t *zpool_hdl;
 101         zpool_handle_t *zpool_next;
 102         char zpool_name[ZFS_MAX_DATASET_NAME_LEN];
 103         int zpool_state;
 104         unsigned int zpool_n_propnames;
 105         const char *zpool_propnames[ZHP_MAX_PROPNAMES];
 106         size_t zpool_config_size;
 107         nvlist_t *zpool_config;
 108         nvlist_t *zpool_old_config;
 109         nvlist_t *zpool_props;
 110         diskaddr_t zpool_start_block;
 111 };
 112
 113 typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *,
 114     const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *);
 115
 116 typedef struct zfs_uri_handler {
 117         const char *zuh_scheme;
 118         zfs_uri_handler_fn_t zuh_handler;
 119 } zfs_uri_handler_t;
 120
 121 #define CONFIG_BUF_MINSIZE      262144
 122
 123 extern int zfs_error(libzfs_handle_t *, int, const char *);
 124 extern int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...)
 125     __attribute__((format(printf, 3, 4)));
 126 extern void zfs_error_aux(libzfs_handle_t *, const char *, ...)
 127     __attribute__((format(printf, 2, 3)));
 128 extern void *zfs_alloc(libzfs_handle_t *, size_t);
 129 extern void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
 130 extern char *zfs_asprintf(libzfs_handle_t *, const char *, ...)
 131     __attribute__((format(printf, 2, 3)));
 132 extern char *zfs_strdup(libzfs_handle_t *, const char *);
 133 extern int no_memory(libzfs_handle_t *);
 134
 135 extern int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...)
 136     __attribute__((format(printf, 3, 4)));
 137 extern void zfs_setprop_error(libzfs_handle_t *, zfs_prop_t, int, char *);
 138 extern int zpool_standard_error(libzfs_handle_t *, int, const char *);
 139 extern int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...)
 140     __attribute__((format(printf, 3, 4)));
 141
 142 extern zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
 143 extern zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
 144
 145 extern int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
 146     nvlist_t *, const char **, uint64_t *, const char *);
 147 extern int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
 148     zfs_type_t type);
 149
 150 /*
 151  * Use this changelist_gather() flag to force attempting mounts
 152  * on each change node regardless of whether or not it is currently
 153  * mounted.
 154  */
 155 #define CL_GATHER_MOUNT_ALWAYS  1
 156 /*
 157  * changelist_gather() flag to force it to iterate on mounted datasets only
 158  */
 159 #define CL_GATHER_ITER_MOUNTED  2
 160 /*
 161  * Use this changelist_gather() flag to prevent unmounting of file systems.
 162  */
 163 #define CL_GATHER_DONT_UNMOUNT  4
 164
 165 typedef struct prop_changelist prop_changelist_t;
 166
 167 extern void zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
 168 extern void zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 169 extern void zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 170 extern void zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
 171 extern int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
 172 extern void zcmd_free_nvlists(zfs_cmd_t *);
 173
 174 extern int changelist_prefix(prop_changelist_t *);
 175 extern int changelist_postfix(prop_changelist_t *);
 176 extern void changelist_rename(prop_changelist_t *, const char *, const char *);
 177 extern void changelist_remove(prop_changelist_t *, const char *);
 178 extern void changelist_free(prop_changelist_t *);
 179 extern prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int,
 180     int);
 181 extern int changelist_unshare(prop_changelist_t *, const enum sa_protocol *);
 182 extern int changelist_haszonedchild(prop_changelist_t *);
 183
 184 extern void remove_mountpoint(zfs_handle_t *);
 185 extern int create_parents(libzfs_handle_t *, char *, int);
 186
 187 extern zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
 188 extern zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
 189     nvlist_t *props);
 190
 191 extern int zpool_open_silent(libzfs_handle_t *, const char *,
 192     zpool_handle_t **);
 193
 194 extern boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
 195
 196 extern int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
 197     boolean_t modifying);
 198
 199 extern void namespace_clear(libzfs_handle_t *);
 200
 201 typedef struct {
 202         zfs_prop_t p_prop;
 203         int p_share_err;
 204         int p_unshare_err;
 205 } proto_table_t;
 206
 207 typedef struct differ_info {
 208         zfs_handle_t *zhp;
 209         char *fromsnap;
 210         char *frommnt;
 211         char *tosnap;
 212         char *tomnt;
 213         char *ds;
 214         char *dsmnt;
 215         char *tmpsnap;
 216         char errbuf[ERRBUFLEN];
 217         boolean_t isclone;
 218         boolean_t scripted;
 219         boolean_t classify;
 220         boolean_t timestamped;
 221         boolean_t no_mangle;
 222         uint64_t shares;
 223         int zerr;
 224         int cleanupfd;
 225         int outputfd;
 226         int datafd;
 227 } differ_info_t;
 228
 229 extern int do_mount(zfs_handle_t *zhp, const char *mntpt, const char *opts,
 230     int flags);
 231 extern int do_unmount(zfs_handle_t *zhp, const char *mntpt, int flags);
 232 extern int libzfs_load_module(void);
 233 extern int zpool_relabel_disk(libzfs_handle_t *hdl, const char *path,
 234     const char *msg);
 235 extern int find_shares_object(differ_info_t *di);
 236
 237 #ifdef  __cplusplus
 238 }
 239 #endif
 240
 241 #endif  /* _LIBZFS_IMPL_H */