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