X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/22752d7347b7143b7eeb7de734cad5e469615996..0e8f25088a5fcac96419b8243a2838acd637fa88:/src/msg/msg_gos.c

diff --git a/src/msg/msg_gos.c b/src/msg/msg_gos.c
index dc1a480c20..0ce5b3ef84 100644
--- a/src/msg/msg_gos.c
+++ b/src/msg/msg_gos.c
@@ -12,7 +12,7 @@
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
                                 "Logging specific to MSG (gos)");
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Executes a task and waits for its termination.
  *
  * This function is used for describing the behavior of a process. It
@@ -53,7 +53,7 @@ MSG_error_t MSG_task_execute(m_task_t task)
   p_simdata = SIMIX_process_self_get_data(self);
   simdata->isused=1;
   simdata->compute =
-      simcall_host_execute(task->name, p_simdata->m_host->simdata->smx_host,
+      simcall_host_execute(task->name, p_simdata->m_host->smx_host,
                            simdata->computation_amount,
                            simdata->priority);
 #ifdef HAVE_TRACING
@@ -146,12 +146,12 @@ MSG_parallel_task_create(const char *name, int host_nb,
   simdata->comm_amount = communication_amount;
 
   for (i = 0; i < host_nb; i++)
-    simdata->host_list[i] = host_list[i]->simdata->smx_host;
+    simdata->host_list[i] = host_list[i]->smx_host;
 
   return task;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Executes a parallel task and waits for its termination.
  *
  * \param task a #m_task_t to execute on the location on which the process is running.
@@ -175,7 +175,7 @@ MSG_error_t MSG_parallel_task_execute(m_task_t task)
   xbt_assert(simdata->host_nb,
               "This is not a parallel task. Go to hell.");
 
-  XBT_DEBUG("Parallel computing on %s", p_simdata->m_host->name);
+  XBT_DEBUG("Parallel computing on %s", SIMIX_host_get_name(p_simdata->m_host->smx_host));
 
   simdata->isused=1;
 
@@ -214,7 +214,7 @@ MSG_error_t MSG_parallel_task_execute(m_task_t task)
 }
 
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sleep for the specified number of seconds
  *
  * Makes the current process sleep until \a time seconds have elapsed.
@@ -252,12 +252,28 @@ MSG_error_t MSG_process_sleep(double nb_sec)
   }
 }
 
-/** \ingroup msg_gos_functions
- * \brief Receives a task from a mailbox from a specific host.
+/** \ingroup msg_task_usage
+ * \brief Deprecated function that used to receive a task from a mailbox from a specific host.
  *
- * This is a blocking function, the execution flow will be blocked
- * until the task is received. See #MSG_task_irecv
- * for receiving tasks asynchronously.
+ * Sorry, this function is not supported anymore. That wouldn't be
+ * impossible to reimplement it, but we are lacking the time to do so ourselves.
+ * If you need this functionality, you can either:
+ *
+ *  - implement the buffering mechanism on the user-level by queuing all messages
+ *    received in the mailbox that do not match your expectation
+ *  - change your application logic to leverage the mailboxes features. For example,
+ *    if you have A receiving messages from B and C, you could have A waiting on
+ *    mailbox "A" most of the time, but on "A#B" when it's waiting for specific
+ *    messages from B and "A#C" when waiting for messages from C. You could even get A
+ *    sometime waiting on all these mailboxes using @ref MSG_comm_waitany. You can find
+ *    an example of use of this function in the @ref MSG_examples section.
+ *  - Provide a proper patch to implement this functionality back in MSG. That wouldn't be
+ *    very difficult actually. Check the function @ref MSG_mailbox_get_task_ext. During its call to
+ *    simcall_comm_recv(), the 5th argument, match_fun, is NULL. Create a function that filters
+ *    messages according to the host (that you will pass as sixth argument to simcall_comm_recv()
+ *    and that your filtering function will receive as first parameter, and then, the filter could
+ *    simply compare the host names, for example. After sufficient testing, provide an example that
+ *    we could add to the distribution, and your first contribution to SimGrid is ready. Thanks in advance.
  *
  * \param task a memory location for storing a #m_task_t.
  * \param alias name of the mailbox to receive the task from
@@ -274,7 +290,7 @@ MSG_task_receive_from_host(m_task_t * task, const char *alias,
   return MSG_task_receive_ext(task, alias, -1, host);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Receives a task from a mailbox.
  *
  * This is a blocking function, the execution flow will be blocked
@@ -293,7 +309,7 @@ MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
   return MSG_task_receive_with_timeout(task, alias, -1);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Receives a task from a mailbox with a given timeout.
  *
  * This is a blocking function with a timeout, the execution flow will be blocked
@@ -316,7 +332,7 @@ MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
   return MSG_task_receive_ext(task, alias, timeout, NULL);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Receives a task from a mailbox from a specific host with a given timeout.
  *
  * This is a blocking function with a timeout, the execution flow will be blocked
@@ -344,7 +360,7 @@ MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
                                   host, timeout);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sends a task on a mailbox.
  *
  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
@@ -359,7 +375,7 @@ msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
   return MSG_task_isend_with_matching(task,alias,NULL,NULL);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sends a task on a mailbox, with support for matching requests
  *
  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
@@ -367,12 +383,15 @@ msg_comm_t MSG_task_isend(m_task_t task, const char *alias)
  *
  * \param task a #m_task_t to send on another location.
  * \param alias name of the mailbox to sent the task to
- * \param match_fun boolean function taking the match_data provided by sender (here), and the one of the receiver (if any) and returning whether they match
+ * \param match_fun boolean function which parameters are:
+ *        - match_data_provided_here
+ *        - match_data_provided_by_other_side_if_any
+ *        - the_smx_action_describing_the_other_side
  * \param match_data user provided data passed to match_fun
  * \return the msg_comm_t communication created
  */
 XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *alias,
-    int (*match_fun)(void*,void*),
+    int (*match_fun)(void*,void*, smx_action_t),
     void *match_data)
 {
   simdata_task_t t_simdata = NULL;
@@ -406,7 +425,7 @@ XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *al
   return comm;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sends a task on a mailbox.
  *
  * This is a non blocking detached send function.
@@ -449,13 +468,13 @@ void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
   t_simdata->comm = comm;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Starts listening for receiving a task from an asynchronous communication.
  *
  * This is a non blocking function: use MSG_comm_wait() or MSG_comm_test()
  * to end the communication.
- *
- * \param task a memory location for storing a #m_task_t.
+ * 
+ * \param task a memory location for storing a #m_task_t. has to be valid until the end of the communication.
  * \param name of the mailbox to receive the task on
  * \return the msg_comm_t communication created
  */
@@ -482,7 +501,7 @@ msg_comm_t MSG_task_irecv(m_task_t *task, const char *name)
   return comm;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Checks whether a communication is done, and if yes, finalizes it.
  * \param comm the communication to test
  * \return TRUE if the communication is finished
@@ -529,7 +548,7 @@ int MSG_comm_test(msg_comm_t comm)
   return finished;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief This function checks if a communication is finished.
  * \param comms a vector of communications
  * \return the position of the finished communication if any
@@ -592,7 +611,7 @@ int MSG_comm_testany(xbt_dynar_t comms)
   return finished_index;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Destroys a communication.
  * \param comm the communication to destroy.
  */
@@ -601,12 +620,13 @@ void MSG_comm_destroy(msg_comm_t comm)
   xbt_free(comm);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Wait for the completion of a communication.
  *
  * It takes two parameters.
  * \param comm the communication to wait.
- * \param timeout Wait until the communication terminates or the timeout occurs
+ * \param timeout Wait until the communication terminates or the timeout 
+ * occurs. You can provide a -1 timeout to obtain an infinite timeout.
  * \return MSG_error_t
  */
 MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
@@ -642,7 +662,7 @@ MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout)
   return comm->status;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
 * \brief This function is called by a sender and permit to wait for each communication
 *
 * \param comm a vector of communication
@@ -657,7 +677,7 @@ void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
   }
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief This function waits for the first communication finished in a list.
  * \param comms a vector of communications
  * \return the position of the first finished communication
@@ -720,7 +740,7 @@ int MSG_comm_waitany(xbt_dynar_t comms)
 }
 
 /**
- * \ingroup msg_gos_functions
+ * \ingroup msg_task_usage
  * \brief Returns the error (if any) that occured during a finished communication.
  * \param comm a finished communication
  * \return the status of the communication, or #MSG_OK if no error occured
@@ -731,7 +751,7 @@ MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
   return comm->status;
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Get a task (#m_task_t) from a communication
  *
  * \param comm the communication where to get the task
@@ -763,7 +783,7 @@ void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_si
   }
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sends a task to a mailbox
  *
  * This is a blocking function, the execution flow will be blocked
@@ -782,7 +802,7 @@ MSG_error_t MSG_task_send(m_task_t task, const char *alias)
   return MSG_task_send_with_timeout(task, alias, -1);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sends a task to a mailbox with a maximum rate
  *
  * This is a blocking function, the execution flow will be blocked
@@ -803,7 +823,7 @@ MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
   return MSG_task_send(task, alias);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sends a task to a mailbox with a timeout
  *
  * This is a blocking function, the execution flow will be blocked
@@ -824,7 +844,7 @@ MSG_task_send_with_timeout(m_task_t task, const char *alias,
                                       task, timeout);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Check if there is a communication going on in a mailbox.
  *
  * \param alias the name of the mailbox to be considered
@@ -836,7 +856,7 @@ int MSG_task_listen(const char *alias)
   return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Check the number of communication actions of a given host pending in a mailbox.
  *
  * \param alias the name of the mailbox to be considered
@@ -853,7 +873,7 @@ int MSG_task_listen_from_host(const char *alias, m_host_t host)
                                                (alias), host);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Look if there is a communication on a mailbox and return the
  * PID of the sender process.
  *
@@ -873,7 +893,7 @@ int MSG_task_listen_from(const char *alias)
   return MSG_process_get_PID(task->simdata->sender);
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  * \brief Sets the tracing category of a task.
  *
  * This function should be called after the creation of
@@ -899,7 +919,7 @@ void MSG_task_set_category (m_task_t task, const char *category)
 #endif
 }
 
-/** \ingroup msg_gos_functions
+/** \ingroup msg_task_usage
  *
  * \brief Gets the current tracing category of a task.
  *
@@ -1014,7 +1034,7 @@ MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
               && (channel < msg_global->max_channel), "Invalid channel %d",
               channel);
 
-  XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", dest->name);
+  XBT_DEBUG("MSG_task_put_with_timout: Trying to send a task to '%s'", SIMIX_host_get_name(dest->smx_host));
   return
       MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel
                                    (dest, channel), task, timeout);