Rename struct buffer to struct ofpbuf.
[sliver-openvswitch.git] / lib / vconn.c
index f75f816..1a5dc6b 100644 (file)
  * derivatives without specific, written prior permission.
  */
 
-#include "vconn.h"
+#include <config.h>
+#include "vconn-provider.h"
 #include <assert.h>
 #include <errno.h>
+#include <inttypes.h>
 #include <netinet/in.h>
 #include <poll.h>
 #include <stdlib.h>
 #include <string.h>
-#include "buffer.h"
 #include "flow.h"
 #include "ofp-print.h"
+#include "ofpbuf.h"
 #include "openflow.h"
 #include "poll-loop.h"
 #include "random.h"
@@ -59,8 +61,15 @@ static struct vconn_class *vconn_classes[] = {
     &ssl_vconn_class,
     &pssl_vconn_class,
 #endif
+    &unix_vconn_class,
+    &punix_vconn_class,
 };
 
+/* High rate limit because most of the rate-limiting here is individual
+ * OpenFlow messages going over the vconn.  If those are enabled then we
+ * really need to see them. */
+static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(600, 600);
+
 /* Check the validity of the vconn class structures. */
 static void
 check_vconn_classes(void)
@@ -72,11 +81,16 @@ check_vconn_classes(void)
         struct vconn_class *class = vconn_classes[i];
         assert(class->name != NULL);
         assert(class->open != NULL);
-        assert(class->close != NULL);
-        assert(class->accept
-               ? !class->recv && !class->send
-               :  class->recv && class->send);
-        assert(class->wait != NULL);
+        if (class->close || class->accept || class->recv || class->send
+            || class->wait) {
+            assert(class->close != NULL);
+            assert(class->accept
+                   ? !class->recv && !class->send
+                   :  class->recv && class->send);
+            assert(class->wait != NULL);
+        } else {
+            /* This class delegates to another one. */
+        }
     }
 #endif
 }
@@ -103,6 +117,7 @@ vconn_usage(bool active, bool passive)
         printf("  ssl:HOST[:PORT]         "
                "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
 #endif
+        printf("  unix:FILE               Unix domain socket named FILE\n");
     }
 
     if (passive) {
@@ -115,6 +130,8 @@ vconn_usage(bool active, bool passive)
                "listen for SSL on PORT (default: %d)\n",
                OFP_SSL_PORT);
 #endif
+        printf("  punix:FILE              "
+               "listen on Unix domain socket FILE\n");
     }
 
 #ifdef HAVE_OPENSSL
@@ -140,28 +157,31 @@ vconn_open(const char *name, struct vconn **vconnp)
 
     check_vconn_classes();
 
+    *vconnp = NULL;
     prefix_len = strcspn(name, ":");
     if (prefix_len == strlen(name)) {
-        fatal(0, "`%s' not correct format for peer name", name);
+        error(0, "`%s' not correct format for peer name", name);
+        return EAFNOSUPPORT;
     }
     for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
         struct vconn_class *class = vconn_classes[i];
         if (strlen(class->name) == prefix_len
             && !memcmp(class->name, name, prefix_len)) {
+            struct vconn *vconn;
             char *suffix_copy = xstrdup(name + prefix_len + 1);
-            int retval = class->open(name, suffix_copy, vconnp);
+            int retval = class->open(name, suffix_copy, &vconn);
             free(suffix_copy);
-            if (retval) {
-                *vconnp = NULL;
-            } else {
-                assert((*vconnp)->connect_status != EAGAIN
-                       || (*vconnp)->class->connect);
+            if (!retval) {
+                assert(vconn->connect_status != EAGAIN
+                       || vconn->class->connect);
+                vconn->name = xstrdup(name);
+                *vconnp = vconn;
             }
             return retval;
         }
     }
-    fatal(0, "unknown peer type `%.*s'", (int) prefix_len, name);
-    abort();
+    error(0, "unknown peer type `%.*s'", (int) prefix_len, name);
+    return EAFNOSUPPORT;
 }
 
 int
@@ -191,7 +211,9 @@ void
 vconn_close(struct vconn *vconn)
 {
     if (vconn != NULL) {
+        char *name = vconn->name;
         (vconn->class->close)(vconn);
+        free(name);
     }
 }
 
@@ -252,21 +274,35 @@ vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
 /* Tries to receive an OpenFlow message from 'vconn', which must be an active
  * vconn.  If successful, stores the received message into '*msgp' and returns
  * 0.  The caller is responsible for destroying the message with
- * buffer_delete().  On failure, returns a positive errno value and stores a
+ * ofpbuf_delete().  On failure, returns a positive errno value and stores a
  * null pointer into '*msgp'.  On normal connection close, returns EOF.
  *
  * 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 ofpbuf **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) {
+            struct ofp_header *oh;
+
+            if (VLOG_IS_DBG_ENABLED()) {
+                char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
+                VLOG_DBG_RL(&rl, "%s: received: %s", vconn->name, s);
+                free(s);
+            }
+
+            oh = ofpbuf_at_assert(*msgp, 0, sizeof *oh);
+            if (oh->version != OFP_VERSION) {
+                VLOG_ERR_RL(&rl, "%s: received OpenFlow version %02"PRIx8" "
+                            "!= expected %02x",
+                            vconn->name, oh->version, OFP_VERSION);
+                ofpbuf_delete(*msgp);
+                *msgp = NULL;
+                return EPROTO;
+            }
         }
     }
     if (retval) {
@@ -287,17 +323,19 @@ 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 ofpbuf *msg)
 {
     int retval = vconn_connect(vconn);
     if (!retval) {
+        assert(msg->size >= sizeof(struct ofp_header));
+        assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
         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);
+                VLOG_DBG_RL(&rl, "%s: sent (%s): %s", vconn->name, strerror(retval), s);
             }
             free(s);
         }
@@ -307,12 +345,11 @@ vconn_send(struct vconn *vconn, struct buffer *msg)
 
 /* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
 int
-vconn_send_block(struct vconn *vconn, struct buffer *msg)
+vconn_send_block(struct vconn *vconn, struct ofpbuf *msg)
 {
     int retval;
     while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
         vconn_send_wait(vconn);
-        VLOG_DBG("blocking on vconn send");
         poll_block();
     }
     return retval;
@@ -320,17 +357,55 @@ vconn_send_block(struct vconn *vconn, struct buffer *msg)
 
 /* Same as vconn_recv, except that it waits until a message is received. */
 int
-vconn_recv_block(struct vconn *vconn, struct buffer **msgp)
+vconn_recv_block(struct vconn *vconn, struct ofpbuf **msgp)
 {
     int retval;
     while ((retval = vconn_recv(vconn, msgp)) == EAGAIN) {
         vconn_recv_wait(vconn);
-        VLOG_DBG("blocking on vconn receive");
         poll_block();
     }
     return retval;
 }
 
+/* Sends 'request' to 'vconn' and blocks until it receives a reply with a
+ * matching transaction ID.  Returns 0 if successful, in which case the reply
+ * is stored in '*replyp' for the caller to examine and free.  Otherwise
+ * returns a positive errno value, or EOF, and sets '*replyp' to null.
+ *
+ * 'request' is always destroyed, regardless of the return value. */
+int
+vconn_transact(struct vconn *vconn, struct ofpbuf *request,
+               struct ofpbuf **replyp)
+{
+    uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
+    int error;
+
+    *replyp = NULL;
+    error = vconn_send_block(vconn, request);
+    if (error) {
+        ofpbuf_delete(request);
+        return error;
+    }
+    for (;;) {
+        uint32_t recv_xid;
+        struct ofpbuf *reply;
+
+        error = vconn_recv_block(vconn, &reply);
+        if (error) {
+            return error;
+        }
+        recv_xid = ((struct ofp_header *) reply->data)->xid;
+        if (send_xid == recv_xid) {
+            *replyp = reply;
+            return 0;
+        }
+
+        VLOG_DBG_RL(&rl, "%s: received reply with xid %08"PRIx32" != expected "
+                    "%08"PRIx32, vconn->name, recv_xid, send_xid);
+        ofpbuf_delete(reply);
+    }
+}
+
 void
 vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
 {
@@ -382,7 +457,7 @@ vconn_send_wait(struct vconn *vconn)
  * id.  Stores the new buffer in '*bufferp'.  The caller must free the buffer
  * when it is no longer needed. */
 void *
-make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp) 
+make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **bufferp) 
 {
     return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
 }
@@ -393,15 +468,15 @@ make_openflow(size_t openflow_len, uint8_t type, struct buffer **bufferp)
  * buffer when it is no longer needed. */
 void *
 make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
-                  struct buffer **bufferp)
+                  struct ofpbuf **bufferp)
 {
-    struct buffer *buffer;
+    struct ofpbuf *buffer;
     struct ofp_header *oh;
 
     assert(openflow_len >= sizeof *oh);
     assert(openflow_len <= UINT16_MAX);
-    buffer = *bufferp = buffer_new(openflow_len);
-    oh = buffer_put_uninit(buffer, openflow_len);
+    buffer = *bufferp = ofpbuf_new(openflow_len);
+    oh = ofpbuf_put_uninit(buffer, openflow_len);
     memset(oh, 0, openflow_len);
     oh->version = OFP_VERSION;
     oh->type = type;
@@ -413,25 +488,25 @@ make_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
 /* Updates the 'length' field of the OpenFlow message in 'buffer' to
  * 'buffer->size'. */
 void
-update_openflow_length(struct buffer *buffer) 
+update_openflow_length(struct ofpbuf *buffer) 
 {
-    struct ofp_header *oh = buffer_at_assert(buffer, 0, sizeof *oh);
+    struct ofp_header *oh = ofpbuf_at_assert(buffer, 0, sizeof *oh);
     oh->length = htons(buffer->size); 
 }
 
-struct buffer *
-make_add_simple_flow(const struct flow *flow,
-                     uint32_t buffer_id, uint16_t out_port, uint16_t max_idle)
+struct ofpbuf *
+make_add_flow(const struct flow *flow, uint32_t buffer_id,
+              uint16_t idle_timeout, size_t n_actions)
 {
     struct ofp_flow_mod *ofm;
-    size_t size = sizeof *ofm + sizeof ofm->actions[0];
-    struct buffer *out = buffer_new(size);
-    ofm = buffer_put_uninit(out, size);
+    size_t size = sizeof *ofm + n_actions * sizeof ofm->actions[0];
+    struct ofpbuf *out = ofpbuf_new(size);
+    ofm = ofpbuf_put_uninit(out, size);
     memset(ofm, 0, size);
     ofm->header.version = OFP_VERSION;
     ofm->header.type = OFPT_FLOW_MOD;
     ofm->header.length = htons(size);
-    ofm->match.wildcards = htons(0);
+    ofm->match.wildcards = htonl(0);
     ofm->match.in_port = flow->in_port;
     memcpy(ofm->match.dl_src, flow->dl_src, sizeof ofm->match.dl_src);
     memcpy(ofm->match.dl_dst, flow->dl_dst, sizeof ofm->match.dl_dst);
@@ -443,61 +518,75 @@ make_add_simple_flow(const struct flow *flow,
     ofm->match.tp_src = flow->tp_src;
     ofm->match.tp_dst = flow->tp_dst;
     ofm->command = htons(OFPFC_ADD);
-    ofm->max_idle = htons(max_idle);
+    ofm->idle_timeout = htons(idle_timeout);
+    ofm->hard_timeout = htons(OFP_FLOW_PERMANENT);
     ofm->buffer_id = htonl(buffer_id);
+    return out;
+}
+
+struct ofpbuf *
+make_add_simple_flow(const struct flow *flow,
+                     uint32_t buffer_id, uint16_t out_port,
+                     uint16_t idle_timeout)
+{
+    struct ofpbuf *buffer = make_add_flow(flow, buffer_id, idle_timeout, 1);
+    struct ofp_flow_mod *ofm = buffer->data;
     ofm->actions[0].type = htons(OFPAT_OUTPUT);
     ofm->actions[0].arg.output.max_len = htons(0);
     ofm->actions[0].arg.output.port = htons(out_port);
-    return out;
+    return buffer;
 }
 
-struct buffer *
-make_unbuffered_packet_out(const struct buffer *packet,
+struct ofpbuf *
+make_unbuffered_packet_out(const struct ofpbuf *packet,
                            uint16_t in_port, uint16_t out_port)
 {
     struct ofp_packet_out *opo;
-    size_t size = sizeof *opo + packet->size;
-    struct buffer *out = buffer_new(size);
-    opo = buffer_put_uninit(out, size);
+    size_t size = sizeof *opo + sizeof opo->actions[0];
+    struct ofpbuf *out = ofpbuf_new(size + packet->size);
+    opo = ofpbuf_put_uninit(out, size);
     memset(opo, 0, sizeof *opo);
     opo->header.version = OFP_VERSION;
     opo->header.type = OFPT_PACKET_OUT;
-    opo->header.length = htons(size);
     opo->buffer_id = htonl(UINT32_MAX);
     opo->in_port = htons(in_port);
-    opo->out_port = htons(out_port);
-    memcpy(opo->u.data, packet->data, packet->size);
+    opo->n_actions = htons(1);
+    opo->actions[0].type = htons(OFPAT_OUTPUT);
+    opo->actions[0].arg.output.max_len = htons(0);
+    opo->actions[0].arg.output.port = htons(out_port);
+    ofpbuf_put(out, packet->data, packet->size);
+    update_openflow_length(out);
     return out;
 }
 
-struct buffer *
+struct ofpbuf *
 make_buffered_packet_out(uint32_t buffer_id,
                          uint16_t in_port, uint16_t out_port)
 {
     struct ofp_packet_out *opo;
-    size_t size = sizeof *opo + sizeof opo->u.actions[0];
-    struct buffer *out = buffer_new(size);
-    opo = buffer_put_uninit(out, size);
+    size_t size = sizeof *opo + sizeof opo->actions[0];
+    struct ofpbuf *out = ofpbuf_new(size);
+    opo = ofpbuf_put_uninit(out, size);
     memset(opo, 0, size);
     opo->header.version = OFP_VERSION;
     opo->header.type = OFPT_PACKET_OUT;
     opo->header.length = htons(size);
     opo->buffer_id = htonl(buffer_id);
     opo->in_port = htons(in_port);
-    opo->out_port = htons(out_port);
-    opo->u.actions[0].type = htons(OFPAT_OUTPUT);
-    opo->u.actions[0].arg.output.max_len = htons(0);
-    opo->u.actions[0].arg.output.port = htons(out_port);
+    opo->n_actions = htons(1);
+    opo->actions[0].type = htons(OFPAT_OUTPUT);
+    opo->actions[0].arg.output.max_len = htons(0);
+    opo->actions[0].arg.output.port = htons(out_port);
     return out;
 }
 
 /* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
-struct buffer *
+struct ofpbuf *
 make_echo_request(void)
 {
     struct ofp_header *rq;
-    struct buffer *out = buffer_new(sizeof *rq);
-    rq = buffer_put_uninit(out, sizeof *rq);
+    struct ofpbuf *out = ofpbuf_new(sizeof *rq);
+    rq = ofpbuf_put_uninit(out, sizeof *rq);
     rq->version = OFP_VERSION;
     rq->type = OFPT_ECHO_REQUEST;
     rq->length = htons(sizeof *rq);
@@ -507,12 +596,23 @@ make_echo_request(void)
 
 /* Creates and returns an OFPT_ECHO_REPLY message matching the
  * OFPT_ECHO_REQUEST message in 'rq'. */
-struct buffer *
+struct ofpbuf *
 make_echo_reply(const struct ofp_header *rq)
 {
     size_t size = ntohs(rq->length);
-    struct buffer *out = buffer_new(size);
-    struct ofp_header *reply = buffer_put(out, rq, size);
+    struct ofpbuf *out = ofpbuf_new(size);
+    struct ofp_header *reply = ofpbuf_put(out, rq, size);
     reply->type = OFPT_ECHO_REPLY;
     return out;
 }
+
+void
+vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
+           uint32_t ip, const char *name)
+{
+    vconn->class = class;
+    vconn->connect_status = connect_status;
+    vconn->ip = ip;
+    vconn->name = xstrdup(name);
+}
+