772 lines · 22.4 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0/* *  memory buffer pool support. Such pools are mostly used *  for guaranteed, deadlock-free memory allocations during *  extreme VM load. * *  started by Ingo Molnar, Copyright (C) 2001 *  debugging by David Rientjes, Copyright (C) 2015 */#include <linux/fault-inject.h>#include <linux/mm.h>#include <linux/slab.h>#include <linux/highmem.h>#include <linux/kasan.h>#include <linux/kmemleak.h>#include <linux/export.h>#include <linux/mempool.h>#include <linux/writeback.h>#include <linux/static_key.h>#include <linux/init.h>#include "slab.h" static DECLARE_FAULT_ATTR(fail_mempool_alloc);static DECLARE_FAULT_ATTR(fail_mempool_alloc_bulk); /* * Debugging support for mempool using static key. * * This allows enabling mempool debug at boot time via: *   mempool_debug */static DEFINE_STATIC_KEY_FALSE(mempool_debug_enabled); static int __init mempool_debug_setup(char *str){	static_branch_enable(&mempool_debug_enabled);	return 1;}__setup("mempool_debug", mempool_debug_setup); static int __init mempool_faul_inject_init(void){	int error; 	error = PTR_ERR_OR_ZERO(fault_create_debugfs_attr("fail_mempool_alloc",			NULL, &fail_mempool_alloc));	if (error)		return error; 	/* booting will fail on error return here, don't bother to cleanup */	return PTR_ERR_OR_ZERO(		fault_create_debugfs_attr("fail_mempool_alloc_bulk", NULL,		&fail_mempool_alloc_bulk));}late_initcall(mempool_faul_inject_init); static void poison_error(struct mempool *pool, void *element, size_t size,			 size_t byte){	const int nr = pool->curr_nr;	const int start = max_t(int, byte - (BITS_PER_LONG / 8), 0);	const int end = min_t(int, byte + (BITS_PER_LONG / 8), size);	int i; 	pr_err("BUG: mempool element poison mismatch\n");	pr_err("Mempool %p size %zu\n", pool, size);	pr_err(" nr=%d @ %p: %s0x", nr, element, start > 0 ? "... " : "");	for (i = start; i < end; i++)		pr_cont("%x ", *(u8 *)(element + i));	pr_cont("%s\n", end < size ? "..." : "");	dump_stack();} static void __check_element(struct mempool *pool, void *element, size_t size){	u8 *obj = element;	size_t i; 	for (i = 0; i < size; i++) {		u8 exp = (i < size - 1) ? POISON_FREE : POISON_END; 		if (obj[i] != exp) {			poison_error(pool, element, size, i);			return;		}	}	memset(obj, POISON_INUSE, size);} static void check_element(struct mempool *pool, void *element){	/* Skip checking: KASAN might save its metadata in the element. */	if (kasan_enabled())		return; 	/* Mempools backed by slab allocator */	if (pool->free == mempool_kfree) {		__check_element(pool, element, (size_t)pool->pool_data);	} else if (pool->free == mempool_free_slab) {		__check_element(pool, element, kmem_cache_size(pool->pool_data));	} else if (pool->free == mempool_free_pages) {		/* Mempools backed by page allocator */		int order = (int)(long)pool->pool_data; #ifdef CONFIG_HIGHMEM		for (int i = 0; i < (1 << order); i++) {			struct page *page = (struct page *)element;			void *addr = kmap_local_page(page + i); 			__check_element(pool, addr, PAGE_SIZE);			kunmap_local(addr);		}#else		void *addr = page_address((struct page *)element); 		__check_element(pool, addr, PAGE_SIZE << order);#endif	}} static void __poison_element(void *element, size_t size){	u8 *obj = element; 	memset(obj, POISON_FREE, size - 1);	obj[size - 1] = POISON_END;} static void poison_element(struct mempool *pool, void *element){	/* Skip poisoning: KASAN might save its metadata in the element. */	if (kasan_enabled())		return; 	/* Mempools backed by slab allocator */	if (pool->alloc == mempool_kmalloc) {		__poison_element(element, (size_t)pool->pool_data);	} else if (pool->alloc == mempool_alloc_slab) {		__poison_element(element, kmem_cache_size(pool->pool_data));	} else if (pool->alloc == mempool_alloc_pages) {		/* Mempools backed by page allocator */		int order = (int)(long)pool->pool_data; #ifdef CONFIG_HIGHMEM		for (int i = 0; i < (1 << order); i++) {			struct page *page = (struct page *)element;			void *addr = kmap_local_page(page + i); 			__poison_element(addr, PAGE_SIZE);			kunmap_local(addr);		}#else		void *addr = page_address((struct page *)element); 		__poison_element(addr, PAGE_SIZE << order);#endif	}} static __always_inline bool kasan_poison_element(struct mempool *pool,		void *element){	if (pool->alloc == mempool_alloc_slab || pool->alloc == mempool_kmalloc)		return kasan_mempool_poison_object(element);	else if (pool->alloc == mempool_alloc_pages)		return kasan_mempool_poison_pages(element,						(unsigned long)pool->pool_data);	return true;} static void kasan_unpoison_element(struct mempool *pool, void *element){	if (pool->alloc == mempool_kmalloc)		kasan_mempool_unpoison_object(element, (size_t)pool->pool_data);	else if (pool->alloc == mempool_alloc_slab)		kasan_mempool_unpoison_object(element,					      kmem_cache_size(pool->pool_data));	else if (pool->alloc == mempool_alloc_pages)		kasan_mempool_unpoison_pages(element,					     (unsigned long)pool->pool_data);} static __always_inline void add_element(struct mempool *pool, void *element){	BUG_ON(pool->min_nr != 0 && pool->curr_nr >= pool->min_nr); 	if (static_branch_unlikely(&mempool_debug_enabled))		poison_element(pool, element); 	if (kasan_poison_element(pool, element))		pool->elements[pool->curr_nr++] = element;} static void *remove_element(struct mempool *pool){	void *element = pool->elements[--pool->curr_nr]; 	BUG_ON(pool->curr_nr < 0);	kasan_unpoison_element(pool, element); 	if (static_branch_unlikely(&mempool_debug_enabled))		check_element(pool, element);	return element;} /** * mempool_exit - exit a mempool initialized with mempool_init() * @pool:      pointer to the memory pool which was initialized with *             mempool_init(). * * Free all reserved elements in @pool and @pool itself.  This function * only sleeps if the free_fn() function sleeps. * * May be called on a zeroed but uninitialized mempool (i.e. allocated with * kzalloc()). */void mempool_exit(struct mempool *pool){	while (pool->curr_nr) {		void *element = remove_element(pool);		pool->free(element, pool->pool_data);	}	kfree(pool->elements);	pool->elements = NULL;}EXPORT_SYMBOL(mempool_exit); /** * mempool_destroy - deallocate a memory pool * @pool:      pointer to the memory pool which was allocated via *             mempool_create(). * * Free all reserved elements in @pool and @pool itself.  This function * only sleeps if the free_fn() function sleeps. */void mempool_destroy(struct mempool *pool){	if (unlikely(!pool))		return; 	mempool_exit(pool);	kfree(pool);}EXPORT_SYMBOL(mempool_destroy); int mempool_init_node(struct mempool *pool, int min_nr,		mempool_alloc_t *alloc_fn, mempool_free_t *free_fn,		void *pool_data, gfp_t gfp_mask, int node_id){	spin_lock_init(&pool->lock);	pool->min_nr	= min_nr;	pool->pool_data = pool_data;	pool->alloc	= alloc_fn;	pool->free	= free_fn;	init_waitqueue_head(&pool->wait);	/*	 * max() used here to ensure storage for at least 1 element to support	 * zero minimum pool	 */	pool->elements = kmalloc_array_node(max(1, min_nr), sizeof(void *),					    gfp_mask, node_id);	if (!pool->elements)		return -ENOMEM; 	/*	 * First pre-allocate the guaranteed number of buffers,	 * also pre-allocate 1 element for zero minimum pool.	 */	while (pool->curr_nr < max(1, pool->min_nr)) {		void *element; 		element = pool->alloc(gfp_mask, pool->pool_data);		if (unlikely(!element)) {			mempool_exit(pool);			return -ENOMEM;		}		add_element(pool, element);	} 	return 0;}EXPORT_SYMBOL(mempool_init_node); /** * mempool_init - initialize a memory pool * @pool:      pointer to the memory pool that should be initialized * @min_nr:    the minimum number of elements guaranteed to be *             allocated for this pool. * @alloc_fn:  user-defined element-allocation function. * @free_fn:   user-defined element-freeing function. * @pool_data: optional private data available to the user-defined functions. * * Like mempool_create(), but initializes the pool in (i.e. embedded in another * structure). * * Return: %0 on success, negative error code otherwise. */int mempool_init_noprof(struct mempool *pool, int min_nr,		mempool_alloc_t *alloc_fn, mempool_free_t *free_fn,		void *pool_data){	return mempool_init_node(pool, min_nr, alloc_fn, free_fn,				 pool_data, GFP_KERNEL, NUMA_NO_NODE); }EXPORT_SYMBOL(mempool_init_noprof); /** * mempool_create_node - create a memory pool * @min_nr:    the minimum number of elements guaranteed to be *             allocated for this pool. * @alloc_fn:  user-defined element-allocation function. * @free_fn:   user-defined element-freeing function. * @pool_data: optional private data available to the user-defined functions. * @gfp_mask:  memory allocation flags * @node_id:   numa node to allocate on * * this function creates and allocates a guaranteed size, preallocated * memory pool. The pool can be used from the mempool_alloc() and mempool_free() * functions. This function might sleep. Both the alloc_fn() and the free_fn() * functions might sleep - as long as the mempool_alloc() function is not called * from IRQ contexts. * * Return: pointer to the created memory pool object or %NULL on error. */struct mempool *mempool_create_node_noprof(int min_nr,		mempool_alloc_t *alloc_fn, mempool_free_t *free_fn,		void *pool_data, gfp_t gfp_mask, int node_id){	struct mempool *pool; 	pool = kmalloc_node_noprof(sizeof(*pool), gfp_mask | __GFP_ZERO, node_id);	if (!pool)		return NULL; 	if (mempool_init_node(pool, min_nr, alloc_fn, free_fn, pool_data,			      gfp_mask, node_id)) {		kfree(pool);		return NULL;	} 	return pool;}EXPORT_SYMBOL(mempool_create_node_noprof); /** * mempool_resize - resize an existing memory pool * @pool:       pointer to the memory pool which was allocated via *              mempool_create(). * @new_min_nr: the new minimum number of elements guaranteed to be *              allocated for this pool. * * This function shrinks/grows the pool. In the case of growing, * it cannot be guaranteed that the pool will be grown to the new * size immediately, but new mempool_free() calls will refill it. * This function may sleep. * * Note, the caller must guarantee that no mempool_destroy is called * while this function is running. mempool_alloc() & mempool_free() * might be called (eg. from IRQ contexts) while this function executes. * * Return: %0 on success, negative error code otherwise. */int mempool_resize(struct mempool *pool, int new_min_nr){	void *element;	void **new_elements;	unsigned long flags; 	BUG_ON(new_min_nr <= 0);	might_sleep(); 	spin_lock_irqsave(&pool->lock, flags);	if (new_min_nr <= pool->min_nr) {		while (new_min_nr < pool->curr_nr) {			element = remove_element(pool);			spin_unlock_irqrestore(&pool->lock, flags);			pool->free(element, pool->pool_data);			spin_lock_irqsave(&pool->lock, flags);		}		pool->min_nr = new_min_nr;		goto out_unlock;	}	spin_unlock_irqrestore(&pool->lock, flags); 	/* Grow the pool */	new_elements = kmalloc_objs(*new_elements, new_min_nr);	if (!new_elements)		return -ENOMEM; 	spin_lock_irqsave(&pool->lock, flags);	if (unlikely(new_min_nr <= pool->min_nr)) {		/* Raced, other resize will do our work */		spin_unlock_irqrestore(&pool->lock, flags);		kfree(new_elements);		goto out;	}	memcpy(new_elements, pool->elements,			pool->curr_nr * sizeof(*new_elements));	kfree(pool->elements);	pool->elements = new_elements;	pool->min_nr = new_min_nr; 	while (pool->curr_nr < pool->min_nr) {		spin_unlock_irqrestore(&pool->lock, flags);		element = pool->alloc(GFP_KERNEL, pool->pool_data);		if (!element)			goto out;		spin_lock_irqsave(&pool->lock, flags);		if (pool->curr_nr < pool->min_nr) {			add_element(pool, element);		} else {			spin_unlock_irqrestore(&pool->lock, flags);			pool->free(element, pool->pool_data);	/* Raced */			goto out;		}	}out_unlock:	spin_unlock_irqrestore(&pool->lock, flags);out:	return 0;}EXPORT_SYMBOL(mempool_resize); static unsigned int mempool_alloc_from_pool(struct mempool *pool, void **elems,		unsigned int count, unsigned int allocated,		gfp_t gfp_mask){	unsigned long flags;	unsigned int i; 	spin_lock_irqsave(&pool->lock, flags);	if (unlikely(pool->curr_nr < count - allocated))		goto fail;	while (allocated < count)		elems[allocated++] = remove_element(pool);	spin_unlock_irqrestore(&pool->lock, flags); 	/* Paired with rmb in mempool_free(), read comment there. */	smp_wmb(); 	/*	 * Update the allocation stack trace as this is more useful for	 * debugging.	 */	for (i = 0; i < count; i++)		kmemleak_update_trace(elems[i]);	return allocated; fail:	if (gfp_mask & __GFP_DIRECT_RECLAIM) {		DEFINE_WAIT(wait); 		prepare_to_wait(&pool->wait, &wait, TASK_UNINTERRUPTIBLE);		spin_unlock_irqrestore(&pool->lock, flags); 		/*		 * Wait for someone else to return an element to @pool, but wake		 * up occasionally as memory pressure might have reduced even		 * and the normal allocation in alloc_fn could succeed even if		 * no element was returned.		 */		io_schedule_timeout(5 * HZ);		finish_wait(&pool->wait, &wait);	} else {		/* We must not sleep if __GFP_DIRECT_RECLAIM is not set. */		spin_unlock_irqrestore(&pool->lock, flags);	} 	return allocated;} /* * Adjust the gfp flags for mempool allocations, as we never want to dip into * the global emergency reserves or retry in the page allocator. * * The first pass also doesn't want to go reclaim, but the next passes do, so * return a separate subset for that first iteration. */static inline gfp_t mempool_adjust_gfp(gfp_t *gfp_mask){	*gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;	return *gfp_mask & ~(__GFP_DIRECT_RECLAIM | __GFP_IO);} /** * mempool_alloc_bulk - allocate multiple elements from a memory pool * @pool:	pointer to the memory pool * @elems:	partially or fully populated elements array * @count:	number of entries in @elem that need to be allocated * * Allocate @count elements into @elems.  This is done by first calling into the * alloc_fn supplied at pool initialization time, and dipping into the reserved * pool when alloc_fn fails to allocate an element. * * On return all @count elements in @elems will be populated. * * Return: Always 0.  If it wasn't for %$#^$ alloc tags, it would return void. */int mempool_alloc_bulk_noprof(struct mempool *pool, void **elems,

Lines 1–500 of 772.