src/mc/explo/CommunicationDeterminismChecker.cpp

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