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