#include <poll.h>
#include <stdlib.h>
#include <string.h>
-#include "buffer.h"
+#include "dynamic-string.h"
#include "flow.h"
#include "ofp-print.h"
+#include "ofpbuf.h"
#include "openflow.h"
#include "poll-loop.h"
#include "random.h"
#define THIS_MODULE VLM_vconn
#include "vlog.h"
+/* State of an active vconn.*/
+enum vconn_state {
+ /* This is the ordinary progression of states. */
+ VCS_CONNECTING, /* Underlying vconn is not connected. */
+ VCS_SEND_HELLO, /* Waiting to send OFPT_HELLO message. */
+ VCS_RECV_HELLO, /* Waiting to receive OFPT_HELLO message. */
+ VCS_CONNECTED, /* Connection established. */
+
+ /* These states are entered only when something goes wrong. */
+ VCS_SEND_ERROR, /* Sending OFPT_ERROR message. */
+ VCS_DISCONNECTED /* Connection failed or connection closed. */
+};
+
static struct vconn_class *vconn_classes[] = {
&tcp_vconn_class,
&unix_vconn_class,
* really need to see them. */
static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(600, 600);
+static int do_recv(struct vconn *, struct ofpbuf **);
+static int do_send(struct vconn *, struct ofpbuf *);
+
/* Check the validity of the vconn class structures. */
static void
check_vconn_classes(void)
}
/* Prints information on active (if 'active') and passive (if 'passive')
- * connection methods supported by the vconn. */
+ * connection methods supported by the vconn. If 'bootstrap' is true, also
+ * advertises options to bootstrap the CA certificate. */
void
-vconn_usage(bool active, bool passive)
+vconn_usage(bool active, bool passive, bool bootstrap UNUSED)
{
/* Really this should be implemented via callbacks into the vconn
* providers, but that seems too heavy-weight to bother with at the
" -p, --private-key=FILE file with private key\n"
" -c, --certificate=FILE file with certificate for private key\n"
" -C, --ca-cert=FILE file with peer CA certificate\n");
+ if (bootstrap) {
+ printf(" --bootstrap-ca-cert=FILE file with peer CA certificate "
+ "to read or create\n");
+ }
#endif
}
* the form "TYPE:ARGS", where TYPE is an active vconn class's name and ARGS
* are vconn class-specific.
*
+ * 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.
+ *
* 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, struct vconn **vconnp)
+vconn_open(const char *name, int min_version, struct vconn **vconnp)
{
size_t prefix_len;
size_t i;
int retval = class->open(name, suffix_copy, &vconn);
free(suffix_copy);
if (!retval) {
- assert(vconn->connect_status != EAGAIN
+ assert(vconn->state != VCS_CONNECTING
|| vconn->class->connect);
+ vconn->min_version = min_version;
*vconnp = vconn;
}
return retval;
}
int
-vconn_open_block(const char *name, struct vconn **vconnp)
+vconn_open_block(const char *name, int min_version, struct vconn **vconnp)
{
struct vconn *vconn;
int error;
- error = vconn_open(name, &vconn);
+ error = vconn_open(name, min_version, &vconn);
while (error == EAGAIN) {
vconn_connect_wait(vconn);
poll_block();
return vconn->ip;
}
+static void
+vcs_connecting(struct vconn *vconn)
+{
+ int retval = (vconn->class->connect)(vconn);
+ assert(retval != EINPROGRESS);
+ if (!retval) {
+ vconn->state = VCS_SEND_HELLO;
+ } else if (retval != EAGAIN) {
+ vconn->state = VCS_DISCONNECTED;
+ vconn->error = retval;
+ }
+}
+
+static void
+vcs_send_hello(struct vconn *vconn)
+{
+ struct ofpbuf *b;
+ int retval;
+
+ make_openflow(sizeof(struct ofp_header), OFPT_HELLO, &b);
+ retval = do_send(vconn, b);
+ if (!retval) {
+ vconn->state = VCS_RECV_HELLO;
+ } else {
+ ofpbuf_delete(b);
+ if (retval != EAGAIN) {
+ vconn->state = VCS_DISCONNECTED;
+ vconn->error = retval;
+ }
+ }
+}
+
+static void
+vcs_recv_hello(struct vconn *vconn)
+{
+ struct ofpbuf *b;
+ int retval;
+
+ retval = do_recv(vconn, &b);
+ if (!retval) {
+ struct ofp_header *oh = b->data;
+
+ if (oh->type == OFPT_HELLO) {
+ if (b->size > sizeof *oh) {
+ struct ds msg = DS_EMPTY_INITIALIZER;
+ ds_put_format(&msg, "%s: extra-long hello:\n", vconn->name);
+ ds_put_hex_dump(&msg, b->data, b->size, 0, true);
+ VLOG_WARN_RL(&rl, ds_cstr(&msg));
+ ds_destroy(&msg);
+ }
+
+ vconn->version = MIN(OFP_VERSION, oh->version);
+ if (vconn->version < vconn->min_version) {
+ VLOG_WARN_RL(&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);
+ vconn->state = VCS_SEND_ERROR;
+ } else {
+ 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);
+ vconn->state = VCS_CONNECTED;
+ }
+ ofpbuf_delete(b);
+ return;
+ } else {
+ char *s = ofp_to_string(b->data, b->size, 1);
+ VLOG_WARN_RL(&rl, "%s: received message while expecting hello: %s",
+ vconn->name, s);
+ free(s);
+ retval = EPROTO;
+ ofpbuf_delete(b);
+ }
+ }
+
+ if (retval != EAGAIN) {
+ vconn->state = VCS_DISCONNECTED;
+ vconn->error = retval;
+ }
+}
+
+static void
+vcs_send_error(struct vconn *vconn)
+{
+ struct ofp_error_msg *error;
+ struct ofpbuf *b;
+ char s[128];
+ int retval;
+
+ 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));
+ retval = do_send(vconn, b);
+ if (retval) {
+ ofpbuf_delete(b);
+ }
+ if (retval != EAGAIN) {
+ vconn->state = VCS_DISCONNECTED;
+ vconn->error = retval ? retval : EPROTO;
+ }
+}
+
/* 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
int
vconn_connect(struct vconn *vconn)
{
- if (vconn->connect_status == EAGAIN) {
- vconn->connect_status = (vconn->class->connect)(vconn);
- assert(vconn->connect_status != EINPROGRESS);
- }
- return vconn->connect_status;
+ enum vconn_state last_state;
+
+ assert(vconn->min_version >= 0);
+ do {
+ last_state = vconn->state;
+ switch (vconn->state) {
+ case VCS_CONNECTING:
+ vcs_connecting(vconn);
+ break;
+
+ case VCS_SEND_HELLO:
+ vcs_send_hello(vconn);
+ break;
+
+ case VCS_RECV_HELLO:
+ vcs_recv_hello(vconn);
+ break;
+
+ case VCS_CONNECTED:
+ return 0;
+
+ case VCS_SEND_ERROR:
+ vcs_send_error(vconn);
+ break;
+
+ case VCS_DISCONNECTED:
+ return vconn->error;
+
+ default:
+ 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
- * 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 (!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);
- }
+ retval = do_recv(vconn, msgp);
+ }
+ return retval;
+}
+
+static int
+do_recv(struct vconn *vconn, struct ofpbuf **msgp)
+{
+ int retval;
+
+ retval = (vconn->class->recv)(vconn, msgp);
+ 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 = buffer_at_assert(*msgp, 0, sizeof *oh);
- if (oh->version != OFP_VERSION) {
+ 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(&rl, "%s: received OpenFlow version %02"PRIx8" "
+ "before version negotiation complete",
+ vconn->name, oh->version);
+ } else {
VLOG_ERR_RL(&rl, "%s: received OpenFlow version %02"PRIx8" "
"!= expected %02x",
- vconn->name, oh->version, OFP_VERSION);
- buffer_delete(*msgp);
- *msgp = NULL;
- return EPROTO;
+ vconn->name, oh->version, vconn->version);
}
+ ofpbuf_delete(*msgp);
+ retval = EPROTO;
}
}
if (retval) {
* 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_RL(&rl, "%s: sent (%s): %s", vconn->name, strerror(retval), s);
- }
- free(s);
+ retval = do_send(vconn, msg);
+ }
+ return retval;
+}
+
+static int
+do_send(struct vconn *vconn, struct ofpbuf *msg)
+{
+ int 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_RL(&rl, "%s: sent (%s): %s",
+ vconn->name, strerror(retval), s);
}
+ free(s);
}
return retval;
}
/* 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) {
/* 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) {
*
* 'request' is always destroyed, regardless of the return value. */
int
-vconn_transact(struct vconn *vconn, struct buffer *request,
- struct buffer **replyp)
+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) {
- buffer_delete(request);
+ ofpbuf_delete(request);
return error;
}
for (;;) {
uint32_t recv_xid;
- struct buffer *reply;
+ struct ofpbuf *reply;
error = vconn_recv_block(vconn, &reply);
if (error) {
VLOG_DBG_RL(&rl, "%s: received reply with xid %08"PRIx32" != expected "
"%08"PRIx32, vconn->name, recv_xid, send_xid);
- buffer_delete(reply);
+ ofpbuf_delete(reply);
}
}
void
vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
{
- int connect_status;
-
assert(wait == WAIT_CONNECT || wait == WAIT_RECV || wait == WAIT_SEND);
- connect_status = vconn_connect(vconn);
- if (connect_status) {
- if (connect_status == EAGAIN) {
- wait = WAIT_CONNECT;
- } else {
- poll_immediate_wake();
- return;
- }
- }
+ switch (vconn->state) {
+ case VCS_CONNECTING:
+ wait = WAIT_CONNECT;
+ break;
+ case VCS_SEND_HELLO:
+ case VCS_SEND_ERROR:
+ wait = WAIT_SEND;
+ break;
+
+ case VCS_RECV_HELLO:
+ wait = WAIT_RECV;
+ break;
+
+ case VCS_CONNECTED:
+ break;
+
+ case VCS_DISCONNECTED:
+ poll_immediate_wake();
+ return;
+ }
(vconn->class->wait)(vconn, wait);
}
* connection in '*new_vconn' and returns 0. Otherwise, returns a positive
* errno value.
*
+ * 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.
+ *
* 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, struct vconn **new_vconn)
+pvconn_accept(struct pvconn *pvconn, int min_version, struct vconn **new_vconn)
{
int retval = (pvconn->class->accept)(pvconn, new_vconn);
if (retval) {
*new_vconn = NULL;
} else {
- assert((*new_vconn)->connect_status == 0
+ assert((*new_vconn)->state != VCS_CONNECTING
|| (*new_vconn)->class->connect);
+ (*new_vconn)->min_version = min_version;
}
return retval;
}
* 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);
}
* 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;
/* 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 *
+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 + n_actions * sizeof ofm->actions[0];
- struct buffer *out = buffer_new(size);
- ofm = buffer_put_uninit(out, size);
+ 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;
return out;
}
-struct buffer *
+struct ofpbuf *
make_add_simple_flow(const struct flow *flow,
uint32_t buffer_id, uint16_t out_port,
uint16_t idle_timeout)
{
- struct buffer *buffer = make_add_flow(flow, buffer_id, idle_timeout, 1);
+ 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);
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 + sizeof opo->actions[0];
- struct buffer *out = buffer_new(size + packet->size);
- opo = buffer_put_uninit(out, size);
+ struct ofpbuf *out = ofpbuf_new(size + packet->size);
+ opo = ofpbuf_put_uninit(out, size);
memset(opo, 0, size);
opo->header.version = OFP_VERSION;
opo->header.type = OFPT_PACKET_OUT;
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);
- buffer_put(out, packet->data, packet->size);
+ 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->actions[0];
- struct buffer *out = buffer_new(size);
- opo = buffer_put_uninit(out, size);
+ 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;
}
/* 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);
/* 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;
}
uint32_t ip, const char *name)
{
vconn->class = class;
- vconn->connect_status = connect_status;
+ 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->ip = ip;
vconn->name = xstrdup(name);
}
git://git.onelab.eu / sliver-openvswitch.git / blobdiff