2 * Copyright (c) 2018 Cisco and/or its affiliates.
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.
16 #include <plugins/gbp/gbp.h>
17 #include <plugins/gbp/gbp_learn.h>
18 #include <plugins/gbp/gbp_bridge_domain.h>
19 #include <vlibmemory/api.h>
21 #include <vnet/util/throttle.h>
22 #include <vnet/l2/l2_input.h>
23 #include <vnet/fib/fib_table.h>
24 #include <vnet/vxlan-gbp/vxlan_gbp_packet.h>
27 * Grouping of global data for the GBP source EPG classification feature
29 typedef struct gbp_learn_main_t_
32 * Next nodes for L2 output features
34 u32 gl_l2_input_feat_next[32];
37 * logger - VLIB log class
39 vlib_log_class_t gl_logger;
42 * throttles for the DP leanring
44 throttle_t gl_l2_throttle;
45 throttle_t gl_l3_throttle;
49 * The maximum learning rate per-hashed EP
51 #define GBP_ENDPOINT_HASH_LEARN_RATE (1e-2)
53 static gbp_learn_main_t gbp_learn_main;
55 #define GBP_LEARN_DBG(...) \
56 vlib_log_debug (gbp_learn_main.gl_logger, __VA_ARGS__);
58 #define foreach_gbp_learn \
63 #define _(sym,str) GBP_LEARN_ERROR_##sym,
69 static char *gbp_learn_error_strings[] = {
70 #define _(sym,string) string,
77 #define _(sym,str) GBP_LEARN_NEXT_##sym,
83 typedef struct gbp_learn_l2_t_
90 ip46_address_t outer_src;
91 ip46_address_t outer_dst;
96 gbp_learn_l2_cp (const gbp_learn_l2_t * gl2)
98 ip46_address_t *ips = NULL;
100 GBP_LEARN_DBG ("L2 EP: %U %U, %d",
101 format_mac_address_t, &gl2->mac,
102 format_ip46_address, &gl2->ip, IP46_TYPE_ANY, gl2->epg);
104 vec_add1 (ips, gl2->ip);
106 ASSERT (!ip46_address_is_zero (&gl2->outer_src));
107 ASSERT (!ip46_address_is_zero (&gl2->outer_dst));
110 * flip the source and dst, since that's how it was received, this API
111 * takes how it's sent
113 gbp_endpoint_update (gl2->sw_if_index, ips,
115 (GBP_ENDPOINT_FLAG_LEARNT |
116 GBP_ENDPOINT_FLAG_REMOTE),
117 &gl2->outer_dst, &gl2->outer_src, NULL);
121 gbp_learn_l2_ip4_dp (const u8 * mac, const ip4_address_t * ip,
122 u32 bd_index, u32 sw_if_index, epg_id_t epg,
123 const ip4_address_t * outer_src,
124 const ip4_address_t * outer_dst)
126 gbp_learn_l2_t gl2 = {
127 .sw_if_index = sw_if_index,
128 .bd_index = bd_index,
131 .outer_src.ip4 = *outer_src,
132 .outer_dst.ip4 = *outer_dst,
134 mac_address_from_bytes (&gl2.mac, mac);
136 ASSERT (!ip46_address_is_zero (&gl2.outer_src));
137 ASSERT (!ip46_address_is_zero (&gl2.outer_dst));
139 vl_api_rpc_call_main_thread (gbp_learn_l2_cp, (u8 *) & gl2, sizeof (gl2));
143 gbp_learn_l2_ip6_dp (const u8 * mac, const ip6_address_t * ip,
144 u32 bd_index, u32 sw_if_index, epg_id_t epg,
145 const ip4_address_t * outer_src,
146 const ip4_address_t * outer_dst)
148 gbp_learn_l2_t gl2 = {
149 .sw_if_index = sw_if_index,
150 .bd_index = bd_index,
153 .outer_src.ip4 = *outer_src,
154 .outer_dst.ip4 = *outer_dst,
156 mac_address_from_bytes (&gl2.mac, mac);
158 vl_api_rpc_call_main_thread (gbp_learn_l2_cp, (u8 *) & gl2, sizeof (gl2));
162 gbp_learn_l2_dp (const u8 * mac, u32 bd_index, u32 sw_if_index,
164 const ip4_address_t * outer_src,
165 const ip4_address_t * outer_dst)
167 gbp_learn_l2_t gl2 = {
168 .sw_if_index = sw_if_index,
169 .bd_index = bd_index,
171 .outer_src.ip4 = *outer_src,
172 .outer_dst.ip4 = *outer_dst,
174 mac_address_from_bytes (&gl2.mac, mac);
176 vl_api_rpc_call_main_thread (gbp_learn_l2_cp, (u8 *) & gl2, sizeof (gl2));
180 * per-packet trace data
182 typedef struct gbp_learn_l2_trace_t_
184 /* per-pkt trace data */
191 } gbp_learn_l2_trace_t;
194 gbp_learn_get_outer (const ethernet_header_t * eh0,
195 ip4_address_t * outer_src, ip4_address_t * outer_dst)
200 /* rewind back to the ivxlan header */
202 buff -= (sizeof (vxlan_gbp_header_t) +
203 sizeof (udp_header_t) + sizeof (ip4_header_t));
205 ip0 = (ip4_header_t *) buff;
207 *outer_src = ip0->src_address;
208 *outer_dst = ip0->dst_address;
212 gbp_learn_l2 (vlib_main_t * vm,
213 vlib_node_runtime_t * node, vlib_frame_t * frame)
215 u32 n_left_from, *from, *to_next, next_index, thread_index, seed;
216 gbp_learn_main_t *glm;
219 glm = &gbp_learn_main;
221 n_left_from = frame->n_vectors;
222 from = vlib_frame_vector_args (frame);
223 time_now = vlib_time_now (vm);
224 thread_index = vm->thread_index;
226 seed = throttle_seed (&glm->gl_l2_throttle, thread_index, time_now);
228 while (n_left_from > 0)
232 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
234 while (n_left_from > 0 && n_left_to_next > 0)
236 ip4_address_t outer_src, outer_dst;
237 u32 bi0, sw_if_index0, t0, epg0;
238 const ethernet_header_t *eh0;
239 gbp_bridge_domain_t *gb0;
240 gbp_learn_next_t next0;
244 next0 = GBP_LEARN_NEXT_DROP;
252 b0 = vlib_get_buffer (vm, bi0);
253 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
255 eh0 = vlib_buffer_get_current (b0);
256 epg0 = vnet_buffer2 (b0)->gbp.src_epg;
258 next0 = vnet_l2_feature_next (b0, glm->gl_l2_input_feat_next,
259 L2INPUT_FEAT_GBP_LEARN);
261 ge0 = gbp_endpoint_find_mac (eh0->src_address,
262 vnet_buffer (b0)->l2.bd_index);
264 gbp_bridge_domain_get_by_bd_index (vnet_buffer (b0)->l2.bd_index);
266 if ((vnet_buffer2 (b0)->gbp.flags & VXLAN_GBP_GPFLAGS_D) ||
267 (gb0->gb_flags & GBP_BD_FLAG_DO_NOT_LEARN))
274 * check for new EP or a moved EP
276 if (NULL == ge0 || ge0->ge_sw_if_index != sw_if_index0)
280 * use the last 4 bytes of the mac address as the hash for the EP
282 t0 = throttle_check (&glm->gl_l2_throttle, thread_index,
283 *((u32 *) (eh0->src_address + 2)), seed);
286 gbp_learn_get_outer (eh0, &outer_src, &outer_dst);
288 switch (clib_net_to_host_u16 (eh0->type))
290 case ETHERNET_TYPE_IP4:
292 const ip4_header_t *ip0;
294 ip0 = (ip4_header_t *) (eh0 + 1);
296 gbp_learn_l2_ip4_dp (eh0->src_address,
298 vnet_buffer (b0)->l2.bd_index,
300 &outer_src, &outer_dst);
304 case ETHERNET_TYPE_IP6:
306 const ip6_header_t *ip0;
308 ip0 = (ip6_header_t *) (eh0 + 1);
310 gbp_learn_l2_ip6_dp (eh0->src_address,
312 vnet_buffer (b0)->l2.bd_index,
314 &outer_src, &outer_dst);
319 gbp_learn_l2_dp (eh0->src_address,
320 vnet_buffer (b0)->l2.bd_index,
322 &outer_src, &outer_dst);
330 * this update could happen simultaneoulsy from multiple workers
331 * but that's ok we are not interested in being very accurate.
334 ge0->ge_last_time = time_now;
337 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
339 gbp_learn_l2_trace_t *t =
340 vlib_add_trace (vm, node, b0, sizeof (*t));
341 clib_memcpy_fast (t->mac.bytes, eh0->src_address, 6);
342 t->new = (NULL == ge0);
344 t->sw_if_index = sw_if_index0;
346 t->d_bit = ! !(vnet_buffer2 (b0)->gbp.flags &
347 VXLAN_GBP_GPFLAGS_D);
350 /* verify speculative enqueue, maybe switch current next frame */
351 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
352 to_next, n_left_to_next,
356 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
359 return frame->n_vectors;
362 /* packet trace format function */
364 format_gbp_learn_l2_trace (u8 * s, va_list * args)
366 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
367 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
368 gbp_learn_l2_trace_t *t = va_arg (*args, gbp_learn_l2_trace_t *);
370 s = format (s, "new:%d throttled:%d d-bit:%d mac:%U itf:%d epg:%d",
371 t->new, t->throttled, t->d_bit,
372 format_mac_address_t, &t->mac, t->sw_if_index, t->epg);
378 VLIB_REGISTER_NODE (gbp_learn_l2_node) = {
379 .function = gbp_learn_l2,
380 .name = "gbp-learn-l2",
381 .vector_size = sizeof (u32),
382 .format_trace = format_gbp_learn_l2_trace,
383 .type = VLIB_NODE_TYPE_INTERNAL,
385 .n_errors = ARRAY_LEN(gbp_learn_error_strings),
386 .error_strings = gbp_learn_error_strings,
388 .n_next_nodes = GBP_LEARN_N_NEXT,
391 [GBP_LEARN_NEXT_DROP] = "error-drop",
395 VLIB_NODE_FUNCTION_MULTIARCH (gbp_learn_l2_node, gbp_learn_l2);
398 typedef struct gbp_learn_l3_t_
404 ip46_address_t outer_src;
405 ip46_address_t outer_dst;
409 gbp_learn_l3_cp (const gbp_learn_l3_t * gl3)
411 ip46_address_t *ips = NULL;
413 GBP_LEARN_DBG ("L3 EP: %U, %d", format_ip46_address, &gl3->ip,
414 IP46_TYPE_ANY, gl3->epg);
416 vec_add1 (ips, gl3->ip);
418 gbp_endpoint_update (gl3->sw_if_index, ips, NULL, gl3->epg,
419 (GBP_ENDPOINT_FLAG_REMOTE |
420 GBP_ENDPOINT_FLAG_LEARNT),
421 &gl3->outer_dst, &gl3->outer_src, NULL);
425 gbp_learn_ip4_dp (const ip4_address_t * ip,
426 u32 fib_index, u32 sw_if_index, epg_id_t epg,
427 const ip4_address_t * outer_src,
428 const ip4_address_t * outer_dst)
431 gbp_learn_l3_t gl3 = {
435 .sw_if_index = sw_if_index,
436 .fib_index = fib_index,
438 .outer_src.ip4 = *outer_src,
439 .outer_dst.ip4 = *outer_dst,
443 vl_api_rpc_call_main_thread (gbp_learn_l3_cp, (u8 *) & gl3, sizeof (gl3));
447 gbp_learn_ip6_dp (const ip6_address_t * ip,
448 u32 fib_index, u32 sw_if_index, epg_id_t epg,
449 const ip4_address_t * outer_src,
450 const ip4_address_t * outer_dst)
453 gbp_learn_l3_t gl3 = {
457 .sw_if_index = sw_if_index,
458 .fib_index = fib_index,
460 .outer_src.ip4 = *outer_src,
461 .outer_dst.ip4 = *outer_dst,
465 vl_api_rpc_call_main_thread (gbp_learn_l3_cp, (u8 *) & gl3, sizeof (gl3));
469 * per-packet trace data
471 typedef struct gbp_learn_l3_trace_t_
473 /* per-pkt trace data */
479 } gbp_learn_l3_trace_t;
482 gbp_learn_l3 (vlib_main_t * vm,
483 vlib_node_runtime_t * node, vlib_frame_t * frame,
484 fib_protocol_t fproto)
486 u32 n_left_from, *from, *to_next, next_index, thread_index, seed;
487 gbp_learn_main_t *glm;
490 glm = &gbp_learn_main;
492 n_left_from = frame->n_vectors;
493 from = vlib_frame_vector_args (frame);
494 time_now = vlib_time_now (vm);
495 thread_index = vm->thread_index;
497 seed = throttle_seed (&glm->gl_l3_throttle, thread_index, time_now);
499 while (n_left_from > 0)
503 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
505 while (n_left_from > 0 && n_left_to_next > 0)
507 u32 bi0, sw_if_index0, t0, epg0, fib_index0;
508 CLIB_UNUSED (const ip4_header_t *) ip4_0;
509 CLIB_UNUSED (const ip6_header_t *) ip6_0;
510 ip4_address_t outer_src, outer_dst;
511 ethernet_header_t *eth0;
512 gbp_learn_next_t next0;
516 next0 = GBP_LEARN_NEXT_DROP;
524 b0 = vlib_get_buffer (vm, bi0);
525 sw_if_index0 = vnet_buffer (b0)->sw_if_index[VLIB_RX];
526 epg0 = vnet_buffer2 (b0)->gbp.src_epg;
530 vnet_feature_next (&next0, b0);
532 if (vnet_buffer2 (b0)->gbp.flags & VXLAN_GBP_GPFLAGS_D)
539 fib_index0 = fib_table_get_index_for_sw_if_index (fproto,
542 if (FIB_PROTOCOL_IP6 == fproto)
544 ip6_0 = vlib_buffer_get_current (b0);
545 eth0 = (ethernet_header_t *) (((u8 *) ip6_0) - sizeof (*eth0));
547 gbp_learn_get_outer (eth0, &outer_src, &outer_dst);
549 ge0 = gbp_endpoint_find_ip6 (&ip6_0->src_address, fib_index0);
553 t0 = throttle_check (&glm->gl_l3_throttle,
555 ip6_address_hash_to_u32
556 (&ip6_0->src_address), seed);
560 gbp_learn_ip6_dp (&ip6_0->src_address,
561 fib_index0, sw_if_index0, epg0,
562 &outer_src, &outer_dst);
568 * this update could happen simultaneoulsy from multiple
569 * workers but that's ok we are not interested in being
573 ge0->ge_last_time = time_now;
578 ip4_0 = vlib_buffer_get_current (b0);
579 eth0 = (ethernet_header_t *) (((u8 *) ip4_0) - sizeof (*eth0));
581 gbp_learn_get_outer (eth0, &outer_src, &outer_dst);
582 ge0 = gbp_endpoint_find_ip4 (&ip4_0->src_address, fib_index0);
586 t0 = throttle_check (&glm->gl_l3_throttle, thread_index,
587 ip4_0->src_address.as_u32, seed);
591 gbp_learn_ip4_dp (&ip4_0->src_address,
592 fib_index0, sw_if_index0, epg0,
593 &outer_src, &outer_dst);
599 * this update could happen simultaneoulsy from multiple
600 * workers but that's ok we are not interested in being
604 ge0->ge_last_time = time_now;
608 if (PREDICT_FALSE ((b0->flags & VLIB_BUFFER_IS_TRACED)))
610 gbp_learn_l3_trace_t *t;
612 t = vlib_add_trace (vm, node, b0, sizeof (*t));
613 if (FIB_PROTOCOL_IP6 == fproto && ip6_0)
614 ip46_address_set_ip6 (&t->ip, &ip6_0->src_address);
615 if (FIB_PROTOCOL_IP4 == fproto && ip4_0)
616 ip46_address_set_ip4 (&t->ip, &ip4_0->src_address);
617 t->new = (NULL == ge0);
619 t->sw_if_index = sw_if_index0;
623 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
624 to_next, n_left_to_next,
628 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
631 return frame->n_vectors;
634 /* packet trace format function */
636 format_gbp_learn_l3_trace (u8 * s, va_list * args)
638 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
639 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
640 gbp_learn_l3_trace_t *t = va_arg (*args, gbp_learn_l3_trace_t *);
642 s = format (s, "new:%d throttled:%d ip:%U itf:%d epg:%d",
643 t->new, t->throttled,
644 format_ip46_address, &t->ip, IP46_TYPE_ANY, t->sw_if_index,
651 gbp_learn_ip4 (vlib_main_t * vm,
652 vlib_node_runtime_t * node, vlib_frame_t * frame)
654 return (gbp_learn_l3 (vm, node, frame, FIB_PROTOCOL_IP4));
658 gbp_learn_ip6 (vlib_main_t * vm,
659 vlib_node_runtime_t * node, vlib_frame_t * frame)
661 return (gbp_learn_l3 (vm, node, frame, FIB_PROTOCOL_IP6));
665 VLIB_REGISTER_NODE (gbp_learn_ip4_node) = {
666 .function = gbp_learn_ip4,
667 .name = "gbp-learn-ip4",
668 .vector_size = sizeof (u32),
669 .format_trace = format_gbp_learn_l3_trace,
670 .type = VLIB_NODE_TYPE_INTERNAL,
673 VLIB_NODE_FUNCTION_MULTIARCH (gbp_learn_ip4_node, gbp_learn_ip4);
675 VNET_FEATURE_INIT (gbp_learn_ip4, static) =
677 .arc_name = "ip4-unicast",
678 .node_name = "gbp-learn-ip4",
681 VLIB_REGISTER_NODE (gbp_learn_ip6_node) = {
682 .function = gbp_learn_ip6,
683 .name = "gbp-learn-ip6",
684 .vector_size = sizeof (u32),
685 .format_trace = format_gbp_learn_l3_trace,
686 .type = VLIB_NODE_TYPE_INTERNAL,
689 VLIB_NODE_FUNCTION_MULTIARCH (gbp_learn_ip6_node, gbp_learn_ip6);
691 VNET_FEATURE_INIT (gbp_learn_ip6, static) =
693 .arc_name = "ip6-unicast",
694 .node_name = "gbp-learn-ip6",
700 gbp_learn_enable (u32 sw_if_index, gbb_learn_mode_t mode)
702 if (GBP_LEARN_MODE_L2 == mode)
703 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_GBP_LEARN, 1);
706 vnet_feature_enable_disable ("ip4-unicast",
707 "gbp-learn-ip4", sw_if_index, 1, 0, 0);
708 vnet_feature_enable_disable ("ip6-unicast",
709 "gbp-learn-ip6", sw_if_index, 1, 0, 0);
714 gbp_learn_disable (u32 sw_if_index, gbb_learn_mode_t mode)
716 if (GBP_LEARN_MODE_L2 == mode)
717 l2input_intf_bitmap_enable (sw_if_index, L2INPUT_FEAT_GBP_LEARN, 0);
720 vnet_feature_enable_disable ("ip4-unicast",
721 "gbp-learn-ip4", sw_if_index, 0, 0, 0);
722 vnet_feature_enable_disable ("ip6-unicast",
723 "gbp-learn-ip6", sw_if_index, 0, 0, 0);
727 static clib_error_t *
728 gbp_learn_init (vlib_main_t * vm)
730 gbp_learn_main_t *glm = &gbp_learn_main;
731 vlib_thread_main_t *tm = &vlib_thread_main;
733 /* Initialize the feature next-node indices */
734 feat_bitmap_init_next_nodes (vm,
735 gbp_learn_l2_node.index,
737 l2input_get_feat_names (),
738 glm->gl_l2_input_feat_next);
740 throttle_init (&glm->gl_l2_throttle,
741 tm->n_vlib_mains, GBP_ENDPOINT_HASH_LEARN_RATE);
743 throttle_init (&glm->gl_l3_throttle,
744 tm->n_vlib_mains, GBP_ENDPOINT_HASH_LEARN_RATE);
746 glm->gl_logger = vlib_log_register_class ("gbp", "learn");
751 VLIB_INIT_FUNCTION (gbp_learn_init);
754 * fd.io coding-style-patch-verification: ON
757 * eval: (c-set-style "gnu")