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