pipe-win.cpp@ 68976

Last change on this file since 68976 was 62592, checked in by vboxsync, 8 years ago
IPRT: More unused parameters and undefined preprocessor macor warning (C4668) fixes/workarounds. The latter triggers in stdint.h from the compiler and in windows SDK/DDK headers.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 50.2 KB

Line
1	/* $Id: pipe-win.cpp 62592 2016-07-27 13:24:48Z vboxsync $ */
2	/** @file
3	* IPRT - Anonymous Pipes, Windows Implementation.
4	*/
5
6	/*
7	* Copyright (C) 2010-2016 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 <iprt/win/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 0x00000001U
130	#define FILE_PIPE_LISTENING_STATE 0x00000002U
131	#define FILE_PIPE_CONNECTED_STATE 0x00000003U
132	#define FILE_PIPE_CLOSING_STATE 0x00000004U
133
134	#define FILE_PIPE_INBOUND 0x00000000U
135	#define FILE_PIPE_OUTBOUND 0x00000001U
136	#define FILE_PIPE_FULL_DUPLEX 0x00000002U
137
138	#define FILE_PIPE_CLIENT_END 0x00000000U
139	#define FILE_PIPE_SERVER_END 0x00000001U
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 rtPipeQueryNtInfo(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 rtPipeQueryNtInfo 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 (rtPipeQueryNtInfo(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 (rtPipeQueryNtInfo(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	\|\| Info.NamedPipeConfiguration == FILE_PIPE_FULL_DUPLEX,
525	VERR_INVALID_HANDLE);
526	if ( RT_SUCCESS(rc)
527	&& hNative2 == INVALID_HANDLE_VALUE
528	&& !SetHandleInformation(hNative,
529	HANDLE_FLAG_INHERIT /dwMask/,
530	fFlags & RTPIPE_N_INHERIT ? HANDLE_FLAG_INHERIT : 0))
531	{
532	rc = RTErrConvertFromWin32(GetLastError());
533	AssertMsgFailed(("%Rrc\n", rc));
534	}
535	if (RT_SUCCESS(rc))
536	{
537	/*
538	* Ok, we're good!
539	*/
540	/** @todo This is bogus for standard handles! */
541	if (hNative2 != INVALID_HANDLE_VALUE)
542	CloseHandle(hNative);
543	*phPipe = pThis;
544	return VINF_SUCCESS;
545	}
546	}
547
548	/* Bail out. */
549	if (hNative2 != INVALID_HANDLE_VALUE)
550	CloseHandle(hNative2);
551	CloseHandle(pThis->Overlapped.hEvent);
552	}
553	RTCritSectDelete(&pThis->CritSect);
554	}
555	RTMemFree(pThis);
556	return rc;
557	}
558
559
560	RTDECL(RTHCINTPTR) RTPipeToNative(RTPIPE hPipe)
561	{
562	RTPIPEINTERNAL *pThis = hPipe;
563	AssertPtrReturn(pThis, -1);
564	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, -1);
565
566	return (RTHCINTPTR)pThis->hPipe;
567	}
568
569
570	RTDECL(int) RTPipeRead(RTPIPE hPipe, void pvBuf, size_t cbToRead, size_t pcbRead)
571	{
572	RTPIPEINTERNAL *pThis = hPipe;
573	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
574	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
575	AssertReturn(pThis->fRead, VERR_ACCESS_DENIED);
576	AssertPtr(pcbRead);
577	AssertPtr(pvBuf);
578
579	int rc = RTCritSectEnter(&pThis->CritSect);
580	if (RT_SUCCESS(rc))
581	{
582	/* No concurrent readers, sorry. */
583	if (pThis->cUsers == 0)
584	{
585	pThis->cUsers++;
586
587	/*
588	* Kick of a an overlapped read. It should return immediately if
589	* there is bytes in the buffer. If not, we'll cancel it and see
590	* what we get back.
591	*/
592	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
593	DWORD cbRead = 0;
594	if ( cbToRead == 0
595	\|\| ReadFile(pThis->hPipe, pvBuf,
596	cbToRead <= ~(DWORD)0 ? (DWORD)cbToRead : ~(DWORD)0,
597	&cbRead, &pThis->Overlapped))
598	{
599	*pcbRead = cbRead;
600	rc = VINF_SUCCESS;
601	}
602	else if (GetLastError() == ERROR_IO_PENDING)
603	{
604	pThis->fIOPending = true;
605	RTCritSectLeave(&pThis->CritSect);
606
607	if (!CancelIo(pThis->hPipe))
608	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
609	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/))
610	{
611	*pcbRead = cbRead;
612	rc = VINF_SUCCESS;
613	}
614	else if (GetLastError() == ERROR_OPERATION_ABORTED)
615	{
616	*pcbRead = 0;
617	rc = VINF_TRY_AGAIN;
618	}
619	else
620	rc = RTErrConvertFromWin32(GetLastError());
621
622	RTCritSectEnter(&pThis->CritSect);
623	pThis->fIOPending = false;
624	}
625	else
626	rc = RTErrConvertFromWin32(GetLastError());
627	if (rc == VERR_BROKEN_PIPE)
628	pThis->fBrokenPipe = true;
629
630	pThis->cUsers--;
631	}
632	else
633	rc = VERR_WRONG_ORDER;
634	RTCritSectLeave(&pThis->CritSect);
635	}
636	return rc;
637	}
638
639
640	RTDECL(int) RTPipeReadBlocking(RTPIPE hPipe, void pvBuf, size_t cbToRead, size_t pcbRead)
641	{
642	RTPIPEINTERNAL *pThis = hPipe;
643	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
644	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
645	AssertReturn(pThis->fRead, VERR_ACCESS_DENIED);
646	AssertPtr(pvBuf);
647
648	int rc = RTCritSectEnter(&pThis->CritSect);
649	if (RT_SUCCESS(rc))
650	{
651	/* No concurrent readers, sorry. */
652	if (pThis->cUsers == 0)
653	{
654	pThis->cUsers++;
655
656	size_t cbTotalRead = 0;
657	while (cbToRead > 0)
658	{
659	/*
660	* Kick of a an overlapped read. It should return immediately if
661	* there is bytes in the buffer. If not, we'll cancel it and see
662	* what we get back.
663	*/
664	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
665	DWORD cbRead = 0;
666	pThis->fIOPending = true;
667	RTCritSectLeave(&pThis->CritSect);
668
669	if (ReadFile(pThis->hPipe, pvBuf,
670	cbToRead <= ~(DWORD)0 ? (DWORD)cbToRead : ~(DWORD)0,
671	&cbRead, &pThis->Overlapped))
672	rc = VINF_SUCCESS;
673	else if (GetLastError() == ERROR_IO_PENDING)
674	{
675	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
676	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/))
677	rc = VINF_SUCCESS;
678	else
679	rc = RTErrConvertFromWin32(GetLastError());
680	}
681	else
682	rc = RTErrConvertFromWin32(GetLastError());
683
684	RTCritSectEnter(&pThis->CritSect);
685	pThis->fIOPending = false;
686	if (RT_FAILURE(rc))
687	break;
688
689	/* advance */
690	cbToRead -= cbRead;
691	cbTotalRead += cbRead;
692	pvBuf = (uint8_t *)pvBuf + cbRead;
693	}
694
695	if (rc == VERR_BROKEN_PIPE)
696	pThis->fBrokenPipe = true;
697
698	if (pcbRead)
699	{
700	*pcbRead = cbTotalRead;
701	if ( RT_FAILURE(rc)
702	&& cbTotalRead
703	&& rc != VERR_INVALID_POINTER)
704	rc = VINF_SUCCESS;
705	}
706
707	pThis->cUsers--;
708	}
709	else
710	rc = VERR_WRONG_ORDER;
711	RTCritSectLeave(&pThis->CritSect);
712	}
713	return rc;
714	}
715
716
717	RTDECL(int) RTPipeWrite(RTPIPE hPipe, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
718	{
719	RTPIPEINTERNAL *pThis = hPipe;
720	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
721	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
722	AssertReturn(!pThis->fRead, VERR_ACCESS_DENIED);
723	AssertPtr(pcbWritten);
724	AssertPtr(pvBuf);
725
726	int rc = RTCritSectEnter(&pThis->CritSect);
727	if (RT_SUCCESS(rc))
728	{
729	/* No concurrent writers, sorry. */
730	if (pThis->cUsers == 0)
731	{
732	pThis->cUsers++;
733
734	/* If I/O is pending, check if it has completed. */
735	if (pThis->fIOPending)
736	rc = rtPipeWriteCheckCompletion(pThis);
737	else
738	rc = VINF_SUCCESS;
739	if (rc == VINF_SUCCESS)
740	{
741	Assert(!pThis->fIOPending);
742
743	/* Adjust the number of bytes to write to fit into the current
744	buffer quota, unless we've promised stuff in RTPipeSelectOne.
745	WriteQuotaAvailable better not be zero when it shouldn't!! */
746	FILE_PIPE_LOCAL_INFORMATION Info;
747	if ( !pThis->fPromisedWritable
748	&& cbToWrite > 0
749	&& rtPipeQueryNtInfo(pThis, &Info))
750	{
751	if (Info.NamedPipeState == FILE_PIPE_CLOSING_STATE)
752	rc = VERR_BROKEN_PIPE;
753	/** @todo fixme: To get the pipe writing support to work the
754	* block below needs to be commented out until a
755	* way is found to address the problem of the incorrectly
756	* set field Info.WriteQuotaAvailable. */
757	#if 0
758	else if ( cbToWrite >= Info.WriteQuotaAvailable
759	&& Info.OutboundQuota != 0
760	&& (Info.WriteQuotaAvailable \|\| pThis->cbBounceBufAlloc)
761	)
762	{
763	cbToWrite = Info.WriteQuotaAvailable;
764	if (!cbToWrite)
765	rc = VINF_TRY_AGAIN;
766	}
767	#endif
768	}
769	pThis->fPromisedWritable = false;
770
771	/* Do the bounce buffering. */
772	if ( pThis->cbBounceBufAlloc < cbToWrite
773	&& pThis->cbBounceBufAlloc < RTPIPE_NT_SIZE)
774	{
775	if (cbToWrite > RTPIPE_NT_SIZE)
776	cbToWrite = RTPIPE_NT_SIZE;
777	void *pv = RTMemRealloc(pThis->pbBounceBuf, RT_ALIGN_Z(cbToWrite, _1K));
778	if (pv)
779	{
780	pThis->pbBounceBuf = (uint8_t *)pv;
781	pThis->cbBounceBufAlloc = RT_ALIGN_Z(cbToWrite, _1K);
782	}
783	else
784	rc = VERR_NO_MEMORY;
785	}
786	else if (cbToWrite > RTPIPE_NT_SIZE)
787	cbToWrite = RTPIPE_NT_SIZE;
788	if (RT_SUCCESS(rc) && cbToWrite)
789	{
790	memcpy(pThis->pbBounceBuf, pvBuf, cbToWrite);
791	pThis->cbBounceBufUsed = (uint32_t)cbToWrite;
792
793	/* Submit the write. */
794	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
795	DWORD cbWritten = 0;
796	if (WriteFile(pThis->hPipe, pThis->pbBounceBuf, (DWORD)pThis->cbBounceBufUsed,
797	&cbWritten, &pThis->Overlapped))
798	{
799	*pcbWritten = cbWritten;
800	rc = VINF_SUCCESS;
801	}
802	else if (GetLastError() == ERROR_IO_PENDING)
803	{
804	*pcbWritten = cbToWrite;
805	pThis->fIOPending = true;
806	rc = VINF_SUCCESS;
807	}
808	else if (GetLastError() == ERROR_NO_DATA)
809	rc = VERR_BROKEN_PIPE;
810	else
811	rc = RTErrConvertFromWin32(GetLastError());
812	}
813	else if (RT_SUCCESS(rc))
814	*pcbWritten = 0;
815	}
816	else if (RT_SUCCESS(rc))
817	*pcbWritten = 0;
818
819	if (rc == VERR_BROKEN_PIPE)
820	pThis->fBrokenPipe = true;
821
822	pThis->cUsers--;
823	}
824	else
825	rc = VERR_WRONG_ORDER;
826	RTCritSectLeave(&pThis->CritSect);
827	}
828	return rc;
829	}
830
831
832	RTDECL(int) RTPipeWriteBlocking(RTPIPE hPipe, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
833	{
834	RTPIPEINTERNAL *pThis = hPipe;
835	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
836	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
837	AssertReturn(!pThis->fRead, VERR_ACCESS_DENIED);
838	AssertPtr(pvBuf);
839	AssertPtrNull(pcbWritten);
840
841	int rc = RTCritSectEnter(&pThis->CritSect);
842	if (RT_SUCCESS(rc))
843	{
844	/* No concurrent writers, sorry. */
845	if (pThis->cUsers == 0)
846	{
847	pThis->cUsers++;
848
849	/*
850	* If I/O is pending, wait for it to complete.
851	*/
852	if (pThis->fIOPending)
853	{
854	rc = rtPipeWriteCheckCompletion(pThis);
855	while (rc == VINF_TRY_AGAIN)
856	{
857	Assert(pThis->fIOPending);
858	HANDLE hEvent = pThis->Overlapped.hEvent;
859	RTCritSectLeave(&pThis->CritSect);
860	WaitForSingleObject(hEvent, INFINITE);
861	RTCritSectEnter(&pThis->CritSect);
862	}
863	}
864	if (RT_SUCCESS(rc))
865	{
866	Assert(!pThis->fIOPending);
867	pThis->fPromisedWritable = false;
868
869	/*
870	* Try write everything.
871	* No bounce buffering, cUsers protects us.
872	*/
873	size_t cbTotalWritten = 0;
874	while (cbToWrite > 0)
875	{
876	rc = ResetEvent(pThis->Overlapped.hEvent); Assert(rc == TRUE);
877	pThis->fIOPending = true;
878	RTCritSectLeave(&pThis->CritSect);
879
880	DWORD cbWritten = 0;
881	if (WriteFile(pThis->hPipe, pvBuf,
882	cbToWrite <= ~(DWORD)0 ? (DWORD)cbToWrite : ~(DWORD)0,
883	&cbWritten, &pThis->Overlapped))
884	rc = VINF_SUCCESS;
885	else if (GetLastError() == ERROR_IO_PENDING)
886	{
887	WaitForSingleObject(pThis->Overlapped.hEvent, INFINITE);
888	if (GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbWritten, TRUE /fWait/))
889	rc = VINF_SUCCESS;
890	else
891	rc = RTErrConvertFromWin32(GetLastError());
892	}
893	else if (GetLastError() == ERROR_NO_DATA)
894	rc = VERR_BROKEN_PIPE;
895	else
896	rc = RTErrConvertFromWin32(GetLastError());
897
898	RTCritSectEnter(&pThis->CritSect);
899	pThis->fIOPending = false;
900	if (RT_FAILURE(rc))
901	break;
902
903	/* advance */
904	pvBuf = (char const *)pvBuf + cbWritten;
905	cbTotalWritten += cbWritten;
906	cbToWrite -= cbWritten;
907	}
908
909	if (pcbWritten)
910	{
911	*pcbWritten = cbTotalWritten;
912	if ( RT_FAILURE(rc)
913	&& cbTotalWritten
914	&& rc != VERR_INVALID_POINTER)
915	rc = VINF_SUCCESS;
916	}
917	}
918
919	if (rc == VERR_BROKEN_PIPE)
920	pThis->fBrokenPipe = true;
921
922	pThis->cUsers--;
923	}
924	else
925	rc = VERR_WRONG_ORDER;
926	RTCritSectLeave(&pThis->CritSect);
927	}
928	return rc;
929
930	#if 0 /** @todo r=bird: What's this? */
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 (rtPipeQueryNtInfo(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	RTDECL(int) RTPipeQueryInfo(RTPIPE hPipe, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr)
1174	{
1175	RTPIPEINTERNAL *pThis = hPipe;
1176	AssertPtrReturn(pThis, 0);
1177	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, 0);
1178
1179	int rc = RTCritSectEnter(&pThis->CritSect);
1180	AssertRCReturn(rc, 0);
1181
1182	rtPipeFakeQueryInfo(pObjInfo, enmAddAttr, pThis->fRead);
1183
1184	FILE_PIPE_LOCAL_INFORMATION Info;
1185	if (rtPipeQueryNtInfo(pThis, &Info))
1186	{
1187	pObjInfo->cbAllocated = pThis->fRead ? Info.InboundQuota : Info.OutboundQuota;
1188	pObjInfo->cbObject = pThis->fRead ? Info.ReadDataAvailable : Info.WriteQuotaAvailable;
1189	}
1190
1191	RTCritSectLeave(&pThis->CritSect);
1192	return VINF_SUCCESS;
1193	}
1194
1195
1196	int rtPipePollGetHandle(RTPIPE hPipe, uint32_t fEvents, PRTHCINTPTR phNative)
1197	{
1198	RTPIPEINTERNAL *pThis = hPipe;
1199	AssertPtrReturn(pThis, VERR_INVALID_HANDLE);
1200	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, VERR_INVALID_HANDLE);
1201
1202	AssertReturn(!(fEvents & RTPOLL_EVT_READ) \|\| pThis->fRead, VERR_INVALID_PARAMETER);
1203	AssertReturn(!(fEvents & RTPOLL_EVT_WRITE) \|\| !pThis->fRead, VERR_INVALID_PARAMETER);
1204
1205	/* Later: Try register an event handle with the pipe like on OS/2, there is
1206	a file control for doing this obviously intended for the OS/2 subsys.
1207	The question is whether this still exists on Vista and W7. */
1208	*phNative = (RTHCINTPTR)pThis->Overlapped.hEvent;
1209	return VINF_SUCCESS;
1210	}
1211
1212
1213	/**
1214	* Checks for pending events.
1215	*
1216	* @returns Event mask or 0.
1217	* @param pThis The pipe handle.
1218	* @param fEvents The desired events.
1219	*/
1220	static uint32_t rtPipePollCheck(RTPIPEINTERNAL *pThis, uint32_t fEvents)
1221	{
1222	uint32_t fRetEvents = 0;
1223	if (pThis->fBrokenPipe)
1224	fRetEvents \|= RTPOLL_EVT_ERROR;
1225	else if (pThis->fRead)
1226	{
1227	if (!pThis->fIOPending)
1228	{
1229	DWORD cbAvailable;
1230	if (PeekNamedPipe(pThis->hPipe, NULL, 0, NULL, &cbAvailable, NULL))
1231	{
1232	if ( (fEvents & RTPOLL_EVT_READ)
1233	&& cbAvailable > 0)
1234	fRetEvents \|= RTPOLL_EVT_READ;
1235	}
1236	else
1237	{
1238	if (GetLastError() == ERROR_BROKEN_PIPE)
1239	pThis->fBrokenPipe = true;
1240	fRetEvents \|= RTPOLL_EVT_ERROR;
1241	}
1242	}
1243	}
1244	else
1245	{
1246	if (pThis->fIOPending)
1247	{
1248	rtPipeWriteCheckCompletion(pThis);
1249	if (pThis->fBrokenPipe)
1250	fRetEvents \|= RTPOLL_EVT_ERROR;
1251	}
1252	if ( !pThis->fIOPending
1253	&& !fRetEvents)
1254	{
1255	FILE_PIPE_LOCAL_INFORMATION Info;
1256	if (rtPipeQueryNtInfo(pThis, &Info))
1257	{
1258	/* Check for broken pipe. */
1259	if (Info.NamedPipeState == FILE_PIPE_CLOSING_STATE)
1260	{
1261	fRetEvents = RTPOLL_EVT_ERROR;
1262	pThis->fBrokenPipe = true;
1263	}
1264
1265	/* Check if there is available buffer space. */
1266	if ( !fRetEvents
1267	&& (fEvents & RTPOLL_EVT_WRITE)
1268	&& ( Info.WriteQuotaAvailable > 0
1269	\|\| Info.OutboundQuota == 0)
1270	)
1271	fRetEvents \|= RTPOLL_EVT_WRITE;
1272	}
1273	else if (fEvents & RTPOLL_EVT_WRITE)
1274	fRetEvents \|= RTPOLL_EVT_WRITE;
1275	}
1276	}
1277
1278	return fRetEvents;
1279	}
1280
1281
1282	/**
1283	* Internal RTPoll helper that polls the pipe handle and, if @a fNoWait is
1284	* clear, starts whatever actions we've got running during the poll call.
1285	*
1286	* @returns 0 if no pending events, actions initiated if @a fNoWait is clear.
1287	* Event mask (in @a fEvents) and no actions if the handle is ready
1288	* already.
1289	* UINT32_MAX (asserted) if the pipe handle is busy in I/O or a
1290	* different poll set.
1291	*
1292	* @param hPipe The pipe handle.
1293	* @param hPollSet The poll set handle (for access checks).
1294	* @param fEvents The events we're polling for.
1295	* @param fFinalEntry Set if this is the final entry for this handle
1296	* in this poll set. This can be used for dealing
1297	* with duplicate entries.
1298	* @param fNoWait Set if it's a zero-wait poll call. Clear if
1299	* we'll wait for an event to occur.
1300	*/
1301	uint32_t rtPipePollStart(RTPIPE hPipe, RTPOLLSET hPollSet, uint32_t fEvents, bool fFinalEntry, bool fNoWait)
1302	{
1303	/** @todo All this polling code could be optimized to make fewer system
1304	* calls; like for instance the ResetEvent calls. */
1305	RTPIPEINTERNAL *pThis = hPipe;
1306	AssertPtrReturn(pThis, UINT32_MAX);
1307	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, UINT32_MAX);
1308	RT_NOREF_PV(fFinalEntry);
1309
1310	int rc = RTCritSectEnter(&pThis->CritSect);
1311	AssertRCReturn(rc, UINT32_MAX);
1312
1313	/* Check that this is the only current use of this pipe. */
1314	uint32_t fRetEvents;
1315	if ( pThis->cUsers == 0
1316	\|\| pThis->hPollSet == hPollSet)
1317	{
1318	/* Check what the current events are. */
1319	fRetEvents = rtPipePollCheck(pThis, fEvents);
1320	if ( !fRetEvents
1321	&& !fNoWait)
1322	{
1323	/* Make sure the event semaphore has been reset. */
1324	if (!pThis->fIOPending)
1325	{
1326	rc = ResetEvent(pThis->Overlapped.hEvent);
1327	Assert(rc == TRUE);
1328	}
1329
1330	/* Kick off the zero byte read thing if applicable. */
1331	if ( !pThis->fIOPending
1332	&& pThis->fRead
1333	&& (fEvents & RTPOLL_EVT_READ)
1334	)
1335	{
1336	DWORD cbRead = 0;
1337	if (ReadFile(pThis->hPipe, pThis->abBuf, 0, &cbRead, &pThis->Overlapped))
1338	fRetEvents = rtPipePollCheck(pThis, fEvents);
1339	else if (GetLastError() == ERROR_IO_PENDING)
1340	{
1341	pThis->fIOPending = true;
1342	pThis->fZeroByteRead = true;
1343	}
1344	else
1345	fRetEvents = RTPOLL_EVT_ERROR;
1346	}
1347
1348	/* If we're still set for the waiting, record the poll set and
1349	mark the pipe used. */
1350	if (!fRetEvents)
1351	{
1352	pThis->cUsers++;
1353	pThis->hPollSet = hPollSet;
1354	}
1355	}
1356	}
1357	else
1358	{
1359	AssertFailed();
1360	fRetEvents = UINT32_MAX;
1361	}
1362
1363	RTCritSectLeave(&pThis->CritSect);
1364	return fRetEvents;
1365	}
1366
1367
1368	/**
1369	* Called after a WaitForMultipleObjects returned in order to check for pending
1370	* events and stop whatever actions that rtPipePollStart() initiated.
1371	*
1372	* @returns Event mask or 0.
1373	*
1374	* @param hPipe The pipe handle.
1375	* @param fEvents The events we're polling for.
1376	* @param fFinalEntry Set if this is the final entry for this handle
1377	* in this poll set. This can be used for dealing
1378	* with duplicate entries. Only keep in mind that
1379	* this method is called in reverse order, so the
1380	* first call will have this set (when the entire
1381	* set was processed).
1382	* @param fHarvestEvents Set if we should check for pending events.
1383	*/
1384	uint32_t rtPipePollDone(RTPIPE hPipe, uint32_t fEvents, bool fFinalEntry, bool fHarvestEvents)
1385	{
1386	RTPIPEINTERNAL *pThis = hPipe;
1387	AssertPtrReturn(pThis, 0);
1388	AssertReturn(pThis->u32Magic == RTPIPE_MAGIC, 0);
1389	RT_NOREF_PV(fFinalEntry);
1390	RT_NOREF_PV(fHarvestEvents);
1391
1392	int rc = RTCritSectEnter(&pThis->CritSect);
1393	AssertRCReturn(rc, 0);
1394
1395	Assert(pThis->cUsers > 0);
1396
1397
1398	/* Cancel the zero byte read. */
1399	uint32_t fRetEvents = 0;
1400	if (pThis->fZeroByteRead)
1401	{
1402	CancelIo(pThis->hPipe);
1403	DWORD cbRead = 0;
1404	if ( !GetOverlappedResult(pThis->hPipe, &pThis->Overlapped, &cbRead, TRUE /fWait/)
1405	&& GetLastError() != ERROR_OPERATION_ABORTED)
1406	fRetEvents = RTPOLL_EVT_ERROR;
1407
1408	pThis->fIOPending = false;
1409	pThis->fZeroByteRead = false;
1410	}
1411
1412	/* harvest events. */
1413	fRetEvents \|= rtPipePollCheck(pThis, fEvents);
1414
1415	/* update counters. */
1416	pThis->cUsers--;
1417	/** @todo This isn't sane, or is it? See OS/2 impl. */
1418	if (!pThis->cUsers)
1419	pThis->hPollSet = NIL_RTPOLLSET;
1420
1421	RTCritSectLeave(&pThis->CritSect);
1422	return fRetEvents;
1423	}
1424

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

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

Download in other formats: