Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
kill kill simcall
[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 #include <map>
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(smx_actor_t) SIMIX_process_from_PID(aid_t PID);
76
77 /* parallelism */
78 XBT_PUBLIC(int) SIMIX_context_is_parallel();
79 XBT_PUBLIC(int) SIMIX_context_get_nthreads();
80 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
81 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold();
82 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
83 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode();
84 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
85 XBT_PUBLIC(int) SIMIX_is_maestro();
86
87
88 /********************************** Global ************************************/
89 /* Initialization and exit */
90 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
91
92 /* Set to execute in the maestro
93  *
94  * If no maestro code is registered (the default), the main thread
95  * is assumed to be the maestro. */
96 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
97
98 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
99 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
100
101 /* Simulation execution */
102 XBT_PUBLIC(void) SIMIX_run();
103 XBT_PUBLIC(double) SIMIX_get_clock();
104
105 /* Timer functions FIXME: should these be public? */
106 typedef struct s_smx_timer* smx_timer_t;
107
108 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
109 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
110 XBT_PUBLIC(double) SIMIX_timer_next();
111 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
112
113 XBT_PUBLIC(void) SIMIX_display_process_status();
114
115 /******************************* Environment **********************************/
116 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
117
118 /******************************** Deployment **********************************/
119
120 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
121 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
122 XBT_PUBLIC(void) SIMIX_init_application();
123 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
124
125 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
126                                             const char *process_function,
127                                             xbt_dynar_t arguments,
128                                             double process_start_time,
129                                             double process_kill_time);
130
131 /*********************************** Host *************************************/
132 /* Functions for running a process in main()
133  *
134  *  1. create the maestro process
135  *  2. attach (create a context and wait for maestro to give control back to you)
136  *  3. do you process job
137  *  4. detach (this waits for the simulation to terminate)
138  */
139
140 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
141 XBT_PUBLIC(smx_actor_t)
142 SIMIX_process_attach(const char* name, void* data, const char* hostname, std::map<std::string, std::string>* properties,
143                      smx_actor_t parent_process);
144 XBT_PUBLIC(void) SIMIX_process_detach();
145
146 /*********************************** Host *************************************/
147 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
148 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
149 XBT_PUBLIC(void*) SIMIX_host_self_get_data();
150
151 /********************************* Process ************************************/
152 XBT_PUBLIC(int) SIMIX_process_count();
153 XBT_PUBLIC(smx_actor_t) SIMIX_process_self();
154 XBT_PUBLIC(const char*) SIMIX_process_self_get_name();
155 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
156 XBT_PUBLIC(void*) SIMIX_process_self_get_data();
157 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_actor_t process);
158 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_actor_t process);
159 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
160
161 SG_END_DECL()
162
163 /****************************** Communication *********************************/
164 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t));
165 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
166 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
167
168 XBT_PUBLIC(smx_activity_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
169 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
170 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
171 XBT_PUBLIC(void) SIMIX_comm_finish(smx_activity_t synchro);
172
173 /******************************************************************************/
174 /*                            SIMIX simcalls                                  */
175 /******************************************************************************/
176 /* These functions are a system call-like interface to the simulation kernel. */
177 /* They can also be called from maestro's context, and they are thread safe.  */
178 /******************************************************************************/
179
180 XBT_PUBLIC(void) simcall_call(smx_actor_t process);
181
182 /******************************* Host simcalls ********************************/
183 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
184 XBT_PUBLIC(smx_activity_t) simcall_execution_start(const char *name,
185                                                 double flops_amount,
186                                                 double priority, double bound);
187 XBT_PUBLIC(smx_activity_t)
188 simcall_execution_parallel_start(const char* name, int host_nb, sg_host_t* host_list, double* flops_amount,
189                                  double* bytes_amount, double rate, double timeout);
190 XBT_PUBLIC(void) simcall_execution_cancel(smx_activity_t execution);
191 XBT_PUBLIC(void) simcall_execution_set_priority(smx_activity_t execution, double priority);
192 XBT_PUBLIC(void) simcall_execution_set_bound(smx_activity_t execution, double bound);
193 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_activity_t execution);
194
195 /**************************** Process simcalls ********************************/
196 SG_BEGIN_DECL()
197 /* Constructor and Destructor */
198 XBT_PUBLIC(smx_actor_t)
199 simcall_process_create(const char* name, xbt_main_func_t code, void* data, sg_host_t host, int argc, char** argv,
200                        std::map<std::string, std::string>* properties);
201
202 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
203 XBT_PUBLIC(void) SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg);
204
205
206 /* Process handling */
207 XBT_PUBLIC(void) simcall_process_cleanup(smx_actor_t process);
208 XBT_PUBLIC(void) simcall_process_suspend(smx_actor_t process);
209
210 /* Getters and Setters */
211 XBT_PUBLIC(int) simcall_process_count();
212 XBT_PUBLIC(void) simcall_process_set_data(smx_actor_t process, void *data);
213 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_actor_t process, double kill_time);
214 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
215 XBT_PUBLIC(void) simcall_process_join(smx_actor_t process, double timeout);
216 /* Sleep control */
217 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
218 SG_END_DECL()
219
220 /************************** Comunication simcalls *****************************/
221
222 XBT_PUBLIC(void)
223 simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
224                   size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
225                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout);
226
227 XBT_PUBLIC(smx_activity_t)
228 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
229                    size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
230                    void (*clean_fun)(void*), void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data,
231                    int detached);
232
233 XBT_PUBLIC(void)
234 simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
235                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
236                   void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double timeout, double rate);
237
238 XBT_PUBLIC(smx_activity_t)
239 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
240                    int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
241                    void (*copy_data_fun)(smx_activity_t, void*, size_t), void* data, double rate);
242
243 XBT_PUBLIC(smx_activity_t)
244 simcall_comm_iprobe(smx_mailbox_t mbox, int type, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
245                     void* data);
246 XBT_PUBLIC(void) simcall_comm_cancel(smx_activity_t comm);
247
248 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
249 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms, double timeout);
250 XBT_PUBLIC(void) simcall_comm_wait(smx_activity_t comm, double timeout);
251 XBT_PUBLIC(int) simcall_comm_test(smx_activity_t comm);
252 XBT_PUBLIC(int) simcall_comm_testany(smx_activity_t* comms, size_t count);
253
254 /************************** Tracing handling **********************************/
255 XBT_PUBLIC(void) simcall_set_category(smx_activity_t synchro, const char *category);
256
257 /************************** Synchro simcalls **********************************/
258 SG_BEGIN_DECL()
259 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init();
260 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
261 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
262 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
263 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
264 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
265
266 XBT_PUBLIC(smx_cond_t) simcall_cond_init();
267 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
268 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
269 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
270 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
271 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
272 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
273
274 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
275 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
276 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
277
278 /*****************************   File   **********************************/
279 XBT_PUBLIC(sg_size_t) simcall_file_read(surf_file_t fd, sg_size_t size);
280 XBT_PUBLIC(sg_size_t) simcall_file_write(surf_file_t fd, sg_size_t size);
281 /************************** MC simcalls   **********************************/
282 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
283
284 SG_END_DECL()
285
286 #endif                          /* _SIMIX_SIMIX_H */