]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - include/sys/zfs_ioctl.h
Implement Redacted Send/Receive
[FreeBSD/FreeBSD.git] / include / sys / zfs_ioctl.h
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, 2018 by Delphix. All rights reserved.
24  * Copyright 2016 RackTop Systems.
25  * Copyright (c) 2017, Intel Corporation.
26  */
27
28 #ifndef _SYS_ZFS_IOCTL_H
29 #define _SYS_ZFS_IOCTL_H
30
31 #include <sys/cred.h>
32 #include <sys/dmu.h>
33 #include <sys/zio.h>
34 #include <sys/dsl_deleg.h>
35 #include <sys/spa.h>
36 #include <sys/zfs_stat.h>
37
38 #ifdef _KERNEL
39 #include <sys/nvpair.h>
40 #endif  /* _KERNEL */
41
42 #ifdef  __cplusplus
43 extern "C" {
44 #endif
45
46 /*
47  * The structures in this file are passed between userland and the
48  * kernel.  Userland may be running a 32-bit process, while the kernel
49  * is 64-bit.  Therefore, these structures need to compile the same in
50  * 32-bit and 64-bit.  This means not using type "long", and adding
51  * explicit padding so that the 32-bit structure will not be packed more
52  * tightly than the 64-bit structure (which requires 64-bit alignment).
53  */
54
55 /*
56  * Property values for snapdir
57  */
58 #define ZFS_SNAPDIR_HIDDEN              0
59 #define ZFS_SNAPDIR_VISIBLE             1
60
61 /*
62  * Property values for snapdev
63  */
64 #define ZFS_SNAPDEV_HIDDEN              0
65 #define ZFS_SNAPDEV_VISIBLE             1
66 /*
67  * Property values for acltype
68  */
69 #define ZFS_ACLTYPE_OFF                 0
70 #define ZFS_ACLTYPE_POSIXACL            1
71
72 /*
73  * Field manipulation macros for the drr_versioninfo field of the
74  * send stream header.
75  */
76
77 /*
78  * Header types for zfs send streams.
79  */
80 typedef enum drr_headertype {
81         DMU_SUBSTREAM = 0x1,
82         DMU_COMPOUNDSTREAM = 0x2
83 } drr_headertype_t;
84
85 #define DMU_GET_STREAM_HDRTYPE(vi)      BF64_GET((vi), 0, 2)
86 #define DMU_SET_STREAM_HDRTYPE(vi, x)   BF64_SET((vi), 0, 2, x)
87
88 #define DMU_GET_FEATUREFLAGS(vi)        BF64_GET((vi), 2, 30)
89 #define DMU_SET_FEATUREFLAGS(vi, x)     BF64_SET((vi), 2, 30, x)
90
91 /*
92  * Feature flags for zfs send streams (flags in drr_versioninfo)
93  */
94
95 #define DMU_BACKUP_FEATURE_DEDUP                (1 << 0)
96 #define DMU_BACKUP_FEATURE_DEDUPPROPS           (1 << 1)
97 #define DMU_BACKUP_FEATURE_SA_SPILL             (1 << 2)
98 /* flags #3 - #15 are reserved for incompatible closed-source implementations */
99 #define DMU_BACKUP_FEATURE_EMBED_DATA           (1 << 16)
100 #define DMU_BACKUP_FEATURE_LZ4                  (1 << 17)
101 /* flag #18 is reserved for a Delphix feature */
102 #define DMU_BACKUP_FEATURE_LARGE_BLOCKS         (1 << 19)
103 #define DMU_BACKUP_FEATURE_RESUMING             (1 << 20)
104 #define DMU_BACKUP_FEATURE_REDACTED             (1 << 21)
105 #define DMU_BACKUP_FEATURE_COMPRESSED           (1 << 22)
106 #define DMU_BACKUP_FEATURE_LARGE_DNODE          (1 << 23)
107 #define DMU_BACKUP_FEATURE_RAW                  (1 << 24)
108 /* flag #25 is reserved for the ZSTD compression feature */
109 #define DMU_BACKUP_FEATURE_HOLDS                (1 << 26)
110
111 /*
112  * Mask of all supported backup features
113  */
114 #define DMU_BACKUP_FEATURE_MASK (DMU_BACKUP_FEATURE_DEDUP | \
115     DMU_BACKUP_FEATURE_DEDUPPROPS | DMU_BACKUP_FEATURE_SA_SPILL | \
116     DMU_BACKUP_FEATURE_EMBED_DATA | DMU_BACKUP_FEATURE_LZ4 | \
117     DMU_BACKUP_FEATURE_RESUMING | DMU_BACKUP_FEATURE_LARGE_BLOCKS | \
118     DMU_BACKUP_FEATURE_COMPRESSED | DMU_BACKUP_FEATURE_LARGE_DNODE | \
119     DMU_BACKUP_FEATURE_RAW | DMU_BACKUP_FEATURE_HOLDS | \
120         DMU_BACKUP_FEATURE_REDACTED)
121
122 /* Are all features in the given flag word currently supported? */
123 #define DMU_STREAM_SUPPORTED(x) (!((x) & ~DMU_BACKUP_FEATURE_MASK))
124
125 typedef enum dmu_send_resume_token_version {
126         ZFS_SEND_RESUME_TOKEN_VERSION = 1
127 } dmu_send_resume_token_version_t;
128
129 /*
130  * The drr_versioninfo field of the dmu_replay_record has the
131  * following layout:
132  *
133  *      64      56      48      40      32      24      16      8       0
134  *      +-------+-------+-------+-------+-------+-------+-------+-------+
135  *      |               reserved        |        feature-flags      |C|S|
136  *      +-------+-------+-------+-------+-------+-------+-------+-------+
137  *
138  * The low order two bits indicate the header type: SUBSTREAM (0x1)
139  * or COMPOUNDSTREAM (0x2).  Using two bits for this is historical:
140  * this field used to be a version number, where the two version types
141  * were 1 and 2.  Using two bits for this allows earlier versions of
142  * the code to be able to recognize send streams that don't use any
143  * of the features indicated by feature flags.
144  */
145
146 #define DMU_BACKUP_MAGIC 0x2F5bacbacULL
147
148 /*
149  * Send stream flags.  Bits 24-31 are reserved for vendor-specific
150  * implementations and should not be used.
151  */
152 #define DRR_FLAG_CLONE          (1<<0)
153 #define DRR_FLAG_CI_DATA        (1<<1)
154 /*
155  * This send stream, if it is a full send, includes the FREE and FREEOBJECT
156  * records that are created by the sending process.  This means that the send
157  * stream can be received as a clone, even though it is not an incremental.
158  * This is not implemented as a feature flag, because the receiving side does
159  * not need to have implemented it to receive this stream; it is fully backwards
160  * compatible.  We need a flag, though, because full send streams without it
161  * cannot necessarily be received as a clone correctly.
162  */
163 #define DRR_FLAG_FREERECORDS    (1<<2)
164 /*
165  * When DRR_FLAG_SPILL_BLOCK is set it indicates the DRR_OBJECT_SPILL
166  * and DRR_SPILL_UNMODIFIED flags are meaningful in the send stream.
167  *
168  * When DRR_FLAG_SPILL_BLOCK is set, DRR_OBJECT records will have
169  * DRR_OBJECT_SPILL set if and only if they should have a spill block
170  * (either an existing one, or a new one in the send stream).  When clear
171  * the object does not have a spill block and any existing spill block
172  * should be freed.
173  *
174  * Similarly, when DRR_FLAG_SPILL_BLOCK is set, DRR_SPILL records will
175  * have DRR_SPILL_UNMODIFIED set if and only if they were included for
176  * backward compatibility purposes, and can be safely ignored by new versions
177  * of zfs receive.  Previous versions of ZFS which do not understand the
178  * DRR_FLAG_SPILL_BLOCK will process this record and recreate any missing
179  * spill blocks.
180  */
181 #define DRR_FLAG_SPILL_BLOCK    (1<<3)
182
183 /*
184  * flags in the drr_flags field in the DRR_WRITE, DRR_SPILL, DRR_OBJECT,
185  * DRR_WRITE_BYREF, and DRR_OBJECT_RANGE blocks
186  */
187 #define DRR_CHECKSUM_DEDUP      (1<<0) /* not used for SPILL records */
188 #define DRR_RAW_BYTESWAP        (1<<1)
189 #define DRR_OBJECT_SPILL        (1<<2) /* OBJECT record has a spill block */
190 #define DRR_SPILL_UNMODIFIED    (1<<2) /* SPILL record for unmodified block */
191
192 #define DRR_IS_DEDUP_CAPABLE(flags)     ((flags) & DRR_CHECKSUM_DEDUP)
193 #define DRR_IS_RAW_BYTESWAPPED(flags)   ((flags) & DRR_RAW_BYTESWAP)
194 #define DRR_OBJECT_HAS_SPILL(flags)     ((flags) & DRR_OBJECT_SPILL)
195 #define DRR_SPILL_IS_UNMODIFIED(flags)  ((flags) & DRR_SPILL_UNMODIFIED)
196
197 /* deal with compressed drr_write replay records */
198 #define DRR_WRITE_COMPRESSED(drrw)      ((drrw)->drr_compressiontype != 0)
199 #define DRR_WRITE_PAYLOAD_SIZE(drrw) \
200         (DRR_WRITE_COMPRESSED(drrw) ? (drrw)->drr_compressed_size : \
201         (drrw)->drr_logical_size)
202 #define DRR_SPILL_PAYLOAD_SIZE(drrs) \
203         ((drrs)->drr_compressed_size ? \
204         (drrs)->drr_compressed_size : (drrs)->drr_length)
205 #define DRR_OBJECT_PAYLOAD_SIZE(drro) \
206         ((drro)->drr_raw_bonuslen != 0 ? \
207         (drro)->drr_raw_bonuslen : P2ROUNDUP((drro)->drr_bonuslen, 8))
208
209 /*
210  * zfs ioctl command structure
211  */
212 typedef struct dmu_replay_record {
213         enum {
214                 DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
215                 DRR_WRITE, DRR_FREE, DRR_END, DRR_WRITE_BYREF,
216                 DRR_SPILL, DRR_WRITE_EMBEDDED, DRR_OBJECT_RANGE, DRR_REDACT,
217                 DRR_NUMTYPES
218         } drr_type;
219         uint32_t drr_payloadlen;
220         union {
221                 struct drr_begin {
222                         uint64_t drr_magic;
223                         uint64_t drr_versioninfo; /* was drr_version */
224                         uint64_t drr_creation_time;
225                         dmu_objset_type_t drr_type;
226                         uint32_t drr_flags;
227                         uint64_t drr_toguid;
228                         uint64_t drr_fromguid;
229                         char drr_toname[MAXNAMELEN];
230                 } drr_begin;
231                 struct drr_end {
232                         zio_cksum_t drr_checksum;
233                         uint64_t drr_toguid;
234                 } drr_end;
235                 struct drr_object {
236                         uint64_t drr_object;
237                         dmu_object_type_t drr_type;
238                         dmu_object_type_t drr_bonustype;
239                         uint32_t drr_blksz;
240                         uint32_t drr_bonuslen;
241                         uint8_t drr_checksumtype;
242                         uint8_t drr_compress;
243                         uint8_t drr_dn_slots;
244                         uint8_t drr_flags;
245                         uint32_t drr_raw_bonuslen;
246                         uint64_t drr_toguid;
247                         /* only (possibly) nonzero for raw streams */
248                         uint8_t drr_indblkshift;
249                         uint8_t drr_nlevels;
250                         uint8_t drr_nblkptr;
251                         uint8_t drr_pad[5];
252                         uint64_t drr_maxblkid;
253                         /* bonus content follows */
254                 } drr_object;
255                 struct drr_freeobjects {
256                         uint64_t drr_firstobj;
257                         uint64_t drr_numobjs;
258                         uint64_t drr_toguid;
259                 } drr_freeobjects;
260                 struct drr_write {
261                         uint64_t drr_object;
262                         dmu_object_type_t drr_type;
263                         uint32_t drr_pad;
264                         uint64_t drr_offset;
265                         uint64_t drr_logical_size;
266                         uint64_t drr_toguid;
267                         uint8_t drr_checksumtype;
268                         uint8_t drr_flags;
269                         uint8_t drr_compressiontype;
270                         uint8_t drr_pad2[5];
271                         /* deduplication key */
272                         ddt_key_t drr_key;
273                         /* only nonzero if drr_compressiontype is not 0 */
274                         uint64_t drr_compressed_size;
275                         /* only nonzero for raw streams */
276                         uint8_t drr_salt[ZIO_DATA_SALT_LEN];
277                         uint8_t drr_iv[ZIO_DATA_IV_LEN];
278                         uint8_t drr_mac[ZIO_DATA_MAC_LEN];
279                         /* content follows */
280                 } drr_write;
281                 struct drr_free {
282                         uint64_t drr_object;
283                         uint64_t drr_offset;
284                         uint64_t drr_length;
285                         uint64_t drr_toguid;
286                 } drr_free;
287                 struct drr_write_byref {
288                         /* where to put the data */
289                         uint64_t drr_object;
290                         uint64_t drr_offset;
291                         uint64_t drr_length;
292                         uint64_t drr_toguid;
293                         /* where to find the prior copy of the data */
294                         uint64_t drr_refguid;
295                         uint64_t drr_refobject;
296                         uint64_t drr_refoffset;
297                         /* properties of the data */
298                         uint8_t drr_checksumtype;
299                         uint8_t drr_flags;
300                         uint8_t drr_pad2[6];
301                         ddt_key_t drr_key; /* deduplication key */
302                 } drr_write_byref;
303                 struct drr_spill {
304                         uint64_t drr_object;
305                         uint64_t drr_length;
306                         uint64_t drr_toguid;
307                         uint8_t drr_flags;
308                         uint8_t drr_compressiontype;
309                         uint8_t drr_pad[6];
310                         /* only nonzero for raw streams */
311                         uint64_t drr_compressed_size;
312                         uint8_t drr_salt[ZIO_DATA_SALT_LEN];
313                         uint8_t drr_iv[ZIO_DATA_IV_LEN];
314                         uint8_t drr_mac[ZIO_DATA_MAC_LEN];
315                         dmu_object_type_t drr_type;
316                         /* spill data follows */
317                 } drr_spill;
318                 struct drr_write_embedded {
319                         uint64_t drr_object;
320                         uint64_t drr_offset;
321                         /* logical length, should equal blocksize */
322                         uint64_t drr_length;
323                         uint64_t drr_toguid;
324                         uint8_t drr_compression;
325                         uint8_t drr_etype;
326                         uint8_t drr_pad[6];
327                         uint32_t drr_lsize; /* uncompressed size of payload */
328                         uint32_t drr_psize; /* compr. (real) size of payload */
329                         /* (possibly compressed) content follows */
330                 } drr_write_embedded;
331                 struct drr_object_range {
332                         uint64_t drr_firstobj;
333                         uint64_t drr_numslots;
334                         uint64_t drr_toguid;
335                         uint8_t drr_salt[ZIO_DATA_SALT_LEN];
336                         uint8_t drr_iv[ZIO_DATA_IV_LEN];
337                         uint8_t drr_mac[ZIO_DATA_MAC_LEN];
338                         uint8_t drr_flags;
339                         uint8_t drr_pad[3];
340                 } drr_object_range;
341                 struct drr_redact {
342                         uint64_t drr_object;
343                         uint64_t drr_offset;
344                         uint64_t drr_length;
345                         uint64_t drr_toguid;
346                 } drr_redact;
347
348                 /*
349                  * Nore: drr_checksum is overlaid with all record types
350                  * except DRR_BEGIN.  Therefore its (non-pad) members
351                  * must not overlap with members from the other structs.
352                  * We accomplish this by putting its members at the very
353                  * end of the struct.
354                  */
355                 struct drr_checksum {
356                         uint64_t drr_pad[34];
357                         /*
358                          * fletcher-4 checksum of everything preceding the
359                          * checksum.
360                          */
361                         zio_cksum_t drr_checksum;
362                 } drr_checksum;
363         } drr_u;
364 } dmu_replay_record_t;
365
366 /* diff record range types */
367 typedef enum diff_type {
368         DDR_NONE = 0x1,
369         DDR_INUSE = 0x2,
370         DDR_FREE = 0x4
371 } diff_type_t;
372
373 /*
374  * The diff reports back ranges of free or in-use objects.
375  */
376 typedef struct dmu_diff_record {
377         uint64_t ddr_type;
378         uint64_t ddr_first;
379         uint64_t ddr_last;
380 } dmu_diff_record_t;
381
382 typedef struct zinject_record {
383         uint64_t        zi_objset;
384         uint64_t        zi_object;
385         uint64_t        zi_start;
386         uint64_t        zi_end;
387         uint64_t        zi_guid;
388         uint32_t        zi_level;
389         uint32_t        zi_error;
390         uint64_t        zi_type;
391         uint32_t        zi_freq;
392         uint32_t        zi_failfast;
393         char            zi_func[MAXNAMELEN];
394         uint32_t        zi_iotype;
395         int32_t         zi_duration;
396         uint64_t        zi_timer;
397         uint64_t        zi_nlanes;
398         uint32_t        zi_cmd;
399         uint32_t        zi_dvas;
400 } zinject_record_t;
401
402 #define ZINJECT_NULL            0x1
403 #define ZINJECT_FLUSH_ARC       0x2
404 #define ZINJECT_UNLOAD_SPA      0x4
405 #define ZINJECT_CALC_RANGE      0x8
406
407 #define ZEVENT_NONE             0x0
408 #define ZEVENT_NONBLOCK         0x1
409 #define ZEVENT_SIZE             1024
410
411 #define ZEVENT_SEEK_START       0
412 #define ZEVENT_SEEK_END         UINT64_MAX
413
414 /* scaled frequency ranges */
415 #define ZI_PERCENTAGE_MIN       4294UL
416 #define ZI_PERCENTAGE_MAX       UINT32_MAX
417
418 #define ZI_NO_DVA               (-1)
419
420 typedef enum zinject_type {
421         ZINJECT_UNINITIALIZED,
422         ZINJECT_DATA_FAULT,
423         ZINJECT_DEVICE_FAULT,
424         ZINJECT_LABEL_FAULT,
425         ZINJECT_IGNORED_WRITES,
426         ZINJECT_PANIC,
427         ZINJECT_DELAY_IO,
428         ZINJECT_DECRYPT_FAULT,
429 } zinject_type_t;
430
431 typedef struct zfs_share {
432         uint64_t        z_exportdata;
433         uint64_t        z_sharedata;
434         uint64_t        z_sharetype;    /* 0 = share, 1 = unshare */
435         uint64_t        z_sharemax;  /* max length of share string */
436 } zfs_share_t;
437
438 /*
439  * ZFS file systems may behave the usual, POSIX-compliant way, where
440  * name lookups are case-sensitive.  They may also be set up so that
441  * all the name lookups are case-insensitive, or so that only some
442  * lookups, the ones that set an FIGNORECASE flag, are case-insensitive.
443  */
444 typedef enum zfs_case {
445         ZFS_CASE_SENSITIVE,
446         ZFS_CASE_INSENSITIVE,
447         ZFS_CASE_MIXED
448 } zfs_case_t;
449
450 /*
451  * Note: this struct must have the same layout in 32-bit and 64-bit, so
452  * that 32-bit processes (like /sbin/zfs) can pass it to the 64-bit
453  * kernel.  Therefore, we add padding to it so that no "hidden" padding
454  * is automatically added on 64-bit (but not on 32-bit).
455  */
456 typedef struct zfs_cmd {
457         char            zc_name[MAXPATHLEN];    /* name of pool or dataset */
458         uint64_t        zc_nvlist_src;          /* really (char *) */
459         uint64_t        zc_nvlist_src_size;
460         uint64_t        zc_nvlist_dst;          /* really (char *) */
461         uint64_t        zc_nvlist_dst_size;
462         boolean_t       zc_nvlist_dst_filled;   /* put an nvlist in dst? */
463         int             zc_pad2;
464
465         /*
466          * The following members are for legacy ioctls which haven't been
467          * converted to the new method.
468          */
469         uint64_t        zc_history;             /* really (char *) */
470         char            zc_value[MAXPATHLEN * 2];
471         char            zc_string[MAXNAMELEN];
472         uint64_t        zc_guid;
473         uint64_t        zc_nvlist_conf;         /* really (char *) */
474         uint64_t        zc_nvlist_conf_size;
475         uint64_t        zc_cookie;
476         uint64_t        zc_objset_type;
477         uint64_t        zc_perm_action;
478         uint64_t        zc_history_len;
479         uint64_t        zc_history_offset;
480         uint64_t        zc_obj;
481         uint64_t        zc_iflags;              /* internal to zfs(7fs) */
482         zfs_share_t     zc_share;
483         dmu_objset_stats_t zc_objset_stats;
484         struct drr_begin zc_begin_record;
485         zinject_record_t zc_inject_record;
486         uint32_t        zc_defer_destroy;
487         uint32_t        zc_flags;
488         uint64_t        zc_action_handle;
489         int             zc_cleanup_fd;
490         uint8_t         zc_simple;
491         uint8_t         zc_pad[3];              /* alignment */
492         uint64_t        zc_sendobj;
493         uint64_t        zc_fromobj;
494         uint64_t        zc_createtxg;
495         zfs_stat_t      zc_stat;
496 } zfs_cmd_t;
497
498 typedef struct zfs_useracct {
499         char zu_domain[256];
500         uid_t zu_rid;
501         uint32_t zu_pad;
502         uint64_t zu_space;
503 } zfs_useracct_t;
504
505 #define ZFSDEV_MAX_MINOR        (1 << 16)
506 #define ZFS_MIN_MINOR   (ZFSDEV_MAX_MINOR + 1)
507
508 #define ZPOOL_EXPORT_AFTER_SPLIT 0x1
509
510 #ifdef _KERNEL
511 struct objset;
512 struct zfsvfs;
513
514 typedef struct zfs_creat {
515         nvlist_t        *zct_zplprops;
516         nvlist_t        *zct_props;
517 } zfs_creat_t;
518
519 extern int zfs_secpolicy_snapshot_perms(const char *, cred_t *);
520 extern int zfs_secpolicy_rename_perms(const char *, const char *, cred_t *);
521 extern int zfs_secpolicy_destroy_perms(const char *, cred_t *);
522 extern void zfs_unmount_snap(const char *);
523 extern void zfs_destroy_unmount_origin(const char *);
524 extern int getzfsvfs_impl(struct objset *, struct zfsvfs **);
525 extern int getzfsvfs(const char *, struct zfsvfs **);
526
527 enum zfsdev_state_type {
528         ZST_ONEXIT,
529         ZST_ZEVENT,
530         ZST_ALL,
531 };
532
533 /*
534  * The zfsdev_state_t structure is managed as a singly-linked list
535  * from which items are never deleted.  This allows for lock-free
536  * reading of the list so long as assignments to the zs_next and
537  * reads from zs_minor are performed atomically.  Empty items are
538  * indicated by storing -1 into zs_minor.
539  */
540 typedef struct zfsdev_state {
541         struct zfsdev_state     *zs_next;       /* next zfsdev_state_t link */
542         struct file             *zs_file;       /* associated file struct */
543         minor_t                 zs_minor;       /* made up minor number */
544         void                    *zs_onexit;     /* onexit data */
545         void                    *zs_zevent;     /* zevent data */
546 } zfsdev_state_t;
547
548 extern void *zfsdev_get_state(minor_t minor, enum zfsdev_state_type which);
549 extern int zfsdev_getminor(struct file *filp, minor_t *minorp);
550 extern minor_t zfsdev_minor_alloc(void);
551
552 #endif  /* _KERNEL */
553
554 #ifdef  __cplusplus
555 }
556 #endif
557
558 #endif  /* _SYS_ZFS_IOCTL_H */