8.1
general documentation
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-2023 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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------*/
33 
34 BEGIN_C_DECLS
35 
36 /*=============================================================================
37  * Macro definitions
38  *============================================================================*/
39 
40 /*
41  * Print memory usage status.
42  */
43 
44 #define FVM_TRACE_MEM_STATUS \
45  {char str[256]; sprintf(str, "%s:%d", __FILE__, __LINE__); \
46  fvm_trace_mem_status(str);}
47 
48 /*============================================================================
49  * Type definitions
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Public function prototypes
54  *============================================================================*/
55 
56 /*----------------------------------------------------------------------------
57  * Print memory usage status.
58  *
59  * If no associated description is given, a call number will be issued.
60  *
61  * parameters:
62  * descr <-- optional description, or NULL
63  *----------------------------------------------------------------------------*/
64 
65 void
66 fvm_trace_mem_status(const char *descr);
67 
68 /*----------------------------------------------------------------------------*/
69 
70 END_C_DECLS
71 
72 #endif /* __FVM_TRACE_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
fvm_trace_mem_status
void fvm_trace_mem_status(const char *descr)
Definition: fvm_trace.c:93