• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * SCSI Block Commands (SBC) parsing and emulation.
4  *
5  * (c) Copyright 2002-2013 Datera, Inc.
6  *
7  * Nicholas A. Bellinger <nab@kernel.org>
8  */
9 
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/ratelimit.h>
13 #include <linux/crc-t10dif.h>
14 #include <linux/t10-pi.h>
15 #include <asm/unaligned.h>
16 #include <scsi/scsi_proto.h>
17 #include <scsi/scsi_tcq.h>
18 
19 #include <target/target_core_base.h>
20 #include <target/target_core_backend.h>
21 #include <target/target_core_fabric.h>
22 
23 #include "target_core_internal.h"
24 #include "target_core_ua.h"
25 #include "target_core_alua.h"
26 
27 static sense_reason_t
28 sbc_check_prot(struct se_device *, struct se_cmd *, unsigned char, u32, bool);
29 static sense_reason_t sbc_execute_unmap(struct se_cmd *cmd);
30 
31 static sense_reason_t
sbc_emulate_readcapacity(struct se_cmd * cmd)32 sbc_emulate_readcapacity(struct se_cmd *cmd)
33 {
34 	struct se_device *dev = cmd->se_dev;
35 	unsigned char *cdb = cmd->t_task_cdb;
36 	unsigned long long blocks_long = dev->transport->get_blocks(dev);
37 	unsigned char *rbuf;
38 	unsigned char buf[8];
39 	u32 blocks;
40 
41 	/*
42 	 * SBC-2 says:
43 	 *   If the PMI bit is set to zero and the LOGICAL BLOCK
44 	 *   ADDRESS field is not set to zero, the device server shall
45 	 *   terminate the command with CHECK CONDITION status with
46 	 *   the sense key set to ILLEGAL REQUEST and the additional
47 	 *   sense code set to INVALID FIELD IN CDB.
48 	 *
49 	 * In SBC-3, these fields are obsolete, but some SCSI
50 	 * compliance tests actually check this, so we might as well
51 	 * follow SBC-2.
52 	 */
53 	if (!(cdb[8] & 1) && !!(cdb[2] | cdb[3] | cdb[4] | cdb[5]))
54 		return TCM_INVALID_CDB_FIELD;
55 
56 	if (blocks_long >= 0x00000000ffffffff)
57 		blocks = 0xffffffff;
58 	else
59 		blocks = (u32)blocks_long;
60 
61 	put_unaligned_be32(blocks, &buf[0]);
62 	put_unaligned_be32(dev->dev_attrib.block_size, &buf[4]);
63 
64 	rbuf = transport_kmap_data_sg(cmd);
65 	if (rbuf) {
66 		memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
67 		transport_kunmap_data_sg(cmd);
68 	}
69 
70 	target_complete_cmd_with_length(cmd, GOOD, 8);
71 	return 0;
72 }
73 
74 static sense_reason_t
sbc_emulate_readcapacity_16(struct se_cmd * cmd)75 sbc_emulate_readcapacity_16(struct se_cmd *cmd)
76 {
77 	struct se_device *dev = cmd->se_dev;
78 	struct se_session *sess = cmd->se_sess;
79 	int pi_prot_type = dev->dev_attrib.pi_prot_type;
80 
81 	unsigned char *rbuf;
82 	unsigned char buf[32];
83 	unsigned long long blocks = dev->transport->get_blocks(dev);
84 
85 	memset(buf, 0, sizeof(buf));
86 	put_unaligned_be64(blocks, &buf[0]);
87 	put_unaligned_be32(dev->dev_attrib.block_size, &buf[8]);
88 	/*
89 	 * Set P_TYPE and PROT_EN bits for DIF support
90 	 */
91 	if (sess->sup_prot_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DOUT_PASS)) {
92 		/*
93 		 * Only override a device's pi_prot_type if no T10-PI is
94 		 * available, and sess_prot_type has been explicitly enabled.
95 		 */
96 		if (!pi_prot_type)
97 			pi_prot_type = sess->sess_prot_type;
98 
99 		if (pi_prot_type)
100 			buf[12] = (pi_prot_type - 1) << 1 | 0x1;
101 	}
102 
103 	if (dev->transport->get_lbppbe)
104 		buf[13] = dev->transport->get_lbppbe(dev) & 0x0f;
105 
106 	if (dev->transport->get_alignment_offset_lbas) {
107 		u16 lalba = dev->transport->get_alignment_offset_lbas(dev);
108 
109 		put_unaligned_be16(lalba, &buf[14]);
110 	}
111 
112 	/*
113 	 * Set Thin Provisioning Enable bit following sbc3r22 in section
114 	 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
115 	 */
116 	if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws) {
117 		buf[14] |= 0x80;
118 
119 		/*
120 		 * LBPRZ signifies that zeroes will be read back from an LBA after
121 		 * an UNMAP or WRITE SAME w/ unmap bit (sbc3r36 5.16.2)
122 		 */
123 		if (dev->dev_attrib.unmap_zeroes_data)
124 			buf[14] |= 0x40;
125 	}
126 
127 	rbuf = transport_kmap_data_sg(cmd);
128 	if (rbuf) {
129 		memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
130 		transport_kunmap_data_sg(cmd);
131 	}
132 
133 	target_complete_cmd_with_length(cmd, GOOD, 32);
134 	return 0;
135 }
136 
137 static sense_reason_t
sbc_emulate_startstop(struct se_cmd * cmd)138 sbc_emulate_startstop(struct se_cmd *cmd)
139 {
140 	unsigned char *cdb = cmd->t_task_cdb;
141 
142 	/*
143 	 * See sbc3r36 section 5.25
144 	 * Immediate bit should be set since there is nothing to complete
145 	 * POWER CONDITION MODIFIER 0h
146 	 */
147 	if (!(cdb[1] & 1) || cdb[2] || cdb[3])
148 		return TCM_INVALID_CDB_FIELD;
149 
150 	/*
151 	 * See sbc3r36 section 5.25
152 	 * POWER CONDITION 0h START_VALID - process START and LOEJ
153 	 */
154 	if (cdb[4] >> 4 & 0xf)
155 		return TCM_INVALID_CDB_FIELD;
156 
157 	/*
158 	 * See sbc3r36 section 5.25
159 	 * LOEJ 0h - nothing to load or unload
160 	 * START 1h - we are ready
161 	 */
162 	if (!(cdb[4] & 1) || (cdb[4] & 2) || (cdb[4] & 4))
163 		return TCM_INVALID_CDB_FIELD;
164 
165 	target_complete_cmd(cmd, SAM_STAT_GOOD);
166 	return 0;
167 }
168 
sbc_get_write_same_sectors(struct se_cmd * cmd)169 sector_t sbc_get_write_same_sectors(struct se_cmd *cmd)
170 {
171 	u32 num_blocks;
172 
173 	if (cmd->t_task_cdb[0] == WRITE_SAME)
174 		num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
175 	else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
176 		num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
177 	else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
178 		num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
179 
180 	/*
181 	 * Use the explicit range when non zero is supplied, otherwise calculate
182 	 * the remaining range based on ->get_blocks() - starting LBA.
183 	 */
184 	if (num_blocks)
185 		return num_blocks;
186 
187 	return cmd->se_dev->transport->get_blocks(cmd->se_dev) -
188 		cmd->t_task_lba + 1;
189 }
190 EXPORT_SYMBOL(sbc_get_write_same_sectors);
191 
192 static sense_reason_t
sbc_execute_write_same_unmap(struct se_cmd * cmd)193 sbc_execute_write_same_unmap(struct se_cmd *cmd)
194 {
195 	struct sbc_ops *ops = cmd->protocol_data;
196 	sector_t nolb = sbc_get_write_same_sectors(cmd);
197 	sense_reason_t ret;
198 
199 	if (nolb) {
200 		ret = ops->execute_unmap(cmd, cmd->t_task_lba, nolb);
201 		if (ret)
202 			return ret;
203 	}
204 
205 	target_complete_cmd(cmd, GOOD);
206 	return 0;
207 }
208 
209 static sense_reason_t
sbc_emulate_noop(struct se_cmd * cmd)210 sbc_emulate_noop(struct se_cmd *cmd)
211 {
212 	target_complete_cmd(cmd, GOOD);
213 	return 0;
214 }
215 
sbc_get_size(struct se_cmd * cmd,u32 sectors)216 static inline u32 sbc_get_size(struct se_cmd *cmd, u32 sectors)
217 {
218 	return cmd->se_dev->dev_attrib.block_size * sectors;
219 }
220 
transport_get_sectors_6(unsigned char * cdb)221 static inline u32 transport_get_sectors_6(unsigned char *cdb)
222 {
223 	/*
224 	 * Use 8-bit sector value.  SBC-3 says:
225 	 *
226 	 *   A TRANSFER LENGTH field set to zero specifies that 256
227 	 *   logical blocks shall be written.  Any other value
228 	 *   specifies the number of logical blocks that shall be
229 	 *   written.
230 	 */
231 	return cdb[4] ? : 256;
232 }
233 
transport_get_sectors_10(unsigned char * cdb)234 static inline u32 transport_get_sectors_10(unsigned char *cdb)
235 {
236 	return get_unaligned_be16(&cdb[7]);
237 }
238 
transport_get_sectors_12(unsigned char * cdb)239 static inline u32 transport_get_sectors_12(unsigned char *cdb)
240 {
241 	return get_unaligned_be32(&cdb[6]);
242 }
243 
transport_get_sectors_16(unsigned char * cdb)244 static inline u32 transport_get_sectors_16(unsigned char *cdb)
245 {
246 	return get_unaligned_be32(&cdb[10]);
247 }
248 
249 /*
250  * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
251  */
transport_get_sectors_32(unsigned char * cdb)252 static inline u32 transport_get_sectors_32(unsigned char *cdb)
253 {
254 	return get_unaligned_be32(&cdb[28]);
255 
256 }
257 
transport_lba_21(unsigned char * cdb)258 static inline u32 transport_lba_21(unsigned char *cdb)
259 {
260 	return get_unaligned_be24(&cdb[1]) & 0x1fffff;
261 }
262 
transport_lba_32(unsigned char * cdb)263 static inline u32 transport_lba_32(unsigned char *cdb)
264 {
265 	return get_unaligned_be32(&cdb[2]);
266 }
267 
transport_lba_64(unsigned char * cdb)268 static inline unsigned long long transport_lba_64(unsigned char *cdb)
269 {
270 	return get_unaligned_be64(&cdb[2]);
271 }
272 
273 /*
274  * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
275  */
transport_lba_64_ext(unsigned char * cdb)276 static inline unsigned long long transport_lba_64_ext(unsigned char *cdb)
277 {
278 	return get_unaligned_be64(&cdb[12]);
279 }
280 
281 static sense_reason_t
sbc_setup_write_same(struct se_cmd * cmd,unsigned char flags,struct sbc_ops * ops)282 sbc_setup_write_same(struct se_cmd *cmd, unsigned char flags, struct sbc_ops *ops)
283 {
284 	struct se_device *dev = cmd->se_dev;
285 	sector_t end_lba = dev->transport->get_blocks(dev) + 1;
286 	unsigned int sectors = sbc_get_write_same_sectors(cmd);
287 	sense_reason_t ret;
288 
289 	if ((flags & 0x04) || (flags & 0x02)) {
290 		pr_err("WRITE_SAME PBDATA and LBDATA"
291 			" bits not supported for Block Discard"
292 			" Emulation\n");
293 		return TCM_UNSUPPORTED_SCSI_OPCODE;
294 	}
295 	if (sectors > cmd->se_dev->dev_attrib.max_write_same_len) {
296 		pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
297 			sectors, cmd->se_dev->dev_attrib.max_write_same_len);
298 		return TCM_INVALID_CDB_FIELD;
299 	}
300 	/*
301 	 * Sanity check for LBA wrap and request past end of device.
302 	 */
303 	if (((cmd->t_task_lba + sectors) < cmd->t_task_lba) ||
304 	    ((cmd->t_task_lba + sectors) > end_lba)) {
305 		pr_err("WRITE_SAME exceeds last lba %llu (lba %llu, sectors %u)\n",
306 		       (unsigned long long)end_lba, cmd->t_task_lba, sectors);
307 		return TCM_ADDRESS_OUT_OF_RANGE;
308 	}
309 
310 	/* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
311 	if (flags & 0x10) {
312 		pr_warn("WRITE SAME with ANCHOR not supported\n");
313 		return TCM_INVALID_CDB_FIELD;
314 	}
315 	/*
316 	 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
317 	 * translated into block discard requests within backend code.
318 	 */
319 	if (flags & 0x08) {
320 		if (!ops->execute_unmap)
321 			return TCM_UNSUPPORTED_SCSI_OPCODE;
322 
323 		if (!dev->dev_attrib.emulate_tpws) {
324 			pr_err("Got WRITE_SAME w/ UNMAP=1, but backend device"
325 			       " has emulate_tpws disabled\n");
326 			return TCM_UNSUPPORTED_SCSI_OPCODE;
327 		}
328 		cmd->execute_cmd = sbc_execute_write_same_unmap;
329 		return 0;
330 	}
331 	if (!ops->execute_write_same)
332 		return TCM_UNSUPPORTED_SCSI_OPCODE;
333 
334 	ret = sbc_check_prot(dev, cmd, flags >> 5, sectors, true);
335 	if (ret)
336 		return ret;
337 
338 	cmd->execute_cmd = ops->execute_write_same;
339 	return 0;
340 }
341 
xdreadwrite_callback(struct se_cmd * cmd,bool success,int * post_ret)342 static sense_reason_t xdreadwrite_callback(struct se_cmd *cmd, bool success,
343 					   int *post_ret)
344 {
345 	unsigned char *buf, *addr;
346 	struct scatterlist *sg;
347 	unsigned int offset;
348 	sense_reason_t ret = TCM_NO_SENSE;
349 	int i, count;
350 
351 	if (!success)
352 		return 0;
353 
354 	/*
355 	 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
356 	 *
357 	 * 1) read the specified logical block(s);
358 	 * 2) transfer logical blocks from the data-out buffer;
359 	 * 3) XOR the logical blocks transferred from the data-out buffer with
360 	 *    the logical blocks read, storing the resulting XOR data in a buffer;
361 	 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
362 	 *    blocks transferred from the data-out buffer; and
363 	 * 5) transfer the resulting XOR data to the data-in buffer.
364 	 */
365 	buf = kmalloc(cmd->data_length, GFP_KERNEL);
366 	if (!buf) {
367 		pr_err("Unable to allocate xor_callback buf\n");
368 		return TCM_OUT_OF_RESOURCES;
369 	}
370 	/*
371 	 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
372 	 * into the locally allocated *buf
373 	 */
374 	sg_copy_to_buffer(cmd->t_data_sg,
375 			  cmd->t_data_nents,
376 			  buf,
377 			  cmd->data_length);
378 
379 	/*
380 	 * Now perform the XOR against the BIDI read memory located at
381 	 * cmd->t_mem_bidi_list
382 	 */
383 
384 	offset = 0;
385 	for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, count) {
386 		addr = kmap_atomic(sg_page(sg));
387 		if (!addr) {
388 			ret = TCM_OUT_OF_RESOURCES;
389 			goto out;
390 		}
391 
392 		for (i = 0; i < sg->length; i++)
393 			*(addr + sg->offset + i) ^= *(buf + offset + i);
394 
395 		offset += sg->length;
396 		kunmap_atomic(addr);
397 	}
398 
399 out:
400 	kfree(buf);
401 	return ret;
402 }
403 
404 static sense_reason_t
sbc_execute_rw(struct se_cmd * cmd)405 sbc_execute_rw(struct se_cmd *cmd)
406 {
407 	struct sbc_ops *ops = cmd->protocol_data;
408 
409 	return ops->execute_rw(cmd, cmd->t_data_sg, cmd->t_data_nents,
410 			       cmd->data_direction);
411 }
412 
compare_and_write_post(struct se_cmd * cmd,bool success,int * post_ret)413 static sense_reason_t compare_and_write_post(struct se_cmd *cmd, bool success,
414 					     int *post_ret)
415 {
416 	struct se_device *dev = cmd->se_dev;
417 	sense_reason_t ret = TCM_NO_SENSE;
418 
419 	spin_lock_irq(&cmd->t_state_lock);
420 	if (success) {
421 		*post_ret = 1;
422 
423 		if (cmd->scsi_status == SAM_STAT_CHECK_CONDITION)
424 			ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
425 	}
426 	spin_unlock_irq(&cmd->t_state_lock);
427 
428 	/*
429 	 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
430 	 * before the original READ I/O submission.
431 	 */
432 	up(&dev->caw_sem);
433 
434 	return ret;
435 }
436 
compare_and_write_callback(struct se_cmd * cmd,bool success,int * post_ret)437 static sense_reason_t compare_and_write_callback(struct se_cmd *cmd, bool success,
438 						 int *post_ret)
439 {
440 	struct se_device *dev = cmd->se_dev;
441 	struct sg_table write_tbl = { };
442 	struct scatterlist *write_sg, *sg;
443 	unsigned char *buf = NULL, *addr;
444 	struct sg_mapping_iter m;
445 	unsigned int offset = 0, len;
446 	unsigned int nlbas = cmd->t_task_nolb;
447 	unsigned int block_size = dev->dev_attrib.block_size;
448 	unsigned int compare_len = (nlbas * block_size);
449 	sense_reason_t ret = TCM_NO_SENSE;
450 	int rc, i;
451 
452 	/*
453 	 * Handle early failure in transport_generic_request_failure(),
454 	 * which will not have taken ->caw_sem yet..
455 	 */
456 	if (!success && (!cmd->t_data_sg || !cmd->t_bidi_data_sg))
457 		return TCM_NO_SENSE;
458 	/*
459 	 * Handle special case for zero-length COMPARE_AND_WRITE
460 	 */
461 	if (!cmd->data_length)
462 		goto out;
463 	/*
464 	 * Immediately exit + release dev->caw_sem if command has already
465 	 * been failed with a non-zero SCSI status.
466 	 */
467 	if (cmd->scsi_status) {
468 		pr_debug("compare_and_write_callback: non zero scsi_status:"
469 			" 0x%02x\n", cmd->scsi_status);
470 		*post_ret = 1;
471 		if (cmd->scsi_status == SAM_STAT_CHECK_CONDITION)
472 			ret = TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
473 		goto out;
474 	}
475 
476 	buf = kzalloc(cmd->data_length, GFP_KERNEL);
477 	if (!buf) {
478 		pr_err("Unable to allocate compare_and_write buf\n");
479 		ret = TCM_OUT_OF_RESOURCES;
480 		goto out;
481 	}
482 
483 	if (sg_alloc_table(&write_tbl, cmd->t_data_nents, GFP_KERNEL) < 0) {
484 		pr_err("Unable to allocate compare_and_write sg\n");
485 		ret = TCM_OUT_OF_RESOURCES;
486 		goto out;
487 	}
488 	write_sg = write_tbl.sgl;
489 	/*
490 	 * Setup verify and write data payloads from total NumberLBAs.
491 	 */
492 	rc = sg_copy_to_buffer(cmd->t_data_sg, cmd->t_data_nents, buf,
493 			       cmd->data_length);
494 	if (!rc) {
495 		pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
496 		ret = TCM_OUT_OF_RESOURCES;
497 		goto out;
498 	}
499 	/*
500 	 * Compare against SCSI READ payload against verify payload
501 	 */
502 	for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, i) {
503 		addr = (unsigned char *)kmap_atomic(sg_page(sg));
504 		if (!addr) {
505 			ret = TCM_OUT_OF_RESOURCES;
506 			goto out;
507 		}
508 
509 		len = min(sg->length, compare_len);
510 
511 		if (memcmp(addr, buf + offset, len)) {
512 			pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
513 				addr, buf + offset);
514 			kunmap_atomic(addr);
515 			goto miscompare;
516 		}
517 		kunmap_atomic(addr);
518 
519 		offset += len;
520 		compare_len -= len;
521 		if (!compare_len)
522 			break;
523 	}
524 
525 	i = 0;
526 	len = cmd->t_task_nolb * block_size;
527 	sg_miter_start(&m, cmd->t_data_sg, cmd->t_data_nents, SG_MITER_TO_SG);
528 	/*
529 	 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
530 	 */
531 	while (len) {
532 		sg_miter_next(&m);
533 
534 		if (block_size < PAGE_SIZE) {
535 			sg_set_page(&write_sg[i], m.page, block_size,
536 				    m.piter.sg->offset + block_size);
537 		} else {
538 			sg_miter_next(&m);
539 			sg_set_page(&write_sg[i], m.page, block_size,
540 				    m.piter.sg->offset);
541 		}
542 		len -= block_size;
543 		i++;
544 	}
545 	sg_miter_stop(&m);
546 	/*
547 	 * Save the original SGL + nents values before updating to new
548 	 * assignments, to be released in transport_free_pages() ->
549 	 * transport_reset_sgl_orig()
550 	 */
551 	cmd->t_data_sg_orig = cmd->t_data_sg;
552 	cmd->t_data_sg = write_sg;
553 	cmd->t_data_nents_orig = cmd->t_data_nents;
554 	cmd->t_data_nents = 1;
555 
556 	cmd->sam_task_attr = TCM_HEAD_TAG;
557 	cmd->transport_complete_callback = compare_and_write_post;
558 	/*
559 	 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
560 	 * for submitting the adjusted SGL to write instance user-data.
561 	 */
562 	cmd->execute_cmd = sbc_execute_rw;
563 
564 	spin_lock_irq(&cmd->t_state_lock);
565 	cmd->t_state = TRANSPORT_PROCESSING;
566 	cmd->transport_state |= CMD_T_ACTIVE | CMD_T_SENT;
567 	spin_unlock_irq(&cmd->t_state_lock);
568 
569 	__target_execute_cmd(cmd, false);
570 
571 	kfree(buf);
572 	return ret;
573 
574 miscompare:
575 	pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
576 		dev->transport->name);
577 	ret = TCM_MISCOMPARE_VERIFY;
578 out:
579 	/*
580 	 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
581 	 * sbc_compare_and_write() before the original READ I/O submission.
582 	 */
583 	up(&dev->caw_sem);
584 	sg_free_table(&write_tbl);
585 	kfree(buf);
586 	return ret;
587 }
588 
589 static sense_reason_t
sbc_compare_and_write(struct se_cmd * cmd)590 sbc_compare_and_write(struct se_cmd *cmd)
591 {
592 	struct sbc_ops *ops = cmd->protocol_data;
593 	struct se_device *dev = cmd->se_dev;
594 	sense_reason_t ret;
595 	int rc;
596 	/*
597 	 * Submit the READ first for COMPARE_AND_WRITE to perform the
598 	 * comparision using SGLs at cmd->t_bidi_data_sg..
599 	 */
600 	rc = down_interruptible(&dev->caw_sem);
601 	if (rc != 0) {
602 		cmd->transport_complete_callback = NULL;
603 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
604 	}
605 	/*
606 	 * Reset cmd->data_length to individual block_size in order to not
607 	 * confuse backend drivers that depend on this value matching the
608 	 * size of the I/O being submitted.
609 	 */
610 	cmd->data_length = cmd->t_task_nolb * dev->dev_attrib.block_size;
611 
612 	ret = ops->execute_rw(cmd, cmd->t_bidi_data_sg, cmd->t_bidi_data_nents,
613 			      DMA_FROM_DEVICE);
614 	if (ret) {
615 		cmd->transport_complete_callback = NULL;
616 		up(&dev->caw_sem);
617 		return ret;
618 	}
619 	/*
620 	 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
621 	 * upon MISCOMPARE, or in compare_and_write_done() upon completion
622 	 * of WRITE instance user-data.
623 	 */
624 	return TCM_NO_SENSE;
625 }
626 
627 static int
sbc_set_prot_op_checks(u8 protect,bool fabric_prot,enum target_prot_type prot_type,bool is_write,struct se_cmd * cmd)628 sbc_set_prot_op_checks(u8 protect, bool fabric_prot, enum target_prot_type prot_type,
629 		       bool is_write, struct se_cmd *cmd)
630 {
631 	if (is_write) {
632 		cmd->prot_op = fabric_prot ? TARGET_PROT_DOUT_STRIP :
633 			       protect ? TARGET_PROT_DOUT_PASS :
634 			       TARGET_PROT_DOUT_INSERT;
635 		switch (protect) {
636 		case 0x0:
637 		case 0x3:
638 			cmd->prot_checks = 0;
639 			break;
640 		case 0x1:
641 		case 0x5:
642 			cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
643 			if (prot_type == TARGET_DIF_TYPE1_PROT)
644 				cmd->prot_checks |= TARGET_DIF_CHECK_REFTAG;
645 			break;
646 		case 0x2:
647 			if (prot_type == TARGET_DIF_TYPE1_PROT)
648 				cmd->prot_checks = TARGET_DIF_CHECK_REFTAG;
649 			break;
650 		case 0x4:
651 			cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
652 			break;
653 		default:
654 			pr_err("Unsupported protect field %d\n", protect);
655 			return -EINVAL;
656 		}
657 	} else {
658 		cmd->prot_op = fabric_prot ? TARGET_PROT_DIN_INSERT :
659 			       protect ? TARGET_PROT_DIN_PASS :
660 			       TARGET_PROT_DIN_STRIP;
661 		switch (protect) {
662 		case 0x0:
663 		case 0x1:
664 		case 0x5:
665 			cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
666 			if (prot_type == TARGET_DIF_TYPE1_PROT)
667 				cmd->prot_checks |= TARGET_DIF_CHECK_REFTAG;
668 			break;
669 		case 0x2:
670 			if (prot_type == TARGET_DIF_TYPE1_PROT)
671 				cmd->prot_checks = TARGET_DIF_CHECK_REFTAG;
672 			break;
673 		case 0x3:
674 			cmd->prot_checks = 0;
675 			break;
676 		case 0x4:
677 			cmd->prot_checks = TARGET_DIF_CHECK_GUARD;
678 			break;
679 		default:
680 			pr_err("Unsupported protect field %d\n", protect);
681 			return -EINVAL;
682 		}
683 	}
684 
685 	return 0;
686 }
687 
688 static sense_reason_t
sbc_check_prot(struct se_device * dev,struct se_cmd * cmd,unsigned char protect,u32 sectors,bool is_write)689 sbc_check_prot(struct se_device *dev, struct se_cmd *cmd, unsigned char protect,
690 	       u32 sectors, bool is_write)
691 {
692 	int sp_ops = cmd->se_sess->sup_prot_ops;
693 	int pi_prot_type = dev->dev_attrib.pi_prot_type;
694 	bool fabric_prot = false;
695 
696 	if (!cmd->t_prot_sg || !cmd->t_prot_nents) {
697 		if (unlikely(protect &&
698 		    !dev->dev_attrib.pi_prot_type && !cmd->se_sess->sess_prot_type)) {
699 			pr_err("CDB contains protect bit, but device + fabric does"
700 			       " not advertise PROTECT=1 feature bit\n");
701 			return TCM_INVALID_CDB_FIELD;
702 		}
703 		if (cmd->prot_pto)
704 			return TCM_NO_SENSE;
705 	}
706 
707 	switch (dev->dev_attrib.pi_prot_type) {
708 	case TARGET_DIF_TYPE3_PROT:
709 		cmd->reftag_seed = 0xffffffff;
710 		break;
711 	case TARGET_DIF_TYPE2_PROT:
712 		if (protect)
713 			return TCM_INVALID_CDB_FIELD;
714 
715 		cmd->reftag_seed = cmd->t_task_lba;
716 		break;
717 	case TARGET_DIF_TYPE1_PROT:
718 		cmd->reftag_seed = cmd->t_task_lba;
719 		break;
720 	case TARGET_DIF_TYPE0_PROT:
721 		/*
722 		 * See if the fabric supports T10-PI, and the session has been
723 		 * configured to allow export PROTECT=1 feature bit with backend
724 		 * devices that don't support T10-PI.
725 		 */
726 		fabric_prot = is_write ?
727 			      !!(sp_ops & (TARGET_PROT_DOUT_PASS | TARGET_PROT_DOUT_STRIP)) :
728 			      !!(sp_ops & (TARGET_PROT_DIN_PASS | TARGET_PROT_DIN_INSERT));
729 
730 		if (fabric_prot && cmd->se_sess->sess_prot_type) {
731 			pi_prot_type = cmd->se_sess->sess_prot_type;
732 			break;
733 		}
734 		if (!protect)
735 			return TCM_NO_SENSE;
736 		fallthrough;
737 	default:
738 		pr_err("Unable to determine pi_prot_type for CDB: 0x%02x "
739 		       "PROTECT: 0x%02x\n", cmd->t_task_cdb[0], protect);
740 		return TCM_INVALID_CDB_FIELD;
741 	}
742 
743 	if (sbc_set_prot_op_checks(protect, fabric_prot, pi_prot_type, is_write, cmd))
744 		return TCM_INVALID_CDB_FIELD;
745 
746 	cmd->prot_type = pi_prot_type;
747 	cmd->prot_length = dev->prot_length * sectors;
748 
749 	/**
750 	 * In case protection information exists over the wire
751 	 * we modify command data length to describe pure data.
752 	 * The actual transfer length is data length + protection
753 	 * length
754 	 **/
755 	if (protect)
756 		cmd->data_length = sectors * dev->dev_attrib.block_size;
757 
758 	pr_debug("%s: prot_type=%d, data_length=%d, prot_length=%d "
759 		 "prot_op=%d prot_checks=%d\n",
760 		 __func__, cmd->prot_type, cmd->data_length, cmd->prot_length,
761 		 cmd->prot_op, cmd->prot_checks);
762 
763 	return TCM_NO_SENSE;
764 }
765 
766 static int
sbc_check_dpofua(struct se_device * dev,struct se_cmd * cmd,unsigned char * cdb)767 sbc_check_dpofua(struct se_device *dev, struct se_cmd *cmd, unsigned char *cdb)
768 {
769 	if (cdb[1] & 0x10) {
770 		/* see explanation in spc_emulate_modesense */
771 		if (!target_check_fua(dev)) {
772 			pr_err("Got CDB: 0x%02x with DPO bit set, but device"
773 			       " does not advertise support for DPO\n", cdb[0]);
774 			return -EINVAL;
775 		}
776 	}
777 	if (cdb[1] & 0x8) {
778 		if (!target_check_fua(dev)) {
779 			pr_err("Got CDB: 0x%02x with FUA bit set, but device"
780 			       " does not advertise support for FUA write\n",
781 			       cdb[0]);
782 			return -EINVAL;
783 		}
784 		cmd->se_cmd_flags |= SCF_FUA;
785 	}
786 	return 0;
787 }
788 
789 sense_reason_t
sbc_parse_cdb(struct se_cmd * cmd,struct sbc_ops * ops)790 sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops)
791 {
792 	struct se_device *dev = cmd->se_dev;
793 	unsigned char *cdb = cmd->t_task_cdb;
794 	unsigned int size;
795 	u32 sectors = 0;
796 	sense_reason_t ret;
797 
798 	cmd->protocol_data = ops;
799 
800 	switch (cdb[0]) {
801 	case READ_6:
802 		sectors = transport_get_sectors_6(cdb);
803 		cmd->t_task_lba = transport_lba_21(cdb);
804 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
805 		cmd->execute_cmd = sbc_execute_rw;
806 		break;
807 	case READ_10:
808 		sectors = transport_get_sectors_10(cdb);
809 		cmd->t_task_lba = transport_lba_32(cdb);
810 
811 		if (sbc_check_dpofua(dev, cmd, cdb))
812 			return TCM_INVALID_CDB_FIELD;
813 
814 		ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, false);
815 		if (ret)
816 			return ret;
817 
818 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
819 		cmd->execute_cmd = sbc_execute_rw;
820 		break;
821 	case READ_12:
822 		sectors = transport_get_sectors_12(cdb);
823 		cmd->t_task_lba = transport_lba_32(cdb);
824 
825 		if (sbc_check_dpofua(dev, cmd, cdb))
826 			return TCM_INVALID_CDB_FIELD;
827 
828 		ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, false);
829 		if (ret)
830 			return ret;
831 
832 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
833 		cmd->execute_cmd = sbc_execute_rw;
834 		break;
835 	case READ_16:
836 		sectors = transport_get_sectors_16(cdb);
837 		cmd->t_task_lba = transport_lba_64(cdb);
838 
839 		if (sbc_check_dpofua(dev, cmd, cdb))
840 			return TCM_INVALID_CDB_FIELD;
841 
842 		ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, false);
843 		if (ret)
844 			return ret;
845 
846 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
847 		cmd->execute_cmd = sbc_execute_rw;
848 		break;
849 	case WRITE_6:
850 		sectors = transport_get_sectors_6(cdb);
851 		cmd->t_task_lba = transport_lba_21(cdb);
852 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
853 		cmd->execute_cmd = sbc_execute_rw;
854 		break;
855 	case WRITE_10:
856 	case WRITE_VERIFY:
857 		sectors = transport_get_sectors_10(cdb);
858 		cmd->t_task_lba = transport_lba_32(cdb);
859 
860 		if (sbc_check_dpofua(dev, cmd, cdb))
861 			return TCM_INVALID_CDB_FIELD;
862 
863 		ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, true);
864 		if (ret)
865 			return ret;
866 
867 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
868 		cmd->execute_cmd = sbc_execute_rw;
869 		break;
870 	case WRITE_12:
871 		sectors = transport_get_sectors_12(cdb);
872 		cmd->t_task_lba = transport_lba_32(cdb);
873 
874 		if (sbc_check_dpofua(dev, cmd, cdb))
875 			return TCM_INVALID_CDB_FIELD;
876 
877 		ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, true);
878 		if (ret)
879 			return ret;
880 
881 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
882 		cmd->execute_cmd = sbc_execute_rw;
883 		break;
884 	case WRITE_16:
885 	case WRITE_VERIFY_16:
886 		sectors = transport_get_sectors_16(cdb);
887 		cmd->t_task_lba = transport_lba_64(cdb);
888 
889 		if (sbc_check_dpofua(dev, cmd, cdb))
890 			return TCM_INVALID_CDB_FIELD;
891 
892 		ret = sbc_check_prot(dev, cmd, cdb[1] >> 5, sectors, true);
893 		if (ret)
894 			return ret;
895 
896 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
897 		cmd->execute_cmd = sbc_execute_rw;
898 		break;
899 	case XDWRITEREAD_10:
900 		if (cmd->data_direction != DMA_TO_DEVICE ||
901 		    !(cmd->se_cmd_flags & SCF_BIDI))
902 			return TCM_INVALID_CDB_FIELD;
903 		sectors = transport_get_sectors_10(cdb);
904 
905 		if (sbc_check_dpofua(dev, cmd, cdb))
906 			return TCM_INVALID_CDB_FIELD;
907 
908 		cmd->t_task_lba = transport_lba_32(cdb);
909 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
910 
911 		/*
912 		 * Setup BIDI XOR callback to be run after I/O completion.
913 		 */
914 		cmd->execute_cmd = sbc_execute_rw;
915 		cmd->transport_complete_callback = &xdreadwrite_callback;
916 		break;
917 	case VARIABLE_LENGTH_CMD:
918 	{
919 		u16 service_action = get_unaligned_be16(&cdb[8]);
920 		switch (service_action) {
921 		case XDWRITEREAD_32:
922 			sectors = transport_get_sectors_32(cdb);
923 
924 			if (sbc_check_dpofua(dev, cmd, cdb))
925 				return TCM_INVALID_CDB_FIELD;
926 			/*
927 			 * Use WRITE_32 and READ_32 opcodes for the emulated
928 			 * XDWRITE_READ_32 logic.
929 			 */
930 			cmd->t_task_lba = transport_lba_64_ext(cdb);
931 			cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
932 
933 			/*
934 			 * Setup BIDI XOR callback to be run during after I/O
935 			 * completion.
936 			 */
937 			cmd->execute_cmd = sbc_execute_rw;
938 			cmd->transport_complete_callback = &xdreadwrite_callback;
939 			break;
940 		case WRITE_SAME_32:
941 			sectors = transport_get_sectors_32(cdb);
942 			if (!sectors) {
943 				pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
944 				       " supported\n");
945 				return TCM_INVALID_CDB_FIELD;
946 			}
947 
948 			size = sbc_get_size(cmd, 1);
949 			cmd->t_task_lba = get_unaligned_be64(&cdb[12]);
950 
951 			ret = sbc_setup_write_same(cmd, cdb[10], ops);
952 			if (ret)
953 				return ret;
954 			break;
955 		default:
956 			pr_err("VARIABLE_LENGTH_CMD service action"
957 				" 0x%04x not supported\n", service_action);
958 			return TCM_UNSUPPORTED_SCSI_OPCODE;
959 		}
960 		break;
961 	}
962 	case COMPARE_AND_WRITE:
963 		if (!dev->dev_attrib.emulate_caw) {
964 			pr_err_ratelimited("se_device %s/%s (vpd_unit_serial %s) reject COMPARE_AND_WRITE\n",
965 					   dev->se_hba->backend->ops->name,
966 					   config_item_name(&dev->dev_group.cg_item),
967 					   dev->t10_wwn.unit_serial);
968 			return TCM_UNSUPPORTED_SCSI_OPCODE;
969 		}
970 		sectors = cdb[13];
971 		/*
972 		 * Currently enforce COMPARE_AND_WRITE for a single sector
973 		 */
974 		if (sectors > 1) {
975 			pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
976 			       " than 1\n", sectors);
977 			return TCM_INVALID_CDB_FIELD;
978 		}
979 		if (sbc_check_dpofua(dev, cmd, cdb))
980 			return TCM_INVALID_CDB_FIELD;
981 
982 		/*
983 		 * Double size because we have two buffers, note that
984 		 * zero is not an error..
985 		 */
986 		size = 2 * sbc_get_size(cmd, sectors);
987 		cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
988 		cmd->t_task_nolb = sectors;
989 		cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB | SCF_COMPARE_AND_WRITE;
990 		cmd->execute_cmd = sbc_compare_and_write;
991 		cmd->transport_complete_callback = compare_and_write_callback;
992 		break;
993 	case READ_CAPACITY:
994 		size = READ_CAP_LEN;
995 		cmd->execute_cmd = sbc_emulate_readcapacity;
996 		break;
997 	case SERVICE_ACTION_IN_16:
998 		switch (cmd->t_task_cdb[1] & 0x1f) {
999 		case SAI_READ_CAPACITY_16:
1000 			cmd->execute_cmd = sbc_emulate_readcapacity_16;
1001 			break;
1002 		case SAI_REPORT_REFERRALS:
1003 			cmd->execute_cmd = target_emulate_report_referrals;
1004 			break;
1005 		default:
1006 			pr_err("Unsupported SA: 0x%02x\n",
1007 				cmd->t_task_cdb[1] & 0x1f);
1008 			return TCM_INVALID_CDB_FIELD;
1009 		}
1010 		size = get_unaligned_be32(&cdb[10]);
1011 		break;
1012 	case SYNCHRONIZE_CACHE:
1013 	case SYNCHRONIZE_CACHE_16:
1014 		if (cdb[0] == SYNCHRONIZE_CACHE) {
1015 			sectors = transport_get_sectors_10(cdb);
1016 			cmd->t_task_lba = transport_lba_32(cdb);
1017 		} else {
1018 			sectors = transport_get_sectors_16(cdb);
1019 			cmd->t_task_lba = transport_lba_64(cdb);
1020 		}
1021 		if (ops->execute_sync_cache) {
1022 			cmd->execute_cmd = ops->execute_sync_cache;
1023 			goto check_lba;
1024 		}
1025 		size = 0;
1026 		cmd->execute_cmd = sbc_emulate_noop;
1027 		break;
1028 	case UNMAP:
1029 		if (!ops->execute_unmap)
1030 			return TCM_UNSUPPORTED_SCSI_OPCODE;
1031 
1032 		if (!dev->dev_attrib.emulate_tpu) {
1033 			pr_err("Got UNMAP, but backend device has"
1034 			       " emulate_tpu disabled\n");
1035 			return TCM_UNSUPPORTED_SCSI_OPCODE;
1036 		}
1037 		size = get_unaligned_be16(&cdb[7]);
1038 		cmd->execute_cmd = sbc_execute_unmap;
1039 		break;
1040 	case WRITE_SAME_16:
1041 		sectors = transport_get_sectors_16(cdb);
1042 		if (!sectors) {
1043 			pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
1044 			return TCM_INVALID_CDB_FIELD;
1045 		}
1046 
1047 		size = sbc_get_size(cmd, 1);
1048 		cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
1049 
1050 		ret = sbc_setup_write_same(cmd, cdb[1], ops);
1051 		if (ret)
1052 			return ret;
1053 		break;
1054 	case WRITE_SAME:
1055 		sectors = transport_get_sectors_10(cdb);
1056 		if (!sectors) {
1057 			pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
1058 			return TCM_INVALID_CDB_FIELD;
1059 		}
1060 
1061 		size = sbc_get_size(cmd, 1);
1062 		cmd->t_task_lba = get_unaligned_be32(&cdb[2]);
1063 
1064 		/*
1065 		 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
1066 		 * of byte 1 bit 3 UNMAP instead of original reserved field
1067 		 */
1068 		ret = sbc_setup_write_same(cmd, cdb[1], ops);
1069 		if (ret)
1070 			return ret;
1071 		break;
1072 	case VERIFY:
1073 	case VERIFY_16:
1074 		size = 0;
1075 		if (cdb[0] == VERIFY) {
1076 			sectors = transport_get_sectors_10(cdb);
1077 			cmd->t_task_lba = transport_lba_32(cdb);
1078 		} else {
1079 			sectors = transport_get_sectors_16(cdb);
1080 			cmd->t_task_lba = transport_lba_64(cdb);
1081 		}
1082 		cmd->execute_cmd = sbc_emulate_noop;
1083 		goto check_lba;
1084 	case REZERO_UNIT:
1085 	case SEEK_6:
1086 	case SEEK_10:
1087 		/*
1088 		 * There are still clients out there which use these old SCSI-2
1089 		 * commands. This mainly happens when running VMs with legacy
1090 		 * guest systems, connected via SCSI command pass-through to
1091 		 * iSCSI targets. Make them happy and return status GOOD.
1092 		 */
1093 		size = 0;
1094 		cmd->execute_cmd = sbc_emulate_noop;
1095 		break;
1096 	case START_STOP:
1097 		size = 0;
1098 		cmd->execute_cmd = sbc_emulate_startstop;
1099 		break;
1100 	default:
1101 		ret = spc_parse_cdb(cmd, &size);
1102 		if (ret)
1103 			return ret;
1104 	}
1105 
1106 	/* reject any command that we don't have a handler for */
1107 	if (!cmd->execute_cmd)
1108 		return TCM_UNSUPPORTED_SCSI_OPCODE;
1109 
1110 	if (cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) {
1111 		unsigned long long end_lba;
1112 check_lba:
1113 		end_lba = dev->transport->get_blocks(dev) + 1;
1114 		if (((cmd->t_task_lba + sectors) < cmd->t_task_lba) ||
1115 		    ((cmd->t_task_lba + sectors) > end_lba)) {
1116 			pr_err("cmd exceeds last lba %llu "
1117 				"(lba %llu, sectors %u)\n",
1118 				end_lba, cmd->t_task_lba, sectors);
1119 			return TCM_ADDRESS_OUT_OF_RANGE;
1120 		}
1121 
1122 		if (!(cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE))
1123 			size = sbc_get_size(cmd, sectors);
1124 	}
1125 
1126 	return target_cmd_size_check(cmd, size);
1127 }
1128 EXPORT_SYMBOL(sbc_parse_cdb);
1129 
sbc_get_device_type(struct se_device * dev)1130 u32 sbc_get_device_type(struct se_device *dev)
1131 {
1132 	return TYPE_DISK;
1133 }
1134 EXPORT_SYMBOL(sbc_get_device_type);
1135 
1136 static sense_reason_t
sbc_execute_unmap(struct se_cmd * cmd)1137 sbc_execute_unmap(struct se_cmd *cmd)
1138 {
1139 	struct sbc_ops *ops = cmd->protocol_data;
1140 	struct se_device *dev = cmd->se_dev;
1141 	unsigned char *buf, *ptr = NULL;
1142 	sector_t lba;
1143 	int size;
1144 	u32 range;
1145 	sense_reason_t ret = 0;
1146 	int dl, bd_dl;
1147 
1148 	/* We never set ANC_SUP */
1149 	if (cmd->t_task_cdb[1])
1150 		return TCM_INVALID_CDB_FIELD;
1151 
1152 	if (cmd->data_length == 0) {
1153 		target_complete_cmd(cmd, SAM_STAT_GOOD);
1154 		return 0;
1155 	}
1156 
1157 	if (cmd->data_length < 8) {
1158 		pr_warn("UNMAP parameter list length %u too small\n",
1159 			cmd->data_length);
1160 		return TCM_PARAMETER_LIST_LENGTH_ERROR;
1161 	}
1162 
1163 	buf = transport_kmap_data_sg(cmd);
1164 	if (!buf)
1165 		return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
1166 
1167 	dl = get_unaligned_be16(&buf[0]);
1168 	bd_dl = get_unaligned_be16(&buf[2]);
1169 
1170 	size = cmd->data_length - 8;
1171 	if (bd_dl > size)
1172 		pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
1173 			cmd->data_length, bd_dl);
1174 	else
1175 		size = bd_dl;
1176 
1177 	if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
1178 		ret = TCM_INVALID_PARAMETER_LIST;
1179 		goto err;
1180 	}
1181 
1182 	/* First UNMAP block descriptor starts at 8 byte offset */
1183 	ptr = &buf[8];
1184 	pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
1185 		" ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
1186 
1187 	while (size >= 16) {
1188 		lba = get_unaligned_be64(&ptr[0]);
1189 		range = get_unaligned_be32(&ptr[8]);
1190 		pr_debug("UNMAP: Using lba: %llu and range: %u\n",
1191 				 (unsigned long long)lba, range);
1192 
1193 		if (range > dev->dev_attrib.max_unmap_lba_count) {
1194 			ret = TCM_INVALID_PARAMETER_LIST;
1195 			goto err;
1196 		}
1197 
1198 		if (lba + range > dev->transport->get_blocks(dev) + 1) {
1199 			ret = TCM_ADDRESS_OUT_OF_RANGE;
1200 			goto err;
1201 		}
1202 
1203 		if (range) {
1204 			ret = ops->execute_unmap(cmd, lba, range);
1205 			if (ret)
1206 				goto err;
1207 		}
1208 
1209 		ptr += 16;
1210 		size -= 16;
1211 	}
1212 
1213 err:
1214 	transport_kunmap_data_sg(cmd);
1215 	if (!ret)
1216 		target_complete_cmd(cmd, GOOD);
1217 	return ret;
1218 }
1219 
1220 void
sbc_dif_generate(struct se_cmd * cmd)1221 sbc_dif_generate(struct se_cmd *cmd)
1222 {
1223 	struct se_device *dev = cmd->se_dev;
1224 	struct t10_pi_tuple *sdt;
1225 	struct scatterlist *dsg = cmd->t_data_sg, *psg;
1226 	sector_t sector = cmd->t_task_lba;
1227 	void *daddr, *paddr;
1228 	int i, j, offset = 0;
1229 	unsigned int block_size = dev->dev_attrib.block_size;
1230 
1231 	for_each_sg(cmd->t_prot_sg, psg, cmd->t_prot_nents, i) {
1232 		paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1233 		daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1234 
1235 		for (j = 0; j < psg->length;
1236 				j += sizeof(*sdt)) {
1237 			__u16 crc;
1238 			unsigned int avail;
1239 
1240 			if (offset >= dsg->length) {
1241 				offset -= dsg->length;
1242 				kunmap_atomic(daddr - dsg->offset);
1243 				dsg = sg_next(dsg);
1244 				if (!dsg) {
1245 					kunmap_atomic(paddr - psg->offset);
1246 					return;
1247 				}
1248 				daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1249 			}
1250 
1251 			sdt = paddr + j;
1252 			avail = min(block_size, dsg->length - offset);
1253 			crc = crc_t10dif(daddr + offset, avail);
1254 			if (avail < block_size) {
1255 				kunmap_atomic(daddr - dsg->offset);
1256 				dsg = sg_next(dsg);
1257 				if (!dsg) {
1258 					kunmap_atomic(paddr - psg->offset);
1259 					return;
1260 				}
1261 				daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1262 				offset = block_size - avail;
1263 				crc = crc_t10dif_update(crc, daddr, offset);
1264 			} else {
1265 				offset += block_size;
1266 			}
1267 
1268 			sdt->guard_tag = cpu_to_be16(crc);
1269 			if (cmd->prot_type == TARGET_DIF_TYPE1_PROT)
1270 				sdt->ref_tag = cpu_to_be32(sector & 0xffffffff);
1271 			sdt->app_tag = 0;
1272 
1273 			pr_debug("DIF %s INSERT sector: %llu guard_tag: 0x%04x"
1274 				 " app_tag: 0x%04x ref_tag: %u\n",
1275 				 (cmd->data_direction == DMA_TO_DEVICE) ?
1276 				 "WRITE" : "READ", (unsigned long long)sector,
1277 				 sdt->guard_tag, sdt->app_tag,
1278 				 be32_to_cpu(sdt->ref_tag));
1279 
1280 			sector++;
1281 		}
1282 
1283 		kunmap_atomic(daddr - dsg->offset);
1284 		kunmap_atomic(paddr - psg->offset);
1285 	}
1286 }
1287 
1288 static sense_reason_t
sbc_dif_v1_verify(struct se_cmd * cmd,struct t10_pi_tuple * sdt,__u16 crc,sector_t sector,unsigned int ei_lba)1289 sbc_dif_v1_verify(struct se_cmd *cmd, struct t10_pi_tuple *sdt,
1290 		  __u16 crc, sector_t sector, unsigned int ei_lba)
1291 {
1292 	__be16 csum;
1293 
1294 	if (!(cmd->prot_checks & TARGET_DIF_CHECK_GUARD))
1295 		goto check_ref;
1296 
1297 	csum = cpu_to_be16(crc);
1298 
1299 	if (sdt->guard_tag != csum) {
1300 		pr_err("DIFv1 checksum failed on sector %llu guard tag 0x%04x"
1301 			" csum 0x%04x\n", (unsigned long long)sector,
1302 			be16_to_cpu(sdt->guard_tag), be16_to_cpu(csum));
1303 		return TCM_LOGICAL_BLOCK_GUARD_CHECK_FAILED;
1304 	}
1305 
1306 check_ref:
1307 	if (!(cmd->prot_checks & TARGET_DIF_CHECK_REFTAG))
1308 		return 0;
1309 
1310 	if (cmd->prot_type == TARGET_DIF_TYPE1_PROT &&
1311 	    be32_to_cpu(sdt->ref_tag) != (sector & 0xffffffff)) {
1312 		pr_err("DIFv1 Type 1 reference failed on sector: %llu tag: 0x%08x"
1313 		       " sector MSB: 0x%08x\n", (unsigned long long)sector,
1314 		       be32_to_cpu(sdt->ref_tag), (u32)(sector & 0xffffffff));
1315 		return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED;
1316 	}
1317 
1318 	if (cmd->prot_type == TARGET_DIF_TYPE2_PROT &&
1319 	    be32_to_cpu(sdt->ref_tag) != ei_lba) {
1320 		pr_err("DIFv1 Type 2 reference failed on sector: %llu tag: 0x%08x"
1321 		       " ei_lba: 0x%08x\n", (unsigned long long)sector,
1322 			be32_to_cpu(sdt->ref_tag), ei_lba);
1323 		return TCM_LOGICAL_BLOCK_REF_TAG_CHECK_FAILED;
1324 	}
1325 
1326 	return 0;
1327 }
1328 
sbc_dif_copy_prot(struct se_cmd * cmd,unsigned int sectors,bool read,struct scatterlist * sg,int sg_off)1329 void sbc_dif_copy_prot(struct se_cmd *cmd, unsigned int sectors, bool read,
1330 		       struct scatterlist *sg, int sg_off)
1331 {
1332 	struct se_device *dev = cmd->se_dev;
1333 	struct scatterlist *psg;
1334 	void *paddr, *addr;
1335 	unsigned int i, len, left;
1336 	unsigned int offset = sg_off;
1337 
1338 	if (!sg)
1339 		return;
1340 
1341 	left = sectors * dev->prot_length;
1342 
1343 	for_each_sg(cmd->t_prot_sg, psg, cmd->t_prot_nents, i) {
1344 		unsigned int psg_len, copied = 0;
1345 
1346 		paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1347 		psg_len = min(left, psg->length);
1348 		while (psg_len) {
1349 			len = min(psg_len, sg->length - offset);
1350 			addr = kmap_atomic(sg_page(sg)) + sg->offset + offset;
1351 
1352 			if (read)
1353 				memcpy(paddr + copied, addr, len);
1354 			else
1355 				memcpy(addr, paddr + copied, len);
1356 
1357 			left -= len;
1358 			offset += len;
1359 			copied += len;
1360 			psg_len -= len;
1361 
1362 			kunmap_atomic(addr - sg->offset - offset);
1363 
1364 			if (offset >= sg->length) {
1365 				sg = sg_next(sg);
1366 				offset = 0;
1367 			}
1368 		}
1369 		kunmap_atomic(paddr - psg->offset);
1370 	}
1371 }
1372 EXPORT_SYMBOL(sbc_dif_copy_prot);
1373 
1374 sense_reason_t
sbc_dif_verify(struct se_cmd * cmd,sector_t start,unsigned int sectors,unsigned int ei_lba,struct scatterlist * psg,int psg_off)1375 sbc_dif_verify(struct se_cmd *cmd, sector_t start, unsigned int sectors,
1376 	       unsigned int ei_lba, struct scatterlist *psg, int psg_off)
1377 {
1378 	struct se_device *dev = cmd->se_dev;
1379 	struct t10_pi_tuple *sdt;
1380 	struct scatterlist *dsg = cmd->t_data_sg;
1381 	sector_t sector = start;
1382 	void *daddr, *paddr;
1383 	int i;
1384 	sense_reason_t rc;
1385 	int dsg_off = 0;
1386 	unsigned int block_size = dev->dev_attrib.block_size;
1387 
1388 	for (; psg && sector < start + sectors; psg = sg_next(psg)) {
1389 		paddr = kmap_atomic(sg_page(psg)) + psg->offset;
1390 		daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1391 
1392 		for (i = psg_off; i < psg->length &&
1393 				sector < start + sectors;
1394 				i += sizeof(*sdt)) {
1395 			__u16 crc;
1396 			unsigned int avail;
1397 
1398 			if (dsg_off >= dsg->length) {
1399 				dsg_off -= dsg->length;
1400 				kunmap_atomic(daddr - dsg->offset);
1401 				dsg = sg_next(dsg);
1402 				if (!dsg) {
1403 					kunmap_atomic(paddr - psg->offset);
1404 					return 0;
1405 				}
1406 				daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1407 			}
1408 
1409 			sdt = paddr + i;
1410 
1411 			pr_debug("DIF READ sector: %llu guard_tag: 0x%04x"
1412 				 " app_tag: 0x%04x ref_tag: %u\n",
1413 				 (unsigned long long)sector, sdt->guard_tag,
1414 				 sdt->app_tag, be32_to_cpu(sdt->ref_tag));
1415 
1416 			if (sdt->app_tag == T10_PI_APP_ESCAPE) {
1417 				dsg_off += block_size;
1418 				goto next;
1419 			}
1420 
1421 			avail = min(block_size, dsg->length - dsg_off);
1422 			crc = crc_t10dif(daddr + dsg_off, avail);
1423 			if (avail < block_size) {
1424 				kunmap_atomic(daddr - dsg->offset);
1425 				dsg = sg_next(dsg);
1426 				if (!dsg) {
1427 					kunmap_atomic(paddr - psg->offset);
1428 					return 0;
1429 				}
1430 				daddr = kmap_atomic(sg_page(dsg)) + dsg->offset;
1431 				dsg_off = block_size - avail;
1432 				crc = crc_t10dif_update(crc, daddr, dsg_off);
1433 			} else {
1434 				dsg_off += block_size;
1435 			}
1436 
1437 			rc = sbc_dif_v1_verify(cmd, sdt, crc, sector, ei_lba);
1438 			if (rc) {
1439 				kunmap_atomic(daddr - dsg->offset);
1440 				kunmap_atomic(paddr - psg->offset);
1441 				cmd->bad_sector = sector;
1442 				return rc;
1443 			}
1444 next:
1445 			sector++;
1446 			ei_lba++;
1447 		}
1448 
1449 		psg_off = 0;
1450 		kunmap_atomic(daddr - dsg->offset);
1451 		kunmap_atomic(paddr - psg->offset);
1452 	}
1453 
1454 	return 0;
1455 }
1456 EXPORT_SYMBOL(sbc_dif_verify);
1457