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 */
|
2007-06-04 07:59:47 +00:00
|
|
|
/*
|
|
|
|
|
* Function declerations and data structures related to the splice
|
|
|
|
|
* implementation.
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2007 Jens Axboe <jens.axboe@oracle.com>
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
#ifndef SPLICE_H
|
|
|
|
|
#define SPLICE_H
|
|
|
|
|
|
|
|
|
|
#include <linux/pipe_fs_i.h>
|
|
|
|
|
|
|
|
|
|
/*
|
2009-05-12 09:11:48 +00:00
|
|
|
* Flags passed in from splice/tee/vmsplice
|
2007-06-04 07:59:47 +00:00
|
|
|
*/
|
|
|
|
|
#define SPLICE_F_MOVE (0x01) /* move pages instead of copying */
|
|
|
|
|
#define SPLICE_F_NONBLOCK (0x02) /* don't block on the pipe splicing (but */
|
|
|
|
|
/* we may still block on the fd we splice */
|
|
|
|
|
/* from/to, of course */
|
|
|
|
|
#define SPLICE_F_MORE (0x04) /* expect more data */
|
|
|
|
|
#define SPLICE_F_GIFT (0x08) /* pages passed in are a gift */
|
|
|
|
|
|
2016-12-10 18:17:32 +00:00
|
|
|
#define SPLICE_F_ALL (SPLICE_F_MOVE|SPLICE_F_NONBLOCK|SPLICE_F_MORE|SPLICE_F_GIFT)
|
|
|
|
|
|
2007-06-04 07:59:47 +00:00
|
|
|
/*
|
|
|
|
|
* Passed to the actors
|
|
|
|
|
*/
|
|
|
|
|
struct splice_desc {
|
2014-01-28 01:07:12 +00:00
|
|
|
size_t total_len; /* remaining length */
|
|
|
|
|
unsigned int len; /* current length */
|
2007-06-04 07:59:47 +00:00
|
|
|
unsigned int flags; /* splice flags */
|
|
|
|
|
/*
|
|
|
|
|
* actor() private data
|
|
|
|
|
*/
|
|
|
|
|
union {
|
|
|
|
|
void __user *userptr; /* memory to write to */
|
|
|
|
|
struct file *file; /* file to read/write */
|
|
|
|
|
void *data; /* cookie */
|
|
|
|
|
} u;
|
|
|
|
|
loff_t pos; /* file position */
|
2013-06-20 14:58:36 +00:00
|
|
|
loff_t *opos; /* sendfile: output position */
|
2009-04-14 17:48:36 +00:00
|
|
|
size_t num_spliced; /* number of bytes already spliced */
|
|
|
|
|
bool need_wakeup; /* need to wake up writer */
|
2007-06-04 07:59:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
struct partial_page {
|
|
|
|
|
unsigned int offset;
|
|
|
|
|
unsigned int len;
|
2007-06-11 10:00:45 +00:00
|
|
|
unsigned long private;
|
2007-06-04 07:59:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Passed to splice_to_pipe
|
|
|
|
|
*/
|
|
|
|
|
struct splice_pipe_desc {
|
|
|
|
|
struct page **pages; /* page map */
|
|
|
|
|
struct partial_page *partial; /* pages[] may not be contig */
|
2012-06-12 13:24:40 +00:00
|
|
|
int nr_pages; /* number of populated pages in map */
|
|
|
|
|
unsigned int nr_pages_max; /* pages[] & partial[] arrays size */
|
2007-06-04 07:59:47 +00:00
|
|
|
const struct pipe_buf_operations *ops;/* ops associated with output pipe */
|
2007-11-07 07:29:47 +00:00
|
|
|
void (*spd_release)(struct splice_pipe_desc *, unsigned int);
|
2007-06-04 07:59:47 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef int (splice_actor)(struct pipe_inode_info *, struct pipe_buffer *,
|
|
|
|
|
struct splice_desc *);
|
|
|
|
|
typedef int (splice_direct_actor)(struct pipe_inode_info *,
|
|
|
|
|
struct splice_desc *);
|
|
|
|
|
|
|
|
|
|
extern ssize_t splice_from_pipe(struct pipe_inode_info *, struct file *,
|
|
|
|
|
loff_t *, size_t, unsigned int,
|
|
|
|
|
splice_actor *);
|
|
|
|
|
extern ssize_t __splice_from_pipe(struct pipe_inode_info *,
|
|
|
|
|
struct splice_desc *, splice_actor *);
|
|
|
|
|
extern ssize_t splice_to_pipe(struct pipe_inode_info *,
|
|
|
|
|
struct splice_pipe_desc *);
|
2016-09-18 02:38:20 +00:00
|
|
|
extern ssize_t add_to_pipe(struct pipe_inode_info *,
|
|
|
|
|
struct pipe_buffer *);
|
2007-06-04 07:59:47 +00:00
|
|
|
extern ssize_t splice_direct_to_actor(struct file *, struct splice_desc *,
|
|
|
|
|
splice_direct_actor *);
|
|
|
|
|
|
2010-05-20 08:43:18 +00:00
|
|
|
/*
|
|
|
|
|
* for dynamic pipe sizing
|
|
|
|
|
*/
|
2012-06-12 13:24:40 +00:00
|
|
|
extern int splice_grow_spd(const struct pipe_inode_info *, struct splice_pipe_desc *);
|
|
|
|
|
extern void splice_shrink_spd(struct splice_pipe_desc *);
|
2010-05-20 08:43:18 +00:00
|
|
|
|
2011-07-26 00:12:32 +00:00
|
|
|
extern const struct pipe_buf_operations page_cache_pipe_buf_ops;
|
2016-09-22 20:33:12 +00:00
|
|
|
extern const struct pipe_buf_operations default_pipe_buf_ops;
|
2007-06-04 07:59:47 +00:00
|
|
|
#endif
|