1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017-2018 Intel Corporation
9 #include <rte_string_fns.h>
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 static struct rte_compressdev rte_comp_devices[RTE_COMPRESS_MAX_DEVS];
23 static struct rte_compressdev_global compressdev_globals = {
24 .devs = rte_comp_devices,
27 .max_devs = RTE_COMPRESS_MAX_DEVS
30 const struct rte_compressdev_capabilities *
31 rte_compressdev_capability_get(uint8_t dev_id,
32 enum rte_comp_algorithm algo)
34 const struct rte_compressdev_capabilities *capability;
35 struct rte_compressdev_info dev_info;
38 if (dev_id >= compressdev_globals.nb_devs) {
39 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
42 rte_compressdev_info_get(dev_id, &dev_info);
44 while ((capability = &dev_info.capabilities[i++])->algo !=
45 RTE_COMP_ALGO_UNSPECIFIED){
46 if (capability->algo == algo)
54 rte_compressdev_get_feature_name(uint64_t flag)
57 case RTE_COMPDEV_FF_HW_ACCELERATED:
58 return "HW_ACCELERATED";
59 case RTE_COMPDEV_FF_CPU_SSE:
61 case RTE_COMPDEV_FF_CPU_AVX:
63 case RTE_COMPDEV_FF_CPU_AVX2:
65 case RTE_COMPDEV_FF_CPU_AVX512:
67 case RTE_COMPDEV_FF_CPU_NEON:
69 case RTE_COMPDEV_FF_OP_DONE_IN_DEQUEUE:
70 return "OP_DONE_IN_DEQ";
76 static struct rte_compressdev *
77 rte_compressdev_get_dev(uint8_t dev_id)
79 return &compressdev_globals.devs[dev_id];
82 struct rte_compressdev *
83 rte_compressdev_pmd_get_named_dev(const char *name)
85 struct rte_compressdev *dev;
91 for (i = 0; i < compressdev_globals.max_devs; i++) {
92 dev = &compressdev_globals.devs[i];
94 if ((dev->attached == RTE_COMPRESSDEV_ATTACHED) &&
95 (strcmp(dev->data->name, name) == 0))
103 rte_compressdev_is_valid_dev(uint8_t dev_id)
105 struct rte_compressdev *dev = NULL;
107 if (dev_id >= compressdev_globals.nb_devs)
110 dev = rte_compressdev_get_dev(dev_id);
111 if (dev->attached != RTE_COMPRESSDEV_ATTACHED)
119 rte_compressdev_get_dev_id(const char *name)
126 for (i = 0; i < compressdev_globals.nb_devs; i++)
127 if ((strcmp(compressdev_globals.devs[i].data->name, name)
129 (compressdev_globals.devs[i].attached ==
130 RTE_COMPRESSDEV_ATTACHED))
137 rte_compressdev_count(void)
139 return compressdev_globals.nb_devs;
143 rte_compressdev_devices_get(const char *driver_name, uint8_t *devices,
146 uint8_t i, count = 0;
147 struct rte_compressdev *devs = compressdev_globals.devs;
148 uint8_t max_devs = compressdev_globals.max_devs;
150 for (i = 0; i < max_devs && count < nb_devices; i++) {
152 if (devs[i].attached == RTE_COMPRESSDEV_ATTACHED) {
155 cmp = strncmp(devs[i].device->driver->name,
157 strlen(driver_name));
160 devices[count++] = devs[i].data->dev_id;
168 rte_compressdev_socket_id(uint8_t dev_id)
170 struct rte_compressdev *dev;
172 if (!rte_compressdev_is_valid_dev(dev_id))
175 dev = rte_compressdev_get_dev(dev_id);
177 return dev->data->socket_id;
181 rte_compressdev_data_alloc(uint8_t dev_id, struct rte_compressdev_data **data,
184 char mz_name[RTE_COMPRESSDEV_NAME_MAX_LEN];
185 const struct rte_memzone *mz;
188 /* generate memzone name */
189 n = snprintf(mz_name, sizeof(mz_name),
190 "rte_compressdev_data_%u", dev_id);
191 if (n >= (int)sizeof(mz_name))
194 if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
195 mz = rte_memzone_reserve(mz_name,
196 sizeof(struct rte_compressdev_data),
199 mz = rte_memzone_lookup(mz_name);
205 if (rte_eal_process_type() == RTE_PROC_PRIMARY)
206 memset(*data, 0, sizeof(struct rte_compressdev_data));
212 rte_compressdev_find_free_device_index(void)
216 for (dev_id = 0; dev_id < RTE_COMPRESS_MAX_DEVS; dev_id++) {
217 if (rte_comp_devices[dev_id].attached ==
218 RTE_COMPRESSDEV_DETACHED)
221 return RTE_COMPRESS_MAX_DEVS;
224 struct rte_compressdev *
225 rte_compressdev_pmd_allocate(const char *name, int socket_id)
227 struct rte_compressdev *compressdev;
230 if (rte_compressdev_pmd_get_named_dev(name) != NULL) {
232 "comp device with name %s already allocated!", name);
236 dev_id = rte_compressdev_find_free_device_index();
237 if (dev_id == RTE_COMPRESS_MAX_DEVS) {
238 COMPRESSDEV_LOG(ERR, "Reached maximum number of comp devices");
241 compressdev = rte_compressdev_get_dev(dev_id);
243 if (compressdev->data == NULL) {
244 struct rte_compressdev_data *compressdev_data =
245 compressdev_globals.data[dev_id];
247 int retval = rte_compressdev_data_alloc(dev_id,
248 &compressdev_data, socket_id);
250 if (retval < 0 || compressdev_data == NULL)
253 compressdev->data = compressdev_data;
255 strlcpy(compressdev->data->name, name,
256 RTE_COMPRESSDEV_NAME_MAX_LEN);
258 compressdev->data->dev_id = dev_id;
259 compressdev->data->socket_id = socket_id;
260 compressdev->data->dev_started = 0;
262 compressdev->attached = RTE_COMPRESSDEV_ATTACHED;
264 compressdev_globals.nb_devs++;
271 rte_compressdev_pmd_release_device(struct rte_compressdev *compressdev)
275 if (compressdev == NULL)
278 /* Close device only if device operations have been set */
279 if (compressdev->dev_ops) {
280 ret = rte_compressdev_close(compressdev->data->dev_id);
285 compressdev->attached = RTE_COMPRESSDEV_DETACHED;
286 compressdev_globals.nb_devs--;
291 rte_compressdev_queue_pair_count(uint8_t dev_id)
293 struct rte_compressdev *dev;
295 dev = &rte_comp_devices[dev_id];
296 return dev->data->nb_queue_pairs;
300 rte_compressdev_queue_pairs_config(struct rte_compressdev *dev,
301 uint16_t nb_qpairs, int socket_id)
303 struct rte_compressdev_info dev_info;
307 if ((dev == NULL) || (nb_qpairs < 1)) {
308 COMPRESSDEV_LOG(ERR, "invalid param: dev %p, nb_queues %u",
313 COMPRESSDEV_LOG(DEBUG, "Setup %d queues pairs on device %u",
314 nb_qpairs, dev->data->dev_id);
316 memset(&dev_info, 0, sizeof(struct rte_compressdev_info));
318 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_infos_get, -ENOTSUP);
319 (*dev->dev_ops->dev_infos_get)(dev, &dev_info);
321 if ((dev_info.max_nb_queue_pairs != 0) &&
322 (nb_qpairs > dev_info.max_nb_queue_pairs)) {
323 COMPRESSDEV_LOG(ERR, "Invalid num queue_pairs (%u) for dev %u",
324 nb_qpairs, dev->data->dev_id);
328 if (dev->data->queue_pairs == NULL) { /* first time configuration */
329 dev->data->queue_pairs = rte_zmalloc_socket(
330 "compressdev->queue_pairs",
331 sizeof(dev->data->queue_pairs[0]) * nb_qpairs,
332 RTE_CACHE_LINE_SIZE, socket_id);
334 if (dev->data->queue_pairs == NULL) {
335 dev->data->nb_queue_pairs = 0;
337 "failed to get memory for qp meta data, nb_queues %u",
341 } else { /* re-configure */
343 uint16_t old_nb_queues = dev->data->nb_queue_pairs;
345 qp = dev->data->queue_pairs;
347 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
350 for (i = nb_qpairs; i < old_nb_queues; i++) {
351 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
356 qp = rte_realloc(qp, sizeof(qp[0]) * nb_qpairs,
357 RTE_CACHE_LINE_SIZE);
360 "failed to realloc qp meta data, nb_queues %u",
365 if (nb_qpairs > old_nb_queues) {
366 uint16_t new_qs = nb_qpairs - old_nb_queues;
368 memset(qp + old_nb_queues, 0,
369 sizeof(qp[0]) * new_qs);
372 dev->data->queue_pairs = qp;
375 dev->data->nb_queue_pairs = nb_qpairs;
380 rte_compressdev_queue_pairs_release(struct rte_compressdev *dev)
386 COMPRESSDEV_LOG(ERR, "invalid param: dev %p", dev);
390 num_qps = dev->data->nb_queue_pairs;
395 COMPRESSDEV_LOG(DEBUG, "Free %d queues pairs on device %u",
396 dev->data->nb_queue_pairs, dev->data->dev_id);
398 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_release,
401 for (i = 0; i < num_qps; i++) {
402 ret = (*dev->dev_ops->queue_pair_release)(dev, i);
407 rte_free(dev->data->queue_pairs);
408 dev->data->queue_pairs = NULL;
409 dev->data->nb_queue_pairs = 0;
415 rte_compressdev_configure(uint8_t dev_id, struct rte_compressdev_config *config)
417 struct rte_compressdev *dev;
420 if (!rte_compressdev_is_valid_dev(dev_id)) {
421 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
425 dev = &rte_comp_devices[dev_id];
427 if (dev->data->dev_started) {
429 "device %d must be stopped to allow configuration", dev_id);
433 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
435 /* Setup new number of queue pairs and reconfigure device. */
436 diag = rte_compressdev_queue_pairs_config(dev, config->nb_queue_pairs,
440 "dev%d rte_comp_dev_queue_pairs_config = %d",
445 return (*dev->dev_ops->dev_configure)(dev, config);
449 rte_compressdev_start(uint8_t dev_id)
451 struct rte_compressdev *dev;
454 COMPRESSDEV_LOG(DEBUG, "Start dev_id=%" PRIu8, dev_id);
456 if (!rte_compressdev_is_valid_dev(dev_id)) {
457 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
461 dev = &rte_comp_devices[dev_id];
463 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
465 if (dev->data->dev_started != 0) {
467 "Device with dev_id=%" PRIu8 " already started", dev_id);
471 diag = (*dev->dev_ops->dev_start)(dev);
473 dev->data->dev_started = 1;
481 rte_compressdev_stop(uint8_t dev_id)
483 struct rte_compressdev *dev;
485 if (!rte_compressdev_is_valid_dev(dev_id)) {
486 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
490 dev = &rte_comp_devices[dev_id];
492 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
494 if (dev->data->dev_started == 0) {
496 "Device with dev_id=%" PRIu8 " already stopped", dev_id);
500 (*dev->dev_ops->dev_stop)(dev);
501 dev->data->dev_started = 0;
505 rte_compressdev_close(uint8_t dev_id)
507 struct rte_compressdev *dev;
510 if (!rte_compressdev_is_valid_dev(dev_id)) {
511 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
515 dev = &rte_comp_devices[dev_id];
517 /* Device must be stopped before it can be closed */
518 if (dev->data->dev_started == 1) {
519 COMPRESSDEV_LOG(ERR, "Device %u must be stopped before closing",
524 /* Free queue pairs memory */
525 retval = rte_compressdev_queue_pairs_release(dev);
530 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
531 retval = (*dev->dev_ops->dev_close)(dev);
540 rte_compressdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
541 uint32_t max_inflight_ops, int socket_id)
543 struct rte_compressdev *dev;
545 if (!rte_compressdev_is_valid_dev(dev_id)) {
546 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
550 dev = &rte_comp_devices[dev_id];
551 if (queue_pair_id >= dev->data->nb_queue_pairs) {
552 COMPRESSDEV_LOG(ERR, "Invalid queue_pair_id=%d", queue_pair_id);
556 if (dev->data->dev_started) {
558 "device %d must be stopped to allow configuration", dev_id);
562 if (max_inflight_ops == 0) {
564 "Invalid maximum number of inflight operations");
568 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->queue_pair_setup, -ENOTSUP);
570 return (*dev->dev_ops->queue_pair_setup)(dev, queue_pair_id,
571 max_inflight_ops, socket_id);
575 rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
576 struct rte_comp_op **ops, uint16_t nb_ops)
578 struct rte_compressdev *dev = &rte_comp_devices[dev_id];
580 nb_ops = (*dev->dequeue_burst)
581 (dev->data->queue_pairs[qp_id], ops, nb_ops);
587 rte_compressdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
588 struct rte_comp_op **ops, uint16_t nb_ops)
590 struct rte_compressdev *dev = &rte_comp_devices[dev_id];
592 return (*dev->enqueue_burst)(
593 dev->data->queue_pairs[qp_id], ops, nb_ops);
597 rte_compressdev_stats_get(uint8_t dev_id, struct rte_compressdev_stats *stats)
599 struct rte_compressdev *dev;
601 if (!rte_compressdev_is_valid_dev(dev_id)) {
602 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
607 COMPRESSDEV_LOG(ERR, "Invalid stats ptr");
611 dev = &rte_comp_devices[dev_id];
612 memset(stats, 0, sizeof(*stats));
614 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stats_get, -ENOTSUP);
615 (*dev->dev_ops->stats_get)(dev, stats);
620 rte_compressdev_stats_reset(uint8_t dev_id)
622 struct rte_compressdev *dev;
624 if (!rte_compressdev_is_valid_dev(dev_id)) {
625 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
629 dev = &rte_comp_devices[dev_id];
631 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->stats_reset);
632 (*dev->dev_ops->stats_reset)(dev);
637 rte_compressdev_info_get(uint8_t dev_id, struct rte_compressdev_info *dev_info)
639 struct rte_compressdev *dev;
641 if (dev_id >= compressdev_globals.nb_devs) {
642 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
646 dev = &rte_comp_devices[dev_id];
648 memset(dev_info, 0, sizeof(struct rte_compressdev_info));
650 RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
651 (*dev->dev_ops->dev_infos_get)(dev, dev_info);
653 dev_info->driver_name = dev->device->driver->name;
657 rte_compressdev_private_xform_create(uint8_t dev_id,
658 const struct rte_comp_xform *xform,
661 struct rte_compressdev *dev;
664 dev = rte_compressdev_get_dev(dev_id);
666 if (xform == NULL || priv_xform == NULL || dev == NULL)
669 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->private_xform_create, -ENOTSUP);
670 ret = (*dev->dev_ops->private_xform_create)(dev, xform, priv_xform);
673 "dev_id %d failed to create private_xform: err=%d",
682 rte_compressdev_private_xform_free(uint8_t dev_id, void *priv_xform)
684 struct rte_compressdev *dev;
687 dev = rte_compressdev_get_dev(dev_id);
689 if (dev == NULL || priv_xform == NULL)
692 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->private_xform_free, -ENOTSUP);
693 ret = dev->dev_ops->private_xform_free(dev, priv_xform);
696 "dev_id %d failed to free private xform: err=%d",
705 rte_compressdev_stream_create(uint8_t dev_id,
706 const struct rte_comp_xform *xform,
709 struct rte_compressdev *dev;
712 dev = rte_compressdev_get_dev(dev_id);
714 if (xform == NULL || dev == NULL || stream == NULL)
717 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stream_create, -ENOTSUP);
718 ret = (*dev->dev_ops->stream_create)(dev, xform, stream);
721 "dev_id %d failed to create stream: err=%d",
731 rte_compressdev_stream_free(uint8_t dev_id, void *stream)
733 struct rte_compressdev *dev;
736 dev = rte_compressdev_get_dev(dev_id);
738 if (dev == NULL || stream == NULL)
741 RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->stream_free, -ENOTSUP);
742 ret = dev->dev_ops->stream_free(dev, stream);
745 "dev_id %d failed to free stream: err=%d",
754 rte_compressdev_name_get(uint8_t dev_id)
756 struct rte_compressdev *dev = rte_compressdev_get_dev(dev_id);
761 return dev->data->name;
764 RTE_LOG_REGISTER_DEFAULT(compressdev_logtype, NOTICE);