Replaced unik-olsrd with olsr.org
[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 olsr.org.
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 olsr.org; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20  *
21  */
22
23 /**
24  * All these functions are global
25  */
26
27 #include "defs.h"
28 #include "olsr.h"
29 #include "link_set.h"
30 #include "two_hop_neighbor_table.h"
31 #include "tc_set.h"
32 #include "duplicate_set.h"
33 #include "mpr_selector_set.h"
34 #include "mid_set.h"
35 #include "mpr.h"
36 #include "scheduler.h"
37 #include "generate_msg.h"
38 #include "apm.h"
39
40 #include <stdarg.h>
41 #include <signal.h>
42
43
44 /**
45  *Checks if a timer has timed out.
46  */
47
48
49 /**
50  *Initiates a "timer", wich is a timeval structure,
51  *with the value given in time_value.
52  *@param time_value the value to initialize the timer with
53  *@param hold_timer the timer itself
54  *@return nada
55  */
56 inline void
57 olsr_init_timer(olsr_u32_t time_value, struct timeval *hold_timer)
58
59   olsr_u16_t  time_value_sec;
60   olsr_u16_t  time_value_msec;
61
62   time_value_sec = time_value/1000;
63   time_value_msec = time_value-(time_value_sec*1000);
64
65   hold_timer->tv_sec = time_value_sec;
66   hold_timer->tv_usec = time_value_msec*1000;   
67 }
68
69
70
71
72
73 /**
74  *Generaties a timestamp a certain number of milliseconds
75  *into the future.
76  *
77  *@param time_value how many milliseconds from now
78  *@param hold_timer the timer itself
79  *@return nada
80  */
81 inline void
82 olsr_get_timestamp(olsr_u32_t delay, struct timeval *hold_timer)
83
84   hold_timer->tv_sec = now.tv_sec + delay / 1000;
85   hold_timer->tv_usec = now.tv_usec + (delay % 1000) * 1000;
86   
87   if (hold_timer->tv_usec > 1000000)
88     {
89       hold_timer->tv_sec++;
90       hold_timer->tv_usec -= 1000000;
91     }
92 }
93
94
95
96 /**
97  *Initialize the message sequence number as a random value
98  */
99 void
100 init_msg_seqno()
101 {
102   message_seqno = random() & 0xFFFF;
103 }
104
105 /**
106  * Get and increment the message sequence number
107  *
108  *@return the seqno
109  */
110 inline olsr_u16_t
111 get_msg_seqno()
112 {
113   return message_seqno++;
114 }
115
116
117 void
118 register_pcf(int (*f)(int, int, int))
119 {
120   struct pcf *new_pcf;
121
122   olsr_printf(1, "Registering pcf function\n");
123
124   new_pcf = olsr_malloc(sizeof(struct pcf), "New PCF");
125
126   new_pcf->function = f;
127   new_pcf->next = pcf_list;
128   pcf_list = new_pcf;
129
130 }
131
132
133 /**
134  *Process changes in neighborhood or/and topology.
135  *Re-calculates the neighborhooh/topology if there
136  *are any updates - then calls the right functions to
137  *update the routing table.
138  *@return 0
139  */
140 inline void
141 olsr_process_changes()
142 {
143
144   struct pcf *tmp_pc_list;
145
146 #ifdef DEBUG
147   if(changes_neighborhood)
148     olsr_printf(3, "CHANGES IN NEIGHBORHOOD\n");
149   if(changes_topology)
150     olsr_printf(3, "CHANGES IN TOPOLOGY\n");
151   if(changes_hna)
152     olsr_printf(3, "CHANGES IN HNA\n");  
153 #endif
154
155   if(!changes_neighborhood &&
156      !changes_topology &&
157      !changes_hna)
158     return;
159
160   if(changes_neighborhood)
161     {
162       /* Calculate new mprs, HNA and routing table */
163       olsr_calculate_mpr();
164       olsr_calculate_routing_table();
165       olsr_calculate_hna_routes();
166
167       goto process_pcf;  
168     }
169   
170   if(changes_topology)
171     {
172       /* calculate the routing table and HNA */
173       olsr_calculate_routing_table();
174       olsr_calculate_hna_routes();
175
176       goto process_pcf;  
177     }
178
179   if(changes_hna)
180     {
181       /* Update HNA routes */
182       olsr_calculate_hna_routes();
183
184       goto process_pcf;
185     }
186   
187  process_pcf:
188
189   for(tmp_pc_list = pcf_list; 
190       tmp_pc_list != NULL;
191       tmp_pc_list = tmp_pc_list->next)
192     {
193       tmp_pc_list->function(changes_neighborhood,
194                             changes_topology,
195                             changes_hna);
196     }
197
198   changes_neighborhood = DOWN;
199   changes_topology = DOWN;
200   changes_hna = DOWN;
201
202
203   return;
204 }
205
206
207
208
209
210 /**
211  *Initialize all the tables used(neighbor,
212  *topology, MID,  HNA, MPR, dup).
213  *Also initalizes other variables
214  */
215 void
216 olsr_init_tables()
217 {
218   
219   changes_topology = DOWN;
220   changes_neighborhood = DOWN;
221   changes_hna = DOWN;
222
223   /* Initialize link set */
224   olsr_init_link_set();
225
226   /* Initialize duplicate table */
227   olsr_init_duplicate_table();
228
229   /* Initialize neighbor table */
230   olsr_init_neighbor_table();
231
232   /* Initialize routing table */
233   olsr_init_routing_table();
234
235   /* Initialize two hop table */
236   olsr_init_two_hop_table();
237
238   /* Initialize old route table */
239   olsr_init_old_table();
240
241   /* Initialize topology */
242   olsr_init_tc();
243
244   /* Initialize mpr selector table */
245   olsr_init_mprs_set();
246
247   /* Initialize MID set */
248   olsr_init_mid_set();
249
250   /* Initialize HNA set */
251   olsr_init_hna_set();
252
253   /* Initialize ProcessChanges list */
254   ptf_list = NULL;
255   
256 }
257
258
259
260
261
262
263 /**
264  *Check if a message is to be forwarded and forward
265  *it if necessary.
266  *
267  *@param m the OLSR message recieved
268  *@param originator the originator of this message
269  *@param seqno the seqno of the message
270  *
271  *@returns positive if forwarded
272  */
273 int
274 olsr_forward_message(union olsr_message *m, 
275                      union olsr_ip_addr *originator, 
276                      olsr_u16_t seqno,
277                      struct interface *in_if, 
278                      union olsr_ip_addr *from_addr)
279 {
280   union olsr_message *om;
281   union olsr_ip_addr *src;
282   struct neighbor_entry *neighbor;
283   int msgsize;
284
285
286   if(!olsr_check_dup_table_fwd(originator, seqno, &in_if->ip_addr))
287     {
288 #ifdef DEBUG
289       olsr_printf(3, "Message already forwarded!\n");
290 #endif
291       return 0;
292     }
293
294   /* Lookup sender address */
295   if(!(src = mid_lookup_main_addr(from_addr)))
296     src = from_addr;
297
298
299   if(NULL == (neighbor=olsr_lookup_neighbor_table(src)))
300     return 0;
301
302   if(neighbor->status != SYM)
303     return 0;
304
305   /* Update duplicate table interface */
306   olsr_update_dup_entry(originator, seqno, &in_if->ip_addr);
307
308   
309   /* Check MPR */
310   if(olsr_lookup_mprs_set(src) == NULL)
311     {
312 #ifdef DEBUG
313       olsr_printf(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(src));
314 #endif
315       return 0;
316     }
317
318
319   /* Treat TTL hopcnt */
320   if(ipversion == AF_INET)
321     {
322       /* IPv4 */
323       m->v4.hopcnt++;
324       m->v4.ttl--; 
325     }
326   else
327     {
328       /* IPv6 */
329       m->v6.hopcnt++;
330       m->v6.ttl--; 
331     }
332
333
334
335   /* Update dup forwarded */
336   olsr_set_dup_forward(originator, seqno);
337
338   /* Update packet data */
339
340
341   msgsize = ntohs(m->v4.olsr_msgsize);
342
343   if(fwdsize)
344     {
345       /*
346        * Check if message is to big to be piggybacked
347        */
348       if((fwdsize + msgsize) > maxmessagesize)
349         {
350           olsr_printf(1, "Forwardbuffer full(%d + %d) - flushing!\n", fwdsize, msgsize);
351
352           /* Send */
353           net_forward();
354
355           /* Buffer message */
356           buffer_forward(m);
357         }
358       else
359         {
360 #ifdef DEBUG
361           olsr_printf(3, "Piggybacking message - buffer: %d msg: %d\n", fwdsize, msgsize);
362 #endif
363           /* piggyback message to outputbuffer */
364           om =  (union olsr_message *)((char*)fwdmsg + fwdsize);
365
366           memcpy(om, m, msgsize);
367           fwdsize += msgsize;
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 #warning CHANGES IN THE apm INTERFACE(0.4.8)!
460
461   if(apm_read(&ainfo) < 1)
462     return WILL_DEFAULT;
463
464   apm_printinfo(&ainfo);
465
466   /* If AC powered */
467   if(ainfo.ac_line_status == OLSR_AC_POWERED)
468     return 6;
469
470   /* If battery powered 
471    *
472    * juice > 78% will: 3
473    * 78% > juice > 26% will: 2
474    * 26% > juice will: 1
475    */
476   return (ainfo.battery_percentage / 26);
477 }
478
479
480
481 /**
482  *Termination function to be called whenever a error occures
483  *that requires the daemon to terminate
484  *
485  *@param msg the message to write to the syslog and possibly stdout
486  */
487
488 void
489 olsr_exit(const char *msg, int val)
490 {
491   olsr_printf(1, "OLSR EXIT: %s\n", msg);
492   syslog(LOG_ERR, "olsrd exit: %s\n", msg);
493   fflush(stdout);
494   exit_value = val;
495
496   raise(SIGTERM);
497 }
498
499
500 /**
501  *Wrapper for malloc(3) that does error-checking
502  *
503  *@param size the number of bytes to allocalte
504  *@param caller a string identifying the caller for
505  *use in error messaging
506  *
507  *@return a void pointer to the memory allocated
508  */
509 void *
510 olsr_malloc(size_t size, const char *id)
511 {
512   void *ptr;
513
514   if((ptr = malloc(size)) == 0) 
515     {
516       olsr_printf(1, "OUT OF MEMORY: %s\n", strerror(errno));
517       syslog(LOG_ERR, "olsrd: out of memory!: %m\n");
518       olsr_exit((char *)id, EXIT_FAILURE);
519     }
520   return ptr;
521 }
522
523
524 /**
525  *Wrapper for printf that prints to a specific
526  *debuglevel upper limit
527  *
528  */
529
530 inline int
531 olsr_printf(int loglevel, char *format, ...)
532 {
533   va_list arglist;
534
535   va_start(arglist, format);
536
537   if(loglevel <= debug_level)
538     {
539       vprintf(format, arglist);
540     }
541
542   va_end(arglist);
543
544   return 0;
545 }