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 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  * Property values for snapdev
  61  */
  62 #define ZFS_SNAPDEV_HIDDEN              0
  63 #define ZFS_SNAPDEV_VISIBLE             1
  64 /*
  65  * Property values for acltype
  66  */
  67 #define ZFS_ACLTYPE_OFF                 0
  68 #define ZFS_ACLTYPE_POSIXACL            1
  69
  70 /*
  71  * Field manipulation macros for the drr_versioninfo field of the
  72  * send stream header.
  73  */
  74
  75 /*
  76  * Header types for zfs send streams.
  77  */
  78 typedef enum drr_headertype {
  79         DMU_SUBSTREAM = 0x1,
  80         DMU_COMPOUNDSTREAM = 0x2
  81 } drr_headertype_t;
  82
  83 #define DMU_GET_STREAM_HDRTYPE(vi)      BF64_GET((vi), 0, 2)
  84 #define DMU_SET_STREAM_HDRTYPE(vi, x)   BF64_SET((vi), 0, 2, x)
  85
  86 #define DMU_GET_FEATUREFLAGS(vi)        BF64_GET((vi), 2, 30)
  87 #define DMU_SET_FEATUREFLAGS(vi, x)     BF64_SET((vi), 2, 30, x)
  88
  89 /*
  90  * Feature flags for zfs send streams (flags in drr_versioninfo)
  91  */
  92
  93 #define DMU_BACKUP_FEATURE_DEDUP        (0x1)
  94 #define DMU_BACKUP_FEATURE_DEDUPPROPS   (0x2)
  95 #define DMU_BACKUP_FEATURE_SA_SPILL     (0x4)
  96
  97 /*
  98  * Mask of all supported backup features
  99  */
 100 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
 101                 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL)
 102
 103 /* Are all features in the given flag word currently supported? */
 104 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
 105
 106 /*
 107  * The drr_versioninfo field of the dmu_replay_record has the
 108  * following layout:
 109  *
 110  *      64      56      48      40      32      24      16      8       0
 111  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 112  *      |               reserved        |        feature-flags      |C|S|
 113  *      +-------+-------+-------+-------+-------+-------+-------+-------+
 114  *
 115  * The low order two bits indicate the header type: SUBSTREAM (0x1)
 116  * or COMPOUNDSTREAM (0x2).  Using two bits for this is historical:
 117  * this field used to be a version number, where the two version types
 118  * were 1 and 2.  Using two bits for this allows earlier versions of
 119  * the code to be able to recognize send streams that don't use any
 120  * of the features indicated by feature flags.
 121  */
 122
 123 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
 124
 125 #define DRR_FLAG_CLONE          (1<<0)
 126 #define DRR_FLAG_CI_DATA        (1<<1)
 127
 128 /*
 129  * flags in the drr_checksumflags field in the DRR_WRITE and
 130  * DRR_WRITE_BYREF blocks
 131  */
 132 #define DRR_CHECKSUM_DEDUP      (1<<0)
 133
 134 #define DRR_IS_DEDUP_CAPABLE(flags)     ((flags) & DRR_CHECKSUM_DEDUP)
 135
 136 /*
 137  * zfs ioctl command structure
 138  */
 139 typedef struct dmu_replay_record {
 140         enum {
 141                 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
 142                 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
 143                 DRR_SPILL, DRR_NUMTYPES
 144         } drr_type;
 145         uint32_t drr_payloadlen;
 146         union {
 147                 struct drr_begin {
 148                         uint64_t drr_magic;
 149                         uint64_t drr_versioninfo; /* was drr_version */
 150                         uint64_t drr_creation_time;
 151                         dmu_objset_type_t drr_type;
 152                         uint32_t drr_flags;
 153                         uint64_t drr_toguid;
 154                         uint64_t drr_fromguid;
 155                         char drr_toname[MAXNAMELEN];
 156                 } drr_begin;
 157                 struct drr_end {
 158                         zio_cksum_t drr_checksum;
 159                         uint64_t drr_toguid;
 160                 } drr_end;
 161                 struct drr_object {
 162                         uint64_t drr_object;
 163                         dmu_object_type_t drr_type;
 164                         dmu_object_type_t drr_bonustype;
 165                         uint32_t drr_blksz;
 166                         uint32_t drr_bonuslen;
 167                         uint8_t drr_checksumtype;
 168                         uint8_t drr_compress;
 169                         uint8_t drr_pad[6];
 170                         uint64_t drr_toguid;
 171                         /* bonus content follows */
 172                 } drr_object;
 173                 struct drr_freeobjects {
 174                         uint64_t drr_firstobj;
 175                         uint64_t drr_numobjs;
 176                         uint64_t drr_toguid;
 177                 } drr_freeobjects;
 178                 struct drr_write {
 179                         uint64_t drr_object;
 180                         dmu_object_type_t drr_type;
 181                         uint32_t drr_pad;
 182                         uint64_t drr_offset;
 183                         uint64_t drr_length;
 184                         uint64_t drr_toguid;
 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                         /* content follows */
 190                 } drr_write;
 191                 struct drr_free {
 192                         uint64_t drr_object;
 193                         uint64_t drr_offset;
 194                         uint64_t drr_length;
 195                         uint64_t drr_toguid;
 196                 } drr_free;
 197                 struct drr_write_byref {
 198                         /* where to put the data */
 199                         uint64_t drr_object;
 200                         uint64_t drr_offset;
 201                         uint64_t drr_length;
 202                         uint64_t drr_toguid;
 203                         /* where to find the prior copy of the data */
 204                         uint64_t drr_refguid;
 205                         uint64_t drr_refobject;
 206                         uint64_t drr_refoffset;
 207                         /* properties of the data */
 208                         uint8_t drr_checksumtype;
 209                         uint8_t drr_checksumflags;
 210                         uint8_t drr_pad2[6];
 211                         ddt_key_t drr_key; /* deduplication key */
 212                 } drr_write_byref;
 213                 struct drr_spill {
 214                         uint64_t drr_object;
 215                         uint64_t drr_length;
 216                         uint64_t drr_toguid;
 217                         uint64_t drr_pad[4]; /* needed for crypto */
 218                         /* spill data follows */
 219                 } drr_spill;
 220         } drr_u;
 221 } dmu_replay_record_t;
 222
 223 /* diff record range types */
 224 typedef enum diff_type {
 225         DDR_NONE = 0x1,
 226         DDR_INUSE = 0x2,
 227         DDR_FREE = 0x4
 228 } diff_type_t;
 229
 230 /*
 231  * The diff reports back ranges of free or in-use objects.
 232  */
 233 typedef struct dmu_diff_record {
 234         uint64_t ddr_type;
 235         uint64_t ddr_first;
 236         uint64_t ddr_last;
 237 } dmu_diff_record_t;
 238
 239 typedef struct zinject_record {
 240         uint64_t        zi_objset;
 241         uint64_t        zi_object;
 242         uint64_t        zi_start;
 243         uint64_t        zi_end;
 244         uint64_t        zi_guid;
 245         uint32_t        zi_level;
 246         uint32_t        zi_error;
 247         uint64_t        zi_type;
 248         uint32_t        zi_freq;
 249         uint32_t        zi_failfast;
 250         char            zi_func[MAXNAMELEN];
 251         uint32_t        zi_iotype;
 252         int32_t         zi_duration;
 253         uint64_t        zi_timer;
 254         uint32_t        zi_cmd;
 255         uint32_t        zi_pad;
 256 } zinject_record_t;
 257
 258 #define ZINJECT_NULL            0x1
 259 #define ZINJECT_FLUSH_ARC       0x2
 260 #define ZINJECT_UNLOAD_SPA      0x4
 261
 262 #define ZEVENT_NONBLOCK         0x1
 263 #define ZEVENT_SIZE             1024
 264
 265 typedef enum zinject_type {
 266         ZINJECT_UNINITIALIZED,
 267         ZINJECT_DATA_FAULT,
 268         ZINJECT_DEVICE_FAULT,
 269         ZINJECT_LABEL_FAULT,
 270         ZINJECT_IGNORED_WRITES,
 271         ZINJECT_PANIC,
 272         ZINJECT_DELAY_IO,
 273 } zinject_type_t;
 274
 275 typedef struct zfs_share {
 276         uint64_t        z_exportdata;
 277         uint64_t        z_sharedata;
 278         uint64_t        z_sharetype;    /* 0 = share, 1 = unshare */
 279         uint64_t        z_sharemax;  /* max length of share string */
 280 } zfs_share_t;
 281
 282 /*
 283  * ZFS file systems may behave the usual, POSIX-compliant way, where
 284  * name lookups are case-sensitive.  They may also be set up so that
 285  * all the name lookups are case-insensitive, or so that only some
 286  * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
 287  */
 288 typedef enum zfs_case {
 289         ZFS_CASE_SENSITIVE,
 290         ZFS_CASE_INSENSITIVE,
 291         ZFS_CASE_MIXED
 292 } zfs_case_t;
 293
 294 typedef struct zfs_cmd {
 295         char            zc_name[MAXPATHLEN];    /* name of pool or dataset */
 296         uint64_t        zc_nvlist_src;          /* really (char *) */
 297         uint64_t        zc_nvlist_src_size;
 298         uint64_t        zc_nvlist_dst;          /* really (char *) */
 299         uint64_t        zc_nvlist_dst_size;
 300         boolean_t       zc_nvlist_dst_filled;   /* put an nvlist in dst? */
 301         int             zc_pad2;
 302
 303         /*
 304          * The following members are for legacy ioctls which haven't been
 305          * converted to the new method.
 306          */
 307         uint64_t        zc_history;             /* really (char *) */
 308         char            zc_value[MAXPATHLEN * 2];
 309         char            zc_string[MAXNAMELEN];
 310         uint64_t        zc_guid;
 311         uint64_t        zc_nvlist_conf;         /* really (char *) */
 312         uint64_t        zc_nvlist_conf_size;
 313         uint64_t        zc_cookie;
 314         uint64_t        zc_objset_type;
 315         uint64_t        zc_perm_action;
 316         uint64_t        zc_history_len;
 317         uint64_t        zc_history_offset;
 318         uint64_t        zc_obj;
 319         uint64_t        zc_iflags;              /* internal to zfs(7fs) */
 320         zfs_share_t     zc_share;
 321         dmu_objset_stats_t zc_objset_stats;
 322         struct drr_begin zc_begin_record;
 323         zinject_record_t zc_inject_record;
 324         boolean_t       zc_defer_destroy;
 325         boolean_t       zc_temphold;
 326         uint64_t        zc_action_handle;
 327         int             zc_cleanup_fd;
 328         uint8_t         zc_simple;
 329         uint8_t         zc_pad[3];              /* alignment */
 330         uint64_t        zc_sendobj;
 331         uint64_t        zc_fromobj;
 332         uint64_t        zc_createtxg;
 333         zfs_stat_t      zc_stat;
 334 } zfs_cmd_t;
 335
 336 typedef struct zfs_useracct {
 337         char zu_domain[256];
 338         uid_t zu_rid;
 339         uint32_t zu_pad;
 340         uint64_t zu_space;
 341 } zfs_useracct_t;
 342
 343 #define ZFSDEV_MAX_MINOR        (1 << 16)
 344 #define ZFS_MIN_MINOR   (ZFSDEV_MAX_MINOR + 1)
 345
 346 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
 347
 348 #ifdef _KERNEL
 349
 350 typedef struct zfs_creat {
 351         nvlist_t        *zct_zplprops;
 352         nvlist_t        *zct_props;
 353 } zfs_creat_t;
 354
 355 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
 356 extern int zfs_secpolicy_rename_perms(const char *from,
 357     const char *to, cred_t *cr);
 358 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
 359 extern int zfs_unmount_snap(const char *);
 360 extern void zfs_destroy_unmount_origin(const char *);
 361
 362 extern boolean_t dataset_name_hidden(const char *name);
 363
 364 enum zfsdev_state_type {
 365         ZST_ONEXIT,
 366         ZST_ZEVENT,
 367         ZST_ALL,
 368 };
 369
 370 typedef struct zfsdev_state {
 371         list_node_t             zs_next;        /* next zfsdev_state_t link */
 372         struct file             *zs_file;       /* associated file struct */
 373         minor_t                 zs_minor;       /* made up minor number */
 374         void                    *zs_onexit;     /* onexit data */
 375         void                    *zs_zevent;     /* zevent data */
 376 } zfsdev_state_t;
 377
 378 extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
 379 extern minor_t zfsdev_getminor(struct file *filp);
 380 extern minor_t zfsdev_minor_alloc(void);
 381
 382 #endif  /* _KERNEL */
 383
 384 #ifdef  __cplusplus
 385 }
 386 #endif
 387
 388 #endif  /* _SYS_ZFS_IOCTL_H */