lib/bfd.c

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