drivers/target/target_core_cdb.c

   1 /*
   2  * CDB emulation for non-READ/WRITE commands.
   3  *
   4  * Copyright (c) 2002, 2003, 2004, 2005 PyX Technologies, Inc.
   5  * Copyright (c) 2005, 2006, 2007 SBE, Inc.
   6  * Copyright (c) 2007-2010 Rising Tide Systems
   7  * Copyright (c) 2008-2010 Linux-iSCSI.org
   8  *
   9  * Nicholas A. Bellinger <nab@kernel.org>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  */
  25
  26 #include <linux/kernel.h>
  27 #include <linux/module.h>
  28 #include <asm/unaligned.h>
  29 #include <scsi/scsi.h>
  30
  31 #include <target/target_core_base.h>
  32 #include <target/target_core_backend.h>
  33 #include <target/target_core_fabric.h>
  34
  35 #include "target_core_internal.h"
  36 #include "target_core_ua.h"
  37
  38 static void
  39 target_fill_alua_data(struct se_port *port, unsigned char *buf)
  40 {
  41         struct t10_alua_tg_pt_gp *tg_pt_gp;
  42         struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
  43
  44         /*
  45          * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
  46          */
  47         buf[5]  = 0x80;
  48
  49         /*
  50          * Set TPGS field for explict and/or implict ALUA access type
  51          * and opteration.
  52          *
  53          * See spc4r17 section 6.4.2 Table 135
  54          */
  55         if (!port)
  56                 return;
  57         tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
  58         if (!tg_pt_gp_mem)
  59                 return;
  60
  61         spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
  62         tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
  63         if (tg_pt_gp)
  64                 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
  65         spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
  66 }
  67
  68 static int
  69 target_emulate_inquiry_std(struct se_cmd *cmd, char *buf)
  70 {
  71         struct se_lun *lun = cmd->se_lun;
  72         struct se_device *dev = cmd->se_dev;
  73
  74         /* Set RMB (removable media) for tape devices */
  75         if (dev->transport->get_device_type(dev) == TYPE_TAPE)
  76                 buf[1] = 0x80;
  77
  78         buf[2] = dev->transport->get_device_rev(dev);
  79
  80         /*
  81          * NORMACA and HISUP = 0, RESPONSE DATA FORMAT = 2
  82          *
  83          * SPC4 says:
  84          *   A RESPONSE DATA FORMAT field set to 2h indicates that the
  85          *   standard INQUIRY data is in the format defined in this
  86          *   standard. Response data format values less than 2h are
  87          *   obsolete. Response data format values greater than 2h are
  88          *   reserved.
  89          */
  90         buf[3] = 2;
  91
  92         /*
  93          * Enable SCCS and TPGS fields for Emulated ALUA
  94          */
  95         if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
  96                 target_fill_alua_data(lun->lun_sep, buf);
  97
  98         buf[7] = 0x2; /* CmdQue=1 */
  99
 100         snprintf(&buf[8], 8, "LIO-ORG");
 101         snprintf(&buf[16], 16, "%s", dev->se_sub_dev->t10_wwn.model);
 102         snprintf(&buf[32], 4, "%s", dev->se_sub_dev->t10_wwn.revision);
 103         buf[4] = 31; /* Set additional length to 31 */
 104
 105         return 0;
 106 }
 107
 108 /* unit serial number */
 109 static int
 110 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
 111 {
 112         struct se_device *dev = cmd->se_dev;
 113         u16 len = 0;
 114
 115         if (dev->se_sub_dev->su_dev_flags &
 116                         SDF_EMULATED_VPD_UNIT_SERIAL) {
 117                 u32 unit_serial_len;
 118
 119                 unit_serial_len = strlen(dev->se_sub_dev->t10_wwn.unit_serial);
 120                 unit_serial_len++; /* For NULL Terminator */
 121
 122                 len += sprintf(&buf[4], "%s",
 123                         dev->se_sub_dev->t10_wwn.unit_serial);
 124                 len++; /* Extra Byte for NULL Terminator */
 125                 buf[3] = len;
 126         }
 127         return 0;
 128 }
 129
 130 static void
 131 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
 132 {
 133         unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
 134         int cnt;
 135         bool next = true;
 136
 137         /*
 138          * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
 139          * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
 140          * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
 141          * to complete the payload.  These are based from VPD=0x80 PRODUCT SERIAL
 142          * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
 143          * per device uniqeness.
 144          */
 145         for (cnt = 0; *p && cnt < 13; p++) {
 146                 int val = hex_to_bin(*p);
 147
 148                 if (val < 0)
 149                         continue;
 150
 151                 if (next) {
 152                         next = false;
 153                         buf[cnt++] |= val;
 154                 } else {
 155                         next = true;
 156                         buf[cnt] = val << 4;
 157                 }
 158         }
 159 }
 160
 161 /*
 162  * Device identification VPD, for a complete list of
 163  * DESIGNATOR TYPEs see spc4r17 Table 459.
 164  */
 165 static int
 166 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
 167 {
 168         struct se_device *dev = cmd->se_dev;
 169         struct se_lun *lun = cmd->se_lun;
 170         struct se_port *port = NULL;
 171         struct se_portal_group *tpg = NULL;
 172         struct t10_alua_lu_gp_member *lu_gp_mem;
 173         struct t10_alua_tg_pt_gp *tg_pt_gp;
 174         struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
 175         unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
 176         u32 prod_len;
 177         u32 unit_serial_len, off = 0;
 178         u16 len = 0, id_len;
 179
 180         off = 4;
 181
 182         /*
 183          * NAA IEEE Registered Extended Assigned designator format, see
 184          * spc4r17 section 7.7.3.6.5
 185          *
 186          * We depend upon a target_core_mod/ConfigFS provided
 187          * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
 188          * value in order to return the NAA id.
 189          */
 190         if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
 191                 goto check_t10_vend_desc;
 192
 193         /* CODE SET == Binary */
 194         buf[off++] = 0x1;
 195
 196         /* Set ASSOCIATION == addressed logical unit: 0)b */
 197         buf[off] = 0x00;
 198
 199         /* Identifier/Designator type == NAA identifier */
 200         buf[off++] |= 0x3;
 201         off++;
 202
 203         /* Identifier/Designator length */
 204         buf[off++] = 0x10;
 205
 206         /*
 207          * Start NAA IEEE Registered Extended Identifier/Designator
 208          */
 209         buf[off++] = (0x6 << 4);
 210
 211         /*
 212          * Use OpenFabrics IEEE Company ID: 00 14 05
 213          */
 214         buf[off++] = 0x01;
 215         buf[off++] = 0x40;
 216         buf[off] = (0x5 << 4);
 217
 218         /*
 219          * Return ConfigFS Unit Serial Number information for
 220          * VENDOR_SPECIFIC_IDENTIFIER and
 221          * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
 222          */
 223         target_parse_naa_6h_vendor_specific(dev, &buf[off]);
 224
 225         len = 20;
 226         off = (len + 4);
 227
 228 check_t10_vend_desc:
 229         /*
 230          * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
 231          */
 232         id_len = 8; /* For Vendor field */
 233         prod_len = 4; /* For VPD Header */
 234         prod_len += 8; /* For Vendor field */
 235         prod_len += strlen(prod);
 236         prod_len++; /* For : */
 237
 238         if (dev->se_sub_dev->su_dev_flags &
 239                         SDF_EMULATED_VPD_UNIT_SERIAL) {
 240                 unit_serial_len =
 241                         strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
 242                 unit_serial_len++; /* For NULL Terminator */
 243
 244                 id_len += sprintf(&buf[off+12], "%s:%s", prod,
 245                                 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
 246         }
 247         buf[off] = 0x2; /* ASCII */
 248         buf[off+1] = 0x1; /* T10 Vendor ID */
 249         buf[off+2] = 0x0;
 250         memcpy(&buf[off+4], "LIO-ORG", 8);
 251         /* Extra Byte for NULL Terminator */
 252         id_len++;
 253         /* Identifier Length */
 254         buf[off+3] = id_len;
 255         /* Header size for Designation descriptor */
 256         len += (id_len + 4);
 257         off += (id_len + 4);
 258         /*
 259          * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
 260          */
 261         port = lun->lun_sep;
 262         if (port) {
 263                 struct t10_alua_lu_gp *lu_gp;
 264                 u32 padding, scsi_name_len;
 265                 u16 lu_gp_id = 0;
 266                 u16 tg_pt_gp_id = 0;
 267                 u16 tpgt;
 268
 269                 tpg = port->sep_tpg;
 270                 /*
 271                  * Relative target port identifer, see spc4r17
 272                  * section 7.7.3.7
 273                  *
 274                  * Get the PROTOCOL IDENTIFIER as defined by spc4r17
 275                  * section 7.5.1 Table 362
 276                  */
 277                 buf[off] =
 278                         (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
 279                 buf[off++] |= 0x1; /* CODE SET == Binary */
 280                 buf[off] = 0x80; /* Set PIV=1 */
 281                 /* Set ASSOCIATION == target port: 01b */
 282                 buf[off] |= 0x10;
 283                 /* DESIGNATOR TYPE == Relative target port identifer */
 284                 buf[off++] |= 0x4;
 285                 off++; /* Skip over Reserved */
 286                 buf[off++] = 4; /* DESIGNATOR LENGTH */
 287                 /* Skip over Obsolete field in RTPI payload
 288                  * in Table 472 */
 289                 off += 2;
 290                 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
 291                 buf[off++] = (port->sep_rtpi & 0xff);
 292                 len += 8; /* Header size + Designation descriptor */
 293                 /*
 294                  * Target port group identifier, see spc4r17
 295                  * section 7.7.3.8
 296                  *
 297                  * Get the PROTOCOL IDENTIFIER as defined by spc4r17
 298                  * section 7.5.1 Table 362
 299                  */
 300                 if (dev->se_sub_dev->t10_alua.alua_type !=
 301                                 SPC3_ALUA_EMULATED)
 302                         goto check_scsi_name;
 303
 304                 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
 305                 if (!tg_pt_gp_mem)
 306                         goto check_lu_gp;
 307
 308                 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
 309                 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
 310                 if (!tg_pt_gp) {
 311                         spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
 312                         goto check_lu_gp;
 313                 }
 314                 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
 315                 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
 316
 317                 buf[off] =
 318                         (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
 319                 buf[off++] |= 0x1; /* CODE SET == Binary */
 320                 buf[off] = 0x80; /* Set PIV=1 */
 321                 /* Set ASSOCIATION == target port: 01b */
 322                 buf[off] |= 0x10;
 323                 /* DESIGNATOR TYPE == Target port group identifier */
 324                 buf[off++] |= 0x5;
 325                 off++; /* Skip over Reserved */
 326                 buf[off++] = 4; /* DESIGNATOR LENGTH */
 327                 off += 2; /* Skip over Reserved Field */
 328                 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
 329                 buf[off++] = (tg_pt_gp_id & 0xff);
 330                 len += 8; /* Header size + Designation descriptor */
 331                 /*
 332                  * Logical Unit Group identifier, see spc4r17
 333                  * section 7.7.3.8
 334                  */
 335 check_lu_gp:
 336                 lu_gp_mem = dev->dev_alua_lu_gp_mem;
 337                 if (!lu_gp_mem)
 338                         goto check_scsi_name;
 339
 340                 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
 341                 lu_gp = lu_gp_mem->lu_gp;
 342                 if (!lu_gp) {
 343                         spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
 344                         goto check_scsi_name;
 345                 }
 346                 lu_gp_id = lu_gp->lu_gp_id;
 347                 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
 348
 349                 buf[off++] |= 0x1; /* CODE SET == Binary */
 350                 /* DESIGNATOR TYPE == Logical Unit Group identifier */
 351                 buf[off++] |= 0x6;
 352                 off++; /* Skip over Reserved */
 353                 buf[off++] = 4; /* DESIGNATOR LENGTH */
 354                 off += 2; /* Skip over Reserved Field */
 355                 buf[off++] = ((lu_gp_id >> 8) & 0xff);
 356                 buf[off++] = (lu_gp_id & 0xff);
 357                 len += 8; /* Header size + Designation descriptor */
 358                 /*
 359                  * SCSI name string designator, see spc4r17
 360                  * section 7.7.3.11
 361                  *
 362                  * Get the PROTOCOL IDENTIFIER as defined by spc4r17
 363                  * section 7.5.1 Table 362
 364                  */
 365 check_scsi_name:
 366                 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
 367                 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
 368                 scsi_name_len += 10;
 369                 /* Check for 4-byte padding */
 370                 padding = ((-scsi_name_len) & 3);
 371                 if (padding != 0)
 372                         scsi_name_len += padding;
 373                 /* Header size + Designation descriptor */
 374                 scsi_name_len += 4;
 375
 376                 buf[off] =
 377                         (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
 378                 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
 379                 buf[off] = 0x80; /* Set PIV=1 */
 380                 /* Set ASSOCIATION == target port: 01b */
 381                 buf[off] |= 0x10;
 382                 /* DESIGNATOR TYPE == SCSI name string */
 383                 buf[off++] |= 0x8;
 384                 off += 2; /* Skip over Reserved and length */
 385                 /*
 386                  * SCSI name string identifer containing, $FABRIC_MOD
 387                  * dependent information.  For LIO-Target and iSCSI
 388                  * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
 389                  * UTF-8 encoding.
 390                  */
 391                 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
 392                 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
 393                                         tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
 394                 scsi_name_len += 1 /* Include  NULL terminator */;
 395                 /*
 396                  * The null-terminated, null-padded (see 4.4.2) SCSI
 397                  * NAME STRING field contains a UTF-8 format string.
 398                  * The number of bytes in the SCSI NAME STRING field
 399                  * (i.e., the value in the DESIGNATOR LENGTH field)
 400                  * shall be no larger than 256 and shall be a multiple
 401                  * of four.
 402                  */
 403                 if (padding)
 404                         scsi_name_len += padding;
 405
 406                 buf[off-1] = scsi_name_len;
 407                 off += scsi_name_len;
 408                 /* Header size + Designation descriptor */
 409                 len += (scsi_name_len + 4);
 410         }
 411         buf[2] = ((len >> 8) & 0xff);
 412         buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
 413         return 0;
 414 }
 415
 416 /* Extended INQUIRY Data VPD Page */
 417 static int
 418 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
 419 {
 420         buf[3] = 0x3c;
 421         /* Set HEADSUP, ORDSUP, SIMPSUP */
 422         buf[5] = 0x07;
 423
 424         /* If WriteCache emulation is enabled, set V_SUP */
 425         if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
 426                 buf[6] = 0x01;
 427         return 0;
 428 }
 429
 430 /* Block Limits VPD page */
 431 static int
 432 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
 433 {
 434         struct se_device *dev = cmd->se_dev;
 435         u32 max_sectors;
 436         int have_tp = 0;
 437
 438         /*
 439          * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
 440          * emulate_tpu=1 or emulate_tpws=1 we will be expect a
 441          * different page length for Thin Provisioning.
 442          */
 443         if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
 444                 have_tp = 1;
 445
 446         buf[0] = dev->transport->get_device_type(dev);
 447         buf[3] = have_tp ? 0x3c : 0x10;
 448
 449         /* Set WSNZ to 1 */
 450         buf[4] = 0x01;
 451
 452         /*
 453          * Set OPTIMAL TRANSFER LENGTH GRANULARITY
 454          */
 455         put_unaligned_be16(1, &buf[6]);
 456
 457         /*
 458          * Set MAXIMUM TRANSFER LENGTH
 459          */
 460         max_sectors = min(dev->se_sub_dev->se_dev_attrib.fabric_max_sectors,
 461                           dev->se_sub_dev->se_dev_attrib.hw_max_sectors);
 462         put_unaligned_be32(max_sectors, &buf[8]);
 463
 464         /*
 465          * Set OPTIMAL TRANSFER LENGTH
 466          */
 467         put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
 468
 469         /*
 470          * Exit now if we don't support TP.
 471          */
 472         if (!have_tp)
 473                 return 0;
 474
 475         /*
 476          * Set MAXIMUM UNMAP LBA COUNT
 477          */
 478         put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
 479
 480         /*
 481          * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
 482          */
 483         put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
 484                            &buf[24]);
 485
 486         /*
 487          * Set OPTIMAL UNMAP GRANULARITY
 488          */
 489         put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
 490
 491         /*
 492          * UNMAP GRANULARITY ALIGNMENT
 493          */
 494         put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
 495                            &buf[32]);
 496         if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
 497                 buf[32] |= 0x80; /* Set the UGAVALID bit */
 498
 499         return 0;
 500 }
 501
 502 /* Block Device Characteristics VPD page */
 503 static int
 504 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
 505 {
 506         struct se_device *dev = cmd->se_dev;
 507
 508         buf[0] = dev->transport->get_device_type(dev);
 509         buf[3] = 0x3c;
 510         buf[5] = dev->se_sub_dev->se_dev_attrib.is_nonrot ? 1 : 0;
 511
 512         return 0;
 513 }
 514
 515 /* Thin Provisioning VPD */
 516 static int
 517 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
 518 {
 519         struct se_device *dev = cmd->se_dev;
 520
 521         /*
 522          * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
 523          *
 524          * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
 525          * zero, then the page length shall be set to 0004h.  If the DP bit
 526          * is set to one, then the page length shall be set to the value
 527          * defined in table 162.
 528          */
 529         buf[0] = dev->transport->get_device_type(dev);
 530
 531         /*
 532          * Set Hardcoded length mentioned above for DP=0
 533          */
 534         put_unaligned_be16(0x0004, &buf[2]);
 535
 536         /*
 537          * The THRESHOLD EXPONENT field indicates the threshold set size in
 538          * LBAs as a power of 2 (i.e., the threshold set size is equal to
 539          * 2(threshold exponent)).
 540          *
 541          * Note that this is currently set to 0x00 as mkp says it will be
 542          * changing again.  We can enable this once it has settled in T10
 543          * and is actually used by Linux/SCSI ML code.
 544          */
 545         buf[4] = 0x00;
 546
 547         /*
 548          * A TPU bit set to one indicates that the device server supports
 549          * the UNMAP command (see 5.25). A TPU bit set to zero indicates
 550          * that the device server does not support the UNMAP command.
 551          */
 552         if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
 553                 buf[5] = 0x80;
 554
 555         /*
 556          * A TPWS bit set to one indicates that the device server supports
 557          * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
 558          * A TPWS bit set to zero indicates that the device server does not
 559          * support the use of the WRITE SAME (16) command to unmap LBAs.
 560          */
 561         if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
 562                 buf[5] |= 0x40;
 563
 564         return 0;
 565 }
 566
 567 static int
 568 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
 569
 570 static struct {
 571         uint8_t         page;
 572         int             (*emulate)(struct se_cmd *, unsigned char *);
 573 } evpd_handlers[] = {
 574         { .page = 0x00, .emulate = target_emulate_evpd_00 },
 575         { .page = 0x80, .emulate = target_emulate_evpd_80 },
 576         { .page = 0x83, .emulate = target_emulate_evpd_83 },
 577         { .page = 0x86, .emulate = target_emulate_evpd_86 },
 578         { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
 579         { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
 580         { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
 581 };
 582
 583 /* supported vital product data pages */
 584 static int
 585 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
 586 {
 587         int p;
 588
 589         /*
 590          * Only report the INQUIRY EVPD=1 pages after a valid NAA
 591          * Registered Extended LUN WWN has been set via ConfigFS
 592          * during device creation/restart.
 593          */
 594         if (cmd->se_dev->se_sub_dev->su_dev_flags &
 595                         SDF_EMULATED_VPD_UNIT_SERIAL) {
 596                 buf[3] = ARRAY_SIZE(evpd_handlers);
 597                 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p)
 598                         buf[p + 4] = evpd_handlers[p].page;
 599         }
 600
 601         return 0;
 602 }
 603
 604 int target_emulate_inquiry(struct se_cmd *cmd)
 605 {
 606         struct se_device *dev = cmd->se_dev;
 607         struct se_portal_group *tpg = cmd->se_lun->lun_sep->sep_tpg;
 608         unsigned char *buf, *map_buf;
 609         unsigned char *cdb = cmd->t_task_cdb;
 610         int p, ret;
 611
 612         map_buf = transport_kmap_data_sg(cmd);
 613         /*
 614          * If SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC is not set, then we
 615          * know we actually allocated a full page.  Otherwise, if the
 616          * data buffer is too small, allocate a temporary buffer so we
 617          * don't have to worry about overruns in all our INQUIRY
 618          * emulation handling.
 619          */
 620         if (cmd->data_length < SE_INQUIRY_BUF &&
 621             (cmd->se_cmd_flags & SCF_PASSTHROUGH_SG_TO_MEM_NOALLOC)) {
 622                 buf = kzalloc(SE_INQUIRY_BUF, GFP_KERNEL);
 623                 if (!buf) {
 624                         transport_kunmap_data_sg(cmd);
 625                         cmd->scsi_sense_reason = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
 626                         return -ENOMEM;
 627                 }
 628         } else {
 629                 buf = map_buf;
 630         }
 631
 632         if (dev == tpg->tpg_virt_lun0.lun_se_dev)
 633                 buf[0] = 0x3f; /* Not connected */
 634         else
 635                 buf[0] = dev->transport->get_device_type(dev);
 636
 637         if (!(cdb[1] & 0x1)) {
 638                 if (cdb[2]) {
 639                         pr_err("INQUIRY with EVPD==0 but PAGE CODE=%02x\n",
 640                                cdb[2]);
 641                         cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
 642                         ret = -EINVAL;
 643                         goto out;
 644                 }
 645
 646                 ret = target_emulate_inquiry_std(cmd, buf);
 647                 goto out;
 648         }
 649
 650         for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
 651                 if (cdb[2] == evpd_handlers[p].page) {
 652                         buf[1] = cdb[2];
 653                         ret = evpd_handlers[p].emulate(cmd, buf);
 654                         goto out;
 655                 }
 656         }
 657
 658         pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
 659         cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
 660         ret = -EINVAL;
 661
 662 out:
 663         if (buf != map_buf) {
 664                 memcpy(map_buf, buf, cmd->data_length);
 665                 kfree(buf);
 666         }
 667         transport_kunmap_data_sg(cmd);
 668
 669         if (!ret)
 670                 target_complete_cmd(cmd, GOOD);
 671         return ret;
 672 }
 673
 674 int target_emulate_readcapacity(struct se_cmd *cmd)
 675 {
 676         struct se_device *dev = cmd->se_dev;
 677         unsigned char *buf;
 678         unsigned long long blocks_long = dev->transport->get_blocks(dev);
 679         u32 blocks;
 680
 681         if (blocks_long >= 0x00000000ffffffff)
 682                 blocks = 0xffffffff;
 683         else
 684                 blocks = (u32)blocks_long;
 685
 686         buf = transport_kmap_data_sg(cmd);
 687
 688         buf[0] = (blocks >> 24) & 0xff;
 689         buf[1] = (blocks >> 16) & 0xff;
 690         buf[2] = (blocks >> 8) & 0xff;
 691         buf[3] = blocks & 0xff;
 692         buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
 693         buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
 694         buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
 695         buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
 696
 697         transport_kunmap_data_sg(cmd);
 698
 699         target_complete_cmd(cmd, GOOD);
 700         return 0;
 701 }
 702
 703 int target_emulate_readcapacity_16(struct se_cmd *cmd)
 704 {
 705         struct se_device *dev = cmd->se_dev;
 706         unsigned char *buf;
 707         unsigned long long blocks = dev->transport->get_blocks(dev);
 708
 709         buf = transport_kmap_data_sg(cmd);
 710
 711         buf[0] = (blocks >> 56) & 0xff;
 712         buf[1] = (blocks >> 48) & 0xff;
 713         buf[2] = (blocks >> 40) & 0xff;
 714         buf[3] = (blocks >> 32) & 0xff;
 715         buf[4] = (blocks >> 24) & 0xff;
 716         buf[5] = (blocks >> 16) & 0xff;
 717         buf[6] = (blocks >> 8) & 0xff;
 718         buf[7] = blocks & 0xff;
 719         buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
 720         buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
 721         buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
 722         buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
 723         /*
 724          * Set Thin Provisioning Enable bit following sbc3r22 in section
 725          * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
 726          */
 727         if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
 728                 buf[14] = 0x80;
 729
 730         transport_kunmap_data_sg(cmd);
 731
 732         target_complete_cmd(cmd, GOOD);
 733         return 0;
 734 }
 735
 736 static int
 737 target_modesense_rwrecovery(unsigned char *p)
 738 {
 739         p[0] = 0x01;
 740         p[1] = 0x0a;
 741
 742         return 12;
 743 }
 744
 745 static int
 746 target_modesense_control(struct se_device *dev, unsigned char *p)
 747 {
 748         p[0] = 0x0a;
 749         p[1] = 0x0a;
 750         p[2] = 2;
 751         /*
 752          * From spc4r23, 7.4.7 Control mode page
 753          *
 754          * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
 755          * restrictions on the algorithm used for reordering commands
 756          * having the SIMPLE task attribute (see SAM-4).
 757          *
 758          *                    Table 368 -- QUEUE ALGORITHM MODIFIER field
 759          *                         Code      Description
 760          *                          0h       Restricted reordering
 761          *                          1h       Unrestricted reordering allowed
 762          *                          2h to 7h    Reserved
 763          *                          8h to Fh    Vendor specific
 764          *
 765          * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
 766          * the device server shall order the processing sequence of commands
 767          * having the SIMPLE task attribute such that data integrity is maintained
 768          * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
 769          * requests is halted at any time, the final value of all data observable
 770          * on the medium shall be the same as if all the commands had been processed
 771          * with the ORDERED task attribute).
 772          *
 773          * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
 774          * device server may reorder the processing sequence of commands having the
 775          * SIMPLE task attribute in any manner. Any data integrity exposures related to
 776          * command sequence order shall be explicitly handled by the application client
 777          * through the selection of appropriate ommands and task attributes.
 778          */
 779         p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
 780         /*
 781          * From spc4r17, section 7.4.6 Control mode Page
 782          *
 783          * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
 784          *
 785          * 00b: The logical unit shall clear any unit attention condition
 786          * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
 787          * status and shall not establish a unit attention condition when a com-
 788          * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
 789          * status.
 790          *
 791          * 10b: The logical unit shall not clear any unit attention condition
 792          * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
 793          * status and shall not establish a unit attention condition when
 794          * a command is completed with BUSY, TASK SET FULL, or RESERVATION
 795          * CONFLICT status.
 796          *
 797          * 11b a The logical unit shall not clear any unit attention condition
 798          * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
 799          * status and shall establish a unit attention condition for the
 800          * initiator port associated with the I_T nexus on which the BUSY,
 801          * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
 802          * Depending on the status, the additional sense code shall be set to
 803          * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
 804          * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
 805          * command, a unit attention condition shall be established only once
 806          * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
 807          * to the number of commands completed with one of those status codes.
 808          */
 809         p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
 810                (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
 811         /*
 812          * From spc4r17, section 7.4.6 Control mode Page
 813          *
 814          * Task Aborted Status (TAS) bit set to zero.
 815          *
 816          * A task aborted status (TAS) bit set to zero specifies that aborted
 817          * tasks shall be terminated by the device server without any response
 818          * to the application client. A TAS bit set to one specifies that tasks
 819          * aborted by the actions of an I_T nexus other than the I_T nexus on
 820          * which the command was received shall be completed with TASK ABORTED
 821          * status (see SAM-4).
 822          */
 823         p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
 824         p[8] = 0xff;
 825         p[9] = 0xff;
 826         p[11] = 30;
 827
 828         return 12;
 829 }
 830
 831 static int
 832 target_modesense_caching(struct se_device *dev, unsigned char *p)
 833 {
 834         p[0] = 0x08;
 835         p[1] = 0x12;
 836         if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
 837                 p[2] = 0x04; /* Write Cache Enable */
 838         p[12] = 0x20; /* Disabled Read Ahead */
 839
 840         return 20;
 841 }
 842
 843 static void
 844 target_modesense_write_protect(unsigned char *buf, int type)
 845 {
 846         /*
 847          * I believe that the WP bit (bit 7) in the mode header is the same for
 848          * all device types..
 849          */
 850         switch (type) {
 851         case TYPE_DISK:
 852         case TYPE_TAPE:
 853         default:
 854                 buf[0] |= 0x80; /* WP bit */
 855                 break;
 856         }
 857 }
 858
 859 static void
 860 target_modesense_dpofua(unsigned char *buf, int type)
 861 {
 862         switch (type) {
 863         case TYPE_DISK:
 864                 buf[0] |= 0x10; /* DPOFUA bit */
 865                 break;
 866         default:
 867                 break;
 868         }
 869 }
 870
 871 int target_emulate_modesense(struct se_cmd *cmd)
 872 {
 873         struct se_device *dev = cmd->se_dev;
 874         char *cdb = cmd->t_task_cdb;
 875         unsigned char *rbuf;
 876         int type = dev->transport->get_device_type(dev);
 877         int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
 878         int offset = ten ? 8 : 4;
 879         int length = 0;
 880         unsigned char buf[SE_MODE_PAGE_BUF];
 881
 882         memset(buf, 0, SE_MODE_PAGE_BUF);
 883
 884         switch (cdb[2] & 0x3f) {
 885         case 0x01:
 886                 length = target_modesense_rwrecovery(&buf[offset]);
 887                 break;
 888         case 0x08:
 889                 length = target_modesense_caching(dev, &buf[offset]);
 890                 break;
 891         case 0x0a:
 892                 length = target_modesense_control(dev, &buf[offset]);
 893                 break;
 894         case 0x3f:
 895                 length = target_modesense_rwrecovery(&buf[offset]);
 896                 length += target_modesense_caching(dev, &buf[offset+length]);
 897                 length += target_modesense_control(dev, &buf[offset+length]);
 898                 break;
 899         default:
 900                 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
 901                        cdb[2] & 0x3f, cdb[3]);
 902                 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
 903                 return -EINVAL;
 904         }
 905         offset += length;
 906
 907         if (ten) {
 908                 offset -= 2;
 909                 buf[0] = (offset >> 8) & 0xff;
 910                 buf[1] = offset & 0xff;
 911
 912                 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
 913                     (cmd->se_deve &&
 914                     (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
 915                         target_modesense_write_protect(&buf[3], type);
 916
 917                 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
 918                     (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
 919                         target_modesense_dpofua(&buf[3], type);
 920
 921                 if ((offset + 2) > cmd->data_length)
 922                         offset = cmd->data_length;
 923
 924         } else {
 925                 offset -= 1;
 926                 buf[0] = offset & 0xff;
 927
 928                 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
 929                     (cmd->se_deve &&
 930                     (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
 931                         target_modesense_write_protect(&buf[2], type);
 932
 933                 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
 934                     (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
 935                         target_modesense_dpofua(&buf[2], type);
 936
 937                 if ((offset + 1) > cmd->data_length)
 938                         offset = cmd->data_length;
 939         }
 940
 941         rbuf = transport_kmap_data_sg(cmd);
 942         memcpy(rbuf, buf, offset);
 943         transport_kunmap_data_sg(cmd);
 944
 945         target_complete_cmd(cmd, GOOD);
 946         return 0;
 947 }
 948
 949 int target_emulate_request_sense(struct se_cmd *cmd)
 950 {
 951         unsigned char *cdb = cmd->t_task_cdb;
 952         unsigned char *buf;
 953         u8 ua_asc = 0, ua_ascq = 0;
 954         int err = 0;
 955
 956         if (cdb[1] & 0x01) {
 957                 pr_err("REQUEST_SENSE description emulation not"
 958                         " supported\n");
 959                 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
 960                 return -ENOSYS;
 961         }
 962
 963         buf = transport_kmap_data_sg(cmd);
 964
 965         if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
 966                 /*
 967                  * CURRENT ERROR, UNIT ATTENTION
 968                  */
 969                 buf[0] = 0x70;
 970                 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
 971
 972                 if (cmd->data_length < 18) {
 973                         buf[7] = 0x00;
 974                         err = -EINVAL;
 975                         goto end;
 976                 }
 977                 /*
 978                  * The Additional Sense Code (ASC) from the UNIT ATTENTION
 979                  */
 980                 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
 981                 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
 982                 buf[7] = 0x0A;
 983         } else {
 984                 /*
 985                  * CURRENT ERROR, NO SENSE
 986                  */
 987                 buf[0] = 0x70;
 988                 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
 989
 990                 if (cmd->data_length < 18) {
 991                         buf[7] = 0x00;
 992                         err = -EINVAL;
 993                         goto end;
 994                 }
 995                 /*
 996                  * NO ADDITIONAL SENSE INFORMATION
 997                  */
 998                 buf[SPC_ASC_KEY_OFFSET] = 0x00;
 999                 buf[7] = 0x0A;
1000         }
1001
1002 end:
1003         transport_kunmap_data_sg(cmd);
1004         target_complete_cmd(cmd, GOOD);
1005         return 0;
1006 }
1007
1008 /*
1009  * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1010  * Note this is not used for TCM/pSCSI passthrough
1011  */
1012 int target_emulate_unmap(struct se_cmd *cmd)
1013 {
1014         struct se_device *dev = cmd->se_dev;
1015         unsigned char *buf, *ptr = NULL;
1016         unsigned char *cdb = &cmd->t_task_cdb[0];
1017         sector_t lba;
1018         unsigned int size = cmd->data_length, range;
1019         int ret = 0, offset;
1020         unsigned short dl, bd_dl;
1021
1022         if (!dev->transport->do_discard) {
1023                 pr_err("UNMAP emulation not supported for: %s\n",
1024                                 dev->transport->name);
1025                 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1026                 return -ENOSYS;
1027         }
1028
1029         /* First UNMAP block descriptor starts at 8 byte offset */
1030         offset = 8;
1031         size -= 8;
1032         dl = get_unaligned_be16(&cdb[0]);
1033         bd_dl = get_unaligned_be16(&cdb[2]);
1034
1035         buf = transport_kmap_data_sg(cmd);
1036
1037         ptr = &buf[offset];
1038         pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1039                 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1040
1041         while (size) {
1042                 lba = get_unaligned_be64(&ptr[0]);
1043                 range = get_unaligned_be32(&ptr[8]);
1044                 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1045                                  (unsigned long long)lba, range);
1046
1047                 ret = dev->transport->do_discard(dev, lba, range);
1048                 if (ret < 0) {
1049                         pr_err("blkdev_issue_discard() failed: %d\n",
1050                                         ret);
1051                         goto err;
1052                 }
1053
1054                 ptr += 16;
1055                 size -= 16;
1056         }
1057
1058 err:
1059         transport_kunmap_data_sg(cmd);
1060         if (!ret)
1061                 target_complete_cmd(cmd, GOOD);
1062         return ret;
1063 }
1064
1065 /*
1066  * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1067  * Note this is not used for TCM/pSCSI passthrough
1068  */
1069 int target_emulate_write_same(struct se_cmd *cmd)
1070 {
1071         struct se_device *dev = cmd->se_dev;
1072         sector_t range;
1073         sector_t lba = cmd->t_task_lba;
1074         u32 num_blocks;
1075         int ret;
1076
1077         if (!dev->transport->do_discard) {
1078                 pr_err("WRITE_SAME emulation not supported"
1079                                 " for: %s\n", dev->transport->name);
1080                 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1081                 return -ENOSYS;
1082         }
1083
1084         if (cmd->t_task_cdb[0] == WRITE_SAME)
1085                 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
1086         else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
1087                 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
1088         else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
1089                 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
1090
1091         /*
1092          * Use the explicit range when non zero is supplied, otherwise calculate
1093          * the remaining range based on ->get_blocks() - starting LBA.
1094          */
1095         if (num_blocks != 0)
1096                 range = num_blocks;
1097         else
1098                 range = (dev->transport->get_blocks(dev) - lba) + 1;
1099
1100         pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1101                  (unsigned long long)lba, (unsigned long long)range);
1102
1103         ret = dev->transport->do_discard(dev, lba, range);
1104         if (ret < 0) {
1105                 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1106                 return ret;
1107         }
1108
1109         target_complete_cmd(cmd, GOOD);
1110         return 0;
1111 }
1112
1113 int target_emulate_synchronize_cache(struct se_cmd *cmd)
1114 {
1115         if (!cmd->se_dev->transport->do_sync_cache) {
1116                 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1117                         " for: %s\n", cmd->se_dev->transport->name);
1118                 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1119                 return -ENOSYS;
1120         }
1121
1122         cmd->se_dev->transport->do_sync_cache(cmd);
1123         return 0;
1124 }
1125
1126 int target_emulate_noop(struct se_cmd *cmd)
1127 {
1128         target_complete_cmd(cmd, GOOD);
1129         return 0;
1130 }