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