New upstream version 18.11-rc1
[deb_dpdk.git] / drivers / crypto / aesni_gcm / aesni_gcm_pmd.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2016-2017 Intel Corporation
3  */
4
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>
13
14 #include "aesni_gcm_pmd_private.h"
15
16 static uint8_t cryptodev_driver_id;
17
18 /** Parse crypto xform chain and set private session parameters */
19 int
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)
23 {
24         const struct rte_crypto_sym_xform *auth_xform;
25         const struct rte_crypto_sym_xform *aead_xform;
26         uint8_t key_length;
27         uint8_t *key;
28
29         /* AES-GMAC */
30         if (xform->type == RTE_CRYPTO_SYM_XFORM_AUTH) {
31                 auth_xform = xform;
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");
35                         return -ENOTSUP;
36                 }
37                 /* Set IV parameters */
38                 sess->iv.offset = auth_xform->auth.iv.offset;
39                 sess->iv.length = auth_xform->auth.iv.length;
40
41                 /* Select Crypto operation */
42                 if (auth_xform->auth.op == RTE_CRYPTO_AUTH_OP_GENERATE)
43                         sess->op = AESNI_GMAC_OP_GENERATE;
44                 else
45                         sess->op = AESNI_GMAC_OP_VERIFY;
46
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;
50
51         /* AES-GCM */
52         } else if (xform->type == RTE_CRYPTO_SYM_XFORM_AEAD) {
53                 aead_xform = xform;
54
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");
58                         return -ENOTSUP;
59                 }
60
61                 /* Set IV parameters */
62                 sess->iv.offset = aead_xform->aead.iv.offset;
63                 sess->iv.length = aead_xform->aead.iv.length;
64
65                 /* Select Crypto operation */
66                 if (aead_xform->aead.op == RTE_CRYPTO_AEAD_OP_ENCRYPT)
67                         sess->op = AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION;
68                 else
69                         sess->op = AESNI_GCM_OP_AUTHENTICATED_DECRYPTION;
70
71                 key_length = aead_xform->aead.key.length;
72                 key = aead_xform->aead.key.data;
73
74                 sess->aad_length = aead_xform->aead.aad_length;
75                 sess->req_digest_length = aead_xform->aead.digest_length;
76         } else {
77                 AESNI_GCM_LOG(ERR, "Wrong xform type, has to be AEAD or authentication");
78                 return -ENOTSUP;
79         }
80
81
82         /* IV check */
83         if (sess->iv.length != 16 && sess->iv.length != 12 &&
84                         sess->iv.length != 0) {
85                 AESNI_GCM_LOG(ERR, "Wrong IV length");
86                 return -EINVAL;
87         }
88
89         /* Check key length and calculate GCM pre-compute. */
90         switch (key_length) {
91         case 16:
92                 sess->key = AESNI_GCM_KEY_128;
93                 break;
94         case 24:
95                 sess->key = AESNI_GCM_KEY_192;
96                 break;
97         case 32:
98                 sess->key = AESNI_GCM_KEY_256;
99                 break;
100         default:
101                 AESNI_GCM_LOG(ERR, "Invalid key length");
102                 return -EINVAL;
103         }
104
105         gcm_ops[sess->key].precomp(key, &sess->gdata_key);
106
107         /* Digest check */
108         if (sess->req_digest_length > 16) {
109                 AESNI_GCM_LOG(ERR, "Invalid digest length");
110                 return -EINVAL;
111         }
112         /*
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,
115          * in version 0.49.
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.
119          */
120 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
121         if (sess->req_digest_length < 4)
122 #else
123         if (sess->req_digest_length != 16 &&
124                         sess->req_digest_length != 12 &&
125                         sess->req_digest_length != 8)
126 #endif
127                 sess->gen_digest_length = 16;
128         else
129                 sess->gen_digest_length = sess->req_digest_length;
130
131         return 0;
132 }
133
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)
137 {
138         struct aesni_gcm_session *sess = NULL;
139         struct rte_crypto_sym_op *sym_op = op->sym;
140
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(
145                                         sym_op->session,
146                                         cryptodev_driver_id);
147         } else  {
148                 void *_sess;
149                 void *_sess_private_data = NULL;
150
151                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess))
152                         return NULL;
153
154                 if (rte_mempool_get(qp->sess_mp, (void **)&_sess_private_data))
155                         return NULL;
156
157                 sess = (struct aesni_gcm_session *)_sess_private_data;
158
159                 if (unlikely(aesni_gcm_set_session_parameters(qp->ops,
160                                 sess, sym_op->xform) != 0)) {
161                         rte_mempool_put(qp->sess_mp, _sess);
162                         rte_mempool_put(qp->sess_mp, _sess_private_data);
163                         sess = NULL;
164                 }
165                 sym_op->session = (struct rte_cryptodev_sym_session *)_sess;
166                 set_sym_session_private_data(sym_op->session,
167                                 cryptodev_driver_id, _sess_private_data);
168         }
169
170         if (unlikely(sess == NULL))
171                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
172
173         return sess;
174 }
175
176 /**
177  * Process a crypto operation, calling
178  * the GCM API from the multi buffer library.
179  *
180  * @param       qp              queue pair
181  * @param       op              symmetric crypto operation
182  * @param       session         GCM session
183  *
184  * @return
185  *
186  */
187 static int
188 process_gcm_crypto_op(struct aesni_gcm_qp *qp, struct rte_crypto_op *op,
189                 struct aesni_gcm_session *session)
190 {
191         uint8_t *src, *dst;
192         uint8_t *iv_ptr;
193         struct rte_crypto_sym_op *sym_op = op->sym;
194         struct rte_mbuf *m_src = sym_op->m_src;
195         uint32_t offset, data_offset, data_length;
196         uint32_t part_len, total_len, data_len;
197         uint8_t *tag;
198
199         if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION ||
200                         session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
201                 offset = sym_op->aead.data.offset;
202                 data_offset = offset;
203                 data_length = sym_op->aead.data.length;
204         } else {
205                 offset = sym_op->auth.data.offset;
206                 data_offset = offset;
207                 data_length = sym_op->auth.data.length;
208         }
209
210         RTE_ASSERT(m_src != NULL);
211
212         while (offset >= m_src->data_len && data_length != 0) {
213                 offset -= m_src->data_len;
214                 m_src = m_src->next;
215
216                 RTE_ASSERT(m_src != NULL);
217         }
218
219         data_len = m_src->data_len - offset;
220         part_len = (data_len < data_length) ? data_len :
221                         data_length;
222
223         /* Destination buffer is required when segmented source buffer */
224         RTE_ASSERT((part_len == data_length) ||
225                         ((part_len != data_length) &&
226                                         (sym_op->m_dst != NULL)));
227         /* Segmented destination buffer is not supported */
228         RTE_ASSERT((sym_op->m_dst == NULL) ||
229                         ((sym_op->m_dst != NULL) &&
230                                         rte_pktmbuf_is_contiguous(sym_op->m_dst)));
231
232
233         dst = sym_op->m_dst ?
234                         rte_pktmbuf_mtod_offset(sym_op->m_dst, uint8_t *,
235                                         data_offset) :
236                         rte_pktmbuf_mtod_offset(sym_op->m_src, uint8_t *,
237                                         data_offset);
238
239         src = rte_pktmbuf_mtod_offset(m_src, uint8_t *, offset);
240
241         iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
242                                 session->iv.offset);
243
244         if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION) {
245                 qp->ops[session->key].init(&session->gdata_key,
246                                 &qp->gdata_ctx,
247                                 iv_ptr,
248                                 sym_op->aead.aad.data,
249                                 (uint64_t)session->aad_length);
250
251                 qp->ops[session->key].update_enc(&session->gdata_key,
252                                 &qp->gdata_ctx, dst, src,
253                                 (uint64_t)part_len);
254                 total_len = data_length - part_len;
255
256                 while (total_len) {
257                         dst += part_len;
258                         m_src = m_src->next;
259
260                         RTE_ASSERT(m_src != NULL);
261
262                         src = rte_pktmbuf_mtod(m_src, uint8_t *);
263                         part_len = (m_src->data_len < total_len) ?
264                                         m_src->data_len : total_len;
265
266                         qp->ops[session->key].update_enc(&session->gdata_key,
267                                         &qp->gdata_ctx, dst, src,
268                                         (uint64_t)part_len);
269                         total_len -= part_len;
270                 }
271
272                 if (session->req_digest_length != session->gen_digest_length)
273                         tag = qp->temp_digest;
274                 else
275                         tag = sym_op->aead.digest.data;
276
277                 qp->ops[session->key].finalize(&session->gdata_key,
278                                 &qp->gdata_ctx,
279                                 tag,
280                                 session->gen_digest_length);
281         } else if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
282                 qp->ops[session->key].init(&session->gdata_key,
283                                 &qp->gdata_ctx,
284                                 iv_ptr,
285                                 sym_op->aead.aad.data,
286                                 (uint64_t)session->aad_length);
287
288                 qp->ops[session->key].update_dec(&session->gdata_key,
289                                 &qp->gdata_ctx, dst, src,
290                                 (uint64_t)part_len);
291                 total_len = data_length - part_len;
292
293                 while (total_len) {
294                         dst += part_len;
295                         m_src = m_src->next;
296
297                         RTE_ASSERT(m_src != NULL);
298
299                         src = rte_pktmbuf_mtod(m_src, uint8_t *);
300                         part_len = (m_src->data_len < total_len) ?
301                                         m_src->data_len : total_len;
302
303                         qp->ops[session->key].update_dec(&session->gdata_key,
304                                         &qp->gdata_ctx,
305                                         dst, src,
306                                         (uint64_t)part_len);
307                         total_len -= part_len;
308                 }
309
310                 tag = qp->temp_digest;
311                 qp->ops[session->key].finalize(&session->gdata_key,
312                                 &qp->gdata_ctx,
313                                 tag,
314                                 session->gen_digest_length);
315         } else if (session->op == AESNI_GMAC_OP_GENERATE) {
316                 qp->ops[session->key].init(&session->gdata_key,
317                                 &qp->gdata_ctx,
318                                 iv_ptr,
319                                 src,
320                                 (uint64_t)data_length);
321                 if (session->req_digest_length != session->gen_digest_length)
322                         tag = qp->temp_digest;
323                 else
324                         tag = sym_op->auth.digest.data;
325                 qp->ops[session->key].finalize(&session->gdata_key,
326                                 &qp->gdata_ctx,
327                                 tag,
328                                 session->gen_digest_length);
329         } else { /* AESNI_GMAC_OP_VERIFY */
330                 qp->ops[session->key].init(&session->gdata_key,
331                                 &qp->gdata_ctx,
332                                 iv_ptr,
333                                 src,
334                                 (uint64_t)data_length);
335
336                 /*
337                  * Generate always 16 bytes and later compare only
338                  * the bytes passed.
339                  */
340                 tag = qp->temp_digest;
341                 qp->ops[session->key].finalize(&session->gdata_key,
342                                 &qp->gdata_ctx,
343                                 tag,
344                                 session->gen_digest_length);
345         }
346
347         return 0;
348 }
349
350 /**
351  * Process a completed job and return rte_mbuf which job processed
352  *
353  * @param job   JOB_AES_HMAC job to process
354  *
355  * @return
356  * - Returns processed mbuf which is trimmed of output digest used in
357  * verification of supplied digest in the case of a HASH_CIPHER operation
358  * - Returns NULL on invalid job
359  */
360 static void
361 post_process_gcm_crypto_op(struct aesni_gcm_qp *qp,
362                 struct rte_crypto_op *op,
363                 struct aesni_gcm_session *session)
364 {
365         op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
366
367         /* Verify digest if required */
368         if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION ||
369                         session->op == AESNI_GMAC_OP_VERIFY) {
370                 uint8_t *digest;
371
372                 uint8_t *tag = qp->temp_digest;
373
374                 if (session->op == AESNI_GMAC_OP_VERIFY)
375                         digest = op->sym->auth.digest.data;
376                 else
377                         digest = op->sym->aead.digest.data;
378
379 #ifdef RTE_LIBRTE_PMD_AESNI_GCM_DEBUG
380                 rte_hexdump(stdout, "auth tag (orig):",
381                                 digest, session->req_digest_length);
382                 rte_hexdump(stdout, "auth tag (calc):",
383                                 tag, session->req_digest_length);
384 #endif
385
386                 if (memcmp(tag, digest, session->req_digest_length) != 0)
387                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
388         } else {
389                 if (session->req_digest_length != session->gen_digest_length) {
390                         if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION)
391                                 memcpy(op->sym->aead.digest.data, qp->temp_digest,
392                                                 session->req_digest_length);
393                         else
394                                 memcpy(op->sym->auth.digest.data, qp->temp_digest,
395                                                 session->req_digest_length);
396                 }
397         }
398 }
399
400 /**
401  * Process a completed GCM request
402  *
403  * @param qp            Queue Pair to process
404  * @param op            Crypto operation
405  * @param job           JOB_AES_HMAC job
406  *
407  * @return
408  * - Number of processed jobs
409  */
410 static void
411 handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
412                 struct rte_crypto_op *op,
413                 struct aesni_gcm_session *sess)
414 {
415         post_process_gcm_crypto_op(qp, op, sess);
416
417         /* Free session if a session-less crypto op */
418         if (op->sess_type == RTE_CRYPTO_OP_SESSIONLESS) {
419                 memset(sess, 0, sizeof(struct aesni_gcm_session));
420                 memset(op->sym->session, 0,
421                                 rte_cryptodev_sym_get_header_session_size());
422                 rte_mempool_put(qp->sess_mp, sess);
423                 rte_mempool_put(qp->sess_mp, op->sym->session);
424                 op->sym->session = NULL;
425         }
426 }
427
428 static uint16_t
429 aesni_gcm_pmd_dequeue_burst(void *queue_pair,
430                 struct rte_crypto_op **ops, uint16_t nb_ops)
431 {
432         struct aesni_gcm_session *sess;
433         struct aesni_gcm_qp *qp = queue_pair;
434
435         int retval = 0;
436         unsigned int i, nb_dequeued;
437
438         nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
439                         (void **)ops, nb_ops, NULL);
440
441         for (i = 0; i < nb_dequeued; i++) {
442
443                 sess = aesni_gcm_get_session(qp, ops[i]);
444                 if (unlikely(sess == NULL)) {
445                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
446                         qp->qp_stats.dequeue_err_count++;
447                         break;
448                 }
449
450                 retval = process_gcm_crypto_op(qp, ops[i], sess);
451                 if (retval < 0) {
452                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
453                         qp->qp_stats.dequeue_err_count++;
454                         break;
455                 }
456
457                 handle_completed_gcm_crypto_op(qp, ops[i], sess);
458         }
459
460         qp->qp_stats.dequeued_count += i;
461
462         return i;
463 }
464
465 static uint16_t
466 aesni_gcm_pmd_enqueue_burst(void *queue_pair,
467                 struct rte_crypto_op **ops, uint16_t nb_ops)
468 {
469         struct aesni_gcm_qp *qp = queue_pair;
470
471         unsigned int nb_enqueued;
472
473         nb_enqueued = rte_ring_enqueue_burst(qp->processed_pkts,
474                         (void **)ops, nb_ops, NULL);
475         qp->qp_stats.enqueued_count += nb_enqueued;
476
477         return nb_enqueued;
478 }
479
480 static int aesni_gcm_remove(struct rte_vdev_device *vdev);
481
482 static int
483 aesni_gcm_create(const char *name,
484                 struct rte_vdev_device *vdev,
485                 struct rte_cryptodev_pmd_init_params *init_params)
486 {
487         struct rte_cryptodev *dev;
488         struct aesni_gcm_private *internals;
489         enum aesni_gcm_vector_mode vector_mode;
490
491         /* Check CPU for support for AES instruction set */
492         if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
493                 AESNI_GCM_LOG(ERR, "AES instructions not supported by CPU");
494                 return -EFAULT;
495         }
496         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
497         if (dev == NULL) {
498                 AESNI_GCM_LOG(ERR, "driver %s: create failed",
499                         init_params->name);
500                 return -ENODEV;
501         }
502
503         /* Check CPU for supported vector instruction set */
504         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
505                 vector_mode = RTE_AESNI_GCM_AVX2;
506         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
507                 vector_mode = RTE_AESNI_GCM_AVX;
508         else
509                 vector_mode = RTE_AESNI_GCM_SSE;
510
511         dev->driver_id = cryptodev_driver_id;
512         dev->dev_ops = rte_aesni_gcm_pmd_ops;
513
514         /* register rx/tx burst functions for data path */
515         dev->dequeue_burst = aesni_gcm_pmd_dequeue_burst;
516         dev->enqueue_burst = aesni_gcm_pmd_enqueue_burst;
517
518         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
519                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
520                         RTE_CRYPTODEV_FF_CPU_AESNI |
521                         RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
522                         RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT;
523
524         switch (vector_mode) {
525         case RTE_AESNI_GCM_SSE:
526                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
527                 break;
528         case RTE_AESNI_GCM_AVX:
529                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
530                 break;
531         case RTE_AESNI_GCM_AVX2:
532                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
533                 break;
534         default:
535                 break;
536         }
537
538         internals = dev->data->dev_private;
539
540         internals->vector_mode = vector_mode;
541
542         internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
543
544 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
545         AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
546                         imb_get_version_str());
547 #else
548         AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
549 #endif
550
551         return 0;
552 }
553
554 static int
555 aesni_gcm_probe(struct rte_vdev_device *vdev)
556 {
557         struct rte_cryptodev_pmd_init_params init_params = {
558                 "",
559                 sizeof(struct aesni_gcm_private),
560                 rte_socket_id(),
561                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
562         };
563         const char *name;
564         const char *input_args;
565
566         name = rte_vdev_device_name(vdev);
567         if (name == NULL)
568                 return -EINVAL;
569         input_args = rte_vdev_device_args(vdev);
570         rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
571
572         return aesni_gcm_create(name, vdev, &init_params);
573 }
574
575 static int
576 aesni_gcm_remove(struct rte_vdev_device *vdev)
577 {
578         struct rte_cryptodev *cryptodev;
579         const char *name;
580
581         name = rte_vdev_device_name(vdev);
582         if (name == NULL)
583                 return -EINVAL;
584
585         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
586         if (cryptodev == NULL)
587                 return -ENODEV;
588
589         return rte_cryptodev_pmd_destroy(cryptodev);
590 }
591
592 static struct rte_vdev_driver aesni_gcm_pmd_drv = {
593         .probe = aesni_gcm_probe,
594         .remove = aesni_gcm_remove
595 };
596
597 static struct cryptodev_driver aesni_gcm_crypto_drv;
598
599 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_GCM_PMD, aesni_gcm_pmd_drv);
600 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_GCM_PMD, cryptodev_aesni_gcm_pmd);
601 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_GCM_PMD,
602         "max_nb_queue_pairs=<int> "
603         "socket_id=<int>");
604 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_gcm_crypto_drv, aesni_gcm_pmd_drv.driver,
605                 cryptodev_driver_id);
606
607
608 RTE_INIT(aesni_gcm_init_log)
609 {
610         aesni_gcm_logtype_driver = rte_log_register("pmd.crypto.aesni_gcm");
611 }