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 07:07:57 -07:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2013-01-18 15:05:55 -07:00
|
|
|
/*
|
|
|
|
* kernel/workqueue_internal.h
|
|
|
|
*
|
|
|
|
* Workqueue internal header file. Only to be included by workqueue and
|
|
|
|
* core kernel subsystems.
|
|
|
|
*/
|
|
|
|
#ifndef _KERNEL_WORKQUEUE_INTERNAL_H
|
|
|
|
#define _KERNEL_WORKQUEUE_INTERNAL_H
|
|
|
|
|
2013-01-18 15:05:55 -07:00
|
|
|
#include <linux/workqueue.h>
|
2013-01-18 15:05:56 -07:00
|
|
|
#include <linux/kthread.h>
|
2017-10-27 20:07:28 -07:00
|
|
|
#include <linux/preempt.h>
|
2013-01-18 15:05:55 -07:00
|
|
|
|
|
|
|
struct worker_pool;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The poor guys doing the actual heavy lifting. All on-duty workers are
|
|
|
|
* either serving the manager role, on idle list or on busy hash. For
|
|
|
|
* details on the locking annotation (L, I, X...), refer to workqueue.c.
|
|
|
|
*
|
|
|
|
* Only to be used in workqueue and async.
|
|
|
|
*/
|
|
|
|
struct worker {
|
|
|
|
/* on idle list while idle, on busy hash table while busy */
|
|
|
|
union {
|
|
|
|
struct list_head entry; /* L: while idle */
|
|
|
|
struct hlist_node hentry; /* L: while busy */
|
|
|
|
};
|
|
|
|
|
2023-05-17 20:02:08 -07:00
|
|
|
struct work_struct *current_work; /* K: work being processed and its */
|
|
|
|
work_func_t current_func; /* K: function */
|
|
|
|
struct pool_workqueue *current_pwq; /* K: pwq */
|
2023-05-17 20:02:08 -07:00
|
|
|
u64 current_at; /* K: runtime at start or last wakeup */
|
2023-05-17 20:02:08 -07:00
|
|
|
unsigned int current_color; /* K: color */
|
|
|
|
|
|
|
|
int sleeping; /* S: is worker sleeping? */
|
2023-05-17 20:02:08 -07:00
|
|
|
|
|
|
|
/* used by the scheduler to determine a worker's last known identity */
|
2023-05-17 20:02:08 -07:00
|
|
|
work_func_t last_func; /* K: last work's fn */
|
2013-04-30 15:27:22 -07:00
|
|
|
|
2023-05-17 20:02:08 -07:00
|
|
|
struct list_head scheduled; /* L: scheduled works */
|
2013-04-30 15:27:22 -07:00
|
|
|
|
2013-01-18 15:05:55 -07:00
|
|
|
struct task_struct *task; /* I: worker task */
|
2018-05-18 08:47:13 -07:00
|
|
|
struct worker_pool *pool; /* A: the associated pool */
|
2013-02-19 13:17:02 -07:00
|
|
|
/* L: for rescuers */
|
2014-05-20 02:46:34 -07:00
|
|
|
struct list_head node; /* A: anchored at pool->workers */
|
|
|
|
/* A: runs through worker->node */
|
2013-04-30 15:27:22 -07:00
|
|
|
|
2023-05-17 20:02:08 -07:00
|
|
|
unsigned long last_active; /* K: last active timestamp */
|
2023-08-07 18:57:22 -07:00
|
|
|
unsigned int flags; /* L: flags */
|
2013-01-18 15:05:55 -07:00
|
|
|
int id; /* I: worker id */
|
|
|
|
|
2013-04-30 15:27:22 -07:00
|
|
|
/*
|
|
|
|
* Opaque string set with work_set_desc(). Printed out with task
|
|
|
|
* dump for debugging - WARN, BUG, panic or sysrq.
|
|
|
|
*/
|
|
|
|
char desc[WORKER_DESC_LEN];
|
|
|
|
|
2013-01-18 15:05:55 -07:00
|
|
|
/* used only by rescuers to point to the target workqueue */
|
|
|
|
struct workqueue_struct *rescue_wq; /* I: the workqueue to rescue */
|
|
|
|
};
|
|
|
|
|
2013-01-18 15:05:56 -07:00
|
|
|
/**
|
|
|
|
* current_wq_worker - return struct worker if %current is a workqueue worker
|
|
|
|
*/
|
|
|
|
static inline struct worker *current_wq_worker(void)
|
|
|
|
{
|
2017-10-27 20:07:28 -07:00
|
|
|
if (in_task() && (current->flags & PF_WQ_WORKER))
|
2013-01-18 15:05:56 -07:00
|
|
|
return kthread_data(current);
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2013-01-18 15:05:55 -07:00
|
|
|
/*
|
|
|
|
* Scheduler hooks for concurrency managed workqueue. Only to be used from
|
psi: fix aggregation idle shut-off
psi has provisions to shut off the periodic aggregation worker when
there is a period of no task activity - and thus no data that needs
aggregating. However, while developing psi monitoring, Suren noticed
that the aggregation clock currently won't stay shut off for good.
Debugging this revealed a flaw in the idle design: an aggregation run
will see no task activity and decide to go to sleep; shortly thereafter,
the kworker thread that executed the aggregation will go idle and cause
a scheduling change, during which the psi callback will kick the
!pending worker again. This will ping-pong forever, and is equivalent
to having no shut-off logic at all (but with more code!)
Fix this by exempting aggregation workers from psi's clock waking logic
when the state change is them going to sleep. To do this, tag workers
with the last work function they executed, and if in psi we see a worker
going to sleep after aggregating psi data, we will not reschedule the
aggregation work item.
What if the worker is also executing other items before or after?
Any psi state times that were incurred by work items preceding the
aggregation work will have been collected from the per-cpu buckets
during the aggregation itself. If there are work items following the
aggregation work, the worker's last_func tag will be overwritten and the
aggregator will be kept alive to process this genuine new activity.
If the aggregation work is the last thing the worker does, and we decide
to go idle, the brief period of non-idle time incurred between the
aggregation run and the kworker's dequeue will be stranded in the
per-cpu buckets until the clock is woken by later activity. But that
should not be a problem. The buckets can hold 4s worth of time, and
future activity will wake the clock with a 2s delay, giving us 2s worth
of data we can leave behind when disabling aggregation. If it takes a
worker more than two seconds to go idle after it finishes its last work
item, we likely have bigger problems in the system, and won't notice one
sample that was averaged with a bogus per-CPU weight.
Link: http://lkml.kernel.org/r/20190116193501.1910-1-hannes@cmpxchg.org
Fixes: eb414681d5a0 ("psi: pressure stall information for CPU, memory, and IO")
Signed-off-by: Johannes Weiner <hannes@cmpxchg.org>
Reported-by: Suren Baghdasaryan <surenb@google.com>
Acked-by: Tejun Heo <tj@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Lai Jiangshan <jiangshanlai@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2019-02-01 15:20:42 -07:00
|
|
|
* sched/ and workqueue.c.
|
2013-01-18 15:05:55 -07:00
|
|
|
*/
|
2019-03-13 09:55:48 -07:00
|
|
|
void wq_worker_running(struct task_struct *task);
|
|
|
|
void wq_worker_sleeping(struct task_struct *task);
|
2023-05-17 20:02:08 -07:00
|
|
|
void wq_worker_tick(struct task_struct *task);
|
psi: fix aggregation idle shut-off
psi has provisions to shut off the periodic aggregation worker when
there is a period of no task activity - and thus no data that needs
aggregating. However, while developing psi monitoring, Suren noticed
that the aggregation clock currently won't stay shut off for good.
Debugging this revealed a flaw in the idle design: an aggregation run
will see no task activity and decide to go to sleep; shortly thereafter,
the kworker thread that executed the aggregation will go idle and cause
a scheduling change, during which the psi callback will kick the
!pending worker again. This will ping-pong forever, and is equivalent
to having no shut-off logic at all (but with more code!)
Fix this by exempting aggregation workers from psi's clock waking logic
when the state change is them going to sleep. To do this, tag workers
with the last work function they executed, and if in psi we see a worker
going to sleep after aggregating psi data, we will not reschedule the
aggregation work item.
What if the worker is also executing other items before or after?
Any psi state times that were incurred by work items preceding the
aggregation work will have been collected from the per-cpu buckets
during the aggregation itself. If there are work items following the
aggregation work, the worker's last_func tag will be overwritten and the
aggregator will be kept alive to process this genuine new activity.
If the aggregation work is the last thing the worker does, and we decide
to go idle, the brief period of non-idle time incurred between the
aggregation run and the kworker's dequeue will be stranded in the
per-cpu buckets until the clock is woken by later activity. But that
should not be a problem. The buckets can hold 4s worth of time, and
future activity will wake the clock with a 2s delay, giving us 2s worth
of data we can leave behind when disabling aggregation. If it takes a
worker more than two seconds to go idle after it finishes its last work
item, we likely have bigger problems in the system, and won't notice one
sample that was averaged with a bogus per-CPU weight.
Link: http://lkml.kernel.org/r/20190116193501.1910-1-hannes@cmpxchg.org
Fixes: eb414681d5a0 ("psi: pressure stall information for CPU, memory, and IO")
Signed-off-by: Johannes Weiner <hannes@cmpxchg.org>
Reported-by: Suren Baghdasaryan <surenb@google.com>
Acked-by: Tejun Heo <tj@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Lai Jiangshan <jiangshanlai@gmail.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2019-02-01 15:20:42 -07:00
|
|
|
work_func_t wq_worker_last_func(struct task_struct *task);
|
2013-01-18 15:05:55 -07:00
|
|
|
|
|
|
|
#endif /* _KERNEL_WORKQUEUE_INTERNAL_H */
|