Remove the olsr-specific duplicated types
[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 #include "common/list.h"
43
44 #ifndef _OLSR_COOKIE_H
45 #define _OLSR_COOKIE_H
46
47 #define COOKIE_ID_MAX  40       /* maximum number of cookies in the system */
48
49 typedef enum olsr_cookie_type_ {
50   OLSR_COOKIE_TYPE_MIN,
51   OLSR_COOKIE_TYPE_MEMORY,
52   OLSR_COOKIE_TYPE_TIMER,
53   OLSR_COOKIE_TYPE_MAX
54 } olsr_cookie_type;
55
56 /*
57  * This is a cookie. A cookie is a tool aimed for olsrd developers.
58  * It is used for tracking resource usage in the system and also
59  * for locating memory corruption.
60  */
61 struct olsr_cookie_info {
62   olsr_cookie_t ci_id;                 /* ID */
63   char *ci_name;                       /* Name */
64   olsr_cookie_type ci_type;            /* Type of cookie */
65   size_t ci_size;                      /* Fixed size for block allocations */
66   unsigned int ci_flags;               /* Misc. flags */
67   unsigned int ci_usage;               /* Stats, resource usage */
68   unsigned int ci_changes;             /* Stats, resource churn */
69   struct list_node ci_free_list;       /* List head for recyclable blocks */
70   unsigned int ci_free_list_usage;     /* Length of free list */
71 };
72
73 /* Cookie flags */
74 #define COOKIE_NO_MEMCLEAR  ( 1 << 0)   /* Do not clear memory */
75 #define COOKIE_MEMPOISON    ( 2 << 0)   /* Poison memory pattern */
76
77 #define COOKIE_MEMPOISON_PATTERN  0xa6 /* Pattern to spoil memory */
78 #define COOKIE_FREE_LIST_THRESHOLD 10  /* Blocks / Percent  */
79
80 /*
81  * Small brand which gets appended on the end of every block allocation.
82  * Helps to detect memory corruption, like overruns, double frees.
83  */
84 struct olsr_cookie_mem_brand {
85   char cmb_sig[6];
86   olsr_cookie_t cmb_id;
87 };
88
89 /* Externals. */
90 extern struct olsr_cookie_info *olsr_alloc_cookie(const char *,
91                                                   olsr_cookie_type);
92 extern void olsr_free_cookie(struct olsr_cookie_info *);
93 extern void olsr_delete_all_cookies(void);
94 extern char *olsr_cookie_name(olsr_cookie_t);
95 extern void olsr_cookie_set_memory_size(struct olsr_cookie_info *, size_t);
96 extern void olsr_cookie_set_memory_clear(struct olsr_cookie_info *, bool);
97 extern void olsr_cookie_set_memory_poison(struct olsr_cookie_info *, bool);
98 extern void olsr_cookie_usage_incr(olsr_cookie_t);
99 extern void olsr_cookie_usage_decr(olsr_cookie_t);
100
101 extern void *olsr_cookie_malloc(struct olsr_cookie_info *);
102 extern void olsr_cookie_free(struct olsr_cookie_info *, void *);
103
104
105 #endif /* _OLSR_COOKIE_H */
106
107 /*
108  * Local Variables:
109  * c-basic-offset: 2
110  * indent-tabs-mode: nil
111  * End:
112  */