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