lib/vconn.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <config.h>
  35 #include "vconn-provider.h"
  36 #include <assert.h>
  37 #include <errno.h>
  38 #include <inttypes.h>
  39 #include <netinet/in.h>
  40 #include <poll.h>
  41 #include <stdlib.h>
  42 #include <string.h>
  43 #include "buffer.h"
  44 #include "flow.h"
  45 #include "ofp-print.h"
  46 #include "openflow.h"
  47 #include "poll-loop.h"
  48 #include "random.h"
  49 #include "util.h"
  50
  51 #define THIS_MODULE VLM_vconn
  52 #include "vlog.h"
  53
  54 static struct vconn_class *vconn_classes[] = {
  55     &tcp_vconn_class,
  56     &ptcp_vconn_class,
  57 #ifdef HAVE_NETLINK
  58     &netlink_vconn_class,
  59 #endif
  60 #ifdef HAVE_OPENSSL
  61     &ssl_vconn_class,
  62     &pssl_vconn_class,
  63 #endif
  64     &unix_vconn_class,
  65     &punix_vconn_class,
  66 };
  67
  68 /* High rate limit because most of the rate-limiting here is individual
  69  * OpenFlow messages going over the vconn.  If those are enabled then we
  70  * really need to see them. */
  71 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(600, 600);
  72
  73 /* Check the validity of the vconn class structures. */
  74 static void
  75 check_vconn_classes(void)
  76 {
  77 #ifndef NDEBUG
  78     size_t i;
  79
  80     for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
  81         struct vconn_class *class = vconn_classes[i];
  82         assert(class->name != NULL);
  83         assert(class->open != NULL);
  84         if (class->close || class->accept || class->recv || class->send
  85             || class->wait) {
  86             assert(class->close != NULL);
  87             assert(class->accept
  88                    ? !class->recv && !class->send
  89                    :  class->recv && class->send);
  90             assert(class->wait != NULL);
  91         } else {
  92             /* This class delegates to another one. */
  93         }
  94     }
  95 #endif
  96 }
  97
  98 /* Prints information on active (if 'active') and passive (if 'passive')
  99  * connection methods supported by the vconn. */
 100 void
 101 vconn_usage(bool active, bool passive)
 102 {
 103     /* Really this should be implemented via callbacks into the vconn
 104      * providers, but that seems too heavy-weight to bother with at the
 105      * moment. */
 106
 107     printf("\n");
 108     if (active) {
 109         printf("Active OpenFlow connection methods:\n");
 110 #ifdef HAVE_NETLINK
 111         printf("  nl:DP_IDX               "
 112                "local datapath DP_IDX\n");
 113 #endif
 114         printf("  tcp:HOST[:PORT]         "
 115                "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
 116 #ifdef HAVE_OPENSSL
 117         printf("  ssl:HOST[:PORT]         "
 118                "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
 119 #endif
 120         printf("  unix:FILE               Unix domain socket named FILE\n");
 121     }
 122
 123     if (passive) {
 124         printf("Passive OpenFlow connection methods:\n");
 125         printf("  ptcp:[PORT]             "
 126                "listen to TCP PORT (default: %d)\n",
 127                OFP_TCP_PORT);
 128 #ifdef HAVE_OPENSSL
 129         printf("  pssl:[PORT]             "
 130                "listen for SSL on PORT (default: %d)\n",
 131                OFP_SSL_PORT);
 132 #endif
 133         printf("  punix:FILE              "
 134                "listen on Unix domain socket FILE\n");
 135     }
 136
 137 #ifdef HAVE_OPENSSL
 138     printf("PKI configuration (required to use SSL):\n"
 139            "  -p, --private-key=FILE  file with private key\n"
 140            "  -c, --certificate=FILE  file with certificate for private key\n"
 141            "  -C, --ca-cert=FILE      file with peer CA certificate\n");
 142 #endif
 143 }
 144
 145 /* Attempts to connect to an OpenFlow device.  'name' is a connection name in
 146  * the form "TYPE:ARGS", where TYPE is the vconn class's name and ARGS are
 147  * vconn class-specific.
 148  *
 149  * Returns 0 if successful, otherwise a positive errno value.  If successful,
 150  * stores a pointer to the new connection in '*vconnp', otherwise a null
 151  * pointer.  */
 152 int
 153 vconn_open(const char *name, struct vconn **vconnp)
 154 {
 155     size_t prefix_len;
 156     size_t i;
 157
 158     check_vconn_classes();
 159
 160     *vconnp = NULL;
 161     prefix_len = strcspn(name, ":");
 162     if (prefix_len == strlen(name)) {
 163         error(0, "`%s' not correct format for peer name", name);
 164         return EAFNOSUPPORT;
 165     }
 166     for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
 167         struct vconn_class *class = vconn_classes[i];
 168         if (strlen(class->name) == prefix_len
 169             && !memcmp(class->name, name, prefix_len)) {
 170             struct vconn *vconn;
 171             char *suffix_copy = xstrdup(name + prefix_len + 1);
 172             int retval = class->open(name, suffix_copy, &vconn);
 173             free(suffix_copy);
 174             if (!retval) {
 175                 assert(vconn->connect_status != EAGAIN
 176                        || vconn->class->connect);
 177                 vconn->name = xstrdup(name);
 178                 *vconnp = vconn;
 179             }
 180             return retval;
 181         }
 182     }
 183     error(0, "unknown peer type `%.*s'", (int) prefix_len, name);
 184     return EAFNOSUPPORT;
 185 }
 186
 187 int
 188 vconn_open_block(const char *name, struct vconn **vconnp)
 189 {
 190     struct vconn *vconn;
 191     int error;
 192
 193     error = vconn_open(name, &vconn);
 194     while (error == EAGAIN) {
 195         vconn_connect_wait(vconn);
 196         poll_block();
 197         error = vconn_connect(vconn);
 198         assert(error != EINPROGRESS);
 199     }
 200     if (error) {
 201         vconn_close(vconn);
 202         *vconnp = NULL;
 203     } else {
 204         *vconnp = vconn;
 205     }
 206     return error;
 207 }
 208
 209 /* Closes 'vconn'. */
 210 void
 211 vconn_close(struct vconn *vconn)
 212 {
 213     if (vconn != NULL) {
 214         char *name = vconn->name;
 215         (vconn->class->close)(vconn);
 216         free(name);
 217     }
 218 }
 219
 220 /* Returns the name of 'vconn', that is, the string passed to vconn_open(). */
 221 const char *
 222 vconn_get_name(const struct vconn *vconn)
 223 {
 224     return vconn->name;
 225 }
 226
 227 /* Returns true if 'vconn' is a passive vconn, that is, its purpose is to
 228  * wait for connections to arrive, not to transfer data.  Returns false if
 229  * 'vconn' is an active vconn, that is, its purpose is to transfer data, not
 230  * to wait for new connections to arrive. */
 231 bool
 232 vconn_is_passive(const struct vconn *vconn)
 233 {
 234     return vconn->class->accept != NULL;
 235 }
 236
 237 /* Returns the IP address of the peer, or 0 if the peer is not connected over
 238  * an IP-based protocol or if its IP address is not yet known. */
 239 uint32_t
 240 vconn_get_ip(const struct vconn *vconn)
 241 {
 242     return vconn->ip;
 243 }
 244
 245 /* Tries to complete the connection on 'vconn', which must be an active
 246  * vconn.  If 'vconn''s connection is complete, returns 0 if the connection
 247  * was successful or a positive errno value if it failed.  If the
 248  * connection is still in progress, returns EAGAIN. */
 249 int
 250 vconn_connect(struct vconn *vconn)
 251 {
 252     if (vconn->connect_status == EAGAIN) {
 253         vconn->connect_status = (vconn->class->connect)(vconn);
 254         assert(vconn->connect_status != EINPROGRESS);
 255     }
 256     return vconn->connect_status;
 257 }
 258
 259 /* Tries to accept a new connection on 'vconn', which must be a passive vconn.
 260  * If successful, stores the new connection in '*new_vconn' and returns 0.
 261  * Otherwise, returns a positive errno value.
 262  *
 263  * vconn_accept will not block waiting for a connection.  If no connection is
 264  * ready to be accepted, it returns EAGAIN immediately. */
 265 int
 266 vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
 267 {
 268     int retval;
 269
 270     retval = (vconn->class->accept)(vconn, new_vconn);
 271
 272     if (retval) {
 273         *new_vconn = NULL;
 274     } else {
 275         assert((*new_vconn)->connect_status != EAGAIN
 276                || (*new_vconn)->class->connect);
 277     }
 278     return retval;
 279 }
 280
 281 /* Tries to receive an OpenFlow message from 'vconn', which must be an active
 282  * vconn.  If successful, stores the received message into '*msgp' and returns
 283  * 0.  The caller is responsible for destroying the message with
 284  * buffer_delete().  On failure, returns a positive errno value and stores a
 285  * null pointer into '*msgp'.  On normal connection close, returns EOF.
 286  *
 287  * vconn_recv will not block waiting for a packet to arrive.  If no packets
 288  * have been received, it returns EAGAIN immediately. */
 289 int
 290 vconn_recv(struct vconn *vconn, struct buffer **msgp)
 291 {
 292     int retval = vconn_connect(vconn);
 293     if (!retval) {
 294         retval = (vconn->class->recv)(vconn, msgp);
 295         if (!retval) {
 296             struct ofp_header *oh;
 297
 298             if (VLOG_IS_DBG_ENABLED()) {
 299                 char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
 300                 VLOG_DBG_RL(&rl, "%s: received: %s", vconn->name, s);
 301                 free(s);
 302             }
 303
 304             oh = buffer_at_assert(*msgp, 0, sizeof *oh);
 305             if (oh->version != OFP_VERSION) {
 306                 VLOG_ERR_RL(&rl, "%s: received OpenFlow version %02"PRIx8" "
 307                             "!= expected %02x",
 308                             vconn->name, oh->version, OFP_VERSION);
 309                 buffer_delete(*msgp);
 310                 *msgp = NULL;
 311                 return EPROTO;
 312             }
 313         }
 314     }
 315     if (retval) {
 316         *msgp = NULL;
 317     }
 318     return retval;
 319 }
 320
 321 /* Tries to queue 'msg' for transmission on 'vconn', which must be an active
 322  * vconn.  If successful, returns 0, in which case ownership of 'msg' is
 323  * transferred to the vconn.  Success does not guarantee that 'msg' has been or
 324  * ever will be delivered to the peer, only that it has been queued for
 325  * transmission.
 326  *
 327  * Returns a positive errno value on failure, in which case the caller
 328  * retains ownership of 'msg'.
 329  *
 330  * vconn_send will not block.  If 'msg' cannot be immediately accepted for
 331  * transmission, it returns EAGAIN immediately. */
 332 int
 333 vconn_send(struct vconn *vconn, struct buffer *msg)
 334 {
 335     int retval = vconn_connect(vconn);
 336     if (!retval) {
 337         assert(msg->size >= sizeof(struct ofp_header));
 338         assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
 339         if (!VLOG_IS_DBG_ENABLED()) {
 340             retval = (vconn->class->send)(vconn, msg);
 341         } else {
 342             char *s = ofp_to_string(msg->data, msg->size, 1);
 343             retval = (vconn->class->send)(vconn, msg);
 344             if (retval != EAGAIN) {
 345                 VLOG_DBG_RL(&rl, "%s: sent (%s): %s", vconn->name, strerror(retval), s);
 346             }
 347             free(s);
 348         }
 349     }
 350     return retval;
 351 }
 352
 353 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
 354 int
 355 vconn_send_block(struct vconn *vconn, struct buffer *msg)
 356 {
 357     int retval;
 358     while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
 359         vconn_send_wait(vconn);
 360         poll_block();
 361     }
 362     return retval;
 363 }
 364
 365 /* Same as vconn_recv, except that it waits until a message is received. */
 366 int
 367 vconn_recv_block(struct vconn *vconn, struct buffer **msgp)
 368 {
 369     int retval;
 370     while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
 371         vconn_recv_wait(vconn);
 372         poll_block();
 373     }
 374     return retval;
 375 }
 376
 377 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
 378  * matching transaction ID.  Returns 0 if successful, in which case the reply
 379  * is stored in '*replyp' for the caller to examine and free.  Otherwise
 380  * returns a positive errno value, or EOF, and sets '*replyp' to null.
 381  *
 382  * 'request' is always destroyed, regardless of the return value. */
 383 int
 384 vconn_transact(struct vconn *vconn, struct buffer *request,
 385                struct buffer **replyp)
 386 {
 387     uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
 388     int error;
 389
 390     *replyp = NULL;
 391     error = vconn_send_block(vconn, request);
 392     if (error) {
 393         buffer_delete(request);
 394         return error;
 395     }
 396     for (;;) {
 397         uint32_t recv_xid;
 398         struct buffer *reply;
 399
 400         error = vconn_recv_block(vconn, &reply);
 401         if (error) {
 402             return error;
 403         }
 404         recv_xid = ((struct ofp_header *) reply->data)->xid;
 405         if (send_xid == recv_xid) {
 406             *replyp = reply;
 407             return 0;
 408         }
 409
 410         VLOG_DBG_RL(&rl, "%s: received reply with xid %08"PRIx32" != expected "
 411                     "%08"PRIx32, vconn->name, recv_xid, send_xid);
 412         buffer_delete(reply);
 413     }
 414 }
 415
 416 void
 417 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
 418 {
 419     int connect_status;
 420
 421     assert(vconn_is_passive(vconn)
 422            ? wait == WAIT_ACCEPT || wait == WAIT_CONNECT
 423            : wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
 424
 425     connect_status = vconn_connect(vconn);
 426     if (connect_status) {
 427         if (connect_status == EAGAIN) {
 428             wait = WAIT_CONNECT;
 429         } else {
 430             poll_immediate_wake();
 431             return;
 432         }
 433     }
 434
 435     (vconn->class->wait)(vconn, wait);
 436 }
 437
 438 void
 439 vconn_connect_wait(struct vconn *vconn)
 440 {
 441     vconn_wait(vconn, WAIT_CONNECT);
 442 }
 443
 444 void
 445 vconn_accept_wait(struct vconn *vconn)
 446 {
 447     vconn_wait(vconn, WAIT_ACCEPT);
 448 }
 449
 450 void
 451 vconn_recv_wait(struct vconn *vconn)
 452 {
 453     vconn_wait(vconn, WAIT_RECV);
 454 }
 455
 456 void
 457 vconn_send_wait(struct vconn *vconn)
 458 {
 459     vconn_wait(vconn, WAIT_SEND);
 460 }
 461
 462 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
 463  * containing an OpenFlow header with the given 'type' and a random transaction
 464  * id.  Stores the new buffer in '*bufferp'.  The caller must free the buffer
 465  * when it is no longer needed. */
 466 void *
 467 make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp)
 468 {
 469     return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
 470 }
 471
 472 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
 473  * containing an OpenFlow header with the given 'type' and transaction id
 474  * 'xid'.  Stores the new buffer in '*bufferp'.  The caller must free the
 475  * buffer when it is no longer needed. */
 476 void *
 477 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
 478                   struct buffer **bufferp)
 479 {
 480     struct buffer *buffer;
 481     struct ofp_header *oh;
 482
 483     assert(openflow_len >= sizeof *oh);
 484     assert(openflow_len <= UINT16_MAX);
 485     buffer = *bufferp = buffer_new(openflow_len);
 486     oh = buffer_put_uninit(buffer, openflow_len);
 487     memset(oh, 0, openflow_len);
 488     oh->version = OFP_VERSION;
 489     oh->type = type;
 490     oh->length = htons(openflow_len);
 491     oh->xid = xid;
 492     return oh;
 493 }
 494
 495 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
 496  * 'buffer->size'. */
 497 void
 498 update_openflow_length(struct buffer *buffer)
 499 {
 500     struct ofp_header *oh = buffer_at_assert(buffer, 0, sizeof *oh);
 501     oh->length = htons(buffer->size);
 502 }
 503
 504 struct buffer *
 505 make_add_flow(const struct flow *flow, uint32_t buffer_id,
 506               uint16_t idle_timeout, size_t n_actions)
 507 {
 508     struct ofp_flow_mod *ofm;
 509     size_t size = sizeof *ofm + n_actions * sizeof ofm->actions[0];
 510     struct buffer *out = buffer_new(size);
 511     ofm = buffer_put_uninit(out, size);
 512     memset(ofm, 0, size);
 513     ofm->header.version = OFP_VERSION;
 514     ofm->header.type = OFPT_FLOW_MOD;
 515     ofm->header.length = htons(size);
 516     ofm->match.wildcards = htonl(0);
 517     ofm->match.in_port = flow->in_port;
 518     memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
 519     memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
 520     ofm->match.dl_vlan = flow->dl_vlan;
 521     ofm->match.dl_type = flow->dl_type;
 522     ofm->match.nw_src = flow->nw_src;
 523     ofm->match.nw_dst = flow->nw_dst;
 524     ofm->match.nw_proto = flow->nw_proto;
 525     ofm->match.tp_src = flow->tp_src;
 526     ofm->match.tp_dst = flow->tp_dst;
 527     ofm->command = htons(OFPFC_ADD);
 528     ofm->idle_timeout = htons(idle_timeout);
 529     ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
 530     ofm->buffer_id = htonl(buffer_id);
 531     return out;
 532 }
 533
 534 struct buffer *
 535 make_add_simple_flow(const struct flow *flow,
 536                      uint32_t buffer_id, uint16_t out_port,
 537                      uint16_t idle_timeout)
 538 {
 539     struct buffer *buffer = make_add_flow(flow, buffer_id, idle_timeout, 1);
 540     struct ofp_flow_mod *ofm = buffer->data;
 541     ofm->actions[0].type = htons(OFPAT_OUTPUT);
 542     ofm->actions[0].arg.output.max_len = htons(0);
 543     ofm->actions[0].arg.output.port = htons(out_port);
 544     return buffer;
 545 }
 546
 547 struct buffer *
 548 make_unbuffered_packet_out(const struct buffer *packet,
 549                            uint16_t in_port, uint16_t out_port)
 550 {
 551     struct ofp_packet_out *opo;
 552     size_t size = sizeof *opo + sizeof opo->actions[0];
 553     struct buffer *out = buffer_new(size + packet->size);
 554     opo = buffer_put_uninit(out, size);
 555     memset(opo, 0, size);
 556     opo->header.version = OFP_VERSION;
 557     opo->header.type = OFPT_PACKET_OUT;
 558     opo->buffer_id = htonl(UINT32_MAX);
 559     opo->in_port = htons(in_port);
 560     opo->n_actions = htons(1);
 561     opo->actions[0].type = htons(OFPAT_OUTPUT);
 562     opo->actions[0].arg.output.max_len = htons(0);
 563     opo->actions[0].arg.output.port = htons(out_port);
 564     buffer_put(out, packet->data, packet->size);
 565     update_openflow_length(out);
 566     return out;
 567 }
 568
 569 struct buffer *
 570 make_buffered_packet_out(uint32_t buffer_id,
 571                          uint16_t in_port, uint16_t out_port)
 572 {
 573     struct ofp_packet_out *opo;
 574     size_t size = sizeof *opo + sizeof opo->actions[0];
 575     struct buffer *out = buffer_new(size);
 576     opo = buffer_put_uninit(out, size);
 577     memset(opo, 0, size);
 578     opo->header.version = OFP_VERSION;
 579     opo->header.type = OFPT_PACKET_OUT;
 580     opo->header.length = htons(size);
 581     opo->buffer_id = htonl(buffer_id);
 582     opo->in_port = htons(in_port);
 583     opo->n_actions = htons(1);
 584     opo->actions[0].type = htons(OFPAT_OUTPUT);
 585     opo->actions[0].arg.output.max_len = htons(0);
 586     opo->actions[0].arg.output.port = htons(out_port);
 587     return out;
 588 }
 589
 590 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
 591 struct buffer *
 592 make_echo_request(void)
 593 {
 594     struct ofp_header *rq;
 595     struct buffer *out = buffer_new(sizeof *rq);
 596     rq = buffer_put_uninit(out, sizeof *rq);
 597     rq->version = OFP_VERSION;
 598     rq->type = OFPT_ECHO_REQUEST;
 599     rq->length = htons(sizeof *rq);
 600     rq->xid = 0;
 601     return out;
 602 }
 603
 604 /* Creates and returns an OFPT_ECHO_REPLY message matching the
 605  * OFPT_ECHO_REQUEST message in 'rq'. */
 606 struct buffer *
 607 make_echo_reply(const struct ofp_header *rq)
 608 {
 609     size_t size = ntohs(rq->length);
 610     struct buffer *out = buffer_new(size);
 611     struct ofp_header *reply = buffer_put(out, rq, size);
 612     reply->type = OFPT_ECHO_REPLY;
 613     return out;
 614 }
 615
 616 void
 617 vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
 618            uint32_t ip, const char *name)
 619 {
 620     vconn->class = class;
 621     vconn->connect_status = connect_status;
 622     vconn->ip = ip;
 623     vconn->name = xstrdup(name);
 624 }
 625