Logo AND Algorithmique Numérique Distribuée

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