blob: f93cb6979edc705531195aebec3cd61ccd4efb35 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#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
Linus Torvalds1da177e2005-04-16 15:20:36 -07007struct task_struct *kthread_create(int (*threadfn)(void *data),
8 void *data,
Rusty Russelled9559d2008-07-25 12:11:09 +10009 const char namefmt[], ...)
10 __attribute__((format(printf, 3, 4)));
Linus Torvalds1da177e2005-04-16 15:20:36 -070011
12/**
Randy Dunlap9e37bd32006-06-25 05:49:19 -070013 * kthread_run - create and wake a thread.
Linus Torvalds1da177e2005-04-16 15:20:36 -070014 * @threadfn: the function to run until signal_pending(current).
15 * @data: data ptr for @threadfn.
16 * @namefmt: printf-style name for the thread.
17 *
18 * Description: Convenient wrapper for kthread_create() followed by
Randy Dunlap9e37bd32006-06-25 05:49:19 -070019 * wake_up_process(). Returns the kthread or ERR_PTR(-ENOMEM).
20 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070021#define kthread_run(threadfn, data, namefmt, ...) \
22({ \
23 struct task_struct *__k \
24 = kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
25 if (!IS_ERR(__k)) \
26 wake_up_process(__k); \
27 __k; \
28})
29
Linus Torvalds1da177e2005-04-16 15:20:36 -070030void kthread_bind(struct task_struct *k, unsigned int cpu);
Linus Torvalds1da177e2005-04-16 15:20:36 -070031int kthread_stop(struct task_struct *k);
Linus Torvalds1da177e2005-04-16 15:20:36 -070032int kthread_should_stop(void);
33
Eric W. Biederman73c27992007-05-09 02:34:32 -070034int kthreadd(void *unused);
35extern struct task_struct *kthreadd_task;
36
Tejun Heob56c0d82010-06-29 10:07:09 +020037/*
38 * Simple work processor based on kthread.
39 *
40 * This provides easier way to make use of kthreads. A kthread_work
41 * can be queued and flushed using queue/flush_kthread_work()
42 * respectively. Queued kthread_works are processed by a kthread
43 * running kthread_worker_fn().
44 *
45 * A kthread_work can't be freed while it is executing.
46 */
47struct kthread_work;
48typedef void (*kthread_work_func_t)(struct kthread_work *work);
49
50struct kthread_worker {
51 spinlock_t lock;
52 struct list_head work_list;
53 struct task_struct *task;
54};
55
56struct kthread_work {
57 struct list_head node;
58 kthread_work_func_t func;
59 wait_queue_head_t done;
60 atomic_t flushing;
61 int queue_seq;
62 int done_seq;
63};
64
65#define KTHREAD_WORKER_INIT(worker) { \
66 .lock = SPIN_LOCK_UNLOCKED, \
67 .work_list = LIST_HEAD_INIT((worker).work_list), \
68 }
69
70#define KTHREAD_WORK_INIT(work, fn) { \
71 .node = LIST_HEAD_INIT((work).node), \
72 .func = (fn), \
73 .done = __WAIT_QUEUE_HEAD_INITIALIZER((work).done), \
74 .flushing = ATOMIC_INIT(0), \
75 }
76
77#define DEFINE_KTHREAD_WORKER(worker) \
78 struct kthread_worker worker = KTHREAD_WORKER_INIT(worker)
79
80#define DEFINE_KTHREAD_WORK(work, fn) \
81 struct kthread_work work = KTHREAD_WORK_INIT(work, fn)
82
83static inline void init_kthread_worker(struct kthread_worker *worker)
84{
85 *worker = (struct kthread_worker)KTHREAD_WORKER_INIT(*worker);
86}
87
88static inline void init_kthread_work(struct kthread_work *work,
89 kthread_work_func_t fn)
90{
91 *work = (struct kthread_work)KTHREAD_WORK_INIT(*work, fn);
92}
93
94int kthread_worker_fn(void *worker_ptr);
95
96bool queue_kthread_work(struct kthread_worker *worker,
97 struct kthread_work *work);
98void flush_kthread_work(struct kthread_work *work);
99void flush_kthread_worker(struct kthread_worker *worker);
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101#endif /* _LINUX_KTHREAD_H */