src/kernel/actor/SimcallObserver.cpp

   1 /* Copyright (c) 2019-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/actor/SimcallObserver.hpp"
   7 #include "simgrid/s4u/Host.hpp"
   8 #include "src/kernel/activity/CommImpl.hpp"
   9 #include "src/kernel/activity/MutexImpl.hpp"
  10 #include "src/kernel/actor/ActorImpl.hpp"
  11 #include "src/mc/mc_config.hpp"
  12
  13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_observer, mc, "Logging specific to MC simcall observation");
  14
  15 namespace simgrid {
  16 namespace kernel {
  17 namespace actor {
  18
  19 bool SimcallObserver::depends(SimcallObserver* other)
  20 {
  21   THROW_UNIMPLEMENTED;
  22 }
  23 /* Random is only dependent when issued by the same actor (ie, always independent) */
  24 bool RandomSimcall::depends(SimcallObserver* other)
  25 {
  26   return get_issuer() == other->get_issuer();
  27 }
  28 bool MutexSimcall::depends(SimcallObserver* other)
  29 {
  30   if (dynamic_cast<RandomSimcall*>(other) != nullptr)
  31     return other->depends(this); /* Other is random, that is very permissive. Use that relation instead. */
  32
  33 #if 0 /* This code is currently broken and shouldn't be used. We must implement asynchronous locks before */
  34   MutexSimcall* that = dynamic_cast<MutexSimcall*>(other);
  35   if (that == nullptr)
  36     return true; // Depends on anything we don't know
  37
  38   /* Theorem 4.4.7: Any pair of synchronization actions of distinct actors concerning distinct mutexes are independent */
  39   if (this->get_issuer() != that->get_issuer() && this->get_mutex() != that->get_mutex())
  40     return false;
  41
  42   /* Theorem 4.4.8 An AsyncMutexLock is independent with a MutexUnlock of another actor */
  43   if (((dynamic_cast<MutexLockSimcall*>(this) != nullptr && dynamic_cast<MutexUnlockSimcall*>(that)) ||
  44        (dynamic_cast<MutexLockSimcall*>(that) != nullptr && dynamic_cast<MutexUnlockSimcall*>(this))) &&
  45       get_issuer() != other->get_issuer())
  46     return false;
  47 #endif
  48   return true; // Depend on things we don't know for sure that they are independent
  49 }
  50
  51 std::string SimcallObserver::to_string(int /*times_considered*/) const
  52 {
  53   return simgrid::xbt::string_printf("[(%ld)%s (%s)] ", issuer_->get_pid(), issuer_->get_host()->get_cname(),
  54                                      issuer_->get_cname());
  55 }
  56
  57 std::string SimcallObserver::dot_label(int /*times_considered*/) const
  58 {
  59   if (issuer_->get_host())
  60     return xbt::string_printf("[(%ld)%s] ", issuer_->get_pid(), issuer_->get_host()->get_cname());
  61   return xbt::string_printf("[(%ld)] ", issuer_->get_pid());
  62 }
  63
  64 std::string RandomSimcall::to_string(int times_considered) const
  65 {
  66   return SimcallObserver::to_string(times_considered) + "MC_RANDOM(" + std::to_string(times_considered) + ")";
  67 }
  68
  69 std::string RandomSimcall::dot_label(int times_considered) const
  70 {
  71   return SimcallObserver::dot_label(times_considered) + "MC_RANDOM(" + std::to_string(next_value_) + ")";
  72 }
  73
  74 void RandomSimcall::prepare(int times_considered)
  75 {
  76   next_value_ = min_ + times_considered;
  77   XBT_DEBUG("MC_RANDOM(%d, %d) will return %d after %d times", min_, max_, next_value_, times_considered);
  78 }
  79
  80 int RandomSimcall::get_max_consider() const
  81 {
  82   return max_ - min_ + 1;
  83 }
  84
  85 std::string MutexUnlockSimcall::to_string(int times_considered) const
  86 {
  87   return SimcallObserver::to_string(times_considered) + "Mutex UNLOCK";
  88 }
  89
  90 std::string MutexUnlockSimcall::dot_label(int times_considered) const
  91 {
  92   return SimcallObserver::dot_label(times_considered) + "Mutex UNLOCK";
  93 }
  94
  95 std::string MutexLockSimcall::to_string(int times_considered) const
  96 {
  97   auto mutex      = get_mutex();
  98   std::string res = SimcallObserver::to_string(times_considered) + (blocking_ ? "Mutex LOCK" : "Mutex TRYLOCK");
  99   res += "(locked = " + std::to_string(mutex->is_locked());
 100   res += ", owner = " + std::to_string(mutex->get_owner() ? mutex->get_owner()->get_pid() : -1);
 101   res += ", sleeping = n/a)";
 102   return res;
 103 }
 104
 105 std::string MutexLockSimcall::dot_label(int times_considered) const
 106 {
 107   return SimcallObserver::dot_label(times_considered) + (blocking_ ? "Mutex LOCK" : "Mutex TRYLOCK");
 108 }
 109
 110 bool MutexLockSimcall::is_enabled() const
 111 {
 112   return not blocking_ || get_mutex()->get_owner() == nullptr || get_mutex()->get_owner() == get_issuer();
 113 }
 114
 115 std::string ConditionWaitSimcall::to_string(int times_considered) const
 116 {
 117   std::string res = SimcallObserver::to_string(times_considered) + "Condition WAIT";
 118   res += "(" + (timeout_ == -1.0 ? "" : std::to_string(timeout_)) + ")";
 119   return res;
 120 }
 121
 122 std::string ConditionWaitSimcall::dot_label(int times_considered) const
 123 {
 124   return SimcallObserver::dot_label(times_considered) + "Condition WAIT";
 125 }
 126
 127 bool ConditionWaitSimcall::is_enabled() const
 128 {
 129   static bool warned = false;
 130   if (not warned) {
 131     XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
 132     warned = true;
 133   }
 134   return true;
 135 }
 136
 137 std::string SemAcquireSimcall::to_string(int times_considered) const
 138 {
 139   std::string res = SimcallObserver::to_string(times_considered) + "Sem ACQUIRE";
 140   res += "(" + (timeout_ == -1.0 ? "" : std::to_string(timeout_)) + ")";
 141   return res;
 142 }
 143
 144 std::string SemAcquireSimcall::dot_label(int times_considered) const
 145 {
 146   return SimcallObserver::dot_label(times_considered) + "Sem ACQUIRE";
 147 }
 148
 149 bool SemAcquireSimcall::is_enabled() const
 150 {
 151   static bool warned = false;
 152   if (not warned) {
 153     XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
 154     warned = true;
 155   }
 156   return true;
 157 }
 158
 159 int ActivityTestanySimcall::get_max_consider() const
 160 {
 161   // Only Comms are of interest to MC for now. When all types of activities can be consider, this function can simply
 162   // return the size of activities_.
 163   int count = 0;
 164   for (const auto& act : activities_)
 165     if (dynamic_cast<activity::CommImpl*>(act) != nullptr)
 166       count++;
 167   return count;
 168 }
 169
 170 void ActivityTestanySimcall::prepare(int times_considered)
 171 {
 172   next_value_ = times_considered;
 173 }
 174
 175 std::string ActivityTestanySimcall::to_string(int times_considered) const
 176 {
 177   std::string res = SimcallObserver::to_string(times_considered);
 178   if (times_considered == -1) {
 179     res += "TestAny FALSE(-)";
 180   } else {
 181     res += "TestAny(" + xbt::string_printf("(%d of %zu)", times_considered + 1, activities_.size());
 182   }
 183
 184   return res;
 185 }
 186
 187 std::string ActivityTestanySimcall::dot_label(int times_considered) const
 188 {
 189   std::string res = SimcallObserver::dot_label(times_considered) + "TestAny ";
 190   if (times_considered == -1) {
 191     res += "FALSE";
 192   } else {
 193     res += xbt::string_printf("TRUE [%d of %zu]", times_considered + 1, activities_.size());
 194   }
 195   return res;
 196 }
 197
 198 bool ActivityTestSimcall::depends(SimcallObserver* other)
 199 {
 200   if (get_issuer() == other->get_issuer())
 201     return false;
 202
 203   if (dynamic_cast<ActivityTestSimcall*>(other))
 204     return true;
 205
 206   const auto* comm1 = dynamic_cast<activity::CommImpl*>(activity_);
 207   if (comm1 == nullptr)
 208     return false;
 209
 210   if (dynamic_cast<ActivityWaitSimcall*>(other) != nullptr &&
 211       (comm1->src_actor_.get() == nullptr || comm1->dst_actor_.get() == nullptr))
 212     return false;
 213
 214   if (comm1->src_buff_ == nullptr || comm1->dst_buff_ == nullptr)
 215     return false;
 216
 217   if (const auto* test = dynamic_cast<ActivityTestSimcall*>(other)) {
 218     const auto* comm2 = dynamic_cast<activity::CommImpl*>(test->get_activity());
 219     if (comm2 == nullptr)
 220       return false;
 221     else if (comm2->src_buff_ == nullptr || comm2->dst_buff_ == nullptr)
 222       return false;
 223   }
 224
 225   if (auto* wait = dynamic_cast<ActivityWaitSimcall*>(other)) {
 226     auto* comm2 = dynamic_cast<activity::CommImpl*>(wait->get_activity());
 227     if (comm2 == nullptr)
 228       return false;
 229     if (comm1->src_buff_ == comm2->src_buff_ && comm1->dst_buff_ == comm2->dst_buff_)
 230       return false;
 231     if (comm1->src_buff_ != nullptr && comm1->dst_buff_ != nullptr && comm2->src_buff_ != nullptr &&
 232         comm2->dst_buff_ != nullptr && comm1->dst_buff_ != comm2->src_buff_ && comm1->dst_buff_ != comm2->dst_buff_ &&
 233         comm2->dst_buff_ != comm1->src_buff_)
 234       return false;
 235   }
 236
 237   return true;
 238 }
 239
 240 std::string ActivityTestSimcall::to_string(int times_considered) const
 241 {
 242   std::string res = SimcallObserver::to_string(times_considered) + "Test ";
 243   if (const auto* comm = dynamic_cast<activity::CommImpl*>(activity_)) {
 244     if (comm->src_actor_.get() == nullptr || comm->dst_actor_.get() == nullptr) {
 245       res += "FALSE(comm=";
 246       res += XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? xbt::string_printf("%p)", comm)
 247                                                                       : "(verbose only))";
 248     } else {
 249       res += "TRUE(comm=";
 250
 251       auto src = comm->src_actor_;
 252       auto dst = comm->dst_actor_;
 253       res +=
 254           XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? xbt::string_printf("%p", comm) : "(verbose only) ";
 255       res += xbt::string_printf("[(%ld)%s (%s) ", src->get_pid(), src->get_host()->get_cname(), src->get_cname()) +
 256              "-> " +
 257              xbt::string_printf("(%ld)%s (%s)])", dst->get_pid(), dst->get_host()->get_cname(), dst->get_cname());
 258     }
 259   } else
 260     xbt_die("Only Comms are supported here for now");
 261   return res;
 262 }
 263
 264 std::string ActivityTestSimcall::dot_label(int times_considered) const
 265 {
 266   std::string res  = SimcallObserver::dot_label(times_considered) + "Test ";
 267   const auto* comm = dynamic_cast<activity::CommImpl*>(activity_);
 268   if (comm && (comm->src_actor_.get() == nullptr || comm->dst_actor_.get() == nullptr)) {
 269     res += "FALSE";
 270   } else {
 271     res += "TRUE";
 272   }
 273   return res;
 274 }
 275
 276 bool ActivityWaitSimcall::is_enabled() const
 277 {
 278   /* FIXME: check also that src and dst processes are not suspended */
 279   const auto* comm = dynamic_cast<activity::CommImpl*>(activity_);
 280   if (comm == nullptr)
 281     xbt_die("Only Comms are supported here for now");
 282
 283   if (comm->src_timeout_ || comm->dst_timeout_) {
 284     /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
 285      * because even if the communication is not ready, it can timeout and won't block. */
 286     if (_sg_mc_timeout == 1)
 287       return true;
 288   }
 289   /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 290   else if (comm->detached() && comm->src_actor_ == nullptr && comm->get_state() == activity::State::READY)
 291     return (comm->dst_actor_ != nullptr);
 292   return (comm->src_actor_ && comm->dst_actor_);
 293 }
 294
 295 bool ActivityWaitSimcall::depends(SimcallObserver* other)
 296 {
 297   if (get_issuer() == other->get_issuer())
 298     return false;
 299
 300   if (auto* isend = dynamic_cast<CommIsendSimcall*>(other))
 301     return isend->depends(this);
 302
 303   if (auto* irecv = dynamic_cast<CommIrecvSimcall*>(other))
 304     return irecv->depends(this);
 305
 306   /* Timeouts in wait transitions are not considered by the independence theorem, thus assumed dependent */
 307   if (const auto* wait = dynamic_cast<ActivityWaitSimcall*>(other)) {
 308     if (timeout_ > 0 || wait->get_timeout() > 0)
 309       return true;
 310     const auto* comm1 = dynamic_cast<activity::CommImpl*>(activity_);
 311     const auto* comm2 = dynamic_cast<activity::CommImpl*>(wait->get_activity());
 312
 313     if (comm1 == nullptr || comm2 == nullptr) // One wait at least in not on a Comm
 314       return true;
 315
 316     if (comm1->src_buff_ == comm2->src_buff_ && comm1->dst_buff_ == comm2->dst_buff_)
 317       return false;
 318     if (comm1->src_buff_ != nullptr && comm1->dst_buff_ != nullptr && comm2->src_buff_ != nullptr &&
 319         comm2->dst_buff_ != nullptr && comm1->dst_buff_ != comm2->src_buff_ && comm1->dst_buff_ != comm2->dst_buff_ &&
 320         comm2->dst_buff_ != comm1->src_buff_)
 321       return false;
 322   }
 323
 324   return true;
 325 }
 326
 327 std::string ActivityWaitSimcall::to_string(int times_considered) const
 328 {
 329   std::string res = SimcallObserver::to_string(times_considered);
 330   auto* comm      = dynamic_cast<activity::CommImpl*>(activity_);
 331   if (comm == nullptr) {
 332     res += "ActivityWait on non-Comm (FIXME)"; // FIXME
 333     return res;
 334   }
 335
 336   if (times_considered == -1) {
 337     res += "WaitTimeout(comm=" + (XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose)
 338                                       ? xbt::string_printf("%p)", comm)
 339                                       : "(verbose only))");
 340   } else {
 341     res += "Wait(comm=";
 342
 343     auto src = comm->src_actor_;
 344     auto dst = comm->dst_actor_;
 345     res +=
 346         XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? xbt::string_printf("%p", comm) : "(verbose only) ";
 347     res += xbt::string_printf("[(%ld)%s (%s) ", src->get_pid(), src->get_host()->get_cname(), src->get_cname()) +
 348            "-> " + xbt::string_printf("(%ld)%s (%s)])", dst->get_pid(), dst->get_host()->get_cname(), dst->get_cname());
 349   }
 350   return res;
 351 }
 352
 353 std::string ActivityWaitSimcall::dot_label(int times_considered) const
 354 {
 355   std::string res = SimcallObserver::dot_label(times_considered);
 356   res += (times_considered == -1) ? "WaitTimeout " : "Wait ";
 357
 358   const auto* comm = dynamic_cast<activity::CommImpl*>(activity_);
 359   if (comm) {
 360     auto src = comm->src_actor_;
 361     auto dst = comm->dst_actor_;
 362     res += " [(" + std::to_string(src ? src->get_pid() : 0) + ")";
 363     res += "->(" + std::to_string(dst ? dst->get_pid() : 0) + ")]";
 364   } else
 365     xbt_die("Only Comms are supported here for now");
 366   return res;
 367 }
 368
 369 std::string ActivityWaitanySimcall::dot_label(int times_considered) const
 370 {
 371   return SimcallObserver::dot_label(times_considered) +
 372          xbt::string_printf("WaitAny [%d of %zu]", times_considered + 1, activities_.size());
 373 }
 374
 375 bool ActivityWaitanySimcall::is_enabled() const
 376 {
 377   // FIXME: deal with other kind of activities (Exec and I/Os)
 378   // FIXME: Can be factored with ActivityWaitSimcall::is_enabled()
 379   const auto* comm = dynamic_cast<activity::CommImpl*>(activities_[next_value_]);
 380   if (comm == nullptr)
 381     xbt_die("Only Comms are supported here for now");
 382   if (comm->src_timeout_ || comm->dst_timeout_) {
 383     /* If it has a timeout it will be always be enabled (regardless of who declared the timeout),
 384      * because even if the communication is not ready, it can timeout and won't block. */
 385     if (_sg_mc_timeout == 1)
 386       return true;
 387   }
 388   /* On the other hand if it hasn't a timeout, check if the comm is ready.*/
 389   else if (comm->detached() && comm->src_actor_ == nullptr && comm->get_state() == activity::State::READY)
 390     return (comm->dst_actor_ != nullptr);
 391   return (comm->src_actor_ && comm->dst_actor_);
 392 }
 393
 394 int ActivityWaitanySimcall::get_max_consider() const
 395 {
 396   return static_cast<int>(activities_.size());
 397 }
 398
 399 void ActivityWaitanySimcall::prepare(int times_considered)
 400 {
 401   next_value_ = times_considered;
 402 }
 403
 404 std::string ActivityWaitanySimcall::to_string(int times_considered) const
 405 {
 406   std::string res = SimcallObserver::to_string(times_considered) + "WaitAny(";
 407   size_t count    = activities_.size();
 408   if (count > 0) {
 409     if (auto* comm = dynamic_cast<kernel::activity::CommImpl*>(activities_[times_considered]))
 410       res += "comm=" +
 411              (XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? xbt::string_printf("%p", comm)
 412                                                                        : "(verbose only)") +
 413              xbt::string_printf("(%d of %zu))", times_considered + 1, count);
 414     else
 415       xbt_die("Only Comms are supported here for now");
 416   } else
 417     res += "comm at idx " + std::to_string(times_considered) + ")";
 418   return res;
 419 }
 420
 421 bool CommIsendSimcall::depends(SimcallObserver* other)
 422 {
 423   if (get_issuer() == other->get_issuer())
 424     return false;
 425
 426   if (const auto* other_isend = dynamic_cast<CommIsendSimcall*>(other))
 427     return mbox_ == other_isend->get_mailbox();
 428
 429   // FIXME: Not in the former dependency check because of the ordering but seems logical to add it
 430   if (dynamic_cast<CommIrecvSimcall*>(other) != nullptr)
 431     return false;
 432
 433 #if SIMGRID_HAVE_MC // FIXME needed to access mbox_cpy
 434   if (const auto* wait = dynamic_cast<ActivityWaitSimcall*>(other)) {
 435     if (const auto* comm2 = dynamic_cast<activity::CommImpl*>(wait->get_activity())) { // this is a Comm::wait_for
 436       const auto* mbox1 = mbox_;
 437       const auto* mbox2 = comm2->mbox_cpy;
 438
 439       if (mbox1 != mbox2 && wait->get_timeout() <= 0)
 440         return false;
 441
 442       if ((get_issuer() != comm2->src_actor_.get()) && (get_issuer() != comm2->dst_actor_.get()) &&
 443           wait->get_timeout() <= 0)
 444         return false;
 445
 446       if (comm2->type_ == activity::CommImpl::Type::SEND && comm2->src_buff_ != src_buff_ && wait->get_timeout() <= 0)
 447         return false;
 448     }
 449   }
 450 #endif
 451   /* FIXME: the following rule assumes that the result of the isend/irecv call is not stored in a buffer used in the
 452    * test call. */
 453 #if 0
 454   if (dynamic_cast<ActivityTestSimcall*>(other))
 455     return false;
 456 #endif
 457
 458   return true;
 459 }
 460
 461 std::string CommIsendSimcall::to_string(int times_considered) const
 462 {
 463   std::string res = SimcallObserver::to_string(times_considered) + "iSend(";
 464   res += xbt::string_printf("src=(%ld)%s (%s)", get_issuer()->get_pid(), get_issuer()->get_host()->get_cname(),
 465                             get_issuer()->get_cname());
 466   res += ", buff=" + (XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? xbt::string_printf("%p", src_buff_)
 467                                                                                : "(verbose only)");
 468   res += ", size=" +
 469          (XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? std::to_string(src_buff_size_) : "(verbose only)");
 470   res += ")";
 471   return res;
 472 }
 473
 474 bool CommIrecvSimcall::depends(SimcallObserver* other)
 475 {
 476   if (get_issuer() == other->get_issuer())
 477     return false;
 478
 479   if (const auto* other_irecv = dynamic_cast<CommIrecvSimcall*>(other))
 480     return mbox_ == other_irecv->get_mailbox();
 481
 482   if (auto* isend = dynamic_cast<CommIsendSimcall*>(other))
 483     return isend->depends(this);
 484
 485 #if SIMGRID_HAVE_MC // FIXME needed to access mbox_cpy
 486   if (auto* wait = dynamic_cast<ActivityWaitSimcall*>(other)) {
 487     if (auto* comm2 = dynamic_cast<activity::CommImpl*>(wait->get_activity())) { // this is a Comm::wait_for
 488       const auto* mbox1 = mbox_;
 489       const auto* mbox2 = comm2->mbox_cpy;
 490
 491       if (mbox1 != mbox2 && wait->get_timeout() <= 0)
 492         return false;
 493
 494       if ((get_issuer() != comm2->src_actor_.get()) && (get_issuer() != comm2->dst_actor_.get()) &&
 495           wait->get_timeout() <= 0)
 496         return false;
 497
 498       if (comm2->type_ == activity::CommImpl::Type::RECEIVE && comm2->dst_buff_ != dst_buff_ &&
 499           wait->get_timeout() <= 0)
 500         return false;
 501     }
 502   }
 503 #endif
 504   /* FIXME: the following rule assumes that the result of the isend/irecv call is not stored in a buffer used in the
 505    * test call. */
 506 #if 0
 507   if (dynamic_cast<ActivityTestSimcall*>(other))
 508     return false;
 509 #endif
 510
 511   return true;
 512 }
 513
 514 std::string CommIrecvSimcall::to_string(int times_considered) const
 515 {
 516   std::string res = SimcallObserver::to_string(times_considered) + "iRecv(";
 517   res += xbt::string_printf("dst=(%ld)%s (%s)", get_issuer()->get_pid(), get_issuer()->get_host()->get_cname(),
 518                             get_issuer()->get_cname());
 519   res += ", buff=" + (XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? xbt::string_printf("%p", dst_buff_)
 520                                                                                : "(verbose only)");
 521   res += ", size=" + (XBT_LOG_ISENABLED(mc_observer, xbt_log_priority_verbose) ? std::to_string(*dst_buff_size_)
 522                                                                                : "(verbose only)");
 523   res += ")";
 524   return res;
 525 }
 526
 527 } // namespace actor
 528 } // namespace kernel
 529 } // namespace simgrid