summaryrefslogtreecommitdiffstats
path: root/cpukit/include/linux/rbtree.h
blob: b6ec864d06d27f0a94ff68eb2f715588994226c7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/* SPDX-License-Identifier: BSD-2-Clause */

/*
 * Copyright (c) 2015 embedded brains GmbH.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _LINUX_RBTREE_H
#define _LINUX_RBTREE_H

#include <rtems/score/rbtree.h>

#define rb_node RBTree_Node

#define rb_left Node.rbe_left

#define rb_right Node.rbe_right

/*
 * Getting rid of this placeholder structure is a bit difficult.  The use of
 * this placeholder struct may lead to bugs with link-time optimization due to
 * a strict aliasing violation.
 *
 * A common use of this API is a direct access of the rb_node member to get the
 * root node of the tree. So, this cannot be changed.
 *
 * The red-black tree implementation is provided by <sys/tree.h> and we have
 *
 * struct RBTree_Control {
 *   struct RBTree_Node *rbh_root;
 * };
 *
 * The member name rbh_root is fixed by the <sys/tree.h> API.  To use
 * RBTree_Control directly we would need two defines:
 *
 * #define rb_root RBTree_Control
 * #define rb_node rbh_root
 *
 * We already have an rb_node define to RBTree_Node, see above.
 */
struct rb_root {
  RBTree_Node *rb_node;
};

RTEMS_STATIC_ASSERT(
  sizeof( struct rb_root ) == sizeof( RBTree_Control ),
  rb_root_size
);

RTEMS_STATIC_ASSERT(
  offsetof( struct rb_root, rb_node ) == offsetof( RBTree_Control, rbh_root ),
  rb_root_node
);

#undef RB_ROOT
#define RB_ROOT ( (struct rb_root) { NULL } )

#define rb_entry( p, container, field ) RTEMS_CONTAINER_OF( p, container, field )

static inline void rb_insert_color( struct rb_node *node, struct rb_root *root)
{
  _RBTree_Insert_color( (RBTree_Control *) root, node );
}

static inline void rb_erase( struct rb_node *node, struct rb_root *root )
{
  _RBTree_Extract( (RBTree_Control *) root, node );
}

static inline struct rb_node *rb_next( struct rb_node *node )
{
  return _RBTree_Successor( node );
}

static inline struct rb_node *rb_prev( struct rb_node *node )
{
  return _RBTree_Predecessor( node );
}

static inline struct rb_node *rb_first( struct rb_root *root )
{
  return _RBTree_Minimum( (RBTree_Control *) root );
}

static inline struct rb_node *rb_last( struct rb_root *root )
{
  return _RBTree_Maximum( (RBTree_Control *) root );
}

static inline void rb_replace_node(
  struct rb_node *victim,
  struct rb_node *replacement, 
  struct rb_root *root
)
{
  _RBTree_Replace_node(
    (RBTree_Control *) root,
    victim,
    replacement
  );
}

static inline void rb_link_node(
  struct rb_node *node,
  struct rb_node *parent,
  struct rb_node **link
)
{
  _RBTree_Initialize_node( node );
  _RBTree_Add_child( node, parent, link );
}

static inline struct rb_node *rb_parent( struct rb_node *node )
{
  return _RBTree_Parent( node );
}

#define rbtree_postorder_for_each_entry_safe( node, next, root, field ) \
  for ( \
    node = _RBTree_Postorder_first( \
      (RBTree_Control *) root, \
      offsetof( __typeof__( *node ), field ) \
    ); \
    node != NULL && ( \
      next = _RBTree_Postorder_next( \
        &node->field, \
        offsetof( __typeof__( *node ), field ) \
      ), \
      node != NULL \
    ); \
    node = next \
  )

#endif /* _LINUX_RBTREE_H */