X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/452237878ed316508bdfa05e3af625f549628842..fd0a3e64ee8c0eef865c03b8758deb7213f9ee67:/src/mc/mc_config.cpp diff --git a/src/mc/mc_config.cpp b/src/mc/mc_config.cpp index 5acdd2bbf5..571ec6ea8d 100644 --- a/src/mc/mc_config.cpp +++ b/src/mc/mc_config.cpp @@ -1,166 +1,171 @@ -/* Copyright (c) 2008-2018. 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/config.h" -#include "xbt/log.h" -#include - +#include "src/mc/mc_config.hpp" #include "src/mc/mc_replay.hpp" -#include - -#include - -#if SIMGRID_HAVE_MC -#include "src/mc/mc_private.hpp" -#include "src/mc/mc_safety.hpp" -#endif - -#include "src/mc/mc_record.hpp" - -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; -} -} -#endif +#include "src/simgrid/sg_config.hpp" +#include -#if !SIMGRID_HAVE_MC -#define _sg_do_model_check 0 +#if SIMGRID_HAVE_STATEFUL_MC +#include #endif -int _sg_mc_timeout = 0; - -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); -} - -void _mc_cfg_cb_timeout(const char *name) -{ - _mc_cfg_cb_check("value to enable/disable timeout for wait requests", MC_record_path.empty()); - - _sg_mc_timeout = xbt_cfg_get_boolean(name); -} - -#if SIMGRID_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_ksm = 0; -std::string _sg_mc_property_file; -int _sg_mc_hash = 0; -int _sg_mc_max_depth = 1000; -int _sg_mc_max_visited_states = 0; -std::string _sg_mc_dot_output_file; -int _sg_mc_comms_determinism = 0; -int _sg_mc_send_determinism = 0; -int _sg_mc_snapshot_fds = 0; -int _sg_mc_termination = 0; - -void _mc_cfg_cb_reduce(const char *name) -{ - _mc_cfg_cb_check("reduction strategy"); - - std::string val = xbt_cfg_get_string(name); - if (val == "none") - simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::none; - else if (val == "dpor") - simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::dpor; - else - xbt_die("configuration option %s can only take 'none' or 'dpor' as a value", name); -} +XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_cfg); -void _mc_cfg_cb_checkpoint(const char *name) +static simgrid::mc::ModelCheckingMode model_checking_mode = simgrid::mc::ModelCheckingMode::NONE; +simgrid::mc::ModelCheckingMode simgrid::mc::get_model_checking_mode() { - _mc_cfg_cb_check("checkpointing value"); - - _sg_mc_checkpoint = xbt_cfg_get_int(name); + return model_checking_mode; } - -void _mc_cfg_cb_sparse_checkpoint(const char *name) { - _mc_cfg_cb_check("checkpointing value"); - - _sg_mc_sparse_checkpoint = xbt_cfg_get_boolean(name); -} - -void _mc_cfg_cb_ksm(const char *name) +void simgrid::mc::set_model_checking_mode(simgrid::mc::ModelCheckingMode mode) { - _mc_cfg_cb_check("KSM value"); - - _sg_mc_ksm = xbt_cfg_get_boolean(name); + model_checking_mode = mode; } -void _mc_cfg_cb_property(const char *name) -{ - _mc_cfg_cb_check("property"); - - _sg_mc_property_file = xbt_cfg_get_string(name); -} - -void _mc_cfg_cb_hash(const char *name) -{ - _mc_cfg_cb_check("value to enable/disable the use of global hash to speedup state comparaison"); - - _sg_mc_hash = xbt_cfg_get_boolean(name); -} - -void _mc_cfg_cb_snapshot_fds(const char *name) -{ - _mc_cfg_cb_check("value to enable/disable the use of FD snapshotting"); - - _sg_mc_snapshot_fds = xbt_cfg_get_boolean(name); -} - -void _mc_cfg_cb_max_depth(const char *name) -{ - _mc_cfg_cb_check("max depth value"); - - _sg_mc_max_depth = xbt_cfg_get_int(name); -} - -void _mc_cfg_cb_visited(const char *name) -{ - _mc_cfg_cb_check("number of stored visited states"); - - _sg_mc_max_visited_states = xbt_cfg_get_int(name); -} - -void _mc_cfg_cb_dot_output(const char *name) -{ - _mc_cfg_cb_check("file name for a dot output of graph state"); - - _sg_mc_dot_output_file = xbt_cfg_get_string(name); -} - -void _mc_cfg_cb_comms_determinism(const char *name) +static void _mc_cfg_cb_check(const char* spec, bool more_check = true) { - _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes"); - - _sg_mc_comms_determinism = xbt_cfg_get_boolean(name); -} + 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 _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 _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()); + }}; -void _mc_cfg_cb_send_determinism(const char *name) -{ - _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes"); +int _sg_mc_max_visited_states = 0; - _sg_mc_send_determinism = xbt_cfg_get_boolean(name); -} +static simgrid::config::Flag 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") + xbt_die("configuration option 'model-check/reduction' must be one of the following: " + " 'none', 'dpor', 'sdpor', or 'odpor'"); + }}; + +simgrid::config::Flag _sg_mc_sleep_set{ + "model-check/sleep-set", "Whether to enable the use of sleep-set in the reduction algorithm", false, + [](bool) { _mc_cfg_cb_check("value to enable/disable the use of sleep-set in the reduction algorithm"); }}; + +simgrid::config::Flag _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 transistion 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 _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"); }}; + +#if SIMGRID_HAVE_STATEFUL_MC +simgrid::config::Flag _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 _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 _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 _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 _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"); + }}; +#endif -void _mc_cfg_cb_termination(const char *name) +simgrid::config::Flag _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 _sg_mc_max_depth{"model-check/max-depth", + "Maximal exploration depth (default: 1000)", + 1000, + [](int) { _mc_cfg_cb_check("max depth value"); }}; + +static simgrid::config::Flag _sg_mc_max_visited_states__{ + "model-check/visited", + "Specify the number of visited state stored for state comparison reduction: any branch leading to a state that is " + "already stored is cut.\n" + "If value=5, the last 5 visited states are stored. If value=0 (the default), no state is stored and this reduction " + "technique is disabled.", + 0, [](int value) { + _mc_cfg_cb_check("number of stored visited states"); + _sg_mc_max_visited_states = value; + }}; + +simgrid::config::Flag _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"); }}; + +simgrid::mc::ReductionMode simgrid::mc::get_model_checking_reduction() { - _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); - - _sg_mc_termination = xbt_cfg_get_boolean(name); + if ((cfg_mc_reduction.get() == "dpor" || cfg_mc_reduction.get() == "sdpor" || cfg_mc_reduction.get() == "odpor") && + _sg_mc_max_visited_states__ > 0) { + XBT_INFO("Disabling DPOR since state-equality reduction is activated with 'model-check/visited'"); + return simgrid::mc::ReductionMode::none; + } + + 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; + } } - -#endif