1 // SPDX-License-Identifier: GPL-2.0
3 * Memory subsystem support
5 * Written by Matt Tolentino <matthew.e.tolentino@intel.com>
6 * Dave Hansen <haveblue@us.ibm.com>
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.
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>
22 #include <linux/mutex.h>
23 #include <linux/stat.h>
24 #include <linux/slab.h>
26 #include <linux/atomic.h>
27 #include <linux/uaccess.h>
29 static DEFINE_MUTEX(mem_sysfs_mutex
);
31 #define MEMORY_CLASS_NAME "memory"
33 #define to_memory_block(dev) container_of(dev, struct memory_block, dev)
35 static int sections_per_block
;
37 static inline int base_memory_block_id(int section_nr
)
39 return section_nr
/ sections_per_block
;
42 static int memory_subsys_online(struct device
*dev
);
43 static int memory_subsys_offline(struct device
*dev
);
45 static 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
,
52 static BLOCKING_NOTIFIER_HEAD(memory_chain
);
54 int register_memory_notifier(struct notifier_block
*nb
)
56 return blocking_notifier_chain_register(&memory_chain
, nb
);
58 EXPORT_SYMBOL(register_memory_notifier
);
60 void unregister_memory_notifier(struct notifier_block
*nb
)
62 blocking_notifier_chain_unregister(&memory_chain
, nb
);
64 EXPORT_SYMBOL(unregister_memory_notifier
);
66 static ATOMIC_NOTIFIER_HEAD(memory_isolate_chain
);
68 int register_memory_isolate_notifier(struct notifier_block
*nb
)
70 return atomic_notifier_chain_register(&memory_isolate_chain
, nb
);
72 EXPORT_SYMBOL(register_memory_isolate_notifier
);
74 void unregister_memory_isolate_notifier(struct notifier_block
*nb
)
76 atomic_notifier_chain_unregister(&memory_isolate_chain
, nb
);
78 EXPORT_SYMBOL(unregister_memory_isolate_notifier
);
80 static void memory_block_release(struct device
*dev
)
82 struct memory_block
*mem
= to_memory_block(dev
);
87 unsigned long __weak
memory_block_size_bytes(void)
89 return MIN_MEMORY_BLOCK_SIZE
;
92 static unsigned long get_memory_block_size(void)
94 unsigned long block_sz
;
96 block_sz
= memory_block_size_bytes();
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
)) {
101 block_sz
= MIN_MEMORY_BLOCK_SIZE
;
108 * use this as the physical section index that this memsection
112 static ssize_t
show_mem_start_phys_index(struct device
*dev
,
113 struct device_attribute
*attr
, char *buf
)
115 struct memory_block
*mem
= to_memory_block(dev
);
116 unsigned long phys_index
;
118 phys_index
= mem
->start_section_nr
/ sections_per_block
;
119 return sprintf(buf
, "%08lx\n", phys_index
);
123 * Show whether the section of memory is likely to be hot-removable
125 static ssize_t
show_mem_removable(struct device
*dev
,
126 struct device_attribute
*attr
, char *buf
)
128 unsigned long i
, pfn
;
130 struct memory_block
*mem
= to_memory_block(dev
);
132 if (mem
->state
!= MEM_ONLINE
)
135 for (i
= 0; i
< sections_per_block
; i
++) {
136 if (!present_section_nr(mem
->start_section_nr
+ i
))
138 pfn
= section_nr_to_pfn(mem
->start_section_nr
+ i
);
139 ret
&= is_mem_section_removable(pfn
, PAGES_PER_SECTION
);
143 return sprintf(buf
, "%d\n", ret
);
147 * online, offline, going offline, etc.
149 static ssize_t
show_mem_state(struct device
*dev
,
150 struct device_attribute
*attr
, char *buf
)
152 struct memory_block
*mem
= to_memory_block(dev
);
156 * We can probably put these states in a nice little array
157 * so that they're not open-coded
159 switch (mem
->state
) {
161 len
= sprintf(buf
, "online\n");
164 len
= sprintf(buf
, "offline\n");
166 case MEM_GOING_OFFLINE
:
167 len
= sprintf(buf
, "going-offline\n");
170 len
= sprintf(buf
, "ERROR-UNKNOWN-%ld\n",
179 int memory_notify(unsigned long val
, void *v
)
181 return blocking_notifier_call_chain(&memory_chain
, val
, v
);
184 int memory_isolate_notify(unsigned long val
, void *v
)
186 return atomic_notifier_call_chain(&memory_isolate_chain
, val
, v
);
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
194 static bool pages_correctly_probed(unsigned long start_pfn
)
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
;
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
205 for (; section_nr
< section_nr_end
; section_nr
++) {
206 if (WARN_ON_ONCE(!pfn_valid(pfn
)))
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
);
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
);
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
);
222 pfn
+= PAGES_PER_SECTION
;
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().
234 memory_block_action(unsigned long phys_index
, unsigned long action
, int online_type
)
236 unsigned long start_pfn
;
237 unsigned long nr_pages
= PAGES_PER_SECTION
* sections_per_block
;
240 start_pfn
= section_nr_to_pfn(phys_index
);
244 if (!pages_correctly_probed(start_pfn
))
247 ret
= online_pages(start_pfn
, nr_pages
, online_type
);
250 ret
= offline_pages(start_pfn
, nr_pages
);
253 WARN(1, KERN_WARNING
"%s(%ld, %ld) unknown action: "
254 "%ld\n", __func__
, phys_index
, action
, action
);
261 static int memory_block_change_state(struct memory_block
*mem
,
262 unsigned long to_state
, unsigned long from_state_req
)
266 if (mem
->state
!= from_state_req
)
269 if (to_state
== MEM_OFFLINE
)
270 mem
->state
= MEM_GOING_OFFLINE
;
272 ret
= memory_block_action(mem
->start_section_nr
, to_state
,
275 mem
->state
= ret
? from_state_req
: to_state
;
280 /* The device lock serializes operations on memory_subsys_[online|offline] */
281 static int memory_subsys_online(struct device
*dev
)
283 struct memory_block
*mem
= to_memory_block(dev
);
286 if (mem
->state
== MEM_ONLINE
)
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.
294 if (mem
->online_type
< 0)
295 mem
->online_type
= MMOP_ONLINE_KEEP
;
297 /* Already under protection of mem_hotplug_begin() */
298 ret
= memory_block_change_state(mem
, MEM_ONLINE
, MEM_OFFLINE
);
300 /* clear online_type */
301 mem
->online_type
= -1;
306 static int memory_subsys_offline(struct device
*dev
)
308 struct memory_block
*mem
= to_memory_block(dev
);
310 if (mem
->state
== MEM_OFFLINE
)
313 /* Can't offline block with non-present sections */
314 if (mem
->section_count
!= sections_per_block
)
317 return memory_block_change_state(mem
, MEM_OFFLINE
, MEM_ONLINE
);
321 store_mem_state(struct device
*dev
,
322 struct device_attribute
*attr
, const char *buf
, size_t count
)
324 struct memory_block
*mem
= to_memory_block(dev
);
325 int ret
, online_type
;
327 ret
= lock_device_hotplug_sysfs();
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
;
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.
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
);
361 ret
= device_offline(&mem
->dev
);
364 ret
= -EINVAL
; /* should never happen */
369 unlock_device_hotplug();
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?
388 static ssize_t
show_phys_device(struct device
*dev
,
389 struct device_attribute
*attr
, char *buf
)
391 struct memory_block
*mem
= to_memory_block(dev
);
392 return sprintf(buf
, "%d\n", mem
->phys_device
);
395 #ifdef CONFIG_MEMORY_HOTREMOVE
396 static 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
)
402 zone
= zone_for_pfn_range(online_type
, nid
, start_pfn
, nr_pages
);
403 if (zone
!= default_zone
) {
405 strcat(buf
, zone
->name
);
409 static ssize_t
show_valid_zones(struct device
*dev
,
410 struct device_attribute
*attr
, char *buf
)
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
;
420 * The block contains more than one zone can not be offlined.
421 * This can happen e.g. for ZONE_DMA and ZONE_DMA32
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");
426 start_pfn
= valid_start_pfn
;
427 nr_pages
= valid_end_pfn
- start_pfn
;
430 * Check the existing zone. Make sure that we do that only on the
431 * online nodes otherwise the page_zone is not reliable
433 if (mem
->state
== MEM_ONLINE
) {
434 strcat(buf
, page_zone(pfn_to_page(start_pfn
))->name
);
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
);
442 print_allowed_zone(buf
, nid
, start_pfn
, nr_pages
, MMOP_ONLINE_KERNEL
,
444 print_allowed_zone(buf
, nid
, start_pfn
, nr_pages
, MMOP_ONLINE_MOVABLE
,
451 static DEVICE_ATTR(valid_zones
, 0444, show_valid_zones
, NULL
);
454 static DEVICE_ATTR(phys_index
, 0444, show_mem_start_phys_index
, NULL
);
455 static DEVICE_ATTR(state
, 0644, show_mem_state
, store_mem_state
);
456 static DEVICE_ATTR(phys_device
, 0444, show_phys_device
, NULL
);
457 static DEVICE_ATTR(removable
, 0444, show_mem_removable
, NULL
);
460 * Block size attribute stuff
463 print_block_size(struct device
*dev
, struct device_attribute
*attr
,
466 return sprintf(buf
, "%lx\n", get_memory_block_size());
469 static DEVICE_ATTR(block_size_bytes
, 0444, print_block_size
, NULL
);
472 * Memory auto online policy.
476 show_auto_online_blocks(struct device
*dev
, struct device_attribute
*attr
,
479 if (memhp_auto_online
)
480 return sprintf(buf
, "online\n");
482 return sprintf(buf
, "offline\n");
486 store_auto_online_blocks(struct device
*dev
, struct device_attribute
*attr
,
487 const char *buf
, size_t count
)
489 if (sysfs_streq(buf
, "online"))
490 memhp_auto_online
= true;
491 else if (sysfs_streq(buf
, "offline"))
492 memhp_auto_online
= false;
499 static DEVICE_ATTR(auto_online_blocks
, 0644, show_auto_online_blocks
,
500 store_auto_online_blocks
);
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.
508 #ifdef CONFIG_ARCH_MEMORY_PROBE
510 memory_probe_store(struct device
*dev
, struct device_attribute
*attr
,
511 const char *buf
, size_t count
)
515 unsigned long pages_per_block
= PAGES_PER_SECTION
* sections_per_block
;
517 ret
= kstrtoull(buf
, 0, &phys_addr
);
521 if (phys_addr
& ((pages_per_block
<< PAGE_SHIFT
) - 1))
524 nid
= memory_add_physaddr_to_nid(phys_addr
);
525 ret
= add_memory(nid
, phys_addr
,
526 MIN_MEMORY_BLOCK_SIZE
* sections_per_block
);
536 static DEVICE_ATTR(probe
, S_IWUSR
, NULL
, memory_probe_store
);
539 #ifdef CONFIG_MEMORY_FAILURE
541 * Support for offlining pages of memory
544 /* Soft offline a page */
546 store_soft_offline_page(struct device
*dev
,
547 struct device_attribute
*attr
,
548 const char *buf
, size_t count
)
552 if (!capable(CAP_SYS_ADMIN
))
554 if (kstrtoull(buf
, 0, &pfn
) < 0)
559 ret
= soft_offline_page(pfn_to_page(pfn
), 0);
560 return ret
== 0 ? count
: ret
;
563 /* Forcibly offline a page, including killing processes. */
565 store_hard_offline_page(struct device
*dev
,
566 struct device_attribute
*attr
,
567 const char *buf
, size_t count
)
571 if (!capable(CAP_SYS_ADMIN
))
573 if (kstrtoull(buf
, 0, &pfn
) < 0)
576 ret
= memory_failure(pfn
, 0);
577 return ret
? ret
: count
;
580 static DEVICE_ATTR(soft_offline_page
, S_IWUSR
, NULL
, store_soft_offline_page
);
581 static DEVICE_ATTR(hard_offline_page
, S_IWUSR
, NULL
, store_hard_offline_page
);
585 * Note that phys_device is optional. It is here to allow for
586 * differentiation between which *physical* devices each
587 * section belongs to...
589 int __weak
arch_get_memory_phys_device(unsigned long start_pfn
)
595 * A reference for the returned object is held and the reference for the
596 * hinted object is released.
598 struct memory_block
*find_memory_block_hinted(struct mem_section
*section
,
599 struct memory_block
*hint
)
601 int block_id
= base_memory_block_id(__section_nr(section
));
602 struct device
*hintdev
= hint
? &hint
->dev
: NULL
;
605 dev
= subsys_find_device_by_id(&memory_subsys
, block_id
, hintdev
);
607 put_device(&hint
->dev
);
610 return to_memory_block(dev
);
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.
619 * This could be made generic for all device subsystems.
621 struct memory_block
*find_memory_block(struct mem_section
*section
)
623 return find_memory_block_hinted(section
, NULL
);
626 static 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
,
637 static struct attribute_group memory_memblk_attr_group
= {
638 .attrs
= memory_memblk_attrs
,
641 static const struct attribute_group
*memory_memblk_attr_groups
[] = {
642 &memory_memblk_attr_group
,
647 * register_memory - Setup a sysfs device for a memory block
650 int register_memory(struct memory_block
*memory
)
654 memory
->dev
.bus
= &memory_subsys
;
655 memory
->dev
.id
= memory
->start_section_nr
/ sections_per_block
;
656 memory
->dev
.release
= memory_block_release
;
657 memory
->dev
.groups
= memory_memblk_attr_groups
;
658 memory
->dev
.offline
= memory
->state
== MEM_OFFLINE
;
660 ret
= device_register(&memory
->dev
);
662 put_device(&memory
->dev
);
667 static int init_memory_block(struct memory_block
**memory
,
668 struct mem_section
*section
, unsigned long state
)
670 struct memory_block
*mem
;
671 unsigned long start_pfn
;
675 mem
= kzalloc(sizeof(*mem
), GFP_KERNEL
);
679 scn_nr
= __section_nr(section
);
680 mem
->start_section_nr
=
681 base_memory_block_id(scn_nr
) * sections_per_block
;
682 mem
->end_section_nr
= mem
->start_section_nr
+ sections_per_block
- 1;
684 start_pfn
= section_nr_to_pfn(mem
->start_section_nr
);
685 mem
->phys_device
= arch_get_memory_phys_device(start_pfn
);
687 ret
= register_memory(mem
);
693 static int add_memory_block(int base_section_nr
)
695 struct memory_block
*mem
;
696 int i
, ret
, section_count
= 0, section_nr
;
698 for (i
= base_section_nr
;
699 (i
< base_section_nr
+ sections_per_block
) && i
< NR_MEM_SECTIONS
;
701 if (!present_section_nr(i
))
703 if (section_count
== 0)
708 if (section_count
== 0)
710 ret
= init_memory_block(&mem
, __nr_to_section(section_nr
), MEM_ONLINE
);
713 mem
->section_count
= section_count
;
718 * need an interface for the VM to add new memory regions,
719 * but without onlining it.
721 int hotplug_memory_register(int nid
, struct mem_section
*section
)
724 struct memory_block
*mem
;
726 mutex_lock(&mem_sysfs_mutex
);
728 mem
= find_memory_block(section
);
730 mem
->section_count
++;
731 put_device(&mem
->dev
);
733 ret
= init_memory_block(&mem
, section
, MEM_OFFLINE
);
736 mem
->section_count
++;
740 mutex_unlock(&mem_sysfs_mutex
);
744 #ifdef CONFIG_MEMORY_HOTREMOVE
746 unregister_memory(struct memory_block
*memory
)
748 BUG_ON(memory
->dev
.bus
!= &memory_subsys
);
750 /* drop the ref. we got in remove_memory_block() */
751 put_device(&memory
->dev
);
752 device_unregister(&memory
->dev
);
755 static int remove_memory_section(unsigned long node_id
,
756 struct mem_section
*section
, int phys_device
)
758 struct memory_block
*mem
;
760 mutex_lock(&mem_sysfs_mutex
);
763 * Some users of the memory hotplug do not want/need memblock to
764 * track all sections. Skip over those.
766 mem
= find_memory_block(section
);
770 unregister_mem_sect_under_nodes(mem
, __section_nr(section
));
772 mem
->section_count
--;
773 if (mem
->section_count
== 0)
774 unregister_memory(mem
);
776 put_device(&mem
->dev
);
779 mutex_unlock(&mem_sysfs_mutex
);
783 int unregister_memory_section(struct mem_section
*section
)
785 if (!present_section(section
))
788 return remove_memory_section(0, section
, 0);
790 #endif /* CONFIG_MEMORY_HOTREMOVE */
792 /* return true if the memory block is offlined, otherwise, return false */
793 bool is_memblock_offlined(struct memory_block
*mem
)
795 return mem
->state
== MEM_OFFLINE
;
798 static struct attribute
*memory_root_attrs
[] = {
799 #ifdef CONFIG_ARCH_MEMORY_PROBE
800 &dev_attr_probe
.attr
,
803 #ifdef CONFIG_MEMORY_FAILURE
804 &dev_attr_soft_offline_page
.attr
,
805 &dev_attr_hard_offline_page
.attr
,
808 &dev_attr_block_size_bytes
.attr
,
809 &dev_attr_auto_online_blocks
.attr
,
813 static struct attribute_group memory_root_attr_group
= {
814 .attrs
= memory_root_attrs
,
817 static const struct attribute_group
*memory_root_attr_groups
[] = {
818 &memory_root_attr_group
,
823 * Initialize the sysfs support for memory devices...
825 int __init
memory_dev_init(void)
830 unsigned long block_sz
;
832 ret
= subsys_system_register(&memory_subsys
, memory_root_attr_groups
);
836 block_sz
= get_memory_block_size();
837 sections_per_block
= block_sz
/ MIN_MEMORY_BLOCK_SIZE
;
840 * Create entries for memory sections that were found
841 * during boot and have been initialized
843 mutex_lock(&mem_sysfs_mutex
);
844 for (i
= 0; i
<= __highest_present_section_nr
;
845 i
+= sections_per_block
) {
846 err
= add_memory_block(i
);
850 mutex_unlock(&mem_sysfs_mutex
);
854 printk(KERN_ERR
"%s() failed: %d\n", __func__
, ret
);