From cbdabc8b30c8ad58a899e1086ffc38dd43ef4ff9 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Fri, 19 Jul 2013 14:48:57 +0200 Subject: score: Create rwlock implementation header Move implementation specific parts of corerwlock.h and corerwlock.inl into new header file corerwlockimpl.h. The corerwlock.h contains now only the application visible API. --- cpukit/score/Makefile.am | 2 +- cpukit/score/include/rtems/score/corerwlock.h | 161 +---------------- cpukit/score/include/rtems/score/corerwlockimpl.h | 201 ++++++++++++++++++++++ cpukit/score/inline/rtems/score/corerwlock.inl | 50 ------ cpukit/score/preinstall.am | 8 +- cpukit/score/src/corerwlock.c | 2 +- cpukit/score/src/corerwlockobtainread.c | 2 +- cpukit/score/src/corerwlockobtainwrite.c | 2 +- cpukit/score/src/corerwlockrelease.c | 2 +- cpukit/score/src/corerwlocktimeout.c | 2 +- 10 files changed, 214 insertions(+), 218 deletions(-) create mode 100644 cpukit/score/include/rtems/score/corerwlockimpl.h delete mode 100644 cpukit/score/inline/rtems/score/corerwlock.inl (limited to 'cpukit/score') diff --git a/cpukit/score/Makefile.am b/cpukit/score/Makefile.am index 9ef62176f5..65abaa4168 100644 --- a/cpukit/score/Makefile.am +++ b/cpukit/score/Makefile.am @@ -72,6 +72,7 @@ endif if HAS_PTHREADS include_rtems_score_HEADERS += include/rtems/score/corespinlock.h include_rtems_score_HEADERS += include/rtems/score/corerwlock.h +include_rtems_score_HEADERS += include/rtems/score/corerwlockimpl.h endif if HAS_MP @@ -109,7 +110,6 @@ include_rtems_score_HEADERS += inline/rtems/score/wkspace.inl if HAS_PTHREADS include_rtems_score_HEADERS += inline/rtems/score/corespinlock.inl -include_rtems_score_HEADERS += inline/rtems/score/corerwlock.inl endif if HAS_MP diff --git a/cpukit/score/include/rtems/score/corerwlock.h b/cpukit/score/include/rtems/score/corerwlock.h index 8281abb9eb..3ed511495e 100644 --- a/cpukit/score/include/rtems/score/corerwlock.h +++ b/cpukit/score/include/rtems/score/corerwlock.h @@ -19,6 +19,8 @@ #ifndef _RTEMS_SCORE_CORERWLOCK_H #define _RTEMS_SCORE_CORERWLOCK_H +#include + /** * @defgroup ScoreRWLock RWLock Handler * @@ -33,20 +35,6 @@ extern "C" { #endif -#include -#include -#include -#include - -/** - * The following type defines the callout which the API provides - * to support global/multiprocessor operations on RWLocks. - */ -typedef void ( *CORE_RWLock_API_mp_support_callout )( - Thread_Control *, - Objects_Id - ); - /** * RWLock State. */ @@ -62,39 +50,6 @@ typedef enum { CORE_RWLOCK_LOCKED_FOR_WRITING } CORE_RWLock_States; -/** - * Core RWLock handler return statuses. - */ -typedef enum { - /** This status indicates that the operation completed successfully. */ - CORE_RWLOCK_SUCCESSFUL, - /** This status indicates that the thread was blocked waiting for an */ - CORE_RWLOCK_WAS_DELETED, - /** This status indicates that the rwlock was not immediately available. */ - CORE_RWLOCK_UNAVAILABLE, - /** This status indicates that the calling task was willing to block - * but the operation was unable to complete within the time allotted - * because the resource never became available. - */ - CORE_RWLOCK_TIMEOUT -} CORE_RWLock_Status; - -/** This is the last status value. - */ -#define CORE_RWLOCK_STATUS_LAST CORE_RWLOCK_TIMEOUT - -/** - * This is used to denote that a thread is blocking waiting for - * read-only access to the RWLock. - */ -#define CORE_RWLOCK_THREAD_WAITING_FOR_READ 0 - -/** - * This is used to denote that a thread is blocking waiting for - * write-exclusive access to the RWLock. - */ -#define CORE_RWLOCK_THREAD_WAITING_FOR_WRITE 1 - /** * The following defines the control block used to manage the * attributes of each RWLock. @@ -126,121 +81,11 @@ typedef struct { uint32_t number_of_readers; } CORE_RWLock_Control; -/** - * @brief Initialize a RWlock. - * - * This routine initializes the RWLock based on the parameters passed. - * - * @param[in] the_rwlock is the RWLock to initialize - * @param[in] the_rwlock_attributes define the behavior of this instance - */ -void _CORE_RWLock_Initialize( - CORE_RWLock_Control *the_rwlock, - CORE_RWLock_Attributes *the_rwlock_attributes -); - -/** - * @brief Obtain RWLock for reading. - * - * This routine attempts to obtain the RWLock for read access. - * - * @param[in] the_rwlock is the RWLock to wait for - * @param[in] id is the id of the object being waited upon - * @param[in] wait is true if the calling thread is willing to wait - * @param[in] timeout is the number of ticks the calling thread is willing - * to wait if @a wait is true. - * @param[in] api_rwlock_mp_support is the routine to invoke if the - * thread unblocked is remote - * - * @note Status is returned via the thread control block. - */ - -void _CORE_RWLock_Obtain_for_reading( - CORE_RWLock_Control *the_rwlock, - Objects_Id id, - bool wait, - Watchdog_Interval timeout, - CORE_RWLock_API_mp_support_callout api_rwlock_mp_support -); - -/** - * @brief Obtain RWLock for writing. - * - * This routine attempts to obtain the RWLock for write exclusive access. - * - * @param[in] the_rwlock is the RWLock to wait for - * @param[in] id is the id of the object being waited upon - * @param[in] wait is true if the calling thread is willing to wait - * @param[in] timeout is the number of ticks the calling thread is willing - * to wait if @a wait is true. - * @param[in] api_rwlock_mp_support is the routine to invoke if the - * thread unblocked is remote - * - * @note Status is returned via the thread control block. - */ -void _CORE_RWLock_Obtain_for_writing( - CORE_RWLock_Control *the_rwlock, - Objects_Id id, - bool wait, - Watchdog_Interval timeout, - CORE_RWLock_API_mp_support_callout api_rwlock_mp_support -); - -/** - * @brief Release the RWLock. - * - * This routine manually releases @a the_rwlock. All of the threads waiting - * for the RWLock will be readied. - * - * @param[in] the_rwlock is the RWLock to surrender - * - * @retval Status is returned to indicate successful or failure. - */ -CORE_RWLock_Status _CORE_RWLock_Release( - CORE_RWLock_Control *the_rwlock -); - -/** - * This routine assists in the deletion of a RWLock by flushing the - * associated wait queue. - * - * @param[in] _the_rwlock is the RWLock to flush - * @param[in] _remote_extract_callout is the routine to invoke if the - * thread unblocked is remote - * @param[in] _status is the status to be returned to the unblocked thread - */ -#define _CORE_RWLock_Flush( _the_rwlock, _remote_extract_callout, _status) \ - _Thread_queue_Flush( \ - &((_the_rwlock)->Wait_queue), \ - (_remote_extract_callout), \ - (_status) \ - ) - -/** - * @brief RWLock specific thread queue timeout. - * - * This routine processes a thread which timeouts while waiting on - * an RWLock's thread queue. It is called by the watchdog handler. - * - * @param[in] id is the Id of thread to timeout - * @param[in] ignored is an unused pointer to a caller defined area - */ - -void _CORE_RWLock_Timeout( - Objects_Id id, - void *ignored -); - - -#ifndef __RTEMS_APPLICATION__ -#include -#endif +/**@}*/ #ifdef __cplusplus } #endif -/**@}*/ - #endif /* end of include file */ diff --git a/cpukit/score/include/rtems/score/corerwlockimpl.h b/cpukit/score/include/rtems/score/corerwlockimpl.h new file mode 100644 index 0000000000..347754c5e1 --- /dev/null +++ b/cpukit/score/include/rtems/score/corerwlockimpl.h @@ -0,0 +1,201 @@ +/** + * @file + * + * @brief Inlined Routines Associated with the SuperCore RWLock + * + * This include file contains all of the inlined routines associated + * with the SuperCore RWLock. + */ + +/* + * 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_SCORE_CORERWLOCKIMPL_H +#define _RTEMS_SCORE_CORERWLOCKIMPL_H + +#include +#include +#include + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @addtogroup ScoreRWLock + */ +/**@{**/ + +/** + * The following type defines the callout which the API provides + * to support global/multiprocessor operations on RWLocks. + */ +typedef void ( *CORE_RWLock_API_mp_support_callout )( + Thread_Control *, + Objects_Id + ); + +/** + * Core RWLock handler return statuses. + */ +typedef enum { + /** This status indicates that the operation completed successfully. */ + CORE_RWLOCK_SUCCESSFUL, + /** This status indicates that the thread was blocked waiting for an */ + CORE_RWLOCK_WAS_DELETED, + /** This status indicates that the rwlock was not immediately available. */ + CORE_RWLOCK_UNAVAILABLE, + /** This status indicates that the calling task was willing to block + * but the operation was unable to complete within the time allotted + * because the resource never became available. + */ + CORE_RWLOCK_TIMEOUT +} CORE_RWLock_Status; + +/** This is the last status value. + */ +#define CORE_RWLOCK_STATUS_LAST CORE_RWLOCK_TIMEOUT + +/** + * This is used to denote that a thread is blocking waiting for + * read-only access to the RWLock. + */ +#define CORE_RWLOCK_THREAD_WAITING_FOR_READ 0 + +/** + * This is used to denote that a thread is blocking waiting for + * write-exclusive access to the RWLock. + */ +#define CORE_RWLOCK_THREAD_WAITING_FOR_WRITE 1 + +/** + * @brief Initialize a RWlock. + * + * This routine initializes the RWLock based on the parameters passed. + * + * @param[in] the_rwlock is the RWLock to initialize + * @param[in] the_rwlock_attributes define the behavior of this instance + */ +void _CORE_RWLock_Initialize( + CORE_RWLock_Control *the_rwlock, + CORE_RWLock_Attributes *the_rwlock_attributes +); + +/** + * @brief Obtain RWLock for reading. + * + * This routine attempts to obtain the RWLock for read access. + * + * @param[in] the_rwlock is the RWLock to wait for + * @param[in] id is the id of the object being waited upon + * @param[in] wait is true if the calling thread is willing to wait + * @param[in] timeout is the number of ticks the calling thread is willing + * to wait if @a wait is true. + * @param[in] api_rwlock_mp_support is the routine to invoke if the + * thread unblocked is remote + * + * @note Status is returned via the thread control block. + */ + +void _CORE_RWLock_Obtain_for_reading( + CORE_RWLock_Control *the_rwlock, + Objects_Id id, + bool wait, + Watchdog_Interval timeout, + CORE_RWLock_API_mp_support_callout api_rwlock_mp_support +); + +/** + * @brief Obtain RWLock for writing. + * + * This routine attempts to obtain the RWLock for write exclusive access. + * + * @param[in] the_rwlock is the RWLock to wait for + * @param[in] id is the id of the object being waited upon + * @param[in] wait is true if the calling thread is willing to wait + * @param[in] timeout is the number of ticks the calling thread is willing + * to wait if @a wait is true. + * @param[in] api_rwlock_mp_support is the routine to invoke if the + * thread unblocked is remote + * + * @note Status is returned via the thread control block. + */ +void _CORE_RWLock_Obtain_for_writing( + CORE_RWLock_Control *the_rwlock, + Objects_Id id, + bool wait, + Watchdog_Interval timeout, + CORE_RWLock_API_mp_support_callout api_rwlock_mp_support +); + +/** + * @brief Release the RWLock. + * + * This routine manually releases @a the_rwlock. All of the threads waiting + * for the RWLock will be readied. + * + * @param[in] the_rwlock is the RWLock to surrender + * + * @retval Status is returned to indicate successful or failure. + */ +CORE_RWLock_Status _CORE_RWLock_Release( + CORE_RWLock_Control *the_rwlock +); + +/** + * This routine assists in the deletion of a RWLock by flushing the + * associated wait queue. + * + * @param[in] _the_rwlock is the RWLock to flush + * @param[in] _remote_extract_callout is the routine to invoke if the + * thread unblocked is remote + * @param[in] _status is the status to be returned to the unblocked thread + */ +#define _CORE_RWLock_Flush( _the_rwlock, _remote_extract_callout, _status) \ + _Thread_queue_Flush( \ + &((_the_rwlock)->Wait_queue), \ + (_remote_extract_callout), \ + (_status) \ + ) + +/** + * @brief RWLock specific thread queue timeout. + * + * This routine processes a thread which timeouts while waiting on + * an RWLock's thread queue. It is called by the watchdog handler. + * + * @param[in] id is the Id of thread to timeout + * @param[in] ignored is an unused pointer to a caller defined area + */ + +void _CORE_RWLock_Timeout( + Objects_Id id, + void *ignored +); + +/** + * This method is used to initialize core rwlock attributes. + * + * @param[in] the_attributes pointer to the attributes to initialize. + */ +RTEMS_INLINE_ROUTINE void _CORE_RWLock_Initialize_attributes( + CORE_RWLock_Attributes *the_attributes +) +{ + the_attributes->XXX = 0; +} + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif +/* end of include file */ diff --git a/cpukit/score/inline/rtems/score/corerwlock.inl b/cpukit/score/inline/rtems/score/corerwlock.inl deleted file mode 100644 index d1be4b2589..0000000000 --- a/cpukit/score/inline/rtems/score/corerwlock.inl +++ /dev/null @@ -1,50 +0,0 @@ -/** - * @file - * - * @brief Inlined Routines Associated with the SuperCore RWLock - * - * This include file contains all of the inlined routines associated - * with the SuperCore RWLock. - */ - -/* - * 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_SCORE_CORERWLOCK_H -# error "Never use directly; include instead." -#endif - -#ifndef _RTEMS_SCORE_CORERWLOCK_INL -#define _RTEMS_SCORE_CORERWLOCK_INL - -/** - * @addtogroup ScoreRWLock - */ -/**@{**/ - -#include -#include - -/** - * This method is used to initialize core rwlock attributes. - * - * @param[in] the_attributes pointer to the attributes to initialize. - */ -RTEMS_INLINE_ROUTINE void _CORE_RWLock_Initialize_attributes( - CORE_RWLock_Attributes *the_attributes -) -{ - the_attributes->XXX = 0; -} - - -/** @} */ - -#endif -/* end of include file */ diff --git a/cpukit/score/preinstall.am b/cpukit/score/preinstall.am index bd99d82135..294a05fca1 100644 --- a/cpukit/score/preinstall.am +++ b/cpukit/score/preinstall.am @@ -256,6 +256,10 @@ PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/score/corespinlock.h $(PROJECT_INCLUDE)/rtems/score/corerwlock.h: include/rtems/score/corerwlock.h $(PROJECT_INCLUDE)/rtems/score/$(dirstamp) $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/score/corerwlock.h PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/score/corerwlock.h + +$(PROJECT_INCLUDE)/rtems/score/corerwlockimpl.h: include/rtems/score/corerwlockimpl.h $(PROJECT_INCLUDE)/rtems/score/$(dirstamp) + $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/score/corerwlockimpl.h +PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/score/corerwlockimpl.h endif if HAS_MP $(PROJECT_INCLUDE)/rtems/score/mpci.h: include/rtems/score/mpci.h $(PROJECT_INCLUDE)/rtems/score/$(dirstamp) @@ -359,10 +363,6 @@ if HAS_PTHREADS $(PROJECT_INCLUDE)/rtems/score/corespinlock.inl: inline/rtems/score/corespinlock.inl $(PROJECT_INCLUDE)/rtems/score/$(dirstamp) $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/score/corespinlock.inl PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/score/corespinlock.inl - -$(PROJECT_INCLUDE)/rtems/score/corerwlock.inl: inline/rtems/score/corerwlock.inl $(PROJECT_INCLUDE)/rtems/score/$(dirstamp) - $(INSTALL_DATA) $< $(PROJECT_INCLUDE)/rtems/score/corerwlock.inl -PREINSTALL_FILES += $(PROJECT_INCLUDE)/rtems/score/corerwlock.inl endif if HAS_MP $(PROJECT_INCLUDE)/rtems/score/mppkt.inl: inline/rtems/score/mppkt.inl $(PROJECT_INCLUDE)/rtems/score/$(dirstamp) diff --git a/cpukit/score/src/corerwlock.c b/cpukit/score/src/corerwlock.c index 7ed84a5824..1f70bc662e 100644 --- a/cpukit/score/src/corerwlock.c +++ b/cpukit/score/src/corerwlock.c @@ -19,7 +19,7 @@ #endif #include -#include +#include #include #include #include diff --git a/cpukit/score/src/corerwlockobtainread.c b/cpukit/score/src/corerwlockobtainread.c index 18df39d296..8c13f53465 100644 --- a/cpukit/score/src/corerwlockobtainread.c +++ b/cpukit/score/src/corerwlockobtainread.c @@ -19,7 +19,7 @@ #endif #include -#include +#include #include #include #include diff --git a/cpukit/score/src/corerwlockobtainwrite.c b/cpukit/score/src/corerwlockobtainwrite.c index e2b8806028..8335791545 100644 --- a/cpukit/score/src/corerwlockobtainwrite.c +++ b/cpukit/score/src/corerwlockobtainwrite.c @@ -19,7 +19,7 @@ #endif #include -#include +#include #include #include #include diff --git a/cpukit/score/src/corerwlockrelease.c b/cpukit/score/src/corerwlockrelease.c index bcae4cb502..2bbf1a7238 100644 --- a/cpukit/score/src/corerwlockrelease.c +++ b/cpukit/score/src/corerwlockrelease.c @@ -20,7 +20,7 @@ #endif #include -#include +#include #include #include #include diff --git a/cpukit/score/src/corerwlocktimeout.c b/cpukit/score/src/corerwlocktimeout.c index 3b20364e10..1f5da2e046 100644 --- a/cpukit/score/src/corerwlocktimeout.c +++ b/cpukit/score/src/corerwlocktimeout.c @@ -19,7 +19,7 @@ #endif #include -#include +#include #include void _CORE_RWLock_Timeout( -- cgit v1.2.3