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