1 /* Copyright (c) 2007, 2008, 2009, 2010. 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/file_stat.h"
14 #include "xbt/function_types.h"
15 #include "xbt/parmap.h"
20 /**************************** Scalar Values **********************************/
22 typedef union u_smx_scalar u_smx_scalar_t;
24 /* ******************************** Host ************************************ */
25 /** @brief Host datatype
26 @ingroup simix_host_management
28 A <em>location</em> (or <em>host</em>) is any possible place where
29 a process may run. Thus it is represented as a <em>physical
30 resource with computing capabilities</em>, some <em>mailboxes</em>
31 to enable running process to communicate with remote ones, and
32 some <em>private data</em> that can be only accessed by local
35 \see m_host_management
37 typedef xbt_dictelm_t smx_host_t;
38 typedef struct s_smx_host_priv *smx_host_priv_t;
46 SIMIX_SRC_HOST_FAILURE,
47 SIMIX_DST_HOST_FAILURE,
55 typedef struct s_smx_timer* smx_timer_t;
57 /* ******************************** Synchro ************************************ */
59 * \ingroup simix_synchro_management
61 typedef struct s_smx_mutex *smx_mutex_t;
63 * \ingroup simix_synchro_management
65 typedef struct s_smx_cond *smx_cond_t;
67 * \ingroup simix_synchro_management
69 typedef struct s_smx_sem *smx_sem_t;
71 /********************************** File *************************************/
72 typedef struct s_smx_file *smx_file_t;
73 typedef struct s_smx_stat *smx_stat_t;
75 /********************************** Action *************************************/
76 typedef struct s_smx_action *smx_action_t; /* FIXME: replace by specialized action handlers */
80 /* ****************************** Process *********************************** */
81 /** @brief Process datatype
82 @ingroup simix_process_management
84 A processt may be defined as a <em>code</em>, with some <em>private
85 data</em>, executing in a <em>location</em>.
86 \see m_process_management
88 typedef struct s_smx_process *smx_process_t;
93 * Type of function that creates a process.
94 * The function must accept the following parameters:
95 * void* process: the process created will be stored there
96 * const char *name: a name for the object. It is for user-level information and can be NULL
97 * xbt_main_func_t code: is a function describing the behavior of the process
98 * void *data: data a pointer to any data one may want to attach to the new object.
99 * smx_host_t host: the location where the new process is executed
100 * int argc, char **argv: parameters passed to code
101 * xbt_dict_t pros: properties
103 typedef void (*smx_creation_func_t) ( /* process */ smx_process_t*,
104 /* name */ const char*,
105 /* code */ xbt_main_func_t,
106 /* userdata */ void*,
107 /* hostname */ const char*,
108 /* kill_time */ double,
111 /* props */ xbt_dict_t,
112 /* auto_restart */ int);
115 /******************************* Networking ***********************************/
117 * \ingroup simix_rdv_management
119 typedef struct s_smx_rvpoint *smx_rdv_t;
121 XBT_PUBLIC(void*) SIMIX_comm_get_src_data(smx_action_t action);
122 XBT_PUBLIC(void*) SIMIX_comm_get_dst_data(smx_action_t action);
124 /******************************** Context *************************************/
125 typedef struct s_smx_context *smx_context_t;
126 typedef struct s_smx_context_factory *smx_context_factory_t;
128 /* Process creation/destruction callbacks */
129 typedef void (*void_pfn_smxprocess_t) (smx_process_t);
131 typedef void (*void_pfn_smxprocess_t_smxprocess_t) (smx_process_t, smx_process_t);
132 /* for auto-restart function */
133 typedef void (*void_pfn_smxhost_t) (smx_host_t);
135 /* The following function pointer types describe the interface that any context
136 factory should implement */
139 typedef smx_context_t(*smx_pfn_context_factory_create_context_t)
140 (xbt_main_func_t, int, char **, void_pfn_smxprocess_t, void* data);
141 typedef int (*smx_pfn_context_factory_finalize_t) (smx_context_factory_t*);
142 typedef void (*smx_pfn_context_free_t) (smx_context_t);
143 typedef void (*smx_pfn_context_start_t) (smx_context_t);
144 typedef void (*smx_pfn_context_stop_t) (smx_context_t);
145 typedef void (*smx_pfn_context_suspend_t) (smx_context_t context);
146 typedef void (*smx_pfn_context_runall_t) (void);
147 typedef smx_context_t (*smx_pfn_context_self_t) (void);
148 typedef void* (*smx_pfn_context_get_data_t) (smx_context_t context);
150 /* interface of the context factories */
151 typedef struct s_smx_context_factory {
153 smx_pfn_context_factory_create_context_t create_context;
154 smx_pfn_context_factory_finalize_t finalize;
155 smx_pfn_context_free_t free;
156 smx_pfn_context_stop_t stop;
157 smx_pfn_context_suspend_t suspend;
158 smx_pfn_context_runall_t runall;
159 smx_pfn_context_self_t self;
160 smx_pfn_context_get_data_t get_data;
161 } s_smx_context_factory_t;
163 /* Hack: let msg load directly the right factory */
164 typedef void (*smx_ctx_factory_initializer_t)(smx_context_factory_t*);
165 XBT_PUBLIC(smx_ctx_factory_initializer_t) smx_factory_initializer_to_use;
166 extern char* smx_context_factory_name;
167 extern int smx_context_stack_size;
168 extern int smx_context_stack_size_was_set;
170 #ifdef HAVE_THREAD_LOCAL_STORAGE
171 extern __thread smx_context_t smx_current_context;
173 extern smx_context_t smx_current_context;
176 /* *********************** */
177 /* Context type definition */
178 /* *********************** */
179 /* the following function pointers types describe the interface that all context
180 concepts must implement */
181 /* each context type derive from this structure, so they must contain this structure
182 * at their beginning -- OOP in C :/ */
183 typedef struct s_smx_context {
184 s_xbt_swag_hookup_t hookup;
185 xbt_main_func_t code;
186 void_pfn_smxprocess_t cleanup_func;
187 void *data; /* Here SIMIX stores the smx_process_t containing the context */
190 unsigned iwannadie:1;
193 /* methods of this class */
194 XBT_PUBLIC(void) smx_ctx_base_factory_init(smx_context_factory_t *factory);
195 XBT_PUBLIC(int) smx_ctx_base_factory_finalize(smx_context_factory_t *factory);
197 XBT_PUBLIC(smx_context_t)
198 smx_ctx_base_factory_create_context_sized(size_t size,
199 xbt_main_func_t code, int argc,
201 void_pfn_smxprocess_t cleanup,
203 XBT_PUBLIC(void) smx_ctx_base_free(smx_context_t context);
204 XBT_PUBLIC(void) smx_ctx_base_stop(smx_context_t context);
205 XBT_PUBLIC(smx_context_t) smx_ctx_base_self(void);
206 XBT_PUBLIC(void) *smx_ctx_base_get_data(smx_context_t context);
208 XBT_PUBLIC(xbt_dynar_t) SIMIX_process_get_runnable(void);
209 XBT_PUBLIC(smx_process_t) SIMIX_process_from_PID(int PID);
210 XBT_PUBLIC(xbt_dynar_t) SIMIX_processes_as_dynar(void);
213 XBT_PUBLIC(int) SIMIX_context_is_parallel(void);
214 XBT_PUBLIC(int) SIMIX_context_get_nthreads(void);
215 XBT_PUBLIC(void) SIMIX_context_set_nthreads(int nb_threads);
216 XBT_PUBLIC(int) SIMIX_context_get_parallel_threshold(void);
217 XBT_PUBLIC(void) SIMIX_context_set_parallel_threshold(int threshold);
218 XBT_PUBLIC(e_xbt_parmap_mode_t) SIMIX_context_get_parallel_mode(void);
219 XBT_PUBLIC(void) SIMIX_context_set_parallel_mode(e_xbt_parmap_mode_t mode);
223 /********************************** Global ************************************/
224 /* Initialization and exit */
225 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
228 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function);
229 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
230 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_pfn_smxprocess_t_smxprocess_t function);
232 /* Simulation execution */
233 XBT_PUBLIC(void) SIMIX_run(void);
234 XBT_PUBLIC(double) SIMIX_get_clock(void);
236 /* Timer functions FIXME: should these be public? */
237 XBT_PUBLIC(void) SIMIX_timer_set(double date, void *function, void *arg);
238 XBT_PUBLIC(double) SIMIX_timer_next(void);
240 XBT_PUBLIC(void) SIMIX_display_process_status(void);
242 /******************************* Environment **********************************/
243 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
245 /******************************** Deployment **********************************/
247 XBT_PUBLIC(void) SIMIX_function_register(const char *name, xbt_main_func_t code);
248 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
249 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
250 XBT_PUBLIC(void) SIMIX_init_application(void);
251 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
253 XBT_PUBLIC(void) SIMIX_process_set_function(const char* process_host,
254 const char *process_function,
255 xbt_dynar_t arguments,
256 double process_start_time,
257 double process_kill_time);
259 /*********************************** Host *************************************/
260 //XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(u_smx_scalar_t *args);
261 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
262 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
263 XBT_PUBLIC(const char*) SIMIX_host_self_get_name(void);
264 XBT_PUBLIC(const char*) SIMIX_host_get_name(smx_host_t host); /* FIXME: make private: only the name of SIMIX_host_self() should be public without request */
265 XBT_PUBLIC(void) SIMIX_host_self_set_data(void *data);
266 XBT_PUBLIC(void*) SIMIX_host_self_get_data(void);
267 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
268 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
270 /********************************* Process ************************************/
271 XBT_PUBLIC(int) SIMIX_process_count(void);
272 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
273 XBT_PUBLIC(const char*) SIMIX_process_self_get_name(void);
274 XBT_PUBLIC(void) SIMIX_process_self_set_data(smx_process_t self, void *data);
275 XBT_PUBLIC(void*) SIMIX_process_self_get_data(smx_process_t self);
276 XBT_PUBLIC(smx_context_t) SIMIX_process_get_context(smx_process_t);
277 XBT_PUBLIC(void) SIMIX_process_set_context(smx_process_t p,smx_context_t c);
278 XBT_PUBLIC(int) SIMIX_process_has_pending_comms(smx_process_t process);
279 XBT_PUBLIC(void) SIMIX_process_on_exit_runall(smx_process_t process);
280 XBT_PUBLIC(void) SIMIX_process_on_exit(smx_process_t process, int_f_pvoid_t fun, void *data);
282 /****************************** Communication *********************************/
283 XBT_PUBLIC(void) SIMIX_comm_set_copy_data_callback(void (*callback) (smx_action_t, void*, size_t));
284 XBT_PUBLIC(void) SIMIX_comm_copy_pointer_callback(smx_action_t comm, void* buff, size_t buff_size);
285 XBT_PUBLIC(void) SIMIX_comm_copy_buffer_callback(smx_action_t comm, void* buff, size_t buff_size);
286 XBT_PUBLIC(void) smpi_comm_copy_data_callback(smx_action_t comm, void* buff, size_t buff_size);
288 XBT_PUBLIC(smx_action_t) SIMIX_comm_get_send_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
289 XBT_PUBLIC(int) SIMIX_comm_has_send_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
290 XBT_PUBLIC(int) SIMIX_comm_has_recv_match(smx_rdv_t rdv, int (*match_fun)(void*, void*), void* data);
291 XBT_PUBLIC(void) SIMIX_comm_finish(smx_action_t action);
293 /******************************************************************************/
295 /******************************************************************************/
296 /* These functions are a system call-like interface to the simulation kernel. */
297 /* They can also be called from maestro's context, and they are thread safe. */
298 /******************************************************************************/
300 /******************************* Host simcalls ********************************/
301 /* TODO use handlers and keep smx_host_t hidden from higher levels */
302 XBT_PUBLIC(xbt_dict_t) simcall_host_get_dict(void);
303 XBT_PUBLIC(smx_host_t) simcall_host_get_by_name(const char *name);
304 XBT_PUBLIC(const char *) simcall_host_get_name(smx_host_t host);
305 XBT_PUBLIC(xbt_dict_t) simcall_host_get_properties(smx_host_t host);
306 XBT_PUBLIC(double) simcall_host_get_speed(smx_host_t host);
307 XBT_PUBLIC(double) simcall_host_get_available_speed(smx_host_t host);
308 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
309 XBT_PUBLIC(int) simcall_host_get_state(smx_host_t host);
310 XBT_PUBLIC(void *) simcall_host_get_data(smx_host_t host);
312 XBT_PUBLIC(void) simcall_host_set_data(smx_host_t host, void *data);
314 XBT_PUBLIC(smx_action_t) simcall_host_execute(const char *name, smx_host_t host,
315 double computation_amount,
317 XBT_PUBLIC(smx_action_t) simcall_host_parallel_execute(const char *name,
319 smx_host_t *host_list,
320 double *computation_amount,
321 double *communication_amount,
324 XBT_PUBLIC(void) simcall_host_execution_destroy(smx_action_t execution);
325 XBT_PUBLIC(void) simcall_host_execution_cancel(smx_action_t execution);
326 XBT_PUBLIC(double) simcall_host_execution_get_remains(smx_action_t execution);
327 XBT_PUBLIC(e_smx_state_t) simcall_host_execution_get_state(smx_action_t execution);
328 XBT_PUBLIC(void) simcall_host_execution_set_priority(smx_action_t execution, double priority);
329 XBT_PUBLIC(e_smx_state_t) simcall_host_execution_wait(smx_action_t execution);
332 /**************************** Process simcalls ********************************/
333 /* Constructor and Destructor */
334 XBT_PUBLIC(void) simcall_process_create(smx_process_t *process,
336 xbt_main_func_t code,
338 const char *hostname,
340 int argc, char **argv,
341 xbt_dict_t properties,
344 XBT_PUBLIC(void) simcall_process_kill(smx_process_t process);
345 XBT_PUBLIC(void) simcall_process_killall(int reset_pid);
347 /* Process handling */
348 XBT_PUBLIC(void) simcall_process_cleanup(smx_process_t process);
349 XBT_PUBLIC(void) simcall_process_change_host(smx_process_t process,
351 XBT_PUBLIC(void) simcall_process_suspend(smx_process_t process);
352 XBT_PUBLIC(void) simcall_process_resume(smx_process_t process);
354 /* Getters and Setters */
355 XBT_PUBLIC(int) simcall_process_count(void);
356 XBT_PUBLIC(void *) simcall_process_get_data(smx_process_t process);
357 XBT_PUBLIC(void) simcall_process_set_data(smx_process_t process, void *data);
358 XBT_PUBLIC(smx_host_t) simcall_process_get_host(smx_process_t process);
359 XBT_PUBLIC(const char *) simcall_process_get_name(smx_process_t process);
360 int simcall_process_get_PID(smx_process_t process);
361 int simcall_process_get_PPID(smx_process_t process);
362 XBT_PUBLIC(int) simcall_process_is_suspended(smx_process_t process);
363 XBT_PUBLIC(xbt_dict_t) simcall_process_get_properties(smx_process_t host);
364 XBT_PUBLIC(void) simcall_process_set_kill_time(smx_process_t process, double kill_time);
365 XBT_PUBLIC(void) simcall_process_on_exit(smx_process_t process, int_f_pvoid_t fun, void *data);
366 XBT_PUBLIC(void) simcall_process_auto_restart_set(smx_process_t process, int auto_restart);
367 XBT_PUBLIC(smx_process_t) simcall_process_restart(smx_process_t process);
369 XBT_PUBLIC(e_smx_state_t) simcall_process_sleep(double duration);
371 /************************** Comunication simcalls *****************************/
372 /***** Rendez-vous points *****/
374 XBT_PUBLIC(smx_rdv_t) simcall_rdv_create(const char *name);
375 XBT_PUBLIC(void) simcall_rdv_destroy(smx_rdv_t rvp);
376 XBT_PUBLIC(smx_rdv_t) simcall_rdv_get_by_name(const char *name);
377 XBT_PUBLIC(int) simcall_rdv_comm_count_by_host(smx_rdv_t rdv, smx_host_t host);
378 XBT_PUBLIC(smx_action_t) simcall_rdv_get_head(smx_rdv_t rdv);
379 XBT_PUBLIC(smx_process_t) simcall_rdv_get_receiver(smx_rdv_t rdv);
380 XBT_PUBLIC(void) simcall_rdv_set_receiver(smx_rdv_t rdv , smx_process_t process);
382 XBT_PUBLIC(xbt_dict_t) SIMIX_get_rdv_points(void);
384 /***** Communication simcalls *****/
386 XBT_PUBLIC(void) simcall_comm_send(smx_rdv_t rdv, double task_size,
387 double rate, void *src_buff,
388 size_t src_buff_size,
389 int (*match_fun)(void *, void *, smx_action_t),
390 void *data, double timeout);
392 XBT_PUBLIC(smx_action_t) simcall_comm_isend(smx_rdv_t rdv, double task_size,
393 double rate, void *src_buff,
394 size_t src_buff_size,
395 int (*match_fun)(void *, void *, smx_action_t),
396 void (*clean_fun)(void *),
397 void *data, int detached);
399 XBT_PUBLIC(void) simcall_comm_recv(smx_rdv_t rdv, void *dst_buff,
400 size_t * dst_buff_size,
401 int (*match_fun)(void *, void *, smx_action_t),
402 void *data, double timeout);
404 XBT_PUBLIC(smx_action_t) simcall_comm_irecv(smx_rdv_t rdv, void *dst_buff,
405 size_t * dst_buff_size,
406 int (*match_fun)(void *, void *, smx_action_t),
409 XBT_PUBLIC(void) simcall_comm_destroy(smx_action_t comm);
410 XBT_PUBLIC(smx_action_t) simcall_comm_iprobe(smx_rdv_t rdv, int src, int tag,
411 int (*match_fun)(void *, void *, smx_action_t), void *data);
412 XBT_PUBLIC(void) simcall_comm_cancel(smx_action_t comm);
414 /* FIXME: waitany is going to be a vararg function, and should take a timeout */
415 XBT_PUBLIC(unsigned int) simcall_comm_waitany(xbt_dynar_t comms);
416 XBT_PUBLIC(void) simcall_comm_wait(smx_action_t comm, double timeout);
417 XBT_PUBLIC(int) simcall_comm_test(smx_action_t comm);
418 XBT_PUBLIC(int) simcall_comm_testany(xbt_dynar_t comms);
420 /* Getters and setters */
421 XBT_PUBLIC(double) simcall_comm_get_remains(smx_action_t comm);
422 XBT_PUBLIC(e_smx_state_t) simcall_comm_get_state(smx_action_t comm);
423 XBT_PUBLIC(void *) simcall_comm_get_src_data(smx_action_t comm);
424 XBT_PUBLIC(void *) simcall_comm_get_dst_data(smx_action_t comm);
425 XBT_PUBLIC(smx_process_t) simcall_comm_get_src_proc(smx_action_t comm);
426 XBT_PUBLIC(smx_process_t) simcall_comm_get_dst_proc(smx_action_t comm);
428 #ifdef HAVE_LATENCY_BOUND_TRACKING
429 XBT_PUBLIC(int) simcall_comm_is_latency_bounded(smx_action_t comm);
433 /************************** Tracing handling **********************************/
434 XBT_PUBLIC(void) simcall_set_category(smx_action_t action, const char *category);
437 /************************** Synchro simcalls **********************************/
439 XBT_PUBLIC(smx_mutex_t) simcall_mutex_init(void);
440 XBT_PUBLIC(void) simcall_mutex_destroy(smx_mutex_t mutex);
441 XBT_PUBLIC(void) simcall_mutex_lock(smx_mutex_t mutex);
442 XBT_PUBLIC(int) simcall_mutex_trylock(smx_mutex_t mutex);
443 XBT_PUBLIC(void) simcall_mutex_unlock(smx_mutex_t mutex);
445 XBT_PUBLIC(smx_cond_t) simcall_cond_init(void);
446 XBT_PUBLIC(void) simcall_cond_destroy(smx_cond_t cond);
447 XBT_PUBLIC(void) simcall_cond_signal(smx_cond_t cond);
448 XBT_PUBLIC(void) simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
449 XBT_PUBLIC(void) simcall_cond_wait_timeout(smx_cond_t cond,
451 double max_duration);
452 XBT_PUBLIC(void) simcall_cond_broadcast(smx_cond_t cond);
454 XBT_PUBLIC(smx_sem_t) simcall_sem_init(int capacity);
455 XBT_PUBLIC(void) simcall_sem_destroy(smx_sem_t sem);
456 XBT_PUBLIC(void) simcall_sem_release(smx_sem_t sem);
457 XBT_PUBLIC(void) simcall_sem_release_forever(smx_sem_t sem);
458 XBT_PUBLIC(int) simcall_sem_would_block(smx_sem_t sem);
459 XBT_PUBLIC(void) simcall_sem_block_onto(smx_sem_t sem);
460 XBT_PUBLIC(void) simcall_sem_acquire(smx_sem_t sem);
461 XBT_PUBLIC(void) simcall_sem_acquire_timeout(smx_sem_t sem,
462 double max_duration);
463 XBT_PUBLIC(unsigned int) simcall_sem_acquire_any(xbt_dynar_t sems);
464 XBT_PUBLIC(int) simcall_sem_get_capacity(smx_sem_t sem);
466 XBT_PUBLIC(double) simcall_file_read(void* ptr, size_t size, size_t nmemb, smx_file_t stream);
467 XBT_PUBLIC(size_t) simcall_file_write(const void* ptr, size_t size, size_t nmemb, smx_file_t stream);
468 XBT_PUBLIC(smx_file_t) simcall_file_open(const char* storage, const char* path, const char* mode);
469 XBT_PUBLIC(int) simcall_file_close(smx_file_t fp);
470 XBT_PUBLIC(int) simcall_file_stat(smx_file_t fd, s_file_stat_t *buf);
471 XBT_PUBLIC(int) simcall_file_unlink(smx_file_t fd);
472 XBT_PUBLIC(xbt_dict_t) simcall_file_ls(const char* mount, const char* path);
474 /************************** AS router **********************************/
475 XBT_PUBLIC(xbt_dict_t) SIMIX_asr_get_properties(const char *name);
476 /************************** AS router simcalls ***************************/
477 XBT_PUBLIC(xbt_dict_t) simcall_asr_get_properties(const char *name);
479 /************************** MC simcalls **********************************/
480 XBT_PUBLIC(void *) simcall_mc_snapshot(void);
481 XBT_PUBLIC(int) simcall_mc_compare_snapshots(void *s1, void *s2);
483 /************************** New API simcalls **********************************/
484 /* TUTORIAL: New API */
485 /******************************************************************************/
486 XBT_PUBLIC(int) simcall_new_api_fct(const char* param1, double param2);
489 #endif /* _SIMIX_SIMIX_H */