Factor out printing the list of available vconns.
[openvswitch] / lib / vconn.c
index 2fedc2ebc5f449008f6626da3c9427f3a8e65f3c..e25114321a9ca73eb23615eea464805ecb191481 100644 (file)
@@ -1,22 +1,34 @@
-/* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
+/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
+ * Junior University
+ * 
+ * We are making the OpenFlow specification and associated documentation
+ * (Software) available for public use and benefit with the expectation
+ * that others will use, modify and enhance the Software and contribute
+ * those enhancements back to the community. However, since we would
+ * like to make the Software available for broadest use, with as few
+ * restrictions as possible permission is hereby granted, free of
+ * charge, to any person obtaining a copy of this Software to deal in
+ * the Software under the copyrights without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ * 
+ * The name and trademarks of copyright holder(s) may NOT be used in
+ * advertising or publicity pertaining to the Software or any
+ * derivatives without specific, written prior permission.
  */
 
 #include "vconn.h"
 #include <string.h>
 #include "buffer.h"
 #include "flow.h"
+#include "ofp-print.h"
 #include "openflow.h"
+#include "poll-loop.h"
 #include "util.h"
 
+#define THIS_MODULE VLM_vconn
+#include "vlog.h"
+
 static struct vconn_class *vconn_classes[] = {
     &tcp_vconn_class,
     &ptcp_vconn_class,
 #ifdef HAVE_NETLINK
     &netlink_vconn_class,
 #endif
+#ifdef HAVE_OPENSSL
+    &ssl_vconn_class,
+    &pssl_vconn_class,
+#endif
 };
 
 /* Check the validity of the vconn class structures. */
 static void
-check_vconn_classes(void) 
+check_vconn_classes(void)
 {
 #ifndef NDEBUG
     size_t i;
@@ -51,11 +72,55 @@ check_vconn_classes(void)
         assert(class->name != NULL);
         assert(class->open != NULL);
         assert(class->close != NULL);
-        assert(class->prepoll != NULL);
         assert(class->accept
                ? !class->recv && !class->send
-               : class->recv && class->send);
+               :  class->recv && class->send);
+        assert(class->wait != NULL);
+    }
+#endif
+}
+
+/* Prints information on active (if 'active') and passive (if 'passive')
+ * connection methods supported by the vconn. */
+void
+vconn_usage(bool active, bool passive)
+{
+    /* Really this should be implemented via callbacks into the vconn
+     * providers, but that seems too heavy-weight to bother with at the
+     * moment. */
+    
+    printf("\n");
+    if (active) {
+        printf("Active OpenFlow connection methods:\n");
+#ifdef HAVE_NETLINK
+        printf("  nl:DP_IDX               "
+               "local datapath DP_IDX\n");
+#endif
+        printf("  tcp:HOST[:PORT]         "
+               "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
+#ifdef HAVE_OPENSSL
+        printf("  ssl:HOST[:PORT]         "
+               "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
+#endif
+    }
+
+    if (passive) {
+        printf("Passive OpenFlow connection methods:\n");
+        printf("  ptcp:[PORT]             "
+               "listen to TCP PORT (default: %d)\n",
+               OFP_TCP_PORT);
+#ifdef HAVE_OPENSSL
+        printf("  pssl:[PORT]             "
+               "listen for SSL on PORT (default: %d)\n",
+               OFP_SSL_PORT);
+#endif
     }
+
+#ifdef HAVE_OPENSSL
+    printf("PKI configuration (required to use SSL):\n"
+           "  -p, --private-key=FILE  file with private key\n"
+           "  -c, --certificate=FILE  file with certificate for private key\n"
+           "  -C, --ca-cert=FILE      file with peer CA certificate\n");
 #endif
 }
 
@@ -67,7 +132,7 @@ check_vconn_classes(void)
  * stores a pointer to the new connection in '*vconnp', otherwise a null
  * pointer.  */
 int
-vconn_open(const char *name, struct vconn **vconnp) 
+vconn_open(const char *name, struct vconn **vconnp)
 {
     size_t prefix_len;
     size_t i;
@@ -87,6 +152,9 @@ vconn_open(const char *name, struct vconn **vconnp)
             free(suffix_copy);
             if (retval) {
                 *vconnp = NULL;
+            } else {
+                assert((*vconnp)->connect_status != EAGAIN
+                       || (*vconnp)->class->connect);
             }
             return retval;
         }
@@ -95,9 +163,31 @@ vconn_open(const char *name, struct vconn **vconnp)
     abort();
 }
 
+int
+vconn_open_block(const char *name, struct vconn **vconnp)
+{
+    struct vconn *vconn;
+    int error;
+
+    error = vconn_open(name, &vconn);
+    while (error == EAGAIN) {
+        vconn_connect_wait(vconn);
+        poll_block();
+        error = vconn_connect(vconn);
+        assert(error != EINPROGRESS);
+    }
+    if (error) {
+        vconn_close(vconn);
+        *vconnp = NULL;
+    } else {
+        *vconnp = vconn;
+    }
+    return error;
+}
+
 /* Closes 'vconn'. */
 void
-vconn_close(struct vconn *vconn) 
+vconn_close(struct vconn *vconn)
 {
     if (vconn != NULL) {
         (vconn->class->close)(vconn);
@@ -109,35 +199,23 @@ vconn_close(struct vconn *vconn)
  * 'vconn' is an active vconn, that is, its purpose is to transfer data, not
  * to wait for new connections to arrive. */
 bool
-vconn_is_passive(const struct vconn *vconn) 
+vconn_is_passive(const struct vconn *vconn)
 {
     return vconn->class->accept != NULL;
 }
 
-/* Initializes 'pfd->fd' and 'pfd->events' appropriately so that poll() will
- * wake up when the connection becomes available for the operations specified
- * in 'want', or for performing the vconn's needed internal processing.  */
-void
-vconn_prepoll(struct vconn *vconn, int want, struct pollfd *pollfd)
-{
-    (vconn->class->prepoll)(vconn, want, pollfd);
-}
-
-/* Perform any internal processing needed by the connections.  The vconn file
- * descriptor's status, as reported by poll(), must be provided in '*revents'.
- *
- * The postpoll function adjusts '*revents' to reflect the status of the
- * connection from the caller's point of view.  That is, upon return '*revents
- * & POLLIN' indicates that a packet is (potentially) ready to be read (for an
- * active vconn) or a new connection is ready to be accepted (for a passive
- * vconn) and '*revents & POLLOUT' indicates that a packet is (potentially)
- * ready to be written. */
-void
-vconn_postpoll(struct vconn *vconn, short int *revents) 
+/* Tries to complete the connection on 'vconn', which must be an active
+ * vconn.  If 'vconn''s connection is complete, returns 0 if the connection
+ * was successful or a positive errno value if it failed.  If the
+ * connection is still in progress, returns EAGAIN. */
+int
+vconn_connect(struct vconn *vconn)
 {
-    if (vconn->class->postpoll) {
-        (vconn->class->postpoll)(vconn, revents);
-    } 
+    if (vconn->connect_status == EAGAIN) {
+        vconn->connect_status = (vconn->class->connect)(vconn);
+        assert(vconn->connect_status != EINPROGRESS);
+    }
+    return vconn->connect_status;
 }
 
 /* Tries to accept a new connection on 'vconn', which must be a passive vconn.
@@ -147,11 +225,17 @@ vconn_postpoll(struct vconn *vconn, short int *revents)
  * vconn_accept will not block waiting for a connection.  If no connection is
  * ready to be accepted, it returns EAGAIN immediately. */
 int
-vconn_accept(struct vconn *vconn, struct vconn **new_vconn) 
+vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
 {
-    int retval = (vconn->class->accept)(vconn, new_vconn);
+    int retval;
+
+    retval = (vconn->class->accept)(vconn, new_vconn);
+
     if (retval) {
         *new_vconn = NULL;
+    } else {
+        assert((*new_vconn)->connect_status != EAGAIN
+               || (*new_vconn)->class->connect);
     }
     return retval;
 }
@@ -165,9 +249,17 @@ vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
  * vconn_recv will not block waiting for a packet to arrive.  If no packets
  * have been received, it returns EAGAIN immediately. */
 int
-vconn_recv(struct vconn *vconn, struct buffer **msgp) 
+vconn_recv(struct vconn *vconn, struct buffer **msgp)
 {
-    int retval = (vconn->class->recv)(vconn, msgp);
+    int retval = vconn_connect(vconn);
+    if (!retval) {
+        retval = (vconn->class->recv)(vconn, msgp);
+        if (VLOG_IS_DBG_ENABLED() && !retval) {
+            char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
+            VLOG_DBG("received: %s", s);
+            free(s);
+        }
+    }
     if (retval) {
         *msgp = NULL;
     }
@@ -186,37 +278,85 @@ vconn_recv(struct vconn *vconn, struct buffer **msgp)
  * vconn_send will not block.  If 'msg' cannot be immediately accepted for
  * transmission, it returns EAGAIN immediately. */
 int
-vconn_send(struct vconn *vconn, struct buffer *msg) 
+vconn_send(struct vconn *vconn, struct buffer *msg)
 {
-    return (vconn->class->send)(vconn, msg);
+    int retval = vconn_connect(vconn);
+    if (!retval) {
+        if (!VLOG_IS_DBG_ENABLED()) { 
+            retval = (vconn->class->send)(vconn, msg);
+        } else {
+            char *s = ofp_to_string(msg->data, msg->size, 1);
+            retval = (vconn->class->send)(vconn, msg);
+            if (retval != EAGAIN) {
+                VLOG_DBG("sent (%s): %s", strerror(retval), s);
+            }
+            free(s);
+        }
+    }
+    return retval;
 }
 
 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
 int
-vconn_send_wait(struct vconn *vconn, struct buffer *msg) 
+vconn_send_block(struct vconn *vconn, struct buffer *msg)
 {
     int retval;
     while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
-        struct pollfd pfd;
-
-        pfd.fd = -1;
-        pfd.events = 0;
-        vconn_prepoll(vconn, WANT_SEND, &pfd);
-        do {
-            retval = poll(&pfd, 1, -1);
-        } while (retval < 0 && errno == EINTR);
-        if (retval < 0) {
-            return errno;
-        }
-        assert(retval == 1);
-        vconn_postpoll(vconn, &pfd.revents);
+        vconn_send_wait(vconn);
+        poll_block();
     }
     return retval;
 }
 
+void
+vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
+{
+    int connect_status;
+
+    assert(vconn_is_passive(vconn)
+           ? wait == WAIT_ACCEPT || wait == WAIT_CONNECT
+           : wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
+
+    connect_status = vconn_connect(vconn);
+    if (connect_status) {
+        if (connect_status == EAGAIN) {
+            wait = WAIT_CONNECT;
+        } else {
+            poll_immediate_wake();
+            return;
+        }
+    }
+
+    (vconn->class->wait)(vconn, wait);
+}
+
+void
+vconn_connect_wait(struct vconn *vconn)
+{
+    vconn_wait(vconn, WAIT_CONNECT);
+}
+
+void
+vconn_accept_wait(struct vconn *vconn)
+{
+    vconn_wait(vconn, WAIT_ACCEPT);
+}
+
+void
+vconn_recv_wait(struct vconn *vconn)
+{
+    vconn_wait(vconn, WAIT_RECV);
+}
+
+void
+vconn_send_wait(struct vconn *vconn)
+{
+    vconn_wait(vconn, WAIT_SEND);
+}
+
 struct buffer *
 make_add_simple_flow(const struct flow *flow,
-                     uint32_t buffer_id, uint16_t out_port) 
+                     uint32_t buffer_id, uint16_t out_port)
 {
     struct ofp_flow_mod *ofm;
     size_t size = sizeof *ofm + sizeof ofm->actions[0];