Commit 0e65aab7 authored by Jakob Olesen's avatar Jakob Olesen Committed by Kumar Gala
Browse files

misc: Always test the portable version of the math_extras.h functions. 



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: default avatarJakob Olesen <jolesen@fb.com>
parent b2945d30

tests/unit/math_extras/CMakeLists.txt

+1 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: Apache-2.0



project(math_extras)

set(SOURCES main.c portable.c)

include($ENV{ZEPHYR_BASE}/subsys/testsuite/unittest.cmake)

tests/unit/math_extras/main.c

+6 −174
Original line number Diff line number Diff line
@@ -4,181 +4,11 @@ 
 * SPDX-License-Identifier: Apache-2.0

 */



#include <ztest.h>

#include <misc/math_extras.h>

#include <inttypes.h>

/* Test the normal version of the math_extras.h functions */

#define VNAME(N) test_##N

#include "tests.inc"



static void test_u32_add(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);

}

extern void test_portable_math_extras(void);



void test_main(void)

{
@@ -196,4 +26,6 @@ void test_main(void) 
		ztest_unit_test(test_u64_ctz));

	ztest_run_test_suite(test_math_extras);

	/* clang-format on */



	test_portable_math_extras();

}

tests/unit/math_extras/portable.c

0 → 100644
+28 −0
Original line number Diff line number Diff line 
/*

 * 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 */

}

tests/unit/math_extras/tests.inc

0 → 100644
+181 −0
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2019 Facebook

 *

 * SPDX-License-Identifier: Apache-2.0

 */



#include <ztest.h>

#include <misc/math_extras.h>

#include <inttypes.h>



static void VNAME(u32_add)(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 VNAME(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 VNAME(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 VNAME(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 VNAME(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 VNAME(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 VNAME(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 VNAME(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 VNAME(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 VNAME(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);

}

CRA Git | Maintained and supported by SUSTech CRA and CCSE