488570ebd4
Many open source projects have moved to using SPDX identifiers to specify license information, reducing the amount of boilerplate code in every source file. This patch replaces the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause identifier. Almost all of these files share the exact same license text, and this patch only modifies the files that contain the most common license text. There can be slight variations because the third clause contains company names - most say "Intel Corporation", but there are instances for Nvidia, Samsung, Eideticom and even "the copyright holder". Used a bash script to automate replacement of the license text with SPDX identifier which is checked into scripts/spdx.sh. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Dong Yi <dongx.yi@intel.com> Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: <qun.wan@intel.com>
280 lines
9.3 KiB
C
280 lines
9.3 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
/** \file
|
|
* Acceleration engine abstraction layer
|
|
*/
|
|
|
|
#ifndef SPDK_ACCEL_ENGINE_H
|
|
#define SPDK_ACCEL_ENGINE_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/* Flags for accel operations */
|
|
#define ACCEL_FLAG_PERSISTENT (1 << 0)
|
|
|
|
enum accel_opcode {
|
|
ACCEL_OPC_COPY = 0,
|
|
ACCEL_OPC_FILL = 1,
|
|
ACCEL_OPC_DUALCAST = 2,
|
|
ACCEL_OPC_COMPARE = 3,
|
|
ACCEL_OPC_CRC32C = 4,
|
|
ACCEL_OPC_COPY_CRC32C = 5,
|
|
ACCEL_OPC_COMPRESS = 6,
|
|
ACCEL_OPC_DECOMPRESS = 7,
|
|
ACCEL_OPC_LAST = 8,
|
|
};
|
|
|
|
/**
|
|
* Acceleration operation callback.
|
|
*
|
|
* \param ref 'accel_task' passed to the corresponding spdk_accel_submit* call.
|
|
* \param status 0 if it completed successfully, or negative errno if it failed.
|
|
*/
|
|
typedef void (*spdk_accel_completion_cb)(void *ref, int status);
|
|
|
|
/**
|
|
* Acceleration engine finish callback.
|
|
*
|
|
* \param cb_arg Callback argument.
|
|
*/
|
|
typedef void (*spdk_accel_fini_cb)(void *cb_arg);
|
|
|
|
/**
|
|
* Initialize the acceleration engine.
|
|
*
|
|
* \return 0 on success.
|
|
*/
|
|
int spdk_accel_engine_initialize(void);
|
|
|
|
/**
|
|
* Close the acceleration engine.
|
|
*
|
|
* \param cb_fn Called when the close operation completes.
|
|
* \param cb_arg Argument passed to the callback function.
|
|
*/
|
|
void spdk_accel_engine_finish(spdk_accel_fini_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Close the acceleration engine module and perform any necessary cleanup.
|
|
*/
|
|
void spdk_accel_engine_module_finish(void);
|
|
|
|
/**
|
|
* Get the I/O channel registered on the acceleration engine.
|
|
*
|
|
* This I/O channel is used to submit copy request.
|
|
*
|
|
* \return a pointer to the I/O channel on success, or NULL on failure.
|
|
*/
|
|
struct spdk_io_channel *spdk_accel_engine_get_io_channel(void);
|
|
|
|
/**
|
|
* Submit a copy request.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param dst Destination to copy to.
|
|
* \param src Source to copy from.
|
|
* \param nbytes Length in bytes to copy.
|
|
* \param flags Accel framework flags for operations.
|
|
* \param cb_fn Called when this copy operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_copy(struct spdk_io_channel *ch, void *dst, void *src, uint64_t nbytes,
|
|
int flags, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a dual cast copy request.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param dst1 First destination to copy to (must be 4K aligned).
|
|
* \param dst2 Second destination to copy to (must be 4K aligned).
|
|
* \param src Source to copy from.
|
|
* \param nbytes Length in bytes to copy.
|
|
* \param flags Accel framework flags for operations.
|
|
* \param cb_fn Called when this copy operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_dualcast(struct spdk_io_channel *ch, void *dst1, void *dst2, void *src,
|
|
uint64_t nbytes, int flags, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a compare request.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param src1 First location to perform compare on.
|
|
* \param src2 Second location to perform compare on.
|
|
* \param nbytes Length in bytes to compare.
|
|
* \param cb_fn Called when this compare operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, any other value means there was a miscompare.
|
|
*/
|
|
int spdk_accel_submit_compare(struct spdk_io_channel *ch, void *src1, void *src2, uint64_t nbytes,
|
|
spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a fill request.
|
|
*
|
|
* This operation will fill the destination buffer with the specified value.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param dst Destination to fill.
|
|
* \param fill Constant byte to fill to the destination.
|
|
* \param nbytes Length in bytes to fill.
|
|
* \param flags Accel framework flags for operations.
|
|
* \param cb_fn Called when this fill operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_fill(struct spdk_io_channel *ch, void *dst, uint8_t fill, uint64_t nbytes,
|
|
int flags, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a CRC-32C calculation request.
|
|
*
|
|
* This operation will calculate the 4 byte CRC32-C for the given data.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param crc_dst Destination to write the CRC-32C to.
|
|
* \param src The source address for the data.
|
|
* \param seed Four byte seed value.
|
|
* \param nbytes Length in bytes.
|
|
* \param cb_fn Called when this CRC-32C operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_crc32c(struct spdk_io_channel *ch, uint32_t *crc_dst, void *src,
|
|
uint32_t seed,
|
|
uint64_t nbytes, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a chained CRC-32C calculation request.
|
|
*
|
|
* This operation will calculate the 4 byte CRC32-C for the given data.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param crc_dst Destination to write the CRC-32C to.
|
|
* \param iovs The io vector array which stores the src data and len.
|
|
* \param iovcnt The size of the iov.
|
|
* \param seed Four byte seed value.
|
|
* \param cb_fn Called when this CRC-32C operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_crc32cv(struct spdk_io_channel *ch, uint32_t *crc_dst, struct iovec *iovs,
|
|
uint32_t iovcnt, uint32_t seed, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a copy with CRC-32C calculation request.
|
|
*
|
|
* This operation will copy data and calculate the 4 byte CRC32-C for the given data.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param dst Destination to write the data to.
|
|
* \param src The source address for the data.
|
|
* \param crc_dst Destination to write the CRC-32C to.
|
|
* \param seed Four byte seed value.
|
|
* \param nbytes Length in bytes.
|
|
* \param flags Accel framework flags for operations.
|
|
* \param cb_fn Called when this CRC-32C operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_copy_crc32c(struct spdk_io_channel *ch, void *dst, void *src,
|
|
uint32_t *crc_dst, uint32_t seed, uint64_t nbytes, int flags,
|
|
spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Submit a chained copy + CRC-32C calculation request.
|
|
*
|
|
* This operation will calculate the 4 byte CRC32-C for the given data.
|
|
*
|
|
* \param ch I/O channel associated with this call.
|
|
* \param dst Destination to write the data to.
|
|
* \param src_iovs The io vector array which stores the src data and len.
|
|
* \param iovcnt The size of the io vectors.
|
|
* \param crc_dst Destination to write the CRC-32C to.
|
|
* \param seed Four byte seed value.
|
|
* \param flags Accel framework flags for operations.
|
|
* \param cb_fn Called when this CRC-32C operation completes.
|
|
* \param cb_arg Callback argument.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_copy_crc32cv(struct spdk_io_channel *ch, void *dst, struct iovec *src_iovs,
|
|
uint32_t iovcnt, uint32_t *crc_dst, uint32_t seed,
|
|
int flags, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Build and submit a memory compress request.
|
|
*
|
|
* This function will build the compress descriptor and submit it.
|
|
*
|
|
* \param ch I/O channel associated with this call
|
|
* \param dst Destination to compress to.
|
|
* \param src Source to read from.
|
|
* \param nbytes_dst Length in bytes of output buffer.
|
|
* \param nbytes_src Length in bytes of input buffer.
|
|
* \param output_size The size of the compressed data
|
|
* \param flags Flags, optional flags that can vary per operation.
|
|
* \param cb_fn Callback function which will be called when the request is complete.
|
|
* \param cb_arg Opaque value which will be passed back as the arg parameter in
|
|
* the completion callback.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_compress(struct spdk_io_channel *ch, void *dst, void *src,
|
|
uint64_t nbytes_dst, uint64_t nbytes_src, uint32_t *output_size,
|
|
int flags, spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
/**
|
|
* Build and submit a memory decompress request.
|
|
*
|
|
* This function will build the decompress descriptor and submit it.
|
|
*
|
|
* \param ch I/O channel associated with this call
|
|
* \param dst Destination. Must be large enough to hold decompressed data.
|
|
* \param src Source to read from.
|
|
* \param nbytes_dst Length in bytes of output buffer.
|
|
* \param nbytes_src Length in bytes of input buffer.
|
|
* \param flags Flags, optional flags that can vary per operation.
|
|
* \param cb_fn Callback function which will be called when the request is complete.
|
|
* \param cb_arg Opaque value which will be passed back as the arg parameter in
|
|
* the completion callback.
|
|
*
|
|
* \return 0 on success, negative errno on failure.
|
|
*/
|
|
int spdk_accel_submit_decompress(struct spdk_io_channel *ch, void *dst, void *src,
|
|
uint64_t nbytes_dst, uint64_t nbytes_src, int flags,
|
|
spdk_accel_completion_cb cb_fn, void *cb_arg);
|
|
|
|
struct spdk_json_write_ctx;
|
|
|
|
/**
|
|
* Write Acceleration subsystem configuration into provided JSON context.
|
|
*
|
|
* \param w JSON write context
|
|
*/
|
|
void spdk_accel_write_config_json(struct spdk_json_write_ctx *w);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|