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 }
 205
 206 /******************************************************************************/
 207
 208 /* Test if a pointer refers to tainted memory.
 209
 210 Slower version check, for use when platform intermixes malloc and mmap area
 211 addresses. Test against the current-block of all tainted pools first, then all
 212 blocks of all tainted pools.
 213
 214 Return: TRUE iff tainted
 215 */
 216
 217 BOOL
 218 is_tainted_fn(const void * p)
 219 {
 220 storeblock * b;
 221
 222 for (int pool = POOL_TAINT_BASE; pool < nelem(chainbase); pool++)
 223   if ((b = current_block[pool]))
 224     {
 225     uschar * bc = US b + ALIGNED_SIZEOF_STOREBLOCK;
 226     if (US p >= bc && US p < bc + b->length) return TRUE;
 227     }
 228
 229 for (int pool = POOL_TAINT_BASE; pool < nelem(chainbase); pool++)
 230   for (b = chainbase[pool]; b; b = b->next)
 231     {
 232     uschar * bc = US b + ALIGNED_SIZEOF_STOREBLOCK;
 233     if (US p >= bc && US p < bc + b->length) return TRUE;
 234     }
 235 return FALSE;
 236 }
 237
 238
 239 void
 240 die_tainted(const uschar * msg, const uschar * func, int line)
 241 {
 242 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Taint mismatch, %s: %s %d\n",
 243         msg, func, line);
 244 }
 245
 246
 247
 248 /*************************************************
 249 *       Get a block from the current pool        *
 250 *************************************************/
 251
 252 /* Running out of store is a total disaster. This function is called via the
 253 macro store_get(). It passes back a block of store within the current big
 254 block, getting a new one if necessary. The address is saved in
 255 store_last_was_get.
 256
 257 Arguments:
 258   size        amount wanted, bytes
 259   tainted     class: set to true for untrusted data (eg. from smtp input)
 260   func        function from which called
 261   linenumber  line number in source file
 262
 263 Returns:      pointer to store (panic on malloc failure)
 264 */
 265
 266 void *
 267 store_get_3(int size, BOOL tainted, const char *func, int linenumber)
 268 {
 269 int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
 270
 271 /* Ensure we've been asked to allocate memory.
 272 A negative size is a sign of a security problem.
 273 A zero size is also suspect (but we might have to allow it if we find our API
 274 expects it in some places). */
 275 if (size < 1)
 276   {
 277   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 278             "bad memory allocation requested (%d bytes) at %s %d",
 279             size, func, linenumber);
 280   }
 281
 282 /* Round up the size to a multiple of the alignment. Although this looks a
 283 messy statement, because "alignment" is a constant expression, the compiler can
 284 do a reasonable job of optimizing, especially if the value of "alignment" is a
 285 power of two. I checked this with -O2, and gcc did very well, compiling it to 4
 286 instructions on a Sparc (alignment = 8). */
 287
 288 if (size % alignment != 0) size += alignment - (size % alignment);
 289
 290 /* If there isn't room in the current block, get a new one. The minimum
 291 size is STORE_BLOCK_SIZE, and we would expect this to be the norm, since
 292 these functions are mostly called for small amounts of store. */
 293
 294 if (size > yield_length[pool])
 295   {
 296   int length = MAX(
 297           STORE_BLOCK_SIZE(store_block_order[pool]) - ALIGNED_SIZEOF_STOREBLOCK,
 298           size);
 299   int mlength = length + ALIGNED_SIZEOF_STOREBLOCK;
 300   storeblock * newblock;
 301
 302   /* Sometimes store_reset() may leave a block for us; check if we can use it */
 303
 304   if (  (newblock = current_block[pool])
 305      && (newblock = newblock->next)
 306      && newblock->length < length
 307      )
 308     {
 309     /* Give up on this block, because it's too small */
 310     nblocks[pool]--;
 311     internal_store_free(newblock, func, linenumber);
 312     newblock = NULL;
 313     }
 314
 315   /* If there was no free block, get a new one */
 316
 317   if (!newblock)
 318     {
 319     if ((nbytes[pool] += mlength) > maxbytes[pool])
 320       maxbytes[pool] = nbytes[pool];
 321     if ((pool_malloc += mlength) > max_pool_malloc)     /* Used in pools */
 322       max_pool_malloc = pool_malloc;
 323     nonpool_malloc -= mlength;                  /* Exclude from overall total */
 324     if (++nblocks[pool] > maxblocks[pool])
 325       maxblocks[pool] = nblocks[pool];
 326
 327     newblock = internal_store_malloc(mlength, func, linenumber);
 328     newblock->next = NULL;
 329     newblock->length = length;
 330 #ifndef RESTRICTED_MEMORY
 331     if (store_block_order[pool]++ > maxorder[pool])
 332       maxorder[pool] = store_block_order[pool];
 333 #endif
 334
 335     if (!chainbase[pool])
 336       chainbase[pool] = newblock;
 337     else
 338       current_block[pool]->next = newblock;
 339     }
 340
 341   current_block[pool] = newblock;
 342   yield_length[pool] = newblock->length;
 343   next_yield[pool] =
 344     (void *)(CS current_block[pool] + ALIGNED_SIZEOF_STOREBLOCK);
 345   (void) VALGRIND_MAKE_MEM_NOACCESS(next_yield[pool], yield_length[pool]);
 346   }
 347
 348 /* There's (now) enough room in the current block; the yield is the next
 349 pointer. */
 350
 351 store_last_get[pool] = next_yield[pool];
 352
 353 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 354 giving warnings. */
 355
 356 #ifndef COMPILE_UTILITY
 357 DEBUG(D_memory)
 358   debug_printf("---%d Get %6p %5d %-14s %4d\n", pool,
 359     store_last_get[pool], size, func, linenumber);
 360 #endif  /* COMPILE_UTILITY */
 361
 362 (void) VALGRIND_MAKE_MEM_UNDEFINED(store_last_get[pool], size);
 363 /* Update next pointer and number of bytes left in the current block. */
 364
 365 next_yield[pool] = (void *)(CS next_yield[pool] + size);
 366 yield_length[pool] -= size;
 367 return store_last_get[pool];
 368 }
 369
 370
 371
 372 /*************************************************
 373 *       Get a block from the PERM pool           *
 374 *************************************************/
 375
 376 /* This is just a convenience function, useful when just a single block is to
 377 be obtained.
 378
 379 Arguments:
 380   size        amount wanted
 381   func        function from which called
 382   linenumber  line number in source file
 383
 384 Returns:      pointer to store (panic on malloc failure)
 385 */
 386
 387 void *
 388 store_get_perm_3(int size, BOOL tainted, const char *func, int linenumber)
 389 {
 390 void *yield;
 391 int old_pool = store_pool;
 392 store_pool = POOL_PERM;
 393 yield = store_get_3(size, tainted, func, linenumber);
 394 store_pool = old_pool;
 395 return yield;
 396 }
 397
 398
 399
 400 /*************************************************
 401 *      Extend a block if it is at the top        *
 402 *************************************************/
 403
 404 /* While reading strings of unknown length, it is often the case that the
 405 string is being read into the block at the top of the stack. If it needs to be
 406 extended, it is more efficient just to extend within the top block rather than
 407 allocate a new block and then have to copy the data. This function is provided
 408 for the use of string_cat(), but of course can be used elsewhere too.
 409 The block itself is not expanded; only the top allocation from it.
 410
 411 Arguments:
 412   ptr        pointer to store block
 413   oldsize    current size of the block, as requested by user
 414   newsize    new size required
 415   func       function from which called
 416   linenumber line number in source file
 417
 418 Returns:     TRUE if the block is at the top of the stack and has been
 419              extended; FALSE if it isn't at the top of the stack, or cannot
 420              be extended
 421 */
 422
 423 BOOL
 424 store_extend_3(void *ptr, BOOL tainted, int oldsize, int newsize,
 425    const char *func, int linenumber)
 426 {
 427 int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
 428 int inc = newsize - oldsize;
 429 int rounded_oldsize = oldsize;
 430
 431 /* Check that the block being extended was already of the required taint status;
 432 refuse to extend if not. */
 433
 434 if (is_tainted(ptr) != tainted)
 435   return FALSE;
 436
 437 if (rounded_oldsize % alignment != 0)
 438   rounded_oldsize += alignment - (rounded_oldsize % alignment);
 439
 440 if (CS ptr + rounded_oldsize != CS (next_yield[pool]) ||
 441     inc > yield_length[pool] + rounded_oldsize - oldsize)
 442   return FALSE;
 443
 444 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 445 giving warnings. */
 446
 447 #ifndef COMPILE_UTILITY
 448 DEBUG(D_memory)
 449   debug_printf("---%d Ext %6p %5d %-14s %4d\n", pool, ptr, newsize,
 450     func, linenumber);
 451 #endif  /* COMPILE_UTILITY */
 452
 453 if (newsize % alignment != 0) newsize += alignment - (newsize % alignment);
 454 next_yield[pool] = CS ptr + newsize;
 455 yield_length[pool] -= newsize - rounded_oldsize;
 456 (void) VALGRIND_MAKE_MEM_UNDEFINED(ptr + oldsize, inc);
 457 return TRUE;
 458 }
 459
 460
 461
 462
 463 static BOOL
 464 is_pwr2_size(int len)
 465 {
 466 unsigned x = len;
 467 return (x & (x - 1)) == 0;
 468 }
 469
 470
 471 /*************************************************
 472 *    Back up to a previous point on the stack    *
 473 *************************************************/
 474
 475 /* This function resets the next pointer, freeing any subsequent whole blocks
 476 that are now unused. Call with a cookie obtained from store_mark() only; do
 477 not call with a pointer returned by store_get().  Both the untainted and tainted
 478 pools corresposding to store_pool are reset.
 479
 480 Arguments:
 481   r           place to back up to
 482   func        function from which called
 483   linenumber  line number in source file
 484
 485 Returns:      nothing
 486 */
 487
 488 static void
 489 internal_store_reset(void * ptr, int pool, const char *func, int linenumber)
 490 {
 491 storeblock * bb;
 492 storeblock * b = current_block[pool];
 493 char * bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
 494 int newlength, count;
 495 #ifndef COMPILE_UTILITY
 496 int oldmalloc = pool_malloc;
 497 #endif
 498
 499 /* Last store operation was not a get */
 500
 501 store_last_get[pool] = NULL;
 502
 503 /* See if the place is in the current block - as it often will be. Otherwise,
 504 search for the block in which it lies. */
 505
 506 if (CS ptr < bc || CS ptr > bc + b->length)
 507   {
 508   for (b = chainbase[pool]; b; b = b->next)
 509     {
 510     bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
 511     if (CS ptr >= bc && CS ptr <= bc + b->length) break;
 512     }
 513   if (!b)
 514     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "internal error: store_reset(%p) "
 515       "failed: pool=%d %-14s %4d", ptr, pool, func, linenumber);
 516   }
 517
 518 /* Back up, rounding to the alignment if necessary. When testing, flatten
 519 the released memory. */
 520
 521 newlength = bc + b->length - CS ptr;
 522 #ifndef COMPILE_UTILITY
 523 if (debug_store)
 524   {
 525   assert_no_variables(ptr, newlength, func, linenumber);
 526   if (f.running_in_test_harness)
 527     {
 528     (void) VALGRIND_MAKE_MEM_DEFINED(ptr, newlength);
 529     memset(ptr, 0xF0, newlength);
 530     }
 531   }
 532 #endif
 533 (void) VALGRIND_MAKE_MEM_NOACCESS(ptr, newlength);
 534 next_yield[pool] = CS ptr + (newlength % alignment);
 535 count = yield_length[pool];
 536 count = (yield_length[pool] = newlength - (newlength % alignment)) - count;
 537 current_block[pool] = b;
 538
 539 /* Free any subsequent block. Do NOT free the first
 540 successor, if our current block has less than 256 bytes left. This should
 541 prevent us from flapping memory. However, keep this block only when it has
 542 a power-of-two size so probably is not a custom inflated one. */
 543
 544 if (  yield_length[pool] < STOREPOOL_MIN_SIZE
 545    && b->next
 546    && is_pwr2_size(b->next->length + ALIGNED_SIZEOF_STOREBLOCK))
 547   {
 548   b = b->next;
 549 #ifndef COMPILE_UTILITY
 550   if (debug_store)
 551     assert_no_variables(b, b->length + ALIGNED_SIZEOF_STOREBLOCK,
 552                         func, linenumber);
 553 #endif
 554   (void) VALGRIND_MAKE_MEM_NOACCESS(CS b + ALIGNED_SIZEOF_STOREBLOCK,
 555                 b->length - ALIGNED_SIZEOF_STOREBLOCK);
 556   }
 557
 558 bb = b->next;
 559 b->next = NULL;
 560
 561 while ((b = bb))
 562   {
 563   int siz = b->length + ALIGNED_SIZEOF_STOREBLOCK;
 564
 565 #ifndef COMPILE_UTILITY
 566   if (debug_store)
 567     assert_no_variables(b, b->length + ALIGNED_SIZEOF_STOREBLOCK,
 568                         func, linenumber);
 569 #endif
 570   bb = bb->next;
 571   nbytes[pool] -= siz;
 572   pool_malloc -= siz;
 573   nblocks[pool]--;
 574   internal_store_free(b, func, linenumber);
 575
 576 #ifndef RESTRICTED_MEMORY
 577   if (store_block_order[pool] > 13) store_block_order[pool]--;
 578 #endif
 579   }
 580
 581 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 582 giving warnings. */
 583
 584 #ifndef COMPILE_UTILITY
 585 DEBUG(D_memory)
 586   debug_printf("---%d Rst %6p %5d %-14s %4d\tpool %d\n", pool, ptr,
 587     count + oldmalloc - pool_malloc,
 588     func, linenumber, pool_malloc);
 589 #endif  /* COMPILE_UTILITY */
 590 }
 591
 592
 593 rmark
 594 store_reset_3(rmark r, const char *func, int linenumber)
 595 {
 596 void ** ptr = r;
 597
 598 if (store_pool >= POOL_TAINT_BASE)
 599   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 600     "store_reset called for pool %d: %s %d\n", store_pool, func, linenumber);
 601 if (!r)
 602   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 603     "store_reset called with bad mark: %s %d\n", func, linenumber);
 604
 605 internal_store_reset(*ptr, store_pool + POOL_TAINT_BASE, func, linenumber);
 606 internal_store_reset(ptr,  store_pool,             func, linenumber);
 607 return NULL;
 608 }
 609
 610
 611
 612 /* Free tail-end unused allocation.  This lets us allocate a big chunk
 613 early, for cases when we only discover later how much was really needed.
 614
 615 Can be called with a value from store_get(), or an offset after such.  Only
 616 the tainted or untainted pool that serviced the store_get() will be affected.
 617
 618 This is mostly a cut-down version of internal_store_reset().
 619 XXX needs rationalising
 620 */
 621
 622 void
 623 store_release_above_3(void *ptr, const char *func, int linenumber)
 624 {
 625 /* Search all pools' "current" blocks.  If it isn't one of those,
 626 ignore it (it usually will be). */
 627
 628 for (int pool = 0; pool < nelem(current_block); pool++)
 629   {
 630   storeblock * b = current_block[pool];
 631   char * bc;
 632   int count, newlength;
 633
 634   if (!b)
 635     continue;
 636
 637   bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
 638   if (CS ptr < bc || CS ptr > bc + b->length)
 639     continue;
 640
 641   /* Last store operation was not a get */
 642
 643   store_last_get[pool] = NULL;
 644
 645   /* Back up, rounding to the alignment if necessary. When testing, flatten
 646   the released memory. */
 647
 648   newlength = bc + b->length - CS ptr;
 649 #ifndef COMPILE_UTILITY
 650   if (debug_store)
 651     {
 652     assert_no_variables(ptr, newlength, func, linenumber);
 653     if (f.running_in_test_harness)
 654       {
 655       (void) VALGRIND_MAKE_MEM_DEFINED(ptr, newlength);
 656       memset(ptr, 0xF0, newlength);
 657       }
 658     }
 659 #endif
 660   (void) VALGRIND_MAKE_MEM_NOACCESS(ptr, newlength);
 661   next_yield[pool] = CS ptr + (newlength % alignment);
 662   count = yield_length[pool];
 663   count = (yield_length[pool] = newlength - (newlength % alignment)) - count;
 664
 665   /* Cut out the debugging stuff for utilities, but stop picky compilers from
 666   giving warnings. */
 667
 668 #ifndef COMPILE_UTILITY
 669   DEBUG(D_memory)
 670     debug_printf("---%d Rel %6p %5d %-14s %4d\tpool %d\n", pool, ptr, count,
 671       func, linenumber, pool_malloc);
 672 #endif
 673   return;
 674   }
 675 #ifndef COMPILE_UTILITY
 676 DEBUG(D_memory)
 677   debug_printf("non-last memory release try: %s %d\n", func, linenumber);
 678 #endif
 679 }
 680
 681
 682
 683 rmark
 684 store_mark_3(const char *func, int linenumber)
 685 {
 686 void ** p;
 687
 688 #ifndef COMPILE_UTILITY
 689 DEBUG(D_memory)
 690   debug_printf("---%d Mrk                    %-14s %4d\tpool %d\n",
 691     store_pool, func, linenumber, pool_malloc);
 692 #endif  /* COMPILE_UTILITY */
 693
 694 if (store_pool >= POOL_TAINT_BASE)
 695   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
 696     "store_mark called for pool %d: %s %d\n", store_pool, func, linenumber);
 697
 698 /* Stash a mark for the tainted-twin release, in the untainted twin. Return
 699 a cookie (actually the address in the untainted pool) to the caller.
 700 Reset uses the cookie to recover the t-mark, winds back the tainted pool with it
 701 and winds back the untainted pool with the cookie. */
 702
 703 p = store_get_3(sizeof(void *), FALSE, func, linenumber);
 704 *p = store_get_3(0, TRUE, func, linenumber);
 705 return p;
 706 }
 707
 708
 709
 710
 711 /************************************************
 712 *             Release store                     *
 713 ************************************************/
 714
 715 /* This function checks that the pointer it is given is the first thing in a
 716 block, and if so, releases that block.
 717
 718 Arguments:
 719   block       block of store to consider
 720   func        function from which called
 721   linenumber  line number in source file
 722
 723 Returns:      nothing
 724 */
 725
 726 static void
 727 store_release_3(void * block, int pool, const char * func, int linenumber)
 728 {
 729 /* It will never be the first block, so no need to check that. */
 730
 731 for (storeblock * b = chainbase[pool]; b; b = b->next)
 732   {
 733   storeblock * bb = b->next;
 734   if (bb && CS block == CS bb + ALIGNED_SIZEOF_STOREBLOCK)
 735     {
 736     int siz = bb->length + ALIGNED_SIZEOF_STOREBLOCK;
 737     b->next = bb->next;
 738     nbytes[pool] -= siz;
 739     pool_malloc -= siz;
 740     nblocks[pool]--;
 741
 742     /* Cut out the debugging stuff for utilities, but stop picky compilers
 743     from giving warnings. */
 744
 745 #ifndef COMPILE_UTILITY
 746     DEBUG(D_memory)
 747       debug_printf("-Release %6p %-20s %4d %d\n", (void *)bb, func,
 748         linenumber, pool_malloc);
 749
 750     if (f.running_in_test_harness)
 751       memset(bb, 0xF0, bb->length+ALIGNED_SIZEOF_STOREBLOCK);
 752 #endif  /* COMPILE_UTILITY */
 753
 754     internal_store_free(bb, func, linenumber);
 755     return;
 756     }
 757   }
 758 }
 759
 760
 761 /************************************************
 762 *             Move store                        *
 763 ************************************************/
 764
 765 /* Allocate a new block big enough to expend to the given size and
 766 copy the current data into it.  Free the old one if possible.
 767
 768 This function is specifically provided for use when reading very
 769 long strings, e.g. header lines. When the string gets longer than a
 770 complete block, it gets copied to a new block. It is helpful to free
 771 the old block iff the previous copy of the string is at its start,
 772 and therefore the only thing in it. Otherwise, for very long strings,
 773 dead store can pile up somewhat disastrously. This function checks that
 774 the pointer it is given is the first thing in a block, and that nothing
 775 has been allocated since. If so, releases that block.
 776
 777 Arguments:
 778   block
 779   newsize
 780   len
 781
 782 Returns:        new location of data
 783 */
 784
 785 void *
 786 store_newblock_3(void * block, BOOL tainted, int newsize, int len,
 787   const char * func, int linenumber)
 788 {
 789 int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
 790 BOOL release_ok = !tainted && store_last_get[pool] == block;
 791 uschar * newtext;
 792
 793 #if !defined(MACRO_PREDEF) && !defined(COMPILE_UTILITY)
 794 if (is_tainted(block) != tainted)
 795   die_tainted(US"store_newblock", CUS func, linenumber);
 796 #endif
 797
 798 newtext = store_get(newsize, tainted);
 799 memcpy(newtext, block, len);
 800 if (release_ok) store_release_3(block, pool, func, linenumber);
 801 return (void *)newtext;
 802 }
 803
 804
 805
 806
 807 /*************************************************
 808 *                Malloc store                    *
 809 *************************************************/
 810
 811 /* Running out of store is a total disaster for exim. Some malloc functions
 812 do not run happily on very small sizes, nor do they document this fact. This
 813 function is called via the macro store_malloc().
 814
 815 Arguments:
 816   size        amount of store wanted
 817   func        function from which called
 818   line        line number in source file
 819
 820 Returns:      pointer to gotten store (panic on failure)
 821 */
 822
 823 static void *
 824 internal_store_malloc(int size, const char *func, int line)
 825 {
 826 void * yield;
 827
 828 size += sizeof(int);    /* space to store the size, used under debug */
 829 if (size < 16) size = 16;
 830
 831 if (!(yield = malloc((size_t)size)))
 832   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to malloc %d bytes of memory: "
 833     "called from line %d in %s", size, line, func);
 834
 835 #ifndef COMPILE_UTILITY
 836 DEBUG(D_any) *(int *)yield = size;
 837 #endif
 838 yield = US yield + sizeof(int);
 839
 840 if ((nonpool_malloc += size) > max_nonpool_malloc)
 841   max_nonpool_malloc = nonpool_malloc;
 842
 843 /* Cut out the debugging stuff for utilities, but stop picky compilers from
 844 giving warnings. */
 845
 846 #ifndef COMPILE_UTILITY
 847 /* If running in test harness, spend time making sure all the new store
 848 is not filled with zeros so as to catch problems. */
 849
 850 if (f.running_in_test_harness)
 851   memset(yield, 0xF0, (size_t)size - sizeof(int));
 852 DEBUG(D_memory) debug_printf("--Malloc %6p %5d bytes\t%-20s %4d\tpool %5d  nonpool %5d\n",
 853   yield, size, func, line, pool_malloc, nonpool_malloc);
 854 #endif  /* COMPILE_UTILITY */
 855
 856 return yield;
 857 }
 858
 859 void *
 860 store_malloc_3(int size, const char *func, int linenumber)
 861 {
 862 if (n_nonpool_blocks++ > max_nonpool_blocks)
 863   max_nonpool_blocks = n_nonpool_blocks;
 864 return internal_store_malloc(size, func, linenumber);
 865 }
 866
 867
 868 /************************************************
 869 *             Free store                        *
 870 ************************************************/
 871
 872 /* This function is called by the macro store_free().
 873
 874 Arguments:
 875   block       block of store to free
 876   func        function from which called
 877   linenumber  line number in source file
 878
 879 Returns:      nothing
 880 */
 881
 882 static void
 883 internal_store_free(void * block, const char * func, int linenumber)
 884 {
 885 uschar * p = US block - sizeof(int);
 886 #ifndef COMPILE_UTILITY
 887 DEBUG(D_any) nonpool_malloc -= *(int *)p;
 888 DEBUG(D_memory) debug_printf("----Free %6p %5d bytes\t%-20s %4d\n", block, *(int *)p, func, linenumber);
 889 #endif
 890 free(p);
 891 }
 892
 893 void
 894 store_free_3(void * block, const char * func, int linenumber)
 895 {
 896 n_nonpool_blocks--;
 897 internal_store_free(block, func, linenumber);
 898 }
 899
 900 /******************************************************************************/
 901 /* Stats output on process exit */
 902 void
 903 store_exit(void)
 904 {
 905 #ifndef COMPILE_UTILITY
 906 DEBUG(D_memory)
 907  {
 908  debug_printf("----Exit nonpool max: %3d kB in %d blocks\n",
 909   (max_nonpool_malloc+1023)/1024, max_nonpool_blocks);
 910  debug_printf("----Exit npools  max: %3d kB\n", max_pool_malloc/1024);
 911  for (int i = 0; i < NPOOLS; i++)
 912   debug_printf("----Exit  pool %d max: %3d kB in %d blocks at order %u\t%s %s\n",
 913     i, (maxbytes[i]+1023)/1024, maxblocks[i], maxorder[i],
 914     poolclass[i], pooluse[i]);
 915  }
 916 #endif
 917 }
 918
 919
 920 /******************************************************************************/
 921 /* Per-message pool management */
 922
 923 static rmark   message_reset_point    = NULL;
 924
 925 void
 926 message_start(void)
 927 {
 928 int oldpool = store_pool;
 929 store_pool = POOL_MESSAGE;
 930 if (!message_reset_point) message_reset_point = store_mark();
 931 store_pool = oldpool;
 932 }
 933
 934 void message_tidyup(void)
 935 {
 936 int oldpool;
 937 if (!message_reset_point) return;
 938 oldpool = store_pool;
 939 store_pool = POOL_MESSAGE;
 940 message_reset_point = store_reset(message_reset_point);
 941 store_pool = oldpool;
 942 }
 943
 944 /* End of store.c */