lib/bfd.c

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