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