1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/* ========================================================================== */
/* === Include/Mongoose_Logger.hpp ========================================== */
/* ========================================================================== */
/* -----------------------------------------------------------------------------
* Mongoose Graph Partitioning Library, Copyright (C) 2017-2023,
* Scott P. Kolodziej, Nuri S. Yeralan, Timothy A. Davis, William W. Hager
* Mongoose is licensed under Version 3 of the GNU General Public License.
* Mongoose is also available under other licenses; contact authors for details.
* SPDX-License-Identifier: GPL-3.0-only
* -------------------------------------------------------------------------- */
/**
* Centralized debug and timing manager
*
* For debug and timing information to be displayed via stdout. This system
* allows this information to be displayed (or not) without recompilation.
* Timing inforation for different *portions of the library are also managed
* here with a tic/toc pattern.
*/
// #pragma once
#ifndef MONGOOSE_LOGGER_HPP
#define MONGOOSE_LOGGER_HPP
#include <iostream>
#include <string>
#include <SuiteSparse_config.h>
#if !defined (SUITESPARSE_VERSION) || \
(SUITESPARSE_VERSION < SUITESPARSE_VER_CODE(7,4))
#error "Mongoose requires SuiteSparse_config 7.4.0 or later"
#endif
#include "Mongoose_Internal.hpp"
// Default Logging Levels
#ifndef LOG_ERROR
#define LOG_ERROR 1
#endif
#ifndef LOG_WARN
#define LOG_WARN 0
#endif
#ifndef LOG_INFO
#define LOG_INFO 0
#endif
#ifndef LOG_TEST
#define LOG_TEST 0
#endif
// Main Logging Macros
#define LogError(msg) \
do \
{ \
if (LOG_ERROR) \
(std::cout << __FILE__ << ":" << __LINE__ << ": " << msg); \
} while (0)
#define LogWarn(msg) \
do \
{ \
if (LOG_WARN) \
(std::cout << __FILE__ << ":" << __LINE__ << ": " << msg); \
} while (0)
#define LogInfo(msg) \
do \
{ \
if (LOG_INFO) \
(std::cout << msg); \
} while (0)
#define LogTest(msg) \
do \
{ \
if (LOG_TEST) \
(std::cout << msg); \
} while (0)
namespace Mongoose
{
typedef enum DebugType
{
None = 0,
Error = 1,
Warn = 2,
Info = 4,
Test = 8,
All = 15
} DebugType;
typedef enum TimingType
{
MatchingTiming = 0,
CoarseningTiming = 1,
RefinementTiming = 2,
FMTiming = 3,
QPTiming = 4,
IOTiming = 5
} TimingType;
class Logger
{
private:
MONGOOSE_API static int debugLevel;
MONGOOSE_API static bool timingOn;
MONGOOSE_API static double clocks[6];
MONGOOSE_API static float times[6];
public:
static inline void tic(TimingType timingType);
static inline void toc(TimingType timingType);
static inline float getTime(TimingType timingType);
static inline int getDebugLevel();
static void setDebugLevel(int debugType);
static void setTimingFlag(bool tFlag);
static void printTimingInfo();
};
/**
* Start a timer for a given type/part of the code.
*
* Given a timingType (MatchingTiming, CoarseningTiming, RefinementTiming,
* FMTiming, QPTiming, or IOTiming), a clock is started for that computation.
* The general structure is to call tic(IOTiming) at the beginning of an I/O
* operation, then call toc(IOTiming) at the end of the I/O operation.
*
* Note that problems can occur and timing results may be inaccurate if a tic
* is followed by another tic (or a toc is followed by another toc).
*
* @param timingType The portion of the library being timed (MatchingTiming,
* CoarseningTiming, RefinementTiming, FMTiming, QPTiming, or IOTiming).
*/
inline void Logger::tic(TimingType timingType)
{
if (timingOn)
{
clocks[timingType] = SUITESPARSE_TIME;
}
}
/**
* Stop a timer for a given type/part of the code.
*
* Given a timingType (MatchingTiming, CoarseningTiming, RefinementTiming,
* FMTiming, QPTiming, or IOTiming), a clock is stopped for that computation.
* The general structure is to call tic(IOTiming) at the beginning of an I/O
* operation, then call toc(IOTiming) at the end of the I/O operation.
*
* Note that problems can occur and timing results may be inaccurate if a tic
* is followed by another tic (or a toc is followed by another toc).
*
* @param timingType The portion of the library being timed (MatchingTiming,
* CoarseningTiming, RefinementTiming, FMTiming, QPTiming, or IOTiming).
*/
inline void Logger::toc(TimingType timingType)
{
if (timingOn)
{
times[timingType]
+= (float) (SUITESPARSE_TIME - clocks[timingType]) ;
}
}
/**
* Get the time recorded for a given timing type.
*
* Retreive the total clock time for a given timing type (MatchingTiming,
* CoarseningTiming, RefinementTiming, FMTiming, QPTiming, or IOTiming).
*
* @param timingType The portion of the library being timed (MatchingTiming,
* CoarseningTiming, RefinementTiming, FMTiming, QPTiming, or IOTiming).
*/
inline float Logger::getTime(TimingType timingType)
{
return times[timingType];
}
inline int Logger::getDebugLevel()
{
return debugLevel;
}
} // end namespace Mongoose
#endif
|
