3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4 All rights reserved. */
6 /* This program is free software; you can redistribute it and/or modify it
7 * under the terms of the license (GNU LGPL) which comes with this package. */
10 #define _SIMIX_SIMIX_H
15 #include "xbt/function_types.h"
16 #include "simix/datatypes.h"
17 #include "surf/surf.h"
22 /************************** Global ******************************************/
23 XBT_PUBLIC(void) SIMIX_config(const char *name, va_list pa);
24 XBT_PUBLIC(void) SIMIX_global_init(int *argc, char **argv);
25 XBT_PUBLIC(void) SIMIX_clean(void);
26 XBT_PUBLIC(void) SIMIX_function_register(const char *name,
27 xbt_main_func_t code);
28 XBT_PUBLIC(void) SIMIX_function_register_default(xbt_main_func_t code);
29 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
31 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
33 XBT_PUBLIC(double) SIMIX_get_clock(void);
34 XBT_PUBLIC(void) SIMIX_init(void);
35 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done,
36 xbt_fifo_t actions_failed);
39 XBT_PUBLIC(void) SIMIX_timer_set(double date, void *function, void *arg);
40 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
43 XBT_PUBLIC(void) __SIMIX_main(void);
45 /* User create and kill process, the function must accept the folling parameters:
46 * const char *name: a name for the object. It is for user-level information and can be NULL
47 * xbt_main_func_t code: is a function describing the behavior of the agent
48 * void *data: data a pointer to any data one may want to attach to the new object.
49 * smx_host_t host: the location where the new agent is executed
50 * int argc, char **argv: parameters passed to code
53 typedef void *(*smx_creation_func_t) ( /*name */ const char *,
54 /*code */ xbt_main_func_t,
59 /* props */ xbt_dict_t);
60 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t
62 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t
64 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_f_pvoid_t
67 /************************** Host handling ***********************************/
69 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
70 XBT_PUBLIC(void *) SIMIX_host_get_data(smx_host_t host);
72 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
73 XBT_PUBLIC(void) SIMIX_process_set_name(smx_process_t process, char *name);
74 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
75 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
76 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
78 XBT_PUBLIC(int) SIMIX_host_get_number(void);
79 XBT_PUBLIC(smx_host_t *) SIMIX_host_get_table(void);
80 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_dict(void);
82 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
83 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
85 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_properties(smx_host_t host);
87 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
88 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
90 /************************** Process handling *********************************/
91 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
94 const char *hostname, int argc,
96 xbt_dict_t properties);
98 XBT_PUBLIC(void) SIMIX_jprocess_create(const char *name,
101 void *jprocess, void *jenv,
102 smx_process_t * res);
104 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
105 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
106 XBT_PUBLIC(void) SIMIX_process_killall(void);
107 XBT_PUBLIC(void) SIMIX_process_change_host(smx_process_t process,
108 char *source, char *dest);
111 XBT_PUBLIC(void *) SIMIX_process_get_data(smx_process_t process);
112 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
114 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
115 XBT_PUBLIC(const char *) SIMIX_process_get_name(smx_process_t process);
116 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
118 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
119 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
120 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
122 /*property handlers*/
123 XBT_PUBLIC(xbt_dict_t) SIMIX_process_get_properties(smx_process_t host);
125 /************************** Synchro handling **********************************/
128 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
129 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
130 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
131 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
132 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
134 /*****Conditional*****/
135 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
136 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
137 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond, smx_mutex_t mutex);
138 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex,
139 double max_duration);
140 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
141 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
142 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
143 XBT_PUBLIC(void) SIMIX_cond_display_info(smx_cond_t cond);
145 /************************** Action handling ************************************/
146 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,
149 double size, double rate);
150 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,
153 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
154 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
155 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action,
157 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
158 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action,
160 XBT_PUBLIC(void) SIMIX_unregister_action_to_condition(smx_action_t action,
162 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
164 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
166 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char *name,
168 smx_host_t * host_list,
170 *computation_amount, double
171 *communication_amount,
175 void SIMIX_display_process_status(void);
179 #endif /* _SIMIX_SIMIX_H */