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>
20 #include "byte-order.h"
23 #include "dynamic-string.h"
31 #include "openvswitch/types.h"
33 #include "poll-loop.h"
41 VLOG_DEFINE_THIS_MODULE(bfd);
45 * The goal of this module is to replace CFM with something both more flexible
46 * and standards compliant. In service of this goal, the following needs to be
50 * * Implement Demand mode.
51 * * Go through the RFC line by line and verify we comply.
52 * * Test against a hardware implementation. Preferably a popular one.
53 * * Delete BFD packets with nw_ttl != 255 in the datapath to prevent DOS
58 * - BFD show into ovs-bugtool.
60 * - Set TOS/PCP on inner BFD frame, and outer tunnel header when encapped.
62 * - Sending BFD messages should be in its own thread/process.
64 * - Scale testing. How does it operate when there are large number of bfd
65 * sessions? Do we ever have random flaps? What's the CPU utilization?
67 * - Rely on data traffic for liveness by using BFD demand mode.
68 * If we're receiving traffic on a port, we can safely assume it's up (modulo
69 * unidrectional failures). BFD has a demand mode in which it can stay quiet
70 * unless it feels the need to check the status of the port. Using this, we
71 * can implement a strategy in which BFD only sends control messages on dark
74 * - Depending on how one interprets the spec, it appears that a BFD session
75 * can never change bfd.LocalDiag to "No Diagnostic". We should verify that
76 * this is what hardware implementations actually do. Seems like "No
77 * Diagnostic" should be set once a BFD session state goes UP. */
82 FLAG_MULTIPOINT = 1 << 0,
91 STATE_ADMIN_DOWN = 0 << 6,
98 DIAG_NONE = 0, /* No Diagnostic. */
99 DIAG_EXPIRED = 1, /* Control Detection Time Expired. */
100 DIAG_ECHO_FAILED = 2, /* Echo Function Failed. */
101 DIAG_RMT_DOWN = 3, /* Neighbor Signaled Session Down. */
102 DIAG_FWD_RESET = 4, /* Forwarding Plane Reset. */
103 DIAG_PATH_DOWN = 5, /* Path Down. */
104 DIAG_CPATH_DOWN = 6, /* Concatenated Path Down. */
105 DIAG_ADMIN_DOWN = 7, /* Administratively Down. */
106 DIAG_RCPATH_DOWN = 8 /* Reverse Concatenated Path Down. */
109 /* RFC 5880 Section 4.1
111 * 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
112 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
113 * |Vers | Diag |Sta|P|F|C|A|D|M| Detect Mult | Length |
114 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
115 * | My Discriminator |
116 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
117 * | Your Discriminator |
118 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
119 * | Desired Min TX Interval |
120 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
121 * | Required Min RX Interval |
122 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
123 * | Required Min Echo RX Interval |
124 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */
126 uint8_t vers_diag; /* Version and diagnostic. */
127 uint8_t flags; /* 2bit State field followed by flags. */
128 uint8_t mult; /* Fault detection multiplier. */
129 uint8_t length; /* Length of this BFD message. */
130 ovs_be32 my_disc; /* My discriminator. */
131 ovs_be32 your_disc; /* Your discriminator. */
132 ovs_be32 min_tx; /* Desired minimum tx interval. */
133 ovs_be32 min_rx; /* Required minimum rx interval. */
134 ovs_be32 min_rx_echo; /* Required minimum echo rx interval. */
136 BUILD_ASSERT_DECL(BFD_PACKET_LEN == sizeof(struct msg));
138 #define DIAG_MASK 0x1f
140 #define STATE_MASK 0xC0
141 #define FLAGS_MASK 0x3f
144 struct hmap_node node; /* In 'all_bfds'. */
145 uint32_t disc; /* bfd.LocalDiscr. Key in 'all_bfds' hmap. */
147 char *name; /* Name used for logging. */
149 bool cpath_down; /* Concatenated Path Down. */
150 uint8_t mult; /* bfd.DetectMult. */
152 enum state state; /* bfd.SessionState. */
153 enum state rmt_state; /* bfd.RemoteSessionState. */
155 enum diag diag; /* bfd.LocalDiag. */
156 enum diag rmt_diag; /* Remote diagnostic. */
158 enum flags flags; /* Flags sent on messages. */
159 enum flags rmt_flags; /* Flags last received. */
161 uint32_t rmt_disc; /* bfd.RemoteDiscr. */
163 uint16_t udp_src; /* UDP source port. */
165 /* All timers in milliseconds. */
166 long long int rmt_min_rx; /* bfd.RemoteMinRxInterval. */
167 long long int rmt_min_tx; /* Remote minimum TX interval. */
169 long long int cfg_min_tx; /* Configured minimum TX rate. */
170 long long int cfg_min_rx; /* Configured required minimum RX rate. */
171 long long int poll_min_tx; /* Min TX negotating in a poll sequence. */
172 long long int poll_min_rx; /* Min RX negotating in a poll sequence. */
173 long long int min_tx; /* bfd.DesiredMinTxInterval. */
174 long long int min_rx; /* bfd.RequiredMinRxInterval. */
176 long long int last_tx; /* Last TX time. */
177 long long int next_tx; /* Next TX time. */
178 long long int detect_time; /* RFC 5880 6.8.4 Detection time. */
181 int forwarding_override; /* Manual override of 'forwarding' status. */
182 bool check_tnl_key; /* Verify tunnel key of inbound packets? */
185 static bool bfd_in_poll(const struct bfd *);
186 static void bfd_poll(struct bfd *bfd);
187 static const char *bfd_diag_str(enum diag);
188 static const char *bfd_state_str(enum state);
189 static long long int bfd_min_tx(const struct bfd *);
190 static long long int bfd_tx_interval(const struct bfd *);
191 static long long int bfd_rx_interval(const struct bfd *);
192 static void bfd_set_next_tx(struct bfd *);
193 static void bfd_set_state(struct bfd *, enum state, enum diag);
194 static uint32_t generate_discriminator(void);
195 static void bfd_put_details(struct ds *, const struct bfd *);
196 static void bfd_unixctl_show(struct unixctl_conn *, int argc,
197 const char *argv[], void *aux OVS_UNUSED);
198 static void bfd_unixctl_set_forwarding_override(struct unixctl_conn *,
199 int argc, const char *argv[],
200 void *aux OVS_UNUSED);
201 static void log_msg(enum vlog_level, const struct msg *, const char *message,
204 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(20, 20);
205 static struct hmap all_bfds = HMAP_INITIALIZER(&all_bfds);
207 /* Returns true if the interface on which 'bfd' is running may be used to
208 * forward traffic according to the BFD session state. */
210 bfd_forwarding(const struct bfd *bfd)
212 if (bfd->forwarding_override != -1) {
213 return bfd->forwarding_override == 1;
216 return bfd->state == STATE_UP
217 && bfd->rmt_diag != DIAG_PATH_DOWN
218 && bfd->rmt_diag != DIAG_CPATH_DOWN
219 && bfd->rmt_diag != DIAG_RCPATH_DOWN;
222 /* Returns a 'smap' of key value pairs representing the status of 'bfd'
223 * intended for the OVS database. */
225 bfd_get_status(const struct bfd *bfd, struct smap *smap)
227 smap_add(smap, "forwarding", bfd_forwarding(bfd) ? "true" : "false");
228 smap_add(smap, "state", bfd_state_str(bfd->state));
229 smap_add(smap, "diagnostic", bfd_diag_str(bfd->diag));
231 if (bfd->state != STATE_DOWN) {
232 smap_add(smap, "remote_state", bfd_state_str(bfd->rmt_state));
233 smap_add(smap, "remote_diagnostic", bfd_diag_str(bfd->rmt_diag));
237 /* Initializes, destroys, or reconfigures the BFD session 'bfd' (named 'name'),
238 * according to the database configuration contained in 'cfg'. Takes ownership
239 * of 'bfd', which may be NULL. Returns a BFD object which may be used as a
240 * handle for the session, or NULL if BFD is not enabled according to 'cfg'.
241 * Also returns NULL if cfg is NULL. */
243 bfd_configure(struct bfd *bfd, const char *name,
244 const struct smap *cfg)
246 static uint16_t udp_src = 0;
247 static bool init = false;
249 long long int min_tx, min_rx;
253 unixctl_command_register("bfd/show", "[interface]", 0, 1,
254 bfd_unixctl_show, NULL);
255 unixctl_command_register("bfd/set-forwarding",
256 "[interface] normal|false|true", 1, 2,
257 bfd_unixctl_set_forwarding_override, NULL);
261 if (!cfg || !smap_get_bool(cfg, "enable", false)) {
267 bfd = xzalloc(sizeof *bfd);
268 bfd->name = xstrdup(name);
269 bfd->forwarding_override = -1;
270 bfd->disc = generate_discriminator();
271 hmap_insert(&all_bfds, &bfd->node, bfd->disc);
273 bfd->diag = DIAG_NONE;
278 /* RFC 5881 section 4
279 * The source port MUST be in the range 49152 through 65535. The same
280 * UDP source port number MUST be used for all BFD Control packets
281 * associated with a particular session. The source port number SHOULD
282 * be unique among all BFD sessions on the system. */
283 bfd->udp_src = (udp_src++ % 16384) + 49152;
285 bfd_set_state(bfd, STATE_DOWN, DIAG_NONE);
288 bfd->check_tnl_key = smap_get_bool(cfg, "check_tnl_key", false);
289 min_tx = smap_get_int(cfg, "min_tx", 100);
290 min_tx = MAX(min_tx, 100);
291 if (bfd->cfg_min_tx != min_tx) {
292 bfd->cfg_min_tx = min_tx;
293 if (bfd->state != STATE_UP
294 || (!bfd_in_poll(bfd) && bfd->cfg_min_tx < bfd->min_tx)) {
295 bfd->min_tx = bfd->cfg_min_tx;
300 min_rx = smap_get_int(cfg, "min_rx", 1000);
301 min_rx = MAX(min_rx, 100);
302 if (bfd->cfg_min_rx != min_rx) {
303 bfd->cfg_min_rx = min_rx;
304 if (bfd->state != STATE_UP
305 || (!bfd_in_poll(bfd) && bfd->cfg_min_rx > bfd->min_rx)) {
306 bfd->min_rx = bfd->cfg_min_rx;
311 cpath_down = smap_get_bool(cfg, "cpath_down", false);
312 if (bfd->cpath_down != cpath_down) {
313 bfd->cpath_down = cpath_down;
314 if (bfd->diag == DIAG_NONE || bfd->diag == DIAG_CPATH_DOWN) {
315 bfd_set_state(bfd, bfd->state, DIAG_NONE);
323 bfd_ref(const struct bfd *bfd_)
325 struct bfd *bfd = CONST_CAST(struct bfd *, bfd_);
327 ovs_assert(bfd->ref_cnt > 0);
334 bfd_unref(struct bfd *bfd)
337 ovs_assert(bfd->ref_cnt > 0);
338 if (!--bfd->ref_cnt) {
339 hmap_remove(&all_bfds, &bfd->node);
347 bfd_wait(const struct bfd *bfd)
349 if (bfd->flags & FLAG_FINAL) {
350 poll_immediate_wake();
353 poll_timer_wait_until(bfd->next_tx);
354 if (bfd->state > STATE_DOWN) {
355 poll_timer_wait_until(bfd->detect_time);
360 bfd_run(struct bfd *bfd)
362 if (bfd->state > STATE_DOWN && time_msec() >= bfd->detect_time) {
363 bfd_set_state(bfd, STATE_DOWN, DIAG_EXPIRED);
366 if (bfd->min_tx != bfd->cfg_min_tx || bfd->min_rx != bfd->cfg_min_rx) {
372 bfd_should_send_packet(const struct bfd *bfd)
374 return bfd->flags & FLAG_FINAL || time_msec() >= bfd->next_tx;
378 bfd_put_packet(struct bfd *bfd, struct ofpbuf *p,
379 uint8_t eth_src[ETH_ADDR_LEN])
381 long long int min_tx, min_rx;
382 struct udp_header *udp;
383 struct eth_header *eth;
384 struct ip_header *ip;
388 long long int delay = time_msec() - bfd->next_tx;
389 long long int interval = bfd_tx_interval(bfd);
390 if (delay > interval * 3 / 2) {
391 VLOG_WARN("%s: long delay of %lldms (expected %lldms) sending BFD"
392 " control message", bfd->name, delay, interval);
396 /* RFC 5880 Section 6.5
397 * A BFD Control packet MUST NOT have both the Poll (P) and Final (F) bits
399 ovs_assert(!(bfd->flags & FLAG_POLL) || !(bfd->flags & FLAG_FINAL));
401 ofpbuf_reserve(p, 2); /* Properly align after the ethernet header. */
402 eth = ofpbuf_put_uninit(p, sizeof *eth);
403 memcpy(eth->eth_dst, eth_addr_broadcast, ETH_ADDR_LEN);
404 memcpy(eth->eth_src, eth_src, ETH_ADDR_LEN);
405 eth->eth_type = htons(ETH_TYPE_IP);
407 ip = ofpbuf_put_zeros(p, sizeof *ip);
408 ip->ip_ihl_ver = IP_IHL_VER(5, 4);
409 ip->ip_tot_len = htons(sizeof *ip + sizeof *udp + sizeof *msg);
411 ip->ip_proto = IPPROTO_UDP;
412 ip->ip_src = htonl(0xA9FE0100); /* 169.254.1.0 Link Local. */
413 ip->ip_dst = htonl(0xA9FE0101); /* 169.254.1.1 Link Local. */
414 ip->ip_csum = csum(ip, sizeof *ip);
416 udp = ofpbuf_put_zeros(p, sizeof *udp);
417 udp->udp_src = htons(bfd->udp_src);
418 udp->udp_dst = htons(BFD_DEST_PORT);
419 udp->udp_len = htons(sizeof *udp + sizeof *msg);
421 msg = ofpbuf_put_uninit(p, sizeof *msg);
422 msg->vers_diag = (BFD_VERSION << 5) | bfd->diag;
423 msg->flags = (bfd->state & STATE_MASK) | bfd->flags;
425 msg->mult = bfd->mult;
426 msg->length = BFD_PACKET_LEN;
427 msg->my_disc = htonl(bfd->disc);
428 msg->your_disc = htonl(bfd->rmt_disc);
429 msg->min_rx_echo = htonl(0);
431 if (bfd_in_poll(bfd)) {
432 min_tx = bfd->poll_min_tx;
433 min_rx = bfd->poll_min_rx;
435 min_tx = bfd_min_tx(bfd);
436 min_rx = bfd->min_rx;
439 msg->min_tx = htonl(min_tx * 1000);
440 msg->min_rx = htonl(min_rx * 1000);
442 bfd->flags &= ~FLAG_FINAL;
444 log_msg(VLL_DBG, msg, "Sending BFD Message", bfd);
446 bfd->last_tx = time_msec();
447 bfd_set_next_tx(bfd);
451 bfd_should_process_flow(const struct bfd *bfd, const struct flow *flow,
452 struct flow_wildcards *wc)
454 memset(&wc->masks.nw_proto, 0xff, sizeof wc->masks.nw_proto);
455 memset(&wc->masks.tp_dst, 0xff, sizeof wc->masks.tp_dst);
456 if (bfd->check_tnl_key) {
457 memset(&wc->masks.tunnel.tun_id, 0xff, sizeof wc->masks.tunnel.tun_id);
459 return (flow->dl_type == htons(ETH_TYPE_IP)
460 && flow->nw_proto == IPPROTO_UDP
461 && flow->tp_dst == htons(3784)
462 && (!bfd->check_tnl_key || flow->tunnel.tun_id == htonll(0)));
466 bfd_process_packet(struct bfd *bfd, const struct flow *flow,
467 const struct ofpbuf *p)
469 uint32_t rmt_min_rx, pkt_your_disc;
470 enum state rmt_state;
475 /* This function is designed to follow section RFC 5880 6.8.6 closely. */
477 if (flow->nw_ttl != 255) {
478 /* XXX Should drop in the kernel to prevent DOS. */
482 msg = ofpbuf_at(p, (uint8_t *)p->l7 - (uint8_t *)p->data, BFD_PACKET_LEN);
484 VLOG_INFO_RL(&rl, "%s: Received unparseable BFD control message.",
489 /* RFC 5880 Section 6.8.6
490 * If the Length field is greater than the payload of the encapsulating
491 * protocol, the packet MUST be discarded.
493 * Note that we make this check implicity. Above we use ofpbuf_at() to
494 * ensure that there are at least BFD_PACKET_LEN bytes in the payload of
495 * the encapsulating protocol. Below we require msg->length to be exactly
496 * BFD_PACKET_LEN bytes. */
498 flags = msg->flags & FLAGS_MASK;
499 rmt_state = msg->flags & STATE_MASK;
500 version = msg->vers_diag >> VERS_SHIFT;
502 log_msg(VLL_DBG, msg, "Received BFD control message", bfd);
504 if (version != BFD_VERSION) {
505 log_msg(VLL_WARN, msg, "Incorrect version", bfd);
509 /* Technically this should happen after the length check. We don't support
510 * authentication however, so it's simpler to do the check first. */
511 if (flags & FLAG_AUTH) {
512 log_msg(VLL_WARN, msg, "Authenticated control message with"
513 " authentication disabled", bfd);
517 if (msg->length != BFD_PACKET_LEN) {
518 log_msg(VLL_WARN, msg, "Unexpected length", bfd);
519 if (msg->length < BFD_PACKET_LEN) {
525 log_msg(VLL_WARN, msg, "Zero multiplier", bfd);
529 if (flags & FLAG_MULTIPOINT) {
530 log_msg(VLL_WARN, msg, "Unsupported multipoint flag", bfd);
535 log_msg(VLL_WARN, msg, "NULL my_disc", bfd);
539 pkt_your_disc = ntohl(msg->your_disc);
541 /* Technically, we should use the your discriminator field to figure
542 * out which 'struct bfd' this packet is destined towards. That way a
543 * bfd session could migrate from one interface to another
544 * transparently. This doesn't fit in with the OVS structure very
545 * well, so in this respect, we are not compliant. */
546 if (pkt_your_disc != bfd->disc) {
547 log_msg(VLL_WARN, msg, "Incorrect your_disc", bfd);
550 } else if (rmt_state > STATE_DOWN) {
551 log_msg(VLL_WARN, msg, "Null your_disc", bfd);
555 bfd->rmt_disc = ntohl(msg->my_disc);
556 bfd->rmt_state = rmt_state;
557 bfd->rmt_flags = flags;
558 bfd->rmt_diag = msg->vers_diag & DIAG_MASK;
560 if (flags & FLAG_FINAL && bfd_in_poll(bfd)) {
561 bfd->min_tx = bfd->poll_min_tx;
562 bfd->min_rx = bfd->poll_min_rx;
563 bfd->flags &= ~FLAG_POLL;
564 log_msg(VLL_INFO, msg, "Poll sequence terminated", bfd);
567 if (flags & FLAG_POLL) {
568 /* RFC 5880 Section 6.5
569 * When the other system receives a Poll, it immediately transmits a
570 * BFD Control packet with the Final (F) bit set, independent of any
571 * periodic BFD Control packets it may be sending
572 * (see section 6.8.7). */
573 bfd->flags &= ~FLAG_POLL;
574 bfd->flags |= FLAG_FINAL;
577 rmt_min_rx = MAX(ntohl(msg->min_rx) / 1000, 1);
578 if (bfd->rmt_min_rx != rmt_min_rx) {
579 bfd->rmt_min_rx = rmt_min_rx;
580 bfd_set_next_tx(bfd);
581 log_msg(VLL_INFO, msg, "New remote min_rx", bfd);
584 bfd->rmt_min_tx = MAX(ntohl(msg->min_tx) / 1000, 1);
585 bfd->detect_time = bfd_rx_interval(bfd) * bfd->mult + time_msec();
587 if (bfd->state == STATE_ADMIN_DOWN) {
588 VLOG_DBG_RL(&rl, "Administratively down, dropping control message.");
592 if (rmt_state == STATE_ADMIN_DOWN) {
593 if (bfd->state != STATE_DOWN) {
594 bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
597 switch (bfd->state) {
599 if (rmt_state == STATE_DOWN) {
600 bfd_set_state(bfd, STATE_INIT, bfd->diag);
601 } else if (rmt_state == STATE_INIT) {
602 bfd_set_state(bfd, STATE_UP, bfd->diag);
606 if (rmt_state > STATE_DOWN) {
607 bfd_set_state(bfd, STATE_UP, bfd->diag);
611 if (rmt_state <= STATE_DOWN) {
612 bfd_set_state(bfd, STATE_DOWN, DIAG_RMT_DOWN);
613 log_msg(VLL_INFO, msg, "Remote signaled STATE_DOWN", bfd);
616 case STATE_ADMIN_DOWN:
621 /* XXX: RFC 5880 Section 6.8.6 Demand mode related calculations here. */
626 bfd_in_poll(const struct bfd *bfd)
628 return (bfd->flags & FLAG_POLL) != 0;
632 bfd_poll(struct bfd *bfd)
634 if (bfd->state > STATE_DOWN && !bfd_in_poll(bfd)
635 && !(bfd->flags & FLAG_FINAL)) {
636 bfd->poll_min_tx = bfd->cfg_min_tx;
637 bfd->poll_min_rx = bfd->cfg_min_rx;
638 bfd->flags |= FLAG_POLL;
640 VLOG_INFO_RL(&rl, "%s: Initiating poll sequence", bfd->name);
645 bfd_min_tx(const struct bfd *bfd)
647 /* RFC 5880 Section 6.8.3
648 * When bfd.SessionState is not Up, the system MUST set
649 * bfd.DesiredMinTxInterval to a value of not less than one second
650 * (1,000,000 microseconds). This is intended to ensure that the
651 * bandwidth consumed by BFD sessions that are not Up is negligible,
652 * particularly in the case where a neighbor may not be running BFD. */
653 return (bfd->state == STATE_UP ? bfd->min_tx : MAX(bfd->min_tx, 1000));
657 bfd_tx_interval(const struct bfd *bfd)
659 long long int interval = bfd_min_tx(bfd);
660 return MAX(interval, bfd->rmt_min_rx);
664 bfd_rx_interval(const struct bfd *bfd)
666 return MAX(bfd->min_rx, bfd->rmt_min_tx);
670 bfd_set_next_tx(struct bfd *bfd)
672 long long int interval = bfd_tx_interval(bfd);
673 interval -= interval * random_range(26) / 100;
674 bfd->next_tx = bfd->last_tx + interval;
678 bfd_flag_str(enum flags flags)
680 struct ds ds = DS_EMPTY_INITIALIZER;
681 static char flag_str[128];
687 if (flags & FLAG_MULTIPOINT) {
688 ds_put_cstr(&ds, "multipoint ");
691 if (flags & FLAG_DEMAND) {
692 ds_put_cstr(&ds, "demand ");
695 if (flags & FLAG_AUTH) {
696 ds_put_cstr(&ds, "auth ");
699 if (flags & FLAG_CTL) {
700 ds_put_cstr(&ds, "ctl ");
703 if (flags & FLAG_FINAL) {
704 ds_put_cstr(&ds, "final ");
707 if (flags & FLAG_POLL) {
708 ds_put_cstr(&ds, "poll ");
711 ovs_strlcpy(flag_str, ds_cstr(&ds), sizeof flag_str);
717 bfd_state_str(enum state state)
720 case STATE_ADMIN_DOWN: return "admin_down";
721 case STATE_DOWN: return "down";
722 case STATE_INIT: return "init";
723 case STATE_UP: return "up";
724 default: return "invalid";
729 bfd_diag_str(enum diag diag) {
731 case DIAG_NONE: return "No Diagnostic";
732 case DIAG_EXPIRED: return "Control Detection Time Expired";
733 case DIAG_ECHO_FAILED: return "Echo Function Failed";
734 case DIAG_RMT_DOWN: return "Neighbor Signaled Session Down";
735 case DIAG_FWD_RESET: return "Forwarding Plane Reset";
736 case DIAG_PATH_DOWN: return "Path Down";
737 case DIAG_CPATH_DOWN: return "Concatenated Path Down";
738 case DIAG_ADMIN_DOWN: return "Administratively Down";
739 case DIAG_RCPATH_DOWN: return "Reverse Concatenated Path Down";
740 default: return "Invalid Diagnostic";
745 log_msg(enum vlog_level level, const struct msg *p, const char *message,
746 const struct bfd *bfd)
748 struct ds ds = DS_EMPTY_INITIALIZER;
750 if (vlog_should_drop(THIS_MODULE, level, &rl)) {
756 "\n\tvers:%"PRIu8" diag:\"%s\" state:%s mult:%"PRIu8
759 "\n\tmy_disc:0x%"PRIx32" your_disc:0x%"PRIx32
760 "\n\tmin_tx:%"PRIu32"us (%"PRIu32"ms)"
761 "\n\tmin_rx:%"PRIu32"us (%"PRIu32"ms)"
762 "\n\tmin_rx_echo:%"PRIu32"us (%"PRIu32"ms)",
763 bfd->name, message, p->vers_diag >> VERS_SHIFT,
764 bfd_diag_str(p->vers_diag & DIAG_MASK),
765 bfd_state_str(p->flags & STATE_MASK),
766 p->mult, p->length, bfd_flag_str(p->flags & FLAGS_MASK),
767 ntohl(p->my_disc), ntohl(p->your_disc),
768 ntohl(p->min_tx), ntohl(p->min_tx) / 1000,
769 ntohl(p->min_rx), ntohl(p->min_rx) / 1000,
770 ntohl(p->min_rx_echo), ntohl(p->min_rx_echo) / 1000);
771 bfd_put_details(&ds, bfd);
772 VLOG(level, "%s", ds_cstr(&ds));
777 bfd_set_state(struct bfd *bfd, enum state state, enum diag diag)
779 if (diag == DIAG_NONE && bfd->cpath_down) {
780 diag = DIAG_CPATH_DOWN;
783 if (bfd->state != state || bfd->diag != diag) {
784 if (!VLOG_DROP_INFO(&rl)) {
785 struct ds ds = DS_EMPTY_INITIALIZER;
787 ds_put_format(&ds, "%s: BFD state change: %s->%s"
788 " \"%s\"->\"%s\".\n",
789 bfd->name, bfd_state_str(bfd->state),
790 bfd_state_str(state), bfd_diag_str(bfd->diag),
792 bfd_put_details(&ds, bfd);
793 VLOG_INFO("%s", ds_cstr(&ds));
800 if (bfd->state <= STATE_DOWN) {
801 bfd->rmt_state = STATE_DOWN;
802 bfd->rmt_diag = DIAG_NONE;
812 generate_discriminator(void)
816 /* RFC 5880 Section 6.8.1
817 * It SHOULD be set to a random (but still unique) value to improve
818 * security. The value is otherwise outside the scope of this
824 /* 'disc' is by definition random, so there's no reason to waste time
826 disc = random_uint32();
827 HMAP_FOR_EACH_IN_BUCKET (bfd, node, disc, &all_bfds) {
828 if (bfd->disc == disc) {
839 bfd_find_by_name(const char *name)
843 HMAP_FOR_EACH (bfd, node, &all_bfds) {
844 if (!strcmp(bfd->name, name)) {
852 bfd_put_details(struct ds *ds, const struct bfd *bfd)
854 ds_put_format(ds, "\tForwarding: %s\n",
855 bfd_forwarding(bfd) ? "true" : "false");
856 ds_put_format(ds, "\tDetect Multiplier: %d\n", bfd->mult);
857 ds_put_format(ds, "\tConcatenated Path Down: %s\n",
858 bfd->cpath_down ? "true" : "false");
859 ds_put_format(ds, "\tTX Interval: Approx %lldms\n", bfd_tx_interval(bfd));
860 ds_put_format(ds, "\tRX Interval: Approx %lldms\n", bfd_rx_interval(bfd));
861 ds_put_format(ds, "\tDetect Time: now %+lldms\n",
862 time_msec() - bfd->detect_time);
863 ds_put_format(ds, "\tNext TX Time: now %+lldms\n",
864 time_msec() - bfd->next_tx);
865 ds_put_format(ds, "\tLast TX Time: now %+lldms\n",
866 time_msec() - bfd->last_tx);
868 ds_put_cstr(ds, "\n");
870 ds_put_format(ds, "\tLocal Flags: %s\n", bfd_flag_str(bfd->flags));
871 ds_put_format(ds, "\tLocal Session State: %s\n",
872 bfd_state_str(bfd->state));
873 ds_put_format(ds, "\tLocal Diagnostic: %s\n", bfd_diag_str(bfd->diag));
874 ds_put_format(ds, "\tLocal Discriminator: 0x%"PRIx32"\n", bfd->disc);
875 ds_put_format(ds, "\tLocal Minimum TX Interval: %lldms\n",
877 ds_put_format(ds, "\tLocal Minimum RX Interval: %lldms\n", bfd->min_rx);
879 ds_put_cstr(ds, "\n");
881 ds_put_format(ds, "\tRemote Flags: %s\n", bfd_flag_str(bfd->rmt_flags));
882 ds_put_format(ds, "\tRemote Session State: %s\n",
883 bfd_state_str(bfd->rmt_state));
884 ds_put_format(ds, "\tRemote Diagnostic: %s\n",
885 bfd_diag_str(bfd->rmt_diag));
886 ds_put_format(ds, "\tRemote Discriminator: 0x%"PRIx32"\n", bfd->rmt_disc);
887 ds_put_format(ds, "\tRemote Minimum TX Interval: %lldms\n",
889 ds_put_format(ds, "\tRemote Minimum RX Interval: %lldms\n",
894 bfd_unixctl_show(struct unixctl_conn *conn, int argc, const char *argv[],
895 void *aux OVS_UNUSED)
897 struct ds ds = DS_EMPTY_INITIALIZER;
901 bfd = bfd_find_by_name(argv[1]);
903 unixctl_command_reply_error(conn, "no such bfd object");
906 bfd_put_details(&ds, bfd);
908 HMAP_FOR_EACH (bfd, node, &all_bfds) {
909 ds_put_format(&ds, "---- %s ----\n", bfd->name);
910 bfd_put_details(&ds, bfd);
913 unixctl_command_reply(conn, ds_cstr(&ds));
919 bfd_unixctl_set_forwarding_override(struct unixctl_conn *conn, int argc,
920 const char *argv[], void *aux OVS_UNUSED)
922 const char *forward_str = argv[argc - 1];
923 int forwarding_override;
926 if (!strcasecmp("true", forward_str)) {
927 forwarding_override = 1;
928 } else if (!strcasecmp("false", forward_str)) {
929 forwarding_override = 0;
930 } else if (!strcasecmp("normal", forward_str)) {
931 forwarding_override = -1;
933 unixctl_command_reply_error(conn, "unknown fault string");
938 bfd = bfd_find_by_name(argv[1]);
940 unixctl_command_reply_error(conn, "no such BFD object");
943 bfd->forwarding_override = forwarding_override;
945 HMAP_FOR_EACH (bfd, node, &all_bfds) {
946 bfd->forwarding_override = forwarding_override;
950 unixctl_command_reply(conn, "OK");