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