diff options
Diffstat (limited to 'cpukit/posix/include/rtems/posix/pthreadimpl.h')
| -rw-r--r-- | cpukit/posix/include/rtems/posix/pthreadimpl.h | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/cpukit/posix/include/rtems/posix/pthreadimpl.h b/cpukit/posix/include/rtems/posix/pthreadimpl.h new file mode 100644 index 0000000000..1231f01634 --- /dev/null +++ b/cpukit/posix/include/rtems/posix/pthreadimpl.h @@ -0,0 +1,229 @@ +/** + * @file + * + * @brief POSIX Threads Private Support + * + * This include file contains all the private support information for + * POSIX threads. + */ + +/* + * 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_PTHREADIMPL_H +#define _RTEMS_POSIX_PTHREADIMPL_H + +#include <rtems/posix/pthread.h> +#include <rtems/posix/config.h> +#include <rtems/posix/threadsup.h> +#include <rtems/score/thread.h> + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @addtogroup POSIX_PTHREAD + */ +/**@{**/ + +/** + * The following sets the minimum stack size for POSIX threads. + */ +#define PTHREAD_MINIMUM_STACK_SIZE (_Stack_Minimum() * 2) + +/** + * The following defines the information control block used to manage + * this class of objects. + */ +POSIX_EXTERN Objects_Information _POSIX_Threads_Information; + +/** + * This variable contains the default POSIX Thread attributes. + */ +extern const pthread_attr_t _POSIX_Threads_Default_attributes; + +/** + * When the user configures a set of POSIX API initialization threads, + * This variable will point to the method used to initialize them. + * + * NOTE: It is instantiated and initialized by confdefs.h based upon + * application requirements. + */ +extern void (*_POSIX_Threads_Initialize_user_threads_p)(void); + +/** + * @brief POSIX threads manager initialization. + * + * This routine performs the initialization necessary for this manager. + */ +void _POSIX_Threads_Manager_initialization(void); + +/** + * @brief Allocate POSIX thread control block. + * + * This function allocates a pthread control block from + * the inactive chain of free pthread control blocks. + * + * @return This method returns a newly allocated thread. + */ +RTEMS_INLINE_ROUTINE Thread_Control *_POSIX_Threads_Allocate( void ); + +/** + * @brief Free POSIX control block. + * + * This routine frees a pthread control block to the + * inactive chain of free pthread control blocks. + * + * @param[in] the_pthread is a pointer to the thread to free. + */ +RTEMS_INLINE_ROUTINE void _POSIX_Threads_Free( + Thread_Control *the_pthread +); + +/** + * @brief Map POSIX thread IDs to control blocks. + * + * This function maps pthread IDs to pthread control blocks. + * If ID corresponds to a local pthread, then it returns + * the_pthread control pointer which maps to ID and location + * is set to OBJECTS_LOCAL. if the pthread ID is global and + * resides on a remote node, then location is set to OBJECTS_REMOTE, + * and the_pthread is undefined. Otherwise, location is set + * to OBJECTS_ERROR and the_pthread is undefined. + * + * @param[in] id is the id to lookup + * @param[in] location points to the returned location value + * + * @return This methods returns a pointer to the corresponding Thread_Control. + */ +RTEMS_INLINE_ROUTINE Thread_Control *_POSIX_Threads_Get( + pthread_t id, + Objects_Locations *location +); + +/** + * @brief Check if a POSIX thread control block is NULL. + * + * This function returns @c TRUE if the_pthread is @c NULL and @c FALSE + * otherwise. + * + * @param[in] the_pthread is a pointer to the POSIX thread control block + * to check. + * + * @retval TRUE The thread control block is @c NULL. + * @retval FALSE The thread control block is not @c NULL. + */ +RTEMS_INLINE_ROUTINE bool _POSIX_Threads_Is_null( + Thread_Control *the_pthread +); + +/** + * @brief POSIX threads sporadic budget callout. + * + * This routine handles the sporadic scheduling algorithm. + * + * @param[in] the_thread is a pointer to the thread whose budget + * has been exceeded. + */ +void _POSIX_Threads_Sporadic_budget_callout( + Thread_Control *the_thread +); + +/** + * This routine supports the sporadic scheduling algorithm. It + * is scheduled to be executed at the end of each replenishment + * period. In sporadic scheduling a thread will execute at a + * high priority for a user specified amount of CPU time. When + * it exceeds that amount of CPU time, its priority is automatically + * lowered. This TSR is executed when it is time to replenish + * the thread's processor budget and raise its priority. + * + * @param[in] id is ignored + * @param[in] argument is a pointer to the Thread_Control structure + * for the thread being replenished. + */ +void _POSIX_Threads_Sporadic_budget_TSR( + Objects_Id id, + void *argument +); + +/** + * @brief Translate sched_param into SuperCore terms. + * + * This method translates the POSIX API sched_param into the corresponding + * SuperCore settings. + * + * @param[in] policy is the POSIX scheduling policy + * @param[in] param points to the scheduling parameter structure + * @param[in] budget_algorithm points to the output CPU Budget algorithm + * @param[in] budget_callout points to the output CPU Callout + * + * @retval 0 Indicates success. + * @retval error_code POSIX error code indicating failure. + */ +int _POSIX_Thread_Translate_sched_param( + int policy, + struct sched_param *param, + Thread_CPU_budget_algorithms *budget_algorithm, + Thread_CPU_budget_algorithm_callout *budget_callout +); + +/* + * _POSIX_Threads_Allocate + */ + +RTEMS_INLINE_ROUTINE Thread_Control *_POSIX_Threads_Allocate( void ) +{ + return (Thread_Control *) _Objects_Allocate( &_POSIX_Threads_Information ); +} + +/* + * _POSIX_Threads_Free + */ + +RTEMS_INLINE_ROUTINE void _POSIX_Threads_Free ( + Thread_Control *the_pthread +) +{ + _Objects_Free( &_POSIX_Threads_Information, &the_pthread->Object ); +} + +/* + * _POSIX_Threads_Get + */ + +RTEMS_INLINE_ROUTINE Thread_Control *_POSIX_Threads_Get ( + pthread_t id, + Objects_Locations *location +) +{ + return (Thread_Control *) + _Objects_Get( &_POSIX_Threads_Information, (Objects_Id)id, location ); +} + +/* + * _POSIX_Threads_Is_null + */ + +RTEMS_INLINE_ROUTINE bool _POSIX_Threads_Is_null ( + Thread_Control *the_pthread +) +{ + return !the_pthread; +} + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif +/* end of include file */ |