1 /* Copyright (c) 2007-2010, 2012-2015. The SimGrid Team.
2 * All rights reserved. */
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. */
13 #include "xbt/function_types.h"
14 #include "xbt/parmap.h"
16 #include "simgrid/datatypes.h"
17 #include "simgrid/host.h"
30 /** @brief Process datatype
31 @ingroup simix_process_management
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
43 typedef simgrid::kernel::context::Context *smx_context_t;
44 typedef simgrid::simix::ActorImpl *smx_actor_t;
45 typedef simgrid::simix::Mutex *smx_mutex_t;
46 typedef simgrid::simix::Mailbox *smx_mailbox_t;
50 typedef struct s_smx_context *smx_context_t;
51 typedef struct s_smx_actor *smx_actor_t;
52 typedef struct s_smx_mutex *smx_mutex_t;
53 typedef struct s_smx_mailbox *smx_mailbox_t;
57 /**************************** Scalar Values **********************************/
59 typedef union u_smx_scalar u_smx_scalar_t;
61 /* ******************************** Host ************************************ */
62 /** @brief Host datatype
63 @ingroup simix_host_management
65 A <em>location</em> (or <em>host</em>) is any possible place where
66 a process may run. Thus it is represented as a <em>physical
67 resource with computing capabilities</em>, some <em>mailboxes</em>
68 to enable running process to communicate with remote ones, and
69 some <em>private data</em> that can be only accessed by local
72 \see m_host_management
81 SIMIX_SRC_HOST_FAILURE,
82 SIMIX_DST_HOST_FAILURE,
89 /* ******************************** Synchro ************************************ */
92 * \ingroup simix_synchro_management
94 typedef struct s_smx_cond *smx_cond_t;
96 * \ingroup simix_synchro_management
98 typedef struct s_smx_sem *smx_sem_t;
100 /********************************** File *************************************/
101 typedef struct s_smx_file *smx_file_t;
103 /********************************** Storage *************************************/
104 typedef xbt_dictelm_t smx_storage_t;
105 typedef struct s_smx_storage_priv *smx_storage_priv_t;
107 /* ****************************** Process *********************************** */
110 SMX_EXIT_SUCCESS = 0,
112 } smx_process_exit_status_t;
115 /******************************* Networking ***********************************/
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);
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;
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();
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();
144 /********************************** Global ************************************/
145 /* Initialization and exit */
146 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
148 /* Set to execute in the maestro
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);
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);
157 /* Simulation execution */
158 XBT_PUBLIC(void) SIMIX_run();
159 XBT_PUBLIC(double) SIMIX_get_clock();
161 /* Timer functions FIXME: should these be public? */
162 typedef struct s_smx_timer* smx_timer_t;
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);
169 XBT_PUBLIC(void) SIMIX_display_process_status();
171 /******************************* Environment **********************************/
172 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
174 /******************************** Deployment **********************************/
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);
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);
187 /*********************************** Host *************************************/
188 /* Functions for running a process in main()
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)
196 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
197 XBT_PUBLIC(smx_actor_t) SIMIX_process_attach(
200 const char* hostname,
201 xbt_dict_t properties,
202 smx_actor_t parent_process);
203 XBT_PUBLIC(void) SIMIX_process_detach();
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_on(sg_host_t host);
209 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_actor_t issuer);
210 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
211 XBT_PUBLIC(void*) SIMIX_host_self_get_data();
213 /********************************* Process ************************************/
214 XBT_PUBLIC(smx_actor_t) SIMIX_process_ref(smx_actor_t process);
215 XBT_PUBLIC(void) SIMIX_process_unref(smx_actor_t process);
216 XBT_PUBLIC(int) SIMIX_process_count();
217 XBT_PUBLIC(smx_actor_t) SIMIX_process_self();
218 XBT_PUBLIC(const char*) SIMIX_process_self_get_name();
219 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
220 XBT_PUBLIC(void*) SIMIX_process_self_get_data();
221 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_actor_t process);
222 XBT_PUBLIC(void) SIMIX_process_set_context(smx_actor_t p,smx_context_t c);
223 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_actor_t process);
224 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_actor_t process);
225 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
227 /****************************** Communication *********************************/
228 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t));
229 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_activity_t comm, void* buff, size_t buff_size);
230 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_activity_t comm, void* buff, size_t buff_size);
232 XBT_PUBLIC(smx_activity_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
233 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
234 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
235 XBT_PUBLIC(void) SIMIX_comm_finish(smx_activity_t synchro);
237 /******************************************************************************/
239 /******************************************************************************/
240 /* These functions are a system call-like interface to the simulation kernel. */
241 /* They can also be called from maestro's context, and they are thread safe. */
242 /******************************************************************************/
244 XBT_PUBLIC(void) simcall_call(smx_actor_t process);
246 /******************************* Host simcalls ********************************/
247 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
249 XBT_PUBLIC(smx_activity_t) simcall_execution_start(const char *name,
251 double priority, double bound);
252 XBT_PUBLIC(smx_activity_t) simcall_execution_parallel_start(const char *name,
254 sg_host_t *host_list,
255 double *flops_amount,
256 double *bytes_amount,
259 XBT_PUBLIC(void) simcall_execution_cancel(smx_activity_t execution);
260 XBT_PUBLIC(void) simcall_execution_set_priority(smx_activity_t execution, double priority);
261 XBT_PUBLIC(void) simcall_execution_set_bound(smx_activity_t execution, double bound);
262 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_activity_t execution);
264 /******************************* VM simcalls ********************************/
265 // Create the vm_workstation at the SURF level
266 XBT_PUBLIC(void*) simcall_vm_create(const char *name, sg_host_t host);
267 XBT_PUBLIC(int) simcall_vm_get_state(sg_host_t vm);
268 XBT_PUBLIC(void) simcall_vm_start(sg_host_t vm);
269 XBT_PUBLIC(void) simcall_vm_migrate(sg_host_t vm, sg_host_t dst_pm);
270 XBT_PUBLIC(void *) simcall_vm_get_pm(sg_host_t vm);
271 XBT_PUBLIC(void) simcall_vm_set_bound(sg_host_t vm, double bound);
272 XBT_PUBLIC(void) simcall_vm_resume(sg_host_t vm);
273 XBT_PUBLIC(void) simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm);
274 XBT_PUBLIC(void) simcall_vm_save(sg_host_t vm);
275 XBT_PUBLIC(void) simcall_vm_restore(sg_host_t vm);
276 XBT_PUBLIC(void) simcall_vm_suspend(sg_host_t vm);
277 XBT_PUBLIC(void) simcall_vm_destroy(sg_host_t vm);
278 XBT_PUBLIC(void) simcall_vm_shutdown(sg_host_t vm);
280 /**************************** Process simcalls ********************************/
281 /* Constructor and Destructor */
282 XBT_PUBLIC(smx_actor_t) simcall_process_create(const char *name,
283 xbt_main_func_t code,
285 const char *hostname,
287 int argc, char **argv,
288 xbt_dict_t properties,
291 XBT_PUBLIC(void) simcall_process_kill(smx_actor_t process);
292 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
293 XBT_PUBLIC(void) SIMIX_process_throw(smx_actor_t process, xbt_errcat_t cat, int value, const char *msg);
296 /* Process handling */
297 XBT_PUBLIC(void) simcall_process_cleanup(smx_actor_t process);
298 XBT_PUBLIC(void) simcall_process_suspend(smx_actor_t process);
299 XBT_PUBLIC(void) simcall_process_resume(smx_actor_t process);
301 /* Getters and Setters */
302 XBT_PUBLIC(int) simcall_process_count();
303 XBT_PUBLIC(void *) simcall_process_get_data(smx_actor_t process);
304 XBT_PUBLIC(void) simcall_process_set_data(smx_actor_t process, void *data);
305 XBT_PUBLIC(void) simcall_process_set_host(smx_actor_t process, sg_host_t dest);
306 XBT_PUBLIC(int) simcall_process_is_suspended(smx_actor_t process);
307 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_actor_t host);
308 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_actor_t process, double kill_time);
309 XBT_PUBLIC(double) simcall_process_get_kill_time(smx_actor_t process);
310 XBT_PUBLIC(void) simcall_process_on_exit(smx_actor_t process, int_f_pvoid_pvoid_t fun, void *data);
311 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_actor_t process, int auto_restart);
312 XBT_PUBLIC(smx_actor_t) simcall_process_restart(smx_actor_t process);
313 XBT_PUBLIC(void) simcall_process_join(smx_actor_t process, double timeout);
315 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
317 /************************** Comunication simcalls *****************************/
318 /***** Rendez-vous points *****/
320 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_create(const char *name);
321 XBT_PUBLIC(void) simcall_mbox_set_receiver(smx_mailbox_t mbox , smx_actor_t process);
323 /***** Communication simcalls *****/
325 XBT_PUBLIC(void) simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
326 double rate, void *src_buff,
327 size_t src_buff_size,
328 int (*match_fun)(void *, void *, smx_activity_t),
329 void (*copy_data_fun)(smx_activity_t, void*, size_t),
330 void *data, double timeout);
332 XBT_PUBLIC(smx_activity_t) simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox,
334 double rate, void *src_buff,
335 size_t src_buff_size,
336 int (*match_fun)(void *, void *, smx_activity_t),
337 void (*clean_fun)(void *),
338 void (*copy_data_fun)(smx_activity_t, void*, size_t),
339 void *data, int detached);
341 XBT_PUBLIC(void) simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff,
342 size_t * dst_buff_size,
343 int (*match_fun)(void *, void *, smx_activity_t),
344 void (*copy_data_fun)(smx_activity_t, void*, size_t),
345 void *data, double timeout, double rate);
347 XBT_PUBLIC(smx_activity_t) simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void *dst_buff,
348 size_t * dst_buff_size,
349 int (*match_fun)(void *, void *, smx_activity_t),
350 void (*copy_data_fun)(smx_activity_t, void*, size_t),
351 void *data, double rate);
353 XBT_PUBLIC(smx_activity_t) simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
354 int (*match_fun)(void *, void *, smx_activity_t), void *data);
355 XBT_PUBLIC(void) simcall_comm_cancel(smx_activity_t comm);
357 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
358 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms, double timeout);
359 XBT_PUBLIC(void) simcall_comm_wait(smx_activity_t comm, double timeout);
360 XBT_PUBLIC(int) simcall_comm_test(smx_activity_t comm);
361 XBT_PUBLIC(int) simcall_comm_testany(smx_activity_t* comms, size_t count);
363 /************************** Tracing handling **********************************/
364 XBT_PUBLIC(void) simcall_set_category(smx_activity_t synchro, const char *category);
366 /************************** Synchro simcalls **********************************/
367 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init();
368 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_ref(smx_mutex_t mutex);
369 XBT_PUBLIC(void) SIMIX_mutex_unref(smx_mutex_t mutex);
370 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
371 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
372 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
374 XBT_PUBLIC(smx_cond_t) simcall_cond_init();
375 XBT_PUBLIC(void) SIMIX_cond_unref(smx_cond_t cond);
376 XBT_PUBLIC(smx_cond_t) SIMIX_cond_ref(smx_cond_t cond);
377 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
378 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
379 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double max_duration);
380 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
382 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
383 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
384 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
385 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
386 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
387 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem, double max_duration);
388 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
390 /***************************** File **********************************/
391 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
392 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
393 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
394 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
395 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* fullpath, sg_host_t host);
396 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
397 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
398 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
399 XBT_PUBLIC(xbt_dynar_t) simcall_file_get_info(smx_file_t fd);
400 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
401 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
402 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
403 /***************************** Storage **********************************/
404 XBT_PUBLIC(sg_size_t) simcall_storage_get_free_size (smx_storage_t storage);
405 XBT_PUBLIC(sg_size_t) simcall_storage_get_used_size (smx_storage_t storage);
406 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_properties(smx_storage_t storage);
407 XBT_PUBLIC(void*) SIMIX_storage_get_data(smx_storage_t storage);
408 XBT_PUBLIC(void) SIMIX_storage_set_data(smx_storage_t storage, void *data);
409 XBT_PUBLIC(xbt_dict_t) SIMIX_storage_get_content(smx_storage_t storage);
410 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_content(smx_storage_t storage);
411 XBT_PUBLIC(const char*) SIMIX_storage_get_name(smx_storage_t storage);
412 XBT_PUBLIC(sg_size_t) SIMIX_storage_get_size(smx_storage_t storage);
413 XBT_PUBLIC(const char*) SIMIX_storage_get_host(smx_storage_t storage);
414 /************************** AS router **********************************/
415 XBT_PUBLIC(xbt_dict_t) SIMIX_asr_get_properties(const char *name);
416 /************************** AS router simcalls ***************************/
417 XBT_PUBLIC(xbt_dict_t) simcall_asr_get_properties(const char *name);
419 /************************** MC simcalls **********************************/
420 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
423 #endif /* _SIMIX_SIMIX_H */