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