最近在看linux内核代码,想写点东西,但是学的东西还没成体系,写的时候感觉无从下手。那就从最简单的开始吧。本文仿照linux内核对进程空间中对vm_area_struct的操作,实现了对学生对象(Student)的查找,插入。
红黑树需要满足下列4条规则:
- 每个节点颜色非黑即红
- 树的根必须为黑
- 红节点的孩子必须为黑
- 从一个节点到后代叶子节点的每个路径都包含相同数量的黑色节点
以下是测试代码
#include "rbtree.h"
#include <stdio.h>
#include <stdlib.h>
#define offsetof(TYPE, MEMBER) ((unsigned int) &((TYPE *)0)->MEMBER)
#define TYPEOF(x) (__typeof__(x))
#define container_of(ptr, type, member) ({ \
const typeof( ((type *)0)->member ) *__mptr = (ptr); \
(type *)( (char *)__mptr - offsetof(type,member) );})
struct Student{
int id;
struct rb_node s_rb;
struct Student *s_next;
};
struct Student* find_by_id(struct rb_root *root, int id)
{
struct Student *ptr_stu = NULL;
struct rb_node *rbnode = root->rb_node;
while (NULL != rbnode)
{
struct Student *ptr_tmp = container_of(rbnode, struct Student, s_rb);
if (id < ptr_tmp->id)
{
rbnode = rbnode->rb_left;
}
else if (id > ptr_tmp->id)
{
rbnode = rbnode->rb_right;
}
else
{
ptr_stu = ptr_tmp;
break;
}
}
return ptr_stu;
}
void find_student(struct rb_root *s_root, unsigned int s_id,
struct Student **pprev, struct rb_node ***rb_link,
struct rb_node ** rb_parent)
{
struct rb_node ** __rb_link, * __rb_parent, * rb_prev;
__rb_link = &s_root->rb_node;
rb_prev = __rb_parent = NULL;
while (*__rb_link) {
struct Student *vma_tmp = NULL;
__rb_parent = *__rb_link;
vma_tmp = container_of(__rb_parent, struct Student, s_rb);
if (vma_tmp->id > s_id) {
__rb_link = &__rb_parent->rb_left;
//rb_prev = __rb_parent; // 单向列表逆序排列
} else {
rb_prev = __rb_parent; // 单向列表正序排列
__rb_link = &__rb_parent->rb_right;
}
}
*pprev = NULL;
if (rb_prev)
*pprev = container_of(rb_prev, struct Student, s_rb);
*rb_link = __rb_link;
*rb_parent = __rb_parent;
}
/*
将对象加到单向列表中
stu_header 单向列表的列表头
ptr_stu 对象指针
prev 前一个对象的指针
rb_parent 对象插入红黑树所在节点的父节点
*/
static inline void
student_link_list(struct Student **stu_header, struct Student *ptr_stu,
struct Student *prev, struct rb_node *rb_parent)
{
if (prev) {
ptr_stu->s_next = prev->s_next;
prev->s_next = ptr_stu;
} else {
*stu_header = ptr_stu;
if (rb_parent)
ptr_stu->s_next = container_of(rb_parent,
struct Student, s_rb);
else
ptr_stu->s_next = NULL;
}
}
/*
将对象加到红黑树上
s_root 红黑树root节点
ptr_stu 对象指针
rb_link 对象节点所在的节点
rb_parent 父节点
*/
void student_link_rb(struct rb_root *s_root, struct Student *ptr_stu,
struct rb_node **rb_link, struct rb_node *rb_parent)
{
rb_link_node(&ptr_stu->s_rb, rb_parent, rb_link);
rb_insert_color(&ptr_stu->s_rb, s_root);
}
void add_student(struct rb_root *s_root, struct Student *stu, struct Student **stu_header)
{
struct Student *prev;
struct rb_node **rb_link, *rb_parent;
// 查找对象
find_student(s_root, stu->id, &prev, &rb_link, &rb_parent);
// 将stu插入单向列表
student_link_list(stu_header, stu, prev, rb_parent);
// 插入红黑树
student_link_rb(s_root, stu, rb_link, rb_parent);
}
// 获取节点颜色
const char* get_node_color(struct rb_node *node)
{
int i_black = rb_is_black(node);
// 节点颜色
const char * p_color = "R";
if (i_black)
{
p_color = "B";
}
return p_color;
}
// 打印树
void print_tree(struct rb_node *ptr_node, int id)
{
if (NULL == ptr_node)
{
return;
}
// root节点
if (0 == id)
{
struct Student *vma_root = container_of(ptr_node, struct Student, s_rb);
id = vma_root->id;
printf("%d is root, color is %s\n", id, get_node_color(ptr_node));
}
// 打印左子树
if (ptr_node->rb_left != NULL)
{
struct Student *vma_left = container_of(ptr_node->rb_left, struct Student, s_rb);
printf("%d left -> %d, color is %s\n", id, vma_left->id, get_node_color(ptr_node->rb_left));
print_tree(ptr_node->rb_left, vma_left->id);
}
// 打印右子树
if (ptr_node->rb_right != NULL)
{
struct Student *vma_right = container_of(ptr_node->rb_right, struct Student, s_rb);
printf("%d right -> %d, color is %s\n", id, vma_right->id, get_node_color(ptr_node->rb_right));
print_tree(ptr_node->rb_right, vma_right->id);
}
}
int main()
{
// 列表头
struct Student *stu_header = NULL;
// 红黑树root
struct rb_root s_root = {0};
// 构造对象,并添加到列表和树上
for (size_t i = 10; i < 100; i+=20)
{
struct Student *ptr_stu = (struct Student*)malloc(sizeof(struct Student));
ptr_stu->id = i;
add_student(&s_root, ptr_stu, &stu_header);
}
for (size_t i = 20; i <= 100; i+=20)
{
struct Student *ptr_stu = (struct Student*)malloc(sizeof(struct Student));
ptr_stu->id = i;
add_student(&s_root, ptr_stu, &stu_header);
}
// 打印树
printf("\n打印树\n");
print_tree(s_root.rb_node, 0);
// 按单向列表打印
struct Student *ptr_std = stu_header;
printf("\n");
while (NULL != ptr_std)
{
printf("id = %d\n", ptr_std->id);
ptr_std = ptr_std->s_next;
}
// 查找id为60的对象
struct Student *ptr_stu_del = find_by_id(&s_root, 30);
if (NULL != ptr_stu_del)
{
// 删除id为30的对象
rb_erase(&ptr_stu_del->s_rb, &s_root);
free(ptr_stu_del);
ptr_stu_del = NULL;
// 打印树
printf("\n打印树\n");
print_tree(s_root.rb_node, 0);
}
return 0;
}
运行结果如下:
打印树
30 is root, color is B
30 left -> 10, color is B
10 right -> 20, color is R
30 right -> 70, color is R
70 left -> 50, color is B
50 left -> 40, color is R
50 right -> 60, color is R
70 right -> 90, color is B
90 left -> 80, color is R
90 right -> 100, color is R
单向列表顺序打印
id = 10
id = 20
id = 30
id = 40
id = 50
id = 60
id = 70
id = 80
id = 90
id = 100
打印树
40 is root, color is B
40 left -> 10, color is B
10 right -> 20, color is R
40 right -> 70, color is R
70 left -> 50, color is B
50 right -> 60, color is R
70 right -> 90, color is B
90 left -> 80, color is R
90 right -> 100, color is R
贴下rbtree的源代码。
头文件所在位置 include/linux/rbtree.h
/*
Red Black Trees
(C) 1999 Andrea Arcangeli <andrea@suse.de>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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...
Some example of insert and search follows here. The search is a plain
normal search over an ordered tree. The insert instead must be implemented
int two steps: as first thing the code must insert the element in
order as a red leaf in the tree, then the support library function
rb_insert_color() must be called. Such function will do the
not trivial work to rebalance the rbtree if necessary.
-----------------------------------------------------------------------
static inline struct page * rb_search_page_cache(struct inode * inode,
unsigned long offset)
{
struct rb_node * n = inode->i_rb_page_cache.rb_node;
struct page * page;
while (n)
{
page = rb_entry(n, struct page, rb_page_cache);
if (offset < page->offset)
n = n->rb_left;
else if (offset > page->offset)
n = n->rb_right;
else
return page;
}
return NULL;
}
static inline struct page * __rb_insert_page_cache(struct inode * inode,
unsigned long offset,
struct rb_node * node)
{
struct rb_node ** p = &inode->i_rb_page_cache.rb_node;
struct rb_node * parent = NULL;
struct page * page;
while (*p)
{
parent = *p;
page = rb_entry(parent, struct page, rb_page_cache);
if (offset < page->offset)
p = &(*p)->rb_left;
else if (offset > page->offset)
p = &(*p)->rb_right;
else
return page;
}
rb_link_node(node, parent, p);
return NULL;
}
static inline struct page * rb_insert_page_cache(struct inode * inode,
unsigned long offset,
struct rb_node * node)
{
struct page * ret;
if ((ret = __rb_insert_page_cache(inode, offset, node)))
goto out;
rb_insert_color(node, &inode->i_rb_page_cache);
out:
return ret;
}
-----------------------------------------------------------------------
*/
#ifndef _LINUX_RBTREE_H
#define _LINUX_RBTREE_H
#include <linux/kernel.h>
#include <linux/stddef.h>
struct rb_node
{
unsigned long rb_parent_color;
#define RB_RED 0
#define RB_BLACK 1
struct rb_node *rb_right;
struct rb_node *rb_left;
} __attribute__((aligned(sizeof(long))));
/* The alignment might seem pointless, but allegedly CRIS needs it */
struct rb_root
{
struct rb_node *rb_node;
};
#define rb_parent(r) ((struct rb_node *)((r)->rb_parent_color & ~3))
#define rb_color(r) ((r)->rb_parent_color & 1)
#define rb_is_red(r) (!rb_color(r))
#define rb_is_black(r) rb_color(r)
#define rb_set_red(r) do { (r)->rb_parent_color &= ~1; } while (0)
#define rb_set_black(r) do { (r)->rb_parent_color |= 1; } while (0)
static inline void rb_set_parent(struct rb_node *rb, struct rb_node *p)
{
rb->rb_parent_color = (rb->rb_parent_color & 3) | (unsigned long)p;
}
static inline void rb_set_color(struct rb_node *rb, int color)
{
rb->rb_parent_color = (rb->rb_parent_color & ~1) | color;
}
#define RB_ROOT (struct rb_root) { NULL, }
#define rb_entry(ptr, type, member) container_of(ptr, type, member)
#define RB_EMPTY_ROOT(root) ((root)->rb_node == NULL)
#define RB_EMPTY_NODE(node) (rb_parent(node) == node)
#define RB_CLEAR_NODE(node) (rb_set_parent(node, node))
extern void rb_insert_color(struct rb_node *, struct rb_root *);
extern void rb_erase(struct rb_node *, struct rb_root *);
/* 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 *);
extern struct rb_node *rb_first(const struct rb_root *);
extern struct rb_node *rb_last(const struct rb_root *);
/* 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);
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;
}
#endif /* _LINUX_RBTREE_H */
源文件所在位置lib/rbtree.c
/*
Red Black Trees
(C) 1999 Andrea Arcangeli <andrea@suse.de>
(C) 2002 David Woodhouse <dwmw2@infradead.org>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
linux/lib/rbtree.c
*/
#include "rbtree.h"
static void __rb_rotate_left(struct rb_node *node, struct rb_root *root)
{
struct rb_node *right = node->rb_right;
struct rb_node *parent = rb_parent(node);
if ((node->rb_right = right->rb_left))
rb_set_parent(right->rb_left, node);
right->rb_left = node;
rb_set_parent(right, parent);
if (parent)
{
if (node == parent->rb_left)
parent->rb_left = right;
else
parent->rb_right = right;
}
else
root->rb_node = right;
rb_set_parent(node, right);
}
static void __rb_rotate_right(struct rb_node *node, struct rb_root *root)
{
struct rb_node *left = node->rb_left;
struct rb_node *parent = rb_parent(node);
if ((node->rb_left = left->rb_right))
rb_set_parent(left->rb_right, node);
left->rb_right = node;
rb_set_parent(left, parent);
if (parent)
{
if (node == parent->rb_right)
parent->rb_right = left;
else
parent->rb_left = left;
}
else
root->rb_node = left;
rb_set_parent(node, left);
}
void rb_insert_color(struct rb_node *node, struct rb_root *root)
{
struct rb_node *parent, *gparent;
while ((parent = rb_parent(node)) && rb_is_red(parent))
{
gparent = rb_parent(parent);
if (parent == gparent->rb_left)
{
{
register struct rb_node *uncle = gparent->rb_right;
if (uncle && rb_is_red(uncle))
{
rb_set_black(uncle);
rb_set_black(parent);
rb_set_red(gparent);
node = gparent;
continue;
}
}
if (parent->rb_right == node)
{
register struct rb_node *tmp;
__rb_rotate_left(parent, root);
tmp = parent;
parent = node;
node = tmp;
}
rb_set_black(parent);
rb_set_red(gparent);
__rb_rotate_right(gparent, root);
} else {
{
register struct rb_node *uncle = gparent->rb_left;
if (uncle && rb_is_red(uncle))
{
rb_set_black(uncle);
rb_set_black(parent);
rb_set_red(gparent);
node = gparent;
continue;
}
}
if (parent->rb_left == node)
{
register struct rb_node *tmp;
__rb_rotate_right(parent, root);
tmp = parent;
parent = node;
node = tmp;
}
rb_set_black(parent);
rb_set_red(gparent);
__rb_rotate_left(gparent, root);
}
}
rb_set_black(root->rb_node);
}
EXPORT_SYMBOL(rb_insert_color);
static void __rb_erase_color(struct rb_node *node, struct rb_node *parent,
struct rb_root *root)
{
struct rb_node *other;
while ((!node || rb_is_black(node)) && node != root->rb_node)
{
if (parent->rb_left == node)
{
other = parent->rb_right;
if (rb_is_red(other))
{
rb_set_black(other);
rb_set_red(parent);
__rb_rotate_left(parent, root);
other = parent->rb_right;
}
if ((!other->rb_left || rb_is_black(other->rb_left)) &&
(!other->rb_right || rb_is_black(other->rb_right)))
{
rb_set_red(other);
node = parent;
parent = rb_parent(node);
}
else
{
if (!other->rb_right || rb_is_black(other->rb_right))
{
rb_set_black(other->rb_left);
rb_set_red(other);
__rb_rotate_right(other, root);
other = parent->rb_right;
}
rb_set_color(other, rb_color(parent));
rb_set_black(parent);
rb_set_black(other->rb_right);
__rb_rotate_left(parent, root);
node = root->rb_node;
break;
}
}
else
{
other = parent->rb_left;
if (rb_is_red(other))
{
rb_set_black(other);
rb_set_red(parent);
__rb_rotate_right(parent, root);
other = parent->rb_left;
}
if ((!other->rb_left || rb_is_black(other->rb_left)) &&
(!other->rb_right || rb_is_black(other->rb_right)))
{
rb_set_red(other);
node = parent;
parent = rb_parent(node);
}
else
{
if (!other->rb_left || rb_is_black(other->rb_left))
{
rb_set_black(other->rb_right);
rb_set_red(other);
__rb_rotate_left(other, root);
other = parent->rb_left;
}
rb_set_color(other, rb_color(parent));
rb_set_black(parent);
rb_set_black(other->rb_left);
__rb_rotate_right(parent, root);
node = root->rb_node;
break;
}
}
}
if (node)
rb_set_black(node);
}
void rb_erase(struct rb_node *node, struct rb_root *root)
{
struct rb_node *child, *parent;
int color;
if (!node->rb_left)
child = node->rb_right;
else if (!node->rb_right)
child = node->rb_left;
else
{
struct rb_node *old = node, *left;
node = node->rb_right;
while ((left = node->rb_left) != NULL)
node = left;
if (rb_parent(old)) {
if (rb_parent(old)->rb_left == old)
rb_parent(old)->rb_left = node;
else
rb_parent(old)->rb_right = node;
} else
root->rb_node = node;
child = node->rb_right;
parent = rb_parent(node);
color = rb_color(node);
if (parent == old) {
parent = node;
} else {
if (child)
rb_set_parent(child, parent);
parent->rb_left = child;
node->rb_right = old->rb_right;
rb_set_parent(old->rb_right, node);
}
node->rb_parent_color = old->rb_parent_color;
node->rb_left = old->rb_left;
rb_set_parent(old->rb_left, node);
goto color;
}
parent = rb_parent(node);
color = rb_color(node);
if (child)
rb_set_parent(child, parent);
if (parent)
{
if (parent->rb_left == node)
parent->rb_left = child;
else
parent->rb_right = child;
}
else
root->rb_node = child;
color:
if (color == RB_BLACK)
__rb_erase_color(child, parent, root);
}
EXPORT_SYMBOL(rb_erase);
/*
* This function returns the first node (in sort order) of the tree.
*/
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;
}
EXPORT_SYMBOL(rb_first);
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;
}
EXPORT_SYMBOL(rb_last);
struct rb_node *rb_next(const struct rb_node *node)
{
struct rb_node *parent;
if (rb_parent(node) == node)
return NULL;
/* If we have a right-hand child, go down and then left as far
as we can. */
if (node->rb_right) {
node = node->rb_right;
while (node->rb_left)
node=node->rb_left;
return (struct rb_node *)node;
}
/* No right-hand children. Everything down and left is
smaller than us, so any 'next' node must be in the general
direction of our parent. Go up the tree; any time the
ancestor is a right-hand child of its parent, keep going
up. First time it's a left-hand child of its parent, said
parent is our 'next' node. */
while ((parent = rb_parent(node)) && node == parent->rb_right)
node = parent;
return parent;
}
EXPORT_SYMBOL(rb_next);
struct rb_node *rb_prev(const struct rb_node *node)
{
struct rb_node *parent;
if (rb_parent(node) == node)
return NULL;
/* If we have a left-hand child, go down and then right as far
as we can. */
if (node->rb_left) {
node = node->rb_left;
while (node->rb_right)
node=node->rb_right;
return (struct rb_node *)node;
}
/* No left-hand children. Go up till we find an ancestor which
is a right-hand child of its parent */
while ((parent = rb_parent(node)) && node == parent->rb_left)
node = parent;
return parent;
}
EXPORT_SYMBOL(rb_prev);
void rb_replace_node(struct rb_node *victim, struct rb_node *new,
struct rb_root *root)
{
struct rb_node *parent = rb_parent(victim);
/* Set the surrounding nodes to point to the replacement */
if (parent) {
if (victim == parent->rb_left)
parent->rb_left = new;
else
parent->rb_right = new;
} else {
root->rb_node = new;
}
if (victim->rb_left)
rb_set_parent(victim->rb_left, new);
if (victim->rb_right)
rb_set_parent(victim->rb_right, new);
/* Copy the pointers/colour from the victim to the replacement */
*new = *victim;
}
EXPORT_SYMBOL(rb_replace_node);