linux/drivers/scsi/osd/osd_initiator.c
<<
>>
Prefs
   1/*
   2 * osd_initiator - Main body of the osd initiator library.
   3 *
   4 * Note: The file does not contain the advanced security functionality which
   5 * is only needed by the security_manager's initiators.
   6 *
   7 * Copyright (C) 2008 Panasas Inc.  All rights reserved.
   8 *
   9 * Authors:
  10 *   Boaz Harrosh <ooo@electrozaur.com>
  11 *   Benny Halevy <bhalevy@panasas.com>
  12 *
  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
  15 *
  16 * Redistribution and use in source and binary forms, with or without
  17 * modification, are permitted provided that the following conditions
  18 * are met:
  19 *
  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.
  28 *
  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.
  40 */
  41
  42#include <linux/slab.h>
  43#include <linux/module.h>
  44
  45#include <scsi/osd_initiator.h>
  46#include <scsi/osd_sec.h>
  47#include <scsi/osd_attributes.h>
  48#include <scsi/osd_sense.h>
  49
  50#include <scsi/scsi_device.h>
  51
  52#include "osd_debug.h"
  53
  54#ifndef __unused
  55#    define __unused                    __attribute__((unused))
  56#endif
  57
  58enum { OSD_REQ_RETRIES = 1 };
  59
  60MODULE_AUTHOR("Boaz Harrosh <ooo@electrozaur.com>");
  61MODULE_DESCRIPTION("open-osd initiator library libosd.ko");
  62MODULE_LICENSE("GPL");
  63
  64static inline void build_test(void)
  65{
  66        /* structures were not packed */
  67        BUILD_BUG_ON(sizeof(struct osd_capability) != OSD_CAP_LEN);
  68        BUILD_BUG_ON(sizeof(struct osdv2_cdb) != OSD_TOTAL_CDB_LEN);
  69        BUILD_BUG_ON(sizeof(struct osdv1_cdb) != OSDv1_TOTAL_CDB_LEN);
  70}
  71
  72static const char *_osd_ver_desc(struct osd_request *or)
  73{
  74        return osd_req_is_ver1(or) ? "OSD1" : "OSD2";
  75}
  76
  77#define ATTR_DEF_RI(id, len) ATTR_DEF(OSD_APAGE_ROOT_INFORMATION, id, len)
  78
  79static int _osd_get_print_system_info(struct osd_dev *od,
  80        void *caps, struct osd_dev_info *odi)
  81{
  82        struct osd_request *or;
  83        struct osd_attr get_attrs[] = {
  84                ATTR_DEF_RI(OSD_ATTR_RI_VENDOR_IDENTIFICATION, 8),
  85                ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_IDENTIFICATION, 16),
  86                ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_MODEL, 32),
  87                ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_REVISION_LEVEL, 4),
  88                ATTR_DEF_RI(OSD_ATTR_RI_PRODUCT_SERIAL_NUMBER, 64 /*variable*/),
  89                ATTR_DEF_RI(OSD_ATTR_RI_OSD_NAME, 64 /*variable*/),
  90                ATTR_DEF_RI(OSD_ATTR_RI_TOTAL_CAPACITY, 8),
  91                ATTR_DEF_RI(OSD_ATTR_RI_USED_CAPACITY, 8),
  92                ATTR_DEF_RI(OSD_ATTR_RI_NUMBER_OF_PARTITIONS, 8),
  93                ATTR_DEF_RI(OSD_ATTR_RI_CLOCK, 6),
  94                /* IBM-OSD-SIM Has a bug with this one put it last */
  95                ATTR_DEF_RI(OSD_ATTR_RI_OSD_SYSTEM_ID, 20),
  96        };
  97        void *iter = NULL, *pFirst;
  98        int nelem = ARRAY_SIZE(get_attrs), a = 0;
  99        int ret;
 100
 101        or = osd_start_request(od, GFP_KERNEL);
 102        if (!or)
 103                return -ENOMEM;
 104
 105        /* get attrs */
 106        osd_req_get_attributes(or, &osd_root_object);
 107        osd_req_add_get_attr_list(or, get_attrs, ARRAY_SIZE(get_attrs));
 108
 109        ret = osd_finalize_request(or, 0, caps, NULL);
 110        if (ret)
 111                goto out;
 112
 113        ret = osd_execute_request(or);
 114        if (ret) {
 115                OSD_ERR("Failed to detect %s => %d\n", _osd_ver_desc(or), ret);
 116                goto out;
 117        }
 118
 119        osd_req_decode_get_attr_list(or, get_attrs, &nelem, &iter);
 120
 121        OSD_INFO("Detected %s device\n",
 122                _osd_ver_desc(or));
 123
 124        pFirst = get_attrs[a++].val_ptr;
 125        OSD_INFO("VENDOR_IDENTIFICATION  [%s]\n",
 126                (char *)pFirst);
 127
 128        pFirst = get_attrs[a++].val_ptr;
 129        OSD_INFO("PRODUCT_IDENTIFICATION [%s]\n",
 130                (char *)pFirst);
 131
 132        pFirst = get_attrs[a++].val_ptr;
 133        OSD_INFO("PRODUCT_MODEL          [%s]\n",
 134                (char *)pFirst);
 135
 136        pFirst = get_attrs[a++].val_ptr;
 137        OSD_INFO("PRODUCT_REVISION_LEVEL [%u]\n",
 138                pFirst ? get_unaligned_be32(pFirst) : ~0U);
 139
 140        pFirst = get_attrs[a++].val_ptr;
 141        OSD_INFO("PRODUCT_SERIAL_NUMBER  [%s]\n",
 142                (char *)pFirst);
 143
 144        odi->osdname_len = get_attrs[a].len;
 145        /* Avoid NULL for memcmp optimization 0-length is good enough */
 146        odi->osdname = kzalloc(odi->osdname_len + 1, GFP_KERNEL);
 147        if (!odi->osdname) {
 148                ret = -ENOMEM;
 149                goto out;
 150        }
 151        if (odi->osdname_len)
 152                memcpy(odi->osdname, get_attrs[a].val_ptr, odi->osdname_len);
 153        OSD_INFO("OSD_NAME               [%s]\n", odi->osdname);
 154        a++;
 155
 156        pFirst = get_attrs[a++].val_ptr;
 157        OSD_INFO("TOTAL_CAPACITY         [0x%llx]\n",
 158                pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
 159
 160        pFirst = get_attrs[a++].val_ptr;
 161        OSD_INFO("USED_CAPACITY          [0x%llx]\n",
 162                pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
 163
 164        pFirst = get_attrs[a++].val_ptr;
 165        OSD_INFO("NUMBER_OF_PARTITIONS   [%llu]\n",
 166                pFirst ? _LLU(get_unaligned_be64(pFirst)) : ~0ULL);
 167
 168        if (a >= nelem)
 169                goto out;
 170
 171        /* FIXME: Where are the time utilities */
 172        pFirst = get_attrs[a++].val_ptr;
 173        OSD_INFO("CLOCK                  [0x%6phN]\n", pFirst);
 174
 175        if (a < nelem) { /* IBM-OSD-SIM bug, Might not have it */
 176                unsigned len = get_attrs[a].len;
 177                char sid_dump[32*4 + 2]; /* 2nibbles+space+ASCII */
 178
 179                hex_dump_to_buffer(get_attrs[a].val_ptr, len, 32, 1,
 180                                   sid_dump, sizeof(sid_dump), true);
 181                OSD_INFO("OSD_SYSTEM_ID(%d)\n"
 182                         "        [%s]\n", len, sid_dump);
 183
 184                if (unlikely(len > sizeof(odi->systemid))) {
 185                        OSD_ERR("OSD Target error: OSD_SYSTEM_ID too long(%d). "
 186                                "device identification might not work\n", len);
 187                        len = sizeof(odi->systemid);
 188                }
 189                odi->systemid_len = len;
 190                memcpy(odi->systemid, get_attrs[a].val_ptr, len);
 191                a++;
 192        }
 193out:
 194        osd_end_request(or);
 195        return ret;
 196}
 197
 198int osd_auto_detect_ver(struct osd_dev *od,
 199        void *caps, struct osd_dev_info *odi)
 200{
 201        int ret;
 202
 203        /* Auto-detect the osd version */
 204        ret = _osd_get_print_system_info(od, caps, odi);
 205        if (ret) {
 206                osd_dev_set_ver(od, OSD_VER1);
 207                OSD_DEBUG("converting to OSD1\n");
 208                ret = _osd_get_print_system_info(od, caps, odi);
 209        }
 210
 211        return ret;
 212}
 213EXPORT_SYMBOL(osd_auto_detect_ver);
 214
 215static unsigned _osd_req_cdb_len(struct osd_request *or)
 216{
 217        return osd_req_is_ver1(or) ? OSDv1_TOTAL_CDB_LEN : OSD_TOTAL_CDB_LEN;
 218}
 219
 220static unsigned _osd_req_alist_elem_size(struct osd_request *or, unsigned len)
 221{
 222        return osd_req_is_ver1(or) ?
 223                osdv1_attr_list_elem_size(len) :
 224                osdv2_attr_list_elem_size(len);
 225}
 226
 227static void _osd_req_alist_elem_encode(struct osd_request *or,
 228        void *attr_last, const struct osd_attr *oa)
 229{
 230        if (osd_req_is_ver1(or)) {
 231                struct osdv1_attributes_list_element *attr = attr_last;
 232
 233                attr->attr_page = cpu_to_be32(oa->attr_page);
 234                attr->attr_id = cpu_to_be32(oa->attr_id);
 235                attr->attr_bytes = cpu_to_be16(oa->len);
 236                memcpy(attr->attr_val, oa->val_ptr, oa->len);
 237        } else {
 238                struct osdv2_attributes_list_element *attr = attr_last;
 239
 240                attr->attr_page = cpu_to_be32(oa->attr_page);
 241                attr->attr_id = cpu_to_be32(oa->attr_id);
 242                attr->attr_bytes = cpu_to_be16(oa->len);
 243                memcpy(attr->attr_val, oa->val_ptr, oa->len);
 244        }
 245}
 246
 247static int _osd_req_alist_elem_decode(struct osd_request *or,
 248        void *cur_p, struct osd_attr *oa, unsigned max_bytes)
 249{
 250        unsigned inc;
 251        if (osd_req_is_ver1(or)) {
 252                struct osdv1_attributes_list_element *attr = cur_p;
 253
 254                if (max_bytes < sizeof(*attr))
 255                        return -1;
 256
 257                oa->len = be16_to_cpu(attr->attr_bytes);
 258                inc = _osd_req_alist_elem_size(or, oa->len);
 259                if (inc > max_bytes)
 260                        return -1;
 261
 262                oa->attr_page = be32_to_cpu(attr->attr_page);
 263                oa->attr_id = be32_to_cpu(attr->attr_id);
 264
 265                /* OSD1: On empty attributes we return a pointer to 2 bytes
 266                 * of zeros. This keeps similar behaviour with OSD2.
 267                 * (See below)
 268                 */
 269                oa->val_ptr = likely(oa->len) ? attr->attr_val :
 270                                                (u8 *)&attr->attr_bytes;
 271        } else {
 272                struct osdv2_attributes_list_element *attr = cur_p;
 273
 274                if (max_bytes < sizeof(*attr))
 275                        return -1;
 276
 277                oa->len = be16_to_cpu(attr->attr_bytes);
 278                inc = _osd_req_alist_elem_size(or, oa->len);
 279                if (inc > max_bytes)
 280                        return -1;
 281
 282                oa->attr_page = be32_to_cpu(attr->attr_page);
 283                oa->attr_id = be32_to_cpu(attr->attr_id);
 284
 285                /* OSD2: For convenience, on empty attributes, we return 8 bytes
 286                 * of zeros here. This keeps the same behaviour with OSD2r04,
 287                 * and is nice with null terminating ASCII fields.
 288                 * oa->val_ptr == NULL marks the end-of-list, or error.
 289                 */
 290                oa->val_ptr = likely(oa->len) ? attr->attr_val : attr->reserved;
 291        }
 292        return inc;
 293}
 294
 295static unsigned _osd_req_alist_size(struct osd_request *or, void *list_head)
 296{
 297        return osd_req_is_ver1(or) ?
 298                osdv1_list_size(list_head) :
 299                osdv2_list_size(list_head);
 300}
 301
 302static unsigned _osd_req_sizeof_alist_header(struct osd_request *or)
 303{
 304        return osd_req_is_ver1(or) ?
 305                sizeof(struct osdv1_attributes_list_header) :
 306                sizeof(struct osdv2_attributes_list_header);
 307}
 308
 309static void _osd_req_set_alist_type(struct osd_request *or,
 310        void *list, int list_type)
 311{
 312        if (osd_req_is_ver1(or)) {
 313                struct osdv1_attributes_list_header *attr_list = list;
 314
 315                memset(attr_list, 0, sizeof(*attr_list));
 316                attr_list->type = list_type;
 317        } else {
 318                struct osdv2_attributes_list_header *attr_list = list;
 319
 320                memset(attr_list, 0, sizeof(*attr_list));
 321                attr_list->type = list_type;
 322        }
 323}
 324
 325static bool _osd_req_is_alist_type(struct osd_request *or,
 326        void *list, int list_type)
 327{
 328        if (!list)
 329                return false;
 330
 331        if (osd_req_is_ver1(or)) {
 332                struct osdv1_attributes_list_header *attr_list = list;
 333
 334                return attr_list->type == list_type;
 335        } else {
 336                struct osdv2_attributes_list_header *attr_list = list;
 337
 338                return attr_list->type == list_type;
 339        }
 340}
 341
 342/* This is for List-objects not Attributes-Lists */
 343static void _osd_req_encode_olist(struct osd_request *or,
 344        struct osd_obj_id_list *list)
 345{
 346        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
 347
 348        if (osd_req_is_ver1(or)) {
 349                cdbh->v1.list_identifier = list->list_identifier;
 350                cdbh->v1.start_address = list->continuation_id;
 351        } else {
 352                cdbh->v2.list_identifier = list->list_identifier;
 353                cdbh->v2.start_address = list->continuation_id;
 354        }
 355}
 356
 357static osd_cdb_offset osd_req_encode_offset(struct osd_request *or,
 358        u64 offset, unsigned *padding)
 359{
 360        return __osd_encode_offset(offset, padding,
 361                        osd_req_is_ver1(or) ?
 362                                OSDv1_OFFSET_MIN_SHIFT : OSD_OFFSET_MIN_SHIFT,
 363                        OSD_OFFSET_MAX_SHIFT);
 364}
 365
 366static struct osd_security_parameters *
 367_osd_req_sec_params(struct osd_request *or)
 368{
 369        struct osd_cdb *ocdb = &or->cdb;
 370
 371        if (osd_req_is_ver1(or))
 372                return (struct osd_security_parameters *)&ocdb->v1.sec_params;
 373        else
 374                return (struct osd_security_parameters *)&ocdb->v2.sec_params;
 375}
 376
 377void osd_dev_init(struct osd_dev *osdd, struct scsi_device *scsi_device)
 378{
 379        memset(osdd, 0, sizeof(*osdd));
 380        osdd->scsi_device = scsi_device;
 381        osdd->def_timeout = BLK_DEFAULT_SG_TIMEOUT;
 382#ifdef OSD_VER1_SUPPORT
 383        osdd->version = OSD_VER2;
 384#endif
 385        /* TODO: Allocate pools for osd_request attributes ... */
 386}
 387EXPORT_SYMBOL(osd_dev_init);
 388
 389void osd_dev_fini(struct osd_dev *osdd)
 390{
 391        /* TODO: De-allocate pools */
 392
 393        osdd->scsi_device = NULL;
 394}
 395EXPORT_SYMBOL(osd_dev_fini);
 396
 397static struct osd_request *_osd_request_alloc(gfp_t gfp)
 398{
 399        struct osd_request *or;
 400
 401        /* TODO: Use mempool with one saved request */
 402        or = kzalloc(sizeof(*or), gfp);
 403        return or;
 404}
 405
 406static void _osd_request_free(struct osd_request *or)
 407{
 408        kfree(or);
 409}
 410
 411struct osd_request *osd_start_request(struct osd_dev *dev, gfp_t gfp)
 412{
 413        struct osd_request *or;
 414
 415        or = _osd_request_alloc(gfp);
 416        if (!or)
 417                return NULL;
 418
 419        or->osd_dev = dev;
 420        or->alloc_flags = gfp;
 421        or->timeout = dev->def_timeout;
 422        or->retries = OSD_REQ_RETRIES;
 423
 424        return or;
 425}
 426EXPORT_SYMBOL(osd_start_request);
 427
 428static void _osd_free_seg(struct osd_request *or __unused,
 429        struct _osd_req_data_segment *seg)
 430{
 431        if (!seg->buff || !seg->alloc_size)
 432                return;
 433
 434        kfree(seg->buff);
 435        seg->buff = NULL;
 436        seg->alloc_size = 0;
 437}
 438
 439static void _put_request(struct request *rq)
 440{
 441        /*
 442         * If osd_finalize_request() was called but the request was not
 443         * executed through the block layer, then we must release BIOs.
 444         * TODO: Keep error code in or->async_error. Need to audit all
 445         *       code paths.
 446         */
 447        if (unlikely(rq->bio))
 448                blk_end_request(rq, -ENOMEM, blk_rq_bytes(rq));
 449        else
 450                blk_put_request(rq);
 451}
 452
 453void osd_end_request(struct osd_request *or)
 454{
 455        struct request *rq = or->request;
 456
 457        if (rq) {
 458                if (rq->next_rq) {
 459                        _put_request(rq->next_rq);
 460                        rq->next_rq = NULL;
 461                }
 462
 463                _put_request(rq);
 464        }
 465
 466        _osd_free_seg(or, &or->get_attr);
 467        _osd_free_seg(or, &or->enc_get_attr);
 468        _osd_free_seg(or, &or->set_attr);
 469        _osd_free_seg(or, &or->cdb_cont);
 470
 471        _osd_request_free(or);
 472}
 473EXPORT_SYMBOL(osd_end_request);
 474
 475static void _set_error_resid(struct osd_request *or, struct request *req,
 476                             int error)
 477{
 478        or->async_error = error;
 479        or->req_errors = req->errors ? : error;
 480        or->sense_len = req->sense_len;
 481        if (or->out.req)
 482                or->out.residual = or->out.req->resid_len;
 483        if (or->in.req)
 484                or->in.residual = or->in.req->resid_len;
 485}
 486
 487int osd_execute_request(struct osd_request *or)
 488{
 489        int error = blk_execute_rq(or->request->q, NULL, or->request, 0);
 490
 491        _set_error_resid(or, or->request, error);
 492        return error;
 493}
 494EXPORT_SYMBOL(osd_execute_request);
 495
 496static void osd_request_async_done(struct request *req, int error)
 497{
 498        struct osd_request *or = req->end_io_data;
 499
 500        _set_error_resid(or, req, error);
 501        if (req->next_rq) {
 502                __blk_put_request(req->q, req->next_rq);
 503                req->next_rq = NULL;
 504        }
 505
 506        __blk_put_request(req->q, req);
 507        or->request = NULL;
 508        or->in.req = NULL;
 509        or->out.req = NULL;
 510
 511        if (or->async_done)
 512                or->async_done(or, or->async_private);
 513        else
 514                osd_end_request(or);
 515}
 516
 517int osd_execute_request_async(struct osd_request *or,
 518        osd_req_done_fn *done, void *private)
 519{
 520        or->request->end_io_data = or;
 521        or->async_private = private;
 522        or->async_done = done;
 523
 524        blk_execute_rq_nowait(or->request->q, NULL, or->request, 0,
 525                              osd_request_async_done);
 526        return 0;
 527}
 528EXPORT_SYMBOL(osd_execute_request_async);
 529
 530u8 sg_out_pad_buffer[1 << OSDv1_OFFSET_MIN_SHIFT];
 531u8 sg_in_pad_buffer[1 << OSDv1_OFFSET_MIN_SHIFT];
 532
 533static int _osd_realloc_seg(struct osd_request *or,
 534        struct _osd_req_data_segment *seg, unsigned max_bytes)
 535{
 536        void *buff;
 537
 538        if (seg->alloc_size >= max_bytes)
 539                return 0;
 540
 541        buff = krealloc(seg->buff, max_bytes, or->alloc_flags);
 542        if (!buff) {
 543                OSD_ERR("Failed to Realloc %d-bytes was-%d\n", max_bytes,
 544                        seg->alloc_size);
 545                return -ENOMEM;
 546        }
 547
 548        memset(buff + seg->alloc_size, 0, max_bytes - seg->alloc_size);
 549        seg->buff = buff;
 550        seg->alloc_size = max_bytes;
 551        return 0;
 552}
 553
 554static int _alloc_cdb_cont(struct osd_request *or, unsigned total_bytes)
 555{
 556        OSD_DEBUG("total_bytes=%d\n", total_bytes);
 557        return _osd_realloc_seg(or, &or->cdb_cont, total_bytes);
 558}
 559
 560static int _alloc_set_attr_list(struct osd_request *or,
 561        const struct osd_attr *oa, unsigned nelem, unsigned add_bytes)
 562{
 563        unsigned total_bytes = add_bytes;
 564
 565        for (; nelem; --nelem, ++oa)
 566                total_bytes += _osd_req_alist_elem_size(or, oa->len);
 567
 568        OSD_DEBUG("total_bytes=%d\n", total_bytes);
 569        return _osd_realloc_seg(or, &or->set_attr, total_bytes);
 570}
 571
 572static int _alloc_get_attr_desc(struct osd_request *or, unsigned max_bytes)
 573{
 574        OSD_DEBUG("total_bytes=%d\n", max_bytes);
 575        return _osd_realloc_seg(or, &or->enc_get_attr, max_bytes);
 576}
 577
 578static int _alloc_get_attr_list(struct osd_request *or)
 579{
 580        OSD_DEBUG("total_bytes=%d\n", or->get_attr.total_bytes);
 581        return _osd_realloc_seg(or, &or->get_attr, or->get_attr.total_bytes);
 582}
 583
 584/*
 585 * Common to all OSD commands
 586 */
 587
 588static void _osdv1_req_encode_common(struct osd_request *or,
 589        __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
 590{
 591        struct osdv1_cdb *ocdb = &or->cdb.v1;
 592
 593        /*
 594         * For speed, the commands
 595         *      OSD_ACT_PERFORM_SCSI_COMMAND    , V1 0x8F7E, V2 0x8F7C
 596         *      OSD_ACT_SCSI_TASK_MANAGEMENT    , V1 0x8F7F, V2 0x8F7D
 597         * are not supported here. Should pass zero and set after the call
 598         */
 599        act &= cpu_to_be16(~0x0080); /* V1 action code */
 600
 601        OSD_DEBUG("OSDv1 execute opcode 0x%x\n", be16_to_cpu(act));
 602
 603        ocdb->h.varlen_cdb.opcode = VARIABLE_LENGTH_CMD;
 604        ocdb->h.varlen_cdb.additional_cdb_length = OSD_ADDITIONAL_CDB_LENGTH;
 605        ocdb->h.varlen_cdb.service_action = act;
 606
 607        ocdb->h.partition = cpu_to_be64(obj->partition);
 608        ocdb->h.object = cpu_to_be64(obj->id);
 609        ocdb->h.v1.length = cpu_to_be64(len);
 610        ocdb->h.v1.start_address = cpu_to_be64(offset);
 611}
 612
 613static void _osdv2_req_encode_common(struct osd_request *or,
 614         __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
 615{
 616        struct osdv2_cdb *ocdb = &or->cdb.v2;
 617
 618        OSD_DEBUG("OSDv2 execute opcode 0x%x\n", be16_to_cpu(act));
 619
 620        ocdb->h.varlen_cdb.opcode = VARIABLE_LENGTH_CMD;
 621        ocdb->h.varlen_cdb.additional_cdb_length = OSD_ADDITIONAL_CDB_LENGTH;
 622        ocdb->h.varlen_cdb.service_action = act;
 623
 624        ocdb->h.partition = cpu_to_be64(obj->partition);
 625        ocdb->h.object = cpu_to_be64(obj->id);
 626        ocdb->h.v2.length = cpu_to_be64(len);
 627        ocdb->h.v2.start_address = cpu_to_be64(offset);
 628}
 629
 630static void _osd_req_encode_common(struct osd_request *or,
 631        __be16 act, const struct osd_obj_id *obj, u64 offset, u64 len)
 632{
 633        if (osd_req_is_ver1(or))
 634                _osdv1_req_encode_common(or, act, obj, offset, len);
 635        else
 636                _osdv2_req_encode_common(or, act, obj, offset, len);
 637}
 638
 639/*
 640 * Device commands
 641 */
 642/*TODO: void osd_req_set_master_seed_xchg(struct osd_request *, ...); */
 643/*TODO: void osd_req_set_master_key(struct osd_request *, ...); */
 644
 645void osd_req_format(struct osd_request *or, u64 tot_capacity)
 646{
 647        _osd_req_encode_common(or, OSD_ACT_FORMAT_OSD, &osd_root_object, 0,
 648                                tot_capacity);
 649}
 650EXPORT_SYMBOL(osd_req_format);
 651
 652int osd_req_list_dev_partitions(struct osd_request *or,
 653        osd_id initial_id, struct osd_obj_id_list *list, unsigned nelem)
 654{
 655        return osd_req_list_partition_objects(or, 0, initial_id, list, nelem);
 656}
 657EXPORT_SYMBOL(osd_req_list_dev_partitions);
 658
 659static void _osd_req_encode_flush(struct osd_request *or,
 660        enum osd_options_flush_scope_values op)
 661{
 662        struct osd_cdb_head *ocdb = osd_cdb_head(&or->cdb);
 663
 664        ocdb->command_specific_options = op;
 665}
 666
 667void osd_req_flush_obsd(struct osd_request *or,
 668        enum osd_options_flush_scope_values op)
 669{
 670        _osd_req_encode_common(or, OSD_ACT_FLUSH_OSD, &osd_root_object, 0, 0);
 671        _osd_req_encode_flush(or, op);
 672}
 673EXPORT_SYMBOL(osd_req_flush_obsd);
 674
 675/*TODO: void osd_req_perform_scsi_command(struct osd_request *,
 676        const u8 *cdb, ...); */
 677/*TODO: void osd_req_task_management(struct osd_request *, ...); */
 678
 679/*
 680 * Partition commands
 681 */
 682static void _osd_req_encode_partition(struct osd_request *or,
 683        __be16 act, osd_id partition)
 684{
 685        struct osd_obj_id par = {
 686                .partition = partition,
 687                .id = 0,
 688        };
 689
 690        _osd_req_encode_common(or, act, &par, 0, 0);
 691}
 692
 693void osd_req_create_partition(struct osd_request *or, osd_id partition)
 694{
 695        _osd_req_encode_partition(or, OSD_ACT_CREATE_PARTITION, partition);
 696}
 697EXPORT_SYMBOL(osd_req_create_partition);
 698
 699void osd_req_remove_partition(struct osd_request *or, osd_id partition)
 700{
 701        _osd_req_encode_partition(or, OSD_ACT_REMOVE_PARTITION, partition);
 702}
 703EXPORT_SYMBOL(osd_req_remove_partition);
 704
 705/*TODO: void osd_req_set_partition_key(struct osd_request *,
 706        osd_id partition, u8 new_key_id[OSD_CRYPTO_KEYID_SIZE],
 707        u8 seed[OSD_CRYPTO_SEED_SIZE]); */
 708
 709static int _osd_req_list_objects(struct osd_request *or,
 710        __be16 action, const struct osd_obj_id *obj, osd_id initial_id,
 711        struct osd_obj_id_list *list, unsigned nelem)
 712{
 713        struct request_queue *q = osd_request_queue(or->osd_dev);
 714        u64 len = nelem * sizeof(osd_id) + sizeof(*list);
 715        struct bio *bio;
 716
 717        _osd_req_encode_common(or, action, obj, (u64)initial_id, len);
 718
 719        if (list->list_identifier)
 720                _osd_req_encode_olist(or, list);
 721
 722        WARN_ON(or->in.bio);
 723        bio = bio_map_kern(q, list, len, or->alloc_flags);
 724        if (IS_ERR(bio)) {
 725                OSD_ERR("!!! Failed to allocate list_objects BIO\n");
 726                return PTR_ERR(bio);
 727        }
 728
 729        bio_set_op_attrs(bio, REQ_OP_READ, 0);
 730        or->in.bio = bio;
 731        or->in.total_bytes = bio->bi_iter.bi_size;
 732        return 0;
 733}
 734
 735int osd_req_list_partition_collections(struct osd_request *or,
 736        osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
 737        unsigned nelem)
 738{
 739        struct osd_obj_id par = {
 740                .partition = partition,
 741                .id = 0,
 742        };
 743
 744        return osd_req_list_collection_objects(or, &par, initial_id, list,
 745                                               nelem);
 746}
 747EXPORT_SYMBOL(osd_req_list_partition_collections);
 748
 749int osd_req_list_partition_objects(struct osd_request *or,
 750        osd_id partition, osd_id initial_id, struct osd_obj_id_list *list,
 751        unsigned nelem)
 752{
 753        struct osd_obj_id par = {
 754                .partition = partition,
 755                .id = 0,
 756        };
 757
 758        return _osd_req_list_objects(or, OSD_ACT_LIST, &par, initial_id, list,
 759                                     nelem);
 760}
 761EXPORT_SYMBOL(osd_req_list_partition_objects);
 762
 763void osd_req_flush_partition(struct osd_request *or,
 764        osd_id partition, enum osd_options_flush_scope_values op)
 765{
 766        _osd_req_encode_partition(or, OSD_ACT_FLUSH_PARTITION, partition);
 767        _osd_req_encode_flush(or, op);
 768}
 769EXPORT_SYMBOL(osd_req_flush_partition);
 770
 771/*
 772 * Collection commands
 773 */
 774/*TODO: void osd_req_create_collection(struct osd_request *,
 775        const struct osd_obj_id *); */
 776/*TODO: void osd_req_remove_collection(struct osd_request *,
 777        const struct osd_obj_id *); */
 778
 779int osd_req_list_collection_objects(struct osd_request *or,
 780        const struct osd_obj_id *obj, osd_id initial_id,
 781        struct osd_obj_id_list *list, unsigned nelem)
 782{
 783        return _osd_req_list_objects(or, OSD_ACT_LIST_COLLECTION, obj,
 784                                     initial_id, list, nelem);
 785}
 786EXPORT_SYMBOL(osd_req_list_collection_objects);
 787
 788/*TODO: void query(struct osd_request *, ...); V2 */
 789
 790void osd_req_flush_collection(struct osd_request *or,
 791        const struct osd_obj_id *obj, enum osd_options_flush_scope_values op)
 792{
 793        _osd_req_encode_common(or, OSD_ACT_FLUSH_PARTITION, obj, 0, 0);
 794        _osd_req_encode_flush(or, op);
 795}
 796EXPORT_SYMBOL(osd_req_flush_collection);
 797
 798/*TODO: void get_member_attrs(struct osd_request *, ...); V2 */
 799/*TODO: void set_member_attrs(struct osd_request *, ...); V2 */
 800
 801/*
 802 * Object commands
 803 */
 804void osd_req_create_object(struct osd_request *or, struct osd_obj_id *obj)
 805{
 806        _osd_req_encode_common(or, OSD_ACT_CREATE, obj, 0, 0);
 807}
 808EXPORT_SYMBOL(osd_req_create_object);
 809
 810void osd_req_remove_object(struct osd_request *or, struct osd_obj_id *obj)
 811{
 812        _osd_req_encode_common(or, OSD_ACT_REMOVE, obj, 0, 0);
 813}
 814EXPORT_SYMBOL(osd_req_remove_object);
 815
 816
 817/*TODO: void osd_req_create_multi(struct osd_request *or,
 818        struct osd_obj_id *first, struct osd_obj_id_list *list, unsigned nelem);
 819*/
 820
 821void osd_req_write(struct osd_request *or,
 822        const struct osd_obj_id *obj, u64 offset,
 823        struct bio *bio, u64 len)
 824{
 825        _osd_req_encode_common(or, OSD_ACT_WRITE, obj, offset, len);
 826        WARN_ON(or->out.bio || or->out.total_bytes);
 827        WARN_ON(!op_is_write(bio_op(bio)));
 828        or->out.bio = bio;
 829        or->out.total_bytes = len;
 830}
 831EXPORT_SYMBOL(osd_req_write);
 832
 833int osd_req_write_kern(struct osd_request *or,
 834        const struct osd_obj_id *obj, u64 offset, void* buff, u64 len)
 835{
 836        struct request_queue *req_q = osd_request_queue(or->osd_dev);
 837        struct bio *bio = bio_map_kern(req_q, buff, len, GFP_KERNEL);
 838
 839        if (IS_ERR(bio))
 840                return PTR_ERR(bio);
 841
 842        bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
 843        osd_req_write(or, obj, offset, bio, len);
 844        return 0;
 845}
 846EXPORT_SYMBOL(osd_req_write_kern);
 847
 848/*TODO: void osd_req_append(struct osd_request *,
 849        const struct osd_obj_id *, struct bio *data_out); */
 850/*TODO: void osd_req_create_write(struct osd_request *,
 851        const struct osd_obj_id *, struct bio *data_out, u64 offset); */
 852/*TODO: void osd_req_clear(struct osd_request *,
 853        const struct osd_obj_id *, u64 offset, u64 len); */
 854/*TODO: void osd_req_punch(struct osd_request *,
 855        const struct osd_obj_id *, u64 offset, u64 len); V2 */
 856
 857void osd_req_flush_object(struct osd_request *or,
 858        const struct osd_obj_id *obj, enum osd_options_flush_scope_values op,
 859        /*V2*/ u64 offset, /*V2*/ u64 len)
 860{
 861        if (unlikely(osd_req_is_ver1(or) && (offset || len))) {
 862                OSD_DEBUG("OSD Ver1 flush on specific range ignored\n");
 863                offset = 0;
 864                len = 0;
 865        }
 866
 867        _osd_req_encode_common(or, OSD_ACT_FLUSH, obj, offset, len);
 868        _osd_req_encode_flush(or, op);
 869}
 870EXPORT_SYMBOL(osd_req_flush_object);
 871
 872void osd_req_read(struct osd_request *or,
 873        const struct osd_obj_id *obj, u64 offset,
 874        struct bio *bio, u64 len)
 875{
 876        _osd_req_encode_common(or, OSD_ACT_READ, obj, offset, len);
 877        WARN_ON(or->in.bio || or->in.total_bytes);
 878        WARN_ON(op_is_write(bio_op(bio)));
 879        or->in.bio = bio;
 880        or->in.total_bytes = len;
 881}
 882EXPORT_SYMBOL(osd_req_read);
 883
 884int osd_req_read_kern(struct osd_request *or,
 885        const struct osd_obj_id *obj, u64 offset, void* buff, u64 len)
 886{
 887        struct request_queue *req_q = osd_request_queue(or->osd_dev);
 888        struct bio *bio = bio_map_kern(req_q, buff, len, GFP_KERNEL);
 889
 890        if (IS_ERR(bio))
 891                return PTR_ERR(bio);
 892
 893        osd_req_read(or, obj, offset, bio, len);
 894        return 0;
 895}
 896EXPORT_SYMBOL(osd_req_read_kern);
 897
 898static int _add_sg_continuation_descriptor(struct osd_request *or,
 899        const struct osd_sg_entry *sglist, unsigned numentries, u64 *len)
 900{
 901        struct osd_sg_continuation_descriptor *oscd;
 902        u32 oscd_size;
 903        unsigned i;
 904        int ret;
 905
 906        oscd_size = sizeof(*oscd) + numentries * sizeof(oscd->entries[0]);
 907
 908        if (!or->cdb_cont.total_bytes) {
 909                /* First time, jump over the header, we will write to:
 910                 *      cdb_cont.buff + cdb_cont.total_bytes
 911                 */
 912                or->cdb_cont.total_bytes =
 913                                sizeof(struct osd_continuation_segment_header);
 914        }
 915
 916        ret = _alloc_cdb_cont(or, or->cdb_cont.total_bytes + oscd_size);
 917        if (unlikely(ret))
 918                return ret;
 919
 920        oscd = or->cdb_cont.buff + or->cdb_cont.total_bytes;
 921        oscd->hdr.type = cpu_to_be16(SCATTER_GATHER_LIST);
 922        oscd->hdr.pad_length = 0;
 923        oscd->hdr.length = cpu_to_be32(oscd_size - sizeof(*oscd));
 924
 925        *len = 0;
 926        /* copy the sg entries and convert to network byte order */
 927        for (i = 0; i < numentries; i++) {
 928                oscd->entries[i].offset = cpu_to_be64(sglist[i].offset);
 929                oscd->entries[i].len    = cpu_to_be64(sglist[i].len);
 930                *len += sglist[i].len;
 931        }
 932
 933        or->cdb_cont.total_bytes += oscd_size;
 934        OSD_DEBUG("total_bytes=%d oscd_size=%d numentries=%d\n",
 935                  or->cdb_cont.total_bytes, oscd_size, numentries);
 936        return 0;
 937}
 938
 939static int _osd_req_finalize_cdb_cont(struct osd_request *or, const u8 *cap_key)
 940{
 941        struct request_queue *req_q = osd_request_queue(or->osd_dev);
 942        struct bio *bio;
 943        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
 944        struct osd_continuation_segment_header *cont_seg_hdr;
 945
 946        if (!or->cdb_cont.total_bytes)
 947                return 0;
 948
 949        cont_seg_hdr = or->cdb_cont.buff;
 950        cont_seg_hdr->format = CDB_CONTINUATION_FORMAT_V2;
 951        cont_seg_hdr->service_action = cdbh->varlen_cdb.service_action;
 952
 953        /* create a bio for continuation segment */
 954        bio = bio_map_kern(req_q, or->cdb_cont.buff, or->cdb_cont.total_bytes,
 955                           GFP_KERNEL);
 956        if (IS_ERR(bio))
 957                return PTR_ERR(bio);
 958
 959        bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
 960
 961        /* integrity check the continuation before the bio is linked
 962         * with the other data segments since the continuation
 963         * integrity is separate from the other data segments.
 964         */
 965        osd_sec_sign_data(cont_seg_hdr->integrity_check, bio, cap_key);
 966
 967        cdbh->v2.cdb_continuation_length = cpu_to_be32(or->cdb_cont.total_bytes);
 968
 969        /* we can't use _req_append_segment, because we need to link in the
 970         * continuation bio to the head of the bio list - the
 971         * continuation segment (if it exists) is always the first segment in
 972         * the out data buffer.
 973         */
 974        bio->bi_next = or->out.bio;
 975        or->out.bio = bio;
 976        or->out.total_bytes += or->cdb_cont.total_bytes;
 977
 978        return 0;
 979}
 980
 981/* osd_req_write_sg: Takes a @bio that points to the data out buffer and an
 982 * @sglist that has the scatter gather entries. Scatter-gather enables a write
 983 * of multiple none-contiguous areas of an object, in a single call. The extents
 984 * may overlap and/or be in any order. The only constrain is that:
 985 *      total_bytes(sglist) >= total_bytes(bio)
 986 */
 987int osd_req_write_sg(struct osd_request *or,
 988        const struct osd_obj_id *obj, struct bio *bio,
 989        const struct osd_sg_entry *sglist, unsigned numentries)
 990{
 991        u64 len;
 992        int ret = _add_sg_continuation_descriptor(or, sglist, numentries, &len);
 993
 994        if (ret)
 995                return ret;
 996        osd_req_write(or, obj, 0, bio, len);
 997
 998        return 0;
 999}
1000EXPORT_SYMBOL(osd_req_write_sg);
1001
1002/* osd_req_read_sg: Read multiple extents of an object into @bio
1003 * See osd_req_write_sg
1004 */
1005int osd_req_read_sg(struct osd_request *or,
1006        const struct osd_obj_id *obj, struct bio *bio,
1007        const struct osd_sg_entry *sglist, unsigned numentries)
1008{
1009        u64 len;
1010        u64 off;
1011        int ret;
1012
1013        if (numentries > 1) {
1014                off = 0;
1015                ret = _add_sg_continuation_descriptor(or, sglist, numentries,
1016                                                      &len);
1017                if (ret)
1018                        return ret;
1019        } else {
1020                /* Optimize the case of single segment, read_sg is a
1021                 * bidi operation.
1022                 */
1023                len = sglist->len;
1024                off = sglist->offset;
1025        }
1026        osd_req_read(or, obj, off, bio, len);
1027
1028        return 0;
1029}
1030EXPORT_SYMBOL(osd_req_read_sg);
1031
1032/* SG-list write/read Kern API
1033 *
1034 * osd_req_{write,read}_sg_kern takes an array of @buff pointers and an array
1035 * of sg_entries. @numentries indicates how many pointers and sg_entries there
1036 * are.  By requiring an array of buff pointers. This allows a caller to do a
1037 * single write/read and scatter into multiple buffers.
1038 * NOTE: Each buffer + len should not cross a page boundary.
1039 */
1040static struct bio *_create_sg_bios(struct osd_request *or,
1041        void **buff, const struct osd_sg_entry *sglist, unsigned numentries)
1042{
1043        struct request_queue *q = osd_request_queue(or->osd_dev);
1044        struct bio *bio;
1045        unsigned i;
1046
1047        bio = bio_kmalloc(GFP_KERNEL, numentries);
1048        if (unlikely(!bio)) {
1049                OSD_DEBUG("Failed to allocate BIO size=%u\n", numentries);
1050                return ERR_PTR(-ENOMEM);
1051        }
1052
1053        for (i = 0; i < numentries; i++) {
1054                unsigned offset = offset_in_page(buff[i]);
1055                struct page *page = virt_to_page(buff[i]);
1056                unsigned len = sglist[i].len;
1057                unsigned added_len;
1058
1059                BUG_ON(offset + len > PAGE_SIZE);
1060                added_len = bio_add_pc_page(q, bio, page, len, offset);
1061                if (unlikely(len != added_len)) {
1062                        OSD_DEBUG("bio_add_pc_page len(%d) != added_len(%d)\n",
1063                                  len, added_len);
1064                        bio_put(bio);
1065                        return ERR_PTR(-ENOMEM);
1066                }
1067        }
1068
1069        return bio;
1070}
1071
1072int osd_req_write_sg_kern(struct osd_request *or,
1073        const struct osd_obj_id *obj, void **buff,
1074        const struct osd_sg_entry *sglist, unsigned numentries)
1075{
1076        struct bio *bio = _create_sg_bios(or, buff, sglist, numentries);
1077        if (IS_ERR(bio))
1078                return PTR_ERR(bio);
1079
1080        bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
1081        osd_req_write_sg(or, obj, bio, sglist, numentries);
1082
1083        return 0;
1084}
1085EXPORT_SYMBOL(osd_req_write_sg_kern);
1086
1087int osd_req_read_sg_kern(struct osd_request *or,
1088        const struct osd_obj_id *obj, void **buff,
1089        const struct osd_sg_entry *sglist, unsigned numentries)
1090{
1091        struct bio *bio = _create_sg_bios(or, buff, sglist, numentries);
1092        if (IS_ERR(bio))
1093                return PTR_ERR(bio);
1094
1095        osd_req_read_sg(or, obj, bio, sglist, numentries);
1096
1097        return 0;
1098}
1099EXPORT_SYMBOL(osd_req_read_sg_kern);
1100
1101
1102
1103void osd_req_get_attributes(struct osd_request *or,
1104        const struct osd_obj_id *obj)
1105{
1106        _osd_req_encode_common(or, OSD_ACT_GET_ATTRIBUTES, obj, 0, 0);
1107}
1108EXPORT_SYMBOL(osd_req_get_attributes);
1109
1110void osd_req_set_attributes(struct osd_request *or,
1111        const struct osd_obj_id *obj)
1112{
1113        _osd_req_encode_common(or, OSD_ACT_SET_ATTRIBUTES, obj, 0, 0);
1114}
1115EXPORT_SYMBOL(osd_req_set_attributes);
1116
1117/*
1118 * Attributes List-mode
1119 */
1120
1121int osd_req_add_set_attr_list(struct osd_request *or,
1122        const struct osd_attr *oa, unsigned nelem)
1123{
1124        unsigned total_bytes = or->set_attr.total_bytes;
1125        void *attr_last;
1126        int ret;
1127
1128        if (or->attributes_mode &&
1129            or->attributes_mode != OSD_CDB_GET_SET_ATTR_LISTS) {
1130                WARN_ON(1);
1131                return -EINVAL;
1132        }
1133        or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
1134
1135        if (!total_bytes) { /* first-time: allocate and put list header */
1136                total_bytes = _osd_req_sizeof_alist_header(or);
1137                ret = _alloc_set_attr_list(or, oa, nelem, total_bytes);
1138                if (ret)
1139                        return ret;
1140                _osd_req_set_alist_type(or, or->set_attr.buff,
1141                                        OSD_ATTR_LIST_SET_RETRIEVE);
1142        }
1143        attr_last = or->set_attr.buff + total_bytes;
1144
1145        for (; nelem; --nelem) {
1146                unsigned elem_size = _osd_req_alist_elem_size(or, oa->len);
1147
1148                total_bytes += elem_size;
1149                if (unlikely(or->set_attr.alloc_size < total_bytes)) {
1150                        or->set_attr.total_bytes = total_bytes - elem_size;
1151                        ret = _alloc_set_attr_list(or, oa, nelem, total_bytes);
1152                        if (ret)
1153                                return ret;
1154                        attr_last =
1155                                or->set_attr.buff + or->set_attr.total_bytes;
1156                }
1157
1158                _osd_req_alist_elem_encode(or, attr_last, oa);
1159
1160                attr_last += elem_size;
1161                ++oa;
1162        }
1163
1164        or->set_attr.total_bytes = total_bytes;
1165        return 0;
1166}
1167EXPORT_SYMBOL(osd_req_add_set_attr_list);
1168
1169static int _req_append_segment(struct osd_request *or,
1170        unsigned padding, struct _osd_req_data_segment *seg,
1171        struct _osd_req_data_segment *last_seg, struct _osd_io_info *io)
1172{
1173        void *pad_buff;
1174        int ret;
1175
1176        if (padding) {
1177                /* check if we can just add it to last buffer */
1178                if (last_seg &&
1179                    (padding <= last_seg->alloc_size - last_seg->total_bytes))
1180                        pad_buff = last_seg->buff + last_seg->total_bytes;
1181                else
1182                        pad_buff = io->pad_buff;
1183
1184                ret = blk_rq_map_kern(io->req->q, io->req, pad_buff, padding,
1185                                       or->alloc_flags);
1186                if (ret)
1187                        return ret;
1188                io->total_bytes += padding;
1189        }
1190
1191        ret = blk_rq_map_kern(io->req->q, io->req, seg->buff, seg->total_bytes,
1192                               or->alloc_flags);
1193        if (ret)
1194                return ret;
1195
1196        io->total_bytes += seg->total_bytes;
1197        OSD_DEBUG("padding=%d buff=%p total_bytes=%d\n", padding, seg->buff,
1198                  seg->total_bytes);
1199        return 0;
1200}
1201
1202static int _osd_req_finalize_set_attr_list(struct osd_request *or)
1203{
1204        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1205        unsigned padding;
1206        int ret;
1207
1208        if (!or->set_attr.total_bytes) {
1209                cdbh->attrs_list.set_attr_offset = OSD_OFFSET_UNUSED;
1210                return 0;
1211        }
1212
1213        cdbh->attrs_list.set_attr_bytes = cpu_to_be32(or->set_attr.total_bytes);
1214        cdbh->attrs_list.set_attr_offset =
1215                osd_req_encode_offset(or, or->out.total_bytes, &padding);
1216
1217        ret = _req_append_segment(or, padding, &or->set_attr,
1218                                  or->out.last_seg, &or->out);
1219        if (ret)
1220                return ret;
1221
1222        or->out.last_seg = &or->set_attr;
1223        return 0;
1224}
1225
1226int osd_req_add_get_attr_list(struct osd_request *or,
1227        const struct osd_attr *oa, unsigned nelem)
1228{
1229        unsigned total_bytes = or->enc_get_attr.total_bytes;
1230        void *attr_last;
1231        int ret;
1232
1233        if (or->attributes_mode &&
1234            or->attributes_mode != OSD_CDB_GET_SET_ATTR_LISTS) {
1235                WARN_ON(1);
1236                return -EINVAL;
1237        }
1238        or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
1239
1240        /* first time calc data-in list header size */
1241        if (!or->get_attr.total_bytes)
1242                or->get_attr.total_bytes = _osd_req_sizeof_alist_header(or);
1243
1244        /* calc data-out info */
1245        if (!total_bytes) { /* first-time: allocate and put list header */
1246                unsigned max_bytes;
1247
1248                total_bytes = _osd_req_sizeof_alist_header(or);
1249                max_bytes = total_bytes +
1250                        nelem * sizeof(struct osd_attributes_list_attrid);
1251                ret = _alloc_get_attr_desc(or, max_bytes);
1252                if (ret)
1253                        return ret;
1254
1255                _osd_req_set_alist_type(or, or->enc_get_attr.buff,
1256                                        OSD_ATTR_LIST_GET);
1257        }
1258        attr_last = or->enc_get_attr.buff + total_bytes;
1259
1260        for (; nelem; --nelem) {
1261                struct osd_attributes_list_attrid *attrid;
1262                const unsigned cur_size = sizeof(*attrid);
1263
1264                total_bytes += cur_size;
1265                if (unlikely(or->enc_get_attr.alloc_size < total_bytes)) {
1266                        or->enc_get_attr.total_bytes = total_bytes - cur_size;
1267                        ret = _alloc_get_attr_desc(or,
1268                                        total_bytes + nelem * sizeof(*attrid));
1269                        if (ret)
1270                                return ret;
1271                        attr_last = or->enc_get_attr.buff +
1272                                or->enc_get_attr.total_bytes;
1273                }
1274
1275                attrid = attr_last;
1276                attrid->attr_page = cpu_to_be32(oa->attr_page);
1277                attrid->attr_id = cpu_to_be32(oa->attr_id);
1278
1279                attr_last += cur_size;
1280
1281                /* calc data-in size */
1282                or->get_attr.total_bytes +=
1283                        _osd_req_alist_elem_size(or, oa->len);
1284                ++oa;
1285        }
1286
1287        or->enc_get_attr.total_bytes = total_bytes;
1288
1289        OSD_DEBUG(
1290               "get_attr.total_bytes=%u(%u) enc_get_attr.total_bytes=%u(%Zu)\n",
1291               or->get_attr.total_bytes,
1292               or->get_attr.total_bytes - _osd_req_sizeof_alist_header(or),
1293               or->enc_get_attr.total_bytes,
1294               (or->enc_get_attr.total_bytes - _osd_req_sizeof_alist_header(or))
1295                        / sizeof(struct osd_attributes_list_attrid));
1296
1297        return 0;
1298}
1299EXPORT_SYMBOL(osd_req_add_get_attr_list);
1300
1301static int _osd_req_finalize_get_attr_list(struct osd_request *or)
1302{
1303        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1304        unsigned out_padding;
1305        unsigned in_padding;
1306        int ret;
1307
1308        if (!or->enc_get_attr.total_bytes) {
1309                cdbh->attrs_list.get_attr_desc_offset = OSD_OFFSET_UNUSED;
1310                cdbh->attrs_list.get_attr_offset = OSD_OFFSET_UNUSED;
1311                return 0;
1312        }
1313
1314        ret = _alloc_get_attr_list(or);
1315        if (ret)
1316                return ret;
1317
1318        /* The out-going buffer info update */
1319        OSD_DEBUG("out-going\n");
1320        cdbh->attrs_list.get_attr_desc_bytes =
1321                cpu_to_be32(or->enc_get_attr.total_bytes);
1322
1323        cdbh->attrs_list.get_attr_desc_offset =
1324                osd_req_encode_offset(or, or->out.total_bytes, &out_padding);
1325
1326        ret = _req_append_segment(or, out_padding, &or->enc_get_attr,
1327                                  or->out.last_seg, &or->out);
1328        if (ret)
1329                return ret;
1330        or->out.last_seg = &or->enc_get_attr;
1331
1332        /* The incoming buffer info update */
1333        OSD_DEBUG("in-coming\n");
1334        cdbh->attrs_list.get_attr_alloc_length =
1335                cpu_to_be32(or->get_attr.total_bytes);
1336
1337        cdbh->attrs_list.get_attr_offset =
1338                osd_req_encode_offset(or, or->in.total_bytes, &in_padding);
1339
1340        ret = _req_append_segment(or, in_padding, &or->get_attr, NULL,
1341                                  &or->in);
1342        if (ret)
1343                return ret;
1344        or->in.last_seg = &or->get_attr;
1345
1346        return 0;
1347}
1348
1349int osd_req_decode_get_attr_list(struct osd_request *or,
1350        struct osd_attr *oa, int *nelem, void **iterator)
1351{
1352        unsigned cur_bytes, returned_bytes;
1353        int n;
1354        const unsigned sizeof_attr_list = _osd_req_sizeof_alist_header(or);
1355        void *cur_p;
1356
1357        if (!_osd_req_is_alist_type(or, or->get_attr.buff,
1358                                    OSD_ATTR_LIST_SET_RETRIEVE)) {
1359                oa->attr_page = 0;
1360                oa->attr_id = 0;
1361                oa->val_ptr = NULL;
1362                oa->len = 0;
1363                *iterator = NULL;
1364                return 0;
1365        }
1366
1367        if (*iterator) {
1368                BUG_ON((*iterator < or->get_attr.buff) ||
1369                     (or->get_attr.buff + or->get_attr.alloc_size < *iterator));
1370                cur_p = *iterator;
1371                cur_bytes = (*iterator - or->get_attr.buff) - sizeof_attr_list;
1372                returned_bytes = or->get_attr.total_bytes;
1373        } else { /* first time decode the list header */
1374                cur_bytes = sizeof_attr_list;
1375                returned_bytes = _osd_req_alist_size(or, or->get_attr.buff) +
1376                                        sizeof_attr_list;
1377
1378                cur_p = or->get_attr.buff + sizeof_attr_list;
1379
1380                if (returned_bytes > or->get_attr.alloc_size) {
1381                        OSD_DEBUG("target report: space was not big enough! "
1382                                  "Allocate=%u Needed=%u\n",
1383                                  or->get_attr.alloc_size,
1384                                  returned_bytes + sizeof_attr_list);
1385
1386                        returned_bytes =
1387                                or->get_attr.alloc_size - sizeof_attr_list;
1388                }
1389                or->get_attr.total_bytes = returned_bytes;
1390        }
1391
1392        for (n = 0; (n < *nelem) && (cur_bytes < returned_bytes); ++n) {
1393                int inc = _osd_req_alist_elem_decode(or, cur_p, oa,
1394                                                 returned_bytes - cur_bytes);
1395
1396                if (inc < 0) {
1397                        OSD_ERR("BAD FOOD from target. list not valid!"
1398                                "c=%d r=%d n=%d\n",
1399                                cur_bytes, returned_bytes, n);
1400                        oa->val_ptr = NULL;
1401                        cur_bytes = returned_bytes; /* break the caller loop */
1402                        break;
1403                }
1404
1405                cur_bytes += inc;
1406                cur_p += inc;
1407                ++oa;
1408        }
1409
1410        *iterator = (returned_bytes - cur_bytes) ? cur_p : NULL;
1411        *nelem = n;
1412        return returned_bytes - cur_bytes;
1413}
1414EXPORT_SYMBOL(osd_req_decode_get_attr_list);
1415
1416/*
1417 * Attributes Page-mode
1418 */
1419
1420int osd_req_add_get_attr_page(struct osd_request *or,
1421        u32 page_id, void *attar_page, unsigned max_page_len,
1422        const struct osd_attr *set_one_attr)
1423{
1424        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1425
1426        if (or->attributes_mode &&
1427            or->attributes_mode != OSD_CDB_GET_ATTR_PAGE_SET_ONE) {
1428                WARN_ON(1);
1429                return -EINVAL;
1430        }
1431        or->attributes_mode = OSD_CDB_GET_ATTR_PAGE_SET_ONE;
1432
1433        or->get_attr.buff = attar_page;
1434        or->get_attr.total_bytes = max_page_len;
1435
1436        cdbh->attrs_page.get_attr_page = cpu_to_be32(page_id);
1437        cdbh->attrs_page.get_attr_alloc_length = cpu_to_be32(max_page_len);
1438
1439        if (!set_one_attr || !set_one_attr->attr_page)
1440                return 0; /* The set is optional */
1441
1442        or->set_attr.buff = set_one_attr->val_ptr;
1443        or->set_attr.total_bytes = set_one_attr->len;
1444
1445        cdbh->attrs_page.set_attr_page = cpu_to_be32(set_one_attr->attr_page);
1446        cdbh->attrs_page.set_attr_id = cpu_to_be32(set_one_attr->attr_id);
1447        cdbh->attrs_page.set_attr_length = cpu_to_be32(set_one_attr->len);
1448        return 0;
1449}
1450EXPORT_SYMBOL(osd_req_add_get_attr_page);
1451
1452static int _osd_req_finalize_attr_page(struct osd_request *or)
1453{
1454        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1455        unsigned in_padding, out_padding;
1456        int ret;
1457
1458        /* returned page */
1459        cdbh->attrs_page.get_attr_offset =
1460                osd_req_encode_offset(or, or->in.total_bytes, &in_padding);
1461
1462        ret = _req_append_segment(or, in_padding, &or->get_attr, NULL,
1463                                  &or->in);
1464        if (ret)
1465                return ret;
1466
1467        if (or->set_attr.total_bytes == 0)
1468                return 0;
1469
1470        /* set one value */
1471        cdbh->attrs_page.set_attr_offset =
1472                osd_req_encode_offset(or, or->out.total_bytes, &out_padding);
1473
1474        ret = _req_append_segment(or, out_padding, &or->set_attr, NULL,
1475                                  &or->out);
1476        return ret;
1477}
1478
1479static inline void osd_sec_parms_set_out_offset(bool is_v1,
1480        struct osd_security_parameters *sec_parms, osd_cdb_offset offset)
1481{
1482        if (is_v1)
1483                sec_parms->v1.data_out_integrity_check_offset = offset;
1484        else
1485                sec_parms->v2.data_out_integrity_check_offset = offset;
1486}
1487
1488static inline void osd_sec_parms_set_in_offset(bool is_v1,
1489        struct osd_security_parameters *sec_parms, osd_cdb_offset offset)
1490{
1491        if (is_v1)
1492                sec_parms->v1.data_in_integrity_check_offset = offset;
1493        else
1494                sec_parms->v2.data_in_integrity_check_offset = offset;
1495}
1496
1497static int _osd_req_finalize_data_integrity(struct osd_request *or,
1498        bool has_in, bool has_out, struct bio *out_data_bio, u64 out_data_bytes,
1499        const u8 *cap_key)
1500{
1501        struct osd_security_parameters *sec_parms = _osd_req_sec_params(or);
1502        int ret;
1503
1504        if (!osd_is_sec_alldata(sec_parms))
1505                return 0;
1506
1507        if (has_out) {
1508                struct _osd_req_data_segment seg = {
1509                        .buff = &or->out_data_integ,
1510                        .total_bytes = sizeof(or->out_data_integ),
1511                };
1512                unsigned pad;
1513
1514                or->out_data_integ.data_bytes = cpu_to_be64(out_data_bytes);
1515                or->out_data_integ.set_attributes_bytes = cpu_to_be64(
1516                        or->set_attr.total_bytes);
1517                or->out_data_integ.get_attributes_bytes = cpu_to_be64(
1518                        or->enc_get_attr.total_bytes);
1519
1520                osd_sec_parms_set_out_offset(osd_req_is_ver1(or), sec_parms,
1521                        osd_req_encode_offset(or, or->out.total_bytes, &pad));
1522
1523                ret = _req_append_segment(or, pad, &seg, or->out.last_seg,
1524                                          &or->out);
1525                if (ret)
1526                        return ret;
1527                or->out.last_seg = NULL;
1528
1529                /* they are now all chained to request sign them all together */
1530                osd_sec_sign_data(&or->out_data_integ, out_data_bio,
1531                                  cap_key);
1532        }
1533
1534        if (has_in) {
1535                struct _osd_req_data_segment seg = {
1536                        .buff = &or->in_data_integ,
1537                        .total_bytes = sizeof(or->in_data_integ),
1538                };
1539                unsigned pad;
1540
1541                osd_sec_parms_set_in_offset(osd_req_is_ver1(or), sec_parms,
1542                        osd_req_encode_offset(or, or->in.total_bytes, &pad));
1543
1544                ret = _req_append_segment(or, pad, &seg, or->in.last_seg,
1545                                          &or->in);
1546                if (ret)
1547                        return ret;
1548
1549                or->in.last_seg = NULL;
1550        }
1551
1552        return 0;
1553}
1554
1555/*
1556 * osd_finalize_request and helpers
1557 */
1558static struct request *_make_request(struct request_queue *q, bool has_write,
1559                              struct _osd_io_info *oii, gfp_t flags)
1560{
1561        struct request *req;
1562        struct bio *bio = oii->bio;
1563        int ret;
1564
1565        req = blk_get_request(q, has_write ? WRITE : READ, flags);
1566        if (IS_ERR(req))
1567                return req;
1568        blk_rq_set_block_pc(req);
1569
1570        for_each_bio(bio) {
1571                struct bio *bounce_bio = bio;
1572
1573                blk_queue_bounce(req->q, &bounce_bio);
1574                ret = blk_rq_append_bio(req, bounce_bio);
1575                if (ret)
1576                        return ERR_PTR(ret);
1577        }
1578
1579        return req;
1580}
1581
1582static int _init_blk_request(struct osd_request *or,
1583        bool has_in, bool has_out)
1584{
1585        gfp_t flags = or->alloc_flags;
1586        struct scsi_device *scsi_device = or->osd_dev->scsi_device;
1587        struct request_queue *q = scsi_device->request_queue;
1588        struct request *req;
1589        int ret;
1590
1591        req = _make_request(q, has_out, has_out ? &or->out : &or->in, flags);
1592        if (IS_ERR(req)) {
1593                ret = PTR_ERR(req);
1594                goto out;
1595        }
1596
1597        or->request = req;
1598        req->cmd_flags |= REQ_QUIET;
1599
1600        req->timeout = or->timeout;
1601        req->retries = or->retries;
1602        req->sense = or->sense;
1603        req->sense_len = 0;
1604
1605        if (has_out) {
1606                or->out.req = req;
1607                if (has_in) {
1608                        /* allocate bidi request */
1609                        req = _make_request(q, false, &or->in, flags);
1610                        if (IS_ERR(req)) {
1611                                OSD_DEBUG("blk_get_request for bidi failed\n");
1612                                ret = PTR_ERR(req);
1613                                goto out;
1614                        }
1615                        blk_rq_set_block_pc(req);
1616                        or->in.req = or->request->next_rq = req;
1617                }
1618        } else if (has_in)
1619                or->in.req = req;
1620
1621        ret = 0;
1622out:
1623        OSD_DEBUG("or=%p has_in=%d has_out=%d => %d, %p\n",
1624                        or, has_in, has_out, ret, or->request);
1625        return ret;
1626}
1627
1628int osd_finalize_request(struct osd_request *or,
1629        u8 options, const void *cap, const u8 *cap_key)
1630{
1631        struct osd_cdb_head *cdbh = osd_cdb_head(&or->cdb);
1632        bool has_in, has_out;
1633         /* Save for data_integrity without the cdb_continuation */
1634        struct bio *out_data_bio = or->out.bio;
1635        u64 out_data_bytes = or->out.total_bytes;
1636        int ret;
1637
1638        if (options & OSD_REQ_FUA)
1639                cdbh->options |= OSD_CDB_FUA;
1640
1641        if (options & OSD_REQ_DPO)
1642                cdbh->options |= OSD_CDB_DPO;
1643
1644        if (options & OSD_REQ_BYPASS_TIMESTAMPS)
1645                cdbh->timestamp_control = OSD_CDB_BYPASS_TIMESTAMPS;
1646
1647        osd_set_caps(&or->cdb, cap);
1648
1649        has_in = or->in.bio || or->get_attr.total_bytes;
1650        has_out = or->out.bio || or->cdb_cont.total_bytes ||
1651                or->set_attr.total_bytes || or->enc_get_attr.total_bytes;
1652
1653        ret = _osd_req_finalize_cdb_cont(or, cap_key);
1654        if (ret) {
1655                OSD_DEBUG("_osd_req_finalize_cdb_cont failed\n");
1656                return ret;
1657        }
1658        ret = _init_blk_request(or, has_in, has_out);
1659        if (ret) {
1660                OSD_DEBUG("_init_blk_request failed\n");
1661                return ret;
1662        }
1663
1664        or->out.pad_buff = sg_out_pad_buffer;
1665        or->in.pad_buff = sg_in_pad_buffer;
1666
1667        if (!or->attributes_mode)
1668                or->attributes_mode = OSD_CDB_GET_SET_ATTR_LISTS;
1669        cdbh->command_specific_options |= or->attributes_mode;
1670        if (or->attributes_mode == OSD_CDB_GET_ATTR_PAGE_SET_ONE) {
1671                ret = _osd_req_finalize_attr_page(or);
1672                if (ret) {
1673                        OSD_DEBUG("_osd_req_finalize_attr_page failed\n");
1674                        return ret;
1675                }
1676        } else {
1677                /* TODO: I think that for the GET_ATTR command these 2 should
1678                 * be reversed to keep them in execution order (for embeded
1679                 * targets with low memory footprint)
1680                 */
1681                ret = _osd_req_finalize_set_attr_list(or);
1682                if (ret) {
1683                        OSD_DEBUG("_osd_req_finalize_set_attr_list failed\n");
1684                        return ret;
1685                }
1686
1687                ret = _osd_req_finalize_get_attr_list(or);
1688                if (ret) {
1689                        OSD_DEBUG("_osd_req_finalize_get_attr_list failed\n");
1690                        return ret;
1691                }
1692        }
1693
1694        ret = _osd_req_finalize_data_integrity(or, has_in, has_out,
1695                                               out_data_bio, out_data_bytes,
1696                                               cap_key);
1697        if (ret)
1698                return ret;
1699
1700        osd_sec_sign_cdb(&or->cdb, cap_key);
1701
1702        or->request->cmd = or->cdb.buff;
1703        or->request->cmd_len = _osd_req_cdb_len(or);
1704
1705        return 0;
1706}
1707EXPORT_SYMBOL(osd_finalize_request);
1708
1709static bool _is_osd_security_code(int code)
1710{
1711        return  (code == osd_security_audit_value_frozen) ||
1712                (code == osd_security_working_key_frozen) ||
1713                (code == osd_nonce_not_unique) ||
1714                (code == osd_nonce_timestamp_out_of_range) ||
1715                (code == osd_invalid_dataout_buffer_integrity_check_value);
1716}
1717
1718#define OSD_SENSE_PRINT1(fmt, a...) \
1719        do { \
1720                if (__cur_sense_need_output) \
1721                        OSD_ERR(fmt, ##a); \
1722        } while (0)
1723
1724#define OSD_SENSE_PRINT2(fmt, a...) OSD_SENSE_PRINT1("    " fmt, ##a)
1725
1726int osd_req_decode_sense_full(struct osd_request *or,
1727        struct osd_sense_info *osi, bool silent,
1728        struct osd_obj_id *bad_obj_list __unused, int max_obj __unused,
1729        struct osd_attr *bad_attr_list, int max_attr)
1730{
1731        int sense_len, original_sense_len;
1732        struct osd_sense_info local_osi;
1733        struct scsi_sense_descriptor_based *ssdb;
1734        void *cur_descriptor;
1735#if (CONFIG_SCSI_OSD_DPRINT_SENSE == 0)
1736        const bool __cur_sense_need_output = false;
1737#else
1738        bool __cur_sense_need_output = !silent;
1739#endif
1740        int ret;
1741
1742        if (likely(!or->req_errors))
1743                return 0;
1744
1745        osi = osi ? : &local_osi;
1746        memset(osi, 0, sizeof(*osi));
1747
1748        ssdb = (typeof(ssdb))or->sense;
1749        sense_len = or->sense_len;
1750        if ((sense_len < (int)sizeof(*ssdb) || !ssdb->sense_key)) {
1751                OSD_ERR("Block-layer returned error(0x%x) but "
1752                        "sense_len(%u) || key(%d) is empty\n",
1753                        or->req_errors, sense_len, ssdb->sense_key);
1754                goto analyze;
1755        }
1756
1757        if ((ssdb->response_code != 0x72) && (ssdb->response_code != 0x73)) {
1758                OSD_ERR("Unrecognized scsi sense: rcode=%x length=%d\n",
1759                        ssdb->response_code, sense_len);
1760                goto analyze;
1761        }
1762
1763        osi->key = ssdb->sense_key;
1764        osi->additional_code = be16_to_cpu(ssdb->additional_sense_code);
1765        original_sense_len = ssdb->additional_sense_length + 8;
1766
1767#if (CONFIG_SCSI_OSD_DPRINT_SENSE == 1)
1768        if (__cur_sense_need_output)
1769                __cur_sense_need_output = (osi->key > scsi_sk_recovered_error);
1770#endif
1771        OSD_SENSE_PRINT1("Main Sense information key=0x%x length(%d, %d) "
1772                        "additional_code=0x%x async_error=%d errors=0x%x\n",
1773                        osi->key, original_sense_len, sense_len,
1774                        osi->additional_code, or->async_error,
1775                        or->req_errors);
1776
1777        if (original_sense_len < sense_len)
1778                sense_len = original_sense_len;
1779
1780        cur_descriptor = ssdb->ssd;
1781        sense_len -= sizeof(*ssdb);
1782        while (sense_len > 0) {
1783                struct scsi_sense_descriptor *ssd = cur_descriptor;
1784                int cur_len = ssd->additional_length + 2;
1785
1786                sense_len -= cur_len;
1787
1788                if (sense_len < 0)
1789                        break; /* sense was truncated */
1790
1791                switch (ssd->descriptor_type) {
1792                case scsi_sense_information:
1793                case scsi_sense_command_specific_information:
1794                {
1795                        struct scsi_sense_command_specific_data_descriptor
1796                                *sscd = cur_descriptor;
1797
1798                        osi->command_info =
1799                                get_unaligned_be64(&sscd->information) ;
1800                        OSD_SENSE_PRINT2(
1801                                "command_specific_information 0x%llx \n",
1802                                _LLU(osi->command_info));
1803                        break;
1804                }
1805                case scsi_sense_key_specific:
1806                {
1807                        struct scsi_sense_key_specific_data_descriptor
1808                                *ssks = cur_descriptor;
1809
1810                        osi->sense_info = get_unaligned_be16(&ssks->value);
1811                        OSD_SENSE_PRINT2(
1812                                "sense_key_specific_information %u"
1813                                "sksv_cd_bpv_bp (0x%x)\n",
1814                                osi->sense_info, ssks->sksv_cd_bpv_bp);
1815                        break;
1816                }
1817                case osd_sense_object_identification:
1818                { /*FIXME: Keep first not last, Store in array*/
1819                        struct osd_sense_identification_data_descriptor
1820                                *osidd = cur_descriptor;
1821
1822                        osi->not_initiated_command_functions =
1823                                le32_to_cpu(osidd->not_initiated_functions);
1824                        osi->completed_command_functions =
1825                                le32_to_cpu(osidd->completed_functions);
1826                        osi->obj.partition = be64_to_cpu(osidd->partition_id);
1827                        osi->obj.id = be64_to_cpu(osidd->object_id);
1828                        OSD_SENSE_PRINT2(
1829                                "object_identification pid=0x%llx oid=0x%llx\n",
1830                                _LLU(osi->obj.partition), _LLU(osi->obj.id));
1831                        OSD_SENSE_PRINT2(
1832                                "not_initiated_bits(%x) "
1833                                "completed_command_bits(%x)\n",
1834                                osi->not_initiated_command_functions,
1835                                osi->completed_command_functions);
1836                        break;
1837                }
1838                case osd_sense_response_integrity_check:
1839                {
1840                        struct osd_sense_response_integrity_check_descriptor
1841                                *osricd = cur_descriptor;
1842                        const unsigned len =
1843                                          sizeof(osricd->integrity_check_value);
1844                        char key_dump[len*4 + 2]; /* 2nibbles+space+ASCII */
1845
1846                        hex_dump_to_buffer(osricd->integrity_check_value, len,
1847                                       32, 1, key_dump, sizeof(key_dump), true);
1848                        OSD_SENSE_PRINT2("response_integrity [%s]\n", key_dump);
1849                }
1850                case osd_sense_attribute_identification:
1851                {
1852                        struct osd_sense_attributes_data_descriptor
1853                                *osadd = cur_descriptor;
1854                        unsigned len = min(cur_len, sense_len);
1855                        struct osd_sense_attr *pattr = osadd->sense_attrs;
1856
1857                        while (len >= sizeof(*pattr)) {
1858                                u32 attr_page = be32_to_cpu(pattr->attr_page);
1859                                u32 attr_id = be32_to_cpu(pattr->attr_id);
1860
1861                                if (!osi->attr.attr_page) {
1862                                        osi->attr.attr_page = attr_page;
1863                                        osi->attr.attr_id = attr_id;
1864                                }
1865
1866                                if (bad_attr_list && max_attr) {
1867                                        bad_attr_list->attr_page = attr_page;
1868                                        bad_attr_list->attr_id = attr_id;
1869                                        bad_attr_list++;
1870                                        max_attr--;
1871                                }
1872
1873                                len -= sizeof(*pattr);
1874                                OSD_SENSE_PRINT2(
1875                                        "osd_sense_attribute_identification"
1876                                        "attr_page=0x%x attr_id=0x%x\n",
1877                                        attr_page, attr_id);
1878                        }
1879                }
1880                /*These are not legal for OSD*/
1881                case scsi_sense_field_replaceable_unit:
1882                        OSD_SENSE_PRINT2("scsi_sense_field_replaceable_unit\n");
1883                        break;
1884                case scsi_sense_stream_commands:
1885                        OSD_SENSE_PRINT2("scsi_sense_stream_commands\n");
1886                        break;
1887                case scsi_sense_block_commands:
1888                        OSD_SENSE_PRINT2("scsi_sense_block_commands\n");
1889                        break;
1890                case scsi_sense_ata_return:
1891                        OSD_SENSE_PRINT2("scsi_sense_ata_return\n");
1892                        break;
1893                default:
1894                        if (ssd->descriptor_type <= scsi_sense_Reserved_last)
1895                                OSD_SENSE_PRINT2(
1896                                        "scsi_sense Reserved descriptor (0x%x)",
1897                                        ssd->descriptor_type);
1898                        else
1899                                OSD_SENSE_PRINT2(
1900                                        "scsi_sense Vendor descriptor (0x%x)",
1901                                        ssd->descriptor_type);
1902                }
1903
1904                cur_descriptor += cur_len;
1905        }
1906
1907analyze:
1908        if (!osi->key) {
1909                /* scsi sense is Empty, the request was never issued to target
1910                 * linux return code might tell us what happened.
1911                 */
1912                if (or->async_error == -ENOMEM)
1913                        osi->osd_err_pri = OSD_ERR_PRI_RESOURCE;
1914                else
1915                        osi->osd_err_pri = OSD_ERR_PRI_UNREACHABLE;
1916                ret = or->async_error;
1917        } else if (osi->key <= scsi_sk_recovered_error) {
1918                osi->osd_err_pri = 0;
1919                ret = 0;
1920        } else if (osi->additional_code == scsi_invalid_field_in_cdb) {
1921                if (osi->cdb_field_offset == OSD_CFO_STARTING_BYTE) {
1922                        osi->osd_err_pri = OSD_ERR_PRI_CLEAR_PAGES;
1923                        ret = -EFAULT; /* caller should recover from this */
1924                } else if (osi->cdb_field_offset == OSD_CFO_OBJECT_ID) {
1925                        osi->osd_err_pri = OSD_ERR_PRI_NOT_FOUND;
1926                        ret = -ENOENT;
1927                } else if (osi->cdb_field_offset == OSD_CFO_PERMISSIONS) {
1928                        osi->osd_err_pri = OSD_ERR_PRI_NO_ACCESS;
1929                        ret = -EACCES;
1930                } else {
1931                        osi->osd_err_pri = OSD_ERR_PRI_BAD_CRED;
1932                        ret = -EINVAL;
1933                }
1934        } else if (osi->additional_code == osd_quota_error) {
1935                osi->osd_err_pri = OSD_ERR_PRI_NO_SPACE;
1936                ret = -ENOSPC;
1937        } else if (_is_osd_security_code(osi->additional_code)) {
1938                osi->osd_err_pri = OSD_ERR_PRI_BAD_CRED;
1939                ret = -EINVAL;
1940        } else {
1941                osi->osd_err_pri = OSD_ERR_PRI_EIO;
1942                ret = -EIO;
1943        }
1944
1945        if (!or->out.residual)
1946                or->out.residual = or->out.total_bytes;
1947        if (!or->in.residual)
1948                or->in.residual = or->in.total_bytes;
1949
1950        return ret;
1951}
1952EXPORT_SYMBOL(osd_req_decode_sense_full);
1953
1954/*
1955 * Implementation of osd_sec.h API
1956 * TODO: Move to a separate osd_sec.c file at a later stage.
1957 */
1958
1959enum { OSD_SEC_CAP_V1_ALL_CAPS =
1960        OSD_SEC_CAP_APPEND | OSD_SEC_CAP_OBJ_MGMT | OSD_SEC_CAP_REMOVE   |
1961        OSD_SEC_CAP_CREATE | OSD_SEC_CAP_SET_ATTR | OSD_SEC_CAP_GET_ATTR |
1962        OSD_SEC_CAP_WRITE  | OSD_SEC_CAP_READ     | OSD_SEC_CAP_POL_SEC  |
1963        OSD_SEC_CAP_GLOBAL | OSD_SEC_CAP_DEV_MGMT
1964};
1965
1966enum { OSD_SEC_CAP_V2_ALL_CAPS =
1967        OSD_SEC_CAP_V1_ALL_CAPS | OSD_SEC_CAP_QUERY | OSD_SEC_CAP_M_OBJECT
1968};
1969
1970void osd_sec_init_nosec_doall_caps(void *caps,
1971        const struct osd_obj_id *obj, bool is_collection, const bool is_v1)
1972{
1973        struct osd_capability *cap = caps;
1974        u8 type;
1975        u8 descriptor_type;
1976
1977        if (likely(obj->id)) {
1978                if (unlikely(is_collection)) {
1979                        type = OSD_SEC_OBJ_COLLECTION;
1980                        descriptor_type = is_v1 ? OSD_SEC_OBJ_DESC_OBJ :
1981                                                  OSD_SEC_OBJ_DESC_COL;
1982                } else {
1983                        type = OSD_SEC_OBJ_USER;
1984                        descriptor_type = OSD_SEC_OBJ_DESC_OBJ;
1985                }
1986                WARN_ON(!obj->partition);
1987        } else {
1988                type = obj->partition ? OSD_SEC_OBJ_PARTITION :
1989                                        OSD_SEC_OBJ_ROOT;
1990                descriptor_type = OSD_SEC_OBJ_DESC_PAR;
1991        }
1992
1993        memset(cap, 0, sizeof(*cap));
1994
1995        cap->h.format = OSD_SEC_CAP_FORMAT_VER1;
1996        cap->h.integrity_algorithm__key_version = 0; /* MAKE_BYTE(0, 0); */
1997        cap->h.security_method = OSD_SEC_NOSEC;
1998/*      cap->expiration_time;
1999        cap->AUDIT[30-10];
2000        cap->discriminator[42-30];
2001        cap->object_created_time; */
2002        cap->h.object_type = type;
2003        osd_sec_set_caps(&cap->h, OSD_SEC_CAP_V1_ALL_CAPS);
2004        cap->h.object_descriptor_type = descriptor_type;
2005        cap->od.obj_desc.policy_access_tag = 0;
2006        cap->od.obj_desc.allowed_partition_id = cpu_to_be64(obj->partition);
2007        cap->od.obj_desc.allowed_object_id = cpu_to_be64(obj->id);
2008}
2009EXPORT_SYMBOL(osd_sec_init_nosec_doall_caps);
2010
2011/* FIXME: Extract version from caps pointer.
2012 *        Also Pete's target only supports caps from OSDv1 for now
2013 */
2014void osd_set_caps(struct osd_cdb *cdb, const void *caps)
2015{
2016        /* NOTE: They start at same address */
2017        memcpy(&cdb->v1.caps, caps, OSDv1_CAP_LEN);
2018}
2019
2020bool osd_is_sec_alldata(struct osd_security_parameters *sec_parms __unused)
2021{
2022        return false;
2023}
2024
2025void osd_sec_sign_cdb(struct osd_cdb *ocdb __unused, const u8 *cap_key __unused)
2026{
2027}
2028
2029void osd_sec_sign_data(void *data_integ __unused,
2030                       struct bio *bio __unused, const u8 *cap_key __unused)
2031{
2032}
2033
2034/*
2035 * Declared in osd_protocol.h
2036 * 4.12.5 Data-In and Data-Out buffer offsets
2037 * byte offset = mantissa * (2^(exponent+8))
2038 * Returns the smallest allowed encoded offset that contains given @offset
2039 * The actual encoded offset returned is @offset + *@padding.
2040 */
2041osd_cdb_offset __osd_encode_offset(
2042        u64 offset, unsigned *padding, int min_shift, int max_shift)
2043{
2044        u64 try_offset = -1, mod, align;
2045        osd_cdb_offset be32_offset;
2046        int shift;
2047
2048        *padding = 0;
2049        if (!offset)
2050                return 0;
2051
2052        for (shift = min_shift; shift < max_shift; ++shift) {
2053                try_offset = offset >> shift;
2054                if (try_offset < (1 << OSD_OFFSET_MAX_BITS))
2055                        break;
2056        }
2057
2058        BUG_ON(shift == max_shift);
2059
2060        align = 1 << shift;
2061        mod = offset & (align - 1);
2062        if (mod) {
2063                *padding = align - mod;
2064                try_offset += 1;
2065        }
2066
2067        try_offset |= ((shift - 8) & 0xf) << 28;
2068        be32_offset = cpu_to_be32((u32)try_offset);
2069
2070        OSD_DEBUG("offset=%llu mantissa=%llu exp=%d encoded=%x pad=%d\n",
2071                 _LLU(offset), _LLU(try_offset & 0x0FFFFFFF), shift,
2072                 be32_offset, *padding);
2073        return be32_offset;
2074}
2075