app/test/test_reorder.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include "test.h"
  35 #include "stdio.h"
  36
  37 #include <unistd.h>
  38 #include <string.h>
  39
  40 #include <rte_cycles.h>
  41 #include <rte_errno.h>
  42 #include <rte_mbuf.h>
  43 #include <rte_reorder.h>
  44 #include <rte_lcore.h>
  45 #include <rte_malloc.h>
  46
  47 #include "test.h"
  48
  49 #define BURST 32
  50 #define REORDER_BUFFER_SIZE 16384
  51 #define NUM_MBUFS (2*REORDER_BUFFER_SIZE)
  52 #define REORDER_BUFFER_SIZE_INVALID 2049
  53
  54 struct reorder_unittest_params {
  55         struct rte_mempool *p;
  56         struct rte_reorder_buffer *b;
  57 };
  58
  59 static struct reorder_unittest_params default_params  = {
  60         .p = NULL,
  61         .b = NULL
  62 };
  63
  64 static struct reorder_unittest_params *test_params = &default_params;
  65
  66 static int
  67 test_reorder_create(void)
  68 {
  69         struct rte_reorder_buffer *b = NULL;
  70
  71         b = rte_reorder_create(NULL, rte_socket_id(), REORDER_BUFFER_SIZE);
  72         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  73                         "No error on create() with NULL name");
  74
  75         b = rte_reorder_create("PKT", rte_socket_id(), REORDER_BUFFER_SIZE_INVALID);
  76         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
  77                         "No error on create() with invalid buffer size param.");
  78
  79         b = rte_reorder_create("PKT_RO1", rte_socket_id(), REORDER_BUFFER_SIZE);
  80         printf("DEBUG: b= %p, orig_b= %p\n", b, test_params->b);
  81         TEST_ASSERT_EQUAL(b, test_params->b,
  82                         "New reorder instance created with already existing name");
  83
  84         return 0;
  85 }
  86
  87 static int
  88 test_reorder_init(void)
  89 {
  90         struct rte_reorder_buffer *b = NULL;
  91         unsigned int size;
  92         /*
  93          * The minimum memory area size that should be passed to library is,
  94          * sizeof(struct rte_reorder_buffer) + (2 * size * sizeof(struct rte_mbuf *));
  95          * Otherwise error will be thrown
  96          */
  97
  98         size = 100;
  99         b = rte_reorder_init(b, size, "PKT1", REORDER_BUFFER_SIZE);
 100         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
 101                         "No error on init with NULL buffer.");
 102
 103         b = rte_malloc(NULL, size, 0);
 104         b = rte_reorder_init(b, size, "PKT1", REORDER_BUFFER_SIZE);
 105         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
 106                         "No error on init with invalid mem zone size.");
 107         rte_free(b);
 108
 109         size = 262336;
 110         b = rte_malloc(NULL, size, 0);
 111         b = rte_reorder_init(b, size, "PKT1", REORDER_BUFFER_SIZE_INVALID);
 112         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
 113                         "No error on init with invalid buffer size param.");
 114
 115         b = rte_reorder_init(b, size, NULL, REORDER_BUFFER_SIZE);
 116         TEST_ASSERT((b == NULL) && (rte_errno == EINVAL),
 117                         "No error on init with invalid name.");
 118         rte_free(b);
 119
 120         return 0;
 121 }
 122
 123 static int
 124 test_reorder_find_existing(void)
 125 {
 126         struct rte_reorder_buffer *b = NULL;
 127
 128         /* Try to find existing reorder buffer instance */
 129         b = rte_reorder_find_existing("PKT_RO1");
 130         TEST_ASSERT_EQUAL(b, test_params->b,
 131                         "existing reorder buffer instance not found");
 132
 133         /* Try to find non existing reorder buffer instance */
 134         b = rte_reorder_find_existing("ro_find_non_existing");
 135         TEST_ASSERT((b == NULL) && (rte_errno == ENOENT),
 136                         "non existing reorder buffer instance found");
 137
 138         return 0;
 139 }
 140
 141 static int
 142 test_reorder_free(void)
 143 {
 144         struct rte_reorder_buffer *b1 = NULL, *b2 = NULL;
 145         const char *name = "test_free";
 146
 147         b1 = rte_reorder_create(name, rte_socket_id(), 8);
 148         TEST_ASSERT_NOT_NULL(b1, "Failed to create reorder buffer.");
 149
 150         b2 = rte_reorder_find_existing(name);
 151         TEST_ASSERT_EQUAL(b1, b2, "Failed to find existing reorder buffer");
 152
 153         rte_reorder_free(b1);
 154
 155         b2 = rte_reorder_find_existing(name);
 156         TEST_ASSERT((b2 == NULL) && (rte_errno == ENOENT),
 157                         "Found previously freed reorder buffer");
 158
 159         return 0;
 160 }
 161
 162 static int
 163 test_reorder_insert(void)
 164 {
 165         struct rte_reorder_buffer *b = NULL;
 166         struct rte_mempool *p = test_params->p;
 167         const unsigned int size = 4;
 168         const unsigned int num_bufs = 6;
 169         struct rte_mbuf *bufs[num_bufs];
 170         int ret = 0;
 171         unsigned i;
 172
 173         /* This would create a reorder buffer instance consisting of:
 174          * reorder_seq = 0
 175          * ready_buf: RB[size] = {NULL, NULL, NULL, NULL}
 176          * order_buf: OB[size] = {NULL, NULL, NULL, NULL}
 177          */
 178         b = rte_reorder_create("test_insert", rte_socket_id(), size);
 179         TEST_ASSERT_NOT_NULL(b, "Failed to create reorder buffer");
 180
 181         ret = rte_mempool_get_bulk(p, (void *)bufs, num_bufs);
 182         TEST_ASSERT_SUCCESS(ret, "Error getting mbuf from pool");
 183
 184         /* late packet */
 185         bufs[0]->seqn = 3 * size;
 186         ret = rte_reorder_insert(b, bufs[0]);
 187         if (!((ret == -1) && (rte_errno == ERANGE))) {
 188                 printf("%s:%d: No error inserting late packet with seqn:"
 189                                 " 3 * size\n", __func__, __LINE__);
 190                 ret = -1;
 191                 goto exit;
 192         }
 193
 194         for (i = 0; i < num_bufs; i++)
 195                 bufs[i]->seqn = i;
 196
 197         /* This should fill up order buffer:
 198          * reorder_seq = 0
 199          * RB[] = {NULL, NULL, NULL, NULL}
 200          * OB[] = {0, 1, 2, 3}
 201          */
 202         for (i = 0; i < size; i++) {
 203                 ret = rte_reorder_insert(b, bufs[i]);
 204                 if (ret != 0) {
 205                         printf("%s:%d: Error inserting packet with seqn less than size\n",
 206                                         __func__, __LINE__);
 207                         ret = -1;
 208                         goto exit;
 209                 }
 210         }
 211
 212         /* early packet - should move mbufs to ready buf and move sequence window
 213          * reorder_seq = 4
 214          * RB[] = {0, 1, 2, 3}
 215          * OB[] = {4, NULL, NULL, NULL}
 216          */
 217         ret = rte_reorder_insert(b, bufs[4]);
 218         if (ret != 0) {
 219                 printf("%s:%d: Error inserting early packet with seqn: size\n",
 220                                 __func__, __LINE__);
 221                 ret = -1;
 222                 goto exit;
 223         }
 224
 225         /* early packet from current sequence window - full ready buffer */
 226         bufs[5]->seqn = 2 * size;
 227         ret = rte_reorder_insert(b, bufs[5]);
 228         if (!((ret == -1) && (rte_errno == ENOSPC))) {
 229                 printf("%s:%d: No error inserting early packet with full ready buffer\n",
 230                                 __func__, __LINE__);
 231                 ret = -1;
 232                 goto exit;
 233         }
 234
 235         ret = 0;
 236 exit:
 237         rte_mempool_put_bulk(p, (void *)bufs, num_bufs);
 238         rte_reorder_free(b);
 239         return ret;
 240 }
 241
 242 static int
 243 test_reorder_drain(void)
 244 {
 245         struct rte_reorder_buffer *b = NULL;
 246         struct rte_mempool *p = test_params->p;
 247         const unsigned int size = 4;
 248         const unsigned int num_bufs = 10;
 249         struct rte_mbuf *bufs[num_bufs];
 250         int ret = 0;
 251         unsigned i, cnt;
 252
 253         /* This would create a reorder buffer instance consisting of:
 254          * reorder_seq = 0
 255          * ready_buf: RB[size] = {NULL, NULL, NULL, NULL}
 256          * order_buf: OB[size] = {NULL, NULL, NULL, NULL}
 257          */
 258         b = rte_reorder_create("test_insert", rte_socket_id(), size);
 259         TEST_ASSERT_NOT_NULL(b, "Failed to create reorder buffer");
 260
 261         ret = rte_mempool_get_bulk(p, (void *)bufs, num_bufs);
 262         TEST_ASSERT_SUCCESS(ret, "Error getting mbuf from pool");
 263
 264         /* Check no drained packets if reorder is empty */
 265         cnt = rte_reorder_drain(b, bufs, 1);
 266         if (cnt != 0) {
 267                 printf("%s:%d: drained packets from empty reorder buffer\n",
 268                                 __func__, __LINE__);
 269                 ret = -1;
 270                 goto exit;
 271         }
 272
 273         for (i = 0; i < num_bufs; i++)
 274                 bufs[i]->seqn = i;
 275
 276         /* Insert packet with seqn 1:
 277          * reorder_seq = 0
 278          * RB[] = {NULL, NULL, NULL, NULL}
 279          * OB[] = {NULL, 1, NULL, NULL}
 280          */
 281         rte_reorder_insert(b, bufs[1]);
 282
 283         /* Check no drained packets if no ready/order packets */
 284         cnt = rte_reorder_drain(b, bufs, 1);
 285         if (cnt != 0) {
 286                 printf("%s:%d: drained packets from empty reorder buffer\n",
 287                                 __func__, __LINE__);
 288                 ret = -1;
 289                 goto exit;
 290         }
 291
 292         /* Insert more packets
 293          * RB[] = {NULL, NULL, NULL, NULL}
 294          * OB[] = {0, 1, NULL, 3}
 295          */
 296         rte_reorder_insert(b, bufs[0]);
 297         rte_reorder_insert(b, bufs[3]);
 298
 299         /* drained expected packets */
 300         cnt = rte_reorder_drain(b, bufs, 4);
 301         if (cnt != 2) {
 302                 printf("%s:%d:%d: number of expected packets not drained\n",
 303                                 __func__, __LINE__, cnt);
 304                 ret = -1;
 305                 goto exit;
 306         }
 307
 308         /*
 309          * RB[] = {NULL, NULL, NULL, NULL}
 310          * OB[] = {NULL, 3, NULL, NULL}
 311          */
 312
 313         rte_reorder_insert(b, bufs[4]);
 314         rte_reorder_insert(b, bufs[7]);
 315
 316         /*
 317          * RB[] = {3, 4, NULL, NULL}
 318          * OB[] = {NULL, NULL, 7, NULL}
 319          */
 320
 321         cnt = rte_reorder_drain(b, bufs, 4);
 322         if (cnt != 2) {
 323                 printf("%s:%d:%d: number of expected packets not drained\n",
 324                                 __func__, __LINE__, cnt);
 325                 ret = -1;
 326                 goto exit;
 327         }
 328
 329         ret = 0;
 330 exit:
 331         rte_mempool_put_bulk(p, (void *)bufs, num_bufs);
 332         rte_reorder_free(b);
 333         return ret;
 334 }
 335
 336 static int
 337 test_setup(void)
 338 {
 339         /* reorder buffer instance creation */
 340         if (test_params->b == NULL) {
 341                 test_params->b = rte_reorder_create("PKT_RO1", rte_socket_id(),
 342                                                         REORDER_BUFFER_SIZE);
 343                 if (test_params->b == NULL) {
 344                         printf("%s: Error creating reorder buffer instance b\n",
 345                                         __func__);
 346                         return -1;
 347                 }
 348         } else
 349                 rte_reorder_reset(test_params->b);
 350
 351         /* mempool creation */
 352         if (test_params->p == NULL) {
 353                 test_params->p = rte_pktmbuf_pool_create("RO_MBUF_POOL",
 354                         NUM_MBUFS, BURST, 0, RTE_MBUF_DEFAULT_BUF_SIZE,
 355                         rte_socket_id());
 356                 if (test_params->p == NULL) {
 357                         printf("%s: Error creating mempool\n", __func__);
 358                         return -1;
 359                 }
 360         }
 361         return 0;
 362 }
 363
 364 static struct unit_test_suite reorder_test_suite  = {
 365
 366         .setup = test_setup,
 367         .suite_name = "Reorder Unit Test Suite",
 368         .unit_test_cases = {
 369                 TEST_CASE(test_reorder_create),
 370                 TEST_CASE(test_reorder_init),
 371                 TEST_CASE(test_reorder_find_existing),
 372                 TEST_CASE(test_reorder_free),
 373                 TEST_CASE(test_reorder_insert),
 374                 TEST_CASE(test_reorder_drain),
 375                 TEST_CASES_END()
 376         }
 377 };
 378
 379 static int
 380 test_reorder(void)
 381 {
 382         return unit_test_suite_runner(&reorder_test_suite);
 383 }
 384
 385 static struct test_command reorder_cmd = {
 386         .command = "reorder_autotest",
 387         .callback = test_reorder,
 388 };
 389 REGISTER_TEST_COMMAND(reorder_cmd);