mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-04 18:09:57 +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>
179 lines
4.7 KiB
C
179 lines
4.7 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef __LINUX_TEXTSEARCH_H
|
|
#define __LINUX_TEXTSEARCH_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/list.h>
|
|
#include <linux/kernel.h>
|
|
#include <linux/err.h>
|
|
#include <linux/slab.h>
|
|
|
|
struct module;
|
|
|
|
struct ts_config;
|
|
|
|
#define TS_AUTOLOAD 1 /* Automatically load textsearch modules when needed */
|
|
#define TS_IGNORECASE 2 /* Searches string case insensitively */
|
|
|
|
/**
|
|
* struct ts_state - search state
|
|
* @offset: offset for next match
|
|
* @cb: control buffer, for persistent variables of get_next_block()
|
|
*/
|
|
struct ts_state
|
|
{
|
|
unsigned int offset;
|
|
char cb[40];
|
|
};
|
|
|
|
/**
|
|
* struct ts_ops - search module operations
|
|
* @name: name of search algorithm
|
|
* @init: initialization function to prepare a search
|
|
* @find: find the next occurrence of the pattern
|
|
* @destroy: destroy algorithm specific parts of a search configuration
|
|
* @get_pattern: return head of pattern
|
|
* @get_pattern_len: return length of pattern
|
|
* @owner: module reference to algorithm
|
|
*/
|
|
struct ts_ops
|
|
{
|
|
const char *name;
|
|
struct ts_config * (*init)(const void *, unsigned int, gfp_t, int);
|
|
unsigned int (*find)(struct ts_config *,
|
|
struct ts_state *);
|
|
void (*destroy)(struct ts_config *);
|
|
void * (*get_pattern)(struct ts_config *);
|
|
unsigned int (*get_pattern_len)(struct ts_config *);
|
|
struct module *owner;
|
|
struct list_head list;
|
|
};
|
|
|
|
/**
|
|
* struct ts_config - search configuration
|
|
* @ops: operations of chosen algorithm
|
|
* @flags: flags
|
|
* @get_next_block: callback to fetch the next block to search in
|
|
* @finish: callback to finalize a search
|
|
*/
|
|
struct ts_config
|
|
{
|
|
struct ts_ops *ops;
|
|
int flags;
|
|
|
|
/**
|
|
* get_next_block - fetch next block of data
|
|
* @consumed: number of bytes consumed by the caller
|
|
* @dst: destination buffer
|
|
* @conf: search configuration
|
|
* @state: search state
|
|
*
|
|
* Called repeatedly until 0 is returned. Must assign the
|
|
* head of the next block of data to &*dst and return the length
|
|
* of the block or 0 if at the end. consumed == 0 indicates
|
|
* a new search. May store/read persistent values in state->cb.
|
|
*/
|
|
unsigned int (*get_next_block)(unsigned int consumed,
|
|
const u8 **dst,
|
|
struct ts_config *conf,
|
|
struct ts_state *state);
|
|
|
|
/**
|
|
* finish - finalize/clean a series of get_next_block() calls
|
|
* @conf: search configuration
|
|
* @state: search state
|
|
*
|
|
* Called after the last use of get_next_block(), may be used
|
|
* to cleanup any leftovers.
|
|
*/
|
|
void (*finish)(struct ts_config *conf,
|
|
struct ts_state *state);
|
|
};
|
|
|
|
/**
|
|
* textsearch_next - continue searching for a pattern
|
|
* @conf: search configuration
|
|
* @state: search state
|
|
*
|
|
* Continues a search looking for more occurrences of the pattern.
|
|
* textsearch_find() must be called to find the first occurrence
|
|
* in order to reset the state.
|
|
*
|
|
* Returns the position of the next occurrence of the pattern or
|
|
* UINT_MAX if not match was found.
|
|
*/
|
|
static inline unsigned int textsearch_next(struct ts_config *conf,
|
|
struct ts_state *state)
|
|
{
|
|
unsigned int ret = conf->ops->find(conf, state);
|
|
|
|
if (conf->finish)
|
|
conf->finish(conf, state);
|
|
|
|
return ret;
|
|
}
|
|
|
|
/**
|
|
* textsearch_find - start searching for a pattern
|
|
* @conf: search configuration
|
|
* @state: search state
|
|
*
|
|
* Returns the position of first occurrence of the pattern or
|
|
* UINT_MAX if no match was found.
|
|
*/
|
|
static inline unsigned int textsearch_find(struct ts_config *conf,
|
|
struct ts_state *state)
|
|
{
|
|
state->offset = 0;
|
|
return textsearch_next(conf, state);
|
|
}
|
|
|
|
/**
|
|
* textsearch_get_pattern - return head of the pattern
|
|
* @conf: search configuration
|
|
*/
|
|
static inline void *textsearch_get_pattern(struct ts_config *conf)
|
|
{
|
|
return conf->ops->get_pattern(conf);
|
|
}
|
|
|
|
/**
|
|
* textsearch_get_pattern_len - return length of the pattern
|
|
* @conf: search configuration
|
|
*/
|
|
static inline unsigned int textsearch_get_pattern_len(struct ts_config *conf)
|
|
{
|
|
return conf->ops->get_pattern_len(conf);
|
|
}
|
|
|
|
extern int textsearch_register(struct ts_ops *);
|
|
extern int textsearch_unregister(struct ts_ops *);
|
|
extern struct ts_config *textsearch_prepare(const char *, const void *,
|
|
unsigned int, gfp_t, int);
|
|
extern void textsearch_destroy(struct ts_config *conf);
|
|
extern unsigned int textsearch_find_continuous(struct ts_config *,
|
|
struct ts_state *,
|
|
const void *, unsigned int);
|
|
|
|
|
|
#define TS_PRIV_ALIGNTO 8
|
|
#define TS_PRIV_ALIGN(len) (((len) + TS_PRIV_ALIGNTO-1) & ~(TS_PRIV_ALIGNTO-1))
|
|
|
|
static inline struct ts_config *alloc_ts_config(size_t payload,
|
|
gfp_t gfp_mask)
|
|
{
|
|
struct ts_config *conf;
|
|
|
|
conf = kzalloc(TS_PRIV_ALIGN(sizeof(*conf)) + payload, gfp_mask);
|
|
if (conf == NULL)
|
|
return ERR_PTR(-ENOMEM);
|
|
|
|
return conf;
|
|
}
|
|
|
|
static inline void *ts_config_priv(struct ts_config *conf)
|
|
{
|
|
return ((u8 *) conf + TS_PRIV_ALIGN(sizeof(struct ts_config)));
|
|
}
|
|
|
|
#endif
|