src/s4u/s4u_Actor.cpp

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