-/* Copyright (c) 2006-2018. The SimGrid Team. All rights reserved. */
+/* Copyright (c) 2006-2019. 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/actor.h"
#include "simgrid/s4u/Actor.hpp"
#include "simgrid/s4u/Exec.hpp"
#include "simgrid/s4u/Host.hpp"
-#include "src/instr/instr_private.hpp"
+#include "src/kernel/activity/ExecImpl.hpp"
+#include "src/simix/smx_host_private.hpp"
#include "src/simix/smx_private.hpp"
+#include "src/surf/HostImpl.hpp"
+
+#include <sstream>
XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
namespace s4u {
simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
+simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
// ***** Actor creation *****
ActorPtr Actor::self()
{
- smx_context_t self_context = SIMIX_context_self();
+ smx_context_t self_context = simgrid::kernel::context::Context::self();
if (self_context == nullptr)
return simgrid::s4u::ActorPtr();
return self_context->process()->iface();
}
-ActorPtr Actor::create(const char* name, s4u::Host* host, std::function<void()> code)
+ActorPtr Actor::create(std::string 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::create(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
+ActorPtr Actor::create(std::string name, s4u::Host* host, std::string 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::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
- return actor->iface();
+ return create(name, host, factory(std::move(args)));
}
void intrusive_ptr_add_ref(Actor* actor)
void Actor::set_auto_restart(bool autorestart)
{
- simgrid::simix::kernelImmediate([this, autorestart]() { pimpl_->auto_restart = autorestart; });
+ simgrid::simix::simcall([this, autorestart]() {
+ xbt_assert(autorestart && not pimpl_->auto_restart_); // FIXME: handle all cases
+ pimpl_->set_auto_restart(autorestart);
+
+ simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->host_, pimpl_);
+ XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
+ pimpl_->host_->pimpl_->actors_at_boot_.emplace_back(arg);
+ });
}
-void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data)
+void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
{
- simcall_process_on_exit(pimpl_, fun, data);
+ simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
}
-/** @brief Moves the actor to another host
- *
- * If the actor is currently blocked on an execution activity, the activity is also
- * migrated to the new host. If it's blocked on another kind of activity, an error is
- * raised as the mandated code is not written yet. Please report that bug if you need it.
- *
- * Asynchronous activities started by the actor are not migrated automatically, so you have
- * to take care of this yourself (only you knows which ones should be migrated).
- */
-void Actor::migrate(Host* new_host)
+void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
{
- std::string key;
- simgrid::instr::LinkType* link = nullptr;
- bool tracing = TRACE_actor_is_enabled();
- if (tracing) {
- static long long int counter = 0;
-
- key = std::to_string(counter);
- counter++;
-
- // start link
- container_t actor_container = simgrid::instr::Container::byName(instr_pid(this));
- link = simgrid::instr::Container::getRoot()->getLink("ACTOR_LINK");
- link->startEvent(actor_container, "M", key);
+ simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+}
- // destroy existing container of this process
- actor_container->removeFromParent();
- }
+void Actor::migrate(Host* new_host)
+{
+ s4u::Actor::on_migration_start(this);
- simgrid::simix::kernelImmediate([this, new_host]() {
+ simgrid::simix::simcall([this, new_host]() {
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 kind of activities
SIMIX_process_change_host(this->pimpl_, new_host);
});
- 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
- link->endEvent(simgrid::instr::Container::byName(instr_pid(this)), "M", key);
- }
+ s4u::Actor::on_migration_end(this);
}
s4u::Host* Actor::get_host()
{
- return this->pimpl_->host;
+ return this->pimpl_->host_;
}
void Actor::daemonize()
{
- simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
+ simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
}
bool Actor::is_daemon() const
{
- return this->pimpl_->isDaemon();
+ return this->pimpl_->is_daemon();
}
const simgrid::xbt::string& Actor::get_name() const
aid_t Actor::get_pid() const
{
- return this->pimpl_->pid;
+ return this->pimpl_->pid_;
}
aid_t Actor::get_ppid() const
{
- return this->pimpl_->ppid;
+ return this->pimpl_->ppid_;
}
void Actor::suspend()
{
- if (TRACE_actor_is_enabled())
- simgrid::instr::Container::byName(instr_pid(this))->getState("ACTOR_STATE")->pushEvent("suspend");
-
+ s4u::Actor::on_suspend(this);
simcall_process_suspend(pimpl_);
}
void Actor::resume()
{
- simgrid::simix::kernelImmediate([this] { pimpl_->resume(); });
- if (TRACE_actor_is_enabled())
- simgrid::instr::Container::byName(instr_pid(this))->getState("ACTOR_STATE")->popEvent();
+ simgrid::simix::simcall([this] { pimpl_->resume(); });
+ s4u::Actor::on_resume(this);
}
-int Actor::is_suspended()
+bool Actor::is_suspended()
{
- return simgrid::simix::kernelImmediate([this] { return pimpl_->suspended; });
+ return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
}
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). */
+/** @brief Get the kill time of an actor(or 0 if unset). */
double Actor::get_kill_time()
{
return SIMIX_timer_get_date(pimpl_->kill_timer);
}
-void Actor::kill(aid_t pid)
+void Actor::kill(aid_t pid) // deprecated
{
smx_actor_t killer = SIMIX_process_self();
smx_actor_t process = SIMIX_process_from_PID(pid);
if (process != nullptr) {
- simgrid::simix::kernelImmediate([killer, process] { SIMIX_process_kill(process, killer); });
+ simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
} else {
std::ostringstream oss;
oss << "kill: (" << pid << ") - No such actor" << std::endl;
void Actor::kill()
{
smx_actor_t process = SIMIX_process_self();
- simgrid::simix::kernelImmediate(
+ simgrid::simix::simcall(
[this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
}
void Actor::kill_all()
{
- simcall_process_killall();
+ smx_actor_t self = SIMIX_process_self();
+ simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
}
-std::map<std::string, std::string>* Actor::get_properties()
+std::unordered_map<std::string, std::string>* Actor::get_properties()
{
- return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
+ return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
}
/** Retrieve the property value (or nullptr if not set) */
-const char* Actor::get_property(const char* key)
+const char* Actor::get_property(std::string key)
{
- return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
+ return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
}
-void Actor::set_property(const char* key, const char* value)
+void Actor::set_property(std::string key, std::string value)
{
- simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
+ simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
}
Actor* Actor::restart()
{
- return simgrid::simix::kernelImmediate([this]() { return pimpl_->restart(); });
+ return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
}
// ***** this_actor *****
void sleep_for(double duration)
{
- if (duration > 0)
+ if (duration > 0) {
+ smx_actor_t actor = SIMIX_process_self();
+ simgrid::s4u::Actor::on_sleep(actor->iface());
+
simcall_process_sleep(duration);
+
+ simgrid::s4u::Actor::on_wake_up(actor->iface());
+ }
}
void yield()
{
- simgrid::simix::kernelImmediate([] { /* do nothing*/ });
+ simgrid::simix::simcall([] { /* do nothing*/ });
}
XBT_PUBLIC void sleep_until(double timeout)
{
double now = SIMIX_get_clock();
if (timeout > now)
- simcall_process_sleep(timeout - now);
+ sleep_for(timeout - now);
}
void execute(double flops)
{
- smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, get_host());
- simcall_execution_wait(s);
+ execute(flops, 1.0 /* priority */);
}
void execute(double flops, double priority)
{
- smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, get_host());
+ exec_init(flops)->set_priority(priority)->start()->wait();
+}
+
+void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
+ std::vector<double> bytes_amounts)
+{
+ parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
+}
+void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
+ std::vector<double> bytes_amounts, double timeout)
+{
+ xbt_assert(hosts.size() > 0, "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(),
+ "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());
+
+ /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
+ * but that's OK because simcall_execution_wait() is called from here too.
+ */
+ smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
+ (flops_amounts.empty() ? nullptr : flops_amounts.data()),
+ (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
+ /* rate */ -1, timeout);
simcall_execution_wait(s);
}
-void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout)
+// deprecated
+void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
{
smx_activity_t s =
- simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, timeout);
+ simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
simcall_execution_wait(s);
+ delete[] flops_amount;
+ delete[] bytes_amount;
}
+// deprecated
void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
{
- smx_activity_t s = simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, -1);
+ smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
+ /* rate */ -1, /*timeout*/ -1);
simcall_execution_wait(s);
+ delete[] flops_amount;
+ delete[] bytes_amount;
}
ExecPtr exec_init(double flops_amount)
aid_t get_pid()
{
- return SIMIX_process_self()->pid;
+ return SIMIX_process_self()->pid_;
}
aid_t get_ppid()
{
- return SIMIX_process_self()->ppid;
+ return SIMIX_process_self()->ppid_;
}
std::string get_name()
Host* get_host()
{
- return SIMIX_process_self()->host;
+ return SIMIX_process_self()->host_;
}
void suspend()
{
- if (TRACE_actor_is_enabled())
- instr::Container::byName(get_name() + "-" + std::to_string(get_pid()))
- ->getState("ACTOR_STATE")
- ->pushEvent("suspend");
- simcall_process_suspend(SIMIX_process_self());
-}
-
-void resume()
-{
- smx_actor_t process = SIMIX_process_self();
- simgrid::simix::kernelImmediate([process] { process->resume(); });
+ smx_actor_t actor = SIMIX_process_self();
+ simgrid::s4u::Actor::on_suspend(actor->iface());
- if (TRACE_actor_is_enabled())
- instr::Container::byName(get_name() + "-" + std::to_string(get_pid()))->getState("ACTOR_STATE")->popEvent();
+ simcall_process_suspend(actor);
}
-bool is_suspended()
+void resume()
{
smx_actor_t process = SIMIX_process_self();
- return simgrid::simix::kernelImmediate([process] { return process->suspended; });
+ simgrid::simix::simcall([process] { process->resume(); });
+ simgrid::s4u::Actor::on_resume(process->iface());
}
-void kill()
+void exit()
{
smx_actor_t process = SIMIX_process_self();
- simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
+ simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
}
-void on_exit(int_f_pvoid_pvoid_t fun, void* data)
+void on_exit(std::function<void(int, void*)> fun, void* data)
{
- simcall_process_on_exit(SIMIX_process_self(), fun, data);
+ SIMIX_process_self()->iface()->on_exit(fun, data);
}
/** @brief Moves the current actor to another host
{
return get_host();
}
-bool isSuspended() /* deprecated */
+void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
{
- return is_suspended();
+ SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
}
-void onExit /* deprecated */ (int_f_pvoid_pvoid_t fun, void* data)
+void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
{
- on_exit(fun, data);
+ on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+}
+void kill() /* deprecated */
+{
+ exit();
}
} // namespace this_actor
/* **************************** Public C interface *************************** */
-/** \ingroup m_actor_management
- * \brief Returns the process ID of \a actor.
+/** @ingroup m_actor_management
+ * @brief Returns the process ID of @a actor.
*
- * This function checks whether \a actor is a valid pointer and return its PID (or 0 in case of problem).
+ * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
*/
-int sg_actor_get_PID(sg_actor_t actor)
+aid_t 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 */
return actor->get_pid();
}
-/** \ingroup m_actor_management
- * \brief Returns the process ID of the parent of \a actor.
+/** @ingroup m_actor_management
+ * @brief Returns the process ID of the parent of @a actor.
*
- * This function checks whether \a actor is a valid pointer and return its parent's PID.
+ * 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.
*/
-int sg_actor_get_PPID(sg_actor_t actor)
+aid_t sg_actor_get_PPID(sg_actor_t actor)
{
return actor->get_ppid();
}
-/** \ingroup m_actor_management
- * \brief Return the name of an actor.
+/** @ingroup m_actor_management
+ *
+ * @brief Return a #sg_actor_t given its PID.
+ *
+ * This function search in the list of all the created sg_actor_t for a sg_actor_t whose PID is equal to @a PID.
+ * 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)
+{
+ return simgrid::s4u::Actor::by_pid(pid).get();
+}
+
+/** @ingroup m_actor_management
+ * @brief Return the name of an actor.
*/
const char* sg_actor_get_name(sg_actor_t actor)
{
return actor->get_host();
}
-/** \ingroup m_actor_management
- * \brief Returns the value of a given actor property
+/** @ingroup m_actor_management
+ * @brief Returns the value of a given actor property
*
- * \param actor an actor
- * \param name a property name
- * \return value of a property (or nullptr if the property is not set)
+ * @param actor an actor
+ * @param name a property name
+ * @return value of a property (or nullptr if the property is not set)
*/
const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
{
return actor->get_property(name);
}
-/** \ingroup m_actor_management
- * \brief Return the list of properties
+/** @ingroup m_actor_management
+ * @brief Return the list of properties
*
* This function returns all the parameters associated with an 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->get_properties();
+ std::unordered_map<std::string, std::string>* props = actor->get_properties();
if (props == nullptr)
return nullptr;
- for (auto const& elm : *props) {
- xbt_dict_set(as_dict, elm.first.c_str(), xbt_strdup(elm.second.c_str()), nullptr);
+ for (auto const& kv : *props) {
+ xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
}
return as_dict;
}
-/** \ingroup m_actor_management
- * \brief Suspend the actor.
+/** @ingroup m_actor_management
+ * @brief Suspend the actor.
*
* This function suspends the actor by suspending the task on which it was waiting for the completion.
*/
actor->suspend();
}
-/** \ingroup m_actor_management
- * \brief Resume a suspended actor.
+/** @ingroup m_actor_management
+ * @brief Resume a suspended actor.
*
* This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
*/
actor->resume();
}
-/** \ingroup m_actor_management
- * \brief Returns true if the actor is suspended .
+/** @ingroup m_actor_management
+ * @brief Returns true if the actor is suspended .
*
* This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
*/
}
/**
- * \ingroup m_actor_management
- * \brief Restarts an actor from the beginning.
+ * @ingroup m_actor_management
+ * @brief Restarts an actor from the beginning.
*/
sg_actor_t sg_actor_restart(sg_actor_t actor)
{
return actor->restart();
}
+/**
+ * @ingroup m_actor_management
+ * @brief Sets the "auto-restart" flag of the actor.
+ * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
+ */
+void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
+{
+ actor->set_auto_restart(auto_restart);
+}
+
/** @ingroup m_actor_management
* @brief This actor will be terminated automatically when the last non-daemon actor finishes
*/
actor->daemonize();
}
-/** \ingroup m_actor_management
- * \brief Migrates an actor to another location.
+/** @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.
+ * This function changes the value of the #sg_host_t on which @a actor is running.
*/
void sg_actor_migrate(sg_actor_t process, sg_host_t host)
{
process->migrate(host);
}
-/** \ingroup m_actor_management
- * \brief Wait for the completion of a #sg_actor_t.
+/** @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
+ * @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->kill();
}
-/** \ingroup m_actor_management
- * \brief Set the kill time of an actor.
+void sg_actor_kill_all()
+{
+ simgrid::s4u::Actor::kill_all();
+}
+
+/** @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.
+ * @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);
}
+
+/** Yield the current actor; let the other actors execute first */
+void sg_actor_yield()
+{
+ simgrid::s4u::this_actor::yield();
+}
