xref: /spdk/lib/ftl/mngt/ftl_mngt_misc.c (revision 510f4c134a21b45ff3a5add9ebc6c6cf7e49aeab)
1 /*   SPDX-License-Identifier: BSD-3-Clause
2  *   Copyright (c) Intel Corporation.
3  *   All rights reserved.
4  */
5 
6 #include "ftl_core.h"
7 #include "ftl_utils.h"
8 #include "ftl_mngt.h"
9 #include "ftl_mngt_steps.h"
10 #include "ftl_band.h"
11 #include "ftl_internal.h"
12 #include "ftl_nv_cache.h"
13 #include "ftl_debug.h"
14 
15 void
16 ftl_mngt_check_conf(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
17 {
18 	if (ftl_conf_is_valid(&dev->conf)) {
19 		ftl_mngt_next_step(mngt);
20 	} else {
21 		ftl_mngt_fail_step(mngt);
22 	}
23 }
24 
25 static int
26 init_p2l_map_pool(struct spdk_ftl_dev *dev)
27 {
28 	size_t p2l_pool_el_blks = spdk_divide_round_up(ftl_p2l_map_pool_elem_size(dev), FTL_BLOCK_SIZE);
29 	size_t p2l_pool_buf_blks = P2L_MEMPOOL_SIZE * p2l_pool_el_blks;
30 	void *p2l_pool_buf;
31 
32 	dev->p2l_pool_md = ftl_md_create(dev, p2l_pool_buf_blks, 0, "p2l_pool",
33 					 ftl_md_create_shm_flags(dev), NULL);
34 	if (!dev->p2l_pool_md) {
35 		return -ENOMEM;
36 	}
37 
38 	p2l_pool_buf = ftl_md_get_buffer(dev->p2l_pool_md);
39 	dev->p2l_pool = ftl_mempool_create_ext(p2l_pool_buf, P2L_MEMPOOL_SIZE,
40 					       p2l_pool_el_blks * FTL_BLOCK_SIZE,
41 					       FTL_BLOCK_SIZE);
42 	if (!dev->p2l_pool) {
43 		return -ENOMEM;
44 	}
45 
46 	if (!ftl_fast_startup(dev)) {
47 		ftl_mempool_initialize_ext(dev->p2l_pool);
48 	}
49 
50 	return 0;
51 }
52 
53 static int
54 init_band_md_pool(struct spdk_ftl_dev *dev)
55 {
56 	dev->band_md_pool = ftl_mempool_create(P2L_MEMPOOL_SIZE,
57 					       sizeof(struct ftl_band_md),
58 					       FTL_BLOCK_SIZE,
59 					       SPDK_ENV_SOCKET_ID_ANY);
60 	if (!dev->band_md_pool) {
61 		return -ENOMEM;
62 	}
63 
64 	return 0;
65 }
66 
67 void
68 ftl_mngt_init_mem_pools(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
69 {
70 	if (init_p2l_map_pool(dev)) {
71 		ftl_mngt_fail_step(mngt);
72 	}
73 
74 	if (init_band_md_pool(dev)) {
75 		ftl_mngt_fail_step(mngt);
76 	}
77 
78 	ftl_mngt_next_step(mngt);
79 }
80 
81 void
82 ftl_mngt_deinit_mem_pools(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
83 {
84 	if (dev->p2l_pool) {
85 		ftl_mempool_destroy_ext(dev->p2l_pool);
86 		dev->p2l_pool = NULL;
87 	}
88 
89 	if (dev->p2l_pool_md) {
90 		ftl_md_destroy(dev->p2l_pool_md, ftl_md_destroy_shm_flags(dev));
91 		dev->p2l_pool_md = NULL;
92 	}
93 
94 	if (dev->band_md_pool) {
95 		ftl_mempool_destroy(dev->band_md_pool);
96 		dev->band_md_pool = NULL;
97 	}
98 
99 	ftl_mngt_next_step(mngt);
100 }
101 
102 void
103 ftl_mngt_init_reloc(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
104 {
105 	dev->reloc = ftl_reloc_init(dev);
106 	if (!dev->reloc) {
107 		FTL_ERRLOG(dev, "Unable to initialize reloc structures\n");
108 		ftl_mngt_fail_step(mngt);
109 		return;
110 	}
111 
112 	ftl_mngt_next_step(mngt);
113 }
114 
115 void
116 ftl_mngt_deinit_reloc(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
117 {
118 	ftl_reloc_free(dev->reloc);
119 	ftl_mngt_next_step(mngt);
120 }
121 
122 void
123 ftl_mngt_init_nv_cache(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
124 {
125 	if (ftl_nv_cache_init(dev)) {
126 		FTL_ERRLOG(dev, "Unable to initialize persistent cache\n");
127 		ftl_mngt_fail_step(mngt);
128 		return;
129 	}
130 
131 	ftl_mngt_next_step(mngt);
132 }
133 
134 void
135 ftl_mngt_deinit_nv_cache(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
136 {
137 	ftl_nv_cache_deinit(dev);
138 	ftl_mngt_next_step(mngt);
139 }
140 
141 static void
142 user_clear_cb(struct spdk_ftl_dev *dev, struct ftl_md *md, int status)
143 {
144 	struct ftl_mngt_process *mngt = md->owner.cb_ctx;
145 
146 	if (status) {
147 		FTL_ERRLOG(ftl_mngt_get_dev(mngt), "FTL NV Cache: ERROR of clearing user cache data\n");
148 		ftl_mngt_fail_step(mngt);
149 	} else {
150 		ftl_mngt_next_step(mngt);
151 	}
152 }
153 
154 void
155 ftl_mngt_scrub_nv_cache(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
156 {
157 	struct ftl_layout_region *region = &dev->layout.region[FTL_LAYOUT_REGION_TYPE_DATA_NVC];
158 	struct ftl_md *md = dev->layout.md[FTL_LAYOUT_REGION_TYPE_DATA_NVC];
159 	union ftl_md_vss vss;
160 
161 	FTL_NOTICELOG(dev, "First startup needs to scrub nv cache data region, this may take some time.\n");
162 	FTL_NOTICELOG(dev, "Scrubbing %lluGiB\n", region->current.blocks * FTL_BLOCK_SIZE / GiB);
163 
164 	/* Need to scrub user data, so in case of dirty shutdown the recovery won't
165 	 * pull in data during open chunks recovery from any previous instance
166 	 */
167 	md->cb = user_clear_cb;
168 	md->owner.cb_ctx = mngt;
169 
170 	vss.version.md_version = region->current.version;
171 	vss.nv_cache.lba = FTL_ADDR_INVALID;
172 	ftl_md_clear(md, 0, &vss);
173 }
174 
175 void
176 ftl_mngt_finalize_startup(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
177 {
178 	dev->initialized = 1;
179 	dev->sb_shm->shm_ready = true;
180 
181 	ftl_reloc_resume(dev->reloc);
182 	ftl_writer_resume(&dev->writer_user);
183 	ftl_writer_resume(&dev->writer_gc);
184 	ftl_nv_cache_resume(&dev->nv_cache);
185 
186 	ftl_mngt_next_step(mngt);
187 }
188 
189 void
190 ftl_mngt_start_core_poller(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
191 {
192 	dev->core_poller = SPDK_POLLER_REGISTER(ftl_core_poller, dev, 0);
193 	if (!dev->core_poller) {
194 		FTL_ERRLOG(dev, "Unable to register core poller\n");
195 		ftl_mngt_fail_step(mngt);
196 		return;
197 	}
198 
199 	ftl_mngt_next_step(mngt);
200 }
201 
202 void
203 ftl_mngt_stop_core_poller(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
204 {
205 	dev->halt = true;
206 
207 	if (dev->core_poller) {
208 		ftl_mngt_continue_step(mngt);
209 	} else {
210 		ftl_mngt_next_step(mngt);
211 	}
212 }
213 
214 void
215 ftl_mngt_dump_stats(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
216 {
217 	ftl_dev_dump_bands(dev);
218 	ftl_dev_dump_stats(dev);
219 	ftl_mngt_next_step(mngt);
220 }
221 
222 void
223 ftl_mngt_init_vld_map(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
224 {
225 	struct ftl_md *valid_map_md = dev->layout.md[FTL_LAYOUT_REGION_TYPE_VALID_MAP];
226 
227 	dev->valid_map = ftl_bitmap_create(ftl_md_get_buffer(valid_map_md),
228 					   ftl_md_get_buffer_size(valid_map_md));
229 	if (!dev->valid_map) {
230 		FTL_ERRLOG(dev, "Failed to create valid map\n");
231 		ftl_mngt_fail_step(mngt);
232 		return;
233 	}
234 
235 	ftl_mngt_next_step(mngt);
236 }
237 
238 void
239 ftl_mngt_deinit_vld_map(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
240 {
241 	if (dev->valid_map) {
242 		ftl_bitmap_destroy(dev->valid_map);
243 		dev->valid_map = NULL;
244 	}
245 
246 	ftl_mngt_next_step(mngt);
247 }
248