util/crc16: add crc16 library support and unit tests (9ca670ac) · Commits · Public Repositories / spdk

examples/nvme/perf/perf.c

+3 −19

Original line number	Diff line number	Diff line
		@@ -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 <libaio.h>
		@@ -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,7 +524,7 @@ 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,
		crc16 = spdk_crc16_t10dif(task->buf + (sector_size + md_size) * i,
		sector_size + md_size - 8);
		to_be16(&pi->guard, crc16);
		}

include/spdk/crc16.h

0 → 100644

+66 −0

Original line number	Diff line number	Diff line
		/*-
		* 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 */

lib/util/Makefile

+1 −1

Original line number	Diff line number	Diff line
		@@ -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

lib/util/crc16.c

0 → 100644

+53 −0

Original line number	Diff line number	Diff line
		/*-
		* 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;
		}

test/lib/nvme/e2edp/nvme_dp.c

+3 −19

Original line number	Diff line number	Diff line
		@@ -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;