5b03dd938c
Docs, RPC, unit tests, etc., will follow. Notes: * The current implementation will only work with VFIO. * The current implementation supports only the existing accel framework API. The API will be expanded for DSA exclusive features in a subsequent patch. * SW is required to manage flow control, to not over-run the work queues. This is provided in the accel plug-in module. The upper layers use public API to manage this. * As we need to support any number of channels (we can't limit ourselves to the number of work queues) we need to dynamically size/resize our per channel descriptor rings based on the number of current channels. This is done from upper layers via public API into the lib. * As channels are created, the total number of work queue slots is divided across the channels evenly. Same thing when they are destroyed, remaining channels will see the ring sizes increase. This is done from upper layers via public API into the lib. Signed-off-by: paul luse <paul.e.luse@intel.com> Change-Id: Ifaa39935107206a2d990cec992854675e5502057 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/1722 Community-CI: Mellanox Build Bot Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com> Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
106 lines
3.6 KiB
C
106 lines
3.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_INTERNAL_ACCEL_ENGINE_H
|
|
#define SPDK_INTERNAL_ACCEL_ENGINE_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#include "spdk/accel_engine.h"
|
|
#include "spdk/queue.h"
|
|
|
|
enum accel_module {
|
|
ACCEL_SW = 0,
|
|
ACCEL_AUTO,
|
|
ACCEL_CBDMA,
|
|
ACCEL_IDXD_DSA,
|
|
ACCEL_MODULE_MAX
|
|
};
|
|
|
|
int accel_set_module(enum accel_module *opts);
|
|
|
|
struct spdk_accel_task {
|
|
spdk_accel_completion_cb cb;
|
|
uint8_t offload_ctx[0];
|
|
};
|
|
|
|
struct spdk_accel_engine {
|
|
int (*copy)(void *cb_arg, struct spdk_io_channel *ch, void *dst, void *src,
|
|
uint64_t nbytes, spdk_accel_completion_cb cb);
|
|
int (*fill)(void *cb_arg, struct spdk_io_channel *ch, void *dst, uint8_t fill,
|
|
uint64_t nbytes, spdk_accel_completion_cb cb);
|
|
struct spdk_io_channel *(*get_io_channel)(void);
|
|
};
|
|
|
|
struct spdk_accel_module_if {
|
|
/** Initialization function for the module. Called by the spdk
|
|
* application during startup.
|
|
*
|
|
* Modules are required to define this function.
|
|
*/
|
|
int (*module_init)(void);
|
|
|
|
/** Finish function for the module. Called by the spdk application
|
|
* before the spdk application exits to perform any necessary cleanup.
|
|
*
|
|
* Modules are not required to define this function.
|
|
*/
|
|
void (*module_fini)(void *ctx);
|
|
|
|
/** Function called to return a text string representing the
|
|
* module's configuration options for inclusion in an
|
|
* spdk configuration file.
|
|
*/
|
|
void (*config_text)(FILE *fp);
|
|
|
|
size_t (*get_ctx_size)(void);
|
|
TAILQ_ENTRY(spdk_accel_module_if) tailq;
|
|
};
|
|
|
|
void spdk_accel_hw_engine_register(struct spdk_accel_engine *accel_engine);
|
|
void spdk_accel_module_list_add(struct spdk_accel_module_if *accel_module);
|
|
|
|
#define SPDK_ACCEL_MODULE_REGISTER(init_fn, fini_fn, config_fn, ctx_size_fn) \
|
|
static struct spdk_accel_module_if init_fn ## _if = { \
|
|
.module_init = init_fn, \
|
|
.module_fini = fini_fn, \
|
|
.config_text = config_fn, \
|
|
.get_ctx_size = ctx_size_fn, \
|
|
}; \
|
|
__attribute__((constructor)) static void init_fn ## _init(void) \
|
|
{ \
|
|
spdk_accel_module_list_add(&init_fn ## _if); \
|
|
}
|
|
|
|
#endif
|