Home | History | Annotate | Download | only in linux 
      1 /*
      2  * workqueue.h --- work queue handling for Linux.
      3  */
      4 
      5 #ifndef _LINUX_WORKQUEUE_H
      6 #define _LINUX_WORKQUEUE_H
      7 
      8 #include <linux/timer.h>
      9 #include <linux/linkage.h>
     10 #include <linux/bitops.h>
     11 
     12 struct workqueue_struct;
     13 
     14 struct work_struct {
     15 	unsigned long pending;
     16 	struct list_head entry;
     17 	void (*func)(void *);
     18 	void *data;
     19 	void *wq_data;
     20 	struct timer_list timer;
     21 };
     22 
     23 struct execute_work {
     24 	struct work_struct work;
     25 };
     26 
     27 #define __WORK_INITIALIZER(n, f, d) {				\
     28         .entry	= { &(n).entry, &(n).entry },			\
     29 	.func = (f),						\
     30 	.data = (d),						\
     31 	.timer = TIMER_INITIALIZER(NULL, 0, 0),			\
     32 	}
     33 
     34 #define DECLARE_WORK(n, f, d)					\
     35 	struct work_struct n = __WORK_INITIALIZER(n, f, d)
     36 
     37 /*
     38  * initialize a work-struct's func and data pointers:
     39  */
     40 #define PREPARE_WORK(_work, _func, _data)			\
     41 	do {							\
     42 		(_work)->func = _func;				\
     43 		(_work)->data = _data;				\
     44 	} while (0)
     45 
     46 /*
     47  * initialize all of a work-struct:
     48  */
     49 #define INIT_WORK(_work, _func, _data)				\
     50 	do {							\
     51 		INIT_LIST_HEAD(&(_work)->entry);		\
     52 		(_work)->pending = 0;				\
     53 		PREPARE_WORK((_work), (_func), (_data));	\
     54 		init_timer(&(_work)->timer);			\
     55 	} while (0)
     56 
     57 extern struct workqueue_struct *__create_workqueue(const char *name,
     58 						    int singlethread);
     59 #define create_workqueue(name) __create_workqueue((name), 0)
     60 #define create_singlethread_workqueue(name) __create_workqueue((name), 1)
     61 
     62 extern void destroy_workqueue(struct workqueue_struct *wq);
     63 
     64 extern int FASTCALL(queue_work(struct workqueue_struct *wq, struct work_struct *work));
     65 extern int FASTCALL(queue_delayed_work(struct workqueue_struct *wq, struct work_struct *work, unsigned long delay));
     66 extern int queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
     67 	struct work_struct *work, unsigned long delay);
     68 extern void FASTCALL(flush_workqueue(struct workqueue_struct *wq));
     69 
     70 extern int FASTCALL(schedule_work(struct work_struct *work));
     71 extern int FASTCALL(schedule_delayed_work(struct work_struct *work, unsigned long delay));
     72 
     73 extern int schedule_delayed_work_on(int cpu, struct work_struct *work, unsigned long delay);
     74 extern int schedule_on_each_cpu(void (*func)(void *info), void *info);
     75 extern void flush_scheduled_work(void);
     76 extern int current_is_keventd(void);
     77 extern int keventd_up(void);
     78 
     79 extern void init_workqueues(void);
     80 void cancel_rearming_delayed_work(struct work_struct *work);
     81 void cancel_rearming_delayed_workqueue(struct workqueue_struct *,
     82 				       struct work_struct *);
     83 int execute_in_process_context(void (*fn)(void *), void *,
     84 			       struct execute_work *);
     85 
     86 /*
     87  * Kill off a pending schedule_delayed_work().  Note that the work callback
     88  * function may still be running on return from cancel_delayed_work().  Run
     89  * flush_scheduled_work() to wait on it.
     90  */
     91 static inline int cancel_delayed_work(struct work_struct *work)
     92 {
     93 	int ret;
     94 
     95 	ret = del_timer_sync(&work->timer);
     96 	if (ret)
     97 		clear_bit(0, &work->pending);
     98 	return ret;
     99 }
    100 
    101 #endif
    102