include/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) 2012, 2015 by Delphix. All rights reserved.
  24  * Copyright 2016 RackTop Systems.
  25  */
  26
  27 #ifndef _SYS_ZFS_IOCTL_H
  28 #define _SYS_ZFS_IOCTL_H
  29
  30 #include <sys/cred.h>
  31 #include <sys/dmu.h>
  32 #include <sys/zio.h>
  33 #include <sys/dsl_deleg.h>
  34 #include <sys/spa.h>
  35 #include <sys/zfs_stat.h>
  36
  37 #ifdef _KERNEL
  38 #include <sys/nvpair.h>
  39 #endif  /* _KERNEL */
  40
  41 #ifdef  __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /*
  46  * The structures in this file are passed between userland and the
  47  * kernel.  Userland may be running a 32-bit process, while the kernel
  48  * is 64-bit.  Therefore, these structures need to compile the same in
  49  * 32-bit and 64-bit.  This means not using type "long", and adding
  50  * explicit padding so that the 32-bit structure will not be packed more
  51  * tightly than the 64-bit structure (which requires 64-bit alignment).
  52  */
  53
  54 /*
  55  * Property values for snapdir
  56  */
  57 #define ZFS_SNAPDIR_HIDDEN              0
  58 #define ZFS_SNAPDIR_VISIBLE             1
  59
  60 /*
  61  * Property values for snapdev
  62  */
  63 #define ZFS_SNAPDEV_HIDDEN              0
  64 #define ZFS_SNAPDEV_VISIBLE             1
  65 /*
  66  * Property values for acltype
  67  */
  68 #define ZFS_ACLTYPE_OFF                 0
  69 #define ZFS_ACLTYPE_POSIXACL            1
  70
  71 /*
  72  * Field manipulation macros for the drr_versioninfo field of the
  73  * send stream header.
  74  */
  75
  76 /*
  77  * Header types for zfs send streams.
  78  */
  79 typedef enum drr_headertype {
  80         DMU_SUBSTREAM = 0x1,
  81         DMU_COMPOUNDSTREAM = 0x2
  82 } drr_headertype_t;
  83
  84 #define DMU_GET_STREAM_HDRTYPE(vi)      BF64_GET((vi), 0, 2)
  85 #define DMU_SET_STREAM_HDRTYPE(vi, x)   BF64_SET((vi), 0, 2, x)
  86
  87 #define DMU_GET_FEATUREFLAGS(vi)        BF64_GET((vi), 2, 30)
  88 #define DMU_SET_FEATUREFLAGS(vi, x)     BF64_SET((vi), 2, 30, x)
  89
  90 /*
  91  * Feature flags for zfs send streams (flags in drr_versioninfo)
  92  */
  93
  94 #define DMU_BACKUP_FEATURE_DEDUP                (1 << 0)
  95 #define DMU_BACKUP_FEATURE_DEDUPPROPS           (1 << 1)
  96 #define DMU_BACKUP_FEATURE_SA_SPILL             (1 << 2)
  97 /* flags #3 - #15 are reserved for incompatible closed-source implementations */
  98 #define DMU_BACKUP_FEATURE_EMBED_DATA           (1 << 16)
  99 #define DMU_BACKUP_FEATURE_LZ4                  (1 << 17)
 100 /* flag #18 is reserved for a Delphix feature */
 101 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS         (1 << 19)
 102 #define DMU_BACKUP_FEATURE_RESUMING             (1 << 20)
 103 #define DMU_BACKUP_FEATURE_LARGE_DNODE          (1 << 21)
 104 #define DMU_BACKUP_FEATURE_COMPRESSED           (1 << 22)
 105
 106 /*
 107  * Mask of all supported backup features
 108  */
 109 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
 110     DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
 111     DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_LZ4 | \
 112     DMU_BACKUP_FEATURE_RESUMING | DMU_BACKUP_FEATURE_LARGE_BLOCKS | \
 113     DMU_BACKUP_FEATURE_COMPRESSED | DMU_BACKUP_FEATURE_LARGE_DNODE)
 114
 115 /* Are all features in the given flag word currently supported? */
 116 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
 117
 118 typedef enum dmu_send_resume_token_version {
 119         ZFS_SEND_RESUME_TOKEN_VERSION = 1
 120 } dmu_send_resume_token_version_t;
 121
 122 /*
 123  * The drr_versioninfo field of the dmu_replay_record has the
 124  * following layout:
 125  *
 126  *      64      56      48      40      32      24      16      8       0
 127  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 128  *      |               reserved        |        feature-flags      |C|S|
 129  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 130  *
 131  * The low order two bits indicate the header type: SUBSTREAM (0x1)
 132  * or COMPOUNDSTREAM (0x2).  Using two bits for this is historical:
 133  * this field used to be a version number, where the two version types
 134  * were 1 and 2.  Using two bits for this allows earlier versions of
 135  * the code to be able to recognize send streams that don't use any
 136  * of the features indicated by feature flags.
 137  */
 138
 139 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
 140
 141 /*
 142  * Send stream flags.  Bits 24-31 are reserved for vendor-specific
 143  * implementations and should not be used.
 144  */
 145 #define DRR_FLAG_CLONE          (1<<0)
 146 #define DRR_FLAG_CI_DATA        (1<<1)
 147 /*
 148  * This send stream, if it is a full send, includes the FREE and FREEOBJECT
 149  * records that are created by the sending process.  This means that the send
 150  * stream can be received as a clone, even though it is not an incremental.
 151  * This is not implemented as a feature flag, because the receiving side does
 152  * not need to have implemented it to receive this stream; it is fully backwards
 153  * compatible.  We need a flag, though, because full send streams without it
 154  * cannot necessarily be received as a clone correctly.
 155  */
 156 #define DRR_FLAG_FREERECORDS    (1<<2)
 157
 158 /*
 159  * flags in the drr_checksumflags field in the DRR_WRITE and
 160  * DRR_WRITE_BYREF blocks
 161  */
 162 #define DRR_CHECKSUM_DEDUP      (1<<0)
 163
 164 #define DRR_IS_DEDUP_CAPABLE(flags)     ((flags) & DRR_CHECKSUM_DEDUP)
 165
 166 /* deal with compressed drr_write replay records */
 167 #define DRR_WRITE_COMPRESSED(drrw)      ((drrw)->drr_compressiontype != 0)
 168 #define DRR_WRITE_PAYLOAD_SIZE(drrw) \
 169         (DRR_WRITE_COMPRESSED(drrw) ? (drrw)->drr_compressed_size : \
 170         (drrw)->drr_logical_size)
 171
 172 /*
 173  * zfs ioctl command structure
 174  */
 175 typedef struct dmu_replay_record {
 176         enum {
 177                 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
 178                 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
 179                 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
 180         } drr_type;
 181         uint32_t drr_payloadlen;
 182         union {
 183                 struct drr_begin {
 184                         uint64_t drr_magic;
 185                         uint64_t drr_versioninfo; /* was drr_version */
 186                         uint64_t drr_creation_time;
 187                         dmu_objset_type_t drr_type;
 188                         uint32_t drr_flags;
 189                         uint64_t drr_toguid;
 190                         uint64_t drr_fromguid;
 191                         char drr_toname[MAXNAMELEN];
 192                 } drr_begin;
 193                 struct drr_end {
 194                         zio_cksum_t drr_checksum;
 195                         uint64_t drr_toguid;
 196                 } drr_end;
 197                 struct drr_object {
 198                         uint64_t drr_object;
 199                         dmu_object_type_t drr_type;
 200                         dmu_object_type_t drr_bonustype;
 201                         uint32_t drr_blksz;
 202                         uint32_t drr_bonuslen;
 203                         uint8_t drr_checksumtype;
 204                         uint8_t drr_compress;
 205                         uint8_t drr_dn_slots;
 206                         uint8_t drr_pad[5];
 207                         uint64_t drr_toguid;
 208                         /* bonus content follows */
 209                 } drr_object;
 210                 struct drr_freeobjects {
 211                         uint64_t drr_firstobj;
 212                         uint64_t drr_numobjs;
 213                         uint64_t drr_toguid;
 214                 } drr_freeobjects;
 215                 struct drr_write {
 216                         uint64_t drr_object;
 217                         dmu_object_type_t drr_type;
 218                         uint32_t drr_pad;
 219                         uint64_t drr_offset;
 220                         uint64_t drr_logical_size;
 221                         uint64_t drr_toguid;
 222                         uint8_t drr_checksumtype;
 223                         uint8_t drr_checksumflags;
 224                         uint8_t drr_compressiontype;
 225                         uint8_t drr_pad2[5];
 226                         /* deduplication key */
 227                         ddt_key_t drr_key;
 228                         /* only nonzero if drr_compressiontype is not 0 */
 229                         uint64_t drr_compressed_size;
 230                         /* content follows */
 231                 } drr_write;
 232                 struct drr_free {
 233                         uint64_t drr_object;
 234                         uint64_t drr_offset;
 235                         uint64_t drr_length;
 236                         uint64_t drr_toguid;
 237                 } drr_free;
 238                 struct drr_write_byref {
 239                         /* where to put the data */
 240                         uint64_t drr_object;
 241                         uint64_t drr_offset;
 242                         uint64_t drr_length;
 243                         uint64_t drr_toguid;
 244                         /* where to find the prior copy of the data */
 245                         uint64_t drr_refguid;
 246                         uint64_t drr_refobject;
 247                         uint64_t drr_refoffset;
 248                         /* properties of the data */
 249                         uint8_t drr_checksumtype;
 250                         uint8_t drr_checksumflags;
 251                         uint8_t drr_pad2[6];
 252                         ddt_key_t drr_key; /* deduplication key */
 253                 } drr_write_byref;
 254                 struct drr_spill {
 255                         uint64_t drr_object;
 256                         uint64_t drr_length;
 257                         uint64_t drr_toguid;
 258                         uint64_t drr_pad[4]; /* needed for crypto */
 259                         /* spill data follows */
 260                 } drr_spill;
 261                 struct drr_write_embedded {
 262                         uint64_t drr_object;
 263                         uint64_t drr_offset;
 264                         /* logical length, should equal blocksize */
 265                         uint64_t drr_length;
 266                         uint64_t drr_toguid;
 267                         uint8_t drr_compression;
 268                         uint8_t drr_etype;
 269                         uint8_t drr_pad[6];
 270                         uint32_t drr_lsize; /* uncompressed size of payload */
 271                         uint32_t drr_psize; /* compr. (real) size of payload */
 272                         /* (possibly compressed) content follows */
 273                 } drr_write_embedded;
 274
 275                 /*
 276                  * Nore: drr_checksum is overlaid with all record types
 277                  * except DRR_BEGIN.  Therefore its (non-pad) members
 278                  * must not overlap with members from the other structs.
 279                  * We accomplish this by putting its members at the very
 280                  * end of the struct.
 281                  */
 282                 struct drr_checksum {
 283                         uint64_t drr_pad[34];
 284                         /*
 285                          * fletcher-4 checksum of everything preceding the
 286                          * checksum.
 287                          */
 288                         zio_cksum_t drr_checksum;
 289                 } drr_checksum;
 290         } drr_u;
 291 } dmu_replay_record_t;
 292
 293 /* diff record range types */
 294 typedef enum diff_type {
 295         DDR_NONE = 0x1,
 296         DDR_INUSE = 0x2,
 297         DDR_FREE = 0x4
 298 } diff_type_t;
 299
 300 /*
 301  * The diff reports back ranges of free or in-use objects.
 302  */
 303 typedef struct dmu_diff_record {
 304         uint64_t ddr_type;
 305         uint64_t ddr_first;
 306         uint64_t ddr_last;
 307 } dmu_diff_record_t;
 308
 309 typedef struct zinject_record {
 310         uint64_t        zi_objset;
 311         uint64_t        zi_object;
 312         uint64_t        zi_start;
 313         uint64_t        zi_end;
 314         uint64_t        zi_guid;
 315         uint32_t        zi_level;
 316         uint32_t        zi_error;
 317         uint64_t        zi_type;
 318         uint32_t        zi_freq;
 319         uint32_t        zi_failfast;
 320         char            zi_func[MAXNAMELEN];
 321         uint32_t        zi_iotype;
 322         int32_t         zi_duration;
 323         uint64_t        zi_timer;
 324         uint64_t        zi_nlanes;
 325         uint32_t        zi_cmd;
 326         uint32_t        zi_pad;
 327 } zinject_record_t;
 328
 329 #define ZINJECT_NULL            0x1
 330 #define ZINJECT_FLUSH_ARC       0x2
 331 #define ZINJECT_UNLOAD_SPA      0x4
 332
 333 #define ZEVENT_NONE             0x0
 334 #define ZEVENT_NONBLOCK         0x1
 335 #define ZEVENT_SIZE             1024
 336
 337 #define ZEVENT_SEEK_START       0
 338 #define ZEVENT_SEEK_END         UINT64_MAX
 339
 340 typedef enum zinject_type {
 341         ZINJECT_UNINITIALIZED,
 342         ZINJECT_DATA_FAULT,
 343         ZINJECT_DEVICE_FAULT,
 344         ZINJECT_LABEL_FAULT,
 345         ZINJECT_IGNORED_WRITES,
 346         ZINJECT_PANIC,
 347         ZINJECT_DELAY_IO,
 348 } zinject_type_t;
 349
 350 typedef struct zfs_share {
 351         uint64_t        z_exportdata;
 352         uint64_t        z_sharedata;
 353         uint64_t        z_sharetype;    /* 0 = share, 1 = unshare */
 354         uint64_t        z_sharemax;  /* max length of share string */
 355 } zfs_share_t;
 356
 357 /*
 358  * ZFS file systems may behave the usual, POSIX-compliant way, where
 359  * name lookups are case-sensitive.  They may also be set up so that
 360  * all the name lookups are case-insensitive, or so that only some
 361  * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
 362  */
 363 typedef enum zfs_case {
 364         ZFS_CASE_SENSITIVE,
 365         ZFS_CASE_INSENSITIVE,
 366         ZFS_CASE_MIXED
 367 } zfs_case_t;
 368
 369 /*
 370  * Note: this struct must have the same layout in 32-bit and 64-bit, so
 371  * that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
 372  * kernel.  Therefore, we add padding to it so that no "hidden" padding
 373  * is automatically added on 64-bit (but not on 32-bit).
 374  */
 375 typedef struct zfs_cmd {
 376         char            zc_name[MAXPATHLEN];    /* name of pool or dataset */
 377         uint64_t        zc_nvlist_src;          /* really (char *) */
 378         uint64_t        zc_nvlist_src_size;
 379         uint64_t        zc_nvlist_dst;          /* really (char *) */
 380         uint64_t        zc_nvlist_dst_size;
 381         boolean_t       zc_nvlist_dst_filled;   /* put an nvlist in dst? */
 382         int             zc_pad2;
 383
 384         /*
 385          * The following members are for legacy ioctls which haven't been
 386          * converted to the new method.
 387          */
 388         uint64_t        zc_history;             /* really (char *) */
 389         char            zc_value[MAXPATHLEN * 2];
 390         char            zc_string[MAXNAMELEN];
 391         uint64_t        zc_guid;
 392         uint64_t        zc_nvlist_conf;         /* really (char *) */
 393         uint64_t        zc_nvlist_conf_size;
 394         uint64_t        zc_cookie;
 395         uint64_t        zc_objset_type;
 396         uint64_t        zc_perm_action;
 397         uint64_t        zc_history_len;
 398         uint64_t        zc_history_offset;
 399         uint64_t        zc_obj;
 400         uint64_t        zc_iflags;              /* internal to zfs(7fs) */
 401         zfs_share_t     zc_share;
 402         dmu_objset_stats_t zc_objset_stats;
 403         struct drr_begin zc_begin_record;
 404         zinject_record_t zc_inject_record;
 405         uint32_t        zc_defer_destroy;
 406         uint32_t        zc_flags;
 407         uint64_t        zc_action_handle;
 408         int             zc_cleanup_fd;
 409         uint8_t         zc_simple;
 410         uint8_t         zc_pad[3];              /* alignment */
 411         uint64_t        zc_sendobj;
 412         uint64_t        zc_fromobj;
 413         uint64_t        zc_createtxg;
 414         zfs_stat_t      zc_stat;
 415 } zfs_cmd_t;
 416
 417 typedef struct zfs_useracct {
 418         char zu_domain[256];
 419         uid_t zu_rid;
 420         uint32_t zu_pad;
 421         uint64_t zu_space;
 422 } zfs_useracct_t;
 423
 424 #define ZFSDEV_MAX_MINOR        (1 << 16)
 425 #define ZFS_MIN_MINOR   (ZFSDEV_MAX_MINOR + 1)
 426
 427 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
 428
 429 #ifdef _KERNEL
 430
 431 typedef struct zfs_creat {
 432         nvlist_t        *zct_zplprops;
 433         nvlist_t        *zct_props;
 434 } zfs_creat_t;
 435
 436 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
 437 extern int zfs_secpolicy_rename_perms(const char *from,
 438     const char *to, cred_t *cr);
 439 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
 440 extern int zfs_unmount_snap(const char *);
 441 extern void zfs_destroy_unmount_origin(const char *);
 442
 443 extern boolean_t dataset_name_hidden(const char *name);
 444
 445 enum zfsdev_state_type {
 446         ZST_ONEXIT,
 447         ZST_ZEVENT,
 448         ZST_ALL,
 449 };
 450
 451 /*
 452  * The zfsdev_state_t structure is managed as a singly-linked list
 453  * from which items are never deleted.  This allows for lock-free
 454  * reading of the list so long as assignments to the zs_next and
 455  * reads from zs_minor are performed atomically.  Empty items are
 456  * indicated by storing -1 into zs_minor.
 457  */
 458 typedef struct zfsdev_state {
 459         struct zfsdev_state     *zs_next;       /* next zfsdev_state_t link */
 460         struct file             *zs_file;       /* associated file struct */
 461         minor_t                 zs_minor;       /* made up minor number */
 462         void                    *zs_onexit;     /* onexit data */
 463         void                    *zs_zevent;     /* zevent data */
 464 } zfsdev_state_t;
 465
 466 extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
 467 extern int zfsdev_getminor(struct file *filp, minor_t *minorp);
 468 extern minor_t zfsdev_minor_alloc(void);
 469
 470 #endif  /* _KERNEL */
 471
 472 #ifdef  __cplusplus
 473 }
 474 #endif
 475
 476 #endif  /* _SYS_ZFS_IOCTL_H */