045e77c235
For copied extended LBA payload, Introduce a struct to collect DIF error information and pass the reference to the struct to bit-flip error injection and verification. This change will make logging of DIF error and comparison between injection and verification possible for copied extended LBA payload. Merging this patch to the previous is possible but add this as a separate patch to reduce the patch size. Change-Id: I9f7ac1332fe63cb206c692d0876c8de41ef9286f Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-on: https://review.gerrithub.io/c/435227 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: wuzhouhui <wuzhouhui@kingsoft.com> Reviewed-by: Jim Harris <james.r.harris@intel.com>
200 lines
6.6 KiB
C
200 lines
6.6 KiB
C
/*-
|
|
* 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.
|
|
*/
|
|
|
|
#ifndef SPDK_DIF_H
|
|
#define SPDK_DIF_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
#include "spdk/assert.h"
|
|
|
|
#define SPDK_DIF_REFTAG_CHECK (1U << 26)
|
|
#define SPDK_DIF_APPTAG_CHECK (1U << 27)
|
|
#define SPDK_DIF_GUARD_CHECK (1U << 28)
|
|
|
|
#define SPDK_DIF_REFTAG_ERROR 0x1
|
|
#define SPDK_DIF_APPTAG_ERROR 0x2
|
|
#define SPDK_DIF_GUARD_ERROR 0x4
|
|
#define SPDK_DIF_DATA_ERROR 0x8
|
|
|
|
enum spdk_dif_type {
|
|
SPDK_DIF_DISABLE = 0,
|
|
SPDK_DIF_TYPE1 = 1,
|
|
SPDK_DIF_TYPE2 = 2,
|
|
SPDK_DIF_TYPE3 = 3,
|
|
};
|
|
|
|
struct spdk_dif {
|
|
uint16_t guard;
|
|
uint16_t app_tag;
|
|
uint32_t ref_tag;
|
|
};
|
|
SPDK_STATIC_ASSERT(sizeof(struct spdk_dif) == 8, "Incorrect size");
|
|
|
|
/** DIF context information */
|
|
struct spdk_dif_ctx {
|
|
/** Block size */
|
|
uint32_t block_size;
|
|
|
|
/** Metadata size */
|
|
uint32_t md_size;
|
|
|
|
/** Interval for guard computation */
|
|
uint32_t guard_interval;
|
|
|
|
/** DIF type */
|
|
enum spdk_dif_type dif_type;
|
|
|
|
/* Flags to specify the DIF action */
|
|
uint32_t dif_flags;
|
|
|
|
/* Initial reference tag */
|
|
uint32_t init_ref_tag;
|
|
|
|
/** Application tag */
|
|
uint16_t app_tag;
|
|
|
|
/* Application tag mask */
|
|
uint16_t apptag_mask;
|
|
};
|
|
|
|
/** DIF error information */
|
|
struct spdk_dif_error {
|
|
/** Error type */
|
|
uint8_t err_type;
|
|
|
|
/** Expected value */
|
|
uint32_t expected;
|
|
|
|
/** Actual value */
|
|
uint32_t actual;
|
|
|
|
/** Offset the error occurred at, block based */
|
|
uint32_t err_offset;
|
|
};
|
|
|
|
/**
|
|
* Initialize DIF context.
|
|
*
|
|
* \param ctx DIF context.
|
|
* \param block_size Block size in a block.
|
|
* \param md_size Metadata size in a block.
|
|
* \param dif_loc DIF location. If true, DIF is set in the last 8 bytes of metadata.
|
|
* If false, DIF is in the first 8 bytes of metadata.
|
|
* \param dif_type Type of DIF.
|
|
* \param dif_flags Flag to specify the DIF action.
|
|
* \param init_ref_tag Initial reference tag. For type 1, this is the
|
|
* starting block address.
|
|
* \param apptag_mask Application tag mask.
|
|
* \param app_tag Application tag.
|
|
*
|
|
* \return 0 on success and negated errno otherwise.
|
|
*/
|
|
int spdk_dif_ctx_init(struct spdk_dif_ctx *ctx, uint32_t block_size, uint32_t md_size,
|
|
bool dif_loc, enum spdk_dif_type dif_type, uint32_t dif_flags,
|
|
uint32_t init_ref_tag, uint16_t apptag_mask, uint16_t app_tag);
|
|
|
|
/**
|
|
* Generate DIF for extended LBA payload.
|
|
*
|
|
* \param iovs iovec array describing the extended LBA payload.
|
|
* \param iovcnt Number of elements in the iovec array.
|
|
* \param num_blocks Number of blocks of the payload.
|
|
* \param ctx DIF context.
|
|
*
|
|
* \return 0 on success and negated errno otherwise.
|
|
*/
|
|
int spdk_dif_generate(struct iovec *iovs, int iovcnt, uint32_t num_blocks,
|
|
const struct spdk_dif_ctx *ctx);
|
|
|
|
/**
|
|
* Verify DIF for extended LBA payload.
|
|
*
|
|
* \param iovs iovec array describing the extended LBA payload.
|
|
* \param iovcnt Number of elements in the iovec array.
|
|
* \param num_blocks Number of blocks of the payload.
|
|
* \param ctx DIF context.
|
|
* \param err_blk Error information of the block in which DIF error is found.
|
|
*
|
|
* \return 0 on success and negated errno otherwise.
|
|
*/
|
|
int spdk_dif_verify(struct iovec *iovs, int iovcnt, uint32_t num_blocks,
|
|
const struct spdk_dif_ctx *ctx, struct spdk_dif_error *err_blk);
|
|
|
|
/**
|
|
* Copy data and generate DIF for extended LBA payload.
|
|
*
|
|
* \param iovs iovec array describing the LBA payload.
|
|
* \param iovcnt Number of elements in the iovec array.
|
|
* \param bounce_iov A contiguous buffer forming extended LBA payload.
|
|
* \param num_blocks Number of blocks of the LBA payload.
|
|
* \param ctx DIF context.
|
|
*
|
|
* \return 0 on success and negated errno otherwise.
|
|
*/
|
|
int spdk_dif_generate_copy(struct iovec *iovs, int iovcnt, struct iovec *bounce_iov,
|
|
uint32_t num_blocks, const struct spdk_dif_ctx *ctx);
|
|
|
|
/**
|
|
* Verify DIF and copy data for extended LBA payload.
|
|
*
|
|
* \param iovs iovec array describing the LBA payload.
|
|
* \param iovcnt Number of elements in the iovec array.
|
|
* \param bounce_iov A contiguous buffer forming extended LBA payload.
|
|
* \param num_blocks Number of blocks of the LBA payload.
|
|
* \param ctx DIF context.
|
|
* \param err_blk Error information of the block in which DIF error is found.
|
|
*
|
|
* \return 0 on success and negated errno otherwise.
|
|
*/
|
|
int spdk_dif_verify_copy(struct iovec *iovs, int iovcnt, struct iovec *bounce_iov,
|
|
uint32_t num_blocks, const struct spdk_dif_ctx *ctx,
|
|
struct spdk_dif_error *err_blk);
|
|
|
|
/**
|
|
* Inject bit flip error to extended LBA payload.
|
|
*
|
|
* \param iovs iovec array describing the extended LBA payload.
|
|
* \param iovcnt Number of elements in the iovec array.
|
|
* \param num_blocks Number of blocks of the payload.
|
|
* \param ctx DIF context.
|
|
* \param inject_flags Flags to specify the action of error injection.
|
|
* \param inject_offset Offset, in blocks, to which error is injected.
|
|
* If multiple error is injected, only the last injection is stored.
|
|
*
|
|
* \return 0 on success and negated errno otherwise including no metadata.
|
|
*/
|
|
int spdk_dif_inject_error(struct iovec *iovs, int iovcnt, uint32_t num_blocks,
|
|
const struct spdk_dif_ctx *ctx, uint32_t inject_flags,
|
|
uint32_t *inject_offset);
|
|
#endif /* SPDK_DIF_H */
|