mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-21 16:29:59 +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>
365 lines
10 KiB
C
365 lines
10 KiB
C
// SPDX-License-Identifier: GPL-2.0
|
|
/*
|
|
* (C) 2001 Clemson University and The University of Chicago
|
|
* (C) 2011 Omnibond Systems
|
|
*
|
|
* Changes by Acxiom Corporation to implement generic service_operation()
|
|
* function, Copyright Acxiom Corporation, 2005.
|
|
*
|
|
* See COPYING in top-level directory.
|
|
*/
|
|
|
|
/*
|
|
* In-kernel waitqueue operations.
|
|
*/
|
|
|
|
#include "protocol.h"
|
|
#include "orangefs-kernel.h"
|
|
#include "orangefs-bufmap.h"
|
|
|
|
static int wait_for_matching_downcall(struct orangefs_kernel_op_s *, long, bool);
|
|
static void orangefs_clean_up_interrupted_operation(struct orangefs_kernel_op_s *);
|
|
|
|
/*
|
|
* What we do in this function is to walk the list of operations that are
|
|
* present in the request queue and mark them as purged.
|
|
* NOTE: This is called from the device close after client-core has
|
|
* guaranteed that no new operations could appear on the list since the
|
|
* client-core is anyway going to exit.
|
|
*/
|
|
void purge_waiting_ops(void)
|
|
{
|
|
struct orangefs_kernel_op_s *op;
|
|
|
|
spin_lock(&orangefs_request_list_lock);
|
|
list_for_each_entry(op, &orangefs_request_list, list) {
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"pvfs2-client-core: purging op tag %llu %s\n",
|
|
llu(op->tag),
|
|
get_opname_string(op));
|
|
set_op_state_purged(op);
|
|
gossip_debug(GOSSIP_DEV_DEBUG,
|
|
"%s: op:%s: op_state:%d: process:%s:\n",
|
|
__func__,
|
|
get_opname_string(op),
|
|
op->op_state,
|
|
current->comm);
|
|
}
|
|
spin_unlock(&orangefs_request_list_lock);
|
|
}
|
|
|
|
/*
|
|
* submits a ORANGEFS operation and waits for it to complete
|
|
*
|
|
* Note op->downcall.status will contain the status of the operation (in
|
|
* errno format), whether provided by pvfs2-client or a result of failure to
|
|
* service the operation. If the caller wishes to distinguish, then
|
|
* op->state can be checked to see if it was serviced or not.
|
|
*
|
|
* Returns contents of op->downcall.status for convenience
|
|
*/
|
|
int service_operation(struct orangefs_kernel_op_s *op,
|
|
const char *op_name,
|
|
int flags)
|
|
{
|
|
long timeout = MAX_SCHEDULE_TIMEOUT;
|
|
int ret = 0;
|
|
|
|
DEFINE_WAIT(wait_entry);
|
|
|
|
op->upcall.tgid = current->tgid;
|
|
op->upcall.pid = current->pid;
|
|
|
|
retry_servicing:
|
|
op->downcall.status = 0;
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: %s op:%p: process:%s: pid:%d:\n",
|
|
__func__,
|
|
op_name,
|
|
op,
|
|
current->comm,
|
|
current->pid);
|
|
|
|
/*
|
|
* If ORANGEFS_OP_NO_MUTEX was set in flags, we need to avoid
|
|
* acquiring the request_mutex because we're servicing a
|
|
* high priority remount operation and the request_mutex is
|
|
* already taken.
|
|
*/
|
|
if (!(flags & ORANGEFS_OP_NO_MUTEX)) {
|
|
if (flags & ORANGEFS_OP_INTERRUPTIBLE)
|
|
ret = mutex_lock_interruptible(&orangefs_request_mutex);
|
|
else
|
|
ret = mutex_lock_killable(&orangefs_request_mutex);
|
|
/*
|
|
* check to see if we were interrupted while waiting for
|
|
* mutex
|
|
*/
|
|
if (ret < 0) {
|
|
op->downcall.status = ret;
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: service_operation interrupted.\n",
|
|
__func__);
|
|
return ret;
|
|
}
|
|
}
|
|
|
|
/* queue up the operation */
|
|
spin_lock(&orangefs_request_list_lock);
|
|
spin_lock(&op->lock);
|
|
set_op_state_waiting(op);
|
|
gossip_debug(GOSSIP_DEV_DEBUG,
|
|
"%s: op:%s: op_state:%d: process:%s:\n",
|
|
__func__,
|
|
get_opname_string(op),
|
|
op->op_state,
|
|
current->comm);
|
|
/* add high priority remount op to the front of the line. */
|
|
if (flags & ORANGEFS_OP_PRIORITY)
|
|
list_add(&op->list, &orangefs_request_list);
|
|
else
|
|
list_add_tail(&op->list, &orangefs_request_list);
|
|
spin_unlock(&op->lock);
|
|
wake_up_interruptible(&orangefs_request_list_waitq);
|
|
if (!__is_daemon_in_service()) {
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s:client core is NOT in service.\n",
|
|
__func__);
|
|
/*
|
|
* Don't wait for the userspace component to return if
|
|
* the filesystem is being umounted anyway.
|
|
*/
|
|
if (op->upcall.type == ORANGEFS_VFS_OP_FS_UMOUNT)
|
|
timeout = 0;
|
|
else
|
|
timeout = op_timeout_secs * HZ;
|
|
}
|
|
spin_unlock(&orangefs_request_list_lock);
|
|
|
|
if (!(flags & ORANGEFS_OP_NO_MUTEX))
|
|
mutex_unlock(&orangefs_request_mutex);
|
|
|
|
ret = wait_for_matching_downcall(op, timeout,
|
|
flags & ORANGEFS_OP_INTERRUPTIBLE);
|
|
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: wait_for_matching_downcall returned %d for %p\n",
|
|
__func__,
|
|
ret,
|
|
op);
|
|
|
|
/* got matching downcall; make sure status is in errno format */
|
|
if (!ret) {
|
|
spin_unlock(&op->lock);
|
|
op->downcall.status =
|
|
orangefs_normalize_to_errno(op->downcall.status);
|
|
ret = op->downcall.status;
|
|
goto out;
|
|
}
|
|
|
|
/* failed to get matching downcall */
|
|
if (ret == -ETIMEDOUT) {
|
|
gossip_err("%s: %s -- wait timed out; aborting attempt.\n",
|
|
__func__,
|
|
op_name);
|
|
}
|
|
|
|
/*
|
|
* remove a waiting op from the request list or
|
|
* remove an in-progress op from the in-progress list.
|
|
*/
|
|
orangefs_clean_up_interrupted_operation(op);
|
|
|
|
op->downcall.status = ret;
|
|
/* retry if operation has not been serviced and if requested */
|
|
if (ret == -EAGAIN) {
|
|
op->attempts++;
|
|
timeout = op_timeout_secs * HZ;
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"orangefs: tag %llu (%s)"
|
|
" -- operation to be retried (%d attempt)\n",
|
|
llu(op->tag),
|
|
op_name,
|
|
op->attempts);
|
|
|
|
/*
|
|
* io ops (ops that use the shared memory buffer) have
|
|
* to be returned to their caller for a retry. Other ops
|
|
* can just be recycled here.
|
|
*/
|
|
if (!op->uses_shared_memory)
|
|
goto retry_servicing;
|
|
}
|
|
|
|
out:
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: %s returning: %d for %p.\n",
|
|
__func__,
|
|
op_name,
|
|
ret,
|
|
op);
|
|
return ret;
|
|
}
|
|
|
|
/* This can get called on an I/O op if it had a bad service_operation. */
|
|
bool orangefs_cancel_op_in_progress(struct orangefs_kernel_op_s *op)
|
|
{
|
|
u64 tag = op->tag;
|
|
if (!op_state_in_progress(op))
|
|
return false;
|
|
|
|
op->slot_to_free = op->upcall.req.io.buf_index;
|
|
memset(&op->upcall, 0, sizeof(op->upcall));
|
|
memset(&op->downcall, 0, sizeof(op->downcall));
|
|
op->upcall.type = ORANGEFS_VFS_OP_CANCEL;
|
|
op->upcall.req.cancel.op_tag = tag;
|
|
op->downcall.type = ORANGEFS_VFS_OP_INVALID;
|
|
op->downcall.status = -1;
|
|
orangefs_new_tag(op);
|
|
|
|
spin_lock(&orangefs_request_list_lock);
|
|
/* orangefs_request_list_lock is enough of a barrier here */
|
|
if (!__is_daemon_in_service()) {
|
|
spin_unlock(&orangefs_request_list_lock);
|
|
return false;
|
|
}
|
|
spin_lock(&op->lock);
|
|
set_op_state_waiting(op);
|
|
gossip_debug(GOSSIP_DEV_DEBUG,
|
|
"%s: op:%s: op_state:%d: process:%s:\n",
|
|
__func__,
|
|
get_opname_string(op),
|
|
op->op_state,
|
|
current->comm);
|
|
list_add(&op->list, &orangefs_request_list);
|
|
spin_unlock(&op->lock);
|
|
spin_unlock(&orangefs_request_list_lock);
|
|
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"Attempting ORANGEFS operation cancellation of tag %llu\n",
|
|
llu(tag));
|
|
return true;
|
|
}
|
|
|
|
/*
|
|
* Change an op to the "given up" state and remove it from its list.
|
|
*/
|
|
static void
|
|
orangefs_clean_up_interrupted_operation(struct orangefs_kernel_op_s *op)
|
|
{
|
|
/*
|
|
* handle interrupted cases depending on what state we were in when
|
|
* the interruption is detected.
|
|
*
|
|
* Called with op->lock held.
|
|
*/
|
|
|
|
/*
|
|
* List manipulation code elsewhere will ignore ops that
|
|
* have been given up upon.
|
|
*/
|
|
op->op_state |= OP_VFS_STATE_GIVEN_UP;
|
|
|
|
if (list_empty(&op->list)) {
|
|
/* caught copying to/from daemon */
|
|
BUG_ON(op_state_serviced(op));
|
|
spin_unlock(&op->lock);
|
|
wait_for_completion(&op->waitq);
|
|
} else if (op_state_waiting(op)) {
|
|
/*
|
|
* upcall hasn't been read; remove op from upcall request
|
|
* list.
|
|
*/
|
|
spin_unlock(&op->lock);
|
|
spin_lock(&orangefs_request_list_lock);
|
|
list_del_init(&op->list);
|
|
spin_unlock(&orangefs_request_list_lock);
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"Interrupted: Removed op %p from request_list\n",
|
|
op);
|
|
} else if (op_state_in_progress(op)) {
|
|
/* op must be removed from the in progress htable */
|
|
spin_unlock(&op->lock);
|
|
spin_lock(&orangefs_htable_ops_in_progress_lock);
|
|
list_del_init(&op->list);
|
|
spin_unlock(&orangefs_htable_ops_in_progress_lock);
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"Interrupted: Removed op %p"
|
|
" from htable_ops_in_progress\n",
|
|
op);
|
|
} else {
|
|
spin_unlock(&op->lock);
|
|
gossip_err("interrupted operation is in a weird state 0x%x\n",
|
|
op->op_state);
|
|
}
|
|
reinit_completion(&op->waitq);
|
|
}
|
|
|
|
/*
|
|
* Sleeps on waitqueue waiting for matching downcall.
|
|
* If client-core finishes servicing, then we are good to go.
|
|
* else if client-core exits, we get woken up here, and retry with a timeout
|
|
*
|
|
* When this call returns to the caller, the specified op will no
|
|
* longer be in either the in_progress hash table or on the request list.
|
|
*
|
|
* Returns 0 on success and -errno on failure
|
|
* Errors are:
|
|
* EAGAIN in case we want the caller to requeue and try again..
|
|
* EINTR/EIO/ETIMEDOUT indicating we are done trying to service this
|
|
* operation since client-core seems to be exiting too often
|
|
* or if we were interrupted.
|
|
*
|
|
* Returns with op->lock taken.
|
|
*/
|
|
static int wait_for_matching_downcall(struct orangefs_kernel_op_s *op,
|
|
long timeout,
|
|
bool interruptible)
|
|
{
|
|
long n;
|
|
|
|
/*
|
|
* There's a "schedule_timeout" inside of these wait
|
|
* primitives, during which the op is out of the hands of the
|
|
* user process that needs something done and is being
|
|
* manipulated by the client-core process.
|
|
*/
|
|
if (interruptible)
|
|
n = wait_for_completion_interruptible_timeout(&op->waitq,
|
|
timeout);
|
|
else
|
|
n = wait_for_completion_killable_timeout(&op->waitq, timeout);
|
|
|
|
spin_lock(&op->lock);
|
|
|
|
if (op_state_serviced(op))
|
|
return 0;
|
|
|
|
if (unlikely(n < 0)) {
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: operation interrupted, tag %llu, %p\n",
|
|
__func__,
|
|
llu(op->tag),
|
|
op);
|
|
return -EINTR;
|
|
}
|
|
if (op_state_purged(op)) {
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: operation purged, tag %llu, %p, %d\n",
|
|
__func__,
|
|
llu(op->tag),
|
|
op,
|
|
op->attempts);
|
|
return (op->attempts < ORANGEFS_PURGE_RETRY_COUNT) ?
|
|
-EAGAIN :
|
|
-EIO;
|
|
}
|
|
/* must have timed out, then... */
|
|
gossip_debug(GOSSIP_WAIT_DEBUG,
|
|
"%s: operation timed out, tag %llu, %p, %d)\n",
|
|
__func__,
|
|
llu(op->tag),
|
|
op,
|
|
op->attempts);
|
|
return -ETIMEDOUT;
|
|
}
|