Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MC: Trade less use of executed_req for more network messages
[simgrid.git] / src / mc / checker / SafetyChecker.cpp
1 /* Copyright (c) 2016-2022. 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/Session.hpp"
7 #include "src/mc/Transition.hpp"
8 #include "src/mc/VisitedState.hpp"
9 #include "src/mc/checker/SafetyChecker.hpp"
10 #include "src/mc/mc_config.hpp"
11 #include "src/mc/mc_exit.hpp"
12 #include "src/mc/mc_private.hpp"
13 #include "src/mc/mc_record.hpp"
14
15 #include "src/xbt/mmalloc/mmprivate.h"
16 #include "xbt/log.h"
17 #include "xbt/sysdep.h"
18
19 #include <cassert>
20 #include <cstdio>
21
22 #include <memory>
23 #include <string>
24 #include <vector>
25
26 using api = simgrid::mc::Api;
27
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety verification ");
29
30 namespace simgrid {
31 namespace mc {
32
33 void SafetyChecker::check_non_termination(const State* current_state)
34 {
35   for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
36     if (api::get().snapshot_equal((*state)->system_state_.get(), current_state->system_state_.get())) {
37       XBT_INFO("Non-progressive cycle: state %d -> state %d", (*state)->num_, current_state->num_);
38       XBT_INFO("******************************************");
39       XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
40       XBT_INFO("******************************************");
41       XBT_INFO("Counter-example execution trace:");
42       for (auto const& s : get_textual_trace())
43         XBT_INFO("  %s", s.c_str());
44       api::get().dump_record_path();
45       api::get().log_state();
46
47       throw TerminationError();
48     }
49 }
50
51 RecordTrace SafetyChecker::get_record_trace() // override
52 {
53   RecordTrace res;
54   for (auto const& state : stack_)
55     res.push_back(state->get_transition());
56   return res;
57 }
58
59 std::vector<std::string> SafetyChecker::get_textual_trace() // override
60 {
61   std::vector<std::string> trace;
62   for (auto const& state : stack_)
63     trace.push_back(state->transition_.textual);
64   return trace;
65 }
66
67 void SafetyChecker::log_state() // override
68 {
69   XBT_INFO("Expanded states = %lu", expanded_states_count_);
70   XBT_INFO("Visited states = %lu", api::get().mc_get_visited_states());
71   XBT_INFO("Executed transitions = %lu", api::get().mc_get_executed_trans());
72 }
73
74 void SafetyChecker::run()
75 {
76   /* This function runs the DFS algorithm the state space.
77    * We do so iteratively instead of recursively, dealing with the call stack manually.
78    * This allows one to explore the call stack at will. */
79
80   while (not stack_.empty()) {
81     /* Get current state */
82     State* state = stack_.back().get();
83
84     XBT_DEBUG("**************************************************");
85     XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
86              state->count_todo());
87
88     api::get().mc_inc_visited_states();
89
90     // Backtrack if we reached the maximum depth
91     if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
92       if (reductionMode_ == ReductionMode::dpor) {
93         XBT_ERROR("/!\\ Max depth of %d reached! THIS WILL PROBABLY BREAK the dpor reduction /!\\",
94                   _sg_mc_max_depth.get());
95         XBT_ERROR("/!\\ If bad things happen, disable dpor with --cfg=model-check/reduction:none /!\\");
96       } else
97         XBT_WARN("/!\\ Max depth reached ! /!\\ ");
98       this->backtrack();
99       continue;
100     }
101
102     // Backtrack if we are revisiting a state we saw previously
103     if (visited_state_ != nullptr) {
104       XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.",
105                 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
106
107       visited_state_ = nullptr;
108       this->backtrack();
109       continue;
110     }
111
112     // Search for the next transition. If found, state is modified accordingly (transition and executed_req are set)
113     // If there is no more transition in the current state, backtrack.
114
115     if (not api::get().mc_state_choose_request(state)) {
116
117       XBT_DEBUG("There remains %zu actors, but none to interleave (depth %zu).",
118                 mc_model_checker->get_remote_process().actors().size(), stack_.size() + 1);
119
120       if (mc_model_checker->get_remote_process().actors().empty())
121         mc_model_checker->finalize_app();
122       this->backtrack();
123       continue;
124     }
125
126     /* Actually answer the request: let execute the selected request (MCed does one step) */
127     auto remote_observer = api::get().execute(state->transition_, &state->executed_req_);
128
129     // If there are processes to interleave and the maximum depth has not been
130     // reached then perform one step of the exploration algorithm.
131     XBT_DEBUG("Execute: %s", state->transition_.textual.c_str());
132
133     std::string req_str;
134     if (dot_output != nullptr)
135       req_str = api::get().request_get_dot_output(state->transition_.aid_, state->transition_.times_considered_);
136
137     api::get().mc_inc_executed_trans();
138
139     /* Create the new expanded state (copy the state of MCed into our MCer data) */
140     ++expanded_states_count_;
141     auto next_state = std::make_unique<State>(expanded_states_count_);
142     next_state->remote_observer_ = remote_observer;
143
144     if (_sg_mc_termination)
145       this->check_non_termination(next_state.get());
146
147     /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
148     if (_sg_mc_max_visited_states > 0)
149       visited_state_ = visited_states_.addVisitedState(expanded_states_count_, next_state.get(), true);
150
151     /* If this is a new state (or if we don't care about state-equality reduction) */
152     if (visited_state_ == nullptr) {
153       /* Get an enabled process and insert it in the interleave set of the next state */
154       auto actors = api::get().get_actors();
155       for (auto& remoteActor : actors) {
156         auto actor = remoteActor.copy.get_buffer();
157         if (get_session().actor_is_enabled(actor->get_pid())) {
158           next_state->mark_todo(actor->get_pid());
159           if (reductionMode_ == ReductionMode::dpor)
160             break; // With DPOR, we take the first enabled transition
161         }
162       }
163
164       if (dot_output != nullptr)
165         std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
166
167     } else if (dot_output != nullptr)
168       std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_,
169                    visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
170                    req_str.c_str());
171
172     stack_.push_back(std::move(next_state));
173   }
174
175   XBT_INFO("No property violation found.");
176   api::get().log_state();
177 }
178
179 void SafetyChecker::backtrack()
180 {
181   stack_.pop_back();
182
183   api::get().mc_check_deadlock();
184
185   /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
186    *  have it empty in the way. For each deleted state, check if the request that has generated it (from its
187    *  predecessor state), depends on any other previous request executed before it. If it does then add it to the
188    *  interleave set of the state that executed that previous request. */
189
190   while (not stack_.empty()) {
191     std::unique_ptr<State> state = std::move(stack_.back());
192     stack_.pop_back();
193     if (reductionMode_ == ReductionMode::dpor) {
194       aid_t issuer_id = state->transition_.aid_;
195       for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
196         State* prev_state = i->get();
197         if (state->transition_.aid_ == prev_state->transition_.aid_) {
198           XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->transition_.textual.c_str(),
199                     prev_state->transition_.textual.c_str(), issuer_id);
200           break;
201         } else if (api::get().requests_are_dependent(prev_state->remote_observer_, state->remote_observer_)) {
202           if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
203             XBT_DEBUG("Dependent Transitions:");
204             XBT_DEBUG("  %s (state=%d)", prev_state->transition_.textual.c_str(), prev_state->num_);
205             XBT_DEBUG("  %s (state=%d)", state->transition_.textual.c_str(), state->num_);
206           }
207
208           if (not prev_state->actor_states_[issuer_id].is_done())
209             prev_state->mark_todo(issuer_id);
210           else
211             XBT_DEBUG("Actor %ld is in done set", issuer_id);
212           break;
213         } else {
214           if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
215             XBT_DEBUG("INDEPENDENT Transitions:");
216             XBT_DEBUG("  %s (state=%d)", prev_state->transition_.textual.c_str(), prev_state->num_);
217             XBT_DEBUG("  %s (state=%d)", state->transition_.textual.c_str(), state->num_);
218           }
219         }
220       }
221     }
222
223     if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
224       /* We found a back-tracking point, let's loop */
225       XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
226       stack_.push_back(std::move(state));
227       this->restore_state();
228       XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
229       break;
230     } else {
231       XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
232     }
233   }
234 }
235
236 void SafetyChecker::restore_state()
237 {
238   /* Intermediate backtracking */
239   const State* last_state = stack_.back().get();
240   if (last_state->system_state_) {
241     api::get().restore_state(last_state->system_state_);
242     return;
243   }
244
245   get_session().restore_initial_state();
246
247   /* Traverse the stack from the state at position start and re-execute the transitions */
248   for (std::unique_ptr<State> const& state : stack_) {
249     if (state == stack_.back())
250       break;
251     api::get().execute(state->transition_, &state->executed_req_);
252     /* Update statistics */
253     api::get().mc_inc_visited_states();
254     api::get().mc_inc_executed_trans();
255   }
256 }
257
258 SafetyChecker::SafetyChecker(Session* session) : Checker(session)
259 {
260   reductionMode_ = reduction_mode;
261   if (_sg_mc_termination)
262     reductionMode_ = ReductionMode::none;
263   else if (reductionMode_ == ReductionMode::unset)
264     reductionMode_ = ReductionMode::dpor;
265
266   if (_sg_mc_termination)
267     XBT_INFO("Check non progressive cycles");
268   else
269     XBT_INFO("Check a safety property. Reduction is: %s.",
270              (reductionMode_ == ReductionMode::none ? "none"
271                                                     : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
272
273   get_session().take_initial_snapshot();
274
275   XBT_DEBUG("Starting the safety algorithm");
276
277   ++expanded_states_count_;
278   auto initial_state = std::make_unique<State>(expanded_states_count_);
279
280   XBT_DEBUG("**************************************************");
281
282   /* Get an enabled actor and insert it in the interleave set of the initial state */
283   auto actors = api::get().get_actors();
284   XBT_DEBUG("Initial state. %zu actors to consider", actors.size());
285   for (auto& actor : actors) {
286     aid_t aid = actor.copy.get_buffer()->get_pid();
287     if (get_session().actor_is_enabled(aid)) {
288       initial_state->mark_todo(aid);
289       if (reductionMode_ == ReductionMode::dpor) {
290         XBT_DEBUG("Actor %ld is TODO, DPOR is ON so let's go for this one.", aid);
291         break;
292       }
293       XBT_DEBUG("Actor %ld is TODO", aid);
294     }
295   }
296
297   stack_.push_back(std::move(initial_state));
298 }
299
300 Checker* create_safety_checker(Session* session)
301 {
302   return new SafetyChecker(session);
303 }
304
305 } // namespace mc
306 } // namespace simgrid