eliminate the data field from an avl_node
[olsrd.git] / lib / tas / src / plugin.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon (olsrd)
3  *
4  * Copyright (c) 2004, Thomas Lopatic (thomas@olsr.org)
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without 
8  * modification, are permitted provided that the following conditions 
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright 
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright 
14  *   notice, this list of conditions and the following disclaimer in 
15  *   the documentation and/or other materials provided with the 
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its 
18  *   contributors may be used to endorse or promote products derived 
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include <string.h>
43 #include <time.h> // clock_t required by olsrd includes
44
45 #include "link.h"
46 #include "plugin.h"
47 #include "lib.h"
48 #include "os_unix.h"
49 #include "http.h"
50 #include "glua.h"
51 #include "glua_ext.h"
52 #include "olsrd_plugin.h"
53 #include "net_olsr.h"
54
55 #include <defs.h>
56 #include <olsr.h>
57 #include <scheduler.h>
58 #include <parser.h>
59 #include <link_set.h>
60 #include <neighbor_table.h>
61 #include <two_hop_neighbor_table.h>
62 #include <mid_set.h>
63 #include <tc_set.h>
64 #include <hna_set.h>
65 #include <routing_table.h>
66 #include <olsr_protocol.h>
67 #include <lq_route.h>
68 #include <mpr_selector_set.h>
69 #include <duplicate_set.h>
70 #include <lq_plugin.h>
71
72 #define PLUGIN_INTERFACE_VERSION 5
73
74 #define MESSAGE_TYPE 129
75
76 int olsrd_plugin_interface_version(void);
77 int olsrd_plugin_register_param(char *name, char *value);
78 int olsrd_plugin_init(void);
79
80 static int ipAddrLen;
81 static union olsr_ip_addr *mainAddr;
82
83 static struct interface *intTab = NULL;
84 static struct neighbor_entry *neighTab = NULL;
85 static struct mid_entry *midTab = NULL;
86 static struct hna_entry *hnaTab = NULL;
87 static struct olsrd_config *config = NULL;
88
89 static int iterIndex;
90 #if 0
91 /* not used */
92 static struct interface *iterIntTab = NULL;
93 static struct mid_entry *iterMidTab = NULL;
94 static struct hna_entry *iterHnaTab = NULL;
95 #endif
96
97 static struct link_entry *iterLinkTab = NULL;
98 static struct neighbor_entry *iterNeighTab = NULL;
99 static struct tc_entry *iterTcTab = NULL;
100 static struct rt_entry *iterRouteTab = NULL;
101
102 static void __attribute__((constructor)) banner(void)
103 {
104   printf("Tiny Application Server 0.1 by olsr.org\n");
105 }
106
107 int iterLinkTabNext(char *buff, int len)
108 {
109   struct list_node *link_node;
110   struct lqtextbuffer lqbuffer;
111   
112   if (iterLinkTab == NULL)
113     return -1;
114
115   snprintf(buff, len, "local~%s~remote~%s~main~%s~hysteresis~%f~cost~%s~",
116            rawIpAddrToString(&iterLinkTab->local_iface_addr, ipAddrLen),
117            rawIpAddrToString(&iterLinkTab->neighbor_iface_addr, ipAddrLen),
118            rawIpAddrToString(&iterLinkTab->neighbor->neighbor_main_addr, ipAddrLen),
119            iterLinkTab->L_link_quality,
120            get_linkcost_text(iterLinkTab->linkcost, OLSR_FALSE, &lqbuffer));
121
122
123   link_node = iterLinkTab->link_list.next;
124   if (link_node != &link_entry_head) {
125     iterLinkTab = list2link(link_node);
126   } else {
127     iterLinkTab = NULL;
128   }
129
130   return 0;
131 }
132
133 void iterLinkTabInit(void)
134 {
135   struct list_node *link_node;
136
137   link_node = link_entry_head.next;
138   if (link_node != &link_entry_head) {
139     iterLinkTab = list2link(link_node);
140   } else {
141     iterLinkTab = NULL;
142   }
143 }
144
145 int iterNeighTabNext(char *buff, int len)
146 {
147   int res;
148   int i;
149   struct neighbor_2_list_entry *neigh2;
150   
151   if (iterNeighTab == NULL)
152     return -1;
153
154   res = snprintf(buff, len,
155                  "main~%s~symmetric~%s~mpr~%s~mprs~%s~willingness~%d~[~neighbors2~",
156                  rawIpAddrToString(&iterNeighTab->neighbor_main_addr, ipAddrLen),
157                  iterNeighTab->status == SYM ? "true" : "false",
158                  iterNeighTab->is_mpr != 0 ? "true" : "false",
159                  olsr_lookup_mprs_set(&iterNeighTab->neighbor_main_addr) != NULL ?
160                  "true" : "false",
161                  iterNeighTab->willingness);
162
163   i = 0;
164
165   len -= res;
166   buff += res;
167
168   len -= 2;
169
170   for (neigh2 = iterNeighTab->neighbor_2_list.next;
171        neigh2 != &iterNeighTab->neighbor_2_list;
172        neigh2 = neigh2->next)
173   {
174     res = snprintf(buff, len, "%d~%s~", i,
175                    rawIpAddrToString(&neigh2->neighbor_2->neighbor_2_addr,
176                                      ipAddrLen));
177
178     if (res < len)
179       buff += res;
180
181     len -= res;
182
183     if (len <= 0)
184       break;
185
186     i++;
187   }
188
189   strcpy(buff, "]~");
190
191   iterNeighTab = iterNeighTab->next;
192
193   if (iterNeighTab == &neighTab[iterIndex])
194   {
195     iterNeighTab = NULL;
196     
197     while (++iterIndex < HASHSIZE)
198       if (neighTab[iterIndex].next != &neighTab[iterIndex])
199       {
200         iterNeighTab = neighTab[iterIndex].next;
201         break;
202       }
203   }
204
205   return 0;
206 }
207
208 void iterNeighTabInit(void)
209 {
210   iterNeighTab = NULL;
211
212   if (neighTab == NULL)
213     return;
214
215   for (iterIndex = 0; iterIndex < HASHSIZE; iterIndex++)
216     if (neighTab[iterIndex].next != &neighTab[iterIndex])
217     {
218       iterNeighTab = neighTab[iterIndex].next;
219       break;
220     }
221 }
222
223 int iterRouteTabNext(char *buff, int len)
224 {
225   struct avl_node *rt_tree_node;
226
227   if (iterRouteTab == NULL)
228     return -1;
229
230   snprintf(buff, len, "destination~%s~gateway~%s~interface~%s~metric~%d~",
231            rawIpAddrToString(&iterRouteTab->rt_dst.prefix, ipAddrLen),
232            rawIpAddrToString(&iterRouteTab->rt_best->rtp_nexthop.gateway, ipAddrLen),
233            if_ifwithindex_name(iterRouteTab->rt_best->rtp_nexthop.iif_index),
234            iterRouteTab->rt_best->rtp_metric.hops);
235
236   rt_tree_node = avl_walk_next(&iterRouteTab->rt_tree_node);
237   if (rt_tree_node) {
238       iterRouteTab = rt_tree2rt(rt_tree_node);
239   } else {
240       iterRouteTab = NULL;
241   }
242
243   return 0;
244 }
245
246 void iterRouteTabInit(void)
247 {
248   struct avl_node *node;
249
250   avl_init(&routingtree, avl_comp_prefix_default);
251   routingtree_version = 0;
252
253   node = avl_walk_first(&routingtree);
254   iterRouteTab = node ? rt_tree2rt(node) : NULL;
255
256 }
257
258 /**
259  * Grab the next topology entry.
260  *
261  * @param adr the address to look for
262  * @return the entry found or NULL
263  */
264 static struct tc_entry *
265 tas_getnext_tc_entry(struct tc_entry *tc)
266 {
267   struct avl_node *node = avl_walk_next(&tc->vertex_node);
268
269   return (node ? vertex_tree2tc(node) : NULL);
270 }
271
272 int iterTcTabNext(char *buff, int len)
273 {
274   int res;
275   int i;
276   struct tc_edge_entry *tc_edge;
277   struct lqtextbuffer lqbuffer;
278   
279   if (iterTcTab == NULL)
280     return -1;
281
282   res = snprintf(buff, len,
283                  "main~%s~[~destinations~",
284                  rawIpAddrToString(&iterTcTab->addr, ipAddrLen));
285
286   len -= res;
287   buff += res;
288
289   len -= 2;
290   i = 0;
291
292   OLSR_FOR_ALL_TC_EDGE_ENTRIES(iterTcTab, tc_edge) {
293
294     res = snprintf(buff, len, "[~%d~address~%s~cost~%s~]~", i,
295                    rawIpAddrToString(&tc_edge->T_dest_addr, ipAddrLen),
296                    get_linkcost_text(tc_edge->cost, OLSR_FALSE, &lqbuffer));
297
298     if (res < len)
299       buff += res;
300
301     len -= res;
302
303     if (len <= 0)
304       break;
305
306     i++;
307   } OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(iterTcTab, tc_edge);
308   
309   strcpy(buff, "]~");
310
311   iterTcTab = tas_getnext_tc_entry(iterTcTab);
312
313   return 0;
314 }
315
316 void iterTcTabInit(void)
317 {
318   struct avl_node *node;
319   
320   avl_init(&tc_tree, avl_comp_default);
321
322   node = avl_walk_first(&tc_tree);
323   iterTcTab = (node ? vertex_tree2tc(node) : NULL);
324 }
325
326 static void parserFunc(union olsr_message *msg,
327                        struct interface *inInt __attribute__((unused)),
328                        union olsr_ip_addr *neighIntAddr)
329 {
330   char *mess = (char *)msg;
331   union olsr_ip_addr *orig = (union olsr_ip_addr *)(mess + 4);
332   int len = (mess[2] << 8) | mess[3];
333   char *service, *string;
334   int i;
335
336   if (memcmp(orig, mainAddr, ipAddrLen) == 0)
337     return;
338
339   if (check_neighbor_link(neighIntAddr) != SYM_LINK)
340   {
341     error("TAS message not from symmetric neighbour\n");
342     return;
343   }
344
345   if (len < ipAddrLen + 8 + 2)
346   {
347     error("short TAS message received (%d bytes)\n", len);
348     return;
349   }
350
351     len -= ipAddrLen + 8;
352     service = mess + ipAddrLen + 8;
353
354     for (i = 0; i < len && service[i] != 0; i++);
355
356     if (i++ == len)
357     {
358       error("TAS message has unterminated service string\n");
359       return;
360     }
361
362     if (i == len)
363     {
364       error("TAS message lacks payload string\n");
365       return;
366     }
367
368     string = service + i;
369     len -= i;
370
371     for (i = 0; i < len && string[i] != 0; i++);
372
373     if (i == len)
374     {
375       error("TAS message has unterminated payload string\n");
376       return;
377     }
378
379     httpAddTasMessage(service, string, rawIpAddrToString(orig, ipAddrLen));
380
381   olsr_forward_message(msg, neighIntAddr);
382 }
383
384 void sendMessage(const char *service, const char *string)
385 {
386   unsigned char *mess, *walker;
387   int len, pad;
388   unsigned short seqNo;
389   struct interface *inter;
390
391   pad = len = ipAddrLen + 8 + strlen(service) + 1 + strlen(string) + 1;
392
393   len = 1 + ((len - 1) | 3);
394
395   pad = len - pad;
396
397   walker = mess = allocMem(len);
398
399   seqNo = get_msg_seqno();
400
401   *walker++ = MESSAGE_TYPE;
402   *walker++ = 0;
403   *walker++ = (unsigned char)(len >> 8);
404   *walker++ = (unsigned char)len;
405
406   memcpy(walker, mainAddr, ipAddrLen);
407   walker += ipAddrLen;
408
409   *walker++ = 255;
410   *walker++ = 0;
411   *walker++ = (unsigned char)(seqNo >> 8);
412   *walker++ = (unsigned char)seqNo;
413
414   while (*service != 0)
415     *walker++ = *service++;
416
417   *walker++ = 0;
418
419   while (*string != 0)
420     *walker++ = *string++;
421
422   *walker++ = 0;
423
424   while (pad-- > 0)
425     *walker++ = 0;
426
427   for (inter = intTab; inter != NULL; inter = inter->int_next)
428   {
429     if (net_outbuffer_push(inter, mess, len) != len)
430     {
431       net_output(inter);
432       net_outbuffer_push(inter, mess, len);
433     }
434   }
435 }
436
437 static void serviceFunc(void *context __attribute__((unused)))
438 {
439   static int up = 0;
440
441   if (up == 0)
442   {
443     if (httpSetup() < 0)
444       return;
445
446     up = 1;
447   }
448
449   if (up != 0)
450     httpService((int)(1.0 / config->pollrate));
451 }
452
453 int olsrd_plugin_interface_version(void)
454 {
455   return PLUGIN_INTERFACE_VERSION;
456 }
457
458 int olsrd_plugin_init(void)
459 {
460   ipAddrLen = olsr_cnf->ipsize;
461   mainAddr = &olsr_cnf->main_addr;
462
463   intTab = ifnet;
464   neighTab = neighbortable;
465   midTab = mid_set;
466   hnaTab = hna_set;
467   config = olsr_cnf;
468
469   httpInit();
470   
471   olsr_start_timer(OLSR_TAS_SERVICE_INT, 0, OLSR_TIMER_PERIODIC,
472                    &serviceFunc, NULL, 0);
473
474   olsr_parser_add_function(parserFunc, MESSAGE_TYPE, 1);
475
476   return 0;
477 }
478
479 static const struct olsrd_plugin_parameters plugin_parameters[] = {
480     { .name = "address",   .set_plugin_parameter = &httpSetAddress,   .data = NULL },
481     { .name = "port",      .set_plugin_parameter = &httpSetPort,      .data = NULL },
482     { .name = "rootdir",   .set_plugin_parameter = &httpSetRootDir,   .data = NULL },
483     { .name = "workdir",   .set_plugin_parameter = &httpSetWorkDir,   .data = NULL },
484     { .name = "indexfile", .set_plugin_parameter = &httpSetIndexFile, .data = NULL },
485     { .name = "user",      .set_plugin_parameter = &httpSetUser,      .data = NULL },
486     { .name = "password",  .set_plugin_parameter = &httpSetPassword,  .data = NULL },
487     { .name = "sesstime",  .set_plugin_parameter = &httpSetSessTime,  .data = NULL },
488     { .name = "pubdir",    .set_plugin_parameter = &httpSetPubDir,    .data = NULL },
489     { .name = "quantum",   .set_plugin_parameter = &httpSetQuantum,   .data = NULL },
490     { .name = "messtime",  .set_plugin_parameter = &httpSetMessTime,  .data = NULL },
491     { .name = "messlimit", .set_plugin_parameter = &httpSetMessLimit, .data = NULL },
492 };
493
494 void olsrd_get_plugin_parameters(const struct olsrd_plugin_parameters **params, int *size)
495 {
496     *params = plugin_parameters;
497     *size = sizeof(plugin_parameters)/sizeof(*plugin_parameters);
498 }
499
500 /*
501  * Local Variables:
502  * c-basic-offset: 2
503  * End:
504  */