-/* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
+ /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
* Junior University
*
* We are making the OpenFlow specification and associated documentation
#include <errno.h>
#include <getopt.h>
+#include <inttypes.h>
+#include <netinet/in.h>
#include <poll.h>
#include <stdlib.h>
#include <string.h>
#include "buffer.h"
#include "command-line.h"
#include "compiler.h"
+#include "daemon.h"
#include "fault.h"
+#include "flow.h"
+#include "learning-switch.h"
#include "list.h"
-#include "util.h"
-#include "rconn.h"
-#include "vconn-ssl.h"
-#include "vlog-socket.h"
+#include "mac-learning.h"
+#include "netdev.h"
#include "openflow.h"
+#include "packets.h"
#include "poll-loop.h"
+#include "rconn.h"
+#include "util.h"
+#include "vconn-ssl.h"
#include "vconn.h"
+#include "vlog-socket.h"
#include "vlog.h"
#define THIS_MODULE VLM_secchan
-static void parse_options(int argc, char *argv[]);
-static void usage(void) NO_RETURN;
+#include "ofp-print.h"
-static struct vconn *listen_vconn = NULL;
+static const char *listen_vconn_name;
struct half {
struct rconn *rconn;
struct buffer *rxbuf;
};
+/* Behavior when the connection to the controller fails. */
+enum fail_mode {
+ FAIL_OPEN, /* Act as learning switch. */
+ FAIL_CLOSED /* Drop all packets. */
+};
+
struct relay {
struct list node;
+
+#define HALF_LOCAL 0
+#define HALF_REMOTE 1
struct half halves[2];
+
+ bool is_mgmt_conn;
+ struct lswitch *lswitch;
};
static struct list relays = LIST_INITIALIZER(&relays);
+/* Enable the local port? */
+static int local_port;
+
+/* MAC address of local port. */
+static uint8_t local_mac[ETH_ADDR_LEN];
+
+/* MAC learning table for local port. */
+static struct mac_learning *local_ml;
+
+/* -f, --fail: Behavior when the connection to the controller fails. */
+static enum fail_mode fail_mode = FAIL_OPEN;
+
+/* The OpenFlow virtual network device ofX. */
+static struct netdev *of_device;
+
+/* --inactivity-probe: Number of seconds without receiving a message from the
+ controller before sending an inactivity probe. */
+static int probe_interval = 15;
+
+/* --max-idle: Idle time to assign to flows created by learning switch when in
+ * fail-open mode. */
+static int max_idle = 15;
+
+/* --max-backoff: Maximum interval between controller connection attempts, in
+ * seconds. */
+static int max_backoff = 15;
+
+static void parse_options(int argc, char *argv[]);
+static void usage(void) NO_RETURN;
+
static void new_management_connection(const char *nl_name, struct vconn *new_remote);
-static void relay_create(struct rconn *, struct rconn *);
+static struct relay *relay_create(struct rconn *local, struct rconn *remote,
+ bool is_mgmt_conn);
static void relay_run(struct relay *);
static void relay_wait(struct relay *);
static void relay_destroy(struct relay *);
+static bool local_hook(struct relay *r);
+static bool failing_open(struct relay *r);
+static bool fail_open_hook(struct relay *r);
+
int
main(int argc, char *argv[])
{
+ struct rconn *local_rconn, *remote_rconn;
+ struct vconn *listen_vconn;
+ struct relay *controller_relay;
const char *nl_name;
+ char of_name[16];
int retval;
set_program_name(argv[0]);
if (strncmp(nl_name, "nl:", 3)
|| strlen(nl_name) < 4
|| nl_name[strspn(nl_name + 3, "0123456789") + 3]) {
- fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", nl_name);
+ fatal(0, "%s: argument is not of the form \"nl:DP_IDX\"", nl_name);
+ }
+
+ if (listen_vconn_name) {
+ retval = vconn_open(listen_vconn_name, &listen_vconn);
+ if (retval && retval != EAGAIN) {
+ fatal(retval, "opening %s", listen_vconn_name);
+ }
+ if (!vconn_is_passive(listen_vconn)) {
+ fatal(0, "%s is not a passive vconn", listen_vconn_name);
+ }
+ } else {
+ listen_vconn = NULL;
+ }
+
+ snprintf(of_name, sizeof of_name, "of%s", nl_name + 3);
+ retval = netdev_open(of_name, NETDEV_ETH_TYPE_NONE, &of_device);
+ if (!retval) {
+ enum netdev_flags flags;
+ retval = netdev_get_flags(of_device, &flags);
+ if (!retval) {
+ if (flags & NETDEV_UP) {
+ struct in6_addr in6;
+
+ local_port = true;
+ memcpy(local_mac, netdev_get_etheraddr(of_device),
+ ETH_ADDR_LEN);
+ if (netdev_get_in6(of_device, &in6)) {
+ VLOG_WARN("Ignoring IPv6 address on %s device: "
+ "IPv6 not supported", of_name);
+ }
+ local_ml = mac_learning_create();
+ }
+ } else {
+ error(retval, "Could not get flags for %s device", of_name);
+ }
+ } else {
+ error(retval, "Could not open %s device", of_name);
}
retval = vlog_server_listen(NULL, NULL);
fatal(retval, "Could not listen for vlog connections");
}
- relay_create(rconn_new(argv[optind], 1), rconn_new(argv[optind + 1], 1));
+ daemonize();
+
+ local_rconn = rconn_create(1, 0, max_backoff);
+ retval = rconn_connect(local_rconn, nl_name);
+ if (retval == EAFNOSUPPORT) {
+ fatal(0, "No support for %s vconn", nl_name);
+ }
+
+ remote_rconn = rconn_create(1, probe_interval, max_backoff);
+ retval = rconn_connect(remote_rconn, argv[optind + 1]);
+ if (retval == EAFNOSUPPORT) {
+ fatal(0, "No support for %s vconn", argv[optind + 1]);
+ }
+ controller_relay = relay_create(local_rconn, remote_rconn, false);
for (;;) {
struct relay *r, *n;
relay_run(r);
}
if (listen_vconn) {
- struct vconn *new_remote;
for (;;) {
+ struct vconn *new_remote;
retval = vconn_accept(listen_vconn, &new_remote);
if (retval) {
if (retval != EAGAIN) {
}
break;
}
-
new_management_connection(nl_name, new_remote);
}
}
+ failing_open(controller_relay);
/* Wait for something to happen. */
LIST_FOR_EACH (r, struct relay, node, &relays) {
VLOG_ERR("could not connect to %s (%s)",
nl_name_without_subscription, strerror(retval));
vconn_close(new_remote);
+ free(nl_name_without_subscription);
return;
}
- free(nl_name_without_subscription);
/* Add it to the relay list. */
r1 = rconn_new_from_vconn(nl_name_without_subscription, 1, new_local);
r2 = rconn_new_from_vconn("passive", 1, new_remote);
- relay_create(r1, r2);
+ relay_create(r1, r2, true);
+
+ free(nl_name_without_subscription);
}
-static void
-relay_create(struct rconn *a, struct rconn *b)
+static struct relay *
+relay_create(struct rconn *local, struct rconn *remote, bool is_mgmt_conn)
{
struct relay *r;
int i;
r = xmalloc(sizeof *r);
+ r->halves[HALF_LOCAL].rconn = local;
+ r->halves[HALF_REMOTE].rconn = remote;
for (i = 0; i < 2; i++) {
- r->halves[i].rconn = i ? b : a;
r->halves[i].rxbuf = NULL;
}
+ r->is_mgmt_conn = is_mgmt_conn;
+ r->lswitch = NULL;
list_push_back(&relays, &r->node);
+ return r;
}
static void
if (!this->rxbuf) {
this->rxbuf = rconn_recv(this->rconn);
+ if (this->rxbuf && !r->is_mgmt_conn && i == HALF_LOCAL
+ && (local_hook(r) || fail_open_hook(r))) {
+ buffer_delete(this->rxbuf);
+ this->rxbuf = NULL;
+ }
}
if (this->rxbuf) {
int retval = rconn_send(peer->rconn, this->rxbuf);
if (retval != EAGAIN) {
- this->rxbuf = NULL;
if (!retval) {
progress = true;
+ } else {
+ buffer_delete(this->rxbuf);
}
+ this->rxbuf = NULL;
}
}
}
free(r);
}
+static bool
+is_controller_mac(const uint8_t dl_addr[ETH_ADDR_LEN],
+ struct rconn *controller)
+{
+ static uint32_t ip, last_nonzero_ip;
+ static uint8_t mac[ETH_ADDR_LEN], last_nonzero_mac[ETH_ADDR_LEN];
+ static time_t next_refresh = 0;
+
+ uint32_t last_ip = ip;
+
+ time_t now = time(0);
+
+ ip = rconn_get_ip(controller);
+ if (last_ip != ip || !next_refresh || now >= next_refresh) {
+ bool have_mac;
+
+ /* Look up MAC address. */
+ memset(mac, 0, sizeof mac);
+ if (ip) {
+ int retval = netdev_arp_lookup(of_device, ip, mac);
+ if (retval) {
+ VLOG_DBG("cannot look up controller hw address ("IP_FMT"): %s",
+ IP_ARGS(&ip), strerror(retval));
+ }
+ }
+ have_mac = !eth_addr_is_zero(mac);
+
+ /* Log changes in IP, MAC addresses. */
+ if (ip && ip != last_nonzero_ip) {
+ VLOG_DBG("controller IP address changed from "IP_FMT
+ " to "IP_FMT, IP_ARGS(&last_nonzero_ip), IP_ARGS(&ip));
+ last_nonzero_ip = ip;
+ }
+ if (have_mac && memcmp(last_nonzero_mac, mac, ETH_ADDR_LEN)) {
+ VLOG_DBG("controller MAC address changed from "ETH_ADDR_FMT" to "
+ ETH_ADDR_FMT,
+ ETH_ADDR_ARGS(last_nonzero_mac), ETH_ADDR_ARGS(mac));
+ memcpy(last_nonzero_mac, mac, ETH_ADDR_LEN);
+ }
+
+ /* Schedule next refresh.
+ *
+ * If we have an IP address but not a MAC address, then refresh
+ * quickly, since we probably will get a MAC address soon (via ARP).
+ * Otherwise, we can afford to wait a little while. */
+ next_refresh = now + (!ip || have_mac ? 10 : 1);
+ }
+ return !eth_addr_is_zero(mac) && eth_addr_equals(mac, dl_addr);
+}
+
+static bool
+local_hook(struct relay *r)
+{
+ struct rconn *rc = r->halves[HALF_LOCAL].rconn;
+ struct buffer *msg = r->halves[HALF_LOCAL].rxbuf;
+ struct ofp_packet_in *opi;
+ struct ofp_header *oh;
+ size_t pkt_ofs, pkt_len;
+ struct buffer pkt, *b;
+ struct flow flow;
+ uint16_t in_port, out_port;
+
+ if (!local_port) {
+ return false;
+ }
+
+ oh = msg->data;
+ if (oh->type != OFPT_PACKET_IN) {
+ return false;
+ }
+ if (msg->size < offsetof (struct ofp_packet_in, data)) {
+ VLOG_WARN("packet too short (%zu bytes) for packet_in", msg->size);
+ return false;
+ }
+
+ /* Extract flow data from 'opi' into 'flow'. */
+ opi = msg->data;
+ in_port = ntohs(opi->in_port);
+ pkt_ofs = offsetof(struct ofp_packet_in, data);
+ pkt_len = ntohs(opi->header.length) - pkt_ofs;
+ pkt.data = opi->data;
+ pkt.size = pkt_len;
+ flow_extract(&pkt, in_port, &flow);
+
+ /* Deal with local stuff. */
+ if (in_port == OFPP_LOCAL) {
+ out_port = mac_learning_lookup(local_ml, flow.dl_dst);
+ } else if (eth_addr_equals(flow.dl_dst, local_mac)) {
+ out_port = OFPP_LOCAL;
+ if (mac_learning_learn(local_ml, flow.dl_src, in_port)) {
+ VLOG_DBG("learned that "ETH_ADDR_FMT" is on port %"PRIu16,
+ ETH_ADDR_ARGS(flow.dl_src), in_port);
+ }
+ } else if (flow.dl_type == htons(ETH_TYPE_ARP)
+ && eth_addr_is_broadcast(flow.dl_dst)
+ && is_controller_mac(flow.dl_src,
+ r->halves[HALF_REMOTE].rconn)) {
+ out_port = OFPP_FLOOD;
+ } else {
+ return false;
+ }
+
+ /* Add new flow. */
+ if (out_port != OFPP_FLOOD) {
+ b = make_add_simple_flow(&flow, ntohl(opi->buffer_id), out_port,
+ max_idle);
+ if (rconn_force_send(rc, b)) {
+ buffer_delete(b);
+ }
+ }
+
+ /* If the switch didn't buffer the packet, we need to send a copy. */
+ if (out_port == OFPP_FLOOD || ntohl(opi->buffer_id) == UINT32_MAX) {
+ b = make_unbuffered_packet_out(&pkt, in_port, out_port);
+ if (rconn_force_send(rc, b)) {
+ buffer_delete(b);
+ }
+ }
+ return true;
+}
+
+/* Causess 'r' to enter or leave fail-open mode, if appropriate. Returns true
+ * if 'r' is in fail-open fail, false otherwise. */
+static bool
+failing_open(struct relay *r)
+{
+ struct rconn *local = r->halves[HALF_LOCAL].rconn;
+ struct rconn *remote = r->halves[HALF_REMOTE].rconn;
+ int disconnected_duration;
+
+ if (fail_mode == FAIL_CLOSED) {
+ /* We fail closed, so there's never anything to do. */
+ return false;
+ }
+
+ disconnected_duration = rconn_disconnected_duration(remote);
+ if (disconnected_duration < probe_interval * 3) {
+ /* It's not time to fail open yet. */
+ if (r->lswitch && rconn_is_connected(remote)) {
+ /* We're connected, so drop the learning switch. */
+ VLOG_WARN("No longer in fail-open mode");
+ lswitch_destroy(r->lswitch);
+ r->lswitch = NULL;
+ }
+ return false;
+ }
+
+ if (!r->lswitch) {
+ VLOG_WARN("Could not connect to controller for %d seconds, "
+ "failing open", disconnected_duration);
+ r->lswitch = lswitch_create(local, true, max_idle);
+ }
+ return true;
+}
+
+static bool
+fail_open_hook(struct relay *r)
+{
+ if (!failing_open(r)) {
+ return false;
+ } else {
+ struct buffer *msg = r->halves[HALF_LOCAL].rxbuf;
+ struct rconn *local = r->halves[HALF_LOCAL].rconn;
+ lswitch_process_packet(r->lswitch, local, msg);
+ rconn_run(local);
+ return true;
+ }
+}
+
static void
parse_options(int argc, char *argv[])
{
+ enum {
+ OPT_INACTIVITY_PROBE = UCHAR_MAX + 1,
+ OPT_MAX_IDLE,
+ OPT_MAX_BACKOFF
+ };
static struct option long_options[] = {
+ {"fail", required_argument, 0, 'f'},
+ {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
+ {"max-idle", required_argument, 0, OPT_MAX_IDLE},
+ {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
{"listen", required_argument, 0, 'l'},
+ {"detach", no_argument, 0, 'D'},
+ {"pidfile", optional_argument, 0, 'P'},
{"verbose", optional_argument, 0, 'v'},
{"help", no_argument, 0, 'h'},
{"version", no_argument, 0, 'V'},
-#ifdef HAVE_OPENSSL
- {"private-key", required_argument, 0, 'p'},
- {"certificate", required_argument, 0, 'c'},
- {"ca-cert", required_argument, 0, 'C'},
-#endif
+ VCONN_SSL_LONG_OPTIONS
{0, 0, 0, 0},
};
char *short_options = long_options_to_short_options(long_options);
for (;;) {
- int retval;
int c;
c = getopt_long(argc, argv, short_options, long_options, NULL);
}
switch (c) {
- case 'l':
- if (listen_vconn) {
- fatal(0, "-l or --listen may be only specified once");
+ case 'f':
+ if (!strcmp(optarg, "open")) {
+ fail_mode = FAIL_OPEN;
+ } else if (!strcmp(optarg, "closed")) {
+ fail_mode = FAIL_CLOSED;
+ } else {
+ fatal(0,
+ "-f or --fail argument must be \"open\" or \"closed\"");
}
- retval = vconn_open(optarg, &listen_vconn);
- if (retval && retval != EAGAIN) {
- fatal(retval, "opening %s", optarg);
+ break;
+
+ case OPT_INACTIVITY_PROBE:
+ probe_interval = atoi(optarg);
+ if (probe_interval < 5) {
+ fatal(0, "--inactivity-probe argument must be at least 5");
}
- if (!vconn_is_passive(listen_vconn)) {
- fatal(0, "%s is not a passive vconn", optarg);
+ break;
+
+ case OPT_MAX_IDLE:
+ if (!strcmp(optarg, "permanent")) {
+ max_idle = OFP_FLOW_PERMANENT;
+ } else {
+ max_idle = atoi(optarg);
+ if (max_idle < 1 || max_idle > 65535) {
+ fatal(0, "--max-idle argument must be between 1 and "
+ "65535 or the word 'permanent'");
+ }
+ }
+ break;
+
+ case OPT_MAX_BACKOFF:
+ max_backoff = atoi(optarg);
+ if (max_backoff < 1) {
+ fatal(0, "--max-backoff argument must be at least 1");
+ } else if (max_backoff > 3600) {
+ max_backoff = 3600;
}
break;
+ case 'D':
+ set_detach();
+ break;
+
+ case 'P':
+ set_pidfile(optarg ? optarg : "secchan.pid");
+ break;
+
+ case 'l':
+ if (listen_vconn_name) {
+ fatal(0, "-l or --listen may be only specified once");
+ }
+ listen_vconn_name = optarg;
+ break;
+
case 'h':
usage();
vlog_set_verbosity(optarg);
break;
-#ifdef HAVE_OPENSSL
- case 'p':
- vconn_ssl_set_private_key_file(optarg);
- break;
-
- case 'c':
- vconn_ssl_set_certificate_file(optarg);
- break;
-
- case 'C':
- vconn_ssl_set_ca_cert_file(optarg);
- break;
-#endif
+ VCONN_SSL_OPTION_HANDLERS
case '?':
exit(EXIT_FAILURE);
static void
usage(void)
{
- printf("%s: Secure Channel, a relay for OpenFlow messages.\n"
- "usage: %s [OPTIONS] LOCAL REMOTE\n"
- "where LOCAL and REMOTE are active OpenFlow connection methods.\n",
+ printf("%s: secure channel, a relay for OpenFlow messages.\n"
+ "usage: %s [OPTIONS] nl:DP_IDX CONTROLLER\n"
+ "where nl:DP_IDX is a datapath that has been added with dpctl\n"
+ "and CONTROLLER is an active OpenFlow connection method.\n",
program_name, program_name);
vconn_usage(true, true);
printf("\nNetworking options:\n"
+ " -f, --fail=open|closed when controller connection fails:\n"
+ " closed: drop all packets\n"
+ " open (default): act as learning switch\n"
+ " --inactivity-probe=SECS time between inactivity probes\n"
+ " --max-idle=SECS max idle for flows set up by secchan\n"
+ " --max-backoff=SECS max time between controller connection\n"
+ " attempts (default: 15 seconds)\n"
" -l, --listen=METHOD allow management connections on METHOD\n"
" (a passive OpenFlow connection method)\n"
"\nOther options:\n"
+ " -D, --detach run in background as daemon\n"
+ " -P, --pidfile[=FILE] create pidfile (default: %s/secchan.pid)\n"
+ " -v, --verbose=MODULE[:FACILITY[:LEVEL]] set logging levels\n"
" -v, --verbose set maximum verbosity level\n"
" -h, --help display this help message\n"
- " -V, --version display version information\n");
+ " -V, --version display version information\n",
+ RUNDIR);
exit(EXIT_SUCCESS);
}