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     xbt_assert(autorestart && not pimpl_->auto_restart_); // FIXME: handle all cases
  80     pimpl_->set_auto_restart(autorestart);
  81
  82     simgrid::kernel::actor::ProcessArg* arg = new simgrid::kernel::actor::ProcessArg(pimpl_->host_, pimpl_);
  83     XBT_DEBUG("Adding Process %s to the actors_at_boot_ list of Host %s", arg->name.c_str(), arg->host->get_cname());
  84     pimpl_->host_->pimpl_->actors_at_boot_.emplace_back(arg);
  85   });
  86 }
  87
  88 void Actor::on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
  89 {
  90   simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
  91 }
  92
  93 void Actor::on_exit(std::function<void(int, void*)> fun, void* data)
  94 {
  95   simgrid::simix::simcall([this, fun, data] { SIMIX_process_on_exit(pimpl_, fun, data); });
  96 }
  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(std::string key)
 229 {
 230   return simgrid::simix::simcall([this, key] { return pimpl_->get_property(key); });
 231 }
 232
 233 void Actor::set_property(std::string key, std::string 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   execute(flops, 1.0 /* priority */);
 289 }
 290
 291 void execute(double flops, double priority)
 292 {
 293   exec_init(flops)->set_priority(priority)->start()->wait();
 294 }
 295
 296 void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
 297                       std::vector<double> bytes_amounts)
 298 {
 299   parallel_execute(hosts, flops_amounts, bytes_amounts, -1);
 300 }
 301 void parallel_execute(std::vector<s4u::Host*> hosts, std::vector<double> flops_amounts,
 302                       std::vector<double> bytes_amounts, double timeout)
 303 {
 304   xbt_assert(hosts.size() > 0, "Your parallel executions must span over at least one host.");
 305   xbt_assert(hosts.size() == flops_amounts.size() || flops_amounts.empty(),
 306              "Host count (%zu) does not match flops_amount count (%zu).", hosts.size(), flops_amounts.size());
 307   xbt_assert(hosts.size() * hosts.size() == bytes_amounts.size() || bytes_amounts.empty(),
 308              "bytes_amounts must be a matrix of size host_count * host_count (%zu*%zu), but it's of size %zu.",
 309              hosts.size(), hosts.size(), flops_amounts.size());
 310
 311   /* The vectors live as parameter of parallel_execute. No copy is created for simcall_execution_parallel_start(),
 312    * but that's OK because simcall_execution_wait() is called from here too.
 313    */
 314   smx_activity_t s = simcall_execution_parallel_start("", hosts.size(), hosts.data(),
 315                                                       (flops_amounts.empty() ? nullptr : flops_amounts.data()),
 316                                                       (bytes_amounts.empty() ? nullptr : bytes_amounts.data()),
 317                                                       /* rate */ -1, timeout);
 318   simcall_execution_wait(s);
 319 }
 320
 321 // deprecated
 322 void parallel_execute(int host_nb, s4u::Host** host_list, double* flops_amount, double* bytes_amount, double timeout)
 323 {
 324   smx_activity_t s =
 325       simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount, /* rate */ -1, timeout);
 326   simcall_execution_wait(s);
 327   delete[] flops_amount;
 328   delete[] bytes_amount;
 329 }
 330
 331 // deprecated
 332 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
 333 {
 334   smx_activity_t s = simcall_execution_parallel_start("", host_nb, host_list, flops_amount, bytes_amount,
 335                                                       /* rate */ -1, /*timeout*/ -1);
 336   simcall_execution_wait(s);
 337   delete[] flops_amount;
 338   delete[] bytes_amount;
 339 }
 340
 341 ExecPtr exec_init(double flops_amount)
 342 {
 343   ExecPtr res        = ExecPtr(new Exec());
 344   res->host_         = get_host();
 345   res->flops_amount_ = flops_amount;
 346   res->set_remaining(flops_amount);
 347   return res;
 348 }
 349
 350 ExecPtr exec_async(double flops)
 351 {
 352   ExecPtr res = exec_init(flops);
 353   res->start();
 354   return res;
 355 }
 356
 357 aid_t get_pid()
 358 {
 359   return SIMIX_process_self()->pid_;
 360 }
 361
 362 aid_t get_ppid()
 363 {
 364   return SIMIX_process_self()->ppid_;
 365 }
 366
 367 std::string get_name()
 368 {
 369   return SIMIX_process_self()->get_name();
 370 }
 371
 372 const char* get_cname()
 373 {
 374   return SIMIX_process_self()->get_cname();
 375 }
 376
 377 Host* get_host()
 378 {
 379   return SIMIX_process_self()->host_;
 380 }
 381
 382 void suspend()
 383 {
 384   smx_actor_t actor = SIMIX_process_self();
 385   simgrid::s4u::Actor::on_suspend(actor->iface());
 386
 387   simcall_process_suspend(actor);
 388 }
 389
 390 void resume()
 391 {
 392   smx_actor_t process = SIMIX_process_self();
 393   simgrid::simix::simcall([process] { process->resume(); });
 394   simgrid::s4u::Actor::on_resume(process->iface());
 395 }
 396
 397 bool is_suspended()
 398 {
 399   smx_actor_t process = SIMIX_process_self();
 400   return simgrid::simix::simcall([process] { return process->suspended_; });
 401 }
 402
 403 void exit()
 404 {
 405   smx_actor_t process = SIMIX_process_self();
 406   simgrid::simix::simcall([process] { SIMIX_process_kill(process, process); });
 407 }
 408
 409 void on_exit(std::function<void(int, void*)> fun, void* data)
 410 {
 411   SIMIX_process_self()->iface()->on_exit(fun, data);
 412 }
 413
 414 /** @brief Moves the current actor to another host
 415  *
 416  * @see simgrid::s4u::Actor::migrate() for more information
 417  */
 418 void migrate(Host* new_host)
 419 {
 420   SIMIX_process_self()->iface()->migrate(new_host);
 421 }
 422
 423 std::string getName() /* deprecated */
 424 {
 425   return get_name();
 426 }
 427 const char* getCname() /* deprecated */
 428 {
 429   return get_cname();
 430 }
 431 bool isMaestro() /* deprecated */
 432 {
 433   return is_maestro();
 434 }
 435 aid_t getPid() /* deprecated */
 436 {
 437   return get_pid();
 438 }
 439 aid_t getPpid() /* deprecated */
 440 {
 441   return get_ppid();
 442 }
 443 Host* getHost() /* deprecated */
 444 {
 445   return get_host();
 446 }
 447 bool isSuspended() /* deprecated */
 448 {
 449   return is_suspended();
 450 }
 451 void on_exit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 452 {
 453   SIMIX_process_self()->iface()->on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 454 }
 455 void onExit(int_f_pvoid_pvoid_t fun, void* data) /* deprecated */
 456 {
 457   on_exit([fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 458 }
 459 void kill() /* deprecated */
 460 {
 461   exit();
 462 }
 463
 464 } // namespace this_actor
 465 } // namespace s4u
 466 } // namespace simgrid
 467
 468 /* **************************** Public C interface *************************** */
 469
 470 /** @ingroup m_actor_management
 471  * @brief Returns the process ID of @a actor.
 472  *
 473  * This function checks whether @a actor is a valid pointer and return its PID (or 0 in case of problem).
 474  */
 475 int sg_actor_get_PID(sg_actor_t actor)
 476 {
 477   /* Do not raise an exception here: this function is called by the logs
 478    * and the exceptions, so it would be called back again and again */
 479   if (actor == nullptr || actor->get_impl() == nullptr)
 480     return 0;
 481   return actor->get_pid();
 482 }
 483
 484 /** @ingroup m_actor_management
 485  * @brief Returns the process ID of the parent of @a actor.
 486  *
 487  * This function checks whether @a actor is a valid pointer and return its parent's PID.
 488  * Returns -1 if the actor has not been created by any other actor.
 489  */
 490 int sg_actor_get_PPID(sg_actor_t actor)
 491 {
 492   return actor->get_ppid();
 493 }
 494
 495 /** @ingroup m_actor_management
 496  *
 497  * @brief Return a #sg_actor_t given its PID.
 498  *
 499  * 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.
 500  * If none is found, @c nullptr is returned.
 501    Note that the PID are unique in the whole simulation, not only on a given host.
 502  */
 503 sg_actor_t sg_actor_by_PID(aid_t pid)
 504 {
 505   return simgrid::s4u::Actor::by_pid(pid).get();
 506 }
 507
 508 /** @ingroup m_actor_management
 509  * @brief Return the name of an actor.
 510  */
 511 const char* sg_actor_get_name(sg_actor_t actor)
 512 {
 513   return actor->get_cname();
 514 }
 515
 516 sg_host_t sg_actor_get_host(sg_actor_t actor)
 517 {
 518   return actor->get_host();
 519 }
 520
 521 /** @ingroup m_actor_management
 522  * @brief Returns the value of a given actor property
 523  *
 524  * @param actor an actor
 525  * @param name a property name
 526  * @return value of a property (or nullptr if the property is not set)
 527  */
 528 const char* sg_actor_get_property_value(sg_actor_t actor, const char* name)
 529 {
 530   return actor->get_property(name);
 531 }
 532
 533 /** @ingroup m_actor_management
 534  * @brief Return the list of properties
 535  *
 536  * This function returns all the parameters associated with an actor
 537  */
 538 xbt_dict_t sg_actor_get_properties(sg_actor_t actor)
 539 {
 540   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 541   xbt_dict_t as_dict                        = xbt_dict_new_homogeneous(xbt_free_f);
 542   std::unordered_map<std::string, std::string>* props = actor->get_properties();
 543   if (props == nullptr)
 544     return nullptr;
 545   for (auto const& kv : *props) {
 546     xbt_dict_set(as_dict, kv.first.c_str(), xbt_strdup(kv.second.c_str()), nullptr);
 547   }
 548   return as_dict;
 549 }
 550
 551 /** @ingroup m_actor_management
 552  * @brief Suspend the actor.
 553  *
 554  * This function suspends the actor by suspending the task on which it was waiting for the completion.
 555  */
 556 void sg_actor_suspend(sg_actor_t actor)
 557 {
 558   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 559   actor->suspend();
 560 }
 561
 562 /** @ingroup m_actor_management
 563  * @brief Resume a suspended actor.
 564  *
 565  * This function resumes a suspended actor by resuming the task on which it was waiting for the completion.
 566  */
 567 void sg_actor_resume(sg_actor_t actor)
 568 {
 569   xbt_assert(actor != nullptr, "Invalid parameter: First argument must not be nullptr");
 570   actor->resume();
 571 }
 572
 573 /** @ingroup m_actor_management
 574  * @brief Returns true if the actor is suspended .
 575  *
 576  * This checks whether an actor is suspended or not by inspecting the task on which it was waiting for the completion.
 577  */
 578 int sg_actor_is_suspended(sg_actor_t actor)
 579 {
 580   return actor->is_suspended();
 581 }
 582
 583 /**
 584  * @ingroup m_actor_management
 585  * @brief Restarts an actor from the beginning.
 586  */
 587 sg_actor_t sg_actor_restart(sg_actor_t actor)
 588 {
 589   return actor->restart();
 590 }
 591
 592 /**
 593  * @ingroup m_actor_management
 594  * @brief Sets the "auto-restart" flag of the actor.
 595  * If the flag is set to 1, the actor will be automatically restarted when its host comes back up.
 596  */
 597 void sg_actor_set_auto_restart(sg_actor_t actor, int auto_restart)
 598 {
 599   actor->set_auto_restart(auto_restart);
 600 }
 601
 602 /** @ingroup m_actor_management
 603  * @brief This actor will be terminated automatically when the last non-daemon actor finishes
 604  */
 605 void sg_actor_daemonize(sg_actor_t actor)
 606 {
 607   actor->daemonize();
 608 }
 609
 610 /** @ingroup m_actor_management
 611  * @brief Migrates an actor to another location.
 612  *
 613  * This function changes the value of the #sg_host_t on  which @a actor is running.
 614  */
 615 void sg_actor_migrate(sg_actor_t process, sg_host_t host)
 616 {
 617   process->migrate(host);
 618 }
 619
 620 /** @ingroup m_actor_management
 621  * @brief Wait for the completion of a #sg_actor_t.
 622  *
 623  * @param actor the actor to wait for
 624  * @param timeout wait until the actor is over, or the timeout expires
 625  */
 626 void sg_actor_join(sg_actor_t actor, double timeout)
 627 {
 628   actor->join(timeout);
 629 }
 630
 631 void sg_actor_kill(sg_actor_t actor)
 632 {
 633   actor->kill();
 634 }
 635
 636 void sg_actor_kill_all()
 637 {
 638   simgrid::s4u::Actor::kill_all();
 639 }
 640
 641 /** @ingroup m_actor_management
 642  * @brief Set the kill time of an actor.
 643  *
 644  * @param actor an actor
 645  * @param kill_time the time when the actor is killed.
 646  */
 647 void sg_actor_set_kill_time(sg_actor_t actor, double kill_time)
 648 {
 649   actor->set_kill_time(kill_time);
 650 }
 651
 652 /** Yield the current actor; let the other actors execute first */
 653 void sg_actor_yield()
 654 {
 655   simgrid::s4u::this_actor::yield();
 656 }