X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/4a6b0a991a67e6f2f67c03fed43529e078da7115..f78e8f50ae6dc29c91974b032a68f81be9524a64:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index bd7f98280e..ee53c52c49 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -26,10 +26,10 @@ SG_BEGIN_DECL() * #MSG_task_send and friends) hide this object behind a string * alias. That mean that you don't provide the mailbox on which you * want to send your task, but only the name of this mailbox. */ -typedef struct s_smx_rvpoint *msg_mailbox_t; +typedef struct s_smx_mailbox *msg_mailbox_t; /* ******************************** Environment ************************************ */ -typedef surf_As *msg_as_t; +typedef simgrid_As *msg_as_t; /* ******************************** Host ************************************ */ @@ -130,26 +130,6 @@ static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){ return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL); } -/*************** Begin GPU ***************/ -typedef struct simdata_gpu_task *simdata_gpu_task_t; - -typedef struct msg_gpu_task { - char *name; /**< @brief task name if any */ - simdata_gpu_task_t simdata; /**< @brief simulator data */ - long long int counter; /* task unique identifier for instrumentation */ - char *category; /* task category for instrumentation */ -} s_msg_gpu_task_t; - -/** @brief GPU task datatype. - @ingroup m_task_management - - A task may then be defined by a computing - amount, a dispatch latency and a collect latency. - \see m_task_management -*/ -typedef struct msg_gpu_task *msg_gpu_task_t; -/*************** End GPU ***************/ - /** * \brief @brief Communication action. * \ingroup msg_task_usage @@ -284,12 +264,16 @@ XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host); XBT_PUBLIC(void) MSG_host_on(msg_host_t host); XBT_PUBLIC(void) MSG_host_off(msg_host_t host); XBT_PUBLIC(msg_host_t) MSG_host_self(void); -XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h); +XBT_PUBLIC(double) MSG_host_get_speed(msg_host_t h); XBT_PUBLIC(int) MSG_host_get_core_number(msg_host_t h); XBT_PUBLIC(xbt_swag_t) MSG_host_get_process_list(msg_host_t h); XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h); XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h); +// deprecated +XBT_PUBLIC(double) MSG_get_host_speed(msg_host_t h); + + XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate); XBT_PUBLIC(double) MSG_host_get_current_power_peak(msg_host_t h); XBT_PUBLIC(int) MSG_host_get_nb_pstates(msg_host_t h); @@ -378,10 +362,6 @@ XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process); XBT_PUBLIC(msg_task_t) MSG_task_create(const char *name, double flops_amount, double bytes_amount, void *data); -XBT_PUBLIC(msg_gpu_task_t) MSG_gpu_task_create(const char *name, - double flops_amount, - double dispatch_latency, - double collect_latency); XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name, int host_nb, const msg_host_t * host_list, @@ -437,20 +417,14 @@ XBT_PUBLIC(msg_error_t) MSG_task_receive_ext_bounded(msg_task_t * task, const char *alias, double timeout, msg_host_t host, double rate); -XBT_PUBLIC(msg_error_t) - MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, - double timeout, double rate); - -XBT_PUBLIC(msg_error_t) - MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate); +XBT_PUBLIC(msg_error_t) MSG_task_receive_with_timeout_bounded(msg_task_t * task, const char *alias, double timeout, double rate); +XBT_PUBLIC(msg_error_t) MSG_task_receive_bounded(msg_task_t * task, const char *alias,double rate); #define MSG_task_recv_bounded(t,a,r) MSG_task_receive_bounded(t,a,r) XBT_PUBLIC(msg_comm_t) MSG_task_isend(msg_task_t task, const char *alias); XBT_PUBLIC(msg_comm_t) MSG_task_isend_bounded(msg_task_t task, const char *alias, double maxrate); -XBT_PUBLIC(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); +XBT_PUBLIC(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); XBT_PUBLIC(void) MSG_task_dsend(msg_task_t task, const char *alias, void_f_pvoid_t cleanup); XBT_PUBLIC(void) MSG_task_dsend_bounded(msg_task_t task, const char *alias, void_f_pvoid_t cleanup, double maxrate); @@ -460,51 +434,62 @@ XBT_PUBLIC(int) MSG_comm_test(msg_comm_t comm); XBT_PUBLIC(int) MSG_comm_testany(xbt_dynar_t comms); XBT_PUBLIC(void) MSG_comm_destroy(msg_comm_t comm); XBT_PUBLIC(msg_error_t) MSG_comm_wait(msg_comm_t comm, double timeout); -XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, - double timeout); +XBT_PUBLIC(void) MSG_comm_waitall(msg_comm_t * comm, int nb_elem, double timeout); XBT_PUBLIC(int) MSG_comm_waitany(xbt_dynar_t comms); XBT_PUBLIC(msg_task_t) MSG_comm_get_task(msg_comm_t comm); XBT_PUBLIC(msg_error_t) MSG_comm_get_status(msg_comm_t comm); XBT_PUBLIC(int) MSG_task_listen(const char *alias); - -XBT_PUBLIC(int) MSG_task_listen_from_host(const char *alias, - msg_host_t host); - -XBT_PUBLIC(msg_error_t) - MSG_task_send_with_timeout(msg_task_t task, const char *alias, - double timeout); - -XBT_PUBLIC(msg_error_t) - MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, - double timeout, double maxrate); - -XBT_PUBLIC(msg_error_t) - MSG_task_send(msg_task_t task, const char *alias); - -XBT_PUBLIC(msg_error_t) - MSG_task_send_bounded(msg_task_t task, const char *alias, double rate); - +XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout(msg_task_t task, const char *alias, double timeout); +XBT_PUBLIC(msg_error_t) MSG_task_send_with_timeout_bounded(msg_task_t task, const char *alias, double timeout, double maxrate); +XBT_PUBLIC(msg_error_t) MSG_task_send(msg_task_t task, const char *alias); +XBT_PUBLIC(msg_error_t) MSG_task_send_bounded(msg_task_t task, const char *alias, double rate); XBT_PUBLIC(int) MSG_task_listen_from(const char *alias); - XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category); XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task); -/************************** Task handling ************************************/ -XBT_PUBLIC(msg_error_t) - MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task, - msg_host_t host, double timeout); +/************************** Mailbox handling ************************************/ +/* @brief MSG_mailbox_new - create a new mailbox. + * Creates a new mailbox identified by the key specified by the parameter alias and add it in the global dictionary. + * @param alias The alias of the mailbox to create. + * @return The newly created mailbox. + */ +XBT_PUBLIC(msg_mailbox_t) MSG_mailbox_new(const char *alias); -XBT_PUBLIC(msg_error_t) - MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task, - msg_host_t host, double timeout, double rate); +/* @brief MSG_mailbox_get_by_alias - get a mailbox from its alias. + * Returns the mailbox associated with the key specified by the parameter alias. If the mailbox does not exists, + * the function creates it. + * @param alias The alias of the mailbox to return. + * @return The mailbox associated with the alias specified as parameter or a new one if the key doesn't match. + */ +XBT_PUBLIC(msg_mailbox_t) MSG_mailbox_get_by_alias(const char *alias); -XBT_PUBLIC(msg_error_t) - MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task, - double timeout); +/* @brief MSG_mailbox_is_empty - test if a mailbox is empty. + * Tests if a mailbox is empty (contains no msg task). + * @param mailbox The mailbox to get test. + * @return 1 if the mailbox is empty, 0 otherwise. + */ +XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox); +/* @brief MSG_mailbox_set_async - set a mailbox as eager + * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send + * is issued, without waiting for the corresponding receive. + * This call should be done before issuing any receive, and on the receiver's side only + * @param alias The alias of the mailbox to modify. + */ XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias); +/* @brief MSG_mailbox_get_head - get the task at the head of a mailbox. + * Returns the task at the head of the mailbox. This function does not remove the task from the mailbox. + * @param mailbox The mailbox concerned by the operation. + * @return The task at the head of the mailbox. + */ +XBT_PUBLIC(msg_task_t) MSG_mailbox_get_head(msg_mailbox_t mailbox); + +XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task, msg_host_t host, + double timeout); +XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host, + double timeout, double rate); /************************** Action handling **********************************/ XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);