cfm: Support high priority CCM broadcasts.
[sliver-openvswitch.git] / lib / cfm.c
index bdd3839..537eeaa 100644 (file)
--- a/lib/cfm.c
+++ b/lib/cfm.c
@@ -71,7 +71,8 @@ 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;
@@ -86,10 +87,17 @@ 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. */
+
+    int fault_override;    /* Manual override of 'fault' status.
+                              Ignored if negative. */
 
     uint32_t seq;          /* The sequence number of our last CCM. */
     uint8_t ccm_interval;  /* The CCM transmission interval. */
     int ccm_interval_ms;   /* 'ccm_interval' in milliseconds. */
+    uint16_t ccm_vlan;     /* Vlan tag of CCM PDUs. */
+    uint8_t ccm_pcp;       /* Priority of CCM PDUs. */
     uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
 
     struct timer tx_timer;    /* Send CCM when expired. */
@@ -112,13 +120,15 @@ 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. */
+    uint32_t seq;        /* Most recently received sequence number. */
 };
 
-static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
+static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
 static struct hmap all_cfms = HMAP_INITIALIZER(&all_cfms);
 
-static void cfm_unixctl_show(struct unixctl_conn *, const char *args,
-                             void *aux);
+static unixctl_cb_func cfm_unixctl_show;
+static unixctl_cb_func cfm_unixctl_set_fault;
 
 static const uint8_t *
 cfm_ccm_addr(const struct cfm *cfm)
@@ -228,8 +238,10 @@ lookup_remote_mp(const struct cfm *cfm, uint64_t mpid)
 void
 cfm_init(void)
 {
-    unixctl_command_register("cfm/show", "[interface]", cfm_unixctl_show,
+    unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
                              NULL);
+    unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
+                             1, 2, cfm_unixctl_set_fault, NULL);
 }
 
 /* Allocates a 'cfm' object called 'name'.  'cfm' should be initialized by
@@ -244,6 +256,8 @@ 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;
+    cfm->fault_override = -1;
     return cfm;
 }
 
@@ -275,6 +289,7 @@ cfm_run(struct cfm *cfm)
     if (timer_expired(&cfm->fault_timer)) {
         long long int interval = cfm_fault_interval(cfm);
         struct remote_mp *rmp, *rmp_next;
+        bool old_cfm_fault = cfm->fault;
 
         cfm->fault = cfm->unexpected_recv;
         cfm->unexpected_recv = false;
@@ -284,6 +299,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) {
@@ -306,6 +322,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;
             }
         }
@@ -314,6 +334,11 @@ cfm_run(struct cfm *cfm)
             cfm->fault = true;
         }
 
+        if (old_cfm_fault != cfm->fault) {
+            VLOG_INFO_RL(&rl, "%s: CFM fault status changed to %s",
+                         cfm->name, cfm->fault ? "true" : "false");
+        }
+
         timer_set_duration(&cfm->fault_timer, interval);
     }
 }
@@ -335,8 +360,14 @@ cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
     struct ccm *ccm;
 
     timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
-    ccm = eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM,
-                      sizeof *ccm);
+    eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
+
+    if (cfm->ccm_vlan || cfm->ccm_pcp) {
+        uint16_t tci = cfm->ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
+        eth_push_vlan(packet, htons(tci));
+    }
+
+    ccm = packet->l3;
     ccm->mdlevel_version = 0;
     ccm->opcode = CCM_OPCODE;
     ccm->tlv_offset = 70;
@@ -349,9 +380,11 @@ cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
     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) {
@@ -384,9 +417,12 @@ 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);
 
+    cfm->ccm_vlan = s->ccm_vlan & VLAN_VID_MASK;
+    cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
     if (cfm->extended && interval_ms != s->interval) {
         interval = 0;
         interval_ms = MIN(s->interval, UINT16_MAX);
@@ -455,8 +491,17 @@ cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
 
         struct remote_mp *rmp;
         uint64_t ccm_mpid;
+        uint32_t ccm_seq;
+        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;
+        }
+        ccm_seq = ntohl(ccm->seq);
 
         if (ccm_interval != cfm->ccm_interval) {
             VLOG_WARN_RL(&rl, "%s: received a CCM with an invalid interval"
@@ -472,25 +517,37 @@ 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 = xzalloc(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));
+            }
+        }
+
+        VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
+                 " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
+                 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
+
         if (rmp) {
-            rmp->recv = true;
-            rmp->rdi = ccm_rdi;
-        } else if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
-            rmp = xmalloc(sizeof *rmp);
+            if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
+                VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
+                             " numbers which indicate possible connectivity"
+                             " problems (previous %"PRIu32") (current %"PRIu32
+                             ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
+            }
+
             rmp->mpid = ccm_mpid;
             rmp->recv = true;
+            rmp->seq = ccm_seq;
             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")"
-                 " (interval %"PRIu8") (RDI %s)", cfm->name, ntohl(ccm->seq),
-                 ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
     }
 }
 
@@ -499,9 +556,22 @@ cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
 bool
 cfm_get_fault(const struct cfm *cfm)
 {
+    if (cfm->fault_override >= 0) {
+        return cfm->fault_override;
+    }
     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' */
@@ -532,10 +602,15 @@ 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,
-                  cfm->fault ? " fault" : "",
+    ds_put_format(ds, "MPID %"PRIu64":%s%s%s%s\n", cfm->mpid,
+                  cfm->extended ? " extended" : "",
+                  cfm_get_fault(cfm) ? " fault" : "",
+                  cfm->fault_override >= 0 ? " fault_override" : "",
                   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));
@@ -548,18 +623,19 @@ 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");
     }
 }
 
 static void
-cfm_unixctl_show(struct unixctl_conn *conn,
-                 const char *args, void *aux OVS_UNUSED)
+cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
+                 void *aux OVS_UNUSED)
 {
     struct ds ds = DS_EMPTY_INITIALIZER;
     const struct cfm *cfm;
 
-    if (strlen(args)) {
-        cfm = cfm_find(args);
+    if (argc > 1) {
+        cfm = cfm_find(argv[1]);
         if (!cfm) {
             unixctl_command_reply(conn, 501, "no such CFM object");
             return;
@@ -574,3 +650,38 @@ cfm_unixctl_show(struct unixctl_conn *conn,
     unixctl_command_reply(conn, 200, ds_cstr(&ds));
     ds_destroy(&ds);
 }
+
+static void
+cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
+                      void *aux OVS_UNUSED)
+{
+    const char *fault_str = argv[argc - 1];
+    int fault_override;
+    struct cfm *cfm;
+
+    if (!strcasecmp("true", fault_str)) {
+        fault_override = 1;
+    } else if (!strcasecmp("false", fault_str)) {
+        fault_override = 0;
+    } else if (!strcasecmp("normal", fault_str)) {
+        fault_override = -1;
+    } else {
+        unixctl_command_reply(conn, 501, "unknown fault string");
+        return;
+    }
+
+    if (argc > 2) {
+        cfm = cfm_find(argv[1]);
+        if (!cfm) {
+            unixctl_command_reply(conn, 501, "no such CFM object");
+            return;
+        }
+        cfm->fault_override = fault_override;
+    } else {
+        HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
+            cfm->fault_override = fault_override;
+        }
+    }
+
+    unixctl_command_reply(conn, 200, "OK");
+}