Added CVS Id fields to all ca nd h files
[olsrd.git] / lib / powerinfo / src / olsrd_plugin.h
1
2 /*
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 /*
33  * Dynamic linked library example for UniK OLSRd
34  */
35
36 #ifndef _OLSRD_PLUGIN_DEFS
37 #define _OLSRD_PLUGIN_DEFS
38
39
40 #include <sys/socket.h>
41 #include <netinet/in.h>
42 #include <arpa/inet.h>
43 #include <sys/time.h>
44 #include <time.h>
45 #include <math.h>
46
47 #include "olsr_plugin_io.h"
48
49 /* Use this as PARSER_TYPE to receive ALL messages! */
50 #define PROMISCUOUS 0xffffffff
51
52
53 /*****************************************************************************
54  *                               Plugin data                                 *
55  *                       ALTER THIS TO YOUR OWN NEED                         *
56  *****************************************************************************/
57
58 #define PLUGIN_NAME    "OLSRD Powerstatus plugin"
59 #define PLUGIN_VERSION "0.1"
60 #define PLUGIN_AUTHOR   "Andreas T√łnnesen"
61 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
62 #define PLUGIN_INTERFACE_VERSION 1
63
64 /* The type of message you will use */
65 #define MESSAGE_TYPE 128
66
67 /* The type of messages we will receive - can be set to promiscuous */
68 #define PARSER_TYPE MESSAGE_TYPE
69
70
71
72 /****************************************************************************
73  *           Various datastructures and definitions from olsrd              *
74  ****************************************************************************/
75
76 /*
77  * TYPES SECTION
78  */
79
80 /* types */
81 #include <sys/types.h>
82
83 typedef u_int8_t        olsr_u8_t;
84 typedef u_int16_t       olsr_u16_t;
85 typedef u_int32_t       olsr_u32_t;
86 typedef int8_t          olsr_8_t;
87 typedef int16_t         olsr_16_t;
88 typedef int32_t         olsr_32_t;
89
90
91
92 /*
93  * VARIOUS DEFINITIONS
94  */
95
96 union olsr_ip_addr
97 {
98   olsr_u32_t v4;
99   struct in6_addr v6;
100 };
101
102 union hna_netmask
103 {
104   olsr_u32_t v4;
105   olsr_u16_t v6;
106 };
107
108 #define MAX_TTL               0xff
109
110
111 /*
112  *Link Types
113  */
114
115 #define UNSPEC_LINK           0
116 #define ASYM_LINK             1
117 #define SYM_LINK              2
118 #define LOST_LINK             3
119 #define HIDE_LINK             4
120 #define MAX_LINK              4
121
122
123 /*
124  * Mantissa scaling factor
125  */
126
127 #define VTIME_SCALE_FACTOR    0.0625
128
129
130 /*
131  * Hashing
132  */
133
134 #define HASHSIZE        32
135 #define HASHMASK        (HASHSIZE - 1)
136
137 #define MAXIFS         8 /* Maximum number of interfaces (from defs.h) in uOLSRd */
138
139
140 /****************************************************************************
141  *                          INTERFACE SECTION                               *
142  ****************************************************************************/
143
144 /**
145  *A struct containing all necessary information about each
146  *interface participating in the OLSD routing
147  */
148 struct interface 
149 {
150   /* IP version 4 */
151   struct        sockaddr int_addr;              /* address */
152   struct        sockaddr int_netmask;           /* netmask */
153   struct        sockaddr int_broadaddr;         /* broadcast address */
154   /* IP version 6 */
155   struct        sockaddr_in6 int6_addr;         /* Address */
156   struct        sockaddr_in6 int6_multaddr;     /* Multicast */
157   /* IP independent */
158   union         olsr_ip_addr ip_addr;
159   int           int_metric;                     /* init's routing entry */
160   int           int_flags;                      /* see below */
161   char          *int_name;                      /* from kernel if structure */
162   int           if_index;                       /* Kernels index of this interface */
163   int           if_nr;                          /* This interfaces number internally*/
164   int           is_wireless;                    /* wireless interface or not*/
165   olsr_u16_t    olsr_seqnum;                    /* Sequence numbers*/
166   struct        interface *int_next;
167 };
168
169
170 /****************************************************************************
171  *                            PACKET SECTION                                *
172  ****************************************************************************/
173
174
175 /**********************************
176  * DEFINE YOUR CUSTOM PACKET HERE *
177  **********************************/
178
179 struct powermsg
180 {
181   olsr_u8_t       source_type;
182   olsr_u8_t       percentage;
183   olsr_u16_t      time_left;
184 };
185
186 /*
187  * OLSR message (several can exist in one OLSR packet)
188  */
189
190 struct olsrmsg
191 {
192   olsr_u8_t     olsr_msgtype;
193   olsr_u8_t     olsr_vtime;
194   olsr_u16_t    olsr_msgsize;
195   olsr_u32_t    originator;
196   olsr_u8_t     ttl;
197   olsr_u8_t     hopcnt;
198   olsr_u16_t    seqno;
199
200   /* YOUR PACKET GOES HERE */
201   struct powermsg msg;
202
203 };
204
205 /*
206  *IPv6
207  */
208
209 struct olsrmsg6
210 {
211   olsr_u8_t        olsr_msgtype;
212   olsr_u8_t        olsr_vtime;
213   olsr_u16_t       olsr_msgsize;
214   struct in6_addr  originator;
215   olsr_u8_t        ttl;
216   olsr_u8_t        hopcnt;
217   olsr_u16_t       seqno;
218
219   /* YOUR PACKET GOES HERE */
220   struct powermsg msg;
221
222 };
223
224 /*
225  * Generic OLSR packet - DO NOT ALTER
226  */
227
228 struct olsr 
229 {
230   olsr_u16_t      olsr_packlen;         /* packet length */
231   olsr_u16_t      olsr_seqno;
232   struct olsrmsg  olsr_msg[1];          /* variable messages */
233 };
234
235
236 struct olsr6
237 {
238   olsr_u16_t        olsr_packlen;        /* packet length */
239   olsr_u16_t        olsr_seqno;
240   struct olsrmsg6   olsr_msg[1];         /* variable messages */
241 };
242
243
244 /* 
245  * ALWAYS USE THESE WRAPPERS TO
246  * ENSURE IPv4 <-> IPv6 compability 
247  */
248
249 union olsr_message
250 {
251   struct olsrmsg v4;
252   struct olsrmsg6 v6;
253 };
254
255 union olsr_packet
256 {
257   struct olsr v4;
258   struct olsr6 v6;
259 };
260
261
262 /***************************************************************************
263  *                 Functions provided by uolsrd_plugin.c                   *
264  *                  Similar to their siblings in olsrd                     *
265  ***************************************************************************/
266
267 char ipv6_buf[100]; /* buffer for IPv6 inet_htop */
268
269 /* All these could optionally be fetched from olsrd */
270
271 olsr_u32_t
272 olsr_hashing(union olsr_ip_addr *);
273
274 void
275 olsr_get_timestamp(olsr_u32_t, struct timeval *);
276
277 void
278 olsr_init_timer(olsr_u32_t, struct timeval *);
279
280 int
281 olsr_timed_out(struct timeval *);
282
283 char *
284 olsr_ip_to_string(union olsr_ip_addr *);
285
286
287
288 /****************************************************************************
289  *                Function pointers to functions in olsrd                   *
290  *              These allow direct access to olsrd functions                *
291  ****************************************************************************/
292
293 /* The multi-purpose funtion. All other functions are fetched trough this */
294 int (*olsr_plugin_io)(int, void *, size_t);
295
296 /* add a prser function */
297 void (*olsr_parser_add_function)(void (*)(union olsr_message *, struct interface *, union olsr_ip_addr *), 
298                                  int, int);
299
300 /* Register a timeout function */
301 int (*olsr_register_timeout_function)(void (*)());
302
303 /* Register a scheduled event */
304 int (*olsr_register_scheduler_event)(void (*)(), float, float, olsr_u8_t *);
305
306 /* Get the next message seqno in line */
307 olsr_u16_t (*get_msg_seqno)();
308
309 /* Transmit package */
310 int (*net_output)(struct interface*);
311
312 /* Check the duplicate table for prior processing */
313 int (*check_dup_proc)(union olsr_ip_addr *, olsr_u16_t);
314
315 /* Default forward algorithm */
316 int (*default_fwd)(union olsr_message *, 
317                    union olsr_ip_addr *, 
318                    olsr_u16_t,  
319                    struct interface *, 
320                    union olsr_ip_addr *);
321
322 /* Add a socket to the main olsrd select loop */
323 void (*add_olsr_socket)(int, void(*)(int));
324
325 /* Remove a socket from the main olsrd select loop */
326 int (*remove_olsr_socket)(int, void(*)(int));
327
328 /* get the link status to a neighbor */
329 int (*check_neighbor_link)(union olsr_ip_addr *);
330
331 /* Mantissa/exponen conversions */
332 olsr_u8_t (*double_to_me)(double);
333
334 double (*me_to_double)(olsr_u8_t);
335
336 /* olsrd printf wrapper */
337 int (*olsr_printf)(int, char *, ...);
338
339 /* olsrd malloc wrapper */
340 void *(*olsr_malloc)(size_t, const char *);
341
342 /* Add hna net IPv4 */
343 void (*add_local_hna4_entry)(union olsr_ip_addr *, union hna_netmask *);
344
345 /* Remove hna net IPv4 */
346 int (*remove_local_hna4_entry)(union olsr_ip_addr *, union hna_netmask *);
347
348 /* Add hna net IPv6 */
349 void (*add_local_hna6_entry)(union olsr_ip_addr *, union hna_netmask *);
350
351 /* Remove hna net IPv6 */
352 int (*remove_local_hna6_entry)(union olsr_ip_addr *, union hna_netmask *);
353
354
355 /****************************************************************************
356  *                             Data from olsrd                              *
357  *           NOTE THAT POINTERS POINT TO THE DATA USED BY OLSRD!            *
358  *               NEVER ALTER DATA POINTED TO BY THESE POINTERS              * 
359  *                   UNLESS YOU KNOW WHAT YOU ARE DOING!!!                  *
360  ****************************************************************************/
361 /**
362  * The interface list from olsrd
363  */
364
365 struct interface   *ifs;
366
367 /* These two are set automatically by olsrd at load time */
368 int                ipversion;  /* IPversion in use */
369 union olsr_ip_addr *main_addr; /* Main address */
370
371
372 size_t             ipsize;     /* Size of the ipadresses used */
373 struct timeval     *now;       /* the olsrds schedulers idea of current time */
374
375 /* Data that can be altered by your plugin */
376 char               *buffer;    /* The packet buffer - put your packet here */
377 int                *outputsize;/* Pointer to the outputsize - set the size of your packet here */
378
379
380 /****************************************************************************
381  *                Functions that the plugin MUST provide                    *
382  ****************************************************************************/
383
384
385 /* Initialization function */
386 int
387 olsr_plugin_init();
388
389 /* IPC initialization function */
390 int
391 plugin_ipc_init();
392
393 /* Destructor function */
394 void
395 olsr_plugin_exit();
396
397 /* Mulitpurpose funtion */
398 int
399 plugin_io(int, void *, size_t);
400
401 #endif