1 /*
2 * osd_initiator.h - OSD initiator API definition
3 *
4 * Copyright (C) 2008 Panasas Inc. All rights reserved.
5 *
6 * Authors:
7 * Boaz Harrosh <ooo@electrozaur.com>
8 * Benny Halevy <bhalevy@panasas.com>
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2
12 *
13 */
14 #ifndef __OSD_INITIATOR_H__
15 #define __OSD_INITIATOR_H__
16
17 #include <scsi/osd_protocol.h>
18 #include <scsi/osd_types.h>
19
20 #include <linux/blkdev.h>
21 #include <scsi/scsi_device.h>
22
23 /* Note: "NI" in comments below means "Not Implemented yet" */
24
25 /* Configure of code:
26 * #undef if you *don't* want OSD v1 support in runtime.
27 * If #defined the initiator will dynamically configure to encode OSD v1
28 * CDB's if the target is detected to be OSD v1 only.
29 * OSD v2 only commands, options, and attributes will be ignored if target
30 * is v1 only.
31 * If #defined will result in bigger/slower code (OK Slower maybe not)
32 * Q: Should this be CONFIG_SCSI_OSD_VER1_SUPPORT and set from Kconfig?
33 */
34 #define OSD_VER1_SUPPORT y
35
36 enum osd_std_version {
37 OSD_VER_NONE = 0,
38 OSD_VER1 = 1,
39 OSD_VER2 = 2,
40 };
41
42 /*
43 * Object-based Storage Device.
44 * This object represents an OSD device.
45 * It is not a full linux device in any way. It is only
46 * a place to hang resources associated with a Linux
47 * request Q and some default properties.
48 */
49 struct osd_dev {
50 struct scsi_device *scsi_device;
51 unsigned def_timeout;
52
53 #ifdef OSD_VER1_SUPPORT
54 enum osd_std_version version;
55 #endif
56 };
57
58 /* Unique Identification of an OSD device */
59 struct osd_dev_info {
60 unsigned systemid_len;
61 u8 systemid[OSD_SYSTEMID_LEN];
62 unsigned osdname_len;
63 u8 *osdname;
64 };
65
66 /* Retrieve/return osd_dev(s) for use by Kernel clients
67 * Use IS_ERR/ERR_PTR on returned "osd_dev *".
68 */
69 struct osd_dev *osduld_path_lookup(const char *dev_name);
70 struct osd_dev *osduld_info_lookup(const struct osd_dev_info *odi);
71 void osduld_put_device(struct osd_dev *od);
72
73 const struct osd_dev_info *osduld_device_info(struct osd_dev *od);
74 bool osduld_device_same(struct osd_dev *od, const struct osd_dev_info *odi);
75
76 /* Add/remove test ioctls from external modules */
77 typedef int (do_test_fn)(struct osd_dev *od, unsigned cmd, unsigned long arg);
78 int osduld_register_test(unsigned ioctl, do_test_fn *do_test);
79 void osduld_unregister_test(unsigned ioctl);
80
81 /* These are called by uld at probe time */
82 void osd_dev_init(struct osd_dev *od, struct scsi_device *scsi_device);
83 void osd_dev_fini(struct osd_dev *od);
84
85 /**
86 * osd_auto_detect_ver - Detect the OSD version, return Unique Identification
87 *
88 * @od: OSD target lun handle
89 * @caps: Capabilities authorizing OSD root read attributes access
90 * @odi: Retrieved information uniquely identifying the osd target lun
91 * Note: odi->osdname must be kfreed by caller.
92 *
93 * Auto detects the OSD version of the OSD target and sets the @od
94 * accordingly. Meanwhile also returns the "system id" and "osd name" root
95 * attributes which uniquely identify the OSD target. This member is usually
96 * called by the ULD. ULD users should call osduld_device_info().
97 * This rutine allocates osd requests and memory at GFP_KERNEL level and might
98 * sleep.
99 */
100 int osd_auto_detect_ver(struct osd_dev *od,
101 void *caps, struct osd_dev_info *odi);
102
osd_request_queue(struct osd_dev * od)103 static inline struct request_queue *osd_request_queue(struct osd_dev *od)
104 {
105 return od->scsi_device->request_queue;
106 }
107
108 /* we might want to use function vector in the future */
osd_dev_set_ver(struct osd_dev * od,enum osd_std_version v)109 static inline void osd_dev_set_ver(struct osd_dev *od, enum osd_std_version v)
110 {
111 #ifdef OSD_VER1_SUPPORT
112 od->version = v;
113 #endif
114 }
115
osd_dev_is_ver1(struct osd_dev * od)116 static inline bool osd_dev_is_ver1(struct osd_dev *od)
117 {
118 #ifdef OSD_VER1_SUPPORT
119 return od->version == OSD_VER1;
120 #else
121 return false;
122 #endif
123 }
124
125 struct osd_request;
126 typedef void (osd_req_done_fn)(struct osd_request *or, void *private);
127
128 struct osd_request {
129 struct osd_cdb cdb;
130 struct osd_data_out_integrity_info out_data_integ;
131 struct osd_data_in_integrity_info in_data_integ;
132
133 struct osd_dev *osd_dev;
134 struct request *request;
135
136 struct _osd_req_data_segment {
137 void *buff;
138 unsigned alloc_size; /* 0 here means: don't call kfree */
139 unsigned total_bytes;
140 } cdb_cont, set_attr, enc_get_attr, get_attr;
141
142 struct _osd_io_info {
143 struct bio *bio;
144 u64 total_bytes;
145 u64 residual;
146 struct request *req;
147 struct _osd_req_data_segment *last_seg;
148 u8 *pad_buff;
149 } out, in;
150
151 unsigned timeout;
152 unsigned retries;
153 unsigned sense_len;
154 u8 sense[OSD_MAX_SENSE_LEN];
155 enum osd_attributes_mode attributes_mode;
156
157 osd_req_done_fn *async_done;
158 void *async_private;
159 blk_status_t async_error;
160 int req_errors;
161 };
162
osd_req_is_ver1(struct osd_request * or)163 static inline bool osd_req_is_ver1(struct osd_request *or)
164 {
165 return osd_dev_is_ver1(or->osd_dev);
166 }
167
168 /*
169 * How to use the osd library:
170 *
171 * osd_start_request
172 * Allocates a request.
173 *
174 * osd_req_*
175 * Call one of, to encode the desired operation.
176 *
177 * osd_add_{get,set}_attr
178 * Optionally add attributes to the CDB, list or page mode.
179 *
180 * osd_finalize_request
181 * Computes final data out/in offsets and signs the request,
182 * making it ready for execution.
183 *
184 * osd_execute_request
185 * May be called to execute it through the block layer. Other wise submit
186 * the associated block request in some other way.
187 *
188 * After execution:
189 * osd_req_decode_sense
190 * Decodes sense information to verify execution results.
191 *
192 * osd_req_decode_get_attr
193 * Retrieve osd_add_get_attr_list() values if used.
194 *
195 * osd_end_request
196 * Must be called to deallocate the request.
197 */
198
199 /**
200 * osd_start_request - Allocate and initialize an osd_request
201 *
202 * @osd_dev: OSD device that holds the scsi-device and default values
203 * that the request is associated with.
204 *
205 * Allocate osd_request and initialize all members to the
206 * default/initial state.
207 */
208 struct osd_request *osd_start_request(struct osd_dev *od);
209
210 enum osd_req_options {
211 OSD_REQ_FUA = 0x08, /* Force Unit Access */
212 OSD_REQ_DPO = 0x10, /* Disable Page Out */
213
214 OSD_REQ_BYPASS_TIMESTAMPS = 0x80,
215 };
216
217 /**
218 * osd_finalize_request - Sign request and prepare request for execution
219 *
220 * @or: osd_request to prepare
221 * @options: combination of osd_req_options bit flags or 0.
222 * @cap: A Pointer to an OSD_CAP_LEN bytes buffer that is received from
223 * The security manager as capabilities for this cdb.
224 * @cap_key: The cryptographic key used to sign the cdb/data. Can be null
225 * if NOSEC is used.
226 *
227 * The actual request and bios are only allocated here, so are the get_attr
228 * buffers that will receive the returned attributes. Copy's @cap to cdb.
229 * Sign the cdb/data with @cap_key.
230 */
231 int osd_finalize_request(struct osd_request *or,
232 u8 options, const void *cap, const u8 *cap_key);
233
234 /**
235 * osd_execute_request - Execute the request synchronously through block-layer
236 *
237 * @or: osd_request to Executed
238 *
239 * Calls blk_execute_rq to q the command and waits for completion.
240 */
241 int osd_execute_request(struct osd_request *or);
242
243 /**
244 * osd_execute_request_async - Execute the request without waitting.
245 *
246 * @or: - osd_request to Executed
247 * @done: (Optional) - Called at end of execution
248 * @private: - Will be passed to @done function
249 *
250 * Calls blk_execute_rq_nowait to queue the command. When execution is done
251 * optionally calls @done with @private as parameter. @or->async_error will
252 * have the return code
253 */
254 int osd_execute_request_async(struct osd_request *or,
255 osd_req_done_fn *done, void *private);
256
257 /**
258 * osd_req_decode_sense_full - Decode sense information after execution.
259 *
260 * @or: - osd_request to examine
261 * @osi - Receives a more detailed error report information (optional).
262 * @silent - Do not print to dmsg (Even if enabled)
263 * @bad_obj_list - Some commands act on multiple objects. Failed objects will
264 * be received here (optional)
265 * @max_obj - Size of @bad_obj_list.
266 * @bad_attr_list - List of failing attributes (optional)
267 * @max_attr - Size of @bad_attr_list.
268 *
269 * After execution, osd_request results are analyzed using this function. The
270 * return code is the final disposition on the error. So it is possible that a
271 * CHECK_CONDITION was returned from target but this will return NO_ERROR, for
272 * example on recovered errors. All parameters are optional if caller does
273 * not need any returned information.
274 * Note: This function will also dump the error to dmsg according to settings
275 * of the SCSI_OSD_DPRINT_SENSE Kconfig value. Set @silent if you know the
276 * command would routinely fail, to not spam the dmsg file.
277 */
278
279 /**
280 * osd_err_priority - osd categorized return codes in ascending severity.
281 *
282 * The categories are borrowed from the pnfs_osd_errno enum.
283 * See comments for translated Linux codes returned by osd_req_decode_sense.
284 */
285 enum osd_err_priority {
286 OSD_ERR_PRI_NO_ERROR = 0,
287 /* Recoverable, caller should clear_highpage() all pages */
288 OSD_ERR_PRI_CLEAR_PAGES = 1, /* -EFAULT */
289 OSD_ERR_PRI_RESOURCE = 2, /* -ENOMEM */
290 OSD_ERR_PRI_BAD_CRED = 3, /* -EINVAL */
291 OSD_ERR_PRI_NO_ACCESS = 4, /* -EACCES */
292 OSD_ERR_PRI_UNREACHABLE = 5, /* any other */
293 OSD_ERR_PRI_NOT_FOUND = 6, /* -ENOENT */
294 OSD_ERR_PRI_NO_SPACE = 7, /* -ENOSPC */
295 OSD_ERR_PRI_EIO = 8, /* -EIO */
296 };
297
298 struct osd_sense_info {
299 enum osd_err_priority osd_err_pri;
300
301 int key; /* one of enum scsi_sense_keys */
302 int additional_code ; /* enum osd_additional_sense_codes */
303 union { /* Sense specific information */
304 u16 sense_info;
305 u16 cdb_field_offset; /* scsi_invalid_field_in_cdb */
306 };
307 union { /* Command specific information */
308 u64 command_info;
309 };
310
311 u32 not_initiated_command_functions; /* osd_command_functions_bits */
312 u32 completed_command_functions; /* osd_command_functions_bits */
313 struct osd_obj_id obj;
314 struct osd_attr attr;
315 };
316
317 int osd_req_decode_sense_full(struct osd_request *or,
318 struct osd_sense_info *osi, bool silent,
319 struct osd_obj_id *bad_obj_list, int max_obj,
320 struct osd_attr *bad_attr_list, int max_attr);
321
osd_req_decode_sense(struct osd_request * or,struct osd_sense_info * osi)322 static inline int osd_req_decode_sense(struct osd_request *or,
323 struct osd_sense_info *osi)
324 {
325 return osd_req_decode_sense_full(or, osi, false, NULL, 0, NULL, 0);
326 }
327
328 /**
329 * osd_end_request - return osd_request to free store
330 *
331 * @or: osd_request to free
332 *
333 * Deallocate all osd_request resources (struct req's, BIOs, buffers, etc.)
334 */
335 void osd_end_request(struct osd_request *or);
336
337 /*
338 * CDB Encoding
339 *
340 * Note: call only one of the following methods.
341 */
342
343 /*
344 * Device commands
345 */
346 void osd_req_set_master_seed_xchg(struct osd_request *or, ...);/* NI */
347 void osd_req_set_master_key(struct osd_request *or, ...);/* NI */
348
349 void osd_req_format(struct osd_request *or, u64 tot_capacity);
350
351 /* list all partitions
352 * @list header must be initialized to zero on first run.
353 *
354 * Call osd_is_obj_list_done() to find if we got the complete list.
355 */
356 int osd_req_list_dev_partitions(struct osd_request *or,
357 osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem);
358
359 void osd_req_flush_obsd(struct osd_request *or,
360 enum osd_options_flush_scope_values);
361
362 void osd_req_perform_scsi_command(struct osd_request *or,
363 const u8 *cdb, ...);/* NI */
364 void osd_req_task_management(struct osd_request *or, ...);/* NI */
365
366 /*
367 * Partition commands
368 */
369 void osd_req_create_partition(struct osd_request *or, osd_id partition);
370 void osd_req_remove_partition(struct osd_request *or, osd_id partition);
371
372 void osd_req_set_partition_key(struct osd_request *or,
373 osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
374 u8 seed[OSD_CRYPTO_SEED_SIZE]);/* NI */
375
376 /* list all collections in the partition
377 * @list header must be init to zero on first run.
378 *
379 * Call osd_is_obj_list_done() to find if we got the complete list.
380 */
381 int osd_req_list_partition_collections(struct osd_request *or,
382 osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
383 unsigned nelem);
384
385 /* list all objects in the partition
386 * @list header must be init to zero on first run.
387 *
388 * Call osd_is_obj_list_done() to find if we got the complete list.
389 */
390 int osd_req_list_partition_objects(struct osd_request *or,
391 osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
392 unsigned nelem);
393
394 void osd_req_flush_partition(struct osd_request *or,
395 osd_id partition, enum osd_options_flush_scope_values);
396
397 /*
398 * Collection commands
399 */
400 void osd_req_create_collection(struct osd_request *or,
401 const struct osd_obj_id *);/* NI */
402 void osd_req_remove_collection(struct osd_request *or,
403 const struct osd_obj_id *);/* NI */
404
405 /* list all objects in the collection */
406 int osd_req_list_collection_objects(struct osd_request *or,
407 const struct osd_obj_id *, osd_id initial_id,
408 struct osd_obj_id_list *list, unsigned nelem);
409
410 /* V2 only filtered list of objects in the collection */
411 void osd_req_query(struct osd_request *or, ...);/* NI */
412
413 void osd_req_flush_collection(struct osd_request *or,
414 const struct osd_obj_id *, enum osd_options_flush_scope_values);
415
416 void osd_req_get_member_attrs(struct osd_request *or, ...);/* V2-only NI */
417 void osd_req_set_member_attrs(struct osd_request *or, ...);/* V2-only NI */
418
419 /*
420 * Object commands
421 */
422 void osd_req_create_object(struct osd_request *or, struct osd_obj_id *);
423 void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *);
424
425 void osd_req_write(struct osd_request *or,
426 const struct osd_obj_id *obj, u64 offset, struct bio *bio, u64 len);
427 int osd_req_write_kern(struct osd_request *or,
428 const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
429 void osd_req_append(struct osd_request *or,
430 const struct osd_obj_id *, struct bio *data_out);/* NI */
431 void osd_req_create_write(struct osd_request *or,
432 const struct osd_obj_id *, struct bio *data_out, u64 offset);/* NI */
433 void osd_req_clear(struct osd_request *or,
434 const struct osd_obj_id *, u64 offset, u64 len);/* NI */
435 void osd_req_punch(struct osd_request *or,
436 const struct osd_obj_id *, u64 offset, u64 len);/* V2-only NI */
437
438 void osd_req_flush_object(struct osd_request *or,
439 const struct osd_obj_id *, enum osd_options_flush_scope_values,
440 /*V2*/ u64 offset, /*V2*/ u64 len);
441
442 void osd_req_read(struct osd_request *or,
443 const struct osd_obj_id *obj, u64 offset, struct bio *bio, u64 len);
444 int osd_req_read_kern(struct osd_request *or,
445 const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
446
447 /* Scatter/Gather write/read commands */
448 int osd_req_write_sg(struct osd_request *or,
449 const struct osd_obj_id *obj, struct bio *bio,
450 const struct osd_sg_entry *sglist, unsigned numentries);
451 int osd_req_read_sg(struct osd_request *or,
452 const struct osd_obj_id *obj, struct bio *bio,
453 const struct osd_sg_entry *sglist, unsigned numentries);
454 int osd_req_write_sg_kern(struct osd_request *or,
455 const struct osd_obj_id *obj, void **buff,
456 const struct osd_sg_entry *sglist, unsigned numentries);
457 int osd_req_read_sg_kern(struct osd_request *or,
458 const struct osd_obj_id *obj, void **buff,
459 const struct osd_sg_entry *sglist, unsigned numentries);
460
461 /*
462 * Root/Partition/Collection/Object Attributes commands
463 */
464
465 /* get before set */
466 void osd_req_get_attributes(struct osd_request *or, const struct osd_obj_id *);
467
468 /* set before get */
469 void osd_req_set_attributes(struct osd_request *or, const struct osd_obj_id *);
470
471 /*
472 * Attributes appended to most commands
473 */
474
475 /* Attributes List mode (or V2 CDB) */
476 /*
477 * TODO: In ver2 if at finalize time only one attr was set and no gets,
478 * then the Attributes CDB mode is used automatically to save IO.
479 */
480
481 /* set a list of attributes. */
482 int osd_req_add_set_attr_list(struct osd_request *or,
483 const struct osd_attr *, unsigned nelem);
484
485 /* get a list of attributes */
486 int osd_req_add_get_attr_list(struct osd_request *or,
487 const struct osd_attr *, unsigned nelem);
488
489 /*
490 * Attributes list decoding
491 * Must be called after osd_request.request was executed
492 * It is called in a loop to decode the returned get_attr
493 * (see osd_add_get_attr)
494 */
495 int osd_req_decode_get_attr_list(struct osd_request *or,
496 struct osd_attr *, int *nelem, void **iterator);
497
498 /* Attributes Page mode */
499
500 /*
501 * Read an attribute page and optionally set one attribute
502 *
503 * Retrieves the attribute page directly to a user buffer.
504 * @attr_page_data shall stay valid until end of execution.
505 * See osd_attributes.h for common page structures
506 */
507 int osd_req_add_get_attr_page(struct osd_request *or,
508 u32 page_id, void *attr_page_data, unsigned max_page_len,
509 const struct osd_attr *set_one);
510
511 #endif /* __OSD_LIB_H__ */
512