xref: /linux-6.15/include/linux/smpboot.h (revision 840ef8b7)
1 #ifndef _LINUX_SMPBOOT_H
2 #define _LINUX_SMPBOOT_H
3 
4 #include <linux/types.h>
5 
6 struct task_struct;
7 /* Cookie handed to the thread_fn*/
8 struct smpboot_thread_data;
9 
10 /**
11  * struct smp_hotplug_thread - CPU hotplug related thread descriptor
12  * @store:		Pointer to per cpu storage for the task pointers
13  * @list:		List head for core management
14  * @thread_should_run:	Check whether the thread should run or not. Called with
15  *			preemption disabled.
16  * @thread_fn:		The associated thread function
17  * @create:		Optional setup function, called when the thread gets
18  *			created (Not called from the thread context)
19  * @setup:		Optional setup function, called when the thread gets
20  *			operational the first time
21  * @cleanup:		Optional cleanup function, called when the thread
22  *			should stop (module exit)
23  * @park:		Optional park function, called when the thread is
24  *			parked (cpu offline)
25  * @unpark:		Optional unpark function, called when the thread is
26  *			unparked (cpu online)
27  * @selfparking:	Thread is not parked by the park function.
28  * @thread_comm:	The base name of the thread
29  */
30 struct smp_hotplug_thread {
31 	struct task_struct __percpu	**store;
32 	struct list_head		list;
33 	int				(*thread_should_run)(unsigned int cpu);
34 	void				(*thread_fn)(unsigned int cpu);
35 	void				(*create)(unsigned int cpu);
36 	void				(*setup)(unsigned int cpu);
37 	void				(*cleanup)(unsigned int cpu, bool online);
38 	void				(*park)(unsigned int cpu);
39 	void				(*unpark)(unsigned int cpu);
40 	bool				selfparking;
41 	const char			*thread_comm;
42 };
43 
44 int smpboot_register_percpu_thread(struct smp_hotplug_thread *plug_thread);
45 void smpboot_unregister_percpu_thread(struct smp_hotplug_thread *plug_thread);
46 int smpboot_thread_schedule(void);
47 
48 #endif
49