2 * Copyright (c) 2016 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.
17 * @brief L2-GRE over IPSec packet processing.
19 * Add GRE header to thr packet and send it to the esp-encrypt node.
22 #include <vnet/vnet.h>
23 #include <vnet/ipsec-gre/ipsec_gre.h>
25 extern ipsec_gre_main_t ipsec_gre_main;
27 #ifndef CLIB_MARCH_VARIANT
28 ipsec_gre_main_t ipsec_gre_main;
29 #endif /* CLIB_MARCH_VARIANT */
32 * @brief IPv4 and GRE header union.
39 ip4_and_gre_header_t ip4_and_gre;
42 } ip4_and_gre_union_t;
45 * @brief Packet trace.
50 u32 tunnel_id; /**< Tunnel-id / index in tunnel vector */
52 u32 length; /**< pkt length */
54 ip4_address_t src; /**< tunnel src IPv4 address */
55 ip4_address_t dst; /**< tunnel dst IPv4 address */
57 u32 sa_id; /**< tunnel IPSec SA id */
58 } ipsec_gre_tx_trace_t;
61 format_ipsec_gre_tx_trace (u8 * s, va_list * args)
63 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
64 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
65 ipsec_gre_tx_trace_t *t = va_arg (*args, ipsec_gre_tx_trace_t *);
67 s = format (s, "GRE: tunnel %d len %d src %U dst %U sa-id %d",
68 t->tunnel_id, clib_net_to_host_u16 (t->length),
69 format_ip4_address, &t->src.as_u8,
70 format_ip4_address, &t->dst.as_u8, t->sa_id);
75 * @brief IPSec-GRE tunnel interface tx function.
77 * Add GRE header to the packet.
79 * @param vm vlib_main_t corresponding to the current thread.
80 * @param node vlib_node_runtime_t data for this node.
81 * @param frame vlib_frame_t whose contents should be dispatched.
83 * @par Graph mechanics: buffer metadata, next index usage
86 * - <code>node->runtime_data</code>
87 * - Match tunnel by <code>rd->dev_instance</code> in IPSec-GRE tunnels
91 * - <code>vnet_buffer(b)->output_features.ipsec_sad_index</code>
92 * - Set IPSec Security Association for packet encryption.
93 * - <code>vnet_buffer(b)->sw_if_index[VLIB_TX]</code>
94 * - Reset output sw_if_index.
96 * <em>Next Index:</em>
97 * - Dispatches the packet to the esp-encrypt node.
99 VNET_DEVICE_CLASS_TX_FN (ipsec_gre_device_class) (vlib_main_t * vm,
100 vlib_node_runtime_t * node,
101 vlib_frame_t * frame)
103 ipsec_gre_main_t *igm = &ipsec_gre_main;
105 u32 *from, *to_next, n_left_from, n_left_to_next;
106 vnet_interface_output_runtime_t *rd = (void *) node->runtime_data;
107 ipsec_gre_tunnel_t *t = pool_elt_at_index (igm->tunnels, rd->dev_instance);
109 u16 l2_gre_protocol_ethertype = clib_net_to_host_u16 (GRE_PROTOCOL_teb);
111 /* Vector of buffer / pkt indices we're supposed to process */
112 from = vlib_frame_vector_args (frame);
114 /* Number of buffers / pkts */
115 n_left_from = frame->n_vectors;
117 /* Speculatively send the first buffer to the last disposition we used */
118 next_index = node->cached_next_index;
120 while (n_left_from > 0)
122 /* set up to enqueue to our disposition with index = next_index */
123 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
126 * As long as we have enough pkts left to process two pkts
127 * and prefetch two pkts...
129 while (n_left_from >= 4 && n_left_to_next >= 2)
131 vlib_buffer_t *b0, *b1;
132 ip4_header_t *ip0, *ip1;
133 ip4_and_gre_union_t *h0, *h1;
134 u32 bi0, next0, bi1, next1;
135 __attribute__ ((unused)) u8 error0, error1;
137 /* Prefetch the next iteration */
139 vlib_buffer_t *p2, *p3;
141 p2 = vlib_get_buffer (vm, from[2]);
142 p3 = vlib_get_buffer (vm, from[3]);
144 vlib_prefetch_buffer_header (p2, LOAD);
145 vlib_prefetch_buffer_header (p3, LOAD);
148 * Prefetch packet data. We expect to overwrite
149 * the inbound L2 header with an ip header and a
150 * gre header. Might want to prefetch the last line
151 * of rewrite space as well; need profile data
153 CLIB_PREFETCH (p2->data, CLIB_CACHE_LINE_BYTES, STORE);
154 CLIB_PREFETCH (p3->data, CLIB_CACHE_LINE_BYTES, STORE);
157 /* Pick up the next two buffer indices */
161 /* Speculatively enqueue them where we sent the last buffer */
169 b0 = vlib_get_buffer (vm, bi0);
170 b1 = vlib_get_buffer (vm, bi1);
172 vlib_buffer_advance (b0, -sizeof (*h0));
173 vlib_buffer_advance (b1, -sizeof (*h1));
175 h0 = vlib_buffer_get_current (b0);
176 h1 = vlib_buffer_get_current (b1);
185 ip0 = &h0->ip4_and_gre.ip4;
186 h0->ip4_and_gre.gre.protocol = l2_gre_protocol_ethertype;
187 ip0->ip_version_and_header_length = 0x45;
189 ip0->protocol = IP_PROTOCOL_GRE;
191 ip1 = &h1->ip4_and_gre.ip4;
192 h1->ip4_and_gre.gre.protocol = l2_gre_protocol_ethertype;
193 ip1->ip_version_and_header_length = 0x45;
195 ip1->protocol = IP_PROTOCOL_GRE;
198 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
200 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b1));
201 ip0->src_address.as_u32 = t->tunnel_src.as_u32;
202 ip1->src_address.as_u32 = t->tunnel_src.as_u32;
203 ip0->dst_address.as_u32 = t->tunnel_dst.as_u32;
204 ip1->dst_address.as_u32 = t->tunnel_dst.as_u32;
205 ip0->checksum = ip4_header_checksum (ip0);
206 ip1->checksum = ip4_header_checksum (ip1);
208 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
209 vnet_buffer (b0)->sw_if_index[VLIB_TX];
210 vnet_buffer (b1)->sw_if_index[VLIB_RX] =
211 vnet_buffer (b1)->sw_if_index[VLIB_TX];
213 vnet_buffer (b0)->ipsec.sad_index = t->local_sa;
214 vnet_buffer (b1)->ipsec.sad_index = t->local_sa;
216 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
217 vnet_buffer (b1)->sw_if_index[VLIB_TX] = (u32) ~ 0;
219 next0 = IPSEC_GRE_OUTPUT_NEXT_ESP_ENCRYPT;
220 next1 = IPSEC_GRE_OUTPUT_NEXT_ESP_ENCRYPT;
221 error0 = IPSEC_GRE_ERROR_NONE;
222 error1 = IPSEC_GRE_ERROR_NONE;
224 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
226 ipsec_gre_tx_trace_t *tr = vlib_add_trace (vm, node,
228 tr->tunnel_id = t - igm->tunnels;
229 tr->length = ip0->length;
230 tr->src.as_u32 = ip0->src_address.as_u32;
231 tr->dst.as_u32 = ip0->dst_address.as_u32;
232 tr->sa_id = t->local_sa_id;
235 if (PREDICT_FALSE (b1->flags & VLIB_BUFFER_IS_TRACED))
237 ipsec_gre_tx_trace_t *tr = vlib_add_trace (vm, node,
239 tr->tunnel_id = t - igm->tunnels;
240 tr->length = ip1->length;
241 tr->src.as_u32 = ip1->src_address.as_u32;
242 tr->dst.as_u32 = ip1->dst_address.as_u32;
243 tr->sa_id = t->local_sa_id;
246 vlib_validate_buffer_enqueue_x2 (vm, node, next_index,
247 to_next, n_left_to_next,
248 bi0, bi1, next0, next1);
251 while (n_left_from > 0 && n_left_to_next > 0)
255 ip4_and_gre_union_t *h0;
257 __attribute__ ((unused)) u8 error0;
259 bi0 = to_next[0] = from[0];
265 b0 = vlib_get_buffer (vm, bi0);
267 vlib_buffer_advance (b0, -sizeof (*h0));
269 h0 = vlib_buffer_get_current (b0);
274 ip0 = &h0->ip4_and_gre.ip4;
275 h0->ip4_and_gre.gre.protocol = l2_gre_protocol_ethertype;
276 ip0->ip_version_and_header_length = 0x45;
278 ip0->protocol = IP_PROTOCOL_GRE;
280 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
281 ip0->src_address.as_u32 = t->tunnel_src.as_u32;
282 ip0->dst_address.as_u32 = t->tunnel_dst.as_u32;
283 ip0->checksum = ip4_header_checksum (ip0);
285 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
286 vnet_buffer (b0)->sw_if_index[VLIB_TX];
287 vnet_buffer (b0)->ipsec.sad_index = t->local_sa;
288 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
290 next0 = IPSEC_GRE_OUTPUT_NEXT_ESP_ENCRYPT;
291 error0 = IPSEC_GRE_ERROR_NONE;
293 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
295 ipsec_gre_tx_trace_t *tr = vlib_add_trace (vm, node,
297 tr->tunnel_id = t - igm->tunnels;
298 tr->length = ip0->length;
299 tr->src.as_u32 = ip0->src_address.as_u32;
300 tr->dst.as_u32 = ip0->dst_address.as_u32;
301 tr->sa_id = t->local_sa_id;
304 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
305 to_next, n_left_to_next,
309 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
312 vlib_node_increment_counter (vm, ipsec_gre_input_node.index,
313 IPSEC_GRE_ERROR_PKTS_ENCAP, frame->n_vectors);
315 return frame->n_vectors;
318 static clib_error_t *
319 ipsec_gre_interface_admin_up_down (vnet_main_t * vnm, u32 hw_if_index,
322 if (flags & VNET_SW_INTERFACE_FLAG_ADMIN_UP)
323 vnet_hw_interface_set_flags (vnm, hw_if_index,
324 VNET_HW_INTERFACE_FLAG_LINK_UP);
326 vnet_hw_interface_set_flags (vnm, hw_if_index, 0 /* down */ );
328 return /* no error */ 0;
332 format_ipsec_gre_tunnel_name (u8 * s, va_list * args)
334 u32 dev_instance = va_arg (*args, u32);
335 return format (s, "ipsec-gre%d", dev_instance);
339 format_ipsec_gre_device (u8 * s, va_list * args)
341 u32 dev_instance = va_arg (*args, u32);
342 CLIB_UNUSED (int verbose) = va_arg (*args, int);
344 s = format (s, "IPSEC-GRE tunnel: id %d\n", dev_instance);
349 VNET_DEVICE_CLASS (ipsec_gre_device_class) = {
350 .name = "IPSec GRE tunnel device",
351 .format_device_name = format_ipsec_gre_tunnel_name,
352 .format_device = format_ipsec_gre_device,
353 .format_tx_trace = format_ipsec_gre_tx_trace,
354 .admin_up_down_function = ipsec_gre_interface_admin_up_down,
358 #ifndef CLIB_MARCH_VARIANT
359 VNET_HW_INTERFACE_CLASS (ipsec_gre_hw_interface_class) = {
362 #endif /* CLIB_MARCH_VARIANT */
365 static clib_error_t *
366 ipsec_gre_init (vlib_main_t * vm)
368 ipsec_gre_main_t *igm = &ipsec_gre_main;
371 clib_memset (igm, 0, sizeof (igm[0]));
373 igm->vnet_main = vnet_get_main ();
375 if ((error = vlib_call_init_function (vm, ip_main_init)))
378 if ((error = vlib_call_init_function (vm, ip4_lookup_init)))
381 igm->tunnel_by_key = hash_create (0, sizeof (uword));
383 return vlib_call_init_function (vm, ipsec_gre_input_init);
386 VLIB_INIT_FUNCTION (ipsec_gre_init);
389 * fd.io coding-style-patch-verification: ON
392 * eval: (c-set-style "gnu")