X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/bd7d5780ee8b73efd58c83f5d6f864d0a941b3ed..12783570914b603d99b5ffff1c92517592d07e62:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 7609aa42d0..c22f43367e 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -6,13 +6,23 @@ #ifndef SIMGRID_MSG_H #define SIMGRID_MSG_H +#include +#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 @@ -31,58 +41,114 @@ SG_BEGIN_DECL() /* *************************** 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; -/** @brief Host datatype. - @ingroup m_host_management +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); - 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. - */ +/* ******************************** Hosts ************************************ */ typedef sg_host_t msg_host_t; -XBT_PUBLIC_DATA int sg_storage_max_file_descriptors; -/* ******************************** Task ************************************ */ +XBT_PUBLIC size_t MSG_get_host_number(); +XBT_PUBLIC sg_host_t MSG_get_host_by_name(const char* name); +XBT_PUBLIC sg_host_t MSG_host_by_name(const char* name); + +XBT_PUBLIC xbt_dynar_t MSG_hosts_as_dynar(); + +XBT_PUBLIC const char* MSG_host_get_name(sg_host_t host); +XBT_PUBLIC void* MSG_host_get_data(sg_host_t 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); +XBT_PUBLIC void MSG_host_on(sg_host_t h); +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); + +XBT_PUBLIC sg_host_t MSG_host_self(); + +/* ******************************** VMs ************************************* */ +typedef sg_vm_t msg_vm_t; -typedef struct s_simdata_task_t* simdata_task_t; +XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: " + "v3.22 will drop MSG_vm_create() completely.") XBT_PUBLIC sg_vm_t + MSG_vm_create(sg_host_t ind_pm, const char* name, int coreAmount, int ramsize, int mig_netspeed, int dp_intensity); -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; +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); -/** @brief Task datatype. - @ingroup m_task_management +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); - 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 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); -/* ******************************** VM ************************************* */ -typedef sg_vm_t msg_vm_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); -/* ******************************** File ************************************ */ -typedef sg_file_t msg_file_t; +/* ******************************** Storage ********************************* */ +typedef sg_storage_t msg_storage_t; -/* ******************************** Storage ************************************ */ +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); +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); + +/*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); +XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_restart); +XBT_PUBLIC void MSG_process_daemonize(msg_process_t process); +XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host); +XBT_PUBLIC void MSG_process_join(msg_process_t process, double timeout); +XBT_PUBLIC void MSG_process_kill(msg_process_t process); +XBT_PUBLIC void MSG_process_killall(); +XBT_PUBLIC void MSG_process_set_kill_time(msg_process_t process, double kill_time); +XBT_PUBLIC void MSG_process_yield(); -/** @brief Storage datatype. - * @ingroup msg_storage_management - * - * You should consider this as an opaque object. - */ -typedef sg_storage_t msg_storage_t; /** * \brief @brief Communication action. @@ -92,24 +158,32 @@ typedef sg_storage_t msg_storage_t; */ 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 +/* ******************************** Task ************************************ */ -/* ****************************** Process *********************************** */ +typedef struct s_simdata_task_t* simdata_task_t; -/** @brief Process datatype. - @ingroup m_process_management +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; - A process may be defined as a code, with some - private data, executing in a location. +/** @brief Task datatype. + @ingroup m_task_management - You should not access directly to the fields of the pointed - structure, but always use the provided API to interact with - processes. + A task may then be defined by a computing + amount, a message size and some private + data. */ -typedef s4u_Actor* msg_process_t; + +typedef struct msg_task* msg_task_t; + +/** \brief Default value for an uninitialized #msg_task_t. + \ingroup m_task_management +*/ +#define MSG_TASK_UNINITIALIZED NULL /** @brief Return code of most MSG functions @ingroup msg_simulation @@ -149,6 +223,7 @@ 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_create_environment(const char* file); 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); @@ -156,52 +231,6 @@ XBT_PUBLIC void MSG_set_function(const char* host_id, const char* function_name, 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); - -/************************** Storage handling ***********************************/ -XBT_PUBLIC const char* sg_storage_get_name(sg_storage_t storage); -#define MSG_storage_get_name(storage) sg_storage_get_name(storage) -XBT_PUBLIC sg_storage_t sg_storage_get_by_name(const char* name); -#define MSG_storage_get_by_name(name) sg_storage_get_by_name(name) -XBT_PUBLIC xbt_dict_t sg_storage_get_properties(sg_storage_t storage); -#define MSG_storage_get_properties(storage) sg_storage_get_properties(storage) -XBT_PUBLIC void sg_storage_set_property_value(sg_storage_t storage, const char* name, char* value); -#define MSG_storage_set_property_value(storage, name, value) sg_storage_set_property_value(storage, name, value) -XBT_PUBLIC const char* sg_storage_get_property_value(sg_storage_t storage, const char* name); -#define MSG_storage_get_property_value(storage, name) sg_storage_get_property_value(storage, name) -XBT_PUBLIC xbt_dynar_t sg_storages_as_dynar(); -#define MSG_storages_as_dynar() sg_storages_as_dynar() -XBT_PUBLIC void sg_storage_set_data(sg_storage_t host, void* data); -#define MSG_storage_set_data(storage, data) sg_storage_set_data(storage, data) -XBT_PUBLIC void* sg_storage_get_data(sg_storage_t storage); -#define MSG_storage_get_data(storage) sg_storage_get_data(storage) -XBT_PUBLIC const char* sg_storage_get_host(sg_storage_t storage); -#define MSG_storage_get_host(storage) sg_storage_get_host(storage) -XBT_PUBLIC sg_size_t sg_storage_read(sg_storage_t storage, sg_size_t size); -#define MSG_storage_read(storage, size) sg_storage_read(storage, size) -XBT_PUBLIC sg_size_t sg_storage_write(sg_storage_t storage, sg_size_t size); -#define MSG_storage_write(storage, size) sg_storage_write(storage, size) - -/************************** Host handling ***********************************/ -XBT_PUBLIC void MSG_host_get_process_list(msg_host_t h, xbt_dynar_t whereto); - -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 void MSG_create_environment(const char* file); - /************************** 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, @@ -213,19 +242,7 @@ XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, x 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(); -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(); @@ -233,20 +250,11 @@ 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); - -/*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_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); @@ -270,7 +278,6 @@ XBT_PUBLIC msg_error_t MSG_parallel_task_execute_with_timeout(msg_task_t task, d 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); @@ -298,10 +305,6 @@ XBT_PUBLIC msg_error_t MSG_task_receive_bounded(msg_task_t* task, const char* al 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); @@ -336,11 +339,6 @@ XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task); */ 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(); - /** @brief Opaque type representing a semaphore * @ingroup msg_synchro * @hideinitializer @@ -366,63 +364,18 @@ 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 sg_vm_is_created(sg_vm_t vm); -#define MSG_vm_is_created(vm) sg_vm_is_created(vm) -XBT_PUBLIC int sg_vm_is_running(sg_vm_t vm); -#define MSG_vm_is_running(vm) sg_vm_is_running(vm) -XBT_PUBLIC int sg_vm_is_suspended(sg_vm_t vm); -#define MSG_vm_is_suspended(vm) sg_vm_is_suspended(vm) - -XBT_PUBLIC const char* sg_vm_get_name(sg_vm_t vm); -#define MSG_vm_get_name(vm) sg_vm_get_name(vm) -XBT_PUBLIC void sg_vm_set_ramsize(sg_vm_t vm, size_t size); -#define MSG_vm_set_ramsize(vm, size) sg_vm_set_ramsize(vm, size) -XBT_PUBLIC size_t sg_vm_get_ramsize(sg_vm_t vm); -#define MSG_vm_get_ramsize(vm) sg_vm_get_ramsize(vm) - -XBT_PUBLIC sg_vm_t sg_vm_create_core(sg_host_t pm, const char* name); -#define MSG_vm_create_core(vm, name) sg_vm_create_core(vm, name) -XBT_PUBLIC sg_vm_t sg_vm_create_multicore(sg_host_t pm, const char* name, int coreAmount); -#define MSG_vm_create_multicore(vm, name, coreAmount) sg_vm_create_multicore(vm, name, coreAmount) - -XBT_ATTRIB_DEPRECATED_v322("Use sg_vm_create_migratable() from the live migration plugin: " - "v3.22 will drop MSG_vm_create() completely.") 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 sg_vm_start(msg_vm_t vm); -#define MSG_vm_start(vm) sg_vm_start(vm) -XBT_PUBLIC void sg_vm_suspend(msg_vm_t vm); -#define MSG_vm_suspend(vm) sg_vm_suspend(vm) -XBT_PUBLIC void sg_vm_resume(msg_vm_t vm); -#define MSG_vm_resume(vm) sg_vm_resume(vm) -XBT_PUBLIC void sg_vm_shutdown(msg_vm_t vm); -#define MSG_vm_shutdown(vm) sg_vm_shutdown(vm) -XBT_PUBLIC void sg_vm_destroy(msg_vm_t vm); -#define MSG_vm_destroy(vm) sg_vm_destroy(vm) -XBT_PUBLIC sg_host_t sg_vm_get_pm(sg_vm_t vm); -#define MSG_vm_get_pm(vm) sg_vm_get_pm(vm) -XBT_PUBLIC void sg_vm_set_bound(sg_vm_t vm, double bound); -#define MSG_vm_set_bound(vm, bound) sg_vm_set_bound(vm, bound) - /* ****************************************************************************************** */ -/* 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 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); + std::unordered_map* properties); #endif #endif