include/linux/smpboot.h

   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  * @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!
  30  * @cpumask:            Internal state.  To update which threads are unparked,
  31  *                      call smpboot_update_cpumask_percpu_thread().
  32  * @selfparking:        Thread is not parked by the park function.
  33  * @thread_comm:        The base name of the thread
  34  */
  35 struct 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);
  40         void                            (*create)(unsigned int cpu);
  41         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);
  45         void                            (*pre_unpark)(unsigned int cpu);
  46         cpumask_var_t                   cpumask;
  47         bool                            selfparking;
  48         const char                      *thread_comm;
  49 };
  50
  51 int smpboot_register_percpu_thread_cpumask(struct smp_hotplug_thread *plug_thread,
  52                                            const struct cpumask *cpumask);
  53
  54 static inline int
  55 smpboot_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
  61 void smpboot_unregister_percpu_thread(struct smp_hotplug_thread *plug_thread);
  62 int smpboot_update_cpumask_percpu_thread(struct smp_hotplug_thread *plug_thread,
  63                                          const struct cpumask *);
  64
  65 #endif