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