Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Export some mailbox related functions
[simgrid.git] / src / msg / msg_mailbox.c
index 1862138..160503e 100644 (file)
@@ -1,15 +1,12 @@
-#include "msg_mailbox.h"\r
+#include "mailbox.h"\r
 #include "msg/private.h"\r
 \r
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,\r
+                               "Logging specific to MSG (mailbox)");\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
@@ -23,15 +20,23 @@ MSG_mailbox_mod_exit(void)
 }\r
 \r
 msg_mailbox_t\r
-MSG_mailbox_new(const char *alias)\r
+MSG_mailbox_create(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->alias = alias ? xbt_strdup(alias) : NULL;\r
        mailbox->hostname = NULL;\r
        \r
+       return mailbox;\r
+}\r
+\r
+msg_mailbox_t\r
+MSG_mailbox_new(const char *alias)\r
+{\r
+       msg_mailbox_t mailbox = MSG_mailbox_create(alias);\r
+       \r
        /* add the mbox in the dictionary */\r
        xbt_dict_set(msg_mailboxes, alias, mailbox, MSG_mailbox_free);\r
        \r
@@ -39,19 +44,16 @@ MSG_mailbox_new(const char *alias)
 }\r
 \r
 void\r
-MSG_mailbox_destroy(msg_mailbox_t* mailbox)\r
+MSG_mailbox_free(void* mailbox)\r
 {\r
-       xbt_dict_remove(msg_mailboxes,(*mailbox)->alias);\r
+       msg_mailbox_t _mailbox = (msg_mailbox_t)mailbox;\r
 \r
-       if(NULL != ((*mailbox)->hostname))\r
-               free((*mailbox)->hostname);\r
+       if(NULL != (_mailbox->hostname))\r
+               free(_mailbox->hostname);\r
 \r
+       free(_mailbox->alias);\r
        \r
-       free((*mailbox)->alias);\r
-       \r
-       free(*mailbox);\r
-       \r
-       *mailbox = NULL;        \r
+       free(_mailbox);\r
 }\r
 \r
 void\r
@@ -95,26 +97,24 @@ MSG_mailbox_get_head(msg_mailbox_t mailbox)
        return (m_task_t)xbt_fifo_get_item_content(item);\r
 }\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
+ 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
+   if (task->simdata->source == host) {\r
+     xbt_fifo_remove_item(mailbox->tasks, item);\r
+     return task;\r
+   }\r
+\r
+ return NULL;\r
 }\r
 \r
 int\r
-MSG_mailbox_get_count_host_tasks(msg_mailbox_t mailbox, m_host_t host)\r
+MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox, m_host_t host)\r
 {\r
        m_task_t task = NULL;\r
        xbt_fifo_item_t item = NULL;\r
@@ -153,48 +153,324 @@ MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char* hostname)
        mailbox->hostname = xbt_strdup(hostname);\r
 }\r
 \r
-void\r
-MSG_mailbox_free(void* mailbox)\r
+msg_mailbox_t\r
+MSG_mailbox_get_by_alias(const char* alias)\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
+       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
-       free(__mailbox);\r
+       return mailbox; \r
 }\r
 \r
 msg_mailbox_t\r
-MSG_mailbox_get_by_alias(const char* alias)\r
+MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel)\r
 {\r
-       xbt_ex_t e;\r
-       int found = 1;\r
-       msg_mailbox_t mailbox;\r
+        xbt_assert0((host != NULL), "Invalid host");\r
+        xbt_assert1((channel >= 0)&& (channel < msg_global->max_channel), "Invalid channel %d",channel);\r
 \r
-       TRY \r
+        return host->simdata->mailboxes[(size_t)channel];\r
+}\r
+\r
+MSG_error_t \r
+MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t* task, m_host_t host, double timeout)\r
+{\r
+       m_process_t process = MSG_process_self();\r
+       m_task_t t = NULL;\r
+       m_host_t h = NULL;\r
+       simdata_task_t t_simdata = NULL;\r
+       simdata_host_t h_simdata = NULL;\r
+       int first_time = 1;\r
+       \r
+       smx_cond_t cond = NULL; //conditional wait if the task isn't on the channel yet\r
+       \r
+       CHECK_HOST();\r
+       \r
+       /* Sanity check */\r
+       xbt_assert0(task, "Null pointer for the task storage");\r
+       \r
+       if (*task)\r
+               CRITICAL0("MSG_task_get() was asked to write in a non empty task struct.");\r
+       \r
+       /* Get the task */\r
+       h = MSG_host_self();\r
+       h_simdata = h->simdata;\r
+       \r
+       SIMIX_mutex_lock(h->simdata->mutex);\r
+       \r
+       while (1) \r
+       {\r
+               /* if the mailbox is empty (has no task */\r
+               if(!MSG_mailbox_is_empty(mailbox))\r
+               {\r
+                       if(!host) \r
+                       {\r
+                               /* pop the head of the mailbox */\r
+                               t = MSG_mailbox_pop_head(mailbox);\r
+                               break;\r
+                       } \r
+                       else \r
+                       {\r
+                               /* get the first task of the host */\r
+                               if(NULL != (t = MSG_mailbox_get_first_host_task(mailbox,host)))\r
+                                       break;\r
+                       }\r
+               }\r
+       \r
+               if(timeout > 0) \r
+               {\r
+                       if (!first_time) \r
+                       {\r
+                               SIMIX_mutex_unlock(h->simdata->mutex);\r
+                               /* set the simix condition of the mailbox to NULL */\r
+                               MSG_mailbox_set_cond(mailbox, NULL);\r
+                               SIMIX_cond_destroy(cond);\r
+                               MSG_RETURN(MSG_TRANSFER_FAILURE);\r
+                       }\r
+               }\r
+               \r
+               xbt_assert1(!MSG_mailbox_get_cond(mailbox),"A process is already blocked on the channel %s", MSG_mailbox_get_alias(mailbox));\r
+               \r
+               cond = SIMIX_cond_init();\r
+               \r
+               /* set the condition of the mailbox */\r
+               MSG_mailbox_set_cond(mailbox, cond);\r
+               \r
+               if (timeout > 0)\r
+                       SIMIX_cond_wait_timeout(cond, h->simdata->mutex, timeout);\r
+               else \r
+                       SIMIX_cond_wait(MSG_mailbox_get_cond(mailbox), h->simdata->mutex);\r
+                       \r
+       \r
+               if (SIMIX_host_get_state(h_simdata->smx_host) == 0)\r
+                       MSG_RETURN(MSG_HOST_FAILURE);\r
+       \r
+               first_time = 0;\r
+       }\r
+       \r
+       SIMIX_mutex_unlock(h->simdata->mutex);\r
+       \r
+       DEBUG1("OK, got a task (%s)", t->name);\r
+       /* clean conditional */\r
+       if (cond) \r
        {\r
-               mailbox = xbt_dict_get(msg_mailboxes,alias);\r
+               SIMIX_cond_destroy(cond);\r
+               \r
+               MSG_mailbox_set_cond(mailbox,NULL);\r
+       }\r
+       \r
+       t_simdata = t->simdata;\r
+       t_simdata->receiver = process;\r
+       *task = t;\r
+       \r
+       SIMIX_mutex_lock(t_simdata->mutex);\r
+       \r
+       /* Transfer */\r
+       /* create SIMIX action to the communication */\r
+       t_simdata->comm = SIMIX_action_communicate(\r
+                                                                                               t_simdata->sender->simdata->m_host->simdata->smx_host,\r
+                                                                                               process->simdata->m_host->simdata->smx_host,\r
+                                                                                               t->name, \r
+                                                                                               t_simdata->message_size,\r
+                                                                                               t_simdata->rate\r
+                                                                                       );\r
+       \r
+       /* if the process is suspend, create the action but stop its execution, it will be restart when the sender process resume */\r
+       if (MSG_process_is_suspended(t_simdata->sender)) \r
+       {\r
+               DEBUG1("Process sender (%s) suspended", t_simdata->sender->name);\r
+               SIMIX_action_set_priority(t_simdata->comm, 0);\r
+       }\r
+       \r
+       process->simdata->waiting_task = t;\r
+       SIMIX_register_action_to_condition(t_simdata->comm, t_simdata->cond);\r
+       \r
+       while (1) \r
+       {\r
+               SIMIX_cond_wait(t_simdata->cond, t_simdata->mutex);\r
+               \r
+               if (SIMIX_action_get_state(t_simdata->comm) != SURF_ACTION_RUNNING)\r
+                       break;\r
+       }\r
+       \r
+       SIMIX_unregister_action_to_condition(t_simdata->comm, t_simdata->cond);\r
+               process->simdata->waiting_task = NULL;\r
+       \r
+       /* the task has already finished and the pointer must be null */\r
+       if (t->simdata->sender) \r
+       {\r
+               t->simdata->sender->simdata->waiting_task = NULL;\r
+       }\r
+       \r
+       /* for this process, don't need to change in get function */\r
+       t->simdata->receiver = NULL;\r
+       SIMIX_mutex_unlock(t_simdata->mutex);\r
+       \r
+       \r
+       if (SIMIX_action_get_state(t_simdata->comm) == SURF_ACTION_DONE) \r
+       {\r
+               SIMIX_action_destroy(t_simdata->comm);\r
+               t_simdata->comm = NULL;\r
+               t_simdata->using--;\r
+               MSG_RETURN(MSG_OK);\r
        } \r
-       CATCH(e\r
+       else if (SIMIX_host_get_state(h_simdata->smx_host) == 0\r
        {\r
-               if (e.category == not_found_error) \r
+               SIMIX_action_destroy(t_simdata->comm);\r
+               t_simdata->comm = NULL;\r
+               t_simdata->using--;\r
+               MSG_RETURN(MSG_HOST_FAILURE);\r
+       } \r
+       else \r
+       {\r
+               SIMIX_action_destroy(t_simdata->comm);\r
+               t_simdata->comm = NULL;\r
+               t_simdata->using--;\r
+               MSG_RETURN(MSG_TRANSFER_FAILURE);\r
+       }\r
+}\r
+\r
+MSG_error_t \r
+MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task, double timeout)\r
+{\r
+       m_process_t process = MSG_process_self();\r
+       const char* hostname;\r
+       simdata_task_t task_simdata = NULL;\r
+       m_host_t local_host = NULL;\r
+       m_host_t remote_host = NULL;\r
+       smx_cond_t cond = NULL;\r
+\r
+       CHECK_HOST();\r
+       \r
+       task_simdata = task->simdata;\r
+       task_simdata->sender = process;\r
+       task_simdata->source = MSG_process_get_host(process);\r
+       \r
+       xbt_assert0(task_simdata->using == 1,"This task is still being used somewhere else. You cannot send it now. Go fix your code!");\r
+       \r
+       task_simdata->comm = NULL;\r
+       \r
+       task_simdata->using++;\r
+       local_host = ((simdata_process_t) process->simdata)->m_host;\r
+       \r
+       /* get the host name containing the mailbox */\r
+       hostname = MSG_mailbox_get_hostname(mailbox);\r
+\r
+       remote_host = MSG_get_host_by_name(hostname);\r
+\r
+       if(NULL == remote_host)\r
+               THROW1(not_found_error,0,"Host %s not fount", hostname);\r
+\r
+\r
+       DEBUG4("Trying to send a task (%g kB) from %s to %s on the channel aliased by the alias %s",task->simdata->message_size / 1000, local_host->name,remote_host->name, MSG_mailbox_get_alias(mailbox));\r
+       \r
+       SIMIX_mutex_lock(remote_host->simdata->mutex);\r
+\r
+       /* put the task in the mailbox */\r
+       MSG_mailbox_put(mailbox,task);\r
+       \r
+       if(NULL != (cond = MSG_mailbox_get_cond(mailbox)))\r
+       {\r
+               DEBUG0("Somebody is listening. Let's wake him up!");\r
+               SIMIX_cond_signal(cond);\r
+       }\r
+\r
+       \r
+       \r
+       SIMIX_mutex_unlock(remote_host->simdata->mutex);\r
+       \r
+       SIMIX_mutex_lock(task->simdata->mutex);\r
+\r
+       process->simdata->waiting_task = task;\r
+       \r
+       if(timeout > 0) \r
+       {\r
+               xbt_ex_t e;\r
+               double time;\r
+               double time_elapsed;\r
+               time = SIMIX_get_clock();\r
+               \r
+               TRY \r
                {\r
-                       found = 0;\r
-                       xbt_ex_free(e);\r
+                       /*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 */\r
+                       while (1) \r
+                       {\r
+                               time_elapsed = SIMIX_get_clock() - time;\r
+                               SIMIX_cond_wait_timeout(task->simdata->cond, task->simdata->mutex,timeout - time_elapsed);\r
+                               \r
+                               if ((task->simdata->comm != NULL) && (SIMIX_action_get_state(task->simdata->comm) != SURF_ACTION_RUNNING))\r
+                                       break;\r
+                       }\r
                } \r
-               else \r
+               CATCH(e) \r
                {\r
-                       RETHROW;\r
+                       if(e.category==timeout_error) \r
+                       {\r
+                               xbt_ex_free(e);\r
+                               /* verify if the timeout happened and the communication didn't started yet */\r
+                               if (task->simdata->comm == NULL) \r
+                               {\r
+                                       process->simdata->waiting_task = NULL;\r
+                                       \r
+                                       /* remove the task from the mailbox */\r
+                                       MSG_mailbox_remove(mailbox,task);\r
+                                       \r
+                                       if (task->simdata->receiver) \r
+                                       {\r
+                                               task->simdata->receiver->simdata->waiting_task = NULL;\r
+                                       }\r
+                                       \r
+                                       task->simdata->sender = NULL;\r
+                                       \r
+                                       SIMIX_mutex_unlock(task->simdata->mutex);\r
+                                       MSG_RETURN(MSG_TRANSFER_FAILURE);\r
+                               }\r
+                       } \r
+                       else \r
+                       {\r
+                               RETHROW;\r
+                       }\r
+               }\r
+       } \r
+       else \r
+       {\r
+               while (1) \r
+               {\r
+                       SIMIX_cond_wait(task->simdata->cond, task->simdata->mutex);\r
+                       \r
+                       if (SIMIX_action_get_state(task->simdata->comm) != SURF_ACTION_RUNNING)\r
+                               break;\r
                }\r
        }\r
-\r
-       if(!found)\r
+       \r
+       DEBUG1("Action terminated %s", task->name);\r
+       process->simdata->waiting_task = NULL;\r
+       \r
+       /* the task has already finished and the pointer must be null */\r
+       if (task->simdata->receiver) \r
        {\r
-               mailbox = MSG_mailbox_new(alias);\r
-               MSG_mailbox_set_hostname(mailbox,MSG_host_self()->name);\r
+               task->simdata->receiver->simdata->waiting_task = NULL;\r
        }\r
        \r
-       return mailbox; \r
+       task->simdata->sender = NULL;\r
+       SIMIX_mutex_unlock(task->simdata->mutex);\r
+\r
+       \r
+       if (SIMIX_action_get_state(task->simdata->comm) == SURF_ACTION_DONE)\r
+       {\r
+               MSG_RETURN(MSG_OK);\r
+       } \r
+       else if (SIMIX_host_get_state(local_host->simdata->smx_host) == 0) \r
+       {\r
+               MSG_RETURN(MSG_HOST_FAILURE);\r
+       } \r
+       else \r
+       {\r
+               MSG_RETURN(MSG_TRANSFER_FAILURE);\r
+       }\r
 }\r