Added nameservice plugin
[olsrd.git] / lib / nameservice / src / olsrd_plugin.h
1 /*
2  * Copyright (c) 2005, Bruno Randolf <bruno.randolf@4g-systems.biz>
3  * Copyright (c) 2004, Andreas T√łnnesen(andreto-at-olsr.org)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright notice, 
11  *   this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright notice, 
13  *   this list of conditions and the following disclaimer in the documentation 
14  *   and/or other materials provided with the distribution.
15  * * Neither the name of the UniK olsr daemon nor the names of its contributors 
16  *   may be used to endorse or promote products derived from this software 
17  *   without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
22  * IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
23  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
24  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 
26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
27  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 
28  * OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  */
31
32 /* $Id: olsrd_plugin.h,v 1.1 2005/01/16 13:06:00 kattemat Exp $ */
33
34 /*
35  * Dynamic linked library example for UniK OLSRd
36  */
37
38 #ifndef _OLSRD_PLUGIN_DEFS
39 #define _OLSRD_PLUGIN_DEFS
40
41
42 #include <sys/socket.h>
43 #include <netinet/in.h>
44 #include <arpa/inet.h>
45 #include <sys/time.h>
46 #include <time.h>
47 #include <math.h>
48
49 #include "olsr_plugin_io.h"
50
51 /* Use this as PARSER_TYPE to receive ALL messages! */
52 #define PROMISCUOUS 0xffffffff
53
54
55 /****************************************************************************
56  *           Various datastructures and definitions from olsrd              *
57  ****************************************************************************/
58
59 /*
60  * TYPES SECTION
61  */
62
63 /* types */
64 #include <sys/types.h>
65
66 typedef u_int8_t        olsr_u8_t;
67 typedef u_int16_t       olsr_u16_t;
68 typedef u_int32_t       olsr_u32_t;
69 typedef int8_t          olsr_8_t;
70 typedef int16_t         olsr_16_t;
71 typedef int32_t         olsr_32_t;
72
73
74
75 /*
76  * VARIOUS DEFINITIONS
77  */
78
79 union olsr_ip_addr
80 {
81   olsr_u32_t v4;
82   struct in6_addr v6;
83 };
84
85
86 #define MAX_TTL               0xff
87
88
89 /*
90  *Link Types
91  */
92
93 #define UNSPEC_LINK           0
94 #define ASYM_LINK             1
95 #define SYM_LINK              2
96 #define LOST_LINK             3
97 #define HIDE_LINK             4
98 #define MAX_LINK              4
99
100
101
102 /*
103  * Hashing
104  */
105
106 #define HASHSIZE        32
107 #define HASHMASK        (HASHSIZE - 1)
108
109 #define MAXIFS         8 /* Maximum number of interfaces (from defs.h) in uOLSRd */
110
111
112 /****************************************************************************
113  *                          INTERFACE SECTION                               *
114  ****************************************************************************/
115 struct vtimes
116 {
117   olsr_u8_t hello;
118   olsr_u8_t tc;
119   olsr_u8_t mid;
120   olsr_u8_t hna;
121 };
122
123 /**
124  *A struct containing all necessary information about each
125  *interface participating in the OLSD routing
126  */
127 struct interface 
128 {
129   /* IP version 4 */
130   struct        sockaddr int_addr;              /* address */
131   struct        sockaddr int_netmask;           /* netmask */
132   struct        sockaddr int_broadaddr;         /* broadcast address */
133   /* IP version 6 */
134   struct        sockaddr_in6 int6_addr;         /* Address */
135   struct        sockaddr_in6 int6_multaddr;     /* Multicast */
136   /* IP independent */
137   union         olsr_ip_addr ip_addr;
138   int           olsr_socket;                    /* The broadcast socket for this interface */
139   int           int_metric;                     /* metric of interface */
140   int           int_mtu;                        /* MTU of interface */
141   int           int_flags;                      /* see below */
142   char          *int_name;                      /* from kernel if structure */
143   int           if_index;                       /* Kernels index of this interface */
144   int           if_nr;                          /* This interfaces index internally*/
145   int           is_wireless;                    /* wireless interface or not*/
146   olsr_u16_t    olsr_seqnum;                    /* Olsr message seqno */
147
148   float         hello_etime;
149   struct        vtimes valtimes;
150
151   struct        interface *int_next;
152 };
153
154
155 /****************************************************************************
156  *                            PACKET SECTION                                *
157  ****************************************************************************/
158
159  /**********************************
160  * DEFINE YOUR CUSTOM PACKET HERE *
161  **********************************/
162 #include "nameservice_msg.h"
163
164 /* 
165  * ALWAYS USE THESE WRAPPERS TO
166  * ENSURE IPv4 <-> IPv6 compability 
167  */
168
169 union olsr_message
170 {
171   struct olsrmsg v4;
172   struct olsrmsg6 v6;
173 };
174
175
176
177
178 /***************************************************************************
179  *                 Functions provided by uolsrd_plugin.c                   *
180  *                  Similar to their siblings in olsrd                     *
181  ***************************************************************************/
182
183 char ipv6_buf[100]; /* buffer for IPv6 inet_htop */
184
185 /* All these could optionally be fetched from olsrd */
186
187 olsr_u32_t
188 olsr_hashing(union olsr_ip_addr *);
189
190 void
191 olsr_get_timestamp(olsr_u32_t, struct timeval *);
192
193 void
194 olsr_init_timer(olsr_u32_t, struct timeval *);
195
196 int
197 olsr_timed_out(struct timeval *);
198
199 char *
200 olsr_ip_to_string(union olsr_ip_addr *);
201
202
203
204 /****************************************************************************
205  *                Function pointers to functions in olsrd                   *
206  *              These allow direct access to olsrd functions                *
207  ****************************************************************************/
208
209 /* The multi-purpose funtion. All other functions are fetched trough this */
210 int (*olsr_plugin_io)(int, void *, size_t);
211
212 /* add a prser function */
213 void (*olsr_parser_add_function)(void (*)(union olsr_message *, struct interface *, union olsr_ip_addr *), int, int);
214
215 /* Register a timeout function */
216 int (*olsr_register_timeout_function)(void (*)(void));
217
218 /* Register a scheduled event */
219 int (*olsr_register_scheduler_event)(void (*)(void *), void *, float, float, olsr_u8_t *);
220
221 /* Get the next message seqno in line */
222 olsr_u16_t (*get_msg_seqno)(void);
223
224 int (*net_outbuffer_push)(struct interface *, olsr_u8_t *, olsr_u16_t);
225
226 /* Transmit package */
227 int (*net_output)(struct interface*);
228
229 /* Check the duplicate table for prior processing */
230 int (*check_dup_proc)(union olsr_ip_addr *, olsr_u16_t);
231
232 /* Default forward algorithm */
233 int (*default_fwd)(union olsr_message *, 
234                    union olsr_ip_addr *, 
235                    olsr_u16_t,  
236                    struct interface *, 
237                    union olsr_ip_addr *);
238
239 /* Add a socket to the main olsrd select loop */
240 void (*add_olsr_socket)(int, void(*)(int));
241
242 /* get the link status to a neighbor */
243 int (*check_neighbor_link)(union olsr_ip_addr *);
244
245 /* Mantissa/exponen conversions */
246 olsr_u8_t (*double_to_me)(double);
247
248 double (*me_to_double)(olsr_u8_t);
249
250 /* olsrd printf wrapper */
251 int (*olsr_printf)(int, char *, ...);
252
253 /* olsrd malloc wrapper */
254 void *(*olsr_malloc)(size_t, const char *);
255
256
257 /****************************************************************************
258  *                             Data from olsrd                              *
259  *           NOTE THAT POINTERS POINT TO THE DATA USED BY OLSRD!            *
260  *               NEVER ALTER DATA POINTED TO BY THESE POINTERS              * 
261  *                   UNLESS YOU KNOW WHAT YOU ARE DOING!!!                  *
262  ****************************************************************************/
263 /**
264  * The interface list from olsrd
265  */
266
267 struct interface   *ifs;
268
269 /* These two are set automatically by olsrd at load time */
270 int                ipversion;  /* IPversion in use */
271 union olsr_ip_addr *main_addr; /* Main address */
272
273
274 size_t             ipsize;     /* Size of the ipadresses used */
275 struct timeval     *now;       /* the olsrds schedulers idea of current time */
276
277
278 /****************************************************************************
279  *                Functions that the plugin MUST provide                    *
280  ****************************************************************************/
281
282
283 /* Initialization function */
284 int
285 olsr_plugin_init(void);
286
287 /* Destructor function */
288 void
289 olsr_plugin_exit(void);
290
291 /* Mulitpurpose funtion */
292 int
293 plugin_io(int, void *, size_t);
294
295 /* Plugin interface version */
296 int 
297 get_plugin_interface_version(void);
298
299
300 /*****************************************************************************
301  *                               Plugin data                                 *
302  *****************************************************************************/
303
304 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
305 #define PLUGIN_INTERFACE_VERSION 2
306
307 #endif