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