2 * Spanning tree protocol; generic parts
3 * Linux ethernet bridge
6 * Lennert Buytenhek <buytenh@gnu.org>
8 * $Id: br_stp.c,v 1.4 2000/06/19 10:13:35 davem Exp $
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version
13 * 2 of the License, or (at your option) any later version.
15 #include <linux/kernel.h>
16 #include <linux/rculist.h>
18 #include "br_private.h"
19 #include "br_private_stp.h"
21 /* since time values in bpdu are in jiffies and then scaled (1/256)
22 * before sending, make sure that is at least one.
24 #define MESSAGE_AGE_INCR ((HZ < 256) ? 1 : (HZ/256))
26 static const char *br_port_state_names[] = {
27 [BR_STATE_DISABLED] = "disabled",
28 [BR_STATE_LISTENING] = "listening",
29 [BR_STATE_LEARNING] = "learning",
30 [BR_STATE_FORWARDING] = "forwarding",
31 [BR_STATE_BLOCKING] = "blocking",
34 void br_log_state(const struct net_bridge_port *p)
36 pr_info("%s: port %d(%s) entering %s state\n",
37 p->br->dev->name, p->port_no, p->dev->name,
38 br_port_state_names[p->state]);
42 /* called under bridge lock */
43 struct net_bridge_port *br_get_port(struct net_bridge *br, u16 port_no)
45 struct net_bridge_port *p;
47 list_for_each_entry_rcu(p, &br->port_list, list) {
48 if (p->port_no == port_no)
55 /* called under bridge lock */
56 static int br_should_become_root_port(const struct net_bridge_port *p,
59 struct net_bridge *br;
60 struct net_bridge_port *rp;
64 if (p->state == BR_STATE_DISABLED ||
65 br_is_designated_port(p))
68 if (memcmp(&br->bridge_id, &p->designated_root, 8) <= 0)
74 rp = br_get_port(br, root_port);
76 t = memcmp(&p->designated_root, &rp->designated_root, 8);
82 if (p->designated_cost + p->path_cost <
83 rp->designated_cost + rp->path_cost)
85 else if (p->designated_cost + p->path_cost >
86 rp->designated_cost + rp->path_cost)
89 t = memcmp(&p->designated_bridge, &rp->designated_bridge, 8);
95 if (p->designated_port < rp->designated_port)
97 else if (p->designated_port > rp->designated_port)
100 if (p->port_id < rp->port_id)
106 /* called under bridge lock */
107 static void br_root_selection(struct net_bridge *br)
109 struct net_bridge_port *p;
112 list_for_each_entry(p, &br->port_list, list) {
113 if (br_should_become_root_port(p, root_port))
114 root_port = p->port_no;
118 br->root_port = root_port;
121 br->designated_root = br->bridge_id;
122 br->root_path_cost = 0;
124 p = br_get_port(br, root_port);
125 br->designated_root = p->designated_root;
126 br->root_path_cost = p->designated_cost + p->path_cost;
130 /* called under bridge lock */
131 void br_become_root_bridge(struct net_bridge *br)
133 br->max_age = br->bridge_max_age;
134 br->hello_time = br->bridge_hello_time;
135 br->forward_delay = br->bridge_forward_delay;
136 br_topology_change_detection(br);
137 del_timer(&br->tcn_timer);
139 if (br->dev->flags & IFF_UP) {
140 br_config_bpdu_generation(br);
141 mod_timer(&br->hello_timer, jiffies + br->hello_time);
145 /* called under bridge lock */
146 void br_transmit_config(struct net_bridge_port *p)
148 struct br_config_bpdu bpdu;
149 struct net_bridge *br;
152 if (timer_pending(&p->hold_timer)) {
153 p->config_pending = 1;
159 bpdu.topology_change = br->topology_change;
160 bpdu.topology_change_ack = p->topology_change_ack;
161 bpdu.root = br->designated_root;
162 bpdu.root_path_cost = br->root_path_cost;
163 bpdu.bridge_id = br->bridge_id;
164 bpdu.port_id = p->port_id;
165 if (br_is_root_bridge(br))
166 bpdu.message_age = 0;
168 struct net_bridge_port *root
169 = br_get_port(br, br->root_port);
170 bpdu.message_age = br->max_age
171 - (root->message_age_timer.expires - jiffies)
174 bpdu.max_age = br->max_age;
175 bpdu.hello_time = br->hello_time;
176 bpdu.forward_delay = br->forward_delay;
178 if (bpdu.message_age < br->max_age) {
179 br_send_config_bpdu(p, &bpdu);
180 p->topology_change_ack = 0;
181 p->config_pending = 0;
182 mod_timer(&p->hold_timer,
183 round_jiffies(jiffies + BR_HOLD_TIME));
187 /* called under bridge lock */
188 static inline void br_record_config_information(struct net_bridge_port *p,
189 const struct br_config_bpdu *bpdu)
191 p->designated_root = bpdu->root;
192 p->designated_cost = bpdu->root_path_cost;
193 p->designated_bridge = bpdu->bridge_id;
194 p->designated_port = bpdu->port_id;
196 mod_timer(&p->message_age_timer, jiffies
197 + (p->br->max_age - bpdu->message_age));
200 /* called under bridge lock */
201 static inline void br_record_config_timeout_values(struct net_bridge *br,
202 const struct br_config_bpdu *bpdu)
204 br->max_age = bpdu->max_age;
205 br->hello_time = bpdu->hello_time;
206 br->forward_delay = bpdu->forward_delay;
207 br->topology_change = bpdu->topology_change;
210 /* called under bridge lock */
211 void br_transmit_tcn(struct net_bridge *br)
213 br_send_tcn_bpdu(br_get_port(br, br->root_port));
216 /* called under bridge lock */
217 static int br_should_become_designated_port(const struct net_bridge_port *p)
219 struct net_bridge *br;
223 if (br_is_designated_port(p))
226 if (memcmp(&p->designated_root, &br->designated_root, 8))
229 if (br->root_path_cost < p->designated_cost)
231 else if (br->root_path_cost > p->designated_cost)
234 t = memcmp(&br->bridge_id, &p->designated_bridge, 8);
240 if (p->port_id < p->designated_port)
246 /* called under bridge lock */
247 static void br_designated_port_selection(struct net_bridge *br)
249 struct net_bridge_port *p;
251 list_for_each_entry(p, &br->port_list, list) {
252 if (p->state != BR_STATE_DISABLED &&
253 br_should_become_designated_port(p))
254 br_become_designated_port(p);
259 /* called under bridge lock */
260 static int br_supersedes_port_info(struct net_bridge_port *p, struct br_config_bpdu *bpdu)
264 t = memcmp(&bpdu->root, &p->designated_root, 8);
270 if (bpdu->root_path_cost < p->designated_cost)
272 else if (bpdu->root_path_cost > p->designated_cost)
275 t = memcmp(&bpdu->bridge_id, &p->designated_bridge, 8);
281 if (memcmp(&bpdu->bridge_id, &p->br->bridge_id, 8))
284 if (bpdu->port_id <= p->designated_port)
290 /* called under bridge lock */
291 static inline void br_topology_change_acknowledged(struct net_bridge *br)
293 br->topology_change_detected = 0;
294 del_timer(&br->tcn_timer);
297 /* called under bridge lock */
298 void br_topology_change_detection(struct net_bridge *br)
300 int isroot = br_is_root_bridge(br);
302 pr_info("%s: topology change detected, %s\n", br->dev->name,
303 isroot ? "propagating" : "sending tcn bpdu");
306 br->topology_change = 1;
307 mod_timer(&br->topology_change_timer, jiffies
308 + br->bridge_forward_delay + br->bridge_max_age);
309 } else if (!br->topology_change_detected) {
311 mod_timer(&br->tcn_timer, jiffies + br->bridge_hello_time);
314 br->topology_change_detected = 1;
317 /* called under bridge lock */
318 void br_config_bpdu_generation(struct net_bridge *br)
320 struct net_bridge_port *p;
322 list_for_each_entry(p, &br->port_list, list) {
323 if (p->state != BR_STATE_DISABLED &&
324 br_is_designated_port(p))
325 br_transmit_config(p);
329 /* called under bridge lock */
330 static inline void br_reply(struct net_bridge_port *p)
332 br_transmit_config(p);
335 /* called under bridge lock */
336 void br_configuration_update(struct net_bridge *br)
338 br_root_selection(br);
339 br_designated_port_selection(br);
342 /* called under bridge lock */
343 void br_become_designated_port(struct net_bridge_port *p)
345 struct net_bridge *br;
348 p->designated_root = br->designated_root;
349 p->designated_cost = br->root_path_cost;
350 p->designated_bridge = br->bridge_id;
351 p->designated_port = p->port_id;
355 /* called under bridge lock */
356 static void br_make_blocking(struct net_bridge_port *p)
358 if (p->state != BR_STATE_DISABLED &&
359 p->state != BR_STATE_BLOCKING) {
360 if (p->state == BR_STATE_FORWARDING ||
361 p->state == BR_STATE_LEARNING)
362 br_topology_change_detection(p->br);
364 p->state = BR_STATE_BLOCKING;
366 del_timer(&p->forward_delay_timer);
370 /* called under bridge lock */
371 static void br_make_forwarding(struct net_bridge_port *p)
373 if (p->state == BR_STATE_BLOCKING) {
374 if (p->br->stp_enabled == BR_KERNEL_STP)
375 p->state = BR_STATE_LISTENING;
377 p->state = BR_STATE_LEARNING;
380 mod_timer(&p->forward_delay_timer, jiffies + p->br->forward_delay); }
383 /* called under bridge lock */
384 void br_port_state_selection(struct net_bridge *br)
386 struct net_bridge_port *p;
388 /* Don't change port states if userspace is handling STP */
389 if (br->stp_enabled == BR_USER_STP)
392 list_for_each_entry(p, &br->port_list, list) {
393 if (p->state != BR_STATE_DISABLED) {
394 if (p->port_no == br->root_port) {
395 p->config_pending = 0;
396 p->topology_change_ack = 0;
397 br_make_forwarding(p);
398 } else if (br_is_designated_port(p)) {
399 del_timer(&p->message_age_timer);
400 br_make_forwarding(p);
402 p->config_pending = 0;
403 p->topology_change_ack = 0;
411 /* called under bridge lock */
412 static inline void br_topology_change_acknowledge(struct net_bridge_port *p)
414 p->topology_change_ack = 1;
415 br_transmit_config(p);
418 /* called under bridge lock */
419 void br_received_config_bpdu(struct net_bridge_port *p, struct br_config_bpdu *bpdu)
421 struct net_bridge *br;
425 was_root = br_is_root_bridge(br);
427 if (br_supersedes_port_info(p, bpdu)) {
428 br_record_config_information(p, bpdu);
429 br_configuration_update(br);
430 br_port_state_selection(br);
432 if (!br_is_root_bridge(br) && was_root) {
433 del_timer(&br->hello_timer);
434 if (br->topology_change_detected) {
435 del_timer(&br->topology_change_timer);
438 mod_timer(&br->tcn_timer,
439 jiffies + br->bridge_hello_time);
443 if (p->port_no == br->root_port) {
444 br_record_config_timeout_values(br, bpdu);
445 br_config_bpdu_generation(br);
446 if (bpdu->topology_change_ack)
447 br_topology_change_acknowledged(br);
449 } else if (br_is_designated_port(p)) {
454 /* called under bridge lock */
455 void br_received_tcn_bpdu(struct net_bridge_port *p)
457 if (br_is_designated_port(p)) {
458 pr_info("%s: received tcn bpdu on port %i(%s)\n",
459 p->br->dev->name, p->port_no, p->dev->name);
461 br_topology_change_detection(p->br);
462 br_topology_change_acknowledge(p);