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