2 * esp_encrypt.c : IPSec ESP encrypt node using DPDK Cryptodev
4 * Copyright (c) 2016 Intel 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/api_errno.h>
20 #include <vnet/ip/ip.h>
22 #include <vnet/ipsec/ipsec.h>
23 #include <vnet/devices/dpdk/ipsec/ipsec.h>
24 #include <vnet/devices/dpdk/ipsec/esp.h>
25 #include <vnet/devices/dpdk/dpdk.h>
26 #include <vnet/devices/dpdk/dpdk_priv.h>
28 #define foreach_esp_encrypt_next \
29 _(DROP, "error-drop") \
30 _(IP4_LOOKUP, "ip4-lookup") \
31 _(IP6_LOOKUP, "ip6-lookup") \
32 _(INTERFACE_OUTPUT, "interface-output")
34 #define _(v, s) ESP_ENCRYPT_NEXT_##v,
37 foreach_esp_encrypt_next
42 #define foreach_esp_encrypt_error \
43 _(RX_PKTS, "ESP pkts received") \
44 _(SEQ_CYCLED, "sequence number cycled") \
45 _(ENQ_FAIL, "Enqueue failed (buffer full)") \
46 _(NO_CRYPTODEV, "Cryptodev not configured") \
47 _(UNSUPPORTED, "Cipher/Auth not supported")
52 #define _(sym,str) ESP_ENCRYPT_ERROR_##sym,
53 foreach_esp_encrypt_error
56 } esp_encrypt_error_t;
58 static char *esp_encrypt_error_strings[] = {
59 #define _(sym,string) string,
60 foreach_esp_encrypt_error
64 vlib_node_registration_t dpdk_esp_encrypt_node;
70 ipsec_crypto_alg_t crypto_alg;
71 ipsec_integ_alg_t integ_alg;
72 } esp_encrypt_trace_t;
74 /* packet trace format function */
76 format_esp_encrypt_trace (u8 * s, va_list * args)
78 CLIB_UNUSED (vlib_main_t * vm) = va_arg (*args, vlib_main_t *);
79 CLIB_UNUSED (vlib_node_t * node) = va_arg (*args, vlib_node_t *);
80 esp_encrypt_trace_t *t = va_arg (*args, esp_encrypt_trace_t *);
82 s = format (s, "esp: spi %u seq %u crypto %U integrity %U",
84 format_ipsec_crypto_alg, t->crypto_alg,
85 format_ipsec_integ_alg, t->integ_alg);
90 dpdk_esp_encrypt_node_fn (vlib_main_t * vm,
91 vlib_node_runtime_t * node,
92 vlib_frame_t * from_frame)
94 u32 n_left_from, *from, *to_next, next_index;
95 ipsec_main_t *im = &ipsec_main;
96 u32 cpu_index = os_get_cpu_number ();
97 dpdk_crypto_main_t *dcm = &dpdk_crypto_main;
98 dpdk_esp_main_t *em = &dpdk_esp_main;
101 from = vlib_frame_vector_args (from_frame);
102 n_left_from = from_frame->n_vectors;
104 if (PREDICT_FALSE (!dcm->workers_main))
106 /* Likely there are not enough cryptodevs, so drop frame */
107 vlib_node_increment_counter (vm, dpdk_esp_encrypt_node.index,
108 ESP_ENCRYPT_ERROR_NO_CRYPTODEV,
110 vlib_buffer_free (vm, from, n_left_from);
114 crypto_worker_main_t *cwm = vec_elt_at_index (dcm->workers_main, cpu_index);
115 u32 n_qps = vec_len (cwm->qp_data);
116 struct rte_crypto_op **cops_to_enq[n_qps];
117 u32 n_cop_qp[n_qps], *bi_to_enq[n_qps];
119 for (i = 0; i < n_qps; i++)
121 bi_to_enq[i] = cwm->qp_data[i].bi;
122 cops_to_enq[i] = cwm->qp_data[i].cops;
125 memset (n_cop_qp, 0, n_qps * sizeof (u32));
127 crypto_alloc_cops ();
129 next_index = ESP_ENCRYPT_NEXT_DROP;
131 while (n_left_from > 0)
135 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
137 while (n_left_from > 0 && n_left_to_next > 0)
140 vlib_buffer_t *b0 = 0;
143 ip4_and_esp_header_t *ih0, *oh0 = 0;
144 ip6_and_esp_header_t *ih6_0, *oh6_0 = 0;
145 struct rte_mbuf *mb0 = 0;
150 u8 transport_mode = 0;
151 const int BLOCK_SIZE = 16;
154 crypto_sa_session_t *sa_sess;
156 struct rte_crypto_op *cop = 0;
163 b0 = vlib_get_buffer (vm, bi0);
164 sa_index0 = vnet_buffer (b0)->ipsec.sad_index;
165 sa0 = pool_elt_at_index (im->sad, sa_index0);
167 if (PREDICT_FALSE (esp_seq_advance (sa0)))
169 clib_warning ("sequence number counter has cycled SPI %u",
171 vlib_node_increment_counter (vm, dpdk_esp_encrypt_node.index,
172 ESP_ENCRYPT_ERROR_SEQ_CYCLED, 1);
180 sa0->total_data_size += b0->current_length;
182 sa_sess = pool_elt_at_index (cwm->sa_sess_d[1], sa_index0);
183 if (PREDICT_FALSE (!sa_sess->sess))
185 int ret = create_sym_sess (sa0, sa_sess, 1);
187 if (PREDICT_FALSE (ret))
196 qp_index = sa_sess->qp_index;
197 sess = sa_sess->sess;
199 ASSERT (vec_len (vec_elt (cwm->qp_data, qp_index).free_cops) > 0);
200 cop = vec_pop (vec_elt (cwm->qp_data, qp_index).free_cops);
201 ASSERT (cop->status == RTE_CRYPTO_OP_STATUS_NOT_PROCESSED);
203 cops_to_enq[qp_index][0] = cop;
204 cops_to_enq[qp_index] += 1;
205 n_cop_qp[qp_index] += 1;
206 bi_to_enq[qp_index][0] = bi0;
207 bi_to_enq[qp_index] += 1;
210 iv_size = em->esp_crypto_algs[sa0->crypto_alg].iv_len;
211 ih0 = vlib_buffer_get_current (b0);
212 orig_sz = b0->current_length;
213 is_ipv6 = (ih0->ip4.ip_version_and_header_length & 0xF0) == 0x60;
215 if (PREDICT_TRUE (sa0->is_tunnel))
217 if (PREDICT_TRUE (!is_ipv6))
218 adv = -sizeof (ip4_and_esp_header_t);
220 adv = -sizeof (ip6_and_esp_header_t);
224 adv = -sizeof (esp_header_t);
225 if (PREDICT_TRUE (!is_ipv6))
226 orig_sz -= sizeof (ip4_header_t);
228 orig_sz -= sizeof (ip6_header_t);
231 /*transport mode save the eth header before it is overwritten */
232 if (PREDICT_FALSE (!sa0->is_tunnel))
234 ethernet_header_t *ieh0 = (ethernet_header_t *)
235 ((u8 *) vlib_buffer_get_current (b0) -
236 sizeof (ethernet_header_t));
237 ethernet_header_t *oeh0 =
238 (ethernet_header_t *) ((u8 *) ieh0 + (adv - iv_size));
239 clib_memcpy (oeh0, ieh0, sizeof (ethernet_header_t));
242 vlib_buffer_advance (b0, adv - iv_size);
244 /* XXX IP6/ip4 and IP4/IP6 not supported, only IP4/IP4 and IP6/IP6 */
247 if (PREDICT_FALSE (is_ipv6))
249 ih6_0 = (ip6_and_esp_header_t *) ih0;
250 ip_hdr_size = sizeof (ip6_header_t);
251 oh6_0 = vlib_buffer_get_current (b0);
253 if (PREDICT_TRUE (sa0->is_tunnel))
255 next_hdr_type = IP_PROTOCOL_IPV6;
256 oh6_0->ip6.ip_version_traffic_class_and_flow_label =
257 ih6_0->ip6.ip_version_traffic_class_and_flow_label;
261 next_hdr_type = ih6_0->ip6.protocol;
262 memmove (oh6_0, ih6_0, sizeof (ip6_header_t));
265 oh6_0->ip6.protocol = IP_PROTOCOL_IPSEC_ESP;
266 oh6_0->ip6.hop_limit = 254;
267 oh6_0->esp.spi = clib_net_to_host_u32 (sa0->spi);
268 oh6_0->esp.seq = clib_net_to_host_u32 (sa0->seq);
272 ip_hdr_size = sizeof (ip4_header_t);
273 oh0 = vlib_buffer_get_current (b0);
275 if (PREDICT_TRUE (sa0->is_tunnel))
277 next_hdr_type = IP_PROTOCOL_IP_IN_IP;
278 oh0->ip4.tos = ih0->ip4.tos;
282 next_hdr_type = ih0->ip4.protocol;
283 memmove (oh0, ih0, sizeof (ip4_header_t));
286 oh0->ip4.ip_version_and_header_length = 0x45;
287 oh0->ip4.fragment_id = 0;
288 oh0->ip4.flags_and_fragment_offset = 0;
290 oh0->ip4.protocol = IP_PROTOCOL_IPSEC_ESP;
291 oh0->esp.spi = clib_net_to_host_u32 (sa0->spi);
292 oh0->esp.seq = clib_net_to_host_u32 (sa0->seq);
295 if (PREDICT_TRUE (sa0->is_tunnel && !sa0->is_tunnel_ip6))
297 oh0->ip4.src_address.as_u32 = sa0->tunnel_src_addr.ip4.as_u32;
298 oh0->ip4.dst_address.as_u32 = sa0->tunnel_dst_addr.ip4.as_u32;
300 /* in tunnel mode send it back to FIB */
301 next0 = ESP_ENCRYPT_NEXT_IP4_LOOKUP;
302 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
304 else if (sa0->is_tunnel && sa0->is_tunnel_ip6)
306 oh6_0->ip6.src_address.as_u64[0] =
307 sa0->tunnel_src_addr.ip6.as_u64[0];
308 oh6_0->ip6.src_address.as_u64[1] =
309 sa0->tunnel_src_addr.ip6.as_u64[1];
310 oh6_0->ip6.dst_address.as_u64[0] =
311 sa0->tunnel_dst_addr.ip6.as_u64[0];
312 oh6_0->ip6.dst_address.as_u64[1] =
313 sa0->tunnel_dst_addr.ip6.as_u64[1];
315 /* in tunnel mode send it back to FIB */
316 next0 = ESP_ENCRYPT_NEXT_IP6_LOOKUP;
317 vnet_buffer (b0)->sw_if_index[VLIB_TX] = (u32) ~ 0;
321 next0 = ESP_ENCRYPT_NEXT_INTERFACE_OUTPUT;
325 ASSERT (sa0->crypto_alg < IPSEC_CRYPTO_N_ALG);
326 ASSERT (sa0->crypto_alg != IPSEC_CRYPTO_ALG_NONE);
328 int blocks = 1 + (orig_sz + 1) / BLOCK_SIZE;
330 /* pad packet in input buffer */
331 u8 pad_bytes = BLOCK_SIZE * blocks - 2 - orig_sz;
333 u8 *padding = vlib_buffer_get_current (b0) + b0->current_length;
335 for (i = 0; i < pad_bytes; ++i)
338 f0 = vlib_buffer_get_current (b0) + b0->current_length + pad_bytes;
339 f0->pad_length = pad_bytes;
340 f0->next_header = next_hdr_type;
341 b0->current_length += pad_bytes + 2 +
342 em->esp_integ_algs[sa0->integ_alg].trunc_size;
344 vnet_buffer (b0)->sw_if_index[VLIB_RX] =
345 vnet_buffer (b0)->sw_if_index[VLIB_RX];
346 b0->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
348 struct rte_crypto_sym_op *sym_cop;
349 sym_cop = (struct rte_crypto_sym_op *) (cop + 1);
351 dpdk_cop_priv_t *priv = (dpdk_cop_priv_t *) (sym_cop + 1);
353 vnet_buffer (b0)->unused[0] = next0;
355 mb0 = rte_mbuf_from_vlib_buffer (b0);
356 mb0->data_len = b0->current_length;
357 mb0->pkt_len = b0->current_length;
358 mb0->data_off = RTE_PKTMBUF_HEADROOM + b0->current_data;
360 rte_crypto_op_attach_sym_session (cop, sess);
362 sym_cop->m_src = mb0;
364 dpdk_gcm_cnt_blk *icb = &priv->cb;
365 icb->salt = sa0->salt;
366 icb->iv[0] = sa0->seq;
367 icb->iv[1] = sa0->seq_hi;
369 if (sa0->crypto_alg == IPSEC_CRYPTO_ALG_AES_GCM_128)
371 icb->cnt = clib_host_to_net_u32 (1);
372 clib_memcpy (vlib_buffer_get_current (b0) + ip_hdr_size +
373 sizeof (esp_header_t), icb->iv, 8);
374 sym_cop->cipher.data.offset =
375 ip_hdr_size + sizeof (esp_header_t) + iv_size;
376 sym_cop->cipher.data.length = BLOCK_SIZE * blocks;
377 sym_cop->cipher.iv.length = 16;
381 sym_cop->cipher.data.offset =
382 ip_hdr_size + sizeof (esp_header_t);
383 sym_cop->cipher.data.length = BLOCK_SIZE * blocks + iv_size;
384 sym_cop->cipher.iv.length = iv_size;
387 sym_cop->cipher.iv.data = (u8 *) icb;
388 sym_cop->cipher.iv.phys_addr = cop->phys_addr + (uintptr_t) icb
392 ASSERT (sa0->integ_alg < IPSEC_INTEG_N_ALG);
393 ASSERT (sa0->integ_alg != IPSEC_INTEG_ALG_NONE);
395 if (PREDICT_FALSE (sa0->integ_alg == IPSEC_INTEG_ALG_AES_GCM_128))
398 clib_memcpy (aad, vlib_buffer_get_current (b0) + ip_hdr_size,
400 sym_cop->auth.aad.data = aad;
401 sym_cop->auth.aad.phys_addr = cop->phys_addr +
402 (uintptr_t) aad - (uintptr_t) cop;
404 if (PREDICT_FALSE (sa0->use_esn))
406 *((u32 *) & aad[8]) = sa0->seq_hi;
407 sym_cop->auth.aad.length = 12;
411 sym_cop->auth.aad.length = 8;
416 sym_cop->auth.data.offset = ip_hdr_size;
417 sym_cop->auth.data.length = b0->current_length - ip_hdr_size
418 - em->esp_integ_algs[sa0->integ_alg].trunc_size;
420 if (PREDICT_FALSE (sa0->use_esn))
423 vlib_buffer_get_current (b0) + b0->current_length;
424 *((u32 *) payload_end) = sa0->seq_hi;
425 sym_cop->auth.data.length += sizeof (sa0->seq_hi);
428 sym_cop->auth.digest.data = vlib_buffer_get_current (b0) +
430 em->esp_integ_algs[sa0->integ_alg].trunc_size;
431 sym_cop->auth.digest.phys_addr = rte_pktmbuf_mtophys_offset (mb0,
435 [sa0->integ_alg].trunc_size);
436 sym_cop->auth.digest.length =
437 em->esp_integ_algs[sa0->integ_alg].trunc_size;
440 if (PREDICT_FALSE (is_ipv6))
442 oh6_0->ip6.payload_length =
443 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0) -
444 sizeof (ip6_header_t));
449 clib_host_to_net_u16 (vlib_buffer_length_in_chain (vm, b0));
450 oh0->ip4.checksum = ip4_header_checksum (&oh0->ip4);
454 vlib_buffer_advance (b0, -sizeof (ethernet_header_t));
457 if (PREDICT_FALSE (b0->flags & VLIB_BUFFER_IS_TRACED))
459 esp_encrypt_trace_t *tr =
460 vlib_add_trace (vm, node, b0, sizeof (*tr));
462 tr->seq = sa0->seq - 1;
463 tr->crypto_alg = sa0->crypto_alg;
464 tr->integ_alg = sa0->integ_alg;
467 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
469 vlib_node_increment_counter (vm, dpdk_esp_encrypt_node.index,
470 ESP_ENCRYPT_ERROR_RX_PKTS,
471 from_frame->n_vectors);
472 crypto_qp_data_t *qpd;
474 vec_foreach_index (i, cwm->qp_data)
478 qpd = vec_elt_at_index(cwm->qp_data, i);
479 enq = rte_cryptodev_enqueue_burst(qpd->dev_id, qpd->qp_id,
480 qpd->cops, n_cop_qp[i]);
481 qpd->inflights += enq;
483 if (PREDICT_FALSE(enq < n_cop_qp[i]))
485 crypto_free_cop (qpd, &qpd->cops[enq], n_cop_qp[i] - enq);
486 vlib_buffer_free (vm, &qpd->bi[enq], n_cop_qp[i] - enq);
488 vlib_node_increment_counter (vm, dpdk_esp_encrypt_node.index,
489 ESP_ENCRYPT_ERROR_ENQ_FAIL,
495 return from_frame->n_vectors;
498 VLIB_REGISTER_NODE (dpdk_esp_encrypt_node) =
500 .function = dpdk_esp_encrypt_node_fn,.name = "dpdk-esp-encrypt",.flags =
501 VLIB_NODE_FLAG_IS_OUTPUT,.vector_size = sizeof (u32),.format_trace =
502 format_esp_encrypt_trace,.n_errors =
503 ARRAY_LEN (esp_encrypt_error_strings),.error_strings =
504 esp_encrypt_error_strings,.n_next_nodes = 1,.next_nodes =
506 [ESP_ENCRYPT_NEXT_DROP] = "error-drop",}
509 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_encrypt_node, dpdk_esp_encrypt_node_fn)
511 * ESP Encrypt Post Node
513 #define foreach_esp_encrypt_post_error \
514 _(PKTS, "ESP post pkts")
517 #define _(sym,str) ESP_ENCRYPT_POST_ERROR_##sym,
518 foreach_esp_encrypt_post_error
520 ESP_ENCRYPT_POST_N_ERROR,
521 } esp_encrypt_post_error_t;
523 static char *esp_encrypt_post_error_strings[] = {
524 #define _(sym,string) string,
525 foreach_esp_encrypt_post_error
529 vlib_node_registration_t dpdk_esp_encrypt_post_node;
532 format_esp_encrypt_post_trace (u8 * s, va_list * args)
538 dpdk_esp_encrypt_post_node_fn (vlib_main_t * vm,
539 vlib_node_runtime_t * node,
540 vlib_frame_t * from_frame)
542 u32 n_left_from, *from, *to_next = 0, next_index;
544 from = vlib_frame_vector_args (from_frame);
545 n_left_from = from_frame->n_vectors;
547 next_index = node->cached_next_index;
549 while (n_left_from > 0)
553 vlib_get_next_frame (vm, node, next_index, to_next, n_left_to_next);
555 while (n_left_from > 0 && n_left_to_next > 0)
558 vlib_buffer_t *b0 = 0;
565 b0 = vlib_get_buffer (vm, bi0);
570 next0 = vnet_buffer (b0)->unused[0];
572 vlib_validate_buffer_enqueue_x1 (vm, node, next_index,
573 to_next, n_left_to_next, bi0,
576 vlib_put_next_frame (vm, node, next_index, n_left_to_next);
579 vlib_node_increment_counter (vm, dpdk_esp_encrypt_post_node.index,
580 ESP_ENCRYPT_POST_ERROR_PKTS,
581 from_frame->n_vectors);
583 return from_frame->n_vectors;
586 VLIB_REGISTER_NODE (dpdk_esp_encrypt_post_node) =
588 .function = dpdk_esp_encrypt_post_node_fn,.name =
589 "dpdk-esp-encrypt-post",.vector_size = sizeof (u32),.format_trace =
590 format_esp_encrypt_post_trace,.type = VLIB_NODE_TYPE_INTERNAL,.n_errors =
591 ARRAY_LEN (esp_encrypt_post_error_strings),.error_strings =
592 esp_encrypt_post_error_strings,.n_next_nodes =
593 ESP_ENCRYPT_N_NEXT,.next_nodes =
595 #define _(s,n) [ESP_ENCRYPT_NEXT_##s] = n,
596 foreach_esp_encrypt_next
601 VLIB_NODE_FUNCTION_MULTIARCH (dpdk_esp_encrypt_post_node,
602 dpdk_esp_encrypt_post_node_fn)
604 * fd.io coding-style-patch-verification: ON
607 * eval: (c-set-style "gnu")