2 * osd_initiator.h - OSD initiator API definition
4 * Copyright (C) 2008 Panasas Inc. All rights reserved.
7 * Boaz Harrosh <bharrosh@panasas.com>
8 * Benny Halevy <bhalevy@panasas.com>
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
14 #ifndef __OSD_INITIATOR_H__
15 #define __OSD_INITIATOR_H__
17 #include "osd_protocol.h"
18 #include "osd_types.h"
20 #include <linux/blkdev.h>
21 #include <scsi/scsi_device.h>
23 /* Note: "NI" in comments below means "Not Implemented yet" */
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
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?
34 #define OSD_VER1_SUPPORT y
36 enum osd_std_version {
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.
50 struct scsi_device *scsi_device;
53 #ifdef OSD_VER1_SUPPORT
54 enum osd_std_version version;
58 /* Retrieve/return osd_dev(s) for use by Kernel clients */
59 struct osd_dev *osduld_path_lookup(const char *dev_name); /*Use IS_ERR/ERR_PTR*/
60 void osduld_put_device(struct osd_dev *od);
62 /* Add/remove test ioctls from external modules */
63 typedef int (do_test_fn)(struct osd_dev *od, unsigned cmd, unsigned long arg);
64 int osduld_register_test(unsigned ioctl, do_test_fn *do_test);
65 void osduld_unregister_test(unsigned ioctl);
67 /* These are called by uld at probe time */
68 void osd_dev_init(struct osd_dev *od, struct scsi_device *scsi_device);
69 void osd_dev_fini(struct osd_dev *od);
71 /* some hi level device operations */
72 int osd_auto_detect_ver(struct osd_dev *od, void *caps); /* GFP_KERNEL */
73 static inline struct request_queue *osd_request_queue(struct osd_dev *od)
75 return od->scsi_device->request_queue;
78 /* we might want to use function vector in the future */
79 static inline void osd_dev_set_ver(struct osd_dev *od, enum osd_std_version v)
81 #ifdef OSD_VER1_SUPPORT
87 typedef void (osd_req_done_fn)(struct osd_request *or, void *private);
91 struct osd_data_out_integrity_info out_data_integ;
92 struct osd_data_in_integrity_info in_data_integ;
94 struct osd_dev *osd_dev;
95 struct request *request;
97 struct _osd_req_data_segment {
99 unsigned alloc_size; /* 0 here means: don't call kfree */
100 unsigned total_bytes;
101 } set_attr, enc_get_attr, get_attr;
103 struct _osd_io_info {
107 struct _osd_req_data_segment *last_seg;
114 u8 sense[OSD_MAX_SENSE_LEN];
115 enum osd_attributes_mode attributes_mode;
117 osd_req_done_fn *async_done;
122 /* OSD Version control */
123 static inline bool osd_req_is_ver1(struct osd_request *or)
125 #ifdef OSD_VER1_SUPPORT
126 return or->osd_dev->version == OSD_VER1;
133 * How to use the osd library:
136 * Allocates a request.
139 * Call one of, to encode the desired operation.
141 * osd_add_{get,set}_attr
142 * Optionally add attributes to the CDB, list or page mode.
144 * osd_finalize_request
145 * Computes final data out/in offsets and signs the request,
146 * making it ready for execution.
148 * osd_execute_request
149 * May be called to execute it through the block layer. Other wise submit
150 * the associated block request in some other way.
153 * osd_req_decode_sense
154 * Decodes sense information to verify execution results.
156 * osd_req_decode_get_attr
157 * Retrieve osd_add_get_attr_list() values if used.
160 * Must be called to deallocate the request.
164 * osd_start_request - Allocate and initialize an osd_request
166 * @osd_dev: OSD device that holds the scsi-device and default values
167 * that the request is associated with.
168 * @gfp: The allocation flags to use for request allocation, and all
169 * subsequent allocations. This will be stored at
170 * osd_request->alloc_flags, can be changed by user later
172 * Allocate osd_request and initialize all members to the
173 * default/initial state.
175 struct osd_request *osd_start_request(struct osd_dev *od, gfp_t gfp);
177 enum osd_req_options {
178 OSD_REQ_FUA = 0x08, /* Force Unit Access */
179 OSD_REQ_DPO = 0x10, /* Disable Page Out */
181 OSD_REQ_BYPASS_TIMESTAMPS = 0x80,
185 * osd_finalize_request - Sign request and prepare request for execution
187 * @or: osd_request to prepare
188 * @options: combination of osd_req_options bit flags or 0.
189 * @cap: A Pointer to an OSD_CAP_LEN bytes buffer that is received from
190 * The security manager as capabilities for this cdb.
191 * @cap_key: The cryptographic key used to sign the cdb/data. Can be null
194 * The actual request and bios are only allocated here, so are the get_attr
195 * buffers that will receive the returned attributes. Copy's @cap to cdb.
196 * Sign the cdb/data with @cap_key.
198 int osd_finalize_request(struct osd_request *or,
199 u8 options, const void *cap, const u8 *cap_key);
202 * osd_execute_request - Execute the request synchronously through block-layer
204 * @or: osd_request to Executed
206 * Calls blk_execute_rq to q the command and waits for completion.
208 int osd_execute_request(struct osd_request *or);
211 * osd_execute_request_async - Execute the request without waitting.
213 * @or: - osd_request to Executed
214 * @done: (Optional) - Called at end of execution
215 * @private: - Will be passed to @done function
217 * Calls blk_execute_rq_nowait to queue the command. When execution is done
218 * optionally calls @done with @private as parameter. @or->async_error will
219 * have the return code
221 int osd_execute_request_async(struct osd_request *or,
222 osd_req_done_fn *done, void *private);
225 * osd_req_decode_sense_full - Decode sense information after execution.
227 * @or: - osd_request to examine
228 * @osi - Recievs a more detailed error report information (optional).
229 * @silent - Do not print to dmsg (Even if enabled)
230 * @bad_obj_list - Some commands act on multiple objects. Failed objects will
231 * be recieved here (optional)
232 * @max_obj - Size of @bad_obj_list.
233 * @bad_attr_list - List of failing attributes (optional)
234 * @max_attr - Size of @bad_attr_list.
236 * After execution, sense + return code can be analyzed using this function. The
237 * return code is the final disposition on the error. So it is possible that a
238 * CHECK_CONDITION was returned from target but this will return NO_ERROR, for
239 * example on recovered errors. All parameters are optional if caller does
240 * not need any returned information.
241 * Note: This function will also dump the error to dmsg according to settings
242 * of the SCSI_OSD_DPRINT_SENSE Kconfig value. Set @silent if you know the
243 * command would routinely fail, to not spam the dmsg file.
245 struct osd_sense_info {
246 int key; /* one of enum scsi_sense_keys */
247 int additional_code ; /* enum osd_additional_sense_codes */
248 union { /* Sense specific information */
250 u16 cdb_field_offset; /* scsi_invalid_field_in_cdb */
252 union { /* Command specific information */
256 u32 not_initiated_command_functions; /* osd_command_functions_bits */
257 u32 completed_command_functions; /* osd_command_functions_bits */
258 struct osd_obj_id obj;
259 struct osd_attr attr;
262 int osd_req_decode_sense_full(struct osd_request *or,
263 struct osd_sense_info *osi, bool silent,
264 struct osd_obj_id *bad_obj_list, int max_obj,
265 struct osd_attr *bad_attr_list, int max_attr);
267 static inline int osd_req_decode_sense(struct osd_request *or,
268 struct osd_sense_info *osi)
270 return osd_req_decode_sense_full(or, osi, false, NULL, 0, NULL, 0);
274 * osd_end_request - return osd_request to free store
276 * @or: osd_request to free
278 * Deallocate all osd_request resources (struct req's, BIOs, buffers, etc.)
280 void osd_end_request(struct osd_request *or);
285 * Note: call only one of the following methods.
291 void osd_req_set_master_seed_xchg(struct osd_request *or, ...);/* NI */
292 void osd_req_set_master_key(struct osd_request *or, ...);/* NI */
294 void osd_req_format(struct osd_request *or, u64 tot_capacity);
296 /* list all partitions
297 * @list header must be initialized to zero on first run.
299 * Call osd_is_obj_list_done() to find if we got the complete list.
301 int osd_req_list_dev_partitions(struct osd_request *or,
302 osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem);
304 void osd_req_flush_obsd(struct osd_request *or,
305 enum osd_options_flush_scope_values);
307 void osd_req_perform_scsi_command(struct osd_request *or,
308 const u8 *cdb, ...);/* NI */
309 void osd_req_task_management(struct osd_request *or, ...);/* NI */
314 void osd_req_create_partition(struct osd_request *or, osd_id partition);
315 void osd_req_remove_partition(struct osd_request *or, osd_id partition);
317 void osd_req_set_partition_key(struct osd_request *or,
318 osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
319 u8 seed[OSD_CRYPTO_SEED_SIZE]);/* NI */
321 /* list all collections in the partition
322 * @list header must be init to zero on first run.
324 * Call osd_is_obj_list_done() to find if we got the complete list.
326 int osd_req_list_partition_collections(struct osd_request *or,
327 osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
330 /* list all objects in the partition
331 * @list header must be init to zero on first run.
333 * Call osd_is_obj_list_done() to find if we got the complete list.
335 int osd_req_list_partition_objects(struct osd_request *or,
336 osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
339 void osd_req_flush_partition(struct osd_request *or,
340 osd_id partition, enum osd_options_flush_scope_values);
343 * Collection commands
345 void osd_req_create_collection(struct osd_request *or,
346 const struct osd_obj_id *);/* NI */
347 void osd_req_remove_collection(struct osd_request *or,
348 const struct osd_obj_id *);/* NI */
350 /* list all objects in the collection */
351 int osd_req_list_collection_objects(struct osd_request *or,
352 const struct osd_obj_id *, osd_id initial_id,
353 struct osd_obj_id_list *list, unsigned nelem);
355 /* V2 only filtered list of objects in the collection */
356 void osd_req_query(struct osd_request *or, ...);/* NI */
358 void osd_req_flush_collection(struct osd_request *or,
359 const struct osd_obj_id *, enum osd_options_flush_scope_values);
361 void osd_req_get_member_attrs(struct osd_request *or, ...);/* V2-only NI */
362 void osd_req_set_member_attrs(struct osd_request *or, ...);/* V2-only NI */
367 void osd_req_create_object(struct osd_request *or, struct osd_obj_id *);
368 void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *);
370 void osd_req_write(struct osd_request *or,
371 const struct osd_obj_id *obj, u64 offset, struct bio *bio, u64 len);
372 int osd_req_write_kern(struct osd_request *or,
373 const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
374 void osd_req_append(struct osd_request *or,
375 const struct osd_obj_id *, struct bio *data_out);/* NI */
376 void osd_req_create_write(struct osd_request *or,
377 const struct osd_obj_id *, struct bio *data_out, u64 offset);/* NI */
378 void osd_req_clear(struct osd_request *or,
379 const struct osd_obj_id *, u64 offset, u64 len);/* NI */
380 void osd_req_punch(struct osd_request *or,
381 const struct osd_obj_id *, u64 offset, u64 len);/* V2-only NI */
383 void osd_req_flush_object(struct osd_request *or,
384 const struct osd_obj_id *, enum osd_options_flush_scope_values,
385 /*V2*/ u64 offset, /*V2*/ u64 len);
387 void osd_req_read(struct osd_request *or,
388 const struct osd_obj_id *obj, u64 offset, struct bio *bio, u64 len);
389 int osd_req_read_kern(struct osd_request *or,
390 const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
393 * Root/Partition/Collection/Object Attributes commands
397 void osd_req_get_attributes(struct osd_request *or, const struct osd_obj_id *);
400 void osd_req_set_attributes(struct osd_request *or, const struct osd_obj_id *);
403 * Attributes appended to most commands
406 /* Attributes List mode (or V2 CDB) */
408 * TODO: In ver2 if at finalize time only one attr was set and no gets,
409 * then the Attributes CDB mode is used automatically to save IO.
412 /* set a list of attributes. */
413 int osd_req_add_set_attr_list(struct osd_request *or,
414 const struct osd_attr *, unsigned nelem);
416 /* get a list of attributes */
417 int osd_req_add_get_attr_list(struct osd_request *or,
418 const struct osd_attr *, unsigned nelem);
421 * Attributes list decoding
422 * Must be called after osd_request.request was executed
423 * It is called in a loop to decode the returned get_attr
424 * (see osd_add_get_attr)
426 int osd_req_decode_get_attr_list(struct osd_request *or,
427 struct osd_attr *, int *nelem, void **iterator);
429 /* Attributes Page mode */
432 * Read an attribute page and optionally set one attribute
434 * Retrieves the attribute page directly to a user buffer.
435 * @attr_page_data shall stay valid until end of execution.
436 * See osd_attributes.h for common page structures
438 int osd_req_add_get_attr_page(struct osd_request *or,
439 u32 page_id, void *attr_page_data, unsigned max_page_len,
440 const struct osd_attr *set_one);
442 #endif /* __OSD_LIB_H__ */