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 ? xbt_strdup(alias) : NULL);
  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);
  99     SIMIX_req_comm_wait(comm, timeout);
 100     DEBUG2("Got task %s from %p",(*task)->name,mailbox);
 101     (*task)->simdata->refcount--;
 102   }
 103   CATCH(e) {
 104     switch (e.category) {
 105     case host_error:
 106       ret = MSG_HOST_FAILURE;
 107       break;
 108     case network_error:
 109       ret = MSG_TRANSFER_FAILURE;
 110       break;
 111     case timeout_error:
 112       ret = MSG_TIMEOUT;
 113       break;
 114     default:
 115         xbt_backtrace_display(&e);
 116       xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
 117     }
 118     xbt_ex_free(e);
 119   }
 120
 121   if (ret != MSG_HOST_FAILURE &&
 122       ret != MSG_TRANSFER_FAILURE && ret != MSG_TIMEOUT) {
 123 #ifdef HAVE_TRACING
 124     TRACE_msg_task_get_end(start_time, *task);
 125 #endif
 126   }
 127   MSG_RETURN(ret);
 128 }
 129
 130 MSG_error_t
 131 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
 132                              double timeout)
 133 {
 134   xbt_ex_t e;
 135   MSG_error_t ret = MSG_OK;
 136   simdata_task_t t_simdata = NULL;
 137   m_process_t process = MSG_process_self();
 138 #ifdef HAVE_TRACING
 139   int call_end = 0;
 140 #endif
 141   CHECK_HOST();
 142
 143 #ifdef HAVE_TRACING
 144   call_end = TRACE_msg_task_put_start(task);    //must be after CHECK_HOST()
 145 #endif
 146
 147
 148   /* Prepare the task to send */
 149   t_simdata = task->simdata;
 150   t_simdata->sender = process;
 151   t_simdata->source = MSG_host_self();
 152
 153   xbt_assert0(t_simdata->refcount == 1,
 154               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 155
 156   t_simdata->refcount++;
 157   msg_global->sent_msg++;
 158
 159   process->simdata->waiting_task = task;
 160
 161   /* Try to send it by calling SIMIX network layer */
 162   TRY {
 163     t_simdata->comm = SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
 164                        t_simdata->rate, task, sizeof(void *), task);
 165     SIMIX_req_comm_wait(t_simdata->comm, timeout);
 166   }
 167
 168   CATCH(e) {
 169     switch (e.category) {
 170     case host_error:
 171       ret = MSG_HOST_FAILURE;
 172       break;
 173     case network_error:
 174       ret = MSG_TRANSFER_FAILURE;
 175       break;
 176     case timeout_error:
 177       ret = MSG_TIMEOUT;
 178       break;
 179     default:
 180       xbt_die(bprintf("Unhandled SIMIX network exception: %s", e.msg));
 181     }
 182     xbt_ex_free(e);
 183
 184     /* Decrement the refcount only on failure */
 185     t_simdata->refcount--;
 186   }
 187
 188   process->simdata->waiting_task = NULL;
 189 #ifdef HAVE_TRACING
 190   if (call_end)
 191     TRACE_msg_task_put_end();
 192 #endif
 193   MSG_RETURN(ret);
 194 }