- More s/vertex/edge/g
[tinc] / src / graph.c
1 /*
2     graph.c -- graph algorithms
3     Copyright (C) 2001 Guus Sliepen <guus@sliepen.warande.net>,
4                   2001 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.1 2001/10/28 10:16:18 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.
36
37    For the SSSP algorithm Dijkstra's seems to be a nice choice.
38 */
39
40 #include <syslog.h>
41 #include "config.h"
42
43 #include "node.h"
44 #include "edge.h"
45 #include "connection.h"
46
47 #include "system.h"
48
49 /* Implementation of Kruskal's algorithm.
50    Running time: O(V)
51    Please note that sorting on weight is already done by add_vertex().
52 */
53
54 void kruskal(void)
55 {
56   avl_node_t *node;
57   edge_t *e;
58   node_t *n;
59   connection_t *c;
60   int nodes;
61   int safe_edges = 0;
62   
63   syslog(LOG_DEBUG, _("Running Kruskal's algorithm:"));
64
65   /* Clear MST status on nodes */
66
67   for(node = node_tree->head; node; node = node->next)
68     {
69       n = (node_t *)node->data;
70       n->status.mst = 0;
71       node++;
72     }
73
74   /* Clear MST status on connections */
75
76   for(node = connection_tree->head; node; node = node->next)
77     {
78       c = (edge_t *)node->data;
79       c->status.mst = 0;
80     }
81
82   /* Add safe edges */
83
84   for(node = edge_weight_tree->head; node; node = node->next)
85     {
86 // Algorithm should work without this:
87 //      if(safe_edges = nodes - 1)
88 //        break;
89
90       e = (edge_t *)node->data;
91       
92       if(e->from->status.mst && e->to->status.mst)
93         continue;
94
95       e->from->status.mst = 1;
96       e->to->status.mst = 1;
97       if(e->connection)
98         e->connection->status.mst = 1;
99
100       safe_edges++;      
101
102       syslog(LOG_DEBUG, _("Adding safe edge %s - %s weight %d"), e->from->name, e->to->name, e->weight);
103     }
104
105   syslog(LOG_DEBUG, _("Done."));
106
107   if(safe_edges != nodes - 1)
108     {
109       syslog(LOG_ERR, _("Implementation of Kruskal's algorithm is screwed: %d nodes, found %d safe edges"), nodes, safe_edges);
110     }
111 }