1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2016-2017 Intel Corporation
5 #include <rte_common.h>
6 #include <rte_hexdump.h>
7 #include <rte_cryptodev.h>
8 #include <rte_cryptodev_pmd.h>
9 #include <rte_bus_vdev.h>
10 #include <rte_malloc.h>
11 #include <rte_cpuflags.h>
12 #include <rte_byteorder.h>
14 #include "aesni_gcm_pmd_private.h"
16 static uint8_t cryptodev_driver_id;
18 /** Parse crypto xform chain and set private session parameters */
20 aesni_gcm_set_session_parameters(const struct aesni_gcm_ops *gcm_ops,
21 struct aesni_gcm_session *sess,
22 const struct rte_crypto_sym_xform *xform)
24 const struct rte_crypto_sym_xform *auth_xform;
25 const struct rte_crypto_sym_xform *aead_xform;
30 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
32 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_AES_GMAC) {
33 AESNI_GCM_LOG(ERR, "Only AES GMAC is supported as an "
34 "authentication only algorithm");
37 /* Set IV parameters */
38 sess->iv.offset = auth_xform->auth.iv.offset;
39 sess->iv.length = auth_xform->auth.iv.length;
41 /* Select Crypto operation */
42 if (auth_xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
43 sess->op = AESNI_GMAC_OP_GENERATE;
45 sess->op = AESNI_GMAC_OP_VERIFY;
47 key_length = auth_xform->auth.key.length;
48 key = auth_xform->auth.key.data;
49 sess->req_digest_length = auth_xform->auth.digest_length;
52 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
55 if (aead_xform->aead.algo != RTE_CRYPTO_AEAD_AES_GCM) {
56 AESNI_GCM_LOG(ERR, "The only combined operation "
57 "supported is AES GCM");
61 /* Set IV parameters */
62 sess->iv.offset = aead_xform->aead.iv.offset;
63 sess->iv.length = aead_xform->aead.iv.length;
65 /* Select Crypto operation */
66 if (aead_xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
67 sess->op = AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION;
69 sess->op = AESNI_GCM_OP_AUTHENTICATED_DECRYPTION;
71 key_length = aead_xform->aead.key.length;
72 key = aead_xform->aead.key.data;
74 sess->aad_length = aead_xform->aead.aad_length;
75 sess->req_digest_length = aead_xform->aead.digest_length;
77 AESNI_GCM_LOG(ERR, "Wrong xform type, has to be AEAD or authentication");
83 if (sess->iv.length != 16 && sess->iv.length != 12 &&
84 sess->iv.length != 0) {
85 AESNI_GCM_LOG(ERR, "Wrong IV length");
89 /* Check key length and calculate GCM pre-compute. */
92 sess->key = AESNI_GCM_KEY_128;
95 sess->key = AESNI_GCM_KEY_192;
98 sess->key = AESNI_GCM_KEY_256;
101 AESNI_GCM_LOG(ERR, "Invalid key length");
105 gcm_ops[sess->key].precomp(key, &sess->gdata_key);
108 if (sess->req_digest_length > 16) {
109 AESNI_GCM_LOG(ERR, "Invalid digest length");
113 * Multi-buffer lib supports digest sizes from 4 to 16 bytes
114 * in version 0.50 and sizes of 8, 12 and 16 bytes,
116 * If size requested is different, generate the full digest
117 * (16 bytes) in a temporary location and then memcpy
118 * the requested number of bytes.
120 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
121 if (sess->req_digest_length < 4)
123 if (sess->req_digest_length != 16 &&
124 sess->req_digest_length != 12 &&
125 sess->req_digest_length != 8)
127 sess->gen_digest_length = 16;
129 sess->gen_digest_length = sess->req_digest_length;
134 /** Get gcm session */
135 static struct aesni_gcm_session *
136 aesni_gcm_get_session(struct aesni_gcm_qp *qp, struct rte_crypto_op *op)
138 struct aesni_gcm_session *sess = NULL;
139 struct rte_crypto_sym_op *sym_op = op->sym;
141 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
142 if (likely(sym_op->session != NULL))
143 sess = (struct aesni_gcm_session *)
144 get_sym_session_private_data(
146 cryptodev_driver_id);
149 void *_sess_private_data = NULL;
151 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
154 if (rte_mempool_get(qp->sess_mp_priv,
155 (void **)&_sess_private_data))
158 sess = (struct aesni_gcm_session *)_sess_private_data;
160 if (unlikely(aesni_gcm_set_session_parameters(qp->ops,
161 sess, sym_op->xform) != 0)) {
162 rte_mempool_put(qp->sess_mp, _sess);
163 rte_mempool_put(qp->sess_mp_priv, _sess_private_data);
166 sym_op->session = (struct rte_cryptodev_sym_session *)_sess;
167 set_sym_session_private_data(sym_op->session,
168 cryptodev_driver_id, _sess_private_data);
171 if (unlikely(sess == NULL))
172 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
178 * Process a crypto operation, calling
179 * the GCM API from the multi buffer library.
181 * @param qp queue pair
182 * @param op symmetric crypto operation
183 * @param session GCM session
189 process_gcm_crypto_op(struct aesni_gcm_qp *qp, struct rte_crypto_op *op,
190 struct aesni_gcm_session *session)
194 struct rte_crypto_sym_op *sym_op = op->sym;
195 struct rte_mbuf *m_src = sym_op->m_src;
196 uint32_t offset, data_offset, data_length;
197 uint32_t part_len, total_len, data_len;
200 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION ||
201 session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
202 offset = sym_op->aead.data.offset;
203 data_offset = offset;
204 data_length = sym_op->aead.data.length;
206 offset = sym_op->auth.data.offset;
207 data_offset = offset;
208 data_length = sym_op->auth.data.length;
211 RTE_ASSERT(m_src != NULL);
213 while (offset >= m_src->data_len && data_length != 0) {
214 offset -= m_src->data_len;
217 RTE_ASSERT(m_src != NULL);
220 data_len = m_src->data_len - offset;
221 part_len = (data_len < data_length) ? data_len :
224 /* Destination buffer is required when segmented source buffer */
225 RTE_ASSERT((part_len == data_length) ||
226 ((part_len != data_length) &&
227 (sym_op->m_dst != NULL)));
228 /* Segmented destination buffer is not supported */
229 RTE_ASSERT((sym_op->m_dst == NULL) ||
230 ((sym_op->m_dst != NULL) &&
231 rte_pktmbuf_is_contiguous(sym_op->m_dst)));
234 dst = sym_op->m_dst ?
235 rte_pktmbuf_mtod_offset(sym_op->m_dst, uint8_t *,
237 rte_pktmbuf_mtod_offset(sym_op->m_src, uint8_t *,
240 src = rte_pktmbuf_mtod_offset(m_src, uint8_t *, offset);
242 iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
245 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION) {
246 qp->ops[session->key].init(&session->gdata_key,
249 sym_op->aead.aad.data,
250 (uint64_t)session->aad_length);
252 qp->ops[session->key].update_enc(&session->gdata_key,
253 &qp->gdata_ctx, dst, src,
255 total_len = data_length - part_len;
261 RTE_ASSERT(m_src != NULL);
263 src = rte_pktmbuf_mtod(m_src, uint8_t *);
264 part_len = (m_src->data_len < total_len) ?
265 m_src->data_len : total_len;
267 qp->ops[session->key].update_enc(&session->gdata_key,
268 &qp->gdata_ctx, dst, src,
270 total_len -= part_len;
273 if (session->req_digest_length != session->gen_digest_length)
274 tag = qp->temp_digest;
276 tag = sym_op->aead.digest.data;
278 qp->ops[session->key].finalize(&session->gdata_key,
281 session->gen_digest_length);
282 } else if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
283 qp->ops[session->key].init(&session->gdata_key,
286 sym_op->aead.aad.data,
287 (uint64_t)session->aad_length);
289 qp->ops[session->key].update_dec(&session->gdata_key,
290 &qp->gdata_ctx, dst, src,
292 total_len = data_length - part_len;
298 RTE_ASSERT(m_src != NULL);
300 src = rte_pktmbuf_mtod(m_src, uint8_t *);
301 part_len = (m_src->data_len < total_len) ?
302 m_src->data_len : total_len;
304 qp->ops[session->key].update_dec(&session->gdata_key,
308 total_len -= part_len;
311 tag = qp->temp_digest;
312 qp->ops[session->key].finalize(&session->gdata_key,
315 session->gen_digest_length);
316 } else if (session->op == AESNI_GMAC_OP_GENERATE) {
317 qp->ops[session->key].init(&session->gdata_key,
321 (uint64_t)data_length);
322 if (session->req_digest_length != session->gen_digest_length)
323 tag = qp->temp_digest;
325 tag = sym_op->auth.digest.data;
326 qp->ops[session->key].finalize(&session->gdata_key,
329 session->gen_digest_length);
330 } else { /* AESNI_GMAC_OP_VERIFY */
331 qp->ops[session->key].init(&session->gdata_key,
335 (uint64_t)data_length);
338 * Generate always 16 bytes and later compare only
341 tag = qp->temp_digest;
342 qp->ops[session->key].finalize(&session->gdata_key,
345 session->gen_digest_length);
352 * Process a completed job and return rte_mbuf which job processed
354 * @param job JOB_AES_HMAC job to process
357 * - Returns processed mbuf which is trimmed of output digest used in
358 * verification of supplied digest in the case of a HASH_CIPHER operation
359 * - Returns NULL on invalid job
362 post_process_gcm_crypto_op(struct aesni_gcm_qp *qp,
363 struct rte_crypto_op *op,
364 struct aesni_gcm_session *session)
366 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
368 /* Verify digest if required */
369 if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION ||
370 session->op == AESNI_GMAC_OP_VERIFY) {
373 uint8_t *tag = qp->temp_digest;
375 if (session->op == AESNI_GMAC_OP_VERIFY)
376 digest = op->sym->auth.digest.data;
378 digest = op->sym->aead.digest.data;
380 #ifdef RTE_LIBRTE_PMD_AESNI_GCM_DEBUG
381 rte_hexdump(stdout, "auth tag (orig):",
382 digest, session->req_digest_length);
383 rte_hexdump(stdout, "auth tag (calc):",
384 tag, session->req_digest_length);
387 if (memcmp(tag, digest, session->req_digest_length) != 0)
388 op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
390 if (session->req_digest_length != session->gen_digest_length) {
391 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION)
392 memcpy(op->sym->aead.digest.data, qp->temp_digest,
393 session->req_digest_length);
395 memcpy(op->sym->auth.digest.data, qp->temp_digest,
396 session->req_digest_length);
402 * Process a completed GCM request
404 * @param qp Queue Pair to process
405 * @param op Crypto operation
406 * @param job JOB_AES_HMAC job
409 * - Number of processed jobs
412 handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
413 struct rte_crypto_op *op,
414 struct aesni_gcm_session *sess)
416 post_process_gcm_crypto_op(qp, op, sess);
418 /* Free session if a session-less crypto op */
419 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
420 memset(sess, 0, sizeof(struct aesni_gcm_session));
421 memset(op->sym->session, 0,
422 rte_cryptodev_sym_get_existing_header_session_size(
424 rte_mempool_put(qp->sess_mp_priv, sess);
425 rte_mempool_put(qp->sess_mp, op->sym->session);
426 op->sym->session = NULL;
431 aesni_gcm_pmd_dequeue_burst(void *queue_pair,
432 struct rte_crypto_op **ops, uint16_t nb_ops)
434 struct aesni_gcm_session *sess;
435 struct aesni_gcm_qp *qp = queue_pair;
438 unsigned int i, nb_dequeued;
440 nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
441 (void **)ops, nb_ops, NULL);
443 for (i = 0; i < nb_dequeued; i++) {
445 sess = aesni_gcm_get_session(qp, ops[i]);
446 if (unlikely(sess == NULL)) {
447 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
448 qp->qp_stats.dequeue_err_count++;
452 retval = process_gcm_crypto_op(qp, ops[i], sess);
454 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
455 qp->qp_stats.dequeue_err_count++;
459 handle_completed_gcm_crypto_op(qp, ops[i], sess);
462 qp->qp_stats.dequeued_count += i;
468 aesni_gcm_pmd_enqueue_burst(void *queue_pair,
469 struct rte_crypto_op **ops, uint16_t nb_ops)
471 struct aesni_gcm_qp *qp = queue_pair;
473 unsigned int nb_enqueued;
475 nb_enqueued = rte_ring_enqueue_burst(qp->processed_pkts,
476 (void **)ops, nb_ops, NULL);
477 qp->qp_stats.enqueued_count += nb_enqueued;
482 static int aesni_gcm_remove(struct rte_vdev_device *vdev);
485 aesni_gcm_create(const char *name,
486 struct rte_vdev_device *vdev,
487 struct rte_cryptodev_pmd_init_params *init_params)
489 struct rte_cryptodev *dev;
490 struct aesni_gcm_private *internals;
491 enum aesni_gcm_vector_mode vector_mode;
493 /* Check CPU for support for AES instruction set */
494 if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
495 AESNI_GCM_LOG(ERR, "AES instructions not supported by CPU");
498 dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
500 AESNI_GCM_LOG(ERR, "driver %s: create failed",
505 /* Check CPU for supported vector instruction set */
506 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
507 vector_mode = RTE_AESNI_GCM_AVX2;
508 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
509 vector_mode = RTE_AESNI_GCM_AVX;
511 vector_mode = RTE_AESNI_GCM_SSE;
513 dev->driver_id = cryptodev_driver_id;
514 dev->dev_ops = rte_aesni_gcm_pmd_ops;
516 /* register rx/tx burst functions for data path */
517 dev->dequeue_burst = aesni_gcm_pmd_dequeue_burst;
518 dev->enqueue_burst = aesni_gcm_pmd_enqueue_burst;
520 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
521 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
522 RTE_CRYPTODEV_FF_CPU_AESNI |
523 RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
524 RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT;
526 switch (vector_mode) {
527 case RTE_AESNI_GCM_SSE:
528 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
530 case RTE_AESNI_GCM_AVX:
531 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
533 case RTE_AESNI_GCM_AVX2:
534 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
540 internals = dev->data->dev_private;
542 internals->vector_mode = vector_mode;
544 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
546 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
547 AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
548 imb_get_version_str());
550 AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
557 aesni_gcm_probe(struct rte_vdev_device *vdev)
559 struct rte_cryptodev_pmd_init_params init_params = {
561 sizeof(struct aesni_gcm_private),
563 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
566 const char *input_args;
568 name = rte_vdev_device_name(vdev);
571 input_args = rte_vdev_device_args(vdev);
572 rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
574 return aesni_gcm_create(name, vdev, &init_params);
578 aesni_gcm_remove(struct rte_vdev_device *vdev)
580 struct rte_cryptodev *cryptodev;
583 name = rte_vdev_device_name(vdev);
587 cryptodev = rte_cryptodev_pmd_get_named_dev(name);
588 if (cryptodev == NULL)
591 return rte_cryptodev_pmd_destroy(cryptodev);
594 static struct rte_vdev_driver aesni_gcm_pmd_drv = {
595 .probe = aesni_gcm_probe,
596 .remove = aesni_gcm_remove
599 static struct cryptodev_driver aesni_gcm_crypto_drv;
601 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_GCM_PMD, aesni_gcm_pmd_drv);
602 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_GCM_PMD, cryptodev_aesni_gcm_pmd);
603 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_GCM_PMD,
604 "max_nb_queue_pairs=<int> "
606 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_gcm_crypto_drv, aesni_gcm_pmd_drv.driver,
607 cryptodev_driver_id);
610 RTE_INIT(aesni_gcm_init_log)
612 aesni_gcm_logtype_driver = rte_log_register("pmd.crypto.aesni_gcm");