Something went wrong. Try again.
(I'm so sorry!) Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
Something went wrong. Try again.
C
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530/* SPDX-License-Identifier: GPL-2.0-or-later *//* Red Black Trees (C) 1999 Andrea Arcangeli <andrea@suse.de>
linux/include/linux/rbtree.h
To use rbtrees you'll have to implement your own insert and search cores. This will avoid us to use callbacks and to drop drammatically performances. I know it's not the cleaner way, but in C (not in C++) to get performances and genericity...
See Documentation/core-api/rbtree.rst for documentation and samples.*/
#ifndef _LINUX_RBTREE_H#define _LINUX_RBTREE_H
#include <linux/container_of.h>#include <linux/rbtree_types.h>
#include <linux/stddef.h>#include <linux/rcupdate.h>
#define rb_parent(r) ((struct rb_node *)((r)->__rb_parent_color & ~3))
#define rb_entry(ptr, type, member) container_of(ptr, type, member)
#define RB_EMPTY_ROOT(root) (READ_ONCE((root)->rb_node) == NULL)
/* 'empty' nodes are nodes that are known not to be inserted in an rbtree */#define RB_EMPTY_NODE(node) \ ((node)->__rb_parent_color == (unsigned long)(node))#define RB_CLEAR_NODE(node) \ ((node)->__rb_parent_color = (unsigned long)(node))
#define RB_EMPTY_LINKED_NODE(lnode) RB_EMPTY_NODE(&(lnode)->node)#define RB_CLEAR_LINKED_NODE(lnode) ({ \ RB_CLEAR_NODE(&(lnode)->node); \ (lnode)->prev = (lnode)->next = NULL; \})
extern void rb_insert_color(struct rb_node *, struct rb_root *);extern void rb_erase(struct rb_node *, struct rb_root *);extern bool rb_erase_linked(struct rb_node_linked *, struct rb_root_linked *);
/* Find logical next and previous nodes in a tree */extern struct rb_node *rb_next(const struct rb_node *);extern struct rb_node *rb_prev(const struct rb_node *);
/* * This function returns the first node (in sort order) of the tree. */static inline struct rb_node *rb_first(const struct rb_root *root){ struct rb_node *n;
n = root->rb_node; if (!n) return NULL; while (n->rb_left) n = n->rb_left; return n;}
/* * This function returns the last node (in sort order) of the tree. */static inline struct rb_node *rb_last(const struct rb_root *root){ struct rb_node *n;
n = root->rb_node; if (!n) return NULL; while (n->rb_right) n = n->rb_right; return n;}
/* Postorder iteration - always visit the parent after its children */extern struct rb_node *rb_first_postorder(const struct rb_root *);extern struct rb_node *rb_next_postorder(const struct rb_node *);
/* Fast replacement of a single node without remove/rebalance/add/rebalance */extern void rb_replace_node(struct rb_node *victim, struct rb_node *new, struct rb_root *root);extern void rb_replace_node_rcu(struct rb_node *victim, struct rb_node *new, struct rb_root *root);
static inline void rb_link_node(struct rb_node *node, struct rb_node *parent, struct rb_node **rb_link){ node->__rb_parent_color = (unsigned long)parent; node->rb_left = node->rb_right = NULL;
*rb_link = node;}
static inline void rb_link_node_rcu(struct rb_node *node, struct rb_node *parent, struct rb_node **rb_link){ node->__rb_parent_color = (unsigned long)parent; node->rb_left = node->rb_right = NULL;
rcu_assign_pointer(*rb_link, node);}
#define rb_entry_safe(ptr, type, member) \ ({ typeof(ptr) ____ptr = (ptr); \ ____ptr ? rb_entry(____ptr, type, member) : NULL; \ })
/** * rbtree_postorder_for_each_entry_safe - iterate in post-order over rb_root of * given type allowing the backing memory of @pos to be invalidated * * @pos: the 'type *' to use as a loop cursor. * @n: another 'type *' to use as temporary storage * @root: 'rb_root *' of the rbtree. * @field: the name of the rb_node field within 'type'. * * rbtree_postorder_for_each_entry_safe() provides a similar guarantee as * list_for_each_entry_safe() and allows the iteration to continue independent * of changes to @pos by the body of the loop. * * Note, however, that it cannot handle other modifications that re-order the * rbtree it is iterating over. This includes calling rb_erase() on @pos, as * rb_erase() may rebalance the tree, causing us to miss some nodes. */#define rbtree_postorder_for_each_entry_safe(pos, n, root, field) \ for (pos = rb_entry_safe(rb_first_postorder(root), typeof(*pos), field); \ pos && ({ n = rb_entry_safe(rb_next_postorder(&pos->field), \ typeof(*pos), field); 1; }); \ pos = n)
/* Same as rb_first(), but O(1) */#define rb_first_cached(root) (root)->rb_leftmost
static inline void rb_insert_color_cached(struct rb_node *node, struct rb_root_cached *root, bool leftmost){ if (leftmost) root->rb_leftmost = node; rb_insert_color(node, &root->rb_root);}
static inline struct rb_node *rb_erase_cached(struct rb_node *node, struct rb_root_cached *root){ struct rb_node *leftmost = NULL;
if (root->rb_leftmost == node) leftmost = root->rb_leftmost = rb_next(node);
rb_erase(node, &root->rb_root);
return leftmost;}
static inline void rb_replace_node_cached(struct rb_node *victim, struct rb_node *new, struct rb_root_cached *root){ if (root->rb_leftmost == victim) root->rb_leftmost = new; rb_replace_node(victim, new, &root->rb_root);}
/* * The below helper functions use 2 operators with 3 different * calling conventions. The operators are related like: * * comp(a->key,b) < 0 := less(a,b) * comp(a->key,b) > 0 := less(b,a) * comp(a->key,b) == 0 := !less(a,b) && !less(b,a) * * If these operators define a partial order on the elements we make no * guarantee on which of the elements matching the key is found. See * rb_find(). * * The reason for this is to allow the find() interface without requiring an * on-stack dummy object, which might not be feasible due to object size. */
/** * rb_add_cached() - insert @node into the leftmost cached tree @tree * @node: node to insert * @tree: leftmost cached tree to insert @node into * @less: operator defining the (partial) node order * * Returns @node when it is the new leftmost, or NULL. */static __always_inline struct rb_node *rb_add_cached(struct rb_node *node, struct rb_root_cached *tree, bool (*less)(struct rb_node *, const struct rb_node *)){ struct rb_node **link = &tree->rb_root.rb_node; struct rb_node *parent = NULL; bool leftmost = true;
while (*link) { parent = *link; if (less(node, parent)) { link = &parent->rb_left; } else { link = &parent->rb_right; leftmost = false; } }
rb_link_node(node, parent, link); rb_insert_color_cached(node, tree, leftmost);
return leftmost ? node : NULL;}
static __always_inline void__rb_add(struct rb_node *node, struct rb_root *tree, bool (*less)(struct rb_node *, const struct rb_node *), void (*linkop)(struct rb_node *, struct rb_node *, struct rb_node **)){ struct rb_node **link = &tree->rb_node; struct rb_node *parent = NULL;
while (*link) { parent = *link; if (less(node, parent)) link = &parent->rb_left; else link = &parent->rb_right; }
linkop(node, parent, link); rb_link_node(node, parent, link); rb_insert_color(node, tree);}
#define __node_2_linked_node(_n) \ rb_entry((_n), struct rb_node_linked, node)
static inline voidrb_link_linked_node(struct rb_node *node, struct rb_node *parent, struct rb_node **link){ if (!parent) return;
struct rb_node_linked *nnew = __node_2_linked_node(node); struct rb_node_linked *npar = __node_2_linked_node(parent);
if (link == &parent->rb_left) { nnew->prev = npar->prev; nnew->next = npar; npar->prev = nnew; if (nnew->prev) nnew->prev->next = nnew; } else { nnew->next = npar->next; nnew->prev = npar; npar->next = nnew; if (nnew->next) nnew->next->prev = nnew; }}
/** * rb_add_linked() - insert @node into the leftmost linked tree @tree * @node: node to insert * @tree: linked tree to insert @node into * @less: operator defining the (partial) node order * * Returns @true when @node is the new leftmost, @false otherwise. */static __always_inline boolrb_add_linked(struct rb_node_linked *node, struct rb_root_linked *tree, bool (*less)(struct rb_node *, const struct rb_node *)){ __rb_add(&node->node, &tree->rb_root, less, rb_link_linked_node); if (!node->prev) tree->rb_leftmost = node; return !node->prev;}
/* Empty linkop function which is optimized away by the compiler */static __always_inline voidrb_link_noop(struct rb_node *n, struct rb_node *p, struct rb_node **l) { }
/** * rb_add() - insert @node into @tree * @node: node to insert * @tree: tree to insert @node into * @less: operator defining the (partial) node order */static __always_inline voidrb_add(struct rb_node *node, struct rb_root *tree, bool (*less)(struct rb_node *, const struct rb_node *)){ __rb_add(node, tree, less, rb_link_noop);}
/** * rb_find_add_cached() - find equivalent @node in @tree, or add @node * @node: node to look-for / insert * @tree: tree to search / modify * @cmp: operator defining the node order * * Returns the rb_node matching @node, or NULL when no match is found and @node * is inserted. */static __always_inline struct rb_node *rb_find_add_cached(struct rb_node *node, struct rb_root_cached *tree, int (*cmp)(const struct rb_node *new, const struct rb_node *exist)){ bool leftmost = true; struct rb_node **link = &tree->rb_root.rb_node; struct rb_node *parent = NULL; int c;
while (*link) { parent = *link; c = cmp(node, parent);
if (c < 0) { link = &parent->rb_left; } else if (c > 0) { link = &parent->rb_right; leftmost = false; } else { return parent; } }
rb_link_node(node, parent, link); rb_insert_color_cached(node, tree, leftmost); return NULL;}
/** * rb_find_add() - find equivalent @node in @tree, or add @node * @node: node to look-for / insert * @tree: tree to search / modify * @cmp: operator defining the node order * * Returns the rb_node matching @node, or NULL when no match is found and @node * is inserted. */static __always_inline struct rb_node *rb_find_add(struct rb_node *node, struct rb_root *tree, int (*cmp)(struct rb_node *, const struct rb_node *)){ struct rb_node **link = &tree->rb_node; struct rb_node *parent = NULL; int c;
while (*link) { parent = *link; c = cmp(node, parent);
if (c < 0) link = &parent->rb_left; else if (c > 0) link = &parent->rb_right; else return parent; }
rb_link_node(node, parent, link); rb_insert_color(node, tree); return NULL;}
/** * rb_find_add_rcu() - find equivalent @node in @tree, or add @node * @node: node to look-for / insert * @tree: tree to search / modify * @cmp: operator defining the node order * * Adds a Store-Release for link_node. * * Returns the rb_node matching @node, or NULL when no match is found and @node * is inserted. */static __always_inline struct rb_node *rb_find_add_rcu(struct rb_node *node, struct rb_root *tree, int (*cmp)(struct rb_node *, const struct rb_node *)){ struct rb_node **link = &tree->rb_node; struct rb_node *parent = NULL; int c;
while (*link) { parent = *link; c = cmp(node, parent);
if (c < 0) link = &parent->rb_left; else if (c > 0) link = &parent->rb_right; else return parent; }
rb_link_node_rcu(node, parent, link); rb_insert_color(node, tree); return NULL;}
/** * rb_find() - find @key in tree @tree * @key: key to match * @tree: tree to search * @cmp: operator defining the node order * * Returns the rb_node matching @key or NULL. */static __always_inline struct rb_node *rb_find(const void *key, const struct rb_root *tree, int (*cmp)(const void *key, const struct rb_node *)){ struct rb_node *node = tree->rb_node;
while (node) { int c = cmp(key, node);
if (c < 0) node = node->rb_left; else if (c > 0) node = node->rb_right; else return node; }
return NULL;}
/** * rb_find_rcu() - find @key in tree @tree * @key: key to match * @tree: tree to search * @cmp: operator defining the node order * * Notably, tree descent vs concurrent tree rotations is unsound and can result * in false-negatives. * * Returns the rb_node matching @key or NULL. */static __always_inline struct rb_node *rb_find_rcu(const void *key, const struct rb_root *tree, int (*cmp)(const void *key, const struct rb_node *)){ struct rb_node *node = tree->rb_node;
while (node) { int c = cmp(key, node);
if (c < 0) node = rcu_dereference_raw(node->rb_left); else if (c > 0) node = rcu_dereference_raw(node->rb_right); else return node; }
return NULL;}
/** * rb_find_first() - find the first @key in @tree * @key: key to match * @tree: tree to search * @cmp: operator defining node order * * Returns the leftmost node matching @key, or NULL. */static __always_inline struct rb_node *rb_find_first(const void *key, const struct rb_root *tree, int (*cmp)(const void *key, const struct rb_node *)){ struct rb_node *node = tree->rb_node; struct rb_node *match = NULL;
while (node) { int c = cmp(key, node);
if (c <= 0) { if (!c) match = node; node = node->rb_left; } else if (c > 0) { node = node->rb_right; } }
return match;}
/** * rb_next_match() - find the next @key in @tree * @key: key to match * @node: tree to search * @cmp: operator defining node order * * Returns the next node matching @key, or NULL. */static __always_inline struct rb_node *rb_next_match(const void *key, struct rb_node *node, int (*cmp)(const void *key, const struct rb_node *)){ node = rb_next(node); if (node && cmp(key, node)) node = NULL; return node;}
/** * rb_for_each() - iterates a subtree matching @key * @node: iterator * @key: key to match * @tree: tree to search * @cmp: operator defining node order */#define rb_for_each(node, key, tree, cmp) \ for ((node) = rb_find_first((key), (tree), (cmp)); \ (node); (node) = rb_next_match((key), (node), (cmp)))
#endif /* _LINUX_RBTREE_H */