Logo AND Algorithmique Numérique Distribuée

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