9c08bfe4d9de918782a53b684248470d121e7aaf
[olsrd.git] / lib / txtinfo / src / olsrd_txtinfo.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@olsr.org)
5  *                     includes code by Bruno Randolf
6  *                     includes code by Andreas Lopatic
7  *                     includes code by Sven-Ola Tuecke
8  *                     includes code by Lorenz Schori
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  *
15  * * Redistributions of source code must retain the above copyright
16  *   notice, this list of conditions and the following disclaimer.
17  * * Redistributions in binary form must reproduce the above copyright
18  *   notice, this list of conditions and the following disclaimer in
19  *   the documentation and/or other materials provided with the
20  *   distribution.
21  * * Neither the name of olsr.org, olsrd nor the names of its
22  *   contributors may be used to endorse or promote products derived
23  *   from this software without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
30  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
35  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  *
38  * Visit http://www.olsr.org for more information.
39  *
40  * If you find this software useful feel free to make a donation
41  * to the project. For more information see the website or contact
42  * the copyright holders.
43  *
44  */
45
46 /*
47  * Dynamic linked library for the olsr.org olsr daemon
48  */
49
50 #include <sys/types.h>
51 #include <sys/socket.h>
52 #if !defined WIN32
53 #include <sys/select.h>
54 #endif
55 #include <netinet/in.h>
56 #include <arpa/inet.h>
57 #include <sys/time.h>
58 #include <time.h>
59 #include <math.h>
60 #include <stdio.h>
61 #include <string.h>
62 #include <stdlib.h>
63 #include <unistd.h>
64 #include <errno.h>
65
66 #include "ipcalc.h"
67 #include "olsr.h"
68 #include "olsr_types.h"
69 #include "neighbor_table.h"
70 #include "two_hop_neighbor_table.h"
71 #include "mpr_selector_set.h"
72 #include "tc_set.h"
73 #include "hna_set.h"
74 #include "mid_set.h"
75 #include "link_set.h"
76 #include "socket_parser.h"
77 #include "net_olsr.h"
78 #include "lq_plugin.h"
79 #include "common/autobuf.h"
80
81 #include "olsrd_txtinfo.h"
82 #include "olsrd_plugin.h"
83
84 #ifdef WIN32
85 #define close(x) closesocket(x)
86 #endif
87
88 static int ipc_socket;
89
90 /* IPC initialization function */
91 static int plugin_ipc_init(void);
92
93 static void send_info(int send_what, int socket);
94
95 static void ipc_action(int);
96
97 static void ipc_print_neigh(struct autobuf *);
98
99 static void ipc_print_link(struct autobuf *);
100
101 static void ipc_print_routes(struct autobuf *);
102
103 static void ipc_print_topology(struct autobuf *);
104
105 static void ipc_print_hna(struct autobuf *);
106
107 static void ipc_print_mid(struct autobuf *);
108
109 #define TXT_IPC_BUFSIZE 256
110
111 #define SIW_ALL 0
112 #define SIW_NEIGH 1
113 #define SIW_LINK 2
114 #define SIW_ROUTE 3
115 #define SIW_HNA 4
116 #define SIW_MID 5
117 #define SIW_TOPO 6
118 #define SIW_NEIGHLINK 7
119
120 #define MAX_CLIENTS 3
121
122 static char *outbuffer[MAX_CLIENTS];
123 static size_t outbuffer_size[MAX_CLIENTS];
124 static size_t outbuffer_written[MAX_CLIENTS];
125 static int outbuffer_socket[MAX_CLIENTS];
126 static int outbuffer_count;
127
128 static struct timer_entry *writetimer_entry;
129
130 /**
131  *Do initialization here
132  *
133  *This function is called by the my_init
134  *function in uolsrd_plugin.c
135  */
136 int
137 olsrd_plugin_init(void)
138 {
139   /* Initial IPC value */
140   ipc_socket = -1;
141
142   plugin_ipc_init();
143   return 1;
144 }
145
146 /**
147  * destructor - called at unload
148  */
149 void
150 olsr_plugin_exit(void)
151 {
152   if (ipc_socket != -1)
153     close(ipc_socket);
154 }
155
156 static int
157 plugin_ipc_init(void)
158 {
159   struct sockaddr_storage sst;
160   struct sockaddr_in *sin;
161   struct sockaddr_in6 *sin6;
162   uint32_t yes = 1;
163   socklen_t addrlen;
164
165   /* Init ipc socket */
166   if ((ipc_socket = socket(olsr_cnf->ip_version, SOCK_STREAM, 0)) == -1) {
167 #ifndef NODEBUG
168     olsr_printf(1, "(TXTINFO) socket()=%s\n", strerror(errno));
169 #endif
170     return 0;
171   } else {
172     if (setsockopt(ipc_socket, SOL_SOCKET, SO_REUSEADDR, (char *)&yes, sizeof(yes)) < 0) {
173 #ifndef NODEBUG
174       olsr_printf(1, "(TXTINFO) setsockopt()=%s\n", strerror(errno));
175 #endif
176       return 0;
177     }
178 #if defined __FreeBSD__ && defined SO_NOSIGPIPE
179     if (setsockopt(ipc_socket, SOL_SOCKET, SO_NOSIGPIPE, (char *)&yes, sizeof(yes)) < 0) {
180       perror("SO_REUSEADDR failed");
181       return 0;
182     }
183 #endif
184     /* Bind the socket */
185
186     /* complete the socket structure */
187     memset(&sst, 0, sizeof(sst));
188     if (olsr_cnf->ip_version == AF_INET) {
189       sin = (struct sockaddr_in *)&sst;
190       sin->sin_family = AF_INET;
191       addrlen = sizeof(struct sockaddr_in);
192 #ifdef SIN6_LEN
193       sin->sin_len = addrlen;
194 #endif
195       sin->sin_addr.s_addr = INADDR_ANY;
196       sin->sin_port = htons(ipc_port);
197     } else {
198       sin6 = (struct sockaddr_in6 *)&sst;
199       sin6->sin6_family = AF_INET6;
200       addrlen = sizeof(struct sockaddr_in6);
201 #ifdef SIN6_LEN
202       sin6->sin6_len = addrlen;
203 #endif
204       sin6->sin6_addr = in6addr_any;
205       sin6->sin6_port = htons(ipc_port);
206     }
207
208     /* bind the socket to the port number */
209     if (bind(ipc_socket, (struct sockaddr *)&sst, addrlen) == -1) {
210 #ifndef NODEBUG
211       olsr_printf(1, "(TXTINFO) bind()=%s\n", strerror(errno));
212 #endif
213       return 0;
214     }
215
216     /* show that we are willing to listen */
217     if (listen(ipc_socket, 1) == -1) {
218 #ifndef NODEBUG
219       olsr_printf(1, "(TXTINFO) listen()=%s\n", strerror(errno));
220 #endif
221       return 0;
222     }
223
224     /* Register with olsrd */
225     add_olsr_socket(ipc_socket, &ipc_action);
226
227 #ifndef NODEBUG
228     olsr_printf(2, "(TXTINFO) listening on port %d\n", ipc_port);
229 #endif
230   }
231   return 1;
232 }
233
234 static void
235 ipc_action(int fd)
236 {
237   struct sockaddr_storage pin;
238   struct sockaddr_in *sin4;
239   struct sockaddr_in6 *sin6;
240   char addr[INET6_ADDRSTRLEN];
241   fd_set rfds;
242   struct timeval tv;
243   int send_what = 0;
244   int ipc_connection;
245
246   socklen_t addrlen = sizeof(struct sockaddr_storage);
247
248   if ((ipc_connection = accept(fd, (struct sockaddr *)&pin, &addrlen)) == -1) {
249 #ifndef NODEBUG
250     olsr_printf(1, "(TXTINFO) accept()=%s\n", strerror(errno));
251 #endif
252     return;
253   }
254
255   tv.tv_sec = tv.tv_usec = 0;
256   if (olsr_cnf->ip_version == AF_INET) {
257     sin4 = (struct sockaddr_in *)&pin;
258     if (inet_ntop(olsr_cnf->ip_version, &sin4->sin_addr, addr, INET6_ADDRSTRLEN) == NULL)
259       addr[0] = '\0';
260     if (!ip4equal(&sin4->sin_addr, &ipc_accept_ip.v4)) {
261       olsr_printf(1, "(TXTINFO) From host(%s) not allowed!\n", addr);
262       close(ipc_connection);
263       return;
264     }
265   } else {
266     sin6 = (struct sockaddr_in6 *)&pin;
267     if (inet_ntop(olsr_cnf->ip_version, &sin6->sin6_addr, addr, INET6_ADDRSTRLEN) == NULL)
268       addr[0] = '\0';
269     /* Use in6addr_any (::) in olsr.conf to allow anybody. */
270     if (!ip6equal(&in6addr_any, &ipc_accept_ip.v6) && !ip6equal(&sin6->sin6_addr, &ipc_accept_ip.v6)) {
271       olsr_printf(1, "(TXTINFO) From host(%s) not allowed!\n", addr);
272       close(ipc_connection);
273       return;
274     }
275   }
276
277 #ifndef NODEBUG
278   olsr_printf(2, "(TXTINFO) Connect from %s\n", addr);
279 #endif
280
281   /* purge read buffer to prevent blocking on linux */
282   FD_ZERO(&rfds);
283   FD_SET((unsigned int)ipc_connection, &rfds);  /* Win32 needs the cast here */
284   if (0 <= select(ipc_connection + 1, &rfds, NULL, NULL, &tv)) {
285     char requ[128];
286     ssize_t s = recv(ipc_connection, (void *)&requ, sizeof(requ), 0);   /* Win32 needs the cast here */
287     if (0 < s) {
288       requ[s] = 0;
289       /* To print out neighbours only on the Freifunk Status
290        * page the normal output is somewhat lengthy. The
291        * header parsing is sufficient for standard wget.
292        */
293       if (0 != strstr(requ, "/neighbours"))
294         send_what = SIW_NEIGHLINK;
295       else if (0 != strstr(requ, "/neigh"))
296         send_what = SIW_NEIGH;
297       else if (0 != strstr(requ, "/link"))
298         send_what = SIW_LINK;
299       else if (0 != strstr(requ, "/route"))
300         send_what = SIW_ROUTE;
301       else if (0 != strstr(requ, "/hna"))
302         send_what = SIW_HNA;
303       else if (0 != strstr(requ, "/mid"))
304         send_what = SIW_MID;
305       else if (0 != strstr(requ, "/topo"))
306         send_what = SIW_TOPO;
307     }
308   }
309
310   send_info(send_what, ipc_connection);
311 }
312
313 static void
314 ipc_print_neigh(struct autobuf *abuf)
315 {
316   struct ipaddr_str buf1;
317   struct neighbor_entry *neigh;
318   struct neighbor_2_list_entry *list_2;
319   int thop_cnt;
320
321   abuf_puts(abuf, "Table: Neighbors\nIP address\tSYM\tMPR\tMPRS\tWill.\t2 Hop Neighbors\n");
322
323   /* Neighbors */
324   OLSR_FOR_ALL_NBR_ENTRIES(neigh) {
325     abuf_appendf(abuf, "%s\t%s\t%s\t%s\t%d\t", olsr_ip_to_string(&buf1, &neigh->neighbor_main_addr), (neigh->status == SYM) ? "YES" : "NO",
326               neigh->is_mpr ? "YES" : "NO", olsr_lookup_mprs_set(&neigh->neighbor_main_addr) ? "YES" : "NO", neigh->willingness);
327     thop_cnt = 0;
328
329     for (list_2 = neigh->neighbor_2_list.next; list_2 != &neigh->neighbor_2_list; list_2 = list_2->next) {
330       //size += sprintf(&buf[size], "<option>%s</option>\n", olsr_ip_to_string(&buf1, &list_2->neighbor_2->neighbor_2_addr));
331       thop_cnt++;
332     }
333     abuf_appendf(abuf, "%d\n", thop_cnt);
334   }
335   OLSR_FOR_ALL_NBR_ENTRIES_END(neigh);
336   abuf_puts(abuf, "\n");
337 }
338
339 static void
340 ipc_print_link(struct autobuf *abuf)
341 {
342   struct ipaddr_str buf1, buf2;
343   struct lqtextbuffer lqbuffer1, lqbuffer2;
344
345   struct link_entry *link = NULL;
346
347   abuf_puts(abuf, "Table: Links\nLocal IP\tRemote IP\tHyst.\tLQ\tNLQ\tCost\n");
348
349   /* Link set */
350   OLSR_FOR_ALL_LINK_ENTRIES(link) {
351     abuf_appendf(abuf, "%s\t%s\t%0.2f\t%s\t%s\t\n", olsr_ip_to_string(&buf1, &link->local_iface_addr),
352               olsr_ip_to_string(&buf2, &link->neighbor_iface_addr), link->L_link_quality, get_link_entry_text(link, '\t',
353                                                                                                               &lqbuffer1),
354               get_linkcost_text(link->linkcost, false, &lqbuffer2));
355   } OLSR_FOR_ALL_LINK_ENTRIES_END(link);
356
357   abuf_puts(abuf, "\n");
358 }
359
360 static void
361 ipc_print_routes(struct autobuf *abuf)
362 {
363   struct ipaddr_str buf1, buf2;
364   struct rt_entry *rt;
365   struct lqtextbuffer lqbuffer;
366
367   abuf_puts(abuf, "Table: Routes\nDestination\tGateway IP\tMetric\tETX\tInterface\n");
368
369   /* Walk the route table */
370   OLSR_FOR_ALL_RT_ENTRIES(rt) {
371     abuf_appendf(abuf, "%s/%d\t%s\t%d\t%s\t%s\t\n", olsr_ip_to_string(&buf1, &rt->rt_dst.prefix), rt->rt_dst.prefix_len,
372               olsr_ip_to_string(&buf2, &rt->rt_best->rtp_nexthop.gateway), rt->rt_best->rtp_metric.hops,
373               get_linkcost_text(rt->rt_best->rtp_metric.cost, true, &lqbuffer),
374               if_ifwithindex_name(rt->rt_best->rtp_nexthop.iif_index));
375   } OLSR_FOR_ALL_RT_ENTRIES_END(rt);
376
377   abuf_puts(abuf, "\n");
378
379 }
380
381 static void
382 ipc_print_topology(struct autobuf *abuf)
383 {
384   struct tc_entry *tc;
385
386   abuf_puts(abuf, "Table: Topology\nDest. IP\tLast hop IP\tLQ\tNLQ\tCost\n");
387
388   /* Topology */
389   OLSR_FOR_ALL_TC_ENTRIES(tc) {
390     struct tc_edge_entry *tc_edge;
391     OLSR_FOR_ALL_TC_EDGE_ENTRIES(tc, tc_edge) {
392       if (tc_edge->edge_inv) {
393         struct ipaddr_str dstbuf, addrbuf;
394         struct lqtextbuffer lqbuffer1, lqbuffer2;
395         abuf_appendf(abuf, "%s\t%s\t%s\t%s\n", olsr_ip_to_string(&dstbuf, &tc_edge->T_dest_addr), olsr_ip_to_string(&addrbuf, &tc->addr),
396                   get_tc_edge_entry_text(tc_edge, '\t', &lqbuffer1), get_linkcost_text(tc_edge->cost, false, &lqbuffer2));
397       }
398     } OLSR_FOR_ALL_TC_EDGE_ENTRIES_END(tc, tc_edge);
399   } OLSR_FOR_ALL_TC_ENTRIES_END(tc);
400
401   abuf_puts(abuf, "\n");
402 }
403
404 static void
405 ipc_print_hna(struct autobuf *abuf)
406 {
407   int size;
408   struct ip_prefix_list *hna;
409   struct hna_entry *tmp_hna;
410   struct hna_net *tmp_net;
411   struct ipaddr_str addrbuf, mainaddrbuf;
412
413   size = 0;
414
415   abuf_puts(abuf, "Table: HNA\nDestination\tGateway\n");
416
417   /* Announced HNA entries */
418   if (olsr_cnf->ip_version == AF_INET) {
419     for (hna = olsr_cnf->hna_entries; hna != NULL; hna = hna->next) {
420       struct ipaddr_str addrbuf, mainaddrbuf;
421       abuf_appendf(abuf, "%s/%d\t%s\n", olsr_ip_to_string(&addrbuf, &hna->net.prefix), hna->net.prefix_len,
422                 olsr_ip_to_string(&mainaddrbuf, &olsr_cnf->main_addr));
423     }
424   } else {
425     for (hna = olsr_cnf->hna_entries; hna != NULL; hna = hna->next) {
426       struct ipaddr_str addrbuf, mainaddrbuf;
427       abuf_appendf(abuf, "%s/%d\t%s\n", olsr_ip_to_string(&addrbuf, &hna->net.prefix), hna->net.prefix_len,
428                 olsr_ip_to_string(&mainaddrbuf, &olsr_cnf->main_addr));
429     }
430   }
431
432   /* HNA entries */
433   OLSR_FOR_ALL_HNA_ENTRIES(tmp_hna) {
434
435     /* Check all networks */
436     for (tmp_net = tmp_hna->networks.next; tmp_net != &tmp_hna->networks; tmp_net = tmp_net->next) {
437
438       abuf_appendf(abuf, "%s/%d\t%s\n", olsr_ip_to_string(&addrbuf, &tmp_net->A_network_addr), tmp_net->prefixlen,
439                 olsr_ip_to_string(&mainaddrbuf, &tmp_hna->A_gateway_addr));
440     }
441   }
442   OLSR_FOR_ALL_HNA_ENTRIES_END(tmp_hna);
443
444   abuf_puts(abuf, "\n");
445 }
446
447 static void
448 ipc_print_mid(struct autobuf *abuf)
449 {
450   int index;
451   unsigned short is_first;
452   struct mid_entry *entry;
453   struct mid_address *alias;
454
455   abuf_puts(abuf, "Table: MID\nIP address\tAliases\n");
456
457   /* MID */
458   for (index = 0; index < HASHSIZE; index++) {
459     entry = mid_set[index].next;
460
461     while (entry != &mid_set[index]) {
462       struct ipaddr_str buf;
463       abuf_puts(abuf, olsr_ip_to_string(&buf, &entry->main_addr));
464       alias = entry->aliases;
465       is_first = 1;
466
467       while (alias) {
468         abuf_appendf(abuf, "%s%s", (is_first ? "\t" : ";"), olsr_ip_to_string(&buf, &alias->alias));
469
470         alias = alias->next_alias;
471         is_first = 0;
472       }
473       entry = entry->next;
474       abuf_puts(abuf,"\n");
475     }
476   }
477   abuf_puts(abuf, "\n");
478 }
479
480 static void
481 txtinfo_write_data(void *foo __attribute__ ((unused))) {
482   fd_set set;
483   int result, i, j, max;
484   struct timeval tv;
485
486   FD_ZERO(&set);
487   max = 0;
488   for (i=0; i<outbuffer_count; i++) {
489     FD_SET(outbuffer_socket[i], &set);
490     if (outbuffer_socket[i] > max) {
491       max = outbuffer_socket[i];
492     }
493   }
494
495   tv.tv_sec = 0;
496   tv.tv_usec = 0;
497
498   result = select(max + 1, NULL, &set, NULL, &tv);
499   if (result <= 0) {
500     return;
501   }
502
503   for (i=0; i<outbuffer_count; i++) {
504     if (FD_ISSET(outbuffer_socket[i], &set)) {
505       result = write(outbuffer_socket[i], outbuffer[i] + outbuffer_written[i], outbuffer_size[i] - outbuffer_written[i]);
506       if (result > 0) {
507         outbuffer_written[i] += result;
508       }
509
510       if (result <= 0 || outbuffer_written[i] == outbuffer_size[i]) {
511         /* close this socket and cleanup*/
512         close(outbuffer_socket[i]);
513         free (outbuffer[i]);
514
515         for (j=i+1; j<outbuffer_count; j++) {
516           outbuffer[j-1] = outbuffer[j];
517           outbuffer_size[j-1] = outbuffer_size[j];
518           outbuffer_socket[j-1] = outbuffer_socket[j];
519           outbuffer_written[j-1] = outbuffer_written[j];
520         }
521         outbuffer_count--;
522       }
523     }
524   }
525   if (outbuffer_count == 0) {
526     olsr_stop_timer(writetimer_entry);
527   }
528 }
529
530 static void
531 send_info(int send_what, int socket)
532 {
533   struct autobuf abuf;
534
535   abuf_init(&abuf, 4096);
536
537   /* Print minimal http header */
538   abuf_puts(&abuf, "HTTP/1.0 200 OK\n");
539   abuf_puts(&abuf, "Content-type: text/plain\n\n");
540
541   /* Print tables to IPC socket */
542
543   /* links + Neighbors */
544   if ((send_what == SIW_ALL) || (send_what == SIW_NEIGHLINK) || (send_what == SIW_LINK))
545     ipc_print_link(&abuf);
546
547   if ((send_what == SIW_ALL) || (send_what == SIW_NEIGHLINK) || (send_what == SIW_NEIGH))
548     ipc_print_neigh(&abuf);
549
550   /* topology */
551   if ((send_what == SIW_ALL) || (send_what == SIW_TOPO))
552     ipc_print_topology(&abuf);
553
554   /* hna */
555   if ((send_what == SIW_ALL) || (send_what == SIW_HNA))
556     ipc_print_hna(&abuf);
557
558   /* mid */
559   if ((send_what == SIW_ALL) || (send_what == SIW_MID))
560     ipc_print_mid(&abuf);
561
562   /* routes */
563   if ((send_what == SIW_ALL) || (send_what == SIW_ROUTE))
564     ipc_print_routes(&abuf);
565
566   outbuffer[outbuffer_count] = olsr_malloc(abuf.len, "txt output buffer");
567   outbuffer_size[outbuffer_count] = abuf.len;
568   outbuffer_written[outbuffer_count] = 0;
569   outbuffer_socket[outbuffer_count] = socket;
570
571   memcpy(outbuffer[outbuffer_count], abuf.buf, abuf.len);
572   outbuffer_count++;
573
574   if (outbuffer_count == 1) {
575     writetimer_entry = olsr_start_timer(100, 0, OLSR_TIMER_PERIODIC, &txtinfo_write_data, NULL, 0);
576   }
577
578   abuf_free(&abuf);
579 }
580
581 /*
582  * Local Variables:
583  * mode: c
584  * style: linux
585  * c-basic-offset: 4
586  * indent-tabs-mode: nil
587  * End:
588  */