2 * Copyright (c) 2008, 2009, 2010, 2012, 2013, 2014 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 "poll-loop.h"
28 #include "socket-util.h"
30 #include "stream-provider.h"
34 VLOG_DEFINE_THIS_MODULE(stream_fd);
36 /* Active file descriptor stream. */
45 static const struct stream_class stream_fd_class;
47 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
49 static void maybe_unlink_and_free(char *path);
51 /* Creates a new stream named 'name' that will send and receive data on 'fd'
52 * and stores a pointer to the stream in '*streamp'. Initial connection status
53 * 'connect_status' is interpreted as described for stream_init(). 'fd_type'
54 * tells whether the socket is TCP or Unix domain socket.
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, int fd_type,
60 struct stream **streamp)
64 s = xmalloc(sizeof *s);
65 stream_init(&s->stream, &stream_fd_class, connect_status, name);
68 *streamp = &s->stream;
72 static struct stream_fd *
73 stream_fd_cast(struct stream *stream)
75 stream_assert_class(stream, &stream_fd_class);
76 return CONTAINER_OF(stream, struct stream_fd, stream);
80 fd_close(struct stream *stream)
82 struct stream_fd *s = stream_fd_cast(stream);
88 fd_connect(struct stream *stream)
90 struct stream_fd *s = stream_fd_cast(stream);
91 int retval = check_connection_completion(s->fd);
92 if (retval == 0 && s->fd_type == AF_INET) {
93 setsockopt_tcp_nodelay(s->fd);
99 fd_recv(struct stream *stream, void *buffer, size_t n)
101 struct stream_fd *s = stream_fd_cast(stream);
105 retval = recv(s->fd, buffer, n, 0);
107 error = sock_errno();
109 if (error == WSAEWOULDBLOCK) {
113 if (error != EAGAIN) {
114 VLOG_DBG_RL(&rl, "recv: %s", sock_strerror(error));
122 fd_send(struct stream *stream, const void *buffer, size_t n)
124 struct stream_fd *s = stream_fd_cast(stream);
128 retval = send(s->fd, buffer, n, 0);
130 error = sock_errno();
132 if (error == WSAEWOULDBLOCK) {
136 if (error != EAGAIN) {
137 VLOG_DBG_RL(&rl, "recv: %s", sock_strerror(error));
141 return (retval > 0 ? retval : -EAGAIN);
145 fd_wait(struct stream *stream, enum stream_wait_type wait)
147 struct stream_fd *s = stream_fd_cast(stream);
151 poll_fd_wait(s->fd, POLLOUT);
155 poll_fd_wait(s->fd, POLLIN);
163 static const struct stream_class stream_fd_class = {
165 false, /* needs_probes */
167 fd_close, /* close */
168 fd_connect, /* connect */
176 /* Passive file descriptor stream. */
180 struct pstream pstream;
182 int (*accept_cb)(int fd, const struct sockaddr_storage *, size_t ss_len,
184 int (*set_dscp_cb)(int fd, uint8_t dscp);
188 static const struct pstream_class fd_pstream_class;
190 static struct fd_pstream *
191 fd_pstream_cast(struct pstream *pstream)
193 pstream_assert_class(pstream, &fd_pstream_class);
194 return CONTAINER_OF(pstream, struct fd_pstream, pstream);
197 /* Creates a new pstream named 'name' that will accept new socket connections
198 * on 'fd' and stores a pointer to the stream in '*pstreamp'.
200 * When a connection has been accepted, 'accept_cb' will be called with the new
201 * socket fd 'fd' and the remote address of the connection 'sa' and 'sa_len'.
202 * accept_cb must return 0 if the connection is successful, in which case it
203 * must initialize '*streamp' to the new stream, or a positive errno value on
204 * error. In either case accept_cb takes ownership of the 'fd' passed in.
206 * When '*pstreamp' is closed, then 'unlink_path' (if nonnull) will be passed
207 * to fatal_signal_unlink_file_now() and freed with free().
209 * Returns 0 if successful, otherwise a positive errno value. (The current
210 * implementation never fails.) */
212 new_fd_pstream(const char *name, int fd,
213 int (*accept_cb)(int fd, const struct sockaddr_storage *ss,
214 size_t ss_len, struct stream **streamp),
215 int (*set_dscp_cb)(int fd, uint8_t dscp),
216 char *unlink_path, struct pstream **pstreamp)
218 struct fd_pstream *ps = xmalloc(sizeof *ps);
219 pstream_init(&ps->pstream, &fd_pstream_class, name);
221 ps->accept_cb = accept_cb;
222 ps->set_dscp_cb = set_dscp_cb;
223 ps->unlink_path = unlink_path;
224 *pstreamp = &ps->pstream;
229 pfd_close(struct pstream *pstream)
231 struct fd_pstream *ps = fd_pstream_cast(pstream);
233 maybe_unlink_and_free(ps->unlink_path);
238 pfd_accept(struct pstream *pstream, struct stream **new_streamp)
240 struct fd_pstream *ps = fd_pstream_cast(pstream);
241 struct sockaddr_storage ss;
242 socklen_t ss_len = sizeof ss;
246 new_fd = accept(ps->fd, (struct sockaddr *) &ss, &ss_len);
248 retval = sock_errno();
250 if (retval == WSAEWOULDBLOCK) {
254 if (retval != EAGAIN) {
255 VLOG_DBG_RL(&rl, "accept: %s", sock_strerror(retval));
260 retval = set_nonblocking(new_fd);
266 return ps->accept_cb(new_fd, &ss, ss_len, new_streamp);
270 pfd_wait(struct pstream *pstream)
272 struct fd_pstream *ps = fd_pstream_cast(pstream);
273 poll_fd_wait(ps->fd, POLLIN);
277 pfd_set_dscp(struct pstream *pstream, uint8_t dscp)
279 struct fd_pstream *ps = fd_pstream_cast(pstream);
280 if (ps->set_dscp_cb) {
281 return ps->set_dscp_cb(ps->fd, dscp);
286 static const struct pstream_class fd_pstream_class = {
296 /* Helper functions. */
298 maybe_unlink_and_free(char *path)
301 fatal_signal_unlink_file_now(path);