Logo AND Algorithmique Numérique Distribuée

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