Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
do not allocate/free properties
[simgrid.git] / src / s4u / s4u_Actor.cpp
index 6ab12ac..7cb8a48 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2006-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2006-2021. 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. */
@@ -32,8 +32,10 @@ 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;
-xbt::signal<void(Actor const&)> s4u::Actor::on_migration_start; // deprecated
-xbt::signal<void(Actor const&)> s4u::Actor::on_migration_end;   // deprecated
+#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;
@@ -41,19 +43,28 @@ xbt::signal<void(Actor const&)> s4u::Actor::on_destruction;
 // ***** Actor creation *****
 Actor* Actor::self()
 {
-  kernel::context::Context* self_context = kernel::context::Context::self();
+  const kernel::context::Context* self_context = kernel::context::Context::self();
   if (self_context == nullptr)
     return nullptr;
 
-  return self_context->get_actor()->ciface();
+  return self_context->get_actor()->get_ciface();
 }
 
 ActorPtr Actor::init(const std::string& name, s4u::Host* host)
 {
-  kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+  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(); });
-  return actor->iface();
+  return actor->get_iface();
+}
+
+/** Set a non-default stack size for this context (in Kb)
+ *
+ * This must be done before starting the actor, and it won't work with the thread factory. */
+ActorPtr Actor::set_stacksize(unsigned stacksize)
+{
+  pimpl_->set_stacksize(stacksize * 1024);
+  return this;
 }
 
 ActorPtr Actor::start(const std::function<void()>& code)
@@ -64,11 +75,11 @@ ActorPtr Actor::start(const std::function<void()>& code)
 
 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
 {
-  kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+  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); });
 
-  return actor->iface();
+  return actor->get_iface();
 }
 
 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
@@ -87,29 +98,29 @@ void intrusive_ptr_release(const Actor* actor)
 {
   intrusive_ptr_release(actor->pimpl_);
 }
-int Actor::get_refcount()
+int Actor::get_refcount() const
 {
   return pimpl_->get_refcount();
 }
 
 // ***** Actor methods *****
 
-void Actor::join()
+void Actor::join() const
 {
   join(-1);
 }
 
-void Actor::join(double timeout)
+void Actor::join(double timeout) const
 {
   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
-  kernel::actor::ActorImpl* target = pimpl_;
-  kernel::actor::simcall_blocking<void>([issuer, target, timeout] {
+  const kernel::actor::ActorImpl* target = pimpl_;
+  kernel::actor::simcall_blocking([issuer, target, timeout] {
     if (target->finished_) {
       // The joined process is already finished, just wake up the issuer right away
       issuer->simcall_answer();
     } else {
       kernel::activity::ActivityImplPtr sync = issuer->join(target, timeout);
-      sync->register_simcall(&issuer->simcall);
+      sync->register_simcall(&issuer->simcall_);
     }
   });
 }
@@ -120,9 +131,9 @@ void Actor::set_auto_restart(bool autorestart)
     xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
     pimpl_->set_auto_restart(autorestart);
 
-    kernel::actor::ProcessArg* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
+    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);
   });
 }
 
@@ -146,11 +157,11 @@ void Actor::set_host(Host* new_host)
   const s4u::Host* previous_location = get_host();
 
   kernel::actor::simcall([this, new_host]() {
-    if (pimpl_->waiting_synchro != nullptr) {
+    if (pimpl_->waiting_synchro_ != nullptr) {
       // The actor is blocked on an activity. If it's an exec, migrate it too.
       // FIXME: implement the migration of other kinds of activities
       kernel::activity::ExecImplPtr exec =
-          boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
+          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);
     }
@@ -210,7 +221,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 */
@@ -225,7 +236,7 @@ void Actor::resume()
   s4u::Actor::on_resume(*this);
 }
 
-bool Actor::is_suspended()
+bool Actor::is_suspended() const
 {
   return pimpl_->is_suspended();
 }
@@ -236,14 +247,14 @@ void Actor::set_kill_time(double kill_time)
 }
 
 /** @brief Get the kill time of an actor(or 0 if unset). */
-double Actor::get_kill_time()
+double Actor::get_kill_time() const
 {
   return pimpl_->get_kill_time();
 }
 
 void Actor::kill()
 {
-  kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+  const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
   kernel::actor::simcall([this, self] { self->kill(pimpl_); });
 }
 
@@ -251,16 +262,16 @@ void Actor::kill()
 
 ActorPtr Actor::by_pid(aid_t pid)
 {
-  kernel::actor::ActorImpl* actor = SIMIX_process_from_PID(pid);
+  kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(pid);
   if (actor != nullptr)
-    return actor->iface();
+    return actor->get_iface();
   else
     return ActorPtr();
 }
 
 void Actor::kill_all()
 {
-  kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+  const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
   kernel::actor::simcall([self] { self->kill_all(); });
 }
 
@@ -309,19 +320,19 @@ void sleep_for(double duration)
 
   if (duration > 0) {
     kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
-    Actor::on_sleep(*issuer->ciface());
+    Actor::on_sleep(*issuer->get_ciface());
 
-    kernel::actor::simcall_blocking<void>([issuer, duration]() {
+    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);
+      sync->register_simcall(&issuer->simcall_);
     });
 
-    Actor::on_wake_up(*issuer->ciface());
+    Actor::on_wake_up(*issuer->get_ciface());
   }
 }
 
@@ -344,7 +355,7 @@ void execute(double flops)
 
 void execute(double flops, double priority)
 {
-  exec_init(flops)->set_priority(priority)->start()->wait();
+  exec_init(flops)->set_priority(priority)->vetoable_start()->wait();
 }
 
 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
@@ -361,9 +372,7 @@ void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<do
 
 ExecPtr exec_init(double flops_amount)
 {
-  ExecPtr exec = ExecPtr(new Exec());
-  exec->set_flops_amount(flops_amount)->set_host(get_host());
-  return exec;
+  return Exec::init()->set_flops_amount(flops_amount)->set_host(get_host());
 }
 
 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
@@ -374,7 +383,7 @@ ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double
              "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(),
              "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
-             hosts.size(), hosts.size(), flops_amounts.size());
+             hosts.size(), hosts.size(), bytes_amounts.size());
   /* Check that we are not mixing VMs and PMs in the parallel task */
   bool is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(hosts.front()));
   xbt_assert(std::all_of(hosts.begin(), hosts.end(),
@@ -389,15 +398,13 @@ ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double
   xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
              "flops_amounts comprises infinite values!");
 
-  ExecPtr exec = ExecPtr(new Exec());
-  exec->set_flops_amounts(flops_amounts)->set_bytes_amounts(bytes_amounts)->set_hosts(hosts);
-  return exec;
+  return Exec::init()->set_flops_amounts(flops_amounts)->set_bytes_amounts(bytes_amounts)->set_hosts(hosts);
 }
 
 ExecPtr exec_async(double flops)
 {
   ExecPtr res = exec_init(flops);
-  res->start();
+  res->vetoable_start();
   return res;
 }
 
@@ -429,8 +436,8 @@ Host* get_host()
 void suspend()
 {
   kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
-  s4u::Actor::on_suspend(*self->ciface());
-  kernel::actor::simcall_blocking<void>([self] { self->suspend(); });
+  s4u::Actor::on_suspend(*self->get_ciface());
+  kernel::actor::simcall_blocking([self] { self->suspend(); });
 }
 
 void exit()
@@ -441,7 +448,7 @@ void exit()
 
 void on_exit(const std::function<void(bool)>& fun)
 {
-  simgrid::kernel::actor::ActorImpl::self()->iface()->on_exit(fun);
+  simgrid::kernel::actor::ActorImpl::self()->get_iface()->on_exit(fun);
 }
 
 /** @brief Moves the current actor to another host
@@ -450,9 +457,9 @@ void on_exit(const std::function<void(bool)>& fun)
  */
 void set_host(Host* new_host)
 {
-  simgrid::kernel::actor::ActorImpl::self()->iface()->set_host(new_host);
+  simgrid::kernel::actor::ActorImpl::self()->get_iface()->set_host(new_host);
 }
-void migrate(Host* new_host) // deprecated
+void migrate(Host* new_host) // XBT_ATTRIB_DEPRECATED_v329
 {
   set_host(new_host);
 }
@@ -462,18 +469,46 @@ void migrate(Host* new_host) // deprecated
 } // namespace simgrid
 
 /* **************************** Public C interface *************************** */
+size_t sg_actor_count()
+{
+  return simgrid::s4u::Engine::get_instance()->get_actor_count();
+}
+
+sg_actor_t* sg_actor_list()
+{
+  const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
+  size_t actor_count      = e->get_actor_count();
+  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());
+  for (size_t i = 0; i < actor_count; i++)
+    res[i] = actors[i].get();
+  return res;
+}
 
 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)
     function = simgrid::xbt::wrap_main(code, argc, argv);
-  actor->start(std::move(function));
+  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)
+{
+  simgrid::kernel::actor::ActorCode function = simgrid::xbt::wrap_main(code, argc, argv);
+  return simgrid::s4u::Actor::init(name, host)->start(function).get();
+}
+
+void sg_actor_set_stacksize(sg_actor_t actor, unsigned size)
+{
+  actor->set_stacksize(size);
 }
 
 void sg_actor_exit()
@@ -487,7 +522,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 */
@@ -502,7 +537,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();
 }
@@ -514,11 +549,26 @@ 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();
 }
 
+aid_t sg_actor_get_PID(const_sg_actor_t actor) // XBT_ATTRIB_DEPRECATED_v331
+{
+  return sg_actor_get_pid(actor);
+}
+
+aid_t sg_actor_get_PPID(const_sg_actor_t actor) // XBT_ATTRIB_DEPRECATED_v331
+{
+  return sg_actor_get_ppid(actor);
+}
+
+sg_actor_t sg_actor_by_PID(aid_t pid) // XBT_ATTRIB_DEPRECATED_v331
+{
+  return sg_actor_by_pid(pid);
+}
+
 /** @brief Return the name of an actor. */
 const char* sg_actor_get_name(const_sg_actor_t actor)
 {
@@ -587,7 +637,7 @@ void sg_actor_resume(sg_actor_t actor)
  *
  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
  */
-int sg_actor_is_suspended(sg_actor_t actor)
+int sg_actor_is_suspended(const_sg_actor_t actor)
 {
   return actor->is_suspended();
 }
@@ -628,7 +678,7 @@ 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) // deprecated
+void sg_actor_migrate(sg_actor_t process, sg_host_t host) // XBT_ATTRIB_DEPRECATED_v329
 {
   process->set_host(host);
 }
@@ -639,7 +689,7 @@ void sg_actor_migrate(sg_actor_t process, sg_host_t host) // deprecated
  * @param actor the actor to wait for
  * @param timeout wait until the actor is over, or the timeout expires
  */
-void sg_actor_join(sg_actor_t actor, double timeout)
+void sg_actor_join(const_sg_actor_t actor, double timeout)
 {
   actor->join(timeout);
 }
@@ -695,13 +745,13 @@ sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dic
   /* Let's create the process: 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, props).get();
   } catch (simgrid::HostFailureException const&) {
     xbt_die("Could not attach");
   }
 
   simgrid::s4u::this_actor::yield();
-  return actor->ciface();
+  return actor->get_ciface();
 }
 
 void sg_actor_detach()
@@ -724,25 +774,57 @@ const char* sg_actor_self_get_name()
   return simgrid::s4u::this_actor::get_cname();
 }
 
-void* sg_actor_self_data()
+void* sg_actor_self_get_data()
 {
   return simgrid::s4u::Actor::self()->get_data();
 }
 
-void sg_actor_self_data_set(void* userdata)
+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)
+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);
 }
+void sg_actor_execute_with_priority(double flops, double priority)
+{
+  simgrid::s4u::this_actor::exec_init(flops)->set_priority(priority)->wait();
+}
+
+void sg_actor_parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
+{
+  std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
+  std::vector<double> flops;
+  std::vector<double> bytes;
+  if (flops_amount != nullptr)
+    flops = std::vector<double>(flops_amount, flops_amount + host_nb);
+  if (bytes_amount != nullptr)
+    bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
+
+  simgrid::s4u::this_actor::parallel_execute(hosts, flops, bytes);
+}
 
 /** @brief Take an extra reference on that actor to prevent it to be garbage-collected */
 void sg_actor_ref(const_sg_actor_t actor)
@@ -756,20 +838,62 @@ void sg_actor_unref(const_sg_actor_t actor)
 }
 
 /** @brief Return the user data of a #sg_actor_t */
-void* sg_actor_data(const_sg_actor_t actor)
+void* sg_actor_get_data(const_sg_actor_t actor)
 {
   return actor->get_data();
 }
+
 /** @brief Set the user data of a #sg_actor_t */
-void sg_actor_data_set(sg_actor_t actor, void* userdata)
+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.
  */
-void sg_actor_on_exit(int_f_int_pvoid_t fun, void* data)
+void sg_actor_on_exit(void_f_int_pvoid_t fun, void* data)
 {
   simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });
 }
+
+sg_exec_t sg_actor_exec_init(double computation_amount)
+{
+  simgrid::s4u::ExecPtr exec = simgrid::s4u::this_actor::exec_init(computation_amount);
+  exec->add_ref();
+  return exec.get();
+}
+
+sg_exec_t sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount,
+                                      double* bytes_amount)
+{
+  std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
+  std::vector<double> flops;
+  std::vector<double> bytes;
+  if (flops_amount != nullptr)
+    flops = std::vector<double>(flops_amount, flops_amount + host_nb);
+  if (bytes_amount != nullptr)
+    bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
+
+  simgrid::s4u::ExecPtr exec = simgrid::s4u::this_actor::exec_init(hosts, flops, bytes);
+  exec->add_ref();
+  return exec.get();
+}
+
+sg_exec_t sg_actor_exec_async(double computation_amount)
+{
+  simgrid::s4u::ExecPtr exec = simgrid::s4u::this_actor::exec_async(computation_amount);
+  exec->add_ref();
+  return exec.get();
+}