diff --git a/CHANGELOG.md b/CHANGELOG.md index a2971b011..36a181c3c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -24,6 +24,16 @@ The format of the data returned by the get_bdevs_iostat RPC has changed to make it easier to parse. It now returns an object with a "ticks" object and "bdevs" array with the per-bdev statistics. +A new bdev module `delay` has been added which simulates a drive latency when placed +on top of a Null bdev. This module is intended only for testing and can be created using +the new RPC `bdev_delay_create`. That RPC takes the name of the underlying bdev as well +as average and p99 latency arguments for both read and write operations. Average latency is +defined as a value close to what you would expect a perf tool such as FIO to report back as +the mean latency of all I/O submitted to the drive. p99 latency is defined as the value one +would expect the drive to see the slowest 1% of I/O report. For underlying drives with already +significant latency, the latency values provided to the drive will be additive. This should be +taken into account if trying to achieve an artificial latency on top of an nvme drive or aio device. + ### nvme Added spdk_nvme_ctrlr_get_transport_id() to get the transport ID from a diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index aa0bd45ec..0f1682bd3 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -1672,6 +1672,92 @@ Example response: } ~~~ +## bdev_delay_create {#rpc_bdev_delay_create} + +Create delay bdev. This bdev type redirects all IO to it's base bdev and inserts a delay on the completion +path to create an artificial drive latency. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +name | Required | string | Bdev name +base_bdev_name | Required | string | Base bdev name +avg_read_latency | Required | number | average read latency (us) +p99_read_latency | Required | number | p99 read latency (us) +avg_write_latency | Required | number | average write latency (us) +p99_write_latency | Required | number | p99 write latency (us) + +### Result + +Name of newly created bdev. + +### Example + +Example request: + +~~~ +{ + "params": { + "base_bdev_name": "Null0", + "name": "Delay0", + "avg_read_latency": "15", + "p99_read_latency": "50", + "avg_write_latency": "40", + "p99_write_latency": "110", + }, + "jsonrpc": "2.0", + "method": "bdev_delay_create", + "id": 1 +} +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": "Delay0" +} +~~~ + +## bdev_delay_delete {#rpc_bdev_delay_delete} + +Delete delay bdev. + +### Parameters + +Name | Optional | Type | Description +----------------------- | -------- | ----------- | ----------- +name | Required | string | Bdev name + +### Example + +Example request: + +~~~ +{ + "params": { + "name": "Delay0" + }, + "jsonrpc": "2.0", + "method": "bdev_delay_delete", + "id": 1 +} + +~~~ + +Example response: + +~~~ +{ + "jsonrpc": "2.0", + "id": 1, + "result": true +} +~~~ + ## construct_error_bdev {#rpc_construct_error_bdev} Construct error bdev. diff --git a/lib/bdev/Makefile b/lib/bdev/Makefile index 88d62c257..c560cecb0 100644 --- a/lib/bdev/Makefile +++ b/lib/bdev/Makefile @@ -42,7 +42,7 @@ C_SRCS = bdev.c part.c scsi_nvme.c C_SRCS-$(CONFIG_VTUNE) += vtune.c LIBNAME = bdev -DIRS-y += error gpt lvol malloc null nvme passthru raid rpc split +DIRS-y += delay error gpt lvol malloc null nvme passthru raid rpc split ifeq ($(CONFIG_CRYPTO),y) DIRS-y += crypto diff --git a/lib/bdev/delay/Makefile b/lib/bdev/delay/Makefile new file mode 100644 index 000000000..2abdd53f7 --- /dev/null +++ b/lib/bdev/delay/Makefile @@ -0,0 +1,42 @@ +# +# 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_delay.c vbdev_delay_rpc.c +LIBNAME = bdev_delay + +include $(SPDK_ROOT_DIR)/mk/spdk.lib.mk diff --git a/lib/bdev/delay/vbdev_delay.c b/lib/bdev/delay/vbdev_delay.c new file mode 100644 index 000000000..8e7190385 --- /dev/null +++ b/lib/bdev/delay/vbdev_delay.c @@ -0,0 +1,705 @@ +/*- + * 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 "spdk/stdinc.h" + +#include "vbdev_delay.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" + + +static int vbdev_delay_init(void); +static int vbdev_delay_get_ctx_size(void); +static void vbdev_delay_examine(struct spdk_bdev *bdev); +static void vbdev_delay_finish(void); +static int vbdev_delay_config_json(struct spdk_json_write_ctx *w); + +enum delay_io_type { + DELAY_AVG_READ, + DELAY_P99_READ, + DELAY_AVG_WRITE, + DELAY_P99_WRITE, + DELAY_NONE +}; + +static struct spdk_bdev_module delay_if = { + .name = "delay", + .module_init = vbdev_delay_init, + .config_text = NULL, + .get_ctx_size = vbdev_delay_get_ctx_size, + .examine_config = vbdev_delay_examine, + .module_fini = vbdev_delay_finish, + .config_json = vbdev_delay_config_json +}; + +SPDK_BDEV_MODULE_REGISTER(delay, &delay_if) + +/* Associative list to be used in examine */ +struct bdev_association { + char *vbdev_name; + char *bdev_name; + uint64_t avg_read_latency; + uint64_t p99_read_latency; + uint64_t avg_write_latency; + uint64_t p99_write_latency; + TAILQ_ENTRY(bdev_association) link; +}; +static TAILQ_HEAD(, bdev_association) g_bdev_associations = TAILQ_HEAD_INITIALIZER( + g_bdev_associations); + +/* List of virtual bdevs and associated info for each. */ +struct vbdev_delay { + 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_bdev delay_bdev; /* the delay virtual bdev */ + uint64_t average_read_latency_ticks; /* the average read delay */ + uint64_t p99_read_latency_ticks; /* the p99 read delay */ + uint64_t average_write_latency_ticks; /* the average write delay */ + uint64_t p99_write_latency_ticks; /* the p99 write delay */ + TAILQ_ENTRY(vbdev_delay) link; +}; +static TAILQ_HEAD(, vbdev_delay) g_delay_nodes = TAILQ_HEAD_INITIALIZER(g_delay_nodes); + +struct delay_bdev_io { + int status; + + uint64_t completion_tick; + + enum delay_io_type type; + + struct spdk_io_channel *ch; + + struct spdk_bdev_io_wait_entry bdev_io_wait; + + STAILQ_ENTRY(delay_bdev_io) link; +}; + +struct delay_io_channel { + struct spdk_io_channel *base_ch; /* IO channel of base device */ + STAILQ_HEAD(, delay_bdev_io) avg_read_io; + STAILQ_HEAD(, delay_bdev_io) p99_read_io; + STAILQ_HEAD(, delay_bdev_io) avg_write_io; + STAILQ_HEAD(, delay_bdev_io) p99_write_io; + struct spdk_poller *io_poller; + unsigned int rand_seed; +}; + +static void +vbdev_delay_submit_request(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io); + + +/* Callback for unregistering the IO device. */ +static void +_device_unregister_cb(void *io_device) +{ + struct vbdev_delay *delay_node = io_device; + + /* Done with this delay_node. */ + free(delay_node->delay_bdev.name); + free(delay_node); +} + +static int +vbdev_delay_destruct(void *ctx) +{ + struct vbdev_delay *delay_node = (struct vbdev_delay *)ctx; + + /* It is important to follow this exact sequence of steps for destroying + * a vbdev... + */ + + TAILQ_REMOVE(&g_delay_nodes, delay_node, link); + + /* Unclaim the underlying bdev. */ + spdk_bdev_module_release_bdev(delay_node->base_bdev); + + /* Close the underlying bdev. */ + spdk_bdev_close(delay_node->base_desc); + + /* Unregister the io_device. */ + spdk_io_device_unregister(delay_node, _device_unregister_cb); + + return 0; +} + +static void +_process_io_stailq(void *arg, uint64_t ticks) +{ + STAILQ_HEAD(, delay_bdev_io) *head = arg; + struct delay_bdev_io *io_ctx, *tmp; + + STAILQ_FOREACH_SAFE(io_ctx, head, link, tmp) { + if (io_ctx->completion_tick <= ticks) { + STAILQ_REMOVE(head, io_ctx, delay_bdev_io, link); + spdk_bdev_io_complete(SPDK_CONTAINEROF(io_ctx, struct spdk_bdev_io, driver_ctx), io_ctx->status); + } else { + /* We can assume that I/O are strictly ordered. If one is not expired, we can assume that all after it aren't either. */ + break; + } + } +} + +static int +_delay_finish_io(void *arg) +{ + struct delay_io_channel *delay_ch = arg; + uint64_t ticks = spdk_get_ticks(); + + _process_io_stailq(&delay_ch->avg_read_io, ticks); + _process_io_stailq(&delay_ch->avg_write_io, ticks); + _process_io_stailq(&delay_ch->p99_read_io, ticks); + _process_io_stailq(&delay_ch->p99_write_io, ticks); + + return 0; +} + +/* Completion callback for IO that were issued from this bdev. The original bdev_io + * is passed in as an arg so we'll complete that one with the appropriate status + * and then free the one that this module issued. + */ +static void +_delay_complete_io(struct spdk_bdev_io *bdev_io, bool success, void *cb_arg) +{ + struct spdk_bdev_io *orig_io = cb_arg; + struct vbdev_delay *delay_node = SPDK_CONTAINEROF(orig_io->bdev, struct vbdev_delay, delay_bdev); + struct delay_bdev_io *io_ctx = (struct delay_bdev_io *)orig_io->driver_ctx; + struct delay_io_channel *delay_ch = spdk_io_channel_get_ctx(io_ctx->ch); + + io_ctx->status = success ? SPDK_BDEV_IO_STATUS_SUCCESS : SPDK_BDEV_IO_STATUS_FAILED; + spdk_bdev_free_io(bdev_io); + + /* Put the I/O into the proper list for processing by the channel poller. */ + switch (io_ctx->type) { + case DELAY_AVG_READ: + io_ctx->completion_tick = spdk_get_ticks() + delay_node->average_read_latency_ticks; + STAILQ_INSERT_TAIL(&delay_ch->avg_read_io, io_ctx, link); + break; + case DELAY_AVG_WRITE: + io_ctx->completion_tick = spdk_get_ticks() + delay_node->average_write_latency_ticks; + STAILQ_INSERT_TAIL(&delay_ch->avg_write_io, io_ctx, link); + break; + case DELAY_P99_READ: + io_ctx->completion_tick = spdk_get_ticks() + delay_node->p99_read_latency_ticks; + STAILQ_INSERT_TAIL(&delay_ch->p99_read_io, io_ctx, link); + break; + case DELAY_P99_WRITE: + io_ctx->completion_tick = spdk_get_ticks() + delay_node->p99_write_latency_ticks; + STAILQ_INSERT_TAIL(&delay_ch->p99_write_io, io_ctx, link); + break; + case DELAY_NONE: + default: + spdk_bdev_io_complete(orig_io, io_ctx->status); + break; + } +} + +static void +vbdev_delay_resubmit_io(void *arg) +{ + struct spdk_bdev_io *bdev_io = (struct spdk_bdev_io *)arg; + struct delay_bdev_io *io_ctx = (struct delay_bdev_io *)bdev_io->driver_ctx; + + vbdev_delay_submit_request(io_ctx->ch, bdev_io); +} + +static void +vbdev_delay_queue_io(struct spdk_bdev_io *bdev_io) +{ + struct delay_bdev_io *io_ctx = (struct delay_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_delay_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 != 0) { + SPDK_ERRLOG("Queue io failed in vbdev_delay_queue_io, rc=%d.\n", rc); + spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED); + } +} + +static void +delay_read_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, bool success) +{ + struct vbdev_delay *delay_node = SPDK_CONTAINEROF(bdev_io->bdev, struct vbdev_delay, + delay_bdev); + struct delay_io_channel *delay_ch = spdk_io_channel_get_ctx(ch); + int rc; + + if (!success) { + spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED); + return; + } + + rc = spdk_bdev_readv_blocks(delay_node->base_desc, delay_ch->base_ch, bdev_io->u.bdev.iovs, + bdev_io->u.bdev.iovcnt, bdev_io->u.bdev.offset_blocks, + bdev_io->u.bdev.num_blocks, _delay_complete_io, + bdev_io); + + if (rc != 0) { + if (rc == -ENOMEM) { + SPDK_ERRLOG("No memory, start to queue io for delay.\n"); + vbdev_delay_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 void +vbdev_delay_submit_request(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io) +{ + struct vbdev_delay *delay_node = SPDK_CONTAINEROF(bdev_io->bdev, struct vbdev_delay, delay_bdev); + struct delay_io_channel *delay_ch = spdk_io_channel_get_ctx(ch); + struct delay_bdev_io *io_ctx = (struct delay_bdev_io *)bdev_io->driver_ctx; + int rc = 0; + bool is_p99; + + is_p99 = rand_r(&delay_ch->rand_seed) % 100 == 0 ? true : false; + + io_ctx->ch = ch; + io_ctx->type = DELAY_NONE; + + switch (bdev_io->type) { + case SPDK_BDEV_IO_TYPE_READ: + io_ctx->type = is_p99 ? DELAY_P99_READ : DELAY_AVG_READ; + spdk_bdev_io_get_buf(bdev_io, delay_read_get_buf_cb, + bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen); + break; + case SPDK_BDEV_IO_TYPE_WRITE: + io_ctx->type = is_p99 ? DELAY_P99_WRITE : DELAY_AVG_WRITE; + rc = spdk_bdev_writev_blocks(delay_node->base_desc, delay_ch->base_ch, bdev_io->u.bdev.iovs, + bdev_io->u.bdev.iovcnt, bdev_io->u.bdev.offset_blocks, + bdev_io->u.bdev.num_blocks, _delay_complete_io, + bdev_io); + break; + case SPDK_BDEV_IO_TYPE_WRITE_ZEROES: + rc = spdk_bdev_write_zeroes_blocks(delay_node->base_desc, delay_ch->base_ch, + bdev_io->u.bdev.offset_blocks, + bdev_io->u.bdev.num_blocks, + _delay_complete_io, bdev_io); + break; + case SPDK_BDEV_IO_TYPE_UNMAP: + rc = spdk_bdev_unmap_blocks(delay_node->base_desc, delay_ch->base_ch, + bdev_io->u.bdev.offset_blocks, + bdev_io->u.bdev.num_blocks, + _delay_complete_io, bdev_io); + break; + case SPDK_BDEV_IO_TYPE_FLUSH: + rc = spdk_bdev_flush_blocks(delay_node->base_desc, delay_ch->base_ch, + bdev_io->u.bdev.offset_blocks, + bdev_io->u.bdev.num_blocks, + _delay_complete_io, bdev_io); + break; + case SPDK_BDEV_IO_TYPE_RESET: + rc = spdk_bdev_reset(delay_node->base_desc, delay_ch->base_ch, + _delay_complete_io, bdev_io); + break; + default: + SPDK_ERRLOG("delay: unknown I/O type %d\n", bdev_io->type); + spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED); + return; + } + if (rc != 0) { + if (rc == -ENOMEM) { + SPDK_ERRLOG("No memory, start to queue io for delay.\n"); + vbdev_delay_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_delay_io_type_supported(void *ctx, enum spdk_bdev_io_type io_type) +{ + struct vbdev_delay *delay_node = (struct vbdev_delay *)ctx; + + return spdk_bdev_io_type_supported(delay_node->base_bdev, io_type); +} + +static struct spdk_io_channel * +vbdev_delay_get_io_channel(void *ctx) +{ + struct vbdev_delay *delay_node = (struct vbdev_delay *)ctx; + struct spdk_io_channel *delay_ch = NULL; + + delay_ch = spdk_get_io_channel(delay_node); + + return delay_ch; +} + +static void +_delay_write_conf_values(struct vbdev_delay *delay_node, struct spdk_json_write_ctx *w) +{ + spdk_json_write_named_string(w, "name", spdk_bdev_get_name(&delay_node->delay_bdev)); + spdk_json_write_named_string(w, "base_bdev_name", spdk_bdev_get_name(delay_node->base_bdev)); + spdk_json_write_named_int64(w, "avg_read_latency", + delay_node->average_read_latency_ticks / spdk_get_ticks_hz() * SPDK_SEC_TO_USEC); + spdk_json_write_named_int64(w, "p99_read_latency", + delay_node->p99_read_latency_ticks / spdk_get_ticks_hz() * SPDK_SEC_TO_USEC); + spdk_json_write_named_int64(w, "avg_write_latency", + delay_node->average_write_latency_ticks / spdk_get_ticks_hz() * SPDK_SEC_TO_USEC); + spdk_json_write_named_int64(w, "p99_write_latency", + delay_node->p99_write_latency_ticks / spdk_get_ticks_hz() * SPDK_SEC_TO_USEC); +} + +static int +vbdev_delay_dump_info_json(void *ctx, struct spdk_json_write_ctx *w) +{ + struct vbdev_delay *delay_node = (struct vbdev_delay *)ctx; + + spdk_json_write_name(w, "delay"); + spdk_json_write_object_begin(w); + _delay_write_conf_values(delay_node, w); + 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_delay_config_json(struct spdk_json_write_ctx *w) +{ + struct vbdev_delay *delay_node; + + TAILQ_FOREACH(delay_node, &g_delay_nodes, link) { + spdk_json_write_object_begin(w); + spdk_json_write_named_string(w, "method", "bdev_delay_create"); + spdk_json_write_named_object_begin(w, "params"); + _delay_write_conf_values(delay_node, 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 +delay_bdev_ch_create_cb(void *io_device, void *ctx_buf) +{ + struct delay_io_channel *delay_ch = ctx_buf; + struct vbdev_delay *delay_node = io_device; + + STAILQ_INIT(&delay_ch->avg_read_io); + STAILQ_INIT(&delay_ch->p99_read_io); + STAILQ_INIT(&delay_ch->avg_write_io); + STAILQ_INIT(&delay_ch->p99_write_io); + + delay_ch->io_poller = spdk_poller_register(_delay_finish_io, delay_ch, 0); + delay_ch->base_ch = spdk_bdev_get_io_channel(delay_node->base_desc); + delay_ch->rand_seed = time(NULL); + + return 0; +} + +/* 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 +delay_bdev_ch_destroy_cb(void *io_device, void *ctx_buf) +{ + struct delay_io_channel *delay_ch = ctx_buf; + + spdk_poller_unregister(&delay_ch->io_poller); + spdk_put_io_channel(delay_ch->base_ch); +} + +/* Create the delay association from the bdev and vbdev name and insert + * on the global list. */ +static int +vbdev_delay_insert_association(const char *bdev_name, const char *vbdev_name, + uint64_t avg_read_latency, uint64_t p99_read_latency, + uint64_t avg_write_latency, uint64_t p99_write_latency) +{ + struct bdev_association *assoc; + + TAILQ_FOREACH(assoc, &g_bdev_associations, link) { + if (strcmp(vbdev_name, assoc->vbdev_name) == 0) { + SPDK_ERRLOG("delay bdev %s already exists\n", vbdev_name); + return -EEXIST; + } + } + + assoc = calloc(1, sizeof(struct bdev_association)); + if (!assoc) { + SPDK_ERRLOG("could not allocate bdev_association\n"); + return -ENOMEM; + } + + assoc->bdev_name = strdup(bdev_name); + if (!assoc->bdev_name) { + SPDK_ERRLOG("could not allocate assoc->bdev_name\n"); + free(assoc); + return -ENOMEM; + } + + assoc->vbdev_name = strdup(vbdev_name); + if (!assoc->vbdev_name) { + SPDK_ERRLOG("could not allocate assoc->vbdev_name\n"); + free(assoc->bdev_name); + free(assoc); + return -ENOMEM; + } + + assoc->avg_read_latency = avg_read_latency; + assoc->p99_read_latency = p99_read_latency; + assoc->avg_write_latency = avg_write_latency; + assoc->p99_write_latency = p99_write_latency; + + TAILQ_INSERT_TAIL(&g_bdev_associations, assoc, link); + + return 0; +} + +static int +vbdev_delay_init(void) +{ + /* Not allowing for .ini style configuration. */ + return 0; +} + +static void +vbdev_delay_finish(void) +{ + struct bdev_association *assoc; + + while ((assoc = TAILQ_FIRST(&g_bdev_associations))) { + TAILQ_REMOVE(&g_bdev_associations, assoc, link); + free(assoc->bdev_name); + free(assoc->vbdev_name); + free(assoc); + } +} + +static int +vbdev_delay_get_ctx_size(void) +{ + return sizeof(struct delay_bdev_io); +} + +static void +vbdev_delay_write_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx *w) +{ + /* No config per bdev needed */ +} + +/* When we register our bdev this is how we specify our entry points. */ +static const struct spdk_bdev_fn_table vbdev_delay_fn_table = { + .destruct = vbdev_delay_destruct, + .submit_request = vbdev_delay_submit_request, + .io_type_supported = vbdev_delay_io_type_supported, + .get_io_channel = vbdev_delay_get_io_channel, + .dump_info_json = vbdev_delay_dump_info_json, + .write_config_json = vbdev_delay_write_config_json, +}; + +/* Called when the underlying base bdev goes away. */ +static void +vbdev_delay_base_bdev_hotremove_cb(void *ctx) +{ + struct vbdev_delay *delay_node, *tmp; + struct spdk_bdev *bdev_find = ctx; + + TAILQ_FOREACH_SAFE(delay_node, &g_delay_nodes, link, tmp) { + if (bdev_find == delay_node->base_bdev) { + spdk_bdev_unregister(&delay_node->delay_bdev, NULL, NULL); + } + } +} + +/* Create and register the delay vbdev if we find it in our list of bdev names. + * This can be called either by the examine path or RPC method. + */ +static int +vbdev_delay_register(struct spdk_bdev *bdev) +{ + struct bdev_association *assoc; + struct vbdev_delay *delay_node; + uint64_t ticks_mhz = spdk_get_ticks_hz() / SPDK_SEC_TO_USEC; + int rc = 0; + + /* Check our list of names from config versus this bdev and if + * there's a match, create the delay_node & bdev accordingly. + */ + TAILQ_FOREACH(assoc, &g_bdev_associations, link) { + if (strcmp(assoc->bdev_name, bdev->name) != 0) { + continue; + } + + delay_node = calloc(1, sizeof(struct vbdev_delay)); + if (!delay_node) { + rc = -ENOMEM; + SPDK_ERRLOG("could not allocate delay_node\n"); + break; + } + + /* The base bdev that we're attaching to. */ + delay_node->base_bdev = bdev; + delay_node->delay_bdev.name = strdup(assoc->vbdev_name); + if (!delay_node->delay_bdev.name) { + rc = -ENOMEM; + SPDK_ERRLOG("could not allocate delay_bdev name\n"); + free(delay_node); + break; + } + delay_node->delay_bdev.product_name = "delay"; + + delay_node->delay_bdev.write_cache = bdev->write_cache; + delay_node->delay_bdev.required_alignment = bdev->required_alignment; + delay_node->delay_bdev.optimal_io_boundary = bdev->optimal_io_boundary; + delay_node->delay_bdev.blocklen = bdev->blocklen; + delay_node->delay_bdev.blockcnt = bdev->blockcnt; + + delay_node->delay_bdev.ctxt = delay_node; + delay_node->delay_bdev.fn_table = &vbdev_delay_fn_table; + delay_node->delay_bdev.module = &delay_if; + + /* Store the number of ticks you need to add to get the I/O expiration time. */ + delay_node->average_read_latency_ticks = ticks_mhz * assoc->avg_read_latency; + delay_node->p99_read_latency_ticks = ticks_mhz * assoc->p99_read_latency; + delay_node->average_write_latency_ticks = ticks_mhz * assoc->avg_write_latency; + delay_node->p99_write_latency_ticks = ticks_mhz * assoc->p99_write_latency; + + spdk_io_device_register(delay_node, delay_bdev_ch_create_cb, delay_bdev_ch_destroy_cb, + sizeof(struct delay_io_channel), + assoc->vbdev_name); + + rc = spdk_bdev_open(bdev, true, vbdev_delay_base_bdev_hotremove_cb, + bdev, &delay_node->base_desc); + if (rc) { + SPDK_ERRLOG("could not open bdev %s\n", spdk_bdev_get_name(bdev)); + goto error_unregister; + } + + rc = spdk_bdev_module_claim_bdev(bdev, delay_node->base_desc, delay_node->delay_bdev.module); + if (rc) { + SPDK_ERRLOG("could not claim bdev %s\n", spdk_bdev_get_name(bdev)); + goto error_close; + } + + rc = spdk_bdev_register(&delay_node->delay_bdev); + if (rc) { + SPDK_ERRLOG("could not register delay_bdev\n"); + spdk_bdev_module_release_bdev(delay_node->base_bdev); + goto error_close; + } + + TAILQ_INSERT_TAIL(&g_delay_nodes, delay_node, link); + } + + return rc; + +error_close: + spdk_bdev_close(delay_node->base_desc); +error_unregister: + spdk_io_device_unregister(delay_node, NULL); + free(delay_node->delay_bdev.name); + free(delay_node); + return rc; +} + +int +create_delay_disk(const char *bdev_name, const char *vbdev_name, uint64_t avg_read_latency, + uint64_t p99_read_latency, uint64_t avg_write_latency, uint64_t p99_write_latency) +{ + struct spdk_bdev *bdev = NULL; + int rc = 0; + + if (p99_read_latency < avg_read_latency || p99_write_latency < avg_write_latency) { + SPDK_ERRLOG("Unable to create a delay bdev where p99 latency is less than average latency.\n"); + return -EINVAL; + } + + rc = vbdev_delay_insert_association(bdev_name, vbdev_name, avg_read_latency, p99_read_latency, + avg_write_latency, p99_write_latency); + if (rc) { + return rc; + } + + bdev = spdk_bdev_get_by_name(bdev_name); + if (!bdev) { + return 0; + } + + return vbdev_delay_register(bdev); +} + +void +delete_delay_disk(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn, void *cb_arg) +{ + struct bdev_association *assoc; + + if (!bdev || bdev->module != &delay_if) { + cb_fn(cb_arg, -ENODEV); + return; + } + + TAILQ_FOREACH(assoc, &g_bdev_associations, link) { + if (strcmp(assoc->vbdev_name, bdev->name) == 0) { + TAILQ_REMOVE(&g_bdev_associations, assoc, link); + free(assoc->bdev_name); + free(assoc->vbdev_name); + free(assoc); + break; + } + } + + spdk_bdev_unregister(bdev, cb_fn, cb_arg); +} + +static void +vbdev_delay_examine(struct spdk_bdev *bdev) +{ + vbdev_delay_register(bdev); + + spdk_bdev_module_examine_done(&delay_if); +} + +SPDK_LOG_REGISTER_COMPONENT("vbdev_delay", SPDK_LOG_VBDEV_DELAY) diff --git a/lib/bdev/delay/vbdev_delay.h b/lib/bdev/delay/vbdev_delay.h new file mode 100644 index 000000000..b912d23f4 --- /dev/null +++ b/lib/bdev/delay/vbdev_delay.h @@ -0,0 +1,66 @@ +/*- + * 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_DELAY_H +#define SPDK_VBDEV_DELAY_H + +#include "spdk/stdinc.h" + +#include "spdk/bdev.h" +#include "spdk/bdev_module.h" + +/** + * Create new delay bdev. + * + * \param bdev_name Bdev on which delay vbdev will be created. + * \param vbdev_name Name of the delay bdev. + * \param avg_read_latency Desired typical read latency. + * \param p99_read_latency Desired p99 read latency + * \param avg_write_latency Desired typical write latency. + * \param p99_write_latency Desired p99 write latency + * \return 0 on success, other on failure. + */ +int create_delay_disk(const char *bdev_name, const char *vbdev_name, uint64_t avg_read_latency, + uint64_t p99_read_latency, uint64_t avg_write_latency, uint64_t p99_write_latency); + +/** + * Delete delay bdev. + * + * \param bdev Pointer to delay bdev. + * \param cb_fn Function to call after deletion. + * \param cb_arg Argument to pass to cb_fn. + */ +void delete_delay_disk(struct spdk_bdev *bdev, spdk_bdev_unregister_cb cb_fn, + void *cb_arg); + +#endif /* SPDK_VBDEV_DELAY_H */ diff --git a/lib/bdev/delay/vbdev_delay_rpc.c b/lib/bdev/delay/vbdev_delay_rpc.c new file mode 100644 index 000000000..edb73e484 --- /dev/null +++ b/lib/bdev/delay/vbdev_delay_rpc.c @@ -0,0 +1,165 @@ +/*- + * 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_delay.h" +#include "spdk/rpc.h" +#include "spdk/util.h" +#include "spdk/string.h" +#include "spdk_internal/log.h" + +struct rpc_construct_delay { + char *base_bdev_name; + char *name; + uint64_t avg_read_latency; + uint64_t p99_read_latency; + uint64_t avg_write_latency; + uint64_t p99_write_latency; +}; + +static void +free_rpc_construct_delay(struct rpc_construct_delay *r) +{ + free(r->base_bdev_name); + free(r->name); +} + +static const struct spdk_json_object_decoder rpc_construct_delay_decoders[] = { + {"base_bdev_name", offsetof(struct rpc_construct_delay, base_bdev_name), spdk_json_decode_string}, + {"name", offsetof(struct rpc_construct_delay, name), spdk_json_decode_string}, + {"avg_read_latency", offsetof(struct rpc_construct_delay, avg_read_latency), spdk_json_decode_uint64}, + {"p99_read_latency", offsetof(struct rpc_construct_delay, p99_read_latency), spdk_json_decode_uint64}, + {"avg_write_latency", offsetof(struct rpc_construct_delay, avg_write_latency), spdk_json_decode_uint64}, + {"p99_write_latency", offsetof(struct rpc_construct_delay, p99_write_latency), spdk_json_decode_uint64}, +}; + +static void +spdk_rpc_bdev_delay_create(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) +{ + struct rpc_construct_delay req = {NULL}; + struct spdk_json_write_ctx *w; + int rc; + + if (spdk_json_decode_object(params, rpc_construct_delay_decoders, + SPDK_COUNTOF(rpc_construct_delay_decoders), + &req)) { + SPDK_DEBUGLOG(SPDK_LOG_VBDEV_DELAY, "spdk_json_decode_object failed\n"); + free_rpc_construct_delay(&req); + spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, "Invalid parameters"); + return; + } + + rc = create_delay_disk(req.base_bdev_name, req.name, req.avg_read_latency, req.p99_read_latency, + req.avg_write_latency, req.p99_write_latency); + if (rc != 0) { + free_rpc_construct_delay(&req); + spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INTERNAL_ERROR, + "Failed to create delay_disk"); + return; + } + + w = spdk_jsonrpc_begin_result(request); + if (w == NULL) { + free_rpc_construct_delay(&req); + return; + } + + spdk_json_write_string(w, req.name); + spdk_jsonrpc_end_result(request, w); + free_rpc_construct_delay(&req); + return; +} +SPDK_RPC_REGISTER("bdev_delay_create", spdk_rpc_bdev_delay_create, SPDK_RPC_RUNTIME) + +struct rpc_delete_delay { + char *name; +}; + +static void +free_rpc_delete_delay(struct rpc_delete_delay *req) +{ + free(req->name); +} + +static const struct spdk_json_object_decoder rpc_delete_delay_decoders[] = { + {"name", offsetof(struct rpc_delete_delay, name), spdk_json_decode_string}, +}; + +static void +_spdk_rpc_bdev_delay_delete_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_bdev_delay_delete(struct spdk_jsonrpc_request *request, + const struct spdk_json_val *params) +{ + struct rpc_delete_delay req = {NULL}; + struct spdk_bdev *bdev; + int rc; + + if (spdk_json_decode_object(params, rpc_delete_delay_decoders, + SPDK_COUNTOF(rpc_delete_delay_decoders), + &req)) { + rc = -EINVAL; + goto invalid; + } + + bdev = spdk_bdev_get_by_name(req.name); + if (bdev == NULL) { + rc = -ENODEV; + goto invalid; + } + + delete_delay_disk(bdev, _spdk_rpc_bdev_delay_delete_cb, request); + + free_rpc_delete_delay(&req); + + return; + +invalid: + free_rpc_delete_delay(&req); + spdk_jsonrpc_send_error_response(request, SPDK_JSONRPC_ERROR_INVALID_PARAMS, spdk_strerror(-rc)); +} +SPDK_RPC_REGISTER("bdev_delay_delete", spdk_rpc_bdev_delay_delete, SPDK_RPC_RUNTIME) diff --git a/mk/spdk.modules.mk b/mk/spdk.modules.mk index f7ca53617..887fc667e 100644 --- a/mk/spdk.modules.mk +++ b/mk/spdk.modules.mk @@ -32,7 +32,7 @@ # BLOCKDEV_MODULES_LIST = bdev_lvol blobfs blob blob_bdev lvol -BLOCKDEV_MODULES_LIST += bdev_malloc bdev_null bdev_nvme nvme bdev_passthru bdev_error bdev_gpt bdev_split vmd +BLOCKDEV_MODULES_LIST += bdev_malloc bdev_null bdev_nvme nvme bdev_passthru bdev_error bdev_gpt bdev_split bdev_delay vmd BLOCKDEV_MODULES_LIST += bdev_raid ifeq ($(CONFIG_CRYPTO),y) diff --git a/scripts/rpc.py b/scripts/rpc.py index 625243efa..4d775237c 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -408,6 +408,33 @@ if __name__ == "__main__": p.add_argument('name', help='rbd bdev name') p.set_defaults(func=delete_rbd_bdev) + def bdev_delay_create(args): + print(rpc.bdev.bdev_delay_create(args.client, + base_bdev_name=args.base_bdev_name, + name=args.name, + avg_read_latency=args.avg_read_latency, + p99_read_latency=args.nine_nine_read_latency, + avg_write_latency=args.avg_write_latency, + p99_write_latency=args.nine_nine_write_latency)) + + p = subparsers.add_parser('bdev_delay_create', + help='Add a delay bdev on existing bdev') + p.add_argument('-b', '--base-bdev-name', help="Name of the existing bdev", required=True) + p.add_argument('-d', '--name', help="Name of the delay bdev", required=True) + p.add_argument('-r', '--avg-read-latency', help="Average latency to apply before completing read ops", required=True, type=int) + p.add_argument('-t', '--nine-nine-read-latency', help="latency to apply to 1 in 100 read ops", required=True, type=int) + p.add_argument('-w', '--avg-write-latency', help="Average latency to apply before completing write ops", required=True, type=int) + p.add_argument('-n', '--nine-nine-write-latency', help="latency to apply to 1 in 100 write ops", required=True, type=int) + p.set_defaults(func=bdev_delay_create) + + def bdev_delay_delete(args): + rpc.bdev.bdev_delay_delete(args.client, + name=args.name) + + p = subparsers.add_parser('bdev_delay_delete', help='Delete a delay bdev') + p.add_argument('name', help='delay bdev name') + p.set_defaults(func=bdev_delay_delete) + def construct_error_bdev(args): print(rpc.bdev.construct_error_bdev(args.client, base_name=args.base_name)) diff --git a/scripts/rpc/bdev.py b/scripts/rpc/bdev.py index aa6a1aa55..75034ad74 100644 --- a/scripts/rpc/bdev.py +++ b/scripts/rpc/bdev.py @@ -424,6 +424,41 @@ def construct_error_bdev(client, base_name): return client.call('construct_error_bdev', params) +def bdev_delay_create(client, base_bdev_name, name, avg_read_latency, p99_read_latency, avg_write_latency, p99_write_latency): + """Construct a delay block device. + + Args: + base_bdev_name: name of the existing bdev + name: name of block device + avg_read_latency: complete 99% of read ops with this delay + p99_read_latency: complete 1% of read ops with this delay + avg_write_latency: complete 99% of write ops with this delay + p99_write_latency: complete 1% of write ops with this delay + + Returns: + Name of created block device. + """ + params = { + 'base_bdev_name': base_bdev_name, + 'name': name, + 'avg_read_latency': avg_read_latency, + 'p99_read_latency': p99_read_latency, + 'avg_write_latency': avg_write_latency, + 'p99_write_latency': p99_write_latency, + } + return client.call('bdev_delay_create', params) + + +def bdev_delay_delete(client, name): + """Remove delay bdev from the system. + + Args: + name: name of delay bdev to delete + """ + params = {'name': name} + return client.call('bdev_delay_delete', params) + + def delete_error_bdev(client, name): """Remove error bdev from the system. diff --git a/test/json_config/clear_config.py b/test/json_config/clear_config.py index 56071446f..dc0a3c666 100755 --- a/test/json_config/clear_config.py +++ b/test/json_config/clear_config.py @@ -55,6 +55,7 @@ def get_bdev_destroy_method(bdev): 'construct_split_vbdev': "destruct_split_vbdev", 'construct_virtio_dev': "remove_virtio_bdev", 'construct_crypto_bdev': "delete_crypto_bdev", + 'bdev_delay_create': "bdev_delay_delete", 'construct_passthru_bdev': "delete_passthru_bdev", 'construct_compress_bdev': 'delete_compress_bdev', }