1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk/bdev_module.h" 7 #include "spdk/ftl.h" 8 9 #include "ftl_nv_cache.h" 10 #include "ftl_internal.h" 11 #include "ftl_mngt_steps.h" 12 #include "ftl_internal.h" 13 #include "ftl_core.h" 14 #include "utils/ftl_defs.h" 15 16 #define MINIMUM_CACHE_SIZE_GIB 5 17 #define MINIMUM_BASE_SIZE_GIB 20 18 19 /* Dummy bdev module used to to claim bdevs. */ 20 static struct spdk_bdev_module g_ftl_bdev_module = { 21 .name = "ftl_lib", 22 }; 23 24 static inline uint64_t 25 ftl_calculate_num_blocks_in_band(struct spdk_bdev_desc *desc) 26 { 27 /* TODO: this should be passed via input parameter */ 28 #ifdef SPDK_FTL_ZONE_EMU_BLOCKS 29 return SPDK_FTL_ZONE_EMU_BLOCKS; 30 #else 31 return (1ULL << 30) / FTL_BLOCK_SIZE; 32 #endif 33 } 34 35 static void 36 base_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 37 { 38 switch (type) { 39 case SPDK_BDEV_EVENT_REMOVE: 40 assert(0); 41 break; 42 default: 43 break; 44 } 45 } 46 47 void 48 ftl_mngt_open_base_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 49 { 50 uint32_t block_size; 51 uint64_t num_blocks; 52 const char *bdev_name = dev->conf.base_bdev; 53 struct spdk_bdev *bdev; 54 55 if (spdk_bdev_open_ext(bdev_name, true, base_bdev_event_cb, 56 dev, &dev->base_bdev_desc)) { 57 FTL_ERRLOG(dev, "Unable to open bdev: %s\n", bdev_name); 58 goto error; 59 } 60 61 bdev = spdk_bdev_desc_get_bdev(dev->base_bdev_desc); 62 63 if (spdk_bdev_module_claim_bdev(bdev, dev->base_bdev_desc, &g_ftl_bdev_module)) { 64 /* clear the desc so that we don't try to release the claim on cleanup */ 65 spdk_bdev_close(dev->base_bdev_desc); 66 dev->base_bdev_desc = NULL; 67 FTL_ERRLOG(dev, "Unable to claim bdev %s\n", bdev_name); 68 goto error; 69 } 70 71 block_size = spdk_bdev_get_block_size(bdev); 72 if (block_size != FTL_BLOCK_SIZE) { 73 FTL_ERRLOG(dev, "Unsupported block size (%"PRIu32")\n", block_size); 74 goto error; 75 } 76 77 num_blocks = spdk_bdev_get_num_blocks(bdev); 78 79 if (num_blocks * block_size < MINIMUM_BASE_SIZE_GIB * GiB) { 80 FTL_ERRLOG(dev, "Bdev %s is too small, requires, at least %uGiB capacity\n", 81 spdk_bdev_get_name(bdev), MINIMUM_BASE_SIZE_GIB); 82 goto error; 83 } 84 85 dev->base_ioch = spdk_bdev_get_io_channel(dev->base_bdev_desc); 86 if (!dev->base_ioch) { 87 FTL_ERRLOG(dev, "Failed to create base bdev IO channel\n"); 88 goto error; 89 } 90 91 dev->xfer_size = ftl_get_write_unit_size(bdev); 92 93 /* TODO: validate size when base device VSS usage gets added */ 94 dev->md_size = spdk_bdev_get_md_size(bdev); 95 96 /* Cache frequently used values */ 97 dev->num_blocks_in_band = ftl_calculate_num_blocks_in_band(dev->base_bdev_desc); 98 dev->is_zoned = spdk_bdev_is_zoned(spdk_bdev_desc_get_bdev(dev->base_bdev_desc)); 99 100 if (dev->is_zoned) { 101 /* TODO - current FTL code isn't fully compatible with ZNS drives */ 102 FTL_ERRLOG(dev, "Creating FTL on Zoned devices is not supported\n"); 103 goto error; 104 } 105 106 dev->num_bands = num_blocks / ftl_get_num_blocks_in_band(dev); 107 108 /* Save a band worth of space for metadata */ 109 dev->num_bands--; 110 111 ftl_mngt_next_step(mngt); 112 return; 113 error: 114 ftl_mngt_fail_step(mngt); 115 } 116 117 void 118 ftl_mngt_close_base_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 119 { 120 if (dev->base_ioch) { 121 spdk_put_io_channel(dev->base_ioch); 122 dev->base_ioch = NULL; 123 } 124 125 if (dev->base_bdev_desc) { 126 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(dev->base_bdev_desc); 127 128 spdk_bdev_module_release_bdev(bdev); 129 spdk_bdev_close(dev->base_bdev_desc); 130 131 dev->base_bdev_desc = NULL; 132 } 133 134 ftl_mngt_next_step(mngt); 135 } 136 137 static void 138 nv_cache_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 139 { 140 switch (type) { 141 case SPDK_BDEV_EVENT_REMOVE: 142 assert(0); 143 break; 144 default: 145 break; 146 } 147 } 148 149 void 150 ftl_mngt_open_cache_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 151 { 152 struct spdk_bdev *bdev; 153 struct ftl_nv_cache *nv_cache = &dev->nv_cache; 154 const char *bdev_name = dev->conf.cache_bdev; 155 156 if (spdk_bdev_open_ext(bdev_name, true, nv_cache_bdev_event_cb, dev, 157 &nv_cache->bdev_desc)) { 158 FTL_ERRLOG(dev, "Unable to open bdev: %s\n", bdev_name); 159 goto error; 160 } 161 162 bdev = spdk_bdev_desc_get_bdev(nv_cache->bdev_desc); 163 164 if (spdk_bdev_module_claim_bdev(bdev, nv_cache->bdev_desc, &g_ftl_bdev_module)) { 165 /* clear the desc so that we don't try to release the claim on cleanup */ 166 spdk_bdev_close(nv_cache->bdev_desc); 167 nv_cache->bdev_desc = NULL; 168 FTL_ERRLOG(dev, "Unable to claim bdev %s\n", bdev_name); 169 goto error; 170 } 171 172 FTL_NOTICELOG(dev, "Using %s as write buffer cache\n", spdk_bdev_get_name(bdev)); 173 174 if (spdk_bdev_get_block_size(bdev) != FTL_BLOCK_SIZE) { 175 FTL_ERRLOG(dev, "Unsupported block size (%d)\n", 176 spdk_bdev_get_block_size(bdev)); 177 goto error; 178 } 179 180 nv_cache->cache_ioch = spdk_bdev_get_io_channel(nv_cache->bdev_desc); 181 if (!nv_cache->cache_ioch) { 182 FTL_ERRLOG(dev, "Failed to create cache IO channel for NV Cache\n"); 183 goto error; 184 } 185 186 #ifndef SPDK_FTL_VSS_EMU 187 if (!spdk_bdev_is_md_separate(bdev)) { 188 FTL_ERRLOG(dev, "Bdev %s doesn't support separate metadata buffer IO\n", 189 spdk_bdev_get_name(bdev)); 190 goto error; 191 } 192 193 nv_cache->md_size = spdk_bdev_get_md_size(bdev); 194 if (nv_cache->md_size != sizeof(union ftl_md_vss)) { 195 FTL_ERRLOG(dev, "Bdev's %s metadata is invalid size (%"PRIu32")\n", 196 spdk_bdev_get_name(bdev), spdk_bdev_get_md_size(bdev)); 197 goto error; 198 } 199 200 if (spdk_bdev_get_dif_type(bdev) != SPDK_DIF_DISABLE) { 201 FTL_ERRLOG(dev, "Unsupported DIF type used by bdev %s\n", 202 spdk_bdev_get_name(bdev)); 203 goto error; 204 } 205 206 if (bdev->blockcnt * bdev->blocklen < MINIMUM_CACHE_SIZE_GIB * GiB) { 207 FTL_ERRLOG(dev, "Bdev %s is too small, requires, at least %uGiB capacity\n", 208 spdk_bdev_get_name(bdev), MINIMUM_CACHE_SIZE_GIB); 209 goto error; 210 } 211 212 if (ftl_md_xfer_blocks(dev) * nv_cache->md_size > FTL_ZERO_BUFFER_SIZE) { 213 FTL_ERRLOG(dev, "Zero buffer too small for bdev %s metadata transfer\n", 214 spdk_bdev_get_name(bdev)); 215 goto error; 216 } 217 #else 218 if (spdk_bdev_is_md_separate(bdev)) { 219 FTL_ERRLOG(dev, "FTL VSS emulation but NV cache supports VSS\n"); 220 goto error; 221 } 222 223 nv_cache->md_size = 64; 224 FTL_NOTICELOG(dev, "FTL uses VSS emulation\n"); 225 #endif 226 227 ftl_mngt_next_step(mngt); 228 return; 229 error: 230 ftl_mngt_fail_step(mngt); 231 } 232 233 void 234 ftl_mngt_close_cache_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 235 { 236 if (dev->nv_cache.cache_ioch) { 237 spdk_put_io_channel(dev->nv_cache.cache_ioch); 238 dev->nv_cache.cache_ioch = NULL; 239 } 240 241 if (dev->nv_cache.bdev_desc) { 242 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(dev->nv_cache.bdev_desc); 243 244 spdk_bdev_module_release_bdev(bdev); 245 spdk_bdev_close(dev->nv_cache.bdev_desc); 246 247 dev->nv_cache.bdev_desc = NULL; 248 } 249 250 ftl_mngt_next_step(mngt); 251 } 252