diff options
author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2013-07-23 14:38:19 +0200 |
---|---|---|
committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2013-07-23 15:12:55 +0200 |
commit | f6c7c57d86b58e12d372495a23e331cb81ea59ff (patch) | |
tree | 6406542e0324f94964bbce0e41d2f86c637d5f1f /cpukit/rtems/include/rtems/rtems | |
parent | rtems: Include <rtems/debug.h> in <rtems.h> (diff) | |
download | rtems-f6c7c57d86b58e12d372495a23e331cb81ea59ff.tar.bz2 |
rtems: Create region implementation header
Move implementation specific parts of region.h and region.inl into new
header file regionimpl.h. The region.h contains now only the
application visible API.
Diffstat (limited to 'cpukit/rtems/include/rtems/rtems')
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/region.h | 85 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/regionimpl.h | 188 | ||||
-rw-r--r-- | cpukit/rtems/include/rtems/rtems/regionmp.h | 9 |
3 files changed, 200 insertions, 82 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index a99a497b8d..ce471b8169 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -30,15 +30,16 @@ #ifndef _RTEMS_RTEMS_REGION_H #define _RTEMS_RTEMS_REGION_H -#include <rtems/score/object.h> -#include <rtems/score/threadq.h> -#include <rtems/score/heap.h> -#include <rtems/debug.h> #include <rtems/rtems/attr.h> #include <rtems/rtems/options.h> #include <rtems/rtems/status.h> -#include <rtems/rtems/support.h> #include <rtems/rtems/types.h> +#include <rtems/score/heap.h> +#include <rtems/score/tqdata.h> + +#ifdef __cplusplus +extern "C" { +#endif /** * @defgroup ClassicRegion Regions @@ -50,24 +51,6 @@ /**@{*/ /** - * @brief Instantiate RTEMS Region Data - * - * Region 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_REGION_EXTERN -#define RTEMS_REGION_EXTERN extern -#endif - -#ifdef __cplusplus -extern "C" { -#endif - -/** * The following records define the control block used to manage * each region. */ @@ -85,21 +68,6 @@ typedef struct { } Region_Control; /** - * The following defines the information control block used to - * manage this class of objects. - */ -RTEMS_REGION_EXTERN Objects_Information _Region_Information; - -/** - * @brief _Region_Manager_initialization - * - * Region Manager - * - * This routine performs the initialization necessary for this manager. - */ -void _Region_Manager_initialization(void); - -/** * @brief rtems_region_create * * Region Manager @@ -322,50 +290,11 @@ rtems_status_code rtems_region_resize_segment( uintptr_t *old_size ); -#ifndef __RTEMS_APPLICATION__ -#include <rtems/rtems/region.inl> -/** - * @brief Process Region Queue - * - * This is a helper routine which is invoked any time memory is - * freed. It looks at the set of waiting tasks and attempts to - * satisfy all outstanding requests. - * - * @param[in] the_region is the the region - */ -extern void _Region_Process_queue(Region_Control *the_region); - -#endif - -#if defined(RTEMS_MULTIPROCESSING) -#include <rtems/rtems/regionmp.h> -#endif - -/** - * @brief _Region_Debug_Walk - * - * This routine is invoked to verify the integrity of a heap associated - * with the_region. - */ -#ifdef RTEMS_DEBUG - -#define _Region_Debug_Walk( _the_region, _source ) \ - do { \ - if ( rtems_debug_is_enabled( RTEMS_DEBUG_REGION ) ) \ - _Heap_Walk( &(_the_region)->Memory, _source, false ); \ - } while ( 0 ) - -#else - -#define _Region_Debug_Walk( _the_region, _source ) - -#endif +/**@}*/ #ifdef __cplusplus } #endif -/**@}*/ - #endif /* end of include file */ diff --git a/cpukit/rtems/include/rtems/rtems/regionimpl.h b/cpukit/rtems/include/rtems/rtems/regionimpl.h new file mode 100644 index 0000000000..ad2cacb5f2 --- /dev/null +++ b/cpukit/rtems/include/rtems/rtems/regionimpl.h @@ -0,0 +1,188 @@ +/** + * @file + * + * @ingroup ClassicRegionImpl + * + * @brief Classic Region 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.com/license/LICENSE. + */ + +#ifndef _RTEMS_RTEMS_REGIONIMPL_H +#define _RTEMS_RTEMS_REGIONIMPL_H + +#include <rtems/rtems/region.h> +#include <rtems/debug.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @defgroup ClassicRegionImpl Classic Region Manager Implementation + * + * @ingroup ClassicRegion + * + * @{ + */ + +/** + * @brief Instantiate RTEMS Region Data + * + * Region 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_REGION_EXTERN +#define RTEMS_REGION_EXTERN extern +#endif + +/** + * The following defines the information control block used to + * manage this class of objects. + */ +RTEMS_REGION_EXTERN Objects_Information _Region_Information; + +/** + * @brief _Region_Manager_initialization + * + * Region Manager + * + * This routine performs the initialization necessary for this manager. + */ +void _Region_Manager_initialization(void); + +/** + * @brief Region_Allocate + * + * This function allocates a region control block from + * the inactive chain of free region control blocks. + */ +RTEMS_INLINE_ROUTINE Region_Control *_Region_Allocate( void ) +{ + return (Region_Control *) _Objects_Allocate( &_Region_Information ); +} + +/** + * @brief Region_Free + * + * This routine frees a region control block to the + * inactive chain of free region control blocks. + */ +RTEMS_INLINE_ROUTINE void _Region_Free ( + Region_Control *the_region +) +{ + _Objects_Free( &_Region_Information, &the_region->Object ); +} + +/** + * @brief Region_Get + * + * This function maps region IDs to region control blocks. + * If ID corresponds to a local region, then it returns + * the_region control pointer which maps to ID and location + * is set to OBJECTS_LOCAL. Otherwise, location is set + * to OBJECTS_ERROR and the_region is undefined. + */ +RTEMS_INLINE_ROUTINE Region_Control *_Region_Get ( + Objects_Id id, + Objects_Locations *location +) +{ + return (Region_Control *) + _Objects_Get_no_protection( &_Region_Information, id, location ); +} + +/** + * @brief Region_Allocate_segment + * + * This function attempts to allocate a segment from the_region. + * If successful, it returns the address of the allocated segment. + * Otherwise, it returns NULL. + */ +RTEMS_INLINE_ROUTINE void *_Region_Allocate_segment ( + Region_Control *the_region, + uintptr_t size +) +{ + return _Heap_Allocate( &the_region->Memory, size ); +} + +/** + * @brief Region_Free_segment + * + * This function frees the_segment to the_region. + */ +RTEMS_INLINE_ROUTINE bool _Region_Free_segment ( + Region_Control *the_region, + void *the_segment +) +{ + return _Heap_Free( &the_region->Memory, the_segment ); +} + +/** + * @brief Region_Is_null + * + * This function returns TRUE if the_region is NULL and FALSE otherwise. + */ +RTEMS_INLINE_ROUTINE bool _Region_Is_null ( + Region_Control *the_region +) +{ + return ( the_region == NULL ); +} + +/** + * @brief Process Region Queue + * + * This is a helper routine which is invoked any time memory is + * freed. It looks at the set of waiting tasks and attempts to + * satisfy all outstanding requests. + * + * @param[in] the_region is the the region + */ +extern void _Region_Process_queue(Region_Control *the_region); + +/** + * @brief _Region_Debug_Walk + * + * This routine is invoked to verify the integrity of a heap associated + * with the_region. + */ +#ifdef RTEMS_DEBUG + +#define _Region_Debug_Walk( _the_region, _source ) \ + do { \ + if ( rtems_debug_is_enabled( RTEMS_DEBUG_REGION ) ) \ + _Heap_Walk( &(_the_region)->Memory, _source, false ); \ + } while ( 0 ) + +#else + +#define _Region_Debug_Walk( _the_region, _source ) + +#endif + +/**@}*/ + +#ifdef __cplusplus +} +#endif + +#if defined(RTEMS_MULTIPROCESSING) +#include <rtems/rtems/regionmp.h> +#endif + +#endif +/* end of include file */ diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h index 4ec1eb10c8..972f1ba882 100644 --- a/cpukit/rtems/include/rtems/rtems/regionmp.h +++ b/cpukit/rtems/include/rtems/rtems/regionmp.h @@ -21,16 +21,17 @@ #ifndef _RTEMS_RTEMS_REGIONMP_H #define _RTEMS_RTEMS_REGIONMP_H -#ifdef __cplusplus -extern "C" { +#ifndef _RTEMS_RTEMS_REGIONIMPL_H +# error "Never use <rtems/rtems/regionmp.h> directly; include <rtems/rtems/regionimpl.h> instead." #endif #include <rtems/score/mppkt.h> #include <rtems/score/object.h> #include <rtems/score/thread.h> -#include <rtems/rtems/options.h> -#include <rtems/rtems/region.h> +#ifdef __cplusplus +extern "C" { +#endif /** * @defgroup ClassicRegionMP Region MP Support |