X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f04cb933da95f9df2da6d58a72a7b1da12582f7d..23a502252be475af7547139790b3f2310b3c9603:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 1df82a2f52..b3f49b091d 100644 --- a/include/simgrid/msg.h +++ b/include/simgrid/msg.h @@ -1,5 +1,4 @@ - -/* Copyright (c) 2004-2018. The SimGrid Team. All rights reserved. */ +/* Copyright (c) 2004-2019. 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. */ @@ -14,7 +13,9 @@ #include #include #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); @@ -115,14 +137,11 @@ 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; -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); - 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); @@ -158,15 +177,21 @@ 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. + * A process may be defined as a code with some private data. + * Processes must be located on hosts (#msg_host_t), and they exchange data by sending tasks (#msg_task_t) + * that are similar to envelops containing data. + * + * @hideinitializer + */ 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. +/** @brief Return a process from its PID (or NULL if not found). * - * Note that the PID are uniq in the whole simulation, not only on a given host. - * - * @returns NULL if no host is 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); @@ -192,7 +217,7 @@ XBT_PUBLIC void MSG_process_auto_restart_set(msg_process_t process, int auto_res 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. +/** @brief Wait for the completion of a process. * * @param process the process to wait for * @param timeout wait until the process is over, or the timeout occurs @@ -202,10 +227,18 @@ XBT_PUBLIC void MSG_process_join(msg_process_t process, double timeout); 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 */ +/** @brief 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 Sleep for the specified number of seconds */ +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. * @@ -217,46 +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 - @ingroup msg_simulation - @{ */ -/* 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 * @@ -267,20 +264,19 @@ typedef enum { * 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. +/** @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); @@ -316,6 +312,7 @@ XBT_PUBLIC double MSG_get_clock(); XBT_PUBLIC unsigned long int MSG_get_sent_msg(); /************************** Process handling *********************************/ +XBT_PUBLIC void MSG_process_userdata_init(); 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); @@ -327,20 +324,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); @@ -348,7 +338,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); @@ -362,8 +351,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_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); @@ -372,20 +359,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); @@ -430,15 +412,11 @@ XBT_PUBLIC const char* MSG_task_get_category(msg_task_t task); */ XBT_PUBLIC void MSG_mailbox_set_async(const char* alias); -/** @brief Opaque type representing a semaphore - * @ingroup msg_synchro - * @hideinitializer - */ -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 +/** @brief Opaque type representing a semaphore */ +typedef sg_sem_t msg_sem_t; 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 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); @@ -454,19 +432,8 @@ 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 -#ifdef __cplusplus -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