src/mc/mc_config.cpp

   1 /* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/mc/mc_config.hpp"
   7 #include "src/mc/mc_replay.hpp"
   8 #include "src/simgrid/sg_config.hpp"
   9 #include <simgrid/modelchecker.h>
  10
  11 #if SIMGRID_HAVE_MC
  12 #include <string_view>
  13 #endif
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
  16
  17 simgrid::mc::ModelCheckingMode simgrid::mc::model_checking_mode = simgrid::mc::ModelCheckingMode::NONE;
  18
  19 static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
  20 {
  21 #if SIMGRID_HAVE_MC
  22   xbt_assert(_sg_cfg_init_status == 0 || MC_is_active() || MC_record_replay_is_active() || not more_check,
  23              "Specifying a %s is only allowed within the model-checker. Please use simgrid-mc, or specify this option "
  24              "after the replay path.",
  25              spec);
  26 #else
  27   xbt_die("Specifying a %s is only allowed within the model-checker. Please enable it before the compilation.", spec);
  28 #endif
  29 }
  30
  31 /* Replay (this part is enabled even if MC it disabled) */
  32 simgrid::config::Flag<std::string> _sg_mc_record_path{
  33     "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", "",
  34     [](std::string_view value) {
  35       xbt_assert(simgrid::mc::model_checking_mode == simgrid::mc::ModelCheckingMode::NONE ||
  36                      simgrid::mc::model_checking_mode == simgrid::mc::ModelCheckingMode::REPLAY,
  37                  "Specifying a MC replay path is not allowed when running the model-checker in mode %s. "
  38                  "Either remove the model-check/replay parameter, or execute your code out of simgrid-mc.",
  39                  to_c_str(simgrid::mc::model_checking_mode));
  40       simgrid::mc::model_checking_mode = simgrid::mc::ModelCheckingMode::REPLAY;
  41       MC_record_path()                 = value;
  42     }};
  43
  44 #if SIMGRID_HAVE_MC
  45 simgrid::config::Flag<bool> _sg_mc_timeout{
  46     "model-check/timeout", "Whether to enable timeouts for wait requests", false, [](bool) {
  47       _mc_cfg_cb_check("value to enable/disable timeout for wait requests", not MC_record_replay_is_active());
  48     }};
  49
  50 int _sg_mc_max_visited_states = 0;
  51
  52 static simgrid::config::Flag<std::string> cfg_mc_reduction{
  53     "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
  54     [](std::string_view value) {
  55       if (value != "none" && value != "dpor")
  56         xbt_die("configuration option 'model-check/reduction' can only take 'none' or 'dpor' as a value");
  57     }};
  58
  59 simgrid::config::Flag<bool> _sg_mc_sleep_set{
  60     "model-check/sleep-set", "Whether to enable the use of sleep-set in the reduction algorithm", false,
  61     [](bool) { _mc_cfg_cb_check("value to enable/disable the use of sleep-set in the reduction algorithm"); }};
  62
  63 simgrid::config::Flag<std::string> _sg_mc_guided{
  64     "model-check/guided-mc", "Specify the the kind of heuristic to use for guided model-checking", "none",
  65     [](std::string_view value) {
  66       if (value != "none" && value != "nb_wait")
  67         xbt_die("configuration option 'model-check/guided-mc' can only take 'none' or 'nb_wait' as a value");
  68     }};
  69
  70
  71 simgrid::config::Flag<int> _sg_mc_checkpoint{
  72     "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
  73                               "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
  74                               "step => faster verification, but huge memory consumption; higher values are good "
  75                               "compromises between speed and memory consumption.",
  76     0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
  77
  78 simgrid::config::Flag<std::string> _sg_mc_property_file{
  79     "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
  80     [](const std::string&) { _mc_cfg_cb_check("property"); }};
  81
  82 simgrid::config::Flag<bool> _sg_mc_comms_determinism{
  83     "model-check/communications-determinism",
  84     "Whether to enable the detection of communication determinism",
  85     false,
  86     [](bool) {
  87       _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
  88     }};
  89
  90 simgrid::config::Flag<bool> _sg_mc_send_determinism{
  91     "model-check/send-determinism",
  92     "Enable/disable the detection of send-determinism in the communications schemes",
  93     false,
  94     [](bool) {
  95       _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
  96     }};
  97
  98 simgrid::config::Flag<bool> _sg_mc_unfolding_checker{
  99     "model-check/unfolding-checker",
 100     "Whether to enable the unfolding-based dynamic partial order reduction to MPI programs", false, [](bool) {
 101       _mc_cfg_cb_check("value to to enable/disable the unfolding-based dynamic partial order reduction to MPI programs");
 102     }};
 103
 104 simgrid::config::Flag<std::string> _sg_mc_buffering{
 105     "smpi/buffering",
 106     "Buffering semantic to use for MPI (only used in MC)",
 107     "infty",
 108     {{"zero", "No system buffering: MPI_Send is blocking"},
 109      {"infty", "Infinite system buffering: MPI_Send returns immediately"}},
 110     [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
 111
 112 simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
 113                                             "Maximal exploration depth (default: 1000)",
 114                                             1000,
 115                                             [](int) { _mc_cfg_cb_check("max depth value"); }};
 116
 117 static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
 118     "model-check/visited",
 119     "Specify the number of visited state stored for state comparison reduction: any branch leading to a state that is "
 120     "already stored is cut.\n"
 121     "If value=5, the last 5 visited states are stored. If value=0 (the default), no state is stored and this reduction "
 122     "technique is disabled.",
 123     0, [](int value) {
 124       _mc_cfg_cb_check("number of stored visited states");
 125       _sg_mc_max_visited_states = value;
 126     }};
 127
 128 simgrid::config::Flag<bool> _sg_mc_termination{
 129     "model-check/termination", "Whether to enable non progressive cycle detection", false,
 130     [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
 131
 132 bool simgrid::mc::cfg_use_DPOR()
 133 {
 134   if (cfg_mc_reduction.get() == "dpor" && _sg_mc_max_visited_states__ > 0) {
 135     XBT_INFO("Disabling DPOR since state-equality reduction is activated with 'model-check/visited'");
 136     return false;
 137   }
 138   return cfg_mc_reduction.get() == "dpor";
 139 }
 140
 141 #endif