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 <stdio.h>
   7 #include <stdlib.h>
   8 #include <assert.h>
   9 #include <string.h>
  10 #include <unistd.h>
  11 #include <sys/types.h>
  12 #include <limits.h>
  13
  14 #include "mutex.h"
  15
  16 #define MP_SAFE                 /* define to make thread safe */
  17 #define SMALLOC_REDZONE         /* define to detect memory corruption */
  18
  19 #define SMALLOC_BPB     32      /* block size, bytes-per-bit in bitmap */
  20 #define SMALLOC_BPI     (sizeof(unsigned int) * 8)
  21 #define SMALLOC_BPL     (SMALLOC_BPB * SMALLOC_BPI)
  22
  23 #define INITIAL_SIZE    1024*1024       /* new pool size */
  24 #define MAX_POOLS       4               /* maximum number of pools to setup */
  25
  26 #define SMALLOC_PRE_RED         0xdeadbeefU
  27 #define SMALLOC_POST_RED        0x5aa55aa5U
  28
  29 unsigned int smalloc_pool_size = INITIAL_SIZE;
  30
  31 struct pool {
  32         struct fio_mutex *lock;                 /* protects this pool */
  33         void *map;                              /* map of blocks */
  34         unsigned int *bitmap;                   /* blocks free/busy map */
  35         unsigned int free_blocks;               /* free blocks */
  36         unsigned int nr_blocks;                 /* total blocks */
  37         unsigned int next_non_full;
  38         int fd;                                 /* memory backing fd */
  39         char file[PATH_MAX];                    /* filename for fd */
  40         unsigned int mmap_size;
  41 };
  42
  43 struct block_hdr {
  44         unsigned int size;
  45 #ifdef SMALLOC_REDZONE
  46         unsigned int prered;
  47 #endif
  48 };
  49
  50 static struct pool mp[MAX_POOLS];
  51 static unsigned int nr_pools;
  52 static unsigned int last_pool;
  53 static struct fio_mutex *lock;
  54
  55 static inline void pool_lock(struct pool *pool)
  56 {
  57         if (pool->lock)
  58                 fio_mutex_down(pool->lock);
  59 }
  60
  61 static inline void pool_unlock(struct pool *pool)
  62 {
  63         if (pool->lock)
  64                 fio_mutex_up(pool->lock);
  65 }
  66
  67 static inline void global_read_lock(void)
  68 {
  69         if (lock)
  70                 fio_mutex_down_read(lock);
  71 }
  72
  73 static inline void global_read_unlock(void)
  74 {
  75         if (lock)
  76                 fio_mutex_up_read(lock);
  77 }
  78
  79 static inline void global_write_lock(void)
  80 {
  81         if (lock)
  82                 fio_mutex_down_write(lock);
  83 }
  84
  85 static inline void global_write_unlock(void)
  86 {
  87         if (lock)
  88                 fio_mutex_up_write(lock);
  89 }
  90
  91 static inline int ptr_valid(struct pool *pool, void *ptr)
  92 {
  93         unsigned int pool_size = pool->nr_blocks * SMALLOC_BPL;
  94
  95         return (ptr >= pool->map) && (ptr < pool->map + pool_size);
  96 }
  97
  98 static int blocks_iter(unsigned int *map, unsigned int idx,
  99                        unsigned int nr_blocks,
 100                        int (*func)(unsigned int *map, unsigned int mask))
 101 {
 102         while (nr_blocks) {
 103                 unsigned int this_blocks, mask;
 104
 105                 this_blocks = nr_blocks;
 106                 if (this_blocks + idx > SMALLOC_BPI) {
 107                         this_blocks = SMALLOC_BPI - idx;
 108                         idx = SMALLOC_BPI - this_blocks;
 109                 }
 110
 111                 if (this_blocks == SMALLOC_BPI)
 112                         mask = -1U;
 113                 else
 114                         mask = ((1U << this_blocks) - 1) << idx;
 115
 116                 if (!func(map, mask))
 117                         return 0;
 118
 119                 nr_blocks -= this_blocks;
 120                 idx = 0;
 121                 map++;
 122         }
 123
 124         return 1;
 125 }
 126
 127 static int mask_cmp(unsigned int *map, unsigned int mask)
 128 {
 129         return !(*map & mask);
 130 }
 131
 132 static int mask_clear(unsigned int *map, unsigned int mask)
 133 {
 134         *map &= ~mask;
 135         return 1;
 136 }
 137
 138 static int mask_set(unsigned int *map, unsigned int mask)
 139 {
 140         *map |= mask;
 141         return 1;
 142 }
 143
 144 static int blocks_free(unsigned int *map, unsigned int idx,
 145                        unsigned int nr_blocks)
 146 {
 147         return blocks_iter(map, idx, nr_blocks, mask_cmp);
 148 }
 149
 150 static void set_blocks(unsigned int *map, unsigned int idx,
 151                        unsigned int nr_blocks)
 152 {
 153         blocks_iter(map, idx, nr_blocks, mask_set);
 154 }
 155
 156 static void clear_blocks(unsigned int *map, unsigned int idx,
 157                          unsigned int nr_blocks)
 158 {
 159         blocks_iter(map, idx, nr_blocks, mask_clear);
 160 }
 161
 162 static inline int __ffs(int word)
 163 {
 164         int r = 0;
 165
 166         if (!(word & 0xffff)) {
 167                 word >>= 16;
 168                 r += 16;
 169         }
 170         if (!(word & 0xff)) {
 171                 word >>= 8;
 172                 r += 8;
 173         }
 174         if (!(word & 0xf)) {
 175                 word >>= 4;
 176                 r += 4;
 177         }
 178         if (!(word & 3)) {
 179                 word >>= 2;
 180                 r += 2;
 181         }
 182         if (!(word & 1)) {
 183                 word >>= 1;
 184                 r += 1;
 185         }
 186
 187         return r;
 188 }
 189
 190 static int find_next_zero(int word, int start)
 191 {
 192         assert(word != -1U);
 193         word >>= (start + 1);
 194         return __ffs(~word) + start + 1;
 195 }
 196
 197 static int add_pool(struct pool *pool, unsigned int alloc_size)
 198 {
 199         void *ptr;
 200         int fd, bitmap_blocks;
 201
 202         strcpy(pool->file, "/tmp/.fio_smalloc.XXXXXX");
 203         fd = mkstemp(pool->file);
 204         if (fd < 0)
 205                 goto out_close;
 206
 207 #ifdef SMALLOC_REDZONE
 208         alloc_size += sizeof(unsigned int);
 209 #endif
 210         alloc_size += sizeof(struct block_hdr);
 211         if (alloc_size < INITIAL_SIZE)
 212                 alloc_size = INITIAL_SIZE;
 213
 214         /* round up to nearest full number of blocks */
 215         alloc_size = (alloc_size + SMALLOC_BPL - 1) & ~(SMALLOC_BPL - 1);
 216         bitmap_blocks = alloc_size / SMALLOC_BPL;
 217         alloc_size += bitmap_blocks * sizeof(unsigned int);
 218         pool->mmap_size = alloc_size;
 219
 220         pool->nr_blocks = bitmap_blocks;
 221         pool->free_blocks = bitmap_blocks * SMALLOC_BPB;
 222
 223         if (ftruncate(fd, alloc_size) < 0)
 224                 goto out_unlink;
 225
 226         ptr = mmap(NULL, alloc_size, PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
 227         if (ptr == MAP_FAILED)
 228                 goto out_unlink;
 229
 230         memset(ptr, 0, alloc_size);
 231         pool->map = ptr;
 232         pool->bitmap = (void *) ptr + (pool->nr_blocks * SMALLOC_BPL);
 233
 234 #ifdef MP_SAFE
 235         pool->lock = fio_mutex_init(1);
 236         if (!pool->lock)
 237                 goto out_unlink;
 238 #endif
 239
 240         pool->fd = fd;
 241
 242         global_write_lock();
 243         nr_pools++;
 244         global_write_unlock();
 245         return 0;
 246 out_unlink:
 247         fprintf(stderr, "smalloc: failed adding pool\n");
 248         if (pool->map)
 249                 munmap(pool->map, pool->mmap_size);
 250         unlink(pool->file);
 251 out_close:
 252         if (fd >= 0)
 253                 close(fd);
 254         return 1;
 255 }
 256
 257 void sinit(void)
 258 {
 259         int ret;
 260
 261 #ifdef MP_SAFE
 262         lock = fio_mutex_rw_init();
 263 #endif
 264         ret = add_pool(&mp[0], INITIAL_SIZE);
 265         assert(!ret);
 266 }
 267
 268 static void cleanup_pool(struct pool *pool)
 269 {
 270         unlink(pool->file);
 271         close(pool->fd);
 272         munmap(pool->map, pool->mmap_size);
 273
 274         if (pool->lock)
 275                 fio_mutex_remove(pool->lock);
 276 }
 277
 278 void scleanup(void)
 279 {
 280         unsigned int i;
 281
 282         for (i = 0; i < nr_pools; i++)
 283                 cleanup_pool(&mp[i]);
 284
 285         if (lock)
 286                 fio_mutex_remove(lock);
 287 }
 288
 289 static void fill_redzone(struct block_hdr *hdr)
 290 {
 291 #ifdef SMALLOC_REDZONE
 292         unsigned int *postred = (void *) hdr + hdr->size - sizeof(unsigned int);
 293
 294         hdr->prered = SMALLOC_PRE_RED;
 295         *postred = SMALLOC_POST_RED;
 296 #endif
 297 }
 298
 299 static void sfree_check_redzone(struct block_hdr *hdr)
 300 {
 301 #ifdef SMALLOC_REDZONE
 302         unsigned int *postred = (void *) hdr + hdr->size - sizeof(unsigned int);
 303
 304         if (hdr->prered != SMALLOC_PRE_RED) {
 305                 fprintf(stderr, "smalloc pre redzone destroyed!\n");
 306                 fprintf(stderr, "  ptr=%p, prered=%x, expected %x\n",
 307                                 hdr, hdr->prered, SMALLOC_PRE_RED);
 308                 assert(0);
 309         }
 310         if (*postred != SMALLOC_POST_RED) {
 311                 fprintf(stderr, "smalloc post redzone destroyed!\n");
 312                 fprintf(stderr, "  ptr=%p, postred=%x, expected %x\n",
 313                                 hdr, *postred, SMALLOC_POST_RED);
 314                 assert(0);
 315         }
 316 #endif
 317 }
 318
 319 static void sfree_pool(struct pool *pool, void *ptr)
 320 {
 321         struct block_hdr *hdr;
 322         unsigned int i, idx;
 323         unsigned long offset;
 324
 325         if (!ptr)
 326                 return;
 327
 328         ptr -= sizeof(*hdr);
 329         hdr = ptr;
 330
 331         assert(ptr_valid(pool, ptr));
 332
 333         sfree_check_redzone(hdr);
 334
 335         offset = ptr - pool->map;
 336         i = offset / SMALLOC_BPL;
 337         idx = (offset % SMALLOC_BPL) / SMALLOC_BPB;
 338
 339         pool_lock(pool);
 340         clear_blocks(&pool->bitmap[i], idx, size_to_blocks(hdr->size));
 341         if (i < pool->next_non_full)
 342                 pool->next_non_full = i;
 343         pool->free_blocks += size_to_blocks(hdr->size);
 344         pool_unlock(pool);
 345 }
 346
 347 void sfree(void *ptr)
 348 {
 349         struct pool *pool = NULL;
 350         unsigned int i;
 351
 352         if (!ptr)
 353                 return;
 354
 355         global_read_lock();
 356
 357         for (i = 0; i < nr_pools; i++) {
 358                 if (ptr_valid(&mp[i], ptr)) {
 359                         pool = &mp[i];
 360                         break;
 361                 }
 362         }
 363
 364         global_read_unlock();
 365
 366         assert(pool);
 367         sfree_pool(pool, ptr);
 368 }
 369
 370 static inline unsigned int size_to_blocks(unsigned int size)
 371 {
 372         return (size + SMALLOC_BPB - 1) / SMALLOC_BPB;
 373 }
 374
 375 static void *__smalloc_pool(struct pool *pool, unsigned int size)
 376 {
 377         unsigned int nr_blocks;
 378         unsigned int i;
 379         unsigned int offset;
 380         unsigned int last_idx;
 381         void *ret = NULL;
 382
 383         pool_lock(pool);
 384
 385         nr_blocks = size_to_blocks(size);
 386         if (nr_blocks > pool->free_blocks)
 387                 goto fail;
 388
 389         i = pool->next_non_full;
 390         last_idx = 0;
 391         offset = -1U;
 392         while (i < pool->nr_blocks) {
 393                 unsigned int idx;
 394
 395                 if (pool->bitmap[i] == -1U) {
 396                         i++;
 397                         pool->next_non_full = i;
 398                         last_idx = 0;
 399                         continue;
 400                 }
 401
 402                 idx = find_next_zero(pool->bitmap[i], last_idx);
 403                 if (!blocks_free(&pool->bitmap[i], idx, nr_blocks)) {
 404                         idx += nr_blocks;
 405                         if (idx < SMALLOC_BPI)
 406                                 last_idx = idx;
 407                         else {
 408                                 last_idx = 0;
 409                                 while (idx >= SMALLOC_BPI) {
 410                                         i++;
 411                                         idx -= SMALLOC_BPI;
 412                                 }
 413                         }
 414                         continue;
 415                 }
 416                 set_blocks(&pool->bitmap[i], idx, nr_blocks);
 417                 offset = i * SMALLOC_BPL + idx * SMALLOC_BPB;
 418                 break;
 419         }
 420
 421         if (i < pool->nr_blocks) {
 422                 pool->free_blocks -= nr_blocks;
 423                 ret = pool->map + offset;
 424         }
 425 fail:
 426         pool_unlock(pool);
 427         return ret;
 428 }
 429
 430 static void *smalloc_pool(struct pool *pool, unsigned int size)
 431 {
 432         struct block_hdr *hdr;
 433         unsigned int alloc_size;
 434         void *ptr;
 435
 436         alloc_size = size + sizeof(*hdr);
 437 #ifdef SMALLOC_REDZONE
 438         alloc_size += sizeof(unsigned int);
 439 #endif
 440
 441         ptr = __smalloc_pool(pool, alloc_size);
 442         if (!ptr) {
 443                 printf("failed allocating %u\n", alloc_size);
 444                 return NULL;
 445         }
 446
 447         hdr = ptr;
 448         hdr->size = alloc_size;
 449         ptr += sizeof(*hdr);
 450
 451         fill_redzone(hdr);
 452
 453         memset(ptr, 0, size);
 454         return ptr;
 455 }
 456
 457 void *smalloc(unsigned int size)
 458 {
 459         unsigned int i;
 460
 461         global_read_lock();
 462         i = last_pool;
 463
 464         do {
 465                 for (; i < nr_pools; i++) {
 466                         void *ptr = smalloc_pool(&mp[i], size);
 467
 468                         if (ptr) {
 469                                 last_pool = i;
 470                                 global_read_unlock();
 471                                 return ptr;
 472                         }
 473                 }
 474                 if (last_pool) {
 475                         last_pool = 0;
 476                         continue;
 477                 }
 478
 479                 if (nr_pools + 1 > MAX_POOLS)
 480                         break;
 481                 else {
 482                         i = nr_pools;
 483                         global_read_unlock();
 484                         if (add_pool(&mp[nr_pools], size))
 485                                 goto out;
 486                         global_read_lock();
 487                 }
 488         } while (1);
 489
 490         global_read_unlock();
 491 out:
 492         return NULL;
 493 }
 494
 495 char *smalloc_strdup(const char *str)
 496 {
 497         char *ptr;
 498
 499         ptr = smalloc(strlen(str) + 1);
 500         strcpy(ptr, str);
 501         return ptr;
 502 }