xref: /spdk/test/unit/lib/ftl/common/utils.c (revision ffa823557a7c4c580cec5fb46c6c424c11b45458)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (c) Intel Corporation.
3  *   All rights reserved.
4  */
5 
6 #include "spdk/ftl.h"
7 #include "ftl/ftl_core.h"
8 
9 #include "ftl/mngt/ftl_mngt_bdev.c"
10 
11 struct base_bdev_geometry {
12 	size_t write_unit_size;
13 	size_t zone_size;
14 	size_t optimal_open_zones;
15 	size_t blockcnt;
16 };
17 
18 extern struct base_bdev_geometry g_geo;
19 
20 struct spdk_ftl_dev *test_init_ftl_dev(const struct base_bdev_geometry *geo);
21 struct ftl_band *test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id, size_t zone_size);
22 void test_free_ftl_dev(struct spdk_ftl_dev *dev);
23 void test_free_ftl_band(struct ftl_band *band);
24 uint64_t test_offset_from_addr(ftl_addr addr, struct ftl_band *band);
25 
26 DEFINE_STUB(spdk_bdev_desc_get_bdev, struct spdk_bdev *, (struct spdk_bdev_desc *desc), NULL);
27 
28 uint64_t
29 spdk_bdev_get_zone_size(const struct spdk_bdev *bdev)
30 {
31 	return g_geo.zone_size;
32 }
33 
34 uint32_t
35 spdk_bdev_get_optimal_open_zones(const struct spdk_bdev *bdev)
36 {
37 	return g_geo.optimal_open_zones;
38 }
39 
40 DEFINE_RETURN_MOCK(ftl_mempool_get, void *);
41 void *
42 ftl_mempool_get(struct ftl_mempool *mpool)
43 {
44 	return spdk_mempool_get((struct spdk_mempool *)mpool);
45 }
46 
47 void
48 ftl_mempool_put(struct ftl_mempool *mpool, void *element)
49 {
50 	spdk_mempool_put((struct spdk_mempool *)mpool, element);
51 }
52 
53 struct spdk_ftl_dev *
54 test_init_ftl_dev(const struct base_bdev_geometry *geo)
55 {
56 	struct spdk_ftl_dev *dev;
57 
58 	dev = calloc(1, sizeof(*dev));
59 	SPDK_CU_ASSERT_FATAL(dev != NULL);
60 
61 	dev->xfer_size = geo->write_unit_size;
62 	dev->core_thread = spdk_thread_create("unit_test_thread", NULL);
63 	spdk_set_thread(dev->core_thread);
64 	dev->ioch = calloc(1, SPDK_IO_CHANNEL_STRUCT_SIZE
65 			   + sizeof(struct ftl_io_channel *));
66 	dev->num_bands = geo->blockcnt / (geo->zone_size * geo->optimal_open_zones);
67 	dev->bands = calloc(dev->num_bands, sizeof(*dev->bands));
68 	SPDK_CU_ASSERT_FATAL(dev->bands != NULL);
69 
70 	dev->layout.base.total_blocks = UINT64_MAX;
71 
72 	for (size_t i = 0; i < dev->num_bands; i++) {
73 		struct ftl_band_md *md;
74 		int ret;
75 
76 		ret = posix_memalign((void **)&md, FTL_BLOCK_SIZE, sizeof(*md));
77 		SPDK_CU_ASSERT_FATAL(ret == 0);
78 		memset(md, 0, sizeof(*md));
79 		dev->bands[i].md = md;
80 	}
81 
82 	dev->p2l_pool = (struct ftl_mempool *)spdk_mempool_create("ftl_ut", 2, 0x210200,
83 			SPDK_MEMPOOL_DEFAULT_CACHE_SIZE,
84 			SPDK_ENV_SOCKET_ID_ANY);
85 	SPDK_CU_ASSERT_FATAL(dev->p2l_pool != NULL);
86 
87 	TAILQ_INIT(&dev->free_bands);
88 	TAILQ_INIT(&dev->shut_bands);
89 
90 	/* Cache frequently used values */
91 	dev->num_blocks_in_band = ftl_calculate_num_blocks_in_band(dev->base_bdev_desc);
92 	dev->is_zoned = spdk_bdev_is_zoned(spdk_bdev_desc_get_bdev(dev->base_bdev_desc));
93 
94 	return dev;
95 }
96 
97 struct ftl_band *
98 test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id, size_t zone_size)
99 {
100 	struct ftl_band *band;
101 
102 	SPDK_CU_ASSERT_FATAL(dev != NULL);
103 	SPDK_CU_ASSERT_FATAL(id < dev->num_bands);
104 
105 	band = &dev->bands[id];
106 	band->dev = dev;
107 	band->id = id;
108 
109 	band->md->state = FTL_BAND_STATE_CLOSED;
110 	TAILQ_INSERT_HEAD(&dev->shut_bands, band, queue_entry);
111 
112 	band->start_addr = zone_size * id;
113 
114 	return band;
115 }
116 
117 void
118 test_free_ftl_dev(struct spdk_ftl_dev *dev)
119 {
120 	struct spdk_thread *thread;
121 
122 	SPDK_CU_ASSERT_FATAL(dev != NULL);
123 	free(dev->ioch);
124 
125 	thread = dev->core_thread;
126 
127 	spdk_set_thread(thread);
128 	spdk_thread_exit(thread);
129 	while (!spdk_thread_is_exited(thread)) {
130 		spdk_thread_poll(thread, 0, 0);
131 	}
132 	spdk_thread_destroy(thread);
133 	spdk_mempool_free((struct spdk_mempool *)dev->p2l_pool);
134 	for (size_t i = 0; i < dev->num_bands; i++) {
135 		free(dev->bands[i].md);
136 	}
137 	free(dev->bands);
138 	free(dev);
139 }
140 
141 void
142 test_free_ftl_band(struct ftl_band *band)
143 {
144 	SPDK_CU_ASSERT_FATAL(band != NULL);
145 	spdk_dma_free(band->p2l_map.band_dma_md);
146 
147 	band->p2l_map.band_dma_md = NULL;
148 }
149 
150 uint64_t
151 test_offset_from_addr(ftl_addr addr, struct ftl_band *band)
152 {
153 	struct spdk_ftl_dev *dev = band->dev;
154 
155 	CU_ASSERT_EQUAL(ftl_addr_get_band(dev, addr), band->id);
156 
157 	return addr - band->id * ftl_get_num_blocks_in_band(dev);
158 }
159