1 /*- 2 * BSD LICENSE 3 * 4 * Copyright (c) Intel Corporation. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * * Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * * Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in 15 * the documentation and/or other materials provided with the 16 * distribution. 17 * * Neither the name of Intel Corporation nor the names of its 18 * contributors may be used to endorse or promote products derived 19 * from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 24 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 25 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 27 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 #include "spdk/stdinc.h" 35 36 #include "spdk_cunit.h" 37 38 #include "spdk_internal/mock.h" 39 40 #include "nvmf/ctrlr_bdev.c" 41 42 43 SPDK_LOG_REGISTER_COMPONENT(nvmf) 44 45 DEFINE_STUB(spdk_nvmf_request_complete, int, (struct spdk_nvmf_request *req), -1); 46 47 DEFINE_STUB(spdk_bdev_get_name, const char *, (const struct spdk_bdev *bdev), "test"); 48 49 DEFINE_STUB(spdk_bdev_get_acwu, uint16_t, (const struct spdk_bdev *bdev), 0); 50 51 DEFINE_STUB(spdk_bdev_get_data_block_size, uint32_t, 52 (const struct spdk_bdev *bdev), 512); 53 54 DEFINE_STUB(nvmf_ctrlr_process_admin_cmd, int, (struct spdk_nvmf_request *req), 0); 55 56 DEFINE_STUB(spdk_bdev_comparev_blocks, int, (struct spdk_bdev_desc *desc, 57 struct spdk_io_channel *ch, struct iovec *iov, int iovcnt, 58 uint64_t offset_blocks, uint64_t num_blocks, 59 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 60 61 DEFINE_STUB(spdk_bdev_nvme_admin_passthru, int, 62 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 63 const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, 64 spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 65 66 DEFINE_STUB(spdk_bdev_abort, int, 67 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 68 void *bio_cb_arg, spdk_bdev_io_completion_cb cb, void *cb_arg), 0); 69 70 struct spdk_bdev { 71 uint32_t blocklen; 72 uint64_t num_blocks; 73 uint32_t md_len; 74 }; 75 76 uint32_t 77 spdk_bdev_get_block_size(const struct spdk_bdev *bdev) 78 { 79 return bdev->blocklen; 80 } 81 82 uint64_t 83 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev) 84 { 85 return bdev->num_blocks; 86 } 87 88 uint32_t 89 spdk_bdev_get_optimal_io_boundary(const struct spdk_bdev *bdev) 90 { 91 abort(); 92 return 0; 93 } 94 95 uint32_t 96 spdk_bdev_get_md_size(const struct spdk_bdev *bdev) 97 { 98 return bdev->md_len; 99 } 100 101 DEFINE_STUB(spdk_bdev_comparev_and_writev_blocks, int, 102 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 103 struct iovec *compare_iov, int compare_iovcnt, 104 struct iovec *write_iov, int write_iovcnt, 105 uint64_t offset_blocks, uint64_t num_blocks, 106 spdk_bdev_io_completion_cb cb, void *cb_arg), 107 0); 108 109 DEFINE_STUB(nvmf_ctrlr_process_io_cmd, int, (struct spdk_nvmf_request *req), 0); 110 111 DEFINE_STUB_V(spdk_bdev_io_get_nvme_fused_status, (const struct spdk_bdev_io *bdev_io, 112 uint32_t *cdw0, int *cmp_sct, int *cmp_sc, int *wr_sct, int *wr_sc)); 113 114 DEFINE_STUB(spdk_bdev_is_md_interleaved, bool, (const struct spdk_bdev *bdev), false); 115 116 DEFINE_STUB(spdk_bdev_get_dif_type, enum spdk_dif_type, 117 (const struct spdk_bdev *bdev), SPDK_DIF_DISABLE); 118 119 DEFINE_STUB(spdk_bdev_is_dif_head_of_md, bool, (const struct spdk_bdev *bdev), false); 120 121 DEFINE_STUB(spdk_bdev_is_dif_check_enabled, bool, 122 (const struct spdk_bdev *bdev, enum spdk_dif_check_type check_type), false); 123 124 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, 125 (struct spdk_bdev_desc *desc), NULL); 126 127 DEFINE_STUB(spdk_bdev_flush_blocks, int, 128 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 129 uint64_t offset_blocks, uint64_t num_blocks, 130 spdk_bdev_io_completion_cb cb, void *cb_arg), 131 0); 132 133 DEFINE_STUB(spdk_bdev_unmap_blocks, int, 134 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 135 uint64_t offset_blocks, uint64_t num_blocks, 136 spdk_bdev_io_completion_cb cb, void *cb_arg), 137 0); 138 139 DEFINE_STUB(spdk_bdev_io_type_supported, bool, 140 (struct spdk_bdev *bdev, enum spdk_bdev_io_type io_type), false); 141 142 DEFINE_STUB(spdk_bdev_queue_io_wait, int, 143 (struct spdk_bdev *bdev, struct spdk_io_channel *ch, 144 struct spdk_bdev_io_wait_entry *entry), 145 0); 146 147 DEFINE_STUB(spdk_bdev_write_blocks, int, 148 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *buf, 149 uint64_t offset_blocks, uint64_t num_blocks, 150 spdk_bdev_io_completion_cb cb, void *cb_arg), 151 0); 152 153 DEFINE_STUB(spdk_bdev_writev_blocks, int, 154 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 155 struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks, 156 spdk_bdev_io_completion_cb cb, void *cb_arg), 157 0); 158 159 DEFINE_STUB(spdk_bdev_read_blocks, int, 160 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *buf, 161 uint64_t offset_blocks, uint64_t num_blocks, 162 spdk_bdev_io_completion_cb cb, void *cb_arg), 163 0); 164 165 DEFINE_STUB(spdk_bdev_readv_blocks, int, 166 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 167 struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks, 168 spdk_bdev_io_completion_cb cb, void *cb_arg), 169 0); 170 171 DEFINE_STUB(spdk_bdev_write_zeroes_blocks, int, 172 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 173 uint64_t offset_blocks, uint64_t num_blocks, 174 spdk_bdev_io_completion_cb cb, void *cb_arg), 175 0); 176 177 DEFINE_STUB(spdk_bdev_nvme_io_passthru, int, 178 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 179 const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, 180 spdk_bdev_io_completion_cb cb, void *cb_arg), 181 0); 182 183 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *bdev_io)); 184 185 DEFINE_STUB(spdk_nvmf_subsystem_get_nqn, const char *, 186 (const struct spdk_nvmf_subsystem *subsystem), NULL); 187 188 struct spdk_nvmf_ns * 189 spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 190 { 191 abort(); 192 return NULL; 193 } 194 195 struct spdk_nvmf_ns * 196 spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem) 197 { 198 abort(); 199 return NULL; 200 } 201 202 struct spdk_nvmf_ns * 203 spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns) 204 { 205 abort(); 206 return NULL; 207 } 208 209 DEFINE_STUB_V(spdk_bdev_io_get_nvme_status, 210 (const struct spdk_bdev_io *bdev_io, uint32_t *cdw0, int *sct, int *sc)); 211 212 int 213 spdk_dif_ctx_init(struct spdk_dif_ctx *ctx, uint32_t block_size, uint32_t md_size, 214 bool md_interleave, bool dif_loc, enum spdk_dif_type dif_type, uint32_t dif_flags, 215 uint32_t init_ref_tag, uint16_t apptag_mask, uint16_t app_tag, 216 uint32_t data_offset, uint16_t guard_seed) 217 { 218 ctx->block_size = block_size; 219 ctx->md_size = md_size; 220 ctx->init_ref_tag = init_ref_tag; 221 222 return 0; 223 } 224 225 static void 226 test_get_rw_params(void) 227 { 228 struct spdk_nvme_cmd cmd = {0}; 229 uint64_t lba; 230 uint64_t count; 231 232 lba = 0; 233 count = 0; 234 to_le64(&cmd.cdw10, 0x1234567890ABCDEF); 235 to_le32(&cmd.cdw12, 0x9875 | SPDK_NVME_IO_FLAGS_FORCE_UNIT_ACCESS); 236 nvmf_bdev_ctrlr_get_rw_params(&cmd, &lba, &count); 237 CU_ASSERT(lba == 0x1234567890ABCDEF); 238 CU_ASSERT(count == 0x9875 + 1); /* NOTE: this field is 0's based, hence the +1 */ 239 } 240 241 static void 242 test_lba_in_range(void) 243 { 244 /* Trivial cases (no overflow) */ 245 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 0, 1) == true); 246 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 0, 1000) == true); 247 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 0, 1001) == false); 248 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1, 999) == true); 249 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1, 1000) == false); 250 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 999, 1) == true); 251 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1000, 1) == false); 252 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1001, 1) == false); 253 254 /* Overflow edge cases */ 255 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, 0, UINT64_MAX) == true); 256 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, 1, UINT64_MAX) == false); 257 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, UINT64_MAX - 1, 1) == true); 258 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, UINT64_MAX, 1) == false); 259 } 260 261 static void 262 test_get_dif_ctx(void) 263 { 264 struct spdk_bdev bdev = {}; 265 struct spdk_nvme_cmd cmd = {}; 266 struct spdk_dif_ctx dif_ctx = {}; 267 bool ret; 268 269 bdev.md_len = 0; 270 271 ret = nvmf_bdev_ctrlr_get_dif_ctx(&bdev, &cmd, &dif_ctx); 272 CU_ASSERT(ret == false); 273 274 to_le64(&cmd.cdw10, 0x1234567890ABCDEF); 275 bdev.blocklen = 520; 276 bdev.md_len = 8; 277 278 ret = nvmf_bdev_ctrlr_get_dif_ctx(&bdev, &cmd, &dif_ctx); 279 CU_ASSERT(ret == true); 280 CU_ASSERT(dif_ctx.block_size = 520); 281 CU_ASSERT(dif_ctx.md_size == 8); 282 CU_ASSERT(dif_ctx.init_ref_tag == 0x90ABCDEF); 283 } 284 285 static void 286 test_spdk_nvmf_bdev_ctrlr_compare_and_write_cmd(void) 287 { 288 int rc; 289 struct spdk_bdev bdev = {}; 290 struct spdk_bdev_desc *desc = NULL; 291 struct spdk_io_channel ch = {}; 292 293 struct spdk_nvmf_request cmp_req = {}; 294 union nvmf_c2h_msg cmp_rsp = {}; 295 296 struct spdk_nvmf_request write_req = {}; 297 union nvmf_c2h_msg write_rsp = {}; 298 299 struct spdk_nvmf_qpair qpair = {}; 300 301 struct spdk_nvme_cmd cmp_cmd = {}; 302 struct spdk_nvme_cmd write_cmd = {}; 303 304 struct spdk_nvmf_ctrlr ctrlr = {}; 305 struct spdk_nvmf_subsystem subsystem = {}; 306 struct spdk_nvmf_ns ns = {}; 307 struct spdk_nvmf_ns *subsys_ns[1] = {}; 308 309 struct spdk_nvmf_poll_group group = {}; 310 struct spdk_nvmf_subsystem_poll_group sgroups = {}; 311 struct spdk_nvmf_subsystem_pg_ns_info ns_info = {}; 312 313 bdev.blocklen = 512; 314 bdev.num_blocks = 10; 315 ns.bdev = &bdev; 316 317 subsystem.id = 0; 318 subsystem.max_nsid = 1; 319 subsys_ns[0] = &ns; 320 subsystem.ns = (struct spdk_nvmf_ns **)&subsys_ns; 321 322 /* Enable controller */ 323 ctrlr.vcprop.cc.bits.en = 1; 324 ctrlr.subsys = &subsystem; 325 326 group.num_sgroups = 1; 327 sgroups.num_ns = 1; 328 sgroups.ns_info = &ns_info; 329 group.sgroups = &sgroups; 330 331 qpair.ctrlr = &ctrlr; 332 qpair.group = &group; 333 334 cmp_req.qpair = &qpair; 335 cmp_req.cmd = (union nvmf_h2c_msg *)&cmp_cmd; 336 cmp_req.rsp = &cmp_rsp; 337 338 cmp_cmd.nsid = 1; 339 cmp_cmd.fuse = SPDK_NVME_CMD_FUSE_FIRST; 340 cmp_cmd.opc = SPDK_NVME_OPC_COMPARE; 341 342 write_req.qpair = &qpair; 343 write_req.cmd = (union nvmf_h2c_msg *)&write_cmd; 344 write_req.rsp = &write_rsp; 345 346 write_cmd.nsid = 1; 347 write_cmd.fuse = SPDK_NVME_CMD_FUSE_SECOND; 348 write_cmd.opc = SPDK_NVME_OPC_WRITE; 349 350 /* 1. SUCCESS */ 351 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 352 cmp_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 353 354 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 355 write_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 356 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen; 357 358 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 359 360 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS); 361 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 362 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 363 CU_ASSERT(write_rsp.nvme_cpl.status.sct == 0); 364 CU_ASSERT(write_rsp.nvme_cpl.status.sc == 0); 365 366 /* 2. Fused command start lba / num blocks mismatch */ 367 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 368 cmp_cmd.cdw12 = 2; /* NLB: CDW12 bits 15:00, 0's based */ 369 370 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 371 write_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 372 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen; 373 374 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 375 376 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE); 377 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 378 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 379 CU_ASSERT(write_rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 380 CU_ASSERT(write_rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_FIELD); 381 382 /* 3. SPDK_NVME_SC_LBA_OUT_OF_RANGE */ 383 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 384 cmp_cmd.cdw12 = 100; /* NLB: CDW12 bits 15:00, 0's based */ 385 386 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 387 write_cmd.cdw12 = 100; /* NLB: CDW12 bits 15:00, 0's based */ 388 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen; 389 390 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 391 392 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE); 393 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 394 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 395 CU_ASSERT(write_rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 396 CU_ASSERT(write_rsp.nvme_cpl.status.sc == SPDK_NVME_SC_LBA_OUT_OF_RANGE); 397 398 /* 4. SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID */ 399 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 400 cmp_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 401 402 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 403 write_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 404 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen - 1; 405 406 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 407 408 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE); 409 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 410 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 411 CU_ASSERT(write_rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 412 CU_ASSERT(write_rsp.nvme_cpl.status.sc == SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID); 413 } 414 415 int main(int argc, char **argv) 416 { 417 CU_pSuite suite = NULL; 418 unsigned int num_failures; 419 420 CU_set_error_action(CUEA_ABORT); 421 CU_initialize_registry(); 422 423 suite = CU_add_suite("nvmf", NULL, NULL); 424 425 CU_ADD_TEST(suite, test_get_rw_params); 426 CU_ADD_TEST(suite, test_lba_in_range); 427 CU_ADD_TEST(suite, test_get_dif_ctx); 428 429 CU_ADD_TEST(suite, test_spdk_nvmf_bdev_ctrlr_compare_and_write_cmd); 430 431 CU_basic_set_mode(CU_BRM_VERBOSE); 432 CU_basic_run_tests(); 433 num_failures = CU_get_number_of_failures(); 434 CU_cleanup_registry(); 435 return num_failures; 436 } 437