drivers/scsi/osd/osd_initiator.c

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