update comments on all ifdefs
[olsrd.git] / src / parser.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004, Andreas Tonnesen(andreto@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 "parser.h"
43 #include "ipcalc.h"
44 #include "defs.h"
45 #include "process_package.h"
46 #include "mantissa.h"
47 #include "hysteresis.h"
48 #include "duplicate_set.h"
49 #include "mid_set.h"
50 #include "olsr.h"
51 #include "rebuild_packet.h"
52 #include "net_os.h"
53 #include "log.h"
54 #include "print_packet.h"
55 #include "net_olsr.h"
56 #include "duplicate_handler.h"
57
58 #ifdef _WIN32
59 #undef EWOULDBLOCK
60 #define EWOULDBLOCK WSAEWOULDBLOCK
61 #undef errno
62 #define errno WSAGetLastError()
63 char *StrError(unsigned int ErrNo);
64 #undef strerror
65 #define strerror(x) StrError(x)
66 #endif /* _WIN32 */
67
68     /* Sven-Ola: On very slow devices used in huge networks
69  * the amount of lq_tc messages is so high, that the
70  * recv() loop never ends. This is a small hack to end
71  * the loop in this cases
72  */
73
74 unsigned int cpu_overload_exit = 0;
75
76 struct parse_function_entry *parse_functions;
77 struct preprocessor_function_entry *preprocessor_functions;
78 struct packetparser_function_entry *packetparser_functions;
79
80 static uint32_t inbuf_aligned[MAXMESSAGESIZE/sizeof(uint32_t) + 1];
81 static char *inbuf = (char *)inbuf_aligned;
82
83 static bool disp_pack_in = false;
84
85 void
86 parser_set_disp_pack_in(bool val)
87 {
88   disp_pack_in = val;
89 }
90
91 /**
92  *Initialize the parser.
93  *
94  *@return nada
95  */
96 void
97 olsr_init_parser(void)
98 {
99   OLSR_PRINTF(3, "Initializing parser...\n");
100
101   /* Initialize the packet functions */
102   olsr_init_package_process();
103
104 }
105
106 void
107 olsr_destroy_parser(void) {
108   struct parse_function_entry *pe, *pe_next;
109   struct preprocessor_function_entry *ppe, *ppe_next;
110   struct packetparser_function_entry *pae, *pae_next;
111
112   for (pe = parse_functions; pe; pe = pe_next) {
113     pe_next = pe->next;
114     free (pe);
115   }
116   for (ppe = preprocessor_functions; ppe; ppe = ppe_next) {
117     ppe_next = ppe->next;
118     free (ppe);
119   }
120   for (pae = packetparser_functions; pae; pae = pae_next) {
121     pae_next = pae->next;
122     free(pae);
123   }
124 }
125
126 void
127 olsr_parser_add_function(parse_function * function, uint32_t type)
128 {
129   struct parse_function_entry *new_entry;
130
131   OLSR_PRINTF(3, "Parser: registering event for type %d\n", type);
132
133   new_entry = olsr_malloc(sizeof(struct parse_function_entry), "Register parse function");
134
135   new_entry->function = function;
136   new_entry->type = type;
137
138   /* Queue */
139   new_entry->next = parse_functions;
140   parse_functions = new_entry;
141
142   OLSR_PRINTF(3, "Register parse function: Added function for type %d\n", type);
143
144 }
145
146 int
147 olsr_parser_remove_function(parse_function * function, uint32_t type)
148 {
149   struct parse_function_entry *entry, *prev;
150
151   entry = parse_functions;
152   prev = NULL;
153
154   while (entry) {
155     if ((entry->function == function) && (entry->type == type)) {
156       if (entry == parse_functions) {
157         parse_functions = entry->next;
158       } else {
159         prev->next = entry->next;
160       }
161       free(entry);
162       return 1;
163     }
164
165     prev = entry;
166     entry = entry->next;
167   }
168
169   return 0;
170 }
171
172 void
173 olsr_preprocessor_add_function(preprocessor_function * function)
174 {
175   struct preprocessor_function_entry *new_entry;
176
177   OLSR_PRINTF(3, "Parser: registering preprocessor\n");
178
179   new_entry = olsr_malloc(sizeof(struct preprocessor_function_entry), "Register preprocessor function");
180
181   new_entry->function = function;
182
183   /* Queue */
184   new_entry->next = preprocessor_functions;
185   preprocessor_functions = new_entry;
186
187   OLSR_PRINTF(3, "Registered preprocessor function\n");
188
189 }
190
191 int
192 olsr_preprocessor_remove_function(preprocessor_function * function)
193 {
194   struct preprocessor_function_entry *entry, *prev;
195
196   entry = preprocessor_functions;
197   prev = NULL;
198
199   while (entry) {
200     if (entry->function == function) {
201       if (entry == preprocessor_functions) {
202         preprocessor_functions = entry->next;
203       } else {
204         prev->next = entry->next;
205       }
206       free(entry);
207       return 1;
208     }
209
210     prev = entry;
211     entry = entry->next;
212   }
213
214   return 0;
215 }
216
217 void
218 olsr_packetparser_add_function(packetparser_function * function)
219 {
220   struct packetparser_function_entry *new_entry;
221
222   OLSR_PRINTF(3, "Parser: registering packetparser\n");
223
224   new_entry = olsr_malloc(sizeof(struct packetparser_function_entry), "Register packetparser function");
225
226   new_entry->function = function;
227
228   /* Queue */
229   new_entry->next = packetparser_functions;
230   packetparser_functions = new_entry;
231
232   OLSR_PRINTF(3, "Registered packetparser  function\n");
233
234 }
235
236 int
237 olsr_packetparser_remove_function(packetparser_function * function)
238 {
239   struct packetparser_function_entry *entry, *prev;
240
241   entry = packetparser_functions;
242   prev = NULL;
243
244   while (entry) {
245     if (entry->function == function) {
246       if (entry == packetparser_functions) {
247         packetparser_functions = entry->next;
248       } else {
249         prev->next = entry->next;
250       }
251       free(entry);
252       return 1;
253     }
254
255     prev = entry;
256     entry = entry->next;
257   }
258
259   return 0;
260 }
261
262 /**
263  *Process a newly received OLSR packet. Checks the type
264  *and to the neccessary convertions and call the
265  *corresponding functions to handle the information.
266  *@param from the sockaddr struct describing the sender
267  *@param olsr the olsr struct containing the message
268  *@param size the size of the message
269  *@return nada
270  */
271
272 void
273 parse_packet(struct olsr *olsr, int size, struct interface *in_if, union olsr_ip_addr *from_addr)
274 {
275   union olsr_message *m = (union olsr_message *)olsr->olsr_msg;
276   uint32_t count;
277   uint32_t msgsize;
278   uint16_t seqno;
279   struct parse_function_entry *entry;
280   struct packetparser_function_entry *packetparser;
281
282   count = size - ((char *)m - (char *)olsr);
283
284   /* minimum packet size is 4 */
285   if (count < 4)
286     return;
287
288   if (ntohs(olsr->olsr_packlen) !=(uint16_t) size) {
289     struct ipaddr_str buf;
290     OLSR_PRINTF(1, "Size error detected in received packet.\nReceived %d, in packet %d\n", size, ntohs(olsr->olsr_packlen));
291
292     olsr_syslog(OLSR_LOG_ERR, " packet length error in  packet received from %s!", olsr_ip_to_string(&buf, from_addr));
293     return;
294   }
295
296   /* Display packet */
297   if (disp_pack_in)
298     print_olsr_serialized_packet(stdout, (union olsr_packet *)olsr, size, from_addr);
299
300   // translate sequence number to host order
301   olsr->olsr_seqno = ntohs(olsr->olsr_seqno);
302
303   // call packetparser
304   packetparser = packetparser_functions;
305   while (packetparser) {
306     packetparser->function(olsr, in_if, from_addr);
307     packetparser = packetparser->next;
308   }
309
310   //printf("Message from %s\n\n", olsr_ip_to_string(&buf, from_addr));
311
312   /*
313    * Hysteresis update - for every OLSR package
314    */
315   if (olsr_cnf->use_hysteresis) {
316     if (olsr_cnf->ip_version == AF_INET) {
317       /* IPv4 */
318       update_hysteresis_incoming(from_addr, in_if, olsr->olsr_seqno);
319     } else {
320       /* IPv6 */
321       update_hysteresis_incoming(from_addr, in_if, olsr->olsr_seqno);
322     }
323   }
324
325   for (; count > 0; m = (union olsr_message *)((char *)m + (msgsize))) {
326     bool forward = true;
327     bool validated;
328
329     /* minimum message size is 8 + ipsize */
330     if (count < 8 + olsr_cnf->ipsize)
331       break;
332
333     if (olsr_cnf->ip_version == AF_INET) {
334       msgsize = ntohs(m->v4.olsr_msgsize);
335       seqno = ntohs(m->v4.seqno);
336     }
337     else {
338       msgsize = ntohs(m->v6.olsr_msgsize);
339       seqno = ntohs(m->v6.seqno);
340     }
341
342     /* sanity check for msgsize */
343     if (msgsize < 8 + olsr_cnf->ipsize) {
344       struct ipaddr_str buf;
345       union olsr_ip_addr *msgorig = (union olsr_ip_addr *) &m->v4.originator;
346       OLSR_PRINTF(1, "Error, OLSR message from %s (type %d) is to small (%d bytes)"
347           ", ignoring all further content of the packet\n",
348           olsr_ip_to_string(&buf, msgorig), m->v4.olsr_msgtype, msgsize);
349       olsr_syslog(OLSR_LOG_ERR, "Error, OLSR message from %s (type %d) is too small (%d bytes)"
350           ", ignoring all further content of the packet\n",
351           olsr_ip_to_string(&buf, msgorig), m->v4.olsr_msgtype, msgsize);
352       break;
353     }
354
355     if ((msgsize % 4) != 0) {
356       struct ipaddr_str buf;
357       union olsr_ip_addr *msgorig = (union olsr_ip_addr *) &m->v4.originator;
358       OLSR_PRINTF(1, "Error, OLSR message from %s (type %d) must be"
359           " longword aligned, but has a length of %d bytes\n",
360           olsr_ip_to_string(&buf, msgorig), m->v4.olsr_msgtype, msgsize);
361       olsr_syslog(OLSR_LOG_ERR, "Error, OLSR message from %s (type %d) must be"
362           " longword aligned, but has a length of %d bytes",
363           olsr_ip_to_string(&buf, msgorig), m->v4.olsr_msgtype, msgsize);
364       break;
365     }
366
367     if (msgsize > count) {
368       struct ipaddr_str buf;
369       union olsr_ip_addr *msgorig = (union olsr_ip_addr *) &m->v4.originator;
370       OLSR_PRINTF(1, "Error, OLSR message from %s (type %d) says"
371           " length=%d, but only %d bytes left\n",
372           olsr_ip_to_string(&buf, msgorig), m->v4.olsr_msgtype, msgsize, count);
373       olsr_syslog(OLSR_LOG_ERR, "Error, OLSR message from %s (type %d) says"
374           " length=%d, but only %d bytes left",
375           olsr_ip_to_string(&buf, msgorig), m->v4.olsr_msgtype, msgsize, count);
376       break;
377     }
378
379     count -= msgsize;
380
381     /*RFC 3626 section 3.4:
382      *  2    If the time to live of the message is less than or equal to
383      *  '0' (zero), or if the message was sent by the receiving node
384      *  (i.e., the Originator Address of the message is the main
385      *  address of the receiving node): the message MUST silently be
386      *  dropped.
387      */
388
389     /* Should be the same for IPv4 and IPv6 */
390     validated = olsr_validate_address((union olsr_ip_addr *)&m->v4.originator);
391     if (ipequal((union olsr_ip_addr *)&m->v4.originator, &olsr_cnf->main_addr) || !validated) {
392 #ifdef DEBUG
393       struct ipaddr_str buf;
394       OLSR_PRINTF(3, "Not processing message originating from %s!\n",
395                   olsr_ip_to_string(&buf, (union olsr_ip_addr *)&m->v4.originator));
396 #endif /* DEBUG */
397 #ifndef NO_DUPLICATE_DETECTION_HANDLER
398       if (validated) {
399         olsr_test_originator_collision(m->v4.olsr_msgtype, seqno);
400       }
401 #endif /* NO_DUPLICATE_DETECTION_HANDLER */
402       continue;
403     }
404
405     entry = parse_functions;
406     while (entry) {
407       /* Should be the same for IPv4 and IPv6 */
408
409       /* Promiscuous or exact match */
410       if ((entry->type == PROMISCUOUS) || (entry->type == m->v4.olsr_msgtype)) {
411         if (!entry->function(m, in_if, from_addr))
412           forward = false;
413       }
414       entry = entry->next;
415     }
416
417     if (forward) {
418       olsr_forward_message(m, in_if, from_addr);
419     }
420   }                             /* for olsr_msg */
421 }
422
423 /**
424  *Processing OLSR data from socket. Reading data, setting
425  *wich interface received the message, Sends IPC(if used)
426  *and passes the packet on to parse_packet().
427  *
428  *@param fd the filedescriptor that data should be read from.
429  *@return nada
430  */
431 void
432 olsr_input(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused)))
433 {
434   struct interface *olsr_in_if;
435   union olsr_ip_addr from_addr;
436   struct preprocessor_function_entry *entry;
437   char *packet;
438
439   cpu_overload_exit = 0;
440
441   for (;;) {
442     struct ipaddr_str buf;
443     /* sockaddr_in6 is bigger than sockaddr !!!! */
444     struct sockaddr_storage from;
445     socklen_t fromlen;
446     int cc;
447
448     if (32 < ++cpu_overload_exit) {
449       OLSR_PRINTF(1, "CPU overload detected, ending olsr_input() loop\n");
450       break;
451     }
452
453     fromlen = sizeof(struct sockaddr_storage);
454     cc = olsr_recvfrom(fd, inbuf, sizeof(inbuf_aligned), 0, (struct sockaddr *)&from, &fromlen);
455
456     if (cc <= 0) {
457       if (cc < 0 && errno != EWOULDBLOCK) {
458         OLSR_PRINTF(1, "error recvfrom: %s", strerror(errno));
459 #ifndef _WIN32
460         olsr_syslog(OLSR_LOG_ERR, "error recvfrom: %m");
461 #endif /* _WIN32 */
462       }
463       break;
464     }
465     if (olsr_cnf->ip_version == AF_INET) {
466       /* IPv4 sender address */
467       void * src = &((struct sockaddr_in *)&from)->sin_addr;
468       memcpy(&from_addr.v4, src, sizeof(from_addr.v4));
469     } else {
470       /* IPv6 sender address */
471       void * src = &((struct sockaddr_in6 *)&from)->sin6_addr;
472       memcpy(&from_addr.v6, src, sizeof(from_addr.v6));
473     }
474
475 #ifdef DEBUG
476     OLSR_PRINTF(5, "Received a packet from %s\n",
477         olsr_ip_to_string(&buf, &from_addr));
478 #endif /* DEBUG */
479
480     if ((olsr_cnf->ip_version == AF_INET) && (fromlen != sizeof(struct sockaddr_in)))
481       break;
482     else if ((olsr_cnf->ip_version == AF_INET6) && (fromlen != sizeof(struct sockaddr_in6)))
483       break;
484
485     /* are we talking to ourselves? */
486     if (if_ifwithaddr(&from_addr) != NULL)
487       return;
488
489     if ((olsr_in_if = if_ifwithsock(fd)) == NULL) {
490       OLSR_PRINTF(1, "Could not find input interface for message from %s size %d\n", olsr_ip_to_string(&buf, &from_addr), cc);
491       olsr_syslog(OLSR_LOG_ERR, "Could not find input interface for message from %s size %d\n", olsr_ip_to_string(&buf, &from_addr),
492                   cc);
493       return;
494     }
495     // call preprocessors
496     entry = preprocessor_functions;
497     packet = &inbuf[0];
498
499     while (entry) {
500       packet = entry->function(packet, olsr_in_if, &from_addr, &cc);
501       // discard package ?
502       if (packet == NULL) {
503         return;
504       }
505       entry = entry->next;
506     }
507
508     /*
509      * &from - sender
510      * &inbuf.olsr
511      * cc - bytes read
512      */
513     parse_packet((struct olsr *)packet, cc, olsr_in_if, &from_addr);
514
515   }
516 }
517
518 /**
519  *Processing OLSR data from socket. Reading data, setting
520  *wich interface received the message, Sends IPC(if used)
521  *and passes the packet on to parse_packet().
522  *
523  *@param fd the filedescriptor that data should be read from.
524  *@return nada
525  */
526 void
527 olsr_input_hostemu(int fd, void *data __attribute__ ((unused)), unsigned int flags __attribute__ ((unused)))
528 {
529   /* sockaddr_in6 is bigger than sockaddr !!!! */
530   struct sockaddr_storage from;
531   socklen_t fromlen;
532   struct interface *olsr_in_if;
533   union olsr_ip_addr from_addr;
534   uint16_t pcklen;
535   struct preprocessor_function_entry *entry;
536   char *packet;
537
538   /* Host emulator receives IP address first to emulate
539      direct link */
540
541   int cc = recv(fd, (void*)from_addr.v6.s6_addr, olsr_cnf->ipsize, 0);
542   if (cc != (int)olsr_cnf->ipsize) {
543     fprintf(stderr, "Error receiving host-client IP hook(%d) %s!\n", cc, strerror(errno));
544     memcpy(&from_addr, &((struct olsr *)inbuf)->olsr_msg->originator, olsr_cnf->ipsize);
545   }
546
547   /* are we talking to ourselves? */
548   if (if_ifwithaddr(&from_addr) != NULL)
549     return;
550
551   /* Extract size */
552   if ((cc = recv(fd, (void *)&pcklen, 2, MSG_PEEK)) != 2) {     /* Win needs a cast */
553     if (cc <= 0) {
554       fprintf(stderr, "Lost olsr_switch connection - exit!\n");
555       olsr_exit(__func__, EXIT_FAILURE);
556     }
557     fprintf(stderr, "[hust-emu] error extracting size(%d) %s!\n", cc, strerror(errno));
558     return;
559   } else {
560     pcklen = ntohs(pcklen);
561   }
562
563   fromlen = sizeof(struct sockaddr_storage);
564
565   cc = olsr_recvfrom(fd, inbuf, pcklen, 0, (struct sockaddr *)&from, &fromlen);
566
567   if (cc <= 0) {
568     if (cc < 0 && errno != EWOULDBLOCK) {
569       const char *const err_msg = strerror(errno);
570       OLSR_PRINTF(1, "error recvfrom: %s", err_msg);
571       olsr_syslog(OLSR_LOG_ERR, "error recvfrom: %s", err_msg);
572     }
573     return;
574   }
575
576   if (cc != pcklen) {
577     printf("Could not read whole packet(size %d, read %d)\n", pcklen, cc);
578     return;
579   }
580
581   if ((olsr_in_if = if_ifwithsock(fd)) == NULL) {
582     struct ipaddr_str buf;
583     OLSR_PRINTF(1, "Could not find input interface for message from %s size %d\n", olsr_ip_to_string(&buf, &from_addr), cc);
584     olsr_syslog(OLSR_LOG_ERR, "Could not find input interface for message from %s size %d\n", olsr_ip_to_string(&buf, &from_addr),
585                 cc);
586     return;
587   }
588   // call preprocessors
589   entry = preprocessor_functions;
590   packet = &inbuf[0];
591
592   while (entry) {
593     packet = entry->function(packet, olsr_in_if, &from_addr, &cc);
594     // discard package ?
595     if (packet == NULL) {
596       return;
597     }
598     entry = entry->next;
599   }
600
601   /*
602    * &from - sender
603    * &inbuf.olsr
604    * cc - bytes read
605    */
606   parse_packet((struct olsr *)inbuf, cc, olsr_in_if, &from_addr);
607
608 }
609
610 /*
611  * Local Variables:
612  * c-basic-offset: 2
613  * indent-tabs-mode: nil
614  * End:
615  */