Routing table creation based on LQ compiles. Not tested at all.
[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.18 2004/11/07 17:51:20 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       olsr_calculate_mpr();
172       olsr_calculate_routing_table();
173 #else
174       olsr_calculate_lq_mpr();
175       olsr_calculate_lq_routing_table();
176 #endif
177       olsr_calculate_hna_routes();
178
179       goto process_pcf;  
180     }
181   
182   if(changes_topology)
183     {
184       /* calculate the routing table and HNA */
185 #if !defined USE_LINK_QUALITY
186       olsr_calculate_routing_table();
187 #else
188       olsr_calculate_lq_routing_table();
189 #endif
190       olsr_calculate_hna_routes();
191
192       goto process_pcf;  
193     }
194
195   if(changes_hna)
196     {
197       /* Update HNA routes */
198       olsr_calculate_hna_routes();
199
200       goto process_pcf;
201     }
202   
203  process_pcf:
204
205   for(tmp_pc_list = pcf_list; 
206       tmp_pc_list != NULL;
207       tmp_pc_list = tmp_pc_list->next)
208     {
209       tmp_pc_list->function(changes_neighborhood,
210                             changes_topology,
211                             changes_hna);
212     }
213
214   changes_neighborhood = OLSR_FALSE;
215   changes_topology = OLSR_FALSE;
216   changes_hna = OLSR_FALSE;
217
218
219   return;
220 }
221
222
223
224
225
226 /**
227  *Initialize all the tables used(neighbor,
228  *topology, MID,  HNA, MPR, dup).
229  *Also initalizes other variables
230  */
231 void
232 olsr_init_tables()
233 {
234   
235   changes_topology = OLSR_FALSE;
236   changes_neighborhood = OLSR_FALSE;
237   changes_hna = OLSR_FALSE;
238
239   /* Initialize link set */
240   olsr_init_link_set();
241
242   /* Initialize duplicate table */
243   olsr_init_duplicate_table();
244
245   /* Initialize neighbor table */
246   olsr_init_neighbor_table();
247
248   /* Initialize routing table */
249   olsr_init_routing_table();
250
251   /* Initialize two hop table */
252   olsr_init_two_hop_table();
253
254   /* Initialize old route table */
255   olsr_init_old_table();
256
257   /* Initialize topology */
258   olsr_init_tc();
259
260   /* Initialize mpr selector table */
261   olsr_init_mprs_set();
262
263   /* Initialize MID set */
264   olsr_init_mid_set();
265
266   /* Initialize HNA set */
267   olsr_init_hna_set();
268
269   /* Initialize ProcessChanges list */
270   ptf_list = NULL;
271   
272 }
273
274
275
276
277
278
279 /**
280  *Check if a message is to be forwarded and forward
281  *it if necessary.
282  *
283  *@param m the OLSR message recieved
284  *@param originator the originator of this message
285  *@param seqno the seqno of the message
286  *
287  *@returns positive if forwarded
288  */
289 int
290 olsr_forward_message(union olsr_message *m, 
291                      union olsr_ip_addr *originator, 
292                      olsr_u16_t seqno,
293                      struct interface *in_if, 
294                      union olsr_ip_addr *from_addr)
295 {
296   union olsr_ip_addr *src;
297   struct neighbor_entry *neighbor;
298   int msgsize;
299   struct interface *ifn;
300
301
302   if(!olsr_check_dup_table_fwd(originator, seqno, &in_if->ip_addr))
303     {
304 #ifdef DEBUG
305       olsr_printf(3, "Message already forwarded!\n");
306 #endif
307       return 0;
308     }
309
310   /* Lookup sender address */
311   if(!(src = mid_lookup_main_addr(from_addr)))
312     src = from_addr;
313
314
315   if(NULL == (neighbor=olsr_lookup_neighbor_table(src)))
316     return 0;
317
318   if(neighbor->status != SYM)
319     return 0;
320
321   /* Update duplicate table interface */
322   olsr_update_dup_entry(originator, seqno, &in_if->ip_addr);
323
324   
325   /* Check MPR */
326   if(olsr_lookup_mprs_set(src) == NULL)
327     {
328 #ifdef DEBUG
329       olsr_printf(5, "Forward - sender %s not MPR selector\n", olsr_ip_to_string(src));
330 #endif
331       return 0;
332     }
333
334
335   /* Treat TTL hopcnt */
336   if(olsr_cnf->ip_version == AF_INET)
337     {
338       /* IPv4 */
339       m->v4.hopcnt++;
340       m->v4.ttl--; 
341     }
342   else
343     {
344       /* IPv6 */
345       m->v6.hopcnt++;
346       m->v6.ttl--; 
347     }
348
349
350
351   /* Update dup forwarded */
352   olsr_set_dup_forward(originator, seqno);
353
354   /* Update packet data */
355
356
357   msgsize = ntohs(m->v4.olsr_msgsize);
358
359   /* looping trough interfaces */
360   for (ifn = ifnet; ifn ; ifn = ifn->int_next) 
361     { 
362       if(net_output_pending(ifn))
363         {
364           /*
365            * Check if message is to big to be piggybacked
366            */
367           if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
368             {
369               /* Send */
370               net_output(ifn);
371               /* Buffer message */
372               set_buffer_timer(ifn);
373               
374               if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
375                 {
376                   olsr_printf(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
377                   olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
378                 }
379
380             }
381         }
382       
383       else
384         {
385           /* No forwarding pending */
386           set_buffer_timer(ifn);
387           
388           if(net_outbuffer_push(ifn, (olsr_u8_t *)m, msgsize) != msgsize)
389             {
390               olsr_printf(1, "Received message to big to be forwarded in %s(%d bytes)!", ifn->int_name, msgsize);
391               olsr_syslog(OLSR_LOG_ERR, "Received message to big to be forwarded on %s(%d bytes)!", ifn->int_name, msgsize);
392             }
393         }
394     }
395
396   return 1;
397
398 }
399
400
401 void
402 set_buffer_timer(struct interface *ifn)
403 {
404   float jitter;
405   struct timeval jittertimer;
406       
407   /* Set timer */
408   jitter = (float) random()/RAND_MAX;
409   jitter *= max_jitter;
410
411   olsr_init_timer((olsr_u32_t) (jitter*1000), &jittertimer);
412
413   timeradd(&now, &jittertimer, &fwdtimer[ifn->if_nr]);
414
415 }
416
417
418
419 void
420 olsr_init_willingness()
421 {
422   if(olsr_cnf->willingness_auto)
423     olsr_register_scheduler_event(&olsr_update_willingness, NULL, will_int, will_int, NULL);
424 }
425
426 void
427 olsr_update_willingness(void *foo)
428 {
429   int tmp_will;
430
431   tmp_will = olsr_cnf->willingness;
432
433   /* Re-calculate willingness */
434   olsr_cnf->willingness = olsr_calculate_willingness();
435
436   if(tmp_will != olsr_cnf->willingness)
437     {
438       olsr_printf(1, "Local willingness updated: old %d new %d\n", tmp_will, olsr_cnf->willingness);
439     }
440 }
441
442
443 /**
444  *Calculate this nodes willingness to act as a MPR
445  *based on either a fixed value or the power status
446  *of the node using APM
447  *
448  *@return a 8bit value from 0-7 representing the willingness
449  */
450
451 olsr_u8_t
452 olsr_calculate_willingness()
453 {
454   struct olsr_apm_info ainfo;
455
456   /* If fixed willingness */
457   if(!olsr_cnf->willingness_auto)
458     return olsr_cnf->willingness;
459
460 #warning CHANGES IN THE apm INTERFACE(0.4.8)!
461
462   if(apm_read(&ainfo) < 1)
463     return WILL_DEFAULT;
464
465   apm_printinfo(&ainfo);
466
467   /* If AC powered */
468   if(ainfo.ac_line_status == OLSR_AC_POWERED)
469     return 6;
470
471   /* If battery powered 
472    *
473    * juice > 78% will: 3
474    * 78% > juice > 26% will: 2
475    * 26% > juice will: 1
476    */
477   return (ainfo.battery_percentage / 26);
478 }
479
480
481
482 /**
483  *Termination function to be called whenever a error occures
484  *that requires the daemon to terminate
485  *
486  *@param msg the message to write to the syslog and possibly stdout
487  */
488
489 void
490 olsr_exit(const char *msg, int val)
491 {
492   olsr_printf(1, "OLSR EXIT: %s\n", msg);
493   olsr_syslog(OLSR_LOG_ERR, "olsrd exit: %s\n", msg);
494   fflush(stdout);
495   exit_value = val;
496
497   raise(SIGTERM);
498 }
499
500
501 /**
502  *Wrapper for malloc(3) that does error-checking
503  *
504  *@param size the number of bytes to allocalte
505  *@param caller a string identifying the caller for
506  *use in error messaging
507  *
508  *@return a void pointer to the memory allocated
509  */
510 void *
511 olsr_malloc(size_t size, const char *id)
512 {
513   void *ptr;
514
515   if((ptr = malloc(size)) == 0) 
516     {
517       olsr_printf(1, "OUT OF MEMORY: %s\n", strerror(errno));
518       olsr_syslog(OLSR_LOG_ERR, "olsrd: out of memory!: %m\n");
519       olsr_exit((char *)id, EXIT_FAILURE);
520     }
521   return ptr;
522 }
523
524
525 /**
526  *Wrapper for printf that prints to a specific
527  *debuglevel upper limit
528  *
529  */
530
531 inline int
532 olsr_printf(int loglevel, char *format, ...)
533 {
534   va_list arglist;
535
536   va_start(arglist, format);
537
538   if(loglevel <= olsr_cnf->debug_level)
539     {
540       vprintf(format, arglist);
541     }
542
543   va_end(arglist);
544
545   return 0;
546 }