Loading...
1/*
2 * drivers/base/memory.c - basic Memory class support
3 *
4 * Written by Matt Tolentino <matthew.e.tolentino@intel.com>
5 * Dave Hansen <haveblue@us.ibm.com>
6 *
7 * This file provides the necessary infrastructure to represent
8 * a SPARSEMEM-memory-model system's physical memory in /sysfs.
9 * All arch-independent code that assumes MEMORY_HOTPLUG requires
10 * SPARSEMEM should be contained here, or in mm/memory_hotplug.c.
11 */
12
13#include <linux/sysdev.h>
14#include <linux/module.h>
15#include <linux/init.h>
16#include <linux/topology.h>
17#include <linux/capability.h>
18#include <linux/device.h>
19#include <linux/memory.h>
20#include <linux/kobject.h>
21#include <linux/memory_hotplug.h>
22#include <linux/mm.h>
23#include <linux/mutex.h>
24#include <linux/stat.h>
25#include <linux/slab.h>
26
27#include <linux/atomic.h>
28#include <asm/uaccess.h>
29
30static DEFINE_MUTEX(mem_sysfs_mutex);
31
32#define MEMORY_CLASS_NAME "memory"
33
34static int sections_per_block;
35
36static inline int base_memory_block_id(int section_nr)
37{
38 return section_nr / sections_per_block;
39}
40
41static struct sysdev_class memory_sysdev_class = {
42 .name = MEMORY_CLASS_NAME,
43};
44
45static const char *memory_uevent_name(struct kset *kset, struct kobject *kobj)
46{
47 return MEMORY_CLASS_NAME;
48}
49
50static int memory_uevent(struct kset *kset, struct kobject *obj,
51 struct kobj_uevent_env *env)
52{
53 int retval = 0;
54
55 return retval;
56}
57
58static const struct kset_uevent_ops memory_uevent_ops = {
59 .name = memory_uevent_name,
60 .uevent = memory_uevent,
61};
62
63static BLOCKING_NOTIFIER_HEAD(memory_chain);
64
65int register_memory_notifier(struct notifier_block *nb)
66{
67 return blocking_notifier_chain_register(&memory_chain, nb);
68}
69EXPORT_SYMBOL(register_memory_notifier);
70
71void unregister_memory_notifier(struct notifier_block *nb)
72{
73 blocking_notifier_chain_unregister(&memory_chain, nb);
74}
75EXPORT_SYMBOL(unregister_memory_notifier);
76
77static ATOMIC_NOTIFIER_HEAD(memory_isolate_chain);
78
79int register_memory_isolate_notifier(struct notifier_block *nb)
80{
81 return atomic_notifier_chain_register(&memory_isolate_chain, nb);
82}
83EXPORT_SYMBOL(register_memory_isolate_notifier);
84
85void unregister_memory_isolate_notifier(struct notifier_block *nb)
86{
87 atomic_notifier_chain_unregister(&memory_isolate_chain, nb);
88}
89EXPORT_SYMBOL(unregister_memory_isolate_notifier);
90
91/*
92 * register_memory - Setup a sysfs device for a memory block
93 */
94static
95int register_memory(struct memory_block *memory)
96{
97 int error;
98
99 memory->sysdev.cls = &memory_sysdev_class;
100 memory->sysdev.id = memory->start_section_nr / sections_per_block;
101
102 error = sysdev_register(&memory->sysdev);
103 return error;
104}
105
106static void
107unregister_memory(struct memory_block *memory)
108{
109 BUG_ON(memory->sysdev.cls != &memory_sysdev_class);
110
111 /* drop the ref. we got in remove_memory_block() */
112 kobject_put(&memory->sysdev.kobj);
113 sysdev_unregister(&memory->sysdev);
114}
115
116unsigned long __weak memory_block_size_bytes(void)
117{
118 return MIN_MEMORY_BLOCK_SIZE;
119}
120
121static unsigned long get_memory_block_size(void)
122{
123 unsigned long block_sz;
124
125 block_sz = memory_block_size_bytes();
126
127 /* Validate blk_sz is a power of 2 and not less than section size */
128 if ((block_sz & (block_sz - 1)) || (block_sz < MIN_MEMORY_BLOCK_SIZE)) {
129 WARN_ON(1);
130 block_sz = MIN_MEMORY_BLOCK_SIZE;
131 }
132
133 return block_sz;
134}
135
136/*
137 * use this as the physical section index that this memsection
138 * uses.
139 */
140
141static ssize_t show_mem_start_phys_index(struct sys_device *dev,
142 struct sysdev_attribute *attr, char *buf)
143{
144 struct memory_block *mem =
145 container_of(dev, struct memory_block, sysdev);
146 unsigned long phys_index;
147
148 phys_index = mem->start_section_nr / sections_per_block;
149 return sprintf(buf, "%08lx\n", phys_index);
150}
151
152static ssize_t show_mem_end_phys_index(struct sys_device *dev,
153 struct sysdev_attribute *attr, char *buf)
154{
155 struct memory_block *mem =
156 container_of(dev, struct memory_block, sysdev);
157 unsigned long phys_index;
158
159 phys_index = mem->end_section_nr / sections_per_block;
160 return sprintf(buf, "%08lx\n", phys_index);
161}
162
163/*
164 * Show whether the section of memory is likely to be hot-removable
165 */
166static ssize_t show_mem_removable(struct sys_device *dev,
167 struct sysdev_attribute *attr, char *buf)
168{
169 unsigned long i, pfn;
170 int ret = 1;
171 struct memory_block *mem =
172 container_of(dev, struct memory_block, sysdev);
173
174 for (i = 0; i < sections_per_block; i++) {
175 pfn = section_nr_to_pfn(mem->start_section_nr + i);
176 ret &= is_mem_section_removable(pfn, PAGES_PER_SECTION);
177 }
178
179 return sprintf(buf, "%d\n", ret);
180}
181
182/*
183 * online, offline, going offline, etc.
184 */
185static ssize_t show_mem_state(struct sys_device *dev,
186 struct sysdev_attribute *attr, char *buf)
187{
188 struct memory_block *mem =
189 container_of(dev, struct memory_block, sysdev);
190 ssize_t len = 0;
191
192 /*
193 * We can probably put these states in a nice little array
194 * so that they're not open-coded
195 */
196 switch (mem->state) {
197 case MEM_ONLINE:
198 len = sprintf(buf, "online\n");
199 break;
200 case MEM_OFFLINE:
201 len = sprintf(buf, "offline\n");
202 break;
203 case MEM_GOING_OFFLINE:
204 len = sprintf(buf, "going-offline\n");
205 break;
206 default:
207 len = sprintf(buf, "ERROR-UNKNOWN-%ld\n",
208 mem->state);
209 WARN_ON(1);
210 break;
211 }
212
213 return len;
214}
215
216int memory_notify(unsigned long val, void *v)
217{
218 return blocking_notifier_call_chain(&memory_chain, val, v);
219}
220
221int memory_isolate_notify(unsigned long val, void *v)
222{
223 return atomic_notifier_call_chain(&memory_isolate_chain, val, v);
224}
225
226/*
227 * MEMORY_HOTPLUG depends on SPARSEMEM in mm/Kconfig, so it is
228 * OK to have direct references to sparsemem variables in here.
229 */
230static int
231memory_block_action(unsigned long phys_index, unsigned long action)
232{
233 int i;
234 unsigned long start_pfn, start_paddr;
235 unsigned long nr_pages = PAGES_PER_SECTION * sections_per_block;
236 struct page *first_page;
237 int ret;
238
239 first_page = pfn_to_page(phys_index << PFN_SECTION_SHIFT);
240
241 /*
242 * The probe routines leave the pages reserved, just
243 * as the bootmem code does. Make sure they're still
244 * that way.
245 */
246 if (action == MEM_ONLINE) {
247 for (i = 0; i < nr_pages; i++) {
248 if (PageReserved(first_page+i))
249 continue;
250
251 printk(KERN_WARNING "section number %ld page number %d "
252 "not reserved, was it already online?\n",
253 phys_index, i);
254 return -EBUSY;
255 }
256 }
257
258 switch (action) {
259 case MEM_ONLINE:
260 start_pfn = page_to_pfn(first_page);
261 ret = online_pages(start_pfn, nr_pages);
262 break;
263 case MEM_OFFLINE:
264 start_paddr = page_to_pfn(first_page) << PAGE_SHIFT;
265 ret = remove_memory(start_paddr,
266 nr_pages << PAGE_SHIFT);
267 break;
268 default:
269 WARN(1, KERN_WARNING "%s(%ld, %ld) unknown action: "
270 "%ld\n", __func__, phys_index, action, action);
271 ret = -EINVAL;
272 }
273
274 return ret;
275}
276
277static int memory_block_change_state(struct memory_block *mem,
278 unsigned long to_state, unsigned long from_state_req)
279{
280 int ret = 0;
281
282 mutex_lock(&mem->state_mutex);
283
284 if (mem->state != from_state_req) {
285 ret = -EINVAL;
286 goto out;
287 }
288
289 if (to_state == MEM_OFFLINE)
290 mem->state = MEM_GOING_OFFLINE;
291
292 ret = memory_block_action(mem->start_section_nr, to_state);
293
294 if (ret)
295 mem->state = from_state_req;
296 else
297 mem->state = to_state;
298
299out:
300 mutex_unlock(&mem->state_mutex);
301 return ret;
302}
303
304static ssize_t
305store_mem_state(struct sys_device *dev,
306 struct sysdev_attribute *attr, const char *buf, size_t count)
307{
308 struct memory_block *mem;
309 int ret = -EINVAL;
310
311 mem = container_of(dev, struct memory_block, sysdev);
312
313 if (!strncmp(buf, "online", min((int)count, 6)))
314 ret = memory_block_change_state(mem, MEM_ONLINE, MEM_OFFLINE);
315 else if(!strncmp(buf, "offline", min((int)count, 7)))
316 ret = memory_block_change_state(mem, MEM_OFFLINE, MEM_ONLINE);
317
318 if (ret)
319 return ret;
320 return count;
321}
322
323/*
324 * phys_device is a bad name for this. What I really want
325 * is a way to differentiate between memory ranges that
326 * are part of physical devices that constitute
327 * a complete removable unit or fru.
328 * i.e. do these ranges belong to the same physical device,
329 * s.t. if I offline all of these sections I can then
330 * remove the physical device?
331 */
332static ssize_t show_phys_device(struct sys_device *dev,
333 struct sysdev_attribute *attr, char *buf)
334{
335 struct memory_block *mem =
336 container_of(dev, struct memory_block, sysdev);
337 return sprintf(buf, "%d\n", mem->phys_device);
338}
339
340static SYSDEV_ATTR(phys_index, 0444, show_mem_start_phys_index, NULL);
341static SYSDEV_ATTR(end_phys_index, 0444, show_mem_end_phys_index, NULL);
342static SYSDEV_ATTR(state, 0644, show_mem_state, store_mem_state);
343static SYSDEV_ATTR(phys_device, 0444, show_phys_device, NULL);
344static SYSDEV_ATTR(removable, 0444, show_mem_removable, NULL);
345
346#define mem_create_simple_file(mem, attr_name) \
347 sysdev_create_file(&mem->sysdev, &attr_##attr_name)
348#define mem_remove_simple_file(mem, attr_name) \
349 sysdev_remove_file(&mem->sysdev, &attr_##attr_name)
350
351/*
352 * Block size attribute stuff
353 */
354static ssize_t
355print_block_size(struct sysdev_class *class, struct sysdev_class_attribute *attr,
356 char *buf)
357{
358 return sprintf(buf, "%lx\n", get_memory_block_size());
359}
360
361static SYSDEV_CLASS_ATTR(block_size_bytes, 0444, print_block_size, NULL);
362
363static int block_size_init(void)
364{
365 return sysfs_create_file(&memory_sysdev_class.kset.kobj,
366 &attr_block_size_bytes.attr);
367}
368
369/*
370 * Some architectures will have custom drivers to do this, and
371 * will not need to do it from userspace. The fake hot-add code
372 * as well as ppc64 will do all of their discovery in userspace
373 * and will require this interface.
374 */
375#ifdef CONFIG_ARCH_MEMORY_PROBE
376static ssize_t
377memory_probe_store(struct class *class, struct class_attribute *attr,
378 const char *buf, size_t count)
379{
380 u64 phys_addr;
381 int nid;
382 int i, ret;
383
384 phys_addr = simple_strtoull(buf, NULL, 0);
385
386 for (i = 0; i < sections_per_block; i++) {
387 nid = memory_add_physaddr_to_nid(phys_addr);
388 ret = add_memory(nid, phys_addr,
389 PAGES_PER_SECTION << PAGE_SHIFT);
390 if (ret)
391 goto out;
392
393 phys_addr += MIN_MEMORY_BLOCK_SIZE;
394 }
395
396 ret = count;
397out:
398 return ret;
399}
400static CLASS_ATTR(probe, S_IWUSR, NULL, memory_probe_store);
401
402static int memory_probe_init(void)
403{
404 return sysfs_create_file(&memory_sysdev_class.kset.kobj,
405 &class_attr_probe.attr);
406}
407#else
408static inline int memory_probe_init(void)
409{
410 return 0;
411}
412#endif
413
414#ifdef CONFIG_MEMORY_FAILURE
415/*
416 * Support for offlining pages of memory
417 */
418
419/* Soft offline a page */
420static ssize_t
421store_soft_offline_page(struct class *class,
422 struct class_attribute *attr,
423 const char *buf, size_t count)
424{
425 int ret;
426 u64 pfn;
427 if (!capable(CAP_SYS_ADMIN))
428 return -EPERM;
429 if (strict_strtoull(buf, 0, &pfn) < 0)
430 return -EINVAL;
431 pfn >>= PAGE_SHIFT;
432 if (!pfn_valid(pfn))
433 return -ENXIO;
434 ret = soft_offline_page(pfn_to_page(pfn), 0);
435 return ret == 0 ? count : ret;
436}
437
438/* Forcibly offline a page, including killing processes. */
439static ssize_t
440store_hard_offline_page(struct class *class,
441 struct class_attribute *attr,
442 const char *buf, size_t count)
443{
444 int ret;
445 u64 pfn;
446 if (!capable(CAP_SYS_ADMIN))
447 return -EPERM;
448 if (strict_strtoull(buf, 0, &pfn) < 0)
449 return -EINVAL;
450 pfn >>= PAGE_SHIFT;
451 ret = __memory_failure(pfn, 0, 0);
452 return ret ? ret : count;
453}
454
455static CLASS_ATTR(soft_offline_page, 0644, NULL, store_soft_offline_page);
456static CLASS_ATTR(hard_offline_page, 0644, NULL, store_hard_offline_page);
457
458static __init int memory_fail_init(void)
459{
460 int err;
461
462 err = sysfs_create_file(&memory_sysdev_class.kset.kobj,
463 &class_attr_soft_offline_page.attr);
464 if (!err)
465 err = sysfs_create_file(&memory_sysdev_class.kset.kobj,
466 &class_attr_hard_offline_page.attr);
467 return err;
468}
469#else
470static inline int memory_fail_init(void)
471{
472 return 0;
473}
474#endif
475
476/*
477 * Note that phys_device is optional. It is here to allow for
478 * differentiation between which *physical* devices each
479 * section belongs to...
480 */
481int __weak arch_get_memory_phys_device(unsigned long start_pfn)
482{
483 return 0;
484}
485
486struct memory_block *find_memory_block_hinted(struct mem_section *section,
487 struct memory_block *hint)
488{
489 struct kobject *kobj;
490 struct sys_device *sysdev;
491 struct memory_block *mem;
492 char name[sizeof(MEMORY_CLASS_NAME) + 9 + 1];
493 int block_id = base_memory_block_id(__section_nr(section));
494
495 kobj = hint ? &hint->sysdev.kobj : NULL;
496
497 /*
498 * This only works because we know that section == sysdev->id
499 * slightly redundant with sysdev_register()
500 */
501 sprintf(&name[0], "%s%d", MEMORY_CLASS_NAME, block_id);
502
503 kobj = kset_find_obj_hinted(&memory_sysdev_class.kset, name, kobj);
504 if (!kobj)
505 return NULL;
506
507 sysdev = container_of(kobj, struct sys_device, kobj);
508 mem = container_of(sysdev, struct memory_block, sysdev);
509
510 return mem;
511}
512
513/*
514 * For now, we have a linear search to go find the appropriate
515 * memory_block corresponding to a particular phys_index. If
516 * this gets to be a real problem, we can always use a radix
517 * tree or something here.
518 *
519 * This could be made generic for all sysdev classes.
520 */
521struct memory_block *find_memory_block(struct mem_section *section)
522{
523 return find_memory_block_hinted(section, NULL);
524}
525
526static int init_memory_block(struct memory_block **memory,
527 struct mem_section *section, unsigned long state)
528{
529 struct memory_block *mem;
530 unsigned long start_pfn;
531 int scn_nr;
532 int ret = 0;
533
534 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
535 if (!mem)
536 return -ENOMEM;
537
538 scn_nr = __section_nr(section);
539 mem->start_section_nr =
540 base_memory_block_id(scn_nr) * sections_per_block;
541 mem->end_section_nr = mem->start_section_nr + sections_per_block - 1;
542 mem->state = state;
543 mem->section_count++;
544 mutex_init(&mem->state_mutex);
545 start_pfn = section_nr_to_pfn(mem->start_section_nr);
546 mem->phys_device = arch_get_memory_phys_device(start_pfn);
547
548 ret = register_memory(mem);
549 if (!ret)
550 ret = mem_create_simple_file(mem, phys_index);
551 if (!ret)
552 ret = mem_create_simple_file(mem, end_phys_index);
553 if (!ret)
554 ret = mem_create_simple_file(mem, state);
555 if (!ret)
556 ret = mem_create_simple_file(mem, phys_device);
557 if (!ret)
558 ret = mem_create_simple_file(mem, removable);
559
560 *memory = mem;
561 return ret;
562}
563
564static int add_memory_section(int nid, struct mem_section *section,
565 unsigned long state, enum mem_add_context context)
566{
567 struct memory_block *mem;
568 int ret = 0;
569
570 mutex_lock(&mem_sysfs_mutex);
571
572 mem = find_memory_block(section);
573 if (mem) {
574 mem->section_count++;
575 kobject_put(&mem->sysdev.kobj);
576 } else
577 ret = init_memory_block(&mem, section, state);
578
579 if (!ret) {
580 if (context == HOTPLUG &&
581 mem->section_count == sections_per_block)
582 ret = register_mem_sect_under_node(mem, nid);
583 }
584
585 mutex_unlock(&mem_sysfs_mutex);
586 return ret;
587}
588
589int remove_memory_block(unsigned long node_id, struct mem_section *section,
590 int phys_device)
591{
592 struct memory_block *mem;
593
594 mutex_lock(&mem_sysfs_mutex);
595 mem = find_memory_block(section);
596 unregister_mem_sect_under_nodes(mem, __section_nr(section));
597
598 mem->section_count--;
599 if (mem->section_count == 0) {
600 mem_remove_simple_file(mem, phys_index);
601 mem_remove_simple_file(mem, end_phys_index);
602 mem_remove_simple_file(mem, state);
603 mem_remove_simple_file(mem, phys_device);
604 mem_remove_simple_file(mem, removable);
605 unregister_memory(mem);
606 kfree(mem);
607 } else
608 kobject_put(&mem->sysdev.kobj);
609
610 mutex_unlock(&mem_sysfs_mutex);
611 return 0;
612}
613
614/*
615 * need an interface for the VM to add new memory regions,
616 * but without onlining it.
617 */
618int register_new_memory(int nid, struct mem_section *section)
619{
620 return add_memory_section(nid, section, MEM_OFFLINE, HOTPLUG);
621}
622
623int unregister_memory_section(struct mem_section *section)
624{
625 if (!present_section(section))
626 return -EINVAL;
627
628 return remove_memory_block(0, section, 0);
629}
630
631/*
632 * Initialize the sysfs support for memory devices...
633 */
634int __init memory_dev_init(void)
635{
636 unsigned int i;
637 int ret;
638 int err;
639 unsigned long block_sz;
640
641 memory_sysdev_class.kset.uevent_ops = &memory_uevent_ops;
642 ret = sysdev_class_register(&memory_sysdev_class);
643 if (ret)
644 goto out;
645
646 block_sz = get_memory_block_size();
647 sections_per_block = block_sz / MIN_MEMORY_BLOCK_SIZE;
648
649 /*
650 * Create entries for memory sections that were found
651 * during boot and have been initialized
652 */
653 for (i = 0; i < NR_MEM_SECTIONS; i++) {
654 if (!present_section_nr(i))
655 continue;
656 err = add_memory_section(0, __nr_to_section(i), MEM_ONLINE,
657 BOOT);
658 if (!ret)
659 ret = err;
660 }
661
662 err = memory_probe_init();
663 if (!ret)
664 ret = err;
665 err = memory_fail_init();
666 if (!ret)
667 ret = err;
668 err = block_size_init();
669 if (!ret)
670 ret = err;
671out:
672 if (ret)
673 printk(KERN_ERR "%s() failed: %d\n", __func__, ret);
674 return ret;
675}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * Memory subsystem support
4 *
5 * Written by Matt Tolentino <matthew.e.tolentino@intel.com>
6 * Dave Hansen <haveblue@us.ibm.com>
7 *
8 * This file provides the necessary infrastructure to represent
9 * a SPARSEMEM-memory-model system's physical memory in /sysfs.
10 * All arch-independent code that assumes MEMORY_HOTPLUG requires
11 * SPARSEMEM should be contained here, or in mm/memory_hotplug.c.
12 */
13
14#include <linux/module.h>
15#include <linux/init.h>
16#include <linux/topology.h>
17#include <linux/capability.h>
18#include <linux/device.h>
19#include <linux/memory.h>
20#include <linux/memory_hotplug.h>
21#include <linux/mm.h>
22#include <linux/mutex.h>
23#include <linux/stat.h>
24#include <linux/slab.h>
25
26#include <linux/atomic.h>
27#include <linux/uaccess.h>
28
29static DEFINE_MUTEX(mem_sysfs_mutex);
30
31#define MEMORY_CLASS_NAME "memory"
32
33#define to_memory_block(dev) container_of(dev, struct memory_block, dev)
34
35static int sections_per_block;
36
37static inline int base_memory_block_id(int section_nr)
38{
39 return section_nr / sections_per_block;
40}
41
42static int memory_subsys_online(struct device *dev);
43static int memory_subsys_offline(struct device *dev);
44
45static struct bus_type memory_subsys = {
46 .name = MEMORY_CLASS_NAME,
47 .dev_name = MEMORY_CLASS_NAME,
48 .online = memory_subsys_online,
49 .offline = memory_subsys_offline,
50};
51
52static BLOCKING_NOTIFIER_HEAD(memory_chain);
53
54int register_memory_notifier(struct notifier_block *nb)
55{
56 return blocking_notifier_chain_register(&memory_chain, nb);
57}
58EXPORT_SYMBOL(register_memory_notifier);
59
60void unregister_memory_notifier(struct notifier_block *nb)
61{
62 blocking_notifier_chain_unregister(&memory_chain, nb);
63}
64EXPORT_SYMBOL(unregister_memory_notifier);
65
66static ATOMIC_NOTIFIER_HEAD(memory_isolate_chain);
67
68int register_memory_isolate_notifier(struct notifier_block *nb)
69{
70 return atomic_notifier_chain_register(&memory_isolate_chain, nb);
71}
72EXPORT_SYMBOL(register_memory_isolate_notifier);
73
74void unregister_memory_isolate_notifier(struct notifier_block *nb)
75{
76 atomic_notifier_chain_unregister(&memory_isolate_chain, nb);
77}
78EXPORT_SYMBOL(unregister_memory_isolate_notifier);
79
80static void memory_block_release(struct device *dev)
81{
82 struct memory_block *mem = to_memory_block(dev);
83
84 kfree(mem);
85}
86
87unsigned long __weak memory_block_size_bytes(void)
88{
89 return MIN_MEMORY_BLOCK_SIZE;
90}
91
92static unsigned long get_memory_block_size(void)
93{
94 unsigned long block_sz;
95
96 block_sz = memory_block_size_bytes();
97
98 /* Validate blk_sz is a power of 2 and not less than section size */
99 if ((block_sz & (block_sz - 1)) || (block_sz < MIN_MEMORY_BLOCK_SIZE)) {
100 WARN_ON(1);
101 block_sz = MIN_MEMORY_BLOCK_SIZE;
102 }
103
104 return block_sz;
105}
106
107/*
108 * use this as the physical section index that this memsection
109 * uses.
110 */
111
112static ssize_t show_mem_start_phys_index(struct device *dev,
113 struct device_attribute *attr, char *buf)
114{
115 struct memory_block *mem = to_memory_block(dev);
116 unsigned long phys_index;
117
118 phys_index = mem->start_section_nr / sections_per_block;
119 return sprintf(buf, "%08lx\n", phys_index);
120}
121
122/*
123 * Show whether the section of memory is likely to be hot-removable
124 */
125static ssize_t show_mem_removable(struct device *dev,
126 struct device_attribute *attr, char *buf)
127{
128 unsigned long i, pfn;
129 int ret = 1;
130 struct memory_block *mem = to_memory_block(dev);
131
132 if (mem->state != MEM_ONLINE)
133 goto out;
134
135 for (i = 0; i < sections_per_block; i++) {
136 if (!present_section_nr(mem->start_section_nr + i))
137 continue;
138 pfn = section_nr_to_pfn(mem->start_section_nr + i);
139 ret &= is_mem_section_removable(pfn, PAGES_PER_SECTION);
140 }
141
142out:
143 return sprintf(buf, "%d\n", ret);
144}
145
146/*
147 * online, offline, going offline, etc.
148 */
149static ssize_t show_mem_state(struct device *dev,
150 struct device_attribute *attr, char *buf)
151{
152 struct memory_block *mem = to_memory_block(dev);
153 ssize_t len = 0;
154
155 /*
156 * We can probably put these states in a nice little array
157 * so that they're not open-coded
158 */
159 switch (mem->state) {
160 case MEM_ONLINE:
161 len = sprintf(buf, "online\n");
162 break;
163 case MEM_OFFLINE:
164 len = sprintf(buf, "offline\n");
165 break;
166 case MEM_GOING_OFFLINE:
167 len = sprintf(buf, "going-offline\n");
168 break;
169 default:
170 len = sprintf(buf, "ERROR-UNKNOWN-%ld\n",
171 mem->state);
172 WARN_ON(1);
173 break;
174 }
175
176 return len;
177}
178
179int memory_notify(unsigned long val, void *v)
180{
181 return blocking_notifier_call_chain(&memory_chain, val, v);
182}
183
184int memory_isolate_notify(unsigned long val, void *v)
185{
186 return atomic_notifier_call_chain(&memory_isolate_chain, val, v);
187}
188
189/*
190 * The probe routines leave the pages uninitialized, just as the bootmem code
191 * does. Make sure we do not access them, but instead use only information from
192 * within sections.
193 */
194static bool pages_correctly_probed(unsigned long start_pfn)
195{
196 unsigned long section_nr = pfn_to_section_nr(start_pfn);
197 unsigned long section_nr_end = section_nr + sections_per_block;
198 unsigned long pfn = start_pfn;
199
200 /*
201 * memmap between sections is not contiguous except with
202 * SPARSEMEM_VMEMMAP. We lookup the page once per section
203 * and assume memmap is contiguous within each section
204 */
205 for (; section_nr < section_nr_end; section_nr++) {
206 if (WARN_ON_ONCE(!pfn_valid(pfn)))
207 return false;
208
209 if (!present_section_nr(section_nr)) {
210 pr_warn("section %ld pfn[%lx, %lx) not present",
211 section_nr, pfn, pfn + PAGES_PER_SECTION);
212 return false;
213 } else if (!valid_section_nr(section_nr)) {
214 pr_warn("section %ld pfn[%lx, %lx) no valid memmap",
215 section_nr, pfn, pfn + PAGES_PER_SECTION);
216 return false;
217 } else if (online_section_nr(section_nr)) {
218 pr_warn("section %ld pfn[%lx, %lx) is already online",
219 section_nr, pfn, pfn + PAGES_PER_SECTION);
220 return false;
221 }
222 pfn += PAGES_PER_SECTION;
223 }
224
225 return true;
226}
227
228/*
229 * MEMORY_HOTPLUG depends on SPARSEMEM in mm/Kconfig, so it is
230 * OK to have direct references to sparsemem variables in here.
231 * Must already be protected by mem_hotplug_begin().
232 */
233static int
234memory_block_action(unsigned long phys_index, unsigned long action, int online_type)
235{
236 unsigned long start_pfn;
237 unsigned long nr_pages = PAGES_PER_SECTION * sections_per_block;
238 int ret;
239
240 start_pfn = section_nr_to_pfn(phys_index);
241
242 switch (action) {
243 case MEM_ONLINE:
244 if (!pages_correctly_probed(start_pfn))
245 return -EBUSY;
246
247 ret = online_pages(start_pfn, nr_pages, online_type);
248 break;
249 case MEM_OFFLINE:
250 ret = offline_pages(start_pfn, nr_pages);
251 break;
252 default:
253 WARN(1, KERN_WARNING "%s(%ld, %ld) unknown action: "
254 "%ld\n", __func__, phys_index, action, action);
255 ret = -EINVAL;
256 }
257
258 return ret;
259}
260
261static int memory_block_change_state(struct memory_block *mem,
262 unsigned long to_state, unsigned long from_state_req)
263{
264 int ret = 0;
265
266 if (mem->state != from_state_req)
267 return -EINVAL;
268
269 if (to_state == MEM_OFFLINE)
270 mem->state = MEM_GOING_OFFLINE;
271
272 ret = memory_block_action(mem->start_section_nr, to_state,
273 mem->online_type);
274
275 mem->state = ret ? from_state_req : to_state;
276
277 return ret;
278}
279
280/* The device lock serializes operations on memory_subsys_[online|offline] */
281static int memory_subsys_online(struct device *dev)
282{
283 struct memory_block *mem = to_memory_block(dev);
284 int ret;
285
286 if (mem->state == MEM_ONLINE)
287 return 0;
288
289 /*
290 * If we are called from store_mem_state(), online_type will be
291 * set >= 0 Otherwise we were called from the device online
292 * attribute and need to set the online_type.
293 */
294 if (mem->online_type < 0)
295 mem->online_type = MMOP_ONLINE_KEEP;
296
297 /* Already under protection of mem_hotplug_begin() */
298 ret = memory_block_change_state(mem, MEM_ONLINE, MEM_OFFLINE);
299
300 /* clear online_type */
301 mem->online_type = -1;
302
303 return ret;
304}
305
306static int memory_subsys_offline(struct device *dev)
307{
308 struct memory_block *mem = to_memory_block(dev);
309
310 if (mem->state == MEM_OFFLINE)
311 return 0;
312
313 /* Can't offline block with non-present sections */
314 if (mem->section_count != sections_per_block)
315 return -EINVAL;
316
317 return memory_block_change_state(mem, MEM_OFFLINE, MEM_ONLINE);
318}
319
320static ssize_t
321store_mem_state(struct device *dev,
322 struct device_attribute *attr, const char *buf, size_t count)
323{
324 struct memory_block *mem = to_memory_block(dev);
325 int ret, online_type;
326
327 ret = lock_device_hotplug_sysfs();
328 if (ret)
329 return ret;
330
331 if (sysfs_streq(buf, "online_kernel"))
332 online_type = MMOP_ONLINE_KERNEL;
333 else if (sysfs_streq(buf, "online_movable"))
334 online_type = MMOP_ONLINE_MOVABLE;
335 else if (sysfs_streq(buf, "online"))
336 online_type = MMOP_ONLINE_KEEP;
337 else if (sysfs_streq(buf, "offline"))
338 online_type = MMOP_OFFLINE;
339 else {
340 ret = -EINVAL;
341 goto err;
342 }
343
344 /*
345 * Memory hotplug needs to hold mem_hotplug_begin() for probe to find
346 * the correct memory block to online before doing device_online(dev),
347 * which will take dev->mutex. Take the lock early to prevent an
348 * inversion, memory_subsys_online() callbacks will be implemented by
349 * assuming it's already protected.
350 */
351 mem_hotplug_begin();
352
353 switch (online_type) {
354 case MMOP_ONLINE_KERNEL:
355 case MMOP_ONLINE_MOVABLE:
356 case MMOP_ONLINE_KEEP:
357 mem->online_type = online_type;
358 ret = device_online(&mem->dev);
359 break;
360 case MMOP_OFFLINE:
361 ret = device_offline(&mem->dev);
362 break;
363 default:
364 ret = -EINVAL; /* should never happen */
365 }
366
367 mem_hotplug_done();
368err:
369 unlock_device_hotplug();
370
371 if (ret < 0)
372 return ret;
373 if (ret)
374 return -EINVAL;
375
376 return count;
377}
378
379/*
380 * phys_device is a bad name for this. What I really want
381 * is a way to differentiate between memory ranges that
382 * are part of physical devices that constitute
383 * a complete removable unit or fru.
384 * i.e. do these ranges belong to the same physical device,
385 * s.t. if I offline all of these sections I can then
386 * remove the physical device?
387 */
388static ssize_t show_phys_device(struct device *dev,
389 struct device_attribute *attr, char *buf)
390{
391 struct memory_block *mem = to_memory_block(dev);
392 return sprintf(buf, "%d\n", mem->phys_device);
393}
394
395#ifdef CONFIG_MEMORY_HOTREMOVE
396static void print_allowed_zone(char *buf, int nid, unsigned long start_pfn,
397 unsigned long nr_pages, int online_type,
398 struct zone *default_zone)
399{
400 struct zone *zone;
401
402 zone = zone_for_pfn_range(online_type, nid, start_pfn, nr_pages);
403 if (zone != default_zone) {
404 strcat(buf, " ");
405 strcat(buf, zone->name);
406 }
407}
408
409static ssize_t show_valid_zones(struct device *dev,
410 struct device_attribute *attr, char *buf)
411{
412 struct memory_block *mem = to_memory_block(dev);
413 unsigned long start_pfn = section_nr_to_pfn(mem->start_section_nr);
414 unsigned long nr_pages = PAGES_PER_SECTION * sections_per_block;
415 unsigned long valid_start_pfn, valid_end_pfn;
416 struct zone *default_zone;
417 int nid;
418
419 /*
420 * The block contains more than one zone can not be offlined.
421 * This can happen e.g. for ZONE_DMA and ZONE_DMA32
422 */
423 if (!test_pages_in_a_zone(start_pfn, start_pfn + nr_pages, &valid_start_pfn, &valid_end_pfn))
424 return sprintf(buf, "none\n");
425
426 start_pfn = valid_start_pfn;
427 nr_pages = valid_end_pfn - start_pfn;
428
429 /*
430 * Check the existing zone. Make sure that we do that only on the
431 * online nodes otherwise the page_zone is not reliable
432 */
433 if (mem->state == MEM_ONLINE) {
434 strcat(buf, page_zone(pfn_to_page(start_pfn))->name);
435 goto out;
436 }
437
438 nid = pfn_to_nid(start_pfn);
439 default_zone = zone_for_pfn_range(MMOP_ONLINE_KEEP, nid, start_pfn, nr_pages);
440 strcat(buf, default_zone->name);
441
442 print_allowed_zone(buf, nid, start_pfn, nr_pages, MMOP_ONLINE_KERNEL,
443 default_zone);
444 print_allowed_zone(buf, nid, start_pfn, nr_pages, MMOP_ONLINE_MOVABLE,
445 default_zone);
446out:
447 strcat(buf, "\n");
448
449 return strlen(buf);
450}
451static DEVICE_ATTR(valid_zones, 0444, show_valid_zones, NULL);
452#endif
453
454static DEVICE_ATTR(phys_index, 0444, show_mem_start_phys_index, NULL);
455static DEVICE_ATTR(state, 0644, show_mem_state, store_mem_state);
456static DEVICE_ATTR(phys_device, 0444, show_phys_device, NULL);
457static DEVICE_ATTR(removable, 0444, show_mem_removable, NULL);
458
459/*
460 * Block size attribute stuff
461 */
462static ssize_t
463print_block_size(struct device *dev, struct device_attribute *attr,
464 char *buf)
465{
466 return sprintf(buf, "%lx\n", get_memory_block_size());
467}
468
469static DEVICE_ATTR(block_size_bytes, 0444, print_block_size, NULL);
470
471/*
472 * Memory auto online policy.
473 */
474
475static ssize_t
476show_auto_online_blocks(struct device *dev, struct device_attribute *attr,
477 char *buf)
478{
479 if (memhp_auto_online)
480 return sprintf(buf, "online\n");
481 else
482 return sprintf(buf, "offline\n");
483}
484
485static ssize_t
486store_auto_online_blocks(struct device *dev, struct device_attribute *attr,
487 const char *buf, size_t count)
488{
489 if (sysfs_streq(buf, "online"))
490 memhp_auto_online = true;
491 else if (sysfs_streq(buf, "offline"))
492 memhp_auto_online = false;
493 else
494 return -EINVAL;
495
496 return count;
497}
498
499static DEVICE_ATTR(auto_online_blocks, 0644, show_auto_online_blocks,
500 store_auto_online_blocks);
501
502/*
503 * Some architectures will have custom drivers to do this, and
504 * will not need to do it from userspace. The fake hot-add code
505 * as well as ppc64 will do all of their discovery in userspace
506 * and will require this interface.
507 */
508#ifdef CONFIG_ARCH_MEMORY_PROBE
509static ssize_t
510memory_probe_store(struct device *dev, struct device_attribute *attr,
511 const char *buf, size_t count)
512{
513 u64 phys_addr;
514 int nid, ret;
515 unsigned long pages_per_block = PAGES_PER_SECTION * sections_per_block;
516
517 ret = kstrtoull(buf, 0, &phys_addr);
518 if (ret)
519 return ret;
520
521 if (phys_addr & ((pages_per_block << PAGE_SHIFT) - 1))
522 return -EINVAL;
523
524 nid = memory_add_physaddr_to_nid(phys_addr);
525 ret = add_memory(nid, phys_addr,
526 MIN_MEMORY_BLOCK_SIZE * sections_per_block);
527
528 if (ret)
529 goto out;
530
531 ret = count;
532out:
533 return ret;
534}
535
536static DEVICE_ATTR(probe, S_IWUSR, NULL, memory_probe_store);
537#endif
538
539#ifdef CONFIG_MEMORY_FAILURE
540/*
541 * Support for offlining pages of memory
542 */
543
544/* Soft offline a page */
545static ssize_t
546store_soft_offline_page(struct device *dev,
547 struct device_attribute *attr,
548 const char *buf, size_t count)
549{
550 int ret;
551 u64 pfn;
552 if (!capable(CAP_SYS_ADMIN))
553 return -EPERM;
554 if (kstrtoull(buf, 0, &pfn) < 0)
555 return -EINVAL;
556 pfn >>= PAGE_SHIFT;
557 if (!pfn_valid(pfn))
558 return -ENXIO;
559 ret = soft_offline_page(pfn_to_page(pfn), 0);
560 return ret == 0 ? count : ret;
561}
562
563/* Forcibly offline a page, including killing processes. */
564static ssize_t
565store_hard_offline_page(struct device *dev,
566 struct device_attribute *attr,
567 const char *buf, size_t count)
568{
569 int ret;
570 u64 pfn;
571 if (!capable(CAP_SYS_ADMIN))
572 return -EPERM;
573 if (kstrtoull(buf, 0, &pfn) < 0)
574 return -EINVAL;
575 pfn >>= PAGE_SHIFT;
576 ret = memory_failure(pfn, 0);
577 return ret ? ret : count;
578}
579
580static DEVICE_ATTR(soft_offline_page, S_IWUSR, NULL, store_soft_offline_page);
581static DEVICE_ATTR(hard_offline_page, S_IWUSR, NULL, store_hard_offline_page);
582#endif
583
584/*
585 * Note that phys_device is optional. It is here to allow for
586 * differentiation between which *physical* devices each
587 * section belongs to...
588 */
589int __weak arch_get_memory_phys_device(unsigned long start_pfn)
590{
591 return 0;
592}
593
594/*
595 * A reference for the returned object is held and the reference for the
596 * hinted object is released.
597 */
598struct memory_block *find_memory_block_hinted(struct mem_section *section,
599 struct memory_block *hint)
600{
601 int block_id = base_memory_block_id(__section_nr(section));
602 struct device *hintdev = hint ? &hint->dev : NULL;
603 struct device *dev;
604
605 dev = subsys_find_device_by_id(&memory_subsys, block_id, hintdev);
606 if (hint)
607 put_device(&hint->dev);
608 if (!dev)
609 return NULL;
610 return to_memory_block(dev);
611}
612
613/*
614 * For now, we have a linear search to go find the appropriate
615 * memory_block corresponding to a particular phys_index. If
616 * this gets to be a real problem, we can always use a radix
617 * tree or something here.
618 *
619 * This could be made generic for all device subsystems.
620 */
621struct memory_block *find_memory_block(struct mem_section *section)
622{
623 return find_memory_block_hinted(section, NULL);
624}
625
626static struct attribute *memory_memblk_attrs[] = {
627 &dev_attr_phys_index.attr,
628 &dev_attr_state.attr,
629 &dev_attr_phys_device.attr,
630 &dev_attr_removable.attr,
631#ifdef CONFIG_MEMORY_HOTREMOVE
632 &dev_attr_valid_zones.attr,
633#endif
634 NULL
635};
636
637static struct attribute_group memory_memblk_attr_group = {
638 .attrs = memory_memblk_attrs,
639};
640
641static const struct attribute_group *memory_memblk_attr_groups[] = {
642 &memory_memblk_attr_group,
643 NULL,
644};
645
646/*
647 * register_memory - Setup a sysfs device for a memory block
648 */
649static
650int register_memory(struct memory_block *memory)
651{
652 memory->dev.bus = &memory_subsys;
653 memory->dev.id = memory->start_section_nr / sections_per_block;
654 memory->dev.release = memory_block_release;
655 memory->dev.groups = memory_memblk_attr_groups;
656 memory->dev.offline = memory->state == MEM_OFFLINE;
657
658 return device_register(&memory->dev);
659}
660
661static int init_memory_block(struct memory_block **memory,
662 struct mem_section *section, unsigned long state)
663{
664 struct memory_block *mem;
665 unsigned long start_pfn;
666 int scn_nr;
667 int ret = 0;
668
669 mem = kzalloc(sizeof(*mem), GFP_KERNEL);
670 if (!mem)
671 return -ENOMEM;
672
673 scn_nr = __section_nr(section);
674 mem->start_section_nr =
675 base_memory_block_id(scn_nr) * sections_per_block;
676 mem->end_section_nr = mem->start_section_nr + sections_per_block - 1;
677 mem->state = state;
678 start_pfn = section_nr_to_pfn(mem->start_section_nr);
679 mem->phys_device = arch_get_memory_phys_device(start_pfn);
680
681 ret = register_memory(mem);
682
683 *memory = mem;
684 return ret;
685}
686
687static int add_memory_block(int base_section_nr)
688{
689 struct memory_block *mem;
690 int i, ret, section_count = 0, section_nr;
691
692 for (i = base_section_nr;
693 (i < base_section_nr + sections_per_block) && i < NR_MEM_SECTIONS;
694 i++) {
695 if (!present_section_nr(i))
696 continue;
697 if (section_count == 0)
698 section_nr = i;
699 section_count++;
700 }
701
702 if (section_count == 0)
703 return 0;
704 ret = init_memory_block(&mem, __nr_to_section(section_nr), MEM_ONLINE);
705 if (ret)
706 return ret;
707 mem->section_count = section_count;
708 return 0;
709}
710
711/*
712 * need an interface for the VM to add new memory regions,
713 * but without onlining it.
714 */
715int hotplug_memory_register(int nid, struct mem_section *section)
716{
717 int ret = 0;
718 struct memory_block *mem;
719
720 mutex_lock(&mem_sysfs_mutex);
721
722 mem = find_memory_block(section);
723 if (mem) {
724 mem->section_count++;
725 put_device(&mem->dev);
726 } else {
727 ret = init_memory_block(&mem, section, MEM_OFFLINE);
728 if (ret)
729 goto out;
730 mem->section_count++;
731 }
732
733 if (mem->section_count == sections_per_block)
734 ret = register_mem_sect_under_node(mem, nid, false);
735out:
736 mutex_unlock(&mem_sysfs_mutex);
737 return ret;
738}
739
740#ifdef CONFIG_MEMORY_HOTREMOVE
741static void
742unregister_memory(struct memory_block *memory)
743{
744 BUG_ON(memory->dev.bus != &memory_subsys);
745
746 /* drop the ref. we got in remove_memory_block() */
747 put_device(&memory->dev);
748 device_unregister(&memory->dev);
749}
750
751static int remove_memory_section(unsigned long node_id,
752 struct mem_section *section, int phys_device)
753{
754 struct memory_block *mem;
755
756 mutex_lock(&mem_sysfs_mutex);
757
758 /*
759 * Some users of the memory hotplug do not want/need memblock to
760 * track all sections. Skip over those.
761 */
762 mem = find_memory_block(section);
763 if (!mem)
764 goto out_unlock;
765
766 unregister_mem_sect_under_nodes(mem, __section_nr(section));
767
768 mem->section_count--;
769 if (mem->section_count == 0)
770 unregister_memory(mem);
771 else
772 put_device(&mem->dev);
773
774out_unlock:
775 mutex_unlock(&mem_sysfs_mutex);
776 return 0;
777}
778
779int unregister_memory_section(struct mem_section *section)
780{
781 if (!present_section(section))
782 return -EINVAL;
783
784 return remove_memory_section(0, section, 0);
785}
786#endif /* CONFIG_MEMORY_HOTREMOVE */
787
788/* return true if the memory block is offlined, otherwise, return false */
789bool is_memblock_offlined(struct memory_block *mem)
790{
791 return mem->state == MEM_OFFLINE;
792}
793
794static struct attribute *memory_root_attrs[] = {
795#ifdef CONFIG_ARCH_MEMORY_PROBE
796 &dev_attr_probe.attr,
797#endif
798
799#ifdef CONFIG_MEMORY_FAILURE
800 &dev_attr_soft_offline_page.attr,
801 &dev_attr_hard_offline_page.attr,
802#endif
803
804 &dev_attr_block_size_bytes.attr,
805 &dev_attr_auto_online_blocks.attr,
806 NULL
807};
808
809static struct attribute_group memory_root_attr_group = {
810 .attrs = memory_root_attrs,
811};
812
813static const struct attribute_group *memory_root_attr_groups[] = {
814 &memory_root_attr_group,
815 NULL,
816};
817
818/*
819 * Initialize the sysfs support for memory devices...
820 */
821int __init memory_dev_init(void)
822{
823 unsigned int i;
824 int ret;
825 int err;
826 unsigned long block_sz;
827
828 ret = subsys_system_register(&memory_subsys, memory_root_attr_groups);
829 if (ret)
830 goto out;
831
832 block_sz = get_memory_block_size();
833 sections_per_block = block_sz / MIN_MEMORY_BLOCK_SIZE;
834
835 /*
836 * Create entries for memory sections that were found
837 * during boot and have been initialized
838 */
839 mutex_lock(&mem_sysfs_mutex);
840 for (i = 0; i <= __highest_present_section_nr;
841 i += sections_per_block) {
842 err = add_memory_block(i);
843 if (!ret)
844 ret = err;
845 }
846 mutex_unlock(&mem_sysfs_mutex);
847
848out:
849 if (ret)
850 printk(KERN_ERR "%s() failed: %d\n", __func__, ret);
851 return ret;
852}