1 /* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved. */
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. */
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>
11 #if SIMGRID_HAVE_STATEFUL_MC
12 #include <string_view>
15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
17 static simgrid::mc::ModelCheckingMode model_checking_mode = simgrid::mc::ModelCheckingMode::NONE;
18 simgrid::mc::ModelCheckingMode simgrid::mc::get_model_checking_mode()
20 return model_checking_mode;
22 void simgrid::mc::set_model_checking_mode(simgrid::mc::ModelCheckingMode mode)
24 model_checking_mode = mode;
27 static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
29 xbt_assert(_sg_cfg_init_status == 0 || MC_is_active() || MC_record_replay_is_active() || not more_check,
30 "Specifying a %s is only allowed within the model-checker. Please use simgrid-mc, or specify this option "
31 "after the replay path.",
35 /* Replay (this part is enabled even if MC it disabled) */
36 simgrid::config::Flag<std::string> _sg_mc_record_path{
37 "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", "",
38 [](std::string_view value) {
39 if (value.empty()) // Ignore default value
41 xbt_assert(simgrid::mc::get_model_checking_mode() == simgrid::mc::ModelCheckingMode::NONE ||
42 simgrid::mc::get_model_checking_mode() == simgrid::mc::ModelCheckingMode::REPLAY,
43 "Specifying a MC replay path is not allowed when running the model-checker in mode %s. "
44 "Either remove the model-check/replay parameter, or execute your code out of simgrid-mc.",
45 to_c_str(simgrid::mc::get_model_checking_mode()));
46 simgrid::mc::set_model_checking_mode(simgrid::mc::ModelCheckingMode::REPLAY);
47 MC_record_path() = value;
50 simgrid::config::Flag<bool> _sg_mc_timeout{
51 "model-check/timeout", "Whether to enable timeouts for wait requests", false, [](bool) {
52 _mc_cfg_cb_check("value to enable/disable timeout for wait requests", not MC_record_replay_is_active());
55 int _sg_mc_max_visited_states = 0;
57 static simgrid::config::Flag<std::string> cfg_mc_reduction{
58 "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
59 [](std::string_view value) {
60 if (value != "none" && value != "dpor" && value != "sdpor" && value != "odpor")
61 xbt_die("configuration option 'model-check/reduction' must be one of the following: "
62 " 'none', 'dpor', 'sdpor', or 'odpor'");
65 simgrid::config::Flag<bool> _sg_mc_sleep_set{
66 "model-check/sleep-set", "Whether to enable the use of sleep-set in the reduction algorithm", false,
67 [](bool) { _mc_cfg_cb_check("value to enable/disable the use of sleep-set in the reduction algorithm"); }};
69 simgrid::config::Flag<std::string> _sg_mc_strategy{
70 "model-check/strategy",
71 "Specify the the kind of heuristic to use for guided model-checking",
73 {{"none", "No specific strategy: simply pick the first available transistion."},
74 {"nb_wait", "Take any enabled wait transition, to reduce the distance between an async and its wait."}}};
76 #if SIMGRID_HAVE_STATEFUL_MC
77 simgrid::config::Flag<int> _sg_mc_checkpoint{
78 "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
79 "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
80 "step => faster verification, but huge memory consumption; higher values are good "
81 "compromises between speed and memory consumption.",
82 0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
84 simgrid::config::Flag<std::string> _sg_mc_property_file{
85 "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
86 [](const std::string&) { _mc_cfg_cb_check("property"); }};
88 simgrid::config::Flag<bool> _sg_mc_comms_determinism{
89 "model-check/communications-determinism",
90 "Whether to enable the detection of communication determinism",
93 _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
96 simgrid::config::Flag<bool> _sg_mc_send_determinism{
97 "model-check/send-determinism",
98 "Enable/disable the detection of send-determinism in the communications schemes",
101 _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
104 simgrid::config::Flag<bool> _sg_mc_unfolding_checker{
105 "model-check/unfolding-checker",
106 "Whether to enable the unfolding-based dynamic partial order reduction to MPI programs", false, [](bool) {
107 _mc_cfg_cb_check("value to to enable/disable the unfolding-based dynamic partial order reduction to MPI programs");
111 simgrid::config::Flag<std::string> _sg_mc_buffering{
113 "Buffering semantic to use for MPI (only used in MC)",
115 {{"zero", "No system buffering: MPI_Send is blocking"},
116 {"infty", "Infinite system buffering: MPI_Send returns immediately"}},
117 [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
119 simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
120 "Maximal exploration depth (default: 1000)",
122 [](int) { _mc_cfg_cb_check("max depth value"); }};
124 static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
125 "model-check/visited",
126 "Specify the number of visited state stored for state comparison reduction: any branch leading to a state that is "
127 "already stored is cut.\n"
128 "If value=5, the last 5 visited states are stored. If value=0 (the default), no state is stored and this reduction "
129 "technique is disabled.",
131 _mc_cfg_cb_check("number of stored visited states");
132 _sg_mc_max_visited_states = value;
135 simgrid::config::Flag<bool> _sg_mc_termination{
136 "model-check/termination", "Whether to enable non progressive cycle detection", false,
137 [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
139 simgrid::mc::ReductionMode simgrid::mc::get_model_checking_reduction()
141 if ((cfg_mc_reduction.get() == "dpor" || cfg_mc_reduction.get() == "sdpor" || cfg_mc_reduction.get() == "odpor") &&
142 _sg_mc_max_visited_states__ > 0) {
143 XBT_INFO("Disabling DPOR since state-equality reduction is activated with 'model-check/visited'");
144 return simgrid::mc::ReductionMode::none;
147 if (cfg_mc_reduction.get() == "none") {
148 return ReductionMode::none;
149 } else if (cfg_mc_reduction.get() == "dpor") {
150 return ReductionMode::dpor;
151 } else if (cfg_mc_reduction.get() == "sdpor") {
152 return ReductionMode::sdpor;
153 } else if (cfg_mc_reduction.get() == "odpor") {
154 return ReductionMode::odpor;
155 } else if (cfg_mc_reduction.get() == "udpor") {
156 XBT_INFO("No reduction will be used: "
157 "UDPOR has a dedicated invocation 'model-check/unfolding-checker' "
158 "but is not yet fully supported in SimGrid");
159 return ReductionMode::none;
161 XBT_INFO("Unknown reduction mode: defaulting to no reduction");
162 return ReductionMode::none;