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