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