Fix manpage-check on RHEL 5.
[sliver-openvswitch.git] / lib / cfm.c
index 3f3dcd2..0d79bee 100644 (file)
--- a/lib/cfm.c
+++ b/lib/cfm.c
@@ -49,8 +49,13 @@ static const uint8_t eth_addr_ccm_x[6] = {
 
 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
  * specification.  Continuity Check Messages are broadcast periodically so that
- * hosts can determine whom they have connectivity to. */
-#define CCM_LEN 74
+ * hosts can determine whom they have connectivity to.
+ *
+ * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
+ * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
+ * accept such messages too. */
+#define CCM_LEN 75
+#define CCM_ACCEPT_LEN 74
 #define CCM_MAID_LEN 48
 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
 #define CCM_RDI_MASK 0x80
@@ -66,7 +71,11 @@ struct ccm {
     /* Defined by ITU-T Y.1731 should be zero */
     ovs_be16 interval_ms_x;      /* Transmission interval in ms. */
     ovs_be64 mpid64;             /* MPID in extended mode. */
-    uint8_t  zero[6];
+    uint8_t opdown;              /* Operationally down. */
+    uint8_t  zero[5];
+
+    /* TLV space. */
+    uint8_t end_tlv;
 } __attribute__((packed));
 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
 
@@ -78,6 +87,8 @@ struct cfm {
     bool extended;         /* Extended mode. */
     bool fault;            /* Indicates connectivity fault. */
     bool unexpected_recv;  /* Received an unexpected CCM. */
+    bool opup;             /* Operational State. */
+    bool remote_opup;      /* Remote Operational State. */
 
     uint32_t seq;          /* The sequence number of our last CCM. */
     uint8_t ccm_interval;  /* The CCM transmission interval. */
@@ -104,6 +115,7 @@ struct remote_mp {
     bool recv;           /* CCM was received since last fault check. */
     bool rdi;            /* Remote Defect Indicator. Indicates remote_mp isn't
                             receiving CCMs that it's expecting to. */
+    bool opup;           /* Operational State. */
 };
 
 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
@@ -236,6 +248,7 @@ cfm_create(const char *name)
     hmap_init(&cfm->remote_mps);
     cfm_generate_maid(cfm);
     hmap_insert(&all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
+    cfm->remote_opup = true;
     return cfm;
 }
 
@@ -276,6 +289,7 @@ cfm_run(struct cfm *cfm)
         cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
                                   sizeof *cfm->rmps_array);
 
+        cfm->remote_opup = true;
         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
 
             if (!rmp->recv) {
@@ -298,6 +312,10 @@ cfm_run(struct cfm *cfm)
                     cfm->fault = true;
                 }
 
+                if (!rmp->opup) {
+                    cfm->remote_opup = rmp->opup;
+                }
+
                 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
             }
         }
@@ -336,13 +354,16 @@ cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
     ccm->flags = cfm->ccm_interval;
     memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
     memset(ccm->zero, 0, sizeof ccm->zero);
+    ccm->end_tlv = 0;
 
     if (cfm->extended) {
         ccm->mpid = htons(hash_mpid(cfm->mpid));
         ccm->mpid64 = htonll(cfm->mpid);
+        ccm->opdown = !cfm->opup;
     } else {
         ccm->mpid = htons(cfm->mpid);
         ccm->mpid64 = htonll(0);
+        ccm->opdown = 0;
     }
 
     if (cfm->ccm_interval == 0) {
@@ -375,6 +396,7 @@ cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
 
     cfm->mpid = s->mpid;
     cfm->extended = s->extended;
+    cfm->opup = s->opup;
     interval = ms_to_ccm_interval(s->interval);
     interval_ms = ccm_interval_to_ms(interval);
 
@@ -412,7 +434,7 @@ cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
     struct eth_header *eth;
 
     eth = p->l2;
-    ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_LEN);
+    ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
 
     if (!ccm) {
         VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
@@ -446,8 +468,15 @@ cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
 
         struct remote_mp *rmp;
         uint64_t ccm_mpid;
+        bool ccm_opdown;
 
-        ccm_mpid = cfm->extended ? ntohll(ccm->mpid64) : ntohs(ccm->mpid);
+        if (cfm->extended) {
+            ccm_mpid = ntohll(ccm->mpid64);
+            ccm_opdown = ccm->opdown;
+        } else {
+            ccm_mpid = ntohs(ccm->mpid);
+            ccm_opdown = false;
+        }
 
         if (ccm_interval != cfm->ccm_interval) {
             VLOG_WARN_RL(&rl, "%s: received a CCM with an invalid interval"
@@ -463,20 +492,24 @@ cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
         }
 
         rmp = lookup_remote_mp(cfm, ccm_mpid);
+        if (!rmp) {
+            if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
+                rmp = xmalloc(sizeof *rmp);
+                hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
+            } else {
+                cfm->unexpected_recv = true;
+                VLOG_WARN_RL(&rl,
+                             "%s: dropped CCM with MPID %"PRIu64" from MAC "
+                             ETH_ADDR_FMT, cfm->name, ccm_mpid,
+                             ETH_ADDR_ARGS(eth->eth_src));
+            }
+        }
+
         if (rmp) {
-            rmp->recv = true;
-            rmp->rdi = ccm_rdi;
-        } else if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
-            rmp = xmalloc(sizeof *rmp);
             rmp->mpid = ccm_mpid;
             rmp->recv = true;
             rmp->rdi = ccm_rdi;
-            hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(rmp->mpid));
-        } else {
-            cfm->unexpected_recv = true;
-            VLOG_WARN_RL(&rl, "%s: dropped CCM with MPID %"PRIu64" from MAC "
-                         ETH_ADDR_FMT, cfm->name, ccm_mpid,
-                         ETH_ADDR_ARGS(eth->eth_src));
+            rmp->opup = !ccm_opdown;
         }
 
         VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
@@ -493,6 +526,16 @@ cfm_get_fault(const struct cfm *cfm)
     return cfm->fault;
 }
 
+/* Gets the operational state of 'cfm'.  'cfm' is considered operationally down
+ * if it has received a CCM with the operationally down bit set from any of its
+ * remote maintenance points. Returns true if 'cfm' is operationally up. False
+ * otherwise. */
+bool
+cfm_get_opup(const struct cfm *cfm)
+{
+    return cfm->remote_opup;
+}
+
 /* Populates 'rmps' with an array of remote maintenance points reachable by
  * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
  * 'cfm' retains ownership of the array written to 'rmps' */
@@ -523,10 +566,14 @@ cfm_print_details(struct ds *ds, const struct cfm *cfm)
     struct remote_mp *rmp;
 
     ds_put_format(ds, "---- %s ----\n", cfm->name);
-    ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
+    ds_put_format(ds, "MPID %"PRIu64":%s%s%s\n", cfm->mpid,
+                  cfm->extended ? " extended" : "",
                   cfm->fault ? " fault" : "",
                   cfm->unexpected_recv ? " unexpected_recv" : "");
 
+    ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
+    ds_put_format(ds, "\tremote_opstate: %s\n",
+                  cfm->remote_opup ? "up" : "down");
     ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
     ds_put_format(ds, "\tnext CCM tx: %lldms\n",
                   timer_msecs_until_expired(&cfm->tx_timer));
@@ -539,6 +586,7 @@ cfm_print_details(struct ds *ds, const struct cfm *cfm)
                       rmp->rdi ? " rdi" : "");
         ds_put_format(ds, "\trecv since check: %s\n",
                       rmp->recv ? "true" : "false");
+        ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
     }
 }