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