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