cryptodev: change queue pair configure structure
[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_priv,
155                                 (void **)&_sess_private_data))
156                         return NULL;
157
158                 sess = (struct aesni_gcm_session *)_sess_private_data;
159
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);
164                         sess = NULL;
165                 }
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);
169         }
170
171         if (unlikely(sess == NULL))
172                 op->status = RTE_CRYPTO_OP_STATUS_INVALID_SESSION;
173
174         return sess;
175 }
176
177 /**
178  * Process a crypto operation, calling
179  * the GCM API from the multi buffer library.
180  *
181  * @param       qp              queue pair
182  * @param       op              symmetric crypto operation
183  * @param       session         GCM session
184  *
185  * @return
186  *
187  */
188 static int
189 process_gcm_crypto_op(struct aesni_gcm_qp *qp, struct rte_crypto_op *op,
190                 struct aesni_gcm_session *session)
191 {
192         uint8_t *src, *dst;
193         uint8_t *iv_ptr;
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;
198         uint8_t *tag;
199
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;
205         } else {
206                 offset = sym_op->auth.data.offset;
207                 data_offset = offset;
208                 data_length = sym_op->auth.data.length;
209         }
210
211         RTE_ASSERT(m_src != NULL);
212
213         while (offset >= m_src->data_len && data_length != 0) {
214                 offset -= m_src->data_len;
215                 m_src = m_src->next;
216
217                 RTE_ASSERT(m_src != NULL);
218         }
219
220         data_len = m_src->data_len - offset;
221         part_len = (data_len < data_length) ? data_len :
222                         data_length;
223
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)));
232
233
234         dst = sym_op->m_dst ?
235                         rte_pktmbuf_mtod_offset(sym_op->m_dst, uint8_t *,
236                                         data_offset) :
237                         rte_pktmbuf_mtod_offset(sym_op->m_src, uint8_t *,
238                                         data_offset);
239
240         src = rte_pktmbuf_mtod_offset(m_src, uint8_t *, offset);
241
242         iv_ptr = rte_crypto_op_ctod_offset(op, uint8_t *,
243                                 session->iv.offset);
244
245         if (session->op == AESNI_GCM_OP_AUTHENTICATED_ENCRYPTION) {
246                 qp->ops[session->key].init(&session->gdata_key,
247                                 &qp->gdata_ctx,
248                                 iv_ptr,
249                                 sym_op->aead.aad.data,
250                                 (uint64_t)session->aad_length);
251
252                 qp->ops[session->key].update_enc(&session->gdata_key,
253                                 &qp->gdata_ctx, dst, src,
254                                 (uint64_t)part_len);
255                 total_len = data_length - part_len;
256
257                 while (total_len) {
258                         dst += part_len;
259                         m_src = m_src->next;
260
261                         RTE_ASSERT(m_src != NULL);
262
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;
266
267                         qp->ops[session->key].update_enc(&session->gdata_key,
268                                         &qp->gdata_ctx, dst, src,
269                                         (uint64_t)part_len);
270                         total_len -= part_len;
271                 }
272
273                 if (session->req_digest_length != session->gen_digest_length)
274                         tag = qp->temp_digest;
275                 else
276                         tag = sym_op->aead.digest.data;
277
278                 qp->ops[session->key].finalize(&session->gdata_key,
279                                 &qp->gdata_ctx,
280                                 tag,
281                                 session->gen_digest_length);
282         } else if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION) {
283                 qp->ops[session->key].init(&session->gdata_key,
284                                 &qp->gdata_ctx,
285                                 iv_ptr,
286                                 sym_op->aead.aad.data,
287                                 (uint64_t)session->aad_length);
288
289                 qp->ops[session->key].update_dec(&session->gdata_key,
290                                 &qp->gdata_ctx, dst, src,
291                                 (uint64_t)part_len);
292                 total_len = data_length - part_len;
293
294                 while (total_len) {
295                         dst += part_len;
296                         m_src = m_src->next;
297
298                         RTE_ASSERT(m_src != NULL);
299
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;
303
304                         qp->ops[session->key].update_dec(&session->gdata_key,
305                                         &qp->gdata_ctx,
306                                         dst, src,
307                                         (uint64_t)part_len);
308                         total_len -= part_len;
309                 }
310
311                 tag = qp->temp_digest;
312                 qp->ops[session->key].finalize(&session->gdata_key,
313                                 &qp->gdata_ctx,
314                                 tag,
315                                 session->gen_digest_length);
316         } else if (session->op == AESNI_GMAC_OP_GENERATE) {
317                 qp->ops[session->key].init(&session->gdata_key,
318                                 &qp->gdata_ctx,
319                                 iv_ptr,
320                                 src,
321                                 (uint64_t)data_length);
322                 if (session->req_digest_length != session->gen_digest_length)
323                         tag = qp->temp_digest;
324                 else
325                         tag = sym_op->auth.digest.data;
326                 qp->ops[session->key].finalize(&session->gdata_key,
327                                 &qp->gdata_ctx,
328                                 tag,
329                                 session->gen_digest_length);
330         } else { /* AESNI_GMAC_OP_VERIFY */
331                 qp->ops[session->key].init(&session->gdata_key,
332                                 &qp->gdata_ctx,
333                                 iv_ptr,
334                                 src,
335                                 (uint64_t)data_length);
336
337                 /*
338                  * Generate always 16 bytes and later compare only
339                  * the bytes passed.
340                  */
341                 tag = qp->temp_digest;
342                 qp->ops[session->key].finalize(&session->gdata_key,
343                                 &qp->gdata_ctx,
344                                 tag,
345                                 session->gen_digest_length);
346         }
347
348         return 0;
349 }
350
351 /**
352  * Process a completed job and return rte_mbuf which job processed
353  *
354  * @param job   JOB_AES_HMAC job to process
355  *
356  * @return
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
360  */
361 static void
362 post_process_gcm_crypto_op(struct aesni_gcm_qp *qp,
363                 struct rte_crypto_op *op,
364                 struct aesni_gcm_session *session)
365 {
366         op->status = RTE_CRYPTO_OP_STATUS_SUCCESS;
367
368         /* Verify digest if required */
369         if (session->op == AESNI_GCM_OP_AUTHENTICATED_DECRYPTION ||
370                         session->op == AESNI_GMAC_OP_VERIFY) {
371                 uint8_t *digest;
372
373                 uint8_t *tag = qp->temp_digest;
374
375                 if (session->op == AESNI_GMAC_OP_VERIFY)
376                         digest = op->sym->auth.digest.data;
377                 else
378                         digest = op->sym->aead.digest.data;
379
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);
385 #endif
386
387                 if (memcmp(tag, digest, session->req_digest_length) != 0)
388                         op->status = RTE_CRYPTO_OP_STATUS_AUTH_FAILED;
389         } else {
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);
394                         else
395                                 memcpy(op->sym->auth.digest.data, qp->temp_digest,
396                                                 session->req_digest_length);
397                 }
398         }
399 }
400
401 /**
402  * Process a completed GCM request
403  *
404  * @param qp            Queue Pair to process
405  * @param op            Crypto operation
406  * @param job           JOB_AES_HMAC job
407  *
408  * @return
409  * - Number of processed jobs
410  */
411 static void
412 handle_completed_gcm_crypto_op(struct aesni_gcm_qp *qp,
413                 struct rte_crypto_op *op,
414                 struct aesni_gcm_session *sess)
415 {
416         post_process_gcm_crypto_op(qp, op, sess);
417
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_header_session_size());
423                 rte_mempool_put(qp->sess_mp_priv, sess);
424                 rte_mempool_put(qp->sess_mp, op->sym->session);
425                 op->sym->session = NULL;
426         }
427 }
428
429 static uint16_t
430 aesni_gcm_pmd_dequeue_burst(void *queue_pair,
431                 struct rte_crypto_op **ops, uint16_t nb_ops)
432 {
433         struct aesni_gcm_session *sess;
434         struct aesni_gcm_qp *qp = queue_pair;
435
436         int retval = 0;
437         unsigned int i, nb_dequeued;
438
439         nb_dequeued = rte_ring_dequeue_burst(qp->processed_pkts,
440                         (void **)ops, nb_ops, NULL);
441
442         for (i = 0; i < nb_dequeued; i++) {
443
444                 sess = aesni_gcm_get_session(qp, ops[i]);
445                 if (unlikely(sess == NULL)) {
446                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
447                         qp->qp_stats.dequeue_err_count++;
448                         break;
449                 }
450
451                 retval = process_gcm_crypto_op(qp, ops[i], sess);
452                 if (retval < 0) {
453                         ops[i]->status = RTE_CRYPTO_OP_STATUS_INVALID_ARGS;
454                         qp->qp_stats.dequeue_err_count++;
455                         break;
456                 }
457
458                 handle_completed_gcm_crypto_op(qp, ops[i], sess);
459         }
460
461         qp->qp_stats.dequeued_count += i;
462
463         return i;
464 }
465
466 static uint16_t
467 aesni_gcm_pmd_enqueue_burst(void *queue_pair,
468                 struct rte_crypto_op **ops, uint16_t nb_ops)
469 {
470         struct aesni_gcm_qp *qp = queue_pair;
471
472         unsigned int nb_enqueued;
473
474         nb_enqueued = rte_ring_enqueue_burst(qp->processed_pkts,
475                         (void **)ops, nb_ops, NULL);
476         qp->qp_stats.enqueued_count += nb_enqueued;
477
478         return nb_enqueued;
479 }
480
481 static int aesni_gcm_remove(struct rte_vdev_device *vdev);
482
483 static int
484 aesni_gcm_create(const char *name,
485                 struct rte_vdev_device *vdev,
486                 struct rte_cryptodev_pmd_init_params *init_params)
487 {
488         struct rte_cryptodev *dev;
489         struct aesni_gcm_private *internals;
490         enum aesni_gcm_vector_mode vector_mode;
491
492         /* Check CPU for support for AES instruction set */
493         if (!rte_cpu_get_flag_enabled(RTE_CPUFLAG_AES)) {
494                 AESNI_GCM_LOG(ERR, "AES instructions not supported by CPU");
495                 return -EFAULT;
496         }
497         dev = rte_cryptodev_pmd_create(name, &vdev->device, init_params);
498         if (dev == NULL) {
499                 AESNI_GCM_LOG(ERR, "driver %s: create failed",
500                         init_params->name);
501                 return -ENODEV;
502         }
503
504         /* Check CPU for supported vector instruction set */
505         if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX2))
506                 vector_mode = RTE_AESNI_GCM_AVX2;
507         else if (rte_cpu_get_flag_enabled(RTE_CPUFLAG_AVX))
508                 vector_mode = RTE_AESNI_GCM_AVX;
509         else
510                 vector_mode = RTE_AESNI_GCM_SSE;
511
512         dev->driver_id = cryptodev_driver_id;
513         dev->dev_ops = rte_aesni_gcm_pmd_ops;
514
515         /* register rx/tx burst functions for data path */
516         dev->dequeue_burst = aesni_gcm_pmd_dequeue_burst;
517         dev->enqueue_burst = aesni_gcm_pmd_enqueue_burst;
518
519         dev->feature_flags = RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO |
520                         RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING |
521                         RTE_CRYPTODEV_FF_CPU_AESNI |
522                         RTE_CRYPTODEV_FF_OOP_SGL_IN_LB_OUT |
523                         RTE_CRYPTODEV_FF_OOP_LB_IN_LB_OUT;
524
525         switch (vector_mode) {
526         case RTE_AESNI_GCM_SSE:
527                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_SSE;
528                 break;
529         case RTE_AESNI_GCM_AVX:
530                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX;
531                 break;
532         case RTE_AESNI_GCM_AVX2:
533                 dev->feature_flags |= RTE_CRYPTODEV_FF_CPU_AVX2;
534                 break;
535         default:
536                 break;
537         }
538
539         internals = dev->data->dev_private;
540
541         internals->vector_mode = vector_mode;
542
543         internals->max_nb_queue_pairs = init_params->max_nb_queue_pairs;
544
545 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
546         AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: %s\n",
547                         imb_get_version_str());
548 #else
549         AESNI_GCM_LOG(INFO, "IPSec Multi-buffer library version used: 0.49.0\n");
550 #endif
551
552         return 0;
553 }
554
555 static int
556 aesni_gcm_probe(struct rte_vdev_device *vdev)
557 {
558         struct rte_cryptodev_pmd_init_params init_params = {
559                 "",
560                 sizeof(struct aesni_gcm_private),
561                 rte_socket_id(),
562                 RTE_CRYPTODEV_PMD_DEFAULT_MAX_NB_QUEUE_PAIRS
563         };
564         const char *name;
565         const char *input_args;
566
567         name = rte_vdev_device_name(vdev);
568         if (name == NULL)
569                 return -EINVAL;
570         input_args = rte_vdev_device_args(vdev);
571         rte_cryptodev_pmd_parse_input_args(&init_params, input_args);
572
573         return aesni_gcm_create(name, vdev, &init_params);
574 }
575
576 static int
577 aesni_gcm_remove(struct rte_vdev_device *vdev)
578 {
579         struct rte_cryptodev *cryptodev;
580         const char *name;
581
582         name = rte_vdev_device_name(vdev);
583         if (name == NULL)
584                 return -EINVAL;
585
586         cryptodev = rte_cryptodev_pmd_get_named_dev(name);
587         if (cryptodev == NULL)
588                 return -ENODEV;
589
590         return rte_cryptodev_pmd_destroy(cryptodev);
591 }
592
593 static struct rte_vdev_driver aesni_gcm_pmd_drv = {
594         .probe = aesni_gcm_probe,
595         .remove = aesni_gcm_remove
596 };
597
598 static struct cryptodev_driver aesni_gcm_crypto_drv;
599
600 RTE_PMD_REGISTER_VDEV(CRYPTODEV_NAME_AESNI_GCM_PMD, aesni_gcm_pmd_drv);
601 RTE_PMD_REGISTER_ALIAS(CRYPTODEV_NAME_AESNI_GCM_PMD, cryptodev_aesni_gcm_pmd);
602 RTE_PMD_REGISTER_PARAM_STRING(CRYPTODEV_NAME_AESNI_GCM_PMD,
603         "max_nb_queue_pairs=<int> "
604         "socket_id=<int>");
605 RTE_PMD_REGISTER_CRYPTO_DRIVER(aesni_gcm_crypto_drv, aesni_gcm_pmd_drv.driver,
606                 cryptodev_driver_id);
607
608
609 RTE_INIT(aesni_gcm_init_log)
610 {
611         aesni_gcm_logtype_driver = rte_log_register("pmd.crypto.aesni_gcm");
612 }