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 21:07:57 +07:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2006-03-21 01:44:22 +07:00
|
|
|
/*
|
|
|
|
|
* linux/include/linux/sunrpc/metrics.h
|
|
|
|
|
*
|
|
|
|
|
* Declarations for RPC client per-operation metrics
|
|
|
|
|
*
|
|
|
|
|
* Copyright (C) 2005 Chuck Lever <cel@netapp.com>
|
|
|
|
|
*
|
|
|
|
|
* RPC client per-operation statistics provide latency and retry
|
|
|
|
|
* information about each type of RPC procedure in a given RPC program.
|
|
|
|
|
* These statistics are not for detailed problem diagnosis, but simply
|
|
|
|
|
* to indicate whether the problem is local or remote.
|
|
|
|
|
*
|
|
|
|
|
* These counters are not meant to be human-readable, but are meant to be
|
|
|
|
|
* integrated into system monitoring tools such as "sar" and "iostat". As
|
|
|
|
|
* such, the counters are sampled by the tools over time, and are never
|
|
|
|
|
* zeroed after a file system is mounted. Moving averages can be computed
|
|
|
|
|
* by the tools by taking the difference between two instantaneous samples
|
|
|
|
|
* and dividing that by the time between the samples.
|
|
|
|
|
*
|
|
|
|
|
* The counters are maintained in a single array per RPC client, indexed
|
|
|
|
|
* by procedure number. There is no need to maintain separate counter
|
|
|
|
|
* arrays per-CPU because these counters are always modified behind locks.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _LINUX_SUNRPC_METRICS_H
|
|
|
|
|
#define _LINUX_SUNRPC_METRICS_H
|
|
|
|
|
|
|
|
|
|
#include <linux/seq_file.h>
|
2010-05-08 00:34:47 +07:00
|
|
|
#include <linux/ktime.h>
|
2014-11-09 08:15:09 +07:00
|
|
|
#include <linux/spinlock.h>
|
2006-03-21 01:44:22 +07:00
|
|
|
|
|
|
|
|
#define RPC_IOSTATS_VERS "1.0"
|
|
|
|
|
|
|
|
|
|
struct rpc_iostats {
|
2014-11-09 08:15:09 +07:00
|
|
|
spinlock_t om_lock;
|
|
|
|
|
|
2006-03-21 01:44:22 +07:00
|
|
|
/*
|
|
|
|
|
* These counters give an idea about how many request
|
|
|
|
|
* transmissions are required, on average, to complete that
|
|
|
|
|
* particular procedure. Some procedures may require more
|
|
|
|
|
* than one transmission because the server is unresponsive,
|
|
|
|
|
* the client is retransmitting too aggressively, or the
|
|
|
|
|
* requests are large and the network is congested.
|
|
|
|
|
*/
|
|
|
|
|
unsigned long om_ops, /* count of operations */
|
|
|
|
|
om_ntrans, /* count of RPC transmissions */
|
|
|
|
|
om_timeouts; /* count of major timeouts */
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* These count how many bytes are sent and received for a
|
|
|
|
|
* given RPC procedure type. This indicates how much load a
|
|
|
|
|
* particular procedure is putting on the network. These
|
|
|
|
|
* counts include the RPC and ULP headers, and the request
|
|
|
|
|
* payload.
|
|
|
|
|
*/
|
|
|
|
|
unsigned long long om_bytes_sent, /* count of bytes out */
|
|
|
|
|
om_bytes_recv; /* count of bytes in */
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* The length of time an RPC request waits in queue before
|
|
|
|
|
* transmission, the network + server latency of the request,
|
|
|
|
|
* and the total time the request spent from init to release
|
|
|
|
|
* are measured.
|
|
|
|
|
*/
|
2010-05-08 00:34:47 +07:00
|
|
|
ktime_t om_queue, /* queued for xmit */
|
|
|
|
|
om_rtt, /* RPC RTT */
|
|
|
|
|
om_execute; /* RPC execution */
|
2006-03-21 01:44:22 +07:00
|
|
|
} ____cacheline_aligned;
|
|
|
|
|
|
|
|
|
|
struct rpc_task;
|
|
|
|
|
struct rpc_clnt;
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* EXPORTed functions for managing rpc_iostats structures
|
|
|
|
|
*/
|
2006-04-19 00:14:13 +07:00
|
|
|
|
|
|
|
|
#ifdef CONFIG_PROC_FS
|
|
|
|
|
|
2006-03-21 01:44:22 +07:00
|
|
|
struct rpc_iostats * rpc_alloc_iostats(struct rpc_clnt *);
|
2012-02-18 01:15:24 +07:00
|
|
|
void rpc_count_iostats(const struct rpc_task *,
|
|
|
|
|
struct rpc_iostats *);
|
2014-06-24 21:59:52 +07:00
|
|
|
void rpc_count_iostats_metrics(const struct rpc_task *,
|
|
|
|
|
struct rpc_iostats *);
|
sunrpc: Change rpc_print_iostats to rpc_clnt_show_stats and handle rpc_clnt clones
The existing rpc_print_iostats has a few shortcomings. First, the naming
is not consistent with other functions in the kernel that display stats.
Second, it is really displaying stats for an rpc_clnt structure as it
displays both xprt stats and per-op stats. Third, it does not handle
rpc_clnt clones, which is important for the one in-kernel tree caller
of this function, the NFS client's nfs_show_stats function.
Fix all of the above by renaming the rpc_print_iostats to
rpc_clnt_show_stats and looping through any rpc_clnt clones via
cl_parent.
Once this interface is fixed, this addresses a problem with NFSv4.
Before this patch, the /proc/self/mountstats always showed incorrect
counts for NFSv4 lease and session related opcodes such as SEQUENCE,
RENEW, SETCLIENTID, CREATE_SESSION, etc. These counts were always 0
even though many ops would go over the wire. The reason for this is
there are multiple rpc_clnt structures allocated for any given NFSv4
mount, and inside nfs_show_stats() we callled into rpc_print_iostats()
which only handled one of them, nfs_server->client. Fix these counts
by calling sunrpc's new rpc_clnt_show_stats() function, which handles
cloned rpc_clnt structs and prints the stats together.
Note that one side-effect of the above is that multiple mounts from
the same NFS server will show identical counts in the above ops due
to the fact the one rpc_clnt (representing the NFSv4 client state)
is shared across mounts.
Signed-off-by: Dave Wysochanski <dwysocha@redhat.com>
Signed-off-by: Anna Schumaker <Anna.Schumaker@Netapp.com>
2018-07-31 21:10:51 +07:00
|
|
|
void rpc_clnt_show_stats(struct seq_file *, struct rpc_clnt *);
|
2006-03-21 01:44:22 +07:00
|
|
|
void rpc_free_iostats(struct rpc_iostats *);
|
|
|
|
|
|
2006-04-19 00:14:13 +07:00
|
|
|
#else /* CONFIG_PROC_FS */
|
|
|
|
|
|
|
|
|
|
static inline struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt) { return NULL; }
|
2012-02-18 01:15:24 +07:00
|
|
|
static inline void rpc_count_iostats(const struct rpc_task *task,
|
|
|
|
|
struct rpc_iostats *stats) {}
|
2015-02-12 20:28:12 +07:00
|
|
|
static inline void rpc_count_iostats_metrics(const struct rpc_task *task,
|
|
|
|
|
struct rpc_iostats *stats)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
sunrpc: Change rpc_print_iostats to rpc_clnt_show_stats and handle rpc_clnt clones
The existing rpc_print_iostats has a few shortcomings. First, the naming
is not consistent with other functions in the kernel that display stats.
Second, it is really displaying stats for an rpc_clnt structure as it
displays both xprt stats and per-op stats. Third, it does not handle
rpc_clnt clones, which is important for the one in-kernel tree caller
of this function, the NFS client's nfs_show_stats function.
Fix all of the above by renaming the rpc_print_iostats to
rpc_clnt_show_stats and looping through any rpc_clnt clones via
cl_parent.
Once this interface is fixed, this addresses a problem with NFSv4.
Before this patch, the /proc/self/mountstats always showed incorrect
counts for NFSv4 lease and session related opcodes such as SEQUENCE,
RENEW, SETCLIENTID, CREATE_SESSION, etc. These counts were always 0
even though many ops would go over the wire. The reason for this is
there are multiple rpc_clnt structures allocated for any given NFSv4
mount, and inside nfs_show_stats() we callled into rpc_print_iostats()
which only handled one of them, nfs_server->client. Fix these counts
by calling sunrpc's new rpc_clnt_show_stats() function, which handles
cloned rpc_clnt structs and prints the stats together.
Note that one side-effect of the above is that multiple mounts from
the same NFS server will show identical counts in the above ops due
to the fact the one rpc_clnt (representing the NFSv4 client state)
is shared across mounts.
Signed-off-by: Dave Wysochanski <dwysocha@redhat.com>
Signed-off-by: Anna Schumaker <Anna.Schumaker@Netapp.com>
2018-07-31 21:10:51 +07:00
|
|
|
static inline void rpc_clnt_show_stats(struct seq_file *seq, struct rpc_clnt *clnt) {}
|
2006-04-19 00:14:13 +07:00
|
|
|
static inline void rpc_free_iostats(struct rpc_iostats *stats) {}
|
|
|
|
|
|
|
|
|
|
#endif /* CONFIG_PROC_FS */
|
|
|
|
|
|
2006-03-21 01:44:22 +07:00
|
|
|
#endif /* _LINUX_SUNRPC_METRICS_H */
|