/* 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 #include #include #include #include #include #include #include #include #include #include "command-line.h" #include "compiler.h" #include "buffer.h" #include "dpif.h" #ifdef HAVE_NETLINK #include "netlink.h" #include "openflow-netlink.h" #endif #include "util.h" #include "socket-util.h" #include "openflow.h" #include "ofp-print.h" #include "random.h" #include "signal.h" #include "vconn.h" #include "vconn-ssl.h" #include "vlog.h" #define THIS_MODULE VLM_dpctl #define DEFAULT_MAX_IDLE 60 #define MAX_ADD_ACTS 5 static const char* ifconfigbin = "/sbin/ifconfig"; struct command { const char *name; int min_args; int max_args; void (*handler)(int argc, char *argv[]); }; static struct command all_commands[]; static void usage(void) NO_RETURN; static void parse_options(int argc, char *argv[]); int main(int argc, char *argv[]) { struct command *p; set_program_name(argv[0]); vlog_init(); parse_options(argc, argv); argc -= optind; argv += optind; if (argc < 1) fatal(0, "missing command name; use --help for help"); for (p = all_commands; p->name != NULL; p++) { if (!strcmp(p->name, argv[0])) { int n_arg = argc - 1; if (n_arg < p->min_args) fatal(0, "'%s' command requires at least %d arguments", p->name, p->min_args); else if (n_arg > p->max_args) fatal(0, "'%s' command takes at most %d arguments", p->name, p->max_args); else { p->handler(argc, argv); exit(0); } } } fatal(0, "unknown command '%s'; use --help for help", argv[0]); return 0; } static void parse_options(int argc, char *argv[]) { static struct option long_options[] = { {"timeout", required_argument, 0, 't'}, {"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); for (;;) { unsigned long int timeout; int c; c = getopt_long(argc, argv, short_options, long_options, NULL); if (c == -1) { break; } switch (c) { case 't': timeout = strtoul(optarg, NULL, 10); if (timeout <= 0) { fatal(0, "value %s on -t or --timeout is not at least 1", optarg); } else if (timeout < UINT_MAX) { /* Add 1 because historical implementations allow an alarm to * occur up to a second early. */ alarm(timeout + 1); } else { alarm(UINT_MAX); } signal(SIGALRM, SIG_DFL); break; case 'h': usage(); case 'V': printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]); exit(EXIT_SUCCESS); case 'v': vlog_set_verbosity(optarg); break; VCONN_SSL_OPTION_HANDLERS case '?': exit(EXIT_FAILURE); default: abort(); } } free(short_options); } static void usage(void) { printf("%s: OpenFlow switch management utility\n" "usage: %s [OPTIONS] COMMAND [ARG...]\n" #ifdef HAVE_NETLINK "\nFor 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" #endif "\nFor 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-flow SWITCH FLOW add flow described by FLOW\n" " add-flows SWITCH FILE add flows from FILE\n" " del-flows SWITCH FLOW delete matching FLOWs\n" "\nFor local datapaths, remote switches, and controllers:\n" " probe VCONN probe whether VCONN is up\n" " ping VCONN [N] latency of N-byte echos\n" " benchmark VCONN N COUNT bandwidth of COUNT N-byte echos\n" "where each SWITCH is an active OpenFlow connection method.\n", program_name, program_name); vconn_usage(true, false); printf("\nOptions:\n" " -t, --timeout=SECS give up after SECS seconds\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"); exit(EXIT_SUCCESS); } static void run(int retval, const char *message, ...) PRINTF_FORMAT(2, 3); static void run(int retval, const char *message, ...) { if (retval) { 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); } } #ifdef HAVE_NETLINK /* Netlink-only commands. */ static int if_up(const char* intf) { char command[256]; snprintf(command, sizeof command, "%s %s up &> /dev/null", ifconfigbin, 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; 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; open_nl_vconn(argv[1], false, &dp); run(dpif_del_dp(&dp), "del_dp"); dpif_close(&dp); } static void do_add_port(int argc UNUSED, char *argv[]) { struct dpif dp; if_up(argv[2]); 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; 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); } } #endif /* HAVE_NETLINK */ /* Generic commands. */ static void * alloc_stats_request(size_t body_len, uint16_t type, struct buffer **bufferp) { struct ofp_stats_request *rq; rq = make_openflow((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) { update_openflow_length(buffer); run(vconn_send_block(vconn, buffer), "failed to send packet to switch"); } static void dump_transaction(const char *vconn_name, struct buffer *request) { struct vconn *vconn; struct buffer *reply; update_openflow_length(request); run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name); run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name); 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; make_openflow(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); } static uint32_t str_to_int(const char *str) { uint32_t value; if (sscanf(str, "%"SCNu32, &value) != 1) { fatal(0, "invalid numeric format %s", str); } return value; } static void str_to_mac(const char *str, uint8_t mac[6]) { if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8, &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) { fatal(0, "invalid mac address %s", str); } } static void str_to_ip(const char *str, uint32_t *ip) { struct in_addr in_addr; int retval; retval = lookup_ip(str, &in_addr); if (retval) { fatal(0, "%s: could not convert to IP address", str); } *ip = in_addr.s_addr; } static void str_to_action(char *str, struct ofp_action *action, int *n_actions) { uint16_t port; int i; int max_actions = *n_actions; char *act, *arg; char *saveptr = NULL; memset(action, 0, sizeof(*action) * max_actions); for (i=0, act = strtok_r(str, ", \t\r\n", &saveptr); iname); } fprintf(stderr, ")\n"); exit(1); found: data = (char *) match + f->offset; if (!strcmp(value, "*") || !strcmp(value, "ANY")) { wildcards |= f->wildcard; } else { wildcards &= ~f->wildcard; if (f->type == F_U8) { *(uint8_t *) data = str_to_int(value); } else if (f->type == F_U16) { *(uint16_t *) data = htons(str_to_int(value)); } else if (f->type == F_MAC) { str_to_mac(value, data); } else if (f->type == F_IP) { str_to_ip(value, data); } else { NOT_REACHED(); } } } if (name && !value) { fatal(0, "field %s missing value", name); } match->wildcards = htons(wildcards); } static void do_dump_flows(int argc, char *argv[]) { 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, 0, &req->table_id, NULL, 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, 0, &req->table_id, NULL, NULL); memset(req->pad, 0, sizeof req->pad); dump_stats_transaction(argv[1], request); } static void do_add_flow(int argc, char *argv[]) { struct vconn *vconn; struct buffer *buffer; struct ofp_flow_mod *ofm; uint16_t priority, max_idle; size_t size; int n_actions = MAX_ADD_ACTS; run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]); /* Parse and send. */ size = sizeof *ofm + (sizeof ofm->actions[0] * MAX_ADD_ACTS); ofm = make_openflow(size, OFPT_FLOW_MOD, &buffer); str_to_flow(argv[2], &ofm->match, &ofm->actions[0], &n_actions, NULL, &priority, &max_idle); ofm->command = htons(OFPFC_ADD); ofm->max_idle = htons(max_idle); ofm->buffer_id = htonl(UINT32_MAX); ofm->priority = htons(priority); ofm->reserved = htonl(0); /* xxx Should we use the buffer library? */ buffer->size -= (MAX_ADD_ACTS - n_actions) * sizeof ofm->actions[0]; send_openflow_buffer(vconn, buffer); vconn_close(vconn); } static void do_add_flows(int argc, char *argv[]) { struct vconn *vconn; FILE *file; char line[1024]; file = fopen(argv[2], "r"); if (file == NULL) { fatal(errno, "%s: open", argv[2]); } 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, max_idle; size_t size; int n_actions = MAX_ADD_ACTS; char *comment; /* Delete comments. */ comment = strchr(line, '#'); if (comment) { *comment = '\0'; } /* Drop empty lines. */ if (line[strspn(line, " \t\n")] == '\0') { continue; } /* Parse and send. */ size = sizeof *ofm + (sizeof ofm->actions[0] * MAX_ADD_ACTS); ofm = make_openflow(size, OFPT_FLOW_MOD, &buffer); str_to_flow(line, &ofm->match, &ofm->actions[0], &n_actions, NULL, &priority, &max_idle); ofm->command = htons(OFPFC_ADD); ofm->max_idle = htons(max_idle); ofm->buffer_id = htonl(UINT32_MAX); ofm->priority = htons(priority); ofm->reserved = htonl(0); /* xxx Should we use the buffer library? */ buffer->size -= (MAX_ADD_ACTS - n_actions) * sizeof ofm->actions[0]; 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 = make_openflow(size, OFPT_FLOW_MOD, &buffer); str_to_flow(argc > 2 ? argv[2] : "", &ofm->match, NULL, 0, NULL, &priority, NULL); 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_probe(int argc, char *argv[]) { struct buffer *request; struct vconn *vconn; struct buffer *reply; make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request); run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]); run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]); if (reply->size != request->size) { fatal(0, "reply does not match request"); } buffer_delete(reply); vconn_close(vconn); } static void do_ping(int argc, char *argv[]) { size_t max_payload = 65535 - sizeof(struct ofp_header); unsigned int payload; struct vconn *vconn; int i; payload = argc > 2 ? atoi(argv[2]) : 64; if (payload > max_payload) { fatal(0, "payload must be between 0 and %zu bytes", max_payload); } run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]); for (i = 0; i < 10; i++) { struct timeval start, end; struct buffer *request, *reply; struct ofp_header *rq_hdr, *rpy_hdr; rq_hdr = make_openflow(sizeof(struct ofp_header) + payload, OFPT_ECHO_REQUEST, &request); random_bytes(rq_hdr + 1, payload); gettimeofday(&start, NULL); run(vconn_transact(vconn, buffer_clone(request), &reply), "transact"); gettimeofday(&end, NULL); rpy_hdr = reply->data; if (reply->size != request->size || memcmp(rpy_hdr + 1, rq_hdr + 1, payload) || rpy_hdr->xid != rq_hdr->xid || rpy_hdr->type != OFPT_ECHO_REPLY) { printf("Reply does not match request. Request:\n"); ofp_print(stdout, request, request->size, 2); printf("Reply:\n"); ofp_print(stdout, reply, reply->size, 2); } printf("%d bytes from %s: xid=%08"PRIx32" time=%.1f ms\n", reply->size - sizeof *rpy_hdr, argv[1], rpy_hdr->xid, (1000*(double)(end.tv_sec - start.tv_sec)) + (.001*(end.tv_usec - start.tv_usec))); buffer_delete(request); buffer_delete(reply); } vconn_close(vconn); } static void do_benchmark(int argc, char *argv[]) { size_t max_payload = 65535 - sizeof(struct ofp_header); struct timeval start, end; unsigned int payload_size, message_size; struct vconn *vconn; double duration; int count; int i; payload_size = atoi(argv[2]); if (payload_size > max_payload) { fatal(0, "payload must be between 0 and %zu bytes", max_payload); } message_size = sizeof(struct ofp_header) + payload_size; count = atoi(argv[3]); printf("Sending %d packets * %u bytes (with header) = %u bytes total\n", count, message_size, count * message_size); run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]); gettimeofday(&start, NULL); for (i = 0; i < count; i++) { struct buffer *request, *reply; struct ofp_header *rq_hdr; rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request); memset(rq_hdr + 1, 0, payload_size); run(vconn_transact(vconn, request, &reply), "transact"); buffer_delete(reply); } gettimeofday(&end, NULL); vconn_close(vconn); duration = ((1000*(double)(end.tv_sec - start.tv_sec)) + (.001*(end.tv_usec - start.tv_usec))); printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n", duration, count / (duration / 1000.0), count * message_size / (duration / 1000.0)); } static void do_help(int argc UNUSED, char *argv[] UNUSED) { usage(); } static struct command all_commands[] = { #ifdef HAVE_NETLINK { "adddp", 1, 1, do_add_dp }, { "deldp", 1, 1, do_del_dp }, { "addif", 2, 2, do_add_port }, { "delif", 2, 2, do_del_port }, #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", 1, 2, do_dump_flows }, { "dump-aggregate", 1, 2, do_dump_aggregate }, { "add-flow", 2, 2, do_add_flow }, { "add-flows", 2, 2, do_add_flows }, { "del-flows", 1, 2, do_del_flows }, { "dump-ports", 1, 1, do_dump_ports }, { "probe", 1, 1, do_probe }, { "ping", 1, 2, do_ping }, { "benchmark", 3, 3, do_benchmark }, { NULL, 0, 0, NULL }, };