Logo AND Algorithmique Numérique Distribuée

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