dm-log-writes.c 25 KB

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