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.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 /* Check the validity of the vconn class structures. */
  69 static void
  70 check_vconn_classes(void)
  71 {
  72 #ifndef NDEBUG
  73     size_t i;
  74
  75     for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
  76         struct vconn_class *class = vconn_classes[i];
  77         assert(class->name != NULL);
  78         assert(class->open != NULL);
  79         if (class->close || class->accept || class->recv || class->send
  80             || class->wait) {
  81             assert(class->close != NULL);
  82             assert(class->accept
  83                    ? !class->recv && !class->send
  84                    :  class->recv && class->send);
  85             assert(class->wait != NULL);
  86         } else {
  87             /* This class delegates to another one. */
  88         }
  89     }
  90 #endif
  91 }
  92
  93 /* Prints information on active (if 'active') and passive (if 'passive')
  94  * connection methods supported by the vconn. */
  95 void
  96 vconn_usage(bool active, bool passive)
  97 {
  98     /* Really this should be implemented via callbacks into the vconn
  99      * providers, but that seems too heavy-weight to bother with at the
 100      * moment. */
 101
 102     printf("\n");
 103     if (active) {
 104         printf("Active OpenFlow connection methods:\n");
 105 #ifdef HAVE_NETLINK
 106         printf("  nl:DP_IDX               "
 107                "local datapath DP_IDX\n");
 108 #endif
 109         printf("  tcp:HOST[:PORT]         "
 110                "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
 111 #ifdef HAVE_OPENSSL
 112         printf("  ssl:HOST[:PORT]         "
 113                "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
 114 #endif
 115         printf("  unix:FILE               Unix domain socket named FILE\n");
 116     }
 117
 118     if (passive) {
 119         printf("Passive OpenFlow connection methods:\n");
 120         printf("  ptcp:[PORT]             "
 121                "listen to TCP PORT (default: %d)\n",
 122                OFP_TCP_PORT);
 123 #ifdef HAVE_OPENSSL
 124         printf("  pssl:[PORT]             "
 125                "listen for SSL on PORT (default: %d)\n",
 126                OFP_SSL_PORT);
 127 #endif
 128         printf("  punix:FILE              "
 129                "listen on Unix domain socket FILE\n");
 130     }
 131
 132 #ifdef HAVE_OPENSSL
 133     printf("PKI configuration (required to use SSL):\n"
 134            "  -p, --private-key=FILE  file with private key\n"
 135            "  -c, --certificate=FILE  file with certificate for private key\n"
 136            "  -C, --ca-cert=FILE      file with peer CA certificate\n");
 137 #endif
 138 }
 139
 140 /* Attempts to connect to an OpenFlow device.  'name' is a connection name in
 141  * the form "TYPE:ARGS", where TYPE is the vconn class's name and ARGS are
 142  * vconn class-specific.
 143  *
 144  * Returns 0 if successful, otherwise a positive errno value.  If successful,
 145  * stores a pointer to the new connection in '*vconnp', otherwise a null
 146  * pointer.  */
 147 int
 148 vconn_open(const char *name, struct vconn **vconnp)
 149 {
 150     size_t prefix_len;
 151     size_t i;
 152
 153     check_vconn_classes();
 154
 155     prefix_len = strcspn(name, ":");
 156     if (prefix_len == strlen(name)) {
 157         error(0, "`%s' not correct format for peer name", name);
 158         return EAFNOSUPPORT;
 159     }
 160     for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
 161         struct vconn_class *class = vconn_classes[i];
 162         if (strlen(class->name) == prefix_len
 163             && !memcmp(class->name, name, prefix_len)) {
 164             char *suffix_copy = xstrdup(name + prefix_len + 1);
 165             int retval = class->open(name, suffix_copy, vconnp);
 166             free(suffix_copy);
 167             if (retval) {
 168                 *vconnp = NULL;
 169             } else {
 170                 assert((*vconnp)->connect_status != EAGAIN
 171                        || (*vconnp)->class->connect);
 172             }
 173             return retval;
 174         }
 175     }
 176     error(0, "unknown peer type `%.*s'", (int) prefix_len, name);
 177     return EAFNOSUPPORT;
 178 }
 179
 180 int
 181 vconn_open_block(const char *name, struct vconn **vconnp)
 182 {
 183     struct vconn *vconn;
 184     int error;
 185
 186     error = vconn_open(name, &vconn);
 187     while (error == EAGAIN) {
 188         vconn_connect_wait(vconn);
 189         poll_block();
 190         error = vconn_connect(vconn);
 191         assert(error != EINPROGRESS);
 192     }
 193     if (error) {
 194         vconn_close(vconn);
 195         *vconnp = NULL;
 196     } else {
 197         *vconnp = vconn;
 198     }
 199     return error;
 200 }
 201
 202 /* Closes 'vconn'. */
 203 void
 204 vconn_close(struct vconn *vconn)
 205 {
 206     if (vconn != NULL) {
 207         (vconn->class->close)(vconn);
 208     }
 209 }
 210
 211 /* Returns true if 'vconn' is a passive vconn, that is, its purpose is to
 212  * wait for connections to arrive, not to transfer data.  Returns false if
 213  * 'vconn' is an active vconn, that is, its purpose is to transfer data, not
 214  * to wait for new connections to arrive. */
 215 bool
 216 vconn_is_passive(const struct vconn *vconn)
 217 {
 218     return vconn->class->accept != NULL;
 219 }
 220
 221 /* Returns the IP address of the peer, or 0 if the peer is not connected over
 222  * an IP-based protocol or if its IP address is not yet known. */
 223 uint32_t
 224 vconn_get_ip(const struct vconn *vconn)
 225 {
 226     return vconn->ip;
 227 }
 228
 229 /* Tries to complete the connection on 'vconn', which must be an active
 230  * vconn.  If 'vconn''s connection is complete, returns 0 if the connection
 231  * was successful or a positive errno value if it failed.  If the
 232  * connection is still in progress, returns EAGAIN. */
 233 int
 234 vconn_connect(struct vconn *vconn)
 235 {
 236     if (vconn->connect_status == EAGAIN) {
 237         vconn->connect_status = (vconn->class->connect)(vconn);
 238         assert(vconn->connect_status != EINPROGRESS);
 239     }
 240     return vconn->connect_status;
 241 }
 242
 243 /* Tries to accept a new connection on 'vconn', which must be a passive vconn.
 244  * If successful, stores the new connection in '*new_vconn' and returns 0.
 245  * Otherwise, returns a positive errno value.
 246  *
 247  * vconn_accept will not block waiting for a connection.  If no connection is
 248  * ready to be accepted, it returns EAGAIN immediately. */
 249 int
 250 vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
 251 {
 252     int retval;
 253
 254     retval = (vconn->class->accept)(vconn, new_vconn);
 255
 256     if (retval) {
 257         *new_vconn = NULL;
 258     } else {
 259         assert((*new_vconn)->connect_status != EAGAIN
 260                || (*new_vconn)->class->connect);
 261     }
 262     return retval;
 263 }
 264
 265 /* Tries to receive an OpenFlow message from 'vconn', which must be an active
 266  * vconn.  If successful, stores the received message into '*msgp' and returns
 267  * 0.  The caller is responsible for destroying the message with
 268  * buffer_delete().  On failure, returns a positive errno value and stores a
 269  * null pointer into '*msgp'.  On normal connection close, returns EOF.
 270  *
 271  * vconn_recv will not block waiting for a packet to arrive.  If no packets
 272  * have been received, it returns EAGAIN immediately. */
 273 int
 274 vconn_recv(struct vconn *vconn, struct buffer **msgp)
 275 {
 276     int retval = vconn_connect(vconn);
 277     if (!retval) {
 278         retval = (vconn->class->recv)(vconn, msgp);
 279         if (!retval) {
 280             struct ofp_header *oh;
 281
 282             if (VLOG_IS_DBG_ENABLED()) {
 283                 char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
 284                 VLOG_DBG("received: %s", s);
 285                 free(s);
 286             }
 287
 288             oh = buffer_at_assert(*msgp, 0, sizeof *oh);
 289             if (oh->version != OFP_VERSION) {
 290                 VLOG_ERR("received OpenFlow version %02"PRIx8" "
 291                          "!= expected %02x",
 292                          oh->version, OFP_VERSION);
 293                 buffer_delete(*msgp);
 294                 *msgp = NULL;
 295                 return EPROTO;
 296             }
 297         }
 298     }
 299     if (retval) {
 300         *msgp = NULL;
 301     }
 302     return retval;
 303 }
 304
 305 /* Tries to queue 'msg' for transmission on 'vconn', which must be an active
 306  * vconn.  If successful, returns 0, in which case ownership of 'msg' is
 307  * transferred to the vconn.  Success does not guarantee that 'msg' has been or
 308  * ever will be delivered to the peer, only that it has been queued for
 309  * transmission.
 310  *
 311  * Returns a positive errno value on failure, in which case the caller
 312  * retains ownership of 'msg'.
 313  *
 314  * vconn_send will not block.  If 'msg' cannot be immediately accepted for
 315  * transmission, it returns EAGAIN immediately. */
 316 int
 317 vconn_send(struct vconn *vconn, struct buffer *msg)
 318 {
 319     int retval = vconn_connect(vconn);
 320     if (!retval) {
 321         assert(msg->size >= sizeof(struct ofp_header));
 322         assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
 323         if (!VLOG_IS_DBG_ENABLED()) {
 324             retval = (vconn->class->send)(vconn, msg);
 325         } else {
 326             char *s = ofp_to_string(msg->data, msg->size, 1);
 327             retval = (vconn->class->send)(vconn, msg);
 328             if (retval != EAGAIN) {
 329                 VLOG_DBG("sent (%s): %s", strerror(retval), s);
 330             }
 331             free(s);
 332         }
 333     }
 334     return retval;
 335 }
 336
 337 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
 338 int
 339 vconn_send_block(struct vconn *vconn, struct buffer *msg)
 340 {
 341     int retval;
 342     while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
 343         vconn_send_wait(vconn);
 344         VLOG_DBG("blocking on vconn send");
 345         poll_block();
 346     }
 347     return retval;
 348 }
 349
 350 /* Same as vconn_recv, except that it waits until a message is received. */
 351 int
 352 vconn_recv_block(struct vconn *vconn, struct buffer **msgp)
 353 {
 354     int retval;
 355     while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
 356         vconn_recv_wait(vconn);
 357         VLOG_DBG("blocking on vconn receive");
 358         poll_block();
 359     }
 360     return retval;
 361 }
 362
 363 /* Sends 'request' to 'vconn' and blocks until it receives a reply with a
 364  * matching transaction ID.  Returns 0 if successful, in which case the reply
 365  * is stored in '*replyp' for the caller to examine and free.  Otherwise
 366  * returns a positive errno value, or EOF, and sets '*replyp' to null.
 367  *
 368  * 'request' is always destroyed, regardless of the return value. */
 369 int
 370 vconn_transact(struct vconn *vconn, struct buffer *request,
 371                struct buffer **replyp)
 372 {
 373     uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
 374     int error;
 375
 376     *replyp = NULL;
 377     error = vconn_send_block(vconn, request);
 378     if (error) {
 379         buffer_delete(request);
 380         return error;
 381     }
 382     for (;;) {
 383         uint32_t recv_xid;
 384         struct buffer *reply;
 385
 386         error = vconn_recv_block(vconn, &reply);
 387         if (error) {
 388             return error;
 389         }
 390         recv_xid = ((struct ofp_header *) reply->data)->xid;
 391         if (send_xid == recv_xid) {
 392             *replyp = reply;
 393             return 0;
 394         }
 395
 396         VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
 397                  recv_xid, send_xid);
 398         buffer_delete(reply);
 399     }
 400 }
 401
 402 void
 403 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
 404 {
 405     int connect_status;
 406
 407     assert(vconn_is_passive(vconn)
 408            ? wait == WAIT_ACCEPT || wait == WAIT_CONNECT
 409            : wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
 410
 411     connect_status = vconn_connect(vconn);
 412     if (connect_status) {
 413         if (connect_status == EAGAIN) {
 414             wait = WAIT_CONNECT;
 415         } else {
 416             poll_immediate_wake();
 417             return;
 418         }
 419     }
 420
 421     (vconn->class->wait)(vconn, wait);
 422 }
 423
 424 void
 425 vconn_connect_wait(struct vconn *vconn)
 426 {
 427     vconn_wait(vconn, WAIT_CONNECT);
 428 }
 429
 430 void
 431 vconn_accept_wait(struct vconn *vconn)
 432 {
 433     vconn_wait(vconn, WAIT_ACCEPT);
 434 }
 435
 436 void
 437 vconn_recv_wait(struct vconn *vconn)
 438 {
 439     vconn_wait(vconn, WAIT_RECV);
 440 }
 441
 442 void
 443 vconn_send_wait(struct vconn *vconn)
 444 {
 445     vconn_wait(vconn, WAIT_SEND);
 446 }
 447
 448 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
 449  * containing an OpenFlow header with the given 'type' and a random transaction
 450  * id.  Stores the new buffer in '*bufferp'.  The caller must free the buffer
 451  * when it is no longer needed. */
 452 void *
 453 make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp)
 454 {
 455     return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
 456 }
 457
 458 /* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
 459  * containing an OpenFlow header with the given 'type' and transaction id
 460  * 'xid'.  Stores the new buffer in '*bufferp'.  The caller must free the
 461  * buffer when it is no longer needed. */
 462 void *
 463 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
 464                   struct buffer **bufferp)
 465 {
 466     struct buffer *buffer;
 467     struct ofp_header *oh;
 468
 469     assert(openflow_len >= sizeof *oh);
 470     assert(openflow_len <= UINT16_MAX);
 471     buffer = *bufferp = buffer_new(openflow_len);
 472     oh = buffer_put_uninit(buffer, openflow_len);
 473     memset(oh, 0, openflow_len);
 474     oh->version = OFP_VERSION;
 475     oh->type = type;
 476     oh->length = htons(openflow_len);
 477     oh->xid = xid;
 478     return oh;
 479 }
 480
 481 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
 482  * 'buffer->size'. */
 483 void
 484 update_openflow_length(struct buffer *buffer)
 485 {
 486     struct ofp_header *oh = buffer_at_assert(buffer, 0, sizeof *oh);
 487     oh->length = htons(buffer->size);
 488 }
 489
 490 struct buffer *
 491 make_add_flow(const struct flow *flow, uint32_t buffer_id, uint16_t max_idle,
 492               size_t n_actions)
 493 {
 494     struct ofp_flow_mod *ofm;
 495     size_t size = sizeof *ofm + n_actions * sizeof ofm->actions[0];
 496     struct buffer *out = buffer_new(size);
 497     ofm = buffer_put_uninit(out, size);
 498     memset(ofm, 0, size);
 499     ofm->header.version = OFP_VERSION;
 500     ofm->header.type = OFPT_FLOW_MOD;
 501     ofm->header.length = htons(size);
 502     ofm->match.wildcards = htons(0);
 503     ofm->match.in_port = flow->in_port;
 504     memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
 505     memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
 506     ofm->match.dl_vlan = flow->dl_vlan;
 507     ofm->match.dl_type = flow->dl_type;
 508     ofm->match.nw_src = flow->nw_src;
 509     ofm->match.nw_dst = flow->nw_dst;
 510     ofm->match.nw_proto = flow->nw_proto;
 511     ofm->match.tp_src = flow->tp_src;
 512     ofm->match.tp_dst = flow->tp_dst;
 513     ofm->command = htons(OFPFC_ADD);
 514     ofm->max_idle = htons(max_idle);
 515     ofm->buffer_id = htonl(buffer_id);
 516     return out;
 517 }
 518
 519 struct buffer *
 520 make_add_simple_flow(const struct flow *flow,
 521                      uint32_t buffer_id, uint16_t out_port, uint16_t max_idle)
 522 {
 523     struct buffer *buffer = make_add_flow(flow, buffer_id, max_idle, 1);
 524     struct ofp_flow_mod *ofm = buffer->data;
 525     ofm->actions[0].type = htons(OFPAT_OUTPUT);
 526     ofm->actions[0].arg.output.max_len = htons(0);
 527     ofm->actions[0].arg.output.port = htons(out_port);
 528     return buffer;
 529 }
 530
 531 struct buffer *
 532 make_unbuffered_packet_out(const struct buffer *packet,
 533                            uint16_t in_port, uint16_t out_port)
 534 {
 535     struct ofp_packet_out *opo;
 536     size_t size = sizeof *opo + packet->size;
 537     struct buffer *out = buffer_new(size);
 538     opo = buffer_put_uninit(out, size);
 539     memset(opo, 0, sizeof *opo);
 540     opo->header.version = OFP_VERSION;
 541     opo->header.type = OFPT_PACKET_OUT;
 542     opo->header.length = htons(size);
 543     opo->buffer_id = htonl(UINT32_MAX);
 544     opo->in_port = htons(in_port);
 545     opo->out_port = htons(out_port);
 546     memcpy(opo->u.data, packet->data, packet->size);
 547     return out;
 548 }
 549
 550 struct buffer *
 551 make_buffered_packet_out(uint32_t buffer_id,
 552                          uint16_t in_port, uint16_t out_port)
 553 {
 554     struct ofp_packet_out *opo;
 555     size_t size = sizeof *opo + sizeof opo->u.actions[0];
 556     struct buffer *out = buffer_new(size);
 557     opo = buffer_put_uninit(out, size);
 558     memset(opo, 0, size);
 559     opo->header.version = OFP_VERSION;
 560     opo->header.type = OFPT_PACKET_OUT;
 561     opo->header.length = htons(size);
 562     opo->buffer_id = htonl(buffer_id);
 563     opo->in_port = htons(in_port);
 564     opo->out_port = htons(out_port);
 565     opo->u.actions[0].type = htons(OFPAT_OUTPUT);
 566     opo->u.actions[0].arg.output.max_len = htons(0);
 567     opo->u.actions[0].arg.output.port = htons(out_port);
 568     return out;
 569 }
 570
 571 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
 572 struct buffer *
 573 make_echo_request(void)
 574 {
 575     struct ofp_header *rq;
 576     struct buffer *out = buffer_new(sizeof *rq);
 577     rq = buffer_put_uninit(out, sizeof *rq);
 578     rq->version = OFP_VERSION;
 579     rq->type = OFPT_ECHO_REQUEST;
 580     rq->length = htons(sizeof *rq);
 581     rq->xid = 0;
 582     return out;
 583 }
 584
 585 /* Creates and returns an OFPT_ECHO_REPLY message matching the
 586  * OFPT_ECHO_REQUEST message in 'rq'. */
 587 struct buffer *
 588 make_echo_reply(const struct ofp_header *rq)
 589 {
 590     size_t size = ntohs(rq->length);
 591     struct buffer *out = buffer_new(size);
 592     struct ofp_header *reply = buffer_put(out, rq, size);
 593     reply->type = OFPT_ECHO_REPLY;
 594     return out;
 595 }