Remove memory allocation in olsr_timer_add()
[oonf.git] / src / core / os_routing.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 #ifndef OS_ROUTING_H_
43 #define OS_ROUTING_H_
44
45 #include <stdio.h>
46 #include <sys/time.h>
47
48 #include "common/common_types.h"
49 #include "common/list.h"
50 #include "olsr_interface.h"
51 #include "olsr_logging.h"
52 #include "olsr_timer.h"
53 #include "os_system.h"
54
55 /*
56  * Set one of the following defines in the os specific os_routing includes
57  * to OS_SPECIFIC to define that the os code is implementing the function
58  * itself and does not use the generic function
59  * Set it to OS_GENERIC to define that the code use the default implementation.
60  *
61  * Example from os_system_linux.h:
62  *
63  * #define OS_SYSTEM_INIT         OS_SPECIFIC
64  * #define OS_SYSTEM_INIT_IF      OS_SPECIFIC
65  * #define OS_SYSTEM_SET_IFSTATE  OS_SPECIFIC
66  * #define OS_SYSTEM_GETTIMEOFDAY OS_GENERIC
67  * #define OS_SYSTEM_LOG          OS_GENERIC
68  */
69
70 /* set the guard macro so we can include the os specific settings */
71 #define OS_NET_SPECIFIC_INCLUDE
72 #include "os_helper.h"
73
74 #ifdef OS_LINUX
75 #include "os_linux/os_routing_linux.h"
76 #endif
77
78 #ifdef OS_BSD
79 #include "os_bsd/os_routing_bsd.h"
80 #endif
81
82 #ifdef OS_WIN32
83 #include "os_win32/os_routing_win32.h"
84 #endif
85
86 #undef OS_NET_SPECIFIC_INCLUDE
87
88 /* make sure default values for routing are there */
89 #ifndef RTPROT_UNSPEC
90 #define RTPROT_UNSPEC 0
91 #endif
92 #ifndef RT_TABLE_UNSPEC
93 #define RT_TABLE_UNSPEC 0
94 #endif
95
96 struct os_route {
97   /* used for delivering feedback about netlink commands */
98   struct os_route_internal _internal;
99
100   /* address family */
101   unsigned char family;
102
103   /* source, gateway and destination */
104   struct netaddr src, gw, dst;
105
106   /* metric of the route */
107   int metric;
108
109   /* routing table and routing protocol */
110   unsigned char table, protocol;
111
112   /* index of outgoing interface */
113   unsigned int if_index;
114
115   /* callback when operation is finished */
116   void (*cb_finished)(struct os_route *, int error);
117
118   /* callback for os_routing_query() */
119   void (*cb_get)(struct os_route *filter, struct os_route *route);
120 };
121
122 EXPORT extern const struct os_route OS_ROUTE_WILDCARD;
123
124 /* prototypes for all os_routing functions */
125 EXPORT int os_routing_init(void);
126 EXPORT void os_routing_cleanup(void);
127
128 EXPORT int os_routing_init_mesh_if(struct olsr_interface *);
129 EXPORT void os_routing_cleanup_mesh_if(struct olsr_interface *);
130
131 EXPORT int os_routing_set(struct os_route *, bool set, bool del_similar);
132 EXPORT int os_routing_query(struct os_route *);
133 EXPORT void os_routing_interrupt(struct os_route *);
134
135 #endif /* OS_ROUTING_H_ */