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