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         return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, host,
 409                         timeout);
 410 }
 411
 412 msg_comm_t MSG_task_isend(m_task_t task, const char *alias) {
 413         simdata_task_t t_simdata = NULL;
 414         m_process_t process = MSG_process_self();
 415         msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
 416
 417         CHECK_HOST();
 418
 419         /* FIXME: these functions are not tracable */
 420
 421         /* Prepare the task to send */
 422         t_simdata = task->simdata;
 423         t_simdata->sender = process;
 424         t_simdata->source = MSG_host_self();
 425
 426         xbt_assert0(t_simdata->refcount == 1,
 427                         "This task is still being used somewhere else. You cannot send it now. Go fix your code!");
 428
 429         t_simdata->refcount++;
 430         msg_global->sent_msg++;
 431         process->simdata->waiting_task = task;
 432
 433         /* Send it by calling SIMIX network layer */
 434
 435         /* Kept for semantical compatibility with older implementation */
 436         if(mailbox->cond)
 437                 SIMIX_cond_signal(mailbox->cond);
 438
 439         return SIMIX_network_isend(mailbox->rdv, t_simdata->message_size, t_simdata->rate,
 440                         task, sizeof(void*), &t_simdata->comm);
 441 }
 442
 443 msg_comm_t MSG_task_irecv(m_task_t * task, const char *alias) {
 444         smx_comm_t comm;
 445         smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias)->rdv;
 446         msg_mailbox_t mailbox=MSG_mailbox_get_by_alias(alias);
 447         size_t size = sizeof(void*);
 448
 449         CHECK_HOST();
 450
 451         /* FIXME: these functions are not tracable */
 452
 453         memset(&comm,0,sizeof(comm));
 454
 455         /* Kept for compatibility with older implementation */
 456         xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 457                         "A process is already blocked on this channel %s",
 458                         MSG_mailbox_get_alias(mailbox));
 459
 460         /* Sanity check */
 461         xbt_assert0(task, "Null pointer for the task storage");
 462
 463         if (*task)
 464                 CRITICAL0("MSG_task_get() was asked to write in a non empty task struct.");
 465
 466         /* Try to receive it by calling SIMIX network layer */
 467         return SIMIX_network_irecv(rdv, task, &size);
 468 }
 469
 470 int MSG_comm_test(msg_comm_t comm) {
 471         return SIMIX_network_test(comm);
 472 }
 473
 474 /* After received TRUE to MSG_comm_test() function we have to destroy the communication */
 475 void MSG_comm_destroy(msg_comm_t comm) {
 476         if(!(comm->src_proc == SIMIX_process_self()))
 477         {
 478                 m_task_t  task;
 479                 task = (m_task_t) SIMIX_communication_get_src_buf(comm);
 480                 task->simdata->refcount--;
 481         }
 482         SIMIX_communication_destroy(comm);
 483 }
 484
 485 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout) {
 486         xbt_ex_t e;
 487         MSG_error_t res = MSG_OK;
 488         TRY {
 489                 SIMIX_network_wait(comm,timeout);
 490
 491                 if(!(comm->src_proc == SIMIX_process_self()))
 492                 {
 493                         m_task_t  task;
 494                         task = (m_task_t) SIMIX_communication_get_src_buf(comm);
 495                         task->simdata->refcount--;
 496                 }
 497
 498                 /* FIXME: these functions are not tracable */
 499         }  CATCH(e){
 500                 switch(e.category){
 501                         case host_error:
 502                                 res = MSG_HOST_FAILURE;
 503                                 break;
 504                         case network_error:
 505                                 res = MSG_TRANSFER_FAILURE;
 506                                 break;
 507                         case timeout_error:
 508                                 res = MSG_TIMEOUT;
 509                                 break;
 510                         default:
 511                                 xbt_die(bprintf("Unhandled SIMIX network exception: %s",e.msg));
 512                 }
 513                 xbt_ex_free(e);
 514         }
 515         return res;
 516 }
 517
 518
 519 /* This function is called by a sender and permit to wait for each communication
 520  *
 521  * Param:
 522  * - msg_comm_t *comm a vector of communication
 523  * - int nb_elem is th esize of the comm vector
 524  * - timeout for each call of  MSG_comm_wait
 525  */
 526
 527 void MSG_comm_waitall(msg_comm_t *comm,int nb_elem, double timeout) {
 528         int i=0;
 529         for(i=0; i<nb_elem; i++)
 530         {
 531                 MSG_comm_wait(comm[i],timeout);
 532         }
 533 }
 534
 535 int MSG_comm_waitany(xbt_dynar_t comms) {
 536         return SIMIX_network_waitany(comms);
 537 }
 538
 539 m_task_t MSG_comm_get_task(msg_comm_t comm) {
 540         xbt_assert0(comm, "Invalid parameters");
 541         return (m_task_t) SIMIX_communication_get_src_buf(comm);
 542 }
 543
 544 /** \ingroup msg_gos_functions
 545  * \brief Put a task on a channel of an host and waits for the end of the
 546  * transmission.
 547  *
 548  * This function is used for describing the behavior of an agent. It
 549  * takes three parameter.
 550  * \param task a #m_task_t to send on another location. This task
 551  will not be usable anymore when the function will return. There is
 552  no automatic task duplication and you have to save your parameters
 553  before calling this function. Tasks are unique and once it has been
 554  sent to another location, you should not access it anymore. You do
 555  not need to call MSG_task_destroy() but to avoid using, as an
 556  effect of inattention, this task anymore, you definitely should
 557  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 558  can be transfered iff it has been correctly created with
 559  MSG_task_create().
 560  * \param dest the destination of the message
 561  * \param channel the channel on which the agent should put this
 562  task. This value has to be >=0 and < than the maximal number of
 563  channels fixed with MSG_set_channel_number().
 564  * \return #MSG_FATAL if \a task is not properly initialized and
 565  * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
 566  * this function was called was shut down. Returns
 567  * #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 568  * (network failure, dest failure)
 569  */
 570 MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
 571 {
 572         return MSG_task_put_with_timeout(task, dest, channel, -1.0);
 573 }
 574
 575 /** \ingroup msg_gos_functions
 576  * \brief Does exactly the same as MSG_task_put but with a bounded transmition
 577  * rate.
 578  *
 579  * \sa MSG_task_put
 580  */
 581         MSG_error_t
 582 MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
 583                 double maxrate)
 584 {
 585         task->simdata->rate = maxrate;
 586         return MSG_task_put(task, dest, channel);
 587 }
 588
 589 /** \ingroup msg_gos_functions \brief Put a task on a channel of an
 590  * host (with a timeout on the waiting of the destination host) and
 591  * waits for the end of the transmission.
 592  *
 593  * This function is used for describing the behavior of an agent. It
 594  * takes four parameter.
 595  * \param task a #m_task_t to send on another location. This task
 596  will not be usable anymore when the function will return. There is
 597  no automatic task duplication and you have to save your parameters
 598  before calling this function. Tasks are unique and once it has been
 599  sent to another location, you should not access it anymore. You do
 600  not need to call MSG_task_destroy() but to avoid using, as an
 601  effect of inattention, this task anymore, you definitely should
 602  renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task
 603  can be transfered iff it has been correctly created with
 604  MSG_task_create().
 605  * \param dest the destination of the message
 606  * \param channel the channel on which the agent should put this
 607  task. This value has to be >=0 and < than the maximal number of
 608  channels fixed with MSG_set_channel_number().
 609  * \param timeout the maximum time to wait for a task before giving
 610  up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
 611  will not be modified
 612  * \return #MSG_FATAL if \a task is not properly initialized and
 613 #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which
 614 this function was called was shut down. Returns
 615 #MSG_TRANSFER_FAILURE if the transfer could not be properly done
 616 (network failure, dest failure, timeout...)
 617  */
 618         MSG_error_t
 619 MSG_task_put_with_timeout(m_task_t task, m_host_t dest, m_channel_t channel,
 620                 double timeout)
 621 {
 622         xbt_assert1((channel >= 0)
 623                         && (channel < msg_global->max_channel), "Invalid channel %d",
 624                         channel);
 625
 626         return
 627                 MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel(dest, channel),
 628                                 task, timeout);
 629 }
 630
 631 MSG_error_t MSG_task_send(m_task_t task, const char *alias)
 632 {
 633         return MSG_task_send_with_timeout(task, alias, -1);
 634 }
 635
 636
 637         MSG_error_t
 638 MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
 639 {
 640         task->simdata->rate = maxrate;
 641         return MSG_task_send(task, alias);
 642 }
 643
 644
 645         MSG_error_t
 646 MSG_task_send_with_timeout(m_task_t task, const char *alias, double timeout)
 647 {
 648         return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias), task,
 649                         timeout);
 650 }
 651
 652 int MSG_task_listen(const char *alias)
 653 {
 654         CHECK_HOST();
 655
 656         return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
 657 }
 658
 659 /** \ingroup msg_gos_functions
 660  * \brief Test whether there is a pending communication on a channel.
 661  *
 662  * It takes one parameter.
 663  * \param channel the channel on which the agent should be
 664  listening. This value has to be >=0 and < than the maximal
 665  number of channels fixed with MSG_set_channel_number().
 666  * \return 1 if there is a pending communication and 0 otherwise
 667  */
 668 int MSG_task_Iprobe(m_channel_t channel)
 669 {
 670         xbt_assert1((channel >= 0)
 671                         && (channel < msg_global->max_channel), "Invalid channel %d",
 672                         channel);
 673
 674         CHECK_HOST();
 675
 676         return
 677                 !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
 678                                 (MSG_host_self(), channel));
 679 }
 680
 681 /** \ingroup msg_gos_functions
 682
 683  * \brief Return the number of tasks waiting to be received on a \a
 684  channel and sent by \a host.
 685  *
 686  * It takes two parameters.
 687  * \param channel the channel on which the agent should be
 688  listening. This value has to be >=0 and < than the maximal
 689  number of channels fixed with MSG_set_channel_number().
 690  * \param host the host that is to be watched.
 691  * \return the number of tasks waiting to be received on \a channel
 692  and sent by \a host.
 693  */
 694 int MSG_task_probe_from_host(int channel, m_host_t host)
 695 {
 696         xbt_assert1((channel >= 0)
 697                         && (channel < msg_global->max_channel), "Invalid channel %d",
 698                         channel);
 699
 700         CHECK_HOST();
 701
 702         return
 703                 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
 704                                 (MSG_host_self(), channel),
 705                                 host);
 706
 707 }
 708
 709 int MSG_task_listen_from_host(const char *alias, m_host_t host)
 710 {
 711         CHECK_HOST();
 712
 713         return
 714                 MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias(alias),
 715                                 host);
 716 }
 717
 718 /** \ingroup msg_gos_functions
 719  * \brief Test whether there is a pending communication on a channel, and who sent it.
 720  *
 721  * It takes one parameter.
 722  * \param channel the channel on which the agent should be
 723  listening. This value has to be >=0 and < than the maximal
 724  number of channels fixed with MSG_set_channel_number().
 725  * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
 726  */
 727 int MSG_task_probe_from(m_channel_t channel)
 728 {
 729         m_task_t task;
 730
 731         CHECK_HOST();
 732
 733         xbt_assert1((channel >= 0)
 734                         && (channel < msg_global->max_channel), "Invalid channel %d",
 735                         channel);
 736
 737         if (NULL ==
 738                         (task =
 739                          MSG_mailbox_get_head(MSG_mailbox_get_by_channel
 740                                  (MSG_host_self(), channel))))
 741                 return -1;
 742
 743         return MSG_process_get_PID(task->simdata->sender);
 744 }
 745
 746 int MSG_task_listen_from(const char *alias)
 747 {
 748         m_task_t task;
 749
 750         CHECK_HOST();
 751
 752         if (NULL == (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
 753                 return -1;
 754
 755         return MSG_process_get_PID(task->simdata->sender);
 756 }
 757
 758 /** \ingroup msg_gos_functions
 759  * \brief Wait for at most \a max_duration second for a task reception
 760  on \a channel.
 761
 762  * \a PID is updated with the PID of the first process that triggered this event if any.
 763  *
 764  * It takes three parameters:
 765  * \param channel the channel on which the agent should be
 766  listening. This value has to be >=0 and < than the maximal.
 767  number of channels fixed with MSG_set_channel_number().
 768  * \param PID a memory location for storing an int.
 769  * \param timeout the maximum time to wait for a task before
 770  giving up. In the case of a reception, *\a PID will be updated
 771  with the PID of the first process to send a task.
 772  * \return #MSG_HOST_FAILURE if the host is shut down in the meantime
 773  and #MSG_OK otherwise.
 774  */
 775         MSG_error_t
 776 MSG_channel_select_from(m_channel_t channel, double timeout, int *PID)
 777 {
 778         m_host_t h = NULL;
 779         simdata_host_t h_simdata = NULL;
 780         m_task_t t;
 781         int first_time = 1;
 782         smx_cond_t cond;
 783         msg_mailbox_t mailbox;
 784
 785         xbt_assert1((channel >= 0)
 786                         && (channel < msg_global->max_channel), "Invalid channel %d",
 787                         channel);
 788
 789         if (PID) {
 790                 *PID = -1;
 791         }
 792
 793         if (timeout == 0.0) {
 794                 *PID = MSG_task_probe_from(channel);
 795                 MSG_RETURN(MSG_OK);
 796         } else {
 797                 CHECK_HOST();
 798                 h = MSG_host_self();
 799                 h_simdata = h->simdata;
 800
 801                 mailbox = MSG_mailbox_get_by_channel(MSG_host_self(), channel);
 802
 803                 while (MSG_mailbox_is_empty(mailbox)) {
 804                         if (timeout > 0) {
 805                                 if (!first_time) {
 806                                         MSG_RETURN(MSG_OK);
 807                                 }
 808                         }
 809
 810                         SIMIX_mutex_lock(h_simdata->mutex);
 811
 812                         xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 813                                         "A process is already blocked on this channel %d", channel);
 814
 815                         cond = SIMIX_cond_init();
 816
 817                         MSG_mailbox_set_cond(mailbox, cond);
 818
 819                         if (timeout > 0) {
 820                                 SIMIX_cond_wait_timeout(cond, h_simdata->mutex, timeout);
 821                         } else {
 822                                 SIMIX_cond_wait(cond, h_simdata->mutex);
 823                         }
 824
 825                         SIMIX_cond_destroy(cond);
 826                         SIMIX_mutex_unlock(h_simdata->mutex);
 827
 828                         if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
 829                                 MSG_RETURN(MSG_HOST_FAILURE);
 830                         }
 831
 832                         MSG_mailbox_set_cond(mailbox, NULL);
 833                         first_time = 0;
 834                 }
 835
 836                 if (NULL == (t = MSG_mailbox_get_head(mailbox)))
 837                         MSG_RETURN(MSG_OK);
 838
 839
 840                 if (PID) {
 841                         *PID = MSG_process_get_PID(t->simdata->sender);
 842                 }
 843
 844                 MSG_RETURN(MSG_OK);
 845         }
 846 }
 847
 848
 849 MSG_error_t MSG_alias_select_from(const char *alias, double timeout, int *PID)
 850 {
 851         m_host_t h = NULL;
 852         simdata_host_t h_simdata = NULL;
 853         m_task_t t;
 854         int first_time = 1;
 855         smx_cond_t cond;
 856         msg_mailbox_t mailbox;
 857
 858         if (PID) {
 859                 *PID = -1;
 860         }
 861
 862         if (timeout == 0.0) {
 863                 *PID = MSG_task_listen_from(alias);
 864                 MSG_RETURN(MSG_OK);
 865         } else {
 866                 CHECK_HOST();
 867                 h = MSG_host_self();
 868                 h_simdata = h->simdata;
 869
 870                 DEBUG2("Probing on alias %s (%s)", alias, h->name);
 871
 872                 mailbox = MSG_mailbox_get_by_alias(alias);
 873
 874                 while (MSG_mailbox_is_empty(mailbox)) {
 875                         if (timeout > 0) {
 876                                 if (!first_time) {
 877                                         MSG_RETURN(MSG_OK);
 878                                 }
 879                         }
 880
 881                         SIMIX_mutex_lock(h_simdata->mutex);
 882
 883                         xbt_assert1(!MSG_mailbox_get_cond(mailbox),
 884                                         "A process is already blocked on this alias %s", alias);
 885
 886                         cond = SIMIX_cond_init();
 887
 888                         MSG_mailbox_set_cond(mailbox, cond);
 889
 890                         if (timeout > 0) {
 891                                 SIMIX_cond_wait_timeout(cond, h_simdata->mutex, timeout);
 892                         } else {
 893                                 SIMIX_cond_wait(cond, h_simdata->mutex);
 894                         }
 895
 896                         SIMIX_cond_destroy(cond);
 897                         SIMIX_mutex_unlock(h_simdata->mutex);
 898
 899                         if (SIMIX_host_get_state(h_simdata->smx_host) == 0) {
 900                                 MSG_RETURN(MSG_HOST_FAILURE);
 901                         }
 902
 903                         MSG_mailbox_set_cond(mailbox, NULL);
 904                         first_time = 0;
 905                 }
 906
 907                 if (NULL == (t = MSG_mailbox_get_head(mailbox)))
 908                         MSG_RETURN(MSG_OK);
 909
 910
 911                 if (PID) {
 912                         *PID = MSG_process_get_PID(t->simdata->sender);
 913                 }
 914
 915                 MSG_RETURN(MSG_OK);
 916         }
 917 }