Logo AND Algorithmique Numérique Distribuée

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