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