src/kernel/actor/ActorImpl.cpp

   1 /* Copyright (c) 2007-2019. 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 "mc/mc.h"
   7 #include "simgrid/Exception.hpp"
   8 #include "simgrid/s4u/Actor.hpp"
   9 #include "simgrid/s4u/Exec.hpp"
  10 #include "src/kernel/activity/CommImpl.hpp"
  11 #include "src/kernel/activity/ExecImpl.hpp"
  12 #include "src/kernel/activity/IoImpl.hpp"
  13 #include "src/kernel/activity/SleepImpl.hpp"
  14 #include "src/kernel/activity/SynchroRaw.hpp"
  15 #include "src/mc/mc_replay.hpp"
  16 #include "src/mc/remote/Client.hpp"
  17 #include "src/simix/smx_private.hpp"
  18 #include "src/surf/HostImpl.hpp"
  19 #include "src/surf/cpu_interface.hpp"
  20
  21 #include <boost/range/algorithm.hpp>
  22
  23 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix, "Logging specific to SIMIX (process)");
  24
  25 static unsigned long simix_process_maxpid = 0;
  26
  27 /**
  28  * @brief Returns the current agent.
  29  *
  30  * This functions returns the currently running SIMIX process.
  31  *
  32  * @return The SIMIX process
  33  */
  34 smx_actor_t SIMIX_process_self()
  35 {
  36   smx_context_t self_context = simgrid::kernel::context::Context::self();
  37
  38   return (self_context != nullptr) ? self_context->get_actor() : nullptr;
  39 }
  40
  41 /**
  42  * @brief Returns whether a process has pending asynchronous communications.
  43  * @return true if there are asynchronous communications in this process
  44  * @deprecated
  45  */
  46 int SIMIX_process_has_pending_comms(smx_actor_t process)
  47 {
  48
  49   return process->comms.size() > 0;
  50 }
  51
  52 namespace simgrid {
  53 namespace kernel {
  54 namespace actor {
  55
  56 ActorImpl::ActorImpl(const simgrid::xbt::string& name, s4u::Host* host) : host_(host), name_(name), piface_(this)
  57 {
  58   pid_           = simix_process_maxpid++;
  59   simcall.issuer = this;
  60 }
  61
  62 ActorImpl::~ActorImpl() = default;
  63
  64 /* Become an actor in the simulation
  65  *
  66  * Currently this can only be called by the main thread (once) and only work with some thread factories
  67  * (currently ThreadContextFactory).
  68  *
  69  * In the future, it might be extended in order to attach other threads created by a third party library.
  70  */
  71
  72 ActorImplPtr ActorImpl::attach(const std::string& name, void* data, s4u::Host* host,
  73                                std::unordered_map<std::string, std::string>* properties)
  74 {
  75   // This is mostly a copy/paste from create(), it'd be nice to share some code between those two functions.
  76
  77   XBT_DEBUG("Attach process %s on host '%s'", name.c_str(), host->get_cname());
  78
  79   if (not host->is_on()) {
  80     XBT_WARN("Cannot launch process '%s' on failed host '%s'", name.c_str(), host->get_cname());
  81     std::rethrow_exception(
  82         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot attach actor on failed host.")));
  83   }
  84
  85   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
  86   /* Actor data */
  87   actor->set_user_data(data);
  88   actor->code = nullptr;
  89
  90   XBT_VERB("Create context %s", actor->get_cname());
  91   xbt_assert(simix_global != nullptr, "simix is not initialized, please call MSG_init first");
  92   actor->context_.reset(simix_global->context_factory->attach(actor));
  93
  94   /* Add properties */
  95   if (properties != nullptr)
  96     for (auto const& kv : *properties)
  97       actor->set_property(kv.first, kv.second);
  98
  99   /* Add the process to it's host process list */
 100   host->pimpl_->process_list_.push_back(*actor);
 101
 102   /* Now insert it in the global process list and in the process to run list */
 103   simix_global->process_list[actor->get_pid()] = actor;
 104   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", actor, actor->get_cname(), host->get_cname());
 105   simix_global->actors_to_run.push_back(actor);
 106   intrusive_ptr_add_ref(actor);
 107
 108   auto* context = dynamic_cast<simgrid::kernel::context::AttachContext*>(actor->context_.get());
 109   xbt_assert(nullptr != context, "Not a suitable context");
 110   context->attach_start();
 111
 112   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 113   simgrid::s4u::ActorPtr tmp = actor->iface(); // Passing this directly to on_creation will lead to crashes
 114   simgrid::s4u::Actor::on_creation(tmp);
 115
 116   return ActorImplPtr(actor);
 117 }
 118 /** @brief Detach an actor attached with `attach()`
 119  *
 120  *  This is called when the current actor has finished its job.
 121  *  Used in the main thread, it waits for the simulation to finish before returning. When it returns, the other
 122  *  simulated actors and the maestro are destroyed.
 123  */
 124 void ActorImpl::detach()
 125 {
 126   auto* context = dynamic_cast<context::AttachContext*>(context::Context::self());
 127   if (context == nullptr)
 128     xbt_die("Not a suitable context");
 129
 130   context->get_actor()->cleanup();
 131   context->attach_stop();
 132 }
 133
 134 void ActorImpl::cleanup()
 135 {
 136   if (this == simix_global->maestro_process) /* Do not cleanup maestro */
 137     return;
 138
 139   XBT_DEBUG("Cleanup actor %s (%p), waiting synchro %p", get_cname(), this, waiting_synchro.get());
 140
 141   simix_global->mutex.lock();
 142
 143   simix_global->process_list.erase(pid_);
 144   if (host_ && host_process_list_hook.is_linked())
 145     simgrid::xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
 146   if (not smx_destroy_list_hook.is_linked()) {
 147 #if SIMGRID_HAVE_MC
 148     xbt_dynar_push_as(simix_global->dead_actors_vector, ActorImpl*, this);
 149 #endif
 150     simix_global->actors_to_destroy.push_back(*this);
 151   }
 152   context_->iwannadie = false;
 153
 154   simix_global->mutex.unlock();
 155 }
 156
 157 void ActorImpl::exit()
 158 {
 159   context_->iwannadie = true;
 160   blocked_            = false;
 161   suspended_          = false;
 162   exception_          = nullptr;
 163
 164   // Forcefully kill the actor if its host is turned off. Not a HostFailureException because you should not survive that
 165   if (not host_->is_on())
 166     this->throw_exception(std::make_exception_ptr(ForcefulKillException("host failed")));
 167
 168   /* destroy the blocking synchro if any */
 169   if (waiting_synchro != nullptr) {
 170
 171     activity::ExecImplPtr exec   = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
 172     activity::CommImplPtr comm   = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
 173     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
 174     activity::RawImplPtr raw     = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
 175     activity::IoImplPtr io       = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
 176
 177     if (exec != nullptr && exec->surf_action_) {
 178       exec->cancel();
 179       exec->surf_action_->unref();
 180       exec->surf_action_ = nullptr;
 181     } else if (comm != nullptr) {
 182       comms.remove(waiting_synchro);
 183       comm->cancel();
 184       // Remove first occurrence of &actor->simcall:
 185       auto i = boost::range::find(waiting_synchro->simcalls_, &simcall);
 186       if (i != waiting_synchro->simcalls_.end())
 187         waiting_synchro->simcalls_.remove(&simcall);
 188     } else if (sleep != nullptr) {
 189       if (sleep->surf_action_)
 190         sleep->surf_action_->cancel();
 191       sleep->post();
 192     } else if (raw != nullptr) {
 193       raw->finish();
 194     } else if (io != nullptr) {
 195       io->cancel();
 196     } else {
 197       simgrid::kernel::activity::ActivityImplPtr activity = waiting_synchro;
 198       xbt_die("Activity %s is of unknown type %s", activity->get_cname(),
 199               simgrid::xbt::demangle(typeid(activity).name()).get());
 200     }
 201
 202     waiting_synchro = nullptr;
 203   }
 204 }
 205
 206 void ActorImpl::kill(ActorImpl* actor)
 207 {
 208   if (actor->finished_) {
 209     XBT_DEBUG("Ignoring request to kill actor %s@%s that is already dead", actor->get_cname(),
 210               actor->host_->get_cname());
 211     return;
 212   }
 213
 214   XBT_DEBUG("Actor '%s'@%s is killing actor '%s'@%s", get_cname(), host_ ? host_->get_cname() : "", actor->get_cname(),
 215             actor->host_ ? actor->host_->get_cname() : "");
 216
 217   actor->exit();
 218
 219   if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
 220           end(simix_global->actors_to_run) &&
 221       actor != this) {
 222     XBT_DEBUG("Inserting %s in the to_run list", actor->get_cname());
 223     simix_global->actors_to_run.push_back(actor);
 224   }
 225 }
 226
 227 void ActorImpl::kill_all()
 228 {
 229   for (auto const& kv : simix_global->process_list)
 230     if (kv.second != this)
 231       this->kill(kv.second);
 232 }
 233
 234 void ActorImpl::set_kill_time(double kill_time)
 235 {
 236   if (kill_time <= SIMIX_get_clock())
 237     return;
 238   XBT_DEBUG("Set kill time %f for actor %s@%s", kill_time, get_cname(), host_->get_cname());
 239   kill_timer = simix::Timer::set(kill_time, [this] {
 240     this->exit();
 241     kill_timer = nullptr;
 242   });
 243 }
 244
 245 double ActorImpl::get_kill_time()
 246 {
 247   return kill_timer ? kill_timer->get_date() : 0;
 248 }
 249
 250 static void dying_daemon(int /*exit_status*/, void* data)
 251 {
 252   std::vector<ActorImpl*>* vect = &simix_global->daemons;
 253
 254   auto it = std::find(vect->begin(), vect->end(), static_cast<ActorImpl*>(data));
 255   xbt_assert(it != vect->end(), "The dying daemon is not a daemon after all. Please report that bug.");
 256
 257   /* Don't move the whole content since we don't really care about the order */
 258   std::swap(*it, vect->back());
 259   vect->pop_back();
 260 }
 261
 262 void ActorImpl::yield()
 263 {
 264   XBT_DEBUG("Yield actor '%s'", get_cname());
 265
 266   /* Go into sleep and return control to maestro */
 267   context_->suspend();
 268
 269   /* Ok, maestro returned control to us */
 270   XBT_DEBUG("Control returned to me: '%s'", get_cname());
 271
 272   if (context_->iwannadie) {
 273
 274     XBT_DEBUG("Actor %s@%s is dead", get_cname(), host_->get_cname());
 275     // throw simgrid::kernel::context::ForcefulKillException(); Does not seem to properly kill the actor
 276     context_->stop();
 277     THROW_IMPOSSIBLE;
 278   }
 279
 280   if (suspended_) {
 281     XBT_DEBUG("Hey! I'm suspended.");
 282
 283     xbt_assert(exception_ == nullptr, "Gasp! This exception may be lost by subsequent calls.");
 284     suspended_ = false;
 285     suspend(this);
 286   }
 287
 288   if (exception_ != nullptr) {
 289     XBT_DEBUG("Wait, maestro left me an exception");
 290     std::exception_ptr exception = std::move(exception_);
 291     exception_                   = nullptr;
 292     std::rethrow_exception(std::move(exception));
 293   }
 294
 295   if (SMPI_switch_data_segment && not finished_) {
 296     SMPI_switch_data_segment(iface());
 297   }
 298 }
 299
 300 /** This actor will be terminated automatically when the last non-daemon actor finishes */
 301 void ActorImpl::daemonize()
 302 {
 303   if (not daemon_) {
 304     daemon_ = true;
 305     simix_global->daemons.push_back(this);
 306     SIMIX_process_on_exit(this, dying_daemon, this);
 307   }
 308 }
 309
 310 s4u::Actor* ActorImpl::restart()
 311 {
 312   XBT_DEBUG("Restarting actor %s on %s", get_cname(), host_->get_cname());
 313
 314   // retrieve the arguments of the old actor
 315   ProcessArg arg = ProcessArg(host_, this);
 316
 317   // kill the old actor
 318   (this == simix_global->maestro_process) ? this->exit() : SIMIX_process_self()->kill(this);
 319
 320   // start the new actor
 321   ActorImplPtr actor =
 322       ActorImpl::create(arg.name, std::move(arg.code), arg.data, arg.host, arg.properties.get(), nullptr);
 323   actor->set_kill_time(arg.kill_time);
 324   actor->set_auto_restart(arg.auto_restart);
 325
 326   return actor->ciface();
 327 }
 328
 329 activity::ActivityImplPtr ActorImpl::suspend(ActorImpl* issuer)
 330 {
 331   if (suspended_) {
 332     XBT_DEBUG("Actor '%s' is already suspended", get_cname());
 333     return nullptr;
 334   }
 335
 336   suspended_ = true;
 337
 338   /* If we are suspending another actor that is waiting on a sync, suspend its synchronization. */
 339   if (this != issuer) {
 340     if (waiting_synchro)
 341       waiting_synchro->suspend();
 342     /* If the other actor is not waiting, its suspension is delayed to when the actor is rescheduled. */
 343
 344     return nullptr;
 345   } else {
 346     return activity::ExecImplPtr(new activity::ExecImpl("suspend", ""))->set_host(host_)->start(0.0, 1.0, 0.0);
 347   }
 348 }
 349
 350 void ActorImpl::resume()
 351 {
 352   XBT_IN("actor = %p", this);
 353
 354   if (context_->iwannadie) {
 355     XBT_VERB("Ignoring request to suspend an actor that is currently dying.");
 356     return;
 357   }
 358
 359   if (not suspended_)
 360     return;
 361   suspended_ = false;
 362
 363   /* resume the synchronization that was blocking the resumed actor. */
 364   if (waiting_synchro)
 365     waiting_synchro->resume();
 366
 367   XBT_OUT();
 368 }
 369
 370 activity::ActivityImplPtr ActorImpl::join(ActorImpl* actor, double timeout)
 371 {
 372   activity::ActivityImplPtr res = this->sleep(timeout);
 373   intrusive_ptr_add_ref(res.get());
 374   SIMIX_process_on_exit(actor,
 375                         [](int, void* arg) {
 376                           auto sleep = static_cast<activity::SleepImpl*>(arg);
 377                           if (sleep->surf_action_)
 378                             sleep->surf_action_->finish(resource::Action::State::FINISHED);
 379                           intrusive_ptr_release(sleep);
 380                         },
 381                         res.get());
 382   return res;
 383 }
 384
 385 activity::ActivityImplPtr ActorImpl::sleep(double duration)
 386 {
 387   if (not host_->is_on())
 388     throw_exception(std::make_exception_ptr(simgrid::HostFailureException(
 389         XBT_THROW_POINT, std::string("Host ") + host_->get_cname() + " failed, you cannot sleep there.")));
 390
 391   return activity::SleepImplPtr(new activity::SleepImpl("sleep", host_))->start(duration);
 392 }
 393
 394 void ActorImpl::throw_exception(std::exception_ptr e)
 395 {
 396   exception_ = e;
 397
 398   if (suspended_)
 399     resume();
 400
 401   /* cancel the blocking synchro if any */
 402   if (waiting_synchro) {
 403
 404     activity::ExecImplPtr exec = boost::dynamic_pointer_cast<activity::ExecImpl>(waiting_synchro);
 405     if (exec != nullptr)
 406       exec->cancel();
 407
 408     activity::CommImplPtr comm = boost::dynamic_pointer_cast<activity::CommImpl>(waiting_synchro);
 409     if (comm != nullptr) {
 410       comms.remove(comm);
 411       comm->cancel();
 412     }
 413
 414     activity::SleepImplPtr sleep = boost::dynamic_pointer_cast<activity::SleepImpl>(waiting_synchro);
 415     if (sleep != nullptr) {
 416       SIMIX_process_sleep_destroy(waiting_synchro);
 417       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), this) ==
 418               end(simix_global->actors_to_run) &&
 419           this != SIMIX_process_self()) {
 420         XBT_DEBUG("Inserting [%p] %s in the to_run list", this, get_cname());
 421         simix_global->actors_to_run.push_back(this);
 422       }
 423     }
 424
 425     activity::RawImplPtr raw = boost::dynamic_pointer_cast<activity::RawImpl>(waiting_synchro);
 426     if (raw != nullptr) {
 427       raw->finish();
 428     }
 429
 430     activity::IoImplPtr io = boost::dynamic_pointer_cast<activity::IoImpl>(waiting_synchro);
 431     if (io != nullptr) {
 432       io->cancel();
 433     }
 434   }
 435   waiting_synchro = nullptr;
 436 }
 437
 438 void ActorImpl::set_host(s4u::Host* dest)
 439 {
 440   xbt::intrusive_erase(host_->pimpl_->process_list_, *this);
 441   host_ = dest;
 442   dest->pimpl_->process_list_.push_back(*this);
 443 }
 444
 445 ActorImplPtr ActorImpl::init(const std::string& name, s4u::Host* host)
 446 {
 447   ActorImpl* actor = new ActorImpl(xbt::string(name), host);
 448   actor->set_ppid(this->pid_);
 449
 450   intrusive_ptr_add_ref(actor);
 451   /* The on_creation() signal must be delayed until there, where the pid and everything is set */
 452   s4u::Actor::on_creation(actor->iface());
 453
 454   return ActorImplPtr(actor);
 455 }
 456
 457 ActorImpl* ActorImpl::start(const simix::ActorCode& code)
 458 {
 459   xbt_assert(code && host_ != nullptr, "Invalid parameters");
 460
 461   if (not host_->is_on()) {
 462     XBT_WARN("Cannot launch actor '%s' on failed host '%s'", name_.c_str(), host_->get_cname());
 463     intrusive_ptr_release(this);
 464     std::rethrow_exception(
 465         std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Cannot start actor on failed host.")));
 466   }
 467
 468   this->code = code;
 469   XBT_VERB("Create context %s", get_cname());
 470   context_.reset(simix_global->context_factory->create_context(simix::ActorCode(code), this));
 471
 472   XBT_DEBUG("Start context '%s'", get_cname());
 473
 474   /* Add the actor to its host's actor list */
 475   host_->pimpl_->process_list_.push_back(*this);
 476   simix_global->process_list[pid_] = this;
 477
 478   /* Now insert it in the global actor list and in the actor to run list */
 479   XBT_DEBUG("Inserting [%p] %s(%s) in the to_run list", this, get_cname(), host_->get_cname());
 480   simix_global->actors_to_run.push_back(this);
 481
 482   return this;
 483 }
 484
 485 ActorImplPtr ActorImpl::create(const std::string& name, const simix::ActorCode& code, void* data, s4u::Host* host,
 486                                std::unordered_map<std::string, std::string>* properties, ActorImpl* parent_actor)
 487 {
 488   XBT_DEBUG("Start actor %s@'%s'", name.c_str(), host->get_cname());
 489
 490   ActorImplPtr actor;
 491   if (parent_actor != nullptr)
 492     actor = parent_actor->init(xbt::string(name), host);
 493   else
 494     actor = SIMIX_process_self()->init(xbt::string(name), host);
 495
 496   /* actor data */
 497   actor->set_user_data(data);
 498
 499   /* Add properties */
 500   if (properties != nullptr)
 501     for (auto const& kv : *properties)
 502       actor->set_property(kv.first, kv.second);
 503
 504   actor->start(code);
 505
 506   return actor;
 507 }
 508
 509 void create_maestro(const std::function<void()>& code)
 510 {
 511   /* Create maestro actor and initialize it */
 512   ActorImpl* maestro = new ActorImpl(xbt::string(""), /*host*/ nullptr);
 513
 514   if (not code) {
 515     maestro->context_.reset(simix_global->context_factory->create_context(simix::ActorCode(), maestro));
 516   } else {
 517     maestro->context_.reset(simix_global->context_factory->create_maestro(simix::ActorCode(code), maestro));
 518   }
 519
 520   maestro->simcall.issuer       = maestro;
 521   simix_global->maestro_process = maestro;
 522 }
 523
 524 } // namespace actor
 525 } // namespace kernel
 526 } // namespace simgrid
 527
 528 void SIMIX_process_detach()
 529 {
 530   simgrid::kernel::actor::ActorImpl::detach();
 531 }
 532
 533 smx_actor_t SIMIX_process_attach(const char* name, void* data, const char* hostname,
 534                                  std::unordered_map<std::string, std::string>* properties,
 535                                  smx_actor_t /*parent_process*/)
 536 {
 537   return simgrid::kernel::actor::ActorImpl::attach(name, data, sg_host_by_name(hostname), properties).get();
 538 }
 539
 540 /** @deprecated When this function gets removed, also remove the xbt_ex class, that is only there to help users to
 541  * transition */
 542 void SIMIX_process_throw(smx_actor_t actor, xbt_errcat_t cat, int value, const char* msg)
 543 {
 544   SMX_EXCEPTION(actor, cat, value, msg);
 545
 546   if (actor->is_suspended())
 547     actor->resume();
 548
 549   /* cancel the blocking synchro if any */
 550   if (actor->waiting_synchro) {
 551
 552     simgrid::kernel::activity::ExecImplPtr exec =
 553         boost::dynamic_pointer_cast<simgrid::kernel::activity::ExecImpl>(actor->waiting_synchro);
 554     if (exec != nullptr)
 555       exec->cancel();
 556
 557     simgrid::kernel::activity::CommImplPtr comm =
 558         boost::dynamic_pointer_cast<simgrid::kernel::activity::CommImpl>(actor->waiting_synchro);
 559     if (comm != nullptr) {
 560       actor->comms.remove(comm);
 561       comm->cancel();
 562     }
 563
 564     simgrid::kernel::activity::SleepImplPtr sleep =
 565         boost::dynamic_pointer_cast<simgrid::kernel::activity::SleepImpl>(actor->waiting_synchro);
 566     if (sleep != nullptr) {
 567       SIMIX_process_sleep_destroy(actor->waiting_synchro);
 568       if (std::find(begin(simix_global->actors_to_run), end(simix_global->actors_to_run), actor) ==
 569               end(simix_global->actors_to_run) &&
 570           actor != SIMIX_process_self()) {
 571         XBT_DEBUG("Inserting [%p] %s in the to_run list", actor, actor->get_cname());
 572         simix_global->actors_to_run.push_back(actor);
 573       }
 574     }
 575
 576     simgrid::kernel::activity::RawImplPtr raw =
 577         boost::dynamic_pointer_cast<simgrid::kernel::activity::RawImpl>(actor->waiting_synchro);
 578     if (raw != nullptr) {
 579       raw->finish();
 580     }
 581
 582     simgrid::kernel::activity::IoImplPtr io =
 583         boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(actor->waiting_synchro);
 584     if (io != nullptr) {
 585       io->cancel();
 586     }
 587   }
 588   actor->waiting_synchro = nullptr;
 589 }
 590
 591 void simcall_HANDLER_process_suspend(smx_simcall_t simcall, smx_actor_t actor)
 592 {
 593   smx_activity_t sync_suspend = actor->suspend(simcall->issuer);
 594
 595   if (actor != simcall->issuer) {
 596     SIMIX_simcall_answer(simcall);
 597   } else {
 598     sync_suspend->simcalls_.push_back(simcall);
 599     actor->waiting_synchro = sync_suspend;
 600     actor->waiting_synchro->suspend();
 601   }
 602   /* If we are suspending ourselves, then just do not finish the simcall now */
 603 }
 604
 605 int SIMIX_process_get_maxpid()
 606 {
 607   return simix_process_maxpid;
 608 }
 609
 610 int SIMIX_process_count()
 611 {
 612   return simix_global->process_list.size();
 613 }
 614
 615 void* SIMIX_process_self_get_data() // deprecated
 616 {
 617   smx_actor_t self = SIMIX_process_self();
 618
 619   if (self == nullptr) {
 620     return nullptr;
 621   }
 622   return self->get_user_data();
 623 }
 624
 625 void SIMIX_process_self_set_data(void* data) // deprecated
 626 {
 627   SIMIX_process_self()->set_user_data(data);
 628 }
 629
 630 /* needs to be public and without simcall because it is called
 631    by exceptions and logging events */
 632 const char* SIMIX_process_self_get_name()
 633 {
 634
 635   smx_actor_t process = SIMIX_process_self();
 636   if (process == nullptr || process == simix_global->maestro_process)
 637     return "maestro";
 638
 639   return process->get_cname();
 640 }
 641
 642 void simcall_HANDLER_process_join(smx_simcall_t simcall, smx_actor_t process, double timeout)
 643 {
 644   if (process->finished_) {
 645     // The joined process is already finished, just wake up the issuer process right away
 646     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 647     SIMIX_simcall_answer(simcall);
 648     return;
 649   }
 650   smx_activity_t sync = simcall->issuer->join(process, timeout);
 651   sync->simcalls_.push_back(simcall);
 652   simcall->issuer->waiting_synchro = sync;
 653 }
 654
 655 void simcall_HANDLER_process_sleep(smx_simcall_t simcall, double duration)
 656 {
 657   if (MC_is_active() || MC_record_replay_is_active()) {
 658     MC_process_clock_add(simcall->issuer, duration);
 659     simcall_process_sleep__set__result(simcall, SIMIX_DONE);
 660     SIMIX_simcall_answer(simcall);
 661     return;
 662   }
 663   smx_activity_t sync = simcall->issuer->sleep(duration);
 664   sync->simcalls_.push_back(simcall);
 665   simcall->issuer->waiting_synchro = sync;
 666 }
 667
 668 void SIMIX_process_sleep_destroy(smx_activity_t synchro)
 669 {
 670   XBT_DEBUG("Destroy sleep synchro %p", synchro.get());
 671   simgrid::kernel::activity::SleepImplPtr sleep =
 672       boost::static_pointer_cast<simgrid::kernel::activity::SleepImpl>(synchro);
 673
 674   if (sleep->surf_action_) {
 675     sleep->surf_action_->unref();
 676     sleep->surf_action_ = nullptr;
 677   }
 678 }
 679
 680 /**
 681  * @brief Calling this function makes the process to yield.
 682  *
 683  * Only the current process can call this function, giving back the control to maestro.
 684  *
 685  * @param self the current process
 686  */
 687
 688 /** @brief Returns the list of processes to run.
 689  * @deprecated
 690  */
 691 const std::vector<smx_actor_t>& simgrid::simix::process_get_runnable()
 692 {
 693   return simix_global->actors_to_run;
 694 }
 695
 696 /** @brief Returns the process from PID. */
 697 smx_actor_t SIMIX_process_from_PID(aid_t PID)
 698 {
 699   auto actor = simix_global->process_list.find(PID);
 700   return actor == simix_global->process_list.end() ? nullptr : actor->second;
 701 }
 702
 703 void SIMIX_process_on_exit(smx_actor_t actor, int_f_pvoid_pvoid_t fun, void* data)
 704 {
 705   SIMIX_process_on_exit(actor, [fun](int a, void* b) { fun((void*)(intptr_t)a, b); }, data);
 706 }
 707
 708 void SIMIX_process_on_exit(smx_actor_t actor, const std::function<void(bool, void*)>& fun, void* data)
 709 {
 710   xbt_assert(actor, "current process not found: are you in maestro context ?");
 711
 712   actor->on_exit.emplace_back(s_smx_process_exit_fun_t{fun, data});
 713 }
 714
 715 /** @brief Restart a process, starting it again from the beginning. */
 716 /**
 717  * @ingroup simix_process_management
 718  * @brief Creates and runs a new SIMIX process.
 719  *
 720  * The structure and the corresponding thread are created and put in the list of ready processes.
 721  *
 722  * @param name a name for the process. It is for user-level information and can be nullptr.
 723  * @param code the main function of the process
 724  * @param data a pointer to any data one may want to attach to the new object. It is for user-level information and can
 725  * be nullptr.
 726  * It can be retrieved with the method ActorImpl::getUserData().
 727  * @param host where the new agent is executed.
 728  * @param properties the properties of the process
 729  */
 730 smx_actor_t simcall_process_create(const std::string& name, const simgrid::simix::ActorCode& code, void* data,
 731                                    sg_host_t host, std::unordered_map<std::string, std::string>* properties)
 732 {
 733   smx_actor_t self = SIMIX_process_self();
 734   return simgrid::simix::simcall([&name, &code, data, host, properties, self] {
 735     return simgrid::kernel::actor::ActorImpl::create(name, code, data, host, properties, self).get();
 736   });
 737 }
 738
 739 void simcall_process_set_data(smx_actor_t process, void* data)
 740 {
 741   simgrid::simix::simcall([process, data] { process->set_user_data(data); });
 742 }