X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/07ad10208f1c81a149c0737abd70b5a586f06eb0..cb1f41e17133f75d16ce09edee442cda1ae579b6:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 4cedf6e591..26de619874 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -13,6 +13,7 @@ #include #include #include +#include #include #include #include @@ -33,20 +34,42 @@ namespace simgrid { namespace msg { class Comm; +class Task; } } typedef simgrid::msg::Comm sg_msg_Comm; +/** @brief Task datatype. + * + * Since most scheduling algorithms rely on a concept of task that can be either computed locally or + * transferred on another processor, it seems to be the right level of abstraction for our purposes. + * A task may then be defined by a computing amount, a message size and + * some private data. + */ +typedef simgrid::msg::Task* msg_task_t; #else typedef struct msg_Comm sg_msg_Comm; +typedef struct msg_Task* msg_task_t; #endif #ifdef __cplusplus extern "C" { #endif -/* *************************** Network Zones ******************************** */ -#define msg_as_t msg_netzone_t /* portability macro */ +/** @brief Return code of most MSG functions */ +/* Keep these code as binary values: java bindings manipulate | of these values */ +typedef enum { + MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */ + MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */ + MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task + transfer. Either the network is down or the remote host has been + shutdown. */ + MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are + running has just been rebooted. Free your datastructures and + return now !*/ + MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/ +} msg_error_t; +/* *************************** Network Zones ******************************** */ typedef sg_netzone_t msg_netzone_t; XBT_PUBLIC msg_netzone_t MSG_zone_get_root(); @@ -96,18 +119,17 @@ XBT_PUBLIC int MSG_host_get_pstate(sg_host_t host); XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate); /** @brief Start the host if it is off * - * See also #MSG_host_is_on() and #MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy + * See also #MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy * for more info on DVFS. */ XBT_PUBLIC void MSG_host_on(sg_host_t h); /** @brief Stop the host if it is on * - * See also MSG_host_is_on() and MSG_host_is_off() to test the current state of the host and @ref SURF_plugin_energy + * See also MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy * for more info on DVFS. */ XBT_PUBLIC void MSG_host_off(sg_host_t h); XBT_PUBLIC int MSG_host_is_on(sg_host_t h); -XBT_PUBLIC int MSG_host_is_off(sg_host_t h); XBT_PUBLIC xbt_dict_t MSG_host_get_properties(sg_host_t host); XBT_PUBLIC const char* MSG_host_get_property_value(sg_host_t host, const char* name); XBT_PUBLIC void MSG_host_set_property_value(sg_host_t host, const char* name, const char* value); @@ -193,7 +215,7 @@ XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_res * SimGrid simulations run until all non-daemon processes are stopped. */ XBT_PUBLIC void MSG_process_daemonize(msg_process_t process); -/** @brief Imediately changes the host on which this process runs */ +/** @brief Immediately changes the host on which this process runs */ XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host); /** @brief Wait for the completion of a process. * @@ -210,7 +232,13 @@ XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_tim /** @brief Yield the current actor; let the other actors execute first */ XBT_PUBLIC void MSG_process_yield(); /*** @brief Sleep for the specified number of seconds */ -XBT_PUBLIC void MSG_process_sleep(double nb_sec); +XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec); +XBT_PUBLIC msg_process_t MSG_process_self(); +XBT_PUBLIC aid_t MSG_process_self_PID(); +XBT_PUBLIC aid_t MSG_process_self_PPID(); +XBT_PUBLIC const char* MSG_process_self_name(); +XBT_PUBLIC void MSG_process_ref(msg_process_t process); +XBT_PUBLIC void MSG_process_unref(msg_process_t process); /** @brief Object representing an ongoing communication between processes. * @@ -222,43 +250,10 @@ typedef sg_msg_Comm* msg_comm_t; /* ******************************** Task ************************************ */ -typedef struct s_simdata_task_t* simdata_task_t; - -typedef struct msg_task { - char* name; /**< @brief task name if any */ - simdata_task_t simdata; /**< @brief simulator data */ - void* data; /**< @brief user data */ - long long int counter; /* task unique identifier for instrumentation */ - char* category; /* task category for instrumentation */ -} s_msg_task_t; - -/** @brief Task datatype. - * - * Since most scheduling algorithms rely on a concept of task that can be either computed locally or - * transferred on another processor, it seems to be the right level of abstraction for our purposes. - * A task may then be defined by a computing amount, a message size and - * some private data. - */ - -typedef struct msg_task* msg_task_t; /** @brief Default value for an uninitialized #msg_task_t. */ #define MSG_TASK_UNINITIALIZED NULL -/** @brief Return code of most MSG functions */ -/* Keep these code as binary values: java bindings manipulate | of these values */ -typedef enum { - MSG_OK = 0, /**< @brief Everything is right. Keep on going this way ! */ - MSG_TIMEOUT = 1, /**< @brief nothing good happened before the timer you provided elapsed */ - MSG_TRANSFER_FAILURE = 2, /**< @brief There has been a problem during you task - transfer. Either the network is down or the remote host has been - shutdown. */ - MSG_HOST_FAILURE = 4, /**< @brief System shutdown. The host on which you are - running has just been rebooted. Free your datastructures and - return now !*/ - MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/ -} msg_error_t; - /************************** Global ******************************************/ /** @brief set a configuration variable * @@ -272,16 +267,16 @@ XBT_PUBLIC void MSG_config(const char* key, const char* value); /** @brief Initialize the MSG internal data. * @hideinitializer * - * It also check that the link-time and compile-time versions of SimGrid do + * It also checks that the link-time and compile-time versions of SimGrid do * match, so you should use this version instead of the #MSG_init_nocheck * function that does the same initializations, but without this check. * - * We allow to link against compiled versions that differ in the patch level. + * We allow linking 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); \ - MSG_init_nocheck(argc, argv); \ + MSG_init_nocheck((argc), (argv)); \ } while (0) XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv); @@ -328,20 +323,13 @@ XBT_PUBLIC msg_process_t MSG_process_attach(const char* name, void* data, msg_ho XBT_PUBLIC void MSG_process_detach(); XBT_PUBLIC void MSG_process_set_data_cleanup(void_f_pvoid_t data_cleanup); -XBT_PUBLIC int MSG_process_self_PID(); -XBT_PUBLIC int MSG_process_self_PPID(); -XBT_PUBLIC const char* MSG_process_self_name(); -XBT_PUBLIC msg_process_t MSG_process_self(); XBT_PUBLIC xbt_dynar_t MSG_processes_as_dynar(); XBT_PUBLIC int MSG_process_get_number(); XBT_PUBLIC void* MSG_process_get_data(msg_process_t process); XBT_PUBLIC msg_error_t MSG_process_set_data(msg_process_t process, void* data); -XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data); - -XBT_PUBLIC void MSG_process_ref(msg_process_t process); -XBT_PUBLIC void MSG_process_unref(msg_process_t process); +XBT_PUBLIC void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data); /************************** Task handling ************************************/ XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data); @@ -349,7 +337,6 @@ XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, co double* flops_amount, double* bytes_amount, void* data); XBT_PUBLIC void* MSG_task_get_data(msg_task_t task); XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data); -XBT_PUBLIC void MSG_task_set_copy_callback(void (*callback)(msg_task_t task, msg_process_t src, msg_process_t dst)); XBT_PUBLIC msg_process_t MSG_task_get_sender(msg_task_t task); XBT_PUBLIC msg_host_t MSG_task_get_source(msg_task_t task); XBT_PUBLIC const char* MSG_task_get_name(msg_task_t task); @@ -371,20 +358,15 @@ XBT_PUBLIC void MSG_task_set_bytes_amount(msg_task_t task, double bytes_amount); XBT_PUBLIC double MSG_task_get_remaining_communication(msg_task_t task); XBT_PUBLIC double MSG_task_get_bytes_amount(msg_task_t task); -XBT_PUBLIC msg_error_t MSG_task_receive_ext(msg_task_t* task, const char* alias, double timeout, msg_host_t host); - XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout); XBT_PUBLIC msg_error_t MSG_task_receive(msg_task_t* task, const char* alias); -#define MSG_task_recv(t,a) MSG_task_receive(t,a) - -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); +#define MSG_task_recv(t, a) MSG_task_receive((t), (a)) 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) +#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); @@ -441,7 +423,7 @@ XBT_PUBLIC int MSG_sem_would_block(msg_sem_t sem); /** @brief Opaque type representing a barrier identifier */ typedef sg_bar_t msg_bar_t; -/** @brief Initializes a barier, with count elements */ +/** @brief Initializes a barrier, with count elements */ XBT_PUBLIC msg_bar_t MSG_barrier_init(unsigned int count); /** @brief Destroys barrier */ XBT_PUBLIC void MSG_barrier_destroy(msg_bar_t bar); @@ -449,11 +431,6 @@ XBT_PUBLIC void MSG_barrier_destroy(msg_bar_t bar); XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar); /* ****************************************************************************************** */ -/* DO NOT USE this nasty pimple (unless if you're writing a binding) */ -XBT_PUBLIC smx_context_t -XBT_ATTRIB_DEPRECATED_v323("MSG_process_get_smx_ctx is deprecated. Please contact us if you need it.") -MSG_process_get_smx_ctx(msg_process_t process); - #ifdef __cplusplus } #endif