src/s4u/s4u_Actor.cpp

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