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 <ooo@electrozaur.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 <linux/slab.h>
43 #include <linux/module.h>
45 #include <scsi/osd_initiator.h>
46 #include <scsi/osd_sec.h>
47 #include <scsi/osd_attributes.h>
48 #include <scsi/osd_sense.h>
50 #include <scsi/scsi_device.h>
51 #include <scsi/scsi_request.h>
53 #include "osd_debug.h"
56 # define __unused __attribute__((unused))
59 enum { OSD_REQ_RETRIES = 1 };
61 MODULE_AUTHOR("Boaz Harrosh <ooo@electrozaur.com>");
62 MODULE_DESCRIPTION("open-osd initiator library libosd.ko");
63 MODULE_LICENSE("GPL");
65 static inline void build_test(void)
67 /* structures were not packed */
68 BUILD_BUG_ON(sizeof(struct osd_capability) != OSD_CAP_LEN);
69 BUILD_BUG_ON(sizeof(struct osdv2_cdb) != OSD_TOTAL_CDB_LEN);
70 BUILD_BUG_ON(sizeof(struct osdv1_cdb) != OSDv1_TOTAL_CDB_LEN);
73 static const char *_osd_ver_desc(struct osd_request *or)
75 return osd_req_is_ver1(or) ? "OSD1" : "OSD2";
78 #define ATTR_DEF_RI(id, len) ATTR_DEF(OSD_APAGE_ROOT_INFORMATION, id, len)
80 static int _osd_get_print_system_info(struct osd_dev *od,
81 void *caps, struct osd_dev_info *odi)
83 struct osd_request *or;
84 struct osd_attr get_attrs[] = {
85 ATTR_DEF_RI(OSD_ATTR_RI_VENDOR_IDENTIFICATION, 8),
86 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_IDENTIFICATION, 16),
87 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_MODEL, 32),
88 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_REVISION_LEVEL, 4),
89 ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_SERIAL_NUMBER, 64 /*variable*/),
90 ATTR_DEF_RI(OSD_ATTR_RI_OSD_NAME, 64 /*variable*/),
91 ATTR_DEF_RI(OSD_ATTR_RI_TOTAL_CAPACITY, 8),
92 ATTR_DEF_RI(OSD_ATTR_RI_USED_CAPACITY, 8),
93 ATTR_DEF_RI(OSD_ATTR_RI_NUMBER_OF_PARTITIONS, 8),
94 ATTR_DEF_RI(OSD_ATTR_RI_CLOCK, 6),
95 /* IBM-OSD-SIM Has a bug with this one put it last */
96 ATTR_DEF_RI(OSD_ATTR_RI_OSD_SYSTEM_ID, 20),
98 void *iter = NULL, *pFirst;
99 int nelem = ARRAY_SIZE(get_attrs), a = 0;
102 or = osd_start_request(od, GFP_KERNEL);
107 osd_req_get_attributes(or, &osd_root_object);
108 osd_req_add_get_attr_list(or, get_attrs, ARRAY_SIZE(get_attrs));
110 ret = osd_finalize_request(or, 0, caps, NULL);
114 ret = osd_execute_request(or);
116 OSD_ERR("Failed to detect %s => %d\n", _osd_ver_desc(or), ret);
120 osd_req_decode_get_attr_list(or, get_attrs, &nelem, &iter);
122 OSD_INFO("Detected %s device\n",
125 pFirst = get_attrs[a++].val_ptr;
126 OSD_INFO("VENDOR_IDENTIFICATION [%s]\n",
129 pFirst = get_attrs[a++].val_ptr;
130 OSD_INFO("PRODUCT_IDENTIFICATION [%s]\n",
133 pFirst = get_attrs[a++].val_ptr;
134 OSD_INFO("PRODUCT_MODEL [%s]\n",
137 pFirst = get_attrs[a++].val_ptr;
138 OSD_INFO("PRODUCT_REVISION_LEVEL [%u]\n",
139 pFirst ? get_unaligned_be32(pFirst) : ~0U);
141 pFirst = get_attrs[a++].val_ptr;
142 OSD_INFO("PRODUCT_SERIAL_NUMBER [%s]\n",
145 odi->osdname_len = get_attrs[a].len;
146 /* Avoid NULL for memcmp optimization 0-length is good enough */
147 odi->osdname = kzalloc(odi->osdname_len + 1, GFP_KERNEL);
152 if (odi->osdname_len)
153 memcpy(odi->osdname, get_attrs[a].val_ptr, odi->osdname_len);
154 OSD_INFO("OSD_NAME [%s]\n", odi->osdname);
157 pFirst = get_attrs[a++].val_ptr;
158 OSD_INFO("TOTAL_CAPACITY [0x%llx]\n",
159 pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
161 pFirst = get_attrs[a++].val_ptr;
162 OSD_INFO("USED_CAPACITY [0x%llx]\n",
163 pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
165 pFirst = get_attrs[a++].val_ptr;
166 OSD_INFO("NUMBER_OF_PARTITIONS [%llu]\n",
167 pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
172 /* FIXME: Where are the time utilities */
173 pFirst = get_attrs[a++].val_ptr;
174 OSD_INFO("CLOCK [0x%6phN]\n", pFirst);
176 if (a < nelem) { /* IBM-OSD-SIM bug, Might not have it */
177 unsigned len = get_attrs[a].len;
178 char sid_dump[32*4 + 2]; /* 2nibbles+space+ASCII */
180 hex_dump_to_buffer(get_attrs[a].val_ptr, len, 32, 1,
181 sid_dump, sizeof(sid_dump), true);
182 OSD_INFO("OSD_SYSTEM_ID(%d)\n"
183 " [%s]\n", len, sid_dump);
185 if (unlikely(len > sizeof(odi->systemid))) {
186 OSD_ERR("OSD Target error: OSD_SYSTEM_ID too long(%d). "
187 "device identification might not work\n", len);
188 len = sizeof(odi->systemid);
190 odi->systemid_len = len;
191 memcpy(odi->systemid, get_attrs[a].val_ptr, len);
199 int osd_auto_detect_ver(struct osd_dev *od,
200 void *caps, struct osd_dev_info *odi)
204 /* Auto-detect the osd version */
205 ret = _osd_get_print_system_info(od, caps, odi);
207 osd_dev_set_ver(od, OSD_VER1);
208 OSD_DEBUG("converting to OSD1\n");
209 ret = _osd_get_print_system_info(od, caps, odi);
214 EXPORT_SYMBOL(osd_auto_detect_ver);
216 static unsigned _osd_req_cdb_len(struct osd_request *or)
218 return osd_req_is_ver1(or) ? OSDv1_TOTAL_CDB_LEN : OSD_TOTAL_CDB_LEN;
221 static unsigned _osd_req_alist_elem_size(struct osd_request *or, unsigned len)
223 return osd_req_is_ver1(or) ?
224 osdv1_attr_list_elem_size(len) :
225 osdv2_attr_list_elem_size(len);
228 static void _osd_req_alist_elem_encode(struct osd_request *or,
229 void *attr_last, const struct osd_attr *oa)
231 if (osd_req_is_ver1(or)) {
232 struct osdv1_attributes_list_element *attr = attr_last;
234 attr->attr_page = cpu_to_be32(oa->attr_page);
235 attr->attr_id = cpu_to_be32(oa->attr_id);
236 attr->attr_bytes = cpu_to_be16(oa->len);
237 memcpy(attr->attr_val, oa->val_ptr, oa->len);
239 struct osdv2_attributes_list_element *attr = attr_last;
241 attr->attr_page = cpu_to_be32(oa->attr_page);
242 attr->attr_id = cpu_to_be32(oa->attr_id);
243 attr->attr_bytes = cpu_to_be16(oa->len);
244 memcpy(attr->attr_val, oa->val_ptr, oa->len);
248 static int _osd_req_alist_elem_decode(struct osd_request *or,
249 void *cur_p, struct osd_attr *oa, unsigned max_bytes)
252 if (osd_req_is_ver1(or)) {
253 struct osdv1_attributes_list_element *attr = cur_p;
255 if (max_bytes < sizeof(*attr))
258 oa->len = be16_to_cpu(attr->attr_bytes);
259 inc = _osd_req_alist_elem_size(or, oa->len);
263 oa->attr_page = be32_to_cpu(attr->attr_page);
264 oa->attr_id = be32_to_cpu(attr->attr_id);
266 /* OSD1: On empty attributes we return a pointer to 2 bytes
267 * of zeros. This keeps similar behaviour with OSD2.
270 oa->val_ptr = likely(oa->len) ? attr->attr_val :
271 (u8 *)&attr->attr_bytes;
273 struct osdv2_attributes_list_element *attr = cur_p;
275 if (max_bytes < sizeof(*attr))
278 oa->len = be16_to_cpu(attr->attr_bytes);
279 inc = _osd_req_alist_elem_size(or, oa->len);
283 oa->attr_page = be32_to_cpu(attr->attr_page);
284 oa->attr_id = be32_to_cpu(attr->attr_id);
286 /* OSD2: For convenience, on empty attributes, we return 8 bytes
287 * of zeros here. This keeps the same behaviour with OSD2r04,
288 * and is nice with null terminating ASCII fields.
289 * oa->val_ptr == NULL marks the end-of-list, or error.
291 oa->val_ptr = likely(oa->len) ? attr->attr_val : attr->reserved;
296 static unsigned _osd_req_alist_size(struct osd_request *or, void *list_head)
298 return osd_req_is_ver1(or) ?
299 osdv1_list_size(list_head) :
300 osdv2_list_size(list_head);
303 static unsigned _osd_req_sizeof_alist_header(struct osd_request *or)
305 return osd_req_is_ver1(or) ?
306 sizeof(struct osdv1_attributes_list_header) :
307 sizeof(struct osdv2_attributes_list_header);
310 static void _osd_req_set_alist_type(struct osd_request *or,
311 void *list, int list_type)
313 if (osd_req_is_ver1(or)) {
314 struct osdv1_attributes_list_header *attr_list = list;
316 memset(attr_list, 0, sizeof(*attr_list));
317 attr_list->type = list_type;
319 struct osdv2_attributes_list_header *attr_list = list;
321 memset(attr_list, 0, sizeof(*attr_list));
322 attr_list->type = list_type;
326 static bool _osd_req_is_alist_type(struct osd_request *or,
327 void *list, int list_type)
332 if (osd_req_is_ver1(or)) {
333 struct osdv1_attributes_list_header *attr_list = list;
335 return attr_list->type == list_type;
337 struct osdv2_attributes_list_header *attr_list = list;
339 return attr_list->type == list_type;
343 /* This is for List-objects not Attributes-Lists */
344 static void _osd_req_encode_olist(struct osd_request *or,
345 struct osd_obj_id_list *list)
347 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
349 if (osd_req_is_ver1(or)) {
350 cdbh->v1.list_identifier = list->list_identifier;
351 cdbh->v1.start_address = list->continuation_id;
353 cdbh->v2.list_identifier = list->list_identifier;
354 cdbh->v2.start_address = list->continuation_id;
358 static osd_cdb_offset osd_req_encode_offset(struct osd_request *or,
359 u64 offset, unsigned *padding)
361 return __osd_encode_offset(offset, padding,
362 osd_req_is_ver1(or) ?
363 OSDv1_OFFSET_MIN_SHIFT : OSD_OFFSET_MIN_SHIFT,
364 OSD_OFFSET_MAX_SHIFT);
367 static struct osd_security_parameters *
368 _osd_req_sec_params(struct osd_request *or)
370 struct osd_cdb *ocdb = &or->cdb;
372 if (osd_req_is_ver1(or))
373 return (struct osd_security_parameters *)&ocdb->v1.sec_params;
375 return (struct osd_security_parameters *)&ocdb->v2.sec_params;
378 void osd_dev_init(struct osd_dev *osdd, struct scsi_device *scsi_device)
380 memset(osdd, 0, sizeof(*osdd));
381 osdd->scsi_device = scsi_device;
382 osdd->def_timeout = BLK_DEFAULT_SG_TIMEOUT;
383 #ifdef OSD_VER1_SUPPORT
384 osdd->version = OSD_VER2;
386 /* TODO: Allocate pools for osd_request attributes ... */
388 EXPORT_SYMBOL(osd_dev_init);
390 void osd_dev_fini(struct osd_dev *osdd)
392 /* TODO: De-allocate pools */
394 osdd->scsi_device = NULL;
396 EXPORT_SYMBOL(osd_dev_fini);
398 static struct osd_request *_osd_request_alloc(gfp_t gfp)
400 struct osd_request *or;
402 /* TODO: Use mempool with one saved request */
403 or = kzalloc(sizeof(*or), gfp);
407 static void _osd_request_free(struct osd_request *or)
412 struct osd_request *osd_start_request(struct osd_dev *dev, gfp_t gfp)
414 struct osd_request *or;
416 or = _osd_request_alloc(gfp);
421 or->alloc_flags = gfp;
422 or->timeout = dev->def_timeout;
423 or->retries = OSD_REQ_RETRIES;
427 EXPORT_SYMBOL(osd_start_request);
429 static void _osd_free_seg(struct osd_request *or __unused,
430 struct _osd_req_data_segment *seg)
432 if (!seg->buff || !seg->alloc_size)
440 static void _put_request(struct request *rq)
443 * If osd_finalize_request() was called but the request was not
444 * executed through the block layer, then we must release BIOs.
445 * TODO: Keep error code in or->async_error. Need to audit all
448 if (unlikely(rq->bio))
449 blk_end_request(rq, BLK_STS_IOERR, blk_rq_bytes(rq));
454 void osd_end_request(struct osd_request *or)
456 struct request *rq = or->request;
460 _put_request(rq->next_rq);
467 _osd_free_seg(or, &or->get_attr);
468 _osd_free_seg(or, &or->enc_get_attr);
469 _osd_free_seg(or, &or->set_attr);
470 _osd_free_seg(or, &or->cdb_cont);
472 _osd_request_free(or);
474 EXPORT_SYMBOL(osd_end_request);
476 static void _set_error_resid(struct osd_request *or, struct request *req,
479 or->async_error = error;
480 or->req_errors = scsi_req(req)->result;
481 or->sense_len = scsi_req(req)->sense_len;
483 memcpy(or->sense, scsi_req(req)->sense, or->sense_len);
485 or->out.residual = scsi_req(or->out.req)->resid_len;
487 or->in.residual = scsi_req(or->in.req)->resid_len;
490 int osd_execute_request(struct osd_request *or)
492 blk_execute_rq(or->request->q, NULL, or->request, 0);
494 if (scsi_req(or->request)->result) {
495 _set_error_resid(or, or->request, BLK_STS_IOERR);
499 _set_error_resid(or, or->request, BLK_STS_OK);
502 EXPORT_SYMBOL(osd_execute_request);
504 static void osd_request_async_done(struct request *req, blk_status_t error)
506 struct osd_request *or = req->end_io_data;
508 _set_error_resid(or, req, error);
510 __blk_put_request(req->q, req->next_rq);
514 __blk_put_request(req->q, req);
520 or->async_done(or, or->async_private);
525 int osd_execute_request_async(struct osd_request *or,
526 osd_req_done_fn *done, void *private)
528 or->request->end_io_data = or;
529 or->async_private = private;
530 or->async_done = done;
532 blk_execute_rq_nowait(or->request->q, NULL, or->request, 0,
533 osd_request_async_done);
536 EXPORT_SYMBOL(osd_execute_request_async);
538 u8 sg_out_pad_buffer[1 << OSDv1_OFFSET_MIN_SHIFT];
539 u8 sg_in_pad_buffer[1 << OSDv1_OFFSET_MIN_SHIFT];
541 static int _osd_realloc_seg(struct osd_request *or,
542 struct _osd_req_data_segment *seg, unsigned max_bytes)
546 if (seg->alloc_size >= max_bytes)
549 buff = krealloc(seg->buff, max_bytes, or->alloc_flags);
551 OSD_ERR("Failed to Realloc %d-bytes was-%d\n", max_bytes,
556 memset(buff + seg->alloc_size, 0, max_bytes - seg->alloc_size);
558 seg->alloc_size = max_bytes;
562 static int _alloc_cdb_cont(struct osd_request *or, unsigned total_bytes)
564 OSD_DEBUG("total_bytes=%d\n", total_bytes);
565 return _osd_realloc_seg(or, &or->cdb_cont, total_bytes);
568 static int _alloc_set_attr_list(struct osd_request *or,
569 const struct osd_attr *oa, unsigned nelem, unsigned add_bytes)
571 unsigned total_bytes = add_bytes;
573 for (; nelem; --nelem, ++oa)
574 total_bytes += _osd_req_alist_elem_size(or, oa->len);
576 OSD_DEBUG("total_bytes=%d\n", total_bytes);
577 return _osd_realloc_seg(or, &or->set_attr, total_bytes);
580 static int _alloc_get_attr_desc(struct osd_request *or, unsigned max_bytes)
582 OSD_DEBUG("total_bytes=%d\n", max_bytes);
583 return _osd_realloc_seg(or, &or->enc_get_attr, max_bytes);
586 static int _alloc_get_attr_list(struct osd_request *or)
588 OSD_DEBUG("total_bytes=%d\n", or->get_attr.total_bytes);
589 return _osd_realloc_seg(or, &or->get_attr, or->get_attr.total_bytes);
593 * Common to all OSD commands
596 static void _osdv1_req_encode_common(struct osd_request *or,
597 __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
599 struct osdv1_cdb *ocdb = &or->cdb.v1;
602 * For speed, the commands
603 * OSD_ACT_PERFORM_SCSI_COMMAND , V1 0x8F7E, V2 0x8F7C
604 * OSD_ACT_SCSI_TASK_MANAGEMENT , V1 0x8F7F, V2 0x8F7D
605 * are not supported here. Should pass zero and set after the call
607 act &= cpu_to_be16(~0x0080); /* V1 action code */
609 OSD_DEBUG("OSDv1 execute opcode 0x%x\n", be16_to_cpu(act));
611 ocdb->h.varlen_cdb.opcode = VARIABLE_LENGTH_CMD;
612 ocdb->h.varlen_cdb.additional_cdb_length = OSD_ADDITIONAL_CDB_LENGTH;
613 ocdb->h.varlen_cdb.service_action = act;
615 ocdb->h.partition = cpu_to_be64(obj->partition);
616 ocdb->h.object = cpu_to_be64(obj->id);
617 ocdb->h.v1.length = cpu_to_be64(len);
618 ocdb->h.v1.start_address = cpu_to_be64(offset);
621 static void _osdv2_req_encode_common(struct osd_request *or,
622 __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
624 struct osdv2_cdb *ocdb = &or->cdb.v2;
626 OSD_DEBUG("OSDv2 execute opcode 0x%x\n", be16_to_cpu(act));
628 ocdb->h.varlen_cdb.opcode = VARIABLE_LENGTH_CMD;
629 ocdb->h.varlen_cdb.additional_cdb_length = OSD_ADDITIONAL_CDB_LENGTH;
630 ocdb->h.varlen_cdb.service_action = act;
632 ocdb->h.partition = cpu_to_be64(obj->partition);
633 ocdb->h.object = cpu_to_be64(obj->id);
634 ocdb->h.v2.length = cpu_to_be64(len);
635 ocdb->h.v2.start_address = cpu_to_be64(offset);
638 static void _osd_req_encode_common(struct osd_request *or,
639 __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
641 if (osd_req_is_ver1(or))
642 _osdv1_req_encode_common(or, act, obj, offset, len);
644 _osdv2_req_encode_common(or, act, obj, offset, len);
650 /*TODO: void osd_req_set_master_seed_xchg(struct osd_request *, ...); */
651 /*TODO: void osd_req_set_master_key(struct osd_request *, ...); */
653 void osd_req_format(struct osd_request *or, u64 tot_capacity)
655 _osd_req_encode_common(or, OSD_ACT_FORMAT_OSD, &osd_root_object, 0,
658 EXPORT_SYMBOL(osd_req_format);
660 int osd_req_list_dev_partitions(struct osd_request *or,
661 osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem)
663 return osd_req_list_partition_objects(or, 0, initial_id, list, nelem);
665 EXPORT_SYMBOL(osd_req_list_dev_partitions);
667 static void _osd_req_encode_flush(struct osd_request *or,
668 enum osd_options_flush_scope_values op)
670 struct osd_cdb_head *ocdb = osd_cdb_head(&or->cdb);
672 ocdb->command_specific_options = op;
675 void osd_req_flush_obsd(struct osd_request *or,
676 enum osd_options_flush_scope_values op)
678 _osd_req_encode_common(or, OSD_ACT_FLUSH_OSD, &osd_root_object, 0, 0);
679 _osd_req_encode_flush(or, op);
681 EXPORT_SYMBOL(osd_req_flush_obsd);
683 /*TODO: void osd_req_perform_scsi_command(struct osd_request *,
684 const u8 *cdb, ...); */
685 /*TODO: void osd_req_task_management(struct osd_request *, ...); */
690 static void _osd_req_encode_partition(struct osd_request *or,
691 __be16 act, osd_id partition)
693 struct osd_obj_id par = {
694 .partition = partition,
698 _osd_req_encode_common(or, act, &par, 0, 0);
701 void osd_req_create_partition(struct osd_request *or, osd_id partition)
703 _osd_req_encode_partition(or, OSD_ACT_CREATE_PARTITION, partition);
705 EXPORT_SYMBOL(osd_req_create_partition);
707 void osd_req_remove_partition(struct osd_request *or, osd_id partition)
709 _osd_req_encode_partition(or, OSD_ACT_REMOVE_PARTITION, partition);
711 EXPORT_SYMBOL(osd_req_remove_partition);
713 /*TODO: void osd_req_set_partition_key(struct osd_request *,
714 osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
715 u8 seed[OSD_CRYPTO_SEED_SIZE]); */
717 static int _osd_req_list_objects(struct osd_request *or,
718 __be16 action, const struct osd_obj_id *obj, osd_id initial_id,
719 struct osd_obj_id_list *list, unsigned nelem)
721 struct request_queue *q = osd_request_queue(or->osd_dev);
722 u64 len = nelem * sizeof(osd_id) + sizeof(*list);
725 _osd_req_encode_common(or, action, obj, (u64)initial_id, len);
727 if (list->list_identifier)
728 _osd_req_encode_olist(or, list);
731 bio = bio_map_kern(q, list, len, or->alloc_flags);
733 OSD_ERR("!!! Failed to allocate list_objects BIO\n");
737 bio_set_op_attrs(bio, REQ_OP_READ, 0);
739 or->in.total_bytes = bio->bi_iter.bi_size;
743 int osd_req_list_partition_collections(struct osd_request *or,
744 osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
747 struct osd_obj_id par = {
748 .partition = partition,
752 return osd_req_list_collection_objects(or, &par, initial_id, list,
755 EXPORT_SYMBOL(osd_req_list_partition_collections);
757 int osd_req_list_partition_objects(struct osd_request *or,
758 osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
761 struct osd_obj_id par = {
762 .partition = partition,
766 return _osd_req_list_objects(or, OSD_ACT_LIST, &par, initial_id, list,
769 EXPORT_SYMBOL(osd_req_list_partition_objects);
771 void osd_req_flush_partition(struct osd_request *or,
772 osd_id partition, enum osd_options_flush_scope_values op)
774 _osd_req_encode_partition(or, OSD_ACT_FLUSH_PARTITION, partition);
775 _osd_req_encode_flush(or, op);
777 EXPORT_SYMBOL(osd_req_flush_partition);
780 * Collection commands
782 /*TODO: void osd_req_create_collection(struct osd_request *,
783 const struct osd_obj_id *); */
784 /*TODO: void osd_req_remove_collection(struct osd_request *,
785 const struct osd_obj_id *); */
787 int osd_req_list_collection_objects(struct osd_request *or,
788 const struct osd_obj_id *obj, osd_id initial_id,
789 struct osd_obj_id_list *list, unsigned nelem)
791 return _osd_req_list_objects(or, OSD_ACT_LIST_COLLECTION, obj,
792 initial_id, list, nelem);
794 EXPORT_SYMBOL(osd_req_list_collection_objects);
796 /*TODO: void query(struct osd_request *, ...); V2 */
798 void osd_req_flush_collection(struct osd_request *or,
799 const struct osd_obj_id *obj, enum osd_options_flush_scope_values op)
801 _osd_req_encode_common(or, OSD_ACT_FLUSH_PARTITION, obj, 0, 0);
802 _osd_req_encode_flush(or, op);
804 EXPORT_SYMBOL(osd_req_flush_collection);
806 /*TODO: void get_member_attrs(struct osd_request *, ...); V2 */
807 /*TODO: void set_member_attrs(struct osd_request *, ...); V2 */
812 void osd_req_create_object(struct osd_request *or, struct osd_obj_id *obj)
814 _osd_req_encode_common(or, OSD_ACT_CREATE, obj, 0, 0);
816 EXPORT_SYMBOL(osd_req_create_object);
818 void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *obj)
820 _osd_req_encode_common(or, OSD_ACT_REMOVE, obj, 0, 0);
822 EXPORT_SYMBOL(osd_req_remove_object);
825 /*TODO: void osd_req_create_multi(struct osd_request *or,
826 struct osd_obj_id *first, struct osd_obj_id_list *list, unsigned nelem);
829 void osd_req_write(struct osd_request *or,
830 const struct osd_obj_id *obj, u64 offset,
831 struct bio *bio, u64 len)
833 _osd_req_encode_common(or, OSD_ACT_WRITE, obj, offset, len);
834 WARN_ON(or->out.bio || or->out.total_bytes);
835 WARN_ON(!op_is_write(bio_op(bio)));
837 or->out.total_bytes = len;
839 EXPORT_SYMBOL(osd_req_write);
841 int osd_req_write_kern(struct osd_request *or,
842 const struct osd_obj_id *obj, u64 offset, void* buff, u64 len)
844 struct request_queue *req_q = osd_request_queue(or->osd_dev);
845 struct bio *bio = bio_map_kern(req_q, buff, len, GFP_KERNEL);
850 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
851 osd_req_write(or, obj, offset, bio, len);
854 EXPORT_SYMBOL(osd_req_write_kern);
856 /*TODO: void osd_req_append(struct osd_request *,
857 const struct osd_obj_id *, struct bio *data_out); */
858 /*TODO: void osd_req_create_write(struct osd_request *,
859 const struct osd_obj_id *, struct bio *data_out, u64 offset); */
860 /*TODO: void osd_req_clear(struct osd_request *,
861 const struct osd_obj_id *, u64 offset, u64 len); */
862 /*TODO: void osd_req_punch(struct osd_request *,
863 const struct osd_obj_id *, u64 offset, u64 len); V2 */
865 void osd_req_flush_object(struct osd_request *or,
866 const struct osd_obj_id *obj, enum osd_options_flush_scope_values op,
867 /*V2*/ u64 offset, /*V2*/ u64 len)
869 if (unlikely(osd_req_is_ver1(or) && (offset || len))) {
870 OSD_DEBUG("OSD Ver1 flush on specific range ignored\n");
875 _osd_req_encode_common(or, OSD_ACT_FLUSH, obj, offset, len);
876 _osd_req_encode_flush(or, op);
878 EXPORT_SYMBOL(osd_req_flush_object);
880 void osd_req_read(struct osd_request *or,
881 const struct osd_obj_id *obj, u64 offset,
882 struct bio *bio, u64 len)
884 _osd_req_encode_common(or, OSD_ACT_READ, obj, offset, len);
885 WARN_ON(or->in.bio || or->in.total_bytes);
886 WARN_ON(op_is_write(bio_op(bio)));
888 or->in.total_bytes = len;
890 EXPORT_SYMBOL(osd_req_read);
892 int osd_req_read_kern(struct osd_request *or,
893 const struct osd_obj_id *obj, u64 offset, void* buff, u64 len)
895 struct request_queue *req_q = osd_request_queue(or->osd_dev);
896 struct bio *bio = bio_map_kern(req_q, buff, len, GFP_KERNEL);
901 osd_req_read(or, obj, offset, bio, len);
904 EXPORT_SYMBOL(osd_req_read_kern);
906 static int _add_sg_continuation_descriptor(struct osd_request *or,
907 const struct osd_sg_entry *sglist, unsigned numentries, u64 *len)
909 struct osd_sg_continuation_descriptor *oscd;
914 oscd_size = sizeof(*oscd) + numentries * sizeof(oscd->entries[0]);
916 if (!or->cdb_cont.total_bytes) {
917 /* First time, jump over the header, we will write to:
918 * cdb_cont.buff + cdb_cont.total_bytes
920 or->cdb_cont.total_bytes =
921 sizeof(struct osd_continuation_segment_header);
924 ret = _alloc_cdb_cont(or, or->cdb_cont.total_bytes + oscd_size);
928 oscd = or->cdb_cont.buff + or->cdb_cont.total_bytes;
929 oscd->hdr.type = cpu_to_be16(SCATTER_GATHER_LIST);
930 oscd->hdr.pad_length = 0;
931 oscd->hdr.length = cpu_to_be32(oscd_size - sizeof(*oscd));
934 /* copy the sg entries and convert to network byte order */
935 for (i = 0; i < numentries; i++) {
936 oscd->entries[i].offset = cpu_to_be64(sglist[i].offset);
937 oscd->entries[i].len = cpu_to_be64(sglist[i].len);
938 *len += sglist[i].len;
941 or->cdb_cont.total_bytes += oscd_size;
942 OSD_DEBUG("total_bytes=%d oscd_size=%d numentries=%d\n",
943 or->cdb_cont.total_bytes, oscd_size, numentries);
947 static int _osd_req_finalize_cdb_cont(struct osd_request *or, const u8 *cap_key)
949 struct request_queue *req_q = osd_request_queue(or->osd_dev);
951 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
952 struct osd_continuation_segment_header *cont_seg_hdr;
954 if (!or->cdb_cont.total_bytes)
957 cont_seg_hdr = or->cdb_cont.buff;
958 cont_seg_hdr->format = CDB_CONTINUATION_FORMAT_V2;
959 cont_seg_hdr->service_action = cdbh->varlen_cdb.service_action;
961 /* create a bio for continuation segment */
962 bio = bio_map_kern(req_q, or->cdb_cont.buff, or->cdb_cont.total_bytes,
967 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
969 /* integrity check the continuation before the bio is linked
970 * with the other data segments since the continuation
971 * integrity is separate from the other data segments.
973 osd_sec_sign_data(cont_seg_hdr->integrity_check, bio, cap_key);
975 cdbh->v2.cdb_continuation_length = cpu_to_be32(or->cdb_cont.total_bytes);
977 /* we can't use _req_append_segment, because we need to link in the
978 * continuation bio to the head of the bio list - the
979 * continuation segment (if it exists) is always the first segment in
980 * the out data buffer.
982 bio->bi_next = or->out.bio;
984 or->out.total_bytes += or->cdb_cont.total_bytes;
989 /* osd_req_write_sg: Takes a @bio that points to the data out buffer and an
990 * @sglist that has the scatter gather entries. Scatter-gather enables a write
991 * of multiple none-contiguous areas of an object, in a single call. The extents
992 * may overlap and/or be in any order. The only constrain is that:
993 * total_bytes(sglist) >= total_bytes(bio)
995 int osd_req_write_sg(struct osd_request *or,
996 const struct osd_obj_id *obj, struct bio *bio,
997 const struct osd_sg_entry *sglist, unsigned numentries)
1000 int ret = _add_sg_continuation_descriptor(or, sglist, numentries, &len);
1004 osd_req_write(or, obj, 0, bio, len);
1008 EXPORT_SYMBOL(osd_req_write_sg);
1010 /* osd_req_read_sg: Read multiple extents of an object into @bio
1011 * See osd_req_write_sg
1013 int osd_req_read_sg(struct osd_request *or,
1014 const struct osd_obj_id *obj, struct bio *bio,
1015 const struct osd_sg_entry *sglist, unsigned numentries)
1021 if (numentries > 1) {
1023 ret = _add_sg_continuation_descriptor(or, sglist, numentries,
1028 /* Optimize the case of single segment, read_sg is a
1032 off = sglist->offset;
1034 osd_req_read(or, obj, off, bio, len);
1038 EXPORT_SYMBOL(osd_req_read_sg);
1040 /* SG-list write/read Kern API
1042 * osd_req_{write,read}_sg_kern takes an array of @buff pointers and an array
1043 * of sg_entries. @numentries indicates how many pointers and sg_entries there
1044 * are. By requiring an array of buff pointers. This allows a caller to do a
1045 * single write/read and scatter into multiple buffers.
1046 * NOTE: Each buffer + len should not cross a page boundary.
1048 static struct bio *_create_sg_bios(struct osd_request *or,
1049 void **buff, const struct osd_sg_entry *sglist, unsigned numentries)
1051 struct request_queue *q = osd_request_queue(or->osd_dev);
1055 bio = bio_kmalloc(GFP_KERNEL, numentries);
1056 if (unlikely(!bio)) {
1057 OSD_DEBUG("Failed to allocate BIO size=%u\n", numentries);
1058 return ERR_PTR(-ENOMEM);
1061 for (i = 0; i < numentries; i++) {
1062 unsigned offset = offset_in_page(buff[i]);
1063 struct page *page = virt_to_page(buff[i]);
1064 unsigned len = sglist[i].len;
1067 BUG_ON(offset + len > PAGE_SIZE);
1068 added_len = bio_add_pc_page(q, bio, page, len, offset);
1069 if (unlikely(len != added_len)) {
1070 OSD_DEBUG("bio_add_pc_page len(%d) != added_len(%d)\n",
1073 return ERR_PTR(-ENOMEM);
1080 int osd_req_write_sg_kern(struct osd_request *or,
1081 const struct osd_obj_id *obj, void **buff,
1082 const struct osd_sg_entry *sglist, unsigned numentries)
1084 struct bio *bio = _create_sg_bios(or, buff, sglist, numentries);
1086 return PTR_ERR(bio);
1088 bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
1089 osd_req_write_sg(or, obj, bio, sglist, numentries);
1093 EXPORT_SYMBOL(osd_req_write_sg_kern);
1095 int osd_req_read_sg_kern(struct osd_request *or,
1096 const struct osd_obj_id *obj, void **buff,
1097 const struct osd_sg_entry *sglist, unsigned numentries)
1099 struct bio *bio = _create_sg_bios(or, buff, sglist, numentries);
1101 return PTR_ERR(bio);
1103 osd_req_read_sg(or, obj, bio, sglist, numentries);
1107 EXPORT_SYMBOL(osd_req_read_sg_kern);
1111 void osd_req_get_attributes(struct osd_request *or,
1112 const struct osd_obj_id *obj)
1114 _osd_req_encode_common(or, OSD_ACT_GET_ATTRIBUTES, obj, 0, 0);
1116 EXPORT_SYMBOL(osd_req_get_attributes);
1118 void osd_req_set_attributes(struct osd_request *or,
1119 const struct osd_obj_id *obj)
1121 _osd_req_encode_common(or, OSD_ACT_SET_ATTRIBUTES, obj, 0, 0);
1123 EXPORT_SYMBOL(osd_req_set_attributes);
1126 * Attributes List-mode
1129 int osd_req_add_set_attr_list(struct osd_request *or,
1130 const struct osd_attr *oa, unsigned nelem)
1132 unsigned total_bytes = or->set_attr.total_bytes;
1136 if (or->attributes_mode &&
1137 or->attributes_mode != OSD_CDB_GET_SET_ATTR_LISTS) {
1141 or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
1143 if (!total_bytes) { /* first-time: allocate and put list header */
1144 total_bytes = _osd_req_sizeof_alist_header(or);
1145 ret = _alloc_set_attr_list(or, oa, nelem, total_bytes);
1148 _osd_req_set_alist_type(or, or->set_attr.buff,
1149 OSD_ATTR_LIST_SET_RETRIEVE);
1151 attr_last = or->set_attr.buff + total_bytes;
1153 for (; nelem; --nelem) {
1154 unsigned elem_size = _osd_req_alist_elem_size(or, oa->len);
1156 total_bytes += elem_size;
1157 if (unlikely(or->set_attr.alloc_size < total_bytes)) {
1158 or->set_attr.total_bytes = total_bytes - elem_size;
1159 ret = _alloc_set_attr_list(or, oa, nelem, total_bytes);
1163 or->set_attr.buff + or->set_attr.total_bytes;
1166 _osd_req_alist_elem_encode(or, attr_last, oa);
1168 attr_last += elem_size;
1172 or->set_attr.total_bytes = total_bytes;
1175 EXPORT_SYMBOL(osd_req_add_set_attr_list);
1177 static int _req_append_segment(struct osd_request *or,
1178 unsigned padding, struct _osd_req_data_segment *seg,
1179 struct _osd_req_data_segment *last_seg, struct _osd_io_info *io)
1185 /* check if we can just add it to last buffer */
1187 (padding <= last_seg->alloc_size - last_seg->total_bytes))
1188 pad_buff = last_seg->buff + last_seg->total_bytes;
1190 pad_buff = io->pad_buff;
1192 ret = blk_rq_map_kern(io->req->q, io->req, pad_buff, padding,
1196 io->total_bytes += padding;
1199 ret = blk_rq_map_kern(io->req->q, io->req, seg->buff, seg->total_bytes,
1204 io->total_bytes += seg->total_bytes;
1205 OSD_DEBUG("padding=%d buff=%p total_bytes=%d\n", padding, seg->buff,
1210 static int _osd_req_finalize_set_attr_list(struct osd_request *or)
1212 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1216 if (!or->set_attr.total_bytes) {
1217 cdbh->attrs_list.set_attr_offset = OSD_OFFSET_UNUSED;
1221 cdbh->attrs_list.set_attr_bytes = cpu_to_be32(or->set_attr.total_bytes);
1222 cdbh->attrs_list.set_attr_offset =
1223 osd_req_encode_offset(or, or->out.total_bytes, &padding);
1225 ret = _req_append_segment(or, padding, &or->set_attr,
1226 or->out.last_seg, &or->out);
1230 or->out.last_seg = &or->set_attr;
1234 int osd_req_add_get_attr_list(struct osd_request *or,
1235 const struct osd_attr *oa, unsigned nelem)
1237 unsigned total_bytes = or->enc_get_attr.total_bytes;
1241 if (or->attributes_mode &&
1242 or->attributes_mode != OSD_CDB_GET_SET_ATTR_LISTS) {
1246 or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
1248 /* first time calc data-in list header size */
1249 if (!or->get_attr.total_bytes)
1250 or->get_attr.total_bytes = _osd_req_sizeof_alist_header(or);
1252 /* calc data-out info */
1253 if (!total_bytes) { /* first-time: allocate and put list header */
1256 total_bytes = _osd_req_sizeof_alist_header(or);
1257 max_bytes = total_bytes +
1258 nelem * sizeof(struct osd_attributes_list_attrid);
1259 ret = _alloc_get_attr_desc(or, max_bytes);
1263 _osd_req_set_alist_type(or, or->enc_get_attr.buff,
1266 attr_last = or->enc_get_attr.buff + total_bytes;
1268 for (; nelem; --nelem) {
1269 struct osd_attributes_list_attrid *attrid;
1270 const unsigned cur_size = sizeof(*attrid);
1272 total_bytes += cur_size;
1273 if (unlikely(or->enc_get_attr.alloc_size < total_bytes)) {
1274 or->enc_get_attr.total_bytes = total_bytes - cur_size;
1275 ret = _alloc_get_attr_desc(or,
1276 total_bytes + nelem * sizeof(*attrid));
1279 attr_last = or->enc_get_attr.buff +
1280 or->enc_get_attr.total_bytes;
1284 attrid->attr_page = cpu_to_be32(oa->attr_page);
1285 attrid->attr_id = cpu_to_be32(oa->attr_id);
1287 attr_last += cur_size;
1289 /* calc data-in size */
1290 or->get_attr.total_bytes +=
1291 _osd_req_alist_elem_size(or, oa->len);
1295 or->enc_get_attr.total_bytes = total_bytes;
1298 "get_attr.total_bytes=%u(%u) enc_get_attr.total_bytes=%u(%zu)\n",
1299 or->get_attr.total_bytes,
1300 or->get_attr.total_bytes - _osd_req_sizeof_alist_header(or),
1301 or->enc_get_attr.total_bytes,
1302 (or->enc_get_attr.total_bytes - _osd_req_sizeof_alist_header(or))
1303 / sizeof(struct osd_attributes_list_attrid));
1307 EXPORT_SYMBOL(osd_req_add_get_attr_list);
1309 static int _osd_req_finalize_get_attr_list(struct osd_request *or)
1311 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1312 unsigned out_padding;
1313 unsigned in_padding;
1316 if (!or->enc_get_attr.total_bytes) {
1317 cdbh->attrs_list.get_attr_desc_offset = OSD_OFFSET_UNUSED;
1318 cdbh->attrs_list.get_attr_offset = OSD_OFFSET_UNUSED;
1322 ret = _alloc_get_attr_list(or);
1326 /* The out-going buffer info update */
1327 OSD_DEBUG("out-going\n");
1328 cdbh->attrs_list.get_attr_desc_bytes =
1329 cpu_to_be32(or->enc_get_attr.total_bytes);
1331 cdbh->attrs_list.get_attr_desc_offset =
1332 osd_req_encode_offset(or, or->out.total_bytes, &out_padding);
1334 ret = _req_append_segment(or, out_padding, &or->enc_get_attr,
1335 or->out.last_seg, &or->out);
1338 or->out.last_seg = &or->enc_get_attr;
1340 /* The incoming buffer info update */
1341 OSD_DEBUG("in-coming\n");
1342 cdbh->attrs_list.get_attr_alloc_length =
1343 cpu_to_be32(or->get_attr.total_bytes);
1345 cdbh->attrs_list.get_attr_offset =
1346 osd_req_encode_offset(or, or->in.total_bytes, &in_padding);
1348 ret = _req_append_segment(or, in_padding, &or->get_attr, NULL,
1352 or->in.last_seg = &or->get_attr;
1357 int osd_req_decode_get_attr_list(struct osd_request *or,
1358 struct osd_attr *oa, int *nelem, void **iterator)
1360 unsigned cur_bytes, returned_bytes;
1362 const unsigned sizeof_attr_list = _osd_req_sizeof_alist_header(or);
1365 if (!_osd_req_is_alist_type(or, or->get_attr.buff,
1366 OSD_ATTR_LIST_SET_RETRIEVE)) {
1376 BUG_ON((*iterator < or->get_attr.buff) ||
1377 (or->get_attr.buff + or->get_attr.alloc_size < *iterator));
1379 cur_bytes = (*iterator - or->get_attr.buff) - sizeof_attr_list;
1380 returned_bytes = or->get_attr.total_bytes;
1381 } else { /* first time decode the list header */
1382 cur_bytes = sizeof_attr_list;
1383 returned_bytes = _osd_req_alist_size(or, or->get_attr.buff) +
1386 cur_p = or->get_attr.buff + sizeof_attr_list;
1388 if (returned_bytes > or->get_attr.alloc_size) {
1389 OSD_DEBUG("target report: space was not big enough! "
1390 "Allocate=%u Needed=%u\n",
1391 or->get_attr.alloc_size,
1392 returned_bytes + sizeof_attr_list);
1395 or->get_attr.alloc_size - sizeof_attr_list;
1397 or->get_attr.total_bytes = returned_bytes;
1400 for (n = 0; (n < *nelem) && (cur_bytes < returned_bytes); ++n) {
1401 int inc = _osd_req_alist_elem_decode(or, cur_p, oa,
1402 returned_bytes - cur_bytes);
1405 OSD_ERR("BAD FOOD from target. list not valid!"
1407 cur_bytes, returned_bytes, n);
1409 cur_bytes = returned_bytes; /* break the caller loop */
1418 *iterator = (returned_bytes - cur_bytes) ? cur_p : NULL;
1420 return returned_bytes - cur_bytes;
1422 EXPORT_SYMBOL(osd_req_decode_get_attr_list);
1425 * Attributes Page-mode
1428 int osd_req_add_get_attr_page(struct osd_request *or,
1429 u32 page_id, void *attar_page, unsigned max_page_len,
1430 const struct osd_attr *set_one_attr)
1432 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1434 if (or->attributes_mode &&
1435 or->attributes_mode != OSD_CDB_GET_ATTR_PAGE_SET_ONE) {
1439 or->attributes_mode = OSD_CDB_GET_ATTR_PAGE_SET_ONE;
1441 or->get_attr.buff = attar_page;
1442 or->get_attr.total_bytes = max_page_len;
1444 cdbh->attrs_page.get_attr_page = cpu_to_be32(page_id);
1445 cdbh->attrs_page.get_attr_alloc_length = cpu_to_be32(max_page_len);
1447 if (!set_one_attr || !set_one_attr->attr_page)
1448 return 0; /* The set is optional */
1450 or->set_attr.buff = set_one_attr->val_ptr;
1451 or->set_attr.total_bytes = set_one_attr->len;
1453 cdbh->attrs_page.set_attr_page = cpu_to_be32(set_one_attr->attr_page);
1454 cdbh->attrs_page.set_attr_id = cpu_to_be32(set_one_attr->attr_id);
1455 cdbh->attrs_page.set_attr_length = cpu_to_be32(set_one_attr->len);
1458 EXPORT_SYMBOL(osd_req_add_get_attr_page);
1460 static int _osd_req_finalize_attr_page(struct osd_request *or)
1462 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1463 unsigned in_padding, out_padding;
1467 cdbh->attrs_page.get_attr_offset =
1468 osd_req_encode_offset(or, or->in.total_bytes, &in_padding);
1470 ret = _req_append_segment(or, in_padding, &or->get_attr, NULL,
1475 if (or->set_attr.total_bytes == 0)
1479 cdbh->attrs_page.set_attr_offset =
1480 osd_req_encode_offset(or, or->out.total_bytes, &out_padding);
1482 ret = _req_append_segment(or, out_padding, &or->set_attr, NULL,
1487 static inline void osd_sec_parms_set_out_offset(bool is_v1,
1488 struct osd_security_parameters *sec_parms, osd_cdb_offset offset)
1491 sec_parms->v1.data_out_integrity_check_offset = offset;
1493 sec_parms->v2.data_out_integrity_check_offset = offset;
1496 static inline void osd_sec_parms_set_in_offset(bool is_v1,
1497 struct osd_security_parameters *sec_parms, osd_cdb_offset offset)
1500 sec_parms->v1.data_in_integrity_check_offset = offset;
1502 sec_parms->v2.data_in_integrity_check_offset = offset;
1505 static int _osd_req_finalize_data_integrity(struct osd_request *or,
1506 bool has_in, bool has_out, struct bio *out_data_bio, u64 out_data_bytes,
1509 struct osd_security_parameters *sec_parms = _osd_req_sec_params(or);
1512 if (!osd_is_sec_alldata(sec_parms))
1516 struct _osd_req_data_segment seg = {
1517 .buff = &or->out_data_integ,
1518 .total_bytes = sizeof(or->out_data_integ),
1522 or->out_data_integ.data_bytes = cpu_to_be64(out_data_bytes);
1523 or->out_data_integ.set_attributes_bytes = cpu_to_be64(
1524 or->set_attr.total_bytes);
1525 or->out_data_integ.get_attributes_bytes = cpu_to_be64(
1526 or->enc_get_attr.total_bytes);
1528 osd_sec_parms_set_out_offset(osd_req_is_ver1(or), sec_parms,
1529 osd_req_encode_offset(or, or->out.total_bytes, &pad));
1531 ret = _req_append_segment(or, pad, &seg, or->out.last_seg,
1535 or->out.last_seg = NULL;
1537 /* they are now all chained to request sign them all together */
1538 osd_sec_sign_data(&or->out_data_integ, out_data_bio,
1543 struct _osd_req_data_segment seg = {
1544 .buff = &or->in_data_integ,
1545 .total_bytes = sizeof(or->in_data_integ),
1549 osd_sec_parms_set_in_offset(osd_req_is_ver1(or), sec_parms,
1550 osd_req_encode_offset(or, or->in.total_bytes, &pad));
1552 ret = _req_append_segment(or, pad, &seg, or->in.last_seg,
1557 or->in.last_seg = NULL;
1564 * osd_finalize_request and helpers
1566 static struct request *_make_request(struct request_queue *q, bool has_write,
1567 struct _osd_io_info *oii, gfp_t flags)
1569 struct request *req;
1570 struct bio *bio = oii->bio;
1573 req = blk_get_request(q, has_write ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN,
1580 struct bio *bounce_bio = bio;
1582 blk_queue_bounce(req->q, &bounce_bio);
1583 ret = blk_rq_append_bio(req, bounce_bio);
1585 return ERR_PTR(ret);
1591 static int _init_blk_request(struct osd_request *or,
1592 bool has_in, bool has_out)
1594 gfp_t flags = or->alloc_flags;
1595 struct scsi_device *scsi_device = or->osd_dev->scsi_device;
1596 struct request_queue *q = scsi_device->request_queue;
1597 struct request *req;
1600 req = _make_request(q, has_out, has_out ? &or->out : &or->in, flags);
1607 req->rq_flags |= RQF_QUIET;
1609 req->timeout = or->timeout;
1610 scsi_req(req)->retries = or->retries;
1615 /* allocate bidi request */
1616 req = _make_request(q, false, &or->in, flags);
1618 OSD_DEBUG("blk_get_request for bidi failed\n");
1623 or->in.req = or->request->next_rq = req;
1630 OSD_DEBUG("or=%p has_in=%d has_out=%d => %d, %p\n",
1631 or, has_in, has_out, ret, or->request);
1635 int osd_finalize_request(struct osd_request *or,
1636 u8 options, const void *cap, const u8 *cap_key)
1638 struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1639 bool has_in, has_out;
1640 /* Save for data_integrity without the cdb_continuation */
1641 struct bio *out_data_bio = or->out.bio;
1642 u64 out_data_bytes = or->out.total_bytes;
1645 if (options & OSD_REQ_FUA)
1646 cdbh->options |= OSD_CDB_FUA;
1648 if (options & OSD_REQ_DPO)
1649 cdbh->options |= OSD_CDB_DPO;
1651 if (options & OSD_REQ_BYPASS_TIMESTAMPS)
1652 cdbh->timestamp_control = OSD_CDB_BYPASS_TIMESTAMPS;
1654 osd_set_caps(&or->cdb, cap);
1656 has_in = or->in.bio || or->get_attr.total_bytes;
1657 has_out = or->out.bio || or->cdb_cont.total_bytes ||
1658 or->set_attr.total_bytes || or->enc_get_attr.total_bytes;
1660 ret = _osd_req_finalize_cdb_cont(or, cap_key);
1662 OSD_DEBUG("_osd_req_finalize_cdb_cont failed\n");
1665 ret = _init_blk_request(or, has_in, has_out);
1667 OSD_DEBUG("_init_blk_request failed\n");
1671 or->out.pad_buff = sg_out_pad_buffer;
1672 or->in.pad_buff = sg_in_pad_buffer;
1674 if (!or->attributes_mode)
1675 or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
1676 cdbh->command_specific_options |= or->attributes_mode;
1677 if (or->attributes_mode == OSD_CDB_GET_ATTR_PAGE_SET_ONE) {
1678 ret = _osd_req_finalize_attr_page(or);
1680 OSD_DEBUG("_osd_req_finalize_attr_page failed\n");
1684 /* TODO: I think that for the GET_ATTR command these 2 should
1685 * be reversed to keep them in execution order (for embedded
1686 * targets with low memory footprint)
1688 ret = _osd_req_finalize_set_attr_list(or);
1690 OSD_DEBUG("_osd_req_finalize_set_attr_list failed\n");
1694 ret = _osd_req_finalize_get_attr_list(or);
1696 OSD_DEBUG("_osd_req_finalize_get_attr_list failed\n");
1701 ret = _osd_req_finalize_data_integrity(or, has_in, has_out,
1702 out_data_bio, out_data_bytes,
1707 osd_sec_sign_cdb(&or->cdb, cap_key);
1709 scsi_req(or->request)->cmd = or->cdb.buff;
1710 scsi_req(or->request)->cmd_len = _osd_req_cdb_len(or);
1714 EXPORT_SYMBOL(osd_finalize_request);
1716 static bool _is_osd_security_code(int code)
1718 return (code == osd_security_audit_value_frozen) ||
1719 (code == osd_security_working_key_frozen) ||
1720 (code == osd_nonce_not_unique) ||
1721 (code == osd_nonce_timestamp_out_of_range) ||
1722 (code == osd_invalid_dataout_buffer_integrity_check_value);
1725 #define OSD_SENSE_PRINT1(fmt, a...) \
1727 if (__cur_sense_need_output) \
1728 OSD_ERR(fmt, ##a); \
1731 #define OSD_SENSE_PRINT2(fmt, a...) OSD_SENSE_PRINT1(" " fmt, ##a)
1733 int osd_req_decode_sense_full(struct osd_request *or,
1734 struct osd_sense_info *osi, bool silent,
1735 struct osd_obj_id *bad_obj_list __unused, int max_obj __unused,
1736 struct osd_attr *bad_attr_list, int max_attr)
1738 int sense_len, original_sense_len;
1739 struct osd_sense_info local_osi;
1740 struct scsi_sense_descriptor_based *ssdb;
1741 void *cur_descriptor;
1742 #if (CONFIG_SCSI_OSD_DPRINT_SENSE == 0)
1743 const bool __cur_sense_need_output = false;
1745 bool __cur_sense_need_output = !silent;
1749 if (likely(!or->req_errors))
1752 osi = osi ? : &local_osi;
1753 memset(osi, 0, sizeof(*osi));
1755 ssdb = (typeof(ssdb))or->sense;
1756 sense_len = or->sense_len;
1757 if ((sense_len < (int)sizeof(*ssdb) || !ssdb->sense_key)) {
1758 OSD_ERR("Block-layer returned error(0x%x) but "
1759 "sense_len(%u) || key(%d) is empty\n",
1760 or->req_errors, sense_len, ssdb->sense_key);
1764 if ((ssdb->response_code != 0x72) && (ssdb->response_code != 0x73)) {
1765 OSD_ERR("Unrecognized scsi sense: rcode=%x length=%d\n",
1766 ssdb->response_code, sense_len);
1770 osi->key = ssdb->sense_key;
1771 osi->additional_code = be16_to_cpu(ssdb->additional_sense_code);
1772 original_sense_len = ssdb->additional_sense_length + 8;
1774 #if (CONFIG_SCSI_OSD_DPRINT_SENSE == 1)
1775 if (__cur_sense_need_output)
1776 __cur_sense_need_output = (osi->key > scsi_sk_recovered_error);
1778 OSD_SENSE_PRINT1("Main Sense information key=0x%x length(%d, %d) "
1779 "additional_code=0x%x async_error=%d errors=0x%x\n",
1780 osi->key, original_sense_len, sense_len,
1781 osi->additional_code, or->async_error,
1784 if (original_sense_len < sense_len)
1785 sense_len = original_sense_len;
1787 cur_descriptor = ssdb->ssd;
1788 sense_len -= sizeof(*ssdb);
1789 while (sense_len > 0) {
1790 struct scsi_sense_descriptor *ssd = cur_descriptor;
1791 int cur_len = ssd->additional_length + 2;
1793 sense_len -= cur_len;
1796 break; /* sense was truncated */
1798 switch (ssd->descriptor_type) {
1799 case scsi_sense_information:
1800 case scsi_sense_command_specific_information:
1802 struct scsi_sense_command_specific_data_descriptor
1803 *sscd = cur_descriptor;
1806 get_unaligned_be64(&sscd->information) ;
1808 "command_specific_information 0x%llx \n",
1809 _LLU(osi->command_info));
1812 case scsi_sense_key_specific:
1814 struct scsi_sense_key_specific_data_descriptor
1815 *ssks = cur_descriptor;
1817 osi->sense_info = get_unaligned_be16(&ssks->value);
1819 "sense_key_specific_information %u"
1820 "sksv_cd_bpv_bp (0x%x)\n",
1821 osi->sense_info, ssks->sksv_cd_bpv_bp);
1824 case osd_sense_object_identification:
1825 { /*FIXME: Keep first not last, Store in array*/
1826 struct osd_sense_identification_data_descriptor
1827 *osidd = cur_descriptor;
1829 osi->not_initiated_command_functions =
1830 le32_to_cpu(osidd->not_initiated_functions);
1831 osi->completed_command_functions =
1832 le32_to_cpu(osidd->completed_functions);
1833 osi->obj.partition = be64_to_cpu(osidd->partition_id);
1834 osi->obj.id = be64_to_cpu(osidd->object_id);
1836 "object_identification pid=0x%llx oid=0x%llx\n",
1837 _LLU(osi->obj.partition), _LLU(osi->obj.id));
1839 "not_initiated_bits(%x) "
1840 "completed_command_bits(%x)\n",
1841 osi->not_initiated_command_functions,
1842 osi->completed_command_functions);
1845 case osd_sense_response_integrity_check:
1847 struct osd_sense_response_integrity_check_descriptor
1848 *osricd = cur_descriptor;
1849 const unsigned len =
1850 sizeof(osricd->integrity_check_value);
1851 char key_dump[len*4 + 2]; /* 2nibbles+space+ASCII */
1853 hex_dump_to_buffer(osricd->integrity_check_value, len,
1854 32, 1, key_dump, sizeof(key_dump), true);
1855 OSD_SENSE_PRINT2("response_integrity [%s]\n", key_dump);
1857 case osd_sense_attribute_identification:
1859 struct osd_sense_attributes_data_descriptor
1860 *osadd = cur_descriptor;
1861 unsigned len = min(cur_len, sense_len);
1862 struct osd_sense_attr *pattr = osadd->sense_attrs;
1864 while (len >= sizeof(*pattr)) {
1865 u32 attr_page = be32_to_cpu(pattr->attr_page);
1866 u32 attr_id = be32_to_cpu(pattr->attr_id);
1868 if (!osi->attr.attr_page) {
1869 osi->attr.attr_page = attr_page;
1870 osi->attr.attr_id = attr_id;
1873 if (bad_attr_list && max_attr) {
1874 bad_attr_list->attr_page = attr_page;
1875 bad_attr_list->attr_id = attr_id;
1880 len -= sizeof(*pattr);
1882 "osd_sense_attribute_identification"
1883 "attr_page=0x%x attr_id=0x%x\n",
1884 attr_page, attr_id);
1887 /*These are not legal for OSD*/
1888 case scsi_sense_field_replaceable_unit:
1889 OSD_SENSE_PRINT2("scsi_sense_field_replaceable_unit\n");
1891 case scsi_sense_stream_commands:
1892 OSD_SENSE_PRINT2("scsi_sense_stream_commands\n");
1894 case scsi_sense_block_commands:
1895 OSD_SENSE_PRINT2("scsi_sense_block_commands\n");
1897 case scsi_sense_ata_return:
1898 OSD_SENSE_PRINT2("scsi_sense_ata_return\n");
1901 if (ssd->descriptor_type <= scsi_sense_Reserved_last)
1903 "scsi_sense Reserved descriptor (0x%x)",
1904 ssd->descriptor_type);
1907 "scsi_sense Vendor descriptor (0x%x)",
1908 ssd->descriptor_type);
1911 cur_descriptor += cur_len;
1916 /* scsi sense is Empty, the request was never issued to target
1917 * linux return code might tell us what happened.
1919 if (or->async_error == BLK_STS_RESOURCE)
1920 osi->osd_err_pri = OSD_ERR_PRI_RESOURCE;
1922 osi->osd_err_pri = OSD_ERR_PRI_UNREACHABLE;
1923 ret = or->async_error;
1924 } else if (osi->key <= scsi_sk_recovered_error) {
1925 osi->osd_err_pri = 0;
1927 } else if (osi->additional_code == scsi_invalid_field_in_cdb) {
1928 if (osi->cdb_field_offset == OSD_CFO_STARTING_BYTE) {
1929 osi->osd_err_pri = OSD_ERR_PRI_CLEAR_PAGES;
1930 ret = -EFAULT; /* caller should recover from this */
1931 } else if (osi->cdb_field_offset == OSD_CFO_OBJECT_ID) {
1932 osi->osd_err_pri = OSD_ERR_PRI_NOT_FOUND;
1934 } else if (osi->cdb_field_offset == OSD_CFO_PERMISSIONS) {
1935 osi->osd_err_pri = OSD_ERR_PRI_NO_ACCESS;
1938 osi->osd_err_pri = OSD_ERR_PRI_BAD_CRED;
1941 } else if (osi->additional_code == osd_quota_error) {
1942 osi->osd_err_pri = OSD_ERR_PRI_NO_SPACE;
1944 } else if (_is_osd_security_code(osi->additional_code)) {
1945 osi->osd_err_pri = OSD_ERR_PRI_BAD_CRED;
1948 osi->osd_err_pri = OSD_ERR_PRI_EIO;
1952 if (!or->out.residual)
1953 or->out.residual = or->out.total_bytes;
1954 if (!or->in.residual)
1955 or->in.residual = or->in.total_bytes;
1959 EXPORT_SYMBOL(osd_req_decode_sense_full);
1962 * Implementation of osd_sec.h API
1963 * TODO: Move to a separate osd_sec.c file at a later stage.
1966 enum { OSD_SEC_CAP_V1_ALL_CAPS =
1967 OSD_SEC_CAP_APPEND | OSD_SEC_CAP_OBJ_MGMT | OSD_SEC_CAP_REMOVE |
1968 OSD_SEC_CAP_CREATE | OSD_SEC_CAP_SET_ATTR | OSD_SEC_CAP_GET_ATTR |
1969 OSD_SEC_CAP_WRITE | OSD_SEC_CAP_READ | OSD_SEC_CAP_POL_SEC |
1970 OSD_SEC_CAP_GLOBAL | OSD_SEC_CAP_DEV_MGMT
1973 enum { OSD_SEC_CAP_V2_ALL_CAPS =
1974 OSD_SEC_CAP_V1_ALL_CAPS | OSD_SEC_CAP_QUERY | OSD_SEC_CAP_M_OBJECT
1977 void osd_sec_init_nosec_doall_caps(void *caps,
1978 const struct osd_obj_id *obj, bool is_collection, const bool is_v1)
1980 struct osd_capability *cap = caps;
1984 if (likely(obj->id)) {
1985 if (unlikely(is_collection)) {
1986 type = OSD_SEC_OBJ_COLLECTION;
1987 descriptor_type = is_v1 ? OSD_SEC_OBJ_DESC_OBJ :
1988 OSD_SEC_OBJ_DESC_COL;
1990 type = OSD_SEC_OBJ_USER;
1991 descriptor_type = OSD_SEC_OBJ_DESC_OBJ;
1993 WARN_ON(!obj->partition);
1995 type = obj->partition ? OSD_SEC_OBJ_PARTITION :
1997 descriptor_type = OSD_SEC_OBJ_DESC_PAR;
2000 memset(cap, 0, sizeof(*cap));
2002 cap->h.format = OSD_SEC_CAP_FORMAT_VER1;
2003 cap->h.integrity_algorithm__key_version = 0; /* MAKE_BYTE(0, 0); */
2004 cap->h.security_method = OSD_SEC_NOSEC;
2005 /* cap->expiration_time;
2007 cap->discriminator[42-30];
2008 cap->object_created_time; */
2009 cap->h.object_type = type;
2010 osd_sec_set_caps(&cap->h, OSD_SEC_CAP_V1_ALL_CAPS);
2011 cap->h.object_descriptor_type = descriptor_type;
2012 cap->od.obj_desc.policy_access_tag = 0;
2013 cap->od.obj_desc.allowed_partition_id = cpu_to_be64(obj->partition);
2014 cap->od.obj_desc.allowed_object_id = cpu_to_be64(obj->id);
2016 EXPORT_SYMBOL(osd_sec_init_nosec_doall_caps);
2018 /* FIXME: Extract version from caps pointer.
2019 * Also Pete's target only supports caps from OSDv1 for now
2021 void osd_set_caps(struct osd_cdb *cdb, const void *caps)
2023 /* NOTE: They start at same address */
2024 memcpy(&cdb->v1.caps, caps, OSDv1_CAP_LEN);
2027 bool osd_is_sec_alldata(struct osd_security_parameters *sec_parms __unused)
2032 void osd_sec_sign_cdb(struct osd_cdb *ocdb __unused, const u8 *cap_key __unused)
2036 void osd_sec_sign_data(void *data_integ __unused,
2037 struct bio *bio __unused, const u8 *cap_key __unused)
2042 * Declared in osd_protocol.h
2043 * 4.12.5 Data-In and Data-Out buffer offsets
2044 * byte offset = mantissa * (2^(exponent+8))
2045 * Returns the smallest allowed encoded offset that contains given @offset
2046 * The actual encoded offset returned is @offset + *@padding.
2048 osd_cdb_offset __osd_encode_offset(
2049 u64 offset, unsigned *padding, int min_shift, int max_shift)
2051 u64 try_offset = -1, mod, align;
2052 osd_cdb_offset be32_offset;
2059 for (shift = min_shift; shift < max_shift; ++shift) {
2060 try_offset = offset >> shift;
2061 if (try_offset < (1 << OSD_OFFSET_MAX_BITS))
2065 BUG_ON(shift == max_shift);
2068 mod = offset & (align - 1);
2070 *padding = align - mod;
2074 try_offset |= ((shift - 8) & 0xf) << 28;
2075 be32_offset = cpu_to_be32((u32)try_offset);
2077 OSD_DEBUG("offset=%llu mantissa=%llu exp=%d encoded=%x pad=%d\n",
2078 _LLU(offset), _LLU(try_offset & 0x0FFFFFFF), shift,
2079 be32_offset, *padding);