Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
missing documentation for these functions
[simgrid.git] / src / msg / msg_gos.c
index d02ffa7..513882c 100644 (file)
@@ -68,7 +68,7 @@ MSG_error_t MSG_task_execute(m_task_t task)
 
   simdata->isused=0;
 
-  XBT_DEBUG("Execution task '%s' finished in state %d", task->name, comp_state);
+  XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
   if (comp_state == SIMIX_DONE) {
     /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
     simdata->computation_amount = 0.0;
@@ -153,6 +153,12 @@ MSG_parallel_task_create(const char *name, int host_nb,
   return task;
 }
 
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param task
+ * \return
+ */
 MSG_error_t MSG_parallel_task_execute(m_task_t task)
 {
   simdata_task_t simdata = NULL;
@@ -185,7 +191,7 @@ MSG_error_t MSG_parallel_task_execute(m_task_t task)
   comp_state = simcall_host_execution_wait(simdata->compute);
   p_simdata->waiting_action = NULL;
 
-  XBT_DEBUG("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state);
+  XBT_DEBUG("Finished waiting for execution of action %p, state = %d", simdata->compute, (int)comp_state);
 
   simdata->isused=0;
 
@@ -248,102 +254,40 @@ MSG_error_t MSG_process_sleep(double nb_sec)
 }
 
 /** \ingroup msg_gos_functions
- * \brief Listen on \a channel and waits for receiving a task from \a host.
+ * \brief Description forthcoming (FIXME)
  *
- * It takes three parameters.
- * \param task a memory location for storing a #m_task_t. It will
- hold a task when this function will return. Thus \a task should not
- be equal to \c NULL and \a *task should be equal to \c NULL. If one of
- those two condition does not hold, there will be a warning message.
- * \param channel the channel on which the agent should be
- listening. This value has to be >=0 and < than the maximal
- number of channels fixed with MSG_set_channel_number().
- * \param host the host that is to be watched.
- * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
+ * \param task
+ * \param alias
+ * \param host
+ * \return
  */
 MSG_error_t
-MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
+MSG_task_receive_from_host(m_task_t * task, const char *alias,
+                           m_host_t host)
 {
-  XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
-  return MSG_task_get_ext(task, channel, -1, host);
+  return MSG_task_receive_ext(task, alias, -1, host);
 }
 
 /** \ingroup msg_gos_functions
- * \brief Listen on a channel and wait for receiving a task.
+ * \brief Description forthcoming (FIXME)
  *
- * It takes two parameters.
- * \param task a memory location for storing a #m_task_t. It will
- hold a task when this function will return. Thus \a task should not
- be equal to \c NULL and \a *task should be equal to \c NULL. If one of
- those two condition does not hold, there will be a warning message.
- * \param channel the channel on which the agent should be
- listening. This value has to be >=0 and < than the maximal
- number of channels fixed with MSG_set_channel_number().
- * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
+ * \param task
+ * \param alias
+ * \return
  */
-MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
+MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
 {
-  XBT_WARN("DEPRECATED! Now use MSG_task_receive");
-  return MSG_task_get_with_timeout(task, channel, -1);
+  return MSG_task_receive_with_timeout(task, alias, -1);
 }
 
 /** \ingroup msg_gos_functions
- * \brief Listen on a channel and wait for receiving a task with a timeout.
+ * \brief Description forthcoming (FIXME)
  *
- * It takes three parameters.
- * \param task a memory location for storing a #m_task_t. It will
- hold a task when this function will return. Thus \a task should not
- be equal to \c NULL and \a *task should be equal to \c NULL. If one of
- those two condition does not hold, there will be a warning message.
- * \param channel the channel on which the agent should be
- listening. This value has to be >=0 and < than the maximal
- number of channels fixed with MSG_set_channel_number().
- * \param max_duration the maximum time to wait for a task before giving
- up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
- will not be modified and will still be
- equal to \c NULL when returning.
- * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
- */
-MSG_error_t
-MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
-                          double max_duration)
-{
-  XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
-  return MSG_task_get_ext(task, channel, max_duration, NULL);
-}
-
-/** \defgroup msg_gos_functions MSG Operating System Functions
- *  \brief This section describes the functions that can be used
- *  by an agent for handling some task.
+ * \param task
+ * \param alias
+ * \param timeout
+ * \return
  */
-
-MSG_error_t
-MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
-                 m_host_t host)
-{
-  XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
-  xbt_assert((channel >= 0)
-              && (channel < msg_global->max_channel), "Invalid channel %d",
-              channel);
-
-  return
-      MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
-                               (MSG_host_self(), channel), task, host,
-                               timeout);
-}
-
-MSG_error_t
-MSG_task_receive_from_host(m_task_t * task, const char *alias,
-                           m_host_t host)
-{
-  return MSG_task_receive_ext(task, alias, -1, host);
-}
-
-MSG_error_t MSG_task_receive(m_task_t * task, const char *alias)
-{
-  return MSG_task_receive_with_timeout(task, alias, -1);
-}
-
 MSG_error_t
 MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
                               double timeout)
@@ -351,6 +295,15 @@ 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
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param task
+ * \param alias
+ * \param timeout
+ * \param host
+ * \return
+ */
 MSG_error_t
 MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
                      m_host_t host)
@@ -385,7 +338,7 @@ 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 taking the match_data provided by sender (here), and the one of the receiver (if any) and returning whether they match
  * \param match_data user provided data passed to match_fun
  * \return the msg_comm_t communication created
  */
@@ -487,7 +440,7 @@ msg_comm_t MSG_task_irecv(m_task_t *task, const char *name)
 
   CHECK_HOST();
 
-  /* FIXME: these functions are not tracable */
+  /* FIXME: these functions are not traceable */
 
   /* Sanity check */
   xbt_assert(task, "Null pointer for the task storage");
@@ -755,6 +708,12 @@ MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
   return comm->status;
 }
 
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param comm
+ * \return
+ */
 m_task_t MSG_comm_get_task(msg_comm_t comm)
 {
   xbt_assert(comm, "Invalid parameter");
@@ -781,6 +740,109 @@ void MSG_comm_copy_data_from_SIMIX(smx_action_t comm, void* buff, size_t buff_si
   }
 }
 
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param task
+ * \param alias
+ * \return
+ */
+MSG_error_t MSG_task_send(m_task_t task, const char *alias)
+{
+  XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
+  return MSG_task_send_with_timeout(task, alias, -1);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param task
+ * \param alias
+ * \param maxrate
+ * \return
+ */
+MSG_error_t
+MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
+{
+  task->simdata->rate = maxrate;
+  return MSG_task_send(task, alias);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param task
+ * \param alias
+ * \param timeout
+ * \return
+ */
+MSG_error_t
+MSG_task_send_with_timeout(m_task_t task, const char *alias,
+                           double timeout)
+{
+  return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
+                                      task, timeout);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param alias
+ * \return
+ */
+int MSG_task_listen(const char *alias)
+{
+  CHECK_HOST();
+
+  return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param alias
+ * \param host
+ * \return
+ */
+int MSG_task_listen_from_host(const char *alias, m_host_t host)
+{
+  CHECK_HOST();
+
+  return
+      MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
+                                               (alias), host);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Description forthcoming (FIXME)
+ *
+ * \param alias
+ * \return
+ */
+int MSG_task_listen_from(const char *alias)
+{
+  m_task_t task;
+
+  CHECK_HOST();
+
+  if (NULL ==
+      (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
+    return -1;
+
+  return MSG_process_get_PID(task->simdata->sender);
+}
+
+#ifdef MSG_USE_DEPRECATED
+/** \ingroup msg_gos_functions
+ *
+ * \brief Return the last value returned by a MSG function (except
+ * MSG_get_errno...).
+ */
+MSG_error_t MSG_get_errno(void)
+{
+  return PROCESS_GET_ERRNO();
+}
+
 /** \ingroup msg_gos_functions
  * \brief Put a task on a channel of an host and waits for the end of the
  * transmission.
@@ -870,34 +932,33 @@ MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
                                    (dest, channel), task, timeout);
 }
 
-MSG_error_t MSG_task_send(m_task_t task, const char *alias)
-{
-  XBT_DEBUG("MSG_task_send: Trying to send a message on mailbox '%s'", alias);
-  return MSG_task_send_with_timeout(task, alias, -1);
-}
-
-
-MSG_error_t
-MSG_task_send_bounded(m_task_t task, const char *alias, double maxrate)
+/** \ingroup msg_gos_functions
+ * \brief Test whether there is a pending communication on a channel, and who sent it.
+ *
+ * It takes one parameter.
+ * \param channel the channel on which the agent should be
+ listening. This value has to be >=0 and < than the maximal
+ number of channels fixed with MSG_set_channel_number().
+ * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
+ */
+int MSG_task_probe_from(m_channel_t channel)
 {
-  task->simdata->rate = maxrate;
-  return MSG_task_send(task, alias);
-}
+  XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
+  m_task_t task;
 
+  CHECK_HOST();
 
-MSG_error_t
-MSG_task_send_with_timeout(m_task_t task, const char *alias,
-                           double timeout)
-{
-  return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias),
-                                      task, timeout);
-}
+  xbt_assert((channel >= 0)
+              && (channel < msg_global->max_channel), "Invalid channel %d",
+              channel);
 
-int MSG_task_listen(const char *alias)
-{
-  CHECK_HOST();
+  if (NULL ==
+      (task =
+       MSG_mailbox_get_head(MSG_mailbox_get_by_channel
+                            (MSG_host_self(), channel))))
+    return -1;
 
-  return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
+  return MSG_process_get_PID(task->simdata->sender);
 }
 
 /** \ingroup msg_gos_functions
@@ -952,65 +1013,84 @@ int MSG_task_probe_from_host(int channel, m_host_t host)
 
 }
 
-int MSG_task_listen_from_host(const char *alias, m_host_t host)
+/** \ingroup msg_gos_functions
+ * \brief Listen on \a channel and waits for receiving a task from \a host.
+ *
+ * It takes three parameters.
+ * \param task a memory location for storing a #m_task_t. It will
+ hold a task when this function will return. Thus \a task should not
+ be equal to \c NULL and \a *task should be equal to \c NULL. If one of
+ those two condition does not hold, there will be a warning message.
+ * \param channel the channel on which the agent should be
+ listening. This value has to be >=0 and < than the maximal
+ number of channels fixed with MSG_set_channel_number().
+ * \param host the host that is to be watched.
+ * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
+ */
+MSG_error_t
+MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host)
 {
-  CHECK_HOST();
-
-  return
-      MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
-                                               (alias), host);
+  XBT_WARN("DEPRECATED! Now use MSG_task_receive_from_host");
+  return MSG_task_get_ext(task, channel, -1, host);
 }
 
 /** \ingroup msg_gos_functions
- * \brief Test whether there is a pending communication on a channel, and who sent it.
+ * \brief Listen on a channel and wait for receiving a task.
  *
- * It takes one parameter.
+ * It takes two parameters.
+ * \param task a memory location for storing a #m_task_t. It will
+ hold a task when this function will return. Thus \a task should not
+ be equal to \c NULL and \a *task should be equal to \c NULL. If one of
+ those two condition does not hold, there will be a warning message.
  * \param channel the channel on which the agent should be
  listening. This value has to be >=0 and < than the maximal
  number of channels fixed with MSG_set_channel_number().
- * \return -1 if there is no pending communication and the PID of the process who sent it otherwise
+ * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
  */
-int MSG_task_probe_from(m_channel_t channel)
+MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
 {
-  XBT_WARN("DEPRECATED! Now use MSG_task_listen_from");
-  m_task_t task;
+  XBT_WARN("DEPRECATED! Now use MSG_task_receive");
+  return MSG_task_get_with_timeout(task, channel, -1);
+}
 
-  CHECK_HOST();
+/** \ingroup msg_gos_functions
+ * \brief Listen on a channel and wait for receiving a task with a timeout.
+ *
+ * It takes three parameters.
+ * \param task a memory location for storing a #m_task_t. It will
+ hold a task when this function will return. Thus \a task should not
+ be equal to \c NULL and \a *task should be equal to \c NULL. If one of
+ those two condition does not hold, there will be a warning message.
+ * \param channel the channel on which the agent should be
+ listening. This value has to be >=0 and < than the maximal
+ number of channels fixed with MSG_set_channel_number().
+ * \param max_duration the maximum time to wait for a task before giving
+ up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task
+ will not be modified and will still be
+ equal to \c NULL when returning.
+ * \return a #MSG_error_t indicating whether the operation was successful (#MSG_OK), or why it failed otherwise.
+ */
+MSG_error_t
+MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
+                          double max_duration)
+{
+  XBT_WARN("DEPRECATED! Now use MSG_task_receive_with_timeout");
+  return MSG_task_get_ext(task, channel, max_duration, NULL);
+}
 
+MSG_error_t
+MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
+                 m_host_t host)
+{
+  XBT_WARN("DEPRECATED! Now use MSG_task_receive_ext");
   xbt_assert((channel >= 0)
               && (channel < msg_global->max_channel), "Invalid channel %d",
               channel);
 
-  if (NULL ==
-      (task =
-       MSG_mailbox_get_head(MSG_mailbox_get_by_channel
-                            (MSG_host_self(), channel))))
-    return -1;
-
-  return MSG_process_get_PID(task->simdata->sender);
-}
-
-int MSG_task_listen_from(const char *alias)
-{
-  m_task_t task;
-
-  CHECK_HOST();
-
-  if (NULL ==
-      (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
-    return -1;
-
-  return MSG_process_get_PID(task->simdata->sender);
+  return
+      MSG_mailbox_get_task_ext(MSG_mailbox_get_by_channel
+                               (MSG_host_self(), channel), task, host,
+                               timeout);
 }
 
-#ifdef MSG_USE_DEPRECATED
-/** \ingroup msg_gos_functions
- *
- * \brief Return the last value returned by a MSG function (except
- * MSG_get_errno...).
- */
-MSG_error_t MSG_get_errno(void)
-{
-  return PROCESS_GET_ERRNO();
-}
 #endif