summaryrefslogtreecommitdiff
path: root/include/linux/interval_tree_tmpl.h
blob: c1aeb922d65fc55a621459b88b224cfdec466aa0 (plain)
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
/*
  Interval Trees
  (C) 2012  Michel Lespinasse <walken@google.com>

  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

  include/linux/interval_tree_tmpl.h
*/

#include <linux/rbtree_augmented.h>

/*
 * Template for implementing interval trees
 *
 * ITSTRUCT:   struct type of the interval tree nodes
 * ITRB:       name of struct rb_node field within ITSTRUCT
 * ITTYPE:     type of the interval endpoints
 * ITSUBTREE:  name of ITTYPE field within ITSTRUCT holding last-in-subtree
 * ITSTART(n): start endpoint of ITSTRUCT node n
 * ITLAST(n):  last endpoing of ITSTRUCT node n
 * ITSTATIC:   'static' or empty
 * ITPREFIX:   prefix to use for the inline tree definitions
 */

/* IT(name) -> ITPREFIX_name */
#define _ITNAME(prefix, name) prefix ## _ ## name
#define ITNAME(prefix, name) _ITNAME(prefix, name)
#define IT(name) ITNAME(ITPREFIX, name)

/* Callbacks for augmented rbtree insert and remove */

static inline ITTYPE IT(compute_subtree_last)(ITSTRUCT *node)
{
	ITTYPE max = ITLAST(node), subtree_last;
	if (node->ITRB.rb_left) {
		subtree_last = rb_entry(node->ITRB.rb_left,
					ITSTRUCT, ITRB)->ITSUBTREE;
		if (max < subtree_last)
			max = subtree_last;
	}
	if (node->ITRB.rb_right) {
		subtree_last = rb_entry(node->ITRB.rb_right,
					ITSTRUCT, ITRB)->ITSUBTREE;
		if (max < subtree_last)
			max = subtree_last;
	}
	return max;
}

static inline void
IT(augment_propagate)(struct rb_node *rb, struct rb_node *stop)
{
	while (rb != stop) {
		ITSTRUCT *node = rb_entry(rb, ITSTRUCT, ITRB);
		ITTYPE subtree_last = IT(compute_subtree_last)(node);
		if (node->ITSUBTREE == subtree_last)
			break;
		node->ITSUBTREE = subtree_last;
		rb = rb_parent(&node->ITRB);
	}
}

static inline void
IT(augment_copy)(struct rb_node *rb_old, struct rb_node *rb_new)
{
	ITSTRUCT *old = rb_entry(rb_old, ITSTRUCT, ITRB);
	ITSTRUCT *new = rb_entry(rb_new, ITSTRUCT, ITRB);

	new->ITSUBTREE = old->ITSUBTREE;
}

static void IT(augment_rotate)(struct rb_node *rb_old, struct rb_node *rb_new)
{
	ITSTRUCT *old = rb_entry(rb_old, ITSTRUCT, ITRB);
	ITSTRUCT *new = rb_entry(rb_new, ITSTRUCT, ITRB);

	new->ITSUBTREE = old->ITSUBTREE;
	old->ITSUBTREE = IT(compute_subtree_last)(old);
}

static const struct rb_augment_callbacks IT(augment_callbacks) = {
	IT(augment_propagate), IT(augment_copy), IT(augment_rotate)
};

/* Insert / remove interval nodes from the tree */

ITSTATIC void IT(insert)(ITSTRUCT *node, struct rb_root *root)
{
	struct rb_node **link = &root->rb_node, *rb_parent = NULL;
	ITTYPE start = ITSTART(node), last = ITLAST(node);
	ITSTRUCT *parent;

	while (*link) {
		rb_parent = *link;
		parent = rb_entry(rb_parent, ITSTRUCT, ITRB);
		if (parent->ITSUBTREE < last)
			parent->ITSUBTREE = last;
		if (start < ITSTART(parent))
			link = &parent->ITRB.rb_left;
		else
			link = &parent->ITRB.rb_right;
	}

	node->ITSUBTREE = last;
	rb_link_node(&node->ITRB, rb_parent, link);
	rb_insert_augmented(&node->ITRB, root, &IT(augment_callbacks));
}

ITSTATIC void IT(remove)(ITSTRUCT *node, struct rb_root *root)
{
	rb_erase_augmented(&node->ITRB, root, &IT(augment_callbacks));
}

/*
 * Iterate over intervals intersecting [start;last]
 *
 * Note that a node's interval intersects [start;last] iff:
 *   Cond1: ITSTART(node) <= last
 * and
 *   Cond2: start <= ITLAST(node)
 */

static ITSTRUCT *IT(subtree_search)(ITSTRUCT *node, ITTYPE start, ITTYPE last)
{
	while (true) {
		/*
		 * Loop invariant: start <= node->ITSUBTREE
		 * (Cond2 is satisfied by one of the subtree nodes)
		 */
		if (node->ITRB.rb_left) {
			ITSTRUCT *left = rb_entry(node->ITRB.rb_left,
						  ITSTRUCT, ITRB);
			if (start <= left->ITSUBTREE) {
				/*
				 * 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 (ITSTART(node) <= last) {		/* Cond1 */
			if (start <= ITLAST(node))	/* Cond2 */
				return node;	/* node is leftmost match */
			if (node->ITRB.rb_right) {
				node = rb_entry(node->ITRB.rb_right,
						ITSTRUCT, ITRB);
				if (start <= node->ITSUBTREE)
					continue;
			}
		}
		return NULL;	/* No match */
	}
}

ITSTATIC ITSTRUCT *IT(iter_first)(struct rb_root *root,
				  ITTYPE start, ITTYPE last)
{
	ITSTRUCT *node;

	if (!root->rb_node)
		return NULL;
	node = rb_entry(root->rb_node, ITSTRUCT, ITRB);
	if (node->ITSUBTREE < start)
		return NULL;
	return IT(subtree_search)(node, start, last);
}

ITSTATIC ITSTRUCT *IT(iter_next)(ITSTRUCT *node, ITTYPE start, ITTYPE last)
{
	struct rb_node *rb = node->ITRB.rb_right, *prev;

	while (true) {
		/*
		 * Loop invariants:
		 *   Cond1: ITSTART(node) <= last
		 *   rb == node->ITRB.rb_right
		 *
		 * First, search right subtree if suitable
		 */
		if (rb) {
			ITSTRUCT *right = rb_entry(rb, ITSTRUCT, ITRB);
			if (start <= right->ITSUBTREE)
				return IT(subtree_search)(right, start, last);
		}

		/* Move up the tree until we come from a node's left child */
		do {
			rb = rb_parent(&node->ITRB);
			if (!rb)
				return NULL;
			prev = &node->ITRB;
			node = rb_entry(rb, ITSTRUCT, ITRB);
			rb = node->ITRB.rb_right;
		} while (prev == rb);

		/* Check if the node intersects [start;last] */
		if (last < ITSTART(node))		/* !Cond1 */
			return NULL;
		else if (start <= ITLAST(node))		/* Cond2 */
			return node;
	}
}