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