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   stats->used_size = stats->chain_size[0] + stats->chain_size[1]
 223     - MP_CHUNK_TAIL * (stats->chain_count[0] + stats->chain_count[1])
 224     - pool->state.free[0] - pool->state.free[1] - sizeof(*pool);
 225   // FIXME: The following assertion tends to fail. Why?
 226   // ASSERT(stats->used_size < stats->total_size);
 227 }
 228
 229 u64
 230 mp_total_size(struct mempool *pool)
 231 {
 232   return pool->total_size;
 233 }
 234
 235 void
 236 mp_shrink(struct mempool *pool, u64 min_total_size)
 237 {
 238   while (1)
 239     {
 240       struct mempool_chunk *chunk = pool->unused;
 241       if (!chunk || pool->total_size - (chunk->size + MP_CHUNK_TAIL) < min_total_size)
 242         break;
 243       pool->unused = chunk->next;
 244       mp_free_chunk(pool, chunk);
 245     }
 246 }
 247
 248 void *
 249 mp_alloc_internal(struct mempool *pool, uns size)
 250 {
 251   struct mempool_chunk *chunk;
 252   if (size <= pool->threshold)
 253     {
 254       pool->idx = 0;
 255       if (pool->unused)
 256         {
 257           chunk = pool->unused;
 258           pool->unused = chunk->next;
 259         }
 260       else
 261         {
 262           chunk = mp_new_chunk(pool, pool->chunk_size);
 263 #ifdef CONFIG_DEBUG
 264           chunk->pool = pool;
 265 #endif
 266         }
 267       chunk->next = pool->state.last[0];
 268       pool->state.last[0] = chunk;
 269       pool->state.free[0] = pool->chunk_size - size;
 270       return (void *)chunk - pool->chunk_size;
 271     }
 272   else if (likely(size <= MP_SIZE_MAX))
 273     {
 274       pool->idx = 1;
 275       uns aligned = ALIGN_TO(size, CPU_STRUCT_ALIGN);
 276       chunk = mp_new_big_chunk(pool, aligned);
 277       chunk->next = pool->state.last[1];
 278 #ifdef CONFIG_DEBUG
 279       chunk->pool = pool;
 280 #endif
 281       pool->state.last[1] = chunk;
 282       pool->state.free[1] = aligned - size;
 283       return pool->last_big = (void *)chunk - aligned;
 284     }
 285   else
 286     die("Cannot allocate %u bytes from a mempool", size);
 287 }
 288
 289 void *
 290 mp_alloc(struct mempool *pool, uns size)
 291 {
 292   return mp_alloc_fast(pool, size);
 293 }
 294
 295 void *
 296 mp_alloc_noalign(struct mempool *pool, uns size)
 297 {
 298   return mp_alloc_fast_noalign(pool, size);
 299 }
 300
 301 void *
 302 mp_alloc_zero(struct mempool *pool, uns size)
 303 {
 304   void *ptr = mp_alloc_fast(pool, size);
 305   bzero(ptr, size);
 306   return ptr;
 307 }
 308
 309 void *
 310 mp_start_internal(struct mempool *pool, uns size)
 311 {
 312   void *ptr = mp_alloc_internal(pool, size);
 313   pool->state.free[pool->idx] += size;
 314   return ptr;
 315 }
 316
 317 void *
 318 mp_start(struct mempool *pool, uns size)
 319 {
 320   return mp_start_fast(pool, size);
 321 }
 322
 323 void *
 324 mp_start_noalign(struct mempool *pool, uns size)
 325 {
 326   return mp_start_fast_noalign(pool, size);
 327 }
 328
 329 void *
 330 mp_grow_internal(struct mempool *pool, uns size)
 331 {
 332   if (unlikely(size > MP_SIZE_MAX))
 333     die("Cannot allocate %u bytes of memory", size);
 334   uns avail = mp_avail(pool);
 335   void *ptr = mp_ptr(pool);
 336   if (pool->idx)
 337     {
 338       uns amortized = likely(avail <= MP_SIZE_MAX / 2) ? avail * 2 : MP_SIZE_MAX;
 339       amortized = MAX(amortized, size);
 340       amortized = ALIGN_TO(amortized, CPU_STRUCT_ALIGN);
 341       struct mempool_chunk *chunk = pool->state.last[1], *next = chunk->next;
 342       pool->total_size = pool->total_size - chunk->size + amortized;
 343       ptr = xrealloc(ptr, amortized + MP_CHUNK_TAIL);
 344       chunk = ptr + amortized;
 345       chunk->next = next;
 346       chunk->size = amortized;
 347       pool->state.last[1] = chunk;
 348       pool->state.free[1] = amortized;
 349       pool->last_big = ptr;
 350       return ptr;
 351     }
 352   else
 353     {
 354       void *p = mp_start_internal(pool, size);
 355       memcpy(p, ptr, avail);
 356       return p;
 357     }
 358 }
 359
 360 uns
 361 mp_open(struct mempool *pool, void *ptr)
 362 {
 363   return mp_open_fast(pool, ptr);
 364 }
 365
 366 void *
 367 mp_realloc(struct mempool *pool, void *ptr, uns size)
 368 {
 369   return mp_realloc_fast(pool, ptr, size);
 370 }
 371
 372 void *
 373 mp_realloc_zero(struct mempool *pool, void *ptr, uns size)
 374 {
 375   uns old_size = mp_open_fast(pool, ptr);
 376   ptr = mp_grow(pool, size);
 377   if (size > old_size)
 378     bzero(ptr + old_size, size - old_size);
 379   mp_end(pool, ptr + size);
 380   return ptr;
 381 }
 382
 383 void *
 384 mp_spread_internal(struct mempool *pool, void *p, uns size)
 385 {
 386   void *old = mp_ptr(pool);
 387   void *new = mp_grow_internal(pool, p-old+size);
 388   return p-old+new;
 389 }
 390
 391 void
 392 mp_restore(struct mempool *pool, struct mempool_state *state)
 393 {
 394   struct mempool_chunk *chunk, *next;
 395   struct mempool_state s = *state;
 396   for (chunk = pool->state.last[0]; chunk != s.last[0]; chunk = next)
 397     {
 398       next = chunk->next;
 399       chunk->next = pool->unused;
 400       pool->unused = chunk;
 401     }
 402   for (chunk = pool->state.last[1]; chunk != s.last[1]; chunk = next)
 403     {
 404       next = chunk->next;
 405       mp_free_big_chunk(pool, chunk);
 406     }
 407   pool->state = s;
 408   pool->last_big = &pool->last_big;
 409 }
 410
 411 struct mempool_state *
 412 mp_push(struct mempool *pool)
 413 {
 414   struct mempool_state state = pool->state;
 415   struct mempool_state *p = mp_alloc_fast(pool, sizeof(*p));
 416   *p = state;
 417   pool->state.next = p;
 418   return p;
 419 }
 420
 421 void
 422 mp_pop(struct mempool *pool)
 423 {
 424   ASSERT(pool->state.next);
 425   mp_restore(pool, pool->state.next);
 426 }
 427
 428 #ifdef TEST
 429
 430 #include <ucw/getopt.h>
 431 #include <stdio.h>
 432 #include <stdlib.h>
 433 #include <time.h>
 434
 435 static void
 436 fill(byte *ptr, uns len, uns magic)
 437 {
 438   while (len--)
 439     *ptr++ = (magic++ & 255);
 440 }
 441
 442 static void
 443 check(byte *ptr, uns len, uns magic, uns align)
 444 {
 445   ASSERT(!((uintptr_t)ptr & (align - 1)));
 446   while (len--)
 447     if (*ptr++ != (magic++ & 255))
 448       ASSERT(0);
 449 }
 450
 451 int main(int argc, char **argv)
 452 {
 453   srand(time(NULL));
 454   log_init(argv[0]);
 455   cf_def_file = NULL;
 456   if (cf_getopt(argc, argv, CF_SHORT_OPTS, CF_NO_LONG_OPTS, NULL) >= 0 || argc != optind)
 457     die("Invalid usage");
 458
 459   uns max = 1000, n = 0, m = 0, can_realloc = 0;
 460   void *ptr[max];
 461   struct mempool_state *state[max];
 462   uns len[max], num[max], align[max];
 463   struct mempool *mp = mp_new(128), mp_static;
 464
 465   for (uns i = 0; i < 5000; i++)
 466     {
 467       for (uns j = 0; j < n; j++)
 468         check(ptr[j], len[j], j, align[j]);
 469 #if 0
 470       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);
 471       for (struct mempool_chunk *ch = mp->state.last[0]; ch; ch = ch->next)
 472         DBG("small %p %p %p %d", (byte *)ch - ch->size, ch, ch + 1, ch->size);
 473       for (struct mempool_chunk *ch = mp->state.last[1]; ch; ch = ch->next)
 474         DBG("big %p %p %p %d", (byte *)ch - ch->size, ch, ch + 1, ch->size);
 475 #endif
 476       int r = random_max(100);
 477       if ((r -= 1) < 0)
 478         {
 479           DBG("flush");
 480           mp_flush(mp);
 481           n = m = 0;
 482         }
 483       else if ((r -= 1) < 0)
 484         {
 485           DBG("delete & new");
 486           mp_delete(mp);
 487           if (random_max(2))
 488             mp = mp_new(random_max(0x1000) + 1);
 489           else
 490             mp = &mp_static, mp_init(mp, random_max(512) + 1);
 491           n = m = 0;
 492         }
 493       else if (n < max && (r -= 30) < 0)
 494         {
 495           len[n] = random_max(0x2000);
 496           DBG("alloc(%u)", len[n]);
 497           align[n] = random_max(2) ? CPU_STRUCT_ALIGN : 1;
 498           ptr[n] = (align[n] == 1) ? mp_alloc_fast_noalign(mp, len[n]) : mp_alloc_fast(mp, len[n]);
 499           DBG(" -> (%p)", ptr[n]);
 500           fill(ptr[n], len[n], n);
 501           n++;
 502           can_realloc = 1;
 503         }
 504       else if (n < max && (r -= 20) < 0)
 505         {
 506           len[n] = random_max(0x2000);
 507           DBG("start(%u)", len[n]);
 508           align[n] = random_max(2) ? CPU_STRUCT_ALIGN : 1;
 509           ptr[n] = (align[n] == 1) ? mp_start_fast_noalign(mp, len[n]) : mp_start_fast(mp, len[n]);
 510           DBG(" -> (%p)", ptr[n]);
 511           fill(ptr[n], len[n], n);
 512           n++;
 513           can_realloc = 1;
 514           goto grow;
 515         }
 516       else if (can_realloc && n && (r -= 10) < 0)
 517         {
 518           if (mp_open(mp, ptr[n - 1]) != len[n - 1])
 519             ASSERT(0);
 520 grow:
 521           {
 522             uns k = n - 1;
 523             for (uns i = random_max(4); i--; )
 524               {
 525                 uns l = len[k];
 526                 len[k] = random_max(0x2000);
 527                 DBG("grow(%u)", len[k]);
 528                 ptr[k] = mp_grow(mp, len[k]);
 529                 DBG(" -> (%p)", ptr[k]);
 530                 check(ptr[k], MIN(l, len[k]), k, align[k]);
 531                 fill(ptr[k], len[k], k);
 532               }
 533             mp_end(mp, ptr[k] + len[k]);
 534           }
 535         }
 536       else if (can_realloc && n && (r -= 20) < 0)
 537         {
 538           uns i = n - 1, l = len[i];
 539           DBG("realloc(%p, %u)", ptr[i], len[i]);
 540           ptr[i] = mp_realloc(mp, ptr[i], len[i] = random_max(0x2000));
 541           DBG(" -> (%p, %u)", ptr[i], len[i]);
 542           check(ptr[i],  MIN(len[i], l), i, align[i]);
 543           fill(ptr[i], len[i], i);
 544         }
 545       else if (m < max && (r -= 5) < 0)
 546         {
 547           DBG("push(%u)", m);
 548           num[m] = n;
 549           state[m++] = mp_push(mp);
 550           can_realloc = 0;
 551         }
 552       else if (m && (r -= 2) < 0)
 553         {
 554           m--;
 555           DBG("pop(%u)", m);
 556           mp_pop(mp);
 557           n = num[m];
 558           can_realloc = 0;
 559         }
 560       else if (m && (r -= 1) < 0)
 561         {
 562           uns i = random_max(m);
 563           DBG("restore(%u)", i);
 564           mp_restore(mp, state[i]);
 565           n = num[m = i];
 566           can_realloc = 0;
 567         }
 568       else if (can_realloc && n && (r -= 5) < 0)
 569         ASSERT(mp_size(mp, ptr[n - 1]) == len[n - 1]);
 570       else
 571         {
 572           struct mempool_stats stats;
 573           mp_stats(mp, &stats);
 574         }
 575     }
 576
 577   mp_delete(mp);
 578   return 0;
 579 }
 580
 581 #endif