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