Move some setup functions from os_routing to os_net
[oonf.git] / src-api / core / os_routing.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2013, 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 "common/netaddr.h"
51 #include "core/olsr_interface.h"
52 #include "core/olsr_logging.h"
53 #include "core/olsr_timer.h"
54 #include "core/os_system.h"
55
56 /* include os-specific headers */
57 #if defined(__linux__)
58 #include "core/os_linux/os_routing_linux.h"
59 #elif defined (BSD)
60 #include "core/os_bsd/os_routing_bsd.h"
61 #elif defined (_WIN32)
62 #include "core/os_win32/os_routing_win32.h"
63 #else
64 #error "Unknown operation system"
65 #endif
66
67 /* make sure default values for routing are there */
68 #ifndef RTPROT_UNSPEC
69 #define RTPROT_UNSPEC 0
70 #endif
71 #ifndef RT_TABLE_UNSPEC
72 #define RT_TABLE_UNSPEC 0
73 #endif
74
75 struct os_route_str {
76   char buf[
77            /* header */
78            1+
79            /* src */
80            5 + sizeof(struct netaddr_str)
81            /* gw */
82            + 4 + sizeof(struct netaddr_str)
83            /* dst */
84            + 5 + sizeof(struct netaddr_str)
85            /* metric */
86            + 7 +11
87            /* table, protocol */
88            +6+4 +9+4
89            +3 + IF_NAMESIZE + 2 + 10 + 2
90            /* footer and 0-byte */
91            + 2];
92 };
93
94 struct os_route {
95   /* used for delivering feedback about netlink commands */
96   struct os_route_internal _internal;
97
98   /* address family */
99   unsigned char family;
100
101   /* source, gateway and destination */
102   struct netaddr src, gw, dst;
103
104   /* metric of the route */
105   int metric;
106
107   /* routing table and routing protocol */
108   unsigned char table, protocol;
109
110   /* index of outgoing interface */
111   unsigned int if_index;
112
113   /* callback when operation is finished */
114   void (*cb_finished)(struct os_route *, int error);
115
116   /* callback for os_routing_query() */
117   void (*cb_get)(struct os_route *filter, struct os_route *route);
118 };
119
120 EXPORT extern struct oonf_subsystem oonf_os_routing_subsystem;
121 EXPORT extern const struct os_route OS_ROUTE_WILDCARD;
122
123 /* prototypes for all os_routing functions */
124 EXPORT int os_routing_set(struct os_route *, bool set, bool del_similar);
125 EXPORT int os_routing_query(struct os_route *);
126 EXPORT void os_routing_interrupt(struct os_route *);
127
128 EXPORT const char *os_routing_to_string(
129     struct os_route_str *buf, struct os_route *route);
130
131 #endif /* OS_ROUTING_H_ */