cddl/contrib/opensolaris/lib/libzfs/common/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 2007 Sun Microsystems, Inc.  All rights reserved.
  24  * Use is subject to license terms.
  25  */
  26
  27 #ifndef _LIBFS_IMPL_H
  28 #define _LIBFS_IMPL_H
  29
  30 #pragma ident   "%Z%%M% %I%     %E% SMI"
  31
  32 #include <sys/dmu.h>
  33 #include <sys/fs/zfs.h>
  34 #include <sys/zfs_ioctl.h>
  35 #include <sys/zfs_acl.h>
  36 #include <sys/nvpair.h>
  37
  38 #include <libuutil.h>
  39 #include <libzfs.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         uu_avl_pool_t *libzfs_ns_avlpool;
  51         uu_avl_t *libzfs_ns_avl;
  52         uint64_t libzfs_ns_gen;
  53         int libzfs_desc_active;
  54         char libzfs_action[1024];
  55         char libzfs_desc[1024];
  56         int libzfs_printerr;
  57 };
  58
  59 struct zfs_handle {
  60         libzfs_handle_t *zfs_hdl;
  61         char zfs_name[ZFS_MAXNAMELEN];
  62         zfs_type_t zfs_type; /* type including snapshot */
  63         zfs_type_t zfs_head_type; /* type excluding snapshot */
  64         dmu_objset_stats_t zfs_dmustats;
  65         nvlist_t *zfs_props;
  66         nvlist_t *zfs_user_props;
  67         boolean_t zfs_mntcheck;
  68         char *zfs_mntopts;
  69         char zfs_root[MAXPATHLEN];
  70 };
  71
  72 /*
  73  * This is different from checking zfs_type, because it will also catch
  74  * snapshots of volumes.
  75  */
  76 #define ZFS_IS_VOLUME(zhp) ((zhp)->zfs_head_type == ZFS_TYPE_VOLUME)
  77
  78 struct zpool_handle {
  79         libzfs_handle_t *zpool_hdl;
  80         char zpool_name[ZPOOL_MAXNAMELEN];
  81         int zpool_state;
  82         size_t zpool_config_size;
  83         nvlist_t *zpool_config;
  84         nvlist_t *zpool_old_config;
  85         nvlist_t *zpool_props;
  86 };
  87
  88 int zfs_error(libzfs_handle_t *, int, const char *);
  89 int zfs_error_fmt(libzfs_handle_t *, int, const char *, ...);
  90 void zfs_error_aux(libzfs_handle_t *, const char *, ...);
  91 void *zfs_alloc(libzfs_handle_t *, size_t);
  92 void *zfs_realloc(libzfs_handle_t *, void *, size_t, size_t);
  93 char *zfs_strdup(libzfs_handle_t *, const char *);
  94 int no_memory(libzfs_handle_t *);
  95
  96 int zfs_standard_error(libzfs_handle_t *, int, const char *);
  97 int zfs_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
  98 int zpool_standard_error(libzfs_handle_t *, int, const char *);
  99 int zpool_standard_error_fmt(libzfs_handle_t *, int, const char *, ...);
 100
 101 int get_dependents(libzfs_handle_t *, boolean_t, const char *, char ***,
 102     size_t *);
 103
 104 int zfs_expand_proplist_common(libzfs_handle_t *, zfs_proplist_t **,
 105     zfs_type_t);
 106 int zfs_get_proplist_common(libzfs_handle_t *, char *, zfs_proplist_t **,
 107     zfs_type_t);
 108 zfs_prop_t zfs_prop_iter_common(zfs_prop_f, void *, zfs_type_t, boolean_t);
 109 zfs_prop_t zfs_name_to_prop_common(const char *, zfs_type_t);
 110
 111 nvlist_t *zfs_validate_properties(libzfs_handle_t *, zfs_type_t, char *,
 112         nvlist_t *, uint64_t, zfs_handle_t *zhp, const char *errbuf);
 113
 114 typedef struct prop_changelist prop_changelist_t;
 115
 116 int zcmd_alloc_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, size_t);
 117 int zcmd_write_src_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t *, size_t *);
 118 int zcmd_expand_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *);
 119 int zcmd_read_dst_nvlist(libzfs_handle_t *, zfs_cmd_t *, nvlist_t **);
 120 void zcmd_free_nvlists(zfs_cmd_t *);
 121
 122 int changelist_prefix(prop_changelist_t *);
 123 int changelist_postfix(prop_changelist_t *);
 124 void changelist_rename(prop_changelist_t *, const char *, const char *);
 125 void changelist_remove(zfs_handle_t *, prop_changelist_t *);
 126 void changelist_free(prop_changelist_t *);
 127 prop_changelist_t *changelist_gather(zfs_handle_t *, zfs_prop_t, int);
 128 int changelist_unshare(prop_changelist_t *);
 129 int changelist_haszonedchild(prop_changelist_t *);
 130
 131 void remove_mountpoint(zfs_handle_t *);
 132
 133 zfs_handle_t *make_dataset_handle(libzfs_handle_t *, const char *);
 134
 135 int zpool_open_silent(libzfs_handle_t *, const char *, zpool_handle_t **);
 136
 137 int zvol_create_link(libzfs_handle_t *, const char *);
 138 int zvol_remove_link(libzfs_handle_t *, const char *);
 139 int zpool_iter_zvol(zpool_handle_t *, int (*)(const char *, void *), void *);
 140
 141 void namespace_clear(libzfs_handle_t *);
 142
 143 #ifdef  __FreeBSD__
 144 /*
 145  * This is FreeBSD version of ioctl, because Solaris' ioctl() updates
 146  * zc_nvlist_dst_size even if an error is returned, on FreeBSD if an
 147  * error is returned zc_nvlist_dst_size won't be updated.
 148  */
 149 static __inline int
 150 zcmd_ioctl(int fd, unsigned long cmd, zfs_cmd_t *zc)
 151 {
 152         size_t oldsize;
 153         int ret;
 154
 155         oldsize = zc->zc_nvlist_dst_size;
 156         ret = ioctl(fd, cmd, zc);
 157         if (ret == 0 && oldsize < zc->zc_nvlist_dst_size) {
 158                 ret = -1;
 159                 errno = ENOMEM;
 160         }
 161
 162         return (ret);
 163 }
 164 #define ioctl(fd, cmd, zc)      zcmd_ioctl((fd), (cmd), (zc))
 165 #endif
 166
 167 #ifdef  __cplusplus
 168 }
 169 #endif
 170
 171 #endif  /* _LIBFS_IMPL_H */