blob: 577ddf8059758b05ecf9871c2409e3c8d346b5c6 [file] [log] [blame]
Jes Sorensenf14f75b2005-06-21 17:15:02 -07001/*
2 * Basic general purpose allocator for managing special purpose memory
3 * not managed by the regular kmalloc/kfree interface.
4 * Uses for this includes on-device special memory, uncached memory
5 * etc.
6 *
Jes Sorensenf14f75b2005-06-21 17:15:02 -07007 * Copyright 2005 (C) Jes Sorensen <jes@trained-monkey.org>
8 *
9 * This source code is licensed under the GNU General Public License,
10 * Version 2. See the file COPYING for more details.
11 */
12
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090013#include <linux/slab.h>
Jes Sorensenf14f75b2005-06-21 17:15:02 -070014#include <linux/module.h>
Akinobu Mita243797f2009-12-15 16:48:31 -080015#include <linux/bitmap.h>
Jes Sorensenf14f75b2005-06-21 17:15:02 -070016#include <linux/genalloc.h>
17
Jes Sorensenf14f75b2005-06-21 17:15:02 -070018
Dean Nelsona58cbd72006-10-02 02:17:01 -070019/**
20 * gen_pool_create - create a new special memory pool
Dean Nelson929f9722006-06-23 02:03:21 -070021 * @min_alloc_order: log base 2 of number of bytes each bitmap bit represents
22 * @nid: node id of the node the pool structure should be allocated on, or -1
Dean Nelsona58cbd72006-10-02 02:17:01 -070023 *
24 * Create a new special memory pool that can be used to manage special purpose
25 * memory not managed by the regular kmalloc/kfree interface.
Dean Nelson929f9722006-06-23 02:03:21 -070026 */
27struct gen_pool *gen_pool_create(int min_alloc_order, int nid)
Jes Sorensenf14f75b2005-06-21 17:15:02 -070028{
Dean Nelson929f9722006-06-23 02:03:21 -070029 struct gen_pool *pool;
Jes Sorensenf14f75b2005-06-21 17:15:02 -070030
Dean Nelson929f9722006-06-23 02:03:21 -070031 pool = kmalloc_node(sizeof(struct gen_pool), GFP_KERNEL, nid);
32 if (pool != NULL) {
33 rwlock_init(&pool->lock);
34 INIT_LIST_HEAD(&pool->chunks);
35 pool->min_alloc_order = min_alloc_order;
Jes Sorensenf14f75b2005-06-21 17:15:02 -070036 }
Dean Nelson929f9722006-06-23 02:03:21 -070037 return pool;
Jes Sorensenf14f75b2005-06-21 17:15:02 -070038}
39EXPORT_SYMBOL(gen_pool_create);
40
Dean Nelsona58cbd72006-10-02 02:17:01 -070041/**
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070042 * gen_pool_add_virt - add a new chunk of special memory to the pool
Dean Nelson929f9722006-06-23 02:03:21 -070043 * @pool: pool to add new memory chunk to
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070044 * @virt: virtual starting address of memory chunk to add to pool
45 * @phys: physical starting address of memory chunk to add to pool
Dean Nelson929f9722006-06-23 02:03:21 -070046 * @size: size in bytes of the memory chunk to add to pool
47 * @nid: node id of the node the chunk structure and bitmap should be
48 * allocated on, or -1
Dean Nelsona58cbd72006-10-02 02:17:01 -070049 *
50 * Add a new chunk of special memory to the specified pool.
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070051 *
52 * Returns 0 on success or a -ve errno on failure.
Jes Sorensenf14f75b2005-06-21 17:15:02 -070053 */
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070054int gen_pool_add_virt(struct gen_pool *pool, unsigned long virt, phys_addr_t phys,
55 size_t size, int nid)
Jes Sorensenf14f75b2005-06-21 17:15:02 -070056{
Dean Nelson929f9722006-06-23 02:03:21 -070057 struct gen_pool_chunk *chunk;
58 int nbits = size >> pool->min_alloc_order;
59 int nbytes = sizeof(struct gen_pool_chunk) +
60 (nbits + BITS_PER_BYTE - 1) / BITS_PER_BYTE;
Jes Sorensenf14f75b2005-06-21 17:15:02 -070061
Christoph Lameter94f60302007-07-17 04:03:29 -070062 chunk = kmalloc_node(nbytes, GFP_KERNEL | __GFP_ZERO, nid);
Dean Nelson929f9722006-06-23 02:03:21 -070063 if (unlikely(chunk == NULL))
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070064 return -ENOMEM;
Jes Sorensenf14f75b2005-06-21 17:15:02 -070065
Dean Nelson929f9722006-06-23 02:03:21 -070066 spin_lock_init(&chunk->lock);
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070067 chunk->phys_addr = phys;
68 chunk->start_addr = virt;
69 chunk->end_addr = virt + size;
Dean Nelson929f9722006-06-23 02:03:21 -070070
71 write_lock(&pool->lock);
72 list_add(&chunk->next_chunk, &pool->chunks);
73 write_unlock(&pool->lock);
74
75 return 0;
76}
Jean-Christophe PLAGNIOL-VILLARD3c8f3702011-05-24 17:13:34 -070077EXPORT_SYMBOL(gen_pool_add_virt);
78
79/**
80 * gen_pool_virt_to_phys - return the physical address of memory
81 * @pool: pool to allocate from
82 * @addr: starting address of memory
83 *
84 * Returns the physical address on success, or -1 on error.
85 */
86phys_addr_t gen_pool_virt_to_phys(struct gen_pool *pool, unsigned long addr)
87{
88 struct list_head *_chunk;
89 struct gen_pool_chunk *chunk;
90
91 read_lock(&pool->lock);
92 list_for_each(_chunk, &pool->chunks) {
93 chunk = list_entry(_chunk, struct gen_pool_chunk, next_chunk);
94
95 if (addr >= chunk->start_addr && addr < chunk->end_addr)
96 return chunk->phys_addr + addr - chunk->start_addr;
97 }
98 read_unlock(&pool->lock);
99
100 return -1;
101}
102EXPORT_SYMBOL(gen_pool_virt_to_phys);
Dean Nelson929f9722006-06-23 02:03:21 -0700103
Dean Nelsona58cbd72006-10-02 02:17:01 -0700104/**
105 * gen_pool_destroy - destroy a special memory pool
Steve Wise322acc92006-10-02 02:17:00 -0700106 * @pool: pool to destroy
Dean Nelsona58cbd72006-10-02 02:17:01 -0700107 *
108 * Destroy the specified special memory pool. Verifies that there are no
109 * outstanding allocations.
Steve Wise322acc92006-10-02 02:17:00 -0700110 */
111void gen_pool_destroy(struct gen_pool *pool)
112{
113 struct list_head *_chunk, *_next_chunk;
114 struct gen_pool_chunk *chunk;
115 int order = pool->min_alloc_order;
116 int bit, end_bit;
117
118
Steve Wise322acc92006-10-02 02:17:00 -0700119 list_for_each_safe(_chunk, _next_chunk, &pool->chunks) {
120 chunk = list_entry(_chunk, struct gen_pool_chunk, next_chunk);
121 list_del(&chunk->next_chunk);
122
123 end_bit = (chunk->end_addr - chunk->start_addr) >> order;
124 bit = find_next_bit(chunk->bits, end_bit, 0);
125 BUG_ON(bit < end_bit);
126
127 kfree(chunk);
128 }
129 kfree(pool);
130 return;
131}
132EXPORT_SYMBOL(gen_pool_destroy);
133
Dean Nelsona58cbd72006-10-02 02:17:01 -0700134/**
135 * gen_pool_alloc - allocate special memory from the pool
Dean Nelson929f9722006-06-23 02:03:21 -0700136 * @pool: pool to allocate from
137 * @size: number of bytes to allocate from the pool
Dean Nelsona58cbd72006-10-02 02:17:01 -0700138 *
139 * Allocate the requested number of bytes from the specified pool.
140 * Uses a first-fit algorithm.
Dean Nelson929f9722006-06-23 02:03:21 -0700141 */
142unsigned long gen_pool_alloc(struct gen_pool *pool, size_t size)
143{
144 struct list_head *_chunk;
145 struct gen_pool_chunk *chunk;
146 unsigned long addr, flags;
147 int order = pool->min_alloc_order;
Akinobu Mita243797f2009-12-15 16:48:31 -0800148 int nbits, start_bit, end_bit;
Dean Nelson929f9722006-06-23 02:03:21 -0700149
150 if (size == 0)
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700151 return 0;
152
Dean Nelson929f9722006-06-23 02:03:21 -0700153 nbits = (size + (1UL << order) - 1) >> order;
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700154
Dean Nelson929f9722006-06-23 02:03:21 -0700155 read_lock(&pool->lock);
156 list_for_each(_chunk, &pool->chunks) {
157 chunk = list_entry(_chunk, struct gen_pool_chunk, next_chunk);
158
159 end_bit = (chunk->end_addr - chunk->start_addr) >> order;
Dean Nelson929f9722006-06-23 02:03:21 -0700160
161 spin_lock_irqsave(&chunk->lock, flags);
Akinobu Mita243797f2009-12-15 16:48:31 -0800162 start_bit = bitmap_find_next_zero_area(chunk->bits, end_bit, 0,
163 nbits, 0);
164 if (start_bit >= end_bit) {
Dean Nelson929f9722006-06-23 02:03:21 -0700165 spin_unlock_irqrestore(&chunk->lock, flags);
Akinobu Mita243797f2009-12-15 16:48:31 -0800166 continue;
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700167 }
Akinobu Mita243797f2009-12-15 16:48:31 -0800168
169 addr = chunk->start_addr + ((unsigned long)start_bit << order);
170
171 bitmap_set(chunk->bits, start_bit, nbits);
Dean Nelson929f9722006-06-23 02:03:21 -0700172 spin_unlock_irqrestore(&chunk->lock, flags);
Akinobu Mita243797f2009-12-15 16:48:31 -0800173 read_unlock(&pool->lock);
174 return addr;
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700175 }
Dean Nelson929f9722006-06-23 02:03:21 -0700176 read_unlock(&pool->lock);
177 return 0;
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700178}
179EXPORT_SYMBOL(gen_pool_alloc);
180
Dean Nelsona58cbd72006-10-02 02:17:01 -0700181/**
182 * gen_pool_free - free allocated special memory back to the pool
Dean Nelson929f9722006-06-23 02:03:21 -0700183 * @pool: pool to free to
184 * @addr: starting address of memory to free back to pool
185 * @size: size in bytes of memory to free
Dean Nelsona58cbd72006-10-02 02:17:01 -0700186 *
187 * Free previously allocated special memory back to the specified pool.
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700188 */
Dean Nelson929f9722006-06-23 02:03:21 -0700189void gen_pool_free(struct gen_pool *pool, unsigned long addr, size_t size)
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700190{
Dean Nelson929f9722006-06-23 02:03:21 -0700191 struct list_head *_chunk;
192 struct gen_pool_chunk *chunk;
193 unsigned long flags;
194 int order = pool->min_alloc_order;
195 int bit, nbits;
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700196
Dean Nelson929f9722006-06-23 02:03:21 -0700197 nbits = (size + (1UL << order) - 1) >> order;
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700198
Dean Nelson929f9722006-06-23 02:03:21 -0700199 read_lock(&pool->lock);
200 list_for_each(_chunk, &pool->chunks) {
201 chunk = list_entry(_chunk, struct gen_pool_chunk, next_chunk);
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700202
Dean Nelson929f9722006-06-23 02:03:21 -0700203 if (addr >= chunk->start_addr && addr < chunk->end_addr) {
204 BUG_ON(addr + size > chunk->end_addr);
205 spin_lock_irqsave(&chunk->lock, flags);
206 bit = (addr - chunk->start_addr) >> order;
207 while (nbits--)
Andrew Morton96c62d52007-02-20 13:58:12 -0800208 __clear_bit(bit++, chunk->bits);
Dean Nelson929f9722006-06-23 02:03:21 -0700209 spin_unlock_irqrestore(&chunk->lock, flags);
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700210 break;
211 }
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700212 }
Dean Nelson929f9722006-06-23 02:03:21 -0700213 BUG_ON(nbits > 0);
214 read_unlock(&pool->lock);
Jes Sorensenf14f75b2005-06-21 17:15:02 -0700215}
216EXPORT_SYMBOL(gen_pool_free);