1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
|
/** @file
* IPRT - Anonymous Pipes.
*/
/*
* Copyright (C) 2010-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef IPRT_INCLUDED_pipe_h
#define IPRT_INCLUDED_pipe_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <iprt/cdefs.h>
#include <iprt/types.h>
#include <iprt/fs.h>
RT_C_DECLS_BEGIN
/** @defgroup grp_rt_pipe RTPipe - Anonymous Pipes
* @ingroup grp_rt
* @{
*/
/**
* Create an anonymous pipe.
*
* @returns IPRT status code.
* @param phPipeRead Where to return the read end of the pipe.
* @param phPipeWrite Where to return the write end of the pipe.
* @param fFlags A combination of RTPIPE_C_XXX defines.
*/
RTDECL(int) RTPipeCreate(PRTPIPE phPipeRead, PRTPIPE phPipeWrite, uint32_t fFlags);
/** @name RTPipeCreate flags.
* @{ */
/** Mark the read end as inheritable. */
#define RTPIPE_C_INHERIT_READ RT_BIT(0)
/** Mark the write end as inheritable. */
#define RTPIPE_C_INHERIT_WRITE RT_BIT(1)
/** Mask of valid flags. */
#define RTPIPE_C_VALID_MASK UINT32_C(0x00000003)
/** @} */
/**
* Closes one end of a pipe created by RTPipeCreate.
*
* @returns IPRT status code.
* @param hPipe The pipe end to close.
*/
RTDECL(int) RTPipeClose(RTPIPE hPipe);
/**
* Creates an IPRT pipe handle from a native one.
*
* Do NOT use the native handle after passing it to this function, IPRT owns it
* and might even have closed in some cases (in order to gain some query
* information access on Windows).
*
* @returns IPRT status code.
* @param phPipe Where to return the pipe handle.
* @param hNativePipe The native pipe handle.
* @param fFlags Pipe flags, RTPIPE_N_XXX.
*/
RTDECL(int) RTPipeFromNative(PRTPIPE phPipe, RTHCINTPTR hNativePipe, uint32_t fFlags);
/** @name RTPipeFromNative flags.
* @{ */
/** The read end. */
#define RTPIPE_N_READ RT_BIT(0)
/** The write end. */
#define RTPIPE_N_WRITE RT_BIT(1)
/** Make sure the pipe is inheritable if set and not inheritable when clear. */
#define RTPIPE_N_INHERIT RT_BIT(2)
/** Mask of valid flags. */
#define RTPIPE_N_VALID_MASK UINT32_C(0x00000007)
/** @} */
/**
* Gets the native handle for an IPRT pipe handle.
*
* This is mainly for passing a pipe to a child and then closing the parent
* handle. IPRT also uses it internally to implement RTProcCreatEx and
* RTPollSetAdd on some platforms. Do NOT expect sane API behavior if used
* for any other purpose.
*
* @returns The native handle. -1 on failure.
* @param hPipe The IPRT pipe handle.
*/
RTDECL(RTHCINTPTR) RTPipeToNative(RTPIPE hPipe);
/**
* Get the creation inheritability of the pipe.
*
* @returns true if inherited by children (when pipe was created), false if not.
* @param hPipe The IPRT pipe handle.
*/
RTDECL(int) RTPipeGetCreationInheritability(RTPIPE hPipe);
/**
* Read bytes from a pipe, non-blocking.
*
* @returns IPRT status code.
* @retval VERR_WRONG_ORDER if racing a call to RTPipeReadBlocking.
* @retval VERR_BROKEN_PIPE if the remote party has disconnected and we've read
* all the buffered data.
* @retval VINF_TRY_AGAIN if no data was available. @a *pcbRead will be set to
* 0.
* @retval VERR_ACCESS_DENIED if it's a write pipe.
*
* @param hPipe The IPRT pipe handle to read from.
* @param pvBuf Where to put the bytes we read.
* @param cbToRead How much to read. Must be greater than 0.
* @param pcbRead Where to return the number of bytes that has been
* read (mandatory). This is 0 if there is no more
* bytes to read.
* @sa RTPipeReadBlocking.
*/
RTDECL(int) RTPipeRead(RTPIPE hPipe, void *pvBuf, size_t cbToRead, size_t *pcbRead);
/**
* Read bytes from a pipe, blocking.
*
* @returns IPRT status code.
* @retval VERR_WRONG_ORDER if racing a call to RTPipeRead.
* @retval VERR_BROKEN_PIPE if the remote party has disconnected and we've read
* all the buffered data.
* @retval VERR_ACCESS_DENIED if it's a write pipe.
*
* @param hPipe The IPRT pipe handle to read from.
* @param pvBuf Where to put the bytes we read.
* @param cbToRead How much to read.
* @param pcbRead Where to return the number of bytes that has been
* read. Optional.
*/
RTDECL(int) RTPipeReadBlocking(RTPIPE hPipe, void *pvBuf, size_t cbToRead, size_t *pcbRead);
/**
* Write bytes to a pipe, non-blocking.
*
* @returns IPRT status code.
* @retval VERR_WRONG_ORDER if racing a call to RTPipeWriteBlocking.
* @retval VERR_BROKEN_PIPE if the remote party has disconnected. Does not
* trigger when @a cbToWrite is 0.
* @retval VINF_TRY_AGAIN if no data was written. @a *pcbWritten will be set
* to 0.
* @retval VERR_ACCESS_DENIED if it's a read pipe.
*
* @param hPipe The IPRT pipe handle to write to.
* @param pvBuf What to write.
* @param cbToWrite How much to write.
* @param pcbWritten How many bytes we wrote, mandatory. The return can
* be 0.
*/
RTDECL(int) RTPipeWrite(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
/**
* Write bytes to a pipe, blocking.
*
* @returns IPRT status code.
* @retval VERR_WRONG_ORDER if racing a call to RTPipeWrite.
* @retval VERR_BROKEN_PIPE if the remote party has disconnected. Does not
* trigger when @a cbToWrite is 0.
* @retval VERR_ACCESS_DENIED if it's a read pipe.
*
* @param hPipe The IPRT pipe handle to write to.
* @param pvBuf What to write.
* @param cbToWrite How much to write.
* @param pcbWritten How many bytes we wrote, optional. If NULL then all
* bytes will be written.
*/
RTDECL(int) RTPipeWriteBlocking(RTPIPE hPipe, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
/**
* Flushes the buffers for the specified pipe and making sure the other party
* reads them.
*
* @returns IPRT status code.
* @retval VERR_NOT_SUPPORTED if not supported by the OS.
* @retval VERR_BROKEN_PIPE if the remote party has disconnected.
* @retval VERR_ACCESS_DENIED if it's a read pipe.
*
* @param hPipe The IPRT pipe handle to flush.
*/
RTDECL(int) RTPipeFlush(RTPIPE hPipe);
/**
* Checks if the pipe is ready for reading or writing (depending on the pipe
* end).
*
* @returns IPRT status code.
* @retval VERR_TIMEOUT if the timeout was reached before the pipe was ready
* for reading/writing.
* @retval VERR_NOT_SUPPORTED if not supported by the OS?
*
* @param hPipe The IPRT pipe handle to select on.
* @param cMillies Number of milliseconds to wait. Use
* RT_INDEFINITE_WAIT to wait for ever.
*/
RTDECL(int) RTPipeSelectOne(RTPIPE hPipe, RTMSINTERVAL cMillies);
/**
* Queries the number of bytes immediately available for reading.
*
* @returns IPRT status code.
* @retval VERR_NOT_SUPPORTED if not supported by the OS. The caller shall
* handle this case.
*
* @param hPipe The IPRT read pipe handle.
* @param pcbReadable Where to return the number of bytes that is ready
* to be read.
*/
RTDECL(int) RTPipeQueryReadable(RTPIPE hPipe, size_t *pcbReadable);
/**
* Query information about a pipe (mainly a VFS I/O stream formality).
*
* The only thing we guarentee to be returned is RTFSOBJINFO::Attr.fMode being
* set to FIFO and will reflect the read/write end in the RTFS_DOS_READONLY,
* RTFS_UNIX_IRUSR and RTFS_UNIX_IWUSR bits.
*
* Some implementations sometimes provide the pipe buffer size via
* RTFSOBJINFO::cbAllocated.
*
* Some implementations sometimes provide the available read data or available
* write space via RTFSOBJINFO::cbObject.
*
* Some implementations sometimes provide valid device and/or inode numbers.
*
* @returns iprt status code.
*
* @param hPipe The IPRT read pipe handle.
* @param pObjInfo Object information structure to be filled on successful
* return.
* @param enmAddAttr Which set of additional attributes to request. Use
* RTFSOBJATTRADD_NOTHING if this doesn't matter.
*/
RTDECL(int) RTPipeQueryInfo(RTPIPE hPipe, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
/** @} */
RT_C_DECLS_END
#endif /* !IPRT_INCLUDED_pipe_h */
|
