ucw/mempool.c

   1 /*
   2  *      UCW Library -- Memory Pools (One-Time Allocation)
   3  *
   4  *      (c) 1997--2014 Martin Mares <mj@ucw.cz>
   5  *      (c) 2007--2014 Pavel Charvat <pchar@ucw.cz>
   6  *
   7  *      This software may be freely distributed and used according to the terms
   8  *      of the GNU Lesser General Public License.
   9  */
  10
  11 #undef LOCAL_DEBUG
  12
  13 #include <ucw/lib.h>
  14 #include <ucw/alloc.h>
  15 #include <ucw/mempool.h>
  16
  17 #include <string.h>
  18
  19 #define MP_CHUNK_TAIL ALIGN_TO(sizeof(struct mempool_chunk), CPU_STRUCT_ALIGN)
  20 #define MP_SIZE_MAX (~0U - MP_CHUNK_TAIL - CPU_PAGE_SIZE)
  21
  22 struct mempool_chunk {
  23 #ifdef CONFIG_DEBUG
  24   struct mempool *pool;         // Can be useful when analysing coredump for memory leaks
  25 #endif
  26   struct mempool_chunk *next;
  27   uns size;
  28 };
  29
  30 static uns
  31 mp_align_size(uns size)
  32 {
  33 #ifdef CONFIG_UCW_POOL_IS_MMAP
  34   return ALIGN_TO(size + MP_CHUNK_TAIL, CPU_PAGE_SIZE) - MP_CHUNK_TAIL;
  35 #else
  36   return ALIGN_TO(size, CPU_STRUCT_ALIGN);
  37 #endif
  38 }
  39
  40 static void *mp_allocator_alloc(struct ucw_allocator *a, size_t size)
  41 {
  42   struct mempool *mp = (struct mempool *) a;
  43   return mp_alloc_fast(mp, size);
  44 }
  45
  46 static void *mp_allocator_realloc(struct ucw_allocator *a, void *ptr, size_t old_size, size_t new_size)
  47 {
  48   if (new_size <= old_size)
  49     return ptr;
  50
  51   /*
  52    *  In the future, we might want to do something like mp_realloc(),
  53    *  but we have to check that it is indeed the last block in the pool.
  54    */
  55   struct mempool *mp = (struct mempool *) a;
  56   void *new = mp_alloc_fast(mp, new_size);
  57   memcpy(new, ptr, old_size);
  58   return new;
  59 }
  60
  61 static void mp_allocator_free(struct ucw_allocator *a UNUSED, void *ptr UNUSED)
  62 {
  63   // Does nothing
  64 }
  65
  66 void
  67 mp_init(struct mempool *pool, uns chunk_size)
  68 {
  69   chunk_size = mp_align_size(MAX(sizeof(struct mempool), chunk_size));
  70   *pool = (struct mempool) {
  71     .allocator = {
  72       .alloc = mp_allocator_alloc,
  73       .realloc = mp_allocator_realloc,
  74       .free = mp_allocator_free,
  75     },
  76     .chunk_size = chunk_size,
  77     .threshold = chunk_size >> 1,
  78     .last_big = &pool->last_big
  79   };
  80 }
  81
  82 static void *
  83 mp_new_big_chunk(struct mempool *pool, uns size)
  84 {
  85   struct mempool_chunk *chunk;
  86   chunk = xmalloc(size + MP_CHUNK_TAIL) + size;
  87   chunk->size = size;
  88   if (pool)
  89     pool->total_size += size + MP_CHUNK_TAIL;
  90   return chunk;
  91 }
  92
  93 static void
  94 mp_free_big_chunk(struct mempool *pool, struct mempool_chunk *chunk)
  95 {
  96   pool->total_size -= chunk->size + MP_CHUNK_TAIL;
  97   xfree((void *)chunk - chunk->size);
  98 }
  99
 100 static void *
 101 mp_new_chunk(struct mempool *pool, uns size)
 102 {
 103 #ifdef CONFIG_UCW_POOL_IS_MMAP
 104   struct mempool_chunk *chunk;
 105   chunk = page_alloc(size + MP_CHUNK_TAIL) + size;
 106   chunk->size = size;
 107   if (pool)
 108     pool->total_size += size + MP_CHUNK_TAIL;
 109   return chunk;
 110 #else
 111   return mp_new_big_chunk(pool, size);
 112 #endif
 113 }
 114
 115 static void
 116 mp_free_chunk(struct mempool *pool, struct mempool_chunk *chunk)
 117 {
 118 #ifdef CONFIG_UCW_POOL_IS_MMAP
 119   pool->total_size -= chunk->size + MP_CHUNK_TAIL;
 120   page_free((void *)chunk - chunk->size, chunk->size + MP_CHUNK_TAIL);
 121 #else
 122   mp_free_big_chunk(pool, chunk);
 123 #endif
 124 }
 125
 126 struct mempool *
 127 mp_new(uns chunk_size)
 128 {
 129   chunk_size = mp_align_size(MAX(sizeof(struct mempool), chunk_size));
 130   struct mempool_chunk *chunk = mp_new_chunk(NULL, chunk_size);
 131   struct mempool *pool = (void *)chunk - chunk_size;
 132   DBG("Creating mempool %p with %u bytes long chunks", pool, chunk_size);
 133   chunk->next = NULL;
 134 #ifdef CONFIG_DEBUG
 135   chunk->pool = pool;
 136 #endif
 137   *pool = (struct mempool) {
 138     .allocator = {
 139       .alloc = mp_allocator_alloc,
 140       .realloc = mp_allocator_realloc,
 141       .free = mp_allocator_free,
 142     },
 143     .state = { .free = { chunk_size - sizeof(*pool) }, .last = { chunk } },
 144     .chunk_size = chunk_size,
 145     .threshold = chunk_size >> 1,
 146     .last_big = &pool->last_big,
 147     .total_size = chunk->size + MP_CHUNK_TAIL,
 148   };
 149   return pool;
 150 }
 151
 152 static void
 153 mp_free_chain(struct mempool *pool, struct mempool_chunk *chunk)
 154 {
 155   while (chunk)
 156     {
 157       struct mempool_chunk *next = chunk->next;
 158       mp_free_chunk(pool, chunk);
 159       chunk = next;
 160     }
 161 }
 162
 163 static void
 164 mp_free_big_chain(struct mempool *pool, struct mempool_chunk *chunk)
 165 {
 166   while (chunk)
 167     {
 168       struct mempool_chunk *next = chunk->next;
 169       mp_free_big_chunk(pool, chunk);
 170       chunk = next;
 171     }
 172 }
 173
 174 void
 175 mp_delete(struct mempool *pool)
 176 {
 177   DBG("Deleting mempool %p", pool);
 178   mp_free_big_chain(pool, pool->state.last[1]);
 179   mp_free_chain(pool, pool->unused);
 180   mp_free_chain(pool, pool->state.last[0]); // can contain the mempool structure
 181 }
 182
 183 void
 184 mp_flush(struct mempool *pool)
 185 {
 186   mp_free_big_chain(pool, pool->state.last[1]);
 187   struct mempool_chunk *chunk, *next;
 188   for (chunk = pool->state.last[0]; chunk && (void *)chunk - chunk->size != pool; chunk = next)
 189     {
 190       next = chunk->next;
 191       chunk->next = pool->unused;
 192       pool->unused = chunk;
 193     }
 194   pool->state.last[0] = chunk;
 195   pool->state.free[0] = chunk ? chunk->size - sizeof(*pool) : 0;
 196   pool->state.last[1] = NULL;
 197   pool->state.free[1] = 0;
 198   pool->state.next = NULL;
 199   pool->last_big = &pool->last_big;
 200 }
 201
 202 static void
 203 mp_stats_chain(struct mempool_chunk *chunk, struct mempool_stats *stats, uns idx)
 204 {
 205   while (chunk)
 206     {
 207       stats->chain_size[idx] += chunk->size + MP_CHUNK_TAIL;
 208       stats->chain_count[idx]++;
 209       chunk = chunk->next;
 210     }
 211   stats->total_size += stats->chain_size[idx];
 212 }
 213
 214 void
 215 mp_stats(struct mempool *pool, struct mempool_stats *stats)
 216 {
 217   bzero(stats, sizeof(*stats));
 218   mp_stats_chain(pool->state.last[0], stats, 0);
 219   mp_stats_chain(pool->state.last[1], stats, 1);
 220   mp_stats_chain(pool->unused, stats, 2);
 221   ASSERT(stats->total_size == pool->total_size);
 222 }
 223
 224 u64
 225 mp_total_size(struct mempool *pool)
 226 {
 227   return pool->total_size;
 228 }
 229
 230 void *
 231 mp_alloc_internal(struct mempool *pool, uns size)
 232 {
 233   struct mempool_chunk *chunk;
 234   if (size <= pool->threshold)
 235     {
 236       pool->idx = 0;
 237       if (pool->unused)
 238         {
 239           chunk = pool->unused;
 240           pool->unused = chunk->next;
 241         }
 242       else
 243         {
 244           chunk = mp_new_chunk(pool, pool->chunk_size);
 245 #ifdef CONFIG_DEBUG
 246           chunk->pool = pool;
 247 #endif
 248         }
 249       chunk->next = pool->state.last[0];
 250       pool->state.last[0] = chunk;
 251       pool->state.free[0] = pool->chunk_size - size;
 252       return (void *)chunk - pool->chunk_size;
 253     }
 254   else if (likely(size <= MP_SIZE_MAX))
 255     {
 256       pool->idx = 1;
 257       uns aligned = ALIGN_TO(size, CPU_STRUCT_ALIGN);
 258       chunk = mp_new_big_chunk(pool, aligned);
 259       chunk->next = pool->state.last[1];
 260 #ifdef CONFIG_DEBUG
 261       chunk->pool = pool;
 262 #endif
 263       pool->state.last[1] = chunk;
 264       pool->state.free[1] = aligned - size;
 265       return pool->last_big = (void *)chunk - aligned;
 266     }
 267   else
 268     die("Cannot allocate %u bytes from a mempool", size);
 269 }
 270
 271 void *
 272 mp_alloc(struct mempool *pool, uns size)
 273 {
 274   return mp_alloc_fast(pool, size);
 275 }
 276
 277 void *
 278 mp_alloc_noalign(struct mempool *pool, uns size)
 279 {
 280   return mp_alloc_fast_noalign(pool, size);
 281 }
 282
 283 void *
 284 mp_alloc_zero(struct mempool *pool, uns size)
 285 {
 286   void *ptr = mp_alloc_fast(pool, size);
 287   bzero(ptr, size);
 288   return ptr;
 289 }
 290
 291 void *
 292 mp_start_internal(struct mempool *pool, uns size)
 293 {
 294   void *ptr = mp_alloc_internal(pool, size);
 295   pool->state.free[pool->idx] += size;
 296   return ptr;
 297 }
 298
 299 void *
 300 mp_start(struct mempool *pool, uns size)
 301 {
 302   return mp_start_fast(pool, size);
 303 }
 304
 305 void *
 306 mp_start_noalign(struct mempool *pool, uns size)
 307 {
 308   return mp_start_fast_noalign(pool, size);
 309 }
 310
 311 void *
 312 mp_grow_internal(struct mempool *pool, uns size)
 313 {
 314   if (unlikely(size > MP_SIZE_MAX))
 315     die("Cannot allocate %u bytes of memory", size);
 316   uns avail = mp_avail(pool);
 317   void *ptr = mp_ptr(pool);
 318   if (pool->idx)
 319     {
 320       uns amortized = likely(avail <= MP_SIZE_MAX / 2) ? avail * 2 : MP_SIZE_MAX;
 321       amortized = MAX(amortized, size);
 322       amortized = ALIGN_TO(amortized, CPU_STRUCT_ALIGN);
 323       struct mempool_chunk *chunk = pool->state.last[1], *next = chunk->next;
 324       pool->total_size = pool->total_size - chunk->size + amortized;
 325       ptr = xrealloc(ptr, amortized + MP_CHUNK_TAIL);
 326       chunk = ptr + amortized;
 327       chunk->next = next;
 328       chunk->size = amortized;
 329       pool->state.last[1] = chunk;
 330       pool->state.free[1] = amortized;
 331       pool->last_big = ptr;
 332       return ptr;
 333     }
 334   else
 335     {
 336       void *p = mp_start_internal(pool, size);
 337       memcpy(p, ptr, avail);
 338       return p;
 339     }
 340 }
 341
 342 uns
 343 mp_open(struct mempool *pool, void *ptr)
 344 {
 345   return mp_open_fast(pool, ptr);
 346 }
 347
 348 void *
 349 mp_realloc(struct mempool *pool, void *ptr, uns size)
 350 {
 351   return mp_realloc_fast(pool, ptr, size);
 352 }
 353
 354 void *
 355 mp_realloc_zero(struct mempool *pool, void *ptr, uns size)
 356 {
 357   uns old_size = mp_open_fast(pool, ptr);
 358   ptr = mp_grow(pool, size);
 359   if (size > old_size)
 360     bzero(ptr + old_size, size - old_size);
 361   mp_end(pool, ptr + size);
 362   return ptr;
 363 }
 364
 365 void *
 366 mp_spread_internal(struct mempool *pool, void *p, uns size)
 367 {
 368   void *old = mp_ptr(pool);
 369   void *new = mp_grow_internal(pool, p-old+size);
 370   return p-old+new;
 371 }
 372
 373 void
 374 mp_restore(struct mempool *pool, struct mempool_state *state)
 375 {
 376   struct mempool_chunk *chunk, *next;
 377   struct mempool_state s = *state;
 378   for (chunk = pool->state.last[0]; chunk != s.last[0]; chunk = next)
 379     {
 380       next = chunk->next;
 381       chunk->next = pool->unused;
 382       pool->unused = chunk;
 383     }
 384   for (chunk = pool->state.last[1]; chunk != s.last[1]; chunk = next)
 385     {
 386       next = chunk->next;
 387       mp_free_big_chunk(pool, chunk);
 388     }
 389   pool->state = s;
 390   pool->last_big = &pool->last_big;
 391 }
 392
 393 struct mempool_state *
 394 mp_push(struct mempool *pool)
 395 {
 396   struct mempool_state state = pool->state;
 397   struct mempool_state *p = mp_alloc_fast(pool, sizeof(*p));
 398   *p = state;
 399   pool->state.next = p;
 400   return p;
 401 }
 402
 403 void
 404 mp_pop(struct mempool *pool)
 405 {
 406   ASSERT(pool->state.next);
 407   mp_restore(pool, pool->state.next);
 408 }
 409
 410 #ifdef TEST
 411
 412 #include <ucw/getopt.h>
 413 #include <stdio.h>
 414 #include <stdlib.h>
 415 #include <time.h>
 416
 417 static void
 418 fill(byte *ptr, uns len, uns magic)
 419 {
 420   while (len--)
 421     *ptr++ = (magic++ & 255);
 422 }
 423
 424 static void
 425 check(byte *ptr, uns len, uns magic, uns align)
 426 {
 427   ASSERT(!((uintptr_t)ptr & (align - 1)));
 428   while (len--)
 429     if (*ptr++ != (magic++ & 255))
 430       ASSERT(0);
 431 }
 432
 433 int main(int argc, char **argv)
 434 {
 435   srand(time(NULL));
 436   log_init(argv[0]);
 437   cf_def_file = NULL;
 438   if (cf_getopt(argc, argv, CF_SHORT_OPTS, CF_NO_LONG_OPTS, NULL) >= 0 || argc != optind)
 439     die("Invalid usage");
 440
 441   uns max = 1000, n = 0, m = 0, can_realloc = 0;
 442   void *ptr[max];
 443   struct mempool_state *state[max];
 444   uns len[max], num[max], align[max];
 445   struct mempool *mp = mp_new(128), mp_static;
 446
 447   for (uns i = 0; i < 5000; i++)
 448     {
 449       for (uns j = 0; j < n; j++)
 450         check(ptr[j], len[j], j, align[j]);
 451 #if 0
 452       DBG("free_small=%u free_big=%u idx=%u chunk_size=%u last_big=%p", mp->state.free[0], mp->state.free[1], mp->idx, mp->chunk_size, mp->last_big);
 453       for (struct mempool_chunk *ch = mp->state.last[0]; ch; ch = ch->next)
 454         DBG("small %p %p %p %d", (byte *)ch - ch->size, ch, ch + 1, ch->size);
 455       for (struct mempool_chunk *ch = mp->state.last[1]; ch; ch = ch->next)
 456         DBG("big %p %p %p %d", (byte *)ch - ch->size, ch, ch + 1, ch->size);
 457 #endif
 458       int r = random_max(100);
 459       if ((r -= 1) < 0)
 460         {
 461           DBG("flush");
 462           mp_flush(mp);
 463           n = m = 0;
 464         }
 465       else if ((r -= 1) < 0)
 466         {
 467           DBG("delete & new");
 468           mp_delete(mp);
 469           if (random_max(2))
 470             mp = mp_new(random_max(0x1000) + 1);
 471           else
 472             mp = &mp_static, mp_init(mp, random_max(512) + 1);
 473           n = m = 0;
 474         }
 475       else if (n < max && (r -= 30) < 0)
 476         {
 477           len[n] = random_max(0x2000);
 478           DBG("alloc(%u)", len[n]);
 479           align[n] = random_max(2) ? CPU_STRUCT_ALIGN : 1;
 480           ptr[n] = (align[n] == 1) ? mp_alloc_fast_noalign(mp, len[n]) : mp_alloc_fast(mp, len[n]);
 481           DBG(" -> (%p)", ptr[n]);
 482           fill(ptr[n], len[n], n);
 483           n++;
 484           can_realloc = 1;
 485         }
 486       else if (n < max && (r -= 20) < 0)
 487         {
 488           len[n] = random_max(0x2000);
 489           DBG("start(%u)", len[n]);
 490           align[n] = random_max(2) ? CPU_STRUCT_ALIGN : 1;
 491           ptr[n] = (align[n] == 1) ? mp_start_fast_noalign(mp, len[n]) : mp_start_fast(mp, len[n]);
 492           DBG(" -> (%p)", ptr[n]);
 493           fill(ptr[n], len[n], n);
 494           n++;
 495           can_realloc = 1;
 496           goto grow;
 497         }
 498       else if (can_realloc && n && (r -= 10) < 0)
 499         {
 500           if (mp_open(mp, ptr[n - 1]) != len[n - 1])
 501             ASSERT(0);
 502 grow:
 503           {
 504             uns k = n - 1;
 505             for (uns i = random_max(4); i--; )
 506               {
 507                 uns l = len[k];
 508                 len[k] = random_max(0x2000);
 509                 DBG("grow(%u)", len[k]);
 510                 ptr[k] = mp_grow(mp, len[k]);
 511                 DBG(" -> (%p)", ptr[k]);
 512                 check(ptr[k], MIN(l, len[k]), k, align[k]);
 513                 fill(ptr[k], len[k], k);
 514               }
 515             mp_end(mp, ptr[k] + len[k]);
 516           }
 517         }
 518       else if (can_realloc && n && (r -= 20) < 0)
 519         {
 520           uns i = n - 1, l = len[i];
 521           DBG("realloc(%p, %u)", ptr[i], len[i]);
 522           ptr[i] = mp_realloc(mp, ptr[i], len[i] = random_max(0x2000));
 523           DBG(" -> (%p, %u)", ptr[i], len[i]);
 524           check(ptr[i],  MIN(len[i], l), i, align[i]);
 525           fill(ptr[i], len[i], i);
 526         }
 527       else if (m < max && (r -= 5) < 0)
 528         {
 529           DBG("push(%u)", m);
 530           num[m] = n;
 531           state[m++] = mp_push(mp);
 532           can_realloc = 0;
 533         }
 534       else if (m && (r -= 2) < 0)
 535         {
 536           m--;
 537           DBG("pop(%u)", m);
 538           mp_pop(mp);
 539           n = num[m];
 540           can_realloc = 0;
 541         }
 542       else if (m && (r -= 1) < 0)
 543         {
 544           uns i = random_max(m);
 545           DBG("restore(%u)", i);
 546           mp_restore(mp, state[i]);
 547           n = num[m = i];
 548           can_realloc = 0;
 549         }
 550       else if (can_realloc && n && (r -= 5) < 0)
 551         ASSERT(mp_size(mp, ptr[n - 1]) == len[n - 1]);
 552       else
 553         {
 554           struct mempool_stats stats;
 555           mp_stats(mp, &stats);
 556         }
 557     }
 558
 559   mp_delete(mp);
 560   return 0;
 561 }
 562
 563 #endif