1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** POSIX wrapper for THREADX                                             */
16 /**                                                                       */
17 /**                                                                       */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 /* Include necessary system files.  */
23 
24 #include "tx_api.h"     /* Threadx API */
25 #include "pthread.h"    /* Posix API */
26 #include "px_int.h"     /* Posix helper functions */
27 
28 
29 /**************************************************************************/
30 /*                                                                        */
31 /*  FUNCTION                                               RELEASE        */
32 /*                                                                        */
33 /*    posix_in_thread_context                              PORTABLE C     */
34 /*                                                           6.1.7        */
35 /*  AUTHOR                                                                */
36 /*                                                                        */
37 /*    William E. Lamie, Microsoft Corporation                             */
38 /*                                                                        */
39 /*  DESCRIPTION                                                           */
40 /*                                                                        */
41 /*    This function determines if the system is currently in "thread"     */
42 /*      context, i.e. not timer routine, not ISR, not idling.             */
43 /*                                                                        */
44 /*  INPUT                                                                 */
45 /*                                                                        */
46 /*    None                                                                */
47 /*                                                                        */
48 /*  OUTPUT                                                                */
49 /*                                                                        */
50 /*    TX_TRUE | TX_FALSE                                                  */
51 /*                                                                        */
52 /*  CALLS                                                                 */
53 /*                                                                        */
54 /*    None                                                                */
55 /*                                                                        */
56 /*  CALLED BY                                                             */
57 /*                                                                        */
58 /*    posix internal code                                                 */
59 /*                                                                        */
60 /*  RELEASE HISTORY                                                       */
61 /*                                                                        */
62 /*    DATE              NAME                      DESCRIPTION             */
63 /*                                                                        */
64 /*  06-02-2021     William E. Lamie         Initial Version 6.1.7         */
65 /*                                                                        */
66 /**************************************************************************/
posix_in_thread_context(VOID)67 ULONG  posix_in_thread_context(VOID)
68 {
69     /* External variables, defined within ThreadX, needed here. */
70     extern    TX_THREAD *     _tx_thread_current_ptr;
71     extern    ULONG           _tx_thread_system_state;
72 #ifndef TX_TIMER_PROCESS_IN_ISR
73     extern    TX_THREAD       _tx_timer_thread;
74 #endif
75 
76     /*     Return TX_FALSE if any of the following are true:
77          - we are in the scheduling loop (not in a thread);
78          - we are in an ISR
79          - we are in a timer routine
80            Return TX_TRUE otherwise (we are in a thread.)
81    */
82 
83     if (_tx_thread_system_state == TX_INITIALIZE_IN_PROGRESS)
84     {
85 
86         /* We are calling from initialization, return TRUE.  */
87         return(TX_TRUE);
88     }
89     else if ((!_tx_thread_current_ptr)                  /* Not in a thread */
90              || (_tx_thread_system_state)               /* In an ISR       */
91 #ifndef TX_TIMER_PROCESS_IN_ISR
92                                                         /* Timer routine   */
93              || (_tx_thread_current_ptr == &_tx_timer_thread)
94 #endif
95             )
96 
97     {
98         /* We are NOT in thread (thread) context.  */
99         return (TX_FALSE);
100     }
101     else
102     {
103         /* We ARE in thread (thread) context.  */
104         return (TX_TRUE);
105     }
106 }
107