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 * 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 */ 67 typedef 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 */ 128 typedef struct dmu_replay_record { 129 enum { 130 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS, 131 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF, 132 DRR_SPILL, DRR_NUMTYPES 133 } drr_type; 134 uint32_t drr_payloadlen; 135 union { 136 struct drr_begin { 137 uint64_t drr_magic; 138 uint64_t drr_versioninfo; /* was drr_version */ 139 uint64_t drr_creation_time; 140 dmu_objset_type_t drr_type; 141 uint32_t drr_flags; 142 uint64_t drr_toguid; 143 uint64_t drr_fromguid; 144 char drr_toname[MAXNAMELEN]; 145 } drr_begin; 146 struct drr_end { 147 zio_cksum_t drr_checksum; 148 uint64_t drr_toguid; 149 } drr_end; 150 struct drr_object { 151 uint64_t drr_object; 152 dmu_object_type_t drr_type; 153 dmu_object_type_t drr_bonustype; 154 uint32_t drr_blksz; 155 uint32_t drr_bonuslen; 156 uint8_t drr_checksumtype; 157 uint8_t drr_compress; 158 uint8_t drr_pad[6]; 159 uint64_t drr_toguid; 160 /* bonus content follows */ 161 } drr_object; 162 struct drr_freeobjects { 163 uint64_t drr_firstobj; 164 uint64_t drr_numobjs; 165 uint64_t drr_toguid; 166 } drr_freeobjects; 167 struct drr_write { 168 uint64_t drr_object; 169 dmu_object_type_t drr_type; 170 uint32_t drr_pad; 171 uint64_t drr_offset; 172 uint64_t drr_length; 173 uint64_t drr_toguid; 174 uint8_t drr_checksumtype; 175 uint8_t drr_checksumflags; 176 uint8_t drr_pad2[6]; 177 ddt_key_t drr_key; /* deduplication key */ 178 /* content follows */ 179 } drr_write; 180 struct drr_free { 181 uint64_t drr_object; 182 uint64_t drr_offset; 183 uint64_t drr_length; 184 uint64_t drr_toguid; 185 } drr_free; 186 struct drr_write_byref { 187 /* where to put the data */ 188 uint64_t drr_object; 189 uint64_t drr_offset; 190 uint64_t drr_length; 191 uint64_t drr_toguid; 192 /* where to find the prior copy of the data */ 193 uint64_t drr_refguid; 194 uint64_t drr_refobject; 195 uint64_t drr_refoffset; 196 /* properties of the data */ 197 uint8_t drr_checksumtype; 198 uint8_t drr_checksumflags; 199 uint8_t drr_pad2[6]; 200 ddt_key_t drr_key; /* deduplication key */ 201 } drr_write_byref; 202 struct drr_spill { 203 uint64_t drr_object; 204 uint64_t drr_length; 205 uint64_t drr_toguid; 206 uint64_t drr_pad[4]; /* needed for crypto */ 207 /* spill data follows */ 208 } drr_spill; 209 } drr_u; 210 } dmu_replay_record_t; 211 212 /* diff record range types */ 213 typedef enum diff_type { 214 DDR_NONE = 0x1, 215 DDR_INUSE = 0x2, 216 DDR_FREE = 0x4 217 } diff_type_t; 218 219 /* 220 * The diff reports back ranges of free or in-use objects. 221 */ 222 typedef struct dmu_diff_record { 223 uint64_t ddr_type; 224 uint64_t ddr_first; 225 uint64_t ddr_last; 226 } dmu_diff_record_t; 227 228 typedef struct zinject_record { 229 uint64_t zi_objset; 230 uint64_t zi_object; 231 uint64_t zi_start; 232 uint64_t zi_end; 233 uint64_t zi_guid; 234 uint32_t zi_level; 235 uint32_t zi_error; 236 uint64_t zi_type; 237 uint32_t zi_freq; 238 uint32_t zi_failfast; 239 char zi_func[MAXNAMELEN]; 240 uint32_t zi_iotype; 241 int32_t zi_duration; 242 uint64_t zi_timer; 243 } zinject_record_t; 244 245 #define ZINJECT_NULL 0x1 246 #define ZINJECT_FLUSH_ARC 0x2 247 #define ZINJECT_UNLOAD_SPA 0x4 248 249 typedef struct zfs_share { 250 uint64_t z_exportdata; 251 uint64_t z_sharedata; 252 uint64_t z_sharetype; /* 0 = share, 1 = unshare */ 253 uint64_t z_sharemax; /* max length of share string */ 254 } zfs_share_t; 255 256 /* 257 * ZFS file systems may behave the usual, POSIX-compliant way, where 258 * name lookups are case-sensitive. They may also be set up so that 259 * all the name lookups are case-insensitive, or so that only some 260 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive. 261 */ 262 typedef enum zfs_case { 263 ZFS_CASE_SENSITIVE, 264 ZFS_CASE_INSENSITIVE, 265 ZFS_CASE_MIXED 266 } zfs_case_t; 267 268 typedef struct zfs_cmd { 269 char zc_name[MAXPATHLEN]; /* name of pool or dataset */ 270 uint64_t zc_nvlist_src; /* really (char *) */ 271 uint64_t zc_nvlist_src_size; 272 uint64_t zc_nvlist_dst; /* really (char *) */ 273 uint64_t zc_nvlist_dst_size; 274 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */ 275 int zc_pad2; 276 277 /* 278 * The following members are for legacy ioctls which haven't been 279 * converted to the new method. 280 */ 281 uint64_t zc_history; /* really (char *) */ 282 char zc_value[MAXPATHLEN * 2]; 283 char zc_string[MAXNAMELEN]; 284 char zc_top_ds[MAXPATHLEN]; 285 uint64_t zc_guid; 286 uint64_t zc_nvlist_conf; /* really (char *) */ 287 uint64_t zc_nvlist_conf_size; 288 uint64_t zc_cookie; 289 uint64_t zc_objset_type; 290 uint64_t zc_perm_action; 291 uint64_t zc_history_len; 292 uint64_t zc_history_offset; 293 uint64_t zc_obj; 294 uint64_t zc_iflags; /* internal to zfs(7fs) */ 295 zfs_share_t zc_share; 296 dmu_objset_stats_t zc_objset_stats; 297 struct drr_begin zc_begin_record; 298 zinject_record_t zc_inject_record; 299 boolean_t zc_defer_destroy; 300 boolean_t zc_temphold; 301 uint64_t zc_action_handle; 302 int zc_cleanup_fd; 303 uint8_t zc_pad[4]; /* alignment */ 304 uint64_t zc_sendobj; 305 uint64_t zc_fromobj; 306 uint64_t zc_createtxg; 307 zfs_stat_t zc_stat; 308 } zfs_cmd_t; 309 310 typedef struct zfs_useracct { 311 char zu_domain[256]; 312 uid_t zu_rid; 313 uint32_t zu_pad; 314 uint64_t zu_space; 315 } zfs_useracct_t; 316 317 #define ZFSDEV_MAX_MINOR (1 << 16) 318 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1) 319 320 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1 321 322 #ifdef _KERNEL 323 324 typedef struct zfs_creat { 325 nvlist_t *zct_zplprops; 326 nvlist_t *zct_props; 327 } zfs_creat_t; 328 329 extern dev_info_t *zfs_dip; 330 331 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr); 332 extern int zfs_secpolicy_rename_perms(const char *from, 333 const char *to, cred_t *cr); 334 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr); 335 extern int zfs_busy(void); 336 extern int zfs_unmount_snap(const char *, void *); 337 338 /* 339 * ZFS minor numbers can refer to either a control device instance or 340 * a zvol. Depending on the value of zss_type, zss_data points to either 341 * a zvol_state_t or a zfs_onexit_t. 342 */ 343 enum zfs_soft_state_type { 344 ZSST_ZVOL, 345 ZSST_CTLDEV 346 }; 347 348 typedef struct zfs_soft_state { 349 enum zfs_soft_state_type zss_type; 350 void *zss_data; 351 } zfs_soft_state_t; 352 353 extern void *zfsdev_get_soft_state(minor_t minor, 354 enum zfs_soft_state_type which); 355 extern minor_t zfsdev_minor_alloc(void); 356 357 extern void *zfsdev_state; 358 extern kmutex_t zfsdev_state_lock; 359 360 #endif /* _KERNEL */ 361 362 #ifdef __cplusplus 363 } 364 #endif 365 366 #endif /* _SYS_ZFS_IOCTL_H */ 367