summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/rtems/posix/rwlockimpl.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/posix/include/rtems/posix/rwlockimpl.h')
-rw-r--r--cpukit/posix/include/rtems/posix/rwlockimpl.h140
1 files changed, 140 insertions, 0 deletions
diff --git a/cpukit/posix/include/rtems/posix/rwlockimpl.h b/cpukit/posix/include/rtems/posix/rwlockimpl.h
new file mode 100644
index 0000000000..5911a8fd41
--- /dev/null
+++ b/cpukit/posix/include/rtems/posix/rwlockimpl.h
@@ -0,0 +1,140 @@
+/**
+ * @file
+ *
+ * @brief Inlined Routines from the POSIX RWLock Manager
+ *
+ * This file contains the static inlin implementation of the inlined
+ * routines from the POSIX RWLock Manager.
+ */
+
+/*
+ * COPYRIGHT (c) 1989-2011.
+ * 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_POSIX_RWLOCKIMPL_H
+#define _RTEMS_POSIX_RWLOCKIMPL_H
+
+#include <rtems/posix/rwlock.h>
+
+#include <pthread.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * The following defines the information control block used to manage
+ * this class of objects.
+ */
+
+POSIX_EXTERN Objects_Information _POSIX_RWLock_Information;
+
+/**
+ * @brief POSIX RWLock manager initialization.
+ *
+ * This routine performs the initialization necessary for this manager.
+ */
+
+void _POSIX_RWLock_Manager_initialization(void);
+
+/**
+ * @brief POSIX translate core RWLock return code.
+ *
+ * This routine translates SuperCore RWLock status codes into the
+ * corresponding POSIX ones.
+ *
+ *
+ * @param[in] the_RWLock_status is the SuperCore status.
+ *
+ * @return the corresponding POSIX status
+ * @retval 0 The status indicates that the operation completed successfully.
+ * @retval EINVAL The status indicates that the thread was blocked waiting for
+ * an operation to complete and the RWLock was deleted.
+ * @retval EBUSY This status indicates that the RWLock was not
+ * immediately available.
+ * @retval ETIMEDOUT 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.
+ */
+int _POSIX_RWLock_Translate_core_RWLock_return_code(
+ CORE_RWLock_Status the_RWLock_status
+);
+
+/**
+ * @brief Allocate a RWLock control block.
+ *
+ * This function allocates a RWLock control block from
+ * the inactive chain of free RWLock control blocks.
+ */
+RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Allocate( void )
+{
+ return (POSIX_RWLock_Control *)
+ _Objects_Allocate( &_POSIX_RWLock_Information );
+}
+
+/**
+ * @brief Free a RWLock control block.
+ *
+ * This routine frees a RWLock control block to the
+ * inactive chain of free RWLock control blocks.
+ */
+RTEMS_INLINE_ROUTINE void _POSIX_RWLock_Free (
+ POSIX_RWLock_Control *the_RWLock
+)
+{
+ _Objects_Free( &_POSIX_RWLock_Information, &the_RWLock->Object );
+}
+
+/**
+ * @brief Get a RWLock control block.
+ *
+ * This function maps RWLock IDs to RWLock control blocks.
+ * If ID corresponds to a local RWLock, then it returns
+ * the_RWLock control pointer which maps to ID and location
+ * is set to OBJECTS_LOCAL. if the RWLock ID is global and
+ * resides on a remote node, then location is set to OBJECTS_REMOTE,
+ * and the_RWLock is undefined. Otherwise, location is set
+ * to OBJECTS_ERROR and the_RWLock is undefined.
+ */
+RTEMS_INLINE_ROUTINE POSIX_RWLock_Control *_POSIX_RWLock_Get (
+ pthread_rwlock_t *RWLock,
+ Objects_Locations *location
+)
+{
+ return (POSIX_RWLock_Control *) _Objects_Get(
+ &_POSIX_RWLock_Information,
+ (Objects_Id) *RWLock,
+ location
+ );
+}
+
+/**
+ * @brief Check if a RWLock control block is NULL.
+ *
+ * This function returns @c TRUE if the_RWLock is @c NULL and @c FALSE
+ * otherwise.
+ *
+ * @param[in] the_RWLock is the pointer to the RWLock control block
+ * to be checked.
+ *
+ * @retval TRUE The RWLock control block is @c NULL.
+ * @retval FALSE The RWLock control block is not @c NULL.
+ */
+RTEMS_INLINE_ROUTINE bool _POSIX_RWLock_Is_null (
+ POSIX_RWLock_Control *the_RWLock
+)
+{
+ return ( the_RWLock == NULL );
+}
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif
+/* end of include file */