Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Change variable waiting_task to waiting_action on msg process control.
[simgrid.git] / src / msg / msg_mailbox.c
index a6556a2..c285b60 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
+#include "mailbox.h"
+#include "msg/private.h"
+
+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();
+}
+
+void MSG_mailbox_mod_exit(void)
+{
+  xbt_dict_free(&msg_mailboxes);
+}
+
+msg_mailbox_t MSG_mailbox_create(const char *alias)
+{
+  msg_mailbox_t mailbox = xbt_new0(s_msg_mailbox_t, 1);
+
+  mailbox->tasks = xbt_fifo_new();
+  mailbox->cond = NULL;
+  mailbox->alias = alias ? xbt_strdup(alias) : NULL;
+  mailbox->hostname = NULL;
+
+  return 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;
+}
+
+void MSG_mailbox_free(void *mailbox)
+{
+  msg_mailbox_t _mailbox = (msg_mailbox_t) mailbox;
+
+  if (_mailbox->hostname)
+    free(_mailbox->hostname);
+
+  xbt_fifo_free(_mailbox->tasks);
+  free(_mailbox->alias);
+
+  free(_mailbox);
+}
+
+smx_cond_t MSG_mailbox_get_cond(msg_mailbox_t mailbox)
+{
+  return mailbox->cond;
+}
+
+void MSG_mailbox_remove(msg_mailbox_t mailbox, m_task_t task)
+{
+  xbt_fifo_remove(mailbox->tasks, task);
+}
+
+int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
+{
+  return (NULL == xbt_fifo_get_first_item(mailbox->tasks));
+}
+
+m_task_t MSG_mailbox_pop_head(msg_mailbox_t mailbox)
+{
+  return (m_task_t) xbt_fifo_shift(mailbox->tasks);
+}
+
+m_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
+{
+  xbt_fifo_item_t item;
+
+  if (!(item = xbt_fifo_get_first_item(mailbox->tasks)))
+    return NULL;
+
+  return (m_task_t) xbt_fifo_get_item_content(item);
+}
+
+
+m_task_t MSG_mailbox_get_first_host_task(msg_mailbox_t mailbox, m_host_t host)
+{
+  m_task_t task = NULL;
+  xbt_fifo_item_t item = NULL;
+
+  xbt_fifo_foreach(mailbox->tasks, item, task, m_task_t)
+    if (task->simdata->source == host) {
+    xbt_fifo_remove_item(mailbox->tasks, item);
+    return task;
+  }
+
+  return NULL;
+}
+
+int
+MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, m_host_t host)
+{
+  m_task_t task = NULL;
+  xbt_fifo_item_t item = NULL;
+  int count = 0;
+
+  xbt_fifo_foreach(mailbox->tasks, item, task, m_task_t) {
+    if (task->simdata->source == host)
+      count++;
+  }
+
+  return count;
+}
+
+void MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond)
+{
+  mailbox->cond = cond;
+}
+
+const char *MSG_mailbox_get_alias(msg_mailbox_t mailbox)
+{
+  return mailbox->alias;
+}
+
+const char *MSG_mailbox_get_hostname(msg_mailbox_t mailbox)
+{
+  return mailbox->hostname;
+}
+
+void MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char *hostname)
+{
+  mailbox->hostname = xbt_strdup(hostname);
+}
+
+msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
+{
+
+  msg_mailbox_t mailbox = xbt_dict_get_or_null(msg_mailboxes, alias);
+
+  if (!mailbox) {
+    mailbox = MSG_mailbox_new(alias);
+    MSG_mailbox_set_hostname(mailbox, MSG_host_self()->name);
+  }
+
+  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)
+{
+  m_process_t process = MSG_process_self();
+  m_task_t t = NULL;
+  m_host_t h = NULL;
+  simdata_task_t t_simdata = NULL;
+  simdata_host_t h_simdata = NULL;
+  double start_time = SIMIX_get_clock();
+
+  smx_cond_t cond = NULL;       //conditional wait if the task isn't on the channel yet
+
+  CHECK_HOST();
+
+  /* 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.");
+
+  /* Get the task */
+  h = MSG_host_self();
+  h_simdata = h->simdata;
+
+  SIMIX_mutex_lock(h_simdata->mutex);   //FIXME: lock the mailbox instead
+
+  if (MSG_mailbox_get_cond(mailbox)) {
+    CRITICAL1
+      ("A process is already blocked on the channel %s (meaning that someone is already doing a get on this)",
+       MSG_mailbox_get_alias(mailbox));
+    SIMIX_cond_display_info(MSG_mailbox_get_cond(mailbox));
+    xbt_die("Go fix your code!");
+  }
+
+  while (1) {
+    /* if the mailbox is not empty (has a task) */
+    if (!MSG_mailbox_is_empty(mailbox)) {
+      if (!host) {
+        /* pop the head of the mailbox */
+        t = MSG_mailbox_pop_head(mailbox);
+        break;
+      } else {
+        /* get the first task of the host */
+        if ((t = MSG_mailbox_get_first_host_task(mailbox, host)))
+          break;
+      }
+    }
+
+    if ((timeout > 0) && (SIMIX_get_clock() - start_time >= timeout)) { // Timeout already elapsed
+      SIMIX_mutex_unlock(h_simdata->mutex);
+      MSG_mailbox_set_cond(mailbox, NULL);
+      SIMIX_cond_destroy(cond);
+      MSG_RETURN(MSG_TRANSFER_FAILURE);
+    }
+
+    if (!cond) {
+      cond = SIMIX_cond_init();
+      MSG_mailbox_set_cond(mailbox, cond);
+    }
+
+    if (timeout > 0)
+      SIMIX_cond_wait_timeout(cond, h_simdata->mutex,
+                              timeout - start_time + SIMIX_get_clock());
+    else
+      SIMIX_cond_wait(cond, h_simdata->mutex);
+
+    if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
+      SIMIX_mutex_unlock(h_simdata->mutex);
+      MSG_mailbox_set_cond(mailbox, NULL);
+      SIMIX_cond_destroy(cond);
+      MSG_RETURN(MSG_HOST_FAILURE);
+    }
+  }
+
+
+  DEBUG1("OK, got a task (%s)", t->name);
+  /* clean conditional */
+  if (cond) {
+    MSG_mailbox_set_cond(mailbox, NULL);
+    SIMIX_cond_destroy(cond);
+  }
+
+  SIMIX_mutex_unlock(h_simdata->mutex);
+
+  t_simdata = t->simdata;
+  t_simdata->receiver = process;
+  *task = t;
+
+  SIMIX_mutex_lock(t_simdata->mutex);
+
+  /* Transfer */
+  /* create SIMIX action to the communication */
+  t_simdata->comm =
+    SIMIX_action_communicate(t_simdata->sender->simdata->m_host->
+                             simdata->smx_host,
+                             process->simdata->m_host->simdata->smx_host,
+                             t->name, t_simdata->message_size,
+                             t_simdata->rate);
+
+  SIMIX_action_use(t_simdata->comm);
+
+  /* if the process is suspend, create the action but stop its execution, it will be restart when the sender process resume */
+  if (MSG_process_is_suspended(t_simdata->sender)) {
+    DEBUG1("Process sender (%s) suspended", t_simdata->sender->name);
+    SIMIX_action_set_priority(t_simdata->comm, 0);
+  }
+  SIMIX_register_action_to_condition(t_simdata->comm, t_simdata->cond);
+  // breaking point if asynchrounous
+  process->simdata->waiting_action = t_simdata->comm;
+
+  while (1) {
+    SIMIX_cond_wait(t_simdata->cond, t_simdata->mutex);
+
+    if (SIMIX_action_get_state(t_simdata->comm) != SURF_ACTION_RUNNING)
+      break;
+    if (!SIMIX_host_get_state(h_simdata->smx_host))
+      break;
+    if (!SIMIX_host_get_state(process->simdata->m_host->simdata->smx_host))
+      break;
+  }
+
+  SIMIX_unregister_action_to_condition(t_simdata->comm, t_simdata->cond);
+  process->simdata->waiting_action = NULL;
+
+  /* for this process, don't need to change in get function */
+  SIMIX_mutex_unlock(t_simdata->mutex);
+
+  if (SIMIX_action_get_state(t_simdata->comm) == SURF_ACTION_DONE) {
+    if (SIMIX_action_destroy(t_simdata->comm))
+      t_simdata->comm = NULL;
+    MSG_RETURN(MSG_OK);
+  } else if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
+    if (SIMIX_action_destroy(t_simdata->comm))
+      t_simdata->comm = NULL;
+    MSG_RETURN(MSG_HOST_FAILURE);
+  } else {
+    if (SIMIX_action_destroy(t_simdata->comm))
+      t_simdata->comm = NULL;
+    MSG_RETURN(MSG_TRANSFER_FAILURE);
+  }
+}
+
+MSG_error_t
+MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
+                             double timeout)
+{
+  m_process_t process = MSG_process_self();
+  const char *hostname;
+  simdata_task_t t_simdata = NULL;
+  m_host_t local_host = NULL;
+  m_host_t remote_host = NULL;
+  smx_cond_t cond = NULL;
+
+  CHECK_HOST();
+
+  t_simdata = task->simdata;
+  t_simdata->sender = process;
+  t_simdata->source = MSG_process_get_host(process);
+
+  xbt_assert0(t_simdata->refcount == 1,
+              "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
+
+  t_simdata->comm = NULL;
+
+  t_simdata->refcount++;
+  local_host = ((simdata_process_t) process->simdata)->m_host;
+  msg_global->sent_msg++;
+
+  /* get the host name containing the mailbox */
+  hostname = MSG_mailbox_get_hostname(mailbox);
+
+  remote_host = MSG_get_host_by_name(hostname);
+
+  if (!remote_host)
+    THROW1(not_found_error, 0, "Host %s not fount", hostname);
+
+
+  DEBUG4("Trying to send a task (%g kB) from %s to %s on the channel %s",
+         t_simdata->message_size / 1000, local_host->name,
+         remote_host->name, MSG_mailbox_get_alias(mailbox));
+
+  SIMIX_mutex_lock(remote_host->simdata->mutex);        /* FIXME: lock the mailbox instead */
+
+  /* put the task in the mailbox */
+  xbt_fifo_push(mailbox->tasks, task);
+
+  if ((cond = MSG_mailbox_get_cond(mailbox))) {
+    DEBUG0("Somebody is listening. Let's wake him up!");
+    SIMIX_cond_signal(cond);
+  }
+
+  SIMIX_mutex_unlock(remote_host->simdata->mutex);
+
+  SIMIX_mutex_lock(t_simdata->mutex);
+
+  process->simdata->waiting_action = t_simdata->comm;   // for debugging and status displaying purpose
+
+  if (timeout > 0) {
+    xbt_ex_t e;
+    double time;
+    double time_elapsed;
+    time = SIMIX_get_clock();
+
+    TRY {
+      /*verify if the action that ends is the correct. Call the wait_timeout with the new time. If the timeout occurs, an exception is raised */
+      while (1) {
+        time_elapsed = SIMIX_get_clock() - time;
+        SIMIX_cond_wait_timeout(t_simdata->cond, t_simdata->mutex,
+                                timeout - time_elapsed);
+
+        if (t_simdata->comm)
+          SIMIX_action_use(t_simdata->comm);
+        if (t_simdata->comm && (SIMIX_action_get_state(t_simdata->comm) !=
+                                SURF_ACTION_RUNNING))
+          break;
+        if (!SIMIX_host_get_state(local_host->simdata->smx_host))
+          break;
+        if (!SIMIX_host_get_state(remote_host->simdata->smx_host))
+          break;
+      }
+    }
+    CATCH(e) {
+      if (e.category == timeout_error) {
+        xbt_ex_free(e);
+        /* verify if the timeout happened and the communication didn't started yet */
+        if (t_simdata->comm == NULL) {
+          DEBUG1("Action terminated %s (there was a timeout)", task->name);
+          process->simdata->waiting_action = NULL;
+
+          /* remove the task from the mailbox */
+          MSG_mailbox_remove(mailbox, task);
+
+/*           if (t_simdata->receiver && t_simdata->receiver->simdata) {    /\* receiver still around *\/ */
+/*             t_simdata->receiver->simdata->waiting_task = NULL; */
+/*           } */
+
+          SIMIX_mutex_unlock(t_simdata->mutex);
+          MSG_RETURN(MSG_TRANSFER_FAILURE);
+        }
+      } else {
+        RETHROW;
+      }
+    }
+  } else {
+    while (1) {                 //FIXME: factorize with the code right above
+      SIMIX_cond_wait(t_simdata->cond, t_simdata->mutex);
+
+      if (t_simdata->comm)
+        SIMIX_action_use(t_simdata->comm);
+      if (t_simdata->comm
+          && SIMIX_action_get_state(t_simdata->comm) != SURF_ACTION_RUNNING)
+        break;
+      if (!SIMIX_host_get_state(local_host->simdata->smx_host))
+        break;
+      if (!SIMIX_host_get_state(remote_host->simdata->smx_host))
+        break;
+    }
+  }
+
+  DEBUG1("Action terminated %s", task->name);
+  process->simdata->waiting_action = NULL;
+/*   if (t_simdata->receiver && t_simdata->receiver->simdata) {    /\* receiver still around *\/ */
+/*     t_simdata->receiver->simdata->waiting_task = NULL; */
+/*   } */
+
+  SIMIX_mutex_unlock(t_simdata->mutex);
+
+  if (t_simdata->comm
+      && SIMIX_action_get_state(t_simdata->comm) == SURF_ACTION_DONE) {
+    if (SIMIX_action_destroy(t_simdata->comm))
+      t_simdata->comm = NULL;
+    t_simdata->refcount--;
+    MSG_RETURN(MSG_OK);
+  } else if (SIMIX_host_get_state(local_host->simdata->smx_host) == 0) {
+    if (t_simdata->comm && SIMIX_action_destroy(t_simdata->comm))
+      t_simdata->comm = NULL;
+    MSG_RETURN(MSG_HOST_FAILURE);
+  } else {
+    if (t_simdata->comm && SIMIX_action_destroy(t_simdata->comm))
+      t_simdata->comm = NULL;
+    MSG_RETURN(MSG_TRANSFER_FAILURE);
+  }
+}