lib/vconn-stream.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
   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, uint8_t dscp)
  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, dscp);
  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     stream_run(s->stream);
 231     if (!s->txbuf) {
 232         return;
 233     }
 234
 235     retval = stream_send(s->stream, s->txbuf->data, s->txbuf->size);
 236     if (retval < 0) {
 237         if (retval != -EAGAIN) {
 238             VLOG_ERR_RL(&rl, "send: %s", strerror(-retval));
 239             vconn_stream_clear_txbuf(s);
 240             return;
 241         }
 242     } else if (retval > 0) {
 243         ofpbuf_pull(s->txbuf, retval);
 244         if (!s->txbuf->size) {
 245             vconn_stream_clear_txbuf(s);
 246             return;
 247         }
 248     }
 249 }
 250
 251 static void
 252 vconn_stream_run_wait(struct vconn *vconn)
 253 {
 254     struct vconn_stream *s = vconn_stream_cast(vconn);
 255
 256     stream_run_wait(s->stream);
 257     if (s->txbuf) {
 258         stream_send_wait(s->stream);
 259     }
 260 }
 261
 262 static void
 263 vconn_stream_wait(struct vconn *vconn, enum vconn_wait_type wait)
 264 {
 265     struct vconn_stream *s = vconn_stream_cast(vconn);
 266     switch (wait) {
 267     case WAIT_CONNECT:
 268         stream_connect_wait(s->stream);
 269         break;
 270
 271     case WAIT_SEND:
 272         if (!s->txbuf) {
 273             stream_send_wait(s->stream);
 274         } else {
 275             /* Nothing to do: need to drain txbuf first.
 276              * vconn_stream_run_wait() will arrange to wake up when there room
 277              * to send data, so there's no point in calling poll_fd_wait()
 278              * redundantly here. */
 279         }
 280         break;
 281
 282     case WAIT_RECV:
 283         stream_recv_wait(s->stream);
 284         break;
 285
 286     default:
 287         NOT_REACHED();
 288     }
 289 }
 290 \f
 291 /* Passive stream socket vconn. */
 292
 293 struct pvconn_pstream
 294 {
 295     struct pvconn pvconn;
 296     struct pstream *pstream;
 297 };
 298
 299 static struct pvconn_class pstream_pvconn_class;
 300
 301 static struct pvconn_pstream *
 302 pvconn_pstream_cast(struct pvconn *pvconn)
 303 {
 304     return CONTAINER_OF(pvconn, struct pvconn_pstream, pvconn);
 305 }
 306
 307 /* Creates a new pvconn named 'name' that will accept new connections using
 308  * pstream_accept() and stores a pointer to the pvconn in '*pvconnp'.
 309  *
 310  * Returns 0 if successful, otherwise a positive errno value.  (The current
 311  * implementation never fails.) */
 312 static int
 313 pvconn_pstream_listen(const char *name, char *suffix OVS_UNUSED,
 314                       struct pvconn **pvconnp, uint8_t dscp)
 315 {
 316     struct pvconn_pstream *ps;
 317     struct pstream *pstream;
 318     int error;
 319
 320     error = pstream_open_with_default_ports(name, OFP_TCP_PORT, OFP_SSL_PORT,
 321                                             &pstream, dscp);
 322     if (error) {
 323         return error;
 324     }
 325
 326     ps = xmalloc(sizeof *ps);
 327     pvconn_init(&ps->pvconn, &pstream_pvconn_class, name);
 328     ps->pstream = pstream;
 329     *pvconnp = &ps->pvconn;
 330     return 0;
 331 }
 332
 333 static void
 334 pvconn_pstream_close(struct pvconn *pvconn)
 335 {
 336     struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
 337     pstream_close(ps->pstream);
 338     free(ps);
 339 }
 340
 341 static int
 342 pvconn_pstream_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
 343 {
 344     struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
 345     struct stream *stream;
 346     int error;
 347
 348     error = pstream_accept(ps->pstream, &stream);
 349     if (error) {
 350         if (error != EAGAIN) {
 351             VLOG_DBG_RL(&rl, "%s: accept: %s",
 352                         pstream_get_name(ps->pstream), strerror(error));
 353         }
 354         return error;
 355     }
 356
 357     *new_vconnp = vconn_stream_new(stream, 0);
 358     return 0;
 359 }
 360
 361 static void
 362 pvconn_pstream_wait(struct pvconn *pvconn)
 363 {
 364     struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
 365     pstream_wait(ps->pstream);
 366 }
 367 \f
 368 /* Stream-based vconns and pvconns. */
 369
 370 #define STREAM_INIT(NAME)                           \
 371     {                                               \
 372             NAME,                                   \
 373             vconn_stream_open,                      \
 374             vconn_stream_close,                     \
 375             vconn_stream_connect,                   \
 376             vconn_stream_recv,                      \
 377             vconn_stream_send,                      \
 378             vconn_stream_run,                       \
 379             vconn_stream_run_wait,                  \
 380             vconn_stream_wait,                      \
 381     }
 382
 383 #define PSTREAM_INIT(NAME)                          \
 384     {                                               \
 385             NAME,                                   \
 386             pvconn_pstream_listen,                  \
 387             pvconn_pstream_close,                   \
 388             pvconn_pstream_accept,                  \
 389             pvconn_pstream_wait                     \
 390     }
 391
 392 static struct vconn_class stream_vconn_class = STREAM_INIT("stream");
 393 static struct pvconn_class pstream_pvconn_class = PSTREAM_INIT("pstream");
 394
 395 struct vconn_class tcp_vconn_class = STREAM_INIT("tcp");
 396 struct pvconn_class ptcp_pvconn_class = PSTREAM_INIT("ptcp");
 397
 398 struct vconn_class unix_vconn_class = STREAM_INIT("unix");
 399 struct pvconn_class punix_pvconn_class = PSTREAM_INIT("punix");
 400
 401 #ifdef HAVE_OPENSSL
 402 struct vconn_class ssl_vconn_class = STREAM_INIT("ssl");
 403 struct pvconn_class pssl_pvconn_class = PSTREAM_INIT("pssl");
 404 #endif