Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Give simgrid's host its own header file and datatype
[simgrid.git] / include / simgrid / simix.h
1 /* Copyright (c) 2007-2010, 2012-2014. 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_SIMIX_H
8 #define _SIMIX_SIMIX_H
9
10 #include "xbt/misc.h"
11 #include "xbt/fifo.h"
12 #include "xbt/dict.h"
13 #include "xbt/function_types.h"
14 #include "xbt/parmap.h"
15 #include "xbt/swag.h"
16 #include "simgrid/platf.h"
17 #include "simgrid/datatypes.h"
18 #include "simgrid/host.h"
19
20 SG_BEGIN_DECL()
21
22 /**************************** Scalar Values **********************************/
23
24 typedef union u_smx_scalar u_smx_scalar_t;
25
26 /* ******************************** Host ************************************ */
27 /** @brief Host datatype
28     @ingroup simix_host_management
29
30     A <em>location</em> (or <em>host</em>) is any possible place where
31     a process may run. Thus it is represented as a <em>physical
32     resource with computing capabilities</em>, some <em>mailboxes</em>
33     to enable running process to communicate with remote ones, and
34     some <em>private data</em> that can be only accessed by local
35     process.
36
37     \see m_host_management
38   @{ */
39 typedef struct s_smx_host_priv *smx_host_priv_t;
40 typedef enum {
41   SIMIX_WAITING,
42   SIMIX_READY,
43   SIMIX_RUNNING,
44   SIMIX_DONE,
45   SIMIX_CANCELED,
46   SIMIX_FAILED,
47   SIMIX_SRC_HOST_FAILURE,
48   SIMIX_DST_HOST_FAILURE,
49   SIMIX_SRC_TIMEOUT,
50   SIMIX_DST_TIMEOUT,
51   SIMIX_LINK_FAILURE
52 } e_smx_state_t;
53 /** @} */
54
55 /* ******************************** Synchro ************************************ */
56 /**
57  * \ingroup simix_synchro_management
58  */
59 typedef struct s_smx_mutex *smx_mutex_t;
60 /**
61  * \ingroup simix_synchro_management
62  */
63 typedef struct s_smx_cond *smx_cond_t;
64 /**
65  * \ingroup simix_synchro_management
66  */
67 typedef struct s_smx_sem *smx_sem_t;
68
69 /********************************** File *************************************/
70 typedef struct s_smx_file *smx_file_t;
71
72 /********************************** Storage *************************************/
73 typedef xbt_dictelm_t smx_storage_t;
74 typedef struct s_smx_storage_priv *smx_storage_priv_t;
75
76 /********************************** Synchro *************************************/
77 typedef struct s_smx_synchro *smx_synchro_t; /* FIXME: replace by specialized synchro handlers */
78
79 /* ****************************** Process *********************************** */
80 /** @brief Process datatype
81     @ingroup simix_process_management
82
83     A processt may be defined as a <em>code</em>, with some <em>private
84     data</em>, executing in a <em>location</em>.
85     \see m_process_management
86   @{ */
87 typedef struct s_smx_process *smx_process_t;
88 typedef enum {
89   SMX_EXIT_SUCCESS = 0,
90   SMX_EXIT_FAILURE = 1
91 } smx_process_exit_status_t;
92 /** @} */
93
94
95 /*
96  * Type of function that creates a process.
97  * The function must accept the following parameters:
98  * void* process: the process created will be stored there
99  * const char *name: a name for the object. It is for user-level information and can be NULL
100  * xbt_main_func_t code: is a function describing the behavior of the process
101  * void *data: data a pointer to any data one may want to attach to the new object.
102  * sg_host_t host: the location where the new process is executed
103  * int argc, char **argv: parameters passed to code
104  * xbt_dict_t pros: properties
105  */
106 typedef void (*smx_creation_func_t) ( /* process */ smx_process_t*,
107                                       /* name */ const char*,
108                                       /* code */ xbt_main_func_t,
109                                       /* userdata */ void*,
110                                       /* hostname */ const char*,
111                                       /* kill_time */ double,
112                                       /* argc */ int,
113                                       /* argv */ char**,
114                                       /* props */ xbt_dict_t,
115                                       /* auto_restart */ int,
116                                       /* parent_process */ smx_process_t);
117
118
119 /******************************* Networking ***********************************/
120 /**
121  * \ingroup simix_rdv_management
122  */
123 typedef struct s_smx_rvpoint *smx_rdv_t;
124
125 XBT_PUBLIC(void*) SIMIX_comm_get_src_data(smx_synchro_t synchro);
126 XBT_PUBLIC(void*) SIMIX_comm_get_dst_data(smx_synchro_t synchro);
127
128 /******************************** Context *************************************/
129 typedef struct s_smx_context *smx_context_t;
130 typedef struct s_smx_context_factory *smx_context_factory_t;
131
132 /* Process creation/destruction callbacks */
133 typedef void (*void_pfn_smxprocess_t) (smx_process_t);
134 /* Process kill */
135 typedef void (*void_pfn_smxprocess_t_smxprocess_t) (smx_process_t, smx_process_t);
136 /* for auto-restart function */
137 typedef void (*void_pfn_sghost_t) (sg_host_t);
138
139 /* The following function pointer types describe the interface that any context
140    factory should implement */
141
142
143 typedef smx_context_t (*smx_pfn_context_factory_create_context_t)(
144   xbt_main_func_t, int, char **, void_pfn_smxprocess_t, smx_process_t process);
145 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t*);
146 typedef void (*smx_pfn_context_free_t) (smx_context_t);
147 typedef void (*smx_pfn_context_start_t) (smx_context_t);
148 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
149 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
150 typedef void (*smx_pfn_context_runall_t) (void);
151 typedef smx_context_t (*smx_pfn_context_self_t) (void);
152 typedef smx_process_t (*smx_pfn_context_get_process_t) (smx_context_t context);
153
154 /* interface of the context factories */
155 typedef struct s_smx_context_factory {
156   const char *name;
157   smx_pfn_context_factory_create_context_t create_context;
158   smx_pfn_context_factory_finalize_t finalize;
159   smx_pfn_context_free_t free;
160   smx_pfn_context_stop_t stop;
161   smx_pfn_context_suspend_t suspend;
162   smx_pfn_context_runall_t runall;
163   smx_pfn_context_self_t self;
164   smx_pfn_context_get_process_t get_process;
165 } s_smx_context_factory_t;
166
167 /* Hack: let msg load directly the right factory */
168 typedef void (*smx_ctx_factory_initializer_t)(smx_context_factory_t*);
169 XBT_PUBLIC_DATA(smx_ctx_factory_initializer_t) smx_factory_initializer_to_use;
170 extern char* smx_context_factory_name;
171 extern int smx_context_stack_size;
172 extern int smx_context_stack_size_was_set;
173 extern int smx_context_guard_size;
174 extern int smx_context_guard_size_was_set;
175
176 /* *********************** */
177 /* Context type definition */
178 /* *********************** */
179 /* the following function pointers types describe the interface that all context
180    concepts must implement */
181 /* each context type derive from this structure, so they must contain this structure
182  * at their beginning -- OOP in C :/ */
183 typedef struct s_smx_context {
184   s_xbt_swag_hookup_t hookup;
185   xbt_main_func_t code;
186   void_pfn_smxprocess_t cleanup_func;
187   smx_process_t process;
188   char **argv;
189   int argc;
190   unsigned iwannadie:1;
191 } s_smx_ctx_base_t;
192
193 /* methods of this class */
194 XBT_PUBLIC(void) smx_ctx_base_factory_init(smx_context_factory_t *factory);
195 XBT_PUBLIC(int) smx_ctx_base_factory_finalize(smx_context_factory_t *factory);
196
197 XBT_PUBLIC(smx_context_t)
198 smx_ctx_base_factory_create_context_sized(size_t size, xbt_main_func_t code,
199                                           int argc, char **argv,
200                                           void_pfn_smxprocess_t cleanup,
201                                           smx_process_t process);
202 XBT_PUBLIC(void) smx_ctx_base_free(smx_context_t context);
203 XBT_PUBLIC(void) smx_ctx_base_stop(smx_context_t context);
204 XBT_PUBLIC(smx_context_t) smx_ctx_base_self(void);
205 XBT_PUBLIC(smx_process_t) smx_ctx_base_get_process(smx_context_t context);
206
207 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable(void);
208 XBT_PUBLIC(smx_process_t) SIMIX_process_from_PID(int PID);
209 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar(void);
210
211 /* parallelism */
212 XBT_PUBLIC(int) SIMIX_context_is_parallel(void);
213 XBT_PUBLIC(int) SIMIX_context_get_nthreads(void);
214 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
215 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold(void);
216 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
217 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode(void);
218 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
219
220
221
222 /********************************** Global ************************************/
223 /* Initialization and exit */
224 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
225
226
227 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
228 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
229 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t_smxprocess_t function);
230
231 /* Simulation execution */
232 XBT_PUBLIC(void) SIMIX_run(void);
233 XBT_PUBLIC(double) SIMIX_get_clock(void);
234
235 /* Timer functions FIXME: should these be public? */
236 typedef struct s_smx_timer* smx_timer_t;
237
238 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void *function, void *arg);
239 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
240 XBT_PUBLIC(double) SIMIX_timer_next(void);
241 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
242
243 XBT_PUBLIC(void) SIMIX_display_process_status(void);
244
245 /******************************* Environment **********************************/
246 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
247
248 /******************************** Deployment **********************************/
249
250 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
251 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
252 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
253 XBT_PUBLIC(void) SIMIX_init_application(void);
254 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
255
256 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
257                                             const char *process_function,
258                                             xbt_dynar_t arguments,
259                                             double process_start_time,
260                                             double process_kill_time);
261
262 /*********************************** Host *************************************/
263 //XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(u_smx_scalar_t *args);
264 XBT_PUBLIC(sg_host_t) SIMIX_host_get_by_name(const char *name);
265 XBT_PUBLIC(sg_host_t) SIMIX_host_self(void);
266 XBT_PUBLIC(const char*) SIMIX_host_self_get_name(void);
267 #define SIMIX_host_get_name(h) sg_host_name(h)  /* DEPRECATED: SIMIX_host_get_name */
268 XBT_PUBLIC(void) SIMIX_host_on(sg_host_t host);
269 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_process_t issuer);
270 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
271 XBT_PUBLIC(void*) SIMIX_host_self_get_data(void);
272 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_mounted_storage_list(sg_host_t host);
273 /********************************* Process ************************************/
274 XBT_PUBLIC(int) SIMIX_process_count(void);
275 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
276 XBT_PUBLIC(const char*) SIMIX_process_self_get_name(void);
277 XBT_PUBLIC(void) SIMIX_process_self_set_data(smx_process_t self, void *data);
278 XBT_PUBLIC(void*) SIMIX_process_self_get_data(smx_process_t self);
279 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_process_t);
280 XBT_PUBLIC(void) SIMIX_process_set_context(smx_process_t p,smx_context_t c);
281 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_process_t process);
282 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_process_t process);
283 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
284
285 /****************************** Communication *********************************/
286 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_synchro_t, void*, size_t));
287 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
288 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
289
290 XBT_PUBLIC(smx_synchro_t) SIMIX_comm_get_send_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
291 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
292 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
293 XBT_PUBLIC(void) SIMIX_comm_finish(smx_synchro_t synchro);
294
295 /******************************************************************************/
296 /*                            SIMIX simcalls                                  */
297 /******************************************************************************/
298 /* These functions are a system call-like interface to the simulation kernel. */
299 /* They can also be called from maestro's context, and they are thread safe.  */
300 /******************************************************************************/
301
302 /******************************* Host simcalls ********************************/
303 /* TODO use handlers and keep sg_host_t hidden from higher levels */
304 XBT_PUBLIC(sg_host_t) simcall_host_get_by_name(const char *name);
305 XBT_PUBLIC(const char *) simcall_host_get_name(sg_host_t host);
306 XBT_PUBLIC(xbt_dict_t) simcall_host_get_properties(sg_host_t host);
307 XBT_PUBLIC(void) simcall_host_on(sg_host_t host);
308 XBT_PUBLIC(void) simcall_host_off(sg_host_t host);
309 XBT_PUBLIC(int) simcall_host_get_core(sg_host_t host);
310 XBT_PUBLIC(xbt_swag_t) simcall_host_get_process_list(sg_host_t host);
311 XBT_PUBLIC(double) simcall_host_get_speed(sg_host_t host);
312 XBT_PUBLIC(double) simcall_host_get_available_speed(sg_host_t host);
313 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
314 XBT_PUBLIC(int) simcall_host_get_state(sg_host_t host);
315 XBT_PUBLIC(void *) simcall_host_get_data(sg_host_t host);
316
317 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
318
319 XBT_PUBLIC(double) simcall_host_get_current_power_peak(sg_host_t host);
320 XBT_PUBLIC(double) simcall_host_get_power_peak_at(sg_host_t host, int pstate_index);
321 XBT_PUBLIC(int) simcall_host_get_nb_pstates(sg_host_t host);
322 XBT_PUBLIC(void) simcall_host_set_pstate(sg_host_t host, int pstate_index);
323 XBT_PUBLIC(int) simcall_host_get_pstate(sg_host_t host);
324 XBT_PUBLIC(double) simcall_host_get_consumed_energy(sg_host_t host);
325 XBT_PUBLIC(double) simcall_host_get_wattmin_at(sg_host_t host, int pstate);
326 XBT_PUBLIC(double) simcall_host_get_wattmax_at(sg_host_t host, int pstate);
327
328 XBT_PUBLIC(smx_synchro_t) simcall_host_execute(const char *name, sg_host_t host,
329                                                 double flops_amount,
330                                                 double priority, double bound, unsigned long affinity_mask);
331 XBT_PUBLIC(smx_synchro_t) simcall_host_parallel_execute(const char *name,
332                                                      int host_nb,
333                                                      sg_host_t *host_list,
334                                                      double *flops_amount,
335                                                      double *bytes_amount,
336                                                      double amount,
337                                                      double rate);
338 XBT_PUBLIC(void) simcall_host_execution_destroy(smx_synchro_t execution);
339 XBT_PUBLIC(void) simcall_host_execution_cancel(smx_synchro_t execution);
340 XBT_PUBLIC(double) simcall_host_execution_get_remains(smx_synchro_t execution);
341 XBT_PUBLIC(e_smx_state_t) simcall_host_execution_get_state(smx_synchro_t execution);
342 XBT_PUBLIC(void) simcall_host_execution_set_priority(smx_synchro_t execution, double priority);
343 XBT_PUBLIC(void) simcall_host_execution_set_bound(smx_synchro_t execution, double bound);
344 XBT_PUBLIC(void) simcall_host_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask);
345 XBT_PUBLIC(e_smx_state_t) simcall_host_execution_wait(smx_synchro_t execution);
346 XBT_PUBLIC(xbt_dict_t) simcall_host_get_mounted_storage_list(sg_host_t host);
347 XBT_PUBLIC(xbt_dynar_t) simcall_host_get_attached_storage_list(sg_host_t host);
348 XBT_PUBLIC(void) simcall_host_get_params(sg_host_t vm, ws_params_t param);
349 XBT_PUBLIC(void) simcall_host_set_params(sg_host_t vm, ws_params_t param);
350
351 /******************************* VM simcalls ********************************/
352 // Create the vm_workstation at the SURF level
353 XBT_PUBLIC(void*) simcall_vm_create(const char *name, sg_host_t host);
354 XBT_PUBLIC(int) simcall_vm_get_state(sg_host_t vm);
355 XBT_PUBLIC(void) simcall_vm_start(sg_host_t vm);
356 XBT_PUBLIC(void) simcall_vm_migrate(sg_host_t vm, sg_host_t dst_pm);
357 XBT_PUBLIC(void *) simcall_vm_get_pm(sg_host_t vm);
358 XBT_PUBLIC(void) simcall_vm_set_bound(sg_host_t vm, double bound);
359 XBT_PUBLIC(void) simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask);
360 XBT_PUBLIC(void) simcall_vm_resume(sg_host_t vm);
361 XBT_PUBLIC(void) simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm);
362 XBT_PUBLIC(void) simcall_vm_save(sg_host_t vm);
363 XBT_PUBLIC(void) simcall_vm_restore(sg_host_t vm);
364 XBT_PUBLIC(void) simcall_vm_suspend(sg_host_t vm);
365 XBT_PUBLIC(void) simcall_vm_destroy(sg_host_t vm);
366 XBT_PUBLIC(void) simcall_vm_shutdown(sg_host_t vm);
367
368 /**************************** Process simcalls ********************************/
369 /* Constructor and Destructor */
370 XBT_PUBLIC(void) simcall_process_create(smx_process_t *process,
371                                           const char *name,
372                                           xbt_main_func_t code,
373                                           void *data,
374                                           const char *hostname,
375                                           double kill_time,
376                                           int argc, char **argv,
377                                           xbt_dict_t properties,
378                                           int auto_restart);
379
380 XBT_PUBLIC(void) simcall_process_kill(smx_process_t process);
381 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
382 XBT_PUBLIC(void) SIMIX_process_throw(smx_process_t process, xbt_errcat_t cat, int value, const char *msg);
383
384
385 /* Process handling */
386 XBT_PUBLIC(void) simcall_process_cleanup(smx_process_t process);
387 XBT_PUBLIC(void) simcall_process_change_host(smx_process_t process,
388                  sg_host_t dest);
389 XBT_PUBLIC(void) simcall_process_suspend(smx_process_t process);
390 XBT_PUBLIC(void) simcall_process_resume(smx_process_t process);
391
392 /* Getters and Setters */
393 XBT_PUBLIC(int) simcall_process_count(void);
394 XBT_PUBLIC(void *) simcall_process_get_data(smx_process_t process);
395 XBT_PUBLIC(void) simcall_process_set_data(smx_process_t process, void *data);
396 XBT_PUBLIC(sg_host_t) simcall_process_get_host(smx_process_t process);
397 XBT_PUBLIC(const char *) simcall_process_get_name(smx_process_t process);
398 XBT_PUBLIC(int) simcall_process_get_PID(smx_process_t process);
399 XBT_PUBLIC(int) simcall_process_get_PPID(smx_process_t process);
400 XBT_PUBLIC(int) simcall_process_is_suspended(smx_process_t process);
401 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_process_t host);
402 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_process_t process, double kill_time);
403 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
404 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart);
405 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process);
406 XBT_PUBLIC(void) simcall_process_join(smx_process_t process, double timeout);
407 /* Sleep control */
408 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
409
410 /************************** Comunication simcalls *****************************/
411 /***** Rendez-vous points *****/
412
413 XBT_PUBLIC(smx_rdv_t) simcall_rdv_create(const char *name);
414 XBT_PUBLIC(void) simcall_rdv_destroy(smx_rdv_t rvp);
415 XBT_PUBLIC(smx_rdv_t) simcall_rdv_get_by_name(const char *name);
416 XBT_PUBLIC(int) simcall_rdv_comm_count_by_host(smx_rdv_t rdv, sg_host_t host);
417 XBT_PUBLIC(smx_synchro_t) simcall_rdv_get_head(smx_rdv_t rdv);
418 XBT_PUBLIC(smx_process_t) simcall_rdv_get_receiver(smx_rdv_t rdv);
419 XBT_PUBLIC(void) simcall_rdv_set_receiver(smx_rdv_t rdv , smx_process_t process);
420
421 XBT_PUBLIC(xbt_dict_t) SIMIX_get_rdv_points(void);
422
423 /***** Communication simcalls *****/
424
425 XBT_PUBLIC(void) simcall_comm_send(smx_process_t src, smx_rdv_t rdv, double task_size,
426                                      double rate, void *src_buff,
427                                      size_t src_buff_size,
428                                      int (*match_fun)(void *, void *, smx_synchro_t),
429                                      void (*copy_data_fun)(smx_synchro_t, void*, size_t),
430                                      void *data, double timeout);
431
432 XBT_PUBLIC(smx_synchro_t) simcall_comm_isend(smx_process_t src, smx_rdv_t rdv, 
433                                               double task_size,
434                                               double rate, void *src_buff,
435                                               size_t src_buff_size,
436                                               int (*match_fun)(void *, void *, smx_synchro_t),
437                                               void (*clean_fun)(void *),
438                                               void (*copy_data_fun)(smx_synchro_t, void*, size_t),
439                                               void *data, int detached);
440
441 XBT_PUBLIC(void) simcall_comm_recv(smx_rdv_t rdv, void *dst_buff,
442                                    size_t * dst_buff_size,
443                                    int (*match_fun)(void *, void *, smx_synchro_t),
444                                    void (*copy_data_fun)(smx_synchro_t, void*, size_t),
445                                    void *data, double timeout, double rate);
446
447 XBT_PUBLIC(smx_synchro_t) simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff,
448                                             size_t * dst_buff_size,
449                                             int (*match_fun)(void *, void *, smx_synchro_t),
450                                             void (*copy_data_fun)(smx_synchro_t, void*, size_t),
451                                             void *data, double rate);
452
453 XBT_PUBLIC(smx_synchro_t) simcall_comm_iprobe(smx_rdv_t rdv, int type, int src, int tag,
454                                 int (*match_fun)(void *, void *, smx_synchro_t), void *data);
455 XBT_PUBLIC(void) simcall_comm_cancel(smx_synchro_t comm);
456
457 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
458 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms);
459 XBT_PUBLIC(void) simcall_comm_wait(smx_synchro_t comm, double timeout);
460 XBT_PUBLIC(int) simcall_comm_test(smx_synchro_t comm);
461 XBT_PUBLIC(int) simcall_comm_testany(xbt_dynar_t comms);
462
463 /* Getters and setters */
464 XBT_PUBLIC(double) simcall_comm_get_remains(smx_synchro_t comm);
465 XBT_PUBLIC(e_smx_state_t) simcall_comm_get_state(smx_synchro_t comm);
466 XBT_PUBLIC(void *) simcall_comm_get_src_data(smx_synchro_t comm);
467 XBT_PUBLIC(void *) simcall_comm_get_dst_data(smx_synchro_t comm);
468 XBT_PUBLIC(smx_process_t) simcall_comm_get_src_proc(smx_synchro_t comm);
469 XBT_PUBLIC(smx_process_t) simcall_comm_get_dst_proc(smx_synchro_t comm);
470
471 #ifdef HAVE_LATENCY_BOUND_TRACKING
472 XBT_PUBLIC(int) simcall_comm_is_latency_bounded(smx_synchro_t comm);
473 #endif
474
475 /************************** Tracing handling **********************************/
476 XBT_PUBLIC(void) simcall_set_category(smx_synchro_t synchro, const char *category);
477
478 /************************** Synchro simcalls **********************************/
479 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init(void);
480 XBT_PUBLIC(void) simcall_mutex_destroy(smx_mutex_t mutex);
481 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
482 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
483 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
484
485 XBT_PUBLIC(smx_cond_t) simcall_cond_init(void);
486 XBT_PUBLIC(void) simcall_cond_destroy(smx_cond_t cond);
487 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
488 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
489 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond,
490                                          smx_mutex_t mutex,
491                                          double max_duration);
492 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
493
494 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
495 XBT_PUBLIC(void) simcall_sem_destroy(smx_sem_t sem);
496 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
497 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
498 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
499 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem,
500                                              double max_duration);
501 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
502
503 /*****************************   File   **********************************/
504 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
505 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
506 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
507 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
508 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* fullpath, sg_host_t host);
509 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
510 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
511 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
512 XBT_PUBLIC(xbt_dynar_t) simcall_file_get_info(smx_file_t fd);
513 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
514 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
515 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
516 /*****************************   Storage   **********************************/
517 XBT_PUBLIC(sg_size_t) simcall_storage_get_free_size (smx_storage_t storage);
518 XBT_PUBLIC(sg_size_t) simcall_storage_get_used_size (smx_storage_t storage);
519 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_properties(smx_storage_t storage);
520 XBT_PUBLIC(void*) SIMIX_storage_get_data(smx_storage_t storage);
521 XBT_PUBLIC(void) SIMIX_storage_set_data(smx_storage_t storage, void *data);
522 XBT_PUBLIC(xbt_dict_t) SIMIX_storage_get_content(smx_storage_t storage);
523 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_content(smx_storage_t storage);
524 XBT_PUBLIC(const char*) SIMIX_storage_get_name(smx_storage_t storage);
525 XBT_PUBLIC(sg_size_t) SIMIX_storage_get_size(smx_storage_t storage);
526 XBT_PUBLIC(const char*) SIMIX_storage_get_host(smx_storage_t storage);
527 /************************** AS router   **********************************/
528 XBT_PUBLIC(xbt_dict_t) SIMIX_asr_get_properties(const char *name);
529 /************************** AS router simcalls ***************************/
530 XBT_PUBLIC(xbt_dict_t) simcall_asr_get_properties(const char *name);
531
532 /************************** MC simcalls   **********************************/
533 XBT_PUBLIC(void *) simcall_mc_snapshot(void);
534 XBT_PUBLIC(int) simcall_mc_compare_snapshots(void *s1, void *s2);
535 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
536
537 SG_END_DECL()
538 #endif                          /* _SIMIX_SIMIX_H */