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", SPDK_LOG_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 struct spdk_bdev { 50 uint32_t blocklen; 51 uint64_t num_blocks; 52 uint32_t md_len; 53 }; 54 55 uint32_t 56 spdk_bdev_get_block_size(const struct spdk_bdev *bdev) 57 { 58 return bdev->blocklen; 59 } 60 61 uint64_t 62 spdk_bdev_get_num_blocks(const struct spdk_bdev *bdev) 63 { 64 return bdev->num_blocks; 65 } 66 67 uint32_t 68 spdk_bdev_get_optimal_io_boundary(const struct spdk_bdev *bdev) 69 { 70 abort(); 71 return 0; 72 } 73 74 uint32_t 75 spdk_bdev_get_md_size(const struct spdk_bdev *bdev) 76 { 77 return bdev->md_len; 78 } 79 80 DEFINE_STUB(spdk_bdev_comparev_and_writev_blocks, int, 81 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 82 struct iovec *compare_iov, int compare_iovcnt, 83 struct iovec *write_iov, int write_iovcnt, 84 uint64_t offset_blocks, uint64_t num_blocks, 85 spdk_bdev_io_completion_cb cb, void *cb_arg), 86 0); 87 88 DEFINE_STUB(nvmf_ctrlr_process_io_cmd, int, (struct spdk_nvmf_request *req), 0); 89 90 DEFINE_STUB_V(spdk_bdev_io_get_nvme_fused_status, (const struct spdk_bdev_io *bdev_io, 91 uint32_t *cdw0, int *cmp_sct, int *cmp_sc, int *wr_sct, int *wr_sc)); 92 93 DEFINE_STUB(spdk_bdev_is_md_interleaved, bool, (const struct spdk_bdev *bdev), false); 94 95 DEFINE_STUB(spdk_bdev_get_dif_type, enum spdk_dif_type, 96 (const struct spdk_bdev *bdev), SPDK_DIF_DISABLE); 97 98 DEFINE_STUB(spdk_bdev_is_dif_head_of_md, bool, (const struct spdk_bdev *bdev), false); 99 100 DEFINE_STUB(spdk_bdev_is_dif_check_enabled, bool, 101 (const struct spdk_bdev *bdev, enum spdk_dif_check_type check_type), false); 102 103 DEFINE_STUB(spdk_bdev_get_io_channel, struct spdk_io_channel *, 104 (struct spdk_bdev_desc *desc), NULL); 105 106 DEFINE_STUB(spdk_bdev_flush_blocks, int, 107 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 108 uint64_t offset_blocks, uint64_t num_blocks, 109 spdk_bdev_io_completion_cb cb, void *cb_arg), 110 0); 111 112 DEFINE_STUB(spdk_bdev_unmap_blocks, int, 113 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 114 uint64_t offset_blocks, uint64_t num_blocks, 115 spdk_bdev_io_completion_cb cb, void *cb_arg), 116 0); 117 118 DEFINE_STUB(spdk_bdev_io_type_supported, bool, 119 (struct spdk_bdev *bdev, enum spdk_bdev_io_type io_type), false); 120 121 DEFINE_STUB(spdk_bdev_queue_io_wait, int, 122 (struct spdk_bdev *bdev, struct spdk_io_channel *ch, 123 struct spdk_bdev_io_wait_entry *entry), 124 0); 125 126 DEFINE_STUB(spdk_bdev_write_blocks, int, 127 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *buf, 128 uint64_t offset_blocks, uint64_t num_blocks, 129 spdk_bdev_io_completion_cb cb, void *cb_arg), 130 0); 131 132 DEFINE_STUB(spdk_bdev_writev_blocks, int, 133 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 134 struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks, 135 spdk_bdev_io_completion_cb cb, void *cb_arg), 136 0); 137 138 DEFINE_STUB(spdk_bdev_read_blocks, int, 139 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, void *buf, 140 uint64_t offset_blocks, uint64_t num_blocks, 141 spdk_bdev_io_completion_cb cb, void *cb_arg), 142 0); 143 144 DEFINE_STUB(spdk_bdev_readv_blocks, int, 145 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 146 struct iovec *iov, int iovcnt, uint64_t offset_blocks, uint64_t num_blocks, 147 spdk_bdev_io_completion_cb cb, void *cb_arg), 148 0); 149 150 DEFINE_STUB(spdk_bdev_write_zeroes_blocks, int, 151 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 152 uint64_t offset_blocks, uint64_t num_blocks, 153 spdk_bdev_io_completion_cb cb, void *cb_arg), 154 0); 155 156 DEFINE_STUB(spdk_bdev_nvme_io_passthru, int, 157 (struct spdk_bdev_desc *desc, struct spdk_io_channel *ch, 158 const struct spdk_nvme_cmd *cmd, void *buf, size_t nbytes, 159 spdk_bdev_io_completion_cb cb, void *cb_arg), 160 0); 161 162 DEFINE_STUB_V(spdk_bdev_free_io, (struct spdk_bdev_io *bdev_io)); 163 164 DEFINE_STUB(spdk_nvmf_subsystem_get_nqn, const char *, 165 (const struct spdk_nvmf_subsystem *subsystem), NULL); 166 167 struct spdk_nvmf_ns * 168 spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid) 169 { 170 abort(); 171 return NULL; 172 } 173 174 struct spdk_nvmf_ns * 175 spdk_nvmf_subsystem_get_first_ns(struct spdk_nvmf_subsystem *subsystem) 176 { 177 abort(); 178 return NULL; 179 } 180 181 struct spdk_nvmf_ns * 182 spdk_nvmf_subsystem_get_next_ns(struct spdk_nvmf_subsystem *subsystem, struct spdk_nvmf_ns *prev_ns) 183 { 184 abort(); 185 return NULL; 186 } 187 188 DEFINE_STUB_V(spdk_bdev_io_get_nvme_status, 189 (const struct spdk_bdev_io *bdev_io, uint32_t *cdw0, int *sct, int *sc)); 190 191 int 192 spdk_dif_ctx_init(struct spdk_dif_ctx *ctx, uint32_t block_size, uint32_t md_size, 193 bool md_interleave, bool dif_loc, enum spdk_dif_type dif_type, uint32_t dif_flags, 194 uint32_t init_ref_tag, uint16_t apptag_mask, uint16_t app_tag, 195 uint32_t data_offset, uint16_t guard_seed) 196 { 197 ctx->block_size = block_size; 198 ctx->md_size = md_size; 199 ctx->init_ref_tag = init_ref_tag; 200 201 return 0; 202 } 203 204 static void 205 test_get_rw_params(void) 206 { 207 struct spdk_nvme_cmd cmd = {0}; 208 uint64_t lba; 209 uint64_t count; 210 211 lba = 0; 212 count = 0; 213 to_le64(&cmd.cdw10, 0x1234567890ABCDEF); 214 to_le32(&cmd.cdw12, 0x9875 | SPDK_NVME_IO_FLAGS_FORCE_UNIT_ACCESS); 215 nvmf_bdev_ctrlr_get_rw_params(&cmd, &lba, &count); 216 CU_ASSERT(lba == 0x1234567890ABCDEF); 217 CU_ASSERT(count == 0x9875 + 1); /* NOTE: this field is 0's based, hence the +1 */ 218 } 219 220 static void 221 test_lba_in_range(void) 222 { 223 /* Trivial cases (no overflow) */ 224 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 0, 1) == true); 225 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 0, 1000) == true); 226 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 0, 1001) == false); 227 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1, 999) == true); 228 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1, 1000) == false); 229 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 999, 1) == true); 230 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1000, 1) == false); 231 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(1000, 1001, 1) == false); 232 233 /* Overflow edge cases */ 234 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, 0, UINT64_MAX) == true); 235 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, 1, UINT64_MAX) == false); 236 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, UINT64_MAX - 1, 1) == true); 237 CU_ASSERT(nvmf_bdev_ctrlr_lba_in_range(UINT64_MAX, UINT64_MAX, 1) == false); 238 } 239 240 static void 241 test_get_dif_ctx(void) 242 { 243 struct spdk_bdev bdev = {}; 244 struct spdk_nvme_cmd cmd = {}; 245 struct spdk_dif_ctx dif_ctx = {}; 246 bool ret; 247 248 bdev.md_len = 0; 249 250 ret = nvmf_bdev_ctrlr_get_dif_ctx(&bdev, &cmd, &dif_ctx); 251 CU_ASSERT(ret == false); 252 253 to_le64(&cmd.cdw10, 0x1234567890ABCDEF); 254 bdev.blocklen = 520; 255 bdev.md_len = 8; 256 257 ret = nvmf_bdev_ctrlr_get_dif_ctx(&bdev, &cmd, &dif_ctx); 258 CU_ASSERT(ret == true); 259 CU_ASSERT(dif_ctx.block_size = 520); 260 CU_ASSERT(dif_ctx.md_size == 8); 261 CU_ASSERT(dif_ctx.init_ref_tag == 0x90ABCDEF); 262 } 263 264 static void 265 test_spdk_nvmf_bdev_ctrlr_compare_and_write_cmd(void) 266 { 267 int rc; 268 struct spdk_bdev bdev = {}; 269 struct spdk_bdev_desc *desc = NULL; 270 struct spdk_io_channel ch = {}; 271 272 struct spdk_nvmf_request cmp_req = {}; 273 union nvmf_c2h_msg cmp_rsp = {}; 274 275 struct spdk_nvmf_request write_req = {}; 276 union nvmf_c2h_msg write_rsp = {}; 277 278 struct spdk_nvmf_qpair qpair = {}; 279 280 struct spdk_nvme_cmd cmp_cmd = {}; 281 struct spdk_nvme_cmd write_cmd = {}; 282 283 struct spdk_nvmf_ctrlr ctrlr = {}; 284 struct spdk_nvmf_subsystem subsystem = {}; 285 struct spdk_nvmf_ns ns = {}; 286 struct spdk_nvmf_ns *subsys_ns[1] = {}; 287 288 struct spdk_nvmf_poll_group group = {}; 289 struct spdk_nvmf_subsystem_poll_group sgroups = {}; 290 struct spdk_nvmf_subsystem_pg_ns_info ns_info = {}; 291 292 bdev.blocklen = 512; 293 bdev.num_blocks = 10; 294 ns.bdev = &bdev; 295 296 subsystem.id = 0; 297 subsystem.max_nsid = 1; 298 subsys_ns[0] = &ns; 299 subsystem.ns = (struct spdk_nvmf_ns **)&subsys_ns; 300 301 /* Enable controller */ 302 ctrlr.vcprop.cc.bits.en = 1; 303 ctrlr.subsys = &subsystem; 304 305 group.num_sgroups = 1; 306 sgroups.num_ns = 1; 307 sgroups.ns_info = &ns_info; 308 group.sgroups = &sgroups; 309 310 qpair.ctrlr = &ctrlr; 311 qpair.group = &group; 312 313 cmp_req.qpair = &qpair; 314 cmp_req.cmd = (union nvmf_h2c_msg *)&cmp_cmd; 315 cmp_req.rsp = &cmp_rsp; 316 317 cmp_cmd.nsid = 1; 318 cmp_cmd.fuse = SPDK_NVME_CMD_FUSE_FIRST; 319 cmp_cmd.opc = SPDK_NVME_OPC_COMPARE; 320 321 write_req.qpair = &qpair; 322 write_req.cmd = (union nvmf_h2c_msg *)&write_cmd; 323 write_req.rsp = &write_rsp; 324 325 write_cmd.nsid = 1; 326 write_cmd.fuse = SPDK_NVME_CMD_FUSE_SECOND; 327 write_cmd.opc = SPDK_NVME_OPC_WRITE; 328 329 /* 1. SUCCESS */ 330 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 331 cmp_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 332 333 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 334 write_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 335 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen; 336 337 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 338 339 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS); 340 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 341 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 342 CU_ASSERT(write_rsp.nvme_cpl.status.sct == 0); 343 CU_ASSERT(write_rsp.nvme_cpl.status.sc == 0); 344 345 /* 2. Fused command start lba / num blocks mismatch */ 346 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 347 cmp_cmd.cdw12 = 2; /* NLB: CDW12 bits 15:00, 0's based */ 348 349 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 350 write_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 351 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen; 352 353 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 354 355 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE); 356 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 357 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 358 CU_ASSERT(write_rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 359 CU_ASSERT(write_rsp.nvme_cpl.status.sc == SPDK_NVME_SC_INVALID_FIELD); 360 361 /* 3. SPDK_NVME_SC_LBA_OUT_OF_RANGE */ 362 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 363 cmp_cmd.cdw12 = 100; /* NLB: CDW12 bits 15:00, 0's based */ 364 365 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 366 write_cmd.cdw12 = 100; /* NLB: CDW12 bits 15:00, 0's based */ 367 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen; 368 369 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 370 371 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE); 372 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 373 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 374 CU_ASSERT(write_rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 375 CU_ASSERT(write_rsp.nvme_cpl.status.sc == SPDK_NVME_SC_LBA_OUT_OF_RANGE); 376 377 /* 4. SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID */ 378 cmp_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 379 cmp_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 380 381 write_cmd.cdw10 = 1; /* SLBA: CDW10 and CDW11 */ 382 write_cmd.cdw12 = 1; /* NLB: CDW12 bits 15:00, 0's based */ 383 write_req.length = (write_cmd.cdw12 + 1) * bdev.blocklen - 1; 384 385 rc = nvmf_bdev_ctrlr_compare_and_write_cmd(&bdev, desc, &ch, &cmp_req, &write_req); 386 387 CU_ASSERT(rc == SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE); 388 CU_ASSERT(cmp_rsp.nvme_cpl.status.sct == 0); 389 CU_ASSERT(cmp_rsp.nvme_cpl.status.sc == 0); 390 CU_ASSERT(write_rsp.nvme_cpl.status.sct == SPDK_NVME_SCT_GENERIC); 391 CU_ASSERT(write_rsp.nvme_cpl.status.sc == SPDK_NVME_SC_DATA_SGL_LENGTH_INVALID); 392 } 393 394 int main(int argc, char **argv) 395 { 396 CU_pSuite suite = NULL; 397 unsigned int num_failures; 398 399 CU_set_error_action(CUEA_ABORT); 400 CU_initialize_registry(); 401 402 suite = CU_add_suite("nvmf", NULL, NULL); 403 404 CU_ADD_TEST(suite, test_get_rw_params); 405 CU_ADD_TEST(suite, test_lba_in_range); 406 CU_ADD_TEST(suite, test_get_dif_ctx); 407 408 CU_ADD_TEST(suite, test_spdk_nvmf_bdev_ctrlr_compare_and_write_cmd); 409 410 CU_basic_set_mode(CU_BRM_VERBOSE); 411 CU_basic_run_tests(); 412 num_failures = CU_get_number_of_failures(); 413 CU_cleanup_registry(); 414 return num_failures; 415 } 416