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 22:07:57 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2005-04-17 06:20:36 +08:00
|
|
|
/* Rewritten and vastly simplified by Rusty Russell for in-kernel
|
|
|
|
* module loader:
|
|
|
|
* Copyright 2002 Rusty Russell <rusty@rustcorp.com.au> IBM Corporation
|
|
|
|
*/
|
|
|
|
#ifndef _LINUX_KALLSYMS_H
|
|
|
|
#define _LINUX_KALLSYMS_H
|
|
|
|
|
2007-07-07 06:54:09 +08:00
|
|
|
#include <linux/errno.h>
|
2021-07-08 09:09:20 +08:00
|
|
|
#include <linux/buildid.h>
|
2008-07-25 16:45:56 +08:00
|
|
|
#include <linux/kernel.h>
|
2007-11-06 06:50:55 +08:00
|
|
|
#include <linux/stddef.h>
|
2017-12-06 12:36:49 +08:00
|
|
|
#include <linux/mm.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
|
|
|
|
#include <asm/sections.h>
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2021-04-05 11:03:50 +08:00
|
|
|
#define KSYM_NAME_LEN 512
|
2021-07-08 09:09:20 +08:00
|
|
|
#define KSYM_SYMBOL_LEN (sizeof("%s+%#lx/%#lx [%s %s]") + \
|
|
|
|
(KSYM_NAME_LEN - 1) + \
|
|
|
|
2*(BITS_PER_LONG*3/10) + (MODULE_NAME_LEN - 1) + \
|
|
|
|
(BUILD_ID_SIZE_MAX * 2) + 1)
|
2005-04-17 06:20:36 +08:00
|
|
|
|
2020-07-03 02:49:23 +08:00
|
|
|
struct cred;
|
2008-12-06 08:03:58 +08:00
|
|
|
struct module;
|
|
|
|
|
2017-12-06 12:36:49 +08:00
|
|
|
static inline int is_kernel_text(unsigned long addr)
|
|
|
|
{
|
2021-11-09 10:34:02 +08:00
|
|
|
if (__is_kernel_text(addr))
|
2017-12-06 12:36:49 +08:00
|
|
|
return 1;
|
|
|
|
return in_gate_area_no_mm(addr);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int is_kernel(unsigned long addr)
|
|
|
|
{
|
2021-11-09 10:34:02 +08:00
|
|
|
if (__is_kernel(addr))
|
2017-12-06 12:36:49 +08:00
|
|
|
return 1;
|
|
|
|
return in_gate_area_no_mm(addr);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int is_ksym_addr(unsigned long addr)
|
|
|
|
{
|
|
|
|
if (IS_ENABLED(CONFIG_KALLSYMS_ALL))
|
|
|
|
return is_kernel(addr);
|
|
|
|
|
|
|
|
return is_kernel_text(addr) || is_kernel_inittext(addr);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void *dereference_symbol_descriptor(void *ptr)
|
|
|
|
{
|
2022-02-15 20:41:02 +08:00
|
|
|
#ifdef CONFIG_HAVE_FUNCTION_DESCRIPTORS
|
2017-12-06 12:36:49 +08:00
|
|
|
struct module *mod;
|
|
|
|
|
|
|
|
ptr = dereference_kernel_function_descriptor(ptr);
|
|
|
|
if (is_ksym_addr((unsigned long)ptr))
|
|
|
|
return ptr;
|
|
|
|
|
|
|
|
preempt_disable();
|
|
|
|
mod = __module_address((unsigned long)ptr);
|
|
|
|
preempt_enable();
|
|
|
|
|
|
|
|
if (mod)
|
|
|
|
ptr = dereference_module_function_descriptor(mod, ptr);
|
|
|
|
#endif
|
|
|
|
return ptr;
|
|
|
|
}
|
|
|
|
|
2023-06-08 11:31:19 +08:00
|
|
|
/* How and when do we show kallsyms values? */
|
|
|
|
extern bool kallsyms_show_value(const struct cred *cred);
|
|
|
|
|
2022-05-10 20:26:12 +08:00
|
|
|
#ifdef CONFIG_KALLSYMS
|
kallsyms: Add self-test facility
Added test cases for basic functions and performance of functions
kallsyms_lookup_name(), kallsyms_on_each_symbol() and
kallsyms_on_each_match_symbol(). It also calculates the compression rate
of the kallsyms compression algorithm for the current symbol set.
The basic functions test begins by testing a set of symbols whose address
values are known. Then, traverse all symbol addresses and find the
corresponding symbol name based on the address. It's impossible to
determine whether these addresses are correct, but we can use the above
three functions along with the addresses to test each other. Due to the
traversal operation of kallsyms_on_each_symbol() is too slow, only 60
symbols can be tested in one second, so let it test on average once
every 128 symbols. The other two functions validate all symbols.
If the basic functions test is passed, print only performance test
results. If the test fails, print error information, but do not perform
subsequent performance tests.
Start self-test automatically after system startup if
CONFIG_KALLSYMS_SELFTEST=y.
Example of output content: (prefix 'kallsyms_selftest:' is omitted
start
---------------------------------------------------------
| nr_symbols | compressed size | original size | ratio(%) |
|---------------------------------------------------------|
| 107543 | 1357912 | 2407433 | 56.40 |
---------------------------------------------------------
kallsyms_lookup_name() looked up 107543 symbols
The time spent on each symbol is (ns): min=630, max=35295, avg=7353
kallsyms_on_each_symbol() traverse all: 11782628 ns
kallsyms_on_each_match_symbol() traverse all: 9261 ns
finish
Signed-off-by: Zhen Lei <thunder.leizhen@huawei.com>
Signed-off-by: Luis Chamberlain <mcgrof@kernel.org>
2022-11-15 16:33:48 +08:00
|
|
|
unsigned long kallsyms_sym_address(int idx);
|
2023-03-08 15:38:46 +08:00
|
|
|
int kallsyms_on_each_symbol(int (*fn)(void *, const char *, unsigned long),
|
2008-12-06 08:03:58 +08:00
|
|
|
void *data);
|
2022-11-02 16:49:17 +08:00
|
|
|
int kallsyms_on_each_match_symbol(int (*fn)(void *, unsigned long),
|
|
|
|
const char *name, void *data);
|
2008-12-06 08:03:58 +08:00
|
|
|
|
2021-02-02 20:13:27 +08:00
|
|
|
/* Lookup the address for a symbol. Returns 0 if not found. */
|
|
|
|
unsigned long kallsyms_lookup_name(const char *name);
|
|
|
|
|
2006-10-03 16:13:48 +08:00
|
|
|
extern int kallsyms_lookup_size_offset(unsigned long addr,
|
|
|
|
unsigned long *symbolsize,
|
|
|
|
unsigned long *offset);
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
/* Lookup an address. modname is set to NULL if it's in the kernel. */
|
|
|
|
const char *kallsyms_lookup(unsigned long addr,
|
|
|
|
unsigned long *symbolsize,
|
|
|
|
unsigned long *offset,
|
|
|
|
char **modname, char *namebuf);
|
|
|
|
|
2007-05-01 06:09:48 +08:00
|
|
|
/* Look up a kernel symbol and return it in a text buffer. */
|
|
|
|
extern int sprint_symbol(char *buffer, unsigned long address);
|
2021-07-08 09:09:20 +08:00
|
|
|
extern int sprint_symbol_build_id(char *buffer, unsigned long address);
|
2012-05-30 06:07:33 +08:00
|
|
|
extern int sprint_symbol_no_offset(char *buffer, unsigned long address);
|
2011-03-24 10:42:29 +08:00
|
|
|
extern int sprint_backtrace(char *buffer, unsigned long address);
|
2021-07-08 09:09:20 +08:00
|
|
|
extern int sprint_backtrace_build_id(char *buffer, unsigned long address);
|
2007-05-01 06:09:48 +08:00
|
|
|
|
2007-05-08 15:28:43 +08:00
|
|
|
int lookup_symbol_name(unsigned long addr, char *symname);
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
#else /* !CONFIG_KALLSYMS */
|
|
|
|
|
|
|
|
static inline unsigned long kallsyms_lookup_name(const char *name)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2006-10-03 16:13:48 +08:00
|
|
|
static inline int kallsyms_lookup_size_offset(unsigned long addr,
|
|
|
|
unsigned long *symbolsize,
|
|
|
|
unsigned long *offset)
|
|
|
|
{
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
static inline const char *kallsyms_lookup(unsigned long addr,
|
|
|
|
unsigned long *symbolsize,
|
|
|
|
unsigned long *offset,
|
|
|
|
char **modname, char *namebuf)
|
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
|
2007-05-01 06:09:48 +08:00
|
|
|
static inline int sprint_symbol(char *buffer, unsigned long addr)
|
|
|
|
{
|
|
|
|
*buffer = '\0';
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2021-07-08 09:09:20 +08:00
|
|
|
static inline int sprint_symbol_build_id(char *buffer, unsigned long address)
|
|
|
|
{
|
|
|
|
*buffer = '\0';
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2012-05-30 06:07:33 +08:00
|
|
|
static inline int sprint_symbol_no_offset(char *buffer, unsigned long addr)
|
|
|
|
{
|
|
|
|
*buffer = '\0';
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2011-03-24 10:42:29 +08:00
|
|
|
static inline int sprint_backtrace(char *buffer, unsigned long addr)
|
|
|
|
{
|
|
|
|
*buffer = '\0';
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2021-07-08 09:09:20 +08:00
|
|
|
static inline int sprint_backtrace_build_id(char *buffer, unsigned long addr)
|
|
|
|
{
|
|
|
|
*buffer = '\0';
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
2007-05-08 15:28:43 +08:00
|
|
|
static inline int lookup_symbol_name(unsigned long addr, char *symname)
|
|
|
|
{
|
|
|
|
return -ERANGE;
|
|
|
|
}
|
|
|
|
|
2023-03-08 15:38:46 +08:00
|
|
|
static inline int kallsyms_on_each_symbol(int (*fn)(void *, const char *, unsigned long),
|
|
|
|
void *data)
|
2022-05-10 20:26:12 +08:00
|
|
|
{
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
}
|
2022-11-02 16:49:17 +08:00
|
|
|
|
|
|
|
static inline int kallsyms_on_each_match_symbol(int (*fn)(void *, unsigned long),
|
|
|
|
const char *name, void *data)
|
|
|
|
{
|
|
|
|
return -EOPNOTSUPP;
|
|
|
|
}
|
2005-04-17 06:20:36 +08:00
|
|
|
#endif /*CONFIG_KALLSYMS*/
|
|
|
|
|
2020-06-09 12:29:56 +08:00
|
|
|
static inline void print_ip_sym(const char *loglvl, unsigned long ip)
|
2008-07-25 16:45:56 +08:00
|
|
|
{
|
2020-06-09 12:29:56 +08:00
|
|
|
printk("%s[<%px>] %pS\n", loglvl, (void *) ip, (void *) ip);
|
2008-07-25 16:45:56 +08:00
|
|
|
}
|
2006-07-03 15:24:25 +08:00
|
|
|
|
2005-04-17 06:20:36 +08:00
|
|
|
#endif /*_LINUX_KALLSYMS_H*/
|