constification
[exim.git] / src / src / store.h
1 /*************************************************
2 *     Exim - an Internet mail transport agent    *
3 *************************************************/
4
5 /* Copyright (c) University of Cambridge 1995 - 2009 */
6 /* Copyright (c) The Exim Maintainers 2020 */
7 /* See the file NOTICE for conditions of use and distribution. */
8
9 /* Header for Exim's memory allocation functions */
10
11 #ifndef STORE_H
12 #define STORE_H
13
14 /* Define symbols for identifying the store pools. */
15
16 #define NPOOLS 10
17 enum { POOL_MAIN,
18        POOL_PERM,
19        POOL_CONFIG,
20        POOL_SEARCH,
21        POOL_MESSAGE,
22
23        POOL_TAINT_BASE,
24
25        POOL_TAINT_MAIN = POOL_TAINT_BASE,
26        POOL_TAINT_PERM,
27        POOL_TAINT_CONFIG,
28        POOL_TAINT_SEARCH,
29        POOL_TAINT_MESSAGE };
30
31 /* This variable (the one for the current pool) is set by store_get() to its
32 yield, and by store_reset() to NULL. This allows string_cat() to optimize its
33 store handling. */
34
35 extern void *store_last_get[NPOOLS];
36
37 /* This variable contains the current store pool number. */
38
39 extern int store_pool;
40
41 /* Macros for calling the memory allocation routines with
42 tracing information for debugging. */
43
44 #define store_extend(addr, tainted, old, new) \
45   store_extend_3(addr, tainted, old, new, __FUNCTION__, __LINE__)
46
47 #define store_free(addr) \
48         store_free_3(addr, __FUNCTION__, __LINE__)
49 /* store_get & store_get_perm are in local_scan.h */
50 #define store_malloc(size) \
51         store_malloc_3(size, __FUNCTION__, __LINE__)
52 #define store_mark(void) \
53         store_mark_3(__FUNCTION__, __LINE__)
54 #define store_newblock(addr, tainted, newsize, datalen) \
55         store_newblock_3(addr, tainted, newsize, datalen, __FUNCTION__, __LINE__)
56 #define store_release_above(addr) \
57         store_release_above_3(addr, __FUNCTION__, __LINE__)
58 #define store_reset(mark) \
59         store_reset_3(mark, __FUNCTION__, __LINE__)
60
61
62 /* The real functions */
63 typedef void ** rmark;
64
65 extern BOOL    store_extend_3(void *, BOOL, int, int, const char *, int);
66 extern void    store_free_3(void *, const char *, int);
67 /* store_get_3 & store_get_perm_3 are in local_scan.h */
68 extern void   *store_malloc_3(int, const char *, int)           ALLOC ALLOC_SIZE(1) WARN_UNUSED_RESULT;
69 extern rmark   store_mark_3(const char *, int);
70 extern void   *store_newblock_3(void *, BOOL, int, int, const char *, int);
71 extern void    store_release_above_3(void *, const char *, int);
72 extern rmark   store_reset_3(rmark, const char *, int);
73
74 #endif  /* STORE_H */
75
76 /* End of store.h */