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