X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/fe9f13ea487593ec11c6af50d8150a6743c84114..e71a2a302d28430dc1bfee906f842f5f3d0fa3ce:/include/xbt/log.h diff --git a/include/xbt/log.h b/include/xbt/log.h index 1df2b5c3b3..32215d227e 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -1,29 +1,12 @@ /* log - a generic logging facility in the spirit of log4j */ -/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved. */ /* This program is free software; you can redistribute it and/or modify it * under the terms of the license (GNU LGPL) which comes with this package. */ -/** @addtogroup XBT_log - * @brief A generic logging facility in the spirit of log4j (grounding feature) - * - */ - -/** @defgroup XBT_log_cats Existing log categories - * @ingroup XBT_log - * @brief (automatically extracted) - * - * This is the list of all existing log categories in SimGrid. - * This list is automatically extracted from the source code by the tools/doxygen/xbt_log_extract_hierarchy.pl utility. - * - * It should thus contain every categories that are defined in the SimGrid library. - * If you want to see the one defined in your code in addition, provide `--help-logs` on the command line of your - * simulator. - */ - -/* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic - printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */ +/* Define the XBT_LOG_MAYDAY symbol to change all logging facilities into basic printfs, e.g. to debug the logs + * themselves. */ //#define XBT_LOG_MAYDAY #ifndef XBT_LOG_H @@ -33,7 +16,7 @@ #include /* NULL */ #include /* FILE */ #include -SG_BEGIN_DECL() +SG_BEGIN_DECL /**@brief Log priorities * @ingroup XBT_log * @@ -46,7 +29,7 @@ typedef enum { xbt_log_priority_trace = 1, /**< enter and return of some functions */ xbt_log_priority_debug = 2, /**< crufty output */ xbt_log_priority_verbose = 3, /**< verbose output for the user wanting more */ - xbt_log_priority_info = 4, /**< output about the regular functionning */ + xbt_log_priority_info = 4, /**< output about the regular functioning */ xbt_log_priority_warning = 5, /**< minor issue encountered */ xbt_log_priority_error = 6, /**< issue encountered */ xbt_log_priority_critical = 7, /**< major issue encountered */ @@ -102,8 +85,9 @@ typedef enum { * Implementation of XBT_LOG_NEW_SUBCATEGORY, which must declare "extern parent" in addition to avoid an extra * declaration of root when XBT_LOG_NEW_SUBCATEGORY is called by XBT_LOG_NEW_CATEGORY */ #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc) \ - SG_BEGIN_DECL() \ + SG_BEGIN_DECL \ extern void _XBT_LOGV_CTOR(catName)(void) XBT_ATTRIB_CONSTRUCTOR(600); \ + SG_END_DECL \ void _XBT_LOGV_CTOR(catName)(void) \ { \ XBT_LOG_EXTERNAL_CATEGORY(catName); \ @@ -111,7 +95,6 @@ typedef enum { _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized); \ } \ } \ - SG_END_DECL() \ XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = { \ &_XBT_LOGV(parent), \ NULL /* firstChild */, \ @@ -216,6 +199,22 @@ typedef enum { /* Functions you may call */ +/** Provide a log setting as if it were passed on the command line. + * + * Expected syntax: + * ( [category] "." [keyword] ":" value (" ")... )... + * + * where [category] is one the category names (see @ref XBT_log_cats for a complete list of the ones defined in the + * SimGrid library) and keyword is one of the following: + * + * - threshold: 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 @ref log_use_conf_fmt for more information. + * - app or appender: the appender to use. See @ref log_use_conf_app for more information. + */ XBT_PUBLIC void xbt_log_control_set(const char* cs); /* Forward declarations */ @@ -260,7 +259,7 @@ struct xbt_log_event_s { * @param cat the category (not only its name, but the variable) * @param thresholdPriority the priority * - * Programatically alters a category's threshold priority (don't use). + * Programmatically alters a category's threshold priority (don't use). */ XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority_t thresholdPriority); @@ -269,7 +268,7 @@ XBT_PUBLIC void xbt_log_threshold_set(xbt_log_category_t cat, e_xbt_log_priority * @param cat the category (not only its name, but the variable) * @param app the appender * - * Programatically sets the category's appender. (the preferred interface is through xbt_log_control_set()) + * Programmatically sets the category's appender. (the preferred interface is through xbt_log_control_set()) */ XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t app); /** @@ -277,7 +276,7 @@ XBT_PUBLIC void xbt_log_appender_set(xbt_log_category_t cat, xbt_log_appender_t * @param cat the category (not only its name, but the variable) * @param lay the layout * - * Programatically sets the category's layout. (the preferred interface is through xbt_log_control_set()) + * Programmatically sets the category's layout. (the preferred interface is through xbt_log_control_set()) */ XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay); @@ -286,7 +285,7 @@ XBT_PUBLIC void xbt_log_layout_set(xbt_log_category_t cat, xbt_log_layout_t lay) * @param cat the category (not only its name, but the variable) * @param additivity whether logging actions must be passed to parent. * - * Programatically sets whether the logging actions must be passed to the parent category. + * Programmatically sets whether the logging actions must be passed to the parent category. * (the preferred interface is through xbt_log_control_set()) */ XBT_PUBLIC void xbt_log_additivity_set(xbt_log_category_t cat, int additivity); @@ -304,6 +303,8 @@ XBT_PUBLIC xbt_log_appender_t xbt_log_appender2_file_new(const char* arg, int ro /* ********************************** */ /* Functions that you shouldn't call */ /* ********************************** */ + +/** Retrieve and parse all log settings from the command line (don't call it directly) */ XBT_PUBLIC void xbt_log_init(int* argc, char** argv); XBT_PUBLIC void _xbt_log_event_log(xbt_log_event_t ev, const char* fmt, ...) XBT_ATTRIB_PRINTF(2, 3); XBT_PUBLIC int _xbt_log_cat_init(xbt_log_category_t category, e_xbt_log_priority_t priority); @@ -492,5 +493,5 @@ extern xbt_log_layout_t xbt_log_default_layout; */ #define XBT_HELP(...) XBT_CINFO(xbt_help, __VA_ARGS__) -SG_END_DECL() -#endif /* ! _XBT_LOG_H_ */ +SG_END_DECL +#endif /* XBT_LOG_H */