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 /** Queue */ 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_queue.h" 30 31 32 /**************************************************************************/ 33 /* */ 34 /* FUNCTION RELEASE */ 35 /* */ 36 /* _tx_queue_cleanup PORTABLE C */ 37 /* 6.1 */ 38 /* AUTHOR */ 39 /* */ 40 /* William E. Lamie, Microsoft Corporation */ 41 /* */ 42 /* DESCRIPTION */ 43 /* */ 44 /* This function processes queue timeout and thread terminate */ 45 /* actions that require the queue 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_queue_cleanup(TX_THREAD * thread_ptr,ULONG suspension_sequence)77VOID _tx_queue_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_QUEUE *queue_ptr; 85 UINT suspended_count; 86 TX_THREAD *next_thread; 87 TX_THREAD *previous_thread; 88 89 90 #ifndef TX_NOT_INTERRUPTABLE 91 92 /* Disable interrupts to remove the suspended thread from the queue. */ 93 TX_DISABLE 94 95 /* Determine if the cleanup is still required. */ 96 if (thread_ptr -> tx_thread_suspend_cleanup == &(_tx_queue_cleanup)) 97 { 98 99 /* Check for valid suspension sequence. */ 100 if (suspension_sequence == thread_ptr -> tx_thread_suspension_sequence) 101 { 102 103 /* Setup pointer to queue control block. */ 104 queue_ptr = TX_VOID_TO_QUEUE_POINTER_CONVERT(thread_ptr -> tx_thread_suspend_control_block); 105 106 /* Check for NULL queue pointer. */ 107 if (queue_ptr != TX_NULL) 108 { 109 110 /* Is the queue ID valid? */ 111 if (queue_ptr -> tx_queue_id == TX_QUEUE_ID) 112 { 113 114 /* Determine if there are any thread suspensions. */ 115 if (queue_ptr -> tx_queue_suspended_count != TX_NO_SUSPENSIONS) 116 { 117 #else 118 119 /* Setup pointer to queue control block. */ 120 queue_ptr = TX_VOID_TO_QUEUE_POINTER_CONVERT(thread_ptr -> tx_thread_suspend_control_block); 121 #endif 122 123 /* Yes, we still have thread suspension! */ 124 125 /* Clear the suspension cleanup flag. */ 126 thread_ptr -> tx_thread_suspend_cleanup = TX_NULL; 127 128 /* Decrement the suspended count. */ 129 queue_ptr -> tx_queue_suspended_count--; 130 131 /* Pickup the suspended count. */ 132 suspended_count = queue_ptr -> tx_queue_suspended_count; 133 134 /* Remove the suspended thread from the list. */ 135 136 /* See if this is the only suspended thread on the list. */ 137 if (suspended_count == TX_NO_SUSPENSIONS) 138 { 139 140 /* Yes, the only suspended thread. */ 141 142 /* Update the head pointer. */ 143 queue_ptr -> tx_queue_suspension_list = TX_NULL; 144 } 145 else 146 { 147 148 /* At least one more thread is on the same suspension list. */ 149 150 /* Update the links of the adjacent threads. */ 151 next_thread = thread_ptr -> tx_thread_suspended_next; 152 previous_thread = thread_ptr -> tx_thread_suspended_previous; 153 next_thread -> tx_thread_suspended_previous = previous_thread; 154 previous_thread -> tx_thread_suspended_next = next_thread; 155 156 /* Determine if we need to update the head pointer. */ 157 if (queue_ptr -> tx_queue_suspension_list == thread_ptr) 158 { 159 160 /* Update the list head pointer. */ 161 queue_ptr -> tx_queue_suspension_list = next_thread; 162 } 163 } 164 165 /* Now we need to determine if this cleanup is from a terminate, timeout, 166 or from a wait abort. */ 167 if (thread_ptr -> tx_thread_state == TX_QUEUE_SUSP) 168 { 169 170 /* Timeout condition and the thread still suspended on the queue. 171 Setup return error status and resume the thread. */ 172 173 #ifdef TX_QUEUE_ENABLE_PERFORMANCE_INFO 174 175 /* Increment the total timeouts counter. */ 176 _tx_queue_performance_timeout_count++; 177 178 /* Increment the number of timeouts on this queue. */ 179 queue_ptr -> tx_queue_performance_timeout_count++; 180 #endif 181 182 /* Setup return status. */ 183 if (queue_ptr -> tx_queue_enqueued != TX_NO_MESSAGES) 184 { 185 186 /* Queue full timeout! */ 187 thread_ptr -> tx_thread_suspend_status = TX_QUEUE_FULL; 188 } 189 else 190 { 191 192 /* Queue empty timeout! */ 193 thread_ptr -> tx_thread_suspend_status = TX_QUEUE_EMPTY; 194 } 195 196 #ifdef TX_NOT_INTERRUPTABLE 197 198 /* Resume the thread! */ 199 _tx_thread_system_ni_resume(thread_ptr); 200 #else 201 202 /* Temporarily disable preemption. */ 203 _tx_thread_preempt_disable++; 204 205 /* Restore interrupts. */ 206 TX_RESTORE 207 208 /* Resume the thread! */ 209 _tx_thread_system_resume(thread_ptr); 210 211 /* Disable interrupts. */ 212 TX_DISABLE 213 #endif 214 } 215 #ifndef TX_NOT_INTERRUPTABLE 216 } 217 } 218 } 219 } 220 } 221 222 /* Restore interrupts. */ 223 TX_RESTORE 224 #endif 225 } 226 227
