Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
0b243660c1e072a8a1941393e5161e3b3950b76a
[simgrid.git] / include / simgrid / simix.h
1 /* Copyright (c) 2007-2017. The SimGrid Team. All rights reserved.          */
2
3 /* This program is free software; you can redistribute it and/or modify it
4  * under the terms of the license (GNU LGPL) which comes with this package. */
5
6 #ifndef _SIMIX_SIMIX_H
7 #define _SIMIX_SIMIX_H
8
9 #include "simgrid/datatypes.h"
10 #include "simgrid/forward.h"
11 #include "simgrid/host.h"
12 #include "xbt/ex.h"
13 #include "xbt/parmap.h"
14
15 /* ******************************** Host ************************************ */
16 /** @brief Host datatype
17     @ingroup simix_host_management
18
19     A <em>location</em> (or <em>host</em>) is any possible place where
20     a process may run. Thus it is represented as a <em>physical
21     resource with computing capabilities</em>, some <em>mailboxes</em>
22     to enable running process to communicate with remote ones, and
23     some <em>private data</em> that can be only accessed by local
24     process.
25
26     \see m_host_management
27   @{ */
28 typedef enum {
29   SIMIX_WAITING,
30   SIMIX_READY,
31   SIMIX_RUNNING,
32   SIMIX_DONE,
33   SIMIX_CANCELED,
34   SIMIX_FAILED,
35   SIMIX_SRC_HOST_FAILURE,
36   SIMIX_DST_HOST_FAILURE,
37   SIMIX_TIMEOUT,
38   SIMIX_SRC_TIMEOUT,
39   SIMIX_DST_TIMEOUT,
40   SIMIX_LINK_FAILURE
41 } e_smx_state_t;
42 /** @} */
43
44 /* ******************************** Synchro ************************************ */
45
46 /**
47  * \ingroup simix_synchro_management
48  */
49 typedef struct s_smx_cond *smx_cond_t;
50 /**
51  * \ingroup simix_synchro_management
52  */
53 typedef struct s_smx_sem *smx_sem_t;
54
55 /* ****************************** Process *********************************** */
56
57 typedef enum {
58   SMX_EXIT_SUCCESS = 0,
59   SMX_EXIT_FAILURE = 1
60 } smx_process_exit_status_t;
61 /** @} */
62
63 /******************************* Networking ***********************************/
64
65 /* Process creation/destruction callbacks */
66 typedef void (*void_pfn_smxprocess_t) (smx_actor_t);
67
68 extern int smx_context_stack_size;
69 extern int smx_context_stack_size_was_set;
70 extern int smx_context_guard_size;
71 extern int smx_context_guard_size_was_set;
72
73 SG_BEGIN_DECL()
74
75 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable();
76 XBT_PUBLIC(smx_actor_t) SIMIX_process_from_PID(aid_t PID);
77 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar();
78
79 /* parallelism */
80 XBT_PUBLIC(int) SIMIX_context_is_parallel();
81 XBT_PUBLIC(int) SIMIX_context_get_nthreads();
82 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
83 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold();
84 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
85 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode();
86 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
87 XBT_PUBLIC(int) SIMIX_is_maestro();
88
89
90 /********************************** Global ************************************/
91 /* Initialization and exit */
92 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
93
94 /* Set to execute in the maestro
95  *
96  * If no maestro code is registered (the default), the main thread
97  * is assumed to be the maestro. */
98 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
99
100 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
101 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
102
103 /* Simulation execution */
104 XBT_PUBLIC(void) SIMIX_run();
105 XBT_PUBLIC(double) SIMIX_get_clock();
106
107 /* Timer functions FIXME: should these be public? */
108 typedef struct s_smx_timer* smx_timer_t;
109
110 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
111 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
112 XBT_PUBLIC(double) SIMIX_timer_next();
113 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
114
115 XBT_PUBLIC(void) SIMIX_display_process_status();
116
117 /******************************* Environment **********************************/
118 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
119
120 /******************************** Deployment **********************************/
121
122 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
123 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
124 XBT_PUBLIC(void) SIMIX_init_application();
125 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
126
127 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
128                                             const char *process_function,
129                                             xbt_dynar_t arguments,
130                                             double process_start_time,
131                                             double process_kill_time);
132
133 /*********************************** Host *************************************/
134 /* Functions for running a process in main()
135  *
136  *  1. create the maestro process
137  *  2. attach (create a context and wait for maestro to give control back to you)
138  *  3. do you process job
139  *  4. detach (this waits for the simulation to terminate)
140  */
141
142 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
143 XBT_PUBLIC(smx_actor_t) SIMIX_process_attach(
144   const char* name,
145   void *data,
146   const char* hostname,
147   xbt_dict_t properties,
148   smx_actor_t parent_process);
149 XBT_PUBLIC(void) SIMIX_process_detach();
150
151 /*********************************** Host *************************************/
152 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
153 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
154 XBT_PUBLIC(void*) SIMIX_host_self_get_data();
155
156 /********************************* Process ************************************/
157 XBT_PUBLIC(int) SIMIX_process_count();
158 XBT_PUBLIC(smx_actor_t) SIMIX_process_self();
159 XBT_PUBLIC(const char*) SIMIX_process_self_get_name();
160 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
161 XBT_PUBLIC(void*) SIMIX_process_self_get_data();
162 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_actor_t process);
163 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_actor_t process);
164 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
165
166 SG_END_DECL()
167
168 /****************************** Communication *********************************/
169 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t));
170 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
171 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
172
173 XBT_PUBLIC(smx_activity_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
174 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
175 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
176 XBT_PUBLIC(void) SIMIX_comm_finish(smx_activity_t synchro);
177
178 /******************************************************************************/
179 /*                            SIMIX simcalls                                  */
180 /******************************************************************************/
181 /* These functions are a system call-like interface to the simulation kernel. */
182 /* They can also be called from maestro's context, and they are thread safe.  */
183 /******************************************************************************/
184
185 XBT_PUBLIC(void) simcall_call(smx_actor_t process);
186
187 /******************************* Host simcalls ********************************/
188 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
189 XBT_PUBLIC(smx_activity_t) simcall_execution_start(const char *name,
190                                                 double flops_amount,
191                                                 double priority, double bound);
192 XBT_PUBLIC(smx_activity_t)
193 simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
194                                  double* bytes_amount, double amount, double rate, double timeout);
195 XBT_PUBLIC(void) simcall_execution_cancel(smx_activity_t execution);
196 XBT_PUBLIC(void) simcall_execution_set_priority(smx_activity_t execution, double priority);
197 XBT_PUBLIC(void) simcall_execution_set_bound(smx_activity_t execution, double bound);
198 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_activity_t execution);
199
200 /**************************** Process simcalls ********************************/
201 SG_BEGIN_DECL()
202 /* Constructor and Destructor */
203 XBT_PUBLIC(smx_actor_t)
204 simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc, char** argv,
205                        xbt_dict_t properties);
206
207 XBT_PUBLIC(void) simcall_process_kill(smx_actor_t process);
208 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
209 XBT_PUBLIC(void) SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg);
210
211
212 /* Process handling */
213 XBT_PUBLIC(void) simcall_process_cleanup(smx_actor_t process);
214 XBT_PUBLIC(void) simcall_process_suspend(smx_actor_t process);
215
216 /* Getters and Setters */
217 XBT_PUBLIC(int) simcall_process_count();
218 XBT_PUBLIC(void) simcall_process_set_data(smx_actor_t process, void *data);
219 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_actor_t host);
220 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_actor_t process, double kill_time);
221 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
222 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart);
223 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process);
224 XBT_PUBLIC(void) simcall_process_join(smx_actor_t process, double timeout);
225 /* Sleep control */
226 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
227 SG_END_DECL()
228
229 /************************** Comunication simcalls *****************************/
230
231 XBT_PUBLIC(void)
232 simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, size_t task_size, double rate, void* src_buff,
233                   size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
234                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
235
236 XBT_PUBLIC(smx_activity_t)
237 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, size_t task_size, double rate, void* src_buff,
238                    size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
239                    void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
240                    int detached);
241
242 XBT_PUBLIC(void)
243 simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
244                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
245                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate);
246
247 XBT_PUBLIC(smx_activity_t)
248 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
249                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
250                    void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate);
251
252 XBT_PUBLIC(smx_activity_t)
253 simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
254                     int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data);
255 XBT_PUBLIC(void) simcall_comm_cancel(smx_activity_t comm);
256
257 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
258 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms, double timeout);
259 XBT_PUBLIC(void) simcall_comm_wait(smx_activity_t comm, double timeout);
260 XBT_PUBLIC(int) simcall_comm_test(smx_activity_t comm);
261 XBT_PUBLIC(int) simcall_comm_testany(smx_activity_t* comms, size_t count);
262
263 /************************** Tracing handling **********************************/
264 XBT_PUBLIC(void) simcall_set_category(smx_activity_t synchro, const char *category);
265
266 /************************** Synchro simcalls **********************************/
267 SG_BEGIN_DECL()
268 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init();
269 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
270 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
271 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
272 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
273 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
274
275 XBT_PUBLIC(smx_cond_t) simcall_cond_init();
276 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
277 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
278 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
279 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
280 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
281 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
282
283 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
284 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
285 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
286 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
287 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
288 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
289 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
290
291 /*****************************   File   **********************************/
292 XBT_PUBLIC(sg_size_t) simcall_file_read(surf_file_t fd, sg_size_t size, sg_host_t host);
293 XBT_PUBLIC(sg_size_t) simcall_file_write(surf_file_t fd, sg_size_t size, sg_host_t host);
294 XBT_PUBLIC(surf_file_t) simcall_file_open(const char* mount, const char* path, sg_storage_t st);
295 XBT_PUBLIC(int) simcall_file_close(surf_file_t fd, sg_host_t host);
296 /************************** MC simcalls   **********************************/
297 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
298
299 SG_END_DECL()
300
301 #endif                          /* _SIMIX_SIMIX_H */