X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/599347b970dec2ad471021b8eecca62e8f0854e9..40803b27ba5bcb382dfcd593885313a975bafd89:/src/xbt/log.c diff --git a/src/xbt/log.c b/src/xbt/log.c index 23c908ba4a..c560de6d9f 100644 --- a/src/xbt/log.c +++ b/src/xbt/log.c @@ -24,7 +24,6 @@ #include "xbt/dynar.h" #include "xbt/xbt_os_thread.h" -XBT_PUBLIC_DATA(int) (*xbt_pid) (); int xbt_log_no_loc = 0; /* if set to true (with --log=no_loc), file localization will be omitted (for tesh tests) */ static xbt_os_rmutex_t log_cat_init_mutex = NULL; @@ -100,7 +99,7 @@ controlled by the priority concept (which should maybe be renamed to severity). Empirically, the user can specify that he wants to see every debugging message -of GRAS while only being interested into the messages at level "error" or +of MSG while only being interested into the messages at level "error" or higher about the XBT internals. \subsection log_app 1.3 Message appenders @@ -187,7 +186,7 @@ format. This is usually a good idea. Here is an example of the most basic type of macro. This is a logging request with priority warning. -XBT_CLOG(MyCat, gras_log_priority_warning, "Values are: %d and '%s'", 5, +XBT_CLOG(MyCat, xbt_log_priority_warning, "Values are: %d and '%s'", 5, "oops"); A logging request is said to be enabled if its priority is higher than or @@ -256,7 +255,7 @@ XBT_LOG_NEW_CATEGORY(VSS); XBT_LOG_NEW_DEFAULT_SUBCATEGORY(SA, VSS); int main() { - / * Now set the parent's priority. (the string would typcially be a runtime option) * / + / * Now set the parent's priority. (the string would typically be a runtime option) * / xbt_log_control_set("SA.thresh:3"); / * This request is enabled, because WARNING >= INFO. * / @@ -274,9 +273,6 @@ int main() { } \endverbatim -Another example can be found in the relevant part of the GRAS tutorial: -\ref GRAS_tut_tour_logs. - \section log_user 3. User interface \section log_use_conf 3.1 Configuration @@ -284,23 +280,36 @@ Another example can be found in the relevant part of the GRAS tutorial: Although rarely done, it is possible to configure the logs during program initialization by invoking the xbt_log_control_set() method manually. A more conventional way is to use the --log command line -argument. xbt_init() (called by MSG_init(), gras_init() and friends) +argument. xbt_init() (called by MSG_init() and friends) checks and deals properly with such arguments. -The following command line arguments exist, but are deprecated and -may disappear in the future: --xbt-log, --gras-log, --msg-log and ---surf-log. - \subsection log_use_conf_thres 3.1.1 Threshold configuration The most common setting is to control which logging event will get displayed by setting a threshold to each category through the -thres keyword. +threshold keyword. -For example, \verbatim --log=root.thres:debug\endverbatim will make +For example, \verbatim --log=root.threshold:debug\endverbatim will make SimGrid extremely verbose while \verbatim --log=root.thres:critical\endverbatim should shut it almost -completely off. The full list of recognized thresholds is the following: +completely off. + +Note that the threshold keyword can be abbreviated here. For example, +all the following notations have the same result. +\verbatim +--log=root.threshold:debug +--log=root.threshol:debug +--log=root.thresho:debug +--log=root.thresh:debug +--log=root.thres:debug +--log=root.thre:debug +--log=root.thr:debug +--log=root.th:debug +--log=root.t:debug +--log=root.:debug <--- That's obviously really ugly, but it actually works. +\endverbatim + +The full list of recognized thresholds is the following: - trace: enter and return of some functions - debug: crufty output @@ -342,7 +351,7 @@ Here are the existing format directives: - %%p: Priority name (LOG4J compatible) - %%h: Hostname (SimGrid extension) - - %%P: Process name (SimGrid extension) + - %%P: Process name (SimGrid extension -- note that with SMPI this is the integer value of the process rank) - %%t: Thread "name" (LOG4J compatible -- actually the address of the thread in memory) - %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea) @@ -429,10 +438,10 @@ requires an a single comparison of a static variable to a constant. There is also compile time constant, \ref XBT_LOG_STATIC_THRESHOLD, which causes all logging requests with a lower priority to be optimized to 0 cost -by the compiler. By setting it to gras_log_priority_infinite, all logging +by the compiler. By setting it to xbt_log_priority_infinite, all logging requests are statically disabled at compile time and cost nothing. Released executables might be compiled with (note that it will prevent users to debug their problems) -\verbatim-DXBT_LOG_STATIC_THRESHOLD=gras_log_priority_infinite\endverbatim +\verbatim-DXBT_LOG_STATIC_THRESHOLD=xbt_log_priority_infinite\endverbatim Compiling with the \verbatim-DNLOG\endverbatim option disables all logging requests at compilation time while the \verbatim-DNDEBUG\endverbatim disables @@ -507,20 +516,13 @@ const char *xbt_log_priority_names[8] = { s_xbt_log_category_t _XBT_LOGV(XBT_LOG_ROOT_CAT) = { NULL /*parent */ , NULL /* firstChild */ , NULL /* nextSibling */ , - "root", + "root", "The common ancestor for all categories", 0 /*initialized */, xbt_log_priority_uninitialized /* threshold */ , 0 /* isThreshInherited */ , NULL /* appender */ , NULL /* layout */ , 0 /* additivity */ }; -XBT_LOG_NEW_CATEGORY(xbt, "All XBT categories (simgrid toolbox)"); -XBT_LOG_NEW_CATEGORY(surf, "All SURF categories"); -XBT_LOG_NEW_CATEGORY(msg, "All MSG categories"); -XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories"); -XBT_LOG_NEW_CATEGORY(mc, "All MC categories"); -XBT_LOG_NEW_CATEGORY(bindings, "All bindings categories"); - XBT_LOG_NEW_DEFAULT_SUBCATEGORY(log, xbt, "Loggings from the logging mechanism itself"); @@ -535,46 +537,222 @@ void xbt_log_preinit(void) log_cat_init_mutex = xbt_os_rmutex_init(); } +static void xbt_log_connect_categories(void) +{ + /* Connect our log channels: that must be done manually under windows */ + /* Also permit that they are correctly listed by xbt_log_help_categories() */ + + /* xbt */ + XBT_LOG_CONNECT(xbt); + XBT_LOG_CONNECT(graphxml_parse); + XBT_LOG_CONNECT(log); +#if HAVE_MMAP + XBT_LOG_CONNECT(mm_diff); +#endif + XBT_LOG_CONNECT(module); + XBT_LOG_CONNECT(peer); + XBT_LOG_CONNECT(replay); + XBT_LOG_CONNECT(strbuff); + XBT_LOG_CONNECT(xbt_cfg); + XBT_LOG_CONNECT(xbt_dict); + XBT_LOG_CONNECT(xbt_dict_cursor); + XBT_LOG_CONNECT(xbt_dict_elm); +#ifdef XBT_USE_DEPRECATED + XBT_LOG_CONNECT(xbt_dict_multi); +#endif + XBT_LOG_CONNECT(xbt_dyn); + XBT_LOG_CONNECT(xbt_ex); + XBT_LOG_CONNECT(xbt_fifo); + XBT_LOG_CONNECT(xbt_graph); + XBT_LOG_CONNECT(xbt_heap); + XBT_LOG_CONNECT(xbt_lib); + XBT_LOG_CONNECT(xbt_mallocator); + XBT_LOG_CONNECT(xbt_matrix); + XBT_LOG_CONNECT(xbt_parmap); + XBT_LOG_CONNECT(xbt_queue); + XBT_LOG_CONNECT(xbt_set); + XBT_LOG_CONNECT(xbt_sync); + XBT_LOG_CONNECT(xbt_sync_os); + +#ifdef simgrid_EXPORTS + /* The following categories are only defined in libsimgrid */ + + /* bindings */ +#ifdef HAVE_LUA + XBT_LOG_CONNECT(bindings); + XBT_LOG_CONNECT(lua); + XBT_LOG_CONNECT(lua_comm); + XBT_LOG_CONNECT(lua_host); + XBT_LOG_CONNECT(lua_platf); + XBT_LOG_CONNECT(lua_process); + XBT_LOG_CONNECT(lua_state_cloner); + XBT_LOG_CONNECT(lua_task); + XBT_LOG_CONNECT(lua_utils); +#endif + + /* instr */ +#ifdef HAVE_TRACING + XBT_LOG_CONNECT(instr); + XBT_LOG_CONNECT(instr_api); + XBT_LOG_CONNECT(instr_config); + XBT_LOG_CONNECT(instr_msg); + XBT_LOG_CONNECT(instr_msg_process); + XBT_LOG_CONNECT(instr_msg_vm); + XBT_LOG_CONNECT(instr_paje_containers); + XBT_LOG_CONNECT(instr_paje_header); + XBT_LOG_CONNECT(instr_paje_trace); + XBT_LOG_CONNECT(instr_paje_types); + XBT_LOG_CONNECT(instr_paje_values); + XBT_LOG_CONNECT(instr_resource); + XBT_LOG_CONNECT(instr_routing); + XBT_LOG_CONNECT(instr_sd); + XBT_LOG_CONNECT(instr_surf); +#endif + + /* jedule */ +#ifdef HAVE_JEDULE + XBT_LOG_CONNECT(jedule); + XBT_LOG_CONNECT(jed_out); + XBT_LOG_CONNECT(jed_sd); +#endif + + /* mc */ +#ifdef HAVE_MC + XBT_LOG_CONNECT(mc); + XBT_LOG_CONNECT(mc_checkpoint); + XBT_LOG_CONNECT(mc_compare); + XBT_LOG_CONNECT(mc_dpor); + XBT_LOG_CONNECT(mc_global); + XBT_LOG_CONNECT(mc_liveness); + XBT_LOG_CONNECT(mc_memory); + XBT_LOG_CONNECT(mc_memory_map); + XBT_LOG_CONNECT(mc_request); +#endif + + /* msg */ + XBT_LOG_CONNECT(msg); + XBT_LOG_CONNECT(msg_action); + XBT_LOG_CONNECT(msg_gos); + XBT_LOG_CONNECT(msg_io); + XBT_LOG_CONNECT(msg_kernel); + XBT_LOG_CONNECT(msg_mailbox); + XBT_LOG_CONNECT(msg_new_API); + XBT_LOG_CONNECT(msg_process); + XBT_LOG_CONNECT(msg_synchro); + XBT_LOG_CONNECT(msg_task); + XBT_LOG_CONNECT(msg_vm); + + /* simdag */ + XBT_LOG_CONNECT(sd); + XBT_LOG_CONNECT(sd_daxparse); +#ifdef HAVE_GRAPHVIZ + XBT_LOG_CONNECT(sd_dotparse); +#endif + XBT_LOG_CONNECT(sd_kernel); + XBT_LOG_CONNECT(sd_task); + XBT_LOG_CONNECT(sd_workstation); + + /* simix */ + XBT_LOG_CONNECT(simix); + XBT_LOG_CONNECT(simix_context); + XBT_LOG_CONNECT(simix_deployment); + XBT_LOG_CONNECT(simix_environment); + XBT_LOG_CONNECT(simix_host); + XBT_LOG_CONNECT(simix_io); + XBT_LOG_CONNECT(simix_kernel); + XBT_LOG_CONNECT(simix_network); + XBT_LOG_CONNECT(simix_new_api); + XBT_LOG_CONNECT(simix_process); + XBT_LOG_CONNECT(simix_smurf); + XBT_LOG_CONNECT(simix_synchro); + + /* smpi */ + /* SMPI categories are connected in smpi_global.c */ + + /* surf */ + XBT_LOG_CONNECT(surf); + XBT_LOG_CONNECT(platf_generator); + XBT_LOG_CONNECT(random); + XBT_LOG_CONNECT(surf_config); + XBT_LOG_CONNECT(surf_cpu); + XBT_LOG_CONNECT(surf_cpu_ti); + XBT_LOG_CONNECT(surf_kernel); + XBT_LOG_CONNECT(surf_lagrange); + XBT_LOG_CONNECT(surf_lagrange_dichotomy); + XBT_LOG_CONNECT(surf_maxmin); + XBT_LOG_CONNECT(surf_network); + XBT_LOG_CONNECT(surf_new_model); +#ifdef HAVE_GTNETS + XBT_LOG_CONNECT(surf_network_gtnets); + XBT_LOG_CONNECT(surf_network_gtnets_interface); + XBT_LOG_CONNECT(surf_network_gtnets_simulator); + XBT_LOG_CONNECT(surf_network_gtnets_topology); +#endif +#ifdef HAVE_NS3 + XBT_LOG_CONNECT(surf_network_ns3); + XBT_LOG_CONNECT(interface_ns3); + XBT_LOG_CONNECT(simulator_ns3); +#endif + XBT_LOG_CONNECT(surf_parse); + XBT_LOG_CONNECT(surf_route); + XBT_LOG_CONNECT(surf_routing_generic); + XBT_LOG_CONNECT(surf_route_cluster); + XBT_LOG_CONNECT(surf_route_dijkstra); + XBT_LOG_CONNECT(surf_route_floyd); + XBT_LOG_CONNECT(surf_route_full); + XBT_LOG_CONNECT(surf_route_none); + XBT_LOG_CONNECT(surf_route_vivaldi); + XBT_LOG_CONNECT(surf_storage); + XBT_LOG_CONNECT(surf_trace); + XBT_LOG_CONNECT(surf_workstation); + +#endif /* simgrid_EXPORTS */ +} + +static void xbt_log_help(void); +static void xbt_log_help_categories(void); + /** @brief Get all logging settings from the command line * * xbt_log_control_set() is called on each string we got from cmd line */ void xbt_log_init(int *argc, char **argv) { + unsigned help_requested = 0; /* 1: logs; 2: categories */ int i, j; char *opt; // _XBT_LOGV(log).threshold = xbt_log_priority_debug; /* uncomment to set the LOG category to debug directly */ - /* Set logs and init log submodule */ - for (i = 1; i < *argc; i++) { - if (!strncmp(argv[i], "--log=", strlen("--log=")) || - !strncmp(argv[i], "--gras-log=", strlen("--gras-log=")) || - !strncmp(argv[i], "--surf-log=", strlen("--surf-log=")) || - !strncmp(argv[i], "--msg-log=", strlen("--msg-log=")) || - !strncmp(argv[i], "--simix-log=", strlen("--simix-log=")) || - !strncmp(argv[i], "--xbt-log=", strlen("--xbt-log="))) { - - if (strncmp(argv[i], "--log=", strlen("--log="))) - XBT_WARN - ("Option %.*s is deprecated and will disapear in the future. Use --log instead.", - (int) (strchr(argv[i], '=') - argv[i]), argv[i]); + xbt_log_connect_categories(); + /* Set logs and init log submodule */ + for (j = i = 1; i < *argc; i++) { + if (!strncmp(argv[i], "--log=", strlen("--log="))) { opt = strchr(argv[i], '='); opt++; xbt_log_control_set(opt); XBT_DEBUG("Did apply '%s' as log setting", opt); - /*remove this from argv */ - - for (j = i + 1; j < *argc; j++) { - argv[j - 1] = argv[j]; - } - - argv[j - 1] = NULL; - (*argc)--; - i--; /* compensate effect of next loop incrementation */ + } else if (!strcmp(argv[i], "--help-logs")) { + help_requested |= 1; + } else if (!strcmp(argv[i], "--help-log-categories")) { + help_requested |= 2; + } else { + argv[j++] = argv[i]; } } + if (j < *argc) { + argv[j] = NULL; + *argc = j; + } + + if (help_requested) { + if (help_requested & 1) + xbt_log_help(); + if (help_requested & 2) + xbt_log_help_categories(); + exit(0); + } } static void log_cat_exit(xbt_log_category_t cat) @@ -775,7 +953,7 @@ int _xbt_log_cat_init(xbt_log_category_t category, cpp = cpp->nextSibling; } - XBT_DEBUG("Childs of %s: %s; nextSibling: %s", + XBT_DEBUG("Children of %s: %s; nextSibling: %s", category->parent->name, res, (category->parent->nextSibling ? category->parent->nextSibling->name : "none")); @@ -904,7 +1082,7 @@ static xbt_log_setting_t _xbt_log_parse_setting(const char *control_string) xbt_assert(*dot == '.' && (*eq == '=' || *eq == ':'), "Invalid control string '%s'", control_string); - if (!strncmp(dot + 1, "thresh", (size_t) (eq - dot - 1))) { + if (!strncmp(dot + 1, "threshold", (size_t) (eq - dot - 1))) { int i; char *neweq = xbt_strdup(eq + 1); char *p = neweq - 1; @@ -1108,3 +1286,108 @@ void xbt_log_additivity_set(xbt_log_category_t cat, int additivity) { cat->additivity = additivity; } + +static void xbt_log_help(void) +{ + printf( +"Description of the logging output:\n" +"\n" +" Threshold configuration: --log=CATEGORY_NAME.thres:PRIORITY_LEVEL\n" +" CATEGORY_NAME: defined in code with function 'XBT_LOG_NEW_CATEGORY'\n" +" PRIORITY_LEVEL: the level to print (trace,debug,verbose,info,warning,error,critical)\n" +" -> trace: enter and return of some functions\n" +" -> debug: crufty output\n" +" -> verbose: verbose output for the user wanting more\n" +" -> info: output about the regular functionning\n" +" -> warning: minor issue encountered\n" +" -> error: issue encountered\n" +" -> critical: major issue encountered\n" +"\n" +" Format configuration: --log=CATEGORY_NAME.fmt:OPTIONS\n" +" OPTIONS may be:\n" +" -> %%%%: the %% char\n" +" -> %%n: platform-dependent line separator (LOG4J compatible)\n" +" -> %%e: plain old space (SimGrid extension)\n" +"\n" +" -> %%m: user-provided message\n" +"\n" +" -> %%c: Category name (LOG4J compatible)\n" +" -> %%p: Priority name (LOG4J compatible)\n" +"\n" +" -> %%h: Hostname (SimGrid extension)\n" +" -> %%P: Process name (SimGrid extension)\n" +" -> %%t: Thread \"name\" (LOG4J compatible -- actually the address of the thread in memory)\n" +" -> %%i: Process PID (SimGrid extension -- this is a 'i' as in 'i'dea)\n" +"\n" +" -> %%F: file name where the log event was raised (LOG4J compatible)\n" +" -> %%l: location where the log event was raised (LOG4J compatible, like '%%F:%%L' -- this is a l as in 'l'etter)\n" +" -> %%L: line number where the log event was raised (LOG4J compatible)\n" +" -> %%M: function name (LOG4J compatible -- called method name here of course).\n" +" Defined only when using gcc because there is no __FUNCTION__ elsewhere.\n" +"\n" +" -> %%b: full backtrace (Called %%throwable in LOG4J). Defined only under windows or when using the GNU libc because\n" +" backtrace() is not defined elsewhere, and we only have a fallback for windows boxes, not mac ones for example.\n" +" -> %%B: short backtrace (only the first line of the %%b). Called %%throwable{short} in LOG4J; defined where %%b is.\n" +"\n" +" -> %%d: date (UNIX-like epoch)\n" +" -> %%r: application age (time elapsed since the beginning of the application)\n" +"\n" +" Miscellaneous:\n" +" --help-log-categories Display the current hierarchy of log categories.\n" +" --log=no_loc Don't print file names in messages (for tesh tests).\n" +"\n" + ); +} + +static int xbt_log_cat_cmp(const void *pa, const void *pb) +{ + xbt_log_category_t a = *(xbt_log_category_t *)pa; + xbt_log_category_t b = *(xbt_log_category_t *)pb; + return strcmp(a->name, b->name); +} + +static void xbt_log_help_categories_rec(xbt_log_category_t category, + const char *prefix) +{ + char *this_prefix; + char *child_prefix; + xbt_dynar_t dynar; + unsigned i; + xbt_log_category_t cat; + + if (!category) + return; + + if (category->parent) { + this_prefix = bprintf("%s \\_ ", prefix); + child_prefix = bprintf("%s | ", prefix); + } else { + this_prefix = xbt_strdup(prefix); + child_prefix = xbt_strdup(prefix); + } + + dynar = xbt_dynar_new(sizeof(xbt_log_category_t), NULL); + for (cat = category ; cat != NULL; cat = cat->nextSibling) + xbt_dynar_push_as(dynar, xbt_log_category_t, cat); + + xbt_dynar_sort(dynar, xbt_log_cat_cmp); + + for (i = 0; i < xbt_dynar_length(dynar); i++) { + if (i == xbt_dynar_length(dynar) - 1 && category->parent) + *strrchr(child_prefix, '|') = ' '; + cat = xbt_dynar_get_as(dynar, i, xbt_log_category_t); + printf("%s%s: %s\n", this_prefix, cat->name, cat->description); + xbt_log_help_categories_rec(cat->firstChild, child_prefix); + } + + xbt_dynar_free(&dynar); + xbt_free(this_prefix); + xbt_free(child_prefix); +} + +static void xbt_log_help_categories(void) +{ + printf("Current log category hierarchy:\n"); + xbt_log_help_categories_rec(&_XBT_LOGV(XBT_LOG_ROOT_CAT), " "); + printf("\n"); +}