1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright 2023 Solidigm All Rights Reserved 3 * Copyright (C) 2022 Intel Corporation. 4 * All rights reserved. 5 */ 6 7 #include "spdk/bdev_module.h" 8 #include "spdk/ftl.h" 9 10 #include "ftl_nv_cache.h" 11 #include "ftl_internal.h" 12 #include "ftl_mngt_steps.h" 13 #include "ftl_internal.h" 14 #include "ftl_core.h" 15 #include "utils/ftl_defs.h" 16 17 #define MINIMUM_CACHE_SIZE_GIB 5 18 #define MINIMUM_BASE_SIZE_GIB 20 19 20 /* Dummy bdev module used to to claim bdevs. */ 21 static struct spdk_bdev_module g_ftl_bdev_module = { 22 .name = "ftl_lib", 23 }; 24 25 static inline uint64_t 26 ftl_calculate_num_blocks_in_band(struct spdk_bdev_desc *desc) 27 { 28 /* TODO: this should be passed via input parameter */ 29 #ifdef SPDK_FTL_ZONE_EMU_BLOCKS 30 return SPDK_FTL_ZONE_EMU_BLOCKS; 31 #else 32 return (1ULL << 30) / FTL_BLOCK_SIZE; 33 #endif 34 } 35 36 static void 37 base_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *event_ctx) 38 { 39 switch (type) { 40 case SPDK_BDEV_EVENT_REMOVE: 41 assert(0); 42 break; 43 default: 44 break; 45 } 46 } 47 48 void 49 ftl_mngt_open_base_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 50 { 51 uint32_t block_size; 52 uint64_t num_blocks; 53 const char *bdev_name = dev->conf.base_bdev; 54 struct spdk_bdev *bdev; 55 56 if (spdk_bdev_open_ext(bdev_name, true, base_bdev_event_cb, 57 dev, &dev->base_bdev_desc)) { 58 FTL_ERRLOG(dev, "Unable to open bdev: %s\n", bdev_name); 59 goto error; 60 } 61 62 bdev = spdk_bdev_desc_get_bdev(dev->base_bdev_desc); 63 64 if (spdk_bdev_module_claim_bdev(bdev, dev->base_bdev_desc, &g_ftl_bdev_module)) { 65 /* clear the desc so that we don't try to release the claim on cleanup */ 66 spdk_bdev_close(dev->base_bdev_desc); 67 dev->base_bdev_desc = NULL; 68 FTL_ERRLOG(dev, "Unable to claim bdev %s\n", bdev_name); 69 goto error; 70 } 71 72 block_size = spdk_bdev_get_block_size(bdev); 73 if (block_size != FTL_BLOCK_SIZE) { 74 FTL_ERRLOG(dev, "Unsupported block size (%"PRIu32")\n", block_size); 75 goto error; 76 } 77 78 num_blocks = spdk_bdev_get_num_blocks(bdev); 79 80 if (num_blocks * block_size < MINIMUM_BASE_SIZE_GIB * GiB) { 81 FTL_ERRLOG(dev, "Bdev %s is too small, requires, at least %uGiB capacity\n", 82 spdk_bdev_get_name(bdev), MINIMUM_BASE_SIZE_GIB); 83 goto error; 84 } 85 86 dev->base_ioch = spdk_bdev_get_io_channel(dev->base_bdev_desc); 87 if (!dev->base_ioch) { 88 FTL_ERRLOG(dev, "Failed to create base bdev IO channel\n"); 89 goto error; 90 } 91 92 dev->xfer_size = ftl_get_write_unit_size(bdev); 93 if (dev->xfer_size != FTL_NUM_LBA_IN_BLOCK) { 94 FTL_ERRLOG(dev, "Unsupported xfer_size (%"PRIu64")\n", dev->xfer_size); 95 goto error; 96 } 97 98 /* TODO: validate size when base device VSS usage gets added */ 99 dev->md_size = spdk_bdev_get_md_size(bdev); 100 101 /* Cache frequently used values */ 102 dev->num_blocks_in_band = ftl_calculate_num_blocks_in_band(dev->base_bdev_desc); 103 dev->is_zoned = spdk_bdev_is_zoned(spdk_bdev_desc_get_bdev(dev->base_bdev_desc)); 104 105 if (dev->is_zoned) { 106 /* TODO - current FTL code isn't fully compatible with ZNS drives */ 107 FTL_ERRLOG(dev, "Creating FTL on Zoned devices is not supported\n"); 108 goto error; 109 } 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 if (bdev->blockcnt * bdev->blocklen < MINIMUM_CACHE_SIZE_GIB * GiB) { 187 FTL_ERRLOG(dev, "Bdev %s is too small, requires, at least %uGiB capacity\n", 188 spdk_bdev_get_name(bdev), MINIMUM_CACHE_SIZE_GIB); 189 goto error; 190 } 191 nv_cache->md_size = spdk_bdev_get_md_size(bdev); 192 193 /* Get FTL NVC bdev descriptor */ 194 nv_cache->nvc_desc = ftl_nv_cache_device_get_desc_by_bdev(dev, bdev); 195 if (!nv_cache->nvc_desc) { 196 FTL_ERRLOG(dev, "Failed to get NV Cache device descriptor\n"); 197 goto error; 198 } 199 nv_cache->md_size = sizeof(union ftl_md_vss); 200 201 FTL_NOTICELOG(dev, "Using %s as NV Cache device\n", nv_cache->nvc_desc->name); 202 ftl_mngt_next_step(mngt); 203 return; 204 error: 205 ftl_mngt_fail_step(mngt); 206 } 207 208 void 209 ftl_mngt_close_cache_bdev(struct spdk_ftl_dev *dev, struct ftl_mngt_process *mngt) 210 { 211 if (dev->nv_cache.cache_ioch) { 212 spdk_put_io_channel(dev->nv_cache.cache_ioch); 213 dev->nv_cache.cache_ioch = NULL; 214 } 215 216 if (dev->nv_cache.bdev_desc) { 217 struct spdk_bdev *bdev = spdk_bdev_desc_get_bdev(dev->nv_cache.bdev_desc); 218 219 spdk_bdev_module_release_bdev(bdev); 220 spdk_bdev_close(dev->nv_cache.bdev_desc); 221 222 dev->nv_cache.bdev_desc = NULL; 223 } 224 225 ftl_mngt_next_step(mngt); 226 } 227