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