2 * SCSI Block Commands (SBC) parsing and emulation.
4 * (c) Copyright 2002-2013 Datera, Inc.
6 * Nicholas A. Bellinger <nab@kernel.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/ratelimit.h>
26 #include <linux/crc-t10dif.h>
27 #include <asm/unaligned.h>
28 #include <scsi/scsi_proto.h>
29 #include <scsi/scsi_tcq.h>
31 #include <target/target_core_base.h>
32 #include <target/target_core_backend.h>
33 #include <target/target_core_fabric.h>
35 #include "target_core_internal.h"
36 #include "target_core_ua.h"
37 #include "target_core_alua.h"
40 sbc_check_prot(struct se_device *, struct se_cmd *, unsigned char *, u32, bool);
41 static sense_reason_t sbc_execute_unmap(struct se_cmd *cmd);
44 sbc_emulate_readcapacity(struct se_cmd *cmd)
46 struct se_device *dev = cmd->se_dev;
47 unsigned char *cdb = cmd->t_task_cdb;
48 unsigned long long blocks_long = dev->transport->get_blocks(dev);
55 * If the PMI bit is set to zero and the LOGICAL BLOCK
56 * ADDRESS field is not set to zero, the device server shall
57 * terminate the command with CHECK CONDITION status with
58 * the sense key set to ILLEGAL REQUEST and the additional
59 * sense code set to INVALID FIELD IN CDB.
61 * In SBC-3, these fields are obsolete, but some SCSI
62 * compliance tests actually check this, so we might as well
65 if (!(cdb[8] & 1) && !!(cdb[2] | cdb[3] | cdb[4] | cdb[5]))
66 return TCM_INVALID_CDB_FIELD;
68 if (blocks_long >= 0x00000000ffffffff)
71 blocks = (u32)blocks_long;
73 buf[0] = (blocks >> 24) & 0xff;
74 buf[1] = (blocks >> 16) & 0xff;
75 buf[2] = (blocks >> 8) & 0xff;
76 buf[3] = blocks & 0xff;
77 buf[4] = (dev->dev_attrib.block_size >> 24) & 0xff;
78 buf[5] = (dev->dev_attrib.block_size >> 16) & 0xff;
79 buf[6] = (dev->dev_attrib.block_size >> 8) & 0xff;
80 buf[7] = dev->dev_attrib.block_size & 0xff;
82 rbuf = transport_kmap_data_sg(cmd);
84 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
85 transport_kunmap_data_sg(cmd);
88 target_complete_cmd_with_length(cmd, GOOD, 8);
93 sbc_emulate_readcapacity_16(struct se_cmd *cmd)
95 struct se_device *dev = cmd->se_dev;
96 struct se_session *sess = cmd->se_sess;
97 int pi_prot_type = dev->dev_attrib.pi_prot_type;
100 unsigned char buf[32];
101 unsigned long long blocks = dev->transport->get_blocks(dev);
103 memset(buf, 0, sizeof(buf));
104 buf[0] = (blocks >> 56) & 0xff;
105 buf[1] = (blocks >> 48) & 0xff;
106 buf[2] = (blocks >> 40) & 0xff;
107 buf[3] = (blocks >> 32) & 0xff;
108 buf[4] = (blocks >> 24) & 0xff;
109 buf[5] = (blocks >> 16) & 0xff;
110 buf[6] = (blocks >> 8) & 0xff;
111 buf[7] = blocks & 0xff;
112 buf[8] = (dev->dev_attrib.block_size >> 24) & 0xff;
113 buf[9] = (dev->dev_attrib.block_size >> 16) & 0xff;
114 buf[10] = (dev->dev_attrib.block_size >> 8) & 0xff;
115 buf[11] = dev->dev_attrib.block_size & 0xff;
117 * Set P_TYPE and PROT_EN bits for DIF support
119 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
121 * Only override a device's pi_prot_type if no T10-PI is
122 * available, and sess_prot_type has been explicitly enabled.
125 pi_prot_type = sess->sess_prot_type;
128 buf[12] = (pi_prot_type - 1) << 1 | 0x1;
131 if (dev->transport->get_lbppbe)
132 buf[13] = dev->transport->get_lbppbe(dev) & 0x0f;
134 if (dev->transport->get_alignment_offset_lbas) {
135 u16 lalba = dev->transport->get_alignment_offset_lbas(dev);
136 buf[14] = (lalba >> 8) & 0x3f;
137 buf[15] = lalba & 0xff;
141 * Set Thin Provisioning Enable bit following sbc3r22 in section
142 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
144 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
147 rbuf = transport_kmap_data_sg(cmd);
149 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
150 transport_kunmap_data_sg(cmd);
153 target_complete_cmd_with_length(cmd, GOOD, 32);
157 static sense_reason_t
158 sbc_emulate_startstop(struct se_cmd *cmd)
160 unsigned char *cdb = cmd->t_task_cdb;
163 * See sbc3r36 section 5.25
164 * Immediate bit should be set since there is nothing to complete
165 * POWER CONDITION MODIFIER 0h
167 if (!(cdb[1] & 1) || cdb[2] || cdb[3])
168 return TCM_INVALID_CDB_FIELD;
171 * See sbc3r36 section 5.25
172 * POWER CONDITION 0h START_VALID - process START and LOEJ
174 if (cdb[4] >> 4 & 0xf)
175 return TCM_INVALID_CDB_FIELD;
178 * See sbc3r36 section 5.25
179 * LOEJ 0h - nothing to load or unload
180 * START 1h - we are ready
182 if (!(cdb[4] & 1) || (cdb[4] & 2) || (cdb[4] & 4))
183 return TCM_INVALID_CDB_FIELD;
185 target_complete_cmd(cmd, SAM_STAT_GOOD);
189 sector_t sbc_get_write_same_sectors(struct se_cmd *cmd)
193 if (cmd->t_task_cdb[0] == WRITE_SAME)
194 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
195 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
196 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
197 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
198 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
201 * Use the explicit range when non zero is supplied, otherwise calculate
202 * the remaining range based on ->get_blocks() - starting LBA.
207 return cmd->se_dev->transport->get_blocks(cmd->se_dev) -
210 EXPORT_SYMBOL(sbc_get_write_same_sectors);
212 static sense_reason_t
213 sbc_execute_write_same_unmap(struct se_cmd *cmd)
215 struct sbc_ops *ops = cmd->protocol_data;
216 sector_t nolb = sbc_get_write_same_sectors(cmd);
220 ret = ops->execute_unmap(cmd, cmd->t_task_lba, nolb);
225 target_complete_cmd(cmd, GOOD);
229 static sense_reason_t
230 sbc_emulate_noop(struct se_cmd *cmd)
232 target_complete_cmd(cmd, GOOD);
236 static inline u32 sbc_get_size(struct se_cmd *cmd, u32 sectors)
238 return cmd->se_dev->dev_attrib.block_size * sectors;
241 static inline u32 transport_get_sectors_6(unsigned char *cdb)
244 * Use 8-bit sector value. SBC-3 says:
246 * A TRANSFER LENGTH field set to zero specifies that 256
247 * logical blocks shall be written. Any other value
248 * specifies the number of logical blocks that shall be
251 return cdb[4] ? : 256;
254 static inline u32 transport_get_sectors_10(unsigned char *cdb)
256 return (u32)(cdb[7] << 8) + cdb[8];
259 static inline u32 transport_get_sectors_12(unsigned char *cdb)
261 return (u32)(cdb[6] << 24) + (cdb[7] << 16) + (cdb[8] << 8) + cdb[9];
264 static inline u32 transport_get_sectors_16(unsigned char *cdb)
266 return (u32)(cdb[10] << 24) + (cdb[11] << 16) +
267 (cdb[12] << 8) + cdb[13];
271 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
273 static inline u32 transport_get_sectors_32(unsigned char *cdb)
275 return (u32)(cdb[28] << 24) + (cdb[29] << 16) +
276 (cdb[30] << 8) + cdb[31];
280 static inline u32 transport_lba_21(unsigned char *cdb)
282 return ((cdb[1] & 0x1f) << 16) | (cdb[2] << 8) | cdb[3];
285 static inline u32 transport_lba_32(unsigned char *cdb)
287 return (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
290 static inline unsigned long long transport_lba_64(unsigned char *cdb)
292 unsigned int __v1, __v2;
294 __v1 = (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
295 __v2 = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
297 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
301 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
303 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb)
305 unsigned int __v1, __v2;
307 __v1 = (cdb[12] << 24) | (cdb[13] << 16) | (cdb[14] << 8) | cdb[15];
308 __v2 = (cdb[16] << 24) | (cdb[17] << 16) | (cdb[18] << 8) | cdb[19];
310 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
313 static sense_reason_t
314 sbc_setup_write_same(struct se_cmd *cmd, unsigned char *flags, struct sbc_ops *ops)
316 struct se_device *dev = cmd->se_dev;
317 sector_t end_lba = dev->transport->get_blocks(dev) + 1;
318 unsigned int sectors = sbc_get_write_same_sectors(cmd);
321 if ((flags[0] & 0x04) || (flags[0] & 0x02)) {
322 pr_err("WRITE_SAME PBDATA and LBDATA"
323 " bits not supported for Block Discard"
325 return TCM_UNSUPPORTED_SCSI_OPCODE;
327 if (sectors > cmd->se_dev->dev_attrib.max_write_same_len) {
328 pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
329 sectors, cmd->se_dev->dev_attrib.max_write_same_len);
330 return TCM_INVALID_CDB_FIELD;
333 * Sanity check for LBA wrap and request past end of device.
335 if (((cmd->t_task_lba + sectors) < cmd->t_task_lba) ||
336 ((cmd->t_task_lba + sectors) > end_lba)) {
337 pr_err("WRITE_SAME exceeds last lba %llu (lba %llu, sectors %u)\n",
338 (unsigned long long)end_lba, cmd->t_task_lba, sectors);
339 return TCM_ADDRESS_OUT_OF_RANGE;
342 /* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
343 if (flags[0] & 0x10) {
344 pr_warn("WRITE SAME with ANCHOR not supported\n");
345 return TCM_INVALID_CDB_FIELD;
348 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
349 * translated into block discard requests within backend code.
351 if (flags[0] & 0x08) {
352 if (!ops->execute_unmap)
353 return TCM_UNSUPPORTED_SCSI_OPCODE;
355 if (!dev->dev_attrib.emulate_tpws) {
356 pr_err("Got WRITE_SAME w/ UNMAP=1, but backend device"
357 " has emulate_tpws disabled\n");
358 return TCM_UNSUPPORTED_SCSI_OPCODE;
360 cmd->execute_cmd = sbc_execute_write_same_unmap;
363 if (!ops->execute_write_same)
364 return TCM_UNSUPPORTED_SCSI_OPCODE;
366 ret = sbc_check_prot(dev, cmd, &cmd->t_task_cdb[0], sectors, true);
370 cmd->execute_cmd = ops->execute_write_same;
374 static sense_reason_t xdreadwrite_callback(struct se_cmd *cmd, bool success,
377 unsigned char *buf, *addr;
378 struct scatterlist *sg;
380 sense_reason_t ret = TCM_NO_SENSE;
383 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
385 * 1) read the specified logical block(s);
386 * 2) transfer logical blocks from the data-out buffer;
387 * 3) XOR the logical blocks transferred from the data-out buffer with
388 * the logical blocks read, storing the resulting XOR data in a buffer;
389 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
390 * blocks transferred from the data-out buffer; and
391 * 5) transfer the resulting XOR data to the data-in buffer.
393 buf = kmalloc(cmd->data_length, GFP_KERNEL);
395 pr_err("Unable to allocate xor_callback buf\n");
396 return TCM_OUT_OF_RESOURCES;
399 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
400 * into the locally allocated *buf
402 sg_copy_to_buffer(cmd->t_data_sg,
408 * Now perform the XOR against the BIDI read memory located at
409 * cmd->t_mem_bidi_list
413 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, count) {
414 addr = kmap_atomic(sg_page(sg));
416 ret = TCM_OUT_OF_RESOURCES;
420 for (i = 0; i < sg->length; i++)
421 *(addr + sg->offset + i) ^= *(buf + offset + i);
423 offset += sg->length;
432 static sense_reason_t
433 sbc_execute_rw(struct se_cmd *cmd)
435 struct sbc_ops *ops = cmd->protocol_data;
437 return ops->execute_rw(cmd, cmd->t_data_sg, cmd->t_data_nents,
438 cmd->data_direction);
441 static sense_reason_t compare_and_write_post(struct se_cmd *cmd, bool success,
444 struct se_device *dev = cmd->se_dev;
445 sense_reason_t ret = TCM_NO_SENSE;
448 * Only set SCF_COMPARE_AND_WRITE_POST to force a response fall-through
449 * within target_complete_ok_work() if the command was successfully
450 * sent to the backend driver.
452 spin_lock_irq(&cmd->t_state_lock);
453 if (cmd->transport_state & CMD_T_SENT) {
454 cmd->se_cmd_flags |= SCF_COMPARE_AND_WRITE_POST;
457 if (cmd->scsi_status == SAM_STAT_CHECK_CONDITION)
458 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
460 spin_unlock_irq(&cmd->t_state_lock);
463 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
464 * before the original READ I/O submission.
471 static sense_reason_t compare_and_write_callback(struct se_cmd *cmd, bool success,
474 struct se_device *dev = cmd->se_dev;
475 struct scatterlist *write_sg = NULL, *sg;
476 unsigned char *buf = NULL, *addr;
477 struct sg_mapping_iter m;
478 unsigned int offset = 0, len;
479 unsigned int nlbas = cmd->t_task_nolb;
480 unsigned int block_size = dev->dev_attrib.block_size;
481 unsigned int compare_len = (nlbas * block_size);
482 sense_reason_t ret = TCM_NO_SENSE;
486 * Handle early failure in transport_generic_request_failure(),
487 * which will not have taken ->caw_sem yet..
489 if (!success && (!cmd->t_data_sg || !cmd->t_bidi_data_sg))
492 * Handle special case for zero-length COMPARE_AND_WRITE
494 if (!cmd->data_length)
497 * Immediately exit + release dev->caw_sem if command has already
498 * been failed with a non-zero SCSI status.
500 if (cmd->scsi_status) {
501 pr_err("compare_and_write_callback: non zero scsi_status:"
502 " 0x%02x\n", cmd->scsi_status);
506 buf = kzalloc(cmd->data_length, GFP_KERNEL);
508 pr_err("Unable to allocate compare_and_write buf\n");
509 ret = TCM_OUT_OF_RESOURCES;
513 write_sg = kmalloc(sizeof(struct scatterlist) * cmd->t_data_nents,
516 pr_err("Unable to allocate compare_and_write sg\n");
517 ret = TCM_OUT_OF_RESOURCES;
520 sg_init_table(write_sg, cmd->t_data_nents);
522 * Setup verify and write data payloads from total NumberLBAs.
524 rc = sg_copy_to_buffer(cmd->t_data_sg, cmd->t_data_nents, buf,
527 pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
528 ret = TCM_OUT_OF_RESOURCES;
532 * Compare against SCSI READ payload against verify payload
534 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, i) {
535 addr = (unsigned char *)kmap_atomic(sg_page(sg));
537 ret = TCM_OUT_OF_RESOURCES;
541 len = min(sg->length, compare_len);
543 if (memcmp(addr, buf + offset, len)) {
544 pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
558 len = cmd->t_task_nolb * block_size;
559 sg_miter_start(&m, cmd->t_data_sg, cmd->t_data_nents, SG_MITER_TO_SG);
561 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
566 if (block_size < PAGE_SIZE) {
567 sg_set_page(&write_sg[i], m.page, block_size,
568 m.piter.sg->offset + block_size);
571 sg_set_page(&write_sg[i], m.page, block_size,
579 * Save the original SGL + nents values before updating to new
580 * assignments, to be released in transport_free_pages() ->
581 * transport_reset_sgl_orig()
583 cmd->t_data_sg_orig = cmd->t_data_sg;
584 cmd->t_data_sg = write_sg;
585 cmd->t_data_nents_orig = cmd->t_data_nents;
586 cmd->t_data_nents = 1;
588 cmd->sam_task_attr = TCM_HEAD_TAG;
589 cmd->transport_complete_callback = compare_and_write_post;
591 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
592 * for submitting the adjusted SGL to write instance user-data.
594 cmd->execute_cmd = sbc_execute_rw;
596 spin_lock_irq(&cmd->t_state_lock);
597 cmd->t_state = TRANSPORT_PROCESSING;
598 cmd->transport_state |= CMD_T_ACTIVE|CMD_T_BUSY|CMD_T_SENT;
599 spin_unlock_irq(&cmd->t_state_lock);
601 __target_execute_cmd(cmd, false);
607 pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
608 dev->transport->name);
609 ret = TCM_MISCOMPARE_VERIFY;
612 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
613 * sbc_compare_and_write() before the original READ I/O submission.
621 static sense_reason_t
622 sbc_compare_and_write(struct se_cmd *cmd)
624 struct sbc_ops *ops = cmd->protocol_data;
625 struct se_device *dev = cmd->se_dev;
629 * Submit the READ first for COMPARE_AND_WRITE to perform the
630 * comparision using SGLs at cmd->t_bidi_data_sg..
632 rc = down_interruptible(&dev->caw_sem);
634 cmd->transport_complete_callback = NULL;
635 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
638 * Reset cmd->data_length to individual block_size in order to not
639 * confuse backend drivers that depend on this value matching the
640 * size of the I/O being submitted.
642 cmd->data_length = cmd->t_task_nolb * dev->dev_attrib.block_size;
644 ret = ops->execute_rw(cmd, cmd->t_bidi_data_sg, cmd->t_bidi_data_nents,
647 cmd->transport_complete_callback = NULL;
652 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
653 * upon MISCOMPARE, or in compare_and_write_done() upon completion
654 * of WRITE instance user-data.
660 sbc_set_prot_op_checks(u8 protect, bool fabric_prot, enum target_prot_type prot_type,
661 bool is_write, struct se_cmd *cmd)
664 cmd->prot_op = fabric_prot ? TARGET_PROT_DOUT_STRIP :
665 protect ? TARGET_PROT_DOUT_PASS :
666 TARGET_PROT_DOUT_INSERT;
670 cmd->prot_checks = 0;
674 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
675 if (prot_type == TARGET_DIF_TYPE1_PROT)
676 cmd->prot_checks |= TARGET_DIF_CHECK_REFTAG;
679 if (prot_type == TARGET_DIF_TYPE1_PROT)
680 cmd->prot_checks = TARGET_DIF_CHECK_REFTAG;
683 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
686 pr_err("Unsupported protect field %d\n", protect);
690 cmd->prot_op = fabric_prot ? TARGET_PROT_DIN_INSERT :
691 protect ? TARGET_PROT_DIN_PASS :
692 TARGET_PROT_DIN_STRIP;
697 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
698 if (prot_type == TARGET_DIF_TYPE1_PROT)
699 cmd->prot_checks |= TARGET_DIF_CHECK_REFTAG;
702 if (prot_type == TARGET_DIF_TYPE1_PROT)
703 cmd->prot_checks = TARGET_DIF_CHECK_REFTAG;
706 cmd->prot_checks = 0;
709 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
712 pr_err("Unsupported protect field %d\n", protect);
720 static sense_reason_t
721 sbc_check_prot(struct se_device *dev, struct se_cmd *cmd, unsigned char *cdb,
722 u32 sectors, bool is_write)
724 u8 protect = cdb[1] >> 5;
725 int sp_ops = cmd->se_sess->sup_prot_ops;
726 int pi_prot_type = dev->dev_attrib.pi_prot_type;
727 bool fabric_prot = false;
729 if (!cmd->t_prot_sg || !cmd->t_prot_nents) {
730 if (unlikely(protect &&
731 !dev->dev_attrib.pi_prot_type && !cmd->se_sess->sess_prot_type)) {
732 pr_err("CDB contains protect bit, but device + fabric does"
733 " not advertise PROTECT=1 feature bit\n");
734 return TCM_INVALID_CDB_FIELD;
740 switch (dev->dev_attrib.pi_prot_type) {
741 case TARGET_DIF_TYPE3_PROT:
742 cmd->reftag_seed = 0xffffffff;
744 case TARGET_DIF_TYPE2_PROT:
746 return TCM_INVALID_CDB_FIELD;
748 cmd->reftag_seed = cmd->t_task_lba;
750 case TARGET_DIF_TYPE1_PROT:
751 cmd->reftag_seed = cmd->t_task_lba;
753 case TARGET_DIF_TYPE0_PROT:
755 * See if the fabric supports T10-PI, and the session has been
756 * configured to allow export PROTECT=1 feature bit with backend
757 * devices that don't support T10-PI.
759 fabric_prot = is_write ?
760 !!(sp_ops & (TARGET_PROT_DOUT_PASS | TARGET_PROT_DOUT_STRIP)) :
761 !!(sp_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DIN_INSERT));
763 if (fabric_prot && cmd->se_sess->sess_prot_type) {
764 pi_prot_type = cmd->se_sess->sess_prot_type;
771 pr_err("Unable to determine pi_prot_type for CDB: 0x%02x "
772 "PROTECT: 0x%02x\n", cdb[0], protect);
773 return TCM_INVALID_CDB_FIELD;
776 if (sbc_set_prot_op_checks(protect, fabric_prot, pi_prot_type, is_write, cmd))
777 return TCM_INVALID_CDB_FIELD;
779 cmd->prot_type = pi_prot_type;
780 cmd->prot_length = dev->prot_length * sectors;
783 * In case protection information exists over the wire
784 * we modify command data length to describe pure data.
785 * The actual transfer length is data length + protection
789 cmd->data_length = sectors * dev->dev_attrib.block_size;
791 pr_debug("%s: prot_type=%d, data_length=%d, prot_length=%d "
792 "prot_op=%d prot_checks=%d\n",
793 __func__, cmd->prot_type, cmd->data_length, cmd->prot_length,
794 cmd->prot_op, cmd->prot_checks);
800 sbc_check_dpofua(struct se_device *dev, struct se_cmd *cmd, unsigned char *cdb)
803 /* see explanation in spc_emulate_modesense */
804 if (!target_check_fua(dev)) {
805 pr_err("Got CDB: 0x%02x with DPO bit set, but device"
806 " does not advertise support for DPO\n", cdb[0]);
811 if (!target_check_fua(dev)) {
812 pr_err("Got CDB: 0x%02x with FUA bit set, but device"
813 " does not advertise support for FUA write\n",
817 cmd->se_cmd_flags |= SCF_FUA;
823 sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops)
825 struct se_device *dev = cmd->se_dev;
826 unsigned char *cdb = cmd->t_task_cdb;
831 cmd->protocol_data = ops;
835 sectors = transport_get_sectors_6(cdb);
836 cmd->t_task_lba = transport_lba_21(cdb);
837 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
838 cmd->execute_cmd = sbc_execute_rw;
841 sectors = transport_get_sectors_10(cdb);
842 cmd->t_task_lba = transport_lba_32(cdb);
844 if (sbc_check_dpofua(dev, cmd, cdb))
845 return TCM_INVALID_CDB_FIELD;
847 ret = sbc_check_prot(dev, cmd, cdb, sectors, false);
851 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
852 cmd->execute_cmd = sbc_execute_rw;
855 sectors = transport_get_sectors_12(cdb);
856 cmd->t_task_lba = transport_lba_32(cdb);
858 if (sbc_check_dpofua(dev, cmd, cdb))
859 return TCM_INVALID_CDB_FIELD;
861 ret = sbc_check_prot(dev, cmd, cdb, sectors, false);
865 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
866 cmd->execute_cmd = sbc_execute_rw;
869 sectors = transport_get_sectors_16(cdb);
870 cmd->t_task_lba = transport_lba_64(cdb);
872 if (sbc_check_dpofua(dev, cmd, cdb))
873 return TCM_INVALID_CDB_FIELD;
875 ret = sbc_check_prot(dev, cmd, cdb, sectors, false);
879 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
880 cmd->execute_cmd = sbc_execute_rw;
883 sectors = transport_get_sectors_6(cdb);
884 cmd->t_task_lba = transport_lba_21(cdb);
885 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
886 cmd->execute_cmd = sbc_execute_rw;
890 sectors = transport_get_sectors_10(cdb);
891 cmd->t_task_lba = transport_lba_32(cdb);
893 if (sbc_check_dpofua(dev, cmd, cdb))
894 return TCM_INVALID_CDB_FIELD;
896 ret = sbc_check_prot(dev, cmd, cdb, sectors, true);
900 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
901 cmd->execute_cmd = sbc_execute_rw;
904 sectors = transport_get_sectors_12(cdb);
905 cmd->t_task_lba = transport_lba_32(cdb);
907 if (sbc_check_dpofua(dev, cmd, cdb))
908 return TCM_INVALID_CDB_FIELD;
910 ret = sbc_check_prot(dev, cmd, cdb, sectors, true);
914 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
915 cmd->execute_cmd = sbc_execute_rw;
918 sectors = transport_get_sectors_16(cdb);
919 cmd->t_task_lba = transport_lba_64(cdb);
921 if (sbc_check_dpofua(dev, cmd, cdb))
922 return TCM_INVALID_CDB_FIELD;
924 ret = sbc_check_prot(dev, cmd, cdb, sectors, true);
928 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
929 cmd->execute_cmd = sbc_execute_rw;
932 if (cmd->data_direction != DMA_TO_DEVICE ||
933 !(cmd->se_cmd_flags & SCF_BIDI))
934 return TCM_INVALID_CDB_FIELD;
935 sectors = transport_get_sectors_10(cdb);
937 if (sbc_check_dpofua(dev, cmd, cdb))
938 return TCM_INVALID_CDB_FIELD;
940 cmd->t_task_lba = transport_lba_32(cdb);
941 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
944 * Setup BIDI XOR callback to be run after I/O completion.
946 cmd->execute_cmd = sbc_execute_rw;
947 cmd->transport_complete_callback = &xdreadwrite_callback;
949 case VARIABLE_LENGTH_CMD:
951 u16 service_action = get_unaligned_be16(&cdb[8]);
952 switch (service_action) {
954 sectors = transport_get_sectors_32(cdb);
956 if (sbc_check_dpofua(dev, cmd, cdb))
957 return TCM_INVALID_CDB_FIELD;
959 * Use WRITE_32 and READ_32 opcodes for the emulated
960 * XDWRITE_READ_32 logic.
962 cmd->t_task_lba = transport_lba_64_ext(cdb);
963 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
966 * Setup BIDI XOR callback to be run during after I/O
969 cmd->execute_cmd = sbc_execute_rw;
970 cmd->transport_complete_callback = &xdreadwrite_callback;
973 sectors = transport_get_sectors_32(cdb);
975 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
977 return TCM_INVALID_CDB_FIELD;
980 size = sbc_get_size(cmd, 1);
981 cmd->t_task_lba = get_unaligned_be64(&cdb[12]);
983 ret = sbc_setup_write_same(cmd, &cdb[10], ops);
988 pr_err("VARIABLE_LENGTH_CMD service action"
989 " 0x%04x not supported\n", service_action);
990 return TCM_UNSUPPORTED_SCSI_OPCODE;
994 case COMPARE_AND_WRITE:
997 * Currently enforce COMPARE_AND_WRITE for a single sector
1000 pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
1001 " than 1\n", sectors);
1002 return TCM_INVALID_CDB_FIELD;
1004 if (sbc_check_dpofua(dev, cmd, cdb))
1005 return TCM_INVALID_CDB_FIELD;
1008 * Double size because we have two buffers, note that
1009 * zero is not an error..
1011 size = 2 * sbc_get_size(cmd, sectors);
1012 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
1013 cmd->t_task_nolb = sectors;
1014 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB | SCF_COMPARE_AND_WRITE;
1015 cmd->execute_cmd = sbc_compare_and_write;
1016 cmd->transport_complete_callback = compare_and_write_callback;
1019 size = READ_CAP_LEN;
1020 cmd->execute_cmd = sbc_emulate_readcapacity;
1022 case SERVICE_ACTION_IN_16:
1023 switch (cmd->t_task_cdb[1] & 0x1f) {
1024 case SAI_READ_CAPACITY_16:
1025 cmd->execute_cmd = sbc_emulate_readcapacity_16;
1027 case SAI_REPORT_REFERRALS:
1028 cmd->execute_cmd = target_emulate_report_referrals;
1031 pr_err("Unsupported SA: 0x%02x\n",
1032 cmd->t_task_cdb[1] & 0x1f);
1033 return TCM_INVALID_CDB_FIELD;
1035 size = (cdb[10] << 24) | (cdb[11] << 16) |
1036 (cdb[12] << 8) | cdb[13];
1038 case SYNCHRONIZE_CACHE:
1039 case SYNCHRONIZE_CACHE_16:
1040 if (cdb[0] == SYNCHRONIZE_CACHE) {
1041 sectors = transport_get_sectors_10(cdb);
1042 cmd->t_task_lba = transport_lba_32(cdb);
1044 sectors = transport_get_sectors_16(cdb);
1045 cmd->t_task_lba = transport_lba_64(cdb);
1047 if (ops->execute_sync_cache) {
1048 cmd->execute_cmd = ops->execute_sync_cache;
1052 cmd->execute_cmd = sbc_emulate_noop;
1055 if (!ops->execute_unmap)
1056 return TCM_UNSUPPORTED_SCSI_OPCODE;
1058 if (!dev->dev_attrib.emulate_tpu) {
1059 pr_err("Got UNMAP, but backend device has"
1060 " emulate_tpu disabled\n");
1061 return TCM_UNSUPPORTED_SCSI_OPCODE;
1063 size = get_unaligned_be16(&cdb[7]);
1064 cmd->execute_cmd = sbc_execute_unmap;
1067 sectors = transport_get_sectors_16(cdb);
1069 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
1070 return TCM_INVALID_CDB_FIELD;
1073 size = sbc_get_size(cmd, 1);
1074 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
1076 ret = sbc_setup_write_same(cmd, &cdb[1], ops);
1081 sectors = transport_get_sectors_10(cdb);
1083 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
1084 return TCM_INVALID_CDB_FIELD;
1087 size = sbc_get_size(cmd, 1);
1088 cmd->t_task_lba = get_unaligned_be32(&cdb[2]);
1091 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
1092 * of byte 1 bit 3 UNMAP instead of original reserved field
1094 ret = sbc_setup_write_same(cmd, &cdb[1], ops);
1100 sectors = transport_get_sectors_10(cdb);
1101 cmd->t_task_lba = transport_lba_32(cdb);
1102 cmd->execute_cmd = sbc_emulate_noop;
1108 * There are still clients out there which use these old SCSI-2
1109 * commands. This mainly happens when running VMs with legacy
1110 * guest systems, connected via SCSI command pass-through to
1111 * iSCSI targets. Make them happy and return status GOOD.
1114 cmd->execute_cmd = sbc_emulate_noop;
1118 cmd->execute_cmd = sbc_emulate_startstop;
1121 ret = spc_parse_cdb(cmd, &size);
1126 /* reject any command that we don't have a handler for */
1127 if (!cmd->execute_cmd)
1128 return TCM_UNSUPPORTED_SCSI_OPCODE;
1130 if (cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) {
1131 unsigned long long end_lba;
1133 end_lba = dev->transport->get_blocks(dev) + 1;
1134 if (((cmd->t_task_lba + sectors) < cmd->t_task_lba) ||
1135 ((cmd->t_task_lba + sectors) > end_lba)) {
1136 pr_err("cmd exceeds last lba %llu "
1137 "(lba %llu, sectors %u)\n",
1138 end_lba, cmd->t_task_lba, sectors);
1139 return TCM_ADDRESS_OUT_OF_RANGE;
1142 if (!(cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE))
1143 size = sbc_get_size(cmd, sectors);
1146 return target_cmd_size_check(cmd, size);
1148 EXPORT_SYMBOL(sbc_parse_cdb);
1150 u32 sbc_get_device_type(struct se_device *dev)
1154 EXPORT_SYMBOL(sbc_get_device_type);
1156 static sense_reason_t
1157 sbc_execute_unmap(struct se_cmd *cmd)
1159 struct sbc_ops *ops = cmd->protocol_data;
1160 struct se_device *dev = cmd->se_dev;
1161 unsigned char *buf, *ptr = NULL;
1165 sense_reason_t ret = 0;
1168 /* We never set ANC_SUP */
1169 if (cmd->t_task_cdb[1])
1170 return TCM_INVALID_CDB_FIELD;
1172 if (cmd->data_length == 0) {
1173 target_complete_cmd(cmd, SAM_STAT_GOOD);
1177 if (cmd->data_length < 8) {
1178 pr_warn("UNMAP parameter list length %u too small\n",
1180 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1183 buf = transport_kmap_data_sg(cmd);
1185 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1187 dl = get_unaligned_be16(&buf[0]);
1188 bd_dl = get_unaligned_be16(&buf[2]);
1190 size = cmd->data_length - 8;
1192 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
1193 cmd->data_length, bd_dl);
1197 if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
1198 ret = TCM_INVALID_PARAMETER_LIST;
1202 /* First UNMAP block descriptor starts at 8 byte offset */
1204 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1205 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1207 while (size >= 16) {
1208 lba = get_unaligned_be64(&ptr[0]);
1209 range = get_unaligned_be32(&ptr[8]);
1210 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1211 (unsigned long long)lba, range);
1213 if (range > dev->dev_attrib.max_unmap_lba_count) {
1214 ret = TCM_INVALID_PARAMETER_LIST;
1218 if (lba + range > dev->transport->get_blocks(dev) + 1) {
1219 ret = TCM_ADDRESS_OUT_OF_RANGE;
1223 ret = ops->execute_unmap(cmd, lba, range);
1232 transport_kunmap_data_sg(cmd);
1234 target_complete_cmd(cmd, GOOD);
1239 sbc_dif_generate(struct se_cmd *cmd)
1241 struct se_device *dev = cmd->se_dev;
1242 struct t10_pi_tuple *sdt;
1243 struct scatterlist *dsg = cmd->t_data_sg, *psg;
1244 sector_t sector = cmd->t_task_lba;
1245 void *daddr, *paddr;
1246 int i, j, offset = 0;
1247 unsigned int block_size = dev->dev_attrib.block_size;
1249 for_each_sg(cmd->t_prot_sg, psg, cmd->t_prot_nents, i) {
1250 paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1251 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1253 for (j = 0; j < psg->length;
1254 j += sizeof(*sdt)) {
1258 if (offset >= dsg->length) {
1259 offset -= dsg->length;
1260 kunmap_atomic(daddr - dsg->offset);
1263 kunmap_atomic(paddr - psg->offset);
1266 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1270 avail = min(block_size, dsg->length - offset);
1271 crc = crc_t10dif(daddr + offset, avail);
1272 if (avail < block_size) {
1273 kunmap_atomic(daddr - dsg->offset);
1276 kunmap_atomic(paddr - psg->offset);
1279 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1280 offset = block_size - avail;
1281 crc = crc_t10dif_update(crc, daddr, offset);
1283 offset += block_size;
1286 sdt->guard_tag = cpu_to_be16(crc);
1287 if (cmd->prot_type == TARGET_DIF_TYPE1_PROT)
1288 sdt->ref_tag = cpu_to_be32(sector & 0xffffffff);
1291 pr_debug("DIF %s INSERT sector: %llu guard_tag: 0x%04x"
1292 " app_tag: 0x%04x ref_tag: %u\n",
1293 (cmd->data_direction == DMA_TO_DEVICE) ?
1294 "WRITE" : "READ", (unsigned long long)sector,
1295 sdt->guard_tag, sdt->app_tag,
1296 be32_to_cpu(sdt->ref_tag));
1301 kunmap_atomic(daddr - dsg->offset);
1302 kunmap_atomic(paddr - psg->offset);
1306 static sense_reason_t
1307 sbc_dif_v1_verify(struct se_cmd *cmd, struct t10_pi_tuple *sdt,
1308 __u16 crc, sector_t sector, unsigned int ei_lba)
1312 if (!(cmd->prot_checks & TARGET_DIF_CHECK_GUARD))
1315 csum = cpu_to_be16(crc);
1317 if (sdt->guard_tag != csum) {
1318 pr_err("DIFv1 checksum failed on sector %llu guard tag 0x%04x"
1319 " csum 0x%04x\n", (unsigned long long)sector,
1320 be16_to_cpu(sdt->guard_tag), be16_to_cpu(csum));
1321 return TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED;
1325 if (!(cmd->prot_checks & TARGET_DIF_CHECK_REFTAG))
1328 if (cmd->prot_type == TARGET_DIF_TYPE1_PROT &&
1329 be32_to_cpu(sdt->ref_tag) != (sector & 0xffffffff)) {
1330 pr_err("DIFv1 Type 1 reference failed on sector: %llu tag: 0x%08x"
1331 " sector MSB: 0x%08x\n", (unsigned long long)sector,
1332 be32_to_cpu(sdt->ref_tag), (u32)(sector & 0xffffffff));
1333 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED;
1336 if (cmd->prot_type == TARGET_DIF_TYPE2_PROT &&
1337 be32_to_cpu(sdt->ref_tag) != ei_lba) {
1338 pr_err("DIFv1 Type 2 reference failed on sector: %llu tag: 0x%08x"
1339 " ei_lba: 0x%08x\n", (unsigned long long)sector,
1340 be32_to_cpu(sdt->ref_tag), ei_lba);
1341 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED;
1347 void sbc_dif_copy_prot(struct se_cmd *cmd, unsigned int sectors, bool read,
1348 struct scatterlist *sg, int sg_off)
1350 struct se_device *dev = cmd->se_dev;
1351 struct scatterlist *psg;
1353 unsigned int i, len, left;
1354 unsigned int offset = sg_off;
1359 left = sectors * dev->prot_length;
1361 for_each_sg(cmd->t_prot_sg, psg, cmd->t_prot_nents, i) {
1362 unsigned int psg_len, copied = 0;
1364 paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1365 psg_len = min(left, psg->length);
1367 len = min(psg_len, sg->length - offset);
1368 addr = kmap_atomic(sg_page(sg)) + sg->offset + offset;
1371 memcpy(paddr + copied, addr, len);
1373 memcpy(addr, paddr + copied, len);
1380 kunmap_atomic(addr - sg->offset - offset);
1382 if (offset >= sg->length) {
1387 kunmap_atomic(paddr - psg->offset);
1390 EXPORT_SYMBOL(sbc_dif_copy_prot);
1393 sbc_dif_verify(struct se_cmd *cmd, sector_t start, unsigned int sectors,
1394 unsigned int ei_lba, struct scatterlist *psg, int psg_off)
1396 struct se_device *dev = cmd->se_dev;
1397 struct t10_pi_tuple *sdt;
1398 struct scatterlist *dsg = cmd->t_data_sg;
1399 sector_t sector = start;
1400 void *daddr, *paddr;
1404 unsigned int block_size = dev->dev_attrib.block_size;
1406 for (; psg && sector < start + sectors; psg = sg_next(psg)) {
1407 paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1408 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1410 for (i = psg_off; i < psg->length &&
1411 sector < start + sectors;
1412 i += sizeof(*sdt)) {
1416 if (dsg_off >= dsg->length) {
1417 dsg_off -= dsg->length;
1418 kunmap_atomic(daddr - dsg->offset);
1421 kunmap_atomic(paddr - psg->offset);
1424 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1429 pr_debug("DIF READ sector: %llu guard_tag: 0x%04x"
1430 " app_tag: 0x%04x ref_tag: %u\n",
1431 (unsigned long long)sector, sdt->guard_tag,
1432 sdt->app_tag, be32_to_cpu(sdt->ref_tag));
1434 if (sdt->app_tag == cpu_to_be16(0xffff)) {
1435 dsg_off += block_size;
1439 avail = min(block_size, dsg->length - dsg_off);
1440 crc = crc_t10dif(daddr + dsg_off, avail);
1441 if (avail < block_size) {
1442 kunmap_atomic(daddr - dsg->offset);
1445 kunmap_atomic(paddr - psg->offset);
1448 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1449 dsg_off = block_size - avail;
1450 crc = crc_t10dif_update(crc, daddr, dsg_off);
1452 dsg_off += block_size;
1455 rc = sbc_dif_v1_verify(cmd, sdt, crc, sector, ei_lba);
1457 kunmap_atomic(daddr - dsg->offset);
1458 kunmap_atomic(paddr - psg->offset);
1459 cmd->bad_sector = sector;
1468 kunmap_atomic(daddr - dsg->offset);
1469 kunmap_atomic(paddr - psg->offset);
1474 EXPORT_SYMBOL(sbc_dif_verify);