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 #undef ENABLE_RESIZE            /* define to enable pool resizing */
  17 #define MP_SAFE                 /* define to made allocator thread safe */
  18
  19 #define INITIAL_SIZE    1048576 /* new pool size */
  20 #define MAX_POOLS       32      /* maximum number of pools to setup */
  21
  22 unsigned int smalloc_pool_size = INITIAL_SIZE;
  23
  24 #ifdef ENABLE_RESIZE
  25 #define MAX_SIZE        8 * smalloc_pool_size
  26 static unsigned int resize_error;
  27 #endif
  28
  29 struct pool {
  30         struct fio_mutex *lock;                 /* protects this pool */
  31         void *map;                              /* map of blocks */
  32         void *last;                             /* next free block hint */
  33         unsigned int size;                      /* size of pool */
  34         unsigned int room;                      /* size left in pool */
  35         unsigned int largest_block;             /* largest block free */
  36         unsigned int free_since_compact;        /* sfree() since compact() */
  37         int fd;                                 /* memory backing fd */
  38         char file[PATH_MAX];                    /* filename for fd */
  39 };
  40
  41 static struct pool mp[MAX_POOLS];
  42 static unsigned int nr_pools;
  43 static unsigned int last_pool;
  44 static struct fio_mutex *lock;
  45
  46 struct mem_hdr {
  47         unsigned int size;
  48 };
  49
  50 static inline void pool_lock(struct pool *pool)
  51 {
  52         if (pool->lock)
  53                 fio_mutex_down(pool->lock);
  54 }
  55
  56 static inline void pool_unlock(struct pool *pool)
  57 {
  58         if (pool->lock)
  59                 fio_mutex_up(pool->lock);
  60 }
  61
  62 static inline void global_read_lock(void)
  63 {
  64         if (lock)
  65                 fio_mutex_down_read(lock);
  66 }
  67
  68 static inline void global_read_unlock(void)
  69 {
  70         if (lock)
  71                 fio_mutex_up_read(lock);
  72 }
  73
  74 static inline void global_write_lock(void)
  75 {
  76         if (lock)
  77                 fio_mutex_down_write(lock);
  78 }
  79
  80 static inline void global_write_unlock(void)
  81 {
  82         if (lock)
  83                 fio_mutex_up_write(lock);
  84 }
  85
  86 #define hdr_free(hdr)           ((hdr)->size & 0x80000000)
  87 #define hdr_size(hdr)           ((hdr)->size & ~0x80000000)
  88 #define hdr_mark_free(hdr)      ((hdr)->size |= 0x80000000)
  89
  90 static inline int ptr_valid(struct pool *pool, void *ptr)
  91 {
  92         return (ptr >= pool->map) && (ptr < pool->map + pool->size);
  93 }
  94
  95 static inline int __hdr_valid(struct pool *pool, struct mem_hdr *hdr,
  96                               unsigned int size)
  97 {
  98         return ptr_valid(pool, hdr) && ptr_valid(pool, (void *) hdr + size - 1);
  99 }
 100
 101 static inline int hdr_valid(struct pool *pool, struct mem_hdr *hdr)
 102 {
 103         return __hdr_valid(pool, hdr, hdr_size(hdr));
 104 }
 105
 106 static inline int region_free(struct mem_hdr *hdr)
 107 {
 108         return hdr_free(hdr) || (!hdr_free(hdr) && !hdr_size(hdr));
 109 }
 110
 111 static inline struct mem_hdr *__hdr_nxt(struct pool *pool, struct mem_hdr *hdr,
 112                                         unsigned int size)
 113 {
 114         struct mem_hdr *nxt = (void *) hdr + size + sizeof(*hdr);
 115
 116         if (__hdr_valid(pool, nxt, size))
 117                 return nxt;
 118
 119         return NULL;
 120 }
 121
 122 static inline struct mem_hdr *hdr_nxt(struct pool *pool, struct mem_hdr *hdr)
 123 {
 124         return __hdr_nxt(pool, hdr, hdr_size(hdr));
 125 }
 126
 127 static void merge(struct pool *pool, struct mem_hdr *hdr, struct mem_hdr *nxt)
 128 {
 129         unsigned int hfree = hdr_free(hdr);
 130         unsigned int nfree = hdr_free(nxt);
 131
 132         hdr->size = hdr_size(hdr) + hdr_size(nxt) + sizeof(*nxt);
 133         nxt->size = 0;
 134
 135         if (hfree)
 136                 hdr_mark_free(hdr);
 137         if (nfree)
 138                 hdr_mark_free(nxt);
 139
 140         if (pool->last == nxt)
 141                 pool->last = hdr;
 142 }
 143
 144 static int combine(struct pool *pool, struct mem_hdr *prv, struct mem_hdr *hdr)
 145 {
 146         if (prv && hdr_free(prv) && hdr_free(hdr)) {
 147                 merge(pool, prv, hdr);
 148                 return 1;
 149         }
 150
 151         return 0;
 152 }
 153
 154 static int compact_pool(struct pool *pool)
 155 {
 156         struct mem_hdr *hdr = pool->map, *nxt;
 157         unsigned int compacted = 0;
 158
 159         if (pool->free_since_compact < 50)
 160                 return 1;
 161
 162         while (hdr) {
 163                 nxt = hdr_nxt(pool, hdr);
 164                 if (!nxt)
 165                         break;
 166                 if (hdr_free(nxt) && hdr_free(hdr)) {
 167                         merge(pool, hdr, nxt);
 168                         compacted++;
 169                         continue;
 170                 }
 171                 hdr = hdr_nxt(pool, hdr);
 172         }
 173
 174         pool->free_since_compact = 0;
 175         return !!compacted;
 176 }
 177
 178 static int resize_pool(struct pool *pool)
 179 {
 180 #ifdef ENABLE_RESIZE
 181         unsigned int new_size = pool->size << 1;
 182         struct mem_hdr *hdr, *last_hdr;
 183         void *ptr;
 184
 185         if (new_size >= MAX_SIZE || resize_error)
 186                 return 1;
 187
 188         if (ftruncate(pool->fd, new_size) < 0)
 189                 goto fail;
 190
 191         ptr = mremap(pool->map, pool->size, new_size, 0);
 192         if (ptr == MAP_FAILED)
 193                 goto fail;
 194
 195         pool->map = ptr;
 196         hdr = pool;
 197         do {
 198                 last_hdr = hdr;
 199         } while ((hdr = hdr_nxt(hdr)) != NULL);
 200
 201         if (hdr_free(last_hdr)) {
 202                 last_hdr->size = hdr_size(last_hdr) + new_size - pool_size;
 203                 hdr_mark_free(last_hdr);
 204         } else {
 205                 struct mem_hdr *nxt;
 206
 207                 nxt = (void *) last_hdr + hdr_size(last_hdr) + sizeof(*hdr);
 208                 nxt->size = new_size - pool_size - sizeof(*hdr);
 209                 hdr_mark_free(nxt);
 210         }
 211
 212         pool_room += new_size - pool_size;
 213         pool_size = new_size;
 214         return 0;
 215 fail:
 216         perror("resize");
 217         resize_error = 1;
 218 #else
 219         return 1;
 220 #endif
 221 }
 222
 223 static int add_pool(struct pool *pool)
 224 {
 225         struct mem_hdr *hdr;
 226         void *ptr;
 227         int fd;
 228
 229         strcpy(pool->file, "/tmp/.fio_smalloc.XXXXXX");
 230         fd = mkstemp(pool->file);
 231         if (fd < 0)
 232                 goto out_close;
 233
 234         pool->size = smalloc_pool_size;
 235         if (ftruncate(fd, pool->size) < 0)
 236                 goto out_unlink;
 237
 238         ptr = mmap(NULL, pool->size, PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0);
 239         if (ptr == MAP_FAILED)
 240                 goto out_unlink;
 241
 242         memset(ptr, 0, pool->size);
 243         pool->map = pool->last = ptr;
 244
 245 #ifdef MP_SAFE
 246         pool->lock = fio_mutex_init(1);
 247         if (!pool->lock)
 248                 goto out_unlink;
 249 #endif
 250
 251         pool->fd = fd;
 252
 253         hdr = pool->map;
 254         pool->room = hdr->size = pool->size - sizeof(*hdr);
 255         pool->largest_block = pool->room;
 256         hdr_mark_free(hdr);
 257         global_write_lock();
 258         nr_pools++;
 259         global_write_unlock();
 260         return 0;
 261 out_unlink:
 262         if (pool->map)
 263                 munmap(pool->map, pool->size);
 264         unlink(pool->file);
 265 out_close:
 266         if (fd >= 0)
 267                 close(fd);
 268         return 1;
 269 }
 270
 271 void sinit(void)
 272 {
 273         int ret;
 274
 275 #ifdef MP_SAFE
 276         lock = fio_mutex_rw_init();
 277 #endif
 278         ret = add_pool(&mp[0]);
 279         assert(!ret);
 280 }
 281
 282 static void cleanup_pool(struct pool *pool)
 283 {
 284         unlink(pool->file);
 285         close(pool->fd);
 286         munmap(pool->map, pool->size);
 287
 288         if (pool->lock)
 289                 fio_mutex_remove(pool->lock);
 290 }
 291
 292 void scleanup(void)
 293 {
 294         unsigned int i;
 295
 296         for (i = 0; i < nr_pools; i++)
 297                 cleanup_pool(&mp[i]);
 298
 299         if (lock)
 300                 fio_mutex_remove(lock);
 301 }
 302
 303 static void sfree_pool(struct pool *pool, void *ptr)
 304 {
 305         struct mem_hdr *hdr, *nxt;
 306
 307         if (!ptr)
 308                 return;
 309
 310         assert(ptr_valid(pool, ptr));
 311
 312         pool_lock(pool);
 313         hdr = ptr - sizeof(*hdr);
 314         assert(!hdr_free(hdr));
 315         hdr_mark_free(hdr);
 316         pool->room -= hdr_size(hdr);
 317
 318         nxt = hdr_nxt(pool, hdr);
 319         if (nxt && hdr_free(nxt))
 320                 merge(pool, hdr, nxt);
 321
 322         if (hdr_size(hdr) > pool->largest_block)
 323                 pool->largest_block = hdr_size(hdr);
 324
 325         pool->free_since_compact++;
 326         pool_unlock(pool);
 327 }
 328
 329 void sfree(void *ptr)
 330 {
 331         struct pool *pool = NULL;
 332         unsigned int i;
 333
 334         global_read_lock();
 335
 336         for (i = 0; i < nr_pools; i++) {
 337                 if (ptr_valid(&mp[i], ptr)) {
 338                         pool = &mp[i];
 339                         break;
 340                 }
 341         }
 342
 343         global_read_unlock();
 344
 345         assert(pool);
 346         sfree_pool(pool, ptr);
 347 }
 348
 349 static void *smalloc_pool(struct pool *pool, unsigned int size)
 350 {
 351         struct mem_hdr *hdr, *prv;
 352         int did_restart = 0;
 353         void *ret;
 354
 355         /*
 356          * slight chance of race with sfree() here, but acceptable
 357          */
 358         if (!size || size > pool->room + sizeof(*hdr) ||
 359             ((size > pool->largest_block) && pool->largest_block))
 360                 return NULL;
 361
 362         pool_lock(pool);
 363 restart:
 364         hdr = pool->last;
 365         prv = NULL;
 366         do {
 367                 if (combine(pool, prv, hdr))
 368                         hdr = prv;
 369
 370                 if (hdr_free(hdr) && hdr_size(hdr) >= size)
 371                         break;
 372
 373                 prv = hdr;
 374         } while ((hdr = hdr_nxt(pool, hdr)) != NULL);
 375
 376         if (!hdr)
 377                 goto fail;
 378
 379         /*
 380          * more room, adjust next header if any
 381          */
 382         if (hdr_size(hdr) - size >= 2 * sizeof(*hdr)) {
 383                 struct mem_hdr *nxt = __hdr_nxt(pool, hdr, size);
 384
 385                 if (nxt) {
 386                         nxt->size = hdr_size(hdr) - size - sizeof(*hdr);
 387                         if (hdr_size(hdr) == pool->largest_block)
 388                                 pool->largest_block = hdr_size(nxt);
 389                         hdr_mark_free(nxt);
 390                 } else
 391                         size = hdr_size(hdr);
 392         } else
 393                 size = hdr_size(hdr);
 394
 395         if (size == hdr_size(hdr) && size == pool->largest_block)
 396                 pool->largest_block = 0;
 397
 398         /*
 399          * also clears free bit
 400          */
 401         hdr->size = size;
 402         pool->last = hdr_nxt(pool, hdr);
 403         if (!pool->last)
 404                 pool->last = pool->map;
 405         pool->room -= size;
 406         pool_unlock(pool);
 407
 408         ret = (void *) hdr + sizeof(*hdr);
 409         memset(ret, 0, size);
 410         return ret;
 411 fail:
 412         /*
 413          * if we fail to allocate, first compact the entries that we missed.
 414          * if that also fails, increase the size of the pool
 415          */
 416         ++did_restart;
 417         if (did_restart <= 1) {
 418                 if (!compact_pool(pool)) {
 419                         pool->last = pool->map;
 420                         goto restart;
 421                 }
 422         }
 423         ++did_restart;
 424         if (did_restart <= 2) {
 425                 if (!resize_pool(pool)) {
 426                         pool->last = pool->map;
 427                         goto restart;
 428                 }
 429         }
 430         pool_unlock(pool);
 431         return NULL;
 432 }
 433
 434 void *smalloc(unsigned int size)
 435 {
 436         unsigned int i;
 437
 438         global_read_lock();
 439         i = last_pool;
 440
 441         do {
 442                 for (; i < nr_pools; i++) {
 443                         void *ptr = smalloc_pool(&mp[i], size);
 444
 445                         if (ptr) {
 446                                 last_pool = i;
 447                                 global_read_unlock();
 448                                 return ptr;
 449                         }
 450                 }
 451                 if (last_pool) {
 452                         last_pool = 0;
 453                         continue;
 454                 }
 455
 456                 if (nr_pools + 1 >= MAX_POOLS)
 457                         break;
 458                 else {
 459                         i = nr_pools;
 460                         global_read_unlock();
 461                         if (add_pool(&mp[nr_pools]))
 462                                 goto out;
 463                         global_read_lock();
 464                 }
 465         } while (1);
 466
 467         global_read_unlock();
 468 out:
 469         return NULL;
 470 }
 471
 472 char *smalloc_strdup(const char *str)
 473 {
 474         char *ptr;
 475
 476         ptr = smalloc(strlen(str) + 1);
 477         strcpy(ptr, str);
 478         return ptr;
 479 }