mm/page_ext: resurrect struct page extending code for debugging
[cascardo/linux.git] / mm / page_ext.c
1 #include <linux/mm.h>
2 #include <linux/mmzone.h>
3 #include <linux/bootmem.h>
4 #include <linux/page_ext.h>
5 #include <linux/memory.h>
6 #include <linux/vmalloc.h>
7 #include <linux/kmemleak.h>
8
9 /*
10  * struct page extension
11  *
12  * This is the feature to manage memory for extended data per page.
13  *
14  * Until now, we must modify struct page itself to store extra data per page.
15  * This requires rebuilding the kernel and it is really time consuming process.
16  * And, sometimes, rebuild is impossible due to third party module dependency.
17  * At last, enlarging struct page could cause un-wanted system behaviour change.
18  *
19  * This feature is intended to overcome above mentioned problems. This feature
20  * allocates memory for extended data per page in certain place rather than
21  * the struct page itself. This memory can be accessed by the accessor
22  * functions provided by this code. During the boot process, it checks whether
23  * allocation of huge chunk of memory is needed or not. If not, it avoids
24  * allocating memory at all. With this advantage, we can include this feature
25  * into the kernel in default and can avoid rebuild and solve related problems.
26  *
27  * To help these things to work well, there are two callbacks for clients. One
28  * is the need callback which is mandatory if user wants to avoid useless
29  * memory allocation at boot-time. The other is optional, init callback, which
30  * is used to do proper initialization after memory is allocated.
31  *
32  * The need callback is used to decide whether extended memory allocation is
33  * needed or not. Sometimes users want to deactivate some features in this
34  * boot and extra memory would be unneccessary. In this case, to avoid
35  * allocating huge chunk of memory, each clients represent their need of
36  * extra memory through the need callback. If one of the need callbacks
37  * returns true, it means that someone needs extra memory so that
38  * page extension core should allocates memory for page extension. If
39  * none of need callbacks return true, memory isn't needed at all in this boot
40  * and page extension core can skip to allocate memory. As result,
41  * none of memory is wasted.
42  *
43  * The init callback is used to do proper initialization after page extension
44  * is completely initialized. In sparse memory system, extra memory is
45  * allocated some time later than memmap is allocated. In other words, lifetime
46  * of memory for page extension isn't same with memmap for struct page.
47  * Therefore, clients can't store extra data until page extension is
48  * initialized, even if pages are allocated and used freely. This could
49  * cause inadequate state of extra data per page, so, to prevent it, client
50  * can utilize this callback to initialize the state of it correctly.
51  */
52
53 static struct page_ext_operations *page_ext_ops[] = {
54 };
55
56 static unsigned long total_usage;
57
58 static bool __init invoke_need_callbacks(void)
59 {
60         int i;
61         int entries = ARRAY_SIZE(page_ext_ops);
62
63         for (i = 0; i < entries; i++) {
64                 if (page_ext_ops[i]->need && page_ext_ops[i]->need())
65                         return true;
66         }
67
68         return false;
69 }
70
71 static void __init invoke_init_callbacks(void)
72 {
73         int i;
74         int entries = ARRAY_SIZE(page_ext_ops);
75
76         for (i = 0; i < entries; i++) {
77                 if (page_ext_ops[i]->init)
78                         page_ext_ops[i]->init();
79         }
80 }
81
82 #if !defined(CONFIG_SPARSEMEM)
83
84
85 void __meminit pgdat_page_ext_init(struct pglist_data *pgdat)
86 {
87         pgdat->node_page_ext = NULL;
88 }
89
90 struct page_ext *lookup_page_ext(struct page *page)
91 {
92         unsigned long pfn = page_to_pfn(page);
93         unsigned long offset;
94         struct page_ext *base;
95
96         base = NODE_DATA(page_to_nid(page))->node_page_ext;
97 #ifdef CONFIG_DEBUG_VM
98         /*
99          * The sanity checks the page allocator does upon freeing a
100          * page can reach here before the page_ext arrays are
101          * allocated when feeding a range of pages to the allocator
102          * for the first time during bootup or memory hotplug.
103          */
104         if (unlikely(!base))
105                 return NULL;
106 #endif
107         offset = pfn - round_down(node_start_pfn(page_to_nid(page)),
108                                         MAX_ORDER_NR_PAGES);
109         return base + offset;
110 }
111
112 static int __init alloc_node_page_ext(int nid)
113 {
114         struct page_ext *base;
115         unsigned long table_size;
116         unsigned long nr_pages;
117
118         nr_pages = NODE_DATA(nid)->node_spanned_pages;
119         if (!nr_pages)
120                 return 0;
121
122         /*
123          * Need extra space if node range is not aligned with
124          * MAX_ORDER_NR_PAGES. When page allocator's buddy algorithm
125          * checks buddy's status, range could be out of exact node range.
126          */
127         if (!IS_ALIGNED(node_start_pfn(nid), MAX_ORDER_NR_PAGES) ||
128                 !IS_ALIGNED(node_end_pfn(nid), MAX_ORDER_NR_PAGES))
129                 nr_pages += MAX_ORDER_NR_PAGES;
130
131         table_size = sizeof(struct page_ext) * nr_pages;
132
133         base = memblock_virt_alloc_try_nid_nopanic(
134                         table_size, PAGE_SIZE, __pa(MAX_DMA_ADDRESS),
135                         BOOTMEM_ALLOC_ACCESSIBLE, nid);
136         if (!base)
137                 return -ENOMEM;
138         NODE_DATA(nid)->node_page_ext = base;
139         total_usage += table_size;
140         return 0;
141 }
142
143 void __init page_ext_init_flatmem(void)
144 {
145
146         int nid, fail;
147
148         if (!invoke_need_callbacks())
149                 return;
150
151         for_each_online_node(nid)  {
152                 fail = alloc_node_page_ext(nid);
153                 if (fail)
154                         goto fail;
155         }
156         pr_info("allocated %ld bytes of page_ext\n", total_usage);
157         invoke_init_callbacks();
158         return;
159
160 fail:
161         pr_crit("allocation of page_ext failed.\n");
162         panic("Out of memory");
163 }
164
165 #else /* CONFIG_FLAT_NODE_MEM_MAP */
166
167 struct page_ext *lookup_page_ext(struct page *page)
168 {
169         unsigned long pfn = page_to_pfn(page);
170         struct mem_section *section = __pfn_to_section(pfn);
171 #ifdef CONFIG_DEBUG_VM
172         /*
173          * The sanity checks the page allocator does upon freeing a
174          * page can reach here before the page_ext arrays are
175          * allocated when feeding a range of pages to the allocator
176          * for the first time during bootup or memory hotplug.
177          */
178         if (!section->page_ext)
179                 return NULL;
180 #endif
181         return section->page_ext + pfn;
182 }
183
184 static void *__meminit alloc_page_ext(size_t size, int nid)
185 {
186         gfp_t flags = GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN;
187         void *addr = NULL;
188
189         addr = alloc_pages_exact_nid(nid, size, flags);
190         if (addr) {
191                 kmemleak_alloc(addr, size, 1, flags);
192                 return addr;
193         }
194
195         if (node_state(nid, N_HIGH_MEMORY))
196                 addr = vzalloc_node(size, nid);
197         else
198                 addr = vzalloc(size);
199
200         return addr;
201 }
202
203 static int __meminit init_section_page_ext(unsigned long pfn, int nid)
204 {
205         struct mem_section *section;
206         struct page_ext *base;
207         unsigned long table_size;
208
209         section = __pfn_to_section(pfn);
210
211         if (section->page_ext)
212                 return 0;
213
214         table_size = sizeof(struct page_ext) * PAGES_PER_SECTION;
215         base = alloc_page_ext(table_size, nid);
216
217         /*
218          * The value stored in section->page_ext is (base - pfn)
219          * and it does not point to the memory block allocated above,
220          * causing kmemleak false positives.
221          */
222         kmemleak_not_leak(base);
223
224         if (!base) {
225                 pr_err("page ext allocation failure\n");
226                 return -ENOMEM;
227         }
228
229         /*
230          * The passed "pfn" may not be aligned to SECTION.  For the calculation
231          * we need to apply a mask.
232          */
233         pfn &= PAGE_SECTION_MASK;
234         section->page_ext = base - pfn;
235         total_usage += table_size;
236         return 0;
237 }
238 #ifdef CONFIG_MEMORY_HOTPLUG
239 static void free_page_ext(void *addr)
240 {
241         if (is_vmalloc_addr(addr)) {
242                 vfree(addr);
243         } else {
244                 struct page *page = virt_to_page(addr);
245                 size_t table_size;
246
247                 table_size = sizeof(struct page_ext) * PAGES_PER_SECTION;
248
249                 BUG_ON(PageReserved(page));
250                 free_pages_exact(addr, table_size);
251         }
252 }
253
254 static void __free_page_ext(unsigned long pfn)
255 {
256         struct mem_section *ms;
257         struct page_ext *base;
258
259         ms = __pfn_to_section(pfn);
260         if (!ms || !ms->page_ext)
261                 return;
262         base = ms->page_ext + pfn;
263         free_page_ext(base);
264         ms->page_ext = NULL;
265 }
266
267 static int __meminit online_page_ext(unsigned long start_pfn,
268                                 unsigned long nr_pages,
269                                 int nid)
270 {
271         unsigned long start, end, pfn;
272         int fail = 0;
273
274         start = SECTION_ALIGN_DOWN(start_pfn);
275         end = SECTION_ALIGN_UP(start_pfn + nr_pages);
276
277         if (nid == -1) {
278                 /*
279                  * In this case, "nid" already exists and contains valid memory.
280                  * "start_pfn" passed to us is a pfn which is an arg for
281                  * online__pages(), and start_pfn should exist.
282                  */
283                 nid = pfn_to_nid(start_pfn);
284                 VM_BUG_ON(!node_state(nid, N_ONLINE));
285         }
286
287         for (pfn = start; !fail && pfn < end; pfn += PAGES_PER_SECTION) {
288                 if (!pfn_present(pfn))
289                         continue;
290                 fail = init_section_page_ext(pfn, nid);
291         }
292         if (!fail)
293                 return 0;
294
295         /* rollback */
296         for (pfn = start; pfn < end; pfn += PAGES_PER_SECTION)
297                 __free_page_ext(pfn);
298
299         return -ENOMEM;
300 }
301
302 static int __meminit offline_page_ext(unsigned long start_pfn,
303                                 unsigned long nr_pages, int nid)
304 {
305         unsigned long start, end, pfn;
306
307         start = SECTION_ALIGN_DOWN(start_pfn);
308         end = SECTION_ALIGN_UP(start_pfn + nr_pages);
309
310         for (pfn = start; pfn < end; pfn += PAGES_PER_SECTION)
311                 __free_page_ext(pfn);
312         return 0;
313
314 }
315
316 static int __meminit page_ext_callback(struct notifier_block *self,
317                                unsigned long action, void *arg)
318 {
319         struct memory_notify *mn = arg;
320         int ret = 0;
321
322         switch (action) {
323         case MEM_GOING_ONLINE:
324                 ret = online_page_ext(mn->start_pfn,
325                                    mn->nr_pages, mn->status_change_nid);
326                 break;
327         case MEM_OFFLINE:
328                 offline_page_ext(mn->start_pfn,
329                                 mn->nr_pages, mn->status_change_nid);
330                 break;
331         case MEM_CANCEL_ONLINE:
332                 offline_page_ext(mn->start_pfn,
333                                 mn->nr_pages, mn->status_change_nid);
334                 break;
335         case MEM_GOING_OFFLINE:
336                 break;
337         case MEM_ONLINE:
338         case MEM_CANCEL_OFFLINE:
339                 break;
340         }
341
342         return notifier_from_errno(ret);
343 }
344
345 #endif
346
347 void __init page_ext_init(void)
348 {
349         unsigned long pfn;
350         int nid;
351
352         if (!invoke_need_callbacks())
353                 return;
354
355         for_each_node_state(nid, N_MEMORY) {
356                 unsigned long start_pfn, end_pfn;
357
358                 start_pfn = node_start_pfn(nid);
359                 end_pfn = node_end_pfn(nid);
360                 /*
361                  * start_pfn and end_pfn may not be aligned to SECTION and the
362                  * page->flags of out of node pages are not initialized.  So we
363                  * scan [start_pfn, the biggest section's pfn < end_pfn) here.
364                  */
365                 for (pfn = start_pfn; pfn < end_pfn;
366                         pfn = ALIGN(pfn + 1, PAGES_PER_SECTION)) {
367
368                         if (!pfn_valid(pfn))
369                                 continue;
370                         /*
371                          * Nodes's pfns can be overlapping.
372                          * We know some arch can have a nodes layout such as
373                          * -------------pfn-------------->
374                          * N0 | N1 | N2 | N0 | N1 | N2|....
375                          */
376                         if (pfn_to_nid(pfn) != nid)
377                                 continue;
378                         if (init_section_page_ext(pfn, nid))
379                                 goto oom;
380                 }
381         }
382         hotplug_memory_notifier(page_ext_callback, 0);
383         pr_info("allocated %ld bytes of page_ext\n", total_usage);
384         invoke_init_callbacks();
385         return;
386
387 oom:
388         panic("Out of memory");
389 }
390
391 void __meminit pgdat_page_ext_init(struct pglist_data *pgdat)
392 {
393 }
394
395 #endif