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 22:07:57 +08:00
|
|
|
/* SPDX-License-Identifier: GPL-2.0 */
|
2007-10-22 09:03:36 +08:00
|
|
|
#ifndef _LINUX_VIRTIO_H
|
|
|
|
|
#define _LINUX_VIRTIO_H
|
|
|
|
|
/* Everything a virtio driver needs to work with any particular virtio
|
|
|
|
|
* implementation. */
|
|
|
|
|
#include <linux/types.h>
|
|
|
|
|
#include <linux/scatterlist.h>
|
|
|
|
|
#include <linux/spinlock.h>
|
|
|
|
|
#include <linux/device.h>
|
|
|
|
|
#include <linux/mod_devicetable.h>
|
2010-04-29 22:26:37 +08:00
|
|
|
#include <linux/gfp.h>
|
2013-03-20 11:21:24 +08:00
|
|
|
#include <linux/vringh.h>
|
2007-10-22 09:03:36 +08:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* virtqueue - a queue to register buffers for sending or receiving.
|
2009-06-13 12:16:35 +08:00
|
|
|
* @list: the chain of virtqueues for this device
|
2007-10-22 09:03:36 +08:00
|
|
|
* @callback: the function to call when buffers are consumed (can be NULL).
|
2009-06-13 12:16:35 +08:00
|
|
|
* @name: the name of this virtqueue (mainly for debugging)
|
2007-10-22 09:03:36 +08:00
|
|
|
* @vdev: the virtio device this queue was created for.
|
|
|
|
|
* @priv: a pointer for the virtqueue implementation to use.
|
2012-10-16 21:26:14 +08:00
|
|
|
* @index: the zero-based ordinal number for this queue.
|
|
|
|
|
* @num_free: number of elements we expect to be able to fit.
|
|
|
|
|
*
|
|
|
|
|
* A note on @num_free: with indirect buffers, each buffer needs one
|
|
|
|
|
* element in the queue, otherwise a buffer will need one element per
|
|
|
|
|
* sg element.
|
2007-10-22 09:03:36 +08:00
|
|
|
*/
|
2009-06-13 12:16:35 +08:00
|
|
|
struct virtqueue {
|
|
|
|
|
struct list_head list;
|
2008-02-05 12:49:57 +08:00
|
|
|
void (*callback)(struct virtqueue *vq);
|
2009-06-13 12:16:35 +08:00
|
|
|
const char *name;
|
2007-10-22 09:03:36 +08:00
|
|
|
struct virtio_device *vdev;
|
2012-10-16 21:26:14 +08:00
|
|
|
unsigned int index;
|
|
|
|
|
unsigned int num_free;
|
2007-10-22 09:03:36 +08:00
|
|
|
void *priv;
|
|
|
|
|
};
|
|
|
|
|
|
2013-03-20 13:14:26 +08:00
|
|
|
int virtqueue_add_outbuf(struct virtqueue *vq,
|
|
|
|
|
struct scatterlist sg[], unsigned int num,
|
|
|
|
|
void *data,
|
|
|
|
|
gfp_t gfp);
|
|
|
|
|
|
|
|
|
|
int virtqueue_add_inbuf(struct virtqueue *vq,
|
|
|
|
|
struct scatterlist sg[], unsigned int num,
|
|
|
|
|
void *data,
|
|
|
|
|
gfp_t gfp);
|
|
|
|
|
|
2017-02-07 12:15:13 +08:00
|
|
|
int virtqueue_add_inbuf_ctx(struct virtqueue *vq,
|
|
|
|
|
struct scatterlist sg[], unsigned int num,
|
|
|
|
|
void *data,
|
|
|
|
|
void *ctx,
|
|
|
|
|
gfp_t gfp);
|
|
|
|
|
|
2013-03-20 13:07:09 +08:00
|
|
|
int virtqueue_add_sgs(struct virtqueue *vq,
|
|
|
|
|
struct scatterlist *sgs[],
|
|
|
|
|
unsigned int out_sgs,
|
|
|
|
|
unsigned int in_sgs,
|
|
|
|
|
void *data,
|
|
|
|
|
gfp_t gfp);
|
|
|
|
|
|
2013-10-29 07:09:48 +08:00
|
|
|
bool virtqueue_kick(struct virtqueue *vq);
|
2007-10-22 09:03:36 +08:00
|
|
|
|
2012-01-12 13:14:43 +08:00
|
|
|
bool virtqueue_kick_prepare(struct virtqueue *vq);
|
|
|
|
|
|
2013-10-29 07:09:48 +08:00
|
|
|
bool virtqueue_notify(struct virtqueue *vq);
|
2012-01-12 13:14:43 +08:00
|
|
|
|
2010-04-12 21:19:07 +08:00
|
|
|
void *virtqueue_get_buf(struct virtqueue *vq, unsigned int *len);
|
2010-04-12 21:18:25 +08:00
|
|
|
|
2017-02-07 12:15:13 +08:00
|
|
|
void *virtqueue_get_buf_ctx(struct virtqueue *vq, unsigned int *len,
|
|
|
|
|
void **ctx);
|
|
|
|
|
|
2010-04-12 21:19:07 +08:00
|
|
|
void virtqueue_disable_cb(struct virtqueue *vq);
|
2010-04-12 21:18:25 +08:00
|
|
|
|
2010-04-12 21:19:07 +08:00
|
|
|
bool virtqueue_enable_cb(struct virtqueue *vq);
|
2010-04-12 21:18:25 +08:00
|
|
|
|
2013-07-09 18:19:18 +08:00
|
|
|
unsigned virtqueue_enable_cb_prepare(struct virtqueue *vq);
|
|
|
|
|
|
|
|
|
|
bool virtqueue_poll(struct virtqueue *vq, unsigned);
|
|
|
|
|
|
2011-05-20 07:11:14 +08:00
|
|
|
bool virtqueue_enable_cb_delayed(struct virtqueue *vq);
|
|
|
|
|
|
2010-04-12 21:19:07 +08:00
|
|
|
void *virtqueue_detach_unused_buf(struct virtqueue *vq);
|
2010-04-12 21:18:25 +08:00
|
|
|
|
2011-10-19 16:10:59 +08:00
|
|
|
unsigned int virtqueue_get_vring_size(struct virtqueue *vq);
|
2012-08-28 19:54:13 +08:00
|
|
|
|
2013-10-29 07:10:19 +08:00
|
|
|
bool virtqueue_is_broken(struct virtqueue *vq);
|
|
|
|
|
|
2016-02-03 13:46:37 +08:00
|
|
|
const struct vring *virtqueue_get_vring(struct virtqueue *vq);
|
|
|
|
|
dma_addr_t virtqueue_get_desc_addr(struct virtqueue *vq);
|
|
|
|
|
dma_addr_t virtqueue_get_avail_addr(struct virtqueue *vq);
|
|
|
|
|
dma_addr_t virtqueue_get_used_addr(struct virtqueue *vq);
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Legacy accessors -- in almost all cases, these are the wrong functions
|
|
|
|
|
* to use.
|
|
|
|
|
*/
|
|
|
|
|
static inline void *virtqueue_get_desc(struct virtqueue *vq)
|
|
|
|
|
{
|
|
|
|
|
return virtqueue_get_vring(vq)->desc;
|
|
|
|
|
}
|
|
|
|
|
static inline void *virtqueue_get_avail(struct virtqueue *vq)
|
|
|
|
|
{
|
|
|
|
|
return virtqueue_get_vring(vq)->avail;
|
|
|
|
|
}
|
|
|
|
|
static inline void *virtqueue_get_used(struct virtqueue *vq)
|
|
|
|
|
{
|
|
|
|
|
return virtqueue_get_vring(vq)->used;
|
|
|
|
|
}
|
2014-10-07 22:39:47 +08:00
|
|
|
|
2007-10-22 09:03:36 +08:00
|
|
|
/**
|
|
|
|
|
* virtio_device - representation of a device using virtio
|
|
|
|
|
* @index: unique position on the virtio bus
|
2014-11-10 07:03:29 +08:00
|
|
|
* @failed: saved value for VIRTIO_CONFIG_S_FAILED bit (for restore)
|
2014-10-15 07:51:55 +08:00
|
|
|
* @config_enabled: configuration change reporting enabled
|
|
|
|
|
* @config_change_pending: configuration change reported while disabled
|
|
|
|
|
* @config_lock: protects configuration change reporting
|
2007-10-22 09:03:36 +08:00
|
|
|
* @dev: underlying device.
|
|
|
|
|
* @id: the device type identification (used to match it with a driver).
|
|
|
|
|
* @config: the configuration ops for this device.
|
2013-03-20 11:21:24 +08:00
|
|
|
* @vringh_config: configuration ops for host vrings.
|
2009-06-13 12:16:35 +08:00
|
|
|
* @vqs: the list of virtqueues for this device.
|
2008-05-03 10:50:50 +08:00
|
|
|
* @features: the features supported by both driver and device.
|
2007-10-22 09:03:36 +08:00
|
|
|
* @priv: private pointer for the driver's use.
|
|
|
|
|
*/
|
2009-06-13 12:16:35 +08:00
|
|
|
struct virtio_device {
|
2007-10-22 09:03:36 +08:00
|
|
|
int index;
|
2014-10-14 08:10:35 +08:00
|
|
|
bool failed;
|
2014-10-15 07:51:55 +08:00
|
|
|
bool config_enabled;
|
|
|
|
|
bool config_change_pending;
|
|
|
|
|
spinlock_t config_lock;
|
2007-10-22 09:03:36 +08:00
|
|
|
struct device dev;
|
|
|
|
|
struct virtio_device_id id;
|
2013-02-10 13:27:38 +08:00
|
|
|
const struct virtio_config_ops *config;
|
2013-03-20 11:21:24 +08:00
|
|
|
const struct vringh_config_ops *vringh_config;
|
2009-06-13 12:16:35 +08:00
|
|
|
struct list_head vqs;
|
2014-10-07 22:39:43 +08:00
|
|
|
u64 features;
|
2007-10-22 09:03:36 +08:00
|
|
|
void *priv;
|
|
|
|
|
};
|
|
|
|
|
|
2012-12-11 08:34:50 +08:00
|
|
|
static inline struct virtio_device *dev_to_virtio(struct device *_dev)
|
|
|
|
|
{
|
|
|
|
|
return container_of(_dev, struct virtio_device, dev);
|
|
|
|
|
}
|
|
|
|
|
|
2017-02-03 11:16:01 +08:00
|
|
|
void virtio_add_status(struct virtio_device *dev, unsigned int status);
|
2007-10-22 09:03:36 +08:00
|
|
|
int register_virtio_device(struct virtio_device *dev);
|
|
|
|
|
void unregister_virtio_device(struct virtio_device *dev);
|
|
|
|
|
|
2014-04-28 09:45:08 +08:00
|
|
|
void virtio_break_device(struct virtio_device *dev);
|
|
|
|
|
|
2014-10-14 08:10:34 +08:00
|
|
|
void virtio_config_changed(struct virtio_device *dev);
|
2017-02-03 11:16:01 +08:00
|
|
|
void virtio_config_disable(struct virtio_device *dev);
|
|
|
|
|
void virtio_config_enable(struct virtio_device *dev);
|
|
|
|
|
int virtio_finalize_features(struct virtio_device *dev);
|
2014-10-14 08:10:35 +08:00
|
|
|
#ifdef CONFIG_PM_SLEEP
|
|
|
|
|
int virtio_device_freeze(struct virtio_device *dev);
|
|
|
|
|
int virtio_device_restore(struct virtio_device *dev);
|
|
|
|
|
#endif
|
2014-10-14 08:10:34 +08:00
|
|
|
|
2018-04-21 01:22:40 +08:00
|
|
|
#define virtio_device_for_each_vq(vdev, vq) \
|
|
|
|
|
list_for_each_entry(vq, &vdev->vqs, list)
|
|
|
|
|
|
2007-10-22 09:03:36 +08:00
|
|
|
/**
|
|
|
|
|
* virtio_driver - operations for a virtio I/O driver
|
|
|
|
|
* @driver: underlying device driver (populate name and owner).
|
|
|
|
|
* @id_table: the ids serviced by this driver.
|
2011-08-25 21:04:05 +08:00
|
|
|
* @feature_table: an array of feature numbers supported by this driver.
|
2008-05-03 10:50:50 +08:00
|
|
|
* @feature_table_size: number of entries in the feature table array.
|
2014-10-23 23:07:47 +08:00
|
|
|
* @feature_table_legacy: same as feature_table but when working in legacy mode.
|
|
|
|
|
* @feature_table_size_legacy: number of entries in feature table legacy array.
|
2009-06-13 12:16:33 +08:00
|
|
|
* @probe: the function to call when a device is found. Returns 0 or -errno.
|
2017-03-30 19:13:33 +08:00
|
|
|
* @scan: optional function to call after successful probe; intended
|
|
|
|
|
* for virtio-scsi to invoke a scan.
|
2011-08-25 21:04:05 +08:00
|
|
|
* @remove: the function to call when a device is removed.
|
2008-02-05 12:49:58 +08:00
|
|
|
* @config_changed: optional function to call when the device configuration
|
|
|
|
|
* changes; may be called in interrupt context.
|
2017-03-30 19:13:33 +08:00
|
|
|
* @freeze: optional function to call during suspend/hibernation.
|
|
|
|
|
* @restore: optional function to call on resume.
|
2007-10-22 09:03:36 +08:00
|
|
|
*/
|
|
|
|
|
struct virtio_driver {
|
|
|
|
|
struct device_driver driver;
|
|
|
|
|
const struct virtio_device_id *id_table;
|
2008-05-03 10:50:50 +08:00
|
|
|
const unsigned int *feature_table;
|
|
|
|
|
unsigned int feature_table_size;
|
2014-10-23 23:07:47 +08:00
|
|
|
const unsigned int *feature_table_legacy;
|
|
|
|
|
unsigned int feature_table_size_legacy;
|
2017-03-30 00:06:20 +08:00
|
|
|
int (*validate)(struct virtio_device *dev);
|
2007-10-22 09:03:36 +08:00
|
|
|
int (*probe)(struct virtio_device *dev);
|
2012-07-12 05:22:16 +08:00
|
|
|
void (*scan)(struct virtio_device *dev);
|
2007-10-22 09:03:36 +08:00
|
|
|
void (*remove)(struct virtio_device *dev);
|
2008-02-05 12:49:58 +08:00
|
|
|
void (*config_changed)(struct virtio_device *dev);
|
2011-12-22 19:28:26 +08:00
|
|
|
#ifdef CONFIG_PM
|
|
|
|
|
int (*freeze)(struct virtio_device *dev);
|
|
|
|
|
int (*restore)(struct virtio_device *dev);
|
|
|
|
|
#endif
|
2007-10-22 09:03:36 +08:00
|
|
|
};
|
|
|
|
|
|
2012-12-10 16:38:33 +08:00
|
|
|
static inline struct virtio_driver *drv_to_virtio(struct device_driver *drv)
|
|
|
|
|
{
|
|
|
|
|
return container_of(drv, struct virtio_driver, driver);
|
|
|
|
|
}
|
|
|
|
|
|
2007-10-22 09:03:36 +08:00
|
|
|
int register_virtio_driver(struct virtio_driver *drv);
|
|
|
|
|
void unregister_virtio_driver(struct virtio_driver *drv);
|
2013-02-13 13:22:36 +08:00
|
|
|
|
|
|
|
|
/* module_virtio_driver() - Helper macro for drivers that don't do
|
|
|
|
|
* anything special in module init/exit. This eliminates a lot of
|
|
|
|
|
* boilerplate. Each module may only use this macro once, and
|
|
|
|
|
* calling it replaces module_init() and module_exit()
|
|
|
|
|
*/
|
|
|
|
|
#define module_virtio_driver(__virtio_driver) \
|
|
|
|
|
module_driver(__virtio_driver, register_virtio_driver, \
|
|
|
|
|
unregister_virtio_driver)
|
2007-10-22 09:03:36 +08:00
|
|
|
#endif /* _LINUX_VIRTIO_H */
|