drivers/raw/skeleton/skeleton_rawdev_test.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2017 NXP
   3  */
   4
   5 #include <rte_common.h>
   6 #include <rte_mbuf.h>
   7 #include <rte_malloc.h>
   8 #include <rte_memcpy.h>
   9 #include <rte_dev.h>
  10 #include <rte_rawdev.h>
  11 #include <rte_bus_vdev.h>
  12 #include <rte_test.h>
  13
  14 /* Using relative path as skeleton_rawdev is not part of exported headers */
  15 #include "skeleton_rawdev.h"
  16
  17 #define TEST_DEV_NAME "rawdev_skeleton"
  18
  19 #define SKELDEV_LOGS(level, fmt, args...) \
  20         rte_log(RTE_LOG_ ## level, skeleton_pmd_logtype, fmt "\n", \
  21                 ##args)
  22
  23 #define SKELDEV_TEST_INFO(fmt, args...) \
  24         SKELDEV_LOGS(INFO, fmt, ## args)
  25 #define SKELDEV_TEST_DEBUG(fmt, args...) \
  26         SKELDEV_LOGS(DEBUG, fmt, ## args)
  27
  28 #define SKELDEV_TEST_RUN(setup, teardown, test) \
  29         skeldev_test_run(setup, teardown, test, #test)
  30
  31 #define TEST_SUCCESS 0
  32 #define TEST_FAILED  -1
  33
  34 static int total;
  35 static int passed;
  36 static int failed;
  37 static int unsupported;
  38
  39 static uint16_t test_dev_id;
  40
  41 static int
  42 testsuite_setup(void)
  43 {
  44         uint8_t count;
  45         count = rte_rawdev_count();
  46         if (!count) {
  47                 SKELDEV_TEST_INFO("\tNo existing rawdev; "
  48                                   "Creating 'skeldev_rawdev'");
  49                 return rte_vdev_init(TEST_DEV_NAME, NULL);
  50         }
  51
  52         return TEST_SUCCESS;
  53 }
  54
  55 static void local_teardown(void);
  56
  57 static void
  58 testsuite_teardown(void)
  59 {
  60         local_teardown();
  61 }
  62
  63 static void
  64 local_teardown(void)
  65 {
  66         rte_vdev_uninit(TEST_DEV_NAME);
  67 }
  68
  69 static int
  70 test_rawdev_count(void)
  71 {
  72         uint8_t count;
  73         count = rte_rawdev_count();
  74         RTE_TEST_ASSERT(count > 0, "Invalid rawdev count %" PRIu8, count);
  75         return TEST_SUCCESS;
  76 }
  77
  78 static int
  79 test_rawdev_get_dev_id(void)
  80 {
  81         int ret;
  82         ret = rte_rawdev_get_dev_id("invalid_rawdev_device");
  83         RTE_TEST_ASSERT_FAIL(ret, "Expected <0 for invalid dev name ret=%d",
  84                              ret);
  85         return TEST_SUCCESS;
  86 }
  87
  88 static int
  89 test_rawdev_socket_id(void)
  90 {
  91         int socket_id;
  92         socket_id = rte_rawdev_socket_id(test_dev_id);
  93         RTE_TEST_ASSERT(socket_id != -EINVAL,
  94                         "Failed to get socket_id %d", socket_id);
  95         socket_id = rte_rawdev_socket_id(RTE_RAWDEV_MAX_DEVS);
  96         RTE_TEST_ASSERT(socket_id == -EINVAL,
  97                         "Expected -EINVAL %d", socket_id);
  98
  99         return TEST_SUCCESS;
 100 }
 101
 102 static int
 103 test_rawdev_info_get(void)
 104 {
 105         int ret;
 106         struct rte_rawdev_info rdev_info = {0};
 107         struct skeleton_rawdev_conf skel_conf = {0};
 108
 109         ret = rte_rawdev_info_get(test_dev_id, NULL, 0);
 110         RTE_TEST_ASSERT(ret == -EINVAL, "Expected -EINVAL, %d", ret);
 111
 112         rdev_info.dev_private = &skel_conf;
 113
 114         ret = rte_rawdev_info_get(test_dev_id, &rdev_info, sizeof(skel_conf));
 115         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to get raw dev info");
 116
 117         return TEST_SUCCESS;
 118 }
 119
 120 static int
 121 test_rawdev_configure(void)
 122 {
 123         int ret;
 124         struct rte_rawdev_info rdev_info = {0};
 125         struct skeleton_rawdev_conf rdev_conf_set = {0};
 126         struct skeleton_rawdev_conf rdev_conf_get = {0};
 127
 128         /* Check invalid configuration */
 129         ret = rte_rawdev_configure(test_dev_id, NULL);
 130         RTE_TEST_ASSERT(ret == -EINVAL,
 131                         "Null configure; Expected -EINVAL, got %d", ret);
 132
 133         /* Valid configuration test */
 134         rdev_conf_set.num_queues = 1;
 135         rdev_conf_set.capabilities = SKELETON_CAPA_FW_LOAD |
 136                                      SKELETON_CAPA_FW_RESET;
 137
 138         rdev_info.dev_private = &rdev_conf_set;
 139         ret = rte_rawdev_configure(test_dev_id,
 140                                    (rte_rawdev_obj_t)&rdev_info);
 141         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to configure rawdev (%d)", ret);
 142
 143         rdev_info.dev_private = &rdev_conf_get;
 144         ret = rte_rawdev_info_get(test_dev_id,
 145                                   (rte_rawdev_obj_t)&rdev_info,
 146                                   sizeof(rdev_conf_get));
 147         RTE_TEST_ASSERT_SUCCESS(ret,
 148                                 "Failed to obtain rawdev configuration (%d)",
 149                                 ret);
 150
 151         RTE_TEST_ASSERT_EQUAL(rdev_conf_set.num_queues,
 152                               rdev_conf_get.num_queues,
 153                               "Configuration test failed; num_queues (%d)(%d)",
 154                               rdev_conf_set.num_queues,
 155                               rdev_conf_get.num_queues);
 156         RTE_TEST_ASSERT_EQUAL(rdev_conf_set.capabilities,
 157                           rdev_conf_get.capabilities,
 158                           "Configuration test failed; capabilities");
 159
 160         return TEST_SUCCESS;
 161 }
 162
 163 static int
 164 test_rawdev_queue_default_conf_get(void)
 165 {
 166         int ret, i;
 167         struct rte_rawdev_info rdev_info = {0};
 168         struct skeleton_rawdev_conf rdev_conf_get = {0};
 169         struct skeleton_rawdev_queue q = {0};
 170
 171         /* Get the current configuration */
 172         rdev_info.dev_private = &rdev_conf_get;
 173         ret = rte_rawdev_info_get(test_dev_id,
 174                                   (rte_rawdev_obj_t)&rdev_info,
 175                                   sizeof(rdev_conf_get));
 176         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to obtain rawdev configuration (%d)",
 177                                 ret);
 178
 179         /* call to test_rawdev_configure would have set the num_queues = 1 */
 180         RTE_TEST_ASSERT_SUCCESS(!(rdev_conf_get.num_queues > 0),
 181                                 "Invalid number of queues (%d). Expected 1",
 182                                 rdev_conf_get.num_queues);
 183         /* All queues by default should have state = DETACH and
 184          * depth = DEF_DEPTH
 185          */
 186         for (i = 0; i < rdev_conf_get.num_queues; i++) {
 187                 rte_rawdev_queue_conf_get(test_dev_id, i, &q);
 188                 RTE_TEST_ASSERT_EQUAL(q.depth, SKELETON_QUEUE_DEF_DEPTH,
 189                                       "Invalid default depth of queue (%d)",
 190                                       q.depth);
 191                 RTE_TEST_ASSERT_EQUAL(q.state, SKELETON_QUEUE_DETACH,
 192                                       "Invalid default state of queue (%d)",
 193                                       q.state);
 194         }
 195
 196         return TEST_SUCCESS;
 197 }
 198
 199 static int
 200 test_rawdev_queue_count(void)
 201 {
 202         unsigned int q_count;
 203
 204         /* Get the current configuration */
 205         q_count = rte_rawdev_queue_count(test_dev_id);
 206         RTE_TEST_ASSERT_EQUAL(q_count, 1, "Invalid queue count (%d)", q_count);
 207
 208         return TEST_SUCCESS;
 209 }
 210
 211 static int
 212 test_rawdev_queue_setup(void)
 213 {
 214         int ret;
 215         struct rte_rawdev_info rdev_info = {0};
 216         struct skeleton_rawdev_conf rdev_conf_get = {0};
 217         struct skeleton_rawdev_queue qset = {0};
 218         struct skeleton_rawdev_queue qget = {0};
 219
 220         /* Get the current configuration */
 221         rdev_info.dev_private = &rdev_conf_get;
 222         ret = rte_rawdev_info_get(test_dev_id,
 223                                   (rte_rawdev_obj_t)&rdev_info,
 224                                   sizeof(rdev_conf_get));
 225         RTE_TEST_ASSERT_SUCCESS(ret,
 226                                 "Failed to obtain rawdev configuration (%d)",
 227                                 ret);
 228
 229         /* call to test_rawdev_configure would have set the num_queues = 1 */
 230         RTE_TEST_ASSERT_SUCCESS(!(rdev_conf_get.num_queues > 0),
 231                                 "Invalid number of queues (%d). Expected 1",
 232                                 rdev_conf_get.num_queues);
 233
 234         /* Modify the queue depth for Queue 0 and attach it */
 235         qset.depth = 15;
 236         qset.state = SKELETON_QUEUE_ATTACH;
 237         ret = rte_rawdev_queue_setup(test_dev_id, 0, &qset);
 238         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to setup queue (%d)", ret);
 239
 240         /* Now, fetching the queue 0 should show depth as 15 */
 241         ret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget);
 242         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to get queue config (%d)", ret);
 243
 244         RTE_TEST_ASSERT_EQUAL(qset.depth, qget.depth,
 245                               "Failed to set queue depth: Need(%d), has(%d)",
 246                               qset.depth, qget.depth);
 247
 248         return TEST_SUCCESS;
 249 }
 250
 251 /* After executing test_rawdev_queue_setup, queue_id=0 would have depth as 15.
 252  * Releasing should set it back to default. state would set to DETACH
 253  */
 254 static int
 255 test_rawdev_queue_release(void)
 256 {
 257         int ret;
 258         struct skeleton_rawdev_queue qget = {0};
 259
 260         /* Now, fetching the queue 0 should show depth as 100 */
 261         ret = rte_rawdev_queue_release(test_dev_id, 0);
 262         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to release queue 0; (%d)", ret);
 263
 264         /* Now, fetching the queue 0 should show depth as default */
 265         ret = rte_rawdev_queue_conf_get(test_dev_id, 0, &qget);
 266         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to get queue config (%d)", ret);
 267
 268         RTE_TEST_ASSERT_EQUAL(qget.depth, SKELETON_QUEUE_DEF_DEPTH,
 269                               "Release of Queue 0 failed; (depth)");
 270
 271         RTE_TEST_ASSERT_EQUAL(qget.state, SKELETON_QUEUE_DETACH,
 272                               "Release of Queue 0 failed; (state)");
 273
 274         return TEST_SUCCESS;
 275 }
 276
 277 static int
 278 test_rawdev_attr_set_get(void)
 279 {
 280         int ret;
 281         int *dummy_value, set_value;
 282         uint64_t ret_value;
 283
 284         /* Set an attribute and fetch it */
 285         ret = rte_rawdev_set_attr(test_dev_id, "Test1", 100);
 286         RTE_TEST_ASSERT(!ret, "Unable to set an attribute (Test1)");
 287
 288         dummy_value = &set_value;
 289         *dummy_value = 200;
 290         ret = rte_rawdev_set_attr(test_dev_id, "Test2", (uintptr_t)dummy_value);
 291
 292         /* Check if attributes have been set */
 293         ret = rte_rawdev_get_attr(test_dev_id, "Test1", &ret_value);
 294         RTE_TEST_ASSERT_EQUAL(ret_value, 100,
 295                               "Attribute (Test1) not set correctly (%" PRIu64 ")",
 296                               ret_value);
 297
 298         ret_value = 0;
 299         ret = rte_rawdev_get_attr(test_dev_id, "Test2", &ret_value);
 300         RTE_TEST_ASSERT_EQUAL(*((int *)(uintptr_t)ret_value), set_value,
 301                               "Attribute (Test2) not set correctly (%" PRIu64 ")",
 302                               ret_value);
 303
 304         return TEST_SUCCESS;
 305 }
 306
 307 static int
 308 test_rawdev_start_stop(void)
 309 {
 310         int ret;
 311         struct rte_rawdev_info rdev_info = {0};
 312         struct skeleton_rawdev_conf rdev_conf_get = {0};
 313         char *dummy_firmware = NULL;
 314
 315         /* Get the current configuration */
 316         rdev_info.dev_private = &rdev_conf_get;
 317
 318         /* Load a firmware using a dummy address area */
 319         dummy_firmware = rte_zmalloc("RAWDEV SKELETON", sizeof(int) * 10, 0);
 320         RTE_TEST_ASSERT(dummy_firmware != NULL,
 321                         "Failed to create firmware memory backing");
 322
 323         ret = rte_rawdev_firmware_load(test_dev_id, dummy_firmware);
 324         RTE_TEST_ASSERT_SUCCESS(ret, "Firmware loading failed (%d)", ret);
 325
 326         /* Skeleton doesn't do anything with the firmware area - that is dummy
 327          * and can be removed.
 328          */
 329         rte_free(dummy_firmware);
 330         dummy_firmware = NULL;
 331
 332         rte_rawdev_start(test_dev_id);
 333         ret = rte_rawdev_info_get(test_dev_id, (rte_rawdev_obj_t)&rdev_info,
 334                         sizeof(rdev_conf_get));
 335         RTE_TEST_ASSERT_SUCCESS(ret,
 336                                 "Failed to obtain rawdev configuration (%d)",
 337                                 ret);
 338         RTE_TEST_ASSERT_EQUAL(rdev_conf_get.device_state, SKELETON_DEV_RUNNING,
 339                               "Device start failed. State is (%d)",
 340                               rdev_conf_get.device_state);
 341
 342         rte_rawdev_stop(test_dev_id);
 343         ret = rte_rawdev_info_get(test_dev_id, (rte_rawdev_obj_t)&rdev_info,
 344                         sizeof(rdev_conf_get));
 345         RTE_TEST_ASSERT_SUCCESS(ret,
 346                                 "Failed to obtain rawdev configuration (%d)",
 347                                 ret);
 348         RTE_TEST_ASSERT_EQUAL(rdev_conf_get.device_state, SKELETON_DEV_STOPPED,
 349                               "Device stop failed. State is (%d)",
 350                               rdev_conf_get.device_state);
 351
 352         /* Unloading the firmware once device is stopped */
 353         ret = rte_rawdev_firmware_unload(test_dev_id);
 354         RTE_TEST_ASSERT_SUCCESS(ret, "Failed to unload firmware (%d)", ret);
 355
 356         return TEST_SUCCESS;
 357 }
 358
 359 static int
 360 test_rawdev_enqdeq(void)
 361 {
 362         int ret;
 363         unsigned int count = 1;
 364         uint16_t queue_id = 0;
 365         struct rte_rawdev_buf buffers[1];
 366         struct rte_rawdev_buf *deq_buffers = NULL;
 367
 368         buffers[0].buf_addr = malloc(strlen(TEST_DEV_NAME) + 3);
 369         if (!buffers[0].buf_addr)
 370                 goto cleanup;
 371         snprintf(buffers[0].buf_addr, strlen(TEST_DEV_NAME) + 2, "%s%d",
 372                  TEST_DEV_NAME, 0);
 373
 374         ret = rte_rawdev_enqueue_buffers(test_dev_id,
 375                                          (struct rte_rawdev_buf **)&buffers,
 376                                          count, &queue_id);
 377         RTE_TEST_ASSERT_EQUAL((unsigned int)ret, count,
 378                               "Unable to enqueue buffers");
 379
 380         deq_buffers = malloc(sizeof(struct rte_rawdev_buf) * count);
 381         if (!deq_buffers)
 382                 goto cleanup;
 383
 384         ret = rte_rawdev_dequeue_buffers(test_dev_id,
 385                                         (struct rte_rawdev_buf **)&deq_buffers,
 386                                         count, &queue_id);
 387         RTE_TEST_ASSERT_EQUAL((unsigned int)ret, count,
 388                               "Unable to dequeue buffers");
 389
 390         if (deq_buffers)
 391                 free(deq_buffers);
 392
 393         return TEST_SUCCESS;
 394 cleanup:
 395         if (buffers[0].buf_addr)
 396                 free(buffers[0].buf_addr);
 397
 398         return TEST_FAILED;
 399 }
 400
 401 static void skeldev_test_run(int (*setup)(void),
 402                              void (*teardown)(void),
 403                              int (*test)(void),
 404                              const char *name)
 405 {
 406         int ret = 0;
 407
 408         if (setup) {
 409                 ret = setup();
 410                 if (ret < 0) {
 411                         SKELDEV_TEST_INFO("Error setting up test %s", name);
 412                         unsupported++;
 413                 }
 414         }
 415
 416         if (test) {
 417                 ret = test();
 418                 if (ret < 0) {
 419                         failed++;
 420                         SKELDEV_TEST_INFO("%s Failed", name);
 421                 } else {
 422                         passed++;
 423                         SKELDEV_TEST_DEBUG("%s Passed", name);
 424                 }
 425         }
 426
 427         if (teardown)
 428                 teardown();
 429
 430         total++;
 431 }
 432
 433 int
 434 test_rawdev_skeldev(uint16_t dev_id)
 435 {
 436         test_dev_id = dev_id;
 437         testsuite_setup();
 438
 439         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_count);
 440         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_get_dev_id);
 441         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_socket_id);
 442         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_info_get);
 443         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_configure);
 444         SKELDEV_TEST_RUN(test_rawdev_configure, NULL,
 445                          test_rawdev_queue_default_conf_get);
 446         SKELDEV_TEST_RUN(test_rawdev_configure, NULL, test_rawdev_queue_setup);
 447         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_queue_count);
 448         SKELDEV_TEST_RUN(test_rawdev_queue_setup, NULL,
 449                          test_rawdev_queue_release);
 450         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_attr_set_get);
 451         SKELDEV_TEST_RUN(NULL, NULL, test_rawdev_start_stop);
 452         SKELDEV_TEST_RUN(test_rawdev_queue_setup, NULL, test_rawdev_enqdeq);
 453
 454         testsuite_teardown();
 455
 456         SKELDEV_TEST_INFO("Total tests   : %d", total);
 457         SKELDEV_TEST_INFO("Passed        : %d", passed);
 458         SKELDEV_TEST_INFO("Failed        : %d", failed);
 459         SKELDEV_TEST_INFO("Not supported : %d", unsupported);
 460
 461         if (failed)
 462                 return -1;
 463
 464         return 0;
 465 };