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 process = SIMIX_process_from_PID(pid);
 172   if(process != nullptr) {
 173     simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
 174   } else {
 175     std::ostringstream oss;
 176     oss << "kill: ("<< pid <<") - No such process" << std::endl;
 177     throw std::runtime_error(oss.str());
 178   }
 179 }
 180
 181 smx_actor_t Actor::getImpl() {
 182   return pimpl_;
 183 }
 184
 185 void Actor::kill() {
 186   smx_actor_t process = SIMIX_process_self();
 187   simgrid::simix::kernelImmediate(
 188       [this, process] { SIMIX_process_kill(pimpl_, (pimpl_ == simix_global->maestro_process) ? pimpl_ : process); });
 189 }
 190
 191 // ***** Static functions *****
 192
 193 ActorPtr Actor::byPid(aid_t pid)
 194 {
 195   smx_actor_t process = SIMIX_process_from_PID(pid);
 196   if (process != nullptr)
 197     return process->iface();
 198   else
 199     return ActorPtr();
 200 }
 201
 202 void Actor::killAll()
 203 {
 204   simcall_process_killall(1);
 205 }
 206
 207 void Actor::killAll(int resetPid)
 208 {
 209   simcall_process_killall(resetPid);
 210 }
 211
 212 std::map<std::string, std::string>* Actor::getProperties()
 213 {
 214   return simgrid::simix::kernelImmediate([this] { return this->pimpl_->getProperties(); });
 215 }
 216
 217 /** Retrieve the property value (or nullptr if not set) */
 218 const char* Actor::getProperty(const char* key)
 219 {
 220   return simgrid::simix::kernelImmediate([this, key] { return pimpl_->getProperty(key); });
 221 }
 222
 223 void Actor::setProperty(const char* key, const char* value)
 224 {
 225   simgrid::simix::kernelImmediate([this, key, value] { pimpl_->setProperty(key, value); });
 226 }
 227
 228 Actor* Actor::restart()
 229 {
 230   return simgrid::simix::kernelImmediate([this]() { return pimpl_->restart(); });
 231 }
 232
 233 // ***** this_actor *****
 234
 235 namespace this_actor {
 236
 237 /** Returns true if run from the kernel mode, and false if run from a real actor
 238  *
 239  * Everything that is run out of any actor (simulation setup before the engine is run,
 240  * computing the model evolutions as a result to the actors' action, etc) is run in
 241  * kernel mode, just as in any operating systems.
 242  *
 243  * In SimGrid, the actor in charge of doing the stuff in kernel mode is called Maestro,
 244  * because it is the one scheduling when the others should move or wait.
 245  */
 246 bool isMaestro()
 247 {
 248   smx_actor_t process = SIMIX_process_self();
 249   return process == nullptr || process == simix_global->maestro_process;
 250 }
 251
 252 void sleep_for(double duration)
 253 {
 254   if (duration > 0)
 255     simcall_process_sleep(duration);
 256 }
 257
 258 void yield()
 259 {
 260   simgrid::simix::kernelImmediate([] { /* do nothing*/ });
 261 }
 262
 263 XBT_PUBLIC(void) sleep_until(double timeout)
 264 {
 265   double now = SIMIX_get_clock();
 266   if (timeout > now)
 267     simcall_process_sleep(timeout - now);
 268 }
 269
 270 void execute(double flops)
 271 {
 272   smx_activity_t s = simcall_execution_start(nullptr, flops, 1.0 /*priority*/, 0. /*bound*/, getHost());
 273   simcall_execution_wait(s);
 274 }
 275
 276 void execute(double flops, double priority)
 277 {
 278   smx_activity_t s = simcall_execution_start(nullptr, flops, 1 / priority /*priority*/, 0. /*bound*/, getHost());
 279   simcall_execution_wait(s);
 280 }
 281
 282 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount, double timeout)
 283 {
 284   smx_activity_t s =
 285       simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, timeout);
 286   simcall_execution_wait(s);
 287 }
 288
 289 void parallel_execute(int host_nb, sg_host_t* host_list, double* flops_amount, double* bytes_amount)
 290 {
 291   smx_activity_t s = simcall_execution_parallel_start(nullptr, host_nb, host_list, flops_amount, bytes_amount, -1, -1);
 292   simcall_execution_wait(s);
 293 }
 294
 295 ExecPtr exec_init(double flops_amount)
 296 {
 297   ExecPtr res        = ExecPtr(new Exec());
 298   res->host_         = getHost();
 299   res->flops_amount_ = flops_amount;
 300   res->setRemains(flops_amount);
 301   return res;
 302 }
 303
 304 ExecPtr exec_async(double flops)
 305 {
 306   ExecPtr res = exec_init(flops);
 307   res->start();
 308   return res;
 309 }
 310
 311 void* recv(MailboxPtr chan) // deprecated
 312 {
 313   return chan->get();
 314 }
 315
 316 void* recv(MailboxPtr chan, double timeout) // deprecated
 317 {
 318   return chan->get(timeout);
 319 }
 320
 321 void send(MailboxPtr chan, void* payload, double simulatedSize) // deprecated
 322 {
 323   chan->put(payload, simulatedSize);
 324 }
 325
 326 void send(MailboxPtr chan, void* payload, double simulatedSize, double timeout) // deprecated
 327 {
 328   chan->put(payload, simulatedSize, timeout);
 329 }
 330
 331 CommPtr isend(MailboxPtr chan, void* payload, double simulatedSize) // deprecated
 332 {
 333   return chan->put_async(payload, simulatedSize);
 334 }
 335
 336 CommPtr irecv(MailboxPtr chan, void** data) // deprecated
 337 {
 338   return chan->get_async(data);
 339 }
 340
 341 aid_t getPid()
 342 {
 343   return SIMIX_process_self()->pid;
 344 }
 345
 346 aid_t getPpid()
 347 {
 348   return SIMIX_process_self()->ppid;
 349 }
 350
 351 std::string getName()
 352 {
 353   return SIMIX_process_self()->getName();
 354 }
 355
 356 const char* getCname()
 357 {
 358   return SIMIX_process_self()->getCname();
 359 }
 360
 361 Host* getHost()
 362 {
 363   return SIMIX_process_self()->host;
 364 }
 365
 366 void suspend()
 367 {
 368   if (TRACE_actor_is_enabled())
 369     instr::Container::byName(getName() + "-" + std::to_string(getPid()))
 370         ->getState("MSG_PROCESS_STATE")
 371         ->pushEvent("suspend");
 372   simcall_process_suspend(SIMIX_process_self());
 373 }
 374
 375 void resume()
 376 {
 377   smx_actor_t process = SIMIX_process_self();
 378   simgrid::simix::kernelImmediate([process] { process->resume(); });
 379
 380   if (TRACE_actor_is_enabled())
 381     instr::Container::byName(getName() + "-" + std::to_string(getPid()))->getState("MSG_PROCESS_STATE")->popEvent();
 382 }
 383
 384 bool isSuspended()
 385 {
 386   smx_actor_t process = SIMIX_process_self();
 387   return simgrid::simix::kernelImmediate([process] { return process->suspended; });
 388 }
 389
 390 void kill()
 391 {
 392   smx_actor_t process = SIMIX_process_self();
 393   simgrid::simix::kernelImmediate([process] { SIMIX_process_kill(process, process); });
 394 }
 395
 396 void onExit(int_f_pvoid_pvoid_t fun, void* data)
 397 {
 398   simcall_process_on_exit(SIMIX_process_self(), fun, data);
 399 }
 400
 401 /** @brief Moves the current actor to another host
 402  *
 403  * @see simgrid::s4u::Actor::migrate() for more information
 404  */
 405 void migrate(Host* new_host)
 406 {
 407   SIMIX_process_self()->iface()->migrate(new_host);
 408 }
 409 }
 410 }
 411 }