[SCSI] osduld: Use device->release instead of internal kref
[linux-2.6.git] / include / scsi / osd_initiator.h
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 <bharrosh@panasas.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 "osd_protocol.h"
18 #include "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 /* 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);
61
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);
66
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);
70
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)
74 {
75         return od->scsi_device->request_queue;
76 }
77
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)
80 {
81 #ifdef OSD_VER1_SUPPORT
82         od->version = v;
83 #endif
84 }
85
86 static inline bool osd_dev_is_ver1(struct osd_dev *od)
87 {
88 #ifdef OSD_VER1_SUPPORT
89         return od->version == OSD_VER1;
90 #else
91         return false;
92 #endif
93 }
94
95 struct osd_request;
96 typedef void (osd_req_done_fn)(struct osd_request *or, void *private);
97
98 struct osd_request {
99         struct osd_cdb cdb;
100         struct osd_data_out_integrity_info out_data_integ;
101         struct osd_data_in_integrity_info in_data_integ;
102
103         struct osd_dev *osd_dev;
104         struct request *request;
105
106         struct _osd_req_data_segment {
107                 void *buff;
108                 unsigned alloc_size; /* 0 here means: don't call kfree */
109                 unsigned total_bytes;
110         } set_attr, enc_get_attr, get_attr;
111
112         struct _osd_io_info {
113                 struct bio *bio;
114                 u64 total_bytes;
115                 struct request *req;
116                 struct _osd_req_data_segment *last_seg;
117                 u8 *pad_buff;
118         } out, in;
119
120         gfp_t alloc_flags;
121         unsigned timeout;
122         unsigned retries;
123         u8 sense[OSD_MAX_SENSE_LEN];
124         enum osd_attributes_mode attributes_mode;
125
126         osd_req_done_fn *async_done;
127         void *async_private;
128         int async_error;
129 };
130
131 static inline bool osd_req_is_ver1(struct osd_request *or)
132 {
133         return osd_dev_is_ver1(or->osd_dev);
134 }
135
136 /*
137  * How to use the osd library:
138  *
139  * osd_start_request
140  *      Allocates a request.
141  *
142  * osd_req_*
143  *      Call one of, to encode the desired operation.
144  *
145  * osd_add_{get,set}_attr
146  *      Optionally add attributes to the CDB, list or page mode.
147  *
148  * osd_finalize_request
149  *      Computes final data out/in offsets and signs the request,
150  *      making it ready for execution.
151  *
152  * osd_execute_request
153  *      May be called to execute it through the block layer. Other wise submit
154  *      the associated block request in some other way.
155  *
156  * After execution:
157  * osd_req_decode_sense
158  *      Decodes sense information to verify execution results.
159  *
160  * osd_req_decode_get_attr
161  *      Retrieve osd_add_get_attr_list() values if used.
162  *
163  * osd_end_request
164  *      Must be called to deallocate the request.
165  */
166
167 /**
168  * osd_start_request - Allocate and initialize an osd_request
169  *
170  * @osd_dev:    OSD device that holds the scsi-device and default values
171  *              that the request is associated with.
172  * @gfp:        The allocation flags to use for request allocation, and all
173  *              subsequent allocations. This will be stored at
174  *              osd_request->alloc_flags, can be changed by user later
175  *
176  * Allocate osd_request and initialize all members to the
177  * default/initial state.
178  */
179 struct osd_request *osd_start_request(struct osd_dev *od, gfp_t gfp);
180
181 enum osd_req_options {
182         OSD_REQ_FUA = 0x08,     /* Force Unit Access */
183         OSD_REQ_DPO = 0x10,     /* Disable Page Out */
184
185         OSD_REQ_BYPASS_TIMESTAMPS = 0x80,
186 };
187
188 /**
189  * osd_finalize_request - Sign request and prepare request for execution
190  *
191  * @or:         osd_request to prepare
192  * @options:    combination of osd_req_options bit flags or 0.
193  * @cap:        A Pointer to an OSD_CAP_LEN bytes buffer that is received from
194  *              The security manager as capabilities for this cdb.
195  * @cap_key:    The cryptographic key used to sign the cdb/data. Can be null
196  *              if NOSEC is used.
197  *
198  * The actual request and bios are only allocated here, so are the get_attr
199  * buffers that will receive the returned attributes. Copy's @cap to cdb.
200  * Sign the cdb/data with @cap_key.
201  */
202 int osd_finalize_request(struct osd_request *or,
203         u8 options, const void *cap, const u8 *cap_key);
204
205 /**
206  * osd_execute_request - Execute the request synchronously through block-layer
207  *
208  * @or:         osd_request to Executed
209  *
210  * Calls blk_execute_rq to q the command and waits for completion.
211  */
212 int osd_execute_request(struct osd_request *or);
213
214 /**
215  * osd_execute_request_async - Execute the request without waitting.
216  *
217  * @or:                      - osd_request to Executed
218  * @done: (Optional)         - Called at end of execution
219  * @private:                 - Will be passed to @done function
220  *
221  * Calls blk_execute_rq_nowait to queue the command. When execution is done
222  * optionally calls @done with @private as parameter. @or->async_error will
223  * have the return code
224  */
225 int osd_execute_request_async(struct osd_request *or,
226         osd_req_done_fn *done, void *private);
227
228 /**
229  * osd_req_decode_sense_full - Decode sense information after execution.
230  *
231  * @or:           - osd_request to examine
232  * @osi           - Recievs a more detailed error report information (optional).
233  * @silent        - Do not print to dmsg (Even if enabled)
234  * @bad_obj_list  - Some commands act on multiple objects. Failed objects will
235  *                  be recieved here (optional)
236  * @max_obj       - Size of @bad_obj_list.
237  * @bad_attr_list - List of failing attributes (optional)
238  * @max_attr      - Size of @bad_attr_list.
239  *
240  * After execution, sense + return code can be analyzed using this function. The
241  * return code is the final disposition on the error. So it is possible that a
242  * CHECK_CONDITION was returned from target but this will return NO_ERROR, for
243  * example on recovered errors. All parameters are optional if caller does
244  * not need any returned information.
245  * Note: This function will also dump the error to dmsg according to settings
246  * of the SCSI_OSD_DPRINT_SENSE Kconfig value. Set @silent if you know the
247  * command would routinely fail, to not spam the dmsg file.
248  */
249 struct osd_sense_info {
250         int key;                /* one of enum scsi_sense_keys */
251         int additional_code ;   /* enum osd_additional_sense_codes */
252         union { /* Sense specific information */
253                 u16 sense_info;
254                 u16 cdb_field_offset;   /* scsi_invalid_field_in_cdb */
255         };
256         union { /* Command specific information */
257                 u64 command_info;
258         };
259
260         u32 not_initiated_command_functions; /* osd_command_functions_bits */
261         u32 completed_command_functions; /* osd_command_functions_bits */
262         struct osd_obj_id obj;
263         struct osd_attr attr;
264 };
265
266 int osd_req_decode_sense_full(struct osd_request *or,
267         struct osd_sense_info *osi, bool silent,
268         struct osd_obj_id *bad_obj_list, int max_obj,
269         struct osd_attr *bad_attr_list, int max_attr);
270
271 static inline int osd_req_decode_sense(struct osd_request *or,
272         struct osd_sense_info *osi)
273 {
274         return osd_req_decode_sense_full(or, osi, false, NULL, 0, NULL, 0);
275 }
276
277 /**
278  * osd_end_request - return osd_request to free store
279  *
280  * @or:         osd_request to free
281  *
282  * Deallocate all osd_request resources (struct req's, BIOs, buffers, etc.)
283  */
284 void osd_end_request(struct osd_request *or);
285
286 /*
287  * CDB Encoding
288  *
289  * Note: call only one of the following methods.
290  */
291
292 /*
293  * Device commands
294  */
295 void osd_req_set_master_seed_xchg(struct osd_request *or, ...);/* NI */
296 void osd_req_set_master_key(struct osd_request *or, ...);/* NI */
297
298 void osd_req_format(struct osd_request *or, u64 tot_capacity);
299
300 /* list all partitions
301  * @list header must be initialized to zero on first run.
302  *
303  * Call osd_is_obj_list_done() to find if we got the complete list.
304  */
305 int osd_req_list_dev_partitions(struct osd_request *or,
306         osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem);
307
308 void osd_req_flush_obsd(struct osd_request *or,
309         enum osd_options_flush_scope_values);
310
311 void osd_req_perform_scsi_command(struct osd_request *or,
312         const u8 *cdb, ...);/* NI */
313 void osd_req_task_management(struct osd_request *or, ...);/* NI */
314
315 /*
316  * Partition commands
317  */
318 void osd_req_create_partition(struct osd_request *or, osd_id partition);
319 void osd_req_remove_partition(struct osd_request *or, osd_id partition);
320
321 void osd_req_set_partition_key(struct osd_request *or,
322         osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
323         u8 seed[OSD_CRYPTO_SEED_SIZE]);/* NI */
324
325 /* list all collections in the partition
326  * @list header must be init to zero on first run.
327  *
328  * Call osd_is_obj_list_done() to find if we got the complete list.
329  */
330 int osd_req_list_partition_collections(struct osd_request *or,
331         osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
332         unsigned nelem);
333
334 /* list all objects in the partition
335  * @list header must be init to zero on first run.
336  *
337  * Call osd_is_obj_list_done() to find if we got the complete list.
338  */
339 int osd_req_list_partition_objects(struct osd_request *or,
340         osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
341         unsigned nelem);
342
343 void osd_req_flush_partition(struct osd_request *or,
344         osd_id partition, enum osd_options_flush_scope_values);
345
346 /*
347  * Collection commands
348  */
349 void osd_req_create_collection(struct osd_request *or,
350         const struct osd_obj_id *);/* NI */
351 void osd_req_remove_collection(struct osd_request *or,
352         const struct osd_obj_id *);/* NI */
353
354 /* list all objects in the collection */
355 int osd_req_list_collection_objects(struct osd_request *or,
356         const struct osd_obj_id *, osd_id initial_id,
357         struct osd_obj_id_list *list, unsigned nelem);
358
359 /* V2 only filtered list of objects in the collection */
360 void osd_req_query(struct osd_request *or, ...);/* NI */
361
362 void osd_req_flush_collection(struct osd_request *or,
363         const struct osd_obj_id *, enum osd_options_flush_scope_values);
364
365 void osd_req_get_member_attrs(struct osd_request *or, ...);/* V2-only NI */
366 void osd_req_set_member_attrs(struct osd_request *or, ...);/* V2-only NI */
367
368 /*
369  * Object commands
370  */
371 void osd_req_create_object(struct osd_request *or, struct osd_obj_id *);
372 void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *);
373
374 void osd_req_write(struct osd_request *or,
375         const struct osd_obj_id *obj, u64 offset, struct bio *bio, u64 len);
376 int osd_req_write_kern(struct osd_request *or,
377         const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
378 void osd_req_append(struct osd_request *or,
379         const struct osd_obj_id *, struct bio *data_out);/* NI */
380 void osd_req_create_write(struct osd_request *or,
381         const struct osd_obj_id *, struct bio *data_out, u64 offset);/* NI */
382 void osd_req_clear(struct osd_request *or,
383         const struct osd_obj_id *, u64 offset, u64 len);/* NI */
384 void osd_req_punch(struct osd_request *or,
385         const struct osd_obj_id *, u64 offset, u64 len);/* V2-only NI */
386
387 void osd_req_flush_object(struct osd_request *or,
388         const struct osd_obj_id *, enum osd_options_flush_scope_values,
389         /*V2*/ u64 offset, /*V2*/ u64 len);
390
391 void osd_req_read(struct osd_request *or,
392         const struct osd_obj_id *obj, u64 offset, struct bio *bio, u64 len);
393 int osd_req_read_kern(struct osd_request *or,
394         const struct osd_obj_id *obj, u64 offset, void *buff, u64 len);
395
396 /*
397  * Root/Partition/Collection/Object Attributes commands
398  */
399
400 /* get before set */
401 void osd_req_get_attributes(struct osd_request *or, const struct osd_obj_id *);
402
403 /* set before get */
404 void osd_req_set_attributes(struct osd_request *or, const struct osd_obj_id *);
405
406 /*
407  * Attributes appended to most commands
408  */
409
410 /* Attributes List mode (or V2 CDB) */
411   /*
412    * TODO: In ver2 if at finalize time only one attr was set and no gets,
413    * then the Attributes CDB mode is used automatically to save IO.
414    */
415
416 /* set a list of attributes. */
417 int osd_req_add_set_attr_list(struct osd_request *or,
418         const struct osd_attr *, unsigned nelem);
419
420 /* get a list of attributes */
421 int osd_req_add_get_attr_list(struct osd_request *or,
422         const struct osd_attr *, unsigned nelem);
423
424 /*
425  * Attributes list decoding
426  * Must be called after osd_request.request was executed
427  * It is called in a loop to decode the returned get_attr
428  * (see osd_add_get_attr)
429  */
430 int osd_req_decode_get_attr_list(struct osd_request *or,
431         struct osd_attr *, int *nelem, void **iterator);
432
433 /* Attributes Page mode */
434
435 /*
436  * Read an attribute page and optionally set one attribute
437  *
438  * Retrieves the attribute page directly to a user buffer.
439  * @attr_page_data shall stay valid until end of execution.
440  * See osd_attributes.h for common page structures
441  */
442 int osd_req_add_get_attr_page(struct osd_request *or,
443         u32 page_id, void *attr_page_data, unsigned max_page_len,
444         const struct osd_attr *set_one);
445
446 #endif /* __OSD_LIB_H__ */