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 "msg_mailbox.h"
  10 #include "msg_private.h"
  11
  12 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
  13                                 "Logging specific to MSG (mailbox)");
  14
  15 msg_mailbox_t MSG_mailbox_new(const char *alias)
  16 {
  17   return simcall_rdv_create(alias);
  18 }
  19
  20 void MSG_mailbox_free(void *mailbox)
  21 {
  22   simcall_rdv_destroy((msg_mailbox_t)mailbox);
  23 }
  24
  25 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
  26 {
  27   return (NULL == simcall_rdv_get_head(mailbox));
  28 }
  29
  30 msg_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
  31 {
  32   smx_action_t comm = simcall_rdv_get_head(mailbox);
  33
  34   if (!comm)
  35     return NULL;
  36
  37   return (msg_task_t) simcall_comm_get_src_data(comm);
  38 }
  39
  40 int
  41 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
  42                                          msg_host_t host)
  43 {
  44   return simcall_rdv_comm_count_by_host(mailbox, host);
  45 }
  46
  47 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
  48 {
  49
  50   msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
  51
  52   if (!mailbox)
  53     mailbox = MSG_mailbox_new(alias);
  54
  55   return mailbox;
  56 }
  57
  58 /** \ingroup msg_mailbox_management
  59  * \brief Set the mailbox to receive in asynchronous mode
  60  *
  61  * All messages sent to this mailbox will be transferred to
  62  * the receiver without waiting for the receive call.
  63  * The receive call will still be necessary to use the received data.
  64  * If there is a need to receive some messages asynchronously, and some not,
  65  * two different mailboxes should be used.
  66  *
  67  * \param alias The name of the mailbox
  68  */
  69 void MSG_mailbox_set_async(const char *alias){
  70   msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
  71
  72   simcall_rdv_set_receiver(mailbox, SIMIX_process_self());
  73   XBT_VERB("%s mailbox set to receive eagerly for process %p\n",alias, SIMIX_process_self());
  74
  75 }
  76
  77 /** \ingroup msg_mailbox_management
  78  * \brief Get a task from a mailbox on a given host
  79  *
  80  * \param mailbox The mailbox where the task was sent
  81  * \param task a memory location for storing a #msg_task_t.
  82  * \param host a #msg_host_t host from where the task was sent
  83  * \param timeout a timeout
  84
  85  * \return Returns
  86  * #MSG_OK if the task was successfully received,
  87  * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
  88  */
  89 msg_error_t
  90 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task,
  91                          msg_host_t host, double timeout)
  92 {
  93   xbt_ex_t e;
  94   msg_error_t ret = MSG_OK;
  95   /* We no longer support getting a task from a specific host */
  96   if (host)
  97     THROW_UNIMPLEMENTED;
  98
  99 #ifdef HAVE_TRACING
 100   TRACE_msg_task_get_start();
 101   double start_time = MSG_get_clock();
 102 #endif
 103
 104   /* Sanity check */
 105   xbt_assert(task, "Null pointer for the task storage");
 106
 107   if (*task)
 108     XBT_WARN
 109         ("Asked to write the received task in a non empty struct -- proceeding.");
 110
 111   /* Try to receive it by calling SIMIX network layer */
 112   TRY {
 113     simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
 114     XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
 115     (*task)->simdata->isused=0;
 116   }
 117   CATCH(e) {
 118     switch (e.category) {
 119     case network_error:
 120       ret = MSG_TRANSFER_FAILURE;
 121       break;
 122     case timeout_error:
 123       ret = MSG_TIMEOUT;
 124       break;
 125     default:
 126       RETHROW;
 127     }
 128     xbt_ex_free(e);
 129   }
 130
 131 #ifdef HAVE_TRACING
 132   if (ret != MSG_HOST_FAILURE &&
 133       ret != MSG_TRANSFER_FAILURE &&
 134       ret != MSG_TIMEOUT) {
 135     TRACE_msg_task_get_end(start_time, *task);
 136   }
 137 #endif
 138   MSG_RETURN(ret);
 139 }
 140
 141 msg_error_t
 142 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task,
 143                              double timeout)
 144 {
 145   xbt_ex_t e;
 146   msg_error_t ret = MSG_OK;
 147   simdata_task_t t_simdata = NULL;
 148   msg_process_t process = MSG_process_self();
 149   simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
 150
 151 #ifdef HAVE_TRACING
 152   int call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
 153 #endif
 154
 155   /* Prepare the task to send */
 156   t_simdata = task->simdata;
 157   t_simdata->sender = process;
 158   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
 159
 160   xbt_assert(t_simdata->isused == 0,
 161               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 162
 163   t_simdata->isused=1;
 164   t_simdata->comm = NULL;
 165   msg_global->sent_msg++;
 166
 167
 168   p_simdata->waiting_task = task;
 169
 170   /* Try to send it by calling SIMIX network layer */
 171   TRY {
 172       smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
 173                                   t_simdata->rate, task, sizeof(void *),
 174                                   NULL, NULL, task, 0);
 175 #ifdef HAVE_TRACING
 176     if (TRACE_is_enabled()) {
 177       simcall_set_category(comm, task->category);
 178     }
 179 #endif
 180      t_simdata->comm = comm;
 181      simcall_comm_wait(comm, timeout);
 182   }
 183
 184   CATCH(e) {
 185     switch (e.category) {
 186     case network_error:
 187       ret = MSG_TRANSFER_FAILURE;
 188       break;
 189     case timeout_error:
 190       ret = MSG_TIMEOUT;
 191       break;
 192     default:
 193       RETHROW;
 194     }
 195     xbt_ex_free(e);
 196
 197     /* If the send failed, it is not used anymore */
 198     t_simdata->isused = 0;
 199   }
 200
 201
 202   p_simdata->waiting_task = NULL;
 203 #ifdef HAVE_TRACING
 204   if (call_end)
 205     TRACE_msg_task_put_end();
 206 #endif
 207   MSG_RETURN(ret);
 208 }
 209
 210 #ifdef MSG_USE_DEPRECATED
 211 msg_mailbox_t MSG_mailbox_get_by_channel(msg_host_t host,
 212                                          m_channel_t channel)
 213 {
 214   XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
 215   xbt_assert((host != NULL), "Invalid host");
 216   xbt_assert((channel >= 0)
 217               && (channel < msg_global->max_channel), "Invalid channel %d",
 218               channel);
 219
 220   return host->mailboxes[(size_t) channel];
 221 }
 222 #endif