SimGrid
3.18
Versatile Simulation of Distributed Systems
|
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) |
#define | XBT_LOG_DEFAULT_CATEGORY(cname) |
#define | XBT_LOG_NEW_DEFAULT_CATEGORY(cname, desc) |
#define | XBT_LOG_NEW_DEFAULT_SUBCATEGORY(cname, parent, desc) |
#define | XBT_LOG_EXTERNAL_CATEGORY(cname) |
#define | XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(cname) |
#define | XBT_LOG_ISENABLED(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(...) |
Log at TRACE priority that we entered in current function, appending a user specified format. More... | |
#define | XBT_OUT(...) |
Log at TRACE priority that we exited the current function, appending a user specified format. More... | |
#define | XBT_HERE(...) |
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 } |
Log prioritiesThe different existing priorities. More... | |
Functions | |
void | xbt_log_control_set (const char *control_string) |
#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.
#define XBT_LOG_NEW_SUBCATEGORY | ( | catName, | |
parent, | |||
desc | |||
) |
catName | name of new category |
parent | father of the new category in the tree |
desc | string describing the purpose of this category |
Defines a new subcategory of the parent.
#define XBT_LOG_NEW_CATEGORY | ( | catName, | |
desc | |||
) |
catName | name of new category |
desc | string describing the purpose of this category |
Creates a new subcategory of the root category.
#define XBT_LOG_DEFAULT_CATEGORY | ( | cname | ) |
cname | name of the cat |
Indicates which category is the default one.
#define XBT_LOG_NEW_DEFAULT_CATEGORY | ( | cname, | |
desc | |||
) |
cname | name of the cat |
desc | string 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).
#define XBT_LOG_NEW_DEFAULT_SUBCATEGORY | ( | cname, | |
parent, | |||
desc | |||
) |
cname | name of the cat |
parent | name of the parent |
desc | string 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).
#define XBT_LOG_EXTERNAL_CATEGORY | ( | cname | ) |
cname | name 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.
#define XBT_LOG_EXTERNAL_DEFAULT_CATEGORY | ( | cname | ) |
cname | name of the cat |
Indicates that the default category of this file was declared in another file.
#define XBT_LOG_ISENABLED | ( | catName, | |
priority | |||
) |
catName | name of the category |
priority | minimal 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.
#define XBT_CDEBUG | ( | categ, | |
... | |||
) |
Log an event at the DEBUG priority on the specified category with these args.
categ | the category on which to log |
... | the format string and its arguments |
#define XBT_CVERB | ( | categ, | |
... | |||
) |
Log an event at the VERB priority on the specified category with these args.
#define XBT_CINFO | ( | categ, | |
... | |||
) |
Log an event at the INFO priority on the specified category with these args.
#define XBT_CWARN | ( | categ, | |
... | |||
) |
Log an event at the WARN priority on the specified category with these args.
#define XBT_CERROR | ( | categ, | |
... | |||
) |
Log an event at the ERROR priority on the specified category with these args.
#define XBT_CCRITICAL | ( | categ, | |
... | |||
) |
Log an event at the CRITICAL priority on the specified category with these args (CCRITICALn exists for any n<10).
#define XBT_DEBUG | ( | ... | ) |
Log an event at the DEBUG priority on the default category with these args.
... | the format string and its arguments |
#define XBT_VERB | ( | ... | ) |
Log an event at the VERB priority on the default category with these args.
#define XBT_INFO | ( | ... | ) |
Log an event at the INFO priority on the default category with these args.
#define XBT_WARN | ( | ... | ) |
Log an event at the WARN priority on the default category with these args.
#define XBT_ERROR | ( | ... | ) |
Log an event at the ERROR priority on the default category with these args.
#define XBT_CRITICAL | ( | ... | ) |
Log an event at the CRITICAL priority on the default category with these args.
#define XBT_IN | ( | ... | ) |
Log at TRACE priority that we entered in current function, appending a user specified format.
#define XBT_OUT | ( | ... | ) |
Log at TRACE priority that we exited the current function, appending a user specified format.
#define XBT_HERE | ( | ... | ) |
Log at TRACE priority a message indicating that we reached that point, appending a user specified format.
enum e_xbt_log_priority_t |
Log prioritiesThe different existing priorities.
void xbt_log_control_set | ( | const char * | control_string | ) |
control_string | What 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: