xref: /spdk/test/unit/lib/ftl/common/utils.c (revision 12fbe739a31b09aff0d05f354d4f3bbef99afc55)
1  /*   SPDX-License-Identifier: BSD-3-Clause
2   *   Copyright (C) 2018 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  DEFINE_STUB(ftl_nv_cache_device_get_desc_by_bdev, const struct ftl_nv_cache_device_desc *,
29  	    (struct spdk_ftl_dev *dev, struct spdk_bdev *bdev), NULL);
30  
31  uint64_t
32  spdk_bdev_get_zone_size(const struct spdk_bdev *bdev)
33  {
34  	return g_geo.zone_size;
35  }
36  
37  uint32_t
38  spdk_bdev_get_optimal_open_zones(const struct spdk_bdev *bdev)
39  {
40  	return g_geo.optimal_open_zones;
41  }
42  
43  DEFINE_RETURN_MOCK(ftl_mempool_get, void *);
44  void *
45  ftl_mempool_get(struct ftl_mempool *mpool)
46  {
47  	return spdk_mempool_get((struct spdk_mempool *)mpool);
48  }
49  
50  void
51  ftl_mempool_put(struct ftl_mempool *mpool, void *element)
52  {
53  	spdk_mempool_put((struct spdk_mempool *)mpool, element);
54  }
55  
56  ftl_df_obj_id
57  ftl_mempool_get_df_obj_id(struct ftl_mempool *mpool, void *df_obj_ptr)
58  {
59  	return (ftl_df_obj_id)df_obj_ptr;
60  }
61  
62  struct spdk_ftl_dev *
63  test_init_ftl_dev(const struct base_bdev_geometry *geo)
64  {
65  	struct spdk_ftl_dev *dev;
66  
67  	dev = calloc(1, sizeof(*dev));
68  	SPDK_CU_ASSERT_FATAL(dev != NULL);
69  
70  	dev->xfer_size = geo->write_unit_size;
71  	dev->core_thread = spdk_thread_create("unit_test_thread", NULL);
72  	spdk_set_thread(dev->core_thread);
73  	dev->ioch = calloc(1, SPDK_IO_CHANNEL_STRUCT_SIZE
74  			   + sizeof(struct ftl_io_channel *));
75  	dev->num_bands = geo->blockcnt / (geo->zone_size * geo->optimal_open_zones);
76  	dev->bands = calloc(dev->num_bands, sizeof(*dev->bands));
77  	SPDK_CU_ASSERT_FATAL(dev->bands != NULL);
78  
79  	dev->layout.base.total_blocks = UINT64_MAX;
80  
81  	for (size_t i = 0; i < dev->num_bands; i++) {
82  		struct ftl_band_md *md;
83  		int ret;
84  
85  		ret = posix_memalign((void **)&md, FTL_BLOCK_SIZE, sizeof(*md));
86  		SPDK_CU_ASSERT_FATAL(ret == 0);
87  		memset(md, 0, sizeof(*md));
88  		dev->bands[i].md = md;
89  	}
90  
91  	dev->p2l_pool = (struct ftl_mempool *)spdk_mempool_create("ftl_ut", 2, 0x210200,
92  			SPDK_MEMPOOL_DEFAULT_CACHE_SIZE,
93  			SPDK_ENV_SOCKET_ID_ANY);
94  	SPDK_CU_ASSERT_FATAL(dev->p2l_pool != NULL);
95  
96  	TAILQ_INIT(&dev->free_bands);
97  	TAILQ_INIT(&dev->shut_bands);
98  
99  	/* Cache frequently used values */
100  	dev->num_blocks_in_band = ftl_calculate_num_blocks_in_band(dev->base_bdev_desc);
101  	dev->is_zoned = spdk_bdev_is_zoned(spdk_bdev_desc_get_bdev(dev->base_bdev_desc));
102  
103  	return dev;
104  }
105  
106  struct ftl_band *
107  test_init_ftl_band(struct spdk_ftl_dev *dev, size_t id, size_t zone_size)
108  {
109  	struct ftl_band *band;
110  
111  	SPDK_CU_ASSERT_FATAL(dev != NULL);
112  	SPDK_CU_ASSERT_FATAL(id < dev->num_bands);
113  
114  	band = &dev->bands[id];
115  	band->dev = dev;
116  	band->id = id;
117  
118  	band->md->state = FTL_BAND_STATE_CLOSED;
119  	band->md->df_p2l_map = FTL_DF_OBJ_ID_INVALID;
120  	TAILQ_INSERT_HEAD(&dev->shut_bands, band, queue_entry);
121  
122  	band->p2l_map.valid = (struct ftl_bitmap *)spdk_bit_array_create(ftl_get_num_blocks_in_band(dev));
123  	SPDK_CU_ASSERT_FATAL(band->p2l_map.valid != NULL);
124  
125  	band->start_addr = zone_size * id;
126  
127  	return band;
128  }
129  
130  void
131  test_free_ftl_dev(struct spdk_ftl_dev *dev)
132  {
133  	struct spdk_thread *thread;
134  
135  	SPDK_CU_ASSERT_FATAL(dev != NULL);
136  	free(dev->ioch);
137  
138  	thread = dev->core_thread;
139  
140  	spdk_set_thread(thread);
141  	spdk_thread_exit(thread);
142  	while (!spdk_thread_is_exited(thread)) {
143  		spdk_thread_poll(thread, 0, 0);
144  	}
145  	spdk_thread_destroy(thread);
146  	spdk_mempool_free((struct spdk_mempool *)dev->p2l_pool);
147  	for (size_t i = 0; i < dev->num_bands; i++) {
148  		free(dev->bands[i].md);
149  	}
150  	free(dev->bands);
151  	free(dev);
152  }
153  
154  void
155  test_free_ftl_band(struct ftl_band *band)
156  {
157  	SPDK_CU_ASSERT_FATAL(band != NULL);
158  	spdk_bit_array_free((struct spdk_bit_array **)&band->p2l_map.valid);
159  	spdk_dma_free(band->p2l_map.band_dma_md);
160  
161  	band->p2l_map.band_dma_md = NULL;
162  }
163  
164  uint64_t
165  test_offset_from_addr(ftl_addr addr, struct ftl_band *band)
166  {
167  	struct spdk_ftl_dev *dev = band->dev;
168  
169  	CU_ASSERT_EQUAL(ftl_addr_get_band(dev, addr), band->id);
170  
171  	return addr - band->id * ftl_get_num_blocks_in_band(dev);
172  }
173