2 * Copyright (c) 2008, 2009, 2010, 2012, 2013 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"
31 #include "stream-provider.h"
35 VLOG_DEFINE_THIS_MODULE(stream_fd);
37 /* 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().
55 * Returns 0 if successful, otherwise a positive errno value. (The current
56 * implementation never fails.) */
58 new_fd_stream(const char *name, int fd, int connect_status,
59 struct stream **streamp)
63 s = xmalloc(sizeof *s);
64 stream_init(&s->stream, &stream_fd_class, connect_status, name);
66 *streamp = &s->stream;
70 static struct stream_fd *
71 stream_fd_cast(struct stream *stream)
73 stream_assert_class(stream, &stream_fd_class);
74 return CONTAINER_OF(stream, struct stream_fd, stream);
78 fd_close(struct stream *stream)
80 struct stream_fd *s = stream_fd_cast(stream);
86 fd_connect(struct stream *stream)
88 struct stream_fd *s = stream_fd_cast(stream);
89 return check_connection_completion(s->fd);
93 stream_flaky_recv, "simulate failure of fd stream recvs",
97 fd_recv(struct stream *stream, void *buffer, size_t n)
99 struct stream_fd *s = stream_fd_cast(stream);
102 if (STRESS(stream_flaky_recv)) {
106 retval = read(s->fd, buffer, n);
107 return retval >= 0 ? retval : -errno;
111 stream_flaky_send, "simulate failure of fd stream sends",
115 fd_send(struct stream *stream, const void *buffer, size_t n)
117 struct stream_fd *s = stream_fd_cast(stream);
120 if (STRESS(stream_flaky_send)) {
124 retval = write(s->fd, buffer, n);
125 return (retval > 0 ? retval
126 : retval == 0 ? -EAGAIN
131 fd_wait(struct stream *stream, enum stream_wait_type wait)
133 struct stream_fd *s = stream_fd_cast(stream);
137 poll_fd_wait(s->fd, POLLOUT);
141 poll_fd_wait(s->fd, POLLIN);
149 static const struct stream_class stream_fd_class = {
151 false, /* needs_probes */
153 fd_close, /* close */
154 fd_connect, /* connect */
162 /* Passive file descriptor stream. */
166 struct pstream pstream;
168 int (*accept_cb)(int fd, const struct sockaddr *, size_t sa_len,
170 int (*set_dscp_cb)(int fd, uint8_t dscp);
174 static const struct pstream_class fd_pstream_class;
176 static struct fd_pstream *
177 fd_pstream_cast(struct pstream *pstream)
179 pstream_assert_class(pstream, &fd_pstream_class);
180 return CONTAINER_OF(pstream, struct fd_pstream, pstream);
183 /* Creates a new pstream named 'name' that will accept new socket connections
184 * on 'fd' and stores a pointer to the stream in '*pstreamp'.
186 * When a connection has been accepted, 'accept_cb' will be called with the new
187 * socket fd 'fd' and the remote address of the connection 'sa' and 'sa_len'.
188 * accept_cb must return 0 if the connection is successful, in which case it
189 * must initialize '*streamp' to the new stream, or a positive errno value on
190 * error. In either case accept_cb takes ownership of the 'fd' passed in.
192 * When '*pstreamp' is closed, then 'unlink_path' (if nonnull) will be passed
193 * to fatal_signal_unlink_file_now() and freed with free().
195 * Returns 0 if successful, otherwise a positive errno value. (The current
196 * implementation never fails.) */
198 new_fd_pstream(const char *name, int fd,
199 int (*accept_cb)(int fd, const struct sockaddr *sa,
200 size_t sa_len, struct stream **streamp),
201 int (*set_dscp_cb)(int fd, uint8_t dscp),
202 char *unlink_path, struct pstream **pstreamp)
204 struct fd_pstream *ps = xmalloc(sizeof *ps);
205 pstream_init(&ps->pstream, &fd_pstream_class, name);
207 ps->accept_cb = accept_cb;
208 ps->set_dscp_cb = set_dscp_cb;
209 ps->unlink_path = unlink_path;
210 *pstreamp = &ps->pstream;
215 pfd_close(struct pstream *pstream)
217 struct fd_pstream *ps = fd_pstream_cast(pstream);
219 maybe_unlink_and_free(ps->unlink_path);
224 pfd_accept(struct pstream *pstream, struct stream **new_streamp)
226 struct fd_pstream *ps = fd_pstream_cast(pstream);
227 struct sockaddr_storage ss;
228 socklen_t ss_len = sizeof ss;
232 new_fd = accept(ps->fd, (struct sockaddr *) &ss, &ss_len);
235 if (retval != EAGAIN) {
236 VLOG_DBG_RL(&rl, "accept: %s", ovs_strerror(retval));
241 retval = set_nonblocking(new_fd);
247 return ps->accept_cb(new_fd, (const struct sockaddr *) &ss, ss_len,
252 pfd_wait(struct pstream *pstream)
254 struct fd_pstream *ps = fd_pstream_cast(pstream);
255 poll_fd_wait(ps->fd, POLLIN);
259 pfd_set_dscp(struct pstream *pstream, uint8_t dscp)
261 struct fd_pstream *ps = fd_pstream_cast(pstream);
262 if (ps->set_dscp_cb) {
263 return ps->set_dscp_cb(ps->fd, dscp);
268 static const struct pstream_class fd_pstream_class = {
278 /* Helper functions. */
280 maybe_unlink_and_free(char *path)
283 fatal_signal_unlink_file_now(path);