mem: initial doxygen documentation for MM, small whitespace changes
[sip-router] / mem / meminfo.h
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 /*
20  * History:
21  * --------
22  *  2005-03-02  created (andrei)
23  *  2005-07-25  renamed meminfo to mem_info due to name conflict on solaris
24  */
25
26 /**
27  * \file
28  * \brief Memory manager (malloc) informations and statistics
29  * 
30  * Memory manager (malloc) informations and statistics, like the used memory,
31  * fragmentations etc..
32  * \ingroup mem
33  */
34
35 #ifndef meminfo_h
36 #define meminfo_h
37
38
39 /** Memory information structure */
40 struct mem_info{
41         unsigned long total_size; /** total size of memory pool */
42         unsigned long free; /** free memory */
43         unsigned long used; /** allocated size */
44         unsigned long real_used; /** used size plus overhead from malloc */
45         unsigned long max_used; /** maximum used size since server start? */
46         unsigned long min_frag; /** minimum number of fragmentations? */
47         unsigned long total_frags; /** number of total memory fragments */
48 };
49
50 #endif
51