1 /**************************************************************************/ 2 /* */ 3 /* Copyright (c) Microsoft Corporation. All rights reserved. */ 4 /* */ 5 /* This software is licensed under the Microsoft Software License */ 6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */ 7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ 8 /* and in the root directory of this software. */ 9 /* */ 10 /**************************************************************************/ 11 12 13 /**************************************************************************/ 14 /**************************************************************************/ 15 /** */ 16 /** ThreadX Component */ 17 /** */ 18 /** Queue */ 19 /** */ 20 /**************************************************************************/ 21 /**************************************************************************/ 22 23 #define TX_SOURCE_CODE 24 25 26 /* Include necessary system files. */ 27 28 #include "tx_api.h" 29 #include "tx_thread.h" 30 #include "tx_queue.h" 31 32 33 /**************************************************************************/ 34 /* */ 35 /* FUNCTION RELEASE */ 36 /* */ 37 /* _tx_queue_cleanup PORTABLE C */ 38 /* 6.1 */ 39 /* AUTHOR */ 40 /* */ 41 /* William E. Lamie, Microsoft Corporation */ 42 /* */ 43 /* DESCRIPTION */ 44 /* */ 45 /* This function processes queue timeout and thread terminate */ 46 /* actions that require the queue data structures to be cleaned */ 47 /* up. */ 48 /* */ 49 /* INPUT */ 50 /* */ 51 /* thread_ptr Pointer to suspended thread's */ 52 /* control block */ 53 /* */ 54 /* OUTPUT */ 55 /* */ 56 /* None */ 57 /* */ 58 /* CALLS */ 59 /* */ 60 /* _tx_thread_system_resume Resume thread service */ 61 /* _tx_thread_system_ni_resume Non-interruptable resume thread */ 62 /* */ 63 /* CALLED BY */ 64 /* */ 65 /* _tx_thread_timeout Thread timeout processing */ 66 /* _tx_thread_terminate Thread terminate processing */ 67 /* _tx_thread_wait_abort Thread wait abort processing */ 68 /* */ 69 /* RELEASE HISTORY */ 70 /* */ 71 /* DATE NAME DESCRIPTION */ 72 /* */ 73 /* 05-19-2020 William E. Lamie Initial Version 6.0 */ 74 /* 09-30-2020 Yuxin Zhou Modified comment(s), */ 75 /* resulting in version 6.1 */ 76 /* */ 77 /**************************************************************************/ _tx_queue_cleanup(TX_THREAD * thread_ptr,ULONG suspension_sequence)78VOID _tx_queue_cleanup(TX_THREAD *thread_ptr, ULONG suspension_sequence) 79 { 80 81 #ifndef TX_NOT_INTERRUPTABLE 82 TX_INTERRUPT_SAVE_AREA 83 #endif 84 85 TX_QUEUE *queue_ptr; 86 UINT suspended_count; 87 TX_THREAD *next_thread; 88 TX_THREAD *previous_thread; 89 90 91 #ifndef TX_NOT_INTERRUPTABLE 92 93 /* Disable interrupts to remove the suspended thread from the queue. */ 94 TX_DISABLE 95 96 /* Determine if the cleanup is still required. */ 97 if (thread_ptr -> tx_thread_suspend_cleanup == &(_tx_queue_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 queue control block. */ 105 queue_ptr = TX_VOID_TO_QUEUE_POINTER_CONVERT(thread_ptr -> tx_thread_suspend_control_block); 106 107 /* Check for NULL queue pointer. */ 108 if (queue_ptr != TX_NULL) 109 { 110 111 /* Is the queue ID valid? */ 112 if (queue_ptr -> tx_queue_id == TX_QUEUE_ID) 113 { 114 115 /* Determine if there are any thread suspensions. */ 116 if (queue_ptr -> tx_queue_suspended_count != TX_NO_SUSPENSIONS) 117 { 118 #else 119 120 /* Setup pointer to queue control block. */ 121 queue_ptr = TX_VOID_TO_QUEUE_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 queue_ptr -> tx_queue_suspended_count--; 131 132 /* Pickup the suspended count. */ 133 suspended_count = queue_ptr -> tx_queue_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 queue_ptr -> tx_queue_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 (queue_ptr -> tx_queue_suspension_list == thread_ptr) 159 { 160 161 /* Update the list head pointer. */ 162 queue_ptr -> tx_queue_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_QUEUE_SUSP) 169 { 170 171 /* Timeout condition and the thread still suspended on the queue. 172 Setup return error status and resume the thread. */ 173 174 #ifdef TX_QUEUE_ENABLE_PERFORMANCE_INFO 175 176 /* Increment the total timeouts counter. */ 177 _tx_queue_performance_timeout_count++; 178 179 /* Increment the number of timeouts on this queue. */ 180 queue_ptr -> tx_queue_performance_timeout_count++; 181 #endif 182 183 /* Setup return status. */ 184 if (queue_ptr -> tx_queue_enqueued != TX_NO_MESSAGES) 185 { 186 187 /* Queue full timeout! */ 188 thread_ptr -> tx_thread_suspend_status = TX_QUEUE_FULL; 189 } 190 else 191 { 192 193 /* Queue empty timeout! */ 194 thread_ptr -> tx_thread_suspend_status = TX_QUEUE_EMPTY; 195 } 196 197 #ifdef TX_NOT_INTERRUPTABLE 198 199 /* Resume the thread! */ 200 _tx_thread_system_ni_resume(thread_ptr); 201 #else 202 203 /* Temporarily disable preemption. */ 204 _tx_thread_preempt_disable++; 205 206 /* Restore interrupts. */ 207 TX_RESTORE 208 209 /* Resume the thread! */ 210 _tx_thread_system_resume(thread_ptr); 211 212 /* Disable interrupts. */ 213 TX_DISABLE 214 #endif 215 } 216 #ifndef TX_NOT_INTERRUPTABLE 217 } 218 } 219 } 220 } 221 } 222 223 /* Restore interrupts. */ 224 TX_RESTORE 225 #endif 226 } 227 228
