2 * node.c: gre packet processing
4 * Copyright (c) 2012 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #include <vlib/vlib.h>
19 #include <vnet/pg/pg.h>
20 #include <vnet/gre/gre.h>
21 #include <vnet/mpls/mpls.h>
22 #include <vppinfra/sparse_vec.h>
24 #define foreach_gre_input_next \
25 _(PUNT, "error-punt") \
26 _(DROP, "error-drop") \
27 _(ETHERNET_INPUT, "ethernet-input") \
28 _(IP4_INPUT, "ip4-input") \
29 _(IP6_INPUT, "ip6-input") \
30 _(MPLS_INPUT, "mpls-input")
34 #define _(s,n) GRE_INPUT_NEXT_##s,
35 foreach_gre_input_next
50 format_gre_rx_trace (u8 * s, va_list * args)
52 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
53 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
54 gre_rx_trace_t *t = va_arg (*args, gre_rx_trace_t *);
56 s = format (s, "GRE: tunnel %d len %d src %U dst %U",
57 t->tunnel_id, clib_net_to_host_u16 (t->length),
58 format_ip46_address, &t->src, IP46_TYPE_ANY,
59 format_ip46_address, &t->dst, IP46_TYPE_ANY);
65 /* Sparse vector mapping gre protocol in network byte order
67 u16 *next_by_protocol;
68 } gre_input_runtime_t;
71 gre_input (vlib_main_t * vm,
72 vlib_node_runtime_t * node, vlib_frame_t * from_frame, u8 is_ipv6)
74 gre_main_t *gm = &gre_main;
75 __attribute__ ((unused)) u32 n_left_from, next_index, *from, *to_next;
76 u64 cached_tunnel_key4;
77 u64 cached_tunnel_key6[4];
78 u32 cached_tunnel_sw_if_index = 0, tunnel_sw_if_index = 0;
80 u32 thread_index = vlib_get_thread_index ();
82 vnet_interface_main_t *im = &gm->vnet_main->interface_main;
85 memset (&cached_tunnel_key4, 0xff, sizeof (cached_tunnel_key4));
87 memset (&cached_tunnel_key6, 0xff, sizeof (cached_tunnel_key6));
89 from = vlib_frame_vector_args (from_frame);
90 n_left_from = from_frame->n_vectors;
92 next_index = node->cached_next_index;
94 while (n_left_from > 0)
98 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
100 while (n_left_from >= 4 && n_left_to_next >= 2)
103 vlib_buffer_t *b0, *b1;
104 gre_header_t *h0, *h1;
105 u16 version0, version1;
107 u32 i0, i1, next0, next1, protocol0, protocol1;
108 ip4_header_t *ip4_0, *ip4_1;
109 ip6_header_t *ip6_0, *ip6_1;
110 u32 ip4_tun_src0, ip4_tun_dst0;
111 u32 ip4_tun_src1, ip4_tun_dst1;
112 u64 ip6_tun_src0[2], ip6_tun_dst0[2];
113 u64 ip6_tun_src1[2], ip6_tun_dst1[2];
115 /* Prefetch next iteration. */
117 vlib_buffer_t *p2, *p3;
119 p2 = vlib_get_buffer (vm, from[2]);
120 p3 = vlib_get_buffer (vm, from[3]);
122 vlib_prefetch_buffer_header (p2, LOAD);
123 vlib_prefetch_buffer_header (p3, LOAD);
125 CLIB_PREFETCH (p2->data, sizeof (h0[0]), LOAD);
126 CLIB_PREFETCH (p3->data, sizeof (h1[0]), LOAD);
138 b0 = vlib_get_buffer (vm, bi0);
139 b1 = vlib_get_buffer (vm, bi1);
143 /* ip4_local hands us the ip header, not the gre header */
144 ip4_0 = vlib_buffer_get_current (b0);
145 ip4_1 = vlib_buffer_get_current (b1);
146 /* Save src + dst ip4 address, e.g. for mpls-o-gre */
147 ip4_tun_src0 = ip4_0->src_address.as_u32;
148 ip4_tun_dst0 = ip4_0->dst_address.as_u32;
149 ip4_tun_src1 = ip4_1->src_address.as_u32;
150 ip4_tun_dst1 = ip4_1->dst_address.as_u32;
152 vlib_buffer_advance (b0, sizeof (*ip4_0));
153 vlib_buffer_advance (b1, sizeof (*ip4_1));
157 /* ip6_local hands us the ip header, not the gre header */
158 ip6_0 = vlib_buffer_get_current (b0);
159 ip6_1 = vlib_buffer_get_current (b1);
160 /* Save src + dst ip6 address, e.g. for mpls-o-gre */
161 ip6_tun_src0[0] = ip6_0->src_address.as_u64[0];
162 ip6_tun_src0[1] = ip6_0->src_address.as_u64[1];
163 ip6_tun_dst0[0] = ip6_0->dst_address.as_u64[0];
164 ip6_tun_dst0[1] = ip6_0->dst_address.as_u64[1];
165 ip6_tun_src1[0] = ip6_1->src_address.as_u64[0];
166 ip6_tun_src1[1] = ip6_1->src_address.as_u64[1];
167 ip6_tun_dst1[0] = ip6_1->dst_address.as_u64[0];
168 ip6_tun_dst1[1] = ip6_1->dst_address.as_u64[1];
170 vlib_buffer_advance (b0, sizeof (*ip6_0));
171 vlib_buffer_advance (b1, sizeof (*ip6_1));
174 h0 = vlib_buffer_get_current (b0);
175 h1 = vlib_buffer_get_current (b1);
177 /* Index sparse array with network byte order. */
178 protocol0 = h0->protocol;
179 protocol1 = h1->protocol;
180 sparse_vec_index2 (gm->next_by_protocol, protocol0, protocol1,
182 next0 = vec_elt (gm->next_by_protocol, i0);
183 next1 = vec_elt (gm->next_by_protocol, i1);
187 SPARSE_VEC_INVALID_INDEX ? GRE_ERROR_UNKNOWN_PROTOCOL
191 SPARSE_VEC_INVALID_INDEX ? GRE_ERROR_UNKNOWN_PROTOCOL
194 version0 = clib_net_to_host_u16 (h0->flags_and_version);
195 verr0 = version0 & GRE_VERSION_MASK;
196 version1 = clib_net_to_host_u16 (h1->flags_and_version);
197 verr1 = version1 & GRE_VERSION_MASK;
199 b0->error = verr0 ? node->errors[GRE_ERROR_UNSUPPORTED_VERSION]
201 next0 = verr0 ? GRE_INPUT_NEXT_DROP : next0;
202 b1->error = verr1 ? node->errors[GRE_ERROR_UNSUPPORTED_VERSION]
204 next1 = verr1 ? GRE_INPUT_NEXT_DROP : next1;
207 /* RPF check for ip4/ip6 input */
208 if (PREDICT_TRUE (next0 == GRE_INPUT_NEXT_IP4_INPUT
209 || next0 == GRE_INPUT_NEXT_IP6_INPUT
210 || next0 == GRE_INPUT_NEXT_ETHERNET_INPUT
211 || next0 == GRE_INPUT_NEXT_MPLS_INPUT))
217 key4 = ((u64) (ip4_tun_dst0) << 32) | (u64) (ip4_tun_src0);
221 key6[0] = ip6_tun_dst0[0];
222 key6[1] = ip6_tun_dst0[1];
223 key6[2] = ip6_tun_src0[0];
224 key6[3] = ip6_tun_src0[1];
227 if ((!is_ipv6 && cached_tunnel_key4 != key4) ||
228 (is_ipv6 && cached_tunnel_key6[0] != key6[0] &&
229 cached_tunnel_key6[1] != key6[1] &&
230 cached_tunnel_key6[2] != key6[2] &&
231 cached_tunnel_key6[3] != key6[3]))
233 vnet_hw_interface_t *hi;
238 p = hash_get (gm->tunnel_by_key4, key4);
240 p = hash_get_mem (gm->tunnel_by_key6, key6);
243 next0 = GRE_INPUT_NEXT_DROP;
244 b0->error = node->errors[GRE_ERROR_NO_SUCH_TUNNEL];
247 t = pool_elt_at_index (gm->tunnels, p[0]);
248 hi = vnet_get_hw_interface (gm->vnet_main, t->hw_if_index);
249 tunnel_sw_if_index = hi->sw_if_index;
251 cached_tunnel_sw_if_index = tunnel_sw_if_index;
255 tunnel_sw_if_index = cached_tunnel_sw_if_index;
260 next0 = GRE_INPUT_NEXT_DROP;
263 len = vlib_buffer_length_in_chain (vm, b0);
264 vlib_increment_combined_counter (im->combined_sw_if_counters
265 + VNET_INTERFACE_COUNTER_RX,
271 vnet_buffer (b0)->sw_if_index[VLIB_RX] = tunnel_sw_if_index;
274 if (PREDICT_TRUE (next1 == GRE_INPUT_NEXT_IP4_INPUT
275 || next1 == GRE_INPUT_NEXT_IP6_INPUT
276 || next1 == GRE_INPUT_NEXT_ETHERNET_INPUT
277 || next1 == GRE_INPUT_NEXT_MPLS_INPUT))
282 key4 = ((u64) (ip4_tun_dst1) << 32) | (u64) (ip4_tun_src1);
286 key6[0] = ip6_tun_dst1[0];
287 key6[1] = ip6_tun_dst1[1];
288 key6[2] = ip6_tun_src1[0];
289 key6[3] = ip6_tun_src1[1];
292 if ((!is_ipv6 && cached_tunnel_key4 != key4) ||
293 (is_ipv6 && cached_tunnel_key6[0] != key6[0] &&
294 cached_tunnel_key6[1] != key6[1] &&
295 cached_tunnel_key6[2] != key6[2] &&
296 cached_tunnel_key6[3] != key6[3]))
298 vnet_hw_interface_t *hi;
303 p = hash_get (gm->tunnel_by_key4, key4);
305 p = hash_get_mem (gm->tunnel_by_key6, key6);
309 next1 = GRE_INPUT_NEXT_DROP;
310 b1->error = node->errors[GRE_ERROR_NO_SUCH_TUNNEL];
313 t = pool_elt_at_index (gm->tunnels, p[0]);
314 hi = vnet_get_hw_interface (gm->vnet_main, t->hw_if_index);
315 tunnel_sw_if_index = hi->sw_if_index;
317 cached_tunnel_sw_if_index = tunnel_sw_if_index;
321 tunnel_sw_if_index = cached_tunnel_sw_if_index;
326 next1 = GRE_INPUT_NEXT_DROP;
329 len = vlib_buffer_length_in_chain (vm, b1);
330 vlib_increment_combined_counter (im->combined_sw_if_counters
331 + VNET_INTERFACE_COUNTER_RX,
337 vnet_buffer (b1)->sw_if_index[VLIB_RX] = tunnel_sw_if_index;
340 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
342 gre_rx_trace_t *tr = vlib_add_trace (vm, node,
344 tr->tunnel_id = tunnel_sw_if_index;
347 tr->length = ip4_0->length;
348 tr->src.ip4.as_u32 = ip4_0->src_address.as_u32;
349 tr->dst.ip4.as_u32 = ip4_0->dst_address.as_u32;
353 tr->length = ip6_0->payload_length;
354 tr->src.ip6.as_u64[0] = ip6_0->src_address.as_u64[0];
355 tr->src.ip6.as_u64[1] = ip6_0->src_address.as_u64[1];
356 tr->dst.ip6.as_u64[0] = ip6_0->dst_address.as_u64[0];
357 tr->dst.ip6.as_u64[1] = ip6_0->dst_address.as_u64[1];
361 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
363 gre_rx_trace_t *tr = vlib_add_trace (vm, node,
365 tr->tunnel_id = tunnel_sw_if_index;
368 tr->length = ip4_1->length;
369 tr->src.ip4.as_u32 = ip4_1->src_address.as_u32;
370 tr->dst.ip4.as_u32 = ip4_1->dst_address.as_u32;
374 tr->length = ip6_1->payload_length;
375 tr->src.ip6.as_u64[0] = ip6_1->src_address.as_u64[0];
376 tr->src.ip6.as_u64[1] = ip6_1->src_address.as_u64[1];
377 tr->dst.ip6.as_u64[0] = ip6_1->dst_address.as_u64[0];
378 tr->dst.ip6.as_u64[1] = ip6_1->dst_address.as_u64[1];
382 vlib_buffer_advance (b0, sizeof (*h0));
383 vlib_buffer_advance (b1, sizeof (*h1));
385 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
386 to_next, n_left_to_next,
387 bi0, bi1, next0, next1);
390 while (n_left_from > 0 && n_left_to_next > 0)
400 u32 ip4_tun_src0, ip4_tun_dst0;
401 u32 ip6_tun_src0[4], ip6_tun_dst0[4];
410 b0 = vlib_get_buffer (vm, bi0);
411 ip4_0 = vlib_buffer_get_current (b0);
412 ip6_0 = (void *) ip4_0;
416 ip4_tun_src0 = ip4_0->src_address.as_u32;
417 ip4_tun_dst0 = ip4_0->dst_address.as_u32;
419 vlib_buffer_advance (b0, sizeof (*ip4_0));
423 ip6_tun_src0[0] = ip6_0->src_address.as_u64[0];
424 ip6_tun_src0[1] = ip6_0->src_address.as_u64[1];
425 ip6_tun_dst0[0] = ip6_0->dst_address.as_u64[0];
426 ip6_tun_dst0[1] = ip6_0->dst_address.as_u64[1];
428 vlib_buffer_advance (b0, sizeof (*ip6_0));
431 h0 = vlib_buffer_get_current (b0);
433 i0 = sparse_vec_index (gm->next_by_protocol, h0->protocol);
434 next0 = vec_elt (gm->next_by_protocol, i0);
437 node->errors[i0 == SPARSE_VEC_INVALID_INDEX
438 ? GRE_ERROR_UNKNOWN_PROTOCOL : GRE_ERROR_NONE];
440 version0 = clib_net_to_host_u16 (h0->flags_and_version);
441 verr0 = version0 & GRE_VERSION_MASK;
442 b0->error = verr0 ? node->errors[GRE_ERROR_UNSUPPORTED_VERSION]
444 next0 = verr0 ? GRE_INPUT_NEXT_DROP : next0;
447 /* For IP payload we need to find source interface
448 so we can increase counters and help forward node to
450 /* RPF check for ip4/ip6 input */
451 if (PREDICT_TRUE (next0 == GRE_INPUT_NEXT_IP4_INPUT
452 || next0 == GRE_INPUT_NEXT_IP6_INPUT
453 || next0 == GRE_INPUT_NEXT_ETHERNET_INPUT
454 || next0 == GRE_INPUT_NEXT_MPLS_INPUT))
459 key4 = ((u64) (ip4_tun_dst0) << 32) | (u64) (ip4_tun_src0);
463 key6[0] = ip6_tun_dst0[0];
464 key6[1] = ip6_tun_dst0[1];
465 key6[2] = ip6_tun_src0[0];
466 key6[3] = ip6_tun_src0[1];
469 if ((!is_ipv6 && cached_tunnel_key4 != key4) ||
470 (is_ipv6 && cached_tunnel_key6[0] != key6[0] &&
471 cached_tunnel_key6[1] != key6[1] &&
472 cached_tunnel_key6[2] != key6[2] &&
473 cached_tunnel_key6[3] != key6[3]))
475 vnet_hw_interface_t *hi;
480 p = hash_get (gm->tunnel_by_key4, key4);
482 p = hash_get_mem (gm->tunnel_by_key6, key6);
486 next0 = GRE_INPUT_NEXT_DROP;
487 b0->error = node->errors[GRE_ERROR_NO_SUCH_TUNNEL];
490 t = pool_elt_at_index (gm->tunnels, p[0]);
491 hi = vnet_get_hw_interface (gm->vnet_main, t->hw_if_index);
492 tunnel_sw_if_index = hi->sw_if_index;
494 cached_tunnel_sw_if_index = tunnel_sw_if_index;
498 tunnel_sw_if_index = cached_tunnel_sw_if_index;
503 next0 = GRE_INPUT_NEXT_DROP;
506 len = vlib_buffer_length_in_chain (vm, b0);
507 vlib_increment_combined_counter (im->combined_sw_if_counters
508 + VNET_INTERFACE_COUNTER_RX,
514 vnet_buffer (b0)->sw_if_index[VLIB_RX] = tunnel_sw_if_index;
517 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
519 gre_rx_trace_t *tr = vlib_add_trace (vm, node,
521 tr->tunnel_id = tunnel_sw_if_index;
524 tr->length = ip4_0->length;
525 tr->src.ip4.as_u32 = ip4_0->src_address.as_u32;
526 tr->dst.ip4.as_u32 = ip4_0->dst_address.as_u32;
530 tr->length = ip6_0->payload_length;
531 tr->src.ip6.as_u64[0] = ip6_0->src_address.as_u64[0];
532 tr->src.ip6.as_u64[1] = ip6_0->src_address.as_u64[1];
533 tr->dst.ip6.as_u64[0] = ip6_0->dst_address.as_u64[0];
534 tr->dst.ip6.as_u64[1] = ip6_0->dst_address.as_u64[1];
538 vlib_buffer_advance (b0, sizeof (*h0));
540 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
541 to_next, n_left_to_next,
545 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
547 vlib_node_increment_counter (vm,
548 !is_ipv6 ? gre4_input_node.index :
549 gre6_input_node.index, GRE_ERROR_PKTS_DECAP,
550 from_frame->n_vectors);
551 return from_frame->n_vectors;
555 gre4_input (vlib_main_t * vm,
556 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
558 return gre_input (vm, node, from_frame, /* is_ip6 */ 0);
562 gre6_input (vlib_main_t * vm,
563 vlib_node_runtime_t * node, vlib_frame_t * from_frame)
565 return gre_input (vm, node, from_frame, /* is_ip6 */ 1);
568 static char *gre_error_strings[] = {
569 #define gre_error(n,s) s,
575 VLIB_REGISTER_NODE (gre4_input_node) = {
576 .function = gre4_input,
577 .name = "gre4-input",
578 /* Takes a vector of packets. */
579 .vector_size = sizeof (u32),
581 .n_errors = GRE_N_ERROR,
582 .error_strings = gre_error_strings,
584 .n_next_nodes = GRE_INPUT_N_NEXT,
586 #define _(s,n) [GRE_INPUT_NEXT_##s] = n,
587 foreach_gre_input_next
591 .format_buffer = format_gre_header_with_length,
592 .format_trace = format_gre_rx_trace,
593 .unformat_buffer = unformat_gre_header,
598 VLIB_REGISTER_NODE (gre6_input_node) = {
599 .function = gre6_input,
600 .name = "gre6-input",
601 /* Takes a vector of packets. */
602 .vector_size = sizeof (u32),
604 .runtime_data_bytes = sizeof (gre_input_runtime_t),
606 .n_errors = GRE_N_ERROR,
607 .error_strings = gre_error_strings,
609 .n_next_nodes = GRE_INPUT_N_NEXT,
611 #define _(s,n) [GRE_INPUT_NEXT_##s] = n,
612 foreach_gre_input_next
616 .format_buffer = format_gre_header_with_length,
617 .format_trace = format_gre_rx_trace,
618 .unformat_buffer = unformat_gre_header,
622 VLIB_NODE_FUNCTION_MULTIARCH (gre4_input_node, gre4_input)
623 VLIB_NODE_FUNCTION_MULTIARCH (gre6_input_node, gre6_input)
625 gre_register_input_protocol (vlib_main_t * vm,
626 gre_protocol_t protocol, u32 node_index)
628 gre_main_t *em = &gre_main;
629 gre_protocol_info_t *pi;
634 clib_error_t *error = vlib_call_init_function (vm, gre_input_init);
636 clib_error_report (error);
639 pi = gre_get_protocol_info (em, protocol);
640 pi->node_index = node_index;
641 pi->next_index = vlib_node_add_next (vm, gre4_input_node.index, node_index);
642 i = vlib_node_add_next (vm, gre6_input_node.index, node_index);
643 ASSERT (i == pi->next_index);
645 /* Setup gre protocol -> next index sparse vector mapping. */
646 n = sparse_vec_validate (em->next_by_protocol,
647 clib_host_to_net_u16 (protocol));
648 n[0] = pi->next_index;
652 gre_setup_node (vlib_main_t * vm, u32 node_index)
654 vlib_node_t *n = vlib_get_node (vm, node_index);
655 pg_node_t *pn = pg_get_node (node_index);
657 n->format_buffer = format_gre_header_with_length;
658 n->unformat_buffer = unformat_gre_header;
659 pn->unformat_edit = unformat_pg_gre_header;
662 static clib_error_t *
663 gre_input_init (vlib_main_t * vm)
665 gre_main_t *gm = &gre_main;
666 vlib_node_t *ethernet_input, *ip4_input, *ip6_input, *mpls_unicast_input;
670 error = vlib_call_init_function (vm, gre_init);
672 clib_error_report (error);
675 gre_setup_node (vm, gre4_input_node.index);
676 gre_setup_node (vm, gre6_input_node.index);
678 gm->next_by_protocol = sparse_vec_new
679 ( /* elt bytes */ sizeof (gm->next_by_protocol[0]),
680 /* bits in index */ BITS (((gre_header_t *) 0)->protocol));
682 /* These could be moved to the supported protocol input node defn's */
683 ethernet_input = vlib_get_node_by_name (vm, (u8 *) "ethernet-input");
684 ASSERT (ethernet_input);
685 ip4_input = vlib_get_node_by_name (vm, (u8 *) "ip4-input");
687 ip6_input = vlib_get_node_by_name (vm, (u8 *) "ip6-input");
689 mpls_unicast_input = vlib_get_node_by_name (vm, (u8 *) "mpls-input");
690 ASSERT (mpls_unicast_input);
692 gre_register_input_protocol (vm, GRE_PROTOCOL_teb, ethernet_input->index);
694 gre_register_input_protocol (vm, GRE_PROTOCOL_ip4, ip4_input->index);
696 gre_register_input_protocol (vm, GRE_PROTOCOL_ip6, ip6_input->index);
698 gre_register_input_protocol (vm, GRE_PROTOCOL_mpls_unicast,
699 mpls_unicast_input->index);
701 ip4_register_protocol (IP_PROTOCOL_GRE, gre4_input_node.index);
702 ip6_register_protocol (IP_PROTOCOL_GRE, gre6_input_node.index);
707 VLIB_INIT_FUNCTION (gre_input_init);
710 * fd.io coding-style-patch-verification: ON
713 * eval: (c-set-style "gnu")