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.h"
  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   simcall_process_auto_restart_set(pimpl_,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::host()
  79 {
  80   return this->pimpl_->host;
  81 }
  82
  83 void Actor::daemonize()
  84 {
  85   simgrid::simix::kernelImmediate([this]() { pimpl_->daemonize(); });
  86 }
  87
  88 const char* Actor::cname()
  89 {
  90   return this->pimpl_->name.c_str();
  91 }
  92
  93 simgrid::xbt::string Actor::name()
  94 {
  95   return this->pimpl_->name;
  96 }
  97
  98 aid_t Actor::pid()
  99 {
 100   return this->pimpl_->pid;
 101 }
 102
 103 aid_t Actor::ppid()
 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   simcall_process_resume(pimpl_);
 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 double Actor::killTime()
 128 {
 129   return simcall_process_get_kill_time(pimpl_);
 130 }
 131
 132 void Actor::kill(aid_t pid)
 133 {
 134   smx_actor_t process = SIMIX_process_from_PID(pid);
 135   if(process != nullptr) {
 136     simcall_process_kill(process);
 137   } else {
 138     std::ostringstream oss;
 139     oss << "kill: ("<< pid <<") - No such process" << std::endl;
 140     throw std::runtime_error(oss.str());
 141   }
 142 }
 143
 144 smx_actor_t Actor::getImpl() {
 145   return pimpl_;
 146 }
 147
 148 void Actor::kill() {
 149   simcall_process_kill(pimpl_);
 150 }
 151
 152 // ***** Static functions *****
 153
 154 ActorPtr Actor::byPid(aid_t pid)
 155 {
 156   smx_actor_t process = SIMIX_process_from_PID(pid);
 157   if (process != nullptr)
 158     return process->iface();
 159   else
 160     return ActorPtr();
 161 }
 162
 163 void Actor::killAll()
 164 {
 165   simcall_process_killall(1);
 166 }
 167
 168 void Actor::killAll(int resetPid)
 169 {
 170   simcall_process_killall(resetPid);
 171 }
 172
 173 /** Retrieve the property value (or nullptr if not set) */
 174 const char* Actor::property(const char* key)
 175 {
 176   return (char*)xbt_dict_get_or_null(simcall_process_get_properties(pimpl_), key);
 177 }
 178 void Actor::setProperty(const char* key, const char* value)
 179 {
 180   simgrid::simix::kernelImmediate([this, key, value] {
 181     xbt_dict_set(simcall_process_get_properties(pimpl_), key, (char*)value, (void_f_pvoid_t) nullptr);
 182   });
 183 }
 184
 185 // ***** this_actor *****
 186
 187 namespace this_actor {
 188
 189 /** Returns true if run from the kernel mode, and false if run from a real actor
 190  *
 191  * Everything that is run out of any actor (simulation setup before the engine is run,
 192  * computing the model evolutions as a result to the actors' action, etc) is run in
 193  * kernel mode, just as in any operating systems.
 194  *
 195  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
 196  * because it is the one scheduling when the others should move or wait.
 197  */
 198 bool isMaestro()
 199 {
 200   smx_actor_t process = SIMIX_process_self();
 201   return process == nullptr || process == simix_global->maestro_process;
 202 }
 203
 204 void sleep_for(double duration)
 205 {
 206   if (duration > 0)
 207     simcall_process_sleep(duration);
 208 }
 209
 210 XBT_PUBLIC(void) sleep_until(double timeout)
 211 {
 212   double now = SIMIX_get_clock();
 213   if (timeout > now)
 214     simcall_process_sleep(timeout - now);
 215 }
 216
 217 e_smx_state_t execute(double flops) {
 218   smx_activity_t s = simcall_execution_start(nullptr,flops,1.0/*priority*/,0./*bound*/);
 219   return simcall_execution_wait(s);
 220 }
 221
 222 void* recv(MailboxPtr chan) {
 223   void *res = nullptr;
 224   CommPtr c = Comm::recv_init(chan);
 225   c->setDstData(&res, sizeof(res));
 226   c->wait();
 227   return res;
 228 }
 229
 230 void* recv(MailboxPtr chan, double timeout)
 231 {
 232   void* res = nullptr;
 233   CommPtr c = Comm::recv_init(chan);
 234   c->setDstData(&res, sizeof(res));
 235   c->wait(timeout);
 236   return res;
 237 }
 238
 239 void send(MailboxPtr chan, void* payload, double simulatedSize)
 240 {
 241   CommPtr c = Comm::send_init(chan);
 242   c->setRemains(simulatedSize);
 243   c->setSrcData(payload);
 244   // c->start() is optional.
 245   c->wait();
 246 }
 247
 248 void send(MailboxPtr chan, void* payload, double simulatedSize, double timeout)
 249 {
 250   CommPtr c = Comm::send_init(chan);
 251   c->setRemains(simulatedSize);
 252   c->setSrcData(payload);
 253   // c->start() is optional.
 254   c->wait(timeout);
 255 }
 256
 257 CommPtr isend(MailboxPtr chan, void* payload, double simulatedSize)
 258 {
 259   return Comm::send_async(chan, payload, simulatedSize);
 260 }
 261
 262 CommPtr irecv(MailboxPtr chan, void** data)
 263 {
 264   return Comm::recv_async(chan, data);
 265 }
 266
 267 aid_t pid()
 268 {
 269   return SIMIX_process_self()->pid;
 270 }
 271
 272 aid_t ppid()
 273 {
 274   return SIMIX_process_self()->ppid;
 275 }
 276
 277 std::string name()
 278 {
 279   return SIMIX_process_self()->name;
 280 }
 281
 282 Host* host()
 283 {
 284   return SIMIX_process_self()->host;
 285 }
 286
 287 void suspend()
 288 {
 289   simcall_process_suspend(SIMIX_process_self());
 290 }
 291
 292 void resume()
 293 {
 294   simcall_process_resume(SIMIX_process_self());
 295 }
 296
 297 bool isSuspended()
 298 {
 299   smx_actor_t process = SIMIX_process_self();
 300   return simgrid::simix::kernelImmediate([process] { return process->suspended; });
 301 }
 302
 303 void kill()
 304 {
 305   simcall_process_kill(SIMIX_process_self());
 306 }
 307
 308 void onExit(int_f_pvoid_pvoid_t fun, void* data)
 309 {
 310   simcall_process_on_exit(SIMIX_process_self(), fun, data);
 311 }
 312
 313 void migrate(Host* new_host)
 314 {
 315   smx_actor_t process = SIMIX_process_self();
 316   simgrid::simix::kernelImmediate([process, new_host] { process->new_host = new_host; });
 317 }
 318 }
 319 }
 320 }