lib/cfm.c

   1 /*
   2  * Copyright (c) 2010, 2011, 2012, 2013, 2014 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 "connectivity.h"
  26 #include "dynamic-string.h"
  27 #include "flow.h"
  28 #include "hash.h"
  29 #include "hmap.h"
  30 #include "netdev.h"
  31 #include "ofpbuf.h"
  32 #include "packets.h"
  33 #include "poll-loop.h"
  34 #include "random.h"
  35 #include "seq.h"
  36 #include "timer.h"
  37 #include "timeval.h"
  38 #include "unixctl.h"
  39 #include "openvswitch/vlog.h"
  40
  41 VLOG_DEFINE_THIS_MODULE(cfm);
  42
  43 #define CFM_MAX_RMPS 256
  44
  45 /* Ethernet destination address of CCM packets. */
  46 static const uint8_t eth_addr_ccm[ETH_ADDR_LEN] = {
  47     0x01, 0x80, 0xC2, 0x00, 0x00, 0x30 };
  48 static const uint8_t eth_addr_ccm_x[ETH_ADDR_LEN] = {
  49     0x01, 0x23, 0x20, 0x00, 0x00, 0x30
  50 };
  51
  52 #define ETH_TYPE_CFM 0x8902
  53
  54 /* A 'ccm' represents a Continuity Check Message from the 802.1ag
  55  * specification.  Continuity Check Messages are broadcast periodically so that
  56  * hosts can determine whom they have connectivity to.
  57  *
  58  * The minimum length of a CCM as specified by IEEE 802.1ag is 75 bytes.
  59  * Previous versions of Open vSwitch generated 74-byte CCM messages, so we
  60  * accept such messages too. */
  61 #define CCM_LEN 75
  62 #define CCM_ACCEPT_LEN 74
  63 #define CCM_MAID_LEN 48
  64 #define CCM_OPCODE 1 /* CFM message opcode meaning CCM. */
  65 #define CCM_RDI_MASK 0x80
  66 #define CFM_HEALTH_INTERVAL 6
  67
  68 OVS_PACKED(
  69 struct ccm {
  70     uint8_t mdlevel_version; /* MD Level and Version */
  71     uint8_t opcode;
  72     uint8_t flags;
  73     uint8_t tlv_offset;
  74     ovs_be32 seq;
  75     ovs_be16 mpid;
  76     uint8_t maid[CCM_MAID_LEN];
  77
  78     /* Defined by ITU-T Y.1731 should be zero */
  79     ovs_be16 interval_ms_x;      /* Transmission interval in ms. */
  80     ovs_be64 mpid64;             /* MPID in extended mode. */
  81     uint8_t opdown;              /* Operationally down. */
  82     uint8_t zero[5];
  83
  84     /* TLV space. */
  85     uint8_t end_tlv;
  86 });
  87 BUILD_ASSERT_DECL(CCM_LEN == sizeof(struct ccm));
  88
  89 struct cfm {
  90     const char *name;           /* Name of this CFM object. */
  91     struct hmap_node hmap_node; /* Node in all_cfms list. */
  92
  93     struct netdev *netdev;
  94     uint64_t rx_packets;        /* Packets received by 'netdev'. */
  95
  96     uint64_t mpid;
  97     bool demand;           /* Demand mode. */
  98     bool booted;           /* A full fault interval has occurred. */
  99     enum cfm_fault_reason fault;  /* Connectivity fault status. */
 100     enum cfm_fault_reason recv_fault;  /* Bit mask of faults occurring on
 101                                           receive. */
 102     bool opup;             /* Operational State. */
 103     bool remote_opup;      /* Remote Operational State. */
 104
 105     int fault_override;    /* Manual override of 'fault' status.
 106                               Ignored if negative. */
 107
 108     uint32_t seq;          /* The sequence number of our last CCM. */
 109     uint8_t ccm_interval;  /* The CCM transmission interval. */
 110     int ccm_interval_ms;   /* 'ccm_interval' in milliseconds. */
 111     uint16_t ccm_vlan;     /* Vlan tag of CCM PDUs.  CFM_RANDOM_VLAN if
 112                               random. */
 113     uint8_t ccm_pcp;       /* Priority of CCM PDUs. */
 114     uint8_t maid[CCM_MAID_LEN]; /* The MAID of this CFM. */
 115
 116     struct timer tx_timer;    /* Send CCM when expired. */
 117     struct timer fault_timer; /* Check for faults when expired. */
 118
 119     struct hmap remote_mps;   /* Remote MPs. */
 120
 121     /* Result of cfm_get_remote_mpids(). Updated only during fault check to
 122      * avoid flapping. */
 123     uint64_t *rmps_array;     /* Cache of remote_mps. */
 124     size_t rmps_array_len;    /* Number of rmps in 'rmps_array'. */
 125
 126     int health;               /* Percentage of the number of CCM frames
 127                                  received. */
 128     int health_interval;      /* Number of fault_intervals since health was
 129                                  recomputed. */
 130     long long int last_tx;    /* Last CCM transmission time. */
 131
 132     /* These bools are atomic to allow readers to check their values
 133      * without taking 'mutex'.  Such readers do not assume the values they
 134      * read are synchronized with any other members. */
 135     atomic_bool check_tnl_key; /* Verify the tunnel key of inbound packets? */
 136     atomic_bool extended;      /* Extended mode. */
 137     struct ovs_refcount ref_cnt;
 138
 139     uint64_t flap_count;       /* Count the flaps since boot. */
 140
 141     /* True when the variables returned by cfm_get_*() are changed
 142      * since last check. */
 143     bool status_changed;
 144
 145     /* When 'cfm->demand' is set, at least one ccm is required to be received
 146      * every 100 * cfm_interval.  If ccm is not received within this interval,
 147      * even if data packets are received, the cfm fault will be set. */
 148     struct timer demand_rx_ccm_t;
 149 };
 150
 151 /* Remote MPs represent foreign network entities that are configured to have
 152  * the same MAID as this CFM instance. */
 153 struct remote_mp {
 154     uint64_t mpid;         /* The Maintenance Point ID of this 'remote_mp'. */
 155     struct hmap_node node; /* Node in 'remote_mps' map. */
 156
 157     bool recv;           /* CCM was received since last fault check. */
 158     bool opup;           /* Operational State. */
 159     uint32_t seq;        /* Most recently received sequence number. */
 160     uint8_t num_health_ccm; /* Number of received ccm frames every
 161                                CFM_HEALTH_INTERVAL * 'fault_interval'. */
 162     long long int last_rx; /* Last CCM reception time. */
 163
 164 };
 165
 166 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 30);
 167
 168 static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
 169 static struct hmap all_cfms__ = HMAP_INITIALIZER(&all_cfms__);
 170 static struct hmap *const all_cfms OVS_GUARDED_BY(mutex) = &all_cfms__;
 171
 172 static unixctl_cb_func cfm_unixctl_show;
 173 static unixctl_cb_func cfm_unixctl_set_fault;
 174
 175 static uint64_t
 176 cfm_rx_packets(const struct cfm *cfm) OVS_REQUIRES(mutex)
 177 {
 178     struct netdev_stats stats;
 179
 180     if (!netdev_get_stats(cfm->netdev, &stats)) {
 181         return stats.rx_packets;
 182     } else {
 183         return 0;
 184     }
 185 }
 186
 187 static const uint8_t *
 188 cfm_ccm_addr(struct cfm *cfm)
 189 {
 190     bool extended;
 191
 192     atomic_read_relaxed(&cfm->extended, &extended);
 193
 194     return extended ? eth_addr_ccm_x : eth_addr_ccm;
 195 }
 196
 197 /* Returns the string representation of the given cfm_fault_reason 'reason'. */
 198 const char *
 199 cfm_fault_reason_to_str(int reason)
 200 {
 201     switch (reason) {
 202 #define CFM_FAULT_REASON(NAME, STR) case CFM_FAULT_##NAME: return #STR;
 203         CFM_FAULT_REASONS
 204 #undef CFM_FAULT_REASON
 205     default: return "<unknown>";
 206     }
 207 }
 208
 209 static void
 210 ds_put_cfm_fault(struct ds *ds, int fault)
 211 {
 212     int i;
 213
 214     for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
 215         int reason = 1 << i;
 216
 217         if (fault & reason) {
 218             ds_put_format(ds, "%s ", cfm_fault_reason_to_str(reason));
 219         }
 220     }
 221
 222     ds_chomp(ds, ' ');
 223 }
 224
 225 static void
 226 cfm_generate_maid(struct cfm *cfm) OVS_REQUIRES(mutex)
 227 {
 228     const char *ovs_md_name = "ovs";
 229     const char *ovs_ma_name = "ovs";
 230     uint8_t *ma_p;
 231     size_t md_len, ma_len;
 232
 233     memset(cfm->maid, 0, CCM_MAID_LEN);
 234
 235     md_len = strlen(ovs_md_name);
 236     ma_len = strlen(ovs_ma_name);
 237
 238     ovs_assert(md_len && ma_len && md_len + ma_len + 4 <= CCM_MAID_LEN);
 239
 240     cfm->maid[0] = 4;                           /* MD name string format. */
 241     cfm->maid[1] = md_len;                      /* MD name size. */
 242     memcpy(&cfm->maid[2], ovs_md_name, md_len); /* MD name. */
 243
 244     ma_p = cfm->maid + 2 + md_len;
 245     ma_p[0] = 2;                           /* MA name string format. */
 246     ma_p[1] = ma_len;                      /* MA name size. */
 247     memcpy(&ma_p[2], ovs_ma_name, ma_len); /* MA name. */
 248 }
 249
 250 static int
 251 ccm_interval_to_ms(uint8_t interval)
 252 {
 253     switch (interval) {
 254     case 0:  OVS_NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
 255     case 1:  return 3;      /* Not recommended due to timer resolution. */
 256     case 2:  return 10;     /* Not recommended due to timer resolution. */
 257     case 3:  return 100;
 258     case 4:  return 1000;
 259     case 5:  return 10000;
 260     case 6:  return 60000;
 261     case 7:  return 600000;
 262     default: OVS_NOT_REACHED(); /* Explicitly not supported by 802.1ag. */
 263     }
 264
 265     OVS_NOT_REACHED();
 266 }
 267
 268 static long long int
 269 cfm_fault_interval(struct cfm *cfm) OVS_REQUIRES(mutex)
 270 {
 271     /* According to the 802.1ag specification we should assume every other MP
 272      * with the same MAID has the same transmission interval that we have.  If
 273      * an MP has a different interval, cfm_process_heartbeat will register it
 274      * as a fault (likely due to a configuration error).  Thus we can check all
 275      * MPs at once making this quite a bit simpler.
 276      *
 277      * When cfm is not in demand mode, we check when (ccm_interval_ms * 3.5) ms
 278      * have passed.  When cfm is in demand mode, we check when
 279      * (MAX(ccm_interval_ms, 500) * 3.5) ms have passed.  This ensures that
 280      * ovs-vswitchd has enough time to pull statistics from the datapath. */
 281
 282     return (MAX(cfm->ccm_interval_ms, cfm->demand ? 500 : cfm->ccm_interval_ms)
 283             * 7) / 2;
 284 }
 285
 286 static uint8_t
 287 ms_to_ccm_interval(int interval_ms)
 288 {
 289     uint8_t i;
 290
 291     for (i = 7; i > 0; i--) {
 292         if (ccm_interval_to_ms(i) <= interval_ms) {
 293             return i;
 294         }
 295     }
 296
 297     return 1;
 298 }
 299
 300 static uint32_t
 301 hash_mpid(uint64_t mpid)
 302 {
 303     return hash_uint64(mpid);
 304 }
 305
 306 static bool
 307 cfm_is_valid_mpid(bool extended, uint64_t mpid)
 308 {
 309     /* 802.1ag specification requires MPIDs to be within the range [1, 8191].
 310      * In extended mode we relax this requirement. */
 311     return mpid >= 1 && (extended || mpid <= 8191);
 312 }
 313
 314 static struct remote_mp *
 315 lookup_remote_mp(const struct cfm *cfm, uint64_t mpid) OVS_REQUIRES(mutex)
 316 {
 317     struct remote_mp *rmp;
 318
 319     HMAP_FOR_EACH_IN_BUCKET (rmp, node, hash_mpid(mpid), &cfm->remote_mps) {
 320         if (rmp->mpid == mpid) {
 321             return rmp;
 322         }
 323     }
 324
 325     return NULL;
 326 }
 327
 328 void
 329 cfm_init(void)
 330 {
 331     unixctl_command_register("cfm/show", "[interface]", 0, 1, cfm_unixctl_show,
 332                              NULL);
 333     unixctl_command_register("cfm/set-fault", "[interface] normal|false|true",
 334                              1, 2, cfm_unixctl_set_fault, NULL);
 335 }
 336
 337 /* Records the status change and changes the global connectivity seq. */
 338 static void
 339 cfm_status_changed(struct cfm *cfm) OVS_REQUIRES(mutex)
 340 {
 341     seq_change(connectivity_seq_get());
 342     cfm->status_changed = true;
 343 }
 344
 345 /* Allocates a 'cfm' object called 'name'.  'cfm' should be initialized by
 346  * cfm_configure() before use. */
 347 struct cfm *
 348 cfm_create(const struct netdev *netdev) OVS_EXCLUDED(mutex)
 349 {
 350     struct cfm *cfm;
 351
 352     cfm = xzalloc(sizeof *cfm);
 353     cfm->netdev = netdev_ref(netdev);
 354     cfm->name = netdev_get_name(cfm->netdev);
 355     hmap_init(&cfm->remote_mps);
 356     cfm->remote_opup = true;
 357     cfm->fault_override = -1;
 358     cfm->health = -1;
 359     cfm->last_tx = 0;
 360     cfm->flap_count = 0;
 361     atomic_init(&cfm->extended, false);
 362     atomic_init(&cfm->check_tnl_key, false);
 363     ovs_refcount_init(&cfm->ref_cnt);
 364
 365     ovs_mutex_lock(&mutex);
 366     cfm_status_changed(cfm);
 367     cfm_generate_maid(cfm);
 368     hmap_insert(all_cfms, &cfm->hmap_node, hash_string(cfm->name, 0));
 369     ovs_mutex_unlock(&mutex);
 370
 371     return cfm;
 372 }
 373
 374 void
 375 cfm_unref(struct cfm *cfm) OVS_EXCLUDED(mutex)
 376 {
 377     struct remote_mp *rmp, *rmp_next;
 378
 379     if (!cfm) {
 380         return;
 381     }
 382
 383     if (ovs_refcount_unref_relaxed(&cfm->ref_cnt) != 1) {
 384         return;
 385     }
 386
 387     ovs_mutex_lock(&mutex);
 388     cfm_status_changed(cfm);
 389     hmap_remove(all_cfms, &cfm->hmap_node);
 390     ovs_mutex_unlock(&mutex);
 391
 392     HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
 393         hmap_remove(&cfm->remote_mps, &rmp->node);
 394         free(rmp);
 395     }
 396
 397     hmap_destroy(&cfm->remote_mps);
 398     netdev_close(cfm->netdev);
 399     free(cfm->rmps_array);
 400
 401     free(cfm);
 402 }
 403
 404 struct cfm *
 405 cfm_ref(const struct cfm *cfm_)
 406 {
 407     struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
 408     if (cfm) {
 409         ovs_refcount_ref(&cfm->ref_cnt);
 410     }
 411     return cfm;
 412 }
 413
 414 /* Should be run periodically to update fault statistics messages. */
 415 void
 416 cfm_run(struct cfm *cfm) OVS_EXCLUDED(mutex)
 417 {
 418     ovs_mutex_lock(&mutex);
 419     if (timer_expired(&cfm->fault_timer)) {
 420         long long int interval = cfm_fault_interval(cfm);
 421         struct remote_mp *rmp, *rmp_next;
 422         enum cfm_fault_reason old_cfm_fault = cfm->fault;
 423         uint64_t old_flap_count = cfm->flap_count;
 424         int old_health = cfm->health;
 425         size_t old_rmps_array_len = cfm->rmps_array_len;
 426         bool old_rmps_deleted = false;
 427         bool old_rmp_opup = cfm->remote_opup;
 428         bool demand_override;
 429         bool rmp_set_opup = false;
 430         bool rmp_set_opdown = false;
 431
 432         cfm->fault = cfm->recv_fault;
 433         cfm->recv_fault = 0;
 434
 435         cfm->rmps_array_len = 0;
 436         free(cfm->rmps_array);
 437         cfm->rmps_array = xmalloc(hmap_count(&cfm->remote_mps) *
 438                                   sizeof *cfm->rmps_array);
 439
 440         if (cfm->health_interval == CFM_HEALTH_INTERVAL) {
 441             /* Calculate the cfm health of the interface.  If the number of
 442              * remote_mpids of a cfm interface is > 1, the cfm health is
 443              * undefined. If the number of remote_mpids is 1, the cfm health is
 444              * the percentage of the ccm frames received in the
 445              * (CFM_HEALTH_INTERVAL * 3.5)ms, else it is 0. */
 446             if (hmap_count(&cfm->remote_mps) > 1) {
 447                 cfm->health = -1;
 448             } else if (hmap_is_empty(&cfm->remote_mps)) {
 449                 cfm->health = 0;
 450             } else {
 451                 int exp_ccm_recvd;
 452
 453                 rmp = CONTAINER_OF(hmap_first(&cfm->remote_mps),
 454                                    struct remote_mp, node);
 455                 exp_ccm_recvd = (CFM_HEALTH_INTERVAL * 7) / 2;
 456                 /* Calculate the percentage of healthy ccm frames received.
 457                  * Since the 'fault_interval' is (3.5 * cfm_interval), and
 458                  * 1 CCM packet must be received every cfm_interval,
 459                  * the 'remote_mpid' health reports the percentage of
 460                  * healthy CCM frames received every
 461                  * 'CFM_HEALTH_INTERVAL'th 'fault_interval'. */
 462                 cfm->health = (rmp->num_health_ccm * 100) / exp_ccm_recvd;
 463                 cfm->health = MIN(cfm->health, 100);
 464                 rmp->num_health_ccm = 0;
 465                 ovs_assert(cfm->health >= 0 && cfm->health <= 100);
 466             }
 467             cfm->health_interval = 0;
 468         }
 469         cfm->health_interval++;
 470
 471         demand_override = false;
 472         if (cfm->demand) {
 473             uint64_t rx_packets = cfm_rx_packets(cfm);
 474             demand_override = hmap_count(&cfm->remote_mps) == 1
 475                 && rx_packets > cfm->rx_packets
 476                 && !timer_expired(&cfm->demand_rx_ccm_t);
 477             cfm->rx_packets = rx_packets;
 478         }
 479
 480         HMAP_FOR_EACH_SAFE (rmp, rmp_next, node, &cfm->remote_mps) {
 481             if (!rmp->recv) {
 482                 VLOG_INFO("%s: Received no CCM from RMP %"PRIu64" in the last"
 483                           " %lldms", cfm->name, rmp->mpid,
 484                           time_msec() - rmp->last_rx);
 485                 if (!demand_override) {
 486                     old_rmps_deleted = true;
 487                     hmap_remove(&cfm->remote_mps, &rmp->node);
 488                     free(rmp);
 489                 }
 490             } else {
 491                 rmp->recv = false;
 492
 493                 if (rmp->opup) {
 494                     rmp_set_opup = true;
 495                 } else {
 496                     rmp_set_opdown = true;
 497                 }
 498
 499                 cfm->rmps_array[cfm->rmps_array_len++] = rmp->mpid;
 500             }
 501         }
 502
 503         if (rmp_set_opdown) {
 504             cfm->remote_opup = false;
 505         }
 506         else if (rmp_set_opup) {
 507             cfm->remote_opup = true;
 508         }
 509
 510         if (hmap_is_empty(&cfm->remote_mps)) {
 511             cfm->fault |= CFM_FAULT_RECV;
 512         }
 513
 514         if (old_cfm_fault != cfm->fault) {
 515             if (!VLOG_DROP_INFO(&rl)) {
 516                 struct ds ds = DS_EMPTY_INITIALIZER;
 517
 518                 ds_put_cstr(&ds, "from [");
 519                 ds_put_cfm_fault(&ds, old_cfm_fault);
 520                 ds_put_cstr(&ds, "] to [");
 521                 ds_put_cfm_fault(&ds, cfm->fault);
 522                 ds_put_char(&ds, ']');
 523                 VLOG_INFO("%s: CFM faults changed %s.", cfm->name, ds_cstr(&ds));
 524                 ds_destroy(&ds);
 525             }
 526
 527             /* If there is a flap, increments the counter. */
 528             if (old_cfm_fault == 0 || cfm->fault == 0) {
 529                 cfm->flap_count++;
 530             }
 531         }
 532
 533         /* These variables represent the cfm session status, it is desirable
 534          * to update them to database immediately after change. */
 535         if (old_health != cfm->health
 536             || old_rmp_opup != cfm->remote_opup
 537             || (old_rmps_array_len != cfm->rmps_array_len || old_rmps_deleted)
 538             || old_cfm_fault != cfm->fault
 539             || old_flap_count != cfm->flap_count) {
 540             cfm_status_changed(cfm);
 541         }
 542
 543         cfm->booted = true;
 544         timer_set_duration(&cfm->fault_timer, interval);
 545         VLOG_DBG("%s: new fault interval", cfm->name);
 546     }
 547     ovs_mutex_unlock(&mutex);
 548 }
 549
 550 /* Should be run periodically to check if the CFM module has a CCM message it
 551  * wishes to send. */
 552 bool
 553 cfm_should_send_ccm(struct cfm *cfm) OVS_EXCLUDED(mutex)
 554 {
 555     bool ret;
 556
 557     ovs_mutex_lock(&mutex);
 558     ret = timer_expired(&cfm->tx_timer);
 559     ovs_mutex_unlock(&mutex);
 560     return ret;
 561 }
 562
 563 /* Composes a CCM message into 'packet'.  Messages generated with this function
 564  * should be sent whenever cfm_should_send_ccm() indicates. */
 565 void
 566 cfm_compose_ccm(struct cfm *cfm, struct ofpbuf *packet,
 567                 uint8_t eth_src[ETH_ADDR_LEN]) OVS_EXCLUDED(mutex)
 568 {
 569     uint16_t ccm_vlan;
 570     struct ccm *ccm;
 571     bool extended;
 572
 573     ovs_mutex_lock(&mutex);
 574     timer_set_duration(&cfm->tx_timer, cfm->ccm_interval_ms);
 575     eth_compose(packet, cfm_ccm_addr(cfm), eth_src, ETH_TYPE_CFM, sizeof *ccm);
 576
 577     ccm_vlan = (cfm->ccm_vlan != CFM_RANDOM_VLAN
 578                 ? cfm->ccm_vlan
 579                 : random_uint16());
 580     ccm_vlan = ccm_vlan & VLAN_VID_MASK;
 581
 582     if (ccm_vlan || cfm->ccm_pcp) {
 583         uint16_t tci = ccm_vlan | (cfm->ccm_pcp << VLAN_PCP_SHIFT);
 584         eth_push_vlan(packet, htons(ETH_TYPE_VLAN), htons(tci));
 585     }
 586
 587     atomic_read_relaxed(&cfm->extended, &extended);
 588
 589     ccm = ofpbuf_l3(packet);
 590     ccm->mdlevel_version = 0;
 591     ccm->opcode = CCM_OPCODE;
 592     ccm->tlv_offset = 70;
 593     ccm->seq = htonl(++cfm->seq);
 594     ccm->flags = cfm->ccm_interval;
 595     memcpy(ccm->maid, cfm->maid, sizeof ccm->maid);
 596     memset(ccm->zero, 0, sizeof ccm->zero);
 597     ccm->end_tlv = 0;
 598
 599     if (extended) {
 600         ccm->mpid = htons(hash_mpid(cfm->mpid));
 601         ccm->mpid64 = htonll(cfm->mpid);
 602         ccm->opdown = !cfm->opup;
 603     } else {
 604         ccm->mpid = htons(cfm->mpid);
 605         ccm->mpid64 = htonll(0);
 606         ccm->opdown = 0;
 607     }
 608
 609     if (cfm->ccm_interval == 0) {
 610         ovs_assert(extended);
 611         ccm->interval_ms_x = htons(cfm->ccm_interval_ms);
 612     } else {
 613         ccm->interval_ms_x = htons(0);
 614     }
 615
 616     if (cfm->booted && hmap_is_empty(&cfm->remote_mps)) {
 617         ccm->flags |= CCM_RDI_MASK;
 618     }
 619
 620     if (cfm->last_tx) {
 621         long long int delay = time_msec() - cfm->last_tx;
 622         if (delay > (cfm->ccm_interval_ms * 3 / 2)) {
 623             VLOG_INFO("%s: long delay of %lldms (expected %dms) sending CCM"
 624                       " seq %"PRIu32, cfm->name, delay, cfm->ccm_interval_ms,
 625                       cfm->seq);
 626         }
 627     }
 628     cfm->last_tx = time_msec();
 629     ovs_mutex_unlock(&mutex);
 630 }
 631
 632 void
 633 cfm_wait(struct cfm *cfm) OVS_EXCLUDED(mutex)
 634 {
 635     poll_timer_wait_until(cfm_wake_time(cfm));
 636 }
 637
 638
 639 /* Returns the next cfm wakeup time. */
 640 long long int
 641 cfm_wake_time(struct cfm *cfm) OVS_EXCLUDED(mutex)
 642 {
 643     long long int retval;
 644
 645     if (!cfm) {
 646         return LLONG_MAX;
 647     }
 648
 649     ovs_mutex_lock(&mutex);
 650     retval = MIN(cfm->tx_timer.t, cfm->fault_timer.t);
 651     ovs_mutex_unlock(&mutex);
 652     return retval;
 653 }
 654
 655
 656 /* Configures 'cfm' with settings from 's'. */
 657 bool
 658 cfm_configure(struct cfm *cfm, const struct cfm_settings *s)
 659     OVS_EXCLUDED(mutex)
 660 {
 661     uint8_t interval;
 662     int interval_ms;
 663
 664     if (!cfm_is_valid_mpid(s->extended, s->mpid) || s->interval <= 0) {
 665         return false;
 666     }
 667
 668     ovs_mutex_lock(&mutex);
 669     cfm->mpid = s->mpid;
 670     cfm->opup = s->opup;
 671     interval = ms_to_ccm_interval(s->interval);
 672     interval_ms = ccm_interval_to_ms(interval);
 673
 674     atomic_store_relaxed(&cfm->check_tnl_key, s->check_tnl_key);
 675     atomic_store_relaxed(&cfm->extended, s->extended);
 676
 677     cfm->ccm_vlan = s->ccm_vlan;
 678     cfm->ccm_pcp = s->ccm_pcp & (VLAN_PCP_MASK >> VLAN_PCP_SHIFT);
 679     if (s->extended && interval_ms != s->interval) {
 680         interval = 0;
 681         interval_ms = MIN(s->interval, UINT16_MAX);
 682     }
 683
 684     if (s->extended && s->demand) {
 685         if (!cfm->demand) {
 686             cfm->demand = true;
 687             cfm->rx_packets = cfm_rx_packets(cfm);
 688         }
 689     } else {
 690         cfm->demand = false;
 691     }
 692
 693     if (interval != cfm->ccm_interval || interval_ms != cfm->ccm_interval_ms) {
 694         cfm->ccm_interval = interval;
 695         cfm->ccm_interval_ms = interval_ms;
 696
 697         timer_set_expired(&cfm->tx_timer);
 698         timer_set_duration(&cfm->fault_timer, cfm_fault_interval(cfm));
 699     }
 700
 701     ovs_mutex_unlock(&mutex);
 702     return true;
 703 }
 704
 705 /* Must be called when the netdev owned by 'cfm' should change. */
 706 void
 707 cfm_set_netdev(struct cfm *cfm, const struct netdev *netdev)
 708     OVS_EXCLUDED(mutex)
 709 {
 710     ovs_mutex_lock(&mutex);
 711     if (cfm->netdev != netdev) {
 712         netdev_close(cfm->netdev);
 713         cfm->netdev = netdev_ref(netdev);
 714     }
 715     ovs_mutex_unlock(&mutex);
 716 }
 717
 718 /* Returns true if 'cfm' should process packets from 'flow'.  Sets
 719  * fields in 'wc' that were used to make the determination. */
 720 bool
 721 cfm_should_process_flow(const struct cfm *cfm_, const struct flow *flow,
 722                         struct flow_wildcards *wc)
 723 {
 724     struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
 725     bool check_tnl_key;
 726
 727     /* Most packets are not CFM. */
 728     if (OVS_LIKELY(flow->dl_type != htons(ETH_TYPE_CFM))) {
 729         return false;
 730     }
 731
 732     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 733     if (OVS_UNLIKELY(!eth_addr_equals(flow->dl_dst, cfm_ccm_addr(cfm)))) {
 734         return false;
 735     }
 736
 737     atomic_read_relaxed(&cfm->check_tnl_key, &check_tnl_key);
 738
 739     if (check_tnl_key) {
 740         memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
 741         return flow->tunnel.tun_id == htonll(0);
 742     }
 743     return true;
 744 }
 745
 746 /* Updates internal statistics relevant to packet 'p'.  Should be called on
 747  * every packet whose flow returned true when passed to
 748  * cfm_should_process_flow. */
 749 void
 750 cfm_process_heartbeat(struct cfm *cfm, const struct ofpbuf *p)
 751     OVS_EXCLUDED(mutex)
 752 {
 753     struct ccm *ccm;
 754     struct eth_header *eth;
 755     bool extended;
 756
 757     ovs_mutex_lock(&mutex);
 758
 759     atomic_read_relaxed(&cfm->extended, &extended);
 760
 761     eth = ofpbuf_l2(p);
 762     ccm = ofpbuf_at(p, (uint8_t *)ofpbuf_l3(p) - (uint8_t *)ofpbuf_data(p),
 763                     CCM_ACCEPT_LEN);
 764
 765     if (!ccm) {
 766         VLOG_INFO_RL(&rl, "%s: Received an unparseable 802.1ag CCM heartbeat.",
 767                      cfm->name);
 768         goto out;
 769     }
 770
 771     if (ccm->opcode != CCM_OPCODE) {
 772         VLOG_INFO_RL(&rl, "%s: Received an unsupported 802.1ag message. "
 773                      "(opcode %u)", cfm->name, ccm->opcode);
 774         goto out;
 775     }
 776
 777     /* According to the 802.1ag specification, reception of a CCM with an
 778      * incorrect ccm_interval, unexpected MAID, or unexpected MPID should
 779      * trigger a fault.  We ignore this requirement for several reasons.
 780      *
 781      * Faults can cause a controller or Open vSwitch to make potentially
 782      * expensive changes to the network topology.  It seems prudent to trigger
 783      * them judiciously, especially when CFM is used to check slave status of
 784      * bonds. Furthermore, faults can be maliciously triggered by crafting
 785      * unexpected CCMs. */
 786     if (memcmp(ccm->maid, cfm->maid, sizeof ccm->maid)) {
 787         cfm->recv_fault |= CFM_FAULT_MAID;
 788         VLOG_WARN_RL(&rl, "%s: Received unexpected remote MAID from MAC "
 789                      ETH_ADDR_FMT, cfm->name, ETH_ADDR_ARGS(eth->eth_src));
 790     } else {
 791         uint8_t ccm_interval = ccm->flags & 0x7;
 792         bool ccm_rdi = ccm->flags & CCM_RDI_MASK;
 793         uint16_t ccm_interval_ms_x = ntohs(ccm->interval_ms_x);
 794
 795         struct remote_mp *rmp;
 796         uint64_t ccm_mpid;
 797         uint32_t ccm_seq;
 798         bool ccm_opdown;
 799         enum cfm_fault_reason cfm_fault = 0;
 800
 801         if (extended) {
 802             ccm_mpid = ntohll(ccm->mpid64);
 803             ccm_opdown = ccm->opdown;
 804         } else {
 805             ccm_mpid = ntohs(ccm->mpid);
 806             ccm_opdown = false;
 807         }
 808         ccm_seq = ntohl(ccm->seq);
 809
 810         if (ccm_interval != cfm->ccm_interval) {
 811             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected interval"
 812                          " (%"PRIu8") from RMP %"PRIu64, cfm->name,
 813                          ccm_interval, ccm_mpid);
 814         }
 815
 816         if (extended && ccm_interval == 0
 817             && ccm_interval_ms_x != cfm->ccm_interval_ms) {
 818             VLOG_WARN_RL(&rl, "%s: received a CCM with an unexpected extended"
 819                          " interval (%"PRIu16"ms) from RMP %"PRIu64, cfm->name,
 820                          ccm_interval_ms_x, ccm_mpid);
 821         }
 822
 823         rmp = lookup_remote_mp(cfm, ccm_mpid);
 824         if (!rmp) {
 825             if (hmap_count(&cfm->remote_mps) < CFM_MAX_RMPS) {
 826                 rmp = xzalloc(sizeof *rmp);
 827                 hmap_insert(&cfm->remote_mps, &rmp->node, hash_mpid(ccm_mpid));
 828             } else {
 829                 cfm_fault |= CFM_FAULT_OVERFLOW;
 830                 VLOG_WARN_RL(&rl,
 831                              "%s: dropped CCM with MPID %"PRIu64" from MAC "
 832                              ETH_ADDR_FMT, cfm->name, ccm_mpid,
 833                              ETH_ADDR_ARGS(eth->eth_src));
 834             }
 835         }
 836
 837         if (ccm_rdi) {
 838             cfm_fault |= CFM_FAULT_RDI;
 839             VLOG_DBG("%s: RDI bit flagged from RMP %"PRIu64, cfm->name,
 840                      ccm_mpid);
 841         }
 842
 843         VLOG_DBG("%s: received CCM (seq %"PRIu32") (mpid %"PRIu64")"
 844                  " (interval %"PRIu8") (RDI %s)", cfm->name, ccm_seq,
 845                  ccm_mpid, ccm_interval, ccm_rdi ? "true" : "false");
 846
 847         if (rmp) {
 848             if (rmp->mpid == cfm->mpid) {
 849                 cfm_fault |= CFM_FAULT_LOOPBACK;
 850                 VLOG_WARN_RL(&rl,"%s: received CCM with local MPID"
 851                              " %"PRIu64, cfm->name, rmp->mpid);
 852             }
 853
 854             if (rmp->seq && ccm_seq != (rmp->seq + 1)) {
 855                 VLOG_WARN_RL(&rl, "%s: (mpid %"PRIu64") detected sequence"
 856                              " numbers which indicate possible connectivity"
 857                              " problems (previous %"PRIu32") (current %"PRIu32
 858                              ")", cfm->name, ccm_mpid, rmp->seq, ccm_seq);
 859             }
 860
 861             rmp->mpid = ccm_mpid;
 862             if (!cfm_fault) {
 863                 rmp->num_health_ccm++;
 864                 if (cfm->demand) {
 865                     timer_set_duration(&cfm->demand_rx_ccm_t,
 866                                        100 * cfm->ccm_interval_ms);
 867                 }
 868             }
 869             rmp->recv = true;
 870             cfm->recv_fault |= cfm_fault;
 871             rmp->seq = ccm_seq;
 872             rmp->opup = !ccm_opdown;
 873             rmp->last_rx = time_msec();
 874         }
 875     }
 876
 877 out:
 878     ovs_mutex_unlock(&mutex);
 879 }
 880
 881 /* Returns and resets the 'cfm->status_changed'. */
 882 bool
 883 cfm_check_status_change(struct cfm *cfm) OVS_EXCLUDED(mutex)
 884 {
 885     bool ret;
 886
 887     ovs_mutex_lock(&mutex);
 888     ret = cfm->status_changed;
 889     cfm->status_changed = false;
 890     ovs_mutex_unlock(&mutex);
 891
 892     return ret;
 893 }
 894
 895 static int
 896 cfm_get_fault__(const struct cfm *cfm) OVS_REQUIRES(mutex)
 897 {
 898     if (cfm->fault_override >= 0) {
 899         return cfm->fault_override ? CFM_FAULT_OVERRIDE : 0;
 900     }
 901     return cfm->fault;
 902 }
 903
 904 /* Gets the fault status of 'cfm'.  Returns a bit mask of 'cfm_fault_reason's
 905  * indicating the cause of the connectivity fault, or zero if there is no
 906  * fault. */
 907 int
 908 cfm_get_fault(const struct cfm *cfm) OVS_EXCLUDED(mutex)
 909 {
 910     int fault;
 911
 912     ovs_mutex_lock(&mutex);
 913     fault = cfm_get_fault__(cfm);
 914     ovs_mutex_unlock(&mutex);
 915     return fault;
 916 }
 917
 918 /* Gets the number of cfm fault flapping since start. */
 919 uint64_t
 920 cfm_get_flap_count(const struct cfm *cfm) OVS_EXCLUDED(mutex)
 921 {
 922     uint64_t flap_count;
 923     ovs_mutex_lock(&mutex);
 924     flap_count = cfm->flap_count;
 925     ovs_mutex_unlock(&mutex);
 926     return flap_count;
 927 }
 928
 929 /* Gets the health of 'cfm'.  Returns an integer between 0 and 100 indicating
 930  * the health of the link as a percentage of ccm frames received in
 931  * CFM_HEALTH_INTERVAL * 'fault_interval' if there is only 1 remote_mpid,
 932  * returns 0 if there are no remote_mpids, and returns -1 if there are more
 933  * than 1 remote_mpids. */
 934 int
 935 cfm_get_health(const struct cfm *cfm) OVS_EXCLUDED(mutex)
 936 {
 937     int health;
 938
 939     ovs_mutex_lock(&mutex);
 940     health = cfm->health;
 941     ovs_mutex_unlock(&mutex);
 942     return health;
 943 }
 944
 945 static int
 946 cfm_get_opup__(const struct cfm *cfm_) OVS_REQUIRES(mutex)
 947 {
 948     struct cfm *cfm = CONST_CAST(struct cfm *, cfm_);
 949     bool extended;
 950
 951     atomic_read_relaxed(&cfm->extended, &extended);
 952
 953     return extended ? cfm->remote_opup : -1;
 954 }
 955
 956 /* Gets the operational state of 'cfm'.  'cfm' is considered operationally down
 957  * if it has received a CCM with the operationally down bit set from any of its
 958  * remote maintenance points. Returns 1 if 'cfm' is operationally up, 0 if
 959  * 'cfm' is operationally down, or -1 if 'cfm' has no operational state
 960  * (because it isn't in extended mode). */
 961 int
 962 cfm_get_opup(const struct cfm *cfm) OVS_EXCLUDED(mutex)
 963 {
 964     int opup;
 965
 966     ovs_mutex_lock(&mutex);
 967     opup = cfm_get_opup__(cfm);
 968     ovs_mutex_unlock(&mutex);
 969
 970     return opup;
 971 }
 972
 973 static void
 974 cfm_get_remote_mpids__(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
 975     OVS_REQUIRES(mutex)
 976 {
 977     *rmps = xmemdup(cfm->rmps_array, cfm->rmps_array_len * sizeof **rmps);
 978     *n_rmps = cfm->rmps_array_len;
 979 }
 980
 981 /* Populates 'rmps' with an array of remote maintenance points reachable by
 982  * 'cfm'. The number of remote maintenance points is written to 'n_rmps'.
 983  * 'cfm' retains ownership of the array written to 'rmps' */
 984 void
 985 cfm_get_remote_mpids(const struct cfm *cfm, uint64_t **rmps, size_t *n_rmps)
 986     OVS_EXCLUDED(mutex)
 987 {
 988     ovs_mutex_lock(&mutex);
 989     cfm_get_remote_mpids__(cfm, rmps, n_rmps);
 990     ovs_mutex_unlock(&mutex);
 991 }
 992
 993 /* Extracts the status of 'cfm' and fills in the 's'. */
 994 void
 995 cfm_get_status(const struct cfm *cfm, struct cfm_status *s) OVS_EXCLUDED(mutex)
 996 {
 997     ovs_mutex_lock(&mutex);
 998     s->faults = cfm_get_fault__(cfm);
 999     s->remote_opstate = cfm_get_opup__(cfm);
1000     s->flap_count = cfm->flap_count;
1001     s->health = cfm->health;
1002     cfm_get_remote_mpids__(cfm, &s->rmps, &s->n_rmps);
1003     ovs_mutex_unlock(&mutex);
1004 }
1005
1006 static struct cfm *
1007 cfm_find(const char *name) OVS_REQUIRES(mutex)
1008 {
1009     struct cfm *cfm;
1010
1011     HMAP_FOR_EACH_WITH_HASH (cfm, hmap_node, hash_string(name, 0), all_cfms) {
1012         if (!strcmp(cfm->name, name)) {
1013             return cfm;
1014         }
1015     }
1016     return NULL;
1017 }
1018
1019 static void
1020 cfm_print_details(struct ds *ds, struct cfm *cfm) OVS_REQUIRES(mutex)
1021 {
1022     struct remote_mp *rmp;
1023     bool extended;
1024     int fault;
1025
1026     atomic_read_relaxed(&cfm->extended, &extended);
1027
1028     ds_put_format(ds, "---- %s ----\n", cfm->name);
1029     ds_put_format(ds, "MPID %"PRIu64":%s%s\n", cfm->mpid,
1030                   extended ? " extended" : "",
1031                   cfm->fault_override >= 0 ? " fault_override" : "");
1032
1033     fault = cfm_get_fault__(cfm);
1034     if (fault) {
1035         ds_put_cstr(ds, "\tfault: ");
1036         ds_put_cfm_fault(ds, fault);
1037         ds_put_cstr(ds, "\n");
1038     }
1039
1040     if (cfm->health == -1) {
1041         ds_put_format(ds, "\taverage health: undefined\n");
1042     } else {
1043         ds_put_format(ds, "\taverage health: %d\n", cfm->health);
1044     }
1045     ds_put_format(ds, "\topstate: %s\n", cfm->opup ? "up" : "down");
1046     ds_put_format(ds, "\tremote_opstate: %s\n",
1047                   cfm->remote_opup ? "up" : "down");
1048     ds_put_format(ds, "\tinterval: %dms\n", cfm->ccm_interval_ms);
1049     ds_put_format(ds, "\tnext CCM tx: %lldms\n",
1050                   timer_msecs_until_expired(&cfm->tx_timer));
1051     ds_put_format(ds, "\tnext fault check: %lldms\n",
1052                   timer_msecs_until_expired(&cfm->fault_timer));
1053
1054     HMAP_FOR_EACH (rmp, node, &cfm->remote_mps) {
1055         ds_put_format(ds, "Remote MPID %"PRIu64"\n", rmp->mpid);
1056         ds_put_format(ds, "\trecv since check: %s\n",
1057                       rmp->recv ? "true" : "false");
1058         ds_put_format(ds, "\topstate: %s\n", rmp->opup? "up" : "down");
1059     }
1060 }
1061
1062 static void
1063 cfm_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
1064                  void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1065 {
1066     struct ds ds = DS_EMPTY_INITIALIZER;
1067     struct cfm *cfm;
1068
1069     ovs_mutex_lock(&mutex);
1070     if (argc > 1) {
1071         cfm = cfm_find(argv[1]);
1072         if (!cfm) {
1073             unixctl_command_reply_error(conn, "no such CFM object");
1074             goto out;
1075         }
1076         cfm_print_details(&ds, cfm);
1077     } else {
1078         HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
1079             cfm_print_details(&ds, cfm);
1080         }
1081     }
1082
1083     unixctl_command_reply(conn, ds_cstr(&ds));
1084     ds_destroy(&ds);
1085 out:
1086     ovs_mutex_unlock(&mutex);
1087 }
1088
1089 static void
1090 cfm_unixctl_set_fault(struct unixctl_conn *conn, int argc, const char *argv[],
1091                       void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1092 {
1093     const char *fault_str = argv[argc - 1];
1094     int fault_override;
1095     struct cfm *cfm;
1096
1097     ovs_mutex_lock(&mutex);
1098     if (!strcasecmp("true", fault_str)) {
1099         fault_override = 1;
1100     } else if (!strcasecmp("false", fault_str)) {
1101         fault_override = 0;
1102     } else if (!strcasecmp("normal", fault_str)) {
1103         fault_override = -1;
1104     } else {
1105         unixctl_command_reply_error(conn, "unknown fault string");
1106         goto out;
1107     }
1108
1109     if (argc > 2) {
1110         cfm = cfm_find(argv[1]);
1111         if (!cfm) {
1112             unixctl_command_reply_error(conn, "no such CFM object");
1113             goto out;
1114         }
1115         cfm->fault_override = fault_override;
1116         cfm_status_changed(cfm);
1117     } else {
1118         HMAP_FOR_EACH (cfm, hmap_node, all_cfms) {
1119             cfm->fault_override = fault_override;
1120             cfm_status_changed(cfm);
1121         }
1122     }
1123
1124     unixctl_command_reply(conn, "OK");
1125
1126 out:
1127     ovs_mutex_unlock(&mutex);
1128 }