X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/33f32ad6d4e98ec1cbc7eeed1723deee82d59764..edde8f7fbc1b74a81551bf9eb7bac1935b999296:/include/msg/msg.h diff --git a/include/msg/msg.h b/include/msg/msg.h index 9a3817c5e2..f30a1d1ce7 100644 --- a/include/msg/msg.h +++ b/include/msg/msg.h @@ -1,6 +1,5 @@ -/* $Id$ */ - -/* Copyright (c) 2002,2003,2004 Arnaud Legrand. 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. */ @@ -8,123 +7,248 @@ #ifndef MSG_H #define MSG_H -#include "xbt/misc.h" -#include "xbt/sysdep.h" +#include "xbt.h" -BEGIN_DECL() #include "msg/datatypes.h" +#include "xbt/automaton.h" + +SG_BEGIN_DECL() + /************************** Global ******************************************/ -xbt_error_t MSG_config(const char *name, ...); -void MSG_global_init(void); -void MSG_global_init_args(int *argc, char **argv); -void MSG_set_verbosity(MSG_outputmode_t mode); -MSG_error_t MSG_set_channel_number(int number); -MSG_error_t MSG_set_sharing_policy(MSG_sharing_t mode, double param); -int MSG_get_channel_number(void); -MSG_error_t MSG_main(void); -MSG_error_t MSG_clean(void); -void MSG_function_register(const char *name, m_process_code_t code); -m_process_code_t MSG_get_registered_function(const char *name); -void MSG_launch_application(const char *file); -void MSG_paje_output(const char *filename); - -double MSG_getClock(void); -double MSG_get_clock(void); +XBT_PUBLIC(void) MSG_config(const char *name, ...); +XBT_PUBLIC(void) MSG_global_init(int *argc, char **argv); +XBT_PUBLIC(void) MSG_global_init_args(int *argc, char **argv); +XBT_PUBLIC(MSG_error_t) MSG_set_channel_number(int number); +XBT_PUBLIC(int) MSG_get_channel_number(void); +XBT_PUBLIC(MSG_error_t) MSG_main(void); +XBT_PUBLIC(MSG_error_t) MSG_main_stateful(void); +XBT_PUBLIC(MSG_error_t) MSG_main_liveness_stateful(xbt_automaton_t a); +XBT_PUBLIC(MSG_error_t) MSG_main_liveness_stateless(xbt_automaton_t a, char *prgm); +XBT_PUBLIC(MSG_error_t) MSG_clean(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, + const char *function_name, + xbt_dynar_t arguments); + +XBT_PUBLIC(double) MSG_get_clock(void); +XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(void); + /************************** Host handling ***********************************/ -MSG_error_t MSG_host_set_data(m_host_t host, void *data); -void *MSG_host_get_data(m_host_t host); -const char *MSG_host_get_name(m_host_t host); -m_host_t MSG_host_self(void); -int MSG_get_host_msgload(m_host_t host); -int MSG_get_msgload(void); +XBT_PUBLIC(MSG_error_t) MSG_host_set_data(m_host_t host, void *data); +XBT_PUBLIC(void *) MSG_host_get_data(m_host_t host); +XBT_PUBLIC(const char *) MSG_host_get_name(m_host_t host); +XBT_PUBLIC(m_host_t) MSG_host_self(void); +XBT_PUBLIC(int) MSG_get_host_msgload(m_host_t host); +/* int MSG_get_msgload(void); This function lacks specification; discard it */ +XBT_PUBLIC(double) MSG_get_host_speed(m_host_t h); +XBT_PUBLIC(int) MSG_host_is_avail(m_host_t h); +XBT_PUBLIC(void) __MSG_host_destroy(m_host_t host); + +/*property handlers*/ +XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(m_host_t host); +XBT_PUBLIC(const char *) MSG_host_get_property_value(m_host_t host, + const char *name); + +XBT_PUBLIC(void) MSG_create_environment(const char *file); +XBT_PUBLIC(void) MSG_load_platform_script(const char *script_file); + +XBT_PUBLIC(m_host_t) MSG_get_host_by_name(const char *name); +XBT_PUBLIC(int) MSG_get_host_number(void); +XBT_PUBLIC(m_host_t *) MSG_get_host_table(void); -void MSG_create_environment(const char *file); +/************************** Process handling *********************************/ +XBT_PUBLIC(m_process_t) MSG_process_create(const char *name, + xbt_main_func_t code, + void *data, m_host_t host); +XBT_PUBLIC(m_process_t) MSG_process_create_with_arguments(const char *name, + xbt_main_func_t + code, void *data, + m_host_t host, + int argc, + char **argv); +XBT_PUBLIC(m_process_t) MSG_process_create_with_environment(const char + *name, + xbt_main_func_t + code, + void *data, + m_host_t host, + int argc, + char **argv, + xbt_dict_t + properties); +XBT_PUBLIC(void) MSG_process_kill(m_process_t process); +XBT_PUBLIC(int) MSG_process_killall(int reset_PIDs); + +XBT_PUBLIC(MSG_error_t) MSG_process_migrate(m_process_t process, m_host_t host); + +XBT_PUBLIC(void *) MSG_process_get_data(m_process_t process); +XBT_PUBLIC(MSG_error_t) MSG_process_set_data(m_process_t process, + void *data); +XBT_PUBLIC(m_host_t) MSG_process_get_host(m_process_t process); +XBT_PUBLIC(m_process_t) MSG_process_from_PID(int PID); +XBT_PUBLIC(int) MSG_process_get_PID(m_process_t process); +XBT_PUBLIC(int) MSG_process_get_PPID(m_process_t process); +XBT_PUBLIC(const char *) MSG_process_get_name(m_process_t process); +XBT_PUBLIC(int) MSG_process_self_PID(void); +XBT_PUBLIC(int) MSG_process_self_PPID(void); +XBT_PUBLIC(m_process_t) MSG_process_self(void); + +/*property handlers*/ +XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(m_process_t process); +XBT_PUBLIC(const char *) MSG_process_get_property_value(m_process_t + process, + const char *name); + +XBT_PUBLIC(MSG_error_t) MSG_process_suspend(m_process_t process); +XBT_PUBLIC(MSG_error_t) MSG_process_resume(m_process_t process); +XBT_PUBLIC(int) MSG_process_is_suspended(m_process_t process); -m_host_t MSG_get_host_by_name(const char *name); -int MSG_get_host_number(void); -m_host_t *MSG_get_host_table(void); +/************************** Task handling ************************************/ -/************************** Process handling *********************************/ -m_process_t MSG_process_create(const char *name, - m_process_code_t code, void *data, - m_host_t host); -m_process_t MSG_process_create_with_arguments(const char *name, - m_process_code_t code, void *data, - m_host_t host, int argc, char **argv); -void MSG_process_kill(m_process_t process); -int MSG_process_killall(int reset_PIDs); -MSG_error_t MSG_get_arguments(int *argc, char ***argv); -MSG_error_t MSG_set_arguments(m_process_t process,int argc, char *argv[]); - -MSG_error_t MSG_process_change_host(m_process_t process, m_host_t host); - -void *MSG_process_get_data(m_process_t process); -MSG_error_t MSG_process_set_data(m_process_t process, void *data); -m_host_t MSG_process_get_host(m_process_t process); -m_process_t MSG_process_from_PID(int PID); -int MSG_process_get_PID(m_process_t process); -int MSG_process_get_PPID(m_process_t process); -const char *MSG_process_get_name(m_process_t process); -int MSG_process_self_PID(void); -int MSG_process_self_PPID(void); -m_process_t MSG_process_self(void); - -MSG_error_t MSG_process_suspend(m_process_t process); -MSG_error_t MSG_process_resume(m_process_t process); -int MSG_process_isSuspended(m_process_t process); - -MSG_error_t MSG_process_start(m_process_t process); +XBT_PUBLIC(m_task_t) MSG_task_create(const char *name, + double compute_duration, + double message_size, void *data); +XBT_PUBLIC(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); +XBT_PUBLIC(void *) MSG_task_get_data(m_task_t task); +XBT_PUBLIC(void) MSG_task_set_data(m_task_t task, void *data); +XBT_PUBLIC(m_process_t) MSG_task_get_sender(m_task_t task); +XBT_PUBLIC(m_host_t) MSG_task_get_source(m_task_t task); +XBT_PUBLIC(const char *) MSG_task_get_name(m_task_t task); +XBT_PUBLIC(void) MSG_task_set_name(m_task_t task, const char *name); +XBT_PUBLIC(MSG_error_t) MSG_task_cancel(m_task_t task); +XBT_PUBLIC(MSG_error_t) MSG_task_destroy(m_task_t task); + +XBT_PUBLIC(MSG_error_t) MSG_task_get(m_task_t * task, m_channel_t channel); +XBT_PUBLIC(MSG_error_t) MSG_task_get_with_timeout(m_task_t * task, + m_channel_t channel, + double max_duration); +XBT_PUBLIC(MSG_error_t) MSG_task_get_from_host(m_task_t * task, + int channel, m_host_t host); +MSG_error_t MSG_task_receive_from_host(m_task_t * task, const char *alias, + m_host_t host); +XBT_PUBLIC(MSG_error_t) MSG_task_get_ext(m_task_t * task, int channel, + double max_duration, + m_host_t host); + + +XBT_PUBLIC(MSG_error_t) MSG_task_put(m_task_t task, m_host_t dest, + m_channel_t channel); +XBT_PUBLIC(MSG_error_t) MSG_task_put_bounded(m_task_t task, + m_host_t dest, + m_channel_t channel, + double max_rate); +XBT_PUBLIC(MSG_error_t) MSG_task_put_with_timeout(m_task_t task, + m_host_t dest, + m_channel_t channel, + double max_duration); +XBT_PUBLIC(MSG_error_t) MSG_task_execute(m_task_t task); +XBT_PUBLIC(MSG_error_t) MSG_parallel_task_execute(m_task_t task); +XBT_PUBLIC(void) MSG_task_set_priority(m_task_t task, double priority); + +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, m_host_t host); +XBT_PUBLIC(MSG_error_t) MSG_process_sleep(double nb_sec); + +XBT_PUBLIC(double) MSG_task_get_compute_duration(m_task_t task); +XBT_PUBLIC(void) MSG_task_set_compute_duration(m_task_t task, + double compute_duration); +XBT_PUBLIC(double) MSG_task_get_remaining_computation(m_task_t task); +XBT_PUBLIC(double) MSG_task_get_remaining_communication(m_task_t task); +XBT_PUBLIC(int) MSG_task_is_latency_bounded(m_task_t task); +XBT_PUBLIC(double) MSG_task_get_data_size(m_task_t task); + + +XBT_PUBLIC(MSG_error_t) + MSG_task_receive_ext(m_task_t * task, const char *alias, double timeout, + m_host_t host); + +XBT_PUBLIC(MSG_error_t) + MSG_task_receive_with_timeout(m_task_t * task, const char *alias, + double timeout); + +XBT_PUBLIC(MSG_error_t) + MSG_task_receive(m_task_t * task, const char *alias); +#define MSG_task_recv(t,a) MSG_task_receive(t,a) + +XBT_PUBLIC(msg_comm_t) MSG_task_isend(m_task_t task, const char *alias); +XBT_INLINE XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(m_task_t task, const char *alias, + int (*match_fun)(void*,void*), + void *match_data); + +XBT_PUBLIC(void) MSG_task_dsend(m_task_t task, const char *alias, void_f_pvoid_t cleanup); +XBT_PUBLIC(msg_comm_t) MSG_task_irecv(m_task_t * task, const char *alias); +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(int) MSG_comm_waitany(xbt_dynar_t comms); +XBT_PUBLIC(m_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, + m_host_t host); + +XBT_PUBLIC(MSG_error_t) + MSG_task_send_with_timeout(m_task_t task, const char *alias, + double timeout); + +XBT_PUBLIC(MSG_error_t) + MSG_task_send(m_task_t task, const char *alias); + +XBT_PUBLIC(MSG_error_t) + MSG_task_send_bounded(m_task_t task, const char *alias, double rate); + +XBT_PUBLIC(int) MSG_task_listen_from(const char *alias); /************************** Task handling ************************************/ +XBT_PUBLIC(MSG_error_t) + MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, m_task_t * task, + m_host_t host, double timeout); + +XBT_PUBLIC(MSG_error_t) + MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, m_task_t task, + double timeout); + +/************************** Action handling **********************************/ +typedef void (*msg_action_fun) (const char *const *args); +XBT_PUBLIC(void) MSG_action_register(const char *action_name, + msg_action_fun function); +XBT_PUBLIC(void) MSG_action_unregister(const char *action_name); +MSG_error_t MSG_action_trace_run(char *path); + +#ifdef MSG_USE_DEPRECATED +/* these are the functions which are deprecated. Do not use them, they may get removed in future releases */ +#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); +#endif + +#include "instr/instr.h" + +/* Used only by the bindings */ +#include "simix/simix.h" +XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(m_process_t process); -m_task_t MSG_task_create(const char *name, double compute_duration, - double message_size, void *data); -void *MSG_task_get_data(m_task_t task); -m_process_t MSG_task_get_sender(m_task_t task); -const char *MSG_task_get_name(m_task_t task); - -MSG_error_t MSG_task_destroy(m_task_t task); - -MSG_error_t MSG_task_get(m_task_t * task, m_channel_t channel); -MSG_error_t MSG_task_get_with_time_out(m_task_t * task, m_channel_t channel, - double max_duration); -MSG_error_t MSG_task_put(m_task_t task, m_host_t dest, - m_channel_t channel); -MSG_error_t MSG_task_put_bounded(m_task_t task, - m_host_t dest, m_channel_t channel, - double max_rate); -MSG_error_t MSG_task_execute(m_task_t task); -int MSG_task_Iprobe(m_channel_t channel); -int MSG_task_probe_from(m_channel_t channel); -MSG_error_t MSG_process_sleep(double nb_sec); -MSG_error_t MSG_get_errno(void); - -double MSG_task_get_compute_duration(m_task_t task); -double MSG_task_get_data_size(m_task_t task); - -/************************** Deprecated ***************************************/ -/* MSG_error_t MSG_routing_table_init(void); */ -/* MSG_error_t MSG_routing_table_set(m_host_t host1, m_host_t host2, */ -/* m_link_t link); */ -/* m_link_t MSG_routing_table_get(m_host_t host1, m_host_t host2); */ -/* m_host_t MSG_host_create(const char *name, */ -/* char *trace_file, */ -/* long double fixed_cpu, */ -/* char* failure_trace, */ -/* long double fixed_failure, */ -/* void *data); */ -/* m_host_t MSG_host_from_PID(int PID); */ -/* MSG_error_t MSG_host_destroy(m_host_t host); */ - -/* void MSG_link_set_sharing_value(long double alpha); */ -/* m_link_t MSG_link_create(const char *name, */ -/* char *lat_trace_file, long double fixed_latency, */ -/* char *bw_trace_file, long double fixed_bandwidth); */ -/* MSG_error_t MSG_link_destroy(m_link_t link); */ -/* m_link_t MSG_link_merge(const char *name, m_link_t src1, m_link_t src2); */ -/* m_link_t MSG_get_link_by_name(const char *name); */ -/* void MSG_tracelink(m_host_t dest, const char* **names, int *count); */ -END_DECL() +SG_END_DECL() #endif