2005-04-17 00:20:36 +02:00
|
|
|
/*
|
|
|
|
* 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>
|
2006-12-16 18:53:50 +01:00
|
|
|
#include <asm/atomic.h>
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
struct workqueue_struct;
|
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
struct work_struct;
|
|
|
|
typedef void (*work_func_t)(struct work_struct *work);
|
2006-11-22 15:54:45 +01:00
|
|
|
|
2006-12-16 18:53:50 +01:00
|
|
|
/*
|
|
|
|
* The first word is the work queue pointer and the flags rolled into
|
|
|
|
* one
|
|
|
|
*/
|
|
|
|
#define work_data_bits(work) ((unsigned long *)(&(work)->data))
|
|
|
|
|
2005-04-17 00:20:36 +02:00
|
|
|
struct work_struct {
|
2006-12-16 18:53:50 +01:00
|
|
|
atomic_long_t data;
|
2006-11-22 15:54:49 +01:00
|
|
|
#define WORK_STRUCT_PENDING 0 /* T if work item pending execution */
|
2006-11-22 15:55:48 +01:00
|
|
|
#define WORK_STRUCT_NOAUTOREL 1 /* F if work item automatically released on exec */
|
2006-11-22 15:54:49 +01:00
|
|
|
#define WORK_STRUCT_FLAG_MASK (3UL)
|
|
|
|
#define WORK_STRUCT_WQ_DATA_MASK (~WORK_STRUCT_FLAG_MASK)
|
2005-04-17 00:20:36 +02:00
|
|
|
struct list_head entry;
|
2006-11-22 15:54:45 +01:00
|
|
|
work_func_t func;
|
2006-11-22 15:54:01 +01:00
|
|
|
};
|
|
|
|
|
2006-12-16 18:53:50 +01:00
|
|
|
#define WORK_DATA_INIT(autorelease) \
|
|
|
|
ATOMIC_LONG_INIT((autorelease) << WORK_STRUCT_NOAUTOREL)
|
|
|
|
|
2006-11-22 15:54:01 +01:00
|
|
|
struct delayed_work {
|
|
|
|
struct work_struct work;
|
2005-04-17 00:20:36 +02:00
|
|
|
struct timer_list timer;
|
|
|
|
};
|
|
|
|
|
2006-02-23 19:43:43 +01:00
|
|
|
struct execute_work {
|
|
|
|
struct work_struct work;
|
|
|
|
};
|
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
#define __WORK_INITIALIZER(n, f) { \
|
2006-12-16 18:53:50 +01:00
|
|
|
.data = WORK_DATA_INIT(0), \
|
2005-04-17 00:20:36 +02:00
|
|
|
.entry = { &(n).entry, &(n).entry }, \
|
|
|
|
.func = (f), \
|
2006-11-22 15:54:01 +01:00
|
|
|
}
|
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
#define __WORK_INITIALIZER_NAR(n, f) { \
|
2006-12-16 18:53:50 +01:00
|
|
|
.data = WORK_DATA_INIT(1), \
|
2006-11-22 15:55:48 +01:00
|
|
|
.entry = { &(n).entry, &(n).entry }, \
|
|
|
|
.func = (f), \
|
|
|
|
}
|
|
|
|
|
|
|
|
#define __DELAYED_WORK_INITIALIZER(n, f) { \
|
|
|
|
.work = __WORK_INITIALIZER((n).work, (f)), \
|
|
|
|
.timer = TIMER_INITIALIZER(NULL, 0, 0), \
|
|
|
|
}
|
|
|
|
|
|
|
|
#define __DELAYED_WORK_INITIALIZER_NAR(n, f) { \
|
|
|
|
.work = __WORK_INITIALIZER_NAR((n).work, (f)), \
|
2005-04-17 00:20:36 +02:00
|
|
|
.timer = TIMER_INITIALIZER(NULL, 0, 0), \
|
|
|
|
}
|
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
#define DECLARE_WORK(n, f) \
|
|
|
|
struct work_struct n = __WORK_INITIALIZER(n, f)
|
|
|
|
|
|
|
|
#define DECLARE_WORK_NAR(n, f) \
|
|
|
|
struct work_struct n = __WORK_INITIALIZER_NAR(n, f)
|
2005-04-17 00:20:36 +02:00
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
#define DECLARE_DELAYED_WORK(n, f) \
|
|
|
|
struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f)
|
|
|
|
|
|
|
|
#define DECLARE_DELAYED_WORK_NAR(n, f) \
|
|
|
|
struct dwork_struct n = __DELAYED_WORK_INITIALIZER_NAR(n, f)
|
2006-11-22 15:54:01 +01:00
|
|
|
|
2005-04-17 00:20:36 +02:00
|
|
|
/*
|
2006-11-22 15:55:48 +01:00
|
|
|
* initialize a work item's function pointer
|
2005-04-17 00:20:36 +02:00
|
|
|
*/
|
2006-11-22 15:55:48 +01:00
|
|
|
#define PREPARE_WORK(_work, _func) \
|
2005-04-17 00:20:36 +02:00
|
|
|
do { \
|
2006-11-22 15:54:01 +01:00
|
|
|
(_work)->func = (_func); \
|
2005-04-17 00:20:36 +02:00
|
|
|
} while (0)
|
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
#define PREPARE_DELAYED_WORK(_work, _func) \
|
|
|
|
PREPARE_WORK(&(_work)->work, (_func))
|
2006-11-22 15:54:01 +01:00
|
|
|
|
2005-04-17 00:20:36 +02:00
|
|
|
/*
|
2006-11-22 15:54:01 +01:00
|
|
|
* initialize all of a work item in one go
|
2006-12-16 18:53:50 +01:00
|
|
|
*
|
|
|
|
* NOTE! No point in using "atomic_long_set()": useing a direct
|
|
|
|
* assignment of the work data initializer allows the compiler
|
|
|
|
* to generate better code.
|
2005-04-17 00:20:36 +02:00
|
|
|
*/
|
2006-11-22 15:55:48 +01:00
|
|
|
#define INIT_WORK(_work, _func) \
|
2005-04-17 00:20:36 +02:00
|
|
|
do { \
|
2006-12-16 18:53:50 +01:00
|
|
|
(_work)->data = (atomic_long_t) WORK_DATA_INIT(0); \
|
2006-11-22 15:55:48 +01:00
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
|
|
|
PREPARE_WORK((_work), (_func)); \
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
#define INIT_WORK_NAR(_work, _func) \
|
|
|
|
do { \
|
2006-12-16 18:53:50 +01:00
|
|
|
(_work)->data = (atomic_long_t) WORK_DATA_INIT(1); \
|
2006-11-22 15:55:48 +01:00
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
|
|
|
PREPARE_WORK((_work), (_func)); \
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
#define INIT_DELAYED_WORK(_work, _func) \
|
|
|
|
do { \
|
|
|
|
INIT_WORK(&(_work)->work, (_func)); \
|
|
|
|
init_timer(&(_work)->timer); \
|
2006-11-22 15:54:01 +01:00
|
|
|
} while (0)
|
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
#define INIT_DELAYED_WORK_NAR(_work, _func) \
|
2006-11-22 15:54:01 +01:00
|
|
|
do { \
|
2006-11-22 15:55:48 +01:00
|
|
|
INIT_WORK_NAR(&(_work)->work, (_func)); \
|
2005-04-17 00:20:36 +02:00
|
|
|
init_timer(&(_work)->timer); \
|
|
|
|
} while (0)
|
|
|
|
|
2007-05-08 09:27:47 +02:00
|
|
|
#define INIT_DELAYED_WORK_DEFERRABLE(_work, _func) \
|
|
|
|
do { \
|
|
|
|
INIT_WORK(&(_work)->work, (_func)); \
|
|
|
|
init_timer_deferrable(&(_work)->timer); \
|
|
|
|
} while (0)
|
|
|
|
|
2006-11-22 15:54:49 +01:00
|
|
|
/**
|
|
|
|
* work_pending - Find out whether a work item is currently pending
|
|
|
|
* @work: The work item in question
|
|
|
|
*/
|
|
|
|
#define work_pending(work) \
|
2006-12-16 18:53:50 +01:00
|
|
|
test_bit(WORK_STRUCT_PENDING, work_data_bits(work))
|
2006-11-22 15:54:49 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* delayed_work_pending - Find out whether a delayable work item is currently
|
|
|
|
* pending
|
|
|
|
* @work: The work item in question
|
|
|
|
*/
|
2006-12-15 23:13:51 +01:00
|
|
|
#define delayed_work_pending(w) \
|
|
|
|
work_pending(&(w)->work)
|
2006-11-22 15:54:49 +01:00
|
|
|
|
2006-11-22 15:55:48 +01:00
|
|
|
/**
|
|
|
|
* work_release - Release a work item under execution
|
|
|
|
* @work: The work item to release
|
|
|
|
*
|
|
|
|
* This is used to release a work item that has been initialised with automatic
|
|
|
|
* release mode disabled (WORK_STRUCT_NOAUTOREL is set). This gives the work
|
|
|
|
* function the opportunity to grab auxiliary data from the container of the
|
|
|
|
* work_struct before clearing the pending bit as the work_struct may be
|
|
|
|
* subject to deallocation the moment the pending bit is cleared.
|
|
|
|
*
|
|
|
|
* In such a case, this should be called in the work function after it has
|
|
|
|
* fetched any data it may require from the containter of the work_struct.
|
|
|
|
* After this function has been called, the work_struct may be scheduled for
|
|
|
|
* further execution or it may be deallocated unless other precautions are
|
|
|
|
* taken.
|
|
|
|
*
|
|
|
|
* This should also be used to release a delayed work item.
|
|
|
|
*/
|
|
|
|
#define work_release(work) \
|
2006-12-16 18:53:50 +01:00
|
|
|
clear_bit(WORK_STRUCT_PENDING, work_data_bits(work))
|
2006-11-22 15:55:48 +01:00
|
|
|
|
2006-11-22 15:54:01 +01:00
|
|
|
|
2005-04-17 00:20:36 +02:00
|
|
|
extern struct workqueue_struct *__create_workqueue(const char *name,
|
2006-12-07 05:34:49 +01:00
|
|
|
int singlethread,
|
|
|
|
int freezeable);
|
|
|
|
#define create_workqueue(name) __create_workqueue((name), 0, 0)
|
|
|
|
#define create_freezeable_workqueue(name) __create_workqueue((name), 0, 1)
|
|
|
|
#define create_singlethread_workqueue(name) __create_workqueue((name), 1, 0)
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
extern void destroy_workqueue(struct workqueue_struct *wq);
|
|
|
|
|
|
|
|
extern int FASTCALL(queue_work(struct workqueue_struct *wq, struct work_struct *work));
|
2006-11-22 15:54:01 +01:00
|
|
|
extern int FASTCALL(queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *work, unsigned long delay));
|
2006-06-28 22:50:33 +02:00
|
|
|
extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
2006-11-22 15:54:01 +01:00
|
|
|
struct delayed_work *work, unsigned long delay);
|
2005-04-17 00:20:36 +02:00
|
|
|
extern void FASTCALL(flush_workqueue(struct workqueue_struct *wq));
|
|
|
|
|
|
|
|
extern int FASTCALL(schedule_work(struct work_struct *work));
|
2006-12-07 18:28:19 +01:00
|
|
|
extern int FASTCALL(run_scheduled_work(struct work_struct *work));
|
2006-11-22 15:54:01 +01:00
|
|
|
extern int FASTCALL(schedule_delayed_work(struct delayed_work *work, unsigned long delay));
|
2005-04-17 00:20:36 +02:00
|
|
|
|
2006-11-22 15:54:01 +01:00
|
|
|
extern int schedule_delayed_work_on(int cpu, struct delayed_work *work, unsigned long delay);
|
2006-11-22 15:55:48 +01:00
|
|
|
extern int schedule_on_each_cpu(work_func_t func);
|
2005-04-17 00:20:36 +02:00
|
|
|
extern void flush_scheduled_work(void);
|
|
|
|
extern int current_is_keventd(void);
|
|
|
|
extern int keventd_up(void);
|
|
|
|
|
|
|
|
extern void init_workqueues(void);
|
2006-11-22 15:54:01 +01:00
|
|
|
void cancel_rearming_delayed_work(struct delayed_work *work);
|
2005-04-17 00:23:59 +02:00
|
|
|
void cancel_rearming_delayed_workqueue(struct workqueue_struct *,
|
2006-11-22 15:54:01 +01:00
|
|
|
struct delayed_work *);
|
2006-11-22 15:55:48 +01:00
|
|
|
int execute_in_process_context(work_func_t fn, struct execute_work *);
|
2005-04-17 00:20:36 +02:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Kill off a pending schedule_delayed_work(). Note that the work callback
|
2007-04-27 00:45:32 +02:00
|
|
|
* 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
|
|
|
|
* cancel_work_sync() to wait on it.
|
2005-04-17 00:20:36 +02:00
|
|
|
*/
|
2006-11-22 15:54:01 +01:00
|
|
|
static inline int cancel_delayed_work(struct delayed_work *work)
|
2005-04-17 00:20:36 +02:00
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
2007-04-27 00:45:32 +02:00
|
|
|
ret = del_timer(&work->timer);
|
2005-04-17 00:20:36 +02:00
|
|
|
if (ret)
|
2006-12-16 18:53:50 +01:00
|
|
|
work_release(&work->work);
|
2005-04-17 00:20:36 +02:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|