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>
443 lines
13 KiB
C
443 lines
13 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_VIRTIO_CONFIG_H
|
|
#define _LINUX_VIRTIO_CONFIG_H
|
|
|
|
#include <linux/err.h>
|
|
#include <linux/bug.h>
|
|
#include <linux/virtio.h>
|
|
#include <linux/virtio_byteorder.h>
|
|
#include <uapi/linux/virtio_config.h>
|
|
|
|
struct irq_affinity;
|
|
|
|
/**
|
|
* virtio_config_ops - operations for configuring a virtio device
|
|
* @get: read the value of a configuration field
|
|
* vdev: the virtio_device
|
|
* offset: the offset of the configuration field
|
|
* buf: the buffer to write the field value into.
|
|
* len: the length of the buffer
|
|
* @set: write the value of a configuration field
|
|
* vdev: the virtio_device
|
|
* offset: the offset of the configuration field
|
|
* buf: the buffer to read the field value from.
|
|
* len: the length of the buffer
|
|
* @generation: config generation counter
|
|
* vdev: the virtio_device
|
|
* Returns the config generation counter
|
|
* @get_status: read the status byte
|
|
* vdev: the virtio_device
|
|
* Returns the status byte
|
|
* @set_status: write the status byte
|
|
* vdev: the virtio_device
|
|
* status: the new status byte
|
|
* @reset: reset the device
|
|
* vdev: the virtio device
|
|
* After this, status and feature negotiation must be done again
|
|
* Device must not be reset from its vq/config callbacks, or in
|
|
* parallel with being added/removed.
|
|
* @find_vqs: find virtqueues and instantiate them.
|
|
* vdev: the virtio_device
|
|
* nvqs: the number of virtqueues to find
|
|
* vqs: on success, includes new virtqueues
|
|
* callbacks: array of callbacks, for each virtqueue
|
|
* include a NULL entry for vqs that do not need a callback
|
|
* names: array of virtqueue names (mainly for debugging)
|
|
* include a NULL entry for vqs unused by driver
|
|
* Returns 0 on success or error status
|
|
* @del_vqs: free virtqueues found by find_vqs().
|
|
* @get_features: get the array of feature bits for this device.
|
|
* vdev: the virtio_device
|
|
* Returns the first 32 feature bits (all we currently need).
|
|
* @finalize_features: confirm what device features we'll be using.
|
|
* vdev: the virtio_device
|
|
* This gives the final feature bits for the device: it can change
|
|
* the dev->feature bits if it wants.
|
|
* Returns 0 on success or error status
|
|
* @bus_name: return the bus name associated with the device
|
|
* vdev: the virtio_device
|
|
* This returns a pointer to the bus name a la pci_name from which
|
|
* the caller can then copy.
|
|
* @set_vq_affinity: set the affinity for a virtqueue.
|
|
* @get_vq_affinity: get the affinity for a virtqueue (optional).
|
|
*/
|
|
typedef void vq_callback_t(struct virtqueue *);
|
|
struct virtio_config_ops {
|
|
void (*get)(struct virtio_device *vdev, unsigned offset,
|
|
void *buf, unsigned len);
|
|
void (*set)(struct virtio_device *vdev, unsigned offset,
|
|
const void *buf, unsigned len);
|
|
u32 (*generation)(struct virtio_device *vdev);
|
|
u8 (*get_status)(struct virtio_device *vdev);
|
|
void (*set_status)(struct virtio_device *vdev, u8 status);
|
|
void (*reset)(struct virtio_device *vdev);
|
|
int (*find_vqs)(struct virtio_device *, unsigned nvqs,
|
|
struct virtqueue *vqs[], vq_callback_t *callbacks[],
|
|
const char * const names[], const bool *ctx,
|
|
struct irq_affinity *desc);
|
|
void (*del_vqs)(struct virtio_device *);
|
|
u64 (*get_features)(struct virtio_device *vdev);
|
|
int (*finalize_features)(struct virtio_device *vdev);
|
|
const char *(*bus_name)(struct virtio_device *vdev);
|
|
int (*set_vq_affinity)(struct virtqueue *vq, int cpu);
|
|
const struct cpumask *(*get_vq_affinity)(struct virtio_device *vdev,
|
|
int index);
|
|
};
|
|
|
|
/* If driver didn't advertise the feature, it will never appear. */
|
|
void virtio_check_driver_offered_feature(const struct virtio_device *vdev,
|
|
unsigned int fbit);
|
|
|
|
/**
|
|
* __virtio_test_bit - helper to test feature bits. For use by transports.
|
|
* Devices should normally use virtio_has_feature,
|
|
* which includes more checks.
|
|
* @vdev: the device
|
|
* @fbit: the feature bit
|
|
*/
|
|
static inline bool __virtio_test_bit(const struct virtio_device *vdev,
|
|
unsigned int fbit)
|
|
{
|
|
/* Did you forget to fix assumptions on max features? */
|
|
if (__builtin_constant_p(fbit))
|
|
BUILD_BUG_ON(fbit >= 64);
|
|
else
|
|
BUG_ON(fbit >= 64);
|
|
|
|
return vdev->features & BIT_ULL(fbit);
|
|
}
|
|
|
|
/**
|
|
* __virtio_set_bit - helper to set feature bits. For use by transports.
|
|
* @vdev: the device
|
|
* @fbit: the feature bit
|
|
*/
|
|
static inline void __virtio_set_bit(struct virtio_device *vdev,
|
|
unsigned int fbit)
|
|
{
|
|
/* Did you forget to fix assumptions on max features? */
|
|
if (__builtin_constant_p(fbit))
|
|
BUILD_BUG_ON(fbit >= 64);
|
|
else
|
|
BUG_ON(fbit >= 64);
|
|
|
|
vdev->features |= BIT_ULL(fbit);
|
|
}
|
|
|
|
/**
|
|
* __virtio_clear_bit - helper to clear feature bits. For use by transports.
|
|
* @vdev: the device
|
|
* @fbit: the feature bit
|
|
*/
|
|
static inline void __virtio_clear_bit(struct virtio_device *vdev,
|
|
unsigned int fbit)
|
|
{
|
|
/* Did you forget to fix assumptions on max features? */
|
|
if (__builtin_constant_p(fbit))
|
|
BUILD_BUG_ON(fbit >= 64);
|
|
else
|
|
BUG_ON(fbit >= 64);
|
|
|
|
vdev->features &= ~BIT_ULL(fbit);
|
|
}
|
|
|
|
/**
|
|
* virtio_has_feature - helper to determine if this device has this feature.
|
|
* @vdev: the device
|
|
* @fbit: the feature bit
|
|
*/
|
|
static inline bool virtio_has_feature(const struct virtio_device *vdev,
|
|
unsigned int fbit)
|
|
{
|
|
if (fbit < VIRTIO_TRANSPORT_F_START)
|
|
virtio_check_driver_offered_feature(vdev, fbit);
|
|
|
|
return __virtio_test_bit(vdev, fbit);
|
|
}
|
|
|
|
/**
|
|
* virtio_has_iommu_quirk - determine whether this device has the iommu quirk
|
|
* @vdev: the device
|
|
*/
|
|
static inline bool virtio_has_iommu_quirk(const struct virtio_device *vdev)
|
|
{
|
|
/*
|
|
* Note the reverse polarity of the quirk feature (compared to most
|
|
* other features), this is for compatibility with legacy systems.
|
|
*/
|
|
return !virtio_has_feature(vdev, VIRTIO_F_IOMMU_PLATFORM);
|
|
}
|
|
|
|
static inline
|
|
struct virtqueue *virtio_find_single_vq(struct virtio_device *vdev,
|
|
vq_callback_t *c, const char *n)
|
|
{
|
|
vq_callback_t *callbacks[] = { c };
|
|
const char *names[] = { n };
|
|
struct virtqueue *vq;
|
|
int err = vdev->config->find_vqs(vdev, 1, &vq, callbacks, names, NULL,
|
|
NULL);
|
|
if (err < 0)
|
|
return ERR_PTR(err);
|
|
return vq;
|
|
}
|
|
|
|
static inline
|
|
int virtio_find_vqs(struct virtio_device *vdev, unsigned nvqs,
|
|
struct virtqueue *vqs[], vq_callback_t *callbacks[],
|
|
const char * const names[],
|
|
struct irq_affinity *desc)
|
|
{
|
|
return vdev->config->find_vqs(vdev, nvqs, vqs, callbacks, names, NULL, desc);
|
|
}
|
|
|
|
static inline
|
|
int virtio_find_vqs_ctx(struct virtio_device *vdev, unsigned nvqs,
|
|
struct virtqueue *vqs[], vq_callback_t *callbacks[],
|
|
const char * const names[], const bool *ctx,
|
|
struct irq_affinity *desc)
|
|
{
|
|
return vdev->config->find_vqs(vdev, nvqs, vqs, callbacks, names, ctx,
|
|
desc);
|
|
}
|
|
|
|
/**
|
|
* virtio_device_ready - enable vq use in probe function
|
|
* @vdev: the device
|
|
*
|
|
* Driver must call this to use vqs in the probe function.
|
|
*
|
|
* Note: vqs are enabled automatically after probe returns.
|
|
*/
|
|
static inline
|
|
void virtio_device_ready(struct virtio_device *dev)
|
|
{
|
|
unsigned status = dev->config->get_status(dev);
|
|
|
|
BUG_ON(status & VIRTIO_CONFIG_S_DRIVER_OK);
|
|
dev->config->set_status(dev, status | VIRTIO_CONFIG_S_DRIVER_OK);
|
|
}
|
|
|
|
static inline
|
|
const char *virtio_bus_name(struct virtio_device *vdev)
|
|
{
|
|
if (!vdev->config->bus_name)
|
|
return "virtio";
|
|
return vdev->config->bus_name(vdev);
|
|
}
|
|
|
|
/**
|
|
* virtqueue_set_affinity - setting affinity for a virtqueue
|
|
* @vq: the virtqueue
|
|
* @cpu: the cpu no.
|
|
*
|
|
* Pay attention the function are best-effort: the affinity hint may not be set
|
|
* due to config support, irq type and sharing.
|
|
*
|
|
*/
|
|
static inline
|
|
int virtqueue_set_affinity(struct virtqueue *vq, int cpu)
|
|
{
|
|
struct virtio_device *vdev = vq->vdev;
|
|
if (vdev->config->set_vq_affinity)
|
|
return vdev->config->set_vq_affinity(vq, cpu);
|
|
return 0;
|
|
}
|
|
|
|
static inline bool virtio_is_little_endian(struct virtio_device *vdev)
|
|
{
|
|
return virtio_has_feature(vdev, VIRTIO_F_VERSION_1) ||
|
|
virtio_legacy_is_little_endian();
|
|
}
|
|
|
|
/* Memory accessors */
|
|
static inline u16 virtio16_to_cpu(struct virtio_device *vdev, __virtio16 val)
|
|
{
|
|
return __virtio16_to_cpu(virtio_is_little_endian(vdev), val);
|
|
}
|
|
|
|
static inline __virtio16 cpu_to_virtio16(struct virtio_device *vdev, u16 val)
|
|
{
|
|
return __cpu_to_virtio16(virtio_is_little_endian(vdev), val);
|
|
}
|
|
|
|
static inline u32 virtio32_to_cpu(struct virtio_device *vdev, __virtio32 val)
|
|
{
|
|
return __virtio32_to_cpu(virtio_is_little_endian(vdev), val);
|
|
}
|
|
|
|
static inline __virtio32 cpu_to_virtio32(struct virtio_device *vdev, u32 val)
|
|
{
|
|
return __cpu_to_virtio32(virtio_is_little_endian(vdev), val);
|
|
}
|
|
|
|
static inline u64 virtio64_to_cpu(struct virtio_device *vdev, __virtio64 val)
|
|
{
|
|
return __virtio64_to_cpu(virtio_is_little_endian(vdev), val);
|
|
}
|
|
|
|
static inline __virtio64 cpu_to_virtio64(struct virtio_device *vdev, u64 val)
|
|
{
|
|
return __cpu_to_virtio64(virtio_is_little_endian(vdev), val);
|
|
}
|
|
|
|
/* Config space accessors. */
|
|
#define virtio_cread(vdev, structname, member, ptr) \
|
|
do { \
|
|
/* Must match the member's type, and be integer */ \
|
|
if (!typecheck(typeof((((structname*)0)->member)), *(ptr))) \
|
|
(*ptr) = 1; \
|
|
\
|
|
switch (sizeof(*ptr)) { \
|
|
case 1: \
|
|
*(ptr) = virtio_cread8(vdev, \
|
|
offsetof(structname, member)); \
|
|
break; \
|
|
case 2: \
|
|
*(ptr) = virtio_cread16(vdev, \
|
|
offsetof(structname, member)); \
|
|
break; \
|
|
case 4: \
|
|
*(ptr) = virtio_cread32(vdev, \
|
|
offsetof(structname, member)); \
|
|
break; \
|
|
case 8: \
|
|
*(ptr) = virtio_cread64(vdev, \
|
|
offsetof(structname, member)); \
|
|
break; \
|
|
default: \
|
|
BUG(); \
|
|
} \
|
|
} while(0)
|
|
|
|
/* Config space accessors. */
|
|
#define virtio_cwrite(vdev, structname, member, ptr) \
|
|
do { \
|
|
/* Must match the member's type, and be integer */ \
|
|
if (!typecheck(typeof((((structname*)0)->member)), *(ptr))) \
|
|
BUG_ON((*ptr) == 1); \
|
|
\
|
|
switch (sizeof(*ptr)) { \
|
|
case 1: \
|
|
virtio_cwrite8(vdev, \
|
|
offsetof(structname, member), \
|
|
*(ptr)); \
|
|
break; \
|
|
case 2: \
|
|
virtio_cwrite16(vdev, \
|
|
offsetof(structname, member), \
|
|
*(ptr)); \
|
|
break; \
|
|
case 4: \
|
|
virtio_cwrite32(vdev, \
|
|
offsetof(structname, member), \
|
|
*(ptr)); \
|
|
break; \
|
|
case 8: \
|
|
virtio_cwrite64(vdev, \
|
|
offsetof(structname, member), \
|
|
*(ptr)); \
|
|
break; \
|
|
default: \
|
|
BUG(); \
|
|
} \
|
|
} while(0)
|
|
|
|
/* Read @count fields, @bytes each. */
|
|
static inline void __virtio_cread_many(struct virtio_device *vdev,
|
|
unsigned int offset,
|
|
void *buf, size_t count, size_t bytes)
|
|
{
|
|
u32 old, gen = vdev->config->generation ?
|
|
vdev->config->generation(vdev) : 0;
|
|
int i;
|
|
|
|
do {
|
|
old = gen;
|
|
|
|
for (i = 0; i < count; i++)
|
|
vdev->config->get(vdev, offset + bytes * i,
|
|
buf + i * bytes, bytes);
|
|
|
|
gen = vdev->config->generation ?
|
|
vdev->config->generation(vdev) : 0;
|
|
} while (gen != old);
|
|
}
|
|
|
|
static inline void virtio_cread_bytes(struct virtio_device *vdev,
|
|
unsigned int offset,
|
|
void *buf, size_t len)
|
|
{
|
|
__virtio_cread_many(vdev, offset, buf, len, 1);
|
|
}
|
|
|
|
static inline u8 virtio_cread8(struct virtio_device *vdev, unsigned int offset)
|
|
{
|
|
u8 ret;
|
|
vdev->config->get(vdev, offset, &ret, sizeof(ret));
|
|
return ret;
|
|
}
|
|
|
|
static inline void virtio_cwrite8(struct virtio_device *vdev,
|
|
unsigned int offset, u8 val)
|
|
{
|
|
vdev->config->set(vdev, offset, &val, sizeof(val));
|
|
}
|
|
|
|
static inline u16 virtio_cread16(struct virtio_device *vdev,
|
|
unsigned int offset)
|
|
{
|
|
u16 ret;
|
|
vdev->config->get(vdev, offset, &ret, sizeof(ret));
|
|
return virtio16_to_cpu(vdev, (__force __virtio16)ret);
|
|
}
|
|
|
|
static inline void virtio_cwrite16(struct virtio_device *vdev,
|
|
unsigned int offset, u16 val)
|
|
{
|
|
val = (__force u16)cpu_to_virtio16(vdev, val);
|
|
vdev->config->set(vdev, offset, &val, sizeof(val));
|
|
}
|
|
|
|
static inline u32 virtio_cread32(struct virtio_device *vdev,
|
|
unsigned int offset)
|
|
{
|
|
u32 ret;
|
|
vdev->config->get(vdev, offset, &ret, sizeof(ret));
|
|
return virtio32_to_cpu(vdev, (__force __virtio32)ret);
|
|
}
|
|
|
|
static inline void virtio_cwrite32(struct virtio_device *vdev,
|
|
unsigned int offset, u32 val)
|
|
{
|
|
val = (__force u32)cpu_to_virtio32(vdev, val);
|
|
vdev->config->set(vdev, offset, &val, sizeof(val));
|
|
}
|
|
|
|
static inline u64 virtio_cread64(struct virtio_device *vdev,
|
|
unsigned int offset)
|
|
{
|
|
u64 ret;
|
|
__virtio_cread_many(vdev, offset, &ret, 1, sizeof(ret));
|
|
return virtio64_to_cpu(vdev, (__force __virtio64)ret);
|
|
}
|
|
|
|
static inline void virtio_cwrite64(struct virtio_device *vdev,
|
|
unsigned int offset, u64 val)
|
|
{
|
|
val = (__force u64)cpu_to_virtio64(vdev, val);
|
|
vdev->config->set(vdev, offset, &val, sizeof(val));
|
|
}
|
|
|
|
/* Conditional config space accessors. */
|
|
#define virtio_cread_feature(vdev, fbit, structname, member, ptr) \
|
|
({ \
|
|
int _r = 0; \
|
|
if (!virtio_has_feature(vdev, fbit)) \
|
|
_r = -ENOENT; \
|
|
else \
|
|
virtio_cread((vdev), structname, member, ptr); \
|
|
_r; \
|
|
})
|
|
|
|
#endif /* _LINUX_VIRTIO_CONFIG_H */
|