rtems/posix/threadsup.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @brief POSIX Thread API Support
0007  *
0008  * This defines the POSIX thread API extension.
0009  */
0010
0011 /*
0012  *  COPYRIGHT (c) 1989-2014.
0013  *  On-Line Applications Research Corporation (OAR).
0014  *
0015  * Redistribution and use in source and binary forms, with or without
0016  * modification, are permitted provided that the following conditions
0017  * are met:
0018  * 1. Redistributions of source code must retain the above copyright
0019  *    notice, this list of conditions and the following disclaimer.
0020  * 2. Redistributions in binary form must reproduce the above copyright
0021  *    notice, this list of conditions and the following disclaimer in the
0022  *    documentation and/or other materials provided with the distribution.
0023  *
0024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0027  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0028  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0029  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0030  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0031  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0032  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0033  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0034  * POSSIBILITY OF SUCH DAMAGE.
0035  */
0036
0037 #ifndef _RTEMS_POSIX_THREADSUP_H
0038 #define _RTEMS_POSIX_THREADSUP_H
0039
0040 #include <rtems/score/thread.h>
0041 #include <rtems/score/watchdog.h>
0042
0043 #include <pthread.h>
0044 #include <signal.h>
0045
0046 /**
0047  *  @defgroup POSIX_THREAD POSIX Thread API Extension
0048  *
0049  *  @ingroup POSIXAPI
0050  *
0051  */
0052 /**@{**/
0053 #ifdef __cplusplus
0054 extern "C" {
0055 #endif
0056
0057 #if defined(RTEMS_POSIX_API)
0058 /**
0059  * This defines the POSIX API support structure associated with
0060  * each thread in a system with POSIX configured.
0061  */
0062 typedef struct {
0063   /**
0064    * @brief Control block for the sporadic server scheduling policy.
0065    */
0066   struct {
0067     /** The thread of this sporadic control block */
0068     Thread_Control *thread;
0069
0070     /**
0071      * @brief This is the timer which controls when the thread executes at high
0072      * and low priority when using the sporadic server scheduling policy.
0073      */
0074     Watchdog_Control Timer;
0075
0076     /**
0077      * @brief The low priority when using the sporadic server scheduling
0078      * policy.
0079      */
0080     Priority_Node Low_priority;
0081
0082     /**
0083      * @brief Replenishment period for sporadic server.
0084      */
0085     struct timespec sched_ss_repl_period;
0086
0087     /**
0088      * @brief Initial budget for sporadic server.
0089      */
0090     struct timespec sched_ss_init_budget;
0091
0092     /**
0093      * @brief Maximum pending replenishments.
0094      *
0095      * Only used by pthread_getschedparam() and pthread_getattr_np().
0096     */
0097     int sched_ss_max_repl;
0098   } Sporadic;
0099
0100   /** This is the set of signals which are currently unblocked. */
0101   sigset_t                signals_unblocked;
0102   /** This is the set of signals which are currently pending. */
0103   sigset_t                signals_pending;
0104
0105   /**
0106    * @brief Signal post-switch action in case signals are pending.
0107    */
0108   Thread_Action           Signal_action;
0109 } POSIX_API_Control;
0110 #endif
0111
0112 /** @} */
0113
0114 #ifdef __cplusplus
0115 }
0116 #endif
0117
0118 #endif
0119 /* end of include file */