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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/**
* @file
*
* @brief POSIX MUTEX Support
*
* This include file contains all the private support information for
* POSIX mutex's.
*/
/*
* COPYRIGHT (c) 1989-2011.
* On-Line Applications Research Corporation (OAR).
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* http://www.rtems.com/license/LICENSE.
*/
#ifndef _RTEMS_POSIX_MUTEX_H
#define _RTEMS_POSIX_MUTEX_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup POSIX_MUTEX POSIX Mutex Support
*
* @ingroup POSIXAPI
*
* @brief Private Support Information for POSIX Mutex
*
* @{
*/
#include <rtems/score/coremutex.h>
#include <pthread.h>
/*
* Data Structure used to manage a POSIX mutex
*/
typedef struct {
Objects_Control Object;
int process_shared;
CORE_mutex_Control Mutex;
} POSIX_Mutex_Control;
/*
* The following defines the information control block used to manage
* this class of objects.
*/
POSIX_EXTERN Objects_Information _POSIX_Mutex_Information;
/*
* The default mutex attributes structure.
*/
POSIX_EXTERN pthread_mutexattr_t _POSIX_Mutex_Default_attributes;
/*
* @brief POSIX Mutex Manager Initialization
*
* DESCRIPTION:
*
* This routine performs the initialization necessary for this manager.
*/
void _POSIX_Mutex_Manager_initialization(void);
/*
* _POSIX_Mutex_Allocate
*
* DESCRIPTION:
*
* This function allocates a mutexes control block from
* the inactive chain of free mutexes control blocks.
*/
RTEMS_INLINE_ROUTINE POSIX_Mutex_Control *_POSIX_Mutex_Allocate( void );
/*
* _POSIX_Mutex_Free
*
* DESCRIPTION:
*
* This routine frees a mutexes control block to the
* inactive chain of free mutexes control blocks.
*/
RTEMS_INLINE_ROUTINE void _POSIX_Mutex_Free (
POSIX_Mutex_Control *the_mutex
);
#if 0
/*
* _POSIX_Mutex_Get
*
* DESCRIPTION:
*
* This function maps mutexes IDs to mutexes control blocks.
* If ID corresponds to a local mutexes, then it returns
* the_mutex control pointer which maps to ID and location
* is set to OBJECTS_LOCAL. if the mutexes ID is global and
* resides on a remote node, then location is set to OBJECTS_REMOTE,
* and the_mutex is undefined. Otherwise, location is set
* to OBJECTS_ERROR and the_mutex is undefined.
*/
RTEMS_INLINE_ROUTINE POSIX_Mutex_Control *_POSIX_Mutex_Get (
Objects_Id *id,
Objects_Locations *location
);
/*
* _POSIX_Mutex_Is_null
*
* DESCRIPTION:
*
* This function returns TRUE if the_mutex is NULL and FALSE otherwise.
*/
RTEMS_INLINE_ROUTINE bool _POSIX_Mutex_Is_null (
POSIX_Mutex_Control *the_mutex
);
#endif
/*
* _POSIX_Mutex_Lock_support
*
* DESCRIPTION:
*
* A support routine which implements guts of the blocking, non-blocking, and
* timed wait version of mutex lock.
*/
int _POSIX_Mutex_Lock_support(
pthread_mutex_t *mutex,
bool blocking,
Watchdog_Interval timeout
);
/**
* @brief Convert core mutex status codes into the appropriate POSIX status
* values.
*
* DESCRIPTION:
*
* A support routine which converts core mutex status codes into the
* appropriate POSIX status values.
*
* @param[in] the_mutex_status is the mutex status code to translate
*
* @retval 0 Mutex status code indicates the operation completed successfully.
* @retval EBUSY Mutex status code indicates that the operation unable to
* complete immediately because the resource was unavailable.
* @retval EDEADLK Mutex status code indicates that an attempt was made to
* relock a mutex for which nesting is not configured.
* @retval EPERM Mutex status code indicates that an attempt was made to
* release a mutex by a thread other than the thread which locked it.
* @retval EINVAL Mutex status code indicates that the thread was blocked
* waiting for an operation to complete and the mutex was deleted.
* @retval ETIMEDOUT Mutex status code indicates that the calling task was
* willing to block but the operation was unable to complete within the time
* allotted because the resource never became available.
*/
int _POSIX_Mutex_Translate_core_mutex_return_code(
CORE_mutex_Status the_mutex_status
);
/*
* _POSIX_Mutex_Get
*
* DESCRIPTION:
*
* A support routine which translates the mutex id into a local pointer.
* As a side-effect, it may create the mutex.
*
* NOTE:
*
* This version of the method uses a dispatching critical section.
*/
POSIX_Mutex_Control *_POSIX_Mutex_Get (
pthread_mutex_t *mutex,
Objects_Locations *location
);
/*
* _POSIX_Mutex_Get
*
* DESCRIPTION:
*
* A support routine which translates the mutex id into a local pointer.
* As a side-effect, it may create the mutex.
*
* NOTE:
*
* This version of the method uses an interrupt critical section.
*/
POSIX_Mutex_Control *_POSIX_Mutex_Get_interrupt_disable (
pthread_mutex_t *mutex,
Objects_Locations *location,
ISR_Level *level
);
#include <rtems/posix/mutex.inl>
#ifdef __cplusplus
}
#endif
/** @} */
#endif
/* end of include file */
|
