-/* Copyright (c) 2008-2015. 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 <xbt/str.h>
-#include <xbt/log.h>
-#include <xbt/config.h>
+#include "src/mc/mc_config.hpp"
+#include "src/mc/mc_replay.hpp"
+#include "src/simgrid/sg_config.hpp"
+#include <simgrid/modelchecker.h>
-#include <mc/mc.h>
-#include "src/mc/mc_replay.h"
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg);
-#include <simgrid/sg_config.h>
-
-#ifdef HAVE_MC
-#include "src/mc/mc_safety.h"
-#include "src/mc/mc_private.h"
-#endif
-
-#include "src/mc/mc_record.h"
-
-extern "C" {
-
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_config, mc,
- "Configuration of MC");
-
-#ifdef HAVE_MC
-/* Configuration support */
-e_mc_reduce_t mc_reduce_kind = e_mc_reduce_unset;
-#endif
-
-#ifndef HAVE_MC
-#define _sg_do_model_check 0
-#endif
-
-int _sg_mc_timeout = 0;
-
-void _mc_cfg_cb_timeout(const char *name, int pos)
+static simgrid::mc::ModelCheckingMode model_checking_mode = simgrid::mc::ModelCheckingMode::NONE;
+simgrid::mc::ModelCheckingMode simgrid::mc::get_model_checking_mode()
{
- if (_sg_cfg_init_status && !(_sg_do_model_check || MC_record_path)) {
- xbt_die
- ("You are specifying a value to enable/disable timeout for wait requests after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_timeout = xbt_cfg_get_boolean(_sg_cfg_set, name);
+ return model_checking_mode;
}
-
-#ifdef HAVE_MC
-int _sg_do_model_check = 0;
-int _sg_do_model_check_record = 0;
-int _sg_mc_checkpoint = 0;
-int _sg_mc_sparse_checkpoint = 0;
-int _sg_mc_soft_dirty = 0;
-int _sg_mc_ksm = 0;
-char *_sg_mc_property_file = nullptr;
-int _sg_mc_hash = 0;
-int _sg_mc_max_depth = 1000;
-int _sg_mc_visited = 0;
-char *_sg_mc_dot_output_file = nullptr;
-int _sg_mc_comms_determinism = 0;
-int _sg_mc_send_determinism = 0;
-int _sg_mc_safety = 0;
-int _sg_mc_liveness = 0;
-int _sg_mc_snapshot_fds = 0;
-int _sg_mc_termination = 0;
-
-void _mc_cfg_cb_reduce(const char *name, int pos)
+void simgrid::mc::set_model_checking_mode(simgrid::mc::ModelCheckingMode mode)
{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a reduction strategy after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- char *val = xbt_cfg_get_string(_sg_cfg_set, name);
- if (!strcasecmp(val, "none")) {
- mc_reduce_kind = e_mc_reduce_none;
- } else if (!strcasecmp(val, "dpor")) {
- mc_reduce_kind = e_mc_reduce_dpor;
- } else {
- xbt_die("configuration option %s can only take 'none' or 'dpor' as a value",
- name);
- }
+ model_checking_mode = mode;
}
-void _mc_cfg_cb_checkpoint(const char *name, int pos)
+static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a checkpointing value after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_checkpoint = xbt_cfg_get_int(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_sparse_checkpoint(const char *name, int pos) {
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die("You are specifying a checkpointing value after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_sparse_checkpoint = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_soft_dirty(const char *name, int pos) {
- if (_sg_cfg_init_status && !_sg_do_model_check)
- xbt_die("You are specifying a soft dirty value after the initialization "
- "(through MSG_config?), but model-checking was not activated "
- "at config time (through --cfg=model-check:1). "
- "This won't work, sorry.");
- _sg_mc_soft_dirty = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_ksm(const char *name, int pos)
+ 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)", "",
+ [](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", not MC_record_replay_is_active());
+ }};
+
+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<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<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", "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",
+ "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"}},
+ [](std::string_view) { _mc_cfg_cb_check("buffering mode"); }};
+
+simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
+ "Maximal exploration depth (default: 1000)",
+ 1000,
+ [](int) { _mc_cfg_cb_check("max depth value"); }};
+
+simgrid::mc::ReductionMode simgrid::mc::get_model_checking_reduction()
{
- if (_sg_cfg_init_status && !_sg_do_model_check)
- xbt_die("You are specifying a KSM value after the initialization (through MSG_config?), but model-checking was not activated at config time (through --cfg=model-check:1). This won't work, sorry.");
- _sg_mc_ksm = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_property(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a property after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_property_file = xbt_cfg_get_string(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_hash(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a value to enable/disable the use of global hash to speedup state comparaison, but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_hash = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_snapshot_fds(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a value to enable/disable the use of FD snapshoting, but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_snapshot_fds = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_max_depth(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a max depth value after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_max_depth = xbt_cfg_get_int(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_visited(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a number of stored visited states after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_visited = xbt_cfg_get_int(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_dot_output(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a file name for a dot output of graph state after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_dot_output_file = xbt_cfg_get_string(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_comms_determinism(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a value to enable/disable the detection of determinism in the communications schemes after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_comms_determinism = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_send_determinism(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a value to enable/disable the detection of send-determinism in the communications schemes after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
- }
- _sg_mc_send_determinism = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-void _mc_cfg_cb_termination(const char *name, int pos)
-{
- if (_sg_cfg_init_status && !_sg_do_model_check) {
- xbt_die
- ("You are specifying a value to enable/disable the detection of non progressive cycles after the initialization (through MSG_config?), but model-checking was not activated at config time (through bu the program was not runned under the model-checker (with simgrid-mc)). This won't work, sorry.");
+ 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;
}
- _sg_mc_termination = xbt_cfg_get_boolean(_sg_cfg_set, name);
-}
-
-#endif
-
}
