[simix] Update TODO for simgrid::simix::Future

[simgrid.git] / include / simgrid / msg.h

diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h
index ea973f2..2759482 100644 (file)
--- a/include/simgrid/msg.h
+++ b/include/simgrid/msg.h
@@ -79,20 +79,17 @@ typedef struct msg_task *msg_task_t;
 /* ******************************** VM ************************************* */
 typedef msg_host_t msg_vm_t;
 
-/** ******************************** File ************************************ */
+/* ******************************** File ************************************ */
 
-/** @brief File datatype.
-*  @ingroup msg_file_management
-*
-*  You should consider this as an opaque object.
-*/
+/** @brief Opaque object describing a File in MSG.
+ *  @ingroup msg_file */
 typedef xbt_dictelm_t msg_file_t;
 typedef s_xbt_dictelm_t s_msg_file_t;
 
 extern int MSG_FILE_LEVEL;
 typedef struct simdata_file *simdata_file_t;
 
-typedef struct msg_file_priv  {
+struct msg_file_priv  {
   char *fullpath;
   sg_size_t size;
   char* mount_point;
@@ -102,7 +99,9 @@ typedef struct msg_file_priv  {
   int desc_id;
   void *data;
   simdata_file_t simdata;
-} s_msg_file_priv_t, *msg_file_priv_t;
+};
+typedef struct msg_file_priv s_msg_file_priv_t;
+typedef struct msg_file_priv* msg_file_priv_t;
 
 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
@@ -121,10 +120,12 @@ extern int MSG_STORAGE_LEVEL;
 typedef xbt_dictelm_t msg_storage_t;
 typedef s_xbt_dictelm_t s_msg_storage_t;
 
-typedef struct msg_storage_priv  {
+struct msg_storage_priv  {
   const char *hostname;
   void *data;
-} s_msg_storage_priv_t, *msg_storage_priv_t;
+};
+typedef struct msg_storage_priv  s_msg_storage_priv_t;
+typedef struct msg_storage_priv* msg_storage_priv_t;
 
 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
@@ -155,7 +156,7 @@ typedef struct msg_comm *msg_comm_t;
     structure, but always use the provided API to interact with
     processes.
  */
-typedef struct s_smx_process *msg_process_t;
+typedef smx_process_t msg_process_t;
 
 /** @brief Return code of most MSG functions
     @ingroup msg_simulation
@@ -484,14 +485,12 @@ XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
  * @param   mailbox  The mailbox concerned by the operation.
  * @return           The task at the head of the mailbox.
  */
-XBT_PUBLIC(msg_task_t) MSG_mailbox_get_head(msg_mailbox_t mailbox);
+XBT_PUBLIC(msg_task_t) MSG_mailbox_front(msg_mailbox_t mailbox);
 
 XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task, msg_host_t host,
                                                  double timeout);
 XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host,
                                                          double timeout, double rate);
-XBT_PUBLIC(msg_error_t) MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task, double timeout);
-
 
 /************************** Action handling **********************************/
 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
@@ -531,17 +530,17 @@ XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
  *
  */
 
-XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
+XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
 
-XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
+XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t vm);
 
 
-XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
+XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm);
 
 // TODO add VDI later
 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
@@ -550,7 +549,7 @@ XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
 
 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 
-XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
+XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
 
 /* Shutdown the guest operating system. */
 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
@@ -599,5 +598,10 @@ xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 
+
+/* Functions renamed in 3.14 */
+#define MSG_mailbox_get_head(m) MSG_mailbox_front(m)
+
+
 SG_END_DECL()
 #endif