xref: /illumos-gate/usr/src/uts/common/fs/zfs/sys/zfs_ioctl.h (revision 64cfc8ed0c5da83f827c424588bfe709e3fb5a7a)
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 2007 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_ZFS_IOCTL_H
27 #define	_SYS_ZFS_IOCTL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/cred.h>
32 #include <sys/dmu.h>
33 #include <sys/zio.h>
34 #include <sys/dsl_deleg.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 /*
41  * Property values for snapdir
42  */
43 #define	ZFS_SNAPDIR_HIDDEN		0
44 #define	ZFS_SNAPDIR_VISIBLE		1
45 
46 #define	DMU_BACKUP_VERSION (1ULL)
47 #define	DMU_BACKUP_MAGIC 0x2F5bacbacULL
48 
49 /*
50  * zfs ioctl command structure
51  */
52 typedef struct dmu_replay_record {
53 	enum {
54 		DRR_BEGIN, DRR_OBJECT, DRR_FREEOBJECTS,
55 		DRR_WRITE, DRR_FREE, DRR_END,
56 	} drr_type;
57 	uint32_t drr_pad;
58 	union {
59 		struct drr_begin {
60 			uint64_t drr_magic;
61 			uint64_t drr_version;
62 			uint64_t drr_creation_time;
63 			dmu_objset_type_t drr_type;
64 			uint32_t drr_pad;
65 			uint64_t drr_toguid;
66 			uint64_t drr_fromguid;
67 			char drr_toname[MAXNAMELEN];
68 		} drr_begin;
69 		struct drr_end {
70 			zio_cksum_t drr_checksum;
71 		} drr_end;
72 		struct drr_object {
73 			uint64_t drr_object;
74 			dmu_object_type_t drr_type;
75 			dmu_object_type_t drr_bonustype;
76 			uint32_t drr_blksz;
77 			uint32_t drr_bonuslen;
78 			uint8_t drr_checksum;
79 			uint8_t drr_compress;
80 			uint8_t drr_pad[6];
81 			/* bonus content follows */
82 		} drr_object;
83 		struct drr_freeobjects {
84 			uint64_t drr_firstobj;
85 			uint64_t drr_numobjs;
86 		} drr_freeobjects;
87 		struct drr_write {
88 			uint64_t drr_object;
89 			dmu_object_type_t drr_type;
90 			uint32_t drr_pad;
91 			uint64_t drr_offset;
92 			uint64_t drr_length;
93 			/* content follows */
94 		} drr_write;
95 		struct drr_free {
96 			uint64_t drr_object;
97 			uint64_t drr_offset;
98 			uint64_t drr_length;
99 		} drr_free;
100 	} drr_u;
101 } dmu_replay_record_t;
102 
103 typedef struct zinject_record {
104 	uint64_t	zi_objset;
105 	uint64_t	zi_object;
106 	uint64_t	zi_start;
107 	uint64_t	zi_end;
108 	uint64_t	zi_guid;
109 	uint32_t	zi_level;
110 	uint32_t	zi_error;
111 	uint64_t	zi_type;
112 	uint32_t	zi_freq;
113 	uint32_t	zi_pad;	/* pad out to 64 bit alignment */
114 } zinject_record_t;
115 
116 #define	ZINJECT_NULL		0x1
117 #define	ZINJECT_FLUSH_ARC	0x2
118 #define	ZINJECT_UNLOAD_SPA	0x4
119 
120 typedef struct zfs_share {
121 	uint64_t	z_exportdata;
122 	uint64_t	z_sharedata;
123 	uint64_t	z_sharetype;	/* 0 = share, 1 = unshare */
124 	uint64_t	z_sharemax;  /* max length of share string */
125 } zfs_share_t;
126 
127 typedef struct zfs_cmd {
128 	char		zc_name[MAXPATHLEN];
129 	char		zc_value[MAXPATHLEN * 2];
130 	uint64_t	zc_guid;
131 	uint64_t	zc_nvlist_conf;		/* really (char *) */
132 	uint64_t	zc_nvlist_conf_size;
133 	uint64_t	zc_nvlist_src;		/* really (char *) */
134 	uint64_t	zc_nvlist_src_size;
135 	uint64_t	zc_nvlist_dst;		/* really (char *) */
136 	uint64_t	zc_nvlist_dst_size;
137 	uint64_t	zc_cookie;
138 	uint64_t	zc_objset_type;
139 	uint64_t	zc_perm_action;
140 	uint64_t 	zc_history;		/* really (char *) */
141 	uint64_t 	zc_history_len;
142 	uint64_t	zc_history_offset;
143 	uint64_t	zc_obj;
144 	zfs_share_t	zc_share;
145 	dmu_objset_stats_t zc_objset_stats;
146 	struct drr_begin zc_begin_record;
147 	zinject_record_t zc_inject_record;
148 } zfs_cmd_t;
149 
150 #define	ZVOL_MAX_MINOR	(1 << 16)
151 #define	ZFS_MIN_MINOR	(ZVOL_MAX_MINOR + 1)
152 
153 #ifdef _KERNEL
154 
155 extern dev_info_t *zfs_dip;
156 
157 extern int zfs_secpolicy_snapshot_perms(const char *name, cred_t *cr);
158 extern int zfs_secpolicy_rename_perms(const char *from,
159     const char *to, cred_t *cr);
160 extern int zfs_secpolicy_destroy_perms(const char *name, cred_t *cr);
161 extern int zfs_busy(void);
162 extern int zfs_unmount_snap(char *, void *);
163 
164 #endif	/* _KERNEL */
165 
166 #ifdef	__cplusplus
167 }
168 #endif
169 
170 #endif	/* _SYS_ZFS_IOCTL_H */
171