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 firstfree(struct pool *pool)
 342 {
 343         unsigned int i;
 344
 345         for (i = 0; i < pool->nr_blocks; i++)
 346                 if (pool->bitmap[i] != -1U)
 347                         return i;
 348
 349         assert(0);
 350 }
 351
 352 static void *__smalloc_pool(struct pool *pool, size_t size)
 353 {
 354         size_t nr_blocks;
 355         unsigned int i;
 356         unsigned int offset;
 357         unsigned int last_idx;
 358         void *ret = NULL;
 359
 360         fio_sem_down(pool->lock);
 361
 362         nr_blocks = size_to_blocks(size);
 363         if (nr_blocks > pool->free_blocks)
 364                 goto fail;
 365
 366         for (i = pool->next_non_full; pool->bitmap[i] == -1U; i++)
 367                 if (i == pool->nr_blocks - 1) {
 368                         i = firstfree(pool);
 369                         break;
 370                 }
 371
 372         pool->next_non_full = i;
 373
 374         last_idx = 0;
 375         offset = -1U;
 376         while (i < pool->nr_blocks) {
 377                 unsigned int idx;
 378
 379                 if (pool->bitmap[i] == -1U) {
 380                         i++;
 381                         last_idx = 0;
 382                         continue;
 383                 }
 384
 385                 idx = find_next_zero(pool->bitmap[i], last_idx);
 386                 if (!blocks_free(pool, i, idx, nr_blocks)) {
 387                         idx += nr_blocks;
 388                         if (idx < SMALLOC_BPI)
 389                                 last_idx = idx;
 390                         else {
 391                                 last_idx = 0;
 392                                 while (idx >= SMALLOC_BPI) {
 393                                         i++;
 394                                         idx -= SMALLOC_BPI;
 395                                 }
 396                         }
 397                         continue;
 398                 }
 399                 set_blocks(pool, i, idx, nr_blocks);
 400                 offset = i * SMALLOC_BPL + idx * SMALLOC_BPB;
 401                 break;
 402         }
 403
 404         if (i < pool->nr_blocks) {
 405                 pool->free_blocks -= nr_blocks;
 406                 ret = pool->map + offset;
 407         }
 408 fail:
 409         fio_sem_up(pool->lock);
 410         return ret;
 411 }
 412
 413 static size_t size_to_alloc_size(size_t size)
 414 {
 415         size_t alloc_size = size + sizeof(struct block_hdr);
 416
 417         /*
 418          * Round to int alignment, so that the postred pointer will
 419          * be naturally aligned as well.
 420          */
 421 #ifdef SMALLOC_REDZONE
 422         alloc_size += sizeof(unsigned int);
 423         alloc_size = (alloc_size + int_mask) & ~int_mask;
 424 #endif
 425
 426         return alloc_size;
 427 }
 428
 429 static void *smalloc_pool(struct pool *pool, size_t size)
 430 {
 431         size_t alloc_size = size_to_alloc_size(size);
 432         void *ptr;
 433
 434         ptr = __smalloc_pool(pool, alloc_size);
 435         if (ptr) {
 436                 struct block_hdr *hdr = ptr;
 437
 438                 hdr->size = alloc_size;
 439                 fill_redzone(hdr);
 440
 441                 ptr += sizeof(*hdr);
 442                 memset(ptr, 0, size);
 443         }
 444
 445         return ptr;
 446 }
 447
 448 static void smalloc_print_bitmap(struct pool *pool)
 449 {
 450         size_t nr_blocks = pool->nr_blocks;
 451         unsigned int *bitmap = pool->bitmap;
 452         unsigned int i, j;
 453         char *buffer;
 454
 455         if (!enable_smalloc_debug)
 456                 return;
 457
 458         buffer = malloc(SMALLOC_BPI + 1);
 459         if (!buffer)
 460                 return;
 461         buffer[SMALLOC_BPI] = '\0';
 462
 463         for (i = 0; i < nr_blocks; i++) {
 464                 unsigned int line = bitmap[i];
 465
 466                 /* skip completely full lines */
 467                 if (line == -1U)
 468                         continue;
 469
 470                 for (j = 0; j < SMALLOC_BPI; j++)
 471                         if ((1 << j) & line)
 472                                 buffer[SMALLOC_BPI-1-j] = '1';
 473                         else
 474                                 buffer[SMALLOC_BPI-1-j] = '0';
 475
 476                 log_err("smalloc: bitmap %5u, %s\n", i, buffer);
 477         }
 478
 479         free(buffer);
 480 }
 481
 482 void smalloc_debug(size_t size)
 483 {
 484         unsigned int i;
 485         size_t alloc_size = size_to_alloc_size(size);
 486         size_t alloc_blocks;
 487
 488         alloc_blocks = size_to_blocks(alloc_size);
 489
 490         if (size)
 491                 log_err("smalloc: size = %lu, alloc_size = %lu, blocks = %lu\n",
 492                         (unsigned long) size, (unsigned long) alloc_size,
 493                         (unsigned long) alloc_blocks);
 494         for (i = 0; i < nr_pools; i++) {
 495                 log_err("smalloc: pool %u, free/total blocks %u/%u\n", i,
 496                         (unsigned int) (mp[i].free_blocks),
 497                         (unsigned int) (mp[i].nr_blocks*sizeof(unsigned int)*8));
 498                 if (size && mp[i].free_blocks >= alloc_blocks) {
 499                         void *ptr = smalloc_pool(&mp[i], size);
 500                         if (ptr) {
 501                                 sfree(ptr);
 502                                 last_pool = i;
 503                                 log_err("smalloc: smalloc_pool %u succeeded\n", i);
 504                         } else {
 505                                 log_err("smalloc: smalloc_pool %u failed\n", i);
 506                                 log_err("smalloc: next_non_full=%u, nr_blocks=%u\n",
 507                                         (unsigned int) mp[i].next_non_full, (unsigned int) mp[i].nr_blocks);
 508                                 smalloc_print_bitmap(&mp[i]);
 509                         }
 510                 }
 511         }
 512 }
 513
 514 void *smalloc(size_t size)
 515 {
 516         unsigned int i, end_pool;
 517
 518         if (size != (unsigned int) size)
 519                 return NULL;
 520
 521         i = last_pool;
 522         end_pool = nr_pools;
 523
 524         do {
 525                 for (; i < end_pool; i++) {
 526                         void *ptr = smalloc_pool(&mp[i], size);
 527
 528                         if (ptr) {
 529                                 last_pool = i;
 530                                 return ptr;
 531                         }
 532                 }
 533                 if (last_pool) {
 534                         end_pool = last_pool;
 535                         last_pool = i = 0;
 536                         continue;
 537                 }
 538
 539                 break;
 540         } while (1);
 541
 542         log_err("smalloc: OOM. Consider using --alloc-size to increase the "
 543                 "shared memory available.\n");
 544         smalloc_debug(size);
 545         return NULL;
 546 }
 547
 548 void *scalloc(size_t nmemb, size_t size)
 549 {
 550         return smalloc(nmemb * size);
 551 }
 552
 553 char *smalloc_strdup(const char *str)
 554 {
 555         char *ptr = NULL;
 556
 557         ptr = smalloc(strlen(str) + 1);
 558         if (ptr)
 559                 strcpy(ptr, str);
 560         return ptr;
 561 }