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