smalloc.c

   1 /*
   2  * simple memory allocator, backed by mmap() so that it hands out memory
   3  * that can be shared across processes and threads
   4  */
   5 #include <sys/mman.h>
   6 #include <assert.h>
   7 #include <string.h>
   8
   9 #include "fio.h"
  10 #include "fio_sem.h"
  11 #include "os/os.h"
  12 #include "smalloc.h"
  13 #include "log.h"
  14
  15 #define SMALLOC_REDZONE         /* define to detect memory corruption */
  16
  17 #define SMALLOC_BPB     32      /* block size, bytes-per-bit in bitmap */
  18 #define SMALLOC_BPI     (sizeof(unsigned int) * 8)
  19 #define SMALLOC_BPL     (SMALLOC_BPB * SMALLOC_BPI)
  20
  21 #define INITIAL_SIZE    16*1024*1024    /* new pool size */
  22 #define INITIAL_POOLS   8               /* maximum number of pools to setup */
  23
  24 #define MAX_POOLS       16
  25
  26 #define SMALLOC_PRE_RED         0xdeadbeefU
  27 #define SMALLOC_POST_RED        0x5aa55aa5U
  28
  29 unsigned int smalloc_pool_size = INITIAL_SIZE;
  30 #ifdef SMALLOC_REDZONE
  31 static const int int_mask = sizeof(int) - 1;
  32 #endif
  33
  34 struct pool {
  35         struct fio_sem *lock;                   /* protects this pool */
  36         void *map;                              /* map of blocks */
  37         unsigned int *bitmap;                   /* blocks free/busy map */
  38         size_t free_blocks;             /* free blocks */
  39         size_t nr_blocks;                       /* total blocks */
  40         size_t next_non_full;
  41         size_t mmap_size;
  42 };
  43
  44 struct block_hdr {
  45         size_t size;
  46 #ifdef SMALLOC_REDZONE
  47         unsigned int prered;
  48 #endif
  49 };
  50
  51 /*
  52  * This suppresses the voluminous potential bitmap printout when
  53  * smalloc encounters an OOM error
  54  */
  55 static const bool enable_smalloc_debug = false;
  56
  57 static struct pool mp[MAX_POOLS];
  58 static unsigned int nr_pools;
  59 static unsigned int last_pool;
  60
  61 static inline int ptr_valid(struct pool *pool, void *ptr)
  62 {
  63         unsigned int pool_size = pool->nr_blocks * SMALLOC_BPL;
  64
  65         return (ptr >= pool->map) && (ptr < pool->map + pool_size);
  66 }
  67
  68 static inline size_t size_to_blocks(size_t size)
  69 {
  70         return (size + SMALLOC_BPB - 1) / SMALLOC_BPB;
  71 }
  72
  73 static int blocks_iter(struct pool *pool, unsigned int pool_idx,
  74                        unsigned int idx, size_t nr_blocks,
  75                        int (*func)(unsigned int *map, unsigned int mask))
  76 {
  77
  78         while (nr_blocks) {
  79                 unsigned int this_blocks, mask;
  80                 unsigned int *map;
  81
  82                 if (pool_idx >= pool->nr_blocks)
  83                         return 0;
  84
  85                 map = &pool->bitmap[pool_idx];
  86
  87                 this_blocks = nr_blocks;
  88                 if (this_blocks + idx > SMALLOC_BPI) {
  89                         this_blocks = SMALLOC_BPI - idx;
  90                         idx = SMALLOC_BPI - this_blocks;
  91                 }
  92
  93                 if (this_blocks == SMALLOC_BPI)
  94                         mask = -1U;
  95                 else
  96                         mask = ((1U << this_blocks) - 1) << idx;
  97
  98                 if (!func(map, mask))
  99                         return 0;
 100
 101                 nr_blocks -= this_blocks;
 102                 idx = 0;
 103                 pool_idx++;
 104         }
 105
 106         return 1;
 107 }
 108
 109 static int mask_cmp(unsigned int *map, unsigned int mask)
 110 {
 111         return !(*map & mask);
 112 }
 113
 114 static int mask_clear(unsigned int *map, unsigned int mask)
 115 {
 116         assert((*map & mask) == mask);
 117         *map &= ~mask;
 118         return 1;
 119 }
 120
 121 static int mask_set(unsigned int *map, unsigned int mask)
 122 {
 123         assert(!(*map & mask));
 124         *map |= mask;
 125         return 1;
 126 }
 127
 128 static int blocks_free(struct pool *pool, unsigned int pool_idx,
 129                        unsigned int idx, size_t nr_blocks)
 130 {
 131         return blocks_iter(pool, pool_idx, idx, nr_blocks, mask_cmp);
 132 }
 133
 134 static void set_blocks(struct pool *pool, unsigned int pool_idx,
 135                        unsigned int idx, size_t nr_blocks)
 136 {
 137         blocks_iter(pool, pool_idx, idx, nr_blocks, mask_set);
 138 }
 139
 140 static void clear_blocks(struct pool *pool, unsigned int pool_idx,
 141                          unsigned int idx, size_t nr_blocks)
 142 {
 143         blocks_iter(pool, pool_idx, idx, nr_blocks, mask_clear);
 144 }
 145
 146 static int find_next_zero(int word, int start)
 147 {
 148         assert(word != -1U);
 149         word >>= start;
 150         return ffz(word) + start;
 151 }
 152
 153 static bool add_pool(struct pool *pool, unsigned int alloc_size)
 154 {
 155         int bitmap_blocks;
 156         int mmap_flags;
 157         void *ptr;
 158
 159         if (nr_pools == MAX_POOLS)
 160                 return false;
 161
 162 #ifdef SMALLOC_REDZONE
 163         alloc_size += sizeof(unsigned int);
 164 #endif
 165         alloc_size += sizeof(struct block_hdr);
 166         if (alloc_size < INITIAL_SIZE)
 167                 alloc_size = INITIAL_SIZE;
 168
 169         /* round up to nearest full number of blocks */
 170         alloc_size = (alloc_size + SMALLOC_BPL - 1) & ~(SMALLOC_BPL - 1);
 171         bitmap_blocks = alloc_size / SMALLOC_BPL;
 172         alloc_size += bitmap_blocks * sizeof(unsigned int);
 173         pool->mmap_size = alloc_size;
 174
 175         pool->nr_blocks = bitmap_blocks;
 176         pool->free_blocks = bitmap_blocks * SMALLOC_BPB;
 177
 178         mmap_flags = OS_MAP_ANON;
 179 #ifdef CONFIG_ESX
 180         mmap_flags |= MAP_PRIVATE;
 181 #else
 182         mmap_flags |= MAP_SHARED;
 183 #endif
 184         ptr = mmap(NULL, alloc_size, PROT_READ|PROT_WRITE, mmap_flags, -1, 0);
 185
 186         if (ptr == MAP_FAILED)
 187                 goto out_fail;
 188
 189         pool->map = ptr;
 190         pool->bitmap = (unsigned int *)((char *) ptr + (pool->nr_blocks * SMALLOC_BPL));
 191         memset(pool->bitmap, 0, bitmap_blocks * sizeof(unsigned int));
 192
 193         pool->lock = fio_sem_init(FIO_SEM_UNLOCKED);
 194         if (!pool->lock)
 195                 goto out_fail;
 196
 197         nr_pools++;
 198         return true;
 199 out_fail:
 200         log_err("smalloc: failed adding pool\n");
 201         if (pool->map)
 202                 munmap(pool->map, pool->mmap_size);
 203         return false;
 204 }
 205
 206 void sinit(void)
 207 {
 208         bool ret;
 209         int i;
 210
 211         for (i = 0; i < INITIAL_POOLS; i++) {
 212                 ret = add_pool(&mp[nr_pools], smalloc_pool_size);
 213                 if (!ret)
 214                         break;
 215         }
 216
 217         /*
 218          * If we added at least one pool, we should be OK for most
 219          * cases.
 220          */
 221         assert(i);
 222 }
 223
 224 static void cleanup_pool(struct pool *pool)
 225 {
 226         /*
 227          * This will also remove the temporary file we used as a backing
 228          * store, it was already unlinked
 229          */
 230         munmap(pool->map, pool->mmap_size);
 231
 232         if (pool->lock)
 233                 fio_sem_remove(pool->lock);
 234 }
 235
 236 void scleanup(void)
 237 {
 238         unsigned int i;
 239
 240         for (i = 0; i < nr_pools; i++)
 241                 cleanup_pool(&mp[i]);
 242 }
 243
 244 #ifdef SMALLOC_REDZONE
 245 static void *postred_ptr(struct block_hdr *hdr)
 246 {
 247         uintptr_t ptr;
 248
 249         ptr = (uintptr_t) hdr + hdr->size - sizeof(unsigned int);
 250         ptr = (uintptr_t) PTR_ALIGN(ptr, int_mask);
 251
 252         return (void *) ptr;
 253 }
 254
 255 static void fill_redzone(struct block_hdr *hdr)
 256 {
 257         unsigned int *postred = postred_ptr(hdr);
 258
 259         hdr->prered = SMALLOC_PRE_RED;
 260         *postred = SMALLOC_POST_RED;
 261 }
 262
 263 static void sfree_check_redzone(struct block_hdr *hdr)
 264 {
 265         unsigned int *postred = postred_ptr(hdr);
 266
 267         if (hdr->prered != SMALLOC_PRE_RED) {
 268                 log_err("smalloc pre redzone destroyed!\n"
 269                         " ptr=%p, prered=%x, expected %x\n",
 270                                 hdr, hdr->prered, SMALLOC_PRE_RED);
 271                 assert(0);
 272         }
 273         if (*postred != SMALLOC_POST_RED) {
 274                 log_err("smalloc post redzone destroyed!\n"
 275                         "  ptr=%p, postred=%x, expected %x\n",
 276                                 hdr, *postred, SMALLOC_POST_RED);
 277                 assert(0);
 278         }
 279 }
 280 #else
 281 static void fill_redzone(struct block_hdr *hdr)
 282 {
 283 }
 284
 285 static void sfree_check_redzone(struct block_hdr *hdr)
 286 {
 287 }
 288 #endif
 289
 290 static void sfree_pool(struct pool *pool, void *ptr)
 291 {
 292         struct block_hdr *hdr;
 293         unsigned int i, idx;
 294         unsigned long offset;
 295
 296         if (!ptr)
 297                 return;
 298
 299         ptr -= sizeof(*hdr);
 300         hdr = ptr;
 301
 302         assert(ptr_valid(pool, ptr));
 303
 304         sfree_check_redzone(hdr);
 305
 306         offset = ptr - pool->map;
 307         i = offset / SMALLOC_BPL;
 308         idx = (offset % SMALLOC_BPL) / SMALLOC_BPB;
 309
 310         fio_sem_down(pool->lock);
 311         clear_blocks(pool, i, idx, size_to_blocks(hdr->size));
 312         if (i < pool->next_non_full)
 313                 pool->next_non_full = i;
 314         pool->free_blocks += size_to_blocks(hdr->size);
 315         fio_sem_up(pool->lock);
 316 }
 317
 318 void sfree(void *ptr)
 319 {
 320         struct pool *pool = NULL;
 321         unsigned int i;
 322
 323         if (!ptr)
 324                 return;
 325
 326         for (i = 0; i < nr_pools; i++) {
 327                 if (ptr_valid(&mp[i], ptr)) {
 328                         pool = &mp[i];
 329                         break;
 330                 }
 331         }
 332
 333         if (pool) {
 334                 sfree_pool(pool, ptr);
 335                 return;
 336         }
 337
 338         log_err("smalloc: ptr %p not from smalloc pool\n", ptr);
 339 }
 340
 341 static unsigned int find_best_index(struct pool *pool)
 342 {
 343         unsigned int i;
 344
 345         assert(pool->free_blocks);
 346
 347         for (i = pool->next_non_full; pool->bitmap[i] == -1U; i++) {
 348                 if (i == pool->nr_blocks - 1) {
 349                         unsigned int j;
 350
 351                         for (j = 0; j < pool->nr_blocks; j++)
 352                                 if (pool->bitmap[j] != -1U)
 353                                         return j;
 354                 }
 355         }
 356
 357         return i;
 358 }
 359
 360 static void *__smalloc_pool(struct pool *pool, size_t size)
 361 {
 362         size_t nr_blocks;
 363         unsigned int i;
 364         unsigned int offset;
 365         unsigned int last_idx;
 366         void *ret = NULL;
 367
 368         fio_sem_down(pool->lock);
 369
 370         nr_blocks = size_to_blocks(size);
 371         if (nr_blocks > pool->free_blocks)
 372                 goto fail;
 373
 374         pool->next_non_full = find_best_index(pool);
 375
 376         last_idx = 0;
 377         offset = -1U;
 378         i = pool->next_non_full;
 379         while (i < pool->nr_blocks) {
 380                 unsigned int idx;
 381
 382                 if (pool->bitmap[i] == -1U) {
 383                         i++;
 384                         last_idx = 0;
 385                         continue;
 386                 }
 387
 388                 idx = find_next_zero(pool->bitmap[i], last_idx);
 389                 if (!blocks_free(pool, i, idx, nr_blocks)) {
 390                         idx += nr_blocks;
 391                         if (idx < SMALLOC_BPI)
 392                                 last_idx = idx;
 393                         else {
 394                                 last_idx = 0;
 395                                 while (idx >= SMALLOC_BPI) {
 396                                         i++;
 397                                         idx -= SMALLOC_BPI;
 398                                 }
 399                         }
 400                         continue;
 401                 }
 402                 set_blocks(pool, i, idx, nr_blocks);
 403                 offset = i * SMALLOC_BPL + idx * SMALLOC_BPB;
 404                 break;
 405         }
 406
 407         if (i < pool->nr_blocks) {
 408                 pool->free_blocks -= nr_blocks;
 409                 ret = pool->map + offset;
 410         }
 411 fail:
 412         fio_sem_up(pool->lock);
 413         return ret;
 414 }
 415
 416 static size_t size_to_alloc_size(size_t size)
 417 {
 418         size_t alloc_size = size + sizeof(struct block_hdr);
 419
 420         /*
 421          * Round to int alignment, so that the postred pointer will
 422          * be naturally aligned as well.
 423          */
 424 #ifdef SMALLOC_REDZONE
 425         alloc_size += sizeof(unsigned int);
 426         alloc_size = (alloc_size + int_mask) & ~int_mask;
 427 #endif
 428
 429         return alloc_size;
 430 }
 431
 432 static void *smalloc_pool(struct pool *pool, size_t size)
 433 {
 434         size_t alloc_size = size_to_alloc_size(size);
 435         void *ptr;
 436
 437         ptr = __smalloc_pool(pool, alloc_size);
 438         if (ptr) {
 439                 struct block_hdr *hdr = ptr;
 440
 441                 hdr->size = alloc_size;
 442                 fill_redzone(hdr);
 443
 444                 ptr += sizeof(*hdr);
 445                 memset(ptr, 0, size);
 446         }
 447
 448         return ptr;
 449 }
 450
 451 static void smalloc_print_bitmap(struct pool *pool)
 452 {
 453         size_t nr_blocks = pool->nr_blocks;
 454         unsigned int *bitmap = pool->bitmap;
 455         unsigned int i, j;
 456         char *buffer;
 457
 458         if (!enable_smalloc_debug)
 459                 return;
 460
 461         buffer = malloc(SMALLOC_BPI + 1);
 462         if (!buffer)
 463                 return;
 464         buffer[SMALLOC_BPI] = '\0';
 465
 466         for (i = 0; i < nr_blocks; i++) {
 467                 unsigned int line = bitmap[i];
 468
 469                 /* skip completely full lines */
 470                 if (line == -1U)
 471                         continue;
 472
 473                 for (j = 0; j < SMALLOC_BPI; j++)
 474                         if ((1 << j) & line)
 475                                 buffer[SMALLOC_BPI-1-j] = '1';
 476                         else
 477                                 buffer[SMALLOC_BPI-1-j] = '0';
 478
 479                 log_err("smalloc: bitmap %5u, %s\n", i, buffer);
 480         }
 481
 482         free(buffer);
 483 }
 484
 485 void smalloc_debug(size_t size)
 486 {
 487         unsigned int i;
 488         size_t alloc_size = size_to_alloc_size(size);
 489         size_t alloc_blocks;
 490
 491         alloc_blocks = size_to_blocks(alloc_size);
 492
 493         if (size)
 494                 log_err("smalloc: size = %lu, alloc_size = %lu, blocks = %lu\n",
 495                         (unsigned long) size, (unsigned long) alloc_size,
 496                         (unsigned long) alloc_blocks);
 497         for (i = 0; i < nr_pools; i++) {
 498                 log_err("smalloc: pool %u, free/total blocks %u/%u\n", i,
 499                         (unsigned int) (mp[i].free_blocks),
 500                         (unsigned int) (mp[i].nr_blocks*sizeof(unsigned int)*8));
 501                 if (size && mp[i].free_blocks >= alloc_blocks) {
 502                         void *ptr = smalloc_pool(&mp[i], size);
 503                         if (ptr) {
 504                                 sfree(ptr);
 505                                 last_pool = i;
 506                                 log_err("smalloc: smalloc_pool %u succeeded\n", i);
 507                         } else {
 508                                 log_err("smalloc: smalloc_pool %u failed\n", i);
 509                                 log_err("smalloc: next_non_full=%u, nr_blocks=%u\n",
 510                                         (unsigned int) mp[i].next_non_full, (unsigned int) mp[i].nr_blocks);
 511                                 smalloc_print_bitmap(&mp[i]);
 512                         }
 513                 }
 514         }
 515 }
 516
 517 void *smalloc(size_t size)
 518 {
 519         unsigned int i, end_pool;
 520
 521         if (size != (unsigned int) size)
 522                 return NULL;
 523
 524         i = last_pool;
 525         end_pool = nr_pools;
 526
 527         do {
 528                 for (; i < end_pool; i++) {
 529                         void *ptr = smalloc_pool(&mp[i], size);
 530
 531                         if (ptr) {
 532                                 last_pool = i;
 533                                 return ptr;
 534                         }
 535                 }
 536                 if (last_pool) {
 537                         end_pool = last_pool;
 538                         last_pool = i = 0;
 539                         continue;
 540                 }
 541
 542                 break;
 543         } while (1);
 544
 545         log_err("smalloc: OOM. Consider using --alloc-size to increase the "
 546                 "shared memory available.\n");
 547         smalloc_debug(size);
 548         return NULL;
 549 }
 550
 551 void *scalloc(size_t nmemb, size_t size)
 552 {
 553         return smalloc(nmemb * size);
 554 }
 555
 556 char *smalloc_strdup(const char *str)
 557 {
 558         char *ptr = NULL;
 559
 560         ptr = smalloc(strlen(str) + 1);
 561         if (ptr)
 562                 strcpy(ptr, str);
 563         return ptr;
 564 }