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