1 /* Copyright (c) 2016-2020. 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. */
14 #include <xbt/sysdep.h>
16 #include "src/mc/Session.hpp"
17 #include "src/mc/Transition.hpp"
18 #include "src/mc/VisitedState.hpp"
19 #include "src/mc/checker/SafetyChecker.hpp"
20 #include "src/mc/mc_config.hpp"
21 #include "src/mc/mc_exit.hpp"
22 #include "src/mc/mc_private.hpp"
23 #include "src/mc/mc_record.hpp"
24 #include "src/mc/mc_request.hpp"
25 #include "src/mc/mc_smx.hpp"
26 #include "src/mc/mc_api.hpp"
28 #include "src/xbt/mmalloc/mmprivate.h"
30 using mcapi = simgrid::mc::mc_api;
32 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety verification ");
37 void SafetyChecker::check_non_termination(const State* current_state)
39 for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
40 if (mcapi::get().snapshot_equal((*state)->system_state_.get(), current_state->system_state_.get())) {
41 XBT_INFO("Non-progressive cycle: state %d -> state %d", (*state)->num_, current_state->num_);
42 XBT_INFO("******************************************");
43 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
44 XBT_INFO("******************************************");
45 XBT_INFO("Counter-example execution trace:");
46 auto checker = mcapi::get().mc_get_checker();
47 for (auto const& s : checker->get_textual_trace())
48 XBT_INFO(" %s", s.c_str());
49 mcapi::get().mc_dump_record_path();
50 mcapi::get().log_state();
52 throw TerminationError();
56 RecordTrace SafetyChecker::get_record_trace() // override
59 for (auto const& state : stack_)
60 res.push_back(state->get_transition());
64 std::vector<std::string> SafetyChecker::get_textual_trace() // override
66 std::vector<std::string> trace;
67 for (auto const& state : stack_) {
68 int value = state->transition_.argument_;
69 smx_simcall_t req = &state->executed_req_;
70 trace.push_back(mcapi::get().request_to_string(req, value, RequestType::executed));
75 void SafetyChecker::log_state() // override
77 XBT_INFO("Expanded states = %lu", expanded_states_count_);
78 XBT_INFO("Visited states = %lu", mcapi::get().mc_get_visited_states());
79 XBT_INFO("Executed transitions = %lu", mcapi::get().mc_get_executed_trans());
82 void SafetyChecker::run()
84 /* This function runs the DFS algorithm the state space.
85 * We do so iteratively instead of recursively, dealing with the call stack manually.
86 * This allows one to explore the call stack at will. */
88 while (not stack_.empty()) {
89 /* Get current state */
90 State* state = stack_.back().get();
92 XBT_DEBUG("**************************************************");
93 XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
94 state->interleave_size());
96 mcapi::get().mc_inc_visited_states();
98 // Backtrack if we reached the maximum depth
99 if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
100 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
105 // Backtrack if we are revisiting a state we saw previously
106 if (visited_state_ != nullptr) {
107 XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.",
108 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
110 visited_state_ = nullptr;
115 // Search an enabled transition in the current state; backtrack if the interleave set is empty
116 // get_request also sets state.transition to be the one corresponding to the returned req
117 smx_simcall_t req = mcapi::get().mc_state_choose_request(state);
118 // req is now the transition of the process that was selected to be executed
120 if (req == nullptr) {
121 XBT_DEBUG("There are no more processes to interleave. (depth %zu)", stack_.size() + 1);
127 // If there are processes to interleave and the maximum depth has not been
128 // reached then perform one step of the exploration algorithm.
129 XBT_DEBUG("Execute: %s", mcapi::get().request_to_string(req, state->transition_.argument_, RequestType::simix).c_str());
132 if (dot_output != nullptr)
133 req_str = mcapi::get().request_get_dot_output(req, state->transition_.argument_);
135 mcapi::get().mc_inc_executed_trans();
137 /* Actually answer the request: let execute the selected request (MCed does one step) */
138 mcapi::get().execute(state->transition_);
140 /* Create the new expanded state (copy the state of MCed into our MCer data) */
141 ++expanded_states_count_;
142 auto next_state = std::make_unique<State>(expanded_states_count_);
144 if (_sg_mc_termination)
145 this->check_non_termination(next_state.get());
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);
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 = mcapi::get().get_actors();
155 for (auto& remoteActor : actors) {
156 auto actor = remoteActor.copy.get_buffer();
157 if (mcapi::get().actor_is_enabled(actor->get_pid())) {
158 next_state->add_interleaving_set(actor);
159 if (reductionMode_ == ReductionMode::dpor)
160 break; // With DPOR, we take the first enabled transition
164 if (dot_output != nullptr)
165 std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
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,
172 stack_.push_back(std::move(next_state));
175 XBT_INFO("No property violation found.");
176 mcapi::get().log_state();
179 void SafetyChecker::backtrack()
183 /* Check for deadlocks */
184 if (mcapi::get().mc_check_deadlock()) {
185 mcapi::get().mc_show_deadlock();
186 throw DeadlockError();
189 /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
190 * have it empty in the way. For each deleted state, check if the request that has generated it (from its
191 * predecessor state), depends on any other previous request executed before it. If it does then add it to the
192 * interleave set of the state that executed that previous request. */
194 while (not stack_.empty()) {
195 std::unique_ptr<State> state = std::move(stack_.back());
197 if (reductionMode_ == ReductionMode::dpor) {
198 smx_simcall_t req = &state->internal_req_;
199 if (req->call_ == simix::Simcall::MUTEX_LOCK || req->call_ == simix::Simcall::MUTEX_TRYLOCK)
200 xbt_die("Mutex is currently not supported with DPOR, use --cfg=model-check/reduction:none");
202 const kernel::actor::ActorImpl* issuer = mcapi::get().mc_smx_simcall_get_issuer(req);
203 for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
204 State* prev_state = i->get();
205 if (mcapi::get().request_depend(req, &prev_state->internal_req_)) {
206 if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
207 XBT_DEBUG("Dependent Transitions:");
208 int value = prev_state->transition_.argument_;
209 smx_simcall_t prev_req = &prev_state->executed_req_;
210 XBT_DEBUG("%s (state=%d)", mcapi::get().request_to_string(prev_req, value, RequestType::internal).c_str(),
212 value = state->transition_.argument_;
213 prev_req = &state->executed_req_;
214 XBT_DEBUG("%s (state=%d)", mcapi::get().request_to_string(prev_req, value, RequestType::executed).c_str(),
218 if (not prev_state->actor_states_[issuer->get_pid()].is_done())
219 prev_state->add_interleaving_set(issuer);
221 XBT_DEBUG("Process %p is in done set", req->issuer_);
223 } else if (req->issuer_ == prev_state->internal_req_.issuer_) {
224 XBT_DEBUG("Simcall %s and %s with same issuer", mcapi::get().simix_simcall_name(req->call_),
225 mcapi::get().simix_simcall_name(prev_state->internal_req_.call_));
228 const kernel::actor::ActorImpl* previous_issuer = mcapi::get().mc_smx_simcall_get_issuer(&prev_state->internal_req_);
229 XBT_DEBUG("Simcall %s, process %ld (state %d) and simcall %s, process %ld (state %d) are independent",
230 mcapi::get().simix_simcall_name(req->call_), issuer->get_pid(), state->num_,
231 mcapi::get().simix_simcall_name(prev_state->internal_req_.call_), previous_issuer->get_pid(), prev_state->num_);
236 if (state->interleave_size() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
237 /* We found a back-tracking point, let's loop */
238 XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
239 stack_.push_back(std::move(state));
240 this->restore_state();
241 XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
244 XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
249 void SafetyChecker::restore_state()
251 /* Intermediate backtracking */
252 const State* last_state = stack_.back().get();
253 if (last_state->system_state_) {
254 mc_api::get().restore_state(last_state->system_state_);
258 /* Restore the initial state */
259 mcapi::get().s_restore_initial_state();
261 /* Traverse the stack from the state at position start and re-execute the transitions */
262 for (std::unique_ptr<State> const& state : stack_) {
263 if (state == stack_.back())
265 mcapi::get().execute(state->transition_);
266 /* Update statistics */
267 mcapi::get().mc_inc_visited_states();
268 mcapi::get().mc_inc_executed_trans();
272 SafetyChecker::SafetyChecker(Session& s) : Checker(s)
274 reductionMode_ = reduction_mode;
275 if (_sg_mc_termination)
276 reductionMode_ = ReductionMode::none;
277 else if (reductionMode_ == ReductionMode::unset)
278 reductionMode_ = ReductionMode::dpor;
280 if (_sg_mc_termination)
281 XBT_INFO("Check non progressive cycles");
283 XBT_INFO("Check a safety property. Reduction is: %s.",
284 (reductionMode_ == ReductionMode::none ? "none"
285 : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
287 mcapi::get().s_initialize();
289 XBT_DEBUG("Starting the safety algorithm");
291 ++expanded_states_count_;
292 auto initial_state = std::make_unique<State>(expanded_states_count_);
294 XBT_DEBUG("**************************************************");
295 XBT_DEBUG("Initial state");
297 /* Get an enabled actor and insert it in the interleave set of the initial state */
298 auto actors = mcapi::get().get_actors();
299 for (auto& actor : actors)
300 if (mcapi::get().actor_is_enabled(actor.copy.get_buffer()->get_pid())) {
301 initial_state->add_interleaving_set(actor.copy.get_buffer());
302 if (reductionMode_ != ReductionMode::none)
306 stack_.push_back(std::move(initial_state));
309 Checker* createSafetyChecker(Session& s)
311 return new SafetyChecker(s);
315 } // namespace simgrid