-/* Copyright (c) 2008-2019. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2008-2023. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
+#include "src/mc/mc_config.hpp"
#include "src/mc/mc_replay.hpp"
-#include <simgrid/sg_config.hpp>
-#if SIMGRID_HAVE_MC
-#include "src/mc/mc_safety.hpp"
-#endif
+#include "src/simgrid/sg_config.hpp"
+#include <simgrid/modelchecker.h>
-#include <climits>
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_config, mc, "Configuration of the Model Checker");
-
-#if SIMGRID_HAVE_MC
-namespace simgrid {
-namespace mc {
-/* Configuration support */
-simgrid::mc::ReductionMode reduction_mode = simgrid::mc::ReductionMode::unset;
+static simgrid::mc::ModelCheckingMode model_checking_mode = simgrid::mc::ModelCheckingMode::NONE;
+simgrid::mc::ModelCheckingMode simgrid::mc::get_model_checking_mode()
+{
+ return model_checking_mode;
}
+void simgrid::mc::set_model_checking_mode(simgrid::mc::ModelCheckingMode mode)
+{
+ model_checking_mode = mode;
}
-#else
-#define _sg_do_model_check 0
-#endif
static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
{
- if (_sg_cfg_init_status && not _sg_do_model_check && more_check)
- xbt_die("You are specifying a %s after the initialization (through MSG_config?), but the program was not run under "
- "the model-checker (with simgrid-mc)). This won't work, sorry.",
- spec);
+ xbt_assert(_sg_cfg_init_status == 0 || MC_is_active() || MC_record_replay_is_active() || not more_check,
+ "Specifying a %s is only allowed within the model-checker. Please use simgrid-mc, or specify this option "
+ "after the replay path.",
+ spec);
}
/* Replay (this part is enabled even if MC it disabled) */
simgrid::config::Flag<std::string> _sg_mc_record_path{
- "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", ""};
+ "model-check/replay", "Model-check path to replay (as reported by SimGrid when a violation is reported)", "",
+ [](std::string_view value) {
+ if (value.empty()) // Ignore default value
+ return;
+ xbt_assert(simgrid::mc::get_model_checking_mode() == simgrid::mc::ModelCheckingMode::NONE ||
+ simgrid::mc::get_model_checking_mode() == simgrid::mc::ModelCheckingMode::REPLAY,
+ "Specifying a MC replay path is not allowed when running the model-checker in mode %s. "
+ "Either remove the model-check/replay parameter, or execute your code out of simgrid-mc.",
+ to_c_str(simgrid::mc::get_model_checking_mode()));
+ simgrid::mc::set_model_checking_mode(simgrid::mc::ModelCheckingMode::REPLAY);
+ MC_record_path() = value;
+ }};
simgrid::config::Flag<bool> _sg_mc_timeout{
- "model-check/timeout", "Whether to enable timeouts for wait requests", false,
- [](bool) { _mc_cfg_cb_check("value to enable/disable timeout for wait requests", MC_record_path.empty()); }};
+ "model-check/timeout", "Whether to enable timeouts for wait requests", false, [](bool) {
+ _mc_cfg_cb_check("value to enable/disable timeout for wait requests", not MC_record_replay_is_active());
+ }};
-#if SIMGRID_HAVE_MC
-int _sg_do_model_check = 0;
-int _sg_mc_max_visited_states = 0;
+static simgrid::config::Flag<std::string> cfg_mc_reduction{
+ "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
+ [](std::string_view value) {
+ if (value != "none" && value != "dpor" && value != "sdpor" && value != "odpor" && value != "udpor")
+ xbt_die("configuration option 'model-check/reduction' must be one of the following: "
+ " 'none', 'dpor', 'sdpor', 'odpor', or 'udpor'");
+ }};
-simgrid::config::Flag<int> _sg_mc_checkpoint{
- "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
- "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
- "step => faster verification, but huge memory consumption; higher values are good "
- "compromises between speed and memory consumption.",
- 0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
+simgrid::config::Flag<std::string> _sg_mc_strategy{
+ "model-check/strategy",
+ "Specify the the kind of heuristic to use for guided model-checking",
+ "none",
+ {{"none", "No specific strategy: simply pick the first available transition and act as a DFS."},
+ {"max_match_comm", "Try to minimize the number of in-fly communication by appairing matching send and receive."},
+ {"min_match_comm",
+ "Try to maximize the number of in-fly communication by not appairing matching send and receive."},
+ {"uniform", "No specific strategy: choices are made randomly based on a uniform sampling."}}};
-simgrid::config::Flag<std::string> _sg_mc_property_file{
- "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
- [](const std::string&) { _mc_cfg_cb_check("property"); }};
+simgrid::config::Flag<int> _sg_mc_random_seed{"model-check/rand-seed",
+ "give a specific random seed to initialize the uniform distribution", 0,
+ [](int) { _mc_cfg_cb_check("Random seed"); }};
simgrid::config::Flag<bool> _sg_mc_comms_determinism{
- "model-check/communications-determinism",
- {"model-check/communications_determinism"},
- "Whether to enable the detection of communication determinism",
- false,
+ "model-check/communications-determinism", "Whether to enable the detection of communication determinism", false,
[](bool) {
_mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
}};
-
simgrid::config::Flag<bool> _sg_mc_send_determinism{
"model-check/send-determinism",
- {"model-check/send_determinism"},
"Enable/disable the detection of send-determinism in the communications schemes",
false,
[](bool) {
_mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
}};
+simgrid::config::Flag<bool> _sg_mc_unfolding_checker{
+ "model-check/unfolding-checker",
+ "Whether to enable the unfolding-based dynamic partial order reduction to MPI programs", false, [](bool) {
+ _mc_cfg_cb_check("value to to enable/disable the unfolding-based dynamic partial order reduction to MPI programs");
+ }};
+
simgrid::config::Flag<std::string> _sg_mc_buffering{
"smpi/buffering",
"Buffering semantic to use for MPI (only used in MC)",
"infty",
{{"zero", "No system buffering: MPI_Send is blocking"},
{"infty", "Infinite system buffering: MPI_Send returns immediately"}},
- [](const std::string& value) { _mc_cfg_cb_check("buffering mode"); }};
-
-static simgrid::config::Flag<std::string> _sg_mc_reduce{
- "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
- [](const std::string& value) {
- _mc_cfg_cb_check("reduction strategy");
-
- if (value == "none")
- simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::none;
- else if (value == "dpor")
- simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::dpor;
- else
- xbt_die("configuration option model-check/reduction can only take 'none' or 'dpor' as a value");
- }};
+ [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
- {"model-check/max_depth"},
"Maximal exploration depth (default: 1000)",
1000,
[](int) { _mc_cfg_cb_check("max depth value"); }};
-static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
- "model-check/visited", "Specify the number of visited state stored for state comparison reduction. If value=5, the "
- "last 5 visited states are stored. If value=0 (the default), all states are stored.",
- 0, [](int value) {
- _mc_cfg_cb_check("number of stored visited states");
- _sg_mc_max_visited_states = value;
- }};
-
-simgrid::config::Flag<std::string> _sg_mc_dot_output_file{
- "model-check/dot-output",
- {"model-check/dot_output"},
- "Name of dot output file corresponding to graph state",
- "",
- [](const std::string&) { _mc_cfg_cb_check("file name for a dot output of graph state"); }};
-
-simgrid::config::Flag<bool> _sg_mc_termination{
- "model-check/termination", "Whether to enable non progressive cycle detection", false,
- [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
-
-#endif
+simgrid::mc::ReductionMode simgrid::mc::get_model_checking_reduction()
+{
+ if (cfg_mc_reduction.get() == "none") {
+ return ReductionMode::none;
+ } else if (cfg_mc_reduction.get() == "dpor") {
+ return ReductionMode::dpor;
+ } else if (cfg_mc_reduction.get() == "sdpor") {
+ return ReductionMode::sdpor;
+ } else if (cfg_mc_reduction.get() == "odpor") {
+ return ReductionMode::odpor;
+ } else if (cfg_mc_reduction.get() == "udpor") {
+ XBT_INFO("No reduction will be used: "
+ "UDPOR has a dedicated invocation 'model-check/unfolding-checker' "
+ "but is not yet fully supported in SimGrid");
+ return ReductionMode::none;
+ } else {
+ XBT_INFO("Unknown reduction mode: defaulting to no reduction");
+ return ReductionMode::none;
+ }
+}
