SimGrid  3.16
Versatile Simulation of Distributed Systems

Detailed Description

A generic logging facility in the spirit of log4j (grounding feature)

For more information, please refer to Simulation Logging Section.

Modules

 Existing log categories
 (automatically extracted)
 

Macros

#define XBT_LOG_STATIC_THRESHOLD   xbt_log_priority_none
 All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out. More...
 
#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)
 
#define XBT_LOG_NEW_CATEGORY(catName, desc)   XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
 
#define XBT_LOG_DEFAULT_CATEGORY(cname)   static xbt_log_category_t _XBT_LOGV(default) XBT_ATTRIB_UNUSED = &_XBT_LOGV(cname)
 
#define XBT_LOG_NEW_DEFAULT_CATEGORY(cname, desc)
 
#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc)
 
#define XBT_LOG_EXTERNAL_CATEGORY(cname)   extern s_xbt_log_category_t _XBT_LOGV(cname)
 
#define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname)
 
#define XBT_LOG_ISENABLED(catName, priority)   _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
 
#define XBT_CDEBUG(categ, ...)
 Log an event at the DEBUG priority on the specified category with these args. More...
 
#define XBT_CVERB(categ, ...)
 Log an event at the VERB priority on the specified category with these args. More...
 
#define XBT_CINFO(categ, ...)
 Log an event at the INFO priority on the specified category with these args. More...
 
#define XBT_CWARN(categ, ...)
 Log an event at the WARN priority on the specified category with these args. More...
 
#define XBT_CERROR(categ, ...)
 Log an event at the ERROR priority on the specified category with these args. More...
 
#define XBT_CCRITICAL(categ, ...)
 Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10). More...
 
#define XBT_DEBUG(...)
 Log an event at the DEBUG priority on the default category with these args. More...
 
#define XBT_VERB(...)
 Log an event at the VERB priority on the default category with these args. More...
 
#define XBT_INFO(...)
 Log an event at the INFO priority on the default category with these args. More...
 
#define XBT_WARN(...)
 Log an event at the WARN priority on the default category with these args. More...
 
#define XBT_ERROR(...)
 Log an event at the ERROR priority on the default category with these args. More...
 
#define XBT_CRITICAL(...)
 Log an event at the CRITICAL priority on the default category with these args. More...
 
#define XBT_IN(...)   _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)
 Log at TRACE priority that we entered in current function, appending a user specified format. More...
 
#define XBT_OUT(...)   _XBT_IN_OUT("<< end of %s" __VA_ARGS__)
 Log at TRACE priority that we exited the current function, appending a user specified format. More...
 
#define XBT_HERE(...)   XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)
 Log at TRACE priority a message indicating that we reached that point, appending a user specified format. More...
 
#define XBT_LOG_STATIC_THRESHOLD   xbt_log_priority_none
 All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out. More...
 
#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)
 
#define XBT_LOG_NEW_CATEGORY(catName, desc)   XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
 
#define XBT_LOG_DEFAULT_CATEGORY(cname)   static xbt_log_category_t _XBT_LOGV(default) XBT_ATTRIB_UNUSED = &_XBT_LOGV(cname)
 
#define XBT_LOG_NEW_DEFAULT_CATEGORY(cname, desc)
 
#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc)
 
#define XBT_LOG_EXTERNAL_CATEGORY(cname)   extern s_xbt_log_category_t _XBT_LOGV(cname)
 
#define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname)
 
#define XBT_LOG_ISENABLED(catName, priority)   _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
 
#define XBT_CDEBUG(categ, ...)
 Log an event at the DEBUG priority on the specified category with these args. More...
 
#define XBT_CVERB(categ, ...)
 Log an event at the VERB priority on the specified category with these args. More...
 
#define XBT_CINFO(categ, ...)
 Log an event at the INFO priority on the specified category with these args. More...
 
#define XBT_CWARN(categ, ...)
 Log an event at the WARN priority on the specified category with these args. More...
 
#define XBT_CERROR(categ, ...)
 Log an event at the ERROR priority on the specified category with these args. More...
 
#define XBT_CCRITICAL(categ, ...)
 Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10). More...
 
#define XBT_DEBUG(...)
 Log an event at the DEBUG priority on the default category with these args. More...
 
#define XBT_VERB(...)
 Log an event at the VERB priority on the default category with these args. More...
 
#define XBT_INFO(...)
 Log an event at the INFO priority on the default category with these args. More...
 
#define XBT_WARN(...)
 Log an event at the WARN priority on the default category with these args. More...
 
#define XBT_ERROR(...)
 Log an event at the ERROR priority on the default category with these args. More...
 
#define XBT_CRITICAL(...)
 Log an event at the CRITICAL priority on the default category with these args. More...
 
#define XBT_IN(...)   _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)
 Log at TRACE priority that we entered in current function, appending a user specified format. More...
 
#define XBT_OUT(...)   _XBT_IN_OUT("<< end of %s" __VA_ARGS__)
 Log at TRACE priority that we exited the current function, appending a user specified format. More...
 
#define XBT_HERE(...)   XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)
 Log at TRACE priority a message indicating that we reached that point, appending a user specified format. More...
 

Enumerations

enum  e_xbt_log_priority_t {
  xbt_log_priority_trace = 1, xbt_log_priority_debug = 2, xbt_log_priority_verbose = 3, xbt_log_priority_info = 4,
  xbt_log_priority_warning = 5, xbt_log_priority_error = 6, xbt_log_priority_critical = 7, xbt_log_priority_infinite = 8,
  xbt_log_priority_trace = 1, xbt_log_priority_debug = 2, xbt_log_priority_verbose = 3, xbt_log_priority_info = 4,
  xbt_log_priority_warning = 5, xbt_log_priority_error = 6, xbt_log_priority_critical = 7, xbt_log_priority_infinite = 8
}
 Log prioritiesThe different existing priorities. More...
 
enum  e_xbt_log_priority_t {
  xbt_log_priority_trace = 1, xbt_log_priority_debug = 2, xbt_log_priority_verbose = 3, xbt_log_priority_info = 4,
  xbt_log_priority_warning = 5, xbt_log_priority_error = 6, xbt_log_priority_critical = 7, xbt_log_priority_infinite = 8,
  xbt_log_priority_trace = 1, xbt_log_priority_debug = 2, xbt_log_priority_verbose = 3, xbt_log_priority_info = 4,
  xbt_log_priority_warning = 5, xbt_log_priority_error = 6, xbt_log_priority_critical = 7, xbt_log_priority_infinite = 8
}
 Log prioritiesThe different existing priorities. More...
 

Functions

void xbt_log_control_set (const char *control_string)
 

Macro Definition Documentation

◆ XBT_LOG_STATIC_THRESHOLD [1/2]

#define XBT_LOG_STATIC_THRESHOLD   xbt_log_priority_none

All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out.

◆ XBT_LOG_NEW_SUBCATEGORY [1/2]

#define XBT_LOG_NEW_SUBCATEGORY (   catName,
  parent,
  desc 
)
Value:
XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
std::string desc
Definition: config.cpp:143
int int errorclass int flag void baseptr void int MPI_Datatype void int int MPI_Datatype int MPI_Comm comm MPI_Status MPI_Datatype int count char int resultlen void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void void MPI_Datatype int MPI_Aint MPI_Op MPI_Win win MPI_Group MPI_Group MPI_Group newgroup MPI_Group group MPI_Group MPI_Group MPI_Group newgroup MPI_Group int int MPI_Group newgroup MPI_Group int size MPI_Group MPI_Group MPI_Group newgroup MPI_Info char key MPI_Info info MPI_Info int nkeys MPI_Info char int int flag int flag int char int int provided void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Request request MPI_Copy_function MPI_Delete_function int void extra_state MPI_User_function int MPI_Op op MPI_Op int commute void int MPI_Datatype void int int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Op MPI_Win MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Status status void void int MPI_Datatype MPI_Op MPI_Comm comm void void int MPI_Datatype MPI_Op int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype void int MPI_Datatype int MPI_Comm comm void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int void int MPI_Datatype int int MPI_Comm MPI_Status status void int MPI_Datatype int int MPI_Comm MPI_Request request int MPI_Request requests int MPI_Request int MPI_Status statuses MPI_Request int MPI_Status status MPI_Datatype datatype int int MPI_Aint MPI_Datatype MPI_Datatype newtype int int MPI_Aint MPI_Datatype MPI_Datatype new_type int int int MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint MPI_Aint MPI_Datatype newtype MPI_Datatype int type_keyval MPI_Datatype MPI_Aint extent MPI_Datatype datatype MPI_Datatype MPI_Aint MPI_Aint extent MPI_Datatype MPI_Aint MPI_Aint extent int int MPI_Aint MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint disp MPI_Datatype char name MPI_Datatype MPI_Count size MPI_Datatype MPI_Aint disp void int int void int MPI_Datatype MPI_Comm comm int MPI_Request int MPI_Status status int MPI_Request int int MPI_Status status void MPI_Aint int MPI_Info MPI_Comm MPI_Win win MPI_Win void MPI_Aint size MPI_Info MPI_Comm MPI_Win win MPI_Win win MPI_Win char int len MPI_Group int MPI_Win win MPI_Win MPI_Info info MPI_Win win int MPI_Win win MPI_Win win int MPI_Win win MPI_Win win MPI_Win int void att MPI_Win_copy_attr_function MPI_Win_delete_attr_function int void extra_state MPI_Fint comm MPI_Comm comm MPI_Info info MPI_Request request MPI_Win win MPI_Fint info MPI_Fint request int errorclass int char string void int MPI_Datatype int int MPI_Comm MPI_Request request void int size MPI_Request request char port_name MPI_Comm int errorcode MPI_Comm_errhandler_fn MPI_Errhandler errhandler MPI_Comm MPI_Errhandler errhandler MPI_Comm * parent
Definition: smpi_mpi.cpp:263
#define XBT_LOG_EXTERNAL_CATEGORY(cname)
Definition: log.h:220
Parameters
catNamename of new category
parentfather of the new category in the tree
descstring describing the purpose of this category

Defines a new subcategory of the parent.

◆ XBT_LOG_NEW_CATEGORY [1/2]

#define XBT_LOG_NEW_CATEGORY (   catName,
  desc 
)    XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
Parameters
catNamename of new category
descstring describing the purpose of this category

Creates a new subcategory of the root category.

◆ XBT_LOG_DEFAULT_CATEGORY [1/2]

#define XBT_LOG_DEFAULT_CATEGORY (   cname)    static xbt_log_category_t _XBT_LOGV(default) XBT_ATTRIB_UNUSED = &_XBT_LOGV(cname)
Parameters
cnamename of the cat

Indicates which category is the default one.

◆ XBT_LOG_NEW_DEFAULT_CATEGORY [1/2]

#define XBT_LOG_NEW_DEFAULT_CATEGORY (   cname,
  desc 
)
Value:
XBT_LOG_DEFAULT_CATEGORY(cname)
std::string desc
Definition: config.cpp:143
#define XBT_LOG_NEW_CATEGORY(catName, desc)
Definition: log.h:167
Parameters
cnamename of the cat
descstring describing the purpose of this category

Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly specify a category).

Examples:
examples/msg/actions-comm/actions-comm.c, examples/msg/actions-storage/actions-storage.c, examples/msg/app-masterworker/app-masterworker.c, examples/msg/app-pingpong/app-pingpong.c, examples/msg/app-token-ring/app-token-ring.c, examples/msg/async-wait/async-wait.c, examples/msg/async-waitall/async-waitall.c, examples/msg/async-waitany/async-waitany.c, examples/msg/dht-chord/dht-chord.c, examples/msg/io-file/io-file.c, examples/msg/io-remote/io-remote.c, examples/msg/io-storage/io-storage.c, examples/msg/network-ns3/network-ns3.c, examples/msg/platform-properties/platform-properties.c, examples/msg/process-kill/process-kill.c, examples/msg/process-migration/process-migration.c, examples/msg/process-startkilltime/process-startkilltime.c, examples/msg/process-suspend/process-suspend.c, examples/msg/task-priority/task-priority.c, examples/msg/trace-host-user-variables/trace-host-user-variables.c, examples/msg/trace-masterworker/trace-masterworker.c, examples/s4u/actions-comm/s4u_actions-comm.cpp, examples/s4u/actions-storage/s4u_actions-storage.cpp, examples/s4u/actor-create/s4u_actor-create.cpp, examples/s4u/actor-kill/s4u_actor-kill.cpp, examples/s4u/actor-migration/s4u_actor-migration.cpp, examples/s4u/actor-suspend/s4u_actor-suspend.cpp, examples/s4u/app-masterworker/s4u_app-masterworker.cpp, examples/s4u/app-token-ring/s4u_app-token-ring.cpp, and examples/s4u/mutex/s4u_mutex.cpp.

◆ XBT_LOG_NEW_DEFAULT_SUBCATEGORY [1/2]

#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY (   cname,
  parent,
  desc 
)
Value:
XBT_LOG_DEFAULT_CATEGORY(cname)
std::string desc
Definition: config.cpp:143
#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)
Definition: log.h:155
int int errorclass int flag void baseptr void int MPI_Datatype void int int MPI_Datatype int MPI_Comm comm MPI_Status MPI_Datatype int count char int resultlen void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void void MPI_Datatype int MPI_Aint MPI_Op MPI_Win win MPI_Group MPI_Group MPI_Group newgroup MPI_Group group MPI_Group MPI_Group MPI_Group newgroup MPI_Group int int MPI_Group newgroup MPI_Group int size MPI_Group MPI_Group MPI_Group newgroup MPI_Info char key MPI_Info info MPI_Info int nkeys MPI_Info char int int flag int flag int char int int provided void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Request request MPI_Copy_function MPI_Delete_function int void extra_state MPI_User_function int MPI_Op op MPI_Op int commute void int MPI_Datatype void int int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Op MPI_Win MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Status status void void int MPI_Datatype MPI_Op MPI_Comm comm void void int MPI_Datatype MPI_Op int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype void int MPI_Datatype int MPI_Comm comm void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int void int MPI_Datatype int int MPI_Comm MPI_Status status void int MPI_Datatype int int MPI_Comm MPI_Request request int MPI_Request requests int MPI_Request int MPI_Status statuses MPI_Request int MPI_Status status MPI_Datatype datatype int int MPI_Aint MPI_Datatype MPI_Datatype newtype int int MPI_Aint MPI_Datatype MPI_Datatype new_type int int int MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint MPI_Aint MPI_Datatype newtype MPI_Datatype int type_keyval MPI_Datatype MPI_Aint extent MPI_Datatype datatype MPI_Datatype MPI_Aint MPI_Aint extent MPI_Datatype MPI_Aint MPI_Aint extent int int MPI_Aint MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint disp MPI_Datatype char name MPI_Datatype MPI_Count size MPI_Datatype MPI_Aint disp void int int void int MPI_Datatype MPI_Comm comm int MPI_Request int MPI_Status status int MPI_Request int int MPI_Status status void MPI_Aint int MPI_Info MPI_Comm MPI_Win win MPI_Win void MPI_Aint size MPI_Info MPI_Comm MPI_Win win MPI_Win win MPI_Win char int len MPI_Group int MPI_Win win MPI_Win MPI_Info info MPI_Win win int MPI_Win win MPI_Win win int MPI_Win win MPI_Win win MPI_Win int void att MPI_Win_copy_attr_function MPI_Win_delete_attr_function int void extra_state MPI_Fint comm MPI_Comm comm MPI_Info info MPI_Request request MPI_Win win MPI_Fint info MPI_Fint request int errorclass int char string void int MPI_Datatype int int MPI_Comm MPI_Request request void int size MPI_Request request char port_name MPI_Comm int errorcode MPI_Comm_errhandler_fn MPI_Errhandler errhandler MPI_Comm MPI_Errhandler errhandler MPI_Comm * parent
Definition: smpi_mpi.cpp:263
Parameters
cnamename of the cat
parentname of the parent
descstring describing the purpose of this category

Creates a new subcategory of the parent category and makes it the default (used by macros that don't explicitly specify a category).

◆ XBT_LOG_EXTERNAL_CATEGORY [1/2]

#define XBT_LOG_EXTERNAL_CATEGORY (   cname)    extern s_xbt_log_category_t _XBT_LOGV(cname)
Parameters
cnamename of the cat

Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file.

◆ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY [1/2]

#define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY (   cname)
Value:
XBT_LOG_DEFAULT_CATEGORY(cname)
#define XBT_LOG_EXTERNAL_CATEGORY(cname)
Definition: log.h:220
Parameters
cnamename of the cat

Indicates that the default category of this file was declared in another file.

◆ XBT_LOG_ISENABLED [1/2]

#define XBT_LOG_ISENABLED (   catName,
  priority 
)    _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
Parameters
catNamename of the category
priorityminimal priority to be enabled to return true (must be e_xbt_log_priority_t)

Returns true if the given priority is enabled for the category. If you have expensive expressions that are computed outside of the log command and used only within it, you should make its evaluation conditional using this macro.

Examples:
examples/msg/actions-comm/actions-comm.c, examples/msg/actions-storage/actions-storage.c, examples/msg/dht-chord/dht-chord.c, examples/s4u/actions-comm/s4u_actions-comm.cpp, and examples/s4u/actions-storage/s4u_actions-storage.cpp.

◆ XBT_CDEBUG [1/2]

#define XBT_CDEBUG (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_debug; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
crufty output
Definition: log.h:45
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355

Log an event at the DEBUG priority on the specified category with these args.

Parameters
categthe category on which to log
...the format string and its arguments

◆ XBT_CVERB [1/2]

#define XBT_CVERB (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_verbose; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
verbose output for the user wanting more
Definition: log.h:46
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355

Log an event at the VERB priority on the specified category with these args.

◆ XBT_CINFO [1/2]

#define XBT_CINFO (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_info; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355
output about the regular functionning
Definition: log.h:47

Log an event at the INFO priority on the specified category with these args.

◆ XBT_CWARN [1/2]

#define XBT_CWARN (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_warning; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
minor issue encountered
Definition: log.h:48
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355

Log an event at the WARN priority on the specified category with these args.

◆ XBT_CERROR [1/2]

#define XBT_CERROR (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_error; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355
issue encountered
Definition: log.h:49

Log an event at the ERROR priority on the specified category with these args.

◆ XBT_CCRITICAL [1/2]

#define XBT_CCRITICAL (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_critical; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355
major issue encountered
Definition: log.h:50

Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10).

◆ XBT_DEBUG [1/2]

#define XBT_DEBUG (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_debug; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
crufty output
Definition: log.h:45

Log an event at the DEBUG priority on the default category with these args.

Parameters
...the format string and its arguments
Examples:
examples/msg/actions-comm/actions-comm.c, examples/msg/dht-chord/dht-chord.c, and examples/msg/network-ns3/network-ns3.c.

◆ XBT_VERB [1/2]

#define XBT_VERB (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_verbose; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
verbose output for the user wanting more
Definition: log.h:46
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365

Log an event at the VERB priority on the default category with these args.

Examples:
examples/msg/actions-comm/actions-comm.c, examples/msg/actions-storage/actions-storage.c, examples/msg/dht-chord/dht-chord.c, examples/s4u/actions-comm/s4u_actions-comm.cpp, and examples/s4u/actions-storage/s4u_actions-storage.cpp.

◆ XBT_INFO [1/2]

#define XBT_INFO (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_info; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
output about the regular functionning
Definition: log.h:47

Log an event at the INFO priority on the default category with these args.

Examples:
examples/msg/actions-comm/actions-comm.c, examples/msg/actions-storage/actions-storage.c, examples/msg/app-masterworker/app-masterworker.c, examples/msg/app-pingpong/app-pingpong.c, examples/msg/app-token-ring/app-token-ring.c, examples/msg/async-wait/async-wait.c, examples/msg/async-waitall/async-waitall.c, examples/msg/async-waitany/async-waitany.c, examples/msg/dht-chord/dht-chord.c, examples/msg/io-file/io-file.c, examples/msg/io-remote/io-remote.c, examples/msg/io-storage/io-storage.c, examples/msg/network-ns3/network-ns3.c, examples/msg/platform-properties/platform-properties.c, examples/msg/process-kill/process-kill.c, examples/msg/process-migration/process-migration.c, examples/msg/process-startkilltime/process-startkilltime.c, examples/msg/process-suspend/process-suspend.c, examples/msg/task-priority/task-priority.c, examples/msg/trace-host-user-variables/trace-host-user-variables.c, examples/msg/trace-masterworker/trace-masterworker.c, examples/s4u/actions-comm/s4u_actions-comm.cpp, examples/s4u/actions-storage/s4u_actions-storage.cpp, examples/s4u/actor-create/s4u_actor-create.cpp, examples/s4u/actor-kill/s4u_actor-kill.cpp, examples/s4u/actor-migration/s4u_actor-migration.cpp, examples/s4u/actor-suspend/s4u_actor-suspend.cpp, examples/s4u/app-masterworker/s4u_app-masterworker.cpp, examples/s4u/app-token-ring/s4u_app-token-ring.cpp, and examples/s4u/mutex/s4u_mutex.cpp.

◆ XBT_WARN [1/2]

#define XBT_WARN (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_warning; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
minor issue encountered
Definition: log.h:48

Log an event at the WARN priority on the default category with these args.

◆ XBT_ERROR [1/2]

#define XBT_ERROR (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_error; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
issue encountered
Definition: log.h:49

Log an event at the ERROR priority on the default category with these args.

◆ XBT_CRITICAL [1/2]

#define XBT_CRITICAL (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_critical; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
major issue encountered
Definition: log.h:50

Log an event at the CRITICAL priority on the default category with these args.

◆ XBT_IN [1/2]

#define XBT_IN (   ...)    _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)

Log at TRACE priority that we entered in current function, appending a user specified format.

◆ XBT_OUT [1/2]

#define XBT_OUT (   ...)    _XBT_IN_OUT("<< end of %s" __VA_ARGS__)

Log at TRACE priority that we exited the current function, appending a user specified format.

◆ XBT_HERE [1/2]

#define XBT_HERE (   ...)    XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)

Log at TRACE priority a message indicating that we reached that point, appending a user specified format.

◆ XBT_LOG_STATIC_THRESHOLD [2/2]

#define XBT_LOG_STATIC_THRESHOLD   xbt_log_priority_none

All logging requests with priority < XBT_LOG_STATIC_THRESHOLD are disabled at compile time, i.e., compiled out.

◆ XBT_LOG_NEW_SUBCATEGORY [2/2]

#define XBT_LOG_NEW_SUBCATEGORY (   catName,
  parent,
  desc 
)
Value:
XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \
std::string desc
Definition: config.cpp:143
int int errorclass int flag void baseptr void int MPI_Datatype void int int MPI_Datatype int MPI_Comm comm MPI_Status MPI_Datatype int count char int resultlen void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void void MPI_Datatype int MPI_Aint MPI_Op MPI_Win win MPI_Group MPI_Group MPI_Group newgroup MPI_Group group MPI_Group MPI_Group MPI_Group newgroup MPI_Group int int MPI_Group newgroup MPI_Group int size MPI_Group MPI_Group MPI_Group newgroup MPI_Info char key MPI_Info info MPI_Info int nkeys MPI_Info char int int flag int flag int char int int provided void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Request request MPI_Copy_function MPI_Delete_function int void extra_state MPI_User_function int MPI_Op op MPI_Op int commute void int MPI_Datatype void int int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Op MPI_Win MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Status status void void int MPI_Datatype MPI_Op MPI_Comm comm void void int MPI_Datatype MPI_Op int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype void int MPI_Datatype int MPI_Comm comm void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int void int MPI_Datatype int int MPI_Comm MPI_Status status void int MPI_Datatype int int MPI_Comm MPI_Request request int MPI_Request requests int MPI_Request int MPI_Status statuses MPI_Request int MPI_Status status MPI_Datatype datatype int int MPI_Aint MPI_Datatype MPI_Datatype newtype int int MPI_Aint MPI_Datatype MPI_Datatype new_type int int int MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint MPI_Aint MPI_Datatype newtype MPI_Datatype int type_keyval MPI_Datatype MPI_Aint extent MPI_Datatype datatype MPI_Datatype MPI_Aint MPI_Aint extent MPI_Datatype MPI_Aint MPI_Aint extent int int MPI_Aint MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint disp MPI_Datatype char name MPI_Datatype MPI_Count size MPI_Datatype MPI_Aint disp void int int void int MPI_Datatype MPI_Comm comm int MPI_Request int MPI_Status status int MPI_Request int int MPI_Status status void MPI_Aint int MPI_Info MPI_Comm MPI_Win win MPI_Win void MPI_Aint size MPI_Info MPI_Comm MPI_Win win MPI_Win win MPI_Win char int len MPI_Group int MPI_Win win MPI_Win MPI_Info info MPI_Win win int MPI_Win win MPI_Win win int MPI_Win win MPI_Win win MPI_Win int void att MPI_Win_copy_attr_function MPI_Win_delete_attr_function int void extra_state MPI_Fint comm MPI_Comm comm MPI_Info info MPI_Request request MPI_Win win MPI_Fint info MPI_Fint request int errorclass int char string void int MPI_Datatype int int MPI_Comm MPI_Request request void int size MPI_Request request char port_name MPI_Comm int errorcode MPI_Comm_errhandler_fn MPI_Errhandler errhandler MPI_Comm MPI_Errhandler errhandler MPI_Comm * parent
Definition: smpi_mpi.cpp:263
#define XBT_LOG_EXTERNAL_CATEGORY(cname)
Definition: log.h:220
Parameters
catNamename of new category
parentfather of the new category in the tree
descstring describing the purpose of this category

Defines a new subcategory of the parent.

◆ XBT_LOG_NEW_CATEGORY [2/2]

#define XBT_LOG_NEW_CATEGORY (   catName,
  desc 
)    XBT_LOG_NEW_SUBCATEGORY_helper(catName, XBT_LOG_ROOT_CAT, desc)
Parameters
catNamename of new category
descstring describing the purpose of this category

Creates a new subcategory of the root category.

◆ XBT_LOG_DEFAULT_CATEGORY [2/2]

#define XBT_LOG_DEFAULT_CATEGORY (   cname)    static xbt_log_category_t _XBT_LOGV(default) XBT_ATTRIB_UNUSED = &_XBT_LOGV(cname)
Parameters
cnamename of the cat

Indicates which category is the default one.

◆ XBT_LOG_NEW_DEFAULT_CATEGORY [2/2]

#define XBT_LOG_NEW_DEFAULT_CATEGORY (   cname,
  desc 
)
Value:
XBT_LOG_DEFAULT_CATEGORY(cname)
std::string desc
Definition: config.cpp:143
#define XBT_LOG_NEW_CATEGORY(catName, desc)
Definition: log.h:167
Parameters
cnamename of the cat
descstring describing the purpose of this category

Creates a new subcategory of the root category and makes it the default (used by macros that don't explicitly specify a category).

◆ XBT_LOG_NEW_DEFAULT_SUBCATEGORY [2/2]

#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY (   cname,
  parent,
  desc 
)
Value:
XBT_LOG_DEFAULT_CATEGORY(cname)
std::string desc
Definition: config.cpp:143
#define XBT_LOG_NEW_SUBCATEGORY(catName, parent, desc)
Definition: log.h:155
int int errorclass int flag void baseptr void int MPI_Datatype void int int MPI_Datatype int MPI_Comm comm MPI_Status MPI_Datatype int count char int resultlen void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void void MPI_Datatype int MPI_Aint MPI_Op MPI_Win win MPI_Group MPI_Group MPI_Group newgroup MPI_Group group MPI_Group MPI_Group MPI_Group newgroup MPI_Group int int MPI_Group newgroup MPI_Group int size MPI_Group MPI_Group MPI_Group newgroup MPI_Info char key MPI_Info info MPI_Info int nkeys MPI_Info char int int flag int flag int char int int provided void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Request request MPI_Copy_function MPI_Delete_function int void extra_state MPI_User_function int MPI_Op op MPI_Op int commute void int MPI_Datatype void int int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win win void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Op MPI_Win MPI_Request request void int MPI_Datatype int int MPI_Comm MPI_Status status void void int MPI_Datatype MPI_Op MPI_Comm comm void void int MPI_Datatype MPI_Op int MPI_Comm comm void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype int MPI_Aint int MPI_Datatype MPI_Win MPI_Request request void int MPI_Datatype void int MPI_Datatype int MPI_Comm comm void int MPI_Datatype int int MPI_Comm MPI_Request request void int MPI_Datatype int int void int MPI_Datatype int int MPI_Comm MPI_Status status void int MPI_Datatype int int MPI_Comm MPI_Request request int MPI_Request requests int MPI_Request int MPI_Status statuses MPI_Request int MPI_Status status MPI_Datatype datatype int int MPI_Aint MPI_Datatype MPI_Datatype newtype int int MPI_Aint MPI_Datatype MPI_Datatype new_type int int int MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint MPI_Aint MPI_Datatype newtype MPI_Datatype int type_keyval MPI_Datatype MPI_Aint extent MPI_Datatype datatype MPI_Datatype MPI_Aint MPI_Aint extent MPI_Datatype MPI_Aint MPI_Aint extent int int MPI_Aint MPI_Datatype MPI_Datatype newtype MPI_Datatype MPI_Aint disp MPI_Datatype char name MPI_Datatype MPI_Count size MPI_Datatype MPI_Aint disp void int int void int MPI_Datatype MPI_Comm comm int MPI_Request int MPI_Status status int MPI_Request int int MPI_Status status void MPI_Aint int MPI_Info MPI_Comm MPI_Win win MPI_Win void MPI_Aint size MPI_Info MPI_Comm MPI_Win win MPI_Win win MPI_Win char int len MPI_Group int MPI_Win win MPI_Win MPI_Info info MPI_Win win int MPI_Win win MPI_Win win int MPI_Win win MPI_Win win MPI_Win int void att MPI_Win_copy_attr_function MPI_Win_delete_attr_function int void extra_state MPI_Fint comm MPI_Comm comm MPI_Info info MPI_Request request MPI_Win win MPI_Fint info MPI_Fint request int errorclass int char string void int MPI_Datatype int int MPI_Comm MPI_Request request void int size MPI_Request request char port_name MPI_Comm int errorcode MPI_Comm_errhandler_fn MPI_Errhandler errhandler MPI_Comm MPI_Errhandler errhandler MPI_Comm * parent
Definition: smpi_mpi.cpp:263
Parameters
cnamename of the cat
parentname of the parent
descstring describing the purpose of this category

Creates a new subcategory of the parent category and makes it the default (used by macros that don't explicitly specify a category).

◆ XBT_LOG_EXTERNAL_CATEGORY [2/2]

#define XBT_LOG_EXTERNAL_CATEGORY (   cname)    extern s_xbt_log_category_t _XBT_LOGV(cname)
Parameters
cnamename of the cat

Indicates that a category you'll use in this file (e.g., to get subcategories of it) really lives in another file.

◆ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY [2/2]

#define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY (   cname)
Value:
XBT_LOG_DEFAULT_CATEGORY(cname)
#define XBT_LOG_EXTERNAL_CATEGORY(cname)
Definition: log.h:220
Parameters
cnamename of the cat

Indicates that the default category of this file was declared in another file.

◆ XBT_LOG_ISENABLED [2/2]

#define XBT_LOG_ISENABLED (   catName,
  priority 
)    _XBT_LOG_ISENABLEDV(_XBT_LOGV(catName), priority)
Parameters
catNamename of the category
priorityminimal priority to be enabled to return true (must be e_xbt_log_priority_t)

Returns true if the given priority is enabled for the category. If you have expensive expressions that are computed outside of the log command and used only within it, you should make its evaluation conditional using this macro.

◆ XBT_CDEBUG [2/2]

#define XBT_CDEBUG (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_debug; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
crufty output
Definition: log.h:45
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355

Log an event at the DEBUG priority on the specified category with these args.

Parameters
categthe category on which to log
...the format string and its arguments

◆ XBT_CVERB [2/2]

#define XBT_CVERB (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_verbose; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
verbose output for the user wanting more
Definition: log.h:46
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355

Log an event at the VERB priority on the specified category with these args.

◆ XBT_CINFO [2/2]

#define XBT_CINFO (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_info; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355
output about the regular functionning
Definition: log.h:47

Log an event at the INFO priority on the specified category with these args.

◆ XBT_CWARN [2/2]

#define XBT_CWARN (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_warning; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
minor issue encountered
Definition: log.h:48
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355

Log an event at the WARN priority on the specified category with these args.

◆ XBT_CERROR [2/2]

#define XBT_CERROR (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_error; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355
issue encountered
Definition: log.h:49

Log an event at the ERROR priority on the specified category with these args.

◆ XBT_CCRITICAL [2/2]

#define XBT_CCRITICAL (   categ,
  ... 
)
Value:
do { \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = &(_XBT_LOGV(categ)); \
_log_ev.priority = xbt_log_priority_critical; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOGV(cat)
Definition: log.h:85
#define XBT_LOG_ISENABLED(catName, priority)
Definition: log.h:355
major issue encountered
Definition: log.h:50

Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10).

◆ XBT_DEBUG [2/2]

#define XBT_DEBUG (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_debug; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
crufty output
Definition: log.h:45

Log an event at the DEBUG priority on the default category with these args.

Parameters
...the format string and its arguments

◆ XBT_VERB [2/2]

#define XBT_VERB (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_verbose; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
verbose output for the user wanting more
Definition: log.h:46
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365

Log an event at the VERB priority on the default category with these args.

◆ XBT_INFO [2/2]

#define XBT_INFO (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_info; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
output about the regular functionning
Definition: log.h:47

Log an event at the INFO priority on the default category with these args.

◆ XBT_WARN [2/2]

#define XBT_WARN (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_warning; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
minor issue encountered
Definition: log.h:48
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365

Log an event at the WARN priority on the default category with these args.

◆ XBT_ERROR [2/2]

#define XBT_ERROR (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_error; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
issue encountered
Definition: log.h:49

Log an event at the ERROR priority on the default category with these args.

◆ XBT_CRITICAL [2/2]

#define XBT_CRITICAL (   ...)
Value:
do { \
if (_XBT_LOG_ISENABLEDV(*_simgrid_log_category__default, \
s_xbt_log_event_t _log_ev; \
_log_ev.cat = _simgrid_log_category__default; \
_log_ev.priority = xbt_log_priority_critical; \
_log_ev.fileName = __FILE__; \
_log_ev.functionName = __func__; \
_log_ev.lineNum = __LINE__; \
_xbt_log_event_log(&_log_ev, __VA_ARGS__); \
} \
} while (0)
#define _XBT_LOG_ISENABLEDV(catv, priority)
Definition: log.h:365
major issue encountered
Definition: log.h:50

Log an event at the CRITICAL priority on the default category with these args.

◆ XBT_IN [2/2]

#define XBT_IN (   ...)    _XBT_IN_OUT(">> begin of %s" __VA_ARGS__)

Log at TRACE priority that we entered in current function, appending a user specified format.

◆ XBT_OUT [2/2]

#define XBT_OUT (   ...)    _XBT_IN_OUT("<< end of %s" __VA_ARGS__)

Log at TRACE priority that we exited the current function, appending a user specified format.

◆ XBT_HERE [2/2]

#define XBT_HERE (   ...)    XBT_LOG(xbt_log_priority_trace, "-- was here" __VA_ARGS__)

Log at TRACE priority a message indicating that we reached that point, appending a user specified format.

Enumeration Type Documentation

◆ e_xbt_log_priority_t [1/2]

Log prioritiesThe different existing priorities.

Enumerator
xbt_log_priority_trace 

enter and return of some functions

xbt_log_priority_debug 

crufty output

xbt_log_priority_verbose 

verbose output for the user wanting more

xbt_log_priority_info 

output about the regular functionning

xbt_log_priority_warning 

minor issue encountered

xbt_log_priority_error 

issue encountered

xbt_log_priority_critical 

major issue encountered

xbt_log_priority_infinite 

value for XBT_LOG_STATIC_THRESHOLD to not log

xbt_log_priority_trace 

enter and return of some functions

xbt_log_priority_debug 

crufty output

xbt_log_priority_verbose 

verbose output for the user wanting more

xbt_log_priority_info 

output about the regular functionning

xbt_log_priority_warning 

minor issue encountered

xbt_log_priority_error 

issue encountered

xbt_log_priority_critical 

major issue encountered

xbt_log_priority_infinite 

value for XBT_LOG_STATIC_THRESHOLD to not log

◆ e_xbt_log_priority_t [2/2]

Log prioritiesThe different existing priorities.

Enumerator
xbt_log_priority_trace 

enter and return of some functions

xbt_log_priority_debug 

crufty output

xbt_log_priority_verbose 

verbose output for the user wanting more

xbt_log_priority_info 

output about the regular functionning

xbt_log_priority_warning 

minor issue encountered

xbt_log_priority_error 

issue encountered

xbt_log_priority_critical 

major issue encountered

xbt_log_priority_infinite 

value for XBT_LOG_STATIC_THRESHOLD to not log

xbt_log_priority_trace 

enter and return of some functions

xbt_log_priority_debug 

crufty output

xbt_log_priority_verbose 

verbose output for the user wanting more

xbt_log_priority_info 

output about the regular functionning

xbt_log_priority_warning 

minor issue encountered

xbt_log_priority_error 

issue encountered

xbt_log_priority_critical 

major issue encountered

xbt_log_priority_infinite 

value for XBT_LOG_STATIC_THRESHOLD to not log

Function Documentation

◆ xbt_log_control_set()

void xbt_log_control_set ( const char *  control_string)
Parameters
control_stringWhat to parse

Typically passed a command-line argument. The string has the syntax:

 ( [category] "." [keyword] ":" value (" ")... )...

where [category] is one the category names (see Existing log categories for a complete list of the ones defined in the SimGrid library) and keyword is one of the following:

  • thres: category's threshold priority. Possible values: TRACE,DEBUG,VERBOSE,INFO,WARNING,ERROR,CRITICAL
  • add or additivity: whether the logging actions must be passed to the parent category. Possible values: 0, 1, no, yes, on, off. Default value: yes.
  • fmt: the format to use. See Format configuration for more information.
  • app or appender: the appender to use. See Category appender for more information.