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 /* Unique Identification of an OSD device */
60 unsigned systemid_len
;
61 u8 systemid
[OSD_SYSTEMID_LEN
];
66 /* Retrieve/return osd_dev(s) for use by Kernel clients
67 * Use IS_ERR/ERR_PTR on returned "osd_dev *".
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
);
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
);
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
);
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
);
86 * osd_auto_detect_ver - Detect the OSD version, return Unique Identification
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.
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
100 int osd_auto_detect_ver(struct osd_dev
*od
,
101 void *caps
, struct osd_dev_info
*odi
);
103 static inline struct request_queue
*osd_request_queue(struct osd_dev
*od
)
105 return od
->scsi_device
->request_queue
;
108 /* we might want to use function vector in the future */
109 static inline void osd_dev_set_ver(struct osd_dev
*od
, enum osd_std_version v
)
111 #ifdef OSD_VER1_SUPPORT
116 static inline bool osd_dev_is_ver1(struct osd_dev
*od
)
118 #ifdef OSD_VER1_SUPPORT
119 return od
->version
== OSD_VER1
;
126 typedef void (osd_req_done_fn
)(struct osd_request
*or, void *private);
130 struct osd_data_out_integrity_info out_data_integ
;
131 struct osd_data_in_integrity_info in_data_integ
;
133 struct osd_dev
*osd_dev
;
134 struct request
*request
;
136 struct _osd_req_data_segment
{
138 unsigned alloc_size
; /* 0 here means: don't call kfree */
139 unsigned total_bytes
;
140 } set_attr
, enc_get_attr
, get_attr
;
142 struct _osd_io_info
{
146 struct _osd_req_data_segment
*last_seg
;
153 u8 sense
[OSD_MAX_SENSE_LEN
];
154 enum osd_attributes_mode attributes_mode
;
156 osd_req_done_fn
*async_done
;
161 static inline bool osd_req_is_ver1(struct osd_request
*or)
163 return osd_dev_is_ver1(or->osd_dev
);
167 * How to use the osd library:
170 * Allocates a request.
173 * Call one of, to encode the desired operation.
175 * osd_add_{get,set}_attr
176 * Optionally add attributes to the CDB, list or page mode.
178 * osd_finalize_request
179 * Computes final data out/in offsets and signs the request,
180 * making it ready for execution.
182 * osd_execute_request
183 * May be called to execute it through the block layer. Other wise submit
184 * the associated block request in some other way.
187 * osd_req_decode_sense
188 * Decodes sense information to verify execution results.
190 * osd_req_decode_get_attr
191 * Retrieve osd_add_get_attr_list() values if used.
194 * Must be called to deallocate the request.
198 * osd_start_request - Allocate and initialize an osd_request
200 * @osd_dev: OSD device that holds the scsi-device and default values
201 * that the request is associated with.
202 * @gfp: The allocation flags to use for request allocation, and all
203 * subsequent allocations. This will be stored at
204 * osd_request->alloc_flags, can be changed by user later
206 * Allocate osd_request and initialize all members to the
207 * default/initial state.
209 struct osd_request
*osd_start_request(struct osd_dev
*od
, gfp_t gfp
);
211 enum osd_req_options
{
212 OSD_REQ_FUA
= 0x08, /* Force Unit Access */
213 OSD_REQ_DPO
= 0x10, /* Disable Page Out */
215 OSD_REQ_BYPASS_TIMESTAMPS
= 0x80,
219 * osd_finalize_request - Sign request and prepare request for execution
221 * @or: osd_request to prepare
222 * @options: combination of osd_req_options bit flags or 0.
223 * @cap: A Pointer to an OSD_CAP_LEN bytes buffer that is received from
224 * The security manager as capabilities for this cdb.
225 * @cap_key: The cryptographic key used to sign the cdb/data. Can be null
228 * The actual request and bios are only allocated here, so are the get_attr
229 * buffers that will receive the returned attributes. Copy's @cap to cdb.
230 * Sign the cdb/data with @cap_key.
232 int osd_finalize_request(struct osd_request
*or,
233 u8 options
, const void *cap
, const u8
*cap_key
);
236 * osd_execute_request - Execute the request synchronously through block-layer
238 * @or: osd_request to Executed
240 * Calls blk_execute_rq to q the command and waits for completion.
242 int osd_execute_request(struct osd_request
*or);
245 * osd_execute_request_async - Execute the request without waitting.
247 * @or: - osd_request to Executed
248 * @done: (Optional) - Called at end of execution
249 * @private: - Will be passed to @done function
251 * Calls blk_execute_rq_nowait to queue the command. When execution is done
252 * optionally calls @done with @private as parameter. @or->async_error will
253 * have the return code
255 int osd_execute_request_async(struct osd_request
*or,
256 osd_req_done_fn
*done
, void *private);
259 * osd_req_decode_sense_full - Decode sense information after execution.
261 * @or: - osd_request to examine
262 * @osi - Recievs a more detailed error report information (optional).
263 * @silent - Do not print to dmsg (Even if enabled)
264 * @bad_obj_list - Some commands act on multiple objects. Failed objects will
265 * be recieved here (optional)
266 * @max_obj - Size of @bad_obj_list.
267 * @bad_attr_list - List of failing attributes (optional)
268 * @max_attr - Size of @bad_attr_list.
270 * After execution, osd_request results are analyzed using this function. The
271 * return code is the final disposition on the error. So it is possible that a
272 * CHECK_CONDITION was returned from target but this will return NO_ERROR, for
273 * example on recovered errors. All parameters are optional if caller does
274 * not need any returned information.
275 * Note: This function will also dump the error to dmsg according to settings
276 * of the SCSI_OSD_DPRINT_SENSE Kconfig value. Set @silent if you know the
277 * command would routinely fail, to not spam the dmsg file.
281 * osd_err_priority - osd categorized return codes in ascending severity.
283 * The categories are borrowed from the pnfs_osd_errno enum.
284 * See comments for translated Linux codes returned by osd_req_decode_sense.
286 enum osd_err_priority
{
287 OSD_ERR_PRI_NO_ERROR
= 0,
288 /* Recoverable, caller should clear_highpage() all pages */
289 OSD_ERR_PRI_CLEAR_PAGES
= 1, /* -EFAULT */
290 OSD_ERR_PRI_RESOURCE
= 2, /* -ENOMEM */
291 OSD_ERR_PRI_BAD_CRED
= 3, /* -EINVAL */
292 OSD_ERR_PRI_NO_ACCESS
= 4, /* -EACCES */
293 OSD_ERR_PRI_UNREACHABLE
= 5, /* any other */
294 OSD_ERR_PRI_NOT_FOUND
= 6, /* -ENOENT */
295 OSD_ERR_PRI_NO_SPACE
= 7, /* -ENOSPC */
296 OSD_ERR_PRI_EIO
= 8, /* -EIO */
299 struct osd_sense_info
{
300 u64 out_resid
; /* Zero on success otherwise out residual */
301 u64 in_resid
; /* Zero on success otherwise in residual */
302 enum osd_err_priority osd_err_pri
;
304 int key
; /* one of enum scsi_sense_keys */
305 int additional_code
; /* enum osd_additional_sense_codes */
306 union { /* Sense specific information */
308 u16 cdb_field_offset
; /* scsi_invalid_field_in_cdb */
310 union { /* Command specific information */
314 u32 not_initiated_command_functions
; /* osd_command_functions_bits */
315 u32 completed_command_functions
; /* osd_command_functions_bits */
316 struct osd_obj_id obj
;
317 struct osd_attr attr
;
320 int osd_req_decode_sense_full(struct osd_request
*or,
321 struct osd_sense_info
*osi
, bool silent
,
322 struct osd_obj_id
*bad_obj_list
, int max_obj
,
323 struct osd_attr
*bad_attr_list
, int max_attr
);
325 static inline int osd_req_decode_sense(struct osd_request
*or,
326 struct osd_sense_info
*osi
)
328 return osd_req_decode_sense_full(or, osi
, false, NULL
, 0, NULL
, 0);
332 * osd_end_request - return osd_request to free store
334 * @or: osd_request to free
336 * Deallocate all osd_request resources (struct req's, BIOs, buffers, etc.)
338 void osd_end_request(struct osd_request
*or);
343 * Note: call only one of the following methods.
349 void osd_req_set_master_seed_xchg(struct osd_request
*or, ...);/* NI */
350 void osd_req_set_master_key(struct osd_request
*or, ...);/* NI */
352 void osd_req_format(struct osd_request
*or, u64 tot_capacity
);
354 /* list all partitions
355 * @list header must be initialized to zero on first run.
357 * Call osd_is_obj_list_done() to find if we got the complete list.
359 int osd_req_list_dev_partitions(struct osd_request
*or,
360 osd_id initial_id
, struct osd_obj_id_list
*list
, unsigned nelem
);
362 void osd_req_flush_obsd(struct osd_request
*or,
363 enum osd_options_flush_scope_values
);
365 void osd_req_perform_scsi_command(struct osd_request
*or,
366 const u8
*cdb
, ...);/* NI */
367 void osd_req_task_management(struct osd_request
*or, ...);/* NI */
372 void osd_req_create_partition(struct osd_request
*or, osd_id partition
);
373 void osd_req_remove_partition(struct osd_request
*or, osd_id partition
);
375 void osd_req_set_partition_key(struct osd_request
*or,
376 osd_id partition
, u8 new_key_id
[OSD_CRYPTO_KEYID_SIZE
],
377 u8 seed
[OSD_CRYPTO_SEED_SIZE
]);/* NI */
379 /* list all collections in the partition
380 * @list header must be init to zero on first run.
382 * Call osd_is_obj_list_done() to find if we got the complete list.
384 int osd_req_list_partition_collections(struct osd_request
*or,
385 osd_id partition
, osd_id initial_id
, struct osd_obj_id_list
*list
,
388 /* list all objects in the partition
389 * @list header must be init to zero on first run.
391 * Call osd_is_obj_list_done() to find if we got the complete list.
393 int osd_req_list_partition_objects(struct osd_request
*or,
394 osd_id partition
, osd_id initial_id
, struct osd_obj_id_list
*list
,
397 void osd_req_flush_partition(struct osd_request
*or,
398 osd_id partition
, enum osd_options_flush_scope_values
);
401 * Collection commands
403 void osd_req_create_collection(struct osd_request
*or,
404 const struct osd_obj_id
*);/* NI */
405 void osd_req_remove_collection(struct osd_request
*or,
406 const struct osd_obj_id
*);/* NI */
408 /* list all objects in the collection */
409 int osd_req_list_collection_objects(struct osd_request
*or,
410 const struct osd_obj_id
*, osd_id initial_id
,
411 struct osd_obj_id_list
*list
, unsigned nelem
);
413 /* V2 only filtered list of objects in the collection */
414 void osd_req_query(struct osd_request
*or, ...);/* NI */
416 void osd_req_flush_collection(struct osd_request
*or,
417 const struct osd_obj_id
*, enum osd_options_flush_scope_values
);
419 void osd_req_get_member_attrs(struct osd_request
*or, ...);/* V2-only NI */
420 void osd_req_set_member_attrs(struct osd_request
*or, ...);/* V2-only NI */
425 void osd_req_create_object(struct osd_request
*or, struct osd_obj_id
*);
426 void osd_req_remove_object(struct osd_request
*or, struct osd_obj_id
*);
428 void osd_req_write(struct osd_request
*or,
429 const struct osd_obj_id
*obj
, u64 offset
, struct bio
*bio
, u64 len
);
430 int osd_req_write_kern(struct osd_request
*or,
431 const struct osd_obj_id
*obj
, u64 offset
, void *buff
, u64 len
);
432 void osd_req_append(struct osd_request
*or,
433 const struct osd_obj_id
*, struct bio
*data_out
);/* NI */
434 void osd_req_create_write(struct osd_request
*or,
435 const struct osd_obj_id
*, struct bio
*data_out
, u64 offset
);/* NI */
436 void osd_req_clear(struct osd_request
*or,
437 const struct osd_obj_id
*, u64 offset
, u64 len
);/* NI */
438 void osd_req_punch(struct osd_request
*or,
439 const struct osd_obj_id
*, u64 offset
, u64 len
);/* V2-only NI */
441 void osd_req_flush_object(struct osd_request
*or,
442 const struct osd_obj_id
*, enum osd_options_flush_scope_values
,
443 /*V2*/ u64 offset
, /*V2*/ u64 len
);
445 void osd_req_read(struct osd_request
*or,
446 const struct osd_obj_id
*obj
, u64 offset
, struct bio
*bio
, u64 len
);
447 int osd_req_read_kern(struct osd_request
*or,
448 const struct osd_obj_id
*obj
, u64 offset
, void *buff
, u64 len
);
451 * Root/Partition/Collection/Object Attributes commands
455 void osd_req_get_attributes(struct osd_request
*or, const struct osd_obj_id
*);
458 void osd_req_set_attributes(struct osd_request
*or, const struct osd_obj_id
*);
461 * Attributes appended to most commands
464 /* Attributes List mode (or V2 CDB) */
466 * TODO: In ver2 if at finalize time only one attr was set and no gets,
467 * then the Attributes CDB mode is used automatically to save IO.
470 /* set a list of attributes. */
471 int osd_req_add_set_attr_list(struct osd_request
*or,
472 const struct osd_attr
*, unsigned nelem
);
474 /* get a list of attributes */
475 int osd_req_add_get_attr_list(struct osd_request
*or,
476 const struct osd_attr
*, unsigned nelem
);
479 * Attributes list decoding
480 * Must be called after osd_request.request was executed
481 * It is called in a loop to decode the returned get_attr
482 * (see osd_add_get_attr)
484 int osd_req_decode_get_attr_list(struct osd_request
*or,
485 struct osd_attr
*, int *nelem
, void **iterator
);
487 /* Attributes Page mode */
490 * Read an attribute page and optionally set one attribute
492 * Retrieves the attribute page directly to a user buffer.
493 * @attr_page_data shall stay valid until end of execution.
494 * See osd_attributes.h for common page structures
496 int osd_req_add_get_attr_page(struct osd_request
*or,
497 u32 page_id
, void *attr_page_data
, unsigned max_page_len
,
498 const struct osd_attr
*set_one
);
500 #endif /* __OSD_LIB_H__ */