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