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 " status SWITCH [KEY] report statistics (about KEY)\n"
162 " dump-desc SWITCH print switch description\n"
163 " dump-tables SWITCH print table stats\n"
164 " mod-port SWITCH IFACE ACT modify port behavior\n"
165 " dump-ports SWITCH [PORT] print port statistics\n"
166 " dump-flows SWITCH print all flow entries\n"
167 " dump-flows SWITCH FLOW print matching FLOWs\n"
168 " dump-aggregate SWITCH print aggregate flow statistics\n"
169 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
170 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
171 " add-flow SWITCH FLOW add flow described by FLOW\n"
172 " add-flows SWITCH FILE add flows from FILE\n"
173 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
174 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
175 " monitor SWITCH [MISSLEN] print packets received from SWITCH\n"
176 "\nFor OpenFlow switches and controllers:\n"
177 " probe VCONN probe whether VCONN is up\n"
178 " ping VCONN [N] latency of N-byte echos\n"
179 " benchmark VCONN N COUNT bandwidth of COUNT N-byte echos\n"
180 "where each SWITCH is an active OpenFlow connection method.\n",
181 program_name, program_name);
182 vconn_usage(true, false, false);
184 printf("\nOther options:\n"
185 " --strict use strict match for flow commands\n"
186 " -F, --flow-format=FORMAT force particular flow format\n"
187 " -m, --more be more verbose printing OpenFlow\n"
188 " -t, --timeout=SECS give up after SECS seconds\n"
189 " -h, --help display this help message\n"
190 " -V, --version display version information\n");
194 static void run(int retval, const char *message, ...)
197 static void run(int retval, const char *message, ...)
202 fprintf(stderr, "%s: ", program_name);
203 va_start(args, message);
204 vfprintf(stderr, message, args);
207 fputs(": unexpected end of file\n", stderr);
209 fprintf(stderr, ": %s\n", strerror(retval));
216 /* Generic commands. */
219 open_vconn_socket(const char *name, struct vconn **vconnp)
221 char *vconn_name = xasprintf("unix:%s", name);
222 VLOG_DBG("connecting to %s", vconn_name);
223 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
224 "connecting to %s", vconn_name);
229 open_vconn__(const char *name, const char *default_suffix,
230 struct vconn **vconnp)
234 char *bridge_path, *datapath_name, *datapath_type;
236 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
237 dp_parse_name(name, &datapath_name, &datapath_type);
239 if (strstr(name, ":")) {
240 run(vconn_open_block(name, OFP_VERSION, vconnp),
241 "connecting to %s", name);
242 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
243 open_vconn_socket(name, vconnp);
244 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
245 open_vconn_socket(bridge_path, vconnp);
246 } else if (!dpif_open(datapath_name, datapath_type, &dpif)) {
247 char dpif_name[IF_NAMESIZE + 1];
250 run(dpif_port_get_name(dpif, ODPP_LOCAL, dpif_name, sizeof dpif_name),
251 "obtaining name of %s", dpif_name);
253 if (strcmp(dpif_name, name)) {
254 VLOG_DBG("datapath %s is named %s", name, dpif_name);
257 socket_name = xasprintf("%s/%s.%s",
258 ovs_rundir(), dpif_name, default_suffix);
259 if (stat(socket_name, &s)) {
260 ovs_fatal(errno, "cannot connect to %s: stat failed on %s",
262 } else if (!S_ISSOCK(s.st_mode)) {
263 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
267 open_vconn_socket(socket_name, vconnp);
270 ovs_fatal(0, "%s is not a valid connection method", name);
279 open_vconn(const char *name, struct vconn **vconnp)
281 return open_vconn__(name, "mgmt", vconnp);
285 alloc_stats_request(size_t body_len, uint16_t type, struct ofpbuf **bufferp)
287 struct ofp_stats_request *rq;
288 rq = make_openflow((offsetof(struct ofp_stats_request, body)
289 + body_len), OFPT_STATS_REQUEST, bufferp);
290 rq->type = htons(type);
291 rq->flags = htons(0);
296 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
298 update_openflow_length(buffer);
299 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
303 dump_transaction(const char *vconn_name, struct ofpbuf *request)
306 struct ofpbuf *reply;
308 update_openflow_length(request);
309 open_vconn(vconn_name, &vconn);
310 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
311 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
316 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
318 struct ofpbuf *request;
319 make_openflow(sizeof(struct ofp_header), request_type, &request);
320 dump_transaction(vconn_name, request);
324 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
326 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
330 open_vconn(vconn_name, &vconn);
331 send_openflow_buffer(vconn, request);
334 struct ofpbuf *reply;
336 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
337 recv_xid = ((struct ofp_header *) reply->data)->xid;
338 if (send_xid == recv_xid) {
339 struct ofp_stats_reply *osr;
341 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
343 osr = ofpbuf_at(reply, 0, sizeof *osr);
344 done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
346 VLOG_DBG("received reply with xid %08"PRIx32" "
347 "!= expected %08"PRIx32, recv_xid, send_xid);
349 ofpbuf_delete(reply);
355 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
357 struct ofpbuf *request;
358 alloc_stats_request(0, stats_type, &request);
359 dump_stats_transaction(vconn_name, request);
362 /* Sends 'request', which should be a request that only has a reply if an error
363 * occurs, and waits for it to succeed or fail. If an error does occur, prints
364 * it and exits with an error. */
366 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
368 struct ofpbuf *request, *reply;
370 LIST_FOR_EACH (request, list_node, requests) {
371 update_openflow_length(request);
374 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
375 "talking to %s", vconn_get_name(vconn));
377 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
380 ofpbuf_delete(reply);
383 /* Sends 'request', which should be a request that only has a reply if an error
384 * occurs, and waits for it to succeed or fail. If an error does occur, prints
385 * it and exits with an error. */
387 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
389 struct list requests;
391 list_init(&requests);
392 list_push_back(&requests, &request->list_node);
393 transact_multiple_noreply(vconn, &requests);
397 do_show(int argc OVS_UNUSED, char *argv[])
399 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
400 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
404 do_status(int argc, char *argv[])
406 struct nicira_header *request, *reply;
410 request = make_nxmsg(sizeof *request, NXT_STATUS_REQUEST, &b);
412 ofpbuf_put(b, argv[2], strlen(argv[2]));
413 update_openflow_length(b);
415 open_vconn(argv[1], &vconn);
416 run(vconn_transact(vconn, b, &b), "talking to %s", argv[1]);
419 if (b->size < sizeof *reply) {
420 ovs_fatal(0, "short reply (%zu bytes)", b->size);
423 if (reply->header.type != OFPT_VENDOR
424 || reply->vendor != ntohl(NX_VENDOR_ID)
425 || reply->subtype != ntohl(NXT_STATUS_REPLY)) {
426 ofp_print(stderr, b->data, b->size, verbosity + 2);
427 ovs_fatal(0, "bad reply");
430 fwrite(reply + 1, b->size - sizeof *reply, 1, stdout);
434 do_dump_desc(int argc OVS_UNUSED, char *argv[])
436 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
440 do_dump_tables(int argc OVS_UNUSED, char *argv[])
442 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
445 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
446 * 'port_name' (which may be a port name or number), and copies it into
449 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
450 struct ofp_phy_port *oppp)
452 struct ofpbuf *request, *reply;
453 struct ofp_switch_features *osf;
454 unsigned int port_no;
459 /* Try to interpret the argument as a port number. */
460 if (!str_to_uint(port_name, 10, &port_no)) {
464 /* Fetch the switch's ofp_switch_features. */
465 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
466 open_vconn(vconn_name, &vconn);
467 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
470 if (reply->size < sizeof *osf) {
471 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
472 vconn_name, reply->size);
474 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
476 for (port_idx = 0; port_idx < n_ports; port_idx++) {
477 const struct ofp_phy_port *opp = &osf->ports[port_idx];
479 if (port_no != UINT_MAX
480 ? htons(port_no) == opp->port_no
481 : !strncmp(opp->name, port_name, sizeof opp->name)) {
483 ofpbuf_delete(reply);
488 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
491 /* Returns the port number corresponding to 'port_name' (which may be a port
492 * name or number) within the switch 'vconn_name'. */
494 str_to_port_no(const char *vconn_name, const char *port_name)
496 unsigned int port_no;
498 if (str_to_uint(port_name, 10, &port_no)) {
501 struct ofp_phy_port opp;
503 fetch_ofp_phy_port(vconn_name, port_name, &opp);
504 return ntohs(opp.port_no);
509 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
511 struct ofpbuf *sff, *reply;
513 sff = ofputil_make_set_flow_format(flow_format);
514 run(vconn_transact_noreply(vconn, sff, &reply),
515 "talking to %s", vconn_get_name(vconn));
517 char *s = ofp_to_string(reply->data, reply->size, 2);
518 VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
519 vconn_get_name(vconn),
520 ofputil_flow_format_to_string(flow_format),
523 ofpbuf_delete(reply);
530 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
532 struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
533 transact_noreply(vconn, sff);
534 VLOG_DBG("%s: using user-specified flow format %s",
535 vconn_get_name(vconn),
536 ofputil_flow_format_to_string(flow_format));
539 static enum nx_flow_format
540 negotiate_highest_flow_format(struct vconn *vconn, const struct cls_rule *rule,
541 bool cookie_support, ovs_be64 cookie)
543 enum nx_flow_format min_format;
545 min_format = ofputil_min_flow_format(rule, cookie_support, cookie);
546 if (preferred_flow_format != -1) {
547 if (preferred_flow_format < min_format) {
548 ovs_fatal(0, "%s: cannot use requested flow format %s for "
549 "specified flow", vconn_get_name(vconn),
550 ofputil_flow_format_to_string(min_format));
553 set_flow_format(vconn, preferred_flow_format);
554 return preferred_flow_format;
556 enum nx_flow_format flow_format;
558 if (try_set_flow_format(vconn, NXFF_NXM)) {
559 flow_format = NXFF_NXM;
560 } else if (try_set_flow_format(vconn, NXFF_TUN_ID_FROM_COOKIE)) {
561 flow_format = NXFF_TUN_ID_FROM_COOKIE;
563 flow_format = NXFF_OPENFLOW10;
566 if (flow_format < min_format) {
567 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
568 "%s for specified flow", vconn_get_name(vconn),
569 ofputil_flow_format_to_string(min_format));
572 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
573 ofputil_flow_format_to_string(flow_format));
579 do_dump_flows__(int argc, char *argv[], bool aggregate)
581 enum nx_flow_format flow_format;
582 struct flow_stats_request fsr;
583 struct ofpbuf *request;
586 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
588 open_vconn(argv[1], &vconn);
589 flow_format = negotiate_highest_flow_format(vconn, &fsr.match, false, 0);
590 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
591 dump_stats_transaction(argv[1], request);
596 do_dump_flows(int argc, char *argv[])
598 return do_dump_flows__(argc, argv, false);
602 do_dump_aggregate(int argc, char *argv[])
604 return do_dump_flows__(argc, argv, true);
608 do_queue_stats(int argc, char *argv[])
610 struct ofp_queue_stats_request *req;
611 struct ofpbuf *request;
613 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
615 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
616 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
618 req->port_no = htons(OFPP_ALL);
620 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
621 req->queue_id = htonl(atoi(argv[3]));
623 req->queue_id = htonl(OFPQ_ALL);
626 memset(req->pad, 0, sizeof req->pad);
628 dump_stats_transaction(argv[1], request);
631 /* Sets up the flow format for a vconn that will be used to modify the flow
632 * table. Returns the flow format used, after possibly adding an OpenFlow
633 * request to 'requests'.
635 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
636 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
637 * OpenFlow connection.
639 * If 'preferred_flow_format' is a specific format, adds a request to set that
640 * format to 'requests' and returns the format. */
641 static enum nx_flow_format
642 set_initial_format_for_flow_mod(struct list *requests)
644 if (preferred_flow_format < 0) {
645 return NXFF_OPENFLOW10;
649 sff = ofputil_make_set_flow_format(preferred_flow_format);
650 list_push_back(requests, &sff->list_node);
651 return preferred_flow_format;
655 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
656 * operation, given the global 'preferred_flow_format'. */
658 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
660 if (preferred_flow_format >= 0 && flow_format != preferred_flow_format) {
661 ovs_fatal(0, "flow cannot be expressed in flow format %s "
662 "(flow format %s or better is required)",
663 ofputil_flow_format_to_string(preferred_flow_format),
664 ofputil_flow_format_to_string(flow_format));
669 do_flow_mod__(int argc OVS_UNUSED, char *argv[], uint16_t command)
671 enum nx_flow_format flow_format;
672 struct list requests;
675 list_init(&requests);
676 flow_format = set_initial_format_for_flow_mod(&requests);
678 parse_ofp_flow_mod_str(&requests, &flow_format, argc > 2 ? argv[2] : "",
680 check_final_format_for_flow_mod(flow_format);
682 open_vconn(argv[1], &vconn);
683 transact_multiple_noreply(vconn, &requests);
688 do_add_flow(int argc, char *argv[])
690 do_flow_mod__(argc, argv, OFPFC_ADD);
694 do_add_flows(int argc OVS_UNUSED, char *argv[])
696 enum nx_flow_format flow_format;
697 struct list requests;
701 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
703 ovs_fatal(errno, "%s: open", argv[2]);
706 list_init(&requests);
707 flow_format = set_initial_format_for_flow_mod(&requests);
709 open_vconn(argv[1], &vconn);
710 while (parse_ofp_add_flow_file(&requests, &flow_format, file)) {
711 check_final_format_for_flow_mod(flow_format);
712 transact_multiple_noreply(vconn, &requests);
722 do_mod_flows(int argc, char *argv[])
724 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
728 do_del_flows(int argc, char *argv[])
730 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
734 monitor_vconn(struct vconn *vconn)
738 run(vconn_recv_block(vconn, &b), "vconn_recv");
739 ofp_print(stderr, b->data, b->size, verbosity + 2);
745 do_monitor(int argc, char *argv[])
749 open_vconn(argv[1], &vconn);
751 int miss_send_len = atoi(argv[2]);
752 struct ofp_switch_config *osc;
755 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
756 osc->miss_send_len = htons(miss_send_len);
757 transact_noreply(vconn, buf);
759 monitor_vconn(vconn);
763 do_snoop(int argc OVS_UNUSED, char *argv[])
767 open_vconn__(argv[1], "snoop", &vconn);
768 monitor_vconn(vconn);
772 do_dump_ports(int argc, char *argv[])
774 struct ofp_port_stats_request *req;
775 struct ofpbuf *request;
778 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
779 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
780 req->port_no = htons(port);
781 dump_stats_transaction(argv[1], request);
785 do_probe(int argc OVS_UNUSED, char *argv[])
787 struct ofpbuf *request;
789 struct ofpbuf *reply;
791 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
792 open_vconn(argv[1], &vconn);
793 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
794 if (reply->size != sizeof(struct ofp_header)) {
795 ovs_fatal(0, "reply does not match request");
797 ofpbuf_delete(reply);
802 do_mod_port(int argc OVS_UNUSED, char *argv[])
804 struct ofp_port_mod *opm;
805 struct ofp_phy_port opp;
806 struct ofpbuf *request;
809 fetch_ofp_phy_port(argv[1], argv[2], &opp);
811 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
812 opm->port_no = opp.port_no;
813 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
814 opm->config = htonl(0);
815 opm->mask = htonl(0);
816 opm->advertise = htonl(0);
818 if (!strcasecmp(argv[3], "up")) {
819 opm->mask |= htonl(OFPPC_PORT_DOWN);
820 } else if (!strcasecmp(argv[3], "down")) {
821 opm->mask |= htonl(OFPPC_PORT_DOWN);
822 opm->config |= htonl(OFPPC_PORT_DOWN);
823 } else if (!strcasecmp(argv[3], "flood")) {
824 opm->mask |= htonl(OFPPC_NO_FLOOD);
825 } else if (!strcasecmp(argv[3], "noflood")) {
826 opm->mask |= htonl(OFPPC_NO_FLOOD);
827 opm->config |= htonl(OFPPC_NO_FLOOD);
829 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
832 open_vconn(argv[1], &vconn);
833 transact_noreply(vconn, request);
838 do_ping(int argc, char *argv[])
840 size_t max_payload = 65535 - sizeof(struct ofp_header);
841 unsigned int payload;
845 payload = argc > 2 ? atoi(argv[2]) : 64;
846 if (payload > max_payload) {
847 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
850 open_vconn(argv[1], &vconn);
851 for (i = 0; i < 10; i++) {
852 struct timeval start, end;
853 struct ofpbuf *request, *reply;
854 struct ofp_header *rq_hdr, *rpy_hdr;
856 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
857 OFPT_ECHO_REQUEST, &request);
858 random_bytes(rq_hdr + 1, payload);
860 gettimeofday(&start, NULL);
861 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
862 gettimeofday(&end, NULL);
864 rpy_hdr = reply->data;
865 if (reply->size != request->size
866 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
867 || rpy_hdr->xid != rq_hdr->xid
868 || rpy_hdr->type != OFPT_ECHO_REPLY) {
869 printf("Reply does not match request. Request:\n");
870 ofp_print(stdout, request, request->size, verbosity + 2);
872 ofp_print(stdout, reply, reply->size, verbosity + 2);
874 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
875 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
876 (1000*(double)(end.tv_sec - start.tv_sec))
877 + (.001*(end.tv_usec - start.tv_usec)));
878 ofpbuf_delete(request);
879 ofpbuf_delete(reply);
885 do_benchmark(int argc OVS_UNUSED, char *argv[])
887 size_t max_payload = 65535 - sizeof(struct ofp_header);
888 struct timeval start, end;
889 unsigned int payload_size, message_size;
895 payload_size = atoi(argv[2]);
896 if (payload_size > max_payload) {
897 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
899 message_size = sizeof(struct ofp_header) + payload_size;
901 count = atoi(argv[3]);
903 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
904 count, message_size, count * message_size);
906 open_vconn(argv[1], &vconn);
907 gettimeofday(&start, NULL);
908 for (i = 0; i < count; i++) {
909 struct ofpbuf *request, *reply;
910 struct ofp_header *rq_hdr;
912 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
913 memset(rq_hdr + 1, 0, payload_size);
914 run(vconn_transact(vconn, request, &reply), "transact");
915 ofpbuf_delete(reply);
917 gettimeofday(&end, NULL);
920 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
921 + (.001*(end.tv_usec - start.tv_usec)));
922 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
923 duration, count / (duration / 1000.0),
924 count * message_size / (duration / 1000.0));
928 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
933 /* Undocumented commands for unit testing. */
936 print_packet_list(struct list *packets)
938 struct ofpbuf *packet, *next;
940 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
941 ofp_print(stdout, packet->data, packet->size, verbosity);
942 list_remove(&packet->list_node);
943 ofpbuf_delete(packet);
947 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
948 * it back to stdout. */
950 do_parse_flow(int argc OVS_UNUSED, char *argv[])
952 enum nx_flow_format flow_format;
955 flow_format = NXFF_OPENFLOW10;
956 if (preferred_flow_format > 0) {
957 flow_format = preferred_flow_format;
961 parse_ofp_flow_mod_str(&packets, &flow_format, argv[1], OFPFC_ADD);
962 print_packet_list(&packets);
965 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
966 * add-flows) and prints each of the flows back to stdout. */
968 do_parse_flows(int argc OVS_UNUSED, char *argv[])
970 enum nx_flow_format flow_format;
974 file = fopen(argv[1], "r");
976 ovs_fatal(errno, "%s: open", argv[2]);
979 flow_format = NXFF_OPENFLOW10;
980 if (preferred_flow_format > 0) {
981 flow_format = preferred_flow_format;
985 while (parse_ofp_add_flow_file(&packets, &flow_format, file)) {
986 print_packet_list(&packets);
991 /* "parse-nx-match": reads a series of nx_match specifications as strings from
992 * stdin, does some internal fussing with them, and then prints them back as
993 * strings on stdout. */
995 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1000 while (!ds_get_line(&in, stdin)) {
1001 struct ofpbuf nx_match;
1002 struct cls_rule rule;
1007 /* Delete comments, skip blank lines. */
1013 if (strchr(s, '#')) {
1014 *strchr(s, '#') = '\0';
1016 if (s[strspn(s, " ")] == '\0') {
1021 /* Convert string to nx_match. */
1022 ofpbuf_init(&nx_match, 0);
1023 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1025 /* Convert nx_match to cls_rule. */
1026 error = nx_pull_match(&nx_match, match_len, 0, &rule);
1030 /* Convert cls_rule back to nx_match. */
1031 ofpbuf_uninit(&nx_match);
1032 ofpbuf_init(&nx_match, 0);
1033 match_len = nx_put_match(&nx_match, &rule);
1035 /* Convert nx_match to string. */
1036 out = nx_match_to_string(nx_match.data, match_len);
1040 printf("nx_pull_match() returned error %x\n", error);
1043 ofpbuf_uninit(&nx_match);
1048 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1049 * binary data, interpreting them as an OpenFlow message, and prints the
1050 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1052 do_ofp_print(int argc, char *argv[])
1054 struct ofpbuf packet;
1056 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1057 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1058 ovs_fatal(0, "trailing garbage following hex bytes");
1060 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1061 ofpbuf_uninit(&packet);
1064 static const struct command all_commands[] = {
1065 { "show", 1, 1, do_show },
1066 { "status", 1, 2, do_status },
1067 { "monitor", 1, 2, do_monitor },
1068 { "snoop", 1, 1, do_snoop },
1069 { "dump-desc", 1, 1, do_dump_desc },
1070 { "dump-tables", 1, 1, do_dump_tables },
1071 { "dump-flows", 1, 2, do_dump_flows },
1072 { "dump-aggregate", 1, 2, do_dump_aggregate },
1073 { "queue-stats", 1, 3, do_queue_stats },
1074 { "add-flow", 2, 2, do_add_flow },
1075 { "add-flows", 2, 2, do_add_flows },
1076 { "mod-flows", 2, 2, do_mod_flows },
1077 { "del-flows", 1, 2, do_del_flows },
1078 { "dump-ports", 1, 2, do_dump_ports },
1079 { "mod-port", 3, 3, do_mod_port },
1080 { "probe", 1, 1, do_probe },
1081 { "ping", 1, 2, do_ping },
1082 { "benchmark", 3, 3, do_benchmark },
1083 { "help", 0, INT_MAX, do_help },
1085 /* Undocumented commands for testing. */
1086 { "parse-flow", 1, 1, do_parse_flow },
1087 { "parse-flows", 1, 1, do_parse_flows },
1088 { "parse-nx-match", 0, 0, do_parse_nx_match },
1089 { "ofp-print", 1, 2, do_ofp_print },
1091 { NULL, 0, 0, NULL },