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