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
|
|
|
#ifndef _LINUX_FUTEX_H
|
|
|
|
|
#define _LINUX_FUTEX_H
|
|
|
|
|
|
2019-11-06 21:55:36 +00:00
|
|
|
#include <linux/sched.h>
|
2016-12-25 10:38:40 +00:00
|
|
|
#include <linux/ktime.h>
|
2019-11-06 21:55:36 +00:00
|
|
|
|
2012-10-13 09:46:48 +00:00
|
|
|
#include <uapi/linux/futex.h>
|
2006-03-27 09:16:22 +00:00
|
|
|
|
2009-09-23 22:57:23 +00:00
|
|
|
struct inode;
|
|
|
|
|
struct mm_struct;
|
|
|
|
|
struct task_struct;
|
|
|
|
|
|
2007-05-08 07:26:42 +00:00
|
|
|
/*
|
|
|
|
|
* Futexes are matched on equal values of this key.
|
|
|
|
|
* The key type depends on whether it's a shared or private mapping.
|
|
|
|
|
* Don't rearrange members without looking at hash_futex().
|
|
|
|
|
*
|
|
|
|
|
* offset is aligned to a multiple of sizeof(u32) (== 4) by definition.
|
FUTEX: new PRIVATE futexes
Analysis of current linux futex code :
--------------------------------------
A central hash table futex_queues[] holds all contexts (futex_q) of waiting
threads.
Each futex_wait()/futex_wait() has to obtain a spinlock on a hash slot to
perform lookups or insert/deletion of a futex_q.
When a futex_wait() is done, calling thread has to :
1) - Obtain a read lock on mmap_sem to be able to validate the user pointer
(calling find_vma()). This validation tells us if the futex uses
an inode based store (mapped file), or mm based store (anonymous mem)
2) - compute a hash key
3) - Atomic increment of reference counter on an inode or a mm_struct
4) - lock part of futex_queues[] hash table
5) - perform the test on value of futex.
(rollback is value != expected_value, returns EWOULDBLOCK)
(various loops if test triggers mm faults)
6) queue the context into hash table, release the lock got in 4)
7) - release the read_lock on mmap_sem
<block>
8) Eventually unqueue the context (but rarely, as this part may be done
by the futex_wake())
Futexes were designed to improve scalability but current implementation has
various problems :
- Central hashtable :
This means scalability problems if many processes/threads want to use
futexes at the same time.
This means NUMA unbalance because this hashtable is located on one node.
- Using mmap_sem on every futex() syscall :
Even if mmap_sem is a rw_semaphore, up_read()/down_read() are doing atomic
ops on mmap_sem, dirtying cache line :
- lot of cache line ping pongs on SMP configurations.
mmap_sem is also extensively used by mm code (page faults, mmap()/munmap())
Highly threaded processes might suffer from mmap_sem contention.
mmap_sem is also used by oprofile code. Enabling oprofile hurts threaded
programs because of contention on the mmap_sem cache line.
- Using an atomic_inc()/atomic_dec() on inode ref counter or mm ref counter:
It's also a cache line ping pong on SMP. It also increases mmap_sem hold time
because of cache misses.
Most of these scalability problems come from the fact that futexes are in
one global namespace. As we use a central hash table, we must make sure
they are all using the same reference (given by the mm subsystem). We
chose to force all futexes be 'shared'. This has a cost.
But fact is POSIX defined PRIVATE and SHARED, allowing clear separation,
and optimal performance if carefuly implemented. Time has come for linux
to have better threading performance.
The goal is to permit new futex commands to avoid :
- Taking the mmap_sem semaphore, conflicting with other subsystems.
- Modifying a ref_count on mm or an inode, still conflicting with mm or fs.
This is possible because, for one process using PTHREAD_PROCESS_PRIVATE
futexes, we only need to distinguish futexes by their virtual address, no
matter the underlying mm storage is.
If glibc wants to exploit this new infrastructure, it should use new
_PRIVATE futex subcommands for PTHREAD_PROCESS_PRIVATE futexes. And be
prepared to fallback on old subcommands for old kernels. Using one global
variable with the FUTEX_PRIVATE_FLAG or 0 value should be OK.
PTHREAD_PROCESS_SHARED futexes should still use the old subcommands.
Compatibility with old applications is preserved, they still hit the
scalability problems, but new applications can fly :)
Note : the same SHARED futex (mapped on a file) can be used by old binaries
*and* new binaries, because both binaries will use the old subcommands.
Note : Vast majority of futexes should be using PROCESS_PRIVATE semantic,
as this is the default semantic. Almost all applications should benefit
of this changes (new kernel and updated libc)
Some bench results on a Pentium M 1.6 GHz (SMP kernel on a UP machine)
/* calling futex_wait(addr, value) with value != *addr */
433 cycles per futex(FUTEX_WAIT) call (mixing 2 futexes)
424 cycles per futex(FUTEX_WAIT) call (using one futex)
334 cycles per futex(FUTEX_WAIT_PRIVATE) call (mixing 2 futexes)
334 cycles per futex(FUTEX_WAIT_PRIVATE) call (using one futex)
For reference :
187 cycles per getppid() call
188 cycles per umask() call
181 cycles per ni_syscall() call
Signed-off-by: Eric Dumazet <dada1@cosmosbay.com>
Pierre Peiffer <pierre.peiffer@bull.net>
Cc: "Ulrich Drepper" <drepper@gmail.com>
Cc: "Nick Piggin" <nickpiggin@yahoo.com.au>
Cc: "Ingo Molnar" <mingo@elte.hu>
Cc: Rusty Russell <rusty@rustcorp.com.au>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2007-05-09 09:35:04 +00:00
|
|
|
* We use the two low order bits of offset to tell what is the kind of key :
|
|
|
|
|
* 00 : Private process futex (PTHREAD_PROCESS_PRIVATE)
|
|
|
|
|
* (no reference on an inode or mm)
|
|
|
|
|
* 01 : Shared futex (PTHREAD_PROCESS_SHARED)
|
|
|
|
|
* mapped on a file (reference on the underlying inode)
|
|
|
|
|
* 10 : Shared futex (PTHREAD_PROCESS_SHARED)
|
|
|
|
|
* (but private mapping on an mm, and reference taken on it)
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#define FUT_OFF_INODE 1 /* We set bit 0 if key has a reference on inode */
|
|
|
|
|
#define FUT_OFF_MMSHARED 2 /* We set bit 1 if key has a reference on mm */
|
|
|
|
|
|
2007-05-08 07:26:42 +00:00
|
|
|
union futex_key {
|
|
|
|
|
struct {
|
2020-03-04 10:28:31 +00:00
|
|
|
u64 i_seq;
|
2007-05-08 07:26:42 +00:00
|
|
|
unsigned long pgoff;
|
2020-03-04 10:28:31 +00:00
|
|
|
unsigned int offset;
|
2007-05-08 07:26:42 +00:00
|
|
|
} shared;
|
|
|
|
|
struct {
|
2020-03-04 10:28:31 +00:00
|
|
|
union {
|
|
|
|
|
struct mm_struct *mm;
|
|
|
|
|
u64 __tmp;
|
|
|
|
|
};
|
2007-05-08 07:26:42 +00:00
|
|
|
unsigned long address;
|
2020-03-04 10:28:31 +00:00
|
|
|
unsigned int offset;
|
2007-05-08 07:26:42 +00:00
|
|
|
} private;
|
|
|
|
|
struct {
|
2020-03-04 10:28:31 +00:00
|
|
|
u64 ptr;
|
2007-05-08 07:26:42 +00:00
|
|
|
unsigned long word;
|
2020-03-04 10:28:31 +00:00
|
|
|
unsigned int offset;
|
2007-05-08 07:26:42 +00:00
|
|
|
} both;
|
|
|
|
|
};
|
|
|
|
|
|
2020-03-04 10:28:31 +00:00
|
|
|
#define FUTEX_KEY_INIT (union futex_key) { .both = { .ptr = 0ULL } }
|
2008-09-26 17:32:20 +00:00
|
|
|
|
2006-03-27 09:16:22 +00:00
|
|
|
#ifdef CONFIG_FUTEX
|
2019-11-06 21:55:37 +00:00
|
|
|
enum {
|
|
|
|
|
FUTEX_STATE_OK,
|
2019-11-06 21:55:41 +00:00
|
|
|
FUTEX_STATE_EXITING,
|
2019-11-06 21:55:37 +00:00
|
|
|
FUTEX_STATE_DEAD,
|
|
|
|
|
};
|
2018-03-11 10:34:26 +00:00
|
|
|
|
2019-11-06 21:55:36 +00:00
|
|
|
static inline void futex_init_task(struct task_struct *tsk)
|
2006-03-27 09:16:22 +00:00
|
|
|
{
|
2019-11-06 21:55:36 +00:00
|
|
|
tsk->robust_list = NULL;
|
|
|
|
|
#ifdef CONFIG_COMPAT
|
|
|
|
|
tsk->compat_robust_list = NULL;
|
|
|
|
|
#endif
|
|
|
|
|
INIT_LIST_HEAD(&tsk->pi_state_list);
|
|
|
|
|
tsk->pi_state_cache = NULL;
|
2019-11-06 21:55:37 +00:00
|
|
|
tsk->futex_state = FUTEX_STATE_OK;
|
2019-11-06 21:55:44 +00:00
|
|
|
mutex_init(&tsk->futex_exit_mutex);
|
2019-11-06 21:55:37 +00:00
|
|
|
}
|
|
|
|
|
|
2019-11-06 21:55:41 +00:00
|
|
|
void futex_exit_recursive(struct task_struct *tsk);
|
2019-11-06 21:55:39 +00:00
|
|
|
void futex_exit_release(struct task_struct *tsk);
|
|
|
|
|
void futex_exec_release(struct task_struct *tsk);
|
2019-11-06 21:55:36 +00:00
|
|
|
|
|
|
|
|
long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout,
|
|
|
|
|
u32 __user *uaddr2, u32 val2, u32 val3);
|
|
|
|
|
#else
|
|
|
|
|
static inline void futex_init_task(struct task_struct *tsk) { }
|
2019-11-06 21:55:41 +00:00
|
|
|
static inline void futex_exit_recursive(struct task_struct *tsk) { }
|
2019-11-06 21:55:39 +00:00
|
|
|
static inline void futex_exit_release(struct task_struct *tsk) { }
|
|
|
|
|
static inline void futex_exec_release(struct task_struct *tsk) { }
|
2018-03-11 10:34:26 +00:00
|
|
|
static inline long do_futex(u32 __user *uaddr, int op, u32 val,
|
|
|
|
|
ktime_t *timeout, u32 __user *uaddr2,
|
|
|
|
|
u32 val2, u32 val3)
|
|
|
|
|
{
|
|
|
|
|
return -EINVAL;
|
|
|
|
|
}
|
2017-08-01 04:31:32 +00:00
|
|
|
#endif
|
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
#endif
|