Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
db27edc18ca4dd3befc9248d4c4bd2c3eaefe3fc
[simgrid.git] / src / s4u / s4u_actor.cpp
1 /* Copyright (c) 2006-2017. The SimGrid Team. All rights reserved.          */
2
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. */
5
6 #include "xbt/log.h"
7
8 #include "simgrid/s4u/Actor.hpp"
9 #include "simgrid/s4u/Comm.hpp"
10 #include "simgrid/s4u/Host.hpp"
11 #include "simgrid/s4u/Mailbox.hpp"
12
13 #include "src/kernel/context/Context.hpp"
14 #include "src/simix/smx_private.h"
15
16 #include <sstream>
17
18 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
19
20 namespace simgrid {
21 namespace s4u {
22
23 // ***** Actor creation *****
24 ActorPtr Actor::self()
25 {
26   smx_context_t self_context = SIMIX_context_self();
27   if (self_context == nullptr)
28     return simgrid::s4u::ActorPtr();
29
30   return self_context->process()->iface();
31 }
32
33 ActorPtr Actor::createActor(const char* name, s4u::Host* host, std::function<void()> code)
34 {
35   simgrid::simix::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
36   return actor->iface();
37 }
38
39 ActorPtr Actor::createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
40 {
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();
45 }
46
47 void intrusive_ptr_add_ref(Actor* actor)
48 {
49   xbt_assert(actor != nullptr);
50   intrusive_ptr_add_ref(actor->pimpl_);
51 }
52 void intrusive_ptr_release(Actor* actor)
53 {
54   xbt_assert(actor != nullptr);
55   intrusive_ptr_release(actor->pimpl_);
56 }
57
58 // ***** Actor methods *****
59
60 void Actor::join() {
61   simcall_process_join(this->pimpl_, -1);
62 }
63
64 void Actor::setAutoRestart(bool autorestart) {
65   simgrid::simix::kernelImmediate([this, autorestart]() { pimpl_->auto_restart = autorestart; });
66 }
67
68 void Actor::onExit(int_f_pvoid_pvoid_t fun, void* data)
69 {
70   simcall_process_on_exit(pimpl_, fun, data);
71 }
72
73 void Actor::migrate(Host* new_host)
74 {
75   simgrid::simix::kernelImmediate([this, new_host]() { pimpl_->new_host = new_host; });
76 }
77
78 s4u::Host* Actor::getHost()
79 {
80   return this->pimpl_->host;
81 }
82
83 void Actor::daemonize()
84 {
85   simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
86 }
87
88 const char* Actor::getCname()
89 {
90   return this->pimpl_->name.c_str();
91 }
92
93 simgrid::xbt::string Actor::getName()
94 {
95   return this->pimpl_->name;
96 }
97
98 aid_t Actor::getPid()
99 {
100   return this->pimpl_->pid;
101 }
102
103 aid_t Actor::getPpid()
104 {
105   return this->pimpl_->ppid;
106 }
107
108 void Actor::suspend()
109 {
110   simcall_process_suspend(pimpl_);
111 }
112
113 void Actor::resume()
114 {
115   simgrid::simix::kernelImmediate([this] { pimpl_->resume(); });
116 }
117
118 int Actor::isSuspended()
119 {
120   return simgrid::simix::kernelImmediate([this] { return pimpl_->suspended; });
121 }
122
123 void Actor::yield()
124 {
125   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
126 }
127
128 void Actor::setKillTime(double time) {
129   simcall_process_set_kill_time(pimpl_,time);
130 }
131
132 /** \brief Get the kill time of an actor(or 0 if unset). */
133 double Actor::getKillTime()
134 {
135   return SIMIX_timer_get_date(pimpl_->kill_timer);
136 }
137
138 void Actor::kill(aid_t pid)
139 {
140   smx_actor_t process = SIMIX_process_from_PID(pid);
141   if(process != nullptr) {
142     simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
143   } else {
144     std::ostringstream oss;
145     oss << "kill: ("<< pid <<") - No such process" << std::endl;
146     throw std::runtime_error(oss.str());
147   }
148 }
149
150 smx_actor_t Actor::getImpl() {
151   return pimpl_;
152 }
153
154 void Actor::kill() {
155   smx_actor_t process = SIMIX_process_self();
156   simgrid::simix::kernelImmediate(
157       [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
158 }
159
160 // ***** Static functions *****
161
162 ActorPtr Actor::byPid(aid_t pid)
163 {
164   smx_actor_t process = SIMIX_process_from_PID(pid);
165   if (process != nullptr)
166     return process->iface();
167   else
168     return ActorPtr();
169 }
170
171 void Actor::killAll()
172 {
173   simcall_process_killall(1);
174 }
175
176 void Actor::killAll(int resetPid)
177 {
178   simcall_process_killall(resetPid);
179 }
180
181 /** Retrieve the property value (or nullptr if not set) */
182 const char* Actor::getProperty(const char* key)
183 {
184   return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
185 }
186
187 void Actor::setProperty(const char* key, const char* value)
188 {
189   simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
190 }
191
192 Actor* Actor::restart()
193 {
194   return simgrid::simix::kernelImmediate([this]() { return pimpl_->restart(); });
195 }
196
197 // ***** this_actor *****
198
199 namespace this_actor {
200
201 /** Returns true if run from the kernel mode, and false if run from a real actor
202  *
203  * Everything that is run out of any actor (simulation setup before the engine is run,
204  * computing the model evolutions as a result to the actors' action, etc) is run in
205  * kernel mode, just as in any operating systems.
206  *
207  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
208  * because it is the one scheduling when the others should move or wait.
209  */
210 bool isMaestro()
211 {
212   smx_actor_t process = SIMIX_process_self();
213   return process == nullptr || process == simix_global->maestro_process;
214 }
215
216 void sleep_for(double duration)
217 {
218   if (duration > 0)
219     simcall_process_sleep(duration);
220 }
221
222 XBT_PUBLIC(void) sleep_until(double timeout)
223 {
224   double now = SIMIX_get_clock();
225   if (timeout > now)
226     simcall_process_sleep(timeout - now);
227 }
228
229 void execute(double flops)
230 {
231   smx_activity_t s = simcall_execution_start(nullptr,flops,1.0/*priority*/,0./*bound*/);
232   simcall_execution_wait(s);
233 }
234
235 void* recv(MailboxPtr chan) // deprecated
236 {
237   return chan->get();
238 }
239
240 void* recv(MailboxPtr chan, double timeout) // deprecated
241 {
242   return chan->get(timeout);
243 }
244
245 void send(MailboxPtr chan, void* payload, double simulatedSize) // deprecated
246 {
247   chan->put(payload, simulatedSize);
248 }
249
250 void send(MailboxPtr chan, void* payload, double simulatedSize, double timeout) // deprecated
251 {
252   chan->put(payload, simulatedSize, timeout);
253 }
254
255 CommPtr isend(MailboxPtr chan, void* payload, double simulatedSize) // deprecated
256 {
257   return chan->put_async(payload, simulatedSize);
258 }
259
260 CommPtr irecv(MailboxPtr chan, void** data) // deprecated
261 {
262   return chan->get_async(data);
263 }
264
265 aid_t getPid()
266 {
267   return SIMIX_process_self()->pid;
268 }
269
270 aid_t getPpid()
271 {
272   return SIMIX_process_self()->ppid;
273 }
274
275 std::string getName()
276 {
277   return SIMIX_process_self()->name;
278 }
279
280 Host* getHost()
281 {
282   return SIMIX_process_self()->host;
283 }
284
285 void suspend()
286 {
287   simcall_process_suspend(SIMIX_process_self());
288 }
289
290 void resume()
291 {
292   smx_actor_t process = SIMIX_process_self();
293   simgrid::simix::kernelImmediate([process] { process->resume(); });
294 }
295
296 bool isSuspended()
297 {
298   smx_actor_t process = SIMIX_process_self();
299   return simgrid::simix::kernelImmediate([process] { return process->suspended; });
300 }
301
302 void kill()
303 {
304   smx_actor_t process = SIMIX_process_self();
305   simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
306 }
307
308 void onExit(int_f_pvoid_pvoid_t fun, void* data)
309 {
310   simcall_process_on_exit(SIMIX_process_self(), fun, data);
311 }
312
313 void migrate(Host* new_host)
314 {
315   smx_actor_t process = SIMIX_process_self();
316   simgrid::simix::kernelImmediate([process, new_host] { process->new_host = new_host; });
317 }
318 }
319 }
320 }