Logo AND Algorithmique Numérique Distribuée

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