lib/vconn-tcp.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 "vconn.h"
  35 #include <assert.h>
  36 #include <errno.h>
  37 #include <inttypes.h>
  38 #include <netdb.h>
  39 #include <poll.h>
  40 #include <sys/types.h>
  41 #include <netinet/in.h>
  42 #include <netinet/tcp.h>
  43 #include <stdlib.h>
  44 #include <string.h>
  45 #include <unistd.h>
  46 #include "buffer.h"
  47 #include "socket-util.h"
  48 #include "util.h"
  49 #include "openflow.h"
  50 #include "ofp-print.h"
  51 #include "packets.h"
  52 #include "poll-loop.h"
  53
  54 #include "vlog.h"
  55 #define THIS_MODULE VLM_vconn_tcp
  56
  57 /* Active TCP. */
  58
  59 struct tcp_vconn
  60 {
  61     struct vconn vconn;
  62     int fd;
  63     struct buffer *rxbuf;
  64     struct buffer *txbuf;
  65     struct poll_waiter *tx_waiter;
  66 };
  67
  68 static int
  69 new_tcp_vconn(const char *name, int fd, int connect_status,
  70               const struct sockaddr_in *sin, struct vconn **vconnp)
  71 {
  72     struct tcp_vconn *tcp;
  73     int on = 1;
  74     int retval;
  75
  76     retval = setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, &on, sizeof on);
  77     if (retval) {
  78         VLOG_ERR("%s: setsockopt(TCP_NODELAY): %s", name, strerror(errno));
  79         close(fd);
  80         return errno;
  81     }
  82
  83     tcp = xmalloc(sizeof *tcp);
  84     tcp->vconn.class = &tcp_vconn_class;
  85     tcp->vconn.connect_status = connect_status;
  86     tcp->vconn.ip = sin->sin_addr.s_addr;
  87     tcp->fd = fd;
  88     tcp->txbuf = NULL;
  89     tcp->tx_waiter = NULL;
  90     tcp->rxbuf = NULL;
  91     *vconnp = &tcp->vconn;
  92     return 0;
  93 }
  94
  95 static struct tcp_vconn *
  96 tcp_vconn_cast(struct vconn *vconn)
  97 {
  98     assert(vconn->class == &tcp_vconn_class);
  99     return CONTAINER_OF(vconn, struct tcp_vconn, vconn);
 100 }
 101
 102
 103 static int
 104 tcp_open(const char *name, char *suffix, struct vconn **vconnp)
 105 {
 106     char *save_ptr;
 107     const char *host_name;
 108     const char *port_string;
 109     struct sockaddr_in sin;
 110     int retval;
 111     int fd;
 112
 113     /* Glibc 2.7 has a bug in strtok_r when compiling with optimization that
 114      * can cause segfaults here:
 115      * http://sources.redhat.com/bugzilla/show_bug.cgi?id=5614.
 116      * Using "::" instead of the obvious ":" works around it. */
 117     host_name = strtok_r(suffix, "::", &save_ptr);
 118     port_string = strtok_r(NULL, "::", &save_ptr);
 119     if (!host_name) {
 120         fatal(0, "%s: bad peer name format", name);
 121     }
 122
 123     memset(&sin, 0, sizeof sin);
 124     sin.sin_family = AF_INET;
 125     if (lookup_ip(host_name, &sin.sin_addr)) {
 126         return ENOENT;
 127     }
 128     sin.sin_port = htons(port_string ? atoi(port_string) : OFP_TCP_PORT);
 129
 130     fd = socket(AF_INET, SOCK_STREAM, 0);
 131     if (fd < 0) {
 132         VLOG_ERR("%s: socket: %s", name, strerror(errno));
 133         return errno;
 134     }
 135
 136     retval = set_nonblocking(fd);
 137     if (retval) {
 138         close(fd);
 139         return retval;
 140     }
 141
 142     retval = connect(fd, (struct sockaddr *) &sin, sizeof sin);
 143     if (retval < 0) {
 144         if (errno == EINPROGRESS) {
 145             return new_tcp_vconn(name, fd, EAGAIN, &sin, vconnp);
 146         } else {
 147             int error = errno;
 148             VLOG_ERR("%s: connect: %s", name, strerror(error));
 149             close(fd);
 150             return error;
 151         }
 152     } else {
 153         return new_tcp_vconn(name, fd, 0, &sin, vconnp);
 154     }
 155 }
 156
 157 static void
 158 tcp_close(struct vconn *vconn)
 159 {
 160     struct tcp_vconn *tcp = tcp_vconn_cast(vconn);
 161     poll_cancel(tcp->tx_waiter);
 162     close(tcp->fd);
 163     free(tcp);
 164 }
 165
 166 static int
 167 tcp_connect(struct vconn *vconn)
 168 {
 169     struct tcp_vconn *tcp = tcp_vconn_cast(vconn);
 170     return check_connection_completion(tcp->fd);
 171 }
 172
 173 static int
 174 tcp_recv(struct vconn *vconn, struct buffer **bufferp)
 175 {
 176     struct tcp_vconn *tcp = tcp_vconn_cast(vconn);
 177     struct buffer *rx;
 178     size_t want_bytes;
 179     ssize_t retval;
 180
 181     if (tcp->rxbuf == NULL) {
 182         tcp->rxbuf = buffer_new(1564);
 183     }
 184     rx = tcp->rxbuf;
 185
 186 again:
 187     if (sizeof(struct ofp_header) > rx->size) {
 188         want_bytes = sizeof(struct ofp_header) - rx->size;
 189     } else {
 190         struct ofp_header *oh = rx->data;
 191         size_t length = ntohs(oh->length);
 192         if (length < sizeof(struct ofp_header)) {
 193             VLOG_ERR("received too-short ofp_header (%zu bytes)", length);
 194             return EPROTO;
 195         }
 196         want_bytes = length - rx->size;
 197         if (!want_bytes) {
 198             *bufferp = rx;
 199             tcp->rxbuf = NULL;
 200             return 0;
 201         }
 202     }
 203     buffer_reserve_tailroom(rx, want_bytes);
 204
 205     retval = read(tcp->fd, buffer_tail(rx), want_bytes);
 206     if (retval > 0) {
 207         rx->size += retval;
 208         if (retval == want_bytes) {
 209             if (rx->size > sizeof(struct ofp_header)) {
 210                 *bufferp = rx;
 211                 tcp->rxbuf = NULL;
 212                 return 0;
 213             } else {
 214                 goto again;
 215             }
 216         }
 217         return EAGAIN;
 218     } else if (retval == 0) {
 219         if (rx->size) {
 220             VLOG_ERR("connection dropped mid-packet");
 221             return EPROTO;
 222         } else {
 223             return EOF;
 224         }
 225     } else {
 226         return retval ? errno : EAGAIN;
 227     }
 228 }
 229
 230 static void
 231 tcp_clear_txbuf(struct tcp_vconn *tcp)
 232 {
 233     buffer_delete(tcp->txbuf);
 234     tcp->txbuf = NULL;
 235     tcp->tx_waiter = NULL;
 236 }
 237
 238 static void
 239 tcp_do_tx(int fd UNUSED, short int revents UNUSED, void *vconn_)
 240 {
 241     struct vconn *vconn = vconn_;
 242     struct tcp_vconn *tcp = tcp_vconn_cast(vconn);
 243     ssize_t n = write(tcp->fd, tcp->txbuf->data, tcp->txbuf->size);
 244     if (n < 0) {
 245         if (errno != EAGAIN) {
 246             VLOG_ERR("send: %s", strerror(errno));
 247             tcp_clear_txbuf(tcp);
 248             return;
 249         }
 250     } else if (n > 0) {
 251         buffer_pull(tcp->txbuf, n);
 252         if (!tcp->txbuf->size) {
 253             tcp_clear_txbuf(tcp);
 254             return;
 255         }
 256     }
 257     tcp->tx_waiter = poll_fd_callback(tcp->fd, POLLOUT, tcp_do_tx, vconn);
 258 }
 259
 260 static int
 261 tcp_send(struct vconn *vconn, struct buffer *buffer)
 262 {
 263     struct tcp_vconn *tcp = tcp_vconn_cast(vconn);
 264     ssize_t retval;
 265
 266     if (tcp->txbuf) {
 267         return EAGAIN;
 268     }
 269
 270     retval = write(tcp->fd, buffer->data, buffer->size);
 271     if (retval == buffer->size) {
 272         buffer_delete(buffer);
 273         return 0;
 274     } else if (retval >= 0 || errno == EAGAIN) {
 275         tcp->txbuf = buffer;
 276         if (retval > 0) {
 277             buffer_pull(buffer, retval);
 278         }
 279         tcp->tx_waiter = poll_fd_callback(tcp->fd, POLLOUT, tcp_do_tx, vconn);
 280         return 0;
 281     } else {
 282         return errno;
 283     }
 284 }
 285
 286 static void
 287 tcp_wait(struct vconn *vconn, enum vconn_wait_type wait)
 288 {
 289     struct tcp_vconn *tcp = tcp_vconn_cast(vconn);
 290     switch (wait) {
 291     case WAIT_CONNECT:
 292         poll_fd_wait(tcp->fd, POLLOUT);
 293         break;
 294
 295     case WAIT_SEND:
 296         if (!tcp->txbuf) {
 297             poll_fd_wait(tcp->fd, POLLOUT);
 298         } else {
 299             /* Nothing to do: need to drain txbuf first. */
 300         }
 301         break;
 302
 303     case WAIT_RECV:
 304         poll_fd_wait(tcp->fd, POLLIN);
 305         break;
 306
 307     default:
 308         NOT_REACHED();
 309     }
 310 }
 311
 312 struct vconn_class tcp_vconn_class = {
 313     .name = "tcp",
 314     .open = tcp_open,
 315     .close = tcp_close,
 316     .connect = tcp_connect,
 317     .recv = tcp_recv,
 318     .send = tcp_send,
 319     .wait = tcp_wait,
 320 };
 321 \f
 322 /* Passive TCP. */
 323
 324 struct ptcp_vconn
 325 {
 326     struct vconn vconn;
 327     int fd;
 328 };
 329
 330 static struct ptcp_vconn *
 331 ptcp_vconn_cast(struct vconn *vconn)
 332 {
 333     assert(vconn->class == &ptcp_vconn_class);
 334     return CONTAINER_OF(vconn, struct ptcp_vconn, vconn);
 335 }
 336
 337 static int
 338 ptcp_open(const char *name, char *suffix, struct vconn **vconnp)
 339 {
 340     struct sockaddr_in sin;
 341     struct ptcp_vconn *ptcp;
 342     int retval;
 343     int fd;
 344     unsigned int yes  = 1;
 345
 346     fd = socket(AF_INET, SOCK_STREAM, 0);
 347     if (fd < 0) {
 348         VLOG_ERR("%s: socket: %s", name, strerror(errno));
 349         return errno;
 350     }
 351
 352     if ( setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,&yes,sizeof(yes)) < 0) {
 353         VLOG_ERR("%s: setsockopt::SO_REUSEADDR: %s", name, strerror(errno));
 354         return errno;
 355     }
 356
 357
 358     memset(&sin, 0, sizeof sin);
 359     sin.sin_family = AF_INET;
 360     sin.sin_addr.s_addr = htonl(INADDR_ANY);
 361     sin.sin_port = htons(atoi(suffix) ? atoi(suffix) : OFP_TCP_PORT);
 362     retval = bind(fd, (struct sockaddr *) &sin, sizeof sin);
 363     if (retval < 0) {
 364         int error = errno;
 365         VLOG_ERR("%s: bind: %s", name, strerror(error));
 366         close(fd);
 367         return error;
 368     }
 369
 370     retval = listen(fd, 10);
 371     if (retval < 0) {
 372         int error = errno;
 373         VLOG_ERR("%s: listen: %s", name, strerror(error));
 374         close(fd);
 375         return error;
 376     }
 377
 378     retval = set_nonblocking(fd);
 379     if (retval) {
 380         close(fd);
 381         return retval;
 382     }
 383
 384     ptcp = xmalloc(sizeof *ptcp);
 385     ptcp->vconn.class = &ptcp_vconn_class;
 386     ptcp->vconn.connect_status = 0;
 387     ptcp->fd = fd;
 388     *vconnp = &ptcp->vconn;
 389     return 0;
 390 }
 391
 392 static void
 393 ptcp_close(struct vconn *vconn)
 394 {
 395     struct ptcp_vconn *ptcp = ptcp_vconn_cast(vconn);
 396     close(ptcp->fd);
 397     free(ptcp);
 398 }
 399
 400 static int
 401 ptcp_accept(struct vconn *vconn, struct vconn **new_vconnp)
 402 {
 403     struct ptcp_vconn *ptcp = ptcp_vconn_cast(vconn);
 404     struct sockaddr_in sin;
 405     socklen_t sin_len = sizeof sin;
 406     char name[128];
 407     int new_fd;
 408     int error;
 409
 410     new_fd = accept(ptcp->fd, &sin, &sin_len);
 411     if (new_fd < 0) {
 412         int error = errno;
 413         if (error != EAGAIN) {
 414             VLOG_DBG("accept: %s", strerror(error));
 415         }
 416         return error;
 417     }
 418
 419     error = set_nonblocking(new_fd);
 420     if (error) {
 421         close(new_fd);
 422         return error;
 423     }
 424
 425     sprintf(name, "tcp:"IP_FMT, IP_ARGS(&sin.sin_addr));
 426     if (sin.sin_port != htons(OFP_TCP_PORT)) {
 427         sprintf(strchr(name, '\0'), ":%"PRIu16, ntohs(sin.sin_port));
 428     }
 429     return new_tcp_vconn(name, new_fd, 0, &sin, new_vconnp);
 430 }
 431
 432 static void
 433 ptcp_wait(struct vconn *vconn, enum vconn_wait_type wait)
 434 {
 435     struct ptcp_vconn *ptcp = ptcp_vconn_cast(vconn);
 436     assert(wait == WAIT_ACCEPT);
 437     poll_fd_wait(ptcp->fd, POLLIN);
 438 }
 439
 440 struct vconn_class ptcp_vconn_class = {
 441     .name = "ptcp",
 442     .open = ptcp_open,
 443     .close = ptcp_close,
 444     .accept = ptcp_accept,
 445     .wait = ptcp_wait
 446 };
 447