summaryrefslogtreecommitdiffstats
path: root/c/src/exec/rtems/src/sem.c
blob: d810c205eea3127a368b355325f5de7109fff02a (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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
/*
 *  Semaphore Manager
 *
 *  DESCRIPTION:
 *
 *  This package is the implementation of the Semaphore Manager.
 *  This manager utilizes standard Dijkstra counting semaphores to provide
 *  synchronization and mutual exclusion capabilities.
 *
 *  Directives provided are:
 *
 *     + create a semaphore
 *     + get an ID of a semaphore
 *     + delete a semaphore
 *     + acquire a semaphore
 *     + release a semaphore
 *
 *  COPYRIGHT (c) 1989, 1990, 1991, 1992, 1993, 1994.
 *  On-Line Applications Research Corporation (OAR).
 *  All rights assigned to U.S. Government, 1994.
 *
 *  This material may be reproduced by or for the U.S. Government pursuant
 *  to the copyright license under the clause at DFARS 252.227-7013.  This
 *  notice must appear in all copies of this file and its derivatives.
 *
 *  $Id$
 */

#include <rtems/system.h>
#include <rtems/support.h>
#include <rtems/attr.h>
#include <rtems/config.h>
#include <rtems/isr.h>
#include <rtems/object.h>
#include <rtems/options.h>
#include <rtems/sem.h>
#include <rtems/states.h>
#include <rtems/thread.h>
#include <rtems/threadq.h>
#include <rtems/mpci.h>

/*PAGE
 *
 *  _Semaphore_Manager_initialization
 *
 *  This routine initializes all semaphore manager related data structures.
 *
 *  Input parameters:
 *    maximum_semaphores - maximum configured semaphores
 *
 *  Output parameters:  NONE
 */

void _Semaphore_Manager_initialization(
  unsigned32 maximum_semaphores
)
{
  _Objects_Initialize_information(
    &_Semaphore_Information,
    OBJECTS_RTEMS_SEMAPHORES,
    TRUE,
    maximum_semaphores,
    sizeof( Semaphore_Control ),
    FALSE,
    RTEMS_MAXIMUM_NAME_LENGTH,
    FALSE
  );
}

/*PAGE
 *
 *  rtems_semaphore_create
 *
 *  This directive creates a semaphore and sets the initial value based
 *  on the given count.  A semaphore id is returned.
 *
 *  Input parameters:
 *    name          - user defined semaphore name
 *    count         - initial count of semaphore
 *    attribute_set - semaphore attributes
 *    id            - pointer to semaphore id
 *
 *  Output parameters:
 *    id       - semaphore id
 *    RTEMS_SUCCESSFUL - if successful
 *    error code - if unsuccessful
 */

rtems_status_code rtems_semaphore_create(
  rtems_name          name,
  unsigned32          count,
  rtems_attribute  attribute_set,
  Objects_Id         *id
)
{
  register Semaphore_Control *the_semaphore;

  if ( !rtems_is_name_valid( name ) )
    return ( RTEMS_INVALID_NAME );

  if ( _Attributes_Is_global( attribute_set ) ) {

    if ( !_Configuration_Is_multiprocessing() )
      return( RTEMS_MP_NOT_CONFIGURED );

    if ( _Attributes_Is_inherit_priority( attribute_set ) )
      return( RTEMS_NOT_DEFINED );

  } else if ( _Attributes_Is_inherit_priority( attribute_set ) ) {

    if ( ! ( _Attributes_Is_binary_semaphore( attribute_set ) &&
             _Attributes_Is_priority( attribute_set ) ) )
      return( RTEMS_NOT_DEFINED );

  }

  if ( _Attributes_Is_binary_semaphore( attribute_set ) && ( count > 1 ) )
    return( RTEMS_INVALID_NUMBER );

  _Thread_Disable_dispatch();             /* prevents deletion */

  the_semaphore = _Semaphore_Allocate();

  if ( !the_semaphore ) {
    _Thread_Enable_dispatch();
    return( RTEMS_TOO_MANY );
  }

  if ( _Attributes_Is_global( attribute_set ) &&
       !( _Objects_MP_Open( &_Semaphore_Information, name,
                            the_semaphore->Object.id, FALSE ) ) ) {
    _Semaphore_Free( the_semaphore );
    _Thread_Enable_dispatch();
    return( RTEMS_TOO_MANY );
  }

  the_semaphore->attribute_set = attribute_set;
  the_semaphore->count         = count;

  if ( _Attributes_Is_binary_semaphore( attribute_set ) && count == 0 ) {
    the_semaphore->nest_count = 1;
    the_semaphore->holder     = _Thread_Executing;
    the_semaphore->holder_id  = _Thread_Executing->Object.id;
    _Thread_Executing->resource_count++;
  } else {
    the_semaphore->nest_count = 0;
    the_semaphore->holder     = NULL;
    the_semaphore->holder_id  = 0;
  }

  _Thread_queue_Initialize( &the_semaphore->Wait_queue,
                            attribute_set, STATES_WAITING_FOR_SEMAPHORE );

  _Objects_Open( &_Semaphore_Information, &the_semaphore->Object, &name );

  *id = the_semaphore->Object.id;

  if ( _Attributes_Is_global( attribute_set ) )
    _Semaphore_MP_Send_process_packet(
      SEMAPHORE_MP_ANNOUNCE_CREATE,
      the_semaphore->Object.id,
      name,
      0                          /* Not used */
    );
  _Thread_Enable_dispatch();
  return( RTEMS_SUCCESSFUL );
}

/*PAGE
 *
 *  rtems_semaphore_ident
 *
 *  This directive returns the system ID associated with
 *  the semaphore name.
 *
 *  Input parameters:
 *    name - user defined semaphore name
 *    node - node(s) to be searched
 *    id   - pointer to semaphore id
 *
 *  Output parameters:
 *    *id      - semaphore id
 *    RTEMS_SUCCESSFUL - if successful
 *    error code - if unsuccessful
 */

rtems_status_code rtems_semaphore_ident(
  rtems_name    name,
  unsigned32    node,
  Objects_Id   *id
)
{
  return( _Objects_Name_to_id( &_Semaphore_Information, &name, node, id ) );
}

/*PAGE
 *
 *  rtems_semaphore_delete
 *
 *  This directive allows a thread to delete a semaphore specified by
 *  the semaphore id.  The semaphore is freed back to the inactive
 *  semaphore chain.
 *
 *  Input parameters:
 *    id - semaphore id
 *
 *  Output parameters:
 *    RTEMS_SUCCESSFUL - if successful
 *    error code        - if unsuccessful
 */

rtems_status_code rtems_semaphore_delete(
  Objects_Id id
)
{
  register Semaphore_Control *the_semaphore;
  Objects_Locations           location;

  the_semaphore = _Semaphore_Get( id, &location );
  switch ( location ) {
    case OBJECTS_ERROR:
      return( RTEMS_INVALID_ID );
    case OBJECTS_REMOTE:
      _Thread_Dispatch();
      return( RTEMS_ILLEGAL_ON_REMOTE_OBJECT );
    case OBJECTS_LOCAL:
      if ( _Attributes_Is_binary_semaphore( the_semaphore->attribute_set) &&
                       ( the_semaphore->count == 0 ) ) {
        _Thread_Enable_dispatch();
        return( RTEMS_RESOURCE_IN_USE );
      }

      _Objects_Close( &_Semaphore_Information, &the_semaphore->Object );

      _Thread_queue_Flush(
        &the_semaphore->Wait_queue,
        _Semaphore_MP_Send_object_was_deleted
      );

      _Semaphore_Free( the_semaphore );

      if ( _Attributes_Is_global( the_semaphore->attribute_set ) ) {

        _Objects_MP_Close( &_Semaphore_Information, the_semaphore->Object.id );

        _Semaphore_MP_Send_process_packet(
          SEMAPHORE_MP_ANNOUNCE_DELETE,
          the_semaphore->Object.id,
          0,                         /* Not used */
          0                          /* Not used */
        );
      }
      _Thread_Enable_dispatch();
      return( RTEMS_SUCCESSFUL );
  }

  return( RTEMS_INTERNAL_ERROR );   /* unreached - only to remove warnings */
}

/*PAGE
 *
 *  rtems_semaphore_obtain
 *
 *  This directive allows a thread to acquire a semaphore.
 *
 *  Input parameters:
 *    id         - semaphore id
 *    option_set - wait option
 *    timeout    - number of ticks to wait (0 means wait forever)
 *
 *  Output parameters:
 *    RTEMS_SUCCESSFUL - if successful
 *    error code        - if unsuccessful
 */

rtems_status_code rtems_semaphore_obtain(
  Objects_Id        id,
  unsigned32        option_set,
  rtems_interval timeout
)
{
  register Semaphore_Control *the_semaphore;
  Objects_Locations           location;

  the_semaphore = _Semaphore_Get( id, &location );
  switch ( location ) {
    case OBJECTS_ERROR:
      return( RTEMS_INVALID_ID );
    case OBJECTS_REMOTE:
      return _Semaphore_MP_Send_request_packet(
          SEMAPHORE_MP_OBTAIN_REQUEST,
          id,
          option_set,
          timeout
      );
    case OBJECTS_LOCAL:
      if ( !_Semaphore_Seize( the_semaphore, option_set ) ) {
        if ( _Attributes_Is_inherit_priority( the_semaphore->attribute_set ) &&
             the_semaphore->holder->current_priority >
               _Thread_Executing->current_priority ) {
            _Thread_Change_priority(
              the_semaphore->holder, _Thread_Executing->current_priority );
         }
        _Thread_queue_Enqueue( &the_semaphore->Wait_queue, timeout );
      }
      _Thread_Enable_dispatch();
      return( _Thread_Executing->Wait.return_code );
  }

  return( RTEMS_INTERNAL_ERROR );   /* unreached - only to remove warnings */
}

/*PAGE
 *
 *  rtems_semaphore_release
 *
 *  This directive allows a thread to release a semaphore.
 *
 *  Input parameters:
 *    id - semaphore id
 *
 *  Output parameters:
 *    RTEMS_SUCCESSFUL - if successful
 *    error code        - if unsuccessful
 */

rtems_status_code rtems_semaphore_release(
  Objects_Id id
)
{
  register Semaphore_Control *the_semaphore;
  Objects_Locations           location;
  Thread_Control             *the_thread;

  the_semaphore = _Semaphore_Get( id, &location );
  switch ( location ) {
    case OBJECTS_ERROR:
      return( RTEMS_INVALID_ID );
    case OBJECTS_REMOTE:
      return(
        _Semaphore_MP_Send_request_packet(
          SEMAPHORE_MP_RELEASE_REQUEST,
          id,
          0,                               /* Not used */
          MPCI_DEFAULT_TIMEOUT
        )
      );
    case OBJECTS_LOCAL:
      if ( _Attributes_Is_binary_semaphore( the_semaphore->attribute_set)) {

        if ( !_Objects_Are_ids_equal(
               _Thread_Executing->Object.id, the_semaphore->holder_id ) ) {
          _Thread_Enable_dispatch();
          return( RTEMS_NOT_OWNER_OF_RESOURCE );
        }

        the_semaphore->nest_count--;

        if ( the_semaphore->nest_count != 0 ) {
          _Thread_Enable_dispatch();
          return( RTEMS_SUCCESSFUL );
        }

        _Thread_Executing->resource_count--;
        the_semaphore->holder    = NULL;
        the_semaphore->holder_id = 0;

        /*
         *  Whether or not someone is waiting for the semaphore, an
         *  inherited priority must be lowered if this is the last
         *  semaphore (i.e. resource) this task has.
         */

        if ( _Attributes_Is_inherit_priority(the_semaphore->attribute_set) &&
             _Thread_Executing->resource_count == 0 &&
             _Thread_Executing->real_priority !=
                _Thread_Executing->current_priority ) {
           _Thread_Change_priority(
              _Thread_Executing, _Thread_Executing->real_priority );
        }

      }

      if ( (the_thread = _Thread_queue_Dequeue(&the_semaphore->Wait_queue)) ) {

        if ( !_Objects_Is_local_id( the_thread->Object.id ) ) {
          the_thread->receive_packet->return_code = RTEMS_SUCCESSFUL;

          if ( _Attributes_Is_binary_semaphore(the_semaphore->attribute_set) ) {
            the_semaphore->holder    = NULL;
            the_semaphore->holder_id = the_thread->Object.id;
            the_semaphore->nest_count = 1;
          }

          _Semaphore_MP_Send_response_packet(
            SEMAPHORE_MP_OBTAIN_RESPONSE,
            id,
            the_thread
          );
        } else {

          if ( _Attributes_Is_binary_semaphore(the_semaphore->attribute_set) ) {
            the_semaphore->holder    = the_thread;
            the_semaphore->holder_id = the_thread->Object.id;
            the_thread->resource_count++;
            the_semaphore->nest_count = 1;
          }

          /*
           *  No special action for priority inheritance because the_thread
           *  is guaranteed to be the highest priority thread waiting for
           *  the semaphore.
           */
        }
      } else
        the_semaphore->count += 1;

      _Thread_Enable_dispatch();
      return( RTEMS_SUCCESSFUL );
  }

  return( RTEMS_INTERNAL_ERROR );   /* unreached - only to remove warnings */
}

/*PAGE
 *
 *  _Semaphore_Seize
 *
 *  This routine attempts to allocate a semaphore to the calling thread.
 *
 *  Input parameters:
 *    the_semaphore - pointer to semaphore control block
 *    option_set    - acquire semaphore options
 *
 *  Output parameters:
 *    TRUE  - if semaphore allocated
 *    FALSE - if semaphore NOT allocated
 *
 *  INTERRUPT LATENCY:
 *    available
 *    wait
 */

boolean _Semaphore_Seize(
  Semaphore_Control *the_semaphore,
  rtems_option    option_set
)
{
  Thread_Control *executing;
  ISR_Level       level;

  executing = _Thread_Executing;
  executing->Wait.return_code = RTEMS_SUCCESSFUL;
  _ISR_Disable( level );
  if ( the_semaphore->count != 0 ) {
    the_semaphore->count -= 1;
    if ( _Attributes_Is_binary_semaphore( the_semaphore->attribute_set ) ) {
      the_semaphore->holder     = executing;
      the_semaphore->holder_id  = executing->Object.id;
      the_semaphore->nest_count = 1;
      executing->resource_count++;
    }
    _ISR_Enable( level );
    return( TRUE );
  }

  if ( _Options_Is_no_wait( option_set ) ) {
    _ISR_Enable( level );
    executing->Wait.return_code = RTEMS_UNSATISFIED;
    return( TRUE );
  }

  if ( _Attributes_Is_binary_semaphore( the_semaphore->attribute_set ) ) {
    if ( _Objects_Are_ids_equal(
            _Thread_Executing->Object.id, the_semaphore->holder_id ) ) {
      the_semaphore->nest_count++;
      _ISR_Enable( level );
      return( TRUE );
    }
  }

  the_semaphore->Wait_queue.sync = TRUE;
  executing->Wait.queue      = &the_semaphore->Wait_queue;
  executing->Wait.id         = the_semaphore->Object.id;
  executing->Wait.option_set = option_set;
  _ISR_Enable( level );
  return( FALSE );
}