blob: aa08481c8362b512b14f5bc867908fc9eb01951f (
plain) (
blame)
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
|
/**
* @file
*
* @ingroup ScoreAPIMutex
*
* @brief API Mutex Handler API
*/
/*
* COPYRIGHT (c) 1989-2008.
* 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.org/license/LICENSE.
*/
#ifndef _RTEMS_SCORE_APIMUTEX_H
#define _RTEMS_SCORE_APIMUTEX_H
#include <rtems/score/coremutex.h>
#include <rtems/score/object.h>
/**
* @defgroup ScoreAPIMutex API Mutex Handler
*
* @ingroup Score
*
* @brief Provides routines to ensure mutual exclusion on API level.
*/
/**@{**/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Control block used to manage each API mutex.
*/
typedef struct {
/**
* @brief Allows each API Mutex to be a full-fledged RTEMS object.
*/
Objects_Control Object;
/**
* Contains the SuperCore mutex information.
*/
CORE_recursive_mutex_Control Mutex;
/**
* @brief The thread life protection state before the outer-most mutex
* obtain.
*/
Thread_Life_state previous_thread_life_state;
} API_Mutex_Control;
/**
* @brief Initialization for the API Mutexe Handler.
*
* The value @a maximum_mutexes is the maximum number of API mutexes that may
* exist at any time.
*
* @param[in] maximum_mutexes is the maximum number of API mutexes.
*/
void _API_Mutex_Initialization( uint32_t maximum_mutexes );
/**
* @brief Allocates an API mutex from the inactive set and returns it in
* @a mutex.
*/
void _API_Mutex_Allocate( API_Mutex_Control **mutex );
/**
* @brief Acquires the specified API mutex.
*
* @param[in] mutex The API mutex.
*/
void _API_Mutex_Lock( API_Mutex_Control *mutex );
/**
* @brief Releases the specified API mutex.
*
* @param[in] mutex The API mutex.
*/
void _API_Mutex_Unlock( API_Mutex_Control *mutex );
/**
* @brief Checks if the specified API mutex is owned by the executing thread.
*
* @param[in] mutex The API mutex.
*/
bool _API_Mutex_Is_owner( const API_Mutex_Control *mutex );
/** @} */
/**
* @defgroup ScoreAllocatorMutex RTEMS Allocator Mutex
*
* @ingroup ScoreAPIMutex
*
* @brief Protection for all memory allocations and deallocations in RTEMS.
*
* When the APIs all use this for allocation and deallocation protection, then
* this possibly should be renamed and moved to a higher level in the
* hierarchy.
*/
/**@{**/
/**
* @brief Memory allocation mutex.
*
* This points to the API Mutex instance used to ensure that only
* one thread at a time is allocating or freeing memory.
*/
extern API_Mutex_Control *_RTEMS_Allocator_Mutex;
static inline void _RTEMS_Lock_allocator( void )
{
_API_Mutex_Lock( _RTEMS_Allocator_Mutex );
}
static inline void _RTEMS_Unlock_allocator( void )
{
_API_Mutex_Unlock( _RTEMS_Allocator_Mutex );
}
static inline bool _RTEMS_Allocator_is_owner( void )
{
return _API_Mutex_Is_owner( _RTEMS_Allocator_Mutex );
}
extern API_Mutex_Control *_Once_Mutex;
static inline void _Once_Lock( void )
{
_API_Mutex_Lock( _Once_Mutex );
}
static inline void _Once_Unlock( void )
{
_API_Mutex_Unlock( _Once_Mutex );
}
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
