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_bool(w, "fast_shutdown", conf.fast_shutdown); 217 218 spdk_json_write_named_string(w, "base_bdev", conf.base_bdev); 219 220 if (conf.cache_bdev) { 221 spdk_json_write_named_string(w, "cache", conf.cache_bdev); 222 } 223 224 spdk_json_write_object_end(w); 225 spdk_json_write_object_end(w); 226 } 227 228 static int 229 bdev_ftl_dump_info_json(void *ctx, struct spdk_json_write_ctx *w) 230 { 231 struct ftl_bdev *ftl_bdev = ctx; 232 struct spdk_ftl_attrs attrs; 233 struct spdk_ftl_conf conf; 234 235 spdk_ftl_dev_get_attrs(ftl_bdev->dev, &attrs); 236 spdk_ftl_dev_get_conf(ftl_bdev->dev, &conf); 237 238 spdk_json_write_named_object_begin(w, "ftl"); 239 240 spdk_json_write_named_string(w, "base_bdev", conf.base_bdev); 241 242 if (conf.cache_bdev) { 243 spdk_json_write_named_string(w, "cache", conf.cache_bdev); 244 } 245 246 /* ftl */ 247 spdk_json_write_object_end(w); 248 249 return 0; 250 } 251 252 static const struct spdk_bdev_fn_table ftl_fn_table = { 253 .destruct = bdev_ftl_destruct, 254 .submit_request = bdev_ftl_submit_request, 255 .io_type_supported = bdev_ftl_io_type_supported, 256 .get_io_channel = bdev_ftl_get_io_channel, 257 .write_config_json = bdev_ftl_write_config_json, 258 .dump_info_json = bdev_ftl_dump_info_json, 259 }; 260 261 static void 262 bdev_ftl_create_err_complete(struct ftl_bdev *ftl_bdev) 263 { 264 ftl_bdev_init_fn init_cb = ftl_bdev->init_cb; 265 void *init_arg = ftl_bdev->init_arg; 266 int rc = ftl_bdev->rc; 267 268 bdev_ftl_free(ftl_bdev); 269 270 assert(rc); 271 init_cb(NULL, init_arg, rc); 272 } 273 274 static void 275 bdev_ftl_create_err_cleanup_cb(void *ctx, int status) 276 { 277 struct ftl_bdev *ftl_bdev = ctx; 278 279 if (status) { 280 SPDK_ERRLOG("Fatal ERROR of FTL cleanup, name %s\n", ftl_bdev->bdev.name); 281 } 282 283 bdev_ftl_create_err_complete(ftl_bdev); 284 } 285 286 static void 287 bdev_ftl_create_cb(struct spdk_ftl_dev *dev, void *ctx, int status) 288 { 289 struct ftl_bdev *ftl_bdev = ctx; 290 struct ftl_bdev_info info = {}; 291 struct spdk_ftl_attrs attrs; 292 struct spdk_ftl_conf conf; 293 ftl_bdev_init_fn init_cb = ftl_bdev->init_cb; 294 void *init_arg = ftl_bdev->init_arg; 295 296 if (status) { 297 SPDK_ERRLOG("Failed to create FTL device (%d)\n", status); 298 ftl_bdev->rc = status; 299 goto error; 300 } 301 302 spdk_ftl_dev_get_attrs(dev, &attrs); 303 spdk_ftl_dev_get_conf(dev, &conf); 304 305 ftl_bdev->dev = dev; 306 ftl_bdev->bdev.product_name = "FTL disk"; 307 ftl_bdev->bdev.write_cache = 0; 308 ftl_bdev->bdev.blocklen = attrs.block_size; 309 ftl_bdev->bdev.blockcnt = attrs.num_blocks; 310 ftl_bdev->bdev.uuid = conf.uuid; 311 ftl_bdev->bdev.optimal_io_boundary = attrs.optimum_io_size; 312 ftl_bdev->bdev.split_on_optimal_io_boundary = true; 313 314 SPDK_DEBUGLOG(bdev_ftl, "Creating bdev %s:\n", ftl_bdev->bdev.name); 315 SPDK_DEBUGLOG(bdev_ftl, "\tblock_len:\t%zu\n", attrs.block_size); 316 SPDK_DEBUGLOG(bdev_ftl, "\tnum_blocks:\t%"PRIu64"\n", attrs.num_blocks); 317 318 ftl_bdev->bdev.ctxt = ftl_bdev; 319 ftl_bdev->bdev.fn_table = &ftl_fn_table; 320 ftl_bdev->bdev.module = &g_ftl_if; 321 322 status = spdk_bdev_register(&ftl_bdev->bdev); 323 if (status) { 324 ftl_bdev->rc = status; 325 goto error; 326 } 327 328 info.name = ftl_bdev->bdev.name; 329 info.uuid = ftl_bdev->bdev.uuid; 330 331 init_cb(&info, init_arg, 0); 332 return; 333 334 error: 335 if (ftl_bdev->dev) { 336 /* Cleanup all FTL */ 337 spdk_ftl_dev_set_fast_shutdown(ftl_bdev->dev, false); 338 339 /* FTL was created, but we have got an error, so we need to delete it */ 340 spdk_ftl_dev_free(dev, bdev_ftl_create_err_cleanup_cb, ftl_bdev); 341 } else { 342 bdev_ftl_create_err_complete(ftl_bdev); 343 } 344 } 345 346 static void 347 bdev_ftl_defer_free(struct ftl_deferred_init *init) 348 { 349 spdk_ftl_conf_deinit(&init->conf); 350 free(init); 351 } 352 353 int 354 bdev_ftl_defer_init(const struct spdk_ftl_conf *conf) 355 { 356 struct ftl_deferred_init *init; 357 int rc; 358 359 init = calloc(1, sizeof(*init)); 360 if (!init) { 361 return -ENOMEM; 362 } 363 364 rc = spdk_ftl_conf_copy(&init->conf, conf); 365 if (rc) { 366 free(init); 367 return -ENOMEM; 368 } 369 370 LIST_INSERT_HEAD(&g_deferred_init, init, entry); 371 372 return 0; 373 } 374 375 static void 376 bdev_ftl_create_bdev_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *ctx) 377 { 378 } 379 380 int 381 bdev_ftl_create_bdev(const struct spdk_ftl_conf *conf, ftl_bdev_init_fn cb, void *cb_arg) 382 { 383 struct ftl_bdev *ftl_bdev; 384 struct spdk_bdev_desc *base_bdev_desc, *cache_bdev_desc; 385 int rc; 386 387 rc = spdk_bdev_open_ext(conf->base_bdev, false, bdev_ftl_create_bdev_event_cb, NULL, 388 &base_bdev_desc); 389 if (rc) { 390 return rc; 391 } 392 rc = spdk_bdev_open_ext(conf->cache_bdev, false, bdev_ftl_create_bdev_event_cb, NULL, 393 &cache_bdev_desc); 394 if (rc) { 395 spdk_bdev_close(base_bdev_desc); 396 return rc; 397 } 398 399 ftl_bdev = calloc(1, sizeof(*ftl_bdev)); 400 if (!ftl_bdev) { 401 SPDK_ERRLOG("Could not allocate ftl_bdev\n"); 402 spdk_bdev_close(base_bdev_desc); 403 spdk_bdev_close(cache_bdev_desc); 404 return -ENOMEM; 405 } 406 407 ftl_bdev->base_bdev_desc = base_bdev_desc; 408 ftl_bdev->cache_bdev_desc = cache_bdev_desc; 409 410 ftl_bdev->bdev.name = strdup(conf->name); 411 if (!ftl_bdev->bdev.name) { 412 rc = -ENOMEM; 413 goto error; 414 } 415 416 ftl_bdev->init_cb = cb; 417 ftl_bdev->init_arg = cb_arg; 418 419 rc = spdk_ftl_dev_init(conf, bdev_ftl_create_cb, ftl_bdev); 420 if (rc) { 421 SPDK_ERRLOG("Could not create FTL device\n"); 422 goto error; 423 } 424 425 return 0; 426 427 error: 428 bdev_ftl_free(ftl_bdev); 429 return rc; 430 } 431 432 static int 433 bdev_ftl_initialize(void) 434 { 435 return spdk_ftl_init(); 436 } 437 438 static void 439 bdev_ftl_event_cb(enum spdk_bdev_event_type type, struct spdk_bdev *bdev, void *ctx) 440 { 441 } 442 443 void 444 bdev_ftl_delete_bdev(const char *name, bool fast_shutdown, spdk_bdev_unregister_cb cb_fn, 445 void *cb_arg) 446 { 447 struct spdk_bdev_desc *ftl_bdev_desc; 448 struct spdk_bdev *bdev; 449 struct ftl_bdev *ftl; 450 int rc; 451 452 rc = spdk_bdev_open_ext(name, false, bdev_ftl_event_cb, NULL, &ftl_bdev_desc); 453 454 if (rc) { 455 goto not_found; 456 } 457 458 bdev = spdk_bdev_desc_get_bdev(ftl_bdev_desc); 459 460 if (bdev->module != &g_ftl_if) { 461 goto bdev_opened; 462 } 463 464 ftl = bdev->ctxt; 465 assert(ftl); 466 spdk_ftl_dev_set_fast_shutdown(ftl->dev, fast_shutdown); 467 spdk_bdev_close(ftl_bdev_desc); 468 469 rc = spdk_bdev_unregister_by_name(name, &g_ftl_if, cb_fn, cb_arg); 470 if (rc) { 471 cb_fn(cb_arg, rc); 472 } 473 474 return; 475 bdev_opened: 476 spdk_bdev_close(ftl_bdev_desc); 477 not_found: 478 cb_fn(cb_arg, -ENODEV); 479 } 480 481 static void 482 bdev_ftl_finish(void) 483 { 484 spdk_ftl_fini(); 485 } 486 487 static void 488 bdev_ftl_create_defered_cb(const struct ftl_bdev_info *info, void *ctx, int status) 489 { 490 struct ftl_deferred_init *opts = ctx; 491 492 if (status) { 493 SPDK_ERRLOG("Failed to initialize FTL bdev '%s'\n", opts->conf.name); 494 } 495 496 bdev_ftl_defer_free(opts); 497 498 spdk_bdev_module_examine_done(&g_ftl_if); 499 } 500 501 static void 502 bdev_ftl_examine(struct spdk_bdev *bdev) 503 { 504 struct ftl_deferred_init *opts; 505 int rc; 506 507 LIST_FOREACH(opts, &g_deferred_init, entry) { 508 /* spdk_bdev_module_examine_done will be called by bdev_ftl_create_defered_cb */ 509 rc = bdev_ftl_create_bdev(&opts->conf, bdev_ftl_create_defered_cb, opts); 510 if (rc == -ENODEV) { 511 continue; 512 } 513 514 LIST_REMOVE(opts, entry); 515 516 if (rc) { 517 bdev_ftl_create_defered_cb(NULL, opts, rc); 518 } 519 return; 520 } 521 522 spdk_bdev_module_examine_done(&g_ftl_if); 523 } 524 525 SPDK_LOG_REGISTER_COMPONENT(bdev_ftl) 526