Print this page
5025 import and use mandoc
Reviewed by: Hans Rosenfeld <hans.rosenfeld@nexenta.com>
Reviewed by: Igor Kozhukhov <ikozhukhov@gmail.com>
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Albert Lee <trisk@nexenta.com>
Approved by: TBD
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man2/pipe.2
+++ new/usr/src/man/man2/pipe.2
1 1 '\" te
2 2 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
3 3 .\" Copyright 1989 AT&T
4 4 .\" Portions Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
5 5 .\" Portions Copyright (c) 2013, OmniTI Computer Consulting, Inc. All Rights Reserved
6 6 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
7 7 .\" http://www.opengroup.org/bookstore/.
8 8 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
9 9 .\" This notice shall appear on any product containing this material.
10 10 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
11 11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
12 12 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
13 13 .TH PIPE 2 "Apr 19, 2013"
14 14 .SH NAME
15 15 pipe \- create an interprocess channel
16 16 .SH SYNOPSIS
17 17 .LP
18 18 .nf
19 19 #include <unistd.h>
20 20
21 21 \fBint\fR \fBpipe\fR(\fBint\fR \fIfildes\fR[2]);
22 22
23 23 \fBint\fR \fBpipe2\fR(\fBint\fR \fIfildes\fR[2], \fBint\fR \fIflags\fR);
24 24 .fi
25 25
26 26 .SH DESCRIPTION
27 27 .sp
28 28 .LP
29 29 The \fBpipe()\fR and pipe2() functions create an I/O mechanism called a
30 30 pipe and returns two file descriptors, \fIfildes\fR[\fB0\fR] and
31 31 \fIfildes\fR[\fB1\fR]. The files associated with \fIfildes\fR[\fB0\fR]
32 32 and \fIfildes\fR[\fB1\fR] are streams and are both opened for reading and
33 33 writing. The \fBpipe()\fR call will clear the \fBO_NDELAY\fR,
|
↓ open down ↓ |
33 lines elided |
↑ open up ↑ |
34 34 \fBO_NONBLOCK\fR, and \fBFD_CLOEXEC\fR flags on both file descriptors. The
35 35 \fBfcntl\fR(2) function can be used to set these flags.
36 36 .sp
37 37 .LP
38 38 The \fBpipe2()\fR call will clear the \fBO_NDELAY\fR on both filedescriptors.
39 39 The \fIflags\fR argument may be used to specify attributes on both file
40 40 descriptors. \fBpipe2()\fR called with a \fIflags\fR value of 0 will
41 41 behave identically to \fBpipe()\fR. Values for \fIflags\fR are constructed
42 42 by a bitwise-inclusive-OR of flags from the following list, defined in
43 43 <\fBfcntl.h\fR>.
44 -.RE
45 44
46 45 .sp
47 46 .ne 2
48 47 .na
49 48 \fB\fBO_NONBLOCK\fR\fR
50 49 .ad
51 50 .RS 12n
52 51 Both file descriptors will be placed in non-blocking mode. This corresponds
53 52 to the \fBO_NONBLOCK\fR flag to \fBfcntl\fR(2).
54 53 .RE
55 54
56 55 .sp
57 56 .ne 2
58 57 .na
59 58 \fB\fBO_CLOEXEC\fR\fR
60 59 .ad
61 60 .RS 12n
62 61 Both file descriptors will be opened with the FD_CLOEXEC flag set. Both file
63 62 descriptors will be closed prior to any future exec() calls.
64 63 .RE
65 64
66 65 .sp
67 66 .LP
68 67 A read from \fIfildes\fR[\fB0\fR] accesses the data written to
69 68 \fIfildes\fR[\fB1\fR] on a first-in-first-out (FIFO) basis and a read from
70 69 \fIfildes\fR[\fB1\fR] accesses the data written to \fIfildes\fR[\fB0\fR] also
71 70 on a \fBFIFO\fR basis.
72 71 .sp
73 72 .LP
74 73 Upon successful completion \fBpipe()\fR marks for update the \fBst_atime\fR,
75 74 \fBst_ctime\fR, and \fBst_mtime\fR fields of the pipe.
76 75 .SH RETURN VALUES
77 76 .sp
78 77 .LP
79 78 Upon successful completion, \fB0\fR is returned. Otherwise, \fB\(mi1\fR is
80 79 returned and \fBerrno\fR is set to indicate the error.
81 80 .SH ERRORS
82 81 .sp
83 82 .LP
84 83 The \fBpipe()\fR and \fBpipe2()\fR functions will fail if:
85 84 .sp
86 85 .ne 2
87 86 .na
88 87 \fB\fBEMFILE\fR\fR
89 88 .ad
90 89 .RS 10n
91 90 More than {\fBOPEN_MAX\fR} file descriptors are already in use by this process.
92 91 .RE
93 92
94 93 .sp
95 94 .ne 2
96 95 .na
97 96 \fB\fBENFILE\fR\fR
98 97 .ad
99 98 .RS 10n
100 99 The number of simultaneously open files in the system would exceed a
101 100 system-imposed limit.
102 101 .RE
103 102
104 103 .sp
105 104 .ne 2
106 105 .na
107 106 \fB\fBEFAULT\fR\fR
108 107 .ad
109 108 .RS 10n
110 109 The \fIfildes[2]\fR argument points to an illegal address.
111 110 .RE
112 111
113 112 .sp
114 113 .LP
115 114 The \fBpipe2()\fR function will also fail if:
116 115 .sp
117 116 .ne 2
118 117 .na
119 118 \fB\fBEINVAL\fR\fR
120 119 .ad
121 120 .RS 10n
122 121 The \fIflags\fR argument is illegal. Valid \fIflags\fR are zero or a
123 122 bitwise inclusive-OR of \fBO_CLOEXEC\fR and \fBO_NONBLOCK\fR.
124 123 .RE
125 124
126 125
127 126 .SH ATTRIBUTES
128 127 .sp
129 128 .LP
130 129 See \fBattributes\fR(5) for descriptions of the following attributes:
131 130 .sp
132 131
133 132 .sp
134 133 .TS
135 134 box;
136 135 c | c
137 136 l | l .
138 137 ATTRIBUTE TYPE ATTRIBUTE VALUE
139 138 _
140 139 Interface Stability Standard
141 140 _
142 141 MT-Level Async-Signal-Safe
143 142 .TE
144 143
145 144 .SH SEE ALSO
146 145 .sp
147 146 .LP
148 147 \fBsh\fR(1), \fBfcntl\fR(2), \fBfstat\fR(2), \fBgetmsg\fR(2), \fBpoll\fR(2),
149 148 \fBputmsg\fR(2), \fBread\fR(2), \fBwrite\fR(2), \fBopen\fR(2),
150 149 \fBattributes\fR(5), \fBstandards\fR(5), \fBstreamio\fR(7I)
151 150 .SH NOTES
152 151 .sp
153 152 .LP
154 153 Since a pipe is bi-directional, there are two separate flows of data.
155 154 Therefore, the size (\fBst_size\fR) returned by a call to \fBfstat\fR(2) with
156 155 argument \fIfildes\fR[\fB0\fR] or \fIfildes\fR[\fB1\fR] is the number of bytes
157 156 available for reading from \fIfildes\fR[\fB0\fR] or \fIfildes\fR[\fB1\fR]
158 157 respectively. Previously, the size (\fBst_size\fR) returned by a call to
159 158 \fBfstat()\fR with argument \fIfildes\fR[\fB1\fR] (the write-end) was the
160 159 number of bytes available for reading from \fIfildes\fR[\fB0\fR] (the
161 160 read-end).
|
↓ open down ↓ |
107 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX