dm-bufio.c 42 KB

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