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