cryptodev: introduce ARM-specific feature flags
[dpdk.git] / lib / librte_cryptodev / rte_cryptodev.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
5  *
6  *   Redistribution and use in source and binary forms, with or without
7  *   modification, are permitted provided that the following conditions
8  *   are met:
9  *
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
15  *       distribution.
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.
19  *
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.
31  */
32
33 #include <sys/types.h>
34 #include <sys/queue.h>
35 #include <ctype.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <string.h>
39 #include <stdarg.h>
40 #include <errno.h>
41 #include <stdint.h>
42 #include <inttypes.h>
43 #include <netinet/in.h>
44
45 #include <rte_byteorder.h>
46 #include <rte_log.h>
47 #include <rte_debug.h>
48 #include <rte_dev.h>
49 #include <rte_interrupts.h>
50 #include <rte_pci.h>
51 #include <rte_memory.h>
52 #include <rte_memcpy.h>
53 #include <rte_memzone.h>
54 #include <rte_launch.h>
55 #include <rte_tailq.h>
56 #include <rte_eal.h>
57 #include <rte_per_lcore.h>
58 #include <rte_lcore.h>
59 #include <rte_atomic.h>
60 #include <rte_branch_prediction.h>
61 #include <rte_common.h>
62 #include <rte_mempool.h>
63 #include <rte_malloc.h>
64 #include <rte_mbuf.h>
65 #include <rte_errno.h>
66 #include <rte_spinlock.h>
67 #include <rte_string_fns.h>
68
69 #include "rte_crypto.h"
70 #include "rte_cryptodev.h"
71 #include "rte_cryptodev_pmd.h"
72
73 struct rte_cryptodev rte_crypto_devices[RTE_CRYPTO_MAX_DEVS];
74
75 struct rte_cryptodev *rte_cryptodevs = &rte_crypto_devices[0];
76
77 static struct rte_cryptodev_global cryptodev_globals = {
78                 .devs                   = &rte_crypto_devices[0],
79                 .data                   = { NULL },
80                 .nb_devs                = 0,
81                 .max_devs               = RTE_CRYPTO_MAX_DEVS
82 };
83
84 struct rte_cryptodev_global *rte_cryptodev_globals = &cryptodev_globals;
85
86 /* spinlock for crypto device callbacks */
87 static rte_spinlock_t rte_cryptodev_cb_lock = RTE_SPINLOCK_INITIALIZER;
88
89
90 /**
91  * The user application callback description.
92  *
93  * It contains callback address to be registered by user application,
94  * the pointer to the parameters for callback, and the event type.
95  */
96 struct rte_cryptodev_callback {
97         TAILQ_ENTRY(rte_cryptodev_callback) next; /**< Callbacks list */
98         rte_cryptodev_cb_fn cb_fn;              /**< Callback address */
99         void *cb_arg;                           /**< Parameter for callback */
100         enum rte_cryptodev_event_type event;    /**< Interrupt event type */
101         uint32_t active;                        /**< Callback is executing */
102 };
103
104 #define RTE_CRYPTODEV_VDEV_NAME                         ("name")
105 #define RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG                ("max_nb_queue_pairs")
106 #define RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG              ("max_nb_sessions")
107 #define RTE_CRYPTODEV_VDEV_SOCKET_ID                    ("socket_id")
108
109 static const char *cryptodev_vdev_valid_params[] = {
110         RTE_CRYPTODEV_VDEV_NAME,
111         RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
112         RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
113         RTE_CRYPTODEV_VDEV_SOCKET_ID
114 };
115
116 static uint8_t
117 number_of_sockets(void)
118 {
119         int sockets = 0;
120         int i;
121         const struct rte_memseg *ms = rte_eal_get_physmem_layout();
122
123         for (i = 0; ((i < RTE_MAX_MEMSEG) && (ms[i].addr != NULL)); i++) {
124                 if (sockets < ms[i].socket_id)
125                         sockets = ms[i].socket_id;
126         }
127
128         /* Number of sockets = maximum socket_id + 1 */
129         return ++sockets;
130 }
131
132 /** Parse integer from integer argument */
133 static int
134 parse_integer_arg(const char *key __rte_unused,
135                 const char *value, void *extra_args)
136 {
137         int *i = (int *) extra_args;
138
139         *i = atoi(value);
140         if (*i < 0) {
141                 CDEV_LOG_ERR("Argument has to be positive.");
142                 return -1;
143         }
144
145         return 0;
146 }
147
148 /** Parse name */
149 static int
150 parse_name_arg(const char *key __rte_unused,
151                 const char *value, void *extra_args)
152 {
153         struct rte_crypto_vdev_init_params *params = extra_args;
154
155         if (strlen(value) >= RTE_CRYPTODEV_NAME_MAX_LEN - 1) {
156                 CDEV_LOG_ERR("Invalid name %s, should be less than "
157                                 "%u bytes", value,
158                                 RTE_CRYPTODEV_NAME_MAX_LEN - 1);
159                 return -1;
160         }
161
162         strncpy(params->name, value, RTE_CRYPTODEV_NAME_MAX_LEN);
163
164         return 0;
165 }
166
167 int
168 rte_cryptodev_parse_vdev_init_params(struct rte_crypto_vdev_init_params *params,
169                 const char *input_args)
170 {
171         struct rte_kvargs *kvlist = NULL;
172         int ret = 0;
173
174         if (params == NULL)
175                 return -EINVAL;
176
177         if (input_args) {
178                 kvlist = rte_kvargs_parse(input_args,
179                                 cryptodev_vdev_valid_params);
180                 if (kvlist == NULL)
181                         return -1;
182
183                 ret = rte_kvargs_process(kvlist,
184                                         RTE_CRYPTODEV_VDEV_MAX_NB_QP_ARG,
185                                         &parse_integer_arg,
186                                         &params->max_nb_queue_pairs);
187                 if (ret < 0)
188                         goto free_kvlist;
189
190                 ret = rte_kvargs_process(kvlist,
191                                         RTE_CRYPTODEV_VDEV_MAX_NB_SESS_ARG,
192                                         &parse_integer_arg,
193                                         &params->max_nb_sessions);
194                 if (ret < 0)
195                         goto free_kvlist;
196
197                 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_SOCKET_ID,
198                                         &parse_integer_arg,
199                                         &params->socket_id);
200                 if (ret < 0)
201                         goto free_kvlist;
202
203                 ret = rte_kvargs_process(kvlist, RTE_CRYPTODEV_VDEV_NAME,
204                                         &parse_name_arg,
205                                         params);
206                 if (ret < 0)
207                         goto free_kvlist;
208
209                 if (params->socket_id >= number_of_sockets()) {
210                         CDEV_LOG_ERR("Invalid socket id specified to create "
211                                 "the virtual crypto device on");
212                         goto free_kvlist;
213                 }
214         }
215
216 free_kvlist:
217         rte_kvargs_free(kvlist);
218         return ret;
219 }
220
221 const char *
222 rte_cryptodev_get_feature_name(uint64_t flag)
223 {
224         switch (flag) {
225         case RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO:
226                 return "SYMMETRIC_CRYPTO";
227         case RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO:
228                 return "ASYMMETRIC_CRYPTO";
229         case RTE_CRYPTODEV_FF_SYM_OPERATION_CHAINING:
230                 return "SYM_OPERATION_CHAINING";
231         case RTE_CRYPTODEV_FF_CPU_SSE:
232                 return "CPU_SSE";
233         case RTE_CRYPTODEV_FF_CPU_AVX:
234                 return "CPU_AVX";
235         case RTE_CRYPTODEV_FF_CPU_AVX2:
236                 return "CPU_AVX2";
237         case RTE_CRYPTODEV_FF_CPU_AESNI:
238                 return "CPU_AESNI";
239         case RTE_CRYPTODEV_FF_HW_ACCELERATED:
240                 return "HW_ACCELERATED";
241         case RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER:
242                 return "MBUF_SCATTER_GATHER";
243         case RTE_CRYPTODEV_FF_CPU_NEON:
244                 return "CPU_NEON";
245         case RTE_CRYPTODEV_FF_CPU_ARM_CE:
246                 return "CPU_ARM_CE";
247         default:
248                 return NULL;
249         }
250 }
251
252 int
253 rte_cryptodev_create_vdev(const char *name, const char *args)
254 {
255         return rte_eal_vdev_init(name, args);
256 }
257
258 int
259 rte_cryptodev_get_dev_id(const char *name)
260 {
261         unsigned i;
262
263         if (name == NULL)
264                 return -1;
265
266         for (i = 0; i < rte_cryptodev_globals->nb_devs; i++)
267                 if ((strcmp(rte_cryptodev_globals->devs[i].data->name, name)
268                                 == 0) &&
269                                 (rte_cryptodev_globals->devs[i].attached ==
270                                                 RTE_CRYPTODEV_ATTACHED))
271                         return i;
272
273         return -1;
274 }
275
276 uint8_t
277 rte_cryptodev_count(void)
278 {
279         return rte_cryptodev_globals->nb_devs;
280 }
281
282 uint8_t
283 rte_cryptodev_count_devtype(enum rte_cryptodev_type type)
284 {
285         uint8_t i, dev_count = 0;
286
287         for (i = 0; i < rte_cryptodev_globals->max_devs; i++)
288                 if (rte_cryptodev_globals->devs[i].dev_type == type &&
289                         rte_cryptodev_globals->devs[i].attached ==
290                                         RTE_CRYPTODEV_ATTACHED)
291                         dev_count++;
292
293         return dev_count;
294 }
295
296 int
297 rte_cryptodev_socket_id(uint8_t dev_id)
298 {
299         struct rte_cryptodev *dev;
300
301         if (!rte_cryptodev_pmd_is_valid_dev(dev_id))
302                 return -1;
303
304         dev = rte_cryptodev_pmd_get_dev(dev_id);
305
306         return dev->data->socket_id;
307 }
308
309 static inline int
310 rte_cryptodev_data_alloc(uint8_t dev_id, struct rte_cryptodev_data **data,
311                 int socket_id)
312 {
313         char mz_name[RTE_CRYPTODEV_NAME_MAX_LEN];
314         const struct rte_memzone *mz;
315         int n;
316
317         /* generate memzone name */
318         n = snprintf(mz_name, sizeof(mz_name), "rte_cryptodev_data_%u", dev_id);
319         if (n >= (int)sizeof(mz_name))
320                 return -EINVAL;
321
322         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
323                 mz = rte_memzone_reserve(mz_name,
324                                 sizeof(struct rte_cryptodev_data),
325                                 socket_id, 0);
326         } else
327                 mz = rte_memzone_lookup(mz_name);
328
329         if (mz == NULL)
330                 return -ENOMEM;
331
332         *data = mz->addr;
333         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
334                 memset(*data, 0, sizeof(struct rte_cryptodev_data));
335
336         return 0;
337 }
338
339 static uint8_t
340 rte_cryptodev_find_free_device_index(void)
341 {
342         uint8_t dev_id;
343
344         for (dev_id = 0; dev_id < RTE_CRYPTO_MAX_DEVS; dev_id++) {
345                 if (rte_crypto_devices[dev_id].attached ==
346                                 RTE_CRYPTODEV_DETACHED)
347                         return dev_id;
348         }
349         return RTE_CRYPTO_MAX_DEVS;
350 }
351
352 struct rte_cryptodev *
353 rte_cryptodev_pmd_allocate(const char *name, int socket_id)
354 {
355         struct rte_cryptodev *cryptodev;
356         uint8_t dev_id;
357
358         if (rte_cryptodev_pmd_get_named_dev(name) != NULL) {
359                 CDEV_LOG_ERR("Crypto device with name %s already "
360                                 "allocated!", name);
361                 return NULL;
362         }
363
364         dev_id = rte_cryptodev_find_free_device_index();
365         if (dev_id == RTE_CRYPTO_MAX_DEVS) {
366                 CDEV_LOG_ERR("Reached maximum number of crypto devices");
367                 return NULL;
368         }
369
370         cryptodev = rte_cryptodev_pmd_get_dev(dev_id);
371
372         if (cryptodev->data == NULL) {
373                 struct rte_cryptodev_data *cryptodev_data =
374                                 cryptodev_globals.data[dev_id];
375
376                 int retval = rte_cryptodev_data_alloc(dev_id, &cryptodev_data,
377                                 socket_id);
378
379                 if (retval < 0 || cryptodev_data == NULL)
380                         return NULL;
381
382                 cryptodev->data = cryptodev_data;
383
384                 snprintf(cryptodev->data->name, RTE_CRYPTODEV_NAME_MAX_LEN,
385                                 "%s", name);
386
387                 cryptodev->data->dev_id = dev_id;
388                 cryptodev->data->socket_id = socket_id;
389                 cryptodev->data->dev_started = 0;
390
391                 cryptodev->attached = RTE_CRYPTODEV_ATTACHED;
392
393                 cryptodev_globals.nb_devs++;
394         }
395
396         return cryptodev;
397 }
398
399 int
400 rte_cryptodev_pmd_release_device(struct rte_cryptodev *cryptodev)
401 {
402         int ret;
403
404         if (cryptodev == NULL)
405                 return -EINVAL;
406
407         ret = rte_cryptodev_close(cryptodev->data->dev_id);
408         if (ret < 0)
409                 return ret;
410
411         cryptodev->attached = RTE_CRYPTODEV_DETACHED;
412         cryptodev_globals.nb_devs--;
413         return 0;
414 }
415
416 struct rte_cryptodev *
417 rte_cryptodev_pmd_virtual_dev_init(const char *name, size_t dev_private_size,
418                 int socket_id)
419 {
420         struct rte_cryptodev *cryptodev;
421
422         /* allocate device structure */
423         cryptodev = rte_cryptodev_pmd_allocate(name, socket_id);
424         if (cryptodev == NULL)
425                 return NULL;
426
427         /* allocate private device structure */
428         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
429                 cryptodev->data->dev_private =
430                                 rte_zmalloc_socket("cryptodev device private",
431                                                 dev_private_size,
432                                                 RTE_CACHE_LINE_SIZE,
433                                                 socket_id);
434
435                 if (cryptodev->data->dev_private == NULL)
436                         rte_panic("Cannot allocate memzone for private device"
437                                         " data");
438         }
439
440         /* initialise user call-back tail queue */
441         TAILQ_INIT(&(cryptodev->link_intr_cbs));
442
443         return cryptodev;
444 }
445
446 int
447 rte_cryptodev_pci_probe(struct rte_pci_driver *pci_drv,
448                         struct rte_pci_device *pci_dev)
449 {
450         struct rte_cryptodev_driver *cryptodrv;
451         struct rte_cryptodev *cryptodev;
452
453         char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
454
455         int retval;
456
457         cryptodrv = (struct rte_cryptodev_driver *)pci_drv;
458         if (cryptodrv == NULL)
459                 return -ENODEV;
460
461         rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
462                         sizeof(cryptodev_name));
463
464         cryptodev = rte_cryptodev_pmd_allocate(cryptodev_name, rte_socket_id());
465         if (cryptodev == NULL)
466                 return -ENOMEM;
467
468         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
469                 cryptodev->data->dev_private =
470                                 rte_zmalloc_socket(
471                                                 "cryptodev private structure",
472                                                 cryptodrv->dev_private_size,
473                                                 RTE_CACHE_LINE_SIZE,
474                                                 rte_socket_id());
475
476                 if (cryptodev->data->dev_private == NULL)
477                         rte_panic("Cannot allocate memzone for private "
478                                         "device data");
479         }
480
481         cryptodev->pci_dev = pci_dev;
482         cryptodev->driver = cryptodrv;
483
484         /* init user callbacks */
485         TAILQ_INIT(&(cryptodev->link_intr_cbs));
486
487         /* Invoke PMD device initialization function */
488         retval = (*cryptodrv->cryptodev_init)(cryptodrv, cryptodev);
489         if (retval == 0)
490                 return 0;
491
492         CDEV_LOG_ERR("driver %s: crypto_dev_init(vendor_id=0x%x device_id=0x%x)"
493                         " failed", pci_drv->driver.name,
494                         (unsigned) pci_dev->id.vendor_id,
495                         (unsigned) pci_dev->id.device_id);
496
497         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
498                 rte_free(cryptodev->data->dev_private);
499
500         cryptodev->attached = RTE_CRYPTODEV_DETACHED;
501         cryptodev_globals.nb_devs--;
502
503         return -ENXIO;
504 }
505
506 int
507 rte_cryptodev_pci_remove(struct rte_pci_device *pci_dev)
508 {
509         const struct rte_cryptodev_driver *cryptodrv;
510         struct rte_cryptodev *cryptodev;
511         char cryptodev_name[RTE_CRYPTODEV_NAME_MAX_LEN];
512         int ret;
513
514         if (pci_dev == NULL)
515                 return -EINVAL;
516
517         rte_eal_pci_device_name(&pci_dev->addr, cryptodev_name,
518                         sizeof(cryptodev_name));
519
520         cryptodev = rte_cryptodev_pmd_get_named_dev(cryptodev_name);
521         if (cryptodev == NULL)
522                 return -ENODEV;
523
524         cryptodrv = (const struct rte_cryptodev_driver *)pci_dev->driver;
525         if (cryptodrv == NULL)
526                 return -ENODEV;
527
528         /* Invoke PMD device uninit function */
529         if (*cryptodrv->cryptodev_uninit) {
530                 ret = (*cryptodrv->cryptodev_uninit)(cryptodrv, cryptodev);
531                 if (ret)
532                         return ret;
533         }
534
535         /* free crypto device */
536         rte_cryptodev_pmd_release_device(cryptodev);
537
538         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
539                 rte_free(cryptodev->data->dev_private);
540
541         cryptodev->pci_dev = NULL;
542         cryptodev->driver = NULL;
543         cryptodev->data = NULL;
544
545         return 0;
546 }
547
548 uint16_t
549 rte_cryptodev_queue_pair_count(uint8_t dev_id)
550 {
551         struct rte_cryptodev *dev;
552
553         dev = &rte_crypto_devices[dev_id];
554         return dev->data->nb_queue_pairs;
555 }
556
557 static int
558 rte_cryptodev_queue_pairs_config(struct rte_cryptodev *dev, uint16_t nb_qpairs,
559                 int socket_id)
560 {
561         struct rte_cryptodev_info dev_info;
562         void **qp;
563         unsigned i;
564
565         if ((dev == NULL) || (nb_qpairs < 1)) {
566                 CDEV_LOG_ERR("invalid param: dev %p, nb_queues %u",
567                                                         dev, nb_qpairs);
568                 return -EINVAL;
569         }
570
571         CDEV_LOG_DEBUG("Setup %d queues pairs on device %u",
572                         nb_qpairs, dev->data->dev_id);
573
574         memset(&dev_info, 0, sizeof(struct rte_cryptodev_info));
575
576         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
577         (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
578
579         if (nb_qpairs > (dev_info.max_nb_queue_pairs)) {
580                 CDEV_LOG_ERR("Invalid num queue_pairs (%u) for dev %u",
581                                 nb_qpairs, dev->data->dev_id);
582             return -EINVAL;
583         }
584
585         if (dev->data->queue_pairs == NULL) { /* first time configuration */
586                 dev->data->queue_pairs = rte_zmalloc_socket(
587                                 "cryptodev->queue_pairs",
588                                 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
589                                 RTE_CACHE_LINE_SIZE, socket_id);
590
591                 if (dev->data->queue_pairs == NULL) {
592                         dev->data->nb_queue_pairs = 0;
593                         CDEV_LOG_ERR("failed to get memory for qp meta data, "
594                                                         "nb_queues %u",
595                                                         nb_qpairs);
596                         return -(ENOMEM);
597                 }
598         } else { /* re-configure */
599                 int ret;
600                 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
601
602                 qp = dev->data->queue_pairs;
603
604                 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
605                                 -ENOTSUP);
606
607                 for (i = nb_qpairs; i < old_nb_queues; i++) {
608                         ret = (*dev->dev_ops->queue_pair_release)(dev, i);
609                         if (ret < 0)
610                                 return ret;
611                 }
612
613                 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
614                                 RTE_CACHE_LINE_SIZE);
615                 if (qp == NULL) {
616                         CDEV_LOG_ERR("failed to realloc qp meta data,"
617                                                 " nb_queues %u", nb_qpairs);
618                         return -(ENOMEM);
619                 }
620
621                 if (nb_qpairs > old_nb_queues) {
622                         uint16_t new_qs = nb_qpairs - old_nb_queues;
623
624                         memset(qp + old_nb_queues, 0,
625                                 sizeof(qp[0]) * new_qs);
626                 }
627
628                 dev->data->queue_pairs = qp;
629
630         }
631         dev->data->nb_queue_pairs = nb_qpairs;
632         return 0;
633 }
634
635 int
636 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id)
637 {
638         struct rte_cryptodev *dev;
639
640         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
641                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
642                 return -EINVAL;
643         }
644
645         dev = &rte_crypto_devices[dev_id];
646         if (queue_pair_id >= dev->data->nb_queue_pairs) {
647                 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
648                 return -EINVAL;
649         }
650
651         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_start, -ENOTSUP);
652
653         return dev->dev_ops->queue_pair_start(dev, queue_pair_id);
654
655 }
656
657 int
658 rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id)
659 {
660         struct rte_cryptodev *dev;
661
662         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
663                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
664                 return -EINVAL;
665         }
666
667         dev = &rte_crypto_devices[dev_id];
668         if (queue_pair_id >= dev->data->nb_queue_pairs) {
669                 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
670                 return -EINVAL;
671         }
672
673         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_stop, -ENOTSUP);
674
675         return dev->dev_ops->queue_pair_stop(dev, queue_pair_id);
676
677 }
678
679 static int
680 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
681                 unsigned nb_objs, unsigned obj_cache_size, int socket_id);
682
683 int
684 rte_cryptodev_configure(uint8_t dev_id, struct rte_cryptodev_config *config)
685 {
686         struct rte_cryptodev *dev;
687         int diag;
688
689         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
690                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
691                 return -EINVAL;
692         }
693
694         dev = &rte_crypto_devices[dev_id];
695
696         if (dev->data->dev_started) {
697                 CDEV_LOG_ERR(
698                     "device %d must be stopped to allow configuration", dev_id);
699                 return -EBUSY;
700         }
701
702         /* Setup new number of queue pairs and reconfigure device. */
703         diag = rte_cryptodev_queue_pairs_config(dev, config->nb_queue_pairs,
704                         config->socket_id);
705         if (diag != 0) {
706                 CDEV_LOG_ERR("dev%d rte_crypto_dev_queue_pairs_config = %d",
707                                 dev_id, diag);
708                 return diag;
709         }
710
711         /* Setup Session mempool for device */
712         return rte_cryptodev_sym_session_pool_create(dev,
713                         config->session_mp.nb_objs,
714                         config->session_mp.cache_size,
715                         config->socket_id);
716 }
717
718
719 int
720 rte_cryptodev_start(uint8_t dev_id)
721 {
722         struct rte_cryptodev *dev;
723         int diag;
724
725         CDEV_LOG_DEBUG("Start dev_id=%" PRIu8, dev_id);
726
727         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
728                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
729                 return -EINVAL;
730         }
731
732         dev = &rte_crypto_devices[dev_id];
733
734         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
735
736         if (dev->data->dev_started != 0) {
737                 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already started",
738                         dev_id);
739                 return 0;
740         }
741
742         diag = (*dev->dev_ops->dev_start)(dev);
743         if (diag == 0)
744                 dev->data->dev_started = 1;
745         else
746                 return diag;
747
748         return 0;
749 }
750
751 void
752 rte_cryptodev_stop(uint8_t dev_id)
753 {
754         struct rte_cryptodev *dev;
755
756         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
757                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
758                 return;
759         }
760
761         dev = &rte_crypto_devices[dev_id];
762
763         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
764
765         if (dev->data->dev_started == 0) {
766                 CDEV_LOG_ERR("Device with dev_id=%" PRIu8 " already stopped",
767                         dev_id);
768                 return;
769         }
770
771         dev->data->dev_started = 0;
772         (*dev->dev_ops->dev_stop)(dev);
773 }
774
775 int
776 rte_cryptodev_close(uint8_t dev_id)
777 {
778         struct rte_cryptodev *dev;
779         int retval;
780
781         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
782                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
783                 return -1;
784         }
785
786         dev = &rte_crypto_devices[dev_id];
787
788         /* Device must be stopped before it can be closed */
789         if (dev->data->dev_started == 1) {
790                 CDEV_LOG_ERR("Device %u must be stopped before closing",
791                                 dev_id);
792                 return -EBUSY;
793         }
794
795         /* We can't close the device if there are outstanding sessions in use */
796         if (dev->data->session_pool != NULL) {
797                 if (!rte_mempool_full(dev->data->session_pool)) {
798                         CDEV_LOG_ERR("dev_id=%u close failed, session mempool "
799                                         "has sessions still in use, free "
800                                         "all sessions before calling close",
801                                         (unsigned)dev_id);
802                         return -EBUSY;
803                 }
804         }
805
806         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
807         retval = (*dev->dev_ops->dev_close)(dev);
808
809         if (retval < 0)
810                 return retval;
811
812         return 0;
813 }
814
815 int
816 rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
817                 const struct rte_cryptodev_qp_conf *qp_conf, int socket_id)
818 {
819         struct rte_cryptodev *dev;
820
821         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
822                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
823                 return -EINVAL;
824         }
825
826         dev = &rte_crypto_devices[dev_id];
827         if (queue_pair_id >= dev->data->nb_queue_pairs) {
828                 CDEV_LOG_ERR("Invalid queue_pair_id=%d", queue_pair_id);
829                 return -EINVAL;
830         }
831
832         if (dev->data->dev_started) {
833                 CDEV_LOG_ERR(
834                     "device %d must be stopped to allow configuration", dev_id);
835                 return -EBUSY;
836         }
837
838         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
839
840         return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id, qp_conf,
841                         socket_id);
842 }
843
844
845 int
846 rte_cryptodev_stats_get(uint8_t dev_id, struct rte_cryptodev_stats *stats)
847 {
848         struct rte_cryptodev *dev;
849
850         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
851                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
852                 return -ENODEV;
853         }
854
855         if (stats == NULL) {
856                 CDEV_LOG_ERR("Invalid stats ptr");
857                 return -EINVAL;
858         }
859
860         dev = &rte_crypto_devices[dev_id];
861         memset(stats, 0, sizeof(*stats));
862
863         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
864         (*dev->dev_ops->stats_get)(dev, stats);
865         return 0;
866 }
867
868 void
869 rte_cryptodev_stats_reset(uint8_t dev_id)
870 {
871         struct rte_cryptodev *dev;
872
873         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
874                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
875                 return;
876         }
877
878         dev = &rte_crypto_devices[dev_id];
879
880         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
881         (*dev->dev_ops->stats_reset)(dev);
882 }
883
884
885 void
886 rte_cryptodev_info_get(uint8_t dev_id, struct rte_cryptodev_info *dev_info)
887 {
888         struct rte_cryptodev *dev;
889
890         if (dev_id >= cryptodev_globals.nb_devs) {
891                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
892                 return;
893         }
894
895         dev = &rte_crypto_devices[dev_id];
896
897         memset(dev_info, 0, sizeof(struct rte_cryptodev_info));
898
899         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
900         (*dev->dev_ops->dev_infos_get)(dev, dev_info);
901
902         dev_info->pci_dev = dev->pci_dev;
903         if (dev->driver)
904                 dev_info->driver_name = dev->driver->pci_drv.driver.name;
905 }
906
907
908 int
909 rte_cryptodev_callback_register(uint8_t dev_id,
910                         enum rte_cryptodev_event_type event,
911                         rte_cryptodev_cb_fn cb_fn, void *cb_arg)
912 {
913         struct rte_cryptodev *dev;
914         struct rte_cryptodev_callback *user_cb;
915
916         if (!cb_fn)
917                 return -EINVAL;
918
919         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
920                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
921                 return -EINVAL;
922         }
923
924         dev = &rte_crypto_devices[dev_id];
925         rte_spinlock_lock(&rte_cryptodev_cb_lock);
926
927         TAILQ_FOREACH(user_cb, &(dev->link_intr_cbs), next) {
928                 if (user_cb->cb_fn == cb_fn &&
929                         user_cb->cb_arg == cb_arg &&
930                         user_cb->event == event) {
931                         break;
932                 }
933         }
934
935         /* create a new callback. */
936         if (user_cb == NULL) {
937                 user_cb = rte_zmalloc("INTR_USER_CALLBACK",
938                                 sizeof(struct rte_cryptodev_callback), 0);
939                 if (user_cb != NULL) {
940                         user_cb->cb_fn = cb_fn;
941                         user_cb->cb_arg = cb_arg;
942                         user_cb->event = event;
943                         TAILQ_INSERT_TAIL(&(dev->link_intr_cbs), user_cb, next);
944                 }
945         }
946
947         rte_spinlock_unlock(&rte_cryptodev_cb_lock);
948         return (user_cb == NULL) ? -ENOMEM : 0;
949 }
950
951 int
952 rte_cryptodev_callback_unregister(uint8_t dev_id,
953                         enum rte_cryptodev_event_type event,
954                         rte_cryptodev_cb_fn cb_fn, void *cb_arg)
955 {
956         int ret;
957         struct rte_cryptodev *dev;
958         struct rte_cryptodev_callback *cb, *next;
959
960         if (!cb_fn)
961                 return -EINVAL;
962
963         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
964                 CDEV_LOG_ERR("Invalid dev_id=%" PRIu8, dev_id);
965                 return -EINVAL;
966         }
967
968         dev = &rte_crypto_devices[dev_id];
969         rte_spinlock_lock(&rte_cryptodev_cb_lock);
970
971         ret = 0;
972         for (cb = TAILQ_FIRST(&dev->link_intr_cbs); cb != NULL; cb = next) {
973
974                 next = TAILQ_NEXT(cb, next);
975
976                 if (cb->cb_fn != cb_fn || cb->event != event ||
977                                 (cb->cb_arg != (void *)-1 &&
978                                 cb->cb_arg != cb_arg))
979                         continue;
980
981                 /*
982                  * if this callback is not executing right now,
983                  * then remove it.
984                  */
985                 if (cb->active == 0) {
986                         TAILQ_REMOVE(&(dev->link_intr_cbs), cb, next);
987                         rte_free(cb);
988                 } else {
989                         ret = -EAGAIN;
990                 }
991         }
992
993         rte_spinlock_unlock(&rte_cryptodev_cb_lock);
994         return ret;
995 }
996
997 void
998 rte_cryptodev_pmd_callback_process(struct rte_cryptodev *dev,
999         enum rte_cryptodev_event_type event)
1000 {
1001         struct rte_cryptodev_callback *cb_lst;
1002         struct rte_cryptodev_callback dev_cb;
1003
1004         rte_spinlock_lock(&rte_cryptodev_cb_lock);
1005         TAILQ_FOREACH(cb_lst, &(dev->link_intr_cbs), next) {
1006                 if (cb_lst->cb_fn == NULL || cb_lst->event != event)
1007                         continue;
1008                 dev_cb = *cb_lst;
1009                 cb_lst->active = 1;
1010                 rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1011                 dev_cb.cb_fn(dev->data->dev_id, dev_cb.event,
1012                                                 dev_cb.cb_arg);
1013                 rte_spinlock_lock(&rte_cryptodev_cb_lock);
1014                 cb_lst->active = 0;
1015         }
1016         rte_spinlock_unlock(&rte_cryptodev_cb_lock);
1017 }
1018
1019
1020 static void
1021 rte_cryptodev_sym_session_init(struct rte_mempool *mp,
1022                 void *opaque_arg,
1023                 void *_sess,
1024                 __rte_unused unsigned i)
1025 {
1026         struct rte_cryptodev_sym_session *sess = _sess;
1027         struct rte_cryptodev *dev = opaque_arg;
1028
1029         memset(sess, 0, mp->elt_size);
1030
1031         sess->dev_id = dev->data->dev_id;
1032         sess->dev_type = dev->dev_type;
1033         sess->mp = mp;
1034
1035         if (dev->dev_ops->session_initialize)
1036                 (*dev->dev_ops->session_initialize)(mp, sess);
1037 }
1038
1039 static int
1040 rte_cryptodev_sym_session_pool_create(struct rte_cryptodev *dev,
1041                 unsigned nb_objs, unsigned obj_cache_size, int socket_id)
1042 {
1043         char mp_name[RTE_CRYPTODEV_NAME_MAX_LEN];
1044         unsigned priv_sess_size;
1045
1046         unsigned n = snprintf(mp_name, sizeof(mp_name), "cdev_%d_sess_mp",
1047                         dev->data->dev_id);
1048         if (n > sizeof(mp_name)) {
1049                 CDEV_LOG_ERR("Unable to create unique name for session mempool");
1050                 return -ENOMEM;
1051         }
1052
1053         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_get_size, -ENOTSUP);
1054         priv_sess_size = (*dev->dev_ops->session_get_size)(dev);
1055         if (priv_sess_size == 0) {
1056                 CDEV_LOG_ERR("%s returned and invalid private session size ",
1057                                                 dev->data->name);
1058                 return -ENOMEM;
1059         }
1060
1061         unsigned elt_size = sizeof(struct rte_cryptodev_sym_session) +
1062                         priv_sess_size;
1063
1064         dev->data->session_pool = rte_mempool_lookup(mp_name);
1065         if (dev->data->session_pool != NULL) {
1066                 if ((dev->data->session_pool->elt_size != elt_size) ||
1067                                 (dev->data->session_pool->cache_size <
1068                                 obj_cache_size) ||
1069                                 (dev->data->session_pool->size < nb_objs)) {
1070
1071                         CDEV_LOG_ERR("%s mempool already exists with different"
1072                                         " initialization parameters", mp_name);
1073                         dev->data->session_pool = NULL;
1074                         return -ENOMEM;
1075                 }
1076         } else {
1077                 dev->data->session_pool = rte_mempool_create(
1078                                 mp_name, /* mempool name */
1079                                 nb_objs, /* number of elements*/
1080                                 elt_size, /* element size*/
1081                                 obj_cache_size, /* Cache size*/
1082                                 0, /* private data size */
1083                                 NULL, /* obj initialization constructor */
1084                                 NULL, /* obj initialization constructor arg */
1085                                 rte_cryptodev_sym_session_init,
1086                                 /**< obj constructor*/
1087                                 dev, /* obj constructor arg */
1088                                 socket_id, /* socket id */
1089                                 0); /* flags */
1090
1091                 if (dev->data->session_pool == NULL) {
1092                         CDEV_LOG_ERR("%s mempool allocation failed", mp_name);
1093                         return -ENOMEM;
1094                 }
1095         }
1096
1097         CDEV_LOG_DEBUG("%s mempool created!", mp_name);
1098         return 0;
1099 }
1100
1101 struct rte_cryptodev_sym_session *
1102 rte_cryptodev_sym_session_create(uint8_t dev_id,
1103                 struct rte_crypto_sym_xform *xform)
1104 {
1105         struct rte_cryptodev *dev;
1106         struct rte_cryptodev_sym_session *sess;
1107         void *_sess;
1108
1109         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1110                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1111                 return NULL;
1112         }
1113
1114         dev = &rte_crypto_devices[dev_id];
1115
1116         /* Allocate a session structure from the session pool */
1117         if (rte_mempool_get(dev->data->session_pool, &_sess)) {
1118                 CDEV_LOG_ERR("Couldn't get object from session mempool");
1119                 return NULL;
1120         }
1121
1122         sess = (struct rte_cryptodev_sym_session *)_sess;
1123
1124         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_configure, NULL);
1125         if (dev->dev_ops->session_configure(dev, xform, sess->_private) ==
1126                         NULL) {
1127                 CDEV_LOG_ERR("dev_id %d failed to configure session details",
1128                                 dev_id);
1129
1130                 /* Return session to mempool */
1131                 rte_mempool_put(sess->mp, _sess);
1132                 return NULL;
1133         }
1134
1135         return sess;
1136 }
1137
1138 struct rte_cryptodev_sym_session *
1139 rte_cryptodev_sym_session_free(uint8_t dev_id,
1140                 struct rte_cryptodev_sym_session *sess)
1141 {
1142         struct rte_cryptodev *dev;
1143
1144         if (!rte_cryptodev_pmd_is_valid_dev(dev_id)) {
1145                 CDEV_LOG_ERR("Invalid dev_id=%d", dev_id);
1146                 return sess;
1147         }
1148
1149         dev = &rte_crypto_devices[dev_id];
1150
1151         /* Check the session belongs to this device type */
1152         if (sess->dev_type != dev->dev_type)
1153                 return sess;
1154
1155         /* Let device implementation clear session material */
1156         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->session_clear, sess);
1157         dev->dev_ops->session_clear(dev, (void *)sess->_private);
1158
1159         /* Return session to mempool */
1160         rte_mempool_put(sess->mp, (void *)sess);
1161
1162         return NULL;
1163 }
1164
1165 /** Initialise rte_crypto_op mempool element */
1166 static void
1167 rte_crypto_op_init(struct rte_mempool *mempool,
1168                 void *opaque_arg,
1169                 void *_op_data,
1170                 __rte_unused unsigned i)
1171 {
1172         struct rte_crypto_op *op = _op_data;
1173         enum rte_crypto_op_type type = *(enum rte_crypto_op_type *)opaque_arg;
1174
1175         memset(_op_data, 0, mempool->elt_size);
1176
1177         __rte_crypto_op_reset(op, type);
1178
1179         op->phys_addr = rte_mem_virt2phy(_op_data);
1180         op->mempool = mempool;
1181 }
1182
1183
1184 struct rte_mempool *
1185 rte_crypto_op_pool_create(const char *name, enum rte_crypto_op_type type,
1186                 unsigned nb_elts, unsigned cache_size, uint16_t priv_size,
1187                 int socket_id)
1188 {
1189         struct rte_crypto_op_pool_private *priv;
1190
1191         unsigned elt_size = sizeof(struct rte_crypto_op) +
1192                         sizeof(struct rte_crypto_sym_op) +
1193                         priv_size;
1194
1195         /* lookup mempool in case already allocated */
1196         struct rte_mempool *mp = rte_mempool_lookup(name);
1197
1198         if (mp != NULL) {
1199                 priv = (struct rte_crypto_op_pool_private *)
1200                                 rte_mempool_get_priv(mp);
1201
1202                 if (mp->elt_size != elt_size ||
1203                                 mp->cache_size < cache_size ||
1204                                 mp->size < nb_elts ||
1205                                 priv->priv_size <  priv_size) {
1206                         mp = NULL;
1207                         CDEV_LOG_ERR("Mempool %s already exists but with "
1208                                         "incompatible parameters", name);
1209                         return NULL;
1210                 }
1211                 return mp;
1212         }
1213
1214         mp = rte_mempool_create(
1215                         name,
1216                         nb_elts,
1217                         elt_size,
1218                         cache_size,
1219                         sizeof(struct rte_crypto_op_pool_private),
1220                         NULL,
1221                         NULL,
1222                         rte_crypto_op_init,
1223                         &type,
1224                         socket_id,
1225                         0);
1226
1227         if (mp == NULL) {
1228                 CDEV_LOG_ERR("Failed to create mempool %s", name);
1229                 return NULL;
1230         }
1231
1232         priv = (struct rte_crypto_op_pool_private *)
1233                         rte_mempool_get_priv(mp);
1234
1235         priv->priv_size = priv_size;
1236         priv->type = type;
1237
1238         return mp;
1239 }
1240
1241 int
1242 rte_cryptodev_pmd_create_dev_name(char *name, const char *dev_name_prefix)
1243 {
1244         struct rte_cryptodev *dev = NULL;
1245         uint32_t i = 0;
1246
1247         if (name == NULL)
1248                 return -EINVAL;
1249
1250         for (i = 0; i < RTE_CRYPTO_MAX_DEVS; i++) {
1251                 int ret = snprintf(name, RTE_CRYPTODEV_NAME_MAX_LEN,
1252                                 "%s_%u", dev_name_prefix, i);
1253
1254                 if (ret < 0)
1255                         return ret;
1256
1257                 dev = rte_cryptodev_pmd_get_named_dev(name);
1258                 if (!dev)
1259                         return 0;
1260         }
1261
1262         return -1;
1263 }