Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
There's a nice sg_version(), use it.
[simgrid.git] / src / simgrid / sg_config.cpp
index 86c1a6f..6358b59 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2019. 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. */
@@ -6,19 +6,33 @@
 /* sg_config: configuration infrastructure for the simulation world         */
 
 #include "simgrid/sg_config.hpp"
-#include "instr/instr_interface.hpp"
 #include "simgrid/instr.h"
+#include "src/instr/instr_private.hpp"
 #include "src/internal_config.h"
 #include "src/kernel/lmm/maxmin.hpp"
 #include "src/mc/mc_config.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/surf/surf_interface.hpp"
 #include "surf/surf.hpp"
-#include "xbt/config.h"
 #include "xbt/config.hpp"
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid");
 
+static simgrid::config::Flag<bool> cfg_continue_after_help
+  {"help-nostop", "Do not stop the execution when --help is found", false};
+
+/** @brief Allow other libraries to react to the --help flag, too
+ *
+ * When finding --help on the command line, simgrid usually stops right after displaying its help message.
+ * If you are writing a library using simgrid, you may want to display your own help message before everything stops.
+ * If so, just call this function before having simgrid parsing the command line, and you will be given the control
+ * even if the user is asking for help.
+ */
+void sg_config_continue_after_help()
+{
+  cfg_continue_after_help = true;
+}
+
 /* 0: beginning of time (config cannot be changed yet)
  * 1: initialized: cfg_set created (config can now be changed)
  * 2: configured: command line parsed and config part of platform file was
@@ -28,30 +42,38 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of S
 int _sg_cfg_init_status = 0;
 
 /* instruct the upper layer (simix or simdag) to exit as soon as possible */
-int _sg_cfg_exit_asap = 0;
+bool _sg_cfg_exit_asap = false;
 
-#define sg_cfg_exit_early() do { _sg_cfg_exit_asap = 1; return; } while (0)
+#define sg_cfg_exit_early()                                                                                            \
+  do {                                                                                                                 \
+    _sg_cfg_exit_asap = true;                                                                                          \
+    return;                                                                                                            \
+  } while (0)
 
 /* Parse the command line, looking for options */
 static void sg_config_cmd_line(int *argc, char **argv)
 {
-  int shall_exit = 0;
+  bool shall_exit = false;
   int i;
   int j;
+  bool parse_args = true; // Stop parsing the parameters once we found '--'
 
   for (j = i = 1; i < *argc; i++) {
-    if (not strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
+    if (not strcmp("--", argv[i])) {
+      parse_args = false;
+      // Remove that '--' from the arguments
+    } else if (parse_args && not strncmp(argv[i], "--cfg=", strlen("--cfg="))) {
       char *opt = strchr(argv[i], '=');
       opt++;
 
       simgrid::config::set_parse(opt);
       XBT_DEBUG("Did apply '%s' as config setting", opt);
-    } else if (not strcmp(argv[i], "--version")) {
-      printf("%s\n", SIMGRID_VERSION_STRING);
-      shall_exit = 1;
-    } else if (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help")) {
+    } else if (parse_args && not strcmp(argv[i], "--version")) {
+      sg_version();
+      shall_exit = true;
+    } else if (parse_args && (not strcmp(argv[i], "--cfg-help") || not strcmp(argv[i], "--help"))) {
       printf("Description of the configuration accepted by this simulator:\n");
-      xbt_cfg_help();
+      simgrid::config::help();
       printf(
           "\n"
           "Each of these configurations can be used by adding\n"
@@ -66,13 +88,14 @@ static void sg_config_cmd_line(int *argc, char **argv)
           "   --version to get SimGrid version information.\n"
           "\n"
         );
-      shall_exit = 1;
-    } else if (not strcmp(argv[i], "--help-aliases")) {
+      shall_exit = not cfg_continue_after_help;
+      argv[j++]  = argv[i]; // Preserve the --help in argv just in case someone else wants to see it
+    } else if (parse_args && not strcmp(argv[i], "--help-aliases")) {
       printf("Here is a list of all deprecated option names, with their replacement.\n");
-      xbt_cfg_aliases();
+      simgrid::config::show_aliases();
       printf("Please consider using the recent names\n");
-      shall_exit = 1;
-    } else if (not strcmp(argv[i], "--help-models")) {
+      shall_exit = true;
+    } else if (parse_args && not strcmp(argv[i], "--help-models")) {
       model_help("host", surf_host_model_description);
       printf("\n");
       model_help("CPU", surf_cpu_model_description);
@@ -84,10 +107,10 @@ static void sg_config_cmd_line(int *argc, char **argv)
                surf_optimization_mode_description[k].name,
                surf_optimization_mode_description[k].description);
       printf("Both network and CPU models have 'Lazy' as default optimization level\n\n");
-      shall_exit = 1;
-    } else if (not strcmp(argv[i], "--help-tracing")) {
-      TRACE_help (1);
-      shall_exit = 1;
+      shall_exit = true;
+    } else if (parse_args && not strcmp(argv[i], "--help-tracing")) {
+      TRACE_help();
+      shall_exit = true;
     } else {
       argv[j++] = argv[i];
     }
@@ -296,8 +319,8 @@ void sg_config_init(int *argc, char **argv)
   extern bool _sg_do_verbose_exit;
   simgrid::config::bind_flag(_sg_do_verbose_exit, "verbose-exit", "Activate the \"do nothing\" mode in Ctrl-C");
 
-  simgrid::config::declare_flag<int>("contexts/stack-size", "Stack size of contexts in KiB", 8 * 1024,
-                                     [](int value) { smx_context_stack_size = value * 1024; });
+  simgrid::config::declare_flag<int>("contexts/stack-size", "Stack size of contexts in KiB (not with threads)",
+                                     8 * 1024, [](int value) { smx_context_stack_size = value * 1024; });
   simgrid::config::alias("contexts/stack-size", {"contexts/stack_size"});
 
   /* guard size for contexts stacks in memory pages */
@@ -321,7 +344,7 @@ void sg_config_init(int *argc, char **argv)
   /* synchronization mode for parallel user contexts */
 #if HAVE_FUTEX_H
   std::string default_synchro_mode = "futex";
-#else //No futex on mac and posix is unimplememted yet
+#else // No futex on mac and posix is unimplemented yet
   std::string default_synchro_mode = "busy_wait";
 #endif
   simgrid::config::declare_flag<std::string>("contexts/synchro", "Synchronization mode to use when running contexts in "
@@ -402,6 +425,9 @@ void sg_config_init(int *argc, char **argv)
       default_privatization);
   simgrid::config::alias("smpi/privatization", {"smpi/privatize_global_variables", "smpi/privatize-global-variables"});
 
+  simgrid::config::declare_flag<std::string>(
+      "smpi/privatize-libs", "Add libraries (; separated) to privatize (libgfortran for example). You need to provide the full names of the files (libgfortran.so.4), or its full path", "");
+
   simgrid::config::declare_flag<bool>("smpi/grow-injected-times",
                                       "Whether we want to make the injected time in MPI_Iprobe and MPI_Test grow, to "
                                       "allow faster simulation. This can make simulation less precise, though.",
@@ -442,12 +468,6 @@ void sg_config_init(int *argc, char **argv)
   simgrid::config::declare_flag<std::string>("smpi/reduce", "Which collective to use for reduce", "");
 #endif // HAVE_SMPI
 
-  /* Storage */
-
-  sg_storage_max_file_descriptors = 1024;
-  simgrid::config::bind_flag(sg_storage_max_file_descriptors, "storage/max_file_descriptors",
-                             "Maximum number of concurrently opened files per host. Default is 1024");
-
   /* Others */
 
   simgrid::config::declare_flag<bool>(
@@ -472,6 +492,6 @@ void sg_config_finalize()
   if (not _sg_cfg_init_status)
     return;                     /* Not initialized yet. Nothing to do */
 
-  xbt_cfg_free(&simgrid_config);
+  simgrid::config::finalize();
   _sg_cfg_init_status = 0;
 }