2005-04-17 06:20:36 +08: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>
|
2007-10-19 14:39:55 +08:00
|
|
|
#include <linux/lockdep.h>
|
2010-06-29 16:07:13 +08:00
|
|
|
#include <linux/threads.h>
|
2011-07-27 07:09:06 +08:00
|
|
|
#include <linux/atomic.h>
|
2013-03-13 02:30:00 +08:00
|
|
|
#include <linux/cpumask.h>
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
struct workqueue_struct;
|
|
|
|
|
2006-11-22 22:55:48 +08:00
|
|
|
struct work_struct;
|
|
|
|
typedef void (*work_func_t)(struct work_struct *work);
|
2012-08-04 01:30:45 +08:00
|
|
|
void delayed_work_timer_fn(unsigned long __data);
|
2006-11-22 22:54:45 +08:00
|
|
|
|
2006-12-17 01:53:50 +08:00
|
|
|
/*
|
|
|
|
* The first word is the work queue pointer and the flags rolled into
|
|
|
|
* one
|
|
|
|
*/
|
|
|
|
#define work_data_bits(work) ((unsigned long *)(&(work)->data))
|
|
|
|
|
2010-06-29 16:07:10 +08:00
|
|
|
enum {
|
|
|
|
WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */
|
2010-08-25 16:33:56 +08:00
|
|
|
WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */
|
2013-02-14 11:29:12 +08:00
|
|
|
WORK_STRUCT_PWQ_BIT = 2, /* data points to pwq */
|
2010-08-25 16:33:56 +08:00
|
|
|
WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */
|
2010-06-29 16:07:10 +08:00
|
|
|
#ifdef CONFIG_DEBUG_OBJECTS_WORK
|
2010-08-25 16:33:56 +08:00
|
|
|
WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */
|
|
|
|
WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */
|
2010-06-29 16:07:11 +08:00
|
|
|
#else
|
2010-08-25 16:33:56 +08:00
|
|
|
WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */
|
2010-06-29 16:07:10 +08:00
|
|
|
#endif
|
|
|
|
|
2010-06-29 16:07:11 +08:00
|
|
|
WORK_STRUCT_COLOR_BITS = 4,
|
|
|
|
|
2010-06-29 16:07:10 +08:00
|
|
|
WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT,
|
2010-08-25 16:33:56 +08:00
|
|
|
WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT,
|
2013-02-14 11:29:12 +08:00
|
|
|
WORK_STRUCT_PWQ = 1 << WORK_STRUCT_PWQ_BIT,
|
2010-06-29 16:07:12 +08:00
|
|
|
WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT,
|
2010-06-29 16:07:10 +08:00
|
|
|
#ifdef CONFIG_DEBUG_OBJECTS_WORK
|
|
|
|
WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT,
|
|
|
|
#else
|
|
|
|
WORK_STRUCT_STATIC = 0,
|
|
|
|
#endif
|
|
|
|
|
2010-06-29 16:07:11 +08:00
|
|
|
/*
|
|
|
|
* The last color is no color used for works which don't
|
|
|
|
* participate in workqueue flushing.
|
|
|
|
*/
|
|
|
|
WORK_NR_COLORS = (1 << WORK_STRUCT_COLOR_BITS) - 1,
|
|
|
|
WORK_NO_COLOR = WORK_NR_COLORS,
|
|
|
|
|
2010-07-02 16:03:51 +08:00
|
|
|
/* special cpu IDs */
|
2010-07-02 16:03:51 +08:00
|
|
|
WORK_CPU_UNBOUND = NR_CPUS,
|
2013-02-07 10:04:53 +08:00
|
|
|
WORK_CPU_END = NR_CPUS + 1,
|
2010-07-02 16:03:51 +08:00
|
|
|
|
2010-06-29 16:07:11 +08:00
|
|
|
/*
|
2013-02-14 11:29:12 +08:00
|
|
|
* Reserve 7 bits off of pwq pointer w/ debugobjects turned off.
|
|
|
|
* This makes pwqs aligned to 256 bytes and allows 15 workqueue
|
|
|
|
* flush colors.
|
2010-06-29 16:07:11 +08:00
|
|
|
*/
|
|
|
|
WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT +
|
|
|
|
WORK_STRUCT_COLOR_BITS,
|
|
|
|
|
2013-02-14 11:29:12 +08:00
|
|
|
/* data contains off-queue information when !WORK_STRUCT_PWQ */
|
2013-02-20 04:17:01 +08:00
|
|
|
WORK_OFFQ_FLAG_BASE = WORK_STRUCT_COLOR_SHIFT,
|
2012-08-04 01:30:46 +08:00
|
|
|
|
|
|
|
WORK_OFFQ_CANCELING = (1 << WORK_OFFQ_FLAG_BASE),
|
|
|
|
|
2013-01-25 03:01:33 +08:00
|
|
|
/*
|
|
|
|
* When a work item is off queue, its high bits point to the last
|
2013-01-25 03:01:33 +08:00
|
|
|
* pool it was on. Cap at 31 bits and use the highest number to
|
|
|
|
* indicate that no pool is associated.
|
2013-01-25 03:01:33 +08:00
|
|
|
*/
|
2012-08-04 01:30:46 +08:00
|
|
|
WORK_OFFQ_FLAG_BITS = 1,
|
2013-01-25 03:01:33 +08:00
|
|
|
WORK_OFFQ_POOL_SHIFT = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,
|
|
|
|
WORK_OFFQ_LEFT = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT,
|
|
|
|
WORK_OFFQ_POOL_BITS = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31,
|
|
|
|
WORK_OFFQ_POOL_NONE = (1LU << WORK_OFFQ_POOL_BITS) - 1,
|
2012-08-04 01:30:46 +08:00
|
|
|
|
|
|
|
/* convenience constants */
|
2010-06-29 16:07:11 +08:00
|
|
|
WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
|
2010-06-29 16:07:10 +08:00
|
|
|
WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
|
2013-01-25 03:01:33 +08:00
|
|
|
WORK_STRUCT_NO_POOL = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT,
|
2010-06-29 16:07:14 +08:00
|
|
|
|
|
|
|
/* bit mask for work_busy() return values */
|
|
|
|
WORK_BUSY_PENDING = 1 << 0,
|
|
|
|
WORK_BUSY_RUNNING = 1 << 1,
|
2013-05-01 06:27:22 +08:00
|
|
|
|
|
|
|
/* maximum string length for set_worker_desc() */
|
|
|
|
WORKER_DESC_LEN = 24,
|
2010-06-29 16:07:10 +08:00
|
|
|
};
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
struct work_struct {
|
2006-12-17 01:53:50 +08:00
|
|
|
atomic_long_t data;
|
2005-04-17 06:20:36 +08:00
|
|
|
struct list_head entry;
|
2006-11-22 22:54:45 +08:00
|
|
|
work_func_t func;
|
2007-10-19 14:39:55 +08:00
|
|
|
#ifdef CONFIG_LOCKDEP
|
|
|
|
struct lockdep_map lockdep_map;
|
|
|
|
#endif
|
2006-11-22 22:54:01 +08:00
|
|
|
};
|
|
|
|
|
2013-01-25 03:01:33 +08:00
|
|
|
#define WORK_DATA_INIT() ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL)
|
2010-06-29 16:07:13 +08:00
|
|
|
#define WORK_DATA_STATIC_INIT() \
|
2013-01-25 03:01:33 +08:00
|
|
|
ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC)
|
2006-12-17 01:53:50 +08:00
|
|
|
|
2006-11-22 22:54:01 +08:00
|
|
|
struct delayed_work {
|
|
|
|
struct work_struct work;
|
2005-04-17 06:20:36 +08:00
|
|
|
struct timer_list timer;
|
2013-02-07 10:04:53 +08:00
|
|
|
|
|
|
|
/* target workqueue and CPU ->timer uses to queue ->work */
|
|
|
|
struct workqueue_struct *wq;
|
2012-08-09 00:38:42 +08:00
|
|
|
int cpu;
|
2005-04-17 06:20:36 +08:00
|
|
|
};
|
|
|
|
|
2013-03-13 02:30:00 +08:00
|
|
|
/*
|
|
|
|
* A struct for workqueue attributes. This can be used to change
|
|
|
|
* attributes of an unbound workqueue.
|
2013-04-02 02:23:38 +08:00
|
|
|
*
|
|
|
|
* Unlike other fields, ->no_numa isn't a property of a worker_pool. It
|
|
|
|
* only modifies how apply_workqueue_attrs() select pools and thus doesn't
|
|
|
|
* participate in pool hash calculations or equality comparisons.
|
2013-03-13 02:30:00 +08:00
|
|
|
*/
|
|
|
|
struct workqueue_attrs {
|
|
|
|
int nice; /* nice level */
|
|
|
|
cpumask_var_t cpumask; /* allowed CPUs */
|
2013-04-02 02:23:38 +08:00
|
|
|
bool no_numa; /* disable NUMA affinity */
|
2013-03-13 02:30:00 +08:00
|
|
|
};
|
|
|
|
|
2009-04-03 07:56:54 +08:00
|
|
|
static inline struct delayed_work *to_delayed_work(struct work_struct *work)
|
|
|
|
{
|
|
|
|
return container_of(work, struct delayed_work, work);
|
|
|
|
}
|
|
|
|
|
2006-02-24 02:43:43 +08:00
|
|
|
struct execute_work {
|
|
|
|
struct work_struct work;
|
|
|
|
};
|
|
|
|
|
2007-10-19 14:39:55 +08:00
|
|
|
#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
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define __WORK_INITIALIZER(n, f) { \
|
|
|
|
.data = WORK_DATA_STATIC_INIT(), \
|
|
|
|
.entry = { &(n).entry, &(n).entry }, \
|
|
|
|
.func = (f), \
|
|
|
|
__WORK_INIT_LOCKDEP_MAP(#n, &(n)) \
|
2006-11-22 22:55:48 +08:00
|
|
|
}
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \
|
2012-08-22 04:18:23 +08:00
|
|
|
.work = __WORK_INITIALIZER((n).work, (f)), \
|
2012-08-22 04:18:23 +08:00
|
|
|
.timer = __TIMER_INITIALIZER(delayed_work_timer_fn, \
|
2012-08-22 04:18:24 +08:00
|
|
|
0, (unsigned long)&(n), \
|
|
|
|
(tflags) | TIMER_IRQSAFE), \
|
2010-10-21 06:57:33 +08:00
|
|
|
}
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define DECLARE_WORK(n, f) \
|
2006-11-22 22:55:48 +08:00
|
|
|
struct work_struct n = __WORK_INITIALIZER(n, f)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define DECLARE_DELAYED_WORK(n, f) \
|
2012-08-22 04:18:23 +08:00
|
|
|
struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
|
2006-11-22 22:55:48 +08:00
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define DECLARE_DEFERRABLE_WORK(n, f) \
|
2012-08-22 04:18:23 +08:00
|
|
|
struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
|
2010-10-21 06:57:33 +08:00
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/*
|
2006-11-22 22:55:48 +08:00
|
|
|
* initialize a work item's function pointer
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
2012-08-22 04:18:23 +08:00
|
|
|
#define PREPARE_WORK(_work, _func) \
|
|
|
|
do { \
|
|
|
|
(_work)->func = (_func); \
|
2005-04-17 06:20:36 +08:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define PREPARE_DELAYED_WORK(_work, _func) \
|
2006-11-22 22:55:48 +08:00
|
|
|
PREPARE_WORK(&(_work)->work, (_func))
|
2006-11-22 22:54:01 +08:00
|
|
|
|
2009-11-16 00:09:48 +08:00
|
|
|
#ifdef CONFIG_DEBUG_OBJECTS_WORK
|
|
|
|
extern void __init_work(struct work_struct *work, int onstack);
|
|
|
|
extern void destroy_work_on_stack(struct work_struct *work);
|
2010-06-29 16:07:10 +08:00
|
|
|
static inline unsigned int work_static(struct work_struct *work)
|
|
|
|
{
|
2010-06-29 16:07:10 +08:00
|
|
|
return *work_data_bits(work) & WORK_STRUCT_STATIC;
|
2010-06-29 16:07:10 +08:00
|
|
|
}
|
2009-11-16 00:09:48 +08:00
|
|
|
#else
|
|
|
|
static inline void __init_work(struct work_struct *work, int onstack) { }
|
|
|
|
static inline void destroy_work_on_stack(struct work_struct *work) { }
|
2010-06-29 16:07:10 +08:00
|
|
|
static inline unsigned int work_static(struct work_struct *work) { return 0; }
|
2009-11-16 00:09:48 +08:00
|
|
|
#endif
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/*
|
2006-11-22 22:54:01 +08:00
|
|
|
* initialize all of a work item in one go
|
2006-12-17 01:53:50 +08:00
|
|
|
*
|
2009-06-23 18:09:29 +08:00
|
|
|
* NOTE! No point in using "atomic_long_set()": using a direct
|
2006-12-17 01:53:50 +08:00
|
|
|
* assignment of the work data initializer allows the compiler
|
|
|
|
* to generate better code.
|
2005-04-17 06:20:36 +08:00
|
|
|
*/
|
2007-10-19 14:39:55 +08:00
|
|
|
#ifdef CONFIG_LOCKDEP
|
2009-11-16 00:09:48 +08:00
|
|
|
#define __INIT_WORK(_work, _func, _onstack) \
|
2006-11-22 22:55:48 +08:00
|
|
|
do { \
|
2007-10-19 14:39:55 +08:00
|
|
|
static struct lock_class_key __key; \
|
|
|
|
\
|
2009-11-16 00:09:48 +08:00
|
|
|
__init_work((_work), _onstack); \
|
2007-05-09 17:34:19 +08:00
|
|
|
(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
|
2012-08-22 04:18:23 +08:00
|
|
|
lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
|
2006-11-22 22:55:48 +08:00
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
|
|
|
PREPARE_WORK((_work), (_func)); \
|
|
|
|
} while (0)
|
2007-10-19 14:39:55 +08:00
|
|
|
#else
|
2009-11-16 00:09:48 +08:00
|
|
|
#define __INIT_WORK(_work, _func, _onstack) \
|
2007-10-19 14:39:55 +08:00
|
|
|
do { \
|
2009-11-16 00:09:48 +08:00
|
|
|
__init_work((_work), _onstack); \
|
2007-10-19 14:39:55 +08:00
|
|
|
(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
|
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
|
|
|
PREPARE_WORK((_work), (_func)); \
|
|
|
|
} while (0)
|
|
|
|
#endif
|
2006-11-22 22:55:48 +08:00
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define INIT_WORK(_work, _func) \
|
|
|
|
do { \
|
|
|
|
__INIT_WORK((_work), (_func), 0); \
|
2009-11-16 00:09:48 +08:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define INIT_WORK_ONSTACK(_work, _func) \
|
|
|
|
do { \
|
|
|
|
__INIT_WORK((_work), (_func), 1); \
|
2009-11-16 00:09:48 +08:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define __INIT_DELAYED_WORK(_work, _func, _tflags) \
|
2012-08-22 04:18:23 +08:00
|
|
|
do { \
|
|
|
|
INIT_WORK(&(_work)->work, (_func)); \
|
2012-08-22 04:18:23 +08:00
|
|
|
__setup_timer(&(_work)->timer, delayed_work_timer_fn, \
|
2012-08-22 04:18:24 +08:00
|
|
|
(unsigned long)(_work), \
|
|
|
|
(_tflags) | TIMER_IRQSAFE); \
|
2006-11-22 22:54:01 +08:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \
|
2012-08-22 04:18:23 +08:00
|
|
|
do { \
|
|
|
|
INIT_WORK_ONSTACK(&(_work)->work, (_func)); \
|
2012-08-22 04:18:23 +08:00
|
|
|
__setup_timer_on_stack(&(_work)->timer, \
|
|
|
|
delayed_work_timer_fn, \
|
|
|
|
(unsigned long)(_work), \
|
2012-08-22 04:18:24 +08:00
|
|
|
(_tflags) | TIMER_IRQSAFE); \
|
2009-01-12 19:52:23 +08:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define INIT_DELAYED_WORK(_work, _func) \
|
|
|
|
__INIT_DELAYED_WORK(_work, _func, 0)
|
|
|
|
|
|
|
|
#define INIT_DELAYED_WORK_ONSTACK(_work, _func) \
|
|
|
|
__INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
|
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define INIT_DEFERRABLE_WORK(_work, _func) \
|
2012-08-22 04:18:23 +08:00
|
|
|
__INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
|
|
|
|
|
|
|
|
#define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func) \
|
|
|
|
__INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
|
2007-05-08 15:27:47 +08:00
|
|
|
|
2006-11-22 22:54:49 +08:00
|
|
|
/**
|
|
|
|
* work_pending - Find out whether a work item is currently pending
|
|
|
|
* @work: The work item in question
|
|
|
|
*/
|
|
|
|
#define work_pending(work) \
|
2010-06-29 16:07:10 +08:00
|
|
|
test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
|
2006-11-22 22:54:49 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* delayed_work_pending - Find out whether a delayable work item is currently
|
|
|
|
* pending
|
|
|
|
* @work: The work item in question
|
|
|
|
*/
|
2006-12-16 06:13:51 +08:00
|
|
|
#define delayed_work_pending(w) \
|
|
|
|
work_pending(&(w)->work)
|
2006-11-22 22:54:49 +08:00
|
|
|
|
2006-11-22 22:55:48 +08:00
|
|
|
/**
|
2007-05-09 17:34:19 +08:00
|
|
|
* work_clear_pending - for internal use only, mark a work item as not pending
|
|
|
|
* @work: The work item in question
|
2006-11-22 22:55:48 +08:00
|
|
|
*/
|
2007-05-09 17:34:19 +08:00
|
|
|
#define work_clear_pending(work) \
|
2010-06-29 16:07:10 +08:00
|
|
|
clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
|
2006-11-22 22:55:48 +08:00
|
|
|
|
2010-09-10 22:51:36 +08:00
|
|
|
/*
|
|
|
|
* Workqueue flags and constants. For details, please refer to
|
|
|
|
* Documentation/workqueue.txt.
|
|
|
|
*/
|
2010-06-29 16:07:10 +08:00
|
|
|
enum {
|
2013-07-30 20:30:16 +08:00
|
|
|
/*
|
|
|
|
* All wqs are now non-reentrant making the following flag
|
|
|
|
* meaningless. Will be removed.
|
|
|
|
*/
|
|
|
|
WQ_NON_REENTRANT = 1 << 0, /* DEPRECATED */
|
|
|
|
|
2010-07-02 16:03:51 +08:00
|
|
|
WQ_UNBOUND = 1 << 1, /* not bound to any cpu */
|
2011-02-16 16:25:31 +08:00
|
|
|
WQ_FREEZABLE = 1 << 2, /* freeze during suspend */
|
2010-10-11 21:12:27 +08:00
|
|
|
WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */
|
2010-06-29 16:07:14 +08:00
|
|
|
WQ_HIGHPRI = 1 << 4, /* high priority */
|
2010-06-29 16:07:15 +08:00
|
|
|
WQ_CPU_INTENSIVE = 1 << 5, /* cpu instensive workqueue */
|
2013-03-13 02:30:05 +08:00
|
|
|
WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
|
2010-06-29 16:07:14 +08:00
|
|
|
|
2013-04-08 19:15:40 +08:00
|
|
|
/*
|
|
|
|
* Per-cpu workqueues are generally preferred because they tend to
|
|
|
|
* show better performance thanks to cache locality. Per-cpu
|
|
|
|
* workqueues exclude the scheduler from choosing the CPU to
|
|
|
|
* execute the worker threads, which has an unfortunate side effect
|
|
|
|
* of increasing power consumption.
|
|
|
|
*
|
|
|
|
* The scheduler considers a CPU idle if it doesn't have any task
|
|
|
|
* to execute and tries to keep idle cores idle to conserve power;
|
|
|
|
* however, for example, a per-cpu work item scheduled from an
|
|
|
|
* interrupt handler on an idle CPU will force the scheduler to
|
|
|
|
* excute the work item on that CPU breaking the idleness, which in
|
|
|
|
* turn may lead to more scheduling choices which are sub-optimal
|
|
|
|
* in terms of power consumption.
|
|
|
|
*
|
|
|
|
* Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default
|
|
|
|
* but become unbound if workqueue.power_efficient kernel param is
|
|
|
|
* specified. Per-cpu workqueues which are identified to
|
|
|
|
* contribute significantly to power-consumption are identified and
|
|
|
|
* marked with this flag and enabling the power_efficient mode
|
|
|
|
* leads to noticeable power saving at the cost of small
|
|
|
|
* performance disadvantage.
|
|
|
|
*
|
|
|
|
* http://thread.gmane.org/gmane.linux.kernel/1480396
|
|
|
|
*/
|
|
|
|
WQ_POWER_EFFICIENT = 1 << 7,
|
|
|
|
|
2013-03-13 02:30:04 +08:00
|
|
|
__WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */
|
2013-03-13 02:30:04 +08:00
|
|
|
__WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */
|
2010-08-24 20:22:47 +08:00
|
|
|
|
2010-06-29 16:07:14 +08:00
|
|
|
WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
|
2010-07-02 16:03:51 +08:00
|
|
|
WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */
|
2010-06-29 16:07:14 +08:00
|
|
|
WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
|
2010-06-29 16:07:10 +08:00
|
|
|
};
|
2006-11-22 22:54:01 +08:00
|
|
|
|
2010-07-02 16:03:51 +08:00
|
|
|
/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
|
|
|
|
#define WQ_UNBOUND_MAX_ACTIVE \
|
|
|
|
max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
|
2006-11-22 22:55:48 +08:00
|
|
|
|
2010-06-29 16:07:14 +08:00
|
|
|
/*
|
|
|
|
* System-wide workqueues which are always present.
|
|
|
|
*
|
|
|
|
* system_wq is the one used by schedule[_delayed]_work[_on]().
|
|
|
|
* Multi-CPU multi-threaded. There are users which expect relatively
|
|
|
|
* short queue flush time. Don't queue works which can run for too
|
|
|
|
* long.
|
|
|
|
*
|
|
|
|
* system_long_wq is similar to system_wq but may host long running
|
|
|
|
* works. Queue flushing might take relatively long.
|
|
|
|
*
|
2010-07-02 16:03:51 +08:00
|
|
|
* system_unbound_wq is unbound workqueue. Workers are not bound to
|
|
|
|
* any specific CPU, not concurrency managed, and all queued works are
|
|
|
|
* executed immediately as long as max_active limit is not reached and
|
|
|
|
* resources are available.
|
2011-02-08 17:39:03 +08:00
|
|
|
*
|
2011-02-21 16:52:50 +08:00
|
|
|
* system_freezable_wq is equivalent to system_wq except that it's
|
|
|
|
* freezable.
|
2013-04-24 19:42:54 +08:00
|
|
|
*
|
|
|
|
* *_power_efficient_wq are inclined towards saving power and converted
|
|
|
|
* into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise,
|
|
|
|
* they are same as their non-power-efficient counterparts - e.g.
|
|
|
|
* system_power_efficient_wq is identical to system_wq if
|
|
|
|
* 'wq_power_efficient' is disabled. See WQ_POWER_EFFICIENT for more info.
|
2010-06-29 16:07:14 +08:00
|
|
|
*/
|
|
|
|
extern struct workqueue_struct *system_wq;
|
|
|
|
extern struct workqueue_struct *system_long_wq;
|
2010-07-02 16:03:51 +08:00
|
|
|
extern struct workqueue_struct *system_unbound_wq;
|
2011-02-21 16:52:50 +08:00
|
|
|
extern struct workqueue_struct *system_freezable_wq;
|
2013-04-24 19:42:54 +08:00
|
|
|
extern struct workqueue_struct *system_power_efficient_wq;
|
|
|
|
extern struct workqueue_struct *system_freezable_power_efficient_wq;
|
2012-08-21 05:51:23 +08:00
|
|
|
|
2012-08-21 05:51:24 +08:00
|
|
|
static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
|
2012-08-21 05:51:23 +08:00
|
|
|
{
|
|
|
|
return system_wq;
|
|
|
|
}
|
|
|
|
|
2012-08-21 05:51:24 +08:00
|
|
|
static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void)
|
2012-08-21 05:51:23 +08:00
|
|
|
{
|
|
|
|
return system_freezable_wq;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* equivlalent to system_wq and system_freezable_wq, deprecated */
|
|
|
|
#define system_nrt_wq __system_nrt_wq()
|
|
|
|
#define system_nrt_freezable_wq __system_nrt_freezable_wq()
|
2006-11-22 22:54:01 +08:00
|
|
|
|
2007-10-19 14:39:55 +08:00
|
|
|
extern struct workqueue_struct *
|
2012-01-11 07:11:35 +08:00
|
|
|
__alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
|
|
|
|
struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6);
|
2007-10-19 14:39:55 +08:00
|
|
|
|
2012-01-11 07:11:35 +08:00
|
|
|
/**
|
|
|
|
* alloc_workqueue - allocate a workqueue
|
|
|
|
* @fmt: printf format for the name of the workqueue
|
|
|
|
* @flags: WQ_* flags
|
|
|
|
* @max_active: max in-flight work items, 0 for default
|
|
|
|
* @args: args for @fmt
|
|
|
|
*
|
|
|
|
* Allocate a workqueue with the specified parameters. For detailed
|
|
|
|
* information on WQ_* flags, please refer to Documentation/workqueue.txt.
|
|
|
|
*
|
|
|
|
* The __lock_name macro dance is to guarantee that single lock_class_key
|
|
|
|
* doesn't end up with different namesm, which isn't allowed by lockdep.
|
|
|
|
*
|
|
|
|
* RETURNS:
|
|
|
|
* Pointer to the allocated workqueue on success, %NULL on failure.
|
|
|
|
*/
|
2007-10-19 14:39:55 +08:00
|
|
|
#ifdef CONFIG_LOCKDEP
|
2012-08-22 04:18:23 +08:00
|
|
|
#define alloc_workqueue(fmt, flags, max_active, args...) \
|
|
|
|
({ \
|
|
|
|
static struct lock_class_key __key; \
|
|
|
|
const char *__lock_name; \
|
|
|
|
\
|
|
|
|
if (__builtin_constant_p(fmt)) \
|
|
|
|
__lock_name = (fmt); \
|
|
|
|
else \
|
|
|
|
__lock_name = #fmt; \
|
|
|
|
\
|
|
|
|
__alloc_workqueue_key((fmt), (flags), (max_active), \
|
|
|
|
&__key, __lock_name, ##args); \
|
2007-10-19 14:39:55 +08:00
|
|
|
})
|
|
|
|
#else
|
2012-08-22 04:18:23 +08:00
|
|
|
#define alloc_workqueue(fmt, flags, max_active, args...) \
|
|
|
|
__alloc_workqueue_key((fmt), (flags), (max_active), \
|
2012-01-11 07:11:35 +08:00
|
|
|
NULL, NULL, ##args)
|
2007-10-19 14:39:55 +08:00
|
|
|
#endif
|
|
|
|
|
2010-09-16 16:17:35 +08:00
|
|
|
/**
|
|
|
|
* alloc_ordered_workqueue - allocate an ordered workqueue
|
2012-01-11 07:11:35 +08:00
|
|
|
* @fmt: printf format for the name of the workqueue
|
2011-02-16 16:25:31 +08:00
|
|
|
* @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
|
2012-01-11 07:11:35 +08:00
|
|
|
* @args: args for @fmt
|
2010-09-16 16:17:35 +08:00
|
|
|
*
|
|
|
|
* Allocate an ordered workqueue. An ordered workqueue executes at
|
|
|
|
* most one work item at any given time in the queued order. They are
|
|
|
|
* implemented as unbound workqueues with @max_active of one.
|
|
|
|
*
|
|
|
|
* RETURNS:
|
|
|
|
* Pointer to the allocated workqueue on success, %NULL on failure.
|
|
|
|
*/
|
2012-08-22 04:18:23 +08:00
|
|
|
#define alloc_ordered_workqueue(fmt, flags, args...) \
|
2013-03-13 02:30:04 +08:00
|
|
|
alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args)
|
2010-09-16 16:17:35 +08:00
|
|
|
|
2012-08-22 04:18:23 +08:00
|
|
|
#define create_workqueue(name) \
|
2013-07-04 06:04:57 +08:00
|
|
|
alloc_workqueue("%s", WQ_MEM_RECLAIM, 1, (name))
|
2012-08-22 04:18:23 +08:00
|
|
|
#define create_freezable_workqueue(name) \
|
2013-07-04 06:04:57 +08:00
|
|
|
alloc_workqueue("%s", WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, \
|
|
|
|
1, (name))
|
2012-08-22 04:18:23 +08:00
|
|
|
#define create_singlethread_workqueue(name) \
|
2013-07-04 06:04:57 +08:00
|
|
|
alloc_workqueue("%s", WQ_UNBOUND | WQ_MEM_RECLAIM, 1, (name))
|
2005-04-17 06:20:36 +08:00
|
|
|
|
|
|
|
extern void destroy_workqueue(struct workqueue_struct *wq);
|
|
|
|
|
2013-03-13 02:30:00 +08:00
|
|
|
struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask);
|
|
|
|
void free_workqueue_attrs(struct workqueue_attrs *attrs);
|
2013-03-13 02:30:04 +08:00
|
|
|
int apply_workqueue_attrs(struct workqueue_struct *wq,
|
|
|
|
const struct workqueue_attrs *attrs);
|
2013-03-13 02:30:00 +08:00
|
|
|
|
2012-08-04 01:30:44 +08:00
|
|
|
extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
|
2008-07-24 12:28:39 +08:00
|
|
|
struct work_struct *work);
|
2012-08-04 01:30:44 +08:00
|
|
|
extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
2007-05-09 17:34:22 +08:00
|
|
|
struct delayed_work *work, unsigned long delay);
|
2012-08-04 01:30:47 +08:00
|
|
|
extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
|
|
|
struct delayed_work *dwork, unsigned long delay);
|
2007-05-09 17:34:22 +08:00
|
|
|
|
2008-02-14 07:03:15 +08:00
|
|
|
extern void flush_workqueue(struct workqueue_struct *wq);
|
2011-04-06 00:01:44 +08:00
|
|
|
extern void drain_workqueue(struct workqueue_struct *wq);
|
2007-05-09 17:34:22 +08:00
|
|
|
extern void flush_scheduled_work(void);
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2006-11-22 22:55:48 +08:00
|
|
|
extern int schedule_on_each_cpu(work_func_t func);
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2006-11-22 22:55:48 +08:00
|
|
|
int execute_in_process_context(work_func_t fn, struct execute_work *);
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2010-09-16 16:36:00 +08:00
|
|
|
extern bool flush_work(struct work_struct *work);
|
|
|
|
extern bool cancel_work_sync(struct work_struct *work);
|
|
|
|
|
|
|
|
extern bool flush_delayed_work(struct delayed_work *dwork);
|
2012-08-22 04:18:24 +08:00
|
|
|
extern bool cancel_delayed_work(struct delayed_work *dwork);
|
2010-09-16 16:36:00 +08:00
|
|
|
extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
|
2007-05-09 17:34:22 +08:00
|
|
|
|
2010-06-29 16:07:14 +08:00
|
|
|
extern void workqueue_set_max_active(struct workqueue_struct *wq,
|
|
|
|
int max_active);
|
2013-03-13 08:41:37 +08:00
|
|
|
extern bool current_is_workqueue_rescuer(void);
|
2013-03-13 02:29:59 +08:00
|
|
|
extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
|
2010-06-29 16:07:14 +08:00
|
|
|
extern unsigned int work_busy(struct work_struct *work);
|
2013-05-01 06:27:22 +08:00
|
|
|
extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
|
|
|
|
extern void print_worker_info(const char *log_lvl, struct task_struct *task);
|
2010-06-29 16:07:14 +08:00
|
|
|
|
2013-03-14 07:51:36 +08:00
|
|
|
/**
|
|
|
|
* queue_work - queue work on a workqueue
|
|
|
|
* @wq: workqueue to use
|
|
|
|
* @work: work to queue
|
|
|
|
*
|
|
|
|
* Returns %false if @work was already on a queue, %true otherwise.
|
|
|
|
*
|
|
|
|
* We queue the work to the CPU on which it was submitted, but if the CPU dies
|
|
|
|
* it can be processed by another CPU.
|
|
|
|
*/
|
|
|
|
static inline bool queue_work(struct workqueue_struct *wq,
|
|
|
|
struct work_struct *work)
|
|
|
|
{
|
|
|
|
return queue_work_on(WORK_CPU_UNBOUND, wq, work);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* queue_delayed_work - queue work on a workqueue after delay
|
|
|
|
* @wq: workqueue to use
|
|
|
|
* @dwork: delayable work to queue
|
|
|
|
* @delay: number of jiffies to wait before queueing
|
|
|
|
*
|
|
|
|
* Equivalent to queue_delayed_work_on() but tries to use the local CPU.
|
|
|
|
*/
|
|
|
|
static inline bool queue_delayed_work(struct workqueue_struct *wq,
|
|
|
|
struct delayed_work *dwork,
|
|
|
|
unsigned long delay)
|
|
|
|
{
|
|
|
|
return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* mod_delayed_work - modify delay of or queue a delayed work
|
|
|
|
* @wq: workqueue to use
|
|
|
|
* @dwork: work to queue
|
|
|
|
* @delay: number of jiffies to wait before queueing
|
|
|
|
*
|
|
|
|
* mod_delayed_work_on() on local CPU.
|
|
|
|
*/
|
|
|
|
static inline bool mod_delayed_work(struct workqueue_struct *wq,
|
|
|
|
struct delayed_work *dwork,
|
|
|
|
unsigned long delay)
|
|
|
|
{
|
|
|
|
return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* schedule_work_on - put work task on a specific cpu
|
|
|
|
* @cpu: cpu to put the work task on
|
|
|
|
* @work: job to be done
|
|
|
|
*
|
|
|
|
* This puts a job on a specific cpu
|
|
|
|
*/
|
|
|
|
static inline bool schedule_work_on(int cpu, struct work_struct *work)
|
|
|
|
{
|
|
|
|
return queue_work_on(cpu, system_wq, work);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* schedule_work - put work task in global workqueue
|
|
|
|
* @work: job to be done
|
|
|
|
*
|
|
|
|
* Returns %false if @work was already on the kernel-global workqueue and
|
|
|
|
* %true otherwise.
|
|
|
|
*
|
|
|
|
* This puts a job in the kernel-global workqueue if it was not already
|
|
|
|
* queued and leaves it in the same position on the kernel-global
|
|
|
|
* workqueue otherwise.
|
|
|
|
*/
|
|
|
|
static inline bool schedule_work(struct work_struct *work)
|
|
|
|
{
|
|
|
|
return queue_work(system_wq, work);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* schedule_delayed_work_on - queue work in global workqueue on CPU after delay
|
|
|
|
* @cpu: cpu to use
|
|
|
|
* @dwork: job to be done
|
|
|
|
* @delay: number of jiffies to wait
|
|
|
|
*
|
|
|
|
* After waiting for a given time this puts a job in the kernel-global
|
|
|
|
* workqueue on the specified CPU.
|
|
|
|
*/
|
|
|
|
static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
|
|
|
|
unsigned long delay)
|
|
|
|
{
|
|
|
|
return queue_delayed_work_on(cpu, system_wq, dwork, delay);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* schedule_delayed_work - put work task in global workqueue after delay
|
|
|
|
* @dwork: job to be done
|
|
|
|
* @delay: number of jiffies to wait or 0 for immediate execution
|
|
|
|
*
|
|
|
|
* After waiting for a given time this puts a job in the kernel-global
|
|
|
|
* workqueue.
|
|
|
|
*/
|
|
|
|
static inline bool schedule_delayed_work(struct delayed_work *dwork,
|
|
|
|
unsigned long delay)
|
|
|
|
{
|
|
|
|
return queue_delayed_work(system_wq, dwork, delay);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* keventd_up - is workqueue initialized yet?
|
|
|
|
*/
|
|
|
|
static inline bool keventd_up(void)
|
|
|
|
{
|
|
|
|
return system_wq != NULL;
|
|
|
|
}
|
|
|
|
|
2009-09-06 02:17:06 +08:00
|
|
|
/*
|
|
|
|
* Like above, but uses del_timer() instead of del_timer_sync(). This means,
|
|
|
|
* if it returns 0 the timer function may be running and the queueing is in
|
|
|
|
* progress.
|
|
|
|
*/
|
2012-08-22 04:18:24 +08:00
|
|
|
static inline bool __deprecated __cancel_delayed_work(struct delayed_work *work)
|
2009-09-06 02:17:06 +08:00
|
|
|
{
|
2010-09-16 16:36:00 +08:00
|
|
|
bool ret;
|
2009-09-06 02:17:06 +08:00
|
|
|
|
|
|
|
ret = del_timer(&work->timer);
|
|
|
|
if (ret)
|
|
|
|
work_clear_pending(&work->work);
|
|
|
|
return ret;
|
|
|
|
}
|
|
|
|
|
2012-08-21 05:51:23 +08:00
|
|
|
/* used to be different but now identical to flush_work(), deprecated */
|
2012-08-21 05:51:24 +08:00
|
|
|
static inline bool __deprecated flush_work_sync(struct work_struct *work)
|
2012-08-21 05:51:23 +08:00
|
|
|
{
|
|
|
|
return flush_work(work);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* used to be different but now identical to flush_delayed_work(), deprecated */
|
2012-08-21 05:51:24 +08:00
|
|
|
static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
|
2012-08-21 05:51:23 +08:00
|
|
|
{
|
|
|
|
return flush_delayed_work(dwork);
|
|
|
|
}
|
|
|
|
|
2008-11-05 10:39:10 +08:00
|
|
|
#ifndef CONFIG_SMP
|
2013-03-13 02:29:59 +08:00
|
|
|
static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
|
2008-11-05 10:39:10 +08:00
|
|
|
{
|
|
|
|
return fn(arg);
|
|
|
|
}
|
|
|
|
#else
|
2013-03-13 02:29:59 +08:00
|
|
|
long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
|
2008-11-05 10:39:10 +08:00
|
|
|
#endif /* CONFIG_SMP */
|
2010-05-14 03:32:28 +08:00
|
|
|
|
2010-06-29 16:07:12 +08:00
|
|
|
#ifdef CONFIG_FREEZER
|
|
|
|
extern void freeze_workqueues_begin(void);
|
|
|
|
extern bool freeze_workqueues_busy(void);
|
|
|
|
extern void thaw_workqueues(void);
|
|
|
|
#endif /* CONFIG_FREEZER */
|
|
|
|
|
2013-03-13 02:30:05 +08:00
|
|
|
#ifdef CONFIG_SYSFS
|
|
|
|
int workqueue_sysfs_register(struct workqueue_struct *wq);
|
|
|
|
#else /* CONFIG_SYSFS */
|
|
|
|
static inline int workqueue_sysfs_register(struct workqueue_struct *wq)
|
|
|
|
{ return 0; }
|
|
|
|
#endif /* CONFIG_SYSFS */
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
#endif
|