2 * Copyright (c) 2008 Nicira Networks.
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20 /* This is an implementation of Spanning Tree Protocol as described in IEEE
21 * 802.1D-1998, clauses 8 and 9. Section numbers refer to this standard. */
30 /* Ethernet address used as the destination for STP frames. */
31 extern const uint8_t stp_eth_addr[6];
33 /* LLC field values used for STP frames. */
34 #define STP_LLC_SSAP 0x42
35 #define STP_LLC_DSAP 0x42
36 #define STP_LLC_CNTL 0x03
38 /* Bridge and port priorities that should be used by default. */
39 #define STP_DEFAULT_BRIDGE_PRIORITY 32768
40 #define STP_DEFAULT_PORT_PRIORITY 128
42 /* Bridge identifier. Top 16 bits are a priority value (numerically lower
43 * values are higher priorities). Bottom 48 bits are MAC address of bridge. */
44 typedef uint64_t stp_identifier;
46 /* Basic STP functionality. */
47 #define STP_MAX_PORTS 255
48 struct stp *stp_create(const char *name, stp_identifier bridge_id,
49 void (*send_bpdu)(struct ofpbuf *bpdu, int port_no,
52 void stp_destroy(struct stp *);
53 void stp_tick(struct stp *, int ms);
54 void stp_set_bridge_id(struct stp *, stp_identifier bridge_id);
55 void stp_set_bridge_priority(struct stp *, uint16_t new_priority);
56 void stp_set_hello_time(struct stp *, int ms);
57 void stp_set_max_age(struct stp *, int ms);
58 void stp_set_forward_delay(struct stp *, int ms);
61 const char *stp_get_name(const struct stp *);
62 stp_identifier stp_get_bridge_id(const struct stp *);
63 stp_identifier stp_get_designated_root(const struct stp *);
64 bool stp_is_root_bridge(const struct stp *);
65 int stp_get_root_path_cost(const struct stp *);
66 int stp_get_hello_time(const struct stp *);
67 int stp_get_max_age(const struct stp *);
68 int stp_get_forward_delay(const struct stp *);
70 /* Obtaining STP ports. */
71 struct stp_port *stp_get_port(struct stp *, int port_no);
72 struct stp_port *stp_get_root_port(struct stp *);
73 bool stp_get_changed_port(struct stp *, struct stp_port **portp);
75 /* State of an STP port.
77 * A port is in exactly one state at any given time, but distinct bits are used
78 * for states to allow testing for more than one state with a bit mask. */
80 STP_DISABLED = 1 << 0, /* 8.4.5: Disabled by management. */
81 STP_LISTENING = 1 << 1, /* 8.4.2: Not learning or relaying frames. */
82 STP_LEARNING = 1 << 2, /* 8.4.3: Learning but not relaying frames. */
83 STP_FORWARDING = 1 << 3, /* 8.4.4: Learning and relaying frames. */
84 STP_BLOCKING = 1 << 4 /* 8.4.1: Initial boot state. */
86 const char *stp_state_name(enum stp_state);
87 bool stp_forward_in_state(enum stp_state);
88 bool stp_learn_in_state(enum stp_state);
90 void stp_received_bpdu(struct stp_port *, const void *bpdu, size_t bpdu_size);
92 struct stp *stp_port_get_stp(struct stp_port *);
93 int stp_port_no(const struct stp_port *);
94 enum stp_state stp_port_get_state(const struct stp_port *);
95 void stp_port_enable(struct stp_port *);
96 void stp_port_disable(struct stp_port *);
97 void stp_port_set_priority(struct stp_port *, uint8_t new_priority);
98 void stp_port_set_path_cost(struct stp_port *, uint16_t path_cost);
99 void stp_port_set_speed(struct stp_port *, unsigned int speed);
100 void stp_port_enable_change_detection(struct stp_port *);
101 void stp_port_disable_change_detection(struct stp_port *);