~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/linux/workqueue.h

Version: ~ [ linux-5.10-rc1 ] ~ [ linux-5.9.1 ] ~ [ linux-5.8.16 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.72 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.152 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.202 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.240 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.240 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  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 
 16 struct workqueue_struct;
 17 
 18 struct work_struct;
 19 typedef void (*work_func_t)(struct work_struct *work);
 20 void 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 
 28 enum {
 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         /* not bound to any CPU, prefer the local CPU */
 60         WORK_CPU_UNBOUND        = NR_CPUS,
 61 
 62         /*
 63          * Reserve 7 bits off of pwq pointer w/ debugobjects turned off.
 64          * This makes pwqs aligned to 256 bytes and allows 15 workqueue
 65          * flush colors.
 66          */
 67         WORK_STRUCT_FLAG_BITS   = WORK_STRUCT_COLOR_SHIFT +
 68                                   WORK_STRUCT_COLOR_BITS,
 69 
 70         /* data contains off-queue information when !WORK_STRUCT_PWQ */
 71         WORK_OFFQ_FLAG_BASE     = WORK_STRUCT_COLOR_SHIFT,
 72 
 73         __WORK_OFFQ_CANCELING   = WORK_OFFQ_FLAG_BASE,
 74         WORK_OFFQ_CANCELING     = (1 << __WORK_OFFQ_CANCELING),
 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 
100 struct 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 
113 struct 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  */
130 struct workqueue_attrs {
131         int                     nice;           /* nice level */
132         cpumask_var_t           cpumask;        /* allowed CPUs */
133         bool                    no_numa;        /* disable NUMA affinity */
134 };
135 
136 static inline struct delayed_work *to_delayed_work(struct work_struct *work)
137 {
138         return container_of(work, struct delayed_work, work);
139 }
140 
141 struct 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 #ifdef CONFIG_DEBUG_OBJECTS_WORK
181 extern void __init_work(struct work_struct *work, int onstack);
182 extern void destroy_work_on_stack(struct work_struct *work);
183 extern void destroy_delayed_work_on_stack(struct delayed_work *work);
184 static inline unsigned int work_static(struct work_struct *work)
185 {
186         return *work_data_bits(work) & WORK_STRUCT_STATIC;
187 }
188 #else
189 static inline void __init_work(struct work_struct *work, int onstack) { }
190 static inline void destroy_work_on_stack(struct work_struct *work) { }
191 static inline void destroy_delayed_work_on_stack(struct delayed_work *work) { }
192 static inline unsigned int work_static(struct work_struct *work) { return 0; }
193 #endif
194 
195 /*
196  * initialize all of a work item in one go
197  *
198  * NOTE! No point in using "atomic_long_set()": using a direct
199  * assignment of the work data initializer allows the compiler
200  * to generate better code.
201  */
202 #ifdef CONFIG_LOCKDEP
203 #define __INIT_WORK(_work, _func, _onstack)                             \
204         do {                                                            \
205                 static struct lock_class_key __key;                     \
206                                                                         \
207                 __init_work((_work), _onstack);                         \
208                 (_work)->data = (atomic_long_t) WORK_DATA_INIT();       \
209                 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
210                 INIT_LIST_HEAD(&(_work)->entry);                        \
211                 (_work)->func = (_func);                                \
212         } while (0)
213 #else
214 #define __INIT_WORK(_work, _func, _onstack)                             \
215         do {                                                            \
216                 __init_work((_work), _onstack);                         \
217                 (_work)->data = (atomic_long_t) WORK_DATA_INIT();       \
218                 INIT_LIST_HEAD(&(_work)->entry);                        \
219                 (_work)->func = (_func);                                \
220         } while (0)
221 #endif
222 
223 #define INIT_WORK(_work, _func)                                         \
224         do {                                                            \
225                 __INIT_WORK((_work), (_func), 0);                       \
226         } while (0)
227 
228 #define INIT_WORK_ONSTACK(_work, _func)                                 \
229         do {                                                            \
230                 __INIT_WORK((_work), (_func), 1);                       \
231         } while (0)
232 
233 #define __INIT_DELAYED_WORK(_work, _func, _tflags)                      \
234         do {                                                            \
235                 INIT_WORK(&(_work)->work, (_func));                     \
236                 __setup_timer(&(_work)->timer, delayed_work_timer_fn,   \
237                               (unsigned long)(_work),                   \
238                               (_tflags) | TIMER_IRQSAFE);               \
239         } while (0)
240 
241 #define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags)              \
242         do {                                                            \
243                 INIT_WORK_ONSTACK(&(_work)->work, (_func));             \
244                 __setup_timer_on_stack(&(_work)->timer,                 \
245                                        delayed_work_timer_fn,           \
246                                        (unsigned long)(_work),          \
247                                        (_tflags) | TIMER_IRQSAFE);      \
248         } while (0)
249 
250 #define INIT_DELAYED_WORK(_work, _func)                                 \
251         __INIT_DELAYED_WORK(_work, _func, 0)
252 
253 #define INIT_DELAYED_WORK_ONSTACK(_work, _func)                         \
254         __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
255 
256 #define INIT_DEFERRABLE_WORK(_work, _func)                              \
257         __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
258 
259 #define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func)                      \
260         __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
261 
262 /**
263  * work_pending - Find out whether a work item is currently pending
264  * @work: The work item in question
265  */
266 #define work_pending(work) \
267         test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
268 
269 /**
270  * delayed_work_pending - Find out whether a delayable work item is currently
271  * pending
272  * @work: The work item in question
273  */
274 #define delayed_work_pending(w) \
275         work_pending(&(w)->work)
276 
277 /*
278  * Workqueue flags and constants.  For details, please refer to
279  * Documentation/workqueue.txt.
280  */
281 enum {
282         WQ_UNBOUND              = 1 << 1, /* not bound to any cpu */
283         WQ_FREEZABLE            = 1 << 2, /* freeze during suspend */
284         WQ_MEM_RECLAIM          = 1 << 3, /* may be used for memory reclaim */
285         WQ_HIGHPRI              = 1 << 4, /* high priority */
286         WQ_CPU_INTENSIVE        = 1 << 5, /* cpu intensive workqueue */
287         WQ_SYSFS                = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
288 
289         /*
290          * Per-cpu workqueues are generally preferred because they tend to
291          * show better performance thanks to cache locality.  Per-cpu
292          * workqueues exclude the scheduler from choosing the CPU to
293          * execute the worker threads, which has an unfortunate side effect
294          * of increasing power consumption.
295          *
296          * The scheduler considers a CPU idle if it doesn't have any task
297          * to execute and tries to keep idle cores idle to conserve power;
298          * however, for example, a per-cpu work item scheduled from an
299          * interrupt handler on an idle CPU will force the scheduler to
300          * excute the work item on that CPU breaking the idleness, which in
301          * turn may lead to more scheduling choices which are sub-optimal
302          * in terms of power consumption.
303          *
304          * Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default
305          * but become unbound if workqueue.power_efficient kernel param is
306          * specified.  Per-cpu workqueues which are identified to
307          * contribute significantly to power-consumption are identified and
308          * marked with this flag and enabling the power_efficient mode
309          * leads to noticeable power saving at the cost of small
310          * performance disadvantage.
311          *
312          * http://thread.gmane.org/gmane.linux.kernel/1480396
313          */
314         WQ_POWER_EFFICIENT      = 1 << 7,
315 
316         __WQ_DRAINING           = 1 << 16, /* internal: workqueue is draining */
317         __WQ_ORDERED            = 1 << 17, /* internal: workqueue is ordered */
318 
319         WQ_MAX_ACTIVE           = 512,    /* I like 512, better ideas? */
320         WQ_MAX_UNBOUND_PER_CPU  = 4,      /* 4 * #cpus for unbound wq */
321         WQ_DFL_ACTIVE           = WQ_MAX_ACTIVE / 2,
322 };
323 
324 /* unbound wq's aren't per-cpu, scale max_active according to #cpus */
325 #define WQ_UNBOUND_MAX_ACTIVE   \
326         max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
327 
328 /*
329  * System-wide workqueues which are always present.
330  *
331  * system_wq is the one used by schedule[_delayed]_work[_on]().
332  * Multi-CPU multi-threaded.  There are users which expect relatively
333  * short queue flush time.  Don't queue works which can run for too
334  * long.
335  *
336  * system_highpri_wq is similar to system_wq but for work items which
337  * require WQ_HIGHPRI.
338  *
339  * system_long_wq is similar to system_wq but may host long running
340  * works.  Queue flushing might take relatively long.
341  *
342  * system_unbound_wq is unbound workqueue.  Workers are not bound to
343  * any specific CPU, not concurrency managed, and all queued works are
344  * executed immediately as long as max_active limit is not reached and
345  * resources are available.
346  *
347  * system_freezable_wq is equivalent to system_wq except that it's
348  * freezable.
349  *
350  * *_power_efficient_wq are inclined towards saving power and converted
351  * into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise,
352  * they are same as their non-power-efficient counterparts - e.g.
353  * system_power_efficient_wq is identical to system_wq if
354  * 'wq_power_efficient' is disabled.  See WQ_POWER_EFFICIENT for more info.
355  */
356 extern struct workqueue_struct *system_wq;
357 extern struct workqueue_struct *system_highpri_wq;
358 extern struct workqueue_struct *system_long_wq;
359 extern struct workqueue_struct *system_unbound_wq;
360 extern struct workqueue_struct *system_freezable_wq;
361 extern struct workqueue_struct *system_power_efficient_wq;
362 extern struct workqueue_struct *system_freezable_power_efficient_wq;
363 
364 extern struct workqueue_struct *
365 __alloc_workqueue_key(const char *fmt, unsigned int flags, int max_active,
366         struct lock_class_key *key, const char *lock_name, ...) __printf(1, 6);
367 
368 /**
369  * alloc_workqueue - allocate a workqueue
370  * @fmt: printf format for the name of the workqueue
371  * @flags: WQ_* flags
372  * @max_active: max in-flight work items, 0 for default
373  * @args: args for @fmt
374  *
375  * Allocate a workqueue with the specified parameters.  For detailed
376  * information on WQ_* flags, please refer to Documentation/workqueue.txt.
377  *
378  * The __lock_name macro dance is to guarantee that single lock_class_key
379  * doesn't end up with different namesm, which isn't allowed by lockdep.
380  *
381  * RETURNS:
382  * Pointer to the allocated workqueue on success, %NULL on failure.
383  */
384 #ifdef CONFIG_LOCKDEP
385 #define alloc_workqueue(fmt, flags, max_active, args...)                \
386 ({                                                                      \
387         static struct lock_class_key __key;                             \
388         const char *__lock_name;                                        \
389                                                                         \
390         __lock_name = #fmt#args;                                        \
391                                                                         \
392         __alloc_workqueue_key((fmt), (flags), (max_active),             \
393                               &__key, __lock_name, ##args);             \
394 })
395 #else
396 #define alloc_workqueue(fmt, flags, max_active, args...)                \
397         __alloc_workqueue_key((fmt), (flags), (max_active),             \
398                               NULL, NULL, ##args)
399 #endif
400 
401 /**
402  * alloc_ordered_workqueue - allocate an ordered workqueue
403  * @fmt: printf format for the name of the workqueue
404  * @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
405  * @args: args for @fmt
406  *
407  * Allocate an ordered workqueue.  An ordered workqueue executes at
408  * most one work item at any given time in the queued order.  They are
409  * implemented as unbound workqueues with @max_active of one.
410  *
411  * RETURNS:
412  * Pointer to the allocated workqueue on success, %NULL on failure.
413  */
414 #define alloc_ordered_workqueue(fmt, flags, args...)                    \
415         alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | (flags), 1, ##args)
416 
417 #define create_workqueue(name)                                          \
418         alloc_workqueue("%s", WQ_MEM_RECLAIM, 1, (name))
419 #define create_freezable_workqueue(name)                                \
420         alloc_workqueue("%s", WQ_FREEZABLE | WQ_UNBOUND | WQ_MEM_RECLAIM, \
421                         1, (name))
422 #define create_singlethread_workqueue(name)                             \
423         alloc_ordered_workqueue("%s", WQ_MEM_RECLAIM, name)
424 
425 extern void destroy_workqueue(struct workqueue_struct *wq);
426 
427 struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask);
428 void free_workqueue_attrs(struct workqueue_attrs *attrs);
429 int apply_workqueue_attrs(struct workqueue_struct *wq,
430                           const struct workqueue_attrs *attrs);
431 
432 extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
433                         struct work_struct *work);
434 extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
435                         struct delayed_work *work, unsigned long delay);
436 extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
437                         struct delayed_work *dwork, unsigned long delay);
438 
439 extern void flush_workqueue(struct workqueue_struct *wq);
440 extern void drain_workqueue(struct workqueue_struct *wq);
441 extern void flush_scheduled_work(void);
442 
443 extern int schedule_on_each_cpu(work_func_t func);
444 
445 int execute_in_process_context(work_func_t fn, struct execute_work *);
446 
447 extern bool flush_work(struct work_struct *work);
448 extern bool cancel_work_sync(struct work_struct *work);
449 
450 extern bool flush_delayed_work(struct delayed_work *dwork);
451 extern bool cancel_delayed_work(struct delayed_work *dwork);
452 extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
453 
454 extern void workqueue_set_max_active(struct workqueue_struct *wq,
455                                      int max_active);
456 extern bool current_is_workqueue_rescuer(void);
457 extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
458 extern unsigned int work_busy(struct work_struct *work);
459 extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
460 extern void print_worker_info(const char *log_lvl, struct task_struct *task);
461 
462 /**
463  * queue_work - queue work on a workqueue
464  * @wq: workqueue to use
465  * @work: work to queue
466  *
467  * Returns %false if @work was already on a queue, %true otherwise.
468  *
469  * We queue the work to the CPU on which it was submitted, but if the CPU dies
470  * it can be processed by another CPU.
471  */
472 static inline bool queue_work(struct workqueue_struct *wq,
473                               struct work_struct *work)
474 {
475         return queue_work_on(WORK_CPU_UNBOUND, wq, work);
476 }
477 
478 /**
479  * queue_delayed_work - queue work on a workqueue after delay
480  * @wq: workqueue to use
481  * @dwork: delayable work to queue
482  * @delay: number of jiffies to wait before queueing
483  *
484  * Equivalent to queue_delayed_work_on() but tries to use the local CPU.
485  */
486 static inline bool queue_delayed_work(struct workqueue_struct *wq,
487                                       struct delayed_work *dwork,
488                                       unsigned long delay)
489 {
490         return queue_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
491 }
492 
493 /**
494  * mod_delayed_work - modify delay of or queue a delayed work
495  * @wq: workqueue to use
496  * @dwork: work to queue
497  * @delay: number of jiffies to wait before queueing
498  *
499  * mod_delayed_work_on() on local CPU.
500  */
501 static inline bool mod_delayed_work(struct workqueue_struct *wq,
502                                     struct delayed_work *dwork,
503                                     unsigned long delay)
504 {
505         return mod_delayed_work_on(WORK_CPU_UNBOUND, wq, dwork, delay);
506 }
507 
508 /**
509  * schedule_work_on - put work task on a specific cpu
510  * @cpu: cpu to put the work task on
511  * @work: job to be done
512  *
513  * This puts a job on a specific cpu
514  */
515 static inline bool schedule_work_on(int cpu, struct work_struct *work)
516 {
517         return queue_work_on(cpu, system_wq, work);
518 }
519 
520 /**
521  * schedule_work - put work task in global workqueue
522  * @work: job to be done
523  *
524  * Returns %false if @work was already on the kernel-global workqueue and
525  * %true otherwise.
526  *
527  * This puts a job in the kernel-global workqueue if it was not already
528  * queued and leaves it in the same position on the kernel-global
529  * workqueue otherwise.
530  */
531 static inline bool schedule_work(struct work_struct *work)
532 {
533         return queue_work(system_wq, work);
534 }
535 
536 /**
537  * schedule_delayed_work_on - queue work in global workqueue on CPU after delay
538  * @cpu: cpu to use
539  * @dwork: job to be done
540  * @delay: number of jiffies to wait
541  *
542  * After waiting for a given time this puts a job in the kernel-global
543  * workqueue on the specified CPU.
544  */
545 static inline bool schedule_delayed_work_on(int cpu, struct delayed_work *dwork,
546                                             unsigned long delay)
547 {
548         return queue_delayed_work_on(cpu, system_wq, dwork, delay);
549 }
550 
551 /**
552  * schedule_delayed_work - put work task in global workqueue after delay
553  * @dwork: job to be done
554  * @delay: number of jiffies to wait or 0 for immediate execution
555  *
556  * After waiting for a given time this puts a job in the kernel-global
557  * workqueue.
558  */
559 static inline bool schedule_delayed_work(struct delayed_work *dwork,
560                                          unsigned long delay)
561 {
562         return queue_delayed_work(system_wq, dwork, delay);
563 }
564 
565 /**
566  * keventd_up - is workqueue initialized yet?
567  */
568 static inline bool keventd_up(void)
569 {
570         return system_wq != NULL;
571 }
572 
573 #ifndef CONFIG_SMP
574 static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
575 {
576         return fn(arg);
577 }
578 #else
579 long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
580 #endif /* CONFIG_SMP */
581 
582 #ifdef CONFIG_FREEZER
583 extern void freeze_workqueues_begin(void);
584 extern bool freeze_workqueues_busy(void);
585 extern void thaw_workqueues(void);
586 #endif /* CONFIG_FREEZER */
587 
588 #ifdef CONFIG_SYSFS
589 int workqueue_sysfs_register(struct workqueue_struct *wq);
590 #else   /* CONFIG_SYSFS */
591 static inline int workqueue_sysfs_register(struct workqueue_struct *wq)
592 { return 0; }
593 #endif  /* CONFIG_SYSFS */
594 
595 #endif
596 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp