ofp-msgs: New approach to encoding and decoding OpenFlow headers.
[openvswitch] / lib / stream.c
index 540597f1adcfdc7e0af66b95e6e1852a4e20e9f6..2c7bfc3a52ba4303ff0ca83379c50492f44b67d0 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -49,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
@@ -57,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
@@ -73,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
@@ -88,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) {
@@ -154,7 +154,7 @@ stream_usage(const char *name, bool active, bool passive,
  * 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, struct stream_class **classp)
+stream_lookup_class(const char *name, const struct stream_class **classp)
 {
     size_t prefix_len;
     size_t i;
@@ -167,7 +167,7 @@ stream_lookup_class(const char *name, struct stream_class **classp)
         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)) {
             *classp = class;
@@ -182,7 +182,7 @@ stream_lookup_class(const char *name, struct stream_class **classp)
 int
 stream_verify_name(const char *name)
 {
-    struct stream_class *class;
+    const struct stream_class *class;
     return stream_lookup_class(name, &class);
 }
 
@@ -194,9 +194,9 @@ stream_verify_name(const char *name)
  * stores a pointer to the new connection in '*streamp', otherwise a null
  * pointer.  */
 int
-stream_open(const char *name, struct stream **streamp)
+stream_open(const char *name, struct stream **streamp, uint8_t dscp)
 {
-    struct stream_class *class;
+    const struct stream_class *class;
     struct stream *stream;
     char *suffix_copy;
     int error;
@@ -211,7 +211,7 @@ stream_open(const char *name, struct stream **streamp)
 
     /* Call class's "open" function. */
     suffix_copy = xstrdup(strchr(name, ':') + 1);
-    error = class->open(name, suffix_copy, &stream);
+    error = class->open(name, suffix_copy, &stream, dscp);
     free(suffix_copy);
     if (error) {
         goto error;
@@ -457,7 +457,7 @@ stream_send_wait(struct stream *stream)
  * 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, struct pstream_class **classp)
+pstream_lookup_class(const char *name, const struct pstream_class **classp)
 {
     size_t prefix_len;
     size_t i;
@@ -470,7 +470,7 @@ pstream_lookup_class(const char *name, struct pstream_class **classp)
         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)) {
             *classp = class;
@@ -485,10 +485,29 @@ pstream_lookup_class(const char *name, struct pstream_class **classp)
 int
 pstream_verify_name(const char *name)
 {
-    struct pstream_class *class;
+    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.
@@ -497,9 +516,9 @@ pstream_verify_name(const char *name)
  * stores a pointer to the new connection in '*pstreamp', otherwise a null
  * pointer.  */
 int
-pstream_open(const char *name, struct pstream **pstreamp)
+pstream_open(const char *name, struct pstream **pstreamp, uint8_t dscp)
 {
-    struct pstream_class *class;
+    const struct pstream_class *class;
     struct pstream *pstream;
     char *suffix_copy;
     int error;
@@ -514,7 +533,7 @@ pstream_open(const char *name, struct pstream **pstreamp)
 
     /* Call class's "open" function. */
     suffix_copy = xstrdup(strchr(name, ':') + 1);
-    error = class->listen(name, suffix_copy, &pstream);
+    error = class->listen(name, suffix_copy, &pstream, dscp);
     free(suffix_copy);
     if (error) {
         goto error;
@@ -613,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
@@ -650,7 +670,7 @@ stream_set_local_port(struct stream *stream, ovs_be16 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;
@@ -681,7 +701,8 @@ int
 stream_open_with_default_ports(const char *name_,
                                uint16_t default_tcp_port,
                                uint16_t default_ssl_port,
-                               struct stream **streamp)
+                               struct stream **streamp,
+                               uint8_t dscp)
 {
     char *name;
     int error;
@@ -693,7 +714,7 @@ stream_open_with_default_ports(const char *name_,
     } else {
         name = xstrdup(name_);
     }
-    error = stream_open(name, streamp);
+    error = stream_open(name, streamp, dscp);
     free(name);
 
     return error;
@@ -706,7 +727,8 @@ int
 pstream_open_with_default_ports(const char *name_,
                                 uint16_t default_ptcp_port,
                                 uint16_t default_pssl_port,
-                                struct pstream **pstreamp)
+                                struct pstream **pstreamp,
+                                uint8_t dscp)
 {
     char *name;
     int error;
@@ -718,16 +740,36 @@ pstream_open_with_default_ports(const char *name_,
     } else {
         name = xstrdup(name_);
     }
-    error = pstream_open(name, pstreamp);
+    error = pstream_open(name, pstreamp, dscp);
     free(name);
 
     return error;
 }
-\f
+
+/*
+ * 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, size_t size)
+stream_guess_content(const uint8_t *data, ssize_t size)
 {
     if (size >= 2) {
 #define PAIR(A, B) (((A) << 8) | (B))
@@ -736,7 +778,7 @@ stream_guess_content(const uint8_t *data, size_t size)
             return STREAM_SSL;
         case PAIR('{', '"'):
             return STREAM_JSONRPC;
-        case PAIR(OFP_VERSION, OFPT_HELLO):
+        case PAIR(OFP10_VERSION, 0 /* OFPT_HELLO */):
             return STREAM_OPENFLOW;
         }
     }
@@ -770,7 +812,7 @@ stream_content_type_to_string(enum stream_content_type type)
  * 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, size_t size,
+stream_report_content(const void *data, ssize_t size,
                       enum stream_content_type expected_type,
                       struct vlog_module *module, const char *stream_name)
 {
@@ -782,7 +824,7 @@ stream_report_content(const void *data, size_t size,
         vlog_rate_limit(module, VLL_WARN, &rl,
                         "%s: received %s data on %s channel",
                         stream_name,
-                        stream_content_type_to_string(expected_type),
-                        stream_content_type_to_string(actual_type));
+                        stream_content_type_to_string(actual_type),
+                        stream_content_type_to_string(expected_type));
     }
 }