src/msg/msg_mailbox.c

   1 #include "mailbox.h"
   2 #include "msg/private.h"
   3
   4 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_mailbox, msg,
   5                                 "Logging specific to MSG (mailbox)");
   6
   7 static xbt_dict_t msg_mailboxes = NULL;
   8
   9 void MSG_mailbox_mod_init(void)
  10 {
  11   msg_mailboxes = xbt_dict_new();
  12 }
  13
  14 void MSG_mailbox_mod_exit(void)
  15 {
  16   xbt_dict_free(&msg_mailboxes);
  17 }
  18
  19 msg_mailbox_t MSG_mailbox_create(const char *alias)
  20 {
  21   msg_mailbox_t mailbox = xbt_new0(s_msg_mailbox_t, 1);
  22
  23   mailbox->tasks = xbt_fifo_new();
  24   mailbox->cond = NULL;
  25   mailbox->alias = alias ? xbt_strdup(alias) : NULL;
  26   mailbox->hostname = NULL;
  27
  28   return mailbox;
  29 }
  30
  31 msg_mailbox_t MSG_mailbox_new(const char *alias)
  32 {
  33   msg_mailbox_t mailbox = MSG_mailbox_create(alias);
  34
  35   /* add the mbox in the dictionary */
  36   xbt_dict_set(msg_mailboxes, alias, mailbox, MSG_mailbox_free);
  37
  38   return mailbox;
  39 }
  40
  41 void MSG_mailbox_free(void *mailbox)
  42 {
  43   msg_mailbox_t _mailbox = (msg_mailbox_t) mailbox;
  44
  45   if (NULL != (_mailbox->hostname))
  46     free(_mailbox->hostname);
  47
  48   xbt_fifo_free(_mailbox->tasks);
  49   free(_mailbox->alias);
  50
  51   free(_mailbox);
  52 }
  53
  54 void MSG_mailbox_put(msg_mailbox_t mailbox, m_task_t task)
  55 {
  56   xbt_fifo_push(mailbox->tasks, task);
  57 }
  58
  59 smx_cond_t MSG_mailbox_get_cond(msg_mailbox_t mailbox)
  60 {
  61   return mailbox->cond;
  62 }
  63
  64 void MSG_mailbox_remove(msg_mailbox_t mailbox, m_task_t task)
  65 {
  66   xbt_fifo_remove(mailbox->tasks, task);
  67 }
  68
  69 int MSG_mailbox_is_empty(msg_mailbox_t mailbox)
  70 {
  71   return (NULL == xbt_fifo_get_first_item(mailbox->tasks));
  72 }
  73
  74 m_task_t MSG_mailbox_pop_head(msg_mailbox_t mailbox)
  75 {
  76   return (m_task_t) xbt_fifo_shift(mailbox->tasks);
  77 }
  78
  79 m_task_t MSG_mailbox_get_head(msg_mailbox_t mailbox)
  80 {
  81   xbt_fifo_item_t item;
  82
  83   if (NULL == (item = xbt_fifo_get_first_item(mailbox->tasks)))
  84     return NULL;
  85
  86   return (m_task_t) xbt_fifo_get_item_content(item);
  87 }
  88
  89
  90 m_task_t
  91 MSG_mailbox_get_first_host_task(msg_mailbox_t mailbox, m_host_t host)
  92 {
  93   m_task_t task = NULL;
  94   xbt_fifo_item_t item = NULL;
  95
  96   xbt_fifo_foreach(mailbox->tasks, item, task, m_task_t)
  97       if (task->simdata->source == host) {
  98     xbt_fifo_remove_item(mailbox->tasks, item);
  99     return task;
 100   }
 101
 102   return NULL;
 103 }
 104
 105 int
 106 MSG_mailbox_get_count_host_waiting_tasks(msg_mailbox_t mailbox,
 107                                          m_host_t host)
 108 {
 109   m_task_t task = NULL;
 110   xbt_fifo_item_t item = NULL;
 111   int count = 0;
 112
 113   xbt_fifo_foreach(mailbox->tasks, item, task, m_task_t) {
 114     if (task->simdata->source == host)
 115       count++;
 116   }
 117
 118   return count;
 119 }
 120
 121 void MSG_mailbox_set_cond(msg_mailbox_t mailbox, smx_cond_t cond)
 122 {
 123   mailbox->cond = cond;
 124 }
 125
 126 const char *MSG_mailbox_get_alias(msg_mailbox_t mailbox)
 127 {
 128   return mailbox->alias;
 129 }
 130
 131 const char *MSG_mailbox_get_hostname(msg_mailbox_t mailbox)
 132 {
 133   return mailbox->hostname;
 134 }
 135
 136 void MSG_mailbox_set_hostname(msg_mailbox_t mailbox, const char *hostname)
 137 {
 138   mailbox->hostname = xbt_strdup(hostname);
 139 }
 140
 141 msg_mailbox_t MSG_mailbox_get_by_alias(const char *alias)
 142 {
 143
 144   msg_mailbox_t mailbox = xbt_dict_get_or_null(msg_mailboxes, alias);
 145
 146   if (!mailbox) {
 147     mailbox = MSG_mailbox_new(alias);
 148     MSG_mailbox_set_hostname(mailbox, MSG_host_self()->name);
 149   }
 150
 151   return mailbox;
 152 }
 153
 154 msg_mailbox_t
 155 MSG_mailbox_get_by_channel(m_host_t host, m_channel_t channel)
 156 {
 157   xbt_assert0((host != NULL), "Invalid host");
 158   xbt_assert1((channel >= 0)
 159               && (channel < msg_global->max_channel), "Invalid channel %d",
 160               channel);
 161
 162   return host->simdata->mailboxes[(size_t) channel];
 163 }
 164
 165 MSG_error_t
 166 MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task,
 167                          m_host_t host, double timeout)
 168 {
 169   m_process_t process = MSG_process_self();
 170   m_task_t t = NULL;
 171   m_host_t h = NULL;
 172   simdata_task_t t_simdata = NULL;
 173   simdata_host_t h_simdata = NULL;
 174   int first_time = 1;
 175
 176   smx_cond_t cond = NULL;       //conditional wait if the task isn't on the channel yet
 177
 178   CHECK_HOST();
 179
 180   /* Sanity check */
 181   xbt_assert0(task, "Null pointer for the task storage");
 182
 183   if (*task)
 184     CRITICAL0
 185         ("MSG_task_get() was asked to write in a non empty task struct.");
 186
 187   /* Get the task */
 188   h = MSG_host_self();
 189   h_simdata = h->simdata;
 190
 191   SIMIX_mutex_lock(h->simdata->mutex);
 192
 193   while (1) {
 194     /* if the mailbox is empty (has no task */
 195     if (!MSG_mailbox_is_empty(mailbox)) {
 196       if (!host) {
 197         /* pop the head of the mailbox */
 198         t = MSG_mailbox_pop_head(mailbox);
 199         break;
 200       } else {
 201         /* get the first task of the host */
 202         if (NULL != (t = MSG_mailbox_get_first_host_task(mailbox, host)))
 203           break;
 204       }
 205     }
 206
 207     if (timeout > 0) {
 208       if (!first_time) {
 209         SIMIX_mutex_unlock(h->simdata->mutex);
 210         /* set the simix condition of the mailbox to NULL */
 211         MSG_mailbox_set_cond(mailbox, NULL);
 212         SIMIX_cond_destroy(cond);
 213         MSG_RETURN(MSG_TRANSFER_FAILURE);
 214       }
 215     }
 216
 217     xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 218                 "A process is already blocked on the channel %s",
 219                 MSG_mailbox_get_alias(mailbox));
 220
 221     cond = SIMIX_cond_init();
 222
 223     /* set the condition of the mailbox */
 224     MSG_mailbox_set_cond(mailbox, cond);
 225
 226     if (timeout > 0)
 227       SIMIX_cond_wait_timeout(cond, h->simdata->mutex, timeout);
 228     else
 229       SIMIX_cond_wait(MSG_mailbox_get_cond(mailbox), h->simdata->mutex);
 230
 231
 232     if (SIMIX_host_get_state(h_simdata->smx_host) == 0)
 233       MSG_RETURN(MSG_HOST_FAILURE);
 234
 235     first_time = 0;
 236   }
 237
 238   SIMIX_mutex_unlock(h->simdata->mutex);
 239
 240   DEBUG1("OK, got a task (%s)", t->name);
 241   /* clean conditional */
 242   if (cond) {
 243     SIMIX_cond_destroy(cond);
 244
 245     MSG_mailbox_set_cond(mailbox, NULL);
 246   }
 247
 248   t_simdata = t->simdata;
 249   t_simdata->receiver = process;
 250   *task = t;
 251
 252   SIMIX_mutex_lock(t_simdata->mutex);
 253
 254   /* Transfer */
 255   /* create SIMIX action to the communication */
 256   t_simdata->comm =
 257       SIMIX_action_communicate(t_simdata->sender->simdata->m_host->
 258                                simdata->smx_host,
 259                                process->simdata->m_host->simdata->smx_host,
 260                                t->name, t_simdata->message_size,
 261                                t_simdata->rate);
 262
 263   /* if the process is suspend, create the action but stop its execution, it will be restart when the sender process resume */
 264   if (MSG_process_is_suspended(t_simdata->sender)) {
 265     DEBUG1("Process sender (%s) suspended", t_simdata->sender->name);
 266     SIMIX_action_set_priority(t_simdata->comm, 0);
 267   }
 268
 269   process->simdata->waiting_task = t;
 270   SIMIX_register_action_to_condition(t_simdata->comm, t_simdata->cond);
 271
 272   while (1) {
 273     SIMIX_cond_wait(t_simdata->cond, t_simdata->mutex);
 274
 275     if (SIMIX_action_get_state(t_simdata->comm) != SURF_ACTION_RUNNING)
 276       break;
 277   }
 278
 279   SIMIX_unregister_action_to_condition(t_simdata->comm, t_simdata->cond);
 280   process->simdata->waiting_task = NULL;
 281
 282   /* the task has already finished and the pointer must be null */
 283   if (t->simdata->sender) {
 284     t->simdata->sender->simdata->waiting_task = NULL;
 285   }
 286
 287   /* for this process, don't need to change in get function */
 288   t->simdata->receiver = NULL;
 289   SIMIX_mutex_unlock(t_simdata->mutex);
 290
 291
 292   if (SIMIX_action_get_state(t_simdata->comm) == SURF_ACTION_DONE) {
 293     SIMIX_action_destroy(t_simdata->comm);
 294     t_simdata->comm = NULL;
 295     t_simdata->using--;
 296     MSG_RETURN(MSG_OK);
 297   } else if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
 298     SIMIX_action_destroy(t_simdata->comm);
 299     t_simdata->comm = NULL;
 300     t_simdata->using--;
 301     MSG_RETURN(MSG_HOST_FAILURE);
 302   } else {
 303     SIMIX_action_destroy(t_simdata->comm);
 304     t_simdata->comm = NULL;
 305     t_simdata->using--;
 306     MSG_RETURN(MSG_TRANSFER_FAILURE);
 307   }
 308 }
 309
 310 MSG_error_t
 311 MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task,
 312                              double timeout)
 313 {
 314   m_process_t process = MSG_process_self();
 315   const char *hostname;
 316   simdata_task_t task_simdata = NULL;
 317   m_host_t local_host = NULL;
 318   m_host_t remote_host = NULL;
 319   smx_cond_t cond = NULL;
 320
 321   CHECK_HOST();
 322
 323   task_simdata = task->simdata;
 324   task_simdata->sender = process;
 325   task_simdata->source = MSG_process_get_host(process);
 326
 327   xbt_assert0(task_simdata->using == 1,
 328               "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 329
 330   task_simdata->comm = NULL;
 331
 332   task_simdata->using++;
 333   local_host = ((simdata_process_t) process->simdata)->m_host;
 334
 335   /* get the host name containing the mailbox */
 336   hostname = MSG_mailbox_get_hostname(mailbox);
 337
 338   remote_host = MSG_get_host_by_name(hostname);
 339
 340   if (NULL == remote_host)
 341     THROW1(not_found_error, 0, "Host %s not fount", hostname);
 342
 343
 344   DEBUG4
 345       ("Trying to send a task (%g kB) from %s to %s on the channel aliased by the alias %s",
 346        task->simdata->message_size / 1000, local_host->name,
 347        remote_host->name, MSG_mailbox_get_alias(mailbox));
 348
 349   SIMIX_mutex_lock(remote_host->simdata->mutex);
 350
 351   /* put the task in the mailbox */
 352   MSG_mailbox_put(mailbox, task);
 353
 354   if (NULL != (cond = MSG_mailbox_get_cond(mailbox))) {
 355     DEBUG0("Somebody is listening. Let's wake him up!");
 356     SIMIX_cond_signal(cond);
 357   }
 358
 359
 360
 361   SIMIX_mutex_unlock(remote_host->simdata->mutex);
 362
 363   SIMIX_mutex_lock(task->simdata->mutex);
 364
 365   process->simdata->waiting_task = task;
 366
 367   if (timeout > 0) {
 368     xbt_ex_t e;
 369     double time;
 370     double time_elapsed;
 371     time = SIMIX_get_clock();
 372
 373     TRY {
 374       /*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 */
 375       while (1) {
 376         time_elapsed = SIMIX_get_clock() - time;
 377         SIMIX_cond_wait_timeout(task->simdata->cond, task->simdata->mutex,
 378                                 timeout - time_elapsed);
 379
 380         if ((task->simdata->comm != NULL)
 381             && (SIMIX_action_get_state(task->simdata->comm) !=
 382                 SURF_ACTION_RUNNING))
 383           break;
 384       }
 385     }
 386     CATCH(e) {
 387       if (e.category == timeout_error) {
 388         xbt_ex_free(e);
 389         /* verify if the timeout happened and the communication didn't started yet */
 390         if (task->simdata->comm == NULL) {
 391           process->simdata->waiting_task = NULL;
 392
 393           /* remove the task from the mailbox */
 394           MSG_mailbox_remove(mailbox, task);
 395
 396           if (task->simdata->receiver) {
 397             task->simdata->receiver->simdata->waiting_task = NULL;
 398           }
 399
 400           task->simdata->sender = NULL;
 401
 402           SIMIX_mutex_unlock(task->simdata->mutex);
 403           MSG_RETURN(MSG_TRANSFER_FAILURE);
 404         }
 405       } else {
 406         RETHROW;
 407       }
 408     }
 409   } else {
 410     while (1) {
 411       SIMIX_cond_wait(task->simdata->cond, task->simdata->mutex);
 412
 413       if (SIMIX_action_get_state(task->simdata->comm) !=
 414           SURF_ACTION_RUNNING)
 415         break;
 416     }
 417   }
 418
 419   DEBUG1("Action terminated %s", task->name);
 420   process->simdata->waiting_task = NULL;
 421
 422   /* the task has already finished and the pointer must be null */
 423   if (task->simdata->receiver) {
 424     task->simdata->receiver->simdata->waiting_task = NULL;
 425   }
 426
 427   task->simdata->sender = NULL;
 428   SIMIX_mutex_unlock(task->simdata->mutex);
 429
 430
 431   if (SIMIX_action_get_state(task->simdata->comm) == SURF_ACTION_DONE) {
 432     MSG_RETURN(MSG_OK);
 433   } else if (SIMIX_host_get_state(local_host->simdata->smx_host) == 0) {
 434     MSG_RETURN(MSG_HOST_FAILURE);
 435   } else {
 436     MSG_RETURN(MSG_TRANSFER_FAILURE);
 437   }
 438 }