1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright (c) Intel Corporation. 3 * All rights reserved. 4 */ 5 6 #include "spdk/stdinc.h" 7 #include "spdk/bdev.h" 8 #include "spdk/env.h" 9 #include "spdk/thread.h" 10 #include "spdk/json.h" 11 #include "spdk/string.h" 12 #include "spdk/likely.h" 13 #include "spdk/util.h" 14 #include "spdk/string.h" 15 #include "spdk/ftl.h" 16 #include "spdk/log.h" 17 18 #include "bdev_ftl.h" 19 20 struct ftl_bdev { 21 struct spdk_bdev bdev; 22 struct spdk_ftl_dev *dev; 23 ftl_bdev_init_fn init_cb; 24 void *init_arg; 25 int rc; 26 struct spdk_bdev_desc *base_bdev_desc; 27 struct spdk_bdev_desc *cache_bdev_desc; 28 }; 29 30 struct ftl_deferred_init { 31 struct spdk_ftl_conf conf; 32 33 LIST_ENTRY(ftl_deferred_init) entry; 34 }; 35 36 static LIST_HEAD(, ftl_deferred_init) g_deferred_init = LIST_HEAD_INITIALIZER(g_deferred_init); 37 38 static int bdev_ftl_initialize(void); 39 static void bdev_ftl_finish(void); 40 static void bdev_ftl_examine(struct spdk_bdev *bdev); 41 42 static int 43 bdev_ftl_get_ctx_size(void) 44 { 45 return spdk_ftl_io_size(); 46 } 47 48 static struct spdk_bdev_module g_ftl_if = { 49 .name = "ftl", 50 .module_init = bdev_ftl_initialize, 51 .module_fini = bdev_ftl_finish, 52 .examine_disk = bdev_ftl_examine, 53 .get_ctx_size = bdev_ftl_get_ctx_size, 54 }; 55 56 SPDK_BDEV_MODULE_REGISTER(ftl, &g_ftl_if) 57 58 static void 59 bdev_ftl_free(struct ftl_bdev *ftl_bdev) 60 { 61 spdk_bdev_close(ftl_bdev->base_bdev_desc); 62 spdk_bdev_close(ftl_bdev->cache_bdev_desc); 63 free(ftl_bdev->bdev.name); 64 free(ftl_bdev); 65 } 66 67 static void 68 bdev_ftl_dev_free_cb(void *ctx, int status) 69 { 70 struct ftl_bdev *ftl_bdev = ctx; 71 72 spdk_bdev_destruct_done(&ftl_bdev->bdev, status); 73 bdev_ftl_free(ftl_bdev); 74 } 75 76 static int 77 bdev_ftl_destruct(void *ctx) 78 { 79 struct ftl_bdev *ftl_bdev = ctx; 80 81 spdk_ftl_dev_free(ftl_bdev->dev, bdev_ftl_dev_free_cb, ftl_bdev); 82 83 /* return 1 to indicate that the destruction is asynchronous */ 84 return 1; 85 } 86 87 static void 88 bdev_ftl_cb(void *arg, int rc) 89 { 90 struct spdk_bdev_io *bdev_io = arg; 91 enum spdk_bdev_io_status status; 92 93 switch (rc) { 94 case 0: 95 status = SPDK_BDEV_IO_STATUS_SUCCESS; 96 break; 97 case -ENOMEM: 98 status = SPDK_BDEV_IO_STATUS_NOMEM; 99 break; 100 default: 101 status = SPDK_BDEV_IO_STATUS_FAILED; 102 break; 103 } 104 105 spdk_bdev_io_complete(bdev_io, status); 106 } 107 108 static void 109 bdev_ftl_get_buf_cb(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io, 110 bool success) 111 { 112 struct ftl_bdev *ftl_bdev; 113 int rc; 114 115 ftl_bdev = bdev_io->bdev->ctxt; 116 117 if (!success) { 118 spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_FAILED); 119 return; 120 } 121 122 rc = spdk_ftl_readv(ftl_bdev->dev, (struct ftl_io *)bdev_io->driver_ctx, 123 ch, 124 bdev_io->u.bdev.offset_blocks, 125 bdev_io->u.bdev.num_blocks, 126 bdev_io->u.bdev.iovs, bdev_io->u.bdev.iovcnt, bdev_ftl_cb, bdev_io); 127 128 if (spdk_unlikely(rc != 0)) { 129 spdk_bdev_io_complete(bdev_io, rc); 130 } 131 } 132 133 static int 134 _bdev_ftl_submit_request(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io) 135 { 136 struct ftl_bdev *ftl_bdev = (struct ftl_bdev *)bdev_io->bdev->ctxt; 137 138 switch (bdev_io->type) { 139 case SPDK_BDEV_IO_TYPE_READ: 140 spdk_bdev_io_get_buf(bdev_io, bdev_ftl_get_buf_cb, 141 bdev_io->u.bdev.num_blocks * bdev_io->bdev->blocklen); 142 return 0; 143 144 case SPDK_BDEV_IO_TYPE_WRITE: 145 return spdk_ftl_writev(ftl_bdev->dev, (struct ftl_io *)bdev_io->driver_ctx, 146 ch, bdev_io->u.bdev.offset_blocks, 147 bdev_io->u.bdev.num_blocks, bdev_io->u.bdev.iovs, 148 bdev_io->u.bdev.iovcnt, bdev_ftl_cb, bdev_io); 149 150 case SPDK_BDEV_IO_TYPE_UNMAP: 151 case SPDK_BDEV_IO_TYPE_FLUSH: 152 spdk_bdev_io_complete(bdev_io, SPDK_BDEV_IO_STATUS_SUCCESS); 153 return 0; 154 default: 155 return -ENOTSUP; 156 } 157 } 158 159 static void 160 bdev_ftl_submit_request(struct spdk_io_channel *ch, struct spdk_bdev_io *bdev_io) 161 { 162 int rc = _bdev_ftl_submit_request(ch, bdev_io); 163 164 if (spdk_unlikely(rc != 0)) { 165 spdk_bdev_io_complete(bdev_io, rc); 166 } 167 } 168 169 static bool 170 bdev_ftl_io_type_supported(void *ctx, enum spdk_bdev_io_type io_type) 171 { 172 switch (io_type) { 173 case SPDK_BDEV_IO_TYPE_READ: 174 case SPDK_BDEV_IO_TYPE_WRITE: 175 case SPDK_BDEV_IO_TYPE_FLUSH: 176 case SPDK_BDEV_IO_TYPE_UNMAP: 177 return true; 178 default: 179 return false; 180 } 181 } 182 183 static struct spdk_io_channel * 184 bdev_ftl_get_io_channel(void *ctx) 185 { 186 struct ftl_bdev *ftl_bdev = ctx; 187 188 return spdk_ftl_get_io_channel(ftl_bdev->dev); 189 } 190 191 static void 192 bdev_ftl_write_config_json(struct spdk_bdev *bdev, struct spdk_json_write_ctx *w) 193 { 194 struct ftl_bdev *ftl_bdev = bdev->ctxt; 195 struct spdk_ftl_conf conf; 196 char uuid[SPDK_UUID_STRING_LEN]; 197 198 spdk_ftl_dev_get_conf(ftl_bdev->dev, &conf); 199 200 spdk_json_write_object_begin(w); 201 202 spdk_json_write_named_string(w, "method", "bdev_ftl_create"); 203 204 spdk_json_write_named_object_begin(w, "params"); 205 spdk_json_write_named_string(w, "name", ftl_bdev->bdev.name); 206 207 spdk_json_write_named_uint64(w, "overprovisioning", conf.overprovisioning); 208 209 if (conf.core_mask) { 210 spdk_json_write_named_string(w, "core_mask", conf.core_mask); 211 } 212 213 spdk_uuid_fmt_lower(uuid, sizeof(uuid), &conf.uuid); 214 spdk_json_write_named_string(w, "uuid", uuid); 215 216 spdk_json_write_named_string(w, "base_bdev", conf.base_bdev); 217 218 if (conf.cache_bdev) { 219 spdk_json_write_named_string(w, "cache", conf.cache_bdev); 220 } 221 222 spdk_json_write_object_end(w); 223 spdk_json_write_object_end(w); 224 } 225 226 static int 227 bdev_ftl_dump_info_json(void *ctx, struct spdk_json_write_ctx *w) 228 { 229 struct ftl_bdev *ftl_bdev = ctx; 230 struct spdk_ftl_attrs attrs; 231 struct spdk_ftl_conf conf; 232 233 spdk_ftl_dev_get_attrs(ftl_bdev->dev, &attrs); 234 spdk_ftl_dev_get_conf(ftl_bdev->dev, &conf); 235 236 spdk_json_write_named_object_begin(w, "ftl"); 237 238 spdk_json_write_named_string(w, "base_bdev", conf.base_bdev); 239 240 if (conf.cache_bdev) { 241 spdk_json_write_named_string(w, "cache", conf.cache_bdev); 242 } 243 244 /* ftl */ 245 spdk_json_write_object_end(w); 246 247 return 0; 248 } 249 250 static const struct spdk_bdev_fn_table ftl_fn_table = { 251 .destruct = bdev_ftl_destruct, 252 .submit_request = bdev_ftl_submit_request, 253 .io_type_supported = bdev_ftl_io_type_supported, 254 .get_io_channel = bdev_ftl_get_io_channel, 255 .write_config_json = bdev_ftl_write_config_json, 256 .dump_info_json = bdev_ftl_dump_info_json, 257 }; 258 259 static void 260 bdev_ftl_create_err_complete(struct ftl_bdev *ftl_bdev) 261 { 262 ftl_bdev_init_fn init_cb = ftl_bdev->init_cb; 263 void *init_arg = ftl_bdev->init_arg; 264 int rc = ftl_bdev->rc; 265 266 bdev_ftl_free(ftl_bdev); 267 268 assert(rc); 269 init_cb(NULL, init_arg, rc); 270 } 271 272 static void 273 bdev_ftl_create_err_cleanup_cb(void *ctx, int status) 274 { 275 struct ftl_bdev *ftl_bdev = ctx; 276 277 if (status) { 278 SPDK_ERRLOG("Fatal ERROR of FTL cleanup, name %s\n", ftl_bdev->bdev.name); 279 } 280 281 bdev_ftl_create_err_complete(ftl_bdev); 282 } 283 284 static void 285 bdev_ftl_create_cb(struct spdk_ftl_dev *dev, void *ctx, int status) 286 { 287 struct ftl_bdev *ftl_bdev = ctx; 288 struct ftl_bdev_info info = {}; 289 struct spdk_ftl_attrs attrs; 290 struct spdk_ftl_conf conf; 291 ftl_bdev_init_fn init_cb = ftl_bdev->init_cb; 292 void *init_arg = ftl_bdev->init_arg; 293 294 if (status) { 295 SPDK_ERRLOG("Failed to create FTL device (%d)\n", status); 296 ftl_bdev->rc = status; 297 goto error; 298 } 299 300 spdk_ftl_dev_get_attrs(dev, &attrs); 301 spdk_ftl_dev_get_conf(dev, &conf); 302 303 ftl_bdev->dev = dev; 304 ftl_bdev->bdev.product_name = "FTL disk"; 305 ftl_bdev->bdev.write_cache = 0; 306 ftl_bdev->bdev.blocklen = attrs.block_size; 307 ftl_bdev->bdev.blockcnt = attrs.num_blocks; 308 ftl_bdev->bdev.uuid = conf.uuid; 309 ftl_bdev->bdev.optimal_io_boundary = attrs.optimum_io_size; 310 ftl_bdev->bdev.split_on_optimal_io_boundary = true; 311 312 SPDK_DEBUGLOG(bdev_ftl, "Creating bdev %s:\n", ftl_bdev->bdev.name); 313 SPDK_DEBUGLOG(bdev_ftl, "\tblock_len:\t%zu\n", attrs.block_size); 314 SPDK_DEBUGLOG(bdev_ftl, "\tnum_blocks:\t%"PRIu64"\n", attrs.num_blocks); 315 316 ftl_bdev->bdev.ctxt = ftl_bdev; 317 ftl_bdev->bdev.fn_table = &ftl_fn_table; 318 ftl_bdev->bdev.module = &g_ftl_if; 319 320 status = spdk_bdev_register(&ftl_bdev->bdev); 321 if (status) { 322 ftl_bdev->rc = status; 323 goto error; 324 } 325 326 info.name = ftl_bdev->bdev.name; 327 info.uuid = ftl_bdev->bdev.uuid; 328 329 init_cb(&info, init_arg, 0); 330 return; 331 332 error: 333 if (ftl_bdev->dev) { 334 /* FTL was created, but we have got an error, so we need to delete it */ 335 spdk_ftl_dev_free(dev, bdev_ftl_create_err_cleanup_cb, ftl_bdev); 336 } else { 337 bdev_ftl_create_err_complete(ftl_bdev); 338 } 339 } 340 341 static void 342 bdev_ftl_defer_free(struct ftl_deferred_init *init) 343 { 344 spdk_ftl_conf_deinit(&init->conf); 345 free(init); 346 } 347 348 int 349 bdev_ftl_defer_init(const struct spdk_ftl_conf *conf) 350 { 351 struct ftl_deferred_init *init; 352 int rc; 353 354 init = calloc(1, sizeof(*init)); 355 if (!init) { 356 return -ENOMEM; 357 } 358 359 rc = spdk_ftl_conf_copy(&init->conf, conf); 360 if (rc) { 361 free(init); 362 return -ENOMEM; 363 } 364 365 LIST_INSERT_HEAD(&g_deferred_init, init, entry); 366 367 return 0; 368 } 369 370 static void 371 bdev_ftl_create_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *ctx) 372 { 373 } 374 375 int 376 bdev_ftl_create_bdev(const struct spdk_ftl_conf *conf, ftl_bdev_init_fn cb, void *cb_arg) 377 { 378 struct ftl_bdev *ftl_bdev; 379 struct spdk_bdev_desc *base_bdev_desc, *cache_bdev_desc; 380 int rc; 381 382 rc = spdk_bdev_open_ext(conf->base_bdev, false, bdev_ftl_create_bdev_event_cb, NULL, 383 &base_bdev_desc); 384 if (rc) { 385 return rc; 386 } 387 rc = spdk_bdev_open_ext(conf->cache_bdev, false, bdev_ftl_create_bdev_event_cb, NULL, 388 &cache_bdev_desc); 389 if (rc) { 390 spdk_bdev_close(base_bdev_desc); 391 return rc; 392 } 393 394 ftl_bdev = calloc(1, sizeof(*ftl_bdev)); 395 if (!ftl_bdev) { 396 SPDK_ERRLOG("Could not allocate ftl_bdev\n"); 397 spdk_bdev_close(base_bdev_desc); 398 spdk_bdev_close(cache_bdev_desc); 399 return -ENOMEM; 400 } 401 402 ftl_bdev->base_bdev_desc = base_bdev_desc; 403 ftl_bdev->cache_bdev_desc = cache_bdev_desc; 404 405 ftl_bdev->bdev.name = strdup(conf->name); 406 if (!ftl_bdev->bdev.name) { 407 rc = -ENOMEM; 408 goto error; 409 } 410 411 ftl_bdev->init_cb = cb; 412 ftl_bdev->init_arg = cb_arg; 413 414 rc = spdk_ftl_dev_init(conf, bdev_ftl_create_cb, ftl_bdev); 415 if (rc) { 416 SPDK_ERRLOG("Could not create FTL device\n"); 417 goto error; 418 } 419 420 return 0; 421 422 error: 423 bdev_ftl_free(ftl_bdev); 424 return rc; 425 } 426 427 static int 428 bdev_ftl_initialize(void) 429 { 430 return spdk_ftl_init(); 431 } 432 433 void 434 bdev_ftl_delete_bdev(const char *name, spdk_bdev_unregister_cb cb_fn, void *cb_arg) 435 { 436 int rc; 437 438 rc = spdk_bdev_unregister_by_name(name, &g_ftl_if, cb_fn, cb_arg); 439 if (rc) { 440 cb_fn(cb_arg, rc); 441 } 442 } 443 444 static void 445 bdev_ftl_finish(void) 446 { 447 spdk_ftl_fini(); 448 } 449 450 static void 451 bdev_ftl_create_defered_cb(const struct ftl_bdev_info *info, void *ctx, int status) 452 { 453 struct ftl_deferred_init *opts = ctx; 454 455 if (status) { 456 SPDK_ERRLOG("Failed to initialize FTL bdev '%s'\n", opts->conf.name); 457 } 458 459 bdev_ftl_defer_free(opts); 460 461 spdk_bdev_module_examine_done(&g_ftl_if); 462 } 463 464 static void 465 bdev_ftl_examine(struct spdk_bdev *bdev) 466 { 467 struct ftl_deferred_init *opts; 468 int rc; 469 470 LIST_FOREACH(opts, &g_deferred_init, entry) { 471 /* spdk_bdev_module_examine_done will be called by bdev_ftl_create_defered_cb */ 472 rc = bdev_ftl_create_bdev(&opts->conf, bdev_ftl_create_defered_cb, opts); 473 if (rc == -ENODEV) { 474 continue; 475 } 476 477 LIST_REMOVE(opts, entry); 478 479 if (rc) { 480 bdev_ftl_create_defered_cb(NULL, opts, rc); 481 } 482 return; 483 } 484 485 spdk_bdev_module_examine_done(&g_ftl_if); 486 } 487 488 SPDK_LOG_REGISTER_COMPONENT(bdev_ftl) 489