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