summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/src/mutexinit.c
blob: 7b384cbeb795125961f4f4bd198bbeafc1d31a56 (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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
/* SPDX-License-Identifier: BSD-2-Clause */

/**
 * @file
 *
 * @ingroup POSIXAPI
 *
 * @brief Initialize a Mutex
 */

/*
 *  COPYRIGHT (c) 1989-2009.
 *  On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <rtems/posix/muteximpl.h>
#include <rtems/posix/posixapi.h>
#include <rtems/posix/priorityimpl.h>
#include <rtems/score/schedulerimpl.h>

#include <limits.h>

RTEMS_STATIC_ASSERT(
  offsetof( POSIX_Mutex_Control, flags )
    == offsetof( pthread_mutex_t, _flags ),
  POSIX_MUTEX_CONTROL_FLAGS
);

RTEMS_STATIC_ASSERT(
  offsetof( POSIX_Mutex_Control, Recursive )
    == offsetof( pthread_mutex_t, _Recursive ),
  POSIX_MUTEX_CONTROL_RECURSIVE
);

RTEMS_STATIC_ASSERT(
  offsetof( POSIX_Mutex_Control, Priority_ceiling )
    == offsetof( pthread_mutex_t, _Priority_ceiling ),
  POSIX_MUTEX_CONTROL_PRIORITY_CEILING
);

RTEMS_STATIC_ASSERT(
  offsetof( POSIX_Mutex_Control, scheduler )
    == offsetof( pthread_mutex_t, _scheduler ),
  POSIX_MUTEX_CONTROL_SCHEDULER
);

RTEMS_STATIC_ASSERT(
  sizeof( POSIX_Mutex_Control ) == sizeof( pthread_mutex_t ),
  POSIX_MUTEX_CONTROL_SIZE
);

const pthread_mutexattr_t _POSIX_Mutex_Default_attributes = {
#if defined(_UNIX98_THREAD_MUTEX_ATTRIBUTES)
  .type           = PTHREAD_MUTEX_DEFAULT,
#endif
  .is_initialized = true,
  .process_shared = PTHREAD_PROCESS_PRIVATE,
  .prio_ceiling   = INT_MAX,
  .protocol       = PTHREAD_PRIO_NONE,
  .recursive      = false
};

/**
 * 11.3.2 Initializing and Destroying a Mutex, P1003.1c/Draft 10, p. 87
 *
 * NOTE:  XXX Could be optimized so all the attribute error checking
 *            is not performed when attr is NULL.
 */

int pthread_mutex_init(
  pthread_mutex_t           *mutex,
  const pthread_mutexattr_t *attr
)
{
  POSIX_Mutex_Control       *the_mutex;
  const pthread_mutexattr_t *the_attr;
  POSIX_Mutex_Protocol       protocol;
  unsigned long              flags;
  Priority_Control           priority;
  const Scheduler_Control   *scheduler;

  if ( attr ) the_attr = attr;
  else        the_attr = &_POSIX_Mutex_Default_attributes;

  /* Check for NULL mutex */
  if ( !mutex )
    return EINVAL;

  /*
   *  The POSIX specification says:
   *
   *  "Attempting to initialize an already initialized mutex results
   *  in undefined behavior."
   *
   *  Trying to keep the caller from doing the create when *mutex
   *  is actually a valid ID causes grief.  All it takes is the wrong
   *  value in an uninitialized variable to make this fail.
   *
   *  Thus, we do not look at *mutex.
   */

  if ( !the_attr->is_initialized )
    return EINVAL;

  if ( !_POSIX_Is_valid_pshared( the_attr->process_shared ) ) {
    return EINVAL;
  }

  /*
   *  Determine the discipline of the mutex
   */
  switch ( the_attr->protocol ) {
    case PTHREAD_PRIO_NONE:
      protocol = POSIX_MUTEX_NO_PROTOCOL;
      break;
    case PTHREAD_PRIO_INHERIT:
      protocol = POSIX_MUTEX_PRIORITY_INHERIT;
      break;
    case PTHREAD_PRIO_PROTECT:
      protocol = POSIX_MUTEX_PRIORITY_CEILING;
      break;
    default:
      return EINVAL;
  }

#if defined(_UNIX98_THREAD_MUTEX_ATTRIBUTES)
  /*
   *  Validate the mutex type and set appropriate SuperCore mutex
   *  attributes.
   */
  switch ( the_attr->type ) {
    case PTHREAD_MUTEX_NORMAL:
    case PTHREAD_MUTEX_RECURSIVE:
    case PTHREAD_MUTEX_ERRORCHECK:
    case PTHREAD_MUTEX_DEFAULT:
      break;

    default:
      return EINVAL;
  }
#endif

  the_mutex = _POSIX_Mutex_Get( mutex );

  flags = (uintptr_t) the_mutex ^ POSIX_MUTEX_MAGIC;
  flags &= ~POSIX_MUTEX_FLAGS_MASK;
  flags |= protocol;

  if ( the_attr->type == PTHREAD_MUTEX_RECURSIVE ) {
    flags |= POSIX_MUTEX_RECURSIVE;
  }

  the_mutex->flags = flags;

  if ( protocol == POSIX_MUTEX_PRIORITY_CEILING ) {
    int  prio_ceiling;
    bool valid;

    scheduler = _Thread_Scheduler_get_home( _Thread_Get_executing() );
    prio_ceiling = the_attr->prio_ceiling;

    if ( prio_ceiling == INT_MAX ) {
      prio_ceiling = _POSIX_Priority_Get_maximum( scheduler );
    }

    priority = _POSIX_Priority_To_core( scheduler, prio_ceiling, &valid );
    if ( !valid ) {
      return EINVAL;
    }
  } else {
    priority = 0;
    scheduler = NULL;
  }

  _Thread_queue_Queue_initialize(
    &the_mutex->Recursive.Mutex.Queue.Queue,
    NULL
  );
  the_mutex->Recursive.nest_level = 0;
  _Priority_Node_initialize( &the_mutex->Priority_ceiling, priority );
  the_mutex->scheduler = scheduler;
  return 0;
}