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_PIPE_FS_I_H
|
|
|
|
#define _LINUX_PIPE_FS_I_H
|
|
|
|
|
2010-05-20 08:43:18 +00:00
|
|
|
#define PIPE_DEF_BUFFERS 16
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2006-05-03 08:35:26 +00:00
|
|
|
#define PIPE_BUF_FLAG_LRU 0x01 /* page is on the LRU */
|
|
|
|
#define PIPE_BUF_FLAG_ATOMIC 0x02 /* was atomically mapped */
|
|
|
|
#define PIPE_BUF_FLAG_GIFT 0x04 /* page is a gift */
|
pipes: add a "packetized pipe" mode for writing
The actual internal pipe implementation is already really about
individual packets (called "pipe buffers"), and this simply exposes that
as a special packetized mode.
When we are in the packetized mode (marked by O_DIRECT as suggested by
Alan Cox), a write() on a pipe will not merge the new data with previous
writes, so each write will get a pipe buffer of its own. The pipe
buffer is then marked with the PIPE_BUF_FLAG_PACKET flag, which in turn
will tell the reader side to break the read at that boundary (and throw
away any partial packet contents that do not fit in the read buffer).
End result: as long as you do writes less than PIPE_BUF in size (so that
the pipe doesn't have to split them up), you can now treat the pipe as a
packet interface, where each read() system call will read one packet at
a time. You can just use a sufficiently big read buffer (PIPE_BUF is
sufficient, since bigger than that doesn't guarantee atomicity anyway),
and the return value of the read() will naturally give you the size of
the packet.
NOTE! We do not support zero-sized packets, and zero-sized reads and
writes to a pipe continue to be no-ops. Also note that big packets will
currently be split at write time, but that the size at which that
happens is not really specified (except that it's bigger than PIPE_BUF).
Currently that limit is the system page size, but we might want to
explicitly support bigger packets some day.
The main user for this is going to be the autofs packet interface,
allowing us to stop having to care so deeply about exact packet sizes
(which have had bugs with 32/64-bit compatibility modes). But user
space can create packetized pipes with "pipe2(fd, O_DIRECT)", which will
fail with an EINVAL on kernels that do not support this interface.
Tested-by: Michael Tokarev <mjt@tls.msk.ru>
Cc: Alan Cox <alan@lxorguk.ukuu.org.uk>
Cc: David Miller <davem@davemloft.net>
Cc: Ian Kent <raven@themaw.net>
Cc: Thomas Meyer <thomas@m3y3r.de>
Cc: stable@kernel.org # needed for systemd/autofs interaction fix
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2012-04-29 20:12:42 +00:00
|
|
|
#define PIPE_BUF_FLAG_PACKET 0x08 /* read() as a packet */
|
2006-04-02 21:11:04 +00:00
|
|
|
|
2007-06-12 18:51:32 +00:00
|
|
|
/**
|
|
|
|
* struct pipe_buffer - a linux kernel pipe buffer
|
|
|
|
* @page: the page containing the data for the pipe buffer
|
|
|
|
* @offset: offset of data inside the @page
|
|
|
|
* @len: length of data inside the @page
|
|
|
|
* @ops: operations associated with this buffer. See @pipe_buf_operations.
|
|
|
|
* @flags: pipe buffer flags. See above.
|
|
|
|
* @private: private data owned by the ops.
|
|
|
|
**/
|
2005-04-16 22:20:36 +00:00
|
|
|
struct pipe_buffer {
|
|
|
|
struct page *page;
|
|
|
|
unsigned int offset, len;
|
2006-12-13 08:34:04 +00:00
|
|
|
const struct pipe_buf_operations *ops;
|
2006-04-02 21:11:04 +00:00
|
|
|
unsigned int flags;
|
2007-06-11 10:00:45 +00:00
|
|
|
unsigned long private;
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
2007-06-12 18:51:32 +00:00
|
|
|
/**
|
|
|
|
* struct pipe_inode_info - a linux kernel pipe
|
2013-03-21 06:32:24 +00:00
|
|
|
* @mutex: mutex protecting the whole thing
|
2007-06-12 18:51:32 +00:00
|
|
|
* @wait: reader/writer wait point in case of empty/full pipe
|
|
|
|
* @nrbufs: the number of non-empty pipe buffers in this pipe
|
2011-01-09 03:40:33 +00:00
|
|
|
* @buffers: total number of buffers (should be a power of 2)
|
2007-06-12 18:51:32 +00:00
|
|
|
* @curbuf: the current pipe buffer entry
|
|
|
|
* @tmp_page: cached released page
|
|
|
|
* @readers: number of current readers of this pipe
|
|
|
|
* @writers: number of current writers of this pipe
|
2014-02-18 13:54:36 +00:00
|
|
|
* @files: number of struct file referring this pipe (protected by ->i_lock)
|
2007-06-12 18:51:32 +00:00
|
|
|
* @waiting_writers: number of writers blocked waiting for room
|
|
|
|
* @r_counter: reader counter
|
|
|
|
* @w_counter: writer counter
|
|
|
|
* @fasync_readers: reader side fasync
|
|
|
|
* @fasync_writers: writer side fasync
|
|
|
|
* @bufs: the circular array of pipe buffers
|
2016-01-18 15:36:09 +00:00
|
|
|
* @user: the user who created this pipe
|
2007-06-12 18:51:32 +00:00
|
|
|
**/
|
2007-06-04 13:03:12 +00:00
|
|
|
struct pipe_inode_info {
|
2013-03-21 06:32:24 +00:00
|
|
|
struct mutex mutex;
|
2007-06-04 13:03:12 +00:00
|
|
|
wait_queue_head_t wait;
|
2010-05-20 08:43:18 +00:00
|
|
|
unsigned int nrbufs, curbuf, buffers;
|
2007-06-04 13:03:12 +00:00
|
|
|
unsigned int readers;
|
|
|
|
unsigned int writers;
|
2013-03-21 06:21:19 +00:00
|
|
|
unsigned int files;
|
2007-06-04 13:03:12 +00:00
|
|
|
unsigned int waiting_writers;
|
|
|
|
unsigned int r_counter;
|
|
|
|
unsigned int w_counter;
|
2010-05-20 08:43:18 +00:00
|
|
|
struct page *tmp_page;
|
2007-06-04 13:03:12 +00:00
|
|
|
struct fasync_struct *fasync_readers;
|
|
|
|
struct fasync_struct *fasync_writers;
|
2010-05-20 08:43:18 +00:00
|
|
|
struct pipe_buffer *bufs;
|
2016-01-18 15:36:09 +00:00
|
|
|
struct user_struct *user;
|
2007-06-04 13:03:12 +00:00
|
|
|
};
|
|
|
|
|
2006-05-01 17:59:03 +00:00
|
|
|
/*
|
|
|
|
* Note on the nesting of these functions:
|
|
|
|
*
|
2007-06-14 11:10:48 +00:00
|
|
|
* ->confirm()
|
2006-05-01 17:59:03 +00:00
|
|
|
* ->steal()
|
|
|
|
*
|
2016-09-27 08:45:13 +00:00
|
|
|
* That is, ->steal() must be called on a confirmed buffer.
|
|
|
|
* See below for the meaning of each operation. Also see kerneldoc
|
|
|
|
* in fs/pipe.c for the pipe and generic variants of these hooks.
|
2006-05-01 17:59:03 +00:00
|
|
|
*/
|
2005-04-16 22:20:36 +00:00
|
|
|
struct pipe_buf_operations {
|
2007-06-12 18:51:32 +00:00
|
|
|
/*
|
|
|
|
* ->confirm() verifies that the data in the pipe buffer is there
|
|
|
|
* and that the contents are good. If the pages in the pipe belong
|
|
|
|
* to a file system, we may need to wait for IO completion in this
|
|
|
|
* hook. Returns 0 for good, or a negative error value in case of
|
|
|
|
* error.
|
|
|
|
*/
|
2007-06-14 11:10:48 +00:00
|
|
|
int (*confirm)(struct pipe_inode_info *, struct pipe_buffer *);
|
2007-06-12 18:51:32 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* When the contents of this pipe buffer has been completely
|
|
|
|
* consumed by a reader, ->release() is called.
|
|
|
|
*/
|
2005-04-16 22:20:36 +00:00
|
|
|
void (*release)(struct pipe_inode_info *, struct pipe_buffer *);
|
2007-06-12 18:51:32 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Attempt to take ownership of the pipe buffer and its contents.
|
|
|
|
* ->steal() returns 0 for success, in which case the contents
|
|
|
|
* of the pipe (the buf->page) is locked and now completely owned
|
|
|
|
* by the caller. The page may then be transferred to a different
|
|
|
|
* mapping, the most often used case is insertion into different
|
|
|
|
* file address space cache.
|
|
|
|
*/
|
2006-03-30 13:16:46 +00:00
|
|
|
int (*steal)(struct pipe_inode_info *, struct pipe_buffer *);
|
2007-06-12 18:51:32 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Get a reference to the pipe buffer.
|
|
|
|
*/
|
2019-04-05 21:02:10 +00:00
|
|
|
bool (*get)(struct pipe_inode_info *, struct pipe_buffer *);
|
2005-04-16 22:20:36 +00:00
|
|
|
};
|
|
|
|
|
2016-09-27 08:45:12 +00:00
|
|
|
/**
|
|
|
|
* pipe_buf_get - get a reference to a pipe_buffer
|
|
|
|
* @pipe: the pipe that the buffer belongs to
|
|
|
|
* @buf: the buffer to get a reference to
|
2019-04-05 21:02:10 +00:00
|
|
|
*
|
|
|
|
* Return: %true if the reference was successfully obtained.
|
2016-09-27 08:45:12 +00:00
|
|
|
*/
|
2019-04-05 21:02:10 +00:00
|
|
|
static inline __must_check bool pipe_buf_get(struct pipe_inode_info *pipe,
|
2016-09-27 08:45:12 +00:00
|
|
|
struct pipe_buffer *buf)
|
|
|
|
{
|
2019-04-05 21:02:10 +00:00
|
|
|
return buf->ops->get(pipe, buf);
|
2016-09-27 08:45:12 +00:00
|
|
|
}
|
|
|
|
|
2016-09-27 08:45:12 +00:00
|
|
|
/**
|
|
|
|
* pipe_buf_release - put a reference to a pipe_buffer
|
|
|
|
* @pipe: the pipe that the buffer belongs to
|
|
|
|
* @buf: the buffer to put a reference to
|
|
|
|
*/
|
|
|
|
static inline void pipe_buf_release(struct pipe_inode_info *pipe,
|
|
|
|
struct pipe_buffer *buf)
|
|
|
|
{
|
|
|
|
const struct pipe_buf_operations *ops = buf->ops;
|
|
|
|
|
|
|
|
buf->ops = NULL;
|
|
|
|
ops->release(pipe, buf);
|
|
|
|
}
|
|
|
|
|
2016-09-27 08:45:12 +00:00
|
|
|
/**
|
|
|
|
* pipe_buf_confirm - verify contents of the pipe buffer
|
|
|
|
* @pipe: the pipe that the buffer belongs to
|
|
|
|
* @buf: the buffer to confirm
|
|
|
|
*/
|
|
|
|
static inline int pipe_buf_confirm(struct pipe_inode_info *pipe,
|
|
|
|
struct pipe_buffer *buf)
|
|
|
|
{
|
|
|
|
return buf->ops->confirm(pipe, buf);
|
|
|
|
}
|
|
|
|
|
2016-09-27 08:45:12 +00:00
|
|
|
/**
|
|
|
|
* pipe_buf_steal - attempt to take ownership of a pipe_buffer
|
|
|
|
* @pipe: the pipe that the buffer belongs to
|
|
|
|
* @buf: the buffer to attempt to steal
|
|
|
|
*/
|
|
|
|
static inline int pipe_buf_steal(struct pipe_inode_info *pipe,
|
|
|
|
struct pipe_buffer *buf)
|
|
|
|
{
|
|
|
|
return buf->ops->steal(pipe, buf);
|
|
|
|
}
|
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/* Differs from PIPE_BUF in that PIPE_SIZE is the length of the actual
|
|
|
|
memory allocation, whereas PIPE_BUF makes atomicity guarantees. */
|
|
|
|
#define PIPE_SIZE PAGE_SIZE
|
|
|
|
|
2009-04-14 17:48:41 +00:00
|
|
|
/* Pipe lock and unlock operations */
|
|
|
|
void pipe_lock(struct pipe_inode_info *);
|
|
|
|
void pipe_unlock(struct pipe_inode_info *);
|
|
|
|
void pipe_double_lock(struct pipe_inode_info *, struct pipe_inode_info *);
|
|
|
|
|
2018-02-06 23:41:45 +00:00
|
|
|
extern unsigned int pipe_max_size;
|
2016-01-18 15:36:09 +00:00
|
|
|
extern unsigned long pipe_user_pages_hard;
|
|
|
|
extern unsigned long pipe_user_pages_soft;
|
2010-06-03 12:54:39 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
/* Drop the inode semaphore and wait for a pipe event, atomically */
|
2006-04-10 13:18:35 +00:00
|
|
|
void pipe_wait(struct pipe_inode_info *pipe);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2013-03-21 15:04:15 +00:00
|
|
|
struct pipe_inode_info *alloc_pipe_info(void);
|
2013-03-21 15:06:46 +00:00
|
|
|
void free_pipe_info(struct pipe_inode_info *);
|
2005-04-16 22:20:36 +00:00
|
|
|
|
2006-05-01 17:59:03 +00:00
|
|
|
/* Generic pipe buffer ops functions */
|
2019-04-05 21:02:10 +00:00
|
|
|
bool generic_pipe_buf_get(struct pipe_inode_info *, struct pipe_buffer *);
|
2007-06-14 11:10:48 +00:00
|
|
|
int generic_pipe_buf_confirm(struct pipe_inode_info *, struct pipe_buffer *);
|
2006-05-02 13:29:57 +00:00
|
|
|
int generic_pipe_buf_steal(struct pipe_inode_info *, struct pipe_buffer *);
|
2019-04-04 21:59:25 +00:00
|
|
|
int generic_pipe_buf_nosteal(struct pipe_inode_info *, struct pipe_buffer *);
|
2009-05-07 13:37:36 +00:00
|
|
|
void generic_pipe_buf_release(struct pipe_inode_info *, struct pipe_buffer *);
|
splice: don't merge into linked buffers
Before this patch, it was possible for two pipes to affect each other after
data had been transferred between them with tee():
============
$ cat tee_test.c
int main(void) {
int pipe_a[2];
if (pipe(pipe_a)) err(1, "pipe");
int pipe_b[2];
if (pipe(pipe_b)) err(1, "pipe");
if (write(pipe_a[1], "abcd", 4) != 4) err(1, "write");
if (tee(pipe_a[0], pipe_b[1], 2, 0) != 2) err(1, "tee");
if (write(pipe_b[1], "xx", 2) != 2) err(1, "write");
char buf[5];
if (read(pipe_a[0], buf, 4) != 4) err(1, "read");
buf[4] = 0;
printf("got back: '%s'\n", buf);
}
$ gcc -o tee_test tee_test.c
$ ./tee_test
got back: 'abxx'
$
============
As suggested by Al Viro, fix it by creating a separate type for
non-mergeable pipe buffers, then changing the types of buffers in
splice_pipe_to_pipe() and link_pipe().
Cc: <stable@vger.kernel.org>
Fixes: 7c77f0b3f920 ("splice: implement pipe to pipe splicing")
Fixes: 70524490ee2e ("[PATCH] splice: add support for sys_tee()")
Suggested-by: Al Viro <viro@zeniv.linux.org.uk>
Signed-off-by: Jann Horn <jannh@google.com>
Signed-off-by: Al Viro <viro@zeniv.linux.org.uk>
2019-01-23 14:19:17 +00:00
|
|
|
void pipe_buf_mark_unmergeable(struct pipe_buffer *buf);
|
2006-05-01 17:59:03 +00:00
|
|
|
|
2014-01-22 18:36:57 +00:00
|
|
|
extern const struct pipe_buf_operations nosteal_pipe_buf_ops;
|
|
|
|
|
2010-05-20 08:43:18 +00:00
|
|
|
/* for F_SETPIPE_SZ and F_GETPIPE_SZ */
|
|
|
|
long pipe_fcntl(struct file *, unsigned int, unsigned long arg);
|
2010-11-29 00:27:19 +00:00
|
|
|
struct pipe_inode_info *get_pipe_info(struct file *file);
|
2010-11-28 22:09:57 +00:00
|
|
|
|
2012-07-21 11:33:25 +00:00
|
|
|
int create_pipe_files(struct file **, int);
|
2018-02-06 23:42:00 +00:00
|
|
|
unsigned int round_pipe_size(unsigned long size);
|
2012-07-21 11:33:25 +00:00
|
|
|
|
2005-04-16 22:20:36 +00:00
|
|
|
#endif
|