4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
31 * This file is part of Lustre, http://www.lustre.org/
32 * Lustre is a trademark of Sun Microsystems, Inc.
34 * lustre/include/interval_tree.h
36 * Author: Huang Wei <huangwei@clusterfs.com>
37 * Author: Jay Xiong <jinshan.xiong@sun.com>
43 #include <libcfs/libcfs.h> /* LASSERT. */
45 struct interval_node {
46 struct interval_node *in_left;
47 struct interval_node *in_right;
48 struct interval_node *in_parent;
50 in_intree:1, /** set if the node is in tree */
52 __u8 in_res2[4]; /** tags, 8-bytes aligned */
54 struct interval_node_extent {
61 INTERVAL_ITER_CONT = 1,
62 INTERVAL_ITER_STOP = 2
65 static inline int interval_is_intree(struct interval_node *node)
67 return node->in_intree == 1;
70 static inline __u64 interval_low(struct interval_node *node)
72 return node->in_extent.start;
75 static inline __u64 interval_high(struct interval_node *node)
77 return node->in_extent.end;
80 static inline void interval_set(struct interval_node *node,
81 __u64 start, __u64 end)
83 LASSERT(start <= end);
84 node->in_extent.start = start;
85 node->in_extent.end = end;
86 node->in_max_high = end;
89 /* Rules to write an interval callback.
90 * - the callback returns INTERVAL_ITER_STOP when it thinks the iteration
91 * should be stopped. It will then cause the iteration function to return
92 * immediately with return value INTERVAL_ITER_STOP.
93 * - callbacks for interval_iterate and interval_iterate_reverse: Every
94 * nodes in the tree will be set to @node before the callback being called
95 * - callback for interval_search: Only overlapped node will be set to @node
96 * before the callback being called.
98 typedef enum interval_iter (*interval_callback_t)(struct interval_node *node,
101 struct interval_node *interval_insert(struct interval_node *node,
102 struct interval_node **root);
103 void interval_erase(struct interval_node *node, struct interval_node **root);
105 /* Search the extents in the tree and call @func for each overlapped
107 enum interval_iter interval_search(struct interval_node *root,
108 struct interval_node_extent *ex,
109 interval_callback_t func, void *data);
111 /* Iterate every node in the tree - by reverse order or regular order. */
112 enum interval_iter interval_iterate(struct interval_node *root,
113 interval_callback_t func, void *data);
114 enum interval_iter interval_iterate_reverse(struct interval_node *root,
115 interval_callback_t func,void *data);
117 void interval_expand(struct interval_node *root,
118 struct interval_node_extent *ext,
119 struct interval_node_extent *limiter);
120 int interval_is_overlapped(struct interval_node *root,
121 struct interval_node_extent *ex);
122 struct interval_node *interval_find(struct interval_node *root,
123 struct interval_node_extent *ex);