source: trunk/src/kernel32/overlappedio.cpp@ 7605

Last change on this file since 7605 was 7605, checked in by sandervl, 24 years ago

overlapped io updates/fixes
File size: 21.0 KB
Line 
1/* $Id: overlappedio.cpp,v 1.12 2001-12-10 14:04:24 sandervl Exp $ */
2
3/*
4 * Win32 overlapped IO class
5 *
6 * Copyright 2001 Sander van Leeuwen <sandervl@xs4all.nl>
7 *
8 * Project Odin Software License can be found in LICENSE.TXT
9 *
10 */
11
12
13
14#include <os2win.h>
15#include <string.h>
16#include <handlemanager.h>
17#include <heapstring.h>
18#include "overlappedio.h"
19#include "oslibdos.h"
20
21#define DBG_LOCALLOG DBG_overlappedio
22#include "dbglocal.h"
23
24
25//******************************************************************************
26//******************************************************************************
27OverlappedIOHandler::OverlappedIOHandler(LPOVERLAPPED_HANDLER lpReadHandler,
28 LPOVERLAPPED_HANDLER lpWriteHandler,
29 LPOVERLAPPED_HANDLER lpPollHandler,
30 BOOL fFullDuplex) :
31 hThreadRead(0), hThreadWrite(0), hThreadPoll(0)
32{
33 OverlappedIOError errcode = OutOfMemory;
34
35 this->fFullDuplex = fFullDuplex;
36
37 if(lpReadHandler == NULL || lpPollHandler == NULL) {
38 throw(InvalidParameter);
39 }
40
41 pending[ASYNC_INDEX_READ] = pending[ASYNC_INDEX_WRITE] = NULL;
42 pending [ASYNC_INDEX_POLL] = pending [ASYNC_INDEX_BUSY] = NULL;
43
44 this->lpReadHandler = lpReadHandler;
45 this->lpWriteHandler = lpWriteHandler;
46 this->lpPollHandler = lpPollHandler;
47
48 ::InitializeCriticalSection(&critsect);
49 //poll, read & write event semaphores are auto-reset (one thread wakes up
50 //after a SetEvent call)
51 hEventPoll = ::CreateEventA(NULL, FALSE, FALSE, NULL);
52 hEventRead = ::CreateEventA(NULL, FALSE, FALSE, NULL);
53 hEventWrite = ::CreateEventA(NULL, FALSE, FALSE, NULL);
54
55 dprintf(("OverlappedIOThread: hEventRead %x hEventWrite %x hEventPoll %x", hEventRead, hEventWrite, hEventPoll));
56
57 //the exit & cancel event semaphores are manual reset, because these events
58 //must be able to wake up multiple threads
59 hEventExit = ::CreateEventA(NULL, TRUE, FALSE, NULL);
60 hEventCancel = ::CreateEventA(NULL, TRUE, FALSE, NULL);
61 if(!hEventPoll || !hEventRead || !hEventWrite || !hEventExit || !hEventCancel)
62 {
63 DebugInt3();
64 errcode = EventCreationFailed;
65 goto failed;
66 }
67
68 DWORD dwThreadId;
69 LPOVERLAPPED_THREAD_PARAM threadparam;
70
71 dwAsyncType = (lpWriteHandler && fFullDuplex) ? ASYNCIO_READ : ASYNCIO_READWRITE;
72 threadparam = (LPOVERLAPPED_THREAD_PARAM)malloc(sizeof(OVERLAPPED_THREAD_PARAM));
73 if(!threadparam) goto outofmem;
74 threadparam->dwOperation = dwAsyncType;
75 threadparam->lpOverlappedObj = this;
76 hThreadRead = ::CreateThread(NULL, 32*1024, OverlappedIOThread, (LPVOID)threadparam, 0, &dwThreadId);
77
78 if(lpWriteHandler && fFullDuplex) {
79 dwAsyncType |= ASYNCIO_WRITE;
80
81 threadparam = (LPOVERLAPPED_THREAD_PARAM)malloc(sizeof(OVERLAPPED_THREAD_PARAM));
82 if(!threadparam) goto outofmem;
83 threadparam->dwOperation = ASYNCIO_WRITE;
84 threadparam->lpOverlappedObj = this;
85 hThreadWrite = ::CreateThread(NULL, 32*1024, OverlappedIOThread, (LPVOID)threadparam, 0, &dwThreadId);
86 }
87
88 if(lpPollHandler) {
89 dwAsyncType |= ASYNCIO_POLL;
90
91 threadparam = (LPOVERLAPPED_THREAD_PARAM)malloc(sizeof(OVERLAPPED_THREAD_PARAM));
92 if(!threadparam) goto outofmem;
93 threadparam->dwOperation = ASYNCIO_POLL;
94 threadparam->lpOverlappedObj = this;
95 hThreadPoll = ::CreateThread(NULL, 32*1024, OverlappedIOThread, (LPVOID)threadparam, 0, &dwThreadId);
96 }
97
98 if((lpPollHandler && !hThreadPoll) || !hThreadRead || (lpWriteHandler && fFullDuplex && !hThreadWrite))
99 {
100 DebugInt3();
101 errcode = ThreadCreationFailed;
102 goto failed;
103 }
104 return;
105
106outofmem:
107 errcode = OutOfMemory;
108 //fall through
109failed:
110 //SvL: NOTE: We might not fail gracefully when threads have already been
111 // created. (thread accessing memory that has been freed)
112 // Don't feel like wasting time to fix this as this should never
113 // happen anyway.
114 if(hEventExit) {
115 ::SetEvent(hEventExit);
116 ::CloseHandle(hEventExit);
117 }
118
119 if(hEventRead) ::CloseHandle(hEventRead);
120 if(hEventWrite) ::CloseHandle(hEventWrite);
121 if(hEventPoll) ::CloseHandle(hEventPoll);
122
123 if(hThreadRead) ::CloseHandle(hThreadRead);
124 if(hThreadPoll) ::CloseHandle(hThreadPoll);
125 if(hThreadWrite) ::CloseHandle(hThreadWrite);
126 ::DeleteCriticalSection(&critsect);
127
128 throw(errcode);
129}
130//******************************************************************************
131//******************************************************************************
132OverlappedIOHandler::~OverlappedIOHandler()
133{
134 dprintf(("~OverlappedIOHandler: signalling overlapped threads"));
135 ::SetEvent(hEventExit);
136
137 ::CloseHandle(hEventExit);
138 ::CloseHandle(hEventRead);
139 ::CloseHandle(hEventWrite);
140 ::CloseHandle(hEventPoll);
141
142 ::CloseHandle(hThreadRead);
143 if(hThreadPoll) ::CloseHandle(hThreadPoll);
144 if(hThreadWrite) ::CloseHandle(hThreadWrite);
145
146 DeleteCriticalSection(&critsect);
147}
148//******************************************************************************
149//******************************************************************************
150DWORD CALLBACK OverlappedIOThread(LPVOID lpThreadParam)
151{
152 LPOVERLAPPED_THREAD_PARAM threadparam = (LPOVERLAPPED_THREAD_PARAM)lpThreadParam;
153 DWORD dwOperation;
154 OverlappedIOHandler *lpOverlappedObj;
155
156 if(threadparam == NULL) {
157 DebugInt3();
158 return 0;
159 }
160 lpOverlappedObj = threadparam->lpOverlappedObj;
161 dwOperation = threadparam->dwOperation;
162 //free thread parameter first
163 free(threadparam);
164
165 return lpOverlappedObj->threadHandler(dwOperation);
166}
167//******************************************************************************
168//******************************************************************************
169DWORD OverlappedIOHandler::threadHandler(DWORD dwOperation)
170{
171 LPASYNCIOREQUEST lpRequest;
172 LPOVERLAPPED lpOverlapped;
173 HANDLE hEvents[2];
174 HANDLE hEventsWait[2];
175 HANDLE hHandle;
176 DWORD ret, dwTimeOut, dwResult;
177 int index;
178
179 dprintf(("OverlappedIOThread: started for event %d", dwOperation));
180 switch(dwOperation) {
181 case ASYNCIO_READ:
182 case ASYNCIO_READWRITE:
183 hEvents[0] = hEventRead;
184 index = ASYNC_INDEX_READ;
185 break;
186
187 case ASYNCIO_WRITE:
188 hEvents[0] = hEventWrite;
189 index = ASYNC_INDEX_WRITE;
190 break;
191
192 case ASYNCIO_POLL:
193 hEvents[0] = hEventPoll;
194 index = ASYNC_INDEX_POLL;
195 break;
196 default:
197 DebugInt3();
198 }
199 hEvents[1] = hEventExit;
200
201 while(TRUE)
202 {
203 ret = WaitForMultipleObjects(2, hEvents, FALSE, INFINITE);
204 if(ret == WAIT_FAILED) {
205 dprintf(("!WARNING!: WaitForMultipleObjects -> WAIT_FAILED!"));
206 break;
207 }
208 //if hEventExit has been signalled, then we are told to exit
209 if(ret == (WAIT_OBJECT_0+1)) {
210 dprintf(("end of threadHandler signalled"));
211 break;
212 }
213 //process all pending jobs
214 while(TRUE)
215 {
216 ::EnterCriticalSection(&critsect);
217 if(pending[index] == NULL) {
218 ::LeaveCriticalSection(&critsect);
219 break;
220 }
221 lpRequest = pending[index];
222 pending[index] = lpRequest->next;
223
224 //add to in process list
225 lpRequest->next = pending[ASYNC_INDEX_BUSY];
226 pending[ASYNC_INDEX_BUSY] = lpRequest;
227 ::LeaveCriticalSection(&critsect);
228
229 lpOverlapped = lpRequest->lpOverlapped;;
230 hHandle = lpRequest->hHandle;
231
232 switch(dwOperation) {
233 case ASYNCIO_READ:
234 case ASYNCIO_READWRITE:
235 case ASYNCIO_WRITE:
236 if(lpRequest->dwAsyncType == ASYNCIO_READ || lpWriteHandler == NULL) {
237 lpRequest->dwLastError = lpReadHandler(lpRequest, &dwResult, NULL);
238 }
239 else lpRequest->dwLastError = lpWriteHandler(lpRequest, &dwResult, NULL);
240
241 lpOverlapped->Internal = lpRequest->dwLastError;
242 lpOverlapped->InternalHigh = dwResult;
243 if(lpRequest->lpdwResult) {
244 *lpRequest->lpdwResult = dwResult;
245 }
246#ifdef DEBUG
247 if(lpRequest->dwAsyncType == ASYNCIO_READ) {
248 dprintf(("ASYNCIO_READ %x finished; result %x, last error %d", lpOverlapped, dwResult, lpRequest->dwLastError));
249 }
250 else dprintf(("ASYNCIO_WRITE %x finished; result %x, last error %d", lpOverlapped, dwResult, lpRequest->dwLastError));
251#endif
252 //wake up user thread
253 ::SetEvent(lpOverlapped->hEvent);
254 break;
255
256 case ASYNCIO_POLL:
257 hEventsWait[0] = hEventCancel;
258 hEventsWait[1] = hEventExit;
259 ret = WAIT_TIMEOUT;
260 while(TRUE)
261 {
262 dwTimeOut = 0;
263 lpRequest->dwLastError = lpPollHandler(lpRequest, &dwResult, &dwTimeOut);
264 if(lpRequest->dwLastError != ERROR_IO_PENDING) {
265 break;
266 }
267 if(dwTimeOut == 0) {
268 dprintf(("!ERROR!: lpPollHandler returned timeout 0!!"));
269 DebugInt3();
270 break;
271 }
272 //sleep a while to avoid wasting too many cpu cycles; we are woken up when a timeout occurs,
273 //when the operation is cancelled or when the process exits
274 ret = WaitForMultipleObjects(2, hEventsWait, FALSE, dwTimeOut);
275 if(ret != WAIT_TIMEOUT) {
276 dprintf(("ASYNCIO_POLL: WaitForSingleObject didn't time out, abort (ret = %x)", ret));
277 break;
278 }
279 }
280 //Don't access the overlapped & result memory when CancelIo was used to cancel the operation
281 if(ret == WAIT_TIMEOUT)
282 {
283 dprintf(("ASYNCIO_POLL %x: result %x, last error %d", lpOverlapped, dwResult, lpRequest->dwLastError));
284 lpOverlapped->Internal = lpRequest->dwLastError;
285 lpOverlapped->InternalHigh = dwResult;
286 if(lpRequest->lpdwResult) {
287 *lpRequest->lpdwResult = dwResult;
288 }
289 //wake up user thread
290 ::SetEvent(lpOverlapped->hEvent);
291 }
292 break;
293 }
294 //remove from in-process list and delete async request object
295 findAndRemoveRequest(ASYNC_INDEX_BUSY, hHandle);
296 delete lpRequest;
297 } //while(TRUE)
298 }
299 return 0;
300}
301//******************************************************************************
302//******************************************************************************
303BOOL OverlappedIOHandler::WriteFile(HANDLE hHandle,
304 LPCVOID lpBuffer,
305 DWORD nNumberOfBytesToWrite,
306 LPDWORD lpNumberOfBytesWritten,
307 LPOVERLAPPED lpOverlapped,
308 LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
309 DWORD dwUserData,
310 DWORD dwTimeOut)
311{
312 LPASYNCIOREQUEST lpRequest, current;
313 int index;
314
315 if(!lpOverlapped || lpOverlapped->hEvent == 0) {
316 ::SetLastError(ERROR_INVALID_PARAMETER);
317 return FALSE;
318 }
319
320 lpRequest = new ASYNCIOREQUEST;
321 if(lpRequest == NULL) {
322 ::SetLastError(ERROR_NOT_ENOUGH_MEMORY);
323 return FALSE;
324 }
325 lpRequest->dwAsyncType = ASYNCIO_WRITE;
326 lpRequest->hHandle = hHandle;
327 lpRequest->lpBuffer = lpBuffer;
328 lpRequest->nNumberOfBytes = nNumberOfBytesToWrite;
329 lpRequest->lpdwResult = lpNumberOfBytesWritten;
330 lpRequest->lpOverlapped = lpOverlapped;
331 lpRequest->lpCompletionRoutine = lpCompletionRoutine;
332 lpRequest->dwUserData = dwUserData;
333 lpRequest->dwTimeOut = dwTimeOut;
334 lpRequest->next = NULL;
335
336 if(dwAsyncType & ASYNCIO_READWRITE) {
337 index = ASYNC_INDEX_READ;
338 }
339 else index = ASYNC_INDEX_WRITE;
340
341 ::EnterCriticalSection(&critsect);
342 if(pending[index]) {
343 current = pending[index];
344 while(current->next) {
345 current = current->next;
346 }
347 current->next = lpRequest;
348 }
349 else pending[index] = lpRequest;
350 ::LeaveCriticalSection(&critsect);
351
352 lpOverlapped->Internal = STATUS_PENDING;
353 lpOverlapped->InternalHigh = 0;
354 //reset overlapped semaphore to non-signalled
355 ::ResetEvent(lpOverlapped->hEvent);
356
357 //wake up async thread
358 ::SetEvent((dwAsyncType & ASYNCIO_READWRITE) ? hEventRead : hEventWrite);
359
360 ::SetLastError(ERROR_IO_PENDING);
361 return FALSE;
362}
363//******************************************************************************
364//******************************************************************************
365BOOL OverlappedIOHandler::ReadFile(HANDLE hHandle,
366 LPCVOID lpBuffer,
367 DWORD nNumberOfBytesToRead,
368 LPDWORD lpNumberOfBytesRead,
369 LPOVERLAPPED lpOverlapped,
370 LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
371 DWORD dwUserData,
372 DWORD dwTimeOut)
373{
374 LPASYNCIOREQUEST lpRequest, current;
375
376 if(!lpOverlapped || lpOverlapped->hEvent == 0) {
377 ::SetLastError(ERROR_INVALID_PARAMETER);
378 return FALSE;
379 }
380
381 lpRequest = new ASYNCIOREQUEST;
382 if(lpRequest == NULL) {
383 ::SetLastError(ERROR_NOT_ENOUGH_MEMORY);
384 return FALSE;
385 }
386 lpRequest->dwAsyncType = ASYNCIO_READ;
387 lpRequest->hHandle = hHandle;
388 lpRequest->lpBuffer = lpBuffer;
389 lpRequest->nNumberOfBytes = nNumberOfBytesToRead;
390 lpRequest->lpdwResult = lpNumberOfBytesRead;
391 lpRequest->lpOverlapped = lpOverlapped;
392 lpRequest->lpCompletionRoutine = lpCompletionRoutine;
393 lpRequest->dwUserData = dwUserData;
394 lpRequest->dwTimeOut = dwTimeOut;
395 lpRequest->next = NULL;
396
397 ::EnterCriticalSection(&critsect);
398 if(pending[ASYNC_INDEX_READ]) {
399 current = pending[ASYNC_INDEX_READ];
400 while(current->next) {
401 current = current->next;
402 }
403 current->next = lpRequest;
404 }
405 else pending[ASYNC_INDEX_READ] = lpRequest;
406 ::LeaveCriticalSection(&critsect);
407
408 lpOverlapped->Internal = STATUS_PENDING;
409 lpOverlapped->InternalHigh = 0;
410 //reset overlapped semaphore to non-signalled
411 ::ResetEvent(lpOverlapped->hEvent);
412
413 //wake up async thread
414 ::SetEvent(hEventRead);
415 ::SetLastError(ERROR_IO_PENDING);
416 return FALSE;
417}
418//******************************************************************************
419//******************************************************************************
420BOOL OverlappedIOHandler::WaitForEvent(HANDLE hHandle,
421 DWORD dwEventMask,
422 LPDWORD lpfdwEvtMask,
423 LPOVERLAPPED lpOverlapped,
424 LPOVERLAPPED_COMPLETION_ROUTINE lpCompletionRoutine,
425 DWORD dwUserData,
426 DWORD dwTimeOut)
427{
428 LPASYNCIOREQUEST lpRequest, current;
429 DWORD dwLastError, dwResult;
430
431 if(!lpOverlapped || lpOverlapped->hEvent == 0) {
432 ::SetLastError(ERROR_INVALID_PARAMETER);
433 return FALSE;
434 }
435 if(!lpPollHandler) {
436 DebugInt3();
437 ::SetLastError(ERROR_INVALID_PARAMETER);
438 return FALSE;
439 }
440
441 lpRequest = new ASYNCIOREQUEST;
442 if(lpRequest == NULL) {
443 ::SetLastError(ERROR_NOT_ENOUGH_MEMORY);
444 return FALSE;
445 }
446 lpRequest->dwAsyncType = ASYNCIO_POLL;
447 lpRequest->hHandle = hHandle;
448 lpRequest->lpBuffer = NULL;
449 lpRequest->nNumberOfBytes = 0;
450 lpRequest->lpdwResult = lpfdwEvtMask;
451 lpRequest->lpOverlapped = lpOverlapped;
452 lpRequest->lpCompletionRoutine = lpCompletionRoutine;
453 lpRequest->dwUserData = dwUserData;
454 lpRequest->dwTimeOut = dwTimeOut;
455 lpRequest->dwEventMask = dwEventMask;
456 lpRequest->next = NULL;
457
458 lpOverlapped->Internal = STATUS_PENDING;
459 lpOverlapped->InternalHigh = 0;
460 //reset overlapped semaphore to non-signalled
461 ::ResetEvent(lpOverlapped->hEvent);
462
463 //first check if the event has already occured; if so, return result
464 //immediately
465 dwLastError = lpPollHandler(lpRequest, &dwResult, &dwTimeOut);
466 if(dwLastError != ERROR_IO_PENDING)
467 {
468 dprintf(("OverlappedIOHandler::WaitForEvent %x: result %x, last error %d", lpOverlapped, dwResult, dwLastError));
469 lpOverlapped->Internal = dwLastError;
470 lpOverlapped->InternalHigh = dwResult;
471 if(lpfdwEvtMask) {
472 *lpfdwEvtMask = dwResult;
473 }
474 //wake up user thread
475 ::SetEvent(lpOverlapped->hEvent);
476
477 delete lpRequest;
478 ::SetLastError(dwLastError);
479 return (dwLastError == ERROR_SUCCESS);
480 }
481
482 ::EnterCriticalSection(&critsect);
483 if(pending[ASYNC_INDEX_POLL]) {
484 current = pending[ASYNC_INDEX_READ];
485 while(current->next) {
486 current = current->next;
487 }
488 current->next = lpRequest;
489 }
490 else pending[ASYNC_INDEX_POLL] = lpRequest;
491 ::LeaveCriticalSection(&critsect);
492
493 //wake up async thread
494 ::SetEvent(hEventPoll);
495 ::SetLastError(ERROR_IO_PENDING);
496 return FALSE;
497}
498//******************************************************************************
499//******************************************************************************
500BOOL OverlappedIOHandler::CancelIo(HANDLE hHandle)
501{
502 LPASYNCIOREQUEST lpRequest;
503
504 for(int i=ASYNC_INDEX_READ;i<NR_ASYNC_OPERATIONS;i++)
505 {
506 while(TRUE)
507 {
508 lpRequest = findAndRemoveRequest(i, hHandle);
509
510 if(lpRequest) {
511 //TODO: This doesn't work if multiple handles share the
512 // same OverlappedIOHandler
513 lpRequest->fCancelled = TRUE;
514 ::SetEvent(hEventCancel); //cancel pending operation
515 if(i != ASYNC_INDEX_BUSY) {//thread that handles the request will delete it
516 delete lpRequest;
517 }
518 }
519 else break;
520 }
521 }
522 //TODO: return error if there were no pending requests???
523 ::SetLastError(ERROR_SUCCESS);
524 return TRUE;
525}
526//******************************************************************************
527//******************************************************************************
528BOOL OverlappedIOHandler::GetOverlappedResult(HANDLE hHandle,
529 LPOVERLAPPED lpOverlapped,
530 LPDWORD lpcbTransfer,
531 BOOL fWait)
532{
533 DWORD ret;
534
535 ret = ::WaitForSingleObject(lpOverlapped->hEvent, (fWait) ? INFINITE : 0);
536
537 if(lpcbTransfer)
538 *lpcbTransfer = lpOverlapped->InternalHigh;
539
540 ::SetLastError(lpOverlapped->Internal);
541
542 dprintf(("GetOverlappedResult %x -> result %d last error %d", hHandle, lpOverlapped->InternalHigh, lpOverlapped->Internal));
543 return (ret == WAIT_OBJECT_0);
544}
545//******************************************************************************
546//******************************************************************************
547LPASYNCIOREQUEST OverlappedIOHandler::findAndRemoveRequest(int index, HANDLE hHandle)
548{
549 LPASYNCIOREQUEST lpRequest, lpFound = NULL;
550
551 ::EnterCriticalSection(&critsect);
552 if(pending[index])
553 {
554 if(pending[index]->hHandle != hHandle)
555 {
556 lpRequest = pending[index];
557 while(lpRequest->next) {
558 if(lpRequest->next->hHandle == hHandle) {
559 lpFound = lpRequest->next;
560 lpRequest->next = lpFound->next;
561 break;
562 }
563 lpRequest = lpRequest->next;
564 }
565 }
566 else {
567 lpFound = pending[index];
568 pending[index] = lpFound->next;
569 }
570 }
571 ::LeaveCriticalSection(&critsect);
572 return lpFound;
573}
574//******************************************************************************
575//******************************************************************************
576
Note: See TracBrowser for help on using the repository browser.