blob: ea1fe209dd783a23d39b889f596a6d566421db3c (
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
|
/**
* @file
*
* @ingroup RTEMSScoreAPIMutex
*
* @brief This header file provides the interfaces of the
* @ref RTEMSScoreAPIMutex.
*/
/*
* 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/thread.h>
#include <sys/lock.h>
/**
* @defgroup RTEMSScoreAPIMutex API Mutex Handler
*
* @ingroup RTEMSScore
*
* @brief This group contains the API Mutex Handler implementation.
*
* This handler provides routines to ensure mutual exclusion in a thread
* context at the API level.
*
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Control block used to manage each API mutex.
*/
typedef struct {
/**
* A recursive mutex.
*/
struct _Mutex_recursive_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 Statically initialize an API mutex.
*/
#define API_MUTEX_INITIALIZER( name ) \
{ _MUTEX_RECURSIVE_NAMED_INITIALIZER( name ), 0 }
/**
* @brief Acquires the specified API mutex.
*
* @param[in, out] mutex The API mutex to acquire.
*/
void _API_Mutex_Lock( API_Mutex_Control *mutex );
/**
* @brief Releases the specified API mutex.
*
* @param[in, out] mutex The API mutex to release.
*/
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 to check the owner from.
*/
bool _API_Mutex_Is_owner( const API_Mutex_Control *mutex );
/** @} */
/**
* @defgroup RTEMSScoreAllocatorMutex RTEMS Allocator Mutex
*
* @ingroup RTEMSScoreAPIMutex
*
* @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.
*
* @{
*/
void _RTEMS_Lock_allocator( void );
void _RTEMS_Unlock_allocator( void );
bool _RTEMS_Allocator_is_owner( void );
/** @} */
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
