-/* 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 <errno.h>
#include <getopt.h>
#include <inttypes.h>
#include <netinet/in.h>
+#include <stdarg.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include "openflow.h"
#include "ofp-print.h"
#include "vconn.h"
+#include "vconn-ssl.h"
#include "vlog.h"
-#define THIS_MODULE VLM_DPCTL
+#define THIS_MODULE VLM_dpctl
static const char* ifconfigbin = "/sbin/ifconfig";
{"verbose", optional_argument, 0, 'v'},
{"help", no_argument, 0, 'h'},
{"version", no_argument, 0, 'V'},
+ VCONN_SSL_LONG_OPTIONS
{0, 0, 0, 0},
};
char *short_options = long_options_to_short_options(long_options);
vlog_set_verbosity(optarg);
break;
+ VCONN_SSL_OPTION_HANDLERS
+
case '?':
exit(EXIT_FAILURE);
static void
usage(void)
{
- printf("%s: Datapath Utility\n"
+ printf("%s: OpenFlow switch management utility\n"
"usage: %s [OPTIONS] COMMAND [ARG...]\n"
- "\nAvailable commands:\n"
- " adddp DP_ID add a new datapath with ID DP_ID\n"
- " deldp DP_ID delete datapath DP_ID\n"
- " show DP show information about DP\n"
- " addif DP_ID IFACE add IFACE as a port on DP_ID\n"
- " delif DP_ID IFACE delete IFACE as a port on DP_ID\n"
- " monitor DP_ID print packets received on DP_ID\n"
- " dump-tables DP_ID print stats for all tables in DP_ID\n"
- " dump-flows DP_ID T_ID print all flow entries in table T_ID of DP_ID\n"
- " dump-flows DP_ID T_ID FLOW print matching FLOWs in table T_ID of DP_ID\n"
- " add-flows DP FILE add flows from FILE to DP\n"
- " benchmark-nl DP_ID N SIZE send N packets of SIZE bytes up netlink\n"
- "\nOptions:\n"
+#ifdef HAVE_NETLINK
+ "\nCommands that apply to local datapaths only:\n"
+ " adddp nl:DP_ID add a new local datapath DP_ID\n"
+ " deldp nl:DP_ID delete local datapath DP_ID\n"
+ " addif nl:DP_ID IFACE add IFACE as a port on DP_ID\n"
+ " delif nl:DP_ID IFACE delete IFACE as a port on DP_ID\n"
+ " monitor nl:DP_ID print packets received\n"
+ " benchmark-nl nl:DP_ID N SIZE send N packets of SIZE bytes\n"
+#endif
+ "\nCommands that apply to local datapaths and remote switches:\n"
+ " show SWITCH show information\n"
+ " dump-tables SWITCH print table stats\n"
+ " dump-ports SWITCH print port statistics\n"
+ " dump-flows SWITCH print all flow entries\n"
+ " dump-flows SWITCH FLOW print matching FLOWs\n"
+ " dump-aggregate SWITCH print aggregate flow statistics\n"
+ " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
+ " add-flows SWITCH FILE add flows from FILE\n"
+ " del-flows SWITCH FLOW delete matching FLOWs\n"
+ "where each SWITCH is an active OpenFlow connection method.\n",
+ program_name, program_name);
+ vconn_usage(true, false);
+ printf("\nOptions:\n"
+ " -v, --verbose=MODULE:FACILITY:LEVEL configure logging levels\n"
" -v, --verbose set maximum verbosity level\n"
" -h, --help display this help message\n"
- " -V, --version display version information\n",
- program_name, program_name);
+ " -V, --version display version information\n");
exit(EXIT_SUCCESS);
}
-static void run(int retval, const char *name)
+static void run(int retval, const char *message, ...)
+ PRINTF_FORMAT(2, 3);
+
+static void run(int retval, const char *message, ...)
{
if (retval) {
- fatal(retval, "%s", name);
+ va_list args;
+
+ fprintf(stderr, "%s: ", program_name);
+ va_start(args, message);
+ vfprintf(stderr, message, args);
+ va_end(args);
+ if (retval == EOF) {
+ fputs(": unexpected end of file\n", stderr);
+ } else {
+ fprintf(stderr, ": %s\n", strerror(retval));
+ }
+
+ exit(EXIT_FAILURE);
}
}
+\f
+#ifdef HAVE_NETLINK
+/* Netlink-only commands. */
static int if_up(const char* intf)
{
return system(command);
}
+static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
+{
+ if (strncmp(name, "nl:", 3)
+ || strlen(name) < 4
+ || name[strspn(name + 3, "0123456789") + 3]) {
+ fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
+ }
+ run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
+}
+
static void do_add_dp(int argc UNUSED, char *argv[])
{
struct dpif dp;
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
+ open_nl_vconn(argv[1], false, &dp);
run(dpif_add_dp(&dp), "add_dp");
dpif_close(&dp);
}
static void do_del_dp(int argc UNUSED, char *argv[])
{
struct dpif dp;
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
+ open_nl_vconn(argv[1], false, &dp);
run(dpif_del_dp(&dp), "del_dp");
dpif_close(&dp);
}
-static void do_show(int argc UNUSED, char *argv[])
-{
- struct dpif dp;
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
- run(dpif_show(&dp), "show");
- dpif_close(&dp);
-}
-
static void do_add_port(int argc UNUSED, char *argv[])
{
struct dpif dp;
if_up(argv[2]);
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
+ open_nl_vconn(argv[1], false, &dp);
run(dpif_add_port(&dp, argv[2]), "add_port");
dpif_close(&dp);
}
static void do_del_port(int argc UNUSED, char *argv[])
{
struct dpif dp;
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
+ open_nl_vconn(argv[1], false, &dp);
run(dpif_del_port(&dp, argv[2]), "del_port");
dpif_close(&dp);
}
+static void do_monitor(int argc UNUSED, char *argv[])
+{
+ struct dpif dp;
+ open_nl_vconn(argv[1], true, &dp);
+ for (;;) {
+ struct buffer *b;
+ run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
+ ofp_print(stderr, b->data, b->size, 2);
+ buffer_delete(b);
+ }
+}
+
#define BENCHMARK_INCR 100
static void do_benchmark_nl(int argc UNUSED, char *argv[])
uint32_t num_packets, i, milestone;
struct timeval start, end;
- run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
+ open_nl_vconn(argv[1], false, &dp);
num_packets = atoi(argv[2]);
milestone = BENCHMARK_INCR;
run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
dpif_close(&dp);
}
+#endif /* HAVE_NETLINK */
+\f
+/* Generic commands. */
-static void do_monitor(int argc UNUSED, char *argv[])
+static uint32_t
+random_xid(void)
{
- struct dpif dp;
- run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
+ static bool inited = false;
+ if (!inited) {
+ struct timeval tv;
+ inited = true;
+ if (gettimeofday(&tv, NULL) < 0) {
+ fatal(errno, "gettimeofday");
+ }
+ srand(tv.tv_sec ^ tv.tv_usec);
+ }
+ return rand();
+}
+
+static void *
+alloc_openflow_buffer(size_t openflow_len, uint8_t type,
+ struct buffer **bufferp)
+{
+ struct buffer *buffer;
+ struct ofp_header *oh;
+
+ 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 = 0;
+ oh->xid = random_xid();
+ return oh;
+}
+
+static void *
+alloc_stats_request(size_t body_len, uint16_t type, struct buffer **bufferp)
+{
+ struct ofp_stats_request *rq;
+ rq = alloc_openflow_buffer((offsetof(struct ofp_stats_request, body)
+ + body_len), OFPT_STATS_REQUEST, bufferp);
+ rq->type = htons(type);
+ rq->flags = htons(0);
+ return rq->body;
+}
+
+static void
+send_openflow_buffer(struct vconn *vconn, struct buffer *buffer)
+{
+ struct ofp_header *oh;
+
+ oh = buffer_at_assert(buffer, 0, sizeof *oh);
+ oh->length = htons(buffer->size);
+
+ run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
+}
+
+static struct buffer *
+transact_openflow(struct vconn *vconn, struct buffer *request)
+{
+ uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
+
+ send_openflow_buffer(vconn, request);
for (;;) {
- struct buffer *b;
- run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
- ofp_print(stderr, b->data, b->size, 2);
- buffer_delete(b);
+ uint32_t recv_xid;
+ struct buffer *reply;
+
+ run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
+ recv_xid = ((struct ofp_header *) reply->data)->xid;
+ if (send_xid == recv_xid) {
+ return reply;
+ }
+
+ VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
+ recv_xid, send_xid);
+ buffer_delete(reply);
}
}
-static void do_dump_tables(int argc, char *argv[])
+static void
+dump_transaction(const char *vconn_name, struct buffer *request)
{
- struct dpif dp;
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
- run(dpif_dump_tables(&dp), "dump_tables");
- dpif_close(&dp);
+ struct vconn *vconn;
+ struct buffer *reply;
+
+ run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name);
+ reply = transact_openflow(vconn, request);
+ ofp_print(stdout, reply->data, reply->size, 1);
+ vconn_close(vconn);
+}
+
+static void
+dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
+{
+ struct buffer *request;
+ alloc_openflow_buffer(sizeof(struct ofp_header), request_type, &request);
+ dump_transaction(vconn_name, request);
+}
+
+static void
+dump_stats_transaction(const char *vconn_name, struct buffer *request)
+{
+ uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
+ struct vconn *vconn;
+ bool done = false;
+
+ run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name);
+ send_openflow_buffer(vconn, request);
+ while (!done) {
+ uint32_t recv_xid;
+ struct buffer *reply;
+
+ run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
+ recv_xid = ((struct ofp_header *) reply->data)->xid;
+ if (send_xid == recv_xid) {
+ struct ofp_stats_reply *osr;
+
+ ofp_print(stdout, reply->data, reply->size, 1);
+
+ osr = buffer_at(reply, 0, sizeof *osr);
+ done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
+ } else {
+ VLOG_DBG("received reply with xid %08"PRIx32" "
+ "!= expected %08"PRIx32, recv_xid, send_xid);
+ }
+ buffer_delete(reply);
+ }
+ vconn_close(vconn);
+}
+
+static void
+dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
+{
+ struct buffer *request;
+ alloc_stats_request(0, stats_type, &request);
+ dump_stats_transaction(vconn_name, request);
+}
+
+static void
+do_show(int argc UNUSED, char *argv[])
+{
+ dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
+ dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
+}
+
+
+static void
+do_dump_tables(int argc, char *argv[])
+{
+ dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
}
{
uint16_t port;
- if (!strcasecmp(str, "flood")) {
+ if (!strcasecmp(str, "normal")) {
+ port = OFPP_NORMAL;
+ } else if (!strcasecmp(str, "flood")) {
port = OFPP_FLOOD;
+ } else if (!strcasecmp(str, "all")) {
+ port = OFPP_ALL;
} else if (!strcasecmp(str, "controller")) {
port = OFPP_CONTROLLER;
+ } else if (!strcasecmp(str, "local")) {
+ port = OFPP_LOCAL;
} else {
port = str_to_int(str);
}
}
static void
-str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
+str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action,
+ uint8_t *table_idx, uint16_t *priority)
{
struct field {
const char *name;
uint32_t wildcards;
bool got_action = false;
+ if (table_idx) {
+ *table_idx = 0xff;
+ }
+ if (priority) {
+ *priority = OFP_DEFAULT_PRIORITY;
+ }
memset(match, 0, sizeof *match);
wildcards = OFPFW_ALL;
- for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
+ for (name = strtok(string, "="), value = strtok(NULL, ", \t\r\n");
name && value;
- name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
+ name = strtok(NULL, "="), value = strtok(NULL, ", \t\r\n"))
{
const struct field *f;
void *data;
continue;
}
+ if (table_idx && !strcmp(name, "table")) {
+ *table_idx = atoi(value);
+ continue;
+ }
+
+ if (priority && !strcmp(name, "priority")) {
+ *priority = atoi(value);
+ continue;
+ }
+
for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
if (!strcmp(f->name, name)) {
goto found;
found:
data = (char *) match + f->offset;
- if (!strcmp(value, "*")) {
+ if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
wildcards |= f->wildcard;
} else {
wildcards &= ~f->wildcard;
static void do_dump_flows(int argc, char *argv[])
{
- struct dpif dp;
- struct ofp_match match, *matchp;
- run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
- if (argc == 4) {
- str_to_flow(argv[3], &match, NULL);
- matchp = &match;
- } else {
- matchp = NULL;
- }
- run(dpif_dump_flows(&dp, atoi(argv[2]), matchp), "dump_flows");
- dpif_close(&dp);
+ struct ofp_flow_stats_request *req;
+ struct buffer *request;
+
+ req = alloc_stats_request(sizeof *req, OFPST_FLOW, &request);
+ str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL, &req->table_id,
+ NULL);
+ memset(req->pad, 0, sizeof req->pad);
+
+ dump_stats_transaction(argv[1], request);
+}
+
+static void do_dump_aggregate(int argc, char *argv[])
+{
+ struct ofp_aggregate_stats_request *req;
+ struct buffer *request;
+
+ req = alloc_stats_request(sizeof *req, OFPST_AGGREGATE, &request);
+ str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL, &req->table_id,
+ NULL);
+ memset(req->pad, 0, sizeof req->pad);
+
+ dump_stats_transaction(argv[1], request);
}
static void do_add_flows(int argc, char *argv[])
{
struct vconn *vconn;
- char vconn_name[16];
FILE *file;
char line[1024];
- int retval;
-
file = fopen(argv[2], "r");
if (file == NULL) {
fatal(errno, "%s: open", argv[2]);
}
- sprintf(vconn_name, "nl:%d", atoi(argv[1]));
- retval = vconn_open(vconn_name, &vconn);
- if (retval) {
- fatal(retval, "opening datapath");
- }
-
+ run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
while (fgets(line, sizeof line, file)) {
struct buffer *buffer;
struct ofp_flow_mod *ofm;
+ uint16_t priority;
size_t size;
char *comment;
continue;
}
+ /* Parse and send. */
size = sizeof *ofm + sizeof ofm->actions[0];
- buffer = buffer_new(size);
- ofm = buffer_put_uninit(buffer, size);
-
- /* Parse. */
- memset(ofm, 0, size);
- ofm->header.type = OFPT_FLOW_MOD;
- ofm->header.version = OFP_VERSION;
- ofm->header.length = htons(size);
+ ofm = alloc_openflow_buffer(size, OFPT_FLOW_MOD, &buffer);
+ str_to_flow(line, &ofm->match, &ofm->actions[0], NULL, &priority);
ofm->command = htons(OFPFC_ADD);
ofm->max_idle = htons(50);
ofm->buffer_id = htonl(UINT32_MAX);
- ofm->group_id = htonl(0);
- str_to_flow(line, &ofm->match, &ofm->actions[0]);
+ ofm->priority = htons(priority);
+ ofm->reserved = htonl(0);
- retval = vconn_send_wait(vconn, buffer);
- if (retval) {
- fatal(retval, "sending to datapath");
- }
+ send_openflow_buffer(vconn, buffer);
}
vconn_close(vconn);
fclose(file);
}
+static void do_del_flows(int argc, char *argv[])
+{
+ struct vconn *vconn;
+ uint16_t priority;
+
+ run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
+ struct buffer *buffer;
+ struct ofp_flow_mod *ofm;
+ size_t size;
+
+
+ /* Parse and send. */
+ size = sizeof *ofm;
+ ofm = alloc_openflow_buffer(size, OFPT_FLOW_MOD, &buffer);
+ str_to_flow(argc > 2 ? argv[2] : "", &ofm->match, NULL, NULL, &priority);
+ ofm->command = htons(OFPFC_DELETE);
+ ofm->max_idle = htons(0);
+ ofm->buffer_id = htonl(UINT32_MAX);
+ ofm->priority = htons(priority);
+ ofm->reserved = htonl(0);
+
+ send_openflow_buffer(vconn, buffer);
+
+ vconn_close(vconn);
+}
+
+static void
+do_dump_ports(int argc, char *argv[])
+{
+ dump_trivial_stats_transaction(argv[1], OFPST_PORT);
+}
+
static void do_help(int argc UNUSED, char *argv[] UNUSED)
{
usage();
}
static struct command all_commands[] = {
- { "add-dp", 1, 1, do_add_dp },
+#ifdef HAVE_NETLINK
{ "adddp", 1, 1, do_add_dp },
-
- { "del-dp", 1, 1, do_del_dp },
{ "deldp", 1, 1, do_del_dp },
-
- { "show", 1, 1, do_show },
-
- { "add-port", 2, 2, do_add_port },
{ "addif", 2, 2, do_add_port },
-
- { "del-port", 2, 2, do_del_port },
{ "delif", 2, 2, do_del_port },
+ { "benchmark-nl", 3, 3, do_benchmark_nl },
+#endif
+
+ { "show", 1, 1, do_show },
{ "help", 0, INT_MAX, do_help },
{ "monitor", 1, 1, do_monitor },
{ "dump-tables", 1, 1, do_dump_tables },
- { "dump-flows", 2, 3, do_dump_flows },
+ { "dump-flows", 1, 2, do_dump_flows },
+ { "dump-aggregate", 1, 2, do_dump_aggregate },
{ "add-flows", 2, 2, do_add_flows },
-
- { "benchmark-nl", 3, 3, do_benchmark_nl },
+ { "del-flows", 1, 2, do_del_flows },
+ { "dump-ports", 1, 1, do_dump_ports },
+ { NULL, 0, 0, NULL },
};