numam-dpdk/app/test/test_stack.c
Stanislaw Kardach 1abb185d6c stack: allow lock-free only on relevant architectures
Since commit 7911ba0473 ("stack: enable lock-free implementation for
aarch64"), lock-free stack is supported on arm64 but this description was
missing from the doxygen for the flag.

Currently it is impossible to detect programmatically whether lock-free
implementation of rte_stack is supported. One could check whether the
header guard for lock-free stubs is defined (_RTE_STACK_LF_STUBS_H_) but
that's an unstable implementation detail. Because of that currently all
lock-free ring creations silently succeed (as long as the stack header
is 16B long) which later leads to push and pop operations being NOPs.
The observable effect is that stack_lf_autotest fails on platforms not
supporting the lock-free. Instead it should just skip the lock-free test
altogether.

This commit adds a new errno value (ENOTSUP) that may be returned by
rte_stack_create() to indicate that a given combination of flags is not
supported on a current platform.
This is detected by checking a compile-time flag in the include logic in
rte_stack_lf.h which may be used by applications to check the lock-free
support at compile time.

Use the added RTE_STACK_LF_SUPPORTED flag to disable the lock-free stack
tests at the compile time.
Perf test doesn't fail because rte_ring_create() succeeds, however
marking this test as skipped gives a better indication of what actually
was tested.

Fixes: 7911ba0473 ("stack: enable lock-free implementation for aarch64")

Signed-off-by: Stanislaw Kardach <kda@semihalf.com>
Acked-by: Olivier Matz <olivier.matz@6wind.com>
2021-05-03 18:46:15 +02:00

385 lines
8.1 KiB
C

/* SPDX-License-Identifier: BSD-3-Clause
* Copyright(c) 2019 Intel Corporation
*/
#include <string.h>
#include <rte_atomic.h>
#include <rte_lcore.h>
#include <rte_malloc.h>
#include <rte_random.h>
#include <rte_stack.h>
#include "test.h"
#define STACK_SIZE 4096
#define MAX_BULK 32
static int
test_stack_push_pop(struct rte_stack *s, void **obj_table, unsigned int bulk_sz)
{
unsigned int i, ret;
void **popped_objs;
popped_objs = rte_calloc(NULL, STACK_SIZE, sizeof(void *), 0);
if (popped_objs == NULL) {
printf("[%s():%u] failed to calloc %zu bytes\n",
__func__, __LINE__, STACK_SIZE * sizeof(void *));
return -1;
}
for (i = 0; i < STACK_SIZE; i += bulk_sz) {
ret = rte_stack_push(s, &obj_table[i], bulk_sz);
if (ret != bulk_sz) {
printf("[%s():%u] push returned: %d (expected %u)\n",
__func__, __LINE__, ret, bulk_sz);
rte_free(popped_objs);
return -1;
}
if (rte_stack_count(s) != i + bulk_sz) {
printf("[%s():%u] stack count: %u (expected %u)\n",
__func__, __LINE__, rte_stack_count(s),
i + bulk_sz);
rte_free(popped_objs);
return -1;
}
if (rte_stack_free_count(s) != STACK_SIZE - i - bulk_sz) {
printf("[%s():%u] stack free count: %u (expected %u)\n",
__func__, __LINE__, rte_stack_count(s),
STACK_SIZE - i - bulk_sz);
rte_free(popped_objs);
return -1;
}
}
for (i = 0; i < STACK_SIZE; i += bulk_sz) {
ret = rte_stack_pop(s, &popped_objs[i], bulk_sz);
if (ret != bulk_sz) {
printf("[%s():%u] pop returned: %d (expected %u)\n",
__func__, __LINE__, ret, bulk_sz);
rte_free(popped_objs);
return -1;
}
if (rte_stack_count(s) != STACK_SIZE - i - bulk_sz) {
printf("[%s():%u] stack count: %u (expected %u)\n",
__func__, __LINE__, rte_stack_count(s),
STACK_SIZE - i - bulk_sz);
rte_free(popped_objs);
return -1;
}
if (rte_stack_free_count(s) != i + bulk_sz) {
printf("[%s():%u] stack free count: %u (expected %u)\n",
__func__, __LINE__, rte_stack_count(s),
i + bulk_sz);
rte_free(popped_objs);
return -1;
}
}
for (i = 0; i < STACK_SIZE; i++) {
if (obj_table[i] != popped_objs[STACK_SIZE - i - 1]) {
printf("[%s():%u] Incorrect value %p at index 0x%x\n",
__func__, __LINE__,
popped_objs[STACK_SIZE - i - 1], i);
rte_free(popped_objs);
return -1;
}
}
rte_free(popped_objs);
return 0;
}
static int
test_stack_basic(uint32_t flags)
{
struct rte_stack *s = NULL;
void **obj_table = NULL;
int i, ret = -1;
obj_table = rte_calloc(NULL, STACK_SIZE, sizeof(void *), 0);
if (obj_table == NULL) {
printf("[%s():%u] failed to calloc %zu bytes\n",
__func__, __LINE__, STACK_SIZE * sizeof(void *));
goto fail_test;
}
for (i = 0; i < STACK_SIZE; i++)
obj_table[i] = (void *)(uintptr_t)i;
s = rte_stack_create(__func__, STACK_SIZE, rte_socket_id(), flags);
if (s == NULL) {
printf("[%s():%u] failed to create a stack\n",
__func__, __LINE__);
goto fail_test;
}
if (rte_stack_lookup(__func__) != s) {
printf("[%s():%u] failed to lookup a stack\n",
__func__, __LINE__);
goto fail_test;
}
if (rte_stack_count(s) != 0) {
printf("[%s():%u] stack count: %u (expected 0)\n",
__func__, __LINE__, rte_stack_count(s));
goto fail_test;
}
if (rte_stack_free_count(s) != STACK_SIZE) {
printf("[%s():%u] stack free count: %u (expected %u)\n",
__func__, __LINE__, rte_stack_count(s), STACK_SIZE);
goto fail_test;
}
ret = test_stack_push_pop(s, obj_table, 1);
if (ret) {
printf("[%s():%u] Single object push/pop failed\n",
__func__, __LINE__);
goto fail_test;
}
ret = test_stack_push_pop(s, obj_table, MAX_BULK);
if (ret) {
printf("[%s():%u] Bulk object push/pop failed\n",
__func__, __LINE__);
goto fail_test;
}
ret = rte_stack_push(s, obj_table, 2 * STACK_SIZE);
if (ret != 0) {
printf("[%s():%u] Excess objects push succeeded\n",
__func__, __LINE__);
goto fail_test;
}
ret = rte_stack_pop(s, obj_table, 1);
if (ret != 0) {
printf("[%s():%u] Empty stack pop succeeded\n",
__func__, __LINE__);
goto fail_test;
}
ret = 0;
fail_test:
rte_stack_free(s);
rte_free(obj_table);
return ret;
}
static int
test_stack_name_reuse(uint32_t flags)
{
struct rte_stack *s[2];
s[0] = rte_stack_create("test", STACK_SIZE, rte_socket_id(), flags);
if (s[0] == NULL) {
printf("[%s():%u] Failed to create a stack\n",
__func__, __LINE__);
return -1;
}
s[1] = rte_stack_create("test", STACK_SIZE, rte_socket_id(), flags);
if (s[1] != NULL) {
printf("[%s():%u] Failed to detect re-used name\n",
__func__, __LINE__);
return -1;
}
rte_stack_free(s[0]);
return 0;
}
static int
test_stack_name_length(uint32_t flags)
{
char name[RTE_STACK_NAMESIZE + 1];
struct rte_stack *s;
memset(name, 's', sizeof(name));
name[RTE_STACK_NAMESIZE] = '\0';
s = rte_stack_create(name, STACK_SIZE, rte_socket_id(), flags);
if (s != NULL) {
printf("[%s():%u] Failed to prevent long name\n",
__func__, __LINE__);
return -1;
}
if (rte_errno != ENAMETOOLONG) {
printf("[%s():%u] rte_stack failed to set correct errno on failed lookup\n",
__func__, __LINE__);
return -1;
}
return 0;
}
static int
test_lookup_null(void)
{
struct rte_stack *s = rte_stack_lookup("stack_not_found");
if (s != NULL) {
printf("[%s():%u] rte_stack found a non-existent stack\n",
__func__, __LINE__);
return -1;
}
if (rte_errno != ENOENT) {
printf("[%s():%u] rte_stack failed to set correct errno on failed lookup\n",
__func__, __LINE__);
return -1;
}
s = rte_stack_lookup(NULL);
if (s != NULL) {
printf("[%s():%u] rte_stack found a non-existent stack\n",
__func__, __LINE__);
return -1;
}
if (rte_errno != EINVAL) {
printf("[%s():%u] rte_stack failed to set correct errno on failed lookup\n",
__func__, __LINE__);
return -1;
}
return 0;
}
static int
test_free_null(void)
{
/* Check whether the library proper handles a NULL pointer */
rte_stack_free(NULL);
return 0;
}
#define NUM_ITERS_PER_THREAD 100000
struct test_args {
struct rte_stack *s;
};
static struct test_args thread_test_args;
static int
stack_thread_push_pop(__rte_unused void *args)
{
void *obj_table[MAX_BULK];
int i;
for (i = 0; i < NUM_ITERS_PER_THREAD; i++) {
unsigned int num;
num = rte_rand() % MAX_BULK;
if (rte_stack_push(thread_test_args.s, obj_table, num) != num) {
printf("[%s():%u] Failed to push %u pointers\n",
__func__, __LINE__, num);
return -1;
}
if (rte_stack_pop(thread_test_args.s, obj_table, num) != num) {
printf("[%s():%u] Failed to pop %u pointers\n",
__func__, __LINE__, num);
return -1;
}
}
return 0;
}
static int
test_stack_multithreaded(uint32_t flags)
{
unsigned int lcore_id;
struct rte_stack *s;
int result = 0;
if (rte_lcore_count() < 2) {
printf("Not enough cores for test_stack_multithreaded, expecting at least 2\n");
return TEST_SKIPPED;
}
printf("[%s():%u] Running with %u lcores\n",
__func__, __LINE__, rte_lcore_count());
s = rte_stack_create("test", MAX_BULK * rte_lcore_count(), rte_socket_id(), flags);
if (s == NULL) {
printf("[%s():%u] Failed to create a stack\n",
__func__, __LINE__);
return -1;
}
thread_test_args.s = s;
if (rte_eal_mp_remote_launch(stack_thread_push_pop, NULL, CALL_MAIN))
rte_panic("Failed to launch tests\n");
RTE_LCORE_FOREACH(lcore_id) {
if (rte_eal_wait_lcore(lcore_id) < 0)
result = -1;
}
rte_stack_free(s);
return result;
}
static int
__test_stack(uint32_t flags)
{
if (test_stack_basic(flags) < 0)
return -1;
if (test_lookup_null() < 0)
return -1;
if (test_free_null() < 0)
return -1;
if (test_stack_name_reuse(flags) < 0)
return -1;
if (test_stack_name_length(flags) < 0)
return -1;
if (test_stack_multithreaded(flags) < 0)
return -1;
return 0;
}
static int
test_stack(void)
{
return __test_stack(0);
}
static int
test_lf_stack(void)
{
#if defined(RTE_STACK_LF_SUPPORTED)
return __test_stack(RTE_STACK_F_LF);
#else
return TEST_SKIPPED;
#endif
}
REGISTER_TEST_COMMAND(stack_autotest, test_stack);
REGISTER_TEST_COMMAND(stack_lf_autotest, test_lf_stack);