lib/cfm.c

   1 /*
   2  * Copyright (c) 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "cfm.h"
  19
  20 #include <assert.h>
  21 #include <stdint.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24
  25 #include "byte-order.h"
  26 #include "dynamic-string.h"
  27 #include "flow.h"
  28 #include "hash.h"
  29 #include "hmap.h"
  30 #include "ofpbuf.h"
  31 #include "packets.h"
  32 #include "poll-loop.h"
  33 #include "random.h"
  34 #include "timer.h"
  35 #include "timeval.h"
  36 #include "unixctl.h"
  37 #include "vlog.h"
  38
  39 VLOG_DEFINE_THIS_MODULE(cfm);
  40
  41 #define CFM_MAX_RMPS 256
  42
  43 /* Ethernet destination address of CCM packets. */
  44 static const uint8_t eth_addr_ccm[6] = { 0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
  45 static const uint8_t eth_addr_ccm_x[6] = {
  46     0x01, 0x23, 0x20, 0x00, 0x00, 0x30
  47 };
  48
  49 #define ETH_TYPE_CFM 0x8902
  50
  51 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
  52  * specification.  Continuity Check Messages are broadcast periodically so that
  53  * hosts can determine whom they have connectivity to.
  54  *
  55  * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
  56  * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
  57  * accept such messages too. */
  58 #define CCM_LEN 75
  59 #define CCM_ACCEPT_LEN 74
  60 #define CCM_MAID_LEN 48
  61 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
  62 #define CCM_RDI_MASK 0x80
  63 #define CFM_HEALTH_INTERVAL 6
  64 struct ccm {
  65     uint8_t  mdlevel_version; /* MD Level and Version */
  66     uint8_t  opcode;
  67     uint8_t  flags;
  68     uint8_t  tlv_offset;
  69     ovs_be32 seq;
  70     ovs_be16 mpid;
  71     uint8_t  maid[CCM_MAID_LEN];
  72
  73     /* Defined by ITU-T Y.1731 should be zero */
  74     ovs_be16 interval_ms_x;      /* Transmission interval in ms. */
  75     ovs_be64 mpid64;             /* MPID in extended mode. */
  76     uint8_t opdown;              /* Operationally down. */
  77     uint8_t  zero[5];
  78
  79     /* TLV space. */
  80     uint8_t end_tlv;
  81 } __attribute__((packed));
  82 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
  83
  84 struct cfm {
  85     char *name;                 /* Name of this CFM object. */
  86     struct hmap_node hmap_node; /* Node in all_cfms list. */
  87
  88     uint64_t mpid;
  89     bool extended;         /* Extended mode. */
  90     int fault;             /* Connectivity fault status. */
  91     int recv_fault;        /* Bit mask of faults occuring on receive. */
  92     bool opup;             /* Operational State. */
  93     bool remote_opup;      /* Remote Operational State. */
  94
  95     int fault_override;    /* Manual override of 'fault' status.
  96                               Ignored if negative. */
  97
  98     uint32_t seq;          /* The sequence number of our last CCM. */
  99     uint8_t ccm_interval;  /* The CCM transmission interval. */
 100     int ccm_interval_ms;   /* 'ccm_interval' in milliseconds. */
 101     uint16_t ccm_vlan;     /* Vlan tag of CCM PDUs.  CFM_RANDOM_VLAN if
 102                               random. */
 103     uint8_t ccm_pcp;       /* Priority of CCM PDUs. */
 104     uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
 105
 106     struct timer tx_timer;    /* Send CCM when expired. */
 107     struct timer fault_timer; /* Check for faults when expired. */
 108
 109     struct hmap remote_mps;   /* Remote MPs. */
 110
 111     /* Result of cfm_get_remote_mpids(). Updated only during fault check to
 112      * avoid flapping. */
 113     uint64_t *rmps_array;     /* Cache of remote_mps. */
 114     size_t rmps_array_len;    /* Number of rmps in 'rmps_array'. */
 115
 116     int health;               /* Percentage of the number of CCM frames
 117                                  received. */
 118     int health_interval;      /* Number of fault_intervals since health was
 119                                  recomputed. */
 120
 121 };
 122
 123 /* Remote MPs represent foreign network entities that are configured to have
 124  * the same MAID as this CFM instance. */
 125 struct remote_mp {
 126     uint64_t mpid;         /* The Maintenance Point ID of this 'remote_mp'. */
 127     struct hmap_node node; /* Node in 'remote_mps' map. */
 128
 129     bool recv;           /* CCM was received since last fault check. */
 130     bool rdi;            /* Remote Defect Indicator. Indicates remote_mp isn't
 131                             receiving CCMs that it's expecting to. */
 132     bool opup;           /* Operational State. */
 133     uint32_t seq;        /* Most recently received sequence number. */
 134     uint8_t num_health_ccm; /* Number of received ccm frames every
 135                                CFM_HEALTH_INTERVAL * 'fault_interval'. */
 136
 137 };
 138
 139 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
 140 static struct hmap all_cfms = HMAP_INITIALIZER(&all_cfms);
 141
 142 static unixctl_cb_func cfm_unixctl_show;
 143 static unixctl_cb_func cfm_unixctl_set_fault;
 144
 145 static const uint8_t *
 146 cfm_ccm_addr(const struct cfm *cfm)
 147 {
 148     return cfm->extended ? eth_addr_ccm_x : eth_addr_ccm;
 149 }
 150
 151 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
 152 const char *
 153 cfm_fault_reason_to_str(int reason) {
 154     switch (reason) {
 155 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
 156         CFM_FAULT_REASONS
 157 #undef CFM_FAULT_REASON
 158     default: return "<unknown>";
 159     }
 160 }
 161
 162 static void
 163 ds_put_cfm_fault(struct ds *ds, int fault)
 164 {
 165     size_t length = ds->length;
 166     int i;
 167
 168     for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
 169         int reason = 1 << i;
 170
 171         if (fault & reason) {
 172             ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
 173         }
 174     }
 175
 176     if (ds->length > length) {
 177         ds_truncate(ds, ds->length - 1);
 178     }
 179 }
 180
 181 static void
 182 cfm_generate_maid(struct cfm *cfm)
 183 {
 184     const char *ovs_md_name = "ovs";
 185     const char *ovs_ma_name = "ovs";
 186     uint8_t *ma_p;
 187     size_t md_len, ma_len;
 188
 189     memset(cfm->maid, 0, CCM_MAID_LEN);
 190
 191     md_len = strlen(ovs_md_name);
 192     ma_len = strlen(ovs_ma_name);
 193
 194     assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
 195
 196     cfm->maid[0] = 4;                           /* MD name string format. */
 197     cfm->maid[1] = md_len;                      /* MD name size. */
 198     memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
 199
 200     ma_p = cfm->maid + 2 + md_len;
 201     ma_p[0] = 2;                           /* MA name string format. */
 202     ma_p[1] = ma_len;                      /* MA name size. */
 203     memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
 204 }
 205
 206 static int
 207 ccm_interval_to_ms(uint8_t interval)
 208 {
 209     switch (interval) {
 210     case 0:  NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
 211     case 1:  return 3;      /* Not recommended due to timer resolution. */
 212     case 2:  return 10;     /* Not recommended due to timer resolution. */
 213     case 3:  return 100;
 214     case 4:  return 1000;
 215     case 5:  return 10000;
 216     case 6:  return 60000;
 217     case 7:  return 600000;
 218     default: NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
 219     }
 220
 221     NOT_REACHED();
 222 }
 223
 224 static long long int
 225 cfm_fault_interval(struct cfm *cfm)
 226 {
 227     /* According to the 802.1ag specification we should assume every other MP
 228      * with the same MAID has the same transmission interval that we have.  If
 229      * an MP has a different interval, cfm_process_heartbeat will register it
 230      * as a fault (likely due to a configuration error).  Thus we can check all
 231      * MPs at once making this quite a bit simpler.
 232      *
 233      * According to the specification we should check when (ccm_interval_ms *
 234      * 3.5)ms have passed. */
 235     return (cfm->ccm_interval_ms * 7) / 2;
 236 }
 237
 238 static uint8_t
 239 ms_to_ccm_interval(int interval_ms)
 240 {
 241     uint8_t i;
 242
 243     for (i = 7; i > 0; i--) {
 244         if (ccm_interval_to_ms(i) <= interval_ms) {
 245             return i;
 246         }
 247     }
 248
 249     return 1;
 250 }
 251
 252 static uint32_t
 253 hash_mpid(uint64_t mpid)
 254 {
 255     return hash_bytes(&mpid, sizeof mpid, 0);
 256 }
 257
 258 static bool
 259 cfm_is_valid_mpid(bool extended, uint64_t mpid)
 260 {
 261     /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
 262      * In extended mode we relax this requirement. */
 263     return mpid >= 1 && (extended || mpid <= 8191);
 264 }
 265
 266 static struct remote_mp *
 267 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid)
 268 {
 269     struct remote_mp *rmp;
 270
 271     HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
 272         if (rmp->mpid == mpid) {
 273             return rmp;
 274         }
 275     }
 276
 277     return NULL;
 278 }
 279
 280 void
 281 cfm_init(void)
 282 {
 283     unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
 284                              NULL);
 285     unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
 286                              1, 2, cfm_unixctl_set_fault, NULL);
 287 }
 288
 289 /* Allocates a 'cfm' object called 'name'.  'cfm' should be initialized by
 290  * cfm_configure() before use. */
 291 struct cfm *
 292 cfm_create(const char *name)
 293 {
 294     struct cfm *cfm;
 295
 296     cfm = xzalloc(sizeof *cfm);
 297     cfm->name = xstrdup(name);
 298     hmap_init(&cfm->remote_mps);
 299     cfm_generate_maid(cfm);
 300     hmap_insert(&all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
 301     cfm->remote_opup = true;
 302     cfm->fault_override = -1;
 303     cfm->health = -1;
 304     return cfm;
 305 }
 306
 307 void
 308 cfm_destroy(struct cfm *cfm)
 309 {
 310     struct remote_mp *rmp, *rmp_next;
 311
 312     if (!cfm) {
 313         return;
 314     }
 315
 316     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
 317         hmap_remove(&cfm->remote_mps, &rmp->node);
 318         free(rmp);
 319     }
 320
 321     hmap_destroy(&cfm->remote_mps);
 322     hmap_remove(&all_cfms, &cfm->hmap_node);
 323     free(cfm->rmps_array);
 324     free(cfm->name);
 325     free(cfm);
 326 }
 327
 328 /* Should be run periodically to update fault statistics messages. */
 329 void
 330 cfm_run(struct cfm *cfm)
 331 {
 332     if (timer_expired(&cfm->fault_timer)) {
 333         long long int interval = cfm_fault_interval(cfm);
 334         struct remote_mp *rmp, *rmp_next;
 335         bool old_cfm_fault = cfm->fault;
 336
 337         cfm->fault = cfm->recv_fault;
 338         cfm->recv_fault = 0;
 339
 340         cfm->rmps_array_len = 0;
 341         free(cfm->rmps_array);
 342         cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
 343                                   sizeof *cfm->rmps_array);
 344
 345         cfm->remote_opup = true;
 346         if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
 347             /* Calculate the cfm health of the interface.  If the number of
 348              * remote_mpids of a cfm interface is > 1, the cfm health is
 349              * undefined. If the number of remote_mpids is 1, the cfm health is
 350              * the percentage of the ccm frames received in the
 351              * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
 352             if (hmap_count(&cfm->remote_mps) > 1) {
 353                 cfm->health = -1;
 354             } else if (hmap_is_empty(&cfm->remote_mps)) {
 355                 cfm->health = 0;
 356             } else {
 357                 int exp_ccm_recvd;
 358
 359                 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
 360                                    struct remote_mp, node);
 361                 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
 362                 /* Calculate the percentage of healthy ccm frames received.
 363                  * Since the 'fault_interval' is (3.5 * cfm_interval), and
 364                  * 1 CCM packet must be received every cfm_interval,
 365                  * the 'remote_mpid' health reports the percentage of
 366                  * healthy CCM frames received every
 367                  * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
 368                 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
 369                 cfm->health = MIN(cfm->health, 100);
 370                 rmp->num_health_ccm = 0;
 371                 assert(cfm->health >= 0 && cfm->health <= 100);
 372             }
 373             cfm->health_interval = 0;
 374         }
 375         cfm->health_interval++;
 376
 377         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
 378
 379             if (!rmp->recv) {
 380                 VLOG_DBG("%s: no CCM from RMP %"PRIu64" in the last %lldms",
 381                          cfm->name, rmp->mpid, interval);
 382                 hmap_remove(&cfm->remote_mps, &rmp->node);
 383                 free(rmp);
 384             } else {
 385                 rmp->recv = false;
 386
 387                 if (rmp->mpid == cfm->mpid) {
 388                     VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
 389                                  " %"PRIu64, cfm->name, rmp->mpid);
 390                     cfm->fault |= CFM_FAULT_LOOPBACK;
 391                 }
 392
 393                 if (rmp->rdi) {
 394                     VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
 395                              rmp->mpid);
 396                     cfm->fault |= CFM_FAULT_RDI;
 397                 }
 398
 399                 if (!rmp->opup) {
 400                     cfm->remote_opup = rmp->opup;
 401                 }
 402
 403                 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
 404             }
 405         }
 406
 407         if (hmap_is_empty(&cfm->remote_mps)) {
 408             cfm->fault |= CFM_FAULT_RECV;
 409         }
 410
 411         if (old_cfm_fault != cfm->fault) {
 412             struct ds ds = DS_EMPTY_INITIALIZER;
 413
 414             ds_put_cfm_fault(&ds, cfm->fault);
 415             VLOG_INFO_RL(&rl, "%s: CFM fault status changed: %s", cfm->name,
 416                          ds_cstr_ro(&ds));
 417             ds_destroy(&ds);
 418         }
 419
 420         timer_set_duration(&cfm->fault_timer, interval);
 421     }
 422 }
 423
 424 /* Should be run periodically to check if the CFM module has a CCM message it
 425  * wishes to send. */
 426 bool
 427 cfm_should_send_ccm(struct cfm *cfm)
 428 {
 429     return timer_expired(&cfm->tx_timer);
 430 }
 431
 432 /* Composes a CCM message into 'packet'.  Messages generated with this function
 433  * should be sent whenever cfm_should_send_ccm() indicates. */
 434 void
 435 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
 436                 uint8_t eth_src[ETH_ADDR_LEN])
 437 {
 438     uint16_t ccm_vlan;
 439     struct ccm *ccm;
 440
 441     timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
 442     eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
 443
 444     ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
 445                 ? cfm->ccm_vlan
 446                 : random_uint16());
 447     ccm_vlan = ccm_vlan & VLAN_VID_MASK;
 448
 449     if (ccm_vlan || cfm->ccm_pcp) {
 450         uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
 451         eth_push_vlan(packet, htons(tci));
 452     }
 453
 454     ccm = packet->l3;
 455     ccm->mdlevel_version = 0;
 456     ccm->opcode = CCM_OPCODE;
 457     ccm->tlv_offset = 70;
 458     ccm->seq = htonl(++cfm->seq);
 459     ccm->flags = cfm->ccm_interval;
 460     memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
 461     memset(ccm->zero, 0, sizeof ccm->zero);
 462     ccm->end_tlv = 0;
 463
 464     if (cfm->extended) {
 465         ccm->mpid = htons(hash_mpid(cfm->mpid));
 466         ccm->mpid64 = htonll(cfm->mpid);
 467         ccm->opdown = !cfm->opup;
 468     } else {
 469         ccm->mpid = htons(cfm->mpid);
 470         ccm->mpid64 = htonll(0);
 471         ccm->opdown = 0;
 472     }
 473
 474     if (cfm->ccm_interval == 0) {
 475         assert(cfm->extended);
 476         ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
 477     }
 478
 479     if (hmap_is_empty(&cfm->remote_mps)) {
 480         ccm->flags |= CCM_RDI_MASK;
 481     }
 482 }
 483
 484 void
 485 cfm_wait(struct cfm *cfm)
 486 {
 487     timer_wait(&cfm->tx_timer);
 488     timer_wait(&cfm->fault_timer);
 489 }
 490
 491 /* Configures 'cfm' with settings from 's'. */
 492 bool
 493 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
 494 {
 495     uint8_t interval;
 496     int interval_ms;
 497
 498     if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
 499         return false;
 500     }
 501
 502     cfm->mpid = s->mpid;
 503     cfm->extended = s->extended;
 504     cfm->opup = s->opup;
 505     interval = ms_to_ccm_interval(s->interval);
 506     interval_ms = ccm_interval_to_ms(interval);
 507
 508     cfm->ccm_vlan = s->ccm_vlan;
 509     cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
 510     if (cfm->extended && interval_ms != s->interval) {
 511         interval = 0;
 512         interval_ms = MIN(s->interval, UINT16_MAX);
 513     }
 514
 515     if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
 516         cfm->ccm_interval = interval;
 517         cfm->ccm_interval_ms = interval_ms;
 518
 519         timer_set_expired(&cfm->tx_timer);
 520         timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
 521     }
 522
 523     return true;
 524 }
 525
 526 /* Returns true if 'cfm' should process packets from 'flow'. */
 527 bool
 528 cfm_should_process_flow(const struct cfm *cfm, const struct flow *flow)
 529 {
 530     return (ntohs(flow->dl_type) == ETH_TYPE_CFM
 531             && eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm)));
 532 }
 533
 534 /* Updates internal statistics relevant to packet 'p'.  Should be called on
 535  * every packet whose flow returned true when passed to
 536  * cfm_should_process_flow. */
 537 void
 538 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
 539 {
 540     struct ccm *ccm;
 541     struct eth_header *eth;
 542
 543     eth = p->l2;
 544     ccm = ofpbuf_at(p, (uint8_t *)p->l3 - (uint8_t *)p->data, CCM_ACCEPT_LEN);
 545
 546     if (!ccm) {
 547         VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
 548                      cfm->name);
 549         return;
 550     }
 551
 552     if (ccm->opcode != CCM_OPCODE) {
 553         VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
 554                      "(opcode %u)", cfm->name, ccm->opcode);
 555         return;
 556     }
 557
 558     /* According to the 802.1ag specification, reception of a CCM with an
 559      * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
 560      * trigger a fault.  We ignore this requirement for several reasons.
 561      *
 562      * Faults can cause a controller or Open vSwitch to make potentially
 563      * expensive changes to the network topology.  It seems prudent to trigger
 564      * them judiciously, especially when CFM is used to check slave status of
 565      * bonds. Furthermore, faults can be maliciously triggered by crafting
 566      * invalid CCMs. */
 567     if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
 568         cfm->recv_fault |= CFM_FAULT_MAID;
 569         VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
 570                      ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
 571     } else {
 572         uint8_t ccm_interval = ccm->flags & 0x7;
 573         bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
 574         uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
 575
 576         struct remote_mp *rmp;
 577         uint64_t ccm_mpid;
 578         uint32_t ccm_seq;
 579         bool ccm_opdown;
 580         bool fault = false;
 581
 582         if (cfm->extended) {
 583             ccm_mpid = ntohll(ccm->mpid64);
 584             ccm_opdown = ccm->opdown;
 585         } else {
 586             ccm_mpid = ntohs(ccm->mpid);
 587             ccm_opdown = false;
 588         }
 589         ccm_seq = ntohl(ccm->seq);
 590
 591         if (ccm_interval != cfm->ccm_interval) {
 592             VLOG_WARN_RL(&rl, "%s: received a CCM with an invalid interval"
 593                          " (%"PRIu8") from RMP %"PRIu64, cfm->name,
 594                          ccm_interval, ccm_mpid);
 595             fault = true;
 596         }
 597
 598         if (cfm->extended && ccm_interval == 0
 599             && ccm_interval_ms_x != cfm->ccm_interval_ms) {
 600             VLOG_WARN_RL(&rl, "%s: received a CCM with an invalid extended"
 601                          " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
 602                          ccm_interval_ms_x, ccm_mpid);
 603             fault = true;
 604         }
 605
 606         rmp = lookup_remote_mp(cfm, ccm_mpid);
 607         if (!rmp) {
 608             if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
 609                 rmp = xzalloc(sizeof *rmp);
 610                 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
 611             } else {
 612                 cfm->recv_fault |= CFM_FAULT_OVERFLOW;
 613                 VLOG_WARN_RL(&rl,
 614                              "%s: dropped CCM with MPID %"PRIu64" from MAC "
 615                              ETH_ADDR_FMT, cfm->name, ccm_mpid,
 616                              ETH_ADDR_ARGS(eth->eth_src));
 617                 fault = true;
 618             }
 619         }
 620
 621         VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
 622                  " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
 623                  ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
 624
 625         if (ccm_rdi) {
 626             fault = true;
 627         }
 628         if (rmp) {
 629             if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
 630                 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
 631                              " numbers which indicate possible connectivity"
 632                              " problems (previous %"PRIu32") (current %"PRIu32
 633                              ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
 634                 fault = true;
 635             }
 636
 637             rmp->mpid = ccm_mpid;
 638             rmp->recv = true;
 639             if (!fault) {
 640                 rmp->num_health_ccm++;
 641             }
 642             rmp->seq = ccm_seq;
 643             rmp->rdi = ccm_rdi;
 644             rmp->opup = !ccm_opdown;
 645         }
 646     }
 647 }
 648
 649 /* Gets the fault status of 'cfm'.  Returns a bit mask of 'cfm_fault_reason's
 650  * indicating the cause of the connectivity fault, or zero if there is no
 651  * fault. */
 652 int
 653 cfm_get_fault(const struct cfm *cfm)
 654 {
 655     if (cfm->fault_override >= 0) {
 656         return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
 657     }
 658     return cfm->fault;
 659 }
 660
 661 /* Gets the health of 'cfm'.  Returns an integer between 0 and 100 indicating
 662  * the health of the link as a percentage of ccm frames received in
 663  * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
 664  * returns 0 if there are no remote_mpids, and returns -1 if there are more
 665  * than 1 remote_mpids. */
 666 int
 667 cfm_get_health(const struct cfm *cfm)
 668 {
 669     return cfm->health;
 670 }
 671
 672 /* Gets the operational state of 'cfm'.  'cfm' is considered operationally down
 673  * if it has received a CCM with the operationally down bit set from any of its
 674  * remote maintenance points. Returns true if 'cfm' is operationally up. False
 675  * otherwise. */
 676 bool
 677 cfm_get_opup(const struct cfm *cfm)
 678 {
 679     return cfm->remote_opup;
 680 }
 681
 682 /* Populates 'rmps' with an array of remote maintenance points reachable by
 683  * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
 684  * 'cfm' retains ownership of the array written to 'rmps' */
 685 void
 686 cfm_get_remote_mpids(const struct cfm *cfm, const uint64_t **rmps,
 687                      size_t *n_rmps)
 688 {
 689     *rmps = cfm->rmps_array;
 690     *n_rmps = cfm->rmps_array_len;
 691 }
 692
 693 static struct cfm *
 694 cfm_find(const char *name)
 695 {
 696     struct cfm *cfm;
 697
 698     HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), &all_cfms) {
 699         if (!strcmp(cfm->name, name)) {
 700             return cfm;
 701         }
 702     }
 703     return NULL;
 704 }
 705
 706 static void
 707 cfm_print_details(struct ds *ds, const struct cfm *cfm)
 708 {
 709     struct remote_mp *rmp;
 710
 711     ds_put_format(ds, "---- %s ----\n", cfm->name);
 712     ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
 713                   cfm->extended ? " extended" : "",
 714                   cfm->fault_override >= 0 ? " fault_override" : "");
 715
 716
 717     if (cfm_get_fault(cfm)) {
 718         ds_put_cstr(ds, "\tfault: ");
 719         ds_put_cfm_fault(ds, cfm_get_fault(cfm));
 720         ds_put_cstr(ds, "\n");
 721     }
 722
 723     if (cfm->health == -1) {
 724         ds_put_format(ds, "\taverage health: undefined\n");
 725     } else {
 726         ds_put_format(ds, "\taverage health: %d\n", cfm->health);
 727     }
 728     ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
 729     ds_put_format(ds, "\tremote_opstate: %s\n",
 730                   cfm->remote_opup ? "up" : "down");
 731     ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
 732     ds_put_format(ds, "\tnext CCM tx: %lldms\n",
 733                   timer_msecs_until_expired(&cfm->tx_timer));
 734     ds_put_format(ds, "\tnext fault check: %lldms\n",
 735                   timer_msecs_until_expired(&cfm->fault_timer));
 736
 737     HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
 738         ds_put_format(ds, "Remote MPID %"PRIu64":%s\n",
 739                       rmp->mpid,
 740                       rmp->rdi ? " rdi" : "");
 741         ds_put_format(ds, "\trecv since check: %s\n",
 742                       rmp->recv ? "true" : "false");
 743         ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
 744     }
 745 }
 746
 747 static void
 748 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
 749                  void *aux OVS_UNUSED)
 750 {
 751     struct ds ds = DS_EMPTY_INITIALIZER;
 752     const struct cfm *cfm;
 753
 754     if (argc > 1) {
 755         cfm = cfm_find(argv[1]);
 756         if (!cfm) {
 757             unixctl_command_reply_error(conn, "no such CFM object");
 758             return;
 759         }
 760         cfm_print_details(&ds, cfm);
 761     } else {
 762         HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
 763             cfm_print_details(&ds, cfm);
 764         }
 765     }
 766
 767     unixctl_command_reply(conn, ds_cstr(&ds));
 768     ds_destroy(&ds);
 769 }
 770
 771 static void
 772 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
 773                       void *aux OVS_UNUSED)
 774 {
 775     const char *fault_str = argv[argc - 1];
 776     int fault_override;
 777     struct cfm *cfm;
 778
 779     if (!strcasecmp("true", fault_str)) {
 780         fault_override = 1;
 781     } else if (!strcasecmp("false", fault_str)) {
 782         fault_override = 0;
 783     } else if (!strcasecmp("normal", fault_str)) {
 784         fault_override = -1;
 785     } else {
 786         unixctl_command_reply_error(conn, "unknown fault string");
 787         return;
 788     }
 789
 790     if (argc > 2) {
 791         cfm = cfm_find(argv[1]);
 792         if (!cfm) {
 793             unixctl_command_reply_error(conn, "no such CFM object");
 794             return;
 795         }
 796         cfm->fault_override = fault_override;
 797     } else {
 798         HMAP_FOR_EACH (cfm, hmap_node, &all_cfms) {
 799             cfm->fault_override = fault_override;
 800         }
 801     }
 802
 803     unixctl_command_reply(conn, "OK");
 804 }