lib/cfm.c

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