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