Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
change_log_format.cpp
Go to the documentation of this file.
1// -------------------------------------------------------//
2//
3// SHAMROCK code for hydrodynamics
4// Copyright (c) 2021-2026 Timothée David--Cléris <tim.shamrock@proton.me>
5// SPDX-License-Identifier: CeCILL Free Software License Agreement v2.1
6// Shamrock is licensed under the CeCILL 2.1 License, see LICENSE for more information
7//
8// -------------------------------------------------------//
9
15
16#include "shambase/exception.hpp"
17#include "shambase/stacktrace.hpp"
18#include "shambase/term_colors.hpp"
19#include "sham/term/tty.hpp"
20#include "shamcmdopt/env.hpp"
21#include "shamcomm/logs.hpp"
22#include "shamcomm/worldInfo.hpp"
23
27namespace logformatter {
28
35
36 std::string style0_formatter_full(const logger::ReformatArgs &args) {
37 return "[" + (args.color) + args.module_name + shambase::term_colors::reset() + "] "
38 + (args.color) + (args.level_name) + shambase::term_colors::reset() + ": "
39 + args.content;
40 }
41
48 std::string style0_formatter_simple(const logger::ReformatArgs &args) {
49 return "[" + (args.color) + args.module_name + shambase::term_colors::reset() + "] "
50 + (args.color) + (args.level_name) + shambase::term_colors::reset() + ": "
51 + args.content;
52 }
53
60 std::string style1_formatter_full(const logger::ReformatArgs &args) {
61 return sham::format(
62 "{5:}rank={6:<4}{2:} {5:}({3:^20}){2:} {0:}{1:}{2:}: {4:}",
63 args.color,
64 args.level_name,
65 shambase::term_colors::reset(),
66 args.module_name,
67 args.content,
68 shambase::term_colors::faint(),
69 shamcomm::world_rank());
70 }
71
78 std::string style1_formatter_simple(const logger::ReformatArgs &args) {
79 return sham::format(
80 "{5:}({3:}){2:} : {4:}",
81 args.color,
82 args.level_name,
83 shambase::term_colors::reset(),
84 args.module_name,
85 args.content,
86 shambase::term_colors::faint());
87 }
88
94
95 std::string style2_formatter_full(const logger::ReformatArgs &args) {
96
97 return sham::format(
98 "{0:}{1:}{2:}: {4:}{5:} | ({3:}) rank={6:<4}{2:}",
99 args.color,
100 args.level_name,
101 shambase::term_colors::reset(),
102 args.module_name,
103 args.content,
104 shambase::term_colors::faint(),
105 shamcomm::world_rank());
106 }
107
114 std::string style2_formatter_simple(const logger::ReformatArgs &args) {
115 return sham::format(
116 "{5:}({3:}){2:} : {4:}",
117 args.color,
118 args.level_name,
119 shambase::term_colors::reset(),
120 args.module_name,
121 args.content,
122 shambase::term_colors::faint());
123 }
124
131 std::string style3_formatter_full(const logger::ReformatArgs &args) {
132
133 u32 tty_width = sham::term::get_tty_columns();
134
135 std::string ansi_reset = shambase::term_colors::reset();
136 std::string ansi_faint = shambase::term_colors::faint();
137
138 std::string lineend = sham::format(
139 "{5:} [{3:}][rank={6:}]{2:}",
140 args.color,
141 args.level_name,
142 ansi_reset,
143 args.module_name,
144 args.content,
145 ansi_faint,
146 shamcomm::world_rank());
147
148 std::string log = sham::format(
149 "{0:}{1:}{2:}: {4:}",
150 args.color,
151 args.level_name,
152 ansi_reset,
153 args.module_name,
154 args.content,
155 ansi_faint,
156 shamcomm::world_rank());
157
158 std::string log_line1, log_line2;
159 size_t first_nl = log.find_first_of('\n');
160 if (first_nl != std::string::npos) {
161 log_line1 = log.substr(0, first_nl);
162 log_line2 = log.substr(first_nl);
163 } else {
164 log_line1 = log;
165 log_line2 = "";
166 }
167
168 u32 ansi_count = ansi_reset.size() * 2 + ansi_faint.size() + args.color.size();
169
170 return sham::format("{:<{}}", log_line1, tty_width - lineend.size() + ansi_count - 1)
171 + lineend + log_line2;
172 }
173
180 std::string style3_formatter_simple(const logger::ReformatArgs &args) {
181 return sham::format(
182 "{5:}{3:}{2:}: {4:}",
183 args.color,
184 args.level_name,
185 shambase::term_colors::reset(),
186 args.module_name,
187 args.content,
188 shambase::term_colors::bold());
189 }
190
197 std::string style4_formatter_full(const logger::ReformatArgs &args) {
198
199 u32 tty_width = sham::term::get_tty_columns();
200
201 std::string ansi_reset = shambase::term_colors::reset();
202 std::string ansi_faint = shambase::term_colors::faint();
203
204 std::string lineend = sham::format(
205 "{5:} [{3:}][rank={6:}][{7:.2f}s]{2:}",
206 args.color,
207 args.level_name,
208 ansi_reset,
209 args.module_name,
210 args.content,
211 ansi_faint,
212 shamcomm::world_rank(),
213 shambase::details::get_wtime());
214
215 std::string log = sham::format(
216 "{0:}{1:}{2:}: {4:}",
217 args.color,
218 args.level_name,
219 ansi_reset,
220 args.module_name,
221 args.content,
222 ansi_faint,
223 shamcomm::world_rank());
224
225 std::string log_line1, log_line2;
226 size_t first_nl = log.find_first_of('\n');
227 if (first_nl != std::string::npos) {
228 log_line1 = log.substr(0, first_nl);
229 log_line2 = log.substr(first_nl);
230 } else {
231 log_line1 = log;
232 log_line2 = "";
233 }
234
235 u32 ansi_count = ansi_reset.size() * 2 + ansi_faint.size() + args.color.size();
236
237 return sham::format("{:<{}}", log_line1, tty_width - lineend.size() + ansi_count - 1)
238 + lineend + log_line2;
239 }
240
247 std::string style4_formatter_simple(const logger::ReformatArgs &args) {
248 return sham::format(
249 "{5:}{3:}{2:}: {4:}",
250 args.color,
251 args.level_name,
252 shambase::term_colors::reset(),
253 args.module_name,
254 args.content,
255 shambase::term_colors::bold());
256 }
257
266 void exception_gen_callback(std::string msg) {
267 shamcomm::logs::err_ln("Exception", "Exception created :\n" + msg);
268 }
269
270} // namespace logformatter
271
272std::string SHAMLOGFORMATTER = shamcmdopt::getenv_str_default_register(
273 "SHAMLOGFORMATTER", "3", "Change the log formatter (values :0-4) [default: 3]");
274
275std::string SHAMLOG_ERR_ON_EXCEPT = shamcmdopt::getenv_str_default_register(
276 "SHAMLOG_ERR_ON_EXCEPT", "1", "Enable logging of exceptions (default to 1)");
277
278namespace shamsys {
279
280 void change_log_format() {
281
282 shamlog_debug_ln("Sys", "changing formatter to MPI form");
283
284 if (SHAMLOGFORMATTER == "0") {
285 logger::change_formaters(
286 logformatter::style0_formatter_full, logformatter::style0_formatter_simple);
287 } else if (SHAMLOGFORMATTER == "1") {
288 logger::change_formaters(
289 logformatter::style1_formatter_full, logformatter::style1_formatter_simple);
290 } else if (SHAMLOGFORMATTER == "2") {
291 logger::change_formaters(
292 logformatter::style2_formatter_full, logformatter::style2_formatter_simple);
293 } else if (SHAMLOGFORMATTER == "3") {
294 logger::change_formaters(
295 logformatter::style3_formatter_full, logformatter::style3_formatter_simple);
296 } else if (SHAMLOGFORMATTER == "4") {
297 logger::change_formaters(
298 logformatter::style4_formatter_full, logformatter::style4_formatter_simple);
299 } else {
300 logger::err_ln("Log", "Unknown formatter");
301 shambase::throw_unimplemented("Unknown formatter");
302 }
303
304 if (SHAMLOG_ERR_ON_EXCEPT == "1") {
305 shamlog_debug_ln("Log", "Enabling exception handler callback");
306 shambase::set_exception_gen_callback(&logformatter::exception_gen_callback);
307 }
308 }
309} // namespace shamsys
u32
std::uint32_t u32
32 bit unsigned integer
Definition aliases_int.hpp:27
exception.hpp
This header file contains utility functions related to exception handling in the code.
logformatter
Namespace for log formatters.
Definition change_log_format.cpp:27
logformatter::style3_formatter_simple
std::string style3_formatter_simple(const logger::ReformatArgs &args)
Log formatter for style 3, simple details.
Definition change_log_format.cpp:180
logformatter::style0_formatter_full
std::string style0_formatter_full(const logger::ReformatArgs &args)
Log formatter for style 0, full details.
Definition change_log_format.cpp:36
logformatter::exception_gen_callback
void exception_gen_callback(std::string msg)
The callback called when an exception is thrown.
Definition change_log_format.cpp:266
logformatter::style3_formatter_full
std::string style3_formatter_full(const logger::ReformatArgs &args)
Log formatter for style 3, full details.
Definition change_log_format.cpp:131
logformatter::style1_formatter_full
std::string style1_formatter_full(const logger::ReformatArgs &args)
Log formatter for style 1, full details.
Definition change_log_format.cpp:60
logformatter::style4_formatter_full
std::string style4_formatter_full(const logger::ReformatArgs &args)
Log formatter for style 3, full details + time.
Definition change_log_format.cpp:197
logformatter::style2_formatter_simple
std::string style2_formatter_simple(const logger::ReformatArgs &args)
Log formatter for style 2, simple details.
Definition change_log_format.cpp:114
logformatter::style1_formatter_simple
std::string style1_formatter_simple(const logger::ReformatArgs &args)
Log formatter for style 1, simple details.
Definition change_log_format.cpp:78
logformatter::style2_formatter_full
std::string style2_formatter_full(const logger::ReformatArgs &args)
Log formatter for style 2, full details.
Definition change_log_format.cpp:95
logformatter::style0_formatter_simple
std::string style0_formatter_simple(const logger::ReformatArgs &args)
Log formatter for style 0, simple details.
Definition change_log_format.cpp:48
logformatter::style4_formatter_simple
std::string style4_formatter_simple(const logger::ReformatArgs &args)
Log formatter for style 3, simple details + time.
Definition change_log_format.cpp:247
shambase::logs::change_formaters
void change_formaters(reformat_func_ptr full, reformat_func_ptr simple)
Changes the log formatter functions.
Definition reformat_message.cpp:38
shambase::set_exception_gen_callback
void set_exception_gen_callback(exception_gen_callback_t callback)
Set the exception generator callback.
Definition exception.cpp:39
shambase::throw_unimplemented
void throw_unimplemented(SourceLocation loc=SourceLocation{})
Throw a std::runtime_error saying that the function is unimplemented.
Definition exception.hpp:153
shamcmdopt::getenv_str_default_register
std::string getenv_str_default_register(const char *env_var, std::string default_val, std::string desc)
Get the content of the environment variable if it exist and register it documentation,...
Definition env.hpp:97
shamcomm::world_rank
i32 world_rank()
Gives the rank of the current process in the MPI communicator.
Definition worldInfo.cpp:41
shamsys
namespace for the system handling
Definition CommProtocolException.hpp:21
shamsys::change_log_format
void change_log_format()
Change the log formatter according to the SHAMLOGFORMATTER and SHAMLOG_ERR_ON_EXCEPT environment vari...
Definition change_log_format.cpp:280
shamcomm::logs::err_ln
void err_ln(std::string module_name, Types... var2)
Prints a log message with multiple arguments followed by a newline.
Definition logs.hpp:132
stacktrace.hpp
This file contains the definition for the stacktrace related functionality.
shambase::details::get_wtime
f64 get_wtime()
Returns the current wall clock time in seconds.
Definition stacktrace.cpp:182
shambase::logs::ReformatArgs
A structure containing the arguments to a log formatter.
Definition reformat_message.hpp:29
term_colors.hpp
shambase::term_colors::reset
const std::string reset()
Get the reset terminal escape char.
Definition term_colors.hpp:41
shambase::term_colors::faint
const std::string faint()
Get the faint terminal escape char.
Definition term_colors.hpp:45
shambase::term_colors::bold
const std::string bold()
Get the bold terminal escape char.
Definition term_colors.hpp:43
tty.hpp
This file contains tty info getters.
sham::term::get_tty_columns
int get_tty_columns()
Get the number of columns of the current terminal.
Definition tty.cpp:92
worldInfo.hpp
Functions related to the MPI communicator.
Generated on for Shamrock by doxygen 1.15.0