1 /* Copyright (c) 2013 Nicira, Inc.
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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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. */
18 #include <arpa/inet.h>
22 #include "dynamic-string.h"
30 #include "openvswitch/types.h"
32 #include "poll-loop.h"
40 VLOG_DEFINE_THIS_MODULE(bfd);
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
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
57 * - BFD show into ovs-bugtool.
59 * - Set TOS/PCP on inner BFD frame, and outer tunnel header when encapped.
61 * - CFM "check_tnl_key" option equivalent.
63 * - CFM "fault override" equivalent.
65 * - Sending BFD messages should be in its own thread/process.
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?
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
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. */
85 FLAG_MULTIPOINT = 1 << 0,
94 STATE_ADMIN_DOWN = 0 << 6,
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. */
112 /* RFC 5880 Section 4.1
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 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */
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. */
139 BUILD_ASSERT_DECL(BFD_PACKET_LEN == sizeof(struct msg));
141 #define DIAG_MASK 0x1f
143 #define STATE_MASK 0xC0
144 #define FLAGS_MASK 0x3f
147 struct hmap_node node; /* In 'all_bfds'. */
148 uint32_t disc; /* bfd.LocalDiscr. Key in 'all_bfds' hmap. */
150 char *name; /* Name used for logging. */
152 bool cpath_down; /* Concatenated Path Down. */
153 uint8_t mult; /* bfd.DetectMult. */
155 enum state state; /* bfd.SessionState. */
156 enum state rmt_state; /* bfd.RemoteSessionState. */
158 enum diag diag; /* bfd.LocalDiag. */
159 enum diag rmt_diag; /* Remote diagnostic. */
161 enum flags flags; /* Flags sent on messages. */
162 enum flags rmt_flags; /* Flags last received. */
164 uint32_t rmt_disc; /* bfd.RemoteDiscr. */
166 uint16_t udp_src; /* UDP source port. */
168 /* All timers in milliseconds. */
169 long long int rmt_min_rx; /* bfd.RemoteMinRxInterval. */
170 long long int rmt_min_tx; /* Remote minimum TX interval. */
172 long long int cfg_min_tx; /* Configured minimum TX rate. */
173 long long int cfg_min_rx; /* Configured required minimum RX rate. */
174 long long int poll_min_tx; /* Min TX negotating in a poll sequence. */
175 long long int poll_min_rx; /* Min RX negotating in a poll sequence. */
176 long long int min_tx; /* bfd.DesiredMinTxInterval. */
177 long long int min_rx; /* bfd.RequiredMinRxInterval. */
179 long long int last_tx; /* Last TX time. */
180 long long int next_tx; /* Next TX time. */
181 long long int detect_time; /* RFC 5880 6.8.4 Detection time. */
186 static bool bfd_in_poll(const struct bfd *);
187 static void bfd_poll(struct bfd *bfd);
188 static const char *bfd_diag_str(enum diag);
189 static const char *bfd_state_str(enum state);
190 static long long int bfd_min_tx(const struct bfd *);
191 static long long int bfd_tx_interval(const struct bfd *);
192 static long long int bfd_rx_interval(const struct bfd *);
193 static void bfd_set_next_tx(struct bfd *);
194 static void bfd_set_state(struct bfd *, enum state, enum diag);
195 static uint32_t generate_discriminator(void);
196 static void bfd_put_details(struct ds *, const struct bfd *);
197 static void bfd_unixctl_show(struct unixctl_conn *, int argc,
198 const char *argv[], void *aux OVS_UNUSED);
199 static void log_msg(enum vlog_level, const struct msg *, const char *message,
202 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 20);
203 static struct hmap all_bfds = HMAP_INITIALIZER(&all_bfds);
205 /* Returns true if the interface on which 'bfd' is running may be used to
206 * forward traffic according to the BFD session state. */
208 bfd_forwarding(const struct bfd *bfd)
210 return bfd->state == STATE_UP
211 && bfd->rmt_diag != DIAG_PATH_DOWN
212 && bfd->rmt_diag != DIAG_CPATH_DOWN
213 && bfd->rmt_diag != DIAG_RCPATH_DOWN;
216 /* Returns a 'smap' of key value pairs representing the status of 'bfd'
217 * intended for the OVS database. */
219 bfd_get_status(const struct bfd *bfd, struct smap *smap)
221 smap_add(smap, "forwarding", bfd_forwarding(bfd) ? "true" : "false");
222 smap_add(smap, "state", bfd_state_str(bfd->state));
223 smap_add(smap, "diagnostic", bfd_diag_str(bfd->diag));
225 if (bfd->state != STATE_DOWN) {
226 smap_add(smap, "remote_state", bfd_state_str(bfd->rmt_state));
227 smap_add(smap, "remote_diagnostic", bfd_diag_str(bfd->rmt_diag));
231 /* Initializes, destroys, or reconfigures the BFD session 'bfd' (named 'name'),
232 * according to the database configuration contained in 'cfg'. Takes ownership
233 * of 'bfd', which may be NULL. Returns a BFD object which may be used as a
234 * handle for the session, or NULL if BFD is not enabled according to 'cfg'.
235 * Also returns NULL if cfg is NULL. */
237 bfd_configure(struct bfd *bfd, const char *name,
238 const struct smap *cfg)
240 static uint16_t udp_src = 0;
241 static bool init = false;
243 long long int min_tx, min_rx;
247 unixctl_command_register("bfd/show", "[interface]", 0, 1,
248 bfd_unixctl_show, NULL);
252 if (!cfg || !smap_get_bool(cfg, "enable", false)) {
258 bfd = xzalloc(sizeof *bfd);
259 bfd->name = xstrdup(name);
260 bfd->disc = generate_discriminator();
261 hmap_insert(&all_bfds, &bfd->node, bfd->disc);
263 bfd->diag = DIAG_NONE;
268 /* RFC 5881 section 4
269 * The source port MUST be in the range 49152 through 65535. The same
270 * UDP source port number MUST be used for all BFD Control packets
271 * associated with a particular session. The source port number SHOULD
272 * be unique among all BFD sessions on the system. */
273 bfd->udp_src = (udp_src++ % 16384) + 49152;
275 bfd_set_state(bfd, STATE_DOWN, DIAG_NONE);
278 min_tx = smap_get_int(cfg, "min_tx", 100);
279 min_tx = MAX(min_tx, 100);
280 if (bfd->cfg_min_tx != min_tx) {
281 bfd->cfg_min_tx = min_tx;
282 if (bfd->state != STATE_UP
283 || (!bfd_in_poll(bfd) && bfd->cfg_min_tx < bfd->min_tx)) {
284 bfd->min_tx = bfd->cfg_min_tx;
289 min_rx = smap_get_int(cfg, "min_rx", 1000);
290 min_rx = MAX(min_rx, 100);
291 if (bfd->cfg_min_rx != min_rx) {
292 bfd->cfg_min_rx = min_rx;
293 if (bfd->state != STATE_UP
294 || (!bfd_in_poll(bfd) && bfd->cfg_min_rx > bfd->min_rx)) {
295 bfd->min_rx = bfd->cfg_min_rx;
300 cpath_down = smap_get_bool(cfg, "cpath_down", false);
301 if (bfd->cpath_down != cpath_down) {
302 bfd->cpath_down = cpath_down;
303 if (bfd->diag == DIAG_NONE || bfd->diag == DIAG_CPATH_DOWN) {
304 bfd_set_state(bfd, bfd->state, DIAG_NONE);
312 bfd_ref(const struct bfd *bfd_)
314 struct bfd *bfd = CONST_CAST(struct bfd *, bfd_);
316 ovs_assert(bfd->ref_cnt > 0);
323 bfd_unref(struct bfd *bfd)
326 ovs_assert(bfd->ref_cnt > 0);
327 if (!--bfd->ref_cnt) {
328 hmap_remove(&all_bfds, &bfd->node);
336 bfd_wait(const struct bfd *bfd)
338 if (bfd->flags & FLAG_FINAL) {
339 poll_immediate_wake();
342 poll_timer_wait_until(bfd->next_tx);
343 if (bfd->state > STATE_DOWN) {
344 poll_timer_wait_until(bfd->detect_time);
349 bfd_run(struct bfd *bfd)
351 if (bfd->state > STATE_DOWN && time_msec() >= bfd->detect_time) {
352 bfd_set_state(bfd, STATE_DOWN, DIAG_EXPIRED);
355 if (bfd->min_tx != bfd->cfg_min_tx || bfd->min_rx != bfd->cfg_min_rx) {
361 bfd_should_send_packet(const struct bfd *bfd)
363 return bfd->flags & FLAG_FINAL || time_msec() >= bfd->next_tx;
367 bfd_put_packet(struct bfd *bfd, struct ofpbuf *p,
368 uint8_t eth_src[ETH_ADDR_LEN])
370 long long int min_tx, min_rx;
371 struct udp_header *udp;
372 struct eth_header *eth;
373 struct ip_header *ip;
377 long long int delay = time_msec() - bfd->next_tx;
378 long long int interval = bfd_tx_interval(bfd);
379 if (delay > interval * 3 / 2) {
380 VLOG_WARN("%s: long delay of %lldms (expected %lldms) sending BFD"
381 " control message", bfd->name, delay, interval);
385 /* RFC 5880 Section 6.5
386 * A BFD Control packet MUST NOT have both the Poll (P) and Final (F) bits
388 ovs_assert(!(bfd->flags & FLAG_POLL) || !(bfd->flags & FLAG_FINAL));
390 ofpbuf_reserve(p, 2); /* Properly align after the ethernet header. */
391 eth = ofpbuf_put_uninit(p, sizeof *eth);
392 memcpy(eth->eth_dst, eth_addr_broadcast, ETH_ADDR_LEN);
393 memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
394 eth->eth_type = htons(ETH_TYPE_IP);
396 ip = ofpbuf_put_zeros(p, sizeof *ip);
397 ip->ip_ihl_ver = IP_IHL_VER(5, 4);
398 ip->ip_tot_len = htons(sizeof *ip + sizeof *udp + sizeof *msg);
400 ip->ip_proto = IPPROTO_UDP;
401 ip->ip_src = htonl(0xA9FE0100); /* 169.254.1.0 Link Local. */
402 ip->ip_dst = htonl(0xA9FE0101); /* 169.254.1.1 Link Local. */
403 ip->ip_csum = csum(ip, sizeof *ip);
405 udp = ofpbuf_put_zeros(p, sizeof *udp);
406 udp->udp_src = htons(bfd->udp_src);
407 udp->udp_dst = htons(BFD_DEST_PORT);
408 udp->udp_len = htons(sizeof *udp + sizeof *msg);
410 msg = ofpbuf_put_uninit(p, sizeof *msg);
411 msg->vers_diag = (BFD_VERSION << 5) | bfd->diag;
412 msg->flags = (bfd->state & STATE_MASK) | bfd->flags;
414 msg->mult = bfd->mult;
415 msg->length = BFD_PACKET_LEN;
416 msg->my_disc = htonl(bfd->disc);
417 msg->your_disc = htonl(bfd->rmt_disc);
418 msg->min_rx_echo = htonl(0);
420 if (bfd_in_poll(bfd)) {
421 min_tx = bfd->poll_min_tx;
422 min_rx = bfd->poll_min_rx;
424 min_tx = bfd_min_tx(bfd);
425 min_rx = bfd->min_rx;
428 msg->min_tx = htonl(min_tx * 1000);
429 msg->min_rx = htonl(min_rx * 1000);
431 bfd->flags &= ~FLAG_FINAL;
433 log_msg(VLL_DBG, msg, "Sending BFD Message", bfd);
435 bfd->last_tx = time_msec();
436 bfd_set_next_tx(bfd);
440 bfd_should_process_flow(const struct flow *flow, struct flow_wildcards *wc)
442 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
443 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
444 return (flow->dl_type == htons(ETH_TYPE_IP)
445 && flow->nw_proto == IPPROTO_UDP
446 && flow->tp_dst == htons(3784));
450 bfd_process_packet(struct bfd *bfd, const struct flow *flow,
451 const struct ofpbuf *p)
453 uint32_t rmt_min_rx, pkt_your_disc;
454 enum state rmt_state;
459 /* This function is designed to follow section RFC 5880 6.8.6 closely. */
461 if (flow->nw_ttl != 255) {
462 /* XXX Should drop in the kernel to prevent DOS. */
466 msg = ofpbuf_at(p, (uint8_t *)p->l7 - (uint8_t *)p->data, BFD_PACKET_LEN);
468 VLOG_INFO_RL(&rl, "%s: Received unparseable BFD control message.",
473 /* RFC 5880 Section 6.8.6
474 * If the Length field is greater than the payload of the encapsulating
475 * protocol, the packet MUST be discarded.
477 * Note that we make this check implicity. Above we use ofpbuf_at() to
478 * ensure that there are at least BFD_PACKET_LEN bytes in the payload of
479 * the encapsulating protocol. Below we require msg->length to be exactly
480 * BFD_PACKET_LEN bytes. */
482 flags = msg->flags & FLAGS_MASK;
483 rmt_state = msg->flags & STATE_MASK;
484 version = msg->vers_diag >> VERS_SHIFT;
486 log_msg(VLL_DBG, msg, "Received BFD control message", bfd);
488 if (version != BFD_VERSION) {
489 log_msg(VLL_WARN, msg, "Incorrect version", bfd);
493 /* Technically this should happen after the length check. We don't support
494 * authentication however, so it's simpler to do the check first. */
495 if (flags & FLAG_AUTH) {
496 log_msg(VLL_WARN, msg, "Authenticated control message with"
497 " authentication disabled", bfd);
501 if (msg->length != BFD_PACKET_LEN) {
502 log_msg(VLL_WARN, msg, "Unexpected length", bfd);
503 if (msg->length < BFD_PACKET_LEN) {
509 log_msg(VLL_WARN, msg, "Zero multiplier", bfd);
513 if (flags & FLAG_MULTIPOINT) {
514 log_msg(VLL_WARN, msg, "Unsupported multipoint flag", bfd);
519 log_msg(VLL_WARN, msg, "NULL my_disc", bfd);
523 pkt_your_disc = ntohl(msg->your_disc);
525 /* Technically, we should use the your discriminator field to figure
526 * out which 'struct bfd' this packet is destined towards. That way a
527 * bfd session could migrate from one interface to another
528 * transparently. This doesn't fit in with the OVS structure very
529 * well, so in this respect, we are not compliant. */
530 if (pkt_your_disc != bfd->disc) {
531 log_msg(VLL_WARN, msg, "Incorrect your_disc", bfd);
534 } else if (rmt_state > STATE_DOWN) {
535 log_msg(VLL_WARN, msg, "Null your_disc", bfd);
539 bfd->rmt_disc = ntohl(msg->my_disc);
540 bfd->rmt_state = rmt_state;
541 bfd->rmt_flags = flags;
542 bfd->rmt_diag = msg->vers_diag & DIAG_MASK;
544 if (flags & FLAG_FINAL && bfd_in_poll(bfd)) {
545 bfd->min_tx = bfd->poll_min_tx;
546 bfd->min_rx = bfd->poll_min_rx;
547 bfd->flags &= ~FLAG_POLL;
548 log_msg(VLL_INFO, msg, "Poll sequence terminated", bfd);
551 if (flags & FLAG_POLL) {
552 /* RFC 5880 Section 6.5
553 * When the other system receives a Poll, it immediately transmits a
554 * BFD Control packet with the Final (F) bit set, independent of any
555 * periodic BFD Control packets it may be sending
556 * (see section 6.8.7). */
557 bfd->flags &= ~FLAG_POLL;
558 bfd->flags |= FLAG_FINAL;
561 rmt_min_rx = MAX(ntohl(msg->min_rx) / 1000, 1);
562 if (bfd->rmt_min_rx != rmt_min_rx) {
563 bfd->rmt_min_rx = rmt_min_rx;
564 bfd_set_next_tx(bfd);
565 log_msg(VLL_INFO, msg, "New remote min_rx", bfd);
568 bfd->rmt_min_tx = MAX(ntohl(msg->min_tx) / 1000, 1);
569 bfd->detect_time = bfd_rx_interval(bfd) * bfd->mult + time_msec();
571 if (bfd->state == STATE_ADMIN_DOWN) {
572 VLOG_DBG_RL(&rl, "Administratively down, dropping control message.");
576 if (rmt_state == STATE_ADMIN_DOWN) {
577 if (bfd->state != STATE_DOWN) {
578 bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
581 switch (bfd->state) {
583 if (rmt_state == STATE_DOWN) {
584 bfd_set_state(bfd, STATE_INIT, bfd->diag);
585 } else if (rmt_state == STATE_INIT) {
586 bfd_set_state(bfd, STATE_UP, bfd->diag);
590 if (rmt_state > STATE_DOWN) {
591 bfd_set_state(bfd, STATE_UP, bfd->diag);
595 if (rmt_state <= STATE_DOWN) {
596 bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
597 log_msg(VLL_INFO, msg, "Remote signaled STATE_DOWN", bfd);
600 case STATE_ADMIN_DOWN:
605 /* XXX: RFC 5880 Section 6.8.6 Demand mode related calculations here. */
610 bfd_in_poll(const struct bfd *bfd)
612 return (bfd->flags & FLAG_POLL) != 0;
616 bfd_poll(struct bfd *bfd)
618 if (bfd->state > STATE_DOWN && !bfd_in_poll(bfd)
619 && !(bfd->flags & FLAG_FINAL)) {
620 bfd->poll_min_tx = bfd->cfg_min_tx;
621 bfd->poll_min_rx = bfd->cfg_min_rx;
622 bfd->flags |= FLAG_POLL;
624 VLOG_INFO_RL(&rl, "%s: Initiating poll sequence", bfd->name);
629 bfd_min_tx(const struct bfd *bfd)
631 /* RFC 5880 Section 6.8.3
632 * When bfd.SessionState is not Up, the system MUST set
633 * bfd.DesiredMinTxInterval to a value of not less than one second
634 * (1,000,000 microseconds). This is intended to ensure that the
635 * bandwidth consumed by BFD sessions that are not Up is negligible,
636 * particularly in the case where a neighbor may not be running BFD. */
637 return (bfd->state == STATE_UP ? bfd->min_tx : MAX(bfd->min_tx, 1000));
641 bfd_tx_interval(const struct bfd *bfd)
643 long long int interval = bfd_min_tx(bfd);
644 return MAX(interval, bfd->rmt_min_rx);
648 bfd_rx_interval(const struct bfd *bfd)
650 return MAX(bfd->min_rx, bfd->rmt_min_tx);
654 bfd_set_next_tx(struct bfd *bfd)
656 long long int interval = bfd_tx_interval(bfd);
657 interval -= interval * random_range(26) / 100;
658 bfd->next_tx = bfd->last_tx + interval;
662 bfd_flag_str(enum flags flags)
664 struct ds ds = DS_EMPTY_INITIALIZER;
665 static char flag_str[128];
671 if (flags & FLAG_MULTIPOINT) {
672 ds_put_cstr(&ds, "multipoint ");
675 if (flags & FLAG_DEMAND) {
676 ds_put_cstr(&ds, "demand ");
679 if (flags & FLAG_AUTH) {
680 ds_put_cstr(&ds, "auth ");
683 if (flags & FLAG_CTL) {
684 ds_put_cstr(&ds, "ctl ");
687 if (flags & FLAG_FINAL) {
688 ds_put_cstr(&ds, "final ");
691 if (flags & FLAG_POLL) {
692 ds_put_cstr(&ds, "poll ");
695 ovs_strlcpy(flag_str, ds_cstr(&ds), sizeof flag_str);
701 bfd_state_str(enum state state)
704 case STATE_ADMIN_DOWN: return "admin_down";
705 case STATE_DOWN: return "down";
706 case STATE_INIT: return "init";
707 case STATE_UP: return "up";
708 default: return "invalid";
713 bfd_diag_str(enum diag diag) {
715 case DIAG_NONE: return "No Diagnostic";
716 case DIAG_EXPIRED: return "Control Detection Time Expired";
717 case DIAG_ECHO_FAILED: return "Echo Function Failed";
718 case DIAG_RMT_DOWN: return "Neighbor Signaled Session Down";
719 case DIAG_FWD_RESET: return "Forwarding Plane Reset";
720 case DIAG_PATH_DOWN: return "Path Down";
721 case DIAG_CPATH_DOWN: return "Concatenated Path Down";
722 case DIAG_ADMIN_DOWN: return "Administratively Down";
723 case DIAG_RCPATH_DOWN: return "Reverse Concatenated Path Down";
724 default: return "Invalid Diagnostic";
729 log_msg(enum vlog_level level, const struct msg *p, const char *message,
730 const struct bfd *bfd)
732 struct ds ds = DS_EMPTY_INITIALIZER;
734 if (vlog_should_drop(THIS_MODULE, level, &rl)) {
740 "\n\tvers:%"PRIu8" diag:\"%s\" state:%s mult:%"PRIu8
743 "\n\tmy_disc:0x%"PRIx32" your_disc:0x%"PRIx32
744 "\n\tmin_tx:%"PRIu32"us (%"PRIu32"ms)"
745 "\n\tmin_rx:%"PRIu32"us (%"PRIu32"ms)"
746 "\n\tmin_rx_echo:%"PRIu32"us (%"PRIu32"ms)",
747 bfd->name, message, p->vers_diag >> VERS_SHIFT,
748 bfd_diag_str(p->vers_diag & DIAG_MASK),
749 bfd_state_str(p->flags & STATE_MASK),
750 p->mult, p->length, bfd_flag_str(p->flags & FLAGS_MASK),
751 ntohl(p->my_disc), ntohl(p->your_disc),
752 ntohl(p->min_tx), ntohl(p->min_tx) / 1000,
753 ntohl(p->min_rx), ntohl(p->min_rx) / 1000,
754 ntohl(p->min_rx_echo), ntohl(p->min_rx_echo) / 1000);
755 bfd_put_details(&ds, bfd);
756 VLOG(level, "%s", ds_cstr(&ds));
761 bfd_set_state(struct bfd *bfd, enum state state, enum diag diag)
763 if (diag == DIAG_NONE && bfd->cpath_down) {
764 diag = DIAG_CPATH_DOWN;
767 if (bfd->state != state || bfd->diag != diag) {
768 if (!VLOG_DROP_INFO(&rl)) {
769 struct ds ds = DS_EMPTY_INITIALIZER;
771 ds_put_format(&ds, "%s: BFD state change: %s->%s"
772 " \"%s\"->\"%s\".\n",
773 bfd->name, bfd_state_str(bfd->state),
774 bfd_state_str(state), bfd_diag_str(bfd->diag),
776 bfd_put_details(&ds, bfd);
777 VLOG_INFO("%s", ds_cstr(&ds));
784 if (bfd->state <= STATE_DOWN) {
785 bfd->rmt_state = STATE_DOWN;
786 bfd->rmt_diag = DIAG_NONE;
796 generate_discriminator(void)
800 /* RFC 5880 Section 6.8.1
801 * It SHOULD be set to a random (but still unique) value to improve
802 * security. The value is otherwise outside the scope of this
808 /* 'disc' is by definition random, so there's no reason to waste time
810 disc = random_uint32();
811 HMAP_FOR_EACH_IN_BUCKET (bfd, node, disc, &all_bfds) {
812 if (bfd->disc == disc) {
823 bfd_find_by_name(const char *name)
827 HMAP_FOR_EACH (bfd, node, &all_bfds) {
828 if (!strcmp(bfd->name, name)) {
836 bfd_put_details(struct ds *ds, const struct bfd *bfd)
838 ds_put_format(ds, "\tForwarding: %s\n",
839 bfd_forwarding(bfd) ? "true" : "false");
840 ds_put_format(ds, "\tDetect Multiplier: %d\n", bfd->mult);
841 ds_put_format(ds, "\tConcatenated Path Down: %s\n",
842 bfd->cpath_down ? "true" : "false");
843 ds_put_format(ds, "\tTX Interval: Approx %lldms\n", bfd_tx_interval(bfd));
844 ds_put_format(ds, "\tRX Interval: Approx %lldms\n", bfd_rx_interval(bfd));
845 ds_put_format(ds, "\tDetect Time: now %+lldms\n",
846 time_msec() - bfd->detect_time);
847 ds_put_format(ds, "\tNext TX Time: now %+lldms\n",
848 time_msec() - bfd->next_tx);
849 ds_put_format(ds, "\tLast TX Time: now %+lldms\n",
850 time_msec() - bfd->last_tx);
852 ds_put_cstr(ds, "\n");
854 ds_put_format(ds, "\tLocal Flags: %s\n", bfd_flag_str(bfd->flags));
855 ds_put_format(ds, "\tLocal Session State: %s\n",
856 bfd_state_str(bfd->state));
857 ds_put_format(ds, "\tLocal Diagnostic: %s\n", bfd_diag_str(bfd->diag));
858 ds_put_format(ds, "\tLocal Discriminator: 0x%"PRIx32"\n", bfd->disc);
859 ds_put_format(ds, "\tLocal Minimum TX Interval: %lldms\n",
861 ds_put_format(ds, "\tLocal Minimum RX Interval: %lldms\n", bfd->min_rx);
863 ds_put_cstr(ds, "\n");
865 ds_put_format(ds, "\tRemote Flags: %s\n", bfd_flag_str(bfd->rmt_flags));
866 ds_put_format(ds, "\tRemote Session State: %s\n",
867 bfd_state_str(bfd->rmt_state));
868 ds_put_format(ds, "\tRemote Diagnostic: %s\n",
869 bfd_diag_str(bfd->rmt_diag));
870 ds_put_format(ds, "\tRemote Discriminator: 0x%"PRIx32"\n", bfd->rmt_disc);
871 ds_put_format(ds, "\tRemote Minimum TX Interval: %lldms\n",
873 ds_put_format(ds, "\tRemote Minimum RX Interval: %lldms\n",
878 bfd_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
879 void *aux OVS_UNUSED)
881 struct ds ds = DS_EMPTY_INITIALIZER;
885 bfd = bfd_find_by_name(argv[1]);
887 unixctl_command_reply_error(conn, "no such bfd object");
890 bfd_put_details(&ds, bfd);
892 HMAP_FOR_EACH (bfd, node, &all_bfds) {
893 ds_put_format(&ds, "---- %s ----\n", bfd->name);
894 bfd_put_details(&ds, bfd);
897 unixctl_command_reply(conn, ds_cstr(&ds));