src/msg/gos.c

   1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include "msg/private.h"
   8 #include "simix/private.h"
   9 #include "xbt/sysdep.h"
  10 #include "mc/mc.h"
  11 #include "xbt/log.h"
  12 #include "mailbox.h"
  13
  14
  15 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
  16                 "Logging specific to MSG (gos)");
  17
  18 /** \ingroup msg_gos_functions
  19  *
  20  * \brief Return the last value returned by a MSG function (except
  21  * MSG_get_errno...).
  22  */
  23 MSG_error_t MSG_get_errno(void)
  24 {
  25         return PROCESS_GET_ERRNO();
  26 }
  27
  28 /** \ingroup msg_gos_functions
  29  * \brief Executes a task and waits for its termination.
  30  *
  31  * This function is used for describing the behavior of an agent. It
  32  * takes only one parameter.
  33  * \param task a #m_task_t to execute on the location on which the
  34  agent is running.
  35  * \return #MSG_FATAL if \a task is not properly initialized and
  36  * #MSG_OK otherwise.
  37  */
  38 MSG_error_t MSG_task_execute(m_task_t task)
  39 {
  40         simdata_task_t simdata = NULL;
  41         m_process_t self = MSG_process_self();
  42         e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
  43         CHECK_HOST();
  44
  45         simdata = task->simdata;
  46
  47         xbt_assert0(simdata->host_nb==0, "This is a parallel task. Go to hell.");
  48
  49 #ifdef HAVE_TRACING
  50         TRACE_msg_task_execute_start (task);
  51 #endif
  52
  53         xbt_assert1((!simdata->compute) && (task->simdata->refcount == 1),
  54                         "This task is executed somewhere else. Go fix your code! %d", task->simdata->refcount);
  55
  56         DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name);
  57
  58         if (simdata->computation_amount == 0) {
  59 #ifdef HAVE_TRACING
  60                 TRACE_msg_task_execute_end (task);
  61 #endif
  62                 return MSG_OK;
  63         }
  64         simdata->refcount++;
  65         SIMIX_mutex_lock(simdata->mutex);
  66         simdata->compute =
  67                 SIMIX_action_execute(SIMIX_host_self(), task->name,
  68                                 simdata->computation_amount);
  69         SIMIX_action_set_priority(simdata->compute, simdata->priority);
  70
  71         /* changed to waiting action since we are always waiting one action (execute, communicate or sleep) */
  72         self->simdata->waiting_action = simdata->compute;
  73         SIMIX_register_action_to_condition(simdata->compute, simdata->cond);
  74         do {
  75                 SIMIX_cond_wait(simdata->cond, simdata->mutex);
  76                 state = SIMIX_action_get_state(simdata->compute);
  77         } while (state == SURF_ACTION_READY || state == SURF_ACTION_RUNNING);
  78         SIMIX_unregister_action_to_condition(simdata->compute, simdata->cond);
  79         self->simdata->waiting_action = NULL;
  80
  81         SIMIX_mutex_unlock(simdata->mutex);
  82         simdata->refcount--;
  83
  84         if (SIMIX_action_get_state(task->simdata->compute) == SURF_ACTION_DONE) {
  85                 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
  86                 SIMIX_action_destroy(task->simdata->compute);
  87                 simdata->computation_amount = 0.0;
  88                 simdata->comm = NULL;
  89                 simdata->compute = NULL;
  90 #ifdef HAVE_TRACING
  91                 TRACE_msg_task_execute_end (task);
  92 #endif
  93                 MSG_RETURN(MSG_OK);
  94         } else if (SIMIX_host_get_state(SIMIX_host_self()) == 0) {
  95                 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
  96                 SIMIX_action_destroy(task->simdata->compute);
  97                 simdata->comm = NULL;
  98                 simdata->compute = NULL;
  99 #ifdef HAVE_TRACING
 100                 TRACE_msg_task_execute_end (task);
 101 #endif
 102                 MSG_RETURN(MSG_HOST_FAILURE);
 103         } else {
 104                 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 105                 SIMIX_action_destroy(task->simdata->compute);
 106                 simdata->comm = NULL;
 107                 simdata->compute = NULL;
 108 #ifdef HAVE_TRACING
 109                 TRACE_msg_task_execute_end (task);
 110 #endif
 111                 MSG_RETURN(MSG_TASK_CANCELLED);
 112         }
 113 }
 114
 115 /** \ingroup m_task_management
 116  * \brief Creates a new #m_task_t (a parallel one....).
 117  *
 118  * A constructor for #m_task_t taking six arguments and returning the
 119  corresponding object.
 120  * \param name a name for the object. It is for user-level information
 121  and can be NULL.
 122  * \param host_nb the number of hosts implied in the parallel task.
 123  * \param host_list an array of \p host_nb m_host_t.
 124  * \param computation_amount an array of \p host_nb
 125  doubles. computation_amount[i] is the total number of operations
 126  that have to be performed on host_list[i].
 127  * \param communication_amount an array of \p host_nb* \p host_nb doubles.
 128  * \param data a pointer to any data may want to attach to the new
 129  object.  It is for user-level information and can be NULL. It can
 130  be retrieved with the function \ref MSG_task_get_data.
 131  * \see m_task_t
 132  * \return The new corresponding object.
 133  */
 134         m_task_t
 135 MSG_parallel_task_create(const char *name, int host_nb,
 136                 const m_host_t * host_list,
 137                 double *computation_amount,
 138                 double *communication_amount, void *data)
 139 {
 140         int i;
 141         simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1);
 142         m_task_t task = xbt_new0(s_m_task_t, 1);
 143         task->simdata = simdata;
 144
 145         /* Task structure */
 146         task->name = xbt_strdup(name);
 147         task->data = data;
 148
 149         /* Simulator Data */
 150         simdata->computation_amount = 0;
 151         simdata->message_size = 0;
 152         simdata->cond = SIMIX_cond_init();
 153         simdata->mutex = SIMIX_mutex_init();
 154         simdata->compute = NULL;
 155         simdata->comm = NULL;
 156         simdata->rate = -1.0;
 157         simdata->refcount = 1;
 158         simdata->sender = NULL;
 159         simdata->receiver = NULL;
 160         simdata->source = NULL;
 161
 162         simdata->host_nb = host_nb;
 163         simdata->host_list = xbt_new0(smx_host_t, host_nb);
 164         simdata->comp_amount = computation_amount;
 165         simdata->comm_amount = communication_amount;
 166
 167         for (i = 0; i < host_nb; i++)
 168                 simdata->host_list[i] = host_list[i]->simdata->smx_host;
 169
 170         return task;
 171 }
 172
 173 MSG_error_t MSG_parallel_task_execute(m_task_t task)
 174 {
 175         simdata_task_t simdata = NULL;
 176         m_process_t self = MSG_process_self();
 177         e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
 178         CHECK_HOST();
 179
 180         simdata = task->simdata;
 181
 182         xbt_assert0((!simdata->compute)
 183                         && (task->simdata->refcount == 1),
 184                         "This task is executed somewhere else. Go fix your code!");
 185
 186         xbt_assert0(simdata->host_nb, "This is not a parallel task. Go to hell.");
 187
 188         DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name);
 189
 190         simdata->refcount++;
 191
 192         SIMIX_mutex_lock(simdata->mutex);
 193         simdata->compute =
 194                 SIMIX_action_parallel_execute(task->name, simdata->host_nb,
 195                                 simdata->host_list, simdata->comp_amount,
 196                                 simdata->comm_amount, 1.0, -1.0);
 197
 198         self->simdata->waiting_action = simdata->compute;
 199         SIMIX_register_action_to_condition(simdata->compute, simdata->cond);
 200         do {
 201                 SIMIX_cond_wait(simdata->cond, simdata->mutex);
 202                 state = SIMIX_action_get_state(task->simdata->compute);
 203         } while (state == SURF_ACTION_READY || state == SURF_ACTION_RUNNING);
 204
 205         SIMIX_unregister_action_to_condition(simdata->compute, simdata->cond);
 206         self->simdata->waiting_action = NULL;
 207
 208
 209         SIMIX_mutex_unlock(simdata->mutex);
 210         simdata->refcount--;
 211
 212         if (SIMIX_action_get_state(task->simdata->compute) == SURF_ACTION_DONE) {
 213                 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 214                 SIMIX_action_destroy(task->simdata->compute);
 215                 simdata->computation_amount = 0.0;
 216                 simdata->comm = NULL;
 217                 simdata->compute = NULL;
 218                 MSG_RETURN(MSG_OK);
 219         } else if (SIMIX_host_get_state(SIMIX_host_self()) == 0) {
 220                 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 221                 SIMIX_action_destroy(task->simdata->compute);
 222                 simdata->comm = NULL;
 223                 simdata->compute = NULL;
 224                 MSG_RETURN(MSG_HOST_FAILURE);
 225         } else {
 226                 /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
 227                 SIMIX_action_destroy(task->simdata->compute);
 228                 simdata->comm = NULL;
 229                 simdata->compute = NULL;
 230                 MSG_RETURN(MSG_TASK_CANCELLED);
 231         }
 232
 233 }
 234
 235
 236 /** \ingroup msg_gos_functions
 237  * \brief Sleep for the specified number of seconds
 238  *
 239  * Makes the current process sleep until \a time seconds have elapsed.
 240  *
 241  * \param nb_sec a number of second
 242  */
 243 MSG_error_t MSG_process_sleep(double nb_sec)
 244 {
 245         smx_action_t act_sleep;
 246         m_process_t proc = MSG_process_self();
 247         e_surf_action_state_t state = SURF_ACTION_NOT_IN_THE_SYSTEM;
 248         smx_mutex_t mutex;
 249         smx_cond_t cond;
 250
 251 #ifdef HAVE_TRACING
 252         TRACE_msg_process_sleep_in (MSG_process_self());
 253 #endif
 254
 255         /* create action to sleep */
 256         act_sleep =
 257                 SIMIX_action_sleep(SIMIX_process_get_host(proc->simdata->s_process),
 258                                 nb_sec);
 259
 260         mutex = SIMIX_mutex_init();
 261         SIMIX_mutex_lock(mutex);
 262
 263         /* create conditional and register action to it */
 264         cond = SIMIX_cond_init();
 265
 266         proc->simdata->waiting_action = act_sleep;
 267         SIMIX_register_action_to_condition(act_sleep, cond);
 268         do {
 269                 SIMIX_cond_wait(cond, mutex);
 270                 state = SIMIX_action_get_state(act_sleep);
 271         } while (state == SURF_ACTION_READY || state == SURF_ACTION_RUNNING);
 272         proc->simdata->waiting_action = NULL;
 273         SIMIX_unregister_action_to_condition(act_sleep, cond);
 274         SIMIX_mutex_unlock(mutex);
 275
 276         /* remove variables */
 277         SIMIX_cond_destroy(cond);
 278         SIMIX_mutex_destroy(mutex);
 279
 280         if (SIMIX_action_get_state(act_sleep) == SURF_ACTION_DONE) {
 281                 if (SIMIX_host_get_state(SIMIX_host_self()) == SURF_RESOURCE_OFF) {
 282                         SIMIX_action_destroy(act_sleep);
 283 #ifdef HAVE_TRACING
 284                         TRACE_msg_process_sleep_out (MSG_process_self());
 285 #endif
 286                         MSG_RETURN(MSG_HOST_FAILURE);
 287                 }
 288         } else {
 289                 SIMIX_action_destroy(act_sleep);
 290 #ifdef HAVE_TRACING
 291                 TRACE_msg_process_sleep_out (MSG_process_self());
 292 #endif
 293                 MSG_RETURN(MSG_HOST_FAILURE);
 294         }
 295
 296         SIMIX_action_destroy(act_sleep);
 297 #ifdef HAVE_TRACING
 298         TRACE_msg_process_sleep_out (MSG_process_self());
 299 #endif
 300         MSG_RETURN(MSG_OK);
 301 }
 302
 303 /** \ingroup msg_gos_functions
 304  * \brief Listen on \a channel and waits for receiving a task from \a host.
 305  *
 306  * It takes three parameters.
 307  * \param task a memory location for storing a #m_task_t. It will
 308  hold a task when this function will return. Thus \a task should not
 309  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
 310  those two condition does not hold, there will be a warning message.
 311  * \param channel the channel on which the agent should be
 312  listening. This value has to be >=0 and < than the maximal
 313  number of channels fixed with MSG_set_channel_number().
 314  * \param host the host that is to be watched.
 315  * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
 316  if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
 317  */
 318         MSG_error_t
 319 MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
 320 {
 321         return MSG_task_get_ext(task, channel, -1, host);
 322 }
 323
 324 /** \ingroup msg_gos_functions
 325  * \brief Listen on a channel and wait for receiving a task.
 326  *
 327  * It takes two parameters.
 328  * \param task a memory location for storing a #m_task_t. It will
 329  hold a task when this function will return. Thus \a task should not
 330  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
 331  those two condition does not hold, there will be a warning message.
 332  * \param channel the channel on which the agent should be
 333  listening. This value has to be >=0 and < than the maximal
 334  number of channels fixed with MSG_set_channel_number().
 335  * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
 336  * if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
 337  */
 338 MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
 339 {
 340         return MSG_task_get_with_timeout(task, channel, -1);
 341 }
 342
 343 /** \ingroup msg_gos_functions
 344  * \brief Listen on a channel and wait for receiving a task with a timeout.
 345  *
 346  * It takes three parameters.
 347  * \param task a memory location for storing a #m_task_t. It will
 348  hold a task when this function will return. Thus \a task should not
 349  be equal to \c NULL and \a *task should be equal to \c NULL. If one of
 350  those two condition does not hold, there will be a warning message.
 351  * \param channel the channel on which the agent should be
 352  listening. This value has to be >=0 and < than the maximal
 353  number of channels fixed with MSG_set_channel_number().
 354  * \param max_duration the maximum time to wait for a task before giving
 355  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
 356  will not be modified and will still be
 357  equal to \c NULL when returning.
 358  * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING
 359  if \a *task is not equal to \c NULL, and #MSG_OK otherwise.
 360  */
 361         MSG_error_t
 362 MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
 363                 double max_duration)
 364 {
 365         return MSG_task_get_ext(task, channel, max_duration, NULL);
 366 }
 367
 368 /** \defgroup msg_gos_functions MSG Operating System Functions
 369  *  \brief This section describes the functions that can be used
 370  *  by an agent for handling some task.
 371  */
 372
 373         MSG_error_t
 374 MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
 375                 m_host_t host)
 376 {
 377         xbt_assert1((channel >= 0)
 378                         && (channel < msg_global->max_channel), "Invalid channel %d",
 379                         channel);
 380
 381         return
 382                 MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
 383                                 (MSG_host_self(), channel), task, host, timeout);
 384 }
 385
 386         MSG_error_t
 387 MSG_task_receive_from_host(m_task_t * task, const char *alias, m_host_t host)
 388 {
 389         return MSG_task_receive_ext(task, alias, -1, host);
 390 }
 391
 392 MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
 393 {
 394         return MSG_task_receive_with_timeout(task, alias, -1);
 395 }
 396
 397         MSG_error_t
 398 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
 399                 double timeout)
 400 {
 401         return MSG_task_receive_ext(task, alias, timeout, NULL);
 402 }
 403
 404         MSG_error_t
 405 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
 406                 m_host_t host)
 407 {
 408         DEBUG1("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'",alias);
 409         return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, host,
 410                         timeout);
 411 }
 412
 413 msg_comm_t MSG_task_isend(m_task_t task, const char *alias) {
 414         simdata_task_t t_simdata = NULL;
 415         m_process_t process = MSG_process_self();
 416         msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
 417
 418         CHECK_HOST();
 419
 420         /* FIXME: these functions are not tracable */
 421
 422         /* Prepare the task to send */
 423         t_simdata = task->simdata;
 424         t_simdata->sender = process;
 425         t_simdata->source = MSG_host_self();
 426
 427         xbt_assert0(t_simdata->refcount == 1,
 428                         "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 429
 430         t_simdata->refcount++;
 431         msg_global->sent_msg++;
 432         process->simdata->waiting_task = task;
 433
 434         /* Send it by calling SIMIX network layer */
 435
 436         /* Kept for semantical compatibility with older implementation */
 437         if(mailbox->cond)
 438                 SIMIX_cond_signal(mailbox->cond);
 439
 440         return SIMIX_network_isend(mailbox->rdv, t_simdata->message_size, t_simdata->rate,
 441                         task, sizeof(void*), &t_simdata->comm);
 442 }
 443
 444 msg_comm_t MSG_task_irecv(m_task_t * task, const char *alias) {
 445         smx_comm_t comm;
 446         smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias)->rdv;
 447         msg_mailbox_t mailbox=MSG_mailbox_get_by_alias(alias);
 448         size_t size = sizeof(void*);
 449
 450         CHECK_HOST();
 451
 452         /* FIXME: these functions are not tracable */
 453
 454         memset(&comm,0,sizeof(comm));
 455
 456         /* Kept for compatibility with older implementation */
 457         xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 458                         "A process is already blocked on this channel %s",
 459                         MSG_mailbox_get_alias(mailbox));
 460
 461         /* Sanity check */
 462         xbt_assert0(task, "Null pointer for the task storage");
 463
 464         if (*task)
 465                 CRITICAL0("MSG_task_get() was asked to write in a non empty task struct.");
 466
 467         /* Try to receive it by calling SIMIX network layer */
 468         return SIMIX_network_irecv(rdv, task, &size);
 469 }
 470
 471 int MSG_comm_test(msg_comm_t comm) {
 472         return SIMIX_network_test(comm);
 473 }
 474
 475 /* After received TRUE to MSG_comm_test() function we have to destroy the communication */
 476 void MSG_comm_destroy(msg_comm_t comm) {
 477         if(!(comm->src_proc == SIMIX_process_self()))
 478         {
 479                 m_task_t  task;
 480                 task = (m_task_t) SIMIX_communication_get_src_buf(comm);
 481                 task->simdata->refcount--;
 482         }
 483         SIMIX_communication_destroy(comm);
 484 }
 485
 486 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout) {
 487         xbt_ex_t e;
 488         MSG_error_t res = MSG_OK;
 489         TRY {
 490                 SIMIX_network_wait(comm,timeout);
 491
 492                 if(!(comm->src_proc == SIMIX_process_self()))
 493                 {
 494                         m_task_t  task;
 495                         task = (m_task_t) SIMIX_communication_get_src_buf(comm);
 496                         task->simdata->refcount--;
 497                 }
 498
 499                 /* FIXME: these functions are not tracable */
 500         }  CATCH(e){
 501                 switch(e.category){
 502                         case host_error:
 503                                 res = MSG_HOST_FAILURE;
 504                                 break;
 505                         case network_error:
 506                                 res = MSG_TRANSFER_FAILURE;
 507                                 break;
 508                         case timeout_error:
 509                                 res = MSG_TIMEOUT;
 510                                 break;
 511                         default:
 512                                 xbt_die(bprintf("Unhandled SIMIX network exception: %s",e.msg));
 513                 }
 514                 xbt_ex_free(e);
 515         }
 516         return res;
 517 }
 518
 519
 520 /* This function is called by a sender and permit to wait for each communication
 521  *
 522  * Param:
 523  * - msg_comm_t *comm a vector of communication
 524  * - int nb_elem is th esize of the comm vector
 525  * - timeout for each call of  MSG_comm_wait
 526  */
 527
 528 void MSG_comm_waitall(msg_comm_t *comm,int nb_elem, double timeout) {
 529         int i=0;
 530         for(i=0; i<nb_elem; i++)
 531         {
 532                 MSG_comm_wait(comm[i],timeout);
 533         }
 534 }
 535
 536 int MSG_comm_waitany(xbt_dynar_t comms) {
 537         return SIMIX_network_waitany(comms);
 538 }
 539
 540 m_task_t MSG_comm_get_task(msg_comm_t comm) {
 541         xbt_assert0(comm, "Invalid parameters");
 542         return (m_task_t) SIMIX_communication_get_src_buf(comm);
 543 }
 544
 545 /** \ingroup msg_gos_functions
 546  * \brief Put a task on a channel of an host and waits for the end of the
 547  * transmission.
 548  *
 549  * This function is used for describing the behavior of an agent. It
 550  * takes three parameter.
 551  * \param task a #m_task_t to send on another location. This task
 552  will not be usable anymore when the function will return. There is
 553  no automatic task duplication and you have to save your parameters
 554  before calling this function. Tasks are unique and once it has been
 555  sent to another location, you should not access it anymore. You do
 556  not need to call MSG_task_destroy() but to avoid using, as an
 557  effect of inattention, this task anymore, you definitely should
 558  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 559  can be transfered iff it has been correctly created with
 560  MSG_task_create().
 561  * \param dest the destination of the message
 562  * \param channel the channel on which the agent should put this
 563  task. This value has to be >=0 and < than the maximal number of
 564  channels fixed with MSG_set_channel_number().
 565  * \return #MSG_FATAL if \a task is not properly initialized and
 566  * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
 567  * this function was called was shut down. Returns
 568  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 569  * (network failure, dest failure)
 570  */
 571 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
 572 {
 573         return MSG_task_put_with_timeout(task, dest, channel, -1.0);
 574 }
 575
 576 /** \ingroup msg_gos_functions
 577  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
 578  * rate.
 579  *
 580  * \sa MSG_task_put
 581  */
 582         MSG_error_t
 583 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
 584                 double maxrate)
 585 {
 586         task->simdata->rate = maxrate;
 587         return MSG_task_put(task, dest, channel);
 588 }
 589
 590 /** \ingroup msg_gos_functions \brief Put a task on a channel of an
 591  * host (with a timeout on the waiting of the destination host) and
 592  * waits for the end of the transmission.
 593  *
 594  * This function is used for describing the behavior of an agent. It
 595  * takes four parameter.
 596  * \param task a #m_task_t to send on another location. This task
 597  will not be usable anymore when the function will return. There is
 598  no automatic task duplication and you have to save your parameters
 599  before calling this function. Tasks are unique and once it has been
 600  sent to another location, you should not access it anymore. You do
 601  not need to call MSG_task_destroy() but to avoid using, as an
 602  effect of inattention, this task anymore, you definitely should
 603  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 604  can be transfered iff it has been correctly created with
 605  MSG_task_create().
 606  * \param dest the destination of the message
 607  * \param channel the channel on which the agent should put this
 608  task. This value has to be >=0 and < than the maximal number of
 609  channels fixed with MSG_set_channel_number().
 610  * \param timeout the maximum time to wait for a task before giving
 611  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
 612  will not be modified
 613  * \return #MSG_FATAL if \a task is not properly initialized and
 614 #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
 615 this function was called was shut down. Returns
 616 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 617 (network failure, dest failure, timeout...)
 618  */
 619         MSG_error_t
 620 MSG_task_put_with_timeout(m_task_t task, m_host_t dest, m_channel_t channel,
 621                 double timeout)
 622 {
 623         xbt_assert1((channel >= 0)
 624                         && (channel < msg_global->max_channel), "Invalid channel %d",
 625                         channel);
 626
 627         return
 628                 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel(dest, channel),
 629                                 task, timeout);
 630 }
 631
 632 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
 633 {
 634         DEBUG1("MSG_task_send: Trying to send a message on mailbox '%s'",alias);
 635         return MSG_task_send_with_timeout(task, alias, -1);
 636 }
 637
 638
 639         MSG_error_t
 640 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
 641 {
 642         task->simdata->rate = maxrate;
 643         return MSG_task_send(task, alias);
 644 }
 645
 646
 647         MSG_error_t
 648 MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout)
 649 {
 650         return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias), task,
 651                         timeout);
 652 }
 653
 654 int MSG_task_listen(const char *alias)
 655 {
 656         CHECK_HOST();
 657
 658         return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
 659 }
 660
 661 /** \ingroup msg_gos_functions
 662  * \brief Test whether there is a pending communication on a channel.
 663  *
 664  * It takes one parameter.
 665  * \param channel the channel on which the agent should be
 666  listening. This value has to be >=0 and < than the maximal
 667  number of channels fixed with MSG_set_channel_number().
 668  * \return 1 if there is a pending communication and 0 otherwise
 669  */
 670 int MSG_task_Iprobe(m_channel_t channel)
 671 {
 672         xbt_assert1((channel >= 0)
 673                         && (channel < msg_global->max_channel), "Invalid channel %d",
 674                         channel);
 675
 676         CHECK_HOST();
 677
 678         return
 679                 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
 680                                 (MSG_host_self(), channel));
 681 }
 682
 683 /** \ingroup msg_gos_functions
 684
 685  * \brief Return the number of tasks waiting to be received on a \a
 686  channel and sent by \a host.
 687  *
 688  * It takes two parameters.
 689  * \param channel the channel on which the agent should be
 690  listening. This value has to be >=0 and < than the maximal
 691  number of channels fixed with MSG_set_channel_number().
 692  * \param host the host that is to be watched.
 693  * \return the number of tasks waiting to be received on \a channel
 694  and sent by \a host.
 695  */
 696 int MSG_task_probe_from_host(int channel, m_host_t host)
 697 {
 698         xbt_assert1((channel >= 0)
 699                         && (channel < msg_global->max_channel), "Invalid channel %d",
 700                         channel);
 701
 702         CHECK_HOST();
 703
 704         return
 705                 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
 706                                 (MSG_host_self(), channel),
 707                                 host);
 708
 709 }
 710
 711 int MSG_task_listen_from_host(const char *alias, m_host_t host)
 712 {
 713         CHECK_HOST();
 714
 715         return
 716                 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias(alias),
 717                                 host);
 718 }
 719
 720 /** \ingroup msg_gos_functions
 721  * \brief Test whether there is a pending communication on a channel, and who sent it.
 722  *
 723  * It takes one parameter.
 724  * \param channel the channel on which the agent should be
 725  listening. This value has to be >=0 and < than the maximal
 726  number of channels fixed with MSG_set_channel_number().
 727  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
 728  */
 729 int MSG_task_probe_from(m_channel_t channel)
 730 {
 731         m_task_t task;
 732
 733         CHECK_HOST();
 734
 735         xbt_assert1((channel >= 0)
 736                         && (channel < msg_global->max_channel), "Invalid channel %d",
 737                         channel);
 738
 739         if (NULL ==
 740                         (task =
 741                          MSG_mailbox_get_head(MSG_mailbox_get_by_channel
 742                                  (MSG_host_self(), channel))))
 743                 return -1;
 744
 745         return MSG_process_get_PID(task->simdata->sender);
 746 }
 747
 748 int MSG_task_listen_from(const char *alias)
 749 {
 750         m_task_t task;
 751
 752         CHECK_HOST();
 753
 754         if (NULL == (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
 755                 return -1;
 756
 757         return MSG_process_get_PID(task->simdata->sender);
 758 }
 759
 760 /** \ingroup msg_gos_functions
 761  * \brief Wait for at most \a max_duration second for a task reception
 762  on \a channel.
 763
 764  * \a PID is updated with the PID of the first process that triggered this event if any.
 765  *
 766  * It takes three parameters:
 767  * \param channel the channel on which the agent should be
 768  listening. This value has to be >=0 and < than the maximal.
 769  number of channels fixed with MSG_set_channel_number().
 770  * \param PID a memory location for storing an int.
 771  * \param timeout the maximum time to wait for a task before
 772  giving up. In the case of a reception, *\a PID will be updated
 773  with the PID of the first process to send a task.
 774  * \return #MSG_HOST_FAILURE if the host is shut down in the meantime
 775  and #MSG_OK otherwise.
 776  */
 777         MSG_error_t
 778 MSG_channel_select_from(m_channel_t channel, double timeout, int *PID)
 779 {
 780         m_host_t h = NULL;
 781         simdata_host_t h_simdata = NULL;
 782         m_task_t t;
 783         int first_time = 1;
 784         smx_cond_t cond;
 785         msg_mailbox_t mailbox;
 786
 787         xbt_assert1((channel >= 0)
 788                         && (channel < msg_global->max_channel), "Invalid channel %d",
 789                         channel);
 790
 791         if (PID) {
 792                 *PID = -1;
 793         }
 794
 795         if (timeout == 0.0) {
 796                 *PID = MSG_task_probe_from(channel);
 797                 MSG_RETURN(MSG_OK);
 798         } else {
 799                 CHECK_HOST();
 800                 h = MSG_host_self();
 801                 h_simdata = h->simdata;
 802
 803                 mailbox = MSG_mailbox_get_by_channel(MSG_host_self(), channel);
 804
 805                 while (MSG_mailbox_is_empty(mailbox)) {
 806                         if (timeout > 0) {
 807                                 if (!first_time) {
 808                                         MSG_RETURN(MSG_OK);
 809                                 }
 810                         }
 811
 812                         SIMIX_mutex_lock(h_simdata->mutex);
 813
 814                         xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 815                                         "A process is already blocked on this channel %d", channel);
 816
 817                         cond = SIMIX_cond_init();
 818
 819                         MSG_mailbox_set_cond(mailbox, cond);
 820
 821                         if (timeout > 0) {
 822                                 SIMIX_cond_wait_timeout(cond, h_simdata->mutex, timeout);
 823                         } else {
 824                                 SIMIX_cond_wait(cond, h_simdata->mutex);
 825                         }
 826
 827                         SIMIX_cond_destroy(cond);
 828                         SIMIX_mutex_unlock(h_simdata->mutex);
 829
 830                         if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
 831                                 MSG_RETURN(MSG_HOST_FAILURE);
 832                         }
 833
 834                         MSG_mailbox_set_cond(mailbox, NULL);
 835                         first_time = 0;
 836                 }
 837
 838                 if (NULL == (t = MSG_mailbox_get_head(mailbox)))
 839                         MSG_RETURN(MSG_OK);
 840
 841
 842                 if (PID) {
 843                         *PID = MSG_process_get_PID(t->simdata->sender);
 844                 }
 845
 846                 MSG_RETURN(MSG_OK);
 847         }
 848 }
 849
 850
 851 MSG_error_t MSG_alias_select_from(const char *alias, double timeout, int *PID)
 852 {
 853         m_host_t h = NULL;
 854         simdata_host_t h_simdata = NULL;
 855         m_task_t t;
 856         int first_time = 1;
 857         smx_cond_t cond;
 858         msg_mailbox_t mailbox;
 859
 860         if (PID) {
 861                 *PID = -1;
 862         }
 863
 864         if (timeout == 0.0) {
 865                 *PID = MSG_task_listen_from(alias);
 866                 MSG_RETURN(MSG_OK);
 867         } else {
 868                 CHECK_HOST();
 869                 h = MSG_host_self();
 870                 h_simdata = h->simdata;
 871
 872                 DEBUG2("Probing on alias %s (%s)", alias, h->name);
 873
 874                 mailbox = MSG_mailbox_get_by_alias(alias);
 875
 876                 while (MSG_mailbox_is_empty(mailbox)) {
 877                         if (timeout > 0) {
 878                                 if (!first_time) {
 879                                         MSG_RETURN(MSG_OK);
 880                                 }
 881                         }
 882
 883                         SIMIX_mutex_lock(h_simdata->mutex);
 884
 885                         xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 886                                         "A process is already blocked on this alias %s", alias);
 887
 888                         cond = SIMIX_cond_init();
 889
 890                         MSG_mailbox_set_cond(mailbox, cond);
 891
 892                         if (timeout > 0) {
 893                                 SIMIX_cond_wait_timeout(cond, h_simdata->mutex, timeout);
 894                         } else {
 895                                 SIMIX_cond_wait(cond, h_simdata->mutex);
 896                         }
 897
 898                         SIMIX_cond_destroy(cond);
 899                         SIMIX_mutex_unlock(h_simdata->mutex);
 900
 901                         if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
 902                                 MSG_RETURN(MSG_HOST_FAILURE);
 903                         }
 904
 905                         MSG_mailbox_set_cond(mailbox, NULL);
 906                         first_time = 0;
 907                 }
 908
 909                 if (NULL == (t = MSG_mailbox_get_head(mailbox)))
 910                         MSG_RETURN(MSG_OK);
 911
 912
 913                 if (PID) {
 914                         *PID = MSG_process_get_PID(t->simdata->sender);
 915                 }
 916
 917                 MSG_RETURN(MSG_OK);
 918         }
 919 }