Max Heap data structure. More...
#include "asterisk.h"
#include "asterisk/heap.h"
#include "asterisk/utils.h"
#include "asterisk/cli.h"
Go to the source code of this file.
Data Structures | |
struct | ast_heap |
Functions | |
int | __ast_heap_rdlock (struct ast_heap *h, const char *file, const char *func, int line) |
Read-Lock a heap. More... | |
int | __ast_heap_unlock (struct ast_heap *h, const char *file, const char *func, int line) |
Unlock a heap. More... | |
int | __ast_heap_wrlock (struct ast_heap *h, const char *file, const char *func, int line) |
Write-Lock a heap. More... | |
static void * | _ast_heap_remove (struct ast_heap *h, unsigned int index) |
struct ast_heap * | ast_heap_create (unsigned int init_height, ast_heap_cmp_fn cmp_fn, ssize_t index_offset) |
Create a max heap. More... | |
struct ast_heap * | ast_heap_destroy (struct ast_heap *h) |
Destroy a max heap. More... | |
void * | ast_heap_peek (struct ast_heap *h, unsigned int index) |
Peek at an element on a heap. More... | |
void * | ast_heap_pop (struct ast_heap *h) |
Pop the max element off of the heap. More... | |
int | ast_heap_push (struct ast_heap *h, void *elm) |
Push an element on to a heap. More... | |
void * | ast_heap_remove (struct ast_heap *h, void *elm) |
Remove a specific element from a heap. More... | |
size_t | ast_heap_size (struct ast_heap *h) |
Get the current size of a heap. More... | |
int | ast_heap_verify (struct ast_heap *h) |
Verify that a heap has been properly constructed. More... | |
static int | bubble_up (struct ast_heap *h, int i) |
static ssize_t | get_index (struct ast_heap *h, void *elm) |
static int | grow_heap (struct ast_heap *h) |
Add a row of additional storage for the heap. More... | |
static void * | heap_get (struct ast_heap *h, int i) |
static void | heap_set (struct ast_heap *h, int i, void *elm) |
static void | heap_swap (struct ast_heap *h, int i, int j) |
static int | left_node (int i) |
static void | max_heapify (struct ast_heap *h, int i) |
static int | parent_node (int i) |
static int | right_node (int i) |
Max Heap data structure.
Definition in file heap.c.
int __ast_heap_rdlock | ( | struct ast_heap * | h, |
const char * | file, | ||
const char * | func, | ||
int | line | ||
) |
Read-Lock a heap.
h | the heap |
A lock is provided for convenience. It can be assumed that none of the ast_heap API calls are thread safe. This lock does not have to be used if another one is already available to protect the heap.
Definition at line 319 of file heap.c.
References __ast_rwlock_rdlock(), and ast_heap::lock.
int __ast_heap_unlock | ( | struct ast_heap * | h, |
const char * | file, | ||
const char * | func, | ||
int | line | ||
) |
Unlock a heap.
h | the heap |
Definition at line 324 of file heap.c.
References __ast_rwlock_unlock(), and ast_heap::lock.
int __ast_heap_wrlock | ( | struct ast_heap * | h, |
const char * | file, | ||
const char * | func, | ||
int | line | ||
) |
Write-Lock a heap.
h | the heap |
A lock is provided for convenience. It can be assumed that none of the ast_heap API calls are thread safe. This lock does not have to be used if another one is already available to protect the heap.
Definition at line 314 of file heap.c.
References __ast_rwlock_wrlock(), and ast_heap::lock.
|
static |
Definition at line 268 of file heap.c.
References bubble_up(), ast_heap::cur_len, heap_get(), heap_set(), and max_heapify().
Referenced by ast_heap_pop(), and ast_heap_remove().
struct ast_heap* ast_heap_create | ( | unsigned int | init_height, |
ast_heap_cmp_fn | cmp_fn, | ||
ssize_t | index_offset | ||
) |
Create a max heap.
init_height | The initial height of the heap to allocate space for. To start out, there will be room for (2 ^ init_height) - 1 entries. However, the heap will grow as needed. |
cmp_fn | The function that should be used to compare elements in the heap. |
index_offset | This parameter is optional, but must be provided to be able to use ast_heap_remove(). This is the number of bytes into the element where an ssize_t has been made available for the heap's internal use. The heap will use this field to keep track of the element's current position in the heap. The offsetof() macro is useful for providing a proper value for this argument. If ast_heap_remove() will not be used, then a negative value can be provided to indicate that no field for an offset has been allocated. |
Example Usage:
Definition at line 118 of file heap.c.
References __ast_calloc(), ast_calloc, ast_free, ast_log(), ast_rwlock_init, ast_heap::avail_len, ast_heap::cmp_fn, ast_heap::heap, ast_heap::index_offset, ast_heap::lock, and LOG_ERROR.
Referenced by ast_timing_init(), load_resource_list(), and sched_context_create().
Destroy a max heap.
h | the heap to destroy |
Definition at line 163 of file heap.c.
References ast_free, ast_rwlock_destroy, ast_heap::heap, and ast_heap::lock.
Referenced by load_resource_list(), sched_context_destroy(), and timing_shutdown().
void* ast_heap_peek | ( | struct ast_heap * | h, |
unsigned int | index | ||
) |
Peek at an element on a heap.
h | the heap |
index | index of the element to return. The first element is at index 1, and the last element is at the index == the size of the heap. |
Example code for a traversal:
Definition at line 300 of file heap.c.
References ast_heap::cur_len, and heap_get().
Referenced by ast_sched_dump(), ast_sched_report(), ast_sched_runq(), ast_sched_wait(), and ast_timer_open().
void* ast_heap_pop | ( | struct ast_heap * | h | ) |
Pop the max element off of the heap.
h | the heap |
Definition at line 295 of file heap.c.
References _ast_heap_remove().
Referenced by ast_sched_runq(), load_resource_list(), and sched_context_destroy().
int ast_heap_push | ( | struct ast_heap * | h, |
void * | elm | ||
) |
Push an element on to a heap.
h | the heap being added to |
elm | the element being put on the heap |
0 | success |
non-zero | failure |
Definition at line 250 of file heap.c.
References ast_heap::avail_len, bubble_up(), ast_heap::cur_len, grow_heap(), and heap_set().
Referenced by _ast_register_timing_interface(), load_resource(), and schedule().
void* ast_heap_remove | ( | struct ast_heap * | h, |
void * | elm | ||
) |
Remove a specific element from a heap.
h | the heap to remove from |
elm | the element to remove |
Definition at line 284 of file heap.c.
References _ast_heap_remove(), and get_index().
Referenced by ast_sched_del(), and ast_unregister_timing_interface().
size_t ast_heap_size | ( | struct ast_heap * | h | ) |
Get the current size of a heap.
h | the heap |
Definition at line 309 of file heap.c.
References ast_heap::cur_len.
Referenced by ast_sched_dump(), and ast_sched_report().
int ast_heap_verify | ( | struct ast_heap * | h | ) |
Verify that a heap has been properly constructed.
h | a heap |
0 | success |
non-zero | failure |
Definition at line 90 of file heap.c.
References ast_heap::cmp_fn, ast_heap::cur_len, heap_get(), left_node(), and right_node().
|
static |
Definition at line 237 of file heap.c.
References ast_heap::cmp_fn, heap_get(), heap_swap(), and parent_node().
Referenced by _ast_heap_remove(), and ast_heap_push().
|
inlinestatic |
Definition at line 67 of file heap.c.
References ast_heap::index_offset.
Referenced by ast_heap_remove().
|
static |
Add a row of additional storage for the heap.
Definition at line 178 of file heap.c.
References __ast_realloc(), and ast_realloc.
Referenced by ast_heap_push().
|
inlinestatic |
Definition at line 62 of file heap.c.
References ast_heap::heap.
Referenced by _ast_heap_remove(), ast_heap_peek(), ast_heap_verify(), bubble_up(), heap_swap(), and max_heapify().
|
inlinestatic |
Definition at line 80 of file heap.c.
References ast_heap::heap, and ast_heap::index_offset.
Referenced by _ast_heap_remove(), ast_heap_push(), and heap_swap().
|
inlinestatic |
Definition at line 201 of file heap.c.
References heap_get(), and heap_set().
Referenced by bubble_up(), and max_heapify().
|
inlinestatic |
Definition at line 47 of file heap.c.
Referenced by ast_heap_verify(), and max_heapify().
|
inlinestatic |
Definition at line 210 of file heap.c.
References ast_heap::cmp_fn, ast_heap::cur_len, heap_get(), heap_swap(), left_node(), and right_node().
Referenced by _ast_heap_remove().
|
inlinestatic |
|
inlinestatic |
Definition at line 52 of file heap.c.
Referenced by ast_heap_verify(), and max_heapify().