Logo AND Algorithmique Numérique Distribuée

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