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-errors.h"
41 #include "ofp-parse.h"
42 #include "ofp-print.h"
45 #include "ofproto/ofproto.h"
46 #include "openflow/nicira-ext.h"
47 #include "openflow/openflow.h"
48 #include "poll-loop.h"
50 #include "stream-ssl.h"
57 VLOG_DEFINE_THIS_MODULE(ofctl);
59 /* --strict: Use strict matching for flow mod commands? Additionally governs
60 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
64 /* --readd: If ture, on replace-flows, re-add even flows that have not changed
65 * (to reset flow counters). */
68 /* -F, --flow-format: Flow format to use. Either one of NXFF_* to force a
69 * particular flow format or -1 to let ovs-ofctl choose intelligently. */
70 static int preferred_flow_format = -1;
72 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
73 * commands. Either one of NXPIF_* to force a particular packet_in format, or
74 * -1 to let ovs-ofctl choose the default. */
75 static int preferred_packet_in_format = -1;
77 /* -m, --more: Additional verbosity for ofp-print functions. */
80 static const struct command all_commands[];
82 static void usage(void) NO_RETURN;
83 static void parse_options(int argc, char *argv[]);
86 main(int argc, char *argv[])
88 set_program_name(argv[0]);
89 parse_options(argc, argv);
90 signal(SIGPIPE, SIG_IGN);
91 run_command(argc - optind, argv + optind, all_commands);
96 parse_options(int argc, char *argv[])
99 OPT_STRICT = UCHAR_MAX + 1,
104 static struct option long_options[] = {
105 {"timeout", required_argument, NULL, 't'},
106 {"strict", no_argument, NULL, OPT_STRICT},
107 {"readd", no_argument, NULL, OPT_READD},
108 {"flow-format", required_argument, NULL, 'F'},
109 {"packet-in-format", required_argument, NULL, 'P'},
110 {"more", no_argument, NULL, 'm'},
111 {"help", no_argument, NULL, 'h'},
112 {"version", no_argument, NULL, 'V'},
115 STREAM_SSL_LONG_OPTIONS,
118 char *short_options = long_options_to_short_options(long_options);
121 unsigned long int timeout;
124 c = getopt_long(argc, argv, short_options, long_options, NULL);
131 timeout = strtoul(optarg, NULL, 10);
133 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
141 preferred_flow_format = ofputil_flow_format_from_string(optarg);
142 if (preferred_flow_format < 0) {
143 ovs_fatal(0, "unknown flow format `%s'", optarg);
148 preferred_packet_in_format =
149 ofputil_packet_in_format_from_string(optarg);
150 if (preferred_packet_in_format < 0) {
151 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
163 ovs_print_version(OFP_VERSION, OFP_VERSION);
174 DAEMON_OPTION_HANDLERS
176 STREAM_SSL_OPTION_HANDLERS
191 printf("%s: OpenFlow switch management utility\n"
192 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
193 "\nFor OpenFlow switches:\n"
194 " show SWITCH show OpenFlow information\n"
195 " dump-desc SWITCH print switch description\n"
196 " dump-tables SWITCH print table stats\n"
197 " mod-port SWITCH IFACE ACT modify port behavior\n"
198 " get-frags SWITCH print fragment handling behavior\n"
199 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
200 " dump-ports SWITCH [PORT] print port statistics\n"
201 " dump-flows SWITCH print all flow entries\n"
202 " dump-flows SWITCH FLOW print matching FLOWs\n"
203 " dump-aggregate SWITCH print aggregate flow statistics\n"
204 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
205 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
206 " add-flow SWITCH FLOW add flow described by FLOW\n"
207 " add-flows SWITCH FILE add flows from FILE\n"
208 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
209 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
210 " replace-flows SWITCH FILE replace flows with those in FILE\n"
211 " monitor SWITCH [MISSLEN] print packets received from SWITCH\n"
212 "\nFor OpenFlow switches and controllers:\n"
213 " probe TARGET probe whether TARGET is up\n"
214 " ping TARGET [N] latency of N-byte echos\n"
215 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
216 "where SWITCH or TARGET is an active OpenFlow connection method.\n",
217 program_name, program_name);
218 vconn_usage(true, false, false);
221 printf("\nOther options:\n"
222 " --strict use strict match for flow commands\n"
223 " --readd replace flows that haven't changed\n"
224 " -F, --flow-format=FORMAT force particular flow format\n"
225 " -P, --packet-in-format=FRMT force particular packet in format\n"
226 " -m, --more be more verbose printing OpenFlow\n"
227 " -t, --timeout=SECS give up after SECS seconds\n"
228 " -h, --help display this help message\n"
229 " -V, --version display version information\n");
234 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
235 const char *argv[] OVS_UNUSED, void *exiting_)
237 bool *exiting = exiting_;
239 unixctl_command_reply(conn, 200, "");
242 static void run(int retval, const char *message, ...)
245 static void run(int retval, const char *message, ...)
250 va_start(args, message);
251 ovs_fatal_valist(retval, message, args);
255 /* Generic commands. */
258 open_vconn_socket(const char *name, struct vconn **vconnp)
260 char *vconn_name = xasprintf("unix:%s", name);
261 VLOG_DBG("connecting to %s", vconn_name);
262 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
263 "connecting to %s", vconn_name);
268 open_vconn__(const char *name, const char *default_suffix,
269 struct vconn **vconnp)
271 char *datapath_name, *datapath_type, *socket_name;
275 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
277 ofproto_parse_name(name, &datapath_name, &datapath_type);
278 socket_name = xasprintf("%s/%s.%s",
279 ovs_rundir(), datapath_name, default_suffix);
283 if (strchr(name, ':')) {
284 run(vconn_open_block(name, OFP_VERSION, vconnp),
285 "connecting to %s", name);
286 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
287 open_vconn_socket(name, vconnp);
288 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
289 open_vconn_socket(bridge_path, vconnp);
290 } else if (!stat(socket_name, &s)) {
291 if (!S_ISSOCK(s.st_mode)) {
292 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
295 open_vconn_socket(socket_name, vconnp);
297 ovs_fatal(0, "%s is not a bridge or a socket", name);
305 open_vconn(const char *name, struct vconn **vconnp)
307 return open_vconn__(name, "mgmt", vconnp);
311 alloc_stats_request(size_t rq_len, uint16_t type, struct ofpbuf **bufferp)
313 struct ofp_stats_msg *rq;
315 rq = make_openflow(rq_len, OFPT_STATS_REQUEST, bufferp);
316 rq->type = htons(type);
317 rq->flags = htons(0);
322 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
324 update_openflow_length(buffer);
325 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
329 dump_transaction(const char *vconn_name, struct ofpbuf *request)
332 struct ofpbuf *reply;
334 update_openflow_length(request);
335 open_vconn(vconn_name, &vconn);
336 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
337 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
342 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
344 struct ofpbuf *request;
345 make_openflow(sizeof(struct ofp_header), request_type, &request);
346 dump_transaction(vconn_name, request);
350 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
352 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
356 open_vconn(vconn_name, &vconn);
357 send_openflow_buffer(vconn, request);
360 struct ofpbuf *reply;
362 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
363 recv_xid = ((struct ofp_header *) reply->data)->xid;
364 if (send_xid == recv_xid) {
365 struct ofp_stats_msg *osm;
367 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
369 osm = ofpbuf_at(reply, 0, sizeof *osm);
370 done = !osm || !(ntohs(osm->flags) & OFPSF_REPLY_MORE);
372 VLOG_DBG("received reply with xid %08"PRIx32" "
373 "!= expected %08"PRIx32, recv_xid, send_xid);
375 ofpbuf_delete(reply);
381 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
383 struct ofpbuf *request;
384 alloc_stats_request(sizeof(struct ofp_stats_msg), stats_type, &request);
385 dump_stats_transaction(vconn_name, request);
388 /* Sends 'request', which should be a request that only has a reply if an error
389 * occurs, and waits for it to succeed or fail. If an error does occur, prints
390 * it and exits with an error.
392 * Destroys all of the 'requests'. */
394 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
396 struct ofpbuf *request, *reply;
398 LIST_FOR_EACH (request, list_node, requests) {
399 update_openflow_length(request);
402 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
403 "talking to %s", vconn_get_name(vconn));
405 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
408 ofpbuf_delete(reply);
411 /* Sends 'request', which should be a request that only has a reply if an error
412 * occurs, and waits for it to succeed or fail. If an error does occur, prints
413 * it and exits with an error.
415 * Destroys 'request'. */
417 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
419 struct list requests;
421 list_init(&requests);
422 list_push_back(&requests, &request->list_node);
423 transact_multiple_noreply(vconn, &requests);
427 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
429 struct ofp_switch_config *config;
430 struct ofp_header *header;
431 struct ofpbuf *request;
432 struct ofpbuf *reply;
434 make_openflow(sizeof(struct ofp_header), OFPT_GET_CONFIG_REQUEST,
436 run(vconn_transact(vconn, request, &reply),
437 "talking to %s", vconn_get_name(vconn));
439 header = reply->data;
440 if (header->type != OFPT_GET_CONFIG_REPLY ||
441 header->length != htons(sizeof *config)) {
442 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
445 config = reply->data;
450 set_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
452 struct ofp_switch_config *config;
453 struct ofp_header save_header;
454 struct ofpbuf *request;
456 config = make_openflow(sizeof *config, OFPT_SET_CONFIG, &request);
457 save_header = config->header;
459 config->header = save_header;
461 transact_noreply(vconn, request);
465 do_show(int argc OVS_UNUSED, char *argv[])
467 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
468 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
472 do_dump_desc(int argc OVS_UNUSED, char *argv[])
474 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
478 do_dump_tables(int argc OVS_UNUSED, char *argv[])
480 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
483 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
484 * 'port_name' (which may be a port name or number), and copies it into
487 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
488 struct ofp_phy_port *oppp)
490 struct ofpbuf *request, *reply;
491 struct ofp_switch_features *osf;
492 unsigned int port_no;
497 /* Try to interpret the argument as a port number. */
498 if (!str_to_uint(port_name, 10, &port_no)) {
502 /* Fetch the switch's ofp_switch_features. */
503 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
504 open_vconn(vconn_name, &vconn);
505 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
508 if (reply->size < sizeof *osf) {
509 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
510 vconn_name, reply->size);
512 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
514 for (port_idx = 0; port_idx < n_ports; port_idx++) {
515 const struct ofp_phy_port *opp = &osf->ports[port_idx];
517 if (port_no != UINT_MAX
518 ? htons(port_no) == opp->port_no
519 : !strncmp(opp->name, port_name, sizeof opp->name)) {
521 ofpbuf_delete(reply);
526 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
529 /* Returns the port number corresponding to 'port_name' (which may be a port
530 * name or number) within the switch 'vconn_name'. */
532 str_to_port_no(const char *vconn_name, const char *port_name)
534 unsigned int port_no;
536 if (str_to_uint(port_name, 10, &port_no)) {
539 struct ofp_phy_port opp;
541 fetch_ofp_phy_port(vconn_name, port_name, &opp);
542 return ntohs(opp.port_no);
547 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
549 struct ofpbuf *sff, *reply;
551 sff = ofputil_make_set_flow_format(flow_format);
552 run(vconn_transact_noreply(vconn, sff, &reply),
553 "talking to %s", vconn_get_name(vconn));
555 char *s = ofp_to_string(reply->data, reply->size, 2);
556 VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
557 vconn_get_name(vconn),
558 ofputil_flow_format_to_string(flow_format),
561 ofpbuf_delete(reply);
568 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
570 struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
571 transact_noreply(vconn, sff);
572 VLOG_DBG("%s: using user-specified flow format %s",
573 vconn_get_name(vconn),
574 ofputil_flow_format_to_string(flow_format));
577 static enum nx_flow_format
578 negotiate_highest_flow_format(struct vconn *vconn,
579 enum nx_flow_format min_format)
581 if (preferred_flow_format != -1) {
582 if (preferred_flow_format < min_format) {
583 ovs_fatal(0, "%s: cannot use requested flow format %s for "
584 "specified flow", vconn_get_name(vconn),
585 ofputil_flow_format_to_string(min_format));
588 set_flow_format(vconn, preferred_flow_format);
589 return preferred_flow_format;
591 enum nx_flow_format flow_format;
593 if (try_set_flow_format(vconn, NXFF_NXM)) {
594 flow_format = NXFF_NXM;
596 flow_format = NXFF_OPENFLOW10;
599 if (flow_format < min_format) {
600 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
601 "%s for specified flow", vconn_get_name(vconn),
602 ofputil_flow_format_to_string(min_format));
605 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
606 ofputil_flow_format_to_string(flow_format));
612 do_dump_flows__(int argc, char *argv[], bool aggregate)
614 enum nx_flow_format min_flow_format, flow_format;
615 struct ofputil_flow_stats_request fsr;
616 struct ofpbuf *request;
619 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
621 open_vconn(argv[1], &vconn);
622 min_flow_format = ofputil_min_flow_format(&fsr.match);
623 if (fsr.cookie_mask != htonll(0)) {
624 min_flow_format = NXFF_NXM;
626 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
627 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
628 dump_stats_transaction(argv[1], request);
633 do_dump_flows(int argc, char *argv[])
635 return do_dump_flows__(argc, argv, false);
639 do_dump_aggregate(int argc, char *argv[])
641 return do_dump_flows__(argc, argv, true);
645 do_queue_stats(int argc, char *argv[])
647 struct ofp_queue_stats_request *req;
648 struct ofpbuf *request;
650 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
652 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
653 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
655 req->port_no = htons(OFPP_ALL);
657 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
658 req->queue_id = htonl(atoi(argv[3]));
660 req->queue_id = htonl(OFPQ_ALL);
663 memset(req->pad, 0, sizeof req->pad);
665 dump_stats_transaction(argv[1], request);
668 /* Sets up the flow format for a vconn that will be used to modify the flow
669 * table. Returns the flow format used, after possibly adding an OpenFlow
670 * request to 'requests'.
672 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
673 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
674 * OpenFlow connection.
676 * If 'preferred_flow_format' is a specific format, adds a request to set that
677 * format to 'requests' and returns the format. */
678 static enum nx_flow_format
679 set_initial_format_for_flow_mod(struct list *requests)
681 if (preferred_flow_format < 0) {
682 return NXFF_OPENFLOW10;
686 sff = ofputil_make_set_flow_format(preferred_flow_format);
687 list_push_back(requests, &sff->list_node);
688 return preferred_flow_format;
692 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
693 * operation, given the global 'preferred_flow_format'. */
695 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
697 if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
698 ovs_fatal(0, "flow cannot be expressed in flow format %s "
699 "(flow format %s or better is required)",
700 ofputil_flow_format_to_string(preferred_flow_format),
701 ofputil_flow_format_to_string(flow_format));
706 do_flow_mod_file__(int argc OVS_UNUSED, char *argv[], uint16_t command)
708 enum nx_flow_format flow_format;
709 bool flow_mod_table_id;
710 struct list requests;
714 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
716 ovs_fatal(errno, "%s: open", argv[2]);
719 list_init(&requests);
720 flow_format = set_initial_format_for_flow_mod(&requests);
721 flow_mod_table_id = false;
723 open_vconn(argv[1], &vconn);
724 while (parse_ofp_flow_mod_file(&requests, &flow_format, &flow_mod_table_id,
726 check_final_format_for_flow_mod(flow_format);
727 transact_multiple_noreply(vconn, &requests);
737 do_flow_mod__(int argc, char *argv[], uint16_t command)
739 enum nx_flow_format flow_format;
740 bool flow_mod_table_id;
741 struct list requests;
744 if (argc > 2 && !strcmp(argv[2], "-")) {
745 do_flow_mod_file__(argc, argv, command);
749 list_init(&requests);
750 flow_format = set_initial_format_for_flow_mod(&requests);
751 flow_mod_table_id = false;
753 parse_ofp_flow_mod_str(&requests, &flow_format, &flow_mod_table_id,
754 argc > 2 ? argv[2] : "", command, false);
755 check_final_format_for_flow_mod(flow_format);
757 open_vconn(argv[1], &vconn);
758 transact_multiple_noreply(vconn, &requests);
763 do_add_flow(int argc, char *argv[])
765 do_flow_mod__(argc, argv, OFPFC_ADD);
769 do_add_flows(int argc, char *argv[])
771 do_flow_mod_file__(argc, argv, OFPFC_ADD);
775 do_mod_flows(int argc, char *argv[])
777 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
781 do_del_flows(int argc, char *argv[])
783 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
787 set_packet_in_format(struct vconn *vconn,
788 enum nx_packet_in_format packet_in_format)
790 struct ofpbuf *spif = ofputil_make_set_packet_in_format(packet_in_format);
791 transact_noreply(vconn, spif);
792 VLOG_DBG("%s: using user-specified packet in format %s",
793 vconn_get_name(vconn),
794 ofputil_packet_in_format_to_string(packet_in_format));
798 monitor_vconn(struct vconn *vconn)
800 struct unixctl_server *server;
801 bool exiting = false;
804 if (preferred_packet_in_format >= 0) {
805 set_packet_in_format(vconn, preferred_packet_in_format);
807 struct ofpbuf *spif, *reply;
809 spif = ofputil_make_set_packet_in_format(NXPIF_NXM);
810 run(vconn_transact_noreply(vconn, spif, &reply),
811 "talking to %s", vconn_get_name(vconn));
813 char *s = ofp_to_string(reply->data, reply->size, 2);
814 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
815 " replied: %s. Falling back to the switch default.",
816 vconn_get_name(vconn), s);
818 ofpbuf_delete(reply);
822 /* Daemonization will close stderr but we really want to keep it, so make a
824 fd = dup(STDERR_FILENO);
827 error = unixctl_server_create(NULL, &server);
829 ovs_fatal(error, "failed to create unixctl server");
831 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
832 daemonize_complete();
834 /* Now get stderr back. */
835 dup2(fd, STDERR_FILENO);
841 unixctl_server_run(server);
844 retval = vconn_recv(vconn, &b);
845 if (retval == EAGAIN) {
849 run(retval, "vconn_recv");
850 ofp_print(stderr, b->data, b->size, verbosity + 2);
859 vconn_run_wait(vconn);
860 vconn_recv_wait(vconn);
861 unixctl_server_wait(server);
867 do_monitor(int argc, char *argv[])
871 open_vconn(argv[1], &vconn);
873 struct ofp_switch_config config;
875 fetch_switch_config(vconn, &config);
876 config.miss_send_len = htons(atoi(argv[2]));
877 set_switch_config(vconn, &config);
879 monitor_vconn(vconn);
883 do_snoop(int argc OVS_UNUSED, char *argv[])
887 open_vconn__(argv[1], "snoop", &vconn);
888 monitor_vconn(vconn);
892 do_dump_ports(int argc, char *argv[])
894 struct ofp_port_stats_request *req;
895 struct ofpbuf *request;
898 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
899 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
900 req->port_no = htons(port);
901 dump_stats_transaction(argv[1], request);
905 do_probe(int argc OVS_UNUSED, char *argv[])
907 struct ofpbuf *request;
909 struct ofpbuf *reply;
911 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
912 open_vconn(argv[1], &vconn);
913 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
914 if (reply->size != sizeof(struct ofp_header)) {
915 ovs_fatal(0, "reply does not match request");
917 ofpbuf_delete(reply);
922 do_mod_port(int argc OVS_UNUSED, char *argv[])
924 struct ofp_port_mod *opm;
925 struct ofp_phy_port opp;
926 struct ofpbuf *request;
929 fetch_ofp_phy_port(argv[1], argv[2], &opp);
931 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
932 opm->port_no = opp.port_no;
933 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
934 opm->config = htonl(0);
935 opm->mask = htonl(0);
936 opm->advertise = htonl(0);
938 if (!strcasecmp(argv[3], "up")) {
939 opm->mask |= htonl(OFPPC_PORT_DOWN);
940 } else if (!strcasecmp(argv[3], "down")) {
941 opm->mask |= htonl(OFPPC_PORT_DOWN);
942 opm->config |= htonl(OFPPC_PORT_DOWN);
943 } else if (!strcasecmp(argv[3], "flood")) {
944 opm->mask |= htonl(OFPPC_NO_FLOOD);
945 } else if (!strcasecmp(argv[3], "noflood")) {
946 opm->mask |= htonl(OFPPC_NO_FLOOD);
947 opm->config |= htonl(OFPPC_NO_FLOOD);
948 } else if (!strcasecmp(argv[3], "forward")) {
949 opm->mask |= htonl(OFPPC_NO_FWD);
950 } else if (!strcasecmp(argv[3], "noforward")) {
951 opm->mask |= htonl(OFPPC_NO_FWD);
952 opm->config |= htonl(OFPPC_NO_FWD);
954 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
957 open_vconn(argv[1], &vconn);
958 transact_noreply(vconn, request);
963 do_get_frags(int argc OVS_UNUSED, char *argv[])
965 struct ofp_switch_config config;
968 open_vconn(argv[1], &vconn);
969 fetch_switch_config(vconn, &config);
970 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
975 do_set_frags(int argc OVS_UNUSED, char *argv[])
977 struct ofp_switch_config config;
978 enum ofp_config_flags mode;
982 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
983 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
986 open_vconn(argv[1], &vconn);
987 fetch_switch_config(vconn, &config);
988 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
989 if (flags != config.flags) {
990 /* Set the configuration. */
991 config.flags = flags;
992 set_switch_config(vconn, &config);
994 /* Then retrieve the configuration to see if it really took. OpenFlow
995 * doesn't define error reporting for bad modes, so this is all we can
997 fetch_switch_config(vconn, &config);
998 if (flags != config.flags) {
999 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1000 "switch probably doesn't support mode \"%s\")",
1001 argv[1], ofputil_frag_handling_to_string(mode));
1008 do_ping(int argc, char *argv[])
1010 size_t max_payload = 65535 - sizeof(struct ofp_header);
1011 unsigned int payload;
1012 struct vconn *vconn;
1015 payload = argc > 2 ? atoi(argv[2]) : 64;
1016 if (payload > max_payload) {
1017 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1020 open_vconn(argv[1], &vconn);
1021 for (i = 0; i < 10; i++) {
1022 struct timeval start, end;
1023 struct ofpbuf *request, *reply;
1024 struct ofp_header *rq_hdr, *rpy_hdr;
1026 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1027 OFPT_ECHO_REQUEST, &request);
1028 random_bytes(rq_hdr + 1, payload);
1030 xgettimeofday(&start);
1031 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1032 xgettimeofday(&end);
1034 rpy_hdr = reply->data;
1035 if (reply->size != request->size
1036 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1037 || rpy_hdr->xid != rq_hdr->xid
1038 || rpy_hdr->type != OFPT_ECHO_REPLY) {
1039 printf("Reply does not match request. Request:\n");
1040 ofp_print(stdout, request, request->size, verbosity + 2);
1042 ofp_print(stdout, reply, reply->size, verbosity + 2);
1044 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1045 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
1046 (1000*(double)(end.tv_sec - start.tv_sec))
1047 + (.001*(end.tv_usec - start.tv_usec)));
1048 ofpbuf_delete(request);
1049 ofpbuf_delete(reply);
1055 do_benchmark(int argc OVS_UNUSED, char *argv[])
1057 size_t max_payload = 65535 - sizeof(struct ofp_header);
1058 struct timeval start, end;
1059 unsigned int payload_size, message_size;
1060 struct vconn *vconn;
1065 payload_size = atoi(argv[2]);
1066 if (payload_size > max_payload) {
1067 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1069 message_size = sizeof(struct ofp_header) + payload_size;
1071 count = atoi(argv[3]);
1073 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1074 count, message_size, count * message_size);
1076 open_vconn(argv[1], &vconn);
1077 xgettimeofday(&start);
1078 for (i = 0; i < count; i++) {
1079 struct ofpbuf *request, *reply;
1080 struct ofp_header *rq_hdr;
1082 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1083 memset(rq_hdr + 1, 0, payload_size);
1084 run(vconn_transact(vconn, request, &reply), "transact");
1085 ofpbuf_delete(reply);
1087 xgettimeofday(&end);
1090 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1091 + (.001*(end.tv_usec - start.tv_usec)));
1092 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1093 duration, count / (duration / 1000.0),
1094 count * message_size / (duration / 1000.0));
1098 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1103 /* replace-flows and diff-flows commands. */
1105 /* A flow table entry, possibly with two different versions. */
1107 struct cls_rule rule; /* Within a "struct classifier". */
1108 struct fte_version *versions[2];
1111 /* One version of a Flow Table Entry. */
1112 struct fte_version {
1114 uint16_t idle_timeout;
1115 uint16_t hard_timeout;
1117 union ofp_action *actions;
1121 /* Frees 'version' and the data that it owns. */
1123 fte_version_free(struct fte_version *version)
1126 free(version->actions);
1131 /* Returns true if 'a' and 'b' are the same, false if they differ.
1133 * Ignores differences in 'flags' because there's no way to retrieve flags from
1134 * an OpenFlow switch. We have to assume that they are the same. */
1136 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1138 return (a->cookie == b->cookie
1139 && a->idle_timeout == b->idle_timeout
1140 && a->hard_timeout == b->hard_timeout
1141 && a->n_actions == b->n_actions
1142 && !memcmp(a->actions, b->actions,
1143 a->n_actions * sizeof *a->actions));
1146 /* Prints 'version' on stdout. Expects the caller to have printed the rule
1147 * associated with the version. */
1149 fte_version_print(const struct fte_version *version)
1153 if (version->cookie != htonll(0)) {
1154 printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
1156 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1157 printf(" idle_timeout=%"PRIu16, version->idle_timeout);
1159 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1160 printf(" hard_timeout=%"PRIu16, version->hard_timeout);
1164 ofp_print_actions(&s, version->actions, version->n_actions);
1165 printf(" %s\n", ds_cstr(&s));
1170 fte_from_cls_rule(const struct cls_rule *cls_rule)
1172 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1175 /* Frees 'fte' and its versions. */
1177 fte_free(struct fte *fte)
1180 fte_version_free(fte->versions[0]);
1181 fte_version_free(fte->versions[1]);
1186 /* Frees all of the FTEs within 'cls'. */
1188 fte_free_all(struct classifier *cls)
1190 struct cls_cursor cursor;
1191 struct fte *fte, *next;
1193 cls_cursor_init(&cursor, cls, NULL);
1194 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1195 classifier_remove(cls, &fte->rule);
1200 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1201 * necessary. Sets 'version' as the version of that rule with the given
1202 * 'index', replacing any existing version, if any.
1204 * Takes ownership of 'version'. */
1206 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1207 struct fte_version *version, int index)
1209 struct fte *old, *fte;
1211 fte = xzalloc(sizeof *fte);
1213 fte->versions[index] = version;
1215 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1217 fte_version_free(old->versions[index]);
1218 fte->versions[!index] = old->versions[!index];
1223 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1224 * with the specified 'index'. Returns the minimum flow format required to
1225 * represent the flows that were read. */
1226 static enum nx_flow_format
1227 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1229 enum nx_flow_format min_flow_format;
1233 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1235 ovs_fatal(errno, "%s: open", filename);
1239 min_flow_format = NXFF_OPENFLOW10;
1240 while (!ds_get_preprocessed_line(&s, file)) {
1241 struct fte_version *version;
1242 struct ofputil_flow_mod fm;
1243 enum nx_flow_format min_ff;
1245 parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1247 version = xmalloc(sizeof *version);
1248 version->cookie = fm.cookie;
1249 version->idle_timeout = fm.idle_timeout;
1250 version->hard_timeout = fm.hard_timeout;
1251 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1252 version->actions = fm.actions;
1253 version->n_actions = fm.n_actions;
1255 min_ff = ofputil_min_flow_format(&fm.cr);
1256 min_flow_format = MAX(min_flow_format, min_ff);
1257 check_final_format_for_flow_mod(min_flow_format);
1259 fte_insert(cls, &fm.cr, version, index);
1263 if (file != stdin) {
1267 return min_flow_format;
1270 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1271 * format 'flow_format', and adds them as flow table entries in 'cls' for the
1272 * version with the specified 'index'. */
1274 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1275 struct classifier *cls, int index)
1277 struct ofputil_flow_stats_request fsr;
1278 struct ofpbuf *request;
1282 fsr.aggregate = false;
1283 cls_rule_init_catchall(&fsr.match, 0);
1284 fsr.out_port = OFPP_NONE;
1285 fsr.table_id = 0xff;
1286 fsr.cookie = fsr.cookie_mask = htonll(0);
1287 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1288 send_xid = ((struct ofp_header *) request->data)->xid;
1289 send_openflow_buffer(vconn, request);
1294 struct ofpbuf *reply;
1296 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1297 recv_xid = ((struct ofp_header *) reply->data)->xid;
1298 if (send_xid == recv_xid) {
1299 const struct ofputil_msg_type *type;
1300 const struct ofp_stats_msg *osm;
1301 enum ofputil_msg_code code;
1303 ofputil_decode_msg_type(reply->data, &type);
1304 code = ofputil_msg_type_code(type);
1305 if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1306 code != OFPUTIL_NXST_FLOW_REPLY) {
1307 ovs_fatal(0, "received bad reply: %s",
1308 ofp_to_string(reply->data, reply->size,
1313 if (!(osm->flags & htons(OFPSF_REPLY_MORE))) {
1318 struct fte_version *version;
1319 struct ofputil_flow_stats fs;
1322 retval = ofputil_decode_flow_stats_reply(&fs, reply);
1324 if (retval != EOF) {
1325 ovs_fatal(0, "parse error in reply");
1330 version = xmalloc(sizeof *version);
1331 version->cookie = fs.cookie;
1332 version->idle_timeout = fs.idle_timeout;
1333 version->hard_timeout = fs.hard_timeout;
1335 version->n_actions = fs.n_actions;
1336 version->actions = xmemdup(fs.actions,
1337 fs.n_actions * sizeof *fs.actions);
1339 fte_insert(cls, &fs.rule, version, index);
1342 VLOG_DBG("received reply with xid %08"PRIx32" "
1343 "!= expected %08"PRIx32, recv_xid, send_xid);
1345 ofpbuf_delete(reply);
1350 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1351 enum nx_flow_format flow_format, struct list *packets)
1353 const struct fte_version *version = fte->versions[index];
1354 struct ofputil_flow_mod fm;
1358 fm.cookie = version->cookie;
1360 fm.command = command;
1361 fm.idle_timeout = version->idle_timeout;
1362 fm.hard_timeout = version->hard_timeout;
1363 fm.buffer_id = UINT32_MAX;
1364 fm.out_port = OFPP_NONE;
1365 fm.flags = version->flags;
1366 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1367 command == OFPFC_MODIFY_STRICT) {
1368 fm.actions = version->actions;
1369 fm.n_actions = version->n_actions;
1375 ofm = ofputil_encode_flow_mod(&fm, flow_format, false);
1376 list_push_back(packets, &ofm->list_node);
1380 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1382 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1383 enum nx_flow_format min_flow_format, flow_format;
1384 struct cls_cursor cursor;
1385 struct classifier cls;
1386 struct list requests;
1387 struct vconn *vconn;
1390 classifier_init(&cls);
1391 min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1393 open_vconn(argv[1], &vconn);
1394 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1395 read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1397 list_init(&requests);
1399 /* Delete flows that exist on the switch but not in the file. */
1400 cls_cursor_init(&cursor, &cls, NULL);
1401 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1402 struct fte_version *file_ver = fte->versions[FILE_IDX];
1403 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1405 if (sw_ver && !file_ver) {
1406 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1407 flow_format, &requests);
1411 /* Add flows that exist in the file but not on the switch.
1412 * Update flows that exist in both places but differ. */
1413 cls_cursor_init(&cursor, &cls, NULL);
1414 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1415 struct fte_version *file_ver = fte->versions[FILE_IDX];
1416 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1419 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1420 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1424 transact_multiple_noreply(vconn, &requests);
1431 read_flows_from_source(const char *source, struct classifier *cls, int index)
1435 if (source[0] == '/' || source[0] == '.'
1436 || (!strchr(source, ':') && !stat(source, &s))) {
1437 read_flows_from_file(source, cls, index);
1439 enum nx_flow_format flow_format;
1440 struct vconn *vconn;
1442 open_vconn(source, &vconn);
1443 flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1444 read_flows_from_switch(vconn, flow_format, cls, index);
1450 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1452 bool differences = false;
1453 struct cls_cursor cursor;
1454 struct classifier cls;
1457 classifier_init(&cls);
1458 read_flows_from_source(argv[1], &cls, 0);
1459 read_flows_from_source(argv[2], &cls, 1);
1461 cls_cursor_init(&cursor, &cls, NULL);
1462 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1463 struct fte_version *a = fte->versions[0];
1464 struct fte_version *b = fte->versions[1];
1466 if (!a || !b || !fte_version_equals(a, b)) {
1467 char *rule_s = cls_rule_to_string(&fte->rule);
1469 printf("-%s", rule_s);
1470 fte_version_print(a);
1473 printf("+%s", rule_s);
1474 fte_version_print(b);
1489 /* Undocumented commands for unit testing. */
1492 print_packet_list(struct list *packets)
1494 struct ofpbuf *packet, *next;
1496 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1497 ofp_print(stdout, packet->data, packet->size, verbosity);
1498 list_remove(&packet->list_node);
1499 ofpbuf_delete(packet);
1503 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1504 * it back to stdout. */
1506 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1508 enum nx_flow_format flow_format;
1509 bool flow_mod_table_id;
1510 struct list packets;
1512 flow_format = NXFF_OPENFLOW10;
1513 if (preferred_flow_format > 0) {
1514 flow_format = preferred_flow_format;
1516 flow_mod_table_id = false;
1518 list_init(&packets);
1519 parse_ofp_flow_mod_str(&packets, &flow_format, &flow_mod_table_id,
1520 argv[1], OFPFC_ADD, false);
1521 print_packet_list(&packets);
1524 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1525 * add-flows) and prints each of the flows back to stdout. */
1527 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1529 enum nx_flow_format flow_format;
1530 bool flow_mod_table_id;
1531 struct list packets;
1534 file = fopen(argv[1], "r");
1536 ovs_fatal(errno, "%s: open", argv[1]);
1539 flow_format = NXFF_OPENFLOW10;
1540 if (preferred_flow_format > 0) {
1541 flow_format = preferred_flow_format;
1543 flow_mod_table_id = false;
1545 list_init(&packets);
1546 while (parse_ofp_flow_mod_file(&packets, &flow_format, &flow_mod_table_id,
1548 print_packet_list(&packets);
1553 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1554 * stdin, does some internal fussing with them, and then prints them back as
1555 * strings on stdout. */
1557 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1562 while (!ds_get_line(&in, stdin)) {
1563 struct ofpbuf nx_match;
1564 struct cls_rule rule;
1565 ovs_be64 cookie, cookie_mask;
1570 /* Delete comments, skip blank lines. */
1576 if (strchr(s, '#')) {
1577 *strchr(s, '#') = '\0';
1579 if (s[strspn(s, " ")] == '\0') {
1584 /* Convert string to nx_match. */
1585 ofpbuf_init(&nx_match, 0);
1586 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1588 /* Convert nx_match to cls_rule. */
1590 error = nx_pull_match(&nx_match, match_len, 0, &rule,
1591 &cookie, &cookie_mask);
1593 error = nx_pull_match_loose(&nx_match, match_len, 0, &rule,
1594 &cookie, &cookie_mask);
1600 /* Convert cls_rule back to nx_match. */
1601 ofpbuf_uninit(&nx_match);
1602 ofpbuf_init(&nx_match, 0);
1603 match_len = nx_put_match(&nx_match, &rule, cookie, cookie_mask);
1605 /* Convert nx_match to string. */
1606 out = nx_match_to_string(nx_match.data, match_len);
1610 printf("nx_pull_match() returned error %s\n",
1611 ofperr_get_name(error));
1614 ofpbuf_uninit(&nx_match);
1619 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1620 * binary data, interpreting them as an OpenFlow message, and prints the
1621 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1623 do_ofp_print(int argc, char *argv[])
1625 struct ofpbuf packet;
1627 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1628 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1629 ovs_fatal(0, "trailing garbage following hex bytes");
1631 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1632 ofpbuf_uninit(&packet);
1635 static const struct command all_commands[] = {
1636 { "show", 1, 1, do_show },
1637 { "monitor", 1, 2, do_monitor },
1638 { "snoop", 1, 1, do_snoop },
1639 { "dump-desc", 1, 1, do_dump_desc },
1640 { "dump-tables", 1, 1, do_dump_tables },
1641 { "dump-flows", 1, 2, do_dump_flows },
1642 { "dump-aggregate", 1, 2, do_dump_aggregate },
1643 { "queue-stats", 1, 3, do_queue_stats },
1644 { "add-flow", 2, 2, do_add_flow },
1645 { "add-flows", 2, 2, do_add_flows },
1646 { "mod-flows", 2, 2, do_mod_flows },
1647 { "del-flows", 1, 2, do_del_flows },
1648 { "replace-flows", 2, 2, do_replace_flows },
1649 { "diff-flows", 2, 2, do_diff_flows },
1650 { "dump-ports", 1, 2, do_dump_ports },
1651 { "mod-port", 3, 3, do_mod_port },
1652 { "get-frags", 1, 1, do_get_frags },
1653 { "set-frags", 2, 2, do_set_frags },
1654 { "probe", 1, 1, do_probe },
1655 { "ping", 1, 2, do_ping },
1656 { "benchmark", 3, 3, do_benchmark },
1657 { "help", 0, INT_MAX, do_help },
1659 /* Undocumented commands for testing. */
1660 { "parse-flow", 1, 1, do_parse_flow },
1661 { "parse-flows", 1, 1, do_parse_flows },
1662 { "parse-nx-match", 0, 0, do_parse_nx_match },
1663 { "ofp-print", 1, 2, do_ofp_print },
1665 { NULL, 0, 0, NULL },