Logo AND Algorithmique Numérique Distribuée

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