lib/librte_compressdev/rte_compressdev.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2017-2018 Intel Corporation
   3  */
   4
   5 #include <string.h>
   6 #include <stdarg.h>
   7 #include <stdio.h>
   8 #include <inttypes.h>
   9
  10 #include <rte_malloc.h>
  11 #include <rte_eal.h>
  12 #include <rte_memzone.h>
  13
  14 #include "rte_compressdev.h"
  15 #include "rte_compressdev_internal.h"
  16 #include "rte_compressdev_pmd.h"
  17
  18 #define RTE_COMPRESSDEV_DETACHED  (0)
  19 #define RTE_COMPRESSDEV_ATTACHED  (1)
  20
  21 struct rte_compressdev rte_comp_devices[RTE_COMPRESS_MAX_DEVS];
  22
  23 struct rte_compressdev *rte_compressdevs = &rte_comp_devices[0];
  24
  25 static struct rte_compressdev_global compressdev_globals = {
  26                 .devs                   = &rte_comp_devices[0],
  27                 .data                   = { NULL },
  28                 .nb_devs                = 0,
  29                 .max_devs               = RTE_COMPRESS_MAX_DEVS
  30 };
  31
  32 struct rte_compressdev_global *rte_compressdev_globals = &compressdev_globals;
  33
  34 static struct rte_compressdev *
  35 rte_compressdev_get_dev(uint8_t dev_id)
  36 {
  37         return &rte_compressdev_globals->devs[dev_id];
  38 }
  39
  40 struct rte_compressdev * __rte_experimental
  41 rte_compressdev_pmd_get_named_dev(const char *name)
  42 {
  43         struct rte_compressdev *dev;
  44         unsigned int i;
  45
  46         if (name == NULL)
  47                 return NULL;
  48
  49         for (i = 0; i < rte_compressdev_globals->max_devs; i++) {
  50                 dev = &rte_compressdev_globals->devs[i];
  51
  52                 if ((dev->attached == RTE_COMPRESSDEV_ATTACHED) &&
  53                                 (strcmp(dev->data->name, name) == 0))
  54                         return dev;
  55         }
  56
  57         return NULL;
  58 }
  59
  60 static unsigned int
  61 rte_compressdev_is_valid_dev(uint8_t dev_id)
  62 {
  63         struct rte_compressdev *dev = NULL;
  64
  65         if (dev_id >= rte_compressdev_globals->nb_devs)
  66                 return 0;
  67
  68         dev = rte_compressdev_get_dev(dev_id);
  69         if (dev->attached != RTE_COMPRESSDEV_ATTACHED)
  70                 return 0;
  71         else
  72                 return 1;
  73 }
  74
  75
  76 uint8_t __rte_experimental
  77 rte_compressdev_count(void)
  78 {
  79         return rte_compressdev_globals->nb_devs;
  80 }
  81
  82 uint8_t __rte_experimental
  83 rte_compressdev_devices_get(const char *driver_name, uint8_t *devices,
  84         uint8_t nb_devices)
  85 {
  86         uint8_t i, count = 0;
  87         struct rte_compressdev *devs = rte_compressdev_globals->devs;
  88         uint8_t max_devs = rte_compressdev_globals->max_devs;
  89
  90         for (i = 0; i < max_devs && count < nb_devices; i++) {
  91
  92                 if (devs[i].attached == RTE_COMPRESSDEV_ATTACHED) {
  93                         int cmp;
  94
  95                         cmp = strncmp(devs[i].device->driver->name,
  96                                         driver_name,
  97                                         strlen(driver_name));
  98
  99                         if (cmp == 0)
 100                                 devices[count++] = devs[i].data->dev_id;
 101                 }
 102         }
 103
 104         return count;
 105 }
 106
 107 int __rte_experimental
 108 rte_compressdev_socket_id(uint8_t dev_id)
 109 {
 110         struct rte_compressdev *dev;
 111
 112         if (!rte_compressdev_is_valid_dev(dev_id))
 113                 return -1;
 114
 115         dev = rte_compressdev_get_dev(dev_id);
 116
 117         return dev->data->socket_id;
 118 }
 119
 120 static inline int
 121 rte_compressdev_data_alloc(uint8_t dev_id, struct rte_compressdev_data **data,
 122                 int socket_id)
 123 {
 124         char mz_name[RTE_COMPRESSDEV_NAME_MAX_LEN];
 125         const struct rte_memzone *mz;
 126         int n;
 127
 128         /* generate memzone name */
 129         n = snprintf(mz_name, sizeof(mz_name),
 130                         "rte_compressdev_data_%u", dev_id);
 131         if (n >= (int)sizeof(mz_name))
 132                 return -EINVAL;
 133
 134         if (rte_eal_process_type() == RTE_PROC_PRIMARY) {
 135                 mz = rte_memzone_reserve(mz_name,
 136                                 sizeof(struct rte_compressdev_data),
 137                                 socket_id, 0);
 138         } else
 139                 mz = rte_memzone_lookup(mz_name);
 140
 141         if (mz == NULL)
 142                 return -ENOMEM;
 143
 144         *data = mz->addr;
 145         if (rte_eal_process_type() == RTE_PROC_PRIMARY)
 146                 memset(*data, 0, sizeof(struct rte_compressdev_data));
 147
 148         return 0;
 149 }
 150
 151 static uint8_t
 152 rte_compressdev_find_free_device_index(void)
 153 {
 154         uint8_t dev_id;
 155
 156         for (dev_id = 0; dev_id < RTE_COMPRESS_MAX_DEVS; dev_id++) {
 157                 if (rte_comp_devices[dev_id].attached ==
 158                                 RTE_COMPRESSDEV_DETACHED)
 159                         return dev_id;
 160         }
 161         return RTE_COMPRESS_MAX_DEVS;
 162 }
 163
 164 struct rte_compressdev * __rte_experimental
 165 rte_compressdev_pmd_allocate(const char *name, int socket_id)
 166 {
 167         struct rte_compressdev *compressdev;
 168         uint8_t dev_id;
 169
 170         if (rte_compressdev_pmd_get_named_dev(name) != NULL) {
 171                 COMPRESSDEV_LOG(ERR,
 172                         "comp device with name %s already allocated!", name);
 173                 return NULL;
 174         }
 175
 176         dev_id = rte_compressdev_find_free_device_index();
 177         if (dev_id == RTE_COMPRESS_MAX_DEVS) {
 178                 COMPRESSDEV_LOG(ERR, "Reached maximum number of comp devices");
 179                 return NULL;
 180         }
 181         compressdev = rte_compressdev_get_dev(dev_id);
 182
 183         if (compressdev->data == NULL) {
 184                 struct rte_compressdev_data *compressdev_data =
 185                                 compressdev_globals.data[dev_id];
 186
 187                 int retval = rte_compressdev_data_alloc(dev_id,
 188                                 &compressdev_data, socket_id);
 189
 190                 if (retval < 0 || compressdev_data == NULL)
 191                         return NULL;
 192
 193                 compressdev->data = compressdev_data;
 194
 195                 snprintf(compressdev->data->name, RTE_COMPRESSDEV_NAME_MAX_LEN,
 196                                 "%s", name);
 197
 198                 compressdev->data->dev_id = dev_id;
 199                 compressdev->data->socket_id = socket_id;
 200                 compressdev->data->dev_started = 0;
 201
 202                 compressdev->attached = RTE_COMPRESSDEV_ATTACHED;
 203
 204                 compressdev_globals.nb_devs++;
 205         }
 206
 207         return compressdev;
 208 }
 209
 210 int __rte_experimental
 211 rte_compressdev_pmd_release_device(struct rte_compressdev *compressdev)
 212 {
 213         int ret;
 214
 215         if (compressdev == NULL)
 216                 return -EINVAL;
 217
 218         /* Close device only if device operations have been set */
 219         if (compressdev->dev_ops) {
 220                 ret = rte_compressdev_close(compressdev->data->dev_id);
 221                 if (ret < 0)
 222                         return ret;
 223         }
 224
 225         compressdev->attached = RTE_COMPRESSDEV_DETACHED;
 226         compressdev_globals.nb_devs--;
 227         return 0;
 228 }
 229
 230 int __rte_experimental
 231 rte_compressdev_configure(uint8_t dev_id, struct rte_compressdev_config *config)
 232 {
 233         struct rte_compressdev *dev;
 234
 235         if (!rte_compressdev_is_valid_dev(dev_id)) {
 236                 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
 237                 return -EINVAL;
 238         }
 239
 240         dev = &rte_comp_devices[dev_id];
 241
 242         if (dev->data->dev_started) {
 243                 COMPRESSDEV_LOG(ERR,
 244                     "device %d must be stopped to allow configuration", dev_id);
 245                 return -EBUSY;
 246         }
 247
 248         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_configure, -ENOTSUP);
 249
 250         return (*dev->dev_ops->dev_configure)(dev, config);
 251 }
 252
 253
 254 int __rte_experimental
 255 rte_compressdev_start(uint8_t dev_id)
 256 {
 257         struct rte_compressdev *dev;
 258         int diag;
 259
 260         COMPRESSDEV_LOG(DEBUG, "Start dev_id=%" PRIu8, dev_id);
 261
 262         if (!rte_compressdev_is_valid_dev(dev_id)) {
 263                 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
 264                 return -EINVAL;
 265         }
 266
 267         dev = &rte_comp_devices[dev_id];
 268
 269         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_start, -ENOTSUP);
 270
 271         if (dev->data->dev_started != 0) {
 272                 COMPRESSDEV_LOG(ERR,
 273                     "Device with dev_id=%" PRIu8 " already started", dev_id);
 274                 return 0;
 275         }
 276
 277         diag = (*dev->dev_ops->dev_start)(dev);
 278         if (diag == 0)
 279                 dev->data->dev_started = 1;
 280         else
 281                 return diag;
 282
 283         return 0;
 284 }
 285
 286 void __rte_experimental
 287 rte_compressdev_stop(uint8_t dev_id)
 288 {
 289         struct rte_compressdev *dev;
 290
 291         if (!rte_compressdev_is_valid_dev(dev_id)) {
 292                 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
 293                 return;
 294         }
 295
 296         dev = &rte_comp_devices[dev_id];
 297
 298         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_stop);
 299
 300         if (dev->data->dev_started == 0) {
 301                 COMPRESSDEV_LOG(ERR,
 302                     "Device with dev_id=%" PRIu8 " already stopped", dev_id);
 303                 return;
 304         }
 305
 306         (*dev->dev_ops->dev_stop)(dev);
 307         dev->data->dev_started = 0;
 308 }
 309
 310 int __rte_experimental
 311 rte_compressdev_close(uint8_t dev_id)
 312 {
 313         struct rte_compressdev *dev;
 314         int retval;
 315
 316         if (!rte_compressdev_is_valid_dev(dev_id)) {
 317                 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%" PRIu8, dev_id);
 318                 return -1;
 319         }
 320
 321         dev = &rte_comp_devices[dev_id];
 322
 323         /* Device must be stopped before it can be closed */
 324         if (dev->data->dev_started == 1) {
 325                 COMPRESSDEV_LOG(ERR, "Device %u must be stopped before closing",
 326                                 dev_id);
 327                 return -EBUSY;
 328         }
 329
 330         RTE_FUNC_PTR_OR_ERR_RET(*dev->dev_ops->dev_close, -ENOTSUP);
 331         retval = (*dev->dev_ops->dev_close)(dev);
 332
 333         if (retval < 0)
 334                 return retval;
 335
 336         return 0;
 337 }
 338
 339 void __rte_experimental
 340 rte_compressdev_info_get(uint8_t dev_id, struct rte_compressdev_info *dev_info)
 341 {
 342         struct rte_compressdev *dev;
 343
 344         if (dev_id >= compressdev_globals.nb_devs) {
 345                 COMPRESSDEV_LOG(ERR, "Invalid dev_id=%d", dev_id);
 346                 return;
 347         }
 348
 349         dev = &rte_comp_devices[dev_id];
 350
 351         memset(dev_info, 0, sizeof(struct rte_compressdev_info));
 352
 353         RTE_FUNC_PTR_OR_RET(*dev->dev_ops->dev_infos_get);
 354         (*dev->dev_ops->dev_infos_get)(dev, dev_info);
 355
 356         dev_info->driver_name = dev->device->driver->name;
 357 }
 358
 359 const char * __rte_experimental
 360 rte_compressdev_name_get(uint8_t dev_id)
 361 {
 362         struct rte_compressdev *dev = rte_compressdev_get_dev(dev_id);
 363
 364         if (dev == NULL)
 365                 return NULL;
 366
 367         return dev->data->name;
 368 }
 369
 370 RTE_INIT(rte_compressdev_log);
 371
 372 static void
 373 rte_compressdev_log(void)
 374 {
 375         compressdev_logtype = rte_log_register("lib.compressdev");
 376         if (compressdev_logtype >= 0)
 377                 rte_log_set_level(compressdev_logtype, RTE_LOG_NOTICE);
 378 }