1 /* Copyright (c) 2016-2021. 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/Transition.hpp"
17 #include "src/mc/VisitedState.hpp"
18 #include "src/mc/checker/SafetyChecker.hpp"
19 #include "src/mc/mc_config.hpp"
20 #include "src/mc/mc_exit.hpp"
21 #include "src/mc/mc_private.hpp"
22 #include "src/mc/mc_record.hpp"
23 #include "src/mc/mc_request.hpp"
25 #include "src/xbt/mmalloc/mmprivate.h"
27 using api = simgrid::mc::Api;
29 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_safety, mc, "Logging specific to MC safety verification ");
34 void SafetyChecker::check_non_termination(const State* current_state)
36 for (auto state = stack_.rbegin(); state != stack_.rend(); ++state)
37 if (api::get().snapshot_equal((*state)->system_state_.get(), current_state->system_state_.get())) {
38 XBT_INFO("Non-progressive cycle: state %d -> state %d", (*state)->num_, current_state->num_);
39 XBT_INFO("******************************************");
40 XBT_INFO("*** NON-PROGRESSIVE CYCLE DETECTED ***");
41 XBT_INFO("******************************************");
42 XBT_INFO("Counter-example execution trace:");
43 auto checker = api::get().mc_get_checker();
44 for (auto const& s : checker->get_textual_trace())
45 XBT_INFO(" %s", s.c_str());
46 api::get().dump_record_path();
47 api::get().log_state();
49 throw TerminationError();
53 RecordTrace SafetyChecker::get_record_trace() // override
56 for (auto const& state : stack_)
57 res.push_back(state->get_transition());
61 std::vector<std::string> SafetyChecker::get_textual_trace() // override
63 std::vector<std::string> trace;
64 for (auto const& state : stack_)
65 trace.push_back(state->transition_.textual);
69 void SafetyChecker::log_state() // override
71 XBT_INFO("Expanded states = %lu", expanded_states_count_);
72 XBT_INFO("Visited states = %lu", api::get().mc_get_visited_states());
73 XBT_INFO("Executed transitions = %lu", api::get().mc_get_executed_trans());
76 void SafetyChecker::run()
78 /* This function runs the DFS algorithm the state space.
79 * We do so iteratively instead of recursively, dealing with the call stack manually.
80 * This allows one to explore the call stack at will. */
82 while (not stack_.empty()) {
83 /* Get current state */
84 State* state = stack_.back().get();
86 XBT_DEBUG("**************************************************");
87 XBT_VERB("Exploration depth=%zu (state=%p, num %d)(%zu interleave)", stack_.size(), state, state->num_,
90 api::get().mc_inc_visited_states();
92 // Backtrack if we reached the maximum depth
93 if (stack_.size() > (std::size_t)_sg_mc_max_depth) {
94 XBT_WARN("/!\\ Max depth reached ! /!\\ ");
99 // Backtrack if we are revisiting a state we saw previously
100 if (visited_state_ != nullptr) {
101 XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.",
102 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num);
104 visited_state_ = nullptr;
109 // Search an enabled transition in the current state; backtrack if the interleave set is empty
110 // get_request also sets state.transition to be the one corresponding to the returned req
111 smx_simcall_t req = api::get().mc_state_choose_request(state);
112 // req is now the transition of the process that was selected to be executed
114 if (req == nullptr) {
115 XBT_DEBUG("There are no more processes to interleave. (depth %zu)", stack_.size() + 1);
121 // If there are processes to interleave and the maximum depth has not been
122 // reached then perform one step of the exploration algorithm.
123 XBT_DEBUG("Execute: %s",
124 api::get().request_to_string(req, state->transition_.times_considered_, RequestType::simix).c_str());
127 if (dot_output != nullptr)
128 req_str = api::get().request_get_dot_output(req, state->transition_.times_considered_);
130 api::get().mc_inc_executed_trans();
132 /* Actually answer the request: let execute the selected request (MCed does one step) */
133 api::get().execute(state->transition_, &state->executed_req_);
135 /* Create the new expanded state (copy the state of MCed into our MCer data) */
136 ++expanded_states_count_;
137 auto next_state = std::make_unique<State>(expanded_states_count_);
139 if (_sg_mc_termination)
140 this->check_non_termination(next_state.get());
142 /* Check whether we already explored next_state in the past (but only if interested in state-equality reduction) */
143 if (_sg_mc_max_visited_states > 0)
144 visited_state_ = visited_states_.addVisitedState(expanded_states_count_, next_state.get(), true);
146 /* If this is a new state (or if we don't care about state-equality reduction) */
147 if (visited_state_ == nullptr) {
148 /* Get an enabled process and insert it in the interleave set of the next state */
149 auto actors = api::get().get_actors();
150 for (auto& remoteActor : actors) {
151 auto actor = remoteActor.copy.get_buffer();
152 if (api::get().actor_is_enabled(actor->get_pid())) {
153 next_state->mark_todo(actor);
154 if (reductionMode_ == ReductionMode::dpor)
155 break; // With DPOR, we take the first enabled transition
159 if (dot_output != nullptr)
160 std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_, next_state->num_, req_str.c_str());
162 } else if (dot_output != nullptr)
163 std::fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", state->num_,
164 visited_state_->original_num == -1 ? visited_state_->num : visited_state_->original_num,
167 stack_.push_back(std::move(next_state));
170 XBT_INFO("No property violation found.");
171 api::get().log_state();
174 void SafetyChecker::backtrack()
178 api::get().mc_check_deadlock();
180 /* Traverse the stack backwards until a state with a non empty interleave set is found, deleting all the states that
181 * have it empty in the way. For each deleted state, check if the request that has generated it (from its
182 * predecessor state), depends on any other previous request executed before it. If it does then add it to the
183 * interleave set of the state that executed that previous request. */
185 while (not stack_.empty()) {
186 std::unique_ptr<State> state = std::move(stack_.back());
188 if (reductionMode_ == ReductionMode::dpor) {
189 smx_simcall_t req = &state->internal_req_;
190 if (req->call_ == simix::Simcall::MUTEX_LOCK || req->call_ == simix::Simcall::MUTEX_TRYLOCK)
191 xbt_die("Mutex is currently not supported with DPOR, use --cfg=model-check/reduction:none");
193 const kernel::actor::ActorImpl* issuer = api::get().simcall_get_issuer(req);
194 for (auto i = stack_.rbegin(); i != stack_.rend(); ++i) {
195 State* prev_state = i->get();
196 if (api::get().simcall_check_dependency(req, &prev_state->internal_req_)) {
197 if (XBT_LOG_ISENABLED(mc_safety, xbt_log_priority_debug)) {
198 XBT_DEBUG("Dependent Transitions:");
199 int value = prev_state->transition_.times_considered_;
200 smx_simcall_t prev_req = &prev_state->executed_req_;
201 XBT_DEBUG("%s (state=%d)", api::get().request_to_string(prev_req, value, RequestType::internal).c_str(),
203 value = state->transition_.times_considered_;
204 prev_req = &state->executed_req_;
205 XBT_DEBUG("%s (state=%d)", api::get().request_to_string(prev_req, value, RequestType::executed).c_str(),
209 if (not prev_state->actor_states_[issuer->get_pid()].is_done())
210 prev_state->mark_todo(issuer);
212 XBT_DEBUG("Process %p is in done set", req->issuer_);
214 } else if (req->issuer_ == prev_state->internal_req_.issuer_) {
215 XBT_DEBUG("Simcall %s and %s with same issuer", SIMIX_simcall_name(req->call_),
216 SIMIX_simcall_name(prev_state->internal_req_.call_));
219 const kernel::actor::ActorImpl* previous_issuer = api::get().simcall_get_issuer(&prev_state->internal_req_);
220 XBT_DEBUG("Simcall %s, process %ld (state %d) and simcall %s, process %ld (state %d) are independent",
221 SIMIX_simcall_name(req->call_), issuer->get_pid(), state->num_,
222 SIMIX_simcall_name(prev_state->internal_req_.call_), previous_issuer->get_pid(), prev_state->num_);
227 if (state->count_todo() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
228 /* We found a back-tracking point, let's loop */
229 XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num_, stack_.size() + 1);
230 stack_.push_back(std::move(state));
231 this->restore_state();
232 XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num_, stack_.size());
235 XBT_DEBUG("Delete state %d at depth %zu", state->num_, stack_.size() + 1);
240 void SafetyChecker::restore_state()
242 /* Intermediate backtracking */
243 const State* last_state = stack_.back().get();
244 if (last_state->system_state_) {
245 api::get().restore_state(last_state->system_state_);
249 /* Restore the initial state */
250 api::get().restore_initial_state();
252 /* Traverse the stack from the state at position start and re-execute the transitions */
253 for (std::unique_ptr<State> const& state : stack_) {
254 if (state == stack_.back())
256 api::get().execute(state->transition_, &state->executed_req_);
257 /* Update statistics */
258 api::get().mc_inc_visited_states();
259 api::get().mc_inc_executed_trans();
263 SafetyChecker::SafetyChecker() : Checker()
265 reductionMode_ = reduction_mode;
266 if (_sg_mc_termination)
267 reductionMode_ = ReductionMode::none;
268 else if (reductionMode_ == ReductionMode::unset)
269 reductionMode_ = ReductionMode::dpor;
271 if (_sg_mc_termination)
272 XBT_INFO("Check non progressive cycles");
274 XBT_INFO("Check a safety property. Reduction is: %s.",
275 (reductionMode_ == ReductionMode::none ? "none"
276 : (reductionMode_ == ReductionMode::dpor ? "dpor" : "unknown")));
278 api::get().session_initialize();
280 XBT_DEBUG("Starting the safety algorithm");
282 ++expanded_states_count_;
283 auto initial_state = std::make_unique<State>(expanded_states_count_);
285 XBT_DEBUG("**************************************************");
286 XBT_DEBUG("Initial state");
288 /* Get an enabled actor and insert it in the interleave set of the initial state */
289 auto actors = api::get().get_actors();
290 for (auto& actor : actors)
291 if (api::get().actor_is_enabled(actor.copy.get_buffer()->get_pid())) {
292 initial_state->mark_todo(actor.copy.get_buffer());
293 if (reductionMode_ != ReductionMode::none)
297 stack_.push_back(std::move(initial_state));
300 Checker* createSafetyChecker()
302 return new SafetyChecker();
306 } // namespace simgrid