rbtree.h revision 289644 
1/*-
2 * Copyright (c) 2010 Isilon Systems, Inc.
3 * Copyright (c) 2010 iX Systems, Inc.
4 * Copyright (c) 2010 Panasas, Inc.
5 * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice unmodified, this list of conditions, and the following
13 *    disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 *
29 * $FreeBSD: head/sys/ofed/include/linux/rbtree.h 289644 2015-10-20 19:08:26Z hselasky $
30 */
31#ifndef	_LINUX_RBTREE_H_
32#define	_LINUX_RBTREE_H_
33
34#include <sys/stddef.h>
35#include <sys/tree.h>
36
37struct rb_node {
38	RB_ENTRY(rb_node)	__entry;
39};
40#define	rb_left		__entry.rbe_left
41#define	rb_right	__entry.rbe_right
42
43/*
44 * We provide a false structure that has the same bit pattern as tree.h
45 * presents so it matches the member names expected by linux.
46 */
47struct rb_root {
48	struct	rb_node	*rb_node;
49};
50
51/*
52 * In linux all of the comparisons are done by the caller.
53 */
54int panic_cmp(struct rb_node *one, struct rb_node *two);
55
56RB_HEAD(linux_root, rb_node);
57RB_PROTOTYPE(linux_root, rb_node, __entry, panic_cmp);
58
59#define	rb_parent(r)	RB_PARENT(r, __entry)
60#define	rb_color(r)	RB_COLOR(r, __entry)
61#define	rb_is_red(r)	(rb_color(r) == RB_RED)
62#define	rb_is_black(r)	(rb_color(r) == RB_BLACK)
63#define	rb_set_parent(r, p)	rb_parent((r)) = (p)
64#define	rb_set_color(r, c)	rb_color((r)) = (c)
65#define	rb_entry(ptr, type, member)	container_of(ptr, type, member)
66
67#define RB_EMPTY_ROOT(root)     RB_EMPTY((struct linux_root *)root)
68#define RB_EMPTY_NODE(node)     (rb_parent(node) == node)
69#define RB_CLEAR_NODE(node)     (rb_set_parent(node, node))
70
71#define	rb_insert_color(node, root)					\
72	linux_root_RB_INSERT_COLOR((struct linux_root *)(root), (node))
73#define	rb_erase(node, root)						\
74	linux_root_RB_REMOVE((struct linux_root *)(root), (node))
75#define	rb_next(node)	RB_NEXT(linux_root, NULL, (node))
76#define	rb_prev(node)	RB_PREV(linux_root, NULL, (node))
77#define	rb_first(root)	RB_MIN(linux_root, (struct linux_root *)(root))
78#define	rb_last(root)	RB_MAX(linux_root, (struct linux_root *)(root))
79
80static inline void
81rb_link_node(struct rb_node *node, struct rb_node *parent,
82    struct rb_node **rb_link)
83{
84	rb_set_parent(node, parent);
85	rb_set_color(node, RB_RED);
86	node->__entry.rbe_left = node->__entry.rbe_right = NULL;
87	*rb_link = node;
88}
89
90static inline void
91rb_replace_node(struct rb_node *victim, struct rb_node *new,
92    struct rb_root *root)
93{
94	struct rb_node *p;
95
96	p = rb_parent(victim);
97	if (p) {
98		if (p->rb_left == victim)
99			p->rb_left = new;
100		else
101			p->rb_right = new;
102	} else
103		root->rb_node = new;
104	if (victim->rb_left)
105		rb_set_parent(victim->rb_left, new);
106	if (victim->rb_right)
107		rb_set_parent(victim->rb_right, new);
108	*new = *victim;
109}
110
111#undef RB_ROOT
112#define RB_ROOT		(struct rb_root) { NULL }
113
114#endif	/* _LINUX_RBTREE_H_ */
115