linux/include/linux/workqueue.h
<<
>>
Prefs
   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#include <linux/lockdep.h>
  12#include <linux/threads.h>
  13#include <linux/atomic.h>
  14#include <linux/cpumask.h>
  15
  16struct workqueue_struct;
  17
  18struct work_struct;
  19typedef void (*work_func_t)(struct work_struct *work);
  20void delayed_work_timer_fn(unsigned long __data);
  21
  22/*
  23 * The first word is the work queue pointer and the flags rolled into
  24 * one
  25 */
  26#define work_data_bits(work) ((unsigned long *)(&(work)->data))
  27
  28enum {
  29        WORK_STRUCT_PENDING_BIT = 0,    /* work item is pending execution */
  30        WORK_STRUCT_DELAYED_BIT = 1,    /* work item is delayed */
  31        WORK_STRUCT_PWQ_BIT     = 2,    /* data points to pwq */
  32        WORK_STRUCT_LINKED_BIT  = 3,    /* next work is linked to this one */
  33#ifdef CONFIG_DEBUG_OBJECTS_WORK
  34        WORK_STRUCT_STATIC_BIT  = 4,    /* static initializer (debugobjects) */
  35        WORK_STRUCT_COLOR_SHIFT = 5,    /* color for workqueue flushing */
  36#else
  37        WORK_STRUCT_COLOR_SHIFT = 4,    /* color for workqueue flushing */
  38#endif
  39
  40        WORK_STRUCT_COLOR_BITS  = 4,
  41
  42        WORK_STRUCT_PENDING     = 1 << WORK_STRUCT_PENDING_BIT,
  43        WORK_STRUCT_DELAYED     = 1 << WORK_STRUCT_DELAYED_BIT,
  44        WORK_STRUCT_PWQ         = 1 << WORK_STRUCT_PWQ_BIT,
  45        WORK_STRUCT_LINKED      = 1 << WORK_STRUCT_LINKED_BIT,
  46#ifdef CONFIG_DEBUG_OBJECTS_WORK
  47        WORK_STRUCT_STATIC      = 1 << WORK_STRUCT_STATIC_BIT,
  48#else
  49        WORK_STRUCT_STATIC      = 0,
  50#endif
  51
  52        /*
  53         * The last color is no color used for works which don't
  54         * participate in workqueue flushing.
  55         */
  56        WORK_NR_COLORS          = (1 << WORK_STRUCT_COLOR_BITS) - 1,
  57        WORK_NO_COLOR           = WORK_NR_COLORS,
  58
  59        /* special cpu IDs */
  60        WORK_CPU_UNBOUND        = NR_CPUS,
  61        WORK_CPU_END            = NR_CPUS + 1,
  62
  63        /*
  64         * Reserve 7 bits off of pwq pointer w/ debugobjects turned off.
  65         * This makes pwqs aligned to 256 bytes and allows 15 workqueue
  66         * flush colors.
  67         */
  68        WORK_STRUCT_FLAG_BITS   = WORK_STRUCT_COLOR_SHIFT +
  69                                  WORK_STRUCT_COLOR_BITS,
  70
  71        /* data contains off-queue information when !WORK_STRUCT_PWQ */
  72        WORK_OFFQ_FLAG_BASE     = WORK_STRUCT_COLOR_SHIFT,
  73
  74        WORK_OFFQ_CANCELING     = (1 << WORK_OFFQ_FLAG_BASE),
  75
  76        /*
  77         * When a work item is off queue, its high bits point to the last
  78         * pool it was on.  Cap at 31 bits and use the highest number to
  79         * indicate that no pool is associated.
  80         */
  81        WORK_OFFQ_FLAG_BITS     = 1,
  82        WORK_OFFQ_POOL_SHIFT    = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,
  83        WORK_OFFQ_LEFT          = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT,
  84        WORK_OFFQ_POOL_BITS     = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31,
  85        WORK_OFFQ_POOL_NONE     = (1LU << WORK_OFFQ_POOL_BITS) - 1,
  86
  87        /* convenience constants */
  88        WORK_STRUCT_FLAG_MASK   = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
  89        WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
  90        WORK_STRUCT_NO_POOL     = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT,
  91
  92        /* bit mask for work_busy() return values */
  93        WORK_BUSY_PENDING       = 1 << 0,
  94        WORK_BUSY_RUNNING       = 1 << 1,
  95
  96        /* maximum string length for set_worker_desc() */
  97        WORKER_DESC_LEN         = 24,
  98};
  99
 100struct work_struct {
 101        atomic_long_t data;
 102        struct list_head entry;
 103        work_func_t func;
 104#ifdef CONFIG_LOCKDEP
 105        struct lockdep_map lockdep_map;
 106#endif
 107};
 108
 109#define WORK_DATA_INIT()        ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL)
 110#define WORK_DATA_STATIC_INIT() \
 111        ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC)
 112
 113struct delayed_work {
 114        struct work_struct work;
 115        struct timer_list timer;
 116
 117        /* target workqueue and CPU ->timer uses to queue ->work */
 118        struct workqueue_struct *wq;
 119        int cpu;
 120};
 121
 122/*
 123 * A struct for workqueue attributes.  This can be used to change
 124 * attributes of an unbound workqueue.
 125 *
 126 * Unlike other fields, ->no_numa isn't a property of a worker_pool.  It
 127 * only modifies how apply_workqueue_attrs() select pools and thus doesn't
 128 * participate in pool hash calculations or equality comparisons.
 129 */
 130struct workqueue_attrs {
 131        int                     nice;           /* nice level */
 132        cpumask_var_t           cpumask;        /* allowed CPUs */
 133        bool                    no_numa;        /* disable NUMA affinity */
 134};
 135
 136static inline struct delayed_work *to_delayed_work(struct work_struct *work)
 137{
 138        return container_of(work, struct delayed_work, work);
 139}
 140
 141struct execute_work {
 142        struct work_struct work;
 143};
 144
 145#ifdef CONFIG_LOCKDEP
 146/*
 147 * NB: because we have to copy the lockdep_map, setting _key
 148 * here is required, otherwise it could get initialised to the
 149 * copy of the lockdep_map!
 150 */
 151#define __WORK_INIT_LOCKDEP_MAP(n, k) \
 152        .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
 153#else
 154#define __WORK_INIT_LOCKDEP_MAP(n, k)
 155#endif
 156
 157#define __WORK_INITIALIZER(n, f) {                                      \
 158        .data = WORK_DATA_STATIC_INIT(),                                \
 159        .entry  = { &(n).entry, &(n).entry },                           \
 160        .func = (f),                                                    \
 161        __WORK_INIT_LOCKDEP_MAP(#n, &(n))                               \
 162        }
 163
 164#define __DELAYED_WORK_INITIALIZER(n, f, tflags) {                      \
 165        .work = __WORK_INITIALIZER((n).work, (f)),                      \
 166        .timer = __TIMER_INITIALIZER(delayed_work_timer_fn,             \
 167                                     0, (unsigned long)&(n),            \
 168                                     (tflags) | TIMER_IRQSAFE),         \
 169        }
 170
 171#define DECLARE_WORK(n, f)                                              \
 172        struct work_struct n = __WORK_INITIALIZER(n, f)
 173
 174#define DECLARE_DELAYED_WORK(n, f)                                      \
 175        struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
 176
 177#define DECLARE_DEFERRABLE_WORK(n, f)                                   \
 178        struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
 179
 180/*
 181 * initialize a work item's function pointer
 182 */
 183#define PREPARE_WORK(_work, _func)                                      \
 184        do {                                                            \
 185                (_work)->func = (_func);                                \
 186        } while (0)
 187
 188#define PREPARE_DELAYED_WORK(_work, _func)                              \
 189        PREPARE_WORK(&(_work)->work, (_func))
 190
 191#ifdef CONFIG_DEBUG_OBJECTS_WORK
 192extern void __init_work(struct work_struct *work, int onstack);
 193extern void destroy_work_on_stack(struct work_struct *work);
 194extern void destroy_delayed_work_on_stack(struct delayed_work *work);
 195static inline unsigned int work_static(struct work_struct *work)
 196{
 197        return *work_data_bits(work) & WORK_STRUCT_STATIC;
 198}
 199#else
 200static inline void __init_work(struct work_struct *work, int onstack) { }
 201static inline void destroy_work_on_stack(struct work_struct *work) { }
 202static inline void destroy_delayed_work_on_stack(struct delayed_work *work) { }
 203static inline unsigned int work_static(struct work_struct *work) { return 0; }
 204#endif
 205
 206/*
 207 * initialize all of a work item in one go
 208 *
 209 * NOTE! No point in using "atomic_long_set()": using a direct
 210 * assignment of the work data initializer allows the compiler
 211 * to generate better code.
 212 */
 213#ifdef CONFIG_LOCKDEP
 214#define __INIT_WORK(_work, _func, _onstack)                             \
 215        do {                                                            \
 216                static struct lock_class_key __key;                     \
 217                                                                        \
 218                __init_work((_work), _onstack);                         \
 219                (_work)->data = (atomic_long_t) WORK_DATA_INIT();       \
 220                lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
 221                INIT_LIST_HEAD(&(_work)->entry);                        \
 222                PREPARE_WORK((_work), (_func));                         \
 223        } while (0)
 224#else
 225#define __INIT_WORK(_work, _func, _onstack)                             \
 226        do {                                                            \
 227                __init_work((_work), _onstack);                         \
 228                (_work)->data = (atomic_long_t) WORK_DATA_INIT();       \
 229                INIT_LIST_HEAD(&(_work)->entry);                        \
 230                PREPARE_WORK((_work), (_func));                         \
 231        } while (0)
 232#endif
 233
 234#define INIT_WORK(_work, _func)                                         \
 235        do {                                                            \
 236                __INIT_WORK((_work), (_func), 0);                       \
 237        } while (0)
 238
 239#define INIT_WORK_ONSTACK(_work, _func)                                 \
 240        do {                                                            \
 241                __INIT_WORK((_work), (_func), 1);                       \
 242        } while (0)
 243
 244#define __INIT_DELAYED_WORK(_work, _func, _tflags)                      \
 245        do {                                                            \
 246                INIT_WORK(&(_work)->work, (_func));                     \
 247                __setup_timer(&(_work)->timer, delayed_work_timer_fn,   \
 248                              (unsigned long)(_work),                   \
 249                              (_tflags) | TIMER_IRQSAFE);               \
 250        } while (0)
 251
 252#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags)              \
 253        do {                                                            \
 254                INIT_WORK_ONSTACK(&(_work)->work, (_func));             \
 255                __setup_timer_on_stack(&(_work)->timer,                 \
 256                                       delayed_work_timer_fn,           \
 257                                       (unsigned long)(_work),          \
 258                                       (_tflags) | TIMER_IRQSAFE);      \
 259        } while (0)
 260
 261#define INIT_DELAYED_WORK(_work, _func)                                 \
 262        __INIT_DELAYED_WORK(_work, _func, 0)
 263
 264#define INIT_DELAYED_WORK_ONSTACK(_work, _func)                         \
 265        __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
 266
 267#define INIT_DEFERRABLE_WORK(_work, _func)                              \
 268        __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
 269
 270#define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func)                      \
 271        __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
 272
 273/**
 274 * work_pending - Find out whether a work item is currently pending
 275 * @work: The work item in question
 276 */
 277#define work_pending(work) \
 278        test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
 279
 280/**
 281 * delayed_work_pending - Find out whether a delayable work item is currently
 282 * pending
 283 * @work: The work item in question
 284 */
 285#define delayed_work_pending(w) \
 286        work_pending(&(w)->work)
 287
 288/**
 289 * work_clear_pending - for internal use only, mark a work item as not pending
 290 * @work: The work item in question
 291 */
 292#define work_clear_pending(work) \
 293        clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
 294
 295/*
 296 * Workqueue flags and constants.  For details, please refer to
 297 * Documentation/workqueue.txt.
 298 */
 299enum {
 300        WQ_NON_REENTRANT        = 1 << 0, /* guarantee non-reentrance */
 301        WQ_UNBOUND              = 1 << 1, /* not bound to any cpu */
 302        WQ_FREEZABLE            = 1 << 2, /* freeze during suspend */
 303        WQ_MEM_RECLAIM          = 1 << 3, /* may be used for memory reclaim */
 304        WQ_HIGHPRI              = 1 << 4, /* high priority */
 305        WQ_CPU_INTENSIVE        = 1 << 5, /* cpu instensive workqueue */
 306        WQ_SYSFS                = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
 307
 308        /*
 309         * Per-cpu workqueues are generally preferred because they tend to
 310         * show better performance thanks to cache locality.  Per-cpu
 311         * workqueues exclude the scheduler from choosing the CPU to
 312         * execute the worker threads, which has an unfortunate side effect
 313         * of increasing power consumption.
 314         *
 315         * The scheduler considers a CPU idle if it doesn't have any task
 316         * to execute and tries to keep idle cores idle to conserve power;
 317         * however, for example, a per-cpu work item scheduled from an
 318         * interrupt handler on an idle CPU will force the scheduler to
 319         * excute the work item on that CPU breaking the idleness, which in
 320         * turn may lead to more scheduling choices which are sub-optimal
 321         * in terms of power consumption.
 322         *
 323         * Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default
 324         * but become unbound if workqueue.power_efficient kernel param is
 325         * specified.  Per-cpu workqueues which are identified to
 326         * contribute significantly to power-consumption are identified and
 327         * marked with this flag and enabling the power_efficient mode
 328         * leads to noticeable power saving at the cost of small
 329         * performance disadvantage.
 330         *
 331         * http://thread.gmane.org/gmane.linux.kernel/1480396
 332         */
 333        WQ_POWER_EFFICIENT      = 1 << 7,
 334
 335        __WQ_DRAINING           = 1 << 16, /* internal: workqueue is draining */
 336        __WQ_ORDERED            = 1 << 17, /* internal: workqueue is ordered */
 337
 338        WQ_MAX_ACTIVE           = 512,    /* I like 512, better ideas? */
 339        WQ_MAX_UNBOUND_PER_CPU  = 4,      /* 4 * #cpus for unbound wq */
 340        WQ_DFL_ACTIVE           = WQ_MAX_ACTIVE / 2,
 341};
 342
 343/* unbound wq's aren't per-cpu, scale max_active according to #cpus */
 344#define WQ_UNBOUND_MAX_ACTIVE   \
 345        max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
 346
 347/*
 348 * System-wide workqueues which are always present.
 349 *
 350 * system_wq is the one used by schedule[_delayed]_work[_on]().
 351 * Multi-CPU multi-threaded.  There are users which expect relatively
 352 * short queue flush time.  Don't queue works which can run for too
 353 * long.
 354 *
 355 * system_highpri_wq is similar to system_wq but for work items which
 356 * require WQ_HIGHPRI.
 357 *
 358 * system_long_wq is similar to system_wq but may host long running
 359 * works.  Queue flushing might take relatively long.
 360 *
 361 * system_unbound_wq is unbound workqueue.  Workers are not bound to
 362 * any specific CPU, not concurrency managed, and all queued works are
 363 * executed immediately as long as max_active limit is not reached and
 364 * resources are available.
 365 *
 366 * system_freezable_wq is equivalent to system_wq except that it's
 367 * freezable.
 368 *
 369 * *_power_efficient_wq are inclined towards saving power and converted
 370 * into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise,
 371 * they are same as their non-power-efficient counterparts - e.g.
 372 * system_power_efficient_wq is identical to system_wq if
 373 * 'wq_power_efficient' is disabled.  See WQ_POWER_EFFICIENT for more info.
 374 */
 375extern struct workqueue_struct *system_wq;
 376extern struct workqueue_struct *system_highpri_wq;
 377extern struct workqueue_struct *system_long_wq;
 378extern struct workqueue_struct *system_unbound_wq;
 379extern struct workqueue_struct *system_freezable_wq;
 380extern struct workqueue_struct *system_power_efficient_wq;
 381extern struct workqueue_struct *system_freezable_power_efficient_wq;
 382
 383static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
 384{
 385        return system_wq;
 386}
 387
 388static inline struct workqueue_struct * __deprecated __system_nrt_freezable_wq(void)
 389{
 390        return system_freezable_wq;
 391}
 392
 393/* equivlalent to system_wq and system_freezable_wq, deprecated */
 394#define system_nrt_wq                   __system_nrt_wq()
 395#define system_nrt_freezable_wq         __system_nrt_freezable_wq()
 396
 397extern struct workqueue_struct *
 398__alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
 399        struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6);
 400
 401/**
 402 * alloc_workqueue - allocate a workqueue
 403 * @fmt: printf format for the name of the workqueue
 404 * @flags: WQ_* flags
 405 * @max_active: max in-flight work items, 0 for default
 406 * @args: args for @fmt
 407 *
 408 * Allocate a workqueue with the specified parameters.  For detailed
 409 * information on WQ_* flags, please refer to Documentation/workqueue.txt.
 410 *
 411 * The __lock_name macro dance is to guarantee that single lock_class_key
 412 * doesn't end up with different namesm, which isn't allowed by lockdep.
 413 *
 414 * RETURNS:
 415 * Pointer to the allocated workqueue on success, %NULL on failure.
 416 */
 417#ifdef CONFIG_LOCKDEP
 418#define alloc_workqueue(fmt, flags, max_active, args...)                \
 419({                                                                      \
 420        static struct lock_class_key __key;                             \
 421        const char *__lock_name;                                        \
 422                                                                        \
 423        if (__builtin_constant_p(fmt))                                  \
 424                __lock_name = (fmt);                                    \
 425        else                                                            \
 426                __lock_name = #fmt;                                     \
 427                                                                        \
 428        __alloc_workqueue_key((fmt), (flags), (max_active),             \
 429                              &__key, __lock_name, ##args);             \
 430})
 431#else
 432#define alloc_workqueue(fmt, flags, max_active, args...)                \
 433        __alloc_workqueue_key((fmt), (flags), (max_active),             \
 434                              NULL, NULL, ##args)
 435#endif
 436
 437/**
 438 * alloc_ordered_workqueue - allocate an ordered workqueue
 439 * @fmt: printf format for the name of the workqueue
 440 * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
 441 * @args: args for @fmt
 442 *
 443 * Allocate an ordered workqueue.  An ordered workqueue executes at
 444 * most one work item at any given time in the queued order.  They are
 445 * implemented as unbound workqueues with @max_active of one.
 446 *
 447 * RETURNS:
 448 * Pointer to the allocated workqueue on success, %NULL on failure.
 449 */
 450#define alloc_ordered_workqueue(fmt, flags, args...)                    \
 451        alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args)
 452
 453#define create_workqueue(name)                                          \
 454        alloc_workqueue("%s", WQ_MEM_RECLAIM, 1, (name))
 455#define create_freezable_workqueue(name)                                \
 456        alloc_workqueue("%s", WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, \
 457                        1, (name))
 458#define create_singlethread_workqueue(name)                             \
 459        alloc_ordered_workqueue("%s", WQ_MEM_RECLAIM, (name))
 460
 461extern void destroy_workqueue(struct workqueue_struct *wq);
 462
 463struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask);
 464void free_workqueue_attrs(struct workqueue_attrs *attrs);
 465int apply_workqueue_attrs(struct workqueue_struct *wq,
 466                          const struct workqueue_attrs *attrs);
 467
 468extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
 469                        struct work_struct *work);
 470extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
 471                        struct delayed_work *work, unsigned long delay);
 472extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
 473                        struct delayed_work *dwork, unsigned long delay);
 474
 475extern void flush_workqueue(struct workqueue_struct *wq);
 476extern void drain_workqueue(struct workqueue_struct *wq);
 477extern void flush_scheduled_work(void);
 478
 479extern int schedule_on_each_cpu(work_func_t func);
 480
 481int execute_in_process_context(work_func_t fn, struct execute_work *);
 482
 483extern bool flush_work(struct work_struct *work);
 484extern bool cancel_work_sync(struct work_struct *work);
 485
 486extern bool flush_delayed_work(struct delayed_work *dwork);
 487extern bool cancel_delayed_work(struct delayed_work *dwork);
 488extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
 489
 490extern void workqueue_set_max_active(struct workqueue_struct *wq,
 491                                     int max_active);
 492extern bool current_is_workqueue_rescuer(void);
 493extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
 494extern unsigned int work_busy(struct work_struct *work);
 495extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
 496extern void print_worker_info(const char *log_lvl, struct task_struct *task);
 497
 498/**
 499 * queue_work - queue work on a workqueue
 500 * @wq: workqueue to use
 501 * @work: work to queue
 502 *
 503 * Returns %false if @work was already on a queue, %true otherwise.
 504 *
 505 * We queue the work to the CPU on which it was submitted, but if the CPU dies
 506 * it can be processed by another CPU.
 507 */
 508static inline bool queue_work(struct workqueue_struct *wq,
 509                              struct work_struct *work)
 510{
 511        return queue_work_on(WORK_CPU_UNBOUND, wq, work);
 512}
 513
 514/**
 515 * queue_delayed_work - queue work on a workqueue after delay
 516 * @wq: workqueue to use
 517 * @dwork: delayable work to queue
 518 * @delay: number of jiffies to wait before queueing
 519 *
 520 * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
 521 */
 522static inline bool queue_delayed_work(struct workqueue_struct *wq,
 523                                      struct delayed_work *dwork,
 524                                      unsigned long delay)
 525{
 526        return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
 527}
 528
 529/**
 530 * mod_delayed_work - modify delay of or queue a delayed work
 531 * @wq: workqueue to use
 532 * @dwork: work to queue
 533 * @delay: number of jiffies to wait before queueing
 534 *
 535 * mod_delayed_work_on() on local CPU.
 536 */
 537static inline bool mod_delayed_work(struct workqueue_struct *wq,
 538                                    struct delayed_work *dwork,
 539                                    unsigned long delay)
 540{
 541        return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
 542}
 543
 544/**
 545 * schedule_work_on - put work task on a specific cpu
 546 * @cpu: cpu to put the work task on
 547 * @work: job to be done
 548 *
 549 * This puts a job on a specific cpu
 550 */
 551static inline bool schedule_work_on(int cpu, struct work_struct *work)
 552{
 553        return queue_work_on(cpu, system_wq, work);
 554}
 555
 556/**
 557 * schedule_work - put work task in global workqueue
 558 * @work: job to be done
 559 *
 560 * Returns %false if @work was already on the kernel-global workqueue and
 561 * %true otherwise.
 562 *
 563 * This puts a job in the kernel-global workqueue if it was not already
 564 * queued and leaves it in the same position on the kernel-global
 565 * workqueue otherwise.
 566 */
 567static inline bool schedule_work(struct work_struct *work)
 568{
 569        return queue_work(system_wq, work);
 570}
 571
 572/**
 573 * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
 574 * @cpu: cpu to use
 575 * @dwork: job to be done
 576 * @delay: number of jiffies to wait
 577 *
 578 * After waiting for a given time this puts a job in the kernel-global
 579 * workqueue on the specified CPU.
 580 */
 581static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
 582                                            unsigned long delay)
 583{
 584        return queue_delayed_work_on(cpu, system_wq, dwork, delay);
 585}
 586
 587/**
 588 * schedule_delayed_work - put work task in global workqueue after delay
 589 * @dwork: job to be done
 590 * @delay: number of jiffies to wait or 0 for immediate execution
 591 *
 592 * After waiting for a given time this puts a job in the kernel-global
 593 * workqueue.
 594 */
 595static inline bool schedule_delayed_work(struct delayed_work *dwork,
 596                                         unsigned long delay)
 597{
 598        return queue_delayed_work(system_wq, dwork, delay);
 599}
 600
 601/**
 602 * keventd_up - is workqueue initialized yet?
 603 */
 604static inline bool keventd_up(void)
 605{
 606        return system_wq != NULL;
 607}
 608
 609/*
 610 * Like above, but uses del_timer() instead of del_timer_sync(). This means,
 611 * if it returns 0 the timer function may be running and the queueing is in
 612 * progress.
 613 */
 614static inline bool __deprecated __cancel_delayed_work(struct delayed_work *work)
 615{
 616        bool ret;
 617
 618        ret = del_timer(&work->timer);
 619        if (ret)
 620                work_clear_pending(&work->work);
 621        return ret;
 622}
 623
 624/* used to be different but now identical to flush_work(), deprecated */
 625static inline bool __deprecated flush_work_sync(struct work_struct *work)
 626{
 627        return flush_work(work);
 628}
 629
 630/* used to be different but now identical to flush_delayed_work(), deprecated */
 631static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
 632{
 633        return flush_delayed_work(dwork);
 634}
 635
 636#ifndef CONFIG_SMP
 637static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
 638{
 639        return fn(arg);
 640}
 641#else
 642long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
 643#endif /* CONFIG_SMP */
 644
 645#ifdef CONFIG_FREEZER
 646extern void freeze_workqueues_begin(void);
 647extern bool freeze_workqueues_busy(void);
 648extern void thaw_workqueues(void);
 649#endif /* CONFIG_FREEZER */
 650
 651#ifdef CONFIG_SYSFS
 652int workqueue_sysfs_register(struct workqueue_struct *wq);
 653#else   /* CONFIG_SYSFS */
 654static inline int workqueue_sysfs_register(struct workqueue_struct *wq)
 655{ return 0; }
 656#endif  /* CONFIG_SYSFS */
 657
 658#ifdef CONFIG_WQ_WATCHDOG
 659void wq_watchdog_touch(int cpu);
 660#else   /* CONFIG_WQ_WATCHDOG */
 661static inline void wq_watchdog_touch(int cpu) { }
 662#endif  /* CONFIG_WQ_WATCHDOG */
 663
 664#endif
 665