Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove the need of pthread_mutex in mmalloc, to allow its use with sthread
[simgrid.git] / src / simgrid / sg_config.cpp
index 813dce8..10d160a 100644 (file)
@@ -1,22 +1,26 @@
-/* Copyright (c) 2009-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2022. 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. */
 
 /* sg_config: configuration infrastructure for the simulation world         */
 
+#include <simgrid/instr.h>
+#include <simgrid/version.h>
+#include <xbt/config.hpp>
+
 #include "simgrid/sg_config.hpp"
-#include "simgrid/instr.h"
-#include "simgrid/version.h"
+#include "src/include/xbt/mmalloc.h"
 #include "src/instr/instr_private.hpp"
 #include "src/internal_config.h"
+#include "src/kernel/context/Context.hpp"
 #include "src/kernel/lmm/maxmin.hpp"
 #include "src/mc/mc_config.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/smpi/include/smpi_config.hpp"
 #include "src/surf/surf_interface.hpp"
-#include "surf/surf.hpp"
-#include "xbt/config.hpp"
+
+#include <string_view>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(surf_config, surf, "About the configuration of SimGrid");
 
@@ -122,12 +126,12 @@ static void _sg_cfg_cb__plugin(const std::string& value)
     return;
 
   if (value == "help") {
-    model_help("plugin", *surf_plugin_description);
+    model_help("plugin", surf_plugin_description());
     exit(0);
   }
 
-  int plugin_id = find_model_description(*surf_plugin_description, value);
-  (*surf_plugin_description)[plugin_id].model_init_preparse();
+  const auto* plugin = find_model_description(surf_plugin_description(), value);
+  plugin->model_init_preparse();
 }
 
 /* callback of the host/model variable */
@@ -184,19 +188,6 @@ static void _sg_cfg_cb__disk_model(const std::string& value)
   find_model_description(surf_disk_model_description, value);
 }
 
-/* callback of the cpu/model variable */
-static void _sg_cfg_cb__storage_model(const std::string& value)
-{
-  xbt_assert(_sg_cfg_init_status < 2, "Cannot change the model after the initialization");
-
-  if (value == "help") {
-    model_help("storage", surf_storage_model_description);
-    exit(0);
-  }
-
-  find_model_description(surf_storage_model_description, value);
-}
-
 /* callback of the network_model variable */
 static void _sg_cfg_cb__network_model(const std::string& value)
 {
@@ -211,14 +202,14 @@ static void _sg_cfg_cb__network_model(const std::string& value)
   find_model_description(surf_network_model_description, value);
 }
 
-static void _sg_cfg_cb_contexts_parallel_mode(const std::string& mode_name)
+static void _sg_cfg_cb_contexts_parallel_mode(std::string_view mode_name)
 {
   if (mode_name == "posix") {
-    SIMIX_context_set_parallel_mode(XBT_PARMAP_POSIX);
+    simgrid::kernel::context::set_parallel_mode(XBT_PARMAP_POSIX);
   } else if (mode_name == "futex") {
-    SIMIX_context_set_parallel_mode(XBT_PARMAP_FUTEX);
+    simgrid::kernel::context::set_parallel_mode(XBT_PARMAP_FUTEX);
   } else if (mode_name == "busy_wait") {
-    SIMIX_context_set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
+    simgrid::kernel::context::set_parallel_mode(XBT_PARMAP_BUSY_WAIT);
   } else {
     xbt_die("Command line setting of the parallel synchronization mode should "
             "be one of \"posix\", \"futex\" or \"busy_wait\"");
@@ -251,7 +242,7 @@ void sg_config_init(int *argc, char **argv)
   }
 
   /* Plugins configuration */
-  declare_model_flag("plugin", "", &_sg_cfg_cb__plugin, *surf_plugin_description, "plugin", "The plugins");
+  declare_model_flag("plugin", "", &_sg_cfg_cb__plugin, surf_plugin_description(), "plugin", "The plugins");
 
   declare_model_flag("cpu/model", "Cas01", &_sg_cfg_cb__cpu_model, surf_cpu_model_description, "model",
                      "The model to use for the CPU");
@@ -259,9 +250,6 @@ void sg_config_init(int *argc, char **argv)
   declare_model_flag("disk/model", "default", &_sg_cfg_cb__disk_model, surf_disk_model_description, "model",
                      "The model to use for the disk");
 
-  declare_model_flag("storage/model", "default", &_sg_cfg_cb__storage_model, surf_storage_model_description, "model",
-                     "The model to use for the storage");
-
   declare_model_flag("network/model", "LV08", &_sg_cfg_cb__network_model, surf_network_model_description, "model",
                      "The model to use for the network");
 
@@ -277,57 +265,59 @@ void sg_config_init(int *argc, char **argv)
   simgrid::config::bind_flag(sg_maxmin_precision, "maxmin/precision",
                              "Numerical precision used when computing resource sharing (in flops/sec or bytes/sec)");
 
-  simgrid::config::bind_flag(sg_concurrency_limit, "maxmin/concurrency-limit", {"maxmin/concurrency_limit"},
+  simgrid::config::bind_flag(sg_concurrency_limit, "maxmin/concurrency-limit",
                              "Maximum number of concurrent variables in the maxmim system. Also limits the number of "
                              "processes on each host, at higher level. (default: -1 means no such limitation)");
 
   /* The parameters of network models */
 
   sg_latency_factor = 13.01; // comes from the default LV08 network model
-  simgrid::config::bind_flag(sg_latency_factor, "network/latency-factor", {"network/latency_factor"},
+  simgrid::config::bind_flag(sg_latency_factor, "network/latency-factor",
                              "Correction factor to apply to the provided latency (default value set by network model)");
 
   sg_bandwidth_factor = 0.97; // comes from the default LV08 network model
   simgrid::config::bind_flag(
-      sg_bandwidth_factor, "network/bandwidth-factor", {"network/bandwidth_factor"},
+      sg_bandwidth_factor, "network/bandwidth-factor",
       "Correction factor to apply to the provided bandwidth (default value set by network model)");
 
   sg_weight_S_parameter = 20537; // comes from the default LV08 network model
   simgrid::config::bind_flag(
-      sg_weight_S_parameter, "network/weight-S", {"network/weight_S"},
+      sg_weight_S_parameter, "network/weight-S",
       "Correction factor to apply to the weight of competing streams (default value set by network model)");
 
-  simgrid::config::declare_flag<double>("network/loopback-lat",
-                                      "For network models with an implicit loopback link (L07, CM02, LV08), "
-                                      "latency of the loopback link. 0 by default",
-                                      0);
+  static simgrid::config::Flag<double> _sg_network_loopback_latency{
+      "network/loopback-lat",
+      "For network models with an implicit loopback link (L07, CM02, LV08), "
+      "latency of the loopback link. 0 by default",
+      0.0};
 
-  simgrid::config::declare_flag<double>("network/loopback-bw",
-                                      "For network models with an implicit loopback link (L07, CM02, LV08), "
-                                      "bandwidth of the loopback link. 10GBps by default",
-                                      10e9);
+  static simgrid::config::Flag<double> _sg_network_loopback_bandwidth{
+      "network/loopback-bw",
+      "For network models with an implicit loopback link (L07, CM02, LV08), "
+      "bandwidth of the loopback link. 10GBps by default",
+      10e9};
 
   /* Inclusion path */
-  simgrid::config::declare_flag<std::string>("path", "Lookup path for inclusions in platform and deployment XML files",
-                                             "", [](std::string const& path) {
-                                               if (not path.empty())
-                                                 surf_path.push_back(path);
-                                             });
-
-  simgrid::config::declare_flag<bool>("cpu/maxmin-selective-update",
-                                      "Update the constraint set propagating recursively to others constraints "
-                                      "(off by default unless optim is set to lazy)",
-                                      "no");
-  simgrid::config::alias("cpu/maxmin-selective-update", {"cpu/maxmin_selective_update"});
-  simgrid::config::declare_flag<bool>("network/maxmin-selective-update", "Update the constraint set propagating "
+  static simgrid::config::Flag<std::string> cfg_path{
+      "path", "Lookup path for inclusions in platform and deployment XML files", "", [](std::string const& path) {
+        if (not path.empty())
+          surf_path.push_back(path);
+      }};
+
+  static simgrid::config::Flag<bool> cfg_cpu_maxmin_selective_update{
+      "cpu/maxmin-selective-update",
+      "Update the constraint set propagating recursively to others constraints "
+      "(off by default unless optim is set to lazy)",
+      false};
+  static simgrid::config::Flag<bool> cfg_network_maxmin_selective_update{"network/maxmin-selective-update",
+                                                                         "Update the constraint set propagating "
                                                                          "recursively to others constraints (off by "
                                                                          "default unless optim is set to lazy)",
-                                      "no");
-  simgrid::config::alias("network/maxmin-selective-update", {"network/maxmin_selective_update"});
+                                                                         false};
 
-  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"});
+  static simgrid::config::Flag<int> cfg_context_stack_size{
+      "contexts/stack-size", "Stack size of contexts in KiB (not with threads)", 8 * 1024,
+      [](int value) { simgrid::kernel::context::stack_size = value * 1024; }};
 
   /* guard size for contexts stacks in memory pages */
 #if defined(_WIN32) || (PTH_STACKGROWTH != -1)
@@ -335,12 +325,20 @@ void sg_config_init(int *argc, char **argv)
 #else
   int default_guard_size = 1;
 #endif
-  simgrid::config::declare_flag<int>("contexts/guard-size", "Guard size for contexts stacks in memory pages",
-                                     default_guard_size,
-                                     [](int value) { smx_context_guard_size = value * xbt_pagesize; });
-  simgrid::config::alias("contexts/guard-size", {"contexts/guard_size"});
-  simgrid::config::declare_flag<int>("contexts/nthreads", "Number of parallel threads used to execute user contexts", 1,
-                                     &SIMIX_context_set_nthreads);
+  static simgrid::config::Flag<int> cfg_context_guard_size{
+      "contexts/guard-size", "Guard size for contexts stacks in memory pages", default_guard_size,
+      [](int value) { simgrid::kernel::context::guard_size = value * xbt_pagesize; }};
+
+  static simgrid::config::Flag<int> cfg_context_nthreads{
+      "contexts/nthreads", "Number of parallel threads used to execute user contexts", 1, [](int nthreads) {
+#if HAVE_MMALLOC
+        xbt_assert(
+            nthreads == 1 || !malloc_use_mmalloc(),
+            "Parallel simulation is forbidden in the verified program, as there is no protection against race "
+            "conditions in mmalloc itself. Please don't be so greedy and show some mercy for our implementation.");
+#endif
+        simgrid::kernel::context::set_nthreads(nthreads);
+      }};
 
   /* synchronization mode for parallel user contexts */
 #if HAVE_FUTEX_H
@@ -348,9 +346,11 @@ void sg_config_init(int *argc, char **argv)
 #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 "
-                                                                 "parallel (either futex, posix or busy_wait)",
-                                             default_synchro_mode, &_sg_cfg_cb_contexts_parallel_mode);
+  static simgrid::config::Flag<std::string> cfg_context_synchro{"contexts/synchro",
+                                                                "Synchronization mode to use when running contexts in "
+                                                                "parallel (either futex, posix or busy_wait)",
+                                                                default_synchro_mode,
+                                                                &_sg_cfg_cb_contexts_parallel_mode};
 
   // For smpi/bw-factor and smpi/lat-factor
   // SMPI model can be used without enable_smpi, so keep this out of the ifdef.
@@ -360,21 +360,19 @@ void sg_config_init(int *argc, char **argv)
                                              "meaning if(size >=thresholdN ) return valueN.",
                                              "65472:0.940694;15424:0.697866;9376:0.58729;5776:1.08739;3484:0.77493;"
                                              "1426:0.608902;732:0.341987;257:0.338112;0:0.812084");
-  simgrid::config::alias("smpi/bw-factor", {"smpi/bw_factor"});
 
   simgrid::config::declare_flag<std::string>("smpi/lat-factor", "Latency factors for smpi.",
                                              "65472:11.6436;15424:3.48845;9376:2.59299;5776:2.18796;3484:1.88101;"
                                              "1426:1.61075;732:1.9503;257:1.95341;0:2.01467");
-  simgrid::config::alias("smpi/lat-factor", {"smpi/lat_factor"});
-  simgrid::config::declare_flag<std::string>("smpi/IB-penalty-factors",
-                                             "Correction factor to communications using Infiniband model with "
-                                             "contention (default value based on Stampede cluster profiling)",
-                                             "0.965;0.925;1.35");
-  simgrid::config::alias("smpi/IB-penalty-factors", {"smpi/IB_penalty_factors"});
+  static simgrid::config::Flag<std::string> cfg_smpi_IB_penalty_factors{
+      "smpi/IB-penalty-factors",
+      "Correction factor to communications using Infiniband model with "
+      "contention (default value based on Stampede cluster profiling)",
+      "0.965;0.925;1.35"};
   /* Others */
 
-  simgrid::config::declare_flag<bool>(
-      "exception/cutpath", "Whether to cut all path information from call traces, used e.g. in exceptions.", false);
+  static simgrid::config::Flag<bool> cfg_execution_cutpath{
+      "exception/cutpath", "Whether to cut all path information from call traces, used e.g. in exceptions.", false};
 
   if (surf_path.empty())
     simgrid::config::set_default<std::string>("path", "./");
@@ -383,7 +381,7 @@ void sg_config_init(int *argc, char **argv)
 
   sg_config_cmd_line(argc, argv);
 
-  xbt_mallocator_initialization_is_done(SIMIX_context_is_parallel());
+  xbt_mallocator_initialization_is_done(simgrid::kernel::context::is_parallel());
 }
 
 void sg_config_finalize()