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