1 /* Copyright (c) 2008-2019. 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/checker/CommunicationDeterminismChecker.hpp"
7 #include "src/kernel/activity/MailboxImpl.hpp"
8 #include "src/mc/VisitedState.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/mc_request.hpp"
13 #include "src/mc/mc_smx.hpp"
14 #include "src/mc/mc_state.hpp"
15 #include "src/mc/remote/Client.hpp"
18 #include "smpi_request.hpp"
23 using simgrid::mc::remote;
25 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_comm_determinism, mc, "Logging specific to MC communication determinism detection");
27 /********** Global variables **********/
29 std::vector<simgrid::mc::PatternCommunicationList> initial_communications_pattern;
30 std::vector<std::vector<simgrid::mc::PatternCommunication*>> incomplete_communications_pattern;
32 /********** Static functions ***********/
34 static e_mc_comm_pattern_difference_t compare_comm_pattern(simgrid::mc::PatternCommunication* comm1,
35 simgrid::mc::PatternCommunication* comm2)
37 if(comm1->type != comm2->type)
39 if (comm1->rdv != comm2->rdv)
41 if (comm1->src_proc != comm2->src_proc)
43 if (comm1->dst_proc != comm2->dst_proc)
45 if (comm1->tag != comm2->tag)
47 if (comm1->data.size() != comm2->data.size())
48 return DATA_SIZE_DIFF;
49 if (comm1->data != comm2->data)
54 static char* print_determinism_result(e_mc_comm_pattern_difference_t diff, int process,
55 simgrid::mc::PatternCommunication* comm, unsigned int cursor)
60 if (comm->type == simgrid::mc::PatternCommunicationType::send)
61 type = bprintf("The send communications pattern of the process %d is different!", process - 1);
63 type = bprintf("The recv communications pattern of the process %d is different!", process - 1);
67 res = bprintf("%s Different type for communication #%u", type, cursor);
70 res = bprintf("%s Different rdv for communication #%u", type, cursor);
73 res = bprintf("%s Different tag for communication #%u", type, cursor);
76 res = bprintf("%s Different source for communication #%u", type, cursor);
79 res = bprintf("%s Different destination for communication #%u", type, cursor);
82 res = bprintf("%s\n Different data size for communication #%u", type, cursor);
85 res = bprintf("%s\n Different data for communication #%u", type, cursor);
95 static void update_comm_pattern(simgrid::mc::PatternCommunication* comm_pattern,
96 simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> comm_addr)
99 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
100 mc_model_checker->process().read(temp_comm, comm_addr);
101 simgrid::kernel::activity::CommImpl* comm = temp_comm.getBuffer();
103 smx_actor_t src_proc = mc_model_checker->process().resolveActor(simgrid::mc::remote(comm->src_actor_.get()));
104 smx_actor_t dst_proc = mc_model_checker->process().resolveActor(simgrid::mc::remote(comm->dst_actor_.get()));
105 comm_pattern->src_proc = src_proc->get_pid();
106 comm_pattern->dst_proc = dst_proc->get_pid();
107 comm_pattern->src_host = MC_smx_actor_get_host_name(src_proc);
108 comm_pattern->dst_host = MC_smx_actor_get_host_name(dst_proc);
109 if (comm_pattern->data.size() == 0 && comm->src_buff_ != nullptr) {
111 mc_model_checker->process().read(&buff_size, remote(comm->dst_buff_size_));
112 comm_pattern->data.resize(buff_size);
113 mc_model_checker->process().read_bytes(comm_pattern->data.data(), comm_pattern->data.size(),
114 remote(comm->src_buff_));
121 void CommunicationDeterminismChecker::deterministic_comm_pattern(int process, simgrid::mc::PatternCommunication* comm,
124 simgrid::mc::PatternCommunicationList& list = initial_communications_pattern[process];
126 if (not backtracking) {
127 e_mc_comm_pattern_difference_t diff = compare_comm_pattern(list.list[list.index_comm].get(), comm);
129 if (diff != NONE_DIFF) {
130 if (comm->type == simgrid::mc::PatternCommunicationType::send) {
131 this->send_deterministic = 0;
132 if (this->send_diff != nullptr)
133 xbt_free(this->send_diff);
134 this->send_diff = print_determinism_result(diff, process, comm, list.index_comm + 1);
136 this->recv_deterministic = 0;
137 if (this->recv_diff != nullptr)
138 xbt_free(this->recv_diff);
139 this->recv_diff = print_determinism_result(diff, process, comm, list.index_comm + 1);
141 if (_sg_mc_send_determinism && not this->send_deterministic) {
142 XBT_INFO("*********************************************************");
143 XBT_INFO("***** Non-send-deterministic communications pattern *****");
144 XBT_INFO("*********************************************************");
145 XBT_INFO("%s", this->send_diff);
146 xbt_free(this->send_diff);
147 this->send_diff = nullptr;
148 simgrid::mc::session->logState();
149 mc_model_checker->exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
150 } else if (_sg_mc_comms_determinism && (not this->send_deterministic && not this->recv_deterministic)) {
151 XBT_INFO("****************************************************");
152 XBT_INFO("***** Non-deterministic communications pattern *****");
153 XBT_INFO("****************************************************");
154 XBT_INFO("%s", this->send_diff);
155 XBT_INFO("%s", this->recv_diff);
156 xbt_free(this->send_diff);
157 this->send_diff = nullptr;
158 xbt_free(this->recv_diff);
159 this->recv_diff = nullptr;
160 simgrid::mc::session->logState();
161 mc_model_checker->exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
167 /********** Non Static functions ***********/
169 void CommunicationDeterminismChecker::get_comm_pattern(smx_simcall_t request, e_mc_call_type_t call_type,
172 const smx_actor_t issuer = MC_smx_simcall_get_issuer(request);
173 const simgrid::mc::PatternCommunicationList& initial_pattern = initial_communications_pattern[issuer->get_pid()];
174 const std::vector<simgrid::mc::PatternCommunication*>& incomplete_pattern =
175 incomplete_communications_pattern[issuer->get_pid()];
177 std::unique_ptr<simgrid::mc::PatternCommunication> pattern(new simgrid::mc::PatternCommunication());
178 pattern->index = initial_pattern.index_comm + incomplete_pattern.size();
180 if (call_type == MC_CALL_TYPE_SEND) {
181 /* Create comm pattern */
182 pattern->type = simgrid::mc::PatternCommunicationType::send;
183 pattern->comm_addr = static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_isend__getraw__result(request));
185 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_synchro;
186 mc_model_checker->process().read(temp_synchro,
187 remote(static_cast<simgrid::kernel::activity::CommImpl*>(pattern->comm_addr)));
188 simgrid::kernel::activity::CommImpl* synchro =
189 static_cast<simgrid::kernel::activity::CommImpl*>(temp_synchro.getBuffer());
191 char* remote_name = mc_model_checker->process().read<char*>(RemotePtr<char*>(
192 (uint64_t)(synchro->get_mailbox() ? &synchro->get_mailbox()->name_ : &synchro->mbox_cpy->name_)));
193 pattern->rdv = mc_model_checker->process().read_string(RemotePtr<char>(remote_name));
195 mc_model_checker->process().resolveActor(simgrid::mc::remote(synchro->src_actor_.get()))->get_pid();
196 pattern->src_host = MC_smx_actor_get_host_name(issuer);
199 simgrid::smpi::Request mpi_request;
200 mc_model_checker->process().read(
201 &mpi_request, remote(static_cast<simgrid::smpi::Request*>(simcall_comm_isend__get__data(request))));
202 pattern->tag = mpi_request.tag();
205 if (synchro->src_buff_ != nullptr) {
206 pattern->data.resize(synchro->src_buff_size_);
207 mc_model_checker->process().read_bytes(pattern->data.data(), pattern->data.size(), remote(synchro->src_buff_));
210 if(mpi_request.detached()){
211 if (not this->initial_communications_pattern_done) {
212 /* Store comm pattern */
213 initial_communications_pattern[pattern->src_proc].list.push_back(std::move(pattern));
215 /* Evaluate comm determinism */
216 this->deterministic_comm_pattern(pattern->src_proc, pattern.get(), backtracking);
217 initial_communications_pattern[pattern->src_proc].index_comm++;
222 } else if (call_type == MC_CALL_TYPE_RECV) {
223 pattern->type = simgrid::mc::PatternCommunicationType::receive;
224 pattern->comm_addr = static_cast<simgrid::kernel::activity::CommImpl*>(simcall_comm_irecv__getraw__result(request));
227 simgrid::smpi::Request mpi_request;
228 mc_model_checker->process().read(
229 &mpi_request, remote(static_cast<simgrid::smpi::Request*>(simcall_comm_irecv__get__data(request))));
230 pattern->tag = mpi_request.tag();
233 simgrid::mc::Remote<simgrid::kernel::activity::CommImpl> temp_comm;
234 mc_model_checker->process().read(temp_comm,
235 remote(static_cast<simgrid::kernel::activity::CommImpl*>(pattern->comm_addr)));
236 simgrid::kernel::activity::CommImpl* comm = temp_comm.getBuffer();
239 mc_model_checker->process().read(&remote_name,
240 remote(comm->get_mailbox()
241 ? &simgrid::xbt::string::to_string_data(comm->get_mailbox()->name_).data
242 : &simgrid::xbt::string::to_string_data(comm->mbox_cpy->name_).data));
243 pattern->rdv = mc_model_checker->process().read_string(RemotePtr<char>(remote_name));
245 mc_model_checker->process().resolveActor(simgrid::mc::remote(comm->dst_actor_.get()))->get_pid();
246 pattern->dst_host = MC_smx_actor_get_host_name(issuer);
248 xbt_die("Unexpected call_type %i", (int) call_type);
250 XBT_DEBUG("Insert incomplete comm pattern %p for process %ld", pattern.get(), issuer->get_pid());
251 incomplete_communications_pattern[issuer->get_pid()].push_back(pattern.release());
254 void CommunicationDeterminismChecker::complete_comm_pattern(
255 simgrid::mc::RemotePtr<simgrid::kernel::activity::CommImpl> comm_addr, unsigned int issuer, int backtracking)
257 /* Complete comm pattern */
258 std::vector<simgrid::mc::PatternCommunication*>& incomplete_pattern = incomplete_communications_pattern[issuer];
259 auto current_comm_pattern = std::find_if(
260 begin(incomplete_pattern), end(incomplete_pattern),
261 [&comm_addr](simgrid::mc::PatternCommunication* comm) { return remote(comm->comm_addr) == comm_addr; });
262 if (current_comm_pattern == std::end(incomplete_pattern))
263 xbt_die("Corresponding communication not found!");
265 update_comm_pattern(*current_comm_pattern, comm_addr);
266 std::unique_ptr<simgrid::mc::PatternCommunication> comm_pattern(*current_comm_pattern);
267 XBT_DEBUG("Remove incomplete comm pattern for process %u at cursor %zd", issuer,
268 std::distance(begin(incomplete_pattern), current_comm_pattern));
269 incomplete_pattern.erase(current_comm_pattern);
271 if (not this->initial_communications_pattern_done)
272 /* Store comm pattern */
273 initial_communications_pattern[issuer].list.push_back(std::move(comm_pattern));
275 /* Evaluate comm determinism */
276 this->deterministic_comm_pattern(issuer, comm_pattern.get(), backtracking);
277 initial_communications_pattern[issuer].index_comm++;
281 CommunicationDeterminismChecker::CommunicationDeterminismChecker(Session& s) : Checker(s)
285 CommunicationDeterminismChecker::~CommunicationDeterminismChecker() = default;
287 RecordTrace CommunicationDeterminismChecker::getRecordTrace() // override
290 for (auto const& state : stack_)
291 res.push_back(state->getTransition());
295 std::vector<std::string> CommunicationDeterminismChecker::getTextualTrace() // override
297 std::vector<std::string> trace;
298 for (auto const& state : stack_) {
299 smx_simcall_t req = &state->executed_req;
302 simgrid::mc::request_to_string(req, state->transition.argument, simgrid::mc::RequestType::executed));
307 void CommunicationDeterminismChecker::logState() // override
309 if (_sg_mc_comms_determinism && not this->recv_deterministic && this->send_deterministic) {
310 XBT_INFO("******************************************************");
311 XBT_INFO("**** Only-send-deterministic communication pattern ****");
312 XBT_INFO("******************************************************");
313 XBT_INFO("%s", this->recv_diff);
314 } else if (_sg_mc_comms_determinism && not this->send_deterministic && this->recv_deterministic) {
315 XBT_INFO("******************************************************");
316 XBT_INFO("**** Only-recv-deterministic communication pattern ****");
317 XBT_INFO("******************************************************");
318 XBT_INFO("%s", this->send_diff);
320 XBT_INFO("Expanded states = %lu", expandedStatesCount_);
321 XBT_INFO("Visited states = %lu", mc_model_checker->visited_states);
322 XBT_INFO("Executed transitions = %lu", mc_model_checker->executed_transitions);
323 XBT_INFO("Send-deterministic : %s", not this->send_deterministic ? "No" : "Yes");
324 if (_sg_mc_comms_determinism)
325 XBT_INFO("Recv-deterministic : %s", not this->recv_deterministic ? "No" : "Yes");
328 void CommunicationDeterminismChecker::prepare()
330 const int maxpid = MC_smx_get_maxpid();
332 initial_communications_pattern.resize(maxpid);
333 incomplete_communications_pattern.resize(maxpid);
335 std::unique_ptr<simgrid::mc::State> initial_state =
336 std::unique_ptr<simgrid::mc::State>(new simgrid::mc::State(++expandedStatesCount_));
338 XBT_DEBUG("********* Start communication determinism verification *********");
340 /* Get an enabled actor and insert it in the interleave set of the initial state */
341 for (auto& actor : mc_model_checker->process().actors())
342 if (simgrid::mc::actor_is_enabled(actor.copy.getBuffer()))
343 initial_state->addInterleavingSet(actor.copy.getBuffer());
345 stack_.push_back(std::move(initial_state));
348 static inline bool all_communications_are_finished()
350 for (size_t current_actor = 1; current_actor < MC_smx_get_maxpid(); current_actor++) {
351 if (not incomplete_communications_pattern[current_actor].empty()) {
352 XBT_DEBUG("Some communications are not finished, cannot stop the exploration! State not visited.");
359 void CommunicationDeterminismChecker::restoreState()
361 /* Intermediate backtracking */
362 simgrid::mc::State* last_state = stack_.back().get();
363 if (last_state->system_state) {
364 simgrid::mc::restore_snapshot(last_state->system_state);
365 MC_restore_communications_pattern(last_state);
369 /* Restore the initial state */
370 simgrid::mc::session->restoreInitialState();
372 unsigned n = MC_smx_get_maxpid();
373 assert(n == incomplete_communications_pattern.size());
374 assert(n == initial_communications_pattern.size());
375 for (unsigned j=0; j < n ; j++) {
376 incomplete_communications_pattern[j].clear();
377 initial_communications_pattern[j].index_comm = 0;
380 /* Traverse the stack from the state at position start and re-execute the transitions */
381 for (std::unique_ptr<simgrid::mc::State> const& state : stack_) {
382 if (state == stack_.back())
385 int req_num = state->transition.argument;
386 smx_simcall_t saved_req = &state->executed_req;
387 xbt_assert(saved_req);
389 /* because we got a copy of the executed request, we have to fetch the
390 real one, pointed by the request field of the issuer process */
392 const smx_actor_t issuer = MC_smx_simcall_get_issuer(saved_req);
393 smx_simcall_t req = &issuer->simcall;
395 /* TODO : handle test and testany simcalls */
396 e_mc_call_type_t call = MC_get_call_type(req);
397 mc_model_checker->handle_simcall(state->transition);
398 MC_handle_comm_pattern(call, req, req_num, 1);
399 mc_model_checker->wait_for_requests();
401 /* Update statistics */
402 mc_model_checker->visited_states++;
403 mc_model_checker->executed_transitions++;
407 void CommunicationDeterminismChecker::real_run()
409 std::unique_ptr<simgrid::mc::VisitedState> visited_state = nullptr;
410 smx_simcall_t req = nullptr;
412 while (not stack_.empty()) {
413 /* Get current state */
414 simgrid::mc::State* cur_state = stack_.back().get();
416 XBT_DEBUG("**************************************************");
417 XBT_DEBUG("Exploration depth = %zu (state = %d, interleaved processes = %zu)", stack_.size(), cur_state->num,
418 cur_state->interleaveSize());
420 /* Update statistics */
421 mc_model_checker->visited_states++;
423 if (stack_.size() <= (std::size_t)_sg_mc_max_depth)
424 req = MC_state_get_request(cur_state);
428 if (req != nullptr && visited_state == nullptr) {
430 int req_num = cur_state->transition.argument;
432 XBT_DEBUG("Execute: %s", simgrid::mc::request_to_string(req, req_num, simgrid::mc::RequestType::simix).c_str());
435 if (dot_output != nullptr)
436 req_str = simgrid::mc::request_get_dot_output(req, req_num);
438 mc_model_checker->executed_transitions++;
440 /* TODO : handle test and testany simcalls */
441 e_mc_call_type_t call = MC_CALL_TYPE_NONE;
442 if (_sg_mc_comms_determinism || _sg_mc_send_determinism)
443 call = MC_get_call_type(req);
445 /* Answer the request */
446 mc_model_checker->handle_simcall(cur_state->transition);
447 /* After this call req is no longer useful */
449 MC_handle_comm_pattern(call, req, req_num, 0);
451 /* Wait for requests (schedules processes) */
452 mc_model_checker->wait_for_requests();
454 /* Create the new expanded state */
455 std::unique_ptr<simgrid::mc::State> next_state =
456 std::unique_ptr<simgrid::mc::State>(new simgrid::mc::State(++expandedStatesCount_));
458 /* If comm determinism verification, we cannot stop the exploration if some communications are not finished (at
459 * least, data are transferred). These communications are incomplete and they cannot be analyzed and compared
460 * with the initial pattern. */
461 bool compare_snapshots = all_communications_are_finished() && this->initial_communications_pattern_done;
463 if (_sg_mc_max_visited_states != 0)
464 visited_state = visitedStates_.addVisitedState(expandedStatesCount_, next_state.get(), compare_snapshots);
466 visited_state = nullptr;
468 if (visited_state == nullptr) {
470 /* Get enabled actors and insert them in the interleave set of the next state */
471 for (auto& actor : mc_model_checker->process().actors())
472 if (simgrid::mc::actor_is_enabled(actor.copy.getBuffer()))
473 next_state->addInterleavingSet(actor.copy.getBuffer());
475 if (dot_output != nullptr)
476 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", cur_state->num, next_state->num, req_str.c_str());
478 } else if (dot_output != nullptr)
479 fprintf(dot_output, "\"%d\" -> \"%d\" [%s];\n", cur_state->num,
480 visited_state->original_num == -1 ? visited_state->num : visited_state->original_num, req_str.c_str());
482 stack_.push_back(std::move(next_state));
486 if (stack_.size() > (std::size_t) _sg_mc_max_depth)
487 XBT_WARN("/!\\ Max depth reached! /!\\ ");
488 else if (visited_state != nullptr)
489 XBT_DEBUG("State already visited (equal to state %d), exploration stopped on this path.",
490 visited_state->original_num == -1 ? visited_state->num : visited_state->original_num);
492 XBT_DEBUG("There are no more processes to interleave. (depth %zu)", stack_.size());
494 if (not this->initial_communications_pattern_done)
495 this->initial_communications_pattern_done = 1;
497 /* Trash the current state, no longer needed */
498 XBT_DEBUG("Delete state %d at depth %zu", cur_state->num, stack_.size());
501 visited_state = nullptr;
503 /* Check for deadlocks */
504 if (mc_model_checker->checkDeadlock()) {
506 throw simgrid::mc::DeadlockError();
509 while (not stack_.empty()) {
510 std::unique_ptr<simgrid::mc::State> state = std::move(stack_.back());
512 if (state->interleaveSize() && stack_.size() < (std::size_t)_sg_mc_max_depth) {
513 /* We found a back-tracking point, let's loop */
514 XBT_DEBUG("Back-tracking to state %d at depth %zu", state->num, stack_.size() + 1);
515 stack_.push_back(std::move(state));
517 this->restoreState();
519 XBT_DEBUG("Back-tracking to state %d at depth %zu done", stack_.back()->num, stack_.size());
523 XBT_DEBUG("Delete state %d at depth %zu", state->num, stack_.size() + 1);
529 simgrid::mc::session->logState();
532 void CommunicationDeterminismChecker::run()
534 XBT_INFO("Check communication determinism");
535 simgrid::mc::session->initialize();
542 Checker* createCommunicationDeterminismChecker(Session& s)
544 return new CommunicationDeterminismChecker(s);