src/s4u/s4u_Actor.cpp

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