Remember sockaddrs of listening sockets, use appropriate one when sending
[tinc] / src / graph.c
1 /*
2     graph.c -- graph algorithms
3     Copyright (C) 2001-2002 Guus Sliepen <guus@sliepen.warande.net>,
4                   2001-2002 Ivo Timmermans <itimmermans@bigfoot.com>
5
6     This program is free software; you can redistribute it and/or modify
7     it under the terms of the GNU General Public License as published by
8     the Free Software Foundation; either version 2 of the License, or
9     (at your option) any later version.
10
11     This program is distributed in the hope that it will be useful,
12     but WITHOUT ANY WARRANTY; without even the implied warranty of
13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14     GNU General Public License for more details.
15
16     You should have received a copy of the GNU General Public License
17     along with this program; if not, write to the Free Software
18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19
20     $Id: graph.c,v 1.1.2.9 2002/03/12 16:30:15 guus Exp $
21 */
22
23 /* We need to generate two trees from the graph:
24
25    1. A minimum spanning tree for broadcasts,
26    2. A single-source shortest path tree for unicasts.
27
28    Actually, the first one alone would suffice but would make unicast packets
29    take longer routes than necessary.
30
31    For the MST algorithm we can choose from Prim's or Kruskal's. I personally
32    favour Kruskal's, because we make an extra AVL tree of edges sorted on
33    weights (metric). That tree only has to be updated when an edge is added or
34    removed, and during the MST algorithm we just have go linearly through that
35    tree, adding safe edges until #edges = #nodes - 1. The implementation here
36    however is not so fast, because I tried to avoid having to make a forest and
37    merge trees.
38
39    For the SSSP algorithm Dijkstra's seems to be a nice choice. Currently a
40    simple breadth-first search is presented here.
41
42    The SSSP algorithm will also be used to determine whether nodes are directly,
43    indirectly or not reachable from the source. It will also set the correct
44    destination address and port of a node if possible.
45 */
46
47 #include <syslog.h>
48 #include "config.h"
49 #include <string.h>
50 #if defined(HAVE_FREEBSD) || defined(HAVE_OPENBSD)
51  #include <sys/param.h>
52 #endif
53 #include <netinet/in.h>
54
55 #include <avl_tree.h>
56 #include <utils.h>
57
58 #include "netutl.h"
59 #include "node.h"
60 #include "edge.h"
61 #include "connection.h"
62
63 #include "system.h"
64
65 /* Implementation of Kruskal's algorithm.
66    Running time: O(EN)
67    Please note that sorting on weight is already done by add_edge().
68 */
69
70 void mst_kruskal(void)
71 {
72   avl_node_t *node, *next;
73   edge_t *e;
74   node_t *n;
75   connection_t *c;
76   int nodes = 0;
77   int safe_edges = 0;
78   int skipped;
79
80   /* Clear MST status on connections */
81
82   for(node = connection_tree->head; node; node = node->next)
83     {
84       c = (connection_t *)node->data;
85       c->status.mst = 0;
86     }
87
88   /* Do we have something to do at all? */
89   
90   if(!edge_weight_tree->head)
91     return;
92
93   if(debug_lvl >= DEBUG_SCARY_THINGS)
94     syslog(LOG_DEBUG, "Running Kruskal's algorithm:");
95
96   /* Clear visited status on nodes */
97
98   for(node = node_tree->head; node; node = node->next)
99     {
100       n = (node_t *)node->data;
101       n->status.visited = 0;
102       nodes++;
103     }
104
105   /* Starting point */
106   
107   ((edge_t *)edge_weight_tree->head->data)->from.node->status.visited = 1;
108
109   /* Add safe edges */
110
111   for(skipped = 0, node = edge_weight_tree->head; node; node = next)
112     {
113       next = node->next;
114       e = (edge_t *)node->data;
115
116       if(e->from.node->status.visited == e->to.node->status.visited)
117         {
118           skipped = 1;
119           continue;
120         }
121
122       e->from.node->status.visited = 1;
123       e->to.node->status.visited = 1;
124       if(e->connection)
125         e->connection->status.mst = 1;
126
127       safe_edges++;
128
129       if(debug_lvl >= DEBUG_SCARY_THINGS)
130         syslog(LOG_DEBUG, " Adding edge %s - %s weight %d", e->from.node->name, e->to.node->name, e->weight);
131
132       if(skipped)
133         {
134           next = edge_weight_tree->head;
135           continue;
136         }
137     }
138
139   if(debug_lvl >= DEBUG_SCARY_THINGS)
140     syslog(LOG_DEBUG, "Done, counted %d nodes and %d safe edges.", nodes, safe_edges);
141 }
142
143 /* Implementation of a simple breadth-first search algorithm.
144    Running time: O(E)
145 */
146
147 void sssp_bfs(void)
148 {
149   avl_node_t *node, *from, *next, *to;
150   edge_t *e;
151   node_t *n;
152   halfconnection_t to_hc, from_hc;
153   avl_tree_t *todo_tree;
154
155   todo_tree = avl_alloc_tree(NULL, NULL);
156
157   /* Clear visited status on nodes */
158
159   for(node = node_tree->head; node; node = node->next)
160     {
161       n = (node_t *)node->data;
162       n->status.visited = 0;
163     }
164
165   /* Begin with myself */
166
167   myself->status.visited = 1;
168   myself->nexthop = myself;
169   myself->via = myself;
170   node = avl_alloc_node();
171   node->data = myself;
172   avl_insert_top(todo_tree, node);
173
174   /* Loop while todo_tree is filled */
175
176   while(todo_tree->head)
177     {
178       for(from = todo_tree->head; from; from = next)             /* "from" is the node from which we start */
179         {
180           next = from->next;
181           n = (node_t *)from->data;
182
183           for(to = n->edge_tree->head; to; to = to->next)        /* "to" is the edge connected to "from" */
184             {
185               e = (edge_t *)to->data;
186
187               if(e->from.node == n)                              /* "from_hc" is the halfconnection with .node == from */
188                 to_hc = e->to, from_hc = e->from;
189               else
190                 to_hc = e->from, from_hc = e->to;
191
192               if(!to_hc.node->status.visited)
193                 {
194                   to_hc.node->status.visited = 1;
195                   to_hc.node->nexthop = (n->nexthop == myself) ? to_hc.node : n->nexthop;
196                   to_hc.node->via = (e->options & OPTION_INDIRECT || n->via != n) ? n->via : to_hc.node;
197                   to_hc.node->options = e->options;
198                   if(sockaddrcmp(&to_hc.node->address, &to_hc.udpaddress))
199                   {
200                     node = avl_unlink(node_udp_tree, to_hc.node);
201                     to_hc.node->address = to_hc.udpaddress;
202                     if(to_hc.node->hostname)
203                       free(to_hc.node->hostname);
204                     to_hc.node->hostname = sockaddr2hostname(&to_hc.udpaddress);
205                     avl_insert_node(node_udp_tree, node);
206                   }
207                   node = avl_alloc_node();
208                   node->data = to_hc.node;
209                   avl_insert_before(todo_tree, from, node);
210                 }
211             }
212
213           avl_delete_node(todo_tree, from);
214         }
215     }
216
217   avl_free_tree(todo_tree);
218   
219   /* Check reachability status. */
220
221   for(node = node_tree->head; node; node = next)
222     {
223       next = node->next;
224       n = (node_t *)node->data;
225
226       if(n->status.visited)
227       {
228         if(!n->status.reachable)
229         {
230           if(debug_lvl >= DEBUG_TRAFFIC)
231             syslog(LOG_DEBUG, _("Node %s (%s) became reachable"), n->name, n->hostname);
232           n->status.reachable = 1;
233         }
234       }
235       else
236       {
237         if(n->status.reachable)
238         {
239           if(debug_lvl >= DEBUG_TRAFFIC)
240             syslog(LOG_DEBUG, _("Node %s (%s) became unreachable"), n->name, n->hostname);
241           n->status.reachable = 0;
242           n->status.validkey = 0;
243           n->status.waitingforkey = 0;
244           n->sent_seqno = 0;
245         }
246       }
247     }
248 }
249
250 void graph(void)
251 {
252   mst_kruskal();
253   sssp_bfs();
254 }