Sample Code
Windows Driver Samples/ Windows Filtering Platform Sample/ C++/ lib/ HelperFunctions_ThreadsAndEvents.cpp/
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 | //////////////////////////////////////////////////////////////////////////////////////////////////////// Copyright (c) 2012 Microsoft Corporation. All Rights Reserved.//// Module Name:// HelperFunctions_ThreadsAndEvents.cpp//// Abstract:// This module contains functions which functions which simplify threads and eventing.//// Naming Convention://// <Scope><Module><Object><Action><Modifier>// // i.e.//// <Scope>// {// - Function is likely visible to other modules// }// <Module>// {// Hlpr - Function is from HelperFunctions_* Modules.// }// <Object>// {// Event - Function pertains to events.// Thread - Function pertains to threads.// }// <Action>// {// Cleanup -// Set -// Start - // Stop -// Wait -// }// <Modifier>// {// ForCompletion -// ForEvent - Function determines equality between values.// }//// Private Functions://// Public Functions://// Author:// Dusty Harper (DHarper)//// Revision History://// [ Month ][Day] [Year] - [Revision]-[ Comments ]// May 01, 2010 - 1.0 - Creation//////////////////////////////////////////////////////////////////////////////////////////////////////#include "HelperFunctions_Include.h" /// ./** @helper_function="HlprEventReset" Purpose: Sets the event to nonsignaled. <br> <br> Notes: <br> <br>*/VOID HlprEventReset(_In_opt_ HANDLE event){ if(event) ResetEvent(event); return;}/** @helper_function="HlprEventSet" Purpose: Signals an event. <br> <br> Notes: <br> <br>*/VOID HlprEventSet(_In_opt_ HANDLE event){ if(event) SetEvent(event); return;}/** @helper_function="HlprThreadStart" Purpose: Generates a new thread. <br> <br> Notes: <br> <br>*/_Success_(return == NO_ERROR)UINT32 HlprThreadStart(_Inout_ THREAD_DATA* pThreadData, _In_opt_ VOID* pData) /* 0 */{ UINT32 status = NO_ERROR; if(pThreadData) { HlprThreadCleanup(pThreadData); if(pThreadData->threadStartRoutine) { pThreadData->threadStartEvent = CreateEvent(0, TRUE, FALSE, 0); pThreadData->threadStopEvent = CreateEvent(0, TRUE, FALSE, 0); pThreadData->threadContinueEvent = CreateEvent(0, TRUE, FALSE, 0); pThreadData->thread = CreateThread(0, 0, (LPTHREAD_START_ROUTINE)pThreadData->threadStartRoutine, pData ? pData : pThreadData, 0, (LPDWORD)&(pThreadData->threadId)); if(pThreadData->threadStartEvent && pThreadData->threadStopEvent && pThreadData->threadContinueEvent && pThreadData->thread) HlprThreadWaitForEvent(pThreadData->threadStartEvent, pThreadData); else { status = ERROR_GEN_FAILURE; HlprThreadCleanup(pThreadData); HlprLogError(L"HlprThreadStart() [status: %#x]", status); } } else { status = ERROR_INVALID_DATA; HlprLogError(L"HlprThreadStart() [status: %#x][pThreadData->threadStartRoutine: %#x]", status, pThreadData->threadStartRoutine); } } else { status = ERROR_INVALID_PARAMETER; HlprLogError(L"HlprThreadStart() [status: %#x][pThread: %#x]", status, pThreadData); } return status;}/** @helper_function="HlprThreadStop" Purpose: Signals a thread to stop and cleans it up. <br> <br> Notes: <br> <br> MSDN_Ref: HTTP://MSDN.Microsoft.com/En-Us/Library/Windows/Desktop/MS682396.aspx <br> <br>*/_Success_(return == NO_ERROR)UINT32 HlprThreadStop(_Inout_ THREAD_DATA* pThreadData){ UINT32 status = NO_ERROR; const UINT32 RETRY_ATTEMPTS = 5; if(pThreadData) { for(UINT32 i = 0; status != WAIT_TIMEOUT && i < RETRY_ATTEMPTS; i++) { HlprEventSet(pThreadData->threadStopEvent); status = HlprThreadWaitForCompletion(pThreadData); } HlprThreadCleanup(pThreadData); } return status;}/** @helper_function="HlprThreadStop" Purpose: Signals a thread to stop and cleans it up, and frees any allocated memory. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/_At_(*ppThreadData, _Pre_ _Notnull_)_When_(return != NO_ERROR, _At_(*ppThreadData, _Post_ _Notnull_))_When_(return == NO_ERROR, _At_(*ppThreadData, _Post_ _Null_))_Success_(return == NO_ERROR && *ppThreadData == 0)UINT32 HlprThreadStop(_Inout_ THREAD_DATA** ppThreadData){ UINT32 status = NO_ERROR; if(ppThreadData) { status = HlprThreadStop(*ppThreadData); if(status == NO_ERROR) { HLPR_DELETE(*ppThreadData) } } return status;}/** @helper_function="HlprThreadCleanup" Purpose: Cleans up a previously allocated thread. <br> <br> Notes: <br> <br>*/VOID HlprThreadCleanup(_Inout_opt_ THREAD_DATA* pThreadData){ if(pThreadData) { LPTHREAD_START_ROUTINE threadStartRoutine = pThreadData->threadStartRoutine; UINT32 status = NO_ERROR; if(pThreadData->thread) { if(GetExitCodeThread(pThreadData->thread, (DWORD*)&status)) { if(status == STILL_ACTIVE) { UINT64 timeAlpha = GetTickCount64(); const UINT32 FOUR_MINUTES = 240000; for(UINT64 timeOmega = GetTickCount64(); timeOmega - timeAlpha < FOUR_MINUTES; timeOmega = GetTickCount64()) { HlprEventSet(pThreadData->threadStopEvent); status = HlprThreadWaitForCompletion(pThreadData); if(status == NO_ERROR) break; } if(status != NO_ERROR) { HlprLogInfo(L"Possible Runaway Thread");#pragma warning(push)#pragma warning(disable: 6258) /// This is a last resort TerminateThread(pThreadData->thread, ERROR_THREAD_WAS_SUSPENDED);#pragma warning(pop) } } } else { status = GetLastError(); HlprLogError(L"HlprThreadCleanup() [status:%#x]", status); } } HLPR_CLOSE_HANDLE(pThreadData->threadStopEvent); HLPR_CLOSE_HANDLE(pThreadData->threadStartEvent); HLPR_CLOSE_HANDLE(pThreadData->threadContinueEvent); ZeroMemory(pThreadData, sizeof(THREAD_DATA)); pThreadData->threadStartRoutine = threadStartRoutine; } return;}/** @helper_function="HlprThreadWaitForCompletion" Purpose: Waits for a thread to complete. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/_Success_(return == NO_ERROR)UINT32 HlprThreadWaitForCompletion(_Inout_opt_ THREAD_DATA* pThreadData){ UINT32 status = NO_ERROR; if(pThreadData) { HlprEventSet(pThreadData->threadStopEvent); status = HlprThreadWaitForEvent(pThreadData->thread, pThreadData); } return status;}/** @helper_function="HlprThreadWaitForEvent" Purpose: Waits for a particular event to be set within the thread. <br> <br> Notes: <br> <br> MSDN_Ref: <br>*/_Success_(return == NO_ERROR)UINT32 HlprThreadWaitForEvent(_In_ HANDLE eventHandle, _In_ THREAD_DATA* pThreadData){ UINT32 status = NO_ERROR; const UINT32 RETRY_ATTEMPTS = 6; WCHAR* pEventName = 0; if(eventHandle && pThreadData) { if(eventHandle == pThreadData->threadContinueEvent) pEventName = L"Continue Event"; else if(eventHandle == pThreadData->threadStartEvent) pEventName = L"Start Event"; else if(eventHandle == pThreadData->threadStopEvent) pEventName = L"Stop Event"; else if(eventHandle == pThreadData->thread) pEventName = L"Thread"; /// Try for 30 seconds before bailing for(UINT32 i = 0; WaitForSingleObject(eventHandle, 5000) == WAIT_TIMEOUT; i++) { HlprLogInfo(L"HlprThreadWaitForEvent() Waiting for %s ...", pEventName); if(i == RETRY_ATTEMPTS - 1) { status = WAIT_TIMEOUT; HlprLogInfo(L"HlprThreadWaitForEvent() [status: %#x]"); break; } } } return status;} |
Our Services
-
What our customers say about us?
Read our customer testimonials to find out why our clients keep returning for their projects.
View Testimonials
