1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017-2018 Intel Corporation
10 #include <rte_malloc.h>
12 #include <rte_memzone.h>
14 #include "rte_compressdev.h"
15 #include "rte_compressdev_internal.h"
16 #include "rte_compressdev_pmd.h"
18 #define RTE_COMPRESSDEV_DETACHED (0)
19 #define RTE_COMPRESSDEV_ATTACHED (1)
21 struct rte_compressdev rte_comp_devices[RTE_COMPRESS_MAX_DEVS];
23 struct rte_compressdev *rte_compressdevs = &rte_comp_devices[0];
25 static struct rte_compressdev_global compressdev_globals = {
26 .devs = &rte_comp_devices[0],
29 .max_devs = RTE_COMPRESS_MAX_DEVS
32 struct rte_compressdev_global *rte_compressdev_globals = &compressdev_globals;
34 const struct rte_compressdev_capabilities * __rte_experimental
35 rte_compressdev_capability_get(uint8_t dev_id,
36 enum rte_comp_algorithm algo)
38 const struct rte_compressdev_capabilities *capability;
39 struct rte_compressdev_info dev_info;
42 if (dev_id >= compressdev_globals.nb_devs) {
43 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
46 rte_compressdev_info_get(dev_id, &dev_info);
48 while ((capability = &dev_info.capabilities[i++])->algo !=
49 RTE_COMP_ALGO_UNSPECIFIED){
50 if (capability->algo == algo)
57 const char * __rte_experimental
58 rte_compressdev_get_feature_name(uint64_t flag)
61 case RTE_COMPDEV_FF_HW_ACCELERATED:
62 return "HW_ACCELERATED";
63 case RTE_COMPDEV_FF_CPU_SSE:
65 case RTE_COMPDEV_FF_CPU_AVX:
67 case RTE_COMPDEV_FF_CPU_AVX2:
69 case RTE_COMPDEV_FF_CPU_AVX512:
71 case RTE_COMPDEV_FF_CPU_NEON:
78 static struct rte_compressdev *
79 rte_compressdev_get_dev(uint8_t dev_id)
81 return &rte_compressdev_globals->devs[dev_id];
84 struct rte_compressdev * __rte_experimental
85 rte_compressdev_pmd_get_named_dev(const char *name)
87 struct rte_compressdev *dev;
93 for (i = 0; i < rte_compressdev_globals->max_devs; i++) {
94 dev = &rte_compressdev_globals->devs[i];
96 if ((dev->attached == RTE_COMPRESSDEV_ATTACHED) &&
97 (strcmp(dev->data->name, name) == 0))
105 rte_compressdev_is_valid_dev(uint8_t dev_id)
107 struct rte_compressdev *dev = NULL;
109 if (dev_id >= rte_compressdev_globals->nb_devs)
112 dev = rte_compressdev_get_dev(dev_id);
113 if (dev->attached != RTE_COMPRESSDEV_ATTACHED)
120 uint8_t __rte_experimental
121 rte_compressdev_count(void)
123 return rte_compressdev_globals->nb_devs;
126 uint8_t __rte_experimental
127 rte_compressdev_devices_get(const char *driver_name, uint8_t *devices,
130 uint8_t i, count = 0;
131 struct rte_compressdev *devs = rte_compressdev_globals->devs;
132 uint8_t max_devs = rte_compressdev_globals->max_devs;
134 for (i = 0; i < max_devs && count < nb_devices; i++) {
136 if (devs[i].attached == RTE_COMPRESSDEV_ATTACHED) {
139 cmp = strncmp(devs[i].device->driver->name,
141 strlen(driver_name));
144 devices[count++] = devs[i].data->dev_id;
151 int __rte_experimental
152 rte_compressdev_socket_id(uint8_t dev_id)
154 struct rte_compressdev *dev;
156 if (!rte_compressdev_is_valid_dev(dev_id))
159 dev = rte_compressdev_get_dev(dev_id);
161 return dev->data->socket_id;
165 rte_compressdev_data_alloc(uint8_t dev_id, struct rte_compressdev_data **data,
168 char mz_name[RTE_COMPRESSDEV_NAME_MAX_LEN];
169 const struct rte_memzone *mz;
172 /* generate memzone name */
173 n = snprintf(mz_name, sizeof(mz_name),
174 "rte_compressdev_data_%u", dev_id);
175 if (n >= (int)sizeof(mz_name))
178 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
179 mz = rte_memzone_reserve(mz_name,
180 sizeof(struct rte_compressdev_data),
183 mz = rte_memzone_lookup(mz_name);
189 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
190 memset(*data, 0, sizeof(struct rte_compressdev_data));
196 rte_compressdev_find_free_device_index(void)
200 for (dev_id = 0; dev_id < RTE_COMPRESS_MAX_DEVS; dev_id++) {
201 if (rte_comp_devices[dev_id].attached ==
202 RTE_COMPRESSDEV_DETACHED)
205 return RTE_COMPRESS_MAX_DEVS;
208 struct rte_compressdev * __rte_experimental
209 rte_compressdev_pmd_allocate(const char *name, int socket_id)
211 struct rte_compressdev *compressdev;
214 if (rte_compressdev_pmd_get_named_dev(name) != NULL) {
216 "comp device with name %s already allocated!", name);
220 dev_id = rte_compressdev_find_free_device_index();
221 if (dev_id == RTE_COMPRESS_MAX_DEVS) {
222 COMPRESSDEV_LOG(ERR, "Reached maximum number of comp devices");
225 compressdev = rte_compressdev_get_dev(dev_id);
227 if (compressdev->data == NULL) {
228 struct rte_compressdev_data *compressdev_data =
229 compressdev_globals.data[dev_id];
231 int retval = rte_compressdev_data_alloc(dev_id,
232 &compressdev_data, socket_id);
234 if (retval < 0 || compressdev_data == NULL)
237 compressdev->data = compressdev_data;
239 snprintf(compressdev->data->name, RTE_COMPRESSDEV_NAME_MAX_LEN,
242 compressdev->data->dev_id = dev_id;
243 compressdev->data->socket_id = socket_id;
244 compressdev->data->dev_started = 0;
246 compressdev->attached = RTE_COMPRESSDEV_ATTACHED;
248 compressdev_globals.nb_devs++;
254 int __rte_experimental
255 rte_compressdev_pmd_release_device(struct rte_compressdev *compressdev)
259 if (compressdev == NULL)
262 /* Close device only if device operations have been set */
263 if (compressdev->dev_ops) {
264 ret = rte_compressdev_close(compressdev->data->dev_id);
269 compressdev->attached = RTE_COMPRESSDEV_DETACHED;
270 compressdev_globals.nb_devs--;
274 uint16_t __rte_experimental
275 rte_compressdev_queue_pair_count(uint8_t dev_id)
277 struct rte_compressdev *dev;
279 dev = &rte_comp_devices[dev_id];
280 return dev->data->nb_queue_pairs;
284 rte_compressdev_queue_pairs_config(struct rte_compressdev *dev,
285 uint16_t nb_qpairs, int socket_id)
287 struct rte_compressdev_info dev_info;
291 if ((dev == NULL) || (nb_qpairs < 1)) {
292 COMPRESSDEV_LOG(ERR, "invalid param: dev %p, nb_queues %u",
297 COMPRESSDEV_LOG(DEBUG, "Setup %d queues pairs on device %u",
298 nb_qpairs, dev->data->dev_id);
300 memset(&dev_info, 0, sizeof(struct rte_compressdev_info));
302 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
303 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
305 if ((dev_info.max_nb_queue_pairs != 0) &&
306 (nb_qpairs > dev_info.max_nb_queue_pairs)) {
307 COMPRESSDEV_LOG(ERR, "Invalid num queue_pairs (%u) for dev %u",
308 nb_qpairs, dev->data->dev_id);
312 if (dev->data->queue_pairs == NULL) { /* first time configuration */
313 dev->data->queue_pairs = rte_zmalloc_socket(
314 "compressdev->queue_pairs",
315 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
316 RTE_CACHE_LINE_SIZE, socket_id);
318 if (dev->data->queue_pairs == NULL) {
319 dev->data->nb_queue_pairs = 0;
321 "failed to get memory for qp meta data, nb_queues %u",
325 } else { /* re-configure */
327 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
329 qp = dev->data->queue_pairs;
331 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
334 for (i = nb_qpairs; i < old_nb_queues; i++) {
335 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
340 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
341 RTE_CACHE_LINE_SIZE);
344 "failed to realloc qp meta data, nb_queues %u",
349 if (nb_qpairs > old_nb_queues) {
350 uint16_t new_qs = nb_qpairs - old_nb_queues;
352 memset(qp + old_nb_queues, 0,
353 sizeof(qp[0]) * new_qs);
356 dev->data->queue_pairs = qp;
359 dev->data->nb_queue_pairs = nb_qpairs;
364 rte_compressdev_queue_pairs_release(struct rte_compressdev *dev)
370 COMPRESSDEV_LOG(ERR, "invalid param: dev %p", dev);
374 num_qps = dev->data->nb_queue_pairs;
379 COMPRESSDEV_LOG(DEBUG, "Free %d queues pairs on device %u",
380 dev->data->nb_queue_pairs, dev->data->dev_id);
382 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
385 for (i = 0; i < num_qps; i++) {
386 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
391 if (dev->data->queue_pairs != NULL)
392 rte_free(dev->data->queue_pairs);
393 dev->data->queue_pairs = NULL;
394 dev->data->nb_queue_pairs = 0;
399 int __rte_experimental
400 rte_compressdev_configure(uint8_t dev_id, struct rte_compressdev_config *config)
402 struct rte_compressdev *dev;
405 if (!rte_compressdev_is_valid_dev(dev_id)) {
406 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
410 dev = &rte_comp_devices[dev_id];
412 if (dev->data->dev_started) {
414 "device %d must be stopped to allow configuration", dev_id);
418 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
420 /* Setup new number of queue pairs and reconfigure device. */
421 diag = rte_compressdev_queue_pairs_config(dev, config->nb_queue_pairs,
425 "dev%d rte_comp_dev_queue_pairs_config = %d",
430 return (*dev->dev_ops->dev_configure)(dev, config);
433 int __rte_experimental
434 rte_compressdev_start(uint8_t dev_id)
436 struct rte_compressdev *dev;
439 COMPRESSDEV_LOG(DEBUG, "Start dev_id=%" PRIu8, dev_id);
441 if (!rte_compressdev_is_valid_dev(dev_id)) {
442 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
446 dev = &rte_comp_devices[dev_id];
448 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
450 if (dev->data->dev_started != 0) {
452 "Device with dev_id=%" PRIu8 " already started", dev_id);
456 diag = (*dev->dev_ops->dev_start)(dev);
458 dev->data->dev_started = 1;
465 void __rte_experimental
466 rte_compressdev_stop(uint8_t dev_id)
468 struct rte_compressdev *dev;
470 if (!rte_compressdev_is_valid_dev(dev_id)) {
471 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
475 dev = &rte_comp_devices[dev_id];
477 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
479 if (dev->data->dev_started == 0) {
481 "Device with dev_id=%" PRIu8 " already stopped", dev_id);
485 (*dev->dev_ops->dev_stop)(dev);
486 dev->data->dev_started = 0;
489 int __rte_experimental
490 rte_compressdev_close(uint8_t dev_id)
492 struct rte_compressdev *dev;
495 if (!rte_compressdev_is_valid_dev(dev_id)) {
496 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
500 dev = &rte_comp_devices[dev_id];
502 /* Device must be stopped before it can be closed */
503 if (dev->data->dev_started == 1) {
504 COMPRESSDEV_LOG(ERR, "Device %u must be stopped before closing",
509 /* Free queue pairs memory */
510 retval = rte_compressdev_queue_pairs_release(dev);
515 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
516 retval = (*dev->dev_ops->dev_close)(dev);
524 int __rte_experimental
525 rte_compressdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
526 uint32_t max_inflight_ops, int socket_id)
528 struct rte_compressdev *dev;
530 if (!rte_compressdev_is_valid_dev(dev_id)) {
531 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
535 dev = &rte_comp_devices[dev_id];
536 if (queue_pair_id >= dev->data->nb_queue_pairs) {
537 COMPRESSDEV_LOG(ERR, "Invalid queue_pair_id=%d", queue_pair_id);
541 if (dev->data->dev_started) {
543 "device %d must be stopped to allow configuration", dev_id);
547 if (max_inflight_ops == 0) {
549 "Invalid maximum number of inflight operations");
553 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
555 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id,
556 max_inflight_ops, socket_id);
559 uint16_t __rte_experimental
560 rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
561 struct rte_comp_op **ops, uint16_t nb_ops)
563 struct rte_compressdev *dev = &rte_compressdevs[dev_id];
565 nb_ops = (*dev->dequeue_burst)
566 (dev->data->queue_pairs[qp_id], ops, nb_ops);
571 uint16_t __rte_experimental
572 rte_compressdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
573 struct rte_comp_op **ops, uint16_t nb_ops)
575 struct rte_compressdev *dev = &rte_compressdevs[dev_id];
577 return (*dev->enqueue_burst)(
578 dev->data->queue_pairs[qp_id], ops, nb_ops);
581 int __rte_experimental
582 rte_compressdev_stats_get(uint8_t dev_id, struct rte_compressdev_stats *stats)
584 struct rte_compressdev *dev;
586 if (!rte_compressdev_is_valid_dev(dev_id)) {
587 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
592 COMPRESSDEV_LOG(ERR, "Invalid stats ptr");
596 dev = &rte_comp_devices[dev_id];
597 memset(stats, 0, sizeof(*stats));
599 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
600 (*dev->dev_ops->stats_get)(dev, stats);
604 void __rte_experimental
605 rte_compressdev_stats_reset(uint8_t dev_id)
607 struct rte_compressdev *dev;
609 if (!rte_compressdev_is_valid_dev(dev_id)) {
610 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
614 dev = &rte_comp_devices[dev_id];
616 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
617 (*dev->dev_ops->stats_reset)(dev);
621 void __rte_experimental
622 rte_compressdev_info_get(uint8_t dev_id, struct rte_compressdev_info *dev_info)
624 struct rte_compressdev *dev;
626 if (dev_id >= compressdev_globals.nb_devs) {
627 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
631 dev = &rte_comp_devices[dev_id];
633 memset(dev_info, 0, sizeof(struct rte_compressdev_info));
635 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
636 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
638 dev_info->driver_name = dev->device->driver->name;
641 int __rte_experimental
642 rte_compressdev_private_xform_create(uint8_t dev_id,
643 const struct rte_comp_xform *xform,
646 struct rte_compressdev *dev;
649 dev = rte_compressdev_get_dev(dev_id);
651 if (xform == NULL || priv_xform == NULL || dev == NULL)
654 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->private_xform_create, -ENOTSUP);
655 ret = (*dev->dev_ops->private_xform_create)(dev, xform, priv_xform);
658 "dev_id %d failed to create private_xform: err=%d",
666 int __rte_experimental
667 rte_compressdev_private_xform_free(uint8_t dev_id, void *priv_xform)
669 struct rte_compressdev *dev;
672 dev = rte_compressdev_get_dev(dev_id);
674 if (dev == NULL || priv_xform == NULL)
677 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->private_xform_free, -ENOTSUP);
678 ret = dev->dev_ops->private_xform_free(dev, priv_xform);
681 "dev_id %d failed to free private xform: err=%d",
689 int __rte_experimental
690 rte_compressdev_stream_create(uint8_t dev_id,
691 const struct rte_comp_xform *xform,
694 struct rte_compressdev *dev;
697 dev = rte_compressdev_get_dev(dev_id);
699 if (xform == NULL || dev == NULL || stream == NULL)
702 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stream_create, -ENOTSUP);
703 ret = (*dev->dev_ops->stream_create)(dev, xform, stream);
706 "dev_id %d failed to create stream: err=%d",
715 int __rte_experimental
716 rte_compressdev_stream_free(uint8_t dev_id, void *stream)
718 struct rte_compressdev *dev;
721 dev = rte_compressdev_get_dev(dev_id);
723 if (dev == NULL || stream == NULL)
726 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stream_free, -ENOTSUP);
727 ret = dev->dev_ops->stream_free(dev, stream);
730 "dev_id %d failed to free stream: err=%d",
738 const char * __rte_experimental
739 rte_compressdev_name_get(uint8_t dev_id)
741 struct rte_compressdev *dev = rte_compressdev_get_dev(dev_id);
746 return dev->data->name;
749 RTE_INIT(rte_compressdev_log);
752 rte_compressdev_log(void)
754 compressdev_logtype = rte_log_register("lib.compressdev");
755 if (compressdev_logtype >= 0)
756 rte_log_set_level(compressdev_logtype, RTE_LOG_NOTICE);