lib/vconn-stream.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "vconn-stream.h"
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <poll.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <sys/types.h>
  42 #include <unistd.h>
  43 #include "ofpbuf.h"
  44 #include "openflow.h"
  45 #include "poll-loop.h"
  46 #include "socket-util.h"
  47 #include "util.h"
  48 #include "vconn-provider.h"
  49 #include "vconn.h"
  50
  51 #include "vlog.h"
  52 #define THIS_MODULE VLM_vconn_stream
  53
  54 /* Active stream socket vconn. */
  55
  56 struct stream_vconn
  57 {
  58     struct vconn vconn;
  59     int fd;
  60     struct ofpbuf *rxbuf;
  61     struct ofpbuf *txbuf;
  62     struct poll_waiter *tx_waiter;
  63 };
  64
  65 static struct vconn_class stream_vconn_class;
  66
  67 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
  68
  69 int
  70 new_stream_vconn(const char *name, int fd, int connect_status,
  71                  uint32_t ip, struct vconn **vconnp)
  72 {
  73     struct stream_vconn *s;
  74
  75     s = xmalloc(sizeof *s);
  76     vconn_init(&s->vconn, &stream_vconn_class, connect_status, ip, name);
  77     s->fd = fd;
  78     s->txbuf = NULL;
  79     s->tx_waiter = NULL;
  80     s->rxbuf = NULL;
  81     *vconnp = &s->vconn;
  82     return 0;
  83 }
  84
  85 static struct stream_vconn *
  86 stream_vconn_cast(struct vconn *vconn)
  87 {
  88     assert(vconn->class == &stream_vconn_class);
  89     return CONTAINER_OF(vconn, struct stream_vconn, vconn);
  90 }
  91
  92 static void
  93 stream_close(struct vconn *vconn)
  94 {
  95     struct stream_vconn *s = stream_vconn_cast(vconn);
  96     poll_cancel(s->tx_waiter);
  97     close(s->fd);
  98     free(s);
  99 }
 100
 101 static int
 102 stream_connect(struct vconn *vconn)
 103 {
 104     struct stream_vconn *s = stream_vconn_cast(vconn);
 105     return check_connection_completion(s->fd);
 106 }
 107
 108 static int
 109 stream_recv(struct vconn *vconn, struct ofpbuf **bufferp)
 110 {
 111     struct stream_vconn *s = stream_vconn_cast(vconn);
 112     struct ofpbuf *rx;
 113     size_t want_bytes;
 114     ssize_t retval;
 115
 116     if (s->rxbuf == NULL) {
 117         s->rxbuf = ofpbuf_new(1564);
 118     }
 119     rx = s->rxbuf;
 120
 121 again:
 122     if (sizeof(struct ofp_header) > rx->size) {
 123         want_bytes = sizeof(struct ofp_header) - rx->size;
 124     } else {
 125         struct ofp_header *oh = rx->data;
 126         size_t length = ntohs(oh->length);
 127         if (length < sizeof(struct ofp_header)) {
 128             VLOG_ERR_RL(&rl, "received too-short ofp_header (%zu bytes)",
 129                         length);
 130             return EPROTO;
 131         }
 132         want_bytes = length - rx->size;
 133         if (!want_bytes) {
 134             *bufferp = rx;
 135             s->rxbuf = NULL;
 136             return 0;
 137         }
 138     }
 139     ofpbuf_prealloc_tailroom(rx, want_bytes);
 140
 141     retval = read(s->fd, ofpbuf_tail(rx), want_bytes);
 142     if (retval > 0) {
 143         rx->size += retval;
 144         if (retval == want_bytes) {
 145             if (rx->size > sizeof(struct ofp_header)) {
 146                 *bufferp = rx;
 147                 s->rxbuf = NULL;
 148                 return 0;
 149             } else {
 150                 goto again;
 151             }
 152         }
 153         return EAGAIN;
 154     } else if (retval == 0) {
 155         if (rx->size) {
 156             VLOG_ERR_RL(&rl, "connection dropped mid-packet");
 157             return EPROTO;
 158         } else {
 159             return EOF;
 160         }
 161     } else {
 162         return retval ? errno : EAGAIN;
 163     }
 164 }
 165
 166 static void
 167 stream_clear_txbuf(struct stream_vconn *s)
 168 {
 169     ofpbuf_delete(s->txbuf);
 170     s->txbuf = NULL;
 171     s->tx_waiter = NULL;
 172 }
 173
 174 static void
 175 stream_do_tx(int fd UNUSED, short int revents UNUSED, void *vconn_)
 176 {
 177     struct vconn *vconn = vconn_;
 178     struct stream_vconn *s = stream_vconn_cast(vconn);
 179     ssize_t n = write(s->fd, s->txbuf->data, s->txbuf->size);
 180     if (n < 0) {
 181         if (errno != EAGAIN) {
 182             VLOG_ERR_RL(&rl, "send: %s", strerror(errno));
 183             stream_clear_txbuf(s);
 184             return;
 185         }
 186     } else if (n > 0) {
 187         ofpbuf_pull(s->txbuf, n);
 188         if (!s->txbuf->size) {
 189             stream_clear_txbuf(s);
 190             return;
 191         }
 192     }
 193     s->tx_waiter = poll_fd_callback(s->fd, POLLOUT, stream_do_tx, vconn);
 194 }
 195
 196 static int
 197 stream_send(struct vconn *vconn, struct ofpbuf *buffer)
 198 {
 199     struct stream_vconn *s = stream_vconn_cast(vconn);
 200     ssize_t retval;
 201
 202     if (s->txbuf) {
 203         return EAGAIN;
 204     }
 205
 206     retval = write(s->fd, buffer->data, buffer->size);
 207     if (retval == buffer->size) {
 208         ofpbuf_delete(buffer);
 209         return 0;
 210     } else if (retval >= 0 || errno == EAGAIN) {
 211         s->txbuf = buffer;
 212         if (retval > 0) {
 213             ofpbuf_pull(buffer, retval);
 214         }
 215         s->tx_waiter = poll_fd_callback(s->fd, POLLOUT, stream_do_tx, vconn);
 216         return 0;
 217     } else {
 218         return errno;
 219     }
 220 }
 221
 222 static void
 223 stream_wait(struct vconn *vconn, enum vconn_wait_type wait)
 224 {
 225     struct stream_vconn *s = stream_vconn_cast(vconn);
 226     switch (wait) {
 227     case WAIT_CONNECT:
 228         poll_fd_wait(s->fd, POLLOUT);
 229         break;
 230
 231     case WAIT_SEND:
 232         if (!s->txbuf) {
 233             poll_fd_wait(s->fd, POLLOUT);
 234         } else {
 235             /* Nothing to do: need to drain txbuf first. */
 236         }
 237         break;
 238
 239     case WAIT_RECV:
 240         poll_fd_wait(s->fd, POLLIN);
 241         break;
 242
 243     default:
 244         NOT_REACHED();
 245     }
 246 }
 247
 248 static struct vconn_class stream_vconn_class = {
 249     "stream",                   /* name */
 250     NULL,                       /* open */
 251     stream_close,               /* close */
 252     stream_connect,             /* connect */
 253     NULL,                       /* accept */
 254     stream_recv,                /* recv */
 255     stream_send,                /* send */
 256     stream_wait,                /* wait */
 257 };
 258 \f
 259 /* Passive stream socket vconn. */
 260
 261 struct pstream_vconn
 262 {
 263     struct vconn vconn;
 264     int fd;
 265     int (*accept_cb)(int fd, const struct sockaddr *, size_t sa_len,
 266                      struct vconn **);
 267 };
 268
 269 static struct vconn_class pstream_vconn_class;
 270
 271 static struct pstream_vconn *
 272 pstream_vconn_cast(struct vconn *vconn)
 273 {
 274     assert(vconn->class == &pstream_vconn_class);
 275     return CONTAINER_OF(vconn, struct pstream_vconn, vconn);
 276 }
 277
 278 int
 279 new_pstream_vconn(const char *name, int fd,
 280                   int (*accept_cb)(int fd, const struct sockaddr *,
 281                                    size_t sa_len, struct vconn **),
 282                   struct vconn **vconnp)
 283 {
 284     struct pstream_vconn *ps;
 285     int retval;
 286
 287     retval = set_nonblocking(fd);
 288     if (retval) {
 289         close(fd);
 290         return retval;
 291     }
 292
 293     if (listen(fd, 10) < 0) {
 294         int error = errno;
 295         VLOG_ERR("%s: listen: %s", name, strerror(error));
 296         close(fd);
 297         return error;
 298     }
 299
 300     ps = xmalloc(sizeof *ps);
 301     ps->vconn.class = &pstream_vconn_class;
 302     ps->vconn.connect_status = 0;
 303     ps->fd = fd;
 304     ps->accept_cb = accept_cb;
 305     *vconnp = &ps->vconn;
 306     return 0;
 307 }
 308
 309 static void
 310 pstream_close(struct vconn *vconn)
 311 {
 312     struct pstream_vconn *ps = pstream_vconn_cast(vconn);
 313     close(ps->fd);
 314     free(ps);
 315 }
 316
 317 static int
 318 pstream_accept(struct vconn *vconn, struct vconn **new_vconnp)
 319 {
 320     struct pstream_vconn *ps = pstream_vconn_cast(vconn);
 321     struct sockaddr_storage ss;
 322     socklen_t ss_len = sizeof ss;
 323     int new_fd;
 324     int retval;
 325
 326     new_fd = accept(ps->fd, (struct sockaddr *) &ss, &ss_len);
 327     if (new_fd < 0) {
 328         int retval = errno;
 329         if (retval != EAGAIN) {
 330             VLOG_DBG_RL(&rl, "accept: %s", strerror(retval));
 331         }
 332         return retval;
 333     }
 334
 335     retval = set_nonblocking(new_fd);
 336     if (retval) {
 337         close(new_fd);
 338         return retval;
 339     }
 340
 341     return ps->accept_cb(new_fd, (const struct sockaddr *) &ss, ss_len,
 342                          new_vconnp);
 343 }
 344
 345 static void
 346 pstream_wait(struct vconn *vconn, enum vconn_wait_type wait)
 347 {
 348     struct pstream_vconn *ps = pstream_vconn_cast(vconn);
 349     assert(wait == WAIT_ACCEPT);
 350     poll_fd_wait(ps->fd, POLLIN);
 351 }
 352
 353 static struct vconn_class pstream_vconn_class = {
 354     "pstream",                  /* name */
 355     NULL,                       /* open */
 356     pstream_close,              /* close */
 357     NULL,                       /* connect */
 358     pstream_accept,             /* accept */
 359     NULL,                       /* recv */
 360     NULL,                       /* send */
 361     pstream_wait                /* wait */
 362 };