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 <vnet/vnet.h>
19 #include <vnet/gre/gre.h>
20 #include <vnet/adj/adj_midchain.h>
26 ip4_and_gre_header_t ip4_and_gre;
29 } ip4_and_gre_union_t;
32 /* Packet trace structure */
34 /* Tunnel-id / index in tunnel vector */
40 /* tunnel ip4 addresses */
45 u8 * format_gre_tx_trace (u8 * s, va_list * args)
47 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
48 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
49 gre_tx_trace_t * t = va_arg (*args, gre_tx_trace_t *);
51 s = format (s, "GRE: tunnel %d len %d src %U dst %U",
52 t->tunnel_id, clib_net_to_host_u16 (t->length),
53 format_ip4_address, &t->src.as_u8,
54 format_ip4_address, &t->dst.as_u8);
58 u8 * format_gre_protocol (u8 * s, va_list * args)
60 gre_protocol_t p = va_arg (*args, u32);
61 gre_main_t * gm = &gre_main;
62 gre_protocol_info_t * pi = gre_get_protocol_info (gm, p);
65 s = format (s, "%s", pi->name);
67 s = format (s, "0x%04x", p);
72 u8 * format_gre_header_with_length (u8 * s, va_list * args)
74 gre_main_t * gm = &gre_main;
75 gre_header_t * h = va_arg (*args, gre_header_t *);
76 u32 max_header_bytes = va_arg (*args, u32);
77 gre_protocol_t p = clib_net_to_host_u16 (h->protocol);
78 uword indent, header_bytes;
80 header_bytes = sizeof (h[0]);
81 if (max_header_bytes != 0 && header_bytes > max_header_bytes)
82 return format (s, "gre header truncated");
84 indent = format_get_indent (s);
86 s = format (s, "GRE %U", format_gre_protocol, p);
88 if (max_header_bytes != 0 && header_bytes > max_header_bytes)
90 gre_protocol_info_t * pi = gre_get_protocol_info (gm, p);
91 vlib_node_t * node = vlib_get_node (gm->vlib_main, pi->node_index);
92 if (node->format_buffer)
93 s = format (s, "\n%U%U",
94 format_white_space, indent,
95 node->format_buffer, (void *) (h + 1),
96 max_header_bytes - header_bytes);
102 u8 * format_gre_header (u8 * s, va_list * args)
104 gre_header_t * h = va_arg (*args, gre_header_t *);
105 return format (s, "%U", format_gre_header_with_length, h, 0);
108 /* Returns gre protocol as an int in host byte order. */
110 unformat_gre_protocol_host_byte_order (unformat_input_t * input,
113 u16 * result = va_arg (*args, u16 *);
114 gre_main_t * gm = &gre_main;
118 if (unformat_user (input, unformat_vlib_number_by_name,
119 gm->protocol_info_by_name, &i))
121 gre_protocol_info_t * pi = vec_elt_at_index (gm->protocol_infos, i);
122 *result = pi->protocol;
130 unformat_gre_protocol_net_byte_order (unformat_input_t * input,
133 u16 * result = va_arg (*args, u16 *);
134 if (! unformat_user (input, unformat_gre_protocol_host_byte_order, result))
136 *result = clib_host_to_net_u16 ((u16) *result);
141 unformat_gre_header (unformat_input_t * input, va_list * args)
143 u8 ** result = va_arg (*args, u8 **);
144 gre_header_t _h, * h = &_h;
147 if (! unformat (input, "%U",
148 unformat_gre_protocol_host_byte_order, &p))
151 h->protocol = clib_host_to_net_u16 (p);
153 /* Add header to result. */
156 u32 n_bytes = sizeof (h[0]);
158 vec_add2 (*result, p, n_bytes);
159 clib_memcpy (p, h, n_bytes);
166 gre_proto_from_vnet_link (vnet_link_t link)
171 return (GRE_PROTOCOL_ip4);
173 return (GRE_PROTOCOL_ip6);
175 return (GRE_PROTOCOL_mpls_unicast);
176 case VNET_LINK_ETHERNET:
177 return (GRE_PROTOCOL_teb);
179 return (GRE_PROTOCOL_arp);
182 return (GRE_PROTOCOL_ip4);
186 gre_build_rewrite (vnet_main_t * vnm,
188 vnet_link_t link_type,
189 const void *dst_address)
191 gre_main_t * gm = &gre_main;
192 ip4_and_gre_header_t * h;
197 ti = gm->tunnel_index_by_sw_if_index[sw_if_index];
200 /* not one of ours */
203 t = pool_elt_at_index(gm->tunnels, ti);
205 vec_validate(rewrite, sizeof(*h)-1);
206 h = (ip4_and_gre_header_t*)rewrite;
207 h->gre.protocol = clib_host_to_net_u16(gre_proto_from_vnet_link(link_type));
209 h->ip4.ip_version_and_header_length = 0x45;
211 h->ip4.protocol = IP_PROTOCOL_GRE;
212 /* fixup ip4 header length and checksum after-the-fact */
213 h->ip4.src_address.as_u32 = t->tunnel_src.as_u32;
214 h->ip4.dst_address.as_u32 = t->tunnel_dst.as_u32;
215 h->ip4.checksum = ip4_header_checksum (&h->ip4);
221 gre_fixup (vlib_main_t *vm,
227 ip0 = vlib_buffer_get_current (b0);
229 /* Fixup the checksum and len fields in the GRE tunnel encap
230 * that was applied at the midchain node */
231 ip0->length = clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
232 ip0->checksum = ip4_header_checksum (ip0);
236 gre_update_adj (vnet_main_t * vnm,
240 adj_nbr_midchain_update_rewrite (ai, gre_fixup,
241 ADJ_MIDCHAIN_FLAG_NONE,
242 gre_build_rewrite(vnm, sw_if_index,
243 adj_get_link_type(ai),
246 gre_tunnel_stack(ai);
250 * @brief TX function. Only called L2. L3 traffic uses the adj-midchains
253 gre_interface_tx_inline (vlib_main_t * vm,
254 vlib_node_runtime_t * node,
255 vlib_frame_t * frame)
257 gre_main_t * gm = &gre_main;
259 u32 * from, * to_next, n_left_from, n_left_to_next;
260 vnet_interface_output_runtime_t * rd = (void *) node->runtime_data;
261 const gre_tunnel_t *gt = pool_elt_at_index (gm->tunnels, rd->dev_instance);
263 /* Vector of buffer / pkt indices we're supposed to process */
264 from = vlib_frame_vector_args (frame);
266 /* Number of buffers / pkts */
267 n_left_from = frame->n_vectors;
269 /* Speculatively send the first buffer to the last disposition we used */
270 next_index = node->cached_next_index;
272 while (n_left_from > 0)
274 /* set up to enqueue to our disposition with index = next_index */
275 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
281 while (n_left_from > 0 && n_left_to_next > 0)
293 b0 = vlib_get_buffer(vm, bi0);
295 vnet_buffer(b0)->ip.adj_index[VLIB_TX] = gt->l2_adj_index;
297 if (PREDICT_FALSE(b0->flags & VLIB_BUFFER_IS_TRACED))
299 gre_tx_trace_t *tr = vlib_add_trace (vm, node,
301 tr->tunnel_id = gt - gm->tunnels;
302 tr->length = vlib_buffer_length_in_chain (vm, b0);
303 tr->src.as_u32 = gt->tunnel_src.as_u32;
304 tr->dst.as_u32 = gt->tunnel_src.as_u32;
307 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
308 to_next, n_left_to_next,
312 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
315 vlib_node_increment_counter (vm, gre_input_node.index,
316 GRE_ERROR_PKTS_ENCAP, frame->n_vectors);
318 return frame->n_vectors;
322 gre_interface_tx (vlib_main_t * vm,
323 vlib_node_runtime_t * node,
324 vlib_frame_t * frame)
326 return (gre_interface_tx_inline (vm, node, frame));
330 gre_teb_interface_tx (vlib_main_t * vm,
331 vlib_node_runtime_t * node,
332 vlib_frame_t * frame)
334 return (gre_interface_tx_inline (vm, node, frame));
337 static u8 * format_gre_tunnel_name (u8 * s, va_list * args)
339 u32 dev_instance = va_arg (*args, u32);
340 return format (s, "gre%d", dev_instance);
343 static u8 * format_gre_tunnel_teb_name (u8 * s, va_list * args)
345 u32 dev_instance = va_arg (*args, u32);
346 return format (s, "teb-gre%d", dev_instance);
349 static u8 * format_gre_device (u8 * s, va_list * args)
351 u32 dev_instance = va_arg (*args, u32);
352 CLIB_UNUSED (int verbose) = va_arg (*args, int);
354 s = format (s, "GRE tunnel: id %d\n", dev_instance);
358 VNET_DEVICE_CLASS (gre_device_class) = {
359 .name = "GRE tunnel device",
360 .format_device_name = format_gre_tunnel_name,
361 .format_device = format_gre_device,
362 .format_tx_trace = format_gre_tx_trace,
363 .tx_function = gre_interface_tx,
364 .admin_up_down_function = gre_interface_admin_up_down,
370 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (gre_device_class,
373 VNET_DEVICE_CLASS (gre_device_teb_class) = {
374 .name = "GRE TEB tunnel device",
375 .format_device_name = format_gre_tunnel_teb_name,
376 .format_device = format_gre_device,
377 .format_tx_trace = format_gre_tx_trace,
378 .tx_function = gre_teb_interface_tx,
379 .admin_up_down_function = gre_interface_admin_up_down,
385 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (gre_device_teb_class,
386 gre_teb_interface_tx)
388 VNET_HW_INTERFACE_CLASS (gre_hw_interface_class) = {
390 .format_header = format_gre_header_with_length,
391 .unformat_header = unformat_gre_header,
392 .build_rewrite = gre_build_rewrite,
393 .update_adjacency = gre_update_adj,
394 .flags = VNET_HW_INTERFACE_CLASS_FLAG_P2P,
397 static void add_protocol (gre_main_t * gm,
398 gre_protocol_t protocol,
399 char * protocol_name)
401 gre_protocol_info_t * pi;
404 vec_add2 (gm->protocol_infos, pi, 1);
405 i = pi - gm->protocol_infos;
407 pi->name = protocol_name;
408 pi->protocol = protocol;
409 pi->next_index = pi->node_index = ~0;
411 hash_set (gm->protocol_info_by_protocol, protocol, i);
412 hash_set_mem (gm->protocol_info_by_name, pi->name, i);
415 static clib_error_t * gre_init (vlib_main_t * vm)
417 gre_main_t * gm = &gre_main;
418 clib_error_t * error;
419 ip_main_t * im = &ip_main;
420 ip_protocol_info_t * pi;
422 memset (gm, 0, sizeof (gm[0]));
424 gm->vnet_main = vnet_get_main();
426 if ((error = vlib_call_init_function (vm, ip_main_init)))
429 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
432 /* Set up the ip packet generator */
433 pi = ip_get_protocol_info (im, IP_PROTOCOL_GRE);
434 pi->format_header = format_gre_header;
435 pi->unformat_pg_edit = unformat_pg_gre_header;
437 gm->protocol_info_by_name = hash_create_string (0, sizeof (uword));
438 gm->protocol_info_by_protocol = hash_create (0, sizeof (uword));
439 gm->tunnel_by_key = hash_create (0, sizeof (uword));
441 #define _(n,s) add_protocol (gm, GRE_PROTOCOL_##s, #s);
445 return vlib_call_init_function (vm, gre_input_init);
448 VLIB_INIT_FUNCTION (gre_init);
450 gre_main_t * gre_get_main (vlib_main_t * vm)
452 vlib_call_init_function (vm, gre_init);