2 * Copyright (c) 2008, 2009 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/types.h>
26 #include "fatal-signal.h"
27 #include "leak-checker.h"
28 #include "poll-loop.h"
29 #include "socket-util.h"
31 #include "stream-provider.h"
35 #define THIS_MODULE VLM_stream_fd
37 /* Active file descriptor stream. */
46 static 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 * When '*streamp' is closed, then 'unlink_path' (if nonnull) will be passed to
57 * fatal_signal_unlink_file_now() and then freed with free().
59 * Returns 0 if successful, otherwise a positive errno value. (The current
60 * implementation never fails.) */
62 new_fd_stream(const char *name, int fd, int connect_status,
63 char *unlink_path, struct stream **streamp)
67 s = xmalloc(sizeof *s);
68 stream_init(&s->stream, &stream_fd_class, connect_status, name);
70 s->unlink_path = unlink_path;
71 *streamp = &s->stream;
75 static struct stream_fd *
76 stream_fd_cast(struct stream *stream)
78 stream_assert_class(stream, &stream_fd_class);
79 return CONTAINER_OF(stream, struct stream_fd, stream);
83 fd_close(struct stream *stream)
85 struct stream_fd *s = stream_fd_cast(stream);
87 maybe_unlink_and_free(s->unlink_path);
92 fd_connect(struct stream *stream)
94 struct stream_fd *s = stream_fd_cast(stream);
95 return check_connection_completion(s->fd);
99 fd_recv(struct stream *stream, void *buffer, size_t n)
101 struct stream_fd *s = stream_fd_cast(stream);
102 ssize_t retval = read(s->fd, buffer, n);
103 return retval >= 0 ? retval : -errno;
107 fd_send(struct stream *stream, const void *buffer, size_t n)
109 struct stream_fd *s = stream_fd_cast(stream);
110 ssize_t retval = write(s->fd, buffer, n);
111 return (retval > 0 ? retval
112 : retval == 0 ? -EAGAIN
117 fd_wait(struct stream *stream, enum stream_wait_type wait)
119 struct stream_fd *s = stream_fd_cast(stream);
123 poll_fd_wait(s->fd, POLLOUT);
127 poll_fd_wait(s->fd, POLLIN);
135 static struct stream_class stream_fd_class = {
138 fd_close, /* close */
139 fd_connect, /* connect */
147 /* Passive file descriptor stream. */
151 struct pstream pstream;
153 int (*accept_cb)(int fd, const struct sockaddr *, size_t sa_len,
158 static struct pstream_class fd_pstream_class;
160 static struct fd_pstream *
161 fd_pstream_cast(struct pstream *pstream)
163 pstream_assert_class(pstream, &fd_pstream_class);
164 return CONTAINER_OF(pstream, struct fd_pstream, pstream);
167 /* Creates a new pstream named 'name' that will accept new socket connections
168 * on 'fd' and stores a pointer to the stream in '*pstreamp'.
170 * When a connection has been accepted, 'accept_cb' will be called with the new
171 * socket fd 'fd' and the remote address of the connection 'sa' and 'sa_len'.
172 * accept_cb must return 0 if the connection is successful, in which case it
173 * must initialize '*streamp' to the new stream, or a positive errno value on
174 * error. In either case accept_cb takes ownership of the 'fd' passed in.
176 * When '*pstreamp' is closed, then 'unlink_path' (if nonnull) will be passed
177 * to fatal_signal_unlink_file_now() and freed with free().
179 * Returns 0 if successful, otherwise a positive errno value. (The current
180 * implementation never fails.) */
182 new_fd_pstream(const char *name, int fd,
183 int (*accept_cb)(int fd, const struct sockaddr *sa,
184 size_t sa_len, struct stream **streamp),
185 char *unlink_path, struct pstream **pstreamp)
187 struct fd_pstream *ps = xmalloc(sizeof *ps);
188 pstream_init(&ps->pstream, &fd_pstream_class, name);
190 ps->accept_cb = accept_cb;
191 ps->unlink_path = unlink_path;
192 *pstreamp = &ps->pstream;
197 pfd_close(struct pstream *pstream)
199 struct fd_pstream *ps = fd_pstream_cast(pstream);
201 maybe_unlink_and_free(ps->unlink_path);
206 pfd_accept(struct pstream *pstream, struct stream **new_streamp)
208 struct fd_pstream *ps = fd_pstream_cast(pstream);
209 struct sockaddr_storage ss;
210 socklen_t ss_len = sizeof ss;
214 new_fd = accept(ps->fd, (struct sockaddr *) &ss, &ss_len);
217 if (retval != EAGAIN) {
218 VLOG_DBG_RL(&rl, "accept: %s", strerror(retval));
223 retval = set_nonblocking(new_fd);
229 return ps->accept_cb(new_fd, (const struct sockaddr *) &ss, ss_len,
234 pfd_wait(struct pstream *pstream)
236 struct fd_pstream *ps = fd_pstream_cast(pstream);
237 poll_fd_wait(ps->fd, POLLIN);
240 static struct pstream_class fd_pstream_class = {
248 /* Helper functions. */
250 maybe_unlink_and_free(char *path)
253 fatal_signal_unlink_file_now(path);