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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
23 *
24 * Copyright 2011 Nexenta Systems, Inc. All rights reserved.
25 */
26
27 #ifndef _STMF_SBD_H
28 #define _STMF_SBD_H
29
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33
34 typedef stmf_status_t sbd_status_t;
35 extern char sbd_vendor_id[];
36 extern char sbd_product_id[];
37 extern char sbd_revision[];
38 extern char *sbd_mgmt_url;
39 extern uint16_t sbd_mgmt_url_alloc_size;
40 extern krwlock_t sbd_global_prop_lock;
41
42 /*
43 * Error codes
44 */
45 #define SBD_SUCCESS STMF_SUCCESS
46 #define SBD_FAILURE STMF_LU_FAILURE
47
48 #define SBD_ALREADY (SBD_FAILURE | STMF_FSC(1))
49 #define SBD_NOT_SUPPORTED (SBD_FAILURE | STMF_FSC(2))
50 #define SBD_META_CORRUPTED (SBD_FAILURE | STMF_FSC(3))
51 #define SBD_INVALID_ARG (SBD_FAILURE | STMF_FSC(4))
52 #define SBD_NOT_FOUND (SBD_FAILURE | STMF_FSC(5))
53 #define SBD_ALLOC_FAILURE (SBD_FAILURE | STMF_FSC(6))
54 #define SBD_FILEIO_FAILURE (SBD_FAILURE | STMF_FSC(7))
55 #define SBD_IO_PAST_EOF (SBD_FAILURE | STMF_FSC(8))
56 #define SBD_BUSY (SBD_FAILURE | STMF_FSC(9))
57
58 #define SHARED_META_DATA_SIZE 65536
59 #define SBD_META_OFFSET 4096
60 #define SBD_MIN_LU_SIZE (1024 * 1024)
61
62 /*
63 * sms endianess
64 */
65 #define SMS_BIG_ENDIAN 0x00
66 #define SMS_LITTLE_ENDIAN 0xFF
67
68 #ifdef _BIG_ENDIAN
69 #define SMS_DATA_ORDER SMS_BIG_ENDIAN
70 #else
71 #define SMS_DATA_ORDER SMS_LITTLE_ENDIAN
72 #endif
73
74 #define SBD_MAGIC 0x53554e5342444c55
75
76 #define SBD_VER_MAJOR 1
77 #define SBD_VER_MINOR 1
78 #define SBD_VER_SUBMINOR 0
79
80 #if 0
81 typedef struct sbd_meta_start {
82 uint64_t sm_magic;
83 uint64_t sm_meta_size;
84 uint64_t sm_meta_size_used;
85 uint64_t sm_rsvd1; /* Defaults to zero */
86 uint64_t sm_rsvd2;
87 uint16_t sm_ver_major;
88 uint16_t sm_ver_minor;
89 uint16_t sm_ver_subminor;
90 uint8_t sm_flags;
91 uint8_t sm_chksum;
92 } sbd_meta_start_t;
93 #endif
94
95 typedef struct sm_section_hdr {
96 uint64_t sms_offset; /* Offset of this section */
97 uint32_t sms_size; /* Includes the header and padding */
98 uint16_t sms_id; /* Section identifier */
99 uint8_t sms_data_order; /* 0x00 or 0xff */
100 uint8_t sms_chksum;
101 } sm_section_hdr_t;
102
103 /*
104 * sbd meta section identifiers
105 */
106 #define SMS_ID_LU_INFO_1_0 0
107 #define SMS_ID_LU_INFO_1_1 1
108 #define SMS_ID_PGR_INFO 2
109 #define SMS_ID_UNUSED 0x1000
110
111 typedef struct sbd_lu_info_1_0 {
112 sm_section_hdr_t sli_sms_header;
113 uint64_t sli_total_store_size;
114 uint64_t sli_total_meta_size;
115 uint64_t sli_lu_data_offset;
116 uint64_t sli_lu_data_size;
117 uint32_t sli_flags;
118 uint16_t sli_blocksize;
119 uint8_t sli_data_order;
120 uint8_t rsvd1;
121 uint8_t sli_lu_devid[20];
122 uint32_t rsvd2;
123 } sbd_lu_info_1_0_t;
124
125 typedef struct sbd_lu_info_1_1 {
126 sm_section_hdr_t sli_sms_header;
127 uint32_t sli_flags;
128 char sli_rev[4];
129 char sli_vid[8];
130 char sli_pid[16];
131 uint64_t sli_lu_size; /* Read capacity size */
132
133 /*
134 * Essetially zfs volume name for zvols to verify that the
135 * metadata is coming in from the correct zvol and not from a
136 * clone. Has no meaning in any other case.
137 */
138 uint64_t sli_meta_fname_offset;
139
140 /*
141 * Data filename or the media filename when the metadata is in
142 * a separate file. Its not needed if the metadata is shared
143 * with data as the user supplied name is the data filename.
144 */
145 uint64_t sli_data_fname_offset;
146 uint64_t sli_serial_offset;
147 uint64_t sli_alias_offset;
148 uint8_t sli_data_blocksize_shift;
149 uint8_t sli_data_order;
150 uint8_t sli_serial_size;
151 uint8_t sli_rsvd1;
152 uint8_t sli_device_id[20];
153 uint64_t sli_mgmt_url_offset;
154 uint8_t sli_rsvd2[248];
155
156 /*
157 * In case there is no separate meta, sli_meta_fname_offset wont
158 * be valid. The same is true for zfs based metadata. The data_fname
159 * is the zvol.
160 */
161 uint8_t sli_buf[8];
162 } sbd_lu_info_1_1_t;
163
164 /*
165 * sli flags
166 */
167 #define SLI_SEPARATE_META 0x0001
168 #define SLI_WRITE_PROTECTED 0x0002
169 #define SLI_VID_VALID 0x0004
170 #define SLI_PID_VALID 0x0008
171 #define SLI_REV_VALID 0x0010
172 #define SLI_META_FNAME_VALID 0x0020
173 #define SLI_DATA_FNAME_VALID 0x0040
174 #define SLI_SERIAL_VALID 0x0080
175 #define SLI_ALIAS_VALID 0x0100
176 #define SLI_WRITEBACK_CACHE_DISABLE 0x0200
177 #define SLI_ZFS_META 0x0400
178 #define SLI_MGMT_URL_VALID 0x0800
179
180 struct sbd_it_data;
181
182 typedef struct sbd_lu {
183 struct sbd_lu *sl_next;
184 stmf_lu_t *sl_lu;
185 uint32_t sl_alloc_size;
186
187 /* Current LU state */
188 kmutex_t sl_lock;
189 uint32_t sl_flags;
190 uint8_t sl_trans_op;
191 uint8_t sl_state:7,
192 sl_state_not_acked:1;
193
194 char *sl_name; /* refers to meta or data */
195
196 /* Metadata */
197 kmutex_t sl_metadata_lock;
198 krwlock_t sl_access_state_lock;
199 char *sl_alias;
200 char *sl_meta_filename; /* If applicable */
201 char *sl_mgmt_url;
202 vnode_t *sl_meta_vp;
203 vtype_t sl_meta_vtype;
204 uint8_t sl_device_id[20]; /* 4(hdr) + 16(GUID) */
205 uint8_t sl_meta_blocksize_shift; /* Left shift multiplier */
206 uint8_t sl_data_blocksize_shift;
207 uint8_t sl_data_fs_nbits;
208 uint8_t sl_serial_no_size;
209 uint64_t sl_total_meta_size;
210 uint64_t sl_meta_size_used;
211 uint8_t *sl_serial_no; /* optional */
212 char sl_vendor_id[8];
213 char sl_product_id[16];
214 char sl_revision[4];
215 uint32_t sl_data_fname_alloc_size; /* for an explicit alloc */
216 uint16_t sl_alias_alloc_size;
217 uint16_t sl_mgmt_url_alloc_size;
218 uint8_t sl_serial_no_alloc_size;
219 uint8_t sl_access_state;
220 uint64_t sl_meta_offset;
221
222 /* zfs metadata */
223 krwlock_t sl_zfs_meta_lock;
224 char *sl_zfs_meta;
225 minor_t sl_zvol_minor; /* for direct zvol calls */
226 /* opaque handles for zvol direct calls */
227 void *sl_zvol_minor_hdl;
228 void *sl_zvol_objset_hdl;
229 void *sl_zvol_zil_hdl;
230 void *sl_zvol_rl_hdl;
231 void *sl_zvol_bonus_hdl;
232
233 /* Backing store */
234 char *sl_data_filename;
235 vnode_t *sl_data_vp;
236 vtype_t sl_data_vtype;
237 uint64_t sl_total_data_size;
238 uint64_t sl_data_readable_size; /* read() fails after this */
239 uint64_t sl_data_offset; /* After the metadata,if any */
240 uint64_t sl_lu_size; /* READ CAPACITY size */
241 uint64_t sl_blksize; /* used for zvols */
242 uint64_t sl_max_xfer_len; /* used for zvols */
243
244 struct sbd_it_data *sl_it_list;
245 struct sbd_pgr *sl_pgr;
246 uint64_t sl_rs_owner_session_id;
247 } sbd_lu_t;
248
249 /*
250 * sl_flags
251 */
252 #define SL_LINKED 0x00000001
253 #define SL_META_OPENED 0x00000002
254 #define SL_REGISTERED 0x00000004
255 #define SL_META_NEEDS_FLUSH 0x00000008
256 #define SL_DATA_NEEDS_FLUSH 0x00000010
257 #define SL_VID_VALID 0x00000020
258 #define SL_PID_VALID 0x00000040
259 #define SL_REV_VALID 0x00000080
260 #define SL_WRITE_PROTECTED 0x00000100
261 #define SL_MEDIA_LOADED 0x00000200
262 #define SL_LU_HAS_SCSI2_RESERVATION 0x00000400
263 #define SL_WRITEBACK_CACHE_DISABLE 0x00000800
264 #define SL_SAVED_WRITE_CACHE_DISABLE 0x00001000
265 #define SL_MEDIUM_REMOVAL_PREVENTED 0x00002000
266 #define SL_NO_DATA_DKIOFLUSH 0x00004000
267 #define SL_SHARED_META 0x00008000
268 #define SL_ZFS_META 0x00010000
269 #define SL_WRITEBACK_CACHE_SET_UNSUPPORTED 0x00020000
270 #define SL_FLUSH_ON_DISABLED_WRITECACHE 0x00040000
271 #define SL_CALL_ZVOL 0x00080000
272 #define SL_UNMAP_ENABLED 0x00100000
273
274 /*
275 * sl_trans_op. LU is undergoing some transition and this field
276 * tells what kind of transition that is.
277 */
278 #define SL_OP_NONE 0
279 #define SL_OP_CREATE_REGISTER_LU 1
280 #define SL_OP_IMPORT_LU 2
281 #define SL_OP_DELETE_LU 3
282 #define SL_OP_MODIFY_LU 4
283 #define SL_OP_LU_PROPS 5
284
285 sbd_status_t sbd_data_read(sbd_lu_t *sl, scsi_task_t *task,
286 uint64_t offset, uint64_t size, uint8_t *buf);
287 sbd_status_t sbd_data_write(sbd_lu_t *sl, scsi_task_t *task,
288 uint64_t offset, uint64_t size, uint8_t *buf);
289 stmf_status_t sbd_task_alloc(struct scsi_task *task);
290 void sbd_new_task(struct scsi_task *task, struct stmf_data_buf *initial_dbuf);
291 void sbd_dbuf_xfer_done(struct scsi_task *task, struct stmf_data_buf *dbuf);
292 void sbd_send_status_done(struct scsi_task *task);
293 void sbd_task_free(struct scsi_task *task);
294 stmf_status_t sbd_abort(struct stmf_lu *lu, int abort_cmd, void *arg,
295 uint32_t flags);
296 void sbd_ctl(struct stmf_lu *lu, int cmd, void *arg);
297 stmf_status_t sbd_info(uint32_t cmd, stmf_lu_t *lu, void *arg, uint8_t *buf,
298 uint32_t *bufsizep);
299 sbd_status_t sbd_write_lu_info(sbd_lu_t *sl);
300 sbd_status_t sbd_flush_data_cache(sbd_lu_t *sl, int fsync_done);
301 sbd_status_t sbd_wcd_set(int wcd, sbd_lu_t *sl);
302 void sbd_wcd_get(int *wcd, sbd_lu_t *sl);
303 int sbd_unmap(sbd_lu_t *, uint64_t, uint64_t);
304
305 #ifdef __cplusplus
306 }
307 #endif
308
309 #endif /* _STMF_SBD_H */