Blame view

RIOT/sys/posix/pthread/include/pthread_cond.h 5.38 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
  /*
   * Copyright (C) 2014 Hamburg University of Applied Sciences (HAW)
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @ingroup pthread
   * @{
   * @file
   * @brief       RIOT POSIX condition variable API
   * @author      Martin Landsmann <martin.landsmann@haw-hamburg.de>
   */
  
  #ifndef PTHREAD_COND_H
  #define PTHREAD_COND_H
  
  #include <time.h>
  #include "mutex.h"
  #include "priority_queue.h"
  
  #if defined(CPU_CC430) || defined(CPU_MSP430FXYZ)
  #   include "msp430_types.h"
  #endif
  
  #ifdef __MACH__
  /* needed for AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER */
  #include <AvailabilityMacros.h>
  #endif
  
  #if defined(__WITH_AVRLIBC__) || (defined(__MACH__) && !defined(AVAILABLE_MAC_OS_X_VERSION_10_12_AND_LATER))
  typedef int clockid_t;
  #endif
  
  #ifdef __cplusplus
  extern "C" {
  #endif
  
  /**
   * @note condition attributes are currently NOT USED in RIOT condition variables
   */
  typedef struct {
      /** dumdidum */
      int __dummy;
  } pthread_condattr_t;
  
  /**
   * @brief Condition variable
   *
   * @warning fields are managed by cv functions, don't touch
   */
  typedef struct {
      priority_queue_t queue; /**< Threads currently waiting to be signaled. */
  } pthread_cond_t;
  
  /**
   * @brief Initializes a condition attribute variable object using default values
   * @param[in, out] attr pre-allocated condition attribute variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_condattr_init(pthread_condattr_t *attr);
  
  /**
   * @brief Uninitializes a condition attribute variable object
   * @param[in, out] attr pre-allocated condition attribute variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_condattr_destroy(pthread_condattr_t *attr);
  
  /**
   * @brief Get the process-shared attribute in an initialized attributes object referenced by attr
   * @note NOT USED since RIOT is a single process OS
   * @param[in] attr pre-allocated condition attribute variable structure.
   * @param[out] pshared the pre-allocated process-shared variable.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_condattr_getpshared(const pthread_condattr_t *attr, int *pshared);
  
  /**
   * @brief Set the process-shared attribute in an initialized attributes object referenced by attr
   * @note NOT USED since RIOT is a single process OS
   * @param[in, out] attr pre-allocated condition attribute variable structure.
   * @param[in] pshared pshared the pre-allocated process-shared variable.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_condattr_setpshared(pthread_condattr_t *attr, int pshared);
  
  /**
   * @brief Get the clock selected for the conditon variable attribute attr.
   * @note currently NOT USED in RIOT.
   * @param[in] attr pre-allocated condition attribute variable structure.
   * @param[out] clock_id the clock ID that is used to measure the timeout service
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_condattr_getclock(const pthread_condattr_t *attr, clockid_t *clock_id);
  
  /**
   * @brief Set the clock selected for the conditon variable attribute ATTR.
   * @note currently NOT USED in RIOT.
   * @param[in, out] attr pre-allocated condition attribute variable structure.
   * @param[in] clock_id the clock ID that shall be used to measure the timeout service
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_condattr_setclock(pthread_condattr_t *attr, clockid_t clock_id);
  
  /**
   * @brief Initializes a condition variable object
   * @param[in, out] cond pre-allocated condition variable structure.
   * @param[in] attr pre-allocated condition attribute variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_init(pthread_cond_t *cond, pthread_condattr_t *attr);
  
  /**
   * @brief Destroy the condition variable cond
   * @param[in, out] cond pre-allocated condition variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_destroy(pthread_cond_t *cond);
  
  /**
   * @brief blocks the calling thread until the specified condition cond is signalled
   * @param[in, out] cond pre-allocated condition variable structure.
   * @param[in, out] mutex pre-allocated mutex variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_wait(pthread_cond_t *cond, mutex_t *mutex);
  
  /**
   * @brief blocks the calling thread until the specified condition cond is signalled
   * @param[in, out] cond pre-allocated condition variable structure.
   * @param[in, out] mutex pre-allocated mutex variable structure.
   * @param[in] abstime pre-allocated timeout.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_timedwait(pthread_cond_t *cond, mutex_t *mutex, const struct timespec *abstime);
  
  /**
   * @brief unblock at least one of the threads that are blocked on the specified condition variable cond
   * @param[in, out] cond pre-allocated condition variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_signal(pthread_cond_t *cond);
  
  /**
   * @brief unblock all threads that are currently blocked on the specified condition variable cond
   * @param[in, out] cond pre-allocated condition variable structure.
   * @return returns 0 on success, an errorcode otherwise.
   */
  int pthread_cond_broadcast(pthread_cond_t *cond);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* PTHREAD_COND_H */
  
  /**
   * @}
   */