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 <simgrid/modelchecker.h>
   9 #include <simgrid/sg_config.hpp>
  10
  11 #if SIMGRID_HAVE_MC
  12 #include <string_view>
  13 #endif
  14
  15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
  16
  17 bool simgrid::mc::cfg_do_model_check = false;
  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) { MC_record_path() = value; }};
  35
  36 #if SIMGRID_HAVE_MC
  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 int _sg_mc_max_visited_states = 0;
  43
  44 static simgrid::config::Flag<std::string> cfg_mc_reduction{
  45     "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
  46     [](std::string_view value) {
  47       if (value != "none" && value != "dpor")
  48         xbt_die("configuration option 'model-check/reduction' can only take 'none' or 'dpor' as a value");
  49     }};
  50
  51 simgrid::config::Flag<bool> _sg_mc_sleep_set{
  52     "model-check/sleep-set",
  53     "Whether to enable the use of sleep-set in the reduction algorithm",
  54     true,
  55     [](bool) {
  56       _mc_cfg_cb_check("value to enable/disable the use of sleep-set in the reduction algorithm");
  57     }};
  58
  59 simgrid::config::Flag<int> _sg_mc_checkpoint{
  60     "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
  61                               "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
  62                               "step => faster verification, but huge memory consumption; higher values are good "
  63                               "compromises between speed and memory consumption.",
  64     0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
  65
  66 simgrid::config::Flag<std::string> _sg_mc_property_file{
  67     "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
  68     [](const std::string&) { _mc_cfg_cb_check("property"); }};
  69
  70 simgrid::config::Flag<bool> _sg_mc_comms_determinism{
  71     "model-check/communications-determinism",
  72     "Whether to enable the detection of communication determinism",
  73     false,
  74     [](bool) {
  75       _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
  76     }};
  77
  78 simgrid::config::Flag<bool> _sg_mc_send_determinism{
  79     "model-check/send-determinism",
  80     "Enable/disable the detection of send-determinism in the communications schemes",
  81     false,
  82     [](bool) {
  83       _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
  84     }};
  85
  86 simgrid::config::Flag<bool> _sg_mc_unfolding_checker{
  87     "model-check/unfolding-checker",
  88     "Whether to enable the unfolding-based dynamic partial order reduction to MPI programs", false, [](bool) {
  89       _mc_cfg_cb_check("value to to enable/disable the unfolding-based dynamic partial order reduction to MPI programs");
  90     }};
  91
  92 simgrid::config::Flag<std::string> _sg_mc_buffering{
  93     "smpi/buffering",
  94     "Buffering semantic to use for MPI (only used in MC)",
  95     "infty",
  96     {{"zero", "No system buffering: MPI_Send is blocking"},
  97      {"infty", "Infinite system buffering: MPI_Send returns immediately"}},
  98     [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
  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",
 107     "Specify the number of visited state stored for state comparison reduction: any branch leading to a state that is "
 108     "already stored is cut.\n"
 109     "If value=5, the last 5 visited states are stored. If value=0 (the default), no state is stored and this reduction "
 110     "technique is disabled.",
 111     0, [](int value) {
 112       _mc_cfg_cb_check("number of stored visited states");
 113       _sg_mc_max_visited_states = value;
 114     }};
 115
 116 simgrid::config::Flag<std::string> _sg_mc_dot_output_file{
 117     "model-check/dot-output",
 118     "Name of dot output file corresponding to graph state",
 119     "",
 120     [](const std::string&) { _mc_cfg_cb_check("file name for a dot output of graph state"); }};
 121
 122 simgrid::config::Flag<bool> _sg_mc_termination{
 123     "model-check/termination", "Whether to enable non progressive cycle detection", false,
 124     [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
 125
 126 bool simgrid::mc::cfg_use_DPOR()
 127 {
 128   if (cfg_mc_reduction.get() == "dpor" && _sg_mc_max_visited_states__ > 0) {
 129     XBT_INFO("Disabling DPOR since state-equality reduction is activated with 'model-check/visited'");
 130     return false;
 131   }
 132   return cfg_mc_reduction.get() == "dpor";
 133 }
 134
 135 #endif