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.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_emulate_readcapacity(struct se_cmd
*cmd
)
42 struct se_device
*dev
= cmd
->se_dev
;
43 unsigned char *cdb
= cmd
->t_task_cdb
;
44 unsigned long long blocks_long
= dev
->transport
->get_blocks(dev
);
51 * If the PMI bit is set to zero and the LOGICAL BLOCK
52 * ADDRESS field is not set to zero, the device server shall
53 * terminate the command with CHECK CONDITION status with
54 * the sense key set to ILLEGAL REQUEST and the additional
55 * sense code set to INVALID FIELD IN CDB.
57 * In SBC-3, these fields are obsolete, but some SCSI
58 * compliance tests actually check this, so we might as well
61 if (!(cdb
[8] & 1) && !!(cdb
[2] | cdb
[3] | cdb
[4] | cdb
[5]))
62 return TCM_INVALID_CDB_FIELD
;
64 if (blocks_long
>= 0x00000000ffffffff)
67 blocks
= (u32
)blocks_long
;
69 buf
[0] = (blocks
>> 24) & 0xff;
70 buf
[1] = (blocks
>> 16) & 0xff;
71 buf
[2] = (blocks
>> 8) & 0xff;
72 buf
[3] = blocks
& 0xff;
73 buf
[4] = (dev
->dev_attrib
.block_size
>> 24) & 0xff;
74 buf
[5] = (dev
->dev_attrib
.block_size
>> 16) & 0xff;
75 buf
[6] = (dev
->dev_attrib
.block_size
>> 8) & 0xff;
76 buf
[7] = dev
->dev_attrib
.block_size
& 0xff;
78 rbuf
= transport_kmap_data_sg(cmd
);
80 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
81 transport_kunmap_data_sg(cmd
);
84 target_complete_cmd_with_length(cmd
, GOOD
, 8);
89 sbc_emulate_readcapacity_16(struct se_cmd
*cmd
)
91 struct se_device
*dev
= cmd
->se_dev
;
92 struct se_session
*sess
= cmd
->se_sess
;
94 unsigned char buf
[32];
95 unsigned long long blocks
= dev
->transport
->get_blocks(dev
);
97 memset(buf
, 0, sizeof(buf
));
98 buf
[0] = (blocks
>> 56) & 0xff;
99 buf
[1] = (blocks
>> 48) & 0xff;
100 buf
[2] = (blocks
>> 40) & 0xff;
101 buf
[3] = (blocks
>> 32) & 0xff;
102 buf
[4] = (blocks
>> 24) & 0xff;
103 buf
[5] = (blocks
>> 16) & 0xff;
104 buf
[6] = (blocks
>> 8) & 0xff;
105 buf
[7] = blocks
& 0xff;
106 buf
[8] = (dev
->dev_attrib
.block_size
>> 24) & 0xff;
107 buf
[9] = (dev
->dev_attrib
.block_size
>> 16) & 0xff;
108 buf
[10] = (dev
->dev_attrib
.block_size
>> 8) & 0xff;
109 buf
[11] = dev
->dev_attrib
.block_size
& 0xff;
111 * Set P_TYPE and PROT_EN bits for DIF support
113 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
114 if (dev
->dev_attrib
.pi_prot_type
)
115 buf
[12] = (dev
->dev_attrib
.pi_prot_type
- 1) << 1 | 0x1;
118 if (dev
->transport
->get_lbppbe
)
119 buf
[13] = dev
->transport
->get_lbppbe(dev
) & 0x0f;
121 if (dev
->transport
->get_alignment_offset_lbas
) {
122 u16 lalba
= dev
->transport
->get_alignment_offset_lbas(dev
);
123 buf
[14] = (lalba
>> 8) & 0x3f;
124 buf
[15] = lalba
& 0xff;
128 * Set Thin Provisioning Enable bit following sbc3r22 in section
129 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
131 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
134 rbuf
= transport_kmap_data_sg(cmd
);
136 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
137 transport_kunmap_data_sg(cmd
);
140 target_complete_cmd_with_length(cmd
, GOOD
, 32);
144 sector_t
sbc_get_write_same_sectors(struct se_cmd
*cmd
)
148 if (cmd
->t_task_cdb
[0] == WRITE_SAME
)
149 num_blocks
= get_unaligned_be16(&cmd
->t_task_cdb
[7]);
150 else if (cmd
->t_task_cdb
[0] == WRITE_SAME_16
)
151 num_blocks
= get_unaligned_be32(&cmd
->t_task_cdb
[10]);
152 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
153 num_blocks
= get_unaligned_be32(&cmd
->t_task_cdb
[28]);
156 * Use the explicit range when non zero is supplied, otherwise calculate
157 * the remaining range based on ->get_blocks() - starting LBA.
162 return cmd
->se_dev
->transport
->get_blocks(cmd
->se_dev
) -
165 EXPORT_SYMBOL(sbc_get_write_same_sectors
);
167 static sense_reason_t
168 sbc_emulate_noop(struct se_cmd
*cmd
)
170 target_complete_cmd(cmd
, GOOD
);
174 static inline u32
sbc_get_size(struct se_cmd
*cmd
, u32 sectors
)
176 return cmd
->se_dev
->dev_attrib
.block_size
* sectors
;
179 static inline u32
transport_get_sectors_6(unsigned char *cdb
)
182 * Use 8-bit sector value. SBC-3 says:
184 * A TRANSFER LENGTH field set to zero specifies that 256
185 * logical blocks shall be written. Any other value
186 * specifies the number of logical blocks that shall be
189 return cdb
[4] ? : 256;
192 static inline u32
transport_get_sectors_10(unsigned char *cdb
)
194 return (u32
)(cdb
[7] << 8) + cdb
[8];
197 static inline u32
transport_get_sectors_12(unsigned char *cdb
)
199 return (u32
)(cdb
[6] << 24) + (cdb
[7] << 16) + (cdb
[8] << 8) + cdb
[9];
202 static inline u32
transport_get_sectors_16(unsigned char *cdb
)
204 return (u32
)(cdb
[10] << 24) + (cdb
[11] << 16) +
205 (cdb
[12] << 8) + cdb
[13];
209 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
211 static inline u32
transport_get_sectors_32(unsigned char *cdb
)
213 return (u32
)(cdb
[28] << 24) + (cdb
[29] << 16) +
214 (cdb
[30] << 8) + cdb
[31];
218 static inline u32
transport_lba_21(unsigned char *cdb
)
220 return ((cdb
[1] & 0x1f) << 16) | (cdb
[2] << 8) | cdb
[3];
223 static inline u32
transport_lba_32(unsigned char *cdb
)
225 return (cdb
[2] << 24) | (cdb
[3] << 16) | (cdb
[4] << 8) | cdb
[5];
228 static inline unsigned long long transport_lba_64(unsigned char *cdb
)
230 unsigned int __v1
, __v2
;
232 __v1
= (cdb
[2] << 24) | (cdb
[3] << 16) | (cdb
[4] << 8) | cdb
[5];
233 __v2
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
235 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
239 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
241 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb
)
243 unsigned int __v1
, __v2
;
245 __v1
= (cdb
[12] << 24) | (cdb
[13] << 16) | (cdb
[14] << 8) | cdb
[15];
246 __v2
= (cdb
[16] << 24) | (cdb
[17] << 16) | (cdb
[18] << 8) | cdb
[19];
248 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
251 static sense_reason_t
252 sbc_setup_write_same(struct se_cmd
*cmd
, unsigned char *flags
, struct sbc_ops
*ops
)
254 unsigned int sectors
= sbc_get_write_same_sectors(cmd
);
256 if ((flags
[0] & 0x04) || (flags
[0] & 0x02)) {
257 pr_err("WRITE_SAME PBDATA and LBDATA"
258 " bits not supported for Block Discard"
260 return TCM_UNSUPPORTED_SCSI_OPCODE
;
262 if (sectors
> cmd
->se_dev
->dev_attrib
.max_write_same_len
) {
263 pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
264 sectors
, cmd
->se_dev
->dev_attrib
.max_write_same_len
);
265 return TCM_INVALID_CDB_FIELD
;
267 /* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
268 if (flags
[0] & 0x10) {
269 pr_warn("WRITE SAME with ANCHOR not supported\n");
270 return TCM_INVALID_CDB_FIELD
;
273 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
274 * translated into block discard requests within backend code.
276 if (flags
[0] & 0x08) {
277 if (!ops
->execute_write_same_unmap
)
278 return TCM_UNSUPPORTED_SCSI_OPCODE
;
280 cmd
->execute_cmd
= ops
->execute_write_same_unmap
;
283 if (!ops
->execute_write_same
)
284 return TCM_UNSUPPORTED_SCSI_OPCODE
;
286 cmd
->execute_cmd
= ops
->execute_write_same
;
290 static sense_reason_t
xdreadwrite_callback(struct se_cmd
*cmd
)
292 unsigned char *buf
, *addr
;
293 struct scatterlist
*sg
;
295 sense_reason_t ret
= TCM_NO_SENSE
;
298 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
300 * 1) read the specified logical block(s);
301 * 2) transfer logical blocks from the data-out buffer;
302 * 3) XOR the logical blocks transferred from the data-out buffer with
303 * the logical blocks read, storing the resulting XOR data in a buffer;
304 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
305 * blocks transferred from the data-out buffer; and
306 * 5) transfer the resulting XOR data to the data-in buffer.
308 buf
= kmalloc(cmd
->data_length
, GFP_KERNEL
);
310 pr_err("Unable to allocate xor_callback buf\n");
311 return TCM_OUT_OF_RESOURCES
;
314 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
315 * into the locally allocated *buf
317 sg_copy_to_buffer(cmd
->t_data_sg
,
323 * Now perform the XOR against the BIDI read memory located at
324 * cmd->t_mem_bidi_list
328 for_each_sg(cmd
->t_bidi_data_sg
, sg
, cmd
->t_bidi_data_nents
, count
) {
329 addr
= kmap_atomic(sg_page(sg
));
331 ret
= TCM_OUT_OF_RESOURCES
;
335 for (i
= 0; i
< sg
->length
; i
++)
336 *(addr
+ sg
->offset
+ i
) ^= *(buf
+ offset
+ i
);
338 offset
+= sg
->length
;
347 static sense_reason_t
348 sbc_execute_rw(struct se_cmd
*cmd
)
350 return cmd
->execute_rw(cmd
, cmd
->t_data_sg
, cmd
->t_data_nents
,
351 cmd
->data_direction
);
354 static sense_reason_t
compare_and_write_post(struct se_cmd
*cmd
)
356 struct se_device
*dev
= cmd
->se_dev
;
359 * Only set SCF_COMPARE_AND_WRITE_POST to force a response fall-through
360 * within target_complete_ok_work() if the command was successfully
361 * sent to the backend driver.
363 spin_lock_irq(&cmd
->t_state_lock
);
364 if ((cmd
->transport_state
& CMD_T_SENT
) && !cmd
->scsi_status
)
365 cmd
->se_cmd_flags
|= SCF_COMPARE_AND_WRITE_POST
;
366 spin_unlock_irq(&cmd
->t_state_lock
);
369 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
370 * before the original READ I/O submission.
377 static sense_reason_t
compare_and_write_callback(struct se_cmd
*cmd
)
379 struct se_device
*dev
= cmd
->se_dev
;
380 struct scatterlist
*write_sg
= NULL
, *sg
;
381 unsigned char *buf
= NULL
, *addr
;
382 struct sg_mapping_iter m
;
383 unsigned int offset
= 0, len
;
384 unsigned int nlbas
= cmd
->t_task_nolb
;
385 unsigned int block_size
= dev
->dev_attrib
.block_size
;
386 unsigned int compare_len
= (nlbas
* block_size
);
387 sense_reason_t ret
= TCM_NO_SENSE
;
391 * Handle early failure in transport_generic_request_failure(),
392 * which will not have taken ->caw_mutex yet..
394 if (!cmd
->t_data_sg
|| !cmd
->t_bidi_data_sg
)
397 * Immediately exit + release dev->caw_sem if command has already
398 * been failed with a non-zero SCSI status.
400 if (cmd
->scsi_status
) {
401 pr_err("compare_and_write_callback: non zero scsi_status:"
402 " 0x%02x\n", cmd
->scsi_status
);
406 buf
= kzalloc(cmd
->data_length
, GFP_KERNEL
);
408 pr_err("Unable to allocate compare_and_write buf\n");
409 ret
= TCM_OUT_OF_RESOURCES
;
413 write_sg
= kmalloc(sizeof(struct scatterlist
) * cmd
->t_data_nents
,
416 pr_err("Unable to allocate compare_and_write sg\n");
417 ret
= TCM_OUT_OF_RESOURCES
;
420 sg_init_table(write_sg
, cmd
->t_data_nents
);
422 * Setup verify and write data payloads from total NumberLBAs.
424 rc
= sg_copy_to_buffer(cmd
->t_data_sg
, cmd
->t_data_nents
, buf
,
427 pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
428 ret
= TCM_OUT_OF_RESOURCES
;
432 * Compare against SCSI READ payload against verify payload
434 for_each_sg(cmd
->t_bidi_data_sg
, sg
, cmd
->t_bidi_data_nents
, i
) {
435 addr
= (unsigned char *)kmap_atomic(sg_page(sg
));
437 ret
= TCM_OUT_OF_RESOURCES
;
441 len
= min(sg
->length
, compare_len
);
443 if (memcmp(addr
, buf
+ offset
, len
)) {
444 pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
458 len
= cmd
->t_task_nolb
* block_size
;
459 sg_miter_start(&m
, cmd
->t_data_sg
, cmd
->t_data_nents
, SG_MITER_TO_SG
);
461 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
466 if (block_size
< PAGE_SIZE
) {
467 sg_set_page(&write_sg
[i
], m
.page
, block_size
,
471 sg_set_page(&write_sg
[i
], m
.page
, block_size
,
479 * Save the original SGL + nents values before updating to new
480 * assignments, to be released in transport_free_pages() ->
481 * transport_reset_sgl_orig()
483 cmd
->t_data_sg_orig
= cmd
->t_data_sg
;
484 cmd
->t_data_sg
= write_sg
;
485 cmd
->t_data_nents_orig
= cmd
->t_data_nents
;
486 cmd
->t_data_nents
= 1;
488 cmd
->sam_task_attr
= MSG_HEAD_TAG
;
489 cmd
->transport_complete_callback
= compare_and_write_post
;
491 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
492 * for submitting the adjusted SGL to write instance user-data.
494 cmd
->execute_cmd
= sbc_execute_rw
;
496 spin_lock_irq(&cmd
->t_state_lock
);
497 cmd
->t_state
= TRANSPORT_PROCESSING
;
498 cmd
->transport_state
|= CMD_T_ACTIVE
|CMD_T_BUSY
|CMD_T_SENT
;
499 spin_unlock_irq(&cmd
->t_state_lock
);
501 __target_execute_cmd(cmd
);
507 pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
508 dev
->transport
->name
);
509 ret
= TCM_MISCOMPARE_VERIFY
;
512 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
513 * sbc_compare_and_write() before the original READ I/O submission.
521 static sense_reason_t
522 sbc_compare_and_write(struct se_cmd
*cmd
)
524 struct se_device
*dev
= cmd
->se_dev
;
528 * Submit the READ first for COMPARE_AND_WRITE to perform the
529 * comparision using SGLs at cmd->t_bidi_data_sg..
531 rc
= down_interruptible(&dev
->caw_sem
);
532 if ((rc
!= 0) || signal_pending(current
)) {
533 cmd
->transport_complete_callback
= NULL
;
534 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
537 * Reset cmd->data_length to individual block_size in order to not
538 * confuse backend drivers that depend on this value matching the
539 * size of the I/O being submitted.
541 cmd
->data_length
= cmd
->t_task_nolb
* dev
->dev_attrib
.block_size
;
543 ret
= cmd
->execute_rw(cmd
, cmd
->t_bidi_data_sg
, cmd
->t_bidi_data_nents
,
546 cmd
->transport_complete_callback
= NULL
;
551 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
552 * upon MISCOMPARE, or in compare_and_write_done() upon completion
553 * of WRITE instance user-data.
559 sbc_set_prot_op_checks(u8 protect
, enum target_prot_type prot_type
,
560 bool is_write
, struct se_cmd
*cmd
)
563 cmd
->prot_op
= protect
? TARGET_PROT_DOUT_PASS
:
564 TARGET_PROT_DOUT_INSERT
;
568 cmd
->prot_checks
= 0;
572 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
573 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
574 cmd
->prot_checks
|= TARGET_DIF_CHECK_REFTAG
;
577 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
578 cmd
->prot_checks
= TARGET_DIF_CHECK_REFTAG
;
581 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
584 pr_err("Unsupported protect field %d\n", protect
);
588 cmd
->prot_op
= protect
? TARGET_PROT_DIN_PASS
:
589 TARGET_PROT_DIN_STRIP
;
594 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
595 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
596 cmd
->prot_checks
|= TARGET_DIF_CHECK_REFTAG
;
599 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
600 cmd
->prot_checks
= TARGET_DIF_CHECK_REFTAG
;
603 cmd
->prot_checks
= 0;
606 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
609 pr_err("Unsupported protect field %d\n", protect
);
618 sbc_check_prot(struct se_device
*dev
, struct se_cmd
*cmd
, unsigned char *cdb
,
619 u32 sectors
, bool is_write
)
621 u8 protect
= cdb
[1] >> 5;
623 if ((!cmd
->t_prot_sg
|| !cmd
->t_prot_nents
) && cmd
->prot_pto
)
626 switch (dev
->dev_attrib
.pi_prot_type
) {
627 case TARGET_DIF_TYPE3_PROT
:
628 cmd
->reftag_seed
= 0xffffffff;
630 case TARGET_DIF_TYPE2_PROT
:
634 cmd
->reftag_seed
= cmd
->t_task_lba
;
636 case TARGET_DIF_TYPE1_PROT
:
637 cmd
->reftag_seed
= cmd
->t_task_lba
;
639 case TARGET_DIF_TYPE0_PROT
:
644 if (sbc_set_prot_op_checks(protect
, dev
->dev_attrib
.pi_prot_type
,
648 cmd
->prot_type
= dev
->dev_attrib
.pi_prot_type
;
649 cmd
->prot_length
= dev
->prot_length
* sectors
;
652 * In case protection information exists over the wire
653 * we modify command data length to describe pure data.
654 * The actual transfer length is data length + protection
658 cmd
->data_length
= sectors
* dev
->dev_attrib
.block_size
;
660 pr_debug("%s: prot_type=%d, data_length=%d, prot_length=%d "
661 "prot_op=%d prot_checks=%d\n",
662 __func__
, cmd
->prot_type
, cmd
->data_length
, cmd
->prot_length
,
663 cmd
->prot_op
, cmd
->prot_checks
);
669 sbc_parse_cdb(struct se_cmd
*cmd
, struct sbc_ops
*ops
)
671 struct se_device
*dev
= cmd
->se_dev
;
672 unsigned char *cdb
= cmd
->t_task_cdb
;
679 sectors
= transport_get_sectors_6(cdb
);
680 cmd
->t_task_lba
= transport_lba_21(cdb
);
681 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
682 cmd
->execute_rw
= ops
->execute_rw
;
683 cmd
->execute_cmd
= sbc_execute_rw
;
686 sectors
= transport_get_sectors_10(cdb
);
687 cmd
->t_task_lba
= transport_lba_32(cdb
);
689 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, false))
690 return TCM_UNSUPPORTED_SCSI_OPCODE
;
692 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
693 cmd
->execute_rw
= ops
->execute_rw
;
694 cmd
->execute_cmd
= sbc_execute_rw
;
697 sectors
= transport_get_sectors_12(cdb
);
698 cmd
->t_task_lba
= transport_lba_32(cdb
);
700 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, false))
701 return TCM_UNSUPPORTED_SCSI_OPCODE
;
703 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
704 cmd
->execute_rw
= ops
->execute_rw
;
705 cmd
->execute_cmd
= sbc_execute_rw
;
708 sectors
= transport_get_sectors_16(cdb
);
709 cmd
->t_task_lba
= transport_lba_64(cdb
);
711 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, false))
712 return TCM_UNSUPPORTED_SCSI_OPCODE
;
714 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
715 cmd
->execute_rw
= ops
->execute_rw
;
716 cmd
->execute_cmd
= sbc_execute_rw
;
719 sectors
= transport_get_sectors_6(cdb
);
720 cmd
->t_task_lba
= transport_lba_21(cdb
);
721 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
722 cmd
->execute_rw
= ops
->execute_rw
;
723 cmd
->execute_cmd
= sbc_execute_rw
;
727 sectors
= transport_get_sectors_10(cdb
);
728 cmd
->t_task_lba
= transport_lba_32(cdb
);
730 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, true))
731 return TCM_UNSUPPORTED_SCSI_OPCODE
;
734 cmd
->se_cmd_flags
|= SCF_FUA
;
735 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
736 cmd
->execute_rw
= ops
->execute_rw
;
737 cmd
->execute_cmd
= sbc_execute_rw
;
740 sectors
= transport_get_sectors_12(cdb
);
741 cmd
->t_task_lba
= transport_lba_32(cdb
);
743 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, true))
744 return TCM_UNSUPPORTED_SCSI_OPCODE
;
747 cmd
->se_cmd_flags
|= SCF_FUA
;
748 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
749 cmd
->execute_rw
= ops
->execute_rw
;
750 cmd
->execute_cmd
= sbc_execute_rw
;
753 sectors
= transport_get_sectors_16(cdb
);
754 cmd
->t_task_lba
= transport_lba_64(cdb
);
756 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, true))
757 return TCM_UNSUPPORTED_SCSI_OPCODE
;
760 cmd
->se_cmd_flags
|= SCF_FUA
;
761 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
762 cmd
->execute_rw
= ops
->execute_rw
;
763 cmd
->execute_cmd
= sbc_execute_rw
;
766 if (cmd
->data_direction
!= DMA_TO_DEVICE
||
767 !(cmd
->se_cmd_flags
& SCF_BIDI
))
768 return TCM_INVALID_CDB_FIELD
;
769 sectors
= transport_get_sectors_10(cdb
);
771 cmd
->t_task_lba
= transport_lba_32(cdb
);
772 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
775 * Setup BIDI XOR callback to be run after I/O completion.
777 cmd
->execute_rw
= ops
->execute_rw
;
778 cmd
->execute_cmd
= sbc_execute_rw
;
779 cmd
->transport_complete_callback
= &xdreadwrite_callback
;
781 cmd
->se_cmd_flags
|= SCF_FUA
;
783 case VARIABLE_LENGTH_CMD
:
785 u16 service_action
= get_unaligned_be16(&cdb
[8]);
786 switch (service_action
) {
788 sectors
= transport_get_sectors_32(cdb
);
791 * Use WRITE_32 and READ_32 opcodes for the emulated
792 * XDWRITE_READ_32 logic.
794 cmd
->t_task_lba
= transport_lba_64_ext(cdb
);
795 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
798 * Setup BIDI XOR callback to be run during after I/O
801 cmd
->execute_rw
= ops
->execute_rw
;
802 cmd
->execute_cmd
= sbc_execute_rw
;
803 cmd
->transport_complete_callback
= &xdreadwrite_callback
;
805 cmd
->se_cmd_flags
|= SCF_FUA
;
808 sectors
= transport_get_sectors_32(cdb
);
810 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
812 return TCM_INVALID_CDB_FIELD
;
815 size
= sbc_get_size(cmd
, 1);
816 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[12]);
818 ret
= sbc_setup_write_same(cmd
, &cdb
[10], ops
);
823 pr_err("VARIABLE_LENGTH_CMD service action"
824 " 0x%04x not supported\n", service_action
);
825 return TCM_UNSUPPORTED_SCSI_OPCODE
;
829 case COMPARE_AND_WRITE
:
832 * Currently enforce COMPARE_AND_WRITE for a single sector
835 pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
836 " than 1\n", sectors
);
837 return TCM_INVALID_CDB_FIELD
;
840 * Double size because we have two buffers, note that
841 * zero is not an error..
843 size
= 2 * sbc_get_size(cmd
, sectors
);
844 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[2]);
845 cmd
->t_task_nolb
= sectors
;
846 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
| SCF_COMPARE_AND_WRITE
;
847 cmd
->execute_rw
= ops
->execute_rw
;
848 cmd
->execute_cmd
= sbc_compare_and_write
;
849 cmd
->transport_complete_callback
= compare_and_write_callback
;
853 cmd
->execute_cmd
= sbc_emulate_readcapacity
;
855 case SERVICE_ACTION_IN
:
856 switch (cmd
->t_task_cdb
[1] & 0x1f) {
857 case SAI_READ_CAPACITY_16
:
858 cmd
->execute_cmd
= sbc_emulate_readcapacity_16
;
860 case SAI_REPORT_REFERRALS
:
861 cmd
->execute_cmd
= target_emulate_report_referrals
;
864 pr_err("Unsupported SA: 0x%02x\n",
865 cmd
->t_task_cdb
[1] & 0x1f);
866 return TCM_INVALID_CDB_FIELD
;
868 size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
869 (cdb
[12] << 8) | cdb
[13];
871 case SYNCHRONIZE_CACHE
:
872 case SYNCHRONIZE_CACHE_16
:
873 if (cdb
[0] == SYNCHRONIZE_CACHE
) {
874 sectors
= transport_get_sectors_10(cdb
);
875 cmd
->t_task_lba
= transport_lba_32(cdb
);
877 sectors
= transport_get_sectors_16(cdb
);
878 cmd
->t_task_lba
= transport_lba_64(cdb
);
880 if (ops
->execute_sync_cache
) {
881 cmd
->execute_cmd
= ops
->execute_sync_cache
;
885 cmd
->execute_cmd
= sbc_emulate_noop
;
888 if (!ops
->execute_unmap
)
889 return TCM_UNSUPPORTED_SCSI_OPCODE
;
891 size
= get_unaligned_be16(&cdb
[7]);
892 cmd
->execute_cmd
= ops
->execute_unmap
;
895 sectors
= transport_get_sectors_16(cdb
);
897 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
898 return TCM_INVALID_CDB_FIELD
;
901 size
= sbc_get_size(cmd
, 1);
902 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[2]);
904 ret
= sbc_setup_write_same(cmd
, &cdb
[1], ops
);
909 sectors
= transport_get_sectors_10(cdb
);
911 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
912 return TCM_INVALID_CDB_FIELD
;
915 size
= sbc_get_size(cmd
, 1);
916 cmd
->t_task_lba
= get_unaligned_be32(&cdb
[2]);
919 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
920 * of byte 1 bit 3 UNMAP instead of original reserved field
922 ret
= sbc_setup_write_same(cmd
, &cdb
[1], ops
);
928 sectors
= transport_get_sectors_10(cdb
);
929 cmd
->t_task_lba
= transport_lba_32(cdb
);
930 cmd
->execute_cmd
= sbc_emulate_noop
;
936 * There are still clients out there which use these old SCSI-2
937 * commands. This mainly happens when running VMs with legacy
938 * guest systems, connected via SCSI command pass-through to
939 * iSCSI targets. Make them happy and return status GOOD.
942 cmd
->execute_cmd
= sbc_emulate_noop
;
945 ret
= spc_parse_cdb(cmd
, &size
);
950 /* reject any command that we don't have a handler for */
951 if (!(cmd
->se_cmd_flags
& SCF_SCSI_DATA_CDB
) && !cmd
->execute_cmd
)
952 return TCM_UNSUPPORTED_SCSI_OPCODE
;
954 if (cmd
->se_cmd_flags
& SCF_SCSI_DATA_CDB
) {
955 unsigned long long end_lba
;
957 if (sectors
> dev
->dev_attrib
.fabric_max_sectors
) {
958 printk_ratelimited(KERN_ERR
"SCSI OP %02xh with too"
959 " big sectors %u exceeds fabric_max_sectors:"
960 " %u\n", cdb
[0], sectors
,
961 dev
->dev_attrib
.fabric_max_sectors
);
962 return TCM_INVALID_CDB_FIELD
;
964 if (sectors
> dev
->dev_attrib
.hw_max_sectors
) {
965 printk_ratelimited(KERN_ERR
"SCSI OP %02xh with too"
966 " big sectors %u exceeds backend hw_max_sectors:"
967 " %u\n", cdb
[0], sectors
,
968 dev
->dev_attrib
.hw_max_sectors
);
969 return TCM_INVALID_CDB_FIELD
;
972 end_lba
= dev
->transport
->get_blocks(dev
) + 1;
973 if (cmd
->t_task_lba
+ sectors
> end_lba
) {
974 pr_err("cmd exceeds last lba %llu "
975 "(lba %llu, sectors %u)\n",
976 end_lba
, cmd
->t_task_lba
, sectors
);
977 return TCM_ADDRESS_OUT_OF_RANGE
;
980 if (!(cmd
->se_cmd_flags
& SCF_COMPARE_AND_WRITE
))
981 size
= sbc_get_size(cmd
, sectors
);
984 return target_cmd_size_check(cmd
, size
);
986 EXPORT_SYMBOL(sbc_parse_cdb
);
988 u32
sbc_get_device_type(struct se_device
*dev
)
992 EXPORT_SYMBOL(sbc_get_device_type
);
995 sbc_execute_unmap(struct se_cmd
*cmd
,
996 sense_reason_t (*do_unmap_fn
)(struct se_cmd
*, void *,
1000 struct se_device
*dev
= cmd
->se_dev
;
1001 unsigned char *buf
, *ptr
= NULL
;
1005 sense_reason_t ret
= 0;
1008 /* We never set ANC_SUP */
1009 if (cmd
->t_task_cdb
[1])
1010 return TCM_INVALID_CDB_FIELD
;
1012 if (cmd
->data_length
== 0) {
1013 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
1017 if (cmd
->data_length
< 8) {
1018 pr_warn("UNMAP parameter list length %u too small\n",
1020 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1023 buf
= transport_kmap_data_sg(cmd
);
1025 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1027 dl
= get_unaligned_be16(&buf
[0]);
1028 bd_dl
= get_unaligned_be16(&buf
[2]);
1030 size
= cmd
->data_length
- 8;
1032 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
1033 cmd
->data_length
, bd_dl
);
1037 if (size
/ 16 > dev
->dev_attrib
.max_unmap_block_desc_count
) {
1038 ret
= TCM_INVALID_PARAMETER_LIST
;
1042 /* First UNMAP block descriptor starts at 8 byte offset */
1044 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1045 " ptr: %p\n", dev
->transport
->name
, dl
, bd_dl
, size
, ptr
);
1047 while (size
>= 16) {
1048 lba
= get_unaligned_be64(&ptr
[0]);
1049 range
= get_unaligned_be32(&ptr
[8]);
1050 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1051 (unsigned long long)lba
, range
);
1053 if (range
> dev
->dev_attrib
.max_unmap_lba_count
) {
1054 ret
= TCM_INVALID_PARAMETER_LIST
;
1058 if (lba
+ range
> dev
->transport
->get_blocks(dev
) + 1) {
1059 ret
= TCM_ADDRESS_OUT_OF_RANGE
;
1063 ret
= do_unmap_fn(cmd
, priv
, lba
, range
);
1072 transport_kunmap_data_sg(cmd
);
1074 target_complete_cmd(cmd
, GOOD
);
1077 EXPORT_SYMBOL(sbc_execute_unmap
);
1080 sbc_dif_generate(struct se_cmd
*cmd
)
1082 struct se_device
*dev
= cmd
->se_dev
;
1083 struct se_dif_v1_tuple
*sdt
;
1084 struct scatterlist
*dsg
, *psg
= cmd
->t_prot_sg
;
1085 sector_t sector
= cmd
->t_task_lba
;
1086 void *daddr
, *paddr
;
1087 int i
, j
, offset
= 0;
1089 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1090 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1091 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1093 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1095 if (offset
>= psg
->length
) {
1096 kunmap_atomic(paddr
);
1098 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1102 sdt
= paddr
+ offset
;
1103 sdt
->guard_tag
= cpu_to_be16(crc_t10dif(daddr
+ j
,
1104 dev
->dev_attrib
.block_size
));
1105 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
)
1106 sdt
->ref_tag
= cpu_to_be32(sector
& 0xffffffff);
1109 pr_debug("DIF WRITE INSERT sector: %llu guard_tag: 0x%04x"
1110 " app_tag: 0x%04x ref_tag: %u\n",
1111 (unsigned long long)sector
, sdt
->guard_tag
,
1112 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1115 offset
+= sizeof(struct se_dif_v1_tuple
);
1118 kunmap_atomic(paddr
);
1119 kunmap_atomic(daddr
);
1123 static sense_reason_t
1124 sbc_dif_v1_verify(struct se_device
*dev
, struct se_dif_v1_tuple
*sdt
,
1125 const void *p
, sector_t sector
, unsigned int ei_lba
)
1127 int block_size
= dev
->dev_attrib
.block_size
;
1130 csum
= cpu_to_be16(crc_t10dif(p
, block_size
));
1132 if (sdt
->guard_tag
!= csum
) {
1133 pr_err("DIFv1 checksum failed on sector %llu guard tag 0x%04x"
1134 " csum 0x%04x\n", (unsigned long long)sector
,
1135 be16_to_cpu(sdt
->guard_tag
), be16_to_cpu(csum
));
1136 return TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED
;
1139 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
&&
1140 be32_to_cpu(sdt
->ref_tag
) != (sector
& 0xffffffff)) {
1141 pr_err("DIFv1 Type 1 reference failed on sector: %llu tag: 0x%08x"
1142 " sector MSB: 0x%08x\n", (unsigned long long)sector
,
1143 be32_to_cpu(sdt
->ref_tag
), (u32
)(sector
& 0xffffffff));
1144 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED
;
1147 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE2_PROT
&&
1148 be32_to_cpu(sdt
->ref_tag
) != ei_lba
) {
1149 pr_err("DIFv1 Type 2 reference failed on sector: %llu tag: 0x%08x"
1150 " ei_lba: 0x%08x\n", (unsigned long long)sector
,
1151 be32_to_cpu(sdt
->ref_tag
), ei_lba
);
1152 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED
;
1159 sbc_dif_copy_prot(struct se_cmd
*cmd
, unsigned int sectors
, bool read
,
1160 struct scatterlist
*sg
, int sg_off
)
1162 struct se_device
*dev
= cmd
->se_dev
;
1163 struct scatterlist
*psg
;
1165 unsigned int i
, len
, left
;
1166 unsigned int offset
= sg_off
;
1168 left
= sectors
* dev
->prot_length
;
1170 for_each_sg(cmd
->t_prot_sg
, psg
, cmd
->t_prot_nents
, i
) {
1171 unsigned int psg_len
, copied
= 0;
1173 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1174 psg_len
= min(left
, psg
->length
);
1176 len
= min(psg_len
, sg
->length
- offset
);
1177 addr
= kmap_atomic(sg_page(sg
)) + sg
->offset
+ offset
;
1180 memcpy(paddr
+ copied
, addr
, len
);
1182 memcpy(addr
, paddr
+ copied
, len
);
1189 if (offset
>= sg
->length
) {
1193 kunmap_atomic(addr
);
1195 kunmap_atomic(paddr
);
1200 sbc_dif_verify_write(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1201 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1203 struct se_device
*dev
= cmd
->se_dev
;
1204 struct se_dif_v1_tuple
*sdt
;
1205 struct scatterlist
*dsg
, *psg
= cmd
->t_prot_sg
;
1206 sector_t sector
= start
;
1207 void *daddr
, *paddr
;
1208 int i
, j
, offset
= 0;
1211 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1212 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1213 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1215 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1217 if (offset
>= psg
->length
) {
1218 kunmap_atomic(paddr
);
1220 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1224 sdt
= paddr
+ offset
;
1226 pr_debug("DIF WRITE sector: %llu guard_tag: 0x%04x"
1227 " app_tag: 0x%04x ref_tag: %u\n",
1228 (unsigned long long)sector
, sdt
->guard_tag
,
1229 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1231 rc
= sbc_dif_v1_verify(dev
, sdt
, daddr
+ j
, sector
,
1234 kunmap_atomic(paddr
);
1235 kunmap_atomic(daddr
);
1236 cmd
->bad_sector
= sector
;
1242 offset
+= sizeof(struct se_dif_v1_tuple
);
1245 kunmap_atomic(paddr
);
1246 kunmap_atomic(daddr
);
1248 sbc_dif_copy_prot(cmd
, sectors
, false, sg
, sg_off
);
1252 EXPORT_SYMBOL(sbc_dif_verify_write
);
1254 static sense_reason_t
1255 __sbc_dif_verify_read(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1256 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1258 struct se_device
*dev
= cmd
->se_dev
;
1259 struct se_dif_v1_tuple
*sdt
;
1260 struct scatterlist
*dsg
, *psg
= sg
;
1261 sector_t sector
= start
;
1262 void *daddr
, *paddr
;
1263 int i
, j
, offset
= sg_off
;
1266 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1267 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1268 paddr
= kmap_atomic(sg_page(psg
)) + sg
->offset
;
1270 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1272 if (offset
>= psg
->length
) {
1273 kunmap_atomic(paddr
);
1275 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1279 sdt
= paddr
+ offset
;
1281 pr_debug("DIF READ sector: %llu guard_tag: 0x%04x"
1282 " app_tag: 0x%04x ref_tag: %u\n",
1283 (unsigned long long)sector
, sdt
->guard_tag
,
1284 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1286 if (sdt
->app_tag
== cpu_to_be16(0xffff)) {
1288 offset
+= sizeof(struct se_dif_v1_tuple
);
1292 rc
= sbc_dif_v1_verify(dev
, sdt
, daddr
+ j
, sector
,
1295 kunmap_atomic(paddr
);
1296 kunmap_atomic(daddr
);
1297 cmd
->bad_sector
= sector
;
1303 offset
+= sizeof(struct se_dif_v1_tuple
);
1306 kunmap_atomic(paddr
);
1307 kunmap_atomic(daddr
);
1314 sbc_dif_read_strip(struct se_cmd
*cmd
)
1316 struct se_device
*dev
= cmd
->se_dev
;
1317 u32 sectors
= cmd
->prot_length
/ dev
->prot_length
;
1319 return __sbc_dif_verify_read(cmd
, cmd
->t_task_lba
, sectors
, 0,
1324 sbc_dif_verify_read(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1325 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1329 rc
= __sbc_dif_verify_read(cmd
, start
, sectors
, ei_lba
, sg
, sg_off
);
1333 sbc_dif_copy_prot(cmd
, sectors
, true, sg
, sg_off
);
1336 EXPORT_SYMBOL(sbc_dif_verify_read
);