Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
f04ce916ab48437d875006ed6ecadaeaddae4751
[simgrid.git] / include / simgrid / msg.h
1 /* Copyright (c) 2004-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
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. */
6
7 #ifndef MSG_H
8 #define MSG_H
9
10 #include "xbt.h"
11 #include "xbt/lib.h"
12 #include "simgrid/simix.h"
13 #include "simgrid/platf.h"
14
15 SG_BEGIN_DECL()
16
17 /* ******************************** Mailbox ************************************ */
18
19 /** @brief Mailbox datatype
20  *  @ingroup msg_task_usage
21  *
22  * Object representing a communication rendez-vous point, on which
23  * the sender finds the receiver it wants to communicate with. As a
24  * MSG user, you will only rarely manipulate any of these objects
25  * directly, since most of the public interface (such as
26  * #MSG_task_send and friends) hide this object behind a string
27  * alias. That mean that you don't provide the mailbox on which you
28  * want to send your task, but only the name of this mailbox. */
29 typedef struct s_smx_rvpoint *msg_mailbox_t;
30
31 /* ******************************** Environment ************************************ */
32 typedef struct As *msg_as_t;
33
34 /* ******************************** Host ************************************ */
35
36 XBT_PUBLIC_DATA(int) MSG_HOST_LEVEL;
37
38 /** @brief Host datatype.
39     @ingroup m_host_management
40
41     A <em>location</em> (or <em>host</em>) is any possible place where
42     a process may run. Thus it is represented as a <em>physical
43     resource with computing capabilities</em>, some <em>mailboxes</em>
44     to enable running process to communicate with remote ones, and
45     some <em>private data</em> that can be only accessed by local
46     process.
47  */
48 typedef xbt_dictelm_t msg_host_t;
49
50 typedef struct msg_host_priv {
51   int        dp_enabled;
52   xbt_dict_t dp_objs;
53   double     dp_updated_by_deleted_tasks;
54   int        is_migrating;
55
56   xbt_dict_t affinity_mask_db;
57
58 #ifdef MSG_USE_DEPRECATED
59   msg_mailbox_t *mailboxes;     /**< the channels  */
60 #endif
61 } s_msg_host_priv_t, *msg_host_priv_t;
62
63 static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
64   return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
65 }
66
67
68
69 /* ******************************** Task ************************************ */
70
71 typedef struct simdata_task *simdata_task_t;
72
73 typedef struct msg_task {
74   char *name;                   /**< @brief task name if any */
75   simdata_task_t simdata;       /**< @brief simulator data */
76   void *data;                   /**< @brief user data */
77   long long int counter;        /* task unique identifier for instrumentation */
78   char *category;               /* task category for instrumentation */
79 } s_msg_task_t;
80
81 /** @brief Task datatype.
82     @ingroup m_task_management
83
84     A <em>task</em> may then be defined by a <em>computing
85     amount</em>, a <em>message size</em> and some <em>private
86     data</em>.
87  */
88 typedef struct msg_task *msg_task_t;
89
90 /* ******************************** VM ************************************* */
91 typedef msg_host_t msg_vm_t;
92 typedef msg_host_priv_t msg_vm_priv_t;
93
94 static inline msg_vm_priv_t MSG_vm_priv(msg_vm_t vm){
95   return (msg_vm_priv_t) xbt_lib_get_level(vm, MSG_HOST_LEVEL);
96 }
97
98 /** ******************************** File ************************************ */
99
100 /** @brief File datatype.
101 *  @ingroup msg_file_management
102 *
103 *  You should consider this as an opaque object.
104 */
105 typedef xbt_dictelm_t msg_file_t;
106 typedef s_xbt_dictelm_t s_msg_file_t;
107
108 extern int MSG_FILE_LEVEL;
109 typedef struct simdata_file *simdata_file_t;
110
111 typedef struct msg_file_priv  {
112   char *fullpath;
113   sg_size_t size;
114   char* mount_point;
115   char* storageId;
116   char* storage_type;
117   char* content_type;
118   void *data;
119   simdata_file_t simdata;
120 } s_msg_file_priv_t, *msg_file_priv_t;
121
122 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
123   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
124 }
125
126 /* ******************************** Storage ************************************ */
127 /* TODO: PV: to comment */
128
129 extern int MSG_STORAGE_LEVEL;
130
131 /** @brief Storage datatype.
132  *  @ingroup msg_storage_management
133  *
134  *  You should consider this as an opaque object.
135  */
136 typedef xbt_dictelm_t msg_storage_t;
137 typedef s_xbt_dictelm_t s_msg_storage_t;
138
139 typedef struct msg_storage_priv  {
140   const char *hostname;
141   void *data;
142 } s_msg_storage_priv_t, *msg_storage_priv_t;
143
144 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
145   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
146 }
147
148 /*************** Begin GPU ***************/
149 typedef struct simdata_gpu_task *simdata_gpu_task_t;
150
151 typedef struct msg_gpu_task {
152   char *name;                   /**< @brief task name if any */
153   simdata_gpu_task_t simdata;       /**< @brief simulator data */
154   long long int counter;        /* task unique identifier for instrumentation */
155   char *category;               /* task category for instrumentation */
156 } s_msg_gpu_task_t;
157
158 /** @brief GPU task datatype.
159     @ingroup m_task_management
160
161     A <em>task</em> may then be defined by a <em>computing
162     amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
163     \see m_task_management
164 */
165 typedef struct msg_gpu_task *msg_gpu_task_t;
166 /*************** End GPU ***************/
167
168 /**
169  * \brief @brief Communication action.
170  * \ingroup msg_task_usage
171  *
172  * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
173  */
174 typedef struct msg_comm *msg_comm_t;
175
176 /** \brief Default value for an uninitialized #msg_task_t.
177     \ingroup m_task_management
178 */
179 #define MSG_TASK_UNINITIALIZED NULL
180
181 /* ****************************** Process *********************************** */
182
183 /** @brief Process datatype.
184     @ingroup m_process_management
185
186     A process may be defined as a <em>code</em>, with some
187     <em>private data</em>, executing in a <em>location</em>.
188
189     You should not access directly to the fields of the pointed
190     structure, but always use the provided API to interact with
191     processes.
192  */
193 typedef struct s_smx_process *msg_process_t;
194
195 #ifdef MSG_USE_DEPRECATED
196
197 /* Compatibility typedefs */
198 typedef int                     m_channel_t;
199 typedef msg_gpu_task_t          m_gpu_task_t;
200 typedef msg_host_t              m_host_t;
201 typedef msg_process_t           m_process_t;
202 typedef msg_task_t              m_task_t;
203 typedef s_msg_gpu_task_t        s_m_gpu_task_t;
204 typedef s_msg_host_t            s_m_host_t;
205 typedef s_msg_task_t            s_m_task_t;
206 #endif
207
208 /** @brief Return code of most MSG functions
209     @ingroup msg_simulation
210     @{ */
211 /* Keep these code as binary values: java bindings manipulate | of these values */
212 typedef enum {
213   MSG_OK = 0,                 /**< @brief Everything is right. Keep on going this way ! */
214   MSG_TIMEOUT = 1,            /**< @brief nothing good happened before the timer you provided elapsed */
215   MSG_TRANSFER_FAILURE = 2,   /**< @brief There has been a problem during you task
216       transfer. Either the network is down or the remote host has been
217       shutdown. */
218   MSG_HOST_FAILURE = 4,       /**< @brief System shutdown. The host on which you are
219       running has just been rebooted. Free your datastructures and
220       return now !*/
221   MSG_TASK_CANCELED = 8      /**< @brief Canceled task. This task has been canceled by somebody!*/
222 } msg_error_t;
223 /** @} */
224
225 /************************** Global ******************************************/
226 XBT_PUBLIC(void) MSG_config(const char *key, const char *value);
227 /** \ingroup msg_simulation
228  *  \brief Initialize the MSG internal data.
229  *  \hideinitializer
230  *
231  *  It also check that the link-time and compile-time versions of SimGrid do
232  *  match, so you should use this version instead of the #MSG_init_nocheck
233  *  function that does the same initializations, but without this check.
234  *
235  *  We allow to link against compiled versions that differ in the patch level.
236  */
237 #define MSG_init(argc,argv)  {                                          \
238     int ver_major,ver_minor,ver_patch;                                  \
239     sg_version(&ver_major,&ver_minor,&ver_patch);                       \
240     if ((ver_major != SIMGRID_VERSION_MAJOR) ||                         \
241         (ver_minor != SIMGRID_VERSION_MINOR)) {                         \
242       fprintf(stderr,"FATAL ERROR: Your program was compiled with SimGrid version %d.%d.%d, and then linked against SimGrid %d.%d.%d. Please fix this.\n", \
243               SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH,ver_major,ver_minor,ver_patch); \
244     }                                                                   \
245     MSG_init_nocheck(argc,argv);                                        \
246   }
247
248 XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv);
249 XBT_PUBLIC(msg_error_t) MSG_main(void);
250 XBT_PUBLIC(void) MSG_function_register(const char *name,
251                                        xbt_main_func_t code);
252 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
253 XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
254 XBT_PUBLIC(void) MSG_launch_application(const char *file);
255 /*Bypass the parser */
256 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
257                                   const char *function_name,
258                                   xbt_dynar_t arguments);
259
260 XBT_PUBLIC(double) MSG_get_clock(void);
261 XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void);
262
263 /************************** Environment ***********************************/
264 XBT_PUBLIC(msg_as_t) MSG_environment_get_routing_root(void);
265 XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as);
266 XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name);
267 XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as);
268 XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name);
269 XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as);
270 XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as);
271
272 /************************** File handling ***********************************/
273 XBT_PUBLIC(sg_size_t) MSG_file_read(msg_file_t fd, sg_size_t size);
274 XBT_PUBLIC(sg_size_t) MSG_file_write(msg_file_t fd, sg_size_t size);
275 XBT_PUBLIC(msg_file_t) MSG_file_open(const char* fullpath, void* data);
276 XBT_PUBLIC(void*) MSG_file_get_data(msg_file_t fd);
277 XBT_PUBLIC(msg_error_t) MSG_file_set_data(msg_file_t fd, void * data);
278 XBT_PUBLIC(int) MSG_file_close(msg_file_t fd);
279 XBT_PUBLIC(sg_size_t) MSG_file_get_size(msg_file_t fd);
280 XBT_PUBLIC(void) MSG_file_dump(msg_file_t fd);
281 XBT_PUBLIC(msg_error_t) MSG_file_unlink(msg_file_t fd);
282 XBT_PUBLIC(msg_error_t) MSG_file_seek(msg_file_t fd, sg_offset_t offset, int origin);
283 XBT_PUBLIC(sg_size_t) MSG_file_tell (msg_file_t fd);
284 XBT_PUBLIC(void) __MSG_file_get_info(msg_file_t fd);
285 XBT_PUBLIC(void) __MSG_file_priv_free(msg_file_priv_t priv);
286 XBT_PUBLIC(const char *) MSG_file_get_name(msg_file_t storage);
287 XBT_PUBLIC(msg_error_t) MSG_file_move(msg_file_t fd, const char* fullpath);
288 XBT_PUBLIC(msg_error_t) MSG_file_rcopy(msg_file_t fd, msg_host_t host, const char* fullpath);
289 XBT_PUBLIC(msg_error_t) MSG_file_rmove(msg_file_t fd, msg_host_t host, const char* fullpath);
290 /************************** Storage handling ***********************************/
291 XBT_PUBLIC(msg_host_t) MSG_get_storage_by_name(const char *name);
292 XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage);
293 XBT_PUBLIC(sg_size_t) MSG_storage_get_free_size(msg_storage_t storage);
294 XBT_PUBLIC(sg_size_t) MSG_storage_get_used_size(msg_storage_t storage);
295 XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name);
296 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage);
297 XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char *name, char *value,void_f_pvoid_t free_ctn);
298 XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name);
299 XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(void);
300 XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data);
301 XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage);
302 XBT_PUBLIC(xbt_dict_t) MSG_storage_get_content(msg_storage_t storage);
303 XBT_PUBLIC(sg_size_t) MSG_storage_get_size(msg_storage_t storage);
304 XBT_PUBLIC(msg_error_t) MSG_storage_file_move(msg_file_t fd, msg_host_t dest, char* mount, char* fullname);
305 XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage);
306 /************************** AS Router handling ************************************/
307 XBT_PUBLIC(const char *) MSG_as_router_get_property_value(const char* asr, const char *name);
308 XBT_PUBLIC(xbt_dict_t) MSG_as_router_get_properties(const char* asr);
309 XBT_PUBLIC(void) MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn);
310
311 /************************** Host handling ***********************************/
312 XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data);
313 XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host);
314 XBT_PUBLIC(const char *) MSG_host_get_name(msg_host_t host);
315 XBT_PUBLIC(void) MSG_host_on(msg_host_t host);
316 XBT_PUBLIC(void) MSG_host_off(msg_host_t host);
317 XBT_PUBLIC(msg_host_t) MSG_host_self(void);
318 XBT_PUBLIC(int) MSG_get_host_msgload(msg_host_t host);
319 XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h);
320 XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h);
321 XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h);
322 XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h);
323 XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h);
324 XBT_PUBLIC(double) MSG_host_get_wattmin_at(msg_host_t host, int pstate);
325 XBT_PUBLIC(double) MSG_host_get_wattmax_at(msg_host_t host, int pstate);
326
327 XBT_PUBLIC(void) __MSG_host_priv_free(msg_host_priv_t priv);
328 XBT_PUBLIC(void) __MSG_host_destroy(msg_host_t host);
329
330 XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate);
331 XBT_PUBLIC(double) MSG_host_get_current_power_peak(msg_host_t h);
332 XBT_PUBLIC(int)    MSG_host_get_nb_pstates(msg_host_t h);
333 XBT_PUBLIC(void)   MSG_host_set_pstate(msg_host_t h, int pstate);
334 XBT_PUBLIC(int)    MSG_host_get_pstate(msg_host_t host);
335
336 XBT_PUBLIC(double) MSG_host_get_consumed_energy(msg_host_t h);
337
338 /*property handlers*/
339 XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host);
340 XBT_PUBLIC(const char *) MSG_host_get_property_value(msg_host_t host,
341                                                      const char *name);
342 XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host,
343                                              const char *name, char *value,
344                                              void_f_pvoid_t free_ctn);
345
346
347 XBT_PUBLIC(void) MSG_create_environment(const char *file);
348
349 XBT_PUBLIC(msg_host_t) MSG_get_host_by_name(const char *name);
350 XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(void);
351 XBT_PUBLIC(int) MSG_get_host_number(void);
352 XBT_PUBLIC(void) MSG_host_get_params(msg_host_t ind_pm, ws_params_t params);
353 XBT_PUBLIC(void) MSG_host_set_params(msg_host_t ind_pm, ws_params_t params);
354 XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host);
355 XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host);
356 XBT_PUBLIC(xbt_dict_t) MSG_host_get_storage_content(msg_host_t host);
357 /************************** Process handling *********************************/
358 XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name,
359                                            xbt_main_func_t code,
360                                            void *data, msg_host_t host);
361 XBT_PUBLIC(msg_process_t) MSG_process_create_with_arguments(const char *name,
362                                                           xbt_main_func_t
363                                                           code, void *data,
364                                                           msg_host_t host,
365                                                           int argc,
366                                                           char **argv);
367 XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char
368                                                             *name,
369                                                             xbt_main_func_t
370                                                             code,
371                                                             void *data,
372                                                             msg_host_t host,
373                                                             int argc,
374                                                             char **argv,
375                                                             xbt_dict_t
376                                                             properties);
377 XBT_PUBLIC(void) MSG_process_kill(msg_process_t process);
378 XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs);
379 XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host);
380
381 XBT_PUBLIC(void *) MSG_process_get_data(msg_process_t process);
382 XBT_PUBLIC(msg_error_t) MSG_process_set_data(msg_process_t process,
383                                              void *data);
384 XBT_PUBLIC(void) MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup);
385 XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process);
386 XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID);
387 XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process);
388 XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process);
389 XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process);
390 XBT_PUBLIC(int) MSG_process_self_PID(void);
391 XBT_PUBLIC(int) MSG_process_self_PPID(void);
392 XBT_PUBLIC(msg_process_t) MSG_process_self(void);
393 XBT_PUBLIC(xbt_dynar_t) MSG_processes_as_dynar(void);
394 XBT_PUBLIC(int) MSG_process_get_number(void);
395
396 XBT_PUBLIC(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time);
397
398 /*property handlers*/
399 XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process);
400 XBT_PUBLIC(const char *) MSG_process_get_property_value(msg_process_t
401                                                         process,
402                                                         const char *name);
403
404 XBT_PUBLIC(msg_error_t) MSG_process_suspend(msg_process_t process);
405 XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process);
406 XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process);
407 XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data);
408 XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart);
409
410 XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process);
411
412 /************************** Task handling ************************************/
413 XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name,
414                                      double flops_amount,
415                                      double bytes_amount, void *data);
416 XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name,
417                                      double flops_amount,
418                                      double dispatch_latency,
419                                      double collect_latency);
420 XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name,
421                                               int host_nb,
422                                               const msg_host_t * host_list,
423                                               double *flops_amount,
424                                               double *bytes_amount,
425                                               void *data);
426 XBT_PUBLIC(void *) MSG_task_get_data(msg_task_t task);
427 XBT_PUBLIC(void) MSG_task_set_data(msg_task_t task, void *data);
428 XBT_PUBLIC(void) MSG_task_set_copy_callback(void (*callback) (
429     msg_task_t task, msg_process_t src, msg_process_t dst));
430 XBT_PUBLIC(msg_process_t) MSG_task_get_sender(msg_task_t task);
431 XBT_PUBLIC(msg_host_t) MSG_task_get_source(msg_task_t task);
432 XBT_PUBLIC(const char *) MSG_task_get_name(msg_task_t task);
433 XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name);
434 XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task);
435 XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task);
436
437 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias,
438                                        msg_host_t host);
439 XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias,
440                                        msg_host_t host, double rate);
441
442 XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task);
443 XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task);
444 XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority);
445 XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound);
446 XBT_PUBLIC(void) MSG_task_set_affinity(msg_task_t task, msg_host_t host, unsigned long mask);
447
448 XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout);
449 XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec);
450
451 XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task,
452                                                double flops_amount);
453 XBT_PUBLIC(double) MSG_task_get_flops_amount(msg_task_t task);
454 XBT_PUBLIC(void) MSG_task_set_bytes_amount(msg_task_t task,
455                                         double bytes_amount);
456
457 XBT_PUBLIC(double) MSG_task_get_remaining_communication(msg_task_t task);
458 XBT_PUBLIC(int) MSG_task_is_latency_bounded(msg_task_t task);
459 XBT_PUBLIC(double) MSG_task_get_bytes_amount(msg_task_t task);
460
461
462 XBT_PUBLIC(msg_error_t)
463     MSG_task_receive_ext(msg_task_t * task, const char *alias, double timeout,
464                      msg_host_t host);
465
466 XBT_PUBLIC(msg_error_t)
467     MSG_task_receive_with_timeout(msg_task_t * task, const char *alias,
468                               double timeout);
469
470 XBT_PUBLIC(msg_error_t)
471     MSG_task_receive(msg_task_t * task, const char *alias);
472 #define MSG_task_recv(t,a) MSG_task_receive(t,a)
473
474
475
476 XBT_PUBLIC(msg_error_t)
477     MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout,
478                      msg_host_t host, double rate);
479
480 XBT_PUBLIC(msg_error_t)
481     MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias,
482                               double timeout, double rate);
483
484 XBT_PUBLIC(msg_error_t)
485     MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate);
486 #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r)
487
488 XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias);
489 XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate);
490 XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task,
491                                                     const char *alias,
492                                                     int (*match_fun)(void*,void*, smx_synchro_t),
493                                                     void *match_data);
494
495 XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup);
496 XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate);
497 XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias);
498 XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate);
499 XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm);
500 XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms);
501 XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm);
502 XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout);
503 XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem,
504                                   double timeout);
505 XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms);
506 XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm);
507 XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm);
508
509 XBT_PUBLIC(int) MSG_task_listen(const char *alias);
510
511 XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias,
512                                           msg_host_t host);
513
514 XBT_PUBLIC(msg_error_t)
515     MSG_task_send_with_timeout(msg_task_t task, const char *alias,
516                            double timeout);
517
518 XBT_PUBLIC(msg_error_t)
519     MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias,
520                            double timeout, double maxrate);
521
522 XBT_PUBLIC(msg_error_t)
523     MSG_task_send(msg_task_t task, const char *alias);
524
525 XBT_PUBLIC(msg_error_t)
526     MSG_task_send_bounded(msg_task_t task, const char *alias, double rate);
527
528 XBT_PUBLIC(int) MSG_task_listen_from(const char *alias);
529
530 XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
531 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
532
533 /************************** Task handling ************************************/
534 XBT_PUBLIC(msg_error_t)
535     MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
536                          msg_host_t host, double timeout);
537
538 XBT_PUBLIC(msg_error_t)
539     MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task,
540                                      msg_host_t host, double timeout, double rate);
541
542 XBT_PUBLIC(msg_error_t)
543     MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
544                              double timeout);
545
546 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
547
548
549 /************************** Action handling **********************************/
550 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
551 XBT_PUBLIC(void) MSG_action_init(void);
552 XBT_PUBLIC(void) MSG_action_exit(void);
553
554 #ifdef MSG_USE_DEPRECATED
555
556 typedef msg_error_t MSG_error_t;
557
558 #define MSG_global_init(argc, argv)      MSG_init(argc,argv)
559 #define MSG_global_init_args(argc, argv) MSG_init(argc,argv)
560
561 /* these are the functions which are deprecated. Do not use them, they may get removed in future releases */
562 XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void);
563
564 #define MSG_host_is_avail(h) MSG_host_is_on(h)
565
566 #define MSG_TIMEOUT_FAILURE MSG_TIMEOUT
567 #define MSG_TASK_CANCELLED MSG_TASK_CANCELED
568 #define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \
569         MSG_mailbox_put_with_timeout(mailbox, task, timeout)
570
571 #define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h);
572 XBT_PUBLIC(msg_error_t) MSG_get_errno(void);
573
574 XBT_PUBLIC(msg_error_t) MSG_clean(void);
575
576 XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel);
577 XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task,
578                                                   m_channel_t channel,
579                                                   double max_duration);
580 XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task,
581                                                int channel, msg_host_t host);
582 XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel,
583                                          double max_duration,
584                                          msg_host_t host);
585 XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest,
586                                      m_channel_t channel);
587 XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task,
588                                              msg_host_t dest,
589                                              m_channel_t channel,
590                                              double max_rate);
591 XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task,
592                                                   msg_host_t dest,
593                                                   m_channel_t channel,
594                                                   double max_duration);
595 XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel);
596 XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel);
597 XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host);
598
599 XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number);
600 XBT_PUBLIC(int) MSG_get_channel_number(void);
601 #endif
602
603 /** @brief Opaque type representing a semaphore
604  *  @ingroup msg_synchro
605  *  @hideinitializer
606  */
607 typedef struct s_smx_sem *msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be declared here
608 XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
609 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
610 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
611 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
612 XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
613 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
614 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
615
616 /** @brief Opaque type representing a barrier identifier
617  *  @ingroup msg_synchro
618  *  @hideinitializer
619  */
620
621 #define MSG_BARRIER_SERIAL_PROCESS -1
622 typedef struct s_xbt_bar *msg_bar_t;
623 XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count);
624 XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar);
625 XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
626
627 /** @brief Opaque type describing a Virtual Machine.
628  *  @ingroup msg_VMs
629  *
630  * All this is highly experimental and the interface will probably change in the future.
631  * Please don't depend on this yet (although testing is welcomed if you feel so).
632  * Usual lack of guaranty of any kind applies here, and is even increased.
633  *
634  */
635
636 XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
637 XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
638 XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
639
640 XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
641 XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
642 XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
643 XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
644
645
646 XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
647
648 // TODO add VDI later
649 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
650 XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
651     int core_nb, int mem_cap, int net_cap, char *disk_path, int disk_size, int mig_netspeed, int dp_intensity);
652
653 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
654
655 XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
656
657 /* Shutdown the guest operating system. */
658 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
659
660 XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination);
661
662 /* Suspend the execution of the VM, but keep its state on memory. */
663 XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm);
664 XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm);
665
666 /* Save the VM state to a disk. */
667 XBT_PUBLIC(void) MSG_vm_save(msg_vm_t vm);
668 XBT_PUBLIC(void) MSG_vm_restore(msg_vm_t vm);
669
670 XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm);
671 XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound);
672 XBT_PUBLIC(void) MSG_vm_set_affinity(msg_vm_t vm, msg_host_t pm, unsigned long mask);
673
674 /* TODO: do we need this? */
675 // XBT_PUBLIC(xbt_dynar_t) MSG_vms_as_dynar(void);
676
677 /*
678 void* MSG_process_get_property(msg_process_t, char* key)
679 void MSG_process_set_property(msg_process_t, char* key, void* data)
680 void MSG_vm_set_property(msg_vm_t, char* key, void* data)
681
682 void MSG_vm_setMemoryUsed(msg_vm_t vm, double size);
683 void MSG_vm_setCpuUsed(msg_vm_t vm, double inducedLoad);
684   // inducedLoad: un pourcentage (>100 si ca charge plus d'un coeur;
685   //                              <100 si c'est pas CPU intensive)
686   // Contraintes à poser:
687   //   HOST_Power >= CpuUsedVm (\forall VM) + CpuUsedTask (\forall Task)
688   //   VM_coreAmount >= Load de toutes les tasks
689 */
690
691   /*
692 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_host(msg_host_t)
693 xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
694 + des fonctions de filtrage sur les dynar
695 */
696 #include "simgrid/instr.h"
697
698
699
700 /* ****************************************************************************************** */
701 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
702 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
703
704 SG_END_DECL()
705 #endif