Makefile patches by Bruno added
[olsrd.git] / lib / dyn_gw / src / olsrd_plugin.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas T√łnnesen(andreto@olsr.org)
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  * $Id: olsrd_plugin.h,v 1.7 2004/11/30 16:52:15 kattemat Exp $
41  */
42
43 #ifndef _OLSRD_PLUGIN_DEFS
44 #define _OLSRD_PLUGIN_DEFS
45
46
47 #include <sys/socket.h>
48 #include <netinet/in.h>
49 #include <arpa/inet.h>
50 #include <sys/time.h>
51 #include <time.h>
52 #include <math.h>
53
54 #include "olsr_plugin_io.h"
55
56 /* Use this as PARSER_TYPE to receive ALL messages! */
57 #define PROMISCUOUS 0xffffffff
58
59
60 /*****************************************************************************
61  *                               Plugin data                                 *
62  *                       ALTER THIS TO YOUR OWN NEED                         *
63  *****************************************************************************/
64
65 #define PLUGIN_NAME    "OLSRD dynamic gateway plugin"
66 #define PLUGIN_VERSION "0.2"
67 #define PLUGIN_AUTHOR   "Andreas T√łnnesen"
68 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
69 #define PLUGIN_INTERFACE_VERSION 2
70
71
72
73
74 /****************************************************************************
75  *           Various datastructures and definitions from olsrd              *
76  ****************************************************************************/
77
78 /*
79  * TYPES SECTION
80  */
81
82 /* types */
83 #include <sys/types.h>
84
85 typedef u_int8_t        olsr_u8_t;
86 typedef u_int16_t       olsr_u16_t;
87 typedef u_int32_t       olsr_u32_t;
88 typedef int8_t          olsr_8_t;
89 typedef int16_t         olsr_16_t;
90 typedef int32_t         olsr_32_t;
91
92
93
94 /*
95  * VARIOUS DEFINITIONS
96  */
97
98 union olsr_ip_addr
99 {
100   olsr_u32_t v4;
101   struct in6_addr v6;
102 };
103
104 union hna_netmask
105 {
106   olsr_u32_t v4;
107   olsr_u16_t v6;
108 };
109
110 /***************************************************************************
111  *                 Functions provided by uolsrd_plugin.c                   *
112  *                  Similar to their siblings in olsrd                     *
113  ***************************************************************************/
114
115 char ipv6_buf[100]; /* buffer for IPv6 inet_htop */
116
117 /* All these could optionally be fetched from olsrd */
118
119 char *
120 olsr_ip_to_string(union olsr_ip_addr *);
121
122
123
124 /****************************************************************************
125  *                Function pointers to functions in olsrd                   *
126  *              These allow direct access to olsrd functions                *
127  ****************************************************************************/
128
129 /* The multi-purpose funtion. All other functions are fetched trough this */
130 int (*olsr_plugin_io)(int, void *, size_t);
131
132 /* Register a scheduled event */
133 int (*olsr_register_scheduler_event)(void (*)(void), void*, float, float, olsr_u8_t *);
134
135 /* olsrd printf wrapper */
136 int (*olsr_printf)(int, char *, ...);
137
138 /* olsrd malloc wrapper */
139 void *(*olsr_malloc)(size_t, const char *);
140
141 /* Add hna net IPv4 */
142 void (*add_local_hna4_entry)(union olsr_ip_addr *, union hna_netmask *);
143
144 /* Remove hna net IPv4 */
145 int (*remove_local_hna4_entry)(union olsr_ip_addr *, union hna_netmask *);
146
147
148 /****************************************************************************
149  *                             Data from olsrd                              *
150  *           NOTE THAT POINTERS POINT TO THE DATA USED BY OLSRD!            *
151  *               NEVER ALTER DATA POINTED TO BY THESE POINTERS              * 
152  *                   UNLESS YOU KNOW WHAT YOU ARE DOING!!!                  *
153  ****************************************************************************/
154
155 /* These two are set automatically by olsrd at load time */
156 int                ipversion;  /* IPversion in use */
157 union olsr_ip_addr *main_addr; /* Main address */
158
159
160 size_t             ipsize;     /* Size of the ipadresses used */
161 struct timeval     *now;       /* the olsrds schedulers idea of current time */
162
163
164 /****************************************************************************
165  *                Functions that the plugin MUST provide                    *
166  ****************************************************************************/
167
168
169 /* Initialization function */
170 int
171 olsr_plugin_init(void);
172
173 /* Destructor function */
174 void
175 olsr_plugin_exit(void);
176
177 /* Mulitpurpose funtion */
178 int
179 plugin_io(int, void *, size_t);
180
181 int
182 register_olsr_param(char *, char *);
183
184 int 
185 get_plugin_interface_version(void);
186
187 #endif