xref: /linux-6.15/include/linux/memory.h (revision 3f9903b9)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * include/linux/memory.h - generic memory definition
4  *
5  * This is mainly for topological representation. We define the
6  * basic "struct memory_block" here, which can be embedded in per-arch
7  * definitions or NUMA information.
8  *
9  * Basic handling of the devices is done in drivers/base/memory.c
10  * and system devices are handled in drivers/base/sys.c.
11  *
12  * Memory block are exported via sysfs in the class/memory/devices/
13  * directory.
14  *
15  */
16 #ifndef _LINUX_MEMORY_H_
17 #define _LINUX_MEMORY_H_
18 
19 #include <linux/node.h>
20 #include <linux/compiler.h>
21 #include <linux/mutex.h>
22 #include <linux/notifier.h>
23 
24 #define MIN_MEMORY_BLOCK_SIZE     (1UL << SECTION_SIZE_BITS)
25 
26 struct memory_block {
27 	unsigned long start_section_nr;
28 	unsigned long state;		/* serialized by the dev->lock */
29 	int section_count;		/* serialized by mem_sysfs_mutex */
30 	int online_type;		/* for passing data to online routine */
31 	int phys_device;		/* to which fru does this belong? */
32 	void *hw;			/* optional pointer to fw/hw data */
33 	int (*phys_callback)(struct memory_block *);
34 	struct device dev;
35 	int nid;			/* NID for this memory block */
36 };
37 
38 int arch_get_memory_phys_device(unsigned long start_pfn);
39 unsigned long memory_block_size_bytes(void);
40 int set_memory_block_size_order(unsigned int order);
41 
42 /* These states are exposed to userspace as text strings in sysfs */
43 #define	MEM_ONLINE		(1<<0) /* exposed to userspace */
44 #define	MEM_GOING_OFFLINE	(1<<1) /* exposed to userspace */
45 #define	MEM_OFFLINE		(1<<2) /* exposed to userspace */
46 #define	MEM_GOING_ONLINE	(1<<3)
47 #define	MEM_CANCEL_ONLINE	(1<<4)
48 #define	MEM_CANCEL_OFFLINE	(1<<5)
49 
50 struct memory_notify {
51 	unsigned long start_pfn;
52 	unsigned long nr_pages;
53 	int status_change_nid_normal;
54 	int status_change_nid_high;
55 	int status_change_nid;
56 };
57 
58 struct notifier_block;
59 struct mem_section;
60 
61 /*
62  * Priorities for the hotplug memory callback routines (stored in decreasing
63  * order in the callback chain)
64  */
65 #define SLAB_CALLBACK_PRI       1
66 #define IPC_CALLBACK_PRI        10
67 
68 #ifndef CONFIG_MEMORY_HOTPLUG_SPARSE
69 static inline void memory_dev_init(void)
70 {
71 	return;
72 }
73 static inline int register_memory_notifier(struct notifier_block *nb)
74 {
75 	return 0;
76 }
77 static inline void unregister_memory_notifier(struct notifier_block *nb)
78 {
79 }
80 static inline int memory_notify(unsigned long val, void *v)
81 {
82 	return 0;
83 }
84 #else
85 extern int register_memory_notifier(struct notifier_block *nb);
86 extern void unregister_memory_notifier(struct notifier_block *nb);
87 int create_memory_block_devices(unsigned long start, unsigned long size);
88 void remove_memory_block_devices(unsigned long start, unsigned long size);
89 extern void memory_dev_init(void);
90 extern int memory_notify(unsigned long val, void *v);
91 extern struct memory_block *find_memory_block(struct mem_section *);
92 typedef int (*walk_memory_blocks_func_t)(struct memory_block *, void *);
93 extern int walk_memory_blocks(unsigned long start, unsigned long size,
94 			      void *arg, walk_memory_blocks_func_t func);
95 extern int for_each_memory_block(void *arg, walk_memory_blocks_func_t func);
96 #define CONFIG_MEM_BLOCK_SIZE	(PAGES_PER_SECTION<<PAGE_SHIFT)
97 #endif /* CONFIG_MEMORY_HOTPLUG_SPARSE */
98 
99 #ifdef CONFIG_MEMORY_HOTPLUG
100 #define hotplug_memory_notifier(fn, pri) ({		\
101 	static __meminitdata struct notifier_block fn##_mem_nb =\
102 		{ .notifier_call = fn, .priority = pri };\
103 	register_memory_notifier(&fn##_mem_nb);			\
104 })
105 #define register_hotmemory_notifier(nb)		register_memory_notifier(nb)
106 #define unregister_hotmemory_notifier(nb) 	unregister_memory_notifier(nb)
107 #else
108 #define hotplug_memory_notifier(fn, pri)	({ 0; })
109 /* These aren't inline functions due to a GCC bug. */
110 #define register_hotmemory_notifier(nb)    ({ (void)(nb); 0; })
111 #define unregister_hotmemory_notifier(nb)  ({ (void)(nb); })
112 #endif
113 
114 /*
115  * Kernel text modification mutex, used for code patching. Users of this lock
116  * can sleep.
117  */
118 extern struct mutex text_mutex;
119 
120 #endif /* _LINUX_MEMORY_H_ */
121