include/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 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, 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/spa.h>
  34 #include <sys/nvpair.h>
  35 #include <sys/dmu.h>
  36 #include <sys/zfs_ioctl.h>
  37 #include <regex.h>
  38
  39 #include <libuutil.h>
  40 #include <libzfs.h>
  41 #include <libshare.h>
  42 #include <libzfs_core.h>
  43
  44 #ifdef  __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 struct libzfs_handle {
  49         int libzfs_error;
  50         int libzfs_fd;
  51         FILE *libzfs_mnttab;
  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         int libzfs_storeerr; /* stuff error messages into buffer */
  61         boolean_t libzfs_mnttab_enable;
  62         /*
  63          * We need a lock to handle the case where parallel mount
  64          * threads are populating the mnttab cache simultaneously. The
  65          * lock only protects the integrity of the avl tree, and does
  66          * not protect the contents of the mnttab entries themselves.
  67          */
  68         pthread_mutex_t libzfs_mnttab_cache_lock;
  69         avl_tree_t libzfs_mnttab_cache;
  70         int libzfs_pool_iter;
  71         char libzfs_chassis_id[256];
  72         boolean_t libzfs_prop_debug;
  73         regex_t libzfs_urire;
  74         uint64_t libzfs_max_nvlist;
  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
  98 struct zpool_handle {
  99         libzfs_handle_t *zpool_hdl;
 100         zpool_handle_t *zpool_next;
 101         char zpool_name[ZFS_MAX_DATASET_NAME_LEN];
 102         int zpool_state;
 103         size_t zpool_config_size;
 104         nvlist_t *zpool_config;
 105         nvlist_t *zpool_old_config;
 106         nvlist_t *zpool_props;
 107         diskaddr_t zpool_start_block;
 108 };
 109
 110 typedef enum {
 111         PROTO_NFS = 0,
 112         PROTO_SMB = 1,
 113         PROTO_END = 2
 114 } zfs_share_proto_t;
 115
 116 /*
 117  * The following can be used as a bitmask and any new values
 118  * added must preserve that capability.
 119  */
 120 typedef enum {
 121         SHARED_NOT_SHARED = 0x0,
 122         SHARED_NFS = 0x2,
 123         SHARED_SMB = 0x4
 124 } zfs_share_type_t;
 125
 126 typedef int (*zfs_uri_handler_fn_t)(struct libzfs_handle *, const char *,
 127     const char *, zfs_keyformat_t, boolean_t, uint8_t **, size_t *);
 128
 129 typedef struct zfs_uri_handler {
 130         const char *zuh_scheme;
 131         zfs_uri_handler_fn_t zuh_handler;
 132 } zfs_uri_handler_t;
 133
 134 #define CONFIG_BUF_MINSIZE      262144
 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 void zfs_setprop_error(libzfs_handle_t *, zfs_prop_t, int, char *);
 148 int zpool_standard_error(libzfs_handle_t *, int, const char *);
 149 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 150
 151 zfs_handle_t *make_dataset_handle_zc(libzfs_handle_t *, zfs_cmd_t *);
 152 zfs_handle_t *make_dataset_simple_handle_zc(zfs_handle_t *, zfs_cmd_t *);
 153
 154 int zprop_parse_value(libzfs_handle_t *, nvpair_t *, int, zfs_type_t,
 155     nvlist_t *, char **, uint64_t *, const char *);
 156 int zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp,
 157     zfs_type_t type);
 158
 159 /*
 160  * Use this changelist_gather() flag to force attempting mounts
 161  * on each change node regardless of whether or not it is currently
 162  * mounted.
 163  */
 164 #define CL_GATHER_MOUNT_ALWAYS  1
 165 /*
 166  * changelist_gather() flag to force it to iterate on mounted datasets only
 167  */
 168 #define CL_GATHER_ITER_MOUNTED  2
 169 /*
 170  * Use this changelist_gather() flag to prevent unmounting of file systems.
 171  */
 172 #define CL_GATHER_DONT_UNMOUNT  4
 173
 174 typedef struct prop_changelist prop_changelist_t;
 175
 176 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
 177 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 178 int zcmd_write_conf_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *);
 179 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
 180 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
 181 void zcmd_free_nvlists(zfs_cmd_t *);
 182
 183 int changelist_prefix(prop_changelist_t *);
 184 int changelist_postfix(prop_changelist_t *);
 185 void changelist_rename(prop_changelist_t *, const char *, const char *);
 186 void changelist_remove(prop_changelist_t *, const char *);
 187 void changelist_free(prop_changelist_t *);
 188 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int, int);
 189 int changelist_unshare(prop_changelist_t *, zfs_share_proto_t *);
 190 int changelist_haszonedchild(prop_changelist_t *);
 191
 192 void remove_mountpoint(zfs_handle_t *);
 193 int create_parents(libzfs_handle_t *, char *, int);
 194 boolean_t isa_child_of(const char *dataset, const char *parent);
 195
 196 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
 197 zfs_handle_t *make_bookmark_handle(zfs_handle_t *, const char *,
 198     nvlist_t *props);
 199
 200 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
 201
 202 boolean_t zpool_name_valid(libzfs_handle_t *, boolean_t, const char *);
 203
 204 int zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
 205     boolean_t modifying);
 206
 207 void namespace_clear(libzfs_handle_t *);
 208
 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 typedef struct {
 215         zfs_prop_t p_prop;
 216         char *p_name;
 217         int p_share_err;
 218         int p_unshare_err;
 219 } proto_table_t;
 220
 221 typedef struct differ_info {
 222         zfs_handle_t *zhp;
 223         char *fromsnap;
 224         char *frommnt;
 225         char *tosnap;
 226         char *tomnt;
 227         char *ds;
 228         char *dsmnt;
 229         char *tmpsnap;
 230         char errbuf[1024];
 231         boolean_t isclone;
 232         boolean_t scripted;
 233         boolean_t classify;
 234         boolean_t timestamped;
 235         uint64_t shares;
 236         int zerr;
 237         int cleanupfd;
 238         int outputfd;
 239         int datafd;
 240 } differ_info_t;
 241
 242 extern proto_table_t proto_table[PROTO_END];
 243
 244 extern int do_mount(zfs_handle_t *zhp, const char *mntpt, char *opts,
 245     int flags);
 246 extern int do_unmount(const char *mntpt, int flags);
 247 extern int zfs_mount_delegation_check(void);
 248 extern int zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto);
 249 extern int unshare_one(libzfs_handle_t *hdl, const char *name,
 250     const char *mountpoint, zfs_share_proto_t proto);
 251 extern boolean_t zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
 252     zprop_source_t *source, int flags);
 253 extern zfs_share_type_t is_shared(const char *mountpoint,
 254     zfs_share_proto_t proto);
 255 extern int libzfs_load_module(void);
 256 extern int zpool_relabel_disk(libzfs_handle_t *hdl, const char *path,
 257     const char *msg);
 258 extern int find_shares_object(differ_info_t *di);
 259 extern void libzfs_set_pipe_max(int infd);
 260 extern void zfs_commit_proto(zfs_share_proto_t *);
 261
 262 #ifdef  __cplusplus
 263 }
 264 #endif
 265
 266 #endif  /* _LIBZFS_IMPL_H */