1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
8 #include "simgrid/s4u/Actor.hpp"
9 #include "simgrid/s4u/Comm.hpp"
10 #include "simgrid/s4u/Host.hpp"
11 #include "simgrid/s4u/Mailbox.hpp"
13 #include "src/kernel/context/Context.hpp"
14 #include "src/simix/smx_private.h"
18 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
23 // ***** Actor creation *****
24 ActorPtr Actor::self()
26 smx_context_t self_context = SIMIX_context_self();
27 if (self_context == nullptr)
28 return simgrid::s4u::ActorPtr();
30 return self_context->process()->iface();
33 ActorPtr Actor::createActor(const char* name, s4u::Host* host, std::function<void()> code)
35 simgrid::simix::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
36 return actor->iface();
39 ActorPtr Actor::createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
41 simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
42 simgrid::simix::ActorCode code = factory(std::move(args));
43 simgrid::simix::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
44 return actor->iface();
47 void intrusive_ptr_add_ref(Actor* actor)
49 xbt_assert(actor != nullptr);
50 intrusive_ptr_add_ref(actor->pimpl_);
52 void intrusive_ptr_release(Actor* actor)
54 xbt_assert(actor != nullptr);
55 intrusive_ptr_release(actor->pimpl_);
58 // ***** Actor methods *****
61 simcall_process_join(this->pimpl_, -1);
64 void Actor::setAutoRestart(bool autorestart) {
65 simcall_process_auto_restart_set(pimpl_,autorestart);
68 void Actor::onExit(int_f_pvoid_pvoid_t fun, void* data)
70 simcall_process_on_exit(pimpl_, fun, data);
73 void Actor::migrate(Host* new_host)
75 simcall_process_set_host(pimpl_, new_host);
78 s4u::Host* Actor::host()
80 return this->pimpl_->host;
83 void Actor::daemonize()
85 simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
88 const char* Actor::cname()
90 return this->pimpl_->name.c_str();
93 simgrid::xbt::string Actor::name()
95 return this->pimpl_->name;
100 return this->pimpl_->pid;
105 return this->pimpl_->ppid;
108 void Actor::suspend()
110 simcall_process_suspend(pimpl_);
115 simcall_process_resume(pimpl_);
118 int Actor::isSuspended()
120 return simcall_process_is_suspended(pimpl_);
123 void Actor::setKillTime(double time) {
124 simcall_process_set_kill_time(pimpl_,time);
127 double Actor::killTime()
129 return simcall_process_get_kill_time(pimpl_);
132 void Actor::kill(aid_t pid)
134 smx_actor_t process = SIMIX_process_from_PID(pid);
135 if(process != nullptr) {
136 simcall_process_kill(process);
138 std::ostringstream oss;
139 oss << "kill: ("<< pid <<") - No such process" << std::endl;
140 throw std::runtime_error(oss.str());
144 smx_actor_t Actor::getImpl() {
149 simcall_process_kill(pimpl_);
152 // ***** Static functions *****
154 ActorPtr Actor::byPid(aid_t pid)
156 smx_actor_t process = SIMIX_process_from_PID(pid);
157 if (process != nullptr)
158 return process->iface();
163 void Actor::killAll()
165 simcall_process_killall(1);
168 void Actor::killAll(int resetPid)
170 simcall_process_killall(resetPid);
173 /** Retrieve the property value (or nullptr if not set) */
174 const char* Actor::property(const char* key)
176 return (char*)xbt_dict_get_or_null(simcall_process_get_properties(pimpl_), key);
178 void Actor::setProperty(const char* key, const char* value)
180 simgrid::simix::kernelImmediate([this, key, value] {
181 xbt_dict_set(simcall_process_get_properties(pimpl_), key, (char*)value, (void_f_pvoid_t) nullptr);
185 // ***** this_actor *****
187 namespace this_actor {
189 /** Returns true if run from the kernel mode, and false if run from a real actor
191 * Everything that is run out of any actor (simulation setup before the engine is run,
192 * computing the model evolutions as a result to the actors' action, etc) is run in
193 * kernel mode, just as in any operating systems.
195 * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
196 * because it is the one scheduling when the others should move or wait.
200 smx_actor_t process = SIMIX_process_self();
201 return process == nullptr || process == simix_global->maestro_process;
204 void sleep_for(double duration)
207 simcall_process_sleep(duration);
210 XBT_PUBLIC(void) sleep_until(double timeout)
212 double now = SIMIX_get_clock();
214 simcall_process_sleep(timeout - now);
217 e_smx_state_t execute(double flops) {
218 smx_activity_t s = simcall_execution_start(nullptr,flops,1.0/*priority*/,0./*bound*/);
219 return simcall_execution_wait(s);
222 void* recv(MailboxPtr chan) {
224 CommPtr c = Comm::recv_init(chan);
225 c->setDstData(&res, sizeof(res));
230 void* recv(MailboxPtr chan, double timeout)
233 CommPtr c = Comm::recv_init(chan);
234 c->setDstData(&res, sizeof(res));
239 void send(MailboxPtr chan, void* payload, double simulatedSize)
241 CommPtr c = Comm::send_init(chan);
242 c->setRemains(simulatedSize);
243 c->setSrcData(payload);
244 // c->start() is optional.
248 void send(MailboxPtr chan, void* payload, double simulatedSize, double timeout)
250 CommPtr c = Comm::send_init(chan);
251 c->setRemains(simulatedSize);
252 c->setSrcData(payload);
253 // c->start() is optional.
257 CommPtr isend(MailboxPtr chan, void* payload, double simulatedSize)
259 return Comm::send_async(chan, payload, simulatedSize);
262 void dsend(MailboxPtr chan, void* payload, double simulatedSize)
264 Comm::send_detached(chan, payload, simulatedSize);
267 CommPtr irecv(MailboxPtr chan, void** data)
269 return Comm::recv_async(chan, data);
274 return SIMIX_process_self()->pid;
279 return SIMIX_process_self()->ppid;
284 return SIMIX_process_self()->name;
289 return SIMIX_process_self()->host;
294 simcall_process_suspend(SIMIX_process_self());
299 simcall_process_resume(SIMIX_process_self());
304 return simcall_process_is_suspended(SIMIX_process_self());
309 simcall_process_kill(SIMIX_process_self());
312 void onExit(int_f_pvoid_pvoid_t fun, void* data)
314 simcall_process_on_exit(SIMIX_process_self(), fun, data);
317 void migrate(Host* new_host)
319 simcall_process_set_host(SIMIX_process_self(), new_host);