target_core_file.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845
  1. /*******************************************************************************
  2. * Filename: target_core_file.c
  3. *
  4. * This file contains the Storage Engine <-> FILEIO transport specific functions
  5. *
  6. * (c) Copyright 2005-2013 Datera, Inc.
  7. *
  8. * Nicholas A. Bellinger <nab@kernel.org>
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of the GNU General Public License as published by
  12. * the Free Software Foundation; either version 2 of the License, or
  13. * (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU General Public License
  21. * along with this program; if not, write to the Free Software
  22. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23. *
  24. ******************************************************************************/
  25. #include <linux/string.h>
  26. #include <linux/parser.h>
  27. #include <linux/timer.h>
  28. #include <linux/blkdev.h>
  29. #include <linux/slab.h>
  30. #include <linux/spinlock.h>
  31. #include <linux/module.h>
  32. #include <linux/vmalloc.h>
  33. #include <linux/falloc.h>
  34. #include <linux/uio.h>
  35. #include <scsi/scsi_proto.h>
  36. #include <asm/unaligned.h>
  37. #include <target/target_core_base.h>
  38. #include <target/target_core_backend.h>
  39. #include "target_core_file.h"
  40. static inline struct fd_dev *FD_DEV(struct se_device *dev)
  41. {
  42. return container_of(dev, struct fd_dev, dev);
  43. }
  44. static int fd_attach_hba(struct se_hba *hba, u32 host_id)
  45. {
  46. struct fd_host *fd_host;
  47. fd_host = kzalloc(sizeof(struct fd_host), GFP_KERNEL);
  48. if (!fd_host) {
  49. pr_err("Unable to allocate memory for struct fd_host\n");
  50. return -ENOMEM;
  51. }
  52. fd_host->fd_host_id = host_id;
  53. hba->hba_ptr = fd_host;
  54. pr_debug("CORE_HBA[%d] - TCM FILEIO HBA Driver %s on Generic"
  55. " Target Core Stack %s\n", hba->hba_id, FD_VERSION,
  56. TARGET_CORE_VERSION);
  57. pr_debug("CORE_HBA[%d] - Attached FILEIO HBA: %u to Generic\n",
  58. hba->hba_id, fd_host->fd_host_id);
  59. return 0;
  60. }
  61. static void fd_detach_hba(struct se_hba *hba)
  62. {
  63. struct fd_host *fd_host = hba->hba_ptr;
  64. pr_debug("CORE_HBA[%d] - Detached FILEIO HBA: %u from Generic"
  65. " Target Core\n", hba->hba_id, fd_host->fd_host_id);
  66. kfree(fd_host);
  67. hba->hba_ptr = NULL;
  68. }
  69. static struct se_device *fd_alloc_device(struct se_hba *hba, const char *name)
  70. {
  71. struct fd_dev *fd_dev;
  72. struct fd_host *fd_host = hba->hba_ptr;
  73. fd_dev = kzalloc(sizeof(struct fd_dev), GFP_KERNEL);
  74. if (!fd_dev) {
  75. pr_err("Unable to allocate memory for struct fd_dev\n");
  76. return NULL;
  77. }
  78. fd_dev->fd_host = fd_host;
  79. pr_debug("FILEIO: Allocated fd_dev for %p\n", name);
  80. return &fd_dev->dev;
  81. }
  82. static int fd_configure_device(struct se_device *dev)
  83. {
  84. struct fd_dev *fd_dev = FD_DEV(dev);
  85. struct fd_host *fd_host = dev->se_hba->hba_ptr;
  86. struct file *file;
  87. struct inode *inode = NULL;
  88. int flags, ret = -EINVAL;
  89. if (!(fd_dev->fbd_flags & FBDF_HAS_PATH)) {
  90. pr_err("Missing fd_dev_name=\n");
  91. return -EINVAL;
  92. }
  93. /*
  94. * Use O_DSYNC by default instead of O_SYNC to forgo syncing
  95. * of pure timestamp updates.
  96. */
  97. flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
  98. /*
  99. * Optionally allow fd_buffered_io=1 to be enabled for people
  100. * who want use the fs buffer cache as an WriteCache mechanism.
  101. *
  102. * This means that in event of a hard failure, there is a risk
  103. * of silent data-loss if the SCSI client has *not* performed a
  104. * forced unit access (FUA) write, or issued SYNCHRONIZE_CACHE
  105. * to write-out the entire device cache.
  106. */
  107. if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
  108. pr_debug("FILEIO: Disabling O_DSYNC, using buffered FILEIO\n");
  109. flags &= ~O_DSYNC;
  110. }
  111. file = filp_open(fd_dev->fd_dev_name, flags, 0600);
  112. if (IS_ERR(file)) {
  113. pr_err("filp_open(%s) failed\n", fd_dev->fd_dev_name);
  114. ret = PTR_ERR(file);
  115. goto fail;
  116. }
  117. fd_dev->fd_file = file;
  118. /*
  119. * If using a block backend with this struct file, we extract
  120. * fd_dev->fd_[block,dev]_size from struct block_device.
  121. *
  122. * Otherwise, we use the passed fd_size= from configfs
  123. */
  124. inode = file->f_mapping->host;
  125. if (S_ISBLK(inode->i_mode)) {
  126. struct request_queue *q = bdev_get_queue(inode->i_bdev);
  127. unsigned long long dev_size;
  128. fd_dev->fd_block_size = bdev_logical_block_size(inode->i_bdev);
  129. /*
  130. * Determine the number of bytes from i_size_read() minus
  131. * one (1) logical sector from underlying struct block_device
  132. */
  133. dev_size = (i_size_read(file->f_mapping->host) -
  134. fd_dev->fd_block_size);
  135. pr_debug("FILEIO: Using size: %llu bytes from struct"
  136. " block_device blocks: %llu logical_block_size: %d\n",
  137. dev_size, div_u64(dev_size, fd_dev->fd_block_size),
  138. fd_dev->fd_block_size);
  139. if (target_configure_unmap_from_queue(&dev->dev_attrib, q))
  140. pr_debug("IFILE: BLOCK Discard support available,"
  141. " disabled by default\n");
  142. /*
  143. * Enable write same emulation for IBLOCK and use 0xFFFF as
  144. * the smaller WRITE_SAME(10) only has a two-byte block count.
  145. */
  146. dev->dev_attrib.max_write_same_len = 0xFFFF;
  147. if (blk_queue_nonrot(q))
  148. dev->dev_attrib.is_nonrot = 1;
  149. } else {
  150. if (!(fd_dev->fbd_flags & FBDF_HAS_SIZE)) {
  151. pr_err("FILEIO: Missing fd_dev_size="
  152. " parameter, and no backing struct"
  153. " block_device\n");
  154. goto fail;
  155. }
  156. fd_dev->fd_block_size = FD_BLOCKSIZE;
  157. /*
  158. * Limit UNMAP emulation to 8k Number of LBAs (NoLB)
  159. */
  160. dev->dev_attrib.max_unmap_lba_count = 0x2000;
  161. /*
  162. * Currently hardcoded to 1 in Linux/SCSI code..
  163. */
  164. dev->dev_attrib.max_unmap_block_desc_count = 1;
  165. dev->dev_attrib.unmap_granularity = 1;
  166. dev->dev_attrib.unmap_granularity_alignment = 0;
  167. /*
  168. * Limit WRITE_SAME w/ UNMAP=0 emulation to 8k Number of LBAs (NoLB)
  169. * based upon struct iovec limit for vfs_writev()
  170. */
  171. dev->dev_attrib.max_write_same_len = 0x1000;
  172. }
  173. dev->dev_attrib.hw_block_size = fd_dev->fd_block_size;
  174. dev->dev_attrib.max_bytes_per_io = FD_MAX_BYTES;
  175. dev->dev_attrib.hw_max_sectors = FD_MAX_BYTES / fd_dev->fd_block_size;
  176. dev->dev_attrib.hw_queue_depth = FD_MAX_DEVICE_QUEUE_DEPTH;
  177. if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) {
  178. pr_debug("FILEIO: Forcing setting of emulate_write_cache=1"
  179. " with FDBD_HAS_BUFFERED_IO_WCE\n");
  180. dev->dev_attrib.emulate_write_cache = 1;
  181. }
  182. fd_dev->fd_dev_id = fd_host->fd_host_dev_id_count++;
  183. fd_dev->fd_queue_depth = dev->queue_depth;
  184. pr_debug("CORE_FILE[%u] - Added TCM FILEIO Device ID: %u at %s,"
  185. " %llu total bytes\n", fd_host->fd_host_id, fd_dev->fd_dev_id,
  186. fd_dev->fd_dev_name, fd_dev->fd_dev_size);
  187. return 0;
  188. fail:
  189. if (fd_dev->fd_file) {
  190. filp_close(fd_dev->fd_file, NULL);
  191. fd_dev->fd_file = NULL;
  192. }
  193. return ret;
  194. }
  195. static void fd_dev_call_rcu(struct rcu_head *p)
  196. {
  197. struct se_device *dev = container_of(p, struct se_device, rcu_head);
  198. struct fd_dev *fd_dev = FD_DEV(dev);
  199. kfree(fd_dev);
  200. }
  201. static void fd_free_device(struct se_device *dev)
  202. {
  203. struct fd_dev *fd_dev = FD_DEV(dev);
  204. if (fd_dev->fd_file) {
  205. filp_close(fd_dev->fd_file, NULL);
  206. fd_dev->fd_file = NULL;
  207. }
  208. call_rcu(&dev->rcu_head, fd_dev_call_rcu);
  209. }
  210. static int fd_do_rw(struct se_cmd *cmd, struct file *fd,
  211. u32 block_size, struct scatterlist *sgl,
  212. u32 sgl_nents, u32 data_length, int is_write)
  213. {
  214. struct scatterlist *sg;
  215. struct iov_iter iter;
  216. struct bio_vec *bvec;
  217. ssize_t len = 0;
  218. loff_t pos = (cmd->t_task_lba * block_size);
  219. int ret = 0, i;
  220. bvec = kcalloc(sgl_nents, sizeof(struct bio_vec), GFP_KERNEL);
  221. if (!bvec) {
  222. pr_err("Unable to allocate fd_do_readv iov[]\n");
  223. return -ENOMEM;
  224. }
  225. for_each_sg(sgl, sg, sgl_nents, i) {
  226. bvec[i].bv_page = sg_page(sg);
  227. bvec[i].bv_len = sg->length;
  228. bvec[i].bv_offset = sg->offset;
  229. len += sg->length;
  230. }
  231. iov_iter_bvec(&iter, ITER_BVEC, bvec, sgl_nents, len);
  232. if (is_write)
  233. ret = vfs_iter_write(fd, &iter, &pos);
  234. else
  235. ret = vfs_iter_read(fd, &iter, &pos);
  236. kfree(bvec);
  237. if (is_write) {
  238. if (ret < 0 || ret != data_length) {
  239. pr_err("%s() write returned %d\n", __func__, ret);
  240. return (ret < 0 ? ret : -EINVAL);
  241. }
  242. } else {
  243. /*
  244. * Return zeros and GOOD status even if the READ did not return
  245. * the expected virt_size for struct file w/o a backing struct
  246. * block_device.
  247. */
  248. if (S_ISBLK(file_inode(fd)->i_mode)) {
  249. if (ret < 0 || ret != data_length) {
  250. pr_err("%s() returned %d, expecting %u for "
  251. "S_ISBLK\n", __func__, ret,
  252. data_length);
  253. return (ret < 0 ? ret : -EINVAL);
  254. }
  255. } else {
  256. if (ret < 0) {
  257. pr_err("%s() returned %d for non S_ISBLK\n",
  258. __func__, ret);
  259. return ret;
  260. }
  261. }
  262. }
  263. return 1;
  264. }
  265. static sense_reason_t
  266. fd_execute_sync_cache(struct se_cmd *cmd)
  267. {
  268. struct se_device *dev = cmd->se_dev;
  269. struct fd_dev *fd_dev = FD_DEV(dev);
  270. int immed = (cmd->t_task_cdb[1] & 0x2);
  271. loff_t start, end;
  272. int ret;
  273. /*
  274. * If the Immediate bit is set, queue up the GOOD response
  275. * for this SYNCHRONIZE_CACHE op
  276. */
  277. if (immed)
  278. target_complete_cmd(cmd, SAM_STAT_GOOD);
  279. /*
  280. * Determine if we will be flushing the entire device.
  281. */
  282. if (cmd->t_task_lba == 0 && cmd->data_length == 0) {
  283. start = 0;
  284. end = LLONG_MAX;
  285. } else {
  286. start = cmd->t_task_lba * dev->dev_attrib.block_size;
  287. if (cmd->data_length)
  288. end = start + cmd->data_length - 1;
  289. else
  290. end = LLONG_MAX;
  291. }
  292. ret = vfs_fsync_range(fd_dev->fd_file, start, end, 1);
  293. if (ret != 0)
  294. pr_err("FILEIO: vfs_fsync_range() failed: %d\n", ret);
  295. if (immed)
  296. return 0;
  297. if (ret)
  298. target_complete_cmd(cmd, SAM_STAT_CHECK_CONDITION);
  299. else
  300. target_complete_cmd(cmd, SAM_STAT_GOOD);
  301. return 0;
  302. }
  303. static sense_reason_t
  304. fd_execute_write_same(struct se_cmd *cmd)
  305. {
  306. struct se_device *se_dev = cmd->se_dev;
  307. struct fd_dev *fd_dev = FD_DEV(se_dev);
  308. loff_t pos = cmd->t_task_lba * se_dev->dev_attrib.block_size;
  309. sector_t nolb = sbc_get_write_same_sectors(cmd);
  310. struct iov_iter iter;
  311. struct bio_vec *bvec;
  312. unsigned int len = 0, i;
  313. ssize_t ret;
  314. if (!nolb) {
  315. target_complete_cmd(cmd, SAM_STAT_GOOD);
  316. return 0;
  317. }
  318. if (cmd->prot_op) {
  319. pr_err("WRITE_SAME: Protection information with FILEIO"
  320. " backends not supported\n");
  321. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  322. }
  323. if (cmd->t_data_nents > 1 ||
  324. cmd->t_data_sg[0].length != cmd->se_dev->dev_attrib.block_size) {
  325. pr_err("WRITE_SAME: Illegal SGL t_data_nents: %u length: %u"
  326. " block_size: %u\n",
  327. cmd->t_data_nents,
  328. cmd->t_data_sg[0].length,
  329. cmd->se_dev->dev_attrib.block_size);
  330. return TCM_INVALID_CDB_FIELD;
  331. }
  332. bvec = kcalloc(nolb, sizeof(struct bio_vec), GFP_KERNEL);
  333. if (!bvec)
  334. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  335. for (i = 0; i < nolb; i++) {
  336. bvec[i].bv_page = sg_page(&cmd->t_data_sg[0]);
  337. bvec[i].bv_len = cmd->t_data_sg[0].length;
  338. bvec[i].bv_offset = cmd->t_data_sg[0].offset;
  339. len += se_dev->dev_attrib.block_size;
  340. }
  341. iov_iter_bvec(&iter, ITER_BVEC, bvec, nolb, len);
  342. ret = vfs_iter_write(fd_dev->fd_file, &iter, &pos);
  343. kfree(bvec);
  344. if (ret < 0 || ret != len) {
  345. pr_err("vfs_iter_write() returned %zd for write same\n", ret);
  346. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  347. }
  348. target_complete_cmd(cmd, SAM_STAT_GOOD);
  349. return 0;
  350. }
  351. static int
  352. fd_do_prot_fill(struct se_device *se_dev, sector_t lba, sector_t nolb,
  353. void *buf, size_t bufsize)
  354. {
  355. struct fd_dev *fd_dev = FD_DEV(se_dev);
  356. struct file *prot_fd = fd_dev->fd_prot_file;
  357. sector_t prot_length, prot;
  358. loff_t pos = lba * se_dev->prot_length;
  359. if (!prot_fd) {
  360. pr_err("Unable to locate fd_dev->fd_prot_file\n");
  361. return -ENODEV;
  362. }
  363. prot_length = nolb * se_dev->prot_length;
  364. for (prot = 0; prot < prot_length;) {
  365. sector_t len = min_t(sector_t, bufsize, prot_length - prot);
  366. ssize_t ret = kernel_write(prot_fd, buf, len, pos + prot);
  367. if (ret != len) {
  368. pr_err("vfs_write to prot file failed: %zd\n", ret);
  369. return ret < 0 ? ret : -ENODEV;
  370. }
  371. prot += ret;
  372. }
  373. return 0;
  374. }
  375. static int
  376. fd_do_prot_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
  377. {
  378. void *buf;
  379. int rc;
  380. buf = (void *)__get_free_page(GFP_KERNEL);
  381. if (!buf) {
  382. pr_err("Unable to allocate FILEIO prot buf\n");
  383. return -ENOMEM;
  384. }
  385. memset(buf, 0xff, PAGE_SIZE);
  386. rc = fd_do_prot_fill(cmd->se_dev, lba, nolb, buf, PAGE_SIZE);
  387. free_page((unsigned long)buf);
  388. return rc;
  389. }
  390. static sense_reason_t
  391. fd_execute_unmap(struct se_cmd *cmd, sector_t lba, sector_t nolb)
  392. {
  393. struct file *file = FD_DEV(cmd->se_dev)->fd_file;
  394. struct inode *inode = file->f_mapping->host;
  395. int ret;
  396. if (cmd->se_dev->dev_attrib.pi_prot_type) {
  397. ret = fd_do_prot_unmap(cmd, lba, nolb);
  398. if (ret)
  399. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  400. }
  401. if (S_ISBLK(inode->i_mode)) {
  402. /* The backend is block device, use discard */
  403. struct block_device *bdev = inode->i_bdev;
  404. struct se_device *dev = cmd->se_dev;
  405. ret = blkdev_issue_discard(bdev,
  406. target_to_linux_sector(dev, lba),
  407. target_to_linux_sector(dev, nolb),
  408. GFP_KERNEL, 0);
  409. if (ret < 0) {
  410. pr_warn("FILEIO: blkdev_issue_discard() failed: %d\n",
  411. ret);
  412. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  413. }
  414. } else {
  415. /* The backend is normal file, use fallocate */
  416. struct se_device *se_dev = cmd->se_dev;
  417. loff_t pos = lba * se_dev->dev_attrib.block_size;
  418. unsigned int len = nolb * se_dev->dev_attrib.block_size;
  419. int mode = FALLOC_FL_PUNCH_HOLE | FALLOC_FL_KEEP_SIZE;
  420. if (!file->f_op->fallocate)
  421. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  422. ret = file->f_op->fallocate(file, mode, pos, len);
  423. if (ret < 0) {
  424. pr_warn("FILEIO: fallocate() failed: %d\n", ret);
  425. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  426. }
  427. }
  428. return 0;
  429. }
  430. static sense_reason_t
  431. fd_execute_rw(struct se_cmd *cmd, struct scatterlist *sgl, u32 sgl_nents,
  432. enum dma_data_direction data_direction)
  433. {
  434. struct se_device *dev = cmd->se_dev;
  435. struct fd_dev *fd_dev = FD_DEV(dev);
  436. struct file *file = fd_dev->fd_file;
  437. struct file *pfile = fd_dev->fd_prot_file;
  438. sense_reason_t rc;
  439. int ret = 0;
  440. /*
  441. * We are currently limited by the number of iovecs (2048) per
  442. * single vfs_[writev,readv] call.
  443. */
  444. if (cmd->data_length > FD_MAX_BYTES) {
  445. pr_err("FILEIO: Not able to process I/O of %u bytes due to"
  446. "FD_MAX_BYTES: %u iovec count limitation\n",
  447. cmd->data_length, FD_MAX_BYTES);
  448. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  449. }
  450. /*
  451. * Call vectorized fileio functions to map struct scatterlist
  452. * physical memory addresses to struct iovec virtual memory.
  453. */
  454. if (data_direction == DMA_FROM_DEVICE) {
  455. if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
  456. ret = fd_do_rw(cmd, pfile, dev->prot_length,
  457. cmd->t_prot_sg, cmd->t_prot_nents,
  458. cmd->prot_length, 0);
  459. if (ret < 0)
  460. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  461. }
  462. ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
  463. sgl, sgl_nents, cmd->data_length, 0);
  464. if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
  465. u32 sectors = cmd->data_length >>
  466. ilog2(dev->dev_attrib.block_size);
  467. rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
  468. 0, cmd->t_prot_sg, 0);
  469. if (rc)
  470. return rc;
  471. }
  472. } else {
  473. if (cmd->prot_type && dev->dev_attrib.pi_prot_type) {
  474. u32 sectors = cmd->data_length >>
  475. ilog2(dev->dev_attrib.block_size);
  476. rc = sbc_dif_verify(cmd, cmd->t_task_lba, sectors,
  477. 0, cmd->t_prot_sg, 0);
  478. if (rc)
  479. return rc;
  480. }
  481. ret = fd_do_rw(cmd, file, dev->dev_attrib.block_size,
  482. sgl, sgl_nents, cmd->data_length, 1);
  483. /*
  484. * Perform implicit vfs_fsync_range() for fd_do_writev() ops
  485. * for SCSI WRITEs with Forced Unit Access (FUA) set.
  486. * Allow this to happen independent of WCE=0 setting.
  487. */
  488. if (ret > 0 && (cmd->se_cmd_flags & SCF_FUA)) {
  489. loff_t start = cmd->t_task_lba *
  490. dev->dev_attrib.block_size;
  491. loff_t end;
  492. if (cmd->data_length)
  493. end = start + cmd->data_length - 1;
  494. else
  495. end = LLONG_MAX;
  496. vfs_fsync_range(fd_dev->fd_file, start, end, 1);
  497. }
  498. if (ret > 0 && cmd->prot_type && dev->dev_attrib.pi_prot_type) {
  499. ret = fd_do_rw(cmd, pfile, dev->prot_length,
  500. cmd->t_prot_sg, cmd->t_prot_nents,
  501. cmd->prot_length, 1);
  502. if (ret < 0)
  503. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  504. }
  505. }
  506. if (ret < 0)
  507. return TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE;
  508. if (ret)
  509. target_complete_cmd(cmd, SAM_STAT_GOOD);
  510. return 0;
  511. }
  512. enum {
  513. Opt_fd_dev_name, Opt_fd_dev_size, Opt_fd_buffered_io, Opt_err
  514. };
  515. static match_table_t tokens = {
  516. {Opt_fd_dev_name, "fd_dev_name=%s"},
  517. {Opt_fd_dev_size, "fd_dev_size=%s"},
  518. {Opt_fd_buffered_io, "fd_buffered_io=%d"},
  519. {Opt_err, NULL}
  520. };
  521. static ssize_t fd_set_configfs_dev_params(struct se_device *dev,
  522. const char *page, ssize_t count)
  523. {
  524. struct fd_dev *fd_dev = FD_DEV(dev);
  525. char *orig, *ptr, *arg_p, *opts;
  526. substring_t args[MAX_OPT_ARGS];
  527. int ret = 0, arg, token;
  528. opts = kstrdup(page, GFP_KERNEL);
  529. if (!opts)
  530. return -ENOMEM;
  531. orig = opts;
  532. while ((ptr = strsep(&opts, ",\n")) != NULL) {
  533. if (!*ptr)
  534. continue;
  535. token = match_token(ptr, tokens, args);
  536. switch (token) {
  537. case Opt_fd_dev_name:
  538. if (match_strlcpy(fd_dev->fd_dev_name, &args[0],
  539. FD_MAX_DEV_NAME) == 0) {
  540. ret = -EINVAL;
  541. break;
  542. }
  543. pr_debug("FILEIO: Referencing Path: %s\n",
  544. fd_dev->fd_dev_name);
  545. fd_dev->fbd_flags |= FBDF_HAS_PATH;
  546. break;
  547. case Opt_fd_dev_size:
  548. arg_p = match_strdup(&args[0]);
  549. if (!arg_p) {
  550. ret = -ENOMEM;
  551. break;
  552. }
  553. ret = kstrtoull(arg_p, 0, &fd_dev->fd_dev_size);
  554. kfree(arg_p);
  555. if (ret < 0) {
  556. pr_err("kstrtoull() failed for"
  557. " fd_dev_size=\n");
  558. goto out;
  559. }
  560. pr_debug("FILEIO: Referencing Size: %llu"
  561. " bytes\n", fd_dev->fd_dev_size);
  562. fd_dev->fbd_flags |= FBDF_HAS_SIZE;
  563. break;
  564. case Opt_fd_buffered_io:
  565. ret = match_int(args, &arg);
  566. if (ret)
  567. goto out;
  568. if (arg != 1) {
  569. pr_err("bogus fd_buffered_io=%d value\n", arg);
  570. ret = -EINVAL;
  571. goto out;
  572. }
  573. pr_debug("FILEIO: Using buffered I/O"
  574. " operations for struct fd_dev\n");
  575. fd_dev->fbd_flags |= FDBD_HAS_BUFFERED_IO_WCE;
  576. break;
  577. default:
  578. break;
  579. }
  580. }
  581. out:
  582. kfree(orig);
  583. return (!ret) ? count : ret;
  584. }
  585. static ssize_t fd_show_configfs_dev_params(struct se_device *dev, char *b)
  586. {
  587. struct fd_dev *fd_dev = FD_DEV(dev);
  588. ssize_t bl = 0;
  589. bl = sprintf(b + bl, "TCM FILEIO ID: %u", fd_dev->fd_dev_id);
  590. bl += sprintf(b + bl, " File: %s Size: %llu Mode: %s\n",
  591. fd_dev->fd_dev_name, fd_dev->fd_dev_size,
  592. (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE) ?
  593. "Buffered-WCE" : "O_DSYNC");
  594. return bl;
  595. }
  596. static sector_t fd_get_blocks(struct se_device *dev)
  597. {
  598. struct fd_dev *fd_dev = FD_DEV(dev);
  599. struct file *f = fd_dev->fd_file;
  600. struct inode *i = f->f_mapping->host;
  601. unsigned long long dev_size;
  602. /*
  603. * When using a file that references an underlying struct block_device,
  604. * ensure dev_size is always based on the current inode size in order
  605. * to handle underlying block_device resize operations.
  606. */
  607. if (S_ISBLK(i->i_mode))
  608. dev_size = i_size_read(i);
  609. else
  610. dev_size = fd_dev->fd_dev_size;
  611. return div_u64(dev_size - dev->dev_attrib.block_size,
  612. dev->dev_attrib.block_size);
  613. }
  614. static int fd_init_prot(struct se_device *dev)
  615. {
  616. struct fd_dev *fd_dev = FD_DEV(dev);
  617. struct file *prot_file, *file = fd_dev->fd_file;
  618. struct inode *inode;
  619. int ret, flags = O_RDWR | O_CREAT | O_LARGEFILE | O_DSYNC;
  620. char buf[FD_MAX_DEV_PROT_NAME];
  621. if (!file) {
  622. pr_err("Unable to locate fd_dev->fd_file\n");
  623. return -ENODEV;
  624. }
  625. inode = file->f_mapping->host;
  626. if (S_ISBLK(inode->i_mode)) {
  627. pr_err("FILEIO Protection emulation only supported on"
  628. " !S_ISBLK\n");
  629. return -ENOSYS;
  630. }
  631. if (fd_dev->fbd_flags & FDBD_HAS_BUFFERED_IO_WCE)
  632. flags &= ~O_DSYNC;
  633. snprintf(buf, FD_MAX_DEV_PROT_NAME, "%s.protection",
  634. fd_dev->fd_dev_name);
  635. prot_file = filp_open(buf, flags, 0600);
  636. if (IS_ERR(prot_file)) {
  637. pr_err("filp_open(%s) failed\n", buf);
  638. ret = PTR_ERR(prot_file);
  639. return ret;
  640. }
  641. fd_dev->fd_prot_file = prot_file;
  642. return 0;
  643. }
  644. static int fd_format_prot(struct se_device *dev)
  645. {
  646. unsigned char *buf;
  647. int unit_size = FDBD_FORMAT_UNIT_SIZE * dev->dev_attrib.block_size;
  648. int ret;
  649. if (!dev->dev_attrib.pi_prot_type) {
  650. pr_err("Unable to format_prot while pi_prot_type == 0\n");
  651. return -ENODEV;
  652. }
  653. buf = vzalloc(unit_size);
  654. if (!buf) {
  655. pr_err("Unable to allocate FILEIO prot buf\n");
  656. return -ENOMEM;
  657. }
  658. pr_debug("Using FILEIO prot_length: %llu\n",
  659. (unsigned long long)(dev->transport->get_blocks(dev) + 1) *
  660. dev->prot_length);
  661. memset(buf, 0xff, unit_size);
  662. ret = fd_do_prot_fill(dev, 0, dev->transport->get_blocks(dev) + 1,
  663. buf, unit_size);
  664. vfree(buf);
  665. return ret;
  666. }
  667. static void fd_free_prot(struct se_device *dev)
  668. {
  669. struct fd_dev *fd_dev = FD_DEV(dev);
  670. if (!fd_dev->fd_prot_file)
  671. return;
  672. filp_close(fd_dev->fd_prot_file, NULL);
  673. fd_dev->fd_prot_file = NULL;
  674. }
  675. static struct sbc_ops fd_sbc_ops = {
  676. .execute_rw = fd_execute_rw,
  677. .execute_sync_cache = fd_execute_sync_cache,
  678. .execute_write_same = fd_execute_write_same,
  679. .execute_unmap = fd_execute_unmap,
  680. };
  681. static sense_reason_t
  682. fd_parse_cdb(struct se_cmd *cmd)
  683. {
  684. return sbc_parse_cdb(cmd, &fd_sbc_ops);
  685. }
  686. static const struct target_backend_ops fileio_ops = {
  687. .name = "fileio",
  688. .inquiry_prod = "FILEIO",
  689. .inquiry_rev = FD_VERSION,
  690. .owner = THIS_MODULE,
  691. .attach_hba = fd_attach_hba,
  692. .detach_hba = fd_detach_hba,
  693. .alloc_device = fd_alloc_device,
  694. .configure_device = fd_configure_device,
  695. .free_device = fd_free_device,
  696. .parse_cdb = fd_parse_cdb,
  697. .set_configfs_dev_params = fd_set_configfs_dev_params,
  698. .show_configfs_dev_params = fd_show_configfs_dev_params,
  699. .get_device_type = sbc_get_device_type,
  700. .get_blocks = fd_get_blocks,
  701. .init_prot = fd_init_prot,
  702. .format_prot = fd_format_prot,
  703. .free_prot = fd_free_prot,
  704. .tb_dev_attrib_attrs = sbc_attrib_attrs,
  705. };
  706. static int __init fileio_module_init(void)
  707. {
  708. return transport_backend_register(&fileio_ops);
  709. }
  710. static void __exit fileio_module_exit(void)
  711. {
  712. target_backend_unregister(&fileio_ops);
  713. }
  714. MODULE_DESCRIPTION("TCM FILEIO subsystem plugin");
  715. MODULE_AUTHOR("nab@Linux-iSCSI.org");
  716. MODULE_LICENSE("GPL");
  717. module_init(fileio_module_init);
  718. module_exit(fileio_module_exit);