Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Bring back the missing void
[simgrid.git] / include / simgrid / simix.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_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/datatypes.h"
17 #include "simgrid/host.h"
18
19 #ifdef __cplusplus
20
21 namespace simgrid {
22 namespace simix {
23
24   /** @brief Process datatype
25       @ingroup simix_process_management
26
27       A process may be defined as a <em>code</em>, with some <em>private
28       data</em>, executing in a <em>location</em>.
29       \see m_process_management
30     @{ */
31   class Process;
32   class Context;
33   class ContextFactory;
34   class Mutex;
35 }
36 }
37
38 typedef simgrid::simix::Context *smx_context_t;
39 typedef simgrid::simix::Process *smx_process_t;
40
41 /**
42  * \ingroup simix_synchro_management
43  */
44 typedef simgrid::simix::Mutex   *smx_mutex_t;
45
46 #else
47
48 typedef struct s_smx_context *smx_context_t;
49 typedef struct s_smx_process *smx_process_t;
50 typedef struct s_smx_mutex   *smx_mutex_t;
51
52 #endif
53
54 /**************************** Scalar Values **********************************/
55
56 typedef union u_smx_scalar u_smx_scalar_t;
57
58 /* ******************************** Host ************************************ */
59 /** @brief Host datatype
60     @ingroup simix_host_management
61
62     A <em>location</em> (or <em>host</em>) is any possible place where
63     a process may run. Thus it is represented as a <em>physical
64     resource with computing capabilities</em>, some <em>mailboxes</em>
65     to enable running process to communicate with remote ones, and
66     some <em>private data</em> that can be only accessed by local
67     process.
68
69     \see m_host_management
70   @{ */
71 typedef enum {
72   SIMIX_WAITING,
73   SIMIX_READY,
74   SIMIX_RUNNING,
75   SIMIX_DONE,
76   SIMIX_CANCELED,
77   SIMIX_FAILED,
78   SIMIX_SRC_HOST_FAILURE,
79   SIMIX_DST_HOST_FAILURE,
80   SIMIX_SRC_TIMEOUT,
81   SIMIX_DST_TIMEOUT,
82   SIMIX_LINK_FAILURE
83 } e_smx_state_t;
84 /** @} */
85
86 /* ******************************** Synchro ************************************ */
87
88 /**
89  * \ingroup simix_synchro_management
90  */
91 typedef struct s_smx_cond *smx_cond_t;
92 /**
93  * \ingroup simix_synchro_management
94  */
95 typedef struct s_smx_sem *smx_sem_t;
96
97 /********************************** File *************************************/
98 typedef struct s_smx_file *smx_file_t;
99
100 /********************************** Storage *************************************/
101 typedef xbt_dictelm_t smx_storage_t;
102 typedef struct s_smx_storage_priv *smx_storage_priv_t;
103
104 /* ****************************** Process *********************************** */
105
106 typedef enum {
107   SMX_EXIT_SUCCESS = 0,
108   SMX_EXIT_FAILURE = 1
109 } smx_process_exit_status_t;
110 /** @} */
111
112 /******************************* Networking ***********************************/
113 /**
114  * \ingroup simix_mbox_management
115  */
116 typedef struct s_smx_mailbox *smx_mailbox_t;
117
118 /* Process creation/destruction callbacks */
119 typedef void (*void_pfn_smxprocess_t) (smx_process_t);
120 /* for auto-restart function */
121 typedef void (*void_pfn_sghost_t) (sg_host_t);
122
123 extern int smx_context_stack_size;
124 extern int smx_context_stack_size_was_set;
125 extern int smx_context_guard_size;
126 extern int smx_context_guard_size_was_set;
127
128 SG_BEGIN_DECL()
129
130 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable();
131 XBT_PUBLIC(smx_process_t) SIMIX_process_from_PID(int PID);
132 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar(void);
133
134 /* parallelism */
135 XBT_PUBLIC(int) SIMIX_context_is_parallel(void);
136 XBT_PUBLIC(int) SIMIX_context_get_nthreads(void);
137 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
138 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold();
139 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
140 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode(void);
141 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
142 XBT_PUBLIC(int) SIMIX_is_maestro(void);
143
144
145 /********************************** Global ************************************/
146 /* Initialization and exit */
147 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
148
149 /* Set to execute in the maestro
150  *
151  * If no maestro code is registered (the default), the main thread
152  * is assumed to be the maestro. */
153 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
154
155 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
156 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
157
158 /* Simulation execution */
159 XBT_PUBLIC(void) SIMIX_run();
160 XBT_PUBLIC(double) SIMIX_get_clock();
161
162 /* Timer functions FIXME: should these be public? */
163 typedef struct s_smx_timer* smx_timer_t;
164
165 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
166 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
167 XBT_PUBLIC(double) SIMIX_timer_next(void);
168 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
169
170 XBT_PUBLIC(void) SIMIX_display_process_status();
171
172 /******************************* Environment **********************************/
173 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
174
175 /******************************** Deployment **********************************/
176
177 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
178 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
179 XBT_PUBLIC(void) SIMIX_init_application(void);
180 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
181
182 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
183                                             const char *process_function,
184                                             xbt_dynar_t arguments,
185                                             double process_start_time,
186                                             double process_kill_time);
187
188 /*********************************** Host *************************************/
189 /* Functions for running a process in main()
190  *
191  *  1. create the maestro process
192  *  2. attach (create a context and wait for maestro to give control back to you)
193  *  3. do you process job
194  *  4. detach (this waits for the simulation to terminate)
195  */
196
197 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
198 XBT_PUBLIC(smx_process_t) SIMIX_process_attach(
199   const char* name,
200   void *data,
201   const char* hostname,
202   xbt_dict_t properties,
203   smx_process_t parent_process);
204 XBT_PUBLIC(void) SIMIX_process_detach();
205
206 /*********************************** Host *************************************/
207 XBT_PUBLIC(sg_host_t) SIMIX_host_self(void);
208 XBT_PUBLIC(const char*) SIMIX_host_self_get_name(void);
209 XBT_PUBLIC(void) SIMIX_host_on(sg_host_t host);
210 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_process_t issuer);
211 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
212 XBT_PUBLIC(void*) SIMIX_host_self_get_data(void);
213
214 /********************************* Process ************************************/
215 XBT_PUBLIC(smx_process_t) SIMIX_process_ref(smx_process_t process);
216 XBT_PUBLIC(void) SIMIX_process_unref(smx_process_t process);
217 XBT_PUBLIC(int) SIMIX_process_count(void);
218 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
219 XBT_PUBLIC(const char*) SIMIX_process_self_get_name(void);
220 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
221 XBT_PUBLIC(void*) SIMIX_process_self_get_data(void);
222 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_process_t process);
223 XBT_PUBLIC(void) SIMIX_process_set_context(smx_process_t p,smx_context_t c);
224 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_process_t process);
225 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_process_t process);
226 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
227
228 /****************************** Communication *********************************/
229 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_synchro_t, void*, size_t));
230 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
231 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
232
233 XBT_PUBLIC(smx_synchro_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
234 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
235 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
236 XBT_PUBLIC(void) SIMIX_comm_finish(smx_synchro_t synchro);
237
238 /******************************************************************************/
239 /*                            SIMIX simcalls                                  */
240 /******************************************************************************/
241 /* These functions are a system call-like interface to the simulation kernel. */
242 /* They can also be called from maestro's context, and they are thread safe.  */
243 /******************************************************************************/
244
245 XBT_PUBLIC(void) simcall_call(smx_process_t process);
246
247 /******************************* Host simcalls ********************************/
248 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
249
250 XBT_PUBLIC(smx_synchro_t) simcall_execution_start(const char *name,
251                                                 double flops_amount,
252                                                 double priority, double bound, unsigned long affinity_mask);
253 XBT_PUBLIC(smx_synchro_t) simcall_execution_parallel_start(const char *name,
254                                                      int host_nb,
255                                                      sg_host_t *host_list,
256                                                      double *flops_amount,
257                                                      double *bytes_amount,
258                                                      double amount,
259                                                      double rate);
260 XBT_PUBLIC(void) simcall_execution_cancel(smx_synchro_t execution);
261 XBT_PUBLIC(void) simcall_execution_set_priority(smx_synchro_t execution, double priority);
262 XBT_PUBLIC(void) simcall_execution_set_bound(smx_synchro_t execution, double bound);
263 XBT_PUBLIC(void) simcall_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask);
264 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_synchro_t execution);
265
266 /******************************* VM simcalls ********************************/
267 // Create the vm_workstation at the SURF level
268 XBT_PUBLIC(void*) simcall_vm_create(const char *name, sg_host_t host);
269 XBT_PUBLIC(int) simcall_vm_get_state(sg_host_t vm);
270 XBT_PUBLIC(void) simcall_vm_start(sg_host_t vm);
271 XBT_PUBLIC(void) simcall_vm_migrate(sg_host_t vm, sg_host_t dst_pm);
272 XBT_PUBLIC(void *) simcall_vm_get_pm(sg_host_t vm);
273 XBT_PUBLIC(void) simcall_vm_set_bound(sg_host_t vm, double bound);
274 XBT_PUBLIC(void) simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask);
275 XBT_PUBLIC(void) simcall_vm_resume(sg_host_t vm);
276 XBT_PUBLIC(void) simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm);
277 XBT_PUBLIC(void) simcall_vm_save(sg_host_t vm);
278 XBT_PUBLIC(void) simcall_vm_restore(sg_host_t vm);
279 XBT_PUBLIC(void) simcall_vm_suspend(sg_host_t vm);
280 XBT_PUBLIC(void) simcall_vm_destroy(sg_host_t vm);
281 XBT_PUBLIC(void) simcall_vm_shutdown(sg_host_t vm);
282
283 /**************************** Process simcalls ********************************/
284 /* Constructor and Destructor */
285 XBT_PUBLIC(smx_process_t) simcall_process_create(const char *name,
286                                           xbt_main_func_t code,
287                                           void *data,
288                                           const char *hostname,
289                                           double kill_time,
290                                           int argc, char **argv,
291                                           xbt_dict_t properties,
292                                           int auto_restart);
293
294 XBT_PUBLIC(void) simcall_process_kill(smx_process_t process);
295 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
296 XBT_PUBLIC(void) SIMIX_process_throw(smx_process_t process, xbt_errcat_t cat, int value, const char *msg);
297
298
299 /* Process handling */
300 XBT_PUBLIC(void) simcall_process_cleanup(smx_process_t process);
301 XBT_PUBLIC(void) simcall_process_suspend(smx_process_t process);
302 XBT_PUBLIC(void) simcall_process_resume(smx_process_t process);
303
304 /* Getters and Setters */
305 XBT_PUBLIC(int) simcall_process_count(void);
306 XBT_PUBLIC(void *) simcall_process_get_data(smx_process_t process);
307 XBT_PUBLIC(void) simcall_process_set_data(smx_process_t process, void *data);
308 XBT_PUBLIC(void) simcall_process_set_host(smx_process_t process, sg_host_t dest);
309 XBT_PUBLIC(sg_host_t) simcall_process_get_host(smx_process_t process);
310 XBT_PUBLIC(const char *) simcall_process_get_name(smx_process_t process);
311 XBT_PUBLIC(int) simcall_process_get_PID(smx_process_t process);
312 XBT_PUBLIC(int) simcall_process_get_PPID(smx_process_t process);
313 XBT_PUBLIC(int) simcall_process_is_suspended(smx_process_t process);
314 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_process_t host);
315 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_process_t process, double kill_time);
316 XBT_PUBLIC(double) simcall_process_get_kill_time(smx_process_t process);
317 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
318 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart);
319 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process);
320 XBT_PUBLIC(void) simcall_process_join(smx_process_t process, double timeout);
321 /* Sleep control */
322 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
323
324 /************************** Comunication simcalls *****************************/
325 /***** Rendez-vous points *****/
326
327 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_create(const char *name);
328 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_get_by_name(const char *name);
329 XBT_PUBLIC(smx_synchro_t) simcall_mbox_front(smx_mailbox_t mbox);
330 XBT_PUBLIC(void) simcall_mbox_set_receiver(smx_mailbox_t mbox , smx_process_t process);
331
332 /***** Communication simcalls *****/
333
334 XBT_PUBLIC(void) simcall_comm_send(smx_process_t sender, smx_mailbox_t mbox, double task_size,
335                                      double rate, void *src_buff,
336                                      size_t src_buff_size,
337                                      int (*match_fun)(void *, void *, smx_synchro_t),
338                                      void (*copy_data_fun)(smx_synchro_t, void*, size_t),
339                                      void *data, double timeout);
340
341 XBT_PUBLIC(smx_synchro_t) simcall_comm_isend(smx_process_t sender, smx_mailbox_t mbox,
342                                               double task_size,
343                                               double rate, void *src_buff,
344                                               size_t src_buff_size,
345                                               int (*match_fun)(void *, void *, smx_synchro_t),
346                                               void (*clean_fun)(void *),
347                                               void (*copy_data_fun)(smx_synchro_t, void*, size_t),
348                                               void *data, int detached);
349
350 XBT_PUBLIC(void) simcall_comm_recv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff,
351                                    size_t * dst_buff_size,
352                                    int (*match_fun)(void *, void *, smx_synchro_t),
353                                    void (*copy_data_fun)(smx_synchro_t, void*, size_t),
354                                    void *data, double timeout, double rate);
355
356 XBT_PUBLIC(smx_synchro_t) simcall_comm_irecv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff,
357                                             size_t * dst_buff_size,
358                                             int (*match_fun)(void *, void *, smx_synchro_t),
359                                             void (*copy_data_fun)(smx_synchro_t, void*, size_t),
360                                             void *data, double rate);
361
362 XBT_PUBLIC(smx_synchro_t) simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
363                                 int (*match_fun)(void *, void *, smx_synchro_t), void *data);
364 XBT_PUBLIC(void) simcall_comm_cancel(smx_synchro_t comm);
365
366 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
367 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms);
368 XBT_PUBLIC(void) simcall_comm_wait(smx_synchro_t comm, double timeout);
369 XBT_PUBLIC(int) simcall_comm_test(smx_synchro_t comm);
370 XBT_PUBLIC(int) simcall_comm_testany(xbt_dynar_t comms);
371
372 /************************** Tracing handling **********************************/
373 XBT_PUBLIC(void) simcall_set_category(smx_synchro_t synchro, const char *category);
374
375 /************************** Synchro simcalls **********************************/
376 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init(void);
377 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
378 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
379 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
380 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
381 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
382
383 XBT_PUBLIC(smx_cond_t) simcall_cond_init(void);
384 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
385 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
386 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
387 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
388 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond,
389                                          smx_mutex_t mutex,
390                                          double max_duration);
391 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
392
393 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
394 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
395 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
396 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
397 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
398 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem,
399                                              double max_duration);
400 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
401
402 /*****************************   File   **********************************/
403 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
404 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
405 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
406 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
407 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* fullpath, sg_host_t host);
408 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
409 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
410 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
411 XBT_PUBLIC(xbt_dynar_t) simcall_file_get_info(smx_file_t fd);
412 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
413 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
414 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
415 /*****************************   Storage   **********************************/
416 XBT_PUBLIC(sg_size_t) simcall_storage_get_free_size (smx_storage_t storage);
417 XBT_PUBLIC(sg_size_t) simcall_storage_get_used_size (smx_storage_t storage);
418 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_properties(smx_storage_t storage);
419 XBT_PUBLIC(void*) SIMIX_storage_get_data(smx_storage_t storage);
420 XBT_PUBLIC(void) SIMIX_storage_set_data(smx_storage_t storage, void *data);
421 XBT_PUBLIC(xbt_dict_t) SIMIX_storage_get_content(smx_storage_t storage);
422 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_content(smx_storage_t storage);
423 XBT_PUBLIC(const char*) SIMIX_storage_get_name(smx_storage_t storage);
424 XBT_PUBLIC(sg_size_t) SIMIX_storage_get_size(smx_storage_t storage);
425 XBT_PUBLIC(const char*) SIMIX_storage_get_host(smx_storage_t storage);
426 /************************** AS router   **********************************/
427 XBT_PUBLIC(xbt_dict_t) SIMIX_asr_get_properties(const char *name);
428 /************************** AS router simcalls ***************************/
429 XBT_PUBLIC(xbt_dict_t) simcall_asr_get_properties(const char *name);
430
431 /************************** MC simcalls   **********************************/
432 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
433
434 SG_END_DECL()
435 #endif                          /* _SIMIX_SIMIX_H */