4 * Copyright(c) 2016-2017 Intel Corporation. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in
14 * the documentation and/or other materials provided with the
16 * * Neither the name of Intel Corporation nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 #include <rte_common.h>
34 #include <rte_config.h>
35 #include <rte_hexdump.h>
36 #include <rte_cryptodev.h>
37 #include <rte_cryptodev_pmd.h>
38 #include <rte_cryptodev_vdev.h>
40 #include <rte_malloc.h>
41 #include <rte_cpuflags.h>
42 #include <rte_byteorder.h>
44 #include "aesni_gcm_pmd_private.h"
47 /** Parse crypto xform chain and set private session parameters */
49 aesni_gcm_set_session_parameters(const struct aesni_gcm_ops *gcm_ops,
50 struct aesni_gcm_session *sess,
51 const struct rte_crypto_sym_xform *xform)
53 const struct rte_crypto_sym_xform *auth_xform;
54 const struct rte_crypto_sym_xform *aead_xform;
55 uint16_t digest_length;
60 if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
62 if (auth_xform->auth.algo != RTE_CRYPTO_AUTH_AES_GMAC) {
63 GCM_LOG_ERR("Only AES GMAC is supported as an "
64 "authentication only algorithm");
67 /* Set IV parameters */
68 sess->iv.offset = auth_xform->auth.iv.offset;
69 sess->iv.length = auth_xform->auth.iv.length;
71 /* Select Crypto operation */
72 if (auth_xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
73 sess->op = AESNI_GMAC_OP_GENERATE;
75 sess->op = AESNI_GMAC_OP_VERIFY;
77 key_length = auth_xform->auth.key.length;
78 key = auth_xform->auth.key.data;
79 digest_length = auth_xform->auth.digest_length;
82 } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
85 if (aead_xform->aead.algo != RTE_CRYPTO_AEAD_AES_GCM) {
86 GCM_LOG_ERR("The only combined operation "
87 "supported is AES GCM");
91 /* Set IV parameters */
92 sess->iv.offset = aead_xform->aead.iv.offset;
93 sess->iv.length = aead_xform->aead.iv.length;
95 /* Select Crypto operation */
96 if (aead_xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
97 sess->op = AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION;
99 sess->op = AESNI_GCM_OP_AUTHENTICATED_DECRYPTION;
101 key_length = aead_xform->aead.key.length;
102 key = aead_xform->aead.key.data;
104 sess->aad_length = aead_xform->aead.add_auth_data_length;
105 digest_length = aead_xform->aead.digest_length;
107 GCM_LOG_ERR("Wrong xform type, has to be AEAD or authentication");
113 if (sess->iv.length != 16 && sess->iv.length != 12 &&
114 sess->iv.length != 0) {
115 GCM_LOG_ERR("Wrong IV length");
119 /* Check key length and calculate GCM pre-compute. */
120 switch (key_length) {
122 sess->key = AESNI_GCM_KEY_128;
125 sess->key = AESNI_GCM_KEY_192;
128 sess->key = AESNI_GCM_KEY_256;
131 GCM_LOG_ERR("Unsupported key length");
135 gcm_ops[sess->key].precomp(key, &sess->gdata_key);
138 if (digest_length != 16 &&
139 digest_length != 12 &&
140 digest_length != 8) {
141 GCM_LOG_ERR("digest");
144 sess->digest_length = digest_length;
149 /** Get gcm session */
150 static struct aesni_gcm_session *
151 aesni_gcm_get_session(struct aesni_gcm_qp *qp, struct rte_crypto_op *op)
153 struct aesni_gcm_session *sess = NULL;
154 struct rte_crypto_sym_op *sym_op = op->sym;
156 if (op->sess_type == RTE_CRYPTO_OP_WITH_SESSION) {
157 if (unlikely(sym_op->session->dev_type
158 != RTE_CRYPTODEV_AESNI_GCM_PMD))
161 sess = (struct aesni_gcm_session *)sym_op->session->_private;
165 if (rte_mempool_get(qp->sess_mp, &_sess))
168 sess = (struct aesni_gcm_session *)
169 ((struct rte_cryptodev_sym_session *)_sess)->_private;
171 if (unlikely(aesni_gcm_set_session_parameters(qp->ops, sess,
172 sym_op->xform) != 0)) {
173 rte_mempool_put(qp->sess_mp, _sess);
181 * Process a crypto operation, calling
182 * the GCM API from the multi buffer library.
184 * @param qp queue pair
185 * @param op symmetric crypto operation
186 * @param session GCM session
192 process_gcm_crypto_op(struct aesni_gcm_qp *qp, struct rte_crypto_op *op,
193 struct aesni_gcm_session *session)
197 struct rte_crypto_sym_op *sym_op = op->sym;
198 struct rte_mbuf *m_src = sym_op->m_src;
199 uint32_t offset, data_offset, data_length;
200 uint32_t part_len, total_len, data_len;
202 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION ||
203 session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
204 offset = sym_op->aead.data.offset;
205 data_offset = offset;
206 data_length = sym_op->aead.data.length;
208 offset = sym_op->auth.data.offset;
209 data_offset = offset;
210 data_length = sym_op->auth.data.length;
213 RTE_ASSERT(m_src != NULL);
215 while (offset >= m_src->data_len) {
216 offset -= m_src->data_len;
219 RTE_ASSERT(m_src != NULL);
222 data_len = m_src->data_len - offset;
223 part_len = (data_len < data_length) ? data_len :
226 /* Destination buffer is required when segmented source buffer */
227 RTE_ASSERT((part_len == data_length) ||
228 ((part_len != data_length) &&
229 (sym_op->m_dst != NULL)));
230 /* Segmented destination buffer is not supported */
231 RTE_ASSERT((sym_op->m_dst == NULL) ||
232 ((sym_op->m_dst != NULL) &&
233 rte_pktmbuf_is_contiguous(sym_op->m_dst)));
236 dst = sym_op->m_dst ?
237 rte_pktmbuf_mtod_offset(sym_op->m_dst, uint8_t *,
239 rte_pktmbuf_mtod_offset(sym_op->m_src, uint8_t *,
242 src = rte_pktmbuf_mtod_offset(m_src, uint8_t *, offset);
244 iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
247 * GCM working in 12B IV mode => 16B pre-counter block we need
248 * to set BE LSB to 1, driver expects that 16B is allocated
250 if (session->iv.length == 12) {
251 uint32_t *iv_padd = (uint32_t *)&(iv_ptr[12]);
252 *iv_padd = rte_bswap32(1);
255 if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION) {
257 qp->ops[session->key].init(&session->gdata_key,
260 sym_op->aead.aad.data,
261 (uint64_t)session->aad_length);
263 qp->ops[session->key].update_enc(&session->gdata_key,
264 &qp->gdata_ctx, dst, src,
266 total_len = data_length - part_len;
272 RTE_ASSERT(m_src != NULL);
274 src = rte_pktmbuf_mtod(m_src, uint8_t *);
275 part_len = (m_src->data_len < total_len) ?
276 m_src->data_len : total_len;
278 qp->ops[session->key].update_enc(&session->gdata_key,
279 &qp->gdata_ctx, dst, src,
281 total_len -= part_len;
284 qp->ops[session->key].finalize(&session->gdata_key,
286 sym_op->aead.digest.data,
287 (uint64_t)session->digest_length);
288 } else if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
289 uint8_t *auth_tag = (uint8_t *)rte_pktmbuf_append(sym_op->m_dst ?
290 sym_op->m_dst : sym_op->m_src,
291 session->digest_length);
294 GCM_LOG_ERR("auth_tag");
298 qp->ops[session->key].init(&session->gdata_key,
301 sym_op->aead.aad.data,
302 (uint64_t)session->aad_length);
304 qp->ops[session->key].update_dec(&session->gdata_key,
305 &qp->gdata_ctx, dst, src,
307 total_len = data_length - part_len;
313 RTE_ASSERT(m_src != NULL);
315 src = rte_pktmbuf_mtod(m_src, uint8_t *);
316 part_len = (m_src->data_len < total_len) ?
317 m_src->data_len : total_len;
319 qp->ops[session->key].update_dec(&session->gdata_key,
323 total_len -= part_len;
326 qp->ops[session->key].finalize(&session->gdata_key,
329 (uint64_t)session->digest_length);
330 } else if (session->op == AESNI_GMAC_OP_GENERATE) {
331 qp->ops[session->key].init(&session->gdata_key,
335 (uint64_t)data_length);
336 qp->ops[session->key].finalize(&session->gdata_key,
338 sym_op->auth.digest.data,
339 (uint64_t)session->digest_length);
340 } else { /* AESNI_GMAC_OP_VERIFY */
341 uint8_t *auth_tag = (uint8_t *)rte_pktmbuf_append(sym_op->m_dst ?
342 sym_op->m_dst : sym_op->m_src,
343 session->digest_length);
346 GCM_LOG_ERR("auth_tag");
350 qp->ops[session->key].init(&session->gdata_key,
354 (uint64_t)data_length);
356 qp->ops[session->key].finalize(&session->gdata_key,
359 (uint64_t)session->digest_length);
366 * Process a completed job and return rte_mbuf which job processed
368 * @param job JOB_AES_HMAC job to process
371 * - Returns processed mbuf which is trimmed of output digest used in
372 * verification of supplied digest in the case of a HASH_CIPHER operation
373 * - Returns NULL on invalid job
376 post_process_gcm_crypto_op(struct rte_crypto_op *op)
378 struct rte_mbuf *m = op->sym->m_dst ? op->sym->m_dst : op->sym->m_src;
380 struct aesni_gcm_session *session =
381 (struct aesni_gcm_session *)op->sym->session->_private;
383 op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
385 /* Verify digest if required */
386 if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION ||
387 session->op == AESNI_GMAC_OP_VERIFY) {
390 uint8_t *tag = rte_pktmbuf_mtod_offset(m, uint8_t *,
391 m->data_len - session->digest_length);
393 if (session->op == AESNI_GMAC_OP_VERIFY)
394 digest = op->sym->auth.digest.data;
396 digest = op->sym->aead.digest.data;
398 #ifdef RTE_LIBRTE_PMD_AESNI_GCM_DEBUG
399 rte_hexdump(stdout, "auth tag (orig):",
400 digest, session->digest_length);
401 rte_hexdump(stdout, "auth tag (calc):",
402 tag, session->digest_length);
405 if (memcmp(tag, digest, session->digest_length) != 0)
406 op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
408 /* trim area used for digest from mbuf */
409 rte_pktmbuf_trim(m, session->digest_length);
414 * Process a completed GCM request
416 * @param qp Queue Pair to process
417 * @param job JOB_AES_HMAC job
420 * - Number of processed jobs
423 handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
424 struct rte_crypto_op *op)
426 post_process_gcm_crypto_op(op);
428 /* Free session if a session-less crypto op */
429 if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
430 rte_mempool_put(qp->sess_mp, op->sym->session);
431 op->sym->session = NULL;
436 aesni_gcm_pmd_dequeue_burst(void *queue_pair,
437 struct rte_crypto_op **ops, uint16_t nb_ops)
439 struct aesni_gcm_session *sess;
440 struct aesni_gcm_qp *qp = queue_pair;
443 unsigned int i, nb_dequeued;
445 nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
446 (void **)ops, nb_ops, NULL);
448 for (i = 0; i < nb_dequeued; i++) {
450 sess = aesni_gcm_get_session(qp, ops[i]);
451 if (unlikely(sess == NULL)) {
452 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
453 qp->qp_stats.dequeue_err_count++;
457 retval = process_gcm_crypto_op(qp, ops[i], sess);
459 ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
460 qp->qp_stats.dequeue_err_count++;
464 handle_completed_gcm_crypto_op(qp, ops[i]);
467 qp->qp_stats.dequeued_count += i;
473 aesni_gcm_pmd_enqueue_burst(void *queue_pair,
474 struct rte_crypto_op **ops, uint16_t nb_ops)
476 struct aesni_gcm_qp *qp = queue_pair;
478 unsigned int nb_enqueued;
480 nb_enqueued = rte_ring_enqueue_burst(qp->processed_pkts,
481 (void **)ops, nb_ops, NULL);
482 qp->qp_stats.enqueued_count += nb_enqueued;
487 static int aesni_gcm_remove(struct rte_vdev_device *vdev);
490 aesni_gcm_create(const char *name,
491 struct rte_vdev_device *vdev,
492 struct rte_crypto_vdev_init_params *init_params)
494 struct rte_cryptodev *dev;
495 struct aesni_gcm_private *internals;
496 enum aesni_gcm_vector_mode vector_mode;
498 if (init_params->name[0] == '\0')
499 snprintf(init_params->name, sizeof(init_params->name),
502 /* Check CPU for support for AES instruction set */
503 if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
504 GCM_LOG_ERR("AES instructions not supported by CPU");
508 /* Check CPU for supported vector instruction set */
509 if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
510 vector_mode = RTE_AESNI_GCM_AVX2;
511 else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
512 vector_mode = RTE_AESNI_GCM_AVX;
514 vector_mode = RTE_AESNI_GCM_SSE;
516 dev = rte_cryptodev_vdev_pmd_init(init_params->name,
517 sizeof(struct aesni_gcm_private), init_params->socket_id,
520 GCM_LOG_ERR("failed to create cryptodev vdev");
524 dev->dev_type = RTE_CRYPTODEV_AESNI_GCM_PMD;
525 dev->dev_ops = rte_aesni_gcm_pmd_ops;
527 /* register rx/tx burst functions for data path */
528 dev->dequeue_burst = aesni_gcm_pmd_dequeue_burst;
529 dev->enqueue_burst = aesni_gcm_pmd_enqueue_burst;
531 dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
532 RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
533 RTE_CRYPTODEV_FF_CPU_AESNI |
534 RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER;
536 switch (vector_mode) {
537 case RTE_AESNI_GCM_SSE:
538 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
540 case RTE_AESNI_GCM_AVX:
541 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
543 case RTE_AESNI_GCM_AVX2:
544 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
550 internals = dev->data->dev_private;
552 internals->vector_mode = vector_mode;
554 internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
555 internals->max_nb_sessions = init_params->max_nb_sessions;
560 GCM_LOG_ERR("driver %s: create failed", init_params->name);
562 aesni_gcm_remove(vdev);
567 aesni_gcm_probe(struct rte_vdev_device *vdev)
569 struct rte_crypto_vdev_init_params init_params = {
570 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_QUEUE_PAIRS,
571 RTE_CRYPTODEV_VDEV_DEFAULT_MAX_NB_SESSIONS,
576 const char *input_args;
578 name = rte_vdev_device_name(vdev);
581 input_args = rte_vdev_device_args(vdev);
582 rte_cryptodev_vdev_parse_init_params(&init_params, input_args);
584 RTE_LOG(INFO, PMD, "Initialising %s on NUMA node %d\n", name,
585 init_params.socket_id);
586 if (init_params.name[0] != '\0')
587 RTE_LOG(INFO, PMD, " User defined name = %s\n",
589 RTE_LOG(INFO, PMD, " Max number of queue pairs = %d\n",
590 init_params.max_nb_queue_pairs);
591 RTE_LOG(INFO, PMD, " Max number of sessions = %d\n",
592 init_params.max_nb_sessions);
594 return aesni_gcm_create(name, vdev, &init_params);
598 aesni_gcm_remove(struct rte_vdev_device *vdev)
602 name = rte_vdev_device_name(vdev);
606 GCM_LOG_INFO("Closing AESNI crypto device %s on numa socket %u\n",
607 name, rte_socket_id());
612 static struct rte_vdev_driver aesni_gcm_pmd_drv = {
613 .probe = aesni_gcm_probe,
614 .remove = aesni_gcm_remove
617 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_GCM_PMD, aesni_gcm_pmd_drv);
618 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_GCM_PMD, cryptodev_aesni_gcm_pmd);
619 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_GCM_PMD,
620 "max_nb_queue_pairs=<int> "
621 "max_nb_sessions=<int> "