add some basic infrastructure for cookies
[olsrd.git] / src / olsr_cookie.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2008, Hannes Gredler (hannes@gredler.at)
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 #include "olsr_types.h"
42
43 #ifndef _OLSR_COOKIE_H
44 #define _OLSR_COOKIE_H
45
46 #define COOKIE_ID_MAX  20       /* maximum number of cookies in the system */
47
48 typedef enum olsr_cookie_type_ {
49   OLSR_COOKIE_TYPE_MIN,
50   OLSR_COOKIE_TYPE_MEMORY,
51   OLSR_COOKIE_TYPE_TIMER,
52   OLSR_COOKIE_TYPE_MAX
53 } olsr_cookie_type;
54
55 /*
56  * This is a cookie. A cookie is a tool aimed for olsrd developers.
57  * It is used for tracking resource usage in the system and also
58  * for locating memory corruption.
59  */
60 struct olsr_cookie_info {
61   olsr_cookie_t ci_id;                 /* ID */
62   char *ci_name;                       /* Name */
63   olsr_cookie_type ci_type;            /* Type of cookie */
64   size_t ci_size;                      /* Fixed size for block allocations */
65   unsigned int ci_usage;               /* Stats, resource usage */
66   unsigned int ci_changes;             /* Stats, resource churn */
67 };
68
69 /*
70  * Small brand which gets appended on the end of every block allocation.
71  * Helps to detect memory corruption, like overruns, double frees.
72  */
73 struct olsr_cookie_mem_brand {
74   char cmb_sig[6];
75   olsr_cookie_t cmb_id;
76 };
77
78 /* Externals. */
79 extern struct olsr_cookie_info *olsr_alloc_cookie(const char *,
80                                                   olsr_cookie_type);
81 extern void olsr_free_cookie(struct olsr_cookie_info *);
82 extern char *olsr_cookie_name(olsr_cookie_t);
83 extern void olsr_cookie_set_memory_size(struct olsr_cookie_info *, size_t);
84 extern void olsr_cookie_usage_incr(olsr_cookie_t);
85 extern void olsr_cookie_usage_decr(olsr_cookie_t);
86
87 extern void *olsr_cookie_malloc(struct olsr_cookie_info *);
88 extern void olsr_cookie_free(struct olsr_cookie_info *, void *);
89
90
91 #endif /* _OLSR_COOKIE_H */
92
93 /*
94  * Local Variables:
95  * c-basic-offset: 2
96  * End:
97  */