684f83cf0c27557937aa058e1060211616b0bbeb
[exim.git] / src / src / store.c
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) The Exim maintainers 2019 - 2023 */
6 /* Copyright (c) University of Cambridge 1995 - 2018 */
7 /* See the file NOTICE for conditions of use and distribution. */
8 /* SPDX-License-Identifier: GPL-2.0-or-later */
9
10 /* Exim gets and frees all its store through these functions. In the original
11 implementation there was a lot of mallocing and freeing of small bits of store.
12 The philosophy has now changed to a scheme which includes the concept of
13 "stacking pools" of store. For the short-lived processes, there isn't any real
14 need to do any garbage collection, but the stack concept allows quick resetting
15 in places where this seems sensible.
16
17 Obviously the long-running processes (the daemon, the queue runner, and eximon)
18 must take care not to eat store.
19
20 The following different types of store are recognized:
21
22 . Long-lived, large blocks: This is implemented by retaining the original
23   malloc/free functions, and it used for permanent working buffers and for
24   getting blocks to cut up for the other types.
25
26 . Long-lived, small blocks: This is used for blocks that have to survive until
27   the process exits. It is implemented as a stacking pool (POOL_PERM). This is
28   functionally the same as store_malloc(), except that the store can't be
29   freed, but I expect it to be more efficient for handling small blocks.
30
31 . Short-lived, short blocks: Most of the dynamic store falls into this
32   category. It is implemented as a stacking pool (POOL_MAIN) which is reset
33   after accepting a message when multiple messages are received by a single
34   process. Resetting happens at some other times as well, usually fairly
35   locally after some specific processing that needs working store.
36
37 . There is a separate pool (POOL_SEARCH) that is used only for lookup storage.
38   This means it can be freed when search_tidyup() is called to close down all
39   the lookup caching.
40
41 - There is another pool (POOL_MESSAGE) used for medium-lifetime objects; within
42   a single message transaction but needed for longer than the use of the main
43   pool permits.  Currently this means only receive-time DKIM information.
44
45 - There is a dedicated pool for configuration data read from the config file(s).
46   Once complete, it is made readonly.
47
48 - There are pools for each active combination of lookup-quoting, dynamically created.
49
50 . Orthogonal to the four main pool types, there are two classes of memory: untainted
51   and tainted.  The latter is used for values derived from untrusted input, and
52   the string-expansion mechanism refuses to operate on such values (obviously,
53   it can expand an untainted value to return a tainted result).  The classes
54   are implemented by duplicating the four pool types.  Pool resets are requested
55   against the nontainted sibling and apply to both siblings.
56
57   Only memory blocks requested for tainted use are regarded as tainted; anything
58   else (including stack auto variables) is untainted.  Care is needed when coding
59   to not copy untrusted data into untainted memory, as downstream taint-checks
60   would be avoided.
61
62   Intermediate layers (eg. the string functions) can test for taint, and use this
63   for ensurinng that results have proper state.  For example the
64   string_vformat_trc() routing supporting the string_sprintf() interface will
65   recopy a string being built into a tainted allocation if it meets a %s for a
66   tainted argument.  Any intermediate-layer function that (can) return a new
67   allocation should behave this way; returning a tainted result if any tainted
68   content is used.  Intermediate-layer functions (eg. Ustrncpy) that modify
69   existing allocations fail if tainted data is written into an untainted area.
70   Users of functions that modify existing allocations should check if a tainted
71   source and an untainted destination is used, and fail instead (sprintf() being
72   the classic case).
73 */
74
75
76 #include "exim.h"
77 /* keep config.h before memcheck.h, for NVALGRIND */
78 #include "config.h"
79
80 #include <sys/mman.h>
81 #include "memcheck.h"
82
83
84 /* We need to know how to align blocks of data for general use. I'm not sure
85 how to get an alignment factor in general. In the current world, a value of 8
86 is probably right, and this is sizeof(double) on some systems and sizeof(void
87 *) on others, so take the larger of those. Since everything in this expression
88 is a constant, the compiler should optimize it to a simple constant wherever it
89 appears (I checked that gcc does do this). */
90
91 #define alignment \
92   (sizeof(void *) > sizeof(double) ? sizeof(void *) : sizeof(double))
93
94 /* store_reset() will not free the following block if the last used block has
95 less than this much left in it. */
96
97 #define STOREPOOL_MIN_SIZE 256
98
99 /* Structure describing the beginning of each big block. */
100
101 typedef struct storeblock {
102   struct storeblock *next;
103   size_t length;
104 } storeblock;
105
106 /* Pool descriptor struct */
107
108 typedef struct pooldesc {
109   storeblock *  chainbase;              /* list of blocks in pool */
110   storeblock *  current_block;          /* top block, still with free space */
111   void *        next_yield;             /* next allocation point */
112   int           yield_length;           /* remaining space in current block */
113   unsigned      store_block_order;      /* log2(size) block allocation size */
114
115   /* This variable is set by store_get() to its yield, and by store_reset() to
116   NULL. This enables string_cat() to optimize its store handling for very long
117   strings. That's why the variable is global. */
118
119   void *        store_last_get;
120
121   /* These are purely for stats-gathering */
122
123   int           nbytes;
124   int           maxbytes;
125   int           nblocks;
126   int           maxblocks;
127   unsigned      maxorder;
128 } pooldesc;
129
130 /* Enhanced pool descriptor for quoted pools */
131
132 typedef struct quoted_pooldesc {
133   pooldesc                      pool;
134   unsigned                      quoter;
135   struct quoted_pooldesc *      next;
136 } quoted_pooldesc;
137
138 /* Just in case we find ourselves on a system where the structure above has a
139 length that is not a multiple of the alignment, set up a macro for the padded
140 length. */
141
142 #define ALIGNED_SIZEOF_STOREBLOCK \
143   (((sizeof(storeblock) + alignment - 1) / alignment) * alignment)
144
145 /* Size of block to get from malloc to carve up into smaller ones. This
146 must be a multiple of the alignment. We assume that 4096 is going to be
147 suitably aligned.  Double the size per-pool for every malloc, to mitigate
148 certain denial-of-service attacks.  Don't bother to decrease on block frees.
149 We waste average half the current alloc size per pool.  This could be several
150 hundred kB now, vs. 4kB with a constant-size block size.  But the search time
151 for is_tainted(), linear in the number of blocks for the pool, is O(n log n)
152 rather than O(n^2).
153 A test of 2000 RCPTs and just accept ACL had 370kB in 21 blocks before,
154 504kB in 6 blocks now, for the untainted-main (largest) pool.
155 Builds for restricted-memory system can disable the expansion by
156 defining RESTRICTED_MEMORY */
157 /*XXX should we allow any for malloc's own overhead?  But how much? */
158
159 /* #define RESTRICTED_MEMORY */
160 #define STORE_BLOCK_SIZE(order) ((1U << (order)) - ALIGNED_SIZEOF_STOREBLOCK)
161
162 /* Variables holding data for the local pools of store. The current pool number
163 is held in store_pool, which is global so that it can be changed from outside.
164 Setting the initial length values to -1 forces a malloc for the first call,
165 even if the length is zero (which is used for getting a point to reset to). */
166
167 int store_pool = POOL_MAIN;
168
169 pooldesc paired_pools[N_PAIRED_POOLS];
170 quoted_pooldesc * quoted_pools = NULL;
171
172 static int n_nonpool_blocks;    /* current number of direct store_malloc() blocks */
173 static int max_nonpool_blocks;
174 static int max_pool_malloc;     /* max value for pool_malloc */
175 static int max_nonpool_malloc;  /* max value for nonpool_malloc */
176
177 /* pool_malloc holds the amount of memory used by the store pools; this goes up
178 and down as store is reset or released. nonpool_malloc is the total got by
179 malloc from other calls; this doesn't go down because it is just freed by
180 pointer. */
181
182 static int pool_malloc;
183 static int nonpool_malloc;
184
185
186 #ifndef COMPILE_UTILITY
187 static const uschar * pooluse[N_PAIRED_POOLS] = {
188 [POOL_MAIN] =           US"main",
189 [POOL_PERM] =           US"perm",
190 [POOL_CONFIG] =         US"config",
191 [POOL_SEARCH] =         US"search",
192 [POOL_MESSAGE] =        US"message",
193 [POOL_TAINT_MAIN] =     US"main",
194 [POOL_TAINT_PERM] =     US"perm",
195 [POOL_TAINT_CONFIG] =   US"config",
196 [POOL_TAINT_SEARCH] =   US"search",
197 [POOL_TAINT_MESSAGE] =  US"message",
198 };
199 static const uschar * poolclass[N_PAIRED_POOLS] = {
200 [POOL_MAIN] =           US"untainted",
201 [POOL_PERM] =           US"untainted",
202 [POOL_CONFIG] =         US"untainted",
203 [POOL_SEARCH] =         US"untainted",
204 [POOL_MESSAGE] =        US"untainted",
205 [POOL_TAINT_MAIN] =     US"tainted",
206 [POOL_TAINT_PERM] =     US"tainted",
207 [POOL_TAINT_CONFIG] =   US"tainted",
208 [POOL_TAINT_SEARCH] =   US"tainted",
209 [POOL_TAINT_MESSAGE] =  US"tainted",
210 };
211 #endif
212
213
214 static void * internal_store_malloc(size_t, const char *, int);
215 static void   internal_store_free(void *, const char *, int linenumber);
216
217 /******************************************************************************/
218
219 static void
220 pool_init(pooldesc * pp)
221 {
222 memset(pp, 0, sizeof(*pp));
223 pp->yield_length = -1;
224 pp->store_block_order = 12; /* log2(allocation_size) ie. 4kB */
225 }
226
227 /* Initialisation, for things fragile with parameter channges when using
228 static initialisers. */
229
230 void
231 store_init(void)
232 {
233 for (pooldesc * pp = paired_pools; pp < paired_pools + N_PAIRED_POOLS; pp++)
234   pool_init(pp);
235 }
236
237 /******************************************************************************/
238 /* Locating elements given memory pointer */
239
240 static BOOL
241 is_pointer_in_block(const storeblock * b, const void * p)
242 {
243 uschar * bc = US b + ALIGNED_SIZEOF_STOREBLOCK;
244 return US p >= bc && US p < bc + b->length;
245 }
246
247 static pooldesc *
248 pool_current_for_pointer(const void * p)
249 {
250 storeblock * b;
251
252 for (quoted_pooldesc * qp = quoted_pools; qp; qp = qp->next)
253   if ((b = qp->pool.current_block) && is_pointer_in_block(b, p))
254     return &qp->pool;
255
256 for (pooldesc * pp = paired_pools; pp < paired_pools + N_PAIRED_POOLS; pp++)
257   if ((b = pp->current_block) && is_pointer_in_block(b, p))
258     return pp;
259 return NULL;
260 }
261
262 static pooldesc *
263 pool_for_pointer(const void * p, const char * func, int linenumber)
264 {
265 pooldesc * pp;
266 storeblock * b;
267
268 if ((pp = pool_current_for_pointer(p))) return pp;
269
270 for (quoted_pooldesc * qp = quoted_pools; qp; qp = qp->next)
271   for (b = qp->pool.chainbase; b; b = b->next)
272     if (is_pointer_in_block(b, p)) return &qp->pool;
273
274 for (pp = paired_pools; pp < paired_pools + N_PAIRED_POOLS; pp++)
275   for (b = pp->chainbase; b; b = b->next)
276     if (is_pointer_in_block(b, p)) return pp;
277
278 #ifndef COMPILE_UTILITY
279 stackdump();
280 #endif
281 log_write(0, LOG_MAIN|LOG_PANIC_DIE,
282   "bad memory reference; pool not found, at %s %d", func, linenumber);
283 return NULL;
284 }
285
286 /******************************************************************************/
287 /* Test if a pointer refers to tainted memory.
288
289 Slower version check, for use when platform intermixes malloc and mmap area
290 addresses. Test against the current-block of all tainted pools first, then all
291 blocks of all tainted pools.
292
293 Return: TRUE iff tainted
294 */
295
296 BOOL
297 is_tainted_fn(const void * p)
298 {
299 storeblock * b;
300
301 if (p == GET_UNTAINTED) return FALSE;
302 if (p == GET_TAINTED) return TRUE;
303
304 for (pooldesc * pp = paired_pools + POOL_TAINT_BASE;
305      pp < paired_pools + N_PAIRED_POOLS; pp++)
306   if ((b = pp->current_block))
307     if (is_pointer_in_block(b, p)) return TRUE;
308
309 for (quoted_pooldesc * qp = quoted_pools; qp; qp = qp->next)
310   if (b = qp->pool.current_block)
311     if (is_pointer_in_block(b, p)) return TRUE;
312
313 for (pooldesc * pp = paired_pools + POOL_TAINT_BASE;
314      pp < paired_pools + N_PAIRED_POOLS; pp++)
315   for (b = pp->chainbase; b; b = b->next)
316     if (is_pointer_in_block(b, p)) return TRUE;
317
318 for (quoted_pooldesc * qp = quoted_pools; qp; qp = qp->next)
319   for (b = qp->pool.chainbase; b; b = b->next)
320     if (is_pointer_in_block(b, p)) return TRUE;
321
322 return FALSE;
323 }
324
325
326 void
327 die_tainted(const uschar * msg, const uschar * func, int line)
328 {
329 log_write(0, LOG_MAIN|LOG_PANIC_DIE, "Taint mismatch, %s: %s %d\n",
330         msg, func, line);
331 }
332
333
334 #ifndef COMPILE_UTILITY
335 /* Return the pool for the given quoter, or null */
336
337 static pooldesc *
338 pool_for_quoter(unsigned quoter)
339 {
340 for (quoted_pooldesc * qp = quoted_pools; qp; qp = qp->next)
341   if (qp->quoter == quoter)
342     return &qp->pool;
343 return NULL;
344 }
345
346 /* Allocate/init a new quoted-pool and return the pool */
347
348 static pooldesc *
349 quoted_pool_new(unsigned quoter)
350 {
351 // debug_printf("allocating quoted-pool\n");
352 quoted_pooldesc * qp = store_get_perm(sizeof(quoted_pooldesc), GET_UNTAINTED);
353
354 pool_init(&qp->pool);
355 qp->quoter = quoter;
356 qp->next = quoted_pools;
357 quoted_pools = qp;
358 return &qp->pool;
359 }
360 #endif
361
362
363 /******************************************************************************/
364 void
365 store_writeprotect(int pool)
366 {
367 #if !defined(COMPILE_UTILITY) && !defined(MISSING_POSIX_MEMALIGN)
368 for (storeblock * b =  paired_pools[pool].chainbase; b; b = b->next)
369   if (mprotect(b, ALIGNED_SIZEOF_STOREBLOCK + b->length, PROT_READ) != 0)
370     DEBUG(D_any) debug_printf("config block mprotect: (%d) %s\n", errno, strerror(errno));
371 #endif
372 }
373
374 /******************************************************************************/
375
376 static void *
377 pool_get(pooldesc * pp, int size, BOOL align_mem, const char * func, int linenumber)
378 {
379 /* Ensure we've been asked to allocate memory.
380 A negative size is a sign of a security problem.
381 A zero size might be also suspect, but our internal usage deliberately
382 does this to return a current watermark value for a later release of
383 allocated store. */
384
385 if (size < 0 || size >= INT_MAX/2)
386   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
387             "bad memory allocation requested (%d bytes) from %s %d",
388             size, func, linenumber);
389
390 /* Round up the size to a multiple of the alignment. Although this looks a
391 messy statement, because "alignment" is a constant expression, the compiler can
392 do a reasonable job of optimizing, especially if the value of "alignment" is a
393 power of two. I checked this with -O2, and gcc did very well, compiling it to 4
394 instructions on a Sparc (alignment = 8). */
395
396 if (size % alignment != 0) size += alignment - (size % alignment);
397
398 /* If there isn't room in the current block, get a new one. The minimum
399 size is STORE_BLOCK_SIZE, and we would expect this to be the norm, since
400 these functions are mostly called for small amounts of store. */
401
402 if (size > pp->yield_length)
403   {
404   int length = MAX(
405           STORE_BLOCK_SIZE(pp->store_block_order) - ALIGNED_SIZEOF_STOREBLOCK,
406           size);
407   int mlength = length + ALIGNED_SIZEOF_STOREBLOCK;
408   storeblock * newblock;
409
410   /* Sometimes store_reset() may leave a block for us; check if we can use it */
411
412   if (  (newblock = pp->current_block)
413      && (newblock = newblock->next)
414      && newblock->length < length
415      )
416     {
417     /* Give up on this block, because it's too small */
418     pp->nblocks--;
419     internal_store_free(newblock, func, linenumber);
420     newblock = NULL;
421     }
422
423   /* If there was no free block, get a new one */
424
425   if (!newblock)
426     {
427     if ((pp->nbytes += mlength) > pp->maxbytes)
428       pp->maxbytes = pp->nbytes;
429     if ((pool_malloc += mlength) > max_pool_malloc)     /* Used in pools */
430       max_pool_malloc = pool_malloc;
431     nonpool_malloc -= mlength;                  /* Exclude from overall total */
432     if (++pp->nblocks > pp->maxblocks)
433       pp->maxblocks = pp->nblocks;
434
435 #ifndef MISSING_POSIX_MEMALIGN
436     if (align_mem)
437       {
438       long pgsize = sysconf(_SC_PAGESIZE);
439       int err = posix_memalign((void **)&newblock,
440                                 pgsize, (mlength + pgsize - 1) & ~(pgsize - 1));
441       if (err)
442         log_write(0, LOG_MAIN|LOG_PANIC_DIE,
443           "failed to alloc (using posix_memalign) %d bytes of memory: '%s'"
444           "called from line %d in %s",
445           size, strerror(err), linenumber, func);
446       }
447     else
448 #endif
449       newblock = internal_store_malloc(mlength, func, linenumber);
450     newblock->next = NULL;
451     newblock->length = length;
452 #ifndef RESTRICTED_MEMORY
453     if (pp->store_block_order++ > pp->maxorder)
454       pp->maxorder = pp->store_block_order;
455 #endif
456
457     if (! pp->chainbase)
458        pp->chainbase = newblock;
459     else
460       pp->current_block->next = newblock;
461     }
462
463   pp->current_block = newblock;
464   pp->yield_length = newblock->length;
465   pp->next_yield =
466     (void *)(CS pp->current_block + ALIGNED_SIZEOF_STOREBLOCK);
467   (void) VALGRIND_MAKE_MEM_NOACCESS(pp->next_yield, pp->yield_length);
468   }
469
470 /* There's (now) enough room in the current block; the yield is the next
471 pointer. */
472
473 pp->store_last_get = pp->next_yield;
474
475 (void) VALGRIND_MAKE_MEM_UNDEFINED(pp->store_last_get, size);
476 /* Update next pointer and number of bytes left in the current block. */
477
478 pp->next_yield = (void *)(CS pp->next_yield + size);
479 pp->yield_length -= size;
480 return pp->store_last_get;
481 }
482
483 /*************************************************
484 *       Get a block from the current pool        *
485 *************************************************/
486
487 /* Running out of store is a total disaster. This function is called via the
488 macro store_get(). The current store_pool is used, adjusting for taint.
489 If the protoype is quoted, use a quoted-pool.
490 Return a block of store within the current big block of the pool, getting a new
491 one if necessary. The address is saved in store_last_get for the pool.
492
493 Arguments:
494   size        amount wanted, bytes
495   proto_mem   class: get store conformant to this
496                 Special values: 0 forces untainted, 1 forces tainted
497   func        function from which called
498   linenumber  line number in source file
499
500 Returns:      pointer to store (panic on malloc failure)
501 */
502
503 void *
504 store_get_3(int size, const void * proto_mem, const char * func, int linenumber)
505 {
506 #ifndef COMPILE_UTILITY
507 int quoter = quoter_for_address(proto_mem);
508 #endif
509 pooldesc * pp;
510 void * yield;
511
512 #ifndef COMPILE_UTILITY
513 if (!is_real_quoter(quoter))
514 #endif
515   {
516   BOOL tainted = is_tainted(proto_mem);
517   int pool = tainted ? store_pool + POOL_TAINT_BASE : store_pool;
518   pp = paired_pools + pool;
519   yield = pool_get(pp, size, (pool == POOL_CONFIG), func, linenumber);
520
521   /* Cut out the debugging stuff for utilities, but stop picky compilers from
522   giving warnings. */
523
524 #ifndef COMPILE_UTILITY
525   DEBUG(D_memory)
526     debug_printf("---%d Get %6p %5d %-14s %4d\n", pool,
527       pp->store_last_get, size, func, linenumber);
528 #endif
529   }
530 #ifndef COMPILE_UTILITY
531 else
532   {
533   DEBUG(D_memory)
534     debug_printf("allocating quoted-block for quoter %u (from %s %d)\n",
535       quoter, func, linenumber);
536   if (!(pp = pool_for_quoter(quoter))) pp = quoted_pool_new(quoter);
537   yield = pool_get(pp, size, FALSE, func, linenumber);
538   DEBUG(D_memory)
539     debug_printf("---QQ Get %6p %5d %-14s %4d\n",
540       pp->store_last_get, size, func, linenumber);
541   }
542 #endif
543 return yield;
544 }
545
546
547
548 /*************************************************
549 *       Get a block from the PERM pool           *
550 *************************************************/
551
552 /* This is just a convenience function, useful when just a single block is to
553 be obtained.
554
555 Arguments:
556   size        amount wanted
557   proto_mem   class: get store conformant to this
558   func        function from which called
559   linenumber  line number in source file
560
561 Returns:      pointer to store (panic on malloc failure)
562 */
563
564 void *
565 store_get_perm_3(int size, const void * proto_mem, const char * func, int linenumber)
566 {
567 void * yield;
568 int old_pool = store_pool;
569 store_pool = POOL_PERM;
570 yield = store_get_3(size, proto_mem, func, linenumber);
571 store_pool = old_pool;
572 return yield;
573 }
574
575
576 #ifndef COMPILE_UTILITY
577 /*************************************************
578 *  Get a block annotated as being lookup-quoted  *
579 *************************************************/
580
581 /* Allocate from pool a pool consistent with the proto_mem augmented by the
582 requested quoter type.
583
584 XXX currently not handling mark/release
585
586 Args:   size            number of bytes to allocate
587         quoter          id for the quoting type
588         func            caller, for debug
589         linenumber      caller, for debug
590
591 Return: allocated memory block
592 */
593
594 static void *
595 store_force_get_quoted(int size, unsigned quoter,
596   const char * func, int linenumber)
597 {
598 pooldesc * pp = pool_for_quoter(quoter);
599 void * yield;
600
601 DEBUG(D_memory)
602   debug_printf("allocating quoted-block for quoter %u (from %s %d)\n", quoter, func, linenumber);
603
604 if (!pp) pp = quoted_pool_new(quoter);
605 yield = pool_get(pp, size, FALSE, func, linenumber);
606
607 DEBUG(D_memory)
608   debug_printf("---QQ Get %6p %5d %-14s %4d\n",
609     pp->store_last_get, size, func, linenumber);
610
611 return yield;
612 }
613
614 /* Maybe get memory for the specified quoter, but only if the
615 prototype memory is tainted. Otherwise, get plain memory.
616 */
617 void *
618 store_get_quoted_3(int size, const void * proto_mem, unsigned quoter,
619   const char * func, int linenumber)
620 {
621 // debug_printf("store_get_quoted_3: quoter %u\n", quoter);
622 return is_tainted(proto_mem)
623   ? store_force_get_quoted(size, quoter, func, linenumber)
624   : store_get_3(size, proto_mem, func, linenumber);
625 }
626
627 /* Return quoter for given address, or -1 if not in a quoted-pool. */
628 int
629 quoter_for_address(const void * p)
630 {
631 for (quoted_pooldesc * qp = quoted_pools; qp; qp = qp->next)
632   {
633   pooldesc * pp = &qp->pool;
634   storeblock * b;
635
636   if (b = pp->current_block)
637     if (is_pointer_in_block(b, p))
638       return qp->quoter;
639
640   for (b = pp->chainbase; b; b = b->next)
641     if (is_pointer_in_block(b, p))
642       return qp->quoter;
643   }
644 return -1;
645 }
646
647 /* Return TRUE iff the given address is quoted for the given type.
648 There is extra complexity to handle lookup providers with multiple
649 find variants but shared quote functions. */
650 BOOL
651 is_quoted_like(const void * p, unsigned quoter)
652 {
653 int pq = quoter_for_address(p);
654 BOOL y =
655   is_real_quoter(pq) && lookup_list[pq]->quote == lookup_list[quoter]->quote;
656 /* debug_printf("is_quoted(%p, %u): %c\n", p, quoter, y?'T':'F'); */
657 return y;
658 }
659
660 /* Return TRUE if the quoter value indicates an actual quoter */
661 BOOL
662 is_real_quoter(int quoter)
663 {
664 return quoter >= 0;
665 }
666
667 /* Return TRUE if the "new" data requires that the "old" data
668 be recopied to new-class memory.  We order the classes as
669
670   2: tainted, not quoted
671   1: quoted (which is also tainted)
672   0: untainted
673
674 If the "new" is higher-order than the "old", they are not compatible
675 and a copy is needed.  If both are quoted, but the quoters differ,
676 not compatible.  Otherwise they are compatible.
677 */
678 BOOL
679 is_incompatible_fn(const void * old, const void * new)
680 {
681 int oq, nq;
682 unsigned oi, ni;
683
684 ni = is_real_quoter(nq = quoter_for_address(new)) ? 1 : is_tainted(new) ? 2 : 0;
685 oi = is_real_quoter(oq = quoter_for_address(old)) ? 1 : is_tainted(old) ? 2 : 0;
686 return ni > oi || ni == oi && nq != oq;
687 }
688
689 #endif  /*!COMPILE_UTILITY*/
690
691 /*************************************************
692 *      Extend a block if it is at the top        *
693 *************************************************/
694
695 /* While reading strings of unknown length, it is often the case that the
696 string is being read into the block at the top of the stack. If it needs to be
697 extended, it is more efficient just to extend within the top block rather than
698 allocate a new block and then have to copy the data. This function is provided
699 for the use of string_cat(), but of course can be used elsewhere too.
700 The block itself is not expanded; only the top allocation from it.
701
702 Arguments:
703   ptr        pointer to store block
704   oldsize    current size of the block, as requested by user
705   newsize    new size required
706   func       function from which called
707   linenumber line number in source file
708
709 Returns:     TRUE if the block is at the top of the stack and has been
710              extended; FALSE if it isn't at the top of the stack, or cannot
711              be extended
712
713 XXX needs extension for quoted-tracking.  This assumes that the global store_pool
714 is the one to alloc from, which breaks with separated pools.
715 */
716
717 BOOL
718 store_extend_3(void * ptr, int oldsize, int newsize,
719    const char * func, int linenumber)
720 {
721 pooldesc * pp = pool_for_pointer(ptr, func, linenumber);
722 int inc = newsize - oldsize;
723 int rounded_oldsize = oldsize;
724
725 if (oldsize < 0 || newsize < oldsize || newsize >= INT_MAX/2)
726   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
727             "bad memory extension requested (%d -> %d bytes) at %s %d",
728             oldsize, newsize, func, linenumber);
729
730 if (rounded_oldsize % alignment != 0)
731   rounded_oldsize += alignment - (rounded_oldsize % alignment);
732
733 if (CS ptr + rounded_oldsize != CS (pp->next_yield) ||
734     inc > pp->yield_length + rounded_oldsize - oldsize)
735   return FALSE;
736
737 /* Cut out the debugging stuff for utilities, but stop picky compilers from
738 giving warnings. */
739
740 #ifndef COMPILE_UTILITY
741 DEBUG(D_memory)
742   {
743   quoted_pooldesc * qp;
744   for (qp = quoted_pools; qp; qp = qp->next)
745     if (pp == &qp->pool)
746       {
747       debug_printf("---Q%d Ext %6p %5d %-14s %4d\n",
748         (int)(qp - quoted_pools),
749         ptr, newsize, func, linenumber);
750       break;
751       }
752   if (!qp)
753     debug_printf("---%d Ext %6p %5d %-14s %4d\n",
754       (int)(pp - paired_pools),
755       ptr, newsize, func, linenumber);
756   }
757 #endif  /* COMPILE_UTILITY */
758
759 if (newsize % alignment != 0) newsize += alignment - (newsize % alignment);
760 pp->next_yield = CS ptr + newsize;
761 pp->yield_length -= newsize - rounded_oldsize;
762 (void) VALGRIND_MAKE_MEM_UNDEFINED(ptr + oldsize, inc);
763 return TRUE;
764 }
765
766
767
768
769 static BOOL
770 is_pwr2_size(int len)
771 {
772 unsigned x = len;
773 return (x & (x - 1)) == 0;
774 }
775
776
777 /*************************************************
778 *    Back up to a previous point on the stack    *
779 *************************************************/
780
781 /* This function resets the next pointer, freeing any subsequent whole blocks
782 that are now unused. Call with a cookie obtained from store_mark() only; do
783 not call with a pointer returned by store_get().  Both the untainted and tainted
784 pools corresposding to store_pool are reset.
785
786 Quoted pools are not handled.
787
788 Arguments:
789   ptr         place to back up to
790   pool        pool holding the pointer
791   func        function from which called
792   linenumber  line number in source file
793
794 Returns:      nothing
795 */
796
797 static void
798 internal_store_reset(void * ptr, int pool, const char *func, int linenumber)
799 {
800 storeblock * bb;
801 pooldesc * pp = paired_pools + pool;
802 storeblock * b = pp->current_block;
803 char * bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
804 int newlength, count;
805 #ifndef COMPILE_UTILITY
806 int oldmalloc = pool_malloc;
807 #endif
808
809 if (!b) return; /* exim_dumpdb gets this, becuse it has never used tainted mem */
810
811 /* Last store operation was not a get */
812
813 pp->store_last_get = NULL;
814
815 /* See if the place is in the current block - as it often will be. Otherwise,
816 search for the block in which it lies. */
817
818 if (CS ptr < bc || CS ptr > bc + b->length)
819   {
820   for (b =  pp->chainbase; b; b = b->next)
821     {
822     bc = CS b + ALIGNED_SIZEOF_STOREBLOCK;
823     if (CS ptr >= bc && CS ptr <= bc + b->length) break;
824     }
825   if (!b)
826     log_write(0, LOG_MAIN|LOG_PANIC_DIE, "internal error: store_reset(%p) "
827       "failed: pool=%d %-14s %4d", ptr, pool, func, linenumber);
828   }
829
830 /* Back up, rounding to the alignment if necessary. When testing, flatten
831 the released memory. */
832
833 newlength = bc + b->length - CS ptr;
834 #ifndef COMPILE_UTILITY
835 if (debug_store)
836   {
837   assert_no_variables(ptr, newlength, func, linenumber);
838   if (f.running_in_test_harness)
839     {
840     (void) VALGRIND_MAKE_MEM_DEFINED(ptr, newlength);
841     memset(ptr, 0xF0, newlength);
842     }
843   }
844 #endif
845 (void) VALGRIND_MAKE_MEM_NOACCESS(ptr, newlength);
846 pp->next_yield = CS ptr + (newlength % alignment);
847 count = pp->yield_length;
848 count = (pp->yield_length = newlength - (newlength % alignment)) - count;
849 pp->current_block = b;
850
851 /* Free any subsequent block. Do NOT free the first
852 successor, if our current block has less than 256 bytes left. This should
853 prevent us from flapping memory. However, keep this block only when it has
854 a power-of-two size so probably is not a custom inflated one. */
855
856 if (  pp->yield_length < STOREPOOL_MIN_SIZE
857    && b->next
858    && is_pwr2_size(b->next->length + ALIGNED_SIZEOF_STOREBLOCK))
859   {
860   b = b->next;
861 #ifndef COMPILE_UTILITY
862   if (debug_store)
863     assert_no_variables(b, b->length + ALIGNED_SIZEOF_STOREBLOCK,
864                         func, linenumber);
865 #endif
866   (void) VALGRIND_MAKE_MEM_NOACCESS(CS b + ALIGNED_SIZEOF_STOREBLOCK,
867                 b->length - ALIGNED_SIZEOF_STOREBLOCK);
868   }
869
870 bb = b->next;
871 if (pool != POOL_CONFIG)
872   b->next = NULL;
873
874 while ((b = bb))
875   {
876   int siz = b->length + ALIGNED_SIZEOF_STOREBLOCK;
877
878 #ifndef COMPILE_UTILITY
879   if (debug_store)
880     assert_no_variables(b, b->length + ALIGNED_SIZEOF_STOREBLOCK,
881                         func, linenumber);
882 #endif
883   bb = bb->next;
884   pp->nbytes -= siz;
885   pool_malloc -= siz;
886   pp->nblocks--;
887   if (pool != POOL_CONFIG)
888     internal_store_free(b, func, linenumber);
889
890 #ifndef RESTRICTED_MEMORY
891   if (pp->store_block_order > 13) pp->store_block_order--;
892 #endif
893   }
894
895 /* Cut out the debugging stuff for utilities, but stop picky compilers from
896 giving warnings. */
897
898 #ifndef COMPILE_UTILITY
899 DEBUG(D_memory)
900   debug_printf("---%d Rst %6p %5d %-14s %4d\tpool %d\n", pool, ptr,
901     count + oldmalloc - pool_malloc,
902     func, linenumber, pool_malloc);
903 #endif  /* COMPILE_UTILITY */
904 }
905
906
907 /* Back up the pool pair, untainted and tainted, of the store_pool setting.
908 Quoted pools are not handled.
909 */
910
911 rmark
912 store_reset_3(rmark r, const char * func, int linenumber)
913 {
914 void ** ptr = r;
915
916 if (store_pool >= POOL_TAINT_BASE)
917   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
918     "store_reset called for pool %d: %s %d\n", store_pool, func, linenumber);
919 if (!r)
920   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
921     "store_reset called with bad mark: %s %d\n", func, linenumber);
922
923 internal_store_reset(*ptr, store_pool + POOL_TAINT_BASE, func, linenumber);
924 internal_store_reset(ptr,  store_pool,             func, linenumber);
925 return NULL;
926 }
927
928
929 /**************/
930
931 /* Free tail-end unused allocation.  This lets us allocate a big chunk
932 early, for cases when we only discover later how much was really needed.
933
934 Can be called with a value from store_get(), or an offset after such.  Only
935 the tainted or untainted pool that serviced the store_get() will be affected.
936
937 This is mostly a cut-down version of internal_store_reset().
938 XXX needs rationalising
939 */
940
941 void
942 store_release_above_3(void * ptr, const char * func, int linenumber)
943 {
944 pooldesc * pp;
945
946 /* Search all pools' "current" blocks.  If it isn't one of those,
947 ignore it (it usually will be). */
948
949 if ((pp = pool_current_for_pointer(ptr)))
950   {
951   storeblock * b = pp->current_block;
952   int count, newlength;
953
954   /* Last store operation was not a get */
955
956   pp->store_last_get = NULL;
957
958   /* Back up, rounding to the alignment if necessary. When testing, flatten
959   the released memory. */
960
961   newlength = (CS b + ALIGNED_SIZEOF_STOREBLOCK) + b->length - CS ptr;
962 #ifndef COMPILE_UTILITY
963   if (debug_store)
964     {
965     assert_no_variables(ptr, newlength, func, linenumber);
966     if (f.running_in_test_harness)
967       {
968       (void) VALGRIND_MAKE_MEM_DEFINED(ptr, newlength);
969       memset(ptr, 0xF0, newlength);
970       }
971     }
972 #endif
973   (void) VALGRIND_MAKE_MEM_NOACCESS(ptr, newlength);
974   pp->next_yield = CS ptr + (newlength % alignment);
975   count = pp->yield_length;
976   count = (pp->yield_length = newlength - (newlength % alignment)) - count;
977
978   /* Cut out the debugging stuff for utilities, but stop picky compilers from
979   giving warnings. */
980
981 #ifndef COMPILE_UTILITY
982   DEBUG(D_memory)
983     {
984     quoted_pooldesc * qp;
985     for (qp = quoted_pools; qp; qp = qp->next)
986       if (pp == &qp->pool)
987         debug_printf("---Q%d Rel %6p %5d %-14s %4d\tpool %d\n",
988           (int)(qp - quoted_pools),
989           ptr, count, func, linenumber, pool_malloc);
990     if (!qp)
991       debug_printf("---%d Rel %6p %5d %-14s %4d\tpool %d\n",
992         (int)(pp - paired_pools), ptr, count,
993         func, linenumber, pool_malloc);
994     }
995 #endif
996   return;
997   }
998 #ifndef COMPILE_UTILITY
999 DEBUG(D_memory)
1000   debug_printf("non-last memory release try: %s %d\n", func, linenumber);
1001 #endif
1002 }
1003
1004
1005
1006 rmark
1007 store_mark_3(const char * func, int linenumber)
1008 {
1009 void ** p;
1010
1011 #ifndef COMPILE_UTILITY
1012 DEBUG(D_memory)
1013   debug_printf("---%d Mrk                    %-14s %4d\tpool %d\n",
1014     store_pool, func, linenumber, pool_malloc);
1015 #endif  /* COMPILE_UTILITY */
1016
1017 if (store_pool >= POOL_TAINT_BASE)
1018   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1019     "store_mark called for pool %d: %s %d\n", store_pool, func, linenumber);
1020
1021 /* Stash a mark for the tainted-twin release, in the untainted twin. Return
1022 a cookie (actually the address in the untainted pool) to the caller.
1023 Reset uses the cookie to recover the t-mark, winds back the tainted pool with it
1024 and winds back the untainted pool with the cookie. */
1025
1026 p = store_get_3(sizeof(void *), GET_UNTAINTED, func, linenumber);
1027 *p = store_get_3(0, GET_TAINTED, func, linenumber);
1028 return p;
1029 }
1030
1031
1032
1033
1034 /************************************************
1035 *             Release store                     *
1036 ************************************************/
1037
1038 /* This function checks that the pointer it is given is the first thing in a
1039 block, and if so, releases that block.
1040
1041 Arguments:
1042   block       block of store to consider
1043   pp          pool containing the block
1044   func        function from which called
1045   linenumber  line number in source file
1046
1047 Returns:      nothing
1048 */
1049
1050 static void
1051 store_release_3(void * block, pooldesc * pp, const char * func, int linenumber)
1052 {
1053 /* It will never be the first block, so no need to check that. */
1054
1055 for (storeblock * b =  pp->chainbase; b; b = b->next)
1056   {
1057   storeblock * bb = b->next;
1058   if (bb && CS block == CS bb + ALIGNED_SIZEOF_STOREBLOCK)
1059     {
1060     int siz = bb->length + ALIGNED_SIZEOF_STOREBLOCK;
1061     b->next = bb->next;
1062     pp->nbytes -= siz;
1063     pool_malloc -= siz;
1064     pp->nblocks--;
1065
1066     /* Cut out the debugging stuff for utilities, but stop picky compilers
1067     from giving warnings. */
1068
1069 #ifndef COMPILE_UTILITY
1070     DEBUG(D_memory)
1071       debug_printf("-Release %6p %-20s %4d %d\n", (void *)bb, func,
1072         linenumber, pool_malloc);
1073
1074     if (f.running_in_test_harness)
1075       memset(bb, 0xF0, bb->length+ALIGNED_SIZEOF_STOREBLOCK);
1076 #endif  /* COMPILE_UTILITY */
1077
1078     internal_store_free(bb, func, linenumber);
1079     return;
1080     }
1081   }
1082 }
1083
1084
1085 /************************************************
1086 *             Move store                        *
1087 ************************************************/
1088
1089 /* Allocate a new block big enough to expend to the given size and
1090 copy the current data into it.  Free the old one if possible.
1091
1092 This function is specifically provided for use when reading very
1093 long strings, e.g. header lines. When the string gets longer than a
1094 complete block, it gets copied to a new block. It is helpful to free
1095 the old block iff the previous copy of the string is at its start,
1096 and therefore the only thing in it. Otherwise, for very long strings,
1097 dead store can pile up somewhat disastrously. This function checks that
1098 the pointer it is given is the first thing in a block, and that nothing
1099 has been allocated since. If so, releases that block.
1100
1101 Arguments:
1102   oldblock
1103   newsize       requested size
1104   len           current size
1105
1106 Returns:        new location of data
1107 */
1108
1109 void *
1110 store_newblock_3(void * oldblock, int newsize, int len,
1111   const char * func, int linenumber)
1112 {
1113 pooldesc * pp = pool_for_pointer(oldblock, func, linenumber);
1114 BOOL release_ok = !is_tainted(oldblock) && pp->store_last_get == oldblock;              /*XXX why tainted not handled? */
1115 uschar * newblock;
1116
1117 if (len < 0 || len > newsize)
1118   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1119             "bad memory extension requested (%d -> %d bytes) at %s %d",
1120             len, newsize, func, linenumber);
1121
1122 newblock = store_get(newsize, oldblock);
1123 memcpy(newblock, oldblock, len);
1124 if (release_ok) store_release_3(oldblock, pp, func, linenumber);
1125 return (void *)newblock;
1126 }
1127
1128
1129
1130
1131 /*************************************************
1132 *                Malloc store                    *
1133 *************************************************/
1134
1135 /* Running out of store is a total disaster for exim. Some malloc functions
1136 do not run happily on very small sizes, nor do they document this fact. This
1137 function is called via the macro store_malloc().
1138
1139 Arguments:
1140   size        amount of store wanted
1141   func        function from which called
1142   line        line number in source file
1143
1144 Returns:      pointer to gotten store (panic on failure)
1145 */
1146
1147 static void *
1148 internal_store_malloc(size_t size, const char *func, int line)
1149 {
1150 void * yield;
1151
1152 /* Check specifically for a possibly result of conversion from
1153 a negative int, to the (unsigned, wider) size_t */
1154
1155 if (size >= INT_MAX/2)
1156   log_write(0, LOG_MAIN|LOG_PANIC_DIE,
1157     "bad internal_store_malloc request (" SIZE_T_FMT " bytes) from %s %d",
1158     size, func, line);
1159
1160 size += sizeof(size_t); /* space to store the size, used under debug */
1161 if (size < 16) size = 16;
1162
1163 if (!(yield = malloc(size)))
1164   log_write(0, LOG_MAIN|LOG_PANIC_DIE, "failed to malloc " SIZE_T_FMT " bytes of memory: "
1165     "called from line %d in %s", size, line, func);
1166
1167 #ifndef COMPILE_UTILITY
1168 DEBUG(D_any) *(size_t *)yield = size;
1169 #endif
1170 yield = US yield + sizeof(size_t);
1171
1172 if ((nonpool_malloc += size) > max_nonpool_malloc)
1173   max_nonpool_malloc = nonpool_malloc;
1174
1175 /* Cut out the debugging stuff for utilities, but stop picky compilers from
1176 giving warnings. */
1177
1178 #ifndef COMPILE_UTILITY
1179 /* If running in test harness, spend time making sure all the new store
1180 is not filled with zeros so as to catch problems. */
1181
1182 if (f.running_in_test_harness)
1183   memset(yield, 0xF0, size - sizeof(size_t));
1184 DEBUG(D_memory) debug_printf("--Malloc %6p %5lu bytes\t%-20s %4d\tpool %5d  nonpool %5d\n",
1185   yield, size, func, line, pool_malloc, nonpool_malloc);
1186 #endif  /* COMPILE_UTILITY */
1187
1188 return yield;
1189 }
1190
1191 void *
1192 store_malloc_3(size_t size, const char *func, int linenumber)
1193 {
1194 if (n_nonpool_blocks++ > max_nonpool_blocks)
1195   max_nonpool_blocks = n_nonpool_blocks;
1196 return internal_store_malloc(size, func, linenumber);
1197 }
1198
1199
1200 /************************************************
1201 *             Free store                        *
1202 ************************************************/
1203
1204 /* This function is called by the macro store_free().
1205
1206 Arguments:
1207   block       block of store to free
1208   func        function from which called
1209   linenumber  line number in source file
1210
1211 Returns:      nothing
1212 */
1213
1214 static void
1215 internal_store_free(void * block, const char * func, int linenumber)
1216 {
1217 uschar * p = US block - sizeof(size_t);
1218 #ifndef COMPILE_UTILITY
1219 DEBUG(D_any) nonpool_malloc -= *(size_t *)p;
1220 DEBUG(D_memory) debug_printf("----Free %6p %5ld bytes\t%-20s %4d\n",
1221                     block, *(size_t *)p, func, linenumber);
1222 #endif
1223 free(p);
1224 }
1225
1226 void
1227 store_free_3(void * block, const char * func, int linenumber)
1228 {
1229 n_nonpool_blocks--;
1230 internal_store_free(block, func, linenumber);
1231 }
1232
1233 /******************************************************************************/
1234 /* Stats output on process exit */
1235 void
1236 store_exit(void)
1237 {
1238 #ifndef COMPILE_UTILITY
1239 DEBUG(D_memory)
1240  {
1241  int i;
1242  debug_printf("----Exit nonpool max: %3d kB in %d blocks\n",
1243   (max_nonpool_malloc+1023)/1024, max_nonpool_blocks);
1244  debug_printf("----Exit npools  max: %3d kB\n", max_pool_malloc/1024);
1245
1246  for (i = 0; i < N_PAIRED_POOLS; i++)
1247    {
1248    pooldesc * pp = paired_pools + i;
1249    debug_printf("----Exit  pool %2d max: %3d kB in %d blocks at order %u\t%s %s\n",
1250     i, (pp->maxbytes+1023)/1024, pp->maxblocks, pp->maxorder,
1251     poolclass[i], pooluse[i]);
1252    }
1253  i = 0;
1254  for (quoted_pooldesc * qp = quoted_pools; qp; i++, qp = qp->next)
1255    {
1256    pooldesc * pp = &qp->pool;
1257    debug_printf("----Exit  pool Q%d max: %3d kB in %d blocks at order %u\ttainted quoted:%s\n",
1258     i, (pp->maxbytes+1023)/1024, pp->maxblocks, pp->maxorder, lookup_list[qp->quoter]->name);
1259    }
1260  }
1261 #endif
1262 }
1263
1264
1265 /******************************************************************************/
1266 /* Per-message pool management */
1267
1268 static rmark   message_reset_point    = NULL;
1269
1270 void
1271 message_start(void)
1272 {
1273 int oldpool = store_pool;
1274 store_pool = POOL_MESSAGE;
1275 if (!message_reset_point) message_reset_point = store_mark();
1276 store_pool = oldpool;
1277 }
1278
1279 void
1280 message_tidyup(void)
1281 {
1282 int oldpool;
1283 if (!message_reset_point) return;
1284 oldpool = store_pool;
1285 store_pool = POOL_MESSAGE;
1286 message_reset_point = store_reset(message_reset_point);
1287 store_pool = oldpool;
1288 }
1289
1290 /******************************************************************************/
1291 /* Debug analysis of address */
1292
1293 #ifndef COMPILE_UTILITY
1294 void
1295 debug_print_taint(const void * p)
1296 {
1297 int q = quoter_for_address(p);
1298 if (!is_tainted(p)) return;
1299 debug_printf("(tainted");
1300 if (is_real_quoter(q)) debug_printf(", quoted:%s", lookup_list[q]->name);
1301 debug_printf(")\n");
1302 }
1303 #endif
1304
1305 /* End of store.c */