X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/5089a0a98b27f5eeee62321dff4f025f1648f025..3dd753cd9e46d794e00629d03183250aec4a17e4:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index a29e549ed8..6267fb0e1d 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -1,4 +1,4 @@ -/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2022. 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. */ @@ -16,7 +16,7 @@ #include #include #include -#include +#include #include #include #include @@ -37,18 +37,11 @@ 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; +using sg_msg_Comm = simgrid::msg::Comm; +using sg_msg_Task = simgrid::msg::Task; #else typedef struct msg_Comm sg_msg_Comm; -typedef struct msg_Task* msg_task_t; +typedef struct msg_Task sg_msg_Task; #endif #ifdef __cplusplus @@ -73,12 +66,12 @@ typedef enum { 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 const char* MSG_zone_get_name(const_sg_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); +XBT_PUBLIC void MSG_zone_get_sons(const_sg_netzone_t zone, xbt_dict_t whereto); +XBT_PUBLIC const char* MSG_zone_get_property_value(const_sg_netzone_t zone, const char* name); +XBT_PUBLIC void MSG_zone_set_property_value(msg_netzone_t zone, const char* name, const char* value); +XBT_PUBLIC void MSG_zone_get_hosts(const_sg_netzone_t zone, xbt_dynar_t whereto); /* ******************************** Hosts ************************************ */ /** @brief Host datatype. @@ -96,48 +89,45 @@ XBT_PUBLIC sg_host_t MSG_host_by_name(const char* name); /** @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); +XBT_PUBLIC const char* MSG_host_get_name(const_sg_host_t host); /** @brief Returns the user data of this host */ -XBT_PUBLIC void* MSG_host_get_data(sg_host_t host); +XBT_PUBLIC void* MSG_host_get_data(const_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 double MSG_host_get_speed(const_sg_host_t host); +XBT_PUBLIC double MSG_host_get_power_peak_at(const_sg_host_t host, int pstate_index); +XBT_PUBLIC int MSG_host_get_core_number(const_sg_host_t host); +XBT_PUBLIC int MSG_host_get_nb_pstates(const_sg_host_t host); +XBT_PUBLIC int MSG_host_get_pstate(const_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() to test the current state of the host and @ref SURF_plugin_energy + * @beginrst + * See also :cpp:func:`MSG_host_is_on()` to test the current state of the host, and :ref:`plugin_host_energy` * for more info on DVFS. + * @endrst */ XBT_PUBLIC void MSG_host_on(sg_host_t h); /** @brief Stop the host if it is on * - * See also MSG_host_is_on() to test the current state of the host and @ref SURF_plugin_energy + * @beginrst + * See also :cpp:func:`MSG_host_is_on()` to test the current state of the host, and :ref:`plugin_host_energy` * for more info on DVFS. + * @endrst */ XBT_PUBLIC void MSG_host_off(sg_host_t h); -XBT_PUBLIC int MSG_host_is_on(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 int MSG_host_is_on(const_sg_host_t h); +XBT_PUBLIC xbt_dict_t MSG_host_get_properties(const_sg_host_t host); +XBT_PUBLIC const char* MSG_host_get_property_value(const_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 void MSG_host_get_process_list(const_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); +XBT_PUBLIC double MSG_host_get_load(const_sg_host_t host); /* ******************************** VMs ************************************* */ typedef sg_vm_t msg_vm_t; @@ -145,14 +135,14 @@ typedef sg_vm_t msg_vm_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); -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); +XBT_PUBLIC int MSG_vm_is_created(const_sg_vm_t vm); +XBT_PUBLIC int MSG_vm_is_running(const_sg_vm_t vm); +XBT_PUBLIC int MSG_vm_is_suspended(const_sg_vm_t vm); -XBT_PUBLIC const char* MSG_vm_get_name(msg_vm_t vm); +XBT_PUBLIC const char* MSG_vm_get_name(const_sg_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 size_t MSG_vm_get_ramsize(const_sg_vm_t vm); +XBT_PUBLIC msg_host_t MSG_vm_get_pm(const_sg_vm_t vm); XBT_PUBLIC void MSG_vm_set_bound(msg_vm_t vm, double bound); XBT_PUBLIC void MSG_vm_start(msg_vm_t vm); @@ -161,21 +151,6 @@ 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 ********************************* */ -typedef sg_storage_t msg_storage_t; - -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 *************************** */ /** Processes are independent agents that can do stuff on their own. * They are in charge of executing your code interacting with the simulated world. @@ -187,23 +162,23 @@ XBT_PUBLIC sg_size_t MSG_storage_write(msg_storage_t storage, sg_size_t size); */ 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 int MSG_process_get_PID(const_sg_actor_t process); +XBT_PUBLIC int MSG_process_get_PPID(const_sg_actor_t process); /** @brief Return a process from its PID (or NULL if not found). * * Note that the PID are unique in the whole simulation, not only on a given host. */ 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); +XBT_PUBLIC const char* MSG_process_get_name(const_sg_actor_t process); +XBT_PUBLIC sg_host_t MSG_process_get_host(const_sg_actor_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 xbt_dict_t MSG_process_get_properties(const_sg_actor_t process); +XBT_PUBLIC const char* MSG_process_get_property_value(const_sg_actor_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 int MSG_process_is_suspended(const_sg_actor_t process); XBT_PUBLIC void MSG_process_restart(msg_process_t process); /** @brief Sets the "auto-restart" flag of the process. * @@ -222,7 +197,7 @@ XBT_PUBLIC void MSG_process_migrate(msg_process_t process, msg_host_t host); * @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); +XBT_PUBLIC void MSG_process_join(const_sg_actor_t process, double timeout); /** @brief Kills a process */ XBT_PUBLIC void MSG_process_kill(msg_process_t process); /** @brief Kill all running process */ @@ -237,16 +212,27 @@ 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); +XBT_PUBLIC void MSG_process_ref(const_sg_actor_t process); +XBT_PUBLIC void MSG_process_unref(const_sg_actor_t process); /** @brief Object representing an ongoing communication between processes. * - * \rst + * @beginrst * Such beast is usually obtained by using :cpp:func:`MSG_task_isend`, :cpp:func:`MSG_task_irecv` or friends. - * \endrst + * @endrst */ typedef sg_msg_Comm* msg_comm_t; +typedef const sg_msg_Comm* const_msg_comm_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 sg_msg_Task* msg_task_t; +typedef const sg_msg_Task* const_msg_task_t; /* ******************************** Task ************************************ */ @@ -257,8 +243,10 @@ typedef sg_msg_Comm* msg_comm_t; /************************** Global ******************************************/ /** @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. + * @beginrst + * Do --help on any simgrid binary to see the list of currently existing configuration variables, and see Section + * :ref:`options`. + * @endrst * * Example: * MSG_config("host/model","ptask_L07"); @@ -289,7 +277,7 @@ XBT_PUBLIC msg_error_t MSG_main(); * @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); +XBT_PUBLIC void MSG_function_register(const char* name, int (*code)(int, char**)); /** @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 @@ -298,28 +286,22 @@ XBT_PUBLIC void MSG_function_register(const char* name, xbt_main_func_t code); * @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); +XBT_PUBLIC void MSG_function_register_default(int (*code)(int, char**)); /** @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); -#ifndef DOXYGEN -/** @brief register functions bypassing the parser */ -XBT_ATTRIB_DEPRECATED_v329("This function will be removed. Speak up if you need it.") XBT_PUBLIC - void MSG_set_function(const char* host_id, const char* function_name, xbt_dynar_t arguments); -#endif - /** @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(); /************************** 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, +XBT_PUBLIC msg_process_t MSG_process_create(const char* name, int (*code)(int, char**), void* data, msg_host_t host); +XBT_PUBLIC msg_process_t MSG_process_create_with_arguments(const char* name, int (*code)(int, char**), 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, +XBT_PUBLIC msg_process_t MSG_process_create_with_environment(const char* name, int (*code)(int, char**), void* data, msg_host_t host, int argc, char** argv, xbt_dict_t properties); @@ -327,10 +309,8 @@ 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 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 void* MSG_process_get_data(const_sg_actor_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_int_pvoid_t fun, void* data); @@ -339,11 +319,11 @@ XBT_PUBLIC void MSG_process_on_exit(int_f_int_pvoid_t fun, void* data); 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_get_data(const_msg_task_t task); XBT_PUBLIC void MSG_task_set_data(msg_task_t task, void* data); -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 msg_process_t MSG_task_get_sender(const_msg_task_t task); +XBT_PUBLIC msg_host_t MSG_task_get_source(const_msg_task_t task); +XBT_PUBLIC const char* MSG_task_get_name(const_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); @@ -355,12 +335,12 @@ 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 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 double MSG_task_get_flops_amount(const_msg_task_t task); +XBT_PUBLIC double MSG_task_get_remaining_work_ratio(const_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 double MSG_task_get_remaining_communication(const_msg_task_t task); +XBT_PUBLIC double MSG_task_get_bytes_amount(const_msg_task_t task); XBT_PUBLIC msg_error_t MSG_task_receive_with_timeout(msg_task_t* task, const char* alias, double timeout); @@ -380,13 +360,13 @@ XBT_PUBLIC void MSG_task_dsend_bounded(msg_task_t task, const char* alias, void_ 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 int MSG_comm_testany(const_xbt_dynar_t comms); +XBT_PUBLIC void MSG_comm_destroy(const_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_comm_waitany(const_xbt_dynar_t comms); +XBT_PUBLIC msg_task_t MSG_comm_get_task(const_msg_comm_t comm); +XBT_PUBLIC msg_error_t MSG_comm_get_status(const_msg_comm_t comm); /** @brief Check if there is a communication going on in a mailbox. * @@ -402,7 +382,7 @@ 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 const char* MSG_task_get_category(const_msg_task_t task); /************************** Mailbox handling ************************************/ @@ -421,16 +401,16 @@ XBT_PUBLIC msg_sem_t MSG_sem_init(int initial_value); XBT_PUBLIC void MSG_sem_acquire(msg_sem_t sem); XBT_PUBLIC int 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); +XBT_PUBLIC int MSG_sem_get_capacity(const_sg_sem_t sem); +XBT_PUBLIC void MSG_sem_destroy(const_sg_sem_t sem); +XBT_PUBLIC int MSG_sem_would_block(const_sg_sem_t sem); /** @brief Opaque type representing a barrier identifier */ typedef sg_bar_t msg_bar_t; /** @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); +XBT_PUBLIC void MSG_barrier_destroy(const_sg_bar_t bar); /** @brief Performs a barrier already initialized */ XBT_PUBLIC int MSG_barrier_wait(msg_bar_t bar);