test/test/test_reorder.c

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #include <stdio.h>
   6 #include <unistd.h>
   7 #include <string.h>
   8
   9 #include <rte_cycles.h>
  10 #include <rte_errno.h>
  11 #include <rte_mbuf.h>
  12 #include <rte_reorder.h>
  13 #include <rte_lcore.h>
  14 #include <rte_malloc.h>
  15
  16 #include "test.h"
  17
  18 #define BURST 32
  19 #define REORDER_BUFFER_SIZE 16384
  20 #define NUM_MBUFS (2*REORDER_BUFFER_SIZE)
  21 #define REORDER_BUFFER_SIZE_INVALID 2049
  22
  23 struct reorder_unittest_params {
  24         struct rte_mempool *p;
  25         struct rte_reorder_buffer *b;
  26 };
  27
  28 static struct reorder_unittest_params default_params  = {
  29         .p = NULL,
  30         .b = NULL
  31 };
  32
  33 static struct reorder_unittest_params *test_params = &default_params;
  34
  35 static int
  36 test_reorder_create(void)
  37 {
  38         struct rte_reorder_buffer *b = NULL;
  39
  40         b = rte_reorder_create(NULL, rte_socket_id(), REORDER_BUFFER_SIZE);
  41         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  42                         "No error on create() with NULL name");
  43
  44         b = rte_reorder_create("PKT", rte_socket_id(), REORDER_BUFFER_SIZE_INVALID);
  45         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  46                         "No error on create() with invalid buffer size param.");
  47
  48         b = rte_reorder_create("PKT_RO1", rte_socket_id(), REORDER_BUFFER_SIZE);
  49         TEST_ASSERT_EQUAL(b, test_params->b,
  50                         "New reorder instance created with already existing name");
  51
  52         return 0;
  53 }
  54
  55 static int
  56 test_reorder_init(void)
  57 {
  58         struct rte_reorder_buffer *b = NULL;
  59         unsigned int size;
  60         /*
  61          * The minimum memory area size that should be passed to library is,
  62          * sizeof(struct rte_reorder_buffer) + (2 * size * sizeof(struct rte_mbuf *));
  63          * Otherwise error will be thrown
  64          */
  65
  66         size = 100;
  67         b = rte_reorder_init(b, size, "PKT1", REORDER_BUFFER_SIZE);
  68         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  69                         "No error on init with NULL buffer.");
  70
  71         b = rte_malloc(NULL, size, 0);
  72         b = rte_reorder_init(b, size, "PKT1", REORDER_BUFFER_SIZE);
  73         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  74                         "No error on init with invalid mem zone size.");
  75         rte_free(b);
  76
  77         size = 262336;
  78         b = rte_malloc(NULL, size, 0);
  79         b = rte_reorder_init(b, size, "PKT1", REORDER_BUFFER_SIZE_INVALID);
  80         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  81                         "No error on init with invalid buffer size param.");
  82
  83         b = rte_reorder_init(b, size, NULL, REORDER_BUFFER_SIZE);
  84         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  85                         "No error on init with invalid name.");
  86         rte_free(b);
  87
  88         return 0;
  89 }
  90
  91 static int
  92 test_reorder_find_existing(void)
  93 {
  94         struct rte_reorder_buffer *b = NULL;
  95
  96         /* Try to find existing reorder buffer instance */
  97         b = rte_reorder_find_existing("PKT_RO1");
  98         TEST_ASSERT_EQUAL(b, test_params->b,
  99                         "existing reorder buffer instance not found");
 100
 101         /* Try to find non existing reorder buffer instance */
 102         b = rte_reorder_find_existing("ro_find_non_existing");
 103         TEST_ASSERT((b == NULL) && (rte_errno == ENOENT),
 104                         "non existing reorder buffer instance found");
 105
 106         return 0;
 107 }
 108
 109 static int
 110 test_reorder_free(void)
 111 {
 112         struct rte_reorder_buffer *b1 = NULL, *b2 = NULL;
 113         const char *name = "test_free";
 114
 115         b1 = rte_reorder_create(name, rte_socket_id(), 8);
 116         TEST_ASSERT_NOT_NULL(b1, "Failed to create reorder buffer.");
 117
 118         b2 = rte_reorder_find_existing(name);
 119         TEST_ASSERT_EQUAL(b1, b2, "Failed to find existing reorder buffer");
 120
 121         rte_reorder_free(b1);
 122
 123         b2 = rte_reorder_find_existing(name);
 124         TEST_ASSERT((b2 == NULL) && (rte_errno == ENOENT),
 125                         "Found previously freed reorder buffer");
 126
 127         return 0;
 128 }
 129
 130 static int
 131 test_reorder_insert(void)
 132 {
 133         struct rte_reorder_buffer *b = NULL;
 134         struct rte_mempool *p = test_params->p;
 135         const unsigned int size = 4;
 136         const unsigned int num_bufs = 7;
 137         struct rte_mbuf *bufs[num_bufs];
 138         int ret = 0;
 139         unsigned i;
 140
 141         /* This would create a reorder buffer instance consisting of:
 142          * reorder_seq = 0
 143          * ready_buf: RB[size] = {NULL, NULL, NULL, NULL}
 144          * order_buf: OB[size] = {NULL, NULL, NULL, NULL}
 145          */
 146         b = rte_reorder_create("test_insert", rte_socket_id(), size);
 147         TEST_ASSERT_NOT_NULL(b, "Failed to create reorder buffer");
 148
 149         ret = rte_mempool_get_bulk(p, (void *)bufs, num_bufs);
 150         TEST_ASSERT_SUCCESS(ret, "Error getting mbuf from pool");
 151
 152         for (i = 0; i < num_bufs; i++)
 153                 bufs[i]->seqn = i;
 154
 155         /* This should fill up order buffer:
 156          * reorder_seq = 0
 157          * RB[] = {NULL, NULL, NULL, NULL}
 158          * OB[] = {0, 1, 2, 3}
 159          */
 160         for (i = 0; i < size; i++) {
 161                 ret = rte_reorder_insert(b, bufs[i]);
 162                 if (ret != 0) {
 163                         printf("%s:%d: Error inserting packet with seqn less than size\n",
 164                                         __func__, __LINE__);
 165                         ret = -1;
 166                         goto exit;
 167                 }
 168         }
 169
 170         /* early packet - should move mbufs to ready buf and move sequence window
 171          * reorder_seq = 4
 172          * RB[] = {0, 1, 2, 3}
 173          * OB[] = {4, NULL, NULL, NULL}
 174          */
 175         ret = rte_reorder_insert(b, bufs[4]);
 176         if (ret != 0) {
 177                 printf("%s:%d: Error inserting early packet with seqn: size\n",
 178                                 __func__, __LINE__);
 179                 ret = -1;
 180                 goto exit;
 181         }
 182
 183         /* early packet from current sequence window - full ready buffer */
 184         bufs[5]->seqn = 2 * size;
 185         ret = rte_reorder_insert(b, bufs[5]);
 186         if (!((ret == -1) && (rte_errno == ENOSPC))) {
 187                 printf("%s:%d: No error inserting early packet with full ready buffer\n",
 188                                 __func__, __LINE__);
 189                 ret = -1;
 190                 goto exit;
 191         }
 192
 193         /* late packet */
 194         bufs[6]->seqn = 3 * size;
 195         ret = rte_reorder_insert(b, bufs[6]);
 196         if (!((ret == -1) && (rte_errno == ERANGE))) {
 197                 printf("%s:%d: No error inserting late packet with seqn:"
 198                                 " 3 * size\n", __func__, __LINE__);
 199                 ret = -1;
 200                 goto exit;
 201         }
 202
 203         ret = 0;
 204 exit:
 205         rte_mempool_put_bulk(p, (void *)bufs, num_bufs);
 206         rte_reorder_free(b);
 207         return ret;
 208 }
 209
 210 static int
 211 test_reorder_drain(void)
 212 {
 213         struct rte_reorder_buffer *b = NULL;
 214         struct rte_mempool *p = test_params->p;
 215         const unsigned int size = 4;
 216         const unsigned int num_bufs = 8;
 217         struct rte_mbuf *bufs[num_bufs];
 218         struct rte_mbuf *robufs[num_bufs];
 219         int ret = 0;
 220         unsigned i, cnt;
 221
 222         /* This would create a reorder buffer instance consisting of:
 223          * reorder_seq = 0
 224          * ready_buf: RB[size] = {NULL, NULL, NULL, NULL}
 225          * order_buf: OB[size] = {NULL, NULL, NULL, NULL}
 226          */
 227         b = rte_reorder_create("test_drain", rte_socket_id(), size);
 228         TEST_ASSERT_NOT_NULL(b, "Failed to create reorder buffer");
 229
 230         ret = rte_mempool_get_bulk(p, (void *)bufs, num_bufs);
 231         TEST_ASSERT_SUCCESS(ret, "Error getting mbuf from pool");
 232
 233         /* Check no drained packets if reorder is empty */
 234         cnt = rte_reorder_drain(b, robufs, 1);
 235         if (cnt != 0) {
 236                 printf("%s:%d: drained packets from empty reorder buffer\n",
 237                                 __func__, __LINE__);
 238                 ret = -1;
 239                 goto exit;
 240         }
 241
 242         for (i = 0; i < num_bufs; i++)
 243                 bufs[i]->seqn = i;
 244
 245         /* Insert packet with seqn 1:
 246          * reorder_seq = 0
 247          * RB[] = {NULL, NULL, NULL, NULL}
 248          * OB[] = {1, NULL, NULL, NULL}
 249          */
 250         rte_reorder_insert(b, bufs[1]);
 251
 252         cnt = rte_reorder_drain(b, robufs, 1);
 253         if (cnt != 1) {
 254                 printf("%s:%d:%d: number of expected packets not drained\n",
 255                                 __func__, __LINE__, cnt);
 256                 ret = -1;
 257                 goto exit;
 258         }
 259
 260         /* Insert more packets
 261          * RB[] = {NULL, NULL, NULL, NULL}
 262          * OB[] = {NULL, 2, 3, NULL}
 263          */
 264         rte_reorder_insert(b, bufs[2]);
 265         rte_reorder_insert(b, bufs[3]);
 266
 267         /* Insert more packets
 268          * RB[] = {NULL, NULL, NULL, NULL}
 269          * OB[] = {NULL, 2, 3, 4}
 270          */
 271         rte_reorder_insert(b, bufs[4]);
 272
 273         /* Insert more packets
 274          * RB[] = {2, 3, 4, NULL}
 275          * OB[] = {NULL, NULL, 7, NULL}
 276          */
 277         rte_reorder_insert(b, bufs[7]);
 278
 279         /* drained expected packets */
 280         cnt = rte_reorder_drain(b, robufs, 4);
 281         if (cnt != 3) {
 282                 printf("%s:%d:%d: number of expected packets not drained\n",
 283                                 __func__, __LINE__, cnt);
 284                 ret = -1;
 285                 goto exit;
 286         }
 287
 288         /*
 289          * RB[] = {NULL, NULL, NULL, NULL}
 290          * OB[] = {NULL, NULL, 7, NULL}
 291          */
 292         cnt = rte_reorder_drain(b, robufs, 1);
 293         if (cnt != 0) {
 294                 printf("%s:%d:%d: number of expected packets not drained\n",
 295                                 __func__, __LINE__, cnt);
 296                 ret = -1;
 297                 goto exit;
 298         }
 299         ret = 0;
 300 exit:
 301         rte_mempool_put_bulk(p, (void *)bufs, num_bufs);
 302         rte_reorder_free(b);
 303         return ret;
 304 }
 305
 306 static int
 307 test_setup(void)
 308 {
 309         /* reorder buffer instance creation */
 310         if (test_params->b == NULL) {
 311                 test_params->b = rte_reorder_create("PKT_RO1", rte_socket_id(),
 312                                                         REORDER_BUFFER_SIZE);
 313                 if (test_params->b == NULL) {
 314                         printf("%s: Error creating reorder buffer instance b\n",
 315                                         __func__);
 316                         return -1;
 317                 }
 318         } else
 319                 rte_reorder_reset(test_params->b);
 320
 321         /* mempool creation */
 322         if (test_params->p == NULL) {
 323                 test_params->p = rte_pktmbuf_pool_create("RO_MBUF_POOL",
 324                         NUM_MBUFS, BURST, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
 325                         rte_socket_id());
 326                 if (test_params->p == NULL) {
 327                         printf("%s: Error creating mempool\n", __func__);
 328                         return -1;
 329                 }
 330         }
 331         return 0;
 332 }
 333
 334 static void
 335 test_teardown(void)
 336 {
 337         rte_reorder_free(test_params->b);
 338         test_params->b = NULL;
 339         rte_mempool_free(test_params->p);
 340         test_params->p = NULL;
 341 }
 342
 343
 344 static struct unit_test_suite reorder_test_suite  = {
 345
 346         .setup = test_setup,
 347         .teardown = test_teardown,
 348         .suite_name = "Reorder Unit Test Suite",
 349         .unit_test_cases = {
 350                 TEST_CASE(test_reorder_create),
 351                 TEST_CASE(test_reorder_init),
 352                 TEST_CASE(test_reorder_find_existing),
 353                 TEST_CASE(test_reorder_free),
 354                 TEST_CASE(test_reorder_insert),
 355                 TEST_CASE(test_reorder_drain),
 356                 TEST_CASES_END()
 357         }
 358 };
 359
 360 static int
 361 test_reorder(void)
 362 {
 363         return unit_test_suite_runner(&reorder_test_suite);
 364 }
 365
 366 REGISTER_TEST_COMMAND(reorder_autotest, test_reorder);