Initial import
[olsrd.git] / src / olsr.c
1 /*
2  * OLSR ad-hoc routing table management protocol
3  * Copyright (C) 2004 Andreas T√łnnesen (andreto@ifi.uio.no)
4  *
5  * This file is part of olsrd-unik.
6  *
7  * UniK olsrd is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * UniK olsrd is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with olsrd-unik; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  */
22
23 #include "defs.h"
24 #include "olsr.h"
25 #include "link_set.h"
26 #include "two_hop_neighbor_table.h"
27 #include "tc_set.h"
28 #include "duplicate_set.h"
29 #include "mpr_selector_set.h"
30 #include "mid_set.h"
31 #include "mpr.h"
32 #include "scheduler.h"
33 #include "generate_msg.h"
34 #include "apm.h"
35
36 #include <stdarg.h>
37 #include <signal.h>
38
39
40 /**
41  *Checks if a timer has timed out.
42  */
43
44
45 /**
46  *Initiates a "timer", wich is a timeval structure,
47  *with the value given in time_value.
48  *@param time_value the value to initialize the timer with
49  *@param hold_timer the timer itself
50  *@return nada
51  */
52 inline void
53 olsr_init_timer(olsr_u32_t time_value, struct timeval *hold_timer)
54
55   olsr_u16_t  time_value_sec;
56   olsr_u16_t  time_value_msec;
57
58   time_value_sec = time_value/1000;
59   time_value_msec = time_value-(time_value_sec*1000);
60
61   hold_timer->tv_sec = time_value_sec;
62   hold_timer->tv_usec = time_value_msec*1000;   
63 }
64
65
66
67
68
69 /**
70  *Generaties a timestamp a certain number of milliseconds
71  *into the future.
72  *
73  *@param time_value how many milliseconds from now
74  *@param hold_timer the timer itself
75  *@return nada
76  */
77 inline void
78 olsr_get_timestamp(olsr_u32_t delay, struct timeval *hold_timer)
79
80 #warning BUGFIX - TEST!
81
82   hold_timer->tv_sec = now.tv_sec + delay / 1000;
83   hold_timer->tv_usec = now.tv_usec + (delay % 1000) * 1000;
84   
85   if (hold_timer->tv_usec > 1000000)
86     {
87       hold_timer->tv_sec++;
88       hold_timer->tv_usec -= 1000000;
89     }
90 }
91
92
93
94 /**
95  *Initialize the message sequence number as a random value
96  */
97 void
98 init_msg_seqno()
99 {
100   message_seqno = random() & 0xFFFF;
101 }
102
103 /**
104  * Get and increment the message sequence number
105  *
106  *@return the seqno
107  */
108 inline olsr_u16_t
109 get_msg_seqno()
110 {
111   return message_seqno++;
112 }
113
114
115 void
116 register_pcf(int (*f)(int, int, int))
117 {
118   struct pcf *new_pcf;
119
120   olsr_printf(1, "Registering pcf function\n");
121
122   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
123
124   new_pcf->function = f;
125   new_pcf->next = pcf_list;
126   pcf_list = new_pcf;
127
128 }
129
130
131 /**
132  *Process changes in neighborhood or/and topology.
133  *Re-calculates the neighborhooh/topology if there
134  *are any updates - then calls the right functions to
135  *update the routing table.
136  *@return 0
137  */
138 inline void
139 olsr_process_changes()
140 {
141
142   struct pcf *tmp_pc_list;
143
144 #ifdef DEBUG
145   if(changes_neighborhood)
146     olsr_printf(3, "CHANGES IN NEIGHBORHOOD\n");
147   if(changes_topology)
148     olsr_printf(3, "CHANGES IN TOPOLOGY\n");
149   if(changes_hna)
150     olsr_printf(3, "CHANGES IN HNA\n");  
151 #endif
152
153   if(!changes_neighborhood &&
154      !changes_topology &&
155      !changes_hna)
156     return;
157
158   if(changes_neighborhood)
159     {
160       /* Calculate new mprs, HNA and routing table */
161       olsr_calculate_mpr();
162       olsr_calculate_routing_table();
163       olsr_calculate_hna_routes();
164
165       goto process_pcf;  
166     }
167   
168   if(changes_topology)
169     {
170       /* calculate the routing table and HNA */
171       olsr_calculate_routing_table();
172       olsr_calculate_hna_routes();
173
174       goto process_pcf;  
175     }
176
177   if(changes_hna)
178     {
179       /* Update HNA routes */
180       olsr_calculate_hna_routes();
181
182       goto process_pcf;
183     }
184   
185  process_pcf:
186
187   for(tmp_pc_list = pcf_list; 
188       tmp_pc_list != NULL;
189       tmp_pc_list = tmp_pc_list->next)
190     {
191       tmp_pc_list->function(changes_neighborhood,
192                             changes_topology,
193                             changes_hna);
194     }
195
196   changes_neighborhood = DOWN;
197   changes_topology = DOWN;
198   changes_hna = DOWN;
199
200
201   return;
202 }
203
204
205
206
207
208 /**
209  *Initialize all the tables used(neighbor,
210  *topology, MID,  HNA, MPR, dup).
211  *Also initalizes other variables
212  */
213 void
214 olsr_init_tables()
215 {
216   
217   changes_topology = DOWN;
218   changes_neighborhood = DOWN;
219   changes_hna = DOWN;
220
221   /* Initialize link set */
222   olsr_init_link_set();
223
224   /* Initialize duplicate table */
225   olsr_init_duplicate_table();
226
227   /* Initialize neighbor table */
228   olsr_init_neighbor_table();
229
230   /* Initialize routing table */
231   olsr_init_routing_table();
232
233   /* Initialize two hop table */
234   olsr_init_two_hop_table();
235
236   /* Initialize old route table */
237   olsr_init_old_table();
238
239   /* Initialize topology */
240   olsr_init_tc();
241
242   /* Initialize mpr selector table */
243   olsr_init_mprs_set();
244
245   /* Initialize MID set */
246   olsr_init_mid_set();
247
248   /* Initialize HNA set */
249   olsr_init_hna_set();
250
251   /* Initialize ProcessChanges list */
252   ptf_list = NULL;
253   
254 }
255
256
257
258
259
260
261 /**
262  *Check if a message is to be forwarded and forward
263  *it if necessary.
264  *
265  *@param m the OLSR message recieved
266  *@param originator the originator of this message
267  *@param seqno the seqno of the message
268  *
269  *@returns positive if forwarded
270  */
271 int
272 olsr_forward_message(union olsr_message *m, 
273                      union olsr_ip_addr *originator, 
274                      olsr_u16_t seqno,
275                      struct interface *in_if, 
276                      union olsr_ip_addr *from_addr)
277 {
278   union olsr_message *om;
279   union olsr_ip_addr *src;
280   struct neighbor_entry *neighbor;
281   int msgsize;
282
283
284   if(!olsr_check_dup_table_fwd(originator, seqno, &in_if->ip_addr))
285     {
286 #ifdef DEBUG
287       olsr_printf(3, "Message already forwarded!\n");
288 #endif
289       return 0;
290     }
291
292   /* Lookup sender address */
293   if(!(src = mid_lookup_main_addr(from_addr)))
294     src = from_addr;
295
296
297   if(NULL == (neighbor=olsr_lookup_neighbor_table(src)))
298     return 0;
299
300   if(neighbor->status != SYM)
301     return 0;
302
303   /* Update duplicate table interface */
304   olsr_update_dup_entry(originator, seqno, &in_if->ip_addr);
305
306   
307   /* Check MPR */
308   if(olsr_lookup_mprs_set(src) == NULL)
309     {
310 #ifdef DEBUG
311       olsr_printf(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(src));
312 #endif
313       return 0;
314     }
315
316
317   /* Treat TTL hopcnt */
318   if(ipversion == AF_INET)
319     {
320       /* IPv4 */
321       m->v4.hopcnt++;
322       m->v4.ttl--; 
323     }
324   else
325     {
326       /* IPv6 */
327       m->v6.hopcnt++;
328       m->v6.ttl--; 
329     }
330
331
332
333   /* Update dup forwarded */
334   olsr_set_dup_forward(originator, seqno);
335
336   /* Update packet data */
337
338
339   msgsize = ntohs(m->v4.olsr_msgsize);
340
341   if(fwdsize)
342     {
343       /*
344        * Check if message is to big to be piggybacked
345        */
346       if((fwdsize + msgsize) > maxmessagesize)
347         {
348           olsr_printf(1, "Forwardbuffer full(%d + %d) - flushing!\n", fwdsize, msgsize);
349
350           /* Send */
351           net_forward();
352
353           /* Buffer message */
354           buffer_forward(m);
355         }
356       else
357         {
358 #ifdef DEBUG
359           olsr_printf(3, "Piggybacking message - buffer: %d msg: %d\n", fwdsize, msgsize);
360 #endif
361           /* piggyback message to outputbuffer */
362           om =  (union olsr_message *)((char*)fwdmsg + fwdsize);
363
364           memcpy(om, m, msgsize);
365           fwdsize += msgsize;
366           /* Set messagesize  - same for IPv4 and IPv6 */
367           fwdmsg->v4.olsr_packlen = htons(fwdsize);
368         }
369     }
370
371   else
372     {
373       /* No forwarding pending */
374       buffer_forward(m);
375     }
376
377   return 1;
378
379 }
380
381
382
383 int
384 buffer_forward(union olsr_message *m)
385 {
386   float jitter;
387   struct timeval jittertimer;
388   int msgsize;
389
390   msgsize = ntohs(m->v4.olsr_msgsize);  
391       
392   /* Set timer */
393   jitter = (float) random()/RAND_MAX;
394   jitter *= max_jitter;
395
396   olsr_init_timer((olsr_u32_t) (jitter*1000), &jittertimer);
397   
398   timeradd(&now, &jittertimer, &fwdtimer);
399   
400   /* Add header and message */
401   fwdsize = sizeof(olsr_u16_t) + sizeof(olsr_u16_t) + msgsize;
402   
403   /* Set messagesize  - same for IPv4 and IPv6 */
404   fwdmsg->v4.olsr_packlen = htons(fwdsize);
405   
406 #ifdef DEBUG
407   olsr_printf(3, "Adding jitter for forwarding: %f size: %d\n", jitter, fwdsize);
408 #endif
409
410   /* Copy message to outputbuffer */
411   memcpy(fwdmsg->v4.olsr_msg, m, msgsize);
412
413   return 1;
414 }
415
416
417
418 void
419 olsr_init_willingness()
420 {
421   if(!willingness_set)
422     olsr_register_scheduler_event(&olsr_update_willingness, will_int, will_int, NULL);
423 }
424
425 void
426 olsr_update_willingness()
427 {
428   int tmp_will;
429
430   tmp_will = my_willingness;
431
432   /* Re-calculate willingness */
433   my_willingness = olsr_calculate_willingness();
434
435   if(tmp_will != my_willingness)
436     {
437       olsr_printf(1, "Local willingness updated: old %d new %d\n", tmp_will, my_willingness);
438     }
439 }
440
441
442 /**
443  *Calculate this nodes willingness to act as a MPR
444  *based on either a fixed value or the power status
445  *of the node using APM
446  *
447  *@return a 8bit value from 0-7 representing the willingness
448  */
449
450 olsr_u8_t
451 olsr_calculate_willingness()
452 {
453   struct olsr_apm_info ainfo;
454
455   /* If fixed willingness */
456   if(willingness_set)
457     return my_willingness;
458
459
460   if(apm_read(&ainfo) < 0)
461     return WILL_DEFAULT;
462
463   apm_printinfo(&ainfo);
464
465   /* If AC powered */
466   if(ainfo.ac_line_status)
467     return 6;
468
469   /* If battery powered 
470    *
471    * juice > 78% will: 3
472    * 78% > juice > 26% will: 2
473    * 26% > juice will: 1
474    */
475   return (ainfo.battery_percentage / 26);
476 }
477
478
479
480 /**
481  *Termination function to be called whenever a error occures
482  *that requires the daemon to terminate
483  *
484  *@param msg the message to write to the syslog and possibly stdout
485  */
486
487 void
488 olsr_exit(const char *msg, int val)
489 {
490   olsr_printf(1, "OLSR EXIT: %s\n", msg);
491   syslog(LOG_ERR, "olsrd exit: %s\n", msg);
492   fflush(stdout);
493   exit_value = val;
494
495   raise(SIGTERM);
496 }
497
498
499 /**
500  *Wrapper for malloc(3) that does error-checking
501  *
502  *@param size the number of bytes to allocalte
503  *@param caller a string identifying the caller for
504  *use in error messaging
505  *
506  *@return a void pointer to the memory allocated
507  */
508 void *
509 olsr_malloc(size_t size, const char *id)
510 {
511   void *ptr;
512
513   if((ptr = malloc(size)) == 0) 
514     {
515       olsr_printf(1, "OUT OF MEMORY: %s\n", strerror(errno));
516       syslog(LOG_ERR, "olsrd: out of memory!: %m\n");
517       olsr_exit((char *)id, EXIT_FAILURE);
518     }
519   return ptr;
520 }
521
522
523 /**
524  *Wrapper for printf that prints to a specific
525  *debuglevel upper limit
526  *
527  */
528
529 inline int
530 olsr_printf(int loglevel, char *format, ...)
531 {
532   va_list arglist;
533
534   va_start(arglist, format);
535
536   if(loglevel <= debug_level)
537     {
538       vprintf(format, arglist);
539     }
540
541   va_end(arglist);
542
543   return 0;
544 }