src/simix/ActorImpl.hpp

   1 /* Copyright (c) 2007-2016. 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 #ifndef SIMIX_ACTORIMPL_H
   7 #define SIMIX_ACTORIMPL_H
   8
   9 #include "simgrid/s4u/Actor.hpp"
  10 #include "src/simix/popping_private.h"
  11 #include "xbt/swag.h"
  12 #include<list>
  13
  14 typedef struct s_smx_process_exit_fun {
  15   int_f_pvoid_pvoid_t fun;
  16   void *arg;
  17 } s_smx_process_exit_fun_t, *smx_process_exit_fun_t;
  18
  19 namespace simgrid {
  20 namespace simix {
  21
  22 class ProcessArg {
  23 public:
  24   std::string name;
  25   std::function<void()> code;
  26   void *data            = nullptr;
  27   sg_host_t host        = nullptr;
  28   double kill_time      = 0.0;
  29   xbt_dict_t properties = nullptr;
  30   bool auto_restart     = false;
  31 };
  32
  33 class ActorImpl {
  34 public:
  35   ActorImpl() : piface_(this) {}
  36   ~ActorImpl();
  37
  38   // TODO, replace with boost intrusive container hooks
  39   s_xbt_swag_hookup_t process_hookup   = { nullptr, nullptr }; /* simix_global->process_list */
  40   s_xbt_swag_hookup_t synchro_hookup   = { nullptr, nullptr }; /* {mutex,cond,sem}->sleeping */
  41   s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
  42   s_xbt_swag_hookup_t destroy_hookup   = { nullptr, nullptr }; /* simix_global->process_to_destroy */
  43
  44   aid_t pid  = 0;
  45   aid_t ppid = -1;
  46   simgrid::xbt::string name;
  47   const char* cname() { return name.c_str(); }
  48   s4u::Host* host       = nullptr; /* the host on which the process is running */
  49   smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
  50
  51   // TODO, pack them
  52   std::exception_ptr exception;
  53   bool finished     = false;
  54   bool blocked      = false;
  55   bool suspended    = false;
  56   bool auto_restart = false;
  57
  58   sg_host_t new_host            = nullptr; /* if not null, the host on which the process must migrate to */
  59   smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
  60   std::list<smx_activity_t> comms;          /* the current non-blocking communication synchros */
  61   xbt_dict_t properties         = nullptr;
  62   s_smx_simcall_t simcall;
  63   void *data          = nullptr; /* kept for compatibility, it should be replaced with moddata */
  64   std::vector<s_smx_process_exit_fun_t> on_exit; /* list of functions executed when the process dies */
  65
  66   std::function<void()> code;
  67   smx_timer_t kill_timer = nullptr;
  68   int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
  69
  70   /* Refcounting */
  71 private:
  72   std::atomic_int_fast32_t refcount_{1};
  73 public:
  74   friend void intrusive_ptr_add_ref(ActorImpl* process)
  75   {
  76     process->refcount_.fetch_add(1, std::memory_order_relaxed);
  77   }
  78   friend void intrusive_ptr_release(ActorImpl* process)
  79   {
  80     // inspired from http://www.boost.org/doc/libs/1_55_0/doc/html/atomic/usage_examples.html
  81     if (process->refcount_.fetch_sub(1, std::memory_order_release) == 1) {
  82       // Make sure that any changes done on other threads before their acquire are commited before our delete
  83       // http://stackoverflow.com/questions/27751025/why-is-an-acquire-barrier-needed-before-deleting-the-data-in-an-atomically-refer
  84       std::atomic_thread_fence(std::memory_order_acquire);
  85       delete process;
  86     }
  87   }
  88
  89   /* S4U/implem interfaces */
  90 private:
  91   simgrid::s4u::Actor piface_; // Our interface is part of ourselves
  92 public:
  93   simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
  94   simgrid::s4u::Actor* ciface() { return &piface_; }
  95
  96   /* Daemon actors are automatically killed when the last non-daemon leaves */
  97 private:
  98   bool daemon = false;
  99 public:
 100   void daemonize();
 101   bool isDaemon();
 102 };
 103
 104 }
 105 }
 106
 107 typedef simgrid::simix::ProcessArg *smx_process_arg_t;
 108
 109 typedef simgrid::simix::ActorImpl* smx_actor_t;
 110
 111 SG_BEGIN_DECL()
 112
 113 XBT_PRIVATE smx_actor_t SIMIX_process_create(
 114                           const char *name,
 115                           std::function<void()> code,
 116                           void *data,
 117                           sg_host_t host,
 118                           xbt_dict_t properties,
 119                           smx_actor_t parent_process);
 120
 121 XBT_PRIVATE void SIMIX_process_runall();
 122 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
 123 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
 124 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
 125 XBT_PRIVATE void SIMIX_process_empty_trash();
 126 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
 127 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
 128 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
 129 XBT_PRIVATE smx_activity_t SIMIX_process_suspend(smx_actor_t process, smx_actor_t issuer);
 130 XBT_PRIVATE void SIMIX_process_resume(smx_actor_t process);
 131 XBT_PRIVATE int SIMIX_process_get_PID(smx_actor_t self);
 132 XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
 133 XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
 134 XBT_PRIVATE int SIMIX_process_is_suspended(smx_actor_t process);
 135 XBT_PRIVATE xbt_dict_t SIMIX_process_get_properties(smx_actor_t process);
 136 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);
 137 XBT_PRIVATE smx_activity_t SIMIX_process_sleep(smx_actor_t process, double duration);
 138
 139 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
 140 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
 141 XBT_PRIVATE smx_actor_t SIMIX_process_restart(smx_actor_t process, smx_actor_t issuer);
 142
 143 void SIMIX_segment_index_set(smx_actor_t process, int segment_index);
 144 extern void (*SMPI_switch_data_segment)(int dest);
 145
 146 SG_END_DECL()
 147
 148 #endif