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 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
  11
  12 #if SIMGRID_HAVE_MC
  13 #include <string_view>
  14
  15 #else
  16 #define _sg_do_model_check 0
  17 #endif
  18
  19 static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
  20 {
  21   xbt_assert(_sg_cfg_init_status == 0 || _sg_do_model_check || not more_check,
  22              "Specifying a %s is only allowed within the model-checker. Please use simgrid-mc.", spec);
  23 }
  24
  25 /* Replay (this part is enabled even if MC it disabled) */
  26 simgrid::config::Flag<std::string> _sg_mc_record_path{
  27     "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", "",
  28     [](std::string_view value) { MC_record_path() = value; }};
  29
  30 simgrid::config::Flag<bool> _sg_mc_timeout{
  31     "model-check/timeout", "Whether to enable timeouts for wait requests", false, [](bool) {
  32       _mc_cfg_cb_check("value to enable/disable timeout for wait requests", not MC_record_replay_is_active());
  33     }};
  34
  35 #if SIMGRID_HAVE_MC
  36 int _sg_do_model_check = 0;
  37 int _sg_mc_max_visited_states = 0;
  38
  39 static simgrid::config::Flag<std::string> cfg_mc_reduction{
  40     "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
  41     [](std::string_view value) {
  42       if (value != "none" && value != "dpor")
  43         xbt_die("configuration option 'model-check/reduction' can only take 'none' or 'dpor' as a value");
  44     }};
  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 simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
  88                                             "Maximal exploration depth (default: 1000)",
  89                                             1000,
  90                                             [](int) { _mc_cfg_cb_check("max depth value"); }};
  91
  92 static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
  93     "model-check/visited",
  94     "Specify the number of visited state stored for state comparison reduction: any branch leading to a state that is "
  95     "already stored is cut.\n"
  96     "If value=5, the last 5 visited states are stored. If value=0 (the default), no state is stored and this reduction "
  97     "technique is disabled.",
  98     0, [](int value) {
  99       _mc_cfg_cb_check("number of stored visited states");
 100       _sg_mc_max_visited_states = value;
 101     }};
 102
 103 simgrid::config::Flag<std::string> _sg_mc_dot_output_file{
 104     "model-check/dot-output",
 105     "Name of dot output file corresponding to graph state",
 106     "",
 107     [](const std::string&) { _mc_cfg_cb_check("file name for a dot output of graph state"); }};
 108
 109 simgrid::config::Flag<bool> _sg_mc_termination{
 110     "model-check/termination", "Whether to enable non progressive cycle detection", false,
 111     [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
 112
 113 bool simgrid::mc::cfg_use_DPOR()
 114 {
 115   if (cfg_mc_reduction.get() == "dpor" && _sg_mc_max_visited_states__ > 0) {
 116     XBT_INFO("Disabling DPOR since state-equality reduction is activated with 'model-check/visited'");
 117     return false;
 118   }
 119   return cfg_mc_reduction.get() == "dpor";
 120 }
 121
 122 #endif