2fb283223314ea8fc98ac8f3a4ac952bdc8d0910
[linux-3.10.git] / lib / genalloc.c
1 /*
2  * Basic general purpose allocator for managing special purpose
3  * memory, for example, memory that is not managed by the regular
4  * kmalloc/kfree interface.  Uses for this includes on-device special
5  * memory, uncached memory etc.
6  *
7  * It is safe to use the allocator in NMI handlers and other special
8  * unblockable contexts that could otherwise deadlock on locks.  This
9  * is implemented by using atomic operations and retries on any
10  * conflicts.  The disadvantage is that there may be livelocks in
11  * extreme cases.  For better scalability, one allocator can be used
12  * for each CPU.
13  *
14  * The lockless operation only works if there is enough memory
15  * available.  If new memory is added to the pool a lock has to be
16  * still taken.  So any user relying on locklessness has to ensure
17  * that sufficient memory is preallocated.
18  *
19  * The basic atomic operation of this allocator is cmpxchg on long.
20  * On architectures that don't have NMI-safe cmpxchg implementation,
21  * the allocator can NOT be used in NMI handler.  So code uses the
22  * allocator in NMI handler should depend on
23  * CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG.
24  *
25  * Copyright 2005 (C) Jes Sorensen <jes@trained-monkey.org>
26  *
27  * This source code is licensed under the GNU General Public License,
28  * Version 2.  See the file COPYING for more details.
29  */
30
31 #include <linux/slab.h>
32 #include <linux/export.h>
33 #include <linux/bitmap.h>
34 #include <linux/rculist.h>
35 #include <linux/interrupt.h>
36 #include <linux/genalloc.h>
37 #include <linux/of_address.h>
38 #include <linux/of_device.h>
39
40 static inline size_t chunk_size(const struct gen_pool_chunk *chunk)
41 {
42         return chunk->end_addr - chunk->start_addr + 1;
43 }
44
45 static int set_bits_ll(unsigned long *addr, unsigned long mask_to_set)
46 {
47         unsigned long val, nval;
48
49         nval = *addr;
50         do {
51                 val = nval;
52                 if (val & mask_to_set)
53                         return -EBUSY;
54                 cpu_relax();
55         } while ((nval = cmpxchg(addr, val, val | mask_to_set)) != val);
56
57         return 0;
58 }
59
60 static int clear_bits_ll(unsigned long *addr, unsigned long mask_to_clear)
61 {
62         unsigned long val, nval;
63
64         nval = *addr;
65         do {
66                 val = nval;
67                 if ((val & mask_to_clear) != mask_to_clear)
68                         return -EBUSY;
69                 cpu_relax();
70         } while ((nval = cmpxchg(addr, val, val & ~mask_to_clear)) != val);
71
72         return 0;
73 }
74
75 /*
76  * bitmap_set_ll - set the specified number of bits at the specified position
77  * @map: pointer to a bitmap
78  * @start: a bit position in @map
79  * @nr: number of bits to set
80  *
81  * Set @nr bits start from @start in @map lock-lessly. Several users
82  * can set/clear the same bitmap simultaneously without lock. If two
83  * users set the same bit, one user will return remain bits, otherwise
84  * return 0.
85  */
86 static int bitmap_set_ll(unsigned long *map, int start, int nr)
87 {
88         unsigned long *p = map + BIT_WORD(start);
89         const int size = start + nr;
90         int bits_to_set = BITS_PER_LONG - (start % BITS_PER_LONG);
91         unsigned long mask_to_set = BITMAP_FIRST_WORD_MASK(start);
92
93         while (nr - bits_to_set >= 0) {
94                 if (set_bits_ll(p, mask_to_set))
95                         return nr;
96                 nr -= bits_to_set;
97                 bits_to_set = BITS_PER_LONG;
98                 mask_to_set = ~0UL;
99                 p++;
100         }
101         if (nr) {
102                 mask_to_set &= BITMAP_LAST_WORD_MASK(size);
103                 if (set_bits_ll(p, mask_to_set))
104                         return nr;
105         }
106
107         return 0;
108 }
109
110 /*
111  * bitmap_clear_ll - clear the specified number of bits at the specified position
112  * @map: pointer to a bitmap
113  * @start: a bit position in @map
114  * @nr: number of bits to set
115  *
116  * Clear @nr bits start from @start in @map lock-lessly. Several users
117  * can set/clear the same bitmap simultaneously without lock. If two
118  * users clear the same bit, one user will return remain bits,
119  * otherwise return 0.
120  */
121 static int bitmap_clear_ll(unsigned long *map, int start, int nr)
122 {
123         unsigned long *p = map + BIT_WORD(start);
124         const int size = start + nr;
125         int bits_to_clear = BITS_PER_LONG - (start % BITS_PER_LONG);
126         unsigned long mask_to_clear = BITMAP_FIRST_WORD_MASK(start);
127
128         while (nr - bits_to_clear >= 0) {
129                 if (clear_bits_ll(p, mask_to_clear))
130                         return nr;
131                 nr -= bits_to_clear;
132                 bits_to_clear = BITS_PER_LONG;
133                 mask_to_clear = ~0UL;
134                 p++;
135         }
136         if (nr) {
137                 mask_to_clear &= BITMAP_LAST_WORD_MASK(size);
138                 if (clear_bits_ll(p, mask_to_clear))
139                         return nr;
140         }
141
142         return 0;
143 }
144
145 /**
146  * gen_pool_create - create a new special memory pool
147  * @min_alloc_order: log base 2 of number of bytes each bitmap bit represents
148  * @nid: node id of the node the pool structure should be allocated on, or -1
149  *
150  * Create a new special memory pool that can be used to manage special purpose
151  * memory not managed by the regular kmalloc/kfree interface.
152  */
153 struct gen_pool *gen_pool_create(int min_alloc_order, int nid)
154 {
155         struct gen_pool *pool;
156
157         pool = kmalloc_node(sizeof(struct gen_pool), GFP_KERNEL, nid);
158         if (pool != NULL) {
159                 spin_lock_init(&pool->lock);
160                 INIT_LIST_HEAD(&pool->chunks);
161                 pool->min_alloc_order = min_alloc_order;
162                 pool->algo = gen_pool_first_fit;
163                 pool->data = NULL;
164         }
165         return pool;
166 }
167 EXPORT_SYMBOL(gen_pool_create);
168
169 /**
170  * gen_pool_add_virt - add a new chunk of special memory to the pool
171  * @pool: pool to add new memory chunk to
172  * @virt: virtual starting address of memory chunk to add to pool
173  * @phys: physical starting address of memory chunk to add to pool
174  * @size: size in bytes of the memory chunk to add to pool
175  * @nid: node id of the node the chunk structure and bitmap should be
176  *       allocated on, or -1
177  *
178  * Add a new chunk of special memory to the specified pool.
179  *
180  * Returns 0 on success or a -ve errno on failure.
181  */
182 int gen_pool_add_virt(struct gen_pool *pool, unsigned long virt, phys_addr_t phys,
183                  size_t size, int nid)
184 {
185         struct gen_pool_chunk *chunk;
186         int nbits = size >> pool->min_alloc_order;
187         int nbytes = sizeof(struct gen_pool_chunk) +
188                                 BITS_TO_LONGS(nbits) * sizeof(long);
189
190         chunk = kmalloc_node(nbytes, GFP_KERNEL | __GFP_ZERO, nid);
191         if (unlikely(chunk == NULL))
192                 return -ENOMEM;
193
194         chunk->phys_addr = phys;
195         chunk->start_addr = virt;
196         chunk->end_addr = virt + size - 1;
197         atomic_set(&chunk->avail, size);
198
199         spin_lock(&pool->lock);
200         list_add_rcu(&chunk->next_chunk, &pool->chunks);
201         spin_unlock(&pool->lock);
202
203         return 0;
204 }
205 EXPORT_SYMBOL(gen_pool_add_virt);
206
207 /**
208  * gen_pool_virt_to_phys - return the physical address of memory
209  * @pool: pool to allocate from
210  * @addr: starting address of memory
211  *
212  * Returns the physical address on success, or -1 on error.
213  */
214 phys_addr_t gen_pool_virt_to_phys(struct gen_pool *pool, unsigned long addr)
215 {
216         struct gen_pool_chunk *chunk;
217         phys_addr_t paddr = -1;
218
219         rcu_read_lock();
220         list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk) {
221                 if (addr >= chunk->start_addr && addr <= chunk->end_addr) {
222                         paddr = chunk->phys_addr + (addr - chunk->start_addr);
223                         break;
224                 }
225         }
226         rcu_read_unlock();
227
228         return paddr;
229 }
230 EXPORT_SYMBOL(gen_pool_virt_to_phys);
231
232 /**
233  * gen_pool_destroy - destroy a special memory pool
234  * @pool: pool to destroy
235  *
236  * Destroy the specified special memory pool. Verifies that there are no
237  * outstanding allocations.
238  */
239 void gen_pool_destroy(struct gen_pool *pool)
240 {
241         struct list_head *_chunk, *_next_chunk;
242         struct gen_pool_chunk *chunk;
243         int order = pool->min_alloc_order;
244         int bit, end_bit;
245
246         list_for_each_safe(_chunk, _next_chunk, &pool->chunks) {
247                 chunk = list_entry(_chunk, struct gen_pool_chunk, next_chunk);
248                 list_del(&chunk->next_chunk);
249
250                 end_bit = chunk_size(chunk) >> order;
251                 bit = find_next_bit(chunk->bits, end_bit, 0);
252                 BUG_ON(bit < end_bit);
253
254                 kfree(chunk);
255         }
256         kfree(pool);
257         return;
258 }
259 EXPORT_SYMBOL(gen_pool_destroy);
260
261 /**
262  * gen_pool_alloc_addr - allocate special memory from the pool
263  * @pool: pool to allocate from
264  * @size: number of bytes to allocate from the pool
265  * @alloc_addr: if non-zero, allocate starting at alloc_addr.
266  *
267  * Allocate the requested number of bytes from the specified pool.
268  * Uses the pool allocation function (with first-fit algorithm by default).
269  * Can not be used in NMI handler on architectures without
270  * NMI-safe cmpxchg implementation.
271  */
272 unsigned long gen_pool_alloc_addr(struct gen_pool *pool, size_t size,
273                                     unsigned long alloc_addr)
274 {
275         struct gen_pool_chunk *chunk;
276         unsigned long addr = 0;
277         int order = pool->min_alloc_order;
278         int nbits, start_bit = 0, end_bit, remain;
279         int alloc_bit_needed = 0;
280
281 #ifndef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
282         BUG_ON(in_nmi());
283 #endif
284
285         if (size == 0)
286                 return 0;
287
288         if (alloc_addr & (1 << order) - 1)
289                 return 0;
290
291         nbits = (size + (1UL << order) - 1) >> order;
292         rcu_read_lock();
293         list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk) {
294                 if (size > atomic_read(&chunk->avail))
295                         continue;
296
297                 end_bit = chunk_size(chunk) >> order;
298                 if (alloc_addr) {
299                         if (alloc_addr < chunk->start_addr ||
300                                 alloc_addr >= chunk->end_addr)
301                                 continue;
302                         if (alloc_addr + size > chunk->end_addr)
303                                 return 0;
304                         alloc_bit_needed = start_bit =
305                                 (alloc_addr - chunk->start_addr) >> order;
306                 }
307 retry:
308                 start_bit = pool->algo(chunk->bits, end_bit, start_bit, nbits,
309                                 pool->data);
310                 if (alloc_addr && alloc_bit_needed != start_bit)
311                         return 0;
312                 if (start_bit >= end_bit)
313                         continue;
314                 remain = bitmap_set_ll(chunk->bits, start_bit, nbits);
315                 if (remain) {
316                         remain = bitmap_clear_ll(chunk->bits, start_bit,
317                                                  nbits - remain);
318                         BUG_ON(remain);
319                         goto retry;
320                 }
321
322                 addr = chunk->start_addr + ((unsigned long)start_bit << order);
323                 size = nbits << order;
324                 atomic_sub(size, &chunk->avail);
325                 break;
326         }
327         rcu_read_unlock();
328         return addr;
329 }
330 EXPORT_SYMBOL(gen_pool_alloc_addr);
331
332 /**
333  * gen_pool_free - free allocated special memory back to the pool
334  * @pool: pool to free to
335  * @addr: starting address of memory to free back to pool
336  * @size: size in bytes of memory to free
337  *
338  * Free previously allocated special memory back to the specified
339  * pool.  Can not be used in NMI handler on architectures without
340  * NMI-safe cmpxchg implementation.
341  */
342 void gen_pool_free(struct gen_pool *pool, unsigned long addr, size_t size)
343 {
344         struct gen_pool_chunk *chunk;
345         int order = pool->min_alloc_order;
346         int start_bit, nbits, remain;
347
348 #ifndef CONFIG_ARCH_HAVE_NMI_SAFE_CMPXCHG
349         BUG_ON(in_nmi());
350 #endif
351
352         nbits = (size + (1UL << order) - 1) >> order;
353         rcu_read_lock();
354         list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk) {
355                 if (addr >= chunk->start_addr && addr <= chunk->end_addr) {
356                         BUG_ON(addr + size - 1 > chunk->end_addr);
357                         start_bit = (addr - chunk->start_addr) >> order;
358                         remain = bitmap_clear_ll(chunk->bits, start_bit, nbits);
359                         BUG_ON(remain);
360                         size = nbits << order;
361                         atomic_add(size, &chunk->avail);
362                         rcu_read_unlock();
363                         return;
364                 }
365         }
366         rcu_read_unlock();
367         BUG();
368 }
369 EXPORT_SYMBOL(gen_pool_free);
370
371 /**
372  * gen_pool_for_each_chunk - call func for every chunk of generic memory pool
373  * @pool:       the generic memory pool
374  * @func:       func to call
375  * @data:       additional data used by @func
376  *
377  * Call @func for every chunk of generic memory pool.  The @func is
378  * called with rcu_read_lock held.
379  */
380 void gen_pool_for_each_chunk(struct gen_pool *pool,
381         void (*func)(struct gen_pool *pool, struct gen_pool_chunk *chunk, void *data),
382         void *data)
383 {
384         struct gen_pool_chunk *chunk;
385
386         rcu_read_lock();
387         list_for_each_entry_rcu(chunk, &(pool)->chunks, next_chunk)
388                 func(pool, chunk, data);
389         rcu_read_unlock();
390 }
391 EXPORT_SYMBOL(gen_pool_for_each_chunk);
392
393 /**
394  * gen_pool_avail - get available free space of the pool
395  * @pool: pool to get available free space
396  *
397  * Return available free space of the specified pool.
398  */
399 size_t gen_pool_avail(struct gen_pool *pool)
400 {
401         struct gen_pool_chunk *chunk;
402         size_t avail = 0;
403
404         rcu_read_lock();
405         list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk)
406                 avail += atomic_read(&chunk->avail);
407         rcu_read_unlock();
408         return avail;
409 }
410 EXPORT_SYMBOL_GPL(gen_pool_avail);
411
412 /**
413  * gen_pool_size - get size in bytes of memory managed by the pool
414  * @pool: pool to get size
415  *
416  * Return size in bytes of memory managed by the pool.
417  */
418 size_t gen_pool_size(struct gen_pool *pool)
419 {
420         struct gen_pool_chunk *chunk;
421         size_t size = 0;
422
423         rcu_read_lock();
424         list_for_each_entry_rcu(chunk, &pool->chunks, next_chunk)
425                 size += chunk_size(chunk);
426         rcu_read_unlock();
427         return size;
428 }
429 EXPORT_SYMBOL_GPL(gen_pool_size);
430
431 /**
432  * gen_pool_set_algo - set the allocation algorithm
433  * @pool: pool to change allocation algorithm
434  * @algo: custom algorithm function
435  * @data: additional data used by @algo
436  *
437  * Call @algo for each memory allocation in the pool.
438  * If @algo is NULL use gen_pool_first_fit as default
439  * memory allocation function.
440  */
441 void gen_pool_set_algo(struct gen_pool *pool, genpool_algo_t algo, void *data)
442 {
443         rcu_read_lock();
444
445         pool->algo = algo;
446         if (!pool->algo)
447                 pool->algo = gen_pool_first_fit;
448
449         pool->data = data;
450
451         rcu_read_unlock();
452 }
453 EXPORT_SYMBOL(gen_pool_set_algo);
454
455 /**
456  * gen_pool_first_fit - find the first available region
457  * of memory matching the size requirement (no alignment constraint)
458  * @map: The address to base the search on
459  * @size: The bitmap size in bits
460  * @start: The bitnumber to start searching at
461  * @nr: The number of zeroed bits we're looking for
462  * @data: additional data - unused
463  */
464 unsigned long gen_pool_first_fit(unsigned long *map, unsigned long size,
465                 unsigned long start, unsigned int nr, void *data)
466 {
467         return bitmap_find_next_zero_area(map, size, start, nr, 0);
468 }
469 EXPORT_SYMBOL(gen_pool_first_fit);
470
471 /**
472  * gen_pool_best_fit - find the best fitting region of memory
473  * macthing the size requirement (no alignment constraint)
474  * @map: The address to base the search on
475  * @size: The bitmap size in bits
476  * @start: The bitnumber to start searching at
477  * @nr: The number of zeroed bits we're looking for
478  * @data: additional data - unused
479  *
480  * Iterate over the bitmap to find the smallest free region
481  * which we can allocate the memory.
482  */
483 unsigned long gen_pool_best_fit(unsigned long *map, unsigned long size,
484                 unsigned long start, unsigned int nr, void *data)
485 {
486         unsigned long start_bit = size;
487         unsigned long len = size + 1;
488         unsigned long index;
489
490         index = bitmap_find_next_zero_area(map, size, start, nr, 0);
491
492         while (index < size) {
493                 int next_bit = find_next_bit(map, size, index + nr);
494                 if ((next_bit - index) < len) {
495                         len = next_bit - index;
496                         start_bit = index;
497                         if (len == nr)
498                                 return start_bit;
499                 }
500                 index = bitmap_find_next_zero_area(map, size,
501                                                    next_bit + 1, nr, 0);
502         }
503
504         return start_bit;
505 }
506 EXPORT_SYMBOL(gen_pool_best_fit);
507
508 static void devm_gen_pool_release(struct device *dev, void *res)
509 {
510         gen_pool_destroy(*(struct gen_pool **)res);
511 }
512
513 /**
514  * devm_gen_pool_create - managed gen_pool_create
515  * @dev: device that provides the gen_pool
516  * @min_alloc_order: log base 2 of number of bytes each bitmap bit represents
517  * @nid: node id of the node the pool structure should be allocated on, or -1
518  *
519  * Create a new special memory pool that can be used to manage special purpose
520  * memory not managed by the regular kmalloc/kfree interface. The pool will be
521  * automatically destroyed by the device management code.
522  */
523 struct gen_pool *devm_gen_pool_create(struct device *dev, int min_alloc_order,
524                 int nid)
525 {
526         struct gen_pool **ptr, *pool;
527
528         ptr = devres_alloc(devm_gen_pool_release, sizeof(*ptr), GFP_KERNEL);
529
530         pool = gen_pool_create(min_alloc_order, nid);
531         if (pool) {
532                 *ptr = pool;
533                 devres_add(dev, ptr);
534         } else {
535                 devres_free(ptr);
536         }
537
538         return pool;
539 }
540
541 /**
542  * dev_get_gen_pool - Obtain the gen_pool (if any) for a device
543  * @dev: device to retrieve the gen_pool from
544  * @name: Optional name for the gen_pool, usually NULL
545  *
546  * Returns the gen_pool for the device if one is present, or NULL.
547  */
548 struct gen_pool *dev_get_gen_pool(struct device *dev)
549 {
550         struct gen_pool **p = devres_find(dev, devm_gen_pool_release, NULL,
551                                         NULL);
552
553         if (!p)
554                 return NULL;
555         return *p;
556 }
557 EXPORT_SYMBOL_GPL(dev_get_gen_pool);
558
559 #ifdef CONFIG_OF
560 /**
561  * of_get_named_gen_pool - find a pool by phandle property
562  * @np: device node
563  * @propname: property name containing phandle(s)
564  * @index: index into the phandle array
565  *
566  * Returns the pool that contains the chunk starting at the physical
567  * address of the device tree node pointed at by the phandle property,
568  * or NULL if not found.
569  */
570 struct gen_pool *of_get_named_gen_pool(struct device_node *np,
571         const char *propname, int index)
572 {
573         struct platform_device *pdev;
574         struct device_node *np_pool;
575
576         np_pool = of_parse_phandle(np, propname, index);
577         if (!np_pool)
578                 return NULL;
579         pdev = of_find_device_by_node(np_pool);
580         if (!pdev)
581                 return NULL;
582         return dev_get_gen_pool(&pdev->dev);
583 }
584 EXPORT_SYMBOL_GPL(of_get_named_gen_pool);
585 #endif /* CONFIG_OF */