2 * Memory subsystem support
4 * Written by Matt Tolentino <matthew.e.tolentino@intel.com>
5 * Dave Hansen <haveblue@us.ibm.com>
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.
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/topology.h>
16 #include <linux/capability.h>
17 #include <linux/device.h>
18 #include <linux/memory.h>
19 #include <linux/memory_hotplug.h>
21 #include <linux/mutex.h>
22 #include <linux/stat.h>
23 #include <linux/slab.h>
25 #include <linux/atomic.h>
26 #include <linux/uaccess.h>
28 static DEFINE_MUTEX(mem_sysfs_mutex
);
30 #define MEMORY_CLASS_NAME "memory"
32 #define to_memory_block(dev) container_of(dev, struct memory_block, dev)
34 static int sections_per_block
;
36 static inline int base_memory_block_id(int section_nr
)
38 return section_nr
/ sections_per_block
;
41 static int memory_subsys_online(struct device
*dev
);
42 static int memory_subsys_offline(struct device
*dev
);
44 static struct bus_type memory_subsys
= {
45 .name
= MEMORY_CLASS_NAME
,
46 .dev_name
= MEMORY_CLASS_NAME
,
47 .online
= memory_subsys_online
,
48 .offline
= memory_subsys_offline
,
51 static BLOCKING_NOTIFIER_HEAD(memory_chain
);
53 int register_memory_notifier(struct notifier_block
*nb
)
55 return blocking_notifier_chain_register(&memory_chain
, nb
);
57 EXPORT_SYMBOL(register_memory_notifier
);
59 void unregister_memory_notifier(struct notifier_block
*nb
)
61 blocking_notifier_chain_unregister(&memory_chain
, nb
);
63 EXPORT_SYMBOL(unregister_memory_notifier
);
65 static ATOMIC_NOTIFIER_HEAD(memory_isolate_chain
);
67 int register_memory_isolate_notifier(struct notifier_block
*nb
)
69 return atomic_notifier_chain_register(&memory_isolate_chain
, nb
);
71 EXPORT_SYMBOL(register_memory_isolate_notifier
);
73 void unregister_memory_isolate_notifier(struct notifier_block
*nb
)
75 atomic_notifier_chain_unregister(&memory_isolate_chain
, nb
);
77 EXPORT_SYMBOL(unregister_memory_isolate_notifier
);
79 static void memory_block_release(struct device
*dev
)
81 struct memory_block
*mem
= to_memory_block(dev
);
86 unsigned long __weak
memory_block_size_bytes(void)
88 return MIN_MEMORY_BLOCK_SIZE
;
91 static unsigned long get_memory_block_size(void)
93 unsigned long block_sz
;
95 block_sz
= memory_block_size_bytes();
97 /* Validate blk_sz is a power of 2 and not less than section size */
98 if ((block_sz
& (block_sz
- 1)) || (block_sz
< MIN_MEMORY_BLOCK_SIZE
)) {
100 block_sz
= MIN_MEMORY_BLOCK_SIZE
;
107 * use this as the physical section index that this memsection
111 static ssize_t
show_mem_start_phys_index(struct device
*dev
,
112 struct device_attribute
*attr
, char *buf
)
114 struct memory_block
*mem
= to_memory_block(dev
);
115 unsigned long phys_index
;
117 phys_index
= mem
->start_section_nr
/ sections_per_block
;
118 return sprintf(buf
, "%08lx\n", phys_index
);
122 * Show whether the section of memory is likely to be hot-removable
124 static ssize_t
show_mem_removable(struct device
*dev
,
125 struct device_attribute
*attr
, char *buf
)
127 unsigned long i
, pfn
;
129 struct memory_block
*mem
= to_memory_block(dev
);
131 if (mem
->state
!= MEM_ONLINE
)
134 for (i
= 0; i
< sections_per_block
; i
++) {
135 if (!present_section_nr(mem
->start_section_nr
+ i
))
137 pfn
= section_nr_to_pfn(mem
->start_section_nr
+ i
);
138 ret
&= is_mem_section_removable(pfn
, PAGES_PER_SECTION
);
142 return sprintf(buf
, "%d\n", ret
);
146 * online, offline, going offline, etc.
148 static ssize_t
show_mem_state(struct device
*dev
,
149 struct device_attribute
*attr
, char *buf
)
151 struct memory_block
*mem
= to_memory_block(dev
);
155 * We can probably put these states in a nice little array
156 * so that they're not open-coded
158 switch (mem
->state
) {
160 len
= sprintf(buf
, "online\n");
163 len
= sprintf(buf
, "offline\n");
165 case MEM_GOING_OFFLINE
:
166 len
= sprintf(buf
, "going-offline\n");
169 len
= sprintf(buf
, "ERROR-UNKNOWN-%ld\n",
178 int memory_notify(unsigned long val
, void *v
)
180 return blocking_notifier_call_chain(&memory_chain
, val
, v
);
183 int memory_isolate_notify(unsigned long val
, void *v
)
185 return atomic_notifier_call_chain(&memory_isolate_chain
, val
, v
);
189 * The probe routines leave the pages reserved, just as the bootmem code does.
190 * Make sure they're still that way.
192 static bool pages_correctly_reserved(unsigned long start_pfn
)
196 unsigned long pfn
= start_pfn
;
199 * memmap between sections is not contiguous except with
200 * SPARSEMEM_VMEMMAP. We lookup the page once per section
201 * and assume memmap is contiguous within each section
203 for (i
= 0; i
< sections_per_block
; i
++, pfn
+= PAGES_PER_SECTION
) {
204 if (WARN_ON_ONCE(!pfn_valid(pfn
)))
206 page
= pfn_to_page(pfn
);
208 for (j
= 0; j
< PAGES_PER_SECTION
; j
++) {
209 if (PageReserved(page
+ j
))
212 printk(KERN_WARNING
"section number %ld page number %d "
213 "not reserved, was it already online?\n",
214 pfn_to_section_nr(pfn
), j
);
224 * MEMORY_HOTPLUG depends on SPARSEMEM in mm/Kconfig, so it is
225 * OK to have direct references to sparsemem variables in here.
226 * Must already be protected by mem_hotplug_begin().
229 memory_block_action(unsigned long phys_index
, unsigned long action
, int online_type
)
231 unsigned long start_pfn
;
232 unsigned long nr_pages
= PAGES_PER_SECTION
* sections_per_block
;
235 start_pfn
= section_nr_to_pfn(phys_index
);
239 if (!pages_correctly_reserved(start_pfn
))
242 ret
= online_pages(start_pfn
, nr_pages
, online_type
);
245 ret
= offline_pages(start_pfn
, nr_pages
);
248 WARN(1, KERN_WARNING
"%s(%ld, %ld) unknown action: "
249 "%ld\n", __func__
, phys_index
, action
, action
);
256 static int memory_block_change_state(struct memory_block
*mem
,
257 unsigned long to_state
, unsigned long from_state_req
)
261 if (mem
->state
!= from_state_req
)
264 if (to_state
== MEM_OFFLINE
)
265 mem
->state
= MEM_GOING_OFFLINE
;
267 ret
= memory_block_action(mem
->start_section_nr
, to_state
,
270 mem
->state
= ret
? from_state_req
: to_state
;
275 /* The device lock serializes operations on memory_subsys_[online|offline] */
276 static int memory_subsys_online(struct device
*dev
)
278 struct memory_block
*mem
= to_memory_block(dev
);
281 if (mem
->state
== MEM_ONLINE
)
285 * If we are called from store_mem_state(), online_type will be
286 * set >= 0 Otherwise we were called from the device online
287 * attribute and need to set the online_type.
289 if (mem
->online_type
< 0)
290 mem
->online_type
= MMOP_ONLINE_KEEP
;
292 /* Already under protection of mem_hotplug_begin() */
293 ret
= memory_block_change_state(mem
, MEM_ONLINE
, MEM_OFFLINE
);
295 /* clear online_type */
296 mem
->online_type
= -1;
301 static int memory_subsys_offline(struct device
*dev
)
303 struct memory_block
*mem
= to_memory_block(dev
);
305 if (mem
->state
== MEM_OFFLINE
)
308 /* Can't offline block with non-present sections */
309 if (mem
->section_count
!= sections_per_block
)
312 return memory_block_change_state(mem
, MEM_OFFLINE
, MEM_ONLINE
);
316 store_mem_state(struct device
*dev
,
317 struct device_attribute
*attr
, const char *buf
, size_t count
)
319 struct memory_block
*mem
= to_memory_block(dev
);
320 int ret
, online_type
;
322 ret
= lock_device_hotplug_sysfs();
326 if (sysfs_streq(buf
, "online_kernel"))
327 online_type
= MMOP_ONLINE_KERNEL
;
328 else if (sysfs_streq(buf
, "online_movable"))
329 online_type
= MMOP_ONLINE_MOVABLE
;
330 else if (sysfs_streq(buf
, "online"))
331 online_type
= MMOP_ONLINE_KEEP
;
332 else if (sysfs_streq(buf
, "offline"))
333 online_type
= MMOP_OFFLINE
;
340 * Memory hotplug needs to hold mem_hotplug_begin() for probe to find
341 * the correct memory block to online before doing device_online(dev),
342 * which will take dev->mutex. Take the lock early to prevent an
343 * inversion, memory_subsys_online() callbacks will be implemented by
344 * assuming it's already protected.
348 switch (online_type
) {
349 case MMOP_ONLINE_KERNEL
:
350 case MMOP_ONLINE_MOVABLE
:
351 case MMOP_ONLINE_KEEP
:
352 mem
->online_type
= online_type
;
353 ret
= device_online(&mem
->dev
);
356 ret
= device_offline(&mem
->dev
);
359 ret
= -EINVAL
; /* should never happen */
364 unlock_device_hotplug();
375 * phys_device is a bad name for this. What I really want
376 * is a way to differentiate between memory ranges that
377 * are part of physical devices that constitute
378 * a complete removable unit or fru.
379 * i.e. do these ranges belong to the same physical device,
380 * s.t. if I offline all of these sections I can then
381 * remove the physical device?
383 static ssize_t
show_phys_device(struct device
*dev
,
384 struct device_attribute
*attr
, char *buf
)
386 struct memory_block
*mem
= to_memory_block(dev
);
387 return sprintf(buf
, "%d\n", mem
->phys_device
);
390 #ifdef CONFIG_MEMORY_HOTREMOVE
391 static ssize_t
show_valid_zones(struct device
*dev
,
392 struct device_attribute
*attr
, char *buf
)
394 struct memory_block
*mem
= to_memory_block(dev
);
395 unsigned long start_pfn
= section_nr_to_pfn(mem
->start_section_nr
);
396 unsigned long nr_pages
= PAGES_PER_SECTION
* sections_per_block
;
397 unsigned long valid_start_pfn
, valid_end_pfn
;
402 * The block contains more than one zone can not be offlined.
403 * This can happen e.g. for ZONE_DMA and ZONE_DMA32
405 if (!test_pages_in_a_zone(start_pfn
, start_pfn
+ nr_pages
, &valid_start_pfn
, &valid_end_pfn
))
406 return sprintf(buf
, "none\n");
408 start_pfn
= valid_start_pfn
;
409 nr_pages
= valid_end_pfn
- start_pfn
;
412 * Check the existing zone. Make sure that we do that only on the
413 * online nodes otherwise the page_zone is not reliable
415 if (mem
->state
== MEM_ONLINE
) {
416 strcat(buf
, page_zone(pfn_to_page(start_pfn
))->name
);
420 nid
= pfn_to_nid(start_pfn
);
421 if (allow_online_pfn_range(nid
, start_pfn
, nr_pages
, MMOP_ONLINE_KERNEL
)) {
422 strcat(buf
, default_zone_for_pfn(nid
, start_pfn
, nr_pages
)->name
);
426 if (allow_online_pfn_range(nid
, start_pfn
, nr_pages
, MMOP_ONLINE_MOVABLE
)) {
429 strcat(buf
, NODE_DATA(nid
)->node_zones
[ZONE_MOVABLE
].name
);
436 static DEVICE_ATTR(valid_zones
, 0444, show_valid_zones
, NULL
);
439 static DEVICE_ATTR(phys_index
, 0444, show_mem_start_phys_index
, NULL
);
440 static DEVICE_ATTR(state
, 0644, show_mem_state
, store_mem_state
);
441 static DEVICE_ATTR(phys_device
, 0444, show_phys_device
, NULL
);
442 static DEVICE_ATTR(removable
, 0444, show_mem_removable
, NULL
);
445 * Block size attribute stuff
448 print_block_size(struct device
*dev
, struct device_attribute
*attr
,
451 return sprintf(buf
, "%lx\n", get_memory_block_size());
454 static DEVICE_ATTR(block_size_bytes
, 0444, print_block_size
, NULL
);
457 * Memory auto online policy.
461 show_auto_online_blocks(struct device
*dev
, struct device_attribute
*attr
,
464 if (memhp_auto_online
)
465 return sprintf(buf
, "online\n");
467 return sprintf(buf
, "offline\n");
471 store_auto_online_blocks(struct device
*dev
, struct device_attribute
*attr
,
472 const char *buf
, size_t count
)
474 if (sysfs_streq(buf
, "online"))
475 memhp_auto_online
= true;
476 else if (sysfs_streq(buf
, "offline"))
477 memhp_auto_online
= false;
484 static DEVICE_ATTR(auto_online_blocks
, 0644, show_auto_online_blocks
,
485 store_auto_online_blocks
);
488 * Some architectures will have custom drivers to do this, and
489 * will not need to do it from userspace. The fake hot-add code
490 * as well as ppc64 will do all of their discovery in userspace
491 * and will require this interface.
493 #ifdef CONFIG_ARCH_MEMORY_PROBE
495 memory_probe_store(struct device
*dev
, struct device_attribute
*attr
,
496 const char *buf
, size_t count
)
500 unsigned long pages_per_block
= PAGES_PER_SECTION
* sections_per_block
;
502 ret
= kstrtoull(buf
, 0, &phys_addr
);
506 if (phys_addr
& ((pages_per_block
<< PAGE_SHIFT
) - 1))
509 nid
= memory_add_physaddr_to_nid(phys_addr
);
510 ret
= add_memory(nid
, phys_addr
,
511 MIN_MEMORY_BLOCK_SIZE
* sections_per_block
);
521 static DEVICE_ATTR(probe
, S_IWUSR
, NULL
, memory_probe_store
);
524 #ifdef CONFIG_MEMORY_FAILURE
526 * Support for offlining pages of memory
529 /* Soft offline a page */
531 store_soft_offline_page(struct device
*dev
,
532 struct device_attribute
*attr
,
533 const char *buf
, size_t count
)
537 if (!capable(CAP_SYS_ADMIN
))
539 if (kstrtoull(buf
, 0, &pfn
) < 0)
544 ret
= soft_offline_page(pfn_to_page(pfn
), 0);
545 return ret
== 0 ? count
: ret
;
548 /* Forcibly offline a page, including killing processes. */
550 store_hard_offline_page(struct device
*dev
,
551 struct device_attribute
*attr
,
552 const char *buf
, size_t count
)
556 if (!capable(CAP_SYS_ADMIN
))
558 if (kstrtoull(buf
, 0, &pfn
) < 0)
561 ret
= memory_failure(pfn
, 0, 0);
562 return ret
? ret
: count
;
565 static DEVICE_ATTR(soft_offline_page
, S_IWUSR
, NULL
, store_soft_offline_page
);
566 static DEVICE_ATTR(hard_offline_page
, S_IWUSR
, NULL
, store_hard_offline_page
);
570 * Note that phys_device is optional. It is here to allow for
571 * differentiation between which *physical* devices each
572 * section belongs to...
574 int __weak
arch_get_memory_phys_device(unsigned long start_pfn
)
580 * A reference for the returned object is held and the reference for the
581 * hinted object is released.
583 struct memory_block
*find_memory_block_hinted(struct mem_section
*section
,
584 struct memory_block
*hint
)
586 int block_id
= base_memory_block_id(__section_nr(section
));
587 struct device
*hintdev
= hint
? &hint
->dev
: NULL
;
590 dev
= subsys_find_device_by_id(&memory_subsys
, block_id
, hintdev
);
592 put_device(&hint
->dev
);
595 return to_memory_block(dev
);
599 * For now, we have a linear search to go find the appropriate
600 * memory_block corresponding to a particular phys_index. If
601 * this gets to be a real problem, we can always use a radix
602 * tree or something here.
604 * This could be made generic for all device subsystems.
606 struct memory_block
*find_memory_block(struct mem_section
*section
)
608 return find_memory_block_hinted(section
, NULL
);
611 static struct attribute
*memory_memblk_attrs
[] = {
612 &dev_attr_phys_index
.attr
,
613 &dev_attr_state
.attr
,
614 &dev_attr_phys_device
.attr
,
615 &dev_attr_removable
.attr
,
616 #ifdef CONFIG_MEMORY_HOTREMOVE
617 &dev_attr_valid_zones
.attr
,
622 static struct attribute_group memory_memblk_attr_group
= {
623 .attrs
= memory_memblk_attrs
,
626 static const struct attribute_group
*memory_memblk_attr_groups
[] = {
627 &memory_memblk_attr_group
,
632 * register_memory - Setup a sysfs device for a memory block
635 int register_memory(struct memory_block
*memory
)
637 memory
->dev
.bus
= &memory_subsys
;
638 memory
->dev
.id
= memory
->start_section_nr
/ sections_per_block
;
639 memory
->dev
.release
= memory_block_release
;
640 memory
->dev
.groups
= memory_memblk_attr_groups
;
641 memory
->dev
.offline
= memory
->state
== MEM_OFFLINE
;
643 return device_register(&memory
->dev
);
646 static int init_memory_block(struct memory_block
**memory
,
647 struct mem_section
*section
, unsigned long state
)
649 struct memory_block
*mem
;
650 unsigned long start_pfn
;
654 mem
= kzalloc(sizeof(*mem
), GFP_KERNEL
);
658 scn_nr
= __section_nr(section
);
659 mem
->start_section_nr
=
660 base_memory_block_id(scn_nr
) * sections_per_block
;
661 mem
->end_section_nr
= mem
->start_section_nr
+ sections_per_block
- 1;
663 start_pfn
= section_nr_to_pfn(mem
->start_section_nr
);
664 mem
->phys_device
= arch_get_memory_phys_device(start_pfn
);
666 ret
= register_memory(mem
);
672 static int add_memory_block(int base_section_nr
)
674 struct memory_block
*mem
;
675 int i
, ret
, section_count
= 0, section_nr
;
677 for (i
= base_section_nr
;
678 (i
< base_section_nr
+ sections_per_block
) && i
< NR_MEM_SECTIONS
;
680 if (!present_section_nr(i
))
682 if (section_count
== 0)
687 if (section_count
== 0)
689 ret
= init_memory_block(&mem
, __nr_to_section(section_nr
), MEM_ONLINE
);
692 mem
->section_count
= section_count
;
697 * need an interface for the VM to add new memory regions,
698 * but without onlining it.
700 int register_new_memory(int nid
, struct mem_section
*section
)
703 struct memory_block
*mem
;
705 mutex_lock(&mem_sysfs_mutex
);
707 mem
= find_memory_block(section
);
709 mem
->section_count
++;
710 put_device(&mem
->dev
);
712 ret
= init_memory_block(&mem
, section
, MEM_OFFLINE
);
715 mem
->section_count
++;
718 if (mem
->section_count
== sections_per_block
)
719 ret
= register_mem_sect_under_node(mem
, nid
);
721 mutex_unlock(&mem_sysfs_mutex
);
725 #ifdef CONFIG_MEMORY_HOTREMOVE
727 unregister_memory(struct memory_block
*memory
)
729 BUG_ON(memory
->dev
.bus
!= &memory_subsys
);
731 /* drop the ref. we got in remove_memory_block() */
732 put_device(&memory
->dev
);
733 device_unregister(&memory
->dev
);
736 static int remove_memory_section(unsigned long node_id
,
737 struct mem_section
*section
, int phys_device
)
739 struct memory_block
*mem
;
741 mutex_lock(&mem_sysfs_mutex
);
744 * Some users of the memory hotplug do not want/need memblock to
745 * track all sections. Skip over those.
747 mem
= find_memory_block(section
);
751 unregister_mem_sect_under_nodes(mem
, __section_nr(section
));
753 mem
->section_count
--;
754 if (mem
->section_count
== 0)
755 unregister_memory(mem
);
757 put_device(&mem
->dev
);
760 mutex_unlock(&mem_sysfs_mutex
);
764 int unregister_memory_section(struct mem_section
*section
)
766 if (!present_section(section
))
769 return remove_memory_section(0, section
, 0);
771 #endif /* CONFIG_MEMORY_HOTREMOVE */
773 /* return true if the memory block is offlined, otherwise, return false */
774 bool is_memblock_offlined(struct memory_block
*mem
)
776 return mem
->state
== MEM_OFFLINE
;
779 static struct attribute
*memory_root_attrs
[] = {
780 #ifdef CONFIG_ARCH_MEMORY_PROBE
781 &dev_attr_probe
.attr
,
784 #ifdef CONFIG_MEMORY_FAILURE
785 &dev_attr_soft_offline_page
.attr
,
786 &dev_attr_hard_offline_page
.attr
,
789 &dev_attr_block_size_bytes
.attr
,
790 &dev_attr_auto_online_blocks
.attr
,
794 static struct attribute_group memory_root_attr_group
= {
795 .attrs
= memory_root_attrs
,
798 static const struct attribute_group
*memory_root_attr_groups
[] = {
799 &memory_root_attr_group
,
804 * Initialize the sysfs support for memory devices...
806 int __init
memory_dev_init(void)
811 unsigned long block_sz
;
813 ret
= subsys_system_register(&memory_subsys
, memory_root_attr_groups
);
817 block_sz
= get_memory_block_size();
818 sections_per_block
= block_sz
/ MIN_MEMORY_BLOCK_SIZE
;
821 * Create entries for memory sections that were found
822 * during boot and have been initialized
824 mutex_lock(&mem_sysfs_mutex
);
825 for (i
= 0; i
< NR_MEM_SECTIONS
; i
+= sections_per_block
) {
826 /* Don't iterate over sections we know are !present: */
827 if (i
> __highest_present_section_nr
)
830 err
= add_memory_block(i
);
834 mutex_unlock(&mem_sysfs_mutex
);
838 printk(KERN_ERR
"%s() failed: %d\n", __func__
, ret
);