simdata_task_t simdata = NULL;
simdata_process_t p_simdata;
e_smx_state_t comp_state;
- CHECK_HOST();
simdata = task->simdata;
p_simdata = SIMIX_process_self_get_data(self);
simdata->isused=1;
simdata->compute =
- SIMIX_req_host_execute(task->name, p_simdata->m_host->simdata->smx_host,
+ simcall_host_execute(task->name, p_simdata->m_host->simdata->smx_host,
simdata->computation_amount,
simdata->priority);
#ifdef HAVE_TRACING
- SIMIX_req_set_category(simdata->compute, task->category);
+ simcall_set_category(simdata->compute, task->category);
#endif
p_simdata->waiting_action = simdata->compute;
- comp_state = SIMIX_req_host_execution_wait(simdata->compute);
+ comp_state = simcall_host_execution_wait(simdata->compute);
p_simdata->waiting_action = NULL;
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;
TRACE_msg_task_execute_end(task);
#endif
MSG_RETURN(MSG_OK);
- } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
+ } else if (simcall_host_get_state(SIMIX_host_self()) == 0) {
/* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
simdata->comm = NULL;
simdata->compute = NULL;
return task;
}
+/** \ingroup msg_gos_functions
+ * \brief Executes a parallel task and waits for its termination.
+ *
+ * \param task a #m_task_t to execute on the location on which the agent is running.
+ *
+ * \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED
+ * or #MSG_HOST_FAILURE otherwise
+ */
MSG_error_t MSG_parallel_task_execute(m_task_t task)
{
simdata_task_t simdata = NULL;
e_smx_state_t comp_state;
simdata_process_t p_simdata;
- CHECK_HOST();
simdata = task->simdata;
p_simdata = SIMIX_process_self_get_data(SIMIX_process_self());
simdata->isused=1;
simdata->compute =
- SIMIX_req_host_parallel_execute(task->name, simdata->host_nb,
+ simcall_host_parallel_execute(task->name, simdata->host_nb,
simdata->host_list,
simdata->comp_amount,
simdata->comm_amount, 1.0, -1.0);
XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
p_simdata->waiting_action = simdata->compute;
- comp_state = SIMIX_req_host_execution_wait(simdata->compute);
+ 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;
simdata->comm = NULL;
simdata->compute = NULL;
MSG_RETURN(MSG_OK);
- } else if (SIMIX_req_host_get_state(SIMIX_host_self()) == 0) {
+ } else if (simcall_host_get_state(SIMIX_host_self()) == 0) {
/* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
simdata->comm = NULL;
simdata->compute = NULL;
#endif
/* create action to sleep */
- state = SIMIX_req_process_sleep(nb_sec);
+ state = simcall_process_sleep(nb_sec);
/*proc->simdata->waiting_action = act_sleep;
}
/** \ingroup msg_gos_functions
- * \brief Listen on \a channel and waits for receiving a task from \a host.
+ * \brief Receives a task from a mailbox from a specific 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)
-{
- return MSG_task_get_ext(task, channel, -1, host);
-}
-
-/** \ingroup msg_gos_functions
- * \brief Listen on a channel and wait for receiving a task.
+ * This is a blocking function, the execution flow will be blocked
+ * until the task is received. See #MSG_task_irecv
+ * for receiving tasks asynchronously.
*
- * 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.
- */
-MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel)
-{
- return MSG_task_get_with_timeout(task, channel, -1);
-}
-
-/** \ingroup msg_gos_functions
- * \brief Listen on a channel and wait for receiving a task with a timeout.
+ * \param task a memory location for storing a #m_task_t.
+ * \param alias name of the mailbox to receive the task from
+ * \param host a #m_host_t host from where the task was sent
*
- * 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.
+ * \return Returns
+ * #MSG_OK if the task was successfully received,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
*/
-MSG_error_t
-MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel,
- double max_duration)
-{
- 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.
- */
-
-MSG_error_t
-MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout,
- m_host_t host)
-{
- 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);
}
+/** \ingroup msg_gos_functions
+ * \brief Receives a task from a mailbox.
+ *
+ * This is a blocking function, the execution flow will be blocked
+ * until the task is received. See #MSG_task_irecv
+ * for receiving tasks asynchronously.
+ *
+ * \param task a memory location for storing a #m_task_t.
+ * \param alias name of the mailbox to receive the task from
+ *
+ * \return Returns
+ * #MSG_OK if the task was successfully received,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
+ */
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
+ * \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
+ * until the task is received or the timeout is achieved. See #MSG_task_irecv
+ * for receiving tasks asynchronously. You can provide a -1 timeout
+ * to obtain an infinite timeout.
+ *
+ * \param task a memory location for storing a #m_task_t.
+ * \param alias name of the mailbox to receive the task from
+ * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_receive)
+ *
+ * \return Returns
+ * #MSG_OK if the task was successfully received,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
+ */
MSG_error_t
MSG_task_receive_with_timeout(m_task_t * task, const char *alias,
double timeout)
return MSG_task_receive_ext(task, alias, timeout, NULL);
}
+/** \ingroup msg_gos_functions
+ * \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
+ * until the task is received or the timeout is achieved. See #MSG_task_irecv
+ * for receiving tasks asynchronously. You can provide a -1 timeout
+ * to obtain an infinite timeout.
+ *
+ * \param task a memory location for storing a #m_task_t.
+ * \param alias name of the mailbox to receive the task from
+ * \param timeout is the maximum wait time for completion (provide -1 for no timeout)
+ * \param host a #m_host_t host from where the task was sent
+ *
+ * \return Returns
+ * #MSG_OK if the task was successfully received,
+* #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
+ */
MSG_error_t
MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout,
m_host_t host)
*
* \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
*/
m_process_t process = MSG_process_self();
msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
- CHECK_HOST();
-
/* FIXME: these functions are not traceable */
/* Prepare the task to send */
"This task is still being used somewhere else. You cannot send it now. Go fix your code!");
t_simdata->isused = 1;
+ t_simdata->comm = NULL;
msg_global->sent_msg++;
/* Send it by calling SIMIX network layer */
comm->task_received = NULL;
comm->status = MSG_OK;
comm->s_comm =
- SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
+ simcall_comm_isend(mailbox, t_simdata->message_size,
t_simdata->rate, task, sizeof(void *), match_fun, NULL, match_data, 0);
t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */
* \param task a #m_task_t to send on another location.
* \param alias name of the mailbox to sent the task to
* \param cleanup a function to destroy the task if the
- * communication fails (if NULL, MSG_task_destroy() will
- * be used by default)
+ * communication fails, e.g. MSG_task_destroy
+ * (if NULL, no function will be called)
*/
void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup)
{
m_process_t process = MSG_process_self();
msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
- CHECK_HOST();
-
- if (cleanup == NULL) {
- cleanup = (void_f_pvoid_t) MSG_task_destroy;
- }
-
/* FIXME: these functions are not traceable */
/* Prepare the task to send */
"This task is still being used somewhere else. You cannot send it now. Go fix your code!");
t_simdata->isused = 1;
+ t_simdata->comm = NULL;
msg_global->sent_msg++;
/* Send it by calling SIMIX network layer */
- smx_action_t comm = SIMIX_req_comm_isend(mailbox, t_simdata->message_size,
- t_simdata->rate, task, sizeof(void *), NULL,cleanup, NULL, 1);
+ smx_action_t comm = simcall_comm_isend(mailbox, t_simdata->message_size,
+ t_simdata->rate, task, sizeof(void *), NULL, cleanup, NULL, 1);
t_simdata->comm = comm;
}
{
smx_rdv_t rdv = MSG_mailbox_get_by_alias(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");
comm->task_sent = NULL;
comm->task_received = task;
comm->status = MSG_OK;
- comm->s_comm = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL);
+ comm->s_comm = simcall_comm_irecv(rdv, task, NULL, NULL, NULL);
return comm;
}
xbt_ex_t e;
int finished = 0;
TRY {
- finished = SIMIX_req_comm_test(comm->s_comm);
+ finished = simcall_comm_test(comm->s_comm);
if (finished && comm->task_received != NULL) {
/* I am the receiver */
MSG_error_t status = MSG_OK;
TRY {
- finished_index = SIMIX_req_comm_testany(s_comms);
+ finished_index = simcall_comm_testany(s_comms);
}
CATCH(e) {
switch (e.category) {
{
xbt_ex_t e;
TRY {
- SIMIX_req_comm_wait(comm->s_comm, timeout);
+ simcall_comm_wait(comm->s_comm, timeout);
if (comm->task_received != NULL) {
/* I am the receiver */
MSG_error_t status = MSG_OK;
TRY {
- finished_index = SIMIX_req_comm_waitany(s_comms);
+ finished_index = simcall_comm_waitany(s_comms);
}
CATCH(e) {
switch (e.category) {
* \ingroup msg_gos_functions
* \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
+ * \return the status of the communication, or #MSG_OK if no error occured
* during the communication
*/
MSG_error_t MSG_comm_get_status(msg_comm_t comm) {
return comm->status;
}
+/** \ingroup msg_gos_functions
+ * \brief Get a task (#m_task_t) from a communication
+ *
+ * \param comm the communication where to get the task
+ * \return the task from the communication
+ */
m_task_t MSG_comm_get_task(msg_comm_t comm)
{
xbt_assert(comm, "Invalid parameter");
if (msg_global->task_copy_callback) {
m_task_t task = buff;
msg_global->task_copy_callback(task,
- SIMIX_req_comm_get_src_proc(comm), SIMIX_req_comm_get_dst_proc(comm));
+ simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
}
}
/** \ingroup msg_gos_functions
+ * \brief Sends a task to a mailbox
+ *
+ * This is a blocking function, the execution flow will be blocked
+ * until the task is sent (and received in the other side if #MSG_task_receive is used).
+ * See #MSG_task_isend for sending tasks asynchronously.
+ *
+ * \param task the task to be sent
+ * \param alias the mailbox name to where the task is sent
+ *
+ * \return Returns #MSG_OK if the task was successfully sent,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
+ */
+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 Sends a task to a mailbox with a maximum rate
+ *
+ * This is a blocking function, the execution flow will be blocked
+ * until the task is sent. The maxrate parameter allows the application
+ * to limit the bandwidth utilization of network links when sending the task.
+ *
+ * \param task the task to be sent
+ * \param alias the mailbox name to where the task is sent
+ * \param maxrate the maximum communication rate for sending this task
+ *
+ * \return Returns #MSG_OK if the task was successfully sent,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
+ */
+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 Sends a task to a mailbox with a timeout
+ *
+ * This is a blocking function, the execution flow will be blocked
+ * until the task is sent or the timeout is achieved.
+ *
+ * \param task the task to be sent
+ * \param alias the mailbox name to where the task is sent
+ * \param timeout is the maximum wait time for completion (if -1, this call is the same as #MSG_task_send)
+ *
+ * \return Returns #MSG_OK if the task was successfully sent,
+ * #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE, or #MSG_TIMEOUT otherwise.
+ */
+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 Check if there is a communication going on in a mailbox.
+ *
+ * \param alias the name of the mailbox to be considered
+ *
+ * \return Returns 1 if there is a communication, 0 otherwise
+ */
+int MSG_task_listen(const char *alias)
+{
+ return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias));
+}
+
+/** \ingroup msg_gos_functions
+ * \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
+ * \param host the host to check for communication
+ *
+ * \return Returns the number of pending communication actions of the host in the
+ * given mailbox, 0 if there is no pending communication actions.
+ *
+ */
+int MSG_task_listen_from_host(const char *alias, m_host_t host)
+{
+ return
+ MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias
+ (alias), host);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Look if there is a communication on a mailbox and return the
+ * PID of the sender process.
+ *
+ * \param alias the name of the mailbox to be considered
+ *
+ * \return Returns the PID of sender process,
+ * -1 if there is no communication in the mailbox.
+ */
+int MSG_task_listen_from(const char *alias)
+{
+ m_task_t task;
+
+ if (NULL ==
+ (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias))))
+ return -1;
+
+ return MSG_process_get_PID(task->simdata->sender);
+}
+
+/** \ingroup msg_gos_functions
+ * \brief Sets the tracing category of a task.
+ *
+ * This function should be called after the creation of
+ * a MSG task, to define the category of that task. The
+ * first parameter task must contain a task that was
+ * created with the function #MSG_task_create. The second
+ * parameter category must contain a category that was
+ * previously declared with the function #TRACE_category
+ * (or with #TRACE_category_with_color).
+ *
+ * See \ref tracing_tracing for details on how to trace
+ * the (categorized) resource utilization.
+ *
+ * \param task the task that is going to be categorized
+ * \param category the name of the category to be associated to the task
+ *
+ * \see MSG_task_get_category, TRACE_category, TRACE_category_with_color
+ */
+void MSG_task_set_category (m_task_t task, const char *category)
+{
+#ifdef HAVE_TRACING
+ TRACE_msg_set_task_category (task, category);
+#endif
+}
+
+/** \ingroup msg_gos_functions
+ *
+ * \brief Gets the current tracing category of a task.
+ *
+ * \param task the task to be considered
+ *
+ * \see MSG_task_set_category
+ *
+ * \return Returns the name of the tracing category of the given task, NULL otherwise
+ */
+const char *MSG_task_get_category (m_task_t task)
+{
+#ifdef HAVE_TRACING
+ return task->category;
+#else
+ return NULL;
+#endif
+}
+
+#ifdef MSG_USE_DEPRECATED
+/** \ingroup msg_deprecated_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_deprecated_functions
* \brief Put a task on a channel of an host and waits for the end of the
* transmission.
*
*/
MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel)
{
+ XBT_WARN("DEPRECATED! Now use MSG_task_send");
return MSG_task_put_with_timeout(task, dest, channel, -1.0);
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Does exactly the same as MSG_task_put but with a bounded transmition
* rate.
*
MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel,
double maxrate)
{
+ XBT_WARN("DEPRECATED! Now use MSG_task_send_bounded");
task->simdata->rate = maxrate;
return MSG_task_put(task, dest, channel);
}
-/** \ingroup msg_gos_functions \brief Put a task on a channel of an
+/** \ingroup msg_deprecated_functions
+ *
+ * \brief Put a task on a channel of an
* host (with a timeout on the waiting of the destination host) and
* waits for the end of the transmission.
*
MSG_task_put_with_timeout(m_task_t task, m_host_t dest,
m_channel_t channel, double timeout)
{
+ XBT_WARN("DEPRECATED! Now use MSG_task_send_with_timeout");
xbt_assert((channel >= 0)
&& (channel < msg_global->max_channel), "Invalid channel %d",
channel);
(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_deprecated_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;
-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
+/** \ingroup msg_deprecated_functions
* \brief Test whether there is a pending communication on a channel.
*
* It takes one parameter.
*/
int MSG_task_Iprobe(m_channel_t channel)
{
+ XBT_WARN("DEPRECATED!");
xbt_assert((channel >= 0)
&& (channel < msg_global->max_channel), "Invalid channel %d",
channel);
- CHECK_HOST();
-
return
!MSG_mailbox_is_empty(MSG_mailbox_get_by_channel
(MSG_host_self(), channel));
}
-/** \ingroup msg_gos_functions
+/** \ingroup msg_deprecated_functions
* \brief Return the number of tasks waiting to be received on a \a
channel and sent by \a host.
*/
int MSG_task_probe_from_host(int channel, m_host_t host)
{
+ XBT_WARN("DEPRECATED! Now use MSG_task_listen_from_host");
xbt_assert((channel >= 0)
&& (channel < msg_global->max_channel), "Invalid channel %d",
channel);
- CHECK_HOST();
-
return
MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_channel
(MSG_host_self(), channel),
}
-int MSG_task_listen_from_host(const char *alias, m_host_t host)
+/** \ingroup msg_deprecated_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.
+/** \ingroup msg_deprecated_functions
+ * \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)
{
- 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_deprecated_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