list: Allow list_front(), list_back() to take 'const' arguments.
[sliver-openvswitch.git] / lib / vconn-stream.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include <assert.h>
19 #include <errno.h>
20 #include <poll.h>
21 #include <stdlib.h>
22 #include <string.h>
23 #include <sys/types.h>
24 #include <unistd.h>
25 #include "fatal-signal.h"
26 #include "leak-checker.h"
27 #include "ofpbuf.h"
28 #include "openflow/openflow.h"
29 #include "poll-loop.h"
30 #include "socket-util.h"
31 #include "stream.h"
32 #include "util.h"
33 #include "vconn-provider.h"
34 #include "vconn.h"
35 #include "vlog.h"
36
37 VLOG_DEFINE_THIS_MODULE(vconn_stream);
38
39 /* Active stream socket vconn. */
40
41 struct vconn_stream
42 {
43     struct vconn vconn;
44     struct stream *stream;
45     struct ofpbuf *rxbuf;
46     struct ofpbuf *txbuf;
47     int n_packets;
48 };
49
50 static struct vconn_class stream_vconn_class;
51
52 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
53
54 static void vconn_stream_clear_txbuf(struct vconn_stream *);
55
56 static struct vconn *
57 vconn_stream_new(struct stream *stream, int connect_status)
58 {
59     struct vconn_stream *s;
60
61     s = xmalloc(sizeof *s);
62     vconn_init(&s->vconn, &stream_vconn_class, connect_status,
63                stream_get_name(stream));
64     s->stream = stream;
65     s->txbuf = NULL;
66     s->rxbuf = NULL;
67     s->n_packets = 0;
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);
72     return &s->vconn;
73 }
74
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'.
77  *
78  * Returns 0 if successful, otherwise a positive errno value. */
79 static int
80 vconn_stream_open(const char *name, char *suffix OVS_UNUSED,
81                   struct vconn **vconnp)
82 {
83     struct stream *stream;
84     int error;
85
86     error = stream_open_with_default_ports(name, OFP_TCP_PORT, OFP_SSL_PORT,
87                                            &stream);
88     if (!error) {
89         error = stream_connect(stream);
90         if (!error || error == EAGAIN) {
91             *vconnp = vconn_stream_new(stream, error);
92             return 0;
93         }
94     }
95
96     stream_close(stream);
97     return error;
98 }
99
100 static struct vconn_stream *
101 vconn_stream_cast(struct vconn *vconn)
102 {
103     return CONTAINER_OF(vconn, struct vconn_stream, vconn);
104 }
105
106 static void
107 vconn_stream_close(struct vconn *vconn)
108 {
109     struct vconn_stream *s = vconn_stream_cast(vconn);
110
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));
114     }
115
116     stream_close(s->stream);
117     vconn_stream_clear_txbuf(s);
118     ofpbuf_delete(s->rxbuf);
119     free(s);
120 }
121
122 static int
123 vconn_stream_connect(struct vconn *vconn)
124 {
125     struct vconn_stream *s = vconn_stream_cast(vconn);
126     return stream_connect(s->stream);
127 }
128
129 static int
130 vconn_stream_recv__(struct vconn_stream *s, int rx_len)
131 {
132     struct ofpbuf *rx = s->rxbuf;
133     int want_bytes, retval;
134
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);
138     if (retval > 0) {
139         rx->size += retval;
140         return retval == want_bytes ? 0 : EAGAIN;
141     } else if (retval == 0) {
142         if (rx->size) {
143             VLOG_ERR_RL(&rl, "connection dropped mid-packet");
144             return EPROTO;
145         }
146         return EOF;
147     } else {
148         return -retval;
149     }
150 }
151
152 static int
153 vconn_stream_recv(struct vconn *vconn, struct ofpbuf **bufferp)
154 {
155     struct vconn_stream *s = vconn_stream_cast(vconn);
156     const struct ofp_header *oh;
157     int rx_len;
158
159     /* Allocate new receive buffer if we don't have one. */
160     if (s->rxbuf == NULL) {
161         s->rxbuf = ofpbuf_new(1564);
162     }
163
164     /* Read ofp_header. */
165     if (s->rxbuf->size < sizeof(struct ofp_header)) {
166         int retval = vconn_stream_recv__(s, sizeof(struct ofp_header));
167         if (retval) {
168             return retval;
169         }
170     }
171
172     /* Read payload. */
173     oh = s->rxbuf->data;
174     rx_len = ntohs(oh->length);
175     if (rx_len < sizeof(struct ofp_header)) {
176         VLOG_ERR_RL(&rl, "received too-short ofp_header (%d bytes)", rx_len);
177         return EPROTO;
178     } else if (s->rxbuf->size < rx_len) {
179         int retval = vconn_stream_recv__(s, rx_len);
180         if (retval) {
181             return retval;
182         }
183     }
184
185     s->n_packets++;
186     *bufferp = s->rxbuf;
187     s->rxbuf = NULL;
188     return 0;
189 }
190
191 static void
192 vconn_stream_clear_txbuf(struct vconn_stream *s)
193 {
194     ofpbuf_delete(s->txbuf);
195     s->txbuf = NULL;
196 }
197
198 static int
199 vconn_stream_send(struct vconn *vconn, struct ofpbuf *buffer)
200 {
201     struct vconn_stream *s = vconn_stream_cast(vconn);
202     ssize_t retval;
203
204     if (s->txbuf) {
205         return EAGAIN;
206     }
207
208     retval = stream_send(s->stream, buffer->data, buffer->size);
209     if (retval == buffer->size) {
210         ofpbuf_delete(buffer);
211         return 0;
212     } else if (retval >= 0 || retval == -EAGAIN) {
213         leak_checker_claim(buffer);
214         s->txbuf = buffer;
215         if (retval > 0) {
216             ofpbuf_pull(buffer, retval);
217         }
218         return 0;
219     } else {
220         return -retval;
221     }
222 }
223
224 static void
225 vconn_stream_run(struct vconn *vconn)
226 {
227     struct vconn_stream *s = vconn_stream_cast(vconn);
228     ssize_t retval;
229
230     if (!s->txbuf) {
231         return;
232     }
233
234     retval = stream_send(s->stream, s->txbuf->data, s->txbuf->size);
235     if (retval < 0) {
236         if (retval != -EAGAIN) {
237             VLOG_ERR_RL(&rl, "send: %s", strerror(-retval));
238             vconn_stream_clear_txbuf(s);
239             return;
240         }
241     } else if (retval > 0) {
242         ofpbuf_pull(s->txbuf, retval);
243         if (!s->txbuf->size) {
244             vconn_stream_clear_txbuf(s);
245             return;
246         }
247     }
248 }
249
250 static void
251 vconn_stream_run_wait(struct vconn *vconn)
252 {
253     struct vconn_stream *s = vconn_stream_cast(vconn);
254
255     if (s->txbuf) {
256         stream_send_wait(s->stream);
257     }
258 }
259
260 static void
261 vconn_stream_wait(struct vconn *vconn, enum vconn_wait_type wait)
262 {
263     struct vconn_stream *s = vconn_stream_cast(vconn);
264     switch (wait) {
265     case WAIT_CONNECT:
266         stream_connect_wait(s->stream);
267         break;
268
269     case WAIT_SEND:
270         if (!s->txbuf) {
271             stream_send_wait(s->stream);
272         } else {
273             /* Nothing to do: need to drain txbuf first.
274              * vconn_stream_run_wait() will arrange to wake up when there room
275              * to send data, so there's no point in calling poll_fd_wait()
276              * redundantly here. */
277         }
278         break;
279
280     case WAIT_RECV:
281         stream_recv_wait(s->stream);
282         break;
283
284     default:
285         NOT_REACHED();
286     }
287 }
288 \f
289 /* Passive stream socket vconn. */
290
291 struct pvconn_pstream
292 {
293     struct pvconn pvconn;
294     struct pstream *pstream;
295 };
296
297 static struct pvconn_class pstream_pvconn_class;
298
299 static struct pvconn_pstream *
300 pvconn_pstream_cast(struct pvconn *pvconn)
301 {
302     return CONTAINER_OF(pvconn, struct pvconn_pstream, pvconn);
303 }
304
305 /* Creates a new pvconn named 'name' that will accept new connections using
306  * pstream_accept() and stores a pointer to the pvconn in '*pvconnp'.
307  *
308  * Returns 0 if successful, otherwise a positive errno value.  (The current
309  * implementation never fails.) */
310 static int
311 pvconn_pstream_listen(const char *name, char *suffix OVS_UNUSED,
312                       struct pvconn **pvconnp)
313 {
314     struct pvconn_pstream *ps;
315     struct pstream *pstream;
316     int error;
317
318     error = pstream_open_with_default_ports(name, OFP_TCP_PORT, OFP_SSL_PORT,
319                                             &pstream);
320     if (error) {
321         return error;
322     }
323
324     ps = xmalloc(sizeof *ps);
325     pvconn_init(&ps->pvconn, &pstream_pvconn_class, name);
326     ps->pstream = pstream;
327     *pvconnp = &ps->pvconn;
328     return 0;
329 }
330
331 static void
332 pvconn_pstream_close(struct pvconn *pvconn)
333 {
334     struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
335     pstream_close(ps->pstream);
336     free(ps);
337 }
338
339 static int
340 pvconn_pstream_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
341 {
342     struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
343     struct stream *stream;
344     int error;
345
346     error = pstream_accept(ps->pstream, &stream);
347     if (error) {
348         if (error != EAGAIN) {
349             VLOG_DBG_RL(&rl, "%s: accept: %s",
350                         pstream_get_name(ps->pstream), strerror(error));
351         }
352         return error;
353     }
354
355     *new_vconnp = vconn_stream_new(stream, 0);
356     return 0;
357 }
358
359 static void
360 pvconn_pstream_wait(struct pvconn *pvconn)
361 {
362     struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
363     pstream_wait(ps->pstream);
364 }
365 \f
366 /* Stream-based vconns and pvconns. */
367
368 #define STREAM_INIT(NAME)                           \
369     {                                               \
370             NAME,                                   \
371             vconn_stream_open,                      \
372             vconn_stream_close,                     \
373             vconn_stream_connect,                   \
374             vconn_stream_recv,                      \
375             vconn_stream_send,                      \
376             vconn_stream_run,                       \
377             vconn_stream_run_wait,                  \
378             vconn_stream_wait,                      \
379     }
380
381 #define PSTREAM_INIT(NAME)                          \
382     {                                               \
383             NAME,                                   \
384             pvconn_pstream_listen,                  \
385             pvconn_pstream_close,                   \
386             pvconn_pstream_accept,                  \
387             pvconn_pstream_wait                     \
388     }
389
390 static struct vconn_class stream_vconn_class = STREAM_INIT("stream");
391 static struct pvconn_class pstream_pvconn_class = PSTREAM_INIT("pstream");
392
393 struct vconn_class tcp_vconn_class = STREAM_INIT("tcp");
394 struct pvconn_class ptcp_pvconn_class = PSTREAM_INIT("ptcp");
395
396 struct vconn_class unix_vconn_class = STREAM_INIT("unix");
397 struct pvconn_class punix_pvconn_class = PSTREAM_INIT("punix");
398
399 #ifdef HAVE_OPENSSL
400 struct vconn_class ssl_vconn_class = STREAM_INIT("ssl");
401 struct pvconn_class pssl_pvconn_class = PSTREAM_INIT("pssl");
402 #endif