-/* Copyright (C) 2007 Board of Trustees, Leland Stanford Jr. University.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to
- * deal in the Software without restriction, including without limitation the
- * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
- * sell copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
- * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
- * IN THE SOFTWARE.
+/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
+ * Junior University
+ *
+ * We are making the OpenFlow specification and associated documentation
+ * (Software) available for public use and benefit with the expectation
+ * that others will use, modify and enhance the Software and contribute
+ * those enhancements back to the community. However, since we would
+ * like to make the Software available for broadest use, with as few
+ * restrictions as possible permission is hereby granted, free of
+ * charge, to any person obtaining a copy of this Software to deal in
+ * the Software under the copyrights without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
+ * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
+ * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ * The name and trademarks of copyright holder(s) may NOT be used in
+ * advertising or publicity pertaining to the Software or any
+ * derivatives without specific, written prior permission.
*/
#include "vconn.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 "openflow.h"
+#include "poll-loop.h"
+#include "random.h"
#include "util.h"
+#define THIS_MODULE VLM_vconn
+#include "vlog.h"
+
static struct vconn_class *vconn_classes[] = {
&tcp_vconn_class,
&ptcp_vconn_class,
/* Check the validity of the vconn class structures. */
static void
-check_vconn_classes(void)
+check_vconn_classes(void)
{
#ifndef NDEBUG
size_t i;
assert(class->name != NULL);
assert(class->open != NULL);
assert(class->close != NULL);
- assert(class->prepoll != NULL);
assert(class->accept
? !class->recv && !class->send
- : class->recv && class->send);
+ : class->recv && class->send);
+ assert(class->wait != NULL);
}
#endif
}
+/* Prints information on active (if 'active') and passive (if 'passive')
+ * connection methods supported by the vconn. */
+void
+vconn_usage(bool active, bool passive)
+{
+ /* 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");
+#ifdef HAVE_NETLINK
+ printf(" nl:DP_IDX "
+ "local datapath DP_IDX\n");
+#endif
+ printf(" tcp:HOST[:PORT] "
+ "PORT (default: %d) on remote TCP HOST\n", OFP_TCP_PORT);
+#ifdef HAVE_OPENSSL
+ printf(" ssl:HOST[:PORT] "
+ "SSL PORT (default: %d) on remote HOST\n", OFP_SSL_PORT);
+#endif
+ }
+
+ if (passive) {
+ printf("Passive OpenFlow connection methods:\n");
+ printf(" ptcp:[PORT] "
+ "listen to TCP PORT (default: %d)\n",
+ OFP_TCP_PORT);
+#ifdef HAVE_OPENSSL
+ printf(" pssl:[PORT] "
+ "listen for SSL on PORT (default: %d)\n",
+ OFP_SSL_PORT);
+#endif
+ }
+
+#ifdef HAVE_OPENSSL
+ printf("PKI configuration (required to use SSL):\n"
+ " -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");
+#endif
+}
+
/* Attempts to connect to an OpenFlow device. 'name' is a connection name in
* the form "TYPE:ARGS", where TYPE is the vconn class's name and ARGS are
* vconn class-specific.
* 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, struct vconn **vconnp)
{
size_t prefix_len;
size_t i;
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];
free(suffix_copy);
if (retval) {
*vconnp = NULL;
+ } else {
+ assert((*vconnp)->connect_status != EAGAIN
+ || (*vconnp)->class->connect);
}
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
+vconn_open_block(const char *name, struct vconn **vconnp)
+{
+ struct vconn *vconn;
+ int error;
+
+ error = vconn_open(name, &vconn);
+ while (error == EAGAIN) {
+ vconn_connect_wait(vconn);
+ poll_block();
+ error = vconn_connect(vconn);
+ assert(error != EINPROGRESS);
+ }
+ if (error) {
+ vconn_close(vconn);
+ *vconnp = NULL;
+ } else {
+ *vconnp = vconn;
+ }
+ return error;
}
/* Closes 'vconn'. */
void
-vconn_close(struct vconn *vconn)
+vconn_close(struct vconn *vconn)
{
if (vconn != NULL) {
(vconn->class->close)(vconn);
* 'vconn' is an active vconn, that is, its purpose is to transfer data, not
* to wait for new connections to arrive. */
bool
-vconn_is_passive(const struct vconn *vconn)
+vconn_is_passive(const struct vconn *vconn)
{
return vconn->class->accept != NULL;
}
-/* Initializes 'pfd->fd' and 'pfd->events' appropriately so that poll() will
- * wake up when the connection becomes available for the operations specified
- * in 'want', or for performing the vconn's needed internal processing.
- *
- * Normally returns false. Returns true to indicate that no blocking should
- * happen in poll() because the connection is available for some operation
- * specified in 'want' but that status cannot be detected via poll() and thus
- * poll() could block forever otherwise. */
-bool
-vconn_prepoll(struct vconn *vconn, int want, struct pollfd *pollfd)
+/* 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. */
+uint32_t
+vconn_get_ip(const struct vconn *vconn)
{
- return (vconn->class->prepoll)(vconn, want, pollfd);
+ return vconn->ip;
}
-/* Perform any internal processing needed by the connections. The vconn file
- * descriptor's status, as reported by poll(), must be provided in '*revents'.
- *
- * The postpoll function adjusts '*revents' to reflect the status of the
- * connection from the caller's point of view. That is, upon return '*revents
- * & POLLIN' indicates that a packet is (potentially) ready to be read (for an
- * active vconn) or a new connection is ready to be accepted (for a passive
- * vconn) and '*revents & POLLOUT' indicates that a packet is (potentially)
- * ready to be written. */
-void
-vconn_postpoll(struct vconn *vconn, short int *revents)
+/* 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. */
+int
+vconn_connect(struct vconn *vconn)
{
- if (vconn->class->postpoll) {
- (vconn->class->postpoll)(vconn, revents);
- }
+ if (vconn->connect_status == EAGAIN) {
+ vconn->connect_status = (vconn->class->connect)(vconn);
+ assert(vconn->connect_status != EINPROGRESS);
+ }
+ return vconn->connect_status;
}
/* Tries to accept a new connection on 'vconn', which must be a passive vconn.
* vconn_accept will not block waiting for a connection. If no connection is
* ready to be accepted, it returns EAGAIN immediately. */
int
-vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
+vconn_accept(struct vconn *vconn, struct vconn **new_vconn)
{
- int retval = (vconn->class->accept)(vconn, new_vconn);
+ int retval;
+
+ retval = (vconn->class->accept)(vconn, new_vconn);
+
if (retval) {
*new_vconn = NULL;
+ } else {
+ assert((*new_vconn)->connect_status != EAGAIN
+ || (*new_vconn)->class->connect);
}
return retval;
}
* 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 buffer **msgp)
{
- int retval = (vconn->class->recv)(vconn, 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) {
*msgp = NULL;
}
* 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 buffer *msg)
{
- return (vconn->class->send)(vconn, 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);
+ }
+ free(s);
+ }
+ }
+ return retval;
}
/* Same as vconn_send, except that it waits until 'msg' can be transmitted. */
int
-vconn_send_wait(struct vconn *vconn, struct buffer *msg)
+vconn_send_block(struct vconn *vconn, struct buffer *msg)
{
int retval;
while ((retval = vconn_send(vconn, msg)) == EAGAIN) {
- struct pollfd pfd;
-
- pfd.fd = -1;
- pfd.events = 0;
- vconn_prepoll(vconn, WANT_SEND, &pfd);
- do {
- retval = poll(&pfd, 1, -1);
- } while (retval < 0 && errno == EINTR);
- if (retval < 0) {
- return errno;
- }
- assert(retval == 1);
- vconn_postpoll(vconn, &pfd.revents);
+ vconn_send_wait(vconn);
+ VLOG_DBG("blocking on vconn send");
+ poll_block();
}
return retval;
}
+/* Same as vconn_recv, except that it waits until a message is received. */
+int
+vconn_recv_block(struct vconn *vconn, struct buffer **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 buffer *request,
+ struct buffer **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);
+ return error;
+ }
+ for (;;) {
+ uint32_t recv_xid;
+ struct buffer *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("received reply with xid %08"PRIx32" != expected %08"PRIx32,
+ recv_xid, send_xid);
+ buffer_delete(reply);
+ }
+}
+
+void
+vconn_wait(struct vconn *vconn, enum vconn_wait_type wait)
+{
+ int connect_status;
+
+ assert(vconn_is_passive(vconn)
+ ? wait == WAIT_ACCEPT || wait == WAIT_CONNECT
+ : 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;
+ }
+ }
+
+ (vconn->class->wait)(vconn, wait);
+}
+
+void
+vconn_connect_wait(struct vconn *vconn)
+{
+ vconn_wait(vconn, WAIT_CONNECT);
+}
+
+void
+vconn_accept_wait(struct vconn *vconn)
+{
+ vconn_wait(vconn, WAIT_ACCEPT);
+}
+
+void
+vconn_recv_wait(struct vconn *vconn)
+{
+ vconn_wait(vconn, WAIT_RECV);
+}
+
+void
+vconn_send_wait(struct vconn *vconn)
+{
+ vconn_wait(vconn, WAIT_SEND);
+}
+
+/* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
+ * containing an OpenFlow header with the given 'type' and a random transaction
+ * 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)
+{
+ return make_openflow_xid(openflow_len, type, random_uint32(), bufferp);
+}
+
+/* Allocates and returns the first byte of a buffer 'openflow_len' bytes long,
+ * containing an OpenFlow header with the given 'type' and transaction id
+ * 'xid'. Stores the new buffer in '*bufferp'. The caller must free the
+ * 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 buffer *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);
+ memset(oh, 0, openflow_len);
+ oh->version = OFP_VERSION;
+ oh->type = type;
+ oh->length = htons(openflow_len);
+ oh->xid = xid;
+ return oh;
+}
+
+/* Updates the 'length' field of the OpenFlow message in 'buffer' to
+ * 'buffer->size'. */
+void
+update_openflow_length(struct buffer *buffer)
+{
+ struct ofp_header *oh = buffer_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)
+ uint32_t buffer_id, uint16_t out_port, uint16_t max_idle)
{
struct ofp_flow_mod *ofm;
size_t size = sizeof *ofm + sizeof ofm->actions[0];
ofm->match.tp_src = flow->tp_src;
ofm->match.tp_dst = flow->tp_dst;
ofm->command = htons(OFPFC_ADD);
- ofm->max_idle = htons(60);
+ ofm->max_idle = htons(max_idle);
ofm->buffer_id = htonl(buffer_id);
- ofm->group_id = htonl(0);
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;
}
+/* Creates and returns an OFPT_ECHO_REQUEST message with an empty payload. */
+struct buffer *
+make_echo_request(void)
+{
+ struct ofp_header *rq;
+ struct buffer *out = buffer_new(sizeof *rq);
+ rq = buffer_put_uninit(out, sizeof *rq);
+ rq->version = OFP_VERSION;
+ rq->type = OFPT_ECHO_REQUEST;
+ rq->length = htons(sizeof *rq);
+ rq->xid = 0;
+ return out;
+}
+
+/* Creates and returns an OFPT_ECHO_REPLY message matching the
+ * OFPT_ECHO_REQUEST message in 'rq'. */
+struct buffer *
+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);
+ reply->type = OFPT_ECHO_REPLY;
+ return out;
+}
projects / openvswitch / blobdiff