-/* Copyright (c) 2006-2019. 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. */
+#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 "src/include/mc/mc.h"
+#include "src/kernel/EngineImpl.hpp"
#include "src/kernel/activity/ExecImpl.hpp"
-#include "src/simix/smx_host_private.hpp"
-#include "src/simix/smx_private.hpp"
+#include "src/mc/mc_replay.hpp"
#include "src/surf/HostImpl.hpp"
+#include <algorithm>
#include <sstream>
-XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_actor, s4u, "S4U actors");
namespace simgrid {
+
+template class xbt::Extendable<s4u::Actor>;
+
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;
+xbt::signal<void(Actor&)> s4u::Actor::on_creation;
+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;
// ***** Actor creation *****
-ActorPtr Actor::self()
+Actor* Actor::self()
{
- smx_context_t self_context = simgrid::kernel::context::Context::self();
+ const kernel::context::Context* self_context = kernel::context::Context::self();
if (self_context == nullptr)
- return simgrid::s4u::ActorPtr();
+ return nullptr;
- return self_context->get_actor()->iface();
+ return self_context->get_actor()->get_ciface();
}
-ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
+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(); });
+ 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)
{
- simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
- return actor->iface();
+ pimpl_->set_stacksize(stacksize * 1024);
+ return this;
}
-ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
+ActorPtr Actor::start(const std::function<void()>& code)
{
- simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
+ simgrid::kernel::actor::simcall([this, &code] { pimpl_->start(code); });
+ return this;
+}
+
+ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
+{
+ 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->get_iface();
+}
+
+ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
+ std::vector<std::string> args)
+{
+ const simgrid::kernel::actor::ActorCodeFactory& factory =
+ simgrid::kernel::EngineImpl::get_instance()->get_function(function);
return create(name, host, factory(std::move(args)));
}
-void intrusive_ptr_add_ref(Actor* actor)
+void intrusive_ptr_add_ref(const Actor* actor)
{
intrusive_ptr_add_ref(actor->pimpl_);
}
-void intrusive_ptr_release(Actor* actor)
+void intrusive_ptr_release(const Actor* actor)
{
intrusive_ptr_release(actor->pimpl_);
}
+int Actor::get_refcount() const
+{
+ return pimpl_->get_refcount();
+}
// ***** Actor methods *****
-void Actor::join()
+void Actor::join() const
{
- simcall_process_join(this->pimpl_, -1);
+ join(-1);
}
-void Actor::join(double timeout)
+void Actor::join(double timeout) const
{
- simcall_process_join(this->pimpl_, timeout);
+ kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+ 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_);
+ }
+ });
}
void Actor::set_auto_restart(bool autorestart)
{
- simgrid::simix::simcall([this, autorestart]() {
- xbt_assert(autorestart && not pimpl_->auto_restart_); // FIXME: handle all cases
+ kernel::actor::simcall([this, autorestart]() {
+ xbt_assert(autorestart && not pimpl_->has_to_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);
+ 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);
});
}
-void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
+void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun) const
{
- simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
+ kernel::actor::simcall([this, &fun] { pimpl_->on_exit->emplace_back(fun); });
}
-void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
+void Actor::set_host(Host* new_host)
{
- simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
-}
+ 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);
+ }
-void Actor::migrate(Host* new_host)
-{
- s4u::Actor::on_migration_start(this);
+ const s4u::Host* previous_location = get_host();
- simgrid::simix::simcall([this, new_host]() {
- if (pimpl_->waiting_synchro != nullptr) {
+ 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.
- // FIXME: implement the migration of other kind of activities
- simgrid::kernel::activity::ExecImplPtr exec =
- boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
+ // 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);
}
- SIMIX_process_change_host(this->pimpl_, new_host);
+ this->pimpl_->set_host(new_host);
});
- s4u::Actor::on_migration_end(this);
+ 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);
}
-s4u::Host* Actor::get_host()
+s4u::Host* Actor::get_host() const
{
- return this->pimpl_->host_;
+ return this->pimpl_->get_host();
}
void Actor::daemonize()
{
- simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
+ kernel::actor::simcall([this]() { pimpl_->daemonize(); });
}
bool Actor::is_daemon() const
aid_t Actor::get_pid() const
{
- return this->pimpl_->pid_;
+ return this->pimpl_->get_pid();
}
aid_t Actor::get_ppid() const
{
- return this->pimpl_->ppid_;
+ return this->pimpl_->get_ppid();
}
void Actor::suspend()
{
- s4u::Actor::on_suspend(this);
- simcall_process_suspend(pimpl_);
+ kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
+ kernel::actor::ActorImpl* target = pimpl_;
+ s4u::Actor::on_suspend(*this);
+ kernel::actor::simcall_blocking([issuer, target]() {
+ target->suspend();
+ if (target != issuer) {
+ /* If we are suspending ourselves, then just do not finish the simcall now */
+ issuer->simcall_answer();
+ }
+ });
}
void Actor::resume()
{
- simgrid::simix::simcall([this] { pimpl_->resume(); });
- s4u::Actor::on_resume(this);
+ kernel::actor::simcall([this] { pimpl_->resume(); });
+ s4u::Actor::on_resume(*this);
}
-bool Actor::is_suspended()
+bool Actor::is_suspended() const
{
- return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
+ return pimpl_->is_suspended();
}
-void Actor::set_kill_time(double time)
+void Actor::set_kill_time(double kill_time)
{
- simcall_process_set_kill_time(pimpl_, time);
+ kernel::actor::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
}
/** @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) // deprecated
+double Actor::get_kill_time() const
{
- smx_actor_t killer = SIMIX_process_self();
- smx_actor_t process = SIMIX_process_from_PID(pid);
- if (process != nullptr) {
- simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
- } else {
- std::ostringstream oss;
- oss << "kill: (" << pid << ") - No such actor" << std::endl;
- throw std::runtime_error(oss.str());
- }
+ return pimpl_->get_kill_time();
}
void Actor::kill()
{
- smx_actor_t process = SIMIX_process_self();
- simgrid::simix::simcall(
- [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
-}
-
-smx_actor_t Actor::get_impl()
-{
- return pimpl_;
+ const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+ kernel::actor::simcall([this, self] { self->kill(pimpl_); });
}
// ***** Static functions *****
ActorPtr Actor::by_pid(aid_t pid)
{
- smx_actor_t process = SIMIX_process_from_PID(pid);
- if (process != nullptr)
- return process->iface();
+ kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_pid(pid);
+ if (actor != nullptr)
+ return actor->get_iface();
else
return ActorPtr();
}
void Actor::kill_all()
{
- smx_actor_t self = SIMIX_process_self();
- simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
+ const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
+ kernel::actor::simcall([self] { self->kill_all(); });
}
-std::unordered_map<std::string, std::string>* Actor::get_properties()
+const std::unordered_map<std::string, std::string>* Actor::get_properties() const
{
- return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
+ return pimpl_->get_properties();
}
/** Retrieve the property value (or nullptr if not set) */
-const char* Actor::get_property(std::string key)
+const char* Actor::get_property(const std::string& key) const
{
- return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
+ return pimpl_->get_property(key);
}
-void Actor::set_property(std::string key, std::string value)
+void Actor::set_property(const std::string& key, const std::string& value)
{
- simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
+ kernel::actor::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
}
Actor* Actor::restart()
{
- return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
+ return kernel::actor::simcall([this]() { return pimpl_->restart(); });
}
// ***** this_actor *****
*/
bool is_maestro()
{
- smx_actor_t process = SIMIX_process_self();
- return process == nullptr || process == simix_global->maestro_process;
+ return SIMIX_is_maestro();
}
void sleep_for(double duration)
{
- if (duration > 0) {
- smx_actor_t actor = SIMIX_process_self();
- simgrid::s4u::Actor::on_sleep(actor->iface());
-
- simcall_process_sleep(duration);
+ xbt_assert(std::isfinite(duration), "duration is not finite!");
- simgrid::s4u::Actor::on_wake_up(actor->iface());
+ if (duration > 0) {
+ 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()
{
- simgrid::simix::simcall([] { /* do nothing*/ });
+ kernel::actor::simcall([] { /* do nothing*/ });
}
-XBT_PUBLIC void sleep_until(double timeout)
+XBT_PUBLIC void sleep_until(double wakeup_time)
{
double now = SIMIX_get_clock();
- if (timeout > now)
- sleep_for(timeout - now);
+ if (wakeup_time > now)
+ sleep_for(wakeup_time - now);
}
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(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
- std::vector<double> bytes_amounts)
+void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
+ const std::vector<double>& bytes_amounts)
{
- parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
+ exec_init(hosts, flops_amounts, bytes_amounts)->wait();
}
-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);
-}
-
-// deprecated
-void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
+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
{
- smx_activity_t s =
- 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;
+ exec_init(hosts, flops_amounts, bytes_amounts)->wait_for(timeout);
}
-// deprecated
-void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
+ExecPtr exec_init(double flops_amount)
{
- 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;
+ return Exec::init()->set_flops_amount(flops_amount)->set_host(get_host());
}
-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)
{
- return ExecPtr(new Exec(get_host(), flops_amount));
+ 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(), 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(),
+ [is_a_vm](s4u::Host* elm) {
+ bool tmp_is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(elm));
+ return is_a_vm == tmp_is_a_vm;
+ }),
+ "parallel_execute: mixing VMs and PMs is not supported (yet).");
+ /* checking for infinite values */
+ xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
+ "flops_amounts comprises infinite values!");
+ xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
+ "flops_amounts comprises infinite values!");
+
+ 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;
}
aid_t get_pid()
{
- return SIMIX_process_self()->pid_;
+ return simgrid::kernel::actor::ActorImpl::self()->get_pid();
}
aid_t get_ppid()
{
- return SIMIX_process_self()->ppid_;
+ return simgrid::kernel::actor::ActorImpl::self()->get_ppid();
}
std::string get_name()
{
- return SIMIX_process_self()->get_name();
+ return simgrid::kernel::actor::ActorImpl::self()->get_name();
}
const char* get_cname()
{
- return SIMIX_process_self()->get_cname();
+ return simgrid::kernel::actor::ActorImpl::self()->get_cname();
}
Host* get_host()
{
- return SIMIX_process_self()->host_;
+ return simgrid::kernel::actor::ActorImpl::self()->get_host();
}
void suspend()
{
- smx_actor_t actor = SIMIX_process_self();
- simgrid::s4u::Actor::on_suspend(actor->iface());
-
- simcall_process_suspend(actor);
-}
-
-void resume()
-{
- smx_actor_t process = SIMIX_process_self();
- simgrid::simix::simcall([process] { process->resume(); });
- simgrid::s4u::Actor::on_resume(process->iface());
+ kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
+ s4u::Actor::on_suspend(*self->get_ciface());
+ kernel::actor::simcall_blocking([self] { self->suspend(); });
}
void exit()
{
- smx_actor_t process = SIMIX_process_self();
- simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
+ kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
+ simgrid::kernel::actor::simcall([self] { self->exit(); });
}
-void on_exit(std::function<void(int, void*)> fun, void* data)
+void on_exit(const std::function<void(bool)>& fun)
{
- SIMIX_process_self()->iface()->on_exit(fun, data);
+ simgrid::kernel::actor::ActorImpl::self()->get_iface()->on_exit(fun);
}
/** @brief Moves the current actor to another host
*
* @see simgrid::s4u::Actor::migrate() for more information
*/
-void migrate(Host* new_host)
-{
- SIMIX_process_self()->iface()->migrate(new_host);
-}
-
-std::string getName() /* deprecated */
+void set_host(Host* new_host)
{
- return get_name();
+ simgrid::kernel::actor::ActorImpl::self()->get_iface()->set_host(new_host);
}
-const char* getCname() /* deprecated */
+void migrate(Host* new_host) // XBT_ATTRIB_DEPRECATED_v329
{
- return get_cname();
+ set_host(new_host);
}
-bool isMaestro() /* deprecated */
+
+} // namespace this_actor
+} // namespace s4u
+} // namespace simgrid
+
+/* **************************** Public C interface *************************** */
+size_t sg_actor_count()
{
- return is_maestro();
+ return simgrid::s4u::Engine::get_instance()->get_actor_count();
}
-aid_t getPid() /* deprecated */
+
+sg_actor_t* sg_actor_list()
{
- return get_pid();
+ 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;
}
-aid_t getPpid() /* deprecated */
+
+sg_actor_t sg_actor_init(const char* name, sg_host_t host)
{
- return get_ppid();
+ return simgrid::s4u::Actor::init(name, host).get();
}
-Host* getHost() /* deprecated */
+
+void sg_actor_start_(sg_actor_t actor, xbt_main_func_t code, int argc, const char* const* argv)
{
- return get_host();
+ simgrid::kernel::actor::ActorCode function;
+ if (code)
+ function = simgrid::xbt::wrap_main(code, argc, argv);
+ actor->start(function);
}
-void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
+
+sg_actor_t sg_actor_create_(const char* name, sg_host_t host, xbt_main_func_t code, int argc, const char* const* argv)
{
- SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+ simgrid::kernel::actor::ActorCode function = simgrid::xbt::wrap_main(code, argc, argv);
+ return simgrid::s4u::Actor::init(name, host)->start(function).get();
}
-void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
+
+void sg_actor_set_stacksize(sg_actor_t actor, unsigned size)
{
- on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
+ actor->set_stacksize(size);
}
-void kill() /* deprecated */
+
+void sg_actor_exit()
{
- exit();
+ simgrid::s4u::this_actor::exit();
}
-} // namespace this_actor
-} // namespace s4u
-} // namespace simgrid
-
-/* **************************** Public C interface *************************** */
-
-/** @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).
*/
-aid_t sg_actor_get_PID(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 */
return actor->get_pid();
}
-/** @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.
* Returns -1 if the actor has not been created by any other actor.
*/
-aid_t sg_actor_get_PPID(sg_actor_t actor)
+aid_t sg_actor_get_ppid(const_sg_actor_t actor)
{
return actor->get_ppid();
}
-/** @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)
+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)
+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)
{
return actor->get_cname();
}
-sg_host_t sg_actor_get_host(sg_actor_t actor)
+sg_host_t sg_actor_get_host(const_sg_actor_t actor)
{
return actor->get_host();
}
-/** @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)
*/
-const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
+const char* sg_actor_get_property_value(const_sg_actor_t actor, const char* name)
{
return actor->get_property(name);
}
-/** @ingroup m_actor_management
+/**
* @brief Return the list of properties
*
* This function returns all the parameters associated with an actor
*/
-xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
+xbt_dict_t sg_actor_get_properties(const_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::unordered_map<std::string, std::string>* props = actor->get_properties();
+ const std::unordered_map<std::string, std::string>* props = actor->get_properties();
if (props == nullptr)
return nullptr;
for (auto const& kv : *props) {
- xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
+ xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()));
}
return as_dict;
}
-/** @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.
*
* 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 .
*
* 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();
}
-/**
- * @ingroup m_actor_management
- * @brief Restarts an actor from the beginning.
- */
+/** @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.
*/
actor->set_auto_restart(auto_restart);
}
-/** @ingroup m_actor_management
- * @brief This actor will be terminated automatically when the last non-daemon actor finishes
- */
+/** @brief This actor will be terminated automatically when the last non-daemon actor finishes */
void sg_actor_daemonize(sg_actor_t actor)
{
actor->daemonize();
}
-/** @ingroup m_actor_management
+/** Returns whether or not this actor has been daemonized or not */
+int sg_actor_is_daemon(const_sg_actor_t actor)
+{
+ return actor->is_daemon();
+}
+
+/**
* @brief Migrates an actor to another location.
*
* 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)
+void sg_actor_set_host(sg_actor_t actor, sg_host_t host)
{
- process->migrate(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);
}
-/** @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)
+void sg_actor_join(const_sg_actor_t actor, double timeout)
{
actor->join(timeout);
}
simgrid::s4u::Actor::kill_all();
}
-/** @ingroup m_actor_management
+/**
* @brief Set the kill time of an actor.
*
* @param actor an actor
{
simgrid::s4u::this_actor::yield();
}
+
+void sg_actor_sleep_for(double duration)
+{
+ simgrid::s4u::this_actor::sleep_for(duration);
+}
+
+void sg_actor_sleep_until(double wakeup_time)
+{
+ simgrid::s4u::this_actor::sleep_until(wakeup_time);
+}
+
+sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
+{
+ xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
+ std::unordered_map<std::string, std::string> props;
+ xbt_dict_cursor_t cursor = nullptr;
+ char* key;
+ char* value;
+ xbt_dict_foreach (properties, cursor, key, value)
+ 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 */
+ smx_actor_t actor = nullptr;
+ try {
+ 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->get_ciface();
+}
+
+void sg_actor_detach()
+{
+ simgrid::kernel::actor::ActorImpl::detach();
+}
+
+aid_t sg_actor_self_get_pid()
+{
+ return simgrid::s4u::this_actor::get_pid();
+}
+
+aid_t sg_actor_self_get_ppid()
+{
+ return simgrid::s4u::this_actor::get_ppid();
+}
+
+const char* sg_actor_self_get_name()
+{
+ return simgrid::s4u::this_actor::get_cname();
+}
+
+void* sg_actor_self_get_data()
+{
+ return simgrid::s4u::Actor::self()->get_data();
+}
+
+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);
+}
+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)
+{
+ intrusive_ptr_add_ref(actor);
+}
+/** @brief Release a reference on that actor so that it can get be garbage-collected */
+void sg_actor_unref(const_sg_actor_t actor)
+{
+ intrusive_ptr_release(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();
+}
+
+/** @brief Set the user data of a #sg_actor_t */
+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(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();
+}