Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Regenerate.
[simgrid.git] / src / s4u / s4u_Actor.cpp
1 /* Copyright (c) 2006-2021. 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/Exception.hpp"
7 #include "simgrid/actor.h"
8 #include "simgrid/modelchecker.h"
9 #include "simgrid/s4u/Actor.hpp"
10 #include "simgrid/s4u/Exec.hpp"
11 #include "simgrid/s4u/Host.hpp"
12 #include "simgrid/s4u/VirtualMachine.hpp"
13 #include "src/include/mc/mc.h"
14 #include "src/kernel/EngineImpl.hpp"
15 #include "src/kernel/activity/ExecImpl.hpp"
16 #include "src/mc/mc_replay.hpp"
17 #include "src/surf/HostImpl.hpp"
18
19 #include <algorithm>
20 #include <sstream>
21
22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(s4u_actor, s4u, "S4U actors");
23
24 namespace simgrid {
25
26 template class xbt::Extendable<s4u::Actor>;
27
28 namespace s4u {
29
30 xbt::signal<void(Actor&)> s4u::Actor::on_creation;
31 xbt::signal<void(Actor const&)> s4u::Actor::on_suspend;
32 xbt::signal<void(Actor const&)> s4u::Actor::on_resume;
33 xbt::signal<void(Actor const&)> s4u::Actor::on_sleep;
34 xbt::signal<void(Actor const&)> s4u::Actor::on_wake_up;
35 #ifndef DOXYGEN
36 xbt::signal<void(Actor const&)> s4u::Actor::on_migration_start; // XBT_ATTRIB_DEPRECATED_v329
37 xbt::signal<void(Actor const&)> s4u::Actor::on_migration_end;   // XBT_ATTRIB_DEPRECATED_v329
38 #endif
39 xbt::signal<void(Actor const&, Host const& previous_location)> s4u::Actor::on_host_change;
40 xbt::signal<void(Actor const&)> s4u::Actor::on_termination;
41 xbt::signal<void(Actor const&)> s4u::Actor::on_destruction;
42
43 // ***** Actor creation *****
44 Actor* Actor::self()
45 {
46   const kernel::context::Context* self_context = kernel::context::Context::self();
47   if (self_context == nullptr)
48     return nullptr;
49
50   return self_context->get_actor()->get_ciface();
51 }
52
53 ActorPtr Actor::init(const std::string& name, s4u::Host* host)
54 {
55   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
56   kernel::actor::ActorImpl* actor =
57       kernel::actor::simcall([self, &name, host] { return self->init(name, host).get(); });
58   return actor->get_iface();
59 }
60
61 /** Set a non-default stack size for this context (in Kb)
62  *
63  * This must be done before starting the actor, and it won't work with the thread factory. */
64 ActorPtr Actor::set_stacksize(unsigned stacksize)
65 {
66   pimpl_->set_stacksize(stacksize * 1024);
67   return this;
68 }
69
70 ActorPtr Actor::start(const std::function<void()>& code)
71 {
72   simgrid::kernel::actor::simcall([this, &code] { pimpl_->start(code); });
73   return this;
74 }
75
76 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::function<void()>& code)
77 {
78   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
79   kernel::actor::ActorImpl* actor =
80       kernel::actor::simcall([self, &name, host, &code] { return self->init(name, host)->start(code); });
81
82   return actor->get_iface();
83 }
84
85 ActorPtr Actor::create(const std::string& name, s4u::Host* host, const std::string& function,
86                        std::vector<std::string> args)
87 {
88   const simgrid::kernel::actor::ActorCodeFactory& factory =
89       simgrid::kernel::EngineImpl::get_instance()->get_function(function);
90   return create(name, host, factory(std::move(args)));
91 }
92
93 void intrusive_ptr_add_ref(const Actor* actor)
94 {
95   intrusive_ptr_add_ref(actor->pimpl_);
96 }
97 void intrusive_ptr_release(const Actor* actor)
98 {
99   intrusive_ptr_release(actor->pimpl_);
100 }
101 int Actor::get_refcount() const
102 {
103   return pimpl_->get_refcount();
104 }
105
106 // ***** Actor methods *****
107
108 void Actor::join() const
109 {
110   join(-1);
111 }
112
113 void Actor::join(double timeout) const
114 {
115   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
116   const kernel::actor::ActorImpl* target = pimpl_;
117   kernel::actor::simcall_blocking<void>([issuer, target, timeout] {
118     if (target->finished_) {
119       // The joined process is already finished, just wake up the issuer right away
120       issuer->simcall_answer();
121     } else {
122       kernel::activity::ActivityImplPtr sync = issuer->join(target, timeout);
123       sync->register_simcall(&issuer->simcall_);
124     }
125   });
126 }
127
128 void Actor::set_auto_restart(bool autorestart)
129 {
130   kernel::actor::simcall([this, autorestart]() {
131     xbt_assert(autorestart && not pimpl_->has_to_auto_restart()); // FIXME: handle all cases
132     pimpl_->set_auto_restart(autorestart);
133
134     auto* arg = new kernel::actor::ProcessArg(pimpl_->get_host(), pimpl_);
135     XBT_DEBUG("Adding %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
136     pimpl_->get_host()->pimpl_->add_actor_at_boot(arg);
137   });
138 }
139
140 void Actor::on_exit(const std::function<void(bool /*failed*/)>& fun) const
141 {
142   kernel::actor::simcall([this, &fun] { pimpl_->on_exit->emplace_back(fun); });
143 }
144
145 void Actor::set_host(Host* new_host)
146 {
147   if (s4u::Actor::on_migration_start.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329
148     static bool already_warned = false;
149     if (not already_warned) {
150       XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_start. This will be removed "
151                "in v3.29");
152       already_warned = true;
153     }
154     s4u::Actor::on_migration_start(*this);
155   }
156
157   const s4u::Host* previous_location = get_host();
158
159   kernel::actor::simcall([this, new_host]() {
160     if (pimpl_->waiting_synchro_ != nullptr) {
161       // The actor is blocked on an activity. If it's an exec, migrate it too.
162       // FIXME: implement the migration of other kinds of activities
163       kernel::activity::ExecImplPtr exec =
164           boost::dynamic_pointer_cast<kernel::activity::ExecImpl>(pimpl_->waiting_synchro_);
165       xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
166       exec->migrate(new_host);
167     }
168     this->pimpl_->set_host(new_host);
169   });
170
171   if (s4u::Actor::on_migration_end.get_slot_count() > 0) { // XBT_ATTRIB_DEPRECATED_v329
172     static bool already_warned = false;
173     if (not already_warned) {
174       XBT_INFO("Please use s4u::Actor::on_host_change instead of s4u::Actor::on_migration_end. This will be removed in "
175                "v3.29");
176       already_warned = true;
177     }
178     s4u::Actor::on_migration_end(*this);
179   }
180
181   s4u::Actor::on_host_change(*this, *previous_location);
182 }
183
184 s4u::Host* Actor::get_host() const
185 {
186   return this->pimpl_->get_host();
187 }
188
189 void Actor::daemonize()
190 {
191   kernel::actor::simcall([this]() { pimpl_->daemonize(); });
192 }
193
194 bool Actor::is_daemon() const
195 {
196   return this->pimpl_->is_daemon();
197 }
198
199 const simgrid::xbt::string& Actor::get_name() const
200 {
201   return this->pimpl_->get_name();
202 }
203
204 const char* Actor::get_cname() const
205 {
206   return this->pimpl_->get_cname();
207 }
208
209 aid_t Actor::get_pid() const
210 {
211   return this->pimpl_->get_pid();
212 }
213
214 aid_t Actor::get_ppid() const
215 {
216   return this->pimpl_->get_ppid();
217 }
218
219 void Actor::suspend()
220 {
221   kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
222   kernel::actor::ActorImpl* target = pimpl_;
223   s4u::Actor::on_suspend(*this);
224   kernel::actor::simcall_blocking<void>([issuer, target]() {
225     target->suspend();
226     if (target != issuer) {
227       /* If we are suspending ourselves, then just do not finish the simcall now */
228       issuer->simcall_answer();
229     }
230   });
231 }
232
233 void Actor::resume()
234 {
235   kernel::actor::simcall([this] { pimpl_->resume(); });
236   s4u::Actor::on_resume(*this);
237 }
238
239 bool Actor::is_suspended() const
240 {
241   return pimpl_->is_suspended();
242 }
243
244 void Actor::set_kill_time(double kill_time)
245 {
246   kernel::actor::simcall([this, kill_time] { pimpl_->set_kill_time(kill_time); });
247 }
248
249 /** @brief Get the kill time of an actor(or 0 if unset). */
250 double Actor::get_kill_time() const
251 {
252   return pimpl_->get_kill_time();
253 }
254
255 void Actor::kill()
256 {
257   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
258   kernel::actor::simcall([this, self] { self->kill(pimpl_); });
259 }
260
261 // ***** Static functions *****
262
263 ActorPtr Actor::by_pid(aid_t pid)
264 {
265   kernel::actor::ActorImpl* actor = kernel::actor::ActorImpl::by_PID(pid);
266   if (actor != nullptr)
267     return actor->get_iface();
268   else
269     return ActorPtr();
270 }
271
272 void Actor::kill_all()
273 {
274   const kernel::actor::ActorImpl* self = kernel::actor::ActorImpl::self();
275   kernel::actor::simcall([self] { self->kill_all(); });
276 }
277
278 const std::unordered_map<std::string, std::string>* Actor::get_properties() const
279 {
280   return pimpl_->get_properties();
281 }
282
283 /** Retrieve the property value (or nullptr if not set) */
284 const char* Actor::get_property(const std::string& key) const
285 {
286   return pimpl_->get_property(key);
287 }
288
289 void Actor::set_property(const std::string& key, const std::string& value)
290 {
291   kernel::actor::simcall([this, &key, &value] { pimpl_->set_property(key, value); });
292 }
293
294 Actor* Actor::restart()
295 {
296   return kernel::actor::simcall([this]() { return pimpl_->restart(); });
297 }
298
299 // ***** this_actor *****
300
301 namespace this_actor {
302
303 /** Returns true if run from the kernel mode, and false if run from a real actor
304  *
305  * Everything that is run out of any actor (simulation setup before the engine is run,
306  * computing the model evolutions as a result to the actors' action, etc) is run in
307  * kernel mode, just as in any operating systems.
308  *
309  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
310  * because it is the one scheduling when the others should move or wait.
311  */
312 bool is_maestro()
313 {
314   return SIMIX_is_maestro();
315 }
316
317 void sleep_for(double duration)
318 {
319   xbt_assert(std::isfinite(duration), "duration is not finite!");
320
321   if (duration > 0) {
322     kernel::actor::ActorImpl* issuer = kernel::actor::ActorImpl::self();
323     Actor::on_sleep(*issuer->get_ciface());
324
325     kernel::actor::simcall_blocking<void>([issuer, duration]() {
326       if (MC_is_active() || MC_record_replay_is_active()) {
327         MC_process_clock_add(issuer, duration);
328         issuer->simcall_answer();
329         return;
330       }
331       kernel::activity::ActivityImplPtr sync = issuer->sleep(duration);
332       sync->register_simcall(&issuer->simcall_);
333     });
334
335     Actor::on_wake_up(*issuer->get_ciface());
336   }
337 }
338
339 void yield()
340 {
341   kernel::actor::simcall([] { /* do nothing*/ });
342 }
343
344 XBT_PUBLIC void sleep_until(double wakeup_time)
345 {
346   double now = SIMIX_get_clock();
347   if (wakeup_time > now)
348     sleep_for(wakeup_time - now);
349 }
350
351 void execute(double flops)
352 {
353   execute(flops, 1.0 /* priority */);
354 }
355
356 void execute(double flops, double priority)
357 {
358   exec_init(flops)->set_priority(priority)->vetoable_start()->wait();
359 }
360
361 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
362                       const std::vector<double>& bytes_amounts)
363 {
364   exec_init(hosts, flops_amounts, bytes_amounts)->wait();
365 }
366
367 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
368                       const std::vector<double>& bytes_amounts, double timeout) // XBT_ATTRIB_DEPRECATED_v329
369 {
370   exec_init(hosts, flops_amounts, bytes_amounts)->wait_for(timeout);
371 }
372
373 ExecPtr exec_init(double flops_amount)
374 {
375   return Exec::init()->set_flops_amount(flops_amount)->set_host(get_host());
376 }
377
378 ExecPtr exec_init(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
379                   const std::vector<double>& bytes_amounts)
380 {
381   xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
382   xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
383              "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
384   xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
385              "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
386              hosts.size(), hosts.size(), bytes_amounts.size());
387   /* Check that we are not mixing VMs and PMs in the parallel task */
388   bool is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(hosts.front()));
389   xbt_assert(std::all_of(hosts.begin(), hosts.end(),
390                          [is_a_vm](s4u::Host* elm) {
391                            bool tmp_is_a_vm = (nullptr != dynamic_cast<VirtualMachine*>(elm));
392                            return is_a_vm == tmp_is_a_vm;
393                          }),
394              "parallel_execute: mixing VMs and PMs is not supported (yet).");
395   /* checking for infinite values */
396   xbt_assert(std::all_of(flops_amounts.begin(), flops_amounts.end(), [](double elm) { return std::isfinite(elm); }),
397              "flops_amounts comprises infinite values!");
398   xbt_assert(std::all_of(bytes_amounts.begin(), bytes_amounts.end(), [](double elm) { return std::isfinite(elm); }),
399              "flops_amounts comprises infinite values!");
400
401   return Exec::init()->set_flops_amounts(flops_amounts)->set_bytes_amounts(bytes_amounts)->set_hosts(hosts);
402 }
403
404 ExecPtr exec_async(double flops)
405 {
406   ExecPtr res = exec_init(flops);
407   res->vetoable_start();
408   return res;
409 }
410
411 aid_t get_pid()
412 {
413   return simgrid::kernel::actor::ActorImpl::self()->get_pid();
414 }
415
416 aid_t get_ppid()
417 {
418   return simgrid::kernel::actor::ActorImpl::self()->get_ppid();
419 }
420
421 std::string get_name()
422 {
423   return simgrid::kernel::actor::ActorImpl::self()->get_name();
424 }
425
426 const char* get_cname()
427 {
428   return simgrid::kernel::actor::ActorImpl::self()->get_cname();
429 }
430
431 Host* get_host()
432 {
433   return simgrid::kernel::actor::ActorImpl::self()->get_host();
434 }
435
436 void suspend()
437 {
438   kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
439   s4u::Actor::on_suspend(*self->get_ciface());
440   kernel::actor::simcall_blocking<void>([self] { self->suspend(); });
441 }
442
443 void exit()
444 {
445   kernel::actor::ActorImpl* self = simgrid::kernel::actor::ActorImpl::self();
446   simgrid::kernel::actor::simcall([self] { self->exit(); });
447 }
448
449 void on_exit(const std::function<void(bool)>& fun)
450 {
451   simgrid::kernel::actor::ActorImpl::self()->get_iface()->on_exit(fun);
452 }
453
454 /** @brief Moves the current actor to another host
455  *
456  * @see simgrid::s4u::Actor::migrate() for more information
457  */
458 void set_host(Host* new_host)
459 {
460   simgrid::kernel::actor::ActorImpl::self()->get_iface()->set_host(new_host);
461 }
462 void migrate(Host* new_host) // XBT_ATTRIB_DEPRECATED_v329
463 {
464   set_host(new_host);
465 }
466
467 } // namespace this_actor
468 } // namespace s4u
469 } // namespace simgrid
470
471 /* **************************** Public C interface *************************** */
472 size_t sg_actor_count()
473 {
474   return simgrid::s4u::Engine::get_instance()->get_actor_count();
475 }
476
477 sg_actor_t* sg_actor_list()
478 {
479   const simgrid::s4u::Engine* e = simgrid::s4u::Engine::get_instance();
480   size_t actor_count      = e->get_actor_count();
481   xbt_assert(actor_count > 0, "There is no actor!");
482   std::vector<simgrid::s4u::ActorPtr> actors = e->get_all_actors();
483
484   sg_actor_t* res = xbt_new(sg_actor_t, actors.size());
485   for (size_t i = 0; i < actor_count; i++)
486     res[i] = actors[i].get();
487   return res;
488 }
489
490 sg_actor_t sg_actor_init(const char* name, sg_host_t host)
491 {
492   return simgrid::s4u::Actor::init(name, host).get();
493 }
494
495 void sg_actor_start(sg_actor_t actor, xbt_main_func_t code, int argc, const char* const* argv)
496 {
497   simgrid::kernel::actor::ActorCode function;
498   if (code)
499     function = simgrid::xbt::wrap_main(code, argc, argv);
500   actor->start(function);
501 }
502
503 sg_actor_t sg_actor_create(const char* name, sg_host_t host, xbt_main_func_t code, int argc, const char* const* argv)
504 {
505   simgrid::kernel::actor::ActorCode function = simgrid::xbt::wrap_main(code, argc, argv);
506   return simgrid::s4u::Actor::init(name, host)->start(function).get();
507 }
508
509 void sg_actor_set_stacksize(sg_actor_t actor, unsigned size)
510 {
511   actor->set_stacksize(size);
512 }
513
514 void sg_actor_exit()
515 {
516   simgrid::s4u::this_actor::exit();
517 }
518
519 /**
520  * @brief Returns the process ID of @a actor.
521  *
522  * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
523  */
524
525 aid_t sg_actor_get_PID(const_sg_actor_t actor)
526 {
527   /* Do not raise an exception here: this function is called by the logs
528    * and the exceptions, so it would be called back again and again */
529   if (actor == nullptr || actor->get_impl() == nullptr)
530     return 0;
531   return actor->get_pid();
532 }
533
534 /**
535  * @brief Returns the process ID of the parent of @a actor.
536  *
537  * This function checks whether @a actor is a valid pointer and return its parent's PID.
538  * Returns -1 if the actor has not been created by any other actor.
539  */
540 aid_t sg_actor_get_PPID(const_sg_actor_t actor)
541 {
542   return actor->get_ppid();
543 }
544
545 /**
546  * @brief Return a #sg_actor_t given its PID.
547  *
548  * 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.
549  * If none is found, @c nullptr is returned.
550    Note that the PID are unique in the whole simulation, not only on a given host.
551  */
552 sg_actor_t sg_actor_by_PID(aid_t pid)
553 {
554   return simgrid::s4u::Actor::by_pid(pid).get();
555 }
556
557 /** @brief Return the name of an actor. */
558 const char* sg_actor_get_name(const_sg_actor_t actor)
559 {
560   return actor->get_cname();
561 }
562
563 sg_host_t sg_actor_get_host(const_sg_actor_t actor)
564 {
565   return actor->get_host();
566 }
567
568 /**
569  * @brief Returns the value of a given actor property
570  *
571  * @param actor an actor
572  * @param name a property name
573  * @return value of a property (or nullptr if the property is not set)
574  */
575 const char* sg_actor_get_property_value(const_sg_actor_t actor, const char* name)
576 {
577   return actor->get_property(name);
578 }
579
580 /**
581  * @brief Return the list of properties
582  *
583  * This function returns all the parameters associated with an actor
584  */
585 xbt_dict_t sg_actor_get_properties(const_sg_actor_t actor)
586 {
587   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
588   xbt_dict_t as_dict                        = xbt_dict_new_homogeneous(xbt_free_f);
589   const std::unordered_map<std::string, std::string>* props = actor->get_properties();
590   if (props == nullptr)
591     return nullptr;
592   for (auto const& kv : *props) {
593     xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()));
594   }
595   return as_dict;
596 }
597
598 /**
599  * @brief Suspend the actor.
600  *
601  * This function suspends the actor by suspending the task on which it was waiting for the completion.
602  */
603 void sg_actor_suspend(sg_actor_t actor)
604 {
605   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
606   actor->suspend();
607 }
608
609 /**
610  * @brief Resume a suspended actor.
611  *
612  * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
613  */
614 void sg_actor_resume(sg_actor_t actor)
615 {
616   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
617   actor->resume();
618 }
619
620 /**
621  * @brief Returns true if the actor is suspended .
622  *
623  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
624  */
625 int sg_actor_is_suspended(const_sg_actor_t actor)
626 {
627   return actor->is_suspended();
628 }
629
630 /** @brief Restarts an actor from the beginning. */
631 sg_actor_t sg_actor_restart(sg_actor_t actor)
632 {
633   return actor->restart();
634 }
635
636 /**
637  * @brief Sets the "auto-restart" flag of the actor.
638  * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
639  */
640 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
641 {
642   actor->set_auto_restart(auto_restart);
643 }
644
645 /** @brief This actor will be terminated automatically when the last non-daemon actor finishes */
646 void sg_actor_daemonize(sg_actor_t actor)
647 {
648   actor->daemonize();
649 }
650
651 /** Returns whether or not this actor has been daemonized or not */
652 int sg_actor_is_daemon(const_sg_actor_t actor)
653 {
654   return actor->is_daemon();
655 }
656
657 /**
658  * @brief Migrates an actor to another location.
659  *
660  * This function changes the value of the #sg_host_t on  which @a actor is running.
661  */
662 void sg_actor_set_host(sg_actor_t actor, sg_host_t host)
663 {
664   actor->set_host(host);
665 }
666 void sg_actor_migrate(sg_actor_t process, sg_host_t host) // XBT_ATTRIB_DEPRECATED_v329
667 {
668   process->set_host(host);
669 }
670
671 /**
672  * @brief Wait for the completion of a #sg_actor_t.
673  *
674  * @param actor the actor to wait for
675  * @param timeout wait until the actor is over, or the timeout expires
676  */
677 void sg_actor_join(const_sg_actor_t actor, double timeout)
678 {
679   actor->join(timeout);
680 }
681
682 void sg_actor_kill(sg_actor_t actor)
683 {
684   actor->kill();
685 }
686
687 void sg_actor_kill_all()
688 {
689   simgrid::s4u::Actor::kill_all();
690 }
691
692 /**
693  * @brief Set the kill time of an actor.
694  *
695  * @param actor an actor
696  * @param kill_time the time when the actor is killed.
697  */
698 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
699 {
700   actor->set_kill_time(kill_time);
701 }
702
703 /** Yield the current actor; let the other actors execute first */
704 void sg_actor_yield()
705 {
706   simgrid::s4u::this_actor::yield();
707 }
708
709 void sg_actor_sleep_for(double duration)
710 {
711   simgrid::s4u::this_actor::sleep_for(duration);
712 }
713
714 void sg_actor_sleep_until(double wakeup_time)
715 {
716   simgrid::s4u::this_actor::sleep_until(wakeup_time);
717 }
718
719 sg_actor_t sg_actor_attach(const char* name, void* data, sg_host_t host, xbt_dict_t properties)
720 {
721   xbt_assert(host != nullptr, "Invalid parameters: host and code params must not be nullptr");
722   std::unordered_map<std::string, std::string> props;
723   xbt_dict_cursor_t cursor = nullptr;
724   char* key;
725   char* value;
726   xbt_dict_foreach (properties, cursor, key, value)
727     props[key] = value;
728   xbt_dict_free(&properties);
729
730   /* Let's create the process: SIMIX may decide to start it right now, even before returning the flow control to us */
731   smx_actor_t actor = nullptr;
732   try {
733     actor = simgrid::kernel::actor::ActorImpl::attach(name, data, host, &props).get();
734   } catch (simgrid::HostFailureException const&) {
735     xbt_die("Could not attach");
736   }
737
738   simgrid::s4u::this_actor::yield();
739   return actor->get_ciface();
740 }
741
742 void sg_actor_detach()
743 {
744   simgrid::kernel::actor::ActorImpl::detach();
745 }
746
747 aid_t sg_actor_self_get_pid()
748 {
749   return simgrid::s4u::this_actor::get_pid();
750 }
751
752 aid_t sg_actor_self_get_ppid()
753 {
754   return simgrid::s4u::this_actor::get_ppid();
755 }
756
757 const char* sg_actor_self_get_name()
758 {
759   return simgrid::s4u::this_actor::get_cname();
760 }
761
762 void* sg_actor_self_get_data()
763 {
764   return simgrid::s4u::Actor::self()->get_data();
765 }
766
767 void sg_actor_self_set_data(void* userdata)
768 {
769   simgrid::s4u::Actor::self()->set_data(userdata);
770 }
771
772 void* sg_actor_self_data() // XBT_ATTRIB_DEPRECATED_v330
773 {
774   return sg_actor_self_get_data();
775 }
776
777 void sg_actor_self_data_set(void* userdata) // XBT_ATTRIB_DEPRECATED_v330
778 {
779   sg_actor_self_set_data(userdata);
780 }
781
782 sg_actor_t sg_actor_self()
783 {
784   return simgrid::s4u::Actor::self();
785 }
786
787 void sg_actor_self_execute(double flops) // XBT_ATTRIB_DEPRECATED_v330
788 {
789   simgrid::s4u::this_actor::execute(flops);
790 }
791
792 void sg_actor_execute(double flops)
793 {
794   simgrid::s4u::this_actor::execute(flops);
795 }
796 void sg_actor_execute_with_priority(double flops, double priority)
797 {
798   simgrid::s4u::this_actor::exec_init(flops)->set_priority(priority)->wait();
799 }
800
801 void sg_actor_parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
802 {
803   std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
804   std::vector<double> flops;
805   std::vector<double> bytes;
806   if (flops_amount != nullptr)
807     flops = std::vector<double>(flops_amount, flops_amount + host_nb);
808   if (bytes_amount != nullptr)
809     bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
810
811   simgrid::s4u::this_actor::parallel_execute(hosts, flops, bytes);
812 }
813
814 /** @brief Take an extra reference on that actor to prevent it to be garbage-collected */
815 void sg_actor_ref(const_sg_actor_t actor)
816 {
817   intrusive_ptr_add_ref(actor);
818 }
819 /** @brief Release a reference on that actor so that it can get be garbage-collected */
820 void sg_actor_unref(const_sg_actor_t actor)
821 {
822   intrusive_ptr_release(actor);
823 }
824
825 /** @brief Return the user data of a #sg_actor_t */
826 void* sg_actor_get_data(const_sg_actor_t actor)
827 {
828   return actor->get_data();
829 }
830
831 /** @brief Set the user data of a #sg_actor_t */
832 void sg_actor_set_data(sg_actor_t actor, void* userdata)
833 {
834   actor->set_data(userdata);
835 }
836
837 void* sg_actor_data(const_sg_actor_t actor) // XBT_ATTRIB_DEPRECATED_v330
838 {
839   return sg_actor_get_data(actor);
840 }
841
842 void sg_actor_data_set(sg_actor_t actor, void* userdata) // XBT_ATTRIB_DEPRECATED_v330
843 {
844   sg_actor_set_data(actor, userdata);
845 }
846
847 /** @brief Add a function to the list of "on_exit" functions for the current process.
848  *  The on_exit functions are the functions executed when your process is killed.
849  *  You should use them to free the data used by your process.
850  */
851 void sg_actor_on_exit(void_f_int_pvoid_t fun, void* data)
852 {
853   simgrid::s4u::this_actor::on_exit([fun, data](bool failed) { fun(failed ? 1 /*FAILURE*/ : 0 /*SUCCESS*/, data); });
854 }
855
856 sg_exec_t sg_actor_exec_init(double computation_amount)
857 {
858   simgrid::s4u::ExecPtr exec = simgrid::s4u::this_actor::exec_init(computation_amount);
859   exec->add_ref();
860   return exec.get();
861 }
862
863 sg_exec_t sg_actor_parallel_exec_init(int host_nb, const sg_host_t* host_list, double* flops_amount,
864                                       double* bytes_amount)
865 {
866   std::vector<simgrid::s4u::Host*> hosts(host_list, host_list + host_nb);
867   std::vector<double> flops;
868   std::vector<double> bytes;
869   if (flops_amount != nullptr)
870     flops = std::vector<double>(flops_amount, flops_amount + host_nb);
871   if (bytes_amount != nullptr)
872     bytes = std::vector<double>(bytes_amount, bytes_amount + host_nb * host_nb);
873
874   simgrid::s4u::ExecPtr exec = simgrid::s4u::this_actor::exec_init(hosts, flops, bytes);
875   exec->add_ref();
876   return exec.get();
877 }
878
879 sg_exec_t sg_actor_exec_async(double computation_amount)
880 {
881   simgrid::s4u::ExecPtr exec = simgrid::s4u::this_actor::exec_async(computation_amount);
882   exec->add_ref();
883   return exec.get();
884 }