sys/cddl/contrib/opensolaris/uts/common/fs/zfs/sys/zfs_ioctl.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  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  */
  24
  25 #ifndef _SYS_ZFS_IOCTL_H
  26 #define _SYS_ZFS_IOCTL_H
  27
  28 #include <sys/cred.h>
  29 #include <sys/dmu.h>
  30 #include <sys/zio.h>
  31 #include <sys/dsl_deleg.h>
  32 #include <sys/spa.h>
  33 #include <sys/zfs_stat.h>
  34
  35 #ifdef _KERNEL
  36 #include <sys/nvpair.h>
  37 #endif  /* _KERNEL */
  38
  39 #ifdef  __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 /*
  44  * Property values for snapdir
  45  */
  46 #define ZFS_SNAPDIR_HIDDEN              0
  47 #define ZFS_SNAPDIR_VISIBLE             1
  48
  49 /*
  50  * Field manipulation macros for the drr_versioninfo field of the
  51  * send stream header.
  52  */
  53
  54 /*
  55  * Header types for zfs send streams.
  56  */
  57 typedef enum drr_headertype {
  58         DMU_SUBSTREAM = 0x1,
  59         DMU_COMPOUNDSTREAM = 0x2
  60 } drr_headertype_t;
  61
  62 #define DMU_GET_STREAM_HDRTYPE(vi)      BF64_GET((vi), 0, 2)
  63 #define DMU_SET_STREAM_HDRTYPE(vi, x)   BF64_SET((vi), 0, 2, x)
  64
  65 #define DMU_GET_FEATUREFLAGS(vi)        BF64_GET((vi), 2, 30)
  66 #define DMU_SET_FEATUREFLAGS(vi, x)     BF64_SET((vi), 2, 30, x)
  67
  68 /*
  69  * Feature flags for zfs send streams (flags in drr_versioninfo)
  70  */
  71
  72 #define DMU_BACKUP_FEATURE_DEDUP        (0x1)
  73 #define DMU_BACKUP_FEATURE_DEDUPPROPS   (0x2)
  74 #define DMU_BACKUP_FEATURE_SA_SPILL     (0x4)
  75
  76 /*
  77  * Mask of all supported backup features
  78  */
  79 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
  80                 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL)
  81
  82 /* Are all features in the given flag word currently supported? */
  83 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
  84
  85 /*
  86  * The drr_versioninfo field of the dmu_replay_record has the
  87  * following layout:
  88  *
  89  *      64      56      48      40      32      24      16      8       0
  90  *      +-------+-------+-------+-------+-------+-------+-------+-------+
  91  *      |               reserved        |        feature-flags      |C|S|
  92  *      +-------+-------+-------+-------+-------+-------+-------+-------+
  93  *
  94  * The low order two bits indicate the header type: SUBSTREAM (0x1)
  95  * or COMPOUNDSTREAM (0x2).  Using two bits for this is historical:
  96  * this field used to be a version number, where the two version types
  97  * were 1 and 2.  Using two bits for this allows earlier versions of
  98  * the code to be able to recognize send streams that don't use any
  99  * of the features indicated by feature flags.
 100  */
 101
 102 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
 103
 104 #define DRR_FLAG_CLONE          (1<<0)
 105 #define DRR_FLAG_CI_DATA        (1<<1)
 106
 107 /*
 108  * flags in the drr_checksumflags field in the DRR_WRITE and
 109  * DRR_WRITE_BYREF blocks
 110  */
 111 #define DRR_CHECKSUM_DEDUP      (1<<0)
 112
 113 #define DRR_IS_DEDUP_CAPABLE(flags)     ((flags) & DRR_CHECKSUM_DEDUP)
 114
 115 /*
 116  * zfs ioctl command structure
 117  */
 118 struct drr_begin {
 119         uint64_t drr_magic;
 120         uint64_t drr_versioninfo; /* was drr_version */
 121         uint64_t drr_creation_time;
 122         dmu_objset_type_t drr_type;
 123         uint32_t drr_flags;
 124         uint64_t drr_toguid;
 125         uint64_t drr_fromguid;
 126         char drr_toname[MAXNAMELEN];
 127 };
 128
 129 struct drr_end {
 130         zio_cksum_t drr_checksum;
 131         uint64_t drr_toguid;
 132 };
 133
 134 struct drr_object {
 135         uint64_t drr_object;
 136         dmu_object_type_t drr_type;
 137         dmu_object_type_t drr_bonustype;
 138         uint32_t drr_blksz;
 139         uint32_t drr_bonuslen;
 140         uint8_t drr_checksumtype;
 141         uint8_t drr_compress;
 142         uint8_t drr_pad[6];
 143         uint64_t drr_toguid;
 144         /* bonus content follows */
 145 };
 146
 147 struct drr_freeobjects {
 148         uint64_t drr_firstobj;
 149         uint64_t drr_numobjs;
 150         uint64_t drr_toguid;
 151 };
 152
 153 struct drr_write {
 154         uint64_t drr_object;
 155         dmu_object_type_t drr_type;
 156         uint32_t drr_pad;
 157         uint64_t drr_offset;
 158         uint64_t drr_length;
 159         uint64_t drr_toguid;
 160         uint8_t drr_checksumtype;
 161         uint8_t drr_checksumflags;
 162         uint8_t drr_pad2[6];
 163         ddt_key_t drr_key; /* deduplication key */
 164         /* content follows */
 165 };
 166
 167 struct drr_free {
 168         uint64_t drr_object;
 169         uint64_t drr_offset;
 170         uint64_t drr_length;
 171         uint64_t drr_toguid;
 172 };
 173
 174 struct drr_write_byref {
 175         /* where to put the data */
 176         uint64_t drr_object;
 177         uint64_t drr_offset;
 178         uint64_t drr_length;
 179         uint64_t drr_toguid;
 180         /* where to find the prior copy of the data */
 181         uint64_t drr_refguid;
 182         uint64_t drr_refobject;
 183         uint64_t drr_refoffset;
 184         /* properties of the data */
 185         uint8_t drr_checksumtype;
 186         uint8_t drr_checksumflags;
 187         uint8_t drr_pad2[6];
 188         ddt_key_t drr_key; /* deduplication key */
 189 };
 190
 191 struct drr_spill {
 192         uint64_t drr_object;
 193         uint64_t drr_length;
 194         uint64_t drr_toguid;
 195         uint64_t drr_pad[4]; /* needed for crypto */
 196         /* spill data follows */
 197 };
 198
 199 typedef struct dmu_replay_record {
 200         enum {
 201                 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
 202                 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
 203                 DRR_SPILL, DRR_NUMTYPES
 204         } drr_type;
 205         uint32_t drr_payloadlen;
 206         union {
 207                 struct drr_begin drr_begin;
 208                 struct drr_end drr_end;
 209                 struct drr_object drr_object;
 210                 struct drr_freeobjects drr_freeobjects;
 211                 struct drr_write drr_write;
 212                 struct drr_free drr_free;
 213                 struct drr_write_byref drr_write_byref;
 214                 struct drr_spill drr_spill;
 215         } drr_u;
 216 } dmu_replay_record_t;
 217
 218 /* diff record range types */
 219 typedef enum diff_type {
 220         DDR_NONE = 0x1,
 221         DDR_INUSE = 0x2,
 222         DDR_FREE = 0x4
 223 } diff_type_t;
 224
 225 /*
 226  * The diff reports back ranges of free or in-use objects.
 227  */
 228 typedef struct dmu_diff_record {
 229         uint64_t ddr_type;
 230         uint64_t ddr_first;
 231         uint64_t ddr_last;
 232 } dmu_diff_record_t;
 233
 234 typedef struct zinject_record {
 235         uint64_t        zi_objset;
 236         uint64_t        zi_object;
 237         uint64_t        zi_start;
 238         uint64_t        zi_end;
 239         uint64_t        zi_guid;
 240         uint32_t        zi_level;
 241         uint32_t        zi_error;
 242         uint64_t        zi_type;
 243         uint32_t        zi_freq;
 244         uint32_t        zi_failfast;
 245         char            zi_func[MAXNAMELEN];
 246         uint32_t        zi_iotype;
 247         int32_t         zi_duration;
 248         uint64_t        zi_timer;
 249 } zinject_record_t;
 250
 251 #define ZINJECT_NULL            0x1
 252 #define ZINJECT_FLUSH_ARC       0x2
 253 #define ZINJECT_UNLOAD_SPA      0x4
 254
 255 typedef struct zfs_share {
 256         uint64_t        z_exportdata;
 257         uint64_t        z_sharedata;
 258         uint64_t        z_sharetype;    /* 0 = share, 1 = unshare */
 259         uint64_t        z_sharemax;  /* max length of share string */
 260 } zfs_share_t;
 261
 262 /*
 263  * ZFS file systems may behave the usual, POSIX-compliant way, where
 264  * name lookups are case-sensitive.  They may also be set up so that
 265  * all the name lookups are case-insensitive, or so that only some
 266  * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
 267  */
 268 typedef enum zfs_case {
 269         ZFS_CASE_SENSITIVE,
 270         ZFS_CASE_INSENSITIVE,
 271         ZFS_CASE_MIXED
 272 } zfs_case_t;
 273
 274 typedef struct zfs_cmd {
 275         char            zc_name[MAXPATHLEN];
 276         char            zc_value[MAXPATHLEN * 2];
 277         char            zc_string[MAXNAMELEN];
 278         char            zc_top_ds[MAXPATHLEN];
 279         uint64_t        zc_guid;
 280         uint64_t        zc_nvlist_conf;         /* really (char *) */
 281         uint64_t        zc_nvlist_conf_size;
 282         uint64_t        zc_nvlist_src;          /* really (char *) */
 283         uint64_t        zc_nvlist_src_size;
 284         uint64_t        zc_nvlist_dst;          /* really (char *) */
 285         uint64_t        zc_nvlist_dst_size;
 286         uint64_t        zc_cookie;
 287         uint64_t        zc_objset_type;
 288         uint64_t        zc_perm_action;
 289         uint64_t        zc_history;             /* really (char *) */
 290         uint64_t        zc_history_len;
 291         uint64_t        zc_history_offset;
 292         uint64_t        zc_obj;
 293         uint64_t        zc_iflags;              /* internal to zfs(7fs) */
 294         zfs_share_t     zc_share;
 295         uint64_t        zc_jailid;
 296         dmu_objset_stats_t zc_objset_stats;
 297         struct drr_begin zc_begin_record;
 298         zinject_record_t zc_inject_record;
 299         boolean_t       zc_defer_destroy;
 300         boolean_t       zc_temphold;
 301         uint64_t        zc_action_handle;
 302         int             zc_cleanup_fd;
 303         uint8_t         zc_pad[4];              /* alignment */
 304         uint64_t        zc_sendobj;
 305         uint64_t        zc_fromobj;
 306         uint64_t        zc_createtxg;
 307         zfs_stat_t      zc_stat;
 308 } zfs_cmd_t;
 309
 310 typedef struct zfs_useracct {
 311         char zu_domain[256];
 312         uid_t zu_rid;
 313         uint32_t zu_pad;
 314         uint64_t zu_space;
 315 } zfs_useracct_t;
 316
 317 #define ZFSDEV_MAX_MINOR        (1 << 16)
 318 #define ZFS_MIN_MINOR   (ZFSDEV_MAX_MINOR + 1)
 319
 320 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
 321
 322 #ifdef _KERNEL
 323
 324 typedef struct zfs_creat {
 325         nvlist_t        *zct_zplprops;
 326         nvlist_t        *zct_props;
 327 } zfs_creat_t;
 328
 329 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
 330 extern int zfs_secpolicy_rename_perms(const char *from,
 331     const char *to, cred_t *cr);
 332 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
 333 extern int zfs_busy(void);
 334 extern int zfs_unmount_snap(const char *, void *);
 335
 336 /*
 337  * ZFS minor numbers can refer to either a control device instance or
 338  * a zvol. Depending on the value of zss_type, zss_data points to either
 339  * a zvol_state_t or a zfs_onexit_t.
 340  */
 341 enum zfs_soft_state_type {
 342         ZSST_ZVOL,
 343         ZSST_CTLDEV
 344 };
 345
 346 typedef struct zfs_soft_state {
 347         enum zfs_soft_state_type zss_type;
 348         void *zss_data;
 349 } zfs_soft_state_t;
 350
 351 extern void *zfsdev_get_soft_state(minor_t minor,
 352     enum zfs_soft_state_type which);
 353 extern minor_t zfsdev_minor_alloc(void);
 354
 355 extern void *zfsdev_state;
 356
 357 #endif  /* _KERNEL */
 358
 359 #ifdef  __cplusplus
 360 }
 361 #endif
 362
 363 #endif  /* _SYS_ZFS_IOCTL_H */