/*
- * Copyright (c) 2008, 2009, 2010 Nicira Networks.
+ * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
#include <config.h>
#include "vconn-provider.h"
-#include <assert.h>
#include <errno.h>
#include <inttypes.h>
#include <netinet/in.h>
#include "dynamic-string.h"
#include "fatal-signal.h"
#include "flow.h"
+#include "ofp-errors.h"
+#include "ofp-msgs.h"
#include "ofp-print.h"
#include "ofp-util.h"
#include "ofpbuf.h"
#include "poll-loop.h"
#include "random.h"
#include "util.h"
+#include "openvswitch/vlog.h"
+#include "socket-util.h"
-#define THIS_MODULE VLM_vconn
-#include "vlog.h"
+VLOG_DEFINE_THIS_MODULE(vconn);
+
+COVERAGE_DEFINE(vconn_open);
+COVERAGE_DEFINE(vconn_received);
+COVERAGE_DEFINE(vconn_sent);
/* State of an active vconn.*/
enum vconn_state {
VCS_DISCONNECTED /* Connection failed or connection closed. */
};
-static struct vconn_class *vconn_classes[] = {
+static const struct vconn_class *vconn_classes[] = {
&tcp_vconn_class,
&unix_vconn_class,
#ifdef HAVE_OPENSSL
#endif
};
-static struct pvconn_class *pvconn_classes[] = {
+static const struct pvconn_class *pvconn_classes[] = {
&ptcp_pvconn_class,
&punix_pvconn_class,
#ifdef HAVE_OPENSSL
size_t i;
for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
- struct vconn_class *class = vconn_classes[i];
- assert(class->name != NULL);
- assert(class->open != NULL);
+ const struct vconn_class *class = vconn_classes[i];
+ ovs_assert(class->name != NULL);
+ ovs_assert(class->open != NULL);
if (class->close || class->recv || class->send
|| class->run || class->run_wait || class->wait) {
- assert(class->close != NULL);
- assert(class->recv != NULL);
- assert(class->send != NULL);
- assert(class->wait != NULL);
+ ovs_assert(class->close != NULL);
+ ovs_assert(class->recv != NULL);
+ ovs_assert(class->send != NULL);
+ ovs_assert(class->wait != NULL);
} else {
/* This class delegates to another one. */
}
}
for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
- struct pvconn_class *class = pvconn_classes[i];
- assert(class->name != NULL);
- assert(class->listen != NULL);
+ const struct pvconn_class *class = pvconn_classes[i];
+ ovs_assert(class->name != NULL);
+ ovs_assert(class->listen != NULL);
if (class->close || class->accept || class->wait) {
- assert(class->close != NULL);
- assert(class->accept != NULL);
- assert(class->wait != NULL);
+ ovs_assert(class->close != NULL);
+ ovs_assert(class->accept != NULL);
+ ovs_assert(class->wait != NULL);
} else {
/* This class delegates to another one. */
}
/* 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");
- printf(" tcp:IP[:PORT] "
- "PORT (default: %d) at remote IP\n", OFP_TCP_PORT);
+ printf(" tcp:IP[:PORT] "
+ "PORT (default: %d) at remote IP\n", OFP_PORT);
#ifdef HAVE_OPENSSL
- printf(" ssl:IP[:PORT] "
- "SSL PORT (default: %d) at remote IP\n", OFP_SSL_PORT);
+ printf(" ssl:IP[:PORT] "
+ "SSL PORT (default: %d) at remote IP\n", OFP_PORT);
#endif
printf(" unix:FILE Unix domain socket named FILE\n");
}
printf("Passive OpenFlow connection methods:\n");
printf(" ptcp:[PORT][:IP] "
"listen to TCP PORT (default: %d) on IP\n",
- OFP_TCP_PORT);
+ OFP_PORT);
#ifdef HAVE_OPENSSL
printf(" pssl:[PORT][:IP] "
"listen for SSL on PORT (default: %d) on IP\n",
- OFP_SSL_PORT);
+ OFP_PORT);
#endif
printf(" punix:FILE "
"listen on Unix domain socket FILE\n");
* a null pointer into '*classp' if 'name' is in the wrong form or if no such
* class exists. */
static int
-vconn_lookup_class(const char *name, struct vconn_class **classp)
+vconn_lookup_class(const char *name, const struct vconn_class **classp)
{
size_t prefix_len;
size_t i;
for (i = 0; i < ARRAY_SIZE(vconn_classes); i++) {
- struct vconn_class *class = vconn_classes[i];
+ const struct vconn_class *class = vconn_classes[i];
if (strlen(class->name) == prefix_len
&& !memcmp(class->name, name, prefix_len)) {
*classp = class;
int
vconn_verify_name(const char *name)
{
- struct vconn_class *class;
+ const struct vconn_class *class;
return vconn_lookup_class(name, &class);
}
*
* The vconn will automatically negotiate an OpenFlow protocol version
* acceptable to both peers on the connection. The version negotiated will be
- * no lower than 'min_version' and no higher than OFP_VERSION.
+ * one of those in the 'allowed_versions' bitmap: version 'x' is allowed if
+ * allowed_versions & (1 << x) is nonzero. If 'allowed_versions' is zero, then
+ * OFPUTIL_DEFAULT_VERSIONS are allowed.
*
* Returns 0 if successful, otherwise a positive errno value. If successful,
* stores a pointer to the new connection in '*vconnp', otherwise a null
* pointer. */
int
-vconn_open(const char *name, int min_version, struct vconn **vconnp)
+vconn_open(const char *name, uint32_t allowed_versions, uint8_t dscp,
+ struct vconn **vconnp)
{
- struct vconn_class *class;
+ const struct vconn_class *class;
struct vconn *vconn;
char *suffix_copy;
int error;
COVERAGE_INC(vconn_open);
check_vconn_classes();
+ if (!allowed_versions) {
+ allowed_versions = OFPUTIL_DEFAULT_VERSIONS;
+ }
+
/* Look up the class. */
error = vconn_lookup_class(name, &class);
if (!class) {
/* Call class's "open" function. */
suffix_copy = xstrdup(strchr(name, ':') + 1);
- error = class->open(name, suffix_copy, &vconn);
+ error = class->open(name, allowed_versions, suffix_copy, &vconn, dscp);
free(suffix_copy);
if (error) {
goto error;
}
/* Success. */
- assert(vconn->state != VCS_CONNECTING || vconn->class->connect);
- vconn->min_version = min_version;
+ ovs_assert(vconn->state != VCS_CONNECTING || vconn->vclass->connect);
*vconnp = vconn;
return 0;
void
vconn_run(struct vconn *vconn)
{
- if (vconn->class->run) {
- (vconn->class->run)(vconn);
+ if (vconn->state == VCS_CONNECTING ||
+ vconn->state == VCS_SEND_HELLO ||
+ vconn->state == VCS_RECV_HELLO) {
+ vconn_connect(vconn);
+ }
+
+ if (vconn->vclass->run) {
+ (vconn->vclass->run)(vconn);
}
}
void
vconn_run_wait(struct vconn *vconn)
{
- if (vconn->class->run_wait) {
- (vconn->class->run_wait)(vconn);
+ if (vconn->state == VCS_CONNECTING ||
+ vconn->state == VCS_SEND_HELLO ||
+ vconn->state == VCS_RECV_HELLO) {
+ vconn_connect_wait(vconn);
+ }
+
+ if (vconn->vclass->run_wait) {
+ (vconn->vclass->run_wait)(vconn);
}
}
+/* Returns 0 if 'vconn' is healthy (connecting or connected), a positive errno
+ * value if the connection died abnormally (connection failed or aborted), or
+ * EOF if the connection was closed in a normal way. */
int
-vconn_open_block(const char *name, int min_version, struct vconn **vconnp)
+vconn_get_status(const struct vconn *vconn)
+{
+ return vconn->error == EAGAIN ? 0 : vconn->error;
+}
+
+int
+vconn_open_block(const char *name, uint32_t allowed_versions, uint8_t dscp,
+ struct vconn **vconnp)
{
struct vconn *vconn;
int error;
fatal_signal_run();
- error = vconn_open(name, min_version, &vconn);
+ error = vconn_open(name, allowed_versions, dscp, &vconn);
if (!error) {
- while ((error == vconn_connect(vconn)) == EAGAIN) {
- vconn_run(vconn);
- vconn_run_wait(vconn);
- vconn_connect_wait(vconn);
- poll_block();
- }
- assert(error != EINPROGRESS);
+ error = vconn_connect_block(vconn);
}
if (error) {
{
if (vconn != NULL) {
char *name = vconn->name;
- (vconn->class->close)(vconn);
+ (vconn->vclass->close)(vconn);
free(name);
}
}
return vconn->name;
}
-/* 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. */
+/* Returns the allowed_versions of 'vconn', that is,
+ * the allowed_versions passed to vconn_open(). */
uint32_t
-vconn_get_remote_ip(const struct vconn *vconn)
+vconn_get_allowed_versions(const struct vconn *vconn)
{
- return vconn->remote_ip;
+ return vconn->allowed_versions;
}
-/* 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
-vconn_get_remote_port(const struct vconn *vconn)
+/* Sets the allowed_versions of 'vconn', overriding
+ * the allowed_versions passed to vconn_open(). */
+void
+vconn_set_allowed_versions(struct vconn *vconn, uint32_t allowed_versions)
{
- return vconn->remote_port;
+ vconn->allowed_versions = allowed_versions;
}
-/* 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
-vconn_get_local_ip(const struct vconn *vconn)
+/* Returns the OpenFlow version negotiated with the peer, or -1 if version
+ * negotiation is not yet complete.
+ *
+ * A vconn that has successfully connected (that is, vconn_connect() or
+ * vconn_send() or vconn_recv() has returned 0) always negotiated a version. */
+int
+vconn_get_version(const struct vconn *vconn)
{
- return vconn->local_ip;
+ return vconn->version ? vconn->version : -1;
}
-/* 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
-vconn_get_local_port(const struct vconn *vconn)
+/* By default, a vconn accepts only OpenFlow messages whose version matches the
+ * one negotiated for the connection. A message received with a different
+ * version is an error that causes the vconn to drop the connection.
+ *
+ * This functions allows 'vconn' to accept messages with any OpenFlow version.
+ * This is useful in the special case where 'vconn' is used as an rconn
+ * "monitor" connection (see rconn_add_monitor()), that is, where 'vconn' is
+ * used as a target for mirroring OpenFlow messages for debugging and
+ * troubleshooting.
+ *
+ * This function should be called after a successful vconn_open() or
+ * pvconn_accept() but before the connection completes, that is, before
+ * vconn_connect() returns success. Otherwise, messages that arrive on 'vconn'
+ * beforehand with an unexpected version will the vconn to drop the
+ * connection. */
+void
+vconn_set_recv_any_version(struct vconn *vconn)
{
- return vconn->local_port;
+ vconn->recv_any_version = true;
}
static void
-vcs_connecting(struct vconn *vconn)
+vcs_connecting(struct vconn *vconn)
{
- int retval = (vconn->class->connect)(vconn);
- assert(retval != EINPROGRESS);
+ int retval = (vconn->vclass->connect)(vconn);
+ ovs_assert(retval != EINPROGRESS);
if (!retval) {
vconn->state = VCS_SEND_HELLO;
} else if (retval != EAGAIN) {
struct ofpbuf *b;
int retval;
- make_openflow(sizeof(struct ofp_header), OFPT_HELLO, &b);
+ b = ofputil_encode_hello(vconn->allowed_versions);
retval = do_send(vconn, b);
if (!retval) {
vconn->state = VCS_RECV_HELLO;
}
}
+static char *
+version_bitmap_to_string(uint32_t bitmap)
+{
+ struct ds s;
+
+ ds_init(&s);
+ if (!bitmap) {
+ ds_put_cstr(&s, "no versions");
+ } else if (is_pow2(bitmap)) {
+ ds_put_cstr(&s, "version ");
+ ofputil_format_version(&s, leftmost_1bit_idx(bitmap));
+ } else if (is_pow2((bitmap >> 1) + 1)) {
+ ds_put_cstr(&s, "version ");
+ ofputil_format_version(&s, leftmost_1bit_idx(bitmap));
+ ds_put_cstr(&s, " and earlier");
+ } else {
+ ds_put_cstr(&s, "versions ");
+ ofputil_format_version_bitmap(&s, bitmap);
+ }
+ return ds_steal_cstr(&s);
+}
+
static void
vcs_recv_hello(struct vconn *vconn)
{
retval = do_recv(vconn, &b);
if (!retval) {
- struct ofp_header *oh = b->data;
+ enum ofptype type;
+ enum ofperr error;
- if (oh->type == OFPT_HELLO) {
- if (b->size > sizeof *oh) {
+ error = ofptype_decode(&type, b->data);
+ if (!error && type == OFPTYPE_HELLO) {
+ char *peer_s, *local_s;
+ uint32_t common_versions;
+
+ if (!ofputil_decode_hello(b->data, &vconn->peer_versions)) {
struct ds msg = DS_EMPTY_INITIALIZER;
- ds_put_format(&msg, "%s: extra-long hello:\n", vconn->name);
+ ds_put_format(&msg, "%s: unknown data in hello:\n",
+ vconn->name);
ds_put_hex_dump(&msg, b->data, b->size, 0, true);
VLOG_WARN_RL(&bad_ofmsg_rl, "%s", ds_cstr(&msg));
ds_destroy(&msg);
}
- vconn->version = MIN(OFP_VERSION, oh->version);
- if (vconn->version < vconn->min_version) {
+ local_s = version_bitmap_to_string(vconn->allowed_versions);
+ peer_s = version_bitmap_to_string(vconn->peer_versions);
+
+ common_versions = vconn->peer_versions & vconn->allowed_versions;
+ if (!common_versions) {
+ vconn->version = leftmost_1bit_idx(vconn->peer_versions);
VLOG_WARN_RL(&bad_ofmsg_rl,
- "%s: version negotiation failed: we support "
- "versions 0x%02x to 0x%02x inclusive but peer "
- "supports no later than version 0x%02"PRIx8,
- vconn->name, vconn->min_version, OFP_VERSION,
- oh->version);
+ "%s: version negotiation failed (we support "
+ "%s, peer supports %s)",
+ vconn->name, local_s, peer_s);
vconn->state = VCS_SEND_ERROR;
} else {
+ vconn->version = leftmost_1bit_idx(common_versions);
VLOG_DBG("%s: negotiated OpenFlow version 0x%02x "
- "(we support versions 0x%02x to 0x%02x inclusive, "
- "peer no later than version 0x%02"PRIx8")",
- vconn->name, vconn->version, vconn->min_version,
- OFP_VERSION, oh->version);
+ "(we support %s, peer supports %s)", vconn->name,
+ vconn->version, local_s, peer_s);
vconn->state = VCS_CONNECTED;
}
+
+ free(local_s);
+ free(peer_s);
+
ofpbuf_delete(b);
return;
} else {
static void
vcs_send_error(struct vconn *vconn)
{
- struct ofp_error_msg *error;
struct ofpbuf *b;
char s[128];
int retval;
+ char *local_s, *peer_s;
+
+ local_s = version_bitmap_to_string(vconn->allowed_versions);
+ peer_s = version_bitmap_to_string(vconn->peer_versions);
+ snprintf(s, sizeof s, "We support %s, you support %s, no common versions.",
+ local_s, peer_s);
+ free(peer_s);
+ free(local_s);
- snprintf(s, sizeof s, "We support versions 0x%02x to 0x%02x inclusive but "
- "you support no later than version 0x%02"PRIx8".",
- vconn->min_version, OFP_VERSION, vconn->version);
- error = make_openflow(sizeof *error, OFPT_ERROR, &b);
- error->type = htons(OFPET_HELLO_FAILED);
- error->code = htons(OFPHFC_INCOMPATIBLE);
- ofpbuf_put(b, s, strlen(s));
- update_openflow_length(b);
+ b = ofperr_encode_hello(OFPERR_OFPHFC_INCOMPATIBLE, vconn->version, s);
retval = do_send(vconn, b);
if (retval) {
ofpbuf_delete(b);
}
}
-/* 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. */
+/* Tries to complete the connection on '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)
{
enum vconn_state last_state;
- assert(vconn->min_version >= 0);
do {
last_state = vconn->state;
switch (vconn->state) {
return vconn->error;
default:
- NOT_REACHED();
+ OVS_NOT_REACHED();
}
} while (vconn->state != last_state);
return EAGAIN;
}
-/* 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
- * ofpbuf_delete(). On failure, returns a positive errno value and stores a
- * null pointer into '*msgp'. On normal connection close, returns EOF.
+/* Tries to receive an OpenFlow message from 'vconn'. If successful, stores
+ * the received message into '*msgp' and returns 0. The caller is responsible
+ * for destroying the message with 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 ofpbuf **msgp)
{
- int retval = vconn_connect(vconn);
+ struct ofpbuf *msg;
+ int retval;
+
+ retval = vconn_connect(vconn);
if (!retval) {
- retval = do_recv(vconn, msgp);
+ retval = do_recv(vconn, &msg);
+ }
+ if (!retval && !vconn->recv_any_version) {
+ const struct ofp_header *oh = msg->data;
+ if (oh->version != vconn->version) {
+ enum ofptype type;
+
+ if (ofptype_decode(&type, msg->data)
+ || (type != OFPTYPE_HELLO &&
+ type != OFPTYPE_ERROR &&
+ type != OFPTYPE_ECHO_REQUEST &&
+ type != OFPTYPE_ECHO_REPLY)) {
+ struct ofpbuf *reply;
+
+ VLOG_ERR_RL(&bad_ofmsg_rl, "%s: received OpenFlow version "
+ "0x%02"PRIx8" != expected %02x",
+ vconn->name, oh->version, vconn->version);
+
+ /* Send a "bad version" reply, if we can. */
+ reply = ofperr_encode_reply(OFPERR_OFPBRC_BAD_VERSION, oh);
+ retval = vconn_send(vconn, reply);
+ if (retval) {
+ VLOG_INFO_RL(&bad_ofmsg_rl,
+ "%s: failed to queue error reply (%s)",
+ vconn->name, ovs_strerror(retval));
+ ofpbuf_delete(reply);
+ }
+
+ /* Suppress the received message, as if it had not arrived. */
+ retval = EAGAIN;
+ ofpbuf_delete(msg);
+ }
+ }
}
+
+ *msgp = retval ? NULL : msg;
return retval;
}
static int
do_recv(struct vconn *vconn, struct ofpbuf **msgp)
{
- int retval = (vconn->class->recv)(vconn, msgp);
+ int retval = (vconn->vclass->recv)(vconn, msgp);
if (!retval) {
- struct ofp_header *oh;
-
COVERAGE_INC(vconn_received);
if (VLOG_IS_DBG_ENABLED()) {
char *s = ofp_to_string((*msgp)->data, (*msgp)->size, 1);
VLOG_DBG_RL(&ofmsg_rl, "%s: received: %s", vconn->name, s);
free(s);
}
-
- oh = ofpbuf_at_assert(*msgp, 0, sizeof *oh);
- if (oh->version != vconn->version
- && oh->type != OFPT_HELLO
- && oh->type != OFPT_ERROR
- && oh->type != OFPT_ECHO_REQUEST
- && oh->type != OFPT_ECHO_REPLY
- && oh->type != OFPT_VENDOR)
- {
- if (vconn->version < 0) {
- VLOG_ERR_RL(&bad_ofmsg_rl,
- "%s: received OpenFlow message type %"PRIu8" "
- "before version negotiation complete",
- vconn->name, oh->type);
- } else {
- VLOG_ERR_RL(&bad_ofmsg_rl,
- "%s: received OpenFlow version 0x%02"PRIx8" "
- "!= expected %02x",
- vconn->name, oh->version, vconn->version);
- }
- ofpbuf_delete(*msgp);
- retval = EPROTO;
- }
- }
- if (retval) {
- *msgp = NULL;
}
return retval;
}
-/* Tries to queue 'msg' for transmission on 'vconn', which must be an active
- * vconn. If successful, returns 0, in which case ownership of 'msg' is
- * transferred to the vconn. Success does not guarantee that 'msg' has been or
- * ever will be delivered to the peer, only that it has been queued for
- * transmission.
+/* Tries to queue 'msg' for transmission on 'vconn'. If successful, returns 0,
+ * in which case ownership of 'msg' is transferred to the vconn. Success does
+ * not guarantee that 'msg' has been or ever will be delivered to the peer,
+ * only that it has been queued for transmission.
*
* Returns a positive errno value on failure, in which case the caller
* retains ownership of 'msg'.
{
int retval;
- assert(msg->size >= sizeof(struct ofp_header));
- assert(((struct ofp_header *) msg->data)->length == htons(msg->size));
+ ovs_assert(msg->size >= sizeof(struct ofp_header));
+
+ ofpmsg_update_length(msg);
if (!VLOG_IS_DBG_ENABLED()) {
COVERAGE_INC(vconn_sent);
- retval = (vconn->class->send)(vconn, msg);
+ retval = (vconn->vclass->send)(vconn, msg);
} else {
char *s = ofp_to_string(msg->data, msg->size, 1);
- retval = (vconn->class->send)(vconn, msg);
+ retval = (vconn->vclass->send)(vconn, msg);
if (retval != EAGAIN) {
VLOG_DBG_RL(&ofmsg_rl, "%s: sent (%s): %s",
- vconn->name, strerror(retval), s);
+ vconn->name, ovs_strerror(retval), s);
}
free(s);
}
return retval;
}
+/* Same as vconn_connect(), except that it waits until the connection on
+ * 'vconn' completes or fails. Thus, it will never return EAGAIN. */
+int
+vconn_connect_block(struct vconn *vconn)
+{
+ int error;
+
+ while ((error = vconn_connect(vconn)) == EAGAIN) {
+ vconn_run(vconn);
+ vconn_run_wait(vconn);
+ vconn_connect_wait(vconn);
+ poll_block();
+ }
+ ovs_assert(error != EINPROGRESS);
+
+ return error;
+}
+
/* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
int
vconn_send_block(struct vconn *vconn, struct ofpbuf *msg)
return retval;
}
-/* Waits until a message with a transaction ID matching 'xid' is recived on
- * 'vconn'. 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_recv_xid(struct vconn *vconn, uint32_t xid, struct ofpbuf **replyp)
+static int
+vconn_recv_xid__(struct vconn *vconn, ovs_be32 xid, struct ofpbuf **replyp,
+ void (*error_reporter)(const struct ofp_header *))
{
for (;;) {
- uint32_t recv_xid;
+ ovs_be32 recv_xid;
struct ofpbuf *reply;
+ const struct ofp_header *oh;
+ enum ofptype type;
int error;
error = vconn_recv_block(vconn, &reply);
*replyp = NULL;
return error;
}
- recv_xid = ((struct ofp_header *) reply->data)->xid;
+ oh = reply->data;
+ recv_xid = oh->xid;
if (xid == recv_xid) {
*replyp = reply;
return 0;
}
- VLOG_DBG_RL(&bad_ofmsg_rl, "%s: received reply with xid %08"PRIx32
- " != expected %08"PRIx32, vconn->name, recv_xid, xid);
+ error = ofptype_decode(&type, oh);
+ if (!error && type == OFPTYPE_ERROR && error_reporter) {
+ error_reporter(oh);
+ } else {
+ VLOG_DBG_RL(&bad_ofmsg_rl, "%s: received reply with xid %08"PRIx32
+ " != expected %08"PRIx32,
+ vconn->name, ntohl(recv_xid), ntohl(xid));
+ }
ofpbuf_delete(reply);
}
}
+/* Waits until a message with a transaction ID matching 'xid' is received on
+ * 'vconn'. 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_recv_xid(struct vconn *vconn, ovs_be32 xid, struct ofpbuf **replyp)
+{
+ return vconn_recv_xid__(vconn, xid, replyp, NULL);
+}
+
+static int
+vconn_transact__(struct vconn *vconn, struct ofpbuf *request,
+ struct ofpbuf **replyp,
+ void (*error_reporter)(const struct ofp_header *))
+{
+ ovs_be32 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 ? error : vconn_recv_xid__(vconn, send_xid, replyp,
+ error_reporter);
+}
+
/* 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' should be an OpenFlow request that requires a reply. Otherwise,
+ * if there is no reply, this function can end up blocking forever (or until
+ * the peer drops the connection).
+ *
* '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;
+ return vconn_transact__(vconn, request, replyp, NULL);
+}
+
+/* Sends 'request' followed by a barrier request to 'vconn', then blocks until
+ * it receives a reply to the barrier. If successful, stores the reply to
+ * 'request' in '*replyp', if one was received, and otherwise NULL, then
+ * returns 0. Otherwise returns a positive errno value, or EOF, and sets
+ * '*replyp' to null.
+ *
+ * This function is useful for sending an OpenFlow request that doesn't
+ * ordinarily include a reply but might report an error in special
+ * circumstances.
+ *
+ * 'request' is always destroyed, regardless of the return value. */
+int
+vconn_transact_noreply(struct vconn *vconn, struct ofpbuf *request,
+ struct ofpbuf **replyp)
+{
+ ovs_be32 request_xid;
+ ovs_be32 barrier_xid;
+ struct ofpbuf *barrier;
int error;
*replyp = NULL;
+
+ /* Send request. */
+ request_xid = ((struct ofp_header *) request->data)->xid;
error = vconn_send_block(vconn, request);
if (error) {
ofpbuf_delete(request);
+ return error;
+ }
+
+ /* Send barrier. */
+ barrier = ofputil_encode_barrier_request(vconn_get_version(vconn));
+ barrier_xid = ((struct ofp_header *) barrier->data)->xid;
+ error = vconn_send_block(vconn, barrier);
+ if (error) {
+ ofpbuf_delete(barrier);
+ return error;
+ }
+
+ for (;;) {
+ struct ofpbuf *msg;
+ ovs_be32 msg_xid;
+ int error;
+
+ error = vconn_recv_block(vconn, &msg);
+ if (error) {
+ ofpbuf_delete(*replyp);
+ *replyp = NULL;
+ return error;
+ }
+
+ msg_xid = ((struct ofp_header *) msg->data)->xid;
+ if (msg_xid == request_xid) {
+ if (*replyp) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "%s: duplicate replies with "
+ "xid %08"PRIx32, vconn->name, ntohl(msg_xid));
+ ofpbuf_delete(*replyp);
+ }
+ *replyp = msg;
+ } else {
+ ofpbuf_delete(msg);
+ if (msg_xid == barrier_xid) {
+ return 0;
+ } else {
+ VLOG_DBG_RL(&bad_ofmsg_rl, "%s: reply with xid %08"PRIx32
+ " != expected %08"PRIx32" or %08"PRIx32,
+ vconn->name, ntohl(msg_xid),
+ ntohl(request_xid), ntohl(barrier_xid));
+ }
+ }
+ }
+}
+
+/* vconn_transact_noreply() for a list of "struct ofpbuf"s, sent one by one.
+ * All of the requests on 'requests' are always destroyed, regardless of the
+ * return value. */
+int
+vconn_transact_multiple_noreply(struct vconn *vconn, struct ovs_list *requests,
+ struct ofpbuf **replyp)
+{
+ struct ofpbuf *request;
+
+ LIST_FOR_EACH_POP (request, list_node, requests) {
+ int error;
+
+ error = vconn_transact_noreply(vconn, request, replyp);
+ if (error || *replyp) {
+ ofpbuf_list_delete(requests);
+ return error;
+ }
+ }
+
+ *replyp = NULL;
+ return 0;
+}
+
+static enum ofperr
+vconn_bundle_reply_validate(struct ofpbuf *reply,
+ struct ofputil_bundle_ctrl_msg *request,
+ void (*error_reporter)(const struct ofp_header *))
+{
+ const struct ofp_header *oh;
+ enum ofptype type;
+ enum ofperr error;
+ struct ofputil_bundle_ctrl_msg rbc;
+
+ oh = reply->data;
+ error = ofptype_decode(&type, oh);
+ if (error) {
+ return error;
+ }
+
+ if (type == OFPTYPE_ERROR) {
+ error_reporter(oh);
+ return ofperr_decode_msg(oh, NULL);
}
- return error ? error : vconn_recv_xid(vconn, send_xid, replyp);
+ if (type != OFPTYPE_BUNDLE_CONTROL) {
+ return OFPERR_OFPBRC_BAD_TYPE;
+ }
+
+ error = ofputil_decode_bundle_ctrl(oh, &rbc);
+ if (error) {
+ return error;
+ }
+
+ if (rbc.bundle_id != request->bundle_id) {
+ return OFPERR_OFPBFC_BAD_ID;
+ }
+
+ if (rbc.type != request->type + 1) {
+ return OFPERR_OFPBFC_BAD_TYPE;
+ }
+
+ return 0;
+}
+
+/* Send bundle control message 'bc' of 'type' via 'vconn', and wait for either
+ * an error or the corresponding bundle control message response.
+ *
+ * 'error_reporter' is called for any error responses received, which may be
+ * also regarding earlier OpenFlow messages than this bundle control message.
+ *
+ * Returns errno value, or 0 when successful. */
+static int
+vconn_bundle_control_transact(struct vconn *vconn,
+ struct ofputil_bundle_ctrl_msg *bc,
+ uint16_t type,
+ void (*error_reporter)(const struct ofp_header *))
+{
+ struct ofpbuf *request, *reply;
+ int error;
+ enum ofperr ofperr;
+
+ bc->type = type;
+ request = ofputil_encode_bundle_ctrl_request(vconn->version, bc);
+ ofpmsg_update_length(request);
+ error = vconn_transact__(vconn, request, &reply, error_reporter);
+ if (error) {
+ return error;
+ }
+
+ ofperr = vconn_bundle_reply_validate(reply, bc, error_reporter);
+ if (ofperr) {
+ VLOG_WARN_RL(&bad_ofmsg_rl, "Bundle %s failed (%s).",
+ type == OFPBCT_OPEN_REQUEST ? "open"
+ : type == OFPBCT_CLOSE_REQUEST ? "close"
+ : type == OFPBCT_COMMIT_REQUEST ? "commit"
+ : type == OFPBCT_DISCARD_REQUEST ? "discard"
+ : "control message",
+ ofperr_to_string(ofperr));
+ }
+ ofpbuf_delete(reply);
+
+ return ofperr ? EPROTO : 0;
+}
+
+/* Checks if error responses can be received on 'vconn'. */
+static void
+vconn_recv_error(struct vconn *vconn,
+ void (*error_reporter)(const struct ofp_header *))
+{
+ int error;
+
+ do {
+ struct ofpbuf *reply;
+
+ error = vconn_recv(vconn, &reply);
+ if (!error) {
+ const struct ofp_header *oh;
+ enum ofptype type;
+ enum ofperr ofperr;
+
+ oh = reply->data;
+ ofperr = ofptype_decode(&type, oh);
+ if (!ofperr && type == OFPTYPE_ERROR) {
+ error_reporter(oh);
+ } else {
+ VLOG_DBG_RL(&bad_ofmsg_rl,
+ "%s: received unexpected reply with xid %08"PRIx32,
+ vconn->name, ntohl(oh->xid));
+ }
+ ofpbuf_delete(reply);
+ }
+ } while (!error);
+}
+
+static int
+vconn_bundle_add_msg(struct vconn *vconn, struct ofputil_bundle_ctrl_msg *bc,
+ struct ofpbuf *msg,
+ void (*error_reporter)(const struct ofp_header *))
+{
+ struct ofputil_bundle_add_msg bam;
+ struct ofpbuf *request;
+ int error;
+
+ bam.bundle_id = bc->bundle_id;
+ bam.flags = bc->flags;
+ bam.msg = msg->data;
+
+ request = ofputil_encode_bundle_add(vconn->version, &bam);
+ ofpmsg_update_length(request);
+
+ error = vconn_send_block(vconn, request);
+ if (!error) {
+ /* Check for an error return, so that the socket buffer does not become
+ * full of errors. */
+ vconn_recv_error(vconn, error_reporter);
+ }
+ return error;
+}
+
+int
+vconn_bundle_transact(struct vconn *vconn, struct ovs_list *requests,
+ uint16_t flags,
+ void (*error_reporter)(const struct ofp_header *))
+{
+ struct ofputil_bundle_ctrl_msg bc;
+ struct ofpbuf *request;
+ int error;
+
+ memset(&bc, 0, sizeof bc);
+ bc.flags = flags;
+ error = vconn_bundle_control_transact(vconn, &bc, OFPBCT_OPEN_REQUEST,
+ error_reporter);
+ if (error) {
+ return error;
+ }
+
+ LIST_FOR_EACH (request, list_node, requests) {
+ error = vconn_bundle_add_msg(vconn, &bc, request, error_reporter);
+ if (error) {
+ break;
+ }
+ }
+
+ if (!error) {
+ error = vconn_bundle_control_transact(vconn, &bc,
+ OFPBCT_COMMIT_REQUEST,
+ error_reporter);
+ } else {
+ /* Do not overwrite the error code from vconn_bundle_add_msg().
+ * Any error in discard should be either reported or logged, so it
+ * should not get lost. */
+ vconn_bundle_control_transact(vconn, &bc, OFPBCT_DISCARD_REQUEST,
+ error_reporter);
+ }
+ return error;
}
void
vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
{
- assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
+ ovs_assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
switch (vconn->state) {
case VCS_CONNECTING:
poll_immediate_wake();
return;
}
- (vconn->class->wait)(vconn, wait);
+ (vconn->vclass->wait)(vconn, wait);
}
void
* a null pointer into '*classp' if 'name' is in the wrong form or if no such
* class exists. */
static int
-pvconn_lookup_class(const char *name, struct pvconn_class **classp)
+pvconn_lookup_class(const char *name, const struct pvconn_class **classp)
{
size_t prefix_len;
size_t i;
for (i = 0; i < ARRAY_SIZE(pvconn_classes); i++) {
- struct pvconn_class *class = pvconn_classes[i];
+ const struct pvconn_class *class = pvconn_classes[i];
if (strlen(class->name) == prefix_len
&& !memcmp(class->name, name, prefix_len)) {
*classp = class;
int
pvconn_verify_name(const char *name)
{
- struct pvconn_class *class;
+ const struct pvconn_class *class;
return pvconn_lookup_class(name, &class);
}
* connection name in the form "TYPE:ARGS", where TYPE is an passive vconn
* class's name and ARGS are vconn class-specific.
*
+ * vconns accepted by the pvconn will automatically negotiate an OpenFlow
+ * protocol version acceptable to both peers on the connection. The version
+ * negotiated will be one of those in the 'allowed_versions' bitmap: version
+ * 'x' is allowed if allowed_versions & (1 << x) is nonzero. If
+ * 'allowed_versions' is zero, then OFPUTIL_DEFAULT_VERSIONS are allowed.
+ *
* Returns 0 if successful, otherwise a positive errno value. If successful,
* stores a pointer to the new connection in '*pvconnp', otherwise a null
* pointer. */
int
-pvconn_open(const char *name, struct pvconn **pvconnp)
+pvconn_open(const char *name, uint32_t allowed_versions, uint8_t dscp,
+ struct pvconn **pvconnp)
{
- struct pvconn_class *class;
+ const struct pvconn_class *class;
struct pvconn *pvconn;
char *suffix_copy;
int error;
check_vconn_classes();
+ if (!allowed_versions) {
+ allowed_versions = OFPUTIL_DEFAULT_VERSIONS;
+ }
+
/* Look up the class. */
error = pvconn_lookup_class(name, &class);
if (!class) {
/* Call class's "open" function. */
suffix_copy = xstrdup(strchr(name, ':') + 1);
- error = class->listen(name, suffix_copy, &pvconn);
+ error = class->listen(name, allowed_versions, suffix_copy, &pvconn, dscp);
free(suffix_copy);
if (error) {
goto error;
{
if (pvconn != NULL) {
char *name = pvconn->name;
- (pvconn->class->close)(pvconn);
+ (pvconn->pvclass->close)(pvconn);
free(name);
}
}
*
* The new vconn will automatically negotiate an OpenFlow protocol version
* acceptable to both peers on the connection. The version negotiated will be
- * no lower than 'min_version' and no higher than OFP_VERSION.
+ * no lower than 'min_version' and no higher than 'max_version'.
*
* pvconn_accept() will not block waiting for a connection. If no connection
* is ready to be accepted, it returns EAGAIN immediately. */
int
-pvconn_accept(struct pvconn *pvconn, int min_version, struct vconn **new_vconn)
+pvconn_accept(struct pvconn *pvconn, struct vconn **new_vconn)
{
- int retval = (pvconn->class->accept)(pvconn, new_vconn);
+ int retval = (pvconn->pvclass->accept)(pvconn, new_vconn);
if (retval) {
*new_vconn = NULL;
} else {
- assert((*new_vconn)->state != VCS_CONNECTING
- || (*new_vconn)->class->connect);
- (*new_vconn)->min_version = min_version;
+ ovs_assert((*new_vconn)->state != VCS_CONNECTING
+ || (*new_vconn)->vclass->connect);
}
return retval;
}
void
pvconn_wait(struct pvconn *pvconn)
{
- (pvconn->class->wait)(pvconn);
+ (pvconn->pvclass->wait)(pvconn);
}
/* Initializes 'vconn' as a new vconn named 'name', implemented via 'class'.
*
* The caller retains ownership of 'name'. */
void
-vconn_init(struct vconn *vconn, struct vconn_class *class, int connect_status,
- const char *name)
+vconn_init(struct vconn *vconn, const struct vconn_class *class,
+ int connect_status, const char *name, uint32_t allowed_versions)
{
- vconn->class = class;
+ memset(vconn, 0, sizeof *vconn);
+ vconn->vclass = class;
vconn->state = (connect_status == EAGAIN ? VCS_CONNECTING
: !connect_status ? VCS_SEND_HELLO
: VCS_DISCONNECTED);
vconn->error = connect_status;
- vconn->version = -1;
- vconn->min_version = -1;
- vconn->remote_ip = 0;
- vconn->remote_port = 0;
- vconn->local_ip = 0;
- vconn->local_port = 0;
+ vconn->allowed_versions = allowed_versions;
vconn->name = xstrdup(name);
- assert(vconn->state != VCS_CONNECTING || class->connect);
-}
-
-void
-vconn_set_remote_ip(struct vconn *vconn, uint32_t ip)
-{
- vconn->remote_ip = ip;
-}
-
-void
-vconn_set_remote_port(struct vconn *vconn, uint16_t port)
-{
- vconn->remote_port = port;
-}
-
-void
-vconn_set_local_ip(struct vconn *vconn, uint32_t ip)
-{
- vconn->local_ip = ip;
-}
-
-void
-vconn_set_local_port(struct vconn *vconn, uint16_t port)
-{
- vconn->local_port = port;
+ ovs_assert(vconn->state != VCS_CONNECTING || class->connect);
}
void
-pvconn_init(struct pvconn *pvconn, struct pvconn_class *class,
- const char *name)
+pvconn_init(struct pvconn *pvconn, const struct pvconn_class *class,
+ const char *name, uint32_t allowed_versions)
{
- pvconn->class = class;
+ pvconn->pvclass = class;
pvconn->name = xstrdup(name);
+ pvconn->allowed_versions = allowed_versions;
}
projects / cascardo / ovs.git / blobdiff