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