mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-09-12 05:48:40 +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>
341 lines
9.3 KiB
C
341 lines
9.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/*
|
|
* Block data types and constants. Directly include this file only to
|
|
* break include dependency loop.
|
|
*/
|
|
#ifndef __LINUX_BLK_TYPES_H
|
|
#define __LINUX_BLK_TYPES_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/bvec.h>
|
|
|
|
struct bio_set;
|
|
struct bio;
|
|
struct bio_integrity_payload;
|
|
struct page;
|
|
struct block_device;
|
|
struct io_context;
|
|
struct cgroup_subsys_state;
|
|
typedef void (bio_end_io_t) (struct bio *);
|
|
|
|
/*
|
|
* Block error status values. See block/blk-core:blk_errors for the details.
|
|
*/
|
|
typedef u8 __bitwise blk_status_t;
|
|
#define BLK_STS_OK 0
|
|
#define BLK_STS_NOTSUPP ((__force blk_status_t)1)
|
|
#define BLK_STS_TIMEOUT ((__force blk_status_t)2)
|
|
#define BLK_STS_NOSPC ((__force blk_status_t)3)
|
|
#define BLK_STS_TRANSPORT ((__force blk_status_t)4)
|
|
#define BLK_STS_TARGET ((__force blk_status_t)5)
|
|
#define BLK_STS_NEXUS ((__force blk_status_t)6)
|
|
#define BLK_STS_MEDIUM ((__force blk_status_t)7)
|
|
#define BLK_STS_PROTECTION ((__force blk_status_t)8)
|
|
#define BLK_STS_RESOURCE ((__force blk_status_t)9)
|
|
#define BLK_STS_IOERR ((__force blk_status_t)10)
|
|
|
|
/* hack for device mapper, don't use elsewhere: */
|
|
#define BLK_STS_DM_REQUEUE ((__force blk_status_t)11)
|
|
|
|
#define BLK_STS_AGAIN ((__force blk_status_t)12)
|
|
|
|
struct blk_issue_stat {
|
|
u64 stat;
|
|
};
|
|
|
|
/*
|
|
* main unit of I/O for the block layer and lower layers (ie drivers and
|
|
* stacking drivers)
|
|
*/
|
|
struct bio {
|
|
struct bio *bi_next; /* request queue link */
|
|
struct gendisk *bi_disk;
|
|
u8 bi_partno;
|
|
blk_status_t bi_status;
|
|
unsigned int bi_opf; /* bottom bits req flags,
|
|
* top bits REQ_OP. Use
|
|
* accessors.
|
|
*/
|
|
unsigned short bi_flags; /* status, etc and bvec pool number */
|
|
unsigned short bi_ioprio;
|
|
unsigned short bi_write_hint;
|
|
|
|
struct bvec_iter bi_iter;
|
|
|
|
/* Number of segments in this BIO after
|
|
* physical address coalescing is performed.
|
|
*/
|
|
unsigned int bi_phys_segments;
|
|
|
|
/*
|
|
* To keep track of the max segment size, we account for the
|
|
* sizes of the first and last mergeable segments in this bio.
|
|
*/
|
|
unsigned int bi_seg_front_size;
|
|
unsigned int bi_seg_back_size;
|
|
|
|
atomic_t __bi_remaining;
|
|
|
|
bio_end_io_t *bi_end_io;
|
|
|
|
void *bi_private;
|
|
#ifdef CONFIG_BLK_CGROUP
|
|
/*
|
|
* Optional ioc and css associated with this bio. Put on bio
|
|
* release. Read comment on top of bio_associate_current().
|
|
*/
|
|
struct io_context *bi_ioc;
|
|
struct cgroup_subsys_state *bi_css;
|
|
#ifdef CONFIG_BLK_DEV_THROTTLING_LOW
|
|
void *bi_cg_private;
|
|
struct blk_issue_stat bi_issue_stat;
|
|
#endif
|
|
#endif
|
|
union {
|
|
#if defined(CONFIG_BLK_DEV_INTEGRITY)
|
|
struct bio_integrity_payload *bi_integrity; /* data integrity */
|
|
#endif
|
|
};
|
|
|
|
unsigned short bi_vcnt; /* how many bio_vec's */
|
|
|
|
/*
|
|
* Everything starting with bi_max_vecs will be preserved by bio_reset()
|
|
*/
|
|
|
|
unsigned short bi_max_vecs; /* max bvl_vecs we can hold */
|
|
|
|
atomic_t __bi_cnt; /* pin count */
|
|
|
|
struct bio_vec *bi_io_vec; /* the actual vec list */
|
|
|
|
struct bio_set *bi_pool;
|
|
|
|
/*
|
|
* We can inline a number of vecs at the end of the bio, to avoid
|
|
* double allocations for a small number of bio_vecs. This member
|
|
* MUST obviously be kept at the very end of the bio.
|
|
*/
|
|
struct bio_vec bi_inline_vecs[0];
|
|
};
|
|
|
|
#define BIO_RESET_BYTES offsetof(struct bio, bi_max_vecs)
|
|
|
|
/*
|
|
* bio flags
|
|
*/
|
|
#define BIO_SEG_VALID 1 /* bi_phys_segments valid */
|
|
#define BIO_CLONED 2 /* doesn't own data */
|
|
#define BIO_BOUNCED 3 /* bio is a bounce bio */
|
|
#define BIO_USER_MAPPED 4 /* contains user pages */
|
|
#define BIO_NULL_MAPPED 5 /* contains invalid user pages */
|
|
#define BIO_QUIET 6 /* Make BIO Quiet */
|
|
#define BIO_CHAIN 7 /* chained bio, ->bi_remaining in effect */
|
|
#define BIO_REFFED 8 /* bio has elevated ->bi_cnt */
|
|
#define BIO_THROTTLED 9 /* This bio has already been subjected to
|
|
* throttling rules. Don't do it again. */
|
|
#define BIO_TRACE_COMPLETION 10 /* bio_endio() should trace the final completion
|
|
* of this bio. */
|
|
/* See BVEC_POOL_OFFSET below before adding new flags */
|
|
|
|
/*
|
|
* We support 6 different bvec pools, the last one is magic in that it
|
|
* is backed by a mempool.
|
|
*/
|
|
#define BVEC_POOL_NR 6
|
|
#define BVEC_POOL_MAX (BVEC_POOL_NR - 1)
|
|
|
|
/*
|
|
* Top 3 bits of bio flags indicate the pool the bvecs came from. We add
|
|
* 1 to the actual index so that 0 indicates that there are no bvecs to be
|
|
* freed.
|
|
*/
|
|
#define BVEC_POOL_BITS (3)
|
|
#define BVEC_POOL_OFFSET (16 - BVEC_POOL_BITS)
|
|
#define BVEC_POOL_IDX(bio) ((bio)->bi_flags >> BVEC_POOL_OFFSET)
|
|
#if (1<< BVEC_POOL_BITS) < (BVEC_POOL_NR+1)
|
|
# error "BVEC_POOL_BITS is too small"
|
|
#endif
|
|
|
|
/*
|
|
* Flags starting here get preserved by bio_reset() - this includes
|
|
* only BVEC_POOL_IDX()
|
|
*/
|
|
#define BIO_RESET_BITS BVEC_POOL_OFFSET
|
|
|
|
/*
|
|
* Operations and flags common to the bio and request structures.
|
|
* We use 8 bits for encoding the operation, and the remaining 24 for flags.
|
|
*
|
|
* The least significant bit of the operation number indicates the data
|
|
* transfer direction:
|
|
*
|
|
* - if the least significant bit is set transfers are TO the device
|
|
* - if the least significant bit is not set transfers are FROM the device
|
|
*
|
|
* If a operation does not transfer data the least significant bit has no
|
|
* meaning.
|
|
*/
|
|
#define REQ_OP_BITS 8
|
|
#define REQ_OP_MASK ((1 << REQ_OP_BITS) - 1)
|
|
#define REQ_FLAG_BITS 24
|
|
|
|
enum req_opf {
|
|
/* read sectors from the device */
|
|
REQ_OP_READ = 0,
|
|
/* write sectors to the device */
|
|
REQ_OP_WRITE = 1,
|
|
/* flush the volatile write cache */
|
|
REQ_OP_FLUSH = 2,
|
|
/* discard sectors */
|
|
REQ_OP_DISCARD = 3,
|
|
/* get zone information */
|
|
REQ_OP_ZONE_REPORT = 4,
|
|
/* securely erase sectors */
|
|
REQ_OP_SECURE_ERASE = 5,
|
|
/* seset a zone write pointer */
|
|
REQ_OP_ZONE_RESET = 6,
|
|
/* write the same sector many times */
|
|
REQ_OP_WRITE_SAME = 7,
|
|
/* write the zero filled sector many times */
|
|
REQ_OP_WRITE_ZEROES = 9,
|
|
|
|
/* SCSI passthrough using struct scsi_request */
|
|
REQ_OP_SCSI_IN = 32,
|
|
REQ_OP_SCSI_OUT = 33,
|
|
/* Driver private requests */
|
|
REQ_OP_DRV_IN = 34,
|
|
REQ_OP_DRV_OUT = 35,
|
|
|
|
REQ_OP_LAST,
|
|
};
|
|
|
|
enum req_flag_bits {
|
|
__REQ_FAILFAST_DEV = /* no driver retries of device errors */
|
|
REQ_OP_BITS,
|
|
__REQ_FAILFAST_TRANSPORT, /* no driver retries of transport errors */
|
|
__REQ_FAILFAST_DRIVER, /* no driver retries of driver errors */
|
|
__REQ_SYNC, /* request is sync (sync write or read) */
|
|
__REQ_META, /* metadata io request */
|
|
__REQ_PRIO, /* boost priority in cfq */
|
|
__REQ_NOMERGE, /* don't touch this for merging */
|
|
__REQ_IDLE, /* anticipate more IO after this one */
|
|
__REQ_INTEGRITY, /* I/O includes block integrity payload */
|
|
__REQ_FUA, /* forced unit access */
|
|
__REQ_PREFLUSH, /* request for cache flush */
|
|
__REQ_RAHEAD, /* read ahead, can fail anytime */
|
|
__REQ_BACKGROUND, /* background IO */
|
|
|
|
/* command specific flags for REQ_OP_WRITE_ZEROES: */
|
|
__REQ_NOUNMAP, /* do not free blocks when zeroing */
|
|
|
|
__REQ_NOWAIT, /* Don't wait if request will block */
|
|
__REQ_NR_BITS, /* stops here */
|
|
};
|
|
|
|
#define REQ_FAILFAST_DEV (1ULL << __REQ_FAILFAST_DEV)
|
|
#define REQ_FAILFAST_TRANSPORT (1ULL << __REQ_FAILFAST_TRANSPORT)
|
|
#define REQ_FAILFAST_DRIVER (1ULL << __REQ_FAILFAST_DRIVER)
|
|
#define REQ_SYNC (1ULL << __REQ_SYNC)
|
|
#define REQ_META (1ULL << __REQ_META)
|
|
#define REQ_PRIO (1ULL << __REQ_PRIO)
|
|
#define REQ_NOMERGE (1ULL << __REQ_NOMERGE)
|
|
#define REQ_IDLE (1ULL << __REQ_IDLE)
|
|
#define REQ_INTEGRITY (1ULL << __REQ_INTEGRITY)
|
|
#define REQ_FUA (1ULL << __REQ_FUA)
|
|
#define REQ_PREFLUSH (1ULL << __REQ_PREFLUSH)
|
|
#define REQ_RAHEAD (1ULL << __REQ_RAHEAD)
|
|
#define REQ_BACKGROUND (1ULL << __REQ_BACKGROUND)
|
|
|
|
#define REQ_NOUNMAP (1ULL << __REQ_NOUNMAP)
|
|
#define REQ_NOWAIT (1ULL << __REQ_NOWAIT)
|
|
|
|
#define REQ_FAILFAST_MASK \
|
|
(REQ_FAILFAST_DEV | REQ_FAILFAST_TRANSPORT | REQ_FAILFAST_DRIVER)
|
|
|
|
#define REQ_NOMERGE_FLAGS \
|
|
(REQ_NOMERGE | REQ_PREFLUSH | REQ_FUA)
|
|
|
|
#define bio_op(bio) \
|
|
((bio)->bi_opf & REQ_OP_MASK)
|
|
#define req_op(req) \
|
|
((req)->cmd_flags & REQ_OP_MASK)
|
|
|
|
/* obsolete, don't use in new code */
|
|
static inline void bio_set_op_attrs(struct bio *bio, unsigned op,
|
|
unsigned op_flags)
|
|
{
|
|
bio->bi_opf = op | op_flags;
|
|
}
|
|
|
|
static inline bool op_is_write(unsigned int op)
|
|
{
|
|
return (op & 1);
|
|
}
|
|
|
|
/*
|
|
* Check if the bio or request is one that needs special treatment in the
|
|
* flush state machine.
|
|
*/
|
|
static inline bool op_is_flush(unsigned int op)
|
|
{
|
|
return op & (REQ_FUA | REQ_PREFLUSH);
|
|
}
|
|
|
|
/*
|
|
* Reads are always treated as synchronous, as are requests with the FUA or
|
|
* PREFLUSH flag. Other operations may be marked as synchronous using the
|
|
* REQ_SYNC flag.
|
|
*/
|
|
static inline bool op_is_sync(unsigned int op)
|
|
{
|
|
return (op & REQ_OP_MASK) == REQ_OP_READ ||
|
|
(op & (REQ_SYNC | REQ_FUA | REQ_PREFLUSH));
|
|
}
|
|
|
|
typedef unsigned int blk_qc_t;
|
|
#define BLK_QC_T_NONE -1U
|
|
#define BLK_QC_T_SHIFT 16
|
|
#define BLK_QC_T_INTERNAL (1U << 31)
|
|
|
|
static inline bool blk_qc_t_valid(blk_qc_t cookie)
|
|
{
|
|
return cookie != BLK_QC_T_NONE;
|
|
}
|
|
|
|
static inline blk_qc_t blk_tag_to_qc_t(unsigned int tag, unsigned int queue_num,
|
|
bool internal)
|
|
{
|
|
blk_qc_t ret = tag | (queue_num << BLK_QC_T_SHIFT);
|
|
|
|
if (internal)
|
|
ret |= BLK_QC_T_INTERNAL;
|
|
|
|
return ret;
|
|
}
|
|
|
|
static inline unsigned int blk_qc_t_to_queue_num(blk_qc_t cookie)
|
|
{
|
|
return (cookie & ~BLK_QC_T_INTERNAL) >> BLK_QC_T_SHIFT;
|
|
}
|
|
|
|
static inline unsigned int blk_qc_t_to_tag(blk_qc_t cookie)
|
|
{
|
|
return cookie & ((1u << BLK_QC_T_SHIFT) - 1);
|
|
}
|
|
|
|
static inline bool blk_qc_t_is_internal(blk_qc_t cookie)
|
|
{
|
|
return (cookie & BLK_QC_T_INTERNAL) != 0;
|
|
}
|
|
|
|
struct blk_rq_stat {
|
|
s64 mean;
|
|
u64 min;
|
|
u64 max;
|
|
s32 nr_samples;
|
|
s32 nr_batch;
|
|
u64 batch;
|
|
};
|
|
|
|
#endif /* __LINUX_BLK_TYPES_H */
|