dm-log-writes.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944
  1. // SPDX-License-Identifier: GPL-2.0-only
  2. /*
  3. * Copyright (C) 2014 Facebook. All rights reserved.
  4. *
  5. * This file is released under the GPL.
  6. */
  7. #include <linux/device-mapper.h>
  8. #include <linux/module.h>
  9. #include <linux/init.h>
  10. #include <linux/blkdev.h>
  11. #include <linux/bio.h>
  12. #include <linux/dax.h>
  13. #include <linux/slab.h>
  14. #include <linux/kthread.h>
  15. #include <linux/freezer.h>
  16. #include <linux/uio.h>
  17. #define DM_MSG_PREFIX "log-writes"
  18. /*
  19. * This target will sequentially log all writes to the target device onto the
  20. * log device. This is helpful for replaying writes to check for fs consistency
  21. * at all times. This target provides a mechanism to mark specific events to
  22. * check data at a later time. So for example you would:
  23. *
  24. * write data
  25. * fsync
  26. * dmsetup message /dev/whatever mark mymark
  27. * unmount /mnt/test
  28. *
  29. * Then replay the log up to mymark and check the contents of the replay to
  30. * verify it matches what was written.
  31. *
  32. * We log writes only after they have been flushed, this makes the log describe
  33. * close to the order in which the data hits the actual disk, not its cache. So
  34. * for example the following sequence (W means write, C means complete)
  35. *
  36. * Wa,Wb,Wc,Cc,Ca,FLUSH,FUAd,Cb,CFLUSH,CFUAd
  37. *
  38. * Would result in the log looking like this:
  39. *
  40. * c,a,b,flush,fuad,<other writes>,<next flush>
  41. *
  42. * This is meant to help expose problems where file systems do not properly wait
  43. * on data being written before invoking a FLUSH. FUA bypasses cache so once it
  44. * completes it is added to the log as it should be on disk.
  45. *
  46. * We treat DISCARDs as if they don't bypass cache so that they are logged in
  47. * order of completion along with the normal writes. If we didn't do it this
  48. * way we would process all the discards first and then write all the data, when
  49. * in fact we want to do the data and the discard in the order that they
  50. * completed.
  51. */
  52. #define LOG_FLUSH_FLAG (1 << 0)
  53. #define LOG_FUA_FLAG (1 << 1)
  54. #define LOG_DISCARD_FLAG (1 << 2)
  55. #define LOG_MARK_FLAG (1 << 3)
  56. #define LOG_METADATA_FLAG (1 << 4)
  57. #define WRITE_LOG_VERSION 1ULL
  58. #define WRITE_LOG_MAGIC 0x6a736677736872ULL
  59. #define WRITE_LOG_SUPER_SECTOR 0
  60. /*
  61. * The disk format for this is braindead simple.
  62. *
  63. * At byte 0 we have our super, followed by the following sequence for
  64. * nr_entries:
  65. *
  66. * [ 1 sector ][ entry->nr_sectors ]
  67. * [log_write_entry][ data written ]
  68. *
  69. * The log_write_entry takes up a full sector so we can have arbitrary length
  70. * marks and it leaves us room for extra content in the future.
  71. */
  72. /*
  73. * Basic info about the log for userspace.
  74. */
  75. struct log_write_super {
  76. __le64 magic;
  77. __le64 version;
  78. __le64 nr_entries;
  79. __le32 sectorsize;
  80. };
  81. /*
  82. * sector - the sector we wrote.
  83. * nr_sectors - the number of sectors we wrote.
  84. * flags - flags for this log entry.
  85. * data_len - the size of the data in this log entry, this is for private log
  86. * entry stuff, the MARK data provided by userspace for example.
  87. */
  88. struct log_write_entry {
  89. __le64 sector;
  90. __le64 nr_sectors;
  91. __le64 flags;
  92. __le64 data_len;
  93. };
  94. struct log_writes_c {
  95. struct dm_dev *dev;
  96. struct dm_dev *logdev;
  97. u64 logged_entries;
  98. u32 sectorsize;
  99. u32 sectorshift;
  100. atomic_t io_blocks;
  101. atomic_t pending_blocks;
  102. sector_t next_sector;
  103. sector_t end_sector;
  104. bool logging_enabled;
  105. bool device_supports_discard;
  106. spinlock_t blocks_lock;
  107. struct list_head unflushed_blocks;
  108. struct list_head logging_blocks;
  109. wait_queue_head_t wait;
  110. struct task_struct *log_kthread;
  111. struct completion super_done;
  112. };
  113. struct pending_block {
  114. int vec_cnt;
  115. u64 flags;
  116. sector_t sector;
  117. sector_t nr_sectors;
  118. char *data;
  119. u32 datalen;
  120. struct list_head list;
  121. struct bio_vec vecs[];
  122. };
  123. struct per_bio_data {
  124. struct pending_block *block;
  125. };
  126. static inline sector_t bio_to_dev_sectors(struct log_writes_c *lc,
  127. sector_t sectors)
  128. {
  129. return sectors >> (lc->sectorshift - SECTOR_SHIFT);
  130. }
  131. static inline sector_t dev_to_bio_sectors(struct log_writes_c *lc,
  132. sector_t sectors)
  133. {
  134. return sectors << (lc->sectorshift - SECTOR_SHIFT);
  135. }
  136. static void put_pending_block(struct log_writes_c *lc)
  137. {
  138. if (atomic_dec_and_test(&lc->pending_blocks)) {
  139. smp_mb__after_atomic();
  140. if (waitqueue_active(&lc->wait))
  141. wake_up(&lc->wait);
  142. }
  143. }
  144. static void put_io_block(struct log_writes_c *lc)
  145. {
  146. if (atomic_dec_and_test(&lc->io_blocks)) {
  147. smp_mb__after_atomic();
  148. if (waitqueue_active(&lc->wait))
  149. wake_up(&lc->wait);
  150. }
  151. }
  152. static void log_end_io(struct bio *bio)
  153. {
  154. struct log_writes_c *lc = bio->bi_private;
  155. if (bio->bi_status) {
  156. unsigned long flags;
  157. DMERR("Error writing log block, error=%d", bio->bi_status);
  158. spin_lock_irqsave(&lc->blocks_lock, flags);
  159. lc->logging_enabled = false;
  160. spin_unlock_irqrestore(&lc->blocks_lock, flags);
  161. }
  162. bio_free_pages(bio);
  163. put_io_block(lc);
  164. bio_put(bio);
  165. }
  166. static void log_end_super(struct bio *bio)
  167. {
  168. struct log_writes_c *lc = bio->bi_private;
  169. complete(&lc->super_done);
  170. log_end_io(bio);
  171. }
  172. /*
  173. * Meant to be called if there is an error, it will free all the pages
  174. * associated with the block.
  175. */
  176. static void free_pending_block(struct log_writes_c *lc,
  177. struct pending_block *block)
  178. {
  179. int i;
  180. for (i = 0; i < block->vec_cnt; i++) {
  181. if (block->vecs[i].bv_page)
  182. __free_page(block->vecs[i].bv_page);
  183. }
  184. kfree(block->data);
  185. kfree(block);
  186. put_pending_block(lc);
  187. }
  188. static int write_metadata(struct log_writes_c *lc, void *entry,
  189. size_t entrylen, void *data, size_t datalen,
  190. sector_t sector)
  191. {
  192. struct bio *bio;
  193. struct page *page;
  194. void *ptr;
  195. size_t ret;
  196. bio = bio_alloc(lc->logdev->bdev, 1, REQ_OP_WRITE, GFP_KERNEL);
  197. bio->bi_iter.bi_size = 0;
  198. bio->bi_iter.bi_sector = sector;
  199. bio->bi_end_io = (sector == WRITE_LOG_SUPER_SECTOR) ?
  200. log_end_super : log_end_io;
  201. bio->bi_private = lc;
  202. page = alloc_page(GFP_KERNEL);
  203. if (!page) {
  204. DMERR("Couldn't alloc log page");
  205. bio_put(bio);
  206. goto error;
  207. }
  208. ptr = kmap_local_page(page);
  209. memcpy(ptr, entry, entrylen);
  210. if (datalen)
  211. memcpy(ptr + entrylen, data, datalen);
  212. memset(ptr + entrylen + datalen, 0,
  213. lc->sectorsize - entrylen - datalen);
  214. kunmap_local(ptr);
  215. ret = bio_add_page(bio, page, lc->sectorsize, 0);
  216. if (ret != lc->sectorsize) {
  217. DMERR("Couldn't add page to the log block");
  218. goto error_bio;
  219. }
  220. submit_bio(bio);
  221. return 0;
  222. error_bio:
  223. bio_put(bio);
  224. __free_page(page);
  225. error:
  226. put_io_block(lc);
  227. return -1;
  228. }
  229. static int write_inline_data(struct log_writes_c *lc, void *entry,
  230. size_t entrylen, void *data, size_t datalen,
  231. sector_t sector)
  232. {
  233. int bio_pages, pg_datalen, pg_sectorlen, i;
  234. struct page *page;
  235. struct bio *bio;
  236. size_t ret;
  237. void *ptr;
  238. while (datalen) {
  239. bio_pages = bio_max_segs(DIV_ROUND_UP(datalen, PAGE_SIZE));
  240. atomic_inc(&lc->io_blocks);
  241. bio = bio_alloc(lc->logdev->bdev, bio_pages, REQ_OP_WRITE,
  242. GFP_KERNEL);
  243. bio->bi_iter.bi_size = 0;
  244. bio->bi_iter.bi_sector = sector;
  245. bio->bi_end_io = log_end_io;
  246. bio->bi_private = lc;
  247. for (i = 0; i < bio_pages; i++) {
  248. pg_datalen = min_t(int, datalen, PAGE_SIZE);
  249. pg_sectorlen = ALIGN(pg_datalen, lc->sectorsize);
  250. page = alloc_page(GFP_KERNEL);
  251. if (!page) {
  252. DMERR("Couldn't alloc inline data page");
  253. goto error_bio;
  254. }
  255. ptr = kmap_local_page(page);
  256. memcpy(ptr, data, pg_datalen);
  257. if (pg_sectorlen > pg_datalen)
  258. memset(ptr + pg_datalen, 0, pg_sectorlen - pg_datalen);
  259. kunmap_local(ptr);
  260. ret = bio_add_page(bio, page, pg_sectorlen, 0);
  261. if (ret != pg_sectorlen) {
  262. DMERR("Couldn't add page of inline data");
  263. __free_page(page);
  264. goto error_bio;
  265. }
  266. datalen -= pg_datalen;
  267. data += pg_datalen;
  268. }
  269. submit_bio(bio);
  270. sector += bio_pages * PAGE_SECTORS;
  271. }
  272. return 0;
  273. error_bio:
  274. bio_free_pages(bio);
  275. bio_put(bio);
  276. put_io_block(lc);
  277. return -1;
  278. }
  279. static int log_one_block(struct log_writes_c *lc,
  280. struct pending_block *block, sector_t sector)
  281. {
  282. struct bio *bio;
  283. struct log_write_entry entry;
  284. size_t metadatalen, ret;
  285. int i;
  286. entry.sector = cpu_to_le64(block->sector);
  287. entry.nr_sectors = cpu_to_le64(block->nr_sectors);
  288. entry.flags = cpu_to_le64(block->flags);
  289. entry.data_len = cpu_to_le64(block->datalen);
  290. metadatalen = (block->flags & LOG_MARK_FLAG) ? block->datalen : 0;
  291. if (write_metadata(lc, &entry, sizeof(entry), block->data,
  292. metadatalen, sector)) {
  293. free_pending_block(lc, block);
  294. return -1;
  295. }
  296. sector += dev_to_bio_sectors(lc, 1);
  297. if (block->datalen && metadatalen == 0) {
  298. if (write_inline_data(lc, &entry, sizeof(entry), block->data,
  299. block->datalen, sector)) {
  300. free_pending_block(lc, block);
  301. return -1;
  302. }
  303. /* we don't support both inline data & bio data */
  304. goto out;
  305. }
  306. if (!block->vec_cnt)
  307. goto out;
  308. atomic_inc(&lc->io_blocks);
  309. bio = bio_alloc(lc->logdev->bdev, bio_max_segs(block->vec_cnt),
  310. REQ_OP_WRITE, GFP_KERNEL);
  311. bio->bi_iter.bi_size = 0;
  312. bio->bi_iter.bi_sector = sector;
  313. bio->bi_end_io = log_end_io;
  314. bio->bi_private = lc;
  315. for (i = 0; i < block->vec_cnt; i++) {
  316. /*
  317. * The page offset is always 0 because we allocate a new page
  318. * for every bvec in the original bio for simplicity sake.
  319. */
  320. ret = bio_add_page(bio, block->vecs[i].bv_page,
  321. block->vecs[i].bv_len, 0);
  322. if (ret != block->vecs[i].bv_len) {
  323. atomic_inc(&lc->io_blocks);
  324. submit_bio(bio);
  325. bio = bio_alloc(lc->logdev->bdev,
  326. bio_max_segs(block->vec_cnt - i),
  327. REQ_OP_WRITE, GFP_KERNEL);
  328. bio->bi_iter.bi_size = 0;
  329. bio->bi_iter.bi_sector = sector;
  330. bio->bi_end_io = log_end_io;
  331. bio->bi_private = lc;
  332. ret = bio_add_page(bio, block->vecs[i].bv_page,
  333. block->vecs[i].bv_len, 0);
  334. if (ret != block->vecs[i].bv_len) {
  335. DMERR("Couldn't add page on new bio?");
  336. bio_put(bio);
  337. goto error;
  338. }
  339. }
  340. sector += block->vecs[i].bv_len >> SECTOR_SHIFT;
  341. }
  342. submit_bio(bio);
  343. out:
  344. kfree(block->data);
  345. kfree(block);
  346. put_pending_block(lc);
  347. return 0;
  348. error:
  349. free_pending_block(lc, block);
  350. put_io_block(lc);
  351. return -1;
  352. }
  353. static int log_super(struct log_writes_c *lc)
  354. {
  355. struct log_write_super super;
  356. super.magic = cpu_to_le64(WRITE_LOG_MAGIC);
  357. super.version = cpu_to_le64(WRITE_LOG_VERSION);
  358. super.nr_entries = cpu_to_le64(lc->logged_entries);
  359. super.sectorsize = cpu_to_le32(lc->sectorsize);
  360. if (write_metadata(lc, &super, sizeof(super), NULL, 0,
  361. WRITE_LOG_SUPER_SECTOR)) {
  362. DMERR("Couldn't write super");
  363. return -1;
  364. }
  365. /*
  366. * Super sector should be writen in-order, otherwise the
  367. * nr_entries could be rewritten incorrectly by an old bio.
  368. */
  369. wait_for_completion_io(&lc->super_done);
  370. return 0;
  371. }
  372. static inline sector_t logdev_last_sector(struct log_writes_c *lc)
  373. {
  374. return bdev_nr_sectors(lc->logdev->bdev);
  375. }
  376. static int log_writes_kthread(void *arg)
  377. {
  378. struct log_writes_c *lc = arg;
  379. sector_t sector = 0;
  380. while (!kthread_should_stop()) {
  381. bool super = false;
  382. bool logging_enabled;
  383. struct pending_block *block = NULL;
  384. int ret;
  385. spin_lock_irq(&lc->blocks_lock);
  386. if (!list_empty(&lc->logging_blocks)) {
  387. block = list_first_entry(&lc->logging_blocks,
  388. struct pending_block, list);
  389. list_del_init(&block->list);
  390. if (!lc->logging_enabled)
  391. goto next;
  392. sector = lc->next_sector;
  393. if (!(block->flags & LOG_DISCARD_FLAG))
  394. lc->next_sector += dev_to_bio_sectors(lc, block->nr_sectors);
  395. lc->next_sector += dev_to_bio_sectors(lc, 1);
  396. /*
  397. * Apparently the size of the device may not be known
  398. * right away, so handle this properly.
  399. */
  400. if (!lc->end_sector)
  401. lc->end_sector = logdev_last_sector(lc);
  402. if (lc->end_sector &&
  403. lc->next_sector >= lc->end_sector) {
  404. DMERR("Ran out of space on the logdev");
  405. lc->logging_enabled = false;
  406. goto next;
  407. }
  408. lc->logged_entries++;
  409. atomic_inc(&lc->io_blocks);
  410. super = (block->flags & (LOG_FUA_FLAG | LOG_MARK_FLAG));
  411. if (super)
  412. atomic_inc(&lc->io_blocks);
  413. }
  414. next:
  415. logging_enabled = lc->logging_enabled;
  416. spin_unlock_irq(&lc->blocks_lock);
  417. if (block) {
  418. if (logging_enabled) {
  419. ret = log_one_block(lc, block, sector);
  420. if (!ret && super)
  421. ret = log_super(lc);
  422. if (ret) {
  423. spin_lock_irq(&lc->blocks_lock);
  424. lc->logging_enabled = false;
  425. spin_unlock_irq(&lc->blocks_lock);
  426. }
  427. } else
  428. free_pending_block(lc, block);
  429. continue;
  430. }
  431. if (!try_to_freeze()) {
  432. set_current_state(TASK_INTERRUPTIBLE);
  433. if (!kthread_should_stop() &&
  434. list_empty(&lc->logging_blocks))
  435. schedule();
  436. __set_current_state(TASK_RUNNING);
  437. }
  438. }
  439. return 0;
  440. }
  441. /*
  442. * Construct a log-writes mapping:
  443. * log-writes <dev_path> <log_dev_path>
  444. */
  445. static int log_writes_ctr(struct dm_target *ti, unsigned int argc, char **argv)
  446. {
  447. struct log_writes_c *lc;
  448. struct dm_arg_set as;
  449. const char *devname, *logdevname;
  450. int ret;
  451. as.argc = argc;
  452. as.argv = argv;
  453. if (argc < 2) {
  454. ti->error = "Invalid argument count";
  455. return -EINVAL;
  456. }
  457. lc = kzalloc(sizeof(struct log_writes_c), GFP_KERNEL);
  458. if (!lc) {
  459. ti->error = "Cannot allocate context";
  460. return -ENOMEM;
  461. }
  462. spin_lock_init(&lc->blocks_lock);
  463. INIT_LIST_HEAD(&lc->unflushed_blocks);
  464. INIT_LIST_HEAD(&lc->logging_blocks);
  465. init_waitqueue_head(&lc->wait);
  466. init_completion(&lc->super_done);
  467. atomic_set(&lc->io_blocks, 0);
  468. atomic_set(&lc->pending_blocks, 0);
  469. devname = dm_shift_arg(&as);
  470. ret = dm_get_device(ti, devname, dm_table_get_mode(ti->table), &lc->dev);
  471. if (ret) {
  472. ti->error = "Device lookup failed";
  473. goto bad;
  474. }
  475. logdevname = dm_shift_arg(&as);
  476. ret = dm_get_device(ti, logdevname, dm_table_get_mode(ti->table),
  477. &lc->logdev);
  478. if (ret) {
  479. ti->error = "Log device lookup failed";
  480. dm_put_device(ti, lc->dev);
  481. goto bad;
  482. }
  483. lc->sectorsize = bdev_logical_block_size(lc->dev->bdev);
  484. lc->sectorshift = ilog2(lc->sectorsize);
  485. lc->log_kthread = kthread_run(log_writes_kthread, lc, "log-write");
  486. if (IS_ERR(lc->log_kthread)) {
  487. ret = PTR_ERR(lc->log_kthread);
  488. ti->error = "Couldn't alloc kthread";
  489. dm_put_device(ti, lc->dev);
  490. dm_put_device(ti, lc->logdev);
  491. goto bad;
  492. }
  493. /*
  494. * next_sector is in 512b sectors to correspond to what bi_sector expects.
  495. * The super starts at sector 0, and the next_sector is the next logical
  496. * one based on the sectorsize of the device.
  497. */
  498. lc->next_sector = lc->sectorsize >> SECTOR_SHIFT;
  499. lc->logging_enabled = true;
  500. lc->end_sector = logdev_last_sector(lc);
  501. lc->device_supports_discard = true;
  502. ti->num_flush_bios = 1;
  503. ti->flush_supported = true;
  504. ti->num_discard_bios = 1;
  505. ti->discards_supported = true;
  506. ti->per_io_data_size = sizeof(struct per_bio_data);
  507. ti->private = lc;
  508. return 0;
  509. bad:
  510. kfree(lc);
  511. return ret;
  512. }
  513. static int log_mark(struct log_writes_c *lc, char *data)
  514. {
  515. struct pending_block *block;
  516. size_t maxsize = lc->sectorsize - sizeof(struct log_write_entry);
  517. block = kzalloc(sizeof(struct pending_block), GFP_KERNEL);
  518. if (!block) {
  519. DMERR("Error allocating pending block");
  520. return -ENOMEM;
  521. }
  522. block->data = kstrndup(data, maxsize - 1, GFP_KERNEL);
  523. if (!block->data) {
  524. DMERR("Error copying mark data");
  525. kfree(block);
  526. return -ENOMEM;
  527. }
  528. atomic_inc(&lc->pending_blocks);
  529. block->datalen = strlen(block->data);
  530. block->flags |= LOG_MARK_FLAG;
  531. spin_lock_irq(&lc->blocks_lock);
  532. list_add_tail(&block->list, &lc->logging_blocks);
  533. spin_unlock_irq(&lc->blocks_lock);
  534. wake_up_process(lc->log_kthread);
  535. return 0;
  536. }
  537. static void log_writes_dtr(struct dm_target *ti)
  538. {
  539. struct log_writes_c *lc = ti->private;
  540. spin_lock_irq(&lc->blocks_lock);
  541. list_splice_init(&lc->unflushed_blocks, &lc->logging_blocks);
  542. spin_unlock_irq(&lc->blocks_lock);
  543. /*
  544. * This is just nice to have since it'll update the super to include the
  545. * unflushed blocks, if it fails we don't really care.
  546. */
  547. log_mark(lc, "dm-log-writes-end");
  548. wake_up_process(lc->log_kthread);
  549. wait_event(lc->wait, !atomic_read(&lc->io_blocks) &&
  550. !atomic_read(&lc->pending_blocks));
  551. kthread_stop(lc->log_kthread);
  552. WARN_ON(!list_empty(&lc->logging_blocks));
  553. WARN_ON(!list_empty(&lc->unflushed_blocks));
  554. dm_put_device(ti, lc->dev);
  555. dm_put_device(ti, lc->logdev);
  556. kfree(lc);
  557. }
  558. static void normal_map_bio(struct dm_target *ti, struct bio *bio)
  559. {
  560. struct log_writes_c *lc = ti->private;
  561. bio_set_dev(bio, lc->dev->bdev);
  562. }
  563. static int log_writes_map(struct dm_target *ti, struct bio *bio)
  564. {
  565. struct log_writes_c *lc = ti->private;
  566. struct per_bio_data *pb = dm_per_bio_data(bio, sizeof(struct per_bio_data));
  567. struct pending_block *block;
  568. struct bvec_iter iter;
  569. struct bio_vec bv;
  570. size_t alloc_size;
  571. int i = 0;
  572. bool flush_bio = (bio->bi_opf & REQ_PREFLUSH);
  573. bool fua_bio = (bio->bi_opf & REQ_FUA);
  574. bool discard_bio = (bio_op(bio) == REQ_OP_DISCARD);
  575. bool meta_bio = (bio->bi_opf & REQ_META);
  576. pb->block = NULL;
  577. /* Don't bother doing anything if logging has been disabled */
  578. if (!lc->logging_enabled)
  579. goto map_bio;
  580. /*
  581. * Map reads as normal.
  582. */
  583. if (bio_data_dir(bio) == READ)
  584. goto map_bio;
  585. /* No sectors and not a flush? Don't care */
  586. if (!bio_sectors(bio) && !flush_bio)
  587. goto map_bio;
  588. /*
  589. * Discards will have bi_size set but there's no actual data, so just
  590. * allocate the size of the pending block.
  591. */
  592. if (discard_bio)
  593. alloc_size = sizeof(struct pending_block);
  594. else
  595. alloc_size = struct_size(block, vecs, bio_segments(bio));
  596. block = kzalloc(alloc_size, GFP_NOIO);
  597. if (!block) {
  598. DMERR("Error allocating pending block");
  599. spin_lock_irq(&lc->blocks_lock);
  600. lc->logging_enabled = false;
  601. spin_unlock_irq(&lc->blocks_lock);
  602. return DM_MAPIO_KILL;
  603. }
  604. INIT_LIST_HEAD(&block->list);
  605. pb->block = block;
  606. atomic_inc(&lc->pending_blocks);
  607. if (flush_bio)
  608. block->flags |= LOG_FLUSH_FLAG;
  609. if (fua_bio)
  610. block->flags |= LOG_FUA_FLAG;
  611. if (discard_bio)
  612. block->flags |= LOG_DISCARD_FLAG;
  613. if (meta_bio)
  614. block->flags |= LOG_METADATA_FLAG;
  615. block->sector = bio_to_dev_sectors(lc, bio->bi_iter.bi_sector);
  616. block->nr_sectors = bio_to_dev_sectors(lc, bio_sectors(bio));
  617. /* We don't need the data, just submit */
  618. if (discard_bio) {
  619. WARN_ON(flush_bio || fua_bio);
  620. if (lc->device_supports_discard)
  621. goto map_bio;
  622. bio_endio(bio);
  623. return DM_MAPIO_SUBMITTED;
  624. }
  625. /* Flush bio, splice the unflushed blocks onto this list and submit */
  626. if (flush_bio && !bio_sectors(bio)) {
  627. spin_lock_irq(&lc->blocks_lock);
  628. list_splice_init(&lc->unflushed_blocks, &block->list);
  629. spin_unlock_irq(&lc->blocks_lock);
  630. goto map_bio;
  631. }
  632. /*
  633. * We will write this bio somewhere else way later so we need to copy
  634. * the actual contents into new pages so we know the data will always be
  635. * there.
  636. *
  637. * We do this because this could be a bio from O_DIRECT in which case we
  638. * can't just hold onto the page until some later point, we have to
  639. * manually copy the contents.
  640. */
  641. bio_for_each_segment(bv, bio, iter) {
  642. struct page *page;
  643. void *dst;
  644. page = alloc_page(GFP_NOIO);
  645. if (!page) {
  646. DMERR("Error allocing page");
  647. free_pending_block(lc, block);
  648. spin_lock_irq(&lc->blocks_lock);
  649. lc->logging_enabled = false;
  650. spin_unlock_irq(&lc->blocks_lock);
  651. return DM_MAPIO_KILL;
  652. }
  653. dst = kmap_local_page(page);
  654. memcpy_from_bvec(dst, &bv);
  655. kunmap_local(dst);
  656. block->vecs[i].bv_page = page;
  657. block->vecs[i].bv_len = bv.bv_len;
  658. block->vec_cnt++;
  659. i++;
  660. }
  661. /* Had a flush with data in it, weird */
  662. if (flush_bio) {
  663. spin_lock_irq(&lc->blocks_lock);
  664. list_splice_init(&lc->unflushed_blocks, &block->list);
  665. spin_unlock_irq(&lc->blocks_lock);
  666. }
  667. map_bio:
  668. normal_map_bio(ti, bio);
  669. return DM_MAPIO_REMAPPED;
  670. }
  671. static int normal_end_io(struct dm_target *ti, struct bio *bio,
  672. blk_status_t *error)
  673. {
  674. struct log_writes_c *lc = ti->private;
  675. struct per_bio_data *pb = dm_per_bio_data(bio, sizeof(struct per_bio_data));
  676. if (bio_data_dir(bio) == WRITE && pb->block) {
  677. struct pending_block *block = pb->block;
  678. unsigned long flags;
  679. spin_lock_irqsave(&lc->blocks_lock, flags);
  680. if (block->flags & LOG_FLUSH_FLAG) {
  681. list_splice_tail_init(&block->list, &lc->logging_blocks);
  682. list_add_tail(&block->list, &lc->logging_blocks);
  683. wake_up_process(lc->log_kthread);
  684. } else if (block->flags & LOG_FUA_FLAG) {
  685. list_add_tail(&block->list, &lc->logging_blocks);
  686. wake_up_process(lc->log_kthread);
  687. } else
  688. list_add_tail(&block->list, &lc->unflushed_blocks);
  689. spin_unlock_irqrestore(&lc->blocks_lock, flags);
  690. }
  691. return DM_ENDIO_DONE;
  692. }
  693. /*
  694. * INFO format: <logged entries> <highest allocated sector>
  695. */
  696. static void log_writes_status(struct dm_target *ti, status_type_t type,
  697. unsigned int status_flags, char *result,
  698. unsigned int maxlen)
  699. {
  700. unsigned int sz = 0;
  701. struct log_writes_c *lc = ti->private;
  702. switch (type) {
  703. case STATUSTYPE_INFO:
  704. DMEMIT("%llu %llu", lc->logged_entries,
  705. (unsigned long long)lc->next_sector - 1);
  706. if (!lc->logging_enabled)
  707. DMEMIT(" logging_disabled");
  708. break;
  709. case STATUSTYPE_TABLE:
  710. DMEMIT("%s %s", lc->dev->name, lc->logdev->name);
  711. break;
  712. case STATUSTYPE_IMA:
  713. *result = '\0';
  714. break;
  715. }
  716. }
  717. static int log_writes_prepare_ioctl(struct dm_target *ti,
  718. struct block_device **bdev)
  719. {
  720. struct log_writes_c *lc = ti->private;
  721. struct dm_dev *dev = lc->dev;
  722. *bdev = dev->bdev;
  723. /*
  724. * Only pass ioctls through if the device sizes match exactly.
  725. */
  726. if (ti->len != bdev_nr_sectors(dev->bdev))
  727. return 1;
  728. return 0;
  729. }
  730. static int log_writes_iterate_devices(struct dm_target *ti,
  731. iterate_devices_callout_fn fn,
  732. void *data)
  733. {
  734. struct log_writes_c *lc = ti->private;
  735. return fn(ti, lc->dev, 0, ti->len, data);
  736. }
  737. /*
  738. * Messages supported:
  739. * mark <mark data> - specify the marked data.
  740. */
  741. static int log_writes_message(struct dm_target *ti, unsigned int argc, char **argv,
  742. char *result, unsigned int maxlen)
  743. {
  744. int r = -EINVAL;
  745. struct log_writes_c *lc = ti->private;
  746. if (argc != 2) {
  747. DMWARN("Invalid log-writes message arguments, expect 2 arguments, got %d", argc);
  748. return r;
  749. }
  750. if (!strcasecmp(argv[0], "mark"))
  751. r = log_mark(lc, argv[1]);
  752. else
  753. DMWARN("Unrecognised log writes target message received: %s", argv[0]);
  754. return r;
  755. }
  756. static void log_writes_io_hints(struct dm_target *ti, struct queue_limits *limits)
  757. {
  758. struct log_writes_c *lc = ti->private;
  759. if (!bdev_max_discard_sectors(lc->dev->bdev)) {
  760. lc->device_supports_discard = false;
  761. limits->discard_granularity = lc->sectorsize;
  762. limits->max_hw_discard_sectors = (UINT_MAX >> SECTOR_SHIFT);
  763. }
  764. limits->logical_block_size = bdev_logical_block_size(lc->dev->bdev);
  765. limits->physical_block_size = bdev_physical_block_size(lc->dev->bdev);
  766. limits->io_min = limits->physical_block_size;
  767. limits->dma_alignment = limits->logical_block_size - 1;
  768. }
  769. #if IS_ENABLED(CONFIG_FS_DAX)
  770. static struct dax_device *log_writes_dax_pgoff(struct dm_target *ti,
  771. pgoff_t *pgoff)
  772. {
  773. struct log_writes_c *lc = ti->private;
  774. *pgoff += (get_start_sect(lc->dev->bdev) >> PAGE_SECTORS_SHIFT);
  775. return lc->dev->dax_dev;
  776. }
  777. static long log_writes_dax_direct_access(struct dm_target *ti, pgoff_t pgoff,
  778. long nr_pages, enum dax_access_mode mode, void **kaddr,
  779. pfn_t *pfn)
  780. {
  781. struct dax_device *dax_dev = log_writes_dax_pgoff(ti, &pgoff);
  782. return dax_direct_access(dax_dev, pgoff, nr_pages, mode, kaddr, pfn);
  783. }
  784. static int log_writes_dax_zero_page_range(struct dm_target *ti, pgoff_t pgoff,
  785. size_t nr_pages)
  786. {
  787. struct dax_device *dax_dev = log_writes_dax_pgoff(ti, &pgoff);
  788. return dax_zero_page_range(dax_dev, pgoff, nr_pages << PAGE_SHIFT);
  789. }
  790. static size_t log_writes_dax_recovery_write(struct dm_target *ti,
  791. pgoff_t pgoff, void *addr, size_t bytes, struct iov_iter *i)
  792. {
  793. struct dax_device *dax_dev = log_writes_dax_pgoff(ti, &pgoff);
  794. return dax_recovery_write(dax_dev, pgoff, addr, bytes, i);
  795. }
  796. #else
  797. #define log_writes_dax_direct_access NULL
  798. #define log_writes_dax_zero_page_range NULL
  799. #define log_writes_dax_recovery_write NULL
  800. #endif
  801. static struct target_type log_writes_target = {
  802. .name = "log-writes",
  803. .version = {1, 1, 0},
  804. .module = THIS_MODULE,
  805. .ctr = log_writes_ctr,
  806. .dtr = log_writes_dtr,
  807. .map = log_writes_map,
  808. .end_io = normal_end_io,
  809. .status = log_writes_status,
  810. .prepare_ioctl = log_writes_prepare_ioctl,
  811. .message = log_writes_message,
  812. .iterate_devices = log_writes_iterate_devices,
  813. .io_hints = log_writes_io_hints,
  814. .direct_access = log_writes_dax_direct_access,
  815. .dax_zero_page_range = log_writes_dax_zero_page_range,
  816. .dax_recovery_write = log_writes_dax_recovery_write,
  817. };
  818. module_dm(log_writes);
  819. MODULE_DESCRIPTION(DM_NAME " log writes target");
  820. MODULE_AUTHOR("Josef Bacik <jbacik@fb.com>");
  821. MODULE_LICENSE("GPL");