1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * SCSI Block Commands (SBC) parsing and emulation.
5 * (c) Copyright 2002-2013 Datera, Inc.
7 * Nicholas A. Bellinger <nab@kernel.org>
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/ratelimit.h>
13 #include <linux/crc-t10dif.h>
14 #include <linux/t10-pi.h>
15 #include <asm/unaligned.h>
16 #include <scsi/scsi_proto.h>
17 #include <scsi/scsi_tcq.h>
19 #include <target/target_core_base.h>
20 #include <target/target_core_backend.h>
21 #include <target/target_core_fabric.h>
23 #include "target_core_internal.h"
24 #include "target_core_ua.h"
25 #include "target_core_alua.h"
28 sbc_check_prot(struct se_device *, struct se_cmd *, unsigned char, u32, bool);
29 static sense_reason_t sbc_execute_unmap(struct se_cmd *cmd);
32 sbc_emulate_readcapacity(struct se_cmd *cmd)
34 struct se_device *dev = cmd->se_dev;
35 unsigned char *cdb = cmd->t_task_cdb;
36 unsigned long long blocks_long = dev->transport->get_blocks(dev);
43 * If the PMI bit is set to zero and the LOGICAL BLOCK
44 * ADDRESS field is not set to zero, the device server shall
45 * terminate the command with CHECK CONDITION status with
46 * the sense key set to ILLEGAL REQUEST and the additional
47 * sense code set to INVALID FIELD IN CDB.
49 * In SBC-3, these fields are obsolete, but some SCSI
50 * compliance tests actually check this, so we might as well
53 if (!(cdb[8] & 1) && !!(cdb[2] | cdb[3] | cdb[4] | cdb[5]))
54 return TCM_INVALID_CDB_FIELD;
56 if (blocks_long >= 0x00000000ffffffff)
59 blocks = (u32)blocks_long;
61 put_unaligned_be32(blocks, &buf[0]);
62 put_unaligned_be32(dev->dev_attrib.block_size, &buf[4]);
64 rbuf = transport_kmap_data_sg(cmd);
66 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
67 transport_kunmap_data_sg(cmd);
70 target_complete_cmd_with_length(cmd, GOOD, 8);
75 sbc_emulate_readcapacity_16(struct se_cmd *cmd)
77 struct se_device *dev = cmd->se_dev;
78 struct se_session *sess = cmd->se_sess;
79 int pi_prot_type = dev->dev_attrib.pi_prot_type;
82 unsigned char buf[32];
83 unsigned long long blocks = dev->transport->get_blocks(dev);
85 memset(buf, 0, sizeof(buf));
86 put_unaligned_be64(blocks, &buf[0]);
87 put_unaligned_be32(dev->dev_attrib.block_size, &buf[8]);
89 * Set P_TYPE and PROT_EN bits for DIF support
91 if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
93 * Only override a device's pi_prot_type if no T10-PI is
94 * available, and sess_prot_type has been explicitly enabled.
97 pi_prot_type = sess->sess_prot_type;
100 buf[12] = (pi_prot_type - 1) << 1 | 0x1;
103 if (dev->transport->get_lbppbe)
104 buf[13] = dev->transport->get_lbppbe(dev) & 0x0f;
106 if (dev->transport->get_alignment_offset_lbas) {
107 u16 lalba = dev->transport->get_alignment_offset_lbas(dev);
109 put_unaligned_be16(lalba, &buf[14]);
113 * Set Thin Provisioning Enable bit following sbc3r22 in section
114 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
116 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws) {
120 * LBPRZ signifies that zeroes will be read back from an LBA after
121 * an UNMAP or WRITE SAME w/ unmap bit (sbc3r36 5.16.2)
123 if (dev->dev_attrib.unmap_zeroes_data)
127 rbuf = transport_kmap_data_sg(cmd);
129 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
130 transport_kunmap_data_sg(cmd);
133 target_complete_cmd_with_length(cmd, GOOD, 32);
137 static sense_reason_t
138 sbc_emulate_startstop(struct se_cmd *cmd)
140 unsigned char *cdb = cmd->t_task_cdb;
143 * See sbc3r36 section 5.25
144 * Immediate bit should be set since there is nothing to complete
145 * POWER CONDITION MODIFIER 0h
147 if (!(cdb[1] & 1) || cdb[2] || cdb[3])
148 return TCM_INVALID_CDB_FIELD;
151 * See sbc3r36 section 5.25
152 * POWER CONDITION 0h START_VALID - process START and LOEJ
154 if (cdb[4] >> 4 & 0xf)
155 return TCM_INVALID_CDB_FIELD;
158 * See sbc3r36 section 5.25
159 * LOEJ 0h - nothing to load or unload
160 * START 1h - we are ready
162 if (!(cdb[4] & 1) || (cdb[4] & 2) || (cdb[4] & 4))
163 return TCM_INVALID_CDB_FIELD;
165 target_complete_cmd(cmd, SAM_STAT_GOOD);
169 sector_t sbc_get_write_same_sectors(struct se_cmd *cmd)
173 if (cmd->t_task_cdb[0] == WRITE_SAME)
174 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
175 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
176 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
177 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
178 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
181 * Use the explicit range when non zero is supplied, otherwise calculate
182 * the remaining range based on ->get_blocks() - starting LBA.
187 return cmd->se_dev->transport->get_blocks(cmd->se_dev) -
190 EXPORT_SYMBOL(sbc_get_write_same_sectors);
192 static sense_reason_t
193 sbc_execute_write_same_unmap(struct se_cmd *cmd)
195 struct sbc_ops *ops = cmd->protocol_data;
196 sector_t nolb = sbc_get_write_same_sectors(cmd);
200 ret = ops->execute_unmap(cmd, cmd->t_task_lba, nolb);
205 target_complete_cmd(cmd, GOOD);
209 static sense_reason_t
210 sbc_emulate_noop(struct se_cmd *cmd)
212 target_complete_cmd(cmd, GOOD);
216 static inline u32 sbc_get_size(struct se_cmd *cmd, u32 sectors)
218 return cmd->se_dev->dev_attrib.block_size * sectors;
221 static inline u32 transport_get_sectors_6(unsigned char *cdb)
224 * Use 8-bit sector value. SBC-3 says:
226 * A TRANSFER LENGTH field set to zero specifies that 256
227 * logical blocks shall be written. Any other value
228 * specifies the number of logical blocks that shall be
231 return cdb[4] ? : 256;
234 static inline u32 transport_get_sectors_10(unsigned char *cdb)
236 return get_unaligned_be16(&cdb[7]);
239 static inline u32 transport_get_sectors_12(unsigned char *cdb)
241 return get_unaligned_be32(&cdb[6]);
244 static inline u32 transport_get_sectors_16(unsigned char *cdb)
246 return get_unaligned_be32(&cdb[10]);
250 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
252 static inline u32 transport_get_sectors_32(unsigned char *cdb)
254 return get_unaligned_be32(&cdb[28]);
258 static inline u32 transport_lba_21(unsigned char *cdb)
260 return get_unaligned_be24(&cdb[1]) & 0x1fffff;
263 static inline u32 transport_lba_32(unsigned char *cdb)
265 return get_unaligned_be32(&cdb[2]);
268 static inline unsigned long long transport_lba_64(unsigned char *cdb)
270 return get_unaligned_be64(&cdb[2]);
274 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
276 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb)
278 return get_unaligned_be64(&cdb[12]);
281 static sense_reason_t
282 sbc_setup_write_same(struct se_cmd *cmd, unsigned char flags, struct sbc_ops *ops)
284 struct se_device *dev = cmd->se_dev;
285 sector_t end_lba = dev->transport->get_blocks(dev) + 1;
286 unsigned int sectors = sbc_get_write_same_sectors(cmd);
289 if ((flags & 0x04) || (flags & 0x02)) {
290 pr_err("WRITE_SAME PBDATA and LBDATA"
291 " bits not supported for Block Discard"
293 return TCM_UNSUPPORTED_SCSI_OPCODE;
295 if (sectors > cmd->se_dev->dev_attrib.max_write_same_len) {
296 pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
297 sectors, cmd->se_dev->dev_attrib.max_write_same_len);
298 return TCM_INVALID_CDB_FIELD;
301 * Sanity check for LBA wrap and request past end of device.
303 if (((cmd->t_task_lba + sectors) < cmd->t_task_lba) ||
304 ((cmd->t_task_lba + sectors) > end_lba)) {
305 pr_err("WRITE_SAME exceeds last lba %llu (lba %llu, sectors %u)\n",
306 (unsigned long long)end_lba, cmd->t_task_lba, sectors);
307 return TCM_ADDRESS_OUT_OF_RANGE;
310 /* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
312 pr_warn("WRITE SAME with ANCHOR not supported\n");
313 return TCM_INVALID_CDB_FIELD;
316 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
317 * translated into block discard requests within backend code.
320 if (!ops->execute_unmap)
321 return TCM_UNSUPPORTED_SCSI_OPCODE;
323 if (!dev->dev_attrib.emulate_tpws) {
324 pr_err("Got WRITE_SAME w/ UNMAP=1, but backend device"
325 " has emulate_tpws disabled\n");
326 return TCM_UNSUPPORTED_SCSI_OPCODE;
328 cmd->execute_cmd = sbc_execute_write_same_unmap;
331 if (!ops->execute_write_same)
332 return TCM_UNSUPPORTED_SCSI_OPCODE;
334 ret = sbc_check_prot(dev, cmd, flags >> 5, sectors, true);
338 cmd->execute_cmd = ops->execute_write_same;
342 static sense_reason_t xdreadwrite_callback(struct se_cmd *cmd, bool success,
345 unsigned char *buf, *addr;
346 struct scatterlist *sg;
348 sense_reason_t ret = TCM_NO_SENSE;
355 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
357 * 1) read the specified logical block(s);
358 * 2) transfer logical blocks from the data-out buffer;
359 * 3) XOR the logical blocks transferred from the data-out buffer with
360 * the logical blocks read, storing the resulting XOR data in a buffer;
361 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
362 * blocks transferred from the data-out buffer; and
363 * 5) transfer the resulting XOR data to the data-in buffer.
365 buf = kmalloc(cmd->data_length, GFP_KERNEL);
367 pr_err("Unable to allocate xor_callback buf\n");
368 return TCM_OUT_OF_RESOURCES;
371 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
372 * into the locally allocated *buf
374 sg_copy_to_buffer(cmd->t_data_sg,
380 * Now perform the XOR against the BIDI read memory located at
381 * cmd->t_mem_bidi_list
385 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, count) {
386 addr = kmap_atomic(sg_page(sg));
388 ret = TCM_OUT_OF_RESOURCES;
392 for (i = 0; i < sg->length; i++)
393 *(addr + sg->offset + i) ^= *(buf + offset + i);
395 offset += sg->length;
404 static sense_reason_t
405 sbc_execute_rw(struct se_cmd *cmd)
407 struct sbc_ops *ops = cmd->protocol_data;
409 return ops->execute_rw(cmd, cmd->t_data_sg, cmd->t_data_nents,
410 cmd->data_direction);
413 static sense_reason_t compare_and_write_post(struct se_cmd *cmd, bool success,
416 struct se_device *dev = cmd->se_dev;
417 sense_reason_t ret = TCM_NO_SENSE;
419 spin_lock_irq(&cmd->t_state_lock);
423 if (cmd->scsi_status == SAM_STAT_CHECK_CONDITION)
424 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
426 spin_unlock_irq(&cmd->t_state_lock);
429 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
430 * before the original READ I/O submission.
437 static sense_reason_t compare_and_write_callback(struct se_cmd *cmd, bool success,
440 struct se_device *dev = cmd->se_dev;
441 struct sg_table write_tbl = { };
442 struct scatterlist *write_sg, *sg;
443 unsigned char *buf = NULL, *addr;
444 struct sg_mapping_iter m;
445 unsigned int offset = 0, len;
446 unsigned int nlbas = cmd->t_task_nolb;
447 unsigned int block_size = dev->dev_attrib.block_size;
448 unsigned int compare_len = (nlbas * block_size);
449 sense_reason_t ret = TCM_NO_SENSE;
453 * Handle early failure in transport_generic_request_failure(),
454 * which will not have taken ->caw_sem yet..
456 if (!success && (!cmd->t_data_sg || !cmd->t_bidi_data_sg))
459 * Handle special case for zero-length COMPARE_AND_WRITE
461 if (!cmd->data_length)
464 * Immediately exit + release dev->caw_sem if command has already
465 * been failed with a non-zero SCSI status.
467 if (cmd->scsi_status) {
468 pr_debug("compare_and_write_callback: non zero scsi_status:"
469 " 0x%02x\n", cmd->scsi_status);
471 if (cmd->scsi_status == SAM_STAT_CHECK_CONDITION)
472 ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
476 buf = kzalloc(cmd->data_length, GFP_KERNEL);
478 pr_err("Unable to allocate compare_and_write buf\n");
479 ret = TCM_OUT_OF_RESOURCES;
483 if (sg_alloc_table(&write_tbl, cmd->t_data_nents, GFP_KERNEL) < 0) {
484 pr_err("Unable to allocate compare_and_write sg\n");
485 ret = TCM_OUT_OF_RESOURCES;
488 write_sg = write_tbl.sgl;
490 * Setup verify and write data payloads from total NumberLBAs.
492 rc = sg_copy_to_buffer(cmd->t_data_sg, cmd->t_data_nents, buf,
495 pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
496 ret = TCM_OUT_OF_RESOURCES;
500 * Compare against SCSI READ payload against verify payload
502 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, i) {
503 addr = (unsigned char *)kmap_atomic(sg_page(sg));
505 ret = TCM_OUT_OF_RESOURCES;
509 len = min(sg->length, compare_len);
511 if (memcmp(addr, buf + offset, len)) {
512 pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
526 len = cmd->t_task_nolb * block_size;
527 sg_miter_start(&m, cmd->t_data_sg, cmd->t_data_nents, SG_MITER_TO_SG);
529 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
534 if (block_size < PAGE_SIZE) {
535 sg_set_page(&write_sg[i], m.page, block_size,
536 m.piter.sg->offset + block_size);
539 sg_set_page(&write_sg[i], m.page, block_size,
547 * Save the original SGL + nents values before updating to new
548 * assignments, to be released in transport_free_pages() ->
549 * transport_reset_sgl_orig()
551 cmd->t_data_sg_orig = cmd->t_data_sg;
552 cmd->t_data_sg = write_sg;
553 cmd->t_data_nents_orig = cmd->t_data_nents;
554 cmd->t_data_nents = 1;
556 cmd->sam_task_attr = TCM_HEAD_TAG;
557 cmd->transport_complete_callback = compare_and_write_post;
559 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
560 * for submitting the adjusted SGL to write instance user-data.
562 cmd->execute_cmd = sbc_execute_rw;
564 spin_lock_irq(&cmd->t_state_lock);
565 cmd->t_state = TRANSPORT_PROCESSING;
566 cmd->transport_state |= CMD_T_ACTIVE | CMD_T_SENT;
567 spin_unlock_irq(&cmd->t_state_lock);
569 __target_execute_cmd(cmd, false);
575 pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
576 dev->transport->name);
577 ret = TCM_MISCOMPARE_VERIFY;
580 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
581 * sbc_compare_and_write() before the original READ I/O submission.
584 sg_free_table(&write_tbl);
589 static sense_reason_t
590 sbc_compare_and_write(struct se_cmd *cmd)
592 struct sbc_ops *ops = cmd->protocol_data;
593 struct se_device *dev = cmd->se_dev;
597 * Submit the READ first for COMPARE_AND_WRITE to perform the
598 * comparision using SGLs at cmd->t_bidi_data_sg..
600 rc = down_interruptible(&dev->caw_sem);
602 cmd->transport_complete_callback = NULL;
603 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
606 * Reset cmd->data_length to individual block_size in order to not
607 * confuse backend drivers that depend on this value matching the
608 * size of the I/O being submitted.
610 cmd->data_length = cmd->t_task_nolb * dev->dev_attrib.block_size;
612 ret = ops->execute_rw(cmd, cmd->t_bidi_data_sg, cmd->t_bidi_data_nents,
615 cmd->transport_complete_callback = NULL;
620 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
621 * upon MISCOMPARE, or in compare_and_write_done() upon completion
622 * of WRITE instance user-data.
628 sbc_set_prot_op_checks(u8 protect, bool fabric_prot, enum target_prot_type prot_type,
629 bool is_write, struct se_cmd *cmd)
632 cmd->prot_op = fabric_prot ? TARGET_PROT_DOUT_STRIP :
633 protect ? TARGET_PROT_DOUT_PASS :
634 TARGET_PROT_DOUT_INSERT;
638 cmd->prot_checks = 0;
642 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
643 if (prot_type == TARGET_DIF_TYPE1_PROT)
644 cmd->prot_checks |= TARGET_DIF_CHECK_REFTAG;
647 if (prot_type == TARGET_DIF_TYPE1_PROT)
648 cmd->prot_checks = TARGET_DIF_CHECK_REFTAG;
651 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
654 pr_err("Unsupported protect field %d\n", protect);
658 cmd->prot_op = fabric_prot ? TARGET_PROT_DIN_INSERT :
659 protect ? TARGET_PROT_DIN_PASS :
660 TARGET_PROT_DIN_STRIP;
665 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
666 if (prot_type == TARGET_DIF_TYPE1_PROT)
667 cmd->prot_checks |= TARGET_DIF_CHECK_REFTAG;
670 if (prot_type == TARGET_DIF_TYPE1_PROT)
671 cmd->prot_checks = TARGET_DIF_CHECK_REFTAG;
674 cmd->prot_checks = 0;
677 cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
680 pr_err("Unsupported protect field %d\n", protect);
688 static sense_reason_t
689 sbc_check_prot(struct se_device *dev, struct se_cmd *cmd, unsigned char protect,
690 u32 sectors, bool is_write)
692 int sp_ops = cmd->se_sess->sup_prot_ops;
693 int pi_prot_type = dev->dev_attrib.pi_prot_type;
694 bool fabric_prot = false;
696 if (!cmd->t_prot_sg || !cmd->t_prot_nents) {
697 if (unlikely(protect &&
698 !dev->dev_attrib.pi_prot_type && !cmd->se_sess->sess_prot_type)) {
699 pr_err("CDB contains protect bit, but device + fabric does"
700 " not advertise PROTECT=1 feature bit\n");
701 return TCM_INVALID_CDB_FIELD;
707 switch (dev->dev_attrib.pi_prot_type) {
708 case TARGET_DIF_TYPE3_PROT:
709 cmd->reftag_seed = 0xffffffff;
711 case TARGET_DIF_TYPE2_PROT:
713 return TCM_INVALID_CDB_FIELD;
715 cmd->reftag_seed = cmd->t_task_lba;
717 case TARGET_DIF_TYPE1_PROT:
718 cmd->reftag_seed = cmd->t_task_lba;
720 case TARGET_DIF_TYPE0_PROT:
722 * See if the fabric supports T10-PI, and the session has been
723 * configured to allow export PROTECT=1 feature bit with backend
724 * devices that don't support T10-PI.
726 fabric_prot = is_write ?
727 !!(sp_ops & (TARGET_PROT_DOUT_PASS | TARGET_PROT_DOUT_STRIP)) :
728 !!(sp_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DIN_INSERT));
730 if (fabric_prot && cmd->se_sess->sess_prot_type) {
731 pi_prot_type = cmd->se_sess->sess_prot_type;
738 pr_err("Unable to determine pi_prot_type for CDB: 0x%02x "
739 "PROTECT: 0x%02x\n", cmd->t_task_cdb[0], protect);
740 return TCM_INVALID_CDB_FIELD;
743 if (sbc_set_prot_op_checks(protect, fabric_prot, pi_prot_type, is_write, cmd))
744 return TCM_INVALID_CDB_FIELD;
746 cmd->prot_type = pi_prot_type;
747 cmd->prot_length = dev->prot_length * sectors;
750 * In case protection information exists over the wire
751 * we modify command data length to describe pure data.
752 * The actual transfer length is data length + protection
756 cmd->data_length = sectors * dev->dev_attrib.block_size;
758 pr_debug("%s: prot_type=%d, data_length=%d, prot_length=%d "
759 "prot_op=%d prot_checks=%d\n",
760 __func__, cmd->prot_type, cmd->data_length, cmd->prot_length,
761 cmd->prot_op, cmd->prot_checks);
767 sbc_check_dpofua(struct se_device *dev, struct se_cmd *cmd, unsigned char *cdb)
770 /* see explanation in spc_emulate_modesense */
771 if (!target_check_fua(dev)) {
772 pr_err("Got CDB: 0x%02x with DPO bit set, but device"
773 " does not advertise support for DPO\n", cdb[0]);
778 if (!target_check_fua(dev)) {
779 pr_err("Got CDB: 0x%02x with FUA bit set, but device"
780 " does not advertise support for FUA write\n",
784 cmd->se_cmd_flags |= SCF_FUA;
790 sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops)
792 struct se_device *dev = cmd->se_dev;
793 unsigned char *cdb = cmd->t_task_cdb;
798 cmd->protocol_data = ops;
802 sectors = transport_get_sectors_6(cdb);
803 cmd->t_task_lba = transport_lba_21(cdb);
804 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
805 cmd->execute_cmd = sbc_execute_rw;
808 sectors = transport_get_sectors_10(cdb);
809 cmd->t_task_lba = transport_lba_32(cdb);
811 if (sbc_check_dpofua(dev, cmd, cdb))
812 return TCM_INVALID_CDB_FIELD;
814 ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, false);
818 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
819 cmd->execute_cmd = sbc_execute_rw;
822 sectors = transport_get_sectors_12(cdb);
823 cmd->t_task_lba = transport_lba_32(cdb);
825 if (sbc_check_dpofua(dev, cmd, cdb))
826 return TCM_INVALID_CDB_FIELD;
828 ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, false);
832 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
833 cmd->execute_cmd = sbc_execute_rw;
836 sectors = transport_get_sectors_16(cdb);
837 cmd->t_task_lba = transport_lba_64(cdb);
839 if (sbc_check_dpofua(dev, cmd, cdb))
840 return TCM_INVALID_CDB_FIELD;
842 ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, false);
846 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
847 cmd->execute_cmd = sbc_execute_rw;
850 sectors = transport_get_sectors_6(cdb);
851 cmd->t_task_lba = transport_lba_21(cdb);
852 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
853 cmd->execute_cmd = sbc_execute_rw;
857 sectors = transport_get_sectors_10(cdb);
858 cmd->t_task_lba = transport_lba_32(cdb);
860 if (sbc_check_dpofua(dev, cmd, cdb))
861 return TCM_INVALID_CDB_FIELD;
863 ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, true);
867 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
868 cmd->execute_cmd = sbc_execute_rw;
871 sectors = transport_get_sectors_12(cdb);
872 cmd->t_task_lba = transport_lba_32(cdb);
874 if (sbc_check_dpofua(dev, cmd, cdb))
875 return TCM_INVALID_CDB_FIELD;
877 ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, true);
881 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
882 cmd->execute_cmd = sbc_execute_rw;
885 case WRITE_VERIFY_16:
886 sectors = transport_get_sectors_16(cdb);
887 cmd->t_task_lba = transport_lba_64(cdb);
889 if (sbc_check_dpofua(dev, cmd, cdb))
890 return TCM_INVALID_CDB_FIELD;
892 ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, true);
896 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
897 cmd->execute_cmd = sbc_execute_rw;
900 if (cmd->data_direction != DMA_TO_DEVICE ||
901 !(cmd->se_cmd_flags & SCF_BIDI))
902 return TCM_INVALID_CDB_FIELD;
903 sectors = transport_get_sectors_10(cdb);
905 if (sbc_check_dpofua(dev, cmd, cdb))
906 return TCM_INVALID_CDB_FIELD;
908 cmd->t_task_lba = transport_lba_32(cdb);
909 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
912 * Setup BIDI XOR callback to be run after I/O completion.
914 cmd->execute_cmd = sbc_execute_rw;
915 cmd->transport_complete_callback = &xdreadwrite_callback;
917 case VARIABLE_LENGTH_CMD:
919 u16 service_action = get_unaligned_be16(&cdb[8]);
920 switch (service_action) {
922 sectors = transport_get_sectors_32(cdb);
924 if (sbc_check_dpofua(dev, cmd, cdb))
925 return TCM_INVALID_CDB_FIELD;
927 * Use WRITE_32 and READ_32 opcodes for the emulated
928 * XDWRITE_READ_32 logic.
930 cmd->t_task_lba = transport_lba_64_ext(cdb);
931 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
934 * Setup BIDI XOR callback to be run during after I/O
937 cmd->execute_cmd = sbc_execute_rw;
938 cmd->transport_complete_callback = &xdreadwrite_callback;
941 sectors = transport_get_sectors_32(cdb);
943 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
945 return TCM_INVALID_CDB_FIELD;
948 size = sbc_get_size(cmd, 1);
949 cmd->t_task_lba = get_unaligned_be64(&cdb[12]);
951 ret = sbc_setup_write_same(cmd, cdb[10], ops);
956 pr_err("VARIABLE_LENGTH_CMD service action"
957 " 0x%04x not supported\n", service_action);
958 return TCM_UNSUPPORTED_SCSI_OPCODE;
962 case COMPARE_AND_WRITE:
963 if (!dev->dev_attrib.emulate_caw) {
964 pr_err_ratelimited("se_device %s/%s (vpd_unit_serial %s) reject COMPARE_AND_WRITE\n",
965 dev->se_hba->backend->ops->name,
966 config_item_name(&dev->dev_group.cg_item),
967 dev->t10_wwn.unit_serial);
968 return TCM_UNSUPPORTED_SCSI_OPCODE;
972 * Currently enforce COMPARE_AND_WRITE for a single sector
975 pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
976 " than 1\n", sectors);
977 return TCM_INVALID_CDB_FIELD;
979 if (sbc_check_dpofua(dev, cmd, cdb))
980 return TCM_INVALID_CDB_FIELD;
983 * Double size because we have two buffers, note that
984 * zero is not an error..
986 size = 2 * sbc_get_size(cmd, sectors);
987 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
988 cmd->t_task_nolb = sectors;
989 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB | SCF_COMPARE_AND_WRITE;
990 cmd->execute_cmd = sbc_compare_and_write;
991 cmd->transport_complete_callback = compare_and_write_callback;
995 cmd->execute_cmd = sbc_emulate_readcapacity;
997 case SERVICE_ACTION_IN_16:
998 switch (cmd->t_task_cdb[1] & 0x1f) {
999 case SAI_READ_CAPACITY_16:
1000 cmd->execute_cmd = sbc_emulate_readcapacity_16;
1002 case SAI_REPORT_REFERRALS:
1003 cmd->execute_cmd = target_emulate_report_referrals;
1006 pr_err("Unsupported SA: 0x%02x\n",
1007 cmd->t_task_cdb[1] & 0x1f);
1008 return TCM_INVALID_CDB_FIELD;
1010 size = get_unaligned_be32(&cdb[10]);
1012 case SYNCHRONIZE_CACHE:
1013 case SYNCHRONIZE_CACHE_16:
1014 if (cdb[0] == SYNCHRONIZE_CACHE) {
1015 sectors = transport_get_sectors_10(cdb);
1016 cmd->t_task_lba = transport_lba_32(cdb);
1018 sectors = transport_get_sectors_16(cdb);
1019 cmd->t_task_lba = transport_lba_64(cdb);
1021 if (ops->execute_sync_cache) {
1022 cmd->execute_cmd = ops->execute_sync_cache;
1026 cmd->execute_cmd = sbc_emulate_noop;
1029 if (!ops->execute_unmap)
1030 return TCM_UNSUPPORTED_SCSI_OPCODE;
1032 if (!dev->dev_attrib.emulate_tpu) {
1033 pr_err("Got UNMAP, but backend device has"
1034 " emulate_tpu disabled\n");
1035 return TCM_UNSUPPORTED_SCSI_OPCODE;
1037 size = get_unaligned_be16(&cdb[7]);
1038 cmd->execute_cmd = sbc_execute_unmap;
1041 sectors = transport_get_sectors_16(cdb);
1043 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
1044 return TCM_INVALID_CDB_FIELD;
1047 size = sbc_get_size(cmd, 1);
1048 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
1050 ret = sbc_setup_write_same(cmd, cdb[1], ops);
1055 sectors = transport_get_sectors_10(cdb);
1057 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
1058 return TCM_INVALID_CDB_FIELD;
1061 size = sbc_get_size(cmd, 1);
1062 cmd->t_task_lba = get_unaligned_be32(&cdb[2]);
1065 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
1066 * of byte 1 bit 3 UNMAP instead of original reserved field
1068 ret = sbc_setup_write_same(cmd, cdb[1], ops);
1075 if (cdb[0] == VERIFY) {
1076 sectors = transport_get_sectors_10(cdb);
1077 cmd->t_task_lba = transport_lba_32(cdb);
1079 sectors = transport_get_sectors_16(cdb);
1080 cmd->t_task_lba = transport_lba_64(cdb);
1082 cmd->execute_cmd = sbc_emulate_noop;
1088 * There are still clients out there which use these old SCSI-2
1089 * commands. This mainly happens when running VMs with legacy
1090 * guest systems, connected via SCSI command pass-through to
1091 * iSCSI targets. Make them happy and return status GOOD.
1094 cmd->execute_cmd = sbc_emulate_noop;
1098 cmd->execute_cmd = sbc_emulate_startstop;
1101 ret = spc_parse_cdb(cmd, &size);
1106 /* reject any command that we don't have a handler for */
1107 if (!cmd->execute_cmd)
1108 return TCM_UNSUPPORTED_SCSI_OPCODE;
1110 if (cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) {
1111 unsigned long long end_lba;
1113 end_lba = dev->transport->get_blocks(dev) + 1;
1114 if (((cmd->t_task_lba + sectors) < cmd->t_task_lba) ||
1115 ((cmd->t_task_lba + sectors) > end_lba)) {
1116 pr_err("cmd exceeds last lba %llu "
1117 "(lba %llu, sectors %u)\n",
1118 end_lba, cmd->t_task_lba, sectors);
1119 return TCM_ADDRESS_OUT_OF_RANGE;
1122 if (!(cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE))
1123 size = sbc_get_size(cmd, sectors);
1126 return target_cmd_size_check(cmd, size);
1128 EXPORT_SYMBOL(sbc_parse_cdb);
1130 u32 sbc_get_device_type(struct se_device *dev)
1134 EXPORT_SYMBOL(sbc_get_device_type);
1136 static sense_reason_t
1137 sbc_execute_unmap(struct se_cmd *cmd)
1139 struct sbc_ops *ops = cmd->protocol_data;
1140 struct se_device *dev = cmd->se_dev;
1141 unsigned char *buf, *ptr = NULL;
1145 sense_reason_t ret = 0;
1148 /* We never set ANC_SUP */
1149 if (cmd->t_task_cdb[1])
1150 return TCM_INVALID_CDB_FIELD;
1152 if (cmd->data_length == 0) {
1153 target_complete_cmd(cmd, SAM_STAT_GOOD);
1157 if (cmd->data_length < 8) {
1158 pr_warn("UNMAP parameter list length %u too small\n",
1160 return TCM_PARAMETER_LIST_LENGTH_ERROR;
1163 buf = transport_kmap_data_sg(cmd);
1165 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1167 dl = get_unaligned_be16(&buf[0]);
1168 bd_dl = get_unaligned_be16(&buf[2]);
1170 size = cmd->data_length - 8;
1172 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
1173 cmd->data_length, bd_dl);
1177 if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
1178 ret = TCM_INVALID_PARAMETER_LIST;
1182 /* First UNMAP block descriptor starts at 8 byte offset */
1184 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1185 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1187 while (size >= 16) {
1188 lba = get_unaligned_be64(&ptr[0]);
1189 range = get_unaligned_be32(&ptr[8]);
1190 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1191 (unsigned long long)lba, range);
1193 if (range > dev->dev_attrib.max_unmap_lba_count) {
1194 ret = TCM_INVALID_PARAMETER_LIST;
1198 if (lba + range > dev->transport->get_blocks(dev) + 1) {
1199 ret = TCM_ADDRESS_OUT_OF_RANGE;
1204 ret = ops->execute_unmap(cmd, lba, range);
1214 transport_kunmap_data_sg(cmd);
1216 target_complete_cmd(cmd, GOOD);
1221 sbc_dif_generate(struct se_cmd *cmd)
1223 struct se_device *dev = cmd->se_dev;
1224 struct t10_pi_tuple *sdt;
1225 struct scatterlist *dsg = cmd->t_data_sg, *psg;
1226 sector_t sector = cmd->t_task_lba;
1227 void *daddr, *paddr;
1228 int i, j, offset = 0;
1229 unsigned int block_size = dev->dev_attrib.block_size;
1231 for_each_sg(cmd->t_prot_sg, psg, cmd->t_prot_nents, i) {
1232 paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1233 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1235 for (j = 0; j < psg->length;
1236 j += sizeof(*sdt)) {
1240 if (offset >= dsg->length) {
1241 offset -= dsg->length;
1242 kunmap_atomic(daddr - dsg->offset);
1245 kunmap_atomic(paddr - psg->offset);
1248 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1252 avail = min(block_size, dsg->length - offset);
1253 crc = crc_t10dif(daddr + offset, avail);
1254 if (avail < block_size) {
1255 kunmap_atomic(daddr - dsg->offset);
1258 kunmap_atomic(paddr - psg->offset);
1261 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1262 offset = block_size - avail;
1263 crc = crc_t10dif_update(crc, daddr, offset);
1265 offset += block_size;
1268 sdt->guard_tag = cpu_to_be16(crc);
1269 if (cmd->prot_type == TARGET_DIF_TYPE1_PROT)
1270 sdt->ref_tag = cpu_to_be32(sector & 0xffffffff);
1273 pr_debug("DIF %s INSERT sector: %llu guard_tag: 0x%04x"
1274 " app_tag: 0x%04x ref_tag: %u\n",
1275 (cmd->data_direction == DMA_TO_DEVICE) ?
1276 "WRITE" : "READ", (unsigned long long)sector,
1277 sdt->guard_tag, sdt->app_tag,
1278 be32_to_cpu(sdt->ref_tag));
1283 kunmap_atomic(daddr - dsg->offset);
1284 kunmap_atomic(paddr - psg->offset);
1288 static sense_reason_t
1289 sbc_dif_v1_verify(struct se_cmd *cmd, struct t10_pi_tuple *sdt,
1290 __u16 crc, sector_t sector, unsigned int ei_lba)
1294 if (!(cmd->prot_checks & TARGET_DIF_CHECK_GUARD))
1297 csum = cpu_to_be16(crc);
1299 if (sdt->guard_tag != csum) {
1300 pr_err("DIFv1 checksum failed on sector %llu guard tag 0x%04x"
1301 " csum 0x%04x\n", (unsigned long long)sector,
1302 be16_to_cpu(sdt->guard_tag), be16_to_cpu(csum));
1303 return TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED;
1307 if (!(cmd->prot_checks & TARGET_DIF_CHECK_REFTAG))
1310 if (cmd->prot_type == TARGET_DIF_TYPE1_PROT &&
1311 be32_to_cpu(sdt->ref_tag) != (sector & 0xffffffff)) {
1312 pr_err("DIFv1 Type 1 reference failed on sector: %llu tag: 0x%08x"
1313 " sector MSB: 0x%08x\n", (unsigned long long)sector,
1314 be32_to_cpu(sdt->ref_tag), (u32)(sector & 0xffffffff));
1315 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED;
1318 if (cmd->prot_type == TARGET_DIF_TYPE2_PROT &&
1319 be32_to_cpu(sdt->ref_tag) != ei_lba) {
1320 pr_err("DIFv1 Type 2 reference failed on sector: %llu tag: 0x%08x"
1321 " ei_lba: 0x%08x\n", (unsigned long long)sector,
1322 be32_to_cpu(sdt->ref_tag), ei_lba);
1323 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED;
1329 void sbc_dif_copy_prot(struct se_cmd *cmd, unsigned int sectors, bool read,
1330 struct scatterlist *sg, int sg_off)
1332 struct se_device *dev = cmd->se_dev;
1333 struct scatterlist *psg;
1335 unsigned int i, len, left;
1336 unsigned int offset = sg_off;
1341 left = sectors * dev->prot_length;
1343 for_each_sg(cmd->t_prot_sg, psg, cmd->t_prot_nents, i) {
1344 unsigned int psg_len, copied = 0;
1346 paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1347 psg_len = min(left, psg->length);
1349 len = min(psg_len, sg->length - offset);
1350 addr = kmap_atomic(sg_page(sg)) + sg->offset + offset;
1353 memcpy(paddr + copied, addr, len);
1355 memcpy(addr, paddr + copied, len);
1362 kunmap_atomic(addr - sg->offset - offset);
1364 if (offset >= sg->length) {
1369 kunmap_atomic(paddr - psg->offset);
1372 EXPORT_SYMBOL(sbc_dif_copy_prot);
1375 sbc_dif_verify(struct se_cmd *cmd, sector_t start, unsigned int sectors,
1376 unsigned int ei_lba, struct scatterlist *psg, int psg_off)
1378 struct se_device *dev = cmd->se_dev;
1379 struct t10_pi_tuple *sdt;
1380 struct scatterlist *dsg = cmd->t_data_sg;
1381 sector_t sector = start;
1382 void *daddr, *paddr;
1386 unsigned int block_size = dev->dev_attrib.block_size;
1388 for (; psg && sector < start + sectors; psg = sg_next(psg)) {
1389 paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1390 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1392 for (i = psg_off; i < psg->length &&
1393 sector < start + sectors;
1394 i += sizeof(*sdt)) {
1398 if (dsg_off >= dsg->length) {
1399 dsg_off -= dsg->length;
1400 kunmap_atomic(daddr - dsg->offset);
1403 kunmap_atomic(paddr - psg->offset);
1406 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1411 pr_debug("DIF READ sector: %llu guard_tag: 0x%04x"
1412 " app_tag: 0x%04x ref_tag: %u\n",
1413 (unsigned long long)sector, sdt->guard_tag,
1414 sdt->app_tag, be32_to_cpu(sdt->ref_tag));
1416 if (sdt->app_tag == T10_PI_APP_ESCAPE) {
1417 dsg_off += block_size;
1421 avail = min(block_size, dsg->length - dsg_off);
1422 crc = crc_t10dif(daddr + dsg_off, avail);
1423 if (avail < block_size) {
1424 kunmap_atomic(daddr - dsg->offset);
1427 kunmap_atomic(paddr - psg->offset);
1430 daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1431 dsg_off = block_size - avail;
1432 crc = crc_t10dif_update(crc, daddr, dsg_off);
1434 dsg_off += block_size;
1437 rc = sbc_dif_v1_verify(cmd, sdt, crc, sector, ei_lba);
1439 kunmap_atomic(daddr - dsg->offset);
1440 kunmap_atomic(paddr - psg->offset);
1441 cmd->sense_info = sector;
1450 kunmap_atomic(daddr - dsg->offset);
1451 kunmap_atomic(paddr - psg->offset);
1456 EXPORT_SYMBOL(sbc_dif_verify);