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.
23 #include <sys/types.h>
25 #include "fatal-signal.h"
26 #include "leak-checker.h"
28 #include "openflow/openflow.h"
29 #include "poll-loop.h"
30 #include "socket-util.h"
33 #include "vconn-provider.h"
37 VLOG_DEFINE_THIS_MODULE(vconn_stream)
39 /* Active stream socket vconn. */
44 struct stream *stream;
50 static struct vconn_class stream_vconn_class;
52 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
54 static void vconn_stream_clear_txbuf(struct vconn_stream *);
57 vconn_stream_new(struct stream *stream, int connect_status)
59 struct vconn_stream *s;
61 s = xmalloc(sizeof *s);
62 vconn_init(&s->vconn, &stream_vconn_class, connect_status,
63 stream_get_name(stream));
68 s->vconn.remote_ip = stream_get_remote_ip(stream);
69 s->vconn.remote_port = stream_get_remote_port(stream);
70 s->vconn.local_ip = stream_get_local_ip(stream);
71 s->vconn.local_port = stream_get_local_port(stream);
75 /* Creates a new vconn that will send and receive data on a stream named 'name'
76 * and stores a pointer to the vconn in '*vconnp'.
78 * Returns 0 if successful, otherwise a positive errno value. */
80 vconn_stream_open(const char *name, char *suffix OVS_UNUSED,
81 struct vconn **vconnp)
83 struct stream *stream;
86 error = stream_open_with_default_ports(name, OFP_TCP_PORT, OFP_SSL_PORT,
89 error = stream_connect(stream);
90 if (!error || error == EAGAIN) {
91 *vconnp = vconn_stream_new(stream, error);
100 static struct vconn_stream *
101 vconn_stream_cast(struct vconn *vconn)
103 return CONTAINER_OF(vconn, struct vconn_stream, vconn);
107 vconn_stream_close(struct vconn *vconn)
109 struct vconn_stream *s = vconn_stream_cast(vconn);
111 if ((vconn->error == EPROTO || s->n_packets < 1) && s->rxbuf) {
112 stream_report_content(s->rxbuf->data, s->rxbuf->size, STREAM_OPENFLOW,
113 THIS_MODULE, vconn_get_name(vconn));
116 stream_close(s->stream);
117 vconn_stream_clear_txbuf(s);
118 ofpbuf_delete(s->rxbuf);
123 vconn_stream_connect(struct vconn *vconn)
125 struct vconn_stream *s = vconn_stream_cast(vconn);
126 return stream_connect(s->stream);
130 vconn_stream_recv__(struct vconn_stream *s, int rx_len)
132 struct ofpbuf *rx = s->rxbuf;
133 int want_bytes, retval;
135 want_bytes = rx_len - rx->size;
136 ofpbuf_prealloc_tailroom(rx, want_bytes);
137 retval = stream_recv(s->stream, ofpbuf_tail(rx), want_bytes);
140 return retval == want_bytes ? 0 : EAGAIN;
141 } else if (retval == 0) {
143 VLOG_ERR_RL(&rl, "connection dropped mid-packet");
153 vconn_stream_recv(struct vconn *vconn, struct ofpbuf **bufferp)
155 struct vconn_stream *s = vconn_stream_cast(vconn);
156 const struct ofp_header *oh;
159 /* Allocate new receive buffer if we don't have one. */
160 if (s->rxbuf == NULL) {
161 s->rxbuf = ofpbuf_new(1564);
164 /* Read ofp_header. */
165 if (s->rxbuf->size < sizeof(struct ofp_header)) {
166 int retval = vconn_stream_recv__(s, sizeof(struct ofp_header));
174 rx_len = ntohs(oh->length);
175 if (rx_len < sizeof(struct ofp_header)) {
176 VLOG_ERR_RL(&rl, "received too-short ofp_header (%zu bytes)",
179 } else if (s->rxbuf->size < rx_len) {
180 int retval = vconn_stream_recv__(s, rx_len);
193 vconn_stream_clear_txbuf(struct vconn_stream *s)
195 ofpbuf_delete(s->txbuf);
200 vconn_stream_send(struct vconn *vconn, struct ofpbuf *buffer)
202 struct vconn_stream *s = vconn_stream_cast(vconn);
209 retval = stream_send(s->stream, buffer->data, buffer->size);
210 if (retval == buffer->size) {
211 ofpbuf_delete(buffer);
213 } else if (retval >= 0 || retval == -EAGAIN) {
214 leak_checker_claim(buffer);
217 ofpbuf_pull(buffer, retval);
226 vconn_stream_run(struct vconn *vconn)
228 struct vconn_stream *s = vconn_stream_cast(vconn);
235 retval = stream_send(s->stream, s->txbuf->data, s->txbuf->size);
237 if (retval != -EAGAIN) {
238 VLOG_ERR_RL(&rl, "send: %s", strerror(-retval));
239 vconn_stream_clear_txbuf(s);
242 } else if (retval > 0) {
243 ofpbuf_pull(s->txbuf, retval);
244 if (!s->txbuf->size) {
245 vconn_stream_clear_txbuf(s);
252 vconn_stream_run_wait(struct vconn *vconn)
254 struct vconn_stream *s = vconn_stream_cast(vconn);
257 stream_send_wait(s->stream);
262 vconn_stream_wait(struct vconn *vconn, enum vconn_wait_type wait)
264 struct vconn_stream *s = vconn_stream_cast(vconn);
267 stream_connect_wait(s->stream);
272 stream_send_wait(s->stream);
274 /* Nothing to do: need to drain txbuf first.
275 * vconn_stream_run_wait() will arrange to wake up when there room
276 * to send data, so there's no point in calling poll_fd_wait()
277 * redundantly here. */
282 stream_recv_wait(s->stream);
290 /* Passive stream socket vconn. */
292 struct pvconn_pstream
294 struct pvconn pvconn;
295 struct pstream *pstream;
298 static struct pvconn_class pstream_pvconn_class;
300 static struct pvconn_pstream *
301 pvconn_pstream_cast(struct pvconn *pvconn)
303 return CONTAINER_OF(pvconn, struct pvconn_pstream, pvconn);
306 /* Creates a new pvconn named 'name' that will accept new connections using
307 * pstream_accept() and stores a pointer to the pvconn in '*pvconnp'.
309 * Returns 0 if successful, otherwise a positive errno value. (The current
310 * implementation never fails.) */
312 pvconn_pstream_listen(const char *name, char *suffix OVS_UNUSED,
313 struct pvconn **pvconnp)
315 struct pvconn_pstream *ps;
316 struct pstream *pstream;
319 error = pstream_open_with_default_ports(name, OFP_TCP_PORT, OFP_SSL_PORT,
325 ps = xmalloc(sizeof *ps);
326 pvconn_init(&ps->pvconn, &pstream_pvconn_class, name);
327 ps->pstream = pstream;
328 *pvconnp = &ps->pvconn;
333 pvconn_pstream_close(struct pvconn *pvconn)
335 struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
336 pstream_close(ps->pstream);
341 pvconn_pstream_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
343 struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
344 struct stream *stream;
347 error = pstream_accept(ps->pstream, &stream);
349 if (error != EAGAIN) {
350 VLOG_DBG_RL(&rl, "%s: accept: %s",
351 pstream_get_name(ps->pstream), strerror(error));
356 *new_vconnp = vconn_stream_new(stream, 0);
361 pvconn_pstream_wait(struct pvconn *pvconn)
363 struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
364 pstream_wait(ps->pstream);
367 /* Stream-based vconns and pvconns. */
369 #define DEFINE_VCONN_STREAM_CLASS(NAME) \
370 struct vconn_class NAME##_vconn_class = { \
373 vconn_stream_close, \
374 vconn_stream_connect, \
378 vconn_stream_run_wait, \
382 #define DEFINE_PVCONN_STREAM_CLASS(NAME) \
383 struct pvconn_class NAME##_pvconn_class = { \
385 pvconn_pstream_listen, \
386 pvconn_pstream_close, \
387 pvconn_pstream_accept, \
388 pvconn_pstream_wait \
391 static DEFINE_VCONN_STREAM_CLASS(stream);
392 static DEFINE_PVCONN_STREAM_CLASS(pstream);
394 DEFINE_VCONN_STREAM_CLASS(tcp);
395 DEFINE_PVCONN_STREAM_CLASS(ptcp);
397 DEFINE_VCONN_STREAM_CLASS(unix);
398 DEFINE_PVCONN_STREAM_CLASS(punix);
401 DEFINE_VCONN_STREAM_CLASS(ssl);
402 DEFINE_PVCONN_STREAM_CLASS(pssl);