Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Don't define variables in header file.!
[simgrid.git] / src / msg / msg_mailbox.c
index c0e97dc..942f332 100644 (file)
@@ -1,92 +1,53 @@
-#include "mailbox.h"
-#include "msg/private.h"
+/* Mailboxes in MSG */
 
-XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
-                                "Logging specific to MSG (mailbox)");
-
-static xbt_dict_t msg_mailboxes = NULL;
-
-void MSG_mailbox_mod_init(void)
-{
-  msg_mailboxes = xbt_dict_new();
-}
+/* Copyright (c) 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
 
-void MSG_mailbox_mod_exit(void)
-{
-  xbt_dict_free(&msg_mailboxes);
-}
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
 
-msg_mailbox_t MSG_mailbox_create(const char *alias)
-{
-  msg_mailbox_t mailbox = xbt_new0(s_msg_mailbox_t, 1);
+#include "msg_mailbox.h"
+#include "msg_private.h"
 
-  mailbox->cond = NULL;
-  mailbox->alias = alias ? xbt_strdup(alias) : NULL;
-  mailbox->rdv = SIMIX_rdv_create(alias);
-  
-  return mailbox;
-}
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
+                                "Logging specific to MSG (mailbox)");
 
 msg_mailbox_t MSG_mailbox_new(const char *alias)
 {
-  msg_mailbox_t mailbox = MSG_mailbox_create(alias);
-
-  /* add the mbox in the dictionary */
-  xbt_dict_set(msg_mailboxes, alias, mailbox, MSG_mailbox_free);
-
-  return mailbox;
+  return simcall_rdv_create(alias);
 }
 
 void MSG_mailbox_free(void *mailbox)
 {
-  msg_mailbox_t _mailbox = (msg_mailbox_t) mailbox;
-
-  free(_mailbox->alias);
-  SIMIX_rdv_destroy(_mailbox->rdv);
-  
-  free(_mailbox);
-}
-
-smx_cond_t MSG_mailbox_get_cond(msg_mailbox_t mailbox)
-{
-  return mailbox->cond;
+  simcall_rdv_destroy((msg_mailbox_t)mailbox);
 }
 
 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
 {
-  return (NULL == SIMIX_rdv_get_head(mailbox->rdv));
+  return (NULL == simcall_rdv_get_head(mailbox));
 }
 
-m_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
+msg_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
 {
-  smx_comm_t comm = SIMIX_rdv_get_head(mailbox->rdv);
-
-  if(!comm)
-    return NULL; 
-  
-  return (m_task_t)SIMIX_communication_get_data(comm);
-}
+  smx_action_t comm = simcall_rdv_get_head(mailbox);
 
-int
-MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, m_host_t host)
-{
-  return SIMIX_rdv_get_count_waiting_comm (mailbox->rdv, host->simdata->smx_host);
-}
+  if (!comm)
+    return NULL;
 
-void MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond)
-{
-  mailbox->cond = cond;
+  return (msg_task_t) simcall_comm_get_src_data(comm);
 }
 
-const char *MSG_mailbox_get_alias(msg_mailbox_t mailbox)
+int
+MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
+                                         msg_host_t host)
 {
-  return mailbox->alias;
+  return simcall_rdv_comm_count_by_host(mailbox, host);
 }
 
 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
 {
 
-  msg_mailbox_t mailbox = xbt_dict_get_or_null(msg_mailboxes, alias);
+  msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
 
   if (!mailbox)
     mailbox = MSG_mailbox_new(alias);
@@ -94,123 +55,168 @@ msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
   return mailbox;
 }
 
-msg_mailbox_t MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel)
-{
-  xbt_assert0((host != NULL), "Invalid host");
-  xbt_assert1((channel >= 0)
-              && (channel < msg_global->max_channel), "Invalid channel %d",
-              channel);
+/** \ingroup msg_mailbox_management
+ * \brief Set the mailbox to receive in asynchronous mode
+ *
+ * All messages sent to this mailbox will be transferred to 
+ * the receiver without waiting for the receive call. 
+ * The receive call will still be necessary to use the received data.
+ * If there is a need to receive some messages asynchronously, and some not, 
+ * two different mailboxes should be used.
+ *
+ * \param alias The name of the mailbox 
+ */
+void MSG_mailbox_set_async(const char *alias){
+  msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
+
+  simcall_rdv_set_receiver(mailbox, SIMIX_process_self());
+  XBT_VERB("%s mailbox set to receive eagerly for process %p\n",alias, SIMIX_process_self());
 
-  return host->simdata->mailboxes[(size_t) channel];
 }
 
-MSG_error_t
-MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t *task, m_host_t host,
-                         double timeout)
+/** \ingroup msg_mailbox_management
+ * \brief Get a task from a mailbox on a given host
+ *
+ * \param mailbox The mailbox where the task was sent
+ * \param task a memory location for storing a #msg_task_t.
+ * \param host a #msg_host_t host from where the task was sent
+ * \param timeout a timeout
+
+ * \return Returns
+ * #MSG_OK if the task was successfully received,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
+ */
+msg_error_t
+MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
+                         msg_host_t host, double timeout)
 {
   xbt_ex_t e;
-  MSG_error_t ret = MSG_OK;
-  smx_comm_t comm;
-
+  msg_error_t ret = MSG_OK;
   /* We no longer support getting a task from a specific host */
-  if (host) THROW_UNIMPLEMENTED;
-
-  CHECK_HOST();
-
-  memset(&comm,0,sizeof(comm));
+  if (host)
+    THROW_UNIMPLEMENTED;
 
-  /* Kept for compatibility with older implementation */
-  xbt_assert1(!MSG_mailbox_get_cond(mailbox),
-              "A process is already blocked on this channel %s", 
-              MSG_mailbox_get_alias(mailbox));
+#ifdef HAVE_TRACING
+  TRACE_msg_task_get_start();
+  double start_time = MSG_get_clock();
+#endif
 
   /* Sanity check */
-  xbt_assert0(task, "Null pointer for the task storage");
+  xbt_assert(task, "Null pointer for the task storage");
 
   if (*task)
-    CRITICAL0("MSG_task_get() was asked to write in a non empty task struct.");
+    XBT_WARN
+        ("Asked to write the received task in a non empty struct -- proceeding.");
 
   /* Try to receive it by calling SIMIX network layer */
-  TRY{
-    SIMIX_network_recv(mailbox->rdv, timeout, task, NULL, &comm);
-    //INFO2("Got task %s from %s",(*task)->name,mailbox->alias);
-    (*task)->simdata->refcount--;
+  TRY {
+    simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
+    XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
+    (*task)->simdata->isused=0;
   }
-  CATCH(e){
-    switch(e.category){
-      case host_error:
-        ret = MSG_HOST_FAILURE;
-        break;
-      case network_error:
-        ret = MSG_TRANSFER_FAILURE;
-        break;
-      case timeout_error:
-        ret = MSG_TIMEOUT_FAILURE;
-        break;      
-      default:
-        xbt_die(bprintf("Unhandled SIMIX network exception: %s",e.msg));
+  CATCH(e) {
+    switch (e.category) {
+    case network_error:
+      ret = MSG_TRANSFER_FAILURE;
+      break;
+    case timeout_error:
+      ret = MSG_TIMEOUT;
+      break;
+    default:
+      RETHROW;
     }
-    xbt_ex_free(e);        
+    xbt_ex_free(e);
+  }
+
+#ifdef HAVE_TRACING
+  if (ret != MSG_HOST_FAILURE &&
+      ret != MSG_TRANSFER_FAILURE &&
+      ret != MSG_TIMEOUT) {
+    TRACE_msg_task_get_end(start_time, *task);
   }
-  
-  MSG_RETURN(ret);        
+#endif
+  MSG_RETURN(ret);
 }
 
-MSG_error_t
-MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
+msg_error_t
+MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
                              double timeout)
 {
   xbt_ex_t e;
-  MSG_error_t ret = MSG_OK;
+  msg_error_t ret = MSG_OK;
   simdata_task_t t_simdata = NULL;
-  m_process_t process = MSG_process_self();
-  
-  CHECK_HOST();
+  msg_process_t process = MSG_process_self();
+  simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
+
+#ifdef HAVE_TRACING
+  int call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
+#endif
 
   /* Prepare the task to send */
   t_simdata = task->simdata;
   t_simdata->sender = process;
-  t_simdata->source = MSG_host_self();
+  t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
 
-  xbt_assert0(t_simdata->refcount == 1,
+  xbt_assert(t_simdata->isused == 0,
               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 
-  t_simdata->refcount++;
+  t_simdata->isused=1;
+  t_simdata->comm = NULL;
   msg_global->sent_msg++;
 
-  process->simdata->waiting_task = task;
-  
-  /* Try to send it by calling SIMIX network layer */
-  TRY{
-    /* Kept for semantical compatibility with older implementation */
-    if(mailbox->cond)
-      SIMIX_cond_signal(mailbox->cond);
 
-    SIMIX_network_send(mailbox->rdv, t_simdata->message_size, t_simdata->rate,
-                       timeout, task, sizeof(void*), &t_simdata->comm, task);
+  p_simdata->waiting_task = task;
+
+  /* Try to send it by calling SIMIX network layer */
+  TRY {
+      smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
+                                  t_simdata->rate, task, sizeof(void *),
+                                  NULL, NULL, task, 0);
+#ifdef HAVE_TRACING
+    if (TRACE_is_enabled()) {
+      simcall_set_category(comm, task->category);
+    }
+#endif
+     t_simdata->comm = comm;
+     simcall_comm_wait(comm, timeout);
   }
 
-  CATCH(e){
-    switch(e.category){
-      case host_error:
-        ret = MSG_HOST_FAILURE;
-        break;
-      case network_error:
-        ret = MSG_TRANSFER_FAILURE;
-        break;
-      case timeout_error:
-        ret = MSG_TIMEOUT_FAILURE;
-        break;
-      default:
-        xbt_die(bprintf("Unhandled SIMIX network exception: %s",e.msg));
+  CATCH(e) {
+    switch (e.category) {
+    case network_error:
+      ret = MSG_TRANSFER_FAILURE;
+      break;
+    case timeout_error:
+      ret = MSG_TIMEOUT;
+      break;
+    default:
+      RETHROW;
     }
     xbt_ex_free(e);
 
-    /* Decrement the refcount only on failure */
-    t_simdata->refcount--;
+    /* If the send failed, it is not used anymore */
+    t_simdata->isused = 0;
   }
 
-  process->simdata->waiting_task = NULL;
-   
-  MSG_RETURN(ret);        
+
+  p_simdata->waiting_task = NULL;
+#ifdef HAVE_TRACING
+  if (call_end)
+    TRACE_msg_task_put_end();
+#endif
+  MSG_RETURN(ret);
+}
+
+#ifdef MSG_USE_DEPRECATED
+msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
+                                         m_channel_t channel)
+{
+  XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
+  xbt_assert((host != NULL), "Invalid host");
+  xbt_assert((channel >= 0)
+              && (channel < msg_global->max_channel), "Invalid channel %d",
+              channel);
+
+  return host->mailboxes[(size_t) channel];
 }
+#endif