Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
* Cleanup the DTD by renaming:
[simgrid.git] / src / include / simix / simix.h
1 /*      $Id$     */
2
3 /* Copyright (c) 2007 Arnaud Legrand, Bruno Donnassolo.
4    All rights reserved.                                          */
5
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. */
8
9 #ifndef _SIMIX_SIMIX_H
10 #define _SIMIX_SIMIX_H
11
12 #include "xbt/misc.h"
13 #include "xbt/fifo.h"
14 #include "xbt/dict.h"
15 #include "xbt/function_types.h"
16 #include "simix/datatypes.h"
17 #include "surf/surf.h"
18
19 SG_BEGIN_DECL()
20
21
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, xbt_main_func_t code);
27 XBT_PUBLIC(xbt_main_func_t) SIMIX_get_registered_function(const char *name);
28
29 XBT_PUBLIC(void) SIMIX_launch_application(const char *file);
30
31 XBT_PUBLIC(double) SIMIX_get_clock(void);
32 XBT_PUBLIC(double) SIMIX_solve(xbt_fifo_t actions_done, xbt_fifo_t actions_failed);
33
34 /* Timer functions */
35 XBT_PUBLIC(void) SIMIX_timer_set (double date, void *function, void *arg);
36 XBT_PUBLIC(int) SIMIX_timer_get(void **function, void **arg);
37
38 /* only for tests */
39 XBT_PUBLIC(void) __SIMIX_main(void);
40
41 /* User create and kill process, the function must accept the folling parameters:
42  * const char *name: a name for the object. It is for user-level information and can be NULL
43  * xbt_main_func_t code: is a function describing the behavior of the agent
44  * void *data: data a pointer to any data one may want to attach to the new object.
45  * smx_host_t host: the location where the new agent is executed
46  * int argc, char **argv: parameters passed to code
47  *
48  * */
49 typedef void *(*smx_creation_func_t)(/*name*/     const char *,
50                                      /*code*/     xbt_main_func_t, 
51                                      /*userdata*/ void *,
52                                      /*hostname*/ char *, 
53                                      /* argc */   int,
54                                      /* argv */   char **,
55                                      /* props */ xbt_dict_t);
56 XBT_PUBLIC(void) SIMIX_function_register_process_create(smx_creation_func_t function);
57 XBT_PUBLIC(void) SIMIX_function_register_process_kill(void_f_pvoid_t function);
58 XBT_PUBLIC(void) SIMIX_function_register_process_cleanup(void_f_pvoid_t function);
59
60 /************************** Host handling ***********************************/
61
62 XBT_PUBLIC(void) SIMIX_host_set_data(smx_host_t host, void *data);
63 XBT_PUBLIC(void*) SIMIX_host_get_data(smx_host_t host);
64
65 XBT_PUBLIC(const char *) SIMIX_host_get_name(smx_host_t host);
66 XBT_PUBLIC(smx_host_t) SIMIX_host_self(void);
67 XBT_PUBLIC(double) SIMIX_host_get_speed(smx_host_t host);
68 XBT_PUBLIC(double) SIMIX_host_get_available_speed(smx_host_t host);
69
70 XBT_PUBLIC(int) SIMIX_host_get_number(void);
71 XBT_PUBLIC(smx_host_t *)SIMIX_host_get_table(void);
72
73 XBT_PUBLIC(void) SIMIX_create_environment(const char *file);
74 XBT_PUBLIC(smx_host_t) SIMIX_host_get_by_name(const char *name);
75
76 XBT_PUBLIC(xbt_dict_t) SIMIX_host_get_properties(smx_host_t host);
77
78 /* Two possible states, 1 - CPU ON and 0 CPU OFF */
79 XBT_PUBLIC(int) SIMIX_host_get_state(smx_host_t host);
80
81 /************************** Process handling *********************************/
82 XBT_PUBLIC(smx_process_t) SIMIX_process_create(const char *name,
83                                                xbt_main_func_t code, void *data,
84                                                const char * hostname, int argc, char **argv, xbt_dict_t properties);
85
86 XBT_PUBLIC(void) SIMIX_jprocess_create(const char *name, 
87                                        smx_host_t host,
88                                        void *data,
89                                        void *jprocess, void *jenv,
90                                        smx_process_t* res);
91
92 XBT_PUBLIC(void) SIMIX_process_kill(smx_process_t process);
93 XBT_PUBLIC(void) SIMIX_process_cleanup(void *arg);
94 XBT_PUBLIC(void) SIMIX_process_killall(void);
95
96 //above layer
97 XBT_PUBLIC(void*) SIMIX_process_get_data(smx_process_t process);
98 XBT_PUBLIC(void) SIMIX_process_set_data(smx_process_t process, void *data);
99
100 XBT_PUBLIC(smx_host_t) SIMIX_process_get_host(smx_process_t process);
101 XBT_PUBLIC(const char *)SIMIX_process_get_name(smx_process_t process);
102 XBT_PUBLIC(smx_process_t) SIMIX_process_self(void);
103
104 XBT_PUBLIC(void) SIMIX_process_suspend(smx_process_t process);
105 XBT_PUBLIC(void) SIMIX_process_resume(smx_process_t process);
106 XBT_PUBLIC(int) SIMIX_process_is_suspended(smx_process_t process);
107
108 /*property handlers*/
109 XBT_PUBLIC(xbt_dict_t) SIMIX_process_get_properties(smx_process_t host);
110
111 /************************** Synchro handling **********************************/
112
113 /******Mutex******/
114 XBT_PUBLIC(smx_mutex_t) SIMIX_mutex_init(void);
115 XBT_PUBLIC(void) SIMIX_mutex_lock(smx_mutex_t mutex);
116 XBT_PUBLIC(int) SIMIX_mutex_trylock(smx_mutex_t mutex);
117 XBT_PUBLIC(void) SIMIX_mutex_unlock(smx_mutex_t mutex);
118 XBT_PUBLIC(void) SIMIX_mutex_destroy(smx_mutex_t mutex);
119
120 /*****Conditional*****/
121 XBT_PUBLIC(smx_cond_t) SIMIX_cond_init(void);
122 XBT_PUBLIC(void) SIMIX_cond_signal(smx_cond_t cond);
123 XBT_PUBLIC(void) SIMIX_cond_wait(smx_cond_t cond,smx_mutex_t mutex);
124 XBT_PUBLIC(void) SIMIX_cond_wait_timeout(smx_cond_t cond,smx_mutex_t mutex, double max_duration);
125 XBT_PUBLIC(void) SIMIX_cond_broadcast(smx_cond_t cond);
126 XBT_PUBLIC(void) SIMIX_cond_destroy(smx_cond_t cond);
127 XBT_PUBLIC(xbt_fifo_t) SIMIX_cond_get_actions(smx_cond_t cond);
128
129
130 /************************** Action handling ************************************/
131 XBT_PUBLIC(smx_action_t) SIMIX_action_communicate(smx_host_t sender,smx_host_t receiver, const char *name,
132                                                                                                                                                                                                         double size, double rate);
133 XBT_PUBLIC(smx_action_t) SIMIX_action_execute(smx_host_t host,char *name, double amount);
134 XBT_PUBLIC(smx_action_t) SIMIX_action_sleep(smx_host_t host, double amount);
135 XBT_PUBLIC(void) SIMIX_action_cancel(smx_action_t action);
136 XBT_PUBLIC(void) SIMIX_action_set_priority(smx_action_t action, double priority);
137 XBT_PUBLIC(void) SIMIX_action_destroy(smx_action_t action);
138 XBT_PUBLIC(void) SIMIX_register_action_to_condition(smx_action_t action, smx_cond_t cond);
139 XBT_PUBLIC(void) SIMIX_unregister_action_to_condition(smx_action_t action, smx_cond_t cond);
140 XBT_PUBLIC(double) SIMIX_action_get_remains(smx_action_t action);
141
142 XBT_PUBLIC(e_surf_action_state_t) SIMIX_action_get_state(smx_action_t action);
143
144 XBT_PUBLIC(smx_action_t) SIMIX_action_parallel_execute(char * name, 
145                                                        int host_nb,      
146                                                        smx_host_t *host_list,
147                                                        double *computation_amount,
148                                                        double *communication_amount,
149                                                        double amount,
150                                                        double rate);
151
152 void SIMIX_display_process_status(void);
153
154 /* Helper functions for jMSG: manipulate the context data without breaking the module separation */
155 void  SIMIX_process_set_jprocess(smx_process_t process, void *jp);
156 void* SIMIX_process_get_jprocess(smx_process_t process);
157 void  SIMIX_process_set_jenv(smx_process_t process, void *je);
158 void* SIMIX_process_get_jenv(smx_process_t process);
159
160
161 SG_END_DECL()
162
163 #endif                          /* _SIMIX_SIMIX_H */