block, cfq: misc updates to cfq_io_context
[linux-2.6.git] / drivers / target / target_core_cdb.c
blob831468b3163d777f3eb5c982fc05819d37dea3e6
1 /*
2 * CDB emulation for non-READ/WRITE commands.
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
9 * Nicholas A. Bellinger <nab@kernel.org>
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.
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.
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.
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <asm/unaligned.h>
29 #include <scsi/scsi.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_transport.h>
33 #include <target/target_core_fabric_ops.h>
34 #include "target_core_ua.h"
35 #include "target_core_cdb.h"
37 static void
38 target_fill_alua_data(struct se_port *port, unsigned char *buf)
40 struct t10_alua_tg_pt_gp *tg_pt_gp;
41 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
44 * Set SCCS for MAINTENANCE_IN + REPORT_TARGET_PORT_GROUPS.
46 buf[5] = 0x80;
49 * Set TPGS field for explict and/or implict ALUA access type
50 * and opteration.
52 * See spc4r17 section 6.4.2 Table 135
54 if (!port)
55 return;
56 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
57 if (!tg_pt_gp_mem)
58 return;
60 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
61 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
62 if (tg_pt_gp)
63 buf[5] |= tg_pt_gp->tg_pt_gp_alua_access_type;
64 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
67 static int
68 target_emulate_inquiry_std(struct se_cmd *cmd)
70 struct se_lun *lun = cmd->se_lun;
71 struct se_device *dev = cmd->se_dev;
72 struct se_portal_group *tpg = lun->lun_sep->sep_tpg;
73 unsigned char *buf;
76 * Make sure we at least have 6 bytes of INQUIRY response
77 * payload going back for EVPD=0
79 if (cmd->data_length < 6) {
80 pr_err("SCSI Inquiry payload length: %u"
81 " too small for EVPD=0\n", cmd->data_length);
82 return -EINVAL;
85 buf = transport_kmap_first_data_page(cmd);
87 if (dev == tpg->tpg_virt_lun0.lun_se_dev) {
88 buf[0] = 0x3f; /* Not connected */
89 } else {
90 buf[0] = dev->transport->get_device_type(dev);
91 if (buf[0] == TYPE_TAPE)
92 buf[1] = 0x80;
94 buf[2] = dev->transport->get_device_rev(dev);
97 * Enable SCCS and TPGS fields for Emulated ALUA
99 if (dev->se_sub_dev->t10_alua.alua_type == SPC3_ALUA_EMULATED)
100 target_fill_alua_data(lun->lun_sep, buf);
102 if (cmd->data_length < 8) {
103 buf[4] = 1; /* Set additional length to 1 */
104 goto out;
107 buf[7] = 0x32; /* Sync=1 and CmdQue=1 */
110 * Do not include vendor, product, reversion info in INQUIRY
111 * response payload for cdbs with a small allocation length.
113 if (cmd->data_length < 36) {
114 buf[4] = 3; /* Set additional length to 3 */
115 goto out;
118 snprintf((unsigned char *)&buf[8], 8, "LIO-ORG");
119 snprintf((unsigned char *)&buf[16], 16, "%s",
120 &dev->se_sub_dev->t10_wwn.model[0]);
121 snprintf((unsigned char *)&buf[32], 4, "%s",
122 &dev->se_sub_dev->t10_wwn.revision[0]);
123 buf[4] = 31; /* Set additional length to 31 */
125 out:
126 transport_kunmap_first_data_page(cmd);
127 return 0;
130 /* unit serial number */
131 static int
132 target_emulate_evpd_80(struct se_cmd *cmd, unsigned char *buf)
134 struct se_device *dev = cmd->se_dev;
135 u16 len = 0;
137 if (dev->se_sub_dev->su_dev_flags &
138 SDF_EMULATED_VPD_UNIT_SERIAL) {
139 u32 unit_serial_len;
141 unit_serial_len =
142 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
143 unit_serial_len++; /* For NULL Terminator */
145 if (((len + 4) + unit_serial_len) > cmd->data_length) {
146 len += unit_serial_len;
147 buf[2] = ((len >> 8) & 0xff);
148 buf[3] = (len & 0xff);
149 return 0;
151 len += sprintf((unsigned char *)&buf[4], "%s",
152 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
153 len++; /* Extra Byte for NULL Terminator */
154 buf[3] = len;
156 return 0;
159 static void
160 target_parse_naa_6h_vendor_specific(struct se_device *dev, unsigned char *buf)
162 unsigned char *p = &dev->se_sub_dev->t10_wwn.unit_serial[0];
163 int cnt;
164 bool next = true;
167 * Generate up to 36 bits of VENDOR SPECIFIC IDENTIFIER starting on
168 * byte 3 bit 3-0 for NAA IEEE Registered Extended DESIGNATOR field
169 * format, followed by 64 bits of VENDOR SPECIFIC IDENTIFIER EXTENSION
170 * to complete the payload. These are based from VPD=0x80 PRODUCT SERIAL
171 * NUMBER set via vpd_unit_serial in target_core_configfs.c to ensure
172 * per device uniqeness.
174 for (cnt = 0; *p && cnt < 13; p++) {
175 int val = hex_to_bin(*p);
177 if (val < 0)
178 continue;
180 if (next) {
181 next = false;
182 buf[cnt++] |= val;
183 } else {
184 next = true;
185 buf[cnt] = val << 4;
191 * Device identification VPD, for a complete list of
192 * DESIGNATOR TYPEs see spc4r17 Table 459.
194 static int
195 target_emulate_evpd_83(struct se_cmd *cmd, unsigned char *buf)
197 struct se_device *dev = cmd->se_dev;
198 struct se_lun *lun = cmd->se_lun;
199 struct se_port *port = NULL;
200 struct se_portal_group *tpg = NULL;
201 struct t10_alua_lu_gp_member *lu_gp_mem;
202 struct t10_alua_tg_pt_gp *tg_pt_gp;
203 struct t10_alua_tg_pt_gp_member *tg_pt_gp_mem;
204 unsigned char *prod = &dev->se_sub_dev->t10_wwn.model[0];
205 u32 prod_len;
206 u32 unit_serial_len, off = 0;
207 u16 len = 0, id_len;
209 off = 4;
212 * NAA IEEE Registered Extended Assigned designator format, see
213 * spc4r17 section 7.7.3.6.5
215 * We depend upon a target_core_mod/ConfigFS provided
216 * /sys/kernel/config/target/core/$HBA/$DEV/wwn/vpd_unit_serial
217 * value in order to return the NAA id.
219 if (!(dev->se_sub_dev->su_dev_flags & SDF_EMULATED_VPD_UNIT_SERIAL))
220 goto check_t10_vend_desc;
222 if (off + 20 > cmd->data_length)
223 goto check_t10_vend_desc;
225 /* CODE SET == Binary */
226 buf[off++] = 0x1;
228 /* Set ASSOCIATION == addressed logical unit: 0)b */
229 buf[off] = 0x00;
231 /* Identifier/Designator type == NAA identifier */
232 buf[off++] |= 0x3;
233 off++;
235 /* Identifier/Designator length */
236 buf[off++] = 0x10;
239 * Start NAA IEEE Registered Extended Identifier/Designator
241 buf[off++] = (0x6 << 4);
244 * Use OpenFabrics IEEE Company ID: 00 14 05
246 buf[off++] = 0x01;
247 buf[off++] = 0x40;
248 buf[off] = (0x5 << 4);
251 * Return ConfigFS Unit Serial Number information for
252 * VENDOR_SPECIFIC_IDENTIFIER and
253 * VENDOR_SPECIFIC_IDENTIFIER_EXTENTION
255 target_parse_naa_6h_vendor_specific(dev, &buf[off]);
257 len = 20;
258 off = (len + 4);
260 check_t10_vend_desc:
262 * T10 Vendor Identifier Page, see spc4r17 section 7.7.3.4
264 id_len = 8; /* For Vendor field */
265 prod_len = 4; /* For VPD Header */
266 prod_len += 8; /* For Vendor field */
267 prod_len += strlen(prod);
268 prod_len++; /* For : */
270 if (dev->se_sub_dev->su_dev_flags &
271 SDF_EMULATED_VPD_UNIT_SERIAL) {
272 unit_serial_len =
273 strlen(&dev->se_sub_dev->t10_wwn.unit_serial[0]);
274 unit_serial_len++; /* For NULL Terminator */
276 if ((len + (id_len + 4) +
277 (prod_len + unit_serial_len)) >
278 cmd->data_length) {
279 len += (prod_len + unit_serial_len);
280 goto check_port;
282 id_len += sprintf((unsigned char *)&buf[off+12],
283 "%s:%s", prod,
284 &dev->se_sub_dev->t10_wwn.unit_serial[0]);
286 buf[off] = 0x2; /* ASCII */
287 buf[off+1] = 0x1; /* T10 Vendor ID */
288 buf[off+2] = 0x0;
289 memcpy((unsigned char *)&buf[off+4], "LIO-ORG", 8);
290 /* Extra Byte for NULL Terminator */
291 id_len++;
292 /* Identifier Length */
293 buf[off+3] = id_len;
294 /* Header size for Designation descriptor */
295 len += (id_len + 4);
296 off += (id_len + 4);
298 * struct se_port is only set for INQUIRY VPD=1 through $FABRIC_MOD
300 check_port:
301 port = lun->lun_sep;
302 if (port) {
303 struct t10_alua_lu_gp *lu_gp;
304 u32 padding, scsi_name_len;
305 u16 lu_gp_id = 0;
306 u16 tg_pt_gp_id = 0;
307 u16 tpgt;
309 tpg = port->sep_tpg;
311 * Relative target port identifer, see spc4r17
312 * section 7.7.3.7
314 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
315 * section 7.5.1 Table 362
317 if (((len + 4) + 8) > cmd->data_length) {
318 len += 8;
319 goto check_tpgi;
321 buf[off] =
322 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
323 buf[off++] |= 0x1; /* CODE SET == Binary */
324 buf[off] = 0x80; /* Set PIV=1 */
325 /* Set ASSOCIATION == target port: 01b */
326 buf[off] |= 0x10;
327 /* DESIGNATOR TYPE == Relative target port identifer */
328 buf[off++] |= 0x4;
329 off++; /* Skip over Reserved */
330 buf[off++] = 4; /* DESIGNATOR LENGTH */
331 /* Skip over Obsolete field in RTPI payload
332 * in Table 472 */
333 off += 2;
334 buf[off++] = ((port->sep_rtpi >> 8) & 0xff);
335 buf[off++] = (port->sep_rtpi & 0xff);
336 len += 8; /* Header size + Designation descriptor */
338 * Target port group identifier, see spc4r17
339 * section 7.7.3.8
341 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
342 * section 7.5.1 Table 362
344 check_tpgi:
345 if (dev->se_sub_dev->t10_alua.alua_type !=
346 SPC3_ALUA_EMULATED)
347 goto check_scsi_name;
349 if (((len + 4) + 8) > cmd->data_length) {
350 len += 8;
351 goto check_lu_gp;
353 tg_pt_gp_mem = port->sep_alua_tg_pt_gp_mem;
354 if (!tg_pt_gp_mem)
355 goto check_lu_gp;
357 spin_lock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
358 tg_pt_gp = tg_pt_gp_mem->tg_pt_gp;
359 if (!tg_pt_gp) {
360 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
361 goto check_lu_gp;
363 tg_pt_gp_id = tg_pt_gp->tg_pt_gp_id;
364 spin_unlock(&tg_pt_gp_mem->tg_pt_gp_mem_lock);
366 buf[off] =
367 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
368 buf[off++] |= 0x1; /* CODE SET == Binary */
369 buf[off] = 0x80; /* Set PIV=1 */
370 /* Set ASSOCIATION == target port: 01b */
371 buf[off] |= 0x10;
372 /* DESIGNATOR TYPE == Target port group identifier */
373 buf[off++] |= 0x5;
374 off++; /* Skip over Reserved */
375 buf[off++] = 4; /* DESIGNATOR LENGTH */
376 off += 2; /* Skip over Reserved Field */
377 buf[off++] = ((tg_pt_gp_id >> 8) & 0xff);
378 buf[off++] = (tg_pt_gp_id & 0xff);
379 len += 8; /* Header size + Designation descriptor */
381 * Logical Unit Group identifier, see spc4r17
382 * section 7.7.3.8
384 check_lu_gp:
385 if (((len + 4) + 8) > cmd->data_length) {
386 len += 8;
387 goto check_scsi_name;
389 lu_gp_mem = dev->dev_alua_lu_gp_mem;
390 if (!lu_gp_mem)
391 goto check_scsi_name;
393 spin_lock(&lu_gp_mem->lu_gp_mem_lock);
394 lu_gp = lu_gp_mem->lu_gp;
395 if (!lu_gp) {
396 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
397 goto check_scsi_name;
399 lu_gp_id = lu_gp->lu_gp_id;
400 spin_unlock(&lu_gp_mem->lu_gp_mem_lock);
402 buf[off++] |= 0x1; /* CODE SET == Binary */
403 /* DESIGNATOR TYPE == Logical Unit Group identifier */
404 buf[off++] |= 0x6;
405 off++; /* Skip over Reserved */
406 buf[off++] = 4; /* DESIGNATOR LENGTH */
407 off += 2; /* Skip over Reserved Field */
408 buf[off++] = ((lu_gp_id >> 8) & 0xff);
409 buf[off++] = (lu_gp_id & 0xff);
410 len += 8; /* Header size + Designation descriptor */
412 * SCSI name string designator, see spc4r17
413 * section 7.7.3.11
415 * Get the PROTOCOL IDENTIFIER as defined by spc4r17
416 * section 7.5.1 Table 362
418 check_scsi_name:
419 scsi_name_len = strlen(tpg->se_tpg_tfo->tpg_get_wwn(tpg));
420 /* UTF-8 ",t,0x<16-bit TPGT>" + NULL Terminator */
421 scsi_name_len += 10;
422 /* Check for 4-byte padding */
423 padding = ((-scsi_name_len) & 3);
424 if (padding != 0)
425 scsi_name_len += padding;
426 /* Header size + Designation descriptor */
427 scsi_name_len += 4;
429 if (((len + 4) + scsi_name_len) > cmd->data_length) {
430 len += scsi_name_len;
431 goto set_len;
433 buf[off] =
434 (tpg->se_tpg_tfo->get_fabric_proto_ident(tpg) << 4);
435 buf[off++] |= 0x3; /* CODE SET == UTF-8 */
436 buf[off] = 0x80; /* Set PIV=1 */
437 /* Set ASSOCIATION == target port: 01b */
438 buf[off] |= 0x10;
439 /* DESIGNATOR TYPE == SCSI name string */
440 buf[off++] |= 0x8;
441 off += 2; /* Skip over Reserved and length */
443 * SCSI name string identifer containing, $FABRIC_MOD
444 * dependent information. For LIO-Target and iSCSI
445 * Target Port, this means "<iSCSI name>,t,0x<TPGT> in
446 * UTF-8 encoding.
448 tpgt = tpg->se_tpg_tfo->tpg_get_tag(tpg);
449 scsi_name_len = sprintf(&buf[off], "%s,t,0x%04x",
450 tpg->se_tpg_tfo->tpg_get_wwn(tpg), tpgt);
451 scsi_name_len += 1 /* Include NULL terminator */;
453 * The null-terminated, null-padded (see 4.4.2) SCSI
454 * NAME STRING field contains a UTF-8 format string.
455 * The number of bytes in the SCSI NAME STRING field
456 * (i.e., the value in the DESIGNATOR LENGTH field)
457 * shall be no larger than 256 and shall be a multiple
458 * of four.
460 if (padding)
461 scsi_name_len += padding;
463 buf[off-1] = scsi_name_len;
464 off += scsi_name_len;
465 /* Header size + Designation descriptor */
466 len += (scsi_name_len + 4);
468 set_len:
469 buf[2] = ((len >> 8) & 0xff);
470 buf[3] = (len & 0xff); /* Page Length for VPD 0x83 */
471 return 0;
474 /* Extended INQUIRY Data VPD Page */
475 static int
476 target_emulate_evpd_86(struct se_cmd *cmd, unsigned char *buf)
478 if (cmd->data_length < 60)
479 return 0;
481 buf[3] = 0x3c;
482 /* Set HEADSUP, ORDSUP, SIMPSUP */
483 buf[5] = 0x07;
485 /* If WriteCache emulation is enabled, set V_SUP */
486 if (cmd->se_dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
487 buf[6] = 0x01;
488 return 0;
491 /* Block Limits VPD page */
492 static int
493 target_emulate_evpd_b0(struct se_cmd *cmd, unsigned char *buf)
495 struct se_device *dev = cmd->se_dev;
496 int have_tp = 0;
499 * Following sbc3r22 section 6.5.3 Block Limits VPD page, when
500 * emulate_tpu=1 or emulate_tpws=1 we will be expect a
501 * different page length for Thin Provisioning.
503 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
504 have_tp = 1;
506 if (cmd->data_length < (0x10 + 4)) {
507 pr_debug("Received data_length: %u"
508 " too small for EVPD 0xb0\n",
509 cmd->data_length);
510 return -EINVAL;
513 if (have_tp && cmd->data_length < (0x3c + 4)) {
514 pr_debug("Received data_length: %u"
515 " too small for TPE=1 EVPD 0xb0\n",
516 cmd->data_length);
517 have_tp = 0;
520 buf[0] = dev->transport->get_device_type(dev);
521 buf[3] = have_tp ? 0x3c : 0x10;
523 /* Set WSNZ to 1 */
524 buf[4] = 0x01;
527 * Set OPTIMAL TRANSFER LENGTH GRANULARITY
529 put_unaligned_be16(1, &buf[6]);
532 * Set MAXIMUM TRANSFER LENGTH
534 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_sectors, &buf[8]);
537 * Set OPTIMAL TRANSFER LENGTH
539 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.optimal_sectors, &buf[12]);
542 * Exit now if we don't support TP or the initiator sent a too
543 * short buffer.
545 if (!have_tp || cmd->data_length < (0x3c + 4))
546 return 0;
549 * Set MAXIMUM UNMAP LBA COUNT
551 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_lba_count, &buf[20]);
554 * Set MAXIMUM UNMAP BLOCK DESCRIPTOR COUNT
556 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.max_unmap_block_desc_count,
557 &buf[24]);
560 * Set OPTIMAL UNMAP GRANULARITY
562 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity, &buf[28]);
565 * UNMAP GRANULARITY ALIGNMENT
567 put_unaligned_be32(dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment,
568 &buf[32]);
569 if (dev->se_sub_dev->se_dev_attrib.unmap_granularity_alignment != 0)
570 buf[32] |= 0x80; /* Set the UGAVALID bit */
572 return 0;
575 /* Block Device Characteristics VPD page */
576 static int
577 target_emulate_evpd_b1(struct se_cmd *cmd, unsigned char *buf)
579 struct se_device *dev = cmd->se_dev;
581 buf[0] = dev->transport->get_device_type(dev);
582 buf[3] = 0x3c;
584 if (cmd->data_length >= 5 &&
585 dev->se_sub_dev->se_dev_attrib.is_nonrot)
586 buf[5] = 1;
588 return 0;
591 /* Thin Provisioning VPD */
592 static int
593 target_emulate_evpd_b2(struct se_cmd *cmd, unsigned char *buf)
595 struct se_device *dev = cmd->se_dev;
598 * From sbc3r22 section 6.5.4 Thin Provisioning VPD page:
600 * The PAGE LENGTH field is defined in SPC-4. If the DP bit is set to
601 * zero, then the page length shall be set to 0004h. If the DP bit
602 * is set to one, then the page length shall be set to the value
603 * defined in table 162.
605 buf[0] = dev->transport->get_device_type(dev);
608 * Set Hardcoded length mentioned above for DP=0
610 put_unaligned_be16(0x0004, &buf[2]);
613 * The THRESHOLD EXPONENT field indicates the threshold set size in
614 * LBAs as a power of 2 (i.e., the threshold set size is equal to
615 * 2(threshold exponent)).
617 * Note that this is currently set to 0x00 as mkp says it will be
618 * changing again. We can enable this once it has settled in T10
619 * and is actually used by Linux/SCSI ML code.
621 buf[4] = 0x00;
624 * A TPU bit set to one indicates that the device server supports
625 * the UNMAP command (see 5.25). A TPU bit set to zero indicates
626 * that the device server does not support the UNMAP command.
628 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu != 0)
629 buf[5] = 0x80;
632 * A TPWS bit set to one indicates that the device server supports
633 * the use of the WRITE SAME (16) command (see 5.42) to unmap LBAs.
634 * A TPWS bit set to zero indicates that the device server does not
635 * support the use of the WRITE SAME (16) command to unmap LBAs.
637 if (dev->se_sub_dev->se_dev_attrib.emulate_tpws != 0)
638 buf[5] |= 0x40;
640 return 0;
643 static int
644 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf);
646 static struct {
647 uint8_t page;
648 int (*emulate)(struct se_cmd *, unsigned char *);
649 } evpd_handlers[] = {
650 { .page = 0x00, .emulate = target_emulate_evpd_00 },
651 { .page = 0x80, .emulate = target_emulate_evpd_80 },
652 { .page = 0x83, .emulate = target_emulate_evpd_83 },
653 { .page = 0x86, .emulate = target_emulate_evpd_86 },
654 { .page = 0xb0, .emulate = target_emulate_evpd_b0 },
655 { .page = 0xb1, .emulate = target_emulate_evpd_b1 },
656 { .page = 0xb2, .emulate = target_emulate_evpd_b2 },
659 /* supported vital product data pages */
660 static int
661 target_emulate_evpd_00(struct se_cmd *cmd, unsigned char *buf)
663 int p;
665 if (cmd->data_length < 8)
666 return 0;
668 * Only report the INQUIRY EVPD=1 pages after a valid NAA
669 * Registered Extended LUN WWN has been set via ConfigFS
670 * during device creation/restart.
672 if (cmd->se_dev->se_sub_dev->su_dev_flags &
673 SDF_EMULATED_VPD_UNIT_SERIAL) {
674 buf[3] = ARRAY_SIZE(evpd_handlers);
675 for (p = 0; p < min_t(int, ARRAY_SIZE(evpd_handlers),
676 cmd->data_length - 4); ++p)
677 buf[p + 4] = evpd_handlers[p].page;
680 return 0;
683 int target_emulate_inquiry(struct se_task *task)
685 struct se_cmd *cmd = task->task_se_cmd;
686 struct se_device *dev = cmd->se_dev;
687 unsigned char *buf;
688 unsigned char *cdb = cmd->t_task_cdb;
689 int p, ret;
691 if (!(cdb[1] & 0x1)) {
692 ret = target_emulate_inquiry_std(cmd);
693 goto out;
697 * Make sure we at least have 4 bytes of INQUIRY response
698 * payload for 0x00 going back for EVPD=1. Note that 0x80
699 * and 0x83 will check for enough payload data length and
700 * jump to set_len: label when there is not enough inquiry EVPD
701 * payload length left for the next outgoing EVPD metadata
703 if (cmd->data_length < 4) {
704 pr_err("SCSI Inquiry payload length: %u"
705 " too small for EVPD=1\n", cmd->data_length);
706 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
707 return -EINVAL;
710 buf = transport_kmap_first_data_page(cmd);
712 buf[0] = dev->transport->get_device_type(dev);
714 for (p = 0; p < ARRAY_SIZE(evpd_handlers); ++p) {
715 if (cdb[2] == evpd_handlers[p].page) {
716 buf[1] = cdb[2];
717 ret = evpd_handlers[p].emulate(cmd, buf);
718 goto out_unmap;
722 pr_err("Unknown VPD Code: 0x%02x\n", cdb[2]);
723 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
724 ret = -EINVAL;
726 out_unmap:
727 transport_kunmap_first_data_page(cmd);
728 out:
729 if (!ret) {
730 task->task_scsi_status = GOOD;
731 transport_complete_task(task, 1);
733 return ret;
736 int target_emulate_readcapacity(struct se_task *task)
738 struct se_cmd *cmd = task->task_se_cmd;
739 struct se_device *dev = cmd->se_dev;
740 unsigned char *buf;
741 unsigned long long blocks_long = dev->transport->get_blocks(dev);
742 u32 blocks;
744 if (blocks_long >= 0x00000000ffffffff)
745 blocks = 0xffffffff;
746 else
747 blocks = (u32)blocks_long;
749 buf = transport_kmap_first_data_page(cmd);
751 buf[0] = (blocks >> 24) & 0xff;
752 buf[1] = (blocks >> 16) & 0xff;
753 buf[2] = (blocks >> 8) & 0xff;
754 buf[3] = blocks & 0xff;
755 buf[4] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
756 buf[5] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
757 buf[6] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
758 buf[7] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
760 * Set max 32-bit blocks to signal SERVICE ACTION READ_CAPACITY_16
762 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
763 put_unaligned_be32(0xFFFFFFFF, &buf[0]);
765 transport_kunmap_first_data_page(cmd);
767 task->task_scsi_status = GOOD;
768 transport_complete_task(task, 1);
769 return 0;
772 int target_emulate_readcapacity_16(struct se_task *task)
774 struct se_cmd *cmd = task->task_se_cmd;
775 struct se_device *dev = cmd->se_dev;
776 unsigned char *buf;
777 unsigned long long blocks = dev->transport->get_blocks(dev);
779 buf = transport_kmap_first_data_page(cmd);
781 buf[0] = (blocks >> 56) & 0xff;
782 buf[1] = (blocks >> 48) & 0xff;
783 buf[2] = (blocks >> 40) & 0xff;
784 buf[3] = (blocks >> 32) & 0xff;
785 buf[4] = (blocks >> 24) & 0xff;
786 buf[5] = (blocks >> 16) & 0xff;
787 buf[6] = (blocks >> 8) & 0xff;
788 buf[7] = blocks & 0xff;
789 buf[8] = (dev->se_sub_dev->se_dev_attrib.block_size >> 24) & 0xff;
790 buf[9] = (dev->se_sub_dev->se_dev_attrib.block_size >> 16) & 0xff;
791 buf[10] = (dev->se_sub_dev->se_dev_attrib.block_size >> 8) & 0xff;
792 buf[11] = dev->se_sub_dev->se_dev_attrib.block_size & 0xff;
794 * Set Thin Provisioning Enable bit following sbc3r22 in section
795 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
797 if (dev->se_sub_dev->se_dev_attrib.emulate_tpu || dev->se_sub_dev->se_dev_attrib.emulate_tpws)
798 buf[14] = 0x80;
800 transport_kunmap_first_data_page(cmd);
802 task->task_scsi_status = GOOD;
803 transport_complete_task(task, 1);
804 return 0;
807 static int
808 target_modesense_rwrecovery(unsigned char *p)
810 p[0] = 0x01;
811 p[1] = 0x0a;
813 return 12;
816 static int
817 target_modesense_control(struct se_device *dev, unsigned char *p)
819 p[0] = 0x0a;
820 p[1] = 0x0a;
821 p[2] = 2;
823 * From spc4r23, 7.4.7 Control mode page
825 * The QUEUE ALGORITHM MODIFIER field (see table 368) specifies
826 * restrictions on the algorithm used for reordering commands
827 * having the SIMPLE task attribute (see SAM-4).
829 * Table 368 -- QUEUE ALGORITHM MODIFIER field
830 * Code Description
831 * 0h Restricted reordering
832 * 1h Unrestricted reordering allowed
833 * 2h to 7h Reserved
834 * 8h to Fh Vendor specific
836 * A value of zero in the QUEUE ALGORITHM MODIFIER field specifies that
837 * the device server shall order the processing sequence of commands
838 * having the SIMPLE task attribute such that data integrity is maintained
839 * for that I_T nexus (i.e., if the transmission of new SCSI transport protocol
840 * requests is halted at any time, the final value of all data observable
841 * on the medium shall be the same as if all the commands had been processed
842 * with the ORDERED task attribute).
844 * A value of one in the QUEUE ALGORITHM MODIFIER field specifies that the
845 * device server may reorder the processing sequence of commands having the
846 * SIMPLE task attribute in any manner. Any data integrity exposures related to
847 * command sequence order shall be explicitly handled by the application client
848 * through the selection of appropriate ommands and task attributes.
850 p[3] = (dev->se_sub_dev->se_dev_attrib.emulate_rest_reord == 1) ? 0x00 : 0x10;
852 * From spc4r17, section 7.4.6 Control mode Page
854 * Unit Attention interlocks control (UN_INTLCK_CTRL) to code 00b
856 * 00b: The logical unit shall clear any unit attention condition
857 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
858 * status and shall not establish a unit attention condition when a com-
859 * mand is completed with BUSY, TASK SET FULL, or RESERVATION CONFLICT
860 * status.
862 * 10b: The logical unit shall not clear any unit attention condition
863 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
864 * status and shall not establish a unit attention condition when
865 * a command is completed with BUSY, TASK SET FULL, or RESERVATION
866 * CONFLICT status.
868 * 11b a The logical unit shall not clear any unit attention condition
869 * reported in the same I_T_L_Q nexus transaction as a CHECK CONDITION
870 * status and shall establish a unit attention condition for the
871 * initiator port associated with the I_T nexus on which the BUSY,
872 * TASK SET FULL, or RESERVATION CONFLICT status is being returned.
873 * Depending on the status, the additional sense code shall be set to
874 * PREVIOUS BUSY STATUS, PREVIOUS TASK SET FULL STATUS, or PREVIOUS
875 * RESERVATION CONFLICT STATUS. Until it is cleared by a REQUEST SENSE
876 * command, a unit attention condition shall be established only once
877 * for a BUSY, TASK SET FULL, or RESERVATION CONFLICT status regardless
878 * to the number of commands completed with one of those status codes.
880 p[4] = (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 2) ? 0x30 :
881 (dev->se_sub_dev->se_dev_attrib.emulate_ua_intlck_ctrl == 1) ? 0x20 : 0x00;
883 * From spc4r17, section 7.4.6 Control mode Page
885 * Task Aborted Status (TAS) bit set to zero.
887 * A task aborted status (TAS) bit set to zero specifies that aborted
888 * tasks shall be terminated by the device server without any response
889 * to the application client. A TAS bit set to one specifies that tasks
890 * aborted by the actions of an I_T nexus other than the I_T nexus on
891 * which the command was received shall be completed with TASK ABORTED
892 * status (see SAM-4).
894 p[5] = (dev->se_sub_dev->se_dev_attrib.emulate_tas) ? 0x40 : 0x00;
895 p[8] = 0xff;
896 p[9] = 0xff;
897 p[11] = 30;
899 return 12;
902 static int
903 target_modesense_caching(struct se_device *dev, unsigned char *p)
905 p[0] = 0x08;
906 p[1] = 0x12;
907 if (dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0)
908 p[2] = 0x04; /* Write Cache Enable */
909 p[12] = 0x20; /* Disabled Read Ahead */
911 return 20;
914 static void
915 target_modesense_write_protect(unsigned char *buf, int type)
918 * I believe that the WP bit (bit 7) in the mode header is the same for
919 * all device types..
921 switch (type) {
922 case TYPE_DISK:
923 case TYPE_TAPE:
924 default:
925 buf[0] |= 0x80; /* WP bit */
926 break;
930 static void
931 target_modesense_dpofua(unsigned char *buf, int type)
933 switch (type) {
934 case TYPE_DISK:
935 buf[0] |= 0x10; /* DPOFUA bit */
936 break;
937 default:
938 break;
942 int target_emulate_modesense(struct se_task *task)
944 struct se_cmd *cmd = task->task_se_cmd;
945 struct se_device *dev = cmd->se_dev;
946 char *cdb = cmd->t_task_cdb;
947 unsigned char *rbuf;
948 int type = dev->transport->get_device_type(dev);
949 int ten = (cmd->t_task_cdb[0] == MODE_SENSE_10);
950 int offset = ten ? 8 : 4;
951 int length = 0;
952 unsigned char buf[SE_MODE_PAGE_BUF];
954 memset(buf, 0, SE_MODE_PAGE_BUF);
956 switch (cdb[2] & 0x3f) {
957 case 0x01:
958 length = target_modesense_rwrecovery(&buf[offset]);
959 break;
960 case 0x08:
961 length = target_modesense_caching(dev, &buf[offset]);
962 break;
963 case 0x0a:
964 length = target_modesense_control(dev, &buf[offset]);
965 break;
966 case 0x3f:
967 length = target_modesense_rwrecovery(&buf[offset]);
968 length += target_modesense_caching(dev, &buf[offset+length]);
969 length += target_modesense_control(dev, &buf[offset+length]);
970 break;
971 default:
972 pr_err("MODE SENSE: unimplemented page/subpage: 0x%02x/0x%02x\n",
973 cdb[2] & 0x3f, cdb[3]);
974 cmd->scsi_sense_reason = TCM_UNKNOWN_MODE_PAGE;
975 return -EINVAL;
977 offset += length;
979 if (ten) {
980 offset -= 2;
981 buf[0] = (offset >> 8) & 0xff;
982 buf[1] = offset & 0xff;
984 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
985 (cmd->se_deve &&
986 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
987 target_modesense_write_protect(&buf[3], type);
989 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
990 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
991 target_modesense_dpofua(&buf[3], type);
993 if ((offset + 2) > cmd->data_length)
994 offset = cmd->data_length;
996 } else {
997 offset -= 1;
998 buf[0] = offset & 0xff;
1000 if ((cmd->se_lun->lun_access & TRANSPORT_LUNFLAGS_READ_ONLY) ||
1001 (cmd->se_deve &&
1002 (cmd->se_deve->lun_flags & TRANSPORT_LUNFLAGS_READ_ONLY)))
1003 target_modesense_write_protect(&buf[2], type);
1005 if ((dev->se_sub_dev->se_dev_attrib.emulate_write_cache > 0) &&
1006 (dev->se_sub_dev->se_dev_attrib.emulate_fua_write > 0))
1007 target_modesense_dpofua(&buf[2], type);
1009 if ((offset + 1) > cmd->data_length)
1010 offset = cmd->data_length;
1013 rbuf = transport_kmap_first_data_page(cmd);
1014 memcpy(rbuf, buf, offset);
1015 transport_kunmap_first_data_page(cmd);
1017 task->task_scsi_status = GOOD;
1018 transport_complete_task(task, 1);
1019 return 0;
1022 int target_emulate_request_sense(struct se_task *task)
1024 struct se_cmd *cmd = task->task_se_cmd;
1025 unsigned char *cdb = cmd->t_task_cdb;
1026 unsigned char *buf;
1027 u8 ua_asc = 0, ua_ascq = 0;
1028 int err = 0;
1030 if (cdb[1] & 0x01) {
1031 pr_err("REQUEST_SENSE description emulation not"
1032 " supported\n");
1033 cmd->scsi_sense_reason = TCM_INVALID_CDB_FIELD;
1034 return -ENOSYS;
1037 buf = transport_kmap_first_data_page(cmd);
1039 if (!core_scsi3_ua_clear_for_request_sense(cmd, &ua_asc, &ua_ascq)) {
1041 * CURRENT ERROR, UNIT ATTENTION
1043 buf[0] = 0x70;
1044 buf[SPC_SENSE_KEY_OFFSET] = UNIT_ATTENTION;
1046 * Make sure request data length is enough for additional
1047 * sense data.
1049 if (cmd->data_length <= 18) {
1050 buf[7] = 0x00;
1051 err = -EINVAL;
1052 goto end;
1055 * The Additional Sense Code (ASC) from the UNIT ATTENTION
1057 buf[SPC_ASC_KEY_OFFSET] = ua_asc;
1058 buf[SPC_ASCQ_KEY_OFFSET] = ua_ascq;
1059 buf[7] = 0x0A;
1060 } else {
1062 * CURRENT ERROR, NO SENSE
1064 buf[0] = 0x70;
1065 buf[SPC_SENSE_KEY_OFFSET] = NO_SENSE;
1067 * Make sure request data length is enough for additional
1068 * sense data.
1070 if (cmd->data_length <= 18) {
1071 buf[7] = 0x00;
1072 err = -EINVAL;
1073 goto end;
1076 * NO ADDITIONAL SENSE INFORMATION
1078 buf[SPC_ASC_KEY_OFFSET] = 0x00;
1079 buf[7] = 0x0A;
1082 end:
1083 transport_kunmap_first_data_page(cmd);
1084 task->task_scsi_status = GOOD;
1085 transport_complete_task(task, 1);
1086 return 0;
1090 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1091 * Note this is not used for TCM/pSCSI passthrough
1093 int target_emulate_unmap(struct se_task *task)
1095 struct se_cmd *cmd = task->task_se_cmd;
1096 struct se_device *dev = cmd->se_dev;
1097 unsigned char *buf, *ptr = NULL;
1098 unsigned char *cdb = &cmd->t_task_cdb[0];
1099 sector_t lba;
1100 unsigned int size = cmd->data_length, range;
1101 int ret = 0, offset;
1102 unsigned short dl, bd_dl;
1104 if (!dev->transport->do_discard) {
1105 pr_err("UNMAP emulation not supported for: %s\n",
1106 dev->transport->name);
1107 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1108 return -ENOSYS;
1111 /* First UNMAP block descriptor starts at 8 byte offset */
1112 offset = 8;
1113 size -= 8;
1114 dl = get_unaligned_be16(&cdb[0]);
1115 bd_dl = get_unaligned_be16(&cdb[2]);
1117 buf = transport_kmap_first_data_page(cmd);
1119 ptr = &buf[offset];
1120 pr_debug("UNMAP: Sub: %s Using dl: %hu bd_dl: %hu size: %hu"
1121 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1123 while (size) {
1124 lba = get_unaligned_be64(&ptr[0]);
1125 range = get_unaligned_be32(&ptr[8]);
1126 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1127 (unsigned long long)lba, range);
1129 ret = dev->transport->do_discard(dev, lba, range);
1130 if (ret < 0) {
1131 pr_err("blkdev_issue_discard() failed: %d\n",
1132 ret);
1133 goto err;
1136 ptr += 16;
1137 size -= 16;
1140 err:
1141 transport_kunmap_first_data_page(cmd);
1142 if (!ret) {
1143 task->task_scsi_status = GOOD;
1144 transport_complete_task(task, 1);
1146 return ret;
1150 * Used for TCM/IBLOCK and TCM/FILEIO for block/blk-lib.c level discard support.
1151 * Note this is not used for TCM/pSCSI passthrough
1153 int target_emulate_write_same(struct se_task *task)
1155 struct se_cmd *cmd = task->task_se_cmd;
1156 struct se_device *dev = cmd->se_dev;
1157 sector_t range;
1158 sector_t lba = cmd->t_task_lba;
1159 u32 num_blocks;
1160 int ret;
1162 if (!dev->transport->do_discard) {
1163 pr_err("WRITE_SAME emulation not supported"
1164 " for: %s\n", dev->transport->name);
1165 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1166 return -ENOSYS;
1169 if (cmd->t_task_cdb[0] == WRITE_SAME)
1170 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
1171 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
1172 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
1173 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
1174 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
1177 * Use the explicit range when non zero is supplied, otherwise calculate
1178 * the remaining range based on ->get_blocks() - starting LBA.
1180 if (num_blocks != 0)
1181 range = num_blocks;
1182 else
1183 range = (dev->transport->get_blocks(dev) - lba);
1185 pr_debug("WRITE_SAME UNMAP: LBA: %llu Range: %llu\n",
1186 (unsigned long long)lba, (unsigned long long)range);
1188 ret = dev->transport->do_discard(dev, lba, range);
1189 if (ret < 0) {
1190 pr_debug("blkdev_issue_discard() failed for WRITE_SAME\n");
1191 return ret;
1194 task->task_scsi_status = GOOD;
1195 transport_complete_task(task, 1);
1196 return 0;
1199 int target_emulate_synchronize_cache(struct se_task *task)
1201 struct se_device *dev = task->task_se_cmd->se_dev;
1202 struct se_cmd *cmd = task->task_se_cmd;
1204 if (!dev->transport->do_sync_cache) {
1205 pr_err("SYNCHRONIZE_CACHE emulation not supported"
1206 " for: %s\n", dev->transport->name);
1207 cmd->scsi_sense_reason = TCM_UNSUPPORTED_SCSI_OPCODE;
1208 return -ENOSYS;
1211 dev->transport->do_sync_cache(task);
1212 return 0;
1215 int target_emulate_noop(struct se_task *task)
1217 task->task_scsi_status = GOOD;
1218 transport_complete_task(task, 1);
1219 return 0;
1223 * Write a CDB into @cdb that is based on the one the intiator sent us,
1224 * but updated to only cover the sectors that the current task handles.
1226 void target_get_task_cdb(struct se_task *task, unsigned char *cdb)
1228 struct se_cmd *cmd = task->task_se_cmd;
1229 unsigned int cdb_len = scsi_command_size(cmd->t_task_cdb);
1231 memcpy(cdb, cmd->t_task_cdb, cdb_len);
1232 if (cmd->se_cmd_flags & SCF_SCSI_DATA_SG_IO_CDB) {
1233 unsigned long long lba = task->task_lba;
1234 u32 sectors = task->task_sectors;
1236 switch (cdb_len) {
1237 case 6:
1238 /* 21-bit LBA and 8-bit sectors */
1239 cdb[1] = (lba >> 16) & 0x1f;
1240 cdb[2] = (lba >> 8) & 0xff;
1241 cdb[3] = lba & 0xff;
1242 cdb[4] = sectors & 0xff;
1243 break;
1244 case 10:
1245 /* 32-bit LBA and 16-bit sectors */
1246 put_unaligned_be32(lba, &cdb[2]);
1247 put_unaligned_be16(sectors, &cdb[7]);
1248 break;
1249 case 12:
1250 /* 32-bit LBA and 32-bit sectors */
1251 put_unaligned_be32(lba, &cdb[2]);
1252 put_unaligned_be32(sectors, &cdb[6]);
1253 break;
1254 case 16:
1255 /* 64-bit LBA and 32-bit sectors */
1256 put_unaligned_be64(lba, &cdb[2]);
1257 put_unaligned_be32(sectors, &cdb[10]);
1258 break;
1259 case 32:
1260 /* 64-bit LBA and 32-bit sectors, extended CDB */
1261 put_unaligned_be64(lba, &cdb[12]);
1262 put_unaligned_be32(sectors, &cdb[28]);
1263 break;
1264 default:
1265 BUG();
1269 EXPORT_SYMBOL(target_get_task_cdb);