src/s4u/s4u_actor.cpp

   1 /* Copyright (c) 2006-2017. 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 "xbt/log.h"
   7
   8 #include "simgrid/s4u/Actor.hpp"
   9 #include "simgrid/s4u/Comm.hpp"
  10 #include "simgrid/s4u/Exec.hpp"
  11 #include "simgrid/s4u/Host.hpp"
  12 #include "simgrid/s4u/Mailbox.hpp"
  13
  14 #include "src/kernel/context/Context.hpp"
  15 #include "src/simix/smx_private.hpp"
  16
  17 #include <sstream>
  18
  19 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_actor, "S4U actors");
  20
  21 namespace simgrid {
  22 namespace s4u {
  23
  24 // ***** Actor creation *****
  25 ActorPtr Actor::self()
  26 {
  27   smx_context_t self_context = SIMIX_context_self();
  28   if (self_context == nullptr)
  29     return simgrid::s4u::ActorPtr();
  30
  31   return self_context->process()->iface();
  32 }
  33
  34 ActorPtr Actor::createActor(const char* name, s4u::Host* host, std::function<void()> code)
  35 {
  36   simgrid::simix::ActorImpl* actor = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
  37   return actor->iface();
  38 }
  39
  40 ActorPtr Actor::createActor(const char* name, s4u::Host* host, const char* function, std::vector<std::string> args)
  41 {
  42   simgrid::simix::ActorCodeFactory& factory = SIMIX_get_actor_code_factory(function);
  43   simgrid::simix::ActorCode code = factory(std::move(args));
  44   simgrid::simix::ActorImpl* actor          = simcall_process_create(name, std::move(code), nullptr, host, nullptr);
  45   return actor->iface();
  46 }
  47
  48 void intrusive_ptr_add_ref(Actor* actor)
  49 {
  50   intrusive_ptr_add_ref(actor->pimpl_);
  51 }
  52 void intrusive_ptr_release(Actor* actor)
  53 {
  54   intrusive_ptr_release(actor->pimpl_);
  55 }
  56
  57 // ***** Actor methods *****
  58
  59 void Actor::join() {
  60   simcall_process_join(this->pimpl_, -1);
  61 }
  62
  63 void Actor::join(double timeout)
  64 {
  65   simcall_process_join(this->pimpl_, timeout);
  66 }
  67
  68 void Actor::setAutoRestart(bool autorestart) {
  69   simgrid::simix::kernelImmediate([this, autorestart]() { pimpl_->auto_restart = autorestart; });
  70 }
  71
  72 void Actor::onExit(int_f_pvoid_pvoid_t fun, void* data)
  73 {
  74   simcall_process_on_exit(pimpl_, fun, data);
  75 }
  76
  77 /** @brief Moves the actor to another host
  78  *
  79  * If the actor is currently blocked on an execution activity, the activity is also
  80  * migrated to the new host. If it's blocked on another kind of activity, an error is
  81  * raised as the mandated code is not written yet. Please report that bug if you need it.
  82  *
  83  * Asynchronous activities started by the actor are not migrated automatically, so you have
  84  * to take care of this yourself (only you knows which ones should be migrated).
  85  */
  86 void Actor::migrate(Host* new_host)
  87 {
  88   simgrid::simix::kernelImmediate([this, new_host]() {
  89     if (pimpl_->waiting_synchro != nullptr) {
  90       // The actor is blocked on an activity. If it's an exec, migrate it too.
  91       // FIXME: implement the migration of other kind of activities
  92       simgrid::kernel::activity::ExecImplPtr exec =
  93           boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(pimpl_->waiting_synchro);
  94       xbt_assert(exec.get() != nullptr, "We can only migrate blocked actors when they are blocked on executions.");
  95       exec->migrate(new_host);
  96     }
  97     SIMIX_process_change_host(this->pimpl_, new_host);
  98   });
  99 }
 100
 101 s4u::Host* Actor::getHost()
 102 {
 103   return this->pimpl_->host;
 104 }
 105
 106 void Actor::daemonize()
 107 {
 108   simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
 109 }
 110
 111 const simgrid::xbt::string& Actor::getName() const
 112 {
 113   return this->pimpl_->getName();
 114 }
 115
 116 const char* Actor::getCname() const
 117 {
 118   return this->pimpl_->getCname();
 119 }
 120
 121 aid_t Actor::getPid()
 122 {
 123   return this->pimpl_->pid;
 124 }
 125
 126 aid_t Actor::getPpid()
 127 {
 128   return this->pimpl_->ppid;
 129 }
 130
 131 void Actor::suspend()
 132 {
 133   if (TRACE_actor_is_enabled())
 134     simgrid::instr::Container::byName(instr_pid(this))->getState("MSG_PROCESS_STATE")->pushEvent("suspend");
 135
 136   simcall_process_suspend(pimpl_);
 137 }
 138
 139 void Actor::resume()
 140 {
 141   simgrid::simix::kernelImmediate([this] { pimpl_->resume(); });
 142   if (TRACE_actor_is_enabled())
 143     simgrid::instr::Container::byName(instr_pid(this))->getState("MSG_PROCESS_STATE")->popEvent();
 144 }
 145
 146 int Actor::isSuspended()
 147 {
 148   return simgrid::simix::kernelImmediate([this] { return pimpl_->suspended; });
 149 }
 150
 151 void Actor::setKillTime(double time) {
 152   simcall_process_set_kill_time(pimpl_,time);
 153 }
 154
 155 /** \brief Get the kill time of an actor(or 0 if unset). */
 156 double Actor::getKillTime()
 157 {
 158   return SIMIX_timer_get_date(pimpl_->kill_timer);
 159 }
 160
 161 void Actor::kill(aid_t pid)
 162 {
 163   smx_actor_t process = SIMIX_process_from_PID(pid);
 164   if(process != nullptr) {
 165     simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
 166   } else {
 167     std::ostringstream oss;
 168     oss << "kill: ("<< pid <<") - No such process" << std::endl;
 169     throw std::runtime_error(oss.str());
 170   }
 171 }
 172
 173 smx_actor_t Actor::getImpl() {
 174   return pimpl_;
 175 }
 176
 177 void Actor::kill() {
 178   smx_actor_t process = SIMIX_process_self();
 179   simgrid::simix::kernelImmediate(
 180       [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
 181 }
 182
 183 // ***** Static functions *****
 184
 185 ActorPtr Actor::byPid(aid_t pid)
 186 {
 187   smx_actor_t process = SIMIX_process_from_PID(pid);
 188   if (process != nullptr)
 189     return process->iface();
 190   else
 191     return ActorPtr();
 192 }
 193
 194 void Actor::killAll()
 195 {
 196   simcall_process_killall(1);
 197 }
 198
 199 void Actor::killAll(int resetPid)
 200 {
 201   simcall_process_killall(resetPid);
 202 }
 203
 204 std::map<std::string, std::string>* Actor::getProperties()
 205 {
 206   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
 207 }
 208
 209 /** Retrieve the property value (or nullptr if not set) */
 210 const char* Actor::getProperty(const char* key)
 211 {
 212   return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
 213 }
 214
 215 void Actor::setProperty(const char* key, const char* value)
 216 {
 217   simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
 218 }
 219
 220 Actor* Actor::restart()
 221 {
 222   return simgrid::simix::kernelImmediate([this]() { return pimpl_->restart(); });
 223 }
 224
 225 // ***** this_actor *****
 226
 227 namespace this_actor {
 228
 229 /** Returns true if run from the kernel mode, and false if run from a real actor
 230  *
 231  * Everything that is run out of any actor (simulation setup before the engine is run,
 232  * computing the model evolutions as a result to the actors' action, etc) is run in
 233  * kernel mode, just as in any operating systems.
 234  *
 235  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
 236  * because it is the one scheduling when the others should move or wait.
 237  */
 238 bool isMaestro()
 239 {
 240   smx_actor_t process = SIMIX_process_self();
 241   return process == nullptr || process == simix_global->maestro_process;
 242 }
 243
 244 void sleep_for(double duration)
 245 {
 246   if (duration > 0)
 247     simcall_process_sleep(duration);
 248 }
 249
 250 void yield()
 251 {
 252   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
 253 }
 254
 255 XBT_PUBLIC(void) sleep_until(double timeout)
 256 {
 257   double now = SIMIX_get_clock();
 258   if (timeout > now)
 259     simcall_process_sleep(timeout - now);
 260 }
 261
 262 void execute(double flops)
 263 {
 264   smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, getHost());
 265   simcall_execution_wait(s);
 266 }
 267
 268 void execute(double flops, double priority)
 269 {
 270   smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, getHost());
 271   simcall_execution_wait(s);
 272 }
 273
 274 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout)
 275 {
 276   smx_activity_t s =
 277       simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, timeout);
 278   simcall_execution_wait(s);
 279 }
 280
 281 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
 282 {
 283   smx_activity_t s = simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, -1);
 284   simcall_execution_wait(s);
 285 }
 286
 287 ExecPtr exec_init(double flops_amount)
 288 {
 289   ExecPtr res        = ExecPtr(new Exec());
 290   res->host_         = getHost();
 291   res->flops_amount_ = flops_amount;
 292   res->setRemains(flops_amount);
 293   return res;
 294 }
 295
 296 ExecPtr exec_async(double flops)
 297 {
 298   ExecPtr res = exec_init(flops);
 299   res->start();
 300   return res;
 301 }
 302
 303 void* recv(MailboxPtr chan) // deprecated
 304 {
 305   return chan->get();
 306 }
 307
 308 void* recv(MailboxPtr chan, double timeout) // deprecated
 309 {
 310   return chan->get(timeout);
 311 }
 312
 313 void send(MailboxPtr chan, void* payload, double simulatedSize) // deprecated
 314 {
 315   chan->put(payload, simulatedSize);
 316 }
 317
 318 void send(MailboxPtr chan, void* payload, double simulatedSize, double timeout) // deprecated
 319 {
 320   chan->put(payload, simulatedSize, timeout);
 321 }
 322
 323 CommPtr isend(MailboxPtr chan, void* payload, double simulatedSize) // deprecated
 324 {
 325   return chan->put_async(payload, simulatedSize);
 326 }
 327
 328 CommPtr irecv(MailboxPtr chan, void** data) // deprecated
 329 {
 330   return chan->get_async(data);
 331 }
 332
 333 aid_t getPid()
 334 {
 335   return SIMIX_process_self()->pid;
 336 }
 337
 338 aid_t getPpid()
 339 {
 340   return SIMIX_process_self()->ppid;
 341 }
 342
 343 std::string getName()
 344 {
 345   return SIMIX_process_self()->getName();
 346 }
 347
 348 const char* getCname()
 349 {
 350   return SIMIX_process_self()->getCname();
 351 }
 352
 353 Host* getHost()
 354 {
 355   return SIMIX_process_self()->host;
 356 }
 357
 358 void suspend()
 359 {
 360   if (TRACE_actor_is_enabled())
 361     instr::Container::byName(getName() + "-" + std::to_string(getPid()))
 362         ->getState("MSG_PROCESS_STATE")
 363         ->pushEvent("suspend");
 364   simcall_process_suspend(SIMIX_process_self());
 365 }
 366
 367 void resume()
 368 {
 369   smx_actor_t process = SIMIX_process_self();
 370   simgrid::simix::kernelImmediate([process] { process->resume(); });
 371
 372   if (TRACE_actor_is_enabled())
 373     instr::Container::byName(getName() + "-" + std::to_string(getPid()))->getState("MSG_PROCESS_STATE")->popEvent();
 374 }
 375
 376 bool isSuspended()
 377 {
 378   smx_actor_t process = SIMIX_process_self();
 379   return simgrid::simix::kernelImmediate([process] { return process->suspended; });
 380 }
 381
 382 void kill()
 383 {
 384   smx_actor_t process = SIMIX_process_self();
 385   simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
 386 }
 387
 388 void onExit(int_f_pvoid_pvoid_t fun, void* data)
 389 {
 390   simcall_process_on_exit(SIMIX_process_self(), fun, data);
 391 }
 392
 393 /** @brief Moves the current actor to another host
 394  *
 395  * @see simgrid::s4u::Actor::migrate() for more information
 396  */
 397 void migrate(Host* new_host)
 398 {
 399   SIMIX_process_self()->iface()->migrate(new_host);
 400 }
 401 }
 402 }
 403 }