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 #define THIS_MODULE VLM_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 if (error
&& error
!= EAGAIN
) {
93 *vconnp
= vconn_stream_new(stream
, error
);
97 static struct vconn_stream
*
98 vconn_stream_cast(struct vconn
*vconn
)
100 return CONTAINER_OF(vconn
, struct vconn_stream
, vconn
);
104 vconn_stream_close(struct vconn
*vconn
)
106 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
108 if ((vconn
->error
== EPROTO
|| s
->n_packets
< 1) && s
->rxbuf
) {
109 stream_report_content(s
->rxbuf
->data
, s
->rxbuf
->size
, STREAM_OPENFLOW
,
110 THIS_MODULE
, vconn_get_name(vconn
));
113 stream_close(s
->stream
);
114 vconn_stream_clear_txbuf(s
);
115 ofpbuf_delete(s
->rxbuf
);
120 vconn_stream_connect(struct vconn
*vconn
)
122 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
123 return stream_connect(s
->stream
);
127 vconn_stream_recv__(struct vconn_stream
*s
, int rx_len
)
129 struct ofpbuf
*rx
= s
->rxbuf
;
130 int want_bytes
, retval
;
132 want_bytes
= rx_len
- rx
->size
;
133 ofpbuf_prealloc_tailroom(rx
, want_bytes
);
134 retval
= stream_recv(s
->stream
, ofpbuf_tail(rx
), want_bytes
);
137 return retval
== want_bytes
? 0 : EAGAIN
;
138 } else if (retval
== 0) {
140 VLOG_ERR_RL(&rl
, "connection dropped mid-packet");
150 vconn_stream_recv(struct vconn
*vconn
, struct ofpbuf
**bufferp
)
152 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
153 const struct ofp_header
*oh
;
156 /* Allocate new receive buffer if we don't have one. */
157 if (s
->rxbuf
== NULL
) {
158 s
->rxbuf
= ofpbuf_new(1564);
161 /* Read ofp_header. */
162 if (s
->rxbuf
->size
< sizeof(struct ofp_header
)) {
163 int retval
= vconn_stream_recv__(s
, sizeof(struct ofp_header
));
171 rx_len
= ntohs(oh
->length
);
172 if (rx_len
< sizeof(struct ofp_header
)) {
173 VLOG_ERR_RL(&rl
, "received too-short ofp_header (%zu bytes)",
176 } else if (s
->rxbuf
->size
< rx_len
) {
177 int retval
= vconn_stream_recv__(s
, rx_len
);
190 vconn_stream_clear_txbuf(struct vconn_stream
*s
)
192 ofpbuf_delete(s
->txbuf
);
197 vconn_stream_send(struct vconn
*vconn
, struct ofpbuf
*buffer
)
199 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
206 retval
= stream_send(s
->stream
, buffer
->data
, buffer
->size
);
207 if (retval
== buffer
->size
) {
208 ofpbuf_delete(buffer
);
210 } else if (retval
>= 0 || retval
== -EAGAIN
) {
211 leak_checker_claim(buffer
);
214 ofpbuf_pull(buffer
, retval
);
223 vconn_stream_run(struct vconn
*vconn
)
225 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
232 retval
= stream_send(s
->stream
, s
->txbuf
->data
, s
->txbuf
->size
);
234 if (retval
!= -EAGAIN
) {
235 VLOG_ERR_RL(&rl
, "send: %s", strerror(-retval
));
236 vconn_stream_clear_txbuf(s
);
239 } else if (retval
> 0) {
240 ofpbuf_pull(s
->txbuf
, retval
);
241 if (!s
->txbuf
->size
) {
242 vconn_stream_clear_txbuf(s
);
249 vconn_stream_run_wait(struct vconn
*vconn
)
251 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
254 stream_send_wait(s
->stream
);
259 vconn_stream_wait(struct vconn
*vconn
, enum vconn_wait_type wait
)
261 struct vconn_stream
*s
= vconn_stream_cast(vconn
);
264 stream_connect_wait(s
->stream
);
269 stream_send_wait(s
->stream
);
271 /* Nothing to do: need to drain txbuf first.
272 * vconn_stream_run_wait() will arrange to wake up when there room
273 * to send data, so there's no point in calling poll_fd_wait()
274 * redundantly here. */
279 stream_recv_wait(s
->stream
);
287 /* Passive stream socket vconn. */
289 struct pvconn_pstream
291 struct pvconn pvconn
;
292 struct pstream
*pstream
;
295 static struct pvconn_class pstream_pvconn_class
;
297 static struct pvconn_pstream
*
298 pvconn_pstream_cast(struct pvconn
*pvconn
)
300 return CONTAINER_OF(pvconn
, struct pvconn_pstream
, pvconn
);
303 /* Creates a new pvconn named 'name' that will accept new connections using
304 * pstream_accept() and stores a pointer to the pvconn in '*pvconnp'.
306 * Returns 0 if successful, otherwise a positive errno value. (The current
307 * implementation never fails.) */
309 pvconn_pstream_listen(const char *name
, char *suffix OVS_UNUSED
,
310 struct pvconn
**pvconnp
)
312 struct pvconn_pstream
*ps
;
313 struct pstream
*pstream
;
316 error
= pstream_open_with_default_ports(name
, OFP_TCP_PORT
, OFP_SSL_PORT
,
322 ps
= xmalloc(sizeof *ps
);
323 pvconn_init(&ps
->pvconn
, &pstream_pvconn_class
, name
);
324 ps
->pstream
= pstream
;
325 *pvconnp
= &ps
->pvconn
;
330 pvconn_pstream_close(struct pvconn
*pvconn
)
332 struct pvconn_pstream
*ps
= pvconn_pstream_cast(pvconn
);
333 pstream_close(ps
->pstream
);
338 pvconn_pstream_accept(struct pvconn
*pvconn
, struct vconn
**new_vconnp
)
340 struct pvconn_pstream
*ps
= pvconn_pstream_cast(pvconn
);
341 struct stream
*stream
;
344 error
= pstream_accept(ps
->pstream
, &stream
);
346 if (error
!= EAGAIN
) {
347 VLOG_DBG_RL(&rl
, "%s: accept: %s",
348 pstream_get_name(ps
->pstream
), strerror(error
));
353 *new_vconnp
= vconn_stream_new(stream
, 0);
358 pvconn_pstream_wait(struct pvconn
*pvconn
)
360 struct pvconn_pstream
*ps
= pvconn_pstream_cast(pvconn
);
361 pstream_wait(ps
->pstream
);
364 /* Stream-based vconns and pvconns. */
366 #define DEFINE_VCONN_STREAM_CLASS(NAME) \
367 struct vconn_class NAME##_vconn_class = { \
370 vconn_stream_close, \
371 vconn_stream_connect, \
375 vconn_stream_run_wait, \
379 #define DEFINE_PVCONN_STREAM_CLASS(NAME) \
380 struct pvconn_class NAME##_pvconn_class = { \
382 pvconn_pstream_listen, \
383 pvconn_pstream_close, \
384 pvconn_pstream_accept, \
385 pvconn_pstream_wait \
388 static DEFINE_VCONN_STREAM_CLASS(stream
);
389 static DEFINE_PVCONN_STREAM_CLASS(pstream
);
391 DEFINE_VCONN_STREAM_CLASS(tcp
);
392 DEFINE_PVCONN_STREAM_CLASS(ptcp
);
394 DEFINE_VCONN_STREAM_CLASS(unix
);
395 DEFINE_PVCONN_STREAM_CLASS(punix
);
398 DEFINE_VCONN_STREAM_CLASS(ssl
);
399 DEFINE_PVCONN_STREAM_CLASS(pssl
);