tests/test-vconn.c

   1 /*
   2  * Copyright (c) 2009, 2010, 2011, 2012, 2013, 2014 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 #undef NDEBUG
  19 #include "openvswitch/vconn.h"
  20 #include <assert.h>
  21 #include <errno.h>
  22 #include <inttypes.h>
  23 #include <signal.h>
  24 #include <stdlib.h>
  25 #include <unistd.h>
  26 #include "command-line.h"
  27 #include "fatal-signal.h"
  28 #include "ofp-msgs.h"
  29 #include "ofp-util.h"
  30 #include "ofpbuf.h"
  31 #include "openflow/openflow.h"
  32 #include "ovstest.h"
  33 #include "poll-loop.h"
  34 #include "socket-util.h"
  35 #include "stream.h"
  36 #include "stream-ssl.h"
  37 #include "timeval.h"
  38 #include "util.h"
  39 #include "openvswitch/vlog.h"
  40
  41 struct fake_pvconn {
  42     const char *type;
  43     char *pvconn_name;
  44     char *vconn_name;
  45     struct pstream *pstream;
  46 };
  47
  48 static void
  49 check(int a, int b, const char *as, const char *file, int line)
  50 {
  51     if (a != b) {
  52         ovs_fatal(0, "%s:%d: %s is %d but should be %d", file, line, as, a, b);
  53     }
  54 }
  55
  56
  57 #define CHECK(A, B) check(A, B, #A, __FILE__, __LINE__)
  58
  59 static void
  60 check_errno(int a, int b, const char *as, const char *file, int line)
  61 {
  62     if (a != b) {
  63         char *str_b = xstrdup(ovs_strerror(abs(b)));
  64         ovs_fatal(0, "%s:%d: %s is %d (%s) but should be %d (%s)",
  65                   file, line, as, a, ovs_strerror(abs(a)), b, str_b);
  66     }
  67 }
  68
  69 #define CHECK_ERRNO(A, B) check_errno(A, B, #A, __FILE__, __LINE__)
  70
  71 static void
  72 fpv_create(const char *type, struct fake_pvconn *fpv)
  73 {
  74 #ifdef HAVE_OPENSSL
  75     if (!strcmp(type, "ssl")) {
  76         stream_ssl_set_private_key_file("testpki-privkey.pem");
  77         stream_ssl_set_certificate_file("testpki-cert.pem");
  78         stream_ssl_set_ca_cert_file("testpki-cacert.pem", false);
  79     }
  80 #endif
  81
  82     fpv->type = type;
  83     if (!strcmp(type, "unix")) {
  84         static int unix_count = 0;
  85         char *bind_path;
  86
  87         bind_path = xasprintf("fake-pvconn.%d", unix_count++);
  88         fpv->pvconn_name = xasprintf("punix:%s", bind_path);
  89         fpv->vconn_name = xasprintf("unix:%s", bind_path);
  90         CHECK_ERRNO(pstream_open(fpv->pvconn_name, &fpv->pstream,
  91                                  DSCP_DEFAULT), 0);
  92         free(bind_path);
  93     } else if (!strcmp(type, "tcp") || !strcmp(type, "ssl")) {
  94         char *s, *port, *save_ptr = NULL;
  95         char *open_name;
  96
  97         open_name = xasprintf("p%s:0:127.0.0.1", type);
  98         CHECK_ERRNO(pstream_open(open_name, &fpv->pstream, DSCP_DEFAULT), 0);
  99
 100         /* Extract bound port number from pstream name. */
 101         s = xstrdup(pstream_get_name(fpv->pstream));
 102         strtok_r(s, ":", &save_ptr);
 103         port = strtok_r(NULL, ":", &save_ptr);
 104
 105         /* Save info. */
 106         fpv->pvconn_name = xstrdup(pstream_get_name(fpv->pstream));
 107         fpv->vconn_name = xasprintf("%s:127.0.0.1:%s", type, port);
 108
 109         free(open_name);
 110         free(s);
 111     } else {
 112         abort();
 113     }
 114 }
 115
 116 static struct stream *
 117 fpv_accept(struct fake_pvconn *fpv)
 118 {
 119     struct stream *stream;
 120
 121     CHECK_ERRNO(pstream_accept_block(fpv->pstream, &stream), 0);
 122
 123     return stream;
 124 }
 125
 126 static void
 127 fpv_close(struct fake_pvconn *fpv)
 128 {
 129     pstream_close(fpv->pstream);
 130     fpv->pstream = NULL;
 131 }
 132
 133 static void
 134 fpv_destroy(struct fake_pvconn *fpv)
 135 {
 136     fpv_close(fpv);
 137     free(fpv->pvconn_name);
 138     free(fpv->vconn_name);
 139 }
 140
 141 /* Connects to a fake_pvconn with vconn_open(), then closes the listener and
 142  * verifies that vconn_connect() reports 'expected_error'. */
 143 static void
 144 test_refuse_connection(int argc OVS_UNUSED, char *argv[])
 145 {
 146     const char *type = argv[1];
 147     struct fake_pvconn fpv;
 148     struct vconn *vconn;
 149     int error;
 150
 151     fpv_create(type, &fpv);
 152     CHECK_ERRNO(vconn_open(fpv.vconn_name, 0, DSCP_DEFAULT, &vconn), 0);
 153     fpv_close(&fpv);
 154     vconn_run(vconn);
 155
 156     error = vconn_connect_block(vconn);
 157     if (!strcmp(type, "tcp")) {
 158         if (error != ECONNRESET && error != EPIPE
 159 #ifdef _WIN32
 160             && error != WSAECONNRESET
 161 #endif
 162             ) {
 163             ovs_fatal(0, "unexpected vconn_connect() return value %d (%s)",
 164                       error, ovs_strerror(error));
 165         }
 166     } else if (!strcmp(type, "unix")) {
 167 #ifndef _WIN32
 168         CHECK_ERRNO(error, EPIPE);
 169 #else
 170         CHECK_ERRNO(error, WSAECONNRESET);
 171 #endif
 172     } else if (!strcmp(type, "ssl")) {
 173         if (error != EPROTO && error != ECONNRESET) {
 174             ovs_fatal(0, "unexpected vconn_connect() return value %d (%s)",
 175                       error, ovs_strerror(error));
 176         }
 177     } else {
 178         ovs_fatal(0, "invalid connection type %s", type);
 179     }
 180
 181     vconn_close(vconn);
 182     fpv_destroy(&fpv);
 183 }
 184
 185 /* Connects to a fake_pvconn with vconn_open(), accepts that connection and
 186  * closes it immediately, and verifies that vconn_connect() reports
 187  * 'expected_error'. */
 188 static void
 189 test_accept_then_close(int argc OVS_UNUSED, char *argv[])
 190 {
 191     const char *type = argv[1];
 192     struct fake_pvconn fpv;
 193     struct vconn *vconn;
 194     int error;
 195
 196     fpv_create(type, &fpv);
 197     CHECK_ERRNO(vconn_open(fpv.vconn_name, 0, DSCP_DEFAULT, &vconn), 0);
 198     vconn_run(vconn);
 199     stream_close(fpv_accept(&fpv));
 200     fpv_close(&fpv);
 201
 202     error = vconn_connect_block(vconn);
 203     if (!strcmp(type, "tcp") || !strcmp(type, "unix")) {
 204         if (error != ECONNRESET && error != EPIPE
 205 #ifdef _WIN32
 206             && error != WSAECONNRESET
 207 #endif
 208             ) {
 209             ovs_fatal(0, "unexpected vconn_connect() return value %d (%s)",
 210                       error, ovs_strerror(error));
 211         }
 212     } else {
 213         CHECK_ERRNO(error, EPROTO);
 214     }
 215
 216     vconn_close(vconn);
 217     fpv_destroy(&fpv);
 218 }
 219
 220 /* Connects to a fake_pvconn with vconn_open(), accepts that connection and
 221  * reads the hello message from it, then closes the connection and verifies
 222  * that vconn_connect() reports 'expected_error'. */
 223 static void
 224 test_read_hello(int argc OVS_UNUSED, char *argv[])
 225 {
 226     const char *type = argv[1];
 227     struct fake_pvconn fpv;
 228     struct vconn *vconn;
 229     struct stream *stream;
 230     int error;
 231
 232     fpv_create(type, &fpv);
 233     CHECK_ERRNO(vconn_open(fpv.vconn_name, 0, DSCP_DEFAULT, &vconn), 0);
 234     vconn_run(vconn);
 235     stream = fpv_accept(&fpv);
 236     fpv_destroy(&fpv);
 237     for (;;) {
 238        struct ofp_header hello;
 239        int retval;
 240
 241        retval = stream_recv(stream, &hello, sizeof hello);
 242        if (retval == sizeof hello) {
 243            enum ofpraw raw;
 244
 245            CHECK(hello.version, OFP13_VERSION);
 246            CHECK(ofpraw_decode_partial(&raw, &hello, sizeof hello), 0);
 247            CHECK(raw, OFPRAW_OFPT_HELLO);
 248            CHECK(ntohs(hello.length), sizeof hello);
 249            break;
 250        } else {
 251            CHECK_ERRNO(retval, -EAGAIN);
 252        }
 253
 254        vconn_run(vconn);
 255        CHECK_ERRNO(vconn_connect(vconn), EAGAIN);
 256        vconn_run_wait(vconn);
 257        vconn_connect_wait(vconn);
 258        stream_recv_wait(stream);
 259        poll_block();
 260     }
 261     stream_close(stream);
 262     error = vconn_connect_block(vconn);
 263     if (error != ECONNRESET && error != EPIPE) {
 264         ovs_fatal(0, "unexpected vconn_connect() return value %d (%s)",
 265                   error, ovs_strerror(error));
 266     }
 267     vconn_close(vconn);
 268 }
 269
 270 /* Connects to a fake_pvconn with vconn_open(), accepts that connection and
 271  * sends the 'out' bytes in 'out_size' to it (presumably an OFPT_HELLO
 272  * message), then verifies that vconn_connect() reports
 273  * 'expect_connect_error'. */
 274 static void
 275 test_send_hello(const char *type, const void *out, size_t out_size,
 276                 int expect_connect_error)
 277 {
 278     struct fake_pvconn fpv;
 279     struct vconn *vconn;
 280     bool read_hello, connected;
 281     struct ofpbuf *msg;
 282     struct stream *stream;
 283     size_t n_sent;
 284
 285     fpv_create(type, &fpv);
 286     CHECK_ERRNO(vconn_open(fpv.vconn_name, 0, DSCP_DEFAULT, &vconn), 0);
 287     vconn_run(vconn);
 288     stream = fpv_accept(&fpv);
 289     fpv_destroy(&fpv);
 290
 291     n_sent = 0;
 292     while (n_sent < out_size) {
 293         int retval;
 294
 295         retval = stream_send(stream, (char *) out + n_sent, out_size - n_sent);
 296         if (retval > 0) {
 297             n_sent += retval;
 298         } else if (retval == -EAGAIN) {
 299             stream_run(stream);
 300             vconn_run(vconn);
 301             stream_recv_wait(stream);
 302             vconn_connect_wait(vconn);
 303             vconn_run_wait(vconn);
 304             poll_block();
 305         } else {
 306             ovs_fatal(0, "stream_send returned unexpected value %d", retval);
 307         }
 308     }
 309
 310     read_hello = connected = false;
 311     for (;;) {
 312        if (!read_hello) {
 313            struct ofp_header hello;
 314            int retval = stream_recv(stream, &hello, sizeof hello);
 315            if (retval == sizeof hello) {
 316                enum ofpraw raw;
 317
 318                CHECK(hello.version, OFP13_VERSION);
 319                CHECK(ofpraw_decode_partial(&raw, &hello, sizeof hello), 0);
 320                CHECK(raw, OFPRAW_OFPT_HELLO);
 321                CHECK(ntohs(hello.length), sizeof hello);
 322                read_hello = true;
 323            } else {
 324                CHECK_ERRNO(retval, -EAGAIN);
 325            }
 326        }
 327
 328        vconn_run(vconn);
 329        if (!connected) {
 330            int error = vconn_connect(vconn);
 331            if (error == expect_connect_error) {
 332                if (!error) {
 333                    connected = true;
 334                } else {
 335                    stream_close(stream);
 336                    vconn_close(vconn);
 337                    return;
 338                }
 339            } else {
 340                CHECK_ERRNO(error, EAGAIN);
 341            }
 342        }
 343
 344        if (read_hello && connected) {
 345            break;
 346        }
 347
 348        vconn_run_wait(vconn);
 349        if (!connected) {
 350            vconn_connect_wait(vconn);
 351        }
 352        if (!read_hello) {
 353            stream_recv_wait(stream);
 354        }
 355        poll_block();
 356     }
 357     stream_close(stream);
 358     CHECK_ERRNO(vconn_recv_block(vconn, &msg), EOF);
 359     vconn_close(vconn);
 360 }
 361
 362 /* Try connecting and sending a normal hello, which should succeed. */
 363 static void
 364 test_send_plain_hello(int argc OVS_UNUSED, char *argv[])
 365 {
 366     const char *type = argv[1];
 367     struct ofpbuf *hello;
 368
 369     hello = ofpraw_alloc_xid(OFPRAW_OFPT_HELLO, OFP13_VERSION,
 370                              htonl(0x12345678), 0);
 371     test_send_hello(type, hello->data, hello->size, 0);
 372     ofpbuf_delete(hello);
 373 }
 374
 375 /* Try connecting and sending an extra-long hello, which should succeed (since
 376  * the specification says that implementations must accept and ignore extra
 377  * data). */
 378 static void
 379 test_send_long_hello(int argc OVS_UNUSED, char *argv[])
 380 {
 381     const char *type = argv[1];
 382     struct ofpbuf *hello;
 383     enum { EXTRA_BYTES = 8 };
 384
 385     hello = ofpraw_alloc_xid(OFPRAW_OFPT_HELLO, OFP13_VERSION,
 386                              htonl(0x12345678), EXTRA_BYTES);
 387     ofpbuf_put_zeros(hello, EXTRA_BYTES);
 388     ofpmsg_update_length(hello);
 389     test_send_hello(type, hello->data, hello->size, 0);
 390     ofpbuf_delete(hello);
 391 }
 392
 393 /* Try connecting and sending an echo request instead of a hello, which should
 394  * fail with EPROTO. */
 395 static void
 396 test_send_echo_hello(int argc OVS_UNUSED, char *argv[])
 397 {
 398     const char *type = argv[1];
 399     struct ofpbuf *echo;
 400
 401     echo = ofpraw_alloc_xid(OFPRAW_OFPT_ECHO_REQUEST, OFP13_VERSION,
 402                              htonl(0x12345678), 0);
 403     test_send_hello(type, echo->data, echo->size, EPROTO);
 404     ofpbuf_delete(echo);
 405 }
 406
 407 /* Try connecting and sending a hello packet that has its length field as 0,
 408  * which should fail with EPROTO. */
 409 static void
 410 test_send_short_hello(int argc OVS_UNUSED, char *argv[])
 411 {
 412     const char *type = argv[1];
 413     struct ofp_header hello;
 414
 415     memset(&hello, 0, sizeof hello);
 416     test_send_hello(type, &hello, sizeof hello, EPROTO);
 417 }
 418
 419 /* Try connecting and sending a hello packet that has a bad version, which
 420  * should fail with EPROTO. */
 421 static void
 422 test_send_invalid_version_hello(int argc OVS_UNUSED, char *argv[])
 423 {
 424     const char *type = argv[1];
 425     struct ofpbuf *hello;
 426
 427     hello = ofpraw_alloc_xid(OFPRAW_OFPT_HELLO, OFP13_VERSION,
 428                              htonl(0x12345678), 0);
 429     ((struct ofp_header *) hello->data)->version = 0;
 430     test_send_hello(type, hello->data, hello->size, EPROTO);
 431     ofpbuf_delete(hello);
 432 }
 433
 434 static const struct ovs_cmdl_command commands[] = {
 435     {"refuse-connection", NULL, 1, 1, test_refuse_connection},
 436     {"accept-then-close", NULL, 1, 1, test_accept_then_close},
 437     {"read-hello", NULL, 1, 1, test_read_hello},
 438     {"send-plain-hello", NULL, 1, 1, test_send_plain_hello},
 439     {"send-long-hello", NULL, 1, 1, test_send_long_hello},
 440     {"send-echo-hello", NULL, 1, 1, test_send_echo_hello},
 441     {"send-short-hello", NULL, 1, 1, test_send_short_hello},
 442     {"send-invalid-version-hello", NULL, 1, 1, test_send_invalid_version_hello},
 443     {NULL, NULL, 0, 0, NULL},
 444 };
 445
 446 static void
 447 test_vconn_main(int argc, char *argv[])
 448 {
 449     set_program_name(argv[0]);
 450     vlog_set_levels(NULL, VLF_ANY_DESTINATION, VLL_EMER);
 451     vlog_set_levels(NULL, VLF_CONSOLE, VLL_DBG);
 452     fatal_ignore_sigpipe();
 453
 454     time_alarm(10);
 455
 456     ovs_cmdl_run_command(argc - 1, argv + 1, commands);
 457 }
 458
 459 OVSTEST_REGISTER("test-vconn", test_vconn_main);