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