Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix scan-build warning (link may be null).
[simgrid.git] / src / s4u / s4u_actor.cpp
index 8803ed0..9afb794 100644 (file)
@@ -14,8 +14,8 @@ 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()
@@ -27,13 +27,13 @@ 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::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));
@@ -61,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);
 }
@@ -83,7 +84,8 @@ void Actor::migrate(Host* new_host)
 {
   std::string key;
   simgrid::instr::LinkType* link = nullptr;
-  if (TRACE_actor_is_enabled()) {
+  bool tracing                   = TRACE_actor_is_enabled();
+  if (tracing) {
     static long long int counter = 0;
 
     key = std::to_string(counter);
@@ -110,7 +112,7 @@ void Actor::migrate(Host* new_host)
     SIMIX_process_change_host(this->pimpl_, new_host);
   });
 
-  if (TRACE_actor_is_enabled()) {
+  if (tracing) {
     // create new container on the new_host location
     simgrid::instr::Container::byName(new_host->get_name())->createChild(instr_pid(this), "ACTOR");
     // end link
@@ -118,7 +120,7 @@ void Actor::migrate(Host* new_host)
   }
 }
 
-s4u::Host* Actor::getHost()
+s4u::Host* Actor::get_host()
 {
   return this->pimpl_->host;
 }
@@ -128,7 +130,7 @@ void Actor::daemonize()
   simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
 }
 
-bool Actor::isDaemon()
+bool Actor::is_daemon() const
 {
   return this->pimpl_->isDaemon();
 }
@@ -143,12 +145,12 @@ const char* Actor::get_cname() const
   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;
 }
@@ -168,17 +170,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);
 }
@@ -202,14 +205,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)
@@ -218,23 +221,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); });
 }
@@ -257,7 +260,7 @@ namespace this_actor {
  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
  * because it is the one scheduling when the others should move or wait.
  */
-bool isMaestro()
+bool is_maestro()
 {
   smx_actor_t process = SIMIX_process_self();
   return process == nullptr || process == simix_global->maestro_process;
@@ -283,13 +286,13 @@ XBT_PUBLIC void sleep_until(double timeout)
 
 void execute(double flops)
 {
-  smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, getHost());
+  smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, get_host());
   simcall_execution_wait(s);
 }
 
 void execute(double flops, double priority)
 {
-  smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, getHost());
+  smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, get_host());
   simcall_execution_wait(s);
 }
 
@@ -309,9 +312,9 @@ void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, d
 ExecPtr exec_init(double flops_amount)
 {
   ExecPtr res        = ExecPtr(new Exec());
-  res->host_         = getHost();
+  res->host_         = get_host();
   res->flops_amount_ = flops_amount;
-  res->setRemains(flops_amount);
+  res->set_remaining(flops_amount);
   return res;
 }
 
@@ -322,12 +325,12 @@ ExecPtr exec_async(double flops)
   return res;
 }
 
-aid_t getPid()
+aid_t get_pid()
 {
   return SIMIX_process_self()->pid;
 }
 
-aid_t getPpid()
+aid_t get_ppid()
 {
   return SIMIX_process_self()->ppid;
 }
@@ -342,7 +345,7 @@ const char* get_cname()
   return SIMIX_process_self()->get_cname();
 }
 
-Host* getHost()
+Host* get_host()
 {
   return SIMIX_process_self()->host;
 }
@@ -350,7 +353,7 @@ Host* getHost()
 void suspend()
 {
   if (TRACE_actor_is_enabled())
-    instr::Container::byName(get_name() + "-" + std::to_string(getPid()))
+    instr::Container::byName(get_name() + "-" + std::to_string(get_pid()))
         ->getState("ACTOR_STATE")
         ->pushEvent("suspend");
   simcall_process_suspend(SIMIX_process_self());
@@ -362,10 +365,10 @@ void resume()
   simgrid::simix::kernelImmediate([process] { process->resume(); });
 
   if (TRACE_actor_is_enabled())
-    instr::Container::byName(get_name() + "-" + std::to_string(getPid()))->getState("ACTOR_STATE")->popEvent();
+    instr::Container::byName(get_name() + "-" + std::to_string(get_pid()))->getState("ACTOR_STATE")->popEvent();
 }
 
-bool isSuspended()
+bool is_suspended()
 {
   smx_actor_t process = SIMIX_process_self();
   return simgrid::simix::kernelImmediate([process] { return process->suspended; });
@@ -377,7 +380,7 @@ void kill()
   simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
 }
 
-void onExit(int_f_pvoid_pvoid_t fun, void* data)
+void on_exit(int_f_pvoid_pvoid_t fun, void* data)
 {
   simcall_process_on_exit(SIMIX_process_self(), fun, data);
 }
@@ -391,6 +394,39 @@ void migrate(Host* new_host)
   SIMIX_process_self()->iface()->migrate(new_host);
 }
 
+std::string getName() /* deprecated */
+{
+  return get_name();
+}
+const char* getCname() /* deprecated */
+{
+  return get_cname();
+}
+bool isMaestro() /* deprecated */
+{
+  return is_maestro();
+}
+aid_t getPid() /* deprecated */
+{
+  return get_pid();
+}
+aid_t getPpid() /* deprecated */
+{
+  return get_ppid();
+}
+Host* getHost() /* deprecated */
+{
+  return get_host();
+}
+bool isSuspended() /* deprecated */
+{
+  return is_suspended();
+}
+void onExit /* deprecated */ (int_f_pvoid_pvoid_t fun, void* data)
+{
+  on_exit(fun, data);
+}
+
 } // namespace this_actor
 } // namespace s4u
 } // namespace simgrid
@@ -406,9 +442,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
@@ -419,7 +455,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,7 +468,7 @@ const char* sg_actor_get_name(sg_actor_t actor)
 
 sg_host_t sg_actor_get_host(sg_actor_t actor)
 {
-  return actor->getHost();
+  return actor->get_host();
 }
 
 /** \ingroup m_actor_management
@@ -444,7 +480,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
@@ -456,7 +492,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) {
@@ -494,7 +530,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();
 }
 
 /**
@@ -548,5 +584,5 @@ void sg_actor_kill(sg_actor_t actor)
  */
 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 {
-  actor->setKillTime(kill_time);
+  actor->set_kill_time(kill_time);
 }