crypto/aesni_mb: support large HMAC key sizes
[dpdk.git] / drivers / crypto / aesni_mb / rte_aesni_mb_pmd_ops.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2017 Intel Corporation
3  */
4
5 #include <string.h>
6
7 #include <rte_common.h>
8 #include <rte_malloc.h>
9 #include <rte_cryptodev_pmd.h>
10
11 #include "rte_aesni_mb_pmd_private.h"
12
13
14 static const struct rte_cryptodev_capabilities aesni_mb_pmd_capabilities[] = {
15         {       /* MD5 HMAC */
16                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
17                 {.sym = {
18                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
19                         {.auth = {
20                                 .algo = RTE_CRYPTO_AUTH_MD5_HMAC,
21                                 .block_size = 64,
22                                 .key_size = {
23                                         .min = 1,
24                                         .max = 64,
25                                         .increment = 1
26                                 },
27                                 .digest_size = {
28 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
29                                         .min = 1,
30                                         .max = 16,
31                                         .increment = 1
32 #else
33                                         .min = 12,
34                                         .max = 12,
35                                         .increment = 0
36 #endif
37                                 },
38                                 .iv_size = { 0 }
39                         }, }
40                 }, }
41         },
42         {       /* SHA1 HMAC */
43                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
44                 {.sym = {
45                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
46                         {.auth = {
47                                 .algo = RTE_CRYPTO_AUTH_SHA1_HMAC,
48                                 .block_size = 64,
49                                 .key_size = {
50                                         .min = 1,
51 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
52                                         .max = 65535,
53 #else
54                                         .max = 64,
55 #endif
56                                         .increment = 1
57                                 },
58                                 .digest_size = {
59 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
60                                         .min = 1,
61                                         .max = 20,
62                                         .increment = 1
63 #else
64                                         .min = 12,
65                                         .max = 12,
66                                         .increment = 0
67 #endif
68                                 },
69                                 .iv_size = { 0 }
70                         }, }
71                 }, }
72         },
73         {       /* SHA224 HMAC */
74                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
75                 {.sym = {
76                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
77                         {.auth = {
78                                 .algo = RTE_CRYPTO_AUTH_SHA224_HMAC,
79                                 .block_size = 64,
80                                 .key_size = {
81                                         .min = 1,
82 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
83                                         .max = 65535,
84 #else
85                                         .max = 64,
86 #endif
87                                         .increment = 1
88                                 },
89                                 .digest_size = {
90 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
91                                         .min = 1,
92                                         .max = 28,
93                                         .increment = 1
94 #else
95                                         .min = 14,
96                                         .max = 14,
97                                         .increment = 0
98 #endif
99                                 },
100                                 .iv_size = { 0 }
101                         }, }
102                 }, }
103         },
104         {       /* SHA256 HMAC */
105                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
106                 {.sym = {
107                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
108                         {.auth = {
109                                 .algo = RTE_CRYPTO_AUTH_SHA256_HMAC,
110                                 .block_size = 64,
111                                 .key_size = {
112                                         .min = 1,
113 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
114                                         .max = 65535,
115 #else
116                                         .max = 64,
117 #endif
118                                         .increment = 1
119                                 },
120                                 .digest_size = {
121 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
122                                         .min = 1,
123                                         .max = 32,
124                                         .increment = 1
125 #else
126                                         .min = 16,
127                                         .max = 16,
128                                         .increment = 0
129 #endif
130                                 },
131                                 .iv_size = { 0 }
132                         }, }
133                 }, }
134         },
135         {       /* SHA384 HMAC */
136                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
137                 {.sym = {
138                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
139                         {.auth = {
140                                 .algo = RTE_CRYPTO_AUTH_SHA384_HMAC,
141                                 .block_size = 128,
142                                 .key_size = {
143                                         .min = 1,
144 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
145                                         .max = 65535,
146 #else
147                                         .max = 128,
148 #endif
149                                         .increment = 1
150                                 },
151                                 .digest_size = {
152 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
153                                         .min = 1,
154                                         .max = 48,
155                                         .increment = 1
156 #else
157                                         .min = 24,
158                                         .max = 24,
159                                         .increment = 0
160 #endif
161                                 },
162                                 .iv_size = { 0 }
163                         }, }
164                 }, }
165         },
166         {       /* SHA512 HMAC */
167                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
168                 {.sym = {
169                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
170                         {.auth = {
171                                 .algo = RTE_CRYPTO_AUTH_SHA512_HMAC,
172                                 .block_size = 128,
173                                 .key_size = {
174                                         .min = 1,
175 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
176                                         .max = 65535,
177 #else
178                                         .max = 128,
179 #endif
180                                         .increment = 1
181                                 },
182                                 .digest_size = {
183 #if IMB_VERSION_NUM >= IMB_VERSION(0, 50, 0)
184                                         .min = 1,
185                                         .max = 64,
186                                         .increment = 1
187 #else
188                                         .min = 32,
189                                         .max = 32,
190                                         .increment = 0
191 #endif
192                                 },
193                                 .iv_size = { 0 }
194                         }, }
195                 }, }
196         },
197         {       /* AES XCBC HMAC */
198                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
199                 {.sym = {
200                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
201                         {.auth = {
202                                 .algo = RTE_CRYPTO_AUTH_AES_XCBC_MAC,
203                                 .block_size = 16,
204                                 .key_size = {
205                                         .min = 16,
206                                         .max = 16,
207                                         .increment = 0
208                                 },
209                                 .digest_size = {
210                                         .min = 12,
211                                         .max = 12,
212                                         .increment = 0
213                                 },
214                                 .iv_size = { 0 }
215                         }, }
216                 }, }
217         },
218         {       /* AES CBC */
219                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
220                 {.sym = {
221                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
222                         {.cipher = {
223                                 .algo = RTE_CRYPTO_CIPHER_AES_CBC,
224                                 .block_size = 16,
225                                 .key_size = {
226                                         .min = 16,
227                                         .max = 32,
228                                         .increment = 8
229                                 },
230                                 .iv_size = {
231                                         .min = 16,
232                                         .max = 16,
233                                         .increment = 0
234                                 }
235                         }, }
236                 }, }
237         },
238         {       /* AES CTR */
239                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
240                 {.sym = {
241                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
242                         {.cipher = {
243                                 .algo = RTE_CRYPTO_CIPHER_AES_CTR,
244                                 .block_size = 16,
245                                 .key_size = {
246                                         .min = 16,
247                                         .max = 32,
248                                         .increment = 8
249                                 },
250                                 .iv_size = {
251                                         .min = 12,
252                                         .max = 16,
253                                         .increment = 4
254                                 }
255                         }, }
256                 }, }
257         },
258         {       /* AES DOCSIS BPI */
259                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
260                 {.sym = {
261                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
262                         {.cipher = {
263                                 .algo = RTE_CRYPTO_CIPHER_AES_DOCSISBPI,
264                                 .block_size = 16,
265                                 .key_size = {
266                                         .min = 16,
267                                         .max = 16,
268                                         .increment = 0
269                                 },
270                                 .iv_size = {
271                                         .min = 16,
272                                         .max = 16,
273                                         .increment = 0
274                                 }
275                         }, }
276                 }, }
277         },
278         {       /* DES CBC */
279                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
280                 {.sym = {
281                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
282                         {.cipher = {
283                                 .algo = RTE_CRYPTO_CIPHER_DES_CBC,
284                                 .block_size = 8,
285                                 .key_size = {
286                                         .min = 8,
287                                         .max = 8,
288                                         .increment = 0
289                                 },
290                                 .iv_size = {
291                                         .min = 8,
292                                         .max = 8,
293                                         .increment = 0
294                                 }
295                         }, }
296                 }, }
297         },
298         {       /*  3DES CBC */
299                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
300                 {.sym = {
301                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
302                         {.cipher = {
303                                 .algo = RTE_CRYPTO_CIPHER_3DES_CBC,
304                                 .block_size = 8,
305                                 .key_size = {
306                                         .min = 8,
307                                         .max = 24,
308                                         .increment = 8
309                                 },
310                                 .iv_size = {
311                                         .min = 8,
312                                         .max = 8,
313                                         .increment = 0
314                                 }
315                         }, }
316                 }, }
317         },
318         {       /* DES DOCSIS BPI */
319                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
320                 {.sym = {
321                         .xform_type = RTE_CRYPTO_SYM_XFORM_CIPHER,
322                         {.cipher = {
323                                 .algo = RTE_CRYPTO_CIPHER_DES_DOCSISBPI,
324                                 .block_size = 8,
325                                 .key_size = {
326                                         .min = 8,
327                                         .max = 8,
328                                         .increment = 0
329                                 },
330                                 .iv_size = {
331                                         .min = 8,
332                                         .max = 8,
333                                         .increment = 0
334                                 }
335                         }, }
336                 }, }
337         },
338         {       /* AES CCM */
339                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
340                 {.sym = {
341                         .xform_type = RTE_CRYPTO_SYM_XFORM_AEAD,
342                         {.aead = {
343                                 .algo = RTE_CRYPTO_AEAD_AES_CCM,
344                                 .block_size = 16,
345                                 .key_size = {
346                                         .min = 16,
347                                         .max = 16,
348                                         .increment = 0
349                                 },
350                                 .digest_size = {
351                                         .min = 4,
352                                         .max = 16,
353                                         .increment = 2
354                                 },
355                                 .aad_size = {
356                                         .min = 0,
357                                         .max = 46,
358                                         .increment = 1
359                                 },
360                                 .iv_size = {
361                                         .min = 7,
362                                         .max = 13,
363                                         .increment = 1
364                                 },
365                         }, }
366                 }, }
367         },
368         {       /* AES CMAC */
369                 .op = RTE_CRYPTO_OP_TYPE_SYMMETRIC,
370                 {.sym = {
371                         .xform_type = RTE_CRYPTO_SYM_XFORM_AUTH,
372                         {.auth = {
373                                 .algo = RTE_CRYPTO_AUTH_AES_CMAC,
374                                 .block_size = 16,
375                                 .key_size = {
376                                         .min = 16,
377                                         .max = 16,
378                                         .increment = 0
379                                 },
380                                 .digest_size = {
381                                         .min = 1,
382                                         .max = 16,
383                                         .increment = 1
384                                 },
385                                 .iv_size = { 0 }
386                         }, }
387                 }, }
388         },
389         RTE_CRYPTODEV_END_OF_CAPABILITIES_LIST()
390 };
391
392
393 /** Configure device */
394 static int
395 aesni_mb_pmd_config(__rte_unused struct rte_cryptodev *dev,
396                 __rte_unused struct rte_cryptodev_config *config)
397 {
398         return 0;
399 }
400
401 /** Start device */
402 static int
403 aesni_mb_pmd_start(__rte_unused struct rte_cryptodev *dev)
404 {
405         return 0;
406 }
407
408 /** Stop device */
409 static void
410 aesni_mb_pmd_stop(__rte_unused struct rte_cryptodev *dev)
411 {
412 }
413
414 /** Close device */
415 static int
416 aesni_mb_pmd_close(__rte_unused struct rte_cryptodev *dev)
417 {
418         return 0;
419 }
420
421
422 /** Get device statistics */
423 static void
424 aesni_mb_pmd_stats_get(struct rte_cryptodev *dev,
425                 struct rte_cryptodev_stats *stats)
426 {
427         int qp_id;
428
429         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
430                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
431
432                 stats->enqueued_count += qp->stats.enqueued_count;
433                 stats->dequeued_count += qp->stats.dequeued_count;
434
435                 stats->enqueue_err_count += qp->stats.enqueue_err_count;
436                 stats->dequeue_err_count += qp->stats.dequeue_err_count;
437         }
438 }
439
440 /** Reset device statistics */
441 static void
442 aesni_mb_pmd_stats_reset(struct rte_cryptodev *dev)
443 {
444         int qp_id;
445
446         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
447                 struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
448
449                 memset(&qp->stats, 0, sizeof(qp->stats));
450         }
451 }
452
453
454 /** Get device info */
455 static void
456 aesni_mb_pmd_info_get(struct rte_cryptodev *dev,
457                 struct rte_cryptodev_info *dev_info)
458 {
459         struct aesni_mb_private *internals = dev->data->dev_private;
460
461         if (dev_info != NULL) {
462                 dev_info->driver_id = dev->driver_id;
463                 dev_info->feature_flags = dev->feature_flags;
464                 dev_info->capabilities = aesni_mb_pmd_capabilities;
465                 dev_info->max_nb_queue_pairs = internals->max_nb_queue_pairs;
466                 /* No limit of number of sessions */
467                 dev_info->sym.max_nb_sessions = 0;
468         }
469 }
470
471 /** Release queue pair */
472 static int
473 aesni_mb_pmd_qp_release(struct rte_cryptodev *dev, uint16_t qp_id)
474 {
475         struct aesni_mb_qp *qp = dev->data->queue_pairs[qp_id];
476         struct rte_ring *r = NULL;
477
478         if (qp != NULL) {
479                 r = rte_ring_lookup(qp->name);
480                 if (r)
481                         rte_ring_free(r);
482                 if (qp->mb_mgr)
483                         free_mb_mgr(qp->mb_mgr);
484                 rte_free(qp);
485                 dev->data->queue_pairs[qp_id] = NULL;
486         }
487         return 0;
488 }
489
490 /** set a unique name for the queue pair based on it's name, dev_id and qp_id */
491 static int
492 aesni_mb_pmd_qp_set_unique_name(struct rte_cryptodev *dev,
493                 struct aesni_mb_qp *qp)
494 {
495         unsigned n = snprintf(qp->name, sizeof(qp->name),
496                         "aesni_mb_pmd_%u_qp_%u",
497                         dev->data->dev_id, qp->id);
498
499         if (n >= sizeof(qp->name))
500                 return -1;
501
502         return 0;
503 }
504
505 /** Create a ring to place processed operations on */
506 static struct rte_ring *
507 aesni_mb_pmd_qp_create_processed_ops_ring(struct aesni_mb_qp *qp,
508                 const char *str, unsigned int ring_size, int socket_id)
509 {
510         struct rte_ring *r;
511         char ring_name[RTE_CRYPTODEV_NAME_MAX_LEN];
512
513         unsigned int n = snprintf(ring_name, sizeof(ring_name),
514                                 "%s_%s",
515                                 qp->name, str);
516
517         if (n >= sizeof(ring_name))
518                 return NULL;
519
520         r = rte_ring_lookup(ring_name);
521         if (r) {
522                 if (rte_ring_get_size(r) >= ring_size) {
523                         AESNI_MB_LOG(INFO, "Reusing existing ring %s for processed ops",
524                         ring_name);
525                         return r;
526                 }
527
528                 AESNI_MB_LOG(ERR, "Unable to reuse existing ring %s for processed ops",
529                         ring_name);
530                 return NULL;
531         }
532
533         return rte_ring_create(ring_name, ring_size, socket_id,
534                         RING_F_SP_ENQ | RING_F_SC_DEQ);
535 }
536
537 /** Setup a queue pair */
538 static int
539 aesni_mb_pmd_qp_setup(struct rte_cryptodev *dev, uint16_t qp_id,
540                 const struct rte_cryptodev_qp_conf *qp_conf,
541                 int socket_id, struct rte_mempool *session_pool)
542 {
543         struct aesni_mb_qp *qp = NULL;
544         struct aesni_mb_private *internals = dev->data->dev_private;
545         int ret = -1;
546
547         /* Free memory prior to re-allocation if needed. */
548         if (dev->data->queue_pairs[qp_id] != NULL)
549                 aesni_mb_pmd_qp_release(dev, qp_id);
550
551         /* Allocate the queue pair data structure. */
552         qp = rte_zmalloc_socket("AES-NI PMD Queue Pair", sizeof(*qp),
553                                         RTE_CACHE_LINE_SIZE, socket_id);
554         if (qp == NULL)
555                 return -ENOMEM;
556
557         qp->id = qp_id;
558         dev->data->queue_pairs[qp_id] = qp;
559
560         if (aesni_mb_pmd_qp_set_unique_name(dev, qp))
561                 goto qp_setup_cleanup;
562
563
564         qp->mb_mgr = alloc_mb_mgr(0);
565         if (qp->mb_mgr == NULL) {
566                 ret = -ENOMEM;
567                 goto qp_setup_cleanup;
568         }
569
570         qp->op_fns = &job_ops[internals->vector_mode];
571
572         qp->ingress_queue = aesni_mb_pmd_qp_create_processed_ops_ring(qp,
573                         "ingress", qp_conf->nb_descriptors, socket_id);
574         if (qp->ingress_queue == NULL) {
575                 ret = -1;
576                 goto qp_setup_cleanup;
577         }
578
579         qp->sess_mp = session_pool;
580
581         memset(&qp->stats, 0, sizeof(qp->stats));
582
583         char mp_name[RTE_MEMPOOL_NAMESIZE];
584
585         snprintf(mp_name, RTE_MEMPOOL_NAMESIZE,
586                                 "digest_mp_%u_%u", dev->data->dev_id, qp_id);
587
588         /* Initialise multi-buffer manager */
589         (*qp->op_fns->job.init_mgr)(qp->mb_mgr);
590         return 0;
591
592 qp_setup_cleanup:
593         if (qp) {
594                 if (qp->mb_mgr == NULL)
595                         free_mb_mgr(qp->mb_mgr);
596                 rte_free(qp);
597         }
598
599         return ret;
600 }
601
602 /** Return the number of allocated queue pairs */
603 static uint32_t
604 aesni_mb_pmd_qp_count(struct rte_cryptodev *dev)
605 {
606         return dev->data->nb_queue_pairs;
607 }
608
609 /** Returns the size of the aesni multi-buffer session structure */
610 static unsigned
611 aesni_mb_pmd_sym_session_get_size(struct rte_cryptodev *dev __rte_unused)
612 {
613         return sizeof(struct aesni_mb_session);
614 }
615
616 /** Configure a aesni multi-buffer session from a crypto xform chain */
617 static int
618 aesni_mb_pmd_sym_session_configure(struct rte_cryptodev *dev,
619                 struct rte_crypto_sym_xform *xform,
620                 struct rte_cryptodev_sym_session *sess,
621                 struct rte_mempool *mempool)
622 {
623         void *sess_private_data;
624         struct aesni_mb_private *internals = dev->data->dev_private;
625         int ret;
626
627         if (unlikely(sess == NULL)) {
628                 AESNI_MB_LOG(ERR, "invalid session struct");
629                 return -EINVAL;
630         }
631
632         if (rte_mempool_get(mempool, &sess_private_data)) {
633                 AESNI_MB_LOG(ERR,
634                                 "Couldn't get object from session mempool");
635                 return -ENOMEM;
636         }
637
638         ret = aesni_mb_set_session_parameters(&job_ops[internals->vector_mode],
639                         sess_private_data, xform);
640         if (ret != 0) {
641                 AESNI_MB_LOG(ERR, "failed configure session parameters");
642
643                 /* Return session to mempool */
644                 rte_mempool_put(mempool, sess_private_data);
645                 return ret;
646         }
647
648         set_sym_session_private_data(sess, dev->driver_id,
649                         sess_private_data);
650
651         return 0;
652 }
653
654 /** Clear the memory of session so it doesn't leave key material behind */
655 static void
656 aesni_mb_pmd_sym_session_clear(struct rte_cryptodev *dev,
657                 struct rte_cryptodev_sym_session *sess)
658 {
659         uint8_t index = dev->driver_id;
660         void *sess_priv = get_sym_session_private_data(sess, index);
661
662         /* Zero out the whole structure */
663         if (sess_priv) {
664                 memset(sess_priv, 0, sizeof(struct aesni_mb_session));
665                 struct rte_mempool *sess_mp = rte_mempool_from_obj(sess_priv);
666                 set_sym_session_private_data(sess, index, NULL);
667                 rte_mempool_put(sess_mp, sess_priv);
668         }
669 }
670
671 struct rte_cryptodev_ops aesni_mb_pmd_ops = {
672                 .dev_configure          = aesni_mb_pmd_config,
673                 .dev_start              = aesni_mb_pmd_start,
674                 .dev_stop               = aesni_mb_pmd_stop,
675                 .dev_close              = aesni_mb_pmd_close,
676
677                 .stats_get              = aesni_mb_pmd_stats_get,
678                 .stats_reset            = aesni_mb_pmd_stats_reset,
679
680                 .dev_infos_get          = aesni_mb_pmd_info_get,
681
682                 .queue_pair_setup       = aesni_mb_pmd_qp_setup,
683                 .queue_pair_release     = aesni_mb_pmd_qp_release,
684                 .queue_pair_count       = aesni_mb_pmd_qp_count,
685
686                 .sym_session_get_size   = aesni_mb_pmd_sym_session_get_size,
687                 .sym_session_configure  = aesni_mb_pmd_sym_session_configure,
688                 .sym_session_clear      = aesni_mb_pmd_sym_session_clear
689 };
690
691 struct rte_cryptodev_ops *rte_aesni_mb_pmd_ops = &aesni_mb_pmd_ops;