Added checks for NULL returned from get_best_link_to_neighbor in the LQ code
[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  * $Id: lq_mpr.c,v 1.10 2005/11/29 18:37:58 kattemat Exp $
40  */
41
42 #include "defs.h"
43 #include "neighbor_table.h"
44 #include "two_hop_neighbor_table.h"
45 #include "link_set.h"
46 #include "lq_mpr.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   double best;
55   olsr_bool mpr_changes = OLSR_FALSE;
56   struct link_entry *link;
57
58   for(i = 0; i < HASHSIZE; i++)
59     {
60       for (neigh = neighbortable[i].next;
61            neigh != &neighbortable[i];
62            neigh = neigh->next)
63         { 
64           // memorize previous MPR status
65
66           neigh->was_mpr = neigh->is_mpr;
67
68           // clear current MPR status
69
70           neigh->is_mpr = OLSR_FALSE;
71
72           // in this pass we are only interested in WILL_ALWAYS neighbours
73
74           if(neigh->status == NOT_SYM ||
75              neigh->willingness != WILL_ALWAYS)
76             continue;
77
78           neigh->is_mpr = OLSR_TRUE;
79
80           if (neigh->is_mpr != neigh->was_mpr)
81             mpr_changes = OLSR_TRUE;
82         }
83     }
84
85   for(i = 0; i < HASHSIZE; i++)
86     {
87       // loop through all 2-hop neighbours
88
89       for (neigh2 = two_hop_neighbortable[i].next;
90            neigh2 != &two_hop_neighbortable[i];
91            neigh2 = neigh2->next)
92         {
93           // check whether this 2-hop neighbour is also a neighbour
94
95           neigh = olsr_lookup_neighbor_table(&neigh2->neighbor_2_addr);
96
97           // if it's a neighbour and also symmetric, then examine
98           // the link quality
99           
100           if (neigh != NULL && neigh->status == SYM)
101             {
102               // if the direct link is better than the best route via
103               // an MPR, then prefer the direct link and do not select
104               // an MPR for this 2-hop neighbour
105
106               // determine the link quality of the direct link
107
108               link = get_best_link_to_neighbor(&neigh->neighbor_main_addr);
109
110               if(!link)
111                 continue;
112
113               best = link->loss_link_quality * link->neigh_link_quality;
114
115               // see wether we find a better route via an MPR
116
117               for (walker = neigh2->neighbor_2_nblist.next;
118                    walker != &neigh2->neighbor_2_nblist;
119                    walker = walker->next)
120                 if (walker->path_link_quality > best)
121                   break;
122
123               // we've reached the end of the list, so we haven't found
124               // a better route via an MPR - so, skip MPR selection for
125               // this 1-hop neighbor
126
127               if (walker == &neigh2->neighbor_2_nblist)
128                 continue;
129             }
130
131           // find the connecting 1-hop neighbours with the
132           // best total link qualities
133
134           // mark all 1-hop neighbours as not selected
135
136           for (walker = neigh2->neighbor_2_nblist.next;
137                walker != &neigh2->neighbor_2_nblist;
138                walker = walker->next)
139             walker->neighbor->skip = OLSR_FALSE;
140
141           for (k = 0; k < olsr_cnf->mpr_coverage; k++)
142             {
143               // look for the best 1-hop neighbour that we haven't
144               // yet selected
145
146               neigh = NULL;
147               best = -1.0;
148
149               for (walker = neigh2->neighbor_2_nblist.next;
150                    walker != &neigh2->neighbor_2_nblist;
151                    walker = walker->next)
152                 if (walker->neighbor->status == SYM &&
153                     !walker->neighbor->skip &&
154                     walker->path_link_quality > best)
155                   {
156                     neigh = walker->neighbor;
157                     best = walker->path_link_quality;
158                   }
159
160               if (neigh != NULL)
161                 {
162                   neigh->is_mpr = OLSR_TRUE;
163                   neigh->skip = OLSR_TRUE;
164           
165                   if (neigh->is_mpr != neigh->was_mpr)
166                     mpr_changes = OLSR_TRUE;
167                 }
168
169               // no neighbour found => the requested MPR coverage cannot
170               // be satisfied => stop
171
172               else
173                 break;
174             }
175         }
176     }
177
178   if (mpr_changes && olsr_cnf->tc_redundancy > 0)
179     changes = OLSR_TRUE;
180 }