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