blob: ad0a3f7cf6cc73081ca600b241060ce5ef867e44 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Spanning tree protocol; generic parts
3 * Linux ethernet bridge
4 *
5 * Authors:
6 * Lennert Buytenhek <buytenh@gnu.org>
7 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
12 */
13#include <linux/kernel.h>
Franck Bui-Huu82524742008-05-12 21:21:05 +020014#include <linux/rculist.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
16#include "br_private.h"
17#include "br_private_stp.h"
18
19/* since time values in bpdu are in jiffies and then scaled (1/256)
20 * before sending, make sure that is at least one.
21 */
22#define MESSAGE_AGE_INCR ((HZ < 256) ? 1 : (HZ/256))
23
Jan Engelhardt36cbd3d2009-08-05 10:42:58 -070024static const char *const br_port_state_names[] = {
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +090025 [BR_STATE_DISABLED] = "disabled",
Linus Torvalds1da177e2005-04-16 15:20:36 -070026 [BR_STATE_LISTENING] = "listening",
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +090027 [BR_STATE_LEARNING] = "learning",
28 [BR_STATE_FORWARDING] = "forwarding",
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 [BR_STATE_BLOCKING] = "blocking",
30};
31
32void br_log_state(const struct net_bridge_port *p)
33{
stephen hemminger28a16c92010-05-10 09:31:09 +000034 br_info(p->br, "port %u(%s) entering %s state\n",
35 (unsigned) p->port_no, p->dev->name,
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 br_port_state_names[p->state]);
Linus Torvalds1da177e2005-04-16 15:20:36 -070037}
38
39/* called under bridge lock */
40struct net_bridge_port *br_get_port(struct net_bridge *br, u16 port_no)
41{
42 struct net_bridge_port *p;
43
44 list_for_each_entry_rcu(p, &br->port_list, list) {
45 if (p->port_no == port_no)
46 return p;
47 }
48
49 return NULL;
50}
51
52/* called under bridge lock */
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +090053static int br_should_become_root_port(const struct net_bridge_port *p,
Linus Torvalds1da177e2005-04-16 15:20:36 -070054 u16 root_port)
55{
56 struct net_bridge *br;
57 struct net_bridge_port *rp;
58 int t;
59
60 br = p->br;
61 if (p->state == BR_STATE_DISABLED ||
62 br_is_designated_port(p))
63 return 0;
64
65 if (memcmp(&br->bridge_id, &p->designated_root, 8) <= 0)
66 return 0;
67
68 if (!root_port)
69 return 1;
70
71 rp = br_get_port(br, root_port);
72
73 t = memcmp(&p->designated_root, &rp->designated_root, 8);
74 if (t < 0)
75 return 1;
76 else if (t > 0)
77 return 0;
78
79 if (p->designated_cost + p->path_cost <
80 rp->designated_cost + rp->path_cost)
81 return 1;
82 else if (p->designated_cost + p->path_cost >
83 rp->designated_cost + rp->path_cost)
84 return 0;
85
86 t = memcmp(&p->designated_bridge, &rp->designated_bridge, 8);
87 if (t < 0)
88 return 1;
89 else if (t > 0)
90 return 0;
91
92 if (p->designated_port < rp->designated_port)
93 return 1;
94 else if (p->designated_port > rp->designated_port)
95 return 0;
96
97 if (p->port_id < rp->port_id)
98 return 1;
99
100 return 0;
101}
102
103/* called under bridge lock */
104static void br_root_selection(struct net_bridge *br)
105{
106 struct net_bridge_port *p;
107 u16 root_port = 0;
108
109 list_for_each_entry(p, &br->port_list, list) {
110 if (br_should_become_root_port(p, root_port))
111 root_port = p->port_no;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 }
113
114 br->root_port = root_port;
115
116 if (!root_port) {
117 br->designated_root = br->bridge_id;
118 br->root_path_cost = 0;
119 } else {
120 p = br_get_port(br, root_port);
121 br->designated_root = p->designated_root;
122 br->root_path_cost = p->designated_cost + p->path_cost;
123 }
124}
125
126/* called under bridge lock */
127void br_become_root_bridge(struct net_bridge *br)
128{
129 br->max_age = br->bridge_max_age;
130 br->hello_time = br->bridge_hello_time;
131 br->forward_delay = br->bridge_forward_delay;
132 br_topology_change_detection(br);
133 del_timer(&br->tcn_timer);
134
135 if (br->dev->flags & IFF_UP) {
136 br_config_bpdu_generation(br);
137 mod_timer(&br->hello_timer, jiffies + br->hello_time);
138 }
139}
140
141/* called under bridge lock */
142void br_transmit_config(struct net_bridge_port *p)
143{
144 struct br_config_bpdu bpdu;
145 struct net_bridge *br;
146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 if (timer_pending(&p->hold_timer)) {
148 p->config_pending = 1;
149 return;
150 }
151
152 br = p->br;
153
154 bpdu.topology_change = br->topology_change;
155 bpdu.topology_change_ack = p->topology_change_ack;
156 bpdu.root = br->designated_root;
157 bpdu.root_path_cost = br->root_path_cost;
158 bpdu.bridge_id = br->bridge_id;
159 bpdu.port_id = p->port_id;
160 if (br_is_root_bridge(br))
161 bpdu.message_age = 0;
162 else {
163 struct net_bridge_port *root
164 = br_get_port(br, br->root_port);
stephen hemminger0c031502011-07-22 07:47:06 +0000165 bpdu.message_age = (jiffies - root->designated_age)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 + MESSAGE_AGE_INCR;
167 }
168 bpdu.max_age = br->max_age;
169 bpdu.hello_time = br->hello_time;
170 bpdu.forward_delay = br->forward_delay;
171
172 if (bpdu.message_age < br->max_age) {
173 br_send_config_bpdu(p, &bpdu);
174 p->topology_change_ack = 0;
175 p->config_pending = 0;
Stephen Hemminger9a834b82007-05-31 01:21:39 -0700176 mod_timer(&p->hold_timer,
177 round_jiffies(jiffies + BR_HOLD_TIME));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 }
179}
180
181/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000182static void br_record_config_information(struct net_bridge_port *p,
183 const struct br_config_bpdu *bpdu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
185 p->designated_root = bpdu->root;
186 p->designated_cost = bpdu->root_path_cost;
187 p->designated_bridge = bpdu->bridge_id;
188 p->designated_port = bpdu->port_id;
stephen hemminger0c031502011-07-22 07:47:06 +0000189 p->designated_age = jiffies + bpdu->message_age;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900191 mod_timer(&p->message_age_timer, jiffies
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 + (p->br->max_age - bpdu->message_age));
193}
194
195/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000196static void br_record_config_timeout_values(struct net_bridge *br,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 const struct br_config_bpdu *bpdu)
198{
199 br->max_age = bpdu->max_age;
200 br->hello_time = bpdu->hello_time;
201 br->forward_delay = bpdu->forward_delay;
202 br->topology_change = bpdu->topology_change;
203}
204
205/* called under bridge lock */
206void br_transmit_tcn(struct net_bridge *br)
207{
208 br_send_tcn_bpdu(br_get_port(br, br->root_port));
209}
210
211/* called under bridge lock */
212static int br_should_become_designated_port(const struct net_bridge_port *p)
213{
214 struct net_bridge *br;
215 int t;
216
217 br = p->br;
218 if (br_is_designated_port(p))
219 return 1;
220
221 if (memcmp(&p->designated_root, &br->designated_root, 8))
222 return 1;
223
224 if (br->root_path_cost < p->designated_cost)
225 return 1;
226 else if (br->root_path_cost > p->designated_cost)
227 return 0;
228
229 t = memcmp(&br->bridge_id, &p->designated_bridge, 8);
230 if (t < 0)
231 return 1;
232 else if (t > 0)
233 return 0;
234
235 if (p->port_id < p->designated_port)
236 return 1;
237
238 return 0;
239}
240
241/* called under bridge lock */
242static void br_designated_port_selection(struct net_bridge *br)
243{
244 struct net_bridge_port *p;
245
246 list_for_each_entry(p, &br->port_list, list) {
247 if (p->state != BR_STATE_DISABLED &&
248 br_should_become_designated_port(p))
249 br_become_designated_port(p);
250
251 }
252}
253
254/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000255static int br_supersedes_port_info(const struct net_bridge_port *p,
256 const struct br_config_bpdu *bpdu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257{
258 int t;
259
260 t = memcmp(&bpdu->root, &p->designated_root, 8);
261 if (t < 0)
262 return 1;
263 else if (t > 0)
264 return 0;
265
266 if (bpdu->root_path_cost < p->designated_cost)
267 return 1;
268 else if (bpdu->root_path_cost > p->designated_cost)
269 return 0;
270
271 t = memcmp(&bpdu->bridge_id, &p->designated_bridge, 8);
272 if (t < 0)
273 return 1;
274 else if (t > 0)
275 return 0;
276
277 if (memcmp(&bpdu->bridge_id, &p->br->bridge_id, 8))
278 return 1;
279
280 if (bpdu->port_id <= p->designated_port)
281 return 1;
282
283 return 0;
284}
285
286/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000287static void br_topology_change_acknowledged(struct net_bridge *br)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288{
289 br->topology_change_detected = 0;
290 del_timer(&br->tcn_timer);
291}
292
293/* called under bridge lock */
294void br_topology_change_detection(struct net_bridge *br)
295{
296 int isroot = br_is_root_bridge(br);
297
Stephen Hemminger4f0611a2009-05-15 06:11:58 +0000298 if (br->stp_enabled != BR_KERNEL_STP)
299 return;
300
stephen hemminger28a16c92010-05-10 09:31:09 +0000301 br_info(br, "topology change detected, %s\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 isroot ? "propagating" : "sending tcn bpdu");
303
304 if (isroot) {
305 br->topology_change = 1;
306 mod_timer(&br->topology_change_timer, jiffies
307 + br->bridge_forward_delay + br->bridge_max_age);
308 } else if (!br->topology_change_detected) {
309 br_transmit_tcn(br);
310 mod_timer(&br->tcn_timer, jiffies + br->bridge_hello_time);
311 }
312
313 br->topology_change_detected = 1;
314}
315
316/* called under bridge lock */
317void br_config_bpdu_generation(struct net_bridge *br)
318{
319 struct net_bridge_port *p;
320
321 list_for_each_entry(p, &br->port_list, list) {
322 if (p->state != BR_STATE_DISABLED &&
323 br_is_designated_port(p))
324 br_transmit_config(p);
325 }
326}
327
328/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000329static void br_reply(struct net_bridge_port *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330{
331 br_transmit_config(p);
332}
333
334/* called under bridge lock */
335void br_configuration_update(struct net_bridge *br)
336{
337 br_root_selection(br);
338 br_designated_port_selection(br);
339}
340
341/* called under bridge lock */
342void br_become_designated_port(struct net_bridge_port *p)
343{
344 struct net_bridge *br;
345
346 br = p->br;
347 p->designated_root = br->designated_root;
348 p->designated_cost = br->root_path_cost;
349 p->designated_bridge = br->bridge_id;
350 p->designated_port = p->port_id;
351}
352
353
354/* called under bridge lock */
355static void br_make_blocking(struct net_bridge_port *p)
356{
357 if (p->state != BR_STATE_DISABLED &&
358 p->state != BR_STATE_BLOCKING) {
359 if (p->state == BR_STATE_FORWARDING ||
360 p->state == BR_STATE_LEARNING)
361 br_topology_change_detection(p->br);
362
363 p->state = BR_STATE_BLOCKING;
364 br_log_state(p);
stephen hemminger4ecb9612011-07-22 07:47:09 +0000365 br_ifinfo_notify(RTM_NEWLINK, p);
366
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 del_timer(&p->forward_delay_timer);
368 }
369}
370
371/* called under bridge lock */
372static void br_make_forwarding(struct net_bridge_port *p)
373{
Stephen Hemmingeref647f12008-08-05 18:42:51 -0700374 struct net_bridge *br = p->br;
Stephen Hemminger9cde0702007-03-21 14:22:44 -0700375
Stephen Hemmingeref647f12008-08-05 18:42:51 -0700376 if (p->state != BR_STATE_BLOCKING)
377 return;
378
stephen hemmingera461c022011-03-10 05:57:04 +0000379 if (br->stp_enabled == BR_NO_STP || br->forward_delay == 0) {
Stephen Hemmingeref647f12008-08-05 18:42:51 -0700380 p->state = BR_STATE_FORWARDING;
381 br_topology_change_detection(br);
382 del_timer(&p->forward_delay_timer);
stephen hemminger160d73b2011-07-22 07:47:10 +0000383 } else if (br->stp_enabled == BR_KERNEL_STP)
Stephen Hemmingeref647f12008-08-05 18:42:51 -0700384 p->state = BR_STATE_LISTENING;
385 else
386 p->state = BR_STATE_LEARNING;
387
Herbert Xu3fe2d7c2010-02-28 00:49:38 -0800388 br_multicast_enable_port(p);
Stephen Hemmingeref647f12008-08-05 18:42:51 -0700389 br_log_state(p);
stephen hemminger4ecb9612011-07-22 07:47:09 +0000390 br_ifinfo_notify(RTM_NEWLINK, p);
Stephen Hemmingeref647f12008-08-05 18:42:51 -0700391
392 if (br->forward_delay != 0)
393 mod_timer(&p->forward_delay_timer, jiffies + br->forward_delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394}
395
396/* called under bridge lock */
397void br_port_state_selection(struct net_bridge *br)
398{
399 struct net_bridge_port *p;
stephen hemminger1faa4352011-03-07 08:34:06 +0000400 unsigned int liveports = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Stephen Hemminger9cde0702007-03-21 14:22:44 -0700402 /* Don't change port states if userspace is handling STP */
403 if (br->stp_enabled == BR_USER_STP)
404 return;
405
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 list_for_each_entry(p, &br->port_list, list) {
stephen hemminger1faa4352011-03-07 08:34:06 +0000407 if (p->state == BR_STATE_DISABLED)
408 continue;
409
410 if (p->port_no == br->root_port) {
411 p->config_pending = 0;
412 p->topology_change_ack = 0;
413 br_make_forwarding(p);
414 } else if (br_is_designated_port(p)) {
415 del_timer(&p->message_age_timer);
416 br_make_forwarding(p);
417 } else {
418 p->config_pending = 0;
419 p->topology_change_ack = 0;
420 br_make_blocking(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421 }
422
stephen hemminger1faa4352011-03-07 08:34:06 +0000423 if (p->state == BR_STATE_FORWARDING)
424 ++liveports;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 }
stephen hemminger1faa4352011-03-07 08:34:06 +0000426
427 if (liveports == 0)
428 netif_carrier_off(br->dev);
429 else
430 netif_carrier_on(br->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431}
432
433/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000434static void br_topology_change_acknowledge(struct net_bridge_port *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
436 p->topology_change_ack = 1;
437 br_transmit_config(p);
438}
439
440/* called under bridge lock */
stephen hemminger160d73b2011-07-22 07:47:10 +0000441void br_received_config_bpdu(struct net_bridge_port *p,
442 const struct br_config_bpdu *bpdu)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443{
444 struct net_bridge *br;
445 int was_root;
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447 br = p->br;
448 was_root = br_is_root_bridge(br);
449
450 if (br_supersedes_port_info(p, bpdu)) {
451 br_record_config_information(p, bpdu);
452 br_configuration_update(br);
453 br_port_state_selection(br);
454
455 if (!br_is_root_bridge(br) && was_root) {
456 del_timer(&br->hello_timer);
457 if (br->topology_change_detected) {
458 del_timer(&br->topology_change_timer);
459 br_transmit_tcn(br);
460
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900461 mod_timer(&br->tcn_timer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 jiffies + br->bridge_hello_time);
463 }
464 }
465
466 if (p->port_no == br->root_port) {
467 br_record_config_timeout_values(br, bpdu);
468 br_config_bpdu_generation(br);
469 if (bpdu->topology_change_ack)
470 br_topology_change_acknowledged(br);
471 }
YOSHIFUJI Hideaki9d6f2292007-02-09 23:24:35 +0900472 } else if (br_is_designated_port(p)) {
473 br_reply(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 }
475}
476
477/* called under bridge lock */
478void br_received_tcn_bpdu(struct net_bridge_port *p)
479{
480 if (br_is_designated_port(p)) {
stephen hemminger28a16c92010-05-10 09:31:09 +0000481 br_info(p->br, "port %u(%s) received tcn bpdu\n",
482 (unsigned) p->port_no, p->dev->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
484 br_topology_change_detection(p->br);
485 br_topology_change_acknowledge(p);
486 }
487}
stephen hemminger14f98f22011-04-04 14:03:33 +0000488
489/* Change bridge STP parameter */
490int br_set_hello_time(struct net_bridge *br, unsigned long val)
491{
492 unsigned long t = clock_t_to_jiffies(val);
493
494 if (t < BR_MIN_HELLO_TIME || t > BR_MAX_HELLO_TIME)
495 return -ERANGE;
496
497 spin_lock_bh(&br->lock);
498 br->bridge_hello_time = t;
499 if (br_is_root_bridge(br))
500 br->hello_time = br->bridge_hello_time;
501 spin_unlock_bh(&br->lock);
502 return 0;
503}
504
505int br_set_max_age(struct net_bridge *br, unsigned long val)
506{
507 unsigned long t = clock_t_to_jiffies(val);
508
509 if (t < BR_MIN_MAX_AGE || t > BR_MAX_MAX_AGE)
510 return -ERANGE;
511
512 spin_lock_bh(&br->lock);
513 br->bridge_max_age = t;
514 if (br_is_root_bridge(br))
515 br->max_age = br->bridge_max_age;
516 spin_unlock_bh(&br->lock);
517 return 0;
518
519}
520
521int br_set_forward_delay(struct net_bridge *br, unsigned long val)
522{
523 unsigned long t = clock_t_to_jiffies(val);
524
525 if (br->stp_enabled != BR_NO_STP &&
526 (t < BR_MIN_FORWARD_DELAY || t > BR_MAX_FORWARD_DELAY))
527 return -ERANGE;
528
529 spin_lock_bh(&br->lock);
530 br->bridge_forward_delay = t;
531 if (br_is_root_bridge(br))
532 br->forward_delay = br->bridge_forward_delay;
533 spin_unlock_bh(&br->lock);
534 return 0;
535}