Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mc: snake_case the checkers
[simgrid.git] / src / mc / mc_config.cpp
1 /* Copyright (c) 2008-2019. 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_replay.hpp"
7 #include <simgrid/sg_config.hpp>
8 #if SIMGRID_HAVE_MC
9 #include "src/mc/mc_safety.hpp"
10 #endif
11
12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_config, mc, "Configuration of the Model Checker");
13
14 #if SIMGRID_HAVE_MC
15 namespace simgrid {
16 namespace mc {
17 /* Configuration support */
18 simgrid::mc::ReductionMode reduction_mode = simgrid::mc::ReductionMode::unset;
19 }
20 }
21 #endif
22
23 #if !SIMGRID_HAVE_MC
24 #define _sg_do_model_check 0
25 #endif
26
27 static void _mc_cfg_cb_check(const char* spec, bool more_check = true)
28 {
29   if (_sg_cfg_init_status && not _sg_do_model_check && more_check)
30     xbt_die("You are specifying a %s after the initialization (through MSG_config?), but the program was not run under "
31             "the model-checker (with simgrid-mc)). This won't work, sorry.",
32             spec);
33 }
34
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
39 simgrid::config::Flag<bool> _sg_mc_timeout{
40     "model-check/timeout", "Whether to enable timeouts for wait requests", false,
41     [](bool) { _mc_cfg_cb_check("value to enable/disable timeout for wait requests", MC_record_path.empty()); }};
42
43 #if SIMGRID_HAVE_MC
44 int _sg_do_model_check = 0;
45 int _sg_mc_max_visited_states = 0;
46
47 simgrid::config::Flag<int> _sg_mc_checkpoint{
48     "model-check/checkpoint", "Specify the amount of steps between checkpoints during stateful model-checking "
49                               "(default: 0 => stateless verification). If value=1, one checkpoint is saved for each "
50                               "step => faster verification, but huge memory consumption; higher values are good "
51                               "compromises between speed and memory consumption.",
52     0, [](int) { _mc_cfg_cb_check("checkpointing value"); }};
53
54 simgrid::config::Flag<bool> _sg_mc_sparse_checkpoint{"model-check/sparse-checkpoint", "Use sparse per-page snapshots.",
55                                                      false, [](bool) { _mc_cfg_cb_check("checkpointing value"); }};
56
57 simgrid::config::Flag<std::string> _sg_mc_property_file{
58     "model-check/property", "Name of the file containing the property, as formatted by the ltl2ba program.", "",
59     [](const std::string&) { _mc_cfg_cb_check("property"); }};
60
61 simgrid::config::Flag<bool> _sg_mc_comms_determinism{
62     "model-check/communications-determinism",
63     {"model-check/communications_determinism"},
64     "Whether to enable the detection of communication determinism",
65     false,
66     [](bool) {
67       _mc_cfg_cb_check("value to enable/disable the detection of determinism in the communications schemes");
68     }};
69
70 simgrid::config::Flag<bool> _sg_mc_send_determinism{
71     "model-check/send-determinism",
72     {"model-check/send_determinism"},
73     "Enable/disable the detection of send-determinism in the communications schemes",
74     false,
75     [](bool) {
76       _mc_cfg_cb_check("value to enable/disable the detection of send-determinism in the communications schemes");
77     }};
78
79 static simgrid::config::Flag<std::string> _sg_mc_reduce{
80     "model-check/reduction", "Specify the kind of exploration reduction (either none or DPOR)", "dpor",
81     [](const std::string& value) {
82       _mc_cfg_cb_check("reduction strategy");
83
84       if (value == "none")
85         simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::none;
86       else if (value == "dpor")
87         simgrid::mc::reduction_mode = simgrid::mc::ReductionMode::dpor;
88       else
89         xbt_die("configuration option model-check/reduction can only take 'none' or 'dpor' as a value");
90     }};
91
92 simgrid::config::Flag<bool> _sg_mc_hash{
93     "model-check/hash", "Whether to enable state hash for state comparison (experimental)", false,
94     [](bool) { _mc_cfg_cb_check("value to enable/disable the use of global hash to speedup state comparaison"); }};
95
96 simgrid::config::Flag<int> _sg_mc_max_depth{"model-check/max-depth",
97                                             {"model-check/max_depth"},
98                                             "Maximal exploration depth (default: 1000)",
99                                             1000,
100                                             [](int) { _mc_cfg_cb_check("max depth value"); }};
101
102 static simgrid::config::Flag<int> _sg_mc_max_visited_states__{
103     "model-check/visited", "Specify the number of visited state stored for state comparison reduction. If value=5, the "
104                            "last 5 visited states are stored. If value=0 (the default), all states are stored.",
105     0, [](int value) {
106       _mc_cfg_cb_check("number of stored visited states");
107       _sg_mc_max_visited_states = value;
108     }};
109
110 simgrid::config::Flag<std::string> _sg_mc_dot_output_file{
111     "model-check/dot-output",
112     {"model-check/dot_output"},
113     "Name of dot output file corresponding to graph state",
114     "",
115     [](const std::string&) { _mc_cfg_cb_check("file name for a dot output of graph state"); }};
116
117 simgrid::config::Flag<bool> _sg_mc_termination{
118     "model-check/termination", "Whether to enable non progressive cycle detection", false,
119     [](bool) { _mc_cfg_cb_check("value to enable/disable the detection of non progressive cycles"); }};
120
121 #endif