Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix race condition on task put/get
[simgrid.git] / src / msg / msg_mailbox.c
index a6556a2..5de723a 100644 (file)
-#include "msg_mailbox.h"\r
-#include "msg/private.h"\r
-\r
-static xbt_dict_t \r
-msg_mailboxes = NULL;\r
-\r
-xbt_dict_t\r
-MSG_get_mailboxes(void)\r
-{\r
-       return msg_mailboxes;\r
-}\r
-\r
-void\r
-MSG_mailbox_mod_init(void)\r
-{\r
-       msg_mailboxes = xbt_dict_new(); \r
-}\r
-\r
-void\r
-MSG_mailbox_mod_exit(void)\r
-{\r
-       xbt_dict_free(&msg_mailboxes);\r
-}\r
-\r
-msg_mailbox_t\r
-MSG_mailbox_new(const char *alias)\r
-{\r
-       msg_mailbox_t mailbox = xbt_new0(s_msg_mailbox_t,1);\r
-       \r
-       mailbox->tasks = xbt_fifo_new();\r
-       mailbox->cond = NULL;\r
-       mailbox->alias = xbt_strdup(alias);\r
-       mailbox->hostname = NULL;\r
-       \r
-       /* add the mbox in the dictionary */\r
-       xbt_dict_set(msg_mailboxes, alias, mailbox, MSG_mailbox_free);\r
-       \r
-       return mailbox;\r
-}\r
-\r
-void\r
-MSG_mailbox_destroy(msg_mailbox_t* mailbox)\r
-{\r
-       xbt_dict_remove(msg_mailboxes,(*mailbox)->alias);\r
-\r
-       if(NULL != ((*mailbox)->hostname))\r
-               free((*mailbox)->hostname);\r
-\r
-       \r
-       free((*mailbox)->alias);\r
-       \r
-       free(*mailbox);\r
-       \r
-       *mailbox = NULL;        \r
-}\r
-\r
-void\r
-MSG_mailbox_put(msg_mailbox_t mailbox, m_task_t task)\r
-{\r
-       xbt_fifo_push(mailbox->tasks, task);\r
-}\r
-\r
-smx_cond_t\r
-MSG_mailbox_get_cond(msg_mailbox_t mailbox)\r
-{\r
-       return mailbox->cond;\r
-}\r
-\r
-void\r
-MSG_mailbox_remove(msg_mailbox_t mailbox, m_task_t task)\r
-{\r
-       xbt_fifo_remove(mailbox->tasks,task);\r
-}\r
-\r
-int\r
-MSG_mailbox_is_empty(msg_mailbox_t mailbox)\r
-{\r
-       return (NULL == xbt_fifo_get_first_item(mailbox->tasks));\r
-}\r
-\r
-m_task_t\r
-MSG_mailbox_pop_head(msg_mailbox_t mailbox)\r
-{\r
-       return (m_task_t)xbt_fifo_shift(mailbox->tasks);\r
-}\r
-\r
-m_task_t\r
-MSG_mailbox_get_head(msg_mailbox_t mailbox)\r
-{\r
-       xbt_fifo_item_t item;\r
-       \r
-       if(NULL == (item = xbt_fifo_get_first_item(mailbox->tasks)))\r
-               return NULL;\r
-               \r
-       return (m_task_t)xbt_fifo_get_item_content(item);\r
-}\r
-\r
-m_task_t\r
-MSG_mailbox_get_first_host_task(msg_mailbox_t mailbox, m_host_t host)\r
-{\r
-       m_task_t task = NULL;\r
-       xbt_fifo_item_t item = NULL;\r
-       \r
-       xbt_fifo_foreach(mailbox->tasks, item, task, m_task_t) \r
-       {\r
-               if (task->simdata->source == host)\r
-                       break;\r
-       }\r
-       \r
-       if(item) \r
-               xbt_fifo_remove_item(mailbox->tasks, item);\r
-               \r
-       return task;\r
-}\r
-\r
-int\r
-MSG_mailbox_get_count_host_tasks(msg_mailbox_t mailbox, m_host_t host)\r
-{\r
-       m_task_t task = NULL;\r
-       xbt_fifo_item_t item = NULL;\r
-       int count = 0;\r
-       \r
-       xbt_fifo_foreach(mailbox->tasks, item, task, m_task_t) \r
-       {\r
-               if (task->simdata->source == host)\r
-                       count++;\r
-       }\r
-               \r
-       return count;\r
-}\r
-\r
-void\r
-MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond)\r
-{\r
-       mailbox->cond = cond;\r
-}\r
-\r
-const char*\r
-MSG_mailbox_get_alias(msg_mailbox_t mailbox)\r
-{\r
-       return mailbox->alias;\r
-}\r
-\r
-const char*\r
-MSG_mailbox_get_hostname(msg_mailbox_t mailbox)\r
-{\r
-       return mailbox->hostname;\r
-}\r
-\r
-void\r
-MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char* hostname)\r
-{\r
-       mailbox->hostname = xbt_strdup(hostname);\r
-}\r
-\r
-void\r
-MSG_mailbox_free(void* mailbox)\r
-{\r
-       msg_mailbox_t __mailbox = (msg_mailbox_t)mailbox;\r
-\r
-       if(NULL != (__mailbox->hostname))\r
-               free(__mailbox->hostname);\r
-\r
-       free(__mailbox->alias);\r
-       \r
-       free(__mailbox);\r
-}\r
-\r
-msg_mailbox_t\r
-MSG_mailbox_get_by_alias(const char* alias)\r
-{\r
-\r
-       msg_mailbox_t mailbox = xbt_dict_get_or_null(msg_mailboxes,alias);\r
-   \r
-       if(!mailbox)\r
-       {\r
-               mailbox = MSG_mailbox_new(alias);\r
-               MSG_mailbox_set_hostname(mailbox,MSG_host_self()->name);\r
-       }\r
-       \r
-       return mailbox; \r
-}\r
+/* Mailboxes in MSG */
+
+/* Copyright (c) 2008, 2009, 2010. The SimGrid Team.
+ * All rights reserved.                                                     */
+
+/* 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. */
+
+#include "mailbox.h"
+#include "msg/private.h"
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
+                                "Logging specific to MSG (mailbox)");
+
+msg_mailbox_t MSG_mailbox_new(const char *alias)
+{
+  return SIMIX_req_rdv_create(alias);
+}
+
+void MSG_mailbox_free(void *mailbox)
+{
+  SIMIX_req_rdv_destroy((msg_mailbox_t)mailbox);
+}
+
+int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
+{
+  return (NULL == SIMIX_req_rdv_get_head(mailbox));
+}
+
+m_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
+{
+  smx_action_t comm = SIMIX_req_rdv_get_head(mailbox);
+
+  if (!comm)
+    return NULL;
+
+  return (m_task_t) SIMIX_req_comm_get_src_data(comm);
+}
+
+int
+MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
+                                         m_host_t host)
+{
+  return SIMIX_req_rdv_comm_count_by_host(mailbox,
+                                      host->simdata->smx_host);
+}
+
+msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
+{
+
+  msg_mailbox_t mailbox = SIMIX_req_rdv_get_by_name(alias);
+
+  if (!mailbox)
+    mailbox = MSG_mailbox_new(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);
+
+  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)
+{
+  xbt_ex_t e;
+  MSG_error_t ret = MSG_OK;
+  smx_action_t comm = NULL;
+#ifdef HAVE_TRACING
+  double start_time = 0;
+#endif
+  /* We no longer support getting a task from a specific host */
+  if (host)
+    THROW_UNIMPLEMENTED;
+
+  CHECK_HOST();
+#ifdef HAVE_TRACING
+  TRACE_msg_task_get_start();
+  start_time = MSG_get_clock();
+#endif
+
+  /* Sanity check */
+  xbt_assert0(task, "Null pointer for the task storage");
+
+  if (*task)
+    CRITICAL0
+        ("MSG_task_get() was asked to write in a non empty task struct.");
+
+  /* Try to receive it by calling SIMIX network layer */
+  TRY {
+    comm = SIMIX_req_comm_irecv(mailbox, task, NULL, NULL, NULL);
+    SIMIX_req_comm_wait(comm, timeout);
+    (*task)->simdata->comm = comm;
+    SIMIX_req_comm_destroy(comm);
+    DEBUG2("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;
+      break;
+    default:
+       xbt_backtrace_display(&e);
+      xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
+    }
+    xbt_ex_free(e);
+  }
+
+  if (ret != MSG_HOST_FAILURE &&
+      ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
+#ifdef HAVE_TRACING
+    TRACE_msg_task_get_end(start_time, *task);
+#endif
+  }
+  MSG_RETURN(ret);
+}
+
+MSG_error_t
+MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
+                             double timeout)
+{
+  xbt_ex_t e;
+  MSG_error_t ret = MSG_OK;
+  simdata_task_t t_simdata = NULL;
+  m_process_t process = MSG_process_self();
+  smx_action_t comm;
+#ifdef HAVE_TRACING
+  int call_end = 0;
+#endif
+  CHECK_HOST();
+
+#ifdef HAVE_TRACING
+  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();
+
+  xbt_assert0(t_simdata->isused == 0,
+              "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
+
+  t_simdata->isused=1;
+  msg_global->sent_msg++;
+
+  process->simdata->waiting_task = task;
+
+  /* Try to send it by calling SIMIX network layer */
+  TRY {
+    comm = SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
+             t_simdata->rate, task, sizeof(void *), NULL, NULL);
+    t_simdata->comm = comm;
+#ifdef HAVE_TRACING
+    SIMIX_req_set_category(comm, task->category);
+#endif
+    SIMIX_req_comm_wait(comm, timeout);
+    SIMIX_req_comm_destroy(comm);
+  }
+
+  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;
+      break;
+    default:
+      xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
+    }
+    xbt_ex_free(e);
+
+    /* If the send failed, it is not used anymore */
+    t_simdata->isused=0;
+  }
+
+  process->simdata->waiting_task = NULL;
+#ifdef HAVE_TRACING
+  if (call_end)
+    TRACE_msg_task_put_end();
+#endif
+  MSG_RETURN(ret);
+}