2005-04-16 18:20:36 -04: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>
|
|
|
|
|
|
|
|
struct workqueue_struct;
|
|
|
|
|
2006-11-22 09:55:48 -05:00
|
|
|
struct work_struct;
|
|
|
|
typedef void (*work_func_t)(struct work_struct *work);
|
2006-11-22 09:54:45 -05:00
|
|
|
|
2005-04-16 18:20:36 -04:00
|
|
|
struct work_struct {
|
2006-11-22 09:55:48 -05:00
|
|
|
/* the first word is the work queue pointer and the flags rolled into
|
|
|
|
* one */
|
2006-11-22 09:54:49 -05:00
|
|
|
unsigned long management;
|
|
|
|
#define WORK_STRUCT_PENDING 0 /* T if work item pending execution */
|
2006-11-22 09:55:48 -05:00
|
|
|
#define WORK_STRUCT_NOAUTOREL 1 /* F if work item automatically released on exec */
|
2006-11-22 09:54:49 -05:00
|
|
|
#define WORK_STRUCT_FLAG_MASK (3UL)
|
|
|
|
#define WORK_STRUCT_WQ_DATA_MASK (~WORK_STRUCT_FLAG_MASK)
|
2005-04-16 18:20:36 -04:00
|
|
|
struct list_head entry;
|
2006-11-22 09:54:45 -05:00
|
|
|
work_func_t func;
|
2006-11-22 09:54:01 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
struct delayed_work {
|
|
|
|
struct work_struct work;
|
2005-04-16 18:20:36 -04:00
|
|
|
struct timer_list timer;
|
|
|
|
};
|
|
|
|
|
2006-02-23 13:43:43 -05:00
|
|
|
struct execute_work {
|
|
|
|
struct work_struct work;
|
|
|
|
};
|
|
|
|
|
2006-11-22 09:55:48 -05:00
|
|
|
#define __WORK_INITIALIZER(n, f) { \
|
|
|
|
.management = 0, \
|
2005-04-16 18:20:36 -04:00
|
|
|
.entry = { &(n).entry, &(n).entry }, \
|
|
|
|
.func = (f), \
|
2006-11-22 09:54:01 -05:00
|
|
|
}
|
|
|
|
|
2006-11-22 09:55:48 -05:00
|
|
|
#define __WORK_INITIALIZER_NAR(n, f) { \
|
|
|
|
.management = (1 << WORK_STRUCT_NOAUTOREL), \
|
|
|
|
.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-16 18:20:36 -04:00
|
|
|
.timer = TIMER_INITIALIZER(NULL, 0, 0), \
|
|
|
|
}
|
|
|
|
|
2006-11-22 09:55:48 -05: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-16 18:20:36 -04:00
|
|
|
|
2006-11-22 09:55:48 -05: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 09:54:01 -05:00
|
|
|
|
2005-04-16 18:20:36 -04:00
|
|
|
/*
|
2006-11-22 09:55:48 -05:00
|
|
|
* initialize a work item's function pointer
|
2005-04-16 18:20:36 -04:00
|
|
|
*/
|
2006-11-22 09:55:48 -05:00
|
|
|
#define PREPARE_WORK(_work, _func) \
|
2005-04-16 18:20:36 -04:00
|
|
|
do { \
|
2006-11-22 09:54:01 -05:00
|
|
|
(_work)->func = (_func); \
|
2005-04-16 18:20:36 -04:00
|
|
|
} while (0)
|
|
|
|
|
2006-11-22 09:55:48 -05:00
|
|
|
#define PREPARE_DELAYED_WORK(_work, _func) \
|
|
|
|
PREPARE_WORK(&(_work)->work, (_func))
|
2006-11-22 09:54:01 -05:00
|
|
|
|
2005-04-16 18:20:36 -04:00
|
|
|
/*
|
2006-11-22 09:54:01 -05:00
|
|
|
* initialize all of a work item in one go
|
2005-04-16 18:20:36 -04:00
|
|
|
*/
|
2006-11-22 09:55:48 -05:00
|
|
|
#define INIT_WORK(_work, _func) \
|
2005-04-16 18:20:36 -04:00
|
|
|
do { \
|
2006-11-22 09:54:49 -05:00
|
|
|
(_work)->management = 0; \
|
2006-11-22 09:55:48 -05:00
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
|
|
|
PREPARE_WORK((_work), (_func)); \
|
|
|
|
} while (0)
|
|
|
|
|
|
|
|
#define INIT_WORK_NAR(_work, _func) \
|
|
|
|
do { \
|
|
|
|
(_work)->management = (1 << WORK_STRUCT_NOAUTOREL); \
|
|
|
|
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 09:54:01 -05:00
|
|
|
} while (0)
|
|
|
|
|
2006-11-22 09:55:48 -05:00
|
|
|
#define INIT_DELAYED_WORK_NAR(_work, _func) \
|
2006-11-22 09:54:01 -05:00
|
|
|
do { \
|
2006-11-22 09:55:48 -05:00
|
|
|
INIT_WORK_NAR(&(_work)->work, (_func)); \
|
2005-04-16 18:20:36 -04:00
|
|
|
init_timer(&(_work)->timer); \
|
|
|
|
} while (0)
|
|
|
|
|
2006-11-22 09:54:49 -05:00
|
|
|
/**
|
|
|
|
* work_pending - Find out whether a work item is currently pending
|
|
|
|
* @work: The work item in question
|
|
|
|
*/
|
|
|
|
#define work_pending(work) \
|
|
|
|
test_bit(WORK_STRUCT_PENDING, &(work)->management)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* delayed_work_pending - Find out whether a delayable work item is currently
|
|
|
|
* pending
|
|
|
|
* @work: The work item in question
|
|
|
|
*/
|
|
|
|
#define delayed_work_pending(work) \
|
|
|
|
test_bit(WORK_STRUCT_PENDING, &(work)->work.management)
|
|
|
|
|
2006-11-22 09:55:48 -05: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) \
|
|
|
|
clear_bit(WORK_STRUCT_PENDING, &(work)->management)
|
|
|
|
|
2006-11-22 09:54:01 -05:00
|
|
|
|
2005-04-16 18:20:36 -04:00
|
|
|
extern struct workqueue_struct *__create_workqueue(const char *name,
|
|
|
|
int singlethread);
|
|
|
|
#define create_workqueue(name) __create_workqueue((name), 0)
|
|
|
|
#define create_singlethread_workqueue(name) __create_workqueue((name), 1)
|
|
|
|
|
|
|
|
extern void destroy_workqueue(struct workqueue_struct *wq);
|
|
|
|
|
|
|
|
extern int FASTCALL(queue_work(struct workqueue_struct *wq, struct work_struct *work));
|
2006-11-22 09:54:01 -05:00
|
|
|
extern int FASTCALL(queue_delayed_work(struct workqueue_struct *wq, struct delayed_work *work, unsigned long delay));
|
2006-06-28 16:50:33 -04:00
|
|
|
extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
2006-11-22 09:54:01 -05:00
|
|
|
struct delayed_work *work, unsigned long delay);
|
2005-04-16 18:20:36 -04:00
|
|
|
extern void FASTCALL(flush_workqueue(struct workqueue_struct *wq));
|
|
|
|
|
|
|
|
extern int FASTCALL(schedule_work(struct work_struct *work));
|
2006-11-22 09:54:01 -05:00
|
|
|
extern int FASTCALL(schedule_delayed_work(struct delayed_work *work, unsigned long delay));
|
2005-04-16 18:20:36 -04:00
|
|
|
|
2006-11-22 09:54:01 -05:00
|
|
|
extern int schedule_delayed_work_on(int cpu, struct delayed_work *work, unsigned long delay);
|
2006-11-22 09:55:48 -05:00
|
|
|
extern int schedule_on_each_cpu(work_func_t func);
|
2005-04-16 18:20:36 -04: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 09:54:01 -05:00
|
|
|
void cancel_rearming_delayed_work(struct delayed_work *work);
|
2005-04-16 18:23:59 -04:00
|
|
|
void cancel_rearming_delayed_workqueue(struct workqueue_struct *,
|
2006-11-22 09:54:01 -05:00
|
|
|
struct delayed_work *);
|
2006-11-22 09:55:48 -05:00
|
|
|
int execute_in_process_context(work_func_t fn, struct execute_work *);
|
2005-04-16 18:20:36 -04:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Kill off a pending schedule_delayed_work(). Note that the work callback
|
|
|
|
* function may still be running on return from cancel_delayed_work(). Run
|
|
|
|
* flush_scheduled_work() to wait on it.
|
|
|
|
*/
|
2006-11-22 09:54:01 -05:00
|
|
|
static inline int cancel_delayed_work(struct delayed_work *work)
|
2005-04-16 18:20:36 -04:00
|
|
|
{
|
|
|
|
int ret;
|
|
|
|
|
|
|
|
ret = del_timer_sync(&work->timer);
|
|
|
|
if (ret)
|
2006-11-22 09:54:49 -05:00
|
|
|
clear_bit(WORK_STRUCT_PENDING, &work->work.management);
|
2005-04-16 18:20:36 -04:00
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif
|