xref: /spdk/lib/ftl/mngt/ftl_mngt_startup.c (revision d33497d3f4a2b8f96e5764a91b516ba7ba11e316)
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_mngt.h"
8 #include "ftl_mngt_steps.h"
9 
10 static const struct ftl_mngt_process_desc desc_startup;
11 static const struct ftl_mngt_process_desc desc_first_start;
12 
13 static void
14 ftl_mngt_select_startup_mode(struct spdk_ftl_dev *dev,
15 			     struct ftl_mngt_process *mngt)
16 {
17 	if (dev->conf.mode & SPDK_FTL_MODE_CREATE) {
18 		ftl_mngt_call_process(mngt, &desc_first_start);
19 	} else {
20 		ftl_mngt_fail_step(mngt);
21 	}
22 }
23 
24 /*
25  * Common startup steps required by FTL in all cases (creation, load, dirty shutdown recovery).
26  * Includes actions like opening the devices, calculating the expected size and version of metadata, etc.
27  */
28 static const struct ftl_mngt_process_desc desc_startup = {
29 	.name = "FTL startup",
30 	.steps = {
31 		{
32 			.name = "Check configuration",
33 			.action = ftl_mngt_check_conf,
34 		},
35 		{
36 			.name = "Open base bdev",
37 			.action = ftl_mngt_open_base_bdev,
38 			.cleanup = ftl_mngt_close_base_bdev
39 		},
40 		{
41 			.name = "Open cache bdev",
42 			.action = ftl_mngt_open_cache_bdev,
43 			.cleanup = ftl_mngt_close_cache_bdev
44 		},
45 #ifdef SPDK_FTL_VSS_EMU
46 		{
47 			.name = "Initialize VSS emu",
48 			.action = ftl_mngt_md_init_vss_emu,
49 			.cleanup = ftl_mngt_md_deinit_vss_emu
50 		},
51 #endif
52 		{
53 			.name = "Initialize superblock",
54 			.action = ftl_mngt_superblock_init,
55 			.cleanup = ftl_mngt_superblock_deinit
56 		},
57 		{
58 			.name = "Register IO device",
59 			.action = ftl_mngt_register_io_device,
60 			.cleanup = ftl_mngt_unregister_io_device
61 		},
62 		{
63 			.name = "Initialize core IO channel",
64 			.action = ftl_mngt_init_io_channel,
65 			.cleanup = ftl_mngt_deinit_io_channel
66 		},
67 		{
68 			.name = "Initialize layout",
69 			.action = ftl_mngt_init_layout
70 		},
71 		{
72 			.name = "Initialize metadata",
73 			.action = ftl_mngt_init_md,
74 			.cleanup = ftl_mngt_deinit_md
75 		},
76 		{
77 			.name = "Select startup mode",
78 			.action = ftl_mngt_select_startup_mode
79 		},
80 		{}
81 	}
82 };
83 
84 /*
85  * Steps executed when creating FTL for the first time - most important being scrubbing
86  * old data/metadata (so it's not leaked during dirty shutdown recovery) and laying out
87  * regions for the new metadata (initializing band states, etc).
88  */
89 static const struct ftl_mngt_process_desc desc_first_start = {
90 	.name = "FTL first start",
91 	.steps = {
92 		{
93 			.name = "Scrub NV cache",
94 			.action = ftl_mngt_scrub_nv_cache,
95 		},
96 		{
97 			.name = "Set FTL dirty state",
98 			.action = ftl_mngt_set_dirty,
99 		},
100 		{
101 			.name = "Start core poller",
102 			.action = ftl_mngt_start_core_poller,
103 			.cleanup = ftl_mngt_stop_core_poller
104 		},
105 		{
106 			.name = "Finalize initialization",
107 			.action = ftl_mngt_finalize_startup,
108 		},
109 		{}
110 	}
111 };
112 
113 int
114 ftl_mngt_call_dev_startup(struct spdk_ftl_dev *dev, ftl_mngt_completion cb, void *cb_cntx)
115 {
116 	return ftl_mngt_process_execute(dev, &desc_startup, cb, cb_cntx);
117 }
118 
119 void
120 ftl_mngt_rollback_device(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt)
121 {
122 	ftl_mngt_call_process_rollback(mngt, &desc_startup);
123 }
124