| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 7 | struct task_struct *kthread_create(int (*threadfn)(void *data), | 
 | 8 | 				   void *data, | 
| Rusty Russell | ed9559d | 2008-07-25 12:11:09 +1000 | [diff] [blame] | 9 | 				   const char namefmt[], ...) | 
 | 10 | 	__attribute__((format(printf, 3, 4))); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 11 |  | 
 | 12 | /** | 
| Randy Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 13 |  * kthread_run - create and wake a thread. | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 |  * @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 Dunlap | 9e37bd3 | 2006-06-25 05:49:19 -0700 | [diff] [blame] | 19 |  * wake_up_process().  Returns the kthread or ERR_PTR(-ENOMEM). | 
 | 20 |  */ | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 21 | #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 Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 30 | void kthread_bind(struct task_struct *k, unsigned int cpu); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 31 | int kthread_stop(struct task_struct *k); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 32 | int kthread_should_stop(void); | 
| Tejun Heo | 82805ab | 2010-06-29 10:07:09 +0200 | [diff] [blame] | 33 | void *kthread_data(struct task_struct *k); | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 34 |  | 
| Eric W. Biederman | 73c2799 | 2007-05-09 02:34:32 -0700 | [diff] [blame] | 35 | int kthreadd(void *unused); | 
 | 36 | extern struct task_struct *kthreadd_task; | 
 | 37 |  | 
| Tejun Heo | b56c0d8 | 2010-06-29 10:07:09 +0200 | [diff] [blame] | 38 | /* | 
 | 39 |  * Simple work processor based on kthread. | 
 | 40 |  * | 
 | 41 |  * This provides easier way to make use of kthreads.  A kthread_work | 
 | 42 |  * can be queued and flushed using queue/flush_kthread_work() | 
 | 43 |  * respectively.  Queued kthread_works are processed by a kthread | 
 | 44 |  * running kthread_worker_fn(). | 
 | 45 |  * | 
 | 46 |  * A kthread_work can't be freed while it is executing. | 
 | 47 |  */ | 
 | 48 | struct kthread_work; | 
 | 49 | typedef void (*kthread_work_func_t)(struct kthread_work *work); | 
 | 50 |  | 
 | 51 | struct kthread_worker { | 
 | 52 | 	spinlock_t		lock; | 
 | 53 | 	struct list_head	work_list; | 
 | 54 | 	struct task_struct	*task; | 
 | 55 | }; | 
 | 56 |  | 
 | 57 | struct kthread_work { | 
 | 58 | 	struct list_head	node; | 
 | 59 | 	kthread_work_func_t	func; | 
 | 60 | 	wait_queue_head_t	done; | 
 | 61 | 	atomic_t		flushing; | 
 | 62 | 	int			queue_seq; | 
 | 63 | 	int			done_seq; | 
 | 64 | }; | 
 | 65 |  | 
 | 66 | #define KTHREAD_WORKER_INIT(worker)	{				\ | 
 | 67 | 	.lock = SPIN_LOCK_UNLOCKED,					\ | 
 | 68 | 	.work_list = LIST_HEAD_INIT((worker).work_list),		\ | 
 | 69 | 	} | 
 | 70 |  | 
 | 71 | #define KTHREAD_WORK_INIT(work, fn)	{				\ | 
 | 72 | 	.node = LIST_HEAD_INIT((work).node),				\ | 
 | 73 | 	.func = (fn),							\ | 
 | 74 | 	.done = __WAIT_QUEUE_HEAD_INITIALIZER((work).done),		\ | 
 | 75 | 	.flushing = ATOMIC_INIT(0),					\ | 
 | 76 | 	} | 
 | 77 |  | 
 | 78 | #define DEFINE_KTHREAD_WORKER(worker)					\ | 
 | 79 | 	struct kthread_worker worker = KTHREAD_WORKER_INIT(worker) | 
 | 80 |  | 
 | 81 | #define DEFINE_KTHREAD_WORK(work, fn)					\ | 
 | 82 | 	struct kthread_work work = KTHREAD_WORK_INIT(work, fn) | 
 | 83 |  | 
 | 84 | static inline void init_kthread_worker(struct kthread_worker *worker) | 
 | 85 | { | 
 | 86 | 	*worker = (struct kthread_worker)KTHREAD_WORKER_INIT(*worker); | 
 | 87 | } | 
 | 88 |  | 
 | 89 | static inline void init_kthread_work(struct kthread_work *work, | 
 | 90 | 				     kthread_work_func_t fn) | 
 | 91 | { | 
 | 92 | 	*work = (struct kthread_work)KTHREAD_WORK_INIT(*work, fn); | 
 | 93 | } | 
 | 94 |  | 
 | 95 | int kthread_worker_fn(void *worker_ptr); | 
 | 96 |  | 
 | 97 | bool queue_kthread_work(struct kthread_worker *worker, | 
 | 98 | 			struct kthread_work *work); | 
 | 99 | void flush_kthread_work(struct kthread_work *work); | 
 | 100 | void flush_kthread_worker(struct kthread_worker *worker); | 
 | 101 |  | 
| Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | #endif /* _LINUX_KTHREAD_H */ |