target_core_sbc.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961
  1. /*
  2. * SCSI Block Commands (SBC) parsing and emulation.
  3. *
  4. * (c) Copyright 2002-2013 Datera, Inc.
  5. *
  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. #include <linux/kernel.h>
  23. #include <linux/module.h>
  24. #include <linux/ratelimit.h>
  25. #include <asm/unaligned.h>
  26. #include <scsi/scsi.h>
  27. #include <scsi/scsi_tcq.h>
  28. #include <target/target_core_base.h>
  29. #include <target/target_core_backend.h>
  30. #include <target/target_core_fabric.h>
  31. #include "target_core_internal.h"
  32. #include "target_core_ua.h"
  33. static sense_reason_t
  34. sbc_emulate_readcapacity(struct se_cmd *cmd)
  35. {
  36. struct se_device *dev = cmd->se_dev;
  37. unsigned char *cdb = cmd->t_task_cdb;
  38. unsigned long long blocks_long = dev->transport->get_blocks(dev);
  39. unsigned char *rbuf;
  40. unsigned char buf[8];
  41. u32 blocks;
  42. /*
  43. * SBC-2 says:
  44. * If the PMI bit is set to zero and the LOGICAL BLOCK
  45. * ADDRESS field is not set to zero, the device server shall
  46. * terminate the command with CHECK CONDITION status with
  47. * the sense key set to ILLEGAL REQUEST and the additional
  48. * sense code set to INVALID FIELD IN CDB.
  49. *
  50. * In SBC-3, these fields are obsolete, but some SCSI
  51. * compliance tests actually check this, so we might as well
  52. * follow SBC-2.
  53. */
  54. if (!(cdb[8] & 1) && !!(cdb[2] | cdb[3] | cdb[4] | cdb[5]))
  55. return TCM_INVALID_CDB_FIELD;
  56. if (blocks_long >= 0x00000000ffffffff)
  57. blocks = 0xffffffff;
  58. else
  59. blocks = (u32)blocks_long;
  60. buf[0] = (blocks >> 24) & 0xff;
  61. buf[1] = (blocks >> 16) & 0xff;
  62. buf[2] = (blocks >> 8) & 0xff;
  63. buf[3] = blocks & 0xff;
  64. buf[4] = (dev->dev_attrib.block_size >> 24) & 0xff;
  65. buf[5] = (dev->dev_attrib.block_size >> 16) & 0xff;
  66. buf[6] = (dev->dev_attrib.block_size >> 8) & 0xff;
  67. buf[7] = dev->dev_attrib.block_size & 0xff;
  68. rbuf = transport_kmap_data_sg(cmd);
  69. if (rbuf) {
  70. memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
  71. transport_kunmap_data_sg(cmd);
  72. }
  73. target_complete_cmd(cmd, GOOD);
  74. return 0;
  75. }
  76. static sense_reason_t
  77. sbc_emulate_readcapacity_16(struct se_cmd *cmd)
  78. {
  79. struct se_device *dev = cmd->se_dev;
  80. unsigned char *rbuf;
  81. unsigned char buf[32];
  82. unsigned long long blocks = dev->transport->get_blocks(dev);
  83. memset(buf, 0, sizeof(buf));
  84. buf[0] = (blocks >> 56) & 0xff;
  85. buf[1] = (blocks >> 48) & 0xff;
  86. buf[2] = (blocks >> 40) & 0xff;
  87. buf[3] = (blocks >> 32) & 0xff;
  88. buf[4] = (blocks >> 24) & 0xff;
  89. buf[5] = (blocks >> 16) & 0xff;
  90. buf[6] = (blocks >> 8) & 0xff;
  91. buf[7] = blocks & 0xff;
  92. buf[8] = (dev->dev_attrib.block_size >> 24) & 0xff;
  93. buf[9] = (dev->dev_attrib.block_size >> 16) & 0xff;
  94. buf[10] = (dev->dev_attrib.block_size >> 8) & 0xff;
  95. buf[11] = dev->dev_attrib.block_size & 0xff;
  96. if (dev->transport->get_lbppbe)
  97. buf[13] = dev->transport->get_lbppbe(dev) & 0x0f;
  98. if (dev->transport->get_alignment_offset_lbas) {
  99. u16 lalba = dev->transport->get_alignment_offset_lbas(dev);
  100. buf[14] = (lalba >> 8) & 0x3f;
  101. buf[15] = lalba & 0xff;
  102. }
  103. /*
  104. * Set Thin Provisioning Enable bit following sbc3r22 in section
  105. * READ CAPACITY (16) byte 14 if emulate_tpu or emulate_tpws is enabled.
  106. */
  107. if (dev->dev_attrib.emulate_tpu || dev->dev_attrib.emulate_tpws)
  108. buf[14] |= 0x80;
  109. rbuf = transport_kmap_data_sg(cmd);
  110. if (rbuf) {
  111. memcpy(rbuf, buf, min_t(u32, sizeof(buf), cmd->data_length));
  112. transport_kunmap_data_sg(cmd);
  113. }
  114. target_complete_cmd(cmd, GOOD);
  115. return 0;
  116. }
  117. sector_t sbc_get_write_same_sectors(struct se_cmd *cmd)
  118. {
  119. u32 num_blocks;
  120. if (cmd->t_task_cdb[0] == WRITE_SAME)
  121. num_blocks = get_unaligned_be16(&cmd->t_task_cdb[7]);
  122. else if (cmd->t_task_cdb[0] == WRITE_SAME_16)
  123. num_blocks = get_unaligned_be32(&cmd->t_task_cdb[10]);
  124. else /* WRITE_SAME_32 via VARIABLE_LENGTH_CMD */
  125. num_blocks = get_unaligned_be32(&cmd->t_task_cdb[28]);
  126. /*
  127. * Use the explicit range when non zero is supplied, otherwise calculate
  128. * the remaining range based on ->get_blocks() - starting LBA.
  129. */
  130. if (num_blocks)
  131. return num_blocks;
  132. return cmd->se_dev->transport->get_blocks(cmd->se_dev) -
  133. cmd->t_task_lba + 1;
  134. }
  135. EXPORT_SYMBOL(sbc_get_write_same_sectors);
  136. static sense_reason_t
  137. sbc_emulate_noop(struct se_cmd *cmd)
  138. {
  139. target_complete_cmd(cmd, GOOD);
  140. return 0;
  141. }
  142. static inline u32 sbc_get_size(struct se_cmd *cmd, u32 sectors)
  143. {
  144. return cmd->se_dev->dev_attrib.block_size * sectors;
  145. }
  146. static int sbc_check_valid_sectors(struct se_cmd *cmd)
  147. {
  148. struct se_device *dev = cmd->se_dev;
  149. unsigned long long end_lba;
  150. u32 sectors;
  151. sectors = cmd->data_length / dev->dev_attrib.block_size;
  152. end_lba = dev->transport->get_blocks(dev) + 1;
  153. if (cmd->t_task_lba + sectors > end_lba) {
  154. pr_err("target: lba %llu, sectors %u exceeds end lba %llu\n",
  155. cmd->t_task_lba, sectors, end_lba);
  156. return -EINVAL;
  157. }
  158. return 0;
  159. }
  160. static inline u32 transport_get_sectors_6(unsigned char *cdb)
  161. {
  162. /*
  163. * Use 8-bit sector value. SBC-3 says:
  164. *
  165. * A TRANSFER LENGTH field set to zero specifies that 256
  166. * logical blocks shall be written. Any other value
  167. * specifies the number of logical blocks that shall be
  168. * written.
  169. */
  170. return cdb[4] ? : 256;
  171. }
  172. static inline u32 transport_get_sectors_10(unsigned char *cdb)
  173. {
  174. return (u32)(cdb[7] << 8) + cdb[8];
  175. }
  176. static inline u32 transport_get_sectors_12(unsigned char *cdb)
  177. {
  178. return (u32)(cdb[6] << 24) + (cdb[7] << 16) + (cdb[8] << 8) + cdb[9];
  179. }
  180. static inline u32 transport_get_sectors_16(unsigned char *cdb)
  181. {
  182. return (u32)(cdb[10] << 24) + (cdb[11] << 16) +
  183. (cdb[12] << 8) + cdb[13];
  184. }
  185. /*
  186. * Used for VARIABLE_LENGTH_CDB WRITE_32 and READ_32 variants
  187. */
  188. static inline u32 transport_get_sectors_32(unsigned char *cdb)
  189. {
  190. return (u32)(cdb[28] << 24) + (cdb[29] << 16) +
  191. (cdb[30] << 8) + cdb[31];
  192. }
  193. static inline u32 transport_lba_21(unsigned char *cdb)
  194. {
  195. return ((cdb[1] & 0x1f) << 16) | (cdb[2] << 8) | cdb[3];
  196. }
  197. static inline u32 transport_lba_32(unsigned char *cdb)
  198. {
  199. return (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
  200. }
  201. static inline unsigned long long transport_lba_64(unsigned char *cdb)
  202. {
  203. unsigned int __v1, __v2;
  204. __v1 = (cdb[2] << 24) | (cdb[3] << 16) | (cdb[4] << 8) | cdb[5];
  205. __v2 = (cdb[6] << 24) | (cdb[7] << 16) | (cdb[8] << 8) | cdb[9];
  206. return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
  207. }
  208. /*
  209. * For VARIABLE_LENGTH_CDB w/ 32 byte extended CDBs
  210. */
  211. static inline unsigned long long transport_lba_64_ext(unsigned char *cdb)
  212. {
  213. unsigned int __v1, __v2;
  214. __v1 = (cdb[12] << 24) | (cdb[13] << 16) | (cdb[14] << 8) | cdb[15];
  215. __v2 = (cdb[16] << 24) | (cdb[17] << 16) | (cdb[18] << 8) | cdb[19];
  216. return ((unsigned long long)__v2) | (unsigned long long)__v1 << 32;
  217. }
  218. static sense_reason_t
  219. sbc_setup_write_same(struct se_cmd *cmd, unsigned char *flags, struct sbc_ops *ops)
  220. {
  221. unsigned int sectors = sbc_get_write_same_sectors(cmd);
  222. if ((flags[0] & 0x04) || (flags[0] & 0x02)) {
  223. pr_err("WRITE_SAME PBDATA and LBDATA"
  224. " bits not supported for Block Discard"
  225. " Emulation\n");
  226. return TCM_UNSUPPORTED_SCSI_OPCODE;
  227. }
  228. if (sectors > cmd->se_dev->dev_attrib.max_write_same_len) {
  229. pr_warn("WRITE_SAME sectors: %u exceeds max_write_same_len: %u\n",
  230. sectors, cmd->se_dev->dev_attrib.max_write_same_len);
  231. return TCM_INVALID_CDB_FIELD;
  232. }
  233. /* We always have ANC_SUP == 0 so setting ANCHOR is always an error */
  234. if (flags[0] & 0x10) {
  235. pr_warn("WRITE SAME with ANCHOR not supported\n");
  236. return TCM_INVALID_CDB_FIELD;
  237. }
  238. /*
  239. * Special case for WRITE_SAME w/ UNMAP=1 that ends up getting
  240. * translated into block discard requests within backend code.
  241. */
  242. if (flags[0] & 0x08) {
  243. if (!ops->execute_write_same_unmap)
  244. return TCM_UNSUPPORTED_SCSI_OPCODE;
  245. cmd->execute_cmd = ops->execute_write_same_unmap;
  246. return 0;
  247. }
  248. if (!ops->execute_write_same)
  249. return TCM_UNSUPPORTED_SCSI_OPCODE;
  250. cmd->execute_cmd = ops->execute_write_same;
  251. return 0;
  252. }
  253. static sense_reason_t xdreadwrite_callback(struct se_cmd *cmd)
  254. {
  255. unsigned char *buf, *addr;
  256. struct scatterlist *sg;
  257. unsigned int offset;
  258. sense_reason_t ret = TCM_NO_SENSE;
  259. int i, count;
  260. /*
  261. * From sbc3r22.pdf section 5.48 XDWRITEREAD (10) command
  262. *
  263. * 1) read the specified logical block(s);
  264. * 2) transfer logical blocks from the data-out buffer;
  265. * 3) XOR the logical blocks transferred from the data-out buffer with
  266. * the logical blocks read, storing the resulting XOR data in a buffer;
  267. * 4) if the DISABLE WRITE bit is set to zero, then write the logical
  268. * blocks transferred from the data-out buffer; and
  269. * 5) transfer the resulting XOR data to the data-in buffer.
  270. */
  271. buf = kmalloc(cmd->data_length, GFP_KERNEL);
  272. if (!buf) {
  273. pr_err("Unable to allocate xor_callback buf\n");
  274. return TCM_OUT_OF_RESOURCES;
  275. }
  276. /*
  277. * Copy the scatterlist WRITE buffer located at cmd->t_data_sg
  278. * into the locally allocated *buf
  279. */
  280. sg_copy_to_buffer(cmd->t_data_sg,
  281. cmd->t_data_nents,
  282. buf,
  283. cmd->data_length);
  284. /*
  285. * Now perform the XOR against the BIDI read memory located at
  286. * cmd->t_mem_bidi_list
  287. */
  288. offset = 0;
  289. for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, count) {
  290. addr = kmap_atomic(sg_page(sg));
  291. if (!addr) {
  292. ret = TCM_OUT_OF_RESOURCES;
  293. goto out;
  294. }
  295. for (i = 0; i < sg->length; i++)
  296. *(addr + sg->offset + i) ^= *(buf + offset + i);
  297. offset += sg->length;
  298. kunmap_atomic(addr);
  299. }
  300. out:
  301. kfree(buf);
  302. return ret;
  303. }
  304. static sense_reason_t
  305. sbc_execute_rw(struct se_cmd *cmd)
  306. {
  307. return cmd->execute_rw(cmd, cmd->t_data_sg, cmd->t_data_nents,
  308. cmd->data_direction);
  309. }
  310. static sense_reason_t compare_and_write_post(struct se_cmd *cmd)
  311. {
  312. struct se_device *dev = cmd->se_dev;
  313. /*
  314. * Only set SCF_COMPARE_AND_WRITE_POST to force a response fall-through
  315. * within target_complete_ok_work() if the command was successfully
  316. * sent to the backend driver.
  317. */
  318. spin_lock_irq(&cmd->t_state_lock);
  319. if ((cmd->transport_state & CMD_T_SENT) && !cmd->scsi_status)
  320. cmd->se_cmd_flags |= SCF_COMPARE_AND_WRITE_POST;
  321. spin_unlock_irq(&cmd->t_state_lock);
  322. /*
  323. * Unlock ->caw_sem originally obtained during sbc_compare_and_write()
  324. * before the original READ I/O submission.
  325. */
  326. up(&dev->caw_sem);
  327. return TCM_NO_SENSE;
  328. }
  329. static sense_reason_t compare_and_write_callback(struct se_cmd *cmd)
  330. {
  331. struct se_device *dev = cmd->se_dev;
  332. struct scatterlist *write_sg = NULL, *sg;
  333. unsigned char *buf = NULL, *addr;
  334. struct sg_mapping_iter m;
  335. unsigned int offset = 0, len;
  336. unsigned int nlbas = cmd->t_task_nolb;
  337. unsigned int block_size = dev->dev_attrib.block_size;
  338. unsigned int compare_len = (nlbas * block_size);
  339. sense_reason_t ret = TCM_NO_SENSE;
  340. int rc, i;
  341. /*
  342. * Handle early failure in transport_generic_request_failure(),
  343. * which will not have taken ->caw_mutex yet..
  344. */
  345. if (!cmd->t_data_sg || !cmd->t_bidi_data_sg)
  346. return TCM_NO_SENSE;
  347. /*
  348. * Immediately exit + release dev->caw_sem if command has already
  349. * been failed with a non-zero SCSI status.
  350. */
  351. if (cmd->scsi_status) {
  352. pr_err("compare_and_write_callback: non zero scsi_status:"
  353. " 0x%02x\n", cmd->scsi_status);
  354. goto out;
  355. }
  356. buf = kzalloc(cmd->data_length, GFP_KERNEL);
  357. if (!buf) {
  358. pr_err("Unable to allocate compare_and_write buf\n");
  359. ret = TCM_OUT_OF_RESOURCES;
  360. goto out;
  361. }
  362. write_sg = kzalloc(sizeof(struct scatterlist) * cmd->t_data_nents,
  363. GFP_KERNEL);
  364. if (!write_sg) {
  365. pr_err("Unable to allocate compare_and_write sg\n");
  366. ret = TCM_OUT_OF_RESOURCES;
  367. goto out;
  368. }
  369. /*
  370. * Setup verify and write data payloads from total NumberLBAs.
  371. */
  372. rc = sg_copy_to_buffer(cmd->t_data_sg, cmd->t_data_nents, buf,
  373. cmd->data_length);
  374. if (!rc) {
  375. pr_err("sg_copy_to_buffer() failed for compare_and_write\n");
  376. ret = TCM_OUT_OF_RESOURCES;
  377. goto out;
  378. }
  379. /*
  380. * Compare against SCSI READ payload against verify payload
  381. */
  382. for_each_sg(cmd->t_bidi_data_sg, sg, cmd->t_bidi_data_nents, i) {
  383. addr = (unsigned char *)kmap_atomic(sg_page(sg));
  384. if (!addr) {
  385. ret = TCM_OUT_OF_RESOURCES;
  386. goto out;
  387. }
  388. len = min(sg->length, compare_len);
  389. if (memcmp(addr, buf + offset, len)) {
  390. pr_warn("Detected MISCOMPARE for addr: %p buf: %p\n",
  391. addr, buf + offset);
  392. kunmap_atomic(addr);
  393. goto miscompare;
  394. }
  395. kunmap_atomic(addr);
  396. offset += len;
  397. compare_len -= len;
  398. if (!compare_len)
  399. break;
  400. }
  401. i = 0;
  402. len = cmd->t_task_nolb * block_size;
  403. sg_miter_start(&m, cmd->t_data_sg, cmd->t_data_nents, SG_MITER_TO_SG);
  404. /*
  405. * Currently assumes NoLB=1 and SGLs are PAGE_SIZE..
  406. */
  407. while (len) {
  408. sg_miter_next(&m);
  409. if (block_size < PAGE_SIZE) {
  410. sg_set_page(&write_sg[i], m.page, block_size,
  411. block_size);
  412. } else {
  413. sg_miter_next(&m);
  414. sg_set_page(&write_sg[i], m.page, block_size,
  415. 0);
  416. }
  417. len -= block_size;
  418. i++;
  419. }
  420. sg_miter_stop(&m);
  421. /*
  422. * Save the original SGL + nents values before updating to new
  423. * assignments, to be released in transport_free_pages() ->
  424. * transport_reset_sgl_orig()
  425. */
  426. cmd->t_data_sg_orig = cmd->t_data_sg;
  427. cmd->t_data_sg = write_sg;
  428. cmd->t_data_nents_orig = cmd->t_data_nents;
  429. cmd->t_data_nents = 1;
  430. cmd->sam_task_attr = MSG_HEAD_TAG;
  431. cmd->transport_complete_callback = compare_and_write_post;
  432. /*
  433. * Now reset ->execute_cmd() to the normal sbc_execute_rw() handler
  434. * for submitting the adjusted SGL to write instance user-data.
  435. */
  436. cmd->execute_cmd = sbc_execute_rw;
  437. spin_lock_irq(&cmd->t_state_lock);
  438. cmd->t_state = TRANSPORT_PROCESSING;
  439. cmd->transport_state |= CMD_T_ACTIVE|CMD_T_BUSY|CMD_T_SENT;
  440. spin_unlock_irq(&cmd->t_state_lock);
  441. __target_execute_cmd(cmd);
  442. kfree(buf);
  443. return ret;
  444. miscompare:
  445. pr_warn("Target/%s: Send MISCOMPARE check condition and sense\n",
  446. dev->transport->name);
  447. ret = TCM_MISCOMPARE_VERIFY;
  448. out:
  449. /*
  450. * In the MISCOMPARE or failure case, unlock ->caw_sem obtained in
  451. * sbc_compare_and_write() before the original READ I/O submission.
  452. */
  453. up(&dev->caw_sem);
  454. kfree(write_sg);
  455. kfree(buf);
  456. return ret;
  457. }
  458. static sense_reason_t
  459. sbc_compare_and_write(struct se_cmd *cmd)
  460. {
  461. struct se_device *dev = cmd->se_dev;
  462. sense_reason_t ret;
  463. int rc;
  464. /*
  465. * Submit the READ first for COMPARE_AND_WRITE to perform the
  466. * comparision using SGLs at cmd->t_bidi_data_sg..
  467. */
  468. rc = down_interruptible(&dev->caw_sem);
  469. if ((rc != 0) || signal_pending(current)) {
  470. cmd->transport_complete_callback = NULL;
  471. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  472. }
  473. /*
  474. * Reset cmd->data_length to individual block_size in order to not
  475. * confuse backend drivers that depend on this value matching the
  476. * size of the I/O being submitted.
  477. */
  478. cmd->data_length = cmd->t_task_nolb * dev->dev_attrib.block_size;
  479. ret = cmd->execute_rw(cmd, cmd->t_bidi_data_sg, cmd->t_bidi_data_nents,
  480. DMA_FROM_DEVICE);
  481. if (ret) {
  482. cmd->transport_complete_callback = NULL;
  483. up(&dev->caw_sem);
  484. return ret;
  485. }
  486. /*
  487. * Unlock of dev->caw_sem to occur in compare_and_write_callback()
  488. * upon MISCOMPARE, or in compare_and_write_done() upon completion
  489. * of WRITE instance user-data.
  490. */
  491. return TCM_NO_SENSE;
  492. }
  493. sense_reason_t
  494. sbc_parse_cdb(struct se_cmd *cmd, struct sbc_ops *ops)
  495. {
  496. struct se_device *dev = cmd->se_dev;
  497. unsigned char *cdb = cmd->t_task_cdb;
  498. unsigned int size;
  499. u32 sectors = 0;
  500. sense_reason_t ret;
  501. switch (cdb[0]) {
  502. case READ_6:
  503. sectors = transport_get_sectors_6(cdb);
  504. cmd->t_task_lba = transport_lba_21(cdb);
  505. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  506. cmd->execute_rw = ops->execute_rw;
  507. cmd->execute_cmd = sbc_execute_rw;
  508. break;
  509. case READ_10:
  510. sectors = transport_get_sectors_10(cdb);
  511. cmd->t_task_lba = transport_lba_32(cdb);
  512. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  513. cmd->execute_rw = ops->execute_rw;
  514. cmd->execute_cmd = sbc_execute_rw;
  515. break;
  516. case READ_12:
  517. sectors = transport_get_sectors_12(cdb);
  518. cmd->t_task_lba = transport_lba_32(cdb);
  519. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  520. cmd->execute_rw = ops->execute_rw;
  521. cmd->execute_cmd = sbc_execute_rw;
  522. break;
  523. case READ_16:
  524. sectors = transport_get_sectors_16(cdb);
  525. cmd->t_task_lba = transport_lba_64(cdb);
  526. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  527. cmd->execute_rw = ops->execute_rw;
  528. cmd->execute_cmd = sbc_execute_rw;
  529. break;
  530. case WRITE_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;
  534. cmd->execute_rw = ops->execute_rw;
  535. cmd->execute_cmd = sbc_execute_rw;
  536. break;
  537. case WRITE_10:
  538. case WRITE_VERIFY:
  539. sectors = transport_get_sectors_10(cdb);
  540. cmd->t_task_lba = transport_lba_32(cdb);
  541. if (cdb[1] & 0x8)
  542. cmd->se_cmd_flags |= SCF_FUA;
  543. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  544. cmd->execute_rw = ops->execute_rw;
  545. cmd->execute_cmd = sbc_execute_rw;
  546. break;
  547. case WRITE_12:
  548. sectors = transport_get_sectors_12(cdb);
  549. cmd->t_task_lba = transport_lba_32(cdb);
  550. if (cdb[1] & 0x8)
  551. cmd->se_cmd_flags |= SCF_FUA;
  552. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  553. cmd->execute_rw = ops->execute_rw;
  554. cmd->execute_cmd = sbc_execute_rw;
  555. break;
  556. case WRITE_16:
  557. sectors = transport_get_sectors_16(cdb);
  558. cmd->t_task_lba = transport_lba_64(cdb);
  559. if (cdb[1] & 0x8)
  560. cmd->se_cmd_flags |= SCF_FUA;
  561. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  562. cmd->execute_rw = ops->execute_rw;
  563. cmd->execute_cmd = sbc_execute_rw;
  564. break;
  565. case XDWRITEREAD_10:
  566. if (cmd->data_direction != DMA_TO_DEVICE ||
  567. !(cmd->se_cmd_flags & SCF_BIDI))
  568. return TCM_INVALID_CDB_FIELD;
  569. sectors = transport_get_sectors_10(cdb);
  570. cmd->t_task_lba = transport_lba_32(cdb);
  571. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  572. /*
  573. * Setup BIDI XOR callback to be run after I/O completion.
  574. */
  575. cmd->execute_rw = ops->execute_rw;
  576. cmd->execute_cmd = sbc_execute_rw;
  577. cmd->transport_complete_callback = &xdreadwrite_callback;
  578. if (cdb[1] & 0x8)
  579. cmd->se_cmd_flags |= SCF_FUA;
  580. break;
  581. case VARIABLE_LENGTH_CMD:
  582. {
  583. u16 service_action = get_unaligned_be16(&cdb[8]);
  584. switch (service_action) {
  585. case XDWRITEREAD_32:
  586. sectors = transport_get_sectors_32(cdb);
  587. /*
  588. * Use WRITE_32 and READ_32 opcodes for the emulated
  589. * XDWRITE_READ_32 logic.
  590. */
  591. cmd->t_task_lba = transport_lba_64_ext(cdb);
  592. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB;
  593. /*
  594. * Setup BIDI XOR callback to be run during after I/O
  595. * completion.
  596. */
  597. cmd->execute_rw = ops->execute_rw;
  598. cmd->execute_cmd = sbc_execute_rw;
  599. cmd->transport_complete_callback = &xdreadwrite_callback;
  600. if (cdb[1] & 0x8)
  601. cmd->se_cmd_flags |= SCF_FUA;
  602. break;
  603. case WRITE_SAME_32:
  604. sectors = transport_get_sectors_32(cdb);
  605. if (!sectors) {
  606. pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not"
  607. " supported\n");
  608. return TCM_INVALID_CDB_FIELD;
  609. }
  610. size = sbc_get_size(cmd, 1);
  611. cmd->t_task_lba = get_unaligned_be64(&cdb[12]);
  612. ret = sbc_setup_write_same(cmd, &cdb[10], ops);
  613. if (ret)
  614. return ret;
  615. break;
  616. default:
  617. pr_err("VARIABLE_LENGTH_CMD service action"
  618. " 0x%04x not supported\n", service_action);
  619. return TCM_UNSUPPORTED_SCSI_OPCODE;
  620. }
  621. break;
  622. }
  623. case COMPARE_AND_WRITE:
  624. sectors = cdb[13];
  625. /*
  626. * Currently enforce COMPARE_AND_WRITE for a single sector
  627. */
  628. if (sectors > 1) {
  629. pr_err("COMPARE_AND_WRITE contains NoLB: %u greater"
  630. " than 1\n", sectors);
  631. return TCM_INVALID_CDB_FIELD;
  632. }
  633. /*
  634. * Double size because we have two buffers, note that
  635. * zero is not an error..
  636. */
  637. size = 2 * sbc_get_size(cmd, sectors);
  638. cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
  639. cmd->t_task_nolb = sectors;
  640. cmd->se_cmd_flags |= SCF_SCSI_DATA_CDB | SCF_COMPARE_AND_WRITE;
  641. cmd->execute_rw = ops->execute_rw;
  642. cmd->execute_cmd = sbc_compare_and_write;
  643. cmd->transport_complete_callback = compare_and_write_callback;
  644. break;
  645. case READ_CAPACITY:
  646. size = READ_CAP_LEN;
  647. cmd->execute_cmd = sbc_emulate_readcapacity;
  648. break;
  649. case SERVICE_ACTION_IN:
  650. switch (cmd->t_task_cdb[1] & 0x1f) {
  651. case SAI_READ_CAPACITY_16:
  652. cmd->execute_cmd = sbc_emulate_readcapacity_16;
  653. break;
  654. default:
  655. pr_err("Unsupported SA: 0x%02x\n",
  656. cmd->t_task_cdb[1] & 0x1f);
  657. return TCM_INVALID_CDB_FIELD;
  658. }
  659. size = (cdb[10] << 24) | (cdb[11] << 16) |
  660. (cdb[12] << 8) | cdb[13];
  661. break;
  662. case SYNCHRONIZE_CACHE:
  663. case SYNCHRONIZE_CACHE_16:
  664. if (!ops->execute_sync_cache) {
  665. size = 0;
  666. cmd->execute_cmd = sbc_emulate_noop;
  667. break;
  668. }
  669. /*
  670. * Extract LBA and range to be flushed for emulated SYNCHRONIZE_CACHE
  671. */
  672. if (cdb[0] == SYNCHRONIZE_CACHE) {
  673. sectors = transport_get_sectors_10(cdb);
  674. cmd->t_task_lba = transport_lba_32(cdb);
  675. } else {
  676. sectors = transport_get_sectors_16(cdb);
  677. cmd->t_task_lba = transport_lba_64(cdb);
  678. }
  679. size = sbc_get_size(cmd, sectors);
  680. /*
  681. * Check to ensure that LBA + Range does not exceed past end of
  682. * device for IBLOCK and FILEIO ->do_sync_cache() backend calls
  683. */
  684. if (cmd->t_task_lba || sectors) {
  685. if (sbc_check_valid_sectors(cmd) < 0)
  686. return TCM_ADDRESS_OUT_OF_RANGE;
  687. }
  688. cmd->execute_cmd = ops->execute_sync_cache;
  689. break;
  690. case UNMAP:
  691. if (!ops->execute_unmap)
  692. return TCM_UNSUPPORTED_SCSI_OPCODE;
  693. size = get_unaligned_be16(&cdb[7]);
  694. cmd->execute_cmd = ops->execute_unmap;
  695. break;
  696. case WRITE_SAME_16:
  697. sectors = transport_get_sectors_16(cdb);
  698. if (!sectors) {
  699. pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
  700. return TCM_INVALID_CDB_FIELD;
  701. }
  702. size = sbc_get_size(cmd, 1);
  703. cmd->t_task_lba = get_unaligned_be64(&cdb[2]);
  704. ret = sbc_setup_write_same(cmd, &cdb[1], ops);
  705. if (ret)
  706. return ret;
  707. break;
  708. case WRITE_SAME:
  709. sectors = transport_get_sectors_10(cdb);
  710. if (!sectors) {
  711. pr_err("WSNZ=1, WRITE_SAME w/sectors=0 not supported\n");
  712. return TCM_INVALID_CDB_FIELD;
  713. }
  714. size = sbc_get_size(cmd, 1);
  715. cmd->t_task_lba = get_unaligned_be32(&cdb[2]);
  716. /*
  717. * Follow sbcr26 with WRITE_SAME (10) and check for the existence
  718. * of byte 1 bit 3 UNMAP instead of original reserved field
  719. */
  720. ret = sbc_setup_write_same(cmd, &cdb[1], ops);
  721. if (ret)
  722. return ret;
  723. break;
  724. case VERIFY:
  725. size = 0;
  726. cmd->execute_cmd = sbc_emulate_noop;
  727. break;
  728. case REZERO_UNIT:
  729. case SEEK_6:
  730. case SEEK_10:
  731. /*
  732. * There are still clients out there which use these old SCSI-2
  733. * commands. This mainly happens when running VMs with legacy
  734. * guest systems, connected via SCSI command pass-through to
  735. * iSCSI targets. Make them happy and return status GOOD.
  736. */
  737. size = 0;
  738. cmd->execute_cmd = sbc_emulate_noop;
  739. break;
  740. default:
  741. ret = spc_parse_cdb(cmd, &size);
  742. if (ret)
  743. return ret;
  744. }
  745. /* reject any command that we don't have a handler for */
  746. if (!(cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) && !cmd->execute_cmd)
  747. return TCM_UNSUPPORTED_SCSI_OPCODE;
  748. if (cmd->se_cmd_flags & SCF_SCSI_DATA_CDB) {
  749. unsigned long long end_lba;
  750. if (sectors > dev->dev_attrib.fabric_max_sectors) {
  751. printk_ratelimited(KERN_ERR "SCSI OP %02xh with too"
  752. " big sectors %u exceeds fabric_max_sectors:"
  753. " %u\n", cdb[0], sectors,
  754. dev->dev_attrib.fabric_max_sectors);
  755. return TCM_INVALID_CDB_FIELD;
  756. }
  757. if (sectors > dev->dev_attrib.hw_max_sectors) {
  758. printk_ratelimited(KERN_ERR "SCSI OP %02xh with too"
  759. " big sectors %u exceeds backend hw_max_sectors:"
  760. " %u\n", cdb[0], sectors,
  761. dev->dev_attrib.hw_max_sectors);
  762. return TCM_INVALID_CDB_FIELD;
  763. }
  764. end_lba = dev->transport->get_blocks(dev) + 1;
  765. if (cmd->t_task_lba + sectors > end_lba) {
  766. pr_err("cmd exceeds last lba %llu "
  767. "(lba %llu, sectors %u)\n",
  768. end_lba, cmd->t_task_lba, sectors);
  769. return TCM_ADDRESS_OUT_OF_RANGE;
  770. }
  771. if (!(cmd->se_cmd_flags & SCF_COMPARE_AND_WRITE))
  772. size = sbc_get_size(cmd, sectors);
  773. }
  774. return target_cmd_size_check(cmd, size);
  775. }
  776. EXPORT_SYMBOL(sbc_parse_cdb);
  777. u32 sbc_get_device_type(struct se_device *dev)
  778. {
  779. return TYPE_DISK;
  780. }
  781. EXPORT_SYMBOL(sbc_get_device_type);
  782. sense_reason_t
  783. sbc_execute_unmap(struct se_cmd *cmd,
  784. sense_reason_t (*do_unmap_fn)(struct se_cmd *, void *,
  785. sector_t, sector_t),
  786. void *priv)
  787. {
  788. struct se_device *dev = cmd->se_dev;
  789. unsigned char *buf, *ptr = NULL;
  790. sector_t lba;
  791. int size;
  792. u32 range;
  793. sense_reason_t ret = 0;
  794. int dl, bd_dl;
  795. /* We never set ANC_SUP */
  796. if (cmd->t_task_cdb[1])
  797. return TCM_INVALID_CDB_FIELD;
  798. if (cmd->data_length == 0) {
  799. target_complete_cmd(cmd, SAM_STAT_GOOD);
  800. return 0;
  801. }
  802. if (cmd->data_length < 8) {
  803. pr_warn("UNMAP parameter list length %u too small\n",
  804. cmd->data_length);
  805. return TCM_PARAMETER_LIST_LENGTH_ERROR;
  806. }
  807. buf = transport_kmap_data_sg(cmd);
  808. if (!buf)
  809. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  810. dl = get_unaligned_be16(&buf[0]);
  811. bd_dl = get_unaligned_be16(&buf[2]);
  812. size = cmd->data_length - 8;
  813. if (bd_dl > size)
  814. pr_warn("UNMAP parameter list length %u too small, ignoring bd_dl %u\n",
  815. cmd->data_length, bd_dl);
  816. else
  817. size = bd_dl;
  818. if (size / 16 > dev->dev_attrib.max_unmap_block_desc_count) {
  819. ret = TCM_INVALID_PARAMETER_LIST;
  820. goto err;
  821. }
  822. /* First UNMAP block descriptor starts at 8 byte offset */
  823. ptr = &buf[8];
  824. pr_debug("UNMAP: Sub: %s Using dl: %u bd_dl: %u size: %u"
  825. " ptr: %p\n", dev->transport->name, dl, bd_dl, size, ptr);
  826. while (size >= 16) {
  827. lba = get_unaligned_be64(&ptr[0]);
  828. range = get_unaligned_be32(&ptr[8]);
  829. pr_debug("UNMAP: Using lba: %llu and range: %u\n",
  830. (unsigned long long)lba, range);
  831. if (range > dev->dev_attrib.max_unmap_lba_count) {
  832. ret = TCM_INVALID_PARAMETER_LIST;
  833. goto err;
  834. }
  835. if (lba + range > dev->transport->get_blocks(dev) + 1) {
  836. ret = TCM_ADDRESS_OUT_OF_RANGE;
  837. goto err;
  838. }
  839. ret = do_unmap_fn(cmd, priv, lba, range);
  840. if (ret)
  841. goto err;
  842. ptr += 16;
  843. size -= 16;
  844. }
  845. err:
  846. transport_kunmap_data_sg(cmd);
  847. if (!ret)
  848. target_complete_cmd(cmd, GOOD);
  849. return ret;
  850. }
  851. EXPORT_SYMBOL(sbc_execute_unmap);