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 <string_view>
  12
  13 #else
  14 #define _sg_do_model_check 0
  15 #endif
  16
  17 static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
  18 {
  19   xbt_assert(_sg_cfg_init_status == 0 || _sg_do_model_check || not more_check,
  20              "Specifying a %s is only allowed within the model-checker. Please use simgrid-mc.", spec);
  21 }
  22
  23 /* Replay (this part is enabled even if MC it disabled) */
  24 simgrid::config::Flag<std::string> _sg_mc_record_path{
  25     "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", "",
  26     [](std::string_view value) { MC_record_path() = value; }};
  27
  28 simgrid::config::Flag<bool> _sg_mc_timeout{
  29     "model-check/timeout", "Whether to enable timeouts for wait requests", false, [](bool) {
  30       _mc_cfg_cb_check("value to enable/disable timeout for wait requests", not MC_record_replay_is_active());
  31     }};
  32
  33 #if SIMGRID_HAVE_MC
  34 int _sg_do_model_check = 0;
  35 int _sg_mc_max_visited_states = 0;
  36
  37 static simgrid::config::Flag<std::string> cfg_mc_reduction{
  38     "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
  39     [](std::string_view value) {
  40       if (value != "none" && value != "dpor")
  41         xbt_die("configuration option 'model-check/reduction' can only take 'none' or 'dpor' as a value");
  42     }};
  43
  44 bool simgrid::mc::cfg_use_DPOR()
  45 {
  46   return cfg_mc_reduction.get() == "dpor";
  47 }
  48
  49 simgrid::config::Flag<int> _sg_mc_checkpoint{
  50     "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
  51                               "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
  52                               "step => faster verification, but huge memory consumption; higher values are good "
  53                               "compromises between speed and memory consumption.",
  54     0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
  55
  56 simgrid::config::Flag<std::string> _sg_mc_property_file{
  57     "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
  58     [](const std::string&) { _mc_cfg_cb_check("property"); }};
  59
  60 simgrid::config::Flag<bool> _sg_mc_comms_determinism{
  61     "model-check/communications-determinism",
  62     "Whether to enable the detection of communication determinism",
  63     false,
  64     [](bool) {
  65       _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
  66     }};
  67
  68 simgrid::config::Flag<bool> _sg_mc_send_determinism{
  69     "model-check/send-determinism",
  70     "Enable/disable the detection of send-determinism in the communications schemes",
  71     false,
  72     [](bool) {
  73       _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
  74     }};
  75
  76 simgrid::config::Flag<bool> _sg_mc_unfolding_checker{
  77     "model-check/unfolding-checker",
  78     "Whether to enable the unfolding-based dynamic partial order reduction to MPI programs", false, [](bool) {
  79       _mc_cfg_cb_check("value to to enable/disable the unfolding-based dynamic partial order reduction to MPI programs");
  80     }};
  81
  82 simgrid::config::Flag<std::string> _sg_mc_buffering{
  83     "smpi/buffering",
  84     "Buffering semantic to use for MPI (only used in MC)",
  85     "infty",
  86     {{"zero", "No system buffering: MPI_Send is blocking"},
  87      {"infty", "Infinite system buffering: MPI_Send returns immediately"}},
  88     [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
  89
  90 simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
  91                                             "Maximal exploration depth (default: 1000)",
  92                                             1000,
  93                                             [](int) { _mc_cfg_cb_check("max depth value"); }};
  94
  95 static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
  96     "model-check/visited", "Specify the number of visited state stored for state comparison reduction. If value=5, the "
  97                            "last 5 visited states are stored. If value=0 (the default), all states are stored.",
  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 #endif