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 m_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 (m_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                                          m_host_t host)
  43 {
  44   return simcall_rdv_comm_count_by_host(mailbox,
  45                                       host->smx_host);
  46 }
  47
  48 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
  49 {
  50
  51   msg_mailbox_t mailbox = simcall_rdv_get_by_name(alias);
  52
  53   if (!mailbox)
  54     mailbox = MSG_mailbox_new(alias);
  55
  56   return mailbox;
  57 }
  58
  59 MSG_error_t
  60 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
  61                          m_host_t host, double timeout)
  62 {
  63   xbt_ex_t e;
  64   MSG_error_t ret = MSG_OK;
  65   /* We no longer support getting a task from a specific host */
  66   if (host)
  67     THROW_UNIMPLEMENTED;
  68
  69 #ifdef HAVE_TRACING
  70   TRACE_msg_task_get_start();
  71   volatile double start_time = MSG_get_clock();
  72 #endif
  73
  74   /* Sanity check */
  75   xbt_assert(task, "Null pointer for the task storage");
  76
  77   if (*task)
  78     XBT_WARN
  79         ("Asked to write the received task in a non empty struct -- proceeding.");
  80
  81   /* Try to receive it by calling SIMIX network layer */
  82   TRY {
  83     simcall_comm_recv(mailbox, task, NULL, NULL, NULL, timeout);
  84     XBT_DEBUG("Got task %s from %p",(*task)->name,mailbox);
  85     (*task)->simdata->isused=0;
  86   }
  87   CATCH(e) {
  88     switch (e.category) {
  89     case host_error:
  90       ret = MSG_HOST_FAILURE;
  91       break;
  92     case network_error:
  93       ret = MSG_TRANSFER_FAILURE;
  94       break;
  95     case timeout_error:
  96       ret = MSG_TIMEOUT;
  97       break;
  98     default:
  99       RETHROW;
 100     }
 101     xbt_ex_free(e);
 102   }
 103
 104 #ifdef HAVE_TRACING
 105   if (ret != MSG_HOST_FAILURE &&
 106       ret != MSG_TRANSFER_FAILURE &&
 107       ret != MSG_TIMEOUT) {
 108     TRACE_msg_task_get_end(start_time, *task);
 109   }
 110 #endif
 111   MSG_RETURN(ret);
 112 }
 113
 114 MSG_error_t
 115 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
 116                              double timeout)
 117 {
 118   xbt_ex_t e;
 119   MSG_error_t ret = MSG_OK;
 120   simdata_task_t t_simdata = NULL;
 121   m_process_t process = MSG_process_self();
 122   simdata_process_t p_simdata = SIMIX_process_self_get_data(process);
 123
 124 #ifdef HAVE_TRACING
 125   int call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
 126 #endif
 127
 128   /* Prepare the task to send */
 129   t_simdata = task->simdata;
 130   t_simdata->sender = process;
 131   t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data(process))->m_host;
 132
 133   xbt_assert(t_simdata->isused == 0,
 134               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 135
 136   t_simdata->isused=1;
 137   t_simdata->comm = NULL;
 138   msg_global->sent_msg++;
 139
 140
 141   p_simdata->waiting_task = task;
 142
 143   /* Try to send it by calling SIMIX network layer */
 144   TRY {
 145       smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
 146                                   t_simdata->rate, task, sizeof(void *),
 147                                   NULL, NULL, task, 0);
 148 #ifdef HAVE_TRACING
 149     if (TRACE_is_enabled()) {
 150       simcall_set_category(comm, task->category);
 151     }
 152 #endif
 153      t_simdata->comm = comm;
 154      simcall_comm_wait(comm, timeout);
 155   }
 156
 157   CATCH(e) {
 158     switch (e.category) {
 159     case host_error:
 160       ret = MSG_HOST_FAILURE;
 161       break;
 162     case network_error:
 163       ret = MSG_TRANSFER_FAILURE;
 164       break;
 165     case timeout_error:
 166       ret = MSG_TIMEOUT;
 167       break;
 168     default:
 169       RETHROW;
 170     }
 171     xbt_ex_free(e);
 172
 173     /* If the send failed, it is not used anymore */
 174     t_simdata->isused = 0;
 175   }
 176
 177
 178   p_simdata->waiting_task = NULL;
 179 #ifdef HAVE_TRACING
 180   if (call_end)
 181     TRACE_msg_task_put_end();
 182 #endif
 183   MSG_RETURN(ret);
 184 }
 185
 186 #ifdef MSG_USE_DEPRECATED
 187 msg_mailbox_t MSG_mailbox_get_by_channel(m_host_t host,
 188                                          m_channel_t channel)
 189 {
 190   XBT_WARN("DEPRECATED! Now use MSG_mailbox_get_by_alias");
 191   xbt_assert((host != NULL), "Invalid host");
 192   xbt_assert((channel >= 0)
 193               && (channel < msg_global->max_channel), "Invalid channel %d",
 194               channel);
 195
 196   return host->mailboxes[(size_t) channel];
 197 }
 198 #endif