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