Skip to content

Commit

Permalink
misc: Always test the portable version of the math_extras.h functions.
Browse files Browse the repository at this point in the history 
The implementation of the <misc/math_extras.h> functions will use the
portable C code when PORTABLE_MISC_MATH_EXTRAS is defined before
including the header.

Use this feature macro to make sure that the unit test always tests the
portable functions in addition to the ones using builtins for the
current compiler.

Signed-off-by: Jakob Olesen <jolesen@fb.com>
  • Loading branch information
@galak
Jakob Olesen authored and galak committed May 15, 2019
1 parent b2945d3 commit 0e65aab
Show file tree
Hide file tree
Showing 4 changed files with 216 additions and 174 deletions.
1 change: 1 addition & 0 deletions tests/unit/math_extras/CMakeLists.txt
View file
Original file line number Original file line Diff line number Diff line change
@@ -1,4 +1,5 @@
# SPDX-License-Identifier: Apache-2.0 # SPDX-License-Identifier: Apache-2.0


project(math_extras) project(math_extras)
set(SOURCES main.c portable.c)
include($ENV{ZEPHYR_BASE}/subsys/testsuite/unittest.cmake) include($ENV{ZEPHYR_BASE}/subsys/testsuite/unittest.cmake)
180 changes: 6 additions & 174 deletions tests/unit/math_extras/main.c
View file
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -4,181 +4,11 @@
* SPDX-License-Identifier: Apache-2.0 * SPDX-License-Identifier: Apache-2.0
*/ */


#include <ztest.h> /* Test the normal version of the math_extras.h functions */
#include <misc/math_extras.h> #define VNAME(N) test_##N
#include <inttypes.h> #include "tests.inc"


static void test_u32_add(void) extern void test_portable_math_extras(void);
{
u32_t result = 42;

zassert_false(u32_add_overflow(2, 3, &result), NULL);
zassert_equal(result, 5, NULL);

zassert_false(u32_add_overflow(2, 0, &result), NULL);
zassert_equal(result, 2, NULL);

zassert_false(u32_add_overflow(0, 3, &result), NULL);
zassert_equal(result, 3, NULL);

zassert_false(u32_add_overflow(0, UINT32_MAX, &result), NULL);
zassert_equal(result, UINT32_MAX, NULL);
zassert_true(u32_add_overflow(1, UINT32_MAX, &result), NULL);
zassert_equal(result, 0, NULL);

zassert_false(u32_add_overflow(UINT32_MAX, 0, &result), NULL);
zassert_equal(result, UINT32_MAX, NULL);
zassert_true(u32_add_overflow(UINT32_MAX, 2, &result), NULL);
zassert_equal(result, 1, NULL);
}

static void test_u32_mul(void)
{
u32_t result = 42;

zassert_false(u32_mul_overflow(2, 3, &result), NULL);
zassert_equal(result, 6, NULL);

zassert_false(u32_mul_overflow(UINT32_MAX, 1, &result), NULL);
zassert_equal(result, UINT32_MAX, NULL);
zassert_true(u32_mul_overflow(UINT32_MAX, 2, &result), NULL);
zassert_equal(result, UINT32_MAX * 2, NULL);

zassert_false(u32_mul_overflow(1, UINT32_MAX, &result), NULL);
zassert_equal(result, UINT32_MAX, NULL);
zassert_true(u32_mul_overflow(2, UINT32_MAX, &result), NULL);
zassert_equal(result, UINT32_MAX * 2, NULL);
}

static void test_u64_add(void)
{
u64_t result = 42;

zassert_false(u64_add_overflow(2, 3, &result), NULL);
zassert_equal(result, 5, NULL);

zassert_false(u64_add_overflow(2, 0, &result), NULL);
zassert_equal(result, 2, NULL);

zassert_false(u64_add_overflow(0, 3, &result), NULL);
zassert_equal(result, 3, NULL);

zassert_false(u64_add_overflow(0, UINT64_MAX, &result), NULL);
zassert_equal(result, UINT64_MAX, NULL);
zassert_true(u64_add_overflow(1, UINT64_MAX, &result), NULL);
zassert_equal(result, 0, NULL);

zassert_false(u64_add_overflow(UINT64_MAX, 0, &result), NULL);
zassert_equal(result, UINT64_MAX, NULL);
zassert_true(u64_add_overflow(UINT64_MAX, 2, &result), NULL);
zassert_equal(result, 1, NULL);
}

static void test_u64_mul(void)
{
u64_t result = 42;

zassert_false(u64_mul_overflow(2, 3, &result), NULL);
zassert_equal(result, 6, NULL);

zassert_false(u64_mul_overflow(UINT64_MAX, 1, &result), NULL);
zassert_equal(result, UINT64_MAX, NULL);
zassert_true(u64_mul_overflow(UINT64_MAX, 2, &result), NULL);
zassert_equal(result, UINT64_MAX * 2, NULL);

zassert_false(u64_mul_overflow(1, UINT64_MAX, &result), NULL);
zassert_equal(result, UINT64_MAX, NULL);
zassert_true(u64_mul_overflow(2, UINT64_MAX, &result), NULL);
zassert_equal(result, UINT64_MAX * 2, NULL);
}

static void test_size_add(void)
{
size_t result = 42;

zassert_false(size_add_overflow(2, 3, &result), NULL);
zassert_equal(result, 5, NULL);

zassert_false(size_add_overflow(2, 0, &result), NULL);
zassert_equal(result, 2, NULL);

zassert_false(size_add_overflow(0, 3, &result), NULL);
zassert_equal(result, 3, NULL);

zassert_false(size_add_overflow(0, SIZE_MAX, &result), NULL);
zassert_equal(result, SIZE_MAX, NULL);
zassert_true(size_add_overflow(1, SIZE_MAX, &result), NULL);
zassert_equal(result, 0, NULL);

zassert_false(size_add_overflow(SIZE_MAX, 0, &result), NULL);
zassert_equal(result, SIZE_MAX, NULL);
zassert_true(size_add_overflow(SIZE_MAX, 2, &result), NULL);
zassert_equal(result, 1, NULL);
}

static void test_size_mul(void)
{
size_t result = 42;

zassert_false(size_mul_overflow(2, 3, &result), NULL);
zassert_equal(result, 6, NULL);

zassert_false(size_mul_overflow(SIZE_MAX, 1, &result), NULL);
zassert_equal(result, SIZE_MAX, NULL);
zassert_true(size_mul_overflow(SIZE_MAX, 2, &result), NULL);
zassert_equal(result, SIZE_MAX * 2, NULL);

zassert_false(size_mul_overflow(1, SIZE_MAX, &result), NULL);
zassert_equal(result, SIZE_MAX, NULL);
zassert_true(size_mul_overflow(2, SIZE_MAX, &result), NULL);
zassert_equal(result, SIZE_MAX * 2, NULL);
}

static void test_u32_clz(void)
{
zassert_equal(u32_count_leading_zeros(0), 32, NULL);
zassert_equal(u32_count_leading_zeros(1), 31, NULL);
zassert_equal(u32_count_leading_zeros(0xf00f), 16, NULL);
zassert_equal(u32_count_leading_zeros(0xf00ff00f), 0, NULL);
zassert_equal(u32_count_leading_zeros(0xffffffff), 0, NULL);
}

static void test_u64_clz(void)
{
zassert_equal(u64_count_leading_zeros(0), 64, NULL);
zassert_equal(u64_count_leading_zeros(1), 63, NULL);
zassert_equal(u64_count_leading_zeros(0xf00f), 48, NULL);
zassert_equal(u64_count_leading_zeros(0xf00ff00f), 32, NULL);
zassert_equal(u64_count_leading_zeros(0xffffffff), 32, NULL);
zassert_equal(u64_count_leading_zeros(0xf00f00000000ull), 16, NULL);
zassert_equal(u64_count_leading_zeros(0xf00ff00f00000000ull), 0, NULL);
zassert_equal(u64_count_leading_zeros(0xffffffff00000000ull), 0, NULL);
}

static void test_u32_ctz(void)
{
zassert_equal(u32_count_trailing_zeros(0), 32, NULL);
zassert_equal(u32_count_trailing_zeros(1), 0, NULL);
zassert_equal(u32_count_trailing_zeros(6), 1, NULL);
zassert_equal(u32_count_trailing_zeros(0x00f00f00), 8, NULL);
zassert_equal(u32_count_trailing_zeros(0xf00ffc00), 10, NULL);
zassert_equal(u32_count_trailing_zeros(0xffffffff), 0, NULL);
zassert_equal(u32_count_trailing_zeros(0x80000000), 31, NULL);
}

static void test_u64_ctz(void)
{
zassert_equal(u64_count_trailing_zeros(0), 64, NULL);
zassert_equal(u64_count_trailing_zeros(1), 0, NULL);
zassert_equal(u64_count_trailing_zeros(6), 1, NULL);
zassert_equal(u64_count_trailing_zeros(0x00f00f00), 8, NULL);
zassert_equal(u64_count_trailing_zeros(0xf00ffc00), 10, NULL);
zassert_equal(u64_count_trailing_zeros(0xffffffffffffffffull), 0, NULL);
zassert_equal(u64_count_trailing_zeros(0x8000000080000000ull), 31,
NULL);
zassert_equal(u64_count_trailing_zeros(0xc000000000000000ull), 62,
NULL);
}


void test_main(void) void test_main(void)
{ {
Expand All @@ -196,4 +26,6 @@ void test_main(void)
ztest_unit_test(test_u64_ctz)); ztest_unit_test(test_u64_ctz));
ztest_run_test_suite(test_math_extras); ztest_run_test_suite(test_math_extras);
/* clang-format on */ /* clang-format on */

test_portable_math_extras();
} }
28 changes: 28 additions & 0 deletions tests/unit/math_extras/portable.c
View file
Original file line number Original file line Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright (c) 2019 Facebook
*
* SPDX-License-Identifier: Apache-2.0
*/

/* Test the portable version of the math_extras.h functions */
#define PORTABLE_MISC_MATH_EXTRAS 1
#define VNAME(N) test_portable_##N
#include "tests.inc"

void test_portable_math_extras(void)
{
/* clang-format off */
ztest_test_suite(test_portable_math_extras,
ztest_unit_test(test_portable_u32_add),
ztest_unit_test(test_portable_u32_mul),
ztest_unit_test(test_portable_u64_add),
ztest_unit_test(test_portable_u64_mul),
ztest_unit_test(test_portable_size_add),
ztest_unit_test(test_portable_size_mul),
ztest_unit_test(test_portable_u32_clz),
ztest_unit_test(test_portable_u64_clz),
ztest_unit_test(test_portable_u32_ctz),
ztest_unit_test(test_portable_u64_ctz));
ztest_run_test_suite(test_portable_math_extras);
/* clang-format on */
}
Loading

0 comments on commit 0e65aab

Please sign in to comment.