Code_Saturne
CFD tool
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
fvm_trace.h
Go to the documentation of this file.
1 #ifndef __FVM_TRACE_H__
2 #define __FVM_TRACE_H__
3 
4 /*============================================================================
5  * Tracing utility functions for profiling and debugging
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2012 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #if 0
33 } /* Fake brace to force back Emacs auto-indentation back to column 0 */
34 #endif
35 #endif /* __cplusplus */
36 
37 /*=============================================================================
38  * Macro definitions
39  *============================================================================*/
40 
41 /*
42  * Print memory usage status.
43  */
44 
45 #define FVM_TRACE_MEM_STATUS \
46  {char str[256]; sprintf(str, "%s:%d", __FILE__, __LINE__); \
47  fvm_trace_mem_status(str);}
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
53 /*=============================================================================
54  * Public function prototypes
55  *============================================================================*/
56 
57 /*----------------------------------------------------------------------------
58  * Print memory usage status.
59  *
60  * If no associated description is given, a call number will be issued.
61  *
62  * parameters:
63  * descr <-- optional description, or NULL
64  *----------------------------------------------------------------------------*/
65 
66 void
67 fvm_trace_mem_status(const char *descr);
68 
69 /*----------------------------------------------------------------------------*/
70 
71 #ifdef __cplusplus
72 }
73 #endif /* __cplusplus */
74 
75 #endif /* __FVM_TRACE_H__ */
void fvm_trace_mem_status(const char *descr)
Definition: fvm_trace.c:98