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