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_internal/mock.h" 37 38 #include "spdk/env.h" 39 #include "spdk/queue.h" 40 #include "spdk/util.h" 41 42 static uint32_t g_ut_num_cores; 43 static bool *g_ut_cores; 44 45 void allocate_cores(uint32_t num_cores); 46 void free_cores(void); 47 48 DEFINE_STUB(spdk_process_is_primary, bool, (void), true) 49 DEFINE_STUB(spdk_memzone_lookup, void *, (const char *name), NULL) 50 DEFINE_STUB_V(spdk_pci_driver_register, (const char *name, struct spdk_pci_id *id_table, 51 uint32_t flags)); 52 DEFINE_STUB(spdk_pci_nvme_get_driver, struct spdk_pci_driver *, (void), NULL) 53 DEFINE_STUB(spdk_pci_ioat_get_driver, struct spdk_pci_driver *, (void), NULL) 54 DEFINE_STUB(spdk_pci_virtio_get_driver, struct spdk_pci_driver *, (void), NULL) 55 DEFINE_STUB(spdk_env_thread_launch_pinned, int, (uint32_t core, thread_start_fn fn, void *arg), 0); 56 DEFINE_STUB_V(spdk_env_thread_wait_all, (void)); 57 DEFINE_STUB_V(spdk_env_opts_init, (struct spdk_env_opts *opts)); 58 DEFINE_STUB(spdk_env_init, int, (const struct spdk_env_opts *opts), 0); 59 DEFINE_STUB_V(spdk_env_fini, (void)); 60 61 void 62 allocate_cores(uint32_t num_cores) 63 { 64 uint32_t i; 65 66 g_ut_num_cores = num_cores; 67 68 g_ut_cores = calloc(num_cores, sizeof(bool)); 69 assert(g_ut_cores != NULL); 70 71 for (i = 0; i < num_cores; i++) { 72 g_ut_cores[i] = true; 73 } 74 } 75 76 void 77 free_cores(void) 78 { 79 free(g_ut_cores); 80 g_ut_cores = NULL; 81 g_ut_num_cores = 0; 82 } 83 84 static uint32_t 85 ut_get_next_core(uint32_t i) 86 { 87 i++; 88 89 while (i < g_ut_num_cores) { 90 if (!g_ut_cores[i]) { 91 i++; 92 continue; 93 } 94 break; 95 } 96 97 if (i < g_ut_num_cores) { 98 return i; 99 } else { 100 return UINT32_MAX; 101 } 102 } 103 104 uint32_t 105 spdk_env_get_first_core(void) 106 { 107 return ut_get_next_core(-1); 108 } 109 110 uint32_t 111 spdk_env_get_next_core(uint32_t prev_core) 112 { 113 return ut_get_next_core(prev_core); 114 } 115 116 uint32_t 117 spdk_env_get_core_count(void) 118 { 119 return g_ut_num_cores; 120 } 121 122 uint32_t 123 spdk_env_get_last_core(void) 124 { 125 uint32_t i; 126 uint32_t last_core = UINT32_MAX; 127 128 SPDK_ENV_FOREACH_CORE(i) { 129 last_core = i; 130 } 131 132 return last_core; 133 } 134 135 DEFINE_RETURN_MOCK(spdk_env_get_current_core, uint32_t); 136 uint32_t 137 spdk_env_get_current_core(void) 138 { 139 HANDLE_RETURN_MOCK(spdk_env_get_current_core); 140 141 return UINT32_MAX; 142 } 143 144 DEFINE_RETURN_MOCK(spdk_env_get_socket_id, uint32_t); 145 uint32_t 146 spdk_env_get_socket_id(uint32_t core) 147 { 148 HANDLE_RETURN_MOCK(spdk_env_get_socket_id); 149 150 return SPDK_ENV_SOCKET_ID_ANY; 151 } 152 153 /* 154 * These mocks don't use the DEFINE_STUB macros because 155 * their default implementation is more complex. 156 */ 157 158 DEFINE_RETURN_MOCK(spdk_memzone_reserve, void *); 159 void * 160 spdk_memzone_reserve(const char *name, size_t len, int socket_id, unsigned flags) 161 { 162 HANDLE_RETURN_MOCK(spdk_memzone_reserve); 163 164 return malloc(len); 165 } 166 167 DEFINE_RETURN_MOCK(spdk_memzone_reserve_aligned, void *); 168 void * 169 spdk_memzone_reserve_aligned(const char *name, size_t len, int socket_id, 170 unsigned flags, unsigned align) 171 { 172 HANDLE_RETURN_MOCK(spdk_memzone_reserve_aligned); 173 174 return malloc(len); 175 } 176 177 DEFINE_RETURN_MOCK(spdk_malloc, void *); 178 void * 179 spdk_malloc(size_t size, size_t align, uint64_t *phys_addr, int socket_id, uint32_t flags) 180 { 181 HANDLE_RETURN_MOCK(spdk_malloc); 182 183 void *buf = NULL; 184 185 if (align == 0) { 186 align = 8; 187 } 188 189 if (posix_memalign(&buf, align, size)) { 190 return NULL; 191 } 192 if (phys_addr) { 193 *phys_addr = (uint64_t)buf; 194 } 195 196 return buf; 197 } 198 199 DEFINE_RETURN_MOCK(spdk_zmalloc, void *); 200 void * 201 spdk_zmalloc(size_t size, size_t align, uint64_t *phys_addr, int socket_id, uint32_t flags) 202 { 203 HANDLE_RETURN_MOCK(spdk_zmalloc); 204 205 void *buf = spdk_malloc(size, align, phys_addr, -1, 1); 206 207 if (buf != NULL) { 208 memset(buf, 0, size); 209 } 210 return buf; 211 } 212 213 DEFINE_RETURN_MOCK(spdk_dma_malloc, void *); 214 void * 215 spdk_dma_malloc(size_t size, size_t align, uint64_t *phys_addr) 216 { 217 HANDLE_RETURN_MOCK(spdk_dma_malloc); 218 219 return spdk_malloc(size, align, phys_addr, -1, 1); 220 } 221 222 DEFINE_RETURN_MOCK(spdk_realloc, void *); 223 void * 224 spdk_realloc(void *buf, size_t size, size_t align) 225 { 226 HANDLE_RETURN_MOCK(spdk_realloc); 227 228 return realloc(buf, size); 229 } 230 231 DEFINE_RETURN_MOCK(spdk_dma_zmalloc, void *); 232 void * 233 spdk_dma_zmalloc(size_t size, size_t align, uint64_t *phys_addr) 234 { 235 HANDLE_RETURN_MOCK(spdk_dma_zmalloc); 236 237 return spdk_zmalloc(size, align, phys_addr, -1, 1); 238 } 239 240 DEFINE_RETURN_MOCK(spdk_dma_malloc_socket, void *); 241 void * 242 spdk_dma_malloc_socket(size_t size, size_t align, uint64_t *phys_addr, int socket_id) 243 { 244 HANDLE_RETURN_MOCK(spdk_dma_malloc_socket); 245 246 return spdk_dma_malloc(size, align, phys_addr); 247 } 248 249 DEFINE_RETURN_MOCK(spdk_dma_zmalloc_socket, void *); 250 void * 251 spdk_dma_zmalloc_socket(size_t size, size_t align, uint64_t *phys_addr, int socket_id) 252 { 253 HANDLE_RETURN_MOCK(spdk_dma_zmalloc_socket); 254 255 return spdk_dma_zmalloc(size, align, phys_addr); 256 } 257 258 DEFINE_RETURN_MOCK(spdk_dma_realloc, void *); 259 void * 260 spdk_dma_realloc(void *buf, size_t size, size_t align, uint64_t *phys_addr) 261 { 262 HANDLE_RETURN_MOCK(spdk_dma_realloc); 263 264 return realloc(buf, size); 265 } 266 267 void 268 spdk_free(void *buf) 269 { 270 /* fix for false-positives in *certain* static analysis tools. */ 271 assert((uintptr_t)buf != UINTPTR_MAX); 272 free(buf); 273 } 274 275 void 276 spdk_dma_free(void *buf) 277 { 278 return spdk_free(buf); 279 } 280 281 #ifndef UNIT_TEST_NO_VTOPHYS 282 DEFINE_RETURN_MOCK(spdk_vtophys, uint64_t); 283 uint64_t 284 spdk_vtophys(const void *buf, uint64_t *size) 285 { 286 HANDLE_RETURN_MOCK(spdk_vtophys); 287 288 return (uintptr_t)buf; 289 } 290 #endif 291 292 void 293 spdk_memzone_dump(FILE *f) 294 { 295 return; 296 } 297 298 DEFINE_RETURN_MOCK(spdk_memzone_free, int); 299 int 300 spdk_memzone_free(const char *name) 301 { 302 HANDLE_RETURN_MOCK(spdk_memzone_free); 303 304 return 0; 305 } 306 307 struct test_mempool { 308 size_t count; 309 size_t ele_size; 310 }; 311 312 DEFINE_RETURN_MOCK(spdk_mempool_create, struct spdk_mempool *); 313 struct spdk_mempool * 314 spdk_mempool_create(const char *name, size_t count, 315 size_t ele_size, size_t cache_size, int socket_id) 316 { 317 struct test_mempool *mp; 318 319 HANDLE_RETURN_MOCK(spdk_mempool_create); 320 321 mp = calloc(1, sizeof(*mp)); 322 if (mp == NULL) { 323 return NULL; 324 } 325 326 mp->count = count; 327 mp->ele_size = ele_size; 328 329 return (struct spdk_mempool *)mp; 330 } 331 332 void 333 spdk_mempool_free(struct spdk_mempool *_mp) 334 { 335 struct test_mempool *mp = (struct test_mempool *)_mp; 336 337 free(mp); 338 } 339 340 DEFINE_RETURN_MOCK(spdk_mempool_get, void *); 341 void * 342 spdk_mempool_get(struct spdk_mempool *_mp) 343 { 344 struct test_mempool *mp = (struct test_mempool *)_mp; 345 size_t ele_size = 0x10000; 346 void *buf; 347 348 HANDLE_RETURN_MOCK(spdk_mempool_get); 349 350 if (mp && mp->count == 0) { 351 return NULL; 352 } 353 354 if (mp) { 355 ele_size = mp->ele_size; 356 } 357 358 if (posix_memalign(&buf, 64, spdk_align32pow2(ele_size))) { 359 return NULL; 360 } else { 361 if (mp) { 362 mp->count--; 363 } 364 return buf; 365 } 366 } 367 368 int 369 spdk_mempool_get_bulk(struct spdk_mempool *mp, void **ele_arr, size_t count) 370 { 371 for (size_t i = 0; i < count; i++) { 372 ele_arr[i] = spdk_mempool_get(mp); 373 if (ele_arr[i] == NULL) { 374 return -1; 375 } 376 } 377 return 0; 378 } 379 380 void 381 spdk_mempool_put(struct spdk_mempool *_mp, void *ele) 382 { 383 struct test_mempool *mp = (struct test_mempool *)_mp; 384 385 if (mp) { 386 mp->count++; 387 } 388 free(ele); 389 } 390 391 void 392 spdk_mempool_put_bulk(struct spdk_mempool *mp, void **ele_arr, size_t count) 393 { 394 for (size_t i = 0; i < count; i++) { 395 spdk_mempool_put(mp, ele_arr[i]); 396 } 397 } 398 399 DEFINE_RETURN_MOCK(spdk_mempool_count, size_t); 400 size_t 401 spdk_mempool_count(const struct spdk_mempool *_mp) 402 { 403 struct test_mempool *mp = (struct test_mempool *)_mp; 404 405 HANDLE_RETURN_MOCK(spdk_mempool_count); 406 407 if (mp) { 408 return mp->count; 409 } else { 410 return 1024; 411 } 412 } 413 414 struct spdk_ring_ele { 415 void *ele; 416 TAILQ_ENTRY(spdk_ring_ele) link; 417 }; 418 419 struct spdk_ring { 420 TAILQ_HEAD(, spdk_ring_ele) elements; 421 pthread_mutex_t lock; 422 size_t count; 423 }; 424 425 DEFINE_RETURN_MOCK(spdk_ring_create, struct spdk_ring *); 426 struct spdk_ring * 427 spdk_ring_create(enum spdk_ring_type type, size_t count, int socket_id) 428 { 429 struct spdk_ring *ring; 430 431 HANDLE_RETURN_MOCK(spdk_ring_create); 432 433 ring = calloc(1, sizeof(*ring)); 434 if (!ring) { 435 return NULL; 436 } 437 438 if (pthread_mutex_init(&ring->lock, NULL)) { 439 free(ring); 440 return NULL; 441 } 442 443 TAILQ_INIT(&ring->elements); 444 return ring; 445 } 446 447 void 448 spdk_ring_free(struct spdk_ring *ring) 449 { 450 struct spdk_ring_ele *ele, *tmp; 451 452 if (!ring) { 453 return; 454 } 455 456 TAILQ_FOREACH_SAFE(ele, &ring->elements, link, tmp) { 457 free(ele); 458 } 459 460 pthread_mutex_destroy(&ring->lock); 461 free(ring); 462 } 463 464 DEFINE_RETURN_MOCK(spdk_ring_enqueue, size_t); 465 size_t 466 spdk_ring_enqueue(struct spdk_ring *ring, void **objs, size_t count, 467 size_t *free_space) 468 { 469 struct spdk_ring_ele *ele; 470 size_t i; 471 472 HANDLE_RETURN_MOCK(spdk_ring_enqueue); 473 474 pthread_mutex_lock(&ring->lock); 475 476 for (i = 0; i < count; i++) { 477 ele = calloc(1, sizeof(*ele)); 478 if (!ele) { 479 break; 480 } 481 482 ele->ele = objs[i]; 483 TAILQ_INSERT_TAIL(&ring->elements, ele, link); 484 ring->count++; 485 } 486 487 pthread_mutex_unlock(&ring->lock); 488 return i; 489 } 490 491 DEFINE_RETURN_MOCK(spdk_ring_dequeue, size_t); 492 size_t 493 spdk_ring_dequeue(struct spdk_ring *ring, void **objs, size_t count) 494 { 495 struct spdk_ring_ele *ele, *tmp; 496 size_t i = 0; 497 498 HANDLE_RETURN_MOCK(spdk_ring_dequeue); 499 500 if (count == 0) { 501 return 0; 502 } 503 504 pthread_mutex_lock(&ring->lock); 505 506 TAILQ_FOREACH_SAFE(ele, &ring->elements, link, tmp) { 507 TAILQ_REMOVE(&ring->elements, ele, link); 508 ring->count--; 509 objs[i] = ele->ele; 510 free(ele); 511 i++; 512 if (i >= count) { 513 break; 514 } 515 } 516 517 pthread_mutex_unlock(&ring->lock); 518 return i; 519 520 } 521 522 523 DEFINE_RETURN_MOCK(spdk_ring_count, size_t); 524 size_t 525 spdk_ring_count(struct spdk_ring *ring) 526 { 527 HANDLE_RETURN_MOCK(spdk_ring_count); 528 return ring->count; 529 } 530 531 DEFINE_RETURN_MOCK(spdk_get_ticks, uint64_t); 532 uint64_t 533 spdk_get_ticks(void) 534 { 535 HANDLE_RETURN_MOCK(spdk_get_ticks); 536 537 return ut_spdk_get_ticks; 538 } 539 540 DEFINE_RETURN_MOCK(spdk_get_ticks_hz, uint64_t); 541 uint64_t 542 spdk_get_ticks_hz(void) 543 { 544 HANDLE_RETURN_MOCK(spdk_get_ticks_hz); 545 546 return 1000000; 547 } 548 549 void 550 spdk_delay_us(unsigned int us) 551 { 552 /* spdk_get_ticks_hz is 1000000, meaning 1 tick per us. */ 553 ut_spdk_get_ticks += us; 554 } 555 556 #ifndef UNIT_TEST_NO_PCI_ADDR 557 DEFINE_RETURN_MOCK(spdk_pci_addr_parse, int); 558 int 559 spdk_pci_addr_parse(struct spdk_pci_addr *addr, const char *bdf) 560 { 561 unsigned domain, bus, dev, func; 562 563 HANDLE_RETURN_MOCK(spdk_pci_addr_parse); 564 565 if (addr == NULL || bdf == NULL) { 566 return -EINVAL; 567 } 568 569 if ((sscanf(bdf, "%x:%x:%x.%x", &domain, &bus, &dev, &func) == 4) || 570 (sscanf(bdf, "%x.%x.%x.%x", &domain, &bus, &dev, &func) == 4)) { 571 /* Matched a full address - all variables are initialized */ 572 } else if (sscanf(bdf, "%x:%x:%x", &domain, &bus, &dev) == 3) { 573 func = 0; 574 } else if ((sscanf(bdf, "%x:%x.%x", &bus, &dev, &func) == 3) || 575 (sscanf(bdf, "%x.%x.%x", &bus, &dev, &func) == 3)) { 576 domain = 0; 577 } else if ((sscanf(bdf, "%x:%x", &bus, &dev) == 2) || 578 (sscanf(bdf, "%x.%x", &bus, &dev) == 2)) { 579 domain = 0; 580 func = 0; 581 } else { 582 return -EINVAL; 583 } 584 585 if (bus > 0xFF || dev > 0x1F || func > 7) { 586 return -EINVAL; 587 } 588 589 addr->domain = domain; 590 addr->bus = bus; 591 addr->dev = dev; 592 addr->func = func; 593 594 return 0; 595 } 596 597 DEFINE_RETURN_MOCK(spdk_pci_addr_fmt, int); 598 int 599 spdk_pci_addr_fmt(char *bdf, size_t sz, const struct spdk_pci_addr *addr) 600 { 601 int rc; 602 603 HANDLE_RETURN_MOCK(spdk_pci_addr_fmt); 604 605 rc = snprintf(bdf, sz, "%04x:%02x:%02x.%x", 606 addr->domain, addr->bus, 607 addr->dev, addr->func); 608 609 if (rc > 0 && (size_t)rc < sz) { 610 return 0; 611 } 612 613 return -1; 614 } 615 616 DEFINE_RETURN_MOCK(spdk_pci_addr_compare, int); 617 int 618 spdk_pci_addr_compare(const struct spdk_pci_addr *a1, const struct spdk_pci_addr *a2) 619 { 620 HANDLE_RETURN_MOCK(spdk_pci_addr_compare); 621 622 if (a1->domain > a2->domain) { 623 return 1; 624 } else if (a1->domain < a2->domain) { 625 return -1; 626 } else if (a1->bus > a2->bus) { 627 return 1; 628 } else if (a1->bus < a2->bus) { 629 return -1; 630 } else if (a1->dev > a2->dev) { 631 return 1; 632 } else if (a1->dev < a2->dev) { 633 return -1; 634 } else if (a1->func > a2->func) { 635 return 1; 636 } else if (a1->func < a2->func) { 637 return -1; 638 } 639 640 return 0; 641 } 642 #endif 643