Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove an useless pimple around exceptions
[simgrid.git] / src / simix / smx_private.h
1 /* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef _SIMIX_PRIVATE_H
8 #define _SIMIX_PRIVATE_H
9
10 #include "src/internal_config.h"
11 #include "simgrid/simix.h"
12 #include "surf/surf.h"
13 #include "xbt/base.h"
14 #include "xbt/fifo.h"
15 #include "xbt/swag.h"
16 #include "xbt/dict.h"
17 #include "xbt/mallocator.h"
18 #include "xbt/config.h"
19 #include "xbt/xbt_os_time.h"
20 #include "xbt/function_types.h"
21 #include "src/xbt/ex_interface.h"
22 #include "src/instr/instr_private.h"
23 #include "smx_process_private.h"
24 #include "smx_host_private.h"
25 #include "smx_io_private.h"
26 #include "smx_network_private.h"
27 #include "popping_private.h"
28 #include "smx_synchro_private.h"
29
30 #include <signal.h>
31
32 #ifdef __cplusplus
33
34 #include <simgrid/simix.hpp>
35
36 namespace simgrid {
37 namespace simix {
38
39 /* Hack: let msg load directly the right factory
40  *
41  * This is a factory of factory! How nice is this?
42  */
43 typedef ContextFactory* (*ContextFactoryInitializer)(void);
44 XBT_PUBLIC_DATA(ContextFactoryInitializer) factory_initializer;
45
46 }
47 }
48
49 typedef simgrid::simix::ContextFactory *smx_context_factory_t;
50
51 #else
52
53 typedef struct s_smx_context_factory *smx_context_factory_t;
54
55 #endif
56
57 SG_BEGIN_DECL()
58
59 /********************************** Simix Global ******************************/
60 typedef struct s_smx_global {
61   smx_context_factory_t context_factory;
62   xbt_dynar_t process_to_run;
63   xbt_dynar_t process_that_ran;
64   xbt_swag_t process_list;
65   xbt_swag_t process_to_destroy;
66   smx_process_t maestro_process;
67   xbt_dict_t registered_functions;
68   smx_creation_func_t create_process_function;
69   void_pfn_smxprocess_t kill_process_function;
70   /** Callback used when killing a SMX_process */
71   void_pfn_smxprocess_t cleanup_process_function;
72   xbt_mallocator_t synchro_mallocator;
73
74   xbt_os_mutex_t mutex;
75 } s_smx_global_t, *smx_global_t;
76
77 XBT_PUBLIC_DATA(smx_global_t) simix_global;
78 extern XBT_PRIVATE unsigned long simix_process_maxpid;
79
80 XBT_PUBLIC(void) SIMIX_clean(void);
81
82 /******************************** Exceptions *********************************/
83 /** @brief Ask to the provided simix process to raise the provided exception */
84 #define SMX_EXCEPTION(issuer, cat, val, msg)                            \
85   if (1) {                                                              \
86     smx_process_t _smx_throw_issuer = (issuer); /* evaluate only once */\
87     THROW_PREPARE(_smx_throw_issuer->running_ctx, (cat), (val), xbt_strdup(msg)); \
88     _smx_throw_issuer->doexception = 1;                                 \
89   } else ((void)0)
90
91 /* ******************************** File ************************************ */
92 typedef struct s_smx_file {
93   surf_file_t surf_file;
94   void* data;                   /**< @brief user data */
95 } s_smx_file_t;
96
97 /********************************* synchro *************************************/
98
99 typedef enum {
100   SIMIX_SYNC_EXECUTE,
101   SIMIX_SYNC_PARALLEL_EXECUTE,
102   SIMIX_SYNC_COMMUNICATE,
103   SIMIX_SYNC_JOIN,
104   SIMIX_SYNC_SLEEP,
105   SIMIX_SYNC_SYNCHRO,
106   SIMIX_SYNC_IO,
107 } e_smx_synchro_type_t;
108
109 typedef enum {
110   SIMIX_COMM_SEND,
111   SIMIX_COMM_RECEIVE,
112   SIMIX_COMM_READY,
113   SIMIX_COMM_DONE
114 } e_smx_comm_type_t;
115
116 typedef enum {
117   SIMIX_IO_OPEN,
118   SIMIX_IO_WRITE,
119   SIMIX_IO_READ,
120   SIMIX_IO_STAT
121 } e_smx_io_type_t;
122
123 /** @brief synchro datatype */
124 typedef struct s_smx_synchro {
125
126   e_smx_synchro_type_t type;          /* Type of SIMIX synchro */
127   e_smx_state_t state;               /* State of the synchro */
128   char *name;                        /* synchro name if any */
129   xbt_fifo_t simcalls;               /* List of simcalls waiting for this synchro */
130
131   /* Data specific to each synchro type */
132   union {
133
134     struct {
135       sg_host_t host;                /* The host where the execution takes place */
136       surf_action_t surf_exec;        /* The Surf execution action encapsulated */
137     } execution; /* Possibly parallel execution */
138
139     struct {
140       e_smx_comm_type_t type;         /* Type of the communication (SIMIX_COMM_SEND or SIMIX_COMM_RECEIVE) */
141       smx_mailbox_t mbox;             /* Rendez-vous where the comm is queued */
142
143 #if HAVE_MC
144       smx_mailbox_t mbox_cpy;         /* Copy of the rendez-vous where the comm is queued, MC needs it for DPOR
145                                          (comm.mbox set to NULL when the communication is removed from the mailbox
146                                          (used as garbage collector)) */
147 #endif
148       int refcount;                   /* Number of processes involved in the cond */
149       int detached;                   /* If detached or not */
150
151       void (*clean_fun)(void*);       /* Function to clean the detached src_buf if something goes wrong */
152       int (*match_fun)(void*,void*,smx_synchro_t);  /* Filter function used by the other side. It is used when
153                                          looking if a given communication matches my needs. For that, myself must match the
154                                          expectations of the other side, too. See  */
155       void (*copy_data_fun) (smx_synchro_t, void*, size_t);
156
157       /* Surf action data */
158       surf_action_t surf_comm;        /* The Surf communication action encapsulated */
159       surf_action_t src_timeout;      /* Surf's actions to instrument the timeouts */
160       surf_action_t dst_timeout;      /* Surf's actions to instrument the timeouts */
161       smx_process_t src_proc;
162       smx_process_t dst_proc;
163       double rate;
164       double task_size;
165
166       /* Data to be transfered */
167       void *src_buff;
168       void *dst_buff;
169       size_t src_buff_size;
170       size_t *dst_buff_size;
171       unsigned copied:1;              /* whether the data were already copied */
172
173       void* src_data;                 /* User data associated to communication */
174       void* dst_data;
175     } comm;
176
177     struct {
178       sg_host_t host;                /* The host that is sleeping */
179       surf_action_t surf_sleep;       /* The Surf sleeping action encapsulated */
180     } sleep;
181
182     struct {
183       surf_action_t sleep;
184     } synchro;
185
186     struct {
187       sg_host_t host;
188       surf_action_t surf_io;
189     } io;
190   };
191
192   char *category;                     /* simix action category for instrumentation */
193 } s_smx_synchro_t;
194
195 XBT_PRIVATE void SIMIX_context_mod_init(void);
196 XBT_PRIVATE void SIMIX_context_mod_exit(void);
197
198 XBT_PRIVATE smx_context_t SIMIX_context_new(
199   xbt_main_func_t code, int argc, char **argv,
200   void_pfn_smxprocess_t cleanup_func,
201   smx_process_t simix_process);
202
203 #ifndef WIN32
204 XBT_PUBLIC_DATA(char sigsegv_stack[SIGSTKSZ]);
205 #endif
206
207 /* We are using the bottom of the stack to save some information, like the
208  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
209  * size for the stack. */
210 #if HAVE_VALGRIND_H
211 # define smx_context_usable_stack_size                                  \
212   (smx_context_stack_size - sizeof(unsigned int)) /* for valgrind_stack_id */
213 #else
214 # define smx_context_usable_stack_size smx_context_stack_size
215 #endif
216
217 XBT_PRIVATE void *SIMIX_context_stack_new(void);
218 XBT_PRIVATE void SIMIX_context_stack_delete(void *stack);
219
220 XBT_PRIVATE void SIMIX_context_set_current(smx_context_t context);
221 XBT_PRIVATE smx_context_t SIMIX_context_get_current(void);
222
223 /* ****************************** */
224 /* context manipulation functions */
225 /* ****************************** */
226
227 XBT_PUBLIC(int) SIMIX_process_get_maxpid(void);
228
229 XBT_PRIVATE void SIMIX_post_create_environment(void);
230
231 // FIXME, Dirty hack for SMPI+MSG
232 XBT_PRIVATE void SIMIX_process_set_cleanup_function(
233   smx_process_t process, void_pfn_smxprocess_t cleanup);
234
235 SG_END_DECL()
236
237 #endif