823d5ab87d43d2b83815446d470f1a00bad2211a
[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.3 2005/02/21 19:47:29 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 #include "olsr_types.h"
51 #include "hashing.h"
52 #include "interfaces.h"
53
54 /* Use this as PARSER_TYPE to receive ALL messages! */
55 #define PROMISCUOUS 0xffffffff
56
57
58 /****************************************************************************
59  *           Various datastructures and definitions from olsrd              *
60  ****************************************************************************/
61
62 #define MAX_TTL               0xff
63
64
65 /*
66  *Link Types
67  */
68
69 #define UNSPEC_LINK           0
70 #define ASYM_LINK             1
71 #define SYM_LINK              2
72 #define LOST_LINK             3
73 #define HIDE_LINK             4
74 #define MAX_LINK              4
75
76
77 #define MAXIFS         8 /* Maximum number of interfaces (from defs.h) in uOLSRd */
78
79
80
81 /****************************************************************************
82  *                            PACKET SECTION                                *
83  ****************************************************************************/
84
85  /**********************************
86  * DEFINE YOUR CUSTOM PACKET HERE *
87  **********************************/
88 #include "nameservice_msg.h"
89
90 /* 
91  * ALWAYS USE THESE WRAPPERS TO
92  * ENSURE IPv4 <-> IPv6 compability 
93  */
94
95 union olsr_message
96 {
97   struct olsrmsg v4;
98   struct olsrmsg6 v6;
99 };
100
101
102
103
104 /***************************************************************************
105  *                 Functions provided by uolsrd_plugin.c                   *
106  *                  Similar to their siblings in olsrd                     *
107  ***************************************************************************/
108
109 char ipv6_buf[100]; /* buffer for IPv6 inet_htop */
110
111 /* All these could optionally be fetched from olsrd */
112
113 olsr_u32_t
114 olsr_hashing(union olsr_ip_addr *);
115
116 void
117 olsr_get_timestamp(olsr_u32_t, struct timeval *);
118
119 void
120 olsr_init_timer(olsr_u32_t, struct timeval *);
121
122 int
123 olsr_timed_out(struct timeval *);
124
125 char *
126 olsr_ip_to_string(union olsr_ip_addr *);
127
128
129
130 /****************************************************************************
131  *                Function pointers to functions in olsrd                   *
132  *              These allow direct access to olsrd functions                *
133  ****************************************************************************/
134
135 /* The multi-purpose funtion. All other functions are fetched trough this */
136 int (*olsr_plugin_io)(int, void *, size_t);
137
138 /* add a prser function */
139 void (*olsr_parser_add_function)(void (*)(union olsr_message *, struct interface *, union olsr_ip_addr *), int, int);
140
141 /* Register a timeout function */
142 int (*olsr_register_timeout_function)(void (*)(void));
143
144 /* Register a scheduled event */
145 int (*olsr_register_scheduler_event)(void (*)(void *), void *, float, float, olsr_u8_t *);
146
147 /* Get the next message seqno in line */
148 olsr_u16_t (*get_msg_seqno)(void);
149
150 int (*net_outbuffer_push)(struct interface *, olsr_u8_t *, olsr_u16_t);
151
152 /* Transmit package */
153 int (*net_output)(struct interface*);
154
155 /* Check the duplicate table for prior processing */
156 int (*check_dup_proc)(union olsr_ip_addr *, olsr_u16_t);
157
158 /* Default forward algorithm */
159 int (*default_fwd)(union olsr_message *, 
160                    union olsr_ip_addr *, 
161                    olsr_u16_t,  
162                    struct interface *, 
163                    union olsr_ip_addr *);
164
165 /* Add a socket to the main olsrd select loop */
166 void (*add_olsr_socket)(int, void(*)(int));
167
168 /* get the link status to a neighbor */
169 int (*check_neighbor_link)(union olsr_ip_addr *);
170
171 /* Mantissa/exponen conversions */
172 olsr_u8_t (*double_to_me)(double);
173
174 double (*me_to_double)(olsr_u8_t);
175
176 /* olsrd printf wrapper */
177 int (*olsr_printf)(int, char *, ...);
178
179 /* olsrd malloc wrapper */
180 void *(*olsr_malloc)(size_t, const char *);
181
182
183 /****************************************************************************
184  *                             Data from olsrd                              *
185  *           NOTE THAT POINTERS POINT TO THE DATA USED BY OLSRD!            *
186  *               NEVER ALTER DATA POINTED TO BY THESE POINTERS              * 
187  *                   UNLESS YOU KNOW WHAT YOU ARE DOING!!!                  *
188  ****************************************************************************/
189 /**
190  * The interface list from olsrd
191  */
192
193 struct interface   *ifs;
194
195 /* These two are set automatically by olsrd at load time */
196 int                ipversion;  /* IPversion in use */
197 union olsr_ip_addr *main_addr; /* Main address */
198
199
200 size_t             ipsize;     /* Size of the ipadresses used */
201 struct timeval     *now;       /* the olsrds schedulers idea of current time */
202
203
204 /****************************************************************************
205  *                Functions that the plugin MUST provide                    *
206  ****************************************************************************/
207
208
209 /* Initialization function */
210 int
211 olsr_plugin_init(void);
212
213 /* Destructor function */
214 void
215 olsr_plugin_exit(void);
216
217 /* Mulitpurpose funtion */
218 int
219 plugin_io(int, void *, size_t);
220
221 /* Plugin interface version */
222 int 
223 get_plugin_interface_version(void);
224
225
226 /*****************************************************************************
227  *                               Plugin data                                 *
228  *****************************************************************************/
229
230 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
231 #define PLUGIN_INTERFACE_VERSION 2
232
233 #endif