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 */
|
2015-12-18 20:39:16 +08:00
|
|
|
#ifndef __TOOLS_LINUX_LIST_H
|
|
|
|
#define __TOOLS_LINUX_LIST_H
|
|
|
|
|
2014-04-26 03:31:02 +08:00
|
|
|
#include <linux/types.h>
|
2015-12-18 20:39:16 +08:00
|
|
|
#include <linux/poison.h>
|
|
|
|
#include <linux/kernel.h>
|
|
|
|
#include <linux/compiler.h>
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Simple doubly linked list implementation.
|
|
|
|
*
|
|
|
|
* Some of the internal functions ("__xxx") are useful when
|
|
|
|
* manipulating whole lists rather than single entries, as
|
|
|
|
* sometimes we already know the next/prev entries and we can
|
|
|
|
* generate better code by using them directly rather than
|
|
|
|
* using the generic single-entry routines.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define LIST_HEAD_INIT(name) { &(name), &(name) }
|
|
|
|
|
|
|
|
#define LIST_HEAD(name) \
|
|
|
|
struct list_head name = LIST_HEAD_INIT(name)
|
|
|
|
|
|
|
|
static inline void INIT_LIST_HEAD(struct list_head *list)
|
|
|
|
{
|
|
|
|
list->next = list;
|
|
|
|
list->prev = list;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Insert a new entry between two known consecutive entries.
|
|
|
|
*
|
|
|
|
* This is only for internal list manipulation where we know
|
|
|
|
* the prev/next entries already!
|
|
|
|
*/
|
|
|
|
#ifndef CONFIG_DEBUG_LIST
|
|
|
|
static inline void __list_add(struct list_head *new,
|
|
|
|
struct list_head *prev,
|
|
|
|
struct list_head *next)
|
|
|
|
{
|
|
|
|
next->prev = new;
|
|
|
|
new->next = next;
|
|
|
|
new->prev = prev;
|
|
|
|
prev->next = new;
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
extern void __list_add(struct list_head *new,
|
|
|
|
struct list_head *prev,
|
|
|
|
struct list_head *next);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_add - add a new entry
|
|
|
|
* @new: new entry to be added
|
|
|
|
* @head: list head to add it after
|
|
|
|
*
|
|
|
|
* Insert a new entry after the specified head.
|
|
|
|
* This is good for implementing stacks.
|
|
|
|
*/
|
|
|
|
static inline void list_add(struct list_head *new, struct list_head *head)
|
|
|
|
{
|
|
|
|
__list_add(new, head, head->next);
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_add_tail - add a new entry
|
|
|
|
* @new: new entry to be added
|
|
|
|
* @head: list head to add it before
|
|
|
|
*
|
|
|
|
* Insert a new entry before the specified head.
|
|
|
|
* This is useful for implementing queues.
|
|
|
|
*/
|
|
|
|
static inline void list_add_tail(struct list_head *new, struct list_head *head)
|
|
|
|
{
|
|
|
|
__list_add(new, head->prev, head);
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Delete a list entry by making the prev/next entries
|
|
|
|
* point to each other.
|
|
|
|
*
|
|
|
|
* This is only for internal list manipulation where we know
|
|
|
|
* the prev/next entries already!
|
|
|
|
*/
|
|
|
|
static inline void __list_del(struct list_head * prev, struct list_head * next)
|
|
|
|
{
|
|
|
|
next->prev = prev;
|
|
|
|
WRITE_ONCE(prev->next, next);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_del - deletes entry from list.
|
|
|
|
* @entry: the element to delete from the list.
|
|
|
|
* Note: list_empty() on entry does not return true after this, the entry is
|
|
|
|
* in an undefined state.
|
|
|
|
*/
|
|
|
|
#ifndef CONFIG_DEBUG_LIST
|
|
|
|
static inline void __list_del_entry(struct list_head *entry)
|
|
|
|
{
|
|
|
|
__list_del(entry->prev, entry->next);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void list_del(struct list_head *entry)
|
|
|
|
{
|
|
|
|
__list_del(entry->prev, entry->next);
|
|
|
|
entry->next = LIST_POISON1;
|
|
|
|
entry->prev = LIST_POISON2;
|
|
|
|
}
|
|
|
|
#else
|
|
|
|
extern void __list_del_entry(struct list_head *entry);
|
|
|
|
extern void list_del(struct list_head *entry);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_replace - replace old entry by new one
|
|
|
|
* @old : the element to be replaced
|
|
|
|
* @new : the new element to insert
|
|
|
|
*
|
|
|
|
* If @old was empty, it will be overwritten.
|
|
|
|
*/
|
|
|
|
static inline void list_replace(struct list_head *old,
|
|
|
|
struct list_head *new)
|
|
|
|
{
|
|
|
|
new->next = old->next;
|
|
|
|
new->next->prev = new;
|
|
|
|
new->prev = old->prev;
|
|
|
|
new->prev->next = new;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void list_replace_init(struct list_head *old,
|
|
|
|
struct list_head *new)
|
|
|
|
{
|
|
|
|
list_replace(old, new);
|
|
|
|
INIT_LIST_HEAD(old);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_del_init - deletes entry from list and reinitialize it.
|
|
|
|
* @entry: the element to delete from the list.
|
|
|
|
*/
|
|
|
|
static inline void list_del_init(struct list_head *entry)
|
|
|
|
{
|
|
|
|
__list_del_entry(entry);
|
|
|
|
INIT_LIST_HEAD(entry);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_move - delete from one list and add as another's head
|
|
|
|
* @list: the entry to move
|
|
|
|
* @head: the head that will precede our entry
|
|
|
|
*/
|
|
|
|
static inline void list_move(struct list_head *list, struct list_head *head)
|
|
|
|
{
|
|
|
|
__list_del_entry(list);
|
|
|
|
list_add(list, head);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_move_tail - delete from one list and add as another's tail
|
|
|
|
* @list: the entry to move
|
|
|
|
* @head: the head that will follow our entry
|
|
|
|
*/
|
|
|
|
static inline void list_move_tail(struct list_head *list,
|
|
|
|
struct list_head *head)
|
|
|
|
{
|
|
|
|
__list_del_entry(list);
|
|
|
|
list_add_tail(list, head);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_is_last - tests whether @list is the last entry in list @head
|
|
|
|
* @list: the entry to test
|
|
|
|
* @head: the head of the list
|
|
|
|
*/
|
|
|
|
static inline int list_is_last(const struct list_head *list,
|
|
|
|
const struct list_head *head)
|
|
|
|
{
|
|
|
|
return list->next == head;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_empty - tests whether a list is empty
|
|
|
|
* @head: the list to test.
|
|
|
|
*/
|
|
|
|
static inline int list_empty(const struct list_head *head)
|
|
|
|
{
|
|
|
|
return head->next == head;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_empty_careful - tests whether a list is empty and not being modified
|
|
|
|
* @head: the list to test
|
|
|
|
*
|
|
|
|
* Description:
|
|
|
|
* tests whether a list is empty _and_ checks that no other CPU might be
|
|
|
|
* in the process of modifying either member (next or prev)
|
|
|
|
*
|
|
|
|
* NOTE: using list_empty_careful() without synchronization
|
|
|
|
* can only be safe if the only activity that can happen
|
|
|
|
* to the list entry is list_del_init(). Eg. it cannot be used
|
|
|
|
* if another CPU could re-list_add() it.
|
|
|
|
*/
|
|
|
|
static inline int list_empty_careful(const struct list_head *head)
|
|
|
|
{
|
|
|
|
struct list_head *next = head->next;
|
|
|
|
return (next == head) && (next == head->prev);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_rotate_left - rotate the list to the left
|
|
|
|
* @head: the head of the list
|
|
|
|
*/
|
|
|
|
static inline void list_rotate_left(struct list_head *head)
|
|
|
|
{
|
|
|
|
struct list_head *first;
|
|
|
|
|
|
|
|
if (!list_empty(head)) {
|
|
|
|
first = head->next;
|
|
|
|
list_move_tail(first, head);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_is_singular - tests whether a list has just one entry.
|
|
|
|
* @head: the list to test.
|
|
|
|
*/
|
|
|
|
static inline int list_is_singular(const struct list_head *head)
|
|
|
|
{
|
|
|
|
return !list_empty(head) && (head->next == head->prev);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void __list_cut_position(struct list_head *list,
|
|
|
|
struct list_head *head, struct list_head *entry)
|
|
|
|
{
|
|
|
|
struct list_head *new_first = entry->next;
|
|
|
|
list->next = head->next;
|
|
|
|
list->next->prev = list;
|
|
|
|
list->prev = entry;
|
|
|
|
entry->next = list;
|
|
|
|
head->next = new_first;
|
|
|
|
new_first->prev = head;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_cut_position - cut a list into two
|
|
|
|
* @list: a new list to add all removed entries
|
|
|
|
* @head: a list with entries
|
|
|
|
* @entry: an entry within head, could be the head itself
|
|
|
|
* and if so we won't cut the list
|
|
|
|
*
|
|
|
|
* This helper moves the initial part of @head, up to and
|
|
|
|
* including @entry, from @head to @list. You should
|
|
|
|
* pass on @entry an element you know is on @head. @list
|
|
|
|
* should be an empty list or a list you do not care about
|
|
|
|
* losing its data.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
static inline void list_cut_position(struct list_head *list,
|
|
|
|
struct list_head *head, struct list_head *entry)
|
|
|
|
{
|
|
|
|
if (list_empty(head))
|
|
|
|
return;
|
|
|
|
if (list_is_singular(head) &&
|
|
|
|
(head->next != entry && head != entry))
|
|
|
|
return;
|
|
|
|
if (entry == head)
|
|
|
|
INIT_LIST_HEAD(list);
|
|
|
|
else
|
|
|
|
__list_cut_position(list, head, entry);
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void __list_splice(const struct list_head *list,
|
|
|
|
struct list_head *prev,
|
|
|
|
struct list_head *next)
|
|
|
|
{
|
|
|
|
struct list_head *first = list->next;
|
|
|
|
struct list_head *last = list->prev;
|
|
|
|
|
|
|
|
first->prev = prev;
|
|
|
|
prev->next = first;
|
|
|
|
|
|
|
|
last->next = next;
|
|
|
|
next->prev = last;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_splice - join two lists, this is designed for stacks
|
|
|
|
* @list: the new list to add.
|
|
|
|
* @head: the place to add it in the first list.
|
|
|
|
*/
|
|
|
|
static inline void list_splice(const struct list_head *list,
|
|
|
|
struct list_head *head)
|
|
|
|
{
|
|
|
|
if (!list_empty(list))
|
|
|
|
__list_splice(list, head, head->next);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_splice_tail - join two lists, each list being a queue
|
|
|
|
* @list: the new list to add.
|
|
|
|
* @head: the place to add it in the first list.
|
|
|
|
*/
|
|
|
|
static inline void list_splice_tail(struct list_head *list,
|
|
|
|
struct list_head *head)
|
|
|
|
{
|
|
|
|
if (!list_empty(list))
|
|
|
|
__list_splice(list, head->prev, head);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_splice_init - join two lists and reinitialise the emptied list.
|
|
|
|
* @list: the new list to add.
|
|
|
|
* @head: the place to add it in the first list.
|
|
|
|
*
|
|
|
|
* The list at @list is reinitialised
|
|
|
|
*/
|
|
|
|
static inline void list_splice_init(struct list_head *list,
|
|
|
|
struct list_head *head)
|
|
|
|
{
|
|
|
|
if (!list_empty(list)) {
|
|
|
|
__list_splice(list, head, head->next);
|
|
|
|
INIT_LIST_HEAD(list);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_splice_tail_init - join two lists and reinitialise the emptied list
|
|
|
|
* @list: the new list to add.
|
|
|
|
* @head: the place to add it in the first list.
|
|
|
|
*
|
|
|
|
* Each of the lists is a queue.
|
|
|
|
* The list at @list is reinitialised
|
|
|
|
*/
|
|
|
|
static inline void list_splice_tail_init(struct list_head *list,
|
|
|
|
struct list_head *head)
|
|
|
|
{
|
|
|
|
if (!list_empty(list)) {
|
|
|
|
__list_splice(list, head->prev, head);
|
|
|
|
INIT_LIST_HEAD(list);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_entry - get the struct for this entry
|
|
|
|
* @ptr: the &struct list_head pointer.
|
|
|
|
* @type: the type of the struct this is embedded in.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*/
|
|
|
|
#define list_entry(ptr, type, member) \
|
|
|
|
container_of(ptr, type, member)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_first_entry - get the first element from a list
|
|
|
|
* @ptr: the list head to take the element from.
|
|
|
|
* @type: the type of the struct this is embedded in.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Note, that list is expected to be not empty.
|
|
|
|
*/
|
|
|
|
#define list_first_entry(ptr, type, member) \
|
|
|
|
list_entry((ptr)->next, type, member)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_last_entry - get the last element from a list
|
|
|
|
* @ptr: the list head to take the element from.
|
|
|
|
* @type: the type of the struct this is embedded in.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Note, that list is expected to be not empty.
|
|
|
|
*/
|
|
|
|
#define list_last_entry(ptr, type, member) \
|
|
|
|
list_entry((ptr)->prev, type, member)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_first_entry_or_null - get the first element from a list
|
|
|
|
* @ptr: the list head to take the element from.
|
|
|
|
* @type: the type of the struct this is embedded in.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Note that if the list is empty, it returns NULL.
|
|
|
|
*/
|
|
|
|
#define list_first_entry_or_null(ptr, type, member) \
|
|
|
|
(!list_empty(ptr) ? list_first_entry(ptr, type, member) : NULL)
|
|
|
|
|
2022-07-09 09:50:21 +08:00
|
|
|
/**
|
|
|
|
* list_last_entry_or_null - get the last element from a list
|
|
|
|
* @ptr: the list head to take the element from.
|
|
|
|
* @type: the type of the struct this is embedded in.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Note that if the list is empty, it returns NULL.
|
|
|
|
*/
|
|
|
|
#define list_last_entry_or_null(ptr, type, member) \
|
|
|
|
(!list_empty(ptr) ? list_last_entry(ptr, type, member) : NULL)
|
|
|
|
|
2015-12-18 20:39:16 +08:00
|
|
|
/**
|
|
|
|
* list_next_entry - get the next element in list
|
|
|
|
* @pos: the type * to cursor
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*/
|
|
|
|
#define list_next_entry(pos, member) \
|
|
|
|
list_entry((pos)->member.next, typeof(*(pos)), member)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_prev_entry - get the prev element in list
|
|
|
|
* @pos: the type * to cursor
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*/
|
|
|
|
#define list_prev_entry(pos, member) \
|
|
|
|
list_entry((pos)->member.prev, typeof(*(pos)), member)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each - iterate over a list
|
|
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
*/
|
|
|
|
#define list_for_each(pos, head) \
|
|
|
|
for (pos = (head)->next; pos != (head); pos = pos->next)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_prev - iterate over a list backwards
|
|
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
*/
|
|
|
|
#define list_for_each_prev(pos, head) \
|
|
|
|
for (pos = (head)->prev; pos != (head); pos = pos->prev)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_safe - iterate over a list safe against removal of list entry
|
|
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
|
|
* @n: another &struct list_head to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
*/
|
|
|
|
#define list_for_each_safe(pos, n, head) \
|
|
|
|
for (pos = (head)->next, n = pos->next; pos != (head); \
|
|
|
|
pos = n, n = pos->next)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_prev_safe - iterate over a list backwards safe against removal of list entry
|
|
|
|
* @pos: the &struct list_head to use as a loop cursor.
|
|
|
|
* @n: another &struct list_head to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
*/
|
|
|
|
#define list_for_each_prev_safe(pos, n, head) \
|
|
|
|
for (pos = (head)->prev, n = pos->prev; \
|
|
|
|
pos != (head); \
|
|
|
|
pos = n, n = pos->prev)
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry - iterate over list of given type
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry(pos, head, member) \
|
|
|
|
for (pos = list_first_entry(head, typeof(*pos), member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = list_next_entry(pos, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_reverse - iterate backwards over list of given type.
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_reverse(pos, head, member) \
|
|
|
|
for (pos = list_last_entry(head, typeof(*pos), member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = list_prev_entry(pos, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_prepare_entry - prepare a pos entry for use in list_for_each_entry_continue()
|
|
|
|
* @pos: the type * to use as a start point
|
|
|
|
* @head: the head of the list
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Prepares a pos entry for use as a start point in list_for_each_entry_continue().
|
|
|
|
*/
|
|
|
|
#define list_prepare_entry(pos, head, member) \
|
|
|
|
((pos) ? : list_entry(head, typeof(*pos), member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_continue - continue iteration over list of given type
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Continue to iterate over list of given type, continuing after
|
|
|
|
* the current position.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_continue(pos, head, member) \
|
|
|
|
for (pos = list_next_entry(pos, member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = list_next_entry(pos, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_continue_reverse - iterate backwards from the given point
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Start to iterate over list of given type backwards, continuing after
|
|
|
|
* the current position.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_continue_reverse(pos, head, member) \
|
|
|
|
for (pos = list_prev_entry(pos, member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = list_prev_entry(pos, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_from - iterate over list of given type from the current point
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Iterate over list of given type, continuing from current position.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_from(pos, head, member) \
|
|
|
|
for (; &pos->member != (head); \
|
|
|
|
pos = list_next_entry(pos, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_safe - iterate over list of given type safe against removal of list entry
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @n: another type * to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_safe(pos, n, head, member) \
|
|
|
|
for (pos = list_first_entry(head, typeof(*pos), member), \
|
|
|
|
n = list_next_entry(pos, member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = n, n = list_next_entry(n, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_safe_continue - continue list iteration safe against removal
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @n: another type * to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Iterate over list of given type, continuing after current point,
|
|
|
|
* safe against removal of list entry.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_safe_continue(pos, n, head, member) \
|
|
|
|
for (pos = list_next_entry(pos, member), \
|
|
|
|
n = list_next_entry(pos, member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = n, n = list_next_entry(n, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_safe_from - iterate over list from current point safe against removal
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @n: another type * to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Iterate over list of given type from current point, safe against
|
|
|
|
* removal of list entry.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_safe_from(pos, n, head, member) \
|
|
|
|
for (n = list_next_entry(pos, member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = n, n = list_next_entry(n, member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_entry_safe_reverse - iterate backwards over list safe against removal
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @n: another type * to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* Iterate backwards over list of given type, safe against removal
|
|
|
|
* of list entry.
|
|
|
|
*/
|
|
|
|
#define list_for_each_entry_safe_reverse(pos, n, head, member) \
|
|
|
|
for (pos = list_last_entry(head, typeof(*pos), member), \
|
|
|
|
n = list_prev_entry(pos, member); \
|
|
|
|
&pos->member != (head); \
|
|
|
|
pos = n, n = list_prev_entry(n, member))
|
2011-05-22 16:07:37 +08:00
|
|
|
|
2015-12-18 20:39:16 +08:00
|
|
|
/**
|
|
|
|
* list_safe_reset_next - reset a stale list_for_each_entry_safe loop
|
|
|
|
* @pos: the loop cursor used in the list_for_each_entry_safe loop
|
|
|
|
* @n: temporary storage used in list_for_each_entry_safe
|
|
|
|
* @member: the name of the list_head within the struct.
|
|
|
|
*
|
|
|
|
* list_safe_reset_next is not safe to use in general if the list may be
|
|
|
|
* modified concurrently (eg. the lock is dropped in the loop body). An
|
|
|
|
* exception to this is if the cursor element (pos) is pinned in the list,
|
|
|
|
* and list_safe_reset_next is called after re-taking the lock and before
|
|
|
|
* completing the current iteration of the loop body.
|
|
|
|
*/
|
|
|
|
#define list_safe_reset_next(pos, n, member) \
|
|
|
|
n = list_next_entry(pos, member)
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Double linked lists with a single pointer list head.
|
|
|
|
* Mostly useful for hash tables where the two pointer list head is
|
|
|
|
* too wasteful.
|
|
|
|
* You lose the ability to access the tail in O(1).
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define HLIST_HEAD_INIT { .first = NULL }
|
|
|
|
#define HLIST_HEAD(name) struct hlist_head name = { .first = NULL }
|
|
|
|
#define INIT_HLIST_HEAD(ptr) ((ptr)->first = NULL)
|
|
|
|
static inline void INIT_HLIST_NODE(struct hlist_node *h)
|
|
|
|
{
|
|
|
|
h->next = NULL;
|
|
|
|
h->pprev = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int hlist_unhashed(const struct hlist_node *h)
|
|
|
|
{
|
|
|
|
return !h->pprev;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline int hlist_empty(const struct hlist_head *h)
|
|
|
|
{
|
|
|
|
return !h->first;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void __hlist_del(struct hlist_node *n)
|
|
|
|
{
|
|
|
|
struct hlist_node *next = n->next;
|
|
|
|
struct hlist_node **pprev = n->pprev;
|
|
|
|
|
|
|
|
WRITE_ONCE(*pprev, next);
|
|
|
|
if (next)
|
|
|
|
next->pprev = pprev;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void hlist_del(struct hlist_node *n)
|
|
|
|
{
|
|
|
|
__hlist_del(n);
|
|
|
|
n->next = LIST_POISON1;
|
|
|
|
n->pprev = LIST_POISON2;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void hlist_del_init(struct hlist_node *n)
|
|
|
|
{
|
|
|
|
if (!hlist_unhashed(n)) {
|
|
|
|
__hlist_del(n);
|
|
|
|
INIT_HLIST_NODE(n);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void hlist_add_head(struct hlist_node *n, struct hlist_head *h)
|
|
|
|
{
|
|
|
|
struct hlist_node *first = h->first;
|
|
|
|
n->next = first;
|
|
|
|
if (first)
|
|
|
|
first->pprev = &n->next;
|
|
|
|
h->first = n;
|
|
|
|
n->pprev = &h->first;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* next must be != NULL */
|
|
|
|
static inline void hlist_add_before(struct hlist_node *n,
|
|
|
|
struct hlist_node *next)
|
|
|
|
{
|
|
|
|
n->pprev = next->pprev;
|
|
|
|
n->next = next;
|
|
|
|
next->pprev = &n->next;
|
|
|
|
*(n->pprev) = n;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline void hlist_add_behind(struct hlist_node *n,
|
|
|
|
struct hlist_node *prev)
|
|
|
|
{
|
|
|
|
n->next = prev->next;
|
|
|
|
prev->next = n;
|
|
|
|
n->pprev = &prev->next;
|
|
|
|
|
|
|
|
if (n->next)
|
|
|
|
n->next->pprev = &n->next;
|
|
|
|
}
|
|
|
|
|
|
|
|
/* after that we'll appear to be on some hlist and hlist_del will work */
|
|
|
|
static inline void hlist_add_fake(struct hlist_node *n)
|
|
|
|
{
|
|
|
|
n->pprev = &n->next;
|
|
|
|
}
|
|
|
|
|
|
|
|
static inline bool hlist_fake(struct hlist_node *h)
|
|
|
|
{
|
|
|
|
return h->pprev == &h->next;
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Move a list from one list head to another. Fixup the pprev
|
|
|
|
* reference of the first entry if it exists.
|
|
|
|
*/
|
|
|
|
static inline void hlist_move_list(struct hlist_head *old,
|
|
|
|
struct hlist_head *new)
|
|
|
|
{
|
|
|
|
new->first = old->first;
|
|
|
|
if (new->first)
|
|
|
|
new->first->pprev = &new->first;
|
|
|
|
old->first = NULL;
|
|
|
|
}
|
|
|
|
|
|
|
|
#define hlist_entry(ptr, type, member) container_of(ptr,type,member)
|
|
|
|
|
|
|
|
#define hlist_for_each(pos, head) \
|
|
|
|
for (pos = (head)->first; pos ; pos = pos->next)
|
|
|
|
|
|
|
|
#define hlist_for_each_safe(pos, n, head) \
|
|
|
|
for (pos = (head)->first; pos && ({ n = pos->next; 1; }); \
|
|
|
|
pos = n)
|
|
|
|
|
|
|
|
#define hlist_entry_safe(ptr, type, member) \
|
|
|
|
({ typeof(ptr) ____ptr = (ptr); \
|
|
|
|
____ptr ? hlist_entry(____ptr, type, member) : NULL; \
|
|
|
|
})
|
|
|
|
|
|
|
|
/**
|
|
|
|
* hlist_for_each_entry - iterate over list of given type
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the hlist_node within the struct.
|
|
|
|
*/
|
|
|
|
#define hlist_for_each_entry(pos, head, member) \
|
|
|
|
for (pos = hlist_entry_safe((head)->first, typeof(*(pos)), member);\
|
|
|
|
pos; \
|
|
|
|
pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* hlist_for_each_entry_continue - iterate over a hlist continuing after current point
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @member: the name of the hlist_node within the struct.
|
|
|
|
*/
|
|
|
|
#define hlist_for_each_entry_continue(pos, member) \
|
|
|
|
for (pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member);\
|
|
|
|
pos; \
|
|
|
|
pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* hlist_for_each_entry_from - iterate over a hlist continuing from current point
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @member: the name of the hlist_node within the struct.
|
|
|
|
*/
|
|
|
|
#define hlist_for_each_entry_from(pos, member) \
|
|
|
|
for (; pos; \
|
|
|
|
pos = hlist_entry_safe((pos)->member.next, typeof(*(pos)), member))
|
|
|
|
|
|
|
|
/**
|
|
|
|
* hlist_for_each_entry_safe - iterate over list of given type safe against removal of list entry
|
|
|
|
* @pos: the type * to use as a loop cursor.
|
|
|
|
* @n: another &struct hlist_node to use as temporary storage
|
|
|
|
* @head: the head for your list.
|
|
|
|
* @member: the name of the hlist_node within the struct.
|
|
|
|
*/
|
|
|
|
#define hlist_for_each_entry_safe(pos, n, head, member) \
|
|
|
|
for (pos = hlist_entry_safe((head)->first, typeof(*pos), member);\
|
|
|
|
pos && ({ n = pos->member.next; 1; }); \
|
|
|
|
pos = hlist_entry_safe(n, typeof(*pos), member))
|
2009-07-02 01:46:08 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* list_del_range - deletes range of entries from list.
|
|
|
|
* @begin: first element in the range to delete from the list.
|
|
|
|
* @end: last element in the range to delete from the list.
|
|
|
|
* Note: list_empty on the range of entries does not return true after this,
|
|
|
|
* the entries is in an undefined state.
|
|
|
|
*/
|
|
|
|
static inline void list_del_range(struct list_head *begin,
|
|
|
|
struct list_head *end)
|
|
|
|
{
|
|
|
|
begin->prev->next = end->next;
|
|
|
|
end->next->prev = begin->prev;
|
|
|
|
}
|
2010-08-07 03:51:12 +08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* list_for_each_from - iterate over a list from one of its nodes
|
|
|
|
* @pos: the &struct list_head to use as a loop cursor, from where to start
|
|
|
|
* @head: the head for your list.
|
|
|
|
*/
|
|
|
|
#define list_for_each_from(pos, head) \
|
2011-05-21 03:50:29 +08:00
|
|
|
for (; pos != (head); pos = pos->next)
|
2015-12-18 20:39:16 +08:00
|
|
|
|
|
|
|
#endif /* __TOOLS_LINUX_LIST_H */
|