diff --git a/CHANGELOG.md b/CHANGELOG.md index 2a8c8dca6..90c3daa04 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -37,6 +37,11 @@ Support for AES_XTS was added for the QAT polled mode driver (pmd). The create AES_CBC (default) or AES_XTS. AES_XTS isonly valid when using the QAT polled mode driver. The key2 parameter is the second key required for AES_XTS. +### util + +New functions `spdk_sn32_lt` and `spdk_sn32_gt` have been added. They compare two sequence +numbers based on serial number arithmetic. + ## v20.01 ### bdev diff --git a/include/spdk/util.h b/include/spdk/util.h index 41734e46e..6358524fa 100644 --- a/include/spdk/util.h +++ b/include/spdk/util.h @@ -135,6 +135,54 @@ size_t spdk_iovcpy(struct iovec *siov, size_t siovcnt, struct iovec *diov, size_ } \ } while (0) +/** + * Add two sequece numbers s1 and s2 + * + * \param s1 First sequence number + * \param s2 Second sequence number + * + * \return Sum of s1 and s2 based on serial number arithmetic. + */ +static inline uint32_t +spdk_sn32_add(uint32_t s1, uint32_t s2) +{ + return (uint32_t)(s1 + s2); +} + +#define SPDK_SN32_CMPMAX (1U << (32 - 1)) + +/** + * Compare if sequence number s1 is less than s2. + * + * \param s1 First sequence number + * \param s2 Second sequence number + * + * \return true if s1 is less than s2, or false otherwise. + */ +static inline bool +spdk_sn32_lt(uint32_t s1, uint32_t s2) +{ + return (s1 != s2) && + ((s1 < s2 && s2 - s1 < SPDK_SN32_CMPMAX) || + (s1 > s2 && s1 - s2 > SPDK_SN32_CMPMAX)); +} + +/** + * Compare if sequence number s1 is greater than s2. + * + * \param s1 First sequence number + * \param s2 Second sequence number + * + * \return true if s1 is greater than s2, or false otherwise. + */ +static inline bool +spdk_sn32_gt(uint32_t s1, uint32_t s2) +{ + return (s1 != s2) && + ((s1 < s2 && s2 - s1 > SPDK_SN32_CMPMAX) || + (s1 > s2 && s1 - s2 < SPDK_SN32_CMPMAX)); +} + #ifdef __cplusplus } #endif diff --git a/test/unit/lib/util/Makefile b/test/unit/lib/util/Makefile index 20cf5b124..221715725 100644 --- a/test/unit/lib/util/Makefile +++ b/test/unit/lib/util/Makefile @@ -35,7 +35,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..) include $(SPDK_ROOT_DIR)/mk/spdk.common.mk DIRS-y = base64.c bit_array.c cpuset.c crc16.c crc32_ieee.c crc32c.c dif.c \ - iov.c pipe.c string.c + iov.c math.c pipe.c string.c .PHONY: all clean $(DIRS-y) diff --git a/test/unit/lib/util/math.c/.gitignore b/test/unit/lib/util/math.c/.gitignore new file mode 100644 index 000000000..e51846f2b --- /dev/null +++ b/test/unit/lib/util/math.c/.gitignore @@ -0,0 +1 @@ +math_ut diff --git a/test/unit/lib/util/math.c/Makefile b/test/unit/lib/util/math.c/Makefile new file mode 100644 index 000000000..e8b20c6be --- /dev/null +++ b/test/unit/lib/util/math.c/Makefile @@ -0,0 +1,39 @@ +# +# BSD LICENSE +# +# Copyright (c) Intel Corporation. +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# * Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in +# the documentation and/or other materials provided with the +# distribution. +# * Neither the name of Intel Corporation nor the names of its +# contributors may be used to endorse or promote products derived +# from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../../..) +include $(SPDK_ROOT_DIR)/mk/spdk.common.mk + +TEST_FILE = math_ut.c + +include $(SPDK_ROOT_DIR)/mk/spdk.unittest.mk diff --git a/test/unit/lib/util/math.c/math_ut.c b/test/unit/lib/util/math.c/math_ut.c new file mode 100644 index 000000000..c4b4f630b --- /dev/null +++ b/test/unit/lib/util/math.c/math_ut.c @@ -0,0 +1,92 @@ +/*- + * BSD LICENSE + * + * Copyright (c) Intel Corporation. + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * * Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * * Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in + * the documentation and/or other materials provided with the + * distribution. + * * Neither the name of Intel Corporation nor the names of its + * contributors may be used to endorse or promote products derived + * from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include "spdk/stdinc.h" + +#include "spdk_cunit.h" + +#include "util/math.c" + +static void +test_serial_number_arithmetic(void) +{ + CU_ASSERT(spdk_sn32_add(0, 1) == 1); + CU_ASSERT(spdk_sn32_add(1, 1) == 2); + CU_ASSERT(spdk_sn32_add(1, 2) == 3); + CU_ASSERT(spdk_sn32_add(1, UINT32_MAX) == 0); + CU_ASSERT(spdk_sn32_add(UINT32_MAX, UINT32_MAX) == UINT32_MAX - 1); + CU_ASSERT(spdk_sn32_gt(1, 0) == true); + CU_ASSERT(spdk_sn32_gt(2, 1) == true); + CU_ASSERT(spdk_sn32_gt(UINT32_MAX, UINT32_MAX - 1) == true); + CU_ASSERT(spdk_sn32_gt(0, UINT32_MAX) == true); + CU_ASSERT(spdk_sn32_gt(100, UINT32_MAX - 100) == true); + CU_ASSERT(spdk_sn32_lt(1, 0) == false); + CU_ASSERT(spdk_sn32_lt(2, 1) == false); + CU_ASSERT(spdk_sn32_lt(UINT32_MAX, UINT32_MAX - 1) == false); + CU_ASSERT(spdk_sn32_lt(0, UINT32_MAX) == false); + CU_ASSERT(spdk_sn32_lt(100, UINT32_MAX - 100) == false); +} + +int +main(int argc, char **argv) +{ + CU_pSuite suite = NULL; + unsigned int num_failures; + + if (CU_initialize_registry() != CUE_SUCCESS) { + return CU_get_error(); + } + + suite = CU_add_suite("math", NULL, NULL); + if (suite == NULL) { + CU_cleanup_registry(); + return CU_get_error(); + } + + if ( + CU_add_test(suite, "test_serial_number_arithmetic", + test_serial_number_arithmetic) == NULL + ) { + CU_cleanup_registry(); + return CU_get_error(); + } + + CU_basic_set_mode(CU_BRM_VERBOSE); + + CU_basic_run_tests(); + + num_failures = CU_get_number_of_failures(); + CU_cleanup_registry(); + + return num_failures; +} diff --git a/test/unit/unittest.sh b/test/unit/unittest.sh index b0d35c670..2ae70c3a3 100755 --- a/test/unit/unittest.sh +++ b/test/unit/unittest.sh @@ -111,6 +111,7 @@ function unittest_util { $valgrind $testdir/lib/util/string.c/string_ut $valgrind $testdir/lib/util/dif.c/dif_ut $valgrind $testdir/lib/util/iov.c/iov_ut + $valgrind $testdir/lib/util/math.c/math_ut $valgrind $testdir/lib/util/pipe.c/pipe_ut }