红黑树（rbtree）在Linux中
日期 2007年1月18日
作者 Rob Landley [email protected]
红黑树是什么，它们有什么作用？
红黑树是一种自平衡的二叉搜索树，用于存储可排序的键/值数据对。这与基数树（用于高效存储稀疏数组，因此使用长整数索引来插入/访问/删除节点）和哈希表（不保持排序以便轻松按顺序遍历，并且必须针对特定大小和哈希函数进行调整，而红黑树可以优雅地存储任意键）不同。
红黑树类似于AVL树，但在插入和删除时提供更快的实时有界最坏情况性能（分别最多两次旋转和三次旋转来平衡树），查找时间略慢（但仍为O(log n)）。
引用Linux周刊新闻：
内核中使用了许多红黑树。截止日期和CFQ I/O调度程序使用rbtree跟踪请求；数据包CD/DVD驱动程序也是如此。高分辨率计时器代码使用rbtree来组织未完成的计时器请求。ext3文件系统使用红黑树跟踪目录条目。虚拟内存区域（VMAs）使用红黑树进行跟踪，epoll文件描述符、加密密钥以及“分层令牌桶”调度程序中的网络数据包也是如此。
本文介绍了Linux rbtree实现的用法。有关红黑树的性质和实现的更多信息，请参阅：
- Linux周刊新闻关于红黑树的文章
https://lwn.net/Articles/184495/ - 红黑树的维基百科条目
https://en.wikipedia.org/wiki/Red-black_tree
Linux中红黑树的实现
Linux的rbtree实现位于文件“lib/rbtree.c”中。要使用它，请“#include <linux/rbtree.h>”。
Linux的rbtree实现经过了速度优化，因此比传统的树实现少了一层间接性（并且具有更好的缓存局部性）。每个struct rb_node的实例都嵌入在它组织的数据结构中，而不是使用指针来分离rb_node和数据结构。而且，用户应该编写自己的树搜索和插入函数，调用提供的rbtree函数。锁定也留给了rbtree代码的用户。
创建新的rbtree
rbtree树中的数据节点是包含struct rb_node成员的结构：
struct mytype {
struct rb_node node;
char *keystring;
};
当处理嵌入的struct rb_node指针时，可以使用标准的container_of()宏来访问包含的数据结构。此外，可以通过rb_entry(node, type, member)直接访问各个成员。
在每个rbtree的根部是一个rb_root结构，通过以下方式初始化为空：
struct rb_root mytree = RB_ROOT;
在rbtree中查找值
编写树的搜索函数相当简单：从根开始，比较每个值，并根据需要跟随左侧或右侧分支。
示例：
struct mytype *my_search(struct rb_root *root, char *string)
{
struct rb_node *node = root->rb_node;
while (node) {
struct mytype *data = container_of(node, struct mytype, node);
int result;
result = strcmp(string, data->keystring);
if (result < 0)
node = node->rb_left;
else if (result > 0)
node = node->rb_right;
else
return data;
}
return NULL;
}
在rbtree中插入数据
在树中插入数据首先涉及查找要插入新节点的位置，然后插入节点并重新平衡（"重新着色"）树。
插入的搜索与之前的搜索不同，它找到要将新节点插入的指针位置。新节点还需要一个指向其父节点的链接，以便进行重新平衡。
示例：
int my_insert(struct rb_root *root, struct mytype *data)
{
struct rb_node **new = &(root->rb_node), *parent = NULL;
/* 确定新节点的放置位置 */
while (*new) {
struct mytype *this = container_of(*new, struct mytype, node);
int result = strcmp(data->keystring, this->keystring);
parent = *new;
if (result < 0)
new = &((*new)->rb_left);
else if (result > 0)
new = &((*new)->rb_right);
else
return FALSE;
}
/* 添加新节点并重新平衡树。 */
rb_link_node(&data->node, parent, new);
rb_insert_color(&data->node, root);
return TRUE;
}
从rbtree中删除或替换现有数据
要从树中删除现有节点，请调用：
void rb_erase(struct rb_node *victim, struct rb_root *tree);
示例：
struct mytype *data = mysearch(&mytree, "walrus");
if (data) {
rb_erase(&data->node, &mytree);
myfree(data);
}
要用具有相同键的新节点替换树中的现有节点，请调用：
void rb_replace_node(struct rb_node *old, struct rb_node *new,
struct rb_root *tree);
以这种方式替换节点不会重新排序树：如果新节点的键与旧节点的键不同，rbtree可能会变得损坏。
在rbtree中迭代存储的元素（按排序顺序）
提供了四个函数，用于按排序顺序迭代rbtree中的内容。这些函数适用于任意树，不应该需要修改或包装（除了锁定目的）：
struct rb_node *rb_first(struct rb_root *tree);
struct rb_node *rb_last(struct rb_root *tree);
struct rb_node *rb_next(struct rb_node *node);
struct rb_node *rb_prev(struct rb_node *node);
要开始迭代，请使用指向树根的指针调用rb_first()或rb_last()，它将返回指向树中第一个或最后一个元素的节点结构的指针。要继续，通过在当前节点上调用rb_next()或rb_prev()来获取下一个或前一个节点。当没有更多节点时，这将返回NULL。
迭代函数返回指向嵌入的struct rb_node的指针，可以使用container_of()宏访问包含的数据结构，并且可以通过rb_entry(node, type, member)直接访问各个成员。
示例：
struct rb_node *node;
for (node = rb_first(&mytree); node; node = rb_next(node))
printk("key=%s\n", rb_entry(node, struct mytype, node)->keystring);
缓存的rbtree
计算最左侧（最小）节点对于二叉搜索树来说是一项相当常见的任务，例如用于遍历或依赖于特定顺序的用户逻辑。为此，用户可以使用'struct rb_root_cached'来将O(logN)的rb_first()调用优化为简单的指针获取，避免潜在昂贵的树迭代。这在维护时具有可忽略的运行时开销，尽管内存占用较大。
与rb_root结构类似，缓存的rbtree通过以下方式初始化为空：
struct rb_root_cached mytree = RB_ROOT_CACHED;
缓存的rbtree只是一个带有额外指针的常规rb_root，用于缓存最左侧节点。这允许rb_root_cached存在于rb_root可以存在的任何地方，从而支持增强树以及一些额外接口：
struct rb_node *rb_first_cached(struct rb_root_cached *tree);
void rb_insert_color_cached(struct rb_node *, struct rb_root_cached *, bool);
void rb_erase_cached(struct rb_node *node, struct rb_root_cached *);
插入和删除调用都有增强树的相应对应：
void rb_insert_augmented_cached(struct rb_node *node, struct rb_root_cached *,
bool, struct rb_augment_callbacks *);
void rb_erase_augmented_cached(struct rb_node *, struct rb_root_cached *,
struct rb_augment_callbacks *);
增强rbtree的支持
增强rbtree是一个在每个节点中存储“一些”附加数据的rbtree，其中节点N的子树中的所有节点的内容必须是节点N的函数。这些数据可以用于为rbtree增加一些新功能。增强rbtree是建立在基本rbtree基础设施之上的可选功能。想要使用此功能的rbtree用户必须在插入和删除节点时使用用户提供的增强回调来调用增强函数。
实现增强rbtree操作的C文件必须包含<linux/rbtree_augmented.h>而不是<linux/rbtree.h>。请注意，linux/rbtree_augmented.h暴露了一些不应依赖的rbtree实现细节；请坚持使用那里记录的API，并且不要从头文件中包含<linux/rbtree_augmented.h>，以便最小化用户意外依赖这些实现细节的可能性。
在插入时，用户必须更新通往插入节点的路径上的增强信息，然后像往常一样调用rb_link_node()和rb_augment_inserted()，而不是通常的rb_insert_color()调用。如果rb_augment_inserted()重新平衡了rbtree，它将回调到用户提供的函数，以更新受影响的子树上的增强信息。
在擦除节点时，用户必须调用rb_erase_augmented()而不是rb_erase()。rb_erase_augmented()回调到用户提供的函数，以更新受影响的子树上的增强信息。
在这两种情况下，通过struct rb_augment_callbacks提供回调。必须定义3个回调：
- 传播回调，它更新给定节点及其祖先的增强值，直到给定的停止点（或NULL以更新到根）。
- 复制回调，它将给定子树的增强值复制到新分配的子树根。
- 树旋转回调，它将给定子树的增强值复制到新分配的子树根，并重新计算以前的子树根的增强信息。
编译后的rb_erase_augmented()代码可能会内联传播和复制回调，这会导致一个很大的函数，因此每个增强rbtree用户应该在一个地方有一个单独的rb_erase_augmented()调用点，以限制编译后的代码大小。
示例用法
区间树是增强rb树的一个示例。参考 - 《算法导论》（Cormen, Leiserson, Rivest and Stein）. 有关区间树的更多详细信息：
经典的rbtree具有单个键，不能直接用于存储像[lo:hi]这样的区间范围，并快速查找任何与新的lo:hi重叠或查找是否存在与新的lo:hi完全匹配的区间。但是，可以通过结构化方式增强rbtree来存储这样的区间范围，从而可以进行高效的查找和完全匹配。
存储在每个节点中的“额外信息”是其所有后代节点中最大的hi（max_hi）值。这些信息可以通过仅查看节点及其直接子节点来在每个节点上维护。这将用于O(log n)查找最低匹配（所有可能匹配中最低的起始地址）：
struct interval_tree_node *
interval_tree_first_match(struct rb_root *root,
unsigned long start, unsigned long last)
{
struct interval_tree_node *node;
if (!root->rb_node)
return NULL;
node = rb_entry(root->rb_node, struct interval_tree_node, rb);
while (true) {
if (node->rb.rb_left) {
struct interval_tree_node *left =
rb_entry(node->rb.rb_left,
struct interval_tree_node, rb);
if (left->__subtree_last >= start) {
/*
* Some nodes in left subtree satisfy Cond2.
* Iterate to find the leftmost such node N.
* If it also satisfies Cond1, that's the match
* we are looking for. Otherwise, there is no
* matching interval as nodes to the right of N
* can't satisfy Cond1 either.
*/
node = left;
continue;
}
}
if (node->start <= last) { /* Cond1 */
if (node->last >= start) /* Cond2 */
return node; /* node is leftmost match */
if (node->rb.rb_right) {
node = rb_entry(node->rb.rb_right,
struct interval_tree_node, rb);
if (node->__subtree_last >= start)
continue;
}
}
return NULL; /* No match */
}
}
插入/删除使用以下增强回调定义：
static inline unsigned long
compute_subtree_last(struct interval_tree_node *node)
{
unsigned long max = node->last, subtree_last;
if (node->rb.rb_left) {
subtree_last = rb_entry(node->rb.rb_left,
struct interval_tree_node, rb)->__subtree_last;
if (max < subtree_last)
max = subtree_last;
}
if (node->rb.rb_right) {
subtree_last = rb_entry(node->rb.rb_right,
struct interval_tree_node, rb)->__subtree_last;
if (max < subtree_last)
max = subtree_last;
}
return max;
}
static void augment_propagate(struct rb_node *rb, struct rb_node *stop)
{
while (rb != stop) {
struct interval_tree_node *node =
rb_entry(rb, struct interval_tree_node, rb);
unsigned long subtree_last = compute_subtree_last(node);
if (node->__subtree_last == subtree_last)
break;
node->__subtree_last = subtree_last;
rb = rb_parent(&node->rb);
}
}
static void augment_copy(struct rb_node *rb_old, struct rb_node *rb_new)
{
struct interval_tree_node *old =
rb_entry(rb_old, struct interval_tree_node, rb);
struct interval_tree_node *new =
rb_entry(rb_new, struct interval_tree_node, rb);
new->__subtree_last = old->__subtree_last;
}
static void augment_rotate(struct rb_node *rb_old, struct rb_node *rb_new)
{
struct interval_tree_node *old =
rb_entry(rb_old, struct interval_tree_node, rb);
struct interval_tree_node *new =
rb_entry(rb_new, struct interval_tree_node, rb);
new->__subtree_last = old->__subtree_last;
old->__subtree_last = compute_subtree_last(old);
}
static const struct rb_augment_callbacks augment_callbacks = {
augment_propagate, augment_copy, augment_rotate
};
void interval_tree_insert(struct interval_tree_node *node,
struct rb_root *root)
{
struct rb_node **link = &root->rb_node, *rb_parent = NULL;
unsigned long start = node->start, last = node->last;
struct interval_tree_node *parent;
while (*link) {
rb_parent = *link;
parent = rb_entry(rb_parent, struct interval_tree_node, rb);
if (parent->__subtree_last < last)
parent->__subtree_last = last;
if (start < parent->start)
link = &parent->rb.rb_left;
else
link = &parent->rb.rb_right;
}
node->__subtree_last = last;
rb_link_node(&node->rb, rb_parent, link);
rb_insert_augmented(&node->rb, root, &augment_callbacks);
}
void interval_tree_remove(struct interval_tree_node *node,
struct rb_root *root)
{
rb_erase_augmented(&node->rb, root, &augment_callbacks);
}