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 <sys/types.h>
19 #include <arpa/inet.h>
20 #include <netinet/in_systm.h>
21 #include <netinet/ip.h>
23 #include "byte-order.h"
26 #include "dynamic-string.h"
35 #include "ovs-thread.h"
36 #include "openvswitch/types.h"
38 #include "poll-loop.h"
42 #include "unaligned.h"
47 VLOG_DEFINE_THIS_MODULE(bfd
);
51 * The goal of this module is to replace CFM with something both more flexible
52 * and standards compliant. In service of this goal, the following needs to be
56 * * Implement Demand mode.
57 * * Go through the RFC line by line and verify we comply.
58 * * Test against a hardware implementation. Preferably a popular one.
59 * * Delete BFD packets with nw_ttl != 255 in the datapath to prevent DOS
64 * - Set TOS/PCP on the outer tunnel header when encapped.
66 * - Sending BFD messages should be in its own thread/process.
68 * - Scale testing. How does it operate when there are large number of bfd
69 * sessions? Do we ever have random flaps? What's the CPU utilization?
71 * - Rely on data traffic for liveness by using BFD demand mode.
72 * If we're receiving traffic on a port, we can safely assume it's up (modulo
73 * unidrectional failures). BFD has a demand mode in which it can stay quiet
74 * unless it feels the need to check the status of the port. Using this, we
75 * can implement a strategy in which BFD only sends control messages on dark
78 * - Depending on how one interprets the spec, it appears that a BFD session
79 * can never change bfd.LocalDiag to "No Diagnostic". We should verify that
80 * this is what hardware implementations actually do. Seems like "No
81 * Diagnostic" should be set once a BFD session state goes UP. */
86 FLAG_MULTIPOINT
= 1 << 0,
95 STATE_ADMIN_DOWN
= 0 << 6,
102 DIAG_NONE
= 0, /* No Diagnostic. */
103 DIAG_EXPIRED
= 1, /* Control Detection Time Expired. */
104 DIAG_ECHO_FAILED
= 2, /* Echo Function Failed. */
105 DIAG_RMT_DOWN
= 3, /* Neighbor Signaled Session Down. */
106 DIAG_FWD_RESET
= 4, /* Forwarding Plane Reset. */
107 DIAG_PATH_DOWN
= 5, /* Path Down. */
108 DIAG_CPATH_DOWN
= 6, /* Concatenated Path Down. */
109 DIAG_ADMIN_DOWN
= 7, /* Administratively Down. */
110 DIAG_RCPATH_DOWN
= 8 /* Reverse Concatenated Path Down. */
113 /* RFC 5880 Section 4.1
115 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
116 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
117 * |Vers | Diag |Sta|P|F|C|A|D|M| Detect Mult | Length |
118 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
119 * | My Discriminator |
120 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
121 * | Your Discriminator |
122 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
123 * | Desired Min TX Interval |
124 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
125 * | Required Min RX Interval |
126 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
127 * | Required Min Echo RX Interval |
128 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */
130 uint8_t vers_diag
; /* Version and diagnostic. */
131 uint8_t flags
; /* 2bit State field followed by flags. */
132 uint8_t mult
; /* Fault detection multiplier. */
133 uint8_t length
; /* Length of this BFD message. */
134 ovs_be32 my_disc
; /* My discriminator. */
135 ovs_be32 your_disc
; /* Your discriminator. */
136 ovs_be32 min_tx
; /* Desired minimum tx interval. */
137 ovs_be32 min_rx
; /* Required minimum rx interval. */
138 ovs_be32 min_rx_echo
; /* Required minimum echo rx interval. */
140 BUILD_ASSERT_DECL(BFD_PACKET_LEN
== sizeof(struct msg
));
142 #define DIAG_MASK 0x1f
144 #define STATE_MASK 0xC0
145 #define FLAGS_MASK 0x3f
148 struct hmap_node node
; /* In 'all_bfds'. */
149 uint32_t disc
; /* bfd.LocalDiscr. Key in 'all_bfds' hmap. */
151 char *name
; /* Name used for logging. */
153 bool cpath_down
; /* Concatenated Path Down. */
154 uint8_t mult
; /* bfd.DetectMult. */
156 struct netdev
*netdev
;
157 uint64_t rx_packets
; /* Packets received by 'netdev'. */
159 enum state state
; /* bfd.SessionState. */
160 enum state rmt_state
; /* bfd.RemoteSessionState. */
162 enum diag diag
; /* bfd.LocalDiag. */
163 enum diag rmt_diag
; /* Remote diagnostic. */
165 enum flags flags
; /* Flags sent on messages. */
166 enum flags rmt_flags
; /* Flags last received. */
168 uint32_t rmt_disc
; /* bfd.RemoteDiscr. */
170 uint8_t eth_dst
[ETH_ADDR_LEN
];/* Ethernet destination address. */
171 bool eth_dst_set
; /* 'eth_dst' set through database. */
173 uint16_t udp_src
; /* UDP source port. */
175 /* All timers in milliseconds. */
176 long long int rmt_min_rx
; /* bfd.RemoteMinRxInterval. */
177 long long int rmt_min_tx
; /* Remote minimum TX interval. */
179 long long int cfg_min_tx
; /* Configured minimum TX rate. */
180 long long int cfg_min_rx
; /* Configured required minimum RX rate. */
181 long long int poll_min_tx
; /* Min TX negotating in a poll sequence. */
182 long long int poll_min_rx
; /* Min RX negotating in a poll sequence. */
183 long long int min_tx
; /* bfd.DesiredMinTxInterval. */
184 long long int min_rx
; /* bfd.RequiredMinRxInterval. */
186 long long int last_tx
; /* Last TX time. */
187 long long int next_tx
; /* Next TX time. */
188 long long int detect_time
; /* RFC 5880 6.8.4 Detection time. */
190 int forwarding_override
; /* Manual override of 'forwarding' status. */
192 atomic_bool check_tnl_key
; /* Verify tunnel key of inbound packets? */
195 /* When forward_if_rx is true, bfd_forwarding() will return
196 * true as long as there are incoming packets received.
197 * Note, forwarding_override still has higher priority. */
198 bool forwarding_if_rx
;
199 long long int forwarding_if_rx_detect_time
;
201 /* BFD decay related variables. */
202 bool in_decay
; /* True when bfd is in decay. */
203 int decay_min_rx
; /* min_rx is set to decay_min_rx when */
205 int decay_rx_ctl
; /* Count bfd packets received within decay */
206 /* detect interval. */
207 uint64_t decay_rx_packets
; /* Packets received by 'netdev'. */
208 long long int decay_detect_time
; /* Decay detection time. */
211 static struct ovs_mutex mutex
= OVS_MUTEX_INITIALIZER
;
212 static struct hmap all_bfds__
= HMAP_INITIALIZER(&all_bfds__
);
213 static struct hmap
*const all_bfds
OVS_GUARDED_BY(mutex
) = &all_bfds__
;
215 static bool bfd_forwarding__(const struct bfd
*) OVS_REQUIRES(mutex
);
216 static bool bfd_in_poll(const struct bfd
*) OVS_REQUIRES(mutex
);
217 static void bfd_poll(struct bfd
*bfd
) OVS_REQUIRES(mutex
);
218 static const char *bfd_diag_str(enum diag
) OVS_REQUIRES(mutex
);
219 static const char *bfd_state_str(enum state
) OVS_REQUIRES(mutex
);
220 static long long int bfd_min_tx(const struct bfd
*) OVS_REQUIRES(mutex
);
221 static long long int bfd_tx_interval(const struct bfd
*)
223 static long long int bfd_rx_interval(const struct bfd
*)
225 static void bfd_set_next_tx(struct bfd
*) OVS_REQUIRES(mutex
);
226 static void bfd_set_state(struct bfd
*, enum state
, enum diag
)
228 static uint32_t generate_discriminator(void) OVS_REQUIRES(mutex
);
229 static void bfd_put_details(struct ds
*, const struct bfd
*)
231 static uint64_t bfd_rx_packets(const struct bfd
*) OVS_REQUIRES(mutex
);
232 static void bfd_try_decay(struct bfd
*) OVS_REQUIRES(mutex
);
233 static void bfd_decay_update(struct bfd
*) OVS_REQUIRES(mutex
);
234 static void bfd_check_rx(struct bfd
*) OVS_REQUIRES(mutex
);
235 static void bfd_forwarding_if_rx_update(struct bfd
*) OVS_REQUIRES(mutex
);
236 static void bfd_unixctl_show(struct unixctl_conn
*, int argc
,
237 const char *argv
[], void *aux OVS_UNUSED
);
238 static void bfd_unixctl_set_forwarding_override(struct unixctl_conn
*,
239 int argc
, const char *argv
[],
240 void *aux OVS_UNUSED
);
241 static void log_msg(enum vlog_level
, const struct msg
*, const char *message
,
242 const struct bfd
*) OVS_REQUIRES(mutex
);
244 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(20, 20);
246 /* Returns true if the interface on which 'bfd' is running may be used to
247 * forward traffic according to the BFD session state. */
249 bfd_forwarding(const struct bfd
*bfd
) OVS_EXCLUDED(mutex
)
253 ovs_mutex_lock(&mutex
);
254 ret
= bfd_forwarding__(bfd
);
255 ovs_mutex_unlock(&mutex
);
259 /* Returns a 'smap' of key value pairs representing the status of 'bfd'
260 * intended for the OVS database. */
262 bfd_get_status(const struct bfd
*bfd
, struct smap
*smap
)
265 ovs_mutex_lock(&mutex
);
266 smap_add(smap
, "forwarding", bfd_forwarding__(bfd
)? "true" : "false");
267 smap_add(smap
, "state", bfd_state_str(bfd
->state
));
268 smap_add(smap
, "diagnostic", bfd_diag_str(bfd
->diag
));
270 if (bfd
->state
!= STATE_DOWN
) {
271 smap_add(smap
, "remote_state", bfd_state_str(bfd
->rmt_state
));
272 smap_add(smap
, "remote_diagnostic", bfd_diag_str(bfd
->rmt_diag
));
274 ovs_mutex_unlock(&mutex
);
277 /* Initializes, destroys, or reconfigures the BFD session 'bfd' (named 'name'),
278 * according to the database configuration contained in 'cfg'. Takes ownership
279 * of 'bfd', which may be NULL. Returns a BFD object which may be used as a
280 * handle for the session, or NULL if BFD is not enabled according to 'cfg'.
281 * Also returns NULL if cfg is NULL. */
283 bfd_configure(struct bfd
*bfd
, const char *name
, const struct smap
*cfg
,
284 struct netdev
*netdev
) OVS_EXCLUDED(mutex
)
286 static struct ovsthread_once once
= OVSTHREAD_ONCE_INITIALIZER
;
287 static atomic_uint16_t udp_src
= ATOMIC_VAR_INIT(0);
290 long long int min_tx
, min_rx
;
291 bool need_poll
= false;
292 bool cfg_min_rx_changed
= false;
293 bool cpath_down
, forwarding_if_rx
;
295 uint8_t ea
[ETH_ADDR_LEN
];
297 if (ovsthread_once_start(&once
)) {
298 unixctl_command_register("bfd/show", "[interface]", 0, 1,
299 bfd_unixctl_show
, NULL
);
300 unixctl_command_register("bfd/set-forwarding",
301 "[interface] normal|false|true", 1, 2,
302 bfd_unixctl_set_forwarding_override
, NULL
);
303 ovsthread_once_done(&once
);
306 if (!cfg
|| !smap_get_bool(cfg
, "enable", false)) {
311 ovs_mutex_lock(&mutex
);
313 bfd
= xzalloc(sizeof *bfd
);
314 bfd
->name
= xstrdup(name
);
315 bfd
->forwarding_override
= -1;
316 bfd
->disc
= generate_discriminator();
317 hmap_insert(all_bfds
, &bfd
->node
, bfd
->disc
);
319 bfd
->diag
= DIAG_NONE
;
322 atomic_init(&bfd
->ref_cnt
, 1);
323 bfd
->netdev
= netdev_ref(netdev
);
324 bfd
->rx_packets
= bfd_rx_packets(bfd
);
325 bfd
->in_decay
= false;
327 /* RFC 5881 section 4
328 * The source port MUST be in the range 49152 through 65535. The same
329 * UDP source port number MUST be used for all BFD Control packets
330 * associated with a particular session. The source port number SHOULD
331 * be unique among all BFD sessions on the system. */
332 atomic_add(&udp_src
, 1, &bfd
->udp_src
);
333 bfd
->udp_src
= (bfd
->udp_src
% 16384) + 49152;
335 bfd_set_state(bfd
, STATE_DOWN
, DIAG_NONE
);
337 memcpy(bfd
->eth_dst
, eth_addr_bfd
, ETH_ADDR_LEN
);
340 atomic_store(&bfd
->check_tnl_key
,
341 smap_get_bool(cfg
, "check_tnl_key", false));
342 min_tx
= smap_get_int(cfg
, "min_tx", 100);
343 min_tx
= MAX(min_tx
, 100);
344 if (bfd
->cfg_min_tx
!= min_tx
) {
345 bfd
->cfg_min_tx
= min_tx
;
346 if (bfd
->state
!= STATE_UP
347 || (!bfd_in_poll(bfd
) && bfd
->cfg_min_tx
< bfd
->min_tx
)) {
348 bfd
->min_tx
= bfd
->cfg_min_tx
;
353 min_rx
= smap_get_int(cfg
, "min_rx", 1000);
354 min_rx
= MAX(min_rx
, 100);
355 if (bfd
->cfg_min_rx
!= min_rx
) {
356 bfd
->cfg_min_rx
= min_rx
;
357 if (bfd
->state
!= STATE_UP
358 || (!bfd_in_poll(bfd
) && bfd
->cfg_min_rx
> bfd
->min_rx
)) {
359 bfd
->min_rx
= bfd
->cfg_min_rx
;
361 cfg_min_rx_changed
= true;
365 decay_min_rx
= smap_get_int(cfg
, "decay_min_rx", 0);
366 if (bfd
->decay_min_rx
!= decay_min_rx
|| cfg_min_rx_changed
) {
367 if (decay_min_rx
> 0 && decay_min_rx
< bfd
->cfg_min_rx
) {
368 VLOG_WARN("%s: decay_min_rx cannot be less than %lld ms",
369 bfd
->name
, bfd
->cfg_min_rx
);
370 bfd
->decay_min_rx
= 0;
372 bfd
->decay_min_rx
= decay_min_rx
;
375 bfd
->in_decay
= false;
376 bfd_decay_update(bfd
);
380 cpath_down
= smap_get_bool(cfg
, "cpath_down", false);
381 if (bfd
->cpath_down
!= cpath_down
) {
382 bfd
->cpath_down
= cpath_down
;
383 if (bfd
->diag
== DIAG_NONE
|| bfd
->diag
== DIAG_CPATH_DOWN
) {
384 bfd_set_state(bfd
, bfd
->state
, DIAG_NONE
);
389 hwaddr
= smap_get(cfg
, "bfd_dst_mac");
390 if (hwaddr
&& eth_addr_from_string(hwaddr
, ea
) && !eth_addr_is_zero(ea
)) {
391 memcpy(bfd
->eth_dst
, ea
, ETH_ADDR_LEN
);
392 bfd
->eth_dst_set
= true;
393 } else if (bfd
->eth_dst_set
) {
394 memcpy(bfd
->eth_dst
, eth_addr_bfd
, ETH_ADDR_LEN
);
395 bfd
->eth_dst_set
= false;
398 forwarding_if_rx
= smap_get_bool(cfg
, "forwarding_if_rx", false);
399 if (bfd
->forwarding_if_rx
!= forwarding_if_rx
) {
400 bfd
->forwarding_if_rx
= forwarding_if_rx
;
401 if (bfd
->state
== STATE_UP
&& bfd
->forwarding_if_rx
) {
402 bfd_forwarding_if_rx_update(bfd
);
404 bfd
->forwarding_if_rx_detect_time
= 0;
411 ovs_mutex_unlock(&mutex
);
416 bfd_ref(const struct bfd
*bfd_
)
418 struct bfd
*bfd
= CONST_CAST(struct bfd
*, bfd_
);
421 atomic_add(&bfd
->ref_cnt
, 1, &orig
);
422 ovs_assert(orig
> 0);
428 bfd_unref(struct bfd
*bfd
) OVS_EXCLUDED(mutex
)
433 atomic_sub(&bfd
->ref_cnt
, 1, &orig
);
434 ovs_assert(orig
> 0);
436 ovs_mutex_lock(&mutex
);
437 hmap_remove(all_bfds
, &bfd
->node
);
438 netdev_close(bfd
->netdev
);
441 ovs_mutex_unlock(&mutex
);
447 bfd_wait(const struct bfd
*bfd
) OVS_EXCLUDED(mutex
)
449 poll_timer_wait_until(bfd_wake_time(bfd
));
452 /* Returns the next wake up time. */
454 bfd_wake_time(const struct bfd
*bfd
) OVS_EXCLUDED(mutex
)
456 long long int retval
;
462 ovs_mutex_lock(&mutex
);
463 if (bfd
->flags
& FLAG_FINAL
) {
466 retval
= bfd
->next_tx
;
467 if (bfd
->state
> STATE_DOWN
) {
468 retval
= MIN(bfd
->detect_time
, retval
);
471 ovs_mutex_unlock(&mutex
);
476 bfd_run(struct bfd
*bfd
) OVS_EXCLUDED(mutex
)
481 ovs_mutex_lock(&mutex
);
483 old_in_decay
= bfd
->in_decay
;
485 if (bfd
->state
> STATE_DOWN
&& now
>= bfd
->detect_time
) {
486 bfd_set_state(bfd
, STATE_DOWN
, DIAG_EXPIRED
);
489 /* Decay may only happen when state is STATE_UP, bfd->decay_min_rx is
490 * configured, and decay_detect_time is reached. */
491 if (bfd
->state
== STATE_UP
&& bfd
->decay_min_rx
> 0
492 && now
>= bfd
->decay_detect_time
) {
496 /* Always checks the reception of any packet. */
499 if (bfd
->min_tx
!= bfd
->cfg_min_tx
500 || (bfd
->min_rx
!= bfd
->cfg_min_rx
&& bfd
->min_rx
!= bfd
->decay_min_rx
)
501 || bfd
->in_decay
!= old_in_decay
) {
504 ovs_mutex_unlock(&mutex
);
508 bfd_should_send_packet(const struct bfd
*bfd
) OVS_EXCLUDED(mutex
)
511 ovs_mutex_lock(&mutex
);
512 ret
= bfd
->flags
& FLAG_FINAL
|| time_msec() >= bfd
->next_tx
;
513 ovs_mutex_unlock(&mutex
);
518 bfd_put_packet(struct bfd
*bfd
, struct ofpbuf
*p
,
519 uint8_t eth_src
[ETH_ADDR_LEN
]) OVS_EXCLUDED(mutex
)
521 long long int min_tx
, min_rx
;
522 struct udp_header
*udp
;
523 struct eth_header
*eth
;
524 struct ip_header
*ip
;
527 ovs_mutex_lock(&mutex
);
529 long long int delay
= time_msec() - bfd
->next_tx
;
530 long long int interval
= bfd_tx_interval(bfd
);
531 if (delay
> interval
* 3 / 2) {
532 VLOG_INFO("%s: long delay of %lldms (expected %lldms) sending BFD"
533 " control message", bfd
->name
, delay
, interval
);
537 /* RFC 5880 Section 6.5
538 * A BFD Control packet MUST NOT have both the Poll (P) and Final (F) bits
540 ovs_assert(!(bfd
->flags
& FLAG_POLL
) || !(bfd
->flags
& FLAG_FINAL
));
542 ofpbuf_reserve(p
, 2); /* Properly align after the ethernet header. */
543 eth
= ofpbuf_put_uninit(p
, sizeof *eth
);
544 memcpy(eth
->eth_src
, eth_src
, ETH_ADDR_LEN
);
545 memcpy(eth
->eth_dst
, bfd
->eth_dst
, ETH_ADDR_LEN
);
546 eth
->eth_type
= htons(ETH_TYPE_IP
);
548 ip
= ofpbuf_put_zeros(p
, sizeof *ip
);
549 ip
->ip_ihl_ver
= IP_IHL_VER(5, 4);
550 ip
->ip_tot_len
= htons(sizeof *ip
+ sizeof *udp
+ sizeof *msg
);
552 ip
->ip_tos
= IPTOS_LOWDELAY
| IPTOS_THROUGHPUT
;
553 ip
->ip_proto
= IPPROTO_UDP
;
554 /* Use link local addresses: */
555 put_16aligned_be32(&ip
->ip_src
, htonl(0xA9FE0100)); /* 169.254.1.0. */
556 put_16aligned_be32(&ip
->ip_dst
, htonl(0xA9FE0101)); /* 169.254.1.1. */
557 ip
->ip_csum
= csum(ip
, sizeof *ip
);
559 udp
= ofpbuf_put_zeros(p
, sizeof *udp
);
560 udp
->udp_src
= htons(bfd
->udp_src
);
561 udp
->udp_dst
= htons(BFD_DEST_PORT
);
562 udp
->udp_len
= htons(sizeof *udp
+ sizeof *msg
);
564 msg
= ofpbuf_put_uninit(p
, sizeof *msg
);
565 msg
->vers_diag
= (BFD_VERSION
<< 5) | bfd
->diag
;
566 msg
->flags
= (bfd
->state
& STATE_MASK
) | bfd
->flags
;
568 msg
->mult
= bfd
->mult
;
569 msg
->length
= BFD_PACKET_LEN
;
570 msg
->my_disc
= htonl(bfd
->disc
);
571 msg
->your_disc
= htonl(bfd
->rmt_disc
);
572 msg
->min_rx_echo
= htonl(0);
574 if (bfd_in_poll(bfd
)) {
575 min_tx
= bfd
->poll_min_tx
;
576 min_rx
= bfd
->poll_min_rx
;
578 min_tx
= bfd_min_tx(bfd
);
579 min_rx
= bfd
->min_rx
;
582 msg
->min_tx
= htonl(min_tx
* 1000);
583 msg
->min_rx
= htonl(min_rx
* 1000);
585 bfd
->flags
&= ~FLAG_FINAL
;
587 log_msg(VLL_DBG
, msg
, "Sending BFD Message", bfd
);
589 bfd
->last_tx
= time_msec();
590 bfd_set_next_tx(bfd
);
591 ovs_mutex_unlock(&mutex
);
595 bfd_should_process_flow(const struct bfd
*bfd_
, const struct flow
*flow
,
596 struct flow_wildcards
*wc
)
598 struct bfd
*bfd
= CONST_CAST(struct bfd
*, bfd_
);
601 memset(&wc
->masks
.dl_dst
, 0xff, sizeof wc
->masks
.dl_dst
);
602 if (bfd
->eth_dst_set
&& memcmp(bfd
->eth_dst
, flow
->dl_dst
, ETH_ADDR_LEN
)) {
606 memset(&wc
->masks
.nw_proto
, 0xff, sizeof wc
->masks
.nw_proto
);
607 memset(&wc
->masks
.tp_dst
, 0xff, sizeof wc
->masks
.tp_dst
);
609 atomic_read(&bfd
->check_tnl_key
, &check_tnl_key
);
611 memset(&wc
->masks
.tunnel
.tun_id
, 0xff, sizeof wc
->masks
.tunnel
.tun_id
);
613 return (flow
->dl_type
== htons(ETH_TYPE_IP
)
614 && flow
->nw_proto
== IPPROTO_UDP
615 && flow
->tp_dst
== htons(BFD_DEST_PORT
)
616 && (!check_tnl_key
|| flow
->tunnel
.tun_id
== htonll(0)));
620 bfd_process_packet(struct bfd
*bfd
, const struct flow
*flow
,
621 const struct ofpbuf
*p
) OVS_EXCLUDED(mutex
)
623 uint32_t rmt_min_rx
, pkt_your_disc
;
624 enum state rmt_state
;
629 /* This function is designed to follow section RFC 5880 6.8.6 closely. */
631 ovs_mutex_lock(&mutex
);
632 /* Increments the decay rx counter. */
635 if (flow
->nw_ttl
!= 255) {
636 /* XXX Should drop in the kernel to prevent DOS. */
640 msg
= ofpbuf_at(p
, (uint8_t *)p
->l7
- (uint8_t *)p
->data
, BFD_PACKET_LEN
);
642 VLOG_INFO_RL(&rl
, "%s: Received too-short BFD control message (only "
643 "%td bytes long, at least %d required).",
644 bfd
->name
, (uint8_t *) ofpbuf_tail(p
) - (uint8_t *) p
->l7
,
649 /* RFC 5880 Section 6.8.6
650 * If the Length field is greater than the payload of the encapsulating
651 * protocol, the packet MUST be discarded.
653 * Note that we make this check implicity. Above we use ofpbuf_at() to
654 * ensure that there are at least BFD_PACKET_LEN bytes in the payload of
655 * the encapsulating protocol. Below we require msg->length to be exactly
656 * BFD_PACKET_LEN bytes. */
658 flags
= msg
->flags
& FLAGS_MASK
;
659 rmt_state
= msg
->flags
& STATE_MASK
;
660 version
= msg
->vers_diag
>> VERS_SHIFT
;
662 log_msg(VLL_DBG
, msg
, "Received BFD control message", bfd
);
664 if (version
!= BFD_VERSION
) {
665 log_msg(VLL_WARN
, msg
, "Incorrect version", bfd
);
669 /* Technically this should happen after the length check. We don't support
670 * authentication however, so it's simpler to do the check first. */
671 if (flags
& FLAG_AUTH
) {
672 log_msg(VLL_WARN
, msg
, "Authenticated control message with"
673 " authentication disabled", bfd
);
677 if (msg
->length
!= BFD_PACKET_LEN
) {
678 log_msg(VLL_WARN
, msg
, "Unexpected length", bfd
);
679 if (msg
->length
< BFD_PACKET_LEN
) {
685 log_msg(VLL_WARN
, msg
, "Zero multiplier", bfd
);
689 if (flags
& FLAG_MULTIPOINT
) {
690 log_msg(VLL_WARN
, msg
, "Unsupported multipoint flag", bfd
);
695 log_msg(VLL_WARN
, msg
, "NULL my_disc", bfd
);
699 pkt_your_disc
= ntohl(msg
->your_disc
);
701 /* Technically, we should use the your discriminator field to figure
702 * out which 'struct bfd' this packet is destined towards. That way a
703 * bfd session could migrate from one interface to another
704 * transparently. This doesn't fit in with the OVS structure very
705 * well, so in this respect, we are not compliant. */
706 if (pkt_your_disc
!= bfd
->disc
) {
707 log_msg(VLL_WARN
, msg
, "Incorrect your_disc", bfd
);
710 } else if (rmt_state
> STATE_DOWN
) {
711 log_msg(VLL_WARN
, msg
, "Null your_disc", bfd
);
715 bfd
->rmt_disc
= ntohl(msg
->my_disc
);
716 bfd
->rmt_state
= rmt_state
;
717 bfd
->rmt_flags
= flags
;
718 bfd
->rmt_diag
= msg
->vers_diag
& DIAG_MASK
;
720 if (flags
& FLAG_FINAL
&& bfd_in_poll(bfd
)) {
721 bfd
->min_tx
= bfd
->poll_min_tx
;
722 bfd
->min_rx
= bfd
->poll_min_rx
;
723 bfd
->flags
&= ~FLAG_POLL
;
724 log_msg(VLL_INFO
, msg
, "Poll sequence terminated", bfd
);
727 if (flags
& FLAG_POLL
) {
728 /* RFC 5880 Section 6.5
729 * When the other system receives a Poll, it immediately transmits a
730 * BFD Control packet with the Final (F) bit set, independent of any
731 * periodic BFD Control packets it may be sending
732 * (see section 6.8.7). */
733 bfd
->flags
&= ~FLAG_POLL
;
734 bfd
->flags
|= FLAG_FINAL
;
737 rmt_min_rx
= MAX(ntohl(msg
->min_rx
) / 1000, 1);
738 if (bfd
->rmt_min_rx
!= rmt_min_rx
) {
739 bfd
->rmt_min_rx
= rmt_min_rx
;
740 bfd_set_next_tx(bfd
);
741 log_msg(VLL_INFO
, msg
, "New remote min_rx", bfd
);
744 bfd
->rmt_min_tx
= MAX(ntohl(msg
->min_tx
) / 1000, 1);
745 bfd
->detect_time
= bfd_rx_interval(bfd
) * bfd
->mult
+ time_msec();
747 if (bfd
->state
== STATE_ADMIN_DOWN
) {
748 VLOG_DBG_RL(&rl
, "Administratively down, dropping control message.");
752 if (rmt_state
== STATE_ADMIN_DOWN
) {
753 if (bfd
->state
!= STATE_DOWN
) {
754 bfd_set_state(bfd
, STATE_DOWN
, DIAG_RMT_DOWN
);
757 switch (bfd
->state
) {
759 if (rmt_state
== STATE_DOWN
) {
760 bfd_set_state(bfd
, STATE_INIT
, bfd
->diag
);
761 } else if (rmt_state
== STATE_INIT
) {
762 bfd_set_state(bfd
, STATE_UP
, bfd
->diag
);
766 if (rmt_state
> STATE_DOWN
) {
767 bfd_set_state(bfd
, STATE_UP
, bfd
->diag
);
771 if (rmt_state
<= STATE_DOWN
) {
772 bfd_set_state(bfd
, STATE_DOWN
, DIAG_RMT_DOWN
);
773 log_msg(VLL_INFO
, msg
, "Remote signaled STATE_DOWN", bfd
);
776 case STATE_ADMIN_DOWN
:
781 /* XXX: RFC 5880 Section 6.8.6 Demand mode related calculations here. */
784 ovs_mutex_unlock(&mutex
);
787 /* Must be called when the netdev owned by 'bfd' should change. */
789 bfd_set_netdev(struct bfd
*bfd
, const struct netdev
*netdev
)
792 ovs_mutex_lock(&mutex
);
793 if (bfd
->netdev
!= netdev
) {
794 netdev_close(bfd
->netdev
);
795 bfd
->netdev
= netdev_ref(netdev
);
796 if (bfd
->decay_min_rx
&& bfd
->state
== STATE_UP
) {
797 bfd_decay_update(bfd
);
799 if (bfd
->forwarding_if_rx
&& bfd
->state
== STATE_UP
) {
800 bfd_forwarding_if_rx_update(bfd
);
802 bfd
->rx_packets
= bfd_rx_packets(bfd
);
804 ovs_mutex_unlock(&mutex
);
809 bfd_forwarding__(const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
813 if (bfd
->forwarding_override
!= -1) {
814 return bfd
->forwarding_override
== 1;
817 time
= bfd
->forwarding_if_rx_detect_time
;
818 return (bfd
->state
== STATE_UP
819 || (bfd
->forwarding_if_rx
&& time
> time_msec()))
820 && bfd
->rmt_diag
!= DIAG_PATH_DOWN
821 && bfd
->rmt_diag
!= DIAG_CPATH_DOWN
822 && bfd
->rmt_diag
!= DIAG_RCPATH_DOWN
;
827 bfd_in_poll(const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
829 return (bfd
->flags
& FLAG_POLL
) != 0;
833 bfd_poll(struct bfd
*bfd
) OVS_REQUIRES(mutex
)
835 if (bfd
->state
> STATE_DOWN
&& !bfd_in_poll(bfd
)
836 && !(bfd
->flags
& FLAG_FINAL
)) {
837 bfd
->poll_min_tx
= bfd
->cfg_min_tx
;
838 bfd
->poll_min_rx
= bfd
->in_decay
? bfd
->decay_min_rx
: bfd
->cfg_min_rx
;
839 bfd
->flags
|= FLAG_POLL
;
841 VLOG_INFO_RL(&rl
, "%s: Initiating poll sequence", bfd
->name
);
846 bfd_min_tx(const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
848 /* RFC 5880 Section 6.8.3
849 * When bfd.SessionState is not Up, the system MUST set
850 * bfd.DesiredMinTxInterval to a value of not less than one second
851 * (1,000,000 microseconds). This is intended to ensure that the
852 * bandwidth consumed by BFD sessions that are not Up is negligible,
853 * particularly in the case where a neighbor may not be running BFD. */
854 return (bfd
->state
== STATE_UP
? bfd
->min_tx
: MAX(bfd
->min_tx
, 1000));
858 bfd_tx_interval(const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
860 long long int interval
= bfd_min_tx(bfd
);
861 return MAX(interval
, bfd
->rmt_min_rx
);
865 bfd_rx_interval(const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
867 return MAX(bfd
->min_rx
, bfd
->rmt_min_tx
);
871 bfd_set_next_tx(struct bfd
*bfd
) OVS_REQUIRES(mutex
)
873 long long int interval
= bfd_tx_interval(bfd
);
874 interval
-= interval
* random_range(26) / 100;
875 bfd
->next_tx
= bfd
->last_tx
+ interval
;
879 bfd_flag_str(enum flags flags
)
881 struct ds ds
= DS_EMPTY_INITIALIZER
;
882 static char flag_str
[128];
888 if (flags
& FLAG_MULTIPOINT
) {
889 ds_put_cstr(&ds
, "multipoint ");
892 if (flags
& FLAG_DEMAND
) {
893 ds_put_cstr(&ds
, "demand ");
896 if (flags
& FLAG_AUTH
) {
897 ds_put_cstr(&ds
, "auth ");
900 if (flags
& FLAG_CTL
) {
901 ds_put_cstr(&ds
, "ctl ");
904 if (flags
& FLAG_FINAL
) {
905 ds_put_cstr(&ds
, "final ");
908 if (flags
& FLAG_POLL
) {
909 ds_put_cstr(&ds
, "poll ");
912 /* Do not copy the trailing whitespace. */
914 ovs_strlcpy(flag_str
, ds_cstr(&ds
), sizeof flag_str
);
920 bfd_state_str(enum state state
)
923 case STATE_ADMIN_DOWN
: return "admin_down";
924 case STATE_DOWN
: return "down";
925 case STATE_INIT
: return "init";
926 case STATE_UP
: return "up";
927 default: return "invalid";
932 bfd_diag_str(enum diag diag
) {
934 case DIAG_NONE
: return "No Diagnostic";
935 case DIAG_EXPIRED
: return "Control Detection Time Expired";
936 case DIAG_ECHO_FAILED
: return "Echo Function Failed";
937 case DIAG_RMT_DOWN
: return "Neighbor Signaled Session Down";
938 case DIAG_FWD_RESET
: return "Forwarding Plane Reset";
939 case DIAG_PATH_DOWN
: return "Path Down";
940 case DIAG_CPATH_DOWN
: return "Concatenated Path Down";
941 case DIAG_ADMIN_DOWN
: return "Administratively Down";
942 case DIAG_RCPATH_DOWN
: return "Reverse Concatenated Path Down";
943 default: return "Invalid Diagnostic";
948 log_msg(enum vlog_level level
, const struct msg
*p
, const char *message
,
949 const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
951 struct ds ds
= DS_EMPTY_INITIALIZER
;
953 if (vlog_should_drop(THIS_MODULE
, level
, &rl
)) {
959 "\n\tvers:%"PRIu8
" diag:\"%s\" state:%s mult:%"PRIu8
962 "\n\tmy_disc:0x%"PRIx32
" your_disc:0x%"PRIx32
963 "\n\tmin_tx:%"PRIu32
"us (%"PRIu32
"ms)"
964 "\n\tmin_rx:%"PRIu32
"us (%"PRIu32
"ms)"
965 "\n\tmin_rx_echo:%"PRIu32
"us (%"PRIu32
"ms)",
966 bfd
->name
, message
, p
->vers_diag
>> VERS_SHIFT
,
967 bfd_diag_str(p
->vers_diag
& DIAG_MASK
),
968 bfd_state_str(p
->flags
& STATE_MASK
),
969 p
->mult
, p
->length
, bfd_flag_str(p
->flags
& FLAGS_MASK
),
970 ntohl(p
->my_disc
), ntohl(p
->your_disc
),
971 ntohl(p
->min_tx
), ntohl(p
->min_tx
) / 1000,
972 ntohl(p
->min_rx
), ntohl(p
->min_rx
) / 1000,
973 ntohl(p
->min_rx_echo
), ntohl(p
->min_rx_echo
) / 1000);
974 bfd_put_details(&ds
, bfd
);
975 VLOG(level
, "%s", ds_cstr(&ds
));
980 bfd_set_state(struct bfd
*bfd
, enum state state
, enum diag diag
)
983 if (diag
== DIAG_NONE
&& bfd
->cpath_down
) {
984 diag
= DIAG_CPATH_DOWN
;
987 if (bfd
->state
!= state
|| bfd
->diag
!= diag
) {
988 if (!VLOG_DROP_INFO(&rl
)) {
989 struct ds ds
= DS_EMPTY_INITIALIZER
;
991 ds_put_format(&ds
, "%s: BFD state change: %s->%s"
992 " \"%s\"->\"%s\".\n",
993 bfd
->name
, bfd_state_str(bfd
->state
),
994 bfd_state_str(state
), bfd_diag_str(bfd
->diag
),
996 bfd_put_details(&ds
, bfd
);
997 VLOG_INFO("%s", ds_cstr(&ds
));
1004 if (bfd
->state
<= STATE_DOWN
) {
1005 bfd
->rmt_state
= STATE_DOWN
;
1006 bfd
->rmt_diag
= DIAG_NONE
;
1007 bfd
->rmt_min_rx
= 1;
1010 bfd
->rmt_min_tx
= 0;
1011 /* Resets the min_rx if in_decay. */
1012 if (bfd
->in_decay
) {
1013 bfd
->min_rx
= bfd
->cfg_min_rx
;
1014 bfd
->in_decay
= false;
1017 /* Resets the decay when state changes to STATE_UP
1018 * and decay_min_rx is configured. */
1019 if (bfd
->state
== STATE_UP
&& bfd
->decay_min_rx
) {
1020 bfd_decay_update(bfd
);
1026 bfd_rx_packets(const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
1028 struct netdev_stats stats
;
1030 if (!netdev_get_stats(bfd
->netdev
, &stats
)) {
1031 return stats
.rx_packets
;
1037 /* Decays the bfd->min_rx to bfd->decay_min_rx when 'diff' is less than
1038 * the 'expect' value. */
1040 bfd_try_decay(struct bfd
*bfd
) OVS_REQUIRES(mutex
)
1042 int64_t diff
, expect
;
1044 /* The 'diff' is the difference between current interface rx_packets
1045 * stats and last-time check. The 'expect' is the recorded number of
1046 * bfd control packets received within an approximately decay_min_rx
1047 * (2000 ms if decay_min_rx is less than 2000 ms) interval.
1049 * Since the update of rx_packets stats at interface happens
1050 * asynchronously to the bfd_rx_packets() function, the 'diff' value
1051 * can be jittered. Thusly, we double the decay_rx_ctl to provide
1052 * more wiggle room. */
1053 diff
= bfd_rx_packets(bfd
) - bfd
->decay_rx_packets
;
1054 expect
= 2 * MAX(bfd
->decay_rx_ctl
, 1);
1055 bfd
->in_decay
= diff
<= expect
? true : false;
1056 bfd_decay_update(bfd
);
1059 /* Updates the rx_packets, decay_rx_ctl and decay_detect_time. */
1061 bfd_decay_update(struct bfd
* bfd
) OVS_REQUIRES(mutex
)
1063 bfd
->decay_rx_packets
= bfd_rx_packets(bfd
);
1064 bfd
->decay_rx_ctl
= 0;
1065 bfd
->decay_detect_time
= MAX(bfd
->decay_min_rx
, 2000) + time_msec();
1068 /* Checks if there are packets received during the time since last call.
1069 * If forwarding_if_rx is enabled and packets are received, updates the
1070 * forwarding_if_rx_detect_time. */
1072 bfd_check_rx(struct bfd
*bfd
) OVS_REQUIRES(mutex
)
1074 uint64_t rx_packets
= bfd_rx_packets(bfd
);
1077 diff
= rx_packets
- bfd
->rx_packets
;
1078 bfd
->rx_packets
= rx_packets
;
1080 VLOG_INFO_RL(&rl
, "rx_packets count is smaller than last time.");
1082 if (bfd
->forwarding_if_rx
&& diff
> 0) {
1083 bfd_forwarding_if_rx_update(bfd
);
1087 /* Updates the forwarding_if_rx_detect_time. */
1089 bfd_forwarding_if_rx_update(struct bfd
*bfd
) OVS_REQUIRES(mutex
)
1091 int64_t incr
= bfd_rx_interval(bfd
) * bfd
->mult
;
1092 bfd
->forwarding_if_rx_detect_time
= MAX(incr
, 2000) + time_msec();
1096 generate_discriminator(void)
1100 /* RFC 5880 Section 6.8.1
1101 * It SHOULD be set to a random (but still unique) value to improve
1102 * security. The value is otherwise outside the scope of this
1108 /* 'disc' is by definition random, so there's no reason to waste time
1110 disc
= random_uint32();
1111 HMAP_FOR_EACH_IN_BUCKET (bfd
, node
, disc
, all_bfds
) {
1112 if (bfd
->disc
== disc
) {
1123 bfd_find_by_name(const char *name
) OVS_REQUIRES(mutex
)
1127 HMAP_FOR_EACH (bfd
, node
, all_bfds
) {
1128 if (!strcmp(bfd
->name
, name
)) {
1136 bfd_put_details(struct ds
*ds
, const struct bfd
*bfd
) OVS_REQUIRES(mutex
)
1138 ds_put_format(ds
, "\tForwarding: %s\n",
1139 bfd_forwarding__(bfd
) ? "true" : "false");
1140 ds_put_format(ds
, "\tDetect Multiplier: %d\n", bfd
->mult
);
1141 ds_put_format(ds
, "\tConcatenated Path Down: %s\n",
1142 bfd
->cpath_down
? "true" : "false");
1143 ds_put_format(ds
, "\tTX Interval: Approx %lldms\n", bfd_tx_interval(bfd
));
1144 ds_put_format(ds
, "\tRX Interval: Approx %lldms\n", bfd_rx_interval(bfd
));
1145 ds_put_format(ds
, "\tDetect Time: now %+lldms\n",
1146 time_msec() - bfd
->detect_time
);
1147 ds_put_format(ds
, "\tNext TX Time: now %+lldms\n",
1148 time_msec() - bfd
->next_tx
);
1149 ds_put_format(ds
, "\tLast TX Time: now %+lldms\n",
1150 time_msec() - bfd
->last_tx
);
1152 ds_put_cstr(ds
, "\n");
1154 ds_put_format(ds
, "\tLocal Flags: %s\n", bfd_flag_str(bfd
->flags
));
1155 ds_put_format(ds
, "\tLocal Session State: %s\n",
1156 bfd_state_str(bfd
->state
));
1157 ds_put_format(ds
, "\tLocal Diagnostic: %s\n", bfd_diag_str(bfd
->diag
));
1158 ds_put_format(ds
, "\tLocal Discriminator: 0x%"PRIx32
"\n", bfd
->disc
);
1159 ds_put_format(ds
, "\tLocal Minimum TX Interval: %lldms\n",
1161 ds_put_format(ds
, "\tLocal Minimum RX Interval: %lldms\n", bfd
->min_rx
);
1163 ds_put_cstr(ds
, "\n");
1165 ds_put_format(ds
, "\tRemote Flags: %s\n", bfd_flag_str(bfd
->rmt_flags
));
1166 ds_put_format(ds
, "\tRemote Session State: %s\n",
1167 bfd_state_str(bfd
->rmt_state
));
1168 ds_put_format(ds
, "\tRemote Diagnostic: %s\n",
1169 bfd_diag_str(bfd
->rmt_diag
));
1170 ds_put_format(ds
, "\tRemote Discriminator: 0x%"PRIx32
"\n", bfd
->rmt_disc
);
1171 ds_put_format(ds
, "\tRemote Minimum TX Interval: %lldms\n",
1173 ds_put_format(ds
, "\tRemote Minimum RX Interval: %lldms\n",
1178 bfd_unixctl_show(struct unixctl_conn
*conn
, int argc
, const char *argv
[],
1179 void *aux OVS_UNUSED
) OVS_EXCLUDED(mutex
)
1181 struct ds ds
= DS_EMPTY_INITIALIZER
;
1184 ovs_mutex_lock(&mutex
);
1186 bfd
= bfd_find_by_name(argv
[1]);
1188 unixctl_command_reply_error(conn
, "no such bfd object");
1191 bfd_put_details(&ds
, bfd
);
1193 HMAP_FOR_EACH (bfd
, node
, all_bfds
) {
1194 ds_put_format(&ds
, "---- %s ----\n", bfd
->name
);
1195 bfd_put_details(&ds
, bfd
);
1198 unixctl_command_reply(conn
, ds_cstr(&ds
));
1202 ovs_mutex_unlock(&mutex
);
1207 bfd_unixctl_set_forwarding_override(struct unixctl_conn
*conn
, int argc
,
1208 const char *argv
[], void *aux OVS_UNUSED
)
1211 const char *forward_str
= argv
[argc
- 1];
1212 int forwarding_override
;
1215 ovs_mutex_lock(&mutex
);
1216 if (!strcasecmp("true", forward_str
)) {
1217 forwarding_override
= 1;
1218 } else if (!strcasecmp("false", forward_str
)) {
1219 forwarding_override
= 0;
1220 } else if (!strcasecmp("normal", forward_str
)) {
1221 forwarding_override
= -1;
1223 unixctl_command_reply_error(conn
, "unknown fault string");
1228 bfd
= bfd_find_by_name(argv
[1]);
1230 unixctl_command_reply_error(conn
, "no such BFD object");
1233 bfd
->forwarding_override
= forwarding_override
;
1235 HMAP_FOR_EACH (bfd
, node
, all_bfds
) {
1236 bfd
->forwarding_override
= forwarding_override
;
1240 unixctl_command_reply(conn
, "OK");
1243 ovs_mutex_unlock(&mutex
);