blob: e6109a6cd8f65eb779163d1a084a6e0256a11db0 [file] [log] [blame]
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +00001#ifndef _LINUX_SMPBOOT_H
2#define _LINUX_SMPBOOT_H
3
4#include <linux/types.h>
5
6struct task_struct;
7/* Cookie handed to the thread_fn*/
8struct 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
Thomas Gleixner7d7e4992013-01-31 12:11:12 +000017 * @create: Optional setup function, called when the thread gets
18 * created (Not called from the thread context)
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +000019 * @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)
Thomas Gleixner46c498c2013-02-26 18:44:33 +010027 * @pre_unpark: Optional unpark function, called before the thread is
28 * unparked (cpu online). This is not guaranteed to be
29 * called on the target cpu of the thread. Careful!
Chris Metcalfb5242e92015-06-24 16:55:42 -070030 * @cpumask: Internal state. To update which threads are unparked,
31 * call smpboot_update_cpumask_percpu_thread().
Thomas Gleixner7d7e4992013-01-31 12:11:12 +000032 * @selfparking: Thread is not parked by the park function.
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +000033 * @thread_comm: The base name of the thread
34 */
35struct smp_hotplug_thread {
36 struct task_struct __percpu **store;
37 struct list_head list;
38 int (*thread_should_run)(unsigned int cpu);
39 void (*thread_fn)(unsigned int cpu);
Thomas Gleixner7d7e4992013-01-31 12:11:12 +000040 void (*create)(unsigned int cpu);
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +000041 void (*setup)(unsigned int cpu);
42 void (*cleanup)(unsigned int cpu, bool online);
43 void (*park)(unsigned int cpu);
44 void (*unpark)(unsigned int cpu);
Thomas Gleixner46c498c2013-02-26 18:44:33 +010045 void (*pre_unpark)(unsigned int cpu);
Chris Metcalfb5242e92015-06-24 16:55:42 -070046 cpumask_var_t cpumask;
Thomas Gleixner7d7e4992013-01-31 12:11:12 +000047 bool selfparking;
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +000048 const char *thread_comm;
49};
50
Frederic Weisbecker230ec932015-09-04 15:45:06 -070051int smpboot_register_percpu_thread_cpumask(struct smp_hotplug_thread *plug_thread,
52 const struct cpumask *cpumask);
53
54static inline int
55smpboot_register_percpu_thread(struct smp_hotplug_thread *plug_thread)
56{
57 return smpboot_register_percpu_thread_cpumask(plug_thread,
58 cpu_possible_mask);
59}
60
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +000061void smpboot_unregister_percpu_thread(struct smp_hotplug_thread *plug_thread);
Chris Metcalfb5242e92015-06-24 16:55:42 -070062int smpboot_update_cpumask_percpu_thread(struct smp_hotplug_thread *plug_thread,
63 const struct cpumask *);
Thomas Gleixnerf97f8f02012-07-16 10:42:36 +000064
65#endif