src/src/store.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2018 */
   6 /* Copyright (c) The Exim maintainers 2019 - 2020 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8
   9 /* Exim gets and frees all its store through these functions. In the original
  10 implementation there was a lot of mallocing and freeing of small bits of store.
  11 The philosophy has now changed to a scheme which includes the concept of
  12 "stacking pools" of store. For the short-lived processes, there isn't any real
  13 need to do any garbage collection, but the stack concept allows quick resetting
  14 in places where this seems sensible.
  15
  16 Obviously the long-running processes (the daemon, the queue runner, and eximon)
  17 must take care not to eat store.
  18
  19 The following different types of store are recognized:
  20
  21 . Long-lived, large blocks: This is implemented by retaining the original
  22   malloc/free functions, and it used for permanent working buffers and for
  23   getting blocks to cut up for the other types.
  24
  25 . Long-lived, small blocks: This is used for blocks that have to survive until
  26   the process exits. It is implemented as a stacking pool (POOL_PERM). This is
  27   functionally the same as store_malloc(), except that the store can't be
  28   freed, but I expect it to be more efficient for handling small blocks.
  29
  30 . Short-lived, short blocks: Most of the dynamic store falls into this
  31   category. It is implemented as a stacking pool (POOL_MAIN) which is reset
  32   after accepting a message when multiple messages are received by a single
  33   process. Resetting happens at some other times as well, usually fairly
  34   locally after some specific processing that needs working store.
  35
  36 . There is a separate pool (POOL_SEARCH) that is used only for lookup storage.
  37   This means it can be freed when search_tidyup() is called to close down all
  38   the lookup caching.
  39
  40 - There is another pool (POOL_MESSAGE) used for medium-lifetime objects; within
  41   a single message transaction but needed for longer than the use of the main
  42   pool permits.  Currently this means only receive-time DKIM information.
  43
  44 . Orthogonal to the three pool types, there are two classes of memory: untainted
  45   and tainted.  The latter is used for values derived from untrusted input, and
  46   the string-expansion mechanism refuses to operate on such values (obviously,
  47   it can expand an untainted value to return a tainted result).  The classes
  48   are implemented by duplicating the four pool types.  Pool resets are requested
  49   against the nontainted sibling and apply to both siblings.
  50
  51   Only memory blocks requested for tainted use are regarded as tainted; anything
  52   else (including stack auto variables) is untainted.  Care is needed when coding
  53   to not copy untrusted data into untainted memory, as downstream taint-checks
  54   would be avoided.
  55
  56   Intermediate layers (eg. the string functions) can test for taint, and use this
  57   for ensurinng that results have proper state.  For example the
  58   string_vformat_trc() routing supporting the string_sprintf() interface will
  59   recopy a string being built into a tainted allocation if it meets a %s for a
  60   tainted argument.  Any intermediate-layer function that (can) return a new
  61   allocation should behave this way; returning a tainted result if any tainted
  62   content is used.  Intermediate-layer functions (eg. Ustrncpy) that modify
  63   existing allocations fail if tainted data is written into an untainted area.
  64   Users of functions that modify existing allocations should check if a tainted
  65   source and an untainted destination is used, and fail instead (sprintf() being
  66   the classic case).
  67 */
  68
  69
  70 #include "exim.h"
  71 /* keep config.h before memcheck.h, for NVALGRIND */
  72 #include "config.h"
  73
  74 #include <sys/mman.h>
  75 #include "memcheck.h"
  76
  77
  78 /* We need to know how to align blocks of data for general use. I'm not sure
  79 how to get an alignment factor in general. In the current world, a value of 8
  80 is probably right, and this is sizeof(double) on some systems and sizeof(void
  81 *) on others, so take the larger of those. Since everything in this expression
  82 is a constant, the compiler should optimize it to a simple constant wherever it
  83 appears (I checked that gcc does do this). */
  84
  85 #define alignment \
  86   (sizeof(void *) > sizeof(double) ? sizeof(void *) : sizeof(double))
  87
  88 /* store_reset() will not free the following block if the last used block has
  89 less than this much left in it. */
  90
  91 #define STOREPOOL_MIN_SIZE 256
  92
  93 /* Structure describing the beginning of each big block. */
  94
  95 typedef struct storeblock {
  96   struct storeblock *next;
  97   size_t length;
  98 } storeblock;
  99
 100 /* Just in case we find ourselves on a system where the structure above has a
 101 length that is not a multiple of the alignment, set up a macro for the padded
 102 length. */
 103
 104 #define ALIGNED_SIZEOF_STOREBLOCK \
 105   (((sizeof(storeblock) + alignment - 1) / alignment) * alignment)
 106
 107 /* Size of block to get from malloc to carve up into smaller ones. This
 108 must be a multiple of the alignment. We assume that 4096 is going to be
 109 suitably aligned.  Double the size per-pool for every malloc, to mitigate
 110 certain denial-of-service attacks.  Don't bother to decrease on block frees.
 111 We waste average half the current alloc size per pool.  This could be several
 112 hundred kB now, vs. 4kB with a constant-size block size.  But the search time
 113 for is_tainted(), linear in the number of blocks for the pool, is O(n log n)
 114 rather than O(n^2).
 115 A test of 2000 RCPTs and just accept ACL had 370kB in 21 blocks before,
 116 504kB in 6 blocks now, for the untainted-main (largest) pool.
 117 Builds for restricted-memory system can disable the expansion by
 118 defining RESTRICTED_MEMORY */
 119 /*XXX should we allow any for malloc's own overhead?  But how much? */
 120
 121 /* #define RESTRICTED_MEMORY */
 122 #define STORE_BLOCK_SIZE(order) ((1U << (order)) - ALIGNED_SIZEOF_STOREBLOCK)
 123
 124 /* Variables holding data for the local pools of store. The current pool number
 125 is held in store_pool, which is global so that it can be changed from outside.
 126 Setting the initial length values to -1 forces a malloc for the first call,
 127 even if the length is zero (which is used for getting a point to reset to). */
 128
 129 int store_pool = POOL_MAIN;
 130
 131 static storeblock *chainbase[NPOOLS];
 132 static storeblock *current_block[NPOOLS];
 133 static void *next_yield[NPOOLS];
 134 static int yield_length[NPOOLS];
 135 static unsigned store_block_order[NPOOLS];
 136
 137 /* pool_malloc holds the amount of memory used by the store pools; this goes up
 138 and down as store is reset or released. nonpool_malloc is the total got by
 139 malloc from other calls; this doesn't go down because it is just freed by
 140 pointer. */
 141
 142 static int pool_malloc;
 143 static int nonpool_malloc;
 144
 145 /* This variable is set by store_get() to its yield, and by store_reset() to
 146 NULL. This enables string_cat() to optimize its store handling for very long
 147 strings. That's why the variable is global. */
 148
 149 void *store_last_get[NPOOLS];
 150
 151 /* These are purely for stats-gathering */
 152
 153 static int nbytes[NPOOLS];      /* current bytes allocated */
 154 static int maxbytes[NPOOLS];    /* max number reached */
 155 static int nblocks[NPOOLS];     /* current number of blocks allocated */
 156 static int maxblocks[NPOOLS];
 157 static unsigned maxorder[NPOOLS];
 158 static int n_nonpool_blocks;    /* current number of direct store_malloc() blocks */
 159 static int max_nonpool_blocks;
 160 static int max_pool_malloc;     /* max value for pool_malloc */
 161 static int max_nonpool_malloc;  /* max value for nonpool_malloc */
 162
 163
 164 #ifndef COMPILE_UTILITY
 165 static const uschar * pooluse[NPOOLS] = {
 166 [POOL_MAIN] =           US"main",
 167 [POOL_PERM] =           US"perm",
 168 [POOL_SEARCH] =         US"search",
 169 [POOL_MESSAGE] =        US"message",
 170 [POOL_TAINT_MAIN] =     US"main",
 171 [POOL_TAINT_PERM] =     US"perm",
 172 [POOL_TAINT_SEARCH] =   US"search",
 173 [POOL_TAINT_SEARCH] =   US"search",
 174 [POOL_TAINT_MESSAGE] =  US"message",
 175 };
 176 static const uschar * poolclass[NPOOLS] = {
 177 [POOL_MAIN] =           US"untainted",
 178 [POOL_PERM] =           US"untainted",
 179 [POOL_SEARCH] =         US"untainted",
 180 [POOL_MESSAGE] =        US"untainted",
 181 [POOL_TAINT_MAIN] =     US"tainted",
 182 [POOL_TAINT_PERM] =     US"tainted",
 183 [POOL_TAINT_SEARCH] =   US"tainted",
 184 [POOL_TAINT_MESSAGE] =  US"tainted",
 185 };
 186 #endif
 187
 188
 189 static void * internal_store_malloc(int, const char *, int);
 190 static void   internal_store_free(void *, const char *, int linenumber);
 191
 192 /******************************************************************************/
 193 /* Initialisation, for things fragile with parameter channges when using
 194 static initialisers. */
 195
 196 void
 197 store_init(void)
 198 {
 199 for (int i = 0; i < NPOOLS; i++)
 200   {
 201   yield_length[i] = -1;
 202   store_block_order[i] = 12; /* log2(allocation_size) ie. 4kB */
 203   }
 204 store_block_order[POOL_MAIN] = 13;
 205 }
 206
 207 /******************************************************************************/
 208
 209 /* Test if a pointer refers to tainted memory.
 210
 211 Slower version check, for use when platform intermixes malloc and mmap area
 212 addresses. Test against the current-block of all tainted pools first, then all
 213 blocks of all tainted pools.
 214
 215 Return: TRUE iff tainted
 216 */
 217
 218 BOOL
 219 is_tainted_fn(const void * p)
 220 {
 221 storeblock * b;
 222
 223 for (int pool = POOL_TAINT_BASE; pool < nelem(chainbase); pool++)
 224   if ((b = current_block[pool]))
 225     {
 226     uschar * bc = US b + ALIGNED_SIZEOF_STOREBLOCK;
 227     if (US p >= bc && US p < bc + b->length) return TRUE;
 228     }
 229
 230 for (int pool = POOL_TAINT_BASE; pool < nelem(chainbase); pool++)
 231   for (b = chainbase[pool]; b; b = b->next)
 232     {
 233     uschar * bc = US b + ALIGNED_SIZEOF_STOREBLOCK;
 234     if (US p >= bc && US p < bc + b->length) return TRUE;
 235     }
 236 return FALSE;
 237 }
 238
 239
 240 void
 241 die_tainted(const uschar * msg, const uschar * func, int line)
 242 {
 243 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Taint mismatch, %s: %s %d\n",
 244         msg, func, line);
 245 }
 246
 247
 248
 249 /*************************************************
 250 *       Get a block from the current pool        *
 251 *************************************************/
 252
 253 /* Running out of store is a total disaster. This function is called via the
 254 macro store_get(). It passes back a block of store within the current big
 255 block, getting a new one if necessary. The address is saved in
 256 store_last_was_get.
 257
 258 Arguments:
 259   size        amount wanted, bytes
 260   tainted     class: set to true for untrusted data (eg. from smtp input)
 261   func        function from which called
 262   linenumber  line number in source file
 263
 264 Returns:      pointer to store (panic on malloc failure)
 265 */
 266
 267 void *
 268 store_get_3(int size, BOOL tainted, const char *func, int linenumber)
 269 {
 270 int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
 271
 272 /* Round up the size to a multiple of the alignment. Although this looks a
 273 messy statement, because "alignment" is a constant expression, the compiler can
 274 do a reasonable job of optimizing, especially if the value of "alignment" is a
 275 power of two. I checked this with -O2, and gcc did very well, compiling it to 4
 276 instructions on a Sparc (alignment = 8). */
 277
 278 if (size % alignment != 0) size += alignment - (size % alignment);
 279
 280 /* If there isn't room in the current block, get a new one. The minimum
 281 size is STORE_BLOCK_SIZE, and we would expect this to be the norm, since
 282 these functions are mostly called for small amounts of store. */
 283
 284 if (size > yield_length[pool])
 285   {
 286   int length = MAX(STORE_BLOCK_SIZE(store_block_order[pool]), size);
 287   int mlength = length + ALIGNED_SIZEOF_STOREBLOCK;
 288   storeblock * newblock;
 289
 290   /* Sometimes store_reset() may leave a block for us; check if we can use it */
 291
 292   if (  (newblock = current_block[pool])
 293      && (newblock = newblock->next)
 294      && newblock->length < length
 295      )
 296     {
 297     /* Give up on this block, because it's too small */
 298     nblocks[pool]--;
 299     internal_store_free(newblock, func, linenumber);
 300     newblock = NULL;
 301     }
 302
 303   /* If there was no free block, get a new one */
 304
 305   if (!newblock)
 306     {
 307     if ((nbytes[pool] += mlength) > maxbytes[pool])
 308       maxbytes[pool] = nbytes[pool];
 309     if ((pool_malloc += mlength) > max_pool_malloc)     /* Used in pools */
 310       max_pool_malloc = pool_malloc;
 311     nonpool_malloc -= mlength;                  /* Exclude from overall total */
 312     if (++nblocks[pool] > maxblocks[pool])
 313       maxblocks[pool] = nblocks[pool];
 314
 315     newblock = internal_store_malloc(mlength, func, linenumber);
 316     newblock->next = NULL;
 317     newblock->length = length;
 318 #ifndef RESTRICTED_MEMORY
 319     if (store_block_order[pool]++ > maxorder[pool])
 320       maxorder[pool] = store_block_order[pool];
 321 #endif
 322
 323     if (!chainbase[pool])
 324       chainbase[pool] = newblock;
 325     else
 326       current_block[pool]->next = newblock;
 327     }
 328
 329   current_block[pool] = newblock;
 330   yield_length[pool] = newblock->length;
 331   next_yield[pool] =
 332     (void *)(CS current_block[pool] + ALIGNED_SIZEOF_STOREBLOCK);
 333   (void) VALGRIND_MAKE_MEM_NOACCESS(next_yield[pool], yield_length[pool]);
 334   }
 335
 336 /* There's (now) enough room in the current block; the yield is the next
 337 pointer. */
 338
 339 store_last_get[pool] = next_yield[pool];
 340
 341 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 342 giving warnings. */
 343
 344 #ifndef COMPILE_UTILITY
 345 DEBUG(D_memory)
 346   debug_printf("---%d Get %6p %5d %-14s %4d\n", pool,
 347     store_last_get[pool], size, func, linenumber);
 348 #endif  /* COMPILE_UTILITY */
 349
 350 (void) VALGRIND_MAKE_MEM_UNDEFINED(store_last_get[pool], size);
 351 /* Update next pointer and number of bytes left in the current block. */
 352
 353 next_yield[pool] = (void *)(CS next_yield[pool] + size);
 354 yield_length[pool] -= size;
 355 return store_last_get[pool];
 356 }
 357
 358
 359
 360 /*************************************************
 361 *       Get a block from the PERM pool           *
 362 *************************************************/
 363
 364 /* This is just a convenience function, useful when just a single block is to
 365 be obtained.
 366
 367 Arguments:
 368   size        amount wanted
 369   func        function from which called
 370   linenumber  line number in source file
 371
 372 Returns:      pointer to store (panic on malloc failure)
 373 */
 374
 375 void *
 376 store_get_perm_3(int size, BOOL tainted, const char *func, int linenumber)
 377 {
 378 void *yield;
 379 int old_pool = store_pool;
 380 store_pool = POOL_PERM;
 381 yield = store_get_3(size, tainted, func, linenumber);
 382 store_pool = old_pool;
 383 return yield;
 384 }
 385
 386
 387
 388 /*************************************************
 389 *      Extend a block if it is at the top        *
 390 *************************************************/
 391
 392 /* While reading strings of unknown length, it is often the case that the
 393 string is being read into the block at the top of the stack. If it needs to be
 394 extended, it is more efficient just to extend within the top block rather than
 395 allocate a new block and then have to copy the data. This function is provided
 396 for the use of string_cat(), but of course can be used elsewhere too.
 397 The block itself is not expanded; only the top allocation from it.
 398
 399 Arguments:
 400   ptr        pointer to store block
 401   oldsize    current size of the block, as requested by user
 402   newsize    new size required
 403   func       function from which called
 404   linenumber line number in source file
 405
 406 Returns:     TRUE if the block is at the top of the stack and has been
 407              extended; FALSE if it isn't at the top of the stack, or cannot
 408              be extended
 409 */
 410
 411 BOOL
 412 store_extend_3(void *ptr, BOOL tainted, int oldsize, int newsize,
 413    const char *func, int linenumber)
 414 {
 415 int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
 416 int inc = newsize - oldsize;
 417 int rounded_oldsize = oldsize;
 418
 419 /* Check that the block being extended was already of the required taint status;
 420 refuse to extend if not. */
 421
 422 if (is_tainted(ptr) != tainted)
 423   return FALSE;
 424
 425 if (rounded_oldsize % alignment != 0)
 426   rounded_oldsize += alignment - (rounded_oldsize % alignment);
 427
 428 if (CS ptr + rounded_oldsize != CS (next_yield[pool]) ||
 429     inc > yield_length[pool] + rounded_oldsize - oldsize)
 430   return FALSE;
 431
 432 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 433 giving warnings. */
 434
 435 #ifndef COMPILE_UTILITY
 436 DEBUG(D_memory)
 437   debug_printf("---%d Ext %6p %5d %-14s %4d\n", pool, ptr, newsize,
 438     func, linenumber);
 439 #endif  /* COMPILE_UTILITY */
 440
 441 if (newsize % alignment != 0) newsize += alignment - (newsize % alignment);
 442 next_yield[pool] = CS ptr + newsize;
 443 yield_length[pool] -= newsize - rounded_oldsize;
 444 (void) VALGRIND_MAKE_MEM_UNDEFINED(ptr + oldsize, inc);
 445 return TRUE;
 446 }
 447
 448
 449
 450
 451 static BOOL
 452 is_pwr2_size(int len)
 453 {
 454 unsigned x = len;
 455 return (x & (x - 1)) == 0;
 456 }
 457
 458
 459 /*************************************************
 460 *    Back up to a previous point on the stack    *
 461 *************************************************/
 462
 463 /* This function resets the next pointer, freeing any subsequent whole blocks
 464 that are now unused. Call with a cookie obtained from store_mark() only; do
 465 not call with a pointer returned by store_get().  Both the untainted and tainted
 466 pools corresposding to store_pool are reset.
 467
 468 Arguments:
 469   r           place to back up to
 470   func        function from which called
 471   linenumber  line number in source file
 472
 473 Returns:      nothing
 474 */
 475
 476 static void
 477 internal_store_reset(void * ptr, int pool, const char *func, int linenumber)
 478 {
 479 storeblock * bb;
 480 storeblock * b = current_block[pool];
 481 char * bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
 482 int newlength, count;
 483 #ifndef COMPILE_UTILITY
 484 int oldmalloc = pool_malloc;
 485 #endif
 486
 487 /* Last store operation was not a get */
 488
 489 store_last_get[pool] = NULL;
 490
 491 /* See if the place is in the current block - as it often will be. Otherwise,
 492 search for the block in which it lies. */
 493
 494 if (CS ptr < bc || CS ptr > bc + b->length)
 495   {
 496   for (b = chainbase[pool]; b; b = b->next)
 497     {
 498     bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
 499     if (CS ptr >= bc && CS ptr <= bc + b->length) break;
 500     }
 501   if (!b)
 502     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "internal error: store_reset(%p) "
 503       "failed: pool=%d %-14s %4d", ptr, pool, func, linenumber);
 504   }
 505
 506 /* Back up, rounding to the alignment if necessary. When testing, flatten
 507 the released memory. */
 508
 509 newlength = bc + b->length - CS ptr;
 510 #ifndef COMPILE_UTILITY
 511 if (debug_store)
 512   {
 513   assert_no_variables(ptr, newlength, func, linenumber);
 514   if (f.running_in_test_harness)
 515     {
 516     (void) VALGRIND_MAKE_MEM_DEFINED(ptr, newlength);
 517     memset(ptr, 0xF0, newlength);
 518     }
 519   }
 520 #endif
 521 (void) VALGRIND_MAKE_MEM_NOACCESS(ptr, newlength);
 522 next_yield[pool] = CS ptr + (newlength % alignment);
 523 count = yield_length[pool];
 524 count = (yield_length[pool] = newlength - (newlength % alignment)) - count;
 525 current_block[pool] = b;
 526
 527 /* Free any subsequent block. Do NOT free the first
 528 successor, if our current block has less than 256 bytes left. This should
 529 prevent us from flapping memory. However, keep this block only when it has
 530 a power-of-two size so probably is not a custom inflated one. */
 531
 532 if (  yield_length[pool] < STOREPOOL_MIN_SIZE
 533    && b->next
 534    && is_pwr2_size(b->next->length + ALIGNED_SIZEOF_STOREBLOCK))
 535   {
 536   b = b->next;
 537 #ifndef COMPILE_UTILITY
 538   if (debug_store)
 539     assert_no_variables(b, b->length + ALIGNED_SIZEOF_STOREBLOCK,
 540                         func, linenumber);
 541 #endif
 542   (void) VALGRIND_MAKE_MEM_NOACCESS(CS b + ALIGNED_SIZEOF_STOREBLOCK,
 543                 b->length - ALIGNED_SIZEOF_STOREBLOCK);
 544   }
 545
 546 bb = b->next;
 547 b->next = NULL;
 548
 549 /* If there will be only one block left in the pool, drop one
 550 most-recent allocation size increase, ensuring it does not increase
 551 forever. */
 552
 553 if (!bb && store_block_order[pool] > 12) store_block_order[pool]--;
 554
 555 while ((b = bb))
 556   {
 557   int siz = b->length + ALIGNED_SIZEOF_STOREBLOCK;
 558 #ifndef COMPILE_UTILITY
 559   if (debug_store)
 560     assert_no_variables(b, b->length + ALIGNED_SIZEOF_STOREBLOCK,
 561                         func, linenumber);
 562 #endif
 563   bb = bb->next;
 564   nbytes[pool] -= siz;
 565   pool_malloc -= siz;
 566   nblocks[pool]--;
 567   internal_store_free(b, func, linenumber);
 568   }
 569
 570 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 571 giving warnings. */
 572
 573 #ifndef COMPILE_UTILITY
 574 DEBUG(D_memory)
 575   debug_printf("---%d Rst %6p %5d %-14s %4d\tpool %d\n", pool, ptr,
 576     count + oldmalloc - pool_malloc,
 577     func, linenumber, pool_malloc);
 578 #endif  /* COMPILE_UTILITY */
 579 }
 580
 581
 582 rmark
 583 store_reset_3(rmark r, const char *func, int linenumber)
 584 {
 585 void ** ptr = r;
 586
 587 if (store_pool >= POOL_TAINT_BASE)
 588   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 589     "store_reset called for pool %d: %s %d\n", store_pool, func, linenumber);
 590 if (!r)
 591   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 592     "store_reset called with bad mark: %s %d\n", func, linenumber);
 593
 594 internal_store_reset(*ptr, store_pool + POOL_TAINT_BASE, func, linenumber);
 595 internal_store_reset(ptr,  store_pool,             func, linenumber);
 596 return NULL;
 597 }
 598
 599
 600
 601 /* Free tail-end unused allocation.  This lets us allocate a big chunk
 602 early, for cases when we only discover later how much was really needed.
 603
 604 Can be called with a value from store_get(), or an offset after such.  Only
 605 the tainted or untainted pool that serviced the store_get() will be affected.
 606
 607 This is mostly a cut-down version of internal_store_reset().
 608 XXX needs rationalising
 609 */
 610
 611 void
 612 store_release_above_3(void *ptr, const char *func, int linenumber)
 613 {
 614 /* Search all pools' "current" blocks.  If it isn't one of those,
 615 ignore it (it usually will be). */
 616
 617 for (int pool = 0; pool < nelem(current_block); pool++)
 618   {
 619   storeblock * b = current_block[pool];
 620   char * bc;
 621   int count, newlength;
 622
 623   if (!b)
 624     continue;
 625
 626   bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
 627   if (CS ptr < bc || CS ptr > bc + b->length)
 628     continue;
 629
 630   /* Last store operation was not a get */
 631
 632   store_last_get[pool] = NULL;
 633
 634   /* Back up, rounding to the alignment if necessary. When testing, flatten
 635   the released memory. */
 636
 637   newlength = bc + b->length - CS ptr;
 638 #ifndef COMPILE_UTILITY
 639   if (debug_store)
 640     {
 641     assert_no_variables(ptr, newlength, func, linenumber);
 642     if (f.running_in_test_harness)
 643       {
 644       (void) VALGRIND_MAKE_MEM_DEFINED(ptr, newlength);
 645       memset(ptr, 0xF0, newlength);
 646       }
 647     }
 648 #endif
 649   (void) VALGRIND_MAKE_MEM_NOACCESS(ptr, newlength);
 650   next_yield[pool] = CS ptr + (newlength % alignment);
 651   count = yield_length[pool];
 652   count = (yield_length[pool] = newlength - (newlength % alignment)) - count;
 653
 654   /* Cut out the debugging stuff for utilities, but stop picky compilers from
 655   giving warnings. */
 656
 657 #ifndef COMPILE_UTILITY
 658   DEBUG(D_memory)
 659     debug_printf("---%d Rel %6p %5d %-14s %4d\tpool %d\n", pool, ptr, count,
 660       func, linenumber, pool_malloc);
 661 #endif
 662   return;
 663   }
 664 #ifndef COMPILE_UTILITY
 665 DEBUG(D_memory)
 666   debug_printf("non-last memory release try: %s %d\n", func, linenumber);
 667 #endif
 668 }
 669
 670
 671
 672 rmark
 673 store_mark_3(const char *func, int linenumber)
 674 {
 675 void ** p;
 676
 677 #ifndef COMPILE_UTILITY
 678 DEBUG(D_memory)
 679   debug_printf("---%d Mrk                    %-14s %4d\tpool %d\n",
 680     store_pool, func, linenumber, pool_malloc);
 681 #endif  /* COMPILE_UTILITY */
 682
 683 if (store_pool >= POOL_TAINT_BASE)
 684   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 685     "store_mark called for pool %d: %s %d\n", store_pool, func, linenumber);
 686
 687 /* Stash a mark for the tainted-twin release, in the untainted twin. Return
 688 a cookie (actually the address in the untainted pool) to the caller.
 689 Reset uses the cookie to recover the t-mark, winds back the tainted pool with it
 690 and winds back the untainted pool with the cookie. */
 691
 692 p = store_get_3(sizeof(void *), FALSE, func, linenumber);
 693 *p = store_get_3(0, TRUE, func, linenumber);
 694 return p;
 695 }
 696
 697
 698
 699
 700 /************************************************
 701 *             Release store                     *
 702 ************************************************/
 703
 704 /* This function checks that the pointer it is given is the first thing in a
 705 block, and if so, releases that block.
 706
 707 Arguments:
 708   block       block of store to consider
 709   func        function from which called
 710   linenumber  line number in source file
 711
 712 Returns:      nothing
 713 */
 714
 715 static void
 716 store_release_3(void * block, int pool, const char * func, int linenumber)
 717 {
 718 /* It will never be the first block, so no need to check that. */
 719
 720 for (storeblock * b = chainbase[pool]; b; b = b->next)
 721   {
 722   storeblock * bb = b->next;
 723   if (bb && CS block == CS bb + ALIGNED_SIZEOF_STOREBLOCK)
 724     {
 725     int siz = bb->length + ALIGNED_SIZEOF_STOREBLOCK;
 726     b->next = bb->next;
 727     nbytes[pool] -= siz;
 728     pool_malloc -= siz;
 729     nblocks[pool]--;
 730
 731     /* Cut out the debugging stuff for utilities, but stop picky compilers
 732     from giving warnings. */
 733
 734 #ifndef COMPILE_UTILITY
 735     DEBUG(D_memory)
 736       debug_printf("-Release %6p %-20s %4d %d\n", (void *)bb, func,
 737         linenumber, pool_malloc);
 738
 739     if (f.running_in_test_harness)
 740       memset(bb, 0xF0, bb->length+ALIGNED_SIZEOF_STOREBLOCK);
 741 #endif  /* COMPILE_UTILITY */
 742
 743     free(bb);
 744     return;
 745     }
 746   }
 747 }
 748
 749
 750 /************************************************
 751 *             Move store                        *
 752 ************************************************/
 753
 754 /* Allocate a new block big enough to expend to the given size and
 755 copy the current data into it.  Free the old one if possible.
 756
 757 This function is specifically provided for use when reading very
 758 long strings, e.g. header lines. When the string gets longer than a
 759 complete block, it gets copied to a new block. It is helpful to free
 760 the old block iff the previous copy of the string is at its start,
 761 and therefore the only thing in it. Otherwise, for very long strings,
 762 dead store can pile up somewhat disastrously. This function checks that
 763 the pointer it is given is the first thing in a block, and that nothing
 764 has been allocated since. If so, releases that block.
 765
 766 Arguments:
 767   block
 768   newsize
 769   len
 770
 771 Returns:        new location of data
 772 */
 773
 774 void *
 775 store_newblock_3(void * block, BOOL tainted, int newsize, int len,
 776   const char * func, int linenumber)
 777 {
 778 int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
 779 BOOL release_ok = !tainted && store_last_get[pool] == block;
 780 uschar * newtext;
 781
 782 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 783 if (is_tainted(block) != tainted)
 784   die_tainted(US"store_newblock", CUS func, linenumber);
 785 #endif
 786
 787 newtext = store_get(newsize, tainted);
 788 memcpy(newtext, block, len);
 789 if (release_ok) store_release_3(block, pool, func, linenumber);
 790 return (void *)newtext;
 791 }
 792
 793
 794
 795
 796 /*************************************************
 797 *                Malloc store                    *
 798 *************************************************/
 799
 800 /* Running out of store is a total disaster for exim. Some malloc functions
 801 do not run happily on very small sizes, nor do they document this fact. This
 802 function is called via the macro store_malloc().
 803
 804 Arguments:
 805   size        amount of store wanted
 806   func        function from which called
 807   line        line number in source file
 808
 809 Returns:      pointer to gotten store (panic on failure)
 810 */
 811
 812 static void *
 813 internal_store_malloc(int size, const char *func, int line)
 814 {
 815 void * yield;
 816
 817 #ifndef COMPILE_UTILITY
 818 DEBUG(D_memory) size += sizeof(int);    /* space to store the size */
 819 #endif
 820
 821 if (size < 16) size = 16;
 822
 823 if (!(yield = malloc((size_t)size)))
 824   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to malloc %d bytes of memory: "
 825     "called from line %d in %s", size, line, func);
 826
 827 #ifndef COMPILE_UTILITY
 828 DEBUG(D_memory) { *(int *)yield = size; yield = US yield + sizeof(int); }
 829 #endif
 830
 831 if ((nonpool_malloc += size) > max_nonpool_malloc)
 832   max_nonpool_malloc = nonpool_malloc;
 833
 834 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 835 giving warnings. */
 836
 837 #ifndef COMPILE_UTILITY
 838 /* If running in test harness, spend time making sure all the new store
 839 is not filled with zeros so as to catch problems. */
 840
 841 if (f.running_in_test_harness)
 842   memset(yield, 0xF0, (size_t)size - sizeof(int));
 843 DEBUG(D_memory) debug_printf("--Malloc %6p %5d bytes\t%-20s %4d\tpool %5d  nonpool %5d\n",
 844   yield, size, func, line, pool_malloc, nonpool_malloc);
 845 #endif  /* COMPILE_UTILITY */
 846
 847 return yield;
 848 }
 849
 850 void *
 851 store_malloc_3(int size, const char *func, int linenumber)
 852 {
 853 if (n_nonpool_blocks++ > max_nonpool_blocks)
 854   max_nonpool_blocks = n_nonpool_blocks;
 855 return internal_store_malloc(size, func, linenumber);
 856 }
 857
 858
 859 /************************************************
 860 *             Free store                        *
 861 ************************************************/
 862
 863 /* This function is called by the macro store_free().
 864
 865 Arguments:
 866   block       block of store to free
 867   func        function from which called
 868   linenumber  line number in source file
 869
 870 Returns:      nothing
 871 */
 872
 873 static void
 874 internal_store_free(void * block, const char * func, int linenumber)
 875 {
 876 uschar * p = block;
 877 #ifndef COMPILE_UTILITY
 878 DEBUG(D_memory) { p -= sizeof(int); nonpool_malloc -= *(int *)p; }
 879 DEBUG(D_memory) debug_printf("----Free %6p %5d bytes\t%-20s %4d\n", block, *(int *)p, func, linenumber);
 880 #endif
 881 free(p);
 882 }
 883
 884 void
 885 store_free_3(void * block, const char * func, int linenumber)
 886 {
 887 n_nonpool_blocks--;
 888 internal_store_free(block, func, linenumber);
 889 }
 890
 891 /******************************************************************************/
 892 /* Stats output on process exit */
 893 void
 894 store_exit(void)
 895 {
 896 #ifndef COMPILE_UTILITY
 897 DEBUG(D_memory)
 898  {
 899  debug_printf("----Exit nonpool max: %3d kB in %d blocks\n",
 900   (max_nonpool_malloc+1023)/1024, max_nonpool_blocks);
 901  debug_printf("----Exit npools  max: %3d kB\n", max_pool_malloc/1024);
 902  for (int i = 0; i < NPOOLS; i++)
 903   debug_printf("----Exit  pool %d max: %3d kB in %d blocks at order %u\t%s %s\n",
 904     i, maxbytes[i]/1024, maxblocks[i], maxorder[i],
 905     poolclass[i], pooluse[i]);
 906  }
 907 #endif
 908 }
 909
 910
 911 /******************************************************************************/
 912 /* Per-message pool management */
 913
 914 static rmark   message_reset_point    = NULL;
 915
 916 void
 917 message_start(void)
 918 {
 919 int oldpool = store_pool;
 920 store_pool = POOL_MESSAGE;
 921 if (!message_reset_point) message_reset_point = store_mark();
 922 store_pool = oldpool;
 923 }
 924
 925 void message_tidyup(void)
 926 {
 927 int oldpool;
 928 if (!message_reset_point) return;
 929 oldpool = store_pool;
 930 store_pool = POOL_MESSAGE;
 931 message_reset_point = store_reset(message_reset_point);
 932 store_pool = oldpool;
 933 }
 934
 935 /* End of store.c */