Logo AND Algorithmique Numérique Distribuée

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