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(cmd
, GOOD
);
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(cmd
, GOOD
);
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 int sbc_check_valid_sectors(struct se_cmd
*cmd
)
181 struct se_device
*dev
= cmd
->se_dev
;
182 unsigned long long end_lba
;
185 sectors
= cmd
->data_length
/ dev
->dev_attrib
.block_size
;
186 end_lba
= dev
->transport
->get_blocks(dev
) + 1;
188 if (cmd
->t_task_lba
+ sectors
> end_lba
) {
189 pr_err("target: lba %llu, sectors %u exceeds end lba %llu\n",
190 cmd
->t_task_lba
, sectors
, end_lba
);
197 static inline u32
transport_get_sectors_6(unsigned char *cdb
)
200 * Use 8-bit sector value. SBC-3 says:
202 * A TRANSFER LENGTH field set to zero specifies that 256
203 * logical blocks shall be written. Any other value
204 * specifies the number of logical blocks that shall be
207 return cdb
[4] ? : 256;
210 static inline u32
transport_get_sectors_10(unsigned char *cdb
)
212 return (u32
)(cdb
[7] << 8) + cdb
[8];
215 static inline u32
transport_get_sectors_12(unsigned char *cdb
)
217 return (u32
)(cdb
[6] << 24) + (cdb
[7] << 16) + (cdb
[8] << 8) + cdb
[9];
220 static inline u32
transport_get_sectors_16(unsigned char *cdb
)
222 return (u32
)(cdb
[10] << 24) + (cdb
[11] << 16) +
223 (cdb
[12] << 8) + cdb
[13];
227 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
229 static inline u32
transport_get_sectors_32(unsigned char *cdb
)
231 return (u32
)(cdb
[28] << 24) + (cdb
[29] << 16) +
232 (cdb
[30] << 8) + cdb
[31];
236 static inline u32
transport_lba_21(unsigned char *cdb
)
238 return ((cdb
[1] & 0x1f) << 16) | (cdb
[2] << 8) | cdb
[3];
241 static inline u32
transport_lba_32(unsigned char *cdb
)
243 return (cdb
[2] << 24) | (cdb
[3] << 16) | (cdb
[4] << 8) | cdb
[5];
246 static inline unsigned long long transport_lba_64(unsigned char *cdb
)
248 unsigned int __v1
, __v2
;
250 __v1
= (cdb
[2] << 24) | (cdb
[3] << 16) | (cdb
[4] << 8) | cdb
[5];
251 __v2
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
253 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
257 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
259 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb
)
261 unsigned int __v1
, __v2
;
263 __v1
= (cdb
[12] << 24) | (cdb
[13] << 16) | (cdb
[14] << 8) | cdb
[15];
264 __v2
= (cdb
[16] << 24) | (cdb
[17] << 16) | (cdb
[18] << 8) | cdb
[19];
266 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
269 static sense_reason_t
270 sbc_setup_write_same(struct se_cmd
*cmd
, unsigned char *flags
, struct sbc_ops
*ops
)
272 unsigned int sectors
= sbc_get_write_same_sectors(cmd
);
274 if ((flags
[0] & 0x04) || (flags
[0] & 0x02)) {
275 pr_err("WRITE_SAME PBDATA and LBDATA"
276 " bits not supported for Block Discard"
278 return TCM_UNSUPPORTED_SCSI_OPCODE
;
280 if (sectors
> cmd
->se_dev
->dev_attrib
.max_write_same_len
) {
281 pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
282 sectors
, cmd
->se_dev
->dev_attrib
.max_write_same_len
);
283 return TCM_INVALID_CDB_FIELD
;
285 /* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
286 if (flags
[0] & 0x10) {
287 pr_warn("WRITE SAME with ANCHOR not supported\n");
288 return TCM_INVALID_CDB_FIELD
;
291 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
292 * translated into block discard requests within backend code.
294 if (flags
[0] & 0x08) {
295 if (!ops
->execute_write_same_unmap
)
296 return TCM_UNSUPPORTED_SCSI_OPCODE
;
298 cmd
->execute_cmd
= ops
->execute_write_same_unmap
;
301 if (!ops
->execute_write_same
)
302 return TCM_UNSUPPORTED_SCSI_OPCODE
;
304 cmd
->execute_cmd
= ops
->execute_write_same
;
308 static sense_reason_t
xdreadwrite_callback(struct se_cmd
*cmd
)
310 unsigned char *buf
, *addr
;
311 struct scatterlist
*sg
;
313 sense_reason_t ret
= TCM_NO_SENSE
;
316 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
318 * 1) read the specified logical block(s);
319 * 2) transfer logical blocks from the data-out buffer;
320 * 3) XOR the logical blocks transferred from the data-out buffer with
321 * the logical blocks read, storing the resulting XOR data in a buffer;
322 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
323 * blocks transferred from the data-out buffer; and
324 * 5) transfer the resulting XOR data to the data-in buffer.
326 buf
= kmalloc(cmd
->data_length
, GFP_KERNEL
);
328 pr_err("Unable to allocate xor_callback buf\n");
329 return TCM_OUT_OF_RESOURCES
;
332 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
333 * into the locally allocated *buf
335 sg_copy_to_buffer(cmd
->t_data_sg
,
341 * Now perform the XOR against the BIDI read memory located at
342 * cmd->t_mem_bidi_list
346 for_each_sg(cmd
->t_bidi_data_sg
, sg
, cmd
->t_bidi_data_nents
, count
) {
347 addr
= kmap_atomic(sg_page(sg
));
349 ret
= TCM_OUT_OF_RESOURCES
;
353 for (i
= 0; i
< sg
->length
; i
++)
354 *(addr
+ sg
->offset
+ i
) ^= *(buf
+ offset
+ i
);
356 offset
+= sg
->length
;
365 static sense_reason_t
366 sbc_execute_rw(struct se_cmd
*cmd
)
368 return cmd
->execute_rw(cmd
, cmd
->t_data_sg
, cmd
->t_data_nents
,
369 cmd
->data_direction
);
372 static sense_reason_t
compare_and_write_post(struct se_cmd
*cmd
)
374 struct se_device
*dev
= cmd
->se_dev
;
377 * Only set SCF_COMPARE_AND_WRITE_POST to force a response fall-through
378 * within target_complete_ok_work() if the command was successfully
379 * sent to the backend driver.
381 spin_lock_irq(&cmd
->t_state_lock
);
382 if ((cmd
->transport_state
& CMD_T_SENT
) && !cmd
->scsi_status
)
383 cmd
->se_cmd_flags
|= SCF_COMPARE_AND_WRITE_POST
;
384 spin_unlock_irq(&cmd
->t_state_lock
);
387 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
388 * before the original READ I/O submission.
395 static sense_reason_t
compare_and_write_callback(struct se_cmd
*cmd
)
397 struct se_device
*dev
= cmd
->se_dev
;
398 struct scatterlist
*write_sg
= NULL
, *sg
;
399 unsigned char *buf
= NULL
, *addr
;
400 struct sg_mapping_iter m
;
401 unsigned int offset
= 0, len
;
402 unsigned int nlbas
= cmd
->t_task_nolb
;
403 unsigned int block_size
= dev
->dev_attrib
.block_size
;
404 unsigned int compare_len
= (nlbas
* block_size
);
405 sense_reason_t ret
= TCM_NO_SENSE
;
409 * Handle early failure in transport_generic_request_failure(),
410 * which will not have taken ->caw_mutex yet..
412 if (!cmd
->t_data_sg
|| !cmd
->t_bidi_data_sg
)
415 * Immediately exit + release dev->caw_sem if command has already
416 * been failed with a non-zero SCSI status.
418 if (cmd
->scsi_status
) {
419 pr_err("compare_and_write_callback: non zero scsi_status:"
420 " 0x%02x\n", cmd
->scsi_status
);
424 buf
= kzalloc(cmd
->data_length
, GFP_KERNEL
);
426 pr_err("Unable to allocate compare_and_write buf\n");
427 ret
= TCM_OUT_OF_RESOURCES
;
431 write_sg
= kmalloc(sizeof(struct scatterlist
) * cmd
->t_data_nents
,
434 pr_err("Unable to allocate compare_and_write sg\n");
435 ret
= TCM_OUT_OF_RESOURCES
;
438 sg_init_table(write_sg
, cmd
->t_data_nents
);
440 * Setup verify and write data payloads from total NumberLBAs.
442 rc
= sg_copy_to_buffer(cmd
->t_data_sg
, cmd
->t_data_nents
, buf
,
445 pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
446 ret
= TCM_OUT_OF_RESOURCES
;
450 * Compare against SCSI READ payload against verify payload
452 for_each_sg(cmd
->t_bidi_data_sg
, sg
, cmd
->t_bidi_data_nents
, i
) {
453 addr
= (unsigned char *)kmap_atomic(sg_page(sg
));
455 ret
= TCM_OUT_OF_RESOURCES
;
459 len
= min(sg
->length
, compare_len
);
461 if (memcmp(addr
, buf
+ offset
, len
)) {
462 pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
476 len
= cmd
->t_task_nolb
* block_size
;
477 sg_miter_start(&m
, cmd
->t_data_sg
, cmd
->t_data_nents
, SG_MITER_TO_SG
);
479 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
484 if (block_size
< PAGE_SIZE
) {
485 sg_set_page(&write_sg
[i
], m
.page
, block_size
,
489 sg_set_page(&write_sg
[i
], m
.page
, block_size
,
497 * Save the original SGL + nents values before updating to new
498 * assignments, to be released in transport_free_pages() ->
499 * transport_reset_sgl_orig()
501 cmd
->t_data_sg_orig
= cmd
->t_data_sg
;
502 cmd
->t_data_sg
= write_sg
;
503 cmd
->t_data_nents_orig
= cmd
->t_data_nents
;
504 cmd
->t_data_nents
= 1;
506 cmd
->sam_task_attr
= MSG_HEAD_TAG
;
507 cmd
->transport_complete_callback
= compare_and_write_post
;
509 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
510 * for submitting the adjusted SGL to write instance user-data.
512 cmd
->execute_cmd
= sbc_execute_rw
;
514 spin_lock_irq(&cmd
->t_state_lock
);
515 cmd
->t_state
= TRANSPORT_PROCESSING
;
516 cmd
->transport_state
|= CMD_T_ACTIVE
|CMD_T_BUSY
|CMD_T_SENT
;
517 spin_unlock_irq(&cmd
->t_state_lock
);
519 __target_execute_cmd(cmd
);
525 pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
526 dev
->transport
->name
);
527 ret
= TCM_MISCOMPARE_VERIFY
;
530 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
531 * sbc_compare_and_write() before the original READ I/O submission.
539 static sense_reason_t
540 sbc_compare_and_write(struct se_cmd
*cmd
)
542 struct se_device
*dev
= cmd
->se_dev
;
546 * Submit the READ first for COMPARE_AND_WRITE to perform the
547 * comparision using SGLs at cmd->t_bidi_data_sg..
549 rc
= down_interruptible(&dev
->caw_sem
);
550 if ((rc
!= 0) || signal_pending(current
)) {
551 cmd
->transport_complete_callback
= NULL
;
552 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
555 * Reset cmd->data_length to individual block_size in order to not
556 * confuse backend drivers that depend on this value matching the
557 * size of the I/O being submitted.
559 cmd
->data_length
= cmd
->t_task_nolb
* dev
->dev_attrib
.block_size
;
561 ret
= cmd
->execute_rw(cmd
, cmd
->t_bidi_data_sg
, cmd
->t_bidi_data_nents
,
564 cmd
->transport_complete_callback
= NULL
;
569 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
570 * upon MISCOMPARE, or in compare_and_write_done() upon completion
571 * of WRITE instance user-data.
577 sbc_set_prot_op_checks(u8 protect
, enum target_prot_type prot_type
,
578 bool is_write
, struct se_cmd
*cmd
)
581 cmd
->prot_op
= protect
? TARGET_PROT_DOUT_PASS
:
582 TARGET_PROT_DOUT_INSERT
;
586 cmd
->prot_checks
= 0;
590 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
591 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
592 cmd
->prot_checks
|= TARGET_DIF_CHECK_REFTAG
;
595 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
596 cmd
->prot_checks
= TARGET_DIF_CHECK_REFTAG
;
599 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
602 pr_err("Unsupported protect field %d\n", protect
);
606 cmd
->prot_op
= protect
? TARGET_PROT_DIN_PASS
:
607 TARGET_PROT_DIN_STRIP
;
612 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
613 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
614 cmd
->prot_checks
|= TARGET_DIF_CHECK_REFTAG
;
617 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
618 cmd
->prot_checks
= TARGET_DIF_CHECK_REFTAG
;
621 cmd
->prot_checks
= 0;
624 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
627 pr_err("Unsupported protect field %d\n", protect
);
636 sbc_check_prot(struct se_device
*dev
, struct se_cmd
*cmd
, unsigned char *cdb
,
637 u32 sectors
, bool is_write
)
639 u8 protect
= cdb
[1] >> 5;
641 if ((!cmd
->t_prot_sg
|| !cmd
->t_prot_nents
) && cmd
->prot_pto
)
644 switch (dev
->dev_attrib
.pi_prot_type
) {
645 case TARGET_DIF_TYPE3_PROT
:
646 cmd
->reftag_seed
= 0xffffffff;
648 case TARGET_DIF_TYPE2_PROT
:
652 cmd
->reftag_seed
= cmd
->t_task_lba
;
654 case TARGET_DIF_TYPE1_PROT
:
655 cmd
->reftag_seed
= cmd
->t_task_lba
;
657 case TARGET_DIF_TYPE0_PROT
:
662 if (sbc_set_prot_op_checks(protect
, dev
->dev_attrib
.pi_prot_type
,
666 cmd
->prot_type
= dev
->dev_attrib
.pi_prot_type
;
667 cmd
->prot_length
= dev
->prot_length
* sectors
;
668 pr_debug("%s: prot_type=%d, prot_length=%d prot_op=%d prot_checks=%d\n",
669 __func__
, cmd
->prot_type
, cmd
->prot_length
,
670 cmd
->prot_op
, cmd
->prot_checks
);
676 sbc_parse_cdb(struct se_cmd
*cmd
, struct sbc_ops
*ops
)
678 struct se_device
*dev
= cmd
->se_dev
;
679 unsigned char *cdb
= cmd
->t_task_cdb
;
686 sectors
= transport_get_sectors_6(cdb
);
687 cmd
->t_task_lba
= transport_lba_21(cdb
);
688 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
689 cmd
->execute_rw
= ops
->execute_rw
;
690 cmd
->execute_cmd
= sbc_execute_rw
;
693 sectors
= transport_get_sectors_10(cdb
);
694 cmd
->t_task_lba
= transport_lba_32(cdb
);
696 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, false))
697 return TCM_UNSUPPORTED_SCSI_OPCODE
;
699 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
700 cmd
->execute_rw
= ops
->execute_rw
;
701 cmd
->execute_cmd
= sbc_execute_rw
;
704 sectors
= transport_get_sectors_12(cdb
);
705 cmd
->t_task_lba
= transport_lba_32(cdb
);
707 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, false))
708 return TCM_UNSUPPORTED_SCSI_OPCODE
;
710 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
711 cmd
->execute_rw
= ops
->execute_rw
;
712 cmd
->execute_cmd
= sbc_execute_rw
;
715 sectors
= transport_get_sectors_16(cdb
);
716 cmd
->t_task_lba
= transport_lba_64(cdb
);
718 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, false))
719 return TCM_UNSUPPORTED_SCSI_OPCODE
;
721 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
722 cmd
->execute_rw
= ops
->execute_rw
;
723 cmd
->execute_cmd
= sbc_execute_rw
;
726 sectors
= transport_get_sectors_6(cdb
);
727 cmd
->t_task_lba
= transport_lba_21(cdb
);
728 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
729 cmd
->execute_rw
= ops
->execute_rw
;
730 cmd
->execute_cmd
= sbc_execute_rw
;
734 sectors
= transport_get_sectors_10(cdb
);
735 cmd
->t_task_lba
= transport_lba_32(cdb
);
737 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, true))
738 return TCM_UNSUPPORTED_SCSI_OPCODE
;
741 cmd
->se_cmd_flags
|= SCF_FUA
;
742 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
743 cmd
->execute_rw
= ops
->execute_rw
;
744 cmd
->execute_cmd
= sbc_execute_rw
;
747 sectors
= transport_get_sectors_12(cdb
);
748 cmd
->t_task_lba
= transport_lba_32(cdb
);
750 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, true))
751 return TCM_UNSUPPORTED_SCSI_OPCODE
;
754 cmd
->se_cmd_flags
|= SCF_FUA
;
755 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
756 cmd
->execute_rw
= ops
->execute_rw
;
757 cmd
->execute_cmd
= sbc_execute_rw
;
760 sectors
= transport_get_sectors_16(cdb
);
761 cmd
->t_task_lba
= transport_lba_64(cdb
);
763 if (!sbc_check_prot(dev
, cmd
, cdb
, sectors
, true))
764 return TCM_UNSUPPORTED_SCSI_OPCODE
;
767 cmd
->se_cmd_flags
|= SCF_FUA
;
768 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
769 cmd
->execute_rw
= ops
->execute_rw
;
770 cmd
->execute_cmd
= sbc_execute_rw
;
773 if (cmd
->data_direction
!= DMA_TO_DEVICE
||
774 !(cmd
->se_cmd_flags
& SCF_BIDI
))
775 return TCM_INVALID_CDB_FIELD
;
776 sectors
= transport_get_sectors_10(cdb
);
778 cmd
->t_task_lba
= transport_lba_32(cdb
);
779 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
782 * Setup BIDI XOR callback to be run after I/O completion.
784 cmd
->execute_rw
= ops
->execute_rw
;
785 cmd
->execute_cmd
= sbc_execute_rw
;
786 cmd
->transport_complete_callback
= &xdreadwrite_callback
;
788 cmd
->se_cmd_flags
|= SCF_FUA
;
790 case VARIABLE_LENGTH_CMD
:
792 u16 service_action
= get_unaligned_be16(&cdb
[8]);
793 switch (service_action
) {
795 sectors
= transport_get_sectors_32(cdb
);
798 * Use WRITE_32 and READ_32 opcodes for the emulated
799 * XDWRITE_READ_32 logic.
801 cmd
->t_task_lba
= transport_lba_64_ext(cdb
);
802 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
805 * Setup BIDI XOR callback to be run during after I/O
808 cmd
->execute_rw
= ops
->execute_rw
;
809 cmd
->execute_cmd
= sbc_execute_rw
;
810 cmd
->transport_complete_callback
= &xdreadwrite_callback
;
812 cmd
->se_cmd_flags
|= SCF_FUA
;
815 sectors
= transport_get_sectors_32(cdb
);
817 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
819 return TCM_INVALID_CDB_FIELD
;
822 size
= sbc_get_size(cmd
, 1);
823 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[12]);
825 ret
= sbc_setup_write_same(cmd
, &cdb
[10], ops
);
830 pr_err("VARIABLE_LENGTH_CMD service action"
831 " 0x%04x not supported\n", service_action
);
832 return TCM_UNSUPPORTED_SCSI_OPCODE
;
836 case COMPARE_AND_WRITE
:
839 * Currently enforce COMPARE_AND_WRITE for a single sector
842 pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
843 " than 1\n", sectors
);
844 return TCM_INVALID_CDB_FIELD
;
847 * Double size because we have two buffers, note that
848 * zero is not an error..
850 size
= 2 * sbc_get_size(cmd
, sectors
);
851 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[2]);
852 cmd
->t_task_nolb
= sectors
;
853 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
| SCF_COMPARE_AND_WRITE
;
854 cmd
->execute_rw
= ops
->execute_rw
;
855 cmd
->execute_cmd
= sbc_compare_and_write
;
856 cmd
->transport_complete_callback
= compare_and_write_callback
;
860 cmd
->execute_cmd
= sbc_emulate_readcapacity
;
862 case SERVICE_ACTION_IN
:
863 switch (cmd
->t_task_cdb
[1] & 0x1f) {
864 case SAI_READ_CAPACITY_16
:
865 cmd
->execute_cmd
= sbc_emulate_readcapacity_16
;
867 case SAI_REPORT_REFERRALS
:
868 cmd
->execute_cmd
= target_emulate_report_referrals
;
871 pr_err("Unsupported SA: 0x%02x\n",
872 cmd
->t_task_cdb
[1] & 0x1f);
873 return TCM_INVALID_CDB_FIELD
;
875 size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
876 (cdb
[12] << 8) | cdb
[13];
878 case SYNCHRONIZE_CACHE
:
879 case SYNCHRONIZE_CACHE_16
:
880 if (!ops
->execute_sync_cache
) {
882 cmd
->execute_cmd
= sbc_emulate_noop
;
887 * Extract LBA and range to be flushed for emulated SYNCHRONIZE_CACHE
889 if (cdb
[0] == SYNCHRONIZE_CACHE
) {
890 sectors
= transport_get_sectors_10(cdb
);
891 cmd
->t_task_lba
= transport_lba_32(cdb
);
893 sectors
= transport_get_sectors_16(cdb
);
894 cmd
->t_task_lba
= transport_lba_64(cdb
);
897 size
= sbc_get_size(cmd
, sectors
);
900 * Check to ensure that LBA + Range does not exceed past end of
901 * device for IBLOCK and FILEIO ->do_sync_cache() backend calls
903 if (cmd
->t_task_lba
|| sectors
) {
904 if (sbc_check_valid_sectors(cmd
) < 0)
905 return TCM_ADDRESS_OUT_OF_RANGE
;
907 cmd
->execute_cmd
= ops
->execute_sync_cache
;
910 if (!ops
->execute_unmap
)
911 return TCM_UNSUPPORTED_SCSI_OPCODE
;
913 size
= get_unaligned_be16(&cdb
[7]);
914 cmd
->execute_cmd
= ops
->execute_unmap
;
917 sectors
= transport_get_sectors_16(cdb
);
919 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
920 return TCM_INVALID_CDB_FIELD
;
923 size
= sbc_get_size(cmd
, 1);
924 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[2]);
926 ret
= sbc_setup_write_same(cmd
, &cdb
[1], ops
);
931 sectors
= transport_get_sectors_10(cdb
);
933 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
934 return TCM_INVALID_CDB_FIELD
;
937 size
= sbc_get_size(cmd
, 1);
938 cmd
->t_task_lba
= get_unaligned_be32(&cdb
[2]);
941 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
942 * of byte 1 bit 3 UNMAP instead of original reserved field
944 ret
= sbc_setup_write_same(cmd
, &cdb
[1], ops
);
950 cmd
->execute_cmd
= sbc_emulate_noop
;
956 * There are still clients out there which use these old SCSI-2
957 * commands. This mainly happens when running VMs with legacy
958 * guest systems, connected via SCSI command pass-through to
959 * iSCSI targets. Make them happy and return status GOOD.
962 cmd
->execute_cmd
= sbc_emulate_noop
;
965 ret
= spc_parse_cdb(cmd
, &size
);
970 /* reject any command that we don't have a handler for */
971 if (!(cmd
->se_cmd_flags
& SCF_SCSI_DATA_CDB
) && !cmd
->execute_cmd
)
972 return TCM_UNSUPPORTED_SCSI_OPCODE
;
974 if (cmd
->se_cmd_flags
& SCF_SCSI_DATA_CDB
) {
975 unsigned long long end_lba
;
977 if (sectors
> dev
->dev_attrib
.fabric_max_sectors
) {
978 printk_ratelimited(KERN_ERR
"SCSI OP %02xh with too"
979 " big sectors %u exceeds fabric_max_sectors:"
980 " %u\n", cdb
[0], sectors
,
981 dev
->dev_attrib
.fabric_max_sectors
);
982 return TCM_INVALID_CDB_FIELD
;
984 if (sectors
> dev
->dev_attrib
.hw_max_sectors
) {
985 printk_ratelimited(KERN_ERR
"SCSI OP %02xh with too"
986 " big sectors %u exceeds backend hw_max_sectors:"
987 " %u\n", cdb
[0], sectors
,
988 dev
->dev_attrib
.hw_max_sectors
);
989 return TCM_INVALID_CDB_FIELD
;
992 end_lba
= dev
->transport
->get_blocks(dev
) + 1;
993 if (cmd
->t_task_lba
+ sectors
> end_lba
) {
994 pr_err("cmd exceeds last lba %llu "
995 "(lba %llu, sectors %u)\n",
996 end_lba
, cmd
->t_task_lba
, sectors
);
997 return TCM_ADDRESS_OUT_OF_RANGE
;
1000 if (!(cmd
->se_cmd_flags
& SCF_COMPARE_AND_WRITE
))
1001 size
= sbc_get_size(cmd
, sectors
);
1004 return target_cmd_size_check(cmd
, size
);
1006 EXPORT_SYMBOL(sbc_parse_cdb
);
1008 u32
sbc_get_device_type(struct se_device
*dev
)
1012 EXPORT_SYMBOL(sbc_get_device_type
);
1015 sbc_execute_unmap(struct se_cmd
*cmd
,
1016 sense_reason_t (*do_unmap_fn
)(struct se_cmd
*, void *,
1017 sector_t
, sector_t
),
1020 struct se_device
*dev
= cmd
->se_dev
;
1021 unsigned char *buf
, *ptr
= NULL
;
1025 sense_reason_t ret
= 0;
1028 /* We never set ANC_SUP */
1029 if (cmd
->t_task_cdb
[1])
1030 return TCM_INVALID_CDB_FIELD
;
1032 if (cmd
->data_length
== 0) {
1033 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
1037 if (cmd
->data_length
< 8) {
1038 pr_warn("UNMAP parameter list length %u too small\n",
1040 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1043 buf
= transport_kmap_data_sg(cmd
);
1045 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1047 dl
= get_unaligned_be16(&buf
[0]);
1048 bd_dl
= get_unaligned_be16(&buf
[2]);
1050 size
= cmd
->data_length
- 8;
1052 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
1053 cmd
->data_length
, bd_dl
);
1057 if (size
/ 16 > dev
->dev_attrib
.max_unmap_block_desc_count
) {
1058 ret
= TCM_INVALID_PARAMETER_LIST
;
1062 /* First UNMAP block descriptor starts at 8 byte offset */
1064 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1065 " ptr: %p\n", dev
->transport
->name
, dl
, bd_dl
, size
, ptr
);
1067 while (size
>= 16) {
1068 lba
= get_unaligned_be64(&ptr
[0]);
1069 range
= get_unaligned_be32(&ptr
[8]);
1070 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1071 (unsigned long long)lba
, range
);
1073 if (range
> dev
->dev_attrib
.max_unmap_lba_count
) {
1074 ret
= TCM_INVALID_PARAMETER_LIST
;
1078 if (lba
+ range
> dev
->transport
->get_blocks(dev
) + 1) {
1079 ret
= TCM_ADDRESS_OUT_OF_RANGE
;
1083 ret
= do_unmap_fn(cmd
, priv
, lba
, range
);
1092 transport_kunmap_data_sg(cmd
);
1094 target_complete_cmd(cmd
, GOOD
);
1097 EXPORT_SYMBOL(sbc_execute_unmap
);
1100 sbc_dif_generate(struct se_cmd
*cmd
)
1102 struct se_device
*dev
= cmd
->se_dev
;
1103 struct se_dif_v1_tuple
*sdt
;
1104 struct scatterlist
*dsg
, *psg
= cmd
->t_prot_sg
;
1105 sector_t sector
= cmd
->t_task_lba
;
1106 void *daddr
, *paddr
;
1107 int i
, j
, offset
= 0;
1109 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1110 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1111 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1113 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1115 if (offset
>= psg
->length
) {
1116 kunmap_atomic(paddr
);
1118 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1122 sdt
= paddr
+ offset
;
1123 sdt
->guard_tag
= cpu_to_be16(crc_t10dif(daddr
+ j
,
1124 dev
->dev_attrib
.block_size
));
1125 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
)
1126 sdt
->ref_tag
= cpu_to_be32(sector
& 0xffffffff);
1129 pr_debug("DIF WRITE INSERT sector: %llu guard_tag: 0x%04x"
1130 " app_tag: 0x%04x ref_tag: %u\n",
1131 (unsigned long long)sector
, sdt
->guard_tag
,
1132 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1135 offset
+= sizeof(struct se_dif_v1_tuple
);
1138 kunmap_atomic(paddr
);
1139 kunmap_atomic(daddr
);
1143 static sense_reason_t
1144 sbc_dif_v1_verify(struct se_device
*dev
, struct se_dif_v1_tuple
*sdt
,
1145 const void *p
, sector_t sector
, unsigned int ei_lba
)
1147 int block_size
= dev
->dev_attrib
.block_size
;
1150 csum
= cpu_to_be16(crc_t10dif(p
, block_size
));
1152 if (sdt
->guard_tag
!= csum
) {
1153 pr_err("DIFv1 checksum failed on sector %llu guard tag 0x%04x"
1154 " csum 0x%04x\n", (unsigned long long)sector
,
1155 be16_to_cpu(sdt
->guard_tag
), be16_to_cpu(csum
));
1156 return TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED
;
1159 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
&&
1160 be32_to_cpu(sdt
->ref_tag
) != (sector
& 0xffffffff)) {
1161 pr_err("DIFv1 Type 1 reference failed on sector: %llu tag: 0x%08x"
1162 " sector MSB: 0x%08x\n", (unsigned long long)sector
,
1163 be32_to_cpu(sdt
->ref_tag
), (u32
)(sector
& 0xffffffff));
1164 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED
;
1167 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE2_PROT
&&
1168 be32_to_cpu(sdt
->ref_tag
) != ei_lba
) {
1169 pr_err("DIFv1 Type 2 reference failed on sector: %llu tag: 0x%08x"
1170 " ei_lba: 0x%08x\n", (unsigned long long)sector
,
1171 be32_to_cpu(sdt
->ref_tag
), ei_lba
);
1172 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED
;
1179 sbc_dif_copy_prot(struct se_cmd
*cmd
, unsigned int sectors
, bool read
,
1180 struct scatterlist
*sg
, int sg_off
)
1182 struct se_device
*dev
= cmd
->se_dev
;
1183 struct scatterlist
*psg
;
1185 unsigned int i
, len
, left
;
1186 unsigned int offset
= sg_off
;
1188 left
= sectors
* dev
->prot_length
;
1190 for_each_sg(cmd
->t_prot_sg
, psg
, cmd
->t_prot_nents
, i
) {
1191 unsigned int psg_len
, copied
= 0;
1193 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1194 psg_len
= min(left
, psg
->length
);
1196 len
= min(psg_len
, sg
->length
- offset
);
1197 addr
= kmap_atomic(sg_page(sg
)) + sg
->offset
+ offset
;
1200 memcpy(paddr
+ copied
, addr
, len
);
1202 memcpy(addr
, paddr
+ copied
, len
);
1209 if (offset
>= sg
->length
) {
1213 kunmap_atomic(addr
);
1215 kunmap_atomic(paddr
);
1220 sbc_dif_verify_write(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1221 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1223 struct se_device
*dev
= cmd
->se_dev
;
1224 struct se_dif_v1_tuple
*sdt
;
1225 struct scatterlist
*dsg
, *psg
= cmd
->t_prot_sg
;
1226 sector_t sector
= start
;
1227 void *daddr
, *paddr
;
1228 int i
, j
, offset
= 0;
1231 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1232 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1233 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1235 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1237 if (offset
>= psg
->length
) {
1238 kunmap_atomic(paddr
);
1240 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1244 sdt
= paddr
+ offset
;
1246 pr_debug("DIF WRITE sector: %llu guard_tag: 0x%04x"
1247 " app_tag: 0x%04x ref_tag: %u\n",
1248 (unsigned long long)sector
, sdt
->guard_tag
,
1249 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1251 rc
= sbc_dif_v1_verify(dev
, sdt
, daddr
+ j
, sector
,
1254 kunmap_atomic(paddr
);
1255 kunmap_atomic(daddr
);
1256 cmd
->bad_sector
= sector
;
1262 offset
+= sizeof(struct se_dif_v1_tuple
);
1265 kunmap_atomic(paddr
);
1266 kunmap_atomic(daddr
);
1268 sbc_dif_copy_prot(cmd
, sectors
, false, sg
, sg_off
);
1272 EXPORT_SYMBOL(sbc_dif_verify_write
);
1274 static sense_reason_t
1275 __sbc_dif_verify_read(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1276 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1278 struct se_device
*dev
= cmd
->se_dev
;
1279 struct se_dif_v1_tuple
*sdt
;
1280 struct scatterlist
*dsg
, *psg
= sg
;
1281 sector_t sector
= start
;
1282 void *daddr
, *paddr
;
1283 int i
, j
, offset
= sg_off
;
1286 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1287 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1288 paddr
= kmap_atomic(sg_page(psg
)) + sg
->offset
;
1290 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1292 if (offset
>= psg
->length
) {
1293 kunmap_atomic(paddr
);
1295 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1299 sdt
= paddr
+ offset
;
1301 pr_debug("DIF READ sector: %llu guard_tag: 0x%04x"
1302 " app_tag: 0x%04x ref_tag: %u\n",
1303 (unsigned long long)sector
, sdt
->guard_tag
,
1304 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1306 if (sdt
->app_tag
== cpu_to_be16(0xffff)) {
1308 offset
+= sizeof(struct se_dif_v1_tuple
);
1312 rc
= sbc_dif_v1_verify(dev
, sdt
, daddr
+ j
, sector
,
1315 kunmap_atomic(paddr
);
1316 kunmap_atomic(daddr
);
1317 cmd
->bad_sector
= sector
;
1323 offset
+= sizeof(struct se_dif_v1_tuple
);
1326 kunmap_atomic(paddr
);
1327 kunmap_atomic(daddr
);
1334 sbc_dif_read_strip(struct se_cmd
*cmd
)
1336 struct se_device
*dev
= cmd
->se_dev
;
1337 u32 sectors
= cmd
->prot_length
/ dev
->prot_length
;
1339 return __sbc_dif_verify_read(cmd
, cmd
->t_task_lba
, sectors
, 0,
1344 sbc_dif_verify_read(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1345 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1349 rc
= __sbc_dif_verify_read(cmd
, start
, sectors
, ei_lba
, sg
, sg_off
);
1353 sbc_dif_copy_prot(cmd
, sectors
, true, sg
, sg_off
);
1356 EXPORT_SYMBOL(sbc_dif_verify_read
);