kthread.h revision 271127 
1/*-
2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice unmodified, this list of conditions, and the following
13 *    disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 */
29#ifndef	_LINUX_KTHREAD_H_
30#define	_LINUX_KTHREAD_H_
31
32#include <sys/param.h>
33#include <sys/lock.h>
34#include <sys/mutex.h>
35#include <sys/kernel.h>
36#include <sys/kthread.h>
37#include <sys/sleepqueue.h>
38
39#include <linux/slab.h>
40#include <linux/sched.h>
41
42static inline void
43_kthread_fn(void *arg)
44{
45	struct task_struct *task;
46
47	task = arg;
48	task_struct_set(curthread, task);
49	if (task->should_stop == 0)
50		task->task_ret = task->task_fn(task->task_data);
51	PROC_LOCK(task->task_thread->td_proc);
52	task->should_stop = TASK_STOPPED;
53	wakeup(task);
54	PROC_UNLOCK(task->task_thread->td_proc);
55	kthread_exit();
56}
57
58static inline struct task_struct *
59_kthread_create(int (*threadfn)(void *data), void *data)
60{
61	struct task_struct *task;
62
63	task = kzalloc(sizeof(*task), GFP_KERNEL);
64	task->task_fn = threadfn;
65	task->task_data = data;
66
67	return (task);
68}
69
70struct task_struct *kthread_create(int (*threadfn)(void *data),
71                                   void *data,
72                                   const char namefmt[], ...)
73        __attribute__((format(printf, 3, 4)));
74
75#define	kthread_run(fn, data, fmt, ...)					\
76({									\
77	struct task_struct *_task;					\
78									\
79	_task = _kthread_create((fn), (data));				\
80	if (kthread_add(_kthread_fn, _task, NULL, &_task->task_thread,	\
81	    0, 0, fmt, ## __VA_ARGS__)) {				\
82		kfree(_task);						\
83		_task = NULL;						\
84	} else								\
85		task_struct_set(_task->task_thread, _task);		\
86	_task;								\
87})
88
89#define	kthread_should_stop()	current->should_stop
90
91static inline int
92kthread_stop(struct task_struct *task)
93{
94
95	PROC_LOCK(task->task_thread->td_proc);
96	task->should_stop = TASK_SHOULD_STOP;
97	wake_up_process(task);
98	while (task->should_stop != TASK_STOPPED)
99		msleep(task, &task->task_thread->td_proc->p_mtx, PWAIT,
100		    "kstop", hz);
101	PROC_UNLOCK(task->task_thread->td_proc);
102	return task->task_ret;
103}
104
105#endif	/* _LINUX_KTHREAD_H_ */
106