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         bfd_status_changed(bfd);
 393     }
 394
 395     atomic_store(&bfd->check_tnl_key,
 396                  smap_get_bool(cfg, "check_tnl_key", false));
 397     min_tx = smap_get_int(cfg, "min_tx", 100);
 398     min_tx = MAX(min_tx, 100);
 399     if (bfd->cfg_min_tx != min_tx) {
 400         bfd->cfg_min_tx = min_tx;
 401         if (bfd->state != STATE_UP
 402             || (!bfd_in_poll(bfd) && bfd->cfg_min_tx < bfd->min_tx)) {
 403             bfd->min_tx = bfd->cfg_min_tx;
 404         }
 405         need_poll = true;
 406     }
 407
 408     min_rx = smap_get_int(cfg, "min_rx", 1000);
 409     min_rx = MAX(min_rx, 100);
 410     if (bfd->cfg_min_rx != min_rx) {
 411         bfd->cfg_min_rx = min_rx;
 412         if (bfd->state != STATE_UP
 413             || (!bfd_in_poll(bfd) && bfd->cfg_min_rx > bfd->min_rx)) {
 414             bfd->min_rx = bfd->cfg_min_rx;
 415         }
 416         cfg_min_rx_changed = true;
 417         need_poll = true;
 418     }
 419
 420     decay_min_rx = smap_get_int(cfg, "decay_min_rx", 0);
 421     if (bfd->decay_min_rx != decay_min_rx || cfg_min_rx_changed) {
 422         if (decay_min_rx > 0 && decay_min_rx < bfd->cfg_min_rx) {
 423             VLOG_WARN("%s: decay_min_rx cannot be less than %lld ms",
 424                       bfd->name, bfd->cfg_min_rx);
 425             bfd->decay_min_rx = 0;
 426         } else {
 427             bfd->decay_min_rx = decay_min_rx;
 428         }
 429         /* Resets decay. */
 430         bfd->in_decay = false;
 431         bfd_decay_update(bfd);
 432         need_poll = true;
 433     }
 434
 435     cpath_down = smap_get_bool(cfg, "cpath_down", false);
 436     if (bfd->cpath_down != cpath_down) {
 437         bfd->cpath_down = cpath_down;
 438         bfd_set_state(bfd, bfd->state, DIAG_NONE);
 439         need_poll = true;
 440     }
 441
 442     hwaddr = smap_get(cfg, "bfd_dst_mac");
 443     if (hwaddr && eth_addr_from_string(hwaddr, ea) && !eth_addr_is_zero(ea)) {
 444         memcpy(bfd->eth_dst, ea, ETH_ADDR_LEN);
 445         bfd->eth_dst_set = true;
 446     } else if (bfd->eth_dst_set) {
 447         memcpy(bfd->eth_dst, eth_addr_bfd, ETH_ADDR_LEN);
 448         bfd->eth_dst_set = false;
 449     }
 450
 451     ip_src = smap_get(cfg, "bfd_src_ip");
 452     if (ip_src && bfd_lookup_ip(ip_src, &in_addr)) {
 453         memcpy(&bfd->ip_src, &in_addr, sizeof in_addr);
 454     } else {
 455         bfd->ip_src = htonl(0xA9FE0100); /* 169.254.1.0. */
 456     }
 457
 458     ip_dst = smap_get(cfg, "bfd_dst_ip");
 459     if (ip_dst && bfd_lookup_ip(ip_dst, &in_addr)) {
 460         memcpy(&bfd->ip_dst, &in_addr, sizeof in_addr);
 461     } else {
 462         bfd->ip_dst = htonl(0xA9FE0101); /* 169.254.1.1. */
 463     }
 464
 465     forwarding_if_rx = smap_get_bool(cfg, "forwarding_if_rx", false);
 466     if (bfd->forwarding_if_rx != forwarding_if_rx) {
 467         bfd->forwarding_if_rx = forwarding_if_rx;
 468         if (bfd->state == STATE_UP && bfd->forwarding_if_rx) {
 469             bfd_forwarding_if_rx_update(bfd);
 470         } else {
 471             bfd->forwarding_if_rx_detect_time = 0;
 472         }
 473     }
 474
 475     if (need_poll) {
 476         bfd_poll(bfd);
 477     }
 478     ovs_mutex_unlock(&mutex);
 479     return bfd;
 480 }
 481
 482 struct bfd *
 483 bfd_ref(const struct bfd *bfd_)
 484 {
 485     struct bfd *bfd = CONST_CAST(struct bfd *, bfd_);
 486     if (bfd) {
 487         ovs_refcount_ref(&bfd->ref_cnt);
 488     }
 489     return bfd;
 490 }
 491
 492 void
 493 bfd_unref(struct bfd *bfd) OVS_EXCLUDED(mutex)
 494 {
 495     if (bfd && ovs_refcount_unref(&bfd->ref_cnt) == 1) {
 496         ovs_mutex_lock(&mutex);
 497         bfd_status_changed(bfd);
 498         hmap_remove(all_bfds, &bfd->node);
 499         netdev_close(bfd->netdev);
 500         free(bfd->name);
 501         free(bfd);
 502         ovs_mutex_unlock(&mutex);
 503     }
 504 }
 505
 506 void
 507 bfd_wait(const struct bfd *bfd) OVS_EXCLUDED(mutex)
 508 {
 509     poll_timer_wait_until(bfd_wake_time(bfd));
 510 }
 511
 512 /* Returns the next wake up time. */
 513 long long int
 514 bfd_wake_time(const struct bfd *bfd) OVS_EXCLUDED(mutex)
 515 {
 516     long long int retval;
 517
 518     if (!bfd) {
 519         return LLONG_MAX;
 520     }
 521
 522     ovs_mutex_lock(&mutex);
 523     if (bfd->flags & FLAG_FINAL) {
 524         retval = 0;
 525     } else {
 526         retval = bfd->next_tx;
 527         if (bfd->state > STATE_DOWN) {
 528             retval = MIN(bfd->detect_time, retval);
 529         }
 530     }
 531     ovs_mutex_unlock(&mutex);
 532     return retval;
 533 }
 534
 535 void
 536 bfd_run(struct bfd *bfd) OVS_EXCLUDED(mutex)
 537 {
 538     long long int now;
 539     bool old_in_decay;
 540
 541     ovs_mutex_lock(&mutex);
 542     now = time_msec();
 543     old_in_decay = bfd->in_decay;
 544
 545     if (bfd->state > STATE_DOWN && now >= bfd->detect_time) {
 546         bfd_set_state(bfd, STATE_DOWN, DIAG_EXPIRED);
 547     }
 548     bfd_forwarding__(bfd);
 549
 550     /* Decay may only happen when state is STATE_UP, bfd->decay_min_rx is
 551      * configured, and decay_detect_time is reached. */
 552     if (bfd->state == STATE_UP && bfd->decay_min_rx > 0
 553         && now >= bfd->decay_detect_time) {
 554         bfd_try_decay(bfd);
 555     }
 556
 557     if (bfd->min_tx != bfd->cfg_min_tx
 558         || (bfd->min_rx != bfd->cfg_min_rx && bfd->min_rx != bfd->decay_min_rx)
 559         || bfd->in_decay != old_in_decay) {
 560         bfd_poll(bfd);
 561     }
 562     ovs_mutex_unlock(&mutex);
 563 }
 564
 565 bool
 566 bfd_should_send_packet(const struct bfd *bfd) OVS_EXCLUDED(mutex)
 567 {
 568     bool ret;
 569     ovs_mutex_lock(&mutex);
 570     ret = bfd->flags & FLAG_FINAL || time_msec() >= bfd->next_tx;
 571     ovs_mutex_unlock(&mutex);
 572     return ret;
 573 }
 574
 575 void
 576 bfd_put_packet(struct bfd *bfd, struct ofpbuf *p,
 577                uint8_t eth_src[ETH_ADDR_LEN]) OVS_EXCLUDED(mutex)
 578 {
 579     long long int min_tx, min_rx;
 580     struct udp_header *udp;
 581     struct eth_header *eth;
 582     struct ip_header *ip;
 583     struct msg *msg;
 584
 585     ovs_mutex_lock(&mutex);
 586     if (bfd->next_tx) {
 587         long long int delay = time_msec() - bfd->next_tx;
 588         long long int interval = bfd_tx_interval(bfd);
 589         if (delay > interval * 3 / 2) {
 590             VLOG_INFO("%s: long delay of %lldms (expected %lldms) sending BFD"
 591                       " control message", bfd->name, delay, interval);
 592         }
 593     }
 594
 595     /* RFC 5880 Section 6.5
 596      * A BFD Control packet MUST NOT have both the Poll (P) and Final (F) bits
 597      * set. */
 598     ovs_assert(!(bfd->flags & FLAG_POLL) || !(bfd->flags & FLAG_FINAL));
 599
 600     ofpbuf_reserve(p, 2); /* Properly align after the ethernet header. */
 601     eth = ofpbuf_put_uninit(p, sizeof *eth);
 602     memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
 603     memcpy(eth->eth_dst, bfd->eth_dst, ETH_ADDR_LEN);
 604     eth->eth_type = htons(ETH_TYPE_IP);
 605
 606     ip = ofpbuf_put_zeros(p, sizeof *ip);
 607     ip->ip_ihl_ver = IP_IHL_VER(5, 4);
 608     ip->ip_tot_len = htons(sizeof *ip + sizeof *udp + sizeof *msg);
 609     ip->ip_ttl = MAXTTL;
 610     ip->ip_tos = IPTOS_LOWDELAY | IPTOS_THROUGHPUT;
 611     ip->ip_proto = IPPROTO_UDP;
 612     put_16aligned_be32(&ip->ip_src, bfd->ip_src);
 613     put_16aligned_be32(&ip->ip_dst, bfd->ip_dst);
 614     ip->ip_csum = csum(ip, sizeof *ip);
 615
 616     udp = ofpbuf_put_zeros(p, sizeof *udp);
 617     udp->udp_src = htons(bfd->udp_src);
 618     udp->udp_dst = htons(BFD_DEST_PORT);
 619     udp->udp_len = htons(sizeof *udp + sizeof *msg);
 620
 621     msg = ofpbuf_put_uninit(p, sizeof *msg);
 622     msg->vers_diag = (BFD_VERSION << 5) | bfd->diag;
 623     msg->flags = (bfd->state & STATE_MASK) | bfd->flags;
 624
 625     msg->mult = bfd->mult;
 626     msg->length = BFD_PACKET_LEN;
 627     msg->my_disc = htonl(bfd->disc);
 628     msg->your_disc = htonl(bfd->rmt_disc);
 629     msg->min_rx_echo = htonl(0);
 630
 631     if (bfd_in_poll(bfd)) {
 632         min_tx = bfd->poll_min_tx;
 633         min_rx = bfd->poll_min_rx;
 634     } else {
 635         min_tx = bfd_min_tx(bfd);
 636         min_rx = bfd->min_rx;
 637     }
 638
 639     msg->min_tx = htonl(min_tx * 1000);
 640     msg->min_rx = htonl(min_rx * 1000);
 641
 642     bfd->flags &= ~FLAG_FINAL;
 643
 644     log_msg(VLL_DBG, msg, "Sending BFD Message", bfd);
 645
 646     bfd->last_tx = time_msec();
 647     bfd_set_next_tx(bfd);
 648     ovs_mutex_unlock(&mutex);
 649 }
 650
 651 bool
 652 bfd_should_process_flow(const struct bfd *bfd_, const struct flow *flow,
 653                         struct flow_wildcards *wc)
 654 {
 655     struct bfd *bfd = CONST_CAST(struct bfd *, bfd_);
 656     bool check_tnl_key;
 657
 658     memset(&wc->masks.dl_dst, 0xff, sizeof wc->masks.dl_dst);
 659     if (bfd->eth_dst_set && memcmp(bfd->eth_dst, flow->dl_dst, ETH_ADDR_LEN)) {
 660         return false;
 661     }
 662
 663     memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
 664     memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
 665
 666     atomic_read(&bfd->check_tnl_key, &check_tnl_key);
 667     if (check_tnl_key) {
 668         memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
 669     }
 670     return (flow->dl_type == htons(ETH_TYPE_IP)
 671             && flow->nw_proto == IPPROTO_UDP
 672             && flow->tp_dst == htons(BFD_DEST_PORT)
 673             && (!check_tnl_key || flow->tunnel.tun_id == htonll(0)));
 674 }
 675
 676 void
 677 bfd_process_packet(struct bfd *bfd, const struct flow *flow,
 678                    const struct ofpbuf *p) OVS_EXCLUDED(mutex)
 679 {
 680     uint32_t rmt_min_rx, pkt_your_disc;
 681     enum state rmt_state;
 682     enum flags flags;
 683     uint8_t version;
 684     struct msg *msg;
 685     const uint8_t *l7 = ofpbuf_get_udp_payload(p);
 686
 687     if (!l7) {
 688         return; /* No UDP payload. */
 689     }
 690
 691     /* This function is designed to follow section RFC 5880 6.8.6 closely. */
 692
 693     ovs_mutex_lock(&mutex);
 694     /* Increments the decay rx counter. */
 695     bfd->decay_rx_ctl++;
 696
 697     bfd_forwarding__(bfd);
 698
 699     if (flow->nw_ttl != 255) {
 700         /* XXX Should drop in the kernel to prevent DOS. */
 701         goto out;
 702     }
 703
 704     msg = ofpbuf_at(p, l7 - (uint8_t *)ofpbuf_data(p), BFD_PACKET_LEN);
 705     if (!msg) {
 706         VLOG_INFO_RL(&rl, "%s: Received too-short BFD control message (only "
 707                      "%"PRIdPTR" bytes long, at least %d required).",
 708                      bfd->name, (uint8_t *) ofpbuf_tail(p) - l7,
 709                      BFD_PACKET_LEN);
 710         goto out;
 711     }
 712
 713     /* RFC 5880 Section 6.8.6
 714      * If the Length field is greater than the payload of the encapsulating
 715      * protocol, the packet MUST be discarded.
 716      *
 717      * Note that we make this check implicity.  Above we use ofpbuf_at() to
 718      * ensure that there are at least BFD_PACKET_LEN bytes in the payload of
 719      * the encapsulating protocol.  Below we require msg->length to be exactly
 720      * BFD_PACKET_LEN bytes. */
 721
 722     flags = msg->flags & FLAGS_MASK;
 723     rmt_state = msg->flags & STATE_MASK;
 724     version = msg->vers_diag >> VERS_SHIFT;
 725
 726     log_msg(VLL_DBG, msg, "Received BFD control message", bfd);
 727
 728     if (version != BFD_VERSION) {
 729         log_msg(VLL_WARN, msg, "Incorrect version", bfd);
 730         goto out;
 731     }
 732
 733     /* Technically this should happen after the length check. We don't support
 734      * authentication however, so it's simpler to do the check first. */
 735     if (flags & FLAG_AUTH) {
 736         log_msg(VLL_WARN, msg, "Authenticated control message with"
 737                    " authentication disabled", bfd);
 738         goto out;
 739     }
 740
 741     if (msg->length != BFD_PACKET_LEN) {
 742         log_msg(VLL_WARN, msg, "Unexpected length", bfd);
 743         if (msg->length < BFD_PACKET_LEN) {
 744             goto out;
 745         }
 746     }
 747
 748     if (!msg->mult) {
 749         log_msg(VLL_WARN, msg, "Zero multiplier", bfd);
 750         goto out;
 751     }
 752
 753     if (flags & FLAG_MULTIPOINT) {
 754         log_msg(VLL_WARN, msg, "Unsupported multipoint flag", bfd);
 755         goto out;
 756     }
 757
 758     if (!msg->my_disc) {
 759         log_msg(VLL_WARN, msg, "NULL my_disc", bfd);
 760         goto out;
 761     }
 762
 763     pkt_your_disc = ntohl(msg->your_disc);
 764     if (pkt_your_disc) {
 765         /* Technically, we should use the your discriminator field to figure
 766          * out which 'struct bfd' this packet is destined towards.  That way a
 767          * bfd session could migrate from one interface to another
 768          * transparently.  This doesn't fit in with the OVS structure very
 769          * well, so in this respect, we are not compliant. */
 770        if (pkt_your_disc != bfd->disc) {
 771            log_msg(VLL_WARN, msg, "Incorrect your_disc", bfd);
 772            goto out;
 773        }
 774     } else if (rmt_state > STATE_DOWN) {
 775         log_msg(VLL_WARN, msg, "Null your_disc", bfd);
 776         goto out;
 777     }
 778
 779     if (bfd->rmt_state != rmt_state) {
 780         bfd_status_changed(bfd);
 781     }
 782
 783     bfd->rmt_disc = ntohl(msg->my_disc);
 784     bfd->rmt_state = rmt_state;
 785     bfd->rmt_flags = flags;
 786     bfd->rmt_diag = msg->vers_diag & DIAG_MASK;
 787
 788     if (flags & FLAG_FINAL && bfd_in_poll(bfd)) {
 789         bfd->min_tx = bfd->poll_min_tx;
 790         bfd->min_rx = bfd->poll_min_rx;
 791         bfd->flags &= ~FLAG_POLL;
 792         log_msg(VLL_INFO, msg, "Poll sequence terminated", bfd);
 793     }
 794
 795     if (flags & FLAG_POLL) {
 796         /* RFC 5880 Section 6.5
 797          * When the other system receives a Poll, it immediately transmits a
 798          * BFD Control packet with the Final (F) bit set, independent of any
 799          * periodic BFD Control packets it may be sending
 800          * (see section 6.8.7). */
 801         bfd->flags &= ~FLAG_POLL;
 802         bfd->flags |= FLAG_FINAL;
 803     }
 804
 805     rmt_min_rx = MAX(ntohl(msg->min_rx) / 1000, 1);
 806     if (bfd->rmt_min_rx != rmt_min_rx) {
 807         bfd->rmt_min_rx = rmt_min_rx;
 808         if (bfd->next_tx) {
 809             bfd_set_next_tx(bfd);
 810         }
 811         log_msg(VLL_INFO, msg, "New remote min_rx", bfd);
 812     }
 813
 814     bfd->rmt_min_tx = MAX(ntohl(msg->min_tx) / 1000, 1);
 815     bfd->detect_time = bfd_rx_interval(bfd) * bfd->mult + time_msec();
 816
 817     if (bfd->state == STATE_ADMIN_DOWN) {
 818         VLOG_DBG_RL(&rl, "Administratively down, dropping control message.");
 819         goto out;
 820     }
 821
 822     if (rmt_state == STATE_ADMIN_DOWN) {
 823         if (bfd->state != STATE_DOWN) {
 824             bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
 825         }
 826     } else {
 827         switch (bfd->state) {
 828         case STATE_DOWN:
 829             if (rmt_state == STATE_DOWN) {
 830                 bfd_set_state(bfd, STATE_INIT, bfd->diag);
 831             } else if (rmt_state == STATE_INIT) {
 832                 bfd_set_state(bfd, STATE_UP, bfd->diag);
 833             }
 834             break;
 835         case STATE_INIT:
 836             if (rmt_state > STATE_DOWN) {
 837                 bfd_set_state(bfd, STATE_UP, bfd->diag);
 838             }
 839             break;
 840         case STATE_UP:
 841             if (rmt_state <= STATE_DOWN) {
 842                 bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
 843                 log_msg(VLL_INFO, msg, "Remote signaled STATE_DOWN", bfd);
 844             }
 845             break;
 846         case STATE_ADMIN_DOWN:
 847         default:
 848             OVS_NOT_REACHED();
 849         }
 850     }
 851     /* XXX: RFC 5880 Section 6.8.6 Demand mode related calculations here. */
 852
 853     if (bfd->forwarding_if_rx) {
 854         bfd->demand_rx_bfd_time = time_msec() + 100 * bfd->cfg_min_rx;
 855     }
 856
 857 out:
 858     bfd_forwarding__(bfd);
 859     ovs_mutex_unlock(&mutex);
 860 }
 861
 862 /* Must be called when the netdev owned by 'bfd' should change. */
 863 void
 864 bfd_set_netdev(struct bfd *bfd, const struct netdev *netdev)
 865     OVS_EXCLUDED(mutex)
 866 {
 867     ovs_mutex_lock(&mutex);
 868     if (bfd->netdev != netdev) {
 869         netdev_close(bfd->netdev);
 870         bfd->netdev = netdev_ref(netdev);
 871         if (bfd->decay_min_rx && bfd->state == STATE_UP) {
 872             bfd_decay_update(bfd);
 873         }
 874         if (bfd->forwarding_if_rx && bfd->state == STATE_UP) {
 875             bfd_forwarding_if_rx_update(bfd);
 876         }
 877         bfd->rx_packets = bfd_rx_packets(bfd);
 878     }
 879     ovs_mutex_unlock(&mutex);
 880 }
 881
 882 \f
 883 /* Updates the forwarding flag.  If override is not configured and
 884  * the forwarding flag value changes, increments the flap count.
 885  *
 886  * Note this function may be called multiple times in a function
 887  * (e.g. bfd_account_rx) before and after the bfd state or status
 888  * change.  This is to capture any forwarding flag flap. */
 889 static bool
 890 bfd_forwarding__(struct bfd *bfd) OVS_REQUIRES(mutex)
 891 {
 892     long long int now = time_msec();
 893     bool forwarding_if_rx;
 894     bool last_forwarding = bfd->last_forwarding;
 895
 896     if (bfd->forwarding_override != -1) {
 897         return bfd->forwarding_override == 1;
 898     }
 899
 900     forwarding_if_rx = bfd->forwarding_if_rx
 901                        && bfd->forwarding_if_rx_detect_time > now
 902                        && bfd->demand_rx_bfd_time > now;
 903
 904     bfd->last_forwarding = (bfd->state == STATE_UP || forwarding_if_rx)
 905                            && bfd->rmt_diag != DIAG_PATH_DOWN
 906                            && bfd->rmt_diag != DIAG_CPATH_DOWN
 907                            && bfd->rmt_diag != DIAG_RCPATH_DOWN;
 908     if (bfd->last_forwarding != last_forwarding) {
 909         bfd->flap_count++;
 910         bfd_status_changed(bfd);
 911     }
 912     return bfd->last_forwarding;
 913 }
 914
 915 /* Helpers. */
 916 static bool
 917 bfd_lookup_ip(const char *host_name, struct in_addr *addr)
 918 {
 919     if (!inet_pton(AF_INET, host_name, addr)) {
 920         VLOG_ERR_RL(&rl, "\"%s\" is not a valid IP address", host_name);
 921         return false;
 922     }
 923     return true;
 924 }
 925
 926 static bool
 927 bfd_in_poll(const struct bfd *bfd) OVS_REQUIRES(mutex)
 928 {
 929     return (bfd->flags & FLAG_POLL) != 0;
 930 }
 931
 932 static void
 933 bfd_poll(struct bfd *bfd) OVS_REQUIRES(mutex)
 934 {
 935     if (bfd->state > STATE_DOWN && !bfd_in_poll(bfd)
 936         && !(bfd->flags & FLAG_FINAL)) {
 937         bfd->poll_min_tx = bfd->cfg_min_tx;
 938         bfd->poll_min_rx = bfd->in_decay ? bfd->decay_min_rx : bfd->cfg_min_rx;
 939         bfd->flags |= FLAG_POLL;
 940         bfd->next_tx = 0;
 941         VLOG_INFO_RL(&rl, "%s: Initiating poll sequence", bfd->name);
 942     }
 943 }
 944
 945 static long long int
 946 bfd_min_tx(const struct bfd *bfd) OVS_REQUIRES(mutex)
 947 {
 948     /* RFC 5880 Section 6.8.3
 949      * When bfd.SessionState is not Up, the system MUST set
 950      * bfd.DesiredMinTxInterval to a value of not less than one second
 951      * (1,000,000 microseconds).  This is intended to ensure that the
 952      * bandwidth consumed by BFD sessions that are not Up is negligible,
 953      * particularly in the case where a neighbor may not be running BFD. */
 954     return (bfd->state == STATE_UP ? bfd->min_tx : MAX(bfd->min_tx, 1000));
 955 }
 956
 957 static long long int
 958 bfd_tx_interval(const struct bfd *bfd) OVS_REQUIRES(mutex)
 959 {
 960     long long int interval = bfd_min_tx(bfd);
 961     return MAX(interval, bfd->rmt_min_rx);
 962 }
 963
 964 static long long int
 965 bfd_rx_interval(const struct bfd *bfd) OVS_REQUIRES(mutex)
 966 {
 967     return MAX(bfd->min_rx, bfd->rmt_min_tx);
 968 }
 969
 970 static void
 971 bfd_set_next_tx(struct bfd *bfd) OVS_REQUIRES(mutex)
 972 {
 973     long long int interval = bfd_tx_interval(bfd);
 974     interval -= interval * random_range(26) / 100;
 975     bfd->next_tx = bfd->last_tx + interval;
 976 }
 977
 978 static const char *
 979 bfd_flag_str(enum flags flags)
 980 {
 981     struct ds ds = DS_EMPTY_INITIALIZER;
 982     static char flag_str[128];
 983
 984     if (!flags) {
 985         return "none";
 986     }
 987
 988     if (flags & FLAG_MULTIPOINT) {
 989         ds_put_cstr(&ds, "multipoint ");
 990     }
 991
 992     if (flags & FLAG_DEMAND) {
 993         ds_put_cstr(&ds, "demand ");
 994     }
 995
 996     if (flags & FLAG_AUTH) {
 997         ds_put_cstr(&ds, "auth ");
 998     }
 999
1000     if (flags & FLAG_CTL) {
1001         ds_put_cstr(&ds, "ctl ");
1002     }
1003
1004     if (flags & FLAG_FINAL) {
1005         ds_put_cstr(&ds, "final ");
1006     }
1007
1008     if (flags & FLAG_POLL) {
1009         ds_put_cstr(&ds, "poll ");
1010     }
1011
1012     /* Do not copy the trailing whitespace. */
1013     ds_chomp(&ds, ' ');
1014     ovs_strlcpy(flag_str, ds_cstr(&ds), sizeof flag_str);
1015     ds_destroy(&ds);
1016     return flag_str;
1017 }
1018
1019 static const char *
1020 bfd_state_str(enum state state)
1021 {
1022     switch (state) {
1023     case STATE_ADMIN_DOWN: return "admin_down";
1024     case STATE_DOWN: return "down";
1025     case STATE_INIT: return "init";
1026     case STATE_UP: return "up";
1027     default: return "invalid";
1028     }
1029 }
1030
1031 static const char *
1032 bfd_diag_str(enum diag diag) {
1033     switch (diag) {
1034     case DIAG_NONE: return "No Diagnostic";
1035     case DIAG_EXPIRED: return "Control Detection Time Expired";
1036     case DIAG_ECHO_FAILED: return "Echo Function Failed";
1037     case DIAG_RMT_DOWN: return "Neighbor Signaled Session Down";
1038     case DIAG_FWD_RESET: return "Forwarding Plane Reset";
1039     case DIAG_PATH_DOWN: return "Path Down";
1040     case DIAG_CPATH_DOWN: return "Concatenated Path Down";
1041     case DIAG_ADMIN_DOWN: return "Administratively Down";
1042     case DIAG_RCPATH_DOWN: return "Reverse Concatenated Path Down";
1043     default: return "Invalid Diagnostic";
1044     }
1045 };
1046
1047 static void
1048 log_msg(enum vlog_level level, const struct msg *p, const char *message,
1049         const struct bfd *bfd) OVS_REQUIRES(mutex)
1050 {
1051     struct ds ds = DS_EMPTY_INITIALIZER;
1052
1053     if (vlog_should_drop(THIS_MODULE, level, &rl)) {
1054         return;
1055     }
1056
1057     ds_put_format(&ds,
1058                   "%s: %s."
1059                   "\n\tvers:%"PRIu8" diag:\"%s\" state:%s mult:%"PRIu8
1060                   " length:%"PRIu8
1061                   "\n\tflags: %s"
1062                   "\n\tmy_disc:0x%"PRIx32" your_disc:0x%"PRIx32
1063                   "\n\tmin_tx:%"PRIu32"us (%"PRIu32"ms)"
1064                   "\n\tmin_rx:%"PRIu32"us (%"PRIu32"ms)"
1065                   "\n\tmin_rx_echo:%"PRIu32"us (%"PRIu32"ms)",
1066                   bfd->name, message, p->vers_diag >> VERS_SHIFT,
1067                   bfd_diag_str(p->vers_diag & DIAG_MASK),
1068                   bfd_state_str(p->flags & STATE_MASK),
1069                   p->mult, p->length, bfd_flag_str(p->flags & FLAGS_MASK),
1070                   ntohl(p->my_disc), ntohl(p->your_disc),
1071                   ntohl(p->min_tx), ntohl(p->min_tx) / 1000,
1072                   ntohl(p->min_rx), ntohl(p->min_rx) / 1000,
1073                   ntohl(p->min_rx_echo), ntohl(p->min_rx_echo) / 1000);
1074     bfd_put_details(&ds, bfd);
1075     VLOG(level, "%s", ds_cstr(&ds));
1076     ds_destroy(&ds);
1077 }
1078
1079 static void
1080 bfd_set_state(struct bfd *bfd, enum state state, enum diag diag)
1081     OVS_REQUIRES(mutex)
1082 {
1083     if (bfd->cpath_down) {
1084         diag = DIAG_CPATH_DOWN;
1085     }
1086
1087     if (bfd->state != state || bfd->diag != diag) {
1088         if (!VLOG_DROP_INFO(&rl)) {
1089             struct ds ds = DS_EMPTY_INITIALIZER;
1090
1091             ds_put_format(&ds, "%s: BFD state change: %s->%s"
1092                           " \"%s\"->\"%s\".\n",
1093                           bfd->name, bfd_state_str(bfd->state),
1094                           bfd_state_str(state), bfd_diag_str(bfd->diag),
1095                           bfd_diag_str(diag));
1096             bfd_put_details(&ds, bfd);
1097             VLOG_INFO("%s", ds_cstr(&ds));
1098             ds_destroy(&ds);
1099         }
1100
1101         bfd->state = state;
1102         bfd->diag = diag;
1103
1104         if (bfd->state <= STATE_DOWN) {
1105             bfd->rmt_state = STATE_DOWN;
1106             bfd->rmt_diag = DIAG_NONE;
1107             bfd->rmt_min_rx = 1;
1108             bfd->rmt_flags = 0;
1109             bfd->rmt_disc = 0;
1110             bfd->rmt_min_tx = 0;
1111             /* Resets the min_rx if in_decay. */
1112             if (bfd->in_decay) {
1113                 bfd->min_rx = bfd->cfg_min_rx;
1114                 bfd->in_decay = false;
1115             }
1116         }
1117         /* Resets the decay when state changes to STATE_UP
1118          * and decay_min_rx is configured. */
1119         if (bfd->state == STATE_UP && bfd->decay_min_rx) {
1120             bfd_decay_update(bfd);
1121         }
1122
1123         bfd_status_changed(bfd);
1124     }
1125 }
1126
1127 static uint64_t
1128 bfd_rx_packets(const struct bfd *bfd) OVS_REQUIRES(mutex)
1129 {
1130     struct netdev_stats stats;
1131
1132     if (!netdev_get_stats(bfd->netdev, &stats)) {
1133         return stats.rx_packets;
1134     } else {
1135         return 0;
1136     }
1137 }
1138
1139 /* Decays the bfd->min_rx to bfd->decay_min_rx when 'diff' is less than
1140  * the 'expect' value. */
1141 static void
1142 bfd_try_decay(struct bfd *bfd) OVS_REQUIRES(mutex)
1143 {
1144     int64_t diff, expect;
1145
1146     /* The 'diff' is the difference between current interface rx_packets
1147      * stats and last-time check.  The 'expect' is the recorded number of
1148      * bfd control packets received within an approximately decay_min_rx
1149      * (2000 ms if decay_min_rx is less than 2000 ms) interval.
1150      *
1151      * Since the update of rx_packets stats at interface happens
1152      * asynchronously to the bfd_rx_packets() function, the 'diff' value
1153      * can be jittered.  Thusly, we double the decay_rx_ctl to provide
1154      * more wiggle room. */
1155     diff = bfd_rx_packets(bfd) - bfd->decay_rx_packets;
1156     expect = 2 * MAX(bfd->decay_rx_ctl, 1);
1157     bfd->in_decay = diff <= expect ? true : false;
1158     bfd_decay_update(bfd);
1159 }
1160
1161 /* Updates the rx_packets, decay_rx_ctl and decay_detect_time. */
1162 static void
1163 bfd_decay_update(struct bfd * bfd) OVS_REQUIRES(mutex)
1164 {
1165     bfd->decay_rx_packets = bfd_rx_packets(bfd);
1166     bfd->decay_rx_ctl = 0;
1167     bfd->decay_detect_time = MAX(bfd->decay_min_rx, 2000) + time_msec();
1168 }
1169
1170 /* Records the status change and changes the global connectivity seq. */
1171 static void
1172 bfd_status_changed(struct bfd *bfd) OVS_REQUIRES(mutex)
1173 {
1174     seq_change(connectivity_seq_get());
1175     bfd->status_changed = true;
1176 }
1177
1178 static void
1179 bfd_forwarding_if_rx_update(struct bfd *bfd) OVS_REQUIRES(mutex)
1180 {
1181     int64_t incr = bfd_rx_interval(bfd) * bfd->mult;
1182     bfd->forwarding_if_rx_detect_time = MAX(incr, 2000) + time_msec();
1183 }
1184
1185 static uint32_t
1186 generate_discriminator(void)
1187 {
1188     uint32_t disc = 0;
1189
1190     /* RFC 5880 Section 6.8.1
1191      * It SHOULD be set to a random (but still unique) value to improve
1192      * security.  The value is otherwise outside the scope of this
1193      * specification. */
1194
1195     while (!disc) {
1196         struct bfd *bfd;
1197
1198         /* 'disc' is by definition random, so there's no reason to waste time
1199          * hashing it. */
1200         disc = random_uint32();
1201         HMAP_FOR_EACH_IN_BUCKET (bfd, node, disc, all_bfds) {
1202             if (bfd->disc == disc) {
1203                 disc = 0;
1204                 break;
1205             }
1206         }
1207     }
1208
1209     return disc;
1210 }
1211
1212 static struct bfd *
1213 bfd_find_by_name(const char *name) OVS_REQUIRES(mutex)
1214 {
1215     struct bfd *bfd;
1216
1217     HMAP_FOR_EACH (bfd, node, all_bfds) {
1218         if (!strcmp(bfd->name, name)) {
1219             return bfd;
1220         }
1221     }
1222     return NULL;
1223 }
1224
1225 static void
1226 bfd_put_details(struct ds *ds, const struct bfd *bfd) OVS_REQUIRES(mutex)
1227 {
1228     ds_put_format(ds, "\tForwarding: %s\n",
1229                   bfd_forwarding__(CONST_CAST(struct bfd *, bfd))
1230                   ? "true" : "false");
1231     ds_put_format(ds, "\tDetect Multiplier: %d\n", bfd->mult);
1232     ds_put_format(ds, "\tConcatenated Path Down: %s\n",
1233                   bfd->cpath_down ? "true" : "false");
1234     ds_put_format(ds, "\tTX Interval: Approx %lldms\n", bfd_tx_interval(bfd));
1235     ds_put_format(ds, "\tRX Interval: Approx %lldms\n", bfd_rx_interval(bfd));
1236     ds_put_format(ds, "\tDetect Time: now %+lldms\n",
1237                   time_msec() - bfd->detect_time);
1238     ds_put_format(ds, "\tNext TX Time: now %+lldms\n",
1239                   time_msec() - bfd->next_tx);
1240     ds_put_format(ds, "\tLast TX Time: now %+lldms\n",
1241                   time_msec() - bfd->last_tx);
1242
1243     ds_put_cstr(ds, "\n");
1244
1245     ds_put_format(ds, "\tLocal Flags: %s\n", bfd_flag_str(bfd->flags));
1246     ds_put_format(ds, "\tLocal Session State: %s\n",
1247                   bfd_state_str(bfd->state));
1248     ds_put_format(ds, "\tLocal Diagnostic: %s\n", bfd_diag_str(bfd->diag));
1249     ds_put_format(ds, "\tLocal Discriminator: 0x%"PRIx32"\n", bfd->disc);
1250     ds_put_format(ds, "\tLocal Minimum TX Interval: %lldms\n",
1251                   bfd_min_tx(bfd));
1252     ds_put_format(ds, "\tLocal Minimum RX Interval: %lldms\n", bfd->min_rx);
1253
1254     ds_put_cstr(ds, "\n");
1255
1256     ds_put_format(ds, "\tRemote Flags: %s\n", bfd_flag_str(bfd->rmt_flags));
1257     ds_put_format(ds, "\tRemote Session State: %s\n",
1258                   bfd_state_str(bfd->rmt_state));
1259     ds_put_format(ds, "\tRemote Diagnostic: %s\n",
1260                   bfd_diag_str(bfd->rmt_diag));
1261     ds_put_format(ds, "\tRemote Discriminator: 0x%"PRIx32"\n", bfd->rmt_disc);
1262     ds_put_format(ds, "\tRemote Minimum TX Interval: %lldms\n",
1263                   bfd->rmt_min_tx);
1264     ds_put_format(ds, "\tRemote Minimum RX Interval: %lldms\n",
1265                   bfd->rmt_min_rx);
1266 }
1267
1268 static void
1269 bfd_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
1270                  void *aux OVS_UNUSED) OVS_EXCLUDED(mutex)
1271 {
1272     struct ds ds = DS_EMPTY_INITIALIZER;
1273     struct bfd *bfd;
1274
1275     ovs_mutex_lock(&mutex);
1276     if (argc > 1) {
1277         bfd = bfd_find_by_name(argv[1]);
1278         if (!bfd) {
1279             unixctl_command_reply_error(conn, "no such bfd object");
1280             goto out;
1281         }
1282         bfd_put_details(&ds, bfd);
1283     } else {
1284         HMAP_FOR_EACH (bfd, node, all_bfds) {
1285             ds_put_format(&ds, "---- %s ----\n", bfd->name);
1286             bfd_put_details(&ds, bfd);
1287         }
1288     }
1289     unixctl_command_reply(conn, ds_cstr(&ds));
1290     ds_destroy(&ds);
1291
1292 out:
1293     ovs_mutex_unlock(&mutex);
1294 }
1295
1296
1297 static void
1298 bfd_unixctl_set_forwarding_override(struct unixctl_conn *conn, int argc,
1299                                     const char *argv[], void *aux OVS_UNUSED)
1300     OVS_EXCLUDED(mutex)
1301 {
1302     const char *forward_str = argv[argc - 1];
1303     int forwarding_override;
1304     struct bfd *bfd;
1305
1306     ovs_mutex_lock(&mutex);
1307     if (!strcasecmp("true", forward_str)) {
1308         forwarding_override = 1;
1309     } else if (!strcasecmp("false", forward_str)) {
1310         forwarding_override = 0;
1311     } else if (!strcasecmp("normal", forward_str)) {
1312         forwarding_override = -1;
1313     } else {
1314         unixctl_command_reply_error(conn, "unknown fault string");
1315         goto out;
1316     }
1317
1318     if (argc > 2) {
1319         bfd = bfd_find_by_name(argv[1]);
1320         if (!bfd) {
1321             unixctl_command_reply_error(conn, "no such BFD object");
1322             goto out;
1323         }
1324         bfd->forwarding_override = forwarding_override;
1325         bfd_status_changed(bfd);
1326     } else {
1327         HMAP_FOR_EACH (bfd, node, all_bfds) {
1328             bfd->forwarding_override = forwarding_override;
1329             bfd_status_changed(bfd);
1330         }
1331     }
1332
1333     unixctl_command_reply(conn, "OK");
1334
1335 out:
1336     ovs_mutex_unlock(&mutex);
1337 }