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->get_actor()->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     this->pimpl_->set_host(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 kill_time)
 168 {
 169   simgrid::simix::simcall([this, kill_time] { pimpl_->set_kill_time(kill_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 victim  = SIMIX_process_from_PID(pid);
 182   if (victim != nullptr) {
 183     simgrid::simix::simcall([killer, victim] { killer->kill(victim); });
 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([this, process] {
 195     if (pimpl_ == simix_global->maestro_process)
 196       pimpl_->exit();
 197     else
 198       process->kill(pimpl_);
 199   });
 200 }
 201
 202 smx_actor_t Actor::get_impl()
 203 {
 204   return pimpl_;
 205 }
 206
 207 // ***** Static functions *****
 208
 209 ActorPtr Actor::by_pid(aid_t pid)
 210 {
 211   smx_actor_t process = SIMIX_process_from_PID(pid);
 212   if (process != nullptr)
 213     return process->iface();
 214   else
 215     return ActorPtr();
 216 }
 217
 218 void Actor::kill_all()
 219 {
 220   smx_actor_t self = SIMIX_process_self();
 221   simgrid::simix::simcall([self] { self->kill_all(); });
 222 }
 223
 224 std::unordered_map<std::string, std::string>* Actor::get_properties()
 225 {
 226   return simgrid::simix::simcall([this] { return this->pimpl_->get_properties(); });
 227 }
 228
 229 /** Retrieve the property value (or nullptr if not set) */
 230 const char* Actor::get_property(std::string key)
 231 {
 232   return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
 233 }
 234
 235 void Actor::set_property(std::string key, std::string value)
 236 {
 237   simgrid::simix::simcall([this, key, value] { pimpl_->set_property(key, value); });
 238 }
 239
 240 Actor* Actor::restart()
 241 {
 242   return simgrid::simix::simcall([this]() { return pimpl_->restart(); });
 243 }
 244
 245 // ***** this_actor *****
 246
 247 namespace this_actor {
 248
 249 /** Returns true if run from the kernel mode, and false if run from a real actor
 250  *
 251  * Everything that is run out of any actor (simulation setup before the engine is run,
 252  * computing the model evolutions as a result to the actors' action, etc) is run in
 253  * kernel mode, just as in any operating systems.
 254  *
 255  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
 256  * because it is the one scheduling when the others should move or wait.
 257  */
 258 bool is_maestro()
 259 {
 260   smx_actor_t process = SIMIX_process_self();
 261   return process == nullptr || process == simix_global->maestro_process;
 262 }
 263
 264 void sleep_for(double duration)
 265 {
 266   if (duration > 0) {
 267     smx_actor_t actor = SIMIX_process_self();
 268     simgrid::s4u::Actor::on_sleep(actor->iface());
 269
 270     simcall_process_sleep(duration);
 271
 272     simgrid::s4u::Actor::on_wake_up(actor->iface());
 273   }
 274 }
 275
 276 void yield()
 277 {
 278   simgrid::simix::simcall([] { /* do nothing*/ });
 279 }
 280
 281 XBT_PUBLIC void sleep_until(double timeout)
 282 {
 283   double now = SIMIX_get_clock();
 284   if (timeout > now)
 285     sleep_for(timeout - now);
 286 }
 287
 288 void execute(double flops)
 289 {
 290   execute(flops, 1.0 /* priority */);
 291 }
 292
 293 void execute(double flops, double priority)
 294 {
 295   exec_init(flops)->set_priority(priority)->start()->wait();
 296 }
 297
 298 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 299                       const std::vector<double>& bytes_amounts)
 300 {
 301   parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
 302 }
 303 void parallel_execute(const std::vector<s4u::Host*>& hosts, const std::vector<double>& flops_amounts,
 304                       const std::vector<double>& bytes_amounts, double timeout)
 305 {
 306   xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
 307   xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
 308              "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
 309   xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
 310              "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
 311              hosts.size(), hosts.size(), flops_amounts.size());
 312
 313   /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
 314    * but that's OK because simcall_execution_wait() is called from here too.
 315    */
 316   smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
 317                                                       (flops_amounts.empty() ? nullptr : flops_amounts.data()),
 318                                                       (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
 319                                                       /* rate */ -1, timeout);
 320   simcall_execution_wait(s);
 321 }
 322
 323 // deprecated
 324 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount,
 325                       double timeout)
 326 {
 327   smx_activity_t s =
 328       simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
 329   simcall_execution_wait(s);
 330   delete[] flops_amount;
 331   delete[] bytes_amount;
 332 }
 333
 334 // deprecated
 335 void parallel_execute(int host_nb, s4u::Host* const* host_list, const double* flops_amount, const double* bytes_amount)
 336 {
 337   smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
 338                                                       /* rate */ -1, /*timeout*/ -1);
 339   simcall_execution_wait(s);
 340   delete[] flops_amount;
 341   delete[] bytes_amount;
 342 }
 343
 344 ExecPtr exec_init(double flops_amount)
 345 {
 346   return ExecPtr(new Exec(get_host(), flops_amount));
 347 }
 348
 349 ExecPtr exec_async(double flops)
 350 {
 351   ExecPtr res = exec_init(flops);
 352   res->start();
 353   return res;
 354 }
 355
 356 aid_t get_pid()
 357 {
 358   return SIMIX_process_self()->pid_;
 359 }
 360
 361 aid_t get_ppid()
 362 {
 363   return SIMIX_process_self()->ppid_;
 364 }
 365
 366 std::string get_name()
 367 {
 368   return SIMIX_process_self()->get_name();
 369 }
 370
 371 const char* get_cname()
 372 {
 373   return SIMIX_process_self()->get_cname();
 374 }
 375
 376 Host* get_host()
 377 {
 378   return SIMIX_process_self()->host_;
 379 }
 380
 381 void suspend()
 382 {
 383   smx_actor_t actor = SIMIX_process_self();
 384   simgrid::s4u::Actor::on_suspend(actor->iface());
 385
 386   simcall_process_suspend(actor);
 387 }
 388
 389 void resume()
 390 {
 391   smx_actor_t process = SIMIX_process_self();
 392   simgrid::simix::simcall([process] { process->resume(); });
 393   simgrid::s4u::Actor::on_resume(process->iface());
 394 }
 395
 396 void exit()
 397 {
 398   smx_actor_t actor = SIMIX_process_self();
 399   simgrid::simix::simcall([actor] { actor->exit(); });
 400 }
 401
 402 void on_exit(std::function<void(int, void*)> fun, void* data)
 403 {
 404   SIMIX_process_self()->iface()->on_exit(fun, data);
 405 }
 406
 407 /** @brief Moves the current actor to another host
 408  *
 409  * @see simgrid::s4u::Actor::migrate() for more information
 410  */
 411 void migrate(Host* new_host)
 412 {
 413   SIMIX_process_self()->iface()->migrate(new_host);
 414 }
 415
 416 std::string getName() /* deprecated */
 417 {
 418   return get_name();
 419 }
 420 const char* getCname() /* deprecated */
 421 {
 422   return get_cname();
 423 }
 424 bool isMaestro() /* deprecated */
 425 {
 426   return is_maestro();
 427 }
 428 aid_t getPid() /* deprecated */
 429 {
 430   return get_pid();
 431 }
 432 aid_t getPpid() /* deprecated */
 433 {
 434   return get_ppid();
 435 }
 436 Host* getHost() /* deprecated */
 437 {
 438   return get_host();
 439 }
 440 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 441 {
 442   SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 443 }
 444 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 445 {
 446   on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 447 }
 448 void kill() /* deprecated */
 449 {
 450   exit();
 451 }
 452
 453 } // namespace this_actor
 454 } // namespace s4u
 455 } // namespace simgrid
 456
 457 /* **************************** Public C interface *************************** */
 458
 459 /** @ingroup m_actor_management
 460  * @brief Returns the process ID of @a actor.
 461  *
 462  * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
 463  */
 464 aid_t sg_actor_get_PID(sg_actor_t actor)
 465 {
 466   /* Do not raise an exception here: this function is called by the logs
 467    * and the exceptions, so it would be called back again and again */
 468   if (actor == nullptr || actor->get_impl() == nullptr)
 469     return 0;
 470   return actor->get_pid();
 471 }
 472
 473 /** @ingroup m_actor_management
 474  * @brief Returns the process ID of the parent of @a actor.
 475  *
 476  * This function checks whether @a actor is a valid pointer and return its parent's PID.
 477  * Returns -1 if the actor has not been created by any other actor.
 478  */
 479 aid_t sg_actor_get_PPID(sg_actor_t actor)
 480 {
 481   return actor->get_ppid();
 482 }
 483
 484 /** @ingroup m_actor_management
 485  *
 486  * @brief Return a #sg_actor_t given its PID.
 487  *
 488  * 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.
 489  * If none is found, @c nullptr is returned.
 490    Note that the PID are unique in the whole simulation, not only on a given host.
 491  */
 492 sg_actor_t sg_actor_by_PID(aid_t pid)
 493 {
 494   return simgrid::s4u::Actor::by_pid(pid).get();
 495 }
 496
 497 /** @ingroup m_actor_management
 498  * @brief Return the name of an actor.
 499  */
 500 const char* sg_actor_get_name(sg_actor_t actor)
 501 {
 502   return actor->get_cname();
 503 }
 504
 505 sg_host_t sg_actor_get_host(sg_actor_t actor)
 506 {
 507   return actor->get_host();
 508 }
 509
 510 /** @ingroup m_actor_management
 511  * @brief Returns the value of a given actor property
 512  *
 513  * @param actor an actor
 514  * @param name a property name
 515  * @return value of a property (or nullptr if the property is not set)
 516  */
 517 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
 518 {
 519   return actor->get_property(name);
 520 }
 521
 522 /** @ingroup m_actor_management
 523  * @brief Return the list of properties
 524  *
 525  * This function returns all the parameters associated with an actor
 526  */
 527 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
 528 {
 529   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 530   xbt_dict_t as_dict                        = xbt_dict_new_homogeneous(xbt_free_f);
 531   std::unordered_map<std::string, std::string>* props = actor->get_properties();
 532   if (props == nullptr)
 533     return nullptr;
 534   for (auto const& kv : *props) {
 535     xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
 536   }
 537   return as_dict;
 538 }
 539
 540 /** @ingroup m_actor_management
 541  * @brief Suspend the actor.
 542  *
 543  * This function suspends the actor by suspending the task on which it was waiting for the completion.
 544  */
 545 void sg_actor_suspend(sg_actor_t actor)
 546 {
 547   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 548   actor->suspend();
 549 }
 550
 551 /** @ingroup m_actor_management
 552  * @brief Resume a suspended actor.
 553  *
 554  * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
 555  */
 556 void sg_actor_resume(sg_actor_t actor)
 557 {
 558   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 559   actor->resume();
 560 }
 561
 562 /** @ingroup m_actor_management
 563  * @brief Returns true if the actor is suspended .
 564  *
 565  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
 566  */
 567 int sg_actor_is_suspended(sg_actor_t actor)
 568 {
 569   return actor->is_suspended();
 570 }
 571
 572 /**
 573  * @ingroup m_actor_management
 574  * @brief Restarts an actor from the beginning.
 575  */
 576 sg_actor_t sg_actor_restart(sg_actor_t actor)
 577 {
 578   return actor->restart();
 579 }
 580
 581 /**
 582  * @ingroup m_actor_management
 583  * @brief Sets the "auto-restart" flag of the actor.
 584  * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
 585  */
 586 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 587 {
 588   actor->set_auto_restart(auto_restart);
 589 }
 590
 591 /** @ingroup m_actor_management
 592  * @brief This actor will be terminated automatically when the last non-daemon actor finishes
 593  */
 594 void sg_actor_daemonize(sg_actor_t actor)
 595 {
 596   actor->daemonize();
 597 }
 598
 599 /** @ingroup m_actor_management
 600  * @brief Migrates an actor to another location.
 601  *
 602  * This function changes the value of the #sg_host_t on  which @a actor is running.
 603  */
 604 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
 605 {
 606   process->migrate(host);
 607 }
 608
 609 /** @ingroup m_actor_management
 610  * @brief Wait for the completion of a #sg_actor_t.
 611  *
 612  * @param actor the actor to wait for
 613  * @param timeout wait until the actor is over, or the timeout expires
 614  */
 615 void sg_actor_join(sg_actor_t actor, double timeout)
 616 {
 617   actor->join(timeout);
 618 }
 619
 620 void sg_actor_kill(sg_actor_t actor)
 621 {
 622   actor->kill();
 623 }
 624
 625 void sg_actor_kill_all()
 626 {
 627   simgrid::s4u::Actor::kill_all();
 628 }
 629
 630 /** @ingroup m_actor_management
 631  * @brief Set the kill time of an actor.
 632  *
 633  * @param actor an actor
 634  * @param kill_time the time when the actor is killed.
 635  */
 636 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 637 {
 638   actor->set_kill_time(kill_time);
 639 }
 640
 641 /** Yield the current actor; let the other actors execute first */
 642 void sg_actor_yield()
 643 {
 644   simgrid::s4u::this_actor::yield();
 645 }
 646
 647 void sg_actor_sleep_for(double duration)
 648 {
 649   simgrid::s4u::this_actor::sleep_for(duration);
 650 }