Logo AND Algorithmique Numérique Distribuée

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