0001 .. SPDX-License-Identifier: GPL-2.0
0002 .. include:: ../disclaimer-zh_CN.rst
0003
0004 :Original: Documentation/core-api/rbtree.rst
0005
0006 :翻译:
0007
0008 唐艺舟 Tang Yizhou <tangyeechou@gmail.com>
0009
0010 =========================
0011 Linux中的红黑树（rbtree）
0012 =========================
0013
0014
0015 :日期: 2007年1月18日
0016 :作者: Rob Landley <rob@landley.net>
0017
0018 何为红黑树，它们有什么用？
0019 --------------------------
0020
0021 红黑树是一种自平衡二叉搜索树，被用来存储可排序的键/值数据对。这与基数树（被用来高效
0022 存储稀疏数组，因此使用长整型下标来插入/访问/删除结点）和哈希表（没有保持排序因而无法
0023 容易地按序遍历，同时必须调节其大小和哈希函数，然而红黑树可以优雅地伸缩以便存储任意
0024 数量的键）不同。
0025
0026 红黑树和AVL树类似，但在插入和删除时提供了更快的实时有界的最坏情况性能（分别最多两次
0027 旋转和三次旋转，来平衡树），查询时间轻微变慢（但时间复杂度仍然是O(log n)）。
0028
0029 引用Linux每周新闻（Linux Weekly News）：
0030
0031 内核中有多处红黑树的使用案例。最后期限调度器和完全公平排队（CFQ）I/O调度器利用
0032 红黑树跟踪请求；数据包CD/DVD驱动程序也是如此。高精度时钟代码使用一颗红黑树组织
0033 未完成的定时器请求。ext3文件系统用红黑树跟踪目录项。虚拟内存区域（VMAs）、epoll
0034 文件描述符、密码学密钥和在“分层令牌桶”调度器中的网络数据包都由红黑树跟踪。
0035
0036 本文档涵盖了对Linux红黑树实现的使用方法。更多关于红黑树的性质和实现的信息，参见：
0037
0038 Linux每周新闻关于红黑树的文章
0039 https://lwn.net/Articles/184495/
0040
0041 维基百科红黑树词条
0042 https://en.wikipedia.org/wiki/Red-black_tree
0043
0044 红黑树的Linux实现
0045 -----------------
0046
0047 Linux的红黑树实现在文件“lib/rbtree.c”中。要使用它，需要“#include <linux/rbtree.h>”。
0048
0049 Linux的红黑树实现对速度进行了优化，因此比传统的实现少一个间接层（有更好的缓存局部性）。
0050 每个rb_node结构体的实例嵌入在它管理的数据结构中，因此不需要靠指针来分离rb_node和它
0051 管理的数据结构。用户应该编写他们自己的树搜索和插入函数，来调用已提供的红黑树函数，
0052 而不是使用一个比较回调函数指针。加锁代码也留给红黑树的用户编写。
0053
0054 创建一颗红黑树
0055 --------------
0056
0057 红黑树中的数据结点是包含rb_node结构体成员的结构体::
0058
0059 struct mytype {
0060 struct rb_node node;
0061 char *keystring;
0062 };
0063
0064 当处理一个指向内嵌rb_node结构体的指针时，包住rb_node的结构体可用标准的container_of()
0065 宏访问。此外，个体成员可直接用rb_entry(node, type, member)访问。
0066
0067 每颗红黑树的根是一个rb_root数据结构，它由以下方式初始化为空:
0068
0069 struct rb_root mytree = RB_ROOT;
0070
0071 在一颗红黑树中搜索值
0072 --------------------
0073
0074 为你的树写一个搜索函数是相当简单的：从树根开始，比较每个值，然后根据需要继续前往左边或
0075 右边的分支。
0076
0077 示例::
0078
0079 struct mytype *my_search(struct rb_root *root, char *string)
0080 {
0081 struct rb_node *node = root->rb_node;
0082
0083 while (node) {
0084 struct mytype *data = container_of(node, struct mytype, node);
0085 int result;
0086
0087 result = strcmp(string, data->keystring);
0088
0089 if (result < 0)
0090 node = node->rb_left;
0091 else if (result > 0)
0092 node = node->rb_right;
0093 else
0094 return data;
0095 }
0096 return NULL;
0097 }
0098
0099 在一颗红黑树中插入数据
0100 ----------------------
0101
0102 在树中插入数据的步骤包括：首先搜索插入新结点的位置，然后插入结点并对树再平衡
0103 （"recoloring"）。
0104
0105 插入的搜索和上文的搜索不同，它要找到嫁接新结点的位置。新结点也需要一个指向它的父节点
0106 的链接，以达到再平衡的目的。
0107
0108 示例::
0109
0110 int my_insert(struct rb_root *root, struct mytype *data)
0111 {
0112 struct rb_node **new = &(root->rb_node), *parent = NULL;
0113
0114 /* Figure out where to put new node */
0115 while (*new) {
0116 struct mytype *this = container_of(*new, struct mytype, node);
0117 int result = strcmp(data->keystring, this->keystring);
0118
0119 parent = *new;
0120 if (result < 0)
0121 new = &((*new)->rb_left);
0122 else if (result > 0)
0123 new = &((*new)->rb_right);
0124 else
0125 return FALSE;
0126 }
0127
0128 /* Add new node and rebalance tree. */
0129 rb_link_node(&data->node, parent, new);
0130 rb_insert_color(&data->node, root);
0131
0132 return TRUE;
0133 }
0134
0135 在一颗红黑树中删除或替换已经存在的数据
0136 --------------------------------------
0137
0138 若要从树中删除一个已经存在的结点，调用::
0139
0140 void rb_erase(struct rb_node *victim, struct rb_root *tree);
0141
0142 示例::
0143
0144 struct mytype *data = mysearch(&mytree, "walrus");
0145
0146 if (data) {
0147 rb_erase(&data->node, &mytree);
0148 myfree(data);
0149 }
0150
0151 若要用一个新结点替换树中一个已经存在的键值相同的结点，调用::
0152
0153 void rb_replace_node(struct rb_node *old, struct rb_node *new,
0154 struct rb_root *tree);
0155
0156 通过这种方式替换结点不会对树做重排序：如果新结点的键值和旧结点不同，红黑树可能被
0157 破坏。
0158
0159 （按排序的顺序）遍历存储在红黑树中的元素
0160 ----------------------------------------
0161
0162 我们提供了四个函数，用于以排序的方式遍历一颗红黑树的内容。这些函数可以在任意红黑树
0163 上工作，并且不需要被修改或包装（除非加锁的目的）::
0164
0165 struct rb_node *rb_first(struct rb_root *tree);
0166 struct rb_node *rb_last(struct rb_root *tree);
0167 struct rb_node *rb_next(struct rb_node *node);
0168 struct rb_node *rb_prev(struct rb_node *node);
0169
0170 要开始迭代，需要使用一个指向树根的指针调用rb_first()或rb_last()，它将返回一个指向
0171 树中第一个或最后一个元素所包含的节点结构的指针。要继续的话，可以在当前结点上调用
0172 rb_next()或rb_prev()来获取下一个或上一个结点。当没有剩余的结点时，将返回NULL。
0173
0174 迭代器函数返回一个指向被嵌入的rb_node结构体的指针，由此，包住rb_node的结构体可用
0175 标准的container_of()宏访问。此外，个体成员可直接用rb_entry(node, type, member)
0176 访问。
0177
0178 示例::
0179
0180 struct rb_node *node;
0181 for (node = rb_first(&mytree); node; node = rb_next(node))
0182 printk("key=%s\n", rb_entry(node, struct mytype, node)->keystring);
0183
0184 带缓存的红黑树
0185 --------------
0186
0187 计算最左边（最小的）结点是二叉搜索树的一个相当常见的任务，例如用于遍历，或用户根据
0188 他们自己的逻辑依赖一个特定的顺序。为此，用户可以使用'struct rb_root_cached'来优化
0189 时间复杂度为O(logN)的rb_first()的调用，以简单地获取指针，避免了潜在的昂贵的树迭代。
0190 维护操作的额外运行时间开销可忽略，不过内存占用较大。
0191
0192 和rb_root结构体类似，带缓存的红黑树由以下方式初始化为空::
0193
0194 struct rb_root_cached mytree = RB_ROOT_CACHED;
0195
0196 带缓存的红黑树只是一个常规的rb_root，加上一个额外的指针来缓存最左边的节点。这使得
0197 rb_root_cached可以存在于rb_root存在的任何地方，并且只需增加几个接口来支持带缓存的
0198 树::
0199
0200 struct rb_node *rb_first_cached(struct rb_root_cached *tree);
0201 void rb_insert_color_cached(struct rb_node *, struct rb_root_cached *, bool);
0202 void rb_erase_cached(struct rb_node *node, struct rb_root_cached *);
0203
0204 操作和删除也有对应的带缓存的树的调用::
0205
0206 void rb_insert_augmented_cached(struct rb_node *node, struct rb_root_cached *,
0207 bool, struct rb_augment_callbacks *);
0208 void rb_erase_augmented_cached(struct rb_node *, struct rb_root_cached *,
0209 struct rb_augment_callbacks *);
0210
0211
0212 对增强型红黑树的支持
0213 --------------------
0214
0215 增强型红黑树是一种在每个结点里存储了“一些”附加数据的红黑树，其中结点N的附加数据
0216 必须是以N为根的子树中所有结点的内容的函数。它是建立在红黑树基础设施之上的可选特性。
0217 想要使用这个特性的红黑树用户，插入和删除结点时必须调用增强型接口并提供增强型回调函数。
0218
0219 实现增强型红黑树操作的C文件必须包含<linux/rbtree_augmented.h>而不是<linux/rbtree.h>。
0220 注意，linux/rbtree_augmented.h暴露了一些红黑树实现的细节而你不应依赖它们，请坚持
0221 使用文档记录的API，并且不要在头文件中包含<linux/rbtree_augmented.h>，以最小化你的
0222 用户意外地依赖这些实现细节的可能。
0223
0224 插入时，用户必须更新通往被插入节点的路径上的增强信息，然后像往常一样调用rb_link_node()，
0225 然后是rb_augment_inserted()而不是平时的rb_insert_color()调用。如果
0226 rb_augment_inserted()再平衡了红黑树，它将回调至一个用户提供的函数来更新受影响的
0227 子树上的增强信息。
0228
0229 删除一个结点时，用户必须调用rb_erase_augmented()而不是rb_erase()。
0230 rb_erase_augmented()回调至一个用户提供的函数来更新受影响的子树上的增强信息。
0231
0232 在两种情况下，回调都是通过rb_augment_callbacks结构体提供的。必须定义3个回调：
0233
0234 - 一个传播回调，它更新一个给定结点和它的祖先们的增强数据，直到一个给定的停止点
0235 （如果是NULL，将更新一路更新到树根）。
0236
0237 - 一个复制回调，它将一颗给定子树的增强数据复制到一个新指定的子树树根。
0238
0239 - 一个树旋转回调，它将一颗给定的子树的增强值复制到新指定的子树树根上，并重新计算
0240 先前的子树树根的增强值。
0241
0242 rb_erase_augmented()编译后的代码可能会内联传播、复制回调，这将导致函数体积更大，
0243 因此每个增强型红黑树的用户应该只有一个rb_erase_augmented()的调用点，以限制编译后
0244 的代码大小。
0245
0246
0247 使用示例
0248 ^^^^^^^^
0249
0250 区间树是增强型红黑树的一个例子。参考Cormen，Leiserson，Rivest和Stein写的
0251 《算法导论》。区间树的更多细节：
0252
0253 经典的红黑树只有一个键，它不能直接用来存储像[lo:hi]这样的区间范围，也不能快速查找
0254 与新的lo:hi重叠的部分，或者查找是否有与新的lo:hi完全匹配的部分。
0255
0256 然而，红黑树可以被增强，以一种结构化的方式来存储这种区间范围，从而使高效的查找和
0257 精确匹配成为可能。
0258
0259 这个存储在每个节点中的“额外信息”是其所有后代结点中的最大hi（max_hi）值。这个信息
0260 可以保持在每个结点上，只需查看一下该结点和它的直系子结点们。这将被用于时间复杂度
0261 为O(log n)的最低匹配查找（所有可能的匹配中最低的起始地址），就像这样::
0262
0263 struct interval_tree_node *
0264 interval_tree_first_match(struct rb_root *root,
0265 unsigned long start, unsigned long last)
0266 {
0267 struct interval_tree_node *node;
0268
0269 if (!root->rb_node)
0270 return NULL;
0271 node = rb_entry(root->rb_node, struct interval_tree_node, rb);
0272
0273 while (true) {
0274 if (node->rb.rb_left) {
0275 struct interval_tree_node *left =
0276 rb_entry(node->rb.rb_left,
0277 struct interval_tree_node, rb);
0278 if (left->__subtree_last >= start) {
0279 /*
0280 * Some nodes in left subtree satisfy Cond2.
0281 * Iterate to find the leftmost such node N.
0282 * If it also satisfies Cond1, that's the match
0283 * we are looking for. Otherwise, there is no
0284 * matching interval as nodes to the right of N
0285 * can't satisfy Cond1 either.
0286 */
0287 node = left;
0288 continue;
0289 }
0290 }
0291 if (node->start <= last) { /* Cond1 */
0292 if (node->last >= start) /* Cond2 */
0293 return node; /* node is leftmost match */
0294 if (node->rb.rb_right) {
0295 node = rb_entry(node->rb.rb_right,
0296 struct interval_tree_node, rb);
0297 if (node->__subtree_last >= start)
0298 continue;
0299 }
0300 }
0301 return NULL; /* No match */
0302 }
0303 }
0304
0305 插入/删除是通过以下增强型回调来定义的::
0306
0307 static inline unsigned long
0308 compute_subtree_last(struct interval_tree_node *node)
0309 {
0310 unsigned long max = node->last, subtree_last;
0311 if (node->rb.rb_left) {
0312 subtree_last = rb_entry(node->rb.rb_left,
0313 struct interval_tree_node, rb)->__subtree_last;
0314 if (max < subtree_last)
0315 max = subtree_last;
0316 }
0317 if (node->rb.rb_right) {
0318 subtree_last = rb_entry(node->rb.rb_right,
0319 struct interval_tree_node, rb)->__subtree_last;
0320 if (max < subtree_last)
0321 max = subtree_last;
0322 }
0323 return max;
0324 }
0325
0326 static void augment_propagate(struct rb_node *rb, struct rb_node *stop)
0327 {
0328 while (rb != stop) {
0329 struct interval_tree_node *node =
0330 rb_entry(rb, struct interval_tree_node, rb);
0331 unsigned long subtree_last = compute_subtree_last(node);
0332 if (node->__subtree_last == subtree_last)
0333 break;
0334 node->__subtree_last = subtree_last;
0335 rb = rb_parent(&node->rb);
0336 }
0337 }
0338
0339 static void augment_copy(struct rb_node *rb_old, struct rb_node *rb_new)
0340 {
0341 struct interval_tree_node *old =
0342 rb_entry(rb_old, struct interval_tree_node, rb);
0343 struct interval_tree_node *new =
0344 rb_entry(rb_new, struct interval_tree_node, rb);
0345
0346 new->__subtree_last = old->__subtree_last;
0347 }
0348
0349 static void augment_rotate(struct rb_node *rb_old, struct rb_node *rb_new)
0350 {
0351 struct interval_tree_node *old =
0352 rb_entry(rb_old, struct interval_tree_node, rb);
0353 struct interval_tree_node *new =
0354 rb_entry(rb_new, struct interval_tree_node, rb);
0355
0356 new->__subtree_last = old->__subtree_last;
0357 old->__subtree_last = compute_subtree_last(old);
0358 }
0359
0360 static const struct rb_augment_callbacks augment_callbacks = {
0361 augment_propagate, augment_copy, augment_rotate
0362 };
0363
0364 void interval_tree_insert(struct interval_tree_node *node,
0365 struct rb_root *root)
0366 {
0367 struct rb_node **link = &root->rb_node, *rb_parent = NULL;
0368 unsigned long start = node->start, last = node->last;
0369 struct interval_tree_node *parent;
0370
0371 while (*link) {
0372 rb_parent = *link;
0373 parent = rb_entry(rb_parent, struct interval_tree_node, rb);
0374 if (parent->__subtree_last < last)
0375 parent->__subtree_last = last;
0376 if (start < parent->start)
0377 link = &parent->rb.rb_left;
0378 else
0379 link = &parent->rb.rb_right;
0380 }
0381
0382 node->__subtree_last = last;
0383 rb_link_node(&node->rb, rb_parent, link);
0384 rb_insert_augmented(&node->rb, root, &augment_callbacks);
0385 }
0386
0387 void interval_tree_remove(struct interval_tree_node *node,
0388 struct rb_root *root)
0389 {
0390 rb_erase_augmented(&node->rb, root, &augment_callbacks);
0391 }
