include/linux/kthread.h

   1 #ifndef _LINUX_KTHREAD_H
   2 #define _LINUX_KTHREAD_H
   3 /* Simple interface for creating and stopping kernel threads without mess. */
   4 #include <linux/err.h>
   5 #include <linux/sched.h>
   6
   7 __printf(4, 5)
   8 struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
   9                                            void *data,
  10                                            int node,
  11                                            const char namefmt[], ...);
  12
  13 #define kthread_create(threadfn, data, namefmt, arg...) \
  14         kthread_create_on_node(threadfn, data, NUMA_NO_NODE, namefmt, ##arg)
  15
  16
  17 struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
  18                                           void *data,
  19                                           unsigned int cpu,
  20                                           const char *namefmt);
  21
  22 /**
  23  * kthread_run - create and wake a thread.
  24  * @threadfn: the function to run until signal_pending(current).
  25  * @data: data ptr for @threadfn.
  26  * @namefmt: printf-style name for the thread.
  27  *
  28  * Description: Convenient wrapper for kthread_create() followed by
  29  * wake_up_process().  Returns the kthread or ERR_PTR(-ENOMEM).
  30  */
  31 #define kthread_run(threadfn, data, namefmt, ...)                          \
  32 ({                                                                         \
  33         struct task_struct *__k                                            \
  34                 = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
  35         if (!IS_ERR(__k))                                                  \
  36                 wake_up_process(__k);                                      \
  37         __k;                                                               \
  38 })
  39
  40 void kthread_bind(struct task_struct *k, unsigned int cpu);
  41 void kthread_bind_mask(struct task_struct *k, const struct cpumask *mask);
  42 int kthread_stop(struct task_struct *k);
  43 bool kthread_should_stop(void);
  44 bool kthread_should_park(void);
  45 bool kthread_freezable_should_stop(bool *was_frozen);
  46 void *kthread_data(struct task_struct *k);
  47 void *probe_kthread_data(struct task_struct *k);
  48 int kthread_park(struct task_struct *k);
  49 void kthread_unpark(struct task_struct *k);
  50 void kthread_parkme(void);
  51
  52 int kthreadd(void *unused);
  53 extern struct task_struct *kthreadd_task;
  54 extern int tsk_fork_get_node(struct task_struct *tsk);
  55
  56 /*
  57  * Simple work processor based on kthread.
  58  *
  59  * This provides easier way to make use of kthreads.  A kthread_work
  60  * can be queued and flushed using queue/flush_kthread_work()
  61  * respectively.  Queued kthread_works are processed by a kthread
  62  * running kthread_worker_fn().
  63  */
  64 struct kthread_work;
  65 typedef void (*kthread_work_func_t)(struct kthread_work *work);
  66
  67 struct kthread_worker {
  68         spinlock_t              lock;
  69         struct list_head        work_list;
  70         struct task_struct      *task;
  71         struct kthread_work     *current_work;
  72 };
  73
  74 struct kthread_work {
  75         struct list_head        node;
  76         kthread_work_func_t     func;
  77         struct kthread_worker   *worker;
  78         /* Number of canceling calls that are running at the moment. */
  79         int                     canceling;
  80 };
  81
  82 #define KTHREAD_WORKER_INIT(worker)     {                               \
  83         .lock = __SPIN_LOCK_UNLOCKED((worker).lock),                    \
  84         .work_list = LIST_HEAD_INIT((worker).work_list),                \
  85         }
  86
  87 #define KTHREAD_WORK_INIT(work, fn)     {                               \
  88         .node = LIST_HEAD_INIT((work).node),                            \
  89         .func = (fn),                                                   \
  90         }
  91
  92 #define DEFINE_KTHREAD_WORKER(worker)                                   \
  93         struct kthread_worker worker = KTHREAD_WORKER_INIT(worker)
  94
  95 #define DEFINE_KTHREAD_WORK(work, fn)                                   \
  96         struct kthread_work work = KTHREAD_WORK_INIT(work, fn)
  97
  98 /*
  99  * kthread_worker.lock needs its own lockdep class key when defined on
 100  * stack with lockdep enabled.  Use the following macros in such cases.
 101  */
 102 #ifdef CONFIG_LOCKDEP
 103 # define KTHREAD_WORKER_INIT_ONSTACK(worker)                            \
 104         ({ init_kthread_worker(&worker); worker; })
 105 # define DEFINE_KTHREAD_WORKER_ONSTACK(worker)                          \
 106         struct kthread_worker worker = KTHREAD_WORKER_INIT_ONSTACK(worker)
 107 #else
 108 # define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker)
 109 #endif
 110
 111 extern void __init_kthread_worker(struct kthread_worker *worker,
 112                         const char *name, struct lock_class_key *key);
 113
 114 #define init_kthread_worker(worker)                                     \
 115         do {                                                            \
 116                 static struct lock_class_key __key;                     \
 117                 __init_kthread_worker((worker), "("#worker")->lock", &__key); \
 118         } while (0)
 119
 120 #define init_kthread_work(work, fn)                                     \
 121         do {                                                            \
 122                 memset((work), 0, sizeof(struct kthread_work));         \
 123                 INIT_LIST_HEAD(&(work)->node);                          \
 124                 (work)->func = (fn);                                    \
 125         } while (0)
 126
 127 int kthread_worker_fn(void *worker_ptr);
 128
 129 bool queue_kthread_work(struct kthread_worker *worker,
 130                         struct kthread_work *work);
 131 void flush_kthread_work(struct kthread_work *work);
 132 void flush_kthread_worker(struct kthread_worker *worker);
 133
 134 bool kthread_cancel_work_sync(struct kthread_work *work);
 135
 136 #endif /* _LINUX_KTHREAD_H */