Update to new avl/list iteration macros
[olsrd.git] / src / olsr_cookie.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include <stdint.h>
43
44 #include "olsr_types.h"
45 #include "common/list.h"
46 #include "common/avl.h"
47
48 #ifndef _OLSR_COOKIE_H
49 #define _OLSR_COOKIE_H
50
51 extern struct avl_tree EXPORT(olsr_cookie_tree);
52
53 /*
54  * This is a cookie. A cookie is a tool aimed for olsrd developers.
55  * It is used for tracking resource usage in the system and also
56  * for locating memory corruption.
57  */
58 struct olsr_cookie_info {
59   struct avl_node ci_node;
60   /* Name */
61   char *ci_name;
62
63   /* Size of memory blocks */
64   size_t ci_size;
65
66   /* size including prefix and custom data */
67   size_t ci_total_size;
68
69   /* offset from the inline custom data block */
70   size_t ci_custom_offset;
71
72   /*
73    * minimum number of chunks the allocator will keep
74    * in the free list before starting to deallocate one
75    */
76   uint32_t ci_min_free_count;
77
78   /* Stats, resource usage */
79   uint32_t ci_usage;
80
81   /* Stats, resource churn */
82   uint32_t ci_changes;
83
84   /* list of custom additions of this memory cookie */
85   struct list_entity ci_custom_list;
86
87   /* List head for used memory blocks */
88   struct list_entity ci_used_list;
89
90   /* List head for recyclable blocks */
91   struct list_entity ci_free_list;
92
93   /* Length of free list */
94   uint32_t ci_free_list_usage;
95 };
96
97 /* Custom addition to existing cookie */
98 struct olsr_cookie_custom {
99   struct list_entity node;
100
101   char *name;
102
103   size_t size;
104   size_t offset;
105
106   void (*init)(struct olsr_cookie_info *, void *, void *);
107   void (*cleanup)(struct olsr_cookie_info *, void *, void *);
108 };
109
110 /* should have a length of 2*memory_alignment */
111 struct olsr_memory_prefix {
112   struct list_entity node;
113   uint8_t *custom;
114   uint8_t is_inline;
115   uint8_t padding[sizeof(size_t) - sizeof(uint8_t)];
116 };
117
118 #define OLSR_FOR_ALL_COOKIES(ci, iterator) avl_for_each_element_safe(&olsr_cookie_tree, ci, ci_node, iterator)
119 #define OLSR_FOR_ALL_USED_MEM(ci, mem, iterator) list_for_each_element_safe(&ci->ci_used_list, mem, node, iterator)
120 #define OLSR_FOR_ALL_FREE_MEM(ci, mem, iterator) list_for_each_element_safe(&ci->ci_free_list, mem, node, iterator)
121 #define OLSR_FOR_ALL_CUSTOM_MEM(ci, custom, iterator) list_for_each_element_safe(&ci->ci_custom_list, custom, node, iterator)
122
123 #define COOKIE_FREE_LIST_THRESHOLD 10   /* Blocks / Percent  */
124
125 /* Externals. */
126 void olsr_cookie_init(void);
127 void olsr_cookie_cleanup(void);
128
129 struct olsr_cookie_info *EXPORT(olsr_create_memcookie) (const char *, size_t size);
130 void EXPORT(olsr_cleanup_memcookie)(struct olsr_cookie_info *);
131
132 void EXPORT(olsr_cookie_set_min_free)(struct olsr_cookie_info *, uint32_t);
133
134 void *EXPORT(olsr_cookie_malloc) (struct olsr_cookie_info *);
135 void EXPORT(olsr_cookie_free) (struct olsr_cookie_info *, void *);
136
137 struct olsr_cookie_custom *EXPORT(olsr_alloc_cookie_custom)(
138     struct olsr_cookie_info *ci, size_t size, const char *name,
139     void (*init)(struct olsr_cookie_info *, void *, void *),
140     void (*cleanup)(struct olsr_cookie_info *, void *, void *));
141
142 void EXPORT(olsr_free_cookie_custom)(
143     struct olsr_cookie_info *ci, struct olsr_cookie_custom *custom);
144
145 /* inline function to access memory of custom data */
146 static inline void *EXPORT(olsr_cookie_get_custom)(
147     struct olsr_cookie_custom *custom,
148     void *ptr) {
149   struct olsr_memory_prefix *mem;
150
151   /* get to the prefix memory structure */
152   mem = ptr;
153   mem--;
154
155   return mem->custom + custom->offset;
156 }
157
158 #endif /* _OLSR_COOKIE_H */
159
160 /*
161  * Local Variables:
162  * c-basic-offset: 2
163  * indent-tabs-mode: nil
164  * End:
165  */