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