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) /* deprecated */
  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::unordered_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(std::function<void(int, void*)> fun, void* data)
 375 {
 376   SIMIX_process_self()->iface()->on_exit(fun, data);
 377 }
 378
 379 /** @brief Moves the current actor to another host
 380  *
 381  * @see simgrid::s4u::Actor::migrate() for more information
 382  */
 383 void migrate(Host* new_host)
 384 {
 385   SIMIX_process_self()->iface()->migrate(new_host);
 386 }
 387
 388 std::string getName() /* deprecated */
 389 {
 390   return get_name();
 391 }
 392 const char* getCname() /* deprecated */
 393 {
 394   return get_cname();
 395 }
 396 bool isMaestro() /* deprecated */
 397 {
 398   return is_maestro();
 399 }
 400 aid_t getPid() /* deprecated */
 401 {
 402   return get_pid();
 403 }
 404 aid_t getPpid() /* deprecated */
 405 {
 406   return get_ppid();
 407 }
 408 Host* getHost() /* deprecated */
 409 {
 410   return get_host();
 411 }
 412 bool isSuspended() /* deprecated */
 413 {
 414   return is_suspended();
 415 }
 416 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 417 {
 418   SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 419 }
 420 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 421 {
 422   on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 423 }
 424
 425 } // namespace this_actor
 426 } // namespace s4u
 427 } // namespace simgrid
 428
 429 /* **************************** Public C interface *************************** */
 430
 431 /** \ingroup m_actor_management
 432  * \brief Returns the process ID of \a actor.
 433  *
 434  * This function checks whether \a actor is a valid pointer and return its PID (or 0 in case of problem).
 435  */
 436 int sg_actor_get_PID(sg_actor_t actor)
 437 {
 438   /* Do not raise an exception here: this function is called by the logs
 439    * and the exceptions, so it would be called back again and again */
 440   if (actor == nullptr || actor->get_impl() == nullptr)
 441     return 0;
 442   return actor->get_pid();
 443 }
 444
 445 /** \ingroup m_actor_management
 446  * \brief Returns the process ID of the parent of \a actor.
 447  *
 448  * This function checks whether \a actor is a valid pointer and return its parent's PID.
 449  * Returns -1 if the actor has not been created by any other actor.
 450  */
 451 int sg_actor_get_PPID(sg_actor_t actor)
 452 {
 453   return actor->get_ppid();
 454 }
 455
 456 /** \ingroup m_actor_management
 457  *
 458  * \brief Return a #sg_actor_t given its PID.
 459  *
 460  * 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.
 461  * If none is found, \c nullptr is returned.
 462    Note that the PID are unique in the whole simulation, not only on a given host.
 463  */
 464 sg_actor_t sg_actor_by_PID(aid_t pid)
 465 {
 466   return simgrid::s4u::Actor::by_pid(pid).get();
 467 }
 468
 469 /** \ingroup m_actor_management
 470  * \brief Return the name of an actor.
 471  */
 472 const char* sg_actor_get_name(sg_actor_t actor)
 473 {
 474   return actor->get_cname();
 475 }
 476
 477 sg_host_t sg_actor_get_host(sg_actor_t actor)
 478 {
 479   return actor->get_host();
 480 }
 481
 482 /** \ingroup m_actor_management
 483  * \brief Returns the value of a given actor property
 484  *
 485  * \param actor an actor
 486  * \param name a property name
 487  * \return value of a property (or nullptr if the property is not set)
 488  */
 489 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
 490 {
 491   return actor->get_property(name);
 492 }
 493
 494 /** \ingroup m_actor_management
 495  * \brief Return the list of properties
 496  *
 497  * This function returns all the parameters associated with an actor
 498  */
 499 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
 500 {
 501   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 502   xbt_dict_t as_dict                        = xbt_dict_new_homogeneous(xbt_free_f);
 503   std::unordered_map<std::string, std::string>* props = actor->get_properties();
 504   if (props == nullptr)
 505     return nullptr;
 506   for (auto const& kv : *props) {
 507     xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
 508   }
 509   return as_dict;
 510 }
 511
 512 /** \ingroup m_actor_management
 513  * \brief Suspend the actor.
 514  *
 515  * This function suspends the actor by suspending the task on which it was waiting for the completion.
 516  */
 517 void sg_actor_suspend(sg_actor_t actor)
 518 {
 519   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 520   actor->suspend();
 521 }
 522
 523 /** \ingroup m_actor_management
 524  * \brief Resume a suspended actor.
 525  *
 526  * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
 527  */
 528 void sg_actor_resume(sg_actor_t actor)
 529 {
 530   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 531   actor->resume();
 532 }
 533
 534 /** \ingroup m_actor_management
 535  * \brief Returns true if the actor is suspended .
 536  *
 537  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
 538  */
 539 int sg_actor_is_suspended(sg_actor_t actor)
 540 {
 541   return actor->is_suspended();
 542 }
 543
 544 /**
 545  * \ingroup m_actor_management
 546  * \brief Restarts an actor from the beginning.
 547  */
 548 sg_actor_t sg_actor_restart(sg_actor_t actor)
 549 {
 550   return actor->restart();
 551 }
 552
 553 /**
 554  * \ingroup m_actor_management
 555  * \brief Sets the "auto-restart" flag of the actor.
 556  * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
 557  */
 558 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 559 {
 560   actor->set_auto_restart(auto_restart);
 561 }
 562
 563 /** @ingroup m_actor_management
 564  * @brief This actor will be terminated automatically when the last non-daemon actor finishes
 565  */
 566 void sg_actor_daemonize(sg_actor_t actor)
 567 {
 568   actor->daemonize();
 569 }
 570
 571 /** \ingroup m_actor_management
 572  * \brief Migrates an actor to another location.
 573  *
 574  * This function changes the value of the #sg_host_t on  which \a actor is running.
 575  */
 576 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
 577 {
 578   process->migrate(host);
 579 }
 580
 581 /** \ingroup m_actor_management
 582  * \brief Wait for the completion of a #sg_actor_t.
 583  *
 584  * \param actor the actor to wait for
 585  * \param timeout wait until the actor is over, or the timeout expires
 586  */
 587 void sg_actor_join(sg_actor_t actor, double timeout)
 588 {
 589   actor->join(timeout);
 590 }
 591
 592 void sg_actor_kill(sg_actor_t actor)
 593 {
 594   actor->kill();
 595 }
 596
 597 void sg_actor_kill_all()
 598 {
 599   simgrid::s4u::Actor::kill_all();
 600 }
 601
 602 /** \ingroup m_actor_management
 603  * \brief Set the kill time of an actor.
 604  *
 605  * \param actor an actor
 606  * \param kill_time the time when the actor is killed.
 607  */
 608 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 609 {
 610   actor->set_kill_time(kill_time);
 611 }
 612
 613 /** Yield the current actor; let the other actors execute first */
 614 void sg_actor_yield()
 615 {
 616   simgrid::s4u::this_actor::yield();
 617 }