1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (C) 2022 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 if (dev->xfer_size != FTL_NUM_LBA_IN_BLOCK) { 93 FTL_ERRLOG(dev, "Unsupported xfer_size (%"PRIu64")\n", dev->xfer_size); 94 goto error; 95 } 96 97 /* TODO: validate size when base device VSS usage gets added */ 98 dev->md_size = spdk_bdev_get_md_size(bdev); 99 100 /* Cache frequently used values */ 101 dev->num_blocks_in_band = ftl_calculate_num_blocks_in_band(dev->base_bdev_desc); 102 dev->is_zoned = spdk_bdev_is_zoned(spdk_bdev_desc_get_bdev(dev->base_bdev_desc)); 103 104 if (dev->is_zoned) { 105 /* TODO - current FTL code isn't fully compatible with ZNS drives */ 106 FTL_ERRLOG(dev, "Creating FTL on Zoned devices is not supported\n"); 107 goto error; 108 } 109 110 ftl_mngt_next_step(mngt); 111 return; 112 error: 113 ftl_mngt_fail_step(mngt); 114 } 115 116 void 117 ftl_mngt_close_base_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 118 { 119 if (dev->base_ioch) { 120 spdk_put_io_channel(dev->base_ioch); 121 dev->base_ioch = NULL; 122 } 123 124 if (dev->base_bdev_desc) { 125 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(dev->base_bdev_desc); 126 127 spdk_bdev_module_release_bdev(bdev); 128 spdk_bdev_close(dev->base_bdev_desc); 129 130 dev->base_bdev_desc = NULL; 131 } 132 133 ftl_mngt_next_step(mngt); 134 } 135 136 static void 137 nv_cache_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 138 { 139 switch (type) { 140 case SPDK_BDEV_EVENT_REMOVE: 141 assert(0); 142 break; 143 default: 144 break; 145 } 146 } 147 148 void 149 ftl_mngt_open_cache_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 150 { 151 struct spdk_bdev *bdev; 152 struct ftl_nv_cache *nv_cache = &dev->nv_cache; 153 const char *bdev_name = dev->conf.cache_bdev; 154 155 if (spdk_bdev_open_ext(bdev_name, true, nv_cache_bdev_event_cb, dev, 156 &nv_cache->bdev_desc)) { 157 FTL_ERRLOG(dev, "Unable to open bdev: %s\n", bdev_name); 158 goto error; 159 } 160 161 bdev = spdk_bdev_desc_get_bdev(nv_cache->bdev_desc); 162 163 if (spdk_bdev_module_claim_bdev(bdev, nv_cache->bdev_desc, &g_ftl_bdev_module)) { 164 /* clear the desc so that we don't try to release the claim on cleanup */ 165 spdk_bdev_close(nv_cache->bdev_desc); 166 nv_cache->bdev_desc = NULL; 167 FTL_ERRLOG(dev, "Unable to claim bdev %s\n", bdev_name); 168 goto error; 169 } 170 171 FTL_NOTICELOG(dev, "Using %s as write buffer cache\n", spdk_bdev_get_name(bdev)); 172 173 if (spdk_bdev_get_block_size(bdev) != FTL_BLOCK_SIZE) { 174 FTL_ERRLOG(dev, "Unsupported block size (%d)\n", 175 spdk_bdev_get_block_size(bdev)); 176 goto error; 177 } 178 179 nv_cache->cache_ioch = spdk_bdev_get_io_channel(nv_cache->bdev_desc); 180 if (!nv_cache->cache_ioch) { 181 FTL_ERRLOG(dev, "Failed to create cache IO channel for NV Cache\n"); 182 goto error; 183 } 184 185 #ifndef SPDK_FTL_VSS_EMU 186 if (!spdk_bdev_is_md_separate(bdev)) { 187 FTL_ERRLOG(dev, "Bdev %s doesn't support separate metadata buffer IO\n", 188 spdk_bdev_get_name(bdev)); 189 goto error; 190 } 191 192 nv_cache->md_size = spdk_bdev_get_md_size(bdev); 193 if (nv_cache->md_size != sizeof(union ftl_md_vss)) { 194 FTL_ERRLOG(dev, "Bdev's %s metadata is invalid size (%"PRIu32")\n", 195 spdk_bdev_get_name(bdev), spdk_bdev_get_md_size(bdev)); 196 goto error; 197 } 198 199 if (spdk_bdev_get_dif_type(bdev) != SPDK_DIF_DISABLE) { 200 FTL_ERRLOG(dev, "Unsupported DIF type used by bdev %s\n", 201 spdk_bdev_get_name(bdev)); 202 goto error; 203 } 204 205 if (bdev->blockcnt * bdev->blocklen < MINIMUM_CACHE_SIZE_GIB * GiB) { 206 FTL_ERRLOG(dev, "Bdev %s is too small, requires, at least %uGiB capacity\n", 207 spdk_bdev_get_name(bdev), MINIMUM_CACHE_SIZE_GIB); 208 goto error; 209 } 210 211 if (ftl_md_xfer_blocks(dev) * nv_cache->md_size > FTL_ZERO_BUFFER_SIZE) { 212 FTL_ERRLOG(dev, "Zero buffer too small for bdev %s metadata transfer\n", 213 spdk_bdev_get_name(bdev)); 214 goto error; 215 } 216 #else 217 if (spdk_bdev_is_md_separate(bdev)) { 218 FTL_ERRLOG(dev, "FTL VSS emulation but NV cache supports VSS\n"); 219 goto error; 220 } 221 222 nv_cache->md_size = 64; 223 FTL_NOTICELOG(dev, "FTL uses VSS emulation\n"); 224 #endif 225 226 ftl_mngt_next_step(mngt); 227 return; 228 error: 229 ftl_mngt_fail_step(mngt); 230 } 231 232 void 233 ftl_mngt_close_cache_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 234 { 235 if (dev->nv_cache.cache_ioch) { 236 spdk_put_io_channel(dev->nv_cache.cache_ioch); 237 dev->nv_cache.cache_ioch = NULL; 238 } 239 240 if (dev->nv_cache.bdev_desc) { 241 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(dev->nv_cache.bdev_desc); 242 243 spdk_bdev_module_release_bdev(bdev); 244 spdk_bdev_close(dev->nv_cache.bdev_desc); 245 246 dev->nv_cache.bdev_desc = NULL; 247 } 248 249 ftl_mngt_next_step(mngt); 250 } 251