src/mc/explo/CommunicationDeterminismChecker.cpp

   1 /* Copyright (c) 2008-2023. 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/kernel/activity/MailboxImpl.hpp"
   7 #include "src/mc/explo/DFSExplorer.hpp"
   8 #include "src/mc/mc_config.hpp"
   9 #include "src/mc/mc_exit.hpp"
  10 #include "src/mc/mc_forward.hpp"
  11 #include "src/mc/mc_private.hpp"
  12 #include "src/mc/transition/TransitionAny.hpp"
  13 #include "src/mc/transition/TransitionComm.hpp"
  14 #include "xbt/string.hpp"
  15
  16 #include <cstdint>
  17
  18 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_comm_determinism, mc, "Logging specific to MC communication determinism detection");
  19
  20 namespace simgrid::mc {
  21
  22 enum class CallType { NONE, SEND, RECV, WAIT, WAITANY };
  23 enum class CommPatternDifference { NONE, TYPE, MBOX, TAG, SRC_PROC, DST_PROC, DATA_SIZE };
  24 enum class PatternCommunicationType {
  25   none    = 0,
  26   send    = 1,
  27   receive = 2,
  28 };
  29
  30 class PatternCommunication {
  31 public:
  32   int num                       = 0;
  33   uintptr_t comm_addr           = 0;
  34   PatternCommunicationType type = PatternCommunicationType::send;
  35   unsigned long src_proc        = 0;
  36   unsigned long dst_proc        = 0;
  37   unsigned mbox                 = 0;
  38   unsigned size                 = 0;
  39   int tag                       = 0;
  40   int index                     = 0;
  41
  42   PatternCommunication dup() const
  43   {
  44     simgrid::mc::PatternCommunication res;
  45     // num?
  46     res.comm_addr = this->comm_addr;
  47     res.type      = this->type;
  48     res.src_proc  = this->src_proc;
  49     res.dst_proc  = this->dst_proc;
  50     res.mbox      = this->mbox;
  51     res.tag       = this->tag;
  52     res.index     = this->index;
  53     return res;
  54   }
  55 };
  56
  57 struct PatternCommunicationList {
  58   unsigned int index_comm = 0;
  59   std::vector<std::unique_ptr<simgrid::mc::PatternCommunication>> list;
  60 };
  61
  62 /********** Checker extension **********/
  63
  64 class CommDetExtension {
  65   Exploration& exploration_;
  66
  67 public:
  68   static simgrid::xbt::Extension<simgrid::mc::Exploration, CommDetExtension> EXTENSION_ID;
  69
  70   explicit CommDetExtension(Exploration& explo) : exploration_(explo) {}
  71
  72   std::vector<simgrid::mc::PatternCommunicationList> initial_communications_pattern;
  73   std::vector<std::vector<simgrid::mc::PatternCommunication*>> incomplete_communications_pattern;
  74
  75   bool initial_communications_pattern_done = false;
  76   bool recv_deterministic                  = true;
  77   bool send_deterministic                  = true;
  78   std::string send_diff;
  79   std::string recv_diff;
  80
  81   void exploration_start()
  82   {
  83     const unsigned long maxpid = exploration_.get_remote_app().get_maxpid();
  84
  85     initial_communications_pattern.resize(maxpid);
  86     incomplete_communications_pattern.resize(maxpid);
  87   }
  88   void restore_communications_pattern(const simgrid::mc::State* state, RemoteApp const& remote_app);
  89   void enforce_deterministic_pattern(aid_t process, const PatternCommunication* comm);
  90   void get_comm_pattern(const Transition* transition);
  91   void complete_comm_pattern(const CommWaitTransition* transition);
  92   void handle_comm_pattern(const Transition* transition);
  93 };
  94 simgrid::xbt::Extension<simgrid::mc::Exploration, CommDetExtension> CommDetExtension::EXTENSION_ID;
  95 /********** State Extension ***********/
  96
  97 class StateCommDet {
  98 public:
  99   std::vector<std::vector<simgrid::mc::PatternCommunication>> incomplete_comm_pattern_;
 100   std::vector<unsigned> communication_indices_;
 101
 102   static simgrid::xbt::Extension<simgrid::mc::State, StateCommDet> EXTENSION_ID;
 103   explicit StateCommDet(CommDetExtension& checker, RemoteApp const& remote_app)
 104   {
 105     const unsigned long maxpid = remote_app.get_maxpid();
 106     for (unsigned long i = 0; i < maxpid; i++) {
 107       std::vector<simgrid::mc::PatternCommunication> res;
 108       for (auto const& comm : checker.incomplete_communications_pattern[i])
 109         res.push_back(comm->dup());
 110       incomplete_comm_pattern_.push_back(std::move(res));
 111     }
 112
 113     for (auto const& list_process_comm : checker.initial_communications_pattern)
 114       this->communication_indices_.push_back(list_process_comm.index_comm);
 115   }
 116 };
 117 simgrid::xbt::Extension<simgrid::mc::State, StateCommDet> StateCommDet::EXTENSION_ID;
 118
 119 static simgrid::mc::CommPatternDifference compare_comm_pattern(const simgrid::mc::PatternCommunication* comm1,
 120                                                                const simgrid::mc::PatternCommunication* comm2)
 121 {
 122   using simgrid::mc::CommPatternDifference;
 123   if (comm1->type != comm2->type)
 124     return CommPatternDifference::TYPE;
 125   if (comm1->mbox != comm2->mbox)
 126     return CommPatternDifference::MBOX;
 127   if (comm1->src_proc != comm2->src_proc)
 128     return CommPatternDifference::SRC_PROC;
 129   if (comm1->dst_proc != comm2->dst_proc)
 130     return CommPatternDifference::DST_PROC;
 131   if (comm1->tag != comm2->tag)
 132     return CommPatternDifference::TAG;
 133   if (comm1->size != comm2->size)
 134     return CommPatternDifference::DATA_SIZE;
 135   return CommPatternDifference::NONE;
 136 }
 137
 138 void CommDetExtension::restore_communications_pattern(const simgrid::mc::State* state, RemoteApp const& remote_app)
 139 {
 140   for (size_t i = 0; i < initial_communications_pattern.size(); i++)
 141     initial_communications_pattern[i].index_comm =
 142         state->extension<simgrid::mc::StateCommDet>()->communication_indices_[i];
 143
 144   const unsigned long maxpid = remote_app.get_maxpid();
 145   for (unsigned long i = 0; i < maxpid; i++) {
 146     incomplete_communications_pattern[i].clear();
 147     for (simgrid::mc::PatternCommunication const& comm :
 148          state->extension<simgrid::mc::StateCommDet>()->incomplete_comm_pattern_[i])
 149       incomplete_communications_pattern[i].push_back(new simgrid::mc::PatternCommunication(comm.dup()));
 150   }
 151 }
 152
 153 static std::string print_determinism_result(simgrid::mc::CommPatternDifference diff, aid_t actor,
 154                                             const simgrid::mc::PatternCommunication* comm, unsigned int cursor)
 155 {
 156   std::string type;
 157   std::string res;
 158
 159   if (comm->type == simgrid::mc::PatternCommunicationType::send)
 160     type = xbt::string_printf("The send communications pattern of the actor %ld is different!", actor - 1);
 161   else
 162     type = xbt::string_printf("The recv communications pattern of the actor %ld is different!", actor - 1);
 163
 164   using simgrid::mc::CommPatternDifference;
 165   switch (diff) {
 166     case CommPatternDifference::TYPE:
 167       res = xbt::string_printf("%s Different type for communication #%u", type.c_str(), cursor);
 168       break;
 169     case CommPatternDifference::MBOX:
 170       res = xbt::string_printf("%s Different mailbox for communication #%u", type.c_str(), cursor);
 171       break;
 172     case CommPatternDifference::TAG:
 173       res = xbt::string_printf("%s Different tag for communication #%u", type.c_str(), cursor);
 174       break;
 175     case CommPatternDifference::SRC_PROC:
 176       res = xbt::string_printf("%s Different source for communication #%u", type.c_str(), cursor);
 177       break;
 178     case CommPatternDifference::DST_PROC:
 179       res = xbt::string_printf("%s Different destination for communication #%u", type.c_str(), cursor);
 180       break;
 181     case CommPatternDifference::DATA_SIZE:
 182       res = xbt::string_printf("%s Different data size for communication #%u", type.c_str(), cursor);
 183       break;
 184     default:
 185       res = "";
 186       break;
 187   }
 188
 189   return res;
 190 }
 191
 192 void CommDetExtension::enforce_deterministic_pattern(aid_t actor, const PatternCommunication* comm)
 193 {
 194   PatternCommunicationList& list = initial_communications_pattern[actor];
 195   CommPatternDifference diff     = compare_comm_pattern(list.list[list.index_comm].get(), comm);
 196
 197   if (diff != CommPatternDifference::NONE) {
 198     if (comm->type == PatternCommunicationType::send) {
 199       send_deterministic = false;
 200       send_diff          = print_determinism_result(diff, actor, comm, list.index_comm + 1);
 201     } else {
 202       recv_deterministic = false;
 203       if (recv_diff.empty())
 204         recv_diff = print_determinism_result(diff, actor, comm, list.index_comm + 1);
 205     }
 206     if (_sg_mc_send_determinism && not send_deterministic) {
 207       XBT_INFO("*********************************************************");
 208       XBT_INFO("***** Non-send-deterministic communications pattern *****");
 209       XBT_INFO("*********************************************************");
 210       XBT_INFO("%s", send_diff.c_str());
 211       exploration_.log_state();
 212       exploration_.system_exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
 213     } else if (_sg_mc_comms_determinism && (not send_deterministic && not recv_deterministic)) {
 214       XBT_INFO("****************************************************");
 215       XBT_INFO("***** Non-deterministic communications pattern *****");
 216       XBT_INFO("****************************************************");
 217       if (not send_diff.empty())
 218         XBT_INFO("%s", send_diff.c_str());
 219       if (not recv_diff.empty())
 220         XBT_INFO("%s", recv_diff.c_str());
 221       exploration_.log_state();
 222       exploration_.system_exit(SIMGRID_MC_EXIT_NON_DETERMINISM);
 223     }
 224   }
 225 }
 226
 227 /********** Non Static functions ***********/
 228
 229 void CommDetExtension::get_comm_pattern(const Transition* transition)
 230 {
 231   const mc::PatternCommunicationList& initial_pattern          = initial_communications_pattern[transition->aid_];
 232   const std::vector<PatternCommunication*>& incomplete_pattern = incomplete_communications_pattern[transition->aid_];
 233
 234   auto pattern   = std::make_unique<PatternCommunication>();
 235   pattern->index = initial_pattern.index_comm + incomplete_pattern.size();
 236
 237   if (transition->type_ == Transition::Type::COMM_ASYNC_SEND) {
 238     auto* send = static_cast<const CommSendTransition*>(transition);
 239
 240     pattern->type      = PatternCommunicationType::send;
 241     pattern->comm_addr = send->get_comm();
 242     pattern->tag       = send->get_tag();
 243
 244     // FIXME: Detached sends should be enforced when the receive is waited
 245
 246   } else if (transition->type_ == Transition::Type::COMM_ASYNC_RECV) {
 247     auto* recv = static_cast<const CommRecvTransition*>(transition);
 248
 249     pattern->type      = PatternCommunicationType::receive;
 250     pattern->comm_addr = recv->get_comm();
 251     pattern->tag       = recv->get_tag();
 252   }
 253
 254   XBT_DEBUG("Insert incomplete comm pattern %p type:%d for process %ld (comm: %" PRIxPTR ")", pattern.get(),
 255             (int)pattern->type, transition->aid_, pattern->comm_addr);
 256   incomplete_communications_pattern[transition->aid_].push_back(pattern.release());
 257 }
 258
 259 void CommDetExtension::complete_comm_pattern(const CommWaitTransition* transition)
 260 {
 261   /* Complete comm pattern */
 262   std::vector<PatternCommunication*>& incomplete_pattern = incomplete_communications_pattern[transition->aid_];
 263   uintptr_t comm_addr                                    = transition->get_comm();
 264   auto current_comm_pattern =
 265       std::find_if(begin(incomplete_pattern), end(incomplete_pattern),
 266                    [&comm_addr](const PatternCommunication* comm) { return (comm->comm_addr == comm_addr); });
 267   xbt_assert(current_comm_pattern != std::end(incomplete_pattern), "Corresponding communication not found!");
 268   std::unique_ptr<PatternCommunication> comm_pattern(*current_comm_pattern);
 269
 270   comm_pattern->src_proc = transition->get_sender();
 271   comm_pattern->dst_proc = transition->get_receiver();
 272   comm_pattern->mbox     = transition->get_mailbox();
 273
 274   XBT_DEBUG("Remove incomplete comm pattern for actor %ld at cursor %zd", transition->aid_,
 275             std::distance(begin(incomplete_pattern), current_comm_pattern));
 276   incomplete_pattern.erase(current_comm_pattern);
 277
 278   if (initial_communications_pattern_done) {
 279     /* Evaluate comm determinism */
 280     enforce_deterministic_pattern(transition->aid_, comm_pattern.get());
 281     initial_communications_pattern[transition->aid_].index_comm++;
 282   } else {
 283     /* Store comm pattern */
 284     initial_communications_pattern[transition->aid_].list.push_back(std::move(comm_pattern));
 285   }
 286 }
 287
 288 void CommDetExtension::handle_comm_pattern(const Transition* transition)
 289 {
 290   if (not _sg_mc_comms_determinism && not _sg_mc_send_determinism)
 291     return;
 292
 293   switch (transition->type_) {
 294     case Transition::Type::COMM_ASYNC_SEND:
 295     case Transition::Type::COMM_ASYNC_RECV:
 296       get_comm_pattern(transition);
 297       break;
 298     case Transition::Type::COMM_WAIT:
 299       complete_comm_pattern(static_cast<const CommWaitTransition*>(transition));
 300       break;
 301     case Transition::Type::WAITANY:
 302       // Ignore wait on non-comm
 303       if (auto const* wait = dynamic_cast<const CommWaitTransition*>(
 304               static_cast<const WaitAnyTransition*>(transition)->get_current_transition()))
 305         complete_comm_pattern(wait);
 306       break;
 307     default: /* Ignore unhandled transition types */
 308       break;
 309   }
 310 }
 311
 312 /* FIXME: CommDet probably don't play nicely with stateful exploration
 313
 314       bool all_communications_are_finished = true;
 315       for (size_t current_actor = 1; all_communications_are_finished && current_actor < maxpid; current_actor++) {
 316         if (not extension->incomplete_communications_pattern[current_actor].empty()) {
 317           XBT_DEBUG("Some communications are not finished, cannot stop the exploration! State not visited.");
 318           all_communications_are_finished = false;
 319         }
 320       }
 321  */
 322
 323 Exploration* create_communication_determinism_checker(const std::vector<char*>& args, bool with_dpor)
 324 {
 325   CommDetExtension::EXTENSION_ID = simgrid::mc::Exploration::extension_create<CommDetExtension>();
 326   StateCommDet::EXTENSION_ID     = simgrid::mc::State::extension_create<StateCommDet>();
 327
 328   XBT_DEBUG("********* Start communication determinism verification *********");
 329
 330   auto base      = new DFSExplorer(args, with_dpor, true);
 331   auto extension = new CommDetExtension(*base);
 332
 333   DFSExplorer::on_exploration_start([extension](RemoteApp const&) {
 334     XBT_INFO("Check communication determinism");
 335     extension->exploration_start();
 336   });
 337   DFSExplorer::on_backtracking(
 338       [extension](RemoteApp const&) { extension->initial_communications_pattern_done = true; });
 339   DFSExplorer::on_state_creation([extension](State* state, RemoteApp const& remote_app) {
 340     state->extension_set(new StateCommDet(*extension, remote_app));
 341   });
 342
 343   DFSExplorer::on_restore_system_state([extension](State const* state, RemoteApp const& remote_app) {
 344     extension->restore_communications_pattern(state, remote_app);
 345   });
 346
 347   DFSExplorer::on_restore_initial_state([extension](RemoteApp const& remote_app) {
 348     const unsigned long maxpid = remote_app.get_maxpid();
 349     assert(maxpid == extension->incomplete_communications_pattern.size());
 350     assert(maxpid == extension->initial_communications_pattern.size());
 351     for (unsigned long j = 0; j < maxpid; j++) {
 352       extension->incomplete_communications_pattern[j].clear();
 353       extension->initial_communications_pattern[j].index_comm = 0;
 354     }
 355   });
 356
 357   DFSExplorer::on_transition_replay(
 358       [extension](Transition const* t, RemoteApp const&) { extension->handle_comm_pattern(t); });
 359   DFSExplorer::on_transition_execute(
 360       [extension](Transition const* t, RemoteApp const&) { extension->handle_comm_pattern(t); });
 361
 362   DFSExplorer::on_log_state([extension](RemoteApp const&) {
 363     if (_sg_mc_comms_determinism) {
 364       if (extension->send_deterministic && not extension->recv_deterministic) {
 365         XBT_INFO("*******************************************************");
 366         XBT_INFO("**** Only-send-deterministic communication pattern ****");
 367         XBT_INFO("*******************************************************");
 368         XBT_INFO("%s", extension->recv_diff.c_str());
 369       }
 370       if (not extension->send_deterministic && extension->recv_deterministic) {
 371         XBT_INFO("*******************************************************");
 372         XBT_INFO("**** Only-recv-deterministic communication pattern ****");
 373         XBT_INFO("*******************************************************");
 374         XBT_INFO("%s", extension->send_diff.c_str());
 375       }
 376     }
 377     XBT_INFO("Send-deterministic : %s", extension->send_deterministic ? "Yes" : "No");
 378     if (_sg_mc_comms_determinism)
 379       XBT_INFO("Recv-deterministic : %s", extension->recv_deterministic ? "Yes" : "No");
 380     delete extension;
 381   });
 382
 383   return base;
 384 }
 385
 386 } // namespace simgrid::mc