Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
CommDet: reimplement on top of transitions. Don't mess with requests anymore
[simgrid.git] / src / kernel / actor / SimcallObserver.cpp
index bb763ef..f869507 100644 (file)
@@ -1,12 +1,17 @@
-/* Copyright (c) 2019-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2019-2022. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 
 #include "src/kernel/actor/SimcallObserver.hpp"
 #include "simgrid/s4u/Host.hpp"
+#include "src/kernel/activity/CommImpl.hpp"
+#include "src/kernel/activity/MailboxImpl.hpp"
 #include "src/kernel/activity/MutexImpl.hpp"
 #include "src/kernel/actor/ActorImpl.hpp"
+#include "src/mc/mc_config.hpp"
+
+#include <sstream>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_observer, mc, "Logging specific to MC simcall observation");
 
@@ -14,27 +19,46 @@ namespace simgrid {
 namespace kernel {
 namespace actor {
 
-std::string SimcallObserver::to_string(int /*times_considered*/) const
+void SimcallObserver::serialize(std::stringstream& stream) const
 {
-  return simgrid::xbt::string_printf("[(%ld)%s (%s)] ", issuer_->get_pid(), issuer_->get_host()->get_cname(),
-                                     issuer_->get_cname());
+  stream << (short)mc::Transition::Type::UNKNOWN;
 }
-
-std::string SimcallObserver::dot_label() const
+bool SimcallObserver::depends(SimcallObserver* other)
 {
-  if (issuer_->get_host())
-    return xbt::string_printf("[(%ld)%s] ", issuer_->get_pid(), issuer_->get_cname());
-  return xbt::string_printf("[(%ld)] ", issuer_->get_pid());
+  THROW_UNIMPLEMENTED;
 }
-
-std::string RandomSimcall::to_string(int times_considered) const
+/* Random is only dependent when issued by the same actor (ie, always independent) */
+bool RandomSimcall::depends(SimcallObserver* other)
+{
+  return get_issuer() == other->get_issuer();
+}
+void RandomSimcall::serialize(std::stringstream& stream) const
 {
-  return SimcallObserver::to_string(times_considered) + "MC_RANDOM(" + std::to_string(times_considered) + ")";
+  stream << (short)mc::Transition::Type::RANDOM << ' ';
+  stream << min_ << ' ' << max_;
 }
 
-std::string RandomSimcall::dot_label() const
+bool MutexSimcall::depends(SimcallObserver* other)
 {
-  return SimcallObserver::dot_label() + "MC_RANDOM(" + std::to_string(next_value_) + ")";
+  if (dynamic_cast<RandomSimcall*>(other) != nullptr)
+    return other->depends(this); /* Other is random, that is very permissive. Use that relation instead. */
+
+#if 0 /* This code is currently broken and shouldn't be used. We must implement asynchronous locks before */
+  MutexSimcall* that = dynamic_cast<MutexSimcall*>(other);
+  if (that == nullptr)
+    return true; // Depends on anything we don't know
+
+  /* Theorem 4.4.7: Any pair of synchronization actions of distinct actors concerning distinct mutexes are independent */
+  if (this->get_issuer() != that->get_issuer() && this->get_mutex() != that->get_mutex())
+    return false;
+
+  /* Theorem 4.4.8 An AsyncMutexLock is independent with a MutexUnlock of another actor */
+  if (((dynamic_cast<MutexLockSimcall*>(this) != nullptr && dynamic_cast<MutexUnlockSimcall*>(that)) ||
+       (dynamic_cast<MutexLockSimcall*>(that) != nullptr && dynamic_cast<MutexUnlockSimcall*>(this))) &&
+      get_issuer() != other->get_issuer())
+    return false;
+#endif
+  return true; // Depend on things we don't know for sure that they are independent
 }
 
 void RandomSimcall::prepare(int times_considered)
@@ -43,95 +67,187 @@ void RandomSimcall::prepare(int times_considered)
   XBT_DEBUG("MC_RANDOM(%d, %d) will return %d after %d times", min_, max_, next_value_, times_considered);
 }
 
-int RandomSimcall::get_max_consider() const
+int RandomSimcall::get_max_consider()
 {
   return max_ - min_ + 1;
 }
 
-std::string MutexUnlockSimcall::to_string(int times_considered) const
-{
-  return SimcallObserver::to_string(times_considered) + "Mutex UNLOCK";
-}
-
-std::string MutexUnlockSimcall::dot_label() const
-{
-  return SimcallObserver::dot_label() + "Mutex UNLOCK";
-}
-
+/*
 std::string MutexLockSimcall::to_string(int times_considered) const
 {
+  auto mutex      = get_mutex();
   std::string res = SimcallObserver::to_string(times_considered) + (blocking_ ? "Mutex LOCK" : "Mutex TRYLOCK");
-  res += "(locked = " + std::to_string(mutex_->is_locked());
-  res += ", owner = " + std::to_string(mutex_->get_owner() ? mutex_->get_owner()->get_pid() : -1);
+  res += "(locked = " + std::to_string(mutex->is_locked());
+  res += ", owner = " + std::to_string(mutex->get_owner() ? mutex->get_owner()->get_pid() : -1);
   res += ", sleeping = n/a)";
   return res;
+}*/
+
+bool MutexLockSimcall::is_enabled()
+{
+  return not blocking_ || get_mutex()->get_owner() == nullptr || get_mutex()->get_owner() == get_issuer();
 }
 
-std::string MutexLockSimcall::dot_label() const
+bool ConditionWaitSimcall::is_enabled()
 {
-  return SimcallObserver::dot_label() + (blocking_ ? "Mutex LOCK" : "Mutex TRYLOCK");
+  static bool warned = false;
+  if (not warned) {
+    XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
+    warned = true;
+  }
+  return true;
 }
 
-bool MutexLockSimcall::is_enabled() const
+bool SemAcquireSimcall::is_enabled()
 {
-  return not blocking_ || mutex_->get_owner() == nullptr || mutex_->get_owner() == get_issuer();
+  static bool warned = false;
+  if (not warned) {
+    XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
+    warned = true;
+  }
+  return true;
 }
 
-std::string ConditionWaitSimcall::to_string(int times_considered) const
+ActivityTestanySimcall::ActivityTestanySimcall(ActorImpl* actor, const std::vector<activity::ActivityImpl*>& activities)
+    : ResultingSimcall(actor, -1), activities_(activities)
 {
-  std::string res = SimcallObserver::to_string(times_considered) + "Condition WAIT";
-  res += "(" + (timeout_ == -1.0 ? "" : std::to_string(timeout_)) + ")";
-  return res;
 }
 
-std::string ConditionWaitSimcall::dot_label() const
+int ActivityTestanySimcall::get_max_consider()
 {
-  return SimcallObserver::dot_label() + "Condition WAIT";
+  indexes_.clear();
+  // list all the activities that are ready
+  for (unsigned i = 0; i < activities_.size(); i++)
+    if (activities_[i]->test(get_issuer()))
+      indexes_.push_back(i);
+  return indexes_.size() + 1;
 }
 
-bool ConditionWaitSimcall::is_enabled() const
+void ActivityTestanySimcall::prepare(int times_considered)
 {
-  static bool warned = false;
-  if (not warned) {
-    XBT_INFO("Using condition variables in model-checked code is still experimental. Use at your own risk");
-    warned = true;
+  if (times_considered < static_cast<int>(indexes_.size()))
+    next_value_ = indexes_.at(times_considered);
+  else
+    next_value_ = -1;
+}
+static void serialize_activity_test(const activity::ActivityImpl* act, std::stringstream& stream)
+{
+  if (auto* comm = dynamic_cast<activity::CommImpl const*>(act)) {
+    stream << "  " << (short)mc::Transition::Type::COMM_TEST;
+    stream << ' ' << (uintptr_t)comm;
+    stream << ' ' << (comm->src_actor_ != nullptr ? comm->src_actor_->get_pid() : -1);
+    stream << ' ' << (comm->dst_actor_ != nullptr ? comm->dst_actor_->get_pid() : -1);
+    stream << ' ' << comm->get_mailbox_id();
+    stream << ' ' << (uintptr_t)comm->src_buff_ << ' ' << (uintptr_t)comm->dst_buff_ << ' ' << comm->src_buff_size_;
+  } else {
+    stream << (short)mc::Transition::Type::UNKNOWN;
   }
-  return true;
 }
+void ActivityTestanySimcall::serialize(std::stringstream& stream) const
+{
+  stream << (short)mc::Transition::Type::TESTANY << ' ' << activities_.size() << ' ';
+  for (auto const& act : activities_) {
+    serialize_activity_test(act, stream);
+    stream << ' ';
+  }
+}
+void ActivityTestSimcall::serialize(std::stringstream& stream) const
+{
+  serialize_activity_test(activity_, stream);
+}
+static void serialize_activity_wait(const activity::ActivityImpl* act, bool timeout, std::stringstream& stream)
+{
+  if (auto* comm = dynamic_cast<activity::CommImpl const*>(act)) {
+    stream << (short)mc::Transition::Type::COMM_WAIT << ' ';
+    stream << timeout << ' ' << (uintptr_t)comm;
 
-std::string SemAcquireSimcall::to_string(int times_considered) const
+    stream << ' ' << (comm->src_actor_ != nullptr ? comm->src_actor_->get_pid() : -1);
+    stream << ' ' << (comm->dst_actor_ != nullptr ? comm->dst_actor_->get_pid() : -1);
+    stream << ' ' << comm->get_mailbox_id();
+    stream << ' ' << (uintptr_t)comm->src_buff_ << ' ' << (uintptr_t)comm->dst_buff_ << ' ' << comm->src_buff_size_;
+  } else {
+    stream << (short)mc::Transition::Type::UNKNOWN;
+  }
+}
+
+void ActivityWaitSimcall::serialize(std::stringstream& stream) const
+{
+  serialize_activity_wait(activity_, timeout_ > 0, stream);
+}
+void ActivityWaitanySimcall::serialize(std::stringstream& stream) const
+{
+  stream << (short)mc::Transition::Type::WAITANY << ' ' << activities_.size() << ' ';
+  for (auto const& act : activities_) {
+    serialize_activity_wait(act, timeout_ > 0, stream);
+    stream << ' ';
+  }
+}
+ActivityWaitanySimcall::ActivityWaitanySimcall(ActorImpl* actor, const std::vector<activity::ActivityImpl*>& activities,
+                                               double timeout)
+    : ResultingSimcall(actor, -1), activities_(activities), timeout_(timeout)
 {
-  std::string res = SimcallObserver::to_string(times_considered) + "Sem ACQUIRE";
-  res += "(" + (timeout_ == -1.0 ? "" : std::to_string(timeout_)) + ")";
-  return res;
 }
 
-std::string SemAcquireSimcall::dot_label() const
+bool ActivityWaitSimcall::is_enabled()
 {
-  return SimcallObserver::dot_label() + "Sem ACQUIRE";
+  // FIXME: if _sg_mc_timeout == 1 and if we have either a sender or receiver timeout, the transition is enabled
+  // because even if the communication is not ready, it can timeout and won't block.
+
+  return activity_->test(get_issuer());
 }
 
-bool SemAcquireSimcall::is_enabled() const
+bool ActivityWaitanySimcall::is_enabled()
 {
-  static bool warned = false;
-  if (not warned) {
-    XBT_INFO("Using semaphore in model-checked code is still experimental. Use at your own risk");
-    warned = true;
-  }
-  return true;
+  // list all the activities that are ready
+  indexes_.clear();
+  for (unsigned i = 0; i < activities_.size(); i++)
+    if (activities_[i]->test(get_issuer()))
+      indexes_.push_back(i);
+
+  //  if (_sg_mc_timeout && timeout_)  FIXME: deal with the potential timeout of the WaitAny
+
+  // FIXME: even if the WaitAny has no timeout, some of the activities may still have one.
+  // we should iterate over the vector searching for them
+  return not indexes_.empty();
 }
 
-std::string ExecutionWaitanySimcall::to_string(int times_considered) const
+int ActivityWaitanySimcall::get_max_consider()
 {
-  std::string res = SimcallObserver::to_string(times_considered) + "Execution WAITANY";
-  res += "(" + (timeout_ == -1.0 ? "" : std::to_string(timeout_)) + ")";
+  // list all the activities that are ready
+  indexes_.clear();
+  for (unsigned i = 0; i < activities_.size(); i++)
+    if (activities_[i]->test(get_issuer()))
+      indexes_.push_back(i);
+
+  int res = indexes_.size();
+  //  if (_sg_mc_timeout && timeout_)
+  //    res++;
+
   return res;
 }
 
-std::string ExecutionWaitanySimcall::dot_label() const
+void ActivityWaitanySimcall::prepare(int times_considered)
+{
+  if (times_considered < static_cast<int>(indexes_.size()))
+    next_value_ = indexes_.at(times_considered);
+  else
+    next_value_ = -1;
+}
+
+void CommIsendSimcall::serialize(std::stringstream& stream) const
 {
-  return SimcallObserver::dot_label() + "Execution WAITANY";
+  stream << (short)mc::Transition::Type::COMM_SEND << ' ';
+  stream << (uintptr_t)comm_ << ' ' << mbox_->get_id() << ' ' << (uintptr_t)src_buff_ << ' ' << src_buff_size_;
+  XBT_DEBUG("SendObserver comm:%p mbox:%u buff:%p size:%zu", comm_, mbox_->get_id(), src_buff_, src_buff_size_);
 }
+
+void CommIrecvSimcall::serialize(std::stringstream& stream) const
+{
+  stream << (short)mc::Transition::Type::COMM_RECV << ' ';
+  stream << (uintptr_t)comm_ << ' ' << mbox_->get_id() << ' ' << (uintptr_t)dst_buff_;
+  XBT_DEBUG("RecvObserver comm:%p mbox:%u buff:%p", comm_, mbox_->get_id(), dst_buff_);
+}
+
 } // namespace actor
 } // namespace kernel
 } // namespace simgrid