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"
25 /** @brief Process datatype
26 @ingroup simix_process_management
28 A process may be defined as a <em>code</em>, with some <em>private
29 data</em>, executing in a <em>location</em>.
30 \see m_process_management
39 typedef simgrid::simix::Context *smx_context_t;
40 typedef simgrid::simix::Process *smx_process_t;
44 typedef struct s_smx_context *smx_context_t;
45 typedef struct s_smx_process *smx_process_t;
53 /**************************** Scalar Values **********************************/
55 typedef union u_smx_scalar u_smx_scalar_t;
57 /* ******************************** Host ************************************ */
58 /** @brief Host datatype
59 @ingroup simix_host_management
61 A <em>location</em> (or <em>host</em>) is any possible place where
62 a process may run. Thus it is represented as a <em>physical
63 resource with computing capabilities</em>, some <em>mailboxes</em>
64 to enable running process to communicate with remote ones, and
65 some <em>private data</em> that can be only accessed by local
68 \see m_host_management
77 SIMIX_SRC_HOST_FAILURE,
78 SIMIX_DST_HOST_FAILURE,
85 /* ******************************** Synchro ************************************ */
87 * \ingroup simix_synchro_management
89 typedef struct s_smx_mutex *smx_mutex_t;
91 * \ingroup simix_synchro_management
93 typedef struct s_smx_cond *smx_cond_t;
95 * \ingroup simix_synchro_management
97 typedef struct s_smx_sem *smx_sem_t;
99 /********************************** File *************************************/
100 typedef struct s_smx_file *smx_file_t;
102 /********************************** Storage *************************************/
103 typedef xbt_dictelm_t smx_storage_t;
104 typedef struct s_smx_storage_priv *smx_storage_priv_t;
106 /* ****************************** Process *********************************** */
109 SMX_EXIT_SUCCESS = 0,
111 } smx_process_exit_status_t;
116 * Type of function that creates a process.
117 * The function must accept the following parameters:
118 * void* process: the process created will be stored there
119 * const char *name: a name for the object. It is for user-level information and can be NULL
120 * xbt_main_func_t code: is a function describing the behavior of the process
121 * void *data: data a pointer to any data one may want to attach to the new object.
122 * sg_host_t host: the location where the new process is executed
123 * int argc, char **argv: parameters passed to code
124 * xbt_dict_t pros: properties
126 typedef smx_process_t (*smx_creation_func_t) (
127 /* name */ const char*,
128 /* code */ xbt_main_func_t,
129 /* userdata */ void*,
130 /* hostname */ const char*,
131 /* kill_time */ double,
134 /* props */ xbt_dict_t,
135 /* auto_restart */ int,
136 /* parent_process */ smx_process_t);
139 /******************************* Networking ***********************************/
141 * \ingroup simix_mbox_management
143 typedef struct s_smx_mailbox *smx_mailbox_t;
145 /* Process creation/destruction callbacks */
146 typedef void (*void_pfn_smxprocess_t) (smx_process_t);
147 /* for auto-restart function */
148 typedef void (*void_pfn_sghost_t) (sg_host_t);
150 extern int smx_context_stack_size;
151 extern int smx_context_stack_size_was_set;
152 extern int smx_context_guard_size;
153 extern int smx_context_guard_size_was_set;
155 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable(void);
156 XBT_PUBLIC(smx_process_t) SIMIX_process_from_PID(int PID);
157 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar(void);
160 XBT_PUBLIC(int) SIMIX_context_is_parallel(void);
161 XBT_PUBLIC(int) SIMIX_context_get_nthreads(void);
162 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
163 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold(void);
164 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
165 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode(void);
166 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
167 XBT_PUBLIC(int) SIMIX_is_maestro();
170 /********************************** Global ************************************/
171 /* Initialization and exit */
172 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
174 /* Set to execute in the maestro
176 * If no maestro code is registered (the default), the main thread
177 * is assumed to be the maestro. */
178 XBT_PUBLIC(void) SIMIX_set_maestro(void (*code)(void*), void* data);
180 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
181 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
182 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t function);
184 /* Simulation execution */
185 XBT_PUBLIC(void) SIMIX_run(void);
186 XBT_PUBLIC(double) SIMIX_get_clock(void);
188 /* Timer functions FIXME: should these be public? */
189 typedef struct s_smx_timer* smx_timer_t;
191 XBT_PUBLIC(smx_timer_t) SIMIX_timer_set(double date, void (*function)(void*), void *arg);
192 XBT_PUBLIC(void) SIMIX_timer_remove(smx_timer_t timer);
193 XBT_PUBLIC(double) SIMIX_timer_next(void);
194 XBT_PUBLIC(double) SIMIX_timer_get_date(smx_timer_t timer);
196 XBT_PUBLIC(void) SIMIX_display_process_status(void);
198 /******************************* Environment **********************************/
199 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
201 /******************************** Deployment **********************************/
203 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
204 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
205 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
206 XBT_PUBLIC(void) SIMIX_init_application(void);
207 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
209 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
210 const char *process_function,
211 xbt_dynar_t arguments,
212 double process_start_time,
213 double process_kill_time);
215 /*********************************** Host *************************************/
216 /* Functions for running a process in main()
218 * 1. create the maestro process
219 * 2. attach (create a context and wait for maestro to give control back to you)
220 * 3. do you process job
221 * 4. detach (this waits for the simulation to terminate)
224 XBT_PUBLIC(void) SIMIX_maestro_create(void (*code)(void*), void* data);
225 XBT_PUBLIC(smx_process_t) SIMIX_process_attach(
228 const char* hostname,
229 xbt_dict_t properties,
230 smx_process_t parent_process);
231 XBT_PUBLIC(void) SIMIX_process_detach(void);
233 /*********************************** Host *************************************/
234 XBT_PUBLIC(sg_host_t) SIMIX_host_self(void);
235 XBT_PUBLIC(const char*) SIMIX_host_self_get_name(void);
236 XBT_PUBLIC(void) SIMIX_host_on(sg_host_t host);
237 XBT_PUBLIC(void) SIMIX_host_off(sg_host_t host, smx_process_t issuer);
238 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
239 XBT_PUBLIC(void*) SIMIX_host_self_get_data(void);
241 /********************************* Process ************************************/
242 XBT_PUBLIC(int) SIMIX_process_count(void);
243 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
244 XBT_PUBLIC(const char*) SIMIX_process_self_get_name(void);
245 XBT_PUBLIC(void) SIMIX_process_self_set_data(void *data);
246 XBT_PUBLIC(void*) SIMIX_process_self_get_data(void);
247 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_process_t);
248 XBT_PUBLIC(void) SIMIX_process_set_context(smx_process_t p,smx_context_t c);
249 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_process_t process);
250 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_process_t process);
251 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
252 XBT_PUBLIC(xbt_main_func_t) SIMIX_process_get_code(void);
254 /****************************** Communication *********************************/
255 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_synchro_t, void*, size_t));
256 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
257 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_synchro_t comm, void* buff, size_t buff_size);
259 XBT_PUBLIC(smx_synchro_t) SIMIX_comm_get_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
260 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
261 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_mailbox_t mbox, int (*match_fun)(void*, void*), void* data);
262 XBT_PUBLIC(void) SIMIX_comm_finish(smx_synchro_t synchro);
264 /******************************************************************************/
266 /******************************************************************************/
267 /* These functions are a system call-like interface to the simulation kernel. */
268 /* They can also be called from maestro's context, and they are thread safe. */
269 /******************************************************************************/
271 XBT_PUBLIC(void) simcall_call(smx_process_t process);
273 /******************************* Host simcalls ********************************/
274 XBT_PUBLIC(void) simcall_host_set_data(sg_host_t host, void *data);
276 XBT_PUBLIC(smx_synchro_t) simcall_execution_start(const char *name,
278 double priority, double bound, unsigned long affinity_mask);
279 XBT_PUBLIC(smx_synchro_t) simcall_execution_parallel_start(const char *name,
281 sg_host_t *host_list,
282 double *flops_amount,
283 double *bytes_amount,
286 XBT_PUBLIC(void) simcall_execution_cancel(smx_synchro_t execution);
287 XBT_PUBLIC(void) simcall_execution_set_priority(smx_synchro_t execution, double priority);
288 XBT_PUBLIC(void) simcall_execution_set_bound(smx_synchro_t execution, double bound);
289 XBT_PUBLIC(void) simcall_execution_set_affinity(smx_synchro_t execution, sg_host_t host, unsigned long mask);
290 XBT_PUBLIC(e_smx_state_t) simcall_execution_wait(smx_synchro_t execution);
292 /******************************* VM simcalls ********************************/
293 // Create the vm_workstation at the SURF level
294 XBT_PUBLIC(void*) simcall_vm_create(const char *name, sg_host_t host);
295 XBT_PUBLIC(int) simcall_vm_get_state(sg_host_t vm);
296 XBT_PUBLIC(void) simcall_vm_start(sg_host_t vm);
297 XBT_PUBLIC(void) simcall_vm_migrate(sg_host_t vm, sg_host_t dst_pm);
298 XBT_PUBLIC(void *) simcall_vm_get_pm(sg_host_t vm);
299 XBT_PUBLIC(void) simcall_vm_set_bound(sg_host_t vm, double bound);
300 XBT_PUBLIC(void) simcall_vm_set_affinity(sg_host_t vm, sg_host_t pm, unsigned long mask);
301 XBT_PUBLIC(void) simcall_vm_resume(sg_host_t vm);
302 XBT_PUBLIC(void) simcall_vm_migratefrom_resumeto(sg_host_t vm, sg_host_t src_pm, sg_host_t dst_pm);
303 XBT_PUBLIC(void) simcall_vm_save(sg_host_t vm);
304 XBT_PUBLIC(void) simcall_vm_restore(sg_host_t vm);
305 XBT_PUBLIC(void) simcall_vm_suspend(sg_host_t vm);
306 XBT_PUBLIC(void) simcall_vm_destroy(sg_host_t vm);
307 XBT_PUBLIC(void) simcall_vm_shutdown(sg_host_t vm);
309 /**************************** Process simcalls ********************************/
310 /* Constructor and Destructor */
311 XBT_PUBLIC(smx_process_t) simcall_process_create(const char *name,
312 xbt_main_func_t code,
314 const char *hostname,
316 int argc, char **argv,
317 xbt_dict_t properties,
320 XBT_PUBLIC(void) simcall_process_kill(smx_process_t process);
321 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
322 XBT_PUBLIC(void) SIMIX_process_throw(smx_process_t process, xbt_errcat_t cat, int value, const char *msg);
325 /* Process handling */
326 XBT_PUBLIC(void) simcall_process_cleanup(smx_process_t process);
327 XBT_PUBLIC(void) simcall_process_suspend(smx_process_t process);
328 XBT_PUBLIC(void) simcall_process_resume(smx_process_t process);
330 /* Getters and Setters */
331 XBT_PUBLIC(int) simcall_process_count(void);
332 XBT_PUBLIC(void *) simcall_process_get_data(smx_process_t process);
333 XBT_PUBLIC(void) simcall_process_set_data(smx_process_t process, void *data);
334 XBT_PUBLIC(void) simcall_process_set_host(smx_process_t process, sg_host_t dest);
335 XBT_PUBLIC(sg_host_t) simcall_process_get_host(smx_process_t process);
336 XBT_PUBLIC(const char *) simcall_process_get_name(smx_process_t process);
337 XBT_PUBLIC(int) simcall_process_get_PID(smx_process_t process);
338 XBT_PUBLIC(int) simcall_process_get_PPID(smx_process_t process);
339 XBT_PUBLIC(int) simcall_process_is_suspended(smx_process_t process);
340 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_process_t host);
341 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_process_t process, double kill_time);
342 XBT_PUBLIC(double) simcall_process_get_kill_time(smx_process_t process);
343 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_pvoid_t fun, void *data);
344 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart);
345 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process);
346 XBT_PUBLIC(void) simcall_process_join(smx_process_t process, double timeout);
348 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
350 /************************** Comunication simcalls *****************************/
351 /***** Rendez-vous points *****/
353 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_create(const char *name);
354 XBT_PUBLIC(smx_mailbox_t) simcall_mbox_get_by_name(const char *name);
355 XBT_PUBLIC(smx_synchro_t) simcall_mbox_front(smx_mailbox_t mbox);
356 XBT_PUBLIC(void) simcall_mbox_set_receiver(smx_mailbox_t mbox , smx_process_t process);
358 /***** Communication simcalls *****/
360 XBT_PUBLIC(void) simcall_comm_send(smx_process_t sender, smx_mailbox_t mbox, double task_size,
361 double rate, void *src_buff,
362 size_t src_buff_size,
363 int (*match_fun)(void *, void *, smx_synchro_t),
364 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
365 void *data, double timeout);
367 XBT_PUBLIC(smx_synchro_t) simcall_comm_isend(smx_process_t sender, smx_mailbox_t mbox,
369 double rate, void *src_buff,
370 size_t src_buff_size,
371 int (*match_fun)(void *, void *, smx_synchro_t),
372 void (*clean_fun)(void *),
373 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
374 void *data, int detached);
376 XBT_PUBLIC(void) simcall_comm_recv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff,
377 size_t * dst_buff_size,
378 int (*match_fun)(void *, void *, smx_synchro_t),
379 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
380 void *data, double timeout, double rate);
382 XBT_PUBLIC(smx_synchro_t) simcall_comm_irecv(smx_process_t receiver, smx_mailbox_t mbox, void *dst_buff,
383 size_t * dst_buff_size,
384 int (*match_fun)(void *, void *, smx_synchro_t),
385 void (*copy_data_fun)(smx_synchro_t, void*, size_t),
386 void *data, double rate);
388 XBT_PUBLIC(smx_synchro_t) simcall_comm_iprobe(smx_mailbox_t mbox, int type, int src, int tag,
389 int (*match_fun)(void *, void *, smx_synchro_t), void *data);
390 XBT_PUBLIC(void) simcall_comm_cancel(smx_synchro_t comm);
392 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
393 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms);
394 XBT_PUBLIC(void) simcall_comm_wait(smx_synchro_t comm, double timeout);
395 XBT_PUBLIC(int) simcall_comm_test(smx_synchro_t comm);
396 XBT_PUBLIC(int) simcall_comm_testany(xbt_dynar_t comms);
398 /************************** Tracing handling **********************************/
399 XBT_PUBLIC(void) simcall_set_category(smx_synchro_t synchro, const char *category);
401 /************************** Synchro simcalls **********************************/
402 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init(void);
403 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
404 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
405 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
406 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
408 XBT_PUBLIC(smx_cond_t) simcall_cond_init(void);
409 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
410 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
411 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
412 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond,
414 double max_duration);
415 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
417 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
418 XBT_PUBLIC(void) SIMIX_sem_destroy(smx_sem_t sem);
419 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
420 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
421 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
422 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem,
423 double max_duration);
424 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
426 /***************************** File **********************************/
427 XBT_PUBLIC(void *) simcall_file_get_data(smx_file_t fd);
428 XBT_PUBLIC(void) simcall_file_set_data(smx_file_t fd, void *data);
429 XBT_PUBLIC(sg_size_t) simcall_file_read(smx_file_t fd, sg_size_t size, sg_host_t host);
430 XBT_PUBLIC(sg_size_t) simcall_file_write(smx_file_t fd, sg_size_t size, sg_host_t host);
431 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* fullpath, sg_host_t host);
432 XBT_PUBLIC(int) simcall_file_close(smx_file_t fd, sg_host_t host);
433 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd, sg_host_t host);
434 XBT_PUBLIC(sg_size_t) simcall_file_get_size(smx_file_t fd);
435 XBT_PUBLIC(xbt_dynar_t) simcall_file_get_info(smx_file_t fd);
436 XBT_PUBLIC(sg_size_t) simcall_file_tell(smx_file_t fd);
437 XBT_PUBLIC(int) simcall_file_seek(smx_file_t fd, sg_offset_t offset, int origin);
438 XBT_PUBLIC(int) simcall_file_move(smx_file_t fd, const char* fullpath);
439 /***************************** Storage **********************************/
440 XBT_PUBLIC(sg_size_t) simcall_storage_get_free_size (smx_storage_t storage);
441 XBT_PUBLIC(sg_size_t) simcall_storage_get_used_size (smx_storage_t storage);
442 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_properties(smx_storage_t storage);
443 XBT_PUBLIC(void*) SIMIX_storage_get_data(smx_storage_t storage);
444 XBT_PUBLIC(void) SIMIX_storage_set_data(smx_storage_t storage, void *data);
445 XBT_PUBLIC(xbt_dict_t) SIMIX_storage_get_content(smx_storage_t storage);
446 XBT_PUBLIC(xbt_dict_t) simcall_storage_get_content(smx_storage_t storage);
447 XBT_PUBLIC(const char*) SIMIX_storage_get_name(smx_storage_t storage);
448 XBT_PUBLIC(sg_size_t) SIMIX_storage_get_size(smx_storage_t storage);
449 XBT_PUBLIC(const char*) SIMIX_storage_get_host(smx_storage_t storage);
450 /************************** AS router **********************************/
451 XBT_PUBLIC(xbt_dict_t) SIMIX_asr_get_properties(const char *name);
452 /************************** AS router simcalls ***************************/
453 XBT_PUBLIC(xbt_dict_t) simcall_asr_get_properties(const char *name);
455 /************************** MC simcalls **********************************/
456 XBT_PUBLIC(int) simcall_mc_random(int min, int max);
459 #endif /* _SIMIX_SIMIX_H */