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 free(buf); 157 } 158 159 void 160 spdk_dma_free(void *buf) 161 { 162 return spdk_free(buf); 163 } 164 165 #ifndef UNIT_TEST_NO_VTOPHYS 166 DEFINE_RETURN_MOCK(spdk_vtophys, uint64_t); 167 uint64_t 168 spdk_vtophys(void *buf, uint64_t *size) 169 { 170 HANDLE_RETURN_MOCK(spdk_vtophys); 171 172 return (uintptr_t)buf; 173 } 174 #endif 175 176 void 177 spdk_memzone_dump(FILE *f) 178 { 179 return; 180 } 181 182 DEFINE_RETURN_MOCK(spdk_memzone_free, int); 183 int 184 spdk_memzone_free(const char *name) 185 { 186 HANDLE_RETURN_MOCK(spdk_memzone_free); 187 188 return 0; 189 } 190 191 struct test_mempool { 192 size_t count; 193 size_t ele_size; 194 }; 195 196 DEFINE_RETURN_MOCK(spdk_mempool_create, struct spdk_mempool *); 197 struct spdk_mempool * 198 spdk_mempool_create(const char *name, size_t count, 199 size_t ele_size, size_t cache_size, int socket_id) 200 { 201 struct test_mempool *mp; 202 203 HANDLE_RETURN_MOCK(spdk_mempool_create); 204 205 mp = calloc(1, sizeof(*mp)); 206 if (mp == NULL) { 207 return NULL; 208 } 209 210 mp->count = count; 211 mp->ele_size = ele_size; 212 213 return (struct spdk_mempool *)mp; 214 } 215 216 void 217 spdk_mempool_free(struct spdk_mempool *_mp) 218 { 219 struct test_mempool *mp = (struct test_mempool *)_mp; 220 221 free(mp); 222 } 223 224 DEFINE_RETURN_MOCK(spdk_mempool_get, void *); 225 void * 226 spdk_mempool_get(struct spdk_mempool *_mp) 227 { 228 struct test_mempool *mp = (struct test_mempool *)_mp; 229 size_t ele_size = 0x10000; 230 void *buf; 231 232 HANDLE_RETURN_MOCK(spdk_mempool_get); 233 234 if (mp && mp->count == 0) { 235 return NULL; 236 } 237 238 if (mp) { 239 ele_size = mp->ele_size; 240 } 241 242 if (posix_memalign(&buf, 64, spdk_align32pow2(ele_size))) { 243 return NULL; 244 } else { 245 if (mp) { 246 mp->count--; 247 } 248 return buf; 249 } 250 } 251 252 int 253 spdk_mempool_get_bulk(struct spdk_mempool *mp, void **ele_arr, size_t count) 254 { 255 for (size_t i = 0; i < count; i++) { 256 ele_arr[i] = spdk_mempool_get(mp); 257 if (ele_arr[i] == NULL) { 258 return -1; 259 } 260 } 261 return 0; 262 } 263 264 void 265 spdk_mempool_put(struct spdk_mempool *_mp, void *ele) 266 { 267 struct test_mempool *mp = (struct test_mempool *)_mp; 268 269 if (mp) { 270 mp->count++; 271 } 272 free(ele); 273 } 274 275 void 276 spdk_mempool_put_bulk(struct spdk_mempool *mp, void **ele_arr, size_t count) 277 { 278 for (size_t i = 0; i < count; i++) { 279 spdk_mempool_put(mp, ele_arr[i]); 280 } 281 } 282 283 DEFINE_RETURN_MOCK(spdk_mempool_count, size_t); 284 size_t 285 spdk_mempool_count(const struct spdk_mempool *_mp) 286 { 287 struct test_mempool *mp = (struct test_mempool *)_mp; 288 289 HANDLE_RETURN_MOCK(spdk_mempool_count); 290 291 if (mp) { 292 return mp->count; 293 } else { 294 return 1024; 295 } 296 } 297 298 struct spdk_ring_ele { 299 void *ele; 300 TAILQ_ENTRY(spdk_ring_ele) link; 301 }; 302 303 struct spdk_ring { 304 TAILQ_HEAD(, spdk_ring_ele) elements; 305 pthread_mutex_t lock; 306 size_t count; 307 }; 308 309 DEFINE_RETURN_MOCK(spdk_ring_create, struct spdk_ring *); 310 struct spdk_ring * 311 spdk_ring_create(enum spdk_ring_type type, size_t count, int socket_id) 312 { 313 struct spdk_ring *ring; 314 315 HANDLE_RETURN_MOCK(spdk_ring_create); 316 317 ring = calloc(1, sizeof(*ring)); 318 if (!ring) { 319 return NULL; 320 } 321 322 if (pthread_mutex_init(&ring->lock, NULL)) { 323 free(ring); 324 return NULL; 325 } 326 327 TAILQ_INIT(&ring->elements); 328 return ring; 329 } 330 331 void 332 spdk_ring_free(struct spdk_ring *ring) 333 { 334 struct spdk_ring_ele *ele, *tmp; 335 336 if (!ring) { 337 return; 338 } 339 340 TAILQ_FOREACH_SAFE(ele, &ring->elements, link, tmp) { 341 free(ele); 342 } 343 344 pthread_mutex_destroy(&ring->lock); 345 free(ring); 346 } 347 348 DEFINE_RETURN_MOCK(spdk_ring_enqueue, size_t); 349 size_t 350 spdk_ring_enqueue(struct spdk_ring *ring, void **objs, size_t count) 351 { 352 struct spdk_ring_ele *ele; 353 size_t i; 354 355 HANDLE_RETURN_MOCK(spdk_ring_enqueue); 356 357 pthread_mutex_lock(&ring->lock); 358 359 for (i = 0; i < count; i++) { 360 ele = calloc(1, sizeof(*ele)); 361 if (!ele) { 362 break; 363 } 364 365 ele->ele = objs[i]; 366 TAILQ_INSERT_TAIL(&ring->elements, ele, link); 367 ring->count++; 368 } 369 370 pthread_mutex_unlock(&ring->lock); 371 return i; 372 } 373 374 DEFINE_RETURN_MOCK(spdk_ring_dequeue, size_t); 375 size_t 376 spdk_ring_dequeue(struct spdk_ring *ring, void **objs, size_t count) 377 { 378 struct spdk_ring_ele *ele, *tmp; 379 size_t i = 0; 380 381 HANDLE_RETURN_MOCK(spdk_ring_dequeue); 382 383 if (count == 0) { 384 return 0; 385 } 386 387 pthread_mutex_lock(&ring->lock); 388 389 TAILQ_FOREACH_SAFE(ele, &ring->elements, link, tmp) { 390 TAILQ_REMOVE(&ring->elements, ele, link); 391 ring->count--; 392 objs[i] = ele->ele; 393 free(ele); 394 i++; 395 if (i >= count) { 396 break; 397 } 398 } 399 400 pthread_mutex_unlock(&ring->lock); 401 return i; 402 403 } 404 405 406 DEFINE_RETURN_MOCK(spdk_ring_count, size_t); 407 size_t 408 spdk_ring_count(struct spdk_ring *ring) 409 { 410 HANDLE_RETURN_MOCK(spdk_ring_count); 411 return ring->count; 412 } 413 414 DEFINE_RETURN_MOCK(spdk_get_ticks, uint64_t); 415 uint64_t 416 spdk_get_ticks(void) 417 { 418 HANDLE_RETURN_MOCK(spdk_get_ticks); 419 420 return ut_spdk_get_ticks; 421 } 422 423 DEFINE_RETURN_MOCK(spdk_get_ticks_hz, uint64_t); 424 uint64_t 425 spdk_get_ticks_hz(void) 426 { 427 HANDLE_RETURN_MOCK(spdk_get_ticks_hz); 428 429 return 1000000; 430 } 431 432 void 433 spdk_delay_us(unsigned int us) 434 { 435 /* spdk_get_ticks_hz is 1000000, meaning 1 tick per us. */ 436 ut_spdk_get_ticks += us; 437 } 438 439 #ifndef UNIT_TEST_NO_PCI_ADDR 440 DEFINE_RETURN_MOCK(spdk_pci_addr_parse, int); 441 int 442 spdk_pci_addr_parse(struct spdk_pci_addr *addr, const char *bdf) 443 { 444 unsigned domain, bus, dev, func; 445 446 HANDLE_RETURN_MOCK(spdk_pci_addr_parse); 447 448 if (addr == NULL || bdf == NULL) { 449 return -EINVAL; 450 } 451 452 if ((sscanf(bdf, "%x:%x:%x.%x", &domain, &bus, &dev, &func) == 4) || 453 (sscanf(bdf, "%x.%x.%x.%x", &domain, &bus, &dev, &func) == 4)) { 454 /* Matched a full address - all variables are initialized */ 455 } else if (sscanf(bdf, "%x:%x:%x", &domain, &bus, &dev) == 3) { 456 func = 0; 457 } else if ((sscanf(bdf, "%x:%x.%x", &bus, &dev, &func) == 3) || 458 (sscanf(bdf, "%x.%x.%x", &bus, &dev, &func) == 3)) { 459 domain = 0; 460 } else if ((sscanf(bdf, "%x:%x", &bus, &dev) == 2) || 461 (sscanf(bdf, "%x.%x", &bus, &dev) == 2)) { 462 domain = 0; 463 func = 0; 464 } else { 465 return -EINVAL; 466 } 467 468 if (bus > 0xFF || dev > 0x1F || func > 7) { 469 return -EINVAL; 470 } 471 472 addr->domain = domain; 473 addr->bus = bus; 474 addr->dev = dev; 475 addr->func = func; 476 477 return 0; 478 } 479 480 DEFINE_RETURN_MOCK(spdk_pci_addr_fmt, int); 481 int 482 spdk_pci_addr_fmt(char *bdf, size_t sz, const struct spdk_pci_addr *addr) 483 { 484 int rc; 485 486 HANDLE_RETURN_MOCK(spdk_pci_addr_fmt); 487 488 rc = snprintf(bdf, sz, "%04x:%02x:%02x.%x", 489 addr->domain, addr->bus, 490 addr->dev, addr->func); 491 492 if (rc > 0 && (size_t)rc < sz) { 493 return 0; 494 } 495 496 return -1; 497 } 498 499 DEFINE_RETURN_MOCK(spdk_pci_addr_compare, int); 500 int 501 spdk_pci_addr_compare(const struct spdk_pci_addr *a1, const struct spdk_pci_addr *a2) 502 { 503 HANDLE_RETURN_MOCK(spdk_pci_addr_compare); 504 505 if (a1->domain > a2->domain) { 506 return 1; 507 } else if (a1->domain < a2->domain) { 508 return -1; 509 } else if (a1->bus > a2->bus) { 510 return 1; 511 } else if (a1->bus < a2->bus) { 512 return -1; 513 } else if (a1->dev > a2->dev) { 514 return 1; 515 } else if (a1->dev < a2->dev) { 516 return -1; 517 } else if (a1->func > a2->func) { 518 return 1; 519 } else if (a1->func < a2->func) { 520 return -1; 521 } 522 523 return 0; 524 } 525 #endif 526