pipe-win.cpp@ 40654

Last change on this file since 40654 was 39691, checked in by vboxsync, 13 years ago
pipe-win.cpp: build fix.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 49.1 KB

Line
1	/* $Id: pipe-win.cpp 39691 2011-12-30 13:16:35Z vboxsync $ */
2	/** @file
3	* IPRT - Anonymous Pipes, Windows Implementation.
4	*/
5
6	/*
7	* Copyright (C) 2010 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.virtualbox.org. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*
17	* The contents of this file may alternatively be used under the terms
18	* of the Common Development and Distribution License Version 1.0
19	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20	* VirtualBox OSE distribution, in which case the provisions of the
21	* CDDL are applicable instead of those of the GPL.
22	*
23	* You may elect to license modified versions of this file under the
24	* terms and conditions of either the GPL or the CDDL or both.
25	*/
26
27
28	/*******************************************************************************
29	* Header Files *
30	*******************************************************************************/
31	#include <Windows.h>
32
33	#include <iprt/pipe.h>
34	#include "internal/iprt.h"
35
36	#include <iprt/asm.h>
37	#include <iprt/assert.h>
38	#include <iprt/critsect.h>
39	#include <iprt/err.h>
40	#include <iprt/mem.h>
41	#include <iprt/string.h>
42	#include <iprt/poll.h>
43	#include <iprt/process.h>
44	#include <iprt/thread.h>
45	#include <iprt/time.h>
46	#include "internal/pipe.h"
47	#include "internal/magics.h"
48
49
50	/*******************************************************************************
51	* Defined Constants And Macros *
52	*******************************************************************************/
53	/** The pipe buffer size we prefer. */
54	#define RTPIPE_NT_SIZE _64K
55
56
57	/*******************************************************************************
58	* Structures and Typedefs *
59	*******************************************************************************/
60	typedef struct RTPIPEINTERNAL
61	{
62	/** Magic value (RTPIPE_MAGIC). */
63	uint32_t u32Magic;
64	/** The pipe handle. */
65	HANDLE hPipe;
66	/** Set if this is the read end, clear if it's the write end. */
67	bool fRead;
68	/** Set if there is already pending I/O. */
69	bool fIOPending;
70	/** Set if the zero byte read that the poll code using is pending. */
71	bool fZeroByteRead;
72	/** Set if the pipe is broken. */
73	bool fBrokenPipe;
74	/** Set if we've promised that the handle is writable. */
75	bool fPromisedWritable;
76	/** Usage counter. */
77	uint32_t cUsers;
78	/** The overlapped I/O structure we use. */
79	OVERLAPPED Overlapped;
80	/** Bounce buffer for writes. */
81	uint8_t *pbBounceBuf;
82	/** Amount of used buffer space. */
83	size_t cbBounceBufUsed;
84	/** Amount of allocated buffer space. */
85	size_t cbBounceBufAlloc;
86	/** The handle of the poll set currently polling on this pipe.
87	* We can only have one poller at the time (lazy bird). */
88	RTPOLLSET hPollSet;
89	/** Critical section protecting the above members.
90	* (Taking the lazy/simple approach.) */
91	RTCRITSECT CritSect;
92	/** Buffer for the zero byte read. */
93	uint8_t abBuf[8];
94	} RTPIPEINTERNAL;
95
96
97	/* from ntdef.h */
98	typedef LONG NTSTATUS;
99
100	/* from ntddk.h */
101	typedef struct _IO_STATUS_BLOCK {
102	union {
103	NTSTATUS Status;
104	PVOID Pointer;
105	};
106	ULONG_PTR Information;
107	} IO_STATUS_BLOCK, *PIO_STATUS_BLOCK;
108
109	typedef enum _FILE_INFORMATION_CLASS {
110	FilePipeInformation = 23,
111	FilePipeLocalInformation = 24,
112	FilePipeRemoteInformation = 25,
113	} FILE_INFORMATION_CLASS, *PFILE_INFORMATION_CLASS;
114
115	/* from ntifs.h */
116	typedef struct _FILE_PIPE_LOCAL_INFORMATION {
117	ULONG NamedPipeType;
118	ULONG NamedPipeConfiguration;
119	ULONG MaximumInstances;
120	ULONG CurrentInstances;
121	ULONG InboundQuota;
122	ULONG ReadDataAvailable;
123	ULONG OutboundQuota;
124	ULONG WriteQuotaAvailable;
125	ULONG NamedPipeState;
126	ULONG NamedPipeEnd;
127	} FILE_PIPE_LOCAL_INFORMATION, *PFILE_PIPE_LOCAL_INFORMATION;
128
129	#define FILE_PIPE_DISCONNECTED_STATE 0x00000001
130	#define FILE_PIPE_LISTENING_STATE 0x00000002
131	#define FILE_PIPE_CONNECTED_STATE 0x00000003
132	#define FILE_PIPE_CLOSING_STATE 0x00000004
133
134	#define FILE_PIPE_INBOUND 0x00000000
135	#define FILE_PIPE_OUTBOUND 0x00000001
136	#define FILE_PIPE_FULL_DUPLEX 0x00000002
137
138	#define FILE_PIPE_CLIENT_END 0x00000000
139	#define FILE_PIPE_SERVER_END 0x00000001
140
141	extern "C" NTSYSAPI NTSTATUS WINAPI NtQueryInformationFile(HANDLE, PIO_STATUS_BLOCK, PVOID, LONG, FILE_INFORMATION_CLASS);
142
143
144	/**
145	* Wrapper for getting FILE_PIPE_LOCAL_INFORMATION via the NT API.
146	*
147	* @returns Success indicator (true/false).
148	* @param pThis The pipe.
149	* @param pInfo The info structure.
150	*/
151	static bool rtPipeQueryInfo(RTPIPEINTERNAL pThis, FILE_PIPE_LOCAL_INFORMATION pInfo)
152	{
153	IO_STATUS_BLOCK Ios;
154	RT_ZERO(Ios);
155	RT_ZERO(*pInfo);
156	NTSTATUS rcNt = NtQueryInformationFile(pThis->hPipe, &Ios, pInfo, sizeof(*pInfo), FilePipeLocalInformation);
157	return rcNt >= 0;
158	}
159
160
161	RTDECL(int) RTPipeCreate(PRTPIPE phPipeRead, PRTPIPE phPipeWrite, uint32_t fFlags)
162	{
163	AssertPtrReturn(phPipeRead, VERR_INVALID_POINTER);
164	AssertPtrReturn(phPipeWrite, VERR_INVALID_POINTER);
165	AssertReturn(!(fFlags & ~RTPIPE_C_VALID_MASK), VERR_INVALID_PARAMETER);
166
167	/*
168	* Create the read end of the pipe.
169	*/
170	DWORD dwErr;
171	HANDLE hPipeR;
172	HANDLE hPipeW;
173	int rc;
174	for (;;)
175	{
176	static volatile uint32_t g_iNextPipe = 0;
177	char szName[128];
178	RTStrPrintf(szName, sizeof(szName), "\\\\.\\pipe\\iprt-pipe-%u-%u", RTProcSelf(), ASMAtomicIncU32(&g_iNextPipe));
179
180	SECURITY_ATTRIBUTES SecurityAttributes;
181	PSECURITY_ATTRIBUTES pSecurityAttributes = NULL;
182	if (fFlags & RTPIPE_C_INHERIT_READ)
183	{
184	SecurityAttributes.nLength = sizeof(SecurityAttributes);
185	SecurityAttributes.lpSecurityDescriptor = NULL;
186	SecurityAttributes.bInheritHandle = TRUE;
187	pSecurityAttributes = &SecurityAttributes;
188	}
189
190	DWORD dwOpenMode = PIPE_ACCESS_INBOUND \| FILE_FLAG_OVERLAPPED;
191	#ifdef FILE_FLAG_FIRST_PIPE_INSTANCE
192	dwOpenMode \|= FILE_FLAG_FIRST_PIPE_INSTANCE;
193	#endif
194
195	DWORD dwPipeMode = PIPE_TYPE_BYTE \| PIPE_READMODE_BYTE \| PIPE_WAIT;
196	#ifdef PIPE_REJECT_REMOTE_CLIENTS
197	dwPipeMode \|= PIPE_REJECT_REMOTE_CLIENTS;
198	#endif
199
200	hPipeR = CreateNamedPipeA(szName, dwOpenMode, dwPipeMode, 1 /nMaxInstances/, RTPIPE_NT_SIZE, RTPIPE_NT_SIZE,
201	NMPWAIT_USE_DEFAULT_WAIT, pSecurityAttributes);
202	#ifdef PIPE_REJECT_REMOTE_CLIENTS
203	if (hPipeR == INVALID_HANDLE_VALUE && GetLastError() == ERROR_INVALID_PARAMETER)
204	{
205	dwPipeMode &= ~PIPE_REJECT_REMOTE_CLIENTS;
206	hPipeR = CreateNamedPipeA(szName, dwOpenMode, dwPipeMode, 1 /nMaxInstances/, RTPIPE_NT_SIZE, RTPIPE_NT_SIZE,
207	NMPWAIT_USE_DEFAULT_WAIT, pSecurityAttributes);
208	}
209	#endif
210	#ifdef FILE_FLAG_FIRST_PIPE_INSTANCE
211	if (hPipeR == INVALID_HANDLE_VALUE && GetLastError() == ERROR_INVALID_PARAMETER)
212	{
213	dwOpenMode &= ~FILE_FLAG_FIRST_PIPE_INSTANCE;
214	hPipeR = CreateNamedPipeA(szName, dwOpenMode, dwPipeMode, 1 /nMaxInstances/, RTPIPE_NT_SIZE, RTPIPE_NT_SIZE,
215	NMPWAIT_USE_DEFAULT_WAIT, pSecurityAttributes);
216	}
217	#endif
218	if (hPipeR != INVALID_HANDLE_VALUE)
219	{
220	/*
221	* Connect to the pipe (the write end).
222	* We add FILE_READ_ATTRIBUTES here to make sure we can query the
223	* pipe state later on.
224	*/
225	pSecurityAttributes = NULL;
226	if (fFlags & RTPIPE_C_INHERIT_WRITE)
227	{
228	SecurityAttributes.nLength = sizeof(SecurityAttributes);
229	SecurityAttributes.lpSecurityDescriptor = NULL;
230	SecurityAttributes.bInheritHandle = TRUE;
231	pSecurityAttributes = &SecurityAttributes;
232	}
233
234	hPipeW = CreateFileA(szName,
235	GENERIC_WRITE \| FILE_READ_ATTRIBUTES /dwDesiredAccess/,
236	0 /dwShareMode/,
237	pSecurityAttributes,
238	OPEN_EXISTING /* dwCreationDisposition */,
239	FILE_FLAG_OVERLAPPED /dwFlagsAndAttributes/,
240	NULL /hTemplateFile/);
241	if (hPipeW != INVALID_HANDLE_VALUE)
242	break;
243	dwErr = GetLastError();
244	CloseHandle(hPipeR);
245	}
246	else
247	dwErr = GetLastError();
248	if ( dwErr != ERROR_PIPE_BUSY /* already exist - compatible */
249	&& dwErr != ERROR_ACCESS_DENIED /* already exist - incompatible */)
250	return RTErrConvertFromWin32(dwErr);
251	/* else: try again with a new name */
252	}
253
254	/*
255	* Create the two handles.
256	*/
257	RTPIPEINTERNAL pThisR = (RTPIPEINTERNAL )RTMemAllocZ(sizeof(RTPIPEINTERNAL));
258	if (pThisR)
259	{
260	RTPIPEINTERNAL pThisW = (RTPIPEINTERNAL )RTMemAllocZ(sizeof(RTPIPEINTERNAL));
261	if (pThisW)
262	{
263	rc = RTCritSectInit(&pThisR->CritSect);
264	if (RT_SUCCESS(rc))
265	{
266	rc = RTCritSectInit(&pThisW->CritSect);
267	if (RT_SUCCESS(rc))
268	{
269	pThisR->Overlapped.hEvent = CreateEvent(NULL, TRUE /fManualReset/,
270	TRUE /fInitialState/, NULL /pName/);
271	if (pThisR->Overlapped.hEvent != NULL)
272	{
273	pThisW->Overlapped.hEvent = CreateEvent(NULL, TRUE /fManualReset/,
274	TRUE /fInitialState/, NULL /pName/);
275	if (pThisW->Overlapped.hEvent != NULL)
276	{
277	pThisR->u32Magic = RTPIPE_MAGIC;
278	pThisW->u32Magic = RTPIPE_MAGIC;
279	pThisR->hPipe = hPipeR;
280	pThisW->hPipe = hPipeW;
281	pThisR->fRead = true;
282	pThisW->fRead = false;
283	//pThisR->fIOPending = false;
284	//pThisW->fIOPending = false;
285	//pThisR->fZeroByteRead = false;
286	//pThisW->fZeroByteRead = false;
287	//pThisR->fBrokenPipe = false;
288	//pThisW->fBrokenPipe = false;
289	//pThisW->fPromisedWritable= false;
290	//pThisR->fPromisedWritable= false;
291	//pThisR->cUsers = 0;
292	//pThisW->cUsers = 0;
293	//pThisR->pbBounceBuf = NULL;
294	//pThisW->pbBounceBuf = NULL;
295	//pThisR->cbBounceBufUsed = 0;
296	//pThisW->cbBounceBufUsed = 0;
297	//pThisR->cbBounceBufAlloc= 0;
298	//pThisW->cbBounceBufAlloc= 0;
299	pThisR->hPollSet = NIL_RTPOLLSET;
300	pThisW->hPollSet = NIL_RTPOLLSET;
301
302	*phPipeRead = pThisR;
303	*phPipeWrite = pThisW;
304	return VINF_SUCCESS;
305	}
306	CloseHandle(pThisR->Overlapped.hEvent);
307	}
308	RTCritSectDelete(&pThisW->CritSect);
309	}
310	RTCritSectDelete(&pThisR->CritSect);
311	}
312	RTMemFree(pThisW);
313	}
314	else
315	rc = VERR_NO_MEMORY;
316	RTMemFree(pThisR);
317	}
318	else
319	rc = VERR_NO_MEMORY;
320
321	CloseHandle(hPipeR);
322	CloseHandle(hPipeW);
323	return rc;
324	}
325
326
327	/**
328	* Common worker for handling I/O completion.
329	*
330	* This is used by RTPipeClose, RTPipeWrite and RTPipeWriteBlocking.
331	*
332	* @returns IPRT status code.
333	* @param pThis The pipe instance handle.
334	*/
335	static int rtPipeWriteCheckCompletion(RTPIPEINTERNAL *pThis)
336	{
337	int rc;
338	DWORD dwRc = WaitForSingleObject(pThis->Overlapped.hEvent, 0);
339	if (dwRc == WAIT_OBJECT_0)
340	{
341	DWORD cbWritten = 0;
342	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbWritten, TRUE))
343	{
344	for (;;)
345	{
346	if (cbWritten >= pThis->cbBounceBufUsed)
347	{
348	pThis->fIOPending = false;
349	rc = VINF_SUCCESS;
350	break;
351	}
352
353	/* resubmit the remainder of the buffer - can this actually happen? */
354	memmove(&pThis->pbBounceBuf[0], &pThis->pbBounceBuf[cbWritten], pThis->cbBounceBufUsed - cbWritten);
355	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
356	if (!WriteFile(pThis->hPipe, pThis->pbBounceBuf, (DWORD)pThis->cbBounceBufUsed,
357	&cbWritten, &pThis->Overlapped))
358	{
359	if (GetLastError() == ERROR_IO_PENDING)
360	rc = VINF_TRY_AGAIN;
361	else
362	{
363	pThis->fIOPending = false;
364	if (GetLastError() == ERROR_NO_DATA)
365	rc = VERR_BROKEN_PIPE;
366	else
367	rc = RTErrConvertFromWin32(GetLastError());
368	if (rc == VERR_BROKEN_PIPE)
369	pThis->fBrokenPipe = true;
370	}
371	break;
372	}
373	Assert(cbWritten > 0);
374	}
375	}
376	else
377	{
378	pThis->fIOPending = false;
379	rc = RTErrConvertFromWin32(GetLastError());
380	}
381	}
382	else if (dwRc == WAIT_TIMEOUT)
383	rc = VINF_TRY_AGAIN;
384	else
385	{
386	pThis->fIOPending = false;
387	if (dwRc == WAIT_ABANDONED)
388	rc = VERR_INVALID_HANDLE;
389	else
390	rc = RTErrConvertFromWin32(GetLastError());
391	}
392	return rc;
393	}
394
395
396
397	RTDECL(int) RTPipeClose(RTPIPE hPipe)
398	{
399	RTPIPEINTERNAL *pThis = hPipe;
400	if (pThis == NIL_RTPIPE)
401	return VINF_SUCCESS;
402	AssertPtrReturn(pThis, VERR_INVALID_PARAMETER);
403	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
404
405	/*
406	* Do the cleanup.
407	*/
408	AssertReturn(ASMAtomicCmpXchgU32(&pThis->u32Magic, ~RTPIPE_MAGIC, RTPIPE_MAGIC), VERR_INVALID_HANDLE);
409	RTCritSectEnter(&pThis->CritSect);
410	Assert(pThis->cUsers == 0);
411
412	if (!pThis->fRead && pThis->fIOPending)
413	rtPipeWriteCheckCompletion(pThis);
414
415	CloseHandle(pThis->hPipe);
416	pThis->hPipe = INVALID_HANDLE_VALUE;
417
418	CloseHandle(pThis->Overlapped.hEvent);
419	pThis->Overlapped.hEvent = NULL;
420
421	RTMemFree(pThis->pbBounceBuf);
422	pThis->pbBounceBuf = NULL;
423
424	RTCritSectLeave(&pThis->CritSect);
425	RTCritSectDelete(&pThis->CritSect);
426
427	RTMemFree(pThis);
428
429	return VINF_SUCCESS;
430	}
431
432
433	RTDECL(int) RTPipeFromNative(PRTPIPE phPipe, RTHCINTPTR hNativePipe, uint32_t fFlags)
434	{
435	AssertPtrReturn(phPipe, VERR_INVALID_POINTER);
436	AssertReturn(!(fFlags & ~RTPIPE_N_VALID_MASK), VERR_INVALID_PARAMETER);
437	AssertReturn(!!(fFlags & RTPIPE_N_READ) != !!(fFlags & RTPIPE_N_WRITE), VERR_INVALID_PARAMETER);
438
439	/*
440	* Get and validate the pipe handle info.
441	*/
442	HANDLE hNative = (HANDLE)hNativePipe;
443	AssertReturn(GetFileType(hNative) == FILE_TYPE_PIPE, VERR_INVALID_HANDLE);
444
445	DWORD cMaxInstances;
446	DWORD fInfo;
447	if (!GetNamedPipeInfo(hNative, &fInfo, NULL, NULL, &cMaxInstances))
448	return RTErrConvertFromWin32(GetLastError());
449	AssertReturn(!(fInfo & PIPE_TYPE_MESSAGE), VERR_INVALID_HANDLE);
450	AssertReturn(cMaxInstances == 1, VERR_INVALID_HANDLE);
451
452	DWORD cInstances;
453	DWORD fState;
454	if (!GetNamedPipeHandleState(hNative, &fState, &cInstances, NULL, NULL, NULL, 0))
455	return RTErrConvertFromWin32(GetLastError());
456	AssertReturn(!(fState & PIPE_NOWAIT), VERR_INVALID_HANDLE);
457	AssertReturn(!(fState & PIPE_READMODE_MESSAGE), VERR_INVALID_HANDLE);
458	AssertReturn(cInstances <= 1, VERR_INVALID_HANDLE);
459
460	/*
461	* Looks kind of OK, create a handle so we can try rtPipeQueryInfo on it
462	* and see if we need to duplicate it to make that call work.
463	*/
464	RTPIPEINTERNAL pThis = (RTPIPEINTERNAL )RTMemAllocZ(sizeof(RTPIPEINTERNAL));
465	if (!pThis)
466	return VERR_NO_MEMORY;
467	int rc = RTCritSectInit(&pThis->CritSect);
468	if (RT_SUCCESS(rc))
469	{
470	pThis->Overlapped.hEvent = CreateEvent(NULL, TRUE /fManualReset/,
471	TRUE /fInitialState/, NULL /pName/);
472	if (pThis->Overlapped.hEvent != NULL)
473	{
474	pThis->u32Magic = RTPIPE_MAGIC;
475	pThis->hPipe = hNative;
476	pThis->fRead = !!(fFlags & RTPIPE_N_READ);
477	//pThis->fIOPending = false;
478	//pThis->fZeroByteRead = false;
479	//pThis->fBrokenPipe = false;
480	//pThisR->fPromisedWritable= false;
481	//pThis->cUsers = 0;
482	//pThis->pbBounceBuf = NULL;
483	//pThis->cbBounceBufUsed = 0;
484	//pThis->cbBounceBufAlloc= 0;
485	pThis->hPollSet = NIL_RTPOLLSET;
486
487	HANDLE hNative2 = INVALID_HANDLE_VALUE;
488	FILE_PIPE_LOCAL_INFORMATION Info;
489	if (rtPipeQueryInfo(pThis, &Info))
490	rc = VINF_SUCCESS;
491	else
492	{
493	if (DuplicateHandle(GetCurrentProcess() /hSrcProcess/, hNative /hSrcHandle/,
494	GetCurrentProcess() /hDstProcess/, &hNative2 /phDstHandle/,
495	pThis->fRead ? GENERIC_READ : GENERIC_WRITE \| FILE_READ_ATTRIBUTES /dwDesiredAccess/,
496	!!(fFlags & RTPIPE_N_INHERIT) /fInheritHandle/,
497	0 /dwOptions/))
498	{
499	pThis->hPipe = hNative2;
500	if (rtPipeQueryInfo(pThis, &Info))
501	rc = VINF_SUCCESS;
502	else
503	{
504	rc = VERR_ACCESS_DENIED;
505	CloseHandle(hNative2);
506	}
507	}
508	else
509	hNative2 = INVALID_HANDLE_VALUE;
510	}
511	if (RT_SUCCESS(rc))
512	{
513	/*
514	* Verify the pipe state and correct the inheritability.
515	*/
516	AssertStmt( Info.NamedPipeState == FILE_PIPE_CONNECTED_STATE
517	\|\| Info.NamedPipeState == FILE_PIPE_CLOSING_STATE
518	\|\| Info.NamedPipeState == FILE_PIPE_DISCONNECTED_STATE,
519	VERR_INVALID_HANDLE);
520	AssertStmt( Info.NamedPipeConfiguration
521	== ( Info.NamedPipeEnd == FILE_PIPE_SERVER_END
522	? (pThis->fRead ? FILE_PIPE_INBOUND : FILE_PIPE_OUTBOUND)
523	: (pThis->fRead ? FILE_PIPE_OUTBOUND : FILE_PIPE_INBOUND) ),
524	VERR_INVALID_HANDLE);
525	if ( RT_SUCCESS(rc)
526	&& hNative2 == INVALID_HANDLE_VALUE
527	&& !SetHandleInformation(hNative,
528	HANDLE_FLAG_INHERIT /dwMask/,
529	fFlags & RTPIPE_N_INHERIT ? HANDLE_FLAG_INHERIT : 0))
530	{
531	rc = RTErrConvertFromWin32(GetLastError());
532	AssertMsgFailed(("%Rrc\n", rc));
533	}
534	if (RT_SUCCESS(rc))
535	{
536	/*
537	* Ok, we're good!
538	*/
539	if (hNative2 != INVALID_HANDLE_VALUE)
540	CloseHandle(hNative);
541	*phPipe = pThis;
542	return VINF_SUCCESS;
543	}
544	}
545
546	/* Bail out. */
547	if (hNative2 != INVALID_HANDLE_VALUE)
548	CloseHandle(hNative2);
549	CloseHandle(pThis->Overlapped.hEvent);
550	}
551	RTCritSectDelete(&pThis->CritSect);
552	}
553	RTMemFree(pThis);
554	return rc;
555	}
556
557
558	RTDECL(RTHCINTPTR) RTPipeToNative(RTPIPE hPipe)
559	{
560	RTPIPEINTERNAL *pThis = hPipe;
561	AssertPtrReturn(pThis, -1);
562	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, -1);
563
564	return (RTHCINTPTR)pThis->hPipe;
565	}
566
567
568	RTDECL(int) RTPipeRead(RTPIPE hPipe, void pvBuf, size_t cbToRead, size_t pcbRead)
569	{
570	RTPIPEINTERNAL *pThis = hPipe;
571	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
572	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
573	AssertReturn(pThis->fRead, VERR_ACCESS_DENIED);
574	AssertPtr(pcbRead);
575	AssertPtr(pvBuf);
576
577	int rc = RTCritSectEnter(&pThis->CritSect);
578	if (RT_SUCCESS(rc))
579	{
580	/* No concurrent readers, sorry. */
581	if (pThis->cUsers == 0)
582	{
583	pThis->cUsers++;
584
585	/*
586	* Kick of a an overlapped read. It should return immediately if
587	* there is bytes in the buffer. If not, we'll cancel it and see
588	* what we get back.
589	*/
590	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
591	DWORD cbRead = 0;
592	if ( cbToRead == 0
593	\|\| ReadFile(pThis->hPipe, pvBuf,
594	cbToRead <= ~(DWORD)0 ? (DWORD)cbToRead : ~(DWORD)0,
595	&cbRead, &pThis->Overlapped))
596	{
597	*pcbRead = cbRead;
598	rc = VINF_SUCCESS;
599	}
600	else if (GetLastError() == ERROR_IO_PENDING)
601	{
602	pThis->fIOPending = true;
603	RTCritSectLeave(&pThis->CritSect);
604
605	if (!CancelIo(pThis->hPipe))
606	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
607	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/))
608	{
609	*pcbRead = cbRead;
610	rc = VINF_SUCCESS;
611	}
612	else if (GetLastError() == ERROR_OPERATION_ABORTED)
613	{
614	*pcbRead = 0;
615	rc = VINF_TRY_AGAIN;
616	}
617	else
618	rc = RTErrConvertFromWin32(GetLastError());
619
620	RTCritSectEnter(&pThis->CritSect);
621	pThis->fIOPending = false;
622	}
623	else
624	rc = RTErrConvertFromWin32(GetLastError());
625	if (rc == VERR_BROKEN_PIPE)
626	pThis->fBrokenPipe = true;
627
628	pThis->cUsers--;
629	}
630	else
631	rc = VERR_WRONG_ORDER;
632	RTCritSectLeave(&pThis->CritSect);
633	}
634	return rc;
635	}
636
637
638	RTDECL(int) RTPipeReadBlocking(RTPIPE hPipe, void pvBuf, size_t cbToRead, size_t pcbRead)
639	{
640	RTPIPEINTERNAL *pThis = hPipe;
641	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
642	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
643	AssertReturn(pThis->fRead, VERR_ACCESS_DENIED);
644	AssertPtr(pvBuf);
645
646	int rc = RTCritSectEnter(&pThis->CritSect);
647	if (RT_SUCCESS(rc))
648	{
649	/* No concurrent readers, sorry. */
650	if (pThis->cUsers == 0)
651	{
652	pThis->cUsers++;
653
654	size_t cbTotalRead = 0;
655	while (cbToRead > 0)
656	{
657	/*
658	* Kick of a an overlapped read. It should return immediately if
659	* there is bytes in the buffer. If not, we'll cancel it and see
660	* what we get back.
661	*/
662	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
663	DWORD cbRead = 0;
664	pThis->fIOPending = true;
665	RTCritSectLeave(&pThis->CritSect);
666
667	if (ReadFile(pThis->hPipe, pvBuf,
668	cbToRead <= ~(DWORD)0 ? (DWORD)cbToRead : ~(DWORD)0,
669	&cbRead, &pThis->Overlapped))
670	rc = VINF_SUCCESS;
671	else if (GetLastError() == ERROR_IO_PENDING)
672	{
673	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
674	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/))
675	rc = VINF_SUCCESS;
676	else
677	rc = RTErrConvertFromWin32(GetLastError());
678	}
679	else
680	rc = RTErrConvertFromWin32(GetLastError());
681
682	RTCritSectEnter(&pThis->CritSect);
683	pThis->fIOPending = false;
684	if (RT_FAILURE(rc))
685	break;
686
687	/* advance */
688	cbToRead -= cbRead;
689	cbTotalRead += cbRead;
690	pvBuf = (uint8_t *)pvBuf + cbRead;
691	}
692
693	if (rc == VERR_BROKEN_PIPE)
694	pThis->fBrokenPipe = true;
695
696	if (pcbRead)
697	{
698	*pcbRead = cbTotalRead;
699	if ( RT_FAILURE(rc)
700	&& cbTotalRead
701	&& rc != VERR_INVALID_POINTER)
702	rc = VINF_SUCCESS;
703	}
704
705	pThis->cUsers--;
706	}
707	else
708	rc = VERR_WRONG_ORDER;
709	RTCritSectLeave(&pThis->CritSect);
710	}
711	return rc;
712	}
713
714
715	RTDECL(int) RTPipeWrite(RTPIPE hPipe, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
716	{
717	RTPIPEINTERNAL *pThis = hPipe;
718	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
719	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
720	AssertReturn(!pThis->fRead, VERR_ACCESS_DENIED);
721	AssertPtr(pcbWritten);
722	AssertPtr(pvBuf);
723
724	int rc = RTCritSectEnter(&pThis->CritSect);
725	if (RT_SUCCESS(rc))
726	{
727	/* No concurrent readers, sorry. */
728	if (pThis->cUsers == 0)
729	{
730	pThis->cUsers++;
731
732	/* If I/O is pending, check if it has completed. */
733	if (pThis->fIOPending)
734	rc = rtPipeWriteCheckCompletion(pThis);
735	else
736	rc = VINF_SUCCESS;
737	if (rc == VINF_SUCCESS)
738	{
739	Assert(!pThis->fIOPending);
740
741	/* Adjust the number of bytes to write to fit into the current
742	buffer quota, unless we've promised stuff in RTPipeSelectOne.
743	WriteQuotaAvailable better not be zero when it shouldn't!! */
744	FILE_PIPE_LOCAL_INFORMATION Info;
745	if ( !pThis->fPromisedWritable
746	&& cbToWrite > 0
747	&& rtPipeQueryInfo(pThis, &Info))
748	{
749	if (Info.NamedPipeState == FILE_PIPE_CLOSING_STATE)
750	rc = VERR_BROKEN_PIPE;
751	/** @todo fixme: To get the pipe writing support to work the
752	* block below needs to be commented out until a
753	* way is found to address the problem of the incorrectly
754	* set field Info.WriteQuotaAvailable. */
755	#if 0
756	else if ( cbToWrite >= Info.WriteQuotaAvailable
757	&& Info.OutboundQuota != 0
758	&& (Info.WriteQuotaAvailable \|\| pThis->cbBounceBufAlloc)
759	)
760	{
761	cbToWrite = Info.WriteQuotaAvailable;
762	if (!cbToWrite)
763	rc = VINF_TRY_AGAIN;
764	}
765	#endif
766	}
767	pThis->fPromisedWritable = false;
768
769	/* Do the bounce buffering. */
770	if ( pThis->cbBounceBufAlloc < cbToWrite
771	&& pThis->cbBounceBufAlloc < RTPIPE_NT_SIZE)
772	{
773	if (cbToWrite > RTPIPE_NT_SIZE)
774	cbToWrite = RTPIPE_NT_SIZE;
775	void *pv = RTMemRealloc(pThis->pbBounceBuf, RT_ALIGN_Z(cbToWrite, _1K));
776	if (pv)
777	{
778	pThis->pbBounceBuf = (uint8_t *)pv;
779	pThis->cbBounceBufAlloc = RT_ALIGN_Z(cbToWrite, _1K);
780	}
781	else
782	rc = VERR_NO_MEMORY;
783	}
784	else if (cbToWrite > RTPIPE_NT_SIZE)
785	cbToWrite = RTPIPE_NT_SIZE;
786	if (RT_SUCCESS(rc) && cbToWrite)
787	{
788	memcpy(pThis->pbBounceBuf, pvBuf, cbToWrite);
789	pThis->cbBounceBufUsed = (uint32_t)cbToWrite;
790
791	/* Submit the write. */
792	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
793	DWORD cbWritten = 0;
794	if (WriteFile(pThis->hPipe, pThis->pbBounceBuf, (DWORD)pThis->cbBounceBufUsed,
795	&cbWritten, &pThis->Overlapped))
796	{
797	*pcbWritten = cbWritten;
798	rc = VINF_SUCCESS;
799	}
800	else if (GetLastError() == ERROR_IO_PENDING)
801	{
802	*pcbWritten = cbToWrite;
803	pThis->fIOPending = true;
804	rc = VINF_SUCCESS;
805	}
806	else if (GetLastError() == ERROR_NO_DATA)
807	rc = VERR_BROKEN_PIPE;
808	else
809	rc = RTErrConvertFromWin32(GetLastError());
810	}
811	else if (RT_SUCCESS(rc))
812	*pcbWritten = 0;
813	}
814	else if (RT_SUCCESS(rc))
815	*pcbWritten = 0;
816
817	if (rc == VERR_BROKEN_PIPE)
818	pThis->fBrokenPipe = true;
819
820	pThis->cUsers--;
821	}
822	else
823	rc = VERR_WRONG_ORDER;
824	RTCritSectLeave(&pThis->CritSect);
825	}
826	return rc;
827	}
828
829
830	RTDECL(int) RTPipeWriteBlocking(RTPIPE hPipe, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
831	{
832	RTPIPEINTERNAL *pThis = hPipe;
833	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
834	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
835	AssertReturn(!pThis->fRead, VERR_ACCESS_DENIED);
836	AssertPtr(pvBuf);
837	AssertPtrNull(pcbWritten);
838
839	int rc = RTCritSectEnter(&pThis->CritSect);
840	if (RT_SUCCESS(rc))
841	{
842	/* No concurrent readers, sorry. */
843	if (pThis->cUsers == 0)
844	{
845	pThis->cUsers++;
846
847	/*
848	* If I/O is pending, wait for it to complete.
849	*/
850	if (pThis->fIOPending)
851	{
852	rc = rtPipeWriteCheckCompletion(pThis);
853	while (rc == VINF_TRY_AGAIN)
854	{
855	Assert(pThis->fIOPending);
856	HANDLE hEvent = pThis->Overlapped.hEvent;
857	RTCritSectLeave(&pThis->CritSect);
858	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
859	RTCritSectEnter(&pThis->CritSect);
860	}
861	}
862	if (RT_SUCCESS(rc))
863	{
864	Assert(!pThis->fIOPending);
865	pThis->fPromisedWritable = false;
866
867	/*
868	* Try write everything.
869	* No bounce buffering, cUsers protects us.
870	*/
871	size_t cbTotalWritten = 0;
872	while (cbToWrite > 0)
873	{
874	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
875	pThis->fIOPending = true;
876	RTCritSectLeave(&pThis->CritSect);
877
878	DWORD cbWritten = 0;
879	if (WriteFile(pThis->hPipe, pvBuf,
880	cbToWrite <= ~(DWORD)0 ? (DWORD)cbToWrite : ~(DWORD)0,
881	&cbWritten, &pThis->Overlapped))
882	rc = VINF_SUCCESS;
883	else if (GetLastError() == ERROR_IO_PENDING)
884	{
885	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
886	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbWritten, TRUE /fWait/))
887	rc = VINF_SUCCESS;
888	else
889	rc = RTErrConvertFromWin32(GetLastError());
890	}
891	else if (GetLastError() == ERROR_NO_DATA)
892	rc = VERR_BROKEN_PIPE;
893	else
894	rc = RTErrConvertFromWin32(GetLastError());
895
896	RTCritSectEnter(&pThis->CritSect);
897	pThis->fIOPending = false;
898	if (RT_FAILURE(rc))
899	break;
900
901	/* advance */
902	pvBuf = (char const *)pvBuf + cbWritten;
903	cbTotalWritten += cbWritten;
904	cbToWrite -= cbWritten;
905	}
906
907	if (pcbWritten)
908	{
909	*pcbWritten = cbTotalWritten;
910	if ( RT_FAILURE(rc)
911	&& cbTotalWritten
912	&& rc != VERR_INVALID_POINTER)
913	rc = VINF_SUCCESS;
914	}
915	}
916
917	if (rc == VERR_BROKEN_PIPE)
918	pThis->fBrokenPipe = true;
919
920	pThis->cUsers--;
921	}
922	else
923	rc = VERR_WRONG_ORDER;
924	RTCritSectLeave(&pThis->CritSect);
925	}
926	return rc;
927
928	#if 1
929	return VERR_NOT_IMPLEMENTED;
930	#else
931	int rc = rtPipeTryBlocking(pThis);
932	if (RT_SUCCESS(rc))
933	{
934	size_t cbTotalWritten = 0;
935	while (cbToWrite > 0)
936	{
937	ssize_t cbWritten = write(pThis->fd, pvBuf, RT_MIN(cbToWrite, SSIZE_MAX));
938	if (cbWritten < 0)
939	{
940	rc = RTErrConvertFromErrno(errno);
941	break;
942	}
943
944	/* advance */
945	pvBuf = (char const *)pvBuf + cbWritten;
946	cbTotalWritten += cbWritten;
947	cbToWrite -= cbWritten;
948	}
949
950	if (pcbWritten)
951	{
952	*pcbWritten = cbTotalWritten;
953	if ( RT_FAILURE(rc)
954	&& cbTotalWritten
955	&& rc != VERR_INVALID_POINTER)
956	rc = VINF_SUCCESS;
957	}
958
959	ASMAtomicDecU32(&pThis->u32State);
960	}
961	return rc;
962	#endif
963	}
964
965
966	RTDECL(int) RTPipeFlush(RTPIPE hPipe)
967	{
968	RTPIPEINTERNAL *pThis = hPipe;
969	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
970	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
971	AssertReturn(!pThis->fRead, VERR_ACCESS_DENIED);
972
973	if (!FlushFileBuffers(pThis->hPipe))
974	{
975	int rc = RTErrConvertFromWin32(GetLastError());
976	if (rc == VERR_BROKEN_PIPE)
977	pThis->fBrokenPipe = true;
978	return rc;
979	}
980	return VINF_SUCCESS;
981	}
982
983
984	RTDECL(int) RTPipeSelectOne(RTPIPE hPipe, RTMSINTERVAL cMillies)
985	{
986	RTPIPEINTERNAL *pThis = hPipe;
987	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
988	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
989
990	uint64_t const StartMsTS = RTTimeMilliTS();
991
992	int rc = RTCritSectEnter(&pThis->CritSect);
993	if (RT_FAILURE(rc))
994	return rc;
995	for (unsigned iLoop = 0;; iLoop++)
996	{
997	HANDLE hWait = INVALID_HANDLE_VALUE;
998	if (pThis->fRead)
999	{
1000	if (pThis->fIOPending)
1001	hWait = pThis->Overlapped.hEvent;
1002	else
1003	{
1004	/* Peek at the pipe buffer and see how many bytes it contains. */
1005	DWORD cbAvailable;
1006	if ( PeekNamedPipe(pThis->hPipe, NULL, 0, NULL, &cbAvailable, NULL)
1007	&& cbAvailable > 0)
1008	{
1009	rc = VINF_SUCCESS;
1010	break;
1011	}
1012
1013	/* Start a zero byte read operation that we can wait on. */
1014	if (cMillies == 0)
1015	{
1016	rc = VERR_TIMEOUT;
1017	break;
1018	}
1019	AssertBreakStmt(pThis->cUsers == 0, rc = VERR_INTERNAL_ERROR_5);
1020	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
1021	DWORD cbRead = 0;
1022	if (ReadFile(pThis->hPipe, pThis->abBuf, 0, &cbRead, &pThis->Overlapped))
1023	{
1024	rc = VINF_SUCCESS;
1025	if (iLoop > 10)
1026	RTThreadYield();
1027	}
1028	else if (GetLastError() == ERROR_IO_PENDING)
1029	{
1030	pThis->cUsers++;
1031	pThis->fIOPending = true;
1032	pThis->fZeroByteRead = true;
1033	hWait = pThis->Overlapped.hEvent;
1034	}
1035	else
1036	rc = RTErrConvertFromWin32(GetLastError());
1037	}
1038	}
1039	else
1040	{
1041	if (pThis->fIOPending)
1042	{
1043	rc = rtPipeWriteCheckCompletion(pThis);
1044	if (RT_FAILURE(rc))
1045	break;
1046	}
1047	if (pThis->fIOPending)
1048	hWait = pThis->Overlapped.hEvent;
1049	else
1050	{
1051	FILE_PIPE_LOCAL_INFORMATION Info;
1052	if (rtPipeQueryInfo(pThis, &Info))
1053	{
1054	/* Check for broken pipe. */
1055	if (Info.NamedPipeState == FILE_PIPE_CLOSING_STATE)
1056	{
1057	rc = VERR_BROKEN_PIPE;
1058	break;
1059	}
1060	/* Check for available write buffer space. */
1061	else if (Info.WriteQuotaAvailable > 0)
1062	{
1063	pThis->fPromisedWritable = false;
1064	rc = VINF_SUCCESS;
1065	break;
1066	}
1067	/* delayed buffer alloc or timeout: phony promise
1068	later: See if we still can associate a semaphore with
1069	the pipe, like on OS/2. */
1070	else if ( Info.OutboundQuota == 0
1071	\|\| cMillies)
1072	{
1073	pThis->fPromisedWritable = true;
1074	rc = VINF_SUCCESS;
1075	break;
1076	}
1077	}
1078	else
1079	{
1080	pThis->fPromisedWritable = true;
1081	rc = VINF_SUCCESS;
1082	break;
1083	}
1084	}
1085	}
1086	if (RT_FAILURE(rc))
1087	break;
1088
1089	/*
1090	* Check for timeout.
1091	*/
1092	DWORD cMsMaxWait = INFINITE;
1093	if ( cMillies != RT_INDEFINITE_WAIT
1094	&& ( hWait != INVALID_HANDLE_VALUE
1095	\|\| iLoop > 10)
1096	)
1097	{
1098	uint64_t cElapsed = RTTimeMilliTS() - StartMsTS;
1099	if (cElapsed >= cMillies)
1100	{
1101	rc = VERR_TIMEOUT;
1102	break;
1103	}
1104	cMsMaxWait = cMillies - (uint32_t)cElapsed;
1105	}
1106
1107	/*
1108	* Wait.
1109	*/
1110	if (hWait != INVALID_HANDLE_VALUE)
1111	{
1112	RTCritSectLeave(&pThis->CritSect);
1113
1114	DWORD dwRc = WaitForSingleObject(hWait, cMsMaxWait);
1115	if (dwRc == WAIT_OBJECT_0)
1116	rc = VINF_SUCCESS;
1117	else if (dwRc == WAIT_TIMEOUT)
1118	rc = VERR_TIMEOUT;
1119	else if (dwRc == WAIT_ABANDONED)
1120	rc = VERR_INVALID_HANDLE;
1121	else
1122	rc = RTErrConvertFromWin32(GetLastError());
1123	if ( RT_FAILURE(rc)
1124	&& pThis->u32Magic != RTPIPE_MAGIC)
1125	return rc;
1126
1127	RTCritSectEnter(&pThis->CritSect);
1128	if (pThis->fZeroByteRead)
1129	{
1130	pThis->cUsers--;
1131	pThis->fIOPending = false;
1132	if (rc != VINF_SUCCESS)
1133	CancelIo(pThis->hPipe);
1134	DWORD cbRead = 0;
1135	GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/);
1136	}
1137	if (RT_FAILURE(rc))
1138	break;
1139	}
1140	}
1141
1142	if (rc == VERR_BROKEN_PIPE)
1143	pThis->fBrokenPipe = true;
1144
1145	RTCritSectLeave(&pThis->CritSect);
1146	return rc;
1147	}
1148
1149
1150	RTDECL(int) RTPipeQueryReadable(RTPIPE hPipe, size_t *pcbReadable)
1151	{
1152	RTPIPEINTERNAL *pThis = hPipe;
1153	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
1154	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
1155	AssertReturn(pThis->fRead, VERR_PIPE_NOT_READ);
1156	AssertPtrReturn(pcbReadable, VERR_INVALID_POINTER);
1157
1158	int rc = RTCritSectEnter(&pThis->CritSect);
1159	if (RT_FAILURE(rc))
1160	return rc;
1161
1162	DWORD cbAvailable = 0;
1163	if (PeekNamedPipe(pThis->hPipe, NULL, 0, NULL, &cbAvailable, NULL))
1164	*pcbReadable = cbAvailable;
1165	else
1166	rc = RTErrConvertFromWin32(GetLastError());
1167
1168	RTCritSectLeave(&pThis->CritSect);
1169	return rc;
1170	}
1171
1172
1173	/**
1174	* Internal RTPollSetAdd helper that returns the handle that should be added to
1175	* the pollset.
1176	*
1177	* @returns Valid handle on success, INVALID_HANDLE_VALUE on failure.
1178	* @param hPipe The pipe handle.
1179	* @param fEvents The events we're polling for.
1180	* @param ph where to put the primary handle.
1181	*/
1182	int rtPipePollGetHandle(RTPIPE hPipe, uint32_t fEvents, PHANDLE ph)
1183	{
1184	RTPIPEINTERNAL *pThis = hPipe;
1185	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
1186	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
1187
1188	AssertReturn(!(fEvents & RTPOLL_EVT_READ) \|\| pThis->fRead, VERR_INVALID_PARAMETER);
1189	AssertReturn(!(fEvents & RTPOLL_EVT_WRITE) \|\| !pThis->fRead, VERR_INVALID_PARAMETER);
1190
1191	/* Later: Try register an event handle with the pipe like on OS/2, there is
1192	a file control for doing this obviously intended for the OS/2 subsys.
1193	The question is whether this still exists on Vista and W7. */
1194	*ph = pThis->Overlapped.hEvent;
1195	return VINF_SUCCESS;
1196	}
1197
1198
1199	/**
1200	* Checks for pending events.
1201	*
1202	* @returns Event mask or 0.
1203	* @param pThis The pipe handle.
1204	* @param fEvents The desired events.
1205	*/
1206	static uint32_t rtPipePollCheck(RTPIPEINTERNAL *pThis, uint32_t fEvents)
1207	{
1208	uint32_t fRetEvents = 0;
1209	if (pThis->fBrokenPipe)
1210	fRetEvents \|= RTPOLL_EVT_ERROR;
1211	else if (pThis->fRead)
1212	{
1213	if (!pThis->fIOPending)
1214	{
1215	DWORD cbAvailable;
1216	if (PeekNamedPipe(pThis->hPipe, NULL, 0, NULL, &cbAvailable, NULL))
1217	{
1218	if ( (fEvents & RTPOLL_EVT_READ)
1219	&& cbAvailable > 0)
1220	fRetEvents \|= RTPOLL_EVT_READ;
1221	}
1222	else
1223	{
1224	if (GetLastError() == ERROR_BROKEN_PIPE)
1225	pThis->fBrokenPipe = true;
1226	fRetEvents \|= RTPOLL_EVT_ERROR;
1227	}
1228	}
1229	}
1230	else
1231	{
1232	if (pThis->fIOPending)
1233	{
1234	rtPipeWriteCheckCompletion(pThis);
1235	if (pThis->fBrokenPipe)
1236	fRetEvents \|= RTPOLL_EVT_ERROR;
1237	}
1238	if ( !pThis->fIOPending
1239	&& !fRetEvents)
1240	{
1241	FILE_PIPE_LOCAL_INFORMATION Info;
1242	if (rtPipeQueryInfo(pThis, &Info))
1243	{
1244	/* Check for broken pipe. */
1245	if (Info.NamedPipeState == FILE_PIPE_CLOSING_STATE)
1246	{
1247	fRetEvents = RTPOLL_EVT_ERROR;
1248	pThis->fBrokenPipe = true;
1249	}
1250
1251	/* Check if there is available buffer space. */
1252	if ( !fRetEvents
1253	&& (fEvents & RTPOLL_EVT_WRITE)
1254	&& ( Info.WriteQuotaAvailable > 0
1255	\|\| Info.OutboundQuota == 0)
1256	)
1257	fRetEvents \|= RTPOLL_EVT_WRITE;
1258	}
1259	else if (fEvents & RTPOLL_EVT_WRITE)
1260	fRetEvents \|= RTPOLL_EVT_WRITE;
1261	}
1262	}
1263
1264	return fRetEvents;
1265	}
1266
1267
1268	/**
1269	* Internal RTPoll helper that polls the pipe handle and, if @a fNoWait is
1270	* clear, starts whatever actions we've got running during the poll call.
1271	*
1272	* @returns 0 if no pending events, actions initiated if @a fNoWait is clear.
1273	* Event mask (in @a fEvents) and no actions if the handle is ready
1274	* already.
1275	* UINT32_MAX (asserted) if the pipe handle is busy in I/O or a
1276	* different poll set.
1277	*
1278	* @param hPipe The pipe handle.
1279	* @param hPollSet The poll set handle (for access checks).
1280	* @param fEvents The events we're polling for.
1281	* @param fFinalEntry Set if this is the final entry for this handle
1282	* in this poll set. This can be used for dealing
1283	* with duplicate entries.
1284	* @param fNoWait Set if it's a zero-wait poll call. Clear if
1285	* we'll wait for an event to occur.
1286	*/
1287	uint32_t rtPipePollStart(RTPIPE hPipe, RTPOLLSET hPollSet, uint32_t fEvents, bool fFinalEntry, bool fNoWait)
1288	{
1289	/** @todo All this polling code could be optimized to make fewer system
1290	* calls; like for instance the ResetEvent calls. */
1291	RTPIPEINTERNAL *pThis = hPipe;
1292	AssertPtrReturn(pThis, UINT32_MAX);
1293	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, UINT32_MAX);
1294
1295	int rc = RTCritSectEnter(&pThis->CritSect);
1296	AssertRCReturn(rc, UINT32_MAX);
1297
1298	/* Check that this is the only current use of this pipe. */
1299	uint32_t fRetEvents;
1300	if ( pThis->cUsers == 0
1301	\|\| pThis->hPollSet == hPollSet)
1302	{
1303	/* Check what the current events are. */
1304	fRetEvents = rtPipePollCheck(pThis, fEvents);
1305	if ( !fRetEvents
1306	&& !fNoWait)
1307	{
1308	/* Make sure the event semaphore has been reset. */
1309	if (!pThis->fIOPending)
1310	{
1311	rc = ResetEvent(pThis->Overlapped.hEvent);
1312	Assert(rc == TRUE);
1313	}
1314
1315	/* Kick off the zero byte read thing if applicable. */
1316	if ( !pThis->fIOPending
1317	&& pThis->fRead
1318	&& (fEvents & RTPOLL_EVT_READ)
1319	)
1320	{
1321	DWORD cbRead = 0;
1322	if (ReadFile(pThis->hPipe, pThis->abBuf, 0, &cbRead, &pThis->Overlapped))
1323	fRetEvents = rtPipePollCheck(pThis, fEvents);
1324	else if (GetLastError() == ERROR_IO_PENDING)
1325	{
1326	pThis->fIOPending = true;
1327	pThis->fZeroByteRead = true;
1328	}
1329	else
1330	fRetEvents = RTPOLL_EVT_ERROR;
1331	}
1332
1333	/* If we're still set for the waiting, record the poll set and
1334	mark the pipe used. */
1335	if (!fRetEvents)
1336	{
1337	pThis->cUsers++;
1338	pThis->hPollSet = hPollSet;
1339	}
1340	}
1341	}
1342	else
1343	{
1344	AssertFailed();
1345	fRetEvents = UINT32_MAX;
1346	}
1347
1348	RTCritSectLeave(&pThis->CritSect);
1349	return fRetEvents;
1350	}
1351
1352
1353	/**
1354	* Called after a WaitForMultipleObjects returned in order to check for pending
1355	* events and stop whatever actions that rtPipePollStart() initiated.
1356	*
1357	* @returns Event mask or 0.
1358	*
1359	* @param hPipe The pipe handle.
1360	* @param fEvents The events we're polling for.
1361	* @param fFinalEntry Set if this is the final entry for this handle
1362	* in this poll set. This can be used for dealing
1363	* with duplicate entries. Only keep in mind that
1364	* this method is called in reverse order, so the
1365	* first call will have this set (when the entire
1366	* set was processed).
1367	* @param fHarvestEvents Set if we should check for pending events.
1368	*/
1369	uint32_t rtPipePollDone(RTPIPE hPipe, uint32_t fEvents, bool fFinalEntry, bool fHarvestEvents)
1370	{
1371	RTPIPEINTERNAL *pThis = hPipe;
1372	AssertPtrReturn(pThis, 0);
1373	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, 0);
1374
1375	int rc = RTCritSectEnter(&pThis->CritSect);
1376	AssertRCReturn(rc, 0);
1377
1378	Assert(pThis->cUsers > 0);
1379
1380
1381	/* Cancel the zero byte read. */
1382	uint32_t fRetEvents = 0;
1383	if (pThis->fZeroByteRead)
1384	{
1385	CancelIo(pThis->hPipe);
1386	DWORD cbRead = 0;
1387	if ( !GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/)
1388	&& GetLastError() != ERROR_OPERATION_ABORTED)
1389	fRetEvents = RTPOLL_EVT_ERROR;
1390
1391	pThis->fIOPending = false;
1392	pThis->fZeroByteRead = false;
1393	}
1394
1395	/* harvest events. */
1396	fRetEvents \|= rtPipePollCheck(pThis, fEvents);
1397
1398	/* update counters. */
1399	pThis->cUsers--;
1400	if (!pThis->cUsers)
1401	pThis->hPollSet = NIL_RTPOLLSET;
1402
1403	RTCritSectLeave(&pThis->CritSect);
1404	return fRetEvents;
1405	}
1406

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Runtime/r3/win/pipe-win.cpp@ 40654

Download in other formats: