1fa9e4066Sahrens /* 2fa9e4066Sahrens * CDDL HEADER START 3fa9e4066Sahrens * 4fa9e4066Sahrens * The contents of this file are subject to the terms of the 5ea8dc4b6Seschrock * Common Development and Distribution License (the "License"). 6ea8dc4b6Seschrock * You may not use this file except in compliance with the License. 7fa9e4066Sahrens * 8fa9e4066Sahrens * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9fa9e4066Sahrens * or http://www.opensolaris.org/os/licensing. 10fa9e4066Sahrens * See the License for the specific language governing permissions 11fa9e4066Sahrens * and limitations under the License. 12fa9e4066Sahrens * 13fa9e4066Sahrens * When distributing Covered Code, include this CDDL HEADER in each 14fa9e4066Sahrens * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15fa9e4066Sahrens * If applicable, add the following below this CDDL HEADER, with the 16fa9e4066Sahrens * fields enclosed by brackets "[]" replaced with your own identifying 17fa9e4066Sahrens * information: Portions Copyright [yyyy] [name of copyright owner] 18fa9e4066Sahrens * 19fa9e4066Sahrens * CDDL HEADER END 20fa9e4066Sahrens */ 21fa9e4066Sahrens /* 22c99e4bdcSChris Kirby * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved. 234445fffbSMatthew Ahrens * Copyright (c) 2012 by Delphix. All rights reserved. 24fa9e4066Sahrens */ 25fa9e4066Sahrens 26fa9e4066Sahrens #ifndef _SYS_ZFS_IOCTL_H 27fa9e4066Sahrens #define _SYS_ZFS_IOCTL_H 28fa9e4066Sahrens 29fa9e4066Sahrens #include <sys/cred.h> 30fa9e4066Sahrens #include <sys/dmu.h> 31ea8dc4b6Seschrock #include <sys/zio.h> 32ecd6cf80Smarks #include <sys/dsl_deleg.h> 339e69d7d0SLori Alt #include <sys/spa.h> 3499d5e173STim Haley #include <sys/zfs_stat.h> 35fa9e4066Sahrens 36da6c28aaSamw #ifdef _KERNEL 37da6c28aaSamw #include <sys/nvpair.h> 38da6c28aaSamw #endif /* _KERNEL */ 39da6c28aaSamw 40fa9e4066Sahrens #ifdef __cplusplus 41fa9e4066Sahrens extern "C" { 42fa9e4066Sahrens #endif 43fa9e4066Sahrens 444445fffbSMatthew Ahrens /* 454445fffbSMatthew Ahrens * The structures in this file are passed between userland and the 464445fffbSMatthew Ahrens * kernel. Userland may be running a 32-bit process, while the kernel 474445fffbSMatthew Ahrens * is 64-bit. Therefore, these structures need to compile the same in 484445fffbSMatthew Ahrens * 32-bit and 64-bit. This means not using type "long", and adding 494445fffbSMatthew Ahrens * explicit padding so that the 32-bit structure will not be packed more 504445fffbSMatthew Ahrens * tightly than the 64-bit structure (which requires 64-bit alignment). 514445fffbSMatthew Ahrens */ 524445fffbSMatthew Ahrens 53fa9e4066Sahrens /* 54fa9e4066Sahrens * Property values for snapdir 55fa9e4066Sahrens */ 56a0965f35Sbonwick #define ZFS_SNAPDIR_HIDDEN 0 57a0965f35Sbonwick #define ZFS_SNAPDIR_VISIBLE 1 58fa9e4066Sahrens 599e69d7d0SLori Alt /* 609e69d7d0SLori Alt * Field manipulation macros for the drr_versioninfo field of the 619e69d7d0SLori Alt * send stream header. 629e69d7d0SLori Alt */ 639e69d7d0SLori Alt 649e69d7d0SLori Alt /* 659e69d7d0SLori Alt * Header types for zfs send streams. 669e69d7d0SLori Alt */ 679e69d7d0SLori Alt typedef enum drr_headertype { 689e69d7d0SLori Alt DMU_SUBSTREAM = 0x1, 699e69d7d0SLori Alt DMU_COMPOUNDSTREAM = 0x2 709e69d7d0SLori Alt } drr_headertype_t; 719e69d7d0SLori Alt 729e69d7d0SLori Alt #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2) 739e69d7d0SLori Alt #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x) 749e69d7d0SLori Alt 759e69d7d0SLori Alt #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30) 769e69d7d0SLori Alt #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x) 779e69d7d0SLori Alt 789e69d7d0SLori Alt /* 799e69d7d0SLori Alt * Feature flags for zfs send streams (flags in drr_versioninfo) 809e69d7d0SLori Alt */ 819e69d7d0SLori Alt 829e69d7d0SLori Alt #define DMU_BACKUP_FEATURE_DEDUP (0x1) 838e714474SLori Alt #define DMU_BACKUP_FEATURE_DEDUPPROPS (0x2) 840a586ceaSMark Shellenbaum #define DMU_BACKUP_FEATURE_SA_SPILL (0x4) 859e69d7d0SLori Alt 869e69d7d0SLori Alt /* 879e69d7d0SLori Alt * Mask of all supported backup features 889e69d7d0SLori Alt */ 898e714474SLori Alt #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \ 900a586ceaSMark Shellenbaum DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL) 919e69d7d0SLori Alt 929e69d7d0SLori Alt /* Are all features in the given flag word currently supported? */ 939e69d7d0SLori Alt #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK)) 949e69d7d0SLori Alt 959e69d7d0SLori Alt /* 969e69d7d0SLori Alt * The drr_versioninfo field of the dmu_replay_record has the 979e69d7d0SLori Alt * following layout: 989e69d7d0SLori Alt * 999e69d7d0SLori Alt * 64 56 48 40 32 24 16 8 0 1009e69d7d0SLori Alt * +-------+-------+-------+-------+-------+-------+-------+-------+ 1019e69d7d0SLori Alt * | reserved | feature-flags |C|S| 1029e69d7d0SLori Alt * +-------+-------+-------+-------+-------+-------+-------+-------+ 1039e69d7d0SLori Alt * 1049e69d7d0SLori Alt * The low order two bits indicate the header type: SUBSTREAM (0x1) 1059e69d7d0SLori Alt * or COMPOUNDSTREAM (0x2). Using two bits for this is historical: 1069e69d7d0SLori Alt * this field used to be a version number, where the two version types 1079e69d7d0SLori Alt * were 1 and 2. Using two bits for this allows earlier versions of 1089e69d7d0SLori Alt * the code to be able to recognize send streams that don't use any 1099e69d7d0SLori Alt * of the features indicated by feature flags. 1109e69d7d0SLori Alt */ 1119e69d7d0SLori Alt 112fa9e4066Sahrens #define DMU_BACKUP_MAGIC 0x2F5bacbacULL 113fa9e4066Sahrens 114ab04eb8eStimh #define DRR_FLAG_CLONE (1<<0) 115ab04eb8eStimh #define DRR_FLAG_CI_DATA (1<<1) 1163cb34c60Sahrens 1178e714474SLori Alt /* 1188e714474SLori Alt * flags in the drr_checksumflags field in the DRR_WRITE and 1198e714474SLori Alt * DRR_WRITE_BYREF blocks 1208e714474SLori Alt */ 1218e714474SLori Alt #define DRR_CHECKSUM_DEDUP (1<<0) 1228e714474SLori Alt 1238e714474SLori Alt #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP) 1248e714474SLori Alt 125fa9e4066Sahrens /* 126fa9e4066Sahrens * zfs ioctl command structure 127fa9e4066Sahrens */ 128fa9e4066Sahrens typedef struct dmu_replay_record { 129fa9e4066Sahrens enum { 130fa9e4066Sahrens DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS, 1319e69d7d0SLori Alt DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF, 1320a586ceaSMark Shellenbaum DRR_SPILL, DRR_NUMTYPES 133fa9e4066Sahrens } drr_type; 1343cb34c60Sahrens uint32_t drr_payloadlen; 135fa9e4066Sahrens union { 136fa9e4066Sahrens struct drr_begin { 137fa9e4066Sahrens uint64_t drr_magic; 1389e69d7d0SLori Alt uint64_t drr_versioninfo; /* was drr_version */ 139fa9e4066Sahrens uint64_t drr_creation_time; 140fa9e4066Sahrens dmu_objset_type_t drr_type; 1413cb34c60Sahrens uint32_t drr_flags; 142fa9e4066Sahrens uint64_t drr_toguid; 143fa9e4066Sahrens uint64_t drr_fromguid; 144fa9e4066Sahrens char drr_toname[MAXNAMELEN]; 145fa9e4066Sahrens } drr_begin; 146fa9e4066Sahrens struct drr_end { 147ea8dc4b6Seschrock zio_cksum_t drr_checksum; 1489e69d7d0SLori Alt uint64_t drr_toguid; 149fa9e4066Sahrens } drr_end; 150fa9e4066Sahrens struct drr_object { 151fa9e4066Sahrens uint64_t drr_object; 152fa9e4066Sahrens dmu_object_type_t drr_type; 153fa9e4066Sahrens dmu_object_type_t drr_bonustype; 154fa9e4066Sahrens uint32_t drr_blksz; 155fa9e4066Sahrens uint32_t drr_bonuslen; 1569e69d7d0SLori Alt uint8_t drr_checksumtype; 157fa9e4066Sahrens uint8_t drr_compress; 158fa9e4066Sahrens uint8_t drr_pad[6]; 1599e69d7d0SLori Alt uint64_t drr_toguid; 160a2eea2e1Sahrens /* bonus content follows */ 161fa9e4066Sahrens } drr_object; 162fa9e4066Sahrens struct drr_freeobjects { 163fa9e4066Sahrens uint64_t drr_firstobj; 164fa9e4066Sahrens uint64_t drr_numobjs; 1659e69d7d0SLori Alt uint64_t drr_toguid; 166fa9e4066Sahrens } drr_freeobjects; 167fa9e4066Sahrens struct drr_write { 168fa9e4066Sahrens uint64_t drr_object; 169fa9e4066Sahrens dmu_object_type_t drr_type; 170fa9e4066Sahrens uint32_t drr_pad; 171fa9e4066Sahrens uint64_t drr_offset; 172fa9e4066Sahrens uint64_t drr_length; 1739e69d7d0SLori Alt uint64_t drr_toguid; 1749e69d7d0SLori Alt uint8_t drr_checksumtype; 1758e714474SLori Alt uint8_t drr_checksumflags; 1768e714474SLori Alt uint8_t drr_pad2[6]; 1778e714474SLori Alt ddt_key_t drr_key; /* deduplication key */ 178a2eea2e1Sahrens /* content follows */ 179fa9e4066Sahrens } drr_write; 180fa9e4066Sahrens struct drr_free { 181fa9e4066Sahrens uint64_t drr_object; 182fa9e4066Sahrens uint64_t drr_offset; 183fa9e4066Sahrens uint64_t drr_length; 1849e69d7d0SLori Alt uint64_t drr_toguid; 185fa9e4066Sahrens } drr_free; 1869e69d7d0SLori Alt struct drr_write_byref { 1879e69d7d0SLori Alt /* where to put the data */ 1889e69d7d0SLori Alt uint64_t drr_object; 1899e69d7d0SLori Alt uint64_t drr_offset; 1909e69d7d0SLori Alt uint64_t drr_length; 1919e69d7d0SLori Alt uint64_t drr_toguid; 1929e69d7d0SLori Alt /* where to find the prior copy of the data */ 1939e69d7d0SLori Alt uint64_t drr_refguid; 1949e69d7d0SLori Alt uint64_t drr_refobject; 1959e69d7d0SLori Alt uint64_t drr_refoffset; 1968e714474SLori Alt /* properties of the data */ 1979e69d7d0SLori Alt uint8_t drr_checksumtype; 1988e714474SLori Alt uint8_t drr_checksumflags; 1998e714474SLori Alt uint8_t drr_pad2[6]; 2008e714474SLori Alt ddt_key_t drr_key; /* deduplication key */ 2019e69d7d0SLori Alt } drr_write_byref; 2020a586ceaSMark Shellenbaum struct drr_spill { 2030a586ceaSMark Shellenbaum uint64_t drr_object; 2040a586ceaSMark Shellenbaum uint64_t drr_length; 2050a586ceaSMark Shellenbaum uint64_t drr_toguid; 2060a586ceaSMark Shellenbaum uint64_t drr_pad[4]; /* needed for crypto */ 2070a586ceaSMark Shellenbaum /* spill data follows */ 2080a586ceaSMark Shellenbaum } drr_spill; 209fa9e4066Sahrens } drr_u; 210fa9e4066Sahrens } dmu_replay_record_t; 211fa9e4066Sahrens 21299d5e173STim Haley /* diff record range types */ 21399d5e173STim Haley typedef enum diff_type { 21499d5e173STim Haley DDR_NONE = 0x1, 21599d5e173STim Haley DDR_INUSE = 0x2, 21699d5e173STim Haley DDR_FREE = 0x4 21799d5e173STim Haley } diff_type_t; 21899d5e173STim Haley 21999d5e173STim Haley /* 22099d5e173STim Haley * The diff reports back ranges of free or in-use objects. 22199d5e173STim Haley */ 22299d5e173STim Haley typedef struct dmu_diff_record { 22399d5e173STim Haley uint64_t ddr_type; 22499d5e173STim Haley uint64_t ddr_first; 22599d5e173STim Haley uint64_t ddr_last; 22699d5e173STim Haley } dmu_diff_record_t; 22799d5e173STim Haley 228ea8dc4b6Seschrock typedef struct zinject_record { 229ea8dc4b6Seschrock uint64_t zi_objset; 230ea8dc4b6Seschrock uint64_t zi_object; 231ea8dc4b6Seschrock uint64_t zi_start; 232ea8dc4b6Seschrock uint64_t zi_end; 233ea8dc4b6Seschrock uint64_t zi_guid; 234ea8dc4b6Seschrock uint32_t zi_level; 235ea8dc4b6Seschrock uint32_t zi_error; 236ea8dc4b6Seschrock uint64_t zi_type; 237ea8dc4b6Seschrock uint32_t zi_freq; 2388956713aSEric Schrock uint32_t zi_failfast; 23988ecc943SGeorge Wilson char zi_func[MAXNAMELEN]; 2408f18d1faSGeorge Wilson uint32_t zi_iotype; 241468c413aSTim Haley int32_t zi_duration; 242468c413aSTim Haley uint64_t zi_timer; 243*283b8460SGeorge.Wilson uint32_t zi_cmd; 244*283b8460SGeorge.Wilson uint32_t zi_pad; 245ea8dc4b6Seschrock } zinject_record_t; 246ea8dc4b6Seschrock 247ea8dc4b6Seschrock #define ZINJECT_NULL 0x1 248ea8dc4b6Seschrock #define ZINJECT_FLUSH_ARC 0x2 249ea8dc4b6Seschrock #define ZINJECT_UNLOAD_SPA 0x4 250ea8dc4b6Seschrock 251*283b8460SGeorge.Wilson typedef enum zinject_type { 252*283b8460SGeorge.Wilson ZINJECT_UNINITIALIZED, 253*283b8460SGeorge.Wilson ZINJECT_DATA_FAULT, 254*283b8460SGeorge.Wilson ZINJECT_DEVICE_FAULT, 255*283b8460SGeorge.Wilson ZINJECT_LABEL_FAULT, 256*283b8460SGeorge.Wilson ZINJECT_IGNORED_WRITES, 257*283b8460SGeorge.Wilson ZINJECT_PANIC, 258*283b8460SGeorge.Wilson ZINJECT_DELAY_IO, 259*283b8460SGeorge.Wilson } zinject_type_t; 260*283b8460SGeorge.Wilson 261ecd6cf80Smarks typedef struct zfs_share { 262ecd6cf80Smarks uint64_t z_exportdata; 263ecd6cf80Smarks uint64_t z_sharedata; 264ecd6cf80Smarks uint64_t z_sharetype; /* 0 = share, 1 = unshare */ 265ecd6cf80Smarks uint64_t z_sharemax; /* max length of share string */ 266ecd6cf80Smarks } zfs_share_t; 267ecd6cf80Smarks 268de8267e0Stimh /* 269de8267e0Stimh * ZFS file systems may behave the usual, POSIX-compliant way, where 270de8267e0Stimh * name lookups are case-sensitive. They may also be set up so that 271de8267e0Stimh * all the name lookups are case-insensitive, or so that only some 272de8267e0Stimh * lookups, the ones that set an FIGNORECASE flag, are case-insensitive. 273de8267e0Stimh */ 274de8267e0Stimh typedef enum zfs_case { 275de8267e0Stimh ZFS_CASE_SENSITIVE, 276de8267e0Stimh ZFS_CASE_INSENSITIVE, 277de8267e0Stimh ZFS_CASE_MIXED 278de8267e0Stimh } zfs_case_t; 279de8267e0Stimh 280fa9e4066Sahrens typedef struct zfs_cmd { 2814445fffbSMatthew Ahrens char zc_name[MAXPATHLEN]; /* name of pool or dataset */ 2824445fffbSMatthew Ahrens uint64_t zc_nvlist_src; /* really (char *) */ 2834445fffbSMatthew Ahrens uint64_t zc_nvlist_src_size; 2844445fffbSMatthew Ahrens uint64_t zc_nvlist_dst; /* really (char *) */ 2854445fffbSMatthew Ahrens uint64_t zc_nvlist_dst_size; 2864445fffbSMatthew Ahrens boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */ 2874445fffbSMatthew Ahrens int zc_pad2; 2884445fffbSMatthew Ahrens 2894445fffbSMatthew Ahrens /* 2904445fffbSMatthew Ahrens * The following members are for legacy ioctls which haven't been 2914445fffbSMatthew Ahrens * converted to the new method. 2924445fffbSMatthew Ahrens */ 2934445fffbSMatthew Ahrens uint64_t zc_history; /* really (char *) */ 29455434c77Sek char zc_value[MAXPATHLEN * 2]; 2953cb34c60Sahrens char zc_string[MAXNAMELEN]; 2969e69d7d0SLori Alt char zc_top_ds[MAXPATHLEN]; 297ea8dc4b6Seschrock uint64_t zc_guid; 298990b4856Slling uint64_t zc_nvlist_conf; /* really (char *) */ 299990b4856Slling uint64_t zc_nvlist_conf_size; 300fa9e4066Sahrens uint64_t zc_cookie; 301fa9e4066Sahrens uint64_t zc_objset_type; 302ecd6cf80Smarks uint64_t zc_perm_action; 3034445fffbSMatthew Ahrens uint64_t zc_history_len; 30406eeb2adSek uint64_t zc_history_offset; 30555434c77Sek uint64_t zc_obj; 306478ed9adSEric Taylor uint64_t zc_iflags; /* internal to zfs(7fs) */ 307ecd6cf80Smarks zfs_share_t zc_share; 308fa9e4066Sahrens dmu_objset_stats_t zc_objset_stats; 309fa9e4066Sahrens struct drr_begin zc_begin_record; 310ea8dc4b6Seschrock zinject_record_t zc_inject_record; 311842727c2SChris Kirby boolean_t zc_defer_destroy; 312ca45db41SChris Kirby boolean_t zc_temphold; 313c99e4bdcSChris Kirby uint64_t zc_action_handle; 314c99e4bdcSChris Kirby int zc_cleanup_fd; 31599d5e173STim Haley uint8_t zc_pad[4]; /* alignment */ 316a7f53a56SChris Kirby uint64_t zc_sendobj; 317a7f53a56SChris Kirby uint64_t zc_fromobj; 318a7f53a56SChris Kirby uint64_t zc_createtxg; 31999d5e173STim Haley zfs_stat_t zc_stat; 320fa9e4066Sahrens } zfs_cmd_t; 321fa9e4066Sahrens 32214843421SMatthew Ahrens typedef struct zfs_useracct { 32314843421SMatthew Ahrens char zu_domain[256]; 32414843421SMatthew Ahrens uid_t zu_rid; 32514843421SMatthew Ahrens uint32_t zu_pad; 32614843421SMatthew Ahrens uint64_t zu_space; 32714843421SMatthew Ahrens } zfs_useracct_t; 32814843421SMatthew Ahrens 329c99e4bdcSChris Kirby #define ZFSDEV_MAX_MINOR (1 << 16) 330c99e4bdcSChris Kirby #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1) 331a0965f35Sbonwick 3321195e687SMark J Musante #define ZPOOL_EXPORT_AFTER_SPLIT 0x1 3331195e687SMark J Musante 334fa9e4066Sahrens #ifdef _KERNEL 335fa9e4066Sahrens 336da6c28aaSamw typedef struct zfs_creat { 337de8267e0Stimh nvlist_t *zct_zplprops; 338da6c28aaSamw nvlist_t *zct_props; 339da6c28aaSamw } zfs_creat_t; 340da6c28aaSamw 341fa9e4066Sahrens extern dev_info_t *zfs_dip; 342fa9e4066Sahrens 343ecd6cf80Smarks extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 344ecd6cf80Smarks extern int zfs_secpolicy_rename_perms(const char *from, 345ecd6cf80Smarks const char *to, cred_t *cr); 346ecd6cf80Smarks extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 347fa9e4066Sahrens extern int zfs_busy(void); 348fd136879SMatthew Ahrens extern int zfs_unmount_snap(const char *, void *); 349fa9e4066Sahrens 350c99e4bdcSChris Kirby /* 351c99e4bdcSChris Kirby * ZFS minor numbers can refer to either a control device instance or 352c99e4bdcSChris Kirby * a zvol. Depending on the value of zss_type, zss_data points to either 353c99e4bdcSChris Kirby * a zvol_state_t or a zfs_onexit_t. 354c99e4bdcSChris Kirby */ 355c99e4bdcSChris Kirby enum zfs_soft_state_type { 356c99e4bdcSChris Kirby ZSST_ZVOL, 357c99e4bdcSChris Kirby ZSST_CTLDEV 358c99e4bdcSChris Kirby }; 359c99e4bdcSChris Kirby 360c99e4bdcSChris Kirby typedef struct zfs_soft_state { 361c99e4bdcSChris Kirby enum zfs_soft_state_type zss_type; 362c99e4bdcSChris Kirby void *zss_data; 363c99e4bdcSChris Kirby } zfs_soft_state_t; 364c99e4bdcSChris Kirby 365c99e4bdcSChris Kirby extern void *zfsdev_get_soft_state(minor_t minor, 366c99e4bdcSChris Kirby enum zfs_soft_state_type which); 367c99e4bdcSChris Kirby extern minor_t zfsdev_minor_alloc(void); 368c99e4bdcSChris Kirby 369c99e4bdcSChris Kirby extern void *zfsdev_state; 370c99e4bdcSChris Kirby extern kmutex_t zfsdev_state_lock; 371c99e4bdcSChris Kirby 372fa9e4066Sahrens #endif /* _KERNEL */ 373fa9e4066Sahrens 374fa9e4066Sahrens #ifdef __cplusplus 375fa9e4066Sahrens } 376fa9e4066Sahrens #endif 377fa9e4066Sahrens 378fa9e4066Sahrens #endif /* _SYS_ZFS_IOCTL_H */ 379