app/test/test_func_reentrancy.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 <string.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <stdint.h>
  38 #include <inttypes.h>
  39 #include <stdarg.h>
  40 #include <errno.h>
  41 #include <sys/queue.h>
  42
  43 #include <rte_common.h>
  44 #include <rte_log.h>
  45 #include <rte_debug.h>
  46 #include <rte_memory.h>
  47 #include <rte_memzone.h>
  48 #include <rte_launch.h>
  49 #include <rte_cycles.h>
  50 #include <rte_tailq.h>
  51 #include <rte_eal.h>
  52 #include <rte_per_lcore.h>
  53 #include <rte_lcore.h>
  54 #include <rte_atomic.h>
  55 #include <rte_branch_prediction.h>
  56 #include <rte_ring.h>
  57 #include <rte_mempool.h>
  58 #include <rte_spinlock.h>
  59 #include <rte_malloc.h>
  60
  61 #ifdef RTE_LIBRTE_HASH
  62 #include <rte_hash.h>
  63 #include <rte_fbk_hash.h>
  64 #include <rte_jhash.h>
  65 #endif /* RTE_LIBRTE_HASH */
  66
  67 #ifdef RTE_LIBRTE_LPM
  68 #include <rte_lpm.h>
  69 #endif /* RTE_LIBRTE_LPM */
  70
  71 #include <rte_string_fns.h>
  72
  73 #include "test.h"
  74
  75 typedef int (*case_func_t)(void* arg);
  76 typedef void (*case_clean_t)(unsigned lcore_id);
  77
  78 #define MAX_STRING_SIZE                     (256)
  79 #define MAX_ITER_TIMES                      (16)
  80 #define MAX_LPM_ITER_TIMES                  (8)
  81
  82 #define MEMPOOL_ELT_SIZE                    (0)
  83 #define MEMPOOL_SIZE                        (4)
  84
  85 #define MAX_LCORES      RTE_MAX_MEMZONE / (MAX_ITER_TIMES * 4U)
  86
  87 static rte_atomic32_t synchro = RTE_ATOMIC32_INIT(0);
  88
  89 #define WAIT_SYNCHRO_FOR_SLAVES()   do{ \
  90         if (lcore_self != rte_get_master_lcore())                  \
  91                 while (rte_atomic32_read(&synchro) == 0);        \
  92 } while(0)
  93
  94 /*
  95  * rte_eal_init only init once
  96  */
  97 static int
  98 test_eal_init_once(__attribute__((unused)) void *arg)
  99 {
 100         unsigned lcore_self =  rte_lcore_id();
 101
 102         WAIT_SYNCHRO_FOR_SLAVES();
 103
 104         if (rte_eal_init(0, NULL) != -1)
 105                 return -1;
 106
 107         return 0;
 108 }
 109
 110 /*
 111  * ring create/lookup reentrancy test
 112  */
 113 static int
 114 ring_create_lookup(__attribute__((unused)) void *arg)
 115 {
 116         unsigned lcore_self = rte_lcore_id();
 117         struct rte_ring * rp;
 118         char ring_name[MAX_STRING_SIZE];
 119         int i;
 120
 121         WAIT_SYNCHRO_FOR_SLAVES();
 122
 123         /* create the same ring simultaneously on all threads */
 124         for (i = 0; i < MAX_ITER_TIMES; i++) {
 125                 rp = rte_ring_create("fr_test_once", 4096, SOCKET_ID_ANY, 0);
 126                 if ((NULL == rp) && (rte_ring_lookup("fr_test_once") == NULL))
 127                         return -1;
 128         }
 129
 130         /* create/lookup new ring several times */
 131         for (i = 0; i < MAX_ITER_TIMES; i++) {
 132                 snprintf(ring_name, sizeof(ring_name), "fr_test_%d_%d", lcore_self, i);
 133                 rp = rte_ring_create(ring_name, 4096, SOCKET_ID_ANY, 0);
 134                 if (NULL == rp)
 135                         return -1;
 136                 if (rte_ring_lookup(ring_name) != rp)
 137                         return -1;
 138         }
 139
 140         /* verify all ring created sucessful */
 141         for (i = 0; i < MAX_ITER_TIMES; i++) {
 142                 snprintf(ring_name, sizeof(ring_name), "fr_test_%d_%d", lcore_self, i);
 143                 if (rte_ring_lookup(ring_name) == NULL)
 144                         return -1;
 145         }
 146
 147         return 0;
 148 }
 149
 150 static void
 151 my_obj_init(struct rte_mempool *mp, __attribute__((unused)) void *arg,
 152             void *obj, unsigned i)
 153 {
 154         uint32_t *objnum = obj;
 155         memset(obj, 0, mp->elt_size);
 156         *objnum = i;
 157 }
 158
 159 static int
 160 mempool_create_lookup(__attribute__((unused)) void *arg)
 161 {
 162         unsigned lcore_self = rte_lcore_id();
 163         struct rte_mempool * mp;
 164         char mempool_name[MAX_STRING_SIZE];
 165         int i;
 166
 167         WAIT_SYNCHRO_FOR_SLAVES();
 168
 169         /* create the same mempool simultaneously on all threads */
 170         for (i = 0; i < MAX_ITER_TIMES; i++) {
 171                 mp = rte_mempool_create("fr_test_once",  MEMPOOL_SIZE,
 172                                         MEMPOOL_ELT_SIZE, 0, 0,
 173                                         NULL, NULL,
 174                                         my_obj_init, NULL,
 175                                         SOCKET_ID_ANY, 0);
 176                 if ((NULL == mp) && (rte_mempool_lookup("fr_test_once") == NULL))
 177                         return -1;
 178         }
 179
 180         /* create/lookup new ring several times */
 181         for (i = 0; i < MAX_ITER_TIMES; i++) {
 182                 snprintf(mempool_name, sizeof(mempool_name), "fr_test_%d_%d", lcore_self, i);
 183                 mp = rte_mempool_create(mempool_name, MEMPOOL_SIZE,
 184                                                 MEMPOOL_ELT_SIZE, 0, 0,
 185                                                 NULL, NULL,
 186                                                 my_obj_init, NULL,
 187                                                 SOCKET_ID_ANY, 0);
 188                 if (NULL == mp)
 189                         return -1;
 190                 if (rte_mempool_lookup(mempool_name) != mp)
 191                         return -1;
 192         }
 193
 194         /* verify all ring created sucessful */
 195         for (i = 0; i < MAX_ITER_TIMES; i++) {
 196                 snprintf(mempool_name, sizeof(mempool_name), "fr_test_%d_%d", lcore_self, i);
 197                 if (rte_mempool_lookup(mempool_name) == NULL)
 198                         return -1;
 199         }
 200
 201         return 0;
 202 }
 203
 204 #ifdef RTE_LIBRTE_HASH
 205 static void
 206 hash_clean(unsigned lcore_id)
 207 {
 208         char hash_name[MAX_STRING_SIZE];
 209         struct rte_hash *handle;
 210         int i;
 211
 212         for (i = 0; i < MAX_ITER_TIMES; i++) {
 213                 snprintf(hash_name, sizeof(hash_name), "fr_test_%d_%d",  lcore_id, i);
 214
 215                 if ((handle = rte_hash_find_existing(hash_name)) != NULL)
 216                         rte_hash_free(handle);
 217         }
 218 }
 219
 220 static int
 221 hash_create_free(__attribute__((unused)) void *arg)
 222 {
 223         unsigned lcore_self = rte_lcore_id();
 224         struct rte_hash *handle;
 225         char hash_name[MAX_STRING_SIZE];
 226         int i;
 227         struct rte_hash_parameters hash_params = {
 228                 .name = NULL,
 229                 .entries = 16,
 230                 .bucket_entries = 4,
 231                 .key_len = 4,
 232                 .hash_func = (rte_hash_function)rte_jhash2,
 233                 .hash_func_init_val = 0,
 234                 .socket_id = 0,
 235         };
 236
 237         WAIT_SYNCHRO_FOR_SLAVES();
 238
 239         /* create the same hash simultaneously on all threads */
 240         hash_params.name = "fr_test_once";
 241         for (i = 0; i < MAX_ITER_TIMES; i++) {
 242                 handle = rte_hash_create(&hash_params);
 243                 if ((NULL == handle) && (rte_hash_find_existing("fr_test_once") == NULL))
 244                         return -1;
 245         }
 246
 247         /* create mutiple times simultaneously */
 248         for (i = 0; i < MAX_ITER_TIMES; i++) {
 249                 snprintf(hash_name, sizeof(hash_name), "fr_test_%d_%d", lcore_self, i);
 250                 hash_params.name = hash_name;
 251
 252                 handle = rte_hash_create(&hash_params);
 253                 if (NULL == handle)
 254                         return -1;
 255
 256                 /* verify correct existing and then free all */
 257                 if (handle != rte_hash_find_existing(hash_name))
 258                         return -1;
 259
 260                 rte_hash_free(handle);
 261         }
 262
 263         /* verify free correct */
 264         for (i = 0; i < MAX_ITER_TIMES; i++) {
 265                 snprintf(hash_name, sizeof(hash_name), "fr_test_%d_%d",  lcore_self, i);
 266
 267                 if (NULL != rte_hash_find_existing(hash_name))
 268                         return -1;
 269         }
 270
 271         return 0;
 272 }
 273
 274 static void
 275 fbk_clean(unsigned lcore_id)
 276 {
 277         char fbk_name[MAX_STRING_SIZE];
 278         struct rte_fbk_hash_table *handle;
 279         int i;
 280
 281         for (i = 0; i < MAX_ITER_TIMES; i++) {
 282                 snprintf(fbk_name, sizeof(fbk_name), "fr_test_%d_%d",  lcore_id, i);
 283
 284                 if ((handle = rte_fbk_hash_find_existing(fbk_name)) != NULL)
 285                         rte_fbk_hash_free(handle);
 286         }
 287 }
 288
 289 static int
 290 fbk_create_free(__attribute__((unused)) void *arg)
 291 {
 292         unsigned lcore_self = rte_lcore_id();
 293         struct rte_fbk_hash_table *handle;
 294         char fbk_name[MAX_STRING_SIZE];
 295         int i;
 296         struct rte_fbk_hash_params fbk_params = {
 297                 .name = NULL,
 298                 .entries = 4,
 299                 .entries_per_bucket = 4,
 300                 .socket_id = 0,
 301                 .hash_func = rte_jhash_1word,
 302                 .init_val = RTE_FBK_HASH_INIT_VAL_DEFAULT,
 303         };
 304
 305         WAIT_SYNCHRO_FOR_SLAVES();
 306
 307         /* create the same fbk hash table simultaneously on all threads */
 308         fbk_params.name = "fr_test_once";
 309         for (i = 0; i < MAX_ITER_TIMES; i++) {
 310                 handle = rte_fbk_hash_create(&fbk_params);
 311                 if ((NULL == handle) && (rte_fbk_hash_find_existing("fr_test_once") == NULL))
 312                         return -1;
 313         }
 314
 315         /* create mutiple fbk tables simultaneously */
 316         for (i = 0; i < MAX_ITER_TIMES; i++) {
 317                 snprintf(fbk_name, sizeof(fbk_name), "fr_test_%d_%d", lcore_self, i);
 318                 fbk_params.name = fbk_name;
 319
 320                 handle = rte_fbk_hash_create(&fbk_params);
 321                 if (NULL == handle)
 322                         return -1;
 323
 324                 /* verify correct existing and then free all */
 325                 if (handle != rte_fbk_hash_find_existing(fbk_name))
 326                         return -1;
 327
 328                 rte_fbk_hash_free(handle);
 329         }
 330
 331         /* verify free correct */
 332         for (i = 0; i < MAX_ITER_TIMES; i++) {
 333                 snprintf(fbk_name, sizeof(fbk_name), "fr_test_%d_%d",  lcore_self, i);
 334
 335                 if (NULL != rte_fbk_hash_find_existing(fbk_name))
 336                         return -1;
 337         }
 338
 339         return 0;
 340 }
 341 #endif /* RTE_LIBRTE_HASH */
 342
 343 #ifdef RTE_LIBRTE_LPM
 344 static void
 345 lpm_clean(unsigned lcore_id)
 346 {
 347         char lpm_name[MAX_STRING_SIZE];
 348         struct rte_lpm *lpm;
 349         int i;
 350
 351         for (i = 0; i < MAX_LPM_ITER_TIMES; i++) {
 352                 snprintf(lpm_name, sizeof(lpm_name), "fr_test_%d_%d",  lcore_id, i);
 353
 354                 if ((lpm = rte_lpm_find_existing(lpm_name)) != NULL)
 355                         rte_lpm_free(lpm);
 356         }
 357 }
 358
 359 static int
 360 lpm_create_free(__attribute__((unused)) void *arg)
 361 {
 362         unsigned lcore_self = rte_lcore_id();
 363         struct rte_lpm *lpm;
 364         char lpm_name[MAX_STRING_SIZE];
 365         int i;
 366
 367         WAIT_SYNCHRO_FOR_SLAVES();
 368
 369         /* create the same lpm simultaneously on all threads */
 370         for (i = 0; i < MAX_ITER_TIMES; i++) {
 371                 lpm = rte_lpm_create("fr_test_once",  SOCKET_ID_ANY, 4, RTE_LPM_HEAP);
 372                 if ((NULL == lpm) && (rte_lpm_find_existing("fr_test_once") == NULL))
 373                         return -1;
 374         }
 375
 376         /* create mutiple fbk tables simultaneously */
 377         for (i = 0; i < MAX_LPM_ITER_TIMES; i++) {
 378                 snprintf(lpm_name, sizeof(lpm_name), "fr_test_%d_%d", lcore_self, i);
 379                 lpm = rte_lpm_create(lpm_name, SOCKET_ID_ANY, 4, RTE_LPM_HEAP);
 380                 if (NULL == lpm)
 381                         return -1;
 382
 383                 /* verify correct existing and then free all */
 384                 if (lpm != rte_lpm_find_existing(lpm_name))
 385                         return -1;
 386
 387                 rte_lpm_free(lpm);
 388         }
 389
 390         /* verify free correct */
 391         for (i = 0; i < MAX_LPM_ITER_TIMES; i++) {
 392                 snprintf(lpm_name, sizeof(lpm_name), "fr_test_%d_%d",  lcore_self, i);
 393                 if (NULL != rte_lpm_find_existing(lpm_name))
 394                         return -1;
 395         }
 396
 397         return 0;
 398 }
 399 #endif /* RTE_LIBRTE_LPM */
 400
 401 struct test_case{
 402         case_func_t    func;
 403         void*          arg;
 404         case_clean_t   clean;
 405         char           name[MAX_STRING_SIZE];
 406 };
 407
 408 /* All test cases in the test suite */
 409 struct test_case test_cases[] = {
 410         { test_eal_init_once,     NULL,  NULL,         "eal init once" },
 411         { ring_create_lookup,     NULL,  NULL,         "ring create/lookup" },
 412         { mempool_create_lookup,  NULL,  NULL,         "mempool create/lookup" },
 413 #ifdef RTE_LIBRTE_HASH
 414         { hash_create_free,       NULL,  hash_clean,   "hash create/free" },
 415         { fbk_create_free,        NULL,  fbk_clean,    "fbk create/free" },
 416 #endif /* RTE_LIBRTE_HASH */
 417 #ifdef RTE_LIBRTE_LPM
 418         { lpm_create_free,        NULL,  lpm_clean,    "lpm create/free" },
 419 #endif /* RTE_LIBRTE_LPM */
 420 };
 421
 422 /**
 423  * launch test case in two separate thread
 424  */
 425 static int
 426 launch_test(struct test_case *pt_case)
 427 {
 428         int ret = 0;
 429         unsigned lcore_id;
 430         unsigned cores_save = rte_lcore_count();
 431         unsigned cores = RTE_MIN(cores_save, MAX_LCORES);
 432
 433         if (pt_case->func == NULL)
 434                 return -1;
 435
 436         rte_atomic32_set(&synchro, 0);
 437
 438         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
 439                 if (cores == 1)
 440                         break;
 441                 cores--;
 442                 rte_eal_remote_launch(pt_case->func, pt_case->arg, lcore_id);
 443         }
 444
 445         rte_atomic32_set(&synchro, 1);
 446
 447         if (pt_case->func(pt_case->arg) < 0)
 448                 ret = -1;
 449
 450         cores = cores_save;
 451         RTE_LCORE_FOREACH_SLAVE(lcore_id) {
 452                 if (cores == 1)
 453                         break;
 454                 cores--;
 455                 if (rte_eal_wait_lcore(lcore_id) < 0)
 456                         ret = -1;
 457
 458                 if (pt_case->clean != NULL)
 459                         pt_case->clean(lcore_id);
 460         }
 461
 462         return ret;
 463 }
 464
 465 /**
 466  * Main entry of func_reentrancy test
 467  */
 468 static int
 469 test_func_reentrancy(void)
 470 {
 471         uint32_t case_id;
 472         struct test_case *pt_case = NULL;
 473
 474         if (rte_lcore_count() <= 1) {
 475                 printf("Not enough lcore for testing\n");
 476                 return -1;
 477         }
 478         else if (rte_lcore_count() > MAX_LCORES)
 479                 printf("Too many lcores, some cores will be disabled\n");
 480
 481         for (case_id = 0; case_id < sizeof(test_cases)/sizeof(struct test_case); case_id ++) {
 482                 pt_case = &test_cases[case_id];
 483                 if (pt_case->func == NULL)
 484                         continue;
 485
 486                 if (launch_test(pt_case) < 0) {
 487                         printf("Func-ReEnt CASE %"PRIu32": %s FAIL\n", case_id, pt_case->name);
 488                         return -1;
 489                 }
 490                 printf("Func-ReEnt CASE %"PRIu32": %s PASS\n", case_id, pt_case->name);
 491         }
 492
 493         return 0;
 494 }
 495
 496 static struct test_command func_reentrancy_cmd = {
 497         .command = "func_reentrancy_autotest",
 498         .callback = test_func_reentrancy,
 499 };
 500 REGISTER_TEST_COMMAND(func_reentrancy_cmd);