1 #include <vppinfra/types.h>
2 #include <vlibmemory/api.h>
4 #include <vlib/buffer.h>
5 #include <vnet/ip/format.h>
6 #include <vnet/ethernet/packet.h>
7 #include <vnet/ip/udp_packet.h>
8 #include <vnet/ip/lookup.h>
9 #include <vnet/ip/icmp46_packet.h>
10 #include <vnet/ip/ip4.h>
11 #include <vnet/ip/ip6.h>
12 #include <vnet/ip/udp.h>
13 #include <vnet/ip/ip6_packet.h>
14 #include <vnet/adj/adj.h>
15 #include <vnet/adj/adj_nbr.h>
16 #include <vnet/bfd/bfd_debug.h>
17 #include <vnet/bfd/bfd_udp.h>
18 #include <vnet/bfd/bfd_main.h>
19 #include <vnet/bfd/bfd_api.h>
24 /* hashmap - bfd session index by bfd key - used for CLI/API lookup, where
25 * discriminator is unknown */
26 mhash_t bfd_session_idx_by_bfd_key;
29 static vlib_node_registration_t bfd_udp4_input_node;
30 static vlib_node_registration_t bfd_udp6_input_node;
32 bfd_udp_main_t bfd_udp_main;
34 void bfd_udp_transport_to_buffer (vlib_main_t *vm, vlib_buffer_t *b,
35 bfd_udp_session_t *bus)
38 u16 udp_length, ip_length;
39 bfd_udp_key_t *key = &bus->key;
41 b->flags |= VNET_BUFFER_LOCALLY_ORIGINATED;
42 if (ip46_address_is_ip4 (&key->local_addr))
45 const size_t data_size = sizeof (*ip4) + sizeof (*udp);
46 vlib_buffer_advance (b, -data_size);
47 ip4 = vlib_buffer_get_current (b);
48 udp = (udp_header_t *)(ip4 + 1);
49 memset (ip4, 0, data_size);
50 ip4->ip_version_and_header_length = 0x45;
52 ip4->protocol = IP_PROTOCOL_UDP;
53 ip4->src_address.as_u32 = key->local_addr.ip4.as_u32;
54 ip4->dst_address.as_u32 = key->peer_addr.ip4.as_u32;
56 udp->src_port = clib_host_to_net_u16 (50000); /* FIXME */
57 udp->dst_port = clib_host_to_net_u16 (UDP_DST_PORT_bfd4);
59 /* fix ip length, checksum and udp length */
60 ip_length = vlib_buffer_length_in_chain (vm, b);
62 ip4->length = clib_host_to_net_u16 (ip_length);
63 ip4->checksum = ip4_header_checksum (ip4);
65 udp_length = ip_length - (sizeof (*ip4));
66 udp->length = clib_host_to_net_u16 (udp_length);
70 BFD_ERR ("not implemented");
75 void bfd_add_udp_transport (vlib_main_t *vm, vlib_buffer_t *b,
76 bfd_udp_session_t *bus)
78 vnet_buffer (b)->ip.adj_index[VLIB_RX] = bus->adj_index;
79 vnet_buffer (b)->ip.adj_index[VLIB_TX] = bus->adj_index;
80 bfd_udp_transport_to_buffer (vm, b, bus);
83 static bfd_session_t *bfd_lookup_session (bfd_udp_main_t *bum,
84 const bfd_udp_key_t *key)
86 uword *p = mhash_get (&bum->bfd_session_idx_by_bfd_key, key);
89 return bfd_find_session_by_idx (bum->bfd_main, *p);
94 static vnet_api_error_t
95 bfd_udp_add_session_internal (bfd_udp_main_t *bum, u32 sw_if_index,
96 u32 desired_min_tx_us, u32 required_min_rx_us,
97 u8 detect_mult, const ip46_address_t *local_addr,
98 const ip46_address_t *peer_addr)
100 vnet_sw_interface_t *sw_if =
101 vnet_get_sw_interface (vnet_get_main (), sw_if_index);
102 /* get a pool entry and if we end up not needing it, give it back */
103 bfd_transport_t t = BFD_TRANSPORT_UDP4;
104 if (!ip46_address_is_ip4 (local_addr))
106 t = BFD_TRANSPORT_UDP6;
108 bfd_session_t *bs = bfd_get_session (bum->bfd_main, t);
109 bfd_udp_session_t *bus = &bs->udp;
110 memset (bus, 0, sizeof (*bus));
111 bfd_udp_key_t *key = &bus->key;
112 key->sw_if_index = sw_if->sw_if_index;
113 key->local_addr.as_u64[0] = local_addr->as_u64[0];
114 key->local_addr.as_u64[1] = local_addr->as_u64[1];
115 key->peer_addr.as_u64[0] = peer_addr->as_u64[0];
116 key->peer_addr.as_u64[1] = peer_addr->as_u64[1];
117 const bfd_session_t *tmp = bfd_lookup_session (bum, key);
120 BFD_ERR ("duplicate bfd-udp session, existing bs_idx=%d", tmp->bs_idx);
121 bfd_put_session (bum->bfd_main, bs);
122 return VNET_API_ERROR_BFD_EEXIST;
124 key->sw_if_index = sw_if->sw_if_index;
125 mhash_set (&bum->bfd_session_idx_by_bfd_key, key, bs->bs_idx, NULL);
126 BFD_DBG ("session created, bs_idx=%u, sw_if_index=%d, local=%U, peer=%U",
127 bs->bs_idx, key->sw_if_index, format_ip46_address, &key->local_addr,
128 IP46_TYPE_ANY, format_ip46_address, &key->peer_addr, IP46_TYPE_ANY);
129 if (BFD_TRANSPORT_UDP4 == t)
131 bus->adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP4, VNET_LINK_IP4,
132 &key->peer_addr, key->sw_if_index);
133 BFD_DBG ("adj_nbr_add_or_lock(FIB_PROTOCOL_IP4, VNET_LINK_IP4, %U, %d) "
135 format_ip46_address, &key->peer_addr, IP46_TYPE_ANY,
136 key->sw_if_index, bus->adj_index);
140 bus->adj_index = adj_nbr_add_or_lock (FIB_PROTOCOL_IP6, VNET_LINK_IP6,
141 &key->peer_addr, key->sw_if_index);
142 BFD_DBG ("adj_nbr_add_or_lock(FIB_PROTOCOL_IP6, VNET_LINK_IP6, %U, %d) "
144 format_ip46_address, &key->peer_addr, IP46_TYPE_ANY,
145 key->sw_if_index, bus->adj_index);
147 bs->config_desired_min_tx_us = desired_min_tx_us;
148 bs->required_min_rx_us = required_min_rx_us;
149 bs->required_min_echo_rx_us = required_min_rx_us; /* FIXME */
150 bs->local_detect_mult = detect_mult;
151 bfd_session_start (bum->bfd_main, bs);
155 static vnet_api_error_t
156 bfd_udp_validate_api_input (u32 sw_if_index, const ip46_address_t *local_addr,
157 const ip46_address_t *peer_addr)
159 vnet_sw_interface_t *sw_if =
160 vnet_get_sw_interface (vnet_get_main (), sw_if_index);
161 u8 local_ip_valid = 0;
162 ip_interface_address_t *ia = NULL;
165 BFD_ERR ("got NULL sw_if");
166 return VNET_API_ERROR_INVALID_SW_IF_INDEX;
168 if (ip46_address_is_ip4 (local_addr))
170 if (!ip46_address_is_ip4 (peer_addr))
172 BFD_ERR ("IP family mismatch");
173 return VNET_API_ERROR_INVALID_ARGUMENT;
175 ip4_main_t *im = &ip4_main;
178 foreach_ip_interface_address (
179 &im->lookup_main, ia, sw_if_index, 0 /* honor unnumbered */, ({
181 ip_interface_address_get_address (&im->lookup_main, ia);
182 if (x->as_u32 == local_addr->ip4.as_u32)
184 /* valid address for this interface */
193 if (ip46_address_is_ip4 (peer_addr))
195 BFD_ERR ("IP family mismatch");
196 return VNET_API_ERROR_INVALID_ARGUMENT;
198 ip6_main_t *im = &ip6_main;
200 foreach_ip_interface_address (
201 &im->lookup_main, ia, sw_if_index, 0 /* honor unnumbered */, ({
203 ip_interface_address_get_address (&im->lookup_main, ia);
204 if (local_addr->ip6.as_u64[0] == x->as_u64[0] &&
205 local_addr->ip6.as_u64[1] == x->as_u64[1])
207 /* valid address for this interface */
217 BFD_ERR ("address not found on interface");
218 return VNET_API_ERROR_ADDRESS_NOT_FOUND_FOR_INTERFACE;
224 vnet_api_error_t bfd_udp_add_session (u32 sw_if_index, u32 desired_min_tx_us,
225 u32 required_min_rx_us, u8 detect_mult,
226 const ip46_address_t *local_addr,
227 const ip46_address_t *peer_addr)
229 vnet_api_error_t rv =
230 bfd_udp_validate_api_input (sw_if_index, local_addr, peer_addr);
237 BFD_ERR ("detect_mult < 1");
238 return VNET_API_ERROR_INVALID_ARGUMENT;
240 if (desired_min_tx_us < 1)
242 BFD_ERR ("desired_min_tx_us < 1");
243 return VNET_API_ERROR_INVALID_ARGUMENT;
245 return bfd_udp_add_session_internal (&bfd_udp_main, sw_if_index,
246 desired_min_tx_us, required_min_rx_us,
247 detect_mult, local_addr, peer_addr);
250 vnet_api_error_t bfd_udp_del_session (u32 sw_if_index,
251 const ip46_address_t *local_addr,
252 const ip46_address_t *peer_addr)
254 vnet_api_error_t rv =
255 bfd_udp_validate_api_input (sw_if_index, local_addr, peer_addr);
260 bfd_udp_main_t *bum = &bfd_udp_main;
261 vnet_sw_interface_t *sw_if =
262 vnet_get_sw_interface (vnet_get_main (), sw_if_index);
264 memset (&key, 0, sizeof (key));
265 key.sw_if_index = sw_if->sw_if_index;
266 key.local_addr.as_u64[0] = local_addr->as_u64[0];
267 key.local_addr.as_u64[1] = local_addr->as_u64[1];
268 key.peer_addr.as_u64[0] = peer_addr->as_u64[0];
269 key.peer_addr.as_u64[1] = peer_addr->as_u64[1];
270 bfd_session_t *tmp = bfd_lookup_session (bum, &key);
273 BFD_DBG ("free bfd-udp session, bs_idx=%d", tmp->bs_idx);
274 mhash_unset (&bum->bfd_session_idx_by_bfd_key, &key, NULL);
275 adj_unlock (tmp->udp.adj_index);
276 bfd_put_session (bum->bfd_main, tmp);
280 BFD_ERR ("no such session");
281 return VNET_API_ERROR_BFD_NOENT;
287 BFD_UDP_INPUT_NEXT_NORMAL,
288 BFD_UDP_INPUT_NEXT_REPLY,
289 BFD_UDP_INPUT_N_NEXT,
290 } bfd_udp_input_next_t;
292 /* Packet counters */
293 #define foreach_bfd_udp_error(F) \
294 F (NONE, "good bfd packets (processed)") \
295 F (BAD, "invalid bfd packets") \
296 F (DISABLED, "bfd packets received on disabled interfaces")
298 #define F(sym, string) static char BFD_UDP_ERR_##sym##_STR[] = string;
299 foreach_bfd_udp_error (F);
302 static char *bfd_udp_error_strings[] = {
303 #define F(sym, string) BFD_UDP_ERR_##sym##_STR,
304 foreach_bfd_udp_error (F)
309 #define F(sym, str) BFD_UDP_ERROR_##sym,
310 foreach_bfd_udp_error (F)
315 static void bfd_udp4_find_headers (vlib_buffer_t *b, const ip4_header_t **ip4,
316 const udp_header_t **udp)
318 /* sanity check first */
319 const i32 start = vnet_buffer (b)->ip.start_of_ip_header;
320 if (start < 0 && start < sizeof (b->pre_data))
322 BFD_ERR ("Start of ip header is before pre_data, ignoring");
327 *ip4 = (ip4_header_t *)(b->data + start);
328 if ((u8 *)*ip4 > (u8 *)vlib_buffer_get_current (b))
330 BFD_ERR ("Start of ip header is beyond current data, ignoring");
335 *udp = (udp_header_t *)((*ip4) + 1);
338 static bfd_udp_error_t bfd_udp4_verify_transport (const ip4_header_t *ip4,
339 const udp_header_t *udp,
340 const bfd_session_t *bs)
342 const bfd_udp_session_t *bus = &bs->udp;
343 const bfd_udp_key_t *key = &bus->key;
344 if (ip4->src_address.as_u32 != key->peer_addr.ip4.as_u32)
346 BFD_ERR ("IP src addr mismatch, got %U, expected %U", format_ip4_address,
347 ip4->src_address.as_u32, format_ip4_address,
348 key->peer_addr.ip4.as_u32);
349 return BFD_UDP_ERROR_BAD;
351 if (ip4->dst_address.as_u32 != key->local_addr.ip4.as_u32)
353 BFD_ERR ("IP dst addr mismatch, got %U, expected %U", format_ip4_address,
354 ip4->dst_address.as_u32, format_ip4_address,
355 key->local_addr.ip4.as_u32);
356 return BFD_UDP_ERROR_BAD;
358 const u8 expected_ttl = 255;
359 if (ip4->ttl != expected_ttl)
361 BFD_ERR ("IP unexpected TTL value %d, expected %d", ip4->ttl,
363 return BFD_UDP_ERROR_BAD;
365 if (clib_net_to_host_u16 (udp->src_port) < 49152 ||
366 clib_net_to_host_u16 (udp->src_port) > 65535)
368 BFD_ERR ("Invalid UDP src port %d, out of range <49152,65535>",
371 return BFD_UDP_ERROR_NONE;
380 static void bfd_rpc_update_session_cb (const bfd_rpc_update_t *a)
382 bfd_consume_pkt (bfd_udp_main.bfd_main, &a->pkt, a->bs_idx);
385 static void bfd_rpc_update_session (u32 bs_idx, const bfd_pkt_t *pkt)
387 /* packet length was already verified to be correct by the caller */
388 const u32 data_size = sizeof (bfd_rpc_update_t) -
389 STRUCT_SIZE_OF (bfd_rpc_update_t, pkt) +
392 bfd_rpc_update_t *update = (bfd_rpc_update_t *)data;
393 update->bs_idx = bs_idx;
394 clib_memcpy (&update->pkt, pkt, pkt->head.length);
395 vl_api_rpc_call_main_thread (bfd_rpc_update_session_cb, data, data_size);
398 static bfd_udp_error_t bfd_udp4_scan (vlib_main_t *vm, vlib_node_runtime_t *rt,
399 vlib_buffer_t *b, bfd_session_t **bs_out)
401 const bfd_pkt_t *pkt = vlib_buffer_get_current (b);
402 if (sizeof (*pkt) > b->current_length)
405 "Payload size %d too small to hold bfd packet of minimum size %d",
406 b->current_length, sizeof (*pkt));
407 return BFD_UDP_ERROR_BAD;
409 const ip4_header_t *ip4;
410 const udp_header_t *udp;
411 bfd_udp4_find_headers (b, &ip4, &udp);
414 BFD_ERR ("Couldn't find ip4 or udp header");
415 return BFD_UDP_ERROR_BAD;
417 if (!bfd_verify_pkt_common (pkt))
419 return BFD_UDP_ERROR_BAD;
421 bfd_session_t *bs = NULL;
424 BFD_DBG ("Looking up BFD session using discriminator %u",
426 bs = bfd_find_session_by_disc (bfd_udp_main.bfd_main, pkt->your_disc);
431 memset (&key, 0, sizeof (key));
432 key.sw_if_index = vnet_buffer (b)->sw_if_index[VLIB_RX];
433 key.local_addr.ip4.as_u32 = ip4->dst_address.as_u32;
434 key.peer_addr.ip4.as_u32 = ip4->src_address.as_u32;
435 BFD_DBG ("Looking up BFD session using key (sw_if_index=%u, local=%U, "
437 key.sw_if_index, format_ip4_address, key.local_addr.ip4.as_u8,
438 format_ip4_address, key.peer_addr.ip4.as_u8);
439 bs = bfd_lookup_session (&bfd_udp_main, &key);
443 BFD_ERR ("BFD session lookup failed - no session matches BFD pkt");
444 return BFD_UDP_ERROR_BAD;
446 BFD_DBG ("BFD session found, bs_idx=%u", bs->bs_idx);
447 if (!bfd_verify_pkt_session (pkt, b->current_length, bs))
449 return BFD_UDP_ERROR_BAD;
452 if (BFD_UDP_ERROR_NONE != (err = bfd_udp4_verify_transport (ip4, udp, bs)))
456 bfd_rpc_update_session (bs->bs_idx, pkt);
458 return BFD_UDP_ERROR_NONE;
461 static bfd_udp_error_t bfd_udp6_scan (vlib_main_t *vm, vlib_buffer_t *b)
464 return BFD_UDP_ERROR_BAD;
468 * Process a frame of bfd packets
469 * Expect 1 packet / frame
471 static uword bfd_udp_input (vlib_main_t *vm, vlib_node_runtime_t *rt,
472 vlib_frame_t *f, int is_ipv6)
474 u32 n_left_from, *from;
475 bfd_input_trace_t *t0;
477 from = vlib_frame_vector_args (f); /* array of buffer indices */
478 n_left_from = f->n_vectors; /* number of buffer indices */
480 while (n_left_from > 0)
487 b0 = vlib_get_buffer (vm, bi0);
489 bfd_session_t *bs = NULL;
491 /* If this pkt is traced, snapshot the data */
492 if (b0->flags & VLIB_BUFFER_IS_TRACED)
495 t0 = vlib_add_trace (vm, rt, b0, sizeof (*t0));
496 len = (b0->current_length < sizeof (t0->data)) ? b0->current_length
499 clib_memcpy (t0->data, vlib_buffer_get_current (b0), len);
502 /* scan this bfd pkt. error0 is the counter index to bmp */
505 error0 = bfd_udp6_scan (vm, b0);
509 error0 = bfd_udp4_scan (vm, rt, b0, &bs);
511 b0->error = rt->errors[error0];
513 next0 = BFD_UDP_INPUT_NEXT_NORMAL;
514 if (BFD_UDP_ERROR_NONE == error0)
516 /* if everything went fine, check for poll bit, if present, re-use
517 the buffer and based on (now updated) session parameters, send the
519 const bfd_pkt_t *pkt = vlib_buffer_get_current (b0);
520 if (bfd_pkt_get_poll (pkt))
522 bfd_send_final (vm, b0, bs);
525 vlib_node_increment_counter (vm, bfd_udp6_input_node.index,
530 vlib_node_increment_counter (vm, bfd_udp4_input_node.index,
533 next0 = BFD_UDP_INPUT_NEXT_REPLY;
536 vlib_set_next_frame_buffer (vm, rt, next0, bi0);
545 static uword bfd_udp4_input (vlib_main_t *vm, vlib_node_runtime_t *rt,
548 return bfd_udp_input (vm, rt, f, 0);
552 * bfd input graph node declaration
555 VLIB_REGISTER_NODE (bfd_udp4_input_node, static) = {
556 .function = bfd_udp4_input,
557 .name = "bfd-udp4-input",
558 .vector_size = sizeof (u32),
559 .type = VLIB_NODE_TYPE_INTERNAL,
561 .n_errors = BFD_UDP_N_ERROR,
562 .error_strings = bfd_udp_error_strings,
564 .format_trace = bfd_input_format_trace,
566 .n_next_nodes = BFD_UDP_INPUT_N_NEXT,
569 [BFD_UDP_INPUT_NEXT_NORMAL] = "error-drop",
570 [BFD_UDP_INPUT_NEXT_REPLY] = "ip4-lookup",
575 static uword bfd_udp6_input (vlib_main_t *vm, vlib_node_runtime_t *rt,
578 return bfd_udp_input (vm, rt, f, 1);
582 VLIB_REGISTER_NODE (bfd_udp6_input_node, static) = {
583 .function = bfd_udp6_input,
584 .name = "bfd-udp6-input",
585 .vector_size = sizeof (u32),
586 .type = VLIB_NODE_TYPE_INTERNAL,
588 .n_errors = BFD_UDP_N_ERROR,
589 .error_strings = bfd_udp_error_strings,
591 .format_trace = bfd_input_format_trace,
593 .n_next_nodes = BFD_UDP_INPUT_N_NEXT,
596 [BFD_UDP_INPUT_NEXT_NORMAL] = "error-drop",
597 [BFD_UDP_INPUT_NEXT_REPLY] = "ip6-lookup",
602 static clib_error_t *bfd_sw_interface_up_down (vnet_main_t *vnm,
603 u32 sw_if_index, u32 flags)
605 // vnet_hw_interface_t *hi = vnet_get_sup_hw_interface (vnm, sw_if_index);
606 if (!(flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP))
613 VNET_SW_INTERFACE_ADMIN_UP_DOWN_FUNCTION (bfd_sw_interface_up_down);
615 static clib_error_t *bfd_hw_interface_up_down (vnet_main_t *vnm,
616 u32 hw_if_index, u32 flags)
618 if (flags & VNET_HW_INTERFACE_FLAG_LINK_UP)
625 VNET_HW_INTERFACE_LINK_UP_DOWN_FUNCTION (bfd_hw_interface_up_down);
630 static clib_error_t *bfd_udp_init (vlib_main_t *vm)
632 mhash_init (&bfd_udp_main.bfd_session_idx_by_bfd_key, sizeof (uword),
633 sizeof (bfd_udp_key_t));
634 bfd_udp_main.bfd_main = &bfd_main;
635 udp_register_dst_port (vm, UDP_DST_PORT_bfd4, bfd_udp4_input_node.index, 1);
636 udp_register_dst_port (vm, UDP_DST_PORT_bfd6, bfd_udp6_input_node.index, 0);
640 VLIB_INIT_FUNCTION (bfd_udp_init);