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_check_prot(struct se_device
*, struct se_cmd
*, unsigned char *, u32
, bool);
43 sbc_emulate_readcapacity(struct se_cmd
*cmd
)
45 struct se_device
*dev
= cmd
->se_dev
;
46 unsigned char *cdb
= cmd
->t_task_cdb
;
47 unsigned long long blocks_long
= dev
->transport
->get_blocks(dev
);
54 * If the PMI bit is set to zero and the LOGICAL BLOCK
55 * ADDRESS field is not set to zero, the device server shall
56 * terminate the command with CHECK CONDITION status with
57 * the sense key set to ILLEGAL REQUEST and the additional
58 * sense code set to INVALID FIELD IN CDB.
60 * In SBC-3, these fields are obsolete, but some SCSI
61 * compliance tests actually check this, so we might as well
64 if (!(cdb
[8] & 1) && !!(cdb
[2] | cdb
[3] | cdb
[4] | cdb
[5]))
65 return TCM_INVALID_CDB_FIELD
;
67 if (blocks_long
>= 0x00000000ffffffff)
70 blocks
= (u32
)blocks_long
;
72 buf
[0] = (blocks
>> 24) & 0xff;
73 buf
[1] = (blocks
>> 16) & 0xff;
74 buf
[2] = (blocks
>> 8) & 0xff;
75 buf
[3] = blocks
& 0xff;
76 buf
[4] = (dev
->dev_attrib
.block_size
>> 24) & 0xff;
77 buf
[5] = (dev
->dev_attrib
.block_size
>> 16) & 0xff;
78 buf
[6] = (dev
->dev_attrib
.block_size
>> 8) & 0xff;
79 buf
[7] = dev
->dev_attrib
.block_size
& 0xff;
81 rbuf
= transport_kmap_data_sg(cmd
);
83 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
84 transport_kunmap_data_sg(cmd
);
87 target_complete_cmd_with_length(cmd
, GOOD
, 8);
92 sbc_emulate_readcapacity_16(struct se_cmd
*cmd
)
94 struct se_device
*dev
= cmd
->se_dev
;
95 struct se_session
*sess
= cmd
->se_sess
;
97 unsigned char buf
[32];
98 unsigned long long blocks
= dev
->transport
->get_blocks(dev
);
100 memset(buf
, 0, sizeof(buf
));
101 buf
[0] = (blocks
>> 56) & 0xff;
102 buf
[1] = (blocks
>> 48) & 0xff;
103 buf
[2] = (blocks
>> 40) & 0xff;
104 buf
[3] = (blocks
>> 32) & 0xff;
105 buf
[4] = (blocks
>> 24) & 0xff;
106 buf
[5] = (blocks
>> 16) & 0xff;
107 buf
[6] = (blocks
>> 8) & 0xff;
108 buf
[7] = blocks
& 0xff;
109 buf
[8] = (dev
->dev_attrib
.block_size
>> 24) & 0xff;
110 buf
[9] = (dev
->dev_attrib
.block_size
>> 16) & 0xff;
111 buf
[10] = (dev
->dev_attrib
.block_size
>> 8) & 0xff;
112 buf
[11] = dev
->dev_attrib
.block_size
& 0xff;
114 * Set P_TYPE and PROT_EN bits for DIF support
116 if (sess
->sup_prot_ops
& (TARGET_PROT_DIN_PASS
| TARGET_PROT_DOUT_PASS
)) {
117 if (dev
->dev_attrib
.pi_prot_type
)
118 buf
[12] = (dev
->dev_attrib
.pi_prot_type
- 1) << 1 | 0x1;
121 if (dev
->transport
->get_lbppbe
)
122 buf
[13] = dev
->transport
->get_lbppbe(dev
) & 0x0f;
124 if (dev
->transport
->get_alignment_offset_lbas
) {
125 u16 lalba
= dev
->transport
->get_alignment_offset_lbas(dev
);
126 buf
[14] = (lalba
>> 8) & 0x3f;
127 buf
[15] = lalba
& 0xff;
131 * Set Thin Provisioning Enable bit following sbc3r22 in section
132 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
134 if (dev
->dev_attrib
.emulate_tpu
|| dev
->dev_attrib
.emulate_tpws
)
137 rbuf
= transport_kmap_data_sg(cmd
);
139 memcpy(rbuf
, buf
, min_t(u32
, sizeof(buf
), cmd
->data_length
));
140 transport_kunmap_data_sg(cmd
);
143 target_complete_cmd_with_length(cmd
, GOOD
, 32);
147 sector_t
sbc_get_write_same_sectors(struct se_cmd
*cmd
)
151 if (cmd
->t_task_cdb
[0] == WRITE_SAME
)
152 num_blocks
= get_unaligned_be16(&cmd
->t_task_cdb
[7]);
153 else if (cmd
->t_task_cdb
[0] == WRITE_SAME_16
)
154 num_blocks
= get_unaligned_be32(&cmd
->t_task_cdb
[10]);
155 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
156 num_blocks
= get_unaligned_be32(&cmd
->t_task_cdb
[28]);
159 * Use the explicit range when non zero is supplied, otherwise calculate
160 * the remaining range based on ->get_blocks() - starting LBA.
165 return cmd
->se_dev
->transport
->get_blocks(cmd
->se_dev
) -
168 EXPORT_SYMBOL(sbc_get_write_same_sectors
);
170 static sense_reason_t
171 sbc_emulate_noop(struct se_cmd
*cmd
)
173 target_complete_cmd(cmd
, GOOD
);
177 static inline u32
sbc_get_size(struct se_cmd
*cmd
, u32 sectors
)
179 return cmd
->se_dev
->dev_attrib
.block_size
* sectors
;
182 static inline u32
transport_get_sectors_6(unsigned char *cdb
)
185 * Use 8-bit sector value. SBC-3 says:
187 * A TRANSFER LENGTH field set to zero specifies that 256
188 * logical blocks shall be written. Any other value
189 * specifies the number of logical blocks that shall be
192 return cdb
[4] ? : 256;
195 static inline u32
transport_get_sectors_10(unsigned char *cdb
)
197 return (u32
)(cdb
[7] << 8) + cdb
[8];
200 static inline u32
transport_get_sectors_12(unsigned char *cdb
)
202 return (u32
)(cdb
[6] << 24) + (cdb
[7] << 16) + (cdb
[8] << 8) + cdb
[9];
205 static inline u32
transport_get_sectors_16(unsigned char *cdb
)
207 return (u32
)(cdb
[10] << 24) + (cdb
[11] << 16) +
208 (cdb
[12] << 8) + cdb
[13];
212 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
214 static inline u32
transport_get_sectors_32(unsigned char *cdb
)
216 return (u32
)(cdb
[28] << 24) + (cdb
[29] << 16) +
217 (cdb
[30] << 8) + cdb
[31];
221 static inline u32
transport_lba_21(unsigned char *cdb
)
223 return ((cdb
[1] & 0x1f) << 16) | (cdb
[2] << 8) | cdb
[3];
226 static inline u32
transport_lba_32(unsigned char *cdb
)
228 return (cdb
[2] << 24) | (cdb
[3] << 16) | (cdb
[4] << 8) | cdb
[5];
231 static inline unsigned long long transport_lba_64(unsigned char *cdb
)
233 unsigned int __v1
, __v2
;
235 __v1
= (cdb
[2] << 24) | (cdb
[3] << 16) | (cdb
[4] << 8) | cdb
[5];
236 __v2
= (cdb
[6] << 24) | (cdb
[7] << 16) | (cdb
[8] << 8) | cdb
[9];
238 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
242 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
244 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb
)
246 unsigned int __v1
, __v2
;
248 __v1
= (cdb
[12] << 24) | (cdb
[13] << 16) | (cdb
[14] << 8) | cdb
[15];
249 __v2
= (cdb
[16] << 24) | (cdb
[17] << 16) | (cdb
[18] << 8) | cdb
[19];
251 return ((unsigned long long)__v2
) | (unsigned long long)__v1
<< 32;
254 static sense_reason_t
255 sbc_setup_write_same(struct se_cmd
*cmd
, unsigned char *flags
, struct sbc_ops
*ops
)
257 struct se_device
*dev
= cmd
->se_dev
;
258 sector_t end_lba
= dev
->transport
->get_blocks(dev
) + 1;
259 unsigned int sectors
= sbc_get_write_same_sectors(cmd
);
262 if ((flags
[0] & 0x04) || (flags
[0] & 0x02)) {
263 pr_err("WRITE_SAME PBDATA and LBDATA"
264 " bits not supported for Block Discard"
266 return TCM_UNSUPPORTED_SCSI_OPCODE
;
268 if (sectors
> cmd
->se_dev
->dev_attrib
.max_write_same_len
) {
269 pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
270 sectors
, cmd
->se_dev
->dev_attrib
.max_write_same_len
);
271 return TCM_INVALID_CDB_FIELD
;
274 * Sanity check for LBA wrap and request past end of device.
276 if (((cmd
->t_task_lba
+ sectors
) < cmd
->t_task_lba
) ||
277 ((cmd
->t_task_lba
+ sectors
) > end_lba
)) {
278 pr_err("WRITE_SAME exceeds last lba %llu (lba %llu, sectors %u)\n",
279 (unsigned long long)end_lba
, cmd
->t_task_lba
, sectors
);
280 return TCM_ADDRESS_OUT_OF_RANGE
;
283 /* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
284 if (flags
[0] & 0x10) {
285 pr_warn("WRITE SAME with ANCHOR not supported\n");
286 return TCM_INVALID_CDB_FIELD
;
289 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
290 * translated into block discard requests within backend code.
292 if (flags
[0] & 0x08) {
293 if (!ops
->execute_write_same_unmap
)
294 return TCM_UNSUPPORTED_SCSI_OPCODE
;
296 if (!dev
->dev_attrib
.emulate_tpws
) {
297 pr_err("Got WRITE_SAME w/ UNMAP=1, but backend device"
298 " has emulate_tpws disabled\n");
299 return TCM_UNSUPPORTED_SCSI_OPCODE
;
301 cmd
->execute_cmd
= ops
->execute_write_same_unmap
;
304 if (!ops
->execute_write_same
)
305 return TCM_UNSUPPORTED_SCSI_OPCODE
;
307 ret
= sbc_check_prot(dev
, cmd
, &cmd
->t_task_cdb
[0], sectors
, true);
311 cmd
->execute_cmd
= ops
->execute_write_same
;
315 static sense_reason_t
xdreadwrite_callback(struct se_cmd
*cmd
)
317 unsigned char *buf
, *addr
;
318 struct scatterlist
*sg
;
320 sense_reason_t ret
= TCM_NO_SENSE
;
323 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
325 * 1) read the specified logical block(s);
326 * 2) transfer logical blocks from the data-out buffer;
327 * 3) XOR the logical blocks transferred from the data-out buffer with
328 * the logical blocks read, storing the resulting XOR data in a buffer;
329 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
330 * blocks transferred from the data-out buffer; and
331 * 5) transfer the resulting XOR data to the data-in buffer.
333 buf
= kmalloc(cmd
->data_length
, GFP_KERNEL
);
335 pr_err("Unable to allocate xor_callback buf\n");
336 return TCM_OUT_OF_RESOURCES
;
339 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
340 * into the locally allocated *buf
342 sg_copy_to_buffer(cmd
->t_data_sg
,
348 * Now perform the XOR against the BIDI read memory located at
349 * cmd->t_mem_bidi_list
353 for_each_sg(cmd
->t_bidi_data_sg
, sg
, cmd
->t_bidi_data_nents
, count
) {
354 addr
= kmap_atomic(sg_page(sg
));
356 ret
= TCM_OUT_OF_RESOURCES
;
360 for (i
= 0; i
< sg
->length
; i
++)
361 *(addr
+ sg
->offset
+ i
) ^= *(buf
+ offset
+ i
);
363 offset
+= sg
->length
;
372 static sense_reason_t
373 sbc_execute_rw(struct se_cmd
*cmd
)
375 return cmd
->execute_rw(cmd
, cmd
->t_data_sg
, cmd
->t_data_nents
,
376 cmd
->data_direction
);
379 static sense_reason_t
compare_and_write_post(struct se_cmd
*cmd
)
381 struct se_device
*dev
= cmd
->se_dev
;
384 * Only set SCF_COMPARE_AND_WRITE_POST to force a response fall-through
385 * within target_complete_ok_work() if the command was successfully
386 * sent to the backend driver.
388 spin_lock_irq(&cmd
->t_state_lock
);
389 if ((cmd
->transport_state
& CMD_T_SENT
) && !cmd
->scsi_status
)
390 cmd
->se_cmd_flags
|= SCF_COMPARE_AND_WRITE_POST
;
391 spin_unlock_irq(&cmd
->t_state_lock
);
394 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
395 * before the original READ I/O submission.
402 static sense_reason_t
compare_and_write_callback(struct se_cmd
*cmd
)
404 struct se_device
*dev
= cmd
->se_dev
;
405 struct scatterlist
*write_sg
= NULL
, *sg
;
406 unsigned char *buf
= NULL
, *addr
;
407 struct sg_mapping_iter m
;
408 unsigned int offset
= 0, len
;
409 unsigned int nlbas
= cmd
->t_task_nolb
;
410 unsigned int block_size
= dev
->dev_attrib
.block_size
;
411 unsigned int compare_len
= (nlbas
* block_size
);
412 sense_reason_t ret
= TCM_NO_SENSE
;
416 * Handle early failure in transport_generic_request_failure(),
417 * which will not have taken ->caw_mutex yet..
419 if (!cmd
->t_data_sg
|| !cmd
->t_bidi_data_sg
)
422 * Immediately exit + release dev->caw_sem if command has already
423 * been failed with a non-zero SCSI status.
425 if (cmd
->scsi_status
) {
426 pr_err("compare_and_write_callback: non zero scsi_status:"
427 " 0x%02x\n", cmd
->scsi_status
);
431 buf
= kzalloc(cmd
->data_length
, GFP_KERNEL
);
433 pr_err("Unable to allocate compare_and_write buf\n");
434 ret
= TCM_OUT_OF_RESOURCES
;
438 write_sg
= kmalloc(sizeof(struct scatterlist
) * cmd
->t_data_nents
,
441 pr_err("Unable to allocate compare_and_write sg\n");
442 ret
= TCM_OUT_OF_RESOURCES
;
445 sg_init_table(write_sg
, cmd
->t_data_nents
);
447 * Setup verify and write data payloads from total NumberLBAs.
449 rc
= sg_copy_to_buffer(cmd
->t_data_sg
, cmd
->t_data_nents
, buf
,
452 pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
453 ret
= TCM_OUT_OF_RESOURCES
;
457 * Compare against SCSI READ payload against verify payload
459 for_each_sg(cmd
->t_bidi_data_sg
, sg
, cmd
->t_bidi_data_nents
, i
) {
460 addr
= (unsigned char *)kmap_atomic(sg_page(sg
));
462 ret
= TCM_OUT_OF_RESOURCES
;
466 len
= min(sg
->length
, compare_len
);
468 if (memcmp(addr
, buf
+ offset
, len
)) {
469 pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
483 len
= cmd
->t_task_nolb
* block_size
;
484 sg_miter_start(&m
, cmd
->t_data_sg
, cmd
->t_data_nents
, SG_MITER_TO_SG
);
486 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
491 if (block_size
< PAGE_SIZE
) {
492 sg_set_page(&write_sg
[i
], m
.page
, block_size
,
496 sg_set_page(&write_sg
[i
], m
.page
, block_size
,
504 * Save the original SGL + nents values before updating to new
505 * assignments, to be released in transport_free_pages() ->
506 * transport_reset_sgl_orig()
508 cmd
->t_data_sg_orig
= cmd
->t_data_sg
;
509 cmd
->t_data_sg
= write_sg
;
510 cmd
->t_data_nents_orig
= cmd
->t_data_nents
;
511 cmd
->t_data_nents
= 1;
513 cmd
->sam_task_attr
= TCM_HEAD_TAG
;
514 cmd
->transport_complete_callback
= compare_and_write_post
;
516 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
517 * for submitting the adjusted SGL to write instance user-data.
519 cmd
->execute_cmd
= sbc_execute_rw
;
521 spin_lock_irq(&cmd
->t_state_lock
);
522 cmd
->t_state
= TRANSPORT_PROCESSING
;
523 cmd
->transport_state
|= CMD_T_ACTIVE
|CMD_T_BUSY
|CMD_T_SENT
;
524 spin_unlock_irq(&cmd
->t_state_lock
);
526 __target_execute_cmd(cmd
);
532 pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
533 dev
->transport
->name
);
534 ret
= TCM_MISCOMPARE_VERIFY
;
537 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
538 * sbc_compare_and_write() before the original READ I/O submission.
546 static sense_reason_t
547 sbc_compare_and_write(struct se_cmd
*cmd
)
549 struct se_device
*dev
= cmd
->se_dev
;
553 * Submit the READ first for COMPARE_AND_WRITE to perform the
554 * comparision using SGLs at cmd->t_bidi_data_sg..
556 rc
= down_interruptible(&dev
->caw_sem
);
557 if ((rc
!= 0) || signal_pending(current
)) {
558 cmd
->transport_complete_callback
= NULL
;
559 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
562 * Reset cmd->data_length to individual block_size in order to not
563 * confuse backend drivers that depend on this value matching the
564 * size of the I/O being submitted.
566 cmd
->data_length
= cmd
->t_task_nolb
* dev
->dev_attrib
.block_size
;
568 ret
= cmd
->execute_rw(cmd
, cmd
->t_bidi_data_sg
, cmd
->t_bidi_data_nents
,
571 cmd
->transport_complete_callback
= NULL
;
576 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
577 * upon MISCOMPARE, or in compare_and_write_done() upon completion
578 * of WRITE instance user-data.
584 sbc_set_prot_op_checks(u8 protect
, enum target_prot_type prot_type
,
585 bool is_write
, struct se_cmd
*cmd
)
588 cmd
->prot_op
= protect
? TARGET_PROT_DOUT_PASS
:
589 TARGET_PROT_DOUT_INSERT
;
593 cmd
->prot_checks
= 0;
597 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
598 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
599 cmd
->prot_checks
|= TARGET_DIF_CHECK_REFTAG
;
602 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
603 cmd
->prot_checks
= TARGET_DIF_CHECK_REFTAG
;
606 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
609 pr_err("Unsupported protect field %d\n", protect
);
613 cmd
->prot_op
= protect
? TARGET_PROT_DIN_PASS
:
614 TARGET_PROT_DIN_STRIP
;
619 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
620 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
621 cmd
->prot_checks
|= TARGET_DIF_CHECK_REFTAG
;
624 if (prot_type
== TARGET_DIF_TYPE1_PROT
)
625 cmd
->prot_checks
= TARGET_DIF_CHECK_REFTAG
;
628 cmd
->prot_checks
= 0;
631 cmd
->prot_checks
= TARGET_DIF_CHECK_GUARD
;
634 pr_err("Unsupported protect field %d\n", protect
);
642 static sense_reason_t
643 sbc_check_prot(struct se_device
*dev
, struct se_cmd
*cmd
, unsigned char *cdb
,
644 u32 sectors
, bool is_write
)
646 u8 protect
= cdb
[1] >> 5;
648 if (!cmd
->t_prot_sg
|| !cmd
->t_prot_nents
) {
649 if (protect
&& !dev
->dev_attrib
.pi_prot_type
) {
650 pr_err("CDB contains protect bit, but device does not"
651 " advertise PROTECT=1 feature bit\n");
652 return TCM_INVALID_CDB_FIELD
;
658 switch (dev
->dev_attrib
.pi_prot_type
) {
659 case TARGET_DIF_TYPE3_PROT
:
660 cmd
->reftag_seed
= 0xffffffff;
662 case TARGET_DIF_TYPE2_PROT
:
664 return TCM_INVALID_CDB_FIELD
;
666 cmd
->reftag_seed
= cmd
->t_task_lba
;
668 case TARGET_DIF_TYPE1_PROT
:
669 cmd
->reftag_seed
= cmd
->t_task_lba
;
671 case TARGET_DIF_TYPE0_PROT
:
676 if (sbc_set_prot_op_checks(protect
, dev
->dev_attrib
.pi_prot_type
,
678 return TCM_INVALID_CDB_FIELD
;
680 cmd
->prot_type
= dev
->dev_attrib
.pi_prot_type
;
681 cmd
->prot_length
= dev
->prot_length
* sectors
;
684 * In case protection information exists over the wire
685 * we modify command data length to describe pure data.
686 * The actual transfer length is data length + protection
690 cmd
->data_length
= sectors
* dev
->dev_attrib
.block_size
;
692 pr_debug("%s: prot_type=%d, data_length=%d, prot_length=%d "
693 "prot_op=%d prot_checks=%d\n",
694 __func__
, cmd
->prot_type
, cmd
->data_length
, cmd
->prot_length
,
695 cmd
->prot_op
, cmd
->prot_checks
);
701 sbc_check_dpofua(struct se_device
*dev
, struct se_cmd
*cmd
, unsigned char *cdb
)
704 if (!dev
->dev_attrib
.emulate_dpo
) {
705 pr_err("Got CDB: 0x%02x with DPO bit set, but device"
706 " does not advertise support for DPO\n", cdb
[0]);
711 if (!dev
->dev_attrib
.emulate_fua_write
||
712 !dev
->dev_attrib
.emulate_write_cache
) {
713 pr_err("Got CDB: 0x%02x with FUA bit set, but device"
714 " does not advertise support for FUA write\n",
718 cmd
->se_cmd_flags
|= SCF_FUA
;
724 sbc_parse_cdb(struct se_cmd
*cmd
, struct sbc_ops
*ops
)
726 struct se_device
*dev
= cmd
->se_dev
;
727 unsigned char *cdb
= cmd
->t_task_cdb
;
734 sectors
= transport_get_sectors_6(cdb
);
735 cmd
->t_task_lba
= transport_lba_21(cdb
);
736 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
737 cmd
->execute_rw
= ops
->execute_rw
;
738 cmd
->execute_cmd
= sbc_execute_rw
;
741 sectors
= transport_get_sectors_10(cdb
);
742 cmd
->t_task_lba
= transport_lba_32(cdb
);
744 if (sbc_check_dpofua(dev
, cmd
, cdb
))
745 return TCM_INVALID_CDB_FIELD
;
747 ret
= sbc_check_prot(dev
, cmd
, cdb
, sectors
, false);
751 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
752 cmd
->execute_rw
= ops
->execute_rw
;
753 cmd
->execute_cmd
= sbc_execute_rw
;
756 sectors
= transport_get_sectors_12(cdb
);
757 cmd
->t_task_lba
= transport_lba_32(cdb
);
759 if (sbc_check_dpofua(dev
, cmd
, cdb
))
760 return TCM_INVALID_CDB_FIELD
;
762 ret
= sbc_check_prot(dev
, cmd
, cdb
, sectors
, false);
766 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
767 cmd
->execute_rw
= ops
->execute_rw
;
768 cmd
->execute_cmd
= sbc_execute_rw
;
771 sectors
= transport_get_sectors_16(cdb
);
772 cmd
->t_task_lba
= transport_lba_64(cdb
);
774 if (sbc_check_dpofua(dev
, cmd
, cdb
))
775 return TCM_INVALID_CDB_FIELD
;
777 ret
= sbc_check_prot(dev
, cmd
, cdb
, sectors
, false);
781 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
782 cmd
->execute_rw
= ops
->execute_rw
;
783 cmd
->execute_cmd
= sbc_execute_rw
;
786 sectors
= transport_get_sectors_6(cdb
);
787 cmd
->t_task_lba
= transport_lba_21(cdb
);
788 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
789 cmd
->execute_rw
= ops
->execute_rw
;
790 cmd
->execute_cmd
= sbc_execute_rw
;
794 sectors
= transport_get_sectors_10(cdb
);
795 cmd
->t_task_lba
= transport_lba_32(cdb
);
797 if (sbc_check_dpofua(dev
, cmd
, cdb
))
798 return TCM_INVALID_CDB_FIELD
;
800 ret
= sbc_check_prot(dev
, cmd
, cdb
, sectors
, true);
804 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
805 cmd
->execute_rw
= ops
->execute_rw
;
806 cmd
->execute_cmd
= sbc_execute_rw
;
809 sectors
= transport_get_sectors_12(cdb
);
810 cmd
->t_task_lba
= transport_lba_32(cdb
);
812 if (sbc_check_dpofua(dev
, cmd
, cdb
))
813 return TCM_INVALID_CDB_FIELD
;
815 ret
= sbc_check_prot(dev
, cmd
, cdb
, sectors
, true);
819 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
820 cmd
->execute_rw
= ops
->execute_rw
;
821 cmd
->execute_cmd
= sbc_execute_rw
;
824 sectors
= transport_get_sectors_16(cdb
);
825 cmd
->t_task_lba
= transport_lba_64(cdb
);
827 if (sbc_check_dpofua(dev
, cmd
, cdb
))
828 return TCM_INVALID_CDB_FIELD
;
830 ret
= sbc_check_prot(dev
, cmd
, cdb
, sectors
, true);
834 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
835 cmd
->execute_rw
= ops
->execute_rw
;
836 cmd
->execute_cmd
= sbc_execute_rw
;
839 if (cmd
->data_direction
!= DMA_TO_DEVICE
||
840 !(cmd
->se_cmd_flags
& SCF_BIDI
))
841 return TCM_INVALID_CDB_FIELD
;
842 sectors
= transport_get_sectors_10(cdb
);
844 if (sbc_check_dpofua(dev
, cmd
, cdb
))
845 return TCM_INVALID_CDB_FIELD
;
847 cmd
->t_task_lba
= transport_lba_32(cdb
);
848 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
851 * Setup BIDI XOR callback to be run after I/O completion.
853 cmd
->execute_rw
= ops
->execute_rw
;
854 cmd
->execute_cmd
= sbc_execute_rw
;
855 cmd
->transport_complete_callback
= &xdreadwrite_callback
;
857 case VARIABLE_LENGTH_CMD
:
859 u16 service_action
= get_unaligned_be16(&cdb
[8]);
860 switch (service_action
) {
862 sectors
= transport_get_sectors_32(cdb
);
864 if (sbc_check_dpofua(dev
, cmd
, cdb
))
865 return TCM_INVALID_CDB_FIELD
;
867 * Use WRITE_32 and READ_32 opcodes for the emulated
868 * XDWRITE_READ_32 logic.
870 cmd
->t_task_lba
= transport_lba_64_ext(cdb
);
871 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
;
874 * Setup BIDI XOR callback to be run during after I/O
877 cmd
->execute_rw
= ops
->execute_rw
;
878 cmd
->execute_cmd
= sbc_execute_rw
;
879 cmd
->transport_complete_callback
= &xdreadwrite_callback
;
882 sectors
= transport_get_sectors_32(cdb
);
884 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
886 return TCM_INVALID_CDB_FIELD
;
889 size
= sbc_get_size(cmd
, 1);
890 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[12]);
892 ret
= sbc_setup_write_same(cmd
, &cdb
[10], ops
);
897 pr_err("VARIABLE_LENGTH_CMD service action"
898 " 0x%04x not supported\n", service_action
);
899 return TCM_UNSUPPORTED_SCSI_OPCODE
;
903 case COMPARE_AND_WRITE
:
906 * Currently enforce COMPARE_AND_WRITE for a single sector
909 pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
910 " than 1\n", sectors
);
911 return TCM_INVALID_CDB_FIELD
;
914 * Double size because we have two buffers, note that
915 * zero is not an error..
917 size
= 2 * sbc_get_size(cmd
, sectors
);
918 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[2]);
919 cmd
->t_task_nolb
= sectors
;
920 cmd
->se_cmd_flags
|= SCF_SCSI_DATA_CDB
| SCF_COMPARE_AND_WRITE
;
921 cmd
->execute_rw
= ops
->execute_rw
;
922 cmd
->execute_cmd
= sbc_compare_and_write
;
923 cmd
->transport_complete_callback
= compare_and_write_callback
;
927 cmd
->execute_cmd
= sbc_emulate_readcapacity
;
929 case SERVICE_ACTION_IN_16
:
930 switch (cmd
->t_task_cdb
[1] & 0x1f) {
931 case SAI_READ_CAPACITY_16
:
932 cmd
->execute_cmd
= sbc_emulate_readcapacity_16
;
934 case SAI_REPORT_REFERRALS
:
935 cmd
->execute_cmd
= target_emulate_report_referrals
;
938 pr_err("Unsupported SA: 0x%02x\n",
939 cmd
->t_task_cdb
[1] & 0x1f);
940 return TCM_INVALID_CDB_FIELD
;
942 size
= (cdb
[10] << 24) | (cdb
[11] << 16) |
943 (cdb
[12] << 8) | cdb
[13];
945 case SYNCHRONIZE_CACHE
:
946 case SYNCHRONIZE_CACHE_16
:
947 if (cdb
[0] == SYNCHRONIZE_CACHE
) {
948 sectors
= transport_get_sectors_10(cdb
);
949 cmd
->t_task_lba
= transport_lba_32(cdb
);
951 sectors
= transport_get_sectors_16(cdb
);
952 cmd
->t_task_lba
= transport_lba_64(cdb
);
954 if (ops
->execute_sync_cache
) {
955 cmd
->execute_cmd
= ops
->execute_sync_cache
;
959 cmd
->execute_cmd
= sbc_emulate_noop
;
962 if (!ops
->execute_unmap
)
963 return TCM_UNSUPPORTED_SCSI_OPCODE
;
965 if (!dev
->dev_attrib
.emulate_tpu
) {
966 pr_err("Got UNMAP, but backend device has"
967 " emulate_tpu disabled\n");
968 return TCM_UNSUPPORTED_SCSI_OPCODE
;
970 size
= get_unaligned_be16(&cdb
[7]);
971 cmd
->execute_cmd
= ops
->execute_unmap
;
974 sectors
= transport_get_sectors_16(cdb
);
976 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
977 return TCM_INVALID_CDB_FIELD
;
980 size
= sbc_get_size(cmd
, 1);
981 cmd
->t_task_lba
= get_unaligned_be64(&cdb
[2]);
983 ret
= sbc_setup_write_same(cmd
, &cdb
[1], ops
);
988 sectors
= transport_get_sectors_10(cdb
);
990 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
991 return TCM_INVALID_CDB_FIELD
;
994 size
= sbc_get_size(cmd
, 1);
995 cmd
->t_task_lba
= get_unaligned_be32(&cdb
[2]);
998 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
999 * of byte 1 bit 3 UNMAP instead of original reserved field
1001 ret
= sbc_setup_write_same(cmd
, &cdb
[1], ops
);
1007 sectors
= transport_get_sectors_10(cdb
);
1008 cmd
->t_task_lba
= transport_lba_32(cdb
);
1009 cmd
->execute_cmd
= sbc_emulate_noop
;
1015 * There are still clients out there which use these old SCSI-2
1016 * commands. This mainly happens when running VMs with legacy
1017 * guest systems, connected via SCSI command pass-through to
1018 * iSCSI targets. Make them happy and return status GOOD.
1021 cmd
->execute_cmd
= sbc_emulate_noop
;
1024 ret
= spc_parse_cdb(cmd
, &size
);
1029 /* reject any command that we don't have a handler for */
1030 if (!cmd
->execute_cmd
)
1031 return TCM_UNSUPPORTED_SCSI_OPCODE
;
1033 if (cmd
->se_cmd_flags
& SCF_SCSI_DATA_CDB
) {
1034 unsigned long long end_lba
;
1036 end_lba
= dev
->transport
->get_blocks(dev
) + 1;
1037 if (((cmd
->t_task_lba
+ sectors
) < cmd
->t_task_lba
) ||
1038 ((cmd
->t_task_lba
+ sectors
) > end_lba
)) {
1039 pr_err("cmd exceeds last lba %llu "
1040 "(lba %llu, sectors %u)\n",
1041 end_lba
, cmd
->t_task_lba
, sectors
);
1042 return TCM_ADDRESS_OUT_OF_RANGE
;
1045 if (!(cmd
->se_cmd_flags
& SCF_COMPARE_AND_WRITE
))
1046 size
= sbc_get_size(cmd
, sectors
);
1049 return target_cmd_size_check(cmd
, size
);
1051 EXPORT_SYMBOL(sbc_parse_cdb
);
1053 u32
sbc_get_device_type(struct se_device
*dev
)
1057 EXPORT_SYMBOL(sbc_get_device_type
);
1060 sbc_execute_unmap(struct se_cmd
*cmd
,
1061 sense_reason_t (*do_unmap_fn
)(struct se_cmd
*, void *,
1062 sector_t
, sector_t
),
1065 struct se_device
*dev
= cmd
->se_dev
;
1066 unsigned char *buf
, *ptr
= NULL
;
1070 sense_reason_t ret
= 0;
1073 /* We never set ANC_SUP */
1074 if (cmd
->t_task_cdb
[1])
1075 return TCM_INVALID_CDB_FIELD
;
1077 if (cmd
->data_length
== 0) {
1078 target_complete_cmd(cmd
, SAM_STAT_GOOD
);
1082 if (cmd
->data_length
< 8) {
1083 pr_warn("UNMAP parameter list length %u too small\n",
1085 return TCM_PARAMETER_LIST_LENGTH_ERROR
;
1088 buf
= transport_kmap_data_sg(cmd
);
1090 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE
;
1092 dl
= get_unaligned_be16(&buf
[0]);
1093 bd_dl
= get_unaligned_be16(&buf
[2]);
1095 size
= cmd
->data_length
- 8;
1097 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
1098 cmd
->data_length
, bd_dl
);
1102 if (size
/ 16 > dev
->dev_attrib
.max_unmap_block_desc_count
) {
1103 ret
= TCM_INVALID_PARAMETER_LIST
;
1107 /* First UNMAP block descriptor starts at 8 byte offset */
1109 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1110 " ptr: %p\n", dev
->transport
->name
, dl
, bd_dl
, size
, ptr
);
1112 while (size
>= 16) {
1113 lba
= get_unaligned_be64(&ptr
[0]);
1114 range
= get_unaligned_be32(&ptr
[8]);
1115 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1116 (unsigned long long)lba
, range
);
1118 if (range
> dev
->dev_attrib
.max_unmap_lba_count
) {
1119 ret
= TCM_INVALID_PARAMETER_LIST
;
1123 if (lba
+ range
> dev
->transport
->get_blocks(dev
) + 1) {
1124 ret
= TCM_ADDRESS_OUT_OF_RANGE
;
1128 ret
= do_unmap_fn(cmd
, priv
, lba
, range
);
1137 transport_kunmap_data_sg(cmd
);
1139 target_complete_cmd(cmd
, GOOD
);
1142 EXPORT_SYMBOL(sbc_execute_unmap
);
1145 sbc_dif_generate(struct se_cmd
*cmd
)
1147 struct se_device
*dev
= cmd
->se_dev
;
1148 struct se_dif_v1_tuple
*sdt
;
1149 struct scatterlist
*dsg
, *psg
= cmd
->t_prot_sg
;
1150 sector_t sector
= cmd
->t_task_lba
;
1151 void *daddr
, *paddr
;
1152 int i
, j
, offset
= 0;
1154 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1155 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1156 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1158 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1160 if (offset
>= psg
->length
) {
1161 kunmap_atomic(paddr
);
1163 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1167 sdt
= paddr
+ offset
;
1168 sdt
->guard_tag
= cpu_to_be16(crc_t10dif(daddr
+ j
,
1169 dev
->dev_attrib
.block_size
));
1170 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
)
1171 sdt
->ref_tag
= cpu_to_be32(sector
& 0xffffffff);
1174 pr_debug("DIF WRITE INSERT sector: %llu guard_tag: 0x%04x"
1175 " app_tag: 0x%04x ref_tag: %u\n",
1176 (unsigned long long)sector
, sdt
->guard_tag
,
1177 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1180 offset
+= sizeof(struct se_dif_v1_tuple
);
1183 kunmap_atomic(paddr
);
1184 kunmap_atomic(daddr
);
1188 static sense_reason_t
1189 sbc_dif_v1_verify(struct se_device
*dev
, struct se_dif_v1_tuple
*sdt
,
1190 const void *p
, sector_t sector
, unsigned int ei_lba
)
1192 int block_size
= dev
->dev_attrib
.block_size
;
1195 csum
= cpu_to_be16(crc_t10dif(p
, block_size
));
1197 if (sdt
->guard_tag
!= csum
) {
1198 pr_err("DIFv1 checksum failed on sector %llu guard tag 0x%04x"
1199 " csum 0x%04x\n", (unsigned long long)sector
,
1200 be16_to_cpu(sdt
->guard_tag
), be16_to_cpu(csum
));
1201 return TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED
;
1204 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE1_PROT
&&
1205 be32_to_cpu(sdt
->ref_tag
) != (sector
& 0xffffffff)) {
1206 pr_err("DIFv1 Type 1 reference failed on sector: %llu tag: 0x%08x"
1207 " sector MSB: 0x%08x\n", (unsigned long long)sector
,
1208 be32_to_cpu(sdt
->ref_tag
), (u32
)(sector
& 0xffffffff));
1209 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED
;
1212 if (dev
->dev_attrib
.pi_prot_type
== TARGET_DIF_TYPE2_PROT
&&
1213 be32_to_cpu(sdt
->ref_tag
) != ei_lba
) {
1214 pr_err("DIFv1 Type 2 reference failed on sector: %llu tag: 0x%08x"
1215 " ei_lba: 0x%08x\n", (unsigned long long)sector
,
1216 be32_to_cpu(sdt
->ref_tag
), ei_lba
);
1217 return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED
;
1224 sbc_dif_copy_prot(struct se_cmd
*cmd
, unsigned int sectors
, bool read
,
1225 struct scatterlist
*sg
, int sg_off
)
1227 struct se_device
*dev
= cmd
->se_dev
;
1228 struct scatterlist
*psg
;
1230 unsigned int i
, len
, left
;
1231 unsigned int offset
= sg_off
;
1233 left
= sectors
* dev
->prot_length
;
1235 for_each_sg(cmd
->t_prot_sg
, psg
, cmd
->t_prot_nents
, i
) {
1236 unsigned int psg_len
, copied
= 0;
1238 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1239 psg_len
= min(left
, psg
->length
);
1241 len
= min(psg_len
, sg
->length
- offset
);
1242 addr
= kmap_atomic(sg_page(sg
)) + sg
->offset
+ offset
;
1245 memcpy(paddr
+ copied
, addr
, len
);
1247 memcpy(addr
, paddr
+ copied
, len
);
1254 if (offset
>= sg
->length
) {
1258 kunmap_atomic(addr
);
1260 kunmap_atomic(paddr
);
1265 sbc_dif_verify_write(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1266 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1268 struct se_device
*dev
= cmd
->se_dev
;
1269 struct se_dif_v1_tuple
*sdt
;
1270 struct scatterlist
*dsg
, *psg
= cmd
->t_prot_sg
;
1271 sector_t sector
= start
;
1272 void *daddr
, *paddr
;
1273 int i
, j
, offset
= 0;
1276 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1277 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1278 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1280 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1282 if (offset
>= psg
->length
) {
1283 kunmap_atomic(paddr
);
1285 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1289 sdt
= paddr
+ offset
;
1291 pr_debug("DIF WRITE sector: %llu guard_tag: 0x%04x"
1292 " app_tag: 0x%04x ref_tag: %u\n",
1293 (unsigned long long)sector
, sdt
->guard_tag
,
1294 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1296 rc
= sbc_dif_v1_verify(dev
, sdt
, daddr
+ j
, sector
,
1299 kunmap_atomic(paddr
);
1300 kunmap_atomic(daddr
);
1301 cmd
->bad_sector
= sector
;
1307 offset
+= sizeof(struct se_dif_v1_tuple
);
1310 kunmap_atomic(paddr
);
1311 kunmap_atomic(daddr
);
1313 sbc_dif_copy_prot(cmd
, sectors
, false, sg
, sg_off
);
1317 EXPORT_SYMBOL(sbc_dif_verify_write
);
1319 static sense_reason_t
1320 __sbc_dif_verify_read(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1321 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1323 struct se_device
*dev
= cmd
->se_dev
;
1324 struct se_dif_v1_tuple
*sdt
;
1325 struct scatterlist
*dsg
, *psg
= sg
;
1326 sector_t sector
= start
;
1327 void *daddr
, *paddr
;
1328 int i
, j
, offset
= sg_off
;
1331 for_each_sg(cmd
->t_data_sg
, dsg
, cmd
->t_data_nents
, i
) {
1332 daddr
= kmap_atomic(sg_page(dsg
)) + dsg
->offset
;
1333 paddr
= kmap_atomic(sg_page(psg
)) + sg
->offset
;
1335 for (j
= 0; j
< dsg
->length
; j
+= dev
->dev_attrib
.block_size
) {
1337 if (offset
>= psg
->length
) {
1338 kunmap_atomic(paddr
);
1340 paddr
= kmap_atomic(sg_page(psg
)) + psg
->offset
;
1344 sdt
= paddr
+ offset
;
1346 pr_debug("DIF READ sector: %llu guard_tag: 0x%04x"
1347 " app_tag: 0x%04x ref_tag: %u\n",
1348 (unsigned long long)sector
, sdt
->guard_tag
,
1349 sdt
->app_tag
, be32_to_cpu(sdt
->ref_tag
));
1351 if (sdt
->app_tag
== cpu_to_be16(0xffff)) {
1353 offset
+= sizeof(struct se_dif_v1_tuple
);
1357 rc
= sbc_dif_v1_verify(dev
, sdt
, daddr
+ j
, sector
,
1360 kunmap_atomic(paddr
);
1361 kunmap_atomic(daddr
);
1362 cmd
->bad_sector
= sector
;
1368 offset
+= sizeof(struct se_dif_v1_tuple
);
1371 kunmap_atomic(paddr
);
1372 kunmap_atomic(daddr
);
1379 sbc_dif_read_strip(struct se_cmd
*cmd
)
1381 struct se_device
*dev
= cmd
->se_dev
;
1382 u32 sectors
= cmd
->prot_length
/ dev
->prot_length
;
1384 return __sbc_dif_verify_read(cmd
, cmd
->t_task_lba
, sectors
, 0,
1389 sbc_dif_verify_read(struct se_cmd
*cmd
, sector_t start
, unsigned int sectors
,
1390 unsigned int ei_lba
, struct scatterlist
*sg
, int sg_off
)
1394 rc
= __sbc_dif_verify_read(cmd
, start
, sectors
, ei_lba
, sg
, sg_off
);
1398 sbc_dif_copy_prot(cmd
, sectors
, true, sg
, sg_off
);
1401 EXPORT_SYMBOL(sbc_dif_verify_read
);