2 * osd_initiator - Main body of the osd initiator library.
4 * Note: The file does not contain the advanced security functionality which
5 * is only needed by the security_manager's initiators.
7 * Copyright (C) 2008 Panasas Inc. All rights reserved.
10 * Boaz Harrosh <bharrosh@panasas.com>
11 * Benny Halevy <bhalevy@panasas.com>
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2
16 * Redistribution and use in source and binary forms, with or without
17 * modification, are permitted provided that the following conditions
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
25 * 3. Neither the name of the Panasas company nor the names of its
26 * contributors may be used to endorse or promote products derived
27 * from this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
30 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
31 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
32 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
33 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
36 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
37 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
38 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
39 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 #include <scsi/osd_initiator.h>
43 #include <scsi/osd_sec.h>
44 #include <scsi/osd_attributes.h>
45 #include <scsi/osd_sense.h>
47 #include <scsi/scsi_device.h>
49 #include "osd_debug.h"
52 # define __unused __attribute__((unused))
55 enum { OSD_REQ_RETRIES
= 1 };
57 MODULE_AUTHOR("Boaz Harrosh <bharrosh@panasas.com>");
58 MODULE_DESCRIPTION("open-osd initiator library libosd.ko");
59 MODULE_LICENSE("GPL");
61 static inline void build_test(void)
63 /* structures were not packed */
64 BUILD_BUG_ON(sizeof(struct osd_capability
) != OSD_CAP_LEN
);
65 BUILD_BUG_ON(sizeof(struct osdv2_cdb
) != OSD_TOTAL_CDB_LEN
);
66 BUILD_BUG_ON(sizeof(struct osdv1_cdb
) != OSDv1_TOTAL_CDB_LEN
);
69 static const char *_osd_ver_desc(struct osd_request
*or)
71 return osd_req_is_ver1(or) ? "OSD1" : "OSD2";
74 #define ATTR_DEF_RI(id, len) ATTR_DEF(OSD_APAGE_ROOT_INFORMATION, id, len)
76 static int _osd_get_print_system_info(struct osd_dev
*od
,
77 void *caps
, struct osd_dev_info
*odi
)
79 struct osd_request
*or;
80 struct osd_attr get_attrs
[] = {
81 ATTR_DEF_RI(OSD_ATTR_RI_VENDOR_IDENTIFICATION
, 8),
82 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_IDENTIFICATION
, 16),
83 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_MODEL
, 32),
84 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_REVISION_LEVEL
, 4),
85 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_SERIAL_NUMBER
, 64 /*variable*/),
86 ATTR_DEF_RI(OSD_ATTR_RI_OSD_NAME
, 64 /*variable*/),
87 ATTR_DEF_RI(OSD_ATTR_RI_TOTAL_CAPACITY
, 8),
88 ATTR_DEF_RI(OSD_ATTR_RI_USED_CAPACITY
, 8),
89 ATTR_DEF_RI(OSD_ATTR_RI_NUMBER_OF_PARTITIONS
, 8),
90 ATTR_DEF_RI(OSD_ATTR_RI_CLOCK
, 6),
91 /* IBM-OSD-SIM Has a bug with this one put it last */
92 ATTR_DEF_RI(OSD_ATTR_RI_OSD_SYSTEM_ID
, 20),
94 void *iter
= NULL
, *pFirst
;
95 int nelem
= ARRAY_SIZE(get_attrs
), a
= 0;
98 or = osd_start_request(od
, GFP_KERNEL
);
103 osd_req_get_attributes(or, &osd_root_object
);
104 osd_req_add_get_attr_list(or, get_attrs
, ARRAY_SIZE(get_attrs
));
106 ret
= osd_finalize_request(or, 0, caps
, NULL
);
110 ret
= osd_execute_request(or);
112 OSD_ERR("Failed to detect %s => %d\n", _osd_ver_desc(or), ret
);
116 osd_req_decode_get_attr_list(or, get_attrs
, &nelem
, &iter
);
118 OSD_INFO("Detected %s device\n",
121 pFirst
= get_attrs
[a
++].val_ptr
;
122 OSD_INFO("VENDOR_IDENTIFICATION [%s]\n",
125 pFirst
= get_attrs
[a
++].val_ptr
;
126 OSD_INFO("PRODUCT_IDENTIFICATION [%s]\n",
129 pFirst
= get_attrs
[a
++].val_ptr
;
130 OSD_INFO("PRODUCT_MODEL [%s]\n",
133 pFirst
= get_attrs
[a
++].val_ptr
;
134 OSD_INFO("PRODUCT_REVISION_LEVEL [%u]\n",
135 pFirst
? get_unaligned_be32(pFirst
) : ~0U);
137 pFirst
= get_attrs
[a
++].val_ptr
;
138 OSD_INFO("PRODUCT_SERIAL_NUMBER [%s]\n",
141 odi
->osdname_len
= get_attrs
[a
].len
;
142 /* Avoid NULL for memcmp optimization 0-length is good enough */
143 odi
->osdname
= kzalloc(odi
->osdname_len
+ 1, GFP_KERNEL
);
144 if (odi
->osdname_len
)
145 memcpy(odi
->osdname
, get_attrs
[a
].val_ptr
, odi
->osdname_len
);
146 OSD_INFO("OSD_NAME [%s]\n", odi
->osdname
);
149 pFirst
= get_attrs
[a
++].val_ptr
;
150 OSD_INFO("TOTAL_CAPACITY [0x%llx]\n",
151 pFirst
? _LLU(get_unaligned_be64(pFirst
)) : ~0ULL);
153 pFirst
= get_attrs
[a
++].val_ptr
;
154 OSD_INFO("USED_CAPACITY [0x%llx]\n",
155 pFirst
? _LLU(get_unaligned_be64(pFirst
)) : ~0ULL);
157 pFirst
= get_attrs
[a
++].val_ptr
;
158 OSD_INFO("NUMBER_OF_PARTITIONS [%llu]\n",
159 pFirst
? _LLU(get_unaligned_be64(pFirst
)) : ~0ULL);
164 /* FIXME: Where are the time utilities */
165 pFirst
= get_attrs
[a
++].val_ptr
;
166 OSD_INFO("CLOCK [0x%02x%02x%02x%02x%02x%02x]\n",
167 ((char *)pFirst
)[0], ((char *)pFirst
)[1],
168 ((char *)pFirst
)[2], ((char *)pFirst
)[3],
169 ((char *)pFirst
)[4], ((char *)pFirst
)[5]);
171 if (a
< nelem
) { /* IBM-OSD-SIM bug, Might not have it */
172 unsigned len
= get_attrs
[a
].len
;
173 char sid_dump
[32*4 + 2]; /* 2nibbles+space+ASCII */
175 hex_dump_to_buffer(get_attrs
[a
].val_ptr
, len
, 32, 1,
176 sid_dump
, sizeof(sid_dump
), true);
177 OSD_INFO("OSD_SYSTEM_ID(%d)\n"
178 " [%s]\n", len
, sid_dump
);
180 if (unlikely(len
> sizeof(odi
->systemid
))) {
181 OSD_ERR("OSD Target error: OSD_SYSTEM_ID too long(%d). "
182 "device idetification might not work\n", len
);
183 len
= sizeof(odi
->systemid
);
185 odi
->systemid_len
= len
;
186 memcpy(odi
->systemid
, get_attrs
[a
].val_ptr
, len
);
194 int osd_auto_detect_ver(struct osd_dev
*od
,
195 void *caps
, struct osd_dev_info
*odi
)
199 /* Auto-detect the osd version */
200 ret
= _osd_get_print_system_info(od
, caps
, odi
);
202 osd_dev_set_ver(od
, OSD_VER1
);
203 OSD_DEBUG("converting to OSD1\n");
204 ret
= _osd_get_print_system_info(od
, caps
, odi
);
209 EXPORT_SYMBOL(osd_auto_detect_ver
);
211 static unsigned _osd_req_cdb_len(struct osd_request
*or)
213 return osd_req_is_ver1(or) ? OSDv1_TOTAL_CDB_LEN
: OSD_TOTAL_CDB_LEN
;
216 static unsigned _osd_req_alist_elem_size(struct osd_request
*or, unsigned len
)
218 return osd_req_is_ver1(or) ?
219 osdv1_attr_list_elem_size(len
) :
220 osdv2_attr_list_elem_size(len
);
223 static void _osd_req_alist_elem_encode(struct osd_request
*or,
224 void *attr_last
, const struct osd_attr
*oa
)
226 if (osd_req_is_ver1(or)) {
227 struct osdv1_attributes_list_element
*attr
= attr_last
;
229 attr
->attr_page
= cpu_to_be32(oa
->attr_page
);
230 attr
->attr_id
= cpu_to_be32(oa
->attr_id
);
231 attr
->attr_bytes
= cpu_to_be16(oa
->len
);
232 memcpy(attr
->attr_val
, oa
->val_ptr
, oa
->len
);
234 struct osdv2_attributes_list_element
*attr
= attr_last
;
236 attr
->attr_page
= cpu_to_be32(oa
->attr_page
);
237 attr
->attr_id
= cpu_to_be32(oa
->attr_id
);
238 attr
->attr_bytes
= cpu_to_be16(oa
->len
);
239 memcpy(attr
->attr_val
, oa
->val_ptr
, oa
->len
);
243 static int _osd_req_alist_elem_decode(struct osd_request
*or,
244 void *cur_p
, struct osd_attr
*oa
, unsigned max_bytes
)
247 if (osd_req_is_ver1(or)) {
248 struct osdv1_attributes_list_element
*attr
= cur_p
;
250 if (max_bytes
< sizeof(*attr
))
253 oa
->len
= be16_to_cpu(attr
->attr_bytes
);
254 inc
= _osd_req_alist_elem_size(or, oa
->len
);
258 oa
->attr_page
= be32_to_cpu(attr
->attr_page
);
259 oa
->attr_id
= be32_to_cpu(attr
->attr_id
);
261 /* OSD1: On empty attributes we return a pointer to 2 bytes
262 * of zeros. This keeps similar behaviour with OSD2.
265 oa
->val_ptr
= likely(oa
->len
) ? attr
->attr_val
:
266 (u8
*)&attr
->attr_bytes
;
268 struct osdv2_attributes_list_element
*attr
= cur_p
;
270 if (max_bytes
< sizeof(*attr
))
273 oa
->len
= be16_to_cpu(attr
->attr_bytes
);
274 inc
= _osd_req_alist_elem_size(or, oa
->len
);
278 oa
->attr_page
= be32_to_cpu(attr
->attr_page
);
279 oa
->attr_id
= be32_to_cpu(attr
->attr_id
);
281 /* OSD2: For convenience, on empty attributes, we return 8 bytes
282 * of zeros here. This keeps the same behaviour with OSD2r04,
283 * and is nice with null terminating ASCII fields.
284 * oa->val_ptr == NULL marks the end-of-list, or error.
286 oa
->val_ptr
= likely(oa
->len
) ? attr
->attr_val
: attr
->reserved
;
291 static unsigned _osd_req_alist_size(struct osd_request
*or, void *list_head
)
293 return osd_req_is_ver1(or) ?
294 osdv1_list_size(list_head
) :
295 osdv2_list_size(list_head
);
298 static unsigned _osd_req_sizeof_alist_header(struct osd_request
*or)
300 return osd_req_is_ver1(or) ?
301 sizeof(struct osdv1_attributes_list_header
) :
302 sizeof(struct osdv2_attributes_list_header
);
305 static void _osd_req_set_alist_type(struct osd_request
*or,
306 void *list
, int list_type
)
308 if (osd_req_is_ver1(or)) {
309 struct osdv1_attributes_list_header
*attr_list
= list
;
311 memset(attr_list
, 0, sizeof(*attr_list
));
312 attr_list
->type
= list_type
;
314 struct osdv2_attributes_list_header
*attr_list
= list
;
316 memset(attr_list
, 0, sizeof(*attr_list
));
317 attr_list
->type
= list_type
;
321 static bool _osd_req_is_alist_type(struct osd_request
*or,
322 void *list
, int list_type
)
327 if (osd_req_is_ver1(or)) {
328 struct osdv1_attributes_list_header
*attr_list
= list
;
330 return attr_list
->type
== list_type
;
332 struct osdv2_attributes_list_header
*attr_list
= list
;
334 return attr_list
->type
== list_type
;
338 /* This is for List-objects not Attributes-Lists */
339 static void _osd_req_encode_olist(struct osd_request
*or,
340 struct osd_obj_id_list
*list
)
342 struct osd_cdb_head
*cdbh
= osd_cdb_head(&or->cdb
);
344 if (osd_req_is_ver1(or)) {
345 cdbh
->v1
.list_identifier
= list
->list_identifier
;
346 cdbh
->v1
.start_address
= list
->continuation_id
;
348 cdbh
->v2
.list_identifier
= list
->list_identifier
;
349 cdbh
->v2
.start_address
= list
->continuation_id
;
353 static osd_cdb_offset
osd_req_encode_offset(struct osd_request
*or,
354 u64 offset
, unsigned *padding
)
356 return __osd_encode_offset(offset
, padding
,
357 osd_req_is_ver1(or) ?
358 OSDv1_OFFSET_MIN_SHIFT
: OSD_OFFSET_MIN_SHIFT
,
359 OSD_OFFSET_MAX_SHIFT
);
362 static struct osd_security_parameters
*
363 _osd_req_sec_params(struct osd_request
*or)
365 struct osd_cdb
*ocdb
= &or->cdb
;
367 if (osd_req_is_ver1(or))
368 return (struct osd_security_parameters
*)&ocdb
->v1
.sec_params
;
370 return (struct osd_security_parameters
*)&ocdb
->v2
.sec_params
;
373 void osd_dev_init(struct osd_dev
*osdd
, struct scsi_device
*scsi_device
)
375 memset(osdd
, 0, sizeof(*osdd
));
376 osdd
->scsi_device
= scsi_device
;
377 osdd
->def_timeout
= BLK_DEFAULT_SG_TIMEOUT
;
378 #ifdef OSD_VER1_SUPPORT
379 osdd
->version
= OSD_VER2
;
381 /* TODO: Allocate pools for osd_request attributes ... */
383 EXPORT_SYMBOL(osd_dev_init
);
385 void osd_dev_fini(struct osd_dev
*osdd
)
387 /* TODO: De-allocate pools */
389 osdd
->scsi_device
= NULL
;
391 EXPORT_SYMBOL(osd_dev_fini
);
393 static struct osd_request
*_osd_request_alloc(gfp_t gfp
)
395 struct osd_request
*or;
397 /* TODO: Use mempool with one saved request */
398 or = kzalloc(sizeof(*or), gfp
);
402 static void _osd_request_free(struct osd_request
*or)
407 struct osd_request
*osd_start_request(struct osd_dev
*dev
, gfp_t gfp
)
409 struct osd_request
*or;
411 or = _osd_request_alloc(gfp
);
416 or->alloc_flags
= gfp
;
417 or->timeout
= dev
->def_timeout
;
418 or->retries
= OSD_REQ_RETRIES
;
422 EXPORT_SYMBOL(osd_start_request
);
424 static void _osd_free_seg(struct osd_request
*or __unused
,
425 struct _osd_req_data_segment
*seg
)
427 if (!seg
->buff
|| !seg
->alloc_size
)
435 static void _put_request(struct request
*rq
)
438 * If osd_finalize_request() was called but the request was not
439 * executed through the block layer, then we must release BIOs.
440 * TODO: Keep error code in or->async_error. Need to audit all
443 if (unlikely(rq
->bio
))
444 blk_end_request(rq
, -ENOMEM
, blk_rq_bytes(rq
));
449 void osd_end_request(struct osd_request
*or)
451 struct request
*rq
= or->request
;
453 _osd_free_seg(or, &or->set_attr
);
454 _osd_free_seg(or, &or->enc_get_attr
);
455 _osd_free_seg(or, &or->get_attr
);
459 _put_request(rq
->next_rq
);
465 _osd_request_free(or);
467 EXPORT_SYMBOL(osd_end_request
);
469 static void _set_error_resid(struct osd_request
*or, struct request
*req
,
472 or->async_error
= error
;
473 or->req_errors
= req
->errors
? : error
;
474 or->sense_len
= req
->sense_len
;
476 or->out
.residual
= or->out
.req
->resid_len
;
478 or->in
.residual
= or->in
.req
->resid_len
;
481 int osd_execute_request(struct osd_request
*or)
483 int error
= blk_execute_rq(or->request
->q
, NULL
, or->request
, 0);
485 _set_error_resid(or, or->request
, error
);
488 EXPORT_SYMBOL(osd_execute_request
);
490 static void osd_request_async_done(struct request
*req
, int error
)
492 struct osd_request
*or = req
->end_io_data
;
494 _set_error_resid(or, req
, error
);
496 __blk_put_request(req
->q
, req
->next_rq
);
500 __blk_put_request(req
->q
, req
);
506 or->async_done(or, or->async_private
);
511 int osd_execute_request_async(struct osd_request
*or,
512 osd_req_done_fn
*done
, void *private)
514 or->request
->end_io_data
= or;
515 or->async_private
= private;
516 or->async_done
= done
;
518 blk_execute_rq_nowait(or->request
->q
, NULL
, or->request
, 0,
519 osd_request_async_done
);
522 EXPORT_SYMBOL(osd_execute_request_async
);
524 u8 sg_out_pad_buffer
[1 << OSDv1_OFFSET_MIN_SHIFT
];
525 u8 sg_in_pad_buffer
[1 << OSDv1_OFFSET_MIN_SHIFT
];
527 static int _osd_realloc_seg(struct osd_request
*or,
528 struct _osd_req_data_segment
*seg
, unsigned max_bytes
)
532 if (seg
->alloc_size
>= max_bytes
)
535 buff
= krealloc(seg
->buff
, max_bytes
, or->alloc_flags
);
537 OSD_ERR("Failed to Realloc %d-bytes was-%d\n", max_bytes
,
542 memset(buff
+ seg
->alloc_size
, 0, max_bytes
- seg
->alloc_size
);
544 seg
->alloc_size
= max_bytes
;
548 static int _alloc_set_attr_list(struct osd_request
*or,
549 const struct osd_attr
*oa
, unsigned nelem
, unsigned add_bytes
)
551 unsigned total_bytes
= add_bytes
;
553 for (; nelem
; --nelem
, ++oa
)
554 total_bytes
+= _osd_req_alist_elem_size(or, oa
->len
);
556 OSD_DEBUG("total_bytes=%d\n", total_bytes
);
557 return _osd_realloc_seg(or, &or->set_attr
, total_bytes
);
560 static int _alloc_get_attr_desc(struct osd_request
*or, unsigned max_bytes
)
562 OSD_DEBUG("total_bytes=%d\n", max_bytes
);
563 return _osd_realloc_seg(or, &or->enc_get_attr
, max_bytes
);
566 static int _alloc_get_attr_list(struct osd_request
*or)
568 OSD_DEBUG("total_bytes=%d\n", or->get_attr
.total_bytes
);
569 return _osd_realloc_seg(or, &or->get_attr
, or->get_attr
.total_bytes
);
573 * Common to all OSD commands
576 static void _osdv1_req_encode_common(struct osd_request
*or,
577 __be16 act
, const struct osd_obj_id
*obj
, u64 offset
, u64 len
)
579 struct osdv1_cdb
*ocdb
= &or->cdb
.v1
;
582 * For speed, the commands
583 * OSD_ACT_PERFORM_SCSI_COMMAND , V1 0x8F7E, V2 0x8F7C
584 * OSD_ACT_SCSI_TASK_MANAGEMENT , V1 0x8F7F, V2 0x8F7D
585 * are not supported here. Should pass zero and set after the call
587 act
&= cpu_to_be16(~0x0080); /* V1 action code */
589 OSD_DEBUG("OSDv1 execute opcode 0x%x\n", be16_to_cpu(act
));
591 ocdb
->h
.varlen_cdb
.opcode
= VARIABLE_LENGTH_CMD
;
592 ocdb
->h
.varlen_cdb
.additional_cdb_length
= OSD_ADDITIONAL_CDB_LENGTH
;
593 ocdb
->h
.varlen_cdb
.service_action
= act
;
595 ocdb
->h
.partition
= cpu_to_be64(obj
->partition
);
596 ocdb
->h
.object
= cpu_to_be64(obj
->id
);
597 ocdb
->h
.v1
.length
= cpu_to_be64(len
);
598 ocdb
->h
.v1
.start_address
= cpu_to_be64(offset
);
601 static void _osdv2_req_encode_common(struct osd_request
*or,
602 __be16 act
, const struct osd_obj_id
*obj
, u64 offset
, u64 len
)
604 struct osdv2_cdb
*ocdb
= &or->cdb
.v2
;
606 OSD_DEBUG("OSDv2 execute opcode 0x%x\n", be16_to_cpu(act
));
608 ocdb
->h
.varlen_cdb
.opcode
= VARIABLE_LENGTH_CMD
;
609 ocdb
->h
.varlen_cdb
.additional_cdb_length
= OSD_ADDITIONAL_CDB_LENGTH
;
610 ocdb
->h
.varlen_cdb
.service_action
= act
;
612 ocdb
->h
.partition
= cpu_to_be64(obj
->partition
);
613 ocdb
->h
.object
= cpu_to_be64(obj
->id
);
614 ocdb
->h
.v2
.length
= cpu_to_be64(len
);
615 ocdb
->h
.v2
.start_address
= cpu_to_be64(offset
);
618 static void _osd_req_encode_common(struct osd_request
*or,
619 __be16 act
, const struct osd_obj_id
*obj
, u64 offset
, u64 len
)
621 if (osd_req_is_ver1(or))
622 _osdv1_req_encode_common(or, act
, obj
, offset
, len
);
624 _osdv2_req_encode_common(or, act
, obj
, offset
, len
);
630 /*TODO: void osd_req_set_master_seed_xchg(struct osd_request *, ...); */
631 /*TODO: void osd_req_set_master_key(struct osd_request *, ...); */
633 void osd_req_format(struct osd_request
*or, u64 tot_capacity
)
635 _osd_req_encode_common(or, OSD_ACT_FORMAT_OSD
, &osd_root_object
, 0,
638 EXPORT_SYMBOL(osd_req_format
);
640 int osd_req_list_dev_partitions(struct osd_request
*or,
641 osd_id initial_id
, struct osd_obj_id_list
*list
, unsigned nelem
)
643 return osd_req_list_partition_objects(or, 0, initial_id
, list
, nelem
);
645 EXPORT_SYMBOL(osd_req_list_dev_partitions
);
647 static void _osd_req_encode_flush(struct osd_request
*or,
648 enum osd_options_flush_scope_values op
)
650 struct osd_cdb_head
*ocdb
= osd_cdb_head(&or->cdb
);
652 ocdb
->command_specific_options
= op
;
655 void osd_req_flush_obsd(struct osd_request
*or,
656 enum osd_options_flush_scope_values op
)
658 _osd_req_encode_common(or, OSD_ACT_FLUSH_OSD
, &osd_root_object
, 0, 0);
659 _osd_req_encode_flush(or, op
);
661 EXPORT_SYMBOL(osd_req_flush_obsd
);
663 /*TODO: void osd_req_perform_scsi_command(struct osd_request *,
664 const u8 *cdb, ...); */
665 /*TODO: void osd_req_task_management(struct osd_request *, ...); */
670 static void _osd_req_encode_partition(struct osd_request
*or,
671 __be16 act
, osd_id partition
)
673 struct osd_obj_id par
= {
674 .partition
= partition
,
678 _osd_req_encode_common(or, act
, &par
, 0, 0);
681 void osd_req_create_partition(struct osd_request
*or, osd_id partition
)
683 _osd_req_encode_partition(or, OSD_ACT_CREATE_PARTITION
, partition
);
685 EXPORT_SYMBOL(osd_req_create_partition
);
687 void osd_req_remove_partition(struct osd_request
*or, osd_id partition
)
689 _osd_req_encode_partition(or, OSD_ACT_REMOVE_PARTITION
, partition
);
691 EXPORT_SYMBOL(osd_req_remove_partition
);
693 /*TODO: void osd_req_set_partition_key(struct osd_request *,
694 osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
695 u8 seed[OSD_CRYPTO_SEED_SIZE]); */
697 static int _osd_req_list_objects(struct osd_request
*or,
698 __be16 action
, const struct osd_obj_id
*obj
, osd_id initial_id
,
699 struct osd_obj_id_list
*list
, unsigned nelem
)
701 struct request_queue
*q
= osd_request_queue(or->osd_dev
);
702 u64 len
= nelem
* sizeof(osd_id
) + sizeof(*list
);
705 _osd_req_encode_common(or, action
, obj
, (u64
)initial_id
, len
);
707 if (list
->list_identifier
)
708 _osd_req_encode_olist(or, list
);
711 bio
= bio_map_kern(q
, list
, len
, or->alloc_flags
);
713 OSD_ERR("!!! Failed to allocate list_objects BIO\n");
717 bio
->bi_rw
&= ~(1 << BIO_RW
);
719 or->in
.total_bytes
= bio
->bi_size
;
723 int osd_req_list_partition_collections(struct osd_request
*or,
724 osd_id partition
, osd_id initial_id
, struct osd_obj_id_list
*list
,
727 struct osd_obj_id par
= {
728 .partition
= partition
,
732 return osd_req_list_collection_objects(or, &par
, initial_id
, list
,
735 EXPORT_SYMBOL(osd_req_list_partition_collections
);
737 int osd_req_list_partition_objects(struct osd_request
*or,
738 osd_id partition
, osd_id initial_id
, struct osd_obj_id_list
*list
,
741 struct osd_obj_id par
= {
742 .partition
= partition
,
746 return _osd_req_list_objects(or, OSD_ACT_LIST
, &par
, initial_id
, list
,
749 EXPORT_SYMBOL(osd_req_list_partition_objects
);
751 void osd_req_flush_partition(struct osd_request
*or,
752 osd_id partition
, enum osd_options_flush_scope_values op
)
754 _osd_req_encode_partition(or, OSD_ACT_FLUSH_PARTITION
, partition
);
755 _osd_req_encode_flush(or, op
);
757 EXPORT_SYMBOL(osd_req_flush_partition
);
760 * Collection commands
762 /*TODO: void osd_req_create_collection(struct osd_request *,
763 const struct osd_obj_id *); */
764 /*TODO: void osd_req_remove_collection(struct osd_request *,
765 const struct osd_obj_id *); */
767 int osd_req_list_collection_objects(struct osd_request
*or,
768 const struct osd_obj_id
*obj
, osd_id initial_id
,
769 struct osd_obj_id_list
*list
, unsigned nelem
)
771 return _osd_req_list_objects(or, OSD_ACT_LIST_COLLECTION
, obj
,
772 initial_id
, list
, nelem
);
774 EXPORT_SYMBOL(osd_req_list_collection_objects
);
776 /*TODO: void query(struct osd_request *, ...); V2 */
778 void osd_req_flush_collection(struct osd_request
*or,
779 const struct osd_obj_id
*obj
, enum osd_options_flush_scope_values op
)
781 _osd_req_encode_common(or, OSD_ACT_FLUSH_PARTITION
, obj
, 0, 0);
782 _osd_req_encode_flush(or, op
);
784 EXPORT_SYMBOL(osd_req_flush_collection
);
786 /*TODO: void get_member_attrs(struct osd_request *, ...); V2 */
787 /*TODO: void set_member_attrs(struct osd_request *, ...); V2 */
792 void osd_req_create_object(struct osd_request
*or, struct osd_obj_id
*obj
)
794 _osd_req_encode_common(or, OSD_ACT_CREATE
, obj
, 0, 0);
796 EXPORT_SYMBOL(osd_req_create_object
);
798 void osd_req_remove_object(struct osd_request
*or, struct osd_obj_id
*obj
)
800 _osd_req_encode_common(or, OSD_ACT_REMOVE
, obj
, 0, 0);
802 EXPORT_SYMBOL(osd_req_remove_object
);
805 /*TODO: void osd_req_create_multi(struct osd_request *or,
806 struct osd_obj_id *first, struct osd_obj_id_list *list, unsigned nelem);
809 void osd_req_write(struct osd_request
*or,
810 const struct osd_obj_id
*obj
, u64 offset
,
811 struct bio
*bio
, u64 len
)
813 _osd_req_encode_common(or, OSD_ACT_WRITE
, obj
, offset
, len
);
814 WARN_ON(or->out
.bio
|| or->out
.total_bytes
);
815 WARN_ON(0 == bio_rw_flagged(bio
, BIO_RW
));
817 or->out
.total_bytes
= len
;
819 EXPORT_SYMBOL(osd_req_write
);
821 int osd_req_write_kern(struct osd_request
*or,
822 const struct osd_obj_id
*obj
, u64 offset
, void* buff
, u64 len
)
824 struct request_queue
*req_q
= osd_request_queue(or->osd_dev
);
825 struct bio
*bio
= bio_map_kern(req_q
, buff
, len
, GFP_KERNEL
);
830 bio
->bi_rw
|= (1 << BIO_RW
); /* FIXME: bio_set_dir() */
831 osd_req_write(or, obj
, offset
, bio
, len
);
834 EXPORT_SYMBOL(osd_req_write_kern
);
836 /*TODO: void osd_req_append(struct osd_request *,
837 const struct osd_obj_id *, struct bio *data_out); */
838 /*TODO: void osd_req_create_write(struct osd_request *,
839 const struct osd_obj_id *, struct bio *data_out, u64 offset); */
840 /*TODO: void osd_req_clear(struct osd_request *,
841 const struct osd_obj_id *, u64 offset, u64 len); */
842 /*TODO: void osd_req_punch(struct osd_request *,
843 const struct osd_obj_id *, u64 offset, u64 len); V2 */
845 void osd_req_flush_object(struct osd_request
*or,
846 const struct osd_obj_id
*obj
, enum osd_options_flush_scope_values op
,
847 /*V2*/ u64 offset
, /*V2*/ u64 len
)
849 if (unlikely(osd_req_is_ver1(or) && (offset
|| len
))) {
850 OSD_DEBUG("OSD Ver1 flush on specific range ignored\n");
855 _osd_req_encode_common(or, OSD_ACT_FLUSH
, obj
, offset
, len
);
856 _osd_req_encode_flush(or, op
);
858 EXPORT_SYMBOL(osd_req_flush_object
);
860 void osd_req_read(struct osd_request
*or,
861 const struct osd_obj_id
*obj
, u64 offset
,
862 struct bio
*bio
, u64 len
)
864 _osd_req_encode_common(or, OSD_ACT_READ
, obj
, offset
, len
);
865 WARN_ON(or->in
.bio
|| or->in
.total_bytes
);
866 WARN_ON(1 == bio_rw_flagged(bio
, BIO_RW
));
868 or->in
.total_bytes
= len
;
870 EXPORT_SYMBOL(osd_req_read
);
872 int osd_req_read_kern(struct osd_request
*or,
873 const struct osd_obj_id
*obj
, u64 offset
, void* buff
, u64 len
)
875 struct request_queue
*req_q
= osd_request_queue(or->osd_dev
);
876 struct bio
*bio
= bio_map_kern(req_q
, buff
, len
, GFP_KERNEL
);
881 osd_req_read(or, obj
, offset
, bio
, len
);
884 EXPORT_SYMBOL(osd_req_read_kern
);
886 void osd_req_get_attributes(struct osd_request
*or,
887 const struct osd_obj_id
*obj
)
889 _osd_req_encode_common(or, OSD_ACT_GET_ATTRIBUTES
, obj
, 0, 0);
891 EXPORT_SYMBOL(osd_req_get_attributes
);
893 void osd_req_set_attributes(struct osd_request
*or,
894 const struct osd_obj_id
*obj
)
896 _osd_req_encode_common(or, OSD_ACT_SET_ATTRIBUTES
, obj
, 0, 0);
898 EXPORT_SYMBOL(osd_req_set_attributes
);
901 * Attributes List-mode
904 int osd_req_add_set_attr_list(struct osd_request
*or,
905 const struct osd_attr
*oa
, unsigned nelem
)
907 unsigned total_bytes
= or->set_attr
.total_bytes
;
911 if (or->attributes_mode
&&
912 or->attributes_mode
!= OSD_CDB_GET_SET_ATTR_LISTS
) {
916 or->attributes_mode
= OSD_CDB_GET_SET_ATTR_LISTS
;
918 if (!total_bytes
) { /* first-time: allocate and put list header */
919 total_bytes
= _osd_req_sizeof_alist_header(or);
920 ret
= _alloc_set_attr_list(or, oa
, nelem
, total_bytes
);
923 _osd_req_set_alist_type(or, or->set_attr
.buff
,
924 OSD_ATTR_LIST_SET_RETRIEVE
);
926 attr_last
= or->set_attr
.buff
+ total_bytes
;
928 for (; nelem
; --nelem
) {
929 unsigned elem_size
= _osd_req_alist_elem_size(or, oa
->len
);
931 total_bytes
+= elem_size
;
932 if (unlikely(or->set_attr
.alloc_size
< total_bytes
)) {
933 or->set_attr
.total_bytes
= total_bytes
- elem_size
;
934 ret
= _alloc_set_attr_list(or, oa
, nelem
, total_bytes
);
938 or->set_attr
.buff
+ or->set_attr
.total_bytes
;
941 _osd_req_alist_elem_encode(or, attr_last
, oa
);
943 attr_last
+= elem_size
;
947 or->set_attr
.total_bytes
= total_bytes
;
950 EXPORT_SYMBOL(osd_req_add_set_attr_list
);
952 static int _req_append_segment(struct osd_request
*or,
953 unsigned padding
, struct _osd_req_data_segment
*seg
,
954 struct _osd_req_data_segment
*last_seg
, struct _osd_io_info
*io
)
960 /* check if we can just add it to last buffer */
962 (padding
<= last_seg
->alloc_size
- last_seg
->total_bytes
))
963 pad_buff
= last_seg
->buff
+ last_seg
->total_bytes
;
965 pad_buff
= io
->pad_buff
;
967 ret
= blk_rq_map_kern(io
->req
->q
, io
->req
, pad_buff
, padding
,
971 io
->total_bytes
+= padding
;
974 ret
= blk_rq_map_kern(io
->req
->q
, io
->req
, seg
->buff
, seg
->total_bytes
,
979 io
->total_bytes
+= seg
->total_bytes
;
980 OSD_DEBUG("padding=%d buff=%p total_bytes=%d\n", padding
, seg
->buff
,
985 static int _osd_req_finalize_set_attr_list(struct osd_request
*or)
987 struct osd_cdb_head
*cdbh
= osd_cdb_head(&or->cdb
);
991 if (!or->set_attr
.total_bytes
) {
992 cdbh
->attrs_list
.set_attr_offset
= OSD_OFFSET_UNUSED
;
996 cdbh
->attrs_list
.set_attr_bytes
= cpu_to_be32(or->set_attr
.total_bytes
);
997 cdbh
->attrs_list
.set_attr_offset
=
998 osd_req_encode_offset(or, or->out
.total_bytes
, &padding
);
1000 ret
= _req_append_segment(or, padding
, &or->set_attr
,
1001 or->out
.last_seg
, &or->out
);
1005 or->out
.last_seg
= &or->set_attr
;
1009 int osd_req_add_get_attr_list(struct osd_request
*or,
1010 const struct osd_attr
*oa
, unsigned nelem
)
1012 unsigned total_bytes
= or->enc_get_attr
.total_bytes
;
1016 if (or->attributes_mode
&&
1017 or->attributes_mode
!= OSD_CDB_GET_SET_ATTR_LISTS
) {
1021 or->attributes_mode
= OSD_CDB_GET_SET_ATTR_LISTS
;
1023 /* first time calc data-in list header size */
1024 if (!or->get_attr
.total_bytes
)
1025 or->get_attr
.total_bytes
= _osd_req_sizeof_alist_header(or);
1027 /* calc data-out info */
1028 if (!total_bytes
) { /* first-time: allocate and put list header */
1031 total_bytes
= _osd_req_sizeof_alist_header(or);
1032 max_bytes
= total_bytes
+
1033 nelem
* sizeof(struct osd_attributes_list_attrid
);
1034 ret
= _alloc_get_attr_desc(or, max_bytes
);
1038 _osd_req_set_alist_type(or, or->enc_get_attr
.buff
,
1041 attr_last
= or->enc_get_attr
.buff
+ total_bytes
;
1043 for (; nelem
; --nelem
) {
1044 struct osd_attributes_list_attrid
*attrid
;
1045 const unsigned cur_size
= sizeof(*attrid
);
1047 total_bytes
+= cur_size
;
1048 if (unlikely(or->enc_get_attr
.alloc_size
< total_bytes
)) {
1049 or->enc_get_attr
.total_bytes
= total_bytes
- cur_size
;
1050 ret
= _alloc_get_attr_desc(or,
1051 total_bytes
+ nelem
* sizeof(*attrid
));
1054 attr_last
= or->enc_get_attr
.buff
+
1055 or->enc_get_attr
.total_bytes
;
1059 attrid
->attr_page
= cpu_to_be32(oa
->attr_page
);
1060 attrid
->attr_id
= cpu_to_be32(oa
->attr_id
);
1062 attr_last
+= cur_size
;
1064 /* calc data-in size */
1065 or->get_attr
.total_bytes
+=
1066 _osd_req_alist_elem_size(or, oa
->len
);
1070 or->enc_get_attr
.total_bytes
= total_bytes
;
1073 "get_attr.total_bytes=%u(%u) enc_get_attr.total_bytes=%u(%Zu)\n",
1074 or->get_attr
.total_bytes
,
1075 or->get_attr
.total_bytes
- _osd_req_sizeof_alist_header(or),
1076 or->enc_get_attr
.total_bytes
,
1077 (or->enc_get_attr
.total_bytes
- _osd_req_sizeof_alist_header(or))
1078 / sizeof(struct osd_attributes_list_attrid
));
1082 EXPORT_SYMBOL(osd_req_add_get_attr_list
);
1084 static int _osd_req_finalize_get_attr_list(struct osd_request
*or)
1086 struct osd_cdb_head
*cdbh
= osd_cdb_head(&or->cdb
);
1087 unsigned out_padding
;
1088 unsigned in_padding
;
1091 if (!or->enc_get_attr
.total_bytes
) {
1092 cdbh
->attrs_list
.get_attr_desc_offset
= OSD_OFFSET_UNUSED
;
1093 cdbh
->attrs_list
.get_attr_offset
= OSD_OFFSET_UNUSED
;
1097 ret
= _alloc_get_attr_list(or);
1101 /* The out-going buffer info update */
1102 OSD_DEBUG("out-going\n");
1103 cdbh
->attrs_list
.get_attr_desc_bytes
=
1104 cpu_to_be32(or->enc_get_attr
.total_bytes
);
1106 cdbh
->attrs_list
.get_attr_desc_offset
=
1107 osd_req_encode_offset(or, or->out
.total_bytes
, &out_padding
);
1109 ret
= _req_append_segment(or, out_padding
, &or->enc_get_attr
,
1110 or->out
.last_seg
, &or->out
);
1113 or->out
.last_seg
= &or->enc_get_attr
;
1115 /* The incoming buffer info update */
1116 OSD_DEBUG("in-coming\n");
1117 cdbh
->attrs_list
.get_attr_alloc_length
=
1118 cpu_to_be32(or->get_attr
.total_bytes
);
1120 cdbh
->attrs_list
.get_attr_offset
=
1121 osd_req_encode_offset(or, or->in
.total_bytes
, &in_padding
);
1123 ret
= _req_append_segment(or, in_padding
, &or->get_attr
, NULL
,
1127 or->in
.last_seg
= &or->get_attr
;
1132 int osd_req_decode_get_attr_list(struct osd_request
*or,
1133 struct osd_attr
*oa
, int *nelem
, void **iterator
)
1135 unsigned cur_bytes
, returned_bytes
;
1137 const unsigned sizeof_attr_list
= _osd_req_sizeof_alist_header(or);
1140 if (!_osd_req_is_alist_type(or, or->get_attr
.buff
,
1141 OSD_ATTR_LIST_SET_RETRIEVE
)) {
1151 BUG_ON((*iterator
< or->get_attr
.buff
) ||
1152 (or->get_attr
.buff
+ or->get_attr
.alloc_size
< *iterator
));
1154 cur_bytes
= (*iterator
- or->get_attr
.buff
) - sizeof_attr_list
;
1155 returned_bytes
= or->get_attr
.total_bytes
;
1156 } else { /* first time decode the list header */
1157 cur_bytes
= sizeof_attr_list
;
1158 returned_bytes
= _osd_req_alist_size(or, or->get_attr
.buff
) +
1161 cur_p
= or->get_attr
.buff
+ sizeof_attr_list
;
1163 if (returned_bytes
> or->get_attr
.alloc_size
) {
1164 OSD_DEBUG("target report: space was not big enough! "
1165 "Allocate=%u Needed=%u\n",
1166 or->get_attr
.alloc_size
,
1167 returned_bytes
+ sizeof_attr_list
);
1170 or->get_attr
.alloc_size
- sizeof_attr_list
;
1172 or->get_attr
.total_bytes
= returned_bytes
;
1175 for (n
= 0; (n
< *nelem
) && (cur_bytes
< returned_bytes
); ++n
) {
1176 int inc
= _osd_req_alist_elem_decode(or, cur_p
, oa
,
1177 returned_bytes
- cur_bytes
);
1180 OSD_ERR("BAD FOOD from target. list not valid!"
1182 cur_bytes
, returned_bytes
, n
);
1184 cur_bytes
= returned_bytes
; /* break the caller loop */
1193 *iterator
= (returned_bytes
- cur_bytes
) ? cur_p
: NULL
;
1195 return returned_bytes
- cur_bytes
;
1197 EXPORT_SYMBOL(osd_req_decode_get_attr_list
);
1200 * Attributes Page-mode
1203 int osd_req_add_get_attr_page(struct osd_request
*or,
1204 u32 page_id
, void *attar_page
, unsigned max_page_len
,
1205 const struct osd_attr
*set_one_attr
)
1207 struct osd_cdb_head
*cdbh
= osd_cdb_head(&or->cdb
);
1209 if (or->attributes_mode
&&
1210 or->attributes_mode
!= OSD_CDB_GET_ATTR_PAGE_SET_ONE
) {
1214 or->attributes_mode
= OSD_CDB_GET_ATTR_PAGE_SET_ONE
;
1216 or->get_attr
.buff
= attar_page
;
1217 or->get_attr
.total_bytes
= max_page_len
;
1219 or->set_attr
.buff
= set_one_attr
->val_ptr
;
1220 or->set_attr
.total_bytes
= set_one_attr
->len
;
1222 cdbh
->attrs_page
.get_attr_page
= cpu_to_be32(page_id
);
1223 cdbh
->attrs_page
.get_attr_alloc_length
= cpu_to_be32(max_page_len
);
1224 /* ocdb->attrs_page.get_attr_offset; */
1226 cdbh
->attrs_page
.set_attr_page
= cpu_to_be32(set_one_attr
->attr_page
);
1227 cdbh
->attrs_page
.set_attr_id
= cpu_to_be32(set_one_attr
->attr_id
);
1228 cdbh
->attrs_page
.set_attr_length
= cpu_to_be32(set_one_attr
->len
);
1229 /* ocdb->attrs_page.set_attr_offset; */
1232 EXPORT_SYMBOL(osd_req_add_get_attr_page
);
1234 static int _osd_req_finalize_attr_page(struct osd_request
*or)
1236 struct osd_cdb_head
*cdbh
= osd_cdb_head(&or->cdb
);
1237 unsigned in_padding
, out_padding
;
1241 cdbh
->attrs_page
.get_attr_offset
=
1242 osd_req_encode_offset(or, or->in
.total_bytes
, &in_padding
);
1244 ret
= _req_append_segment(or, in_padding
, &or->get_attr
, NULL
,
1250 cdbh
->attrs_page
.set_attr_offset
=
1251 osd_req_encode_offset(or, or->out
.total_bytes
, &out_padding
);
1253 ret
= _req_append_segment(or, out_padding
, &or->enc_get_attr
, NULL
,
1258 static inline void osd_sec_parms_set_out_offset(bool is_v1
,
1259 struct osd_security_parameters
*sec_parms
, osd_cdb_offset offset
)
1262 sec_parms
->v1
.data_out_integrity_check_offset
= offset
;
1264 sec_parms
->v2
.data_out_integrity_check_offset
= offset
;
1267 static inline void osd_sec_parms_set_in_offset(bool is_v1
,
1268 struct osd_security_parameters
*sec_parms
, osd_cdb_offset offset
)
1271 sec_parms
->v1
.data_in_integrity_check_offset
= offset
;
1273 sec_parms
->v2
.data_in_integrity_check_offset
= offset
;
1276 static int _osd_req_finalize_data_integrity(struct osd_request
*or,
1277 bool has_in
, bool has_out
, u64 out_data_bytes
, const u8
*cap_key
)
1279 struct osd_security_parameters
*sec_parms
= _osd_req_sec_params(or);
1282 if (!osd_is_sec_alldata(sec_parms
))
1286 struct _osd_req_data_segment seg
= {
1287 .buff
= &or->out_data_integ
,
1288 .total_bytes
= sizeof(or->out_data_integ
),
1292 or->out_data_integ
.data_bytes
= cpu_to_be64(out_data_bytes
);
1293 or->out_data_integ
.set_attributes_bytes
= cpu_to_be64(
1294 or->set_attr
.total_bytes
);
1295 or->out_data_integ
.get_attributes_bytes
= cpu_to_be64(
1296 or->enc_get_attr
.total_bytes
);
1298 osd_sec_parms_set_out_offset(osd_req_is_ver1(or), sec_parms
,
1299 osd_req_encode_offset(or, or->out
.total_bytes
, &pad
));
1301 ret
= _req_append_segment(or, pad
, &seg
, or->out
.last_seg
,
1305 or->out
.last_seg
= NULL
;
1307 /* they are now all chained to request sign them all together */
1308 osd_sec_sign_data(&or->out_data_integ
, or->out
.req
->bio
,
1313 struct _osd_req_data_segment seg
= {
1314 .buff
= &or->in_data_integ
,
1315 .total_bytes
= sizeof(or->in_data_integ
),
1319 osd_sec_parms_set_in_offset(osd_req_is_ver1(or), sec_parms
,
1320 osd_req_encode_offset(or, or->in
.total_bytes
, &pad
));
1322 ret
= _req_append_segment(or, pad
, &seg
, or->in
.last_seg
,
1327 or->in
.last_seg
= NULL
;
1334 * osd_finalize_request and helpers
1336 static struct request
*_make_request(struct request_queue
*q
, bool has_write
,
1337 struct _osd_io_info
*oii
, gfp_t flags
)
1340 return blk_make_request(q
, oii
->bio
, flags
);
1342 struct request
*req
;
1344 req
= blk_get_request(q
, has_write
? WRITE
: READ
, flags
);
1346 return ERR_PTR(-ENOMEM
);
1352 static int _init_blk_request(struct osd_request
*or,
1353 bool has_in
, bool has_out
)
1355 gfp_t flags
= or->alloc_flags
;
1356 struct scsi_device
*scsi_device
= or->osd_dev
->scsi_device
;
1357 struct request_queue
*q
= scsi_device
->request_queue
;
1358 struct request
*req
;
1361 req
= _make_request(q
, has_out
, has_out
? &or->out
: &or->in
, flags
);
1368 req
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1369 req
->cmd_flags
|= REQ_QUIET
;
1371 req
->timeout
= or->timeout
;
1372 req
->retries
= or->retries
;
1373 req
->sense
= or->sense
;
1379 /* allocate bidi request */
1380 req
= _make_request(q
, false, &or->in
, flags
);
1382 OSD_DEBUG("blk_get_request for bidi failed\n");
1386 req
->cmd_type
= REQ_TYPE_BLOCK_PC
;
1387 or->in
.req
= or->request
->next_rq
= req
;
1394 OSD_DEBUG("or=%p has_in=%d has_out=%d => %d, %p\n",
1395 or, has_in
, has_out
, ret
, or->request
);
1399 int osd_finalize_request(struct osd_request
*or,
1400 u8 options
, const void *cap
, const u8
*cap_key
)
1402 struct osd_cdb_head
*cdbh
= osd_cdb_head(&or->cdb
);
1403 bool has_in
, has_out
;
1404 u64 out_data_bytes
= or->out
.total_bytes
;
1407 if (options
& OSD_REQ_FUA
)
1408 cdbh
->options
|= OSD_CDB_FUA
;
1410 if (options
& OSD_REQ_DPO
)
1411 cdbh
->options
|= OSD_CDB_DPO
;
1413 if (options
& OSD_REQ_BYPASS_TIMESTAMPS
)
1414 cdbh
->timestamp_control
= OSD_CDB_BYPASS_TIMESTAMPS
;
1416 osd_set_caps(&or->cdb
, cap
);
1418 has_in
= or->in
.bio
|| or->get_attr
.total_bytes
;
1419 has_out
= or->out
.bio
|| or->set_attr
.total_bytes
||
1420 or->enc_get_attr
.total_bytes
;
1422 ret
= _init_blk_request(or, has_in
, has_out
);
1424 OSD_DEBUG("_init_blk_request failed\n");
1428 or->out
.pad_buff
= sg_out_pad_buffer
;
1429 or->in
.pad_buff
= sg_in_pad_buffer
;
1431 if (!or->attributes_mode
)
1432 or->attributes_mode
= OSD_CDB_GET_SET_ATTR_LISTS
;
1433 cdbh
->command_specific_options
|= or->attributes_mode
;
1434 if (or->attributes_mode
== OSD_CDB_GET_ATTR_PAGE_SET_ONE
) {
1435 ret
= _osd_req_finalize_attr_page(or);
1437 /* TODO: I think that for the GET_ATTR command these 2 should
1438 * be reversed to keep them in execution order (for embeded
1439 * targets with low memory footprint)
1441 ret
= _osd_req_finalize_set_attr_list(or);
1443 OSD_DEBUG("_osd_req_finalize_set_attr_list failed\n");
1447 ret
= _osd_req_finalize_get_attr_list(or);
1449 OSD_DEBUG("_osd_req_finalize_get_attr_list failed\n");
1454 ret
= _osd_req_finalize_data_integrity(or, has_in
, has_out
,
1455 out_data_bytes
, cap_key
);
1459 osd_sec_sign_cdb(&or->cdb
, cap_key
);
1461 or->request
->cmd
= or->cdb
.buff
;
1462 or->request
->cmd_len
= _osd_req_cdb_len(or);
1466 EXPORT_SYMBOL(osd_finalize_request
);
1468 static bool _is_osd_security_code(int code
)
1470 return (code
== osd_security_audit_value_frozen
) ||
1471 (code
== osd_security_working_key_frozen
) ||
1472 (code
== osd_nonce_not_unique
) ||
1473 (code
== osd_nonce_timestamp_out_of_range
) ||
1474 (code
== osd_invalid_dataout_buffer_integrity_check_value
);
1477 #define OSD_SENSE_PRINT1(fmt, a...) \
1479 if (__cur_sense_need_output) \
1480 OSD_ERR(fmt, ##a); \
1483 #define OSD_SENSE_PRINT2(fmt, a...) OSD_SENSE_PRINT1(" " fmt, ##a)
1485 int osd_req_decode_sense_full(struct osd_request
*or,
1486 struct osd_sense_info
*osi
, bool silent
,
1487 struct osd_obj_id
*bad_obj_list __unused
, int max_obj __unused
,
1488 struct osd_attr
*bad_attr_list
, int max_attr
)
1490 int sense_len
, original_sense_len
;
1491 struct osd_sense_info local_osi
;
1492 struct scsi_sense_descriptor_based
*ssdb
;
1493 void *cur_descriptor
;
1494 #if (CONFIG_SCSI_OSD_DPRINT_SENSE == 0)
1495 const bool __cur_sense_need_output
= false;
1497 bool __cur_sense_need_output
= !silent
;
1501 if (likely(!or->req_errors
))
1504 osi
= osi
? : &local_osi
;
1505 memset(osi
, 0, sizeof(*osi
));
1507 ssdb
= (typeof(ssdb
))or->sense
;
1508 sense_len
= or->sense_len
;
1509 if ((sense_len
< (int)sizeof(*ssdb
) || !ssdb
->sense_key
)) {
1510 OSD_ERR("Block-layer returned error(0x%x) but "
1511 "sense_len(%u) || key(%d) is empty\n",
1512 or->req_errors
, sense_len
, ssdb
->sense_key
);
1516 if ((ssdb
->response_code
!= 0x72) && (ssdb
->response_code
!= 0x73)) {
1517 OSD_ERR("Unrecognized scsi sense: rcode=%x length=%d\n",
1518 ssdb
->response_code
, sense_len
);
1522 osi
->key
= ssdb
->sense_key
;
1523 osi
->additional_code
= be16_to_cpu(ssdb
->additional_sense_code
);
1524 original_sense_len
= ssdb
->additional_sense_length
+ 8;
1526 #if (CONFIG_SCSI_OSD_DPRINT_SENSE == 1)
1527 if (__cur_sense_need_output
)
1528 __cur_sense_need_output
= (osi
->key
> scsi_sk_recovered_error
);
1530 OSD_SENSE_PRINT1("Main Sense information key=0x%x length(%d, %d) "
1531 "additional_code=0x%x async_error=%d errors=0x%x\n",
1532 osi
->key
, original_sense_len
, sense_len
,
1533 osi
->additional_code
, or->async_error
,
1536 if (original_sense_len
< sense_len
)
1537 sense_len
= original_sense_len
;
1539 cur_descriptor
= ssdb
->ssd
;
1540 sense_len
-= sizeof(*ssdb
);
1541 while (sense_len
> 0) {
1542 struct scsi_sense_descriptor
*ssd
= cur_descriptor
;
1543 int cur_len
= ssd
->additional_length
+ 2;
1545 sense_len
-= cur_len
;
1548 break; /* sense was truncated */
1550 switch (ssd
->descriptor_type
) {
1551 case scsi_sense_information
:
1552 case scsi_sense_command_specific_information
:
1554 struct scsi_sense_command_specific_data_descriptor
1555 *sscd
= cur_descriptor
;
1558 get_unaligned_be64(&sscd
->information
) ;
1560 "command_specific_information 0x%llx \n",
1561 _LLU(osi
->command_info
));
1564 case scsi_sense_key_specific
:
1566 struct scsi_sense_key_specific_data_descriptor
1567 *ssks
= cur_descriptor
;
1569 osi
->sense_info
= get_unaligned_be16(&ssks
->value
);
1571 "sense_key_specific_information %u"
1572 "sksv_cd_bpv_bp (0x%x)\n",
1573 osi
->sense_info
, ssks
->sksv_cd_bpv_bp
);
1576 case osd_sense_object_identification
:
1577 { /*FIXME: Keep first not last, Store in array*/
1578 struct osd_sense_identification_data_descriptor
1579 *osidd
= cur_descriptor
;
1581 osi
->not_initiated_command_functions
=
1582 le32_to_cpu(osidd
->not_initiated_functions
);
1583 osi
->completed_command_functions
=
1584 le32_to_cpu(osidd
->completed_functions
);
1585 osi
->obj
.partition
= be64_to_cpu(osidd
->partition_id
);
1586 osi
->obj
.id
= be64_to_cpu(osidd
->object_id
);
1588 "object_identification pid=0x%llx oid=0x%llx\n",
1589 _LLU(osi
->obj
.partition
), _LLU(osi
->obj
.id
));
1591 "not_initiated_bits(%x) "
1592 "completed_command_bits(%x)\n",
1593 osi
->not_initiated_command_functions
,
1594 osi
->completed_command_functions
);
1597 case osd_sense_response_integrity_check
:
1599 struct osd_sense_response_integrity_check_descriptor
1600 *osricd
= cur_descriptor
;
1601 const unsigned len
=
1602 sizeof(osricd
->integrity_check_value
);
1603 char key_dump
[len
*4 + 2]; /* 2nibbles+space+ASCII */
1605 hex_dump_to_buffer(osricd
->integrity_check_value
, len
,
1606 32, 1, key_dump
, sizeof(key_dump
), true);
1607 OSD_SENSE_PRINT2("response_integrity [%s]\n", key_dump
);
1609 case osd_sense_attribute_identification
:
1611 struct osd_sense_attributes_data_descriptor
1612 *osadd
= cur_descriptor
;
1613 unsigned len
= min(cur_len
, sense_len
);
1614 struct osd_sense_attr
*pattr
= osadd
->sense_attrs
;
1616 while (len
>= sizeof(*pattr
)) {
1617 u32 attr_page
= be32_to_cpu(pattr
->attr_page
);
1618 u32 attr_id
= be32_to_cpu(pattr
->attr_id
);
1620 if (!osi
->attr
.attr_page
) {
1621 osi
->attr
.attr_page
= attr_page
;
1622 osi
->attr
.attr_id
= attr_id
;
1625 if (bad_attr_list
&& max_attr
) {
1626 bad_attr_list
->attr_page
= attr_page
;
1627 bad_attr_list
->attr_id
= attr_id
;
1632 len
-= sizeof(*pattr
);
1634 "osd_sense_attribute_identification"
1635 "attr_page=0x%x attr_id=0x%x\n",
1636 attr_page
, attr_id
);
1639 /*These are not legal for OSD*/
1640 case scsi_sense_field_replaceable_unit
:
1641 OSD_SENSE_PRINT2("scsi_sense_field_replaceable_unit\n");
1643 case scsi_sense_stream_commands
:
1644 OSD_SENSE_PRINT2("scsi_sense_stream_commands\n");
1646 case scsi_sense_block_commands
:
1647 OSD_SENSE_PRINT2("scsi_sense_block_commands\n");
1649 case scsi_sense_ata_return
:
1650 OSD_SENSE_PRINT2("scsi_sense_ata_return\n");
1653 if (ssd
->descriptor_type
<= scsi_sense_Reserved_last
)
1655 "scsi_sense Reserved descriptor (0x%x)",
1656 ssd
->descriptor_type
);
1659 "scsi_sense Vendor descriptor (0x%x)",
1660 ssd
->descriptor_type
);
1663 cur_descriptor
+= cur_len
;
1668 /* scsi sense is Empty, the request was never issued to target
1669 * linux return code might tell us what happened.
1671 if (or->async_error
== -ENOMEM
)
1672 osi
->osd_err_pri
= OSD_ERR_PRI_RESOURCE
;
1674 osi
->osd_err_pri
= OSD_ERR_PRI_UNREACHABLE
;
1675 ret
= or->async_error
;
1676 } else if (osi
->key
<= scsi_sk_recovered_error
) {
1677 osi
->osd_err_pri
= 0;
1679 } else if (osi
->additional_code
== scsi_invalid_field_in_cdb
) {
1680 if (osi
->cdb_field_offset
== OSD_CFO_STARTING_BYTE
) {
1681 osi
->osd_err_pri
= OSD_ERR_PRI_CLEAR_PAGES
;
1682 ret
= -EFAULT
; /* caller should recover from this */
1683 } else if (osi
->cdb_field_offset
== OSD_CFO_OBJECT_ID
) {
1684 osi
->osd_err_pri
= OSD_ERR_PRI_NOT_FOUND
;
1686 } else if (osi
->cdb_field_offset
== OSD_CFO_PERMISSIONS
) {
1687 osi
->osd_err_pri
= OSD_ERR_PRI_NO_ACCESS
;
1690 osi
->osd_err_pri
= OSD_ERR_PRI_BAD_CRED
;
1693 } else if (osi
->additional_code
== osd_quota_error
) {
1694 osi
->osd_err_pri
= OSD_ERR_PRI_NO_SPACE
;
1696 } else if (_is_osd_security_code(osi
->additional_code
)) {
1697 osi
->osd_err_pri
= OSD_ERR_PRI_BAD_CRED
;
1700 osi
->osd_err_pri
= OSD_ERR_PRI_EIO
;
1704 if (!or->out
.residual
)
1705 or->out
.residual
= or->out
.total_bytes
;
1706 if (!or->in
.residual
)
1707 or->in
.residual
= or->in
.total_bytes
;
1711 EXPORT_SYMBOL(osd_req_decode_sense_full
);
1714 * Implementation of osd_sec.h API
1715 * TODO: Move to a separate osd_sec.c file at a later stage.
1718 enum { OSD_SEC_CAP_V1_ALL_CAPS
=
1719 OSD_SEC_CAP_APPEND
| OSD_SEC_CAP_OBJ_MGMT
| OSD_SEC_CAP_REMOVE
|
1720 OSD_SEC_CAP_CREATE
| OSD_SEC_CAP_SET_ATTR
| OSD_SEC_CAP_GET_ATTR
|
1721 OSD_SEC_CAP_WRITE
| OSD_SEC_CAP_READ
| OSD_SEC_CAP_POL_SEC
|
1722 OSD_SEC_CAP_GLOBAL
| OSD_SEC_CAP_DEV_MGMT
1725 enum { OSD_SEC_CAP_V2_ALL_CAPS
=
1726 OSD_SEC_CAP_V1_ALL_CAPS
| OSD_SEC_CAP_QUERY
| OSD_SEC_CAP_M_OBJECT
1729 void osd_sec_init_nosec_doall_caps(void *caps
,
1730 const struct osd_obj_id
*obj
, bool is_collection
, const bool is_v1
)
1732 struct osd_capability
*cap
= caps
;
1736 if (likely(obj
->id
)) {
1737 if (unlikely(is_collection
)) {
1738 type
= OSD_SEC_OBJ_COLLECTION
;
1739 descriptor_type
= is_v1
? OSD_SEC_OBJ_DESC_OBJ
:
1740 OSD_SEC_OBJ_DESC_COL
;
1742 type
= OSD_SEC_OBJ_USER
;
1743 descriptor_type
= OSD_SEC_OBJ_DESC_OBJ
;
1745 WARN_ON(!obj
->partition
);
1747 type
= obj
->partition
? OSD_SEC_OBJ_PARTITION
:
1749 descriptor_type
= OSD_SEC_OBJ_DESC_PAR
;
1752 memset(cap
, 0, sizeof(*cap
));
1754 cap
->h
.format
= OSD_SEC_CAP_FORMAT_VER1
;
1755 cap
->h
.integrity_algorithm__key_version
= 0; /* MAKE_BYTE(0, 0); */
1756 cap
->h
.security_method
= OSD_SEC_NOSEC
;
1757 /* cap->expiration_time;
1759 cap->discriminator[42-30];
1760 cap->object_created_time; */
1761 cap
->h
.object_type
= type
;
1762 osd_sec_set_caps(&cap
->h
, OSD_SEC_CAP_V1_ALL_CAPS
);
1763 cap
->h
.object_descriptor_type
= descriptor_type
;
1764 cap
->od
.obj_desc
.policy_access_tag
= 0;
1765 cap
->od
.obj_desc
.allowed_partition_id
= cpu_to_be64(obj
->partition
);
1766 cap
->od
.obj_desc
.allowed_object_id
= cpu_to_be64(obj
->id
);
1768 EXPORT_SYMBOL(osd_sec_init_nosec_doall_caps
);
1770 /* FIXME: Extract version from caps pointer.
1771 * Also Pete's target only supports caps from OSDv1 for now
1773 void osd_set_caps(struct osd_cdb
*cdb
, const void *caps
)
1775 bool is_ver1
= true;
1776 /* NOTE: They start at same address */
1777 memcpy(&cdb
->v1
.caps
, caps
, is_ver1
? OSDv1_CAP_LEN
: OSD_CAP_LEN
);
1780 bool osd_is_sec_alldata(struct osd_security_parameters
*sec_parms __unused
)
1785 void osd_sec_sign_cdb(struct osd_cdb
*ocdb __unused
, const u8
*cap_key __unused
)
1789 void osd_sec_sign_data(void *data_integ __unused
,
1790 struct bio
*bio __unused
, const u8
*cap_key __unused
)
1795 * Declared in osd_protocol.h
1796 * 4.12.5 Data-In and Data-Out buffer offsets
1797 * byte offset = mantissa * (2^(exponent+8))
1798 * Returns the smallest allowed encoded offset that contains given @offset
1799 * The actual encoded offset returned is @offset + *@padding.
1801 osd_cdb_offset
__osd_encode_offset(
1802 u64 offset
, unsigned *padding
, int min_shift
, int max_shift
)
1804 u64 try_offset
= -1, mod
, align
;
1805 osd_cdb_offset be32_offset
;
1812 for (shift
= min_shift
; shift
< max_shift
; ++shift
) {
1813 try_offset
= offset
>> shift
;
1814 if (try_offset
< (1 << OSD_OFFSET_MAX_BITS
))
1818 BUG_ON(shift
== max_shift
);
1821 mod
= offset
& (align
- 1);
1823 *padding
= align
- mod
;
1827 try_offset
|= ((shift
- 8) & 0xf) << 28;
1828 be32_offset
= cpu_to_be32((u32
)try_offset
);
1830 OSD_DEBUG("offset=%llu mantissa=%llu exp=%d encoded=%x pad=%d\n",
1831 _LLU(offset
), _LLU(try_offset
& 0x0FFFFFFF), shift
,
1832 be32_offset
, *padding
);