1 /* Copyright (c) 2016-2022. 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/explo/DFSExplorer.hpp"
7 #include "src/mc/VisitedState.hpp"
8 #include "src/mc/mc_config.hpp"
9 #include "src/mc/mc_exit.hpp"
10 #include "src/mc/mc_private.hpp"
11 #include "src/mc/mc_record.hpp"
12 #include "src/mc/transition/Transition.hpp"
14 #include "src/xbt/mmalloc/mmprivate.h"
16 #include "xbt/sysdep.h"
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_dfs, mc, "DFS exploration algorithm of the model-checker");
30 xbt::signal<void()> DFSExplorer::on_exploration_start_signal;
31 xbt::signal<void()> DFSExplorer::on_backtracking_signal;
33 xbt::signal<void(State*)> DFSExplorer::on_state_creation_signal;
35 xbt::signal<void(State*)> DFSExplorer::on_restore_system_state_signal;
36 xbt::signal<void()> DFSExplorer::on_restore_initial_state_signal;
37 xbt::signal<void(Transition*)> DFSExplorer::on_transition_replay_signal;
38 xbt::signal<void(Transition*)> DFSExplorer::on_transition_execute_signal;
40 xbt::signal<void()> DFSExplorer::on_log_state_signal;
42 void DFSExplorer::check_non_termination(const State* current_state)
44 for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
45 if (Api::get().snapshot_equal((*state)->get_system_state(), current_state->get_system_state())) {
46 XBT_INFO("Non-progressive cycle: state %ld -> state %ld", (*state)->get_num(), current_state->get_num());
47 XBT_INFO("******************************************");
48 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
49 XBT_INFO("******************************************");
50 XBT_INFO("Counter-example execution trace:");
51 for (auto const& s : get_textual_trace())
52 XBT_INFO(" %s", s.c_str());
53 XBT_INFO("Path = %s", get_record_trace().to_string().c_str());
56 throw TerminationError();
60 RecordTrace DFSExplorer::get_record_trace() // override
63 for (auto const& state : stack_)
64 res.push_back(state->get_transition());
68 std::vector<std::string> DFSExplorer::get_textual_trace() // override
70 std::vector<std::string> trace;
71 for (auto const& state : stack_) {
72 const auto* t = state->get_transition();
73 trace.push_back(xbt::string_printf("%ld: %s", t->aid_, t->to_string().c_str()));
78 void DFSExplorer::log_state() // override
80 on_log_state_signal();
81 XBT_INFO("DFS exploration ended. %ld unique states visited; %ld backtracks (%lu transition replays, %lu states "
83 State::get_expanded_states(), backtrack_count_, Api::get().mc_get_visited_states(),
84 Transition::get_replayed_transitions());
87 void DFSExplorer::run()
89 on_exploration_start_signal();
90 /* This function runs the DFS algorithm the state space.
91 * We do so iteratively instead of recursively, dealing with the call stack manually.
92 * This allows one to explore the call stack at will. */
94 while (not stack_.empty()) {
95 /* Get current state */
96 State* state = stack_.back().get();
98 XBT_DEBUG("**************************************************");
99 XBT_DEBUG("Exploration depth=%zu (state:%ld; %zu interleaves)", stack_.size(), state->get_num(),
100 state->count_todo());
102 Api::get().mc_inc_visited_states();
104 // Backtrack if we reached the maximum depth
105 if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
106 if (reductionMode_ == ReductionMode::dpor) {
107 XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
108 _sg_mc_max_depth.get());
109 XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
111 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
116 // Backtrack if we are revisiting a state we saw previously
117 if (visited_state_ != nullptr) {
118 XBT_DEBUG("State already visited (equal to state %ld), exploration stopped on this path.",
119 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
121 visited_state_ = nullptr;
126 // Search for the next transition
127 int next = state->next_transition();
129 if (next < 0) { // If there is no more transition in the current state, backtrack.
130 XBT_DEBUG("There remains %zu actors, but none to interleave (depth %zu).",
131 mc_model_checker->get_remote_process().actors().size(), stack_.size() + 1);
133 if (mc_model_checker->get_remote_process().actors().empty()) {
134 mc_model_checker->finalize_app();
135 XBT_VERB("Execution came to an end at %s (state: %ld, depth: %zu)", get_record_trace().to_string().c_str(),
136 state->get_num(), stack_.size());
142 /* Actually answer the request: let's execute the selected request (MCed does one step) */
143 state->execute_next(next);
144 on_transition_execute_signal(state->get_transition());
146 // If there are processes to interleave and the maximum depth has not been
147 // reached then perform one step of the exploration algorithm.
148 XBT_VERB("Execute %ld: %.60s (stack depth: %zu, state: %ld, %zu interleaves)", state->get_transition()->aid_,
149 state->get_transition()->to_string().c_str(), stack_.size(), state->get_num(), state->count_todo());
152 if (dot_output != nullptr)
153 req_str = state->get_transition()->dot_string();
155 /* Create the new expanded state (copy the state of MCed into our MCer data) */
156 auto next_state = std::make_unique<State>();
157 on_state_creation_signal(next_state.get());
159 if (_sg_mc_termination)
160 this->check_non_termination(next_state.get());
162 /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
163 if (_sg_mc_max_visited_states > 0)
164 visited_state_ = visited_states_.addVisitedState(next_state->get_num(), next_state.get(), true);
166 /* If this is a new state (or if we don't care about state-equality reduction) */
167 if (visited_state_ == nullptr) {
168 /* Get an enabled process and insert it in the interleave set of the next state */
169 auto actors = Api::get().get_actors();
170 for (auto& remoteActor : actors) {
171 auto actor = remoteActor.copy.get_buffer();
172 if (get_session().actor_is_enabled(actor->get_pid())) {
173 next_state->mark_todo(actor->get_pid());
174 if (reductionMode_ == ReductionMode::dpor)
175 break; // With DPOR, we take the first enabled transition
179 if (dot_output != nullptr)
180 std::fprintf(dot_output, "\"%ld\" -> \"%ld\" [%s];\n", state->get_num(), next_state->get_num(),
183 } else if (dot_output != nullptr)
184 std::fprintf(dot_output, "\"%ld\" -> \"%ld\" [%s];\n", state->get_num(),
185 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
188 stack_.push_back(std::move(next_state));
194 void DFSExplorer::backtrack()
197 XBT_VERB("Backtracking from %s", get_record_trace().to_string().c_str());
198 on_backtracking_signal();
201 get_session().check_deadlock();
203 /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
204 * have it empty in the way. For each deleted state, check if the request that has generated it (from its
205 * predecessor state), depends on any other previous request executed before it. If it does then add it to the
206 * interleave set of the state that executed that previous request. */
208 while (not stack_.empty()) {
209 std::unique_ptr<State> state = std::move(stack_.back());
211 if (reductionMode_ == ReductionMode::dpor) {
212 aid_t issuer_id = state->get_transition()->aid_;
213 for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
214 State* prev_state = i->get();
215 if (state->get_transition()->aid_ == prev_state->get_transition()->aid_) {
216 XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->get_transition()->to_string().c_str(),
217 prev_state->get_transition()->to_string().c_str(), issuer_id);
219 } else if (prev_state->get_transition()->depends(state->get_transition())) {
220 XBT_VERB("Dependent Transitions:");
221 XBT_VERB(" %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
222 XBT_VERB(" %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
224 if (not prev_state->is_done(issuer_id))
225 prev_state->mark_todo(issuer_id);
227 XBT_DEBUG("Actor %ld is in done set", issuer_id);
230 XBT_VERB("INDEPENDENT Transitions:");
231 XBT_VERB(" %s (state=%ld)", prev_state->get_transition()->to_string().c_str(), prev_state->get_num());
232 XBT_VERB(" %s (state=%ld)", state->get_transition()->to_string().c_str(), state->get_num());
237 if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
238 /* We found a back-tracking point, let's loop */
239 XBT_DEBUG("Back-tracking to state %ld at depth %zu", state->get_num(), stack_.size() + 1);
241 std::move(state)); // Put it back on the stack from which it was removed earlier in this while loop
242 this->restore_state();
243 XBT_DEBUG("Back-tracking to state %ld at depth %zu done", stack_.back()->get_num(), stack_.size());
246 XBT_DEBUG("Delete state %ld at depth %zu", state->get_num(), stack_.size() + 1);
251 void DFSExplorer::restore_state()
253 /* If asked to rollback on a state that has a snapshot, restore it */
254 State* last_state = stack_.back().get();
255 if (const auto* system_state = last_state->get_system_state()) {
256 Api::get().restore_state(system_state);
257 on_restore_system_state_signal(last_state);
261 /* if no snapshot, we need to restore the initial state and replay the transitions */
262 get_session().restore_initial_state();
263 on_restore_initial_state_signal();
265 /* Traverse the stack from the state at position start and re-execute the transitions */
266 for (std::unique_ptr<State> const& state : stack_) {
267 if (state == stack_.back()) /* If we are arrived on the target state, don't replay the outgoing transition */
269 state->get_transition()->replay();
270 on_transition_replay_signal(state->get_transition());
271 /* Update statistics */
272 Api::get().mc_inc_visited_states();
276 DFSExplorer::DFSExplorer(Session* session) : Exploration(session)
278 reductionMode_ = reduction_mode;
279 if (_sg_mc_termination)
280 reductionMode_ = ReductionMode::none;
281 else if (reductionMode_ == ReductionMode::unset)
282 reductionMode_ = ReductionMode::dpor;
284 if (_sg_mc_termination)
285 XBT_INFO("Check non progressive cycles");
287 XBT_INFO("Start a DFS exploration. Reduction is: %s.",
288 (reductionMode_ == ReductionMode::none ? "none"
289 : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
291 get_session().take_initial_snapshot();
293 XBT_DEBUG("Starting the DFS exploration");
295 auto initial_state = std::make_unique<State>();
297 XBT_DEBUG("**************************************************");
299 /* Get an enabled actor and insert it in the interleave set of the initial state */
300 auto actors = Api::get().get_actors();
301 XBT_DEBUG("Initial state. %zu actors to consider", actors.size());
302 for (auto& actor : actors) {
303 aid_t aid = actor.copy.get_buffer()->get_pid();
304 if (get_session().actor_is_enabled(aid)) {
305 initial_state->mark_todo(aid);
306 if (reductionMode_ == ReductionMode::dpor) {
307 XBT_DEBUG("Actor %ld is TODO, DPOR is ON so let's go for this one.", aid);
310 XBT_DEBUG("Actor %ld is TODO", aid);
314 stack_.push_back(std::move(initial_state));
317 Exploration* create_dfs_exploration(Session* session)
319 return new DFSExplorer(session);
323 } // namespace simgrid