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->state == VCS_CONNECTING ||
 266         vconn->state == VCS_SEND_HELLO ||
 267         vconn->state == VCS_RECV_HELLO) {
 268         vconn_connect(vconn);
 269     }
 270
 271     if (vconn->class->run) {
 272         (vconn->class->run)(vconn);
 273     }
 274 }
 275
 276 /* Arranges for the poll loop to wake up when 'vconn' needs to perform
 277  * maintenance activities. */
 278 void
 279 vconn_run_wait(struct vconn *vconn)
 280 {
 281     if (vconn->state == VCS_CONNECTING ||
 282         vconn->state == VCS_SEND_HELLO ||
 283         vconn->state == VCS_RECV_HELLO) {
 284         vconn_connect_wait(vconn);
 285     }
 286
 287     if (vconn->class->run_wait) {
 288         (vconn->class->run_wait)(vconn);
 289     }
 290 }
 291
 292 int
 293 vconn_open_block(const char *name, enum ofp_version min_version,
 294                  struct vconn **vconnp)
 295 {
 296     struct vconn *vconn;
 297     int error;
 298
 299     fatal_signal_run();
 300
 301     error = vconn_open(name, min_version, &vconn, DSCP_DEFAULT);
 302     if (!error) {
 303         error = vconn_connect_block(vconn);
 304     }
 305
 306     if (error) {
 307         vconn_close(vconn);
 308         *vconnp = NULL;
 309     } else {
 310         *vconnp = vconn;
 311     }
 312     return error;
 313 }
 314
 315 /* Closes 'vconn'. */
 316 void
 317 vconn_close(struct vconn *vconn)
 318 {
 319     if (vconn != NULL) {
 320         char *name = vconn->name;
 321         (vconn->class->close)(vconn);
 322         free(name);
 323     }
 324 }
 325
 326 /* Returns the name of 'vconn', that is, the string passed to vconn_open(). */
 327 const char *
 328 vconn_get_name(const struct vconn *vconn)
 329 {
 330     return vconn->name;
 331 }
 332
 333 /* Returns the IP address of the peer, or 0 if the peer is not connected over
 334  * an IP-based protocol or if its IP address is not yet known. */
 335 ovs_be32
 336 vconn_get_remote_ip(const struct vconn *vconn)
 337 {
 338     return vconn->remote_ip;
 339 }
 340
 341 /* Returns the transport port of the peer, or 0 if the connection does not
 342  * contain a port or if the port is not yet known. */
 343 ovs_be16
 344 vconn_get_remote_port(const struct vconn *vconn)
 345 {
 346     return vconn->remote_port;
 347 }
 348
 349 /* Returns the IP address used to connect to the peer, or 0 if the
 350  * connection is not an IP-based protocol or if its IP address is not
 351  * yet known. */
 352 ovs_be32
 353 vconn_get_local_ip(const struct vconn *vconn)
 354 {
 355     return vconn->local_ip;
 356 }
 357
 358 /* Returns the transport port used to connect to the peer, or 0 if the
 359  * connection does not contain a port or if the port is not yet known. */
 360 ovs_be16
 361 vconn_get_local_port(const struct vconn *vconn)
 362 {
 363     return vconn->local_port;
 364 }
 365
 366 /* Returns the OpenFlow version negotiated with the peer, or -1 if version
 367  * negotiation is not yet complete.
 368  *
 369  * A vconn that has successfully connected (that is, vconn_connect() or
 370  * vconn_send() or vconn_recv() has returned 0) always negotiated a version. */
 371 int
 372 vconn_get_version(const struct vconn *vconn)
 373 {
 374     return vconn->version ? vconn->version : -1;
 375 }
 376
 377 static void
 378 vcs_connecting(struct vconn *vconn)
 379 {
 380     int retval = (vconn->class->connect)(vconn);
 381     assert(retval != EINPROGRESS);
 382     if (!retval) {
 383         vconn->state = VCS_SEND_HELLO;
 384     } else if (retval != EAGAIN) {
 385         vconn->state = VCS_DISCONNECTED;
 386         vconn->error = retval;
 387     }
 388 }
 389
 390 static void
 391 vcs_send_hello(struct vconn *vconn)
 392 {
 393     struct ofpbuf *b;
 394     int retval;
 395
 396     b = ofpraw_alloc(OFPRAW_OFPT_HELLO, OFP10_VERSION, 0);
 397     retval = do_send(vconn, b);
 398     if (!retval) {
 399         vconn->state = VCS_RECV_HELLO;
 400     } else {
 401         ofpbuf_delete(b);
 402         if (retval != EAGAIN) {
 403             vconn->state = VCS_DISCONNECTED;
 404             vconn->error = retval;
 405         }
 406     }
 407 }
 408
 409 static void
 410 vcs_recv_hello(struct vconn *vconn)
 411 {
 412     struct ofpbuf *b;
 413     int retval;
 414
 415     retval = do_recv(vconn, &b);
 416     if (!retval) {
 417         const struct ofp_header *oh = b->data;
 418         enum ofptype type;
 419         enum ofperr error;
 420
 421         error = ofptype_decode(&type, b->data);
 422         if (!error && type == OFPTYPE_HELLO) {
 423             if (b->size > sizeof *oh) {
 424                 struct ds msg = DS_EMPTY_INITIALIZER;
 425                 ds_put_format(&msg, "%s: extra-long hello:\n", vconn->name);
 426                 ds_put_hex_dump(&msg, b->data, b->size, 0, true);
 427                 VLOG_WARN_RL(&bad_ofmsg_rl, "%s", ds_cstr(&msg));
 428                 ds_destroy(&msg);
 429             }
 430
 431             vconn->version = MIN(OFP10_VERSION, oh->version);
 432             if (vconn->version < vconn->min_version) {
 433                 VLOG_WARN_RL(&bad_ofmsg_rl,
 434                              "%s: version negotiation failed: we support "
 435                              "versions 0x%02x to 0x%02x inclusive but peer "
 436                              "supports no later than version 0x%02"PRIx8,
 437                              vconn->name, vconn->min_version, OFP10_VERSION,
 438                              oh->version);
 439                 vconn->state = VCS_SEND_ERROR;
 440             } else {
 441                 VLOG_DBG("%s: negotiated OpenFlow version 0x%02x "
 442                          "(we support versions 0x%02x to 0x%02x inclusive, "
 443                          "peer no later than version 0x%02"PRIx8")",
 444                          vconn->name, vconn->version, vconn->min_version,
 445                          OFP10_VERSION, oh->version);
 446                 vconn->state = VCS_CONNECTED;
 447             }
 448             ofpbuf_delete(b);
 449             return;
 450         } else {
 451             char *s = ofp_to_string(b->data, b->size, 1);
 452             VLOG_WARN_RL(&bad_ofmsg_rl,
 453                          "%s: received message while expecting hello: %s",
 454                          vconn->name, s);
 455             free(s);
 456             retval = EPROTO;
 457             ofpbuf_delete(b);
 458         }
 459     }
 460
 461     if (retval != EAGAIN) {
 462         vconn->state = VCS_DISCONNECTED;
 463         vconn->error = retval == EOF ? ECONNRESET : retval;
 464     }
 465 }
 466
 467 static void
 468 vcs_send_error(struct vconn *vconn)
 469 {
 470     struct ofpbuf *b;
 471     char s[128];
 472     int retval;
 473
 474     snprintf(s, sizeof s, "We support versions 0x%02x to 0x%02x inclusive but "
 475              "you support no later than version 0x%02"PRIx8".",
 476              vconn->min_version, OFP12_VERSION, vconn->version);
 477     b = ofperr_encode_hello(OFPERR_OFPHFC_INCOMPATIBLE, vconn->version, s);
 478     retval = do_send(vconn, b);
 479     if (retval) {
 480         ofpbuf_delete(b);
 481     }
 482     if (retval != EAGAIN) {
 483         vconn->state = VCS_DISCONNECTED;
 484         vconn->error = retval ? retval : EPROTO;
 485     }
 486 }
 487
 488 /* Tries to complete the connection on 'vconn'. If 'vconn''s connection is
 489  * complete, returns 0 if the connection was successful or a positive errno
 490  * value if it failed.  If the connection is still in progress, returns
 491  * EAGAIN. */
 492 int
 493 vconn_connect(struct vconn *vconn)
 494 {
 495     enum vconn_state last_state;
 496
 497     assert(vconn->min_version > 0);
 498     do {
 499         last_state = vconn->state;
 500         switch (vconn->state) {
 501         case VCS_CONNECTING:
 502             vcs_connecting(vconn);
 503             break;
 504
 505         case VCS_SEND_HELLO:
 506             vcs_send_hello(vconn);
 507             break;
 508
 509         case VCS_RECV_HELLO:
 510             vcs_recv_hello(vconn);
 511             break;
 512
 513         case VCS_CONNECTED:
 514             return 0;
 515
 516         case VCS_SEND_ERROR:
 517             vcs_send_error(vconn);
 518             break;
 519
 520         case VCS_DISCONNECTED:
 521             return vconn->error;
 522
 523         default:
 524             NOT_REACHED();
 525         }
 526     } while (vconn->state != last_state);
 527
 528     return EAGAIN;
 529 }
 530
 531 /* Tries to receive an OpenFlow message from 'vconn'.  If successful, stores
 532  * the received message into '*msgp' and returns 0.  The caller is responsible
 533  * for destroying the message with ofpbuf_delete().  On failure, returns a
 534  * positive errno value and stores a null pointer into '*msgp'.  On normal
 535  * connection close, returns EOF.
 536  *
 537  * vconn_recv will not block waiting for a packet to arrive.  If no packets
 538  * have been received, it returns EAGAIN immediately. */
 539 int
 540 vconn_recv(struct vconn *vconn, struct ofpbuf **msgp)
 541 {
 542     struct ofpbuf *msg;
 543     int retval;
 544
 545     retval = vconn_connect(vconn);
 546     if (!retval) {
 547         retval = do_recv(vconn, &msg);
 548     }
 549     if (!retval) {
 550         const struct ofp_header *oh = msg->data;
 551         if (oh->version != vconn->version) {
 552             enum ofptype type;
 553
 554             if (ofptype_decode(&type, msg->data)
 555                 || (type != OFPTYPE_HELLO &&
 556                     type != OFPTYPE_ERROR &&
 557                     type != OFPTYPE_ECHO_REQUEST &&
 558                     type != OFPTYPE_ECHO_REPLY)) {
 559                 VLOG_ERR_RL(&bad_ofmsg_rl, "%s: received OpenFlow version "
 560                             "0x%02"PRIx8" != expected %02x",
 561                             vconn->name, oh->version, vconn->version);
 562                 ofpbuf_delete(msg);
 563                 retval = EPROTO;
 564             }
 565         }
 566     }
 567
 568     *msgp = retval ? NULL : msg;
 569     return retval;
 570 }
 571
 572 static int
 573 do_recv(struct vconn *vconn, struct ofpbuf **msgp)
 574 {
 575     int retval = (vconn->class->recv)(vconn, msgp);
 576     if (!retval) {
 577         COVERAGE_INC(vconn_received);
 578         if (VLOG_IS_DBG_ENABLED()) {
 579             char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
 580             VLOG_DBG_RL(&ofmsg_rl, "%s: received: %s", vconn->name, s);
 581             free(s);
 582         }
 583     }
 584     return retval;
 585 }
 586
 587 /* Tries to queue 'msg' for transmission on 'vconn'.  If successful, returns 0,
 588  * in which case ownership of 'msg' is transferred to the vconn.  Success does
 589  * not guarantee that 'msg' has been or ever will be delivered to the peer,
 590  * only that it has been queued for transmission.
 591  *
 592  * Returns a positive errno value on failure, in which case the caller
 593  * retains ownership of 'msg'.
 594  *
 595  * vconn_send will not block.  If 'msg' cannot be immediately accepted for
 596  * transmission, it returns EAGAIN immediately. */
 597 int
 598 vconn_send(struct vconn *vconn, struct ofpbuf *msg)
 599 {
 600     int retval = vconn_connect(vconn);
 601     if (!retval) {
 602         retval = do_send(vconn, msg);
 603     }
 604     return retval;
 605 }
 606
 607 static int
 608 do_send(struct vconn *vconn, struct ofpbuf *msg)
 609 {
 610     int retval;
 611
 612     assert(msg->size >= sizeof(struct ofp_header));
 613
 614     ofpmsg_update_length(msg);
 615     if (!VLOG_IS_DBG_ENABLED()) {
 616         COVERAGE_INC(vconn_sent);
 617         retval = (vconn->class->send)(vconn, msg);
 618     } else {
 619         char *s = ofp_to_string(msg->data, msg->size, 1);
 620         retval = (vconn->class->send)(vconn, msg);
 621         if (retval != EAGAIN) {
 622             VLOG_DBG_RL(&ofmsg_rl, "%s: sent (%s): %s",
 623                         vconn->name, strerror(retval), s);
 624         }
 625         free(s);
 626     }
 627     return retval;
 628 }
 629
 630 /* Same as vconn_connect(), except that it waits until the connection on
 631  * 'vconn' completes or fails.  Thus, it will never return EAGAIN. */
 632 int
 633 vconn_connect_block(struct vconn *vconn)
 634 {
 635     int error;
 636
 637     while ((error = vconn_connect(vconn)) == EAGAIN) {
 638         vconn_run(vconn);
 639         vconn_run_wait(vconn);
 640         vconn_connect_wait(vconn);
 641         poll_block();
 642     }
 643     assert(error != EINPROGRESS);
 644
 645     return error;
 646 }
 647
 648 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
 649 int
 650 vconn_send_block(struct vconn *vconn, struct ofpbuf *msg)
 651 {
 652     int retval;
 653
 654     fatal_signal_run();
 655
 656     while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
 657         vconn_run(vconn);
 658         vconn_run_wait(vconn);
 659         vconn_send_wait(vconn);
 660         poll_block();
 661     }
 662     return retval;
 663 }
 664
 665 /* Same as vconn_recv, except that it waits until a message is received. */
 666 int
 667 vconn_recv_block(struct vconn *vconn, struct ofpbuf **msgp)
 668 {
 669     int retval;
 670
 671     fatal_signal_run();
 672
 673     while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
 674         vconn_run(vconn);
 675         vconn_run_wait(vconn);
 676         vconn_recv_wait(vconn);
 677         poll_block();
 678     }
 679     return retval;
 680 }
 681
 682 /* Waits until a message with a transaction ID matching 'xid' is recived on
 683  * 'vconn'.  Returns 0 if successful, in which case the reply is stored in
 684  * '*replyp' for the caller to examine and free.  Otherwise returns a positive
 685  * errno value, or EOF, and sets '*replyp' to null.
 686  *
 687  * 'request' is always destroyed, regardless of the return value. */
 688 int
 689 vconn_recv_xid(struct vconn *vconn, ovs_be32 xid, struct ofpbuf **replyp)
 690 {
 691     for (;;) {
 692         ovs_be32 recv_xid;
 693         struct ofpbuf *reply;
 694         int error;
 695
 696         error = vconn_recv_block(vconn, &reply);
 697         if (error) {
 698             *replyp = NULL;
 699             return error;
 700         }
 701         recv_xid = ((struct ofp_header *) reply->data)->xid;
 702         if (xid == recv_xid) {
 703             *replyp = reply;
 704             return 0;
 705         }
 706
 707         VLOG_DBG_RL(&bad_ofmsg_rl, "%s: received reply with xid %08"PRIx32
 708                     " != expected %08"PRIx32,
 709                     vconn->name, ntohl(recv_xid), ntohl(xid));
 710         ofpbuf_delete(reply);
 711     }
 712 }
 713
 714 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
 715  * matching transaction ID.  Returns 0 if successful, in which case the reply
 716  * is stored in '*replyp' for the caller to examine and free.  Otherwise
 717  * returns a positive errno value, or EOF, and sets '*replyp' to null.
 718  *
 719  * 'request' should be an OpenFlow request that requires a reply.  Otherwise,
 720  * if there is no reply, this function can end up blocking forever (or until
 721  * the peer drops the connection).
 722  *
 723  * 'request' is always destroyed, regardless of the return value. */
 724 int
 725 vconn_transact(struct vconn *vconn, struct ofpbuf *request,
 726                struct ofpbuf **replyp)
 727 {
 728     ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
 729     int error;
 730
 731     *replyp = NULL;
 732     error = vconn_send_block(vconn, request);
 733     if (error) {
 734         ofpbuf_delete(request);
 735     }
 736     return error ? error : vconn_recv_xid(vconn, send_xid, replyp);
 737 }
 738
 739 /* Sends 'request' followed by a barrier request to 'vconn', then blocks until
 740  * it receives a reply to the barrier.  If successful, stores the reply to
 741  * 'request' in '*replyp', if one was received, and otherwise NULL, then
 742  * returns 0.  Otherwise returns a positive errno value, or EOF, and sets
 743  * '*replyp' to null.
 744  *
 745  * This function is useful for sending an OpenFlow request that doesn't
 746  * ordinarily include a reply but might report an error in special
 747  * circumstances.
 748  *
 749  * 'request' is always destroyed, regardless of the return value. */
 750 int
 751 vconn_transact_noreply(struct vconn *vconn, struct ofpbuf *request,
 752                        struct ofpbuf **replyp)
 753 {
 754     ovs_be32 request_xid;
 755     ovs_be32 barrier_xid;
 756     struct ofpbuf *barrier;
 757     int error;
 758
 759     *replyp = NULL;
 760
 761     /* Send request. */
 762     request_xid = ((struct ofp_header *) request->data)->xid;
 763     error = vconn_send_block(vconn, request);
 764     if (error) {
 765         ofpbuf_delete(request);
 766         return error;
 767     }
 768
 769     /* Send barrier. */
 770     barrier = ofputil_encode_barrier_request(vconn_get_version(vconn));
 771     barrier_xid = ((struct ofp_header *) barrier->data)->xid;
 772     error = vconn_send_block(vconn, barrier);
 773     if (error) {
 774         ofpbuf_delete(barrier);
 775         return error;
 776     }
 777
 778     for (;;) {
 779         struct ofpbuf *msg;
 780         ovs_be32 msg_xid;
 781         int error;
 782
 783         error = vconn_recv_block(vconn, &msg);
 784         if (error) {
 785             ofpbuf_delete(*replyp);
 786             *replyp = NULL;
 787             return error;
 788         }
 789
 790         msg_xid = ((struct ofp_header *) msg->data)->xid;
 791         if (msg_xid == request_xid) {
 792             if (*replyp) {
 793                 VLOG_WARN_RL(&bad_ofmsg_rl, "%s: duplicate replies with "
 794                              "xid %08"PRIx32, vconn->name, ntohl(msg_xid));
 795                 ofpbuf_delete(*replyp);
 796             }
 797             *replyp = msg;
 798         } else {
 799             ofpbuf_delete(msg);
 800             if (msg_xid == barrier_xid) {
 801                 return 0;
 802             } else {
 803                 VLOG_DBG_RL(&bad_ofmsg_rl, "%s: reply with xid %08"PRIx32
 804                             " != expected %08"PRIx32" or %08"PRIx32,
 805                             vconn->name, ntohl(msg_xid),
 806                             ntohl(request_xid), ntohl(barrier_xid));
 807             }
 808         }
 809     }
 810 }
 811
 812 /* vconn_transact_noreply() for a list of "struct ofpbuf"s, sent one by one.
 813  * All of the requests on 'requests' are always destroyed, regardless of the
 814  * return value. */
 815 int
 816 vconn_transact_multiple_noreply(struct vconn *vconn, struct list *requests,
 817                                 struct ofpbuf **replyp)
 818 {
 819     struct ofpbuf *request, *next;
 820
 821     LIST_FOR_EACH_SAFE (request, next, list_node, requests) {
 822         int error;
 823
 824         list_remove(&request->list_node);
 825
 826         error = vconn_transact_noreply(vconn, request, replyp);
 827         if (error || *replyp) {
 828             ofpbuf_list_delete(requests);
 829             return error;
 830         }
 831     }
 832
 833     *replyp = NULL;
 834     return 0;
 835 }
 836
 837 void
 838 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
 839 {
 840     assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
 841
 842     switch (vconn->state) {
 843     case VCS_CONNECTING:
 844         wait = WAIT_CONNECT;
 845         break;
 846
 847     case VCS_SEND_HELLO:
 848     case VCS_SEND_ERROR:
 849         wait = WAIT_SEND;
 850         break;
 851
 852     case VCS_RECV_HELLO:
 853         wait = WAIT_RECV;
 854         break;
 855
 856     case VCS_CONNECTED:
 857         break;
 858
 859     case VCS_DISCONNECTED:
 860         poll_immediate_wake();
 861         return;
 862     }
 863     (vconn->class->wait)(vconn, wait);
 864 }
 865
 866 void
 867 vconn_connect_wait(struct vconn *vconn)
 868 {
 869     vconn_wait(vconn, WAIT_CONNECT);
 870 }
 871
 872 void
 873 vconn_recv_wait(struct vconn *vconn)
 874 {
 875     vconn_wait(vconn, WAIT_RECV);
 876 }
 877
 878 void
 879 vconn_send_wait(struct vconn *vconn)
 880 {
 881     vconn_wait(vconn, WAIT_SEND);
 882 }
 883
 884 /* Given 'name', a connection name in the form "TYPE:ARGS", stores the class
 885  * named "TYPE" into '*classp' and returns 0.  Returns EAFNOSUPPORT and stores
 886  * a null pointer into '*classp' if 'name' is in the wrong form or if no such
 887  * class exists. */
 888 static int
 889 pvconn_lookup_class(const char *name, struct pvconn_class **classp)
 890 {
 891     size_t prefix_len;
 892
 893     prefix_len = strcspn(name, ":");
 894     if (name[prefix_len] != '\0') {
 895         size_t i;
 896
 897         for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
 898             struct pvconn_class *class = pvconn_classes[i];
 899             if (strlen(class->name) == prefix_len
 900                 && !memcmp(class->name, name, prefix_len)) {
 901                 *classp = class;
 902                 return 0;
 903             }
 904         }
 905     }
 906
 907     *classp = NULL;
 908     return EAFNOSUPPORT;
 909 }
 910
 911 /* Returns 0 if 'name' is a connection name in the form "TYPE:ARGS" and TYPE is
 912  * a supported connection type, otherwise EAFNOSUPPORT.  */
 913 int
 914 pvconn_verify_name(const char *name)
 915 {
 916     struct pvconn_class *class;
 917     return pvconn_lookup_class(name, &class);
 918 }
 919
 920 /* Attempts to start listening for OpenFlow connections.  'name' is a
 921  * connection name in the form "TYPE:ARGS", where TYPE is an passive vconn
 922  * class's name and ARGS are vconn class-specific.
 923  *
 924  * Returns 0 if successful, otherwise a positive errno value.  If successful,
 925  * stores a pointer to the new connection in '*pvconnp', otherwise a null
 926  * pointer.  */
 927 int
 928 pvconn_open(const char *name, struct pvconn **pvconnp, uint8_t dscp)
 929 {
 930     struct pvconn_class *class;
 931     struct pvconn *pvconn;
 932     char *suffix_copy;
 933     int error;
 934
 935     check_vconn_classes();
 936
 937     /* Look up the class. */
 938     error = pvconn_lookup_class(name, &class);
 939     if (!class) {
 940         goto error;
 941     }
 942
 943     /* Call class's "open" function. */
 944     suffix_copy = xstrdup(strchr(name, ':') + 1);
 945     error = class->listen(name, suffix_copy, &pvconn, dscp);
 946     free(suffix_copy);
 947     if (error) {
 948         goto error;
 949     }
 950
 951     /* Success. */
 952     *pvconnp = pvconn;
 953     return 0;
 954
 955 error:
 956     *pvconnp = NULL;
 957     return error;
 958 }
 959
 960 /* Returns the name that was used to open 'pvconn'.  The caller must not
 961  * modify or free the name. */
 962 const char *
 963 pvconn_get_name(const struct pvconn *pvconn)
 964 {
 965     return pvconn->name;
 966 }
 967
 968 /* Closes 'pvconn'. */
 969 void
 970 pvconn_close(struct pvconn *pvconn)
 971 {
 972     if (pvconn != NULL) {
 973         char *name = pvconn->name;
 974         (pvconn->class->close)(pvconn);
 975         free(name);
 976     }
 977 }
 978
 979 /* Tries to accept a new connection on 'pvconn'.  If successful, stores the new
 980  * connection in '*new_vconn' and returns 0.  Otherwise, returns a positive
 981  * errno value.
 982  *
 983  * The new vconn will automatically negotiate an OpenFlow protocol version
 984  * acceptable to both peers on the connection.  The version negotiated will be
 985  * no lower than 'min_version' and no higher than OFP10_VERSION.
 986  *
 987  * pvconn_accept() will not block waiting for a connection.  If no connection
 988  * is ready to be accepted, it returns EAGAIN immediately. */
 989 int
 990 pvconn_accept(struct pvconn *pvconn, int min_version, struct vconn **new_vconn)
 991 {
 992     int retval = (pvconn->class->accept)(pvconn, new_vconn);
 993     if (retval) {
 994         *new_vconn = NULL;
 995     } else {
 996         assert((*new_vconn)->state != VCS_CONNECTING
 997                || (*new_vconn)->class->connect);
 998         (*new_vconn)->min_version = min_version;
 999     }
1000     return retval;
1001 }
1002
1003 void
1004 pvconn_wait(struct pvconn *pvconn)
1005 {
1006     (pvconn->class->wait)(pvconn);
1007 }
1008
1009 /* Initializes 'vconn' as a new vconn named 'name', implemented via 'class'.
1010  * The initial connection status, supplied as 'connect_status', is interpreted
1011  * as follows:
1012  *
1013  *      - 0: 'vconn' is connected.  Its 'send' and 'recv' functions may be
1014  *        called in the normal fashion.
1015  *
1016  *      - EAGAIN: 'vconn' is trying to complete a connection.  Its 'connect'
1017  *        function should be called to complete the connection.
1018  *
1019  *      - Other positive errno values indicate that the connection failed with
1020  *        the specified error.
1021  *
1022  * After calling this function, vconn_close() must be used to destroy 'vconn',
1023  * otherwise resources will be leaked.
1024  *
1025  * The caller retains ownership of 'name'. */
1026 void
1027 vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
1028            const char *name)
1029 {
1030     vconn->class = class;
1031     vconn->state = (connect_status == EAGAIN ? VCS_CONNECTING
1032                     : !connect_status ? VCS_SEND_HELLO
1033                     : VCS_DISCONNECTED);
1034     vconn->error = connect_status;
1035     vconn->version = 0;
1036     vconn->min_version = 0;
1037     vconn->remote_ip = 0;
1038     vconn->remote_port = 0;
1039     vconn->local_ip = 0;
1040     vconn->local_port = 0;
1041     vconn->name = xstrdup(name);
1042     assert(vconn->state != VCS_CONNECTING || class->connect);
1043 }
1044
1045 void
1046 vconn_set_remote_ip(struct vconn *vconn, ovs_be32 ip)
1047 {
1048     vconn->remote_ip = ip;
1049 }
1050
1051 void
1052 vconn_set_remote_port(struct vconn *vconn, ovs_be16 port)
1053 {
1054     vconn->remote_port = port;
1055 }
1056
1057 void
1058 vconn_set_local_ip(struct vconn *vconn, ovs_be32 ip)
1059 {
1060     vconn->local_ip = ip;
1061 }
1062
1063 void
1064 vconn_set_local_port(struct vconn *vconn, ovs_be16 port)
1065 {
1066     vconn->local_port = port;
1067 }
1068
1069 void
1070 pvconn_init(struct pvconn *pvconn, struct pvconn_class *class,
1071             const char *name)
1072 {
1073     pvconn->class = class;
1074     pvconn->name = xstrdup(name);
1075 }