Print this page
6536 zfs send: want a way to disable setting of DRR_FLAG_FREERECORDS
Reviewed by: Anil Vijarnia <avijarnia@racktopsystems.com>
Reviewed by: Kim Shrier <kshrier@racktopsystems.com>
Reviewed by: Matthew Ahrens <mahrens@delphix.com>
Split |
Close |
Expand all |
Collapse all |
--- old/usr/src/uts/common/fs/zfs/sys/zfs_ioctl.h
+++ new/usr/src/uts/common/fs/zfs/sys/zfs_ioctl.h
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
↓ open down ↓ |
13 lines elided |
↑ open up ↑ |
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21 /*
22 22 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23 23 * Copyright (c) 2012, 2015 by Delphix. All rights reserved.
24 + * Copyright 2016 RackTop Systems.
24 25 */
25 26
26 27 #ifndef _SYS_ZFS_IOCTL_H
27 28 #define _SYS_ZFS_IOCTL_H
28 29
29 30 #include <sys/cred.h>
30 31 #include <sys/dmu.h>
31 32 #include <sys/zio.h>
32 33 #include <sys/dsl_deleg.h>
33 34 #include <sys/spa.h>
34 35 #include <sys/zfs_stat.h>
35 36
36 37 #ifdef _KERNEL
37 38 #include <sys/nvpair.h>
38 39 #endif /* _KERNEL */
39 40
40 41 #ifdef __cplusplus
41 42 extern "C" {
42 43 #endif
43 44
44 45 /*
45 46 * The structures in this file are passed between userland and the
46 47 * kernel. Userland may be running a 32-bit process, while the kernel
47 48 * is 64-bit. Therefore, these structures need to compile the same in
48 49 * 32-bit and 64-bit. This means not using type "long", and adding
49 50 * explicit padding so that the 32-bit structure will not be packed more
50 51 * tightly than the 64-bit structure (which requires 64-bit alignment).
51 52 */
52 53
53 54 /*
54 55 * Property values for snapdir
55 56 */
56 57 #define ZFS_SNAPDIR_HIDDEN 0
57 58 #define ZFS_SNAPDIR_VISIBLE 1
58 59
59 60 /*
60 61 * Field manipulation macros for the drr_versioninfo field of the
61 62 * send stream header.
62 63 */
63 64
64 65 /*
65 66 * Header types for zfs send streams.
66 67 */
67 68 typedef enum drr_headertype {
68 69 DMU_SUBSTREAM = 0x1,
69 70 DMU_COMPOUNDSTREAM = 0x2
70 71 } drr_headertype_t;
71 72
72 73 #define DMU_GET_STREAM_HDRTYPE(vi) BF64_GET((vi), 0, 2)
73 74 #define DMU_SET_STREAM_HDRTYPE(vi, x) BF64_SET((vi), 0, 2, x)
74 75
75 76 #define DMU_GET_FEATUREFLAGS(vi) BF64_GET((vi), 2, 30)
76 77 #define DMU_SET_FEATUREFLAGS(vi, x) BF64_SET((vi), 2, 30, x)
77 78
78 79 /*
79 80 * Feature flags for zfs send streams (flags in drr_versioninfo)
80 81 */
81 82
82 83 #define DMU_BACKUP_FEATURE_DEDUP (1 << 0)
83 84 #define DMU_BACKUP_FEATURE_DEDUPPROPS (1 << 1)
84 85 #define DMU_BACKUP_FEATURE_SA_SPILL (1 << 2)
85 86 /* flags #3 - #15 are reserved for incompatible closed-source implementations */
86 87 #define DMU_BACKUP_FEATURE_EMBED_DATA (1 << 16)
87 88 #define DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 (1 << 17)
88 89 /* flag #18 is reserved for a Delphix feature */
89 90 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS (1 << 19)
90 91 #define DMU_BACKUP_FEATURE_RESUMING (1 << 20)
91 92
92 93 /*
93 94 * Mask of all supported backup features
94 95 */
95 96 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
96 97 DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
97 98 DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_EMBED_DATA_LZ4 | \
98 99 DMU_BACKUP_FEATURE_RESUMING | \
99 100 DMU_BACKUP_FEATURE_LARGE_BLOCKS)
100 101
101 102 /* Are all features in the given flag word currently supported? */
102 103 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
103 104
104 105 typedef enum dmu_send_resume_token_version {
105 106 ZFS_SEND_RESUME_TOKEN_VERSION = 1
106 107 } dmu_send_resume_token_version_t;
107 108
108 109 /*
109 110 * The drr_versioninfo field of the dmu_replay_record has the
110 111 * following layout:
111 112 *
112 113 * 64 56 48 40 32 24 16 8 0
113 114 * +-------+-------+-------+-------+-------+-------+-------+-------+
114 115 * | reserved | feature-flags |C|S|
115 116 * +-------+-------+-------+-------+-------+-------+-------+-------+
116 117 *
↓ open down ↓ |
83 lines elided |
↑ open up ↑ |
117 118 * The low order two bits indicate the header type: SUBSTREAM (0x1)
118 119 * or COMPOUNDSTREAM (0x2). Using two bits for this is historical:
119 120 * this field used to be a version number, where the two version types
120 121 * were 1 and 2. Using two bits for this allows earlier versions of
121 122 * the code to be able to recognize send streams that don't use any
122 123 * of the features indicated by feature flags.
123 124 */
124 125
125 126 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
126 127
128 +/*
129 + * Send stream flags. Bits 24-31 are reserved for vendor-specific
130 + * implementations and should not be used.
131 + */
127 132 #define DRR_FLAG_CLONE (1<<0)
128 133 #define DRR_FLAG_CI_DATA (1<<1)
129 134 /*
130 135 * This send stream, if it is a full send, includes the FREE and FREEOBJECT
131 136 * records that are created by the sending process. This means that the send
132 137 * stream can be received as a clone, even though it is not an incremental.
133 138 * This is not implemented as a feature flag, because the receiving side does
134 139 * not need to have implemented it to receive this stream; it is fully backwards
135 140 * compatible. We need a flag, though, because full send streams without it
136 141 * cannot necessarily be received as a clone correctly.
137 142 */
138 143 #define DRR_FLAG_FREERECORDS (1<<2)
139 144
140 145 /*
141 146 * flags in the drr_checksumflags field in the DRR_WRITE and
142 147 * DRR_WRITE_BYREF blocks
143 148 */
144 149 #define DRR_CHECKSUM_DEDUP (1<<0)
145 150
146 151 #define DRR_IS_DEDUP_CAPABLE(flags) ((flags) & DRR_CHECKSUM_DEDUP)
147 152
148 153 /*
149 154 * zfs ioctl command structure
150 155 */
151 156 typedef struct dmu_replay_record {
152 157 enum {
153 158 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
154 159 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
155 160 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_NUMTYPES
156 161 } drr_type;
157 162 uint32_t drr_payloadlen;
158 163 union {
159 164 struct drr_begin {
160 165 uint64_t drr_magic;
161 166 uint64_t drr_versioninfo; /* was drr_version */
162 167 uint64_t drr_creation_time;
163 168 dmu_objset_type_t drr_type;
164 169 uint32_t drr_flags;
165 170 uint64_t drr_toguid;
166 171 uint64_t drr_fromguid;
167 172 char drr_toname[MAXNAMELEN];
168 173 } drr_begin;
169 174 struct drr_end {
170 175 zio_cksum_t drr_checksum;
171 176 uint64_t drr_toguid;
172 177 } drr_end;
173 178 struct drr_object {
174 179 uint64_t drr_object;
175 180 dmu_object_type_t drr_type;
176 181 dmu_object_type_t drr_bonustype;
177 182 uint32_t drr_blksz;
178 183 uint32_t drr_bonuslen;
179 184 uint8_t drr_checksumtype;
180 185 uint8_t drr_compress;
181 186 uint8_t drr_pad[6];
182 187 uint64_t drr_toguid;
183 188 /* bonus content follows */
184 189 } drr_object;
185 190 struct drr_freeobjects {
186 191 uint64_t drr_firstobj;
187 192 uint64_t drr_numobjs;
188 193 uint64_t drr_toguid;
189 194 } drr_freeobjects;
190 195 struct drr_write {
191 196 uint64_t drr_object;
192 197 dmu_object_type_t drr_type;
193 198 uint32_t drr_pad;
194 199 uint64_t drr_offset;
195 200 uint64_t drr_length;
196 201 uint64_t drr_toguid;
197 202 uint8_t drr_checksumtype;
198 203 uint8_t drr_checksumflags;
199 204 uint8_t drr_pad2[6];
200 205 ddt_key_t drr_key; /* deduplication key */
201 206 /* content follows */
202 207 } drr_write;
203 208 struct drr_free {
204 209 uint64_t drr_object;
205 210 uint64_t drr_offset;
206 211 uint64_t drr_length;
207 212 uint64_t drr_toguid;
208 213 } drr_free;
209 214 struct drr_write_byref {
210 215 /* where to put the data */
211 216 uint64_t drr_object;
212 217 uint64_t drr_offset;
213 218 uint64_t drr_length;
214 219 uint64_t drr_toguid;
215 220 /* where to find the prior copy of the data */
216 221 uint64_t drr_refguid;
217 222 uint64_t drr_refobject;
218 223 uint64_t drr_refoffset;
219 224 /* properties of the data */
220 225 uint8_t drr_checksumtype;
221 226 uint8_t drr_checksumflags;
222 227 uint8_t drr_pad2[6];
223 228 ddt_key_t drr_key; /* deduplication key */
224 229 } drr_write_byref;
225 230 struct drr_spill {
226 231 uint64_t drr_object;
227 232 uint64_t drr_length;
228 233 uint64_t drr_toguid;
229 234 uint64_t drr_pad[4]; /* needed for crypto */
230 235 /* spill data follows */
231 236 } drr_spill;
232 237 struct drr_write_embedded {
233 238 uint64_t drr_object;
234 239 uint64_t drr_offset;
235 240 /* logical length, should equal blocksize */
236 241 uint64_t drr_length;
237 242 uint64_t drr_toguid;
238 243 uint8_t drr_compression;
239 244 uint8_t drr_etype;
240 245 uint8_t drr_pad[6];
241 246 uint32_t drr_lsize; /* uncompressed size of payload */
242 247 uint32_t drr_psize; /* compr. (real) size of payload */
243 248 /* (possibly compressed) content follows */
244 249 } drr_write_embedded;
245 250
246 251 /*
247 252 * Nore: drr_checksum is overlaid with all record types
248 253 * except DRR_BEGIN. Therefore its (non-pad) members
249 254 * must not overlap with members from the other structs.
250 255 * We accomplish this by putting its members at the very
251 256 * end of the struct.
252 257 */
253 258 struct drr_checksum {
254 259 uint64_t drr_pad[34];
255 260 /*
256 261 * fletcher-4 checksum of everything preceding the
257 262 * checksum.
258 263 */
259 264 zio_cksum_t drr_checksum;
260 265 } drr_checksum;
261 266 } drr_u;
262 267 } dmu_replay_record_t;
263 268
264 269 /* diff record range types */
265 270 typedef enum diff_type {
266 271 DDR_NONE = 0x1,
267 272 DDR_INUSE = 0x2,
268 273 DDR_FREE = 0x4
269 274 } diff_type_t;
270 275
271 276 /*
272 277 * The diff reports back ranges of free or in-use objects.
273 278 */
274 279 typedef struct dmu_diff_record {
275 280 uint64_t ddr_type;
276 281 uint64_t ddr_first;
277 282 uint64_t ddr_last;
278 283 } dmu_diff_record_t;
279 284
280 285 typedef struct zinject_record {
281 286 uint64_t zi_objset;
282 287 uint64_t zi_object;
283 288 uint64_t zi_start;
284 289 uint64_t zi_end;
285 290 uint64_t zi_guid;
286 291 uint32_t zi_level;
287 292 uint32_t zi_error;
288 293 uint64_t zi_type;
289 294 uint32_t zi_freq;
290 295 uint32_t zi_failfast;
291 296 char zi_func[MAXNAMELEN];
292 297 uint32_t zi_iotype;
293 298 int32_t zi_duration;
294 299 uint64_t zi_timer;
295 300 uint64_t zi_nlanes;
296 301 uint32_t zi_cmd;
297 302 uint32_t zi_pad;
298 303 } zinject_record_t;
299 304
300 305 #define ZINJECT_NULL 0x1
301 306 #define ZINJECT_FLUSH_ARC 0x2
302 307 #define ZINJECT_UNLOAD_SPA 0x4
303 308
304 309 typedef enum zinject_type {
305 310 ZINJECT_UNINITIALIZED,
306 311 ZINJECT_DATA_FAULT,
307 312 ZINJECT_DEVICE_FAULT,
308 313 ZINJECT_LABEL_FAULT,
309 314 ZINJECT_IGNORED_WRITES,
310 315 ZINJECT_PANIC,
311 316 ZINJECT_DELAY_IO,
312 317 } zinject_type_t;
313 318
314 319 typedef struct zfs_share {
315 320 uint64_t z_exportdata;
316 321 uint64_t z_sharedata;
317 322 uint64_t z_sharetype; /* 0 = share, 1 = unshare */
318 323 uint64_t z_sharemax; /* max length of share string */
319 324 } zfs_share_t;
320 325
321 326 /*
322 327 * ZFS file systems may behave the usual, POSIX-compliant way, where
323 328 * name lookups are case-sensitive. They may also be set up so that
324 329 * all the name lookups are case-insensitive, or so that only some
325 330 * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
326 331 */
327 332 typedef enum zfs_case {
328 333 ZFS_CASE_SENSITIVE,
329 334 ZFS_CASE_INSENSITIVE,
330 335 ZFS_CASE_MIXED
331 336 } zfs_case_t;
332 337
333 338 typedef struct zfs_cmd {
334 339 char zc_name[MAXPATHLEN]; /* name of pool or dataset */
335 340 uint64_t zc_nvlist_src; /* really (char *) */
336 341 uint64_t zc_nvlist_src_size;
337 342 uint64_t zc_nvlist_dst; /* really (char *) */
338 343 uint64_t zc_nvlist_dst_size;
339 344 boolean_t zc_nvlist_dst_filled; /* put an nvlist in dst? */
340 345 int zc_pad2;
341 346
342 347 /*
343 348 * The following members are for legacy ioctls which haven't been
344 349 * converted to the new method.
345 350 */
346 351 uint64_t zc_history; /* really (char *) */
347 352 char zc_value[MAXPATHLEN * 2];
348 353 char zc_string[MAXNAMELEN];
349 354 uint64_t zc_guid;
350 355 uint64_t zc_nvlist_conf; /* really (char *) */
351 356 uint64_t zc_nvlist_conf_size;
352 357 uint64_t zc_cookie;
353 358 uint64_t zc_objset_type;
354 359 uint64_t zc_perm_action;
355 360 uint64_t zc_history_len;
356 361 uint64_t zc_history_offset;
357 362 uint64_t zc_obj;
358 363 uint64_t zc_iflags; /* internal to zfs(7fs) */
359 364 zfs_share_t zc_share;
360 365 dmu_objset_stats_t zc_objset_stats;
361 366 dmu_replay_record_t zc_begin_record;
362 367 zinject_record_t zc_inject_record;
363 368 uint32_t zc_defer_destroy;
364 369 uint32_t zc_flags;
365 370 uint64_t zc_action_handle;
366 371 int zc_cleanup_fd;
367 372 boolean_t zc_resumable;
368 373 uint64_t zc_sendobj;
369 374 uint64_t zc_fromobj;
370 375 uint64_t zc_createtxg;
371 376 zfs_stat_t zc_stat;
372 377 } zfs_cmd_t;
373 378
374 379 typedef struct zfs_useracct {
375 380 char zu_domain[256];
376 381 uid_t zu_rid;
377 382 uint32_t zu_pad;
378 383 uint64_t zu_space;
379 384 } zfs_useracct_t;
380 385
381 386 #define ZFSDEV_MAX_MINOR (1 << 16)
382 387 #define ZFS_MIN_MINOR (ZFSDEV_MAX_MINOR + 1)
383 388
384 389 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
385 390
386 391 #ifdef _KERNEL
387 392
388 393 typedef struct zfs_creat {
389 394 nvlist_t *zct_zplprops;
390 395 nvlist_t *zct_props;
391 396 } zfs_creat_t;
392 397
393 398 extern dev_info_t *zfs_dip;
394 399
395 400 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
396 401 extern int zfs_secpolicy_rename_perms(const char *from,
397 402 const char *to, cred_t *cr);
398 403 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
399 404 extern int zfs_busy(void);
400 405 extern int zfs_unmount_snap(const char *);
401 406 extern void zfs_destroy_unmount_origin(const char *);
402 407
403 408 /*
404 409 * ZFS minor numbers can refer to either a control device instance or
405 410 * a zvol. Depending on the value of zss_type, zss_data points to either
406 411 * a zvol_state_t or a zfs_onexit_t.
407 412 */
408 413 enum zfs_soft_state_type {
409 414 ZSST_ZVOL,
410 415 ZSST_CTLDEV
411 416 };
412 417
413 418 typedef struct zfs_soft_state {
414 419 enum zfs_soft_state_type zss_type;
415 420 void *zss_data;
416 421 } zfs_soft_state_t;
417 422
418 423 extern void *zfsdev_get_soft_state(minor_t minor,
419 424 enum zfs_soft_state_type which);
420 425 extern minor_t zfsdev_minor_alloc(void);
421 426
422 427 extern void *zfsdev_state;
423 428 extern kmutex_t zfsdev_state_lock;
424 429
425 430 #endif /* _KERNEL */
426 431
427 432 #ifdef __cplusplus
428 433 }
429 434 #endif
430 435
431 436 #endif /* _SYS_ZFS_IOCTL_H */
↓ open down ↓ |
295 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX