tests/test-vconn.c

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