Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
2d162da29b4bb3a2c6369886a99e33558c29a5c6
[simgrid.git] / src / s4u / s4u_Actor.cpp
1 /* Copyright (c) 2006-2018. 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 "simgrid/actor.h"
7 #include "simgrid/s4u/Actor.hpp"
8 #include "simgrid/s4u/Exec.hpp"
9 #include "simgrid/s4u/Host.hpp"
10 #include "src/kernel/activity/ExecImpl.hpp"
11 #include "src/simix/smx_host_private.hpp"
12 #include "src/simix/smx_private.hpp"
13 #include "src/surf/HostImpl.hpp"
14
15 #include <sstream>
16
17 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
18
19 namespace simgrid {
20 namespace s4u {
21
22 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_creation;
23 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_suspend;
24 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_resume;
25 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_sleep;
26 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_wake_up;
27 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_start;
28 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_migration_end;
29 simgrid::xbt::signal<void(simgrid::s4u::ActorPtr)> s4u::Actor::on_destruction;
30
31 // ***** Actor creation *****
32 ActorPtr Actor::self()
33 {
34   smx_context_t self_context = SIMIX_context_self();
35   if (self_context == nullptr)
36     return simgrid::s4u::ActorPtr();
37
38   return self_context->process()->iface();
39 }
40
41 ActorPtr Actor::create(std::string name, s4u::Host* host, std::function<void()> code)
42 {
43   simgrid::kernel::actor::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
44   return actor->iface();
45 }
46
47 ActorPtr Actor::create(std::string name, s4u::Host* host, std::string function, std::vector<std::string> args)
48 {
49   simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
50   simgrid::simix::ActorCode code            = factory(std::move(args));
51   simgrid::kernel::actor::ActorImpl* actor  = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
52   return actor->iface();
53 }
54
55 void intrusive_ptr_add_ref(Actor* actor)
56 {
57   intrusive_ptr_add_ref(actor->pimpl_);
58 }
59 void intrusive_ptr_release(Actor* actor)
60 {
61   intrusive_ptr_release(actor->pimpl_);
62 }
63
64 // ***** Actor methods *****
65
66 void Actor::join()
67 {
68   simcall_process_join(this->pimpl_, -1);
69 }
70
71 void Actor::join(double timeout)
72 {
73   simcall_process_join(this->pimpl_, timeout);
74 }
75
76 void Actor::set_auto_restart(bool autorestart)
77 {
78   simgrid::simix::simcall([this, autorestart]() {
79     pimpl_->set_auto_restart(autorestart);
80
81     simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->host_, pimpl_);
82     XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
83     pimpl_->host_->pimpl_->actors_at_boot_.emplace_back(arg);
84   });
85 }
86
87 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
88 {
89   simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
90 }
91
92 void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
93 {
94   simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
95 }
96
97 void Actor::migrate(Host* new_host)
98 {
99   s4u::Actor::on_migration_start(this);
100
101   simgrid::simix::simcall([this, new_host]() {
102     if (pimpl_->waiting_synchro != nullptr) {
103       // The actor is blocked on an activity. If it's an exec, migrate it too.
104       // FIXME: implement the migration of other kind of activities
105       simgrid::kernel::activity::ExecImplPtr exec =
106           boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
107       xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
108       exec->migrate(new_host);
109     }
110     SIMIX_process_change_host(this->pimpl_, new_host);
111   });
112
113   s4u::Actor::on_migration_end(this);
114 }
115
116 s4u::Host* Actor::get_host()
117 {
118   return this->pimpl_->host_;
119 }
120
121 void Actor::daemonize()
122 {
123   simgrid::simix::simcall([this]() { pimpl_->daemonize(); });
124 }
125
126 bool Actor::is_daemon() const
127 {
128   return this->pimpl_->is_daemon();
129 }
130
131 const simgrid::xbt::string& Actor::get_name() const
132 {
133   return this->pimpl_->get_name();
134 }
135
136 const char* Actor::get_cname() const
137 {
138   return this->pimpl_->get_cname();
139 }
140
141 aid_t Actor::get_pid() const
142 {
143   return this->pimpl_->pid_;
144 }
145
146 aid_t Actor::get_ppid() const
147 {
148   return this->pimpl_->ppid_;
149 }
150
151 void Actor::suspend()
152 {
153   s4u::Actor::on_suspend(this);
154   simcall_process_suspend(pimpl_);
155 }
156
157 void Actor::resume()
158 {
159   simgrid::simix::simcall([this] { pimpl_->resume(); });
160   s4u::Actor::on_resume(this);
161 }
162
163 bool Actor::is_suspended()
164 {
165   return simgrid::simix::simcall([this] { return pimpl_->suspended_; });
166 }
167
168 void Actor::set_kill_time(double time)
169 {
170   simcall_process_set_kill_time(pimpl_, time);
171 }
172
173 /** @brief Get the kill time of an actor(or 0 if unset). */
174 double Actor::get_kill_time()
175 {
176   return SIMIX_timer_get_date(pimpl_->kill_timer);
177 }
178
179 void Actor::kill(aid_t pid)
180 {
181   smx_actor_t killer  = SIMIX_process_self();
182   smx_actor_t process = SIMIX_process_from_PID(pid);
183   if (process != nullptr) {
184     simgrid::simix::simcall([killer, process] { SIMIX_process_kill(process, killer); });
185   } else {
186     std::ostringstream oss;
187     oss << "kill: (" << pid << ") - No such actor" << std::endl;
188     throw std::runtime_error(oss.str());
189   }
190 }
191
192 void Actor::kill()
193 {
194   smx_actor_t process = SIMIX_process_self();
195   simgrid::simix::simcall(
196       [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
197 }
198
199 smx_actor_t Actor::get_impl()
200 {
201   return pimpl_;
202 }
203
204 // ***** Static functions *****
205
206 ActorPtr Actor::by_pid(aid_t pid)
207 {
208   smx_actor_t process = SIMIX_process_from_PID(pid);
209   if (process != nullptr)
210     return process->iface();
211   else
212     return ActorPtr();
213 }
214
215 void Actor::kill_all()
216 {
217   smx_actor_t self = SIMIX_process_self();
218   simgrid::simix::simcall([&self] { SIMIX_process_killall(self); });
219 }
220
221 std::unordered_map<std::string, std::string>* Actor::get_properties()
222 {
223   return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
224 }
225
226 /** Retrieve the property value (or nullptr if not set) */
227 const char* Actor::get_property(std::string key)
228 {
229   return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
230 }
231
232 void Actor::set_property(std::string key, std::string value)
233 {
234   simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
235 }
236
237 Actor* Actor::restart()
238 {
239   return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
240 }
241
242 // ***** this_actor *****
243
244 namespace this_actor {
245
246 /** Returns true if run from the kernel mode, and false if run from a real actor
247  *
248  * Everything that is run out of any actor (simulation setup before the engine is run,
249  * computing the model evolutions as a result to the actors' action, etc) is run in
250  * kernel mode, just as in any operating systems.
251  *
252  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
253  * because it is the one scheduling when the others should move or wait.
254  */
255 bool is_maestro()
256 {
257   smx_actor_t process = SIMIX_process_self();
258   return process == nullptr || process == simix_global->maestro_process;
259 }
260
261 void sleep_for(double duration)
262 {
263   if (duration > 0) {
264     smx_actor_t actor = SIMIX_process_self();
265     simgrid::s4u::Actor::on_sleep(actor->iface());
266
267     simcall_process_sleep(duration);
268
269     simgrid::s4u::Actor::on_wake_up(actor->iface());
270   }
271 }
272
273 void yield()
274 {
275   simgrid::simix::simcall([] { /* do nothing*/ });
276 }
277
278 XBT_PUBLIC void sleep_until(double timeout)
279 {
280   double now = SIMIX_get_clock();
281   if (timeout > now)
282     sleep_for(timeout - now);
283 }
284
285 void execute(double flops)
286 {
287   execute(flops, 1.0 /* priority */);
288 }
289
290 void execute(double flops, double priority)
291 {
292   exec_init(flops)->set_priority(priority)->start()->wait();
293 }
294
295 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
296 {
297   smx_activity_t s =
298       simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
299   simcall_execution_wait(s);
300 }
301
302 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
303 {
304   parallel_execute(host_nb, host_list, flops_amount, bytes_amount, /* timeout */ -1);
305 }
306
307 ExecPtr exec_init(double flops_amount)
308 {
309   ExecPtr res        = ExecPtr(new Exec());
310   res->host_         = get_host();
311   res->flops_amount_ = flops_amount;
312   res->set_remaining(flops_amount);
313   return res;
314 }
315
316 ExecPtr exec_async(double flops)
317 {
318   ExecPtr res = exec_init(flops);
319   res->start();
320   return res;
321 }
322
323 aid_t get_pid()
324 {
325   return SIMIX_process_self()->pid_;
326 }
327
328 aid_t get_ppid()
329 {
330   return SIMIX_process_self()->ppid_;
331 }
332
333 std::string get_name()
334 {
335   return SIMIX_process_self()->get_name();
336 }
337
338 const char* get_cname()
339 {
340   return SIMIX_process_self()->get_cname();
341 }
342
343 Host* get_host()
344 {
345   return SIMIX_process_self()->host_;
346 }
347
348 void suspend()
349 {
350   smx_actor_t actor = SIMIX_process_self();
351   simgrid::s4u::Actor::on_suspend(actor->iface());
352
353   simcall_process_suspend(actor);
354 }
355
356 void resume()
357 {
358   smx_actor_t process = SIMIX_process_self();
359   simgrid::simix::simcall([process] { process->resume(); });
360   simgrid::s4u::Actor::on_resume(process->iface());
361 }
362
363 bool is_suspended()
364 {
365   smx_actor_t process = SIMIX_process_self();
366   return simgrid::simix::simcall([process] { return process->suspended_; });
367 }
368
369 void exit()
370 {
371   smx_actor_t process = SIMIX_process_self();
372   simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
373 }
374
375 void on_exit(std::function<void(int, void*)> fun, void* data)
376 {
377   SIMIX_process_self()->iface()->on_exit(fun, data);
378 }
379
380 /** @brief Moves the current actor to another host
381  *
382  * @see simgrid::s4u::Actor::migrate() for more information
383  */
384 void migrate(Host* new_host)
385 {
386   SIMIX_process_self()->iface()->migrate(new_host);
387 }
388
389 std::string getName() /* deprecated */
390 {
391   return get_name();
392 }
393 const char* getCname() /* deprecated */
394 {
395   return get_cname();
396 }
397 bool isMaestro() /* deprecated */
398 {
399   return is_maestro();
400 }
401 aid_t getPid() /* deprecated */
402 {
403   return get_pid();
404 }
405 aid_t getPpid() /* deprecated */
406 {
407   return get_ppid();
408 }
409 Host* getHost() /* deprecated */
410 {
411   return get_host();
412 }
413 bool isSuspended() /* deprecated */
414 {
415   return is_suspended();
416 }
417 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
418 {
419   SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
420 }
421 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
422 {
423   on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
424 }
425 void kill() /* deprecated */
426 {
427   exit();
428 }
429
430 } // namespace this_actor
431 } // namespace s4u
432 } // namespace simgrid
433
434 /* **************************** Public C interface *************************** */
435
436 /** @ingroup m_actor_management
437  * @brief Returns the process ID of @a actor.
438  *
439  * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
440  */
441 int sg_actor_get_PID(sg_actor_t actor)
442 {
443   /* Do not raise an exception here: this function is called by the logs
444    * and the exceptions, so it would be called back again and again */
445   if (actor == nullptr || actor->get_impl() == nullptr)
446     return 0;
447   return actor->get_pid();
448 }
449
450 /** @ingroup m_actor_management
451  * @brief Returns the process ID of the parent of @a actor.
452  *
453  * This function checks whether @a actor is a valid pointer and return its parent's PID.
454  * Returns -1 if the actor has not been created by any other actor.
455  */
456 int sg_actor_get_PPID(sg_actor_t actor)
457 {
458   return actor->get_ppid();
459 }
460
461 /** @ingroup m_actor_management
462  *
463  * @brief Return a #sg_actor_t given its PID.
464  *
465  * 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.
466  * If none is found, @c nullptr is returned.
467    Note that the PID are unique in the whole simulation, not only on a given host.
468  */
469 sg_actor_t sg_actor_by_PID(aid_t pid)
470 {
471   return simgrid::s4u::Actor::by_pid(pid).get();
472 }
473
474 /** @ingroup m_actor_management
475  * @brief Return the name of an actor.
476  */
477 const char* sg_actor_get_name(sg_actor_t actor)
478 {
479   return actor->get_cname();
480 }
481
482 sg_host_t sg_actor_get_host(sg_actor_t actor)
483 {
484   return actor->get_host();
485 }
486
487 /** @ingroup m_actor_management
488  * @brief Returns the value of a given actor property
489  *
490  * @param actor an actor
491  * @param name a property name
492  * @return value of a property (or nullptr if the property is not set)
493  */
494 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
495 {
496   return actor->get_property(name);
497 }
498
499 /** @ingroup m_actor_management
500  * @brief Return the list of properties
501  *
502  * This function returns all the parameters associated with an actor
503  */
504 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
505 {
506   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
507   xbt_dict_t as_dict                        = xbt_dict_new_homogeneous(xbt_free_f);
508   std::unordered_map<std::string, std::string>* props = actor->get_properties();
509   if (props == nullptr)
510     return nullptr;
511   for (auto const& kv : *props) {
512     xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
513   }
514   return as_dict;
515 }
516
517 /** @ingroup m_actor_management
518  * @brief Suspend the actor.
519  *
520  * This function suspends the actor by suspending the task on which it was waiting for the completion.
521  */
522 void sg_actor_suspend(sg_actor_t actor)
523 {
524   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
525   actor->suspend();
526 }
527
528 /** @ingroup m_actor_management
529  * @brief Resume a suspended actor.
530  *
531  * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
532  */
533 void sg_actor_resume(sg_actor_t actor)
534 {
535   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
536   actor->resume();
537 }
538
539 /** @ingroup m_actor_management
540  * @brief Returns true if the actor is suspended .
541  *
542  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
543  */
544 int sg_actor_is_suspended(sg_actor_t actor)
545 {
546   return actor->is_suspended();
547 }
548
549 /**
550  * @ingroup m_actor_management
551  * @brief Restarts an actor from the beginning.
552  */
553 sg_actor_t sg_actor_restart(sg_actor_t actor)
554 {
555   return actor->restart();
556 }
557
558 /**
559  * @ingroup m_actor_management
560  * @brief Sets the "auto-restart" flag of the actor.
561  * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
562  */
563 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
564 {
565   actor->set_auto_restart(auto_restart);
566 }
567
568 /** @ingroup m_actor_management
569  * @brief This actor will be terminated automatically when the last non-daemon actor finishes
570  */
571 void sg_actor_daemonize(sg_actor_t actor)
572 {
573   actor->daemonize();
574 }
575
576 /** @ingroup m_actor_management
577  * @brief Migrates an actor to another location.
578  *
579  * This function changes the value of the #sg_host_t on  which @a actor is running.
580  */
581 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
582 {
583   process->migrate(host);
584 }
585
586 /** @ingroup m_actor_management
587  * @brief Wait for the completion of a #sg_actor_t.
588  *
589  * @param actor the actor to wait for
590  * @param timeout wait until the actor is over, or the timeout expires
591  */
592 void sg_actor_join(sg_actor_t actor, double timeout)
593 {
594   actor->join(timeout);
595 }
596
597 void sg_actor_kill(sg_actor_t actor)
598 {
599   actor->kill();
600 }
601
602 void sg_actor_kill_all()
603 {
604   simgrid::s4u::Actor::kill_all();
605 }
606
607 /** @ingroup m_actor_management
608  * @brief Set the kill time of an actor.
609  *
610  * @param actor an actor
611  * @param kill_time the time when the actor is killed.
612  */
613 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
614 {
615   actor->set_kill_time(kill_time);
616 }
617
618 /** Yield the current actor; let the other actors execute first */
619 void sg_actor_yield()
620 {
621   simgrid::s4u::this_actor::yield();
622 }