Commit | Line | Data |
---|---|---|
1da177e4 LT |
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 | ||
b9075fa9 | 7 | __printf(4, 5) |
207205a2 ED |
8 | struct task_struct *kthread_create_on_node(int (*threadfn)(void *data), |
9 | void *data, | |
10 | int node, | |
b9075fa9 | 11 | const char namefmt[], ...); |
207205a2 ED |
12 | |
13 | #define kthread_create(threadfn, data, namefmt, arg...) \ | |
14 | kthread_create_on_node(threadfn, data, -1, namefmt, ##arg) | |
15 | ||
1da177e4 | 16 | |
2a1d4460 TG |
17 | struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data), |
18 | void *data, | |
19 | unsigned int cpu, | |
20 | const char *namefmt); | |
21 | ||
1da177e4 | 22 | /** |
9e37bd30 | 23 | * kthread_run - create and wake a thread. |
1da177e4 LT |
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 | |
9e37bd30 RD |
29 | * wake_up_process(). Returns the kthread or ERR_PTR(-ENOMEM). |
30 | */ | |
1da177e4 LT |
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 | ||
1da177e4 | 40 | void kthread_bind(struct task_struct *k, unsigned int cpu); |
1da177e4 | 41 | int kthread_stop(struct task_struct *k); |
2a1d4460 TG |
42 | bool kthread_should_stop(void); |
43 | bool kthread_should_park(void); | |
8a32c441 | 44 | bool kthread_freezable_should_stop(bool *was_frozen); |
82805ab7 | 45 | void *kthread_data(struct task_struct *k); |
cd42d559 | 46 | void *probe_kthread_data(struct task_struct *k); |
2a1d4460 TG |
47 | int kthread_park(struct task_struct *k); |
48 | void kthread_unpark(struct task_struct *k); | |
49 | void kthread_parkme(void); | |
1da177e4 | 50 | |
73c27992 EB |
51 | int kthreadd(void *unused); |
52 | extern struct task_struct *kthreadd_task; | |
207205a2 | 53 | extern int tsk_fork_get_node(struct task_struct *tsk); |
73c27992 | 54 | |
b56c0d89 TH |
55 | /* |
56 | * Simple work processor based on kthread. | |
57 | * | |
58 | * This provides easier way to make use of kthreads. A kthread_work | |
59 | * can be queued and flushed using queue/flush_kthread_work() | |
60 | * respectively. Queued kthread_works are processed by a kthread | |
61 | * running kthread_worker_fn(). | |
b56c0d89 TH |
62 | */ |
63 | struct kthread_work; | |
64 | typedef void (*kthread_work_func_t)(struct kthread_work *work); | |
65 | ||
66 | struct kthread_worker { | |
67 | spinlock_t lock; | |
68 | struct list_head work_list; | |
69 | struct task_struct *task; | |
46f3d976 | 70 | struct kthread_work *current_work; |
b56c0d89 TH |
71 | }; |
72 | ||
73 | struct kthread_work { | |
74 | struct list_head node; | |
75 | kthread_work_func_t func; | |
76 | wait_queue_head_t done; | |
46f3d976 | 77 | struct kthread_worker *worker; |
b56c0d89 TH |
78 | }; |
79 | ||
80 | #define KTHREAD_WORKER_INIT(worker) { \ | |
92578c0b | 81 | .lock = __SPIN_LOCK_UNLOCKED((worker).lock), \ |
b56c0d89 TH |
82 | .work_list = LIST_HEAD_INIT((worker).work_list), \ |
83 | } | |
84 | ||
85 | #define KTHREAD_WORK_INIT(work, fn) { \ | |
86 | .node = LIST_HEAD_INIT((work).node), \ | |
87 | .func = (fn), \ | |
88 | .done = __WAIT_QUEUE_HEAD_INITIALIZER((work).done), \ | |
b56c0d89 TH |
89 | } |
90 | ||
91 | #define DEFINE_KTHREAD_WORKER(worker) \ | |
92 | struct kthread_worker worker = KTHREAD_WORKER_INIT(worker) | |
93 | ||
94 | #define DEFINE_KTHREAD_WORK(work, fn) \ | |
95 | struct kthread_work work = KTHREAD_WORK_INIT(work, fn) | |
96 | ||
4f32e9b1 YZ |
97 | /* |
98 | * kthread_worker.lock and kthread_work.done need their own lockdep class | |
99 | * keys if they are defined on stack with lockdep enabled. Use the | |
100 | * following macros when defining them on stack. | |
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 | # define KTHREAD_WORK_INIT_ONSTACK(work, fn) \ | |
108 | ({ init_kthread_work((&work), fn); work; }) | |
109 | # define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) \ | |
110 | struct kthread_work work = KTHREAD_WORK_INIT_ONSTACK(work, fn) | |
111 | #else | |
112 | # define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker) | |
113 | # define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) DEFINE_KTHREAD_WORK(work, fn) | |
114 | #endif | |
115 | ||
116 | extern void __init_kthread_worker(struct kthread_worker *worker, | |
117 | const char *name, struct lock_class_key *key); | |
118 | ||
119 | #define init_kthread_worker(worker) \ | |
120 | do { \ | |
121 | static struct lock_class_key __key; \ | |
122 | __init_kthread_worker((worker), "("#worker")->lock", &__key); \ | |
123 | } while (0) | |
124 | ||
125 | #define init_kthread_work(work, fn) \ | |
126 | do { \ | |
127 | memset((work), 0, sizeof(struct kthread_work)); \ | |
128 | INIT_LIST_HEAD(&(work)->node); \ | |
129 | (work)->func = (fn); \ | |
130 | init_waitqueue_head(&(work)->done); \ | |
131 | } while (0) | |
b56c0d89 TH |
132 | |
133 | int kthread_worker_fn(void *worker_ptr); | |
134 | ||
135 | bool queue_kthread_work(struct kthread_worker *worker, | |
136 | struct kthread_work *work); | |
137 | void flush_kthread_work(struct kthread_work *work); | |
138 | void flush_kthread_worker(struct kthread_worker *worker); | |
139 | ||
1da177e4 | 140 | #endif /* _LINUX_KTHREAD_H */ |