Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of git+ssh://scm.gforge.inria.fr//gitroot/simgrid/simgrid
[simgrid.git] / 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
37   // TODO, replace with boost intrusive container hooks
38   s_xbt_swag_hookup_t process_hookup   = { nullptr, nullptr }; /* simix_global->process_list */
39   s_xbt_swag_hookup_t synchro_hookup   = { nullptr, nullptr }; /* {mutex,cond,sem}->sleeping */
40   s_xbt_swag_hookup_t host_proc_hookup = { nullptr, nullptr }; /* smx_host->process_lis */
41   s_xbt_swag_hookup_t destroy_hookup   = { nullptr, nullptr }; /* simix_global->process_to_destroy */
42
43   unsigned long pid  = 0;
44   unsigned long ppid = -1;
45   simgrid::xbt::string name;
46   const char* cname() { return name.c_str(); }
47   s4u::Host* host       = nullptr; /* the host on which the process is running */
48   smx_context_t context = nullptr; /* the context (uctx/raw/thread) that executes the user function */
49
50   // TODO, pack them
51   std::exception_ptr exception;
52   bool finished     = false;
53   bool blocked      = false;
54   bool suspended    = false;
55   bool auto_restart = false;
56
57   sg_host_t new_host            = nullptr; /* if not null, the host on which the process must migrate to */
58   smx_activity_t waiting_synchro = nullptr; /* the current blocking synchro if any */
59   std::list<smx_activity_t> comms               ;           /* the current non-blocking communication synchros */
60   xbt_dict_t properties         = nullptr;
61   s_smx_simcall_t simcall;
62   void *data          = nullptr; /* kept for compatibility, it should be replaced with moddata */
63   xbt_dynar_t on_exit = nullptr; /* list of functions executed when the process dies */
64
65   std::function<void()> code;
66   smx_timer_t kill_timer = nullptr;
67   int segment_index = -1; /* Reference to an SMPI process' data segment. Default value is -1 if not in SMPI context*/
68
69   friend void intrusive_ptr_add_ref(ActorImpl* process)
70   {
71     // Atomic operation! Do not split in two instructions!
72     auto previous = (process->refcount_)++;
73     xbt_assert(previous != 0);
74     (void) previous;
75   }
76   friend void intrusive_ptr_release(ActorImpl* process)
77   {
78     // Atomic operation! Do not split in two instructions!
79     auto count = --(process->refcount_);
80     if (count == 0)
81       delete process;
82   }
83
84   ~ActorImpl();
85
86   simgrid::s4u::ActorPtr iface() { return s4u::ActorPtr(&piface_); }
87
88 private:
89   std::atomic_int_fast32_t refcount_ { 1 };
90   simgrid::s4u::Actor piface_; // Our interface is part of ourselves
91 };
92
93 }
94 }
95
96 typedef simgrid::simix::ProcessArg *smx_process_arg_t;
97
98 typedef simgrid::simix::ActorImpl* smx_actor_t;
99
100 SG_BEGIN_DECL()
101
102 XBT_PRIVATE smx_actor_t SIMIX_process_create(
103                           const char *name,
104                           std::function<void()> code,
105                           void *data,
106                           sg_host_t host,
107                           xbt_dict_t properties,
108                           smx_actor_t parent_process);
109
110 XBT_PRIVATE void SIMIX_process_runall();
111 XBT_PRIVATE void SIMIX_process_kill(smx_actor_t process, smx_actor_t issuer);
112 XBT_PRIVATE void SIMIX_process_killall(smx_actor_t issuer, int reset_pid);
113 XBT_PRIVATE void SIMIX_process_cleanup(smx_actor_t arg);
114 XBT_PRIVATE void SIMIX_process_empty_trash();
115 XBT_PRIVATE void SIMIX_process_yield(smx_actor_t self);
116 XBT_PRIVATE void SIMIX_process_exception_terminate(xbt_ex_t * e);
117 XBT_PRIVATE void SIMIX_process_change_host(smx_actor_t process, sg_host_t dest);
118 XBT_PRIVATE smx_activity_t SIMIX_process_suspend(smx_actor_t process, smx_actor_t issuer);
119 XBT_PRIVATE void SIMIX_process_resume(smx_actor_t process);
120 XBT_PRIVATE int SIMIX_process_get_PID(smx_actor_t self);
121 XBT_PRIVATE void SIMIX_process_set_data(smx_actor_t process, void *data);
122 XBT_PRIVATE smx_actor_t SIMIX_process_get_by_name(const char* name);
123 XBT_PRIVATE int SIMIX_process_is_suspended(smx_actor_t process);
124 XBT_PRIVATE xbt_dict_t SIMIX_process_get_properties(smx_actor_t process);
125 XBT_PRIVATE smx_activity_t SIMIX_process_join(smx_actor_t issuer, smx_actor_t process, double timeout);
126 XBT_PRIVATE smx_activity_t SIMIX_process_sleep(smx_actor_t process, double duration);
127
128 XBT_PRIVATE void SIMIX_process_sleep_destroy(smx_activity_t synchro);
129 XBT_PRIVATE void SIMIX_process_auto_restart_set(smx_actor_t process, int auto_restart);
130 XBT_PRIVATE smx_actor_t SIMIX_process_restart(smx_actor_t process, smx_actor_t issuer);
131
132 void SIMIX_segment_index_set(smx_actor_t process, int segment_index);
133 extern void (*SMPI_switch_data_segment)(int dest);
134
135 SG_END_DECL()
136
137 #endif