/* Copyright (c) 2004-2016. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
#include "src/simix/smx_private.h" /* MSG_task_listen looks inside the rdv directly. Not clean. */
#include "msg_private.h"
#include "mc/mc.h"
#include "xbt/log.h"
#include "xbt/sysdep.h"
XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg,
"Logging specific to MSG (gos)");
/** \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 takes only one parameter.
* \param task a #msg_task_t to execute on the location on which the process is running.
* \return #MSG_OK if the task was successfully completed, #MSG_TASK_CANCELED or #MSG_HOST_FAILURE otherwise
*/
msg_error_t MSG_task_execute(msg_task_t task)
{
/* TODO: add this to other locations */
msg_host_t host = MSG_process_get_host(MSG_process_self());
MSG_host_add_task(host, task);
msg_error_t ret = MSG_parallel_task_execute(task);
MSG_host_del_task(host, task);
return ret;
}
/** \ingroup msg_task_usage
* \brief Executes a parallel task and waits for its termination.
*
* \param task a #msg_task_t to execute on the location on which the process 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(msg_task_t task)
{
xbt_ex_t e;
simdata_task_t simdata = task->simdata;
simdata_process_t p_simdata = (simdata_process_t) SIMIX_process_self_get_data();
e_smx_state_t comp_state;
msg_error_t status = MSG_OK;
TRACE_msg_task_execute_start(task);
xbt_assert((!simdata->compute) && (task->simdata->isused == 0),
"This task is executed somewhere else. Go fix your code! %d", task->simdata->isused!=NULL);
XBT_DEBUG("Computing on %s", MSG_process_get_name(MSG_process_self()));
if (simdata->flops_amount == 0 && !simdata->host_nb) {
TRACE_msg_task_execute_end(task);
return MSG_OK;
}
TRY {
if (msg_global->debug_multiple_use)
MSG_BT(simdata->isused, "Using Backtrace");
else
simdata->isused = (void*)1;
if (simdata->host_nb > 0) {
simdata->compute = simcall_execution_parallel_start(task->name, simdata->host_nb,simdata->host_list,
simdata->flops_parallel_amount, simdata->bytes_parallel_amount,
1.0, -1.0);
XBT_DEBUG("Parallel execution action created: %p", simdata->compute);
} else {
unsigned long affinity_mask =
(unsigned long)(uintptr_t) xbt_dict_get_or_null_ext(simdata->affinity_mask_db, (char *) p_simdata->m_host,
sizeof(msg_host_t));
XBT_DEBUG("execute %s@%s with affinity(0x%04lx)",
MSG_task_get_name(task), MSG_host_get_name(p_simdata->m_host), affinity_mask);
simdata->compute = simcall_execution_start(task->name, simdata->flops_amount, simdata->priority,
simdata->bound, affinity_mask);
}
simcall_set_category(simdata->compute, task->category);
p_simdata->waiting_action = simdata->compute;
comp_state = simcall_execution_wait(simdata->compute);
p_simdata->waiting_action = NULL;
if (msg_global->debug_multiple_use && simdata->isused!=0)
xbt_ex_free(*(xbt_ex_t*)simdata->isused);
simdata->isused = 0;
XBT_DEBUG("Execution task '%s' finished in state %d", task->name, (int)comp_state);
}
CATCH(e) {
switch (e.category) {
case cancel_error:
status = MSG_TASK_CANCELED;
break;
case host_error:
status = MSG_HOST_FAILURE;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
/* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */
simdata->flops_amount = 0.0;
simdata->comm = NULL;
simdata->compute = NULL;
TRACE_msg_task_execute_end(task);
MSG_RETURN(status);
}
/** \ingroup msg_task_usage
* \brief Sleep for the specified number of seconds
*
* Makes the current process sleep until \a time seconds have elapsed.
*
* \param nb_sec a number of second
*/
msg_error_t MSG_process_sleep(double nb_sec)
{
xbt_ex_t e;
msg_error_t status = MSG_OK;
/*msg_process_t proc = MSG_process_self();*/
TRACE_msg_process_sleep_in(MSG_process_self());
TRY {
simcall_process_sleep(nb_sec);
}
CATCH(e) {
switch (e.category) {
case cancel_error:
XBT_DEBUG("According to the JAVA API, a sleep call should only deal with HostFailureException, WTF here ?");
// adsein: MSG_TASK_CANCELED is assigned when someone kills the process that made the sleep, this is not
// correct. For instance, when the node is turned off, the error should be MSG_HOST_FAILURE, which is by the way
// and according to the JAVA document, the only exception that can be triggered by MSG_Process_sleep call.
// To avoid possible impacts in the code, I just raised a host_failure exception for the moment in the JAVA code
// and did not change anythings at the C level.
// See comment in the jmsg_process.c file, function JNIEXPORT void JNICALL Java_org_simgrid_msg_Process_sleep(JNIEnv *env, jclass cls, jlong jmillis, jint jnanos)
status = MSG_TASK_CANCELED;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
TRACE_msg_process_sleep_out(MSG_process_self());
MSG_RETURN(status);
}
/** \ingroup msg_task_usage
* \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 #msg_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(msg_task_t * task, const char *alias)
{
return MSG_task_receive_with_timeout(task, alias, -1);
}
/** \ingroup msg_task_usage
* \brief Receives a task from a mailbox at a given rate.
*
* \param task a memory location for storing a #msg_task_t.
* \param alias name of the mailbox to receive the task from
* \param rate limit the reception to rate bandwidth
*
* \return Returns
* #MSG_OK if the task was successfully received,
* #MSG_HOST_FAILURE, or #MSG_TRANSFER_FAILURE otherwise.
*/
msg_error_t MSG_task_receive_bounded(msg_task_t * task, const char *alias, double rate)
{
return MSG_task_receive_with_timeout_bounded(task, alias, -1, rate);
}
/** \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 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 #msg_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(msg_task_t * task, const char *alias, double timeout)
{
return MSG_task_receive_ext(task, alias, timeout, NULL);
}
/** \ingroup msg_task_usage
* \brief Receives a task from a mailbox with a given timeout and at a given rate.
*
* \param task a memory location for storing a #msg_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)
* \param rate limit the reception to rate bandwidth
*
* \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_bounded(msg_task_t * task, const char *alias, double timeout,double rate)
{
return MSG_task_receive_ext_bounded(task, alias, timeout, NULL, rate);
}
/** \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 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 #msg_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 #msg_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(msg_task_t * task, const char *alias, double timeout, msg_host_t host)
{
xbt_ex_t e;
msg_error_t ret = MSG_OK;
XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
TRY {
ret = MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, host, timeout);
}
CATCH(e) {
switch (e.category) {
case cancel_error: /* may be thrown by MSG_mailbox_get_by_alias */
ret = MSG_HOST_FAILURE;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
return ret;
}
/** \ingroup msg_task_usage
* \brief Receives a task from a mailbox from a specific host with a given timeout and at a given rate.
*
* \param task a memory location for storing a #msg_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 #msg_host_t host from where the task was sent
* \param rate limit the reception to rate bandwidth
*
* \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_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host,
double rate)
{
XBT_DEBUG("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", alias);
return MSG_mailbox_get_task_ext_bounded(MSG_mailbox_get_by_alias(alias), task, host, timeout, rate);
}
/* Internal function used to factorize code between MSG_task_isend_with_matching() and MSG_task_dsend(). */
static inline msg_comm_t MSG_task_isend_internal(msg_task_t task, const char *alias,
int (*match_fun)(void*,void*, smx_synchro_t),
void *match_data, void_f_pvoid_t cleanup, int detached)
{
simdata_task_t t_simdata = NULL;
msg_process_t process = MSG_process_self();
msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
int call_end = TRACE_msg_task_put_start(task);
/* Prepare the task to send */
t_simdata = task->simdata;
t_simdata->sender = process;
t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data())->m_host;
if (t_simdata->isused != 0) {
if (msg_global->debug_multiple_use){
XBT_ERROR("This task is already used in there:");
xbt_backtrace_display((xbt_ex_t*) t_simdata->isused);
XBT_ERROR("And you try to reuse it from here:");
xbt_backtrace_display_current();
} else {
xbt_assert(t_simdata->isused == 0,
"This task is still being used somewhere else. You cannot send it now. Go fix your code!"
"(use --cfg=msg/debug_multiple_use:on to get the backtrace of the other process)");
}
}
if (msg_global->debug_multiple_use)
MSG_BT(t_simdata->isused, "Using Backtrace");
else
t_simdata->isused = (void*)1;
t_simdata->comm = NULL;
msg_global->sent_msg++;
/* Send it by calling SIMIX network layer */
smx_synchro_t act = simcall_comm_isend(SIMIX_process_self(), mailbox, t_simdata->bytes_amount, t_simdata->rate,
task, sizeof(void *), match_fun, cleanup, NULL, match_data,detached);
t_simdata->comm = act; /* FIXME: is the field t_simdata->comm still useful? */
msg_comm_t comm;
if (detached) {
comm = NULL;
} else {
comm = xbt_new0(s_msg_comm_t, 1);
comm->task_sent = task;
comm->task_received = NULL;
comm->status = MSG_OK;
comm->s_comm = act;
}
if (TRACE_is_enabled())
simcall_set_category(act, task->category);
if (call_end)
TRACE_msg_task_put_end();
return comm;
}
/** \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() to end the communication.
*
* \param task a #msg_task_t to send on another location.
* \param alias name of the mailbox to sent the task to
* \return the msg_comm_t communication created
*/
msg_comm_t MSG_task_isend(msg_task_t task, const char *alias)
{
return MSG_task_isend_internal(task, alias, NULL, NULL, NULL, 0);
}
/** \ingroup msg_task_usage
* \brief Sends a task on a mailbox with a maximum rate
*
* This is a non blocking function: use MSG_comm_wait() or MSG_comm_test() to end the communication. The maxrate
* parameter allows the application to limit the bandwidth utilization of network links when sending the task.
*
* \param task a #msg_task_t to send on another location.
* \param alias name of the mailbox to sent the task to
* \param maxrate the maximum communication rate for sending this task .
* \return the msg_comm_t communication created
*/
msg_comm_t MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate)
{
task->simdata->rate = maxrate;
return MSG_task_isend_internal(task, alias, NULL, NULL, NULL, 0);
}
/** \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() to end the communication.
*
* \param task a #msg_task_t to send on another location.
* \param alias name of the mailbox to sent the task to
* \param match_fun boolean function which parameters are:
* - match_data_provided_here
* - match_data_provided_by_other_side_if_any
* - the_smx_synchro_describing_the_other_side
* \param match_data user provided data passed to match_fun
* \return the msg_comm_t communication created
*/
msg_comm_t MSG_task_isend_with_matching(msg_task_t task, const char *alias,
int (*match_fun)(void*, void*, smx_synchro_t), void *match_data)
{
return MSG_task_isend_internal(task, alias, match_fun, match_data, NULL, 0);
}
/** \ingroup msg_task_usage
* \brief Sends a task on a mailbox.
*
* This is a non blocking detached send function.
* Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
* If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
* usual. More details on this can be obtained on
* this thread
* in the SimGrid-user mailing list archive.
*
* \param task a #msg_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, e.g. MSG_task_destroy
* (if NULL, no function will be called)
*/
void MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup)
{
MSG_task_isend_internal(task, alias, NULL, NULL, cleanup, 1);
}
/** \ingroup msg_task_usage
* \brief Sends a task on a mailbox with a maximal rate.
*
* This is a non blocking detached send function.
* Think of it as a best effort send. Keep in mind that the third parameter is only called if the communication fails.
* If the communication does work, it is responsibility of the receiver code to free anything related to the task, as
* usual. More details on this can be obtained on
* this thread
* in the SimGrid-user mailing list archive.
*
* \param task a #msg_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, e.g. MSG_task_destroy
* (if NULL, no function will be called)
* \param maxrate the maximum communication rate for sending this task
*
*/
void MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate)
{
task->simdata->rate = maxrate;
MSG_task_dsend(task, alias, cleanup);
}
/** \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 #msg_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
*/
msg_comm_t MSG_task_irecv(msg_task_t *task, const char *name)
{
return MSG_task_irecv_bounded(task, name, -1.0);
}
/** \ingroup msg_task_usage
* \brief Starts listening for receiving a task from an asynchronous communication at a given rate.
*
* \param task a memory location for storing a #msg_task_t. has to be valid until the end of the communication.
* \param name of the mailbox to receive the task on
* \param rate limit the bandwidth to the given rate
* \return the msg_comm_t communication created
*/
msg_comm_t MSG_task_irecv_bounded(msg_task_t *task, const char *name, double rate)
{
smx_mailbox_t rdv = MSG_mailbox_get_by_alias(name);
/* FIXME: these functions are not traceable */
/* Sanity check */
xbt_assert(task, "Null pointer for the task storage");
if (*task)
XBT_CRITICAL("MSG_task_irecv() was asked to write in a non empty task struct.");
/* Try to receive it by calling SIMIX network layer */
msg_comm_t comm = xbt_new0(s_msg_comm_t, 1);
comm->task_sent = NULL;
comm->task_received = task;
comm->status = MSG_OK;
comm->s_comm = simcall_comm_irecv(MSG_process_self(), rdv, task, NULL, NULL, NULL, NULL, rate);
return comm;
}
/** \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
* (but it may have failed, use MSG_comm_get_status() to know its status)
* or FALSE if the communication is not finished yet
* If the status is FALSE, don't forget to use MSG_process_sleep() after the test.
*/
int MSG_comm_test(msg_comm_t comm)
{
xbt_ex_t e;
int finished = 0;
TRY {
finished = simcall_comm_test(comm->s_comm);
if (finished && comm->task_received != NULL) {
/* I am the receiver */
if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
(*comm->task_received)->simdata->isused = 0;
}
}
CATCH(e) {
switch (e.category) {
case network_error:
comm->status = MSG_TRANSFER_FAILURE;
finished = 1;
break;
case timeout_error:
comm->status = MSG_TIMEOUT;
finished = 1;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
return finished;
}
/** \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
* (but it may have failed, use MSG_comm_get_status() to know its status),
* or -1 if none is finished
*/
int MSG_comm_testany(xbt_dynar_t comms)
{
xbt_ex_t e;
int finished_index = -1;
/* create the equivalent dynar with SIMIX objects */
xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), NULL);
msg_comm_t comm;
unsigned int cursor;
xbt_dynar_foreach(comms, cursor, comm) {
xbt_dynar_push(s_comms, &comm->s_comm);
}
msg_error_t status = MSG_OK;
TRY {
finished_index = simcall_comm_testany(s_comms);
}
CATCH(e) {
switch (e.category) {
case network_error:
finished_index = e.value;
status = MSG_TRANSFER_FAILURE;
break;
case timeout_error:
finished_index = e.value;
status = MSG_TIMEOUT;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
xbt_dynar_free(&s_comms);
if (finished_index != -1) {
comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
/* the communication is finished */
comm->status = status;
if (status == MSG_OK && comm->task_received != NULL) {
/* I am the receiver */
if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
(*comm->task_received)->simdata->isused = 0;
}
}
return finished_index;
}
/** \ingroup msg_task_usage
* \brief Destroys a communication.
* \param comm the communication to destroy.
*/
void MSG_comm_destroy(msg_comm_t comm)
{
xbt_free(comm);
}
/** \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.
* 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)
{
xbt_ex_t e;
TRY {
simcall_comm_wait(comm->s_comm, timeout);
if (comm->task_received != NULL) {
/* I am the receiver */
if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
(*comm->task_received)->simdata->isused = 0;
}
/* FIXME: these functions are not traceable */
}
CATCH(e) {
switch (e.category) {
case network_error:
comm->status = MSG_TRANSFER_FAILURE;
break;
case timeout_error:
comm->status = MSG_TIMEOUT;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
return comm->status;
}
/** \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
* \param nb_elem is the size of the comm vector
* \param timeout for each call of MSG_comm_wait
*/
void MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout)
{
int i = 0;
for (i = 0; i < nb_elem; i++) {
MSG_comm_wait(comm[i], timeout);
}
}
/** \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
* (but it may have failed, use MSG_comm_get_status() to know its status)
*/
int MSG_comm_waitany(xbt_dynar_t comms)
{
xbt_ex_t e;
int finished_index = -1;
/* create the equivalent dynar with SIMIX objects */
xbt_dynar_t s_comms = xbt_dynar_new(sizeof(smx_synchro_t), NULL);
msg_comm_t comm;
unsigned int cursor;
xbt_dynar_foreach(comms, cursor, comm) {
xbt_dynar_push(s_comms, &comm->s_comm);
}
msg_error_t status = MSG_OK;
TRY {
finished_index = simcall_comm_waitany(s_comms);
}
CATCH(e) {
switch (e.category) {
case network_error:
finished_index = e.value;
status = MSG_TRANSFER_FAILURE;
break;
case timeout_error:
finished_index = e.value;
status = MSG_TIMEOUT;
break;
default:
RETHROW;
}
xbt_ex_free(e);
}
xbt_assert(finished_index != -1, "WaitAny returned -1");
xbt_dynar_free(&s_comms);
comm = xbt_dynar_get_as(comms, finished_index, msg_comm_t);
/* the communication is finished */
comm->status = status;
if (comm->task_received != NULL) {
/* I am the receiver */
if (msg_global->debug_multiple_use && (*comm->task_received)->simdata->isused!=0)
xbt_ex_free(*(xbt_ex_t*)(*comm->task_received)->simdata->isused);
(*comm->task_received)->simdata->isused = 0;
}
return finished_index;
}
/**
* \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
* during the communication
*/
msg_error_t MSG_comm_get_status(msg_comm_t comm) {
return comm->status;
}
/** \ingroup msg_task_usage
* \brief Get a task (#msg_task_t) from a communication
*
* \param comm the communication where to get the task
* \return the task from the communication
*/
msg_task_t MSG_comm_get_task(msg_comm_t comm)
{
xbt_assert(comm, "Invalid parameter");
return comm->task_received ? *comm->task_received : comm->task_sent;
}
/**
* \brief This function is called by SIMIX in kernel mode to copy the data of a comm.
* \param comm the comm
* \param buff the data copied
* \param buff_size size of the buffer
*/
void MSG_comm_copy_data_from_SIMIX(smx_synchro_t comm, void* buff, size_t buff_size) {
// copy the task
SIMIX_comm_copy_pointer_callback(comm, buff, buff_size);
// notify the user callback if any
if (msg_global->task_copy_callback) {
msg_task_t task = (msg_task_t) buff;
msg_global->task_copy_callback(task, simcall_comm_get_src_proc(comm), simcall_comm_get_dst_proc(comm));
}
}
/** \ingroup msg_task_usage
* \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 on 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(msg_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_task_usage
* \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(msg_task_t task, const char *alias, double maxrate)
{
task->simdata->rate = maxrate;
return MSG_task_send(task, alias);
}
/** \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 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(msg_task_t task, const char *alias, double timeout)
{
msg_error_t ret = MSG_OK;
simdata_task_t t_simdata = NULL;
msg_process_t process = MSG_process_self();
simdata_process_t p_simdata = (simdata_process_t) SIMIX_process_self_get_data();
msg_mailbox_t mailbox = MSG_mailbox_get_by_alias(alias);
int call_end = TRACE_msg_task_put_start(task); //must be after CHECK_HOST()
/* Prepare the task to send */
t_simdata = task->simdata;
t_simdata->sender = process;
t_simdata->source = ((simdata_process_t) SIMIX_process_self_get_data())->m_host;
if (t_simdata->isused != 0) {
if (msg_global->debug_multiple_use){
XBT_ERROR("This task is already used in there:");
xbt_backtrace_display((xbt_ex_t*) t_simdata->isused);
XBT_ERROR("And you try to reuse it from here:");
xbt_backtrace_display_current();
} else {
xbt_assert(t_simdata->isused == 0,
"This task is still being used somewhere else. You cannot send it now. Go fix your code!"
" (use --cfg=msg/debug_multiple_use:on to get the backtrace of the other process)");
}
}
if (msg_global->debug_multiple_use)
MSG_BT(t_simdata->isused, "Using Backtrace");
else
t_simdata->isused = (void*)1;
t_simdata->comm = NULL;
msg_global->sent_msg++;
p_simdata->waiting_task = task;
xbt_ex_t e;
/* Try to send it by calling SIMIX network layer */
TRY {
smx_synchro_t comm = NULL; /* MC needs the comm to be set to NULL during the simix call */
comm = simcall_comm_isend(SIMIX_process_self(), mailbox,t_simdata->bytes_amount,
t_simdata->rate, task, sizeof(void *), NULL, NULL, NULL, task, 0);
if (TRACE_is_enabled())
simcall_set_category(comm, task->category);
t_simdata->comm = comm;
simcall_comm_wait(comm, timeout);
}
CATCH(e) {
switch (e.category) {
case cancel_error:
ret = MSG_HOST_FAILURE;
break;
case network_error:
ret = MSG_TRANSFER_FAILURE;
break;
case timeout_error:
ret = MSG_TIMEOUT;
break;
default:
RETHROW;
}
xbt_ex_free(e);
/* If the send failed, it is not used anymore */
if (msg_global->debug_multiple_use && t_simdata->isused!=0)
xbt_ex_free(*(xbt_ex_t*)t_simdata->isused);
t_simdata->isused = 0;
}
p_simdata->waiting_task = NULL;
if (call_end)
TRACE_msg_task_put_end();
MSG_RETURN(ret);
}
/** \ingroup msg_task_usage
* \brief Sends a task to a mailbox with a timeout and with a maximum rate
*
* 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)
* \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, or #MSG_TIMEOUT otherwise.
*/
msg_error_t MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate)
{
task->simdata->rate = maxrate;
return MSG_task_send_with_timeout(task, alias, timeout);
}
/** \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
*
* \return Returns 1 if there is a communication, 0 otherwise
*/
int MSG_task_listen(const char *alias)
{
smx_mailbox_t mbox = MSG_mailbox_get_by_alias(alias);
return !MSG_mailbox_is_empty(mbox) || (mbox->permanent_receiver && !mbox->done_comm_queue->empty());
}
/** \ingroup msg_task_usage
* \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)
{
msg_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_task_usage
* \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 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 (msg_task_t task, const char *category)
{
TRACE_msg_set_task_category (task, category);
}
/** \ingroup msg_task_usage
*
* \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 (msg_task_t task)
{
return task->category;
}
/**
* \brief Returns the value of a given AS or router property
*
* \param asr the name of a router or AS
* \param name a property name
* \return value of a property (or NULL if property not set)
*/
const char *MSG_as_router_get_property_value(const char* asr, const char *name)
{
return (char*) xbt_dict_get_or_null(MSG_as_router_get_properties(asr), name);
}
/**
* \brief Returns a xbt_dict_t consisting of the list of properties assigned to
* a the AS or router
*
* \param asr the name of a router or AS
* \return a dict containing the properties
*/
xbt_dict_t MSG_as_router_get_properties(const char* asr)
{
return (simcall_asr_get_properties(asr));
}
/**
* \brief Change the value of a given AS or router
*
* \param asr the name of a router or AS
* \param name a property name
* \param value what to change the property to
* \param free_ctn the freeing function to use to kill the value on need
*/
void MSG_as_router_set_property_value(const char* asr, const char *name, char *value,void_f_pvoid_t free_ctn) {
xbt_dict_set(MSG_as_router_get_properties(asr), name, value,free_ctn);
}