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