Linux 4.14.66
[platform/kernel/linux-rpi.git] / mm / percpu.c
1 /*
2  * mm/percpu.c - percpu memory allocator
3  *
4  * Copyright (C) 2009           SUSE Linux Products GmbH
5  * Copyright (C) 2009           Tejun Heo <tj@kernel.org>
6  *
7  * Copyright (C) 2017           Facebook Inc.
8  * Copyright (C) 2017           Dennis Zhou <dennisszhou@gmail.com>
9  *
10  * This file is released under the GPLv2 license.
11  *
12  * The percpu allocator handles both static and dynamic areas.  Percpu
13  * areas are allocated in chunks which are divided into units.  There is
14  * a 1-to-1 mapping for units to possible cpus.  These units are grouped
15  * based on NUMA properties of the machine.
16  *
17  *  c0                           c1                         c2
18  *  -------------------          -------------------        ------------
19  * | u0 | u1 | u2 | u3 |        | u0 | u1 | u2 | u3 |      | u0 | u1 | u
20  *  -------------------  ......  -------------------  ....  ------------
21  *
22  * Allocation is done by offsets into a unit's address space.  Ie., an
23  * area of 512 bytes at 6k in c1 occupies 512 bytes at 6k in c1:u0,
24  * c1:u1, c1:u2, etc.  On NUMA machines, the mapping may be non-linear
25  * and even sparse.  Access is handled by configuring percpu base
26  * registers according to the cpu to unit mappings and offsetting the
27  * base address using pcpu_unit_size.
28  *
29  * There is special consideration for the first chunk which must handle
30  * the static percpu variables in the kernel image as allocation services
31  * are not online yet.  In short, the first chunk is structured like so:
32  *
33  *                  <Static | [Reserved] | Dynamic>
34  *
35  * The static data is copied from the original section managed by the
36  * linker.  The reserved section, if non-zero, primarily manages static
37  * percpu variables from kernel modules.  Finally, the dynamic section
38  * takes care of normal allocations.
39  *
40  * The allocator organizes chunks into lists according to free size and
41  * tries to allocate from the fullest chunk first.  Each chunk is managed
42  * by a bitmap with metadata blocks.  The allocation map is updated on
43  * every allocation and free to reflect the current state while the boundary
44  * map is only updated on allocation.  Each metadata block contains
45  * information to help mitigate the need to iterate over large portions
46  * of the bitmap.  The reverse mapping from page to chunk is stored in
47  * the page's index.  Lastly, units are lazily backed and grow in unison.
48  *
49  * There is a unique conversion that goes on here between bytes and bits.
50  * Each bit represents a fragment of size PCPU_MIN_ALLOC_SIZE.  The chunk
51  * tracks the number of pages it is responsible for in nr_pages.  Helper
52  * functions are used to convert from between the bytes, bits, and blocks.
53  * All hints are managed in bits unless explicitly stated.
54  *
55  * To use this allocator, arch code should do the following:
56  *
57  * - define __addr_to_pcpu_ptr() and __pcpu_ptr_to_addr() to translate
58  *   regular address to percpu pointer and back if they need to be
59  *   different from the default
60  *
61  * - use pcpu_setup_first_chunk() during percpu area initialization to
62  *   setup the first chunk containing the kernel static percpu area
63  */
64
65 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
66
67 #include <linux/bitmap.h>
68 #include <linux/bootmem.h>
69 #include <linux/err.h>
70 #include <linux/lcm.h>
71 #include <linux/list.h>
72 #include <linux/log2.h>
73 #include <linux/mm.h>
74 #include <linux/module.h>
75 #include <linux/mutex.h>
76 #include <linux/percpu.h>
77 #include <linux/pfn.h>
78 #include <linux/slab.h>
79 #include <linux/spinlock.h>
80 #include <linux/vmalloc.h>
81 #include <linux/workqueue.h>
82 #include <linux/kmemleak.h>
83 #include <linux/sched.h>
84
85 #include <asm/cacheflush.h>
86 #include <asm/sections.h>
87 #include <asm/tlbflush.h>
88 #include <asm/io.h>
89
90 #define CREATE_TRACE_POINTS
91 #include <trace/events/percpu.h>
92
93 #include "percpu-internal.h"
94
95 /* the slots are sorted by free bytes left, 1-31 bytes share the same slot */
96 #define PCPU_SLOT_BASE_SHIFT            5
97
98 #define PCPU_EMPTY_POP_PAGES_LOW        2
99 #define PCPU_EMPTY_POP_PAGES_HIGH       4
100
101 #ifdef CONFIG_SMP
102 /* default addr <-> pcpu_ptr mapping, override in asm/percpu.h if necessary */
103 #ifndef __addr_to_pcpu_ptr
104 #define __addr_to_pcpu_ptr(addr)                                        \
105         (void __percpu *)((unsigned long)(addr) -                       \
106                           (unsigned long)pcpu_base_addr +               \
107                           (unsigned long)__per_cpu_start)
108 #endif
109 #ifndef __pcpu_ptr_to_addr
110 #define __pcpu_ptr_to_addr(ptr)                                         \
111         (void __force *)((unsigned long)(ptr) +                         \
112                          (unsigned long)pcpu_base_addr -                \
113                          (unsigned long)__per_cpu_start)
114 #endif
115 #else   /* CONFIG_SMP */
116 /* on UP, it's always identity mapped */
117 #define __addr_to_pcpu_ptr(addr)        (void __percpu *)(addr)
118 #define __pcpu_ptr_to_addr(ptr)         (void __force *)(ptr)
119 #endif  /* CONFIG_SMP */
120
121 static int pcpu_unit_pages __ro_after_init;
122 static int pcpu_unit_size __ro_after_init;
123 static int pcpu_nr_units __ro_after_init;
124 static int pcpu_atom_size __ro_after_init;
125 int pcpu_nr_slots __ro_after_init;
126 static size_t pcpu_chunk_struct_size __ro_after_init;
127
128 /* cpus with the lowest and highest unit addresses */
129 static unsigned int pcpu_low_unit_cpu __ro_after_init;
130 static unsigned int pcpu_high_unit_cpu __ro_after_init;
131
132 /* the address of the first chunk which starts with the kernel static area */
133 void *pcpu_base_addr __ro_after_init;
134 EXPORT_SYMBOL_GPL(pcpu_base_addr);
135
136 static const int *pcpu_unit_map __ro_after_init;                /* cpu -> unit */
137 const unsigned long *pcpu_unit_offsets __ro_after_init; /* cpu -> unit offset */
138
139 /* group information, used for vm allocation */
140 static int pcpu_nr_groups __ro_after_init;
141 static const unsigned long *pcpu_group_offsets __ro_after_init;
142 static const size_t *pcpu_group_sizes __ro_after_init;
143
144 /*
145  * The first chunk which always exists.  Note that unlike other
146  * chunks, this one can be allocated and mapped in several different
147  * ways and thus often doesn't live in the vmalloc area.
148  */
149 struct pcpu_chunk *pcpu_first_chunk __ro_after_init;
150
151 /*
152  * Optional reserved chunk.  This chunk reserves part of the first
153  * chunk and serves it for reserved allocations.  When the reserved
154  * region doesn't exist, the following variable is NULL.
155  */
156 struct pcpu_chunk *pcpu_reserved_chunk __ro_after_init;
157
158 DEFINE_SPINLOCK(pcpu_lock);     /* all internal data structures */
159 static DEFINE_MUTEX(pcpu_alloc_mutex);  /* chunk create/destroy, [de]pop, map ext */
160
161 struct list_head *pcpu_slot __ro_after_init; /* chunk list slots */
162
163 /* chunks which need their map areas extended, protected by pcpu_lock */
164 static LIST_HEAD(pcpu_map_extend_chunks);
165
166 /*
167  * The number of empty populated pages, protected by pcpu_lock.  The
168  * reserved chunk doesn't contribute to the count.
169  */
170 int pcpu_nr_empty_pop_pages;
171
172 /*
173  * Balance work is used to populate or destroy chunks asynchronously.  We
174  * try to keep the number of populated free pages between
175  * PCPU_EMPTY_POP_PAGES_LOW and HIGH for atomic allocations and at most one
176  * empty chunk.
177  */
178 static void pcpu_balance_workfn(struct work_struct *work);
179 static DECLARE_WORK(pcpu_balance_work, pcpu_balance_workfn);
180 static bool pcpu_async_enabled __read_mostly;
181 static bool pcpu_atomic_alloc_failed;
182
183 static void pcpu_schedule_balance_work(void)
184 {
185         if (pcpu_async_enabled)
186                 schedule_work(&pcpu_balance_work);
187 }
188
189 /**
190  * pcpu_addr_in_chunk - check if the address is served from this chunk
191  * @chunk: chunk of interest
192  * @addr: percpu address
193  *
194  * RETURNS:
195  * True if the address is served from this chunk.
196  */
197 static bool pcpu_addr_in_chunk(struct pcpu_chunk *chunk, void *addr)
198 {
199         void *start_addr, *end_addr;
200
201         if (!chunk)
202                 return false;
203
204         start_addr = chunk->base_addr + chunk->start_offset;
205         end_addr = chunk->base_addr + chunk->nr_pages * PAGE_SIZE -
206                    chunk->end_offset;
207
208         return addr >= start_addr && addr < end_addr;
209 }
210
211 static int __pcpu_size_to_slot(int size)
212 {
213         int highbit = fls(size);        /* size is in bytes */
214         return max(highbit - PCPU_SLOT_BASE_SHIFT + 2, 1);
215 }
216
217 static int pcpu_size_to_slot(int size)
218 {
219         if (size == pcpu_unit_size)
220                 return pcpu_nr_slots - 1;
221         return __pcpu_size_to_slot(size);
222 }
223
224 static int pcpu_chunk_slot(const struct pcpu_chunk *chunk)
225 {
226         if (chunk->free_bytes < PCPU_MIN_ALLOC_SIZE || chunk->contig_bits == 0)
227                 return 0;
228
229         return pcpu_size_to_slot(chunk->free_bytes);
230 }
231
232 /* set the pointer to a chunk in a page struct */
233 static void pcpu_set_page_chunk(struct page *page, struct pcpu_chunk *pcpu)
234 {
235         page->index = (unsigned long)pcpu;
236 }
237
238 /* obtain pointer to a chunk from a page struct */
239 static struct pcpu_chunk *pcpu_get_page_chunk(struct page *page)
240 {
241         return (struct pcpu_chunk *)page->index;
242 }
243
244 static int __maybe_unused pcpu_page_idx(unsigned int cpu, int page_idx)
245 {
246         return pcpu_unit_map[cpu] * pcpu_unit_pages + page_idx;
247 }
248
249 static unsigned long pcpu_unit_page_offset(unsigned int cpu, int page_idx)
250 {
251         return pcpu_unit_offsets[cpu] + (page_idx << PAGE_SHIFT);
252 }
253
254 static unsigned long pcpu_chunk_addr(struct pcpu_chunk *chunk,
255                                      unsigned int cpu, int page_idx)
256 {
257         return (unsigned long)chunk->base_addr +
258                pcpu_unit_page_offset(cpu, page_idx);
259 }
260
261 static void pcpu_next_unpop(unsigned long *bitmap, int *rs, int *re, int end)
262 {
263         *rs = find_next_zero_bit(bitmap, end, *rs);
264         *re = find_next_bit(bitmap, end, *rs + 1);
265 }
266
267 static void pcpu_next_pop(unsigned long *bitmap, int *rs, int *re, int end)
268 {
269         *rs = find_next_bit(bitmap, end, *rs);
270         *re = find_next_zero_bit(bitmap, end, *rs + 1);
271 }
272
273 /*
274  * Bitmap region iterators.  Iterates over the bitmap between
275  * [@start, @end) in @chunk.  @rs and @re should be integer variables
276  * and will be set to start and end index of the current free region.
277  */
278 #define pcpu_for_each_unpop_region(bitmap, rs, re, start, end)               \
279         for ((rs) = (start), pcpu_next_unpop((bitmap), &(rs), &(re), (end)); \
280              (rs) < (re);                                                    \
281              (rs) = (re) + 1, pcpu_next_unpop((bitmap), &(rs), &(re), (end)))
282
283 #define pcpu_for_each_pop_region(bitmap, rs, re, start, end)                 \
284         for ((rs) = (start), pcpu_next_pop((bitmap), &(rs), &(re), (end));   \
285              (rs) < (re);                                                    \
286              (rs) = (re) + 1, pcpu_next_pop((bitmap), &(rs), &(re), (end)))
287
288 /*
289  * The following are helper functions to help access bitmaps and convert
290  * between bitmap offsets to address offsets.
291  */
292 static unsigned long *pcpu_index_alloc_map(struct pcpu_chunk *chunk, int index)
293 {
294         return chunk->alloc_map +
295                (index * PCPU_BITMAP_BLOCK_BITS / BITS_PER_LONG);
296 }
297
298 static unsigned long pcpu_off_to_block_index(int off)
299 {
300         return off / PCPU_BITMAP_BLOCK_BITS;
301 }
302
303 static unsigned long pcpu_off_to_block_off(int off)
304 {
305         return off & (PCPU_BITMAP_BLOCK_BITS - 1);
306 }
307
308 static unsigned long pcpu_block_off_to_off(int index, int off)
309 {
310         return index * PCPU_BITMAP_BLOCK_BITS + off;
311 }
312
313 /**
314  * pcpu_next_md_free_region - finds the next hint free area
315  * @chunk: chunk of interest
316  * @bit_off: chunk offset
317  * @bits: size of free area
318  *
319  * Helper function for pcpu_for_each_md_free_region.  It checks
320  * block->contig_hint and performs aggregation across blocks to find the
321  * next hint.  It modifies bit_off and bits in-place to be consumed in the
322  * loop.
323  */
324 static void pcpu_next_md_free_region(struct pcpu_chunk *chunk, int *bit_off,
325                                      int *bits)
326 {
327         int i = pcpu_off_to_block_index(*bit_off);
328         int block_off = pcpu_off_to_block_off(*bit_off);
329         struct pcpu_block_md *block;
330
331         *bits = 0;
332         for (block = chunk->md_blocks + i; i < pcpu_chunk_nr_blocks(chunk);
333              block++, i++) {
334                 /* handles contig area across blocks */
335                 if (*bits) {
336                         *bits += block->left_free;
337                         if (block->left_free == PCPU_BITMAP_BLOCK_BITS)
338                                 continue;
339                         return;
340                 }
341
342                 /*
343                  * This checks three things.  First is there a contig_hint to
344                  * check.  Second, have we checked this hint before by
345                  * comparing the block_off.  Third, is this the same as the
346                  * right contig hint.  In the last case, it spills over into
347                  * the next block and should be handled by the contig area
348                  * across blocks code.
349                  */
350                 *bits = block->contig_hint;
351                 if (*bits && block->contig_hint_start >= block_off &&
352                     *bits + block->contig_hint_start < PCPU_BITMAP_BLOCK_BITS) {
353                         *bit_off = pcpu_block_off_to_off(i,
354                                         block->contig_hint_start);
355                         return;
356                 }
357                 /* reset to satisfy the second predicate above */
358                 block_off = 0;
359
360                 *bits = block->right_free;
361                 *bit_off = (i + 1) * PCPU_BITMAP_BLOCK_BITS - block->right_free;
362         }
363 }
364
365 /**
366  * pcpu_next_fit_region - finds fit areas for a given allocation request
367  * @chunk: chunk of interest
368  * @alloc_bits: size of allocation
369  * @align: alignment of area (max PAGE_SIZE)
370  * @bit_off: chunk offset
371  * @bits: size of free area
372  *
373  * Finds the next free region that is viable for use with a given size and
374  * alignment.  This only returns if there is a valid area to be used for this
375  * allocation.  block->first_free is returned if the allocation request fits
376  * within the block to see if the request can be fulfilled prior to the contig
377  * hint.
378  */
379 static void pcpu_next_fit_region(struct pcpu_chunk *chunk, int alloc_bits,
380                                  int align, int *bit_off, int *bits)
381 {
382         int i = pcpu_off_to_block_index(*bit_off);
383         int block_off = pcpu_off_to_block_off(*bit_off);
384         struct pcpu_block_md *block;
385
386         *bits = 0;
387         for (block = chunk->md_blocks + i; i < pcpu_chunk_nr_blocks(chunk);
388              block++, i++) {
389                 /* handles contig area across blocks */
390                 if (*bits) {
391                         *bits += block->left_free;
392                         if (*bits >= alloc_bits)
393                                 return;
394                         if (block->left_free == PCPU_BITMAP_BLOCK_BITS)
395                                 continue;
396                 }
397
398                 /* check block->contig_hint */
399                 *bits = ALIGN(block->contig_hint_start, align) -
400                         block->contig_hint_start;
401                 /*
402                  * This uses the block offset to determine if this has been
403                  * checked in the prior iteration.
404                  */
405                 if (block->contig_hint &&
406                     block->contig_hint_start >= block_off &&
407                     block->contig_hint >= *bits + alloc_bits) {
408                         *bits += alloc_bits + block->contig_hint_start -
409                                  block->first_free;
410                         *bit_off = pcpu_block_off_to_off(i, block->first_free);
411                         return;
412                 }
413                 /* reset to satisfy the second predicate above */
414                 block_off = 0;
415
416                 *bit_off = ALIGN(PCPU_BITMAP_BLOCK_BITS - block->right_free,
417                                  align);
418                 *bits = PCPU_BITMAP_BLOCK_BITS - *bit_off;
419                 *bit_off = pcpu_block_off_to_off(i, *bit_off);
420                 if (*bits >= alloc_bits)
421                         return;
422         }
423
424         /* no valid offsets were found - fail condition */
425         *bit_off = pcpu_chunk_map_bits(chunk);
426 }
427
428 /*
429  * Metadata free area iterators.  These perform aggregation of free areas
430  * based on the metadata blocks and return the offset @bit_off and size in
431  * bits of the free area @bits.  pcpu_for_each_fit_region only returns when
432  * a fit is found for the allocation request.
433  */
434 #define pcpu_for_each_md_free_region(chunk, bit_off, bits)              \
435         for (pcpu_next_md_free_region((chunk), &(bit_off), &(bits));    \
436              (bit_off) < pcpu_chunk_map_bits((chunk));                  \
437              (bit_off) += (bits) + 1,                                   \
438              pcpu_next_md_free_region((chunk), &(bit_off), &(bits)))
439
440 #define pcpu_for_each_fit_region(chunk, alloc_bits, align, bit_off, bits)     \
441         for (pcpu_next_fit_region((chunk), (alloc_bits), (align), &(bit_off), \
442                                   &(bits));                                   \
443              (bit_off) < pcpu_chunk_map_bits((chunk));                        \
444              (bit_off) += (bits),                                             \
445              pcpu_next_fit_region((chunk), (alloc_bits), (align), &(bit_off), \
446                                   &(bits)))
447
448 /**
449  * pcpu_mem_zalloc - allocate memory
450  * @size: bytes to allocate
451  * @gfp: allocation flags
452  *
453  * Allocate @size bytes.  If @size is smaller than PAGE_SIZE,
454  * kzalloc() is used; otherwise, the equivalent of vzalloc() is used.
455  * This is to facilitate passing through whitelisted flags.  The
456  * returned memory is always zeroed.
457  *
458  * CONTEXT:
459  * Does GFP_KERNEL allocation.
460  *
461  * RETURNS:
462  * Pointer to the allocated area on success, NULL on failure.
463  */
464 static void *pcpu_mem_zalloc(size_t size, gfp_t gfp)
465 {
466         if (WARN_ON_ONCE(!slab_is_available()))
467                 return NULL;
468
469         if (size <= PAGE_SIZE)
470                 return kzalloc(size, gfp | GFP_KERNEL);
471         else
472                 return __vmalloc(size, gfp | GFP_KERNEL | __GFP_ZERO,
473                                  PAGE_KERNEL);
474 }
475
476 /**
477  * pcpu_mem_free - free memory
478  * @ptr: memory to free
479  *
480  * Free @ptr.  @ptr should have been allocated using pcpu_mem_zalloc().
481  */
482 static void pcpu_mem_free(void *ptr)
483 {
484         kvfree(ptr);
485 }
486
487 /**
488  * pcpu_chunk_relocate - put chunk in the appropriate chunk slot
489  * @chunk: chunk of interest
490  * @oslot: the previous slot it was on
491  *
492  * This function is called after an allocation or free changed @chunk.
493  * New slot according to the changed state is determined and @chunk is
494  * moved to the slot.  Note that the reserved chunk is never put on
495  * chunk slots.
496  *
497  * CONTEXT:
498  * pcpu_lock.
499  */
500 static void pcpu_chunk_relocate(struct pcpu_chunk *chunk, int oslot)
501 {
502         int nslot = pcpu_chunk_slot(chunk);
503
504         if (chunk != pcpu_reserved_chunk && oslot != nslot) {
505                 if (oslot < nslot)
506                         list_move(&chunk->list, &pcpu_slot[nslot]);
507                 else
508                         list_move_tail(&chunk->list, &pcpu_slot[nslot]);
509         }
510 }
511
512 /**
513  * pcpu_cnt_pop_pages- counts populated backing pages in range
514  * @chunk: chunk of interest
515  * @bit_off: start offset
516  * @bits: size of area to check
517  *
518  * Calculates the number of populated pages in the region
519  * [page_start, page_end).  This keeps track of how many empty populated
520  * pages are available and decide if async work should be scheduled.
521  *
522  * RETURNS:
523  * The nr of populated pages.
524  */
525 static inline int pcpu_cnt_pop_pages(struct pcpu_chunk *chunk, int bit_off,
526                                      int bits)
527 {
528         int page_start = PFN_UP(bit_off * PCPU_MIN_ALLOC_SIZE);
529         int page_end = PFN_DOWN((bit_off + bits) * PCPU_MIN_ALLOC_SIZE);
530
531         if (page_start >= page_end)
532                 return 0;
533
534         /*
535          * bitmap_weight counts the number of bits set in a bitmap up to
536          * the specified number of bits.  This is counting the populated
537          * pages up to page_end and then subtracting the populated pages
538          * up to page_start to count the populated pages in
539          * [page_start, page_end).
540          */
541         return bitmap_weight(chunk->populated, page_end) -
542                bitmap_weight(chunk->populated, page_start);
543 }
544
545 /**
546  * pcpu_chunk_update - updates the chunk metadata given a free area
547  * @chunk: chunk of interest
548  * @bit_off: chunk offset
549  * @bits: size of free area
550  *
551  * This updates the chunk's contig hint and starting offset given a free area.
552  * Choose the best starting offset if the contig hint is equal.
553  */
554 static void pcpu_chunk_update(struct pcpu_chunk *chunk, int bit_off, int bits)
555 {
556         if (bits > chunk->contig_bits) {
557                 chunk->contig_bits_start = bit_off;
558                 chunk->contig_bits = bits;
559         } else if (bits == chunk->contig_bits && chunk->contig_bits_start &&
560                    (!bit_off ||
561                     __ffs(bit_off) > __ffs(chunk->contig_bits_start))) {
562                 /* use the start with the best alignment */
563                 chunk->contig_bits_start = bit_off;
564         }
565 }
566
567 /**
568  * pcpu_chunk_refresh_hint - updates metadata about a chunk
569  * @chunk: chunk of interest
570  *
571  * Iterates over the metadata blocks to find the largest contig area.
572  * It also counts the populated pages and uses the delta to update the
573  * global count.
574  *
575  * Updates:
576  *      chunk->contig_bits
577  *      chunk->contig_bits_start
578  *      nr_empty_pop_pages (chunk and global)
579  */
580 static void pcpu_chunk_refresh_hint(struct pcpu_chunk *chunk)
581 {
582         int bit_off, bits, nr_empty_pop_pages;
583
584         /* clear metadata */
585         chunk->contig_bits = 0;
586
587         bit_off = chunk->first_bit;
588         bits = nr_empty_pop_pages = 0;
589         pcpu_for_each_md_free_region(chunk, bit_off, bits) {
590                 pcpu_chunk_update(chunk, bit_off, bits);
591
592                 nr_empty_pop_pages += pcpu_cnt_pop_pages(chunk, bit_off, bits);
593         }
594
595         /*
596          * Keep track of nr_empty_pop_pages.
597          *
598          * The chunk maintains the previous number of free pages it held,
599          * so the delta is used to update the global counter.  The reserved
600          * chunk is not part of the free page count as they are populated
601          * at init and are special to serving reserved allocations.
602          */
603         if (chunk != pcpu_reserved_chunk)
604                 pcpu_nr_empty_pop_pages +=
605                         (nr_empty_pop_pages - chunk->nr_empty_pop_pages);
606
607         chunk->nr_empty_pop_pages = nr_empty_pop_pages;
608 }
609
610 /**
611  * pcpu_block_update - updates a block given a free area
612  * @block: block of interest
613  * @start: start offset in block
614  * @end: end offset in block
615  *
616  * Updates a block given a known free area.  The region [start, end) is
617  * expected to be the entirety of the free area within a block.  Chooses
618  * the best starting offset if the contig hints are equal.
619  */
620 static void pcpu_block_update(struct pcpu_block_md *block, int start, int end)
621 {
622         int contig = end - start;
623
624         block->first_free = min(block->first_free, start);
625         if (start == 0)
626                 block->left_free = contig;
627
628         if (end == PCPU_BITMAP_BLOCK_BITS)
629                 block->right_free = contig;
630
631         if (contig > block->contig_hint) {
632                 block->contig_hint_start = start;
633                 block->contig_hint = contig;
634         } else if (block->contig_hint_start && contig == block->contig_hint &&
635                    (!start || __ffs(start) > __ffs(block->contig_hint_start))) {
636                 /* use the start with the best alignment */
637                 block->contig_hint_start = start;
638         }
639 }
640
641 /**
642  * pcpu_block_refresh_hint
643  * @chunk: chunk of interest
644  * @index: index of the metadata block
645  *
646  * Scans over the block beginning at first_free and updates the block
647  * metadata accordingly.
648  */
649 static void pcpu_block_refresh_hint(struct pcpu_chunk *chunk, int index)
650 {
651         struct pcpu_block_md *block = chunk->md_blocks + index;
652         unsigned long *alloc_map = pcpu_index_alloc_map(chunk, index);
653         int rs, re;     /* region start, region end */
654
655         /* clear hints */
656         block->contig_hint = 0;
657         block->left_free = block->right_free = 0;
658
659         /* iterate over free areas and update the contig hints */
660         pcpu_for_each_unpop_region(alloc_map, rs, re, block->first_free,
661                                    PCPU_BITMAP_BLOCK_BITS) {
662                 pcpu_block_update(block, rs, re);
663         }
664 }
665
666 /**
667  * pcpu_block_update_hint_alloc - update hint on allocation path
668  * @chunk: chunk of interest
669  * @bit_off: chunk offset
670  * @bits: size of request
671  *
672  * Updates metadata for the allocation path.  The metadata only has to be
673  * refreshed by a full scan iff the chunk's contig hint is broken.  Block level
674  * scans are required if the block's contig hint is broken.
675  */
676 static void pcpu_block_update_hint_alloc(struct pcpu_chunk *chunk, int bit_off,
677                                          int bits)
678 {
679         struct pcpu_block_md *s_block, *e_block, *block;
680         int s_index, e_index;   /* block indexes of the freed allocation */
681         int s_off, e_off;       /* block offsets of the freed allocation */
682
683         /*
684          * Calculate per block offsets.
685          * The calculation uses an inclusive range, but the resulting offsets
686          * are [start, end).  e_index always points to the last block in the
687          * range.
688          */
689         s_index = pcpu_off_to_block_index(bit_off);
690         e_index = pcpu_off_to_block_index(bit_off + bits - 1);
691         s_off = pcpu_off_to_block_off(bit_off);
692         e_off = pcpu_off_to_block_off(bit_off + bits - 1) + 1;
693
694         s_block = chunk->md_blocks + s_index;
695         e_block = chunk->md_blocks + e_index;
696
697         /*
698          * Update s_block.
699          * block->first_free must be updated if the allocation takes its place.
700          * If the allocation breaks the contig_hint, a scan is required to
701          * restore this hint.
702          */
703         if (s_off == s_block->first_free)
704                 s_block->first_free = find_next_zero_bit(
705                                         pcpu_index_alloc_map(chunk, s_index),
706                                         PCPU_BITMAP_BLOCK_BITS,
707                                         s_off + bits);
708
709         if (s_off >= s_block->contig_hint_start &&
710             s_off < s_block->contig_hint_start + s_block->contig_hint) {
711                 /* block contig hint is broken - scan to fix it */
712                 pcpu_block_refresh_hint(chunk, s_index);
713         } else {
714                 /* update left and right contig manually */
715                 s_block->left_free = min(s_block->left_free, s_off);
716                 if (s_index == e_index)
717                         s_block->right_free = min_t(int, s_block->right_free,
718                                         PCPU_BITMAP_BLOCK_BITS - e_off);
719                 else
720                         s_block->right_free = 0;
721         }
722
723         /*
724          * Update e_block.
725          */
726         if (s_index != e_index) {
727                 /*
728                  * When the allocation is across blocks, the end is along
729                  * the left part of the e_block.
730                  */
731                 e_block->first_free = find_next_zero_bit(
732                                 pcpu_index_alloc_map(chunk, e_index),
733                                 PCPU_BITMAP_BLOCK_BITS, e_off);
734
735                 if (e_off == PCPU_BITMAP_BLOCK_BITS) {
736                         /* reset the block */
737                         e_block++;
738                 } else {
739                         if (e_off > e_block->contig_hint_start) {
740                                 /* contig hint is broken - scan to fix it */
741                                 pcpu_block_refresh_hint(chunk, e_index);
742                         } else {
743                                 e_block->left_free = 0;
744                                 e_block->right_free =
745                                         min_t(int, e_block->right_free,
746                                               PCPU_BITMAP_BLOCK_BITS - e_off);
747                         }
748                 }
749
750                 /* update in-between md_blocks */
751                 for (block = s_block + 1; block < e_block; block++) {
752                         block->contig_hint = 0;
753                         block->left_free = 0;
754                         block->right_free = 0;
755                 }
756         }
757
758         /*
759          * The only time a full chunk scan is required is if the chunk
760          * contig hint is broken.  Otherwise, it means a smaller space
761          * was used and therefore the chunk contig hint is still correct.
762          */
763         if (bit_off >= chunk->contig_bits_start  &&
764             bit_off < chunk->contig_bits_start + chunk->contig_bits)
765                 pcpu_chunk_refresh_hint(chunk);
766 }
767
768 /**
769  * pcpu_block_update_hint_free - updates the block hints on the free path
770  * @chunk: chunk of interest
771  * @bit_off: chunk offset
772  * @bits: size of request
773  *
774  * Updates metadata for the allocation path.  This avoids a blind block
775  * refresh by making use of the block contig hints.  If this fails, it scans
776  * forward and backward to determine the extent of the free area.  This is
777  * capped at the boundary of blocks.
778  *
779  * A chunk update is triggered if a page becomes free, a block becomes free,
780  * or the free spans across blocks.  This tradeoff is to minimize iterating
781  * over the block metadata to update chunk->contig_bits.  chunk->contig_bits
782  * may be off by up to a page, but it will never be more than the available
783  * space.  If the contig hint is contained in one block, it will be accurate.
784  */
785 static void pcpu_block_update_hint_free(struct pcpu_chunk *chunk, int bit_off,
786                                         int bits)
787 {
788         struct pcpu_block_md *s_block, *e_block, *block;
789         int s_index, e_index;   /* block indexes of the freed allocation */
790         int s_off, e_off;       /* block offsets of the freed allocation */
791         int start, end;         /* start and end of the whole free area */
792
793         /*
794          * Calculate per block offsets.
795          * The calculation uses an inclusive range, but the resulting offsets
796          * are [start, end).  e_index always points to the last block in the
797          * range.
798          */
799         s_index = pcpu_off_to_block_index(bit_off);
800         e_index = pcpu_off_to_block_index(bit_off + bits - 1);
801         s_off = pcpu_off_to_block_off(bit_off);
802         e_off = pcpu_off_to_block_off(bit_off + bits - 1) + 1;
803
804         s_block = chunk->md_blocks + s_index;
805         e_block = chunk->md_blocks + e_index;
806
807         /*
808          * Check if the freed area aligns with the block->contig_hint.
809          * If it does, then the scan to find the beginning/end of the
810          * larger free area can be avoided.
811          *
812          * start and end refer to beginning and end of the free area
813          * within each their respective blocks.  This is not necessarily
814          * the entire free area as it may span blocks past the beginning
815          * or end of the block.
816          */
817         start = s_off;
818         if (s_off == s_block->contig_hint + s_block->contig_hint_start) {
819                 start = s_block->contig_hint_start;
820         } else {
821                 /*
822                  * Scan backwards to find the extent of the free area.
823                  * find_last_bit returns the starting bit, so if the start bit
824                  * is returned, that means there was no last bit and the
825                  * remainder of the chunk is free.
826                  */
827                 int l_bit = find_last_bit(pcpu_index_alloc_map(chunk, s_index),
828                                           start);
829                 start = (start == l_bit) ? 0 : l_bit + 1;
830         }
831
832         end = e_off;
833         if (e_off == e_block->contig_hint_start)
834                 end = e_block->contig_hint_start + e_block->contig_hint;
835         else
836                 end = find_next_bit(pcpu_index_alloc_map(chunk, e_index),
837                                     PCPU_BITMAP_BLOCK_BITS, end);
838
839         /* update s_block */
840         e_off = (s_index == e_index) ? end : PCPU_BITMAP_BLOCK_BITS;
841         pcpu_block_update(s_block, start, e_off);
842
843         /* freeing in the same block */
844         if (s_index != e_index) {
845                 /* update e_block */
846                 pcpu_block_update(e_block, 0, end);
847
848                 /* reset md_blocks in the middle */
849                 for (block = s_block + 1; block < e_block; block++) {
850                         block->first_free = 0;
851                         block->contig_hint_start = 0;
852                         block->contig_hint = PCPU_BITMAP_BLOCK_BITS;
853                         block->left_free = PCPU_BITMAP_BLOCK_BITS;
854                         block->right_free = PCPU_BITMAP_BLOCK_BITS;
855                 }
856         }
857
858         /*
859          * Refresh chunk metadata when the free makes a page free, a block
860          * free, or spans across blocks.  The contig hint may be off by up to
861          * a page, but if the hint is contained in a block, it will be accurate
862          * with the else condition below.
863          */
864         if ((ALIGN_DOWN(end, min(PCPU_BITS_PER_PAGE, PCPU_BITMAP_BLOCK_BITS)) >
865              ALIGN(start, min(PCPU_BITS_PER_PAGE, PCPU_BITMAP_BLOCK_BITS))) ||
866             s_index != e_index)
867                 pcpu_chunk_refresh_hint(chunk);
868         else
869                 pcpu_chunk_update(chunk, pcpu_block_off_to_off(s_index, start),
870                                   s_block->contig_hint);
871 }
872
873 /**
874  * pcpu_is_populated - determines if the region is populated
875  * @chunk: chunk of interest
876  * @bit_off: chunk offset
877  * @bits: size of area
878  * @next_off: return value for the next offset to start searching
879  *
880  * For atomic allocations, check if the backing pages are populated.
881  *
882  * RETURNS:
883  * Bool if the backing pages are populated.
884  * next_index is to skip over unpopulated blocks in pcpu_find_block_fit.
885  */
886 static bool pcpu_is_populated(struct pcpu_chunk *chunk, int bit_off, int bits,
887                               int *next_off)
888 {
889         int page_start, page_end, rs, re;
890
891         page_start = PFN_DOWN(bit_off * PCPU_MIN_ALLOC_SIZE);
892         page_end = PFN_UP((bit_off + bits) * PCPU_MIN_ALLOC_SIZE);
893
894         rs = page_start;
895         pcpu_next_unpop(chunk->populated, &rs, &re, page_end);
896         if (rs >= page_end)
897                 return true;
898
899         *next_off = re * PAGE_SIZE / PCPU_MIN_ALLOC_SIZE;
900         return false;
901 }
902
903 /**
904  * pcpu_find_block_fit - finds the block index to start searching
905  * @chunk: chunk of interest
906  * @alloc_bits: size of request in allocation units
907  * @align: alignment of area (max PAGE_SIZE bytes)
908  * @pop_only: use populated regions only
909  *
910  * Given a chunk and an allocation spec, find the offset to begin searching
911  * for a free region.  This iterates over the bitmap metadata blocks to
912  * find an offset that will be guaranteed to fit the requirements.  It is
913  * not quite first fit as if the allocation does not fit in the contig hint
914  * of a block or chunk, it is skipped.  This errs on the side of caution
915  * to prevent excess iteration.  Poor alignment can cause the allocator to
916  * skip over blocks and chunks that have valid free areas.
917  *
918  * RETURNS:
919  * The offset in the bitmap to begin searching.
920  * -1 if no offset is found.
921  */
922 static int pcpu_find_block_fit(struct pcpu_chunk *chunk, int alloc_bits,
923                                size_t align, bool pop_only)
924 {
925         int bit_off, bits, next_off;
926
927         /*
928          * Check to see if the allocation can fit in the chunk's contig hint.
929          * This is an optimization to prevent scanning by assuming if it
930          * cannot fit in the global hint, there is memory pressure and creating
931          * a new chunk would happen soon.
932          */
933         bit_off = ALIGN(chunk->contig_bits_start, align) -
934                   chunk->contig_bits_start;
935         if (bit_off + alloc_bits > chunk->contig_bits)
936                 return -1;
937
938         bit_off = chunk->first_bit;
939         bits = 0;
940         pcpu_for_each_fit_region(chunk, alloc_bits, align, bit_off, bits) {
941                 if (!pop_only || pcpu_is_populated(chunk, bit_off, bits,
942                                                    &next_off))
943                         break;
944
945                 bit_off = next_off;
946                 bits = 0;
947         }
948
949         if (bit_off == pcpu_chunk_map_bits(chunk))
950                 return -1;
951
952         return bit_off;
953 }
954
955 /**
956  * pcpu_alloc_area - allocates an area from a pcpu_chunk
957  * @chunk: chunk of interest
958  * @alloc_bits: size of request in allocation units
959  * @align: alignment of area (max PAGE_SIZE)
960  * @start: bit_off to start searching
961  *
962  * This function takes in a @start offset to begin searching to fit an
963  * allocation of @alloc_bits with alignment @align.  It needs to scan
964  * the allocation map because if it fits within the block's contig hint,
965  * @start will be block->first_free. This is an attempt to fill the
966  * allocation prior to breaking the contig hint.  The allocation and
967  * boundary maps are updated accordingly if it confirms a valid
968  * free area.
969  *
970  * RETURNS:
971  * Allocated addr offset in @chunk on success.
972  * -1 if no matching area is found.
973  */
974 static int pcpu_alloc_area(struct pcpu_chunk *chunk, int alloc_bits,
975                            size_t align, int start)
976 {
977         size_t align_mask = (align) ? (align - 1) : 0;
978         int bit_off, end, oslot;
979
980         lockdep_assert_held(&pcpu_lock);
981
982         oslot = pcpu_chunk_slot(chunk);
983
984         /*
985          * Search to find a fit.
986          */
987         end = start + alloc_bits + PCPU_BITMAP_BLOCK_BITS;
988         bit_off = bitmap_find_next_zero_area(chunk->alloc_map, end, start,
989                                              alloc_bits, align_mask);
990         if (bit_off >= end)
991                 return -1;
992
993         /* update alloc map */
994         bitmap_set(chunk->alloc_map, bit_off, alloc_bits);
995
996         /* update boundary map */
997         set_bit(bit_off, chunk->bound_map);
998         bitmap_clear(chunk->bound_map, bit_off + 1, alloc_bits - 1);
999         set_bit(bit_off + alloc_bits, chunk->bound_map);
1000
1001         chunk->free_bytes -= alloc_bits * PCPU_MIN_ALLOC_SIZE;
1002
1003         /* update first free bit */
1004         if (bit_off == chunk->first_bit)
1005                 chunk->first_bit = find_next_zero_bit(
1006                                         chunk->alloc_map,
1007                                         pcpu_chunk_map_bits(chunk),
1008                                         bit_off + alloc_bits);
1009
1010         pcpu_block_update_hint_alloc(chunk, bit_off, alloc_bits);
1011
1012         pcpu_chunk_relocate(chunk, oslot);
1013
1014         return bit_off * PCPU_MIN_ALLOC_SIZE;
1015 }
1016
1017 /**
1018  * pcpu_free_area - frees the corresponding offset
1019  * @chunk: chunk of interest
1020  * @off: addr offset into chunk
1021  *
1022  * This function determines the size of an allocation to free using
1023  * the boundary bitmap and clears the allocation map.
1024  */
1025 static void pcpu_free_area(struct pcpu_chunk *chunk, int off)
1026 {
1027         int bit_off, bits, end, oslot;
1028
1029         lockdep_assert_held(&pcpu_lock);
1030         pcpu_stats_area_dealloc(chunk);
1031
1032         oslot = pcpu_chunk_slot(chunk);
1033
1034         bit_off = off / PCPU_MIN_ALLOC_SIZE;
1035
1036         /* find end index */
1037         end = find_next_bit(chunk->bound_map, pcpu_chunk_map_bits(chunk),
1038                             bit_off + 1);
1039         bits = end - bit_off;
1040         bitmap_clear(chunk->alloc_map, bit_off, bits);
1041
1042         /* update metadata */
1043         chunk->free_bytes += bits * PCPU_MIN_ALLOC_SIZE;
1044
1045         /* update first free bit */
1046         chunk->first_bit = min(chunk->first_bit, bit_off);
1047
1048         pcpu_block_update_hint_free(chunk, bit_off, bits);
1049
1050         pcpu_chunk_relocate(chunk, oslot);
1051 }
1052
1053 static void pcpu_init_md_blocks(struct pcpu_chunk *chunk)
1054 {
1055         struct pcpu_block_md *md_block;
1056
1057         for (md_block = chunk->md_blocks;
1058              md_block != chunk->md_blocks + pcpu_chunk_nr_blocks(chunk);
1059              md_block++) {
1060                 md_block->contig_hint = PCPU_BITMAP_BLOCK_BITS;
1061                 md_block->left_free = PCPU_BITMAP_BLOCK_BITS;
1062                 md_block->right_free = PCPU_BITMAP_BLOCK_BITS;
1063         }
1064 }
1065
1066 /**
1067  * pcpu_alloc_first_chunk - creates chunks that serve the first chunk
1068  * @tmp_addr: the start of the region served
1069  * @map_size: size of the region served
1070  *
1071  * This is responsible for creating the chunks that serve the first chunk.  The
1072  * base_addr is page aligned down of @tmp_addr while the region end is page
1073  * aligned up.  Offsets are kept track of to determine the region served. All
1074  * this is done to appease the bitmap allocator in avoiding partial blocks.
1075  *
1076  * RETURNS:
1077  * Chunk serving the region at @tmp_addr of @map_size.
1078  */
1079 static struct pcpu_chunk * __init pcpu_alloc_first_chunk(unsigned long tmp_addr,
1080                                                          int map_size)
1081 {
1082         struct pcpu_chunk *chunk;
1083         unsigned long aligned_addr, lcm_align;
1084         int start_offset, offset_bits, region_size, region_bits;
1085
1086         /* region calculations */
1087         aligned_addr = tmp_addr & PAGE_MASK;
1088
1089         start_offset = tmp_addr - aligned_addr;
1090
1091         /*
1092          * Align the end of the region with the LCM of PAGE_SIZE and
1093          * PCPU_BITMAP_BLOCK_SIZE.  One of these constants is a multiple of
1094          * the other.
1095          */
1096         lcm_align = lcm(PAGE_SIZE, PCPU_BITMAP_BLOCK_SIZE);
1097         region_size = ALIGN(start_offset + map_size, lcm_align);
1098
1099         /* allocate chunk */
1100         chunk = memblock_virt_alloc(sizeof(struct pcpu_chunk) +
1101                                     BITS_TO_LONGS(region_size >> PAGE_SHIFT),
1102                                     0);
1103
1104         INIT_LIST_HEAD(&chunk->list);
1105
1106         chunk->base_addr = (void *)aligned_addr;
1107         chunk->start_offset = start_offset;
1108         chunk->end_offset = region_size - chunk->start_offset - map_size;
1109
1110         chunk->nr_pages = region_size >> PAGE_SHIFT;
1111         region_bits = pcpu_chunk_map_bits(chunk);
1112
1113         chunk->alloc_map = memblock_virt_alloc(BITS_TO_LONGS(region_bits) *
1114                                                sizeof(chunk->alloc_map[0]), 0);
1115         chunk->bound_map = memblock_virt_alloc(BITS_TO_LONGS(region_bits + 1) *
1116                                                sizeof(chunk->bound_map[0]), 0);
1117         chunk->md_blocks = memblock_virt_alloc(pcpu_chunk_nr_blocks(chunk) *
1118                                                sizeof(chunk->md_blocks[0]), 0);
1119         pcpu_init_md_blocks(chunk);
1120
1121         /* manage populated page bitmap */
1122         chunk->immutable = true;
1123         bitmap_fill(chunk->populated, chunk->nr_pages);
1124         chunk->nr_populated = chunk->nr_pages;
1125         chunk->nr_empty_pop_pages =
1126                 pcpu_cnt_pop_pages(chunk, start_offset / PCPU_MIN_ALLOC_SIZE,
1127                                    map_size / PCPU_MIN_ALLOC_SIZE);
1128
1129         chunk->contig_bits = map_size / PCPU_MIN_ALLOC_SIZE;
1130         chunk->free_bytes = map_size;
1131
1132         if (chunk->start_offset) {
1133                 /* hide the beginning of the bitmap */
1134                 offset_bits = chunk->start_offset / PCPU_MIN_ALLOC_SIZE;
1135                 bitmap_set(chunk->alloc_map, 0, offset_bits);
1136                 set_bit(0, chunk->bound_map);
1137                 set_bit(offset_bits, chunk->bound_map);
1138
1139                 chunk->first_bit = offset_bits;
1140
1141                 pcpu_block_update_hint_alloc(chunk, 0, offset_bits);
1142         }
1143
1144         if (chunk->end_offset) {
1145                 /* hide the end of the bitmap */
1146                 offset_bits = chunk->end_offset / PCPU_MIN_ALLOC_SIZE;
1147                 bitmap_set(chunk->alloc_map,
1148                            pcpu_chunk_map_bits(chunk) - offset_bits,
1149                            offset_bits);
1150                 set_bit((start_offset + map_size) / PCPU_MIN_ALLOC_SIZE,
1151                         chunk->bound_map);
1152                 set_bit(region_bits, chunk->bound_map);
1153
1154                 pcpu_block_update_hint_alloc(chunk, pcpu_chunk_map_bits(chunk)
1155                                              - offset_bits, offset_bits);
1156         }
1157
1158         return chunk;
1159 }
1160
1161 static struct pcpu_chunk *pcpu_alloc_chunk(gfp_t gfp)
1162 {
1163         struct pcpu_chunk *chunk;
1164         int region_bits;
1165
1166         chunk = pcpu_mem_zalloc(pcpu_chunk_struct_size, gfp);
1167         if (!chunk)
1168                 return NULL;
1169
1170         INIT_LIST_HEAD(&chunk->list);
1171         chunk->nr_pages = pcpu_unit_pages;
1172         region_bits = pcpu_chunk_map_bits(chunk);
1173
1174         chunk->alloc_map = pcpu_mem_zalloc(BITS_TO_LONGS(region_bits) *
1175                                            sizeof(chunk->alloc_map[0]), gfp);
1176         if (!chunk->alloc_map)
1177                 goto alloc_map_fail;
1178
1179         chunk->bound_map = pcpu_mem_zalloc(BITS_TO_LONGS(region_bits + 1) *
1180                                            sizeof(chunk->bound_map[0]), gfp);
1181         if (!chunk->bound_map)
1182                 goto bound_map_fail;
1183
1184         chunk->md_blocks = pcpu_mem_zalloc(pcpu_chunk_nr_blocks(chunk) *
1185                                            sizeof(chunk->md_blocks[0]), gfp);
1186         if (!chunk->md_blocks)
1187                 goto md_blocks_fail;
1188
1189         pcpu_init_md_blocks(chunk);
1190
1191         /* init metadata */
1192         chunk->contig_bits = region_bits;
1193         chunk->free_bytes = chunk->nr_pages * PAGE_SIZE;
1194
1195         return chunk;
1196
1197 md_blocks_fail:
1198         pcpu_mem_free(chunk->bound_map);
1199 bound_map_fail:
1200         pcpu_mem_free(chunk->alloc_map);
1201 alloc_map_fail:
1202         pcpu_mem_free(chunk);
1203
1204         return NULL;
1205 }
1206
1207 static void pcpu_free_chunk(struct pcpu_chunk *chunk)
1208 {
1209         if (!chunk)
1210                 return;
1211         pcpu_mem_free(chunk->bound_map);
1212         pcpu_mem_free(chunk->alloc_map);
1213         pcpu_mem_free(chunk);
1214 }
1215
1216 /**
1217  * pcpu_chunk_populated - post-population bookkeeping
1218  * @chunk: pcpu_chunk which got populated
1219  * @page_start: the start page
1220  * @page_end: the end page
1221  * @for_alloc: if this is to populate for allocation
1222  *
1223  * Pages in [@page_start,@page_end) have been populated to @chunk.  Update
1224  * the bookkeeping information accordingly.  Must be called after each
1225  * successful population.
1226  *
1227  * If this is @for_alloc, do not increment pcpu_nr_empty_pop_pages because it
1228  * is to serve an allocation in that area.
1229  */
1230 static void pcpu_chunk_populated(struct pcpu_chunk *chunk, int page_start,
1231                                  int page_end, bool for_alloc)
1232 {
1233         int nr = page_end - page_start;
1234
1235         lockdep_assert_held(&pcpu_lock);
1236
1237         bitmap_set(chunk->populated, page_start, nr);
1238         chunk->nr_populated += nr;
1239
1240         if (!for_alloc) {
1241                 chunk->nr_empty_pop_pages += nr;
1242                 pcpu_nr_empty_pop_pages += nr;
1243         }
1244 }
1245
1246 /**
1247  * pcpu_chunk_depopulated - post-depopulation bookkeeping
1248  * @chunk: pcpu_chunk which got depopulated
1249  * @page_start: the start page
1250  * @page_end: the end page
1251  *
1252  * Pages in [@page_start,@page_end) have been depopulated from @chunk.
1253  * Update the bookkeeping information accordingly.  Must be called after
1254  * each successful depopulation.
1255  */
1256 static void pcpu_chunk_depopulated(struct pcpu_chunk *chunk,
1257                                    int page_start, int page_end)
1258 {
1259         int nr = page_end - page_start;
1260
1261         lockdep_assert_held(&pcpu_lock);
1262
1263         bitmap_clear(chunk->populated, page_start, nr);
1264         chunk->nr_populated -= nr;
1265         chunk->nr_empty_pop_pages -= nr;
1266         pcpu_nr_empty_pop_pages -= nr;
1267 }
1268
1269 /*
1270  * Chunk management implementation.
1271  *
1272  * To allow different implementations, chunk alloc/free and
1273  * [de]population are implemented in a separate file which is pulled
1274  * into this file and compiled together.  The following functions
1275  * should be implemented.
1276  *
1277  * pcpu_populate_chunk          - populate the specified range of a chunk
1278  * pcpu_depopulate_chunk        - depopulate the specified range of a chunk
1279  * pcpu_create_chunk            - create a new chunk
1280  * pcpu_destroy_chunk           - destroy a chunk, always preceded by full depop
1281  * pcpu_addr_to_page            - translate address to physical address
1282  * pcpu_verify_alloc_info       - check alloc_info is acceptable during init
1283  */
1284 static int pcpu_populate_chunk(struct pcpu_chunk *chunk, int off, int size,
1285                                gfp_t gfp);
1286 static void pcpu_depopulate_chunk(struct pcpu_chunk *chunk, int off, int size);
1287 static struct pcpu_chunk *pcpu_create_chunk(gfp_t gfp);
1288 static void pcpu_destroy_chunk(struct pcpu_chunk *chunk);
1289 static struct page *pcpu_addr_to_page(void *addr);
1290 static int __init pcpu_verify_alloc_info(const struct pcpu_alloc_info *ai);
1291
1292 #ifdef CONFIG_NEED_PER_CPU_KM
1293 #include "percpu-km.c"
1294 #else
1295 #include "percpu-vm.c"
1296 #endif
1297
1298 /**
1299  * pcpu_chunk_addr_search - determine chunk containing specified address
1300  * @addr: address for which the chunk needs to be determined.
1301  *
1302  * This is an internal function that handles all but static allocations.
1303  * Static percpu address values should never be passed into the allocator.
1304  *
1305  * RETURNS:
1306  * The address of the found chunk.
1307  */
1308 static struct pcpu_chunk *pcpu_chunk_addr_search(void *addr)
1309 {
1310         /* is it in the dynamic region (first chunk)? */
1311         if (pcpu_addr_in_chunk(pcpu_first_chunk, addr))
1312                 return pcpu_first_chunk;
1313
1314         /* is it in the reserved region? */
1315         if (pcpu_addr_in_chunk(pcpu_reserved_chunk, addr))
1316                 return pcpu_reserved_chunk;
1317
1318         /*
1319          * The address is relative to unit0 which might be unused and
1320          * thus unmapped.  Offset the address to the unit space of the
1321          * current processor before looking it up in the vmalloc
1322          * space.  Note that any possible cpu id can be used here, so
1323          * there's no need to worry about preemption or cpu hotplug.
1324          */
1325         addr += pcpu_unit_offsets[raw_smp_processor_id()];
1326         return pcpu_get_page_chunk(pcpu_addr_to_page(addr));
1327 }
1328
1329 /**
1330  * pcpu_alloc - the percpu allocator
1331  * @size: size of area to allocate in bytes
1332  * @align: alignment of area (max PAGE_SIZE)
1333  * @reserved: allocate from the reserved chunk if available
1334  * @gfp: allocation flags
1335  *
1336  * Allocate percpu area of @size bytes aligned at @align.  If @gfp doesn't
1337  * contain %GFP_KERNEL, the allocation is atomic. If @gfp has __GFP_NOWARN
1338  * then no warning will be triggered on invalid or failed allocation
1339  * requests.
1340  *
1341  * RETURNS:
1342  * Percpu pointer to the allocated area on success, NULL on failure.
1343  */
1344 static void __percpu *pcpu_alloc(size_t size, size_t align, bool reserved,
1345                                  gfp_t gfp)
1346 {
1347         bool is_atomic = (gfp & GFP_KERNEL) != GFP_KERNEL;
1348         bool do_warn = !(gfp & __GFP_NOWARN);
1349         static int warn_limit = 10;
1350         struct pcpu_chunk *chunk;
1351         const char *err;
1352         int slot, off, cpu, ret;
1353         unsigned long flags;
1354         void __percpu *ptr;
1355         size_t bits, bit_align;
1356
1357         /*
1358          * There is now a minimum allocation size of PCPU_MIN_ALLOC_SIZE,
1359          * therefore alignment must be a minimum of that many bytes.
1360          * An allocation may have internal fragmentation from rounding up
1361          * of up to PCPU_MIN_ALLOC_SIZE - 1 bytes.
1362          */
1363         if (unlikely(align < PCPU_MIN_ALLOC_SIZE))
1364                 align = PCPU_MIN_ALLOC_SIZE;
1365
1366         size = ALIGN(size, PCPU_MIN_ALLOC_SIZE);
1367         bits = size >> PCPU_MIN_ALLOC_SHIFT;
1368         bit_align = align >> PCPU_MIN_ALLOC_SHIFT;
1369
1370         if (unlikely(!size || size > PCPU_MIN_UNIT_SIZE || align > PAGE_SIZE ||
1371                      !is_power_of_2(align))) {
1372                 WARN(do_warn, "illegal size (%zu) or align (%zu) for percpu allocation\n",
1373                      size, align);
1374                 return NULL;
1375         }
1376
1377         if (!is_atomic)
1378                 mutex_lock(&pcpu_alloc_mutex);
1379
1380         spin_lock_irqsave(&pcpu_lock, flags);
1381
1382         /* serve reserved allocations from the reserved chunk if available */
1383         if (reserved && pcpu_reserved_chunk) {
1384                 chunk = pcpu_reserved_chunk;
1385
1386                 off = pcpu_find_block_fit(chunk, bits, bit_align, is_atomic);
1387                 if (off < 0) {
1388                         err = "alloc from reserved chunk failed";
1389                         goto fail_unlock;
1390                 }
1391
1392                 off = pcpu_alloc_area(chunk, bits, bit_align, off);
1393                 if (off >= 0)
1394                         goto area_found;
1395
1396                 err = "alloc from reserved chunk failed";
1397                 goto fail_unlock;
1398         }
1399
1400 restart:
1401         /* search through normal chunks */
1402         for (slot = pcpu_size_to_slot(size); slot < pcpu_nr_slots; slot++) {
1403                 list_for_each_entry(chunk, &pcpu_slot[slot], list) {
1404                         off = pcpu_find_block_fit(chunk, bits, bit_align,
1405                                                   is_atomic);
1406                         if (off < 0)
1407                                 continue;
1408
1409                         off = pcpu_alloc_area(chunk, bits, bit_align, off);
1410                         if (off >= 0)
1411                                 goto area_found;
1412
1413                 }
1414         }
1415
1416         spin_unlock_irqrestore(&pcpu_lock, flags);
1417
1418         /*
1419          * No space left.  Create a new chunk.  We don't want multiple
1420          * tasks to create chunks simultaneously.  Serialize and create iff
1421          * there's still no empty chunk after grabbing the mutex.
1422          */
1423         if (is_atomic) {
1424                 err = "atomic alloc failed, no space left";
1425                 goto fail;
1426         }
1427
1428         if (list_empty(&pcpu_slot[pcpu_nr_slots - 1])) {
1429                 chunk = pcpu_create_chunk(0);
1430                 if (!chunk) {
1431                         err = "failed to allocate new chunk";
1432                         goto fail;
1433                 }
1434
1435                 spin_lock_irqsave(&pcpu_lock, flags);
1436                 pcpu_chunk_relocate(chunk, -1);
1437         } else {
1438                 spin_lock_irqsave(&pcpu_lock, flags);
1439         }
1440
1441         goto restart;
1442
1443 area_found:
1444         pcpu_stats_area_alloc(chunk, size);
1445         spin_unlock_irqrestore(&pcpu_lock, flags);
1446
1447         /* populate if not all pages are already there */
1448         if (!is_atomic) {
1449                 int page_start, page_end, rs, re;
1450
1451                 page_start = PFN_DOWN(off);
1452                 page_end = PFN_UP(off + size);
1453
1454                 pcpu_for_each_unpop_region(chunk->populated, rs, re,
1455                                            page_start, page_end) {
1456                         WARN_ON(chunk->immutable);
1457
1458                         ret = pcpu_populate_chunk(chunk, rs, re, 0);
1459
1460                         spin_lock_irqsave(&pcpu_lock, flags);
1461                         if (ret) {
1462                                 pcpu_free_area(chunk, off);
1463                                 err = "failed to populate";
1464                                 goto fail_unlock;
1465                         }
1466                         pcpu_chunk_populated(chunk, rs, re, true);
1467                         spin_unlock_irqrestore(&pcpu_lock, flags);
1468                 }
1469
1470                 mutex_unlock(&pcpu_alloc_mutex);
1471         }
1472
1473         if (pcpu_nr_empty_pop_pages < PCPU_EMPTY_POP_PAGES_LOW)
1474                 pcpu_schedule_balance_work();
1475
1476         /* clear the areas and return address relative to base address */
1477         for_each_possible_cpu(cpu)
1478                 memset((void *)pcpu_chunk_addr(chunk, cpu, 0) + off, 0, size);
1479
1480         ptr = __addr_to_pcpu_ptr(chunk->base_addr + off);
1481         kmemleak_alloc_percpu(ptr, size, gfp);
1482
1483         trace_percpu_alloc_percpu(reserved, is_atomic, size, align,
1484                         chunk->base_addr, off, ptr);
1485
1486         return ptr;
1487
1488 fail_unlock:
1489         spin_unlock_irqrestore(&pcpu_lock, flags);
1490 fail:
1491         trace_percpu_alloc_percpu_fail(reserved, is_atomic, size, align);
1492
1493         if (!is_atomic && do_warn && warn_limit) {
1494                 pr_warn("allocation failed, size=%zu align=%zu atomic=%d, %s\n",
1495                         size, align, is_atomic, err);
1496                 dump_stack();
1497                 if (!--warn_limit)
1498                         pr_info("limit reached, disable warning\n");
1499         }
1500         if (is_atomic) {
1501                 /* see the flag handling in pcpu_blance_workfn() */
1502                 pcpu_atomic_alloc_failed = true;
1503                 pcpu_schedule_balance_work();
1504         } else {
1505                 mutex_unlock(&pcpu_alloc_mutex);
1506         }
1507         return NULL;
1508 }
1509
1510 /**
1511  * __alloc_percpu_gfp - allocate dynamic percpu area
1512  * @size: size of area to allocate in bytes
1513  * @align: alignment of area (max PAGE_SIZE)
1514  * @gfp: allocation flags
1515  *
1516  * Allocate zero-filled percpu area of @size bytes aligned at @align.  If
1517  * @gfp doesn't contain %GFP_KERNEL, the allocation doesn't block and can
1518  * be called from any context but is a lot more likely to fail. If @gfp
1519  * has __GFP_NOWARN then no warning will be triggered on invalid or failed
1520  * allocation requests.
1521  *
1522  * RETURNS:
1523  * Percpu pointer to the allocated area on success, NULL on failure.
1524  */
1525 void __percpu *__alloc_percpu_gfp(size_t size, size_t align, gfp_t gfp)
1526 {
1527         return pcpu_alloc(size, align, false, gfp);
1528 }
1529 EXPORT_SYMBOL_GPL(__alloc_percpu_gfp);
1530
1531 /**
1532  * __alloc_percpu - allocate dynamic percpu area
1533  * @size: size of area to allocate in bytes
1534  * @align: alignment of area (max PAGE_SIZE)
1535  *
1536  * Equivalent to __alloc_percpu_gfp(size, align, %GFP_KERNEL).
1537  */
1538 void __percpu *__alloc_percpu(size_t size, size_t align)
1539 {
1540         return pcpu_alloc(size, align, false, GFP_KERNEL);
1541 }
1542 EXPORT_SYMBOL_GPL(__alloc_percpu);
1543
1544 /**
1545  * __alloc_reserved_percpu - allocate reserved percpu area
1546  * @size: size of area to allocate in bytes
1547  * @align: alignment of area (max PAGE_SIZE)
1548  *
1549  * Allocate zero-filled percpu area of @size bytes aligned at @align
1550  * from reserved percpu area if arch has set it up; otherwise,
1551  * allocation is served from the same dynamic area.  Might sleep.
1552  * Might trigger writeouts.
1553  *
1554  * CONTEXT:
1555  * Does GFP_KERNEL allocation.
1556  *
1557  * RETURNS:
1558  * Percpu pointer to the allocated area on success, NULL on failure.
1559  */
1560 void __percpu *__alloc_reserved_percpu(size_t size, size_t align)
1561 {
1562         return pcpu_alloc(size, align, true, GFP_KERNEL);
1563 }
1564
1565 /**
1566  * pcpu_balance_workfn - manage the amount of free chunks and populated pages
1567  * @work: unused
1568  *
1569  * Reclaim all fully free chunks except for the first one.  This is also
1570  * responsible for maintaining the pool of empty populated pages.  However,
1571  * it is possible that this is called when physical memory is scarce causing
1572  * OOM killer to be triggered.  We should avoid doing so until an actual
1573  * allocation causes the failure as it is possible that requests can be
1574  * serviced from already backed regions.
1575  */
1576 static void pcpu_balance_workfn(struct work_struct *work)
1577 {
1578         /* gfp flags passed to underlying allocators */
1579         const gfp_t gfp = __GFP_NORETRY | __GFP_NOWARN;
1580         LIST_HEAD(to_free);
1581         struct list_head *free_head = &pcpu_slot[pcpu_nr_slots - 1];
1582         struct pcpu_chunk *chunk, *next;
1583         int slot, nr_to_pop, ret;
1584
1585         /*
1586          * There's no reason to keep around multiple unused chunks and VM
1587          * areas can be scarce.  Destroy all free chunks except for one.
1588          */
1589         mutex_lock(&pcpu_alloc_mutex);
1590         spin_lock_irq(&pcpu_lock);
1591
1592         list_for_each_entry_safe(chunk, next, free_head, list) {
1593                 WARN_ON(chunk->immutable);
1594
1595                 /* spare the first one */
1596                 if (chunk == list_first_entry(free_head, struct pcpu_chunk, list))
1597                         continue;
1598
1599                 list_move(&chunk->list, &to_free);
1600         }
1601
1602         spin_unlock_irq(&pcpu_lock);
1603
1604         list_for_each_entry_safe(chunk, next, &to_free, list) {
1605                 int rs, re;
1606
1607                 pcpu_for_each_pop_region(chunk->populated, rs, re, 0,
1608                                          chunk->nr_pages) {
1609                         pcpu_depopulate_chunk(chunk, rs, re);
1610                         spin_lock_irq(&pcpu_lock);
1611                         pcpu_chunk_depopulated(chunk, rs, re);
1612                         spin_unlock_irq(&pcpu_lock);
1613                 }
1614                 pcpu_destroy_chunk(chunk);
1615         }
1616
1617         /*
1618          * Ensure there are certain number of free populated pages for
1619          * atomic allocs.  Fill up from the most packed so that atomic
1620          * allocs don't increase fragmentation.  If atomic allocation
1621          * failed previously, always populate the maximum amount.  This
1622          * should prevent atomic allocs larger than PAGE_SIZE from keeping
1623          * failing indefinitely; however, large atomic allocs are not
1624          * something we support properly and can be highly unreliable and
1625          * inefficient.
1626          */
1627 retry_pop:
1628         if (pcpu_atomic_alloc_failed) {
1629                 nr_to_pop = PCPU_EMPTY_POP_PAGES_HIGH;
1630                 /* best effort anyway, don't worry about synchronization */
1631                 pcpu_atomic_alloc_failed = false;
1632         } else {
1633                 nr_to_pop = clamp(PCPU_EMPTY_POP_PAGES_HIGH -
1634                                   pcpu_nr_empty_pop_pages,
1635                                   0, PCPU_EMPTY_POP_PAGES_HIGH);
1636         }
1637
1638         for (slot = pcpu_size_to_slot(PAGE_SIZE); slot < pcpu_nr_slots; slot++) {
1639                 int nr_unpop = 0, rs, re;
1640
1641                 if (!nr_to_pop)
1642                         break;
1643
1644                 spin_lock_irq(&pcpu_lock);
1645                 list_for_each_entry(chunk, &pcpu_slot[slot], list) {
1646                         nr_unpop = chunk->nr_pages - chunk->nr_populated;
1647                         if (nr_unpop)
1648                                 break;
1649                 }
1650                 spin_unlock_irq(&pcpu_lock);
1651
1652                 if (!nr_unpop)
1653                         continue;
1654
1655                 /* @chunk can't go away while pcpu_alloc_mutex is held */
1656                 pcpu_for_each_unpop_region(chunk->populated, rs, re, 0,
1657                                            chunk->nr_pages) {
1658                         int nr = min(re - rs, nr_to_pop);
1659
1660                         ret = pcpu_populate_chunk(chunk, rs, rs + nr, gfp);
1661                         if (!ret) {
1662                                 nr_to_pop -= nr;
1663                                 spin_lock_irq(&pcpu_lock);
1664                                 pcpu_chunk_populated(chunk, rs, rs + nr, false);
1665                                 spin_unlock_irq(&pcpu_lock);
1666                         } else {
1667                                 nr_to_pop = 0;
1668                         }
1669
1670                         if (!nr_to_pop)
1671                                 break;
1672                 }
1673         }
1674
1675         if (nr_to_pop) {
1676                 /* ran out of chunks to populate, create a new one and retry */
1677                 chunk = pcpu_create_chunk(gfp);
1678                 if (chunk) {
1679                         spin_lock_irq(&pcpu_lock);
1680                         pcpu_chunk_relocate(chunk, -1);
1681                         spin_unlock_irq(&pcpu_lock);
1682                         goto retry_pop;
1683                 }
1684         }
1685
1686         mutex_unlock(&pcpu_alloc_mutex);
1687 }
1688
1689 /**
1690  * free_percpu - free percpu area
1691  * @ptr: pointer to area to free
1692  *
1693  * Free percpu area @ptr.
1694  *
1695  * CONTEXT:
1696  * Can be called from atomic context.
1697  */
1698 void free_percpu(void __percpu *ptr)
1699 {
1700         void *addr;
1701         struct pcpu_chunk *chunk;
1702         unsigned long flags;
1703         int off;
1704
1705         if (!ptr)
1706                 return;
1707
1708         kmemleak_free_percpu(ptr);
1709
1710         addr = __pcpu_ptr_to_addr(ptr);
1711
1712         spin_lock_irqsave(&pcpu_lock, flags);
1713
1714         chunk = pcpu_chunk_addr_search(addr);
1715         off = addr - chunk->base_addr;
1716
1717         pcpu_free_area(chunk, off);
1718
1719         /* if there are more than one fully free chunks, wake up grim reaper */
1720         if (chunk->free_bytes == pcpu_unit_size) {
1721                 struct pcpu_chunk *pos;
1722
1723                 list_for_each_entry(pos, &pcpu_slot[pcpu_nr_slots - 1], list)
1724                         if (pos != chunk) {
1725                                 pcpu_schedule_balance_work();
1726                                 break;
1727                         }
1728         }
1729
1730         trace_percpu_free_percpu(chunk->base_addr, off, ptr);
1731
1732         spin_unlock_irqrestore(&pcpu_lock, flags);
1733 }
1734 EXPORT_SYMBOL_GPL(free_percpu);
1735
1736 bool __is_kernel_percpu_address(unsigned long addr, unsigned long *can_addr)
1737 {
1738 #ifdef CONFIG_SMP
1739         const size_t static_size = __per_cpu_end - __per_cpu_start;
1740         void __percpu *base = __addr_to_pcpu_ptr(pcpu_base_addr);
1741         unsigned int cpu;
1742
1743         for_each_possible_cpu(cpu) {
1744                 void *start = per_cpu_ptr(base, cpu);
1745                 void *va = (void *)addr;
1746
1747                 if (va >= start && va < start + static_size) {
1748                         if (can_addr) {
1749                                 *can_addr = (unsigned long) (va - start);
1750                                 *can_addr += (unsigned long)
1751                                         per_cpu_ptr(base, get_boot_cpu_id());
1752                         }
1753                         return true;
1754                 }
1755         }
1756 #endif
1757         /* on UP, can't distinguish from other static vars, always false */
1758         return false;
1759 }
1760
1761 /**
1762  * is_kernel_percpu_address - test whether address is from static percpu area
1763  * @addr: address to test
1764  *
1765  * Test whether @addr belongs to in-kernel static percpu area.  Module
1766  * static percpu areas are not considered.  For those, use
1767  * is_module_percpu_address().
1768  *
1769  * RETURNS:
1770  * %true if @addr is from in-kernel static percpu area, %false otherwise.
1771  */
1772 bool is_kernel_percpu_address(unsigned long addr)
1773 {
1774         return __is_kernel_percpu_address(addr, NULL);
1775 }
1776
1777 /**
1778  * per_cpu_ptr_to_phys - convert translated percpu address to physical address
1779  * @addr: the address to be converted to physical address
1780  *
1781  * Given @addr which is dereferenceable address obtained via one of
1782  * percpu access macros, this function translates it into its physical
1783  * address.  The caller is responsible for ensuring @addr stays valid
1784  * until this function finishes.
1785  *
1786  * percpu allocator has special setup for the first chunk, which currently
1787  * supports either embedding in linear address space or vmalloc mapping,
1788  * and, from the second one, the backing allocator (currently either vm or
1789  * km) provides translation.
1790  *
1791  * The addr can be translated simply without checking if it falls into the
1792  * first chunk. But the current code reflects better how percpu allocator
1793  * actually works, and the verification can discover both bugs in percpu
1794  * allocator itself and per_cpu_ptr_to_phys() callers. So we keep current
1795  * code.
1796  *
1797  * RETURNS:
1798  * The physical address for @addr.
1799  */
1800 phys_addr_t per_cpu_ptr_to_phys(void *addr)
1801 {
1802         void __percpu *base = __addr_to_pcpu_ptr(pcpu_base_addr);
1803         bool in_first_chunk = false;
1804         unsigned long first_low, first_high;
1805         unsigned int cpu;
1806
1807         /*
1808          * The following test on unit_low/high isn't strictly
1809          * necessary but will speed up lookups of addresses which
1810          * aren't in the first chunk.
1811          *
1812          * The address check is against full chunk sizes.  pcpu_base_addr
1813          * points to the beginning of the first chunk including the
1814          * static region.  Assumes good intent as the first chunk may
1815          * not be full (ie. < pcpu_unit_pages in size).
1816          */
1817         first_low = (unsigned long)pcpu_base_addr +
1818                     pcpu_unit_page_offset(pcpu_low_unit_cpu, 0);
1819         first_high = (unsigned long)pcpu_base_addr +
1820                      pcpu_unit_page_offset(pcpu_high_unit_cpu, pcpu_unit_pages);
1821         if ((unsigned long)addr >= first_low &&
1822             (unsigned long)addr < first_high) {
1823                 for_each_possible_cpu(cpu) {
1824                         void *start = per_cpu_ptr(base, cpu);
1825
1826                         if (addr >= start && addr < start + pcpu_unit_size) {
1827                                 in_first_chunk = true;
1828                                 break;
1829                         }
1830                 }
1831         }
1832
1833         if (in_first_chunk) {
1834                 if (!is_vmalloc_addr(addr))
1835                         return __pa(addr);
1836                 else
1837                         return page_to_phys(vmalloc_to_page(addr)) +
1838                                offset_in_page(addr);
1839         } else
1840                 return page_to_phys(pcpu_addr_to_page(addr)) +
1841                        offset_in_page(addr);
1842 }
1843
1844 /**
1845  * pcpu_alloc_alloc_info - allocate percpu allocation info
1846  * @nr_groups: the number of groups
1847  * @nr_units: the number of units
1848  *
1849  * Allocate ai which is large enough for @nr_groups groups containing
1850  * @nr_units units.  The returned ai's groups[0].cpu_map points to the
1851  * cpu_map array which is long enough for @nr_units and filled with
1852  * NR_CPUS.  It's the caller's responsibility to initialize cpu_map
1853  * pointer of other groups.
1854  *
1855  * RETURNS:
1856  * Pointer to the allocated pcpu_alloc_info on success, NULL on
1857  * failure.
1858  */
1859 struct pcpu_alloc_info * __init pcpu_alloc_alloc_info(int nr_groups,
1860                                                       int nr_units)
1861 {
1862         struct pcpu_alloc_info *ai;
1863         size_t base_size, ai_size;
1864         void *ptr;
1865         int unit;
1866
1867         base_size = ALIGN(sizeof(*ai) + nr_groups * sizeof(ai->groups[0]),
1868                           __alignof__(ai->groups[0].cpu_map[0]));
1869         ai_size = base_size + nr_units * sizeof(ai->groups[0].cpu_map[0]);
1870
1871         ptr = memblock_virt_alloc_nopanic(PFN_ALIGN(ai_size), 0);
1872         if (!ptr)
1873                 return NULL;
1874         ai = ptr;
1875         ptr += base_size;
1876
1877         ai->groups[0].cpu_map = ptr;
1878
1879         for (unit = 0; unit < nr_units; unit++)
1880                 ai->groups[0].cpu_map[unit] = NR_CPUS;
1881
1882         ai->nr_groups = nr_groups;
1883         ai->__ai_size = PFN_ALIGN(ai_size);
1884
1885         return ai;
1886 }
1887
1888 /**
1889  * pcpu_free_alloc_info - free percpu allocation info
1890  * @ai: pcpu_alloc_info to free
1891  *
1892  * Free @ai which was allocated by pcpu_alloc_alloc_info().
1893  */
1894 void __init pcpu_free_alloc_info(struct pcpu_alloc_info *ai)
1895 {
1896         memblock_free_early(__pa(ai), ai->__ai_size);
1897 }
1898
1899 /**
1900  * pcpu_dump_alloc_info - print out information about pcpu_alloc_info
1901  * @lvl: loglevel
1902  * @ai: allocation info to dump
1903  *
1904  * Print out information about @ai using loglevel @lvl.
1905  */
1906 static void pcpu_dump_alloc_info(const char *lvl,
1907                                  const struct pcpu_alloc_info *ai)
1908 {
1909         int group_width = 1, cpu_width = 1, width;
1910         char empty_str[] = "--------";
1911         int alloc = 0, alloc_end = 0;
1912         int group, v;
1913         int upa, apl;   /* units per alloc, allocs per line */
1914
1915         v = ai->nr_groups;
1916         while (v /= 10)
1917                 group_width++;
1918
1919         v = num_possible_cpus();
1920         while (v /= 10)
1921                 cpu_width++;
1922         empty_str[min_t(int, cpu_width, sizeof(empty_str) - 1)] = '\0';
1923
1924         upa = ai->alloc_size / ai->unit_size;
1925         width = upa * (cpu_width + 1) + group_width + 3;
1926         apl = rounddown_pow_of_two(max(60 / width, 1));
1927
1928         printk("%spcpu-alloc: s%zu r%zu d%zu u%zu alloc=%zu*%zu",
1929                lvl, ai->static_size, ai->reserved_size, ai->dyn_size,
1930                ai->unit_size, ai->alloc_size / ai->atom_size, ai->atom_size);
1931
1932         for (group = 0; group < ai->nr_groups; group++) {
1933                 const struct pcpu_group_info *gi = &ai->groups[group];
1934                 int unit = 0, unit_end = 0;
1935
1936                 BUG_ON(gi->nr_units % upa);
1937                 for (alloc_end += gi->nr_units / upa;
1938                      alloc < alloc_end; alloc++) {
1939                         if (!(alloc % apl)) {
1940                                 pr_cont("\n");
1941                                 printk("%spcpu-alloc: ", lvl);
1942                         }
1943                         pr_cont("[%0*d] ", group_width, group);
1944
1945                         for (unit_end += upa; unit < unit_end; unit++)
1946                                 if (gi->cpu_map[unit] != NR_CPUS)
1947                                         pr_cont("%0*d ",
1948                                                 cpu_width, gi->cpu_map[unit]);
1949                                 else
1950                                         pr_cont("%s ", empty_str);
1951                 }
1952         }
1953         pr_cont("\n");
1954 }
1955
1956 /**
1957  * pcpu_setup_first_chunk - initialize the first percpu chunk
1958  * @ai: pcpu_alloc_info describing how to percpu area is shaped
1959  * @base_addr: mapped address
1960  *
1961  * Initialize the first percpu chunk which contains the kernel static
1962  * perpcu area.  This function is to be called from arch percpu area
1963  * setup path.
1964  *
1965  * @ai contains all information necessary to initialize the first
1966  * chunk and prime the dynamic percpu allocator.
1967  *
1968  * @ai->static_size is the size of static percpu area.
1969  *
1970  * @ai->reserved_size, if non-zero, specifies the amount of bytes to
1971  * reserve after the static area in the first chunk.  This reserves
1972  * the first chunk such that it's available only through reserved
1973  * percpu allocation.  This is primarily used to serve module percpu
1974  * static areas on architectures where the addressing model has
1975  * limited offset range for symbol relocations to guarantee module
1976  * percpu symbols fall inside the relocatable range.
1977  *
1978  * @ai->dyn_size determines the number of bytes available for dynamic
1979  * allocation in the first chunk.  The area between @ai->static_size +
1980  * @ai->reserved_size + @ai->dyn_size and @ai->unit_size is unused.
1981  *
1982  * @ai->unit_size specifies unit size and must be aligned to PAGE_SIZE
1983  * and equal to or larger than @ai->static_size + @ai->reserved_size +
1984  * @ai->dyn_size.
1985  *
1986  * @ai->atom_size is the allocation atom size and used as alignment
1987  * for vm areas.
1988  *
1989  * @ai->alloc_size is the allocation size and always multiple of
1990  * @ai->atom_size.  This is larger than @ai->atom_size if
1991  * @ai->unit_size is larger than @ai->atom_size.
1992  *
1993  * @ai->nr_groups and @ai->groups describe virtual memory layout of
1994  * percpu areas.  Units which should be colocated are put into the
1995  * same group.  Dynamic VM areas will be allocated according to these
1996  * groupings.  If @ai->nr_groups is zero, a single group containing
1997  * all units is assumed.
1998  *
1999  * The caller should have mapped the first chunk at @base_addr and
2000  * copied static data to each unit.
2001  *
2002  * The first chunk will always contain a static and a dynamic region.
2003  * However, the static region is not managed by any chunk.  If the first
2004  * chunk also contains a reserved region, it is served by two chunks -
2005  * one for the reserved region and one for the dynamic region.  They
2006  * share the same vm, but use offset regions in the area allocation map.
2007  * The chunk serving the dynamic region is circulated in the chunk slots
2008  * and available for dynamic allocation like any other chunk.
2009  *
2010  * RETURNS:
2011  * 0 on success, -errno on failure.
2012  */
2013 int __init pcpu_setup_first_chunk(const struct pcpu_alloc_info *ai,
2014                                   void *base_addr)
2015 {
2016         size_t size_sum = ai->static_size + ai->reserved_size + ai->dyn_size;
2017         size_t static_size, dyn_size;
2018         struct pcpu_chunk *chunk;
2019         unsigned long *group_offsets;
2020         size_t *group_sizes;
2021         unsigned long *unit_off;
2022         unsigned int cpu;
2023         int *unit_map;
2024         int group, unit, i;
2025         int map_size;
2026         unsigned long tmp_addr;
2027
2028 #define PCPU_SETUP_BUG_ON(cond) do {                                    \
2029         if (unlikely(cond)) {                                           \
2030                 pr_emerg("failed to initialize, %s\n", #cond);          \
2031                 pr_emerg("cpu_possible_mask=%*pb\n",                    \
2032                          cpumask_pr_args(cpu_possible_mask));           \
2033                 pcpu_dump_alloc_info(KERN_EMERG, ai);                   \
2034                 BUG();                                                  \
2035         }                                                               \
2036 } while (0)
2037
2038         /* sanity checks */
2039         PCPU_SETUP_BUG_ON(ai->nr_groups <= 0);
2040 #ifdef CONFIG_SMP
2041         PCPU_SETUP_BUG_ON(!ai->static_size);
2042         PCPU_SETUP_BUG_ON(offset_in_page(__per_cpu_start));
2043 #endif
2044         PCPU_SETUP_BUG_ON(!base_addr);
2045         PCPU_SETUP_BUG_ON(offset_in_page(base_addr));
2046         PCPU_SETUP_BUG_ON(ai->unit_size < size_sum);
2047         PCPU_SETUP_BUG_ON(offset_in_page(ai->unit_size));
2048         PCPU_SETUP_BUG_ON(ai->unit_size < PCPU_MIN_UNIT_SIZE);
2049         PCPU_SETUP_BUG_ON(!IS_ALIGNED(ai->unit_size, PCPU_BITMAP_BLOCK_SIZE));
2050         PCPU_SETUP_BUG_ON(ai->dyn_size < PERCPU_DYNAMIC_EARLY_SIZE);
2051         PCPU_SETUP_BUG_ON(!ai->dyn_size);
2052         PCPU_SETUP_BUG_ON(!IS_ALIGNED(ai->reserved_size, PCPU_MIN_ALLOC_SIZE));
2053         PCPU_SETUP_BUG_ON(!(IS_ALIGNED(PCPU_BITMAP_BLOCK_SIZE, PAGE_SIZE) ||
2054                             IS_ALIGNED(PAGE_SIZE, PCPU_BITMAP_BLOCK_SIZE)));
2055         PCPU_SETUP_BUG_ON(pcpu_verify_alloc_info(ai) < 0);
2056
2057         /* process group information and build config tables accordingly */
2058         group_offsets = memblock_virt_alloc(ai->nr_groups *
2059                                              sizeof(group_offsets[0]), 0);
2060         group_sizes = memblock_virt_alloc(ai->nr_groups *
2061                                            sizeof(group_sizes[0]), 0);
2062         unit_map = memblock_virt_alloc(nr_cpu_ids * sizeof(unit_map[0]), 0);
2063         unit_off = memblock_virt_alloc(nr_cpu_ids * sizeof(unit_off[0]), 0);
2064
2065         for (cpu = 0; cpu < nr_cpu_ids; cpu++)
2066                 unit_map[cpu] = UINT_MAX;
2067
2068         pcpu_low_unit_cpu = NR_CPUS;
2069         pcpu_high_unit_cpu = NR_CPUS;
2070
2071         for (group = 0, unit = 0; group < ai->nr_groups; group++, unit += i) {
2072                 const struct pcpu_group_info *gi = &ai->groups[group];
2073
2074                 group_offsets[group] = gi->base_offset;
2075                 group_sizes[group] = gi->nr_units * ai->unit_size;
2076
2077                 for (i = 0; i < gi->nr_units; i++) {
2078                         cpu = gi->cpu_map[i];
2079                         if (cpu == NR_CPUS)
2080                                 continue;
2081
2082                         PCPU_SETUP_BUG_ON(cpu >= nr_cpu_ids);
2083                         PCPU_SETUP_BUG_ON(!cpu_possible(cpu));
2084                         PCPU_SETUP_BUG_ON(unit_map[cpu] != UINT_MAX);
2085
2086                         unit_map[cpu] = unit + i;
2087                         unit_off[cpu] = gi->base_offset + i * ai->unit_size;
2088
2089                         /* determine low/high unit_cpu */
2090                         if (pcpu_low_unit_cpu == NR_CPUS ||
2091                             unit_off[cpu] < unit_off[pcpu_low_unit_cpu])
2092                                 pcpu_low_unit_cpu = cpu;
2093                         if (pcpu_high_unit_cpu == NR_CPUS ||
2094                             unit_off[cpu] > unit_off[pcpu_high_unit_cpu])
2095                                 pcpu_high_unit_cpu = cpu;
2096                 }
2097         }
2098         pcpu_nr_units = unit;
2099
2100         for_each_possible_cpu(cpu)
2101                 PCPU_SETUP_BUG_ON(unit_map[cpu] == UINT_MAX);
2102
2103         /* we're done parsing the input, undefine BUG macro and dump config */
2104 #undef PCPU_SETUP_BUG_ON
2105         pcpu_dump_alloc_info(KERN_DEBUG, ai);
2106
2107         pcpu_nr_groups = ai->nr_groups;
2108         pcpu_group_offsets = group_offsets;
2109         pcpu_group_sizes = group_sizes;
2110         pcpu_unit_map = unit_map;
2111         pcpu_unit_offsets = unit_off;
2112
2113         /* determine basic parameters */
2114         pcpu_unit_pages = ai->unit_size >> PAGE_SHIFT;
2115         pcpu_unit_size = pcpu_unit_pages << PAGE_SHIFT;
2116         pcpu_atom_size = ai->atom_size;
2117         pcpu_chunk_struct_size = sizeof(struct pcpu_chunk) +
2118                 BITS_TO_LONGS(pcpu_unit_pages) * sizeof(unsigned long);
2119
2120         pcpu_stats_save_ai(ai);
2121
2122         /*
2123          * Allocate chunk slots.  The additional last slot is for
2124          * empty chunks.
2125          */
2126         pcpu_nr_slots = __pcpu_size_to_slot(pcpu_unit_size) + 2;
2127         pcpu_slot = memblock_virt_alloc(
2128                         pcpu_nr_slots * sizeof(pcpu_slot[0]), 0);
2129         for (i = 0; i < pcpu_nr_slots; i++)
2130                 INIT_LIST_HEAD(&pcpu_slot[i]);
2131
2132         /*
2133          * The end of the static region needs to be aligned with the
2134          * minimum allocation size as this offsets the reserved and
2135          * dynamic region.  The first chunk ends page aligned by
2136          * expanding the dynamic region, therefore the dynamic region
2137          * can be shrunk to compensate while still staying above the
2138          * configured sizes.
2139          */
2140         static_size = ALIGN(ai->static_size, PCPU_MIN_ALLOC_SIZE);
2141         dyn_size = ai->dyn_size - (static_size - ai->static_size);
2142
2143         /*
2144          * Initialize first chunk.
2145          * If the reserved_size is non-zero, this initializes the reserved
2146          * chunk.  If the reserved_size is zero, the reserved chunk is NULL
2147          * and the dynamic region is initialized here.  The first chunk,
2148          * pcpu_first_chunk, will always point to the chunk that serves
2149          * the dynamic region.
2150          */
2151         tmp_addr = (unsigned long)base_addr + static_size;
2152         map_size = ai->reserved_size ?: dyn_size;
2153         chunk = pcpu_alloc_first_chunk(tmp_addr, map_size);
2154
2155         /* init dynamic chunk if necessary */
2156         if (ai->reserved_size) {
2157                 pcpu_reserved_chunk = chunk;
2158
2159                 tmp_addr = (unsigned long)base_addr + static_size +
2160                            ai->reserved_size;
2161                 map_size = dyn_size;
2162                 chunk = pcpu_alloc_first_chunk(tmp_addr, map_size);
2163         }
2164
2165         /* link the first chunk in */
2166         pcpu_first_chunk = chunk;
2167         pcpu_nr_empty_pop_pages = pcpu_first_chunk->nr_empty_pop_pages;
2168         pcpu_chunk_relocate(pcpu_first_chunk, -1);
2169
2170         pcpu_stats_chunk_alloc();
2171         trace_percpu_create_chunk(base_addr);
2172
2173         /* we're done */
2174         pcpu_base_addr = base_addr;
2175         return 0;
2176 }
2177
2178 #ifdef CONFIG_SMP
2179
2180 const char * const pcpu_fc_names[PCPU_FC_NR] __initconst = {
2181         [PCPU_FC_AUTO]  = "auto",
2182         [PCPU_FC_EMBED] = "embed",
2183         [PCPU_FC_PAGE]  = "page",
2184 };
2185
2186 enum pcpu_fc pcpu_chosen_fc __initdata = PCPU_FC_AUTO;
2187
2188 static int __init percpu_alloc_setup(char *str)
2189 {
2190         if (!str)
2191                 return -EINVAL;
2192
2193         if (0)
2194                 /* nada */;
2195 #ifdef CONFIG_NEED_PER_CPU_EMBED_FIRST_CHUNK
2196         else if (!strcmp(str, "embed"))
2197                 pcpu_chosen_fc = PCPU_FC_EMBED;
2198 #endif
2199 #ifdef CONFIG_NEED_PER_CPU_PAGE_FIRST_CHUNK
2200         else if (!strcmp(str, "page"))
2201                 pcpu_chosen_fc = PCPU_FC_PAGE;
2202 #endif
2203         else
2204                 pr_warn("unknown allocator %s specified\n", str);
2205
2206         return 0;
2207 }
2208 early_param("percpu_alloc", percpu_alloc_setup);
2209
2210 /*
2211  * pcpu_embed_first_chunk() is used by the generic percpu setup.
2212  * Build it if needed by the arch config or the generic setup is going
2213  * to be used.
2214  */
2215 #if defined(CONFIG_NEED_PER_CPU_EMBED_FIRST_CHUNK) || \
2216         !defined(CONFIG_HAVE_SETUP_PER_CPU_AREA)
2217 #define BUILD_EMBED_FIRST_CHUNK
2218 #endif
2219
2220 /* build pcpu_page_first_chunk() iff needed by the arch config */
2221 #if defined(CONFIG_NEED_PER_CPU_PAGE_FIRST_CHUNK)
2222 #define BUILD_PAGE_FIRST_CHUNK
2223 #endif
2224
2225 /* pcpu_build_alloc_info() is used by both embed and page first chunk */
2226 #if defined(BUILD_EMBED_FIRST_CHUNK) || defined(BUILD_PAGE_FIRST_CHUNK)
2227 /**
2228  * pcpu_build_alloc_info - build alloc_info considering distances between CPUs
2229  * @reserved_size: the size of reserved percpu area in bytes
2230  * @dyn_size: minimum free size for dynamic allocation in bytes
2231  * @atom_size: allocation atom size
2232  * @cpu_distance_fn: callback to determine distance between cpus, optional
2233  *
2234  * This function determines grouping of units, their mappings to cpus
2235  * and other parameters considering needed percpu size, allocation
2236  * atom size and distances between CPUs.
2237  *
2238  * Groups are always multiples of atom size and CPUs which are of
2239  * LOCAL_DISTANCE both ways are grouped together and share space for
2240  * units in the same group.  The returned configuration is guaranteed
2241  * to have CPUs on different nodes on different groups and >=75% usage
2242  * of allocated virtual address space.
2243  *
2244  * RETURNS:
2245  * On success, pointer to the new allocation_info is returned.  On
2246  * failure, ERR_PTR value is returned.
2247  */
2248 static struct pcpu_alloc_info * __init pcpu_build_alloc_info(
2249                                 size_t reserved_size, size_t dyn_size,
2250                                 size_t atom_size,
2251                                 pcpu_fc_cpu_distance_fn_t cpu_distance_fn)
2252 {
2253         static int group_map[NR_CPUS] __initdata;
2254         static int group_cnt[NR_CPUS] __initdata;
2255         const size_t static_size = __per_cpu_end - __per_cpu_start;
2256         int nr_groups = 1, nr_units = 0;
2257         size_t size_sum, min_unit_size, alloc_size;
2258         int upa, max_upa, uninitialized_var(best_upa);  /* units_per_alloc */
2259         int last_allocs, group, unit;
2260         unsigned int cpu, tcpu;
2261         struct pcpu_alloc_info *ai;
2262         unsigned int *cpu_map;
2263
2264         /* this function may be called multiple times */
2265         memset(group_map, 0, sizeof(group_map));
2266         memset(group_cnt, 0, sizeof(group_cnt));
2267
2268         /* calculate size_sum and ensure dyn_size is enough for early alloc */
2269         size_sum = PFN_ALIGN(static_size + reserved_size +
2270                             max_t(size_t, dyn_size, PERCPU_DYNAMIC_EARLY_SIZE));
2271         dyn_size = size_sum - static_size - reserved_size;
2272
2273         /*
2274          * Determine min_unit_size, alloc_size and max_upa such that
2275          * alloc_size is multiple of atom_size and is the smallest
2276          * which can accommodate 4k aligned segments which are equal to
2277          * or larger than min_unit_size.
2278          */
2279         min_unit_size = max_t(size_t, size_sum, PCPU_MIN_UNIT_SIZE);
2280
2281         /* determine the maximum # of units that can fit in an allocation */
2282         alloc_size = roundup(min_unit_size, atom_size);
2283         upa = alloc_size / min_unit_size;
2284         while (alloc_size % upa || (offset_in_page(alloc_size / upa)))
2285                 upa--;
2286         max_upa = upa;
2287
2288         /* group cpus according to their proximity */
2289         for_each_possible_cpu(cpu) {
2290                 group = 0;
2291         next_group:
2292                 for_each_possible_cpu(tcpu) {
2293                         if (cpu == tcpu)
2294                                 break;
2295                         if (group_map[tcpu] == group && cpu_distance_fn &&
2296                             (cpu_distance_fn(cpu, tcpu) > LOCAL_DISTANCE ||
2297                              cpu_distance_fn(tcpu, cpu) > LOCAL_DISTANCE)) {
2298                                 group++;
2299                                 nr_groups = max(nr_groups, group + 1);
2300                                 goto next_group;
2301                         }
2302                 }
2303                 group_map[cpu] = group;
2304                 group_cnt[group]++;
2305         }
2306
2307         /*
2308          * Wasted space is caused by a ratio imbalance of upa to group_cnt.
2309          * Expand the unit_size until we use >= 75% of the units allocated.
2310          * Related to atom_size, which could be much larger than the unit_size.
2311          */
2312         last_allocs = INT_MAX;
2313         for (upa = max_upa; upa; upa--) {
2314                 int allocs = 0, wasted = 0;
2315
2316                 if (alloc_size % upa || (offset_in_page(alloc_size / upa)))
2317                         continue;
2318
2319                 for (group = 0; group < nr_groups; group++) {
2320                         int this_allocs = DIV_ROUND_UP(group_cnt[group], upa);
2321                         allocs += this_allocs;
2322                         wasted += this_allocs * upa - group_cnt[group];
2323                 }
2324
2325                 /*
2326                  * Don't accept if wastage is over 1/3.  The
2327                  * greater-than comparison ensures upa==1 always
2328                  * passes the following check.
2329                  */
2330                 if (wasted > num_possible_cpus() / 3)
2331                         continue;
2332
2333                 /* and then don't consume more memory */
2334                 if (allocs > last_allocs)
2335                         break;
2336                 last_allocs = allocs;
2337                 best_upa = upa;
2338         }
2339         upa = best_upa;
2340
2341         /* allocate and fill alloc_info */
2342         for (group = 0; group < nr_groups; group++)
2343                 nr_units += roundup(group_cnt[group], upa);
2344
2345         ai = pcpu_alloc_alloc_info(nr_groups, nr_units);
2346         if (!ai)
2347                 return ERR_PTR(-ENOMEM);
2348         cpu_map = ai->groups[0].cpu_map;
2349
2350         for (group = 0; group < nr_groups; group++) {
2351                 ai->groups[group].cpu_map = cpu_map;
2352                 cpu_map += roundup(group_cnt[group], upa);
2353         }
2354
2355         ai->static_size = static_size;
2356         ai->reserved_size = reserved_size;
2357         ai->dyn_size = dyn_size;
2358         ai->unit_size = alloc_size / upa;
2359         ai->atom_size = atom_size;
2360         ai->alloc_size = alloc_size;
2361
2362         for (group = 0, unit = 0; group_cnt[group]; group++) {
2363                 struct pcpu_group_info *gi = &ai->groups[group];
2364
2365                 /*
2366                  * Initialize base_offset as if all groups are located
2367                  * back-to-back.  The caller should update this to
2368                  * reflect actual allocation.
2369                  */
2370                 gi->base_offset = unit * ai->unit_size;
2371
2372                 for_each_possible_cpu(cpu)
2373                         if (group_map[cpu] == group)
2374                                 gi->cpu_map[gi->nr_units++] = cpu;
2375                 gi->nr_units = roundup(gi->nr_units, upa);
2376                 unit += gi->nr_units;
2377         }
2378         BUG_ON(unit != nr_units);
2379
2380         return ai;
2381 }
2382 #endif /* BUILD_EMBED_FIRST_CHUNK || BUILD_PAGE_FIRST_CHUNK */
2383
2384 #if defined(BUILD_EMBED_FIRST_CHUNK)
2385 /**
2386  * pcpu_embed_first_chunk - embed the first percpu chunk into bootmem
2387  * @reserved_size: the size of reserved percpu area in bytes
2388  * @dyn_size: minimum free size for dynamic allocation in bytes
2389  * @atom_size: allocation atom size
2390  * @cpu_distance_fn: callback to determine distance between cpus, optional
2391  * @alloc_fn: function to allocate percpu page
2392  * @free_fn: function to free percpu page
2393  *
2394  * This is a helper to ease setting up embedded first percpu chunk and
2395  * can be called where pcpu_setup_first_chunk() is expected.
2396  *
2397  * If this function is used to setup the first chunk, it is allocated
2398  * by calling @alloc_fn and used as-is without being mapped into
2399  * vmalloc area.  Allocations are always whole multiples of @atom_size
2400  * aligned to @atom_size.
2401  *
2402  * This enables the first chunk to piggy back on the linear physical
2403  * mapping which often uses larger page size.  Please note that this
2404  * can result in very sparse cpu->unit mapping on NUMA machines thus
2405  * requiring large vmalloc address space.  Don't use this allocator if
2406  * vmalloc space is not orders of magnitude larger than distances
2407  * between node memory addresses (ie. 32bit NUMA machines).
2408  *
2409  * @dyn_size specifies the minimum dynamic area size.
2410  *
2411  * If the needed size is smaller than the minimum or specified unit
2412  * size, the leftover is returned using @free_fn.
2413  *
2414  * RETURNS:
2415  * 0 on success, -errno on failure.
2416  */
2417 int __init pcpu_embed_first_chunk(size_t reserved_size, size_t dyn_size,
2418                                   size_t atom_size,
2419                                   pcpu_fc_cpu_distance_fn_t cpu_distance_fn,
2420                                   pcpu_fc_alloc_fn_t alloc_fn,
2421                                   pcpu_fc_free_fn_t free_fn)
2422 {
2423         void *base = (void *)ULONG_MAX;
2424         void **areas = NULL;
2425         struct pcpu_alloc_info *ai;
2426         size_t size_sum, areas_size;
2427         unsigned long max_distance;
2428         int group, i, highest_group, rc;
2429
2430         ai = pcpu_build_alloc_info(reserved_size, dyn_size, atom_size,
2431                                    cpu_distance_fn);
2432         if (IS_ERR(ai))
2433                 return PTR_ERR(ai);
2434
2435         size_sum = ai->static_size + ai->reserved_size + ai->dyn_size;
2436         areas_size = PFN_ALIGN(ai->nr_groups * sizeof(void *));
2437
2438         areas = memblock_virt_alloc_nopanic(areas_size, 0);
2439         if (!areas) {
2440                 rc = -ENOMEM;
2441                 goto out_free;
2442         }
2443
2444         /* allocate, copy and determine base address & max_distance */
2445         highest_group = 0;
2446         for (group = 0; group < ai->nr_groups; group++) {
2447                 struct pcpu_group_info *gi = &ai->groups[group];
2448                 unsigned int cpu = NR_CPUS;
2449                 void *ptr;
2450
2451                 for (i = 0; i < gi->nr_units && cpu == NR_CPUS; i++)
2452                         cpu = gi->cpu_map[i];
2453                 BUG_ON(cpu == NR_CPUS);
2454
2455                 /* allocate space for the whole group */
2456                 ptr = alloc_fn(cpu, gi->nr_units * ai->unit_size, atom_size);
2457                 if (!ptr) {
2458                         rc = -ENOMEM;
2459                         goto out_free_areas;
2460                 }
2461                 /* kmemleak tracks the percpu allocations separately */
2462                 kmemleak_free(ptr);
2463                 areas[group] = ptr;
2464
2465                 base = min(ptr, base);
2466                 if (ptr > areas[highest_group])
2467                         highest_group = group;
2468         }
2469         max_distance = areas[highest_group] - base;
2470         max_distance += ai->unit_size * ai->groups[highest_group].nr_units;
2471
2472         /* warn if maximum distance is further than 75% of vmalloc space */
2473         if (max_distance > VMALLOC_TOTAL * 3 / 4) {
2474                 pr_warn("max_distance=0x%lx too large for vmalloc space 0x%lx\n",
2475                                 max_distance, VMALLOC_TOTAL);
2476 #ifdef CONFIG_NEED_PER_CPU_PAGE_FIRST_CHUNK
2477                 /* and fail if we have fallback */
2478                 rc = -EINVAL;
2479                 goto out_free_areas;
2480 #endif
2481         }
2482
2483         /*
2484          * Copy data and free unused parts.  This should happen after all
2485          * allocations are complete; otherwise, we may end up with
2486          * overlapping groups.
2487          */
2488         for (group = 0; group < ai->nr_groups; group++) {
2489                 struct pcpu_group_info *gi = &ai->groups[group];
2490                 void *ptr = areas[group];
2491
2492                 for (i = 0; i < gi->nr_units; i++, ptr += ai->unit_size) {
2493                         if (gi->cpu_map[i] == NR_CPUS) {
2494                                 /* unused unit, free whole */
2495                                 free_fn(ptr, ai->unit_size);
2496                                 continue;
2497                         }
2498                         /* copy and return the unused part */
2499                         memcpy(ptr, __per_cpu_load, ai->static_size);
2500                         free_fn(ptr + size_sum, ai->unit_size - size_sum);
2501                 }
2502         }
2503
2504         /* base address is now known, determine group base offsets */
2505         for (group = 0; group < ai->nr_groups; group++) {
2506                 ai->groups[group].base_offset = areas[group] - base;
2507         }
2508
2509         pr_info("Embedded %zu pages/cpu @%p s%zu r%zu d%zu u%zu\n",
2510                 PFN_DOWN(size_sum), base, ai->static_size, ai->reserved_size,
2511                 ai->dyn_size, ai->unit_size);
2512
2513         rc = pcpu_setup_first_chunk(ai, base);
2514         goto out_free;
2515
2516 out_free_areas:
2517         for (group = 0; group < ai->nr_groups; group++)
2518                 if (areas[group])
2519                         free_fn(areas[group],
2520                                 ai->groups[group].nr_units * ai->unit_size);
2521 out_free:
2522         pcpu_free_alloc_info(ai);
2523         if (areas)
2524                 memblock_free_early(__pa(areas), areas_size);
2525         return rc;
2526 }
2527 #endif /* BUILD_EMBED_FIRST_CHUNK */
2528
2529 #ifdef BUILD_PAGE_FIRST_CHUNK
2530 /**
2531  * pcpu_page_first_chunk - map the first chunk using PAGE_SIZE pages
2532  * @reserved_size: the size of reserved percpu area in bytes
2533  * @alloc_fn: function to allocate percpu page, always called with PAGE_SIZE
2534  * @free_fn: function to free percpu page, always called with PAGE_SIZE
2535  * @populate_pte_fn: function to populate pte
2536  *
2537  * This is a helper to ease setting up page-remapped first percpu
2538  * chunk and can be called where pcpu_setup_first_chunk() is expected.
2539  *
2540  * This is the basic allocator.  Static percpu area is allocated
2541  * page-by-page into vmalloc area.
2542  *
2543  * RETURNS:
2544  * 0 on success, -errno on failure.
2545  */
2546 int __init pcpu_page_first_chunk(size_t reserved_size,
2547                                  pcpu_fc_alloc_fn_t alloc_fn,
2548                                  pcpu_fc_free_fn_t free_fn,
2549                                  pcpu_fc_populate_pte_fn_t populate_pte_fn)
2550 {
2551         static struct vm_struct vm;
2552         struct pcpu_alloc_info *ai;
2553         char psize_str[16];
2554         int unit_pages;
2555         size_t pages_size;
2556         struct page **pages;
2557         int unit, i, j, rc;
2558         int upa;
2559         int nr_g0_units;
2560
2561         snprintf(psize_str, sizeof(psize_str), "%luK", PAGE_SIZE >> 10);
2562
2563         ai = pcpu_build_alloc_info(reserved_size, 0, PAGE_SIZE, NULL);
2564         if (IS_ERR(ai))
2565                 return PTR_ERR(ai);
2566         BUG_ON(ai->nr_groups != 1);
2567         upa = ai->alloc_size/ai->unit_size;
2568         nr_g0_units = roundup(num_possible_cpus(), upa);
2569         if (unlikely(WARN_ON(ai->groups[0].nr_units != nr_g0_units))) {
2570                 pcpu_free_alloc_info(ai);
2571                 return -EINVAL;
2572         }
2573
2574         unit_pages = ai->unit_size >> PAGE_SHIFT;
2575
2576         /* unaligned allocations can't be freed, round up to page size */
2577         pages_size = PFN_ALIGN(unit_pages * num_possible_cpus() *
2578                                sizeof(pages[0]));
2579         pages = memblock_virt_alloc(pages_size, 0);
2580
2581         /* allocate pages */
2582         j = 0;
2583         for (unit = 0; unit < num_possible_cpus(); unit++) {
2584                 unsigned int cpu = ai->groups[0].cpu_map[unit];
2585                 for (i = 0; i < unit_pages; i++) {
2586                         void *ptr;
2587
2588                         ptr = alloc_fn(cpu, PAGE_SIZE, PAGE_SIZE);
2589                         if (!ptr) {
2590                                 pr_warn("failed to allocate %s page for cpu%u\n",
2591                                                 psize_str, cpu);
2592                                 goto enomem;
2593                         }
2594                         /* kmemleak tracks the percpu allocations separately */
2595                         kmemleak_free(ptr);
2596                         pages[j++] = virt_to_page(ptr);
2597                 }
2598         }
2599
2600         /* allocate vm area, map the pages and copy static data */
2601         vm.flags = VM_ALLOC;
2602         vm.size = num_possible_cpus() * ai->unit_size;
2603         vm_area_register_early(&vm, PAGE_SIZE);
2604
2605         for (unit = 0; unit < num_possible_cpus(); unit++) {
2606                 unsigned long unit_addr =
2607                         (unsigned long)vm.addr + unit * ai->unit_size;
2608
2609                 for (i = 0; i < unit_pages; i++)
2610                         populate_pte_fn(unit_addr + (i << PAGE_SHIFT));
2611
2612                 /* pte already populated, the following shouldn't fail */
2613                 rc = __pcpu_map_pages(unit_addr, &pages[unit * unit_pages],
2614                                       unit_pages);
2615                 if (rc < 0)
2616                         panic("failed to map percpu area, err=%d\n", rc);
2617
2618                 /*
2619                  * FIXME: Archs with virtual cache should flush local
2620                  * cache for the linear mapping here - something
2621                  * equivalent to flush_cache_vmap() on the local cpu.
2622                  * flush_cache_vmap() can't be used as most supporting
2623                  * data structures are not set up yet.
2624                  */
2625
2626                 /* copy static data */
2627                 memcpy((void *)unit_addr, __per_cpu_load, ai->static_size);
2628         }
2629
2630         /* we're ready, commit */
2631         pr_info("%d %s pages/cpu @%p s%zu r%zu d%zu\n",
2632                 unit_pages, psize_str, vm.addr, ai->static_size,
2633                 ai->reserved_size, ai->dyn_size);
2634
2635         rc = pcpu_setup_first_chunk(ai, vm.addr);
2636         goto out_free_ar;
2637
2638 enomem:
2639         while (--j >= 0)
2640                 free_fn(page_address(pages[j]), PAGE_SIZE);
2641         rc = -ENOMEM;
2642 out_free_ar:
2643         memblock_free_early(__pa(pages), pages_size);
2644         pcpu_free_alloc_info(ai);
2645         return rc;
2646 }
2647 #endif /* BUILD_PAGE_FIRST_CHUNK */
2648
2649 #ifndef CONFIG_HAVE_SETUP_PER_CPU_AREA
2650 /*
2651  * Generic SMP percpu area setup.
2652  *
2653  * The embedding helper is used because its behavior closely resembles
2654  * the original non-dynamic generic percpu area setup.  This is
2655  * important because many archs have addressing restrictions and might
2656  * fail if the percpu area is located far away from the previous
2657  * location.  As an added bonus, in non-NUMA cases, embedding is
2658  * generally a good idea TLB-wise because percpu area can piggy back
2659  * on the physical linear memory mapping which uses large page
2660  * mappings on applicable archs.
2661  */
2662 unsigned long __per_cpu_offset[NR_CPUS] __read_mostly;
2663 EXPORT_SYMBOL(__per_cpu_offset);
2664
2665 static void * __init pcpu_dfl_fc_alloc(unsigned int cpu, size_t size,
2666                                        size_t align)
2667 {
2668         return  memblock_virt_alloc_from_nopanic(
2669                         size, align, __pa(MAX_DMA_ADDRESS));
2670 }
2671
2672 static void __init pcpu_dfl_fc_free(void *ptr, size_t size)
2673 {
2674         memblock_free_early(__pa(ptr), size);
2675 }
2676
2677 void __init setup_per_cpu_areas(void)
2678 {
2679         unsigned long delta;
2680         unsigned int cpu;
2681         int rc;
2682
2683         /*
2684          * Always reserve area for module percpu variables.  That's
2685          * what the legacy allocator did.
2686          */
2687         rc = pcpu_embed_first_chunk(PERCPU_MODULE_RESERVE,
2688                                     PERCPU_DYNAMIC_RESERVE, PAGE_SIZE, NULL,
2689                                     pcpu_dfl_fc_alloc, pcpu_dfl_fc_free);
2690         if (rc < 0)
2691                 panic("Failed to initialize percpu areas.");
2692
2693         delta = (unsigned long)pcpu_base_addr - (unsigned long)__per_cpu_start;
2694         for_each_possible_cpu(cpu)
2695                 __per_cpu_offset[cpu] = delta + pcpu_unit_offsets[cpu];
2696 }
2697 #endif  /* CONFIG_HAVE_SETUP_PER_CPU_AREA */
2698
2699 #else   /* CONFIG_SMP */
2700
2701 /*
2702  * UP percpu area setup.
2703  *
2704  * UP always uses km-based percpu allocator with identity mapping.
2705  * Static percpu variables are indistinguishable from the usual static
2706  * variables and don't require any special preparation.
2707  */
2708 void __init setup_per_cpu_areas(void)
2709 {
2710         const size_t unit_size =
2711                 roundup_pow_of_two(max_t(size_t, PCPU_MIN_UNIT_SIZE,
2712                                          PERCPU_DYNAMIC_RESERVE));
2713         struct pcpu_alloc_info *ai;
2714         void *fc;
2715
2716         ai = pcpu_alloc_alloc_info(1, 1);
2717         fc = memblock_virt_alloc_from_nopanic(unit_size,
2718                                               PAGE_SIZE,
2719                                               __pa(MAX_DMA_ADDRESS));
2720         if (!ai || !fc)
2721                 panic("Failed to allocate memory for percpu areas.");
2722         /* kmemleak tracks the percpu allocations separately */
2723         kmemleak_free(fc);
2724
2725         ai->dyn_size = unit_size;
2726         ai->unit_size = unit_size;
2727         ai->atom_size = unit_size;
2728         ai->alloc_size = unit_size;
2729         ai->groups[0].nr_units = 1;
2730         ai->groups[0].cpu_map[0] = 0;
2731
2732         if (pcpu_setup_first_chunk(ai, fc) < 0)
2733                 panic("Failed to initialize percpu areas.");
2734 }
2735
2736 #endif  /* CONFIG_SMP */
2737
2738 /*
2739  * Percpu allocator is initialized early during boot when neither slab or
2740  * workqueue is available.  Plug async management until everything is up
2741  * and running.
2742  */
2743 static int __init percpu_enable_async(void)
2744 {
2745         pcpu_async_enabled = true;
2746         return 0;
2747 }
2748 subsys_initcall(percpu_enable_async);