src/msg/msg_mailbox.c

   1 /* Mailboxes in MSG */
   2
   3 /* Copyright (c) 2008, 2009, 2010. The SimGrid Team.
   4  * All rights reserved.                                                     */
   5
   6 /* This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the license (GNU LGPL) which comes with this package. */
   8
   9 #include "mailbox.h"
  10 #include "msg/private.h"
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
  12                                 "Logging specific to MSG (mailbox)");
  13
  14 msg_mailbox_t MSG_mailbox_new(const char *alias)
  15 {
  16   return SIMIX_req_rdv_create(alias);
  17 }
  18
  19 void MSG_mailbox_free(void *mailbox)
  20 {
  21   SIMIX_req_rdv_destroy((msg_mailbox_t)mailbox);
  22 }
  23
  24 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
  25 {
  26   return (NULL == SIMIX_req_rdv_get_head(mailbox));
  27 }
  28
  29 m_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
  30 {
  31   smx_action_t comm = SIMIX_req_rdv_get_head(mailbox);
  32
  33   if (!comm)
  34     return NULL;
  35
  36   return (m_task_t) SIMIX_req_comm_get_data(comm);
  37 }
  38
  39 int
  40 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
  41                                          m_host_t host)
  42 {
  43   return SIMIX_req_rdv_comm_count_by_host(mailbox,
  44                                       host->simdata->smx_host);
  45 }
  46
  47 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
  48 {
  49
  50   msg_mailbox_t mailbox = SIMIX_req_rdv_get_by_name(alias);
  51
  52   if (!mailbox)
  53     mailbox = MSG_mailbox_new(alias);
  54
  55   return mailbox;
  56 }
  57
  58 msg_mailbox_t MSG_mailbox_get_by_channel(m_host_t host,
  59                                          m_channel_t channel)
  60 {
  61   xbt_assert0((host != NULL), "Invalid host");
  62   xbt_assert1((channel >= 0)
  63               && (channel < msg_global->max_channel), "Invalid channel %d",
  64               channel);
  65
  66   return host->simdata->mailboxes[(size_t) channel];
  67 }
  68
  69 MSG_error_t
  70 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
  71                          m_host_t host, double timeout)
  72 {
  73   xbt_ex_t e;
  74   MSG_error_t ret = MSG_OK;
  75   smx_action_t comm = NULL;
  76 #ifdef HAVE_TRACING
  77   double start_time = 0;
  78 #endif
  79   /* We no longer support getting a task from a specific host */
  80   if (host)
  81     THROW_UNIMPLEMENTED;
  82
  83   CHECK_HOST();
  84 #ifdef HAVE_TRACING
  85   TRACE_msg_task_get_start();
  86   start_time = MSG_get_clock();
  87 #endif
  88
  89   /* Sanity check */
  90   xbt_assert0(task, "Null pointer for the task storage");
  91
  92   if (*task)
  93     CRITICAL0
  94         ("MSG_task_get() was asked to write in a non empty task struct.");
  95
  96   /* Try to receive it by calling SIMIX network layer */
  97   TRY {
  98     comm = SIMIX_req_comm_irecv(mailbox, task, NULL, NULL, NULL);
  99     SIMIX_req_comm_wait(comm, timeout);
 100     SIMIX_req_comm_destroy(comm);
 101     DEBUG2("Got task %s from %p",(*task)->name,mailbox);
 102     (*task)->simdata->refcount--;
 103   }
 104   CATCH(e) {
 105     switch (e.category) {
 106     case host_error:
 107       ret = MSG_HOST_FAILURE;
 108       break;
 109     case network_error:
 110       ret = MSG_TRANSFER_FAILURE;
 111       break;
 112     case timeout_error:
 113       ret = MSG_TIMEOUT;
 114       break;
 115     default:
 116         xbt_backtrace_display(&e);
 117       xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
 118     }
 119     xbt_ex_free(e);
 120   }
 121
 122   if (ret != MSG_HOST_FAILURE &&
 123       ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
 124 #ifdef HAVE_TRACING
 125     TRACE_msg_task_get_end(start_time, *task);
 126 #endif
 127   }
 128   MSG_RETURN(ret);
 129 }
 130
 131 MSG_error_t
 132 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
 133                              double timeout)
 134 {
 135   xbt_ex_t e;
 136   MSG_error_t ret = MSG_OK;
 137   simdata_task_t t_simdata = NULL;
 138   m_process_t process = MSG_process_self();
 139 #ifdef HAVE_TRACING
 140   int call_end = 0;
 141 #endif
 142   CHECK_HOST();
 143
 144 #ifdef HAVE_TRACING
 145   call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
 146 #endif
 147
 148
 149   /* Prepare the task to send */
 150   t_simdata = task->simdata;
 151   t_simdata->sender = process;
 152   t_simdata->source = MSG_host_self();
 153
 154   xbt_assert0(t_simdata->refcount == 1,
 155               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 156
 157   t_simdata->refcount++;
 158   msg_global->sent_msg++;
 159
 160   process->simdata->waiting_task = task;
 161
 162   /* Try to send it by calling SIMIX network layer */
 163   TRY {
 164     t_simdata->comm = SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
 165                        t_simdata->rate, task, sizeof(void *), NULL, task);
 166 #ifdef HAVE_TRACING
 167     SIMIX_req_set_category(t_simdata->comm, task->category);
 168 #endif
 169     SIMIX_req_comm_wait(t_simdata->comm, timeout);
 170     SIMIX_req_comm_destroy(t_simdata->comm);
 171   }
 172
 173   CATCH(e) {
 174     switch (e.category) {
 175     case host_error:
 176       ret = MSG_HOST_FAILURE;
 177       break;
 178     case network_error:
 179       ret = MSG_TRANSFER_FAILURE;
 180       break;
 181     case timeout_error:
 182       ret = MSG_TIMEOUT;
 183       break;
 184     default:
 185       xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
 186     }
 187     xbt_ex_free(e);
 188
 189     /* Decrement the refcount only on failure */
 190     t_simdata->refcount--;
 191   }
 192
 193   process->simdata->waiting_task = NULL;
 194 #ifdef HAVE_TRACING
 195   if (call_end)
 196     TRACE_msg_task_put_end();
 197 #endif
 198   MSG_RETURN(ret);
 199 }