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.
21 #include <sys/socket.h>
30 #include "byte-order.h"
31 #include "classifier.h"
32 #include "command-line.h"
36 #include "dynamic-string.h"
40 #include "ofp-parse.h"
41 #include "ofp-print.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "stream-ssl.h"
53 VLOG_DEFINE_THIS_MODULE(ofctl);
55 /* --strict: Use strict matching for flow mod commands? */
58 /* -F, --flow-format: Flow format to use. Either one of NXFF_* to force a
59 * particular flow format or -1 to let ovs-ofctl choose intelligently. */
60 static int preferred_flow_format = -1;
62 /* -m, --more: Additional verbosity for ofp-print functions. */
65 static const struct command all_commands[];
67 static void usage(void) NO_RETURN;
68 static void parse_options(int argc, char *argv[]);
71 main(int argc, char *argv[])
73 set_program_name(argv[0]);
74 parse_options(argc, argv);
75 signal(SIGPIPE, SIG_IGN);
76 run_command(argc - optind, argv + optind, all_commands);
81 parse_options(int argc, char *argv[])
84 OPT_STRICT = UCHAR_MAX + 1,
87 static struct option long_options[] = {
88 {"timeout", required_argument, 0, 't'},
89 {"strict", no_argument, 0, OPT_STRICT},
90 {"flow-format", required_argument, 0, 'F'},
91 {"more", no_argument, 0, 'm'},
92 {"help", no_argument, 0, 'h'},
93 {"version", no_argument, 0, 'V'},
95 STREAM_SSL_LONG_OPTIONS
98 char *short_options = long_options_to_short_options(long_options);
101 unsigned long int timeout;
104 c = getopt_long(argc, argv, short_options, long_options, NULL);
111 timeout = strtoul(optarg, NULL, 10);
113 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
121 preferred_flow_format = ofputil_flow_format_from_string(optarg);
122 if (preferred_flow_format < 0) {
123 ovs_fatal(0, "unknown flow format `%s'", optarg);
135 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
143 STREAM_SSL_OPTION_HANDLERS
158 printf("%s: OpenFlow switch management utility\n"
159 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
160 "\nFor OpenFlow switches:\n"
161 " show SWITCH show OpenFlow information\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_dump_desc(int argc OVS_UNUSED, char *argv[])
406 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
410 do_dump_tables(int argc OVS_UNUSED, char *argv[])
412 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
415 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
416 * 'port_name' (which may be a port name or number), and copies it into
419 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
420 struct ofp_phy_port *oppp)
422 struct ofpbuf *request, *reply;
423 struct ofp_switch_features *osf;
424 unsigned int port_no;
429 /* Try to interpret the argument as a port number. */
430 if (!str_to_uint(port_name, 10, &port_no)) {
434 /* Fetch the switch's ofp_switch_features. */
435 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
436 open_vconn(vconn_name, &vconn);
437 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
440 if (reply->size < sizeof *osf) {
441 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
442 vconn_name, reply->size);
444 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
446 for (port_idx = 0; port_idx < n_ports; port_idx++) {
447 const struct ofp_phy_port *opp = &osf->ports[port_idx];
449 if (port_no != UINT_MAX
450 ? htons(port_no) == opp->port_no
451 : !strncmp(opp->name, port_name, sizeof opp->name)) {
453 ofpbuf_delete(reply);
458 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
461 /* Returns the port number corresponding to 'port_name' (which may be a port
462 * name or number) within the switch 'vconn_name'. */
464 str_to_port_no(const char *vconn_name, const char *port_name)
466 unsigned int port_no;
468 if (str_to_uint(port_name, 10, &port_no)) {
471 struct ofp_phy_port opp;
473 fetch_ofp_phy_port(vconn_name, port_name, &opp);
474 return ntohs(opp.port_no);
479 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
481 struct ofpbuf *sff, *reply;
483 sff = ofputil_make_set_flow_format(flow_format);
484 run(vconn_transact_noreply(vconn, sff, &reply),
485 "talking to %s", vconn_get_name(vconn));
487 char *s = ofp_to_string(reply->data, reply->size, 2);
488 VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
489 vconn_get_name(vconn),
490 ofputil_flow_format_to_string(flow_format),
493 ofpbuf_delete(reply);
500 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
502 struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
503 transact_noreply(vconn, sff);
504 VLOG_DBG("%s: using user-specified flow format %s",
505 vconn_get_name(vconn),
506 ofputil_flow_format_to_string(flow_format));
509 static enum nx_flow_format
510 negotiate_highest_flow_format(struct vconn *vconn,
511 enum nx_flow_format min_format)
513 if (preferred_flow_format != -1) {
514 if (preferred_flow_format < min_format) {
515 ovs_fatal(0, "%s: cannot use requested flow format %s for "
516 "specified flow", vconn_get_name(vconn),
517 ofputil_flow_format_to_string(min_format));
520 set_flow_format(vconn, preferred_flow_format);
521 return preferred_flow_format;
523 enum nx_flow_format flow_format;
525 if (try_set_flow_format(vconn, NXFF_NXM)) {
526 flow_format = NXFF_NXM;
527 } else if (try_set_flow_format(vconn, NXFF_TUN_ID_FROM_COOKIE)) {
528 flow_format = NXFF_TUN_ID_FROM_COOKIE;
530 flow_format = NXFF_OPENFLOW10;
533 if (flow_format < min_format) {
534 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
535 "%s for specified flow", vconn_get_name(vconn),
536 ofputil_flow_format_to_string(min_format));
539 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
540 ofputil_flow_format_to_string(flow_format));
546 do_dump_flows__(int argc, char *argv[], bool aggregate)
548 enum nx_flow_format min_flow_format, flow_format;
549 struct flow_stats_request fsr;
550 struct ofpbuf *request;
553 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
555 open_vconn(argv[1], &vconn);
556 min_flow_format = ofputil_min_flow_format(&fsr.match, false, 0);
557 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
558 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
559 dump_stats_transaction(argv[1], request);
564 do_dump_flows(int argc, char *argv[])
566 return do_dump_flows__(argc, argv, false);
570 do_dump_aggregate(int argc, char *argv[])
572 return do_dump_flows__(argc, argv, true);
576 do_queue_stats(int argc, char *argv[])
578 struct ofp_queue_stats_request *req;
579 struct ofpbuf *request;
581 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
583 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
584 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
586 req->port_no = htons(OFPP_ALL);
588 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
589 req->queue_id = htonl(atoi(argv[3]));
591 req->queue_id = htonl(OFPQ_ALL);
594 memset(req->pad, 0, sizeof req->pad);
596 dump_stats_transaction(argv[1], request);
599 /* Sets up the flow format for a vconn that will be used to modify the flow
600 * table. Returns the flow format used, after possibly adding an OpenFlow
601 * request to 'requests'.
603 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
604 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
605 * OpenFlow connection.
607 * If 'preferred_flow_format' is a specific format, adds a request to set that
608 * format to 'requests' and returns the format. */
609 static enum nx_flow_format
610 set_initial_format_for_flow_mod(struct list *requests)
612 if (preferred_flow_format < 0) {
613 return NXFF_OPENFLOW10;
617 sff = ofputil_make_set_flow_format(preferred_flow_format);
618 list_push_back(requests, &sff->list_node);
619 return preferred_flow_format;
623 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
624 * operation, given the global 'preferred_flow_format'. */
626 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
628 if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
629 ovs_fatal(0, "flow cannot be expressed in flow format %s "
630 "(flow format %s or better is required)",
631 ofputil_flow_format_to_string(preferred_flow_format),
632 ofputil_flow_format_to_string(flow_format));
637 do_flow_mod_file__(int argc OVS_UNUSED, char *argv[], uint16_t command)
639 enum nx_flow_format flow_format;
640 struct list requests;
644 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
646 ovs_fatal(errno, "%s: open", argv[2]);
649 list_init(&requests);
650 flow_format = set_initial_format_for_flow_mod(&requests);
652 open_vconn(argv[1], &vconn);
653 while (parse_ofp_flow_mod_file(&requests, &flow_format, file, command)) {
654 check_final_format_for_flow_mod(flow_format);
655 transact_multiple_noreply(vconn, &requests);
665 do_flow_mod__(int argc, char *argv[], uint16_t command)
667 enum nx_flow_format flow_format;
668 struct list requests;
671 if (argc > 2 && !strcmp(argv[2], "-")) {
672 do_flow_mod_file__(argc, argv, command);
676 list_init(&requests);
677 flow_format = set_initial_format_for_flow_mod(&requests);
679 parse_ofp_flow_mod_str(&requests, &flow_format, argc > 2 ? argv[2] : "",
681 check_final_format_for_flow_mod(flow_format);
683 open_vconn(argv[1], &vconn);
684 transact_multiple_noreply(vconn, &requests);
689 do_add_flow(int argc, char *argv[])
691 do_flow_mod__(argc, argv, OFPFC_ADD);
695 do_add_flows(int argc, char *argv[])
697 do_flow_mod_file__(argc, argv, OFPFC_ADD);
701 do_mod_flows(int argc, char *argv[])
703 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
707 do_del_flows(int argc, char *argv[])
709 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
713 monitor_vconn(struct vconn *vconn)
717 run(vconn_recv_block(vconn, &b), "vconn_recv");
718 ofp_print(stderr, b->data, b->size, verbosity + 2);
724 do_monitor(int argc, char *argv[])
728 open_vconn(argv[1], &vconn);
730 int miss_send_len = atoi(argv[2]);
731 struct ofp_switch_config *osc;
734 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
735 osc->miss_send_len = htons(miss_send_len);
736 transact_noreply(vconn, buf);
738 monitor_vconn(vconn);
742 do_snoop(int argc OVS_UNUSED, char *argv[])
746 open_vconn__(argv[1], "snoop", &vconn);
747 monitor_vconn(vconn);
751 do_dump_ports(int argc, char *argv[])
753 struct ofp_port_stats_request *req;
754 struct ofpbuf *request;
757 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
758 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
759 req->port_no = htons(port);
760 dump_stats_transaction(argv[1], request);
764 do_probe(int argc OVS_UNUSED, char *argv[])
766 struct ofpbuf *request;
768 struct ofpbuf *reply;
770 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
771 open_vconn(argv[1], &vconn);
772 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
773 if (reply->size != sizeof(struct ofp_header)) {
774 ovs_fatal(0, "reply does not match request");
776 ofpbuf_delete(reply);
781 do_mod_port(int argc OVS_UNUSED, char *argv[])
783 struct ofp_port_mod *opm;
784 struct ofp_phy_port opp;
785 struct ofpbuf *request;
788 fetch_ofp_phy_port(argv[1], argv[2], &opp);
790 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
791 opm->port_no = opp.port_no;
792 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
793 opm->config = htonl(0);
794 opm->mask = htonl(0);
795 opm->advertise = htonl(0);
797 if (!strcasecmp(argv[3], "up")) {
798 opm->mask |= htonl(OFPPC_PORT_DOWN);
799 } else if (!strcasecmp(argv[3], "down")) {
800 opm->mask |= htonl(OFPPC_PORT_DOWN);
801 opm->config |= htonl(OFPPC_PORT_DOWN);
802 } else if (!strcasecmp(argv[3], "flood")) {
803 opm->mask |= htonl(OFPPC_NO_FLOOD);
804 } else if (!strcasecmp(argv[3], "noflood")) {
805 opm->mask |= htonl(OFPPC_NO_FLOOD);
806 opm->config |= htonl(OFPPC_NO_FLOOD);
808 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
811 open_vconn(argv[1], &vconn);
812 transact_noreply(vconn, request);
817 do_ping(int argc, char *argv[])
819 size_t max_payload = 65535 - sizeof(struct ofp_header);
820 unsigned int payload;
824 payload = argc > 2 ? atoi(argv[2]) : 64;
825 if (payload > max_payload) {
826 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
829 open_vconn(argv[1], &vconn);
830 for (i = 0; i < 10; i++) {
831 struct timeval start, end;
832 struct ofpbuf *request, *reply;
833 struct ofp_header *rq_hdr, *rpy_hdr;
835 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
836 OFPT_ECHO_REQUEST, &request);
837 random_bytes(rq_hdr + 1, payload);
839 gettimeofday(&start, NULL);
840 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
841 gettimeofday(&end, NULL);
843 rpy_hdr = reply->data;
844 if (reply->size != request->size
845 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
846 || rpy_hdr->xid != rq_hdr->xid
847 || rpy_hdr->type != OFPT_ECHO_REPLY) {
848 printf("Reply does not match request. Request:\n");
849 ofp_print(stdout, request, request->size, verbosity + 2);
851 ofp_print(stdout, reply, reply->size, verbosity + 2);
853 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
854 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
855 (1000*(double)(end.tv_sec - start.tv_sec))
856 + (.001*(end.tv_usec - start.tv_usec)));
857 ofpbuf_delete(request);
858 ofpbuf_delete(reply);
864 do_benchmark(int argc OVS_UNUSED, char *argv[])
866 size_t max_payload = 65535 - sizeof(struct ofp_header);
867 struct timeval start, end;
868 unsigned int payload_size, message_size;
874 payload_size = atoi(argv[2]);
875 if (payload_size > max_payload) {
876 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
878 message_size = sizeof(struct ofp_header) + payload_size;
880 count = atoi(argv[3]);
882 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
883 count, message_size, count * message_size);
885 open_vconn(argv[1], &vconn);
886 gettimeofday(&start, NULL);
887 for (i = 0; i < count; i++) {
888 struct ofpbuf *request, *reply;
889 struct ofp_header *rq_hdr;
891 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
892 memset(rq_hdr + 1, 0, payload_size);
893 run(vconn_transact(vconn, request, &reply), "transact");
894 ofpbuf_delete(reply);
896 gettimeofday(&end, NULL);
899 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
900 + (.001*(end.tv_usec - start.tv_usec)));
901 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
902 duration, count / (duration / 1000.0),
903 count * message_size / (duration / 1000.0));
907 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
912 /* replace-flows and diff-flows commands. */
914 /* A flow table entry, possibly with two different versions. */
916 struct cls_rule rule; /* Within a "struct classifier". */
917 struct fte_version *versions[2];
920 /* One version of a Flow Table Entry. */
923 uint16_t idle_timeout;
924 uint16_t hard_timeout;
926 union ofp_action *actions;
930 /* Frees 'version' and the data that it owns. */
932 fte_version_free(struct fte_version *version)
935 free(version->actions);
940 /* Returns true if 'a' and 'b' are the same, false if they differ.
942 * Ignores differences in 'flags' because there's no way to retrieve flags from
943 * an OpenFlow switch. We have to assume that they are the same. */
945 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
947 return (a->cookie == b->cookie
948 && a->idle_timeout == b->idle_timeout
949 && a->hard_timeout == b->hard_timeout
950 && a->n_actions == b->n_actions
951 && !memcmp(a->actions, b->actions,
952 a->n_actions * sizeof *a->actions));
955 /* Prints 'version' on stdout. Expects the caller to have printed the rule
956 * associated with the version. */
958 fte_version_print(const struct fte_version *version)
962 if (version->cookie != htonll(0)) {
963 printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
965 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
966 printf(" idle_timeout=%"PRIu16, version->idle_timeout);
968 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
969 printf(" hard_timeout=%"PRIu16, version->hard_timeout);
973 ofp_print_actions(&s, (const struct ofp_action_header *) version->actions,
974 version->n_actions * sizeof *version->actions);
975 printf(" %s\n", ds_cstr(&s));
980 fte_from_cls_rule(const struct cls_rule *cls_rule)
982 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
985 /* Frees 'fte' and its versions. */
987 fte_free(struct fte *fte)
990 fte_version_free(fte->versions[0]);
991 fte_version_free(fte->versions[1]);
996 /* Frees all of the FTEs within 'cls'. */
998 fte_free_all(struct classifier *cls)
1000 struct cls_cursor cursor;
1001 struct fte *fte, *next;
1003 cls_cursor_init(&cursor, cls, NULL);
1004 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1005 classifier_remove(cls, &fte->rule);
1010 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1011 * necessary. Sets 'version' as the version of that rule with the given
1012 * 'index', replacing any existing version, if any.
1014 * Takes ownership of 'version'. */
1016 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1017 struct fte_version *version, int index)
1019 struct fte *old, *fte;
1021 fte = xzalloc(sizeof *fte);
1023 fte->versions[index] = version;
1025 old = fte_from_cls_rule(classifier_insert(cls, &fte->rule));
1027 fte_version_free(old->versions[index]);
1028 fte->versions[!index] = old->versions[!index];
1033 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1034 * with the specified 'index'. Returns the minimum flow format required to
1035 * represent the flows that were read. */
1036 static enum nx_flow_format
1037 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1039 enum nx_flow_format min_flow_format;
1043 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1045 ovs_fatal(errno, "%s: open", filename);
1049 min_flow_format = NXFF_OPENFLOW10;
1050 while (!ds_get_preprocessed_line(&s, file)) {
1051 struct fte_version *version;
1052 enum nx_flow_format min_ff;
1053 struct ofpbuf actions;
1057 ofpbuf_init(&actions, 64);
1058 parse_ofp_str(&fm, &table_idx, &actions, ds_cstr(&s));
1060 version = xmalloc(sizeof *version);
1061 version->cookie = fm.cookie;
1062 version->idle_timeout = fm.idle_timeout;
1063 version->hard_timeout = fm.hard_timeout;
1064 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1065 version->n_actions = actions.size / sizeof *version->actions;
1066 version->actions = ofpbuf_steal_data(&actions);
1068 min_ff = ofputil_min_flow_format(&fm.cr, true, fm.cookie);
1069 min_flow_format = MAX(min_flow_format, min_ff);
1070 check_final_format_for_flow_mod(min_flow_format);
1072 fte_insert(cls, &fm.cr, version, index);
1076 if (file != stdin) {
1080 return min_flow_format;
1083 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1084 * format 'flow_format', and adds them as flow table entries in 'cls' for the
1085 * version with the specified 'index'. */
1087 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1088 struct classifier *cls, int index)
1090 struct flow_stats_request fsr;
1091 struct ofpbuf *request;
1095 fsr.aggregate = false;
1096 cls_rule_init_catchall(&fsr.match, 0);
1097 fsr.out_port = OFPP_NONE;
1098 fsr.table_id = 0xff;
1099 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1100 send_xid = ((struct ofp_header *) request->data)->xid;
1101 send_openflow_buffer(vconn, request);
1106 struct ofpbuf *reply;
1108 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1109 recv_xid = ((struct ofp_header *) reply->data)->xid;
1110 if (send_xid == recv_xid) {
1111 const struct ofputil_msg_type *type;
1112 const struct ofp_stats_reply *osr;
1113 enum ofputil_msg_code code;
1115 ofputil_decode_msg_type(reply->data, &type);
1116 code = ofputil_msg_type_code(type);
1117 if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1118 code != OFPUTIL_NXST_FLOW_REPLY) {
1119 ovs_fatal(0, "received bad reply: %s",
1120 ofp_to_string(reply->data, reply->size,
1125 if (!(osr->flags & htons(OFPSF_REPLY_MORE))) {
1130 struct fte_version *version;
1131 struct ofputil_flow_stats fs;
1134 retval = ofputil_decode_flow_stats_reply(&fs, reply,
1137 if (retval != EOF) {
1138 ovs_fatal(0, "parse error in reply");
1143 version = xmalloc(sizeof *version);
1144 version->cookie = fs.cookie;
1145 version->idle_timeout = fs.idle_timeout;
1146 version->hard_timeout = fs.hard_timeout;
1148 version->n_actions = fs.n_actions;
1149 version->actions = xmemdup(fs.actions,
1150 fs.n_actions * sizeof *fs.actions);
1152 fte_insert(cls, &fs.rule, version, index);
1155 VLOG_DBG("received reply with xid %08"PRIx32" "
1156 "!= expected %08"PRIx32, recv_xid, send_xid);
1158 ofpbuf_delete(reply);
1163 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1164 enum nx_flow_format flow_format, struct list *packets)
1166 const struct fte_version *version = fte->versions[index];
1171 fm.cookie = version->cookie;
1172 fm.command = command;
1173 fm.idle_timeout = version->idle_timeout;
1174 fm.hard_timeout = version->hard_timeout;
1175 fm.buffer_id = UINT32_MAX;
1176 fm.out_port = OFPP_NONE;
1177 fm.flags = version->flags;
1178 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1179 command == OFPFC_MODIFY_STRICT) {
1180 fm.actions = version->actions;
1181 fm.n_actions = version->n_actions;
1187 ofm = ofputil_encode_flow_mod(&fm, flow_format);
1188 list_push_back(packets, &ofm->list_node);
1192 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1194 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1195 enum nx_flow_format min_flow_format, flow_format;
1196 struct cls_cursor cursor;
1197 struct classifier cls;
1198 struct list requests;
1199 struct vconn *vconn;
1202 classifier_init(&cls);
1203 min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1205 open_vconn(argv[1], &vconn);
1206 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1207 read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1209 list_init(&requests);
1211 /* Delete flows that exist on the switch but not in the file. */
1212 cls_cursor_init(&cursor, &cls, NULL);
1213 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1214 struct fte_version *file_ver = fte->versions[FILE_IDX];
1215 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1217 if (sw_ver && !file_ver) {
1218 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1219 flow_format, &requests);
1223 /* Add flows that exist in the file but not on the switch.
1224 * Update flows that exist in both places but differ. */
1225 cls_cursor_init(&cursor, &cls, NULL);
1226 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1227 struct fte_version *file_ver = fte->versions[FILE_IDX];
1228 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1230 if (file_ver && (!sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1231 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1235 transact_multiple_noreply(vconn, &requests);
1242 read_flows_from_source(const char *source, struct classifier *cls, int index)
1246 if (source[0] == '/' || source[0] == '.'
1247 || (!strchr(source, ':') && !stat(source, &s))) {
1248 read_flows_from_file(source, cls, index);
1250 enum nx_flow_format flow_format;
1251 struct vconn *vconn;
1253 open_vconn(source, &vconn);
1254 flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1255 read_flows_from_switch(vconn, flow_format, cls, index);
1261 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1263 bool differences = false;
1264 struct cls_cursor cursor;
1265 struct classifier cls;
1268 classifier_init(&cls);
1269 read_flows_from_source(argv[1], &cls, 0);
1270 read_flows_from_source(argv[2], &cls, 1);
1272 cls_cursor_init(&cursor, &cls, NULL);
1273 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1274 struct fte_version *a = fte->versions[0];
1275 struct fte_version *b = fte->versions[1];
1277 if (!a || !b || !fte_version_equals(a, b)) {
1278 char *rule_s = cls_rule_to_string(&fte->rule);
1280 printf("-%s", rule_s);
1281 fte_version_print(a);
1284 printf("+%s", rule_s);
1285 fte_version_print(b);
1300 /* Undocumented commands for unit testing. */
1303 print_packet_list(struct list *packets)
1305 struct ofpbuf *packet, *next;
1307 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1308 ofp_print(stdout, packet->data, packet->size, verbosity);
1309 list_remove(&packet->list_node);
1310 ofpbuf_delete(packet);
1314 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1315 * it back to stdout. */
1317 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1319 enum nx_flow_format flow_format;
1320 struct list packets;
1322 flow_format = NXFF_OPENFLOW10;
1323 if (preferred_flow_format > 0) {
1324 flow_format = preferred_flow_format;
1327 list_init(&packets);
1328 parse_ofp_flow_mod_str(&packets, &flow_format, argv[1], OFPFC_ADD);
1329 print_packet_list(&packets);
1332 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1333 * add-flows) and prints each of the flows back to stdout. */
1335 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1337 enum nx_flow_format flow_format;
1338 struct list packets;
1341 file = fopen(argv[1], "r");
1343 ovs_fatal(errno, "%s: open", argv[2]);
1346 flow_format = NXFF_OPENFLOW10;
1347 if (preferred_flow_format > 0) {
1348 flow_format = preferred_flow_format;
1351 list_init(&packets);
1352 while (parse_ofp_flow_mod_file(&packets, &flow_format, file, OFPFC_ADD)) {
1353 print_packet_list(&packets);
1358 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1359 * stdin, does some internal fussing with them, and then prints them back as
1360 * strings on stdout. */
1362 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1367 while (!ds_get_line(&in, stdin)) {
1368 struct ofpbuf nx_match;
1369 struct cls_rule rule;
1374 /* Delete comments, skip blank lines. */
1380 if (strchr(s, '#')) {
1381 *strchr(s, '#') = '\0';
1383 if (s[strspn(s, " ")] == '\0') {
1388 /* Convert string to nx_match. */
1389 ofpbuf_init(&nx_match, 0);
1390 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1392 /* Convert nx_match to cls_rule. */
1393 error = nx_pull_match(&nx_match, match_len, 0, &rule);
1397 /* Convert cls_rule back to nx_match. */
1398 ofpbuf_uninit(&nx_match);
1399 ofpbuf_init(&nx_match, 0);
1400 match_len = nx_put_match(&nx_match, &rule);
1402 /* Convert nx_match to string. */
1403 out = nx_match_to_string(nx_match.data, match_len);
1407 printf("nx_pull_match() returned error %x\n", error);
1410 ofpbuf_uninit(&nx_match);
1415 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1416 * binary data, interpreting them as an OpenFlow message, and prints the
1417 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1419 do_ofp_print(int argc, char *argv[])
1421 struct ofpbuf packet;
1423 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1424 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1425 ovs_fatal(0, "trailing garbage following hex bytes");
1427 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1428 ofpbuf_uninit(&packet);
1431 static const struct command all_commands[] = {
1432 { "show", 1, 1, do_show },
1433 { "monitor", 1, 2, do_monitor },
1434 { "snoop", 1, 1, do_snoop },
1435 { "dump-desc", 1, 1, do_dump_desc },
1436 { "dump-tables", 1, 1, do_dump_tables },
1437 { "dump-flows", 1, 2, do_dump_flows },
1438 { "dump-aggregate", 1, 2, do_dump_aggregate },
1439 { "queue-stats", 1, 3, do_queue_stats },
1440 { "add-flow", 2, 2, do_add_flow },
1441 { "add-flows", 2, 2, do_add_flows },
1442 { "mod-flows", 2, 2, do_mod_flows },
1443 { "del-flows", 1, 2, do_del_flows },
1444 { "replace-flows", 2, 2, do_replace_flows },
1445 { "diff-flows", 2, 2, do_diff_flows },
1446 { "dump-ports", 1, 2, do_dump_ports },
1447 { "mod-port", 3, 3, do_mod_port },
1448 { "probe", 1, 1, do_probe },
1449 { "ping", 1, 2, do_ping },
1450 { "benchmark", 3, 3, do_benchmark },
1451 { "help", 0, INT_MAX, do_help },
1453 /* Undocumented commands for testing. */
1454 { "parse-flow", 1, 1, do_parse_flow },
1455 { "parse-flows", 1, 1, do_parse_flows },
1456 { "parse-nx-match", 0, 0, do_parse_nx_match },
1457 { "ofp-print", 1, 2, do_ofp_print },
1459 { NULL, 0, 0, NULL },