From 9ca670ac8a77730da0f7200be5c27e277c04f6b4 Mon Sep 17 00:00:00 2001 From: Changpeng Liu Date: Fri, 15 Dec 2017 00:39:14 -0500 Subject: [PATCH] util/crc16: add crc16 library support and unit tests Change-Id: I7174f1799361b8337ff5590b90ad6a0564ca8e9b Signed-off-by: Changpeng Liu Reviewed-on: https://review.gerrithub.io/391899 Tested-by: SPDK Automated Test System Reviewed-by: Daniel Verkamp Reviewed-by: Jim Harris --- examples/nvme/perf/perf.c | 22 +------- include/spdk/crc16.h | 66 ++++++++++++++++++++++ lib/util/Makefile | 2 +- lib/util/crc16.c | 53 ++++++++++++++++++ test/lib/nvme/e2edp/nvme_dp.c | 22 +------- test/unit/lib/util/Makefile | 2 +- test/unit/lib/util/crc16.c/.gitignore | 1 + test/unit/lib/util/crc16.c/Makefile | 53 ++++++++++++++++++ test/unit/lib/util/crc16.c/crc16_ut.c | 80 +++++++++++++++++++++++++++ unittest.sh | 1 + 10 files changed, 262 insertions(+), 40 deletions(-) create mode 100644 include/spdk/crc16.h create mode 100644 lib/util/crc16.c create mode 100644 test/unit/lib/util/crc16.c/.gitignore create mode 100644 test/unit/lib/util/crc16.c/Makefile create mode 100644 test/unit/lib/util/crc16.c/crc16_ut.c diff --git a/examples/nvme/perf/perf.c b/examples/nvme/perf/perf.c index 49cf55108..e3645e0b7 100644 --- a/examples/nvme/perf/perf.c +++ b/examples/nvme/perf/perf.c @@ -42,6 +42,7 @@ #include "spdk/nvme_intel.h" #include "spdk/histogram_data.h" #include "spdk/endian.h" +#include "spdk/crc16.h" #if HAVE_LIBAIO #include @@ -192,23 +193,6 @@ static int g_aio_optind; /* Index of first AIO filename in argv */ static void task_complete(struct perf_task *task); -static uint16_t crc16_t10dif(uint8_t *buf, size_t len) -{ - uint32_t rem = 0; - unsigned int i, j; - - uint16_t poly = 0x8bb7; - - for (i = 0; i < len; i++) { - rem = rem ^ (buf[i] << 8); - for (j = 0; j < 8; j++) { - rem = rem << 1; - rem = (rem & 0x10000) ? rem ^ poly : rem; - } - } - return (uint16_t)rem; -} - static void register_ns(struct spdk_nvme_ctrlr *ctrlr, struct spdk_nvme_ns *ns) { @@ -540,8 +524,8 @@ task_extended_lba_setup_pi(struct ns_entry *entry, struct perf_task *task, uint6 if (is_write) { if (entry->io_flags & SPDK_NVME_IO_FLAGS_PRCHK_GUARD) { /* CRC buffer should not include PI */ - crc16 = crc16_t10dif(task->buf + (sector_size + md_size) * i, - sector_size + md_size - 8); + crc16 = spdk_crc16_t10dif(task->buf + (sector_size + md_size) * i, + sector_size + md_size - 8); to_be16(&pi->guard, crc16); } if (entry->io_flags & SPDK_NVME_IO_FLAGS_PRCHK_APPTAG) { diff --git a/include/spdk/crc16.h b/include/spdk/crc16.h new file mode 100644 index 000000000..ad79a41d8 --- /dev/null +++ b/include/spdk/crc16.h @@ -0,0 +1,66 @@ +/*- + * 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. + */ + +/** + * \file + * CRC-16 utility functions + */ + +#ifndef SPDK_CRC16_H +#define SPDK_CRC16_H + +#include "spdk/stdinc.h" + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * T10-DIF CRC-16 polynomial + */ +#define SPDK_T10DIF_CRC16_POLYNOMIAL 0x8bb7u + +/** + * Calculate T10-DIF CRC-16 checksum. + * + * \param buf Data buffer to checksum. + * \param len Length of buf in bytes. + * \return CRC-16 value. + */ +uint16_t spdk_crc16_t10dif(const void *buf, size_t len); + +#ifdef __cplusplus +} +#endif + +#endif /* SPDK_CRC16_H */ diff --git a/lib/util/Makefile b/lib/util/Makefile index ad4c6be1b..f9448e579 100644 --- a/lib/util/Makefile +++ b/lib/util/Makefile @@ -35,7 +35,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../..) include $(SPDK_ROOT_DIR)/mk/spdk.common.mk CFLAGS += $(ENV_CFLAGS) -C_SRCS = bit_array.c crc32.c crc32c.c crc32_ieee.c fd.c io_channel.c string.c +C_SRCS = bit_array.c crc16.c crc32.c crc32c.c crc32_ieee.c fd.c io_channel.c string.c LIBNAME = util include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk diff --git a/lib/util/crc16.c b/lib/util/crc16.c new file mode 100644 index 000000000..491c90589 --- /dev/null +++ b/lib/util/crc16.c @@ -0,0 +1,53 @@ +/*- + * 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/crc16.h" + +uint16_t +spdk_crc16_t10dif(const void *buf, size_t len) +{ + uint32_t j, rem = 0; + const uint8_t *data = (const uint8_t *)buf; + size_t i; + + uint16_t poly = SPDK_T10DIF_CRC16_POLYNOMIAL; + + for (i = 0; i < len; i++) { + rem = rem ^ (data[i] << 8); + for (j = 0; j < 8; j++) { + rem = rem << 1; + rem = (rem & 0x10000) ? rem ^ poly : rem; + } + } + return (uint16_t)rem; +} diff --git a/test/lib/nvme/e2edp/nvme_dp.c b/test/lib/nvme/e2edp/nvme_dp.c index 991343291..640683ba4 100644 --- a/test/lib/nvme/e2edp/nvme_dp.c +++ b/test/lib/nvme/e2edp/nvme_dp.c @@ -39,6 +39,7 @@ #include "spdk/nvme.h" #include "spdk/env.h" +#include "spdk/crc16.h" static uint32_t swap32(uint32_t value) { @@ -61,23 +62,6 @@ static uint16_t swap16(uint16_t value) return result; } -static uint16_t crc16_t10dif(uint8_t *buf, size_t len) -{ - uint32_t rem = 0; - unsigned int i, j; - - uint16_t poly = 0x8bb7; - - for (i = 0; i < len; i++) { - rem = rem ^ (buf[i] << 8); - for (j = 0; j < 8; j++) { - rem = rem << 1; - rem = (rem & 0x10000) ? rem ^ poly : rem; - } - } - return (uint16_t)rem; -} - #define MAX_DEVS 64 #define DATA_PATTERN 0x5A @@ -190,10 +174,10 @@ static uint32_t dp_guard_check_extended_lba_test(struct spdk_nvme_ns *ns, struct ns_data_buffer_reset(ns, req, DATA_PATTERN); pi = (struct spdk_nvme_protection_info *)(req->contig + sector_size + md_size - 8); /* big-endian for guard */ - pi->guard = swap16(crc16_t10dif(req->contig, sector_size)); + pi->guard = swap16(spdk_crc16_t10dif(req->contig, sector_size)); pi = (struct spdk_nvme_protection_info *)(req->contig + (sector_size + md_size) * 2 - 8); - pi->guard = swap16(crc16_t10dif(req->contig + sector_size + md_size, sector_size)); + pi->guard = swap16(spdk_crc16_t10dif(req->contig + sector_size + md_size, sector_size)); *io_flags = SPDK_NVME_IO_FLAGS_PRCHK_GUARD; diff --git a/test/unit/lib/util/Makefile b/test/unit/lib/util/Makefile index bc684cd96..a14904eae 100644 --- a/test/unit/lib/util/Makefile +++ b/test/unit/lib/util/Makefile @@ -34,7 +34,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..) include $(SPDK_ROOT_DIR)/mk/spdk.common.mk -DIRS-y = bit_array.c crc32_ieee.c crc32c.c io_channel.c string.c +DIRS-y = bit_array.c crc16.c crc32_ieee.c crc32c.c io_channel.c string.c .PHONY: all clean $(DIRS-y) diff --git a/test/unit/lib/util/crc16.c/.gitignore b/test/unit/lib/util/crc16.c/.gitignore new file mode 100644 index 000000000..d026adf09 --- /dev/null +++ b/test/unit/lib/util/crc16.c/.gitignore @@ -0,0 +1 @@ +crc16_ut diff --git a/test/unit/lib/util/crc16.c/Makefile b/test/unit/lib/util/crc16.c/Makefile new file mode 100644 index 000000000..0d1c275a8 --- /dev/null +++ b/test/unit/lib/util/crc16.c/Makefile @@ -0,0 +1,53 @@ +# +# 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 +include $(SPDK_ROOT_DIR)/mk/spdk.app.mk + +CFLAGS += -I$(SPDK_ROOT_DIR)/test +CFLAGS += -I$(SPDK_ROOT_DIR)/lib/util +APP = crc16_ut +C_SRCS := crc16_ut.c + +LIBS += -lcunit + +all : $(APP) + +$(APP) : $(OBJS) $(SPDK_LIBS) + $(LINK_C) + +clean : + $(CLEAN_C) $(APP) + +include $(SPDK_ROOT_DIR)/mk/spdk.deps.mk diff --git a/test/unit/lib/util/crc16.c/crc16_ut.c b/test/unit/lib/util/crc16.c/crc16_ut.c new file mode 100644 index 000000000..bab6ffcd7 --- /dev/null +++ b/test/unit/lib/util/crc16.c/crc16_ut.c @@ -0,0 +1,80 @@ +/*- + * 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 "crc16.c" + +static void +test_crc16_t10dif(void) +{ + uint16_t crc; + char buf[] = "123456789"; + + crc = spdk_crc16_t10dif(buf, strlen(buf)); + CU_ASSERT(crc == 0xd0db); +} + +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("crc16", NULL, NULL); + if (suite == NULL) { + CU_cleanup_registry(); + return CU_get_error(); + } + + if ( + CU_add_test(suite, "test_crc16_t10dif", test_crc16_t10dif) == 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/unittest.sh b/unittest.sh index 1a1d48e10..dbe9e3c13 100755 --- a/unittest.sh +++ b/unittest.sh @@ -99,6 +99,7 @@ $valgrind test/unit/lib/iscsi/iscsi.c/iscsi_ut $valgrind test/unit/lib/iscsi/init_grp.c/init_grp_ut test/unit/lib/iscsi/init_grp.c/init_grp.conf $valgrind test/unit/lib/util/bit_array.c/bit_array_ut +$valgrind test/unit/lib/util/crc16.c/crc16_ut $valgrind test/unit/lib/util/crc32_ieee.c/crc32_ieee_ut $valgrind test/unit/lib/util/crc32c.c/crc32c_ut $valgrind test/unit/lib/util/io_channel.c/io_channel_ut