mirror of
https://mirrors.bfsu.edu.cn/git/linux.git
synced 2024-12-06 02:24:14 +08:00
b24413180f
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>
370 lines
8.9 KiB
C
370 lines
8.9 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
|
/*
|
|
* HMC Drive CD/DVD Device
|
|
*
|
|
* Copyright IBM Corp. 2013
|
|
* Author(s): Ralf Hoppe (rhoppe@de.ibm.com)
|
|
*
|
|
* This file provides a Linux "misc" character device for access to an
|
|
* assigned HMC drive CD/DVD-ROM. It works as follows: First create the
|
|
* device by calling hmcdrv_dev_init(). After open() a lseek(fd, 0,
|
|
* SEEK_END) indicates that a new FTP command follows (not needed on the
|
|
* first command after open). Then write() the FTP command ASCII string
|
|
* to it, e.g. "dir /" or "nls <directory>" or "get <filename>". At the
|
|
* end read() the response.
|
|
*/
|
|
|
|
#define KMSG_COMPONENT "hmcdrv"
|
|
#define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
|
|
|
|
#include <linux/kernel.h>
|
|
#include <linux/module.h>
|
|
#include <linux/slab.h>
|
|
#include <linux/fs.h>
|
|
#include <linux/cdev.h>
|
|
#include <linux/miscdevice.h>
|
|
#include <linux/device.h>
|
|
#include <linux/capability.h>
|
|
#include <linux/delay.h>
|
|
#include <linux/uaccess.h>
|
|
|
|
#include "hmcdrv_dev.h"
|
|
#include "hmcdrv_ftp.h"
|
|
|
|
/* If the following macro is defined, then the HMC device creates it's own
|
|
* separated device class (and dynamically assigns a major number). If not
|
|
* defined then the HMC device is assigned to the "misc" class devices.
|
|
*
|
|
#define HMCDRV_DEV_CLASS "hmcftp"
|
|
*/
|
|
|
|
#define HMCDRV_DEV_NAME "hmcdrv"
|
|
#define HMCDRV_DEV_BUSY_DELAY 500 /* delay between -EBUSY trials in ms */
|
|
#define HMCDRV_DEV_BUSY_RETRIES 3 /* number of retries on -EBUSY */
|
|
|
|
struct hmcdrv_dev_node {
|
|
|
|
#ifdef HMCDRV_DEV_CLASS
|
|
struct cdev dev; /* character device structure */
|
|
umode_t mode; /* mode of device node (unused, zero) */
|
|
#else
|
|
struct miscdevice dev; /* "misc" device structure */
|
|
#endif
|
|
|
|
};
|
|
|
|
static int hmcdrv_dev_open(struct inode *inode, struct file *fp);
|
|
static int hmcdrv_dev_release(struct inode *inode, struct file *fp);
|
|
static loff_t hmcdrv_dev_seek(struct file *fp, loff_t pos, int whence);
|
|
static ssize_t hmcdrv_dev_read(struct file *fp, char __user *ubuf,
|
|
size_t len, loff_t *pos);
|
|
static ssize_t hmcdrv_dev_write(struct file *fp, const char __user *ubuf,
|
|
size_t len, loff_t *pos);
|
|
static ssize_t hmcdrv_dev_transfer(char __kernel *cmd, loff_t offset,
|
|
char __user *buf, size_t len);
|
|
|
|
/*
|
|
* device operations
|
|
*/
|
|
static const struct file_operations hmcdrv_dev_fops = {
|
|
.open = hmcdrv_dev_open,
|
|
.llseek = hmcdrv_dev_seek,
|
|
.release = hmcdrv_dev_release,
|
|
.read = hmcdrv_dev_read,
|
|
.write = hmcdrv_dev_write,
|
|
};
|
|
|
|
static struct hmcdrv_dev_node hmcdrv_dev; /* HMC device struct (static) */
|
|
|
|
#ifdef HMCDRV_DEV_CLASS
|
|
|
|
static struct class *hmcdrv_dev_class; /* device class pointer */
|
|
static dev_t hmcdrv_dev_no; /* device number (major/minor) */
|
|
|
|
/**
|
|
* hmcdrv_dev_name() - provides a naming hint for a device node in /dev
|
|
* @dev: device for which the naming/mode hint is
|
|
* @mode: file mode for device node created in /dev
|
|
*
|
|
* See: devtmpfs.c, function devtmpfs_create_node()
|
|
*
|
|
* Return: recommended device file name in /dev
|
|
*/
|
|
static char *hmcdrv_dev_name(struct device *dev, umode_t *mode)
|
|
{
|
|
char *nodename = NULL;
|
|
const char *devname = dev_name(dev); /* kernel device name */
|
|
|
|
if (devname)
|
|
nodename = kasprintf(GFP_KERNEL, "%s", devname);
|
|
|
|
/* on device destroy (rmmod) the mode pointer may be NULL
|
|
*/
|
|
if (mode)
|
|
*mode = hmcdrv_dev.mode;
|
|
|
|
return nodename;
|
|
}
|
|
|
|
#endif /* HMCDRV_DEV_CLASS */
|
|
|
|
/*
|
|
* open()
|
|
*/
|
|
static int hmcdrv_dev_open(struct inode *inode, struct file *fp)
|
|
{
|
|
int rc;
|
|
|
|
/* check for non-blocking access, which is really unsupported
|
|
*/
|
|
if (fp->f_flags & O_NONBLOCK)
|
|
return -EINVAL;
|
|
|
|
/* Because it makes no sense to open this device read-only (then a
|
|
* FTP command cannot be emitted), we respond with an error.
|
|
*/
|
|
if ((fp->f_flags & O_ACCMODE) == O_RDONLY)
|
|
return -EINVAL;
|
|
|
|
/* prevent unloading this module as long as anyone holds the
|
|
* device file open - so increment the reference count here
|
|
*/
|
|
if (!try_module_get(THIS_MODULE))
|
|
return -ENODEV;
|
|
|
|
fp->private_data = NULL; /* no command yet */
|
|
rc = hmcdrv_ftp_startup();
|
|
if (rc)
|
|
module_put(THIS_MODULE);
|
|
|
|
pr_debug("open file '/dev/%pD' with return code %d\n", fp, rc);
|
|
return rc;
|
|
}
|
|
|
|
/*
|
|
* release()
|
|
*/
|
|
static int hmcdrv_dev_release(struct inode *inode, struct file *fp)
|
|
{
|
|
pr_debug("closing file '/dev/%pD'\n", fp);
|
|
kfree(fp->private_data);
|
|
fp->private_data = NULL;
|
|
hmcdrv_ftp_shutdown();
|
|
module_put(THIS_MODULE);
|
|
return 0;
|
|
}
|
|
|
|
/*
|
|
* lseek()
|
|
*/
|
|
static loff_t hmcdrv_dev_seek(struct file *fp, loff_t pos, int whence)
|
|
{
|
|
switch (whence) {
|
|
case SEEK_CUR: /* relative to current file position */
|
|
pos += fp->f_pos; /* new position stored in 'pos' */
|
|
break;
|
|
|
|
case SEEK_SET: /* absolute (relative to beginning of file) */
|
|
break; /* SEEK_SET */
|
|
|
|
/* We use SEEK_END as a special indicator for a SEEK_SET
|
|
* (set absolute position), combined with a FTP command
|
|
* clear.
|
|
*/
|
|
case SEEK_END:
|
|
if (fp->private_data) {
|
|
kfree(fp->private_data);
|
|
fp->private_data = NULL;
|
|
}
|
|
|
|
break; /* SEEK_END */
|
|
|
|
default: /* SEEK_DATA, SEEK_HOLE: unsupported */
|
|
return -EINVAL;
|
|
}
|
|
|
|
if (pos < 0)
|
|
return -EINVAL;
|
|
|
|
if (fp->f_pos != pos)
|
|
++fp->f_version;
|
|
|
|
fp->f_pos = pos;
|
|
return pos;
|
|
}
|
|
|
|
/*
|
|
* transfer (helper function)
|
|
*/
|
|
static ssize_t hmcdrv_dev_transfer(char __kernel *cmd, loff_t offset,
|
|
char __user *buf, size_t len)
|
|
{
|
|
ssize_t retlen;
|
|
unsigned trials = HMCDRV_DEV_BUSY_RETRIES;
|
|
|
|
do {
|
|
retlen = hmcdrv_ftp_cmd(cmd, offset, buf, len);
|
|
|
|
if (retlen != -EBUSY)
|
|
break;
|
|
|
|
msleep(HMCDRV_DEV_BUSY_DELAY);
|
|
|
|
} while (--trials > 0);
|
|
|
|
return retlen;
|
|
}
|
|
|
|
/*
|
|
* read()
|
|
*/
|
|
static ssize_t hmcdrv_dev_read(struct file *fp, char __user *ubuf,
|
|
size_t len, loff_t *pos)
|
|
{
|
|
ssize_t retlen;
|
|
|
|
if (((fp->f_flags & O_ACCMODE) == O_WRONLY) ||
|
|
(fp->private_data == NULL)) { /* no FTP cmd defined ? */
|
|
return -EBADF;
|
|
}
|
|
|
|
retlen = hmcdrv_dev_transfer((char *) fp->private_data,
|
|
*pos, ubuf, len);
|
|
|
|
pr_debug("read from file '/dev/%pD' at %lld returns %zd/%zu\n",
|
|
fp, (long long) *pos, retlen, len);
|
|
|
|
if (retlen > 0)
|
|
*pos += retlen;
|
|
|
|
return retlen;
|
|
}
|
|
|
|
/*
|
|
* write()
|
|
*/
|
|
static ssize_t hmcdrv_dev_write(struct file *fp, const char __user *ubuf,
|
|
size_t len, loff_t *pos)
|
|
{
|
|
ssize_t retlen;
|
|
|
|
pr_debug("writing file '/dev/%pD' at pos. %lld with length %zd\n",
|
|
fp, (long long) *pos, len);
|
|
|
|
if (!fp->private_data) { /* first expect a cmd write */
|
|
fp->private_data = kmalloc(len + 1, GFP_KERNEL);
|
|
|
|
if (!fp->private_data)
|
|
return -ENOMEM;
|
|
|
|
if (!copy_from_user(fp->private_data, ubuf, len)) {
|
|
((char *)fp->private_data)[len] = '\0';
|
|
return len;
|
|
}
|
|
|
|
kfree(fp->private_data);
|
|
fp->private_data = NULL;
|
|
return -EFAULT;
|
|
}
|
|
|
|
retlen = hmcdrv_dev_transfer((char *) fp->private_data,
|
|
*pos, (char __user *) ubuf, len);
|
|
if (retlen > 0)
|
|
*pos += retlen;
|
|
|
|
pr_debug("write to file '/dev/%pD' returned %zd\n", fp, retlen);
|
|
|
|
return retlen;
|
|
}
|
|
|
|
/**
|
|
* hmcdrv_dev_init() - creates a HMC drive CD/DVD device
|
|
*
|
|
* This function creates a HMC drive CD/DVD kernel device and an associated
|
|
* device under /dev, using a dynamically allocated major number.
|
|
*
|
|
* Return: 0 on success, else an error code.
|
|
*/
|
|
int hmcdrv_dev_init(void)
|
|
{
|
|
int rc;
|
|
|
|
#ifdef HMCDRV_DEV_CLASS
|
|
struct device *dev;
|
|
|
|
rc = alloc_chrdev_region(&hmcdrv_dev_no, 0, 1, HMCDRV_DEV_NAME);
|
|
|
|
if (rc)
|
|
goto out_err;
|
|
|
|
cdev_init(&hmcdrv_dev.dev, &hmcdrv_dev_fops);
|
|
hmcdrv_dev.dev.owner = THIS_MODULE;
|
|
rc = cdev_add(&hmcdrv_dev.dev, hmcdrv_dev_no, 1);
|
|
|
|
if (rc)
|
|
goto out_unreg;
|
|
|
|
/* At this point the character device exists in the kernel (see
|
|
* /proc/devices), but not under /dev nor /sys/devices/virtual. So
|
|
* we have to create an associated class (see /sys/class).
|
|
*/
|
|
hmcdrv_dev_class = class_create(THIS_MODULE, HMCDRV_DEV_CLASS);
|
|
|
|
if (IS_ERR(hmcdrv_dev_class)) {
|
|
rc = PTR_ERR(hmcdrv_dev_class);
|
|
goto out_devdel;
|
|
}
|
|
|
|
/* Finally a device node in /dev has to be established (as 'mkdev'
|
|
* does from the command line). Notice that assignment of a device
|
|
* node name/mode function is optional (only for mode != 0600).
|
|
*/
|
|
hmcdrv_dev.mode = 0; /* "unset" */
|
|
hmcdrv_dev_class->devnode = hmcdrv_dev_name;
|
|
|
|
dev = device_create(hmcdrv_dev_class, NULL, hmcdrv_dev_no, NULL,
|
|
"%s", HMCDRV_DEV_NAME);
|
|
if (!IS_ERR(dev))
|
|
return 0;
|
|
|
|
rc = PTR_ERR(dev);
|
|
class_destroy(hmcdrv_dev_class);
|
|
hmcdrv_dev_class = NULL;
|
|
|
|
out_devdel:
|
|
cdev_del(&hmcdrv_dev.dev);
|
|
|
|
out_unreg:
|
|
unregister_chrdev_region(hmcdrv_dev_no, 1);
|
|
|
|
out_err:
|
|
|
|
#else /* !HMCDRV_DEV_CLASS */
|
|
hmcdrv_dev.dev.minor = MISC_DYNAMIC_MINOR;
|
|
hmcdrv_dev.dev.name = HMCDRV_DEV_NAME;
|
|
hmcdrv_dev.dev.fops = &hmcdrv_dev_fops;
|
|
hmcdrv_dev.dev.mode = 0; /* finally produces 0600 */
|
|
rc = misc_register(&hmcdrv_dev.dev);
|
|
#endif /* HMCDRV_DEV_CLASS */
|
|
|
|
return rc;
|
|
}
|
|
|
|
/**
|
|
* hmcdrv_dev_exit() - destroys a HMC drive CD/DVD device
|
|
*/
|
|
void hmcdrv_dev_exit(void)
|
|
{
|
|
#ifdef HMCDRV_DEV_CLASS
|
|
if (!IS_ERR_OR_NULL(hmcdrv_dev_class)) {
|
|
device_destroy(hmcdrv_dev_class, hmcdrv_dev_no);
|
|
class_destroy(hmcdrv_dev_class);
|
|
}
|
|
|
|
cdev_del(&hmcdrv_dev.dev);
|
|
unregister_chrdev_region(hmcdrv_dev_no, 1);
|
|
#else /* !HMCDRV_DEV_CLASS */
|
|
misc_deregister(&hmcdrv_dev.dev);
|
|
#endif /* HMCDRV_DEV_CLASS */
|
|
}
|