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 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_STMF_SBD_IOCTL_H
27 #define	_STMF_SBD_IOCTL_H
28 
29 #ifdef	__cplusplus
30 extern "C" {
31 #endif
32 
33 /*
34  * error codes from sbd.
35  */
36 typedef enum sbd_ret {
37 	SBD_RET_META_CREATION_FAILED = 0x01,
38 	SBD_RET_INVALID_BLKSIZE,
39 	SBD_RET_REQUIRES_SEPARATE_META,
40 	SBD_RET_FILE_ALREADY_REGISTERED,
41 	SBD_RET_GUID_ALREADY_REGISTERED,
42 	SBD_RET_DATA_PATH_NOT_ABSOLUTE,
43 	SBD_RET_META_PATH_NOT_ABSOLUTE,
44 	SBD_RET_META_FILE_LOOKUP_FAILED,
45 	SBD_RET_ZFS_META_CREATE_FAILED,
46 	SBD_ZVOL_META_NAME_MISMATCH,
47 	SBD_RET_DATA_FILE_LOOKUP_FAILED,
48 	SBD_RET_WRONG_META_FILE_TYPE,
49 	SBD_RET_WRONG_DATA_FILE_TYPE,
50 	SBD_RET_DATA_FILE_OPEN_FAILED,
51 	SBD_RET_META_FILE_OPEN_FAILED,
52 	SBD_RET_DATA_FILE_GETATTR_FAILED,
53 	SBD_RET_META_FILE_GETATTR_FAILED,
54 	SBD_RET_FILE_SIZE_ERROR,
55 	SBD_RET_FILE_ALIGN_ERROR,
56 	SBD_RET_SIZE_OUT_OF_RANGE,
57 	SBD_RET_SIZE_NOT_SUPPORTED_BY_FS,
58 	SBD_RET_NO_META,
59 	SBD_RET_VERSION_NOT_SUPPORTED,
60 	SBD_RET_LU_BUSY,
61 	SBD_RET_NOT_FOUND,
62 	SBD_RET_INSUFFICIENT_BUF_SPACE,
63 	SBD_RET_WRITE_CACHE_SET_FAILED,
64 	SBD_RET_ACCESS_STATE_FAILED,
65 
66 	SBD_RET_MAX_VAL
67 } sbd_ret_t;
68 
69 #define	SBD_IOCTL_DEF(n)	((((int)0x5B) << 16) | (n))
70 #define	SBD_IOCTL_CREATE_AND_REGISTER_LU		SBD_IOCTL_DEF(1)
71 #define	SBD_IOCTL_IMPORT_LU				SBD_IOCTL_DEF(2)
72 #define	SBD_IOCTL_DELETE_LU				SBD_IOCTL_DEF(3)
73 #define	SBD_IOCTL_MODIFY_LU				SBD_IOCTL_DEF(4)
74 #define	SBD_IOCTL_GET_LU_PROPS				SBD_IOCTL_DEF(5)
75 #define	SBD_IOCTL_GET_LU_LIST				SBD_IOCTL_DEF(6)
76 #define	SBD_IOCTL_SET_LU_STANDBY			SBD_IOCTL_DEF(7)
77 
78 typedef struct sbd_create_and_reg_lu {
79 	uint32_t	slu_struct_size;
80 	uint16_t	slu_meta_fname_valid:1,
81 			slu_lu_size_valid:1,
82 			slu_blksize_valid:1,
83 			slu_vid_valid:1,
84 			slu_pid_valid:1,
85 			slu_rev_valid:1,
86 			slu_serial_valid:1,
87 			slu_alias_valid:1,
88 			slu_mgmt_url_valid:1,
89 			slu_guid_valid:1,
90 			slu_company_id_valid:1,
91 			slu_host_id_valid:1,
92 			slu_writeback_cache_disable_valid:1,
93 			slu_writeback_cache_disable:1,
94 			slu_write_protected:1;
95 	uint16_t	slu_meta_fname_off;
96 	uint64_t	slu_lu_size;
97 	uint16_t	slu_data_fname_off;
98 	uint16_t	slu_serial_off;
99 	uint8_t		slu_serial_size;
100 	uint8_t		slu_ret_filesize_nbits;
101 	uint16_t	slu_blksize;
102 	uint32_t	slu_company_id;
103 	uint16_t	slu_alias_off;
104 	uint16_t	slu_mgmt_url_off;
105 	uint32_t	slu_host_id;
106 	char		slu_rev[4];
107 	char		slu_vid[8];
108 	char		slu_pid[16];
109 	uint8_t		slu_guid[16];
110 	char		slu_buf[8];	/* likely more than 8 */
111 } sbd_create_and_reg_lu_t;
112 
113 typedef struct sbd_set_lu_standby {
114 	uint8_t		stlu_guid[16];
115 } sbd_set_lu_standby_t;
116 
117 
118 typedef struct sbd_import_lu {
119 	uint32_t	ilu_struct_size;
120 	uint32_t	ilu_rsvd;
121 	uint8_t		ilu_ret_guid[16];
122 	char		ilu_meta_fname[8]; /* Can be more than 8 */
123 } sbd_import_lu_t;
124 
125 typedef struct sbd_modify_lu {
126 	uint32_t	mlu_struct_size;
127 	uint32_t	mlu_lu_size_valid:1,
128 			mlu_serial_valid:1,
129 			mlu_alias_valid:1,
130 			mlu_mgmt_url_valid:1,
131 			mlu_writeback_cache_disable_valid:1,
132 			mlu_writeback_cache_disable:1,
133 			mlu_write_protected_valid:1,
134 			mlu_write_protected:1,
135 			mlu_by_guid:1,
136 			mlu_by_fname:1,
137 			mlu_standby_valid:1,
138 			mlu_standby:1;
139 	uint64_t	mlu_lu_size;
140 	uint16_t	mlu_alias_off;
141 	uint16_t	mlu_mgmt_url_off;
142 	uint16_t	mlu_serial_off;
143 	uint16_t	mlu_serial_size;
144 	uint16_t	mlu_fname_off;
145 	uint16_t	mlu_rsvd1;
146 	uint32_t	mlu_rsvd2;
147 	uint8_t		mlu_input_guid[16];
148 	char		mlu_buf[8]; /* can be more than 8 */
149 } sbd_modify_lu_t;
150 
151 typedef struct sbd_delete_lu {
152 	uint32_t	dlu_struct_size;
153 	uint16_t	dlu_by_guid:1,
154 			dlu_by_meta_name:1;
155 	uint16_t	dlu_rsvd;
156 	uint8_t		dlu_guid[16];
157 	uint8_t		dlu_meta_name[8];
158 } sbd_delete_lu_t;
159 
160 /*
161  * sbd access states
162  */
163 #define	SBD_LU_ACTIVE			1
164 #define	SBD_LU_TRANSITION_TO_ACTIVE	2
165 #define	SBD_LU_STANDBY			3
166 #define	SBD_LU_TRANSITION_TO_STANDBY	4
167 
168 typedef struct sbd_lu_props {
169 	uint32_t	slp_input_guid:1,	/* GUID or meta filename */
170 			slp_separate_meta:1,
171 			slp_meta_fname_valid:1,
172 			slp_data_fname_valid:1,
173 			slp_zfs_meta:1,
174 			slp_alias_valid:1,
175 			slp_mgmt_url_valid:1,
176 			slp_lu_vid:1,
177 			slp_lu_pid:1,
178 			slp_lu_rev:1,
179 			slp_serial_valid:1,
180 			slp_writeback_cache_disable_cur:1,
181 			slp_writeback_cache_disable_saved:1,
182 			slp_write_protected:1;
183 	uint16_t	slp_meta_fname_off;
184 	uint16_t	slp_data_fname_off;
185 	uint64_t	slp_lu_size;
186 	uint16_t	slp_serial_off;
187 	uint16_t	slp_blksize;
188 	uint16_t	slp_alias_off;
189 	uint16_t	slp_mgmt_url_off;
190 	uint32_t	slp_buf_size_needed;	/* Upon return */
191 	uint16_t	slp_serial_size;
192 	uint16_t	slp_access_state;
193 	char		slp_rev[4];
194 	char		slp_vid[8];
195 	char		slp_pid[16];
196 	uint8_t		slp_guid[16];
197 	uint8_t		slp_buf[8];	/* likely more than 8 */
198 } sbd_lu_props_t;
199 
200 #ifdef	__cplusplus
201 }
202 #endif
203 
204 #endif /* _STMF_SBD_IOCTL_H */
205