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/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"
15 #include "src/xbt/mmalloc/mmprivate.h"
17 #include "xbt/sysdep.h"
26 using api = simgrid::mc::Api;
28 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety verification ");
33 void SafetyChecker::check_non_termination(const State* current_state)
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();
47 throw TerminationError();
51 RecordTrace SafetyChecker::get_record_trace() // override
54 for (auto const& state : stack_)
55 res.push_back(state->get_transition());
59 std::vector<std::string> SafetyChecker::get_textual_trace() // override
61 std::vector<std::string> trace;
62 for (auto const& state : stack_)
63 trace.push_back(state->transition_.to_string());
67 void SafetyChecker::log_state() // override
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", Transition::get_executed_transitions());
74 void SafetyChecker::run()
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. */
80 while (not stack_.empty()) {
81 /* Get current state */
82 State* state = stack_.back().get();
84 XBT_DEBUG("**************************************************");
85 XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
88 api::get().mc_inc_visited_states();
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 /!\\");
97 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
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);
107 visited_state_ = nullptr;
112 // Search for the next transition
113 int next = state->next_transition();
115 if (next < 0) { // If there is no more transition in the current state, backtrack.
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);
120 if (mc_model_checker->get_remote_process().actors().empty())
121 mc_model_checker->finalize_app();
126 /* Actually answer the request: let execute the selected request (MCed does one step) */
127 auto remote_observer = state->transition_.execute(state, next);
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_.to_string().c_str());
134 if (dot_output != nullptr)
135 req_str = api::get().request_get_dot_output(state->transition_.aid_, state->transition_.times_considered_);
137 /* Create the new expanded state (copy the state of MCed into our MCer data) */
138 ++expanded_states_count_;
139 auto next_state = std::make_unique<State>(expanded_states_count_);
140 next_state->remote_observer_ = remote_observer;
142 if (_sg_mc_termination)
143 this->check_non_termination(next_state.get());
145 /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
146 if (_sg_mc_max_visited_states > 0)
147 visited_state_ = visited_states_.addVisitedState(expanded_states_count_, next_state.get(), true);
149 /* If this is a new state (or if we don't care about state-equality reduction) */
150 if (visited_state_ == nullptr) {
151 /* Get an enabled process and insert it in the interleave set of the next state */
152 auto actors = api::get().get_actors();
153 for (auto& remoteActor : actors) {
154 auto actor = remoteActor.copy.get_buffer();
155 if (get_session().actor_is_enabled(actor->get_pid())) {
156 next_state->mark_todo(actor->get_pid());
157 if (reductionMode_ == ReductionMode::dpor)
158 break; // With DPOR, we take the first enabled transition
162 if (dot_output != nullptr)
163 std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
165 } else if (dot_output != nullptr)
166 std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_,
167 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
170 stack_.push_back(std::move(next_state));
173 XBT_INFO("No property violation found.");
174 api::get().log_state();
177 void SafetyChecker::backtrack()
181 api::get().mc_check_deadlock();
183 /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
184 * have it empty in the way. For each deleted state, check if the request that has generated it (from its
185 * predecessor state), depends on any other previous request executed before it. If it does then add it to the
186 * interleave set of the state that executed that previous request. */
188 while (not stack_.empty()) {
189 std::unique_ptr<State> state = std::move(stack_.back());
191 if (reductionMode_ == ReductionMode::dpor) {
192 aid_t issuer_id = state->transition_.aid_;
193 for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
194 State* prev_state = i->get();
195 if (state->transition_.aid_ == prev_state->transition_.aid_) {
196 XBT_DEBUG("Simcall >>%s<< and >>%s<< with same issuer %ld", state->transition_.to_string().c_str(),
197 prev_state->transition_.to_string().c_str(), issuer_id);
199 } else if (api::get().requests_are_dependent(prev_state->remote_observer_, state->remote_observer_)) {
200 if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
201 XBT_DEBUG("Dependent Transitions:");
202 XBT_DEBUG(" %s (state=%d)", prev_state->transition_.to_string().c_str(), prev_state->num_);
203 XBT_DEBUG(" %s (state=%d)", state->transition_.to_string().c_str(), state->num_);
206 if (not prev_state->actor_states_[issuer_id].is_done())
207 prev_state->mark_todo(issuer_id);
209 XBT_DEBUG("Actor %ld is in done set", issuer_id);
212 if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
213 XBT_DEBUG("INDEPENDENT Transitions:");
214 XBT_DEBUG(" %s (state=%d)", prev_state->transition_.to_string().c_str(), prev_state->num_);
215 XBT_DEBUG(" %s (state=%d)", state->transition_.to_string().c_str(), state->num_);
221 if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
222 /* We found a back-tracking point, let's loop */
223 XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
224 stack_.push_back(std::move(state));
225 this->restore_state();
226 XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
229 XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
234 void SafetyChecker::restore_state()
236 /* Intermediate backtracking */
237 const State* last_state = stack_.back().get();
238 if (last_state->system_state_) {
239 api::get().restore_state(last_state->system_state_);
243 get_session().restore_initial_state();
245 /* Traverse the stack from the state at position start and re-execute the transitions */
246 for (std::unique_ptr<State> const& state : stack_) {
247 if (state == stack_.back())
249 state->transition_.replay();
250 /* Update statistics */
251 api::get().mc_inc_visited_states();
255 SafetyChecker::SafetyChecker(Session* session) : Checker(session)
257 reductionMode_ = reduction_mode;
258 if (_sg_mc_termination)
259 reductionMode_ = ReductionMode::none;
260 else if (reductionMode_ == ReductionMode::unset)
261 reductionMode_ = ReductionMode::dpor;
263 if (_sg_mc_termination)
264 XBT_INFO("Check non progressive cycles");
266 XBT_INFO("Check a safety property. Reduction is: %s.",
267 (reductionMode_ == ReductionMode::none ? "none"
268 : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
270 get_session().take_initial_snapshot();
272 XBT_DEBUG("Starting the safety algorithm");
274 ++expanded_states_count_;
275 auto initial_state = std::make_unique<State>(expanded_states_count_);
277 XBT_DEBUG("**************************************************");
279 /* Get an enabled actor and insert it in the interleave set of the initial state */
280 auto actors = api::get().get_actors();
281 XBT_DEBUG("Initial state. %zu actors to consider", actors.size());
282 for (auto& actor : actors) {
283 aid_t aid = actor.copy.get_buffer()->get_pid();
284 if (get_session().actor_is_enabled(aid)) {
285 initial_state->mark_todo(aid);
286 if (reductionMode_ == ReductionMode::dpor) {
287 XBT_DEBUG("Actor %ld is TODO, DPOR is ON so let's go for this one.", aid);
290 XBT_DEBUG("Actor %ld is TODO", aid);
294 stack_.push_back(std::move(initial_state));
297 Checker* create_safety_checker(Session* session)
299 return new SafetyChecker(session);
303 } // namespace simgrid