src/mc/mc_config.cpp

   1 /* Copyright (c) 2008-2022. 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 <simgrid/sg_config.hpp>
   9
  10 #if SIMGRID_HAVE_MC
  11 #include "src/mc/mc_safety.hpp"
  12 #include <string_view>
  13 #endif
  14
  15 #if SIMGRID_HAVE_MC
  16 namespace simgrid::mc {
  17 /* Configuration support */
  18 simgrid::mc::ReductionMode reduction_mode = simgrid::mc::ReductionMode::unset;
  19 } // namespace simgrid::mc
  20 #else
  21 #define _sg_do_model_check 0
  22 #endif
  23
  24 static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
  25 {
  26   xbt_assert(_sg_cfg_init_status == 0 || _sg_do_model_check || not more_check,
  27              "You are specifying a %s after the initialization (through MSG_config?), but the program was not run "
  28              "under the model-checker (with simgrid-mc)). This won't work, sorry.",
  29              spec);
  30 }
  31
  32 /* Replay (this part is enabled even if MC it disabled) */
  33 simgrid::config::Flag<std::string> _sg_mc_record_path{
  34     "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", "",
  35     [](std::string_view value) { MC_record_path() = value; }};
  36
  37 simgrid::config::Flag<bool> _sg_mc_timeout{
  38     "model-check/timeout", "Whether to enable timeouts for wait requests", false, [](bool) {
  39       _mc_cfg_cb_check("value to enable/disable timeout for wait requests", not MC_record_replay_is_active());
  40     }};
  41
  42 #if SIMGRID_HAVE_MC
  43 int _sg_do_model_check = 0;
  44 int _sg_mc_max_visited_states = 0;
  45
  46 simgrid::config::Flag<int> _sg_mc_checkpoint{
  47     "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
  48                               "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
  49                               "step => faster verification, but huge memory consumption; higher values are good "
  50                               "compromises between speed and memory consumption.",
  51     0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
  52
  53 simgrid::config::Flag<std::string> _sg_mc_property_file{
  54     "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
  55     [](const std::string&) { _mc_cfg_cb_check("property"); }};
  56
  57 simgrid::config::Flag<bool> _sg_mc_comms_determinism{
  58     "model-check/communications-determinism",
  59     "Whether to enable the detection of communication determinism",
  60     false,
  61     [](bool) {
  62       _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
  63     }};
  64
  65 simgrid::config::Flag<bool> _sg_mc_send_determinism{
  66     "model-check/send-determinism",
  67     "Enable/disable the detection of send-determinism in the communications schemes",
  68     false,
  69     [](bool) {
  70       _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
  71     }};
  72
  73 simgrid::config::Flag<bool> _sg_mc_unfolding_checker{
  74     "model-check/unfolding-checker",
  75     "Whether to enable the unfolding-based dynamic partial order reduction to MPI programs", false, [](bool) {
  76       _mc_cfg_cb_check("value to to enable/disable the unfolding-based dynamic partial order reduction to MPI programs");
  77     }};
  78
  79 simgrid::config::Flag<std::string> _sg_mc_buffering{
  80     "smpi/buffering",
  81     "Buffering semantic to use for MPI (only used in MC)",
  82     "infty",
  83     {{"zero", "No system buffering: MPI_Send is blocking"},
  84      {"infty", "Infinite system buffering: MPI_Send returns immediately"}},
  85     [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
  86
  87 static simgrid::config::Flag<std::string> _sg_mc_reduce{
  88     "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
  89     [](std::string_view value) {
  90       _mc_cfg_cb_check("reduction strategy");
  91
  92       if (value == "none")
  93         simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::none;
  94       else if (value == "dpor")
  95         simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::dpor;
  96       else
  97         xbt_die("configuration option model-check/reduction can only take 'none' or 'dpor' as a value");
  98     }};
  99
 100 simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
 101                                             "Maximal exploration depth (default: 1000)",
 102                                             1000,
 103                                             [](int) { _mc_cfg_cb_check("max depth value"); }};
 104
 105 static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
 106     "model-check/visited", "Specify the number of visited state stored for state comparison reduction. If value=5, the "
 107                            "last 5 visited states are stored. If value=0 (the default), all states are stored.",
 108     0, [](int value) {
 109       _mc_cfg_cb_check("number of stored visited states");
 110       _sg_mc_max_visited_states = value;
 111     }};
 112
 113 simgrid::config::Flag<std::string> _sg_mc_dot_output_file{
 114     "model-check/dot-output",
 115     "Name of dot output file corresponding to graph state",
 116     "",
 117     [](const std::string&) { _mc_cfg_cb_check("file name for a dot output of graph state"); }};
 118
 119 simgrid::config::Flag<bool> _sg_mc_termination{
 120     "model-check/termination", "Whether to enable non progressive cycle detection", false,
 121     [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
 122
 123 #endif