X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/93c7b4bd9208b45b5a5899abd1da65262431c33f..fdd8518c8e9ae4e42c5a8f4c465960832d85eeb2:/include/simgrid/msg.h diff --git a/include/simgrid/msg.h b/include/simgrid/msg.h index 87b46fcff9..97087ae715 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 @@ -44,6 +44,20 @@ typedef struct msg_Comm sg_msg_Comm; extern "C" { #endif +/** @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 ******************************** */ #define msg_as_t msg_netzone_t /* portability macro */ @@ -102,7 +116,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); @@ -167,11 +181,9 @@ 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); @@ -197,7 +209,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 @@ -207,10 +219,12 @@ 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); /** @brief Object representing an ongoing communication between processes. * @@ -245,20 +259,6 @@ 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 ! */ - 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 * @@ -363,8 +363,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); @@ -431,14 +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 - * @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); @@ -463,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