include ADMIN_INTERFACE flag and src/cfgparser/cfgfile_gen.o
[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 /* $Id: olsrd_plugin.h,v 1.9 2005/04/10 11:52:05 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 "interfaces.h"
52 #include "apm.h"
53
54 /* Use this as PARSER_TYPE to receive ALL messages! */
55 #define PROMISCUOUS 0xffffffff
56
57
58 /*****************************************************************************
59  *                               Plugin data                                 *
60  *                       ALTER THIS TO YOUR OWN NEED                         *
61  *****************************************************************************/
62
63 #define PLUGIN_NAME    "OLSRD Powerstatus plugin"
64 #define PLUGIN_VERSION "0.3"
65 #define PLUGIN_AUTHOR   "Andreas T√łnnesen"
66 #define MOD_DESC PLUGIN_NAME " " PLUGIN_VERSION " by " PLUGIN_AUTHOR
67 #define PLUGIN_INTERFACE_VERSION 3
68
69 /* The type of message you will use */
70 #define MESSAGE_TYPE 128
71
72 /* The type of messages we will receive - can be set to promiscuous */
73 #define PARSER_TYPE MESSAGE_TYPE
74
75
76
77 /****************************************************************************
78  *           Various datastructures and definitions from olsrd              *
79  ****************************************************************************/
80
81
82 #define MAX_TTL               0xff
83
84
85 /*
86  *Link Types
87  */
88
89 #define UNSPEC_LINK           0
90 #define ASYM_LINK             1
91 #define SYM_LINK              2
92 #define LOST_LINK             3
93 #define HIDE_LINK             4
94 #define MAX_LINK              4
95
96
97
98 /*
99  * Hashing
100  */
101
102 #define HASHSIZE        32
103 #define HASHMASK        (HASHSIZE - 1)
104
105 #define MAXIFS         8 /* Maximum number of interfaces (from defs.h) in uOLSRd */
106
107
108 /****************************************************************************
109  *                            PACKET SECTION                                *
110  ****************************************************************************/
111
112
113 /**********************************
114  * DEFINE YOUR CUSTOM PACKET HERE *
115  **********************************/
116
117 struct powermsg
118 {
119   olsr_u8_t       source_type;
120   olsr_u8_t       percentage;
121   olsr_u16_t      time_left;
122 };
123
124 /*
125  * OLSR message (several can exist in one OLSR packet)
126  */
127
128 struct olsrmsg
129 {
130   olsr_u8_t     olsr_msgtype;
131   olsr_u8_t     olsr_vtime;
132   olsr_u16_t    olsr_msgsize;
133   olsr_u32_t    originator;
134   olsr_u8_t     ttl;
135   olsr_u8_t     hopcnt;
136   olsr_u16_t    seqno;
137
138   /* YOUR PACKET GOES HERE */
139   struct powermsg msg;
140
141 };
142
143 /*
144  *IPv6
145  */
146
147 struct olsrmsg6
148 {
149   olsr_u8_t        olsr_msgtype;
150   olsr_u8_t        olsr_vtime;
151   olsr_u16_t       olsr_msgsize;
152   struct in6_addr  originator;
153   olsr_u8_t        ttl;
154   olsr_u8_t        hopcnt;
155   olsr_u16_t       seqno;
156
157   /* YOUR PACKET GOES HERE */
158   struct powermsg msg;
159
160 };
161
162 /* 
163  * ALWAYS USE THESE WRAPPERS TO
164  * ENSURE IPv4 <-> IPv6 compability 
165  */
166
167 union olsr_message
168 {
169   struct olsrmsg v4;
170   struct olsrmsg6 v6;
171 };
172
173
174
175
176 /***************************************************************************
177  *                 Functions provided by uolsrd_plugin.c                   *
178  *                  Similar to their siblings in olsrd                     *
179  ***************************************************************************/
180
181 char ipv6_buf[100]; /* buffer for IPv6 inet_htop */
182
183 /* All these could optionally be fetched from olsrd */
184
185 olsr_u32_t
186 olsr_hashing(union olsr_ip_addr *);
187
188 void
189 olsr_get_timestamp(olsr_u32_t, struct timeval *);
190
191 void
192 olsr_init_timer(olsr_u32_t, struct timeval *);
193
194 int
195 olsr_timed_out(struct timeval *);
196
197 char *
198 olsr_ip_to_string(union olsr_ip_addr *);
199
200
201
202 /****************************************************************************
203  *                Function pointers to functions in olsrd                   *
204  *              These allow direct access to olsrd functions                *
205  ****************************************************************************/
206
207 /* The multi-purpose funtion. All other functions are fetched trough this */
208 int (*olsr_plugin_io)(int, void *, size_t);
209
210 /* add a prser function */
211 void (*olsr_parser_add_function)(void (*)(union olsr_message *, struct interface *, union olsr_ip_addr *), int, int);
212
213 /* Register a timeout function */
214 int (*olsr_register_timeout_function)(void (*)(void));
215
216 /* Register a scheduled event */
217 int (*olsr_register_scheduler_event)(void (*)(void *), void *, float, float, olsr_u8_t *);
218
219 /* Get the next message seqno in line */
220 olsr_u16_t (*get_msg_seqno)(void);
221
222 int (*net_outbuffer_push)(struct interface *, olsr_u8_t *, olsr_u16_t);
223
224 /* Transmit package */
225 int (*net_output)(struct interface*);
226
227 /* Check the duplicate table for prior processing */
228 int (*check_dup_proc)(union olsr_ip_addr *, olsr_u16_t);
229
230 /* Default forward algorithm */
231 int (*default_fwd)(union olsr_message *, 
232                    union olsr_ip_addr *, 
233                    olsr_u16_t,  
234                    struct interface *, 
235                    union olsr_ip_addr *);
236
237 /* Add a socket to the main olsrd select loop */
238 void (*add_olsr_socket)(int, void(*)(int));
239
240 /* get the link status to a neighbor */
241 int (*check_neighbor_link)(union olsr_ip_addr *);
242
243 /* Mantissa/exponen conversions */
244 olsr_u8_t (*double_to_me)(double);
245
246 double (*me_to_double)(olsr_u8_t);
247
248 /* olsrd printf wrapper */
249 int (*olsr_printf)(int, char *, ...);
250
251 /* olsrd malloc wrapper */
252 void *(*olsr_malloc)(size_t, const char *);
253
254 int (*apm_read)(struct olsr_apm_info *);
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 /* IPC initialization function */
288 int
289 plugin_ipc_init(void);
290
291 int
292 register_olsr_param(char *, char *);
293
294 /* Destructor function */
295 void
296 olsr_plugin_exit(void);
297
298 /* Mulitpurpose funtion */
299 int
300 plugin_io(int, void *, size_t);
301
302 /* Plugin interface version */
303 int 
304 get_plugin_interface_version(void);
305
306 #endif