2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
29 #include "byte-order.h"
30 #include "classifier.h"
31 #include "command-line.h"
35 #include "dynamic-string.h"
39 #include "ofp-parse.h"
40 #include "ofp-print.h"
43 #include "openflow/nicira-ext.h"
44 #include "openflow/openflow.h"
46 #include "stream-ssl.h"
52 VLOG_DEFINE_THIS_MODULE(ofctl);
54 /* --strict: Use strict matching for flow mod commands? */
57 /* -F, --flow-format: Flow format to use. Either one of NXFF_* to force a
58 * particular flow format or -1 to let ovs-ofctl choose intelligently. */
59 static int preferred_flow_format = -1;
61 /* -m, --more: Additional verbosity for ofp-print functions. */
64 static const struct command all_commands[];
66 static void usage(void) NO_RETURN;
67 static void parse_options(int argc, char *argv[]);
70 main(int argc, char *argv[])
72 set_program_name(argv[0]);
73 parse_options(argc, argv);
74 signal(SIGPIPE, SIG_IGN);
75 run_command(argc - optind, argv + optind, all_commands);
80 parse_options(int argc, char *argv[])
83 OPT_STRICT = UCHAR_MAX + 1,
86 static struct option long_options[] = {
87 {"timeout", required_argument, 0, 't'},
88 {"strict", no_argument, 0, OPT_STRICT},
89 {"flow-format", required_argument, 0, 'F'},
90 {"more", no_argument, 0, 'm'},
91 {"help", no_argument, 0, 'h'},
92 {"version", no_argument, 0, 'V'},
94 STREAM_SSL_LONG_OPTIONS
97 char *short_options = long_options_to_short_options(long_options);
100 unsigned long int timeout;
103 c = getopt_long(argc, argv, short_options, long_options, NULL);
110 timeout = strtoul(optarg, NULL, 10);
112 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
120 preferred_flow_format = ofputil_flow_format_from_string(optarg);
121 if (preferred_flow_format < 0) {
122 ovs_fatal(0, "unknown flow format `%s'", optarg);
134 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
142 STREAM_SSL_OPTION_HANDLERS
157 printf("%s: OpenFlow switch management utility\n"
158 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
159 "\nFor OpenFlow switches:\n"
160 " show SWITCH show OpenFlow information\n"
161 " dump-desc SWITCH print switch description\n"
162 " dump-tables SWITCH print table stats\n"
163 " mod-port SWITCH IFACE ACT modify port behavior\n"
164 " dump-ports SWITCH [PORT] print port statistics\n"
165 " dump-flows SWITCH print all flow entries\n"
166 " dump-flows SWITCH FLOW print matching FLOWs\n"
167 " dump-aggregate SWITCH print aggregate flow statistics\n"
168 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
169 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
170 " add-flow SWITCH FLOW add flow described by FLOW\n"
171 " add-flows SWITCH FILE add flows from FILE\n"
172 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
173 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
174 " monitor SWITCH [MISSLEN] print packets received from SWITCH\n"
175 "\nFor OpenFlow switches and controllers:\n"
176 " probe VCONN probe whether VCONN is up\n"
177 " ping VCONN [N] latency of N-byte echos\n"
178 " benchmark VCONN N COUNT bandwidth of COUNT N-byte echos\n"
179 "where each SWITCH is an active OpenFlow connection method.\n",
180 program_name, program_name);
181 vconn_usage(true, false, false);
183 printf("\nOther options:\n"
184 " --strict use strict match for flow commands\n"
185 " -F, --flow-format=FORMAT force particular flow format\n"
186 " -m, --more be more verbose printing OpenFlow\n"
187 " -t, --timeout=SECS give up after SECS seconds\n"
188 " -h, --help display this help message\n"
189 " -V, --version display version information\n");
193 static void run(int retval, const char *message, ...)
196 static void run(int retval, const char *message, ...)
201 fprintf(stderr, "%s: ", program_name);
202 va_start(args, message);
203 vfprintf(stderr, message, args);
206 fputs(": unexpected end of file\n", stderr);
208 fprintf(stderr, ": %s\n", strerror(retval));
215 /* Generic commands. */
218 open_vconn_socket(const char *name, struct vconn **vconnp)
220 char *vconn_name = xasprintf("unix:%s", name);
221 VLOG_DBG("connecting to %s", vconn_name);
222 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
223 "connecting to %s", vconn_name);
228 open_vconn__(const char *name, const char *default_suffix,
229 struct vconn **vconnp)
233 char *bridge_path, *datapath_name, *datapath_type;
235 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
236 dp_parse_name(name, &datapath_name, &datapath_type);
238 if (strstr(name, ":")) {
239 run(vconn_open_block(name, OFP_VERSION, vconnp),
240 "connecting to %s", name);
241 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
242 open_vconn_socket(name, vconnp);
243 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
244 open_vconn_socket(bridge_path, vconnp);
245 } else if (!dpif_open(datapath_name, datapath_type, &dpif)) {
246 char dpif_name[IF_NAMESIZE + 1];
249 run(dpif_port_get_name(dpif, ODPP_LOCAL, dpif_name, sizeof dpif_name),
250 "obtaining name of %s", dpif_name);
252 if (strcmp(dpif_name, name)) {
253 VLOG_DBG("datapath %s is named %s", name, dpif_name);
256 socket_name = xasprintf("%s/%s.%s",
257 ovs_rundir(), dpif_name, default_suffix);
258 if (stat(socket_name, &s)) {
259 ovs_fatal(errno, "cannot connect to %s: stat failed on %s",
261 } else if (!S_ISSOCK(s.st_mode)) {
262 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
266 open_vconn_socket(socket_name, vconnp);
269 ovs_fatal(0, "%s is not a valid connection method", name);
278 open_vconn(const char *name, struct vconn **vconnp)
280 return open_vconn__(name, "mgmt", vconnp);
284 alloc_stats_request(size_t body_len, uint16_t type, struct ofpbuf **bufferp)
286 struct ofp_stats_request *rq;
287 rq = make_openflow((offsetof(struct ofp_stats_request, body)
288 + body_len), OFPT_STATS_REQUEST, bufferp);
289 rq->type = htons(type);
290 rq->flags = htons(0);
295 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
297 update_openflow_length(buffer);
298 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
302 dump_transaction(const char *vconn_name, struct ofpbuf *request)
305 struct ofpbuf *reply;
307 update_openflow_length(request);
308 open_vconn(vconn_name, &vconn);
309 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
310 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
315 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
317 struct ofpbuf *request;
318 make_openflow(sizeof(struct ofp_header), request_type, &request);
319 dump_transaction(vconn_name, request);
323 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
325 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
329 open_vconn(vconn_name, &vconn);
330 send_openflow_buffer(vconn, request);
333 struct ofpbuf *reply;
335 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
336 recv_xid = ((struct ofp_header *) reply->data)->xid;
337 if (send_xid == recv_xid) {
338 struct ofp_stats_reply *osr;
340 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
342 osr = ofpbuf_at(reply, 0, sizeof *osr);
343 done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
345 VLOG_DBG("received reply with xid %08"PRIx32" "
346 "!= expected %08"PRIx32, recv_xid, send_xid);
348 ofpbuf_delete(reply);
354 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
356 struct ofpbuf *request;
357 alloc_stats_request(0, stats_type, &request);
358 dump_stats_transaction(vconn_name, request);
361 /* Sends 'request', which should be a request that only has a reply if an error
362 * occurs, and waits for it to succeed or fail. If an error does occur, prints
363 * it and exits with an error. */
365 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
367 struct ofpbuf *request, *reply;
369 LIST_FOR_EACH (request, list_node, requests) {
370 update_openflow_length(request);
373 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
374 "talking to %s", vconn_get_name(vconn));
376 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
379 ofpbuf_delete(reply);
382 /* Sends 'request', which should be a request that only has a reply if an error
383 * occurs, and waits for it to succeed or fail. If an error does occur, prints
384 * it and exits with an error. */
386 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
388 struct list requests;
390 list_init(&requests);
391 list_push_back(&requests, &request->list_node);
392 transact_multiple_noreply(vconn, &requests);
396 do_show(int argc OVS_UNUSED, char *argv[])
398 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
399 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
403 do_dump_desc(int argc OVS_UNUSED, char *argv[])
405 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
409 do_dump_tables(int argc OVS_UNUSED, char *argv[])
411 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
414 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
415 * 'port_name' (which may be a port name or number), and copies it into
418 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
419 struct ofp_phy_port *oppp)
421 struct ofpbuf *request, *reply;
422 struct ofp_switch_features *osf;
423 unsigned int port_no;
428 /* Try to interpret the argument as a port number. */
429 if (!str_to_uint(port_name, 10, &port_no)) {
433 /* Fetch the switch's ofp_switch_features. */
434 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
435 open_vconn(vconn_name, &vconn);
436 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
439 if (reply->size < sizeof *osf) {
440 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
441 vconn_name, reply->size);
443 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
445 for (port_idx = 0; port_idx < n_ports; port_idx++) {
446 const struct ofp_phy_port *opp = &osf->ports[port_idx];
448 if (port_no != UINT_MAX
449 ? htons(port_no) == opp->port_no
450 : !strncmp(opp->name, port_name, sizeof opp->name)) {
452 ofpbuf_delete(reply);
457 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
460 /* Returns the port number corresponding to 'port_name' (which may be a port
461 * name or number) within the switch 'vconn_name'. */
463 str_to_port_no(const char *vconn_name, const char *port_name)
465 unsigned int port_no;
467 if (str_to_uint(port_name, 10, &port_no)) {
470 struct ofp_phy_port opp;
472 fetch_ofp_phy_port(vconn_name, port_name, &opp);
473 return ntohs(opp.port_no);
478 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
480 struct ofpbuf *sff, *reply;
482 sff = ofputil_make_set_flow_format(flow_format);
483 run(vconn_transact_noreply(vconn, sff, &reply),
484 "talking to %s", vconn_get_name(vconn));
486 char *s = ofp_to_string(reply->data, reply->size, 2);
487 VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
488 vconn_get_name(vconn),
489 ofputil_flow_format_to_string(flow_format),
492 ofpbuf_delete(reply);
499 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
501 struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
502 transact_noreply(vconn, sff);
503 VLOG_DBG("%s: using user-specified flow format %s",
504 vconn_get_name(vconn),
505 ofputil_flow_format_to_string(flow_format));
508 static enum nx_flow_format
509 negotiate_highest_flow_format(struct vconn *vconn, const struct cls_rule *rule,
510 bool cookie_support, ovs_be64 cookie)
512 enum nx_flow_format min_format;
514 min_format = ofputil_min_flow_format(rule, cookie_support, cookie);
515 if (preferred_flow_format != -1) {
516 if (preferred_flow_format < min_format) {
517 ovs_fatal(0, "%s: cannot use requested flow format %s for "
518 "specified flow", vconn_get_name(vconn),
519 ofputil_flow_format_to_string(min_format));
522 set_flow_format(vconn, preferred_flow_format);
523 return preferred_flow_format;
525 enum nx_flow_format flow_format;
527 if (try_set_flow_format(vconn, NXFF_NXM)) {
528 flow_format = NXFF_NXM;
529 } else if (try_set_flow_format(vconn, NXFF_TUN_ID_FROM_COOKIE)) {
530 flow_format = NXFF_TUN_ID_FROM_COOKIE;
532 flow_format = NXFF_OPENFLOW10;
535 if (flow_format < min_format) {
536 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
537 "%s for specified flow", vconn_get_name(vconn),
538 ofputil_flow_format_to_string(min_format));
541 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
542 ofputil_flow_format_to_string(flow_format));
548 do_dump_flows__(int argc, char *argv[], bool aggregate)
550 enum nx_flow_format flow_format;
551 struct flow_stats_request fsr;
552 struct ofpbuf *request;
555 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
557 open_vconn(argv[1], &vconn);
558 flow_format = negotiate_highest_flow_format(vconn, &fsr.match, false, 0);
559 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
560 dump_stats_transaction(argv[1], request);
565 do_dump_flows(int argc, char *argv[])
567 return do_dump_flows__(argc, argv, false);
571 do_dump_aggregate(int argc, char *argv[])
573 return do_dump_flows__(argc, argv, true);
577 do_queue_stats(int argc, char *argv[])
579 struct ofp_queue_stats_request *req;
580 struct ofpbuf *request;
582 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
584 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
585 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
587 req->port_no = htons(OFPP_ALL);
589 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
590 req->queue_id = htonl(atoi(argv[3]));
592 req->queue_id = htonl(OFPQ_ALL);
595 memset(req->pad, 0, sizeof req->pad);
597 dump_stats_transaction(argv[1], request);
600 /* Sets up the flow format for a vconn that will be used to modify the flow
601 * table. Returns the flow format used, after possibly adding an OpenFlow
602 * request to 'requests'.
604 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
605 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
606 * OpenFlow connection.
608 * If 'preferred_flow_format' is a specific format, adds a request to set that
609 * format to 'requests' and returns the format. */
610 static enum nx_flow_format
611 set_initial_format_for_flow_mod(struct list *requests)
613 if (preferred_flow_format < 0) {
614 return NXFF_OPENFLOW10;
618 sff = ofputil_make_set_flow_format(preferred_flow_format);
619 list_push_back(requests, &sff->list_node);
620 return preferred_flow_format;
624 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
625 * operation, given the global 'preferred_flow_format'. */
627 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
629 if (preferred_flow_format >= 0 && flow_format != preferred_flow_format) {
630 ovs_fatal(0, "flow cannot be expressed in flow format %s "
631 "(flow format %s or better is required)",
632 ofputil_flow_format_to_string(preferred_flow_format),
633 ofputil_flow_format_to_string(flow_format));
638 do_flow_mod__(int argc OVS_UNUSED, char *argv[], uint16_t command)
640 enum nx_flow_format flow_format;
641 struct list requests;
644 list_init(&requests);
645 flow_format = set_initial_format_for_flow_mod(&requests);
647 parse_ofp_flow_mod_str(&requests, &flow_format, argc > 2 ? argv[2] : "",
649 check_final_format_for_flow_mod(flow_format);
651 open_vconn(argv[1], &vconn);
652 transact_multiple_noreply(vconn, &requests);
657 do_add_flow(int argc, char *argv[])
659 do_flow_mod__(argc, argv, OFPFC_ADD);
663 do_add_flows(int argc OVS_UNUSED, char *argv[])
665 enum nx_flow_format flow_format;
666 struct list requests;
670 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
672 ovs_fatal(errno, "%s: open", argv[2]);
675 list_init(&requests);
676 flow_format = set_initial_format_for_flow_mod(&requests);
678 open_vconn(argv[1], &vconn);
679 while (parse_ofp_add_flow_file(&requests, &flow_format, file)) {
680 check_final_format_for_flow_mod(flow_format);
681 transact_multiple_noreply(vconn, &requests);
691 do_mod_flows(int argc, char *argv[])
693 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
697 do_del_flows(int argc, char *argv[])
699 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
703 monitor_vconn(struct vconn *vconn)
707 run(vconn_recv_block(vconn, &b), "vconn_recv");
708 ofp_print(stderr, b->data, b->size, verbosity + 2);
714 do_monitor(int argc, char *argv[])
718 open_vconn(argv[1], &vconn);
720 int miss_send_len = atoi(argv[2]);
721 struct ofp_switch_config *osc;
724 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
725 osc->miss_send_len = htons(miss_send_len);
726 transact_noreply(vconn, buf);
728 monitor_vconn(vconn);
732 do_snoop(int argc OVS_UNUSED, char *argv[])
736 open_vconn__(argv[1], "snoop", &vconn);
737 monitor_vconn(vconn);
741 do_dump_ports(int argc, char *argv[])
743 struct ofp_port_stats_request *req;
744 struct ofpbuf *request;
747 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
748 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
749 req->port_no = htons(port);
750 dump_stats_transaction(argv[1], request);
754 do_probe(int argc OVS_UNUSED, char *argv[])
756 struct ofpbuf *request;
758 struct ofpbuf *reply;
760 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
761 open_vconn(argv[1], &vconn);
762 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
763 if (reply->size != sizeof(struct ofp_header)) {
764 ovs_fatal(0, "reply does not match request");
766 ofpbuf_delete(reply);
771 do_mod_port(int argc OVS_UNUSED, char *argv[])
773 struct ofp_port_mod *opm;
774 struct ofp_phy_port opp;
775 struct ofpbuf *request;
778 fetch_ofp_phy_port(argv[1], argv[2], &opp);
780 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
781 opm->port_no = opp.port_no;
782 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
783 opm->config = htonl(0);
784 opm->mask = htonl(0);
785 opm->advertise = htonl(0);
787 if (!strcasecmp(argv[3], "up")) {
788 opm->mask |= htonl(OFPPC_PORT_DOWN);
789 } else if (!strcasecmp(argv[3], "down")) {
790 opm->mask |= htonl(OFPPC_PORT_DOWN);
791 opm->config |= htonl(OFPPC_PORT_DOWN);
792 } else if (!strcasecmp(argv[3], "flood")) {
793 opm->mask |= htonl(OFPPC_NO_FLOOD);
794 } else if (!strcasecmp(argv[3], "noflood")) {
795 opm->mask |= htonl(OFPPC_NO_FLOOD);
796 opm->config |= htonl(OFPPC_NO_FLOOD);
798 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
801 open_vconn(argv[1], &vconn);
802 transact_noreply(vconn, request);
807 do_ping(int argc, char *argv[])
809 size_t max_payload = 65535 - sizeof(struct ofp_header);
810 unsigned int payload;
814 payload = argc > 2 ? atoi(argv[2]) : 64;
815 if (payload > max_payload) {
816 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
819 open_vconn(argv[1], &vconn);
820 for (i = 0; i < 10; i++) {
821 struct timeval start, end;
822 struct ofpbuf *request, *reply;
823 struct ofp_header *rq_hdr, *rpy_hdr;
825 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
826 OFPT_ECHO_REQUEST, &request);
827 random_bytes(rq_hdr + 1, payload);
829 gettimeofday(&start, NULL);
830 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
831 gettimeofday(&end, NULL);
833 rpy_hdr = reply->data;
834 if (reply->size != request->size
835 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
836 || rpy_hdr->xid != rq_hdr->xid
837 || rpy_hdr->type != OFPT_ECHO_REPLY) {
838 printf("Reply does not match request. Request:\n");
839 ofp_print(stdout, request, request->size, verbosity + 2);
841 ofp_print(stdout, reply, reply->size, verbosity + 2);
843 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
844 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
845 (1000*(double)(end.tv_sec - start.tv_sec))
846 + (.001*(end.tv_usec - start.tv_usec)));
847 ofpbuf_delete(request);
848 ofpbuf_delete(reply);
854 do_benchmark(int argc OVS_UNUSED, char *argv[])
856 size_t max_payload = 65535 - sizeof(struct ofp_header);
857 struct timeval start, end;
858 unsigned int payload_size, message_size;
864 payload_size = atoi(argv[2]);
865 if (payload_size > max_payload) {
866 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
868 message_size = sizeof(struct ofp_header) + payload_size;
870 count = atoi(argv[3]);
872 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
873 count, message_size, count * message_size);
875 open_vconn(argv[1], &vconn);
876 gettimeofday(&start, NULL);
877 for (i = 0; i < count; i++) {
878 struct ofpbuf *request, *reply;
879 struct ofp_header *rq_hdr;
881 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
882 memset(rq_hdr + 1, 0, payload_size);
883 run(vconn_transact(vconn, request, &reply), "transact");
884 ofpbuf_delete(reply);
886 gettimeofday(&end, NULL);
889 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
890 + (.001*(end.tv_usec - start.tv_usec)));
891 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
892 duration, count / (duration / 1000.0),
893 count * message_size / (duration / 1000.0));
897 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
902 /* Undocumented commands for unit testing. */
905 print_packet_list(struct list *packets)
907 struct ofpbuf *packet, *next;
909 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
910 ofp_print(stdout, packet->data, packet->size, verbosity);
911 list_remove(&packet->list_node);
912 ofpbuf_delete(packet);
916 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
917 * it back to stdout. */
919 do_parse_flow(int argc OVS_UNUSED, char *argv[])
921 enum nx_flow_format flow_format;
924 flow_format = NXFF_OPENFLOW10;
925 if (preferred_flow_format > 0) {
926 flow_format = preferred_flow_format;
930 parse_ofp_flow_mod_str(&packets, &flow_format, argv[1], OFPFC_ADD);
931 print_packet_list(&packets);
934 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
935 * add-flows) and prints each of the flows back to stdout. */
937 do_parse_flows(int argc OVS_UNUSED, char *argv[])
939 enum nx_flow_format flow_format;
943 file = fopen(argv[1], "r");
945 ovs_fatal(errno, "%s: open", argv[2]);
948 flow_format = NXFF_OPENFLOW10;
949 if (preferred_flow_format > 0) {
950 flow_format = preferred_flow_format;
954 while (parse_ofp_add_flow_file(&packets, &flow_format, file)) {
955 print_packet_list(&packets);
960 /* "parse-nx-match": reads a series of nx_match specifications as strings from
961 * stdin, does some internal fussing with them, and then prints them back as
962 * strings on stdout. */
964 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
969 while (!ds_get_line(&in, stdin)) {
970 struct ofpbuf nx_match;
971 struct cls_rule rule;
976 /* Delete comments, skip blank lines. */
982 if (strchr(s, '#')) {
983 *strchr(s, '#') = '\0';
985 if (s[strspn(s, " ")] == '\0') {
990 /* Convert string to nx_match. */
991 ofpbuf_init(&nx_match, 0);
992 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
994 /* Convert nx_match to cls_rule. */
995 error = nx_pull_match(&nx_match, match_len, 0, &rule);
999 /* Convert cls_rule back to nx_match. */
1000 ofpbuf_uninit(&nx_match);
1001 ofpbuf_init(&nx_match, 0);
1002 match_len = nx_put_match(&nx_match, &rule);
1004 /* Convert nx_match to string. */
1005 out = nx_match_to_string(nx_match.data, match_len);
1009 printf("nx_pull_match() returned error %x\n", error);
1012 ofpbuf_uninit(&nx_match);
1017 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1018 * binary data, interpreting them as an OpenFlow message, and prints the
1019 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1021 do_ofp_print(int argc, char *argv[])
1023 struct ofpbuf packet;
1025 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1026 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1027 ovs_fatal(0, "trailing garbage following hex bytes");
1029 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1030 ofpbuf_uninit(&packet);
1033 static const struct command all_commands[] = {
1034 { "show", 1, 1, do_show },
1035 { "monitor", 1, 2, do_monitor },
1036 { "snoop", 1, 1, do_snoop },
1037 { "dump-desc", 1, 1, do_dump_desc },
1038 { "dump-tables", 1, 1, do_dump_tables },
1039 { "dump-flows", 1, 2, do_dump_flows },
1040 { "dump-aggregate", 1, 2, do_dump_aggregate },
1041 { "queue-stats", 1, 3, do_queue_stats },
1042 { "add-flow", 2, 2, do_add_flow },
1043 { "add-flows", 2, 2, do_add_flows },
1044 { "mod-flows", 2, 2, do_mod_flows },
1045 { "del-flows", 1, 2, do_del_flows },
1046 { "dump-ports", 1, 2, do_dump_ports },
1047 { "mod-port", 3, 3, do_mod_port },
1048 { "probe", 1, 1, do_probe },
1049 { "ping", 1, 2, do_ping },
1050 { "benchmark", 3, 3, do_benchmark },
1051 { "help", 0, INT_MAX, do_help },
1053 /* Undocumented commands for testing. */
1054 { "parse-flow", 1, 1, do_parse_flow },
1055 { "parse-flows", 1, 1, do_parse_flows },
1056 { "parse-nx-match", 0, 0, do_parse_nx_match },
1057 { "ofp-print", 1, 2, do_ofp_print },
1059 { NULL, 0, 0, NULL },