Add new entry in Release_Notes.

[simgrid.git] / include / xbt / log.h

diff --git a/include/xbt/log.h b/include/xbt/log.h
index 1e6292b..49adae5 100644 (file)
--- a/include/xbt/log.h
+++ b/include/xbt/log.h
@@ -1,6 +1,6 @@
 /* log - a generic logging facility in the spirit of log4j                  */
 
-/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2023. 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. */
@@ -15,7 +15,7 @@
 #include <stdarg.h>
 #include <stddef.h> /* NULL */
 #include <stdio.h>  /* FILE */
-#include <xbt/misc.h>
+#include <xbt/base.h>
 SG_BEGIN_DECL
 /**@brief Log priorities
  * @ingroup XBT_log
@@ -81,9 +81,6 @@ typedef enum {
  * start of main().
  */
 
-/* Asserts that the provided name was not already used for another category */
-void _xbt_log_is_name_unique(const char* name, const char* file, int line);
-
 /* XBT_LOG_NEW_SUBCATEGORY_helper:
  * 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 */
@@ -94,12 +91,9 @@ void _xbt_log_is_name_unique(const char* name, const char* file, int line);
   void _XBT_LOGV_CTOR(catName)(void)                                                                                   \
   {                                                                                                                    \
     XBT_LOG_EXTERNAL_CATEGORY(catName);                                                                                \
-    _xbt_log_is_name_unique(_XBT_STRINGIFY(catName), __FILE__, __LINE__);                                              \
-    if (!_XBT_LOGV(catName).initialized) {                                                                             \
-      _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized);                                          \
-    }                                                                                                                  \
+    (void)_xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized);                                      \
   }                                                                                                                    \
-  XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = {                                                     \
+  s_xbt_log_category_t _XBT_LOGV(catName) = {                                                                          \
       &_XBT_LOGV(parent),                                                                                              \
       NULL /* firstChild */,                                                                                           \
       NULL /* nextSibling */,                                                                                          \
@@ -203,6 +197,22 @@ void _xbt_log_is_name_unique(const char* name, const char* file, int line);
 
 /* 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 */
@@ -291,22 +301,13 @@ 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);
 
-#ifdef DLL_EXPORT
-XBT_PUBLIC_DATA s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
-#else
-// If we `dllexport` the root log category, MinGW does not want us to take its address with the error:
-// > initializer element is not constant
-// When using auto-import, MinGW is happy.
-// We should handle this for non-root log categories as well.
 extern s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT);
-#endif
-
-extern xbt_log_appender_t xbt_log_default_appender;
-extern xbt_log_layout_t xbt_log_default_layout;
 
 /* ********************** */
 /* Public functions again */