Bring manpages and usage messages up-to-date.
[openvswitch] / utilities / dpctl.c
index a9c0d8b64fa42f0a8da14f2296430ebffcdfa347..2d09e98e0aa1d04c702b03fac47a621cde84f0e9 100644 (file)
@@ -35,6 +35,7 @@
 #include <getopt.h>
 #include <inttypes.h>
 #include <netinet/in.h>
+#include <stdarg.h>
 #include <stdlib.h>
 #include <string.h>
 #include <unistd.h>
@@ -56,7 +57,7 @@
 #include "vconn-ssl.h"
 
 #include "vlog.h"
-#define THIS_MODULE VLM_DPCTL
+#define THIS_MODULE VLM_dpctl
 
 static const char* ifconfigbin = "/sbin/ifconfig";
 
@@ -112,11 +113,7 @@ parse_options(int argc, char *argv[])
         {"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);
@@ -142,19 +139,7 @@ parse_options(int argc, char *argv[])
             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);
@@ -177,40 +162,49 @@ usage(void)
            "  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 also apply to remote switches:\n"
-           "  show VCONN                  show information about VCONN\n"
-           "  monitor VCONN               print packets received on VCONN\n"
-           "  dump-tables VCONN           print table stats for VCONN\n"
-           "  dump-flows VCONN T_ID       print all flow entries in table T_ID of VCONN\n"
-           "  dump-flows VCONN T_ID FLOW  print matching FLOWs in table T_ID of VCONN\n"
-           "  add-flows VCONN FILE        add flows from FILE to VCONN\n"
-           "where each VCONN is one of the following:\n"
-           "  tcp:HOST[:PORT]             PORT (default: %d) on remote TCP HOST\n",
-           program_name, program_name, OFP_TCP_PORT);
-#ifdef HAVE_NETLINK
-    printf("  nl:DP_IDX                   via netlink to local datapath DP_IDX\n");
-#endif
-#ifdef HAVE_OPENSSL
-    printf("  ssl:HOST[:PORT]             SSL PORT (default: %d) on remote HOST\n"
-           "\nPKI 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",
-           OFP_SSL_PORT);
-#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");
     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
@@ -268,6 +262,18 @@ static void do_del_port(int argc UNUSED, char *argv[])
     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[])
@@ -309,34 +315,153 @@ static void do_benchmark_nl(int argc UNUSED, char *argv[])
 \f
 /* Generic commands. */
 
-static void do_show(int argc UNUSED, char *argv[])
+static uint32_t
+random_xid(void)
 {
-#if 0
-    struct dpif dp;
-    run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
-    run(dpif_show(&dp), "show");
-    dpif_close(&dp);
-#endif
+    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 do_monitor(int argc UNUSED, char *argv[])
+static void *
+alloc_openflow_buffer(size_t openflow_len, uint8_t type,
+                      struct buffer **bufferp)
 {
-    struct dpif dp;
-    run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
+       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);
 }
 
 
@@ -377,10 +502,16 @@ str_to_action(const char *str, struct ofp_action *action)
 {
     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);
     }
@@ -391,7 +522,8 @@ str_to_action(const char *str, struct ofp_action *action)
 }
 
 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;
@@ -418,11 +550,17 @@ str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
     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;
@@ -433,6 +571,16 @@ str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
             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;
@@ -451,7 +599,7 @@ str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
 
     found:
         data = (char *) match + f->offset;
-        if (!strcmp(value, "*")) {
+        if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
             wildcards |= f->wildcard;
         } else {
             wildcards &= ~f->wildcard;
@@ -479,43 +627,47 @@ str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
 
 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;
@@ -531,30 +683,54 @@ static void do_add_flows(int argc, char *argv[])
             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_block(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();
@@ -574,6 +750,10 @@ static struct command all_commands[] = {
     { "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 },
+    { "del-flows", 1, 2, do_del_flows },
+    { "dump-ports", 1, 1, do_dump_ports },
+    { NULL, 0, 0, NULL },
 };