blob: 5c822fdc8f6f5eb346e3873ed0fc6df5f983666e [file] [log] [blame]
Christoph Hellwigd6e01752012-05-20 11:59:14 -04001/*
2 * SCSI Block Commands (SBC) parsing and emulation.
3 *
Nicholas Bellingerfd9a11d2012-11-09 14:51:48 -08004 * (c) Copyright 2002-2012 RisingTide Systems LLC.
Christoph Hellwigd6e01752012-05-20 11:59:14 -04005 *
6 * Nicholas A. Bellinger <nab@kernel.org>
7 *
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.
12 *
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.
17 *
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.
21 */
22
23#include <linux/kernel.h>
24#include <linux/module.h>
25#include <linux/ratelimit.h>
26#include <asm/unaligned.h>
27#include <scsi/scsi.h>
Nicholas Bellinger68ff9b92013-08-19 15:20:28 -070028#include <scsi/scsi_tcq.h>
Christoph Hellwigd6e01752012-05-20 11:59:14 -040029
30#include <target/target_core_base.h>
31#include <target/target_core_backend.h>
32#include <target/target_core_fabric.h>
33
34#include "target_core_internal.h"
35#include "target_core_ua.h"
36
37
Christoph Hellwigde103c92012-11-06 12:24:09 -080038static sense_reason_t
39sbc_emulate_readcapacity(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040040{
41 struct se_device *dev = cmd->se_dev;
Roland Dreier8dc86322013-06-26 17:36:19 -070042 unsigned char *cdb = cmd->t_task_cdb;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040043 unsigned long long blocks_long = dev->transport->get_blocks(dev);
Paolo Bonzinia50da142012-09-07 17:30:40 +020044 unsigned char *rbuf;
45 unsigned char buf[8];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040046 u32 blocks;
47
Roland Dreier8dc86322013-06-26 17:36:19 -070048 /*
49 * SBC-2 says:
50 * If the PMI bit is set to zero and the LOGICAL BLOCK
51 * ADDRESS field is not set to zero, the device server shall
52 * terminate the command with CHECK CONDITION status with
53 * the sense key set to ILLEGAL REQUEST and the additional
54 * sense code set to INVALID FIELD IN CDB.
55 *
56 * In SBC-3, these fields are obsolete, but some SCSI
57 * compliance tests actually check this, so we might as well
58 * follow SBC-2.
59 */
60 if (!(cdb[8] & 1) && !!(cdb[2] | cdb[3] | cdb[4] | cdb[5]))
61 return TCM_INVALID_CDB_FIELD;
62
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040063 if (blocks_long >= 0x00000000ffffffff)
64 blocks = 0xffffffff;
65 else
66 blocks = (u32)blocks_long;
67
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040068 buf[0] = (blocks >> 24) & 0xff;
69 buf[1] = (blocks >> 16) & 0xff;
70 buf[2] = (blocks >> 8) & 0xff;
71 buf[3] = blocks & 0xff;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -040072 buf[4] = (dev->dev_attrib.block_size >> 24) & 0xff;
73 buf[5] = (dev->dev_attrib.block_size >> 16) & 0xff;
74 buf[6] = (dev->dev_attrib.block_size >> 8) & 0xff;
75 buf[7] = dev->dev_attrib.block_size & 0xff;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040076
Paolo Bonzinia50da142012-09-07 17:30:40 +020077 rbuf = transport_kmap_data_sg(cmd);
Nicholas Bellinger8b4b0dc2013-01-29 14:18:00 -080078 if (rbuf) {
79 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
80 transport_kunmap_data_sg(cmd);
81 }
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040082
83 target_complete_cmd(cmd, GOOD);
84 return 0;
85}
86
Christoph Hellwigde103c92012-11-06 12:24:09 -080087static sense_reason_t
88sbc_emulate_readcapacity_16(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040089{
90 struct se_device *dev = cmd->se_dev;
Paolo Bonzinia50da142012-09-07 17:30:40 +020091 unsigned char *rbuf;
92 unsigned char buf[32];
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040093 unsigned long long blocks = dev->transport->get_blocks(dev);
94
Paolo Bonzinia50da142012-09-07 17:30:40 +020095 memset(buf, 0, sizeof(buf));
Christoph Hellwig1fd032e2012-05-20 11:59:15 -040096 buf[0] = (blocks >> 56) & 0xff;
97 buf[1] = (blocks >> 48) & 0xff;
98 buf[2] = (blocks >> 40) & 0xff;
99 buf[3] = (blocks >> 32) & 0xff;
100 buf[4] = (blocks >> 24) & 0xff;
101 buf[5] = (blocks >> 16) & 0xff;
102 buf[6] = (blocks >> 8) & 0xff;
103 buf[7] = blocks & 0xff;
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400104 buf[8] = (dev->dev_attrib.block_size >> 24) & 0xff;
105 buf[9] = (dev->dev_attrib.block_size >> 16) & 0xff;
106 buf[10] = (dev->dev_attrib.block_size >> 8) & 0xff;
107 buf[11] = dev->dev_attrib.block_size & 0xff;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400108 /*
109 * Set Thin Provisioning Enable bit following sbc3r22 in section
110 * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
111 */
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400112 if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400113 buf[14] = 0x80;
114
Paolo Bonzinia50da142012-09-07 17:30:40 +0200115 rbuf = transport_kmap_data_sg(cmd);
Nicholas Bellinger8b4b0dc2013-01-29 14:18:00 -0800116 if (rbuf) {
117 memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
118 transport_kunmap_data_sg(cmd);
119 }
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400120
121 target_complete_cmd(cmd, GOOD);
122 return 0;
123}
124
Roland Dreier972b29c82013-02-22 09:52:57 -0800125sector_t sbc_get_write_same_sectors(struct se_cmd *cmd)
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400126{
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400127 u32 num_blocks;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400128
129 if (cmd->t_task_cdb[0] == WRITE_SAME)
130 num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
131 else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
132 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
133 else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
134 num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
135
136 /*
137 * Use the explicit range when non zero is supplied, otherwise calculate
138 * the remaining range based on ->get_blocks() - starting LBA.
139 */
Christoph Hellwig6f974e82012-06-17 18:40:54 -0400140 if (num_blocks)
141 return num_blocks;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400142
Christoph Hellwig6f974e82012-06-17 18:40:54 -0400143 return cmd->se_dev->transport->get_blocks(cmd->se_dev) -
144 cmd->t_task_lba + 1;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400145}
Roland Dreier972b29c82013-02-22 09:52:57 -0800146EXPORT_SYMBOL(sbc_get_write_same_sectors);
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400147
Christoph Hellwigde103c92012-11-06 12:24:09 -0800148static sense_reason_t
Nicholas Bellinger1920ed62012-11-06 20:59:41 -0800149sbc_emulate_noop(struct se_cmd *cmd)
Bernhard Kohl1a1ff382012-10-24 15:53:58 +0200150{
151 target_complete_cmd(cmd, GOOD);
152 return 0;
153}
154
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400155static inline u32 sbc_get_size(struct se_cmd *cmd, u32 sectors)
156{
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400157 return cmd->se_dev->dev_attrib.block_size * sectors;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400158}
159
160static int sbc_check_valid_sectors(struct se_cmd *cmd)
161{
162 struct se_device *dev = cmd->se_dev;
163 unsigned long long end_lba;
164 u32 sectors;
165
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400166 sectors = cmd->data_length / dev->dev_attrib.block_size;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400167 end_lba = dev->transport->get_blocks(dev) + 1;
168
169 if (cmd->t_task_lba + sectors > end_lba) {
170 pr_err("target: lba %llu, sectors %u exceeds end lba %llu\n",
171 cmd->t_task_lba, sectors, end_lba);
172 return -EINVAL;
173 }
174
175 return 0;
176}
177
178static inline u32 transport_get_sectors_6(unsigned char *cdb)
179{
180 /*
181 * Use 8-bit sector value. SBC-3 says:
182 *
183 * A TRANSFER LENGTH field set to zero specifies that 256
184 * logical blocks shall be written. Any other value
185 * specifies the number of logical blocks that shall be
186 * written.
187 */
188 return cdb[4] ? : 256;
189}
190
191static inline u32 transport_get_sectors_10(unsigned char *cdb)
192{
193 return (u32)(cdb[7] << 8) + cdb[8];
194}
195
196static inline u32 transport_get_sectors_12(unsigned char *cdb)
197{
198 return (u32)(cdb[6] << 24) + (cdb[7] << 16) + (cdb[8] << 8) + cdb[9];
199}
200
201static inline u32 transport_get_sectors_16(unsigned char *cdb)
202{
203 return (u32)(cdb[10] << 24) + (cdb[11] << 16) +
204 (cdb[12] << 8) + cdb[13];
205}
206
207/*
208 * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
209 */
210static inline u32 transport_get_sectors_32(unsigned char *cdb)
211{
212 return (u32)(cdb[28] << 24) + (cdb[29] << 16) +
213 (cdb[30] << 8) + cdb[31];
214
215}
216
217static inline u32 transport_lba_21(unsigned char *cdb)
218{
219 return ((cdb[1] & 0x1f) << 16) | (cdb[2] << 8) | cdb[3];
220}
221
222static inline u32 transport_lba_32(unsigned char *cdb)
223{
224 return (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
225}
226
227static inline unsigned long long transport_lba_64(unsigned char *cdb)
228{
229 unsigned int __v1, __v2;
230
231 __v1 = (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
232 __v2 = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
233
234 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
235}
236
237/*
238 * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
239 */
240static inline unsigned long long transport_lba_64_ext(unsigned char *cdb)
241{
242 unsigned int __v1, __v2;
243
244 __v1 = (cdb[12] << 24) | (cdb[13] << 16) | (cdb[14] << 8) | cdb[15];
245 __v2 = (cdb[16] << 24) | (cdb[17] << 16) | (cdb[18] << 8) | cdb[19];
246
247 return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
248}
249
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800250static sense_reason_t
251sbc_setup_write_same(struct se_cmd *cmd, unsigned char *flags, struct sbc_ops *ops)
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400252{
Roland Dreier972b29c82013-02-22 09:52:57 -0800253 unsigned int sectors = sbc_get_write_same_sectors(cmd);
Nicholas Bellinger773cbaf2012-11-15 11:02:49 -0800254
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400255 if ((flags[0] & 0x04) || (flags[0] & 0x02)) {
256 pr_err("WRITE_SAME PBDATA and LBDATA"
257 " bits not supported for Block Discard"
258 " Emulation\n");
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800259 return TCM_UNSUPPORTED_SCSI_OPCODE;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400260 }
Nicholas Bellinger773cbaf2012-11-15 11:02:49 -0800261 if (sectors > cmd->se_dev->dev_attrib.max_write_same_len) {
262 pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
263 sectors, cmd->se_dev->dev_attrib.max_write_same_len);
264 return TCM_INVALID_CDB_FIELD;
265 }
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400266 /*
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800267 * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
268 * translated into block discard requests within backend code.
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400269 */
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800270 if (flags[0] & 0x08) {
271 if (!ops->execute_write_same_unmap)
272 return TCM_UNSUPPORTED_SCSI_OPCODE;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400273
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800274 cmd->execute_cmd = ops->execute_write_same_unmap;
275 return 0;
276 }
277 if (!ops->execute_write_same)
278 return TCM_UNSUPPORTED_SCSI_OPCODE;
279
280 cmd->execute_cmd = ops->execute_write_same;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400281 return 0;
282}
283
Nicholas Bellingera6b01332013-08-19 14:34:17 -0700284static sense_reason_t xdreadwrite_callback(struct se_cmd *cmd)
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400285{
286 unsigned char *buf, *addr;
287 struct scatterlist *sg;
288 unsigned int offset;
Nicholas Bellingera6b01332013-08-19 14:34:17 -0700289 sense_reason_t ret = TCM_NO_SENSE;
290 int i, count;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400291 /*
292 * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
293 *
294 * 1) read the specified logical block(s);
295 * 2) transfer logical blocks from the data-out buffer;
296 * 3) XOR the logical blocks transferred from the data-out buffer with
297 * the logical blocks read, storing the resulting XOR data in a buffer;
298 * 4) if the DISABLE WRITE bit is set to zero, then write the logical
299 * blocks transferred from the data-out buffer; and
300 * 5) transfer the resulting XOR data to the data-in buffer.
301 */
302 buf = kmalloc(cmd->data_length, GFP_KERNEL);
303 if (!buf) {
304 pr_err("Unable to allocate xor_callback buf\n");
Nicholas Bellingera6b01332013-08-19 14:34:17 -0700305 return TCM_OUT_OF_RESOURCES;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400306 }
307 /*
308 * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
309 * into the locally allocated *buf
310 */
311 sg_copy_to_buffer(cmd->t_data_sg,
312 cmd->t_data_nents,
313 buf,
314 cmd->data_length);
315
316 /*
317 * Now perform the XOR against the BIDI read memory located at
318 * cmd->t_mem_bidi_list
319 */
320
321 offset = 0;
322 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, count) {
323 addr = kmap_atomic(sg_page(sg));
Nicholas Bellingera6b01332013-08-19 14:34:17 -0700324 if (!addr) {
325 ret = TCM_OUT_OF_RESOURCES;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400326 goto out;
Nicholas Bellingera6b01332013-08-19 14:34:17 -0700327 }
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400328
329 for (i = 0; i < sg->length; i++)
330 *(addr + sg->offset + i) ^= *(buf + offset + i);
331
332 offset += sg->length;
333 kunmap_atomic(addr);
334 }
335
336out:
337 kfree(buf);
Nicholas Bellingera6b01332013-08-19 14:34:17 -0700338 return ret;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400339}
340
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700341static sense_reason_t
342sbc_execute_rw(struct se_cmd *cmd)
343{
344 return cmd->execute_rw(cmd, cmd->t_data_sg, cmd->t_data_nents,
345 cmd->data_direction);
346}
347
Nicholas Bellinger68ff9b92013-08-19 15:20:28 -0700348static sense_reason_t compare_and_write_post(struct se_cmd *cmd)
349{
350 struct se_device *dev = cmd->se_dev;
351
352 cmd->se_cmd_flags |= SCF_COMPARE_AND_WRITE_POST;
353 /*
354 * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
355 * before the original READ I/O submission.
356 */
357 up(&dev->caw_sem);
358
359 return TCM_NO_SENSE;
360}
361
362static sense_reason_t compare_and_write_callback(struct se_cmd *cmd)
363{
364 struct se_device *dev = cmd->se_dev;
365 struct scatterlist *write_sg = NULL, *sg;
366 unsigned char *buf, *addr;
367 struct sg_mapping_iter m;
368 unsigned int offset = 0, len;
369 unsigned int nlbas = cmd->t_task_nolb;
370 unsigned int block_size = dev->dev_attrib.block_size;
371 unsigned int compare_len = (nlbas * block_size);
372 sense_reason_t ret = TCM_NO_SENSE;
373 int rc, i;
374
375 buf = kzalloc(cmd->data_length, GFP_KERNEL);
376 if (!buf) {
377 pr_err("Unable to allocate compare_and_write buf\n");
Nicholas Bellingera2890082013-08-21 18:10:04 -0700378 ret = TCM_OUT_OF_RESOURCES;
379 goto out;
Nicholas Bellinger68ff9b92013-08-19 15:20:28 -0700380 }
381
382 write_sg = kzalloc(sizeof(struct scatterlist) * cmd->t_data_nents,
383 GFP_KERNEL);
384 if (!write_sg) {
385 pr_err("Unable to allocate compare_and_write sg\n");
386 ret = TCM_OUT_OF_RESOURCES;
387 goto out;
388 }
389 /*
390 * Setup verify and write data payloads from total NumberLBAs.
391 */
392 rc = sg_copy_to_buffer(cmd->t_data_sg, cmd->t_data_nents, buf,
393 cmd->data_length);
394 if (!rc) {
395 pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
396 ret = TCM_OUT_OF_RESOURCES;
397 goto out;
398 }
399 /*
400 * Compare against SCSI READ payload against verify payload
401 */
402 for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, i) {
403 addr = (unsigned char *)kmap_atomic(sg_page(sg));
404 if (!addr) {
405 ret = TCM_OUT_OF_RESOURCES;
406 goto out;
407 }
408
409 len = min(sg->length, compare_len);
410
411 if (memcmp(addr, buf + offset, len)) {
412 pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
413 addr, buf + offset);
414 kunmap_atomic(addr);
415 goto miscompare;
416 }
417 kunmap_atomic(addr);
418
419 offset += len;
420 compare_len -= len;
421 if (!compare_len)
422 break;
423 }
424
425 i = 0;
426 len = cmd->t_task_nolb * block_size;
427 sg_miter_start(&m, cmd->t_data_sg, cmd->t_data_nents, SG_MITER_TO_SG);
428 /*
429 * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
430 */
431 while (len) {
432 sg_miter_next(&m);
433
434 if (block_size < PAGE_SIZE) {
435 sg_set_page(&write_sg[i], m.page, block_size,
436 block_size);
437 } else {
438 sg_miter_next(&m);
439 sg_set_page(&write_sg[i], m.page, block_size,
440 0);
441 }
442 len -= block_size;
443 i++;
444 }
445 sg_miter_stop(&m);
446 /*
447 * Save the original SGL + nents values before updating to new
448 * assignments, to be released in transport_free_pages() ->
449 * transport_reset_sgl_orig()
450 */
451 cmd->t_data_sg_orig = cmd->t_data_sg;
452 cmd->t_data_sg = write_sg;
453 cmd->t_data_nents_orig = cmd->t_data_nents;
454 cmd->t_data_nents = 1;
455
456 cmd->sam_task_attr = MSG_HEAD_TAG;
457 cmd->transport_complete_callback = compare_and_write_post;
458 /*
459 * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
460 * for submitting the adjusted SGL to write instance user-data.
461 */
462 cmd->execute_cmd = sbc_execute_rw;
463
464 spin_lock_irq(&cmd->t_state_lock);
465 cmd->t_state = TRANSPORT_PROCESSING;
466 cmd->transport_state |= CMD_T_ACTIVE|CMD_T_BUSY|CMD_T_SENT;
467 spin_unlock_irq(&cmd->t_state_lock);
468
469 __target_execute_cmd(cmd);
470
471 kfree(buf);
472 return ret;
473
474miscompare:
475 pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
476 dev->transport->name);
477 ret = TCM_MISCOMPARE_VERIFY;
478out:
479 /*
480 * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
481 * sbc_compare_and_write() before the original READ I/O submission.
482 */
483 up(&dev->caw_sem);
484 kfree(write_sg);
485 kfree(buf);
486 return ret;
487}
488
489static sense_reason_t
490sbc_compare_and_write(struct se_cmd *cmd)
491{
492 struct se_device *dev = cmd->se_dev;
493 sense_reason_t ret;
494 int rc;
495 /*
496 * Submit the READ first for COMPARE_AND_WRITE to perform the
497 * comparision using SGLs at cmd->t_bidi_data_sg..
498 */
499 rc = down_interruptible(&dev->caw_sem);
500 if ((rc != 0) || signal_pending(current)) {
501 cmd->transport_complete_callback = NULL;
502 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
503 }
504
505 ret = cmd->execute_rw(cmd, cmd->t_bidi_data_sg, cmd->t_bidi_data_nents,
506 DMA_FROM_DEVICE);
507 if (ret) {
508 cmd->transport_complete_callback = NULL;
509 up(&dev->caw_sem);
510 return ret;
511 }
512 /*
513 * Unlock of dev->caw_sem to occur in compare_and_write_callback()
514 * upon MISCOMPARE, or in compare_and_write_done() upon completion
515 * of WRITE instance user-data.
516 */
517 return TCM_NO_SENSE;
518}
519
Christoph Hellwigde103c92012-11-06 12:24:09 -0800520sense_reason_t
521sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops)
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400522{
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400523 struct se_device *dev = cmd->se_dev;
524 unsigned char *cdb = cmd->t_task_cdb;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400525 unsigned int size;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400526 u32 sectors = 0;
Christoph Hellwigde103c92012-11-06 12:24:09 -0800527 sense_reason_t ret;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400528
529 switch (cdb[0]) {
530 case READ_6:
531 sectors = transport_get_sectors_6(cdb);
532 cmd->t_task_lba = transport_lba_21(cdb);
533 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700534 cmd->execute_rw = ops->execute_rw;
535 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400536 break;
537 case READ_10:
538 sectors = transport_get_sectors_10(cdb);
539 cmd->t_task_lba = transport_lba_32(cdb);
540 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700541 cmd->execute_rw = ops->execute_rw;
542 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400543 break;
544 case READ_12:
545 sectors = transport_get_sectors_12(cdb);
546 cmd->t_task_lba = transport_lba_32(cdb);
547 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700548 cmd->execute_rw = ops->execute_rw;
549 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400550 break;
551 case READ_16:
552 sectors = transport_get_sectors_16(cdb);
553 cmd->t_task_lba = transport_lba_64(cdb);
554 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700555 cmd->execute_rw = ops->execute_rw;
556 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400557 break;
558 case WRITE_6:
559 sectors = transport_get_sectors_6(cdb);
560 cmd->t_task_lba = transport_lba_21(cdb);
561 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700562 cmd->execute_rw = ops->execute_rw;
563 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400564 break;
565 case WRITE_10:
566 case WRITE_VERIFY:
567 sectors = transport_get_sectors_10(cdb);
568 cmd->t_task_lba = transport_lba_32(cdb);
569 if (cdb[1] & 0x8)
570 cmd->se_cmd_flags |= SCF_FUA;
571 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700572 cmd->execute_rw = ops->execute_rw;
573 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400574 break;
575 case WRITE_12:
576 sectors = transport_get_sectors_12(cdb);
577 cmd->t_task_lba = transport_lba_32(cdb);
578 if (cdb[1] & 0x8)
579 cmd->se_cmd_flags |= SCF_FUA;
580 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700581 cmd->execute_rw = ops->execute_rw;
582 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400583 break;
584 case WRITE_16:
585 sectors = transport_get_sectors_16(cdb);
586 cmd->t_task_lba = transport_lba_64(cdb);
587 if (cdb[1] & 0x8)
588 cmd->se_cmd_flags |= SCF_FUA;
589 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700590 cmd->execute_rw = ops->execute_rw;
591 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400592 break;
593 case XDWRITEREAD_10:
Christoph Hellwigde103c92012-11-06 12:24:09 -0800594 if (cmd->data_direction != DMA_TO_DEVICE ||
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400595 !(cmd->se_cmd_flags & SCF_BIDI))
Christoph Hellwigde103c92012-11-06 12:24:09 -0800596 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400597 sectors = transport_get_sectors_10(cdb);
598
599 cmd->t_task_lba = transport_lba_32(cdb);
600 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
601
602 /*
603 * Setup BIDI XOR callback to be run after I/O completion.
604 */
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700605 cmd->execute_rw = ops->execute_rw;
606 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400607 cmd->transport_complete_callback = &xdreadwrite_callback;
608 if (cdb[1] & 0x8)
609 cmd->se_cmd_flags |= SCF_FUA;
610 break;
611 case VARIABLE_LENGTH_CMD:
612 {
613 u16 service_action = get_unaligned_be16(&cdb[8]);
614 switch (service_action) {
615 case XDWRITEREAD_32:
616 sectors = transport_get_sectors_32(cdb);
617
618 /*
619 * Use WRITE_32 and READ_32 opcodes for the emulated
620 * XDWRITE_READ_32 logic.
621 */
622 cmd->t_task_lba = transport_lba_64_ext(cdb);
623 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
624
625 /*
626 * Setup BIDI XOR callback to be run during after I/O
627 * completion.
628 */
Nicholas Bellingera82a9532013-08-19 23:57:30 -0700629 cmd->execute_rw = ops->execute_rw;
630 cmd->execute_cmd = sbc_execute_rw;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400631 cmd->transport_complete_callback = &xdreadwrite_callback;
632 if (cdb[1] & 0x8)
633 cmd->se_cmd_flags |= SCF_FUA;
634 break;
635 case WRITE_SAME_32:
636 sectors = transport_get_sectors_32(cdb);
637 if (!sectors) {
638 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
639 " supported\n");
Christoph Hellwigde103c92012-11-06 12:24:09 -0800640 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400641 }
642
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400643 size = sbc_get_size(cmd, 1);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400644 cmd->t_task_lba = get_unaligned_be64(&cdb[12]);
645
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800646 ret = sbc_setup_write_same(cmd, &cdb[10], ops);
Dan Carpenter6b64e1f2012-11-27 17:27:01 +0300647 if (ret)
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800648 return ret;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400649 break;
650 default:
651 pr_err("VARIABLE_LENGTH_CMD service action"
652 " 0x%04x not supported\n", service_action);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800653 return TCM_UNSUPPORTED_SCSI_OPCODE;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400654 }
655 break;
656 }
Nicholas Bellinger68ff9b92013-08-19 15:20:28 -0700657 case COMPARE_AND_WRITE:
658 sectors = cdb[13];
659 /*
660 * Currently enforce COMPARE_AND_WRITE for a single sector
661 */
662 if (sectors > 1) {
663 pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
664 " than 1\n", sectors);
665 return TCM_INVALID_CDB_FIELD;
666 }
667 /*
668 * Double size because we have two buffers, note that
669 * zero is not an error..
670 */
671 size = 2 * sbc_get_size(cmd, sectors);
672 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
673 cmd->t_task_nolb = sectors;
674 cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB | SCF_COMPARE_AND_WRITE;
675 cmd->execute_rw = ops->execute_rw;
676 cmd->execute_cmd = sbc_compare_and_write;
677 cmd->transport_complete_callback = compare_and_write_callback;
678 break;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400679 case READ_CAPACITY:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400680 size = READ_CAP_LEN;
681 cmd->execute_cmd = sbc_emulate_readcapacity;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400682 break;
683 case SERVICE_ACTION_IN:
684 switch (cmd->t_task_cdb[1] & 0x1f) {
685 case SAI_READ_CAPACITY_16:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400686 cmd->execute_cmd = sbc_emulate_readcapacity_16;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400687 break;
688 default:
689 pr_err("Unsupported SA: 0x%02x\n",
690 cmd->t_task_cdb[1] & 0x1f);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800691 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400692 }
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400693 size = (cdb[10] << 24) | (cdb[11] << 16) |
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400694 (cdb[12] << 8) | cdb[13];
695 break;
696 case SYNCHRONIZE_CACHE:
697 case SYNCHRONIZE_CACHE_16:
Hannes Reinecke882e3f82013-03-04 14:08:06 +0100698 if (!ops->execute_sync_cache) {
699 size = 0;
700 cmd->execute_cmd = sbc_emulate_noop;
701 break;
702 }
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400703
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400704 /*
705 * Extract LBA and range to be flushed for emulated SYNCHRONIZE_CACHE
706 */
707 if (cdb[0] == SYNCHRONIZE_CACHE) {
708 sectors = transport_get_sectors_10(cdb);
709 cmd->t_task_lba = transport_lba_32(cdb);
710 } else {
711 sectors = transport_get_sectors_16(cdb);
712 cmd->t_task_lba = transport_lba_64(cdb);
713 }
714
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400715 size = sbc_get_size(cmd, sectors);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400716
717 /*
718 * Check to ensure that LBA + Range does not exceed past end of
719 * device for IBLOCK and FILEIO ->do_sync_cache() backend calls
720 */
721 if (cmd->t_task_lba || sectors) {
722 if (sbc_check_valid_sectors(cmd) < 0)
Roland Dreier33633672013-02-08 15:18:38 -0800723 return TCM_ADDRESS_OUT_OF_RANGE;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400724 }
Christoph Hellwigad67f0d2012-06-17 18:40:53 -0400725 cmd->execute_cmd = ops->execute_sync_cache;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400726 break;
727 case UNMAP:
Christoph Hellwig14150a62012-06-17 18:40:55 -0400728 if (!ops->execute_unmap)
Christoph Hellwigde103c92012-11-06 12:24:09 -0800729 return TCM_UNSUPPORTED_SCSI_OPCODE;
Christoph Hellwig14150a62012-06-17 18:40:55 -0400730
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400731 size = get_unaligned_be16(&cdb[7]);
Christoph Hellwig14150a62012-06-17 18:40:55 -0400732 cmd->execute_cmd = ops->execute_unmap;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400733 break;
734 case WRITE_SAME_16:
735 sectors = transport_get_sectors_16(cdb);
736 if (!sectors) {
737 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
Christoph Hellwigde103c92012-11-06 12:24:09 -0800738 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400739 }
740
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400741 size = sbc_get_size(cmd, 1);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400742 cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
743
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800744 ret = sbc_setup_write_same(cmd, &cdb[1], ops);
Dan Carpenter6b64e1f2012-11-27 17:27:01 +0300745 if (ret)
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800746 return ret;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400747 break;
748 case WRITE_SAME:
749 sectors = transport_get_sectors_10(cdb);
750 if (!sectors) {
751 pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
Christoph Hellwigde103c92012-11-06 12:24:09 -0800752 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400753 }
754
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400755 size = sbc_get_size(cmd, 1);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400756 cmd->t_task_lba = get_unaligned_be32(&cdb[2]);
757
758 /*
759 * Follow sbcr26 with WRITE_SAME (10) and check for the existence
760 * of byte 1 bit 3 UNMAP instead of original reserved field
761 */
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800762 ret = sbc_setup_write_same(cmd, &cdb[1], ops);
Dan Carpenter6b64e1f2012-11-27 17:27:01 +0300763 if (ret)
Nicholas Bellingercd063be2012-11-07 20:01:10 -0800764 return ret;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400765 break;
766 case VERIFY:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400767 size = 0;
Nicholas Bellinger1920ed62012-11-06 20:59:41 -0800768 cmd->execute_cmd = sbc_emulate_noop;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400769 break;
Bernhard Kohl1a1ff382012-10-24 15:53:58 +0200770 case REZERO_UNIT:
771 case SEEK_6:
772 case SEEK_10:
773 /*
774 * There are still clients out there which use these old SCSI-2
775 * commands. This mainly happens when running VMs with legacy
776 * guest systems, connected via SCSI command pass-through to
777 * iSCSI targets. Make them happy and return status GOOD.
778 */
779 size = 0;
780 cmd->execute_cmd = sbc_emulate_noop;
781 break;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400782 default:
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400783 ret = spc_parse_cdb(cmd, &size);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400784 if (ret)
785 return ret;
786 }
787
788 /* reject any command that we don't have a handler for */
789 if (!(cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) && !cmd->execute_cmd)
Christoph Hellwigde103c92012-11-06 12:24:09 -0800790 return TCM_UNSUPPORTED_SCSI_OPCODE;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400791
792 if (cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) {
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400793 unsigned long long end_lba;
794
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400795 if (sectors > dev->dev_attrib.fabric_max_sectors) {
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400796 printk_ratelimited(KERN_ERR "SCSI OP %02xh with too"
797 " big sectors %u exceeds fabric_max_sectors:"
798 " %u\n", cdb[0], sectors,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400799 dev->dev_attrib.fabric_max_sectors);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800800 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400801 }
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400802 if (sectors > dev->dev_attrib.hw_max_sectors) {
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400803 printk_ratelimited(KERN_ERR "SCSI OP %02xh with too"
804 " big sectors %u exceeds backend hw_max_sectors:"
805 " %u\n", cdb[0], sectors,
Christoph Hellwig0fd97cc2012-10-08 00:03:19 -0400806 dev->dev_attrib.hw_max_sectors);
Christoph Hellwigde103c92012-11-06 12:24:09 -0800807 return TCM_INVALID_CDB_FIELD;
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400808 }
809
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400810 end_lba = dev->transport->get_blocks(dev) + 1;
811 if (cmd->t_task_lba + sectors > end_lba) {
812 pr_err("cmd exceeds last lba %llu "
813 "(lba %llu, sectors %u)\n",
814 end_lba, cmd->t_task_lba, sectors);
Roland Dreier09ceadc2013-06-26 17:36:18 -0700815 return TCM_ADDRESS_OUT_OF_RANGE;
Christoph Hellwig1fd032e2012-05-20 11:59:15 -0400816 }
817
Nicholas Bellinger68ff9b92013-08-19 15:20:28 -0700818 if (!(cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE))
819 size = sbc_get_size(cmd, sectors);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400820 }
821
Christoph Hellwigde103c92012-11-06 12:24:09 -0800822 return target_cmd_size_check(cmd, size);
Christoph Hellwigd6e01752012-05-20 11:59:14 -0400823}
824EXPORT_SYMBOL(sbc_parse_cdb);
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400825
Christoph Hellwig6f23ac82012-10-07 10:55:53 -0400826u32 sbc_get_device_type(struct se_device *dev)
827{
828 return TYPE_DISK;
829}
830EXPORT_SYMBOL(sbc_get_device_type);
Asias He86d71822013-02-25 14:03:46 +0800831
832sense_reason_t
833sbc_execute_unmap(struct se_cmd *cmd,
834 sense_reason_t (*do_unmap_fn)(struct se_cmd *, void *,
835 sector_t, sector_t),
836 void *priv)
837{
838 struct se_device *dev = cmd->se_dev;
839 unsigned char *buf, *ptr = NULL;
840 sector_t lba;
841 int size;
842 u32 range;
843 sense_reason_t ret = 0;
844 int dl, bd_dl;
845
846 /* We never set ANC_SUP */
847 if (cmd->t_task_cdb[1])
848 return TCM_INVALID_CDB_FIELD;
849
850 if (cmd->data_length == 0) {
851 target_complete_cmd(cmd, SAM_STAT_GOOD);
852 return 0;
853 }
854
855 if (cmd->data_length < 8) {
856 pr_warn("UNMAP parameter list length %u too small\n",
857 cmd->data_length);
858 return TCM_PARAMETER_LIST_LENGTH_ERROR;
859 }
860
861 buf = transport_kmap_data_sg(cmd);
862 if (!buf)
863 return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
864
865 dl = get_unaligned_be16(&buf[0]);
866 bd_dl = get_unaligned_be16(&buf[2]);
867
868 size = cmd->data_length - 8;
869 if (bd_dl > size)
870 pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
871 cmd->data_length, bd_dl);
872 else
873 size = bd_dl;
874
875 if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
876 ret = TCM_INVALID_PARAMETER_LIST;
877 goto err;
878 }
879
880 /* First UNMAP block descriptor starts at 8 byte offset */
881 ptr = &buf[8];
882 pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
883 " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
884
885 while (size >= 16) {
886 lba = get_unaligned_be64(&ptr[0]);
887 range = get_unaligned_be32(&ptr[8]);
888 pr_debug("UNMAP: Using lba: %llu and range: %u\n",
889 (unsigned long long)lba, range);
890
891 if (range > dev->dev_attrib.max_unmap_lba_count) {
892 ret = TCM_INVALID_PARAMETER_LIST;
893 goto err;
894 }
895
896 if (lba + range > dev->transport->get_blocks(dev) + 1) {
897 ret = TCM_ADDRESS_OUT_OF_RANGE;
898 goto err;
899 }
900
901 ret = do_unmap_fn(cmd, priv, lba, range);
902 if (ret)
903 goto err;
904
905 ptr += 16;
906 size -= 16;
907 }
908
909err:
910 transport_kunmap_data_sg(cmd);
911 if (!ret)
912 target_complete_cmd(cmd, GOOD);
913 return ret;
914}
915EXPORT_SYMBOL(sbc_execute_unmap);