Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
added return value for MSG_sem_get_capacity
[simgrid.git] / src / msg / msg_synchro.cpp
1 /* Copyright (c) 2013-2014. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #include <xbt/ex.hpp>
8
9 #include "msg_private.h"
10 #include "xbt/sysdep.h"
11 #include "xbt/synchro_core.h"
12 #include "xbt/log.h"
13
14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(msg_synchro, msg, "Logging specific to MSG (synchro)");
15
16 /** @addtogroup msg_synchro
17  *
18  *  @{
19  */
20
21 /** @brief creates a semaphore object of the given initial capacity */
22 msg_sem_t MSG_sem_init(int initial_value) {
23   return simcall_sem_init(initial_value);
24 }
25
26 /** @brief locks on a semaphore object */
27 void MSG_sem_acquire(msg_sem_t sem) {
28   simcall_sem_acquire(sem);
29 }
30
31 /** @brief locks on a semaphore object up until the provided timeout expires */
32 msg_error_t MSG_sem_acquire_timeout(msg_sem_t sem, double timeout) {
33   msg_error_t res = MSG_OK;
34   try {
35     simcall_sem_acquire_timeout(sem,timeout);
36   } catch(xbt_ex& e) {
37     if (e.category == timeout_error)
38       return MSG_TIMEOUT;
39     throw;
40   }
41   return res;
42 }
43
44 /** @brief releases the semaphore object */
45 void MSG_sem_release(msg_sem_t sem) {
46   simcall_sem_release(sem);
47 }
48
49 int MSG_sem_get_capacity(msg_sem_t sem) {
50   return simcall_sem_get_capacity(sem);
51 }
52
53 void MSG_sem_destroy(msg_sem_t sem) {
54   SIMIX_sem_destroy(sem);
55 }
56
57 /** @brief returns a boolean indicating if this semaphore would block at this very specific time
58  *
59  * Note that the returned value may be wrong right after the function call, when you try to use it...
60  * But that's a classical semaphore issue, and SimGrid's semaphore are not different to usual ones here.
61  */
62 int MSG_sem_would_block(msg_sem_t sem) {
63   return simcall_sem_would_block(sem);
64 }
65
66 /** @brief Initializes a barrier, with count elements */
67 msg_bar_t MSG_barrier_init(unsigned int count) {
68    return (msg_bar_t)xbt_barrier_init(count);
69 }
70
71 /** @brief Initializes a barrier, with count elements */
72 void MSG_barrier_destroy(msg_bar_t bar) {
73   xbt_barrier_destroy((xbt_bar_t)bar);
74 }
75
76 /** @brief Performs a barrier already initialized */
77 int MSG_barrier_wait(msg_bar_t bar) {
78   if(xbt_barrier_wait((xbt_bar_t)bar) == XBT_BARRIER_SERIAL_PROCESS)
79     return MSG_BARRIER_SERIAL_PROCESS;
80   else
81     return 0;
82 }
83 /**@}*/