lib/cfm.c

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