From Sven-Ola Tuecke <sven-ola@gmx.de>: add support for fixedpoint math
[olsrd.git] / src / lq_mpr.c
1 /*
2  * The olsr.org Optimized Link-State Routing daemon(olsrd)
3  * Copyright (c) 2004, Thomas Lopatic (thomas@lopatic.de)
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without 
7  * modification, are permitted provided that the following conditions 
8  * are met:
9  *
10  * * Redistributions of source code must retain the above copyright 
11  *   notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright 
13  *   notice, this list of conditions and the following disclaimer in 
14  *   the documentation and/or other materials provided with the 
15  *   distribution.
16  * * Neither the name of olsr.org, olsrd nor the names of its 
17  *   contributors may be used to endorse or promote products derived 
18  *   from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
24  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN 
30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
31  * POSSIBILITY OF SUCH DAMAGE.
32  *
33  * Visit http://www.olsr.org for more information.
34  *
35  * If you find this software useful feel free to make a donation
36  * to the project. For more information see the website or contact
37  * the copyright holders.
38  *
39  */
40
41 #include "defs.h"
42 #include "neighbor_table.h"
43 #include "two_hop_neighbor_table.h"
44 #include "link_set.h"
45 #include "lq_mpr.h"
46 #include "scheduler.h"
47
48 void olsr_calculate_lq_mpr(void)
49 {
50   struct neighbor_2_entry *neigh2;
51   struct neighbor_list_entry *walker;
52   int i, k;
53   struct neighbor_entry *neigh;
54 #ifdef USE_FPM
55   fpm best, best_1hop;
56 #else
57   double best, best_1hop;
58 #endif
59   olsr_bool mpr_changes = OLSR_FALSE;
60
61   for(i = 0; i < HASHSIZE; i++)
62     {
63       for (neigh = neighbortable[i].next;
64            neigh != &neighbortable[i];
65            neigh = neigh->next)
66         { 
67           // memorize previous MPR status
68
69           neigh->was_mpr = neigh->is_mpr;
70
71           // clear current MPR status
72
73           neigh->is_mpr = OLSR_FALSE;
74
75           // in this pass we are only interested in WILL_ALWAYS neighbours
76
77           if(neigh->status == NOT_SYM ||
78              neigh->willingness != WILL_ALWAYS)
79             continue;
80
81           neigh->is_mpr = OLSR_TRUE;
82
83           if (neigh->is_mpr != neigh->was_mpr)
84             mpr_changes = OLSR_TRUE;
85         }
86     }
87
88   for(i = 0; i < HASHSIZE; i++)
89     {
90       // loop through all 2-hop neighbours
91
92       for (neigh2 = two_hop_neighbortable[i].next;
93            neigh2 != &two_hop_neighbortable[i];
94            neigh2 = neigh2->next)
95         {
96 #ifdef USE_FPM
97           best_1hop = itofpm(-1);
98 #else
99           best_1hop = -1.0;
100 #endif
101
102           // check whether this 2-hop neighbour is also a neighbour
103
104           neigh = olsr_lookup_neighbor_table(&neigh2->neighbor_2_addr);
105
106           // if it's a neighbour and also symmetric, then examine
107           // the link quality
108           
109           if (neigh != NULL && neigh->status == SYM)
110             {
111               // if the direct link is better than the best route via
112               // an MPR, then prefer the direct link and do not select
113               // an MPR for this 2-hop neighbour
114
115               // determine the link quality of the direct link
116
117               struct link_entry *lnk = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
118
119               if (!lnk)
120                 continue;
121
122 #ifdef USE_FPM
123               best_1hop = fpmmul(lnk->loss_link_quality, lnk->neigh_link_quality);
124 #else
125               best_1hop = lnk->loss_link_quality * lnk->neigh_link_quality;
126 #endif
127
128               // see wether we find a better route via an MPR
129
130               for (walker = neigh2->neighbor_2_nblist.next;
131                    walker != &neigh2->neighbor_2_nblist;
132                    walker = walker->next)
133                 if (walker->path_link_quality > best_1hop)
134                   break;
135
136               // we've reached the end of the list, so we haven't found
137               // a better route via an MPR - so, skip MPR selection for
138               // this 1-hop neighbor
139
140               if (walker == &neigh2->neighbor_2_nblist)
141                 continue;
142             }
143
144           // find the connecting 1-hop neighbours with the
145           // best total link qualities
146
147           // mark all 1-hop neighbours as not selected
148
149           for (walker = neigh2->neighbor_2_nblist.next;
150                walker != &neigh2->neighbor_2_nblist;
151                walker = walker->next)
152             walker->neighbor->skip = OLSR_FALSE;
153
154           for (k = 0; k < olsr_cnf->mpr_coverage; k++)
155             {
156               // look for the best 1-hop neighbour that we haven't
157               // yet selected
158
159               neigh = NULL;
160 #ifdef USE_FPM
161               best = itofpm(-1);
162 #else
163               best = -1.0;
164 #endif
165
166               for (walker = neigh2->neighbor_2_nblist.next;
167                    walker != &neigh2->neighbor_2_nblist;
168                    walker = walker->next)
169                 if (walker->neighbor->status == SYM &&
170                     !walker->neighbor->skip &&
171                     walker->path_link_quality > best)
172                   {
173                     neigh = walker->neighbor;
174                     best = walker->path_link_quality;
175                   }
176
177               // Found a 1-hop neighbor that we haven't previously selected.
178               // Use it as MPR only when the 2-hop path through it is better than
179               // any existing 1-hop path.
180               if ((neigh != NULL) && (best > best_1hop))
181                 {
182                   neigh->is_mpr = OLSR_TRUE;
183                   neigh->skip = OLSR_TRUE;
184           
185                   if (neigh->is_mpr != neigh->was_mpr)
186                     mpr_changes = OLSR_TRUE;
187                 }
188
189               // no neighbour found => the requested MPR coverage cannot
190               // be satisfied => stop
191
192               else
193                 break;
194             }
195         }
196     }
197
198   if (mpr_changes && olsr_cnf->tc_redundancy > 0)
199     signal_link_changes(OLSR_TRUE);
200 }