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