lib/bfd.c

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