lib/bfd.c

   1 /* Copyright (c) 2013 Nicira, Inc.
   2  *
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License. */
  14
  15 #include <config.h>
  16 #include "bfd.h"
  17
  18 #include <sys/types.h>
  19 #include <arpa/inet.h>
  20 #include <netinet/in_systm.h>
  21 #include <netinet/ip.h>
  22
  23 #include "byte-order.h"
  24 #include "connectivity.h"
  25 #include "csum.h"
  26 #include "dpif.h"
  27 #include "dynamic-string.h"
  28 #include "flow.h"
  29 #include "hash.h"
  30 #include "hmap.h"
  31 #include "list.h"
  32 #include "netdev.h"
  33 #include "netlink.h"
  34 #include "odp-util.h"
  35 #include "ofpbuf.h"
  36 #include "ovs-thread.h"
  37 #include "openvswitch/types.h"
  38 #include "packets.h"
  39 #include "poll-loop.h"
  40 #include "random.h"
  41 #include "seq.h"
  42 #include "smap.h"
  43 #include "timeval.h"
  44 #include "unaligned.h"
  45 #include "unixctl.h"
  46 #include "util.h"
  47 #include "vlog.h"
  48
  49 VLOG_DEFINE_THIS_MODULE(bfd);
  50
  51 /* XXX Finish BFD.
  52  *
  53  * The goal of this module is to replace CFM with something both more flexible
  54  * and standards compliant.  In service of this goal, the following needs to be
  55  * done.
  56  *
  57  * - Compliance
  58  *   * Implement Demand mode.
  59  *   * Go through the RFC line by line and verify we comply.
  60  *   * Test against a hardware implementation.  Preferably a popular one.
  61  *   * Delete BFD packets with nw_ttl != 255 in the datapath to prevent DOS
  62  *     attacks.
  63  *
  64  * - Unit tests.
  65  *
  66  * - Set TOS/PCP on the outer tunnel header when encapped.
  67  *
  68  * - Sending BFD messages should be in its own thread/process.
  69  *
  70  * - Scale testing.  How does it operate when there are large number of bfd
  71  *   sessions?  Do we ever have random flaps?  What's the CPU utilization?
  72  *
  73  * - Rely on data traffic for liveness by using BFD demand mode.
  74  *   If we're receiving traffic on a port, we can safely assume it's up (modulo
  75  *   unidrectional failures).  BFD has a demand mode in which it can stay quiet
  76  *   unless it feels the need to check the status of the port.  Using this, we
  77  *   can implement a strategy in which BFD only sends control messages on dark
  78  *   interfaces.
  79  *
  80  * - Depending on how one interprets the spec, it appears that a BFD session
  81  *   can never change bfd.LocalDiag to "No Diagnostic".  We should verify that
  82  *   this is what hardware implementations actually do.  Seems like "No
  83  *   Diagnostic" should be set once a BFD session state goes UP. */
  84
  85 #define BFD_VERSION 1
  86
  87 enum flags {
  88     FLAG_MULTIPOINT = 1 << 0,
  89     FLAG_DEMAND = 1 << 1,
  90     FLAG_AUTH = 1 << 2,
  91     FLAG_CTL = 1 << 3,
  92     FLAG_FINAL = 1 << 4,
  93     FLAG_POLL = 1 << 5
  94 };
  95
  96 enum state {
  97     STATE_ADMIN_DOWN = 0 << 6,
  98     STATE_DOWN = 1 << 6,
  99     STATE_INIT = 2 << 6,
 100     STATE_UP = 3 << 6
 101 };
 102
 103 enum diag {
 104     DIAG_NONE = 0,                /* No Diagnostic. */
 105     DIAG_EXPIRED = 1,             /* Control Detection Time Expired. */
 106     DIAG_ECHO_FAILED = 2,         /* Echo Function Failed. */
 107     DIAG_RMT_DOWN = 3,            /* Neighbor Signaled Session Down. */
 108     DIAG_FWD_RESET = 4,           /* Forwarding Plane Reset. */
 109     DIAG_PATH_DOWN = 5,           /* Path Down. */
 110     DIAG_CPATH_DOWN = 6,          /* Concatenated Path Down. */
 111     DIAG_ADMIN_DOWN = 7,          /* Administratively Down. */
 112     DIAG_RCPATH_DOWN = 8          /* Reverse Concatenated Path Down. */
 113 };
 114
 115 /* RFC 5880 Section 4.1
 116  *  0                   1                   2                   3
 117  *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 118  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 119  * |Vers |  Diag   |Sta|P|F|C|A|D|M|  Detect Mult  |    Length     |
 120  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 121  * |                       My Discriminator                        |
 122  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 123  * |                      Your Discriminator                       |
 124  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 125  * |                    Desired Min TX Interval                    |
 126  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 127  * |                   Required Min RX Interval                    |
 128  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 129  * |                 Required Min Echo RX Interval                 |
 130  * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */
 131 struct msg {
 132     uint8_t vers_diag;    /* Version and diagnostic. */
 133     uint8_t flags;        /* 2bit State field followed by flags. */
 134     uint8_t mult;         /* Fault detection multiplier. */
 135     uint8_t length;       /* Length of this BFD message. */
 136     ovs_be32 my_disc;     /* My discriminator. */
 137     ovs_be32 your_disc;   /* Your discriminator. */
 138     ovs_be32 min_tx;      /* Desired minimum tx interval. */
 139     ovs_be32 min_rx;      /* Required minimum rx interval. */
 140     ovs_be32 min_rx_echo; /* Required minimum echo rx interval. */
 141 };
 142 BUILD_ASSERT_DECL(BFD_PACKET_LEN == sizeof(struct msg));
 143
 144 #define DIAG_MASK 0x1f
 145 #define VERS_SHIFT 5
 146 #define STATE_MASK 0xC0
 147 #define FLAGS_MASK 0x3f
 148
 149 struct bfd {
 150     struct hmap_node node;        /* In 'all_bfds'. */
 151     uint32_t disc;                /* bfd.LocalDiscr. Key in 'all_bfds' hmap. */
 152
 153     char *name;                   /* Name used for logging. */
 154
 155     bool cpath_down;              /* Concatenated Path Down. */
 156     uint8_t mult;                 /* bfd.DetectMult. */
 157
 158     struct netdev *netdev;
 159     uint64_t rx_packets;          /* Packets received by 'netdev'. */
 160
 161     enum state state;             /* bfd.SessionState. */
 162     enum state rmt_state;         /* bfd.RemoteSessionState. */
 163
 164     enum diag diag;               /* bfd.LocalDiag. */
 165     enum diag rmt_diag;           /* Remote diagnostic. */
 166
 167     enum flags flags;             /* Flags sent on messages. */
 168     enum flags rmt_flags;         /* Flags last received. */
 169
 170     uint32_t rmt_disc;            /* bfd.RemoteDiscr. */
 171
 172     uint8_t eth_dst[ETH_ADDR_LEN];/* Ethernet destination address. */
 173     bool eth_dst_set;             /* 'eth_dst' set through database. */
 174
 175     uint16_t udp_src;             /* UDP source port. */
 176
 177     /* All timers in milliseconds. */
 178     long long int rmt_min_rx;     /* bfd.RemoteMinRxInterval. */
 179     long long int rmt_min_tx;     /* Remote minimum TX interval. */
 180
 181     long long int cfg_min_tx;     /* Configured minimum TX rate. */
 182     long long int cfg_min_rx;     /* Configured required minimum RX rate. */
 183     long long int poll_min_tx;    /* Min TX negotating in a poll sequence. */
 184     long long int poll_min_rx;    /* Min RX negotating in a poll sequence. */
 185     long long int min_tx;         /* bfd.DesiredMinTxInterval. */
 186     long long int min_rx;         /* bfd.RequiredMinRxInterval. */
 187
 188     long long int last_tx;        /* Last TX time. */
 189     long long int next_tx;        /* Next TX time. */
 190     long long int detect_time;    /* RFC 5880 6.8.4 Detection time. */
 191
 192     bool last_forwarding;         /* Last calculation of forwarding flag. */
 193     int forwarding_override;      /* Manual override of 'forwarding' status. */
 194
 195     atomic_bool check_tnl_key;    /* Verify tunnel key of inbound packets? */
 196     atomic_int ref_cnt;
 197
 198     /* When forward_if_rx is true, bfd_forwarding() will return
 199      * true as long as there are incoming packets received.
 200      * Note, forwarding_override still has higher priority. */
 201     bool forwarding_if_rx;
 202     long long int forwarding_if_rx_detect_time;
 203
 204     /* BFD decay related variables. */
 205     bool in_decay;                /* True when bfd is in decay. */
 206     int decay_min_rx;             /* min_rx is set to decay_min_rx when */
 207                                   /* in decay. */
 208     int decay_rx_ctl;             /* Count bfd packets received within decay */
 209                                   /* detect interval. */
 210     uint64_t decay_rx_packets;    /* Packets received by 'netdev'. */
 211     long long int decay_detect_time; /* Decay detection time. */
 212
 213     uint64_t flap_count;          /* Counts bfd forwarding flaps. */
 214 };
 215
 216 static struct ovs_mutex mutex = OVS_MUTEX_INITIALIZER;
 217 static struct hmap all_bfds__ = HMAP_INITIALIZER(&all_bfds__);
 218 static struct hmap *const all_bfds OVS_GUARDED_BY(mutex) = &all_bfds__;
 219
 220 static bool bfd_forwarding__(struct bfd *) OVS_REQUIRES(mutex);
 221 static bool bfd_in_poll(const struct bfd *) OVS_REQUIRES(mutex);
 222 static void bfd_poll(struct bfd *bfd) OVS_REQUIRES(mutex);
 223 static const char *bfd_diag_str(enum diag) OVS_REQUIRES(mutex);
 224 static const char *bfd_state_str(enum state) OVS_REQUIRES(mutex);
 225 static long long int bfd_min_tx(const struct bfd *) OVS_REQUIRES(mutex);
 226 static long long int bfd_tx_interval(const struct bfd *)
 227     OVS_REQUIRES(mutex);
 228 static long long int bfd_rx_interval(const struct bfd *)
 229     OVS_REQUIRES(mutex);
 230 static void bfd_set_next_tx(struct bfd *) OVS_REQUIRES(mutex);
 231 static void bfd_set_state(struct bfd *, enum state, enum diag)
 232     OVS_REQUIRES(mutex);
 233 static uint32_t generate_discriminator(void) OVS_REQUIRES(mutex);
 234 static void bfd_put_details(struct ds *, const struct bfd *)
 235     OVS_REQUIRES(mutex);
 236 static uint64_t bfd_rx_packets(const struct bfd *) OVS_REQUIRES(mutex);
 237 static void bfd_try_decay(struct bfd *) OVS_REQUIRES(mutex);
 238 static void bfd_decay_update(struct bfd *) OVS_REQUIRES(mutex);
 239
 240 static void bfd_forwarding_if_rx_update(struct bfd *) OVS_REQUIRES(mutex);
 241 static void bfd_unixctl_show(struct unixctl_conn *, int argc,
 242                              const char *argv[], void *aux OVS_UNUSED);
 243 static void bfd_unixctl_set_forwarding_override(struct unixctl_conn *,
 244                                                 int argc, const char *argv[],
 245                                                 void *aux OVS_UNUSED);
 246 static void log_msg(enum vlog_level, const struct msg *, const char *message,
 247                     const struct bfd *) OVS_REQUIRES(mutex);
 248
 249 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 20);
 250
 251 /* Returns true if the interface on which 'bfd' is running may be used to
 252  * forward traffic according to the BFD session state. */
 253 bool
 254 bfd_forwarding(struct bfd *bfd) OVS_EXCLUDED(mutex)
 255 {
 256     bool ret;
 257
 258     ovs_mutex_lock(&mutex);
 259     ret = bfd_forwarding__(bfd);
 260     ovs_mutex_unlock(&mutex);
 261     return ret;
 262 }
 263
 264 /* When forwarding_if_rx is enabled, if there are packets received,
 265  * updates forwarding_if_rx_detect_time. */
 266 void
 267 bfd_account_rx(struct bfd *bfd, const struct dpif_flow_stats *stats)
 268 {
 269     if (stats->n_packets && bfd->forwarding_if_rx) {
 270         ovs_mutex_lock(&mutex);
 271         bfd_forwarding__(bfd);
 272         bfd_forwarding_if_rx_update(bfd);
 273         bfd_forwarding__(bfd);
 274         ovs_mutex_unlock(&mutex);
 275     }
 276 }
 277
 278 /* Returns a 'smap' of key value pairs representing the status of 'bfd'
 279  * intended for the OVS database. */
 280 void
 281 bfd_get_status(const struct bfd *bfd, struct smap *smap)
 282     OVS_EXCLUDED(mutex)
 283 {
 284     ovs_mutex_lock(&mutex);
 285     smap_add(smap, "forwarding",
 286              bfd_forwarding__(CONST_CAST(struct bfd *, bfd))
 287              ? "true" : "false");
 288     smap_add(smap, "state", bfd_state_str(bfd->state));
 289     smap_add(smap, "diagnostic", bfd_diag_str(bfd->diag));
 290     smap_add_format(smap, "flap_count", "%"PRIu64, bfd->flap_count);
 291
 292     if (bfd->state != STATE_DOWN) {
 293         smap_add(smap, "remote_state", bfd_state_str(bfd->rmt_state));
 294         smap_add(smap, "remote_diagnostic", bfd_diag_str(bfd->rmt_diag));
 295     }
 296     ovs_mutex_unlock(&mutex);
 297 }
 298
 299 /* Initializes, destroys, or reconfigures the BFD session 'bfd' (named 'name'),
 300  * according to the database configuration contained in 'cfg'.  Takes ownership
 301  * of 'bfd', which may be NULL.  Returns a BFD object which may be used as a
 302  * handle for the session, or NULL if BFD is not enabled according to 'cfg'.
 303  * Also returns NULL if cfg is NULL. */
 304 struct bfd *
 305 bfd_configure(struct bfd *bfd, const char *name, const struct smap *cfg,
 306               struct netdev *netdev) OVS_EXCLUDED(mutex)
 307 {
 308     static struct ovsthread_once once = OVSTHREAD_ONCE_INITIALIZER;
 309     static atomic_uint16_t udp_src = ATOMIC_VAR_INIT(0);
 310
 311     int decay_min_rx;
 312     long long int min_tx, min_rx;
 313     bool need_poll = false;
 314     bool cfg_min_rx_changed = false;
 315     bool cpath_down, forwarding_if_rx;
 316     const char *hwaddr;
 317     uint8_t ea[ETH_ADDR_LEN];
 318
 319     if (ovsthread_once_start(&once)) {
 320         unixctl_command_register("bfd/show", "[interface]", 0, 1,
 321                                  bfd_unixctl_show, NULL);
 322         unixctl_command_register("bfd/set-forwarding",
 323                                  "[interface] normal|false|true", 1, 2,
 324                                  bfd_unixctl_set_forwarding_override, NULL);
 325         ovsthread_once_done(&once);
 326     }
 327
 328     if (!cfg || !smap_get_bool(cfg, "enable", false)) {
 329         bfd_unref(bfd);
 330         return NULL;
 331     }
 332
 333     ovs_mutex_lock(&mutex);
 334     if (!bfd) {
 335         bfd = xzalloc(sizeof *bfd);
 336         bfd->name = xstrdup(name);
 337         bfd->forwarding_override = -1;
 338         bfd->disc = generate_discriminator();
 339         hmap_insert(all_bfds, &bfd->node, bfd->disc);
 340
 341         bfd->diag = DIAG_NONE;
 342         bfd->min_tx = 1000;
 343         bfd->mult = 3;
 344         atomic_init(&bfd->ref_cnt, 1);
 345         bfd->netdev = netdev_ref(netdev);
 346         bfd->rx_packets = bfd_rx_packets(bfd);
 347         bfd->in_decay = false;
 348         bfd->flap_count = 0;
 349
 350         /* RFC 5881 section 4
 351          * The source port MUST be in the range 49152 through 65535.  The same
 352          * UDP source port number MUST be used for all BFD Control packets
 353          * associated with a particular session.  The source port number SHOULD
 354          * be unique among all BFD sessions on the system. */
 355         atomic_add(&udp_src, 1, &bfd->udp_src);
 356         bfd->udp_src = (bfd->udp_src % 16384) + 49152;
 357
 358         bfd_set_state(bfd, STATE_DOWN, DIAG_NONE);
 359
 360         memcpy(bfd->eth_dst, eth_addr_bfd, ETH_ADDR_LEN);
 361     }
 362
 363     atomic_store(&bfd->check_tnl_key,
 364                  smap_get_bool(cfg, "check_tnl_key", false));
 365     min_tx = smap_get_int(cfg, "min_tx", 100);
 366     min_tx = MAX(min_tx, 100);
 367     if (bfd->cfg_min_tx != min_tx) {
 368         bfd->cfg_min_tx = min_tx;
 369         if (bfd->state != STATE_UP
 370             || (!bfd_in_poll(bfd) && bfd->cfg_min_tx < bfd->min_tx)) {
 371             bfd->min_tx = bfd->cfg_min_tx;
 372         }
 373         need_poll = true;
 374     }
 375
 376     min_rx = smap_get_int(cfg, "min_rx", 1000);
 377     min_rx = MAX(min_rx, 100);
 378     if (bfd->cfg_min_rx != min_rx) {
 379         bfd->cfg_min_rx = min_rx;
 380         if (bfd->state != STATE_UP
 381             || (!bfd_in_poll(bfd) && bfd->cfg_min_rx > bfd->min_rx)) {
 382             bfd->min_rx = bfd->cfg_min_rx;
 383         }
 384         cfg_min_rx_changed = true;
 385         need_poll = true;
 386     }
 387
 388     decay_min_rx = smap_get_int(cfg, "decay_min_rx", 0);
 389     if (bfd->decay_min_rx != decay_min_rx || cfg_min_rx_changed) {
 390         if (decay_min_rx > 0 && decay_min_rx < bfd->cfg_min_rx) {
 391             VLOG_WARN("%s: decay_min_rx cannot be less than %lld ms",
 392                       bfd->name, bfd->cfg_min_rx);
 393             bfd->decay_min_rx = 0;
 394         } else {
 395             bfd->decay_min_rx = decay_min_rx;
 396         }
 397         /* Resets decay. */
 398         bfd->in_decay = false;
 399         bfd_decay_update(bfd);
 400         need_poll = true;
 401     }
 402
 403     cpath_down = smap_get_bool(cfg, "cpath_down", false);
 404     if (bfd->cpath_down != cpath_down) {
 405         bfd->cpath_down = cpath_down;
 406         if (bfd->diag == DIAG_NONE || bfd->diag == DIAG_CPATH_DOWN) {
 407             bfd_set_state(bfd, bfd->state, DIAG_NONE);
 408         }
 409         need_poll = true;
 410     }
 411
 412     hwaddr = smap_get(cfg, "bfd_dst_mac");
 413     if (hwaddr && eth_addr_from_string(hwaddr, ea) && !eth_addr_is_zero(ea)) {
 414         memcpy(bfd->eth_dst, ea, ETH_ADDR_LEN);
 415         bfd->eth_dst_set = true;
 416     } else if (bfd->eth_dst_set) {
 417         memcpy(bfd->eth_dst, eth_addr_bfd, ETH_ADDR_LEN);
 418         bfd->eth_dst_set = false;
 419     }
 420
 421     forwarding_if_rx = smap_get_bool(cfg, "forwarding_if_rx", false);
 422     if (bfd->forwarding_if_rx != forwarding_if_rx) {
 423         bfd->forwarding_if_rx = forwarding_if_rx;
 424         if (bfd->state == STATE_UP && bfd->forwarding_if_rx) {
 425             bfd_forwarding_if_rx_update(bfd);
 426         } else {
 427             bfd->forwarding_if_rx_detect_time = 0;
 428         }
 429     }
 430
 431     if (need_poll) {
 432         bfd_poll(bfd);
 433     }
 434     ovs_mutex_unlock(&mutex);
 435     return bfd;
 436 }
 437
 438 struct bfd *
 439 bfd_ref(const struct bfd *bfd_)
 440 {
 441     struct bfd *bfd = CONST_CAST(struct bfd *, bfd_);
 442     if (bfd) {
 443         int orig;
 444         atomic_add(&bfd->ref_cnt, 1, &orig);
 445         ovs_assert(orig > 0);
 446     }
 447     return bfd;
 448 }
 449
 450 void
 451 bfd_unref(struct bfd *bfd) OVS_EXCLUDED(mutex)
 452 {
 453     if (bfd) {
 454         int orig;
 455
 456         atomic_sub(&bfd->ref_cnt, 1, &orig);
 457         ovs_assert(orig > 0);
 458         if (orig == 1) {
 459             ovs_mutex_lock(&mutex);
 460             hmap_remove(all_bfds, &bfd->node);
 461             netdev_close(bfd->netdev);
 462             free(bfd->name);
 463             atomic_destroy(&bfd->ref_cnt);
 464             free(bfd);
 465             ovs_mutex_unlock(&mutex);
 466         }
 467     }
 468 }
 469
 470 void
 471 bfd_wait(const struct bfd *bfd) OVS_EXCLUDED(mutex)
 472 {
 473     poll_timer_wait_until(bfd_wake_time(bfd));
 474 }
 475
 476 /* Returns the next wake up time. */
 477 long long int
 478 bfd_wake_time(const struct bfd *bfd) OVS_EXCLUDED(mutex)
 479 {
 480     long long int retval;
 481
 482     if (!bfd) {
 483         return LLONG_MAX;
 484     }
 485
 486     ovs_mutex_lock(&mutex);
 487     if (bfd->flags & FLAG_FINAL) {
 488         retval = 0;
 489     } else {
 490         retval = bfd->next_tx;
 491         if (bfd->state > STATE_DOWN) {
 492             retval = MIN(bfd->detect_time, retval);
 493         }
 494     }
 495     ovs_mutex_unlock(&mutex);
 496     return retval;
 497 }
 498
 499 void
 500 bfd_run(struct bfd *bfd) OVS_EXCLUDED(mutex)
 501 {
 502     long long int now;
 503     bool old_in_decay;
 504
 505     ovs_mutex_lock(&mutex);
 506     now = time_msec();
 507     old_in_decay = bfd->in_decay;
 508
 509     if (bfd->state > STATE_DOWN && now >= bfd->detect_time) {
 510         bfd_set_state(bfd, STATE_DOWN, DIAG_EXPIRED);
 511     }
 512     bfd_forwarding__(bfd);
 513
 514     /* Decay may only happen when state is STATE_UP, bfd->decay_min_rx is
 515      * configured, and decay_detect_time is reached. */
 516     if (bfd->state == STATE_UP && bfd->decay_min_rx > 0
 517         && now >= bfd->decay_detect_time) {
 518         bfd_try_decay(bfd);
 519     }
 520
 521     if (bfd->min_tx != bfd->cfg_min_tx
 522         || (bfd->min_rx != bfd->cfg_min_rx && bfd->min_rx != bfd->decay_min_rx)
 523         || bfd->in_decay != old_in_decay) {
 524         bfd_poll(bfd);
 525     }
 526     ovs_mutex_unlock(&mutex);
 527 }
 528
 529 bool
 530 bfd_should_send_packet(const struct bfd *bfd) OVS_EXCLUDED(mutex)
 531 {
 532     bool ret;
 533     ovs_mutex_lock(&mutex);
 534     ret = bfd->flags & FLAG_FINAL || time_msec() >= bfd->next_tx;
 535     ovs_mutex_unlock(&mutex);
 536     return ret;
 537 }
 538
 539 void
 540 bfd_put_packet(struct bfd *bfd, struct ofpbuf *p,
 541                uint8_t eth_src[ETH_ADDR_LEN]) OVS_EXCLUDED(mutex)
 542 {
 543     long long int min_tx, min_rx;
 544     struct udp_header *udp;
 545     struct eth_header *eth;
 546     struct ip_header *ip;
 547     struct msg *msg;
 548
 549     ovs_mutex_lock(&mutex);
 550     if (bfd->next_tx) {
 551         long long int delay = time_msec() - bfd->next_tx;
 552         long long int interval = bfd_tx_interval(bfd);
 553         if (delay > interval * 3 / 2) {
 554             VLOG_INFO("%s: long delay of %lldms (expected %lldms) sending BFD"
 555                       " control message", bfd->name, delay, interval);
 556         }
 557     }
 558
 559     /* RFC 5880 Section 6.5
 560      * A BFD Control packet MUST NOT have both the Poll (P) and Final (F) bits
 561      * set. */
 562     ovs_assert(!(bfd->flags & FLAG_POLL) || !(bfd->flags & FLAG_FINAL));
 563
 564     ofpbuf_reserve(p, 2); /* Properly align after the ethernet header. */
 565     eth = ofpbuf_put_uninit(p, sizeof *eth);
 566     memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
 567     memcpy(eth->eth_dst, bfd->eth_dst, ETH_ADDR_LEN);
 568     eth->eth_type = htons(ETH_TYPE_IP);
 569
 570     ip = ofpbuf_put_zeros(p, sizeof *ip);
 571     ip->ip_ihl_ver = IP_IHL_VER(5, 4);
 572     ip->ip_tot_len = htons(sizeof *ip + sizeof *udp + sizeof *msg);
 573     ip->ip_ttl = MAXTTL;
 574     ip->ip_tos = IPTOS_LOWDELAY | IPTOS_THROUGHPUT;
 575     ip->ip_proto = IPPROTO_UDP;
 576     /* Use link local addresses: */
 577     put_16aligned_be32(&ip->ip_src, htonl(0xA9FE0100)); /* 169.254.1.0. */
 578     put_16aligned_be32(&ip->ip_dst, htonl(0xA9FE0101)); /* 169.254.1.1. */
 579     ip->ip_csum = csum(ip, sizeof *ip);
 580
 581     udp = ofpbuf_put_zeros(p, sizeof *udp);
 582     udp->udp_src = htons(bfd->udp_src);
 583     udp->udp_dst = htons(BFD_DEST_PORT);
 584     udp->udp_len = htons(sizeof *udp + sizeof *msg);
 585
 586     msg = ofpbuf_put_uninit(p, sizeof *msg);
 587     msg->vers_diag = (BFD_VERSION << 5) | bfd->diag;
 588     msg->flags = (bfd->state & STATE_MASK) | bfd->flags;
 589
 590     msg->mult = bfd->mult;
 591     msg->length = BFD_PACKET_LEN;
 592     msg->my_disc = htonl(bfd->disc);
 593     msg->your_disc = htonl(bfd->rmt_disc);
 594     msg->min_rx_echo = htonl(0);
 595
 596     if (bfd_in_poll(bfd)) {
 597         min_tx = bfd->poll_min_tx;
 598         min_rx = bfd->poll_min_rx;
 599     } else {
 600         min_tx = bfd_min_tx(bfd);
 601         min_rx = bfd->min_rx;
 602     }
 603
 604     msg->min_tx = htonl(min_tx * 1000);
 605     msg->min_rx = htonl(min_rx * 1000);
 606
 607     bfd->flags &= ~FLAG_FINAL;
 608
 609     log_msg(VLL_DBG, msg, "Sending BFD Message", bfd);
 610
 611     bfd->last_tx = time_msec();
 612     bfd_set_next_tx(bfd);
 613     ovs_mutex_unlock(&mutex);
 614 }
 615
 616 bool
 617 bfd_should_process_flow(const struct bfd *bfd_, const struct flow *flow,
 618                         struct flow_wildcards *wc)
 619 {
 620     struct bfd *bfd = CONST_CAST(struct bfd *, bfd_);
 621     bool check_tnl_key;
 622
 623     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 624     if (bfd->eth_dst_set && memcmp(bfd->eth_dst, flow->dl_dst, ETH_ADDR_LEN)) {
 625         return false;
 626     }
 627
 628     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 629     memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 630
 631     atomic_read(&bfd->check_tnl_key, &check_tnl_key);
 632     if (check_tnl_key) {
 633         memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
 634     }
 635     return (flow->dl_type == htons(ETH_TYPE_IP)
 636             && flow->nw_proto == IPPROTO_UDP
 637             && flow->tp_dst == htons(BFD_DEST_PORT)
 638             && (!check_tnl_key || flow->tunnel.tun_id == htonll(0)));
 639 }
 640
 641 void
 642 bfd_process_packet(struct bfd *bfd, const struct flow *flow,
 643                    const struct ofpbuf *p) OVS_EXCLUDED(mutex)
 644 {
 645     uint32_t rmt_min_rx, pkt_your_disc;
 646     enum state rmt_state;
 647     enum flags flags;
 648     uint8_t version;
 649     struct msg *msg;
 650
 651     /* This function is designed to follow section RFC 5880 6.8.6 closely. */
 652
 653     ovs_mutex_lock(&mutex);
 654     /* Increments the decay rx counter. */
 655     bfd->decay_rx_ctl++;
 656
 657     bfd_forwarding__(bfd);
 658
 659     if (flow->nw_ttl != 255) {
 660         /* XXX Should drop in the kernel to prevent DOS. */
 661         goto out;
 662     }
 663
 664     msg = ofpbuf_at(p, (uint8_t *)p->l7 - (uint8_t *)p->data, BFD_PACKET_LEN);
 665     if (!msg) {
 666         VLOG_INFO_RL(&rl, "%s: Received too-short BFD control message (only "
 667                      "%"PRIdPTR" bytes long, at least %d required).",
 668                      bfd->name, (uint8_t *) ofpbuf_tail(p) - (uint8_t *) p->l7,
 669                      BFD_PACKET_LEN);
 670         goto out;
 671     }
 672
 673     /* RFC 5880 Section 6.8.6
 674      * If the Length field is greater than the payload of the encapsulating
 675      * protocol, the packet MUST be discarded.
 676      *
 677      * Note that we make this check implicity.  Above we use ofpbuf_at() to
 678      * ensure that there are at least BFD_PACKET_LEN bytes in the payload of
 679      * the encapsulating protocol.  Below we require msg->length to be exactly
 680      * BFD_PACKET_LEN bytes. */
 681
 682     flags = msg->flags & FLAGS_MASK;
 683     rmt_state = msg->flags & STATE_MASK;
 684     version = msg->vers_diag >> VERS_SHIFT;
 685
 686     log_msg(VLL_DBG, msg, "Received BFD control message", bfd);
 687
 688     if (version != BFD_VERSION) {
 689         log_msg(VLL_WARN, msg, "Incorrect version", bfd);
 690         goto out;
 691     }
 692
 693     /* Technically this should happen after the length check. We don't support
 694      * authentication however, so it's simpler to do the check first. */
 695     if (flags & FLAG_AUTH) {
 696         log_msg(VLL_WARN, msg, "Authenticated control message with"
 697                    " authentication disabled", bfd);
 698         goto out;
 699     }
 700
 701     if (msg->length != BFD_PACKET_LEN) {
 702         log_msg(VLL_WARN, msg, "Unexpected length", bfd);
 703         if (msg->length < BFD_PACKET_LEN) {
 704             goto out;
 705         }
 706     }
 707
 708     if (!msg->mult) {
 709         log_msg(VLL_WARN, msg, "Zero multiplier", bfd);
 710         goto out;
 711     }
 712
 713     if (flags & FLAG_MULTIPOINT) {
 714         log_msg(VLL_WARN, msg, "Unsupported multipoint flag", bfd);
 715         goto out;
 716     }
 717
 718     if (!msg->my_disc) {
 719         log_msg(VLL_WARN, msg, "NULL my_disc", bfd);
 720         goto out;
 721     }
 722
 723     pkt_your_disc = ntohl(msg->your_disc);
 724     if (pkt_your_disc) {
 725         /* Technically, we should use the your discriminator field to figure
 726          * out which 'struct bfd' this packet is destined towards.  That way a
 727          * bfd session could migrate from one interface to another
 728          * transparently.  This doesn't fit in with the OVS structure very
 729          * well, so in this respect, we are not compliant. */
 730        if (pkt_your_disc != bfd->disc) {
 731            log_msg(VLL_WARN, msg, "Incorrect your_disc", bfd);
 732            goto out;
 733        }
 734     } else if (rmt_state > STATE_DOWN) {
 735         log_msg(VLL_WARN, msg, "Null your_disc", bfd);
 736         goto out;
 737     }
 738
 739     if (bfd->rmt_state != rmt_state) {
 740         seq_change(connectivity_seq_get());
 741     }
 742
 743     bfd->rmt_disc = ntohl(msg->my_disc);
 744     bfd->rmt_state = rmt_state;
 745     bfd->rmt_flags = flags;
 746     bfd->rmt_diag = msg->vers_diag & DIAG_MASK;
 747
 748     if (flags & FLAG_FINAL && bfd_in_poll(bfd)) {
 749         bfd->min_tx = bfd->poll_min_tx;
 750         bfd->min_rx = bfd->poll_min_rx;
 751         bfd->flags &= ~FLAG_POLL;
 752         log_msg(VLL_INFO, msg, "Poll sequence terminated", bfd);
 753     }
 754
 755     if (flags & FLAG_POLL) {
 756         /* RFC 5880 Section 6.5
 757          * When the other system receives a Poll, it immediately transmits a
 758          * BFD Control packet with the Final (F) bit set, independent of any
 759          * periodic BFD Control packets it may be sending
 760          * (see section 6.8.7). */
 761         bfd->flags &= ~FLAG_POLL;
 762         bfd->flags |= FLAG_FINAL;
 763     }
 764
 765     rmt_min_rx = MAX(ntohl(msg->min_rx) / 1000, 1);
 766     if (bfd->rmt_min_rx != rmt_min_rx) {
 767         bfd->rmt_min_rx = rmt_min_rx;
 768         if (bfd->next_tx) {
 769             bfd_set_next_tx(bfd);
 770         }
 771         log_msg(VLL_INFO, msg, "New remote min_rx", bfd);
 772     }
 773
 774     bfd->rmt_min_tx = MAX(ntohl(msg->min_tx) / 1000, 1);
 775     bfd->detect_time = bfd_rx_interval(bfd) * bfd->mult + time_msec();
 776
 777     if (bfd->state == STATE_ADMIN_DOWN) {
 778         VLOG_DBG_RL(&rl, "Administratively down, dropping control message.");
 779         goto out;
 780     }
 781
 782     if (rmt_state == STATE_ADMIN_DOWN) {
 783         if (bfd->state != STATE_DOWN) {
 784             bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
 785         }
 786     } else {
 787         switch (bfd->state) {
 788         case STATE_DOWN:
 789             if (rmt_state == STATE_DOWN) {
 790                 bfd_set_state(bfd, STATE_INIT, bfd->diag);
 791             } else if (rmt_state == STATE_INIT) {
 792                 bfd_set_state(bfd, STATE_UP, bfd->diag);
 793             }
 794             break;
 795         case STATE_INIT:
 796             if (rmt_state > STATE_DOWN) {
 797                 bfd_set_state(bfd, STATE_UP, bfd->diag);
 798             }
 799             break;
 800         case STATE_UP:
 801             if (rmt_state <= STATE_DOWN) {
 802                 bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
 803                 log_msg(VLL_INFO, msg, "Remote signaled STATE_DOWN", bfd);
 804             }
 805             break;
 806         case STATE_ADMIN_DOWN:
 807         default:
 808             OVS_NOT_REACHED();
 809         }
 810     }
 811     /* XXX: RFC 5880 Section 6.8.6 Demand mode related calculations here. */
 812
 813 out:
 814     bfd_forwarding__(bfd);
 815     ovs_mutex_unlock(&mutex);
 816 }
 817
 818 /* Must be called when the netdev owned by 'bfd' should change. */
 819 void
 820 bfd_set_netdev(struct bfd *bfd, const struct netdev *netdev)
 821     OVS_EXCLUDED(mutex)
 822 {
 823     ovs_mutex_lock(&mutex);
 824     if (bfd->netdev != netdev) {
 825         netdev_close(bfd->netdev);
 826         bfd->netdev = netdev_ref(netdev);
 827         if (bfd->decay_min_rx && bfd->state == STATE_UP) {
 828             bfd_decay_update(bfd);
 829         }
 830         if (bfd->forwarding_if_rx && bfd->state == STATE_UP) {
 831             bfd_forwarding_if_rx_update(bfd);
 832         }
 833         bfd->rx_packets = bfd_rx_packets(bfd);
 834     }
 835     ovs_mutex_unlock(&mutex);
 836 }
 837
 838 \f
 839 /* Updates the forwarding flag.  If override is not configured and
 840  * the forwarding flag value changes, increments the flap count.
 841  *
 842  * Note this function may be called multiple times in a function
 843  * (e.g. bfd_account_rx) before and after the bfd state or status
 844  * change.  This is to capture any forwarding flag flap. */
 845 static bool
 846 bfd_forwarding__(struct bfd *bfd) OVS_REQUIRES(mutex)
 847 {
 848     long long int time;
 849     bool last_forwarding = bfd->last_forwarding;
 850
 851     if (bfd->forwarding_override != -1) {
 852         return bfd->forwarding_override == 1;
 853     }
 854
 855     time = bfd->forwarding_if_rx_detect_time;
 856     bfd->last_forwarding = (bfd->state == STATE_UP
 857                             || (bfd->forwarding_if_rx && time > time_msec()))
 858                             && bfd->rmt_diag != DIAG_PATH_DOWN
 859                             && bfd->rmt_diag != DIAG_CPATH_DOWN
 860                             && bfd->rmt_diag != DIAG_RCPATH_DOWN;
 861     if (bfd->last_forwarding != last_forwarding) {
 862         bfd->flap_count++;
 863         seq_change(connectivity_seq_get());
 864     }
 865     return bfd->last_forwarding;
 866 }
 867
 868 /* Helpers. */
 869 static bool
 870 bfd_in_poll(const struct bfd *bfd) OVS_REQUIRES(mutex)
 871 {
 872     return (bfd->flags & FLAG_POLL) != 0;
 873 }
 874
 875 static void
 876 bfd_poll(struct bfd *bfd) OVS_REQUIRES(mutex)
 877 {
 878     if (bfd->state > STATE_DOWN && !bfd_in_poll(bfd)
 879         && !(bfd->flags & FLAG_FINAL)) {
 880         bfd->poll_min_tx = bfd->cfg_min_tx;
 881         bfd->poll_min_rx = bfd->in_decay ? bfd->decay_min_rx : bfd->cfg_min_rx;
 882         bfd->flags |= FLAG_POLL;
 883         bfd->next_tx = 0;
 884         VLOG_INFO_RL(&rl, "%s: Initiating poll sequence", bfd->name);
 885     }
 886 }
 887
 888 static long long int
 889 bfd_min_tx(const struct bfd *bfd) OVS_REQUIRES(mutex)
 890 {
 891     /* RFC 5880 Section 6.8.3
 892      * When bfd.SessionState is not Up, the system MUST set
 893      * bfd.DesiredMinTxInterval to a value of not less than one second
 894      * (1,000,000 microseconds).  This is intended to ensure that the
 895      * bandwidth consumed by BFD sessions that are not Up is negligible,
 896      * particularly in the case where a neighbor may not be running BFD. */
 897     return (bfd->state == STATE_UP ? bfd->min_tx : MAX(bfd->min_tx, 1000));
 898 }
 899
 900 static long long int
 901 bfd_tx_interval(const struct bfd *bfd) OVS_REQUIRES(mutex)
 902 {
 903     long long int interval = bfd_min_tx(bfd);
 904     return MAX(interval, bfd->rmt_min_rx);
 905 }
 906
 907 static long long int
 908 bfd_rx_interval(const struct bfd *bfd) OVS_REQUIRES(mutex)
 909 {
 910     return MAX(bfd->min_rx, bfd->rmt_min_tx);
 911 }
 912
 913 static void
 914 bfd_set_next_tx(struct bfd *bfd) OVS_REQUIRES(mutex)
 915 {
 916     long long int interval = bfd_tx_interval(bfd);
 917     interval -= interval * random_range(26) / 100;
 918     bfd->next_tx = bfd->last_tx + interval;
 919 }
 920
 921 static const char *
 922 bfd_flag_str(enum flags flags)
 923 {
 924     struct ds ds = DS_EMPTY_INITIALIZER;
 925     static char flag_str[128];
 926
 927     if (!flags) {
 928         return "none";
 929     }
 930
 931     if (flags & FLAG_MULTIPOINT) {
 932         ds_put_cstr(&ds, "multipoint ");
 933     }
 934
 935     if (flags & FLAG_DEMAND) {
 936         ds_put_cstr(&ds, "demand ");
 937     }
 938
 939     if (flags & FLAG_AUTH) {
 940         ds_put_cstr(&ds, "auth ");
 941     }
 942
 943     if (flags & FLAG_CTL) {
 944         ds_put_cstr(&ds, "ctl ");
 945     }
 946
 947     if (flags & FLAG_FINAL) {
 948         ds_put_cstr(&ds, "final ");
 949     }
 950
 951     if (flags & FLAG_POLL) {
 952         ds_put_cstr(&ds, "poll ");
 953     }
 954
 955     /* Do not copy the trailing whitespace. */
 956     ds_chomp(&ds, ' ');
 957     ovs_strlcpy(flag_str, ds_cstr(&ds), sizeof flag_str);
 958     ds_destroy(&ds);
 959     return flag_str;
 960 }
 961
 962 static const char *
 963 bfd_state_str(enum state state)
 964 {
 965     switch (state) {
 966     case STATE_ADMIN_DOWN: return "admin_down";
 967     case STATE_DOWN: return "down";
 968     case STATE_INIT: return "init";
 969     case STATE_UP: return "up";
 970     default: return "invalid";
 971     }
 972 }
 973
 974 static const char *
 975 bfd_diag_str(enum diag diag) {
 976     switch (diag) {
 977     case DIAG_NONE: return "No Diagnostic";
 978     case DIAG_EXPIRED: return "Control Detection Time Expired";
 979     case DIAG_ECHO_FAILED: return "Echo Function Failed";
 980     case DIAG_RMT_DOWN: return "Neighbor Signaled Session Down";
 981     case DIAG_FWD_RESET: return "Forwarding Plane Reset";
 982     case DIAG_PATH_DOWN: return "Path Down";
 983     case DIAG_CPATH_DOWN: return "Concatenated Path Down";
 984     case DIAG_ADMIN_DOWN: return "Administratively Down";
 985     case DIAG_RCPATH_DOWN: return "Reverse Concatenated Path Down";
 986     default: return "Invalid Diagnostic";
 987     }
 988 };
 989
 990 static void
 991 log_msg(enum vlog_level level, const struct msg *p, const char *message,
 992         const struct bfd *bfd) OVS_REQUIRES(mutex)
 993 {
 994     struct ds ds = DS_EMPTY_INITIALIZER;
 995
 996     if (vlog_should_drop(THIS_MODULE, level, &rl)) {
 997         return;
 998     }
 999
1000     ds_put_format(&ds,
1001                   "%s: %s."
1002                   "\n\tvers:%"PRIu8" diag:\"%s\" state:%s mult:%"PRIu8
1003                   " length:%"PRIu8
1004                   "\n\tflags: %s"
1005                   "\n\tmy_disc:0x%"PRIx32" your_disc:0x%"PRIx32
1006                   "\n\tmin_tx:%"PRIu32"us (%"PRIu32"ms)"
1007                   "\n\tmin_rx:%"PRIu32"us (%"PRIu32"ms)"
1008                   "\n\tmin_rx_echo:%"PRIu32"us (%"PRIu32"ms)",
1009                   bfd->name, message, p->vers_diag >> VERS_SHIFT,
1010                   bfd_diag_str(p->vers_diag & DIAG_MASK),
1011                   bfd_state_str(p->flags & STATE_MASK),
1012                   p->mult, p->length, bfd_flag_str(p->flags & FLAGS_MASK),
1013                   ntohl(p->my_disc), ntohl(p->your_disc),
1014                   ntohl(p->min_tx), ntohl(p->min_tx) / 1000,
1015                   ntohl(p->min_rx), ntohl(p->min_rx) / 1000,
1016                   ntohl(p->min_rx_echo), ntohl(p->min_rx_echo) / 1000);
1017     bfd_put_details(&ds, bfd);
1018     VLOG(level, "%s", ds_cstr(&ds));
1019     ds_destroy(&ds);
1020 }
1021
1022 static void
1023 bfd_set_state(struct bfd *bfd, enum state state, enum diag diag)
1024     OVS_REQUIRES(mutex)
1025 {
1026     if (diag == DIAG_NONE && bfd->cpath_down) {
1027         diag = DIAG_CPATH_DOWN;
1028     }
1029
1030     if (bfd->state != state || bfd->diag != diag) {
1031         if (!VLOG_DROP_INFO(&rl)) {
1032             struct ds ds = DS_EMPTY_INITIALIZER;
1033
1034             ds_put_format(&ds, "%s: BFD state change: %s->%s"
1035                           " \"%s\"->\"%s\".\n",
1036                           bfd->name, bfd_state_str(bfd->state),
1037                           bfd_state_str(state), bfd_diag_str(bfd->diag),
1038                           bfd_diag_str(diag));
1039             bfd_put_details(&ds, bfd);
1040             VLOG_INFO("%s", ds_cstr(&ds));
1041             ds_destroy(&ds);
1042         }
1043
1044         bfd->state = state;
1045         bfd->diag = diag;
1046
1047         if (bfd->state <= STATE_DOWN) {
1048             bfd->rmt_state = STATE_DOWN;
1049             bfd->rmt_diag = DIAG_NONE;
1050             bfd->rmt_min_rx = 1;
1051             bfd->rmt_flags = 0;
1052             bfd->rmt_disc = 0;
1053             bfd->rmt_min_tx = 0;
1054             /* Resets the min_rx if in_decay. */
1055             if (bfd->in_decay) {
1056                 bfd->min_rx = bfd->cfg_min_rx;
1057                 bfd->in_decay = false;
1058             }
1059         }
1060         /* Resets the decay when state changes to STATE_UP
1061          * and decay_min_rx is configured. */
1062         if (bfd->state == STATE_UP && bfd->decay_min_rx) {
1063             bfd_decay_update(bfd);
1064         }
1065
1066         seq_change(connectivity_seq_get());
1067     }
1068 }
1069
1070 static uint64_t
1071 bfd_rx_packets(const struct bfd *bfd) OVS_REQUIRES(mutex)
1072 {
1073     struct netdev_stats stats;
1074
1075     if (!netdev_get_stats(bfd->netdev, &stats)) {
1076         return stats.rx_packets;
1077     } else {
1078         return 0;
1079     }
1080 }
1081
1082 /* Decays the bfd->min_rx to bfd->decay_min_rx when 'diff' is less than
1083  * the 'expect' value. */
1084 static void
1085 bfd_try_decay(struct bfd *bfd) OVS_REQUIRES(mutex)
1086 {
1087     int64_t diff, expect;
1088
1089     /* The 'diff' is the difference between current interface rx_packets
1090      * stats and last-time check.  The 'expect' is the recorded number of
1091      * bfd control packets received within an approximately decay_min_rx
1092      * (2000 ms if decay_min_rx is less than 2000 ms) interval.
1093      *
1094      * Since the update of rx_packets stats at interface happens
1095      * asynchronously to the bfd_rx_packets() function, the 'diff' value
1096      * can be jittered.  Thusly, we double the decay_rx_ctl to provide
1097      * more wiggle room. */
1098     diff = bfd_rx_packets(bfd) - bfd->decay_rx_packets;
1099     expect = 2 * MAX(bfd->decay_rx_ctl, 1);
1100     bfd->in_decay = diff <= expect ? true : false;
1101     bfd_decay_update(bfd);
1102 }
1103
1104 /* Updates the rx_packets, decay_rx_ctl and decay_detect_time. */
1105 static void
1106 bfd_decay_update(struct bfd * bfd) OVS_REQUIRES(mutex)
1107 {
1108     bfd->decay_rx_packets = bfd_rx_packets(bfd);
1109     bfd->decay_rx_ctl = 0;
1110     bfd->decay_detect_time = MAX(bfd->decay_min_rx, 2000) + time_msec();
1111 }
1112
1113 static void
1114 bfd_forwarding_if_rx_update(struct bfd *bfd) OVS_REQUIRES(mutex)
1115 {
1116     int64_t incr = bfd_rx_interval(bfd) * bfd->mult;
1117     bfd->forwarding_if_rx_detect_time = MAX(incr, 2000) + time_msec();
1118 }
1119
1120 static uint32_t
1121 generate_discriminator(void)
1122 {
1123     uint32_t disc = 0;
1124
1125     /* RFC 5880 Section 6.8.1
1126      * It SHOULD be set to a random (but still unique) value to improve
1127      * security.  The value is otherwise outside the scope of this
1128      * specification. */
1129
1130     while (!disc) {
1131         struct bfd *bfd;
1132
1133         /* 'disc' is by definition random, so there's no reason to waste time
1134          * hashing it. */
1135         disc = random_uint32();
1136         HMAP_FOR_EACH_IN_BUCKET (bfd, node, disc, all_bfds) {
1137             if (bfd->disc == disc) {
1138                 disc = 0;
1139                 break;
1140             }
1141         }
1142     }
1143
1144     return disc;
1145 }
1146
1147 static struct bfd *
1148 bfd_find_by_name(const char *name) OVS_REQUIRES(mutex)
1149 {
1150     struct bfd *bfd;
1151
1152     HMAP_FOR_EACH (bfd, node, all_bfds) {
1153         if (!strcmp(bfd->name, name)) {
1154             return bfd;
1155         }
1156     }
1157     return NULL;
1158 }
1159
1160 static void
1161 bfd_put_details(struct ds *ds, const struct bfd *bfd) OVS_REQUIRES(mutex)
1162 {
1163     ds_put_format(ds, "\tForwarding: %s\n",
1164                   bfd_forwarding__(CONST_CAST(struct bfd *, bfd))
1165                   ? "true" : "false");
1166     ds_put_format(ds, "\tDetect Multiplier: %d\n", bfd->mult);
1167     ds_put_format(ds, "\tConcatenated Path Down: %s\n",
1168                   bfd->cpath_down ? "true" : "false");
1169     ds_put_format(ds, "\tTX Interval: Approx %lldms\n", bfd_tx_interval(bfd));
1170     ds_put_format(ds, "\tRX Interval: Approx %lldms\n", bfd_rx_interval(bfd));
1171     ds_put_format(ds, "\tDetect Time: now %+lldms\n",
1172                   time_msec() - bfd->detect_time);
1173     ds_put_format(ds, "\tNext TX Time: now %+lldms\n",
1174                   time_msec() - bfd->next_tx);
1175     ds_put_format(ds, "\tLast TX Time: now %+lldms\n",
1176                   time_msec() - bfd->last_tx);
1177
1178     ds_put_cstr(ds, "\n");
1179
1180     ds_put_format(ds, "\tLocal Flags: %s\n", bfd_flag_str(bfd->flags));
1181     ds_put_format(ds, "\tLocal Session State: %s\n",
1182                   bfd_state_str(bfd->state));
1183     ds_put_format(ds, "\tLocal Diagnostic: %s\n", bfd_diag_str(bfd->diag));
1184     ds_put_format(ds, "\tLocal Discriminator: 0x%"PRIx32"\n", bfd->disc);
1185     ds_put_format(ds, "\tLocal Minimum TX Interval: %lldms\n",
1186                   bfd_min_tx(bfd));
1187     ds_put_format(ds, "\tLocal Minimum RX Interval: %lldms\n", bfd->min_rx);
1188
1189     ds_put_cstr(ds, "\n");
1190
1191     ds_put_format(ds, "\tRemote Flags: %s\n", bfd_flag_str(bfd->rmt_flags));
1192     ds_put_format(ds, "\tRemote Session State: %s\n",
1193                   bfd_state_str(bfd->rmt_state));
1194     ds_put_format(ds, "\tRemote Diagnostic: %s\n",
1195                   bfd_diag_str(bfd->rmt_diag));
1196     ds_put_format(ds, "\tRemote Discriminator: 0x%"PRIx32"\n", bfd->rmt_disc);
1197     ds_put_format(ds, "\tRemote Minimum TX Interval: %lldms\n",
1198                   bfd->rmt_min_tx);
1199     ds_put_format(ds, "\tRemote Minimum RX Interval: %lldms\n",
1200                   bfd->rmt_min_rx);
1201 }
1202
1203 static void
1204 bfd_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
1205                  void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1206 {
1207     struct ds ds = DS_EMPTY_INITIALIZER;
1208     struct bfd *bfd;
1209
1210     ovs_mutex_lock(&mutex);
1211     if (argc > 1) {
1212         bfd = bfd_find_by_name(argv[1]);
1213         if (!bfd) {
1214             unixctl_command_reply_error(conn, "no such bfd object");
1215             goto out;
1216         }
1217         bfd_put_details(&ds, bfd);
1218     } else {
1219         HMAP_FOR_EACH (bfd, node, all_bfds) {
1220             ds_put_format(&ds, "---- %s ----\n", bfd->name);
1221             bfd_put_details(&ds, bfd);
1222         }
1223     }
1224     unixctl_command_reply(conn, ds_cstr(&ds));
1225     ds_destroy(&ds);
1226
1227 out:
1228     ovs_mutex_unlock(&mutex);
1229 }
1230
1231
1232 static void
1233 bfd_unixctl_set_forwarding_override(struct unixctl_conn *conn, int argc,
1234                                     const char *argv[], void *aux OVS_UNUSED)
1235     OVS_EXCLUDED(mutex)
1236 {
1237     const char *forward_str = argv[argc - 1];
1238     int forwarding_override;
1239     struct bfd *bfd;
1240
1241     ovs_mutex_lock(&mutex);
1242     if (!strcasecmp("true", forward_str)) {
1243         forwarding_override = 1;
1244     } else if (!strcasecmp("false", forward_str)) {
1245         forwarding_override = 0;
1246     } else if (!strcasecmp("normal", forward_str)) {
1247         forwarding_override = -1;
1248     } else {
1249         unixctl_command_reply_error(conn, "unknown fault string");
1250         goto out;
1251     }
1252
1253     if (argc > 2) {
1254         bfd = bfd_find_by_name(argv[1]);
1255         if (!bfd) {
1256             unixctl_command_reply_error(conn, "no such BFD object");
1257             goto out;
1258         }
1259         bfd->forwarding_override = forwarding_override;
1260     } else {
1261         HMAP_FOR_EACH (bfd, node, all_bfds) {
1262             bfd->forwarding_override = forwarding_override;
1263         }
1264     }
1265
1266     unixctl_command_reply(conn, "OK");
1267
1268 out:
1269     ovs_mutex_unlock(&mutex);
1270 }