[mirror_ubuntu-zesty-kernel.git] / include / linux / kthread.h

#ifndef _LINUX_KTHREAD_H
#define _LINUX_KTHREAD_H
/* Simple interface for creating and stopping kernel threads without mess. */
#include <linux/err.h>
#include <linux/sched.h>

__printf(4, 5)
struct task_struct *kthread_create_on_node(int (*threadfn)(void *data),
					   void *data,
					   int node,
					   const char namefmt[], ...);

#define kthread_create(threadfn, data, namefmt, arg...) \
	kthread_create_on_node(threadfn, data, -1, namefmt, ##arg)


/**
 * kthread_run - create and wake a thread.
 * @threadfn: the function to run until signal_pending(current).
 * @data: data ptr for @threadfn.
 * @namefmt: printf-style name for the thread.
 *
 * Description: Convenient wrapper for kthread_create() followed by
 * wake_up_process().  Returns the kthread or ERR_PTR(-ENOMEM).
 */
#define kthread_run(threadfn, data, namefmt, ...)			   \
({									   \
	struct task_struct *__k						   \
		= kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
	if (!IS_ERR(__k))						   \
		wake_up_process(__k);					   \
	__k;								   \
})

void kthread_bind(struct task_struct *k, unsigned int cpu);
int kthread_stop(struct task_struct *k);
int kthread_should_stop(void);
bool kthread_freezable_should_stop(bool *was_frozen);
void *kthread_data(struct task_struct *k);

int kthreadd(void *unused);
extern struct task_struct *kthreadd_task;
extern int tsk_fork_get_node(struct task_struct *tsk);

/*
 * Simple work processor based on kthread.
 *
 * This provides easier way to make use of kthreads.  A kthread_work
 * can be queued and flushed using queue/flush_kthread_work()
 * respectively.  Queued kthread_works are processed by a kthread
 * running kthread_worker_fn().
 *
 * A kthread_work can't be freed while it is executing.
 */
struct kthread_work;
typedef void (*kthread_work_func_t)(struct kthread_work *work);

struct kthread_worker {
	spinlock_t		lock;
	struct list_head	work_list;
	struct task_struct	*task;
};

struct kthread_work {
	struct list_head	node;
	kthread_work_func_t	func;
	wait_queue_head_t	done;
	atomic_t		flushing;
	int			queue_seq;
	int			done_seq;
};

#define KTHREAD_WORKER_INIT(worker)	{				\
	.lock = __SPIN_LOCK_UNLOCKED((worker).lock),			\
	.work_list = LIST_HEAD_INIT((worker).work_list),		\
	}

#define KTHREAD_WORK_INIT(work, fn)	{				\
	.node = LIST_HEAD_INIT((work).node),				\
	.func = (fn),							\
	.done = __WAIT_QUEUE_HEAD_INITIALIZER((work).done),		\
	.flushing = ATOMIC_INIT(0),					\
	}

#define DEFINE_KTHREAD_WORKER(worker)					\
	struct kthread_worker worker = KTHREAD_WORKER_INIT(worker)

#define DEFINE_KTHREAD_WORK(work, fn)					\
	struct kthread_work work = KTHREAD_WORK_INIT(work, fn)

/*
 * kthread_worker.lock and kthread_work.done need their own lockdep class
 * keys if they are defined on stack with lockdep enabled.  Use the
 * following macros when defining them on stack.
 */
#ifdef CONFIG_LOCKDEP
# define KTHREAD_WORKER_INIT_ONSTACK(worker)				\
	({ init_kthread_worker(&worker); worker; })
# define DEFINE_KTHREAD_WORKER_ONSTACK(worker)				\
	struct kthread_worker worker = KTHREAD_WORKER_INIT_ONSTACK(worker)
# define KTHREAD_WORK_INIT_ONSTACK(work, fn)				\
	({ init_kthread_work((&work), fn); work; })
# define DEFINE_KTHREAD_WORK_ONSTACK(work, fn)				\
	struct kthread_work work = KTHREAD_WORK_INIT_ONSTACK(work, fn)
#else
# define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker)
# define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) DEFINE_KTHREAD_WORK(work, fn)
#endif

extern void __init_kthread_worker(struct kthread_worker *worker,
			const char *name, struct lock_class_key *key);

#define init_kthread_worker(worker)					\
	do {								\
		static struct lock_class_key __key;			\
		__init_kthread_worker((worker), "("#worker")->lock", &__key); \
	} while (0)

#define init_kthread_work(work, fn)					\
	do {								\
		memset((work), 0, sizeof(struct kthread_work));		\
		INIT_LIST_HEAD(&(work)->node);				\
		(work)->func = (fn);					\
		init_waitqueue_head(&(work)->done);			\
	} while (0)

int kthread_worker_fn(void *worker_ptr);

bool queue_kthread_work(struct kthread_worker *worker,
			struct kthread_work *work);
void flush_kthread_work(struct kthread_work *work);
void flush_kthread_worker(struct kthread_worker *worker);

#endif /* _LINUX_KTHREAD_H */
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 LT	16
1da177e4 LT	17	/**
9e37bd30	18	* kthread_run - create and wake a thread.
1da177e4 LT	19	* @threadfn: the function to run until signal_pending(current).
	20	* @data: data ptr for @threadfn.
	21	* @namefmt: printf-style name for the thread.
	22	*
	23	* Description: Convenient wrapper for kthread_create() followed by
9e37bd30 RD	24	* wake_up_process(). Returns the kthread or ERR_PTR(-ENOMEM).
9e37bd30 RD	25	*/
1da177e4 LT	26	#define kthread_run(threadfn, data, namefmt, ...) \
	27	({ \
	28	struct task_struct *__k \
	29	= kthread_create(threadfn, data, namefmt, ## __VA_ARGS__); \
	30	if (!IS_ERR(__k)) \
	31	wake_up_process(__k); \
	32	__k; \
	33	})
	34
1da177e4	35	void kthread_bind(struct task_struct *k, unsigned int cpu);
1da177e4	36	int kthread_stop(struct task_struct *k);
1da177e4	37	int kthread_should_stop(void);
8a32c441	38	bool kthread_freezable_should_stop(bool *was_frozen);
82805ab7	39	void kthread_data(struct task_struct k);
1da177e4	40
73c27992 EB	41	int kthreadd(void *unused);
73c27992 EB	42	extern struct task_struct *kthreadd_task;
207205a2	43	extern int tsk_fork_get_node(struct task_struct *tsk);
73c27992	44
b56c0d89 TH	45	/*
	46	* Simple work processor based on kthread.
	47	*
	48	* This provides easier way to make use of kthreads. A kthread_work
	49	* can be queued and flushed using queue/flush_kthread_work()
	50	* respectively. Queued kthread_works are processed by a kthread
	51	* running kthread_worker_fn().
	52	*
	53	* A kthread_work can't be freed while it is executing.
	54	*/
	55	struct kthread_work;
	56	typedef void (kthread_work_func_t)(struct kthread_work work);
	57
	58	struct kthread_worker {
	59	spinlock_t lock;
	60	struct list_head work_list;
	61	struct task_struct *task;
	62	};
	63
	64	struct kthread_work {
	65	struct list_head node;
	66	kthread_work_func_t func;
	67	wait_queue_head_t done;
	68	atomic_t flushing;
	69	int queue_seq;
	70	int done_seq;
	71	};
	72
	73	#define KTHREAD_WORKER_INIT(worker) { \
92578c0b	74	.lock = __SPIN_LOCK_UNLOCKED((worker).lock), \
b56c0d89 TH	75	.work_list = LIST_HEAD_INIT((worker).work_list), \
	76	}
	77
	78	#define KTHREAD_WORK_INIT(work, fn) { \
	79	.node = LIST_HEAD_INIT((work).node), \
	80	.func = (fn), \
	81	.done = __WAIT_QUEUE_HEAD_INITIALIZER((work).done), \
	82	.flushing = ATOMIC_INIT(0), \
	83	}
	84
	85	#define DEFINE_KTHREAD_WORKER(worker) \
	86	struct kthread_worker worker = KTHREAD_WORKER_INIT(worker)
	87
	88	#define DEFINE_KTHREAD_WORK(work, fn) \
	89	struct kthread_work work = KTHREAD_WORK_INIT(work, fn)
	90
4f32e9b1 YZ	91	/*
	92	* kthread_worker.lock and kthread_work.done need their own lockdep class
	93	* keys if they are defined on stack with lockdep enabled. Use the
	94	* following macros when defining them on stack.
	95	*/
	96	#ifdef CONFIG_LOCKDEP
	97	# define KTHREAD_WORKER_INIT_ONSTACK(worker) \
	98	({ init_kthread_worker(&worker); worker; })
	99	# define DEFINE_KTHREAD_WORKER_ONSTACK(worker) \
	100	struct kthread_worker worker = KTHREAD_WORKER_INIT_ONSTACK(worker)
	101	# define KTHREAD_WORK_INIT_ONSTACK(work, fn) \
	102	({ init_kthread_work((&work), fn); work; })
	103	# define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) \
	104	struct kthread_work work = KTHREAD_WORK_INIT_ONSTACK(work, fn)
	105	#else
	106	# define DEFINE_KTHREAD_WORKER_ONSTACK(worker) DEFINE_KTHREAD_WORKER(worker)
	107	# define DEFINE_KTHREAD_WORK_ONSTACK(work, fn) DEFINE_KTHREAD_WORK(work, fn)
	108	#endif
	109
	110	extern void __init_kthread_worker(struct kthread_worker *worker,
	111	const char name, struct lock_class_key key);
	112
	113	#define init_kthread_worker(worker) \
	114	do { \
	115	static struct lock_class_key __key; \
	116	__init_kthread_worker((worker), "("#worker")->lock", &__key); \
	117	} while (0)
	118
	119	#define init_kthread_work(work, fn) \
	120	do { \
	121	memset((work), 0, sizeof(struct kthread_work)); \
	122	INIT_LIST_HEAD(&(work)->node); \
	123	(work)->func = (fn); \
	124	init_waitqueue_head(&(work)->done); \
	125	} while (0)
b56c0d89 TH	126
	127	int kthread_worker_fn(void *worker_ptr);
	128
	129	bool queue_kthread_work(struct kthread_worker *worker,
	130	struct kthread_work *work);
	131	void flush_kthread_work(struct kthread_work *work);
	132	void flush_kthread_worker(struct kthread_worker *worker);
	133
1da177e4	134	#endif /* _LINUX_KTHREAD_H */