lib/cfm.c

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