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