lib/vconn.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 "vconn-provider.h"
  19 #include <assert.h>
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <netinet/in.h>
  23 #include <poll.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include "coverage.h"
  27 #include "dynamic-string.h"
  28 #include "fatal-signal.h"
  29 #include "flow.h"
  30 #include "ofp-errors.h"
  31 #include "ofp-msgs.h"
  32 #include "ofp-print.h"
  33 #include "ofp-util.h"
  34 #include "ofpbuf.h"
  35 #include "openflow/nicira-ext.h"
  36 #include "openflow/openflow.h"
  37 #include "packets.h"
  38 #include "poll-loop.h"
  39 #include "random.h"
  40 #include "util.h"
  41 #include "vlog.h"
  42 #include "socket-util.h"
  43
  44 VLOG_DEFINE_THIS_MODULE(vconn);
  45
  46 COVERAGE_DEFINE(vconn_open);
  47 COVERAGE_DEFINE(vconn_received);
  48 COVERAGE_DEFINE(vconn_sent);
  49
  50 /* State of an active vconn.*/
  51 enum vconn_state {
  52     /* This is the ordinary progression of states. */
  53     VCS_CONNECTING,             /* Underlying vconn is not connected. */
  54     VCS_SEND_HELLO,             /* Waiting to send OFPT_HELLO message. */
  55     VCS_RECV_HELLO,             /* Waiting to receive OFPT_HELLO message. */
  56     VCS_CONNECTED,              /* Connection established. */
  57
  58     /* These states are entered only when something goes wrong. */
  59     VCS_SEND_ERROR,             /* Sending OFPT_ERROR message. */
  60     VCS_DISCONNECTED            /* Connection failed or connection closed. */
  61 };
  62
  63 static struct vconn_class *vconn_classes[] = {
  64     &tcp_vconn_class,
  65     &unix_vconn_class,
  66 #ifdef HAVE_OPENSSL
  67     &ssl_vconn_class,
  68 #endif
  69 };
  70
  71 static struct pvconn_class *pvconn_classes[] = {
  72     &ptcp_pvconn_class,
  73     &punix_pvconn_class,
  74 #ifdef HAVE_OPENSSL
  75     &pssl_pvconn_class,
  76 #endif
  77 };
  78
  79 /* Rate limit for individual OpenFlow messages going over the vconn, output at
  80  * DBG level.  This is very high because, if these are enabled, it is because
  81  * we really need to see them. */
  82 static struct vlog_rate_limit ofmsg_rl = VLOG_RATE_LIMIT_INIT(600, 600);
  83
  84 /* Rate limit for OpenFlow message parse errors.  These always indicate a bug
  85  * in the peer and so there's not much point in showing a lot of them. */
  86 static struct vlog_rate_limit bad_ofmsg_rl = VLOG_RATE_LIMIT_INIT(1, 5);
  87
  88 static int do_recv(struct vconn *, struct ofpbuf **);
  89 static int do_send(struct vconn *, struct ofpbuf *);
  90
  91 /* Check the validity of the vconn class structures. */
  92 static void
  93 check_vconn_classes(void)
  94 {
  95 #ifndef NDEBUG
  96     size_t i;
  97
  98     for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
  99         struct vconn_class *class = vconn_classes[i];
 100         assert(class->name != NULL);
 101         assert(class->open != NULL);
 102         if (class->close || class->recv || class->send
 103             || class->run || class->run_wait || class->wait) {
 104             assert(class->close != NULL);
 105             assert(class->recv != NULL);
 106             assert(class->send != NULL);
 107             assert(class->wait != NULL);
 108         } else {
 109             /* This class delegates to another one. */
 110         }
 111     }
 112
 113     for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
 114         struct pvconn_class *class = pvconn_classes[i];
 115         assert(class->name != NULL);
 116         assert(class->listen != NULL);
 117         if (class->close || class->accept || class->wait) {
 118             assert(class->close != NULL);
 119             assert(class->accept != NULL);
 120             assert(class->wait != NULL);
 121         } else {
 122             /* This class delegates to another one. */
 123         }
 124     }
 125 #endif
 126 }
 127
 128 /* Prints information on active (if 'active') and passive (if 'passive')
 129  * connection methods supported by the vconn.  If 'bootstrap' is true, also
 130  * advertises options to bootstrap the CA certificate. */
 131 void
 132 vconn_usage(bool active, bool passive, bool bootstrap OVS_UNUSED)
 133 {
 134     /* Really this should be implemented via callbacks into the vconn
 135      * providers, but that seems too heavy-weight to bother with at the
 136      * moment. */
 137
 138     printf("\n");
 139     if (active) {
 140         printf("Active OpenFlow connection methods:\n");
 141         printf("  tcp:IP[:PORT]         "
 142                "PORT (default: %d) at remote IP\n", OFP_TCP_PORT);
 143 #ifdef HAVE_OPENSSL
 144         printf("  ssl:IP[:PORT]         "
 145                "SSL PORT (default: %d) at remote IP\n", OFP_SSL_PORT);
 146 #endif
 147         printf("  unix:FILE               Unix domain socket named FILE\n");
 148     }
 149
 150     if (passive) {
 151         printf("Passive OpenFlow connection methods:\n");
 152         printf("  ptcp:[PORT][:IP]        "
 153                "listen to TCP PORT (default: %d) on IP\n",
 154                OFP_TCP_PORT);
 155 #ifdef HAVE_OPENSSL
 156         printf("  pssl:[PORT][:IP]        "
 157                "listen for SSL on PORT (default: %d) on IP\n",
 158                OFP_SSL_PORT);
 159 #endif
 160         printf("  punix:FILE              "
 161                "listen on Unix domain socket FILE\n");
 162     }
 163
 164 #ifdef HAVE_OPENSSL
 165     printf("PKI configuration (required to use SSL):\n"
 166            "  -p, --private-key=FILE  file with private key\n"
 167            "  -c, --certificate=FILE  file with certificate for private key\n"
 168            "  -C, --ca-cert=FILE      file with peer CA certificate\n");
 169     if (bootstrap) {
 170         printf("  --bootstrap-ca-cert=FILE  file with peer CA certificate "
 171                "to read or create\n");
 172     }
 173 #endif
 174 }
 175
 176 /* Given 'name', a connection name in the form "TYPE:ARGS", stores the class
 177  * named "TYPE" into '*classp' and returns 0.  Returns EAFNOSUPPORT and stores
 178  * a null pointer into '*classp' if 'name' is in the wrong form or if no such
 179  * class exists. */
 180 static int
 181 vconn_lookup_class(const char *name, struct vconn_class **classp)
 182 {
 183     size_t prefix_len;
 184
 185     prefix_len = strcspn(name, ":");
 186     if (name[prefix_len] != '\0') {
 187         size_t i;
 188
 189         for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
 190             struct vconn_class *class = vconn_classes[i];
 191             if (strlen(class->name) == prefix_len
 192                 && !memcmp(class->name, name, prefix_len)) {
 193                 *classp = class;
 194                 return 0;
 195             }
 196         }
 197     }
 198
 199     *classp = NULL;
 200     return EAFNOSUPPORT;
 201 }
 202
 203 /* Returns 0 if 'name' is a connection name in the form "TYPE:ARGS" and TYPE is
 204  * a supported connection type, otherwise EAFNOSUPPORT.  */
 205 int
 206 vconn_verify_name(const char *name)
 207 {
 208     struct vconn_class *class;
 209     return vconn_lookup_class(name, &class);
 210 }
 211
 212 /* Attempts to connect to an OpenFlow device.  'name' is a connection name in
 213  * the form "TYPE:ARGS", where TYPE is an active vconn class's name and ARGS
 214  * are vconn class-specific.
 215  *
 216  * The vconn will automatically negotiate an OpenFlow protocol version
 217  * acceptable to both peers on the connection.  The version negotiated will be
 218  * no lower than 'min_version' and no higher than OFP10_VERSION.
 219  *
 220  * Returns 0 if successful, otherwise a positive errno value.  If successful,
 221  * stores a pointer to the new connection in '*vconnp', otherwise a null
 222  * pointer.  */
 223 int
 224 vconn_open(const char *name, int min_version, struct vconn **vconnp,
 225            uint8_t dscp)
 226 {
 227     struct vconn_class *class;
 228     struct vconn *vconn;
 229     char *suffix_copy;
 230     int error;
 231
 232     COVERAGE_INC(vconn_open);
 233     check_vconn_classes();
 234
 235     /* Look up the class. */
 236     error = vconn_lookup_class(name, &class);
 237     if (!class) {
 238         goto error;
 239     }
 240
 241     /* Call class's "open" function. */
 242     suffix_copy = xstrdup(strchr(name, ':') + 1);
 243     error = class->open(name, suffix_copy, &vconn, dscp);
 244     free(suffix_copy);
 245     if (error) {
 246         goto error;
 247     }
 248
 249     /* Success. */
 250     assert(vconn->state != VCS_CONNECTING || vconn->class->connect);
 251     vconn->min_version = min_version;
 252     *vconnp = vconn;
 253     return 0;
 254
 255 error:
 256     *vconnp = NULL;
 257     return error;
 258 }
 259
 260 /* Allows 'vconn' to perform maintenance activities, such as flushing output
 261  * buffers. */
 262 void
 263 vconn_run(struct vconn *vconn)
 264 {
 265     if (vconn->class->run) {
 266         (vconn->class->run)(vconn);
 267     }
 268 }
 269
 270 /* Arranges for the poll loop to wake up when 'vconn' needs to perform
 271  * maintenance activities. */
 272 void
 273 vconn_run_wait(struct vconn *vconn)
 274 {
 275     if (vconn->class->run_wait) {
 276         (vconn->class->run_wait)(vconn);
 277     }
 278 }
 279
 280 int
 281 vconn_open_block(const char *name, enum ofp_version min_version,
 282                  struct vconn **vconnp)
 283 {
 284     struct vconn *vconn;
 285     int error;
 286
 287     fatal_signal_run();
 288
 289     error = vconn_open(name, min_version, &vconn, DSCP_DEFAULT);
 290     if (!error) {
 291         error = vconn_connect_block(vconn);
 292     }
 293
 294     if (error) {
 295         vconn_close(vconn);
 296         *vconnp = NULL;
 297     } else {
 298         *vconnp = vconn;
 299     }
 300     return error;
 301 }
 302
 303 /* Closes 'vconn'. */
 304 void
 305 vconn_close(struct vconn *vconn)
 306 {
 307     if (vconn != NULL) {
 308         char *name = vconn->name;
 309         (vconn->class->close)(vconn);
 310         free(name);
 311     }
 312 }
 313
 314 /* Returns the name of 'vconn', that is, the string passed to vconn_open(). */
 315 const char *
 316 vconn_get_name(const struct vconn *vconn)
 317 {
 318     return vconn->name;
 319 }
 320
 321 /* Returns the IP address of the peer, or 0 if the peer is not connected over
 322  * an IP-based protocol or if its IP address is not yet known. */
 323 ovs_be32
 324 vconn_get_remote_ip(const struct vconn *vconn)
 325 {
 326     return vconn->remote_ip;
 327 }
 328
 329 /* Returns the transport port of the peer, or 0 if the connection does not
 330  * contain a port or if the port is not yet known. */
 331 ovs_be16
 332 vconn_get_remote_port(const struct vconn *vconn)
 333 {
 334     return vconn->remote_port;
 335 }
 336
 337 /* Returns the IP address used to connect to the peer, or 0 if the
 338  * connection is not an IP-based protocol or if its IP address is not
 339  * yet known. */
 340 ovs_be32
 341 vconn_get_local_ip(const struct vconn *vconn)
 342 {
 343     return vconn->local_ip;
 344 }
 345
 346 /* Returns the transport port used to connect to the peer, or 0 if the
 347  * connection does not contain a port or if the port is not yet known. */
 348 ovs_be16
 349 vconn_get_local_port(const struct vconn *vconn)
 350 {
 351     return vconn->local_port;
 352 }
 353
 354 /* Returns the OpenFlow version negotiated with the peer, or -1 if version
 355  * negotiation is not yet complete.
 356  *
 357  * A vconn that has successfully connected (that is, vconn_connect() or
 358  * vconn_send() or vconn_recv() has returned 0) always negotiated a version. */
 359 enum ofp_version
 360 vconn_get_version(const struct vconn *vconn)
 361 {
 362     return vconn->version;
 363 }
 364
 365 static void
 366 vcs_connecting(struct vconn *vconn)
 367 {
 368     int retval = (vconn->class->connect)(vconn);
 369     assert(retval != EINPROGRESS);
 370     if (!retval) {
 371         vconn->state = VCS_SEND_HELLO;
 372     } else if (retval != EAGAIN) {
 373         vconn->state = VCS_DISCONNECTED;
 374         vconn->error = retval;
 375     }
 376 }
 377
 378 static void
 379 vcs_send_hello(struct vconn *vconn)
 380 {
 381     struct ofpbuf *b;
 382     int retval;
 383
 384     b = ofpraw_alloc(OFPRAW_OFPT_HELLO, OFP10_VERSION, 0);
 385     retval = do_send(vconn, b);
 386     if (!retval) {
 387         vconn->state = VCS_RECV_HELLO;
 388     } else {
 389         ofpbuf_delete(b);
 390         if (retval != EAGAIN) {
 391             vconn->state = VCS_DISCONNECTED;
 392             vconn->error = retval;
 393         }
 394     }
 395 }
 396
 397 static void
 398 vcs_recv_hello(struct vconn *vconn)
 399 {
 400     struct ofpbuf *b;
 401     int retval;
 402
 403     retval = do_recv(vconn, &b);
 404     if (!retval) {
 405         const struct ofp_header *oh = b->data;
 406         enum ofptype type;
 407         enum ofperr error;
 408
 409         error = ofptype_decode(&type, b->data);
 410         if (!error && type == OFPTYPE_HELLO) {
 411             if (b->size > sizeof *oh) {
 412                 struct ds msg = DS_EMPTY_INITIALIZER;
 413                 ds_put_format(&msg, "%s: extra-long hello:\n", vconn->name);
 414                 ds_put_hex_dump(&msg, b->data, b->size, 0, true);
 415                 VLOG_WARN_RL(&bad_ofmsg_rl, "%s", ds_cstr(&msg));
 416                 ds_destroy(&msg);
 417             }
 418
 419             vconn->version = MIN(OFP10_VERSION, oh->version);
 420             if (vconn->version < vconn->min_version) {
 421                 VLOG_WARN_RL(&bad_ofmsg_rl,
 422                              "%s: version negotiation failed: we support "
 423                              "versions 0x%02x to 0x%02x inclusive but peer "
 424                              "supports no later than version 0x%02"PRIx8,
 425                              vconn->name, vconn->min_version, OFP10_VERSION,
 426                              oh->version);
 427                 vconn->state = VCS_SEND_ERROR;
 428             } else {
 429                 VLOG_DBG("%s: negotiated OpenFlow version 0x%02x "
 430                          "(we support versions 0x%02x to 0x%02x inclusive, "
 431                          "peer no later than version 0x%02"PRIx8")",
 432                          vconn->name, vconn->version, vconn->min_version,
 433                          OFP10_VERSION, oh->version);
 434                 vconn->state = VCS_CONNECTED;
 435             }
 436             ofpbuf_delete(b);
 437             return;
 438         } else {
 439             char *s = ofp_to_string(b->data, b->size, 1);
 440             VLOG_WARN_RL(&bad_ofmsg_rl,
 441                          "%s: received message while expecting hello: %s",
 442                          vconn->name, s);
 443             free(s);
 444             retval = EPROTO;
 445             ofpbuf_delete(b);
 446         }
 447     }
 448
 449     if (retval != EAGAIN) {
 450         vconn->state = VCS_DISCONNECTED;
 451         vconn->error = retval == EOF ? ECONNRESET : retval;
 452     }
 453 }
 454
 455 static void
 456 vcs_send_error(struct vconn *vconn)
 457 {
 458     struct ofpbuf *b;
 459     char s[128];
 460     int retval;
 461
 462     snprintf(s, sizeof s, "We support versions 0x%02x to 0x%02x inclusive but "
 463              "you support no later than version 0x%02"PRIx8".",
 464              vconn->min_version, OFP10_VERSION, vconn->version);
 465     b = ofperr_encode_hello(OFPERR_OFPHFC_INCOMPATIBLE,
 466                             ofperr_domain_from_version(vconn->version), s);
 467     retval = do_send(vconn, b);
 468     if (retval) {
 469         ofpbuf_delete(b);
 470     }
 471     if (retval != EAGAIN) {
 472         vconn->state = VCS_DISCONNECTED;
 473         vconn->error = retval ? retval : EPROTO;
 474     }
 475 }
 476
 477 /* Tries to complete the connection on 'vconn'. If 'vconn''s connection is
 478  * complete, returns 0 if the connection was successful or a positive errno
 479  * value if it failed.  If the connection is still in progress, returns
 480  * EAGAIN. */
 481 int
 482 vconn_connect(struct vconn *vconn)
 483 {
 484     enum vconn_state last_state;
 485
 486     assert(vconn->min_version > 0);
 487     do {
 488         last_state = vconn->state;
 489         switch (vconn->state) {
 490         case VCS_CONNECTING:
 491             vcs_connecting(vconn);
 492             break;
 493
 494         case VCS_SEND_HELLO:
 495             vcs_send_hello(vconn);
 496             break;
 497
 498         case VCS_RECV_HELLO:
 499             vcs_recv_hello(vconn);
 500             break;
 501
 502         case VCS_CONNECTED:
 503             return 0;
 504
 505         case VCS_SEND_ERROR:
 506             vcs_send_error(vconn);
 507             break;
 508
 509         case VCS_DISCONNECTED:
 510             return vconn->error;
 511
 512         default:
 513             NOT_REACHED();
 514         }
 515     } while (vconn->state != last_state);
 516
 517     return EAGAIN;
 518 }
 519
 520 /* Tries to receive an OpenFlow message from 'vconn'.  If successful, stores
 521  * the received message into '*msgp' and returns 0.  The caller is responsible
 522  * for destroying the message with ofpbuf_delete().  On failure, returns a
 523  * positive errno value and stores a null pointer into '*msgp'.  On normal
 524  * connection close, returns EOF.
 525  *
 526  * vconn_recv will not block waiting for a packet to arrive.  If no packets
 527  * have been received, it returns EAGAIN immediately. */
 528 int
 529 vconn_recv(struct vconn *vconn, struct ofpbuf **msgp)
 530 {
 531     struct ofpbuf *msg;
 532     int retval;
 533
 534     retval = vconn_connect(vconn);
 535     if (!retval) {
 536         retval = do_recv(vconn, &msg);
 537     }
 538     if (!retval) {
 539         const struct ofp_header *oh = msg->data;
 540         if (oh->version != vconn->version) {
 541             enum ofptype type;
 542
 543             if (ofptype_decode(&type, msg->data)
 544                 || (type != OFPTYPE_HELLO &&
 545                     type != OFPTYPE_ERROR &&
 546                     type != OFPTYPE_ECHO_REQUEST &&
 547                     type != OFPTYPE_ECHO_REPLY)) {
 548                 VLOG_ERR_RL(&bad_ofmsg_rl, "%s: received OpenFlow version "
 549                             "0x%02"PRIx8" != expected %02x",
 550                             vconn->name, oh->version, vconn->version);
 551                 ofpbuf_delete(msg);
 552                 retval = EPROTO;
 553             }
 554         }
 555     }
 556
 557     *msgp = retval ? NULL : msg;
 558     return retval;
 559 }
 560
 561 static int
 562 do_recv(struct vconn *vconn, struct ofpbuf **msgp)
 563 {
 564     int retval = (vconn->class->recv)(vconn, msgp);
 565     if (!retval) {
 566         COVERAGE_INC(vconn_received);
 567         if (VLOG_IS_DBG_ENABLED()) {
 568             char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
 569             VLOG_DBG_RL(&ofmsg_rl, "%s: received: %s", vconn->name, s);
 570             free(s);
 571         }
 572     }
 573     return retval;
 574 }
 575
 576 /* Tries to queue 'msg' for transmission on 'vconn'.  If successful, returns 0,
 577  * in which case ownership of 'msg' is transferred to the vconn.  Success does
 578  * not guarantee that 'msg' has been or ever will be delivered to the peer,
 579  * only that it has been queued for transmission.
 580  *
 581  * Returns a positive errno value on failure, in which case the caller
 582  * retains ownership of 'msg'.
 583  *
 584  * vconn_send will not block.  If 'msg' cannot be immediately accepted for
 585  * transmission, it returns EAGAIN immediately. */
 586 int
 587 vconn_send(struct vconn *vconn, struct ofpbuf *msg)
 588 {
 589     int retval = vconn_connect(vconn);
 590     if (!retval) {
 591         retval = do_send(vconn, msg);
 592     }
 593     return retval;
 594 }
 595
 596 static int
 597 do_send(struct vconn *vconn, struct ofpbuf *msg)
 598 {
 599     int retval;
 600
 601     assert(msg->size >= sizeof(struct ofp_header));
 602
 603     ofpmsg_update_length(msg);
 604     if (!VLOG_IS_DBG_ENABLED()) {
 605         COVERAGE_INC(vconn_sent);
 606         retval = (vconn->class->send)(vconn, msg);
 607     } else {
 608         char *s = ofp_to_string(msg->data, msg->size, 1);
 609         retval = (vconn->class->send)(vconn, msg);
 610         if (retval != EAGAIN) {
 611             VLOG_DBG_RL(&ofmsg_rl, "%s: sent (%s): %s",
 612                         vconn->name, strerror(retval), s);
 613         }
 614         free(s);
 615     }
 616     return retval;
 617 }
 618
 619 /* Same as vconn_connect(), except that it waits until the connection on
 620  * 'vconn' completes or fails.  Thus, it will never return EAGAIN. */
 621 int
 622 vconn_connect_block(struct vconn *vconn)
 623 {
 624     int error;
 625
 626     while ((error = vconn_connect(vconn)) == EAGAIN) {
 627         vconn_run(vconn);
 628         vconn_run_wait(vconn);
 629         vconn_connect_wait(vconn);
 630         poll_block();
 631     }
 632     assert(error != EINPROGRESS);
 633
 634     return error;
 635 }
 636
 637 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
 638 int
 639 vconn_send_block(struct vconn *vconn, struct ofpbuf *msg)
 640 {
 641     int retval;
 642
 643     fatal_signal_run();
 644
 645     while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
 646         vconn_run(vconn);
 647         vconn_run_wait(vconn);
 648         vconn_send_wait(vconn);
 649         poll_block();
 650     }
 651     return retval;
 652 }
 653
 654 /* Same as vconn_recv, except that it waits until a message is received. */
 655 int
 656 vconn_recv_block(struct vconn *vconn, struct ofpbuf **msgp)
 657 {
 658     int retval;
 659
 660     fatal_signal_run();
 661
 662     while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
 663         vconn_run(vconn);
 664         vconn_run_wait(vconn);
 665         vconn_recv_wait(vconn);
 666         poll_block();
 667     }
 668     return retval;
 669 }
 670
 671 /* Waits until a message with a transaction ID matching 'xid' is recived on
 672  * 'vconn'.  Returns 0 if successful, in which case the reply is stored in
 673  * '*replyp' for the caller to examine and free.  Otherwise returns a positive
 674  * errno value, or EOF, and sets '*replyp' to null.
 675  *
 676  * 'request' is always destroyed, regardless of the return value. */
 677 int
 678 vconn_recv_xid(struct vconn *vconn, ovs_be32 xid, struct ofpbuf **replyp)
 679 {
 680     for (;;) {
 681         ovs_be32 recv_xid;
 682         struct ofpbuf *reply;
 683         int error;
 684
 685         error = vconn_recv_block(vconn, &reply);
 686         if (error) {
 687             *replyp = NULL;
 688             return error;
 689         }
 690         recv_xid = ((struct ofp_header *) reply->data)->xid;
 691         if (xid == recv_xid) {
 692             *replyp = reply;
 693             return 0;
 694         }
 695
 696         VLOG_DBG_RL(&bad_ofmsg_rl, "%s: received reply with xid %08"PRIx32
 697                     " != expected %08"PRIx32,
 698                     vconn->name, ntohl(recv_xid), ntohl(xid));
 699         ofpbuf_delete(reply);
 700     }
 701 }
 702
 703 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
 704  * matching transaction ID.  Returns 0 if successful, in which case the reply
 705  * is stored in '*replyp' for the caller to examine and free.  Otherwise
 706  * returns a positive errno value, or EOF, and sets '*replyp' to null.
 707  *
 708  * 'request' should be an OpenFlow request that requires a reply.  Otherwise,
 709  * if there is no reply, this function can end up blocking forever (or until
 710  * the peer drops the connection).
 711  *
 712  * 'request' is always destroyed, regardless of the return value. */
 713 int
 714 vconn_transact(struct vconn *vconn, struct ofpbuf *request,
 715                struct ofpbuf **replyp)
 716 {
 717     ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
 718     int error;
 719
 720     *replyp = NULL;
 721     error = vconn_send_block(vconn, request);
 722     if (error) {
 723         ofpbuf_delete(request);
 724     }
 725     return error ? error : vconn_recv_xid(vconn, send_xid, replyp);
 726 }
 727
 728 /* Sends 'request' followed by a barrier request to 'vconn', then blocks until
 729  * it receives a reply to the barrier.  If successful, stores the reply to
 730  * 'request' in '*replyp', if one was received, and otherwise NULL, then
 731  * returns 0.  Otherwise returns a positive errno value, or EOF, and sets
 732  * '*replyp' to null.
 733  *
 734  * This function is useful for sending an OpenFlow request that doesn't
 735  * ordinarily include a reply but might report an error in special
 736  * circumstances.
 737  *
 738  * 'request' is always destroyed, regardless of the return value. */
 739 int
 740 vconn_transact_noreply(struct vconn *vconn, struct ofpbuf *request,
 741                        struct ofpbuf **replyp)
 742 {
 743     ovs_be32 request_xid;
 744     ovs_be32 barrier_xid;
 745     struct ofpbuf *barrier;
 746     int error;
 747
 748     *replyp = NULL;
 749
 750     /* Send request. */
 751     request_xid = ((struct ofp_header *) request->data)->xid;
 752     error = vconn_send_block(vconn, request);
 753     if (error) {
 754         ofpbuf_delete(request);
 755         return error;
 756     }
 757
 758     /* Send barrier. */
 759     barrier = ofputil_encode_barrier_request();
 760     barrier_xid = ((struct ofp_header *) barrier->data)->xid;
 761     error = vconn_send_block(vconn, barrier);
 762     if (error) {
 763         ofpbuf_delete(barrier);
 764         return error;
 765     }
 766
 767     for (;;) {
 768         struct ofpbuf *msg;
 769         ovs_be32 msg_xid;
 770         int error;
 771
 772         error = vconn_recv_block(vconn, &msg);
 773         if (error) {
 774             ofpbuf_delete(*replyp);
 775             *replyp = NULL;
 776             return error;
 777         }
 778
 779         msg_xid = ((struct ofp_header *) msg->data)->xid;
 780         if (msg_xid == request_xid) {
 781             if (*replyp) {
 782                 VLOG_WARN_RL(&bad_ofmsg_rl, "%s: duplicate replies with "
 783                              "xid %08"PRIx32, vconn->name, ntohl(msg_xid));
 784                 ofpbuf_delete(*replyp);
 785             }
 786             *replyp = msg;
 787         } else {
 788             ofpbuf_delete(msg);
 789             if (msg_xid == barrier_xid) {
 790                 return 0;
 791             } else {
 792                 VLOG_DBG_RL(&bad_ofmsg_rl, "%s: reply with xid %08"PRIx32
 793                             " != expected %08"PRIx32" or %08"PRIx32,
 794                             vconn->name, ntohl(msg_xid),
 795                             ntohl(request_xid), ntohl(barrier_xid));
 796             }
 797         }
 798     }
 799 }
 800
 801 /* vconn_transact_noreply() for a list of "struct ofpbuf"s, sent one by one.
 802  * All of the requests on 'requests' are always destroyed, regardless of the
 803  * return value. */
 804 int
 805 vconn_transact_multiple_noreply(struct vconn *vconn, struct list *requests,
 806                                 struct ofpbuf **replyp)
 807 {
 808     struct ofpbuf *request, *next;
 809
 810     LIST_FOR_EACH_SAFE (request, next, list_node, requests) {
 811         int error;
 812
 813         list_remove(&request->list_node);
 814
 815         error = vconn_transact_noreply(vconn, request, replyp);
 816         if (error || *replyp) {
 817             ofpbuf_list_delete(requests);
 818             return error;
 819         }
 820     }
 821
 822     *replyp = NULL;
 823     return 0;
 824 }
 825
 826 void
 827 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
 828 {
 829     assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
 830
 831     switch (vconn->state) {
 832     case VCS_CONNECTING:
 833         wait = WAIT_CONNECT;
 834         break;
 835
 836     case VCS_SEND_HELLO:
 837     case VCS_SEND_ERROR:
 838         wait = WAIT_SEND;
 839         break;
 840
 841     case VCS_RECV_HELLO:
 842         wait = WAIT_RECV;
 843         break;
 844
 845     case VCS_CONNECTED:
 846         break;
 847
 848     case VCS_DISCONNECTED:
 849         poll_immediate_wake();
 850         return;
 851     }
 852     (vconn->class->wait)(vconn, wait);
 853 }
 854
 855 void
 856 vconn_connect_wait(struct vconn *vconn)
 857 {
 858     vconn_wait(vconn, WAIT_CONNECT);
 859 }
 860
 861 void
 862 vconn_recv_wait(struct vconn *vconn)
 863 {
 864     vconn_wait(vconn, WAIT_RECV);
 865 }
 866
 867 void
 868 vconn_send_wait(struct vconn *vconn)
 869 {
 870     vconn_wait(vconn, WAIT_SEND);
 871 }
 872
 873 /* Given 'name', a connection name in the form "TYPE:ARGS", stores the class
 874  * named "TYPE" into '*classp' and returns 0.  Returns EAFNOSUPPORT and stores
 875  * a null pointer into '*classp' if 'name' is in the wrong form or if no such
 876  * class exists. */
 877 static int
 878 pvconn_lookup_class(const char *name, struct pvconn_class **classp)
 879 {
 880     size_t prefix_len;
 881
 882     prefix_len = strcspn(name, ":");
 883     if (name[prefix_len] != '\0') {
 884         size_t i;
 885
 886         for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
 887             struct pvconn_class *class = pvconn_classes[i];
 888             if (strlen(class->name) == prefix_len
 889                 && !memcmp(class->name, name, prefix_len)) {
 890                 *classp = class;
 891                 return 0;
 892             }
 893         }
 894     }
 895
 896     *classp = NULL;
 897     return EAFNOSUPPORT;
 898 }
 899
 900 /* Returns 0 if 'name' is a connection name in the form "TYPE:ARGS" and TYPE is
 901  * a supported connection type, otherwise EAFNOSUPPORT.  */
 902 int
 903 pvconn_verify_name(const char *name)
 904 {
 905     struct pvconn_class *class;
 906     return pvconn_lookup_class(name, &class);
 907 }
 908
 909 /* Attempts to start listening for OpenFlow connections.  'name' is a
 910  * connection name in the form "TYPE:ARGS", where TYPE is an passive vconn
 911  * class's name and ARGS are vconn class-specific.
 912  *
 913  * Returns 0 if successful, otherwise a positive errno value.  If successful,
 914  * stores a pointer to the new connection in '*pvconnp', otherwise a null
 915  * pointer.  */
 916 int
 917 pvconn_open(const char *name, struct pvconn **pvconnp, uint8_t dscp)
 918 {
 919     struct pvconn_class *class;
 920     struct pvconn *pvconn;
 921     char *suffix_copy;
 922     int error;
 923
 924     check_vconn_classes();
 925
 926     /* Look up the class. */
 927     error = pvconn_lookup_class(name, &class);
 928     if (!class) {
 929         goto error;
 930     }
 931
 932     /* Call class's "open" function. */
 933     suffix_copy = xstrdup(strchr(name, ':') + 1);
 934     error = class->listen(name, suffix_copy, &pvconn, dscp);
 935     free(suffix_copy);
 936     if (error) {
 937         goto error;
 938     }
 939
 940     /* Success. */
 941     *pvconnp = pvconn;
 942     return 0;
 943
 944 error:
 945     *pvconnp = NULL;
 946     return error;
 947 }
 948
 949 /* Returns the name that was used to open 'pvconn'.  The caller must not
 950  * modify or free the name. */
 951 const char *
 952 pvconn_get_name(const struct pvconn *pvconn)
 953 {
 954     return pvconn->name;
 955 }
 956
 957 /* Closes 'pvconn'. */
 958 void
 959 pvconn_close(struct pvconn *pvconn)
 960 {
 961     if (pvconn != NULL) {
 962         char *name = pvconn->name;
 963         (pvconn->class->close)(pvconn);
 964         free(name);
 965     }
 966 }
 967
 968 /* Tries to accept a new connection on 'pvconn'.  If successful, stores the new
 969  * connection in '*new_vconn' and returns 0.  Otherwise, returns a positive
 970  * errno value.
 971  *
 972  * The new vconn will automatically negotiate an OpenFlow protocol version
 973  * acceptable to both peers on the connection.  The version negotiated will be
 974  * no lower than 'min_version' and no higher than OFP10_VERSION.
 975  *
 976  * pvconn_accept() will not block waiting for a connection.  If no connection
 977  * is ready to be accepted, it returns EAGAIN immediately. */
 978 int
 979 pvconn_accept(struct pvconn *pvconn, int min_version, struct vconn **new_vconn)
 980 {
 981     int retval = (pvconn->class->accept)(pvconn, new_vconn);
 982     if (retval) {
 983         *new_vconn = NULL;
 984     } else {
 985         assert((*new_vconn)->state != VCS_CONNECTING
 986                || (*new_vconn)->class->connect);
 987         (*new_vconn)->min_version = min_version;
 988     }
 989     return retval;
 990 }
 991
 992 void
 993 pvconn_wait(struct pvconn *pvconn)
 994 {
 995     (pvconn->class->wait)(pvconn);
 996 }
 997
 998 /* Initializes 'vconn' as a new vconn named 'name', implemented via 'class'.
 999  * The initial connection status, supplied as 'connect_status', is interpreted
1000  * as follows:
1001  *
1002  *      - 0: 'vconn' is connected.  Its 'send' and 'recv' functions may be
1003  *        called in the normal fashion.
1004  *
1005  *      - EAGAIN: 'vconn' is trying to complete a connection.  Its 'connect'
1006  *        function should be called to complete the connection.
1007  *
1008  *      - Other positive errno values indicate that the connection failed with
1009  *        the specified error.
1010  *
1011  * After calling this function, vconn_close() must be used to destroy 'vconn',
1012  * otherwise resources will be leaked.
1013  *
1014  * The caller retains ownership of 'name'. */
1015 void
1016 vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
1017            const char *name)
1018 {
1019     vconn->class = class;
1020     vconn->state = (connect_status == EAGAIN ? VCS_CONNECTING
1021                     : !connect_status ? VCS_SEND_HELLO
1022                     : VCS_DISCONNECTED);
1023     vconn->error = connect_status;
1024     vconn->version = 0;
1025     vconn->min_version = 0;
1026     vconn->remote_ip = 0;
1027     vconn->remote_port = 0;
1028     vconn->local_ip = 0;
1029     vconn->local_port = 0;
1030     vconn->name = xstrdup(name);
1031     assert(vconn->state != VCS_CONNECTING || class->connect);
1032 }
1033
1034 void
1035 vconn_set_remote_ip(struct vconn *vconn, ovs_be32 ip)
1036 {
1037     vconn->remote_ip = ip;
1038 }
1039
1040 void
1041 vconn_set_remote_port(struct vconn *vconn, ovs_be16 port)
1042 {
1043     vconn->remote_port = port;
1044 }
1045
1046 void
1047 vconn_set_local_ip(struct vconn *vconn, ovs_be32 ip)
1048 {
1049     vconn->local_ip = ip;
1050 }
1051
1052 void
1053 vconn_set_local_port(struct vconn *vconn, ovs_be16 port)
1054 {
1055     vconn->local_port = port;
1056 }
1057
1058 void
1059 pvconn_init(struct pvconn *pvconn, struct pvconn_class *class,
1060             const char *name)
1061 {
1062     pvconn->class = class;
1063     pvconn->name = xstrdup(name);
1064 }