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