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