blob: 628a570e3308a2cd0582857e680e528daf815022 (
plain) (
tree)
|
|
/**
* @file rtems/rtems/barrier.inl
*
* @defgroup ClassicBarrier Barriers
*
* @ingroup ClassicRTEMS
* @brief Inline Implementation from Barrier Manager
*
* This file contains the static inlin implementation of the inlined
* routines from the Barrier Manager.
*/
/*
* 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_BARRIERIMPL_H
#define _RTEMS_RTEMS_BARRIERIMPL_H
#include <rtems/rtems/barrier.h>
#include <rtems/score/corebarrierimpl.h>
#include <rtems/score/objectimpl.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* @defgroup ClassicBarrierImpl Classic Barrier Implementation
*
* @ingroup ClassicBarrier
*
* @{
*/
/**
* @brief Instantiate Barrier Data
*
* Barrier Manager -- Instantiate Data
*
* This constant is defined to extern most of the time when using
* this header file. However by defining it to nothing, the data
* declared in this header file can be instantiated. This is done
* in a single per manager file.
*/
#ifndef RTEMS_BARRIER_EXTERN
#define RTEMS_BARRIER_EXTERN extern
#endif
/**
* The following defines the information control block used to manage
* this class of objects.
*/
RTEMS_BARRIER_EXTERN Objects_Information _Barrier_Information;
/**
* @brief _Barrier_Manager_initialization
*
* This routine performs the initialization necessary for this manager.
*/
void _Barrier_Manager_initialization(void);
/**
* @brief _Barrier_Allocate
*
* This function allocates a barrier control block from
* the inactive chain of free barrier control blocks.
*/
RTEMS_INLINE_ROUTINE Barrier_Control *_Barrier_Allocate( void )
{
return (Barrier_Control *) _Objects_Allocate( &_Barrier_Information );
}
/**
* @brief _Barrier_Free
*
* This routine frees a barrier control block to the
* inactive chain of free barrier control blocks.
*/
RTEMS_INLINE_ROUTINE void _Barrier_Free (
Barrier_Control *the_barrier
)
{
_Objects_Free( &_Barrier_Information, &the_barrier->Object );
}
/**
* @brief _Barrier_Get
*
* This function maps barrier IDs to barrier control blocks.
* If ID corresponds to a local barrier, then it returns
* the_barrier control pointer which maps to ID and location
* is set to OBJECTS_LOCAL. if the barrier ID is global and
* resides on a remote node, then location is set to OBJECTS_REMOTE,
* and the_barrier is undefined. Otherwise, location is set
* to OBJECTS_ERROR and the_barrier is undefined.
*/
RTEMS_INLINE_ROUTINE Barrier_Control *_Barrier_Get (
Objects_Id id,
Objects_Locations *location
)
{
return (Barrier_Control *)
_Objects_Get( &_Barrier_Information, id, location );
}
/**
* @brief _Barrier_Is_null
*
* This function returns TRUE if the_barrier is NULL and FALSE otherwise.
*/
RTEMS_INLINE_ROUTINE bool _Barrier_Is_null (
Barrier_Control *the_barrier
)
{
return ( the_barrier == NULL );
}
/**
* @brief Translate SuperCore Barrier Status Code to RTEMS Status Code
*
* This function returns a RTEMS status code based on the barrier
* status code specified.
*
* @param[in] the_status is the SuperCore Barrier status to translate.
*
* @retval a status code indicating success or the reason for failure.
*/
rtems_status_code _Barrier_Translate_core_barrier_return_code (
CORE_barrier_Status the_status
);
/**@}*/
#ifdef __cplusplus
}
#endif
#endif
/* end of include file */
|
