2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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"
24 #include <sys/socket.h>
25 #include <sys/types.h>
27 #include "fatal-signal.h"
28 #include "leak-checker.h"
29 #include "poll-loop.h"
30 #include "socket-util.h"
32 #include "stream-provider.h"
36 VLOG_DEFINE_THIS_MODULE(stream_fd);
38 /* Active file descriptor stream. */
47 static struct stream_class stream_fd_class;
49 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
51 static void maybe_unlink_and_free(char *path);
53 /* Creates a new stream named 'name' that will send and receive data on 'fd'
54 * and stores a pointer to the stream in '*streamp'. Initial connection status
55 * 'connect_status' is interpreted as described for stream_init().
57 * When '*streamp' is closed, then 'unlink_path' (if nonnull) will be passed to
58 * fatal_signal_unlink_file_now() and then freed with free().
60 * Returns 0 if successful, otherwise a positive errno value. (The current
61 * implementation never fails.) */
63 new_fd_stream(const char *name, int fd, int connect_status,
64 char *unlink_path, struct stream **streamp)
68 s = xmalloc(sizeof *s);
69 stream_init(&s->stream, &stream_fd_class, connect_status, name);
71 s->unlink_path = unlink_path;
72 *streamp = &s->stream;
76 static struct stream_fd *
77 stream_fd_cast(struct stream *stream)
79 stream_assert_class(stream, &stream_fd_class);
80 return CONTAINER_OF(stream, struct stream_fd, stream);
84 fd_close(struct stream *stream)
86 struct stream_fd *s = stream_fd_cast(stream);
88 maybe_unlink_and_free(s->unlink_path);
93 fd_connect(struct stream *stream)
95 struct stream_fd *s = stream_fd_cast(stream);
96 return check_connection_completion(s->fd);
100 fd_recv(struct stream *stream, void *buffer, size_t n)
102 struct stream_fd *s = stream_fd_cast(stream);
103 ssize_t retval = read(s->fd, buffer, n);
104 return retval >= 0 ? retval : -errno;
108 fd_send(struct stream *stream, const void *buffer, size_t n)
110 struct stream_fd *s = stream_fd_cast(stream);
111 ssize_t retval = write(s->fd, buffer, n);
112 return (retval > 0 ? retval
113 : retval == 0 ? -EAGAIN
118 fd_wait(struct stream *stream, enum stream_wait_type wait)
120 struct stream_fd *s = stream_fd_cast(stream);
124 poll_fd_wait(s->fd, POLLOUT);
128 poll_fd_wait(s->fd, POLLIN);
136 static struct stream_class stream_fd_class = {
139 fd_close, /* close */
140 fd_connect, /* connect */
148 /* Passive file descriptor stream. */
152 struct pstream pstream;
154 int (*accept_cb)(int fd, const struct sockaddr *, size_t sa_len,
159 static struct pstream_class fd_pstream_class;
161 static struct fd_pstream *
162 fd_pstream_cast(struct pstream *pstream)
164 pstream_assert_class(pstream, &fd_pstream_class);
165 return CONTAINER_OF(pstream, struct fd_pstream, pstream);
168 /* Creates a new pstream named 'name' that will accept new socket connections
169 * on 'fd' and stores a pointer to the stream in '*pstreamp'.
171 * When a connection has been accepted, 'accept_cb' will be called with the new
172 * socket fd 'fd' and the remote address of the connection 'sa' and 'sa_len'.
173 * accept_cb must return 0 if the connection is successful, in which case it
174 * must initialize '*streamp' to the new stream, or a positive errno value on
175 * error. In either case accept_cb takes ownership of the 'fd' passed in.
177 * When '*pstreamp' is closed, then 'unlink_path' (if nonnull) will be passed
178 * to fatal_signal_unlink_file_now() and freed with free().
180 * Returns 0 if successful, otherwise a positive errno value. (The current
181 * implementation never fails.) */
183 new_fd_pstream(const char *name, int fd,
184 int (*accept_cb)(int fd, const struct sockaddr *sa,
185 size_t sa_len, struct stream **streamp),
186 char *unlink_path, struct pstream **pstreamp)
188 struct fd_pstream *ps = xmalloc(sizeof *ps);
189 pstream_init(&ps->pstream, &fd_pstream_class, name);
191 ps->accept_cb = accept_cb;
192 ps->unlink_path = unlink_path;
193 *pstreamp = &ps->pstream;
198 pfd_close(struct pstream *pstream)
200 struct fd_pstream *ps = fd_pstream_cast(pstream);
202 maybe_unlink_and_free(ps->unlink_path);
207 pfd_accept(struct pstream *pstream, struct stream **new_streamp)
209 struct fd_pstream *ps = fd_pstream_cast(pstream);
210 struct sockaddr_storage ss;
211 socklen_t ss_len = sizeof ss;
215 new_fd = accept(ps->fd, (struct sockaddr *) &ss, &ss_len);
218 if (retval != EAGAIN) {
219 VLOG_DBG_RL(&rl, "accept: %s", strerror(retval));
224 retval = set_nonblocking(new_fd);
230 return ps->accept_cb(new_fd, (const struct sockaddr *) &ss, ss_len,
235 pfd_wait(struct pstream *pstream)
237 struct fd_pstream *ps = fd_pstream_cast(pstream);
238 poll_fd_wait(ps->fd, POLLIN);
241 static struct pstream_class fd_pstream_class = {
249 /* Helper functions. */
251 maybe_unlink_and_free(char *path)
254 fatal_signal_unlink_file_now(path);