Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
further snake_case Actor (::this_actor remains)
[simgrid.git] / src / s4u / s4u_actor.cpp
index e8b3fdf..f0d1a57 100644 (file)
@@ -3,26 +3,19 @@
 /* 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 "xbt/log.h"
-
 #include "simgrid/s4u/Actor.hpp"
-#include "simgrid/s4u/Comm.hpp"
 #include "simgrid/s4u/Exec.hpp"
 #include "simgrid/s4u/Host.hpp"
-#include "simgrid/s4u/Mailbox.hpp"
-
-#include "src/kernel/context/Context.hpp"
+#include "src/instr/instr_private.hpp"
 #include "src/simix/smx_private.hpp"
 
-#include <sstream>
-
 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
 
 namespace simgrid {
 namespace s4u {
 
-simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::onCreation;
-simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::onDestruction;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
 
 // ***** Actor creation *****
 ActorPtr Actor::self()
@@ -34,17 +27,17 @@ ActorPtr Actor::self()
   return self_context->process()->iface();
 }
 
-ActorPtr Actor::createActor(const char* name, s4u::Host* host, std::function<void()> code)
+ActorPtr Actor::create(const char* name, s4u::Host* host, std::function<void()> code)
 {
-  simgrid::simix::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
+  simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
   return actor->iface();
 }
 
-ActorPtr Actor::createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
+ActorPtr Actor::create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
 {
   simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
   simgrid::simix::ActorCode code = factory(std::move(args));
-  simgrid::simix::ActorImpl* actor          = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
+  simgrid::kernel::actor::ActorImpl* actor  = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
   return actor->iface();
 }
 
@@ -68,11 +61,12 @@ void Actor::join(double timeout)
   simcall_process_join(this->pimpl_, timeout);
 }
 
-void Actor::setAutoRestart(bool autorestart) {
+void Actor::set_auto_restart(bool autorestart)
+{
   simgrid::simix::kernelImmediate([this, autorestart]() { pimpl_->auto_restart = autorestart; });
 }
 
-void Actor::onExit(int_f_pvoid_pvoid_t fun, void* data)
+void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data)
 {
   simcall_process_on_exit(pimpl_, fun, data);
 }
@@ -119,14 +113,13 @@ void Actor::migrate(Host* new_host)
 
   if (TRACE_actor_is_enabled()) {
     // create new container on the new_host location
-    new simgrid::instr::Container(instr_pid(this), "ACTOR", simgrid::instr::Container::byName(new_host->getName()));
-
+    simgrid::instr::Container::byName(new_host->get_name())->createChild(instr_pid(this), "ACTOR");
     // end link
     link->endEvent(simgrid::instr::Container::byName(instr_pid(this)), "M", key);
   }
 }
 
-s4u::Host* Actor::getHost()
+s4u::Host* Actor::get_host()
 {
   return this->pimpl_->host;
 }
@@ -136,27 +129,27 @@ void Actor::daemonize()
   simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
 }
 
-bool Actor::isDaemon()
+bool Actor::is_daemon() const
 {
   return this->pimpl_->isDaemon();
 }
 
-const simgrid::xbt::string& Actor::getName() const
+const simgrid::xbt::string& Actor::get_name() const
 {
-  return this->pimpl_->getName();
+  return this->pimpl_->get_name();
 }
 
-const char* Actor::getCname() const
+const char* Actor::get_cname() const
 {
-  return this->pimpl_->getCname();
+  return this->pimpl_->get_cname();
 }
 
-aid_t Actor::getPid()
+aid_t Actor::get_pid() const
 {
   return this->pimpl_->pid;
 }
 
-aid_t Actor::getPpid()
+aid_t Actor::get_ppid() const
 {
   return this->pimpl_->ppid;
 }
@@ -176,17 +169,18 @@ void Actor::resume()
     simgrid::instr::Container::byName(instr_pid(this))->getState("ACTOR_STATE")->popEvent();
 }
 
-int Actor::isSuspended()
+int Actor::is_suspended()
 {
   return simgrid::simix::kernelImmediate([this] { return pimpl_->suspended; });
 }
 
-void Actor::setKillTime(double time) {
+void Actor::set_kill_time(double time)
+{
   simcall_process_set_kill_time(pimpl_,time);
 }
 
 /** \brief Get the kill time of an actor(or 0 if unset). */
-double Actor::getKillTime()
+double Actor::get_kill_time()
 {
   return SIMIX_timer_get_date(pimpl_->kill_timer);
 }
@@ -210,14 +204,14 @@ void Actor::kill() {
       [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
 }
 
-smx_actor_t Actor::getImpl()
+smx_actor_t Actor::get_impl()
 {
   return pimpl_;
 }
 
 // ***** Static functions *****
 
-ActorPtr Actor::byPid(aid_t pid)
+ActorPtr Actor::by_pid(aid_t pid)
 {
   smx_actor_t process = SIMIX_process_from_PID(pid);
   if (process != nullptr)
@@ -226,23 +220,23 @@ ActorPtr Actor::byPid(aid_t pid)
     return ActorPtr();
 }
 
-void Actor::killAll()
+void Actor::kill_all()
 {
   simcall_process_killall();
 }
 
-std::map<std::string, std::string>* Actor::getProperties()
+std::map<std::string, std::string>* Actor::get_properties()
 {
   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
 }
 
 /** Retrieve the property value (or nullptr if not set) */
-const char* Actor::getProperty(const char* key)
+const char* Actor::get_property(const char* key)
 {
   return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
 }
 
-void Actor::setProperty(const char* key, const char* value)
+void Actor::set_property(const char* key, const char* value)
 {
   simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
 }
@@ -319,7 +313,7 @@ ExecPtr exec_init(double flops_amount)
   ExecPtr res        = ExecPtr(new Exec());
   res->host_         = getHost();
   res->flops_amount_ = flops_amount;
-  res->setRemains(flops_amount);
+  res->set_remaining(flops_amount);
   return res;
 }
 
@@ -340,14 +334,14 @@ aid_t getPpid()
   return SIMIX_process_self()->ppid;
 }
 
-std::string getName()
+std::string get_name()
 {
-  return SIMIX_process_self()->getName();
+  return SIMIX_process_self()->get_name();
 }
 
-const char* getCname()
+const char* get_cname()
 {
-  return SIMIX_process_self()->getCname();
+  return SIMIX_process_self()->get_cname();
 }
 
 Host* getHost()
@@ -358,7 +352,9 @@ Host* getHost()
 void suspend()
 {
   if (TRACE_actor_is_enabled())
-    instr::Container::byName(getName() + "-" + std::to_string(getPid()))->getState("ACTOR_STATE")->pushEvent("suspend");
+    instr::Container::byName(get_name() + "-" + std::to_string(getPid()))
+        ->getState("ACTOR_STATE")
+        ->pushEvent("suspend");
   simcall_process_suspend(SIMIX_process_self());
 }
 
@@ -368,7 +364,7 @@ void resume()
   simgrid::simix::kernelImmediate([process] { process->resume(); });
 
   if (TRACE_actor_is_enabled())
-    instr::Container::byName(getName() + "-" + std::to_string(getPid()))->getState("ACTOR_STATE")->popEvent();
+    instr::Container::byName(get_name() + "-" + std::to_string(getPid()))->getState("ACTOR_STATE")->popEvent();
 }
 
 bool isSuspended()
@@ -396,12 +392,13 @@ void migrate(Host* new_host)
 {
   SIMIX_process_self()->iface()->migrate(new_host);
 }
+
 } // namespace this_actor
 } // namespace s4u
 } // namespace simgrid
 
 /* **************************** Public C interface *************************** */
-SG_BEGIN_DECL()
+
 /** \ingroup m_actor_management
  * \brief Returns the process ID of \a actor.
  *
@@ -411,9 +408,9 @@ int sg_actor_get_PID(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 */
-  if (actor == nullptr || actor->getImpl() == nullptr)
+  if (actor == nullptr || actor->get_impl() == nullptr)
     return 0;
-  return actor->getPid();
+  return actor->get_pid();
 }
 
 /** \ingroup m_actor_management
@@ -424,7 +421,7 @@ int sg_actor_get_PID(sg_actor_t actor)
  */
 int sg_actor_get_PPID(sg_actor_t actor)
 {
-  return actor->getPpid();
+  return actor->get_ppid();
 }
 
 /** \ingroup m_actor_management
@@ -432,12 +429,12 @@ int sg_actor_get_PPID(sg_actor_t actor)
  */
 const char* sg_actor_get_name(sg_actor_t actor)
 {
-  return actor->getCname();
+  return actor->get_cname();
 }
 
 sg_host_t sg_actor_get_host(sg_actor_t actor)
 {
-  return actor->getHost();
+  return actor->get_host();
 }
 
 /** \ingroup m_actor_management
@@ -449,7 +446,7 @@ sg_host_t sg_actor_get_host(sg_actor_t actor)
  */
 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
 {
-  return actor->getProperty(name);
+  return actor->get_property(name);
 }
 
 /** \ingroup m_actor_management
@@ -461,7 +458,7 @@ xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
 {
   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
   xbt_dict_t as_dict = xbt_dict_new_homogeneous(xbt_free_f);
-  std::map<std::string, std::string>* props = actor->getProperties();
+  std::map<std::string, std::string>* props = actor->get_properties();
   if (props == nullptr)
     return nullptr;
   for (auto const& elm : *props) {
@@ -499,7 +496,7 @@ void sg_actor_resume(sg_actor_t actor)
  */
 int sg_actor_is_suspended(sg_actor_t actor)
 {
-  return actor->isSuspended();
+  return actor->is_suspended();
 }
 
 /**
@@ -519,7 +516,7 @@ void sg_actor_daemonize(sg_actor_t actor)
   actor->daemonize();
 }
 
-/** \ingroup m_process_management
+/** \ingroup m_actor_management
  * \brief Migrates an actor to another location.
  *
  * This function changes the value of the #sg_host_t on  which \a actor is running.
@@ -529,4 +526,29 @@ void sg_actor_migrate(sg_actor_t process, sg_host_t host)
   process->migrate(host);
 }
 
-SG_END_DECL()
+/** \ingroup m_actor_management
+* \brief Wait for the completion of a #sg_actor_t.
+*
+* \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)
+{
+  actor->join(timeout);
+}
+
+void sg_actor_kill(sg_actor_t actor)
+{
+  actor->kill();
+}
+
+/** \ingroup m_actor_management
+ * \brief Set the kill time of an actor.
+ *
+ * \param actor an actor
+ * \param kill_time the time when the actor is killed.
+ */
+void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
+{
+  actor->set_kill_time(kill_time);
+}