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,
510 enum nx_flow_format min_format)
512 if (preferred_flow_format != -1) {
513 if (preferred_flow_format < min_format) {
514 ovs_fatal(0, "%s: cannot use requested flow format %s for "
515 "specified flow", vconn_get_name(vconn),
516 ofputil_flow_format_to_string(min_format));
519 set_flow_format(vconn, preferred_flow_format);
520 return preferred_flow_format;
522 enum nx_flow_format flow_format;
524 if (try_set_flow_format(vconn, NXFF_NXM)) {
525 flow_format = NXFF_NXM;
526 } else if (try_set_flow_format(vconn, NXFF_TUN_ID_FROM_COOKIE)) {
527 flow_format = NXFF_TUN_ID_FROM_COOKIE;
529 flow_format = NXFF_OPENFLOW10;
532 if (flow_format < min_format) {
533 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
534 "%s for specified flow", vconn_get_name(vconn),
535 ofputil_flow_format_to_string(min_format));
538 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
539 ofputil_flow_format_to_string(flow_format));
545 do_dump_flows__(int argc, char *argv[], bool aggregate)
547 enum nx_flow_format min_flow_format, flow_format;
548 struct flow_stats_request fsr;
549 struct ofpbuf *request;
552 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
554 open_vconn(argv[1], &vconn);
555 min_flow_format = ofputil_min_flow_format(&fsr.match, false, 0);
556 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
557 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
558 dump_stats_transaction(argv[1], request);
563 do_dump_flows(int argc, char *argv[])
565 return do_dump_flows__(argc, argv, false);
569 do_dump_aggregate(int argc, char *argv[])
571 return do_dump_flows__(argc, argv, true);
575 do_queue_stats(int argc, char *argv[])
577 struct ofp_queue_stats_request *req;
578 struct ofpbuf *request;
580 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
582 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
583 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
585 req->port_no = htons(OFPP_ALL);
587 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
588 req->queue_id = htonl(atoi(argv[3]));
590 req->queue_id = htonl(OFPQ_ALL);
593 memset(req->pad, 0, sizeof req->pad);
595 dump_stats_transaction(argv[1], request);
598 /* Sets up the flow format for a vconn that will be used to modify the flow
599 * table. Returns the flow format used, after possibly adding an OpenFlow
600 * request to 'requests'.
602 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
603 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
604 * OpenFlow connection.
606 * If 'preferred_flow_format' is a specific format, adds a request to set that
607 * format to 'requests' and returns the format. */
608 static enum nx_flow_format
609 set_initial_format_for_flow_mod(struct list *requests)
611 if (preferred_flow_format < 0) {
612 return NXFF_OPENFLOW10;
616 sff = ofputil_make_set_flow_format(preferred_flow_format);
617 list_push_back(requests, &sff->list_node);
618 return preferred_flow_format;
622 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
623 * operation, given the global 'preferred_flow_format'. */
625 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
627 if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
628 ovs_fatal(0, "flow cannot be expressed in flow format %s "
629 "(flow format %s or better is required)",
630 ofputil_flow_format_to_string(preferred_flow_format),
631 ofputil_flow_format_to_string(flow_format));
636 do_flow_mod__(int argc OVS_UNUSED, char *argv[], uint16_t command)
638 enum nx_flow_format flow_format;
639 struct list requests;
642 list_init(&requests);
643 flow_format = set_initial_format_for_flow_mod(&requests);
645 parse_ofp_flow_mod_str(&requests, &flow_format, argc > 2 ? argv[2] : "",
647 check_final_format_for_flow_mod(flow_format);
649 open_vconn(argv[1], &vconn);
650 transact_multiple_noreply(vconn, &requests);
655 do_add_flow(int argc, char *argv[])
657 do_flow_mod__(argc, argv, OFPFC_ADD);
661 do_add_flows(int argc OVS_UNUSED, char *argv[])
663 enum nx_flow_format flow_format;
664 struct list requests;
668 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
670 ovs_fatal(errno, "%s: open", argv[2]);
673 list_init(&requests);
674 flow_format = set_initial_format_for_flow_mod(&requests);
676 open_vconn(argv[1], &vconn);
677 while (parse_ofp_flow_mod_file(&requests, &flow_format, file, OFPFC_ADD)) {
678 check_final_format_for_flow_mod(flow_format);
679 transact_multiple_noreply(vconn, &requests);
689 do_mod_flows(int argc, char *argv[])
691 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
695 do_del_flows(int argc, char *argv[])
697 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
701 monitor_vconn(struct vconn *vconn)
705 run(vconn_recv_block(vconn, &b), "vconn_recv");
706 ofp_print(stderr, b->data, b->size, verbosity + 2);
712 do_monitor(int argc, char *argv[])
716 open_vconn(argv[1], &vconn);
718 int miss_send_len = atoi(argv[2]);
719 struct ofp_switch_config *osc;
722 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
723 osc->miss_send_len = htons(miss_send_len);
724 transact_noreply(vconn, buf);
726 monitor_vconn(vconn);
730 do_snoop(int argc OVS_UNUSED, char *argv[])
734 open_vconn__(argv[1], "snoop", &vconn);
735 monitor_vconn(vconn);
739 do_dump_ports(int argc, char *argv[])
741 struct ofp_port_stats_request *req;
742 struct ofpbuf *request;
745 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
746 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
747 req->port_no = htons(port);
748 dump_stats_transaction(argv[1], request);
752 do_probe(int argc OVS_UNUSED, char *argv[])
754 struct ofpbuf *request;
756 struct ofpbuf *reply;
758 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
759 open_vconn(argv[1], &vconn);
760 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
761 if (reply->size != sizeof(struct ofp_header)) {
762 ovs_fatal(0, "reply does not match request");
764 ofpbuf_delete(reply);
769 do_mod_port(int argc OVS_UNUSED, char *argv[])
771 struct ofp_port_mod *opm;
772 struct ofp_phy_port opp;
773 struct ofpbuf *request;
776 fetch_ofp_phy_port(argv[1], argv[2], &opp);
778 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
779 opm->port_no = opp.port_no;
780 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
781 opm->config = htonl(0);
782 opm->mask = htonl(0);
783 opm->advertise = htonl(0);
785 if (!strcasecmp(argv[3], "up")) {
786 opm->mask |= htonl(OFPPC_PORT_DOWN);
787 } else if (!strcasecmp(argv[3], "down")) {
788 opm->mask |= htonl(OFPPC_PORT_DOWN);
789 opm->config |= htonl(OFPPC_PORT_DOWN);
790 } else if (!strcasecmp(argv[3], "flood")) {
791 opm->mask |= htonl(OFPPC_NO_FLOOD);
792 } else if (!strcasecmp(argv[3], "noflood")) {
793 opm->mask |= htonl(OFPPC_NO_FLOOD);
794 opm->config |= htonl(OFPPC_NO_FLOOD);
796 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
799 open_vconn(argv[1], &vconn);
800 transact_noreply(vconn, request);
805 do_ping(int argc, char *argv[])
807 size_t max_payload = 65535 - sizeof(struct ofp_header);
808 unsigned int payload;
812 payload = argc > 2 ? atoi(argv[2]) : 64;
813 if (payload > max_payload) {
814 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
817 open_vconn(argv[1], &vconn);
818 for (i = 0; i < 10; i++) {
819 struct timeval start, end;
820 struct ofpbuf *request, *reply;
821 struct ofp_header *rq_hdr, *rpy_hdr;
823 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
824 OFPT_ECHO_REQUEST, &request);
825 random_bytes(rq_hdr + 1, payload);
827 gettimeofday(&start, NULL);
828 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
829 gettimeofday(&end, NULL);
831 rpy_hdr = reply->data;
832 if (reply->size != request->size
833 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
834 || rpy_hdr->xid != rq_hdr->xid
835 || rpy_hdr->type != OFPT_ECHO_REPLY) {
836 printf("Reply does not match request. Request:\n");
837 ofp_print(stdout, request, request->size, verbosity + 2);
839 ofp_print(stdout, reply, reply->size, verbosity + 2);
841 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
842 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
843 (1000*(double)(end.tv_sec - start.tv_sec))
844 + (.001*(end.tv_usec - start.tv_usec)));
845 ofpbuf_delete(request);
846 ofpbuf_delete(reply);
852 do_benchmark(int argc OVS_UNUSED, char *argv[])
854 size_t max_payload = 65535 - sizeof(struct ofp_header);
855 struct timeval start, end;
856 unsigned int payload_size, message_size;
862 payload_size = atoi(argv[2]);
863 if (payload_size > max_payload) {
864 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
866 message_size = sizeof(struct ofp_header) + payload_size;
868 count = atoi(argv[3]);
870 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
871 count, message_size, count * message_size);
873 open_vconn(argv[1], &vconn);
874 gettimeofday(&start, NULL);
875 for (i = 0; i < count; i++) {
876 struct ofpbuf *request, *reply;
877 struct ofp_header *rq_hdr;
879 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
880 memset(rq_hdr + 1, 0, payload_size);
881 run(vconn_transact(vconn, request, &reply), "transact");
882 ofpbuf_delete(reply);
884 gettimeofday(&end, NULL);
887 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
888 + (.001*(end.tv_usec - start.tv_usec)));
889 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
890 duration, count / (duration / 1000.0),
891 count * message_size / (duration / 1000.0));
895 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
900 /* replace-flows and diff-flows commands. */
902 /* A flow table entry, possibly with two different versions. */
904 struct cls_rule rule; /* Within a "struct classifier". */
905 struct fte_version *versions[2];
908 /* One version of a Flow Table Entry. */
911 uint16_t idle_timeout;
912 uint16_t hard_timeout;
914 union ofp_action *actions;
918 /* Frees 'version' and the data that it owns. */
920 fte_version_free(struct fte_version *version)
923 free(version->actions);
928 /* Returns true if 'a' and 'b' are the same, false if they differ.
930 * Ignores differences in 'flags' because there's no way to retrieve flags from
931 * an OpenFlow switch. We have to assume that they are the same. */
933 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
935 return (a->cookie == b->cookie
936 && a->idle_timeout == b->idle_timeout
937 && a->hard_timeout == b->hard_timeout
938 && a->n_actions == b->n_actions
939 && !memcmp(a->actions, b->actions,
940 a->n_actions * sizeof *a->actions));
943 /* Prints 'version' on stdout. Expects the caller to have printed the rule
944 * associated with the version. */
946 fte_version_print(const struct fte_version *version)
950 if (version->cookie != htonll(0)) {
951 printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
953 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
954 printf(" idle_timeout=%"PRIu16, version->idle_timeout);
956 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
957 printf(" hard_timeout=%"PRIu16, version->hard_timeout);
961 ofp_print_actions(&s, (const struct ofp_action_header *) version->actions,
962 version->n_actions * sizeof *version->actions);
963 printf(" %s\n", ds_cstr(&s));
968 fte_from_cls_rule(const struct cls_rule *cls_rule)
970 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
973 /* Frees 'fte' and its versions. */
975 fte_free(struct fte *fte)
978 fte_version_free(fte->versions[0]);
979 fte_version_free(fte->versions[1]);
984 /* Frees all of the FTEs within 'cls'. */
986 fte_free_all(struct classifier *cls)
988 struct cls_cursor cursor;
989 struct fte *fte, *next;
991 cls_cursor_init(&cursor, cls, NULL);
992 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
993 classifier_remove(cls, &fte->rule);
998 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
999 * necessary. Sets 'version' as the version of that rule with the given
1000 * 'index', replacing any existing version, if any.
1002 * Takes ownership of 'version'. */
1004 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1005 struct fte_version *version, int index)
1007 struct fte *old, *fte;
1009 fte = xzalloc(sizeof *fte);
1011 fte->versions[index] = version;
1013 old = fte_from_cls_rule(classifier_insert(cls, &fte->rule));
1015 fte_version_free(old->versions[index]);
1016 fte->versions[!index] = old->versions[!index];
1021 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1022 * with the specified 'index'. Returns the minimum flow format required to
1023 * represent the flows that were read. */
1024 static enum nx_flow_format
1025 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1027 enum nx_flow_format min_flow_format;
1031 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1033 ovs_fatal(errno, "%s: open", filename);
1037 min_flow_format = NXFF_OPENFLOW10;
1038 while (!ds_get_preprocessed_line(&s, file)) {
1039 struct fte_version *version;
1040 enum nx_flow_format min_ff;
1041 struct ofpbuf actions;
1045 ofpbuf_init(&actions, 64);
1046 parse_ofp_str(&fm, &table_idx, &actions, ds_cstr(&s));
1048 version = xmalloc(sizeof *version);
1049 version->cookie = fm.cookie;
1050 version->idle_timeout = fm.idle_timeout;
1051 version->hard_timeout = fm.hard_timeout;
1052 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1053 version->n_actions = actions.size / sizeof *version->actions;
1054 version->actions = ofpbuf_steal_data(&actions);
1056 min_ff = ofputil_min_flow_format(&fm.cr, true, fm.cookie);
1057 min_flow_format = MAX(min_flow_format, min_ff);
1058 check_final_format_for_flow_mod(min_flow_format);
1060 fte_insert(cls, &fm.cr, version, index);
1064 if (file != stdin) {
1068 return min_flow_format;
1071 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1072 * format 'flow_format', and adds them as flow table entries in 'cls' for the
1073 * version with the specified 'index'. */
1075 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1076 struct classifier *cls, int index)
1078 struct flow_stats_request fsr;
1079 struct ofpbuf *request;
1083 fsr.aggregate = false;
1084 cls_rule_init_catchall(&fsr.match, 0);
1085 fsr.out_port = OFPP_NONE;
1086 fsr.table_id = 0xff;
1087 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1088 send_xid = ((struct ofp_header *) request->data)->xid;
1089 send_openflow_buffer(vconn, request);
1094 struct ofpbuf *reply;
1096 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1097 recv_xid = ((struct ofp_header *) reply->data)->xid;
1098 if (send_xid == recv_xid) {
1099 const struct ofputil_msg_type *type;
1100 const struct ofp_stats_reply *osr;
1101 enum ofputil_msg_code code;
1103 ofputil_decode_msg_type(reply->data, &type);
1104 code = ofputil_msg_type_code(type);
1105 if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1106 code != OFPUTIL_NXST_FLOW_REPLY) {
1107 ovs_fatal(0, "received bad reply: %s",
1108 ofp_to_string(reply->data, reply->size,
1113 if (!(osr->flags & htons(OFPSF_REPLY_MORE))) {
1118 struct fte_version *version;
1119 struct ofputil_flow_stats fs;
1122 retval = ofputil_decode_flow_stats_reply(&fs, reply,
1125 if (retval != EOF) {
1126 ovs_fatal(0, "parse error in reply");
1131 version = xmalloc(sizeof *version);
1132 version->cookie = fs.cookie;
1133 version->idle_timeout = fs.idle_timeout;
1134 version->hard_timeout = fs.hard_timeout;
1136 version->n_actions = fs.n_actions;
1137 version->actions = xmemdup(fs.actions,
1138 fs.n_actions * sizeof *fs.actions);
1140 fte_insert(cls, &fs.rule, version, index);
1143 osr = ofpbuf_at(reply, 0, sizeof *osr);
1145 VLOG_DBG("received reply with xid %08"PRIx32" "
1146 "!= expected %08"PRIx32, recv_xid, send_xid);
1148 ofpbuf_delete(reply);
1153 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1154 enum nx_flow_format flow_format, struct list *packets)
1156 const struct fte_version *version = fte->versions[index];
1161 fm.cookie = version->cookie;
1162 fm.command = command;
1163 fm.idle_timeout = version->idle_timeout;
1164 fm.hard_timeout = version->hard_timeout;
1165 fm.buffer_id = UINT32_MAX;
1166 fm.out_port = OFPP_NONE;
1167 fm.flags = version->flags;
1168 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1169 command == OFPFC_MODIFY_STRICT) {
1170 fm.actions = version->actions;
1171 fm.n_actions = version->n_actions;
1177 ofm = ofputil_encode_flow_mod(&fm, flow_format);
1178 list_push_back(packets, &ofm->list_node);
1182 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1184 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1185 enum nx_flow_format min_flow_format, flow_format;
1186 struct cls_cursor cursor;
1187 struct classifier cls;
1188 struct list requests;
1189 struct vconn *vconn;
1192 classifier_init(&cls);
1193 min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1195 open_vconn(argv[1], &vconn);
1196 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1197 read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1199 list_init(&requests);
1201 /* Delete flows that exist on the switch but not in the file. */
1202 cls_cursor_init(&cursor, &cls, NULL);
1203 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1204 struct fte_version *file_ver = fte->versions[FILE_IDX];
1205 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1207 if (sw_ver && !file_ver) {
1208 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1209 flow_format, &requests);
1213 /* Add flows that exist in the file but not on the switch.
1214 * Update flows that exist in both places but differ. */
1215 cls_cursor_init(&cursor, &cls, NULL);
1216 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1217 struct fte_version *file_ver = fte->versions[FILE_IDX];
1218 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1220 if (file_ver && (!sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1221 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1225 transact_multiple_noreply(vconn, &requests);
1232 read_flows_from_source(const char *source, struct classifier *cls, int index)
1236 if (source[0] == '/' || source[0] == '.'
1237 || (!strchr(source, ':') && !stat(source, &s))) {
1238 read_flows_from_file(source, cls, index);
1240 enum nx_flow_format flow_format;
1241 struct vconn *vconn;
1243 open_vconn(source, &vconn);
1244 flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1245 read_flows_from_switch(vconn, flow_format, cls, index);
1251 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1253 bool differences = false;
1254 struct cls_cursor cursor;
1255 struct classifier cls;
1258 classifier_init(&cls);
1259 read_flows_from_source(argv[1], &cls, 0);
1260 read_flows_from_source(argv[2], &cls, 1);
1262 cls_cursor_init(&cursor, &cls, NULL);
1263 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1264 struct fte_version *a = fte->versions[0];
1265 struct fte_version *b = fte->versions[1];
1267 if (!a || !b || !fte_version_equals(a, b)) {
1268 char *rule_s = cls_rule_to_string(&fte->rule);
1270 printf("-%s", rule_s);
1271 fte_version_print(a);
1274 printf("+%s", rule_s);
1275 fte_version_print(b);
1290 /* Undocumented commands for unit testing. */
1293 print_packet_list(struct list *packets)
1295 struct ofpbuf *packet, *next;
1297 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1298 ofp_print(stdout, packet->data, packet->size, verbosity);
1299 list_remove(&packet->list_node);
1300 ofpbuf_delete(packet);
1304 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1305 * it back to stdout. */
1307 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1309 enum nx_flow_format flow_format;
1310 struct list packets;
1312 flow_format = NXFF_OPENFLOW10;
1313 if (preferred_flow_format > 0) {
1314 flow_format = preferred_flow_format;
1317 list_init(&packets);
1318 parse_ofp_flow_mod_str(&packets, &flow_format, argv[1], OFPFC_ADD);
1319 print_packet_list(&packets);
1322 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1323 * add-flows) and prints each of the flows back to stdout. */
1325 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1327 enum nx_flow_format flow_format;
1328 struct list packets;
1331 file = fopen(argv[1], "r");
1333 ovs_fatal(errno, "%s: open", argv[2]);
1336 flow_format = NXFF_OPENFLOW10;
1337 if (preferred_flow_format > 0) {
1338 flow_format = preferred_flow_format;
1341 list_init(&packets);
1342 while (parse_ofp_flow_mod_file(&packets, &flow_format, file, OFPFC_ADD)) {
1343 print_packet_list(&packets);
1348 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1349 * stdin, does some internal fussing with them, and then prints them back as
1350 * strings on stdout. */
1352 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1357 while (!ds_get_line(&in, stdin)) {
1358 struct ofpbuf nx_match;
1359 struct cls_rule rule;
1364 /* Delete comments, skip blank lines. */
1370 if (strchr(s, '#')) {
1371 *strchr(s, '#') = '\0';
1373 if (s[strspn(s, " ")] == '\0') {
1378 /* Convert string to nx_match. */
1379 ofpbuf_init(&nx_match, 0);
1380 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1382 /* Convert nx_match to cls_rule. */
1383 error = nx_pull_match(&nx_match, match_len, 0, &rule);
1387 /* Convert cls_rule back to nx_match. */
1388 ofpbuf_uninit(&nx_match);
1389 ofpbuf_init(&nx_match, 0);
1390 match_len = nx_put_match(&nx_match, &rule);
1392 /* Convert nx_match to string. */
1393 out = nx_match_to_string(nx_match.data, match_len);
1397 printf("nx_pull_match() returned error %x\n", error);
1400 ofpbuf_uninit(&nx_match);
1405 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1406 * binary data, interpreting them as an OpenFlow message, and prints the
1407 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1409 do_ofp_print(int argc, char *argv[])
1411 struct ofpbuf packet;
1413 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1414 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1415 ovs_fatal(0, "trailing garbage following hex bytes");
1417 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1418 ofpbuf_uninit(&packet);
1421 static const struct command all_commands[] = {
1422 { "show", 1, 1, do_show },
1423 { "monitor", 1, 2, do_monitor },
1424 { "snoop", 1, 1, do_snoop },
1425 { "dump-desc", 1, 1, do_dump_desc },
1426 { "dump-tables", 1, 1, do_dump_tables },
1427 { "dump-flows", 1, 2, do_dump_flows },
1428 { "dump-aggregate", 1, 2, do_dump_aggregate },
1429 { "queue-stats", 1, 3, do_queue_stats },
1430 { "add-flow", 2, 2, do_add_flow },
1431 { "add-flows", 2, 2, do_add_flows },
1432 { "mod-flows", 2, 2, do_mod_flows },
1433 { "del-flows", 1, 2, do_del_flows },
1434 { "replace-flows", 2, 2, do_replace_flows },
1435 { "diff-flows", 2, 2, do_diff_flows },
1436 { "dump-ports", 1, 2, do_dump_ports },
1437 { "mod-port", 3, 3, do_mod_port },
1438 { "probe", 1, 1, do_probe },
1439 { "ping", 1, 2, do_ping },
1440 { "benchmark", 3, 3, do_benchmark },
1441 { "help", 0, INT_MAX, do_help },
1443 /* Undocumented commands for testing. */
1444 { "parse-flow", 1, 1, do_parse_flow },
1445 { "parse-flows", 1, 1, do_parse_flows },
1446 { "parse-nx-match", 0, 0, do_parse_nx_match },
1447 { "ofp-print", 1, 2, do_ofp_print },
1449 { NULL, 0, 0, NULL },