mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-24 17:59:32 +00:00
![Greg Kroah-Hartman](/assets/img/avatar_default.png)
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>
193 lines
6.1 KiB
C
193 lines
6.1 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _PROBE_EVENT_H
|
|
#define _PROBE_EVENT_H
|
|
|
|
#include <linux/compiler.h>
|
|
#include <stdbool.h>
|
|
#include "intlist.h"
|
|
#include "namespaces.h"
|
|
|
|
/* Probe related configurations */
|
|
struct probe_conf {
|
|
bool show_ext_vars;
|
|
bool show_location_range;
|
|
bool force_add;
|
|
bool no_inlines;
|
|
bool cache;
|
|
int max_probes;
|
|
};
|
|
extern struct probe_conf probe_conf;
|
|
extern bool probe_event_dry_run;
|
|
|
|
struct symbol;
|
|
|
|
/* kprobe-tracer and uprobe-tracer tracing point */
|
|
struct probe_trace_point {
|
|
char *realname; /* function real name (if needed) */
|
|
char *symbol; /* Base symbol */
|
|
char *module; /* Module name */
|
|
unsigned long offset; /* Offset from symbol */
|
|
unsigned long address; /* Actual address of the trace point */
|
|
bool retprobe; /* Return probe flag */
|
|
};
|
|
|
|
/* probe-tracer tracing argument referencing offset */
|
|
struct probe_trace_arg_ref {
|
|
struct probe_trace_arg_ref *next; /* Next reference */
|
|
long offset; /* Offset value */
|
|
};
|
|
|
|
/* kprobe-tracer and uprobe-tracer tracing argument */
|
|
struct probe_trace_arg {
|
|
char *name; /* Argument name */
|
|
char *value; /* Base value */
|
|
char *type; /* Type name */
|
|
struct probe_trace_arg_ref *ref; /* Referencing offset */
|
|
};
|
|
|
|
/* kprobe-tracer and uprobe-tracer tracing event (point + arg) */
|
|
struct probe_trace_event {
|
|
char *event; /* Event name */
|
|
char *group; /* Group name */
|
|
struct probe_trace_point point; /* Trace point */
|
|
int nargs; /* Number of args */
|
|
bool uprobes; /* uprobes only */
|
|
struct probe_trace_arg *args; /* Arguments */
|
|
};
|
|
|
|
/* Perf probe probing point */
|
|
struct perf_probe_point {
|
|
char *file; /* File path */
|
|
char *function; /* Function name */
|
|
int line; /* Line number */
|
|
bool retprobe; /* Return probe flag */
|
|
char *lazy_line; /* Lazy matching pattern */
|
|
unsigned long offset; /* Offset from function entry */
|
|
unsigned long abs_address; /* Absolute address of the point */
|
|
};
|
|
|
|
/* Perf probe probing argument field chain */
|
|
struct perf_probe_arg_field {
|
|
struct perf_probe_arg_field *next; /* Next field */
|
|
char *name; /* Name of the field */
|
|
long index; /* Array index number */
|
|
bool ref; /* Referencing flag */
|
|
};
|
|
|
|
/* Perf probe probing argument */
|
|
struct perf_probe_arg {
|
|
char *name; /* Argument name */
|
|
char *var; /* Variable name */
|
|
char *type; /* Type name */
|
|
struct perf_probe_arg_field *field; /* Structure fields */
|
|
};
|
|
|
|
/* Perf probe probing event (point + arg) */
|
|
struct perf_probe_event {
|
|
char *event; /* Event name */
|
|
char *group; /* Group name */
|
|
struct perf_probe_point point; /* Probe point */
|
|
int nargs; /* Number of arguments */
|
|
bool sdt; /* SDT/cached event flag */
|
|
bool uprobes; /* Uprobe event flag */
|
|
char *target; /* Target binary */
|
|
struct perf_probe_arg *args; /* Arguments */
|
|
struct probe_trace_event *tevs;
|
|
int ntevs;
|
|
struct nsinfo *nsi; /* Target namespace */
|
|
};
|
|
|
|
/* Line range */
|
|
struct line_range {
|
|
char *file; /* File name */
|
|
char *function; /* Function name */
|
|
int start; /* Start line number */
|
|
int end; /* End line number */
|
|
int offset; /* Start line offset */
|
|
char *path; /* Real path name */
|
|
char *comp_dir; /* Compile directory */
|
|
struct intlist *line_list; /* Visible lines */
|
|
};
|
|
|
|
struct strlist;
|
|
|
|
/* List of variables */
|
|
struct variable_list {
|
|
struct probe_trace_point point; /* Actual probepoint */
|
|
struct strlist *vars; /* Available variables */
|
|
};
|
|
|
|
struct map;
|
|
int init_probe_symbol_maps(bool user_only);
|
|
void exit_probe_symbol_maps(void);
|
|
|
|
/* Command string to events */
|
|
int parse_perf_probe_command(const char *cmd, struct perf_probe_event *pev);
|
|
int parse_probe_trace_command(const char *cmd, struct probe_trace_event *tev);
|
|
|
|
/* Events to command string */
|
|
char *synthesize_perf_probe_command(struct perf_probe_event *pev);
|
|
char *synthesize_probe_trace_command(struct probe_trace_event *tev);
|
|
char *synthesize_perf_probe_arg(struct perf_probe_arg *pa);
|
|
char *synthesize_perf_probe_point(struct perf_probe_point *pp);
|
|
|
|
int perf_probe_event__copy(struct perf_probe_event *dst,
|
|
struct perf_probe_event *src);
|
|
|
|
bool perf_probe_with_var(struct perf_probe_event *pev);
|
|
|
|
/* Check the perf_probe_event needs debuginfo */
|
|
bool perf_probe_event_need_dwarf(struct perf_probe_event *pev);
|
|
|
|
/* Release event contents */
|
|
void clear_perf_probe_event(struct perf_probe_event *pev);
|
|
void clear_probe_trace_event(struct probe_trace_event *tev);
|
|
|
|
/* Command string to line-range */
|
|
int parse_line_range_desc(const char *cmd, struct line_range *lr);
|
|
|
|
/* Release line range members */
|
|
void line_range__clear(struct line_range *lr);
|
|
|
|
/* Initialize line range */
|
|
int line_range__init(struct line_range *lr);
|
|
|
|
int add_perf_probe_events(struct perf_probe_event *pevs, int npevs);
|
|
int convert_perf_probe_events(struct perf_probe_event *pevs, int npevs);
|
|
int apply_perf_probe_events(struct perf_probe_event *pevs, int npevs);
|
|
int show_probe_trace_events(struct perf_probe_event *pevs, int npevs);
|
|
void cleanup_perf_probe_events(struct perf_probe_event *pevs, int npevs);
|
|
|
|
struct strfilter;
|
|
|
|
int del_perf_probe_events(struct strfilter *filter);
|
|
|
|
int show_perf_probe_event(const char *group, const char *event,
|
|
struct perf_probe_event *pev,
|
|
const char *module, bool use_stdout);
|
|
int show_perf_probe_events(struct strfilter *filter);
|
|
int show_line_range(struct line_range *lr, const char *module,
|
|
struct nsinfo *nsi, bool user);
|
|
int show_available_vars(struct perf_probe_event *pevs, int npevs,
|
|
struct strfilter *filter);
|
|
int show_available_funcs(const char *module, struct nsinfo *nsi,
|
|
struct strfilter *filter, bool user);
|
|
void arch__fix_tev_from_maps(struct perf_probe_event *pev,
|
|
struct probe_trace_event *tev, struct map *map,
|
|
struct symbol *sym);
|
|
|
|
/* If there is no space to write, returns -E2BIG. */
|
|
int e_snprintf(char *str, size_t size, const char *format, ...) __printf(3, 4);
|
|
|
|
/* Maximum index number of event-name postfix */
|
|
#define MAX_EVENT_INDEX 1024
|
|
|
|
int copy_to_probe_trace_arg(struct probe_trace_arg *tvar,
|
|
struct perf_probe_arg *pvar);
|
|
|
|
struct map *get_target_map(const char *target, struct nsinfo *nsi, bool user);
|
|
|
|
void arch__post_process_probe_trace_events(struct perf_probe_event *pev,
|
|
int ntevs);
|
|
|
|
#endif /*_PROBE_EVENT_H */
|