X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/65ba2d986262a9d812fe5def15cc49af1da2ac02..c52c503d21e54cc4ff15a64060c2eb0b265f5f73:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 52e382b14b..f66a3377ea 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -11,26 +11,11 @@ #include "xbt/lib.h" #include "simgrid/forward.h" #include "simgrid/simix.h" -#include "simgrid/platf.h" SG_BEGIN_DECL() -/* ******************************** Mailbox ************************************ */ - -/** @brief Mailbox datatype - * @ingroup msg_task_usage - * - * Object representing a communication rendez-vous point, on which - * the sender finds the receiver it wants to communicate with. As a - * MSG user, you will only rarely manipulate any of these objects - * directly, since most of the public interface (such as - * #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; - -/* ******************************** Environment ************************************ */ -typedef surf_As *msg_as_t; +/* ************************* Autonomous System ****************************** */ +typedef simgrid_As *msg_as_t; /* ******************************** Host ************************************ */ @@ -54,12 +39,10 @@ typedef struct s_msg_host_priv { xbt_dict_t affinity_mask_db; xbt_dynar_t file_descriptor_table; - -#ifdef MSG_USE_DEPRECATED - msg_mailbox_t *mailboxes; /**< the channels */ -#endif } s_msg_host_priv_t; +XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors; + /* ******************************** Task ************************************ */ typedef struct simdata_task *simdata_task_t; @@ -84,20 +67,17 @@ typedef struct msg_task *msg_task_t; /* ******************************** VM ************************************* */ typedef msg_host_t msg_vm_t; -/** ******************************** File ************************************ */ +/* ******************************** File ************************************ */ -/** @brief File datatype. -* @ingroup msg_file_management -* -* You should consider this as an opaque object. -*/ +/** @brief Opaque object describing a File in MSG. + * @ingroup msg_file */ typedef xbt_dictelm_t msg_file_t; typedef s_xbt_dictelm_t s_msg_file_t; extern int MSG_FILE_LEVEL; typedef struct simdata_file *simdata_file_t; -typedef struct msg_file_priv { +struct msg_file_priv { char *fullpath; sg_size_t size; char* mount_point; @@ -107,7 +87,9 @@ typedef struct msg_file_priv { int desc_id; void *data; simdata_file_t simdata; -} s_msg_file_priv_t, *msg_file_priv_t; +}; +typedef struct msg_file_priv s_msg_file_priv_t; +typedef struct msg_file_priv* msg_file_priv_t; static inline msg_file_priv_t MSG_file_priv(msg_file_t file){ return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL); @@ -126,35 +108,17 @@ extern int MSG_STORAGE_LEVEL; typedef xbt_dictelm_t msg_storage_t; typedef s_xbt_dictelm_t s_msg_storage_t; -typedef struct msg_storage_priv { +struct msg_storage_priv { const char *hostname; void *data; -} s_msg_storage_priv_t, *msg_storage_priv_t; +}; +typedef struct msg_storage_priv s_msg_storage_priv_t; +typedef struct msg_storage_priv* msg_storage_priv_t; 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 @@ -180,20 +144,7 @@ typedef struct msg_comm *msg_comm_t; structure, but always use the provided API to interact with processes. */ -typedef struct s_smx_process *msg_process_t; - -#ifdef MSG_USE_DEPRECATED - -/* Compatibility typedefs */ -typedef int m_channel_t; -typedef msg_gpu_task_t m_gpu_task_t; -typedef msg_host_t m_host_t; -typedef msg_process_t m_process_t; -typedef msg_task_t m_task_t; -typedef s_msg_gpu_task_t s_m_gpu_task_t; -typedef s_msg_host_t s_m_host_t; -typedef s_msg_task_t s_m_task_t; -#endif +typedef smx_process_t msg_process_t; /** @brief Return code of most MSG functions @ingroup msg_simulation @@ -225,7 +176,7 @@ XBT_PUBLIC(void) MSG_config(const char *key, const char *value); * We allow to link against compiled versions that differ in the patch level. */ #define MSG_init(argc,argv) do { \ - sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\ + sg_version_check(SIMGRID_VERSION_MAJOR,SIMGRID_VERSION_MINOR,SIMGRID_VERSION_PATCH);\ MSG_init_nocheck(argc,argv); \ } while (0) @@ -234,7 +185,6 @@ XBT_PUBLIC(msg_error_t) MSG_main(void); XBT_PUBLIC(void) MSG_function_register(const char *name, xbt_main_func_t code); XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code); -XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name); XBT_PUBLIC(void) MSG_launch_application(const char *file); /*Bypass the parser */ XBT_PUBLIC(void) MSG_set_function(const char *host_id, @@ -250,7 +200,6 @@ XBT_PUBLIC(const char *) MSG_environment_as_get_name(msg_as_t as); XBT_PUBLIC(msg_as_t) MSG_environment_as_get_by_name(const char * name); XBT_PUBLIC(xbt_dict_t) MSG_environment_as_get_routing_sons(msg_as_t as); XBT_PUBLIC(const char *) MSG_environment_as_get_property_value(msg_as_t as, const char *name); -XBT_PUBLIC(const char *) MSG_environment_as_get_model(msg_as_t as); XBT_PUBLIC(xbt_dynar_t) MSG_environment_as_get_hosts(msg_as_t as); /************************** File handling ***********************************/ @@ -303,12 +252,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); @@ -353,6 +306,11 @@ XBT_PUBLIC(msg_process_t) MSG_process_create_with_environment(const char char **argv, xbt_dict_t properties); +XBT_PUBLIC(msg_process_t) MSG_process_attach( + const char *name, void *data, + msg_host_t host, xbt_dict_t properties); +XBT_PUBLIC(void) MSG_process_detach(void); + XBT_PUBLIC(void) MSG_process_kill(msg_process_t process); XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs); XBT_PUBLIC(msg_error_t) MSG_process_migrate(msg_process_t process, msg_host_t host); @@ -392,10 +350,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, @@ -413,11 +367,6 @@ XBT_PUBLIC(void) MSG_task_set_name(msg_task_t task, const char *name); XBT_PUBLIC(msg_error_t) MSG_task_cancel(msg_task_t task); XBT_PUBLIC(msg_error_t) MSG_task_destroy(msg_task_t task); -XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host(msg_task_t * task, const char *alias, - msg_host_t host); -XBT_PUBLIC(msg_error_t) MSG_task_receive_from_host_bounded(msg_task_t * task, const char *alias, - msg_host_t host, double rate); - XBT_PUBLIC(msg_error_t) MSG_task_execute(msg_task_t task); XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task); XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority); @@ -456,20 +405,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); @@ -479,106 +422,35 @@ 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); - -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); - -XBT_PUBLIC(msg_error_t) - MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task, - double timeout); +/************************** Mailbox handling ************************************/ +/* @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); - /************************** Action handling **********************************/ XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path); XBT_PUBLIC(void) MSG_action_init(void); XBT_PUBLIC(void) MSG_action_exit(void); -#ifdef MSG_USE_DEPRECATED - -typedef msg_error_t MSG_error_t; - -#define MSG_global_init(argc, argv) MSG_init(argc,argv) -#define MSG_global_init_args(argc, argv) MSG_init(argc,argv) - -/* these are the functions which are deprecated. Do not use them, they may get removed in future releases */ -XBT_PUBLIC(msg_host_t *) MSG_get_host_table(void); - -#define MSG_host_is_avail(h) MSG_host_is_on(h) - -#define MSG_TIMEOUT_FAILURE MSG_TIMEOUT -#define MSG_TASK_CANCELLED MSG_TASK_CANCELED -#define MSG_mailbox_put_with_time_out(mailbox, task, timeout) \ - MSG_mailbox_put_with_timeout(mailbox, task, timeout) - -#define MSG_process_change_host(h) MSG_process_migrate(MSG_process_self(),h); -XBT_PUBLIC(msg_error_t) MSG_get_errno(void); - -XBT_PUBLIC(msg_error_t) MSG_clean(void); - -XBT_PUBLIC(msg_error_t) MSG_task_get(msg_task_t * task, m_channel_t channel); -XBT_PUBLIC(msg_error_t) MSG_task_get_with_timeout(msg_task_t * task, - m_channel_t channel, - double max_duration); -XBT_PUBLIC(msg_error_t) MSG_task_get_from_host(msg_task_t * task, - int channel, msg_host_t host); -XBT_PUBLIC(msg_error_t) MSG_task_get_ext(msg_task_t * task, int channel, - double max_duration, - msg_host_t host); -XBT_PUBLIC(msg_error_t) MSG_task_put(msg_task_t task, msg_host_t dest, - m_channel_t channel); -XBT_PUBLIC(msg_error_t) MSG_task_put_bounded(msg_task_t task, - msg_host_t dest, - m_channel_t channel, - double max_rate); -XBT_PUBLIC(msg_error_t) MSG_task_put_with_timeout(msg_task_t task, - msg_host_t dest, - m_channel_t channel, - double max_duration); -XBT_PUBLIC(int) MSG_task_Iprobe(m_channel_t channel); -XBT_PUBLIC(int) MSG_task_probe_from(m_channel_t channel); -XBT_PUBLIC(int) MSG_task_probe_from_host(int channel, msg_host_t host); - -XBT_PUBLIC(msg_error_t) MSG_set_channel_number(int number); -XBT_PUBLIC(int) MSG_get_channel_number(void); -#endif - /** @brief Opaque type representing a semaphore * @ingroup msg_synchro * @hideinitializer @@ -588,7 +460,7 @@ XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value); XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem); XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout); XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem); -XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem); +XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem); XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem); XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem); @@ -612,17 +484,17 @@ XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar); * */ -XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t); -XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t); -XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t); +XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm); +XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm); +XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm); -XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t); -XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t); -XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t); -XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t); +XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm); +XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t vm); +XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t vm); +XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t vm); -XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t); +XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm); // TODO add VDI later XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name); @@ -631,7 +503,7 @@ XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name, XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm); -XBT_PUBLIC(void) MSG_vm_start(msg_vm_t); +XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm); /* Shutdown the guest operating system. */ XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm); @@ -680,5 +552,10 @@ xbt_dynar_t MSG_vm_get_list_from_hosts(msg_dynar_t) /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */ XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process); + +/* Functions renamed in 3.14 */ +#define MSG_mailbox_get_head(m) MSG_mailbox_front(m) + + SG_END_DECL() #endif