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