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