X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/8963831bbd6c10389bc103e579afe2d632262d95..ca7162936235b0732afe3a675ca09fe11f915eab:/src/msg/gos.c diff --git a/src/msg/gos.c b/src/msg/gos.c index 8d5cf00b4b..8093c97664 100644 --- a/src/msg/gos.c +++ b/src/msg/gos.c @@ -1,30 +1,27 @@ -/* $Id$ */ - -/* Copyright (c) 2002-2007 Arnaud Legrand. */ -/* Copyright (c) 2007 Bruno Donassolo. */ -/* All rights reserved. */ +/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. 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 "msg/private.h" +#include "private.h" #include "xbt/sysdep.h" +#include "mc/mc.h" #include "xbt/log.h" #include "mailbox.h" XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, - "Logging specific to MSG (gos)"); + "Logging specific to MSG (gos)"); /** \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) +MSG_error_t MSG_get_errno(void) { - return PROCESS_GET_ERRNO(); + return PROCESS_GET_ERRNO(); } /** \ingroup msg_gos_functions @@ -33,175 +30,190 @@ MSG_get_errno(void) * This function is used for describing the behavior of an agent. It * takes only one parameter. * \param task a #m_task_t to execute on the location on which the - agent is running. + agent is running. * \return #MSG_FATAL if \a task is not properly initialized and * #MSG_OK otherwise. */ -MSG_error_t -MSG_task_execute(m_task_t task) -{ - simdata_task_t simdata = NULL; - m_process_t self = MSG_process_self(); - CHECK_HOST(); - - simdata = task->simdata; - xbt_assert0((!simdata->compute) && (task->simdata->refcount == 1),"This task is executed somewhere else. Go fix your code!"); - - DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name); - - simdata->refcount ++; - SIMIX_mutex_lock(simdata->mutex); - simdata->compute = SIMIX_action_execute(SIMIX_host_self(), task->name, simdata->computation_amount); - SIMIX_action_set_priority(simdata->compute, simdata->priority); - - self->simdata->waiting_task = task; - SIMIX_register_action_to_condition(simdata->compute, simdata->cond); - SIMIX_cond_wait(simdata->cond, simdata->mutex); - SIMIX_unregister_action_to_condition(simdata->compute, simdata->cond); - self->simdata->waiting_task = NULL; - - SIMIX_mutex_unlock(simdata->mutex); - simdata->refcount --; - - if (SIMIX_action_get_state(task->simdata->compute) == SURF_ACTION_DONE) - { - /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ - SIMIX_action_destroy(task->simdata->compute); - simdata->computation_amount = 0.0; - simdata->comm = NULL; - simdata->compute = NULL; - MSG_RETURN(MSG_OK); - } - else if(SIMIX_host_get_state(SIMIX_host_self()) == 0) - { - /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ - SIMIX_action_destroy(task->simdata->compute); - simdata->comm = NULL; - simdata->compute = NULL; - MSG_RETURN(MSG_HOST_FAILURE); - } - else - { - /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ - SIMIX_action_destroy(task->simdata->compute); - simdata->comm = NULL; - simdata->compute = NULL; - MSG_RETURN(MSG_TASK_CANCELLED); - } +MSG_error_t MSG_task_execute(m_task_t task) +{ + simdata_task_t simdata = NULL; + m_process_t self = MSG_process_self(); + e_smx_state_t comp_state; + CHECK_HOST(); + + simdata = task->simdata; + + xbt_assert0(simdata->host_nb == 0, + "This is a parallel task. Go to hell."); + +#ifdef HAVE_TRACING + TRACE_msg_task_execute_start(task); +#endif + + xbt_assert1((!simdata->compute) && (task->simdata->isused == 0), + "This task is executed somewhere else. Go fix your code! %d", + task->simdata->isused); + + DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name); + + if (simdata->computation_amount == 0) { +#ifdef HAVE_TRACING + TRACE_msg_task_execute_end(task); +#endif + return MSG_OK; + } + simdata->isused=1; + simdata->compute = + SIMIX_req_host_execute(task->name, SIMIX_host_self(), + simdata->computation_amount, + simdata->priority); +#ifdef HAVE_TRACING + SIMIX_req_set_category(simdata->compute, task->category); +#endif + + self->simdata->waiting_action = simdata->compute; + comp_state = SIMIX_req_host_execution_wait(simdata->compute); + self->simdata->waiting_action = NULL; + + simdata->isused=0; + + DEBUG2("Execution task '%s' finished in state %d", task->name, 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; + simdata->comm = NULL; + simdata->compute = NULL; +#ifdef HAVE_TRACING + TRACE_msg_task_execute_end(task); +#endif + MSG_RETURN(MSG_OK); + } else if (SIMIX_req_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; +#ifdef HAVE_TRACING + TRACE_msg_task_execute_end(task); +#endif + MSG_RETURN(MSG_HOST_FAILURE); + } else { + /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ + simdata->comm = NULL; + simdata->compute = NULL; +#ifdef HAVE_TRACING + TRACE_msg_task_execute_end(task); +#endif + MSG_RETURN(MSG_TASK_CANCELLED); + } } /** \ingroup m_task_management * \brief Creates a new #m_task_t (a parallel one....). * - * A constructor for #m_task_t taking six arguments and returning the - corresponding object. + * A constructor for #m_task_t taking six arguments and returning the + corresponding object. * \param name a name for the object. It is for user-level information - and can be NULL. + and can be NULL. * \param host_nb the number of hosts implied in the parallel task. * \param host_list an array of \p host_nb m_host_t. * \param computation_amount an array of \p host_nb - doubles. computation_amount[i] is the total number of operations - that have to be performed on host_list[i]. + doubles. computation_amount[i] is the total number of operations + that have to be performed on host_list[i]. * \param communication_amount an array of \p host_nb* \p host_nb doubles. * \param data a pointer to any data may want to attach to the new - object. It is for user-level information and can be NULL. It can - be retrieved with the function \ref MSG_task_get_data. + object. It is for user-level information and can be NULL. It can + be retrieved with the function \ref MSG_task_get_data. * \see m_task_t * \return The new corresponding object. */ -m_task_t -MSG_parallel_task_create(const char *name,int host_nb, const m_host_t * host_list, double *computation_amount, double *communication_amount, void *data) -{ - int i; - simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1); - m_task_t task = xbt_new0(s_m_task_t, 1); - task->simdata = simdata; - - /* Task structure */ - task->name = xbt_strdup(name); - task->data = data; - - /* Simulator Data */ - simdata->computation_amount = 0; - simdata->message_size = 0; - simdata->cond = SIMIX_cond_init(); - simdata->mutex = SIMIX_mutex_init(); - simdata->compute = NULL; - simdata->comm = NULL; - simdata->rate = -1.0; - simdata->refcount = 1; - simdata->sender = NULL; - simdata->receiver = NULL; - simdata->source = NULL; - - simdata->host_nb = host_nb; - simdata->host_list = xbt_new0(smx_host_t, host_nb); - simdata->comp_amount = computation_amount; - simdata->comm_amount = communication_amount; - - for (i = 0; i < host_nb; i++) - simdata->host_list[i] = host_list[i]->simdata->smx_host; - - return task; -} - -MSG_error_t -MSG_parallel_task_execute(m_task_t task) -{ - simdata_task_t simdata = NULL; - m_process_t self = MSG_process_self(); - CHECK_HOST(); - - simdata = task->simdata; - - xbt_assert0((!simdata->compute) && (task->simdata->refcount == 1),"This task is executed somewhere else. Go fix your code!"); - - xbt_assert0(simdata->host_nb,"This is not a parallel task. Go to hell."); - - DEBUG1("Computing on %s", MSG_process_self()->simdata->m_host->name); - - simdata->refcount ++; - - SIMIX_mutex_lock(simdata->mutex); - simdata->compute = - SIMIX_action_parallel_execute(task->name, simdata->host_nb, simdata->host_list, simdata->comp_amount, simdata->comm_amount, 1.0, -1.0); - - self->simdata->waiting_task = task; - SIMIX_register_action_to_condition(simdata->compute, simdata->cond); - SIMIX_cond_wait(simdata->cond, simdata->mutex); - SIMIX_unregister_action_to_condition(simdata->compute, simdata->cond); - self->simdata->waiting_task = NULL; - - - SIMIX_mutex_unlock(simdata->mutex); - simdata->refcount --; - - if (SIMIX_action_get_state(task->simdata->compute) == SURF_ACTION_DONE) - { - /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ - SIMIX_action_destroy(task->simdata->compute); - simdata->computation_amount = 0.0; - simdata->comm = NULL; - simdata->compute = NULL; - MSG_RETURN(MSG_OK); - } - else if(SIMIX_host_get_state(SIMIX_host_self()) == 0) - { - /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ - SIMIX_action_destroy(task->simdata->compute); - simdata->comm = NULL; - simdata->compute = NULL; - MSG_RETURN(MSG_HOST_FAILURE); - } - else - { - /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ - SIMIX_action_destroy(task->simdata->compute); - simdata->comm = NULL; - simdata->compute = NULL; - MSG_RETURN(MSG_TASK_CANCELLED); - } +m_task_t +MSG_parallel_task_create(const char *name, int host_nb, + const m_host_t * host_list, + double *computation_amount, + double *communication_amount, void *data) +{ + int i; + simdata_task_t simdata = xbt_new0(s_simdata_task_t, 1); + m_task_t task = xbt_new0(s_m_task_t, 1); + task->simdata = simdata; + + /* Task structure */ + task->name = xbt_strdup(name); + task->data = data; + + /* Simulator Data */ + simdata->computation_amount = 0; + simdata->message_size = 0; + simdata->compute = NULL; + simdata->comm = NULL; + simdata->rate = -1.0; + simdata->isused = 0; + simdata->sender = NULL; + simdata->receiver = NULL; + simdata->source = NULL; + + simdata->host_nb = host_nb; + simdata->host_list = xbt_new0(smx_host_t, host_nb); + simdata->comp_amount = computation_amount; + simdata->comm_amount = communication_amount; + + for (i = 0; i < host_nb; i++) + simdata->host_list[i] = host_list[i]->simdata->smx_host; + + return task; +} + +MSG_error_t MSG_parallel_task_execute(m_task_t task) +{ + simdata_task_t simdata = NULL; + e_smx_state_t comp_state; + m_process_t self = MSG_process_self(); + CHECK_HOST(); + simdata = task->simdata; + + xbt_assert0((!simdata->compute) + && (task->simdata->isused == 0), + "This task is executed somewhere else. Go fix your code!"); + + xbt_assert0(simdata->host_nb, + "This is not a parallel task. Go to hell."); + + DEBUG1("Parallel computing on %s", MSG_process_self()->simdata->m_host->name); + + simdata->isused=1; + + simdata->compute = + SIMIX_req_host_parallel_execute(task->name, simdata->host_nb, + simdata->host_list, + simdata->comp_amount, + simdata->comm_amount, 1.0, -1.0); + DEBUG1("Parallel execution action created: %p", simdata->compute); + + self->simdata->waiting_action = simdata->compute; + comp_state = SIMIX_req_host_execution_wait(simdata->compute); + self->simdata->waiting_action = NULL; + + DEBUG2("Finished waiting for execution of action %p, state = %d", simdata->compute, comp_state); + + simdata->isused=0; + + 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; + simdata->comm = NULL; + simdata->compute = NULL; + MSG_RETURN(MSG_OK); + } else if (SIMIX_req_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; + MSG_RETURN(MSG_HOST_FAILURE); + } else { + /* action ended, set comm and compute = NULL, the actions is already destroyed in the main function */ + simdata->comm = NULL; + simdata->compute = NULL; + MSG_RETURN(MSG_TASK_CANCELLED); + } } @@ -212,81 +224,56 @@ MSG_parallel_task_execute(m_task_t task) * * \param nb_sec a number of second */ -MSG_error_t -MSG_process_sleep(double nb_sec) -{ - smx_action_t act_sleep; - m_process_t proc = MSG_process_self(); - smx_mutex_t mutex; - smx_cond_t cond; - - /* create action to sleep */ - act_sleep = SIMIX_action_sleep(SIMIX_process_get_host(proc->simdata->s_process), nb_sec); - - mutex = SIMIX_mutex_init(); - SIMIX_mutex_lock(mutex); - - /* create conditional and register action to it */ - cond = SIMIX_cond_init(); - - SIMIX_register_action_to_condition(act_sleep, cond); - SIMIX_cond_wait(cond, mutex); - SIMIX_unregister_action_to_condition(act_sleep, cond); - SIMIX_mutex_unlock(mutex); - - /* remove variables */ - SIMIX_cond_destroy(cond); - SIMIX_mutex_destroy(mutex); - - if (SIMIX_action_get_state(act_sleep) == SURF_ACTION_DONE) - { - if (SIMIX_host_get_state(SIMIX_host_self()) == SURF_CPU_OFF) - { - SIMIX_action_destroy(act_sleep); - MSG_RETURN(MSG_HOST_FAILURE); - } - } - else - { - SIMIX_action_destroy(act_sleep); - MSG_RETURN(MSG_HOST_FAILURE); - } - - MSG_RETURN(MSG_OK); -} - -/** \ingroup msg_gos_functions - * \brief Return the number of MSG tasks currently running on - * the host of the current running process. - */ -static int -MSG_get_msgload(void) +MSG_error_t MSG_process_sleep(double nb_sec) { - xbt_die("not implemented yet"); - return 0; -} + e_smx_state_t state; + /*m_process_t proc = MSG_process_self();*/ + +#ifdef HAVE_TRACING + TRACE_msg_process_sleep_in(MSG_process_self()); +#endif + /* create action to sleep */ + state = SIMIX_req_process_sleep(nb_sec); + /*proc->simdata->waiting_action = act_sleep; + + FIXME: check if not setting the waiting_action breaks something on msg + + proc->simdata->waiting_action = NULL;*/ + + if (state == SIMIX_DONE) { +#ifdef HAVE_TRACING + TRACE_msg_process_sleep_out(MSG_process_self()); +#endif + MSG_RETURN(MSG_OK); + } else { +#ifdef HAVE_TRACING + TRACE_msg_process_sleep_out(MSG_process_self()); +#endif + MSG_RETURN(MSG_HOST_FAILURE); + } +} /** \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. + 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(). + 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 #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING - if \a *task is not equal to \c NULL, and #MSG_OK otherwise. + if \a *task is not equal to \c NULL, and #MSG_OK otherwise. */ -MSG_error_t +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); + return MSG_task_get_ext(task, channel, -1, host); } /** \ingroup msg_gos_functions @@ -294,19 +281,18 @@ MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host) * * 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. + 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(). + listening. This value has to be >=0 and < than the maximal + number of channels fixed with MSG_set_channel_number(). * \return #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING * if \a *task is not equal to \c NULL, and #MSG_OK otherwise. */ -MSG_error_t -MSG_task_get(m_task_t * task, m_channel_t channel) +MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel) { - return MSG_task_get_with_timeout(task, channel, -1); + return MSG_task_get_with_timeout(task, channel, -1); } /** \ingroup msg_gos_functions @@ -314,21 +300,22 @@ MSG_task_get(m_task_t * task, m_channel_t channel) * * 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. + 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(). + 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. + 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 #MSG_FATAL if \a task is equal to \c NULL, #MSG_WARNING - if \a *task is not equal to \c NULL, and #MSG_OK otherwise. + if \a *task is not equal to \c NULL, and #MSG_OK otherwise. */ -MSG_error_t -MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel, double max_duration) +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); } @@ -338,38 +325,420 @@ MSG_task_get_with_timeout(m_task_t * task, m_channel_t channel, double max_durat * 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) +MSG_error_t +MSG_task_get_ext(m_task_t * task, m_channel_t channel, double timeout, + m_host_t host) +{ + xbt_assert1((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) { - xbt_assert1((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); + return MSG_task_receive_ext(task, alias, -1, host); } -MSG_error_t -MSG_task_receive_from_host(m_task_t * task, const char* alias, m_host_t host) +MSG_error_t MSG_task_receive(m_task_t * task, const char *alias) { - return MSG_task_receive_ext(task, alias, -1, host); + return MSG_task_receive_with_timeout(task, alias, -1); } -MSG_error_t -MSG_task_receive(m_task_t * task, const char* alias) +MSG_error_t +MSG_task_receive_with_timeout(m_task_t * task, const char *alias, + double timeout) { - return MSG_task_receive_with_timeout(task, alias, -1); + return MSG_task_receive_ext(task, alias, timeout, NULL); } -MSG_error_t -MSG_task_receive_with_timeout(m_task_t * task, const char* alias, double timeout) +MSG_error_t +MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout, + m_host_t host) { - return MSG_task_receive_ext(task, alias, timeout, NULL); + DEBUG1 + ("MSG_task_receive_ext: Trying to receive a message on mailbox '%s'", + alias); + return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, + host, timeout); } -MSG_error_t -MSG_task_receive_ext(m_task_t* task, const char* alias, double timeout, m_host_t host) +/** \ingroup msg_gos_functions + * \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 #m_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(m_task_t task, const char *alias) { - return MSG_mailbox_get_task_ext(MSG_mailbox_get_by_alias(alias), task, host, timeout); + simdata_task_t t_simdata = NULL; + 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 */ + t_simdata = task->simdata; + t_simdata->sender = process; + t_simdata->source = MSG_host_self(); + + xbt_assert0(t_simdata->isused == 0, + "This task is still being used somewhere else. You cannot send it now. Go fix your code!"); + + t_simdata->isused = 1; + msg_global->sent_msg++; + + /* Send it by calling SIMIX network layer */ + msg_comm_t comm = xbt_new0(s_msg_comm_t, 1); + comm->task_sent = task; + comm->task_received = NULL; + comm->status = MSG_OK; + comm->s_comm = + SIMIX_req_comm_isend(mailbox, t_simdata->message_size, + t_simdata->rate, task, sizeof(void *), NULL, NULL, 0); + t_simdata->comm = comm->s_comm; /* FIXME: is the field t_simdata->comm still useful? */ + + return comm; } +/** \ingroup msg_gos_functions + * \brief Sends a task on a mailbox. + * + * This is a non blocking detached send function. + * Think of it as a best effort send. The communication + * object will be destroyed by the receiver (if any). + * + * \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) + */ +void MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup) +{ + simdata_task_t t_simdata = NULL; + 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 */ + t_simdata = task->simdata; + t_simdata->sender = process; + t_simdata->source = MSG_host_self(); + + xbt_assert0(t_simdata->isused == 0, + "This task is still being used somewhere else. You cannot send it now. Go fix your code!"); + + t_simdata->isused = 1; + msg_global->sent_msg++; + + /* Send it by calling SIMIX network layer */ + SIMIX_req_comm_isend(mailbox, t_simdata->message_size, + t_simdata->rate, task, sizeof(void *), NULL, cleanup, 1); +} + +/** \ingroup msg_gos_functions + * \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 name of the mailbox to receive the task on + * \return the msg_comm_t communication created + */ +msg_comm_t MSG_task_irecv(m_task_t *task, const char *alias) +{ + smx_rdv_t rdv = MSG_mailbox_get_by_alias(alias); + + CHECK_HOST(); + + /* FIXME: these functions are not tracable */ + + /* Sanity check */ + xbt_assert0(task, "Null pointer for the task storage"); + + if (*task) + CRITICAL0 + ("MSG_task_get() 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 = SIMIX_req_comm_irecv(rdv, task, NULL, NULL, NULL); + + return comm; +} + +/** \ingroup msg_gos_functions + * \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 = SIMIX_req_comm_test(comm->s_comm); + } + CATCH(e) { + switch (e.category) { + + case host_error: + comm->status = MSG_HOST_FAILURE; + finished = 1; + break; + + 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_gos_functions + * \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_action_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 = SIMIX_req_comm_testany(s_comms); + } + CATCH(e) { + switch (e.category) { + + case host_error: + finished_index = e.value; + status = MSG_HOST_FAILURE; + break; + + 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; + } + + return finished_index; +} + +/** \ingroup msg_gos_functions + * \brief Destroys a communication. + * \param comm the communication to destroy. + */ +void MSG_comm_destroy(msg_comm_t comm) +{ + if (comm->task_received != NULL + && *comm->task_received != NULL + && MSG_comm_get_status(comm) == MSG_OK) { + (*comm->task_received)->simdata->isused = 0; + } + + /* FIXME auto-destroy comms from SIMIX to avoid this request */ + SIMIX_req_comm_destroy(comm->s_comm); + free(comm); +} + +/** \ingroup msg_gos_functions + * \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 + * \return MSG_error_t + */ +MSG_error_t MSG_comm_wait(msg_comm_t comm, double timeout) +{ + xbt_ex_t e; + TRY { + SIMIX_req_comm_wait(comm->s_comm, timeout); + + if (comm->task_received != NULL) { + /* I am the receiver */ + (*comm->task_received)->simdata->isused = 0; + } + + /* FIXME: these functions are not traceable */ + } + CATCH(e) { + switch (e.category) { + case host_error: + comm->status = MSG_HOST_FAILURE; + break; + 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_gos_functions +* \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_gos_functions + * \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_action_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 = SIMIX_req_comm_waitany(s_comms); + } + CATCH(e) { + switch (e.category) { + + case host_error: + finished_index = e.value; + status = MSG_HOST_FAILURE; + break; + + 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_assert0(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; + + return finished_index; +} + +/** + * \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 + * during the communication + */ +MSG_error_t MSG_comm_get_status(msg_comm_t comm) { + + return comm->status; +} + +m_task_t MSG_comm_get_task(msg_comm_t comm) +{ + xbt_assert0(comm, "Invalid parameter"); + + return comm->task_received ? *comm->task_received : comm->task_sent; +} /** \ingroup msg_gos_functions * \brief Put a task on a channel of an host and waits for the end of the @@ -378,42 +747,42 @@ MSG_task_receive_ext(m_task_t* task, const char* alias, double timeout, m_host_t * This function is used for describing the behavior of an agent. It * takes three parameter. * \param task a #m_task_t to send on another location. This task - will not be usable anymore when the function will return. There is - no automatic task duplication and you have to save your parameters - before calling this function. Tasks are unique and once it has been - sent to another location, you should not access it anymore. You do - not need to call MSG_task_destroy() but to avoid using, as an - effect of inattention, this task anymore, you definitely should - renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task - can be transfered iff it has been correctly created with - MSG_task_create(). + will not be usable anymore when the function will return. There is + no automatic task duplication and you have to save your parameters + before calling this function. Tasks are unique and once it has been + sent to another location, you should not access it anymore. You do + not need to call MSG_task_destroy() but to avoid using, as an + effect of inattention, this task anymore, you definitely should + renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task + can be transfered iff it has been correctly created with + MSG_task_create(). * \param dest the destination of the message * \param channel the channel on which the agent should put this - task. This value has to be >=0 and < than the maximal number of - channels fixed with MSG_set_channel_number(). + task. This value has to be >=0 and < than the maximal number of + channels fixed with MSG_set_channel_number(). * \return #MSG_FATAL if \a task is not properly initialized and * #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which * this function was called was shut down. Returns * #MSG_TRANSFER_FAILURE if the transfer could not be properly done * (network failure, dest failure) */ -MSG_error_t -MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel) +MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, m_channel_t channel) { - return MSG_task_put_with_timeout(task, dest, channel, -1.0); + return MSG_task_put_with_timeout(task, dest, channel, -1.0); } /** \ingroup msg_gos_functions - * \brief Does exactly the same as MSG_task_put but with a bounded transmition + * \brief Does exactly the same as MSG_task_put but with a bounded transmition * rate. * * \sa MSG_task_put */ MSG_error_t -MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, double maxrate) +MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, + double maxrate) { - task->simdata->rate = maxrate; - return MSG_task_put(task, dest, channel); + task->simdata->rate = maxrate; + return MSG_task_put(task, dest, channel); } /** \ingroup msg_gos_functions \brief Put a task on a channel of an @@ -423,63 +792,70 @@ MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, double m * This function is used for describing the behavior of an agent. It * takes four parameter. * \param task a #m_task_t to send on another location. This task - will not be usable anymore when the function will return. There is - no automatic task duplication and you have to save your parameters - before calling this function. Tasks are unique and once it has been - sent to another location, you should not access it anymore. You do - not need to call MSG_task_destroy() but to avoid using, as an - effect of inattention, this task anymore, you definitely should - renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task - can be transfered iff it has been correctly created with - MSG_task_create(). + will not be usable anymore when the function will return. There is + no automatic task duplication and you have to save your parameters + before calling this function. Tasks are unique and once it has been + sent to another location, you should not access it anymore. You do + not need to call MSG_task_destroy() but to avoid using, as an + effect of inattention, this task anymore, you definitely should + renitialize it with #MSG_TASK_UNINITIALIZED. Note that this task + can be transfered iff it has been correctly created with + MSG_task_create(). * \param dest the destination of the message * \param channel the channel on which the agent should put this - task. This value has to be >=0 and < than the maximal number of - channels fixed with MSG_set_channel_number(). + task. This value has to be >=0 and < than the maximal number of + channels fixed with MSG_set_channel_number(). * \param timeout 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 + up. In such a case, #MSG_TRANSFER_FAILURE will be returned, \a task + will not be modified * \return #MSG_FATAL if \a task is not properly initialized and - #MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which - this function was called was shut down. Returns - #MSG_TRANSFER_FAILURE if the transfer could not be properly done - (network failure, dest failure, timeout...) +#MSG_OK otherwise. Returns #MSG_HOST_FAILURE if the host on which +this function was called was shut down. Returns +#MSG_TRANSFER_FAILURE if the transfer could not be properly done +(network failure, dest failure, timeout...) */ -MSG_error_t -MSG_task_put_with_timeout(m_task_t task, m_host_t dest, m_channel_t channel, double timeout) +MSG_error_t +MSG_task_put_with_timeout(m_task_t task, m_host_t dest, + m_channel_t channel, double timeout) { - xbt_assert1((channel >= 0) && (channel < msg_global->max_channel), "Invalid channel %d", channel); - - return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel(dest, channel), task, timeout); + xbt_assert1((channel >= 0) + && (channel < msg_global->max_channel), "Invalid channel %d", + channel); + + DEBUG1("MSG_task_put_with_timout: Trying to send a task to '%s'", dest->name); + return + MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_channel + (dest, channel), task, timeout); } -MSG_error_t -MSG_task_send(m_task_t task,const char* alias) +MSG_error_t MSG_task_send(m_task_t task, const char *alias) { - return MSG_task_send_with_timeout(task, alias, -1); + DEBUG1("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) +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); + task->simdata->rate = maxrate; + return MSG_task_send(task, alias); } - -MSG_error_t -MSG_task_send_with_timeout(m_task_t task, const char* alias, double timeout) + +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); + return MSG_mailbox_put_with_timeout(MSG_mailbox_get_by_alias(alias), + task, timeout); } -int -MSG_task_listen(const char* alias) +int MSG_task_listen(const char *alias) { - CHECK_HOST(); - - return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias)); + CHECK_HOST(); + + return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias)); } /** \ingroup msg_gos_functions @@ -487,50 +863,58 @@ MSG_task_listen(const char* alias) * * 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(). + 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 a pending communication and 0 otherwise */ -int -MSG_task_Iprobe(m_channel_t channel) +int MSG_task_Iprobe(m_channel_t channel) { - xbt_assert1((channel >= 0) && (channel < msg_global->max_channel), "Invalid channel %d", channel); - + xbt_assert1((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)); + + return + !MSG_mailbox_is_empty(MSG_mailbox_get_by_channel + (MSG_host_self(), channel)); } /** \ingroup msg_gos_functions * \brief Return the number of tasks waiting to be received on a \a - channel and sent by \a host. + channel and sent by \a host. * * It takes two parameters. * \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(). + 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 the number of tasks waiting to be received on \a channel - and sent by \a host. + and sent by \a host. */ -int -MSG_task_probe_from_host(int channel, m_host_t host) +int MSG_task_probe_from_host(int channel, m_host_t host) { - xbt_assert1((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),host); - + xbt_assert1((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), + host); + } -int -MSG_task_listen_from_host(const char* alias, m_host_t host) +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); + CHECK_HOST(); + + return + MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias + (alias), host); } /** \ingroup msg_gos_functions @@ -538,221 +922,38 @@ MSG_task_listen_from_host(const char* alias, m_host_t host) * * 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(). + 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) +int MSG_task_probe_from(m_channel_t channel) { - m_task_t task; + m_task_t task; - CHECK_HOST(); - - xbt_assert1((channel >= 0) && (channel < msg_global->max_channel), "Invalid channel %d", channel); + CHECK_HOST(); + + xbt_assert1((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; + 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); + return MSG_process_get_PID(task->simdata->sender); } -int -MSG_task_listen_from(const char* alias) +int MSG_task_listen_from(const char *alias) { - m_task_t task; + m_task_t task; - CHECK_HOST(); + CHECK_HOST(); - if(NULL == (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias)))) - return -1; + 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_process_get_PID(task->simdata->sender); } - -/** \ingroup msg_gos_functions - * \brief Wait for at most \a max_duration second for a task reception - on \a channel. - - * \a PID is updated with the PID of the first process that triggered this event if any. - * - * It takes three parameters: - * \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 PID a memory location for storing an int. - * \param timeout the maximum time to wait for a task before - giving up. In the case of a reception, *\a PID will be updated - with the PID of the first process to send a task. - * \return #MSG_HOST_FAILURE if the host is shut down in the meantime - and #MSG_OK otherwise. - */ -MSG_error_t -MSG_channel_select_from(m_channel_t channel,double timeout, int *PID) -{ - m_host_t h = NULL; - simdata_host_t h_simdata = NULL; - m_task_t t; - int first_time = 1; - smx_cond_t cond; - msg_mailbox_t mailbox; - - xbt_assert1((channel >= 0) && (channel < msg_global->max_channel), "Invalid channel %d",channel); - - if(PID) - { - *PID = -1; - } - - if (timeout == 0.0) - { - *PID = MSG_task_probe_from(channel); - MSG_RETURN(MSG_OK); - } - else - { - CHECK_HOST(); - h = MSG_host_self(); - h_simdata = h->simdata; - - mailbox = MSG_mailbox_get_by_channel(MSG_host_self(), channel); - - while(MSG_mailbox_is_empty(mailbox)) - { - if(timeout > 0) - { - if (!first_time) - { - MSG_RETURN(MSG_OK); - } - } - - SIMIX_mutex_lock(h_simdata->mutex); - - xbt_assert1(!MSG_mailbox_get_cond(mailbox),"A process is already blocked on this channel %d",channel); - - cond = SIMIX_cond_init(); - - MSG_mailbox_set_cond(mailbox, cond); - - if (timeout > 0) - { - SIMIX_cond_wait_timeout(cond, h_simdata->mutex, timeout); - } - else - { - SIMIX_cond_wait(cond, h_simdata->mutex); - } - - SIMIX_cond_destroy(cond); - SIMIX_mutex_unlock(h_simdata->mutex); - - if (SIMIX_host_get_state(h_simdata->smx_host) == 0) - { - MSG_RETURN(MSG_HOST_FAILURE); - } - - MSG_mailbox_set_cond(mailbox,NULL); - first_time = 0; - } - - if(NULL == (t = MSG_mailbox_get_head(mailbox))) - MSG_RETURN(MSG_OK); - - - if (PID) - { - *PID = MSG_process_get_PID(t->simdata->sender); - } - - MSG_RETURN(MSG_OK); - } -} - - -MSG_error_t -MSG_alias_select_from(const char* alias, double timeout, int* PID) -{ - m_host_t h = NULL; - simdata_host_t h_simdata = NULL; - m_task_t t; - int first_time = 1; - smx_cond_t cond; - msg_mailbox_t mailbox; - - if (PID) - { - *PID = -1; - } - - if(timeout == 0.0) - { - *PID = MSG_task_listen_from(alias); - MSG_RETURN(MSG_OK); - } - else - { - CHECK_HOST(); - h = MSG_host_self(); - h_simdata = h->simdata; - - DEBUG2("Probing on alias %s (%s)", alias, h->name); - - mailbox = MSG_mailbox_get_by_alias(alias); - - while(MSG_mailbox_is_empty(mailbox)) - { - if(timeout > 0) - { - if (!first_time) - { - MSG_RETURN(MSG_OK); - } - } - - SIMIX_mutex_lock(h_simdata->mutex); - - xbt_assert1(!MSG_mailbox_get_cond(mailbox),"A process is already blocked on this alias %s",alias); - - cond = SIMIX_cond_init(); - - MSG_mailbox_set_cond(mailbox, cond); - - if (timeout > 0) - { - SIMIX_cond_wait_timeout(cond, h_simdata->mutex, timeout); - } - else - { - SIMIX_cond_wait(cond, h_simdata->mutex); - } - - SIMIX_cond_destroy(cond); - SIMIX_mutex_unlock(h_simdata->mutex); - - if (SIMIX_host_get_state(h_simdata->smx_host) == 0) - { - MSG_RETURN(MSG_HOST_FAILURE); - } - - MSG_mailbox_set_cond(mailbox,NULL); - first_time = 0; - } - - if(NULL == (t = MSG_mailbox_get_head(mailbox))) - MSG_RETURN(MSG_OK); - - - if (PID) - { - *PID = MSG_process_get_PID(t->simdata->sender); - } - - MSG_RETURN(MSG_OK); - } -} - - - - -