X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b1cf006c096c7c723185f01183938a85b437e925..717bb82fd56727b8a066418eaa654290373736ea:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 068e469e54..7db7b0492b 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -1,22 +1,35 @@ -/* Copyright (c) 2004-2017. The SimGrid Team. All rights reserved. */ + +/* Copyright (c) 2004-2018. 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. */ -#ifndef MSG_H -#define MSG_H - -#include "simgrid/datatypes.h" -#include "simgrid/forward.h" -#include "simgrid/host.h" - -#include "xbt/base.h" -#include "xbt/dict.h" -#include "xbt/dynar.h" +#ifndef SIMGRID_MSG_H +#define SIMGRID_MSG_H + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#ifndef MIN +#define MIN(a, b) ((a) < (b) ? (a) : (b)) +#endif +#ifndef MAX +#define MAX(a, b) ((a) > (b) ? (a) : (b)) +#endif #ifdef __cplusplus -#include "simgrid/simix.h" #include +#include namespace simgrid { namespace msg { class Comm; @@ -27,94 +40,204 @@ typedef simgrid::msg::Comm sg_msg_Comm; typedef struct msg_Comm sg_msg_Comm; #endif -SG_BEGIN_DECL() +#ifdef __cplusplus +extern "C" { +#endif /* *************************** Network Zones ******************************** */ #define msg_as_t msg_netzone_t /* portability macro */ -typedef s4u_NetZone* msg_netzone_t; -/* ******************************** Host ************************************ */ +typedef sg_netzone_t msg_netzone_t; + +XBT_PUBLIC msg_netzone_t MSG_zone_get_root(); +XBT_PUBLIC const char* MSG_zone_get_name(msg_netzone_t zone); +XBT_PUBLIC msg_netzone_t MSG_zone_get_by_name(const char* name); +XBT_PUBLIC void MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto); +XBT_PUBLIC const char* MSG_zone_get_property_value(msg_netzone_t zone, const char* name); +XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, char* value); +XBT_PUBLIC void MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto); +/* ******************************** Hosts ************************************ */ /** @brief Host datatype. - @ingroup m_host_management - - A location (or host) is any possible place where - a process may run. Thus it is represented as a physical - resource with computing capabilities, some mailboxes - to enable running process to communicate with remote ones, and - some private data that can be only accessed by local - process. + * + * A location (or host) is any possible place where a process may run. Thus it is represented as a + * physical resource with computing capabilities, some mailboxes to enable running process to + * communicate with remote ones, and some private data that can be only accessed by local process. */ typedef sg_host_t msg_host_t; +/** @brief Finds a msg_host_t using its name. */ +XBT_PUBLIC sg_host_t MSG_get_host_by_name(const char* name); +/** @brief Finds a msg_host_t using its name. */ +XBT_PUBLIC sg_host_t MSG_host_by_name(const char* name); -XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors; -/* ******************************** 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 Returns the amount of host found in the platform */ +XBT_PUBLIC size_t MSG_get_host_number(); +/** @brief Returns a dynar with all existing hosts + * + * The host order in the returned array is generally different from the host creation/declaration order in the XML + * platform (we use a hash table internally). + */ +XBT_PUBLIC xbt_dynar_t MSG_hosts_as_dynar(); + +/** @brief Returns the name of this host */ +XBT_PUBLIC const char* MSG_host_get_name(sg_host_t host); +/** @brief Returns the user data of this host */ +XBT_PUBLIC void* MSG_host_get_data(sg_host_t host); +/** @brief Sets the user data of this host */ +XBT_PUBLIC void MSG_host_set_data(sg_host_t host, void* data); +XBT_PUBLIC xbt_dict_t MSG_host_get_mounted_storage_list(sg_host_t host); +XBT_PUBLIC xbt_dynar_t MSG_host_get_attached_storage_lists(sg_host_t host); +XBT_PUBLIC double MSG_host_get_speed(sg_host_t host); +XBT_PUBLIC double MSG_host_get_power_peak_at(sg_host_t host, int pstate_index); +XBT_PUBLIC int MSG_host_get_core_number(sg_host_t host); +XBT_PUBLIC int MSG_host_get_nb_pstates(sg_host_t host); +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 + * 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 + * 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); +XBT_PUBLIC void MSG_host_get_process_list(sg_host_t host, xbt_dynar_t whereto); + +/** @brief Return the location on which the current process is executed */ +XBT_PUBLIC sg_host_t MSG_host_self(); +XBT_PUBLIC double MSG_host_get_load(sg_host_t host); + +/* ******************************** VMs ************************************* */ +typedef sg_vm_t msg_vm_t; -/** @brief Task datatype. - @ingroup m_task_management +XBT_PUBLIC msg_vm_t MSG_vm_create_core(msg_host_t pm, const char* name); +XBT_PUBLIC msg_vm_t MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount); - A task may then be defined by a computing - amount, a message size and some private - data. - */ -typedef struct msg_task *msg_task_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_suspended(msg_vm_t vm); -/* ******************************** VM ************************************* */ -typedef sg_vm_t msg_vm_t; +XBT_PUBLIC const char* MSG_vm_get_name(msg_vm_t vm); +XBT_PUBLIC void MSG_vm_set_ramsize(msg_vm_t vm, size_t size); +XBT_PUBLIC size_t MSG_vm_get_ramsize(msg_vm_t vm); +XBT_PUBLIC msg_host_t MSG_vm_get_pm(msg_vm_t vm); +XBT_PUBLIC void MSG_vm_set_bound(msg_vm_t vm, double bound); -/* ******************************** File ************************************ */ -typedef sg_file_t msg_file_t; +XBT_PUBLIC void MSG_vm_start(msg_vm_t vm); +XBT_PUBLIC void MSG_vm_suspend(msg_vm_t vm); +XBT_PUBLIC void MSG_vm_resume(msg_vm_t vm); +XBT_PUBLIC void MSG_vm_shutdown(msg_vm_t vm); +XBT_PUBLIC void MSG_vm_destroy(msg_vm_t vm); -/* ******************************** Storage ************************************ */ +/* ******************************** Storage ********************************* */ +typedef sg_storage_t msg_storage_t; -/** @brief Storage datatype. - * @ingroup msg_storage_management +XBT_PUBLIC const char* MSG_storage_get_name(msg_storage_t storage); +XBT_PUBLIC msg_storage_t MSG_storage_get_by_name(const char* name); +XBT_PUBLIC xbt_dict_t MSG_storage_get_properties(msg_storage_t storage); +XBT_PUBLIC void MSG_storage_set_property_value(msg_storage_t storage, const char* name, const char* value); +XBT_PUBLIC const char* MSG_storage_get_property_value(msg_storage_t storage, const char* name); +XBT_PUBLIC xbt_dynar_t MSG_storages_as_dynar(); +XBT_PUBLIC void MSG_storage_set_data(msg_storage_t storage, void* data); +XBT_PUBLIC void* MSG_storage_get_data(msg_storage_t storage); +XBT_PUBLIC const char* MSG_storage_get_host(msg_storage_t storage); +XBT_PUBLIC sg_size_t MSG_storage_read(msg_storage_t storage, sg_size_t size); +XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size); + +/* ******************************** Actor/process *************************** */ +typedef sg_actor_t msg_process_t; + +XBT_PUBLIC int MSG_process_get_PID(msg_process_t process); +XBT_PUBLIC int MSG_process_get_PPID(msg_process_t process); +/** @brief Return a #msg_process_t from its PID. + * + * Note that the PID are uniq in the whole simulation, not only on a given host. * - * You should consider this as an opaque object. + * @returns NULL if no host is found */ -typedef sg_storage_t msg_storage_t; +XBT_PUBLIC sg_actor_t MSG_process_from_PID(int pid); +XBT_PUBLIC const char* MSG_process_get_name(msg_process_t process); +XBT_PUBLIC sg_host_t MSG_process_get_host(msg_process_t process); -/** - * \brief @brief Communication action. - * \ingroup msg_task_usage +/*property handlers*/ +XBT_PUBLIC xbt_dict_t MSG_process_get_properties(msg_process_t process); +XBT_PUBLIC const char* MSG_process_get_property_value(msg_process_t process, const char* name); + +XBT_PUBLIC void MSG_process_suspend(msg_process_t process); +XBT_PUBLIC void MSG_process_resume(msg_process_t process); +XBT_PUBLIC int MSG_process_is_suspended(msg_process_t process); +XBT_PUBLIC void MSG_process_restart(msg_process_t process); +/** @brief Sets the "auto-restart" flag of the process. + * + * If the flag is set, the process will be automatically restarted when its host comes back up. + */ +XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart); +/** @brief Indicates that this process should not prevent the simulation from ending + * + * 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 */ +XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host); +/** @brief Wait for the completion of a #msg_process_t. * - * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends. + * @param process the process to wait for + * @param timeout wait until the process is over, or the timeout occurs + */ +XBT_PUBLIC void MSG_process_join(msg_process_t process, double timeout); +/** @brief Kills a process */ +XBT_PUBLIC void MSG_process_kill(msg_process_t process); +/** @brief Kill all running process */ +XBT_PUBLIC void MSG_process_killall(); +/** @breif Specifies the time at which the process should be automatically killed */ +XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_time); +/** @brief Yield the current actor; let the other actors execute first */ +XBT_PUBLIC void MSG_process_yield(); + +/** @brief Object representing an ongoing communication between processes. + * + * \rst + * Such beast is usually obtained by using :cpp:func:`MSG_task_isend`, :cpp:func:`MSG_task_irecv` or friends. + * \endrst */ typedef sg_msg_Comm* msg_comm_t; -/** \brief Default value for an uninitialized #msg_task_t. - \ingroup m_task_management -*/ -#define MSG_TASK_UNINITIALIZED NULL - -/* ****************************** Process *********************************** */ +/* ******************************** Task ************************************ */ -/** @brief Process datatype. - @ingroup m_process_management +typedef struct s_simdata_task_t* simdata_task_t; - A process may be defined as a code, with some - private data, executing in a location. +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; - You should not access directly to the fields of the pointed - structure, but always use the provided API to interact with - processes. +/** @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 s4u_Actor* msg_process_t; -/** @brief Return code of most MSG functions - @ingroup msg_simulation - @{ */ +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 ! */ @@ -127,13 +250,20 @@ typedef enum { return now !*/ MSG_TASK_CANCELED = 8 /**< @brief Canceled task. This task has been canceled by somebody!*/ } msg_error_t; -/** @} */ /************************** Global ******************************************/ -XBT_PUBLIC(void) MSG_config(const char *key, const char *value); -/** \ingroup msg_simulation - * \brief Initialize the MSG internal data. - * \hideinitializer +/** @brief set a configuration variable + * + * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section @ref + * options. + * + * Example: + * MSG_config("host/model","ptask_L07"); + */ +XBT_PUBLIC void MSG_config(const char* key, const char* value); +/** @ingroup msg_simulation + * @brief Initialize the MSG internal data. + * @hideinitializer * * It also check that the link-time and compile-time versions of SimGrid do * match, so you should use this version instead of the #MSG_init_nocheck @@ -141,291 +271,158 @@ 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);\ - MSG_init_nocheck(argc,argv); \ +#define MSG_init(argc, argv) \ + do { \ + sg_version_check(SIMGRID_VERSION_MAJOR, SIMGRID_VERSION_MINOR, SIMGRID_VERSION_PATCH); \ + MSG_init_nocheck(argc, argv); \ } while (0) -XBT_PUBLIC(void) MSG_init_nocheck(int *argc, char **argv); -XBT_PUBLIC(msg_error_t) MSG_main();; -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(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(); -XBT_PUBLIC(unsigned long int) MSG_get_sent_msg(); - -/************************** Net Zones ***********************************/ -XBT_PUBLIC(msg_netzone_t) MSG_zone_get_root(); -XBT_PUBLIC(const char*) MSG_zone_get_name(msg_netzone_t zone); -XBT_PUBLIC(msg_netzone_t) MSG_zone_get_by_name(const char* name); -XBT_PUBLIC(void) MSG_zone_get_sons(msg_netzone_t zone, xbt_dict_t whereto); -XBT_PUBLIC(const char*) MSG_zone_get_property_value(msg_netzone_t as, const char* name); -XBT_PUBLIC(void) MSG_zone_set_property_value(msg_netzone_t netzone, const char* name, char* value); -XBT_PUBLIC(void) MSG_zone_get_hosts(msg_netzone_t zone, xbt_dynar_t whereto); - -XBT_ATTRIB_DEPRECATED_v319( - "Use MSG_zone_get_root() instead: v3.19 will turn this warning into an error.") static inline msg_netzone_t - MSG_environment_get_routing_root() -{ - return MSG_zone_get_root(); -} -XBT_ATTRIB_DEPRECATED_v319( - "Use MSG_zone_get_name() instead: v3.19 will turn this warning into an error.") static inline const - char* MSG_environment_as_get_name(msg_netzone_t zone) -{ - return MSG_zone_get_name(zone); -} -XBT_ATTRIB_DEPRECATED_v319( - "Use MSG_zone_get_by_name() instead: v3.19 will turn this warning into an error.") static inline msg_netzone_t - MSG_environment_as_get_by_name(const char* name) -{ - return MSG_zone_get_by_name(name); -} -XBT_ATTRIB_DEPRECATED_v319( - "Use MSG_zone_get_sons() instead: v3.19 will turn this warning into an error.") static inline xbt_dict_t - MSG_environment_as_get_routing_sons(msg_netzone_t zone) -{ - xbt_dict_t res = xbt_dict_new_homogeneous(NULL); - MSG_zone_get_sons(zone, res); - return res; -} -XBT_ATTRIB_DEPRECATED_v319( - "Use MSG_zone_get_property_value() instead: v3.19 will turn this warning into an error.") static inline const - char* MSG_environment_as_get_property_value(msg_netzone_t zone, const char* name) -{ - return MSG_zone_get_property_value(zone, name); -} -XBT_ATTRIB_DEPRECATED_v319( - "Use MSG_zone_set_property_value() instead: v3.19 will remove MSG_environment_as_set_property_value() " - "completely.") static inline void MSG_environment_as_set_property_value(msg_netzone_t zone, const char* name, - char* value) -{ - MSG_zone_set_property_value(zone, name, value); -} -XBT_ATTRIB_DEPRECATED_v319("Use MSG_zone_get_hosts() instead: v3.19 will remove MSG_environment_as_get_hosts() " - "completely.") static inline xbt_dynar_t MSG_environment_as_get_hosts(msg_netzone_t zone) -{ - xbt_dynar_t res = xbt_dynar_new(sizeof(sg_host_t), NULL); - MSG_zone_get_hosts(zone, res); - return res; -} - -/************************** Storage handling ***********************************/ -XBT_PUBLIC(const char *) MSG_storage_get_name(msg_storage_t storage); -XBT_PUBLIC(msg_storage_t) MSG_storage_get_by_name(const char *name); -XBT_PUBLIC(xbt_dict_t) MSG_storage_get_properties(msg_storage_t storage); -XBT_PUBLIC(void) MSG_storage_set_property_value(msg_storage_t storage, const char* name, char* value); -XBT_PUBLIC(const char *)MSG_storage_get_property_value(msg_storage_t storage, const char *name); -XBT_PUBLIC(xbt_dynar_t) MSG_storages_as_dynar(); -XBT_PUBLIC(msg_error_t) MSG_storage_set_data(msg_storage_t host, void *data); -XBT_PUBLIC(void *) MSG_storage_get_data(msg_storage_t storage); -XBT_PUBLIC(const char *) MSG_storage_get_host(msg_storage_t storage); -XBT_PUBLIC(sg_size_t) MSG_storage_read(msg_storage_t storage, sg_size_t size); -XBT_PUBLIC(sg_size_t) MSG_storage_write(msg_storage_t storage, sg_size_t size); - -/************************** Host handling ***********************************/ -XBT_PUBLIC(msg_host_t) MSG_host_by_name(const char *name); -#define MSG_get_host_by_name(n) MSG_host_by_name(n) /* Rewrite the old name into the new one transparently */ -XBT_PUBLIC(msg_error_t) MSG_host_set_data(msg_host_t host, void *data); -XBT_PUBLIC(void *) MSG_host_get_data(msg_host_t host); -/** \ingroup m_host_management +XBT_PUBLIC void MSG_init_nocheck(int* argc, char** argv); +/** @brief Launch the MSG simulation */ +XBT_PUBLIC msg_error_t MSG_main(); +/** @brief Registers the main function of a process in a global table. * - * \brief Return the name of the #msg_host_t. */ -#define MSG_host_get_name(host) sg_host_get_name(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(); -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(void) MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto); -XBT_PUBLIC(int) MSG_host_is_on(msg_host_t h); -XBT_PUBLIC(int) MSG_host_is_off(msg_host_t h); - -XBT_ATTRIB_DEPRECATED_v319("Use MSG_host_get_speed(): v3.19 will drop MSG_get_host_speed() " - "completely.") static inline double MSG_get_host_speed(msg_host_t host) -{ - return MSG_host_get_speed(host); -} -XBT_ATTRIB_DEPRECATED_v320("Use MSG_host_get_speed(): v3.20 will drop MSG_host_get_current_power_peak() " - "completely.") static inline double MSG_host_get_current_power_peak(msg_host_t host) -{ - return MSG_host_get_speed(host); -} - -XBT_PUBLIC(double) MSG_host_get_power_peak_at(msg_host_t h, int pstate); -XBT_PUBLIC(int) MSG_host_get_nb_pstates(msg_host_t h); -#define MSG_host_get_pstate(h) sg_host_get_pstate(h) /* users don't know that MSG is the C version of SimGrid */ -#define MSG_host_set_pstate(h, pstate) sg_host_set_pstate(h, pstate) /* (same here) */ -XBT_PUBLIC(xbt_dynar_t) MSG_hosts_as_dynar(); -XBT_PUBLIC(int) MSG_get_host_number(); -XBT_PUBLIC(xbt_dict_t) MSG_host_get_mounted_storage_list(msg_host_t host); -XBT_PUBLIC(xbt_dynar_t) MSG_host_get_attached_storage_list(msg_host_t host); + * This table is then used by #MSG_launch_application. + * @param name the reference name of the function. + * @param code the function (must have the same prototype than the main function of any C program: int ..(int argc, char + * *argv[])) + */ +XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code); +/** @brief Registers a code function as being the default value. + * + * This function will get used by MSG_launch_application() when there is no registered function of the requested name + * in. + * + * @param code the function (must have the same prototype than the main function of any C program: int ..(int argc, char + * *argv[])) + */ +XBT_PUBLIC void MSG_function_register_default(xbt_main_func_t code); +/** @brief Creates a new platform, including hosts, links and the routing_table */ +XBT_PUBLIC void MSG_create_environment(const char* file); +/** @brief Creates the application described in the provided file */ +XBT_PUBLIC void MSG_launch_application(const char* file); +/** @brief register functions bypassing the parser */ +XBT_PUBLIC void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments); + +/** @brief A clock (in second). */ +XBT_PUBLIC double MSG_get_clock(); +/** @brief Returns the amount of messages sent since the simulation start */ +XBT_PUBLIC unsigned long int MSG_get_sent_msg(); -/*property handlers*/ -XBT_PUBLIC(xbt_dict_t) MSG_host_get_properties(msg_host_t host); -XBT_PUBLIC(const char*) MSG_host_get_property_value(msg_host_t host, const char* name); -XBT_PUBLIC(void) MSG_host_set_property_value(msg_host_t host, const char* name, char* value); +/************************** Process handling *********************************/ +XBT_PUBLIC msg_process_t MSG_process_create(const char* name, xbt_main_func_t code, void* data, msg_host_t host); +XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, + msg_host_t host, int argc, char** argv); +XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, + msg_host_t host, int argc, char** argv, + xbt_dict_t properties); -XBT_PUBLIC(void) MSG_create_environment(const char *file); +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(); -/************************** Process handling *********************************/ -XBT_PUBLIC(msg_process_t) MSG_process_create(const char *name, - xbt_main_func_t code, - void *data, msg_host_t host); -XBT_PUBLIC(msg_process_t) -MSG_process_create_with_arguments(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc, - char** argv); -XBT_PUBLIC(msg_process_t) -MSG_process_create_with_environment(const char* name, xbt_main_func_t code, void* data, msg_host_t host, int argc, - 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(); - -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); -XBT_PUBLIC(void) MSG_process_yield(); - -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_set_data_cleanup(void_f_pvoid_t data_cleanup); -XBT_PUBLIC(msg_host_t) MSG_process_get_host(msg_process_t process); -XBT_PUBLIC(msg_process_t) MSG_process_from_PID(int PID); -XBT_PUBLIC(int) MSG_process_get_PID(msg_process_t process); -XBT_PUBLIC(int) MSG_process_get_PPID(msg_process_t process); -XBT_PUBLIC(const char *) MSG_process_get_name(msg_process_t process); -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(msg_error_t) MSG_process_set_kill_time(msg_process_t process, double kill_time); +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(); -/*property handlers*/ -XBT_PUBLIC(xbt_dict_t) MSG_process_get_properties(msg_process_t process); -XBT_PUBLIC(const char*) MSG_process_get_property_value(msg_process_t process, const char* name); +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(msg_error_t) MSG_process_suspend(msg_process_t process); -XBT_PUBLIC(msg_error_t) MSG_process_resume(msg_process_t process); -XBT_PUBLIC(int) MSG_process_is_suspended(msg_process_t process); -XBT_PUBLIC(void) MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void *data); -XBT_PUBLIC(void) MSG_process_auto_restart_set(msg_process_t process, int auto_restart); +XBT_PUBLIC void MSG_process_on_exit(int_f_pvoid_pvoid_t fun, void* data); -XBT_PUBLIC(void) MSG_process_daemonize(msg_process_t process); -XBT_PUBLIC(msg_process_t) MSG_process_restart(msg_process_t process); -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_ref(msg_process_t process); +XBT_PUBLIC void MSG_process_unref(msg_process_t process); /************************** Task handling ************************************/ -XBT_PUBLIC(msg_task_t) MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data); -XBT_PUBLIC(msg_task_t) MSG_parallel_task_create(const char *name, - int host_nb, - const msg_host_t * host_list, - 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); -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_execute(msg_task_t task); -XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute(msg_task_t task); -XBT_PUBLIC(msg_error_t) MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout); -XBT_PUBLIC(void) MSG_task_set_priority(msg_task_t task, double priority); -XBT_PUBLIC(void) MSG_task_set_bound(msg_task_t task, double bound); - -XBT_PUBLIC(msg_error_t) MSG_process_join(msg_process_t process, double timeout); -XBT_PUBLIC(msg_error_t) MSG_process_sleep(double nb_sec); - -XBT_PUBLIC(void) MSG_task_set_flops_amount(msg_task_t task, double flops_amount); -XBT_ATTRIB_DEPRECATED_v321("Use MSG_task_get_initial_flops_amount if you want to get initial amounts of flops, or " - "Use MSG_task_get_remaining_work_ratio to get task progress (in order " - "to compute progress in flops)") XBT_PUBLIC(double) - MSG_task_get_flops_amount(msg_task_t task); -XBT_PUBLIC(double) MSG_task_get_initial_flops_amount(msg_task_t task); -XBT_PUBLIC(double) MSG_task_get_remaining_work_ratio(msg_task_t task); -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(int) MSG_task_is_latency_bounded(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); +XBT_PUBLIC msg_task_t MSG_task_create(const char* name, double flops_amount, double bytes_amount, void* data); +XBT_PUBLIC msg_task_t MSG_parallel_task_create(const char* name, int host_nb, const msg_host_t* host_list, + 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); +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_execute(msg_task_t task); +XBT_PUBLIC msg_error_t MSG_parallel_task_execute(msg_task_t task); +XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, double timeout); +XBT_PUBLIC void MSG_task_set_priority(msg_task_t task, double priority); +XBT_PUBLIC void MSG_task_set_bound(msg_task_t task, double bound); + +XBT_PUBLIC msg_error_t MSG_process_sleep(double nb_sec); + +XBT_PUBLIC void MSG_task_set_flops_amount(msg_task_t task, double flops_amount); +XBT_PUBLIC double MSG_task_get_flops_amount(msg_task_t task); +XBT_PUBLIC double MSG_task_get_remaining_work_ratio(msg_task_t task); +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); +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_ATTRIB_DEPRECATED_v320( - "This function will be removed from SimGrid v3.20. If you really need this function, please speak up quickly.") - XBT_PUBLIC(msg_comm_t) MSG_task_isend_with_matching(msg_task_t task, const char* alias, - int (*match_fun)(void*, void*, void*), 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); -XBT_PUBLIC(msg_comm_t) MSG_task_irecv(msg_task_t * task, const char *alias); -XBT_PUBLIC(msg_comm_t) MSG_task_irecv_bounded(msg_task_t * task, const char *alias, double rate); -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(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(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); +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 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); +XBT_PUBLIC msg_comm_t MSG_task_irecv(msg_task_t* task, const char* alias); +XBT_PUBLIC msg_comm_t MSG_task_irecv_bounded(msg_task_t* task, const char* alias, double rate); +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 msg_task_t MSG_comm_get_task(msg_comm_t comm); +XBT_PUBLIC msg_error_t MSG_comm_get_status(msg_comm_t comm); + +/** @brief Check if there is a communication going on in a mailbox. + * + * @param alias the name of the mailbox to be considered + * + * @return Returns 1 if there is a communication, 0 otherwise + */ +XBT_PUBLIC int MSG_task_listen(const char* alias); +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); /************************** 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. +/* @brief set a mailbox in eager mode. + * All messages sent to this mailbox will be transferred to the receiver without waiting for the receive call. + * The receive call will still be necessary to use the received data. + * If there is a need to receive some messages asynchronously, and some not, two different mailboxes should be used. + * * 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(); -XBT_PUBLIC(void) MSG_action_exit(); +XBT_PUBLIC void MSG_mailbox_set_async(const char* alias); /** @brief Opaque type representing a semaphore * @ingroup msg_synchro @@ -433,77 +430,37 @@ XBT_PUBLIC(void) MSG_action_exit(); */ typedef struct s_smx_sem_t* msg_sem_t; // Yeah that's a rename of the smx_sem_t which doesnt require smx_sem_t to be // declared here -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(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); - -/** @brief Opaque type representing a barrier identifier - * @ingroup msg_synchro - * @hideinitializer - */ - -#define MSG_BARRIER_SERIAL_PROCESS -1 -typedef struct s_msg_bar_t* msg_bar_t; -XBT_PUBLIC(msg_bar_t) MSG_barrier_init( unsigned int count); -XBT_PUBLIC(void) MSG_barrier_destroy(msg_bar_t bar); -XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar); - -/** @brief Opaque type describing a Virtual Machine. - * @ingroup msg_VMs - * - * All this is highly experimental and the interface will probably change in the future. - * Please don't depend on this yet (although testing is welcomed if you feel so). - * Usual lack of guaranty of any kind applies here, and is even increased. - * - */ - -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 vm); - -XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm); -XBT_PUBLIC(void) MSG_vm_get_params(msg_vm_t vm, vm_params_t params); -XBT_PUBLIC(void) MSG_vm_set_params(msg_vm_t vm, vm_params_t params); - -// TODO add VDI later -XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name); -XBT_PUBLIC(msg_vm_t) MSG_vm_create_multicore(msg_host_t pm, const char* name, int coreAmount); -XBT_PUBLIC(msg_vm_t) -MSG_vm_create(msg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity); - -XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm); - -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); - -XBT_PUBLIC(void) MSG_vm_migrate(msg_vm_t vm, msg_host_t destination); - -/* Suspend the execution of the VM, but keep its state on memory. */ -XBT_PUBLIC(void) MSG_vm_suspend(msg_vm_t vm); -XBT_PUBLIC(void) MSG_vm_resume(msg_vm_t vm); - -XBT_PUBLIC(msg_host_t) MSG_vm_get_pm(msg_vm_t vm); -XBT_PUBLIC(void) MSG_vm_set_bound(msg_vm_t vm, double bound); - -#include "simgrid/instr.h" +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 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); + +/** @brief Opaque type representing a barrier identifier */ +typedef sg_bar_t msg_bar_t; +/** @brief Initializes a barier, 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); +/** @brief Performs a barrier already initialized */ +XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar); /* ****************************************************************************************** */ -/* 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); +/* 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); -SG_END_DECL() +#ifdef __cplusplus +} +#endif #ifdef __cplusplus -XBT_PUBLIC(msg_process_t) -MSG_process_create_from_stdfunc(const char* name, std::function code, void* data, msg_host_t host, - std::map* properties); +XBT_PUBLIC msg_process_t MSG_process_create_from_stdfunc(std::string name, std::function code, void* data, + msg_host_t host, + std::unordered_map* properties); #endif #endif