summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/semimpl.h
blob: c84c3d2a76487795c5e97e88a39d40f2d36133f0 (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
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
/**
 * @file
 *
 * @ingroup RTEMSImplClassicSemaphore
 *
 * @brief Classic Semaphore Manager Implementation
 */

/*  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_RTEMS_SEMIMPL_H
#define _RTEMS_RTEMS_SEMIMPL_H

#include <rtems/rtems/semdata.h>
#include <rtems/score/coremuteximpl.h>
#include <rtems/score/coresemimpl.h>
#include <rtems/score/mrspimpl.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @defgroup RTEMSImplClassicSemaphore Semaphore Manager
 *
 * @ingroup RTEMSImplClassic
 *
 * @brief This group contains the Semaphore Manager implementation.
 *
 * @{
 */

/**
 * @brief Classic semaphore variants.
 *
 * Must be in synchronization with Semaphore_Control::variant.
 */
typedef enum {
  SEMAPHORE_VARIANT_MUTEX_INHERIT_PRIORITY,
  SEMAPHORE_VARIANT_MUTEX_PRIORITY_CEILING,
  SEMAPHORE_VARIANT_MUTEX_NO_PROTOCOL,
  SEMAPHORE_VARIANT_SIMPLE_BINARY,
  SEMAPHORE_VARIANT_COUNTING
#if defined(RTEMS_SMP)
  ,
  SEMAPHORE_VARIANT_MRSP
#endif
} Semaphore_Variant;

typedef enum {
  SEMAPHORE_DISCIPLINE_PRIORITY,
  SEMAPHORE_DISCIPLINE_FIFO
} Semaphore_Discipline;

RTEMS_INLINE_ROUTINE uintptr_t _Semaphore_Get_flags(
  const Semaphore_Control *the_semaphore
)
{
  _Assert( _Chain_Is_node_off_chain( &the_semaphore->Object.Node ) );
  return (uintptr_t) the_semaphore->Object.Node.previous;
}

RTEMS_INLINE_ROUTINE void _Semaphore_Set_flags(
  Semaphore_Control *the_semaphore,
  uintptr_t          flags
)
{
  _Assert( _Chain_Is_node_off_chain( &the_semaphore->Object.Node ) );
  the_semaphore->Object.Node.previous = (Chain_Node *) flags;
}

RTEMS_INLINE_ROUTINE Semaphore_Variant _Semaphore_Get_variant(
  uintptr_t flags
)
{
  return (Semaphore_Discipline) ( flags & 0x7 );
}

RTEMS_INLINE_ROUTINE uintptr_t _Semaphore_Set_variant(
  uintptr_t         flags,
  Semaphore_Variant variant
)
{
  return flags | variant;
}

RTEMS_INLINE_ROUTINE Semaphore_Discipline _Semaphore_Get_discipline(
  uintptr_t flags
)
{
  return (Semaphore_Discipline) ( ( flags >> 3 ) & 0x1 );
}

RTEMS_INLINE_ROUTINE uintptr_t _Semaphore_Set_discipline(
  uintptr_t            flags,
  Semaphore_Discipline discipline
)
{
  return flags | ( discipline << 3 );
}

#if defined(RTEMS_MULTIPROCESSING)
RTEMS_INLINE_ROUTINE bool _Semaphore_Is_global(
  uintptr_t flags
)
{
  return ( flags & 0x10 ) != 0;
}

RTEMS_INLINE_ROUTINE uintptr_t _Semaphore_Make_global( uintptr_t flags )
{
  return flags | 0x10;
}
#endif

RTEMS_INLINE_ROUTINE const Thread_queue_Operations *_Semaphore_Get_operations(
  uintptr_t flags
)
{
  if (
    _Semaphore_Get_variant( flags ) == SEMAPHORE_VARIANT_MUTEX_INHERIT_PRIORITY
  ) {
    return &_Thread_queue_Operations_priority_inherit;
  }

  if ( _Semaphore_Get_discipline( flags ) == SEMAPHORE_DISCIPLINE_PRIORITY ) {
    return &_Thread_queue_Operations_priority;
  }

  return &_Thread_queue_Operations_FIFO;
}

/**
 *  @brief Allocates a semaphore control block from
 *  the inactive chain of free semaphore control blocks.
 *
 *  This function allocates a semaphore control block from
 *  the inactive chain of free semaphore control blocks.
 */
RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Allocate( void )
{
  return (Semaphore_Control *) _Objects_Allocate( &_Semaphore_Information );
}

/**
 *  @brief Frees a semaphore control block to the
 *  inactive chain of free semaphore control blocks.
 *
 *  This routine frees a semaphore control block to the
 *  inactive chain of free semaphore control blocks.
 */
RTEMS_INLINE_ROUTINE void _Semaphore_Free (
  Semaphore_Control *the_semaphore
)
{
  _Objects_Free( &_Semaphore_Information, &the_semaphore->Object );
}

RTEMS_INLINE_ROUTINE Semaphore_Control *_Semaphore_Get(
  Objects_Id            id,
  Thread_queue_Context *queue_context
)
{
  _Thread_queue_Context_initialize( queue_context );
  return (Semaphore_Control *) _Objects_Get(
    id,
    &queue_context->Lock_context.Lock_context,
    &_Semaphore_Information
  );
}

/** @} */

#ifdef __cplusplus
}
#endif

#ifdef RTEMS_MULTIPROCESSING
#include <rtems/rtems/semmp.h>
#endif

#endif
/*  end of include file */