workqueue.h 6.24 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10
/*
 * workqueue.h --- work queue handling for Linux.
 */

#ifndef _LINUX_WORKQUEUE_H
#define _LINUX_WORKQUEUE_H

#include <linux/timer.h>
#include <linux/linkage.h>
#include <linux/bitops.h>
11
#include <linux/lockdep.h>
12
#include <asm/atomic.h>
Linus Torvalds's avatar
Linus Torvalds committed
13 14 15

struct workqueue_struct;

16 17
struct work_struct;
typedef void (*work_func_t)(struct work_struct *work);
18

19 20 21 22 23 24
/*
 * The first word is the work queue pointer and the flags rolled into
 * one
 */
#define work_data_bits(work) ((unsigned long *)(&(work)->data))

Linus Torvalds's avatar
Linus Torvalds committed
25
struct work_struct {
26
	atomic_long_t data;
27 28 29
#define WORK_STRUCT_PENDING 0		/* T if work item pending execution */
#define WORK_STRUCT_FLAG_MASK (3UL)
#define WORK_STRUCT_WQ_DATA_MASK (~WORK_STRUCT_FLAG_MASK)
Linus Torvalds's avatar
Linus Torvalds committed
30
	struct list_head entry;
31
	work_func_t func;
32 33 34
#ifdef CONFIG_LOCKDEP
	struct lockdep_map lockdep_map;
#endif
35 36
};

37
#define WORK_DATA_INIT()	ATOMIC_LONG_INIT(0)
38

39 40
struct delayed_work {
	struct work_struct work;
Linus Torvalds's avatar
Linus Torvalds committed
41 42 43
	struct timer_list timer;
};

44 45 46 47
struct execute_work {
	struct work_struct work;
};

48 49 50 51 52 53 54 55 56 57 58 59
#ifdef CONFIG_LOCKDEP
/*
 * NB: because we have to copy the lockdep_map, setting _key
 * here is required, otherwise it could get initialised to the
 * copy of the lockdep_map!
 */
#define __WORK_INIT_LOCKDEP_MAP(n, k) \
	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
#else
#define __WORK_INIT_LOCKDEP_MAP(n, k)
#endif

60
#define __WORK_INITIALIZER(n, f) {				\
61 62
	.data = WORK_DATA_INIT(),				\
	.entry	= { &(n).entry, &(n).entry },			\
63
	.func = (f),						\
64
	__WORK_INIT_LOCKDEP_MAP(#n, &(n))			\
65 66 67 68 69 70 71 72 73 74 75 76 77
	}

#define __DELAYED_WORK_INITIALIZER(n, f) {			\
	.work = __WORK_INITIALIZER((n).work, (f)),		\
	.timer = TIMER_INITIALIZER(NULL, 0, 0),			\
	}

#define DECLARE_WORK(n, f)					\
	struct work_struct n = __WORK_INITIALIZER(n, f)

#define DECLARE_DELAYED_WORK(n, f)				\
	struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)

Linus Torvalds's avatar
Linus Torvalds committed
78
/*
79
 * initialize a work item's function pointer
Linus Torvalds's avatar
Linus Torvalds committed
80
 */
81
#define PREPARE_WORK(_work, _func)				\
Linus Torvalds's avatar
Linus Torvalds committed
82
	do {							\
83
		(_work)->func = (_func);			\
Linus Torvalds's avatar
Linus Torvalds committed
84 85
	} while (0)

86 87
#define PREPARE_DELAYED_WORK(_work, _func)			\
	PREPARE_WORK(&(_work)->work, (_func))
88

Linus Torvalds's avatar
Linus Torvalds committed
89
/*
90
 * initialize all of a work item in one go
91 92 93 94
 *
 * NOTE! No point in using "atomic_long_set()": useing a direct
 * assignment of the work data initializer allows the compiler
 * to generate better code.
Linus Torvalds's avatar
Linus Torvalds committed
95
 */
96
#ifdef CONFIG_LOCKDEP
97
#define INIT_WORK(_work, _func)						\
98
	do {								\
99 100
		static struct lock_class_key __key;			\
									\
101
		(_work)->data = (atomic_long_t) WORK_DATA_INIT();	\
102
		lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0);\
103 104 105
		INIT_LIST_HEAD(&(_work)->entry);			\
		PREPARE_WORK((_work), (_func));				\
	} while (0)
106 107 108 109 110 111 112 113
#else
#define INIT_WORK(_work, _func)						\
	do {								\
		(_work)->data = (atomic_long_t) WORK_DATA_INIT();	\
		INIT_LIST_HEAD(&(_work)->entry);			\
		PREPARE_WORK((_work), (_func));				\
	} while (0)
#endif
114 115 116 117 118

#define INIT_DELAYED_WORK(_work, _func)				\
	do {							\
		INIT_WORK(&(_work)->work, (_func));		\
		init_timer(&(_work)->timer);			\
119 120
	} while (0)

121 122 123 124 125 126
#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func)			\
	do {							\
		INIT_WORK(&(_work)->work, (_func));		\
		init_timer_deferrable(&(_work)->timer);		\
	} while (0)

127 128 129 130 131
/**
 * work_pending - Find out whether a work item is currently pending
 * @work: The work item in question
 */
#define work_pending(work) \
132
	test_bit(WORK_STRUCT_PENDING, work_data_bits(work))
133 134 135 136 137 138

/**
 * delayed_work_pending - Find out whether a delayable work item is currently
 * pending
 * @work: The work item in question
 */
139 140
#define delayed_work_pending(w) \
	work_pending(&(w)->work)
141

142
/**
143 144
 * work_clear_pending - for internal use only, mark a work item as not pending
 * @work: The work item in question
145
 */
146
#define work_clear_pending(work) \
147
	clear_bit(WORK_STRUCT_PENDING, work_data_bits(work))
148

149

150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
extern struct workqueue_struct *
__create_workqueue_key(const char *name, int singlethread,
		       int freezeable, struct lock_class_key *key);

#ifdef CONFIG_LOCKDEP
#define __create_workqueue(name, singlethread, freezeable)	\
({								\
	static struct lock_class_key __key;			\
								\
	__create_workqueue_key((name), (singlethread),		\
			       (freezeable), &__key);		\
})
#else
#define __create_workqueue(name, singlethread, freezeable)	\
	__create_workqueue_key((name), (singlethread), (freezeable), NULL)
#endif

167
#define create_workqueue(name) __create_workqueue((name), 0, 0)
168
#define create_freezeable_workqueue(name) __create_workqueue((name), 1, 1)
169
#define create_singlethread_workqueue(name) __create_workqueue((name), 1, 0)
Linus Torvalds's avatar
Linus Torvalds committed
170 171 172 173

extern void destroy_workqueue(struct workqueue_struct *wq);

extern int FASTCALL(queue_work(struct workqueue_struct *wq, struct work_struct *work));
174 175
extern int FASTCALL(queue_delayed_work(struct workqueue_struct *wq,
			struct delayed_work *work, unsigned long delay));
176
extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
177 178
			struct delayed_work *work, unsigned long delay);

Linus Torvalds's avatar
Linus Torvalds committed
179
extern void FASTCALL(flush_workqueue(struct workqueue_struct *wq));
180
extern void flush_scheduled_work(void);
Linus Torvalds's avatar
Linus Torvalds committed
181 182

extern int FASTCALL(schedule_work(struct work_struct *work));
183 184 185 186
extern int FASTCALL(schedule_delayed_work(struct delayed_work *work,
					unsigned long delay));
extern int schedule_delayed_work_on(int cpu, struct delayed_work *work,
					unsigned long delay);
187
extern int schedule_on_each_cpu(work_func_t func);
Linus Torvalds's avatar
Linus Torvalds committed
188 189 190 191
extern int current_is_keventd(void);
extern int keventd_up(void);

extern void init_workqueues(void);
192
int execute_in_process_context(work_func_t fn, struct execute_work *);
Linus Torvalds's avatar
Linus Torvalds committed
193

194
extern int cancel_work_sync(struct work_struct *work);
195

Linus Torvalds's avatar
Linus Torvalds committed
196 197
/*
 * Kill off a pending schedule_delayed_work().  Note that the work callback
198 199
 * function may still be running on return from cancel_delayed_work(), unless
 * it returns 1 and the work doesn't re-arm itself. Run flush_workqueue() or
200
 * cancel_work_sync() to wait on it.
Linus Torvalds's avatar
Linus Torvalds committed
201
 */
202
static inline int cancel_delayed_work(struct delayed_work *work)
Linus Torvalds's avatar
Linus Torvalds committed
203 204 205
{
	int ret;

206
	ret = del_timer_sync(&work->timer);
Linus Torvalds's avatar
Linus Torvalds committed
207
	if (ret)
208
		work_clear_pending(&work->work);
Linus Torvalds's avatar
Linus Torvalds committed
209 210 211
	return ret;
}

212
extern int cancel_delayed_work_sync(struct delayed_work *work);
213

214
/* Obsolete. use cancel_delayed_work_sync() */
215 216 217 218
static inline
void cancel_rearming_delayed_workqueue(struct workqueue_struct *wq,
					struct delayed_work *work)
{
219 220 221 222 223 224 225 226
	cancel_delayed_work_sync(work);
}

/* Obsolete. use cancel_delayed_work_sync() */
static inline
void cancel_rearming_delayed_work(struct delayed_work *work)
{
	cancel_delayed_work_sync(work);
227 228
}

Linus Torvalds's avatar
Linus Torvalds committed
229
#endif