2 * Copyright (C) 2009-2011 Red Hat, Inc.
4 * Author: Mikulas Patocka <mpatocka@redhat.com>
6 * This file is released under the GPL.
11 #include <linux/device-mapper.h>
12 #include <linux/dm-io.h>
13 #include <linux/slab.h>
14 #include <linux/jiffies.h>
15 #include <linux/vmalloc.h>
16 #include <linux/shrinker.h>
17 #include <linux/module.h>
18 #include <linux/rbtree.h>
20 #define DM_MSG_PREFIX "bufio"
23 * Memory management policy:
24 * Limit the number of buffers to DM_BUFIO_MEMORY_PERCENT of main memory
25 * or DM_BUFIO_VMALLOC_PERCENT of vmalloc memory (whichever is lower).
26 * Always allocate at least DM_BUFIO_MIN_BUFFERS buffers.
27 * Start background writeback when there are DM_BUFIO_WRITEBACK_PERCENT
30 #define DM_BUFIO_MIN_BUFFERS 8
32 #define DM_BUFIO_MEMORY_PERCENT 2
33 #define DM_BUFIO_VMALLOC_PERCENT 25
34 #define DM_BUFIO_WRITEBACK_PERCENT 75
37 * Check buffer ages in this interval (seconds)
39 #define DM_BUFIO_WORK_TIMER_SECS 30
42 * Free buffers when they are older than this (seconds)
44 #define DM_BUFIO_DEFAULT_AGE_SECS 300
47 * The nr of bytes of cached data to keep around.
49 #define DM_BUFIO_DEFAULT_RETAIN_BYTES (256 * 1024)
52 * The number of bvec entries that are embedded directly in the buffer.
53 * If the chunk size is larger, dm-io is used to do the io.
55 #define DM_BUFIO_INLINE_VECS 16
58 * Don't try to use kmem_cache_alloc for blocks larger than this.
59 * For explanation, see alloc_buffer_data below.
61 #define DM_BUFIO_BLOCK_SIZE_SLAB_LIMIT (PAGE_SIZE >> 1)
62 #define DM_BUFIO_BLOCK_SIZE_GFP_LIMIT (PAGE_SIZE << (MAX_ORDER - 1))
65 * dm_buffer->list_mode
73 * All buffers are linked to cache_hash with their hash_list field.
75 * Clean buffers that are not being written (B_WRITING not set)
76 * are linked to lru[LIST_CLEAN] with their lru_list field.
78 * Dirty and clean buffers that are being written are linked to
79 * lru[LIST_DIRTY] with their lru_list field. When the write
80 * finishes, the buffer cannot be relinked immediately (because we
81 * are in an interrupt context and relinking requires process
82 * context), so some clean-not-writing buffers can be held on
83 * dirty_lru too. They are later added to lru in the process
86 struct dm_bufio_client
{
89 struct list_head lru
[LIST_SIZE
];
90 unsigned long n_buffers
[LIST_SIZE
];
92 struct block_device
*bdev
;
94 unsigned char sectors_per_block_bits
;
95 unsigned char pages_per_block_bits
;
96 unsigned char blocks_per_page_bits
;
98 void (*alloc_callback
)(struct dm_buffer
*);
99 void (*write_callback
)(struct dm_buffer
*);
101 struct dm_io_client
*dm_io
;
103 struct list_head reserved_buffers
;
104 unsigned need_reserved_buffers
;
106 unsigned minimum_buffers
;
108 struct rb_root buffer_tree
;
109 wait_queue_head_t free_buffer_wait
;
111 int async_write_error
;
113 struct list_head client_list
;
114 struct shrinker shrinker
;
125 * Describes how the block was allocated:
126 * kmem_cache_alloc(), __get_free_pages() or vmalloc().
127 * See the comment at alloc_buffer_data.
131 DATA_MODE_GET_FREE_PAGES
= 1,
132 DATA_MODE_VMALLOC
= 2,
138 struct list_head lru_list
;
141 enum data_mode data_mode
;
142 unsigned char list_mode
; /* LIST_* */
147 unsigned long last_accessed
;
148 struct dm_bufio_client
*c
;
149 struct list_head write_list
;
151 struct bio_vec bio_vec
[DM_BUFIO_INLINE_VECS
];
154 /*----------------------------------------------------------------*/
156 static struct kmem_cache
*dm_bufio_caches
[PAGE_SHIFT
- SECTOR_SHIFT
];
157 static char *dm_bufio_cache_names
[PAGE_SHIFT
- SECTOR_SHIFT
];
159 static inline int dm_bufio_cache_index(struct dm_bufio_client
*c
)
161 unsigned ret
= c
->blocks_per_page_bits
- 1;
163 BUG_ON(ret
>= ARRAY_SIZE(dm_bufio_caches
));
168 #define DM_BUFIO_CACHE(c) (dm_bufio_caches[dm_bufio_cache_index(c)])
169 #define DM_BUFIO_CACHE_NAME(c) (dm_bufio_cache_names[dm_bufio_cache_index(c)])
171 #define dm_bufio_in_request() (!!current->bio_list)
173 static void dm_bufio_lock(struct dm_bufio_client
*c
)
175 mutex_lock_nested(&c
->lock
, dm_bufio_in_request());
178 static int dm_bufio_trylock(struct dm_bufio_client
*c
)
180 return mutex_trylock(&c
->lock
);
183 static void dm_bufio_unlock(struct dm_bufio_client
*c
)
185 mutex_unlock(&c
->lock
);
189 * FIXME Move to sched.h?
191 #ifdef CONFIG_PREEMPT_VOLUNTARY
192 # define dm_bufio_cond_resched() \
194 if (unlikely(need_resched())) \
198 # define dm_bufio_cond_resched() do { } while (0)
201 /*----------------------------------------------------------------*/
204 * Default cache size: available memory divided by the ratio.
206 static unsigned long dm_bufio_default_cache_size
;
209 * Total cache size set by the user.
211 static unsigned long dm_bufio_cache_size
;
214 * A copy of dm_bufio_cache_size because dm_bufio_cache_size can change
215 * at any time. If it disagrees, the user has changed cache size.
217 static unsigned long dm_bufio_cache_size_latch
;
219 static DEFINE_SPINLOCK(param_spinlock
);
222 * Buffers are freed after this timeout
224 static unsigned dm_bufio_max_age
= DM_BUFIO_DEFAULT_AGE_SECS
;
225 static unsigned dm_bufio_retain_bytes
= DM_BUFIO_DEFAULT_RETAIN_BYTES
;
227 static unsigned long dm_bufio_peak_allocated
;
228 static unsigned long dm_bufio_allocated_kmem_cache
;
229 static unsigned long dm_bufio_allocated_get_free_pages
;
230 static unsigned long dm_bufio_allocated_vmalloc
;
231 static unsigned long dm_bufio_current_allocated
;
233 /*----------------------------------------------------------------*/
236 * Per-client cache: dm_bufio_cache_size / dm_bufio_client_count
238 static unsigned long dm_bufio_cache_size_per_client
;
241 * The current number of clients.
243 static int dm_bufio_client_count
;
246 * The list of all clients.
248 static LIST_HEAD(dm_bufio_all_clients
);
251 * This mutex protects dm_bufio_cache_size_latch,
252 * dm_bufio_cache_size_per_client and dm_bufio_client_count
254 static DEFINE_MUTEX(dm_bufio_clients_lock
);
256 /*----------------------------------------------------------------
257 * A red/black tree acts as an index for all the buffers.
258 *--------------------------------------------------------------*/
259 static struct dm_buffer
*__find(struct dm_bufio_client
*c
, sector_t block
)
261 struct rb_node
*n
= c
->buffer_tree
.rb_node
;
265 b
= container_of(n
, struct dm_buffer
, node
);
267 if (b
->block
== block
)
270 n
= (b
->block
< block
) ? n
->rb_left
: n
->rb_right
;
276 static void __insert(struct dm_bufio_client
*c
, struct dm_buffer
*b
)
278 struct rb_node
**new = &c
->buffer_tree
.rb_node
, *parent
= NULL
;
279 struct dm_buffer
*found
;
282 found
= container_of(*new, struct dm_buffer
, node
);
284 if (found
->block
== b
->block
) {
290 new = (found
->block
< b
->block
) ?
291 &((*new)->rb_left
) : &((*new)->rb_right
);
294 rb_link_node(&b
->node
, parent
, new);
295 rb_insert_color(&b
->node
, &c
->buffer_tree
);
298 static void __remove(struct dm_bufio_client
*c
, struct dm_buffer
*b
)
300 rb_erase(&b
->node
, &c
->buffer_tree
);
303 /*----------------------------------------------------------------*/
305 static void adjust_total_allocated(enum data_mode data_mode
, long diff
)
307 static unsigned long * const class_ptr
[DATA_MODE_LIMIT
] = {
308 &dm_bufio_allocated_kmem_cache
,
309 &dm_bufio_allocated_get_free_pages
,
310 &dm_bufio_allocated_vmalloc
,
313 spin_lock(¶m_spinlock
);
315 *class_ptr
[data_mode
] += diff
;
317 dm_bufio_current_allocated
+= diff
;
319 if (dm_bufio_current_allocated
> dm_bufio_peak_allocated
)
320 dm_bufio_peak_allocated
= dm_bufio_current_allocated
;
322 spin_unlock(¶m_spinlock
);
326 * Change the number of clients and recalculate per-client limit.
328 static void __cache_size_refresh(void)
330 BUG_ON(!mutex_is_locked(&dm_bufio_clients_lock
));
331 BUG_ON(dm_bufio_client_count
< 0);
333 dm_bufio_cache_size_latch
= ACCESS_ONCE(dm_bufio_cache_size
);
336 * Use default if set to 0 and report the actual cache size used.
338 if (!dm_bufio_cache_size_latch
) {
339 (void)cmpxchg(&dm_bufio_cache_size
, 0,
340 dm_bufio_default_cache_size
);
341 dm_bufio_cache_size_latch
= dm_bufio_default_cache_size
;
344 dm_bufio_cache_size_per_client
= dm_bufio_cache_size_latch
/
345 (dm_bufio_client_count
? : 1);
349 * Allocating buffer data.
351 * Small buffers are allocated with kmem_cache, to use space optimally.
353 * For large buffers, we choose between get_free_pages and vmalloc.
354 * Each has advantages and disadvantages.
356 * __get_free_pages can randomly fail if the memory is fragmented.
357 * __vmalloc won't randomly fail, but vmalloc space is limited (it may be
358 * as low as 128M) so using it for caching is not appropriate.
360 * If the allocation may fail we use __get_free_pages. Memory fragmentation
361 * won't have a fatal effect here, but it just causes flushes of some other
362 * buffers and more I/O will be performed. Don't use __get_free_pages if it
363 * always fails (i.e. order >= MAX_ORDER).
365 * If the allocation shouldn't fail we use __vmalloc. This is only for the
366 * initial reserve allocation, so there's no risk of wasting all vmalloc
369 static void *alloc_buffer_data(struct dm_bufio_client
*c
, gfp_t gfp_mask
,
370 enum data_mode
*data_mode
)
375 if (c
->block_size
<= DM_BUFIO_BLOCK_SIZE_SLAB_LIMIT
) {
376 *data_mode
= DATA_MODE_SLAB
;
377 return kmem_cache_alloc(DM_BUFIO_CACHE(c
), gfp_mask
);
380 if (c
->block_size
<= DM_BUFIO_BLOCK_SIZE_GFP_LIMIT
&&
381 gfp_mask
& __GFP_NORETRY
) {
382 *data_mode
= DATA_MODE_GET_FREE_PAGES
;
383 return (void *)__get_free_pages(gfp_mask
,
384 c
->pages_per_block_bits
);
387 *data_mode
= DATA_MODE_VMALLOC
;
390 * __vmalloc allocates the data pages and auxiliary structures with
391 * gfp_flags that were specified, but pagetables are always allocated
392 * with GFP_KERNEL, no matter what was specified as gfp_mask.
394 * Consequently, we must set per-process flag PF_MEMALLOC_NOIO so that
395 * all allocations done by this process (including pagetables) are done
396 * as if GFP_NOIO was specified.
399 if (gfp_mask
& __GFP_NORETRY
)
400 noio_flag
= memalloc_noio_save();
402 ptr
= __vmalloc(c
->block_size
, gfp_mask
| __GFP_HIGHMEM
, PAGE_KERNEL
);
404 if (gfp_mask
& __GFP_NORETRY
)
405 memalloc_noio_restore(noio_flag
);
411 * Free buffer's data.
413 static void free_buffer_data(struct dm_bufio_client
*c
,
414 void *data
, enum data_mode data_mode
)
418 kmem_cache_free(DM_BUFIO_CACHE(c
), data
);
421 case DATA_MODE_GET_FREE_PAGES
:
422 free_pages((unsigned long)data
, c
->pages_per_block_bits
);
425 case DATA_MODE_VMALLOC
:
430 DMCRIT("dm_bufio_free_buffer_data: bad data mode: %d",
437 * Allocate buffer and its data.
439 static struct dm_buffer
*alloc_buffer(struct dm_bufio_client
*c
, gfp_t gfp_mask
)
441 struct dm_buffer
*b
= kmalloc(sizeof(struct dm_buffer
) + c
->aux_size
,
449 b
->data
= alloc_buffer_data(c
, gfp_mask
, &b
->data_mode
);
455 adjust_total_allocated(b
->data_mode
, (long)c
->block_size
);
461 * Free buffer and its data.
463 static void free_buffer(struct dm_buffer
*b
)
465 struct dm_bufio_client
*c
= b
->c
;
467 adjust_total_allocated(b
->data_mode
, -(long)c
->block_size
);
469 free_buffer_data(c
, b
->data
, b
->data_mode
);
474 * Link buffer to the hash list and clean or dirty queue.
476 static void __link_buffer(struct dm_buffer
*b
, sector_t block
, int dirty
)
478 struct dm_bufio_client
*c
= b
->c
;
480 c
->n_buffers
[dirty
]++;
482 b
->list_mode
= dirty
;
483 list_add(&b
->lru_list
, &c
->lru
[dirty
]);
485 b
->last_accessed
= jiffies
;
489 * Unlink buffer from the hash list and dirty or clean queue.
491 static void __unlink_buffer(struct dm_buffer
*b
)
493 struct dm_bufio_client
*c
= b
->c
;
495 BUG_ON(!c
->n_buffers
[b
->list_mode
]);
497 c
->n_buffers
[b
->list_mode
]--;
499 list_del(&b
->lru_list
);
503 * Place the buffer to the head of dirty or clean LRU queue.
505 static void __relink_lru(struct dm_buffer
*b
, int dirty
)
507 struct dm_bufio_client
*c
= b
->c
;
509 BUG_ON(!c
->n_buffers
[b
->list_mode
]);
511 c
->n_buffers
[b
->list_mode
]--;
512 c
->n_buffers
[dirty
]++;
513 b
->list_mode
= dirty
;
514 list_move(&b
->lru_list
, &c
->lru
[dirty
]);
515 b
->last_accessed
= jiffies
;
518 /*----------------------------------------------------------------
519 * Submit I/O on the buffer.
521 * Bio interface is faster but it has some problems:
522 * the vector list is limited (increasing this limit increases
523 * memory-consumption per buffer, so it is not viable);
525 * the memory must be direct-mapped, not vmalloced;
527 * the I/O driver can reject requests spuriously if it thinks that
528 * the requests are too big for the device or if they cross a
529 * controller-defined memory boundary.
531 * If the buffer is small enough (up to DM_BUFIO_INLINE_VECS pages) and
532 * it is not vmalloced, try using the bio interface.
534 * If the buffer is big, if it is vmalloced or if the underlying device
535 * rejects the bio because it is too large, use dm-io layer to do the I/O.
536 * The dm-io layer splits the I/O into multiple requests, avoiding the above
538 *--------------------------------------------------------------*/
541 * dm-io completion routine. It just calls b->bio.bi_end_io, pretending
542 * that the request was handled directly with bio interface.
544 static void dmio_complete(unsigned long error
, void *context
)
546 struct dm_buffer
*b
= context
;
548 b
->bio
.bi_error
= error
? -EIO
: 0;
549 b
->bio
.bi_end_io(&b
->bio
);
552 static void use_dmio(struct dm_buffer
*b
, int rw
, sector_t block
,
553 bio_end_io_t
*end_io
)
556 struct dm_io_request io_req
= {
558 .notify
.fn
= dmio_complete
,
560 .client
= b
->c
->dm_io
,
562 struct dm_io_region region
= {
564 .sector
= block
<< b
->c
->sectors_per_block_bits
,
565 .count
= b
->c
->block_size
>> SECTOR_SHIFT
,
568 if (b
->data_mode
!= DATA_MODE_VMALLOC
) {
569 io_req
.mem
.type
= DM_IO_KMEM
;
570 io_req
.mem
.ptr
.addr
= b
->data
;
572 io_req
.mem
.type
= DM_IO_VMA
;
573 io_req
.mem
.ptr
.vma
= b
->data
;
576 b
->bio
.bi_end_io
= end_io
;
578 r
= dm_io(&io_req
, 1, ®ion
, NULL
);
585 static void inline_endio(struct bio
*bio
)
587 bio_end_io_t
*end_fn
= bio
->bi_private
;
588 int error
= bio
->bi_error
;
591 * Reset the bio to free any attached resources
592 * (e.g. bio integrity profiles).
596 bio
->bi_error
= error
;
600 static void use_inline_bio(struct dm_buffer
*b
, int rw
, sector_t block
,
601 bio_end_io_t
*end_io
)
607 b
->bio
.bi_io_vec
= b
->bio_vec
;
608 b
->bio
.bi_max_vecs
= DM_BUFIO_INLINE_VECS
;
609 b
->bio
.bi_iter
.bi_sector
= block
<< b
->c
->sectors_per_block_bits
;
610 b
->bio
.bi_bdev
= b
->c
->bdev
;
611 b
->bio
.bi_end_io
= inline_endio
;
613 * Use of .bi_private isn't a problem here because
614 * the dm_buffer's inline bio is local to bufio.
616 b
->bio
.bi_private
= end_io
;
619 * We assume that if len >= PAGE_SIZE ptr is page-aligned.
620 * If len < PAGE_SIZE the buffer doesn't cross page boundary.
623 len
= b
->c
->block_size
;
625 if (len
>= PAGE_SIZE
)
626 BUG_ON((unsigned long)ptr
& (PAGE_SIZE
- 1));
628 BUG_ON((unsigned long)ptr
& (len
- 1));
631 if (!bio_add_page(&b
->bio
, virt_to_page(ptr
),
632 len
< PAGE_SIZE
? len
: PAGE_SIZE
,
633 virt_to_phys(ptr
) & (PAGE_SIZE
- 1))) {
634 BUG_ON(b
->c
->block_size
<= PAGE_SIZE
);
635 use_dmio(b
, rw
, block
, end_io
);
643 submit_bio(rw
, &b
->bio
);
646 static void submit_io(struct dm_buffer
*b
, int rw
, sector_t block
,
647 bio_end_io_t
*end_io
)
649 if (rw
== WRITE
&& b
->c
->write_callback
)
650 b
->c
->write_callback(b
);
652 if (b
->c
->block_size
<= DM_BUFIO_INLINE_VECS
* PAGE_SIZE
&&
653 b
->data_mode
!= DATA_MODE_VMALLOC
)
654 use_inline_bio(b
, rw
, block
, end_io
);
656 use_dmio(b
, rw
, block
, end_io
);
659 /*----------------------------------------------------------------
660 * Writing dirty buffers
661 *--------------------------------------------------------------*/
664 * The endio routine for write.
666 * Set the error, clear B_WRITING bit and wake anyone who was waiting on
669 static void write_endio(struct bio
*bio
)
671 struct dm_buffer
*b
= container_of(bio
, struct dm_buffer
, bio
);
673 b
->write_error
= bio
->bi_error
;
674 if (unlikely(bio
->bi_error
)) {
675 struct dm_bufio_client
*c
= b
->c
;
676 int error
= bio
->bi_error
;
677 (void)cmpxchg(&c
->async_write_error
, 0, error
);
680 BUG_ON(!test_bit(B_WRITING
, &b
->state
));
682 smp_mb__before_atomic();
683 clear_bit(B_WRITING
, &b
->state
);
684 smp_mb__after_atomic();
686 wake_up_bit(&b
->state
, B_WRITING
);
690 * Initiate a write on a dirty buffer, but don't wait for it.
692 * - If the buffer is not dirty, exit.
693 * - If there some previous write going on, wait for it to finish (we can't
694 * have two writes on the same buffer simultaneously).
695 * - Submit our write and don't wait on it. We set B_WRITING indicating
696 * that there is a write in progress.
698 static void __write_dirty_buffer(struct dm_buffer
*b
,
699 struct list_head
*write_list
)
701 if (!test_bit(B_DIRTY
, &b
->state
))
704 clear_bit(B_DIRTY
, &b
->state
);
705 wait_on_bit_lock_io(&b
->state
, B_WRITING
, TASK_UNINTERRUPTIBLE
);
708 submit_io(b
, WRITE
, b
->block
, write_endio
);
710 list_add_tail(&b
->write_list
, write_list
);
713 static void __flush_write_list(struct list_head
*write_list
)
715 struct blk_plug plug
;
716 blk_start_plug(&plug
);
717 while (!list_empty(write_list
)) {
718 struct dm_buffer
*b
=
719 list_entry(write_list
->next
, struct dm_buffer
, write_list
);
720 list_del(&b
->write_list
);
721 submit_io(b
, WRITE
, b
->block
, write_endio
);
722 dm_bufio_cond_resched();
724 blk_finish_plug(&plug
);
728 * Wait until any activity on the buffer finishes. Possibly write the
729 * buffer if it is dirty. When this function finishes, there is no I/O
730 * running on the buffer and the buffer is not dirty.
732 static void __make_buffer_clean(struct dm_buffer
*b
)
734 BUG_ON(b
->hold_count
);
736 if (!b
->state
) /* fast case */
739 wait_on_bit_io(&b
->state
, B_READING
, TASK_UNINTERRUPTIBLE
);
740 __write_dirty_buffer(b
, NULL
);
741 wait_on_bit_io(&b
->state
, B_WRITING
, TASK_UNINTERRUPTIBLE
);
745 * Find some buffer that is not held by anybody, clean it, unlink it and
748 static struct dm_buffer
*__get_unclaimed_buffer(struct dm_bufio_client
*c
)
752 list_for_each_entry_reverse(b
, &c
->lru
[LIST_CLEAN
], lru_list
) {
753 BUG_ON(test_bit(B_WRITING
, &b
->state
));
754 BUG_ON(test_bit(B_DIRTY
, &b
->state
));
756 if (!b
->hold_count
) {
757 __make_buffer_clean(b
);
761 dm_bufio_cond_resched();
764 list_for_each_entry_reverse(b
, &c
->lru
[LIST_DIRTY
], lru_list
) {
765 BUG_ON(test_bit(B_READING
, &b
->state
));
767 if (!b
->hold_count
) {
768 __make_buffer_clean(b
);
772 dm_bufio_cond_resched();
779 * Wait until some other threads free some buffer or release hold count on
782 * This function is entered with c->lock held, drops it and regains it
785 static void __wait_for_free_buffer(struct dm_bufio_client
*c
)
787 DECLARE_WAITQUEUE(wait
, current
);
789 add_wait_queue(&c
->free_buffer_wait
, &wait
);
790 set_task_state(current
, TASK_UNINTERRUPTIBLE
);
795 remove_wait_queue(&c
->free_buffer_wait
, &wait
);
808 * Allocate a new buffer. If the allocation is not possible, wait until
809 * some other thread frees a buffer.
811 * May drop the lock and regain it.
813 static struct dm_buffer
*__alloc_buffer_wait_no_callback(struct dm_bufio_client
*c
, enum new_flag nf
)
818 * dm-bufio is resistant to allocation failures (it just keeps
819 * one buffer reserved in cases all the allocations fail).
820 * So set flags to not try too hard:
821 * GFP_NOIO: don't recurse into the I/O layer
822 * __GFP_NORETRY: don't retry and rather return failure
823 * __GFP_NOMEMALLOC: don't use emergency reserves
824 * __GFP_NOWARN: don't print a warning in case of failure
826 * For debugging, if we set the cache size to 1, no new buffers will
830 if (dm_bufio_cache_size_latch
!= 1) {
831 b
= alloc_buffer(c
, GFP_NOIO
| __GFP_NORETRY
| __GFP_NOMEMALLOC
| __GFP_NOWARN
);
836 if (nf
== NF_PREFETCH
)
839 if (!list_empty(&c
->reserved_buffers
)) {
840 b
= list_entry(c
->reserved_buffers
.next
,
841 struct dm_buffer
, lru_list
);
842 list_del(&b
->lru_list
);
843 c
->need_reserved_buffers
++;
848 b
= __get_unclaimed_buffer(c
);
852 __wait_for_free_buffer(c
);
856 static struct dm_buffer
*__alloc_buffer_wait(struct dm_bufio_client
*c
, enum new_flag nf
)
858 struct dm_buffer
*b
= __alloc_buffer_wait_no_callback(c
, nf
);
863 if (c
->alloc_callback
)
864 c
->alloc_callback(b
);
870 * Free a buffer and wake other threads waiting for free buffers.
872 static void __free_buffer_wake(struct dm_buffer
*b
)
874 struct dm_bufio_client
*c
= b
->c
;
876 if (!c
->need_reserved_buffers
)
879 list_add(&b
->lru_list
, &c
->reserved_buffers
);
880 c
->need_reserved_buffers
--;
883 wake_up(&c
->free_buffer_wait
);
886 static void __write_dirty_buffers_async(struct dm_bufio_client
*c
, int no_wait
,
887 struct list_head
*write_list
)
889 struct dm_buffer
*b
, *tmp
;
891 list_for_each_entry_safe_reverse(b
, tmp
, &c
->lru
[LIST_DIRTY
], lru_list
) {
892 BUG_ON(test_bit(B_READING
, &b
->state
));
894 if (!test_bit(B_DIRTY
, &b
->state
) &&
895 !test_bit(B_WRITING
, &b
->state
)) {
896 __relink_lru(b
, LIST_CLEAN
);
900 if (no_wait
&& test_bit(B_WRITING
, &b
->state
))
903 __write_dirty_buffer(b
, write_list
);
904 dm_bufio_cond_resched();
909 * Get writeback threshold and buffer limit for a given client.
911 static void __get_memory_limit(struct dm_bufio_client
*c
,
912 unsigned long *threshold_buffers
,
913 unsigned long *limit_buffers
)
915 unsigned long buffers
;
917 if (ACCESS_ONCE(dm_bufio_cache_size
) != dm_bufio_cache_size_latch
) {
918 mutex_lock(&dm_bufio_clients_lock
);
919 __cache_size_refresh();
920 mutex_unlock(&dm_bufio_clients_lock
);
923 buffers
= dm_bufio_cache_size_per_client
>>
924 (c
->sectors_per_block_bits
+ SECTOR_SHIFT
);
926 if (buffers
< c
->minimum_buffers
)
927 buffers
= c
->minimum_buffers
;
929 *limit_buffers
= buffers
;
930 *threshold_buffers
= buffers
* DM_BUFIO_WRITEBACK_PERCENT
/ 100;
934 * Check if we're over watermark.
935 * If we are over threshold_buffers, start freeing buffers.
936 * If we're over "limit_buffers", block until we get under the limit.
938 static void __check_watermark(struct dm_bufio_client
*c
,
939 struct list_head
*write_list
)
941 unsigned long threshold_buffers
, limit_buffers
;
943 __get_memory_limit(c
, &threshold_buffers
, &limit_buffers
);
945 while (c
->n_buffers
[LIST_CLEAN
] + c
->n_buffers
[LIST_DIRTY
] >
948 struct dm_buffer
*b
= __get_unclaimed_buffer(c
);
953 __free_buffer_wake(b
);
954 dm_bufio_cond_resched();
957 if (c
->n_buffers
[LIST_DIRTY
] > threshold_buffers
)
958 __write_dirty_buffers_async(c
, 1, write_list
);
961 /*----------------------------------------------------------------
963 *--------------------------------------------------------------*/
965 static struct dm_buffer
*__bufio_new(struct dm_bufio_client
*c
, sector_t block
,
966 enum new_flag nf
, int *need_submit
,
967 struct list_head
*write_list
)
969 struct dm_buffer
*b
, *new_b
= NULL
;
973 b
= __find(c
, block
);
980 new_b
= __alloc_buffer_wait(c
, nf
);
985 * We've had a period where the mutex was unlocked, so need to
986 * recheck the hash table.
988 b
= __find(c
, block
);
990 __free_buffer_wake(new_b
);
994 __check_watermark(c
, write_list
);
1000 __link_buffer(b
, block
, LIST_CLEAN
);
1002 if (nf
== NF_FRESH
) {
1007 b
->state
= 1 << B_READING
;
1013 if (nf
== NF_PREFETCH
)
1016 * Note: it is essential that we don't wait for the buffer to be
1017 * read if dm_bufio_get function is used. Both dm_bufio_get and
1018 * dm_bufio_prefetch can be used in the driver request routine.
1019 * If the user called both dm_bufio_prefetch and dm_bufio_get on
1020 * the same buffer, it would deadlock if we waited.
1022 if (nf
== NF_GET
&& unlikely(test_bit(B_READING
, &b
->state
)))
1026 __relink_lru(b
, test_bit(B_DIRTY
, &b
->state
) ||
1027 test_bit(B_WRITING
, &b
->state
));
1032 * The endio routine for reading: set the error, clear the bit and wake up
1033 * anyone waiting on the buffer.
1035 static void read_endio(struct bio
*bio
)
1037 struct dm_buffer
*b
= container_of(bio
, struct dm_buffer
, bio
);
1039 b
->read_error
= bio
->bi_error
;
1041 BUG_ON(!test_bit(B_READING
, &b
->state
));
1043 smp_mb__before_atomic();
1044 clear_bit(B_READING
, &b
->state
);
1045 smp_mb__after_atomic();
1047 wake_up_bit(&b
->state
, B_READING
);
1051 * A common routine for dm_bufio_new and dm_bufio_read. Operation of these
1052 * functions is similar except that dm_bufio_new doesn't read the
1053 * buffer from the disk (assuming that the caller overwrites all the data
1054 * and uses dm_bufio_mark_buffer_dirty to write new data back).
1056 static void *new_read(struct dm_bufio_client
*c
, sector_t block
,
1057 enum new_flag nf
, struct dm_buffer
**bp
)
1060 struct dm_buffer
*b
;
1062 LIST_HEAD(write_list
);
1065 b
= __bufio_new(c
, block
, nf
, &need_submit
, &write_list
);
1068 __flush_write_list(&write_list
);
1074 submit_io(b
, READ
, b
->block
, read_endio
);
1076 wait_on_bit_io(&b
->state
, B_READING
, TASK_UNINTERRUPTIBLE
);
1078 if (b
->read_error
) {
1079 int error
= b
->read_error
;
1081 dm_bufio_release(b
);
1083 return ERR_PTR(error
);
1091 void *dm_bufio_get(struct dm_bufio_client
*c
, sector_t block
,
1092 struct dm_buffer
**bp
)
1094 return new_read(c
, block
, NF_GET
, bp
);
1096 EXPORT_SYMBOL_GPL(dm_bufio_get
);
1098 void *dm_bufio_read(struct dm_bufio_client
*c
, sector_t block
,
1099 struct dm_buffer
**bp
)
1101 BUG_ON(dm_bufio_in_request());
1103 return new_read(c
, block
, NF_READ
, bp
);
1105 EXPORT_SYMBOL_GPL(dm_bufio_read
);
1107 void *dm_bufio_new(struct dm_bufio_client
*c
, sector_t block
,
1108 struct dm_buffer
**bp
)
1110 BUG_ON(dm_bufio_in_request());
1112 return new_read(c
, block
, NF_FRESH
, bp
);
1114 EXPORT_SYMBOL_GPL(dm_bufio_new
);
1116 void dm_bufio_prefetch(struct dm_bufio_client
*c
,
1117 sector_t block
, unsigned n_blocks
)
1119 struct blk_plug plug
;
1121 LIST_HEAD(write_list
);
1123 BUG_ON(dm_bufio_in_request());
1125 blk_start_plug(&plug
);
1128 for (; n_blocks
--; block
++) {
1130 struct dm_buffer
*b
;
1131 b
= __bufio_new(c
, block
, NF_PREFETCH
, &need_submit
,
1133 if (unlikely(!list_empty(&write_list
))) {
1135 blk_finish_plug(&plug
);
1136 __flush_write_list(&write_list
);
1137 blk_start_plug(&plug
);
1140 if (unlikely(b
!= NULL
)) {
1144 submit_io(b
, READ
, b
->block
, read_endio
);
1145 dm_bufio_release(b
);
1147 dm_bufio_cond_resched();
1158 blk_finish_plug(&plug
);
1160 EXPORT_SYMBOL_GPL(dm_bufio_prefetch
);
1162 void dm_bufio_release(struct dm_buffer
*b
)
1164 struct dm_bufio_client
*c
= b
->c
;
1168 BUG_ON(!b
->hold_count
);
1171 if (!b
->hold_count
) {
1172 wake_up(&c
->free_buffer_wait
);
1175 * If there were errors on the buffer, and the buffer is not
1176 * to be written, free the buffer. There is no point in caching
1179 if ((b
->read_error
|| b
->write_error
) &&
1180 !test_bit(B_READING
, &b
->state
) &&
1181 !test_bit(B_WRITING
, &b
->state
) &&
1182 !test_bit(B_DIRTY
, &b
->state
)) {
1184 __free_buffer_wake(b
);
1190 EXPORT_SYMBOL_GPL(dm_bufio_release
);
1192 void dm_bufio_mark_buffer_dirty(struct dm_buffer
*b
)
1194 struct dm_bufio_client
*c
= b
->c
;
1198 BUG_ON(test_bit(B_READING
, &b
->state
));
1200 if (!test_and_set_bit(B_DIRTY
, &b
->state
))
1201 __relink_lru(b
, LIST_DIRTY
);
1205 EXPORT_SYMBOL_GPL(dm_bufio_mark_buffer_dirty
);
1207 void dm_bufio_write_dirty_buffers_async(struct dm_bufio_client
*c
)
1209 LIST_HEAD(write_list
);
1211 BUG_ON(dm_bufio_in_request());
1214 __write_dirty_buffers_async(c
, 0, &write_list
);
1216 __flush_write_list(&write_list
);
1218 EXPORT_SYMBOL_GPL(dm_bufio_write_dirty_buffers_async
);
1221 * For performance, it is essential that the buffers are written asynchronously
1222 * and simultaneously (so that the block layer can merge the writes) and then
1225 * Finally, we flush hardware disk cache.
1227 int dm_bufio_write_dirty_buffers(struct dm_bufio_client
*c
)
1230 unsigned long buffers_processed
= 0;
1231 struct dm_buffer
*b
, *tmp
;
1233 LIST_HEAD(write_list
);
1236 __write_dirty_buffers_async(c
, 0, &write_list
);
1238 __flush_write_list(&write_list
);
1242 list_for_each_entry_safe_reverse(b
, tmp
, &c
->lru
[LIST_DIRTY
], lru_list
) {
1243 int dropped_lock
= 0;
1245 if (buffers_processed
< c
->n_buffers
[LIST_DIRTY
])
1246 buffers_processed
++;
1248 BUG_ON(test_bit(B_READING
, &b
->state
));
1250 if (test_bit(B_WRITING
, &b
->state
)) {
1251 if (buffers_processed
< c
->n_buffers
[LIST_DIRTY
]) {
1255 wait_on_bit_io(&b
->state
, B_WRITING
,
1256 TASK_UNINTERRUPTIBLE
);
1260 wait_on_bit_io(&b
->state
, B_WRITING
,
1261 TASK_UNINTERRUPTIBLE
);
1264 if (!test_bit(B_DIRTY
, &b
->state
) &&
1265 !test_bit(B_WRITING
, &b
->state
))
1266 __relink_lru(b
, LIST_CLEAN
);
1268 dm_bufio_cond_resched();
1271 * If we dropped the lock, the list is no longer consistent,
1272 * so we must restart the search.
1274 * In the most common case, the buffer just processed is
1275 * relinked to the clean list, so we won't loop scanning the
1276 * same buffer again and again.
1278 * This may livelock if there is another thread simultaneously
1279 * dirtying buffers, so we count the number of buffers walked
1280 * and if it exceeds the total number of buffers, it means that
1281 * someone is doing some writes simultaneously with us. In
1282 * this case, stop, dropping the lock.
1287 wake_up(&c
->free_buffer_wait
);
1290 a
= xchg(&c
->async_write_error
, 0);
1291 f
= dm_bufio_issue_flush(c
);
1297 EXPORT_SYMBOL_GPL(dm_bufio_write_dirty_buffers
);
1300 * Use dm-io to send and empty barrier flush the device.
1302 int dm_bufio_issue_flush(struct dm_bufio_client
*c
)
1304 struct dm_io_request io_req
= {
1305 .bi_rw
= WRITE_FLUSH
,
1306 .mem
.type
= DM_IO_KMEM
,
1307 .mem
.ptr
.addr
= NULL
,
1310 struct dm_io_region io_reg
= {
1316 BUG_ON(dm_bufio_in_request());
1318 return dm_io(&io_req
, 1, &io_reg
, NULL
);
1320 EXPORT_SYMBOL_GPL(dm_bufio_issue_flush
);
1323 * We first delete any other buffer that may be at that new location.
1325 * Then, we write the buffer to the original location if it was dirty.
1327 * Then, if we are the only one who is holding the buffer, relink the buffer
1328 * in the hash queue for the new location.
1330 * If there was someone else holding the buffer, we write it to the new
1331 * location but not relink it, because that other user needs to have the buffer
1332 * at the same place.
1334 void dm_bufio_release_move(struct dm_buffer
*b
, sector_t new_block
)
1336 struct dm_bufio_client
*c
= b
->c
;
1337 struct dm_buffer
*new;
1339 BUG_ON(dm_bufio_in_request());
1344 new = __find(c
, new_block
);
1346 if (new->hold_count
) {
1347 __wait_for_free_buffer(c
);
1352 * FIXME: Is there any point waiting for a write that's going
1353 * to be overwritten in a bit?
1355 __make_buffer_clean(new);
1356 __unlink_buffer(new);
1357 __free_buffer_wake(new);
1360 BUG_ON(!b
->hold_count
);
1361 BUG_ON(test_bit(B_READING
, &b
->state
));
1363 __write_dirty_buffer(b
, NULL
);
1364 if (b
->hold_count
== 1) {
1365 wait_on_bit_io(&b
->state
, B_WRITING
,
1366 TASK_UNINTERRUPTIBLE
);
1367 set_bit(B_DIRTY
, &b
->state
);
1369 __link_buffer(b
, new_block
, LIST_DIRTY
);
1372 wait_on_bit_lock_io(&b
->state
, B_WRITING
,
1373 TASK_UNINTERRUPTIBLE
);
1375 * Relink buffer to "new_block" so that write_callback
1376 * sees "new_block" as a block number.
1377 * After the write, link the buffer back to old_block.
1378 * All this must be done in bufio lock, so that block number
1379 * change isn't visible to other threads.
1381 old_block
= b
->block
;
1383 __link_buffer(b
, new_block
, b
->list_mode
);
1384 submit_io(b
, WRITE
, new_block
, write_endio
);
1385 wait_on_bit_io(&b
->state
, B_WRITING
,
1386 TASK_UNINTERRUPTIBLE
);
1388 __link_buffer(b
, old_block
, b
->list_mode
);
1392 dm_bufio_release(b
);
1394 EXPORT_SYMBOL_GPL(dm_bufio_release_move
);
1397 * Free the given buffer.
1399 * This is just a hint, if the buffer is in use or dirty, this function
1402 void dm_bufio_forget(struct dm_bufio_client
*c
, sector_t block
)
1404 struct dm_buffer
*b
;
1408 b
= __find(c
, block
);
1409 if (b
&& likely(!b
->hold_count
) && likely(!b
->state
)) {
1411 __free_buffer_wake(b
);
1416 EXPORT_SYMBOL(dm_bufio_forget
);
1418 void dm_bufio_set_minimum_buffers(struct dm_bufio_client
*c
, unsigned n
)
1420 c
->minimum_buffers
= n
;
1422 EXPORT_SYMBOL(dm_bufio_set_minimum_buffers
);
1424 unsigned dm_bufio_get_block_size(struct dm_bufio_client
*c
)
1426 return c
->block_size
;
1428 EXPORT_SYMBOL_GPL(dm_bufio_get_block_size
);
1430 sector_t
dm_bufio_get_device_size(struct dm_bufio_client
*c
)
1432 return i_size_read(c
->bdev
->bd_inode
) >>
1433 (SECTOR_SHIFT
+ c
->sectors_per_block_bits
);
1435 EXPORT_SYMBOL_GPL(dm_bufio_get_device_size
);
1437 sector_t
dm_bufio_get_block_number(struct dm_buffer
*b
)
1441 EXPORT_SYMBOL_GPL(dm_bufio_get_block_number
);
1443 void *dm_bufio_get_block_data(struct dm_buffer
*b
)
1447 EXPORT_SYMBOL_GPL(dm_bufio_get_block_data
);
1449 void *dm_bufio_get_aux_data(struct dm_buffer
*b
)
1453 EXPORT_SYMBOL_GPL(dm_bufio_get_aux_data
);
1455 struct dm_bufio_client
*dm_bufio_get_client(struct dm_buffer
*b
)
1459 EXPORT_SYMBOL_GPL(dm_bufio_get_client
);
1461 static void drop_buffers(struct dm_bufio_client
*c
)
1463 struct dm_buffer
*b
;
1466 BUG_ON(dm_bufio_in_request());
1469 * An optimization so that the buffers are not written one-by-one.
1471 dm_bufio_write_dirty_buffers_async(c
);
1475 while ((b
= __get_unclaimed_buffer(c
)))
1476 __free_buffer_wake(b
);
1478 for (i
= 0; i
< LIST_SIZE
; i
++)
1479 list_for_each_entry(b
, &c
->lru
[i
], lru_list
)
1480 DMERR("leaked buffer %llx, hold count %u, list %d",
1481 (unsigned long long)b
->block
, b
->hold_count
, i
);
1483 for (i
= 0; i
< LIST_SIZE
; i
++)
1484 BUG_ON(!list_empty(&c
->lru
[i
]));
1490 * We may not be able to evict this buffer if IO pending or the client
1491 * is still using it. Caller is expected to know buffer is too old.
1493 * And if GFP_NOFS is used, we must not do any I/O because we hold
1494 * dm_bufio_clients_lock and we would risk deadlock if the I/O gets
1495 * rerouted to different bufio client.
1497 static bool __try_evict_buffer(struct dm_buffer
*b
, gfp_t gfp
)
1499 if (!(gfp
& __GFP_FS
)) {
1500 if (test_bit(B_READING
, &b
->state
) ||
1501 test_bit(B_WRITING
, &b
->state
) ||
1502 test_bit(B_DIRTY
, &b
->state
))
1509 __make_buffer_clean(b
);
1511 __free_buffer_wake(b
);
1516 static unsigned get_retain_buffers(struct dm_bufio_client
*c
)
1518 unsigned retain_bytes
= ACCESS_ONCE(dm_bufio_retain_bytes
);
1519 return retain_bytes
/ c
->block_size
;
1522 static unsigned long __scan(struct dm_bufio_client
*c
, unsigned long nr_to_scan
,
1526 struct dm_buffer
*b
, *tmp
;
1527 unsigned long freed
= 0;
1528 unsigned long count
= nr_to_scan
;
1529 unsigned retain_target
= get_retain_buffers(c
);
1531 for (l
= 0; l
< LIST_SIZE
; l
++) {
1532 list_for_each_entry_safe_reverse(b
, tmp
, &c
->lru
[l
], lru_list
) {
1533 if (__try_evict_buffer(b
, gfp_mask
))
1535 if (!--nr_to_scan
|| ((count
- freed
) <= retain_target
))
1537 dm_bufio_cond_resched();
1543 static unsigned long
1544 dm_bufio_shrink_scan(struct shrinker
*shrink
, struct shrink_control
*sc
)
1546 struct dm_bufio_client
*c
;
1547 unsigned long freed
;
1549 c
= container_of(shrink
, struct dm_bufio_client
, shrinker
);
1550 if (sc
->gfp_mask
& __GFP_FS
)
1552 else if (!dm_bufio_trylock(c
))
1555 freed
= __scan(c
, sc
->nr_to_scan
, sc
->gfp_mask
);
1560 static unsigned long
1561 dm_bufio_shrink_count(struct shrinker
*shrink
, struct shrink_control
*sc
)
1563 struct dm_bufio_client
*c
;
1564 unsigned long count
;
1566 c
= container_of(shrink
, struct dm_bufio_client
, shrinker
);
1567 if (sc
->gfp_mask
& __GFP_FS
)
1569 else if (!dm_bufio_trylock(c
))
1572 count
= c
->n_buffers
[LIST_CLEAN
] + c
->n_buffers
[LIST_DIRTY
];
1578 * Create the buffering interface
1580 struct dm_bufio_client
*dm_bufio_client_create(struct block_device
*bdev
, unsigned block_size
,
1581 unsigned reserved_buffers
, unsigned aux_size
,
1582 void (*alloc_callback
)(struct dm_buffer
*),
1583 void (*write_callback
)(struct dm_buffer
*))
1586 struct dm_bufio_client
*c
;
1589 BUG_ON(block_size
< 1 << SECTOR_SHIFT
||
1590 (block_size
& (block_size
- 1)));
1592 c
= kzalloc(sizeof(*c
), GFP_KERNEL
);
1597 c
->buffer_tree
= RB_ROOT
;
1600 c
->block_size
= block_size
;
1601 c
->sectors_per_block_bits
= __ffs(block_size
) - SECTOR_SHIFT
;
1602 c
->pages_per_block_bits
= (__ffs(block_size
) >= PAGE_SHIFT
) ?
1603 __ffs(block_size
) - PAGE_SHIFT
: 0;
1604 c
->blocks_per_page_bits
= (__ffs(block_size
) < PAGE_SHIFT
?
1605 PAGE_SHIFT
- __ffs(block_size
) : 0);
1607 c
->aux_size
= aux_size
;
1608 c
->alloc_callback
= alloc_callback
;
1609 c
->write_callback
= write_callback
;
1611 for (i
= 0; i
< LIST_SIZE
; i
++) {
1612 INIT_LIST_HEAD(&c
->lru
[i
]);
1613 c
->n_buffers
[i
] = 0;
1616 mutex_init(&c
->lock
);
1617 INIT_LIST_HEAD(&c
->reserved_buffers
);
1618 c
->need_reserved_buffers
= reserved_buffers
;
1620 c
->minimum_buffers
= DM_BUFIO_MIN_BUFFERS
;
1622 init_waitqueue_head(&c
->free_buffer_wait
);
1623 c
->async_write_error
= 0;
1625 c
->dm_io
= dm_io_client_create();
1626 if (IS_ERR(c
->dm_io
)) {
1627 r
= PTR_ERR(c
->dm_io
);
1631 mutex_lock(&dm_bufio_clients_lock
);
1632 if (c
->blocks_per_page_bits
) {
1633 if (!DM_BUFIO_CACHE_NAME(c
)) {
1634 DM_BUFIO_CACHE_NAME(c
) = kasprintf(GFP_KERNEL
, "dm_bufio_cache-%u", c
->block_size
);
1635 if (!DM_BUFIO_CACHE_NAME(c
)) {
1637 mutex_unlock(&dm_bufio_clients_lock
);
1642 if (!DM_BUFIO_CACHE(c
)) {
1643 DM_BUFIO_CACHE(c
) = kmem_cache_create(DM_BUFIO_CACHE_NAME(c
),
1645 c
->block_size
, 0, NULL
);
1646 if (!DM_BUFIO_CACHE(c
)) {
1648 mutex_unlock(&dm_bufio_clients_lock
);
1653 mutex_unlock(&dm_bufio_clients_lock
);
1655 while (c
->need_reserved_buffers
) {
1656 struct dm_buffer
*b
= alloc_buffer(c
, GFP_KERNEL
);
1662 __free_buffer_wake(b
);
1665 mutex_lock(&dm_bufio_clients_lock
);
1666 dm_bufio_client_count
++;
1667 list_add(&c
->client_list
, &dm_bufio_all_clients
);
1668 __cache_size_refresh();
1669 mutex_unlock(&dm_bufio_clients_lock
);
1671 c
->shrinker
.count_objects
= dm_bufio_shrink_count
;
1672 c
->shrinker
.scan_objects
= dm_bufio_shrink_scan
;
1673 c
->shrinker
.seeks
= 1;
1674 c
->shrinker
.batch
= 0;
1675 register_shrinker(&c
->shrinker
);
1681 while (!list_empty(&c
->reserved_buffers
)) {
1682 struct dm_buffer
*b
= list_entry(c
->reserved_buffers
.next
,
1683 struct dm_buffer
, lru_list
);
1684 list_del(&b
->lru_list
);
1687 dm_io_client_destroy(c
->dm_io
);
1693 EXPORT_SYMBOL_GPL(dm_bufio_client_create
);
1696 * Free the buffering interface.
1697 * It is required that there are no references on any buffers.
1699 void dm_bufio_client_destroy(struct dm_bufio_client
*c
)
1705 unregister_shrinker(&c
->shrinker
);
1707 mutex_lock(&dm_bufio_clients_lock
);
1709 list_del(&c
->client_list
);
1710 dm_bufio_client_count
--;
1711 __cache_size_refresh();
1713 mutex_unlock(&dm_bufio_clients_lock
);
1715 BUG_ON(!RB_EMPTY_ROOT(&c
->buffer_tree
));
1716 BUG_ON(c
->need_reserved_buffers
);
1718 while (!list_empty(&c
->reserved_buffers
)) {
1719 struct dm_buffer
*b
= list_entry(c
->reserved_buffers
.next
,
1720 struct dm_buffer
, lru_list
);
1721 list_del(&b
->lru_list
);
1725 for (i
= 0; i
< LIST_SIZE
; i
++)
1726 if (c
->n_buffers
[i
])
1727 DMERR("leaked buffer count %d: %ld", i
, c
->n_buffers
[i
]);
1729 for (i
= 0; i
< LIST_SIZE
; i
++)
1730 BUG_ON(c
->n_buffers
[i
]);
1732 dm_io_client_destroy(c
->dm_io
);
1735 EXPORT_SYMBOL_GPL(dm_bufio_client_destroy
);
1737 static unsigned get_max_age_hz(void)
1739 unsigned max_age
= ACCESS_ONCE(dm_bufio_max_age
);
1741 if (max_age
> UINT_MAX
/ HZ
)
1742 max_age
= UINT_MAX
/ HZ
;
1744 return max_age
* HZ
;
1747 static bool older_than(struct dm_buffer
*b
, unsigned long age_hz
)
1749 return time_after_eq(jiffies
, b
->last_accessed
+ age_hz
);
1752 static void __evict_old_buffers(struct dm_bufio_client
*c
, unsigned long age_hz
)
1754 struct dm_buffer
*b
, *tmp
;
1755 unsigned retain_target
= get_retain_buffers(c
);
1760 count
= c
->n_buffers
[LIST_CLEAN
] + c
->n_buffers
[LIST_DIRTY
];
1761 list_for_each_entry_safe_reverse(b
, tmp
, &c
->lru
[LIST_CLEAN
], lru_list
) {
1762 if (count
<= retain_target
)
1765 if (!older_than(b
, age_hz
))
1768 if (__try_evict_buffer(b
, 0))
1771 dm_bufio_cond_resched();
1777 static void cleanup_old_buffers(void)
1779 unsigned long max_age_hz
= get_max_age_hz();
1780 struct dm_bufio_client
*c
;
1782 mutex_lock(&dm_bufio_clients_lock
);
1784 list_for_each_entry(c
, &dm_bufio_all_clients
, client_list
)
1785 __evict_old_buffers(c
, max_age_hz
);
1787 mutex_unlock(&dm_bufio_clients_lock
);
1790 static struct workqueue_struct
*dm_bufio_wq
;
1791 static struct delayed_work dm_bufio_work
;
1793 static void work_fn(struct work_struct
*w
)
1795 cleanup_old_buffers();
1797 queue_delayed_work(dm_bufio_wq
, &dm_bufio_work
,
1798 DM_BUFIO_WORK_TIMER_SECS
* HZ
);
1801 /*----------------------------------------------------------------
1803 *--------------------------------------------------------------*/
1806 * This is called only once for the whole dm_bufio module.
1807 * It initializes memory limit.
1809 static int __init
dm_bufio_init(void)
1813 dm_bufio_allocated_kmem_cache
= 0;
1814 dm_bufio_allocated_get_free_pages
= 0;
1815 dm_bufio_allocated_vmalloc
= 0;
1816 dm_bufio_current_allocated
= 0;
1818 memset(&dm_bufio_caches
, 0, sizeof dm_bufio_caches
);
1819 memset(&dm_bufio_cache_names
, 0, sizeof dm_bufio_cache_names
);
1821 mem
= (__u64
)((totalram_pages
- totalhigh_pages
) *
1822 DM_BUFIO_MEMORY_PERCENT
/ 100) << PAGE_SHIFT
;
1824 if (mem
> ULONG_MAX
)
1829 * Get the size of vmalloc space the same way as VMALLOC_TOTAL
1830 * in fs/proc/internal.h
1832 if (mem
> (VMALLOC_END
- VMALLOC_START
) * DM_BUFIO_VMALLOC_PERCENT
/ 100)
1833 mem
= (VMALLOC_END
- VMALLOC_START
) * DM_BUFIO_VMALLOC_PERCENT
/ 100;
1836 dm_bufio_default_cache_size
= mem
;
1838 mutex_lock(&dm_bufio_clients_lock
);
1839 __cache_size_refresh();
1840 mutex_unlock(&dm_bufio_clients_lock
);
1842 dm_bufio_wq
= create_singlethread_workqueue("dm_bufio_cache");
1846 INIT_DELAYED_WORK(&dm_bufio_work
, work_fn
);
1847 queue_delayed_work(dm_bufio_wq
, &dm_bufio_work
,
1848 DM_BUFIO_WORK_TIMER_SECS
* HZ
);
1854 * This is called once when unloading the dm_bufio module.
1856 static void __exit
dm_bufio_exit(void)
1861 cancel_delayed_work_sync(&dm_bufio_work
);
1862 destroy_workqueue(dm_bufio_wq
);
1864 for (i
= 0; i
< ARRAY_SIZE(dm_bufio_caches
); i
++)
1865 kmem_cache_destroy(dm_bufio_caches
[i
]);
1867 for (i
= 0; i
< ARRAY_SIZE(dm_bufio_cache_names
); i
++)
1868 kfree(dm_bufio_cache_names
[i
]);
1870 if (dm_bufio_client_count
) {
1871 DMCRIT("%s: dm_bufio_client_count leaked: %d",
1872 __func__
, dm_bufio_client_count
);
1876 if (dm_bufio_current_allocated
) {
1877 DMCRIT("%s: dm_bufio_current_allocated leaked: %lu",
1878 __func__
, dm_bufio_current_allocated
);
1882 if (dm_bufio_allocated_get_free_pages
) {
1883 DMCRIT("%s: dm_bufio_allocated_get_free_pages leaked: %lu",
1884 __func__
, dm_bufio_allocated_get_free_pages
);
1888 if (dm_bufio_allocated_vmalloc
) {
1889 DMCRIT("%s: dm_bufio_vmalloc leaked: %lu",
1890 __func__
, dm_bufio_allocated_vmalloc
);
1898 module_init(dm_bufio_init
)
1899 module_exit(dm_bufio_exit
)
1901 module_param_named(max_cache_size_bytes
, dm_bufio_cache_size
, ulong
, S_IRUGO
| S_IWUSR
);
1902 MODULE_PARM_DESC(max_cache_size_bytes
, "Size of metadata cache");
1904 module_param_named(max_age_seconds
, dm_bufio_max_age
, uint
, S_IRUGO
| S_IWUSR
);
1905 MODULE_PARM_DESC(max_age_seconds
, "Max age of a buffer in seconds");
1907 module_param_named(retain_bytes
, dm_bufio_retain_bytes
, uint
, S_IRUGO
| S_IWUSR
);
1908 MODULE_PARM_DESC(retain_bytes
, "Try to keep at least this many bytes cached in memory");
1910 module_param_named(peak_allocated_bytes
, dm_bufio_peak_allocated
, ulong
, S_IRUGO
| S_IWUSR
);
1911 MODULE_PARM_DESC(peak_allocated_bytes
, "Tracks the maximum allocated memory");
1913 module_param_named(allocated_kmem_cache_bytes
, dm_bufio_allocated_kmem_cache
, ulong
, S_IRUGO
);
1914 MODULE_PARM_DESC(allocated_kmem_cache_bytes
, "Memory allocated with kmem_cache_alloc");
1916 module_param_named(allocated_get_free_pages_bytes
, dm_bufio_allocated_get_free_pages
, ulong
, S_IRUGO
);
1917 MODULE_PARM_DESC(allocated_get_free_pages_bytes
, "Memory allocated with get_free_pages");
1919 module_param_named(allocated_vmalloc_bytes
, dm_bufio_allocated_vmalloc
, ulong
, S_IRUGO
);
1920 MODULE_PARM_DESC(allocated_vmalloc_bytes
, "Memory allocated with vmalloc");
1922 module_param_named(current_allocated_bytes
, dm_bufio_current_allocated
, ulong
, S_IRUGO
);
1923 MODULE_PARM_DESC(current_allocated_bytes
, "Memory currently used by the cache");
1925 MODULE_AUTHOR("Mikulas Patocka <dm-devel@redhat.com>");
1926 MODULE_DESCRIPTION(DM_NAME
" buffered I/O library");
1927 MODULE_LICENSE("GPL");