vconn: Reimplement in terms of the "stream" abstraction.

This reduces the amount of redundancy in the source tree, by making all of
the current implementations of a vconn simply delegate to the "stream"
abstraction.

1 files changed, 186 insertions, 152 deletions

diff --git a/lib/vconn-stream.c b/lib/vconn-stream.c
index f19f3ebfa..594eded55 100644
--- a/lib/vconn-stream.c
+++ b/lib/vconn-stream.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2008, 2009 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010 Nicira Networks.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
  */
 
 #include <config.h>
-#include "vconn-stream.h"
 #include <assert.h>
 #include <errno.h>
 #include <poll.h>
@@ -29,6 +28,7 @@
 #include "openflow/openflow.h"
 #include "poll-loop.h"
 #include "socket-util.h"
+#include "stream.h"
 #include "util.h"
 #include "vconn-provider.h"
 #include "vconn.h"
@@ -38,76 +38,92 @@
 
 /* Active stream socket vconn. */
 
-struct stream_vconn
+struct vconn_stream
 {
     struct vconn vconn;
-    int fd;
+    struct stream *stream;
     struct ofpbuf *rxbuf;
     struct ofpbuf *txbuf;
-    char *unlink_path;
 };
 
 static struct vconn_class stream_vconn_class;
 
 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 25);
 
-static void stream_clear_txbuf(struct stream_vconn *);
-static void maybe_unlink_and_free(char *path);
+static void vconn_stream_clear_txbuf(struct vconn_stream *);
+static int count_fields(const char *);
 
-/* Creates a new vconn named 'name' that will send and receive data on 'fd' and
- * stores a pointer to the vconn in '*vconnp'.  Initial connection status
- * 'connect_status' is interpreted as described for vconn_init().
- *
- * When '*vconnp' is closed, then 'unlink_path' (if nonnull) will be passed to
- * fatal_signal_unlink_file_now() and then freed with free().
- *
- * Returns 0 if successful, otherwise a positive errno value.  (The current
- * implementation never fails.) */
-int
-new_stream_vconn(const char *name, int fd, int connect_status,
-                 char *unlink_path, struct vconn **vconnp)
+static struct vconn *
+vconn_stream_new(struct stream *stream, int connect_status)
 {
-    struct stream_vconn *s;
+    struct vconn_stream *s;
 
     s = xmalloc(sizeof *s);
-    vconn_init(&s->vconn, &stream_vconn_class, connect_status, name);
-    s->fd = fd;
+    vconn_init(&s->vconn, &stream_vconn_class, connect_status,
+               stream_get_name(stream));
+    s->stream = stream;
     s->txbuf = NULL;
     s->rxbuf = NULL;
-    s->unlink_path = unlink_path;
-    *vconnp = &s->vconn;
+    return &s->vconn;
+}
+
+/* Creates a new vconn that will send and receive data on a stream named 'name'
+ * and stores a pointer to the vconn in '*vconnp'.
+ *
+ * Returns 0 if successful, otherwise a positive errno value. */
+static int
+vconn_stream_open(const char *name_, char *suffix UNUSED,
+                  struct vconn **vconnp)
+{
+    struct stream *stream;
+    char *name;
+    int error;
+
+    if (!strncmp(name_, "tcp:", 4) && count_fields(name_) < 3) {
+        name = xasprintf("%s:%d", name_, OFP_TCP_PORT);
+    } else if (!strncmp(name_, "ssl:", 4) && count_fields(name_) < 3) {
+        name = xasprintf("%s:%d", name_, OFP_SSL_PORT);
+    } else {
+        name = xstrdup(name_);
+    }
+    error = stream_open(name, &stream);
+    free(name);
+
+    if (error && error != EAGAIN) {
+        return error;
+    }
+
+    *vconnp = vconn_stream_new(stream, error);
     return 0;
 }
 
-static struct stream_vconn *
-stream_vconn_cast(struct vconn *vconn)
+static struct vconn_stream *
+vconn_stream_cast(struct vconn *vconn)
 {
-    vconn_assert_class(vconn, &stream_vconn_class);
-    return CONTAINER_OF(vconn, struct stream_vconn, vconn);
+    return CONTAINER_OF(vconn, struct vconn_stream, vconn);
 }
 
 static void
-stream_close(struct vconn *vconn)
+vconn_stream_close(struct vconn *vconn)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
-    stream_clear_txbuf(s);
+    struct vconn_stream *s = vconn_stream_cast(vconn);
+    stream_close(s->stream);
+    vconn_stream_clear_txbuf(s);
     ofpbuf_delete(s->rxbuf);
-    close(s->fd);
-    maybe_unlink_and_free(s->unlink_path);
     free(s);
 }
 
 static int
-stream_connect(struct vconn *vconn)
+vconn_stream_connect(struct vconn *vconn)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
-    return check_connection_completion(s->fd);
+    struct vconn_stream *s = vconn_stream_cast(vconn);
+    return stream_connect(s->stream);
 }
 
 static int
-stream_recv(struct vconn *vconn, struct ofpbuf **bufferp)
+vconn_stream_recv(struct vconn *vconn, struct ofpbuf **bufferp)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
+    struct vconn_stream *s = vconn_stream_cast(vconn);
     struct ofpbuf *rx;
     size_t want_bytes;
     ssize_t retval;
@@ -137,7 +153,7 @@ again:
     }
     ofpbuf_prealloc_tailroom(rx, want_bytes);
 
-    retval = read(s->fd, ofpbuf_tail(rx), want_bytes);
+    retval = stream_recv(s->stream, ofpbuf_tail(rx), want_bytes);
     if (retval > 0) {
         rx->size += retval;
         if (retval == want_bytes) {
@@ -158,32 +174,32 @@ again:
             return EOF;
         }
     } else {
-        return errno;
+        return -retval;
     }
 }
 
 static void
-stream_clear_txbuf(struct stream_vconn *s)
+vconn_stream_clear_txbuf(struct vconn_stream *s)
 {
     ofpbuf_delete(s->txbuf);
     s->txbuf = NULL;
 }
 
 static int
-stream_send(struct vconn *vconn, struct ofpbuf *buffer)
+vconn_stream_send(struct vconn *vconn, struct ofpbuf *buffer)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
+    struct vconn_stream *s = vconn_stream_cast(vconn);
     ssize_t retval;
 
     if (s->txbuf) {
         return EAGAIN;
     }
 
-    retval = write(s->fd, buffer->data, buffer->size);
+    retval = stream_send(s->stream, buffer->data, buffer->size);
     if (retval == buffer->size) {
         ofpbuf_delete(buffer);
         return 0;
-    } else if (retval >= 0 || errno == EAGAIN) {
+    } else if (retval >= 0 || retval == -EAGAIN) {
         leak_checker_claim(buffer);
         s->txbuf = buffer;
         if (retval > 0) {
@@ -191,193 +207,211 @@ stream_send(struct vconn *vconn, struct ofpbuf *buffer)
         }
         return 0;
     } else {
-        return errno;
+        return -retval;
     }
 }
 
 static void
-stream_run(struct vconn *vconn)
+vconn_stream_run(struct vconn *vconn)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
-    ssize_t n;
+    struct vconn_stream *s = vconn_stream_cast(vconn);
+    ssize_t retval;
 
     if (!s->txbuf) {
         return;
     }
 
-    n = write(s->fd, s->txbuf->data, s->txbuf->size);
-    if (n < 0) {
-        if (errno != EAGAIN) {
-            VLOG_ERR_RL(&rl, "send: %s", strerror(errno));
-            stream_clear_txbuf(s);
+    retval = stream_send(s->stream, s->txbuf->data, s->txbuf->size);
+    if (retval < 0) {
+        if (retval != -EAGAIN) {
+            VLOG_ERR_RL(&rl, "send: %s", strerror(-retval));
+            vconn_stream_clear_txbuf(s);
             return;
         }
-    } else if (n > 0) {
-        ofpbuf_pull(s->txbuf, n);
+    } else if (retval > 0) {
+        ofpbuf_pull(s->txbuf, retval);
         if (!s->txbuf->size) {
-            stream_clear_txbuf(s);
+            vconn_stream_clear_txbuf(s);
             return;
         }
     }
 }
 
 static void
-stream_run_wait(struct vconn *vconn)
+vconn_stream_run_wait(struct vconn *vconn)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
+    struct vconn_stream *s = vconn_stream_cast(vconn);
 
     if (s->txbuf) {
-        poll_fd_wait(s->fd, POLLOUT);
+        stream_send_wait(s->stream);
     }
 }
 
 static void
-stream_wait(struct vconn *vconn, enum vconn_wait_type wait)
+vconn_stream_wait(struct vconn *vconn, enum vconn_wait_type wait)
 {
-    struct stream_vconn *s = stream_vconn_cast(vconn);
+    struct vconn_stream *s = vconn_stream_cast(vconn);
     switch (wait) {
     case WAIT_CONNECT:
-        poll_fd_wait(s->fd, POLLOUT);
+        stream_connect_wait(s->stream);
         break;
 
     case WAIT_SEND:
         if (!s->txbuf) {
-            poll_fd_wait(s->fd, POLLOUT);
+            stream_send_wait(s->stream);
         } else {
-            /* Nothing to do: need to drain txbuf first.  stream_run_wait()
-             * will arrange to wake up when there room to send data, so there's
-             * no point in calling poll_fd_wait() redundantly here. */
+            /* Nothing to do: need to drain txbuf first.
+             * vconn_stream_run_wait() will arrange to wake up when there room
+             * to send data, so there's no point in calling poll_fd_wait()
+             * redundantly here. */
         }
         break;
 
     case WAIT_RECV:
-        poll_fd_wait(s->fd, POLLIN);
+        stream_recv_wait(s->stream);
         break;
 
     default:
         NOT_REACHED();
     }
 }
-
-static struct vconn_class stream_vconn_class = {
-    "stream",                   /* name */
-    NULL,                       /* open */
-    stream_close,               /* close */
-    stream_connect,             /* connect */
-    stream_recv,                /* recv */
-    stream_send,                /* send */
-    stream_run,                 /* run */
-    stream_run_wait,            /* run_wait */
-    stream_wait,                /* wait */
-};
 
 /* Passive stream socket vconn. */
 
-struct pstream_pvconn
+struct pvconn_pstream
 {
     struct pvconn pvconn;
-    int fd;
-    int (*accept_cb)(int fd, const struct sockaddr *, size_t sa_len,
-                     struct vconn **);
-    char *unlink_path;
+    struct pstream *pstream;
 };
 
 static struct pvconn_class pstream_pvconn_class;
 
-static struct pstream_pvconn *
-pstream_pvconn_cast(struct pvconn *pvconn)
+static struct pvconn_pstream *
+pvconn_pstream_cast(struct pvconn *pvconn)
 {
-    pvconn_assert_class(pvconn, &pstream_pvconn_class);
-    return CONTAINER_OF(pvconn, struct pstream_pvconn, pvconn);
+    return CONTAINER_OF(pvconn, struct pvconn_pstream, pvconn);
 }
 
-/* Creates a new pvconn named 'name' that will accept new socket connections on
- * 'fd' and stores a pointer to the vconn in '*pvconnp'.
- *
- * When a connection has been accepted, 'accept_cb' will be called with the new
- * socket fd 'fd' and the remote address of the connection 'sa' and 'sa_len'.
- * accept_cb must return 0 if the connection is successful, in which case it
- * must initialize '*vconnp' to the new vconn, or a positive errno value on
- * error.  In either case accept_cb takes ownership of the 'fd' passed in.
- *
- * When '*pvconnp' is closed, then 'unlink_path' (if nonnull) will be passed to
- * fatal_signal_unlink_file_now() and freed with free().
+/* Creates a new pvconn named 'name' that will accept new connections using
+ * pstream_accept() and stores a pointer to the pvconn in '*pvconnp'.
  *
  * Returns 0 if successful, otherwise a positive errno value.  (The current
  * implementation never fails.) */
-int
-new_pstream_pvconn(const char *name, int fd,
-                  int (*accept_cb)(int fd, const struct sockaddr *sa,
-                                   size_t sa_len, struct vconn **vconnp),
-                  char *unlink_path, struct pvconn **pvconnp)
+static int
+pvconn_pstream_listen(const char *name_, char *suffix UNUSED,
+                      struct pvconn **pvconnp)
 {
-    struct pstream_pvconn *ps = xmalloc(sizeof *ps);
-    pvconn_init(&ps->pvconn, &pstream_pvconn_class, name);
-    ps->fd = fd;
-    ps->accept_cb = accept_cb;
-    ps->unlink_path = unlink_path;
+    struct pvconn_pstream *ps;
+    struct pstream *pstream;
+    char *name;
+    int error;
+
+    if (!strncmp(name_, "ptcp:", 5) && count_fields(name_) < 2) {
+        name = xasprintf("%s:%d", name_, OFP_TCP_PORT);
+    } else if (!strncmp(name_, "pssl:", 5) && count_fields(name_) < 2) {
+        name = xasprintf("%s:%d", name_, OFP_SSL_PORT);
+    } else {
+        name = xstrdup(name_);
+    }
+    error = pstream_open(name, &pstream);
+    free(name);
+    if (error) {
+        return error;
+    }
+
+    ps = xmalloc(sizeof *ps);
+    pvconn_init(&ps->pvconn, &pstream_pvconn_class, name_);
+    ps->pstream = pstream;
     *pvconnp = &ps->pvconn;
     return 0;
 }
 
 static void
-pstream_close(struct pvconn *pvconn)
+pvconn_pstream_close(struct pvconn *pvconn)
 {
-    struct pstream_pvconn *ps = pstream_pvconn_cast(pvconn);
-    close(ps->fd);
-    maybe_unlink_and_free(ps->unlink_path);
+    struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
+    pstream_close(ps->pstream);
     free(ps);
 }
 
 static int
-pstream_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
+pvconn_pstream_accept(struct pvconn *pvconn, struct vconn **new_vconnp)
 {
-    struct pstream_pvconn *ps = pstream_pvconn_cast(pvconn);
-    struct sockaddr_storage ss;
-    socklen_t ss_len = sizeof ss;
-    int new_fd;
-    int retval;
-
-    new_fd = accept(ps->fd, (struct sockaddr *) &ss, &ss_len);
-    if (new_fd < 0) {
-        int retval = errno;
-        if (retval != EAGAIN) {
-            VLOG_DBG_RL(&rl, "accept: %s", strerror(retval));
+    struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
+    struct stream *stream;
+    int error;
+
+    error = pstream_accept(ps->pstream, &stream);
+    if (error) {
+        if (error != EAGAIN) {
+            VLOG_DBG_RL(&rl, "%s: accept: %s",
+                        pstream_get_name(ps->pstream), strerror(error));
         }
-        return retval;
-    }
-
-    retval = set_nonblocking(new_fd);
-    if (retval) {
-        close(new_fd);
-        return retval;
+        return error;
     }
 
-    return ps->accept_cb(new_fd, (const struct sockaddr *) &ss, ss_len,
-                         new_vconnp);
+    *new_vconnp = vconn_stream_new(stream, 0);
+    return 0;
 }
 
 static void
-pstream_wait(struct pvconn *pvconn)
+pvconn_pstream_wait(struct pvconn *pvconn)
 {
-    struct pstream_pvconn *ps = pstream_pvconn_cast(pvconn);
-    poll_fd_wait(ps->fd, POLLIN);
+    struct pvconn_pstream *ps = pvconn_pstream_cast(pvconn);
+    pstream_wait(ps->pstream);
 }
-
-static struct pvconn_class pstream_pvconn_class = {
-    "pstream",
-    NULL,
-    pstream_close,
-    pstream_accept,
-    pstream_wait
-};
 
-/* Helper functions. */
-static void
-maybe_unlink_and_free(char *path)
+static int
+count_fields(const char *s_)
 {
-    if (path) {
-        fatal_signal_unlink_file_now(path);
-        free(path);
+    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;
 }
+
+/* Stream-based vconns and pvconns. */
+
+#define DEFINE_VCONN_STREAM_CLASS(NAME)             \
+        struct vconn_class NAME##_vconn_class = {   \
+            #NAME,                                  \
+            vconn_stream_open,                      \
+            vconn_stream_close,                     \
+            vconn_stream_connect,                   \
+            vconn_stream_recv,                      \
+            vconn_stream_send,                      \
+            vconn_stream_run,                       \
+            vconn_stream_run_wait,                  \
+            vconn_stream_wait,                      \
+        };
+
+#define DEFINE_PVCONN_STREAM_CLASS(NAME)            \
+        struct pvconn_class NAME##_pvconn_class = { \
+            #NAME,                                  \
+            pvconn_pstream_listen,                  \
+            pvconn_pstream_close,                   \
+            pvconn_pstream_accept,                  \
+            pvconn_pstream_wait                     \
+        };
+
+static DEFINE_VCONN_STREAM_CLASS(stream);
+static DEFINE_PVCONN_STREAM_CLASS(pstream);
+
+DEFINE_VCONN_STREAM_CLASS(tcp);
+DEFINE_PVCONN_STREAM_CLASS(ptcp);
+
+DEFINE_VCONN_STREAM_CLASS(unix);
+DEFINE_PVCONN_STREAM_CLASS(punix);
+
+#ifdef HAVE_OPENSSL
+DEFINE_VCONN_STREAM_CLASS(ssl);
+DEFINE_PVCONN_STREAM_CLASS(pssl);
+#endif