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

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

Version: ~ [ linux-5.8-rc4 ] ~ [ linux-5.7.7 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.50 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.131 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.187 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.229 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.229 ] ~ [ 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         /* 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   = WORK_OFFQ_FLAG_BASE,
 75         WORK_OFFQ_CANCELING     = (1 << __WORK_OFFQ_CANCELING),
 76 
 77         /*
 78          * When a work item is off queue, its high bits point to the last
 79          * pool it was on.  Cap at 31 bits and use the highest number to
 80          * indicate that no pool is associated.
 81          */
 82         WORK_OFFQ_FLAG_BITS     = 1,
 83         WORK_OFFQ_POOL_SHIFT    = WORK_OFFQ_FLAG_BASE + WORK_OFFQ_FLAG_BITS,
 84         WORK_OFFQ_LEFT          = BITS_PER_LONG - WORK_OFFQ_POOL_SHIFT,
 85         WORK_OFFQ_POOL_BITS     = WORK_OFFQ_LEFT <= 31 ? WORK_OFFQ_LEFT : 31,
 86         WORK_OFFQ_POOL_NONE     = (1LU << WORK_OFFQ_POOL_BITS) - 1,
 87 
 88         /* convenience constants */
 89         WORK_STRUCT_FLAG_MASK   = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
 90         WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
 91         WORK_STRUCT_NO_POOL     = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT,
 92 
 93         /* bit mask for work_busy() return values */
 94         WORK_BUSY_PENDING       = 1 << 0,
 95         WORK_BUSY_RUNNING       = 1 << 1,
 96 
 97         /* maximum string length for set_worker_desc() */
 98         WORKER_DESC_LEN         = 24,
 99 };
100 
101 struct work_struct {
102         atomic_long_t data;
103         struct list_head entry;
104         work_func_t func;
105 #ifdef CONFIG_LOCKDEP
106         struct lockdep_map lockdep_map;
107 #endif
108 };
109 
110 #define WORK_DATA_INIT()        ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL)
111 #define WORK_DATA_STATIC_INIT() \
112         ATOMIC_LONG_INIT(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC)
113 
114 struct delayed_work {
115         struct work_struct work;
116         struct timer_list timer;
117 
118         /* target workqueue and CPU ->timer uses to queue ->work */
119         struct workqueue_struct *wq;
120         int cpu;
121 };
122 
123 /*
124  * A struct for workqueue attributes.  This can be used to change
125  * attributes of an unbound workqueue.
126  *
127  * Unlike other fields, ->no_numa isn't a property of a worker_pool.  It
128  * only modifies how apply_workqueue_attrs() select pools and thus doesn't
129  * participate in pool hash calculations or equality comparisons.
130  */
131 struct workqueue_attrs {
132         int                     nice;           /* nice level */
133         cpumask_var_t           cpumask;        /* allowed CPUs */
134         bool                    no_numa;        /* disable NUMA affinity */
135 };
136 
137 static inline struct delayed_work *to_delayed_work(struct work_struct *work)
138 {
139         return container_of(work, struct delayed_work, work);
140 }
141 
142 struct execute_work {
143         struct work_struct work;
144 };
145 
146 #ifdef CONFIG_LOCKDEP
147 /*
148  * NB: because we have to copy the lockdep_map, setting _key
149  * here is required, otherwise it could get initialised to the
150  * copy of the lockdep_map!
151  */
152 #define __WORK_INIT_LOCKDEP_MAP(n, k) \
153         .lockdep_map = STATIC_LOCKDEP_MAP_INIT(n, k),
154 #else
155 #define __WORK_INIT_LOCKDEP_MAP(n, k)
156 #endif
157 
158 #define __WORK_INITIALIZER(n, f) {                                      \
159         .data = WORK_DATA_STATIC_INIT(),                                \
160         .entry  = { &(n).entry, &(n).entry },                           \
161         .func = (f),                                                    \
162         __WORK_INIT_LOCKDEP_MAP(#n, &(n))                               \
163         }
164 
165 #define __DELAYED_WORK_INITIALIZER(n, f, tflags) {                      \
166         .work = __WORK_INITIALIZER((n).work, (f)),                      \
167         .timer = __TIMER_INITIALIZER(delayed_work_timer_fn,             \
168                                      0, (unsigned long)&(n),            \
169                                      (tflags) | TIMER_IRQSAFE),         \
170         }
171 
172 #define DECLARE_WORK(n, f)                                              \
173         struct work_struct n = __WORK_INITIALIZER(n, f)
174 
175 #define DECLARE_DELAYED_WORK(n, f)                                      \
176         struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
177 
178 #define DECLARE_DEFERRABLE_WORK(n, f)                                   \
179         struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
180 
181 /*
182  * initialize a work item's function pointer
183  */
184 #define PREPARE_WORK(_work, _func)                                      \
185         do {                                                            \
186                 (_work)->func = (_func);                                \
187         } while (0)
188 
189 #define PREPARE_DELAYED_WORK(_work, _func)                              \
190         PREPARE_WORK(&(_work)->work, (_func))
191 
192 #ifdef CONFIG_DEBUG_OBJECTS_WORK
193 extern void __init_work(struct work_struct *work, int onstack);
194 extern void destroy_work_on_stack(struct work_struct *work);
195 static inline unsigned int work_static(struct work_struct *work)
196 {
197         return *work_data_bits(work) & WORK_STRUCT_STATIC;
198 }
199 #else
200 static inline void __init_work(struct work_struct *work, int onstack) { }
201 static inline void destroy_work_on_stack(struct work_struct *work) { }
202 static inline unsigned int work_static(struct work_struct *work) { return 0; }
203 #endif
204 
205 /*
206  * initialize all of a work item in one go
207  *
208  * NOTE! No point in using "atomic_long_set()": using a direct
209  * assignment of the work data initializer allows the compiler
210  * to generate better code.
211  */
212 #ifdef CONFIG_LOCKDEP
213 #define __INIT_WORK(_work, _func, _onstack)                             \
214         do {                                                            \
215                 static struct lock_class_key __key;                     \
216                                                                         \
217                 __init_work((_work), _onstack);                         \
218                 (_work)->data = (atomic_long_t) WORK_DATA_INIT();       \
219                 lockdep_init_map(&(_work)->lockdep_map, #_work, &__key, 0); \
220                 INIT_LIST_HEAD(&(_work)->entry);                        \
221                 PREPARE_WORK((_work), (_func));                         \
222         } while (0)
223 #else
224 #define __INIT_WORK(_work, _func, _onstack)                             \
225         do {                                                            \
226                 __init_work((_work), _onstack);                         \
227                 (_work)->data = (atomic_long_t) WORK_DATA_INIT();       \
228                 INIT_LIST_HEAD(&(_work)->entry);                        \
229                 PREPARE_WORK((_work), (_func));                         \
230         } while (0)
231 #endif
232 
233 #define INIT_WORK(_work, _func)                                         \
234         do {                                                            \
235                 __INIT_WORK((_work), (_func), 0);                       \
236         } while (0)
237 
238 #define INIT_WORK_ONSTACK(_work, _func)                                 \
239         do {                                                            \
240                 __INIT_WORK((_work), (_func), 1);                       \
241         } while (0)
242 
243 #define __INIT_DELAYED_WORK(_work, _func, _tflags)                      \
244         do {                                                            \
245                 INIT_WORK(&(_work)->work, (_func));                     \
246                 __setup_timer(&(_work)->timer, delayed_work_timer_fn,   \
247                               (unsigned long)(_work),                   \
248                               (_tflags) | TIMER_IRQSAFE);               \
249         } while (0)
250 
251 #define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags)              \
252         do {                                                            \
253                 INIT_WORK_ONSTACK(&(_work)->work, (_func));             \
254                 __setup_timer_on_stack(&(_work)->timer,                 \
255                                        delayed_work_timer_fn,           \
256                                        (unsigned long)(_work),          \
257                                        (_tflags) | TIMER_IRQSAFE);      \
258         } while (0)
259 
260 #define INIT_DELAYED_WORK(_work, _func)                                 \
261         __INIT_DELAYED_WORK(_work, _func, 0)
262 
263 #define INIT_DELAYED_WORK_ONSTACK(_work, _func)                         \
264         __INIT_DELAYED_WORK_ONSTACK(_work, _func, 0)
265 
266 #define INIT_DEFERRABLE_WORK(_work, _func)                              \
267         __INIT_DELAYED_WORK(_work, _func, TIMER_DEFERRABLE)
268 
269 #define INIT_DEFERRABLE_WORK_ONSTACK(_work, _func)                      \
270         __INIT_DELAYED_WORK_ONSTACK(_work, _func, TIMER_DEFERRABLE)
271 
272 /**
273  * work_pending - Find out whether a work item is currently pending
274  * @work: The work item in question
275  */
276 #define work_pending(work) \
277         test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
278 
279 /**
280  * delayed_work_pending - Find out whether a delayable work item is currently
281  * pending
282  * @work: The work item in question
283  */
284 #define delayed_work_pending(w) \
285         work_pending(&(w)->work)
286 
287 /**
288  * work_clear_pending - for internal use only, mark a work item as not pending
289  * @work: The work item in question
290  */
291 #define work_clear_pending(work) \
292         clear_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
293 
294 /*
295  * Workqueue flags and constants.  For details, please refer to
296  * Documentation/workqueue.txt.
297  */
298 enum {
299         /*
300          * All wqs are now non-reentrant making the following flag
301          * meaningless.  Will be removed.
302          */
303         WQ_NON_REENTRANT        = 1 << 0, /* DEPRECATED */
304 
305         WQ_UNBOUND              = 1 << 1, /* not bound to any cpu */
306         WQ_FREEZABLE            = 1 << 2, /* freeze during suspend */
307         WQ_MEM_RECLAIM          = 1 << 3, /* may be used for memory reclaim */
308         WQ_HIGHPRI              = 1 << 4, /* high priority */
309         WQ_CPU_INTENSIVE        = 1 << 5, /* cpu instensive workqueue */
310         WQ_SYSFS                = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
311 
312         /*
313          * Per-cpu workqueues are generally preferred because they tend to
314          * show better performance thanks to cache locality.  Per-cpu
315          * workqueues exclude the scheduler from choosing the CPU to
316          * execute the worker threads, which has an unfortunate side effect
317          * of increasing power consumption.
318          *
319          * The scheduler considers a CPU idle if it doesn't have any task
320          * to execute and tries to keep idle cores idle to conserve power;
321          * however, for example, a per-cpu work item scheduled from an
322          * interrupt handler on an idle CPU will force the scheduler to
323          * excute the work item on that CPU breaking the idleness, which in
324          * turn may lead to more scheduling choices which are sub-optimal
325          * in terms of power consumption.
326          *
327          * Workqueues marked with WQ_POWER_EFFICIENT are per-cpu by default
328          * but become unbound if workqueue.power_efficient kernel param is
329          * specified.  Per-cpu workqueues which are identified to
330          * contribute significantly to power-consumption are identified and
331          * marked with this flag and enabling the power_efficient mode
332          * leads to noticeable power saving at the cost of small
333          * performance disadvantage.
334          *
335          * http://thread.gmane.org/gmane.linux.kernel/1480396
336          */
337         WQ_POWER_EFFICIENT      = 1 << 7,
338 
339         __WQ_DRAINING           = 1 << 16, /* internal: workqueue is draining */
340         __WQ_ORDERED            = 1 << 17, /* internal: workqueue is ordered */
341 
342         WQ_MAX_ACTIVE           = 512,    /* I like 512, better ideas? */
343         WQ_MAX_UNBOUND_PER_CPU  = 4,      /* 4 * #cpus for unbound wq */
344         WQ_DFL_ACTIVE           = WQ_MAX_ACTIVE / 2,
345 };
346 
347 /* unbound wq's aren't per-cpu, scale max_active according to #cpus */
348 #define WQ_UNBOUND_MAX_ACTIVE   \
349         max_t(int, WQ_MAX_ACTIVE, num_possible_cpus() * WQ_MAX_UNBOUND_PER_CPU)
350 
351 /*
352  * System-wide workqueues which are always present.
353  *
354  * system_wq is the one used by schedule[_delayed]_work[_on]().
355  * Multi-CPU multi-threaded.  There are users which expect relatively
356  * short queue flush time.  Don't queue works which can run for too
357  * long.
358  *
359  * system_long_wq is similar to system_wq but may host long running
360  * works.  Queue flushing might take relatively long.
361  *
362  * system_unbound_wq is unbound workqueue.  Workers are not bound to
363  * any specific CPU, not concurrency managed, and all queued works are
364  * executed immediately as long as max_active limit is not reached and
365  * resources are available.
366  *
367  * system_freezable_wq is equivalent to system_wq except that it's
368  * freezable.
369  *
370  * *_power_efficient_wq are inclined towards saving power and converted
371  * into WQ_UNBOUND variants if 'wq_power_efficient' is enabled; otherwise,
372  * they are same as their non-power-efficient counterparts - e.g.
373  * system_power_efficient_wq is identical to system_wq if
374  * 'wq_power_efficient' is disabled.  See WQ_POWER_EFFICIENT for more info.
375  */
376 extern struct workqueue_struct *system_wq;
377 extern struct workqueue_struct *system_long_wq;
378 extern struct workqueue_struct *system_unbound_wq;
379 extern struct workqueue_struct *system_freezable_wq;
380 extern struct workqueue_struct *system_power_efficient_wq;
381 extern struct workqueue_struct *system_freezable_power_efficient_wq;
382 
383 static inline struct workqueue_struct * __deprecated __system_nrt_wq(void)
384 {
385         return system_wq;
386 }
387 
388 static 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 
397 extern 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 
461 extern void destroy_workqueue(struct workqueue_struct *wq);
462 
463 struct workqueue_attrs *alloc_workqueue_attrs(gfp_t gfp_mask);
464 void free_workqueue_attrs(struct workqueue_attrs *attrs);
465 int apply_workqueue_attrs(struct workqueue_struct *wq,
466                           const struct workqueue_attrs *attrs);
467 
468 extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
469                         struct work_struct *work);
470 extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
471                         struct delayed_work *work, unsigned long delay);
472 extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
473                         struct delayed_work *dwork, unsigned long delay);
474 
475 extern void flush_workqueue(struct workqueue_struct *wq);
476 extern void drain_workqueue(struct workqueue_struct *wq);
477 extern void flush_scheduled_work(void);
478 
479 extern int schedule_on_each_cpu(work_func_t func);
480 
481 int execute_in_process_context(work_func_t fn, struct execute_work *);
482 
483 extern bool flush_work(struct work_struct *work);
484 extern bool cancel_work_sync(struct work_struct *work);
485 
486 extern bool flush_delayed_work(struct delayed_work *dwork);
487 extern bool cancel_delayed_work(struct delayed_work *dwork);
488 extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
489 
490 extern void workqueue_set_max_active(struct workqueue_struct *wq,
491                                      int max_active);
492 extern bool current_is_workqueue_rescuer(void);
493 extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
494 extern unsigned int work_busy(struct work_struct *work);
495 extern __printf(1, 2) void set_worker_desc(const char *fmt, ...);
496 extern 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  */
508 static 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  */
522 static 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  */
537 static 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  */
551 static 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  */
567 static 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  */
581 static 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  */
595 static 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  */
604 static 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  */
614 static 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 */
625 static 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 */
631 static inline bool __deprecated flush_delayed_work_sync(struct delayed_work *dwork)
632 {
633         return flush_delayed_work(dwork);
634 }
635 
636 #ifndef CONFIG_SMP
637 static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
638 {
639         return fn(arg);
640 }
641 #else
642 long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
643 #endif /* CONFIG_SMP */
644 
645 #ifdef CONFIG_FREEZER
646 extern void freeze_workqueues_begin(void);
647 extern bool freeze_workqueues_busy(void);
648 extern void thaw_workqueues(void);
649 #endif /* CONFIG_FREEZER */
650 
651 #ifdef CONFIG_SYSFS
652 int workqueue_sysfs_register(struct workqueue_struct *wq);
653 #else   /* CONFIG_SYSFS */
654 static inline int workqueue_sysfs_register(struct workqueue_struct *wq)
655 { return 0; }
656 #endif  /* CONFIG_SYSFS */
657 
658 #endif
659 

~ [ 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