
Patch series "mm: Randomize free memory", v10.
This patch (of 3):
Randomization of the page allocator improves the average utilization of
a direct-mapped memory-side-cache. Memory side caching is a platform
capability that Linux has been previously exposed to in HPC
(high-performance computing) environments on specialty platforms. In
that instance it was a smaller pool of high-bandwidth-memory relative to
higher-capacity / lower-bandwidth DRAM. Now, this capability is going
to be found on general purpose server platforms where DRAM is a cache in
front of higher latency persistent memory [1].
Robert offered an explanation of the state of the art of Linux
interactions with memory-side-caches [2], and I copy it here:
It's been a problem in the HPC space:
http://www.nersc.gov/research-and-development/knl-cache-mode-performance-coe/
A kernel module called zonesort is available to try to help:
https://software.intel.com/en-us/articles/xeon-phi-software
and this abandoned patch series proposed that for the kernel:
https://lkml.kernel.org/r/20170823100205.17311-1-lukasz.daniluk@intel.com
Dan's patch series doesn't attempt to ensure buffers won't conflict, but
also reduces the chance that the buffers will. This will make performance
more consistent, albeit slower than "optimal" (which is near impossible
to attain in a general-purpose kernel). That's better than forcing
users to deploy remedies like:
"To eliminate this gradual degradation, we have added a Stream
measurement to the Node Health Check that follows each job;
nodes are rebooted whenever their measured memory bandwidth
falls below 300 GB/s."
A replacement for zonesort was merged upstream in commit cc9aec03e5
("x86/numa_emulation: Introduce uniform split capability"). With this
numa_emulation capability, memory can be split into cache sized
("near-memory" sized) numa nodes. A bind operation to such a node, and
disabling workloads on other nodes, enables full cache performance.
However, once the workload exceeds the cache size then cache conflicts
are unavoidable. While HPC environments might be able to tolerate
time-scheduling of cache sized workloads, for general purpose server
platforms, the oversubscribed cache case will be the common case.
The worst case scenario is that a server system owner benchmarks a
workload at boot with an un-contended cache only to see that performance
degrade over time, even below the average cache performance due to
excessive conflicts. Randomization clips the peaks and fills in the
valleys of cache utilization to yield steady average performance.
Here are some performance impact details of the patches:
1/ An Intel internal synthetic memory bandwidth measurement tool, saw a
3X speedup in a contrived case that tries to force cache conflicts.
The contrived cased used the numa_emulation capability to force an
instance of the benchmark to be run in two of the near-memory sized
numa nodes. If both instances were placed on the same emulated they
would fit and cause zero conflicts. While on separate emulated nodes
without randomization they underutilized the cache and conflicted
unnecessarily due to the in-order allocation per node.
2/ A well known Java server application benchmark was run with a heap
size that exceeded cache size by 3X. The cache conflict rate was 8%
for the first run and degraded to 21% after page allocator aging. With
randomization enabled the rate levelled out at 11%.
3/ A MongoDB workload did not observe measurable difference in
cache-conflict rates, but the overall throughput dropped by 7% with
randomization in one case.
4/ Mel Gorman ran his suite of performance workloads with randomization
enabled on platforms without a memory-side-cache and saw a mix of some
improvements and some losses [3].
While there is potentially significant improvement for applications that
depend on low latency access across a wide working-set, the performance
may be negligible to negative for other workloads. For this reason the
shuffle capability defaults to off unless a direct-mapped
memory-side-cache is detected. Even then, the page_alloc.shuffle=0
parameter can be specified to disable the randomization on those systems.
Outside of memory-side-cache utilization concerns there is potentially
security benefit from randomization. Some data exfiltration and
return-oriented-programming attacks rely on the ability to infer the
location of sensitive data objects. The kernel page allocator, especially
early in system boot, has predictable first-in-first out behavior for
physical pages. Pages are freed in physical address order when first
onlined.
Quoting Kees:
"While we already have a base-address randomization
(CONFIG_RANDOMIZE_MEMORY), attacks against the same hardware and
memory layouts would certainly be using the predictability of
allocation ordering (i.e. for attacks where the base address isn't
important: only the relative positions between allocated memory).
This is common in lots of heap-style attacks. They try to gain
control over ordering by spraying allocations, etc.
I'd really like to see this because it gives us something similar
to CONFIG_SLAB_FREELIST_RANDOM but for the page allocator."
While SLAB_FREELIST_RANDOM reduces the predictability of some local slab
caches it leaves vast bulk of memory to be predictably in order allocated.
However, it should be noted, the concrete security benefits are hard to
quantify, and no known CVE is mitigated by this randomization.
Introduce shuffle_free_memory(), and its helper shuffle_zone(), to perform
a Fisher-Yates shuffle of the page allocator 'free_area' lists when they
are initially populated with free memory at boot and at hotplug time. Do
this based on either the presence of a page_alloc.shuffle=Y command line
parameter, or autodetection of a memory-side-cache (to be added in a
follow-on patch).
The shuffling is done in terms of CONFIG_SHUFFLE_PAGE_ORDER sized free
pages where the default CONFIG_SHUFFLE_PAGE_ORDER is MAX_ORDER-1 i.e. 10,
4MB this trades off randomization granularity for time spent shuffling.
MAX_ORDER-1 was chosen to be minimally invasive to the page allocator
while still showing memory-side cache behavior improvements, and the
expectation that the security implications of finer granularity
randomization is mitigated by CONFIG_SLAB_FREELIST_RANDOM. The
performance impact of the shuffling appears to be in the noise compared to
other memory initialization work.
This initial randomization can be undone over time so a follow-on patch is
introduced to inject entropy on page free decisions. It is reasonable to
ask if the page free entropy is sufficient, but it is not enough due to
the in-order initial freeing of pages. At the start of that process
putting page1 in front or behind page0 still keeps them close together,
page2 is still near page1 and has a high chance of being adjacent. As
more pages are added ordering diversity improves, but there is still high
page locality for the low address pages and this leads to no significant
impact to the cache conflict rate.
[1]: https://itpeernetwork.intel.com/intel-optane-dc-persistent-memory-operating-modes/
[2]: https://lkml.kernel.org/r/AT5PR8401MB1169D656C8B5E121752FC0F8AB120@AT5PR8401MB1169.NAMPRD84.PROD.OUTLOOK.COM
[3]: https://lkml.org/lkml/2018/10/12/309
[dan.j.williams@intel.com: fix shuffle enable]
Link: http://lkml.kernel.org/r/154943713038.3858443.4125180191382062871.stgit@dwillia2-desk3.amr.corp.intel.com
[cai@lca.pw: fix SHUFFLE_PAGE_ALLOCATOR help texts]
Link: http://lkml.kernel.org/r/20190425201300.75650-1-cai@lca.pw
Link: http://lkml.kernel.org/r/154899811738.3165233.12325692939590944259.stgit@dwillia2-desk3.amr.corp.intel.com
Signed-off-by: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Qian Cai <cai@lca.pw>
Reviewed-by: Kees Cook <keescook@chromium.org>
Acked-by: Michal Hocko <mhocko@suse.com>
Cc: Dave Hansen <dave.hansen@linux.intel.com>
Cc: Keith Busch <keith.busch@intel.com>
Cc: Robert Elliott <elliott@hpe.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
890 lines
25 KiB
C
890 lines
25 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
#ifndef _LINUX_LIST_H
|
|
#define _LINUX_LIST_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/stddef.h>
|
|
#include <linux/poison.h>
|
|
#include <linux/const.h>
|
|
#include <linux/kernel.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)
|
|
{
|
|
WRITE_ONCE(list->next, list);
|
|
list->prev = list;
|
|
}
|
|
|
|
#ifdef CONFIG_DEBUG_LIST
|
|
extern bool __list_add_valid(struct list_head *new,
|
|
struct list_head *prev,
|
|
struct list_head *next);
|
|
extern bool __list_del_entry_valid(struct list_head *entry);
|
|
#else
|
|
static inline bool __list_add_valid(struct list_head *new,
|
|
struct list_head *prev,
|
|
struct list_head *next)
|
|
{
|
|
return true;
|
|
}
|
|
static inline bool __list_del_entry_valid(struct list_head *entry)
|
|
{
|
|
return true;
|
|
}
|
|
#endif
|
|
|
|
/*
|
|
* Insert a new entry between two known consecutive entries.
|
|
*
|
|
* This is only for internal list manipulation where we know
|
|
* the prev/next entries already!
|
|
*/
|
|
static inline void __list_add(struct list_head *new,
|
|
struct list_head *prev,
|
|
struct list_head *next)
|
|
{
|
|
if (!__list_add_valid(new, prev, next))
|
|
return;
|
|
|
|
next->prev = new;
|
|
new->next = next;
|
|
new->prev = prev;
|
|
WRITE_ONCE(prev->next, new);
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
static inline void __list_del_entry(struct list_head *entry)
|
|
{
|
|
if (!__list_del_entry_valid(entry))
|
|
return;
|
|
|
|
__list_del(entry->prev, entry->next);
|
|
}
|
|
|
|
static inline void list_del(struct list_head *entry)
|
|
{
|
|
__list_del_entry(entry);
|
|
entry->next = LIST_POISON1;
|
|
entry->prev = LIST_POISON2;
|
|
}
|
|
|
|
/**
|
|
* 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_swap - replace entry1 with entry2 and re-add entry1 at entry2's position
|
|
* @entry1: the location to place entry2
|
|
* @entry2: the location to place entry1
|
|
*/
|
|
static inline void list_swap(struct list_head *entry1,
|
|
struct list_head *entry2)
|
|
{
|
|
struct list_head *pos = entry2->prev;
|
|
|
|
list_del(entry2);
|
|
list_replace(entry1, entry2);
|
|
if (pos == entry1)
|
|
pos = entry2;
|
|
list_add(entry1, pos);
|
|
}
|
|
|
|
/**
|
|
* 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_bulk_move_tail - move a subsection of a list to its tail
|
|
* @head: the head that will follow our entry
|
|
* @first: first entry to move
|
|
* @last: last entry to move, can be the same as first
|
|
*
|
|
* Move all entries between @first and including @last before @head.
|
|
* All three entries must belong to the same linked list.
|
|
*/
|
|
static inline void list_bulk_move_tail(struct list_head *head,
|
|
struct list_head *first,
|
|
struct list_head *last)
|
|
{
|
|
first->prev->next = last->next;
|
|
last->next->prev = first->prev;
|
|
|
|
head->prev->next = first;
|
|
first->prev = head->prev;
|
|
|
|
last->next = head;
|
|
head->prev = last;
|
|
}
|
|
|
|
/**
|
|
* list_is_first -- tests whether @list is the first entry in list @head
|
|
* @list: the entry to test
|
|
* @head: the head of the list
|
|
*/
|
|
static inline int list_is_first(const struct list_head *list,
|
|
const struct list_head *head)
|
|
{
|
|
return list->prev == 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 READ_ONCE(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_rotate_to_front() - Rotate list to specific item.
|
|
* @list: The desired new front of the list.
|
|
* @head: The head of the list.
|
|
*
|
|
* Rotates list so that @list becomes the new front of the list.
|
|
*/
|
|
static inline void list_rotate_to_front(struct list_head *list,
|
|
struct list_head *head)
|
|
{
|
|
/*
|
|
* Deletes the list head from the list denoted by @head and
|
|
* places it as the tail of @list, this effectively rotates the
|
|
* list so that @list is at the front.
|
|
*/
|
|
list_move_tail(head, list);
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
|
|
/**
|
|
* list_cut_before - cut a list into two, before given entry
|
|
* @list: a new list to add all removed entries
|
|
* @head: a list with entries
|
|
* @entry: an entry within head, could be the head itself
|
|
*
|
|
* This helper moves the initial part of @head, up to but
|
|
* excluding @entry, from @head to @list. You should pass
|
|
* in @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.
|
|
* If @entry == @head, all entries on @head are moved to
|
|
* @list.
|
|
*/
|
|
static inline void list_cut_before(struct list_head *list,
|
|
struct list_head *head,
|
|
struct list_head *entry)
|
|
{
|
|
if (head->next == entry) {
|
|
INIT_LIST_HEAD(list);
|
|
return;
|
|
}
|
|
list->next = head->next;
|
|
list->next->prev = list;
|
|
list->prev = entry->prev;
|
|
list->prev->next = list;
|
|
head->next = entry;
|
|
entry->prev = head;
|
|
}
|
|
|
|
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) ({ \
|
|
struct list_head *head__ = (ptr); \
|
|
struct list_head *pos__ = READ_ONCE(head__->next); \
|
|
pos__ != head__ ? list_entry(pos__, type, member) : NULL; \
|
|
})
|
|
|
|
/**
|
|
* 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_from_reverse - iterate backwards 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 backwards over list of given type, continuing from current position.
|
|
*/
|
|
#define list_for_each_entry_from_reverse(pos, head, member) \
|
|
for (; &pos->member != (head); \
|
|
pos = list_prev_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))
|
|
|
|
/**
|
|
* 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 !READ_ONCE(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;
|
|
WRITE_ONCE(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;
|
|
WRITE_ONCE(*(n->pprev), n);
|
|
}
|
|
|
|
static inline void hlist_add_behind(struct hlist_node *n,
|
|
struct hlist_node *prev)
|
|
{
|
|
n->next = prev->next;
|
|
WRITE_ONCE(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;
|
|
}
|
|
|
|
/*
|
|
* Check whether the node is the only node of the head without
|
|
* accessing head:
|
|
*/
|
|
static inline bool
|
|
hlist_is_singular_node(struct hlist_node *n, struct hlist_head *h)
|
|
{
|
|
return !n->next && n->pprev == &h->first;
|
|
}
|
|
|
|
/*
|
|
* 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))
|
|
|
|
#endif
|