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