X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/2c9cf2269d00dab91af16e3ab7ed2228e2047817..8f1ee3e1004fed6acef03da662a0590da900a7d8:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index a62ed6facb..b66155e335 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. */ @@ -15,6 +14,7 @@ #include #include #include +#include #include #include #include @@ -102,7 +102,7 @@ XBT_PUBLIC void MSG_host_set_pstate(sg_host_t host, int pstate); 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() 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); @@ -115,6 +115,7 @@ 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; @@ -154,15 +155,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. - * - * Note that the PID are uniq in the whole simulation, not only on a given host. +/** @brief Return a process from its PID (or NULL if not found). * - * @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); @@ -188,7 +195,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 @@ -198,7 +205,7 @@ 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(); @@ -260,8 +267,7 @@ 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 @@ -423,15 +429,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); @@ -456,10 +458,4 @@ MSG_process_get_smx_ctx(msg_process_t process); } #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