1 /*
2  * Copyright (c) 2011 Intel Corporation. All Rights Reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the
6  * "Software"), to deal in the Software without restriction, including
7  * without limitation the rights to use, copy, modify, merge, publish,
8  * distribute, sub license, and/or sell copies of the Software, and to
9  * permit persons to whom the Software is furnished to do so, subject to
10  * the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the
13  * next paragraph) shall be included in all copies or substantial portions
14  * of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
19  * IN NO EVENT SHALL PRECISION INSIGHT AND/OR ITS SUPPLIERS BE LIABLE FOR
20  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
21  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
22  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  *
24  * Authors:
25  *    Waldo Bastian <waldo.bastian@intel.com>
26  *
27  */
28 
29 #ifndef _OBJECT_HEAP_H_
30 #define _OBJECT_HEAP_H_
31 
32 #define OBJECT_HEAP_OFFSET_MASK         0x7F000000
33 #define OBJECT_HEAP_ID_MASK                     0x00FFFFFF
34 
35 typedef struct object_base_s *object_base_p;
36 typedef struct object_heap_s *object_heap_p;
37 
38 struct object_base_s {
39     int id;
40     int next_free;
41 };
42 
43 struct object_heap_s {
44     int object_size;
45     int id_offset;
46     object_base_p *heap_index;
47     int next_free;
48     int heap_size;
49     int heap_increment;
50 };
51 
52 typedef int object_heap_iterator;
53 
54 /*
55  * Return 0 on success, -1 on error
56  */
57 int object_heap_init(object_heap_p heap, int object_size, int id_offset);
58 
59 /*
60  * Allocates an object
61  * Returns the object ID on success, returns -1 on error
62  */
63 int object_heap_allocate(object_heap_p heap);
64 
65 /*
66  * Lookup an allocated object by object ID
67  * Returns a pointer to the object on success, returns NULL on error
68  */
69 object_base_p object_heap_lookup(object_heap_p heap, int id);
70 
71 /*
72  * Iterate over all objects in the heap.
73  * Returns a pointer to the first object on the heap, returns NULL if heap is empty.
74  */
75 object_base_p object_heap_first(object_heap_p heap, object_heap_iterator *iter);
76 
77 /*
78  * Iterate over all objects in the heap.
79  * Returns a pointer to the next object on the heap, returns NULL if heap is empty.
80  */
81 object_base_p object_heap_next(object_heap_p heap, object_heap_iterator *iter);
82 
83 /*
84  * Frees an object
85  */
86 void object_heap_free(object_heap_p heap, object_base_p obj);
87 
88 /*
89  * Destroys a heap, the heap must be empty.
90  */
91 void object_heap_destroy(object_heap_p heap);
92 
93 /*
94  * Suspend an object
95  * Suspended objects can not be looked up
96  */
97 void object_heap_suspend_object(object_base_p obj, int suspend);
98 
99 #endif /* _OBJECT_HEAP_H_ */
100