From a818023095d564b7c5df964cf13f1d4ff3625089 Mon Sep 17 00:00:00 2001 From: Wojciech Malikowski Date: Wed, 6 Feb 2019 09:18:05 -0500 Subject: [PATCH] test/unit/ftl: Add unit test for write pointer functionality Change-Id: I0c1be8860263a6eed72f2d572fc594c084535ee8 Signed-off-by: Wojciech Malikowski Reviewed-on: https://review.gerrithub.io/c/443579 Tested-by: SPDK CI Jenkins Reviewed-by: Jim Harris Reviewed-by: Ben Walker Reviewed-by: Konrad Sztyber --- test/unit/lib/ftl/Makefile | 2 +- test/unit/lib/ftl/common/utils.c | 28 ++- test/unit/lib/ftl/ftl_wptr/.gitignore | 1 + test/unit/lib/ftl/ftl_wptr/Makefile | 38 ++++ test/unit/lib/ftl/ftl_wptr/ftl_wptr_ut.c | 219 +++++++++++++++++++++++ test/unit/unittest.sh | 1 + 6 files changed, 283 insertions(+), 6 deletions(-) create mode 100644 test/unit/lib/ftl/ftl_wptr/.gitignore create mode 100644 test/unit/lib/ftl/ftl_wptr/Makefile create mode 100644 test/unit/lib/ftl/ftl_wptr/ftl_wptr_ut.c diff --git a/test/unit/lib/ftl/Makefile b/test/unit/lib/ftl/Makefile index bde96982c..8e1b01bb3 100644 --- a/test/unit/lib/ftl/Makefile +++ b/test/unit/lib/ftl/Makefile @@ -34,7 +34,7 @@ SPDK_ROOT_DIR := $(abspath $(CURDIR)/../../../..) include $(SPDK_ROOT_DIR)/mk/spdk.common.mk -DIRS-y = ftl_rwb.c ftl_ppa ftl_band.c ftl_reloc.c +DIRS-y = ftl_rwb.c ftl_ppa ftl_band.c ftl_reloc.c ftl_wptr .PHONY: all clean $(DIRS-y) diff --git a/test/unit/lib/ftl/common/utils.c b/test/unit/lib/ftl/common/utils.c index f5b967ac5..975c5527b 100644 --- a/test/unit/lib/ftl/common/utils.c +++ b/test/unit/lib/ftl/common/utils.c @@ -31,10 +31,19 @@ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ +#include "spdk_internal/thread.h" + #include "spdk/ftl.h" #include "ftl/ftl_core.h" -static struct spdk_ftl_dev * +struct spdk_ftl_dev *test_init_ftl_dev(const struct spdk_ocssd_geometry_data *geo, + const struct spdk_ftl_punit_range *range); +struct ftl_band *test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id); +void test_free_ftl_dev(struct spdk_ftl_dev *dev); +void test_free_ftl_band(struct ftl_band *band); +uint64_t test_offset_from_ppa(struct ftl_ppa ppa, struct ftl_band *band); + +struct spdk_ftl_dev * test_init_ftl_dev(const struct spdk_ocssd_geometry_data *geo, const struct spdk_ftl_punit_range *range) { @@ -47,6 +56,8 @@ test_init_ftl_dev(const struct spdk_ocssd_geometry_data *geo, dev->xfer_size = geo->ws_opt; dev->geo = *geo; dev->range = *range; + dev->core_thread.thread = spdk_thread_create("unit_test_thread"); + spdk_set_thread(dev->core_thread.thread); dev->bands = calloc(geo->num_chk, sizeof(*dev->bands)); SPDK_CU_ASSERT_FATAL(dev->bands != NULL); @@ -61,10 +72,13 @@ test_init_ftl_dev(const struct spdk_ocssd_geometry_data *geo, dev->punits[i].start_ppa.pu = punit / geo->num_grp; } + LIST_INIT(&dev->free_bands); + LIST_INIT(&dev->shut_bands); + return dev; } -static struct ftl_band * +struct ftl_band * test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id) { struct ftl_band *band; @@ -76,6 +90,9 @@ test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id) band = &dev->bands[id]; band->dev = dev; band->id = id; + + band->state = FTL_BAND_STATE_CLOSED; + LIST_INSERT_HEAD(&dev->shut_bands, band, list_entry); CIRCLEQ_INIT(&band->chunks); band->md.vld_map = spdk_bit_array_create(ftl_num_band_lbks(dev)); @@ -99,16 +116,17 @@ test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id) return band; } -static void +void test_free_ftl_dev(struct spdk_ftl_dev *dev) { SPDK_CU_ASSERT_FATAL(dev != NULL); + spdk_thread_exit(dev->core_thread.thread); free(dev->punits); free(dev->bands); free(dev); } -static void +void test_free_ftl_band(struct ftl_band *band) { SPDK_CU_ASSERT_FATAL(band != NULL); @@ -117,7 +135,7 @@ test_free_ftl_band(struct ftl_band *band) free(band->md.lba_map); } -static uint64_t +uint64_t test_offset_from_ppa(struct ftl_ppa ppa, struct ftl_band *band) { struct spdk_ftl_dev *dev = band->dev; diff --git a/test/unit/lib/ftl/ftl_wptr/.gitignore b/test/unit/lib/ftl/ftl_wptr/.gitignore new file mode 100644 index 000000000..8f1f46756 --- /dev/null +++ b/test/unit/lib/ftl/ftl_wptr/.gitignore @@ -0,0 +1 @@ +ftl_wptr_ut diff --git a/test/unit/lib/ftl/ftl_wptr/Makefile b/test/unit/lib/ftl/ftl_wptr/Makefile new file mode 100644 index 000000000..42bf7c602 --- /dev/null +++ b/test/unit/lib/ftl/ftl_wptr/Makefile @@ -0,0 +1,38 @@ +# +# 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)/../../../../..) + +TEST_FILE = ftl_wptr_ut.c + +include $(SPDK_ROOT_DIR)/mk/spdk.unittest.mk diff --git a/test/unit/lib/ftl/ftl_wptr/ftl_wptr_ut.c b/test/unit/lib/ftl/ftl_wptr/ftl_wptr_ut.c new file mode 100644 index 000000000..c1839cbba --- /dev/null +++ b/test/unit/lib/ftl/ftl_wptr/ftl_wptr_ut.c @@ -0,0 +1,219 @@ +/*- + * 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 "spdk_cunit.h" +#include "common/lib/test_env.c" + +#include "ftl/ftl_core.c" +#include "ftl/ftl_band.c" +#include "../common/utils.c" + +static struct spdk_ocssd_geometry_data g_geo = { + .num_grp = 4, + .num_pu = 3, + .num_chk = 20, + .clba = 128, + .ws_opt = 16, + .ws_min = 4, +}; + +static struct spdk_ftl_punit_range g_range = { + .begin = 2, + .end = 9, +}; + +#if defined(DEBUG) +DEFINE_STUB(ftl_band_validate_md, bool, (struct ftl_band *band, const uint64_t *lba_map), true); +#endif +DEFINE_STUB(ftl_io_dec_req, size_t, (struct ftl_io *io), 0); +DEFINE_STUB(ftl_io_inc_req, size_t, (struct ftl_io *io), 0); +DEFINE_STUB_V(ftl_trace_completion, (struct spdk_ftl_dev *dev, const struct ftl_io *io, + enum ftl_trace_completion completion)); +DEFINE_STUB_V(ftl_reloc_add, (struct ftl_reloc *reloc, struct ftl_band *band, size_t offset, + size_t num_lbks, int prio)); +DEFINE_STUB_V(ftl_trace_write_band, (struct spdk_ftl_dev *dev, const struct ftl_band *band)); +DEFINE_STUB_V(ftl_trace_submission, (struct spdk_ftl_dev *dev, const struct ftl_io *io, + struct ftl_ppa ppa, size_t ppa_cnt)); +DEFINE_STUB_V(ftl_rwb_get_limits, (struct ftl_rwb *rwb, size_t limit[FTL_RWB_TYPE_MAX])); +DEFINE_STUB_V(ftl_io_process_error, (struct ftl_io *io, const struct spdk_nvme_cpl *status)); +DEFINE_STUB_V(ftl_trace_limits, (struct spdk_ftl_dev *dev, const size_t *limits, size_t num_free)); +DEFINE_STUB(ftl_rwb_entry_cnt, size_t, (const struct ftl_rwb *rwb), 0); +DEFINE_STUB_V(ftl_rwb_set_limits, (struct ftl_rwb *rwb, const size_t limit[FTL_RWB_TYPE_MAX])); +DEFINE_STUB(spdk_nvme_ocssd_ns_cmd_vector_reset, int, (struct spdk_nvme_ns *ns, + struct spdk_nvme_qpair *qpair, uint64_t *lba_list, uint32_t num_lbas, + struct spdk_ocssd_chunk_information_entry *chunk_info, + spdk_nvme_cmd_cb cb_fn, void *cb_arg), 0); + +struct ftl_io * +ftl_io_erase_init(struct ftl_band *band, size_t lbk_cnt, spdk_ftl_fn cb) +{ + struct ftl_io *io; + + io = calloc(1, sizeof(struct ftl_io)); + SPDK_CU_ASSERT_FATAL(io != NULL); + + io->dev = band->dev; + io->band = band; + io->cb.fn = cb; + io->lbk_cnt = 1; + + return io; +} + +void +ftl_io_complete(struct ftl_io *io) +{ + io->cb.fn(io, 0); + free(io); +} + +static void +setup_wptr_test(struct spdk_ftl_dev **dev, const struct spdk_ocssd_geometry_data *geo, + const struct spdk_ftl_punit_range *range) +{ + size_t i; + struct spdk_ftl_dev *t_dev; + + t_dev = test_init_ftl_dev(geo, range); + + for (i = 0; i < ftl_dev_num_bands(t_dev); ++i) { + test_init_ftl_band(t_dev, i); + t_dev->bands[i].state = FTL_BAND_STATE_CLOSED; + ftl_band_set_state(&t_dev->bands[i], FTL_BAND_STATE_FREE); + } + + *dev = t_dev; +} + +static void +cleanup_wptr_test(struct spdk_ftl_dev *dev) +{ + size_t i; + + for (i = 0; i < ftl_dev_num_bands(dev); ++i) { + test_free_ftl_band(&dev->bands[i]); + } + + test_free_ftl_dev(dev); +} + +static void +test_wptr(void) +{ + struct spdk_ftl_dev *dev; + struct ftl_wptr *wptr; + struct ftl_band *band; + struct ftl_io io = { 0 }; + size_t xfer_size; + size_t chunk, lbk, offset, i; + int rc; + + setup_wptr_test(&dev, &g_geo, &g_range); + + xfer_size = dev->xfer_size; + ftl_add_wptr(dev); + for (i = 0; i < ftl_dev_num_bands(dev); ++i) { + wptr = LIST_FIRST(&dev->wptr_list); + band = wptr->band; + ftl_band_set_state(band, FTL_BAND_STATE_PREP); + ftl_band_set_state(band, FTL_BAND_STATE_OPENING); + ftl_band_set_state(band, FTL_BAND_STATE_OPEN); + io.band = band; + + for (lbk = 0, offset = 0; lbk < ftl_dev_lbks_in_chunk(dev) / xfer_size; ++lbk) { + for (chunk = 0; chunk < band->num_chunks; ++chunk) { + CU_ASSERT_EQUAL(wptr->ppa.lbk, (lbk * xfer_size)); + CU_ASSERT_EQUAL(wptr->offset, offset); + ftl_wptr_advance(wptr, xfer_size); + offset += xfer_size; + } + } + + CU_ASSERT_EQUAL(band->state, FTL_BAND_STATE_FULL); + CU_ASSERT_EQUAL(wptr->ppa.lbk, ftl_dev_lbks_in_chunk(dev)); + + ftl_band_set_state(band, FTL_BAND_STATE_CLOSING); + + /* Call the metadata completion cb to force band state change */ + /* and removal of the actual wptr */ + ftl_md_write_cb(&io, 0); + CU_ASSERT_EQUAL(band->state, FTL_BAND_STATE_CLOSED); + CU_ASSERT_TRUE(LIST_EMPTY(&dev->wptr_list)); + + rc = ftl_add_wptr(dev); + + /* There are no free bands during the last iteration, so */ + /* there'll be no new wptr allocation */ + if (i == (ftl_dev_num_bands(dev) - 1)) { + CU_ASSERT_EQUAL(rc, -1); + } else { + CU_ASSERT_EQUAL(rc, 0); + } + } + + cleanup_wptr_test(dev); +} + +int +main(int argc, char **argv) +{ + CU_pSuite suite = NULL; + unsigned int num_failures; + + if (CU_initialize_registry() != CUE_SUCCESS) { + return CU_get_error(); + } + + suite = CU_add_suite("ftl_wptr_suite", NULL, NULL); + if (!suite) { + CU_cleanup_registry(); + return CU_get_error(); + } + + if ( + CU_add_test(suite, "test_wptr", + test_wptr) == NULL + ) { + CU_cleanup_registry(); + return CU_get_error(); + } + + CU_basic_set_mode(CU_BRM_VERBOSE); + CU_basic_run_tests(); + num_failures = CU_get_number_of_failures(); + CU_cleanup_registry(); + + return num_failures; +} diff --git a/test/unit/unittest.sh b/test/unit/unittest.sh index fc7d025b5..6409885f0 100755 --- a/test/unit/unittest.sh +++ b/test/unit/unittest.sh @@ -148,6 +148,7 @@ $valgrind $testdir/lib/ftl/ftl_rwb.c/ftl_rwb_ut $valgrind $testdir/lib/ftl/ftl_ppa/ftl_ppa_ut $valgrind $testdir/lib/ftl/ftl_band.c/ftl_band_ut $valgrind $testdir/lib/ftl/ftl_reloc.c/ftl_reloc_ut +$valgrind $testdir/lib/ftl/ftl_wptr/ftl_wptr_ut fi # local unit test coverage