2 * Copyright (c) 2008, 2009, 2010, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 #include "stream-fd.h"
23 #include <sys/socket.h>
24 #include <sys/types.h>
26 #include "fatal-signal.h"
27 #include "leak-checker.h"
28 #include "poll-loop.h"
29 #include "socket-util.h"
32 #include "stream-provider.h"
36 VLOG_DEFINE_THIS_MODULE(stream_fd
);
38 /* Active file descriptor stream. */
46 static const struct stream_class stream_fd_class
;
48 static struct vlog_rate_limit rl
= VLOG_RATE_LIMIT_INIT(10, 25);
50 static void maybe_unlink_and_free(char *path
);
52 /* Creates a new stream named 'name' that will send and receive data on 'fd'
53 * and stores a pointer to the stream in '*streamp'. Initial connection status
54 * 'connect_status' is interpreted as described for stream_init().
56 * Returns 0 if successful, otherwise a positive errno value. (The current
57 * implementation never fails.) */
59 new_fd_stream(const char *name
, int fd
, int connect_status
,
60 struct stream
**streamp
)
64 s
= xmalloc(sizeof *s
);
65 stream_init(&s
->stream
, &stream_fd_class
, connect_status
, name
);
67 *streamp
= &s
->stream
;
71 static struct stream_fd
*
72 stream_fd_cast(struct stream
*stream
)
74 stream_assert_class(stream
, &stream_fd_class
);
75 return CONTAINER_OF(stream
, struct stream_fd
, stream
);
79 fd_close(struct stream
*stream
)
81 struct stream_fd
*s
= stream_fd_cast(stream
);
87 fd_connect(struct stream
*stream
)
89 struct stream_fd
*s
= stream_fd_cast(stream
);
90 return check_connection_completion(s
->fd
);
94 stream_flaky_recv
, "simulate failure of fd stream recvs",
98 fd_recv(struct stream
*stream
, void *buffer
, size_t n
)
100 struct stream_fd
*s
= stream_fd_cast(stream
);
103 if (STRESS(stream_flaky_recv
)) {
107 retval
= read(s
->fd
, buffer
, n
);
108 return retval
>= 0 ? retval
: -errno
;
112 stream_flaky_send
, "simulate failure of fd stream sends",
116 fd_send(struct stream
*stream
, const void *buffer
, size_t n
)
118 struct stream_fd
*s
= stream_fd_cast(stream
);
121 if (STRESS(stream_flaky_send
)) {
125 retval
= write(s
->fd
, buffer
, n
);
126 return (retval
> 0 ? retval
127 : retval
== 0 ? -EAGAIN
132 fd_wait(struct stream
*stream
, enum stream_wait_type wait
)
134 struct stream_fd
*s
= stream_fd_cast(stream
);
138 poll_fd_wait(s
->fd
, POLLOUT
);
142 poll_fd_wait(s
->fd
, POLLIN
);
150 static const struct stream_class stream_fd_class
= {
152 false, /* needs_probes */
154 fd_close
, /* close */
155 fd_connect
, /* connect */
163 /* Passive file descriptor stream. */
167 struct pstream pstream
;
169 int (*accept_cb
)(int fd
, const struct sockaddr
*, size_t sa_len
,
171 int (*set_dscp_cb
)(int fd
, uint8_t dscp
);
175 static struct pstream_class fd_pstream_class
;
177 static struct fd_pstream
*
178 fd_pstream_cast(struct pstream
*pstream
)
180 pstream_assert_class(pstream
, &fd_pstream_class
);
181 return CONTAINER_OF(pstream
, struct fd_pstream
, pstream
);
184 /* Creates a new pstream named 'name' that will accept new socket connections
185 * on 'fd' and stores a pointer to the stream in '*pstreamp'.
187 * When a connection has been accepted, 'accept_cb' will be called with the new
188 * socket fd 'fd' and the remote address of the connection 'sa' and 'sa_len'.
189 * accept_cb must return 0 if the connection is successful, in which case it
190 * must initialize '*streamp' to the new stream, or a positive errno value on
191 * error. In either case accept_cb takes ownership of the 'fd' passed in.
193 * When '*pstreamp' is closed, then 'unlink_path' (if nonnull) will be passed
194 * to fatal_signal_unlink_file_now() and freed with free().
196 * Returns 0 if successful, otherwise a positive errno value. (The current
197 * implementation never fails.) */
199 new_fd_pstream(const char *name
, int fd
,
200 int (*accept_cb
)(int fd
, const struct sockaddr
*sa
,
201 size_t sa_len
, struct stream
**streamp
),
202 int (*set_dscp_cb
)(int fd
, uint8_t dscp
),
203 char *unlink_path
, struct pstream
**pstreamp
)
205 struct fd_pstream
*ps
= xmalloc(sizeof *ps
);
206 pstream_init(&ps
->pstream
, &fd_pstream_class
, name
);
208 ps
->accept_cb
= accept_cb
;
209 ps
->set_dscp_cb
= set_dscp_cb
;
210 ps
->unlink_path
= unlink_path
;
211 *pstreamp
= &ps
->pstream
;
216 pfd_close(struct pstream
*pstream
)
218 struct fd_pstream
*ps
= fd_pstream_cast(pstream
);
220 maybe_unlink_and_free(ps
->unlink_path
);
225 pfd_accept(struct pstream
*pstream
, struct stream
**new_streamp
)
227 struct fd_pstream
*ps
= fd_pstream_cast(pstream
);
228 struct sockaddr_storage ss
;
229 socklen_t ss_len
= sizeof ss
;
233 new_fd
= accept(ps
->fd
, (struct sockaddr
*) &ss
, &ss_len
);
236 if (retval
!= EAGAIN
) {
237 VLOG_DBG_RL(&rl
, "accept: %s", strerror(retval
));
242 retval
= set_nonblocking(new_fd
);
248 return ps
->accept_cb(new_fd
, (const struct sockaddr
*) &ss
, ss_len
,
253 pfd_wait(struct pstream
*pstream
)
255 struct fd_pstream
*ps
= fd_pstream_cast(pstream
);
256 poll_fd_wait(ps
->fd
, POLLIN
);
260 pfd_set_dscp(struct pstream
*pstream
, uint8_t dscp
)
262 struct fd_pstream
*ps
= fd_pstream_cast(pstream
);
263 if (ps
->set_dscp_cb
) {
264 return ps
->set_dscp_cb(ps
->fd
, dscp
);
269 static struct pstream_class fd_pstream_class
= {
279 /* Helper functions. */
281 maybe_unlink_and_free(char *path
)
284 fatal_signal_unlink_file_now(path
);