License cleanup: add SPDX GPL-2.0 license identifier to files with no license
Many source files in the tree are missing licensing information, which
makes it harder for compliance tools to determine the correct license.
By default all files without license information are under the default
license of the kernel, which is GPL version 2.
Update the files which contain no license information with the 'GPL-2.0'
SPDX license identifier. The SPDX identifier is a legally binding
shorthand, which can be used instead of the full boiler plate text.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne.
How this work was done:
Patches were generated and checked against linux-4.14-rc6 for a subset of
the use cases:
- file had no licensing information it it.
- file was a */uapi/* one with no licensing information in it,
- file was a */uapi/* one with existing licensing information,
Further patches will be generated in subsequent months to fix up cases
where non-standard license headers were used, and references to license
had to be inferred by heuristics based on keywords.
The analysis to determine which SPDX License Identifier to be applied to
a file was done in a spreadsheet of side by side results from of the
output of two independent scanners (ScanCode & Windriver) producing SPDX
tag:value files created by Philippe Ombredanne. Philippe prepared the
base worksheet, and did an initial spot review of a few 1000 files.
The 4.13 kernel was the starting point of the analysis with 60,537 files
assessed. Kate Stewart did a file by file comparison of the scanner
results in the spreadsheet to determine which SPDX license identifier(s)
to be applied to the file. She confirmed any determination that was not
immediately clear with lawyers working with the Linux Foundation.
Criteria used to select files for SPDX license identifier tagging was:
- Files considered eligible had to be source code files.
- Make and config files were included as candidates if they contained >5
lines of source
- File already had some variant of a license header in it (even if <5
lines).
All documentation files were explicitly excluded.
The following heuristics were used to determine which SPDX license
identifiers to apply.
- when both scanners couldn't find any license traces, file was
considered to have no license information in it, and the top level
COPYING file license applied.
For non */uapi/* files that summary was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 11139
and resulted in the first patch in this series.
If that file was a */uapi/* path one, it was "GPL-2.0 WITH
Linux-syscall-note" otherwise it was "GPL-2.0". Results of that was:
SPDX license identifier # files
---------------------------------------------------|-------
GPL-2.0 WITH Linux-syscall-note 930
and resulted in the second patch in this series.
- if a file had some form of licensing information in it, and was one
of the */uapi/* ones, it was denoted with the Linux-syscall-note if
any GPL family license was found in the file or had no licensing in
it (per prior point). Results summary:
SPDX license identifier # files
---------------------------------------------------|------
GPL-2.0 WITH Linux-syscall-note 270
GPL-2.0+ WITH Linux-syscall-note 169
((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) 21
((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) 17
LGPL-2.1+ WITH Linux-syscall-note 15
GPL-1.0+ WITH Linux-syscall-note 14
((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) 5
LGPL-2.0+ WITH Linux-syscall-note 4
LGPL-2.1 WITH Linux-syscall-note 3
((GPL-2.0 WITH Linux-syscall-note) OR MIT) 3
((GPL-2.0 WITH Linux-syscall-note) AND MIT) 1
and that resulted in the third patch in this series.
- when the two scanners agreed on the detected license(s), that became
the concluded license(s).
- when there was disagreement between the two scanners (one detected a
license but the other didn't, or they both detected different
licenses) a manual inspection of the file occurred.
- In most cases a manual inspection of the information in the file
resulted in a clear resolution of the license that should apply (and
which scanner probably needed to revisit its heuristics).
- When it was not immediately clear, the license identifier was
confirmed with lawyers working with the Linux Foundation.
- If there was any question as to the appropriate license identifier,
the file was flagged for further research and to be revisited later
in time.
In total, over 70 hours of logged manual review was done on the
spreadsheet to determine the SPDX license identifiers to apply to the
source files by Kate, Philippe, Thomas and, in some cases, confirmation
by lawyers working with the Linux Foundation.
Kate also obtained a third independent scan of the 4.13 code base from
FOSSology, and compared selected files where the other two scanners
disagreed against that SPDX file, to see if there was new insights. The
Windriver scanner is based on an older version of FOSSology in part, so
they are related.
Thomas did random spot checks in about 500 files from the spreadsheets
for the uapi headers and agreed with SPDX license identifier in the
files he inspected. For the non-uapi files Thomas did random spot checks
in about 15000 files.
In initial set of patches against 4.14-rc6, 3 files were found to have
copy/paste license identifier errors, and have been fixed to reflect the
correct identifier.
Additionally Philippe spent 10 hours this week doing a detailed manual
inspection and review of the 12,461 patched files from the initial patch
version early this week with:
- a full scancode scan run, collecting the matched texts, detected
license ids and scores
- reviewing anything where there was a license detected (about 500+
files) to ensure that the applied SPDX license was correct
- reviewing anything where there was no detection but the patch license
was not GPL-2.0 WITH Linux-syscall-note to ensure that the applied
SPDX license was correct
This produced a worksheet with 20 files needing minor correction. This
worksheet was then exported into 3 different .csv files for the
different types of files to be modified.
These .csv files were then reviewed by Greg. Thomas wrote a script to
parse the csv files and add the proper SPDX tag to the file, in the
format that the file expected. This script was further refined by Greg
based on the output to detect more types of files automatically and to
distinguish between header and source .c files (which need different
comment types.) Finally Greg ran the script using the .csv files to
generate the patches.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
2017-11-01 14:07:57 +00:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2005-04-16 22:20:36 +00: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 06:39:55 +00:00
|
|
|
#include <linux/lockdep.h>
|
2010-06-29 08:07:13 +00:00
|
|
|
#include <linux/threads.h>
|
2011-07-26 23:09:06 +00:00
|
|
|
#include <linux/atomic.h>
|
2013-03-12 18:30:00 +00:00
|
|
|
#include <linux/cpumask.h>
|
2018-03-14 19:45:13 +00:00
|
|
|
#include <linux/rcupdate.h>
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
struct workqueue_struct;
|
|
|
|
|
2006-11-22 14:55:48 +00:00
|
|
|
struct work_struct;
|
|
|
|
typedef void (*work_func_t)(struct work_struct *work);
|
2017-10-04 23:27:07 +00:00
|
|
|
void delayed_work_timer_fn(struct timer_list *t);
|
2006-11-22 14:54:45 +00:00
|
|
|
|
2006-12-16 17:53:50 +00: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 08:07:10 +00:00
|
|
|
enum {
|
|
|
|
WORK_STRUCT_PENDING_BIT = 0, /* work item is pending execution */
|
2010-08-25 08:33:56 +00:00
|
|
|
WORK_STRUCT_DELAYED_BIT = 1, /* work item is delayed */
|
2013-02-14 03:29:12 +00:00
|
|
|
WORK_STRUCT_PWQ_BIT = 2, /* data points to pwq */
|
2010-08-25 08:33:56 +00:00
|
|
|
WORK_STRUCT_LINKED_BIT = 3, /* next work is linked to this one */
|
2010-06-29 08:07:10 +00:00
|
|
|
#ifdef CONFIG_DEBUG_OBJECTS_WORK
|
2010-08-25 08:33:56 +00:00
|
|
|
WORK_STRUCT_STATIC_BIT = 4, /* static initializer (debugobjects) */
|
|
|
|
WORK_STRUCT_COLOR_SHIFT = 5, /* color for workqueue flushing */
|
2010-06-29 08:07:11 +00:00
|
|
|
#else
|
2010-08-25 08:33:56 +00:00
|
|
|
WORK_STRUCT_COLOR_SHIFT = 4, /* color for workqueue flushing */
|
2010-06-29 08:07:10 +00:00
|
|
|
#endif
|
|
|
|
|
2010-06-29 08:07:11 +00:00
|
|
|
WORK_STRUCT_COLOR_BITS = 4,
|
|
|
|
|
2010-06-29 08:07:10 +00:00
|
|
|
WORK_STRUCT_PENDING = 1 << WORK_STRUCT_PENDING_BIT,
|
2010-08-25 08:33:56 +00:00
|
|
|
WORK_STRUCT_DELAYED = 1 << WORK_STRUCT_DELAYED_BIT,
|
2013-02-14 03:29:12 +00:00
|
|
|
WORK_STRUCT_PWQ = 1 << WORK_STRUCT_PWQ_BIT,
|
2010-06-29 08:07:12 +00:00
|
|
|
WORK_STRUCT_LINKED = 1 << WORK_STRUCT_LINKED_BIT,
|
2010-06-29 08:07:10 +00:00
|
|
|
#ifdef CONFIG_DEBUG_OBJECTS_WORK
|
|
|
|
WORK_STRUCT_STATIC = 1 << WORK_STRUCT_STATIC_BIT,
|
|
|
|
#else
|
|
|
|
WORK_STRUCT_STATIC = 0,
|
|
|
|
#endif
|
|
|
|
|
2010-06-29 08:07:11 +00: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,
|
|
|
|
|
2014-05-22 08:43:44 +00:00
|
|
|
/* not bound to any CPU, prefer the local CPU */
|
2010-07-02 08:03:51 +00:00
|
|
|
WORK_CPU_UNBOUND = NR_CPUS,
|
2010-07-02 08:03:51 +00:00
|
|
|
|
2010-06-29 08:07:11 +00:00
|
|
|
/*
|
2020-06-01 08:44:39 +00:00
|
|
|
* Reserve 8 bits off of pwq pointer w/ debugobjects turned off.
|
2013-02-14 03:29:12 +00:00
|
|
|
* This makes pwqs aligned to 256 bytes and allows 15 workqueue
|
|
|
|
* flush colors.
|
2010-06-29 08:07:11 +00:00
|
|
|
*/
|
|
|
|
WORK_STRUCT_FLAG_BITS = WORK_STRUCT_COLOR_SHIFT +
|
|
|
|
WORK_STRUCT_COLOR_BITS,
|
|
|
|
|
2013-02-14 03:29:12 +00:00
|
|
|
/* data contains off-queue information when !WORK_STRUCT_PWQ */
|
2013-02-19 20:17:01 +00:00
|
|
|
WORK_OFFQ_FLAG_BASE = WORK_STRUCT_COLOR_SHIFT,
|
2012-08-03 17:30:46 +00:00
|
|
|
|
2015-03-05 13:04:13 +00:00
|
|
|
__WORK_OFFQ_CANCELING = WORK_OFFQ_FLAG_BASE,
|
|
|
|
WORK_OFFQ_CANCELING = (1 << __WORK_OFFQ_CANCELING),
|
2012-08-03 17:30:46 +00:00
|
|
|
|
2013-01-24 19:01:33 +00:00
|
|
|
/*
|
|
|
|
* When a work item is off queue, its high bits point to the last
|
2013-01-24 19:01:33 +00:00
|
|
|
* pool it was on. Cap at 31 bits and use the highest number to
|
|
|
|
* indicate that no pool is associated.
|
2013-01-24 19:01:33 +00:00
|
|
|
*/
|
2012-08-03 17:30:46 +00:00
|
|
|
WORK_OFFQ_FLAG_BITS = 1,
|
2013-01-24 19:01:33 +00: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-03 17:30:46 +00:00
|
|
|
|
|
|
|
/* convenience constants */
|
2010-06-29 08:07:11 +00:00
|
|
|
WORK_STRUCT_FLAG_MASK = (1UL << WORK_STRUCT_FLAG_BITS) - 1,
|
2010-06-29 08:07:10 +00:00
|
|
|
WORK_STRUCT_WQ_DATA_MASK = ~WORK_STRUCT_FLAG_MASK,
|
2013-01-24 19:01:33 +00:00
|
|
|
WORK_STRUCT_NO_POOL = (unsigned long)WORK_OFFQ_POOL_NONE << WORK_OFFQ_POOL_SHIFT,
|
2010-06-29 08:07:14 +00:00
|
|
|
|
|
|
|
/* bit mask for work_busy() return values */
|
|
|
|
WORK_BUSY_PENDING = 1 << 0,
|
|
|
|
WORK_BUSY_RUNNING = 1 << 1,
|
2013-04-30 22:27:22 +00:00
|
|
|
|
|
|
|
/* maximum string length for set_worker_desc() */
|
|
|
|
WORKER_DESC_LEN = 24,
|
2010-06-29 08:07:10 +00:00
|
|
|
};
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
struct work_struct {
|
2006-12-16 17:53:50 +00:00
|
|
|
atomic_long_t data;
|
2005-04-16 22:20:36 +00:00
|
|
|
struct list_head entry;
|
2006-11-22 14:54:45 +00:00
|
|
|
work_func_t func;
|
2007-10-19 06:39:55 +00:00
|
|
|
#ifdef CONFIG_LOCKDEP
|
|
|
|
struct lockdep_map lockdep_map;
|
|
|
|
#endif
|
2006-11-22 14:54:01 +00:00
|
|
|
};
|
|
|
|
|
2017-02-01 17:01:17 +00:00
|
|
|
#define WORK_DATA_INIT() ATOMIC_LONG_INIT((unsigned long)WORK_STRUCT_NO_POOL)
|
2010-06-29 08:07:13 +00:00
|
|
|
#define WORK_DATA_STATIC_INIT() \
|
2017-02-01 17:01:17 +00:00
|
|
|
ATOMIC_LONG_INIT((unsigned long)(WORK_STRUCT_NO_POOL | WORK_STRUCT_STATIC))
|
2006-12-16 17:53:50 +00:00
|
|
|
|
2006-11-22 14:54:01 +00:00
|
|
|
struct delayed_work {
|
|
|
|
struct work_struct work;
|
2005-04-16 22:20:36 +00:00
|
|
|
struct timer_list timer;
|
2013-02-07 02:04:53 +00:00
|
|
|
|
|
|
|
/* target workqueue and CPU ->timer uses to queue ->work */
|
|
|
|
struct workqueue_struct *wq;
|
2012-08-08 16:38:42 +00:00
|
|
|
int cpu;
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
2018-03-14 19:45:13 +00:00
|
|
|
struct rcu_work {
|
|
|
|
struct work_struct work;
|
|
|
|
struct rcu_head rcu;
|
|
|
|
|
|
|
|
/* target workqueue ->rcu uses to queue ->work */
|
|
|
|
struct workqueue_struct *wq;
|
|
|
|
};
|
|
|
|
|
2016-10-28 08:14:09 +00:00
|
|
|
/**
|
|
|
|
* struct workqueue_attrs - A struct for workqueue attributes.
|
2013-04-01 18:23:38 +00:00
|
|
|
*
|
2016-10-28 08:14:09 +00:00
|
|
|
* This can be used to change attributes of an unbound workqueue.
|
2013-03-12 18:30:00 +00:00
|
|
|
*/
|
|
|
|
struct workqueue_attrs {
|
2016-10-28 08:14:09 +00:00
|
|
|
/**
|
|
|
|
* @nice: nice level
|
|
|
|
*/
|
|
|
|
int nice;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @cpumask: allowed CPUs
|
|
|
|
*/
|
|
|
|
cpumask_var_t cpumask;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @no_numa: disable NUMA affinity
|
|
|
|
*
|
|
|
|
* Unlike other fields, ``no_numa`` isn't a property of a worker_pool. It
|
|
|
|
* only modifies how :c:func:`apply_workqueue_attrs` select pools and thus
|
|
|
|
* doesn't participate in pool hash calculations or equality comparisons.
|
|
|
|
*/
|
|
|
|
bool no_numa;
|
2013-03-12 18:30:00 +00:00
|
|
|
};
|
|
|
|
|
2009-04-02 23:56:54 +00:00
|
|
|
static inline struct delayed_work *to_delayed_work(struct work_struct *work)
|
|
|
|
{
|
|
|
|
return container_of(work, struct delayed_work, work);
|
|
|
|
}
|
|
|
|
|
2018-03-14 19:45:13 +00:00
|
|
|
static inline struct rcu_work *to_rcu_work(struct work_struct *work)
|
|
|
|
{
|
|
|
|
return container_of(work, struct rcu_work, work);
|
|
|
|
}
|
|
|
|
|
2006-02-23 18:43:43 +00:00
|
|
|
struct execute_work {
|
|
|
|
struct work_struct work;
|
|
|
|
};
|
|
|
|
|
2007-10-19 06:39:55 +00: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-21 20:18:23 +00: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 14:55:48 +00:00
|
|
|
}
|
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define __DELAYED_WORK_INITIALIZER(n, f, tflags) { \
|
2012-08-21 20:18:23 +00:00
|
|
|
.work = __WORK_INITIALIZER((n).work, (f)), \
|
2017-10-23 07:40:42 +00:00
|
|
|
.timer = __TIMER_INITIALIZER(delayed_work_timer_fn,\
|
2012-08-21 20:18:24 +00:00
|
|
|
(tflags) | TIMER_IRQSAFE), \
|
2010-10-20 22:57:33 +00:00
|
|
|
}
|
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define DECLARE_WORK(n, f) \
|
2006-11-22 14:55:48 +00:00
|
|
|
struct work_struct n = __WORK_INITIALIZER(n, f)
|
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define DECLARE_DELAYED_WORK(n, f) \
|
2012-08-21 20:18:23 +00:00
|
|
|
struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, 0)
|
2006-11-22 14:55:48 +00:00
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define DECLARE_DEFERRABLE_WORK(n, f) \
|
2012-08-21 20:18:23 +00:00
|
|
|
struct delayed_work n = __DELAYED_WORK_INITIALIZER(n, f, TIMER_DEFERRABLE)
|
2010-10-20 22:57:33 +00:00
|
|
|
|
2009-11-15 16:09:48 +00: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);
|
2014-03-23 14:20:44 +00:00
|
|
|
extern void destroy_delayed_work_on_stack(struct delayed_work *work);
|
2010-06-29 08:07:10 +00:00
|
|
|
static inline unsigned int work_static(struct work_struct *work)
|
|
|
|
{
|
2010-06-29 08:07:10 +00:00
|
|
|
return *work_data_bits(work) & WORK_STRUCT_STATIC;
|
2010-06-29 08:07:10 +00:00
|
|
|
}
|
2009-11-15 16:09:48 +00:00
|
|
|
#else
|
|
|
|
static inline void __init_work(struct work_struct *work, int onstack) { }
|
|
|
|
static inline void destroy_work_on_stack(struct work_struct *work) { }
|
2014-03-23 14:20:44 +00:00
|
|
|
static inline void destroy_delayed_work_on_stack(struct delayed_work *work) { }
|
2010-06-29 08:07:10 +00:00
|
|
|
static inline unsigned int work_static(struct work_struct *work) { return 0; }
|
2009-11-15 16:09:48 +00:00
|
|
|
#endif
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/*
|
2006-11-22 14:54:01 +00:00
|
|
|
* initialize all of a work item in one go
|
2006-12-16 17:53:50 +00:00
|
|
|
*
|
2009-06-23 10:09:29 +00:00
|
|
|
* NOTE! No point in using "atomic_long_set()": using a direct
|
2006-12-16 17:53:50 +00:00
|
|
|
* assignment of the work data initializer allows the compiler
|
|
|
|
* to generate better code.
|
2005-04-16 22:20:36 +00:00
|
|
|
*/
|
2007-10-19 06:39:55 +00:00
|
|
|
#ifdef CONFIG_LOCKDEP
|
2009-11-15 16:09:48 +00:00
|
|
|
#define __INIT_WORK(_work, _func, _onstack) \
|
2006-11-22 14:55:48 +00:00
|
|
|
do { \
|
2007-10-19 06:39:55 +00:00
|
|
|
static struct lock_class_key __key; \
|
|
|
|
\
|
2009-11-15 16:09:48 +00:00
|
|
|
__init_work((_work), _onstack); \
|
2007-05-09 09:34:19 +00:00
|
|
|
(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
|
2017-10-25 08:56:04 +00:00
|
|
|
lockdep_init_map(&(_work)->lockdep_map, "(work_completion)"#_work, &__key, 0); \
|
2006-11-22 14:55:48 +00:00
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
2014-03-07 15:24:50 +00:00
|
|
|
(_work)->func = (_func); \
|
2006-11-22 14:55:48 +00:00
|
|
|
} while (0)
|
2007-10-19 06:39:55 +00:00
|
|
|
#else
|
2009-11-15 16:09:48 +00:00
|
|
|
#define __INIT_WORK(_work, _func, _onstack) \
|
2007-10-19 06:39:55 +00:00
|
|
|
do { \
|
2009-11-15 16:09:48 +00:00
|
|
|
__init_work((_work), _onstack); \
|
2007-10-19 06:39:55 +00:00
|
|
|
(_work)->data = (atomic_long_t) WORK_DATA_INIT(); \
|
|
|
|
INIT_LIST_HEAD(&(_work)->entry); \
|
2014-03-07 15:24:50 +00:00
|
|
|
(_work)->func = (_func); \
|
2007-10-19 06:39:55 +00:00
|
|
|
} while (0)
|
|
|
|
#endif
|
2006-11-22 14:55:48 +00:00
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define INIT_WORK(_work, _func) \
|
2015-01-06 16:29:29 +00:00
|
|
|
__INIT_WORK((_work), (_func), 0)
|
2009-11-15 16:09:48 +00:00
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define INIT_WORK_ONSTACK(_work, _func) \
|
2015-01-06 16:29:29 +00:00
|
|
|
__INIT_WORK((_work), (_func), 1)
|
2009-11-15 16:09:48 +00:00
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define __INIT_DELAYED_WORK(_work, _func, _tflags) \
|
2012-08-21 20:18:23 +00:00
|
|
|
do { \
|
|
|
|
INIT_WORK(&(_work)->work, (_func)); \
|
2017-10-23 01:48:43 +00:00
|
|
|
__init_timer(&(_work)->timer, \
|
|
|
|
delayed_work_timer_fn, \
|
|
|
|
(_tflags) | TIMER_IRQSAFE); \
|
2006-11-22 14:54:01 +00:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define __INIT_DELAYED_WORK_ONSTACK(_work, _func, _tflags) \
|
2012-08-21 20:18:23 +00:00
|
|
|
do { \
|
|
|
|
INIT_WORK_ONSTACK(&(_work)->work, (_func)); \
|
2017-10-23 01:48:43 +00:00
|
|
|
__init_timer_on_stack(&(_work)->timer, \
|
|
|
|
delayed_work_timer_fn, \
|
|
|
|
(_tflags) | TIMER_IRQSAFE); \
|
2009-01-12 11:52:23 +00:00
|
|
|
} while (0)
|
|
|
|
|
2012-08-21 20:18:23 +00: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-21 20:18:23 +00:00
|
|
|
#define INIT_DEFERRABLE_WORK(_work, _func) \
|
2012-08-21 20:18:23 +00: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 07:27:47 +00:00
|
|
|
|
2018-03-14 19:45:13 +00:00
|
|
|
#define INIT_RCU_WORK(_work, _func) \
|
|
|
|
INIT_WORK(&(_work)->work, (_func))
|
|
|
|
|
|
|
|
#define INIT_RCU_WORK_ONSTACK(_work, _func) \
|
|
|
|
INIT_WORK_ONSTACK(&(_work)->work, (_func))
|
|
|
|
|
2006-11-22 14:54:49 +00: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 08:07:10 +00:00
|
|
|
test_bit(WORK_STRUCT_PENDING_BIT, work_data_bits(work))
|
2006-11-22 14:54:49 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* delayed_work_pending - Find out whether a delayable work item is currently
|
|
|
|
* pending
|
2015-08-13 23:52:02 +00:00
|
|
|
* @w: The work item in question
|
2006-11-22 14:54:49 +00:00
|
|
|
*/
|
2006-12-15 22:13:51 +00:00
|
|
|
#define delayed_work_pending(w) \
|
|
|
|
work_pending(&(w)->work)
|
2006-11-22 14:54:49 +00:00
|
|
|
|
2010-09-10 14:51:36 +00:00
|
|
|
/*
|
|
|
|
* Workqueue flags and constants. For details, please refer to
|
2016-10-28 08:14:09 +00:00
|
|
|
* Documentation/core-api/workqueue.rst.
|
2010-09-10 14:51:36 +00:00
|
|
|
*/
|
2010-06-29 08:07:10 +00:00
|
|
|
enum {
|
2010-07-02 08:03:51 +00:00
|
|
|
WQ_UNBOUND = 1 << 1, /* not bound to any cpu */
|
2011-02-16 08:25:31 +00:00
|
|
|
WQ_FREEZABLE = 1 << 2, /* freeze during suspend */
|
2010-10-11 13:12:27 +00:00
|
|
|
WQ_MEM_RECLAIM = 1 << 3, /* may be used for memory reclaim */
|
2010-06-29 08:07:14 +00:00
|
|
|
WQ_HIGHPRI = 1 << 4, /* high priority */
|
2014-03-24 20:37:02 +00:00
|
|
|
WQ_CPU_INTENSIVE = 1 << 5, /* cpu intensive workqueue */
|
2013-03-12 18:30:05 +00:00
|
|
|
WQ_SYSFS = 1 << 6, /* visible in sysfs, see wq_sysfs_register() */
|
2010-06-29 08:07:14 +00:00
|
|
|
|
2013-04-08 11:15:40 +00: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-12 18:30:04 +00:00
|
|
|
__WQ_DRAINING = 1 << 16, /* internal: workqueue is draining */
|
2013-03-12 18:30:04 +00:00
|
|
|
__WQ_ORDERED = 1 << 17, /* internal: workqueue is ordered */
|
2016-01-29 10:59:46 +00:00
|
|
|
__WQ_LEGACY = 1 << 18, /* internal: create*_workqueue() */
|
2017-09-03 00:18:41 +00:00
|
|
|
__WQ_ORDERED_EXPLICIT = 1 << 19, /* internal: alloc_ordered_workqueue() */
|
2010-08-24 12:22:47 +00:00
|
|
|
|
2010-06-29 08:07:14 +00:00
|
|
|
WQ_MAX_ACTIVE = 512, /* I like 512, better ideas? */
|
2010-07-02 08:03:51 +00:00
|
|
|
WQ_MAX_UNBOUND_PER_CPU = 4, /* 4 * #cpus for unbound wq */
|
2010-06-29 08:07:14 +00:00
|
|
|
WQ_DFL_ACTIVE = WQ_MAX_ACTIVE / 2,
|
2010-06-29 08:07:10 +00:00
|
|
|
};
|
2006-11-22 14:54:01 +00:00
|
|
|
|
2010-07-02 08:03:51 +00: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 14:55:48 +00:00
|
|
|
|
2010-06-29 08:07:14 +00: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.
|
|
|
|
*
|
2014-05-22 08:42:41 +00:00
|
|
|
* system_highpri_wq is similar to system_wq but for work items which
|
|
|
|
* require WQ_HIGHPRI.
|
|
|
|
*
|
2010-06-29 08:07:14 +00:00
|
|
|
* system_long_wq is similar to system_wq but may host long running
|
|
|
|
* works. Queue flushing might take relatively long.
|
|
|
|
*
|
2010-07-02 08:03:51 +00: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 09:39:03 +00:00
|
|
|
*
|
2011-02-21 08:52:50 +00:00
|
|
|
* system_freezable_wq is equivalent to system_wq except that it's
|
|
|
|
* freezable.
|
2013-04-24 11:42:54 +00: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 08:07:14 +00:00
|
|
|
*/
|
|
|
|
extern struct workqueue_struct *system_wq;
|
2014-05-22 08:42:41 +00:00
|
|
|
extern struct workqueue_struct *system_highpri_wq;
|
2010-06-29 08:07:14 +00:00
|
|
|
extern struct workqueue_struct *system_long_wq;
|
2010-07-02 08:03:51 +00:00
|
|
|
extern struct workqueue_struct *system_unbound_wq;
|
2011-02-21 08:52:50 +00:00
|
|
|
extern struct workqueue_struct *system_freezable_wq;
|
2013-04-24 11:42:54 +00:00
|
|
|
extern struct workqueue_struct *system_power_efficient_wq;
|
|
|
|
extern struct workqueue_struct *system_freezable_power_efficient_wq;
|
2012-08-20 21:51:23 +00:00
|
|
|
|
2012-01-10 23:11:35 +00: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
|
2019-02-14 23:00:54 +00:00
|
|
|
* remaining args: args for @fmt
|
2012-01-10 23:11:35 +00:00
|
|
|
*
|
|
|
|
* Allocate a workqueue with the specified parameters. For detailed
|
2016-10-28 08:14:09 +00:00
|
|
|
* information on WQ_* flags, please refer to
|
|
|
|
* Documentation/core-api/workqueue.rst.
|
2012-01-10 23:11:35 +00:00
|
|
|
*
|
|
|
|
* RETURNS:
|
|
|
|
* Pointer to the allocated workqueue on success, %NULL on failure.
|
|
|
|
*/
|
2019-02-14 23:00:54 +00:00
|
|
|
struct workqueue_struct *alloc_workqueue(const char *fmt,
|
|
|
|
unsigned int flags,
|
|
|
|
int max_active, ...);
|
2007-10-19 06:39:55 +00:00
|
|
|
|
2010-09-16 08:17:35 +00:00
|
|
|
/**
|
|
|
|
* alloc_ordered_workqueue - allocate an ordered workqueue
|
2012-01-10 23:11:35 +00:00
|
|
|
* @fmt: printf format for the name of the workqueue
|
2011-02-16 08:25:31 +00:00
|
|
|
* @flags: WQ_* flags (only WQ_FREEZABLE and WQ_MEM_RECLAIM are meaningful)
|
2015-08-13 23:52:02 +00:00
|
|
|
* @args...: args for @fmt
|
2010-09-16 08:17:35 +00: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-21 20:18:23 +00:00
|
|
|
#define alloc_ordered_workqueue(fmt, flags, args...) \
|
2017-07-23 12:36:15 +00:00
|
|
|
alloc_workqueue(fmt, WQ_UNBOUND | __WQ_ORDERED | \
|
|
|
|
__WQ_ORDERED_EXPLICIT | (flags), 1, ##args)
|
2010-09-16 08:17:35 +00:00
|
|
|
|
2012-08-21 20:18:23 +00:00
|
|
|
#define create_workqueue(name) \
|
2016-01-29 10:59:46 +00:00
|
|
|
alloc_workqueue("%s", __WQ_LEGACY | WQ_MEM_RECLAIM, 1, (name))
|
2012-08-21 20:18:23 +00:00
|
|
|
#define create_freezable_workqueue(name) \
|
2016-01-29 10:59:46 +00:00
|
|
|
alloc_workqueue("%s", __WQ_LEGACY | WQ_FREEZABLE | WQ_UNBOUND | \
|
|
|
|
WQ_MEM_RECLAIM, 1, (name))
|
2012-08-21 20:18:23 +00:00
|
|
|
#define create_singlethread_workqueue(name) \
|
2016-01-29 10:59:46 +00:00
|
|
|
alloc_ordered_workqueue("%s", __WQ_LEGACY | WQ_MEM_RECLAIM, name)
|
2005-04-16 22:20:36 +00:00
|
|
|
|
|
|
|
extern void destroy_workqueue(struct workqueue_struct *wq);
|
|
|
|
|
2019-09-06 01:40:22 +00:00
|
|
|
struct workqueue_attrs *alloc_workqueue_attrs(void);
|
|
|
|
void free_workqueue_attrs(struct workqueue_attrs *attrs);
|
|
|
|
int apply_workqueue_attrs(struct workqueue_struct *wq,
|
|
|
|
const struct workqueue_attrs *attrs);
|
2015-04-30 09:16:12 +00:00
|
|
|
int workqueue_set_unbound_cpumask(cpumask_var_t cpumask);
|
2013-03-12 18:30:00 +00:00
|
|
|
|
2012-08-03 17:30:44 +00:00
|
|
|
extern bool queue_work_on(int cpu, struct workqueue_struct *wq,
|
2008-07-24 04:28:39 +00:00
|
|
|
struct work_struct *work);
|
2019-01-22 18:39:26 +00:00
|
|
|
extern bool queue_work_node(int node, struct workqueue_struct *wq,
|
|
|
|
struct work_struct *work);
|
2012-08-03 17:30:44 +00:00
|
|
|
extern bool queue_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
2007-05-09 09:34:22 +00:00
|
|
|
struct delayed_work *work, unsigned long delay);
|
2012-08-03 17:30:47 +00:00
|
|
|
extern bool mod_delayed_work_on(int cpu, struct workqueue_struct *wq,
|
|
|
|
struct delayed_work *dwork, unsigned long delay);
|
2018-03-14 19:45:13 +00:00
|
|
|
extern bool queue_rcu_work(struct workqueue_struct *wq, struct rcu_work *rwork);
|
2007-05-09 09:34:22 +00:00
|
|
|
|
2008-02-13 23:03:15 +00:00
|
|
|
extern void flush_workqueue(struct workqueue_struct *wq);
|
2011-04-05 16:01:44 +00:00
|
|
|
extern void drain_workqueue(struct workqueue_struct *wq);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2006-11-22 14:55:48 +00:00
|
|
|
extern int schedule_on_each_cpu(work_func_t func);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2006-11-22 14:55:48 +00:00
|
|
|
int execute_in_process_context(work_func_t fn, struct execute_work *);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2010-09-16 08:36:00 +00: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-21 20:18:24 +00:00
|
|
|
extern bool cancel_delayed_work(struct delayed_work *dwork);
|
2010-09-16 08:36:00 +00:00
|
|
|
extern bool cancel_delayed_work_sync(struct delayed_work *dwork);
|
2007-05-09 09:34:22 +00:00
|
|
|
|
2018-03-14 19:45:13 +00:00
|
|
|
extern bool flush_rcu_work(struct rcu_work *rwork);
|
|
|
|
|
2010-06-29 08:07:14 +00:00
|
|
|
extern void workqueue_set_max_active(struct workqueue_struct *wq,
|
|
|
|
int max_active);
|
2018-02-11 09:38:28 +00:00
|
|
|
extern struct work_struct *current_work(void);
|
2013-03-13 00:41:37 +00:00
|
|
|
extern bool current_is_workqueue_rescuer(void);
|
2013-03-12 18:29:59 +00:00
|
|
|
extern bool workqueue_congested(int cpu, struct workqueue_struct *wq);
|
2010-06-29 08:07:14 +00:00
|
|
|
extern unsigned int work_busy(struct work_struct *work);
|
2013-04-30 22:27:22 +00: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);
|
workqueue: dump workqueues on sysrq-t
Workqueues are used extensively throughout the kernel but sometimes
it's difficult to debug stalls involving work items because visibility
into its inner workings is fairly limited. Although sysrq-t task dump
annotates each active worker task with the information on the work
item being executed, it is challenging to find out which work items
are pending or delayed on which queues and how pools are being
managed.
This patch implements show_workqueue_state() which dumps all busy
workqueues and pools and is called from the sysrq-t handler. At the
end of sysrq-t dump, something like the following is printed.
Showing busy workqueues and worker pools:
...
workqueue filler_wq: flags=0x0
pwq 2: cpus=1 node=0 flags=0x0 nice=0 active=2/256
in-flight: 491:filler_workfn, 507:filler_workfn
pwq 0: cpus=0 node=0 flags=0x0 nice=0 active=2/256
in-flight: 501:filler_workfn
pending: filler_workfn
...
workqueue test_wq: flags=0x8
pwq 2: cpus=1 node=0 flags=0x0 nice=0 active=1/1
in-flight: 510(RESCUER):test_workfn BAR(69) BAR(500)
delayed: test_workfn1 BAR(492), test_workfn2
...
pool 0: cpus=0 node=0 flags=0x0 nice=0 workers=2 manager: 137
pool 2: cpus=1 node=0 flags=0x0 nice=0 workers=3 manager: 469
pool 3: cpus=1 node=0 flags=0x0 nice=-20 workers=2 idle: 16
pool 8: cpus=0-3 flags=0x4 nice=0 workers=2 manager: 62
The above shows that test_wq is executing test_workfn() on pid 510
which is the rescuer and also that there are two tasks 69 and 500
waiting for the work item to finish in flush_work(). As test_wq has
max_active of 1, there are two work items for test_workfn1() and
test_workfn2() which are delayed till the current work item is
finished. In addition, pid 492 is flushing test_workfn1().
The work item for test_workfn() is being executed on pwq of pool 2
which is the normal priority per-cpu pool for CPU 1. The pool has
three workers, two of which are executing filler_workfn() for
filler_wq and the last one is assuming the manager role trying to
create more workers.
This extra workqueue state dump will hopefully help chasing down hangs
involving workqueues.
v3: cpulist_pr_cont() replaced with "%*pbl" printf formatting.
v2: As suggested by Andrew, minor formatting change in pr_cont_work(),
printk()'s replaced with pr_info()'s, and cpumask printing now
uses cpulist_pr_cont().
Signed-off-by: Tejun Heo <tj@kernel.org>
Cc: Lai Jiangshan <laijs@cn.fujitsu.com>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Andrew Morton <akpm@linux-foundation.org>
CC: Ingo Molnar <mingo@redhat.com>
2015-03-09 13:22:28 +00:00
|
|
|
extern void show_workqueue_state(void);
|
2018-05-18 15:47:13 +00:00
|
|
|
extern void wq_worker_comm(char *buf, size_t size, struct task_struct *task);
|
2010-06-29 08:07:14 +00:00
|
|
|
|
2013-03-13 23:51:36 +00: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.
|
2020-01-22 18:39:52 +00:00
|
|
|
*
|
|
|
|
* Memory-ordering properties: If it returns %true, guarantees that all stores
|
|
|
|
* preceding the call to queue_work() in the program order will be visible from
|
|
|
|
* the CPU which will execute @work by the time such work executes, e.g.,
|
|
|
|
*
|
|
|
|
* { x is initially 0 }
|
|
|
|
*
|
|
|
|
* CPU0 CPU1
|
|
|
|
*
|
|
|
|
* WRITE_ONCE(x, 1); [ @work is being executed ]
|
|
|
|
* r0 = queue_work(wq, work); r1 = READ_ONCE(x);
|
|
|
|
*
|
|
|
|
* Forbids: r0 == true && r1 == 0
|
2013-03-13 23:51:36 +00:00
|
|
|
*/
|
|
|
|
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.
|
2020-01-22 18:39:52 +00:00
|
|
|
*
|
|
|
|
* Shares the same memory-ordering properties of queue_work(), cf. the
|
|
|
|
* DocBook header of queue_work().
|
2013-03-13 23:51:36 +00:00
|
|
|
*/
|
|
|
|
static inline bool schedule_work(struct work_struct *work)
|
|
|
|
{
|
|
|
|
return queue_work(system_wq, work);
|
|
|
|
}
|
|
|
|
|
2015-05-20 06:41:19 +00:00
|
|
|
/**
|
|
|
|
* flush_scheduled_work - ensure that any scheduled work has run to completion.
|
|
|
|
*
|
|
|
|
* Forces execution of the kernel-global workqueue and blocks until its
|
|
|
|
* completion.
|
|
|
|
*
|
|
|
|
* Think twice before calling this function! It's very easy to get into
|
|
|
|
* trouble if you don't take great care. Either of the following situations
|
|
|
|
* will lead to deadlock:
|
|
|
|
*
|
|
|
|
* One of the work items currently on the workqueue needs to acquire
|
|
|
|
* a lock held by your code or its caller.
|
|
|
|
*
|
|
|
|
* Your code is running in the context of a work routine.
|
|
|
|
*
|
|
|
|
* They will be detected by lockdep when they occur, but the first might not
|
|
|
|
* occur very often. It depends on what work items are on the workqueue and
|
|
|
|
* what locks they need, which you have no control over.
|
|
|
|
*
|
|
|
|
* In most situations flushing the entire workqueue is overkill; you merely
|
|
|
|
* need to know that a particular work item isn't queued and isn't running.
|
|
|
|
* In such cases you should use cancel_delayed_work_sync() or
|
|
|
|
* cancel_work_sync() instead.
|
|
|
|
*/
|
|
|
|
static inline void flush_scheduled_work(void)
|
|
|
|
{
|
|
|
|
flush_workqueue(system_wq);
|
|
|
|
}
|
|
|
|
|
2013-03-13 23:51:36 +00:00
|
|
|
/**
|
|
|
|
* 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);
|
|
|
|
}
|
|
|
|
|
2008-11-05 02:39:10 +00:00
|
|
|
#ifndef CONFIG_SMP
|
2013-03-12 18:29:59 +00:00
|
|
|
static inline long work_on_cpu(int cpu, long (*fn)(void *), void *arg)
|
2008-11-05 02:39:10 +00:00
|
|
|
{
|
|
|
|
return fn(arg);
|
|
|
|
}
|
2017-04-12 20:07:28 +00:00
|
|
|
static inline long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg)
|
|
|
|
{
|
|
|
|
return fn(arg);
|
|
|
|
}
|
2008-11-05 02:39:10 +00:00
|
|
|
#else
|
2013-03-12 18:29:59 +00:00
|
|
|
long work_on_cpu(int cpu, long (*fn)(void *), void *arg);
|
2017-04-12 20:07:28 +00:00
|
|
|
long work_on_cpu_safe(int cpu, long (*fn)(void *), void *arg);
|
2008-11-05 02:39:10 +00:00
|
|
|
#endif /* CONFIG_SMP */
|
2010-05-13 19:32:28 +00:00
|
|
|
|
2010-06-29 08:07:12 +00: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-12 18:30:05 +00: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 */
|
|
|
|
|
workqueue: implement lockup detector
Workqueue stalls can happen from a variety of usage bugs such as
missing WQ_MEM_RECLAIM flag or concurrency managed work item
indefinitely staying RUNNING. These stalls can be extremely difficult
to hunt down because the usual warning mechanisms can't detect
workqueue stalls and the internal state is pretty opaque.
To alleviate the situation, this patch implements workqueue lockup
detector. It periodically monitors all worker_pools periodically and,
if any pool failed to make forward progress longer than the threshold
duration, triggers warning and dumps workqueue state as follows.
BUG: workqueue lockup - pool cpus=0 node=0 flags=0x0 nice=0 stuck for 31s!
Showing busy workqueues and worker pools:
workqueue events: flags=0x0
pwq 0: cpus=0 node=0 flags=0x0 nice=0 active=17/256
pending: monkey_wrench_fn, e1000_watchdog, cache_reap, vmstat_shepherd, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, release_one_tty, cgroup_release_agent
workqueue events_power_efficient: flags=0x80
pwq 0: cpus=0 node=0 flags=0x0 nice=0 active=2/256
pending: check_lifetime, neigh_periodic_work
workqueue cgroup_pidlist_destroy: flags=0x0
pwq 0: cpus=0 node=0 flags=0x0 nice=0 active=1/1
pending: cgroup_pidlist_destroy_work_fn
...
The detection mechanism is controller through kernel parameter
workqueue.watchdog_thresh and can be updated at runtime through the
sysfs module parameter file.
v2: Decoupled from softlockup control knobs.
Signed-off-by: Tejun Heo <tj@kernel.org>
Acked-by: Don Zickus <dzickus@redhat.com>
Cc: Ulrich Obergfell <uobergfe@redhat.com>
Cc: Michal Hocko <mhocko@suse.com>
Cc: Chris Mason <clm@fb.com>
Cc: Andrew Morton <akpm@linux-foundation.org>
2015-12-08 16:28:04 +00:00
|
|
|
#ifdef CONFIG_WQ_WATCHDOG
|
|
|
|
void wq_watchdog_touch(int cpu);
|
|
|
|
#else /* CONFIG_WQ_WATCHDOG */
|
|
|
|
static inline void wq_watchdog_touch(int cpu) { }
|
|
|
|
#endif /* CONFIG_WQ_WATCHDOG */
|
|
|
|
|
2016-07-13 17:16:29 +00:00
|
|
|
#ifdef CONFIG_SMP
|
|
|
|
int workqueue_prepare_cpu(unsigned int cpu);
|
|
|
|
int workqueue_online_cpu(unsigned int cpu);
|
|
|
|
int workqueue_offline_cpu(unsigned int cpu);
|
|
|
|
#endif
|
|
|
|
|
2020-02-23 07:28:52 +00:00
|
|
|
void __init workqueue_init_early(void);
|
|
|
|
void __init workqueue_init(void);
|
2016-09-16 19:49:32 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
#endif
|