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