Many open source projects have moved to using SPDX identifiers to specify license information, reducing the amount of boilerplate code in every source file. This patch replaces the bulk of SPDK .c, .cpp and Makefiles with the BSD-3-Clause identifier. Almost all of these files share the exact same license text, and this patch only modifies the files that contain the most common license text. There can be slight variations because the third clause contains company names - most say "Intel Corporation", but there are instances for Nvidia, Samsung, Eideticom and even "the copyright holder". Used a bash script to automate replacement of the license text with SPDX identifier which is checked into scripts/spdx.sh. Signed-off-by: Jim Harris <james.r.harris@intel.com> Change-Id: Iaa88ab5e92ea471691dc298cfe41ebfb5d169780 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/12904 Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com> Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Aleksey Marchuk <alexeymar@nvidia.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Dong Yi <dongx.yi@intel.com> Reviewed-by: Konrad Sztyber <konrad.sztyber@intel.com> Reviewed-by: Paul Luse <paul.e.luse@intel.com> Reviewed-by: <qun.wan@intel.com>
366 lines
13 KiB
C
366 lines
13 KiB
C
/* SPDX-License-Identifier: BSD-3-Clause
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*/
|
|
|
|
#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"
|
|
|
|
#define TEST_BAND_IDX 68
|
|
#define TEST_LBA 0x68676564
|
|
|
|
struct base_bdev_geometry g_geo = {
|
|
.write_unit_size = 16,
|
|
.optimal_open_zones = 9,
|
|
.zone_size = 100,
|
|
.blockcnt = 1500 * 100 * 8,
|
|
};
|
|
|
|
static struct spdk_ftl_dev *g_dev;
|
|
static struct ftl_band *g_band;
|
|
|
|
#if defined(DEBUG)
|
|
DEFINE_STUB(ftl_band_validate_md, bool, (struct ftl_band *band), true);
|
|
DEFINE_STUB_V(ftl_trace_limits, (struct spdk_ftl_dev *dev, int limit, size_t num_free));
|
|
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_trace_defrag_band, (struct spdk_ftl_dev *dev, const struct ftl_band *band));
|
|
DEFINE_STUB_V(ftl_trace_wbuf_fill, (struct spdk_ftl_dev *dev, const struct ftl_io *io));
|
|
DEFINE_STUB_V(ftl_trace_wbuf_pop, (struct spdk_ftl_dev *dev, const struct ftl_wbuf_entry *entry));
|
|
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_addr addr, size_t addr_cnt));
|
|
#endif
|
|
DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *bdev_io));
|
|
DEFINE_STUB(spdk_bdev_get_block_size, uint32_t, (const struct spdk_bdev *bdev), 512);
|
|
DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), "test");
|
|
DEFINE_STUB(spdk_bdev_get_num_blocks, uint64_t, (const struct spdk_bdev *bdev), 0);
|
|
DEFINE_STUB(spdk_bdev_get_media_events, size_t,
|
|
(struct spdk_bdev_desc *bdev_desc, struct spdk_bdev_media_event *events,
|
|
size_t max_events), 0);
|
|
DEFINE_STUB(spdk_bdev_get_md_size, uint32_t, (const struct spdk_bdev *bdev), 8);
|
|
DEFINE_STUB(spdk_bdev_io_get_append_location, uint64_t, (struct spdk_bdev_io *bdev_io), 0);
|
|
DEFINE_STUB(spdk_bdev_write_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
|
|
void *buf, uint64_t offset_blocks, uint64_t num_blocks, spdk_bdev_io_completion_cb cb,
|
|
void *cb_arg), 0);
|
|
DEFINE_STUB(spdk_bdev_write_blocks_with_md, int, (struct spdk_bdev_desc *desc,
|
|
struct spdk_io_channel *ch, void *buf, void *md, uint64_t offset_blocks,
|
|
uint64_t num_blocks, spdk_bdev_io_completion_cb cb, void *cb_arg), 0);
|
|
DEFINE_STUB(spdk_bdev_read_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
|
|
void *buf, uint64_t offset_blocks, uint64_t num_blocks,
|
|
spdk_bdev_io_completion_cb cb, void *cb_arg), 0);
|
|
DEFINE_STUB(spdk_bdev_write_zeroes_blocks, int,
|
|
(struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
|
|
uint64_t offset_blocks, uint64_t num_blocks,
|
|
spdk_bdev_io_completion_cb cb, void *cb_arg), 0);
|
|
DEFINE_STUB(spdk_bdev_writev_blocks, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
|
|
struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks,
|
|
spdk_bdev_io_completion_cb cb, void *cb_arg), 0);
|
|
DEFINE_STUB(spdk_bdev_zone_appendv, int, (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch,
|
|
struct iovec *iov, int iovcnt, uint64_t zone_id, uint64_t num_blocks,
|
|
spdk_bdev_io_completion_cb cb, void *cb_arg), 0);
|
|
DEFINE_STUB(spdk_bdev_zone_management, int, (struct spdk_bdev_desc *desc,
|
|
struct spdk_io_channel *ch,
|
|
uint64_t zone_id, enum spdk_bdev_zone_action action,
|
|
spdk_bdev_io_completion_cb cb, void *cb_arg), 0);
|
|
|
|
DEFINE_STUB_V(ftl_io_advance, (struct ftl_io *io, size_t num_blocks));
|
|
DEFINE_STUB_V(ftl_io_call_foreach_child,
|
|
(struct ftl_io *io, int (*callback)(struct ftl_io *)));
|
|
DEFINE_STUB(ftl_io_channel_get_ctx, struct ftl_io_channel *,
|
|
(struct spdk_io_channel *ioch), NULL);
|
|
DEFINE_STUB_V(ftl_io_complete, (struct ftl_io *io));
|
|
DEFINE_STUB(ftl_io_current_lba, uint64_t, (const struct ftl_io *io), 0);
|
|
DEFINE_STUB_V(ftl_io_dec_req, (struct ftl_io *io));
|
|
DEFINE_STUB(ftl_io_erase_init, struct ftl_io *,
|
|
(struct ftl_band *band, size_t num_blocks, ftl_io_fn cb), NULL);
|
|
DEFINE_STUB_V(ftl_io_fail, (struct ftl_io *io, int status));
|
|
DEFINE_STUB_V(ftl_io_free, (struct ftl_io *io));
|
|
DEFINE_STUB(ftl_io_get_lba, uint64_t,
|
|
(const struct ftl_io *io, size_t offset), 0);
|
|
DEFINE_STUB_V(ftl_io_inc_req, (struct ftl_io *io));
|
|
DEFINE_STUB(ftl_io_init_internal, struct ftl_io *,
|
|
(const struct ftl_io_init_opts *opts), NULL);
|
|
DEFINE_STUB_V(ftl_io_reset, (struct ftl_io *io));
|
|
DEFINE_STUB(ftl_io_iovec_addr, void *, (struct ftl_io *io), NULL);
|
|
DEFINE_STUB(ftl_io_iovec_len_left, size_t, (struct ftl_io *io), 0);
|
|
DEFINE_STUB_V(ftl_io_shrink_iovec, (struct ftl_io *io, size_t num_blocks));
|
|
DEFINE_STUB(ftl_io_wbuf_init, struct ftl_io *,
|
|
(struct spdk_ftl_dev *dev, struct ftl_addr addr,
|
|
struct ftl_band *band, struct ftl_batch *batch, ftl_io_fn cb), NULL);
|
|
DEFINE_STUB(ftl_io_user_init, struct ftl_io *,
|
|
(struct spdk_io_channel *ioch, uint64_t lba, size_t num_blocks,
|
|
struct iovec *iov, size_t iov_cnt, spdk_ftl_fn cb_fn,
|
|
void *cb_arg, int type), NULL);
|
|
|
|
DEFINE_STUB(ftl_iovec_num_blocks, size_t,
|
|
(struct iovec *iov, size_t iov_cnt), 0);
|
|
DEFINE_STUB(ftl_reloc, bool, (struct ftl_reloc *reloc), false);
|
|
DEFINE_STUB_V(ftl_reloc_add, (struct ftl_reloc *reloc, struct ftl_band *band, size_t offset,
|
|
size_t num_blocks, int prio, bool defrag));
|
|
DEFINE_STUB(ftl_reloc_is_defrag_active, bool, (const struct ftl_reloc *reloc), false);
|
|
DEFINE_STUB(ftl_reloc_is_halted, bool, (const struct ftl_reloc *reloc), false);
|
|
|
|
#ifdef SPDK_CONFIG_PMDK
|
|
DEFINE_STUB_V(pmem_persist, (const void *addr, size_t len));
|
|
#endif
|
|
|
|
static void
|
|
setup_band(void)
|
|
{
|
|
int rc;
|
|
|
|
g_dev = test_init_ftl_dev(&g_geo);
|
|
g_band = test_init_ftl_band(g_dev, TEST_BAND_IDX, g_geo.zone_size);
|
|
rc = ftl_band_alloc_lba_map(g_band);
|
|
CU_ASSERT_EQUAL_FATAL(rc, 0);
|
|
}
|
|
|
|
static void
|
|
cleanup_band(void)
|
|
{
|
|
test_free_ftl_band(g_band);
|
|
test_free_ftl_dev(g_dev);
|
|
}
|
|
|
|
static struct ftl_addr
|
|
addr_from_punit(uint64_t punit)
|
|
{
|
|
struct ftl_addr addr = {};
|
|
|
|
addr.offset = punit * g_geo.zone_size;
|
|
return addr;
|
|
}
|
|
|
|
static void
|
|
test_band_block_offset_from_addr_base(void)
|
|
{
|
|
struct ftl_addr addr;
|
|
uint64_t offset, i, flat_lun = 0;
|
|
|
|
setup_band();
|
|
for (i = 0; i < ftl_get_num_punits(g_dev); ++i) {
|
|
addr = addr_from_punit(i);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
|
|
offset = ftl_band_block_offset_from_addr(g_band, addr);
|
|
CU_ASSERT_EQUAL(offset, flat_lun * ftl_get_num_blocks_in_zone(g_dev));
|
|
flat_lun++;
|
|
}
|
|
cleanup_band();
|
|
}
|
|
|
|
static void
|
|
test_band_block_offset_from_addr_offset(void)
|
|
{
|
|
struct ftl_addr addr;
|
|
uint64_t offset, expect, i, j;
|
|
|
|
setup_band();
|
|
for (i = 0; i < ftl_get_num_punits(g_dev); ++i) {
|
|
for (j = 0; j < g_geo.zone_size; ++j) {
|
|
addr = addr_from_punit(i);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + j;
|
|
|
|
offset = ftl_band_block_offset_from_addr(g_band, addr);
|
|
|
|
expect = test_offset_from_addr(addr, g_band);
|
|
CU_ASSERT_EQUAL(offset, expect);
|
|
}
|
|
}
|
|
cleanup_band();
|
|
}
|
|
|
|
static void
|
|
test_band_addr_from_block_offset(void)
|
|
{
|
|
struct ftl_addr addr, expect;
|
|
uint64_t offset, i, j;
|
|
|
|
setup_band();
|
|
for (i = 0; i < ftl_get_num_punits(g_dev); ++i) {
|
|
for (j = 0; j < g_geo.zone_size; ++j) {
|
|
expect = addr_from_punit(i);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + j;
|
|
|
|
offset = ftl_band_block_offset_from_addr(g_band, expect);
|
|
addr = ftl_band_addr_from_block_offset(g_band, offset);
|
|
|
|
CU_ASSERT_EQUAL(addr.offset, expect.offset);
|
|
}
|
|
}
|
|
cleanup_band();
|
|
}
|
|
|
|
static void
|
|
test_band_set_addr(void)
|
|
{
|
|
struct ftl_lba_map *lba_map;
|
|
struct ftl_addr addr;
|
|
uint64_t offset = 0;
|
|
|
|
setup_band();
|
|
lba_map = &g_band->lba_map;
|
|
addr = addr_from_punit(0);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 0);
|
|
|
|
offset = test_offset_from_addr(addr, g_band);
|
|
|
|
ftl_band_set_addr(g_band, TEST_LBA, addr);
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 1);
|
|
CU_ASSERT_EQUAL(lba_map->map[offset], TEST_LBA);
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset));
|
|
|
|
addr.offset += g_geo.zone_size;
|
|
offset = test_offset_from_addr(addr, g_band);
|
|
ftl_band_set_addr(g_band, TEST_LBA + 1, addr);
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 2);
|
|
CU_ASSERT_EQUAL(lba_map->map[offset], TEST_LBA + 1);
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset));
|
|
addr.offset -= g_geo.zone_size;
|
|
offset = test_offset_from_addr(addr, g_band);
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset));
|
|
cleanup_band();
|
|
}
|
|
|
|
static void
|
|
test_invalidate_addr(void)
|
|
{
|
|
struct ftl_lba_map *lba_map;
|
|
struct ftl_addr addr;
|
|
uint64_t offset[2];
|
|
|
|
setup_band();
|
|
lba_map = &g_band->lba_map;
|
|
addr = addr_from_punit(0);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
offset[0] = test_offset_from_addr(addr, g_band);
|
|
|
|
ftl_band_set_addr(g_band, TEST_LBA, addr);
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 1);
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset[0]));
|
|
ftl_invalidate_addr(g_band->dev, addr);
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 0);
|
|
CU_ASSERT_FALSE(spdk_bit_array_get(lba_map->vld, offset[0]));
|
|
|
|
offset[0] = test_offset_from_addr(addr, g_band);
|
|
ftl_band_set_addr(g_band, TEST_LBA, addr);
|
|
addr.offset += g_geo.zone_size;
|
|
offset[1] = test_offset_from_addr(addr, g_band);
|
|
ftl_band_set_addr(g_band, TEST_LBA + 1, addr);
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 2);
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset[0]));
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset[1]));
|
|
ftl_invalidate_addr(g_band->dev, addr);
|
|
CU_ASSERT_EQUAL(lba_map->num_vld, 1);
|
|
CU_ASSERT_TRUE(spdk_bit_array_get(lba_map->vld, offset[0]));
|
|
CU_ASSERT_FALSE(spdk_bit_array_get(lba_map->vld, offset[1]));
|
|
cleanup_band();
|
|
}
|
|
|
|
static void
|
|
test_next_xfer_addr(void)
|
|
{
|
|
struct ftl_addr addr, result, expect;
|
|
|
|
setup_band();
|
|
/* Verify simple one block increment */
|
|
addr = addr_from_punit(0);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
expect = addr;
|
|
expect.offset += 1;
|
|
|
|
result = ftl_band_next_xfer_addr(g_band, addr, 1);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
|
|
/* Verify jumping between zones */
|
|
expect = addr_from_punit(1);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
result = ftl_band_next_xfer_addr(g_band, addr, g_dev->xfer_size);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
|
|
/* Verify jumping works with unaligned offsets */
|
|
expect = addr_from_punit(1);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + 3;
|
|
result = ftl_band_next_xfer_addr(g_band, addr, g_dev->xfer_size + 3);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
|
|
/* Verify jumping from last zone to the first one */
|
|
expect = addr_from_punit(0);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev) + g_dev->xfer_size;
|
|
addr = addr_from_punit(ftl_get_num_punits(g_dev) - 1);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
result = ftl_band_next_xfer_addr(g_band, addr, g_dev->xfer_size);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
|
|
/* Verify jumping from last zone to the first one with unaligned offset */
|
|
expect = addr_from_punit(0);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
expect.offset += g_dev->xfer_size + 2;
|
|
addr = addr_from_punit(ftl_get_num_punits(g_dev) - 1);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
result = ftl_band_next_xfer_addr(g_band, addr, g_dev->xfer_size + 2);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
|
|
/* Verify large offset spanning across the whole band multiple times */
|
|
expect = addr_from_punit(0);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
expect.offset += g_dev->xfer_size * 5 + 4;
|
|
addr = addr_from_punit(0);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
addr.offset += g_dev->xfer_size * 2 + 1;
|
|
result = ftl_band_next_xfer_addr(g_band, addr, 3 * g_dev->xfer_size *
|
|
ftl_get_num_punits(g_dev) + 3);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
|
|
/* Remove one zone and verify it's skipped properly */
|
|
g_band->zone_buf[1].info.state = SPDK_BDEV_ZONE_STATE_OFFLINE;
|
|
CIRCLEQ_REMOVE(&g_band->zones, &g_band->zone_buf[1], circleq);
|
|
g_band->num_zones--;
|
|
expect = addr_from_punit(2);
|
|
expect.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
expect.offset += g_dev->xfer_size * 5 + 4;
|
|
addr = addr_from_punit(0);
|
|
addr.offset += TEST_BAND_IDX * ftl_get_num_blocks_in_band(g_dev);
|
|
addr.offset += g_dev->xfer_size * 2 + 1;
|
|
result = ftl_band_next_xfer_addr(g_band, addr, 3 * g_dev->xfer_size *
|
|
(ftl_get_num_punits(g_dev) - 1) + g_dev->xfer_size + 3);
|
|
CU_ASSERT_EQUAL(result.offset, expect.offset);
|
|
cleanup_band();
|
|
}
|
|
|
|
int
|
|
main(int argc, char **argv)
|
|
{
|
|
CU_pSuite suite = NULL;
|
|
unsigned int num_failures;
|
|
|
|
CU_set_error_action(CUEA_ABORT);
|
|
CU_initialize_registry();
|
|
|
|
suite = CU_add_suite("ftl_band_suite", NULL, NULL);
|
|
|
|
|
|
CU_ADD_TEST(suite, test_band_block_offset_from_addr_base);
|
|
CU_ADD_TEST(suite, test_band_block_offset_from_addr_offset);
|
|
CU_ADD_TEST(suite, test_band_addr_from_block_offset);
|
|
CU_ADD_TEST(suite, test_band_set_addr);
|
|
CU_ADD_TEST(suite, test_invalidate_addr);
|
|
CU_ADD_TEST(suite, test_next_xfer_addr);
|
|
|
|
CU_basic_set_mode(CU_BRM_VERBOSE);
|
|
CU_basic_run_tests();
|
|
num_failures = CU_get_number_of_failures();
|
|
CU_cleanup_registry();
|
|
|
|
return num_failures;
|
|
}
|