X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/19a9b26d01348385d94fe24c9e452c5ec427ae20..a13889143f3dcc24f6100d07e9d20e710e74e0ad:/src/msg/msg_gos.c diff --git a/src/msg/msg_gos.c b/src/msg/msg_gos.c index 5008fd6f92..dc1a480c20 100644 --- a/src/msg/msg_gos.c +++ b/src/msg/msg_gos.c @@ -15,10 +15,9 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_gos, msg, /** \ingroup msg_gos_functions * \brief Executes a task and waits for its termination. * - * This function is used for describing the behavior of an agent. It + * This function is used for describing the behavior of a process. It * takes only one parameter. - * \param task a #m_task_t to execute on the location on which the - agent is running. + * \param task a #m_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 */ @@ -27,7 +26,6 @@ MSG_error_t MSG_task_execute(m_task_t task) simdata_task_t simdata = NULL; simdata_process_t p_simdata; e_smx_state_t comp_state; - CHECK_HOST(); simdata = task->simdata; @@ -156,7 +154,7 @@ MSG_parallel_task_create(const char *name, int host_nb, /** \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. + * \param task a #m_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 @@ -166,7 +164,6 @@ 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()); @@ -382,8 +379,6 @@ XBT_INLINE msg_comm_t MSG_task_isend_with_matching(m_task_t task, const char *al 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 */ @@ -434,8 +429,6 @@ 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(); - /* FIXME: these functions are not traceable */ /* Prepare the task to send */ @@ -470,8 +463,6 @@ msg_comm_t MSG_task_irecv(m_task_t *task, const char *name) { smx_rdv_t rdv = MSG_mailbox_get_by_alias(name); - CHECK_HOST(); - /* FIXME: these functions are not traceable */ /* Sanity check */ @@ -834,30 +825,29 @@ MSG_task_send_with_timeout(m_task_t task, const char *alias, } /** \ingroup msg_gos_functions - * \brief Look if there is a communication on a mailbox + * \brief Check if there is a communication going on in a mailbox. * - * \param alias the mailbox to listen - * \return return 1 if there is a communication or 0 + * \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) { - CHECK_HOST(); - return !MSG_mailbox_is_empty(MSG_mailbox_get_by_alias(alias)); } /** \ingroup msg_gos_functions - * \brief Look if there is a communication on a mailbox from - * a given host + * \brief Check the number of communication actions of a given host pending in a mailbox. * - * \param alias the mailbox to listen + * \param alias the name of the mailbox to be considered * \param host the host to check for communication - * \return return 1 if there is a communication or 0 + * + * \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) { - CHECK_HOST(); - return MSG_mailbox_get_count_host_waiting_tasks(MSG_mailbox_get_by_alias (alias), host); @@ -865,17 +855,17 @@ int MSG_task_listen_from_host(const char *alias, m_host_t host) /** \ingroup msg_gos_functions * \brief Look if there is a communication on a mailbox and return the - * PID from sender process + * PID of the sender process. + * + * \param alias the name of the mailbox to be considered * - * \param alias the mailbox to listen - * \return return the PID of process(or 0 in case of problem) + * \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; - CHECK_HOST(); - if (NULL == (task = MSG_mailbox_get_head(MSG_mailbox_get_by_alias(alias)))) return -1; @@ -883,8 +873,53 @@ int MSG_task_listen_from(const char *alias) return MSG_process_get_PID(task->simdata->sender); } -#ifdef MSG_USE_DEPRECATED /** \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...). @@ -894,11 +929,11 @@ MSG_error_t MSG_get_errno(void) return PROCESS_GET_ERRNO(); } -/** \ingroup msg_gos_functions +/** \ingroup msg_deprecated_functions * \brief Put a task on a channel of an host and waits for the end of the * transmission. * - * This function is used for describing the behavior of an agent. It + * This function is used for describing the behavior of a process. 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 @@ -911,7 +946,7 @@ MSG_error_t MSG_get_errno(void) 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 + * \param channel the channel on which the process should put this task. This value has to be >=0 and < than the maximal number of channels fixed with MSG_set_channel_number(). * \return #MSG_HOST_FAILURE if the host on which @@ -925,7 +960,7 @@ 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); } -/** \ingroup msg_gos_functions +/** \ingroup msg_deprecated_functions * \brief Does exactly the same as MSG_task_put but with a bounded transmition * rate. * @@ -940,11 +975,13 @@ MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, 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. * - * This function is used for describing the behavior of an agent. It + * This function is used for describing the behavior of a process. 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 @@ -957,7 +994,7 @@ MSG_task_put_bounded(m_task_t task, m_host_t dest, m_channel_t channel, 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 + * \param channel the channel on which the process should put this 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 @@ -983,11 +1020,11 @@ MSG_task_put_with_timeout(m_task_t task, m_host_t dest, (dest, channel), task, timeout); } -/** \ingroup msg_gos_functions +/** \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 + * \param channel the channel on which the process 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 @@ -997,8 +1034,6 @@ int MSG_task_probe_from(m_channel_t channel) XBT_WARN("DEPRECATED! Now use MSG_task_listen_from"); m_task_t task; - CHECK_HOST(); - xbt_assert((channel >= 0) && (channel < msg_global->max_channel), "Invalid channel %d", channel); @@ -1012,11 +1047,11 @@ int MSG_task_probe_from(m_channel_t channel) 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. - * \param channel the channel on which the agent should be + * \param channel the channel on which the process 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 a pending communication and 0 otherwise @@ -1028,20 +1063,18 @@ int MSG_task_Iprobe(m_channel_t channel) && (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. * * It takes two parameters. - * \param channel the channel on which the agent should be + * \param channel the channel on which the process 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. @@ -1055,8 +1088,6 @@ int MSG_task_probe_from_host(int channel, m_host_t host) && (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), @@ -1064,7 +1095,7 @@ int MSG_task_probe_from_host(int channel, m_host_t host) } -/** \ingroup msg_gos_functions +/** \ingroup msg_deprecated_functions * \brief Listen on \a channel and waits for receiving a task from \a host. * * It takes three parameters. @@ -1072,7 +1103,7 @@ int MSG_task_probe_from_host(int channel, m_host_t host) 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 + * \param channel the channel on which the process 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. @@ -1085,7 +1116,7 @@ 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 +/** \ingroup msg_deprecated_functions * \brief Listen on a channel and wait for receiving a task. * * It takes two parameters. @@ -1093,7 +1124,7 @@ MSG_task_get_from_host(m_task_t * task, m_channel_t channel, m_host_t host) 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 + * \param channel the channel on which the process 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. @@ -1104,7 +1135,7 @@ 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 +/** \ingroup msg_deprecated_functions * \brief Listen on a channel and wait for receiving a task with a timeout. * * It takes three parameters. @@ -1112,7 +1143,7 @@ MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel) 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 + * \param channel the channel on which the process 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