v0.14.0
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | Static Private Attributes | List of all members
MoFEM::LogManager Struct Reference

Log manager is used to build and partition problems. More...

#include <src/interfaces/LogManager.hpp>

Inheritance diagram for MoFEM::LogManager:
[legend]
Collaboration diagram for MoFEM::LogManager:
[legend]

Classes

struct  InternalData
 

Public Types

enum  SeverityLevel {
  noisy, verbose, inform, warning,
  error
}
 Severity levels. More...
 
enum  LogAttributesBits { BitLineID = 1 << 0, BitScope = 1 << 1 }
 Tag attributes switches. More...
 
typedef boost::log::sources::severity_channel_logger< SeverityLevel, std::string > LoggerType
 Definition of the channel logger. More...
 
typedef sinks::synchronous_sink< sinks::text_ostream_backend > SinkType
 

Public Member Functions

MoFEMErrorCode query_interface (boost::typeindex::type_index type_index, UnknownInterface **iface) const
 
 LogManager (const MoFEM::Core &core)
 
virtual ~LogManager ()=default
 
- Public Member Functions inherited from MoFEM::UnknownInterface
template<class IFACE >
MoFEMErrorCode registerInterface (bool error_if_registration_failed=true)
 Register interface. More...
 
template<class IFACE >
MoFEMErrorCode getInterface (IFACE *&iface) const
 Get interface reference to pointer of interface. More...
 
template<class IFACE >
MoFEMErrorCode getInterface (IFACE **const iface) const
 Get interface pointer to pointer of interface. More...
 
template<class IFACE , typename boost::enable_if< boost::is_pointer< IFACE >, int >::type = 0>
IFACE getInterface () const
 Get interface pointer to pointer of interface. More...
 
template<class IFACE , typename boost::enable_if< boost::is_reference< IFACE >, int >::type = 0>
IFACE getInterface () const
 Get reference to interface. More...
 
template<class IFACE >
IFACE * getInterface () const
 Function returning pointer to interface. More...
 
virtual ~UnknownInterface ()=default
 

Static Public Member Functions

static void addAttributes (LogManager::LoggerType &lg, const int bit=0)
 Add attributes to logger. More...
 
static void addAttributes (const std::string channel, const int bit=0)
 Add attributes to channel. More...
 
static LoggerTypesetLog (const std::string channel)
 Set ans resset chanel logger. More...
 
static LoggerTypegetLog (const std::string channel)
 Get logger by channel. More...
 
static bool checkIfChannelExist (const std::string channel)
 Check if channel exist. More...
 
static void addTag (LogManager::LoggerType &lg, const std::string tag)
 Add tag to logger. More...
 
static void addTag (const std::string channel, const std::string tag)
 Add tag to channel. More...
 
static boost::shared_ptr< std::ostream > getStrmSelf ()
 Get the strm self object. More...
 
static boost::shared_ptr< std::ostream > getStrmWorld ()
 Get the strm world object. More...
 
static boost::shared_ptr< std::ostream > getStrmSync ()
 Get the strm sync object. More...
 
static boost::shared_ptr< std::ostream > getStrmNull ()
 Get the strm null object. More...
 
static boost::shared_ptr< SinkTypecreateSink (boost::shared_ptr< std::ostream > stream_ptr, std::string comm_filter)
 Create a sink object. More...
 
static void createDefaultSinks (MPI_Comm comm)
 Create default sinks. More...
 
static MoFEMErrorCode getOptions ()
 Get logger option. More...
 
static PetscErrorCode logPetscFPrintf (FILE *fd, const char format[], va_list Argp)
 Use to handle PETSc output. More...
 
static std::string getVLikeFormatedString (const char *fmt, va_list args)
 Converts formatted output to string. More...
 
static std::string getCLikeFormatedString (const char *fmt,...)
 Converts formatted output to string. More...
 
static void recordFormatterDefault (logging::record_view const &rec, logging::formatting_ostream &strm)
 Default record formatter. More...
 
- Static Public Member Functions inherited from MoFEM::UnknownInterface
static MoFEMErrorCode getLibVersion (Version &version)
 Get library version. More...
 
static MoFEMErrorCode getFileVersion (moab::Interface &moab, Version &version)
 Get database major version. More...
 
static MoFEMErrorCode setFileVersion (moab::Interface &moab, Version version=Version(MoFEM_VERSION_MAJOR, MoFEM_VERSION_MINOR, MoFEM_VERSION_BUILD))
 Get database major version. More...
 
static MoFEMErrorCode getInterfaceVersion (Version &version)
 Get database major version. More...
 

Static Public Attributes

static constexpr std::array< char *const, error+1 > severityStrings
 
static FILE * dummy_mofem_fd = (FILE *)&dummy_file
 Dummy file pointer (DO NOT USE) More...
 

Private Attributes

MoFEM::CorecOre
 

Static Private Attributes

static boost::shared_ptr< InternalDatainternalDataPtr
 
static std::string petscStringCache = std::string()
 

Detailed Description

Log manager is used to build and partition problems.

Examples
elasticity.cpp.

Definition at line 26 of file LogManager.hpp.

Member Typedef Documentation

◆ LoggerType

typedef boost::log::sources::severity_channel_logger<SeverityLevel, std::string> MoFEM::LogManager::LoggerType

Definition of the channel logger.

Definition at line 64 of file LogManager.hpp.

◆ SinkType

typedef sinks::synchronous_sink<sinks::text_ostream_backend> MoFEM::LogManager::SinkType

Definition at line 66 of file LogManager.hpp.

Constructor & Destructor Documentation

◆ LogManager()

MoFEM::LogManager::LogManager ( const MoFEM::Core core)

Definition at line 141 of file LogManager.cpp.

142  : cOre(const_cast<MoFEM::Core &>(core)) {}

◆ ~LogManager()

virtual MoFEM::LogManager::~LogManager ( )
virtualdefault

Member Function Documentation

◆ checkIfChannelExist()

bool MoFEM::LogManager::checkIfChannelExist ( const std::string  channel)
static

Check if channel exist.

Parameters
channel
Returns
true
false

Definition at line 404 of file LogManager.cpp.

404  {
405  return InternalData::logChannels.find(channel) !=
407 }

◆ createDefaultSinks()

void MoFEM::LogManager::createDefaultSinks ( MPI_Comm  comm)
static

Create default sinks.

Definition at line 313 of file LogManager.cpp.

313  {
314 
315  internalDataPtr = boost::make_shared<InternalData>(comm);
316 
317  auto core_log = logging::core::get();
318  core_log->remove_all_sinks();
319  core_log->add_sink(LogManager::createSink(
320  boost::shared_ptr<std::ostream>(&std::clog, boost::null_deleter()),
321  "PETSC"));
322  core_log->add_sink(createSink(getStrmSelf(), "SELF"));
323  core_log->add_sink(createSink(getStrmWorld(), "WORLD"));
324  core_log->add_sink(createSink(getStrmSync(), "SYNC"));
325  core_log->add_sink(createSink(getStrmNull(), "NULL"));
326 
327  LogManager::setLog("PETSC");
328  LogManager::setLog("SELF");
329  LogManager::setLog("WORLD");
330  LogManager::setLog("SYNC");
331  LogManager::setLog("NULL");
332 
333  MOFEM_LOG_TAG("PETSC", "petsc");
334 
335  int rank;
336  MPI_Comm_rank(comm, &rank);
337  core_log->add_global_attribute("Proc", attrs::constant<unsigned int>(rank));
338 }

◆ createSink()

boost::shared_ptr< LogManager::SinkType > MoFEM::LogManager::createSink ( boost::shared_ptr< std::ostream >  stream_ptr,
std::string  comm_filter 
)
static

Create a sink object.

Parameters
stream_ptr
comm_filter
Returns
boost::shared_ptr<SinkType>
Examples
add_cubit_meshsets.cpp, approx_sphere.cpp, continuity_check_on_skeleton_3d.cpp, continuity_check_on_skeleton_with_simple_2d_for_h1.cpp, continuity_check_on_skeleton_with_simple_2d_for_hcurl.cpp, elasticity.cpp, ep.cpp, level_set.cpp, log.cpp, matrix_function.cpp, nonlinear_dynamics.cpp, nonlinear_elastic.cpp, operators_tests.cpp, scalar_check_approximation.cpp, schur_test_diag_mat.cpp, split_sideset.cpp, tensor_divergence_operator.cpp, and thermo_elastic.cpp.

Definition at line 298 of file LogManager.cpp.

299  {
300 
301  auto backend = boost::make_shared<sinks::text_ostream_backend>();
302  if (stream_ptr)
303  backend->add_stream(stream_ptr);
304  backend->auto_flush(true);
305 
306  auto sink = boost::make_shared<SinkType>(backend);
307  sink->set_filter((expr::has_attr(channel) && channel == comm_filter));
308  sink->set_formatter(&recordFormatterDefault);
309 
310  return sink;
311 }

◆ getCLikeFormatedString()

std::string MoFEM::LogManager::getCLikeFormatedString ( const char *  fmt,
  ... 
)
static

Converts formatted output to string.

Parameters
fmt
args
Returns
std::string

Definition at line 471 of file LogManager.cpp.

471  {
472  va_list args;
473  va_start(args, fmt);
474  auto str = getVLikeFormatedString(fmt, args);
475  va_end(args);
476  return str;
477 }

◆ getOptions()

MoFEMErrorCode MoFEM::LogManager::getOptions ( )
static

Get logger option.

This function is called by MoFEM core when this interface is registred into database.

Returns
MoFEMErrorCode

Definition at line 152 of file LogManager.cpp.

152  {
154  PetscInt sev_level = SeverityLevel::inform;
155  PetscBool log_scope = PETSC_FALSE;
156  PetscBool log_quiet = PETSC_FALSE;
157  PetscBool log_no_colors = PETSC_FALSE;
158  PetscBool log_time = PETSC_FALSE;
159 
160  CHKERR PetscOptionsBegin(PETSC_COMM_WORLD, "log_",
161  "Logging interface options", "none");
162 
163  CHKERR PetscOptionsEList("-severity_level", "Severity level", "",
164  severityStrings.data(), SeverityLevel::error + 1,
165  severityStrings[sev_level], &sev_level, PETSC_NULL);
166  CHKERR PetscOptionsEList("-sl", "Severity level", "",
167  severityStrings.data(), SeverityLevel::error + 1,
168  severityStrings[sev_level], &sev_level, PETSC_NULL);
169 
170  CHKERR PetscOptionsBool("-scope", "Log scope", "", log_scope, &log_scope,
171  NULL);
172 
173  CHKERR PetscOptionsBool("-quiet", "Quiet log attributes", "", log_quiet,
174  &log_quiet, NULL);
175 
176  CHKERR PetscOptionsBool("-no_color", "Terminal with no colors", "",
177  log_no_colors, &log_no_colors, NULL);
178  CHKERR PetscOptionsBool("-nc", "Terminal with no colors", "", log_no_colors,
179  &log_no_colors, NULL);
180 
181  CHKERR PetscOptionsBool("-time", "Log time", "",
182  log_time, &log_time, NULL);
183 
184  ierr = PetscOptionsEnd();
185  CHKERRG(ierr);
186 
187  logging::core::get()->set_filter(MoFEM::LogKeywords::severity >= sev_level);
188 
189  if (log_scope)
190  logging::core::get()->add_global_attribute("Scope", attrs::named_scope());
191 
192  if (log_quiet)
194 
195  if (log_no_colors)
197 
198  if (log_time)
200 
202 }

◆ getStrmNull()

boost::shared_ptr< std::ostream > MoFEM::LogManager::getStrmNull ( )
static

Get the strm null object.

Returns
boost::shared_ptr<std::ostream>

Definition at line 352 of file LogManager.cpp.

352  {
353  return internalDataPtr->getStrmNull();
354 }

◆ getStrmSelf()

boost::shared_ptr< std::ostream > MoFEM::LogManager::getStrmSelf ( )
static

Get the strm self object.

Returns
boost::shared_ptr<std::ostream>
Examples
add_cubit_meshsets.cpp, continuity_check_on_skeleton_3d.cpp, continuity_check_on_skeleton_with_simple_2d_for_h1.cpp, continuity_check_on_skeleton_with_simple_2d_for_hcurl.cpp, log.cpp, and matrix_function.cpp.

Definition at line 340 of file LogManager.cpp.

340  {
341  return internalDataPtr->getStrmSelf();
342 }

◆ getStrmSync()

boost::shared_ptr< std::ostream > MoFEM::LogManager::getStrmSync ( )
static

Get the strm sync object.

Returns
boost::shared_ptr<std::ostream>
Examples
ep.cpp, and thermo_elastic.cpp.

Definition at line 348 of file LogManager.cpp.

348  {
349  return internalDataPtr->getStrmSync();
350 }

◆ getStrmWorld()

boost::shared_ptr< std::ostream > MoFEM::LogManager::getStrmWorld ( )
static

Get the strm world object.

Returns
boost::shared_ptr<std::ostream>
Examples
approx_sphere.cpp, elasticity.cpp, ep.cpp, level_set.cpp, nonlinear_dynamics.cpp, nonlinear_elastic.cpp, operators_tests.cpp, scalar_check_approximation.cpp, schur_test_diag_mat.cpp, split_sideset.cpp, tensor_divergence_operator.cpp, and thermo_elastic.cpp.

Definition at line 344 of file LogManager.cpp.

344  {
345  return internalDataPtr->getStrmWorld();
346 }

◆ getVLikeFormatedString()

std::string MoFEM::LogManager::getVLikeFormatedString ( const char *  fmt,
va_list  args 
)
static

Converts formatted output to string.

Parameters
fmt
args
Returns
std::string

Definition at line 465 of file LogManager.cpp.

465  {
466  std::array<char, 1024> buf;
467  vsprintf(buf.data(), fmt, args);
468  return std::string(buf.data());
469 }

◆ logPetscFPrintf()

PetscErrorCode MoFEM::LogManager::logPetscFPrintf ( FILE *  fd,
const char  format[],
va_list  Argp 
)
static

Use to handle PETSc output.

Note
This is for internal use only/
Parameters
fd
format
Argp
Returns
PetscErrorCode

Definition at line 411 of file LogManager.cpp.

412  {
414  if (fd != stdout && fd != stderr && fd != dummy_mofem_fd) {
415  CHKERR PetscVFPrintfDefault(fd, format, Argp);
416 
417  } else {
418 
419  std::array<char, 1024> buff;
420  size_t length;
421  CHKERR PetscVSNPrintf(buff.data(), 1024, format, &length, Argp);
422 
423  auto get_str = [&buff]() {
424  std::string str;
425  if (!petscStringCache.empty())
426  str = petscStringCache + std::string(buff.data());
427  else
428  str = std::string(buff.data());
429  return str;
430  };
431  const auto str = get_str();
432 
433  if (!str.empty()) {
434  if (fd != dummy_mofem_fd) {
435 
437  MoFEM::LogManager::SeverityLevel::inform;
438  if (str.find("WARNING") != std::string::npos)
439  sev = MoFEM::LogManager::SeverityLevel::warning;
440 
441  std::istringstream is(str);
442  std::string line;
443  std::vector<std::string> log_list;
444 
445  while (getline(is, line, '\n'))
446  log_list.push_back(line);
447 
448  if (str.back() != '\n') {
449  petscStringCache = log_list.back();
450  log_list.pop_back();
451  } else
452  petscStringCache.clear();
453 
454  for(auto &line : log_list)
455  MOFEM_LOG("PETSC", sev) << line;
456 
457  } else {
458  std::clog << str;
459  }
460  }
461  }
463 }

◆ query_interface()

MoFEMErrorCode MoFEM::LogManager::query_interface ( boost::typeindex::type_index  type_index,
UnknownInterface **  iface 
) const
virtual

Implements MoFEM::UnknownInterface.

Definition at line 145 of file LogManager.cpp.

146  {
148  *iface = const_cast<LogManager *>(this);
150 }

◆ recordFormatterDefault()

void MoFEM::LogManager::recordFormatterDefault ( logging::record_view const &  rec,
logging::formatting_ostream &  strm 
)
static

Default record formatter.

Parameters
rec
strm

Definition at line 204 of file LogManager.cpp.

205  {
206 
208 
209  auto sev = rec[severity];
210  auto p = rec[proc_attr];
211  auto l = rec[line_id];
212  auto s = rec[scope];
213  auto tg = rec[tag_attr];
214  auto tl = rec[timeline];
215 
216  auto set_color = [&](const auto str) {
217 #if defined(PETSC_HAVE_UNISTD_H) && defined(PETSC_USE_ISATTY)
218  if (isatty(fileno(stdout)) && !LogManager::InternalData::noColors)
219  strm << str;
220 #endif
221  };
222 
224 
225  auto local_time = boost::posix_time::second_clock::local_time();
226  strm << "(Local time ";
227  strm << local_time.date().year() << "-" << local_time.date().month()
228  << "-" << local_time.date().day() << " "
229  << local_time.time_of_day().hours() << ":"
230  << local_time.time_of_day().minutes() << ":"
231  << local_time.time_of_day().seconds();
232  strm << ") ";
233 
234  }
235 
236  if (!p.empty()) {
237  strm << "[";
238  set_color("\033[32m");
239  strm << p;
240  set_color("\033[0m");
241  strm << "] ";
242  }
243 
244  switch (sev.get()) {
245  case SeverityLevel::error:
246  set_color("\033[1m");
247  case SeverityLevel::warning:
248  set_color("\033[31m");
249  break;
250  case SeverityLevel::inform:
251  set_color("\033[34m");
252  break;
253  case SeverityLevel::verbose:
254  set_color("\033[35m");
255  break;
256  case SeverityLevel::noisy:
257  set_color("\033[36m");
258  break;
259  }
260 
261  strm << sev;
262 
263  set_color("\033[0m");
264 
265  if (!l.empty())
266  strm << std::hex << std::setw(8) << std::setfill('0') << l.get()
267  << std::dec << std::setfill(' ') << ": ";
268 
269  if (!s.empty()) {
270  for (::boost::log::attributes::named_scope_list::const_iterator iter =
271  s->begin();
272  iter != s->end(); ++iter) {
273  const auto path = std::string(iter->file_name.data());
274  const auto file = path.substr(path.find_last_of("/\\") + 1);
275  strm << "(" << file << ":" << iter->line << ">" << iter->scope_name
276  << ")";
277  }
278  strm << " ";
279  }
280 
281  if (!tg.empty()) {
282 
283  set_color("\033[1m");
284  strm << "[" << tg.get() << "] ";
285  set_color("\033[0m");
286  }
287 
288  if (!tl.empty())
289  strm << "[" << tl.get() << "] ";
290  }
291 
292  auto msg = rec[logging::expressions::smessage];
293 
294  strm << msg;
295 }

Member Data Documentation

◆ cOre

MoFEM::Core& MoFEM::LogManager::cOre
private

Definition at line 234 of file LogManager.hpp.

◆ dummy_mofem_fd

FILE * MoFEM::LogManager::dummy_mofem_fd = (FILE *)&dummy_file
static

Dummy file pointer (DO NOT USE)

Note
This is for internal use only/

Definition at line 191 of file LogManager.hpp.

◆ internalDataPtr

boost::shared_ptr< LogManager::InternalData > MoFEM::LogManager::internalDataPtr
staticprivate

Definition at line 236 of file LogManager.hpp.

◆ petscStringCache

std::string MoFEM::LogManager::petscStringCache = std::string()
staticprivate

Definition at line 239 of file LogManager.hpp.

◆ severityStrings

constexpr std::array< char *const, LogManager::SeverityLevel::error+1 > MoFEM::LogManager::severityStrings
staticconstexpr
Initial value:
= {
(char *)"noisy", (char *)"verbose", (char *)"inform", (char *)"warning",
(char *)"error"
}

Definition at line 35 of file LogManager.hpp.


The documentation for this struct was generated from the following files:
MoFEMFunctionReturnHot
#define MoFEMFunctionReturnHot(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:447
MoFEM::CoreTmp< 0 >
Core (interface) class.
Definition: Core.hpp:82
MoFEM::LogManager::dummy_mofem_fd
static FILE * dummy_mofem_fd
Dummy file pointer (DO NOT USE)
Definition: LogManager.hpp:191
MoFEM::LogManager::petscStringCache
static std::string petscStringCache
Definition: LogManager.hpp:239
convert.args
args
Definition: convert.py:66
MoFEM::LogManager::recordFormatterDefault
static void recordFormatterDefault(logging::record_view const &rec, logging::formatting_ostream &strm)
Default record formatter.
Definition: LogManager.cpp:204
MoFEM::LogManager::createSink
static boost::shared_ptr< SinkType > createSink(boost::shared_ptr< std::ostream > stream_ptr, std::string comm_filter)
Create a sink object.
Definition: LogManager.cpp:298
MoFEM::LogManager::getVLikeFormatedString
static std::string getVLikeFormatedString(const char *fmt, va_list args)
Converts formatted output to string.
Definition: LogManager.cpp:465
MoFEM::LogManager::severityStrings
static constexpr std::array< char *const, error+1 > severityStrings
Definition: LogManager.hpp:35
MoFEM::LogManager::getStrmNull
static boost::shared_ptr< std::ostream > getStrmNull()
Get the strm null object.
Definition: LogManager.cpp:352
CHKERR
#define CHKERR
Inline error check.
Definition: definitions.h:535
MoFEM::LogManager::InternalData::logChannels
static std::map< std::string, LoggerType > logChannels
Definition: LogManager.cpp:109
MoFEM::LogManager::cOre
MoFEM::Core & cOre
Definition: LogManager.hpp:234
MoFEM::LogManager::getStrmSync
static boost::shared_ptr< std::ostream > getStrmSync()
Get the strm sync object.
Definition: LogManager.cpp:348
MoFEM::LogManager::internalDataPtr
static boost::shared_ptr< InternalData > internalDataPtr
Definition: LogManager.hpp:236
MoFEM::LogManager::getStrmWorld
static boost::shared_ptr< std::ostream > getStrmWorld()
Get the strm world object.
Definition: LogManager.cpp:344
MoFEM::LogManager::InternalData::noColors
static bool noColors
Definition: LogManager.cpp:105
MoFEM::LogManager::getStrmSelf
static boost::shared_ptr< std::ostream > getStrmSelf()
Get the strm self object.
Definition: LogManager.cpp:340
MoFEM::LogManager::SeverityLevel
SeverityLevel
Severity levels.
Definition: LogManager.hpp:33
MOFEM_LOG_TAG
#define MOFEM_LOG_TAG(channel, tag)
Tag channel.
Definition: LogManager.hpp:339
PetscVFPrintfDefault
PetscErrorCode PetscVFPrintfDefault(FILE *fd, const char *format, va_list Argp)
MOFEM_LOG
#define MOFEM_LOG(channel, severity)
Log.
Definition: LogManager.hpp:308
MoFEM::LogManager::InternalData::logTime
static bool logTime
Definition: LogManager.cpp:107
MoFEM::Exceptions::ierr
static MoFEMErrorCodeGeneric< PetscErrorCode > ierr
Definition: Exceptions.hpp:76
MoFEMFunctionBeginHot
#define MoFEMFunctionBeginHot
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:440
MoFEM::LogManager::setLog
static LoggerType & setLog(const std::string channel)
Set ans resset chanel logger.
Definition: LogManager.cpp:389
MoFEM::LogManager::InternalData::logQuiet
static bool logQuiet
Definition: LogManager.cpp:104
MoFEMFunctionReturn
#define MoFEMFunctionReturn(a)
Last executable line of each PETSc function used for error handling. Replaces return()
Definition: definitions.h:416
CHKERRG
#define CHKERRG(n)
Check error code of MoFEM/MOAB/PETSc function.
Definition: definitions.h:483
MoFEMFunctionBegin
#define MoFEMFunctionBegin
First executable line of each MoFEM function, used for error handling. Final line of MoFEM functions ...
Definition: definitions.h:346
l
FTensor::Index< 'l', 3 > l
Definition: matrix_function.cpp:21
MoFEM::LogManager::LogManager
LogManager(const MoFEM::Core &core)
Definition: LogManager.cpp:141