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 /** ThreadX Component */ 16 /** */ 17 /** Semaphore */ 18 /** */ 19 /**************************************************************************/ 20 /**************************************************************************/ 21 22 #define TX_SOURCE_CODE 23 24 25 /* Include necessary system files. */ 26 27 #include "tx_api.h" 28 #include "tx_thread.h" 29 #include "tx_semaphore.h" 30 31 32 /**************************************************************************/ 33 /* */ 34 /* FUNCTION RELEASE */ 35 /* */ 36 /* _tx_semaphore_cleanup PORTABLE C */ 37 /* 6.1 */ 38 /* AUTHOR */ 39 /* */ 40 /* William E. Lamie, Microsoft Corporation */ 41 /* */ 42 /* DESCRIPTION */ 43 /* */ 44 /* This function processes semaphore timeout and thread terminate */ 45 /* actions that require the semaphore data structures to be cleaned */ 46 /* up. */ 47 /* */ 48 /* INPUT */ 49 /* */ 50 /* thread_ptr Pointer to suspended thread's */ 51 /* control block */ 52 /* */ 53 /* OUTPUT */ 54 /* */ 55 /* None */ 56 /* */ 57 /* CALLS */ 58 /* */ 59 /* _tx_thread_system_resume Resume thread service */ 60 /* _tx_thread_system_ni_resume Non-interruptable resume thread */ 61 /* */ 62 /* CALLED BY */ 63 /* */ 64 /* _tx_thread_timeout Thread timeout processing */ 65 /* _tx_thread_terminate Thread terminate processing */ 66 /* _tx_thread_wait_abort Thread wait abort processing */ 67 /* */ 68 /* RELEASE HISTORY */ 69 /* */ 70 /* DATE NAME DESCRIPTION */ 71 /* */ 72 /* 05-19-2020 William E. Lamie Initial Version 6.0 */ 73 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 74 /* resulting in version 6.1 */ 75 /* */ 76 /**************************************************************************/ _tx_semaphore_cleanup(TX_THREAD * thread_ptr,ULONG suspension_sequence)77VOID _tx_semaphore_cleanup(TX_THREAD *thread_ptr, ULONG suspension_sequence) 78 { 79 80 #ifndef TX_NOT_INTERRUPTABLE 81 TX_INTERRUPT_SAVE_AREA 82 #endif 83 84 TX_SEMAPHORE *semaphore_ptr; 85 UINT suspended_count; 86 TX_THREAD *next_thread; 87 TX_THREAD *previous_thread; 88 89 90 91 #ifndef TX_NOT_INTERRUPTABLE 92 93 /* Disable interrupts to remove the suspended thread from the semaphore. */ 94 TX_DISABLE 95 96 /* Determine if the cleanup is still required. */ 97 if (thread_ptr -> tx_thread_suspend_cleanup == &(_tx_semaphore_cleanup)) 98 { 99 100 /* Check for valid suspension sequence. */ 101 if (suspension_sequence == thread_ptr -> tx_thread_suspension_sequence) 102 { 103 104 /* Setup pointer to semaphore control block. */ 105 semaphore_ptr = TX_VOID_TO_SEMAPHORE_POINTER_CONVERT(thread_ptr -> tx_thread_suspend_control_block); 106 107 /* Check for a NULL semaphore pointer. */ 108 if (semaphore_ptr != TX_NULL) 109 { 110 111 /* Check for a valid semaphore ID. */ 112 if (semaphore_ptr -> tx_semaphore_id == TX_SEMAPHORE_ID) 113 { 114 115 /* Determine if there are any thread suspensions. */ 116 if (semaphore_ptr -> tx_semaphore_suspended_count != TX_NO_SUSPENSIONS) 117 { 118 #else 119 120 /* Setup pointer to semaphore control block. */ 121 semaphore_ptr = TX_VOID_TO_SEMAPHORE_POINTER_CONVERT(thread_ptr -> tx_thread_suspend_control_block); 122 #endif 123 124 /* Yes, we still have thread suspension! */ 125 126 /* Clear the suspension cleanup flag. */ 127 thread_ptr -> tx_thread_suspend_cleanup = TX_NULL; 128 129 /* Decrement the suspended count. */ 130 semaphore_ptr -> tx_semaphore_suspended_count--; 131 132 /* Pickup the suspended count. */ 133 suspended_count = semaphore_ptr -> tx_semaphore_suspended_count; 134 135 /* Remove the suspended thread from the list. */ 136 137 /* See if this is the only suspended thread on the list. */ 138 if (suspended_count == TX_NO_SUSPENSIONS) 139 { 140 141 /* Yes, the only suspended thread. */ 142 143 /* Update the head pointer. */ 144 semaphore_ptr -> tx_semaphore_suspension_list = TX_NULL; 145 } 146 else 147 { 148 149 /* At least one more thread is on the same suspension list. */ 150 151 /* Update the links of the adjacent threads. */ 152 next_thread = thread_ptr -> tx_thread_suspended_next; 153 previous_thread = thread_ptr -> tx_thread_suspended_previous; 154 next_thread -> tx_thread_suspended_previous = previous_thread; 155 previous_thread -> tx_thread_suspended_next = next_thread; 156 157 /* Determine if we need to update the head pointer. */ 158 if (semaphore_ptr -> tx_semaphore_suspension_list == thread_ptr) 159 { 160 161 /* Update the list head pointer. */ 162 semaphore_ptr -> tx_semaphore_suspension_list = next_thread; 163 } 164 } 165 166 /* Now we need to determine if this cleanup is from a terminate, timeout, 167 or from a wait abort. */ 168 if (thread_ptr -> tx_thread_state == TX_SEMAPHORE_SUSP) 169 { 170 171 /* Timeout condition and the thread is still suspended on the semaphore. 172 Setup return error status and resume the thread. */ 173 174 #ifdef TX_SEMAPHORE_ENABLE_PERFORMANCE_INFO 175 176 /* Increment the total timeouts counter. */ 177 _tx_semaphore_performance_timeout_count++; 178 179 /* Increment the number of timeouts on this semaphore. */ 180 semaphore_ptr -> tx_semaphore_performance_timeout_count++; 181 #endif 182 183 /* Setup return status. */ 184 thread_ptr -> tx_thread_suspend_status = TX_NO_INSTANCE; 185 186 #ifdef TX_NOT_INTERRUPTABLE 187 188 /* Resume the thread! */ 189 _tx_thread_system_ni_resume(thread_ptr); 190 #else 191 192 /* Temporarily disable preemption. */ 193 _tx_thread_preempt_disable++; 194 195 /* Restore interrupts. */ 196 TX_RESTORE 197 198 /* Resume the thread! */ 199 _tx_thread_system_resume(thread_ptr); 200 201 /* Disable interrupts. */ 202 TX_DISABLE 203 #endif 204 } 205 #ifndef TX_NOT_INTERRUPTABLE 206 } 207 } 208 } 209 } 210 } 211 212 /* Restore interrupts. */ 213 TX_RESTORE 214 #endif 215 } 216 217
