X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=lib%2Fstream.c;h=271f16b93b650f664e4925f342d764d391a2c710;hb=e0edde6fee279cdbbf3c179f5f50adaf0c7c7f1e;hp=db6ec61bb443aaebf212a4118f7d3224f908e9a0;hpb=02dd3123a0e312f1d33403e744af52dd6096f12d;p=sliver-openvswitch.git

diff --git a/lib/stream.c b/lib/stream.c
index db6ec61bb..271f16b93 100644
--- a/lib/stream.c
+++ b/lib/stream.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,7 @@
 #include <string.h>
 #include "coverage.h"
 #include "dynamic-string.h"
+#include "fatal-signal.h"
 #include "flow.h"
 #include "ofp-print.h"
 #include "ofpbuf.h"
@@ -34,10 +35,13 @@
 #include "poll-loop.h"
 #include "random.h"
 #include "util.h"
-
-#define THIS_MODULE VLM_stream
 #include "vlog.h"
 
+VLOG_DEFINE_THIS_MODULE(stream);
+
+COVERAGE_DEFINE(pstream_open);
+COVERAGE_DEFINE(stream_open);
+
 /* State of an active stream.*/
 enum stream_state {
     SCS_CONNECTING,             /* Underlying stream is not connected. */
@@ -45,7 +49,7 @@ enum stream_state {
     SCS_DISCONNECTED            /* Connection failed or connection closed. */
 };
 
-static struct stream_class *stream_classes[] = {
+static const struct stream_class *stream_classes[] = {
     &tcp_stream_class,
     &unix_stream_class,
 #ifdef HAVE_OPENSSL
@@ -53,7 +57,7 @@ static struct stream_class *stream_classes[] = {
 #endif
 };
 
-static struct pstream_class *pstream_classes[] = {
+static const struct pstream_class *pstream_classes[] = {
     &ptcp_pstream_class,
     &punix_pstream_class,
 #ifdef HAVE_OPENSSL
@@ -69,7 +73,7 @@ check_stream_classes(void)
     size_t i;
 
     for (i = 0; i < ARRAY_SIZE(stream_classes); i++) {
-        struct stream_class *class = stream_classes[i];
+        const struct stream_class *class = stream_classes[i];
         assert(class->name != NULL);
         assert(class->open != NULL);
         if (class->close || class->recv || class->send || class->run
@@ -84,7 +88,7 @@ check_stream_classes(void)
     }
 
     for (i = 0; i < ARRAY_SIZE(pstream_classes); i++) {
-        struct pstream_class *class = pstream_classes[i];
+        const struct pstream_class *class = pstream_classes[i];
         assert(class->name != NULL);
         assert(class->listen != NULL);
         if (class->close || class->accept || class->wait) {
@@ -145,61 +149,110 @@ stream_usage(const char *name, bool active, bool passive,
 #endif
 }
 
-/* Attempts to connect a stream to a remote peer.  'name' is a connection name
- * in the form "TYPE:ARGS", where TYPE is an active stream class's name and
- * ARGS are stream class-specific.
- *
- * Returns 0 if successful, otherwise a positive errno value.  If successful,
- * stores a pointer to the new connection in '*streamp', otherwise a null
- * pointer.  */
-int
-stream_open(const char *name, struct stream **streamp)
+/* Given 'name', a stream name in the form "TYPE:ARGS", stores the class
+ * named "TYPE" into '*classp' and returns 0.  Returns EAFNOSUPPORT and stores
+ * a null pointer into '*classp' if 'name' is in the wrong form or if no such
+ * class exists. */
+static int
+stream_lookup_class(const char *name, const struct stream_class **classp)
 {
     size_t prefix_len;
     size_t i;
 
-    COVERAGE_INC(stream_open);
     check_stream_classes();
 
-    *streamp = NULL;
+    *classp = NULL;
     prefix_len = strcspn(name, ":");
-    if (prefix_len == strlen(name)) {
+    if (name[prefix_len] == '\0') {
         return EAFNOSUPPORT;
     }
     for (i = 0; i < ARRAY_SIZE(stream_classes); i++) {
-        struct stream_class *class = stream_classes[i];
+        const struct stream_class *class = stream_classes[i];
         if (strlen(class->name) == prefix_len
             && !memcmp(class->name, name, prefix_len)) {
-            struct stream *stream;
-            char *suffix_copy = xstrdup(name + prefix_len + 1);
-            int retval = class->open(name, suffix_copy, &stream);
-            free(suffix_copy);
-            if (!retval) {
-                assert(stream->state != SCS_CONNECTING
-                       || stream->class->connect);
-                *streamp = stream;
-            }
-            return retval;
+            *classp = class;
+            return 0;
         }
     }
     return EAFNOSUPPORT;
 }
 
+/* Returns 0 if 'name' is a stream name in the form "TYPE:ARGS" and TYPE is
+ * a supported stream type, otherwise EAFNOSUPPORT.  */
+int
+stream_verify_name(const char *name)
+{
+    const struct stream_class *class;
+    return stream_lookup_class(name, &class);
+}
+
+/* Attempts to connect a stream to a remote peer.  'name' is a connection name
+ * in the form "TYPE:ARGS", where TYPE is an active stream class's name and
+ * ARGS are stream class-specific.
+ *
+ * Returns 0 if successful, otherwise a positive errno value.  If successful,
+ * stores a pointer to the new connection in '*streamp', otherwise a null
+ * pointer.  */
 int
-stream_open_block(const char *name, struct stream **streamp)
+stream_open(const char *name, struct stream **streamp, uint8_t dscp)
 {
+    const struct stream_class *class;
     struct stream *stream;
+    char *suffix_copy;
     int error;
 
-    error = stream_open(name, &stream);
-    while (error == EAGAIN) {
-        stream_run(stream);
-        stream_run_wait(stream);
-        stream_connect_wait(stream);
-        poll_block();
-        error = stream_connect(stream);
+    COVERAGE_INC(stream_open);
+
+    /* Look up the class. */
+    error = stream_lookup_class(name, &class);
+    if (!class) {
+        goto error;
+    }
+
+    /* Call class's "open" function. */
+    suffix_copy = xstrdup(strchr(name, ':') + 1);
+    error = class->open(name, suffix_copy, &stream, dscp);
+    free(suffix_copy);
+    if (error) {
+        goto error;
+    }
+
+    /* Success. */
+    *streamp = stream;
+    return 0;
+
+error:
+    *streamp = NULL;
+    return error;
+}
+
+/* Blocks until a previously started stream connection attempt succeeds or
+ * fails.  'error' should be the value returned by stream_open() and 'streamp'
+ * should point to the stream pointer set by stream_open().  Returns 0 if
+ * successful, otherwise a positive errno value other than EAGAIN or
+ * EINPROGRESS.  If successful, leaves '*streamp' untouched; on error, closes
+ * '*streamp' and sets '*streamp' to null.
+ *
+ * Typical usage:
+ *   error = stream_open_block(stream_open("tcp:1.2.3.4:5", &stream), &stream);
+ */
+int
+stream_open_block(int error, struct stream **streamp)
+{
+    struct stream *stream = *streamp;
+
+    fatal_signal_run();
+
+    if (!error) {
+        while ((error = stream_connect(stream)) == EAGAIN) {
+            stream_run(stream);
+            stream_run_wait(stream);
+            stream_connect_wait(stream);
+            poll_block();
+        }
         assert(error != EINPROGRESS);
     }
+
     if (error) {
         stream_close(stream);
         *streamp = NULL;
@@ -230,7 +283,7 @@ stream_get_name(const struct stream *stream)
 
 /* Returns the IP address of the peer, or 0 if the peer is not connected over
  * an IP-based protocol or if its IP address is not yet known. */
-uint32_t
+ovs_be32
 stream_get_remote_ip(const struct stream *stream)
 {
     return stream->remote_ip;
@@ -238,7 +291,7 @@ stream_get_remote_ip(const struct stream *stream)
 
 /* Returns the transport port of the peer, or 0 if the connection does not
  * contain a port or if the port is not yet known. */
-uint16_t
+ovs_be16
 stream_get_remote_port(const struct stream *stream)
 {
     return stream->remote_port;
@@ -246,7 +299,7 @@ stream_get_remote_port(const struct stream *stream)
 
 /* Returns the IP address used to connect to the peer, or 0 if the connection
  * is not an IP-based protocol or if its IP address is not yet known. */
-uint32_t
+ovs_be32
 stream_get_local_ip(const struct stream *stream)
 {
     return stream->local_ip;
@@ -254,7 +307,7 @@ stream_get_local_ip(const struct stream *stream)
 
 /* Returns the transport port used to connect to the peer, or 0 if the
  * connection does not contain a port or if the port is not yet known. */
-uint16_t
+ovs_be16
 stream_get_local_port(const struct stream *stream)
 {
     return stream->local_port;
@@ -273,10 +326,10 @@ scs_connecting(struct stream *stream)
     }
 }
 
-/* Tries to complete the connection on 'stream', which must be an active
- * stream.  If 'stream''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. */
+/* Tries to complete the connection on 'stream'.  If 'stream''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
 stream_connect(struct stream *stream)
 {
@@ -399,42 +452,102 @@ stream_send_wait(struct stream *stream)
     stream_wait(stream, STREAM_SEND);
 }
 
-/* Attempts to start listening for remote stream connections.  'name' is a
- * connection name in the form "TYPE:ARGS", where TYPE is an passive stream
- * class's name and ARGS are stream class-specific.
- *
- * Returns 0 if successful, otherwise a positive errno value.  If successful,
- * stores a pointer to the new connection in '*pstreamp', otherwise a null
- * pointer.  */
-int
-pstream_open(const char *name, struct pstream **pstreamp)
+/* Given 'name', a pstream name in the form "TYPE:ARGS", stores the class
+ * named "TYPE" into '*classp' and returns 0.  Returns EAFNOSUPPORT and stores
+ * a null pointer into '*classp' if 'name' is in the wrong form or if no such
+ * class exists. */
+static int
+pstream_lookup_class(const char *name, const struct pstream_class **classp)
 {
     size_t prefix_len;
     size_t i;
 
     check_stream_classes();
 
-    *pstreamp = NULL;
+    *classp = NULL;
     prefix_len = strcspn(name, ":");
-    if (prefix_len == strlen(name)) {
+    if (name[prefix_len] == '\0') {
         return EAFNOSUPPORT;
     }
     for (i = 0; i < ARRAY_SIZE(pstream_classes); i++) {
-        struct pstream_class *class = pstream_classes[i];
+        const struct pstream_class *class = pstream_classes[i];
         if (strlen(class->name) == prefix_len
             && !memcmp(class->name, name, prefix_len)) {
-            char *suffix_copy = xstrdup(name + prefix_len + 1);
-            int retval = class->listen(name, suffix_copy, pstreamp);
-            free(suffix_copy);
-            if (retval) {
-                *pstreamp = NULL;
-            }
-            return retval;
+            *classp = class;
+            return 0;
         }
     }
     return EAFNOSUPPORT;
 }
 
+/* Returns 0 if 'name' is a pstream name in the form "TYPE:ARGS" and TYPE is
+ * a supported pstream type, otherwise EAFNOSUPPORT.  */
+int
+pstream_verify_name(const char *name)
+{
+    const struct pstream_class *class;
+    return pstream_lookup_class(name, &class);
+}
+
+/* Returns 1 if the stream or pstream specified by 'name' needs periodic probes
+ * to verify connectivity.  For [p]streams which need probes, it can take a
+ * long time to notice the connection has been dropped.  Returns 0 if the
+ * stream or pstream does not need probes, and -1 if 'name' is not valid. */
+int
+stream_or_pstream_needs_probes(const char *name)
+{
+    const struct pstream_class *pclass;
+    const struct stream_class *class;
+
+    if (!stream_lookup_class(name, &class)) {
+        return class->needs_probes;
+    } else if (!pstream_lookup_class(name, &pclass)) {
+        return pclass->needs_probes;
+    } else {
+        return -1;
+    }
+}
+
+/* Attempts to start listening for remote stream connections.  'name' is a
+ * connection name in the form "TYPE:ARGS", where TYPE is an passive stream
+ * class's name and ARGS are stream class-specific.
+ *
+ * Returns 0 if successful, otherwise a positive errno value.  If successful,
+ * stores a pointer to the new connection in '*pstreamp', otherwise a null
+ * pointer.  */
+int
+pstream_open(const char *name, struct pstream **pstreamp, uint8_t dscp)
+{
+    const struct pstream_class *class;
+    struct pstream *pstream;
+    char *suffix_copy;
+    int error;
+
+    COVERAGE_INC(pstream_open);
+
+    /* Look up the class. */
+    error = pstream_lookup_class(name, &class);
+    if (!class) {
+        goto error;
+    }
+
+    /* Call class's "open" function. */
+    suffix_copy = xstrdup(strchr(name, ':') + 1);
+    error = class->listen(name, suffix_copy, &pstream, dscp);
+    free(suffix_copy);
+    if (error) {
+        goto error;
+    }
+
+    /* Success. */
+    *pstreamp = pstream;
+    return 0;
+
+error:
+    *pstreamp = NULL;
+    return error;
+}
+
 /* Returns the name that was used to open 'pstream'.  The caller must not
  * modify or free the name. */
 const char *
@@ -484,6 +597,7 @@ pstream_accept_block(struct pstream *pstream, struct stream **new_stream)
 {
     int error;
 
+    fatal_signal_run();
     while ((error = pstream_accept(pstream, new_stream)) == EAGAIN) {
         pstream_wait(pstream);
         poll_block();
@@ -518,9 +632,10 @@ pstream_wait(struct pstream *pstream)
  *
  * The caller retains ownership of 'name'. */
 void
-stream_init(struct stream *stream, struct stream_class *class,
+stream_init(struct stream *stream, const struct stream_class *class,
             int connect_status, const char *name)
 {
+    memset(stream, 0, sizeof *stream);
     stream->class = class;
     stream->state = (connect_status == EAGAIN ? SCS_CONNECTING
                     : !connect_status ? SCS_CONNECTED
@@ -531,33 +646,185 @@ stream_init(struct stream *stream, struct stream_class *class,
 }
 
 void
-stream_set_remote_ip(struct stream *stream, uint32_t ip)
+stream_set_remote_ip(struct stream *stream, ovs_be32 ip)
 {
     stream->remote_ip = ip;
 }
 
 void
-stream_set_remote_port(struct stream *stream, uint16_t port)
+stream_set_remote_port(struct stream *stream, ovs_be16 port)
 {
     stream->remote_port = port;
 }
 
 void
-stream_set_local_ip(struct stream *stream, uint32_t ip)
+stream_set_local_ip(struct stream *stream, ovs_be32 ip)
 {
     stream->local_ip = ip;
 }
 
 void
-stream_set_local_port(struct stream *stream, uint16_t port)
+stream_set_local_port(struct stream *stream, ovs_be16 port)
 {
     stream->local_port = port;
 }
 
 void
-pstream_init(struct pstream *pstream, struct pstream_class *class,
+pstream_init(struct pstream *pstream, const struct pstream_class *class,
             const char *name)
 {
     pstream->class = class;
     pstream->name = xstrdup(name);
 }
+
+static int
+count_fields(const char *s_)
+{
+    char *s, *field, *save_ptr;
+    int n = 0;
+
+    save_ptr = NULL;
+    s = xstrdup(s_);
+    for (field = strtok_r(s, ":", &save_ptr); field != NULL;
+         field = strtok_r(NULL, ":", &save_ptr)) {
+        n++;
+    }
+    free(s);
+
+    return n;
+}
+
+/* Like stream_open(), but for tcp streams the port defaults to
+ * 'default_tcp_port' if no port number is given and for SSL streams the port
+ * defaults to 'default_ssl_port' if no port number is given. */
+int
+stream_open_with_default_ports(const char *name_,
+                               uint16_t default_tcp_port,
+                               uint16_t default_ssl_port,
+                               struct stream **streamp,
+                               uint8_t dscp)
+{
+    char *name;
+    int error;
+
+    if (!strncmp(name_, "tcp:", 4) && count_fields(name_) < 3) {
+        name = xasprintf("%s:%d", name_, default_tcp_port);
+    } else if (!strncmp(name_, "ssl:", 4) && count_fields(name_) < 3) {
+        name = xasprintf("%s:%d", name_, default_ssl_port);
+    } else {
+        name = xstrdup(name_);
+    }
+    error = stream_open(name, streamp, dscp);
+    free(name);
+
+    return error;
+}
+
+/* Like pstream_open(), but for ptcp streams the port defaults to
+ * 'default_ptcp_port' if no port number is given and for passive SSL streams
+ * the port defaults to 'default_pssl_port' if no port number is given. */
+int
+pstream_open_with_default_ports(const char *name_,
+                                uint16_t default_ptcp_port,
+                                uint16_t default_pssl_port,
+                                struct pstream **pstreamp,
+                                uint8_t dscp)
+{
+    char *name;
+    int error;
+
+    if (!strncmp(name_, "ptcp:", 5) && count_fields(name_) < 2) {
+        name = xasprintf("%s%d", name_, default_ptcp_port);
+    } else if (!strncmp(name_, "pssl:", 5) && count_fields(name_) < 2) {
+        name = xasprintf("%s%d", name_, default_pssl_port);
+    } else {
+        name = xstrdup(name_);
+    }
+    error = pstream_open(name, pstreamp, dscp);
+    free(name);
+
+    return error;
+}
+
+/*
+ * This function extracts IP address and port from the target string.
+ *
+ *     - On success, function returns true and fills *sin structure with port
+ *       and IP address. If port was absent in target string then it will use
+ *       corresponding default port value.
+ *     - On error, function returns false and *sin contains garbage.
+ */
+bool
+stream_parse_target_with_default_ports(const char *target,
+                                       uint16_t default_tcp_port,
+                                       uint16_t default_ssl_port,
+                                       struct sockaddr_in *sin)
+{
+    return (!strncmp(target, "tcp:", 4)
+             && inet_parse_active(target + 4, default_tcp_port, sin)) ||
+            (!strncmp(target, "ssl:", 4)
+             && inet_parse_active(target + 4, default_ssl_port, sin));
+}
+
+/* Attempts to guess the content type of a stream whose first few bytes were
+ * the 'size' bytes of 'data'. */
+static enum stream_content_type
+stream_guess_content(const uint8_t *data, ssize_t size)
+{
+    if (size >= 2) {
+#define PAIR(A, B) (((A) << 8) | (B))
+        switch (PAIR(data[0], data[1])) {
+        case PAIR(0x16, 0x03):  /* Handshake, version 3. */
+            return STREAM_SSL;
+        case PAIR('{', '"'):
+            return STREAM_JSONRPC;
+        case PAIR(OFP10_VERSION, OFPT_HELLO):
+            return STREAM_OPENFLOW;
+        }
+    }
+
+    return STREAM_UNKNOWN;
+}
+
+/* Returns a string represenation of 'type'. */
+static const char *
+stream_content_type_to_string(enum stream_content_type type)
+{
+    switch (type) {
+    case STREAM_UNKNOWN:
+    default:
+        return "unknown";
+
+    case STREAM_JSONRPC:
+        return "JSON-RPC";
+
+    case STREAM_OPENFLOW:
+        return "OpenFlow";
+
+    case STREAM_SSL:
+        return "SSL";
+    }
+}
+
+/* Attempts to guess the content type of a stream whose first few bytes were
+ * the 'size' bytes of 'data'.  If this is done successfully, and the guessed
+ * content type is other than 'expected_type', then log a message in vlog
+ * module 'module', naming 'stream_name' as the source, explaining what
+ * content was expected and what was actually received. */
+void
+stream_report_content(const void *data, ssize_t size,
+                      enum stream_content_type expected_type,
+                      struct vlog_module *module, const char *stream_name)
+{
+    static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 5);
+    enum stream_content_type actual_type;
+
+    actual_type = stream_guess_content(data, size);
+    if (actual_type != expected_type && actual_type != STREAM_UNKNOWN) {
+        vlog_rate_limit(module, VLL_WARN, &rl,
+                        "%s: received %s data on %s channel",
+                        stream_name,
+                        stream_content_type_to_string(actual_type),
+                        stream_content_type_to_string(expected_type));
+    }
+}