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