X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fstp.h;h=c0175cdbf36752d69c04adb67f005d7065397cb4;hb=HEAD;hp=35c2caa59735cc9cfcdd14e54cfbd1986b84adf5;hpb=34e63086edddcae06d7c1a4fa84fec0861e50758;p=sliver-openvswitch.git

diff --git a/lib/stp.h b/lib/stp.h
index 35c2caa59..c0175cdbf 100644
--- a/lib/stp.h
+++ b/lib/stp.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008 Nicira Networks.
+ * Copyright (c) 2008, 2011 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,9 +27,6 @@
 
 struct ofpbuf;
 
-/* Ethernet address used as the destination for STP frames. */
-extern const uint8_t stp_eth_addr[6];
-
 /* LLC field values used for STP frames. */
 #define STP_LLC_SSAP 0x42
 #define STP_LLC_DSAP 0x42
@@ -39,17 +36,32 @@ extern const uint8_t stp_eth_addr[6];
 #define STP_DEFAULT_BRIDGE_PRIORITY 32768
 #define STP_DEFAULT_PORT_PRIORITY 128
 
+/* Default time values. */
+#define STP_DEFAULT_MAX_AGE    20000
+#define STP_DEFAULT_HELLO_TIME 2000
+#define STP_DEFAULT_FWD_DELAY  15000
+
 /* Bridge identifier.  Top 16 bits are a priority value (numerically lower
  * values are higher priorities).  Bottom 48 bits are MAC address of bridge. */
 typedef uint64_t stp_identifier;
 
+
+#define STP_ID_FMT "%04"PRIx16".%012"PRIx64
+#define STP_ID_ARGS(stp_id) \
+    (uint16_t)((stp_id) >> 48), \
+    (uint64_t)((stp_id) & 0xffffffffffffULL)
+
+#define STP_PORT_ID_FMT "%04"PRIx16
+
 /* Basic STP functionality. */
 #define STP_MAX_PORTS 255
+void stp_init(void);
 struct stp *stp_create(const char *name, stp_identifier bridge_id,
                        void (*send_bpdu)(struct ofpbuf *bpdu, int port_no,
                                          void *aux),
                        void *aux);
-void stp_destroy(struct stp *);
+struct stp *stp_ref(const struct stp *);
+void stp_unref(struct stp *);
 void stp_tick(struct stp *, int ms);
 void stp_set_bridge_id(struct stp *, stp_identifier bridge_id);
 void stp_set_bridge_priority(struct stp *, uint16_t new_priority);
@@ -66,6 +78,7 @@ int stp_get_root_path_cost(const struct stp *);
 int stp_get_hello_time(const struct stp *);
 int stp_get_max_age(const struct stp *);
 int stp_get_forward_delay(const struct stp *);
+bool stp_check_and_reset_fdb_flush(struct stp *);
 
 /* Obtaining STP ports. */
 struct stp_port *stp_get_port(struct stp *, int port_no);
@@ -75,9 +88,30 @@ bool stp_get_changed_port(struct stp *, struct stp_port **portp);
 /* State of an STP port.
  *
  * A port is in exactly one state at any given time, but distinct bits are used
- * for states to allow testing for more than one state with a bit mask. */
+ * for states to allow testing for more than one state with a bit mask.
+ *
+ * The STP_DISABLED state means that the port is disabled by management.
+ * In our implementation, this state means that the port does not
+ * participate in the spanning tree, but it still forwards traffic as if
+ * it were in the STP_FORWARDING state.  This may be different from
+ * other implementations.
+ *
+ * The following diagram describes the various states and what they are
+ * allowed to do in OVS:
+ *
+ *                     FWD  LRN  TX_BPDU RX_BPDU
+ *                     ---  ---  ------- -------
+ *        Disabled      Y    -      -       -
+ *        Blocking      -    -      -       Y
+ *        Listening     -    -      Y       Y
+ *        Learning      -    Y      Y       Y
+ *        Forwarding    Y    Y      Y       Y
+ *
+ * Once again, note that the disabled state forwards traffic, which is
+ * likely different than the spec would indicate.
+ */
 enum stp_state {
-    STP_DISABLED = 1 << 0,       /* 8.4.5: Disabled by management. */
+    STP_DISABLED = 1 << 0,       /* 8.4.5: See note above. */
     STP_LISTENING = 1 << 1,      /* 8.4.2: Not learning or relaying frames. */
     STP_LEARNING = 1 << 2,       /* 8.4.3: Learning but not relaying frames. */
     STP_FORWARDING = 1 << 3,     /* 8.4.4: Learning and relaying frames. */
@@ -86,15 +120,32 @@ enum stp_state {
 const char *stp_state_name(enum stp_state);
 bool stp_forward_in_state(enum stp_state);
 bool stp_learn_in_state(enum stp_state);
+bool stp_listen_in_state(enum stp_state);
+
+/* Role of an STP port. */
+enum stp_role {
+    STP_ROLE_ROOT,               /* Path to root bridge. */
+    STP_ROLE_DESIGNATED,         /* Path to LAN segments. */
+    STP_ROLE_ALTERNATE,          /* Backup path to root bridge. */
+    STP_ROLE_DISABLED            /* Port does not participate in STP. */
+};
+const char *stp_role_name(enum stp_role);
 
 void stp_received_bpdu(struct stp_port *, const void *bpdu, size_t bpdu_size);
 
 struct stp *stp_port_get_stp(struct stp_port *);
+void stp_port_set_aux(struct stp_port *, void *);
+void *stp_port_get_aux(struct stp_port *);
 int stp_port_no(const struct stp_port *);
+int stp_port_get_id(const struct stp_port *);
 enum stp_state stp_port_get_state(const struct stp_port *);
+enum stp_role stp_port_get_role(const struct stp_port *);
+void stp_port_get_counts(const struct stp_port *,
+                         int *tx_count, int *rx_count, int *error_count);
 void stp_port_enable(struct stp_port *);
 void stp_port_disable(struct stp_port *);
 void stp_port_set_priority(struct stp_port *, uint8_t new_priority);
+uint16_t stp_convert_speed_to_cost(unsigned int speed);
 void stp_port_set_path_cost(struct stp_port *, uint16_t path_cost);
 void stp_port_set_speed(struct stp_port *, unsigned int speed);
 void stp_port_enable_change_detection(struct stp_port *);