Logo AND Algorithmique Numérique Distribuée

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