From 081f080a49a3dbe31acb2a8557db90b08bbeaf9c Mon Sep 17 00:00:00 2001 From: Ben Walker Date: Mon, 8 Aug 2022 13:31:08 -0700 Subject: [PATCH] accel: Rename public header to accel.h The public interface of lib/accel is now include/spdk/accel.h Change-Id: Id94f623a494eb1b524b060f4413f633073ea7466 Signed-off-by: Ben Walker Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/13916 Tested-by: SPDK CI Jenkins Reviewed-by: Paul Luse Reviewed-by: Jim Harris Reviewed-by: Aleksey Marchuk --- CHANGELOG.md | 5 ++++- doc/accel_fw.md | 4 ++-- examples/accel/perf/accel_perf.c | 2 +- examples/bdev/fio_plugin/fio_plugin.c | 2 +- include/spdk/{accel_engine.h => accel.h} | 0 include/spdk_internal/accel_engine.h | 2 +- lib/accel/accel_internal.h | 2 +- lib/nvmf/tcp.c | 2 +- module/bdev/malloc/bdev_malloc.c | 2 +- module/bdev/nvme/bdev_nvme.c | 2 +- module/event/subsystems/accel/accel.c | 2 +- test/bdev/bdevio/bdevio.c | 2 +- test/bdev/bdevperf/bdevperf.c | 2 +- 13 files changed, 16 insertions(+), 13 deletions(-) rename include/spdk/{accel_engine.h => accel.h} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index fd6b4a333..b414f8fa1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,7 +35,10 @@ Renamed the `raid5` module to `raid5f` to reflect that it is not a traditional RAID5 implementation - only full stripe writes are supported, partial stripe writes (read-modify-write) are not. -### accel_fw +### accel + +Many names were changed in the accel framework to make them consistent both with themselves and +the rest of SPDK. The primary public header file is now named `include/spdk/accel.h`. Added a new runtime RPC `accel_get_opc_assignments` to get a list of current opcode to engine assignements. diff --git a/doc/accel_fw.md b/doc/accel_fw.md index 4f4c55487..3514242ff 100644 --- a/doc/accel_fw.md +++ b/doc/accel_fw.md @@ -12,11 +12,11 @@ the software module. ## Acceleration Framework Functions {#accel_functions} Functions implemented via the framework can be found in the DoxyGen documentation of the -framework public header file here [accel_engine.h](https://spdk.io/doc/accel__engine_8h.html) +framework public header file here [accel.h](https://spdk.io/doc/accel_8h.html) ## Acceleration Framework Design Considerations {#accel_dc} -The general interface is defined by `/include/accel_engine.h` and implemented +The general interface is defined by `/include/spdk/accel.h` and implemented in `/lib/accel`. These functions may be called by an SPDK application and in most cases, except where otherwise documented, are asynchronous and follow the standard SPDK model for callbacks with a callback argument. diff --git a/examples/accel/perf/accel_perf.c b/examples/accel/perf/accel_perf.c index 8c79c0f21..edbafec4c 100644 --- a/examples/accel/perf/accel_perf.c +++ b/examples/accel/perf/accel_perf.c @@ -9,7 +9,7 @@ #include "spdk/event.h" #include "spdk/log.h" #include "spdk/string.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/crc32.h" #include "spdk/util.h" diff --git a/examples/bdev/fio_plugin/fio_plugin.c b/examples/bdev/fio_plugin/fio_plugin.c index ee53146fd..edef6910a 100644 --- a/examples/bdev/fio_plugin/fio_plugin.c +++ b/examples/bdev/fio_plugin/fio_plugin.c @@ -7,7 +7,7 @@ #include "spdk/bdev.h" #include "spdk/bdev_zone.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/env.h" #include "spdk/init.h" #include "spdk/thread.h" diff --git a/include/spdk/accel_engine.h b/include/spdk/accel.h similarity index 100% rename from include/spdk/accel_engine.h rename to include/spdk/accel.h diff --git a/include/spdk_internal/accel_engine.h b/include/spdk_internal/accel_engine.h index 299ddeb8e..59c84463a 100644 --- a/include/spdk_internal/accel_engine.h +++ b/include/spdk_internal/accel_engine.h @@ -8,7 +8,7 @@ #include "spdk/stdinc.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/queue.h" #include "spdk/config.h" diff --git a/lib/accel/accel_internal.h b/lib/accel/accel_internal.h index df0390600..383fe01a9 100644 --- a/lib/accel/accel_internal.h +++ b/lib/accel/accel_internal.h @@ -8,7 +8,7 @@ #include "spdk/stdinc.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/queue.h" #include "spdk/config.h" diff --git a/lib/nvmf/tcp.c b/lib/nvmf/tcp.c index 5289122c7..fd31ec32d 100644 --- a/lib/nvmf/tcp.c +++ b/lib/nvmf/tcp.c @@ -4,7 +4,7 @@ * Copyright (c) 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved. */ -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/stdinc.h" #include "spdk/crc32.h" #include "spdk/endian.h" diff --git a/module/bdev/malloc/bdev_malloc.c b/module/bdev/malloc/bdev_malloc.c index 6d0bd1d22..c15a8c51a 100644 --- a/module/bdev/malloc/bdev_malloc.c +++ b/module/bdev/malloc/bdev_malloc.c @@ -10,7 +10,7 @@ #include "spdk/bdev.h" #include "spdk/endian.h" #include "spdk/env.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/json.h" #include "spdk/thread.h" #include "spdk/queue.h" diff --git a/module/bdev/nvme/bdev_nvme.c b/module/bdev/nvme/bdev_nvme.c index 07ce67ef1..312a192ac 100644 --- a/module/bdev/nvme/bdev_nvme.c +++ b/module/bdev/nvme/bdev_nvme.c @@ -8,7 +8,7 @@ #include "bdev_nvme.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/config.h" #include "spdk/endian.h" #include "spdk/bdev.h" diff --git a/module/event/subsystems/accel/accel.c b/module/event/subsystems/accel/accel.c index 5d230f100..798d55eb0 100644 --- a/module/event/subsystems/accel/accel.c +++ b/module/event/subsystems/accel/accel.c @@ -5,7 +5,7 @@ #include "spdk/stdinc.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk_internal/init.h" #include "spdk/env.h" diff --git a/test/bdev/bdevio/bdevio.c b/test/bdev/bdevio/bdevio.c index b52d652ac..0c1e17350 100644 --- a/test/bdev/bdevio/bdevio.c +++ b/test/bdev/bdevio/bdevio.c @@ -7,7 +7,7 @@ #include "spdk/stdinc.h" #include "spdk/bdev.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/env.h" #include "spdk/log.h" #include "spdk/thread.h" diff --git a/test/bdev/bdevperf/bdevperf.c b/test/bdev/bdevperf/bdevperf.c index 11dfda999..8ac54a604 100644 --- a/test/bdev/bdevperf/bdevperf.c +++ b/test/bdev/bdevperf/bdevperf.c @@ -6,7 +6,7 @@ #include "spdk/stdinc.h" #include "spdk/bdev.h" -#include "spdk/accel_engine.h" +#include "spdk/accel.h" #include "spdk/endian.h" #include "spdk/env.h" #include "spdk/event.h"