X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/1a64ca4c11a1eb7ba2ecd102f877ac571486a034..84f504218e6e541881d121ba0382f132ff1cf135:/src/s4u/s4u_Actor.cpp

diff --git a/src/s4u/s4u_Actor.cpp b/src/s4u/s4u_Actor.cpp
index 8fdb474ed3..27b2dca710 100644
--- a/src/s4u/s4u_Actor.cpp
+++ b/src/s4u/s4u_Actor.cpp
@@ -1,23 +1,23 @@
-/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-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 "simgrid/Exception.hpp"
-#include "simgrid/actor.h"
-#include "simgrid/modelchecker.h"
-#include "simgrid/s4u/Actor.hpp"
-#include "simgrid/s4u/Exec.hpp"
-#include "simgrid/s4u/Host.hpp"
-#include "simgrid/s4u/VirtualMachine.hpp"
+#include <simgrid/Exception.hpp>
+#include <simgrid/actor.h>
+#include <simgrid/modelchecker.h>
+#include <simgrid/s4u/Actor.hpp>
+#include <simgrid/s4u/Engine.hpp>
+#include <simgrid/s4u/Exec.hpp>
+#include <simgrid/s4u/VirtualMachine.hpp>
+
 #include "src/include/mc/mc.h"
 #include "src/kernel/EngineImpl.hpp"
-#include "src/kernel/activity/ExecImpl.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
 #include "src/mc/mc_replay.hpp"
 #include "src/surf/HostImpl.hpp"
 
 #include <algorithm>
-#include <sstream>
 
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_actor, s4u, "S4U actors");
 
@@ -32,10 +32,6 @@ xbt::signal<void(Actor const&)> s4u::Actor::on_suspend;
 xbt::signal<void(Actor const&)> s4u::Actor::on_resume;
 xbt::signal<void(Actor const&)> s4u::Actor::on_sleep;
 xbt::signal<void(Actor const&)> s4u::Actor::on_wake_up;
-#ifndef DOXYGEN
-xbt::signal<void(Actor const&)> s4u::Actor::on_migration_start; // XBT_ATTRIB_DEPRECATED_v329
-xbt::signal<void(Actor const&)> s4u::Actor::on_migration_end;   // XBT_ATTRIB_DEPRECATED_v329
-#endif
 xbt::signal<void(Actor const&, Host const& previous_location)> s4u::Actor::on_host_change;
 xbt::signal<void(Actor const&)> s4u::Actor::on_termination;
 xbt::signal<void(Actor const&)> s4u::Actor::on_destruction;
@@ -54,7 +50,7 @@ ActorPtr Actor::init(const std::string& name, s4u::Host* host)
 {
   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
   kernel::actor::ActorImpl* actor =
-      kernel::actor::simcall([self, &name, host] { return self->init(name, host).get(); });
+      kernel::actor::simcall_answered([self, &name, host] { return self->init(name, host).get(); });
   return actor->get_iface();
 }
 
@@ -69,7 +65,7 @@ ActorPtr Actor::set_stacksize(unsigned stacksize)
 
 ActorPtr Actor::start(const std::function<void()>& code)
 {
-  simgrid::kernel::actor::simcall([this, &code] { pimpl_->start(code); });
+  simgrid::kernel::actor::simcall_answered([this, &code] { pimpl_->start(code); });
   return this;
 }
 
@@ -77,7 +73,7 @@ ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::func
 {
   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
   kernel::actor::ActorImpl* actor =
-      kernel::actor::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); });
+      kernel::actor::simcall_answered([self, &name, host, &code] { return self->init(name, host)->start(code); });
 
   return actor->get_iface();
 }
@@ -114,9 +110,9 @@ void Actor::join(double timeout) const
 {
   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
   const kernel::actor::ActorImpl* target = pimpl_;
-  kernel::actor::simcall_blocking<void>([issuer, target, timeout] {
-    if (target->finished_) {
-      // The joined process is already finished, just wake up the issuer right away
+  kernel::actor::simcall_blocking([issuer, target, timeout] {
+    if (target->wannadie()) {
+      // The joined actor is already finished, just wake up the issuer right away
       issuer->simcall_answer();
     } else {
       kernel::activity::ActivityImplPtr sync = issuer->join(target, timeout);
@@ -125,59 +121,44 @@ void Actor::join(double timeout) const
   });
 }
 
-void Actor::set_auto_restart(bool autorestart)
+Actor* Actor::set_auto_restart(bool autorestart)
 {
-  kernel::actor::simcall([this, autorestart]() {
-    xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
+  if (autorestart == pimpl_->has_to_auto_restart()) // not changed
+    return this;
+
+  kernel::actor::simcall_answered([this, autorestart]() {
+    xbt_assert(autorestart, "Asking an actor to stop being autorestart is not implemented yet. Ask us if you need it.");
     pimpl_->set_auto_restart(autorestart);
 
     auto* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
     XBT_DEBUG("Adding %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
-    pimpl_->get_host()->pimpl_->add_actor_at_boot(arg);
+    pimpl_->get_host()->get_impl()->add_actor_at_boot(arg);
   });
+  return this;
+}
+int Actor::get_restart_count() const
+{
+  return pimpl_->get_restart_count();
 }
 
 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun) const
 {
-  kernel::actor::simcall([this, &fun] { pimpl_->on_exit->emplace_back(fun); });
+  kernel::actor::simcall_answered([this, &fun] { pimpl_->on_exit->emplace_back(fun); });
 }
 
 void Actor::set_host(Host* new_host)
 {
-  if (s4u::Actor::on_migration_start.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329
-    static bool already_warned = false;
-    if (not already_warned) {
-      XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_start. This will be removed "
-               "in v3.29");
-      already_warned = true;
-    }
-    s4u::Actor::on_migration_start(*this);
-  }
-
   const s4u::Host* previous_location = get_host();
 
-  kernel::actor::simcall([this, new_host]() {
-    if (pimpl_->waiting_synchro_ != nullptr) {
-      // The actor is blocked on an activity. If it's an exec, migrate it too.
+  kernel::actor::simcall_answered([this, new_host]() {
+    for (auto const& activity : pimpl_->activities_) {
       // FIXME: implement the migration of other kinds of activities
-      kernel::activity::ExecImplPtr exec =
-          boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro_);
-      xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
-      exec->migrate(new_host);
+      if (auto exec = boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(activity))
+        exec->migrate(new_host);
     }
     this->pimpl_->set_host(new_host);
   });
 
-  if (s4u::Actor::on_migration_end.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329
-    static bool already_warned = false;
-    if (not already_warned) {
-      XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_end. This will be removed in "
-               "v3.29");
-      already_warned = true;
-    }
-    s4u::Actor::on_migration_end(*this);
-  }
-
   s4u::Actor::on_host_change(*this, *previous_location);
 }
 
@@ -186,9 +167,10 @@ s4u::Host* Actor::get_host() const
   return this->pimpl_->get_host();
 }
 
-void Actor::daemonize()
+Actor* Actor::daemonize()
 {
-  kernel::actor::simcall([this]() { pimpl_->daemonize(); });
+  kernel::actor::simcall_answered([this]() { pimpl_->daemonize(); });
+  return this;
 }
 
 bool Actor::is_daemon() const
@@ -196,6 +178,12 @@ bool Actor::is_daemon() const
   return this->pimpl_->is_daemon();
 }
 
+bool Actor::is_maestro()
+{
+  const auto* self = kernel::actor::ActorImpl::self();
+  return self == nullptr || kernel::EngineImpl::get_instance()->is_maestro(self);
+}
+
 const simgrid::xbt::string& Actor::get_name() const
 {
   return this->pimpl_->get_name();
@@ -221,7 +209,7 @@ void Actor::suspend()
   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
   kernel::actor::ActorImpl* target = pimpl_;
   s4u::Actor::on_suspend(*this);
-  kernel::actor::simcall_blocking<void>([issuer, target]() {
+  kernel::actor::simcall_blocking([issuer, target]() {
     target->suspend();
     if (target != issuer) {
       /* If we are suspending ourselves, then just do not finish the simcall now */
@@ -232,7 +220,7 @@ void Actor::suspend()
 
 void Actor::resume()
 {
-  kernel::actor::simcall([this] { pimpl_->resume(); });
+  kernel::actor::simcall_answered([this] { pimpl_->resume(); });
   s4u::Actor::on_resume(*this);
 }
 
@@ -243,7 +231,7 @@ bool Actor::is_suspended() const
 
 void Actor::set_kill_time(double kill_time)
 {
-  kernel::actor::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
+  kernel::actor::simcall_answered([this, kill_time] { pimpl_->set_kill_time(kill_time); });
 }
 
 /** @brief Get the kill time of an actor(or 0 if unset). */
@@ -255,14 +243,14 @@ double Actor::get_kill_time() const
 void Actor::kill()
 {
   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
-  kernel::actor::simcall([this, self] { self->kill(pimpl_); });
+  kernel::actor::simcall_answered([this, self] { self->kill(pimpl_); });
 }
 
 // ***** Static functions *****
 
 ActorPtr Actor::by_pid(aid_t pid)
 {
-  kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_PID(pid);
+  kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(pid);
   if (actor != nullptr)
     return actor->get_iface();
   else
@@ -272,7 +260,7 @@ ActorPtr Actor::by_pid(aid_t pid)
 void Actor::kill_all()
 {
   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
-  kernel::actor::simcall([self] { self->kill_all(); });
+  kernel::actor::simcall_answered([self] { self->kill_all(); });
 }
 
 const std::unordered_map<std::string, std::string>* Actor::get_properties() const
@@ -288,12 +276,12 @@ const char* Actor::get_property(const std::string& key) const
 
 void Actor::set_property(const std::string& key, const std::string& value)
 {
-  kernel::actor::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
+  kernel::actor::simcall_answered([this, &key, &value] { pimpl_->set_property(key, value); });
 }
 
 Actor* Actor::restart()
 {
-  return kernel::actor::simcall([this]() { return pimpl_->restart(); });
+  return kernel::actor::simcall_answered([this]() { return pimpl_->restart(); });
 }
 
 // ***** this_actor *****
@@ -311,39 +299,51 @@ namespace this_actor {
  */
 bool is_maestro()
 {
-  return SIMIX_is_maestro();
+  return Actor::is_maestro();
 }
 
 void sleep_for(double duration)
 {
   xbt_assert(std::isfinite(duration), "duration is not finite!");
 
-  if (duration > 0) {
-    kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
-    Actor::on_sleep(*issuer->get_ciface());
-
-    kernel::actor::simcall_blocking<void>([issuer, duration]() {
-      if (MC_is_active() || MC_record_replay_is_active()) {
-        MC_process_clock_add(issuer, duration);
-        issuer->simcall_answer();
-        return;
-      }
-      kernel::activity::ActivityImplPtr sync = issuer->sleep(duration);
-      sync->register_simcall(&issuer->simcall_);
-    });
-
-    Actor::on_wake_up(*issuer->get_ciface());
+  if (duration <= 0) /* that's a no-op */
+    return;
+
+  if (duration < sg_surf_precision) {
+    static unsigned int warned = 0; // At most 20 such warnings
+    warned++;
+    if (warned <= 20)
+      XBT_INFO("The parameter to sleep_for() is smaller than the SimGrid numerical accuracy (%g < %g). "
+               "Please refer to https://simgrid.org/doc/latest/Configuring_SimGrid.html#numerical-precision",
+               duration, sg_surf_precision);
+    if (warned == 20)
+      XBT_VERB("(further warnings about the numerical accuracy of sleep_for() will be omitted).");
   }
+
+  kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+  Actor::on_sleep(*issuer->get_ciface());
+
+  kernel::actor::simcall_blocking([issuer, duration]() {
+    if (MC_is_active() || MC_record_replay_is_active()) {
+      MC_process_clock_add(issuer, duration);
+      issuer->simcall_answer();
+      return;
+    }
+    kernel::activity::ActivityImplPtr sync = issuer->sleep(duration);
+    sync->register_simcall(&issuer->simcall_);
+  });
+
+  Actor::on_wake_up(*issuer->get_ciface());
 }
 
 void yield()
 {
-  kernel::actor::simcall([] { /* do nothing*/ });
+  kernel::actor::simcall_answered([] { /* do nothing*/ });
 }
 
 XBT_PUBLIC void sleep_until(double wakeup_time)
 {
-  double now = SIMIX_get_clock();
+  double now = s4u::Engine::get_clock();
   if (wakeup_time > now)
     sleep_for(wakeup_time - now);
 }
@@ -364,10 +364,9 @@ void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<do
   exec_init(hosts, flops_amounts, bytes_amounts)->wait();
 }
 
-void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
-                      const std::vector<double>& bytes_amounts, double timeout) // XBT_ATTRIB_DEPRECATED_v329
+void thread_execute(s4u::Host* host, double flops_amount, int thread_count)
 {
-  exec_init(hosts, flops_amounts, bytes_amounts)->wait_for(timeout);
+  Exec::init()->set_flops_amount(flops_amount)->set_host(host)->set_thread_count(thread_count)->wait();
 }
 
 ExecPtr exec_init(double flops_amount)
@@ -378,7 +377,7 @@ ExecPtr exec_init(double flops_amount)
 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
                   const std::vector<double>& bytes_amounts)
 {
-  xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
+  xbt_assert(not hosts.empty(), "Your parallel executions must span over at least one host.");
   xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
              "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
   xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
@@ -437,13 +436,14 @@ void suspend()
 {
   kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
   s4u::Actor::on_suspend(*self->get_ciface());
-  kernel::actor::simcall_blocking<void>([self] { self->suspend(); });
+  kernel::actor::simcall_blocking([self] { self->suspend(); });
 }
 
 void exit()
 {
   kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
-  simgrid::kernel::actor::simcall([self] { self->exit(); });
+  simgrid::kernel::actor::simcall_answered([self] { self->exit(); });
+  THROW_IMPOSSIBLE;
 }
 
 void on_exit(const std::function<void(bool)>& fun)
@@ -459,10 +459,6 @@ void set_host(Host* new_host)
 {
   simgrid::kernel::actor::ActorImpl::self()->get_iface()->set_host(new_host);
 }
-void migrate(Host* new_host) // XBT_ATTRIB_DEPRECATED_v329
-{
-  set_host(new_host);
-}
 
 } // namespace this_actor
 } // namespace s4u
@@ -481,7 +477,7 @@ sg_actor_t* sg_actor_list()
   xbt_assert(actor_count > 0, "There is no actor!");
   std::vector<simgrid::s4u::ActorPtr> actors = e->get_all_actors();
 
-  sg_actor_t* res = xbt_new(sg_actor_t, actors.size());
+  auto* res = xbt_new(sg_actor_t, actors.size());
   for (size_t i = 0; i < actor_count; i++)
     res[i] = actors[i].get();
   return res;
@@ -492,7 +488,7 @@ sg_actor_t sg_actor_init(const char* name, sg_host_t host)
   return simgrid::s4u::Actor::init(name, host).get();
 }
 
-void sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char* const* argv)
+void sg_actor_start_(sg_actor_t actor, xbt_main_func_t code, int argc, const char* const* argv)
 {
   simgrid::kernel::actor::ActorCode function;
   if (code)
@@ -500,7 +496,7 @@ void sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char
   actor->start(function);
 }
 
-sg_actor_t sg_actor_create(const char* name, sg_host_t host, xbt_main_func_t code, int argc, const char* const* argv)
+sg_actor_t sg_actor_create_(const char* name, sg_host_t host, xbt_main_func_t code, int argc, const char* const* argv)
 {
   simgrid::kernel::actor::ActorCode function = simgrid::xbt::wrap_main(code, argc, argv);
   return simgrid::s4u::Actor::init(name, host)->start(function).get();
@@ -522,7 +518,7 @@ void sg_actor_exit()
  * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
  */
 
-aid_t sg_actor_get_PID(const_sg_actor_t actor)
+aid_t sg_actor_get_pid(const_sg_actor_t actor)
 {
   /* Do not raise an exception here: this function is called by the logs
    * and the exceptions, so it would be called back again and again */
@@ -537,7 +533,7 @@ aid_t sg_actor_get_PID(const_sg_actor_t actor)
  * This function checks whether @a actor is a valid pointer and return its parent's PID.
  * Returns -1 if the actor has not been created by any other actor.
  */
-aid_t sg_actor_get_PPID(const_sg_actor_t actor)
+aid_t sg_actor_get_ppid(const_sg_actor_t actor)
 {
   return actor->get_ppid();
 }
@@ -549,7 +545,7 @@ aid_t sg_actor_get_PPID(const_sg_actor_t actor)
  * If none is found, @c nullptr is returned.
    Note that the PID are unique in the whole simulation, not only on a given host.
  */
-sg_actor_t sg_actor_by_PID(aid_t pid)
+sg_actor_t sg_actor_by_pid(aid_t pid)
 {
   return simgrid::s4u::Actor::by_pid(pid).get();
 }
@@ -663,10 +659,6 @@ void sg_actor_set_host(sg_actor_t actor, sg_host_t host)
 {
   actor->set_host(host);
 }
-void sg_actor_migrate(sg_actor_t process, sg_host_t host) // XBT_ATTRIB_DEPRECATED_v329
-{
-  process->set_host(host);
-}
 
 /**
  * @brief Wait for the completion of a #sg_actor_t.
@@ -727,10 +719,11 @@ sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dic
     props[key] = value;
   xbt_dict_free(&properties);
 
-  /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
+  /* Let's create the actor: SIMIX may decide to start it right now, even before returning the flow control to us */
   smx_actor_t actor = nullptr;
   try {
-    actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
+    actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host).get();
+    actor->set_properties(props);
   } catch (simgrid::HostFailureException const&) {
     xbt_die("Could not attach");
   }
@@ -761,7 +754,7 @@ const char* sg_actor_self_get_name()
 
 void* sg_actor_self_get_data()
 {
-  return simgrid::s4u::Actor::self()->get_data();
+  return simgrid::s4u::Actor::self()->get_data<void>();
 }
 
 void sg_actor_self_set_data(void* userdata)
@@ -769,26 +762,11 @@ void sg_actor_self_set_data(void* userdata)
   simgrid::s4u::Actor::self()->set_data(userdata);
 }
 
-void* sg_actor_self_data() // XBT_ATTRIB_DEPRECATED_v330
-{
-  return sg_actor_self_get_data();
-}
-
-void sg_actor_self_data_set(void* userdata) // XBT_ATTRIB_DEPRECATED_v330
-{
-  sg_actor_self_set_data(userdata);
-}
-
 sg_actor_t sg_actor_self()
 {
   return simgrid::s4u::Actor::self();
 }
 
-void sg_actor_self_execute(double flops) // XBT_ATTRIB_DEPRECATED_v330
-{
-  simgrid::s4u::this_actor::execute(flops);
-}
-
 void sg_actor_execute(double flops)
 {
   simgrid::s4u::this_actor::execute(flops);
@@ -825,7 +803,7 @@ void sg_actor_unref(const_sg_actor_t actor)
 /** @brief Return the user data of a #sg_actor_t */
 void* sg_actor_get_data(const_sg_actor_t actor)
 {
-  return actor->get_data();
+  return actor->get_data<void>();
 }
 
 /** @brief Set the user data of a #sg_actor_t */
@@ -834,19 +812,9 @@ void sg_actor_set_data(sg_actor_t actor, void* userdata)
   actor->set_data(userdata);
 }
 
-void* sg_actor_data(const_sg_actor_t actor) // XBT_ATTRIB_DEPRECATED_v330
-{
-  return sg_actor_get_data(actor);
-}
-
-void sg_actor_data_set(sg_actor_t actor, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
-{
-  sg_actor_set_data(actor, userdata);
-}
-
-/** @brief Add a function to the list of "on_exit" functions for the current process.
- *  The on_exit functions are the functions executed when your process is killed.
- *  You should use them to free the data used by your process.
+/** @brief Add a function to the list of "on_exit" functions for the current actor.
+ *  The on_exit functions are the functions executed when your actor is killed.
+ *  You should use them to free the data used by your actor.
  */
 void sg_actor_on_exit(void_f_int_pvoid_t fun, void* data)
 {