drivers/compress/isal/isal_compress_pmd_ops.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2018 Intel Corporation
   3  */
   4 #include <isa-l.h>
   5
   6 #include <rte_common.h>
   7 #include <rte_compressdev_pmd.h>
   8 #include <rte_malloc.h>
   9
  10 #include "isal_compress_pmd_private.h"
  11
  12 static const struct rte_compressdev_capabilities isal_pmd_capabilities[] = {
  13         {
  14                 .algo = RTE_COMP_ALGO_DEFLATE,
  15                 .comp_feature_flags =   RTE_COMP_FF_SHAREABLE_PRIV_XFORM,
  16                 .window_size = {
  17                         .min = 15,
  18                         .max = 15,
  19                         .increment = 0
  20                 },
  21         },
  22         RTE_COMP_END_OF_CAPABILITIES_LIST()
  23 };
  24
  25 /** Configure device */
  26 static int
  27 isal_comp_pmd_config(struct rte_compressdev *dev,
  28                 struct rte_compressdev_config *config)
  29 {
  30         int ret = 0;
  31         unsigned int n;
  32         char mp_name[RTE_COMPRESSDEV_NAME_MAX_LEN];
  33         unsigned int elt_size = sizeof(struct isal_priv_xform);
  34         struct isal_comp_private *internals = dev->data->dev_private;
  35
  36         n = snprintf(mp_name, sizeof(mp_name), "compdev_%d_xform_mp",
  37                         dev->data->dev_id);
  38         if (n > sizeof(mp_name)) {
  39                 ISAL_PMD_LOG(ERR,
  40                         "Unable to create unique name for xform mempool");
  41                 return -ENOMEM;
  42         }
  43
  44         internals->priv_xform_mp = rte_mempool_lookup(mp_name);
  45
  46         if (internals->priv_xform_mp != NULL) {
  47                 if (((internals->priv_xform_mp)->elt_size != elt_size) ||
  48                                 ((internals->priv_xform_mp)->size <
  49                                         config->max_nb_priv_xforms)) {
  50
  51                         ISAL_PMD_LOG(ERR, "%s mempool already exists with different"
  52                                 " initialization parameters", mp_name);
  53                         internals->priv_xform_mp = NULL;
  54                         return -ENOMEM;
  55                 }
  56         } else { /* First time configuration */
  57                 internals->priv_xform_mp = rte_mempool_create(
  58                                 mp_name, /* mempool name */
  59                                 /* number of elements*/
  60                                 config->max_nb_priv_xforms,
  61                                 elt_size, /* element size*/
  62                                 0, /* Cache size*/
  63                                 0, /* private data size */
  64                                 NULL, /* obj initialization constructor */
  65                                 NULL, /* obj initialization constructor arg */
  66                                 NULL, /**< obj constructor*/
  67                                 NULL, /* obj constructor arg */
  68                                 config->socket_id, /* socket id */
  69                                 0); /* flags */
  70         }
  71
  72         if (internals->priv_xform_mp == NULL) {
  73                 ISAL_PMD_LOG(ERR, "%s mempool allocation failed", mp_name);
  74                 return -ENOMEM;
  75         }
  76
  77         dev->data->dev_private = internals;
  78
  79         return ret;
  80 }
  81
  82 /** Start device */
  83 static int
  84 isal_comp_pmd_start(__rte_unused struct rte_compressdev *dev)
  85 {
  86         return 0;
  87 }
  88
  89 /** Stop device */
  90 static void
  91 isal_comp_pmd_stop(__rte_unused struct rte_compressdev *dev)
  92 {
  93 }
  94
  95 /** Close device */
  96 static int
  97 isal_comp_pmd_close(struct rte_compressdev *dev)
  98 {
  99         /* Free private data */
 100         struct isal_comp_private *internals = dev->data->dev_private;
 101
 102         rte_mempool_free(internals->priv_xform_mp);
 103         return 0;
 104 }
 105
 106 /** Get device statistics */
 107 static void
 108 isal_comp_pmd_stats_get(struct rte_compressdev *dev,
 109                 struct rte_compressdev_stats *stats)
 110 {
 111         uint16_t qp_id;
 112
 113         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 114                 struct isal_comp_qp *qp = dev->data->queue_pairs[qp_id];
 115
 116                 stats->enqueued_count += qp->qp_stats.enqueued_count;
 117                 stats->dequeued_count += qp->qp_stats.dequeued_count;
 118
 119                 stats->enqueue_err_count += qp->qp_stats.enqueue_err_count;
 120                 stats->dequeue_err_count += qp->qp_stats.dequeue_err_count;
 121         }
 122 }
 123
 124 /** Get device info */
 125 static void
 126 isal_comp_pmd_info_get(struct rte_compressdev *dev __rte_unused,
 127                 struct rte_compressdev_info *dev_info)
 128 {
 129         if (dev_info != NULL) {
 130                 dev_info->capabilities = isal_pmd_capabilities;
 131                 dev_info->feature_flags = RTE_COMPDEV_FF_CPU_AVX512 |
 132                                 RTE_COMPDEV_FF_CPU_AVX2 |
 133                                 RTE_COMPDEV_FF_CPU_AVX |
 134                                 RTE_COMPDEV_FF_CPU_SSE;
 135         }
 136 }
 137
 138 /** Reset device statistics */
 139 static void
 140 isal_comp_pmd_stats_reset(struct rte_compressdev *dev)
 141 {
 142         uint16_t qp_id;
 143
 144         for (qp_id = 0; qp_id < dev->data->nb_queue_pairs; qp_id++) {
 145                 struct isal_comp_qp *qp = dev->data->queue_pairs[qp_id];
 146                 memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
 147         }
 148 }
 149
 150 /** Release queue pair */
 151 static int
 152 isal_comp_pmd_qp_release(struct rte_compressdev *dev, uint16_t qp_id)
 153 {
 154         struct isal_comp_qp *qp = dev->data->queue_pairs[qp_id];
 155
 156         if (qp == NULL)
 157                 return -EINVAL;
 158
 159         if (qp->stream != NULL)
 160                 rte_free(qp->stream);
 161
 162         if (qp->stream->level_buf != NULL)
 163                 rte_free(qp->stream->level_buf);
 164
 165         if (dev->data->queue_pairs[qp_id] != NULL)
 166                 rte_free(dev->data->queue_pairs[qp_id]);
 167
 168         return 0;
 169 }
 170
 171 /** Create a ring to place process packets on */
 172 static struct rte_ring *
 173 isal_comp_pmd_qp_create_processed_pkts_ring(struct isal_comp_qp *qp,
 174                 unsigned int ring_size, int socket_id)
 175 {
 176         struct rte_ring *r;
 177
 178         r = rte_ring_lookup(qp->name);
 179         if (r) {
 180                 if (rte_ring_get_size(r) >= ring_size) {
 181                         ISAL_PMD_LOG(DEBUG,
 182                                 "Reusing existing ring %s for processed packets",
 183                                 qp->name);
 184                         return r;
 185                 }
 186
 187                         ISAL_PMD_LOG(ERR,
 188                                 "Unable to reuse existing ring %s"
 189                                 " for processed packets",
 190                          qp->name);
 191                 return NULL;
 192         }
 193
 194         return rte_ring_create(qp->name, ring_size, socket_id,
 195                         RING_F_SP_ENQ | RING_F_SC_DEQ);
 196 }
 197
 198 /** set a unique name for the queue pair based on its name, dev_id and qp_id */
 199 static int
 200 isal_comp_pmd_qp_set_unique_name(struct rte_compressdev *dev,
 201 struct isal_comp_qp *qp)
 202 {
 203         unsigned int n = snprintf(qp->name, sizeof(qp->name),
 204                         "isal_compression_pmd_%u_qp_%u",
 205                         dev->data->dev_id, qp->id);
 206
 207         if (n >= sizeof(qp->name))
 208                 return -1;
 209
 210         return 0;
 211 }
 212
 213 /* Setup a queue pair */
 214 static int
 215 isal_comp_pmd_qp_setup(struct rte_compressdev *dev, uint16_t qp_id,
 216                 uint32_t max_inflight_ops, int socket_id)
 217 {
 218         struct isal_comp_qp *qp = NULL;
 219         int retval;
 220
 221         /* Free memory prior to re-allocation if needed. */
 222         if (dev->data->queue_pairs[qp_id] != NULL)
 223                 isal_comp_pmd_qp_release(dev, qp_id);
 224
 225         /* Allocate the queue pair data structure. */
 226         qp = rte_zmalloc_socket("Isa-l compression PMD Queue Pair", sizeof(*qp),
 227                                         RTE_CACHE_LINE_SIZE, socket_id);
 228         if (qp == NULL) {
 229                 ISAL_PMD_LOG(ERR, "Failed to allocate queue pair memory");
 230                 return (-ENOMEM);
 231         }
 232
 233         /* Initialize memory for compression stream structure */
 234         qp->stream = rte_zmalloc_socket("Isa-l compression stream ",
 235                         sizeof(struct isal_zstream),  RTE_CACHE_LINE_SIZE,
 236                         socket_id);
 237
 238         /* Initialize memory for compression level buffer */
 239         qp->stream->level_buf = rte_zmalloc_socket("Isa-l compression lev_buf",
 240                         ISAL_DEF_LVL3_DEFAULT, RTE_CACHE_LINE_SIZE,
 241                         socket_id);
 242
 243         qp->id = qp_id;
 244         dev->data->queue_pairs[qp_id] = qp;
 245
 246         retval = isal_comp_pmd_qp_set_unique_name(dev, qp);
 247         if (retval) {
 248                 ISAL_PMD_LOG(ERR, "Failed to create unique name for isal "
 249                                 "compression device");
 250                 goto qp_setup_cleanup;
 251         }
 252
 253         qp->processed_pkts = isal_comp_pmd_qp_create_processed_pkts_ring(qp,
 254                         max_inflight_ops, socket_id);
 255         if (qp->processed_pkts == NULL) {
 256                 ISAL_PMD_LOG(ERR, "Failed to create unique name for isal "
 257                                 "compression device");
 258                 goto qp_setup_cleanup;
 259         }
 260
 261         qp->num_free_elements = rte_ring_free_count(qp->processed_pkts);
 262
 263         memset(&qp->qp_stats, 0, sizeof(qp->qp_stats));
 264         return 0;
 265
 266 qp_setup_cleanup:
 267         if (qp)
 268                 rte_free(qp);
 269
 270         return -1;
 271 }
 272
 273 /** Set private xform data*/
 274 static int
 275 isal_comp_pmd_priv_xform_create(struct rte_compressdev *dev,
 276                         const struct rte_comp_xform *xform, void **priv_xform)
 277 {
 278         int ret;
 279         struct isal_comp_private *internals = dev->data->dev_private;
 280
 281         if (xform == NULL) {
 282                 ISAL_PMD_LOG(ERR, "Invalid Xform struct");
 283                 return -EINVAL;
 284         }
 285
 286         if (rte_mempool_get(internals->priv_xform_mp, priv_xform)) {
 287                 ISAL_PMD_LOG(ERR,
 288                         "Couldn't get object from private xform mempool");
 289                 return -ENOMEM;
 290         }
 291
 292         ret = isal_comp_set_priv_xform_parameters(*priv_xform, xform);
 293         if (ret != 0) {
 294                 ISAL_PMD_LOG(ERR, "Failed to configure private xform parameters");
 295
 296                 /* Return private xform to mempool */
 297                 rte_mempool_put(internals->priv_xform_mp, priv_xform);
 298                 return ret;
 299         }
 300         return 0;
 301 }
 302
 303 /** Clear memory of the private xform so it doesn't leave key material behind */
 304 static int
 305 isal_comp_pmd_priv_xform_free(struct rte_compressdev *dev, void *priv_xform)
 306 {
 307         struct isal_comp_private *internals = dev->data->dev_private;
 308
 309         /* Zero out the whole structure */
 310         if (priv_xform) {
 311                 memset(priv_xform, 0, sizeof(struct isal_priv_xform));
 312                 rte_mempool_put(internals->priv_xform_mp, priv_xform);
 313         }
 314         return 0;
 315 }
 316
 317 struct rte_compressdev_ops isal_pmd_ops = {
 318                 .dev_configure          = isal_comp_pmd_config,
 319                 .dev_start              = isal_comp_pmd_start,
 320                 .dev_stop               = isal_comp_pmd_stop,
 321                 .dev_close              = isal_comp_pmd_close,
 322
 323                 .stats_get              = isal_comp_pmd_stats_get,
 324                 .stats_reset            = isal_comp_pmd_stats_reset,
 325
 326                 .dev_infos_get          = isal_comp_pmd_info_get,
 327
 328                 .queue_pair_setup       = isal_comp_pmd_qp_setup,
 329                 .queue_pair_release     = isal_comp_pmd_qp_release,
 330
 331                 .private_xform_create   = isal_comp_pmd_priv_xform_create,
 332                 .private_xform_free     = isal_comp_pmd_priv_xform_free,
 333 };
 334
 335 struct rte_compressdev_ops *isal_compress_pmd_ops = &isal_pmd_ops;