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