Blame view

kernel/kthread.c 32.2 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
  /* Kernel thread helper functions.
   *   Copyright (C) 2004 IBM Corporation, Rusty Russell.
   *
73c279927   Eric W. Biederman   kthread: don't de...
4
   * Creation is done via kthreadd, so that we get a clean environment
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
5
6
7
   * even if we're invoked from userspace (think modprobe, hotplug cpu,
   * etc.).
   */
ae7e81c07   Ingo Molnar   sched/headers: Pr...
8
  #include <uapi/linux/sched/types.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
9
  #include <linux/sched.h>
299300258   Ingo Molnar   sched/headers: Pr...
10
  #include <linux/sched/task.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
11
12
13
  #include <linux/kthread.h>
  #include <linux/completion.h>
  #include <linux/err.h>
58568d2a8   Miao Xie   cpuset,mm: update...
14
  #include <linux/cpuset.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
15
16
  #include <linux/unistd.h>
  #include <linux/file.h>
9984de1a5   Paul Gortmaker   kernel: Map most ...
17
  #include <linux/export.h>
97d1f15b7   Arjan van de Ven   [PATCH] sem2mutex...
18
  #include <linux/mutex.h>
b56c0d893   Tejun Heo   kthread: implemen...
19
20
  #include <linux/slab.h>
  #include <linux/freezer.h>
a74fb73c1   Al Viro   infrastructure fo...
21
  #include <linux/ptrace.h>
cd42d559e   Tejun Heo   kthread: implemen...
22
  #include <linux/uaccess.h>
77f88796c   Tejun Heo   cgroup, kthread: ...
23
  #include <linux/cgroup.h>
ad8d75fff   Steven Rostedt   tracing/events: m...
24
  #include <trace/events/sched.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
25

73c279927   Eric W. Biederman   kthread: don't de...
26
27
28
  static DEFINE_SPINLOCK(kthread_create_lock);
  static LIST_HEAD(kthread_create_list);
  struct task_struct *kthreadd_task;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
29
30
31
  
  struct kthread_create_info
  {
73c279927   Eric W. Biederman   kthread: don't de...
32
  	/* Information passed to kthread() from kthreadd. */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
33
34
  	int (*threadfn)(void *data);
  	void *data;
207205a2b   Eric Dumazet   kthread: NUMA awa...
35
  	int node;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
36

73c279927   Eric W. Biederman   kthread: don't de...
37
  	/* Result passed back to kthread_create() from kthreadd. */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
38
  	struct task_struct *result;
786235eeb   Tetsuo Handa   kthread: make kth...
39
  	struct completion *done;
65f27f384   David Howells   WorkStruct: Pass ...
40

73c279927   Eric W. Biederman   kthread: don't de...
41
  	struct list_head list;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
42
  };
63706172f   Oleg Nesterov   kthreads: rework ...
43
  struct kthread {
2a1d44601   Thomas Gleixner   kthread: Implemen...
44
45
  	unsigned long flags;
  	unsigned int cpu;
82805ab77   Tejun Heo   kthread: implemen...
46
  	void *data;
2a1d44601   Thomas Gleixner   kthread: Implemen...
47
  	struct completion parked;
63706172f   Oleg Nesterov   kthreads: rework ...
48
  	struct completion exited;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
49
  };
2a1d44601   Thomas Gleixner   kthread: Implemen...
50
51
52
53
54
55
  enum KTHREAD_BITS {
  	KTHREAD_IS_PER_CPU = 0,
  	KTHREAD_SHOULD_STOP,
  	KTHREAD_SHOULD_PARK,
  	KTHREAD_IS_PARKED,
  };
1da5c46fa   Oleg Nesterov   kthread: Make str...
56
57
58
59
60
61
62
63
64
  static inline void set_kthread_struct(void *kthread)
  {
  	/*
  	 * We abuse ->set_child_tid to avoid the new member and because it
  	 * can't be wrongly copied by copy_process(). We also rely on fact
  	 * that the caller can't exec, so PF_KTHREAD can't be cleared.
  	 */
  	current->set_child_tid = (__force void __user *)kthread;
  }
4ecdafc80   Oleg Nesterov   kthread: introduc...
65
66
67
  
  static inline struct kthread *to_kthread(struct task_struct *k)
  {
1da5c46fa   Oleg Nesterov   kthread: Make str...
68
69
  	WARN_ON(!(k->flags & PF_KTHREAD));
  	return (__force void *)k->set_child_tid;
4ecdafc80   Oleg Nesterov   kthread: introduc...
70
  }
1da5c46fa   Oleg Nesterov   kthread: Make str...
71
72
73
74
75
76
77
78
  void free_kthread_struct(struct task_struct *k)
  {
  	/*
  	 * Can be NULL if this kthread was created by kernel_thread()
  	 * or if kmalloc() in kthread() failed.
  	 */
  	kfree(to_kthread(k));
  }
9e37bd301   Randy Dunlap   [PATCH] kthread: ...
79
80
81
  /**
   * kthread_should_stop - should this kthread return now?
   *
72fd4a35a   Robert P. J. Day   [PATCH] Numerous ...
82
   * When someone calls kthread_stop() on your kthread, it will be woken
9e37bd301   Randy Dunlap   [PATCH] kthread: ...
83
84
85
   * and this will return true.  You should then return, and your return
   * value will be passed through to kthread_stop().
   */
2a1d44601   Thomas Gleixner   kthread: Implemen...
86
  bool kthread_should_stop(void)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
87
  {
2a1d44601   Thomas Gleixner   kthread: Implemen...
88
  	return test_bit(KTHREAD_SHOULD_STOP, &to_kthread(current)->flags);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
89
90
  }
  EXPORT_SYMBOL(kthread_should_stop);
82805ab77   Tejun Heo   kthread: implemen...
91
  /**
2a1d44601   Thomas Gleixner   kthread: Implemen...
92
93
94
95
96
97
98
99
100
101
102
103
104
105
   * kthread_should_park - should this kthread park now?
   *
   * When someone calls kthread_park() on your kthread, it will be woken
   * and this will return true.  You should then do the necessary
   * cleanup and call kthread_parkme()
   *
   * Similar to kthread_should_stop(), but this keeps the thread alive
   * and in a park position. kthread_unpark() "restarts" the thread and
   * calls the thread function again.
   */
  bool kthread_should_park(void)
  {
  	return test_bit(KTHREAD_SHOULD_PARK, &to_kthread(current)->flags);
  }
18896451e   David Kershner   kthread: export k...
106
  EXPORT_SYMBOL_GPL(kthread_should_park);
2a1d44601   Thomas Gleixner   kthread: Implemen...
107
108
  
  /**
8a32c441c   Tejun Heo   freezer: implemen...
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
   * kthread_freezable_should_stop - should this freezable kthread return now?
   * @was_frozen: optional out parameter, indicates whether %current was frozen
   *
   * kthread_should_stop() for freezable kthreads, which will enter
   * refrigerator if necessary.  This function is safe from kthread_stop() /
   * freezer deadlock and freezable kthreads should use this function instead
   * of calling try_to_freeze() directly.
   */
  bool kthread_freezable_should_stop(bool *was_frozen)
  {
  	bool frozen = false;
  
  	might_sleep();
  
  	if (unlikely(freezing(current)))
  		frozen = __refrigerator(true);
  
  	if (was_frozen)
  		*was_frozen = frozen;
  
  	return kthread_should_stop();
  }
  EXPORT_SYMBOL_GPL(kthread_freezable_should_stop);
  
  /**
82805ab77   Tejun Heo   kthread: implemen...
134
135
136
137
138
139
140
141
142
143
144
   * kthread_data - return data value specified on kthread creation
   * @task: kthread task in question
   *
   * Return the data value specified when kthread @task was created.
   * The caller is responsible for ensuring the validity of @task when
   * calling this function.
   */
  void *kthread_data(struct task_struct *task)
  {
  	return to_kthread(task)->data;
  }
cd42d559e   Tejun Heo   kthread: implemen...
145
  /**
e700591ae   Petr Mladek   kthread: rename p...
146
   * kthread_probe_data - speculative version of kthread_data()
cd42d559e   Tejun Heo   kthread: implemen...
147
148
149
150
151
152
153
   * @task: possible kthread task in question
   *
   * @task could be a kthread task.  Return the data value specified when it
   * was created if accessible.  If @task isn't a kthread task or its data is
   * inaccessible for any reason, %NULL is returned.  This function requires
   * that @task itself is safe to dereference.
   */
e700591ae   Petr Mladek   kthread: rename p...
154
  void *kthread_probe_data(struct task_struct *task)
cd42d559e   Tejun Heo   kthread: implemen...
155
156
157
158
159
160
161
  {
  	struct kthread *kthread = to_kthread(task);
  	void *data = NULL;
  
  	probe_kernel_read(&data, &kthread->data, sizeof(data));
  	return data;
  }
2a1d44601   Thomas Gleixner   kthread: Implemen...
162
163
  static void __kthread_parkme(struct kthread *self)
  {
61ca60932   Peter Zijlstra   kthread, sched/wa...
164
165
166
167
  	for (;;) {
  		set_current_state(TASK_PARKED);
  		if (!test_bit(KTHREAD_SHOULD_PARK, &self->flags))
  			break;
2a1d44601   Thomas Gleixner   kthread: Implemen...
168
169
170
  		if (!test_and_set_bit(KTHREAD_IS_PARKED, &self->flags))
  			complete(&self->parked);
  		schedule();
2a1d44601   Thomas Gleixner   kthread: Implemen...
171
172
173
174
175
176
177
178
179
  	}
  	clear_bit(KTHREAD_IS_PARKED, &self->flags);
  	__set_current_state(TASK_RUNNING);
  }
  
  void kthread_parkme(void)
  {
  	__kthread_parkme(to_kthread(current));
  }
18896451e   David Kershner   kthread: export k...
180
  EXPORT_SYMBOL_GPL(kthread_parkme);
2a1d44601   Thomas Gleixner   kthread: Implemen...
181

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
182
183
  static int kthread(void *_create)
  {
63706172f   Oleg Nesterov   kthreads: rework ...
184
  	/* Copy data: it's on kthread's stack */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
185
  	struct kthread_create_info *create = _create;
63706172f   Oleg Nesterov   kthreads: rework ...
186
187
  	int (*threadfn)(void *data) = create->threadfn;
  	void *data = create->data;
786235eeb   Tetsuo Handa   kthread: make kth...
188
  	struct completion *done;
1da5c46fa   Oleg Nesterov   kthread: Make str...
189
  	struct kthread *self;
63706172f   Oleg Nesterov   kthreads: rework ...
190
  	int ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
191

1da5c46fa   Oleg Nesterov   kthread: Make str...
192
193
  	self = kmalloc(sizeof(*self), GFP_KERNEL);
  	set_kthread_struct(self);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
194

786235eeb   Tetsuo Handa   kthread: make kth...
195
196
197
198
199
200
  	/* If user was SIGKILLed, I release the structure. */
  	done = xchg(&create->done, NULL);
  	if (!done) {
  		kfree(create);
  		do_exit(-EINTR);
  	}
1da5c46fa   Oleg Nesterov   kthread: Make str...
201
202
203
204
205
206
207
208
209
210
211
212
  
  	if (!self) {
  		create->result = ERR_PTR(-ENOMEM);
  		complete(done);
  		do_exit(-ENOMEM);
  	}
  
  	self->flags = 0;
  	self->data = data;
  	init_completion(&self->exited);
  	init_completion(&self->parked);
  	current->vfork_done = &self->exited;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
213
  	/* OK, tell user we're spawned, wait for stop or wakeup */
a076e4bca   Oleg Nesterov   freezer: fix kthr...
214
  	__set_current_state(TASK_UNINTERRUPTIBLE);
3217ab97f   Vitaliy Gusev   kthread: Don't lo...
215
  	create->result = current;
786235eeb   Tetsuo Handa   kthread: make kth...
216
  	complete(done);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
217
  	schedule();
63706172f   Oleg Nesterov   kthreads: rework ...
218
  	ret = -EINTR;
1da5c46fa   Oleg Nesterov   kthread: Make str...
219
  	if (!test_bit(KTHREAD_SHOULD_STOP, &self->flags)) {
77f88796c   Tejun Heo   cgroup, kthread: ...
220
  		cgroup_kthread_ready();
1da5c46fa   Oleg Nesterov   kthread: Make str...
221
  		__kthread_parkme(self);
2a1d44601   Thomas Gleixner   kthread: Implemen...
222
223
  		ret = threadfn(data);
  	}
63706172f   Oleg Nesterov   kthreads: rework ...
224
  	do_exit(ret);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
225
  }
207205a2b   Eric Dumazet   kthread: NUMA awa...
226
227
228
229
230
231
232
  /* called from do_fork() to get node information for about to be created task */
  int tsk_fork_get_node(struct task_struct *tsk)
  {
  #ifdef CONFIG_NUMA
  	if (tsk == kthreadd_task)
  		return tsk->pref_node_fork;
  #endif
81c98869f   Nishanth Aravamudan   kthread: ensure l...
233
  	return NUMA_NO_NODE;
207205a2b   Eric Dumazet   kthread: NUMA awa...
234
  }
73c279927   Eric W. Biederman   kthread: don't de...
235
  static void create_kthread(struct kthread_create_info *create)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
236
  {
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
237
  	int pid;
207205a2b   Eric Dumazet   kthread: NUMA awa...
238
239
240
  #ifdef CONFIG_NUMA
  	current->pref_node_fork = create->node;
  #endif
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
241
242
  	/* We want our own signal handler (we take no signals by default). */
  	pid = kernel_thread(kthread, create, CLONE_FS | CLONE_FILES | SIGCHLD);
cdd140bdd   Oleg Nesterov   kthreads: simplif...
243
  	if (pid < 0) {
786235eeb   Tetsuo Handa   kthread: make kth...
244
245
246
247
248
249
250
  		/* If user was SIGKILLed, I release the structure. */
  		struct completion *done = xchg(&create->done, NULL);
  
  		if (!done) {
  			kfree(create);
  			return;
  		}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
251
  		create->result = ERR_PTR(pid);
786235eeb   Tetsuo Handa   kthread: make kth...
252
  		complete(done);
cdd140bdd   Oleg Nesterov   kthreads: simplif...
253
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
254
  }
c0b942a76   Nicolas Iooss   kthread: add __pr...
255
256
  static __printf(4, 0)
  struct task_struct *__kthread_create_on_node(int (*threadfn)(void *data),
255451e45   Petr Mladek   kthread: allow to...
257
258
259
  						    void *data, int node,
  						    const char namefmt[],
  						    va_list args)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
260
  {
786235eeb   Tetsuo Handa   kthread: make kth...
261
262
263
264
265
266
267
268
269
270
271
  	DECLARE_COMPLETION_ONSTACK(done);
  	struct task_struct *task;
  	struct kthread_create_info *create = kmalloc(sizeof(*create),
  						     GFP_KERNEL);
  
  	if (!create)
  		return ERR_PTR(-ENOMEM);
  	create->threadfn = threadfn;
  	create->data = data;
  	create->node = node;
  	create->done = &done;
73c279927   Eric W. Biederman   kthread: don't de...
272
273
  
  	spin_lock(&kthread_create_lock);
786235eeb   Tetsuo Handa   kthread: make kth...
274
  	list_add_tail(&create->list, &kthread_create_list);
73c279927   Eric W. Biederman   kthread: don't de...
275
  	spin_unlock(&kthread_create_lock);
cbd9b67bd   Dmitry Adamushko   kthread: call wak...
276
  	wake_up_process(kthreadd_task);
786235eeb   Tetsuo Handa   kthread: make kth...
277
278
279
280
281
282
283
284
285
286
287
288
  	/*
  	 * Wait for completion in killable state, for I might be chosen by
  	 * the OOM killer while kthreadd is trying to allocate memory for
  	 * new kernel thread.
  	 */
  	if (unlikely(wait_for_completion_killable(&done))) {
  		/*
  		 * If I was SIGKILLed before kthreadd (or new kernel thread)
  		 * calls complete(), leave the cleanup of this structure to
  		 * that thread.
  		 */
  		if (xchg(&create->done, NULL))
8fe6929cf   Tetsuo Handa   kthread: fix retu...
289
  			return ERR_PTR(-EINTR);
786235eeb   Tetsuo Handa   kthread: make kth...
290
291
292
293
294
295
296
297
  		/*
  		 * kthreadd (or new kernel thread) will call complete()
  		 * shortly.
  		 */
  		wait_for_completion(&done);
  	}
  	task = create->result;
  	if (!IS_ERR(task)) {
c9b5f501e   Peter Zijlstra   sched: Constify f...
298
  		static const struct sched_param param = { .sched_priority = 0 };
f95745687   Snild Dolkow   kthread, tracing:...
299
  		char name[TASK_COMM_LEN];
1c99315bb   Oleg Nesterov   kthread: move sch...
300

f95745687   Snild Dolkow   kthread, tracing:...
301
302
303
304
305
306
  		/*
  		 * task is already visible to other tasks, so updating
  		 * COMM must be protected.
  		 */
  		vsnprintf(name, sizeof(name), namefmt, args);
  		set_task_comm(task, name);
1c99315bb   Oleg Nesterov   kthread: move sch...
307
308
309
310
  		/*
  		 * root may have changed our (kthreadd's) priority or CPU mask.
  		 * The kernel thread should not inherit these properties.
  		 */
786235eeb   Tetsuo Handa   kthread: make kth...
311
312
  		sched_setscheduler_nocheck(task, SCHED_NORMAL, &param);
  		set_cpus_allowed_ptr(task, cpu_all_mask);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
313
  	}
786235eeb   Tetsuo Handa   kthread: make kth...
314
315
  	kfree(create);
  	return task;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
316
  }
255451e45   Petr Mladek   kthread: allow to...
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
  
  /**
   * kthread_create_on_node - create a kthread.
   * @threadfn: the function to run until signal_pending(current).
   * @data: data ptr for @threadfn.
   * @node: task and thread structures for the thread are allocated on this node
   * @namefmt: printf-style name for the thread.
   *
   * Description: This helper function creates and names a kernel
   * thread.  The thread will be stopped: use wake_up_process() to start
   * it.  See also kthread_run().  The new thread has SCHED_NORMAL policy and
   * is affine to all CPUs.
   *
   * If thread is going to be bound on a particular cpu, give its node
   * in @node, to get NUMA affinity for kthread stack, or else give NUMA_NO_NODE.
   * When woken, the thread will run @threadfn() with @data as its
   * argument. @threadfn() can either call do_exit() directly if it is a
   * standalone thread for which no one will call kthread_stop(), or
   * return when 'kthread_should_stop()' is true (which means
   * kthread_stop() has been called).  The return value should be zero
   * or a negative error number; it will be passed to kthread_stop().
   *
   * Returns a task_struct or ERR_PTR(-ENOMEM) or ERR_PTR(-EINTR).
   */
  struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
  					   void *data, int node,
  					   const char namefmt[],
  					   ...)
  {
  	struct task_struct *task;
  	va_list args;
  
  	va_start(args, namefmt);
  	task = __kthread_create_on_node(threadfn, data, node, namefmt, args);
  	va_end(args);
  
  	return task;
  }
207205a2b   Eric Dumazet   kthread: NUMA awa...
355
  EXPORT_SYMBOL(kthread_create_on_node);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
356

25834c73f   Peter Zijlstra   sched: Fix a race...
357
  static void __kthread_bind_mask(struct task_struct *p, const struct cpumask *mask, long state)
2a1d44601   Thomas Gleixner   kthread: Implemen...
358
  {
25834c73f   Peter Zijlstra   sched: Fix a race...
359
  	unsigned long flags;
f2530dc71   Thomas Gleixner   kthread: Prevent ...
360
361
362
363
  	if (!wait_task_inactive(p, state)) {
  		WARN_ON(1);
  		return;
  	}
25834c73f   Peter Zijlstra   sched: Fix a race...
364

2a1d44601   Thomas Gleixner   kthread: Implemen...
365
  	/* It's safe because the task is inactive. */
25834c73f   Peter Zijlstra   sched: Fix a race...
366
367
  	raw_spin_lock_irqsave(&p->pi_lock, flags);
  	do_set_cpus_allowed(p, mask);
14a40ffcc   Tejun Heo   sched: replace PF...
368
  	p->flags |= PF_NO_SETAFFINITY;
25834c73f   Peter Zijlstra   sched: Fix a race...
369
370
371
372
373
374
375
376
377
378
379
  	raw_spin_unlock_irqrestore(&p->pi_lock, flags);
  }
  
  static void __kthread_bind(struct task_struct *p, unsigned int cpu, long state)
  {
  	__kthread_bind_mask(p, cpumask_of(cpu), state);
  }
  
  void kthread_bind_mask(struct task_struct *p, const struct cpumask *mask)
  {
  	__kthread_bind_mask(p, mask, TASK_UNINTERRUPTIBLE);
2a1d44601   Thomas Gleixner   kthread: Implemen...
380
  }
9e37bd301   Randy Dunlap   [PATCH] kthread: ...
381
  /**
881232b70   Peter Zijlstra   sched: Move kthre...
382
383
384
385
386
387
388
389
390
391
   * kthread_bind - bind a just-created kthread to a cpu.
   * @p: thread created by kthread_create().
   * @cpu: cpu (might not be online, must be possible) for @k to run on.
   *
   * Description: This function is equivalent to set_cpus_allowed(),
   * except that @cpu doesn't need to be online, and the thread must be
   * stopped (i.e., just returned from kthread_create()).
   */
  void kthread_bind(struct task_struct *p, unsigned int cpu)
  {
f2530dc71   Thomas Gleixner   kthread: Prevent ...
392
  	__kthread_bind(p, cpu, TASK_UNINTERRUPTIBLE);
881232b70   Peter Zijlstra   sched: Move kthre...
393
394
395
396
  }
  EXPORT_SYMBOL(kthread_bind);
  
  /**
2a1d44601   Thomas Gleixner   kthread: Implemen...
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
   * kthread_create_on_cpu - Create a cpu bound kthread
   * @threadfn: the function to run until signal_pending(current).
   * @data: data ptr for @threadfn.
   * @cpu: The cpu on which the thread should be bound,
   * @namefmt: printf-style name for the thread. Format is restricted
   *	     to "name.*%u". Code fills in cpu number.
   *
   * Description: This helper function creates and names a kernel thread
   * The thread will be woken and put into park mode.
   */
  struct task_struct *kthread_create_on_cpu(int (*threadfn)(void *data),
  					  void *data, unsigned int cpu,
  					  const char *namefmt)
  {
  	struct task_struct *p;
109228389   Nishanth Aravamudan   kernel/kthread.c:...
412
  	p = kthread_create_on_node(threadfn, data, cpu_to_node(cpu), namefmt,
2a1d44601   Thomas Gleixner   kthread: Implemen...
413
414
415
  				   cpu);
  	if (IS_ERR(p))
  		return p;
a65d40961   Petr Mladek   kthread/smpboot: ...
416
417
  	kthread_bind(p, cpu);
  	/* CPU hotplug need to bind once again when unparking the thread. */
2a1d44601   Thomas Gleixner   kthread: Implemen...
418
419
  	set_bit(KTHREAD_IS_PER_CPU, &to_kthread(p)->flags);
  	to_kthread(p)->cpu = cpu;
2a1d44601   Thomas Gleixner   kthread: Implemen...
420
421
  	return p;
  }
cf380a4a9   Oleg Nesterov   kthread: Don't us...
422
423
424
425
426
427
428
429
430
  /**
   * kthread_unpark - unpark a thread created by kthread_create().
   * @k:		thread created by kthread_create().
   *
   * Sets kthread_should_park() for @k to return false, wakes it, and
   * waits for it to return. If the thread is marked percpu then its
   * bound to the cpu again.
   */
  void kthread_unpark(struct task_struct *k)
f2530dc71   Thomas Gleixner   kthread: Prevent ...
431
  {
cf380a4a9   Oleg Nesterov   kthread: Don't us...
432
  	struct kthread *kthread = to_kthread(k);
f2530dc71   Thomas Gleixner   kthread: Prevent ...
433
434
435
436
437
438
439
440
  	clear_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
  	/*
  	 * We clear the IS_PARKED bit here as we don't wait
  	 * until the task has left the park code. So if we'd
  	 * park before that happens we'd see the IS_PARKED bit
  	 * which might be about to be cleared.
  	 */
  	if (test_and_clear_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
a65d40961   Petr Mladek   kthread/smpboot: ...
441
442
443
444
  		/*
  		 * Newly created kthread was parked when the CPU was offline.
  		 * The binding was lost and we need to set it again.
  		 */
f2530dc71   Thomas Gleixner   kthread: Prevent ...
445
446
447
448
449
  		if (test_bit(KTHREAD_IS_PER_CPU, &kthread->flags))
  			__kthread_bind(k, kthread->cpu, TASK_PARKED);
  		wake_up_state(k, TASK_PARKED);
  	}
  }
18896451e   David Kershner   kthread: export k...
450
  EXPORT_SYMBOL_GPL(kthread_unpark);
2a1d44601   Thomas Gleixner   kthread: Implemen...
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
  
  /**
   * kthread_park - park a thread created by kthread_create().
   * @k: thread created by kthread_create().
   *
   * Sets kthread_should_park() for @k to return true, wakes it, and
   * waits for it to return. This can also be called after kthread_create()
   * instead of calling wake_up_process(): the thread will park without
   * calling threadfn().
   *
   * Returns 0 if the thread is parked, -ENOSYS if the thread exited.
   * If called by the kthread itself just the park bit is set.
   */
  int kthread_park(struct task_struct *k)
  {
cf380a4a9   Oleg Nesterov   kthread: Don't us...
466
467
468
469
470
471
472
473
474
475
  	struct kthread *kthread = to_kthread(k);
  
  	if (WARN_ON(k->flags & PF_EXITING))
  		return -ENOSYS;
  
  	if (!test_bit(KTHREAD_IS_PARKED, &kthread->flags)) {
  		set_bit(KTHREAD_SHOULD_PARK, &kthread->flags);
  		if (k != current) {
  			wake_up_process(k);
  			wait_for_completion(&kthread->parked);
2a1d44601   Thomas Gleixner   kthread: Implemen...
476
  		}
2a1d44601   Thomas Gleixner   kthread: Implemen...
477
  	}
cf380a4a9   Oleg Nesterov   kthread: Don't us...
478
479
  
  	return 0;
2a1d44601   Thomas Gleixner   kthread: Implemen...
480
  }
18896451e   David Kershner   kthread: export k...
481
  EXPORT_SYMBOL_GPL(kthread_park);
2a1d44601   Thomas Gleixner   kthread: Implemen...
482
483
  
  /**
9e37bd301   Randy Dunlap   [PATCH] kthread: ...
484
485
486
487
   * kthread_stop - stop a thread created by kthread_create().
   * @k: thread created by kthread_create().
   *
   * Sets kthread_should_stop() for @k to return true, wakes it, and
9ae260270   Oleg Nesterov   update the commen...
488
489
490
491
492
493
   * waits for it to exit. This can also be called after kthread_create()
   * instead of calling wake_up_process(): the thread will exit without
   * calling threadfn().
   *
   * If threadfn() may call do_exit() itself, the caller must ensure
   * task_struct can't go away.
9e37bd301   Randy Dunlap   [PATCH] kthread: ...
494
495
496
497
   *
   * Returns the result of threadfn(), or %-EINTR if wake_up_process()
   * was never called.
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
498
499
  int kthread_stop(struct task_struct *k)
  {
b5c5442bb   Oleg Nesterov   kthread: kill tas...
500
  	struct kthread *kthread;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
501
  	int ret;
0a16b6075   Mathieu Desnoyers   tracing, sched: L...
502
  	trace_sched_kthread_stop(k);
b5c5442bb   Oleg Nesterov   kthread: kill tas...
503
504
  
  	get_task_struct(k);
efb29fbfa   Oleg Nesterov   kthread: Don't us...
505
506
  	kthread = to_kthread(k);
  	set_bit(KTHREAD_SHOULD_STOP, &kthread->flags);
cf380a4a9   Oleg Nesterov   kthread: Don't us...
507
  	kthread_unpark(k);
efb29fbfa   Oleg Nesterov   kthread: Don't us...
508
509
  	wake_up_process(k);
  	wait_for_completion(&kthread->exited);
63706172f   Oleg Nesterov   kthreads: rework ...
510
  	ret = k->exit_code;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
511
  	put_task_struct(k);
0a16b6075   Mathieu Desnoyers   tracing, sched: L...
512

b5c5442bb   Oleg Nesterov   kthread: kill tas...
513
  	trace_sched_kthread_stop_ret(ret);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
514
515
  	return ret;
  }
52e92e578   Adrian Bunk   [PATCH] remove ke...
516
  EXPORT_SYMBOL(kthread_stop);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
517

e804a4a4d   Satyam Sharma   kthread: silence ...
518
  int kthreadd(void *unused)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
519
  {
73c279927   Eric W. Biederman   kthread: don't de...
520
  	struct task_struct *tsk = current;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
521

e804a4a4d   Satyam Sharma   kthread: silence ...
522
  	/* Setup a clean context for our children to inherit. */
73c279927   Eric W. Biederman   kthread: don't de...
523
  	set_task_comm(tsk, "kthreadd");
10ab825bd   Oleg Nesterov   change kernel thr...
524
  	ignore_signals(tsk);
1a2142afa   Rusty Russell   cpumask: remove d...
525
  	set_cpus_allowed_ptr(tsk, cpu_all_mask);
aee4faa49   Lai Jiangshan   kthread: use N_ME...
526
  	set_mems_allowed(node_states[N_MEMORY]);
73c279927   Eric W. Biederman   kthread: don't de...
527

34b087e48   Tejun Heo   freezer: kill unu...
528
  	current->flags |= PF_NOFREEZE;
77f88796c   Tejun Heo   cgroup, kthread: ...
529
  	cgroup_init_kthreadd();
73c279927   Eric W. Biederman   kthread: don't de...
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
  
  	for (;;) {
  		set_current_state(TASK_INTERRUPTIBLE);
  		if (list_empty(&kthread_create_list))
  			schedule();
  		__set_current_state(TASK_RUNNING);
  
  		spin_lock(&kthread_create_lock);
  		while (!list_empty(&kthread_create_list)) {
  			struct kthread_create_info *create;
  
  			create = list_entry(kthread_create_list.next,
  					    struct kthread_create_info, list);
  			list_del_init(&create->list);
  			spin_unlock(&kthread_create_lock);
  
  			create_kthread(create);
  
  			spin_lock(&kthread_create_lock);
  		}
  		spin_unlock(&kthread_create_lock);
  	}
  
  	return 0;
  }
b56c0d893   Tejun Heo   kthread: implemen...
555

3989144f8   Petr Mladek   kthread: kthread ...
556
  void __kthread_init_worker(struct kthread_worker *worker,
4f32e9b1f   Yong Zhang   kthread_work: mak...
557
558
559
  				const char *name,
  				struct lock_class_key *key)
  {
dbf52682c   Petr Mladek   kthread: better s...
560
  	memset(worker, 0, sizeof(struct kthread_worker));
4f32e9b1f   Yong Zhang   kthread_work: mak...
561
562
563
  	spin_lock_init(&worker->lock);
  	lockdep_set_class_and_name(&worker->lock, key, name);
  	INIT_LIST_HEAD(&worker->work_list);
22597dc3d   Petr Mladek   kthread: initial ...
564
  	INIT_LIST_HEAD(&worker->delayed_work_list);
4f32e9b1f   Yong Zhang   kthread_work: mak...
565
  }
3989144f8   Petr Mladek   kthread: kthread ...
566
  EXPORT_SYMBOL_GPL(__kthread_init_worker);
4f32e9b1f   Yong Zhang   kthread_work: mak...
567

b56c0d893   Tejun Heo   kthread: implemen...
568
569
570
571
  /**
   * kthread_worker_fn - kthread function to process kthread_worker
   * @worker_ptr: pointer to initialized kthread_worker
   *
fbae2d44a   Petr Mladek   kthread: add kthr...
572
573
574
   * This function implements the main cycle of kthread worker. It processes
   * work_list until it is stopped with kthread_stop(). It sleeps when the queue
   * is empty.
b56c0d893   Tejun Heo   kthread: implemen...
575
   *
fbae2d44a   Petr Mladek   kthread: add kthr...
576
577
578
   * The works are not allowed to keep any locks, disable preemption or interrupts
   * when they finish. There is defined a safe point for freezing when one work
   * finishes and before a new one is started.
8197b3d43   Petr Mladek   kthread: detect w...
579
580
581
   *
   * Also the works must not be handled by more than one worker at the same time,
   * see also kthread_queue_work().
b56c0d893   Tejun Heo   kthread: implemen...
582
583
584
585
586
   */
  int kthread_worker_fn(void *worker_ptr)
  {
  	struct kthread_worker *worker = worker_ptr;
  	struct kthread_work *work;
fbae2d44a   Petr Mladek   kthread: add kthr...
587
588
589
590
591
  	/*
  	 * FIXME: Update the check and remove the assignment when all kthread
  	 * worker users are created using kthread_create_worker*() functions.
  	 */
  	WARN_ON(worker->task && worker->task != current);
b56c0d893   Tejun Heo   kthread: implemen...
592
  	worker->task = current;
dbf52682c   Petr Mladek   kthread: better s...
593
594
595
  
  	if (worker->flags & KTW_FREEZABLE)
  		set_freezable();
b56c0d893   Tejun Heo   kthread: implemen...
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
  repeat:
  	set_current_state(TASK_INTERRUPTIBLE);	/* mb paired w/ kthread_stop */
  
  	if (kthread_should_stop()) {
  		__set_current_state(TASK_RUNNING);
  		spin_lock_irq(&worker->lock);
  		worker->task = NULL;
  		spin_unlock_irq(&worker->lock);
  		return 0;
  	}
  
  	work = NULL;
  	spin_lock_irq(&worker->lock);
  	if (!list_empty(&worker->work_list)) {
  		work = list_first_entry(&worker->work_list,
  					struct kthread_work, node);
  		list_del_init(&work->node);
  	}
46f3d9762   Tejun Heo   kthread_worker: r...
614
  	worker->current_work = work;
b56c0d893   Tejun Heo   kthread: implemen...
615
616
617
618
619
  	spin_unlock_irq(&worker->lock);
  
  	if (work) {
  		__set_current_state(TASK_RUNNING);
  		work->func(work);
b56c0d893   Tejun Heo   kthread: implemen...
620
621
622
623
  	} else if (!freezing(current))
  		schedule();
  
  	try_to_freeze();
22cf8bc6c   Shaohua Li   kernel/kthread.c:...
624
  	cond_resched();
b56c0d893   Tejun Heo   kthread: implemen...
625
626
627
  	goto repeat;
  }
  EXPORT_SYMBOL_GPL(kthread_worker_fn);
c0b942a76   Nicolas Iooss   kthread: add __pr...
628
  static __printf(3, 0) struct kthread_worker *
dbf52682c   Petr Mladek   kthread: better s...
629
630
  __kthread_create_worker(int cpu, unsigned int flags,
  			const char namefmt[], va_list args)
fbae2d44a   Petr Mladek   kthread: add kthr...
631
632
633
  {
  	struct kthread_worker *worker;
  	struct task_struct *task;
8fb9dcbdc   Oleg Nesterov   kthread: Don't ab...
634
  	int node = -1;
fbae2d44a   Petr Mladek   kthread: add kthr...
635
636
637
638
639
640
  
  	worker = kzalloc(sizeof(*worker), GFP_KERNEL);
  	if (!worker)
  		return ERR_PTR(-ENOMEM);
  
  	kthread_init_worker(worker);
8fb9dcbdc   Oleg Nesterov   kthread: Don't ab...
641
642
  	if (cpu >= 0)
  		node = cpu_to_node(cpu);
fbae2d44a   Petr Mladek   kthread: add kthr...
643

8fb9dcbdc   Oleg Nesterov   kthread: Don't ab...
644
645
  	task = __kthread_create_on_node(kthread_worker_fn, worker,
  						node, namefmt, args);
fbae2d44a   Petr Mladek   kthread: add kthr...
646
647
  	if (IS_ERR(task))
  		goto fail_task;
8fb9dcbdc   Oleg Nesterov   kthread: Don't ab...
648
649
  	if (cpu >= 0)
  		kthread_bind(task, cpu);
dbf52682c   Petr Mladek   kthread: better s...
650
  	worker->flags = flags;
fbae2d44a   Petr Mladek   kthread: add kthr...
651
652
653
654
655
656
657
658
659
660
661
  	worker->task = task;
  	wake_up_process(task);
  	return worker;
  
  fail_task:
  	kfree(worker);
  	return ERR_CAST(task);
  }
  
  /**
   * kthread_create_worker - create a kthread worker
dbf52682c   Petr Mladek   kthread: better s...
662
   * @flags: flags modifying the default behavior of the worker
fbae2d44a   Petr Mladek   kthread: add kthr...
663
664
665
666
667
668
669
   * @namefmt: printf-style name for the kthread worker (task).
   *
   * Returns a pointer to the allocated worker on success, ERR_PTR(-ENOMEM)
   * when the needed structures could not get allocated, and ERR_PTR(-EINTR)
   * when the worker was SIGKILLed.
   */
  struct kthread_worker *
dbf52682c   Petr Mladek   kthread: better s...
670
  kthread_create_worker(unsigned int flags, const char namefmt[], ...)
fbae2d44a   Petr Mladek   kthread: add kthr...
671
672
673
674
675
  {
  	struct kthread_worker *worker;
  	va_list args;
  
  	va_start(args, namefmt);
dbf52682c   Petr Mladek   kthread: better s...
676
  	worker = __kthread_create_worker(-1, flags, namefmt, args);
fbae2d44a   Petr Mladek   kthread: add kthr...
677
678
679
680
681
682
683
684
685
686
  	va_end(args);
  
  	return worker;
  }
  EXPORT_SYMBOL(kthread_create_worker);
  
  /**
   * kthread_create_worker_on_cpu - create a kthread worker and bind it
   *	it to a given CPU and the associated NUMA node.
   * @cpu: CPU number
dbf52682c   Petr Mladek   kthread: better s...
687
   * @flags: flags modifying the default behavior of the worker
fbae2d44a   Petr Mladek   kthread: add kthr...
688
689
690
691
692
693
694
695
696
697
698
699
700
   * @namefmt: printf-style name for the kthread worker (task).
   *
   * Use a valid CPU number if you want to bind the kthread worker
   * to the given CPU and the associated NUMA node.
   *
   * A good practice is to add the cpu number also into the worker name.
   * For example, use kthread_create_worker_on_cpu(cpu, "helper/%d", cpu).
   *
   * Returns a pointer to the allocated worker on success, ERR_PTR(-ENOMEM)
   * when the needed structures could not get allocated, and ERR_PTR(-EINTR)
   * when the worker was SIGKILLed.
   */
  struct kthread_worker *
dbf52682c   Petr Mladek   kthread: better s...
701
702
  kthread_create_worker_on_cpu(int cpu, unsigned int flags,
  			     const char namefmt[], ...)
fbae2d44a   Petr Mladek   kthread: add kthr...
703
704
705
706
707
  {
  	struct kthread_worker *worker;
  	va_list args;
  
  	va_start(args, namefmt);
dbf52682c   Petr Mladek   kthread: better s...
708
  	worker = __kthread_create_worker(cpu, flags, namefmt, args);
fbae2d44a   Petr Mladek   kthread: add kthr...
709
710
711
712
713
  	va_end(args);
  
  	return worker;
  }
  EXPORT_SYMBOL(kthread_create_worker_on_cpu);
37be45d49   Petr Mladek   kthread: allow to...
714
715
716
717
718
719
720
721
722
723
724
725
  /*
   * Returns true when the work could not be queued at the moment.
   * It happens when it is already pending in a worker list
   * or when it is being cancelled.
   */
  static inline bool queuing_blocked(struct kthread_worker *worker,
  				   struct kthread_work *work)
  {
  	lockdep_assert_held(&worker->lock);
  
  	return !list_empty(&work->node) || work->canceling;
  }
8197b3d43   Petr Mladek   kthread: detect w...
726
727
728
729
730
731
732
733
  static void kthread_insert_work_sanity_check(struct kthread_worker *worker,
  					     struct kthread_work *work)
  {
  	lockdep_assert_held(&worker->lock);
  	WARN_ON_ONCE(!list_empty(&work->node));
  	/* Do not use a work with >1 worker, see kthread_queue_work() */
  	WARN_ON_ONCE(work->worker && work->worker != worker);
  }
9a2e03d8e   Tejun Heo   kthread_worker: r...
734
  /* insert @work before @pos in @worker */
3989144f8   Petr Mladek   kthread: kthread ...
735
  static void kthread_insert_work(struct kthread_worker *worker,
8197b3d43   Petr Mladek   kthread: detect w...
736
737
  				struct kthread_work *work,
  				struct list_head *pos)
9a2e03d8e   Tejun Heo   kthread_worker: r...
738
  {
8197b3d43   Petr Mladek   kthread: detect w...
739
  	kthread_insert_work_sanity_check(worker, work);
9a2e03d8e   Tejun Heo   kthread_worker: r...
740
741
  
  	list_add_tail(&work->node, pos);
46f3d9762   Tejun Heo   kthread_worker: r...
742
  	work->worker = worker;
ed1403ec2   Lai Jiangshan   kthread_work: wak...
743
  	if (!worker->current_work && likely(worker->task))
9a2e03d8e   Tejun Heo   kthread_worker: r...
744
745
  		wake_up_process(worker->task);
  }
b56c0d893   Tejun Heo   kthread: implemen...
746
  /**
3989144f8   Petr Mladek   kthread: kthread ...
747
   * kthread_queue_work - queue a kthread_work
b56c0d893   Tejun Heo   kthread: implemen...
748
749
750
751
752
753
   * @worker: target kthread_worker
   * @work: kthread_work to queue
   *
   * Queue @work to work processor @task for async execution.  @task
   * must have been created with kthread_worker_create().  Returns %true
   * if @work was successfully queued, %false if it was already pending.
8197b3d43   Petr Mladek   kthread: detect w...
754
755
756
   *
   * Reinitialize the work if it needs to be used by another worker.
   * For example, when the worker was stopped and started again.
b56c0d893   Tejun Heo   kthread: implemen...
757
   */
3989144f8   Petr Mladek   kthread: kthread ...
758
  bool kthread_queue_work(struct kthread_worker *worker,
b56c0d893   Tejun Heo   kthread: implemen...
759
760
761
762
763
764
  			struct kthread_work *work)
  {
  	bool ret = false;
  	unsigned long flags;
  
  	spin_lock_irqsave(&worker->lock, flags);
37be45d49   Petr Mladek   kthread: allow to...
765
  	if (!queuing_blocked(worker, work)) {
3989144f8   Petr Mladek   kthread: kthread ...
766
  		kthread_insert_work(worker, work, &worker->work_list);
b56c0d893   Tejun Heo   kthread: implemen...
767
768
769
770
771
  		ret = true;
  	}
  	spin_unlock_irqrestore(&worker->lock, flags);
  	return ret;
  }
3989144f8   Petr Mladek   kthread: kthread ...
772
  EXPORT_SYMBOL_GPL(kthread_queue_work);
b56c0d893   Tejun Heo   kthread: implemen...
773

22597dc3d   Petr Mladek   kthread: initial ...
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
  /**
   * kthread_delayed_work_timer_fn - callback that queues the associated kthread
   *	delayed work when the timer expires.
   * @__data: pointer to the data associated with the timer
   *
   * The format of the function is defined by struct timer_list.
   * It should have been called from irqsafe timer with irq already off.
   */
  void kthread_delayed_work_timer_fn(unsigned long __data)
  {
  	struct kthread_delayed_work *dwork =
  		(struct kthread_delayed_work *)__data;
  	struct kthread_work *work = &dwork->work;
  	struct kthread_worker *worker = work->worker;
  
  	/*
  	 * This might happen when a pending work is reinitialized.
  	 * It means that it is used a wrong way.
  	 */
  	if (WARN_ON_ONCE(!worker))
  		return;
  
  	spin_lock(&worker->lock);
  	/* Work must not be used with >1 worker, see kthread_queue_work(). */
  	WARN_ON_ONCE(work->worker != worker);
  
  	/* Move the work from worker->delayed_work_list. */
  	WARN_ON_ONCE(list_empty(&work->node));
  	list_del_init(&work->node);
  	kthread_insert_work(worker, work, &worker->work_list);
  
  	spin_unlock(&worker->lock);
  }
  EXPORT_SYMBOL(kthread_delayed_work_timer_fn);
  
  void __kthread_queue_delayed_work(struct kthread_worker *worker,
  				  struct kthread_delayed_work *dwork,
  				  unsigned long delay)
  {
  	struct timer_list *timer = &dwork->timer;
  	struct kthread_work *work = &dwork->work;
  
  	WARN_ON_ONCE(timer->function != kthread_delayed_work_timer_fn ||
  		     timer->data != (unsigned long)dwork);
  
  	/*
  	 * If @delay is 0, queue @dwork->work immediately.  This is for
  	 * both optimization and correctness.  The earliest @timer can
  	 * expire is on the closest next tick and delayed_work users depend
  	 * on that there's no such delay when @delay is 0.
  	 */
  	if (!delay) {
  		kthread_insert_work(worker, work, &worker->work_list);
  		return;
  	}
  
  	/* Be paranoid and try to detect possible races already now. */
  	kthread_insert_work_sanity_check(worker, work);
  
  	list_add(&work->node, &worker->delayed_work_list);
  	work->worker = worker;
22597dc3d   Petr Mladek   kthread: initial ...
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
  	timer->expires = jiffies + delay;
  	add_timer(timer);
  }
  
  /**
   * kthread_queue_delayed_work - queue the associated kthread work
   *	after a delay.
   * @worker: target kthread_worker
   * @dwork: kthread_delayed_work to queue
   * @delay: number of jiffies to wait before queuing
   *
   * If the work has not been pending it starts a timer that will queue
   * the work after the given @delay. If @delay is zero, it queues the
   * work immediately.
   *
   * Return: %false if the @work has already been pending. It means that
   * either the timer was running or the work was queued. It returns %true
   * otherwise.
   */
  bool kthread_queue_delayed_work(struct kthread_worker *worker,
  				struct kthread_delayed_work *dwork,
  				unsigned long delay)
  {
  	struct kthread_work *work = &dwork->work;
  	unsigned long flags;
  	bool ret = false;
  
  	spin_lock_irqsave(&worker->lock, flags);
37be45d49   Petr Mladek   kthread: allow to...
863
  	if (!queuing_blocked(worker, work)) {
22597dc3d   Petr Mladek   kthread: initial ...
864
865
866
867
868
869
870
871
  		__kthread_queue_delayed_work(worker, dwork, delay);
  		ret = true;
  	}
  
  	spin_unlock_irqrestore(&worker->lock, flags);
  	return ret;
  }
  EXPORT_SYMBOL_GPL(kthread_queue_delayed_work);
9a2e03d8e   Tejun Heo   kthread_worker: r...
872
873
874
875
876
877
878
879
880
881
882
  struct kthread_flush_work {
  	struct kthread_work	work;
  	struct completion	done;
  };
  
  static void kthread_flush_work_fn(struct kthread_work *work)
  {
  	struct kthread_flush_work *fwork =
  		container_of(work, struct kthread_flush_work, work);
  	complete(&fwork->done);
  }
b56c0d893   Tejun Heo   kthread: implemen...
883
  /**
3989144f8   Petr Mladek   kthread: kthread ...
884
   * kthread_flush_work - flush a kthread_work
b56c0d893   Tejun Heo   kthread: implemen...
885
886
887
888
   * @work: work to flush
   *
   * If @work is queued or executing, wait for it to finish execution.
   */
3989144f8   Petr Mladek   kthread: kthread ...
889
  void kthread_flush_work(struct kthread_work *work)
b56c0d893   Tejun Heo   kthread: implemen...
890
  {
46f3d9762   Tejun Heo   kthread_worker: r...
891
892
893
894
895
896
  	struct kthread_flush_work fwork = {
  		KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
  		COMPLETION_INITIALIZER_ONSTACK(fwork.done),
  	};
  	struct kthread_worker *worker;
  	bool noop = false;
46f3d9762   Tejun Heo   kthread_worker: r...
897
898
899
  	worker = work->worker;
  	if (!worker)
  		return;
b56c0d893   Tejun Heo   kthread: implemen...
900

46f3d9762   Tejun Heo   kthread_worker: r...
901
  	spin_lock_irq(&worker->lock);
8197b3d43   Petr Mladek   kthread: detect w...
902
903
  	/* Work must not be used with >1 worker, see kthread_queue_work(). */
  	WARN_ON_ONCE(work->worker != worker);
b56c0d893   Tejun Heo   kthread: implemen...
904

46f3d9762   Tejun Heo   kthread_worker: r...
905
  	if (!list_empty(&work->node))
3989144f8   Petr Mladek   kthread: kthread ...
906
  		kthread_insert_work(worker, &fwork.work, work->node.next);
46f3d9762   Tejun Heo   kthread_worker: r...
907
  	else if (worker->current_work == work)
3989144f8   Petr Mladek   kthread: kthread ...
908
909
  		kthread_insert_work(worker, &fwork.work,
  				    worker->work_list.next);
46f3d9762   Tejun Heo   kthread_worker: r...
910
911
  	else
  		noop = true;
b56c0d893   Tejun Heo   kthread: implemen...
912

46f3d9762   Tejun Heo   kthread_worker: r...
913
  	spin_unlock_irq(&worker->lock);
b56c0d893   Tejun Heo   kthread: implemen...
914

46f3d9762   Tejun Heo   kthread_worker: r...
915
916
  	if (!noop)
  		wait_for_completion(&fwork.done);
b56c0d893   Tejun Heo   kthread: implemen...
917
  }
3989144f8   Petr Mladek   kthread: kthread ...
918
  EXPORT_SYMBOL_GPL(kthread_flush_work);
b56c0d893   Tejun Heo   kthread: implemen...
919

37be45d49   Petr Mladek   kthread: allow to...
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
  /*
   * This function removes the work from the worker queue. Also it makes sure
   * that it won't get queued later via the delayed work's timer.
   *
   * The work might still be in use when this function finishes. See the
   * current_work proceed by the worker.
   *
   * Return: %true if @work was pending and successfully canceled,
   *	%false if @work was not pending
   */
  static bool __kthread_cancel_work(struct kthread_work *work, bool is_dwork,
  				  unsigned long *flags)
  {
  	/* Try to cancel the timer if exists. */
  	if (is_dwork) {
  		struct kthread_delayed_work *dwork =
  			container_of(work, struct kthread_delayed_work, work);
  		struct kthread_worker *worker = work->worker;
  
  		/*
  		 * del_timer_sync() must be called to make sure that the timer
  		 * callback is not running. The lock must be temporary released
  		 * to avoid a deadlock with the callback. In the meantime,
  		 * any queuing is blocked by setting the canceling counter.
  		 */
  		work->canceling++;
  		spin_unlock_irqrestore(&worker->lock, *flags);
  		del_timer_sync(&dwork->timer);
  		spin_lock_irqsave(&worker->lock, *flags);
  		work->canceling--;
  	}
  
  	/*
  	 * Try to remove the work from a worker list. It might either
  	 * be from worker->work_list or from worker->delayed_work_list.
  	 */
  	if (!list_empty(&work->node)) {
  		list_del_init(&work->node);
  		return true;
  	}
  
  	return false;
  }
9a6b06c8d   Petr Mladek   kthread: allow to...
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
  /**
   * kthread_mod_delayed_work - modify delay of or queue a kthread delayed work
   * @worker: kthread worker to use
   * @dwork: kthread delayed work to queue
   * @delay: number of jiffies to wait before queuing
   *
   * If @dwork is idle, equivalent to kthread_queue_delayed_work(). Otherwise,
   * modify @dwork's timer so that it expires after @delay. If @delay is zero,
   * @work is guaranteed to be queued immediately.
   *
   * Return: %true if @dwork was pending and its timer was modified,
   * %false otherwise.
   *
   * A special case is when the work is being canceled in parallel.
   * It might be caused either by the real kthread_cancel_delayed_work_sync()
   * or yet another kthread_mod_delayed_work() call. We let the other command
   * win and return %false here. The caller is supposed to synchronize these
   * operations a reasonable way.
   *
   * This function is safe to call from any context including IRQ handler.
   * See __kthread_cancel_work() and kthread_delayed_work_timer_fn()
   * for details.
   */
  bool kthread_mod_delayed_work(struct kthread_worker *worker,
  			      struct kthread_delayed_work *dwork,
  			      unsigned long delay)
  {
  	struct kthread_work *work = &dwork->work;
  	unsigned long flags;
  	int ret = false;
  
  	spin_lock_irqsave(&worker->lock, flags);
  
  	/* Do not bother with canceling when never queued. */
  	if (!work->worker)
  		goto fast_queue;
  
  	/* Work must not be used with >1 worker, see kthread_queue_work() */
  	WARN_ON_ONCE(work->worker != worker);
  
  	/* Do not fight with another command that is canceling this work. */
  	if (work->canceling)
  		goto out;
  
  	ret = __kthread_cancel_work(work, true, &flags);
  fast_queue:
  	__kthread_queue_delayed_work(worker, dwork, delay);
  out:
  	spin_unlock_irqrestore(&worker->lock, flags);
  	return ret;
  }
  EXPORT_SYMBOL_GPL(kthread_mod_delayed_work);
37be45d49   Petr Mladek   kthread: allow to...
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
  static bool __kthread_cancel_work_sync(struct kthread_work *work, bool is_dwork)
  {
  	struct kthread_worker *worker = work->worker;
  	unsigned long flags;
  	int ret = false;
  
  	if (!worker)
  		goto out;
  
  	spin_lock_irqsave(&worker->lock, flags);
  	/* Work must not be used with >1 worker, see kthread_queue_work(). */
  	WARN_ON_ONCE(work->worker != worker);
  
  	ret = __kthread_cancel_work(work, is_dwork, &flags);
  
  	if (worker->current_work != work)
  		goto out_fast;
  
  	/*
  	 * The work is in progress and we need to wait with the lock released.
  	 * In the meantime, block any queuing by setting the canceling counter.
  	 */
  	work->canceling++;
  	spin_unlock_irqrestore(&worker->lock, flags);
  	kthread_flush_work(work);
  	spin_lock_irqsave(&worker->lock, flags);
  	work->canceling--;
  
  out_fast:
  	spin_unlock_irqrestore(&worker->lock, flags);
  out:
  	return ret;
  }
  
  /**
   * kthread_cancel_work_sync - cancel a kthread work and wait for it to finish
   * @work: the kthread work to cancel
   *
   * Cancel @work and wait for its execution to finish.  This function
   * can be used even if the work re-queues itself. On return from this
   * function, @work is guaranteed to be not pending or executing on any CPU.
   *
   * kthread_cancel_work_sync(&delayed_work->work) must not be used for
   * delayed_work's. Use kthread_cancel_delayed_work_sync() instead.
   *
   * The caller must ensure that the worker on which @work was last
   * queued can't be destroyed before this function returns.
   *
   * Return: %true if @work was pending, %false otherwise.
   */
  bool kthread_cancel_work_sync(struct kthread_work *work)
  {
  	return __kthread_cancel_work_sync(work, false);
  }
  EXPORT_SYMBOL_GPL(kthread_cancel_work_sync);
  
  /**
   * kthread_cancel_delayed_work_sync - cancel a kthread delayed work and
   *	wait for it to finish.
   * @dwork: the kthread delayed work to cancel
   *
   * This is kthread_cancel_work_sync() for delayed works.
   *
   * Return: %true if @dwork was pending, %false otherwise.
   */
  bool kthread_cancel_delayed_work_sync(struct kthread_delayed_work *dwork)
  {
  	return __kthread_cancel_work_sync(&dwork->work, true);
  }
  EXPORT_SYMBOL_GPL(kthread_cancel_delayed_work_sync);
b56c0d893   Tejun Heo   kthread: implemen...
1085
  /**
3989144f8   Petr Mladek   kthread: kthread ...
1086
   * kthread_flush_worker - flush all current works on a kthread_worker
b56c0d893   Tejun Heo   kthread: implemen...
1087
1088
1089
1090
1091
   * @worker: worker to flush
   *
   * Wait until all currently executing or pending works on @worker are
   * finished.
   */
3989144f8   Petr Mladek   kthread: kthread ...
1092
  void kthread_flush_worker(struct kthread_worker *worker)
b56c0d893   Tejun Heo   kthread: implemen...
1093
1094
1095
1096
1097
  {
  	struct kthread_flush_work fwork = {
  		KTHREAD_WORK_INIT(fwork.work, kthread_flush_work_fn),
  		COMPLETION_INITIALIZER_ONSTACK(fwork.done),
  	};
3989144f8   Petr Mladek   kthread: kthread ...
1098
  	kthread_queue_work(worker, &fwork.work);
b56c0d893   Tejun Heo   kthread: implemen...
1099
1100
  	wait_for_completion(&fwork.done);
  }
3989144f8   Petr Mladek   kthread: kthread ...
1101
  EXPORT_SYMBOL_GPL(kthread_flush_worker);
35033fe9c   Petr Mladek   kthread: add kthr...
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
  
  /**
   * kthread_destroy_worker - destroy a kthread worker
   * @worker: worker to be destroyed
   *
   * Flush and destroy @worker.  The simple flush is enough because the kthread
   * worker API is used only in trivial scenarios.  There are no multi-step state
   * machines needed.
   */
  void kthread_destroy_worker(struct kthread_worker *worker)
  {
  	struct task_struct *task;
  
  	task = worker->task;
  	if (WARN_ON(!task))
  		return;
  
  	kthread_flush_worker(worker);
  	kthread_stop(task);
  	WARN_ON(!list_empty(&worker->work_list));
  	kfree(worker);
  }
  EXPORT_SYMBOL(kthread_destroy_worker);