dm-bufio.c 42 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773
  1. /*
  2. * Copyright (C) 2009-2011 Red Hat, Inc.
  3. *
  4. * Author: Mikulas Patocka <mpatocka@redhat.com>
  5. *
  6. * This file is released under the GPL.
  7. */
  8. #include "dm-bufio.h"
  9. #include <linux/device-mapper.h>
  10. #include <linux/dm-io.h>
  11. #include <linux/slab.h>
  12. #include <linux/vmalloc.h>
  13. #include <linux/shrinker.h>
  14. #include <linux/module.h>
  15. #define DM_MSG_PREFIX "bufio"
  16. /*
  17. * Memory management policy:
  18. * Limit the number of buffers to DM_BUFIO_MEMORY_PERCENT of main memory
  19. * or DM_BUFIO_VMALLOC_PERCENT of vmalloc memory (whichever is lower).
  20. * Always allocate at least DM_BUFIO_MIN_BUFFERS buffers.
  21. * Start background writeback when there are DM_BUFIO_WRITEBACK_PERCENT
  22. * dirty buffers.
  23. */
  24. #define DM_BUFIO_MIN_BUFFERS 8
  25. #define DM_BUFIO_MEMORY_PERCENT 2
  26. #define DM_BUFIO_VMALLOC_PERCENT 25
  27. #define DM_BUFIO_WRITEBACK_PERCENT 75
  28. /*
  29. * Check buffer ages in this interval (seconds)
  30. */
  31. #define DM_BUFIO_WORK_TIMER_SECS 10
  32. /*
  33. * Free buffers when they are older than this (seconds)
  34. */
  35. #define DM_BUFIO_DEFAULT_AGE_SECS 60
  36. /*
  37. * The number of bvec entries that are embedded directly in the buffer.
  38. * If the chunk size is larger, dm-io is used to do the io.
  39. */
  40. #define DM_BUFIO_INLINE_VECS 16
  41. /*
  42. * Buffer hash
  43. */
  44. #define DM_BUFIO_HASH_BITS 20
  45. #define DM_BUFIO_HASH(block) \
  46. ((((block) >> DM_BUFIO_HASH_BITS) ^ (block)) & \
  47. ((1 << DM_BUFIO_HASH_BITS) - 1))
  48. /*
  49. * Don't try to use kmem_cache_alloc for blocks larger than this.
  50. * For explanation, see alloc_buffer_data below.
  51. */
  52. #define DM_BUFIO_BLOCK_SIZE_SLAB_LIMIT (PAGE_SIZE >> 1)
  53. #define DM_BUFIO_BLOCK_SIZE_GFP_LIMIT (PAGE_SIZE << (MAX_ORDER - 1))
  54. /*
  55. * dm_buffer->list_mode
  56. */
  57. #define LIST_CLEAN 0
  58. #define LIST_DIRTY 1
  59. #define LIST_SIZE 2
  60. /*
  61. * Linking of buffers:
  62. * All buffers are linked to cache_hash with their hash_list field.
  63. *
  64. * Clean buffers that are not being written (B_WRITING not set)
  65. * are linked to lru[LIST_CLEAN] with their lru_list field.
  66. *
  67. * Dirty and clean buffers that are being written are linked to
  68. * lru[LIST_DIRTY] with their lru_list field. When the write
  69. * finishes, the buffer cannot be relinked immediately (because we
  70. * are in an interrupt context and relinking requires process
  71. * context), so some clean-not-writing buffers can be held on
  72. * dirty_lru too. They are later added to lru in the process
  73. * context.
  74. */
  75. struct dm_bufio_client {
  76. struct mutex lock;
  77. struct list_head lru[LIST_SIZE];
  78. unsigned long n_buffers[LIST_SIZE];
  79. struct block_device *bdev;
  80. unsigned block_size;
  81. unsigned char sectors_per_block_bits;
  82. unsigned char pages_per_block_bits;
  83. unsigned char blocks_per_page_bits;
  84. unsigned aux_size;
  85. void (*alloc_callback)(struct dm_buffer *);
  86. void (*write_callback)(struct dm_buffer *);
  87. struct dm_io_client *dm_io;
  88. struct list_head reserved_buffers;
  89. unsigned need_reserved_buffers;
  90. struct hlist_head *cache_hash;
  91. wait_queue_head_t free_buffer_wait;
  92. int async_write_error;
  93. struct list_head client_list;
  94. struct shrinker shrinker;
  95. };
  96. /*
  97. * Buffer state bits.
  98. */
  99. #define B_READING 0
  100. #define B_WRITING 1
  101. #define B_DIRTY 2
  102. /*
  103. * Describes how the block was allocated:
  104. * kmem_cache_alloc(), __get_free_pages() or vmalloc().
  105. * See the comment at alloc_buffer_data.
  106. */
  107. enum data_mode {
  108. DATA_MODE_SLAB = 0,
  109. DATA_MODE_GET_FREE_PAGES = 1,
  110. DATA_MODE_VMALLOC = 2,
  111. DATA_MODE_LIMIT = 3
  112. };
  113. struct dm_buffer {
  114. struct hlist_node hash_list;
  115. struct list_head lru_list;
  116. sector_t block;
  117. void *data;
  118. enum data_mode data_mode;
  119. unsigned char list_mode; /* LIST_* */
  120. unsigned hold_count;
  121. int read_error;
  122. int write_error;
  123. unsigned long state;
  124. unsigned long last_accessed;
  125. struct dm_bufio_client *c;
  126. struct bio bio;
  127. struct bio_vec bio_vec[DM_BUFIO_INLINE_VECS];
  128. };
  129. /*----------------------------------------------------------------*/
  130. static struct kmem_cache *dm_bufio_caches[PAGE_SHIFT - SECTOR_SHIFT];
  131. static char *dm_bufio_cache_names[PAGE_SHIFT - SECTOR_SHIFT];
  132. static inline int dm_bufio_cache_index(struct dm_bufio_client *c)
  133. {
  134. unsigned ret = c->blocks_per_page_bits - 1;
  135. BUG_ON(ret >= ARRAY_SIZE(dm_bufio_caches));
  136. return ret;
  137. }
  138. #define DM_BUFIO_CACHE(c) (dm_bufio_caches[dm_bufio_cache_index(c)])
  139. #define DM_BUFIO_CACHE_NAME(c) (dm_bufio_cache_names[dm_bufio_cache_index(c)])
  140. #define dm_bufio_in_request() (!!current->bio_list)
  141. static void dm_bufio_lock(struct dm_bufio_client *c)
  142. {
  143. mutex_lock_nested(&c->lock, dm_bufio_in_request());
  144. }
  145. static int dm_bufio_trylock(struct dm_bufio_client *c)
  146. {
  147. return mutex_trylock(&c->lock);
  148. }
  149. static void dm_bufio_unlock(struct dm_bufio_client *c)
  150. {
  151. mutex_unlock(&c->lock);
  152. }
  153. /*
  154. * FIXME Move to sched.h?
  155. */
  156. #ifdef CONFIG_PREEMPT_VOLUNTARY
  157. # define dm_bufio_cond_resched() \
  158. do { \
  159. if (unlikely(need_resched())) \
  160. _cond_resched(); \
  161. } while (0)
  162. #else
  163. # define dm_bufio_cond_resched() do { } while (0)
  164. #endif
  165. /*----------------------------------------------------------------*/
  166. /*
  167. * Default cache size: available memory divided by the ratio.
  168. */
  169. static unsigned long dm_bufio_default_cache_size;
  170. /*
  171. * Total cache size set by the user.
  172. */
  173. static unsigned long dm_bufio_cache_size;
  174. /*
  175. * A copy of dm_bufio_cache_size because dm_bufio_cache_size can change
  176. * at any time. If it disagrees, the user has changed cache size.
  177. */
  178. static unsigned long dm_bufio_cache_size_latch;
  179. static DEFINE_SPINLOCK(param_spinlock);
  180. /*
  181. * Buffers are freed after this timeout
  182. */
  183. static unsigned dm_bufio_max_age = DM_BUFIO_DEFAULT_AGE_SECS;
  184. static unsigned long dm_bufio_peak_allocated;
  185. static unsigned long dm_bufio_allocated_kmem_cache;
  186. static unsigned long dm_bufio_allocated_get_free_pages;
  187. static unsigned long dm_bufio_allocated_vmalloc;
  188. static unsigned long dm_bufio_current_allocated;
  189. /*----------------------------------------------------------------*/
  190. /*
  191. * Per-client cache: dm_bufio_cache_size / dm_bufio_client_count
  192. */
  193. static unsigned long dm_bufio_cache_size_per_client;
  194. /*
  195. * The current number of clients.
  196. */
  197. static int dm_bufio_client_count;
  198. /*
  199. * The list of all clients.
  200. */
  201. static LIST_HEAD(dm_bufio_all_clients);
  202. /*
  203. * This mutex protects dm_bufio_cache_size_latch,
  204. * dm_bufio_cache_size_per_client and dm_bufio_client_count
  205. */
  206. static DEFINE_MUTEX(dm_bufio_clients_lock);
  207. /*----------------------------------------------------------------*/
  208. static void adjust_total_allocated(enum data_mode data_mode, long diff)
  209. {
  210. static unsigned long * const class_ptr[DATA_MODE_LIMIT] = {
  211. &dm_bufio_allocated_kmem_cache,
  212. &dm_bufio_allocated_get_free_pages,
  213. &dm_bufio_allocated_vmalloc,
  214. };
  215. spin_lock(&param_spinlock);
  216. *class_ptr[data_mode] += diff;
  217. dm_bufio_current_allocated += diff;
  218. if (dm_bufio_current_allocated > dm_bufio_peak_allocated)
  219. dm_bufio_peak_allocated = dm_bufio_current_allocated;
  220. spin_unlock(&param_spinlock);
  221. }
  222. /*
  223. * Change the number of clients and recalculate per-client limit.
  224. */
  225. static void __cache_size_refresh(void)
  226. {
  227. BUG_ON(!mutex_is_locked(&dm_bufio_clients_lock));
  228. BUG_ON(dm_bufio_client_count < 0);
  229. dm_bufio_cache_size_latch = ACCESS_ONCE(dm_bufio_cache_size);
  230. /*
  231. * Use default if set to 0 and report the actual cache size used.
  232. */
  233. if (!dm_bufio_cache_size_latch) {
  234. (void)cmpxchg(&dm_bufio_cache_size, 0,
  235. dm_bufio_default_cache_size);
  236. dm_bufio_cache_size_latch = dm_bufio_default_cache_size;
  237. }
  238. dm_bufio_cache_size_per_client = dm_bufio_cache_size_latch /
  239. (dm_bufio_client_count ? : 1);
  240. }
  241. /*
  242. * Allocating buffer data.
  243. *
  244. * Small buffers are allocated with kmem_cache, to use space optimally.
  245. *
  246. * For large buffers, we choose between get_free_pages and vmalloc.
  247. * Each has advantages and disadvantages.
  248. *
  249. * __get_free_pages can randomly fail if the memory is fragmented.
  250. * __vmalloc won't randomly fail, but vmalloc space is limited (it may be
  251. * as low as 128M) so using it for caching is not appropriate.
  252. *
  253. * If the allocation may fail we use __get_free_pages. Memory fragmentation
  254. * won't have a fatal effect here, but it just causes flushes of some other
  255. * buffers and more I/O will be performed. Don't use __get_free_pages if it
  256. * always fails (i.e. order >= MAX_ORDER).
  257. *
  258. * If the allocation shouldn't fail we use __vmalloc. This is only for the
  259. * initial reserve allocation, so there's no risk of wasting all vmalloc
  260. * space.
  261. */
  262. static void *alloc_buffer_data(struct dm_bufio_client *c, gfp_t gfp_mask,
  263. enum data_mode *data_mode)
  264. {
  265. unsigned noio_flag;
  266. void *ptr;
  267. if (c->block_size <= DM_BUFIO_BLOCK_SIZE_SLAB_LIMIT) {
  268. *data_mode = DATA_MODE_SLAB;
  269. return kmem_cache_alloc(DM_BUFIO_CACHE(c), gfp_mask);
  270. }
  271. if (c->block_size <= DM_BUFIO_BLOCK_SIZE_GFP_LIMIT &&
  272. gfp_mask & __GFP_NORETRY) {
  273. *data_mode = DATA_MODE_GET_FREE_PAGES;
  274. return (void *)__get_free_pages(gfp_mask,
  275. c->pages_per_block_bits);
  276. }
  277. *data_mode = DATA_MODE_VMALLOC;
  278. /*
  279. * __vmalloc allocates the data pages and auxiliary structures with
  280. * gfp_flags that were specified, but pagetables are always allocated
  281. * with GFP_KERNEL, no matter what was specified as gfp_mask.
  282. *
  283. * Consequently, we must set per-process flag PF_MEMALLOC_NOIO so that
  284. * all allocations done by this process (including pagetables) are done
  285. * as if GFP_NOIO was specified.
  286. */
  287. if (gfp_mask & __GFP_NORETRY)
  288. noio_flag = memalloc_noio_save();
  289. ptr = __vmalloc(c->block_size, gfp_mask, PAGE_KERNEL);
  290. if (gfp_mask & __GFP_NORETRY)
  291. memalloc_noio_restore(noio_flag);
  292. return ptr;
  293. }
  294. /*
  295. * Free buffer's data.
  296. */
  297. static void free_buffer_data(struct dm_bufio_client *c,
  298. void *data, enum data_mode data_mode)
  299. {
  300. switch (data_mode) {
  301. case DATA_MODE_SLAB:
  302. kmem_cache_free(DM_BUFIO_CACHE(c), data);
  303. break;
  304. case DATA_MODE_GET_FREE_PAGES:
  305. free_pages((unsigned long)data, c->pages_per_block_bits);
  306. break;
  307. case DATA_MODE_VMALLOC:
  308. vfree(data);
  309. break;
  310. default:
  311. DMCRIT("dm_bufio_free_buffer_data: bad data mode: %d",
  312. data_mode);
  313. BUG();
  314. }
  315. }
  316. /*
  317. * Allocate buffer and its data.
  318. */
  319. static struct dm_buffer *alloc_buffer(struct dm_bufio_client *c, gfp_t gfp_mask)
  320. {
  321. struct dm_buffer *b = kmalloc(sizeof(struct dm_buffer) + c->aux_size,
  322. gfp_mask);
  323. if (!b)
  324. return NULL;
  325. b->c = c;
  326. b->data = alloc_buffer_data(c, gfp_mask, &b->data_mode);
  327. if (!b->data) {
  328. kfree(b);
  329. return NULL;
  330. }
  331. adjust_total_allocated(b->data_mode, (long)c->block_size);
  332. return b;
  333. }
  334. /*
  335. * Free buffer and its data.
  336. */
  337. static void free_buffer(struct dm_buffer *b)
  338. {
  339. struct dm_bufio_client *c = b->c;
  340. adjust_total_allocated(b->data_mode, -(long)c->block_size);
  341. free_buffer_data(c, b->data, b->data_mode);
  342. kfree(b);
  343. }
  344. /*
  345. * Link buffer to the hash list and clean or dirty queue.
  346. */
  347. static void __link_buffer(struct dm_buffer *b, sector_t block, int dirty)
  348. {
  349. struct dm_bufio_client *c = b->c;
  350. c->n_buffers[dirty]++;
  351. b->block = block;
  352. b->list_mode = dirty;
  353. list_add(&b->lru_list, &c->lru[dirty]);
  354. hlist_add_head(&b->hash_list, &c->cache_hash[DM_BUFIO_HASH(block)]);
  355. b->last_accessed = jiffies;
  356. }
  357. /*
  358. * Unlink buffer from the hash list and dirty or clean queue.
  359. */
  360. static void __unlink_buffer(struct dm_buffer *b)
  361. {
  362. struct dm_bufio_client *c = b->c;
  363. BUG_ON(!c->n_buffers[b->list_mode]);
  364. c->n_buffers[b->list_mode]--;
  365. hlist_del(&b->hash_list);
  366. list_del(&b->lru_list);
  367. }
  368. /*
  369. * Place the buffer to the head of dirty or clean LRU queue.
  370. */
  371. static void __relink_lru(struct dm_buffer *b, int dirty)
  372. {
  373. struct dm_bufio_client *c = b->c;
  374. BUG_ON(!c->n_buffers[b->list_mode]);
  375. c->n_buffers[b->list_mode]--;
  376. c->n_buffers[dirty]++;
  377. b->list_mode = dirty;
  378. list_move(&b->lru_list, &c->lru[dirty]);
  379. }
  380. /*----------------------------------------------------------------
  381. * Submit I/O on the buffer.
  382. *
  383. * Bio interface is faster but it has some problems:
  384. * the vector list is limited (increasing this limit increases
  385. * memory-consumption per buffer, so it is not viable);
  386. *
  387. * the memory must be direct-mapped, not vmalloced;
  388. *
  389. * the I/O driver can reject requests spuriously if it thinks that
  390. * the requests are too big for the device or if they cross a
  391. * controller-defined memory boundary.
  392. *
  393. * If the buffer is small enough (up to DM_BUFIO_INLINE_VECS pages) and
  394. * it is not vmalloced, try using the bio interface.
  395. *
  396. * If the buffer is big, if it is vmalloced or if the underlying device
  397. * rejects the bio because it is too large, use dm-io layer to do the I/O.
  398. * The dm-io layer splits the I/O into multiple requests, avoiding the above
  399. * shortcomings.
  400. *--------------------------------------------------------------*/
  401. /*
  402. * dm-io completion routine. It just calls b->bio.bi_end_io, pretending
  403. * that the request was handled directly with bio interface.
  404. */
  405. static void dmio_complete(unsigned long error, void *context)
  406. {
  407. struct dm_buffer *b = context;
  408. b->bio.bi_end_io(&b->bio, error ? -EIO : 0);
  409. }
  410. static void use_dmio(struct dm_buffer *b, int rw, sector_t block,
  411. bio_end_io_t *end_io)
  412. {
  413. int r;
  414. struct dm_io_request io_req = {
  415. .bi_rw = rw,
  416. .notify.fn = dmio_complete,
  417. .notify.context = b,
  418. .client = b->c->dm_io,
  419. };
  420. struct dm_io_region region = {
  421. .bdev = b->c->bdev,
  422. .sector = block << b->c->sectors_per_block_bits,
  423. .count = b->c->block_size >> SECTOR_SHIFT,
  424. };
  425. if (b->data_mode != DATA_MODE_VMALLOC) {
  426. io_req.mem.type = DM_IO_KMEM;
  427. io_req.mem.ptr.addr = b->data;
  428. } else {
  429. io_req.mem.type = DM_IO_VMA;
  430. io_req.mem.ptr.vma = b->data;
  431. }
  432. b->bio.bi_end_io = end_io;
  433. r = dm_io(&io_req, 1, &region, NULL);
  434. if (r)
  435. end_io(&b->bio, r);
  436. }
  437. static void use_inline_bio(struct dm_buffer *b, int rw, sector_t block,
  438. bio_end_io_t *end_io)
  439. {
  440. char *ptr;
  441. int len;
  442. bio_init(&b->bio);
  443. b->bio.bi_io_vec = b->bio_vec;
  444. b->bio.bi_max_vecs = DM_BUFIO_INLINE_VECS;
  445. b->bio.bi_sector = block << b->c->sectors_per_block_bits;
  446. b->bio.bi_bdev = b->c->bdev;
  447. b->bio.bi_end_io = end_io;
  448. /*
  449. * We assume that if len >= PAGE_SIZE ptr is page-aligned.
  450. * If len < PAGE_SIZE the buffer doesn't cross page boundary.
  451. */
  452. ptr = b->data;
  453. len = b->c->block_size;
  454. if (len >= PAGE_SIZE)
  455. BUG_ON((unsigned long)ptr & (PAGE_SIZE - 1));
  456. else
  457. BUG_ON((unsigned long)ptr & (len - 1));
  458. do {
  459. if (!bio_add_page(&b->bio, virt_to_page(ptr),
  460. len < PAGE_SIZE ? len : PAGE_SIZE,
  461. virt_to_phys(ptr) & (PAGE_SIZE - 1))) {
  462. BUG_ON(b->c->block_size <= PAGE_SIZE);
  463. use_dmio(b, rw, block, end_io);
  464. return;
  465. }
  466. len -= PAGE_SIZE;
  467. ptr += PAGE_SIZE;
  468. } while (len > 0);
  469. submit_bio(rw, &b->bio);
  470. }
  471. static void submit_io(struct dm_buffer *b, int rw, sector_t block,
  472. bio_end_io_t *end_io)
  473. {
  474. if (rw == WRITE && b->c->write_callback)
  475. b->c->write_callback(b);
  476. if (b->c->block_size <= DM_BUFIO_INLINE_VECS * PAGE_SIZE &&
  477. b->data_mode != DATA_MODE_VMALLOC)
  478. use_inline_bio(b, rw, block, end_io);
  479. else
  480. use_dmio(b, rw, block, end_io);
  481. }
  482. /*----------------------------------------------------------------
  483. * Writing dirty buffers
  484. *--------------------------------------------------------------*/
  485. /*
  486. * The endio routine for write.
  487. *
  488. * Set the error, clear B_WRITING bit and wake anyone who was waiting on
  489. * it.
  490. */
  491. static void write_endio(struct bio *bio, int error)
  492. {
  493. struct dm_buffer *b = container_of(bio, struct dm_buffer, bio);
  494. b->write_error = error;
  495. if (unlikely(error)) {
  496. struct dm_bufio_client *c = b->c;
  497. (void)cmpxchg(&c->async_write_error, 0, error);
  498. }
  499. BUG_ON(!test_bit(B_WRITING, &b->state));
  500. smp_mb__before_clear_bit();
  501. clear_bit(B_WRITING, &b->state);
  502. smp_mb__after_clear_bit();
  503. wake_up_bit(&b->state, B_WRITING);
  504. }
  505. /*
  506. * This function is called when wait_on_bit is actually waiting.
  507. */
  508. static int do_io_schedule(void *word)
  509. {
  510. io_schedule();
  511. return 0;
  512. }
  513. /*
  514. * Initiate a write on a dirty buffer, but don't wait for it.
  515. *
  516. * - If the buffer is not dirty, exit.
  517. * - If there some previous write going on, wait for it to finish (we can't
  518. * have two writes on the same buffer simultaneously).
  519. * - Submit our write and don't wait on it. We set B_WRITING indicating
  520. * that there is a write in progress.
  521. */
  522. static void __write_dirty_buffer(struct dm_buffer *b)
  523. {
  524. if (!test_bit(B_DIRTY, &b->state))
  525. return;
  526. clear_bit(B_DIRTY, &b->state);
  527. wait_on_bit_lock(&b->state, B_WRITING,
  528. do_io_schedule, TASK_UNINTERRUPTIBLE);
  529. submit_io(b, WRITE, b->block, write_endio);
  530. }
  531. /*
  532. * Wait until any activity on the buffer finishes. Possibly write the
  533. * buffer if it is dirty. When this function finishes, there is no I/O
  534. * running on the buffer and the buffer is not dirty.
  535. */
  536. static void __make_buffer_clean(struct dm_buffer *b)
  537. {
  538. BUG_ON(b->hold_count);
  539. if (!b->state) /* fast case */
  540. return;
  541. wait_on_bit(&b->state, B_READING, do_io_schedule, TASK_UNINTERRUPTIBLE);
  542. __write_dirty_buffer(b);
  543. wait_on_bit(&b->state, B_WRITING, do_io_schedule, TASK_UNINTERRUPTIBLE);
  544. }
  545. /*
  546. * Find some buffer that is not held by anybody, clean it, unlink it and
  547. * return it.
  548. */
  549. static struct dm_buffer *__get_unclaimed_buffer(struct dm_bufio_client *c)
  550. {
  551. struct dm_buffer *b;
  552. list_for_each_entry_reverse(b, &c->lru[LIST_CLEAN], lru_list) {
  553. BUG_ON(test_bit(B_WRITING, &b->state));
  554. BUG_ON(test_bit(B_DIRTY, &b->state));
  555. if (!b->hold_count) {
  556. __make_buffer_clean(b);
  557. __unlink_buffer(b);
  558. return b;
  559. }
  560. dm_bufio_cond_resched();
  561. }
  562. list_for_each_entry_reverse(b, &c->lru[LIST_DIRTY], lru_list) {
  563. BUG_ON(test_bit(B_READING, &b->state));
  564. if (!b->hold_count) {
  565. __make_buffer_clean(b);
  566. __unlink_buffer(b);
  567. return b;
  568. }
  569. dm_bufio_cond_resched();
  570. }
  571. return NULL;
  572. }
  573. /*
  574. * Wait until some other threads free some buffer or release hold count on
  575. * some buffer.
  576. *
  577. * This function is entered with c->lock held, drops it and regains it
  578. * before exiting.
  579. */
  580. static void __wait_for_free_buffer(struct dm_bufio_client *c)
  581. {
  582. DECLARE_WAITQUEUE(wait, current);
  583. add_wait_queue(&c->free_buffer_wait, &wait);
  584. set_task_state(current, TASK_UNINTERRUPTIBLE);
  585. dm_bufio_unlock(c);
  586. io_schedule();
  587. set_task_state(current, TASK_RUNNING);
  588. remove_wait_queue(&c->free_buffer_wait, &wait);
  589. dm_bufio_lock(c);
  590. }
  591. enum new_flag {
  592. NF_FRESH = 0,
  593. NF_READ = 1,
  594. NF_GET = 2,
  595. NF_PREFETCH = 3
  596. };
  597. /*
  598. * Allocate a new buffer. If the allocation is not possible, wait until
  599. * some other thread frees a buffer.
  600. *
  601. * May drop the lock and regain it.
  602. */
  603. static struct dm_buffer *__alloc_buffer_wait_no_callback(struct dm_bufio_client *c, enum new_flag nf)
  604. {
  605. struct dm_buffer *b;
  606. /*
  607. * dm-bufio is resistant to allocation failures (it just keeps
  608. * one buffer reserved in cases all the allocations fail).
  609. * So set flags to not try too hard:
  610. * GFP_NOIO: don't recurse into the I/O layer
  611. * __GFP_NORETRY: don't retry and rather return failure
  612. * __GFP_NOMEMALLOC: don't use emergency reserves
  613. * __GFP_NOWARN: don't print a warning in case of failure
  614. *
  615. * For debugging, if we set the cache size to 1, no new buffers will
  616. * be allocated.
  617. */
  618. while (1) {
  619. if (dm_bufio_cache_size_latch != 1) {
  620. b = alloc_buffer(c, GFP_NOIO | __GFP_NORETRY | __GFP_NOMEMALLOC | __GFP_NOWARN);
  621. if (b)
  622. return b;
  623. }
  624. if (nf == NF_PREFETCH)
  625. return NULL;
  626. if (!list_empty(&c->reserved_buffers)) {
  627. b = list_entry(c->reserved_buffers.next,
  628. struct dm_buffer, lru_list);
  629. list_del(&b->lru_list);
  630. c->need_reserved_buffers++;
  631. return b;
  632. }
  633. b = __get_unclaimed_buffer(c);
  634. if (b)
  635. return b;
  636. __wait_for_free_buffer(c);
  637. }
  638. }
  639. static struct dm_buffer *__alloc_buffer_wait(struct dm_bufio_client *c, enum new_flag nf)
  640. {
  641. struct dm_buffer *b = __alloc_buffer_wait_no_callback(c, nf);
  642. if (!b)
  643. return NULL;
  644. if (c->alloc_callback)
  645. c->alloc_callback(b);
  646. return b;
  647. }
  648. /*
  649. * Free a buffer and wake other threads waiting for free buffers.
  650. */
  651. static void __free_buffer_wake(struct dm_buffer *b)
  652. {
  653. struct dm_bufio_client *c = b->c;
  654. if (!c->need_reserved_buffers)
  655. free_buffer(b);
  656. else {
  657. list_add(&b->lru_list, &c->reserved_buffers);
  658. c->need_reserved_buffers--;
  659. }
  660. wake_up(&c->free_buffer_wait);
  661. }
  662. static void __write_dirty_buffers_async(struct dm_bufio_client *c, int no_wait)
  663. {
  664. struct dm_buffer *b, *tmp;
  665. list_for_each_entry_safe_reverse(b, tmp, &c->lru[LIST_DIRTY], lru_list) {
  666. BUG_ON(test_bit(B_READING, &b->state));
  667. if (!test_bit(B_DIRTY, &b->state) &&
  668. !test_bit(B_WRITING, &b->state)) {
  669. __relink_lru(b, LIST_CLEAN);
  670. continue;
  671. }
  672. if (no_wait && test_bit(B_WRITING, &b->state))
  673. return;
  674. __write_dirty_buffer(b);
  675. dm_bufio_cond_resched();
  676. }
  677. }
  678. /*
  679. * Get writeback threshold and buffer limit for a given client.
  680. */
  681. static void __get_memory_limit(struct dm_bufio_client *c,
  682. unsigned long *threshold_buffers,
  683. unsigned long *limit_buffers)
  684. {
  685. unsigned long buffers;
  686. if (ACCESS_ONCE(dm_bufio_cache_size) != dm_bufio_cache_size_latch) {
  687. mutex_lock(&dm_bufio_clients_lock);
  688. __cache_size_refresh();
  689. mutex_unlock(&dm_bufio_clients_lock);
  690. }
  691. buffers = dm_bufio_cache_size_per_client >>
  692. (c->sectors_per_block_bits + SECTOR_SHIFT);
  693. if (buffers < DM_BUFIO_MIN_BUFFERS)
  694. buffers = DM_BUFIO_MIN_BUFFERS;
  695. *limit_buffers = buffers;
  696. *threshold_buffers = buffers * DM_BUFIO_WRITEBACK_PERCENT / 100;
  697. }
  698. /*
  699. * Check if we're over watermark.
  700. * If we are over threshold_buffers, start freeing buffers.
  701. * If we're over "limit_buffers", block until we get under the limit.
  702. */
  703. static void __check_watermark(struct dm_bufio_client *c)
  704. {
  705. unsigned long threshold_buffers, limit_buffers;
  706. __get_memory_limit(c, &threshold_buffers, &limit_buffers);
  707. while (c->n_buffers[LIST_CLEAN] + c->n_buffers[LIST_DIRTY] >
  708. limit_buffers) {
  709. struct dm_buffer *b = __get_unclaimed_buffer(c);
  710. if (!b)
  711. return;
  712. __free_buffer_wake(b);
  713. dm_bufio_cond_resched();
  714. }
  715. if (c->n_buffers[LIST_DIRTY] > threshold_buffers)
  716. __write_dirty_buffers_async(c, 1);
  717. }
  718. /*
  719. * Find a buffer in the hash.
  720. */
  721. static struct dm_buffer *__find(struct dm_bufio_client *c, sector_t block)
  722. {
  723. struct dm_buffer *b;
  724. hlist_for_each_entry(b, &c->cache_hash[DM_BUFIO_HASH(block)],
  725. hash_list) {
  726. dm_bufio_cond_resched();
  727. if (b->block == block)
  728. return b;
  729. }
  730. return NULL;
  731. }
  732. /*----------------------------------------------------------------
  733. * Getting a buffer
  734. *--------------------------------------------------------------*/
  735. static struct dm_buffer *__bufio_new(struct dm_bufio_client *c, sector_t block,
  736. enum new_flag nf, int *need_submit)
  737. {
  738. struct dm_buffer *b, *new_b = NULL;
  739. *need_submit = 0;
  740. b = __find(c, block);
  741. if (b)
  742. goto found_buffer;
  743. if (nf == NF_GET)
  744. return NULL;
  745. new_b = __alloc_buffer_wait(c, nf);
  746. if (!new_b)
  747. return NULL;
  748. /*
  749. * We've had a period where the mutex was unlocked, so need to
  750. * recheck the hash table.
  751. */
  752. b = __find(c, block);
  753. if (b) {
  754. __free_buffer_wake(new_b);
  755. goto found_buffer;
  756. }
  757. __check_watermark(c);
  758. b = new_b;
  759. b->hold_count = 1;
  760. b->read_error = 0;
  761. b->write_error = 0;
  762. __link_buffer(b, block, LIST_CLEAN);
  763. if (nf == NF_FRESH) {
  764. b->state = 0;
  765. return b;
  766. }
  767. b->state = 1 << B_READING;
  768. *need_submit = 1;
  769. return b;
  770. found_buffer:
  771. if (nf == NF_PREFETCH)
  772. return NULL;
  773. /*
  774. * Note: it is essential that we don't wait for the buffer to be
  775. * read if dm_bufio_get function is used. Both dm_bufio_get and
  776. * dm_bufio_prefetch can be used in the driver request routine.
  777. * If the user called both dm_bufio_prefetch and dm_bufio_get on
  778. * the same buffer, it would deadlock if we waited.
  779. */
  780. if (nf == NF_GET && unlikely(test_bit(B_READING, &b->state)))
  781. return NULL;
  782. b->hold_count++;
  783. __relink_lru(b, test_bit(B_DIRTY, &b->state) ||
  784. test_bit(B_WRITING, &b->state));
  785. return b;
  786. }
  787. /*
  788. * The endio routine for reading: set the error, clear the bit and wake up
  789. * anyone waiting on the buffer.
  790. */
  791. static void read_endio(struct bio *bio, int error)
  792. {
  793. struct dm_buffer *b = container_of(bio, struct dm_buffer, bio);
  794. b->read_error = error;
  795. BUG_ON(!test_bit(B_READING, &b->state));
  796. smp_mb__before_clear_bit();
  797. clear_bit(B_READING, &b->state);
  798. smp_mb__after_clear_bit();
  799. wake_up_bit(&b->state, B_READING);
  800. }
  801. /*
  802. * A common routine for dm_bufio_new and dm_bufio_read. Operation of these
  803. * functions is similar except that dm_bufio_new doesn't read the
  804. * buffer from the disk (assuming that the caller overwrites all the data
  805. * and uses dm_bufio_mark_buffer_dirty to write new data back).
  806. */
  807. static void *new_read(struct dm_bufio_client *c, sector_t block,
  808. enum new_flag nf, struct dm_buffer **bp)
  809. {
  810. int need_submit;
  811. struct dm_buffer *b;
  812. dm_bufio_lock(c);
  813. b = __bufio_new(c, block, nf, &need_submit);
  814. dm_bufio_unlock(c);
  815. if (!b)
  816. return b;
  817. if (need_submit)
  818. submit_io(b, READ, b->block, read_endio);
  819. wait_on_bit(&b->state, B_READING, do_io_schedule, TASK_UNINTERRUPTIBLE);
  820. if (b->read_error) {
  821. int error = b->read_error;
  822. dm_bufio_release(b);
  823. return ERR_PTR(error);
  824. }
  825. *bp = b;
  826. return b->data;
  827. }
  828. void *dm_bufio_get(struct dm_bufio_client *c, sector_t block,
  829. struct dm_buffer **bp)
  830. {
  831. return new_read(c, block, NF_GET, bp);
  832. }
  833. EXPORT_SYMBOL_GPL(dm_bufio_get);
  834. void *dm_bufio_read(struct dm_bufio_client *c, sector_t block,
  835. struct dm_buffer **bp)
  836. {
  837. BUG_ON(dm_bufio_in_request());
  838. return new_read(c, block, NF_READ, bp);
  839. }
  840. EXPORT_SYMBOL_GPL(dm_bufio_read);
  841. void *dm_bufio_new(struct dm_bufio_client *c, sector_t block,
  842. struct dm_buffer **bp)
  843. {
  844. BUG_ON(dm_bufio_in_request());
  845. return new_read(c, block, NF_FRESH, bp);
  846. }
  847. EXPORT_SYMBOL_GPL(dm_bufio_new);
  848. void dm_bufio_prefetch(struct dm_bufio_client *c,
  849. sector_t block, unsigned n_blocks)
  850. {
  851. struct blk_plug plug;
  852. BUG_ON(dm_bufio_in_request());
  853. blk_start_plug(&plug);
  854. dm_bufio_lock(c);
  855. for (; n_blocks--; block++) {
  856. int need_submit;
  857. struct dm_buffer *b;
  858. b = __bufio_new(c, block, NF_PREFETCH, &need_submit);
  859. if (unlikely(b != NULL)) {
  860. dm_bufio_unlock(c);
  861. if (need_submit)
  862. submit_io(b, READ, b->block, read_endio);
  863. dm_bufio_release(b);
  864. dm_bufio_cond_resched();
  865. if (!n_blocks)
  866. goto flush_plug;
  867. dm_bufio_lock(c);
  868. }
  869. }
  870. dm_bufio_unlock(c);
  871. flush_plug:
  872. blk_finish_plug(&plug);
  873. }
  874. EXPORT_SYMBOL_GPL(dm_bufio_prefetch);
  875. void dm_bufio_release(struct dm_buffer *b)
  876. {
  877. struct dm_bufio_client *c = b->c;
  878. dm_bufio_lock(c);
  879. BUG_ON(!b->hold_count);
  880. b->hold_count--;
  881. if (!b->hold_count) {
  882. wake_up(&c->free_buffer_wait);
  883. /*
  884. * If there were errors on the buffer, and the buffer is not
  885. * to be written, free the buffer. There is no point in caching
  886. * invalid buffer.
  887. */
  888. if ((b->read_error || b->write_error) &&
  889. !test_bit(B_READING, &b->state) &&
  890. !test_bit(B_WRITING, &b->state) &&
  891. !test_bit(B_DIRTY, &b->state)) {
  892. __unlink_buffer(b);
  893. __free_buffer_wake(b);
  894. }
  895. }
  896. dm_bufio_unlock(c);
  897. }
  898. EXPORT_SYMBOL_GPL(dm_bufio_release);
  899. void dm_bufio_mark_buffer_dirty(struct dm_buffer *b)
  900. {
  901. struct dm_bufio_client *c = b->c;
  902. dm_bufio_lock(c);
  903. BUG_ON(test_bit(B_READING, &b->state));
  904. if (!test_and_set_bit(B_DIRTY, &b->state))
  905. __relink_lru(b, LIST_DIRTY);
  906. dm_bufio_unlock(c);
  907. }
  908. EXPORT_SYMBOL_GPL(dm_bufio_mark_buffer_dirty);
  909. void dm_bufio_write_dirty_buffers_async(struct dm_bufio_client *c)
  910. {
  911. BUG_ON(dm_bufio_in_request());
  912. dm_bufio_lock(c);
  913. __write_dirty_buffers_async(c, 0);
  914. dm_bufio_unlock(c);
  915. }
  916. EXPORT_SYMBOL_GPL(dm_bufio_write_dirty_buffers_async);
  917. /*
  918. * For performance, it is essential that the buffers are written asynchronously
  919. * and simultaneously (so that the block layer can merge the writes) and then
  920. * waited upon.
  921. *
  922. * Finally, we flush hardware disk cache.
  923. */
  924. int dm_bufio_write_dirty_buffers(struct dm_bufio_client *c)
  925. {
  926. int a, f;
  927. unsigned long buffers_processed = 0;
  928. struct dm_buffer *b, *tmp;
  929. dm_bufio_lock(c);
  930. __write_dirty_buffers_async(c, 0);
  931. again:
  932. list_for_each_entry_safe_reverse(b, tmp, &c->lru[LIST_DIRTY], lru_list) {
  933. int dropped_lock = 0;
  934. if (buffers_processed < c->n_buffers[LIST_DIRTY])
  935. buffers_processed++;
  936. BUG_ON(test_bit(B_READING, &b->state));
  937. if (test_bit(B_WRITING, &b->state)) {
  938. if (buffers_processed < c->n_buffers[LIST_DIRTY]) {
  939. dropped_lock = 1;
  940. b->hold_count++;
  941. dm_bufio_unlock(c);
  942. wait_on_bit(&b->state, B_WRITING,
  943. do_io_schedule,
  944. TASK_UNINTERRUPTIBLE);
  945. dm_bufio_lock(c);
  946. b->hold_count--;
  947. } else
  948. wait_on_bit(&b->state, B_WRITING,
  949. do_io_schedule,
  950. TASK_UNINTERRUPTIBLE);
  951. }
  952. if (!test_bit(B_DIRTY, &b->state) &&
  953. !test_bit(B_WRITING, &b->state))
  954. __relink_lru(b, LIST_CLEAN);
  955. dm_bufio_cond_resched();
  956. /*
  957. * If we dropped the lock, the list is no longer consistent,
  958. * so we must restart the search.
  959. *
  960. * In the most common case, the buffer just processed is
  961. * relinked to the clean list, so we won't loop scanning the
  962. * same buffer again and again.
  963. *
  964. * This may livelock if there is another thread simultaneously
  965. * dirtying buffers, so we count the number of buffers walked
  966. * and if it exceeds the total number of buffers, it means that
  967. * someone is doing some writes simultaneously with us. In
  968. * this case, stop, dropping the lock.
  969. */
  970. if (dropped_lock)
  971. goto again;
  972. }
  973. wake_up(&c->free_buffer_wait);
  974. dm_bufio_unlock(c);
  975. a = xchg(&c->async_write_error, 0);
  976. f = dm_bufio_issue_flush(c);
  977. if (a)
  978. return a;
  979. return f;
  980. }
  981. EXPORT_SYMBOL_GPL(dm_bufio_write_dirty_buffers);
  982. /*
  983. * Use dm-io to send and empty barrier flush the device.
  984. */
  985. int dm_bufio_issue_flush(struct dm_bufio_client *c)
  986. {
  987. struct dm_io_request io_req = {
  988. .bi_rw = WRITE_FLUSH,
  989. .mem.type = DM_IO_KMEM,
  990. .mem.ptr.addr = NULL,
  991. .client = c->dm_io,
  992. };
  993. struct dm_io_region io_reg = {
  994. .bdev = c->bdev,
  995. .sector = 0,
  996. .count = 0,
  997. };
  998. BUG_ON(dm_bufio_in_request());
  999. return dm_io(&io_req, 1, &io_reg, NULL);
  1000. }
  1001. EXPORT_SYMBOL_GPL(dm_bufio_issue_flush);
  1002. /*
  1003. * We first delete any other buffer that may be at that new location.
  1004. *
  1005. * Then, we write the buffer to the original location if it was dirty.
  1006. *
  1007. * Then, if we are the only one who is holding the buffer, relink the buffer
  1008. * in the hash queue for the new location.
  1009. *
  1010. * If there was someone else holding the buffer, we write it to the new
  1011. * location but not relink it, because that other user needs to have the buffer
  1012. * at the same place.
  1013. */
  1014. void dm_bufio_release_move(struct dm_buffer *b, sector_t new_block)
  1015. {
  1016. struct dm_bufio_client *c = b->c;
  1017. struct dm_buffer *new;
  1018. BUG_ON(dm_bufio_in_request());
  1019. dm_bufio_lock(c);
  1020. retry:
  1021. new = __find(c, new_block);
  1022. if (new) {
  1023. if (new->hold_count) {
  1024. __wait_for_free_buffer(c);
  1025. goto retry;
  1026. }
  1027. /*
  1028. * FIXME: Is there any point waiting for a write that's going
  1029. * to be overwritten in a bit?
  1030. */
  1031. __make_buffer_clean(new);
  1032. __unlink_buffer(new);
  1033. __free_buffer_wake(new);
  1034. }
  1035. BUG_ON(!b->hold_count);
  1036. BUG_ON(test_bit(B_READING, &b->state));
  1037. __write_dirty_buffer(b);
  1038. if (b->hold_count == 1) {
  1039. wait_on_bit(&b->state, B_WRITING,
  1040. do_io_schedule, TASK_UNINTERRUPTIBLE);
  1041. set_bit(B_DIRTY, &b->state);
  1042. __unlink_buffer(b);
  1043. __link_buffer(b, new_block, LIST_DIRTY);
  1044. } else {
  1045. sector_t old_block;
  1046. wait_on_bit_lock(&b->state, B_WRITING,
  1047. do_io_schedule, TASK_UNINTERRUPTIBLE);
  1048. /*
  1049. * Relink buffer to "new_block" so that write_callback
  1050. * sees "new_block" as a block number.
  1051. * After the write, link the buffer back to old_block.
  1052. * All this must be done in bufio lock, so that block number
  1053. * change isn't visible to other threads.
  1054. */
  1055. old_block = b->block;
  1056. __unlink_buffer(b);
  1057. __link_buffer(b, new_block, b->list_mode);
  1058. submit_io(b, WRITE, new_block, write_endio);
  1059. wait_on_bit(&b->state, B_WRITING,
  1060. do_io_schedule, TASK_UNINTERRUPTIBLE);
  1061. __unlink_buffer(b);
  1062. __link_buffer(b, old_block, b->list_mode);
  1063. }
  1064. dm_bufio_unlock(c);
  1065. dm_bufio_release(b);
  1066. }
  1067. EXPORT_SYMBOL_GPL(dm_bufio_release_move);
  1068. unsigned dm_bufio_get_block_size(struct dm_bufio_client *c)
  1069. {
  1070. return c->block_size;
  1071. }
  1072. EXPORT_SYMBOL_GPL(dm_bufio_get_block_size);
  1073. sector_t dm_bufio_get_device_size(struct dm_bufio_client *c)
  1074. {
  1075. return i_size_read(c->bdev->bd_inode) >>
  1076. (SECTOR_SHIFT + c->sectors_per_block_bits);
  1077. }
  1078. EXPORT_SYMBOL_GPL(dm_bufio_get_device_size);
  1079. sector_t dm_bufio_get_block_number(struct dm_buffer *b)
  1080. {
  1081. return b->block;
  1082. }
  1083. EXPORT_SYMBOL_GPL(dm_bufio_get_block_number);
  1084. void *dm_bufio_get_block_data(struct dm_buffer *b)
  1085. {
  1086. return b->data;
  1087. }
  1088. EXPORT_SYMBOL_GPL(dm_bufio_get_block_data);
  1089. void *dm_bufio_get_aux_data(struct dm_buffer *b)
  1090. {
  1091. return b + 1;
  1092. }
  1093. EXPORT_SYMBOL_GPL(dm_bufio_get_aux_data);
  1094. struct dm_bufio_client *dm_bufio_get_client(struct dm_buffer *b)
  1095. {
  1096. return b->c;
  1097. }
  1098. EXPORT_SYMBOL_GPL(dm_bufio_get_client);
  1099. static void drop_buffers(struct dm_bufio_client *c)
  1100. {
  1101. struct dm_buffer *b;
  1102. int i;
  1103. BUG_ON(dm_bufio_in_request());
  1104. /*
  1105. * An optimization so that the buffers are not written one-by-one.
  1106. */
  1107. dm_bufio_write_dirty_buffers_async(c);
  1108. dm_bufio_lock(c);
  1109. while ((b = __get_unclaimed_buffer(c)))
  1110. __free_buffer_wake(b);
  1111. for (i = 0; i < LIST_SIZE; i++)
  1112. list_for_each_entry(b, &c->lru[i], lru_list)
  1113. DMERR("leaked buffer %llx, hold count %u, list %d",
  1114. (unsigned long long)b->block, b->hold_count, i);
  1115. for (i = 0; i < LIST_SIZE; i++)
  1116. BUG_ON(!list_empty(&c->lru[i]));
  1117. dm_bufio_unlock(c);
  1118. }
  1119. /*
  1120. * Test if the buffer is unused and too old, and commit it.
  1121. * At if noio is set, we must not do any I/O because we hold
  1122. * dm_bufio_clients_lock and we would risk deadlock if the I/O gets rerouted to
  1123. * different bufio client.
  1124. */
  1125. static int __cleanup_old_buffer(struct dm_buffer *b, gfp_t gfp,
  1126. unsigned long max_jiffies)
  1127. {
  1128. if (jiffies - b->last_accessed < max_jiffies)
  1129. return 1;
  1130. if (!(gfp & __GFP_IO)) {
  1131. if (test_bit(B_READING, &b->state) ||
  1132. test_bit(B_WRITING, &b->state) ||
  1133. test_bit(B_DIRTY, &b->state))
  1134. return 1;
  1135. }
  1136. if (b->hold_count)
  1137. return 1;
  1138. __make_buffer_clean(b);
  1139. __unlink_buffer(b);
  1140. __free_buffer_wake(b);
  1141. return 0;
  1142. }
  1143. static void __scan(struct dm_bufio_client *c, unsigned long nr_to_scan,
  1144. struct shrink_control *sc)
  1145. {
  1146. int l;
  1147. struct dm_buffer *b, *tmp;
  1148. for (l = 0; l < LIST_SIZE; l++) {
  1149. list_for_each_entry_safe_reverse(b, tmp, &c->lru[l], lru_list)
  1150. if (!__cleanup_old_buffer(b, sc->gfp_mask, 0) &&
  1151. !--nr_to_scan)
  1152. return;
  1153. dm_bufio_cond_resched();
  1154. }
  1155. }
  1156. static int shrink(struct shrinker *shrinker, struct shrink_control *sc)
  1157. {
  1158. struct dm_bufio_client *c =
  1159. container_of(shrinker, struct dm_bufio_client, shrinker);
  1160. unsigned long r;
  1161. unsigned long nr_to_scan = sc->nr_to_scan;
  1162. if (sc->gfp_mask & __GFP_IO)
  1163. dm_bufio_lock(c);
  1164. else if (!dm_bufio_trylock(c))
  1165. return !nr_to_scan ? 0 : -1;
  1166. if (nr_to_scan)
  1167. __scan(c, nr_to_scan, sc);
  1168. r = c->n_buffers[LIST_CLEAN] + c->n_buffers[LIST_DIRTY];
  1169. if (r > INT_MAX)
  1170. r = INT_MAX;
  1171. dm_bufio_unlock(c);
  1172. return r;
  1173. }
  1174. /*
  1175. * Create the buffering interface
  1176. */
  1177. struct dm_bufio_client *dm_bufio_client_create(struct block_device *bdev, unsigned block_size,
  1178. unsigned reserved_buffers, unsigned aux_size,
  1179. void (*alloc_callback)(struct dm_buffer *),
  1180. void (*write_callback)(struct dm_buffer *))
  1181. {
  1182. int r;
  1183. struct dm_bufio_client *c;
  1184. unsigned i;
  1185. BUG_ON(block_size < 1 << SECTOR_SHIFT ||
  1186. (block_size & (block_size - 1)));
  1187. c = kmalloc(sizeof(*c), GFP_KERNEL);
  1188. if (!c) {
  1189. r = -ENOMEM;
  1190. goto bad_client;
  1191. }
  1192. c->cache_hash = vmalloc(sizeof(struct hlist_head) << DM_BUFIO_HASH_BITS);
  1193. if (!c->cache_hash) {
  1194. r = -ENOMEM;
  1195. goto bad_hash;
  1196. }
  1197. c->bdev = bdev;
  1198. c->block_size = block_size;
  1199. c->sectors_per_block_bits = ffs(block_size) - 1 - SECTOR_SHIFT;
  1200. c->pages_per_block_bits = (ffs(block_size) - 1 >= PAGE_SHIFT) ?
  1201. ffs(block_size) - 1 - PAGE_SHIFT : 0;
  1202. c->blocks_per_page_bits = (ffs(block_size) - 1 < PAGE_SHIFT ?
  1203. PAGE_SHIFT - (ffs(block_size) - 1) : 0);
  1204. c->aux_size = aux_size;
  1205. c->alloc_callback = alloc_callback;
  1206. c->write_callback = write_callback;
  1207. for (i = 0; i < LIST_SIZE; i++) {
  1208. INIT_LIST_HEAD(&c->lru[i]);
  1209. c->n_buffers[i] = 0;
  1210. }
  1211. for (i = 0; i < 1 << DM_BUFIO_HASH_BITS; i++)
  1212. INIT_HLIST_HEAD(&c->cache_hash[i]);
  1213. mutex_init(&c->lock);
  1214. INIT_LIST_HEAD(&c->reserved_buffers);
  1215. c->need_reserved_buffers = reserved_buffers;
  1216. init_waitqueue_head(&c->free_buffer_wait);
  1217. c->async_write_error = 0;
  1218. c->dm_io = dm_io_client_create();
  1219. if (IS_ERR(c->dm_io)) {
  1220. r = PTR_ERR(c->dm_io);
  1221. goto bad_dm_io;
  1222. }
  1223. mutex_lock(&dm_bufio_clients_lock);
  1224. if (c->blocks_per_page_bits) {
  1225. if (!DM_BUFIO_CACHE_NAME(c)) {
  1226. DM_BUFIO_CACHE_NAME(c) = kasprintf(GFP_KERNEL, "dm_bufio_cache-%u", c->block_size);
  1227. if (!DM_BUFIO_CACHE_NAME(c)) {
  1228. r = -ENOMEM;
  1229. mutex_unlock(&dm_bufio_clients_lock);
  1230. goto bad_cache;
  1231. }
  1232. }
  1233. if (!DM_BUFIO_CACHE(c)) {
  1234. DM_BUFIO_CACHE(c) = kmem_cache_create(DM_BUFIO_CACHE_NAME(c),
  1235. c->block_size,
  1236. c->block_size, 0, NULL);
  1237. if (!DM_BUFIO_CACHE(c)) {
  1238. r = -ENOMEM;
  1239. mutex_unlock(&dm_bufio_clients_lock);
  1240. goto bad_cache;
  1241. }
  1242. }
  1243. }
  1244. mutex_unlock(&dm_bufio_clients_lock);
  1245. while (c->need_reserved_buffers) {
  1246. struct dm_buffer *b = alloc_buffer(c, GFP_KERNEL);
  1247. if (!b) {
  1248. r = -ENOMEM;
  1249. goto bad_buffer;
  1250. }
  1251. __free_buffer_wake(b);
  1252. }
  1253. mutex_lock(&dm_bufio_clients_lock);
  1254. dm_bufio_client_count++;
  1255. list_add(&c->client_list, &dm_bufio_all_clients);
  1256. __cache_size_refresh();
  1257. mutex_unlock(&dm_bufio_clients_lock);
  1258. c->shrinker.shrink = shrink;
  1259. c->shrinker.seeks = 1;
  1260. c->shrinker.batch = 0;
  1261. register_shrinker(&c->shrinker);
  1262. return c;
  1263. bad_buffer:
  1264. bad_cache:
  1265. while (!list_empty(&c->reserved_buffers)) {
  1266. struct dm_buffer *b = list_entry(c->reserved_buffers.next,
  1267. struct dm_buffer, lru_list);
  1268. list_del(&b->lru_list);
  1269. free_buffer(b);
  1270. }
  1271. dm_io_client_destroy(c->dm_io);
  1272. bad_dm_io:
  1273. vfree(c->cache_hash);
  1274. bad_hash:
  1275. kfree(c);
  1276. bad_client:
  1277. return ERR_PTR(r);
  1278. }
  1279. EXPORT_SYMBOL_GPL(dm_bufio_client_create);
  1280. /*
  1281. * Free the buffering interface.
  1282. * It is required that there are no references on any buffers.
  1283. */
  1284. void dm_bufio_client_destroy(struct dm_bufio_client *c)
  1285. {
  1286. unsigned i;
  1287. drop_buffers(c);
  1288. unregister_shrinker(&c->shrinker);
  1289. mutex_lock(&dm_bufio_clients_lock);
  1290. list_del(&c->client_list);
  1291. dm_bufio_client_count--;
  1292. __cache_size_refresh();
  1293. mutex_unlock(&dm_bufio_clients_lock);
  1294. for (i = 0; i < 1 << DM_BUFIO_HASH_BITS; i++)
  1295. BUG_ON(!hlist_empty(&c->cache_hash[i]));
  1296. BUG_ON(c->need_reserved_buffers);
  1297. while (!list_empty(&c->reserved_buffers)) {
  1298. struct dm_buffer *b = list_entry(c->reserved_buffers.next,
  1299. struct dm_buffer, lru_list);
  1300. list_del(&b->lru_list);
  1301. free_buffer(b);
  1302. }
  1303. for (i = 0; i < LIST_SIZE; i++)
  1304. if (c->n_buffers[i])
  1305. DMERR("leaked buffer count %d: %ld", i, c->n_buffers[i]);
  1306. for (i = 0; i < LIST_SIZE; i++)
  1307. BUG_ON(c->n_buffers[i]);
  1308. dm_io_client_destroy(c->dm_io);
  1309. vfree(c->cache_hash);
  1310. kfree(c);
  1311. }
  1312. EXPORT_SYMBOL_GPL(dm_bufio_client_destroy);
  1313. static void cleanup_old_buffers(void)
  1314. {
  1315. unsigned long max_age = ACCESS_ONCE(dm_bufio_max_age);
  1316. struct dm_bufio_client *c;
  1317. if (max_age > ULONG_MAX / HZ)
  1318. max_age = ULONG_MAX / HZ;
  1319. mutex_lock(&dm_bufio_clients_lock);
  1320. list_for_each_entry(c, &dm_bufio_all_clients, client_list) {
  1321. if (!dm_bufio_trylock(c))
  1322. continue;
  1323. while (!list_empty(&c->lru[LIST_CLEAN])) {
  1324. struct dm_buffer *b;
  1325. b = list_entry(c->lru[LIST_CLEAN].prev,
  1326. struct dm_buffer, lru_list);
  1327. if (__cleanup_old_buffer(b, 0, max_age * HZ))
  1328. break;
  1329. dm_bufio_cond_resched();
  1330. }
  1331. dm_bufio_unlock(c);
  1332. dm_bufio_cond_resched();
  1333. }
  1334. mutex_unlock(&dm_bufio_clients_lock);
  1335. }
  1336. static struct workqueue_struct *dm_bufio_wq;
  1337. static struct delayed_work dm_bufio_work;
  1338. static void work_fn(struct work_struct *w)
  1339. {
  1340. cleanup_old_buffers();
  1341. queue_delayed_work(dm_bufio_wq, &dm_bufio_work,
  1342. DM_BUFIO_WORK_TIMER_SECS * HZ);
  1343. }
  1344. /*----------------------------------------------------------------
  1345. * Module setup
  1346. *--------------------------------------------------------------*/
  1347. /*
  1348. * This is called only once for the whole dm_bufio module.
  1349. * It initializes memory limit.
  1350. */
  1351. static int __init dm_bufio_init(void)
  1352. {
  1353. __u64 mem;
  1354. memset(&dm_bufio_caches, 0, sizeof dm_bufio_caches);
  1355. memset(&dm_bufio_cache_names, 0, sizeof dm_bufio_cache_names);
  1356. mem = (__u64)((totalram_pages - totalhigh_pages) *
  1357. DM_BUFIO_MEMORY_PERCENT / 100) << PAGE_SHIFT;
  1358. if (mem > ULONG_MAX)
  1359. mem = ULONG_MAX;
  1360. #ifdef CONFIG_MMU
  1361. /*
  1362. * Get the size of vmalloc space the same way as VMALLOC_TOTAL
  1363. * in fs/proc/internal.h
  1364. */
  1365. if (mem > (VMALLOC_END - VMALLOC_START) * DM_BUFIO_VMALLOC_PERCENT / 100)
  1366. mem = (VMALLOC_END - VMALLOC_START) * DM_BUFIO_VMALLOC_PERCENT / 100;
  1367. #endif
  1368. dm_bufio_default_cache_size = mem;
  1369. mutex_lock(&dm_bufio_clients_lock);
  1370. __cache_size_refresh();
  1371. mutex_unlock(&dm_bufio_clients_lock);
  1372. dm_bufio_wq = create_singlethread_workqueue("dm_bufio_cache");
  1373. if (!dm_bufio_wq)
  1374. return -ENOMEM;
  1375. INIT_DELAYED_WORK(&dm_bufio_work, work_fn);
  1376. queue_delayed_work(dm_bufio_wq, &dm_bufio_work,
  1377. DM_BUFIO_WORK_TIMER_SECS * HZ);
  1378. return 0;
  1379. }
  1380. /*
  1381. * This is called once when unloading the dm_bufio module.
  1382. */
  1383. static void __exit dm_bufio_exit(void)
  1384. {
  1385. int bug = 0;
  1386. int i;
  1387. cancel_delayed_work_sync(&dm_bufio_work);
  1388. destroy_workqueue(dm_bufio_wq);
  1389. for (i = 0; i < ARRAY_SIZE(dm_bufio_caches); i++) {
  1390. struct kmem_cache *kc = dm_bufio_caches[i];
  1391. if (kc)
  1392. kmem_cache_destroy(kc);
  1393. }
  1394. for (i = 0; i < ARRAY_SIZE(dm_bufio_cache_names); i++)
  1395. kfree(dm_bufio_cache_names[i]);
  1396. if (dm_bufio_client_count) {
  1397. DMCRIT("%s: dm_bufio_client_count leaked: %d",
  1398. __func__, dm_bufio_client_count);
  1399. bug = 1;
  1400. }
  1401. if (dm_bufio_current_allocated) {
  1402. DMCRIT("%s: dm_bufio_current_allocated leaked: %lu",
  1403. __func__, dm_bufio_current_allocated);
  1404. bug = 1;
  1405. }
  1406. if (dm_bufio_allocated_get_free_pages) {
  1407. DMCRIT("%s: dm_bufio_allocated_get_free_pages leaked: %lu",
  1408. __func__, dm_bufio_allocated_get_free_pages);
  1409. bug = 1;
  1410. }
  1411. if (dm_bufio_allocated_vmalloc) {
  1412. DMCRIT("%s: dm_bufio_vmalloc leaked: %lu",
  1413. __func__, dm_bufio_allocated_vmalloc);
  1414. bug = 1;
  1415. }
  1416. if (bug)
  1417. BUG();
  1418. }
  1419. module_init(dm_bufio_init)
  1420. module_exit(dm_bufio_exit)
  1421. module_param_named(max_cache_size_bytes, dm_bufio_cache_size, ulong, S_IRUGO | S_IWUSR);
  1422. MODULE_PARM_DESC(max_cache_size_bytes, "Size of metadata cache");
  1423. module_param_named(max_age_seconds, dm_bufio_max_age, uint, S_IRUGO | S_IWUSR);
  1424. MODULE_PARM_DESC(max_age_seconds, "Max age of a buffer in seconds");
  1425. module_param_named(peak_allocated_bytes, dm_bufio_peak_allocated, ulong, S_IRUGO | S_IWUSR);
  1426. MODULE_PARM_DESC(peak_allocated_bytes, "Tracks the maximum allocated memory");
  1427. module_param_named(allocated_kmem_cache_bytes, dm_bufio_allocated_kmem_cache, ulong, S_IRUGO);
  1428. MODULE_PARM_DESC(allocated_kmem_cache_bytes, "Memory allocated with kmem_cache_alloc");
  1429. module_param_named(allocated_get_free_pages_bytes, dm_bufio_allocated_get_free_pages, ulong, S_IRUGO);
  1430. MODULE_PARM_DESC(allocated_get_free_pages_bytes, "Memory allocated with get_free_pages");
  1431. module_param_named(allocated_vmalloc_bytes, dm_bufio_allocated_vmalloc, ulong, S_IRUGO);
  1432. MODULE_PARM_DESC(allocated_vmalloc_bytes, "Memory allocated with vmalloc");
  1433. module_param_named(current_allocated_bytes, dm_bufio_current_allocated, ulong, S_IRUGO);
  1434. MODULE_PARM_DESC(current_allocated_bytes, "Memory currently used by the cache");
  1435. MODULE_AUTHOR("Mikulas Patocka <dm-devel@redhat.com>");
  1436. MODULE_DESCRIPTION(DM_NAME " buffered I/O library");
  1437. MODULE_LICENSE("GPL");