d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

bdev/compress: add compression vbdev module

Browse Source 
Just the starting point, base functions and structs.

Change-Id: I2ff2b672aa675a19b89e4449f1cc4aa664007f6f
Signed-off-by: Paul Luse <paul.e.luse@intel.com>
Reviewed-on: https://review.gerrithub.io/c/spdk/spdk/+/435747
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
This commit is contained in:
Paul Luse 2018-12-01 08:09:46 -07:00 committed by Jim Harris
parent 20145fd714
commit db541f8eb3
8 changed files with 1164 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/bdev/Makefile
View File

@ -54,6 +54,10 @@ DIRS-y += ocf/env
DEPDIRS-ocf := ocf/env
endif
ifeq ($(CONFIG_REDUCE),y)
DIRS-y += compress
endif
ifeq ($(OS),Linux)
DIRS-y += aio
DIRS-$(CONFIG_ISCSI_INITIATOR) += iscsi

43
lib/bdev/compress/Makefile Normal file
View File

@ -0,0 +1,43 @@
#
# 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.
#
SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../..)
include $(SPDK_ROOT_DIR)/mk/spdk.common.mk
CFLAGS += -I$(SPDK_ROOT_DIR)/lib/bdev/
C_SRCS = vbdev_compress.c vbdev_compress_rpc.c
LIBNAME = bdev_compress
CFLAGS += $(ENV_CFLAGS)
include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk

841
lib/bdev/compress/vbdev_compress.c Normal file
View File

@ -0,0 +1,841 @@
/*-
* 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 "vbdev_compress.h"
#include "spdk/stdinc.h"
#include "spdk/rpc.h"
#include "spdk/env.h"
#include "spdk/conf.h"
#include "spdk/endian.h"
#include "spdk/string.h"
#include "spdk/thread.h"
#include "spdk/util.h"
#include "spdk/bdev_module.h"
#include "spdk_internal/log.h"
#include <rte_config.h>
#include <rte_bus_vdev.h>
#include <rte_compressdev.h>
/* TODO: valdiate these are good starting values */
#define NUM_MAX_XFORMS 16
#define NUM_MAX_INFLIGHT_OPS 512
#define DEFAULT_WINDOW_SIZE 15
#define MAX_MBUFS_PER_OP 64
#define COMP_BDEV_NAME "compress"
/* To add support for new device types, follow the examples of the following...
* Note that the string names are defined by the DPDK PMD in question so be
* sure to use the exact names.
*/
#define MAX_NUM_DRV_TYPES 1
#define ISAL_PMD "compress_isal"
/* TODO: #define QAT "tbd" */
const char *g_drv_names[MAX_NUM_DRV_TYPES] = { ISAL_PMD };
#define NUM_MBUFS 32768
#define POOL_CACHE_SIZE 256
/* Global list of available compression devices. */
struct compress_dev {
struct rte_compressdev_info cdev_info; /* includes device friendly name */
uint8_t cdev_id; /* identifier for the device */
void *comp_xform; /* shared private xform for comp on this PMD */
void *decomp_xform; /* shared private xform for decomp on this PMD */
TAILQ_ENTRY(compress_dev) link;
};
static TAILQ_HEAD(, compress_dev) g_compress_devs = TAILQ_HEAD_INITIALIZER(g_compress_devs);
/* Global list and lock for unique device/queue pair combos */
struct comp_device_qp {
struct compress_dev *device; /* ptr to compression device */
uint8_t qp; /* queue pair for this node */
bool in_use; /* whether this node is in use or not */
TAILQ_ENTRY(comp_device_qp) link;
};
static TAILQ_HEAD(, comp_device_qp) g_comp_device_qp = TAILQ_HEAD_INITIALIZER(g_comp_device_qp);
static pthread_mutex_t g_comp_device_qp_lock = PTHREAD_MUTEX_INITIALIZER;
/* List of virtual bdevs and associated info for each. */
struct vbdev_compress {
struct spdk_bdev *base_bdev; /* the thing we're attaching to */
struct spdk_bdev_desc *base_desc; /* its descriptor we get from open */
struct spdk_io_channel *base_ch; /* IO channel of base device */
struct spdk_bdev comp_bdev; /* the compression virtual bdev */
struct comp_io_channel *comp_ch; /* channel associated with this bdev */
char *drv_name; /* name of the compression device driver */
struct comp_device_qp *device_qp;
struct spdk_thread *reduce_thread;
pthread_mutex_t reduce_lock;
uint32_t ch_count;
TAILQ_HEAD(, spdk_bdev_io) pending_comp_ios; /* outstanding operations to a comp library */
TAILQ_ENTRY(vbdev_compress) link;
};
static TAILQ_HEAD(, vbdev_compress) g_vbdev_comp = TAILQ_HEAD_INITIALIZER(g_vbdev_comp);
/* The comp vbdev channel struct. It is allocated and freed on my behalf by the io channel code.
*/
struct comp_io_channel {
struct spdk_poller *poller; /* completion poller */
struct spdk_io_channel_iter *iter; /* used with for_each_channel in reset */
};
/* Per I/O context for the compression vbdev. */
struct comp_bdev_io {
struct comp_io_channel *comp_ch; /* used in completion handling */
struct vbdev_compress *comp_bdev; /* vbdev associated with this IO */
struct spdk_bdev_io_wait_entry bdev_io_wait; /* for bdev_io_wait */
struct spdk_bdev_io *orig_io; /* the original IO */
struct spdk_io_channel *ch; /* for resubmission */
struct spdk_bdev_io *read_io;
/* TODO: rename these and maybe read_io above as well */
uint64_t dest_num_blocks; /* num of blocks for the contiguous buffer */
uint64_t dest_offset_blocks; /* block offset on media */
struct iovec dest_iov; /* iov representing contig write buffer */
};
/* Shared mempools between all devices on this system */
static struct spdk_mempool *g_mbuf_mp = NULL; /* mbuf mempool */
static struct rte_mempool *g_comp_op_mp = NULL; /* comp operations, must be rte* mempool */
static void vbdev_compress_examine(struct spdk_bdev *bdev);
static void vbdev_compress_claim(struct vbdev_compress *comp_bdev);
static void vbdev_compress_queue_io(struct spdk_bdev_io *bdev_io);
static void vbdev_compress_submit_request(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io);
/* Called by vbdev_init_compress_drivers() to init each discovered compression device */
static int
create_compress_dev(uint8_t index, uint16_t num_lcores)
{
struct compress_dev *device;
uint16_t q_pairs = num_lcores;
uint8_t cdev_id;
struct rte_comp_xform comp_xform = {};
struct rte_comp_xform decomp_xform = {};
int rc, i;
struct comp_device_qp *dev_qp;
struct comp_device_qp *tmp_qp;
device = calloc(1, sizeof(struct compress_dev));
if (!device) {
return -ENOMEM;
}
/* Get details about this device. */
rte_compressdev_info_get(index, &device->cdev_info);
cdev_id = device->cdev_id = index;
/* Zero means no limit so choose number of lcores. */
if (device->cdev_info.max_nb_queue_pairs == 0) {
q_pairs = num_lcores;
} else {
q_pairs = spdk_min(device->cdev_info.max_nb_queue_pairs, num_lcores);
}
/* Configure the compression device. */
struct rte_compressdev_config config = {
.socket_id = rte_socket_id(),
.nb_queue_pairs = q_pairs,
.max_nb_priv_xforms = NUM_MAX_XFORMS,
.max_nb_streams = 0
};
rc = rte_compressdev_configure(cdev_id, &config);
if (rc < 0) {
SPDK_ERRLOG("Failed to configure compressdev %u\n", cdev_id);
goto err;
}
/* Pre-setup all potential qpairs now and assign them in the channel
* callback.
*/
for (i = 0; i < q_pairs; i++) {
rc = rte_compressdev_queue_pair_setup(cdev_id, i,
NUM_MAX_INFLIGHT_OPS,
rte_socket_id());
if (rc) {
SPDK_ERRLOG("Failed to setup queue pair on "
"compressdev %u\n", cdev_id);
rc = -EINVAL;
goto err;
}
}
rc = rte_compressdev_start(cdev_id);
if (rc < 0) {
SPDK_ERRLOG("Failed to start device %u: error %d\n",
cdev_id, rc);
goto err;
}
/* TODO: if later on all elements remain static, move these
* xform structs to static globals.
*/
/* Create shrared (between all ops per PMD) compress xforms. */
comp_xform = (struct rte_comp_xform) {
.type = RTE_COMP_COMPRESS,
.compress = {
.algo = RTE_COMP_ALGO_DEFLATE,
.deflate.huffman = RTE_COMP_HUFFMAN_DEFAULT,
.level = RTE_COMP_LEVEL_MAX,
.window_size = DEFAULT_WINDOW_SIZE,
.chksum = RTE_COMP_CHECKSUM_NONE,
.hash_algo = RTE_COMP_HASH_ALGO_NONE
}
};
rc = rte_compressdev_private_xform_create(cdev_id, &comp_xform,
&device->comp_xform);
if (rc < 0) {
SPDK_ERRLOG("Failed to create private comp xform device %u: error %d\n",
cdev_id, rc);
goto err;
}
/* Create shrared (between all ops per PMD) decompress xforms. *
* also TODO make this global static if everything stays like this
*/
decomp_xform = (struct rte_comp_xform) {
.type = RTE_COMP_DECOMPRESS,
.decompress = {
.algo = RTE_COMP_ALGO_DEFLATE,
.chksum = RTE_COMP_CHECKSUM_NONE,
.window_size = DEFAULT_WINDOW_SIZE,
.hash_algo = RTE_COMP_HASH_ALGO_NONE
}
};
rc = rte_compressdev_private_xform_create(cdev_id, &decomp_xform,
&device->decomp_xform);
if (rc) {
SPDK_ERRLOG("Failed to create private decomp xform device %u: error %d\n",
cdev_id, rc);
goto err;
}
/* Build up list of device/qp combinations */
for (i = 0; i < q_pairs; i++) {
dev_qp = calloc(1, sizeof(struct comp_device_qp));
if (!dev_qp) {
rc = -ENOMEM;
goto err;
}
dev_qp->device = device;
dev_qp->qp = i;
dev_qp->in_use = false;
TAILQ_INSERT_TAIL(&g_comp_device_qp, dev_qp, link);
}
TAILQ_INSERT_TAIL(&g_compress_devs, device, link);
return 0;
err:
TAILQ_FOREACH_SAFE(dev_qp, &g_comp_device_qp, link, tmp_qp) {
TAILQ_REMOVE(&g_comp_device_qp, dev_qp, link);
free(dev_qp);
}
free(device);
return rc;
}
/* Called from driver init entry point, vbdev_compress_init() */
static int
vbdev_init_compress_drivers(void)
{
uint8_t cdev_count, i;
uint16_t num_lcores = rte_lcore_count();
struct compress_dev *tmp_dev;
struct compress_dev *device;
int rc;
/* We always init the compress_isal PMD */
rc = rte_vdev_init(ISAL_PMD, NULL);
if (rc == 0) {
SPDK_NOTICELOG("created virtual PMD %s\n", ISAL_PMD);
} else {
SPDK_ERRLOG("error creating virtual PMD %s\n", ISAL_PMD);
return -EINVAL;
}
/* If we have no compression devices, there's no reason to continue. */
cdev_count = rte_compressdev_count();
if (cdev_count == 0) {
return 0;
}
if (cdev_count > RTE_COMPRESS_MAX_DEVS) {
SPDK_ERRLOG("error invalid device count from rte_compressdev_count()\n");
return -EINVAL;
}
g_mbuf_mp = spdk_mempool_create("comp_mbuf_mp", NUM_MBUFS, sizeof(struct rte_mbuf),
SPDK_MEMPOOL_DEFAULT_CACHE_SIZE,
SPDK_ENV_SOCKET_ID_ANY);
if (g_mbuf_mp == NULL) {
SPDK_ERRLOG("Cannot create mbuf pool\n");
rc = -ENOMEM;
goto error_create_mbuf;
}
g_comp_op_mp = rte_comp_op_pool_create("comp_op_pool", NUM_MBUFS, POOL_CACHE_SIZE,
0, rte_socket_id());
if (g_comp_op_mp == NULL) {
SPDK_ERRLOG("Cannot create comp op pool\n");
rc = -ENOMEM;
goto error_create_op;
}
/* Init all devices */
for (i = 0; i < cdev_count; i++) {
rc = create_compress_dev(i, num_lcores);
if (rc != 0) {
goto error_create_compress_devs;
}
}
return 0;
/* Error cleanup paths. */
error_create_compress_devs:
TAILQ_FOREACH_SAFE(device, &g_compress_devs, link, tmp_dev) {
TAILQ_REMOVE(&g_compress_devs, device, link);
free(device);
}
error_create_op:
error_create_mbuf:
spdk_mempool_free(g_mbuf_mp);
return rc;
}
/* Poller for the DPDK compression driver. */
static int
comp_dev_poller(void *args)
{
/* TODO future patch in series */
return 0;
}
/* Callback for getting a buf from the bdev pool in the event that the caller passed
* in NULL, we need to own the buffer so it doesn't get freed by another vbdev module
* beneath us before we're done with it.
*/
static void
comp_read_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, bool success)
{
/* TODO future patch */
}
/* TODO: A future patch will add routines to complete IO up the stack, need
* to send the completion on the original bdev_io thread.
*/
static void
_spdk_bdev_io_submit(void *arg)
{
struct comp_bdev_io *io_ctx = arg;
vbdev_compress_submit_request(spdk_io_channel_from_ctx(io_ctx->comp_ch), io_ctx->orig_io);
}
/* Called when someone above submits IO to this vbdev. */
static void
vbdev_compress_submit_request(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io)
{
struct vbdev_compress *comp_bdev = SPDK_CONTAINEROF(bdev_io->bdev, struct vbdev_compress,
comp_bdev);
struct comp_io_channel *comp_ch = spdk_io_channel_get_ctx(ch);
struct comp_bdev_io *io_ctx = (struct comp_bdev_io *)bdev_io->driver_ctx;
int rc = 0;
memset(io_ctx, 0, sizeof(struct comp_bdev_io));
io_ctx->comp_bdev = comp_bdev;
io_ctx->comp_ch = comp_ch;
io_ctx->orig_io = bdev_io;
/* Send this request to the reduce_thread. */
if (spdk_io_channel_get_thread(spdk_bdev_io_get_io_channel(bdev_io))
!= comp_bdev->reduce_thread) {
spdk_thread_send_msg(comp_bdev->reduce_thread, _spdk_bdev_io_submit, io_ctx);
return;
}
switch (bdev_io->type) {
case SPDK_BDEV_IO_TYPE_READ:
spdk_bdev_io_get_buf(bdev_io, comp_read_get_buf_cb,
bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen);
break;
/* TODO in future patch in the series */
case SPDK_BDEV_IO_TYPE_WRITE:
case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
case SPDK_BDEV_IO_TYPE_UNMAP:
case SPDK_BDEV_IO_TYPE_FLUSH:
case SPDK_BDEV_IO_TYPE_RESET:
default:
SPDK_ERRLOG("Unknown I/O type %d\n", bdev_io->type);
spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
return;
}
if (rc) {
if (rc == -ENOMEM) {
SPDK_ERRLOG("No memory, start to queue io for compress.\n");
io_ctx->ch = ch;
vbdev_compress_queue_io(bdev_io);
} else {
SPDK_ERRLOG("ERROR on bdev_io submission!\n");
spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
}
}
}
static bool
vbdev_compress_io_type_supported(void *ctx, enum spdk_bdev_io_type io_type)
{
struct vbdev_compress *comp_bdev = (struct vbdev_compress *)ctx;
switch (io_type) {
case SPDK_BDEV_IO_TYPE_READ:
return spdk_bdev_io_type_supported(comp_bdev->base_bdev, io_type);
case SPDK_BDEV_IO_TYPE_WRITE:
case SPDK_BDEV_IO_TYPE_UNMAP:
case SPDK_BDEV_IO_TYPE_RESET:
case SPDK_BDEV_IO_TYPE_FLUSH:
case SPDK_BDEV_IO_TYPE_WRITE_ZEROES:
default:
return false;
}
}
/* Resubmission function used by the bdev layer when a queued IO is ready to be
* submitted.
*/
static void
vbdev_compress_resubmit_io(void *arg)
{
struct spdk_bdev_io *bdev_io = (struct spdk_bdev_io *)arg;
struct comp_bdev_io *io_ctx = (struct comp_bdev_io *)bdev_io->driver_ctx;
vbdev_compress_submit_request(io_ctx->ch, bdev_io);
}
/* Used to queue an IO in the event of resource issues. */
static void
vbdev_compress_queue_io(struct spdk_bdev_io *bdev_io)
{
struct comp_bdev_io *io_ctx = (struct comp_bdev_io *)bdev_io->driver_ctx;
int rc;
io_ctx->bdev_io_wait.bdev = bdev_io->bdev;
io_ctx->bdev_io_wait.cb_fn = vbdev_compress_resubmit_io;
io_ctx->bdev_io_wait.cb_arg = bdev_io;
rc = spdk_bdev_queue_io_wait(bdev_io->bdev, io_ctx->ch, &io_ctx->bdev_io_wait);
if (rc) {
SPDK_ERRLOG("Queue io failed in vbdev_compress_queue_io, rc=%d.\n", rc);
assert(false);
spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED);
}
}
/* Callback for unregistering the IO device. */
static void
_device_unregister_cb(void *io_device)
{
struct vbdev_compress *comp_bdev = io_device;
/* Done with this comp_bdev. */
pthread_mutex_destroy(&comp_bdev->reduce_lock);
free(comp_bdev->drv_name);
free(comp_bdev->comp_bdev.name);
free(comp_bdev);
}
/* Called after we've unregistered following a hot remove callback.
* Our finish entry point will be called next.
*/
static int
vbdev_compress_destruct(void *ctx)
{
struct vbdev_compress *comp_bdev = (struct vbdev_compress *)ctx;
/* Remove this device from the internal list */
TAILQ_REMOVE(&g_vbdev_comp, comp_bdev, link);
/* Unclaim the underlying bdev. */
spdk_bdev_module_release_bdev(comp_bdev->base_bdev);
/* Close the underlying bdev. */
spdk_bdev_close(comp_bdev->base_desc);
/* Unregister the io_device. */
spdk_io_device_unregister(comp_bdev, _device_unregister_cb);
return 0;
}
/* We supplied this as an entry point for upper layers who want to communicate to this
* bdev. This is how they get a channel.
*/
static struct spdk_io_channel *
vbdev_compress_get_io_channel(void *ctx)
{
struct vbdev_compress *comp_bdev = (struct vbdev_compress *)ctx;
/* The IO channel code will allocate a channel for us which consists of
* the SPDK channel structure plus the size of our comp_io_channel struct
* that we passed in when we registered our IO device. It will then call
* our channel create callback to populate any elements that we need to
* update.
*/
return spdk_get_io_channel(comp_bdev);
}
/* This is the output for get_bdevs() for this vbdev */
static int
vbdev_compress_dump_info_json(void *ctx, struct spdk_json_write_ctx *w)
{
struct vbdev_compress *comp_bdev = (struct vbdev_compress *)ctx;
spdk_json_write_name(w, "compress");
spdk_json_write_object_begin(w);
spdk_json_write_named_string(w, "name", spdk_bdev_get_name(&comp_bdev->comp_bdev));
spdk_json_write_named_string(w, "base_bdev_name", spdk_bdev_get_name(comp_bdev->base_bdev));
spdk_json_write_named_string(w, "compression_pmd", comp_bdev->drv_name);
spdk_json_write_object_end(w);
return 0;
}
/* This is used to generate JSON that can configure this module to its current state. */
static int
vbdev_compress_config_json(struct spdk_json_write_ctx *w)
{
struct vbdev_compress *comp_bdev;
TAILQ_FOREACH(comp_bdev, &g_vbdev_comp, link) {
spdk_json_write_object_begin(w);
spdk_json_write_named_string(w, "method", "construct_compress_bdev");
spdk_json_write_named_object_begin(w, "params");
spdk_json_write_named_string(w, "base_bdev_name", spdk_bdev_get_name(comp_bdev->base_bdev));
spdk_json_write_named_string(w, "name", spdk_bdev_get_name(&comp_bdev->comp_bdev));
spdk_json_write_named_string(w, "compression_pmd", comp_bdev->drv_name);
spdk_json_write_object_end(w);
spdk_json_write_object_end(w);
}
return 0;
}
/* We provide this callback for the SPDK channel code to create a channel using
* the channel struct we provided in our module get_io_channel() entry point. Here
* we get and save off an underlying base channel of the device below us so that
* we can communicate with the base bdev on a per channel basis. If we needed
* our own poller for this vbdev, we'd register it here.
*/
static int
comp_bdev_ch_create_cb(void *io_device, void *ctx_buf)
{
struct comp_io_channel *comp_ch = ctx_buf;
struct vbdev_compress *comp_bdev = io_device;
struct comp_device_qp *device_qp;
/* We use this queue to track outstanding IO in our lyaer. */
TAILQ_INIT(&comp_bdev->pending_comp_ios);
/* Now set the reduce channel if it's not already set. */
pthread_mutex_lock(&comp_bdev->reduce_lock);
if (comp_bdev->ch_count == 0) {
comp_bdev->base_ch = spdk_bdev_get_io_channel(comp_bdev->base_desc);
comp_bdev->reduce_thread = spdk_get_thread();
comp_ch->poller = spdk_poller_register(comp_dev_poller, comp_ch, 0);
/* Now assign a q pair */
pthread_mutex_lock(&g_comp_device_qp_lock);
TAILQ_FOREACH(device_qp, &g_comp_device_qp, link) {
if ((strcmp(device_qp->device->cdev_info.driver_name, comp_bdev->drv_name) == 0) &&
(device_qp->in_use == false)) {
comp_bdev->device_qp = device_qp;
device_qp->in_use = true;
break;
}
}
pthread_mutex_unlock(&g_comp_device_qp_lock);
assert(comp_bdev->device_qp);
}
comp_bdev->ch_count++;
pthread_mutex_unlock(&comp_bdev->reduce_lock);
return 0;
}
static void
_clear_qp_and_put_channel(struct vbdev_compress *comp_bdev)
{
pthread_mutex_lock(&g_comp_device_qp_lock);
comp_bdev->device_qp->in_use = false;
pthread_mutex_unlock(&g_comp_device_qp_lock);
spdk_put_io_channel(comp_bdev->base_ch);
comp_bdev->reduce_thread = NULL;
spdk_poller_unregister(&comp_bdev->comp_ch->poller);
}
/* Used to reroute destroy_ch to the correct thread */
static void
_comp_bdev_ch_destroy_cb(void *arg)
{
struct vbdev_compress *comp_bdev = arg;
pthread_mutex_lock(&comp_bdev->reduce_lock);
if (comp_bdev->ch_count == 0) {
_clear_qp_and_put_channel(comp_bdev);
}
pthread_mutex_unlock(&comp_bdev->reduce_lock);
}
/* We provide this callback for the SPDK channel code to destroy a channel
* created with our create callback. We just need to undo anything we did
* when we created. If this bdev used its own poller, we'd unregsiter it here.
*/
static void
comp_bdev_ch_destroy_cb(void *io_device, void *ctx_buf)
{
struct vbdev_compress *comp_bdev = io_device;
pthread_mutex_lock(&comp_bdev->reduce_lock);
comp_bdev->ch_count--;
if (comp_bdev->ch_count == 0) {
/* Send this request to the thread where the channel was created. */
if (comp_bdev->reduce_thread != spdk_get_thread()) {
spdk_thread_send_msg(comp_bdev->reduce_thread,
_comp_bdev_ch_destroy_cb, comp_bdev);
} else {
_clear_qp_and_put_channel(comp_bdev);
}
}
pthread_mutex_unlock(&comp_bdev->reduce_lock);
}
/* RPC entry point for compression vbdev creation. */
int
create_compress_disk(const char *bdev_name, const char *vbdev_name, const char *comp_pmd)
{
struct spdk_bdev *bdev;
bdev = spdk_bdev_get_by_name(bdev_name);
if (!bdev) {
return -ENODEV;
}
/* TODO: vbdev_init_reduce(bdev); goes here */
return 0;
}
/* On init, just init the compress drivers. All metadata is stored on disk. */
static int
vbdev_compress_init(void)
{
if (vbdev_init_compress_drivers()) {
SPDK_ERRLOG("Error setting up compression devices\n");
return -EINVAL;
}
return 0;
}
/* Called when the entire module is being torn down. */
static void
vbdev_compress_finish(void)
{
struct comp_device_qp *dev_qp;
/* TODO: unload vol in a future patch */
while ((dev_qp = TAILQ_FIRST(&g_comp_device_qp))) {
TAILQ_REMOVE(&g_comp_device_qp, dev_qp, link);
free(dev_qp);
}
pthread_mutex_destroy(&g_comp_device_qp_lock);
rte_mempool_free(g_comp_op_mp);
spdk_mempool_free(g_mbuf_mp);
}
/* During init we'll be asked how much memory we'd like passed to us
* in bev_io structures as context. Here's where we specify how
* much context we want per IO.
*/
static int
vbdev_compress_get_ctx_size(void)
{
return sizeof(struct comp_bdev_io);
}
/* When we register our bdev this is how we specify our entry points. */
static const struct spdk_bdev_fn_table vbdev_compress_fn_table = {
.destruct = vbdev_compress_destruct,
.submit_request = vbdev_compress_submit_request,
.io_type_supported = vbdev_compress_io_type_supported,
.get_io_channel = vbdev_compress_get_io_channel,
.dump_info_json = vbdev_compress_dump_info_json,
.write_config_json = NULL,
};
static struct spdk_bdev_module compress_if = {
.name = "compress",
.module_init = vbdev_compress_init,
.config_text = NULL,
.get_ctx_size = vbdev_compress_get_ctx_size,
.examine_config = vbdev_compress_examine,
.module_fini = vbdev_compress_finish,
.config_json = vbdev_compress_config_json
};
SPDK_BDEV_MODULE_REGISTER(compress, &compress_if)
/* Called when the underlying base bdev goes away. */
static void
vbdev_compress_examine_hotremove_cb(void *ctx)
{
/* TODO */
}
/* Claim isn't called until a future series but removing this function
* alone generates many other warnings about basic vbdev stuff (function
* tables, etc.. I think it's better to have all the base functionality
* in this first patch, I'll remove the pragmas as soon as claim is called
* which happens after reduce is integrated.
*/
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-function"
static void
vbdev_compress_claim(struct vbdev_compress *comp_bdev)
{
int rc;
comp_bdev->comp_bdev.name = spdk_sprintf_alloc("COMP_%s", comp_bdev->base_bdev->name);
if (!comp_bdev->comp_bdev.name) {
SPDK_ERRLOG("could not allocate comp_bdev name\n");
goto error_bdev_name;
}
/* TODO: need to persist either PMD name or ALGO and a bunch of
* other parms to reduce via init and read them back in the load path.
*/
comp_bdev->drv_name = ISAL_PMD;
if (!comp_bdev->drv_name) {
SPDK_ERRLOG("could not allocate comb_bdev drv_name\n");
goto error_drv_name;
}
/* Note: some of the fields below will change in the future - for example,
* blockcnt specifically will not match (the compressed volume size will
* be slightly less than the base bdev size)
*/
comp_bdev->comp_bdev.product_name = COMP_BDEV_NAME;
comp_bdev->comp_bdev.write_cache = comp_bdev->base_bdev->write_cache;
comp_bdev->comp_bdev.required_alignment = comp_bdev->base_bdev->required_alignment;
comp_bdev->comp_bdev.optimal_io_boundary = comp_bdev->base_bdev->optimal_io_boundary;
comp_bdev->comp_bdev.blocklen = comp_bdev->base_bdev->blocklen;
comp_bdev->comp_bdev.blockcnt = comp_bdev->base_bdev->blockcnt;
/* This is the context that is passed to us when the bdev
* layer calls in so we'll save our comp_bdev node here.
*/
comp_bdev->comp_bdev.ctxt = comp_bdev;
comp_bdev->comp_bdev.fn_table = &vbdev_compress_fn_table;
comp_bdev->comp_bdev.module = &compress_if;
pthread_mutex_init(&comp_bdev->reduce_lock, NULL);
TAILQ_INSERT_TAIL(&g_vbdev_comp, comp_bdev, link);
rc = spdk_bdev_open(comp_bdev->base_bdev, true, vbdev_compress_examine_hotremove_cb,
comp_bdev->base_bdev, &comp_bdev->base_desc);
if (rc) {
SPDK_ERRLOG("could not open bdev %s\n", spdk_bdev_get_name(comp_bdev->base_bdev));
goto error_open;
}
spdk_io_device_register(comp_bdev, comp_bdev_ch_create_cb, comp_bdev_ch_destroy_cb,
sizeof(struct comp_io_channel),
comp_bdev->comp_bdev.name);
rc = spdk_bdev_module_claim_bdev(comp_bdev->base_bdev, comp_bdev->base_desc,
comp_bdev->comp_bdev.module);
if (rc) {
SPDK_ERRLOG("could not claim bdev %s\n", spdk_bdev_get_name(comp_bdev->base_bdev));
goto error_claim;
}
rc = spdk_vbdev_register(&comp_bdev->comp_bdev, &comp_bdev->base_bdev, 1);
if (rc < 0) {
SPDK_ERRLOG("ERROR trying to register vbdev\n");
goto error_vbdev_register;
}
SPDK_NOTICELOG("registered io_device and virtual bdev for: %s\n", comp_bdev->comp_bdev.name);
return;
/* Error cleanup paths. */
error_vbdev_register:
spdk_bdev_module_release_bdev(comp_bdev->base_bdev);
error_claim:
TAILQ_REMOVE(&g_vbdev_comp, comp_bdev, link);
spdk_io_device_unregister(comp_bdev, NULL);
free(comp_bdev->drv_name);
error_open:
error_drv_name:
free(comp_bdev->comp_bdev.name);
error_bdev_name:
free(comp_bdev);
}
#pragma GCC diagnostic pop
void
delete_compress_disk(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn, void *cb_arg)
{
if (!bdev || bdev->module != &compress_if) {
cb_fn(cb_arg, -ENODEV);
return;
}
spdk_bdev_unregister(bdev, cb_fn, cb_arg);
}
static void
vbdev_compress_examine(struct spdk_bdev *bdev)
{
spdk_bdev_module_examine_done(&compress_if);
}
SPDK_LOG_REGISTER_COMPONENT("vbdev_compress", SPDK_LOG_VBDEV_COMPRESS)

63
lib/bdev/compress/vbdev_compress.h Normal file
View File

@ -0,0 +1,63 @@
/*-
* 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_VBDEV_COMPRESS_H
#define SPDK_VBDEV_COMPRESS_H
#include "spdk/stdinc.h"
#include "spdk/bdev.h"
typedef void (*spdk_delete_compress_complete)(void *cb_arg, int bdeverrno);
/**
* Create new compression bdev.
*
* \param bdev_name Bdev on which compression vbdev will be created.
* \param vbdev_name Vbdev name.
* \param comp_pmd Compression PMD name.
* \return 0 on success, other on failure.
*/
int create_compress_disk(const char *bdev_name, const char *vbdev_name, const char *comp_pmd);
/**
* Delete compress bdev.
*
* \param bdev Pointer to compression bdev.
* \param cb_fn Function to call after deletion.
* \param cb_arg Argument to pass to cb_fn.
*/
void delete_compress_disk(struct spdk_bdev *bdev, spdk_delete_compress_complete cb_fn,
void *cb_arg);
#endif /* SPDK_VBDEV_COMPRESS_H */

163
lib/bdev/compress/vbdev_compress_rpc.c Normal file
View File

@ -0,0 +1,163 @@
/*-
* 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 "vbdev_compress.h"
#include "spdk/rpc.h"
#include "spdk/util.h"
#include "spdk/string.h"
#include "spdk_internal/log.h"
/* Structure to hold the parameters for this RPC method. */
struct rpc_construct_compress {
char *base_bdev_name;
char *name;
char *comp_pmd;
};
/* Free the allocated memory resource after the RPC handling. */
static void
free_rpc_construct_compress(struct rpc_construct_compress *r)
{
free(r->base_bdev_name);
free(r->name);
free(r->comp_pmd);
}
/* Structure to decode the input parameters for this RPC method. */
static const struct spdk_json_object_decoder rpc_construct_compress_decoders[] = {
{"base_bdev_name", offsetof(struct rpc_construct_compress, base_bdev_name), spdk_json_decode_string},
{"name", offsetof(struct rpc_construct_compress, name), spdk_json_decode_string},
{"comp_pmd", offsetof(struct rpc_construct_compress, comp_pmd), spdk_json_decode_string},
};
/* Decode the parameters for this RPC method and properly construct the compress
* device. Error status returned in the failed cases.
*/
static void
spdk_rpc_construct_compress_bdev(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_construct_compress req = {NULL};
struct spdk_json_write_ctx *w;
int rc;
if (spdk_json_decode_object(params, rpc_construct_compress_decoders,
SPDK_COUNTOF(rpc_construct_compress_decoders),
&req)) {
SPDK_DEBUGLOG(SPDK_LOG_VBDEV_COMPRESS, "spdk_json_decode_object failed\n");
goto invalid;
}
rc = create_compress_disk(req.base_bdev_name, req.name, req.comp_pmd);
if (rc != 0) {
goto invalid;
}
w = spdk_jsonrpc_begin_result(request);
if (w == NULL) {
free_rpc_construct_compress(&req);
return;
}
spdk_json_write_string(w, req.name);
spdk_jsonrpc_end_result(request, w);
free_rpc_construct_compress(&req);
return;
invalid:
free_rpc_construct_compress(&req);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters");
}
SPDK_RPC_REGISTER("construct_compress_bdev", spdk_rpc_construct_compress_bdev, SPDK_RPC_RUNTIME)
struct rpc_delete_compress {
char *name;
};
static void
free_rpc_delete_compress(struct rpc_delete_compress *req)
{
free(req->name);
}
static const struct spdk_json_object_decoder rpc_delete_compress_decoders[] = {
{"name", offsetof(struct rpc_delete_compress, name), spdk_json_decode_string},
};
static void
_spdk_rpc_delete_compress_bdev_cb(void *cb_arg, int bdeverrno)
{
struct spdk_jsonrpc_request *request = cb_arg;
struct spdk_json_write_ctx *w;
w = spdk_jsonrpc_begin_result(request);
if (w == NULL) {
return;
}
spdk_json_write_bool(w, bdeverrno == 0);
spdk_jsonrpc_end_result(request, w);
}
static void
spdk_rpc_delete_compress_bdev(struct spdk_jsonrpc_request *request,
const struct spdk_json_val *params)
{
struct rpc_delete_compress req = {NULL};
struct spdk_bdev *bdev;
int rc;
if (spdk_json_decode_object(params, rpc_delete_compress_decoders,
SPDK_COUNTOF(rpc_delete_compress_decoders),
&req)) {
rc = -EINVAL;
goto invalid;
}
bdev = spdk_bdev_get_by_name(req.name);
if (bdev == NULL) {
rc = -ENODEV;
goto invalid;
}
delete_compress_disk(bdev, _spdk_rpc_delete_compress_bdev_cb, request);
free_rpc_delete_compress(&req);
return;
invalid:
free_rpc_delete_compress(&req);
spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc));
}
SPDK_RPC_REGISTER("delete_compress_bdev", spdk_rpc_delete_compress_bdev, SPDK_RPC_RUNTIME)

4
mk/spdk.modules.mk
View File

@ -44,6 +44,10 @@ BLOCKDEV_MODULES_LIST += bdev_ocf
BLOCKDEV_MODULES_LIST += ocfenv
endif
ifeq ($(CONFIG_REDUCE),y)
BLOCKDEV_MODULES_LIST += bdev_compress
endif
ifeq ($(CONFIG_RDMA),y)
SYS_LIBS += -libverbs -lrdmacm
endif

20
scripts/rpc.py
View File

@ -131,6 +131,26 @@ if __name__ == "__main__":
p.add_argument('-c', '--bdev-io-cache-size', help='Maximum number of bdev_io structures cached per thread', type=int)
p.set_defaults(func=set_bdev_options)
def construct_compress_bdev(args):
print(rpc.bdev.construct_compress_bdev(args.client,
base_bdev_name=args.base_bdev_name,
name=args.name,
comp_pmd=args.comp_pmd))
p = subparsers.add_parser('construct_compress_bdev',
help='Add a compress vbdev')
p.add_argument('-b', '--base_bdev_name', help="Name of the base bdev")
p.add_argument('-c', '--name', help="Name of the compress vbdev")
p.add_argument('-d', '--comp_pmd', help="Name of the compression device driver")
p.set_defaults(func=construct_compress_bdev)
def delete_compress_bdev(args):
rpc.bdev.delete_compress_bdev(args.client,
name=args.name)
p = subparsers.add_parser('delete_compress_bdev', help='Delete a compress disk')
p.add_argument('name', help='compress bdev name')
p.set_defaults(func=delete_compress_bdev)
def construct_crypto_bdev(args):
print(rpc.bdev.construct_crypto_bdev(args.client,
base_bdev_name=args.base_bdev_name,

26
scripts/rpc/bdev.py
View File

@ -15,6 +15,32 @@ def set_bdev_options(client, bdev_io_pool_size=None, bdev_io_cache_size=None):
return client.call('set_bdev_options', params)
def construct_compress_bdev(client, base_bdev_name, name, comp_pmd):
"""Construct a compress virtual block device.
Args:
base_bdev_name: name of the underlying base bdev
name: name for the compress vbdev
comp_pmd: name of of the DPDK compression driver to use
Returns:
Name of created virtual block device.
"""
params = {'base_bdev_name': base_bdev_name, 'name': name, 'comp_pmd': comp_pmd}
return client.call('construct_compress_bdev', params)
def delete_compress_bdev(client, name):
"""Delete compress virtual block device.
Args:
name: name of compress vbdev to delete
"""
params = {'name': name}
return client.call('delete_compress_bdev', params)
def construct_crypto_bdev(client, base_bdev_name, name, crypto_pmd, key):
"""Construct a crypto virtual block device.