mem: initial doxygen documentation for MM, small whitespace changes
[sip-router] / mem / mem.c
1 /*
2  * Copyright (C) 2001-2003 FhG Fokus
3  *
4  * This file is part of sip-router, a free SIP server.
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  *
18  *
19  * History:
20  * --------
21  *  2003-04-08  init_mallocs split into init_{pkg,shm}_malloc (andrei)
22  * 
23  */
24
25 /**
26  * \file
27  * \brief Main definitions for memory manager
28  * 
29  * Main definitions for memory manager, like malloc, free and realloc
30  * \ingroup mem
31  */
32
33
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include "../config.h"
37 #include "../dprint.h"
38 #include "../globals.h"
39 #include "mem.h"
40
41 #ifdef PKG_MALLOC
42 #include "q_malloc.h"
43 #endif
44
45 #ifdef SHM_MEM
46 #include "shm_mem.h"
47 #endif
48
49 #ifdef PKG_MALLOC
50         #ifndef DL_MALLOC
51         char* mem_pool = 0;
52         #endif
53
54         #ifdef F_MALLOC
55                 struct fm_block* mem_block = 0;
56         #elif defined DL_MALLOC
57                 /* don't need this */
58         #else
59                 struct qm_block* mem_block = 0;
60         #endif
61 #endif
62
63
64 /**
65  * \brief Initialize private memory pool
66  * \return 0 if the memory allocation was successful, -1 otherwise
67  */
68 int init_pkg_mallocs()
69 {
70 #ifdef PKG_MALLOC
71         /*init mem*/
72         #ifndef DL_MALLOC
73                 if (pkg_mem_size == 0)
74                         pkg_mem_size = PKG_MEM_POOL_SIZE;
75                 mem_pool = malloc(pkg_mem_size);
76         #endif
77         #ifdef F_MALLOC
78                 if (mem_pool)
79                         mem_block=fm_malloc_init(mem_pool, pkg_mem_size);
80         #elif DL_MALLOC
81                 /* don't need this */
82         #else
83                 if (mem_pool)
84                         mem_block=qm_malloc_init(mem_pool, pkg_mem_size);
85         #endif
86         #ifndef DL_MALLOC
87         if (mem_block==0){
88                 LOG(L_CRIT, "could not initialize memory pool\n");
89                 fprintf(stderr, "Too much pkg memory demanded: %ld bytes\n",
90                                                 pkg_mem_size);
91                 return -1;
92         }
93         #endif
94 #endif
95         return 0;
96 }
97
98
99
100 /**
101  * \brief Destroy private memory pool
102  */
103 void destroy_pkg_mallocs()
104 {
105 #ifdef PKG_MALLOC
106         #ifndef DL_MALLOC
107                 if (mem_pool) {
108                         free(mem_pool);
109                         mem_pool = 0;
110                 }
111         #endif
112 #endif /* PKG_MALLOC */
113 }
114
115
116 /**
117  * \brief Initialize shared memory pool
118  * \param force_alloc Force allocation of memory, e.g. initialize complete block with zero
119  * \return 0 if the memory allocation was successful, -1 otherwise
120  */
121 int init_shm_mallocs(int force_alloc)
122 {
123 #ifdef SHM_MEM
124         if (shm_mem_init(force_alloc)<0) {
125                 LOG(L_CRIT, "could not initialize shared memory pool, exiting...\n");
126                  fprintf(stderr, "Too much shared memory demanded: %ld\n",
127                         shm_mem_size );
128                 return -1;
129         }
130 #endif
131         return 0;
132 }