8148fa5ba2299c8f6fd3887da1a22d5f23b78710
[asterisk/asterisk.git] / include / asterisk / heap.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Russell Bryant <russell@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief Max Heap data structure
22  * \author Russell Bryant <russell@digium.com>
23  */
24
25 #ifndef __AST_HEAP_H__
26 #define __AST_HEAP_H__
27
28 /*!
29  * \brief A max heap.
30  *
31  * \note Thread-safety is left to the user of the API.  The heap API provides
32  *       no locking of its own.  If the heap will be accessed by multiple threads,
33  *       then a lock must be used to ensure that only a single operation is
34  *       done on the heap at a time.  For the sake of convenience, a lock is
35  *       provided for the user of the API to use if another lock is not already
36  *       available to protect the heap.
37  */
38 struct ast_heap;
39
40 /*!
41  * \brief Function type for comparing nodes in a heap
42  *
43  * \param elm1 the first element
44  * \param elm2 the second element
45  *
46  * \retval negative if elm1 < elm2
47  * \retval 0 if elm1 == elm2
48  * \retval positive if elm1 > elm2
49  *
50  * \note This implementation is of a max heap.  However, if a min heap is
51  *       desired, simply swap the return values of this function.
52  */
53 typedef int (*ast_heap_cmp_fn)(void *elm1, void *elm2);
54
55 /*!
56  * \brief Create a max heap
57  *
58  * \param init_height The initial height of the heap to allocate space for.
59  *        To start out, there will be room for (2 ^ init_height) - 1 entries.
60  *        However, the heap will grow as needed.
61  * \param cmp_fn The function that should be used to compare elements in the heap.
62  * \param index_offset This parameter is optional, but must be provided to be able
63  *        to use ast_heap_remove().  This is the number of bytes into the element
64  *        where an ssize_t has been made available for the heap's internal
65  *        use.  The heap will use this field to keep track of the element's current
66  *        position in the heap.  The offsetof() macro is useful for providing a
67  *        proper value for this argument.  If ast_heap_remove() will not be used,
68  *        then a negative value can be provided to indicate that no field for an
69  *        offset has been allocated.
70  *
71  * Example Usage:
72  *
73  * \code
74  *
75  * struct myobj {
76  *    int foo;
77  *    int bar;
78  *    char stuff[8];
79  *    char things[8];
80  *    ssize_t __heap_index;
81  * };
82  *
83  * ...
84  *
85  * static int myobj_cmp(void *obj1, void *obj2);
86  *
87  * ...
88  *
89  * struct ast_heap *h;
90  *
91  * h = ast_heap_create(8, myobj_cmp, offsetof(struct myobj, __heap_index));
92  *
93  * \endcode
94  *
95  * \return An instance of a max heap
96  */
97 struct ast_heap *ast_heap_create(unsigned int init_height, ast_heap_cmp_fn cmp_fn,
98                 ssize_t index_offset);
99
100 /*!
101  * \brief Destroy a max heap
102  *
103  * \param h the heap to destroy
104  *
105  * \return NULL for convenience
106  */
107 struct ast_heap *ast_heap_destroy(struct ast_heap *h);
108
109 /*!
110  * \brief Push an element on to a heap
111  *
112  * \param h the heap being added to
113  * \param elm the element being put on the heap
114  *
115  * \retval 0 success
116  * \retval non-zero failure
117  */
118 int ast_heap_push(struct ast_heap *h, void *elm);
119
120 /*!
121  * \brief Pop the max element off of the heap
122  *
123  * \param h the heap
124  *
125  * \return this will return the element on the top of the heap, which has the
126  *         largest value according to the element comparison function that was
127  *         provided when the heap was created.  The element will be removed before
128  *         being returned.
129  */
130 void *ast_heap_pop(struct ast_heap *h);
131
132 /*!
133  * \brief Remove a specific element from a heap
134  *
135  * \param h the heap to remove from
136  * \param elm the element to remove
137  *
138  * \return elm, if the removal was successful, or NULL if it failed
139  *
140  * \note the index_offset parameter to ast_heap_create() is required to be able
141  *       to use this function.
142  */
143 void *ast_heap_remove(struct ast_heap *h, void *elm);
144
145 /*!
146  * \brief Peek at an element on a heap
147  *
148  * \param h the heap
149  * \param index index of the element to return.  The first element is at index 1,
150  *        and the last element is at the index == the size of the heap.
151  *
152  * \return an element at the specified index on the heap.  This element will \b not
153  *         be removed before being returned.
154  *
155  * \note If this function is being used in combination with ast_heap_size() for
156  *       purposes of traversing the heap, the heap must be locked for the entire
157  *       duration of the traversal.
158  *
159  * Example code for a traversal:
160  * \code
161  *
162  * struct ast_heap *h;
163  *
164  * ...
165  *
166  * size_t size, i;
167  * void *cur_obj;
168  *
169  * ast_heap_rdlock(h);
170  *
171  * size = ast_heap_size(h);
172  *
173  * for (i = 1; i <= size && (cur_obj = ast_heap_peek(h, i)); i++) {
174  *     ... Do stuff with cur_obj ...
175  * }
176  *
177  * ast_heap_unlock(h);
178  *
179  * \endcode
180  */
181 void *ast_heap_peek(struct ast_heap *h, unsigned int index);
182
183 /*!
184  * \brief Get the current size of a heap
185  *
186  * \param h the heap
187  *
188  * \return the number of elements currently in the heap
189  */
190 size_t ast_heap_size(struct ast_heap *h);
191
192 /*!
193  * \brief Write-Lock a heap
194  *
195  * \arg h the heap
196  *
197  * A lock is provided for convenience.  It can be assumed that none of the
198  * ast_heap API calls are thread safe.  This lock does not have to be used
199  * if another one is already available to protect the heap.
200  *
201  * \return see the documentation for pthread_rwlock_wrlock()
202  */
203 int ast_heap_wrlock(struct ast_heap *h);
204
205 /*!
206  * \brief Read-Lock a heap
207  *
208  * \arg h the heap
209  *
210  * A lock is provided for convenience.  It can be assumed that none of the
211  * ast_heap API calls are thread safe.  This lock does not have to be used
212  * if another one is already available to protect the heap.
213  *
214  * \return see the documentation for pthread_rwlock_rdlock()
215  */
216 int ast_heap_rdlock(struct ast_heap *h);
217
218 /*!
219  * \brief Unlock a heap
220  *
221  * \arg h the heap
222  *
223  * \return see the documentation for pthread_rwlock_unlock()
224  */
225 int ast_heap_unlock(struct ast_heap *h);
226
227 /*!
228  * \brief Verify that a heap has been properly constructed
229  *
230  * \param h a heap
231  *
232  * \retval 0 success
233  * \retval non-zero failure
234  *
235  * \note This function is mostly for debugging purposes.  It traverses an existing
236  *       heap and verifies that every node is properly placed relative to its children.
237  */
238 int ast_heap_verify(struct ast_heap *h);
239
240 #endif /* __AST_HEAP_H__ */