mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-26 10:49:33 +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>
329 lines
8.5 KiB
C
329 lines
8.5 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _SCSI_DISK_H
|
|
#define _SCSI_DISK_H
|
|
|
|
/*
|
|
* More than enough for everybody ;) The huge number of majors
|
|
* is a leftover from 16bit dev_t days, we don't really need that
|
|
* much numberspace.
|
|
*/
|
|
#define SD_MAJORS 16
|
|
|
|
/*
|
|
* Time out in seconds for disks and Magneto-opticals (which are slower).
|
|
*/
|
|
#define SD_TIMEOUT (30 * HZ)
|
|
#define SD_MOD_TIMEOUT (75 * HZ)
|
|
/*
|
|
* Flush timeout is a multiplier over the standard device timeout which is
|
|
* user modifiable via sysfs but initially set to SD_TIMEOUT
|
|
*/
|
|
#define SD_FLUSH_TIMEOUT_MULTIPLIER 2
|
|
#define SD_WRITE_SAME_TIMEOUT (120 * HZ)
|
|
|
|
/*
|
|
* Number of allowed retries
|
|
*/
|
|
#define SD_MAX_RETRIES 5
|
|
#define SD_PASSTHROUGH_RETRIES 1
|
|
#define SD_MAX_MEDIUM_TIMEOUTS 2
|
|
|
|
/*
|
|
* Size of the initial data buffer for mode and read capacity data
|
|
*/
|
|
#define SD_BUF_SIZE 512
|
|
|
|
/*
|
|
* Number of sectors at the end of the device to avoid multi-sector
|
|
* accesses to in the case of last_sector_bug
|
|
*/
|
|
#define SD_LAST_BUGGY_SECTORS 8
|
|
|
|
enum {
|
|
SD_EXT_CDB_SIZE = 32, /* Extended CDB size */
|
|
SD_MEMPOOL_SIZE = 2, /* CDB pool size */
|
|
};
|
|
|
|
enum {
|
|
SD_DEF_XFER_BLOCKS = 0xffff,
|
|
SD_MAX_XFER_BLOCKS = 0xffffffff,
|
|
SD_MAX_WS10_BLOCKS = 0xffff,
|
|
SD_MAX_WS16_BLOCKS = 0x7fffff,
|
|
};
|
|
|
|
enum {
|
|
SD_LBP_FULL = 0, /* Full logical block provisioning */
|
|
SD_LBP_UNMAP, /* Use UNMAP command */
|
|
SD_LBP_WS16, /* Use WRITE SAME(16) with UNMAP bit */
|
|
SD_LBP_WS10, /* Use WRITE SAME(10) with UNMAP bit */
|
|
SD_LBP_ZERO, /* Use WRITE SAME(10) with zero payload */
|
|
SD_LBP_DISABLE, /* Discard disabled due to failed cmd */
|
|
};
|
|
|
|
enum {
|
|
SD_ZERO_WRITE = 0, /* Use WRITE(10/16) command */
|
|
SD_ZERO_WS, /* Use WRITE SAME(10/16) command */
|
|
SD_ZERO_WS16_UNMAP, /* Use WRITE SAME(16) with UNMAP */
|
|
SD_ZERO_WS10_UNMAP, /* Use WRITE SAME(10) with UNMAP */
|
|
};
|
|
|
|
struct scsi_disk {
|
|
struct scsi_driver *driver; /* always &sd_template */
|
|
struct scsi_device *device;
|
|
struct device dev;
|
|
struct gendisk *disk;
|
|
struct opal_dev *opal_dev;
|
|
#ifdef CONFIG_BLK_DEV_ZONED
|
|
unsigned int nr_zones;
|
|
unsigned int zone_blocks;
|
|
unsigned int zone_shift;
|
|
unsigned long *zones_wlock;
|
|
unsigned int zones_optimal_open;
|
|
unsigned int zones_optimal_nonseq;
|
|
unsigned int zones_max_open;
|
|
#endif
|
|
atomic_t openers;
|
|
sector_t capacity; /* size in logical blocks */
|
|
u32 max_xfer_blocks;
|
|
u32 opt_xfer_blocks;
|
|
u32 max_ws_blocks;
|
|
u32 max_unmap_blocks;
|
|
u32 unmap_granularity;
|
|
u32 unmap_alignment;
|
|
u32 index;
|
|
unsigned int physical_block_size;
|
|
unsigned int max_medium_access_timeouts;
|
|
unsigned int medium_access_timed_out;
|
|
u8 media_present;
|
|
u8 write_prot;
|
|
u8 protection_type;/* Data Integrity Field */
|
|
u8 provisioning_mode;
|
|
u8 zeroing_mode;
|
|
unsigned ATO : 1; /* state of disk ATO bit */
|
|
unsigned cache_override : 1; /* temp override of WCE,RCD */
|
|
unsigned WCE : 1; /* state of disk WCE bit */
|
|
unsigned RCD : 1; /* state of disk RCD bit, unused */
|
|
unsigned DPOFUA : 1; /* state of disk DPOFUA bit */
|
|
unsigned first_scan : 1;
|
|
unsigned lbpme : 1;
|
|
unsigned lbprz : 1;
|
|
unsigned lbpu : 1;
|
|
unsigned lbpws : 1;
|
|
unsigned lbpws10 : 1;
|
|
unsigned lbpvpd : 1;
|
|
unsigned ws10 : 1;
|
|
unsigned ws16 : 1;
|
|
unsigned rc_basis: 2;
|
|
unsigned zoned: 2;
|
|
unsigned urswrz : 1;
|
|
unsigned security : 1;
|
|
unsigned ignore_medium_access_errors : 1;
|
|
};
|
|
#define to_scsi_disk(obj) container_of(obj,struct scsi_disk,dev)
|
|
|
|
static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
|
|
{
|
|
return container_of(disk->private_data, struct scsi_disk, driver);
|
|
}
|
|
|
|
#define sd_printk(prefix, sdsk, fmt, a...) \
|
|
(sdsk)->disk ? \
|
|
sdev_prefix_printk(prefix, (sdsk)->device, \
|
|
(sdsk)->disk->disk_name, fmt, ##a) : \
|
|
sdev_printk(prefix, (sdsk)->device, fmt, ##a)
|
|
|
|
#define sd_first_printk(prefix, sdsk, fmt, a...) \
|
|
do { \
|
|
if ((sdkp)->first_scan) \
|
|
sd_printk(prefix, sdsk, fmt, ##a); \
|
|
} while (0)
|
|
|
|
static inline int scsi_medium_access_command(struct scsi_cmnd *scmd)
|
|
{
|
|
switch (scmd->cmnd[0]) {
|
|
case READ_6:
|
|
case READ_10:
|
|
case READ_12:
|
|
case READ_16:
|
|
case SYNCHRONIZE_CACHE:
|
|
case VERIFY:
|
|
case VERIFY_12:
|
|
case VERIFY_16:
|
|
case WRITE_6:
|
|
case WRITE_10:
|
|
case WRITE_12:
|
|
case WRITE_16:
|
|
case WRITE_SAME:
|
|
case WRITE_SAME_16:
|
|
case UNMAP:
|
|
return 1;
|
|
case VARIABLE_LENGTH_CMD:
|
|
switch (scmd->cmnd[9]) {
|
|
case READ_32:
|
|
case VERIFY_32:
|
|
case WRITE_32:
|
|
case WRITE_SAME_32:
|
|
return 1;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
static inline sector_t logical_to_sectors(struct scsi_device *sdev, sector_t blocks)
|
|
{
|
|
return blocks << (ilog2(sdev->sector_size) - 9);
|
|
}
|
|
|
|
static inline unsigned int logical_to_bytes(struct scsi_device *sdev, sector_t blocks)
|
|
{
|
|
return blocks * sdev->sector_size;
|
|
}
|
|
|
|
static inline sector_t bytes_to_logical(struct scsi_device *sdev, unsigned int bytes)
|
|
{
|
|
return bytes >> ilog2(sdev->sector_size);
|
|
}
|
|
|
|
static inline sector_t sectors_to_logical(struct scsi_device *sdev, sector_t sector)
|
|
{
|
|
return sector >> (ilog2(sdev->sector_size) - 9);
|
|
}
|
|
|
|
/*
|
|
* Look up the DIX operation based on whether the command is read or
|
|
* write and whether dix and dif are enabled.
|
|
*/
|
|
static inline unsigned int sd_prot_op(bool write, bool dix, bool dif)
|
|
{
|
|
/* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
|
|
const unsigned int ops[] = { /* wrt dix dif */
|
|
SCSI_PROT_NORMAL, /* 0 0 0 */
|
|
SCSI_PROT_READ_STRIP, /* 0 0 1 */
|
|
SCSI_PROT_READ_INSERT, /* 0 1 0 */
|
|
SCSI_PROT_READ_PASS, /* 0 1 1 */
|
|
SCSI_PROT_NORMAL, /* 1 0 0 */
|
|
SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
|
|
SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
|
|
SCSI_PROT_WRITE_PASS, /* 1 1 1 */
|
|
};
|
|
|
|
return ops[write << 2 | dix << 1 | dif];
|
|
}
|
|
|
|
/*
|
|
* Returns a mask of the protection flags that are valid for a given DIX
|
|
* operation.
|
|
*/
|
|
static inline unsigned int sd_prot_flag_mask(unsigned int prot_op)
|
|
{
|
|
const unsigned int flag_mask[] = {
|
|
[SCSI_PROT_NORMAL] = 0,
|
|
|
|
[SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
|
|
SCSI_PROT_GUARD_CHECK |
|
|
SCSI_PROT_REF_CHECK |
|
|
SCSI_PROT_REF_INCREMENT,
|
|
|
|
[SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
|
|
SCSI_PROT_IP_CHECKSUM,
|
|
|
|
[SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
|
|
SCSI_PROT_GUARD_CHECK |
|
|
SCSI_PROT_REF_CHECK |
|
|
SCSI_PROT_REF_INCREMENT |
|
|
SCSI_PROT_IP_CHECKSUM,
|
|
|
|
[SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
|
|
SCSI_PROT_REF_INCREMENT,
|
|
|
|
[SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
|
|
SCSI_PROT_REF_CHECK |
|
|
SCSI_PROT_REF_INCREMENT |
|
|
SCSI_PROT_IP_CHECKSUM,
|
|
|
|
[SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
|
|
SCSI_PROT_GUARD_CHECK |
|
|
SCSI_PROT_REF_CHECK |
|
|
SCSI_PROT_REF_INCREMENT |
|
|
SCSI_PROT_IP_CHECKSUM,
|
|
};
|
|
|
|
return flag_mask[prot_op];
|
|
}
|
|
|
|
#ifdef CONFIG_BLK_DEV_INTEGRITY
|
|
|
|
extern void sd_dif_config_host(struct scsi_disk *);
|
|
extern void sd_dif_prepare(struct scsi_cmnd *scmd);
|
|
extern void sd_dif_complete(struct scsi_cmnd *, unsigned int);
|
|
|
|
#else /* CONFIG_BLK_DEV_INTEGRITY */
|
|
|
|
static inline void sd_dif_config_host(struct scsi_disk *disk)
|
|
{
|
|
}
|
|
static inline int sd_dif_prepare(struct scsi_cmnd *scmd)
|
|
{
|
|
return 0;
|
|
}
|
|
static inline void sd_dif_complete(struct scsi_cmnd *cmd, unsigned int a)
|
|
{
|
|
}
|
|
|
|
#endif /* CONFIG_BLK_DEV_INTEGRITY */
|
|
|
|
static inline int sd_is_zoned(struct scsi_disk *sdkp)
|
|
{
|
|
return sdkp->zoned == 1 || sdkp->device->type == TYPE_ZBC;
|
|
}
|
|
|
|
#ifdef CONFIG_BLK_DEV_ZONED
|
|
|
|
extern int sd_zbc_read_zones(struct scsi_disk *sdkp, unsigned char *buffer);
|
|
extern void sd_zbc_remove(struct scsi_disk *sdkp);
|
|
extern void sd_zbc_print_zones(struct scsi_disk *sdkp);
|
|
extern int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd);
|
|
extern void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd);
|
|
extern int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd);
|
|
extern int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd);
|
|
extern void sd_zbc_complete(struct scsi_cmnd *cmd, unsigned int good_bytes,
|
|
struct scsi_sense_hdr *sshdr);
|
|
|
|
#else /* CONFIG_BLK_DEV_ZONED */
|
|
|
|
static inline int sd_zbc_read_zones(struct scsi_disk *sdkp,
|
|
unsigned char *buf)
|
|
{
|
|
return 0;
|
|
}
|
|
|
|
static inline void sd_zbc_remove(struct scsi_disk *sdkp) {}
|
|
|
|
static inline void sd_zbc_print_zones(struct scsi_disk *sdkp) {}
|
|
|
|
static inline int sd_zbc_write_lock_zone(struct scsi_cmnd *cmd)
|
|
{
|
|
/* Let the drive fail requests */
|
|
return BLKPREP_OK;
|
|
}
|
|
|
|
static inline void sd_zbc_write_unlock_zone(struct scsi_cmnd *cmd) {}
|
|
|
|
static inline int sd_zbc_setup_report_cmnd(struct scsi_cmnd *cmd)
|
|
{
|
|
return BLKPREP_INVALID;
|
|
}
|
|
|
|
static inline int sd_zbc_setup_reset_cmnd(struct scsi_cmnd *cmd)
|
|
{
|
|
return BLKPREP_INVALID;
|
|
}
|
|
|
|
static inline void sd_zbc_complete(struct scsi_cmnd *cmd,
|
|
unsigned int good_bytes,
|
|
struct scsi_sense_hdr *sshdr) {}
|
|
|
|
#endif /* CONFIG_BLK_DEV_ZONED */
|
|
|
|
#endif /* _SCSI_DISK_H */
|