2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
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.
22 #include <sys/socket.h>
32 #include "byte-order.h"
33 #include "classifier.h"
34 #include "command-line.h"
38 #include "dynamic-string.h"
39 #include "fatal-signal.h"
42 #include "ofp-actions.h"
43 #include "ofp-errors.h"
45 #include "ofp-parse.h"
46 #include "ofp-print.h"
48 #include "ofp-version-opt.h"
50 #include "ofproto/ofproto.h"
51 #include "openflow/nicira-ext.h"
52 #include "openflow/openflow.h"
54 #include "pcap-file.h"
55 #include "poll-loop.h"
57 #include "stream-ssl.h"
58 #include "socket-util.h"
64 #include "meta-flow.h"
67 VLOG_DEFINE_THIS_MODULE(ofctl);
69 /* --strict: Use strict matching for flow mod commands? Additionally governs
70 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
74 /* --readd: If true, on replace-flows, re-add even flows that have not changed
75 * (to reset flow counters). */
78 /* -F, --flow-format: Allowed protocols. By default, any protocol is
80 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
82 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
83 * commands. Either one of NXPIF_* to force a particular packet_in format, or
84 * -1 to let ovs-ofctl choose the default. */
85 static int preferred_packet_in_format = -1;
87 /* -m, --more: Additional verbosity for ofp-print functions. */
90 /* --timestamp: Print a timestamp before each received packet on "monitor" and
92 static bool timestamp;
94 /* --unixctl-path: Path to use for unixctl server, for "monitor" and "snoop"
96 static char *unixctl_path;
98 /* --sort, --rsort: Sort order. */
99 enum sort_order { SORT_ASC, SORT_DESC };
100 struct sort_criterion {
101 const struct mf_field *field; /* NULL means to sort by priority. */
102 enum sort_order order;
104 static struct sort_criterion *criteria;
105 static size_t n_criteria, allocated_criteria;
107 static const struct command *get_all_commands(void);
109 static void usage(void) NO_RETURN;
110 static void parse_options(int argc, char *argv[]);
112 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
113 struct ofpbuf **replyp,
114 struct ofputil_flow_stats *,
115 struct ofpbuf *ofpacts);
117 main(int argc, char *argv[])
119 set_program_name(argv[0]);
120 parse_options(argc, argv);
121 fatal_ignore_sigpipe();
122 run_command(argc - optind, argv + optind, get_all_commands());
127 add_sort_criterion(enum sort_order order, const char *field)
129 struct sort_criterion *sc;
131 if (n_criteria >= allocated_criteria) {
132 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
135 sc = &criteria[n_criteria++];
136 if (!field || !strcasecmp(field, "priority")) {
139 sc->field = mf_from_name(field);
141 ovs_fatal(0, "%s: unknown field name", field);
148 parse_options(int argc, char *argv[])
151 OPT_STRICT = UCHAR_MAX + 1,
158 OFP_VERSION_OPTION_ENUMS,
161 static const struct option long_options[] = {
162 {"timeout", required_argument, NULL, 't'},
163 {"strict", no_argument, NULL, OPT_STRICT},
164 {"readd", no_argument, NULL, OPT_READD},
165 {"flow-format", required_argument, NULL, 'F'},
166 {"packet-in-format", required_argument, NULL, 'P'},
167 {"more", no_argument, NULL, 'm'},
168 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
169 {"sort", optional_argument, NULL, OPT_SORT},
170 {"rsort", optional_argument, NULL, OPT_RSORT},
171 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
172 {"help", no_argument, NULL, 'h'},
174 OFP_VERSION_LONG_OPTIONS,
176 STREAM_SSL_LONG_OPTIONS,
179 char *short_options = long_options_to_short_options(long_options);
181 enum ofputil_protocol version_protocols;
183 /* For now, ovs-ofctl only enables OpenFlow 1.0 by default. This is
184 * because ovs-ofctl implements command such as "add-flow" as raw OpenFlow
185 * requests, but those requests have subtly different semantics in
186 * different OpenFlow versions. For example:
188 * - In OpenFlow 1.0, a "mod-flow" operation that does not find any
189 * existing flow to modify adds a new flow.
191 * - In OpenFlow 1.1, a "mod-flow" operation that does not find any
192 * existing flow to modify adds a new flow, but only if the mod-flow
193 * did not match on the flow cookie.
195 * - In OpenFlow 1.2 and a later, a "mod-flow" operation never adds a
198 set_allowed_ofp_versions("OpenFlow10");
201 unsigned long int timeout;
204 c = getopt_long(argc, argv, short_options, long_options, NULL);
211 timeout = strtoul(optarg, NULL, 10);
213 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
221 allowed_protocols = ofputil_protocols_from_string(optarg);
222 if (!allowed_protocols) {
223 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
228 preferred_packet_in_format =
229 ofputil_packet_in_format_from_string(optarg);
230 if (preferred_packet_in_format < 0) {
231 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
255 add_sort_criterion(SORT_ASC, optarg);
259 add_sort_criterion(SORT_DESC, optarg);
263 unixctl_path = optarg;
266 DAEMON_OPTION_HANDLERS
267 OFP_VERSION_OPTION_HANDLERS
269 STREAM_SSL_OPTION_HANDLERS
280 /* Always do a final sort pass based on priority. */
281 add_sort_criterion(SORT_DESC, "priority");
286 versions = get_allowed_ofp_versions();
287 version_protocols = ofputil_protocols_from_version_bitmap(versions);
288 if (!(allowed_protocols & version_protocols)) {
289 char *protocols = ofputil_protocols_to_string(allowed_protocols);
290 struct ds version_s = DS_EMPTY_INITIALIZER;
292 ofputil_format_version_bitmap_names(&version_s, versions);
293 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
294 "any of the enabled flow formats (%s). (Use -O to enable "
295 "additional OpenFlow versions or -F to enable additional "
296 "flow formats.)", ds_cstr(&version_s), protocols);
298 allowed_protocols &= version_protocols;
299 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
306 printf("%s: OpenFlow switch management utility\n"
307 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
308 "\nFor OpenFlow switches:\n"
309 " show SWITCH show OpenFlow information\n"
310 " dump-desc SWITCH print switch description\n"
311 " dump-tables SWITCH print table stats\n"
312 " dump-table-features SWITCH print table features\n"
313 " mod-port SWITCH IFACE ACT modify port behavior\n"
314 " mod-table SWITCH MOD modify flow table behavior\n"
315 " get-frags SWITCH print fragment handling behavior\n"
316 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
317 " dump-ports SWITCH [PORT] print port statistics\n"
318 " dump-ports-desc SWITCH [PORT] print port descriptions\n"
319 " dump-flows SWITCH print all flow entries\n"
320 " dump-flows SWITCH FLOW print matching FLOWs\n"
321 " dump-aggregate SWITCH print aggregate flow statistics\n"
322 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
323 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
324 " add-flow SWITCH FLOW add flow described by FLOW\n"
325 " add-flows SWITCH FILE add flows from FILE\n"
326 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
327 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
328 " replace-flows SWITCH FILE replace flows with those in FILE\n"
329 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
330 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
331 " execute ACTIONS on PACKET\n"
332 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
333 " print packets received from SWITCH\n"
334 " snoop SWITCH snoop on SWITCH and its controller\n"
335 " add-group SWITCH GROUP add group described by GROUP\n"
336 " add-group SWITCH FILE add group from FILE\n"
337 " mod-group SWITCH GROUP modify specific group\n"
338 " del-groups SWITCH [GROUP] delete matching GROUPs\n"
339 " dump-group-features SWITCH print group features\n"
340 " dump-groups SWITCH [GROUP] print group description\n"
341 " dump-group-stats SWITCH [GROUP] print group statistics\n"
342 " queue-get-config SWITCH PORT print queue information for port\n"
343 " add-meter SWITCH METER add meter described by METER\n"
344 " mod-meter SWITCH METER modify specific METER\n"
345 " del-meter SWITCH METER delete METER\n"
346 " del-meters SWITCH delete all meters\n"
347 " dump-meter SWITCH METER print METER configuration\n"
348 " dump-meters SWITCH print all meter configuration\n"
349 " meter-stats SWITCH [METER] print meter statistics\n"
350 " meter-features SWITCH print meter features\n"
351 "\nFor OpenFlow switches and controllers:\n"
352 " probe TARGET probe whether TARGET is up\n"
353 " ping TARGET [N] latency of N-byte echos\n"
354 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
355 "SWITCH or TARGET is an active OpenFlow connection method.\n"
356 "\nOther commands:\n"
357 " ofp-parse FILE print messages read from FILE\n"
358 " ofp-parse-pcap PCAP print OpenFlow read from PCAP\n",
359 program_name, program_name);
360 vconn_usage(true, false, false);
364 printf("\nOther options:\n"
365 " --strict use strict match for flow commands\n"
366 " --readd replace flows that haven't changed\n"
367 " -F, --flow-format=FORMAT force particular flow format\n"
368 " -P, --packet-in-format=FRMT force particular packet in format\n"
369 " -m, --more be more verbose printing OpenFlow\n"
370 " --timestamp (monitor, snoop) print timestamps\n"
371 " -t, --timeout=SECS give up after SECS seconds\n"
372 " --sort[=field] sort in ascending order\n"
373 " --rsort[=field] sort in descending order\n"
374 " --unixctl=SOCKET set control socket name\n"
375 " -h, --help display this help message\n"
376 " -V, --version display version information\n");
381 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
382 const char *argv[] OVS_UNUSED, void *exiting_)
384 bool *exiting = exiting_;
386 unixctl_command_reply(conn, NULL);
389 static void run(int retval, const char *message, ...)
393 run(int retval, const char *message, ...)
398 va_start(args, message);
399 ovs_fatal_valist(retval, message, args);
403 /* Generic commands. */
406 open_vconn_socket(const char *name, struct vconn **vconnp)
408 char *vconn_name = xasprintf("unix:%s", name);
411 error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
413 if (error && error != ENOENT) {
414 ovs_fatal(0, "%s: failed to open socket (%s)", name,
415 ovs_strerror(error));
422 enum open_target { MGMT, SNOOP };
424 static enum ofputil_protocol
425 open_vconn__(const char *name, enum open_target target,
426 struct vconn **vconnp)
428 const char *suffix = target == MGMT ? "mgmt" : "snoop";
429 char *datapath_name, *datapath_type, *socket_name;
430 enum ofputil_protocol protocol;
435 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
437 ofproto_parse_name(name, &datapath_name, &datapath_type);
438 socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
442 if (strchr(name, ':')) {
443 run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
444 "connecting to %s", name);
445 } else if (!open_vconn_socket(name, vconnp)) {
447 } else if (!open_vconn_socket(bridge_path, vconnp)) {
449 } else if (!open_vconn_socket(socket_name, vconnp)) {
452 ovs_fatal(0, "%s is not a bridge or a socket", name);
455 if (target == SNOOP) {
456 vconn_set_recv_any_version(*vconnp);
462 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
463 error = vconn_connect_block(*vconnp);
465 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
466 ovs_strerror(error));
469 ofp_version = vconn_get_version(*vconnp);
470 protocol = ofputil_protocol_from_ofp_version(ofp_version);
472 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
478 static enum ofputil_protocol
479 open_vconn(const char *name, struct vconn **vconnp)
481 return open_vconn__(name, MGMT, vconnp);
485 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
487 ofpmsg_update_length(buffer);
488 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
492 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
494 struct ofpbuf *reply;
496 ofpmsg_update_length(request);
497 run(vconn_transact(vconn, request, &reply), "talking to %s",
498 vconn_get_name(vconn));
499 ofp_print(stdout, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 1);
500 ofpbuf_delete(reply);
504 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
506 struct ofpbuf *request;
509 open_vconn(vconn_name, &vconn);
510 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
511 dump_transaction(vconn, request);
516 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
518 const struct ofp_header *request_oh = ofpbuf_data(request);
519 ovs_be32 send_xid = request_oh->xid;
520 enum ofpraw request_raw;
521 enum ofpraw reply_raw;
524 ofpraw_decode_partial(&request_raw, ofpbuf_data(request), ofpbuf_size(request));
525 reply_raw = ofpraw_stats_request_to_reply(request_raw,
526 request_oh->version);
528 send_openflow_buffer(vconn, request);
531 struct ofpbuf *reply;
533 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
534 recv_xid = ((struct ofp_header *) ofpbuf_data(reply))->xid;
535 if (send_xid == recv_xid) {
538 ofp_print(stdout, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 1);
540 ofpraw_decode(&raw, ofpbuf_data(reply));
541 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
543 } else if (raw == reply_raw) {
544 done = !ofpmp_more(ofpbuf_data(reply));
546 ovs_fatal(0, "received bad reply: %s",
547 ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
551 VLOG_DBG("received reply with xid %08"PRIx32" "
552 "!= expected %08"PRIx32, recv_xid, send_xid);
554 ofpbuf_delete(reply);
559 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
561 struct ofpbuf *request;
564 open_vconn(vconn_name, &vconn);
565 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
566 dump_stats_transaction(vconn, request);
570 /* Sends all of the 'requests', which should be requests that only have replies
571 * if an error occurs, and waits for them to succeed or fail. If an error does
572 * occur, prints it and exits with an error.
574 * Destroys all of the 'requests'. */
576 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
578 struct ofpbuf *request, *reply;
580 LIST_FOR_EACH (request, list_node, requests) {
581 ofpmsg_update_length(request);
584 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
585 "talking to %s", vconn_get_name(vconn));
587 ofp_print(stderr, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 2);
590 ofpbuf_delete(reply);
593 /* Sends 'request', which should be a request that only has a reply if an error
594 * occurs, and waits for it to succeed or fail. If an error does occur, prints
595 * it and exits with an error.
597 * Destroys 'request'. */
599 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
601 struct list requests;
603 list_init(&requests);
604 list_push_back(&requests, &request->list_node);
605 transact_multiple_noreply(vconn, &requests);
609 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
611 struct ofp_switch_config *config;
612 struct ofpbuf *request;
613 struct ofpbuf *reply;
616 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
617 vconn_get_version(vconn), 0);
618 run(vconn_transact(vconn, request, &reply),
619 "talking to %s", vconn_get_name(vconn));
621 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
622 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
625 config = ofpbuf_pull(reply, sizeof *config);
628 ofpbuf_delete(reply);
632 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
634 struct ofpbuf *request;
636 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
637 ofpbuf_put(request, config, sizeof *config);
639 transact_noreply(vconn, request);
643 ofctl_show(int argc OVS_UNUSED, char *argv[])
645 const char *vconn_name = argv[1];
646 enum ofp_version version;
648 struct ofpbuf *request;
649 struct ofpbuf *reply;
652 open_vconn(vconn_name, &vconn);
653 version = vconn_get_version(vconn);
654 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, version, 0);
655 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
657 has_ports = ofputil_switch_features_has_ports(reply);
658 ofp_print(stdout, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 1);
659 ofpbuf_delete(reply);
662 request = ofputil_encode_port_desc_stats_request(version, OFPP_ANY);
663 dump_stats_transaction(vconn, request);
665 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
670 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
672 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
676 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
678 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
682 ofctl_dump_table_features(int argc OVS_UNUSED, char *argv[])
684 struct ofpbuf *request;
687 open_vconn(argv[1], &vconn);
688 request = ofputil_encode_table_features_request(vconn_get_version(vconn));
690 dump_stats_transaction(vconn, request);
696 static bool fetch_port_by_stats(struct vconn *,
697 const char *port_name, ofp_port_t port_no,
698 struct ofputil_phy_port *);
700 /* Uses OFPT_FEATURES_REQUEST to attempt to fetch information about the port
701 * named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
702 * successful, false on failure.
704 * This is only appropriate for OpenFlow 1.0, 1.1, and 1.2, which include a
705 * list of ports in OFPT_FEATURES_REPLY. */
707 fetch_port_by_features(struct vconn *vconn,
708 const char *port_name, ofp_port_t port_no,
709 struct ofputil_phy_port *pp)
711 struct ofputil_switch_features features;
712 const struct ofp_header *oh;
713 struct ofpbuf *request, *reply;
719 /* Fetch the switch's ofp_switch_features. */
720 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
721 vconn_get_version(vconn), 0);
722 run(vconn_transact(vconn, request, &reply),
723 "talking to %s", vconn_get_name(vconn));
725 oh = ofpbuf_data(reply);
726 if (ofptype_decode(&type, ofpbuf_data(reply))
727 || type != OFPTYPE_FEATURES_REPLY) {
728 ovs_fatal(0, "%s: received bad features reply", vconn_get_name(vconn));
730 if (!ofputil_switch_features_has_ports(reply)) {
731 /* The switch features reply does not contain a complete list of ports.
732 * Probably, there are more ports than will fit into a single 64 kB
733 * OpenFlow message. Use OFPST_PORT_DESC to get a complete list of
735 ofpbuf_delete(reply);
736 return fetch_port_by_stats(vconn, port_name, port_no, pp);
739 error = ofputil_decode_switch_features(oh, &features, &b);
741 ovs_fatal(0, "%s: failed to decode features reply (%s)",
742 vconn_get_name(vconn), ofperr_to_string(error));
745 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
746 if (port_no != OFPP_NONE
747 ? port_no == pp->port_no
748 : !strcmp(pp->name, port_name)) {
753 ofpbuf_delete(reply);
757 /* Uses a OFPST_PORT_DESC request to attempt to fetch information about the
758 * port named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
759 * successful, false on failure.
761 * This is most appropriate for OpenFlow 1.3 and later. Open vSwitch 1.7 and
762 * later also implements OFPST_PORT_DESC, as an extension, for OpenFlow 1.0,
763 * 1.1, and 1.2, so this can be used as a fallback in those versions when there
764 * are too many ports than fit in an OFPT_FEATURES_REPLY. */
766 fetch_port_by_stats(struct vconn *vconn,
767 const char *port_name, ofp_port_t port_no,
768 struct ofputil_phy_port *pp)
770 struct ofpbuf *request;
775 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
777 send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
779 send_openflow_buffer(vconn, request);
782 struct ofpbuf *reply;
784 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
785 recv_xid = ((struct ofp_header *) ofpbuf_data(reply))->xid;
786 if (send_xid == recv_xid) {
787 struct ofp_header *oh = ofpbuf_data(reply);
792 ofpbuf_use_const(&b, oh, ntohs(oh->length));
793 if (ofptype_pull(&type, &b)
794 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
795 ovs_fatal(0, "received bad reply: %s",
796 ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
800 flags = ofpmp_flags(oh);
801 done = !(flags & OFPSF_REPLY_MORE);
804 /* We've already found the port, but we need to drain
805 * the queue of any other replies for this request. */
809 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
810 if (port_no != OFPP_NONE ? port_no == pp->port_no
811 : !strcmp(pp->name, port_name)) {
817 VLOG_DBG("received reply with xid %08"PRIx32" "
818 "!= expected %08"PRIx32, recv_xid, send_xid);
820 ofpbuf_delete(reply);
827 str_to_ofp(const char *s, ofp_port_t *ofp_port)
832 ret = str_to_uint(s, 10, &port_);
833 *ofp_port = u16_to_ofp(port_);
837 /* Opens a connection to 'vconn_name', fetches the port structure for
838 * 'port_name' (which may be a port name or number), and copies it into
841 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
842 struct ofputil_phy_port *pp)
848 /* Try to interpret the argument as a port number. */
849 if (!str_to_ofp(port_name, &port_no)) {
853 /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
854 * OFPT_FEATURES_REPLY message. OpenFlow 1.3 and later versions put it
855 * into the OFPST_PORT_DESC reply. Try it the correct way. */
856 open_vconn(vconn_name, &vconn);
857 found = (vconn_get_version(vconn) < OFP13_VERSION
858 ? fetch_port_by_features(vconn, port_name, port_no, pp)
859 : fetch_port_by_stats(vconn, port_name, port_no, pp));
863 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
867 /* Returns the port number corresponding to 'port_name' (which may be a port
868 * name or number) within the switch 'vconn_name'. */
870 str_to_port_no(const char *vconn_name, const char *port_name)
874 if (ofputil_port_from_string(port_name, &port_no)) {
877 struct ofputil_phy_port pp;
879 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
885 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
886 enum ofputil_protocol *cur)
889 struct ofpbuf *request, *reply;
890 enum ofputil_protocol next;
892 request = ofputil_encode_set_protocol(*cur, want, &next);
897 run(vconn_transact_noreply(vconn, request, &reply),
898 "talking to %s", vconn_get_name(vconn));
900 char *s = ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply), 2);
901 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
902 vconn_get_name(vconn), s);
904 ofpbuf_delete(reply);
912 static enum ofputil_protocol
913 set_protocol_for_flow_dump(struct vconn *vconn,
914 enum ofputil_protocol cur_protocol,
915 enum ofputil_protocol usable_protocols)
920 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
921 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
922 if (f & usable_protocols & allowed_protocols
923 && try_set_protocol(vconn, f, &cur_protocol)) {
928 usable_s = ofputil_protocols_to_string(usable_protocols);
929 if (usable_protocols & allowed_protocols) {
930 ovs_fatal(0, "switch does not support any of the usable flow "
931 "formats (%s)", usable_s);
933 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
934 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
935 "allowed flow formats (%s)", usable_s, allowed_s);
939 static struct vconn *
940 prepare_dump_flows(int argc, char *argv[], bool aggregate,
941 struct ofpbuf **requestp)
943 enum ofputil_protocol usable_protocols, protocol;
944 struct ofputil_flow_stats_request fsr;
948 error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
949 argc > 2 ? argv[2] : "",
952 ovs_fatal(0, "%s", error);
955 protocol = open_vconn(argv[1], &vconn);
956 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
957 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
962 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
964 struct ofpbuf *request;
967 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
968 dump_stats_transaction(vconn, request);
973 compare_flows(const void *afs_, const void *bfs_)
975 const struct ofputil_flow_stats *afs = afs_;
976 const struct ofputil_flow_stats *bfs = bfs_;
977 const struct match *a = &afs->match;
978 const struct match *b = &bfs->match;
979 const struct sort_criterion *sc;
981 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
982 const struct mf_field *f = sc->field;
986 unsigned int a_pri = afs->priority;
987 unsigned int b_pri = bfs->priority;
988 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
992 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
993 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
995 /* Skip the test for sc->order, so that missing fields always
996 * sort to the end whether we're sorting in ascending or
997 * descending order. */
1000 union mf_value aval, bval;
1002 mf_get_value(f, &a->flow, &aval);
1003 mf_get_value(f, &b->flow, &bval);
1004 ret = memcmp(&aval, &bval, f->n_bytes);
1009 return sc->order == SORT_ASC ? ret : -ret;
1017 ofctl_dump_flows(int argc, char *argv[])
1020 return ofctl_dump_flows__(argc, argv, false);
1022 struct ofputil_flow_stats *fses;
1023 size_t n_fses, allocated_fses;
1024 struct ofpbuf *request;
1025 struct ofpbuf ofpacts;
1026 struct ofpbuf *reply;
1027 struct vconn *vconn;
1032 vconn = prepare_dump_flows(argc, argv, false, &request);
1033 send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
1034 send_openflow_buffer(vconn, request);
1037 n_fses = allocated_fses = 0;
1039 ofpbuf_init(&ofpacts, 0);
1041 struct ofputil_flow_stats *fs;
1043 if (n_fses >= allocated_fses) {
1044 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
1048 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
1052 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1055 ofpbuf_uninit(&ofpacts);
1057 qsort(fses, n_fses, sizeof *fses, compare_flows);
1060 for (i = 0; i < n_fses; i++) {
1062 ofp_print_flow_stats(&s, &fses[i]);
1067 for (i = 0; i < n_fses; i++) {
1068 free(CONST_CAST(struct ofpact *, fses[i].ofpacts));
1077 ofctl_dump_aggregate(int argc, char *argv[])
1079 return ofctl_dump_flows__(argc, argv, true);
1083 ofctl_queue_stats(int argc, char *argv[])
1085 struct ofpbuf *request;
1086 struct vconn *vconn;
1087 struct ofputil_queue_stats_request oqs;
1089 open_vconn(argv[1], &vconn);
1091 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
1092 oqs.port_no = str_to_port_no(argv[1], argv[2]);
1094 oqs.port_no = OFPP_ANY;
1096 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
1097 oqs.queue_id = atoi(argv[3]);
1099 oqs.queue_id = OFPQ_ALL;
1102 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1103 dump_stats_transaction(vconn, request);
1108 ofctl_queue_get_config(int argc OVS_UNUSED, char *argv[])
1110 const char *vconn_name = argv[1];
1111 const char *port_name = argv[2];
1112 enum ofputil_protocol protocol;
1113 enum ofp_version version;
1114 struct ofpbuf *request;
1115 struct vconn *vconn;
1118 port = str_to_port_no(vconn_name, port_name);
1120 protocol = open_vconn(vconn_name, &vconn);
1121 version = ofputil_protocol_to_ofp_version(protocol);
1122 request = ofputil_encode_queue_get_config_request(version, port);
1123 dump_transaction(vconn, request);
1127 static enum ofputil_protocol
1128 open_vconn_for_flow_mod(const char *remote, struct vconn **vconnp,
1129 enum ofputil_protocol usable_protocols)
1131 enum ofputil_protocol cur_protocol;
1135 if (!(usable_protocols & allowed_protocols)) {
1136 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1137 usable_s = ofputil_protocols_to_string(usable_protocols);
1138 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1139 "allowed flow formats (%s)", usable_s, allowed_s);
1142 /* If the initial flow format is allowed and usable, keep it. */
1143 cur_protocol = open_vconn(remote, vconnp);
1144 if (usable_protocols & allowed_protocols & cur_protocol) {
1145 return cur_protocol;
1148 /* Otherwise try each flow format in turn. */
1149 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1150 enum ofputil_protocol f = 1 << i;
1152 if (f != cur_protocol
1153 && f & usable_protocols & allowed_protocols
1154 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1159 usable_s = ofputil_protocols_to_string(usable_protocols);
1160 ovs_fatal(0, "switch does not support any of the usable flow "
1161 "formats (%s)", usable_s);
1165 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1166 size_t n_fms, enum ofputil_protocol usable_protocols)
1168 enum ofputil_protocol protocol;
1169 struct vconn *vconn;
1172 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1174 for (i = 0; i < n_fms; i++) {
1175 struct ofputil_flow_mod *fm = &fms[i];
1177 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1178 free(CONST_CAST(struct ofpact *, fm->ofpacts));
1184 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1186 enum ofputil_protocol usable_protocols;
1187 struct ofputil_flow_mod *fms = NULL;
1191 error = parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms,
1194 ovs_fatal(0, "%s", error);
1196 ofctl_flow_mod__(argv[1], fms, n_fms, usable_protocols);
1201 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1203 if (argc > 2 && !strcmp(argv[2], "-")) {
1204 ofctl_flow_mod_file(argc, argv, command);
1206 struct ofputil_flow_mod fm;
1208 enum ofputil_protocol usable_protocols;
1210 error = parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command,
1213 ovs_fatal(0, "%s", error);
1215 ofctl_flow_mod__(argv[1], &fm, 1, usable_protocols);
1220 ofctl_add_flow(int argc, char *argv[])
1222 ofctl_flow_mod(argc, argv, OFPFC_ADD);
1226 ofctl_add_flows(int argc, char *argv[])
1228 ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1232 ofctl_mod_flows(int argc, char *argv[])
1234 ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1238 ofctl_del_flows(int argc, char *argv[])
1240 ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1244 set_packet_in_format(struct vconn *vconn,
1245 enum nx_packet_in_format packet_in_format)
1247 struct ofpbuf *spif;
1249 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1251 transact_noreply(vconn, spif);
1252 VLOG_DBG("%s: using user-specified packet in format %s",
1253 vconn_get_name(vconn),
1254 ofputil_packet_in_format_to_string(packet_in_format));
1258 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1260 struct ofp_switch_config config;
1261 enum ofp_config_flags flags;
1263 fetch_switch_config(vconn, &config);
1264 flags = ntohs(config.flags);
1265 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1266 /* Set the invalid ttl config. */
1267 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1269 config.flags = htons(flags);
1270 set_switch_config(vconn, &config);
1272 /* Then retrieve the configuration to see if it really took. OpenFlow
1273 * doesn't define error reporting for bad modes, so this is all we can
1275 fetch_switch_config(vconn, &config);
1276 flags = ntohs(config.flags);
1277 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1278 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1279 "switch probably doesn't support mode)");
1286 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1287 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1288 * an error message and stores NULL in '*msgp'. */
1290 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1292 struct ofp_header *oh;
1295 msg = ofpbuf_new(strlen(hex) / 2);
1298 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1300 return "Trailing garbage in hex data";
1303 if (ofpbuf_size(msg) < sizeof(struct ofp_header)) {
1305 return "Message too short for OpenFlow";
1308 oh = ofpbuf_data(msg);
1309 if (ofpbuf_size(msg) != ntohs(oh->length)) {
1311 return "Message size does not match length in OpenFlow header";
1319 ofctl_send(struct unixctl_conn *conn, int argc,
1320 const char *argv[], void *vconn_)
1322 struct vconn *vconn = vconn_;
1329 for (i = 1; i < argc; i++) {
1330 const char *error_msg;
1334 error_msg = openflow_from_hex(argv[i], &msg);
1336 ds_put_format(&reply, "%s\n", error_msg);
1341 fprintf(stderr, "send: ");
1342 ofp_print(stderr, ofpbuf_data(msg), ofpbuf_size(msg), verbosity);
1344 error = vconn_send_block(vconn, msg);
1347 ds_put_format(&reply, "%s\n", ovs_strerror(error));
1350 ds_put_cstr(&reply, "sent\n");
1355 unixctl_command_reply(conn, ds_cstr(&reply));
1357 unixctl_command_reply_error(conn, ds_cstr(&reply));
1362 struct barrier_aux {
1363 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1364 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1368 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1369 const char *argv[] OVS_UNUSED, void *aux_)
1371 struct barrier_aux *aux = aux_;
1376 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1380 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1381 error = vconn_send_block(aux->vconn, msg);
1384 unixctl_command_reply_error(conn, ovs_strerror(error));
1391 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1392 const char *argv[], void *aux OVS_UNUSED)
1396 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1398 unixctl_command_reply_error(conn, ovs_strerror(errno));
1403 dup2(fd, STDERR_FILENO);
1405 unixctl_command_reply(conn, NULL);
1409 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1410 const char *argv[] OVS_UNUSED, void *blocked_)
1412 bool *blocked = blocked_;
1416 unixctl_command_reply(conn, NULL);
1418 unixctl_command_reply(conn, "already blocking");
1423 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1424 const char *argv[] OVS_UNUSED, void *blocked_)
1426 bool *blocked = blocked_;
1430 unixctl_command_reply(conn, NULL);
1432 unixctl_command_reply(conn, "already unblocked");
1436 /* Prints to stdout all of the messages received on 'vconn'.
1438 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1439 * received on 'vconn'. */
1441 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1443 struct barrier_aux barrier_aux = { vconn, NULL };
1444 struct unixctl_server *server;
1445 bool exiting = false;
1446 bool blocked = false;
1449 daemon_save_fd(STDERR_FILENO);
1451 error = unixctl_server_create(unixctl_path, &server);
1453 ovs_fatal(error, "failed to create unixctl server");
1455 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1456 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1458 unixctl_command_register("ofctl/barrier", "", 0, 0,
1459 ofctl_barrier, &barrier_aux);
1460 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1461 ofctl_set_output_file, NULL);
1463 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1464 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1467 daemonize_complete();
1473 unixctl_server_run(server);
1478 retval = vconn_recv(vconn, &b);
1479 if (retval == EAGAIN) {
1482 run(retval, "vconn_recv");
1485 char *s = xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1486 time_wall_msec(), true);
1491 ofptype_decode(&type, ofpbuf_data(b));
1492 ofp_print(stderr, ofpbuf_data(b), ofpbuf_size(b), verbosity + 2);
1494 switch ((int) type) {
1495 case OFPTYPE_BARRIER_REPLY:
1496 if (barrier_aux.conn) {
1497 unixctl_command_reply(barrier_aux.conn, NULL);
1498 barrier_aux.conn = NULL;
1502 case OFPTYPE_ECHO_REQUEST:
1503 if (reply_to_echo_requests) {
1504 struct ofpbuf *reply;
1506 reply = make_echo_reply(ofpbuf_data(b));
1507 retval = vconn_send_block(vconn, reply);
1509 ovs_fatal(retval, "failed to send echo reply");
1522 vconn_run_wait(vconn);
1524 vconn_recv_wait(vconn);
1526 unixctl_server_wait(server);
1530 unixctl_server_destroy(server);
1534 ofctl_monitor(int argc, char *argv[])
1536 struct vconn *vconn;
1538 enum ofputil_protocol usable_protocols;
1540 open_vconn(argv[1], &vconn);
1541 for (i = 2; i < argc; i++) {
1542 const char *arg = argv[i];
1544 if (isdigit((unsigned char) *arg)) {
1545 struct ofp_switch_config config;
1547 fetch_switch_config(vconn, &config);
1548 config.miss_send_len = htons(atoi(arg));
1549 set_switch_config(vconn, &config);
1550 } else if (!strcmp(arg, "invalid_ttl")) {
1551 monitor_set_invalid_ttl_to_controller(vconn);
1552 } else if (!strncmp(arg, "watch:", 6)) {
1553 struct ofputil_flow_monitor_request fmr;
1557 error = parse_flow_monitor_request(&fmr, arg + 6,
1560 ovs_fatal(0, "%s", error);
1563 msg = ofpbuf_new(0);
1564 ofputil_append_flow_monitor_request(&fmr, msg);
1565 dump_stats_transaction(vconn, msg);
1567 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1571 if (preferred_packet_in_format >= 0) {
1572 set_packet_in_format(vconn, preferred_packet_in_format);
1574 enum ofp_version version = vconn_get_version(vconn);
1577 case OFP10_VERSION: {
1578 struct ofpbuf *spif, *reply;
1580 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1582 run(vconn_transact_noreply(vconn, spif, &reply),
1583 "talking to %s", vconn_get_name(vconn));
1585 char *s = ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply), 2);
1586 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1587 " replied: %s. Falling back to the switch default.",
1588 vconn_get_name(vconn), s);
1590 ofpbuf_delete(reply);
1605 monitor_vconn(vconn, true);
1609 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1611 struct vconn *vconn;
1613 open_vconn__(argv[1], SNOOP, &vconn);
1614 monitor_vconn(vconn, false);
1618 ofctl_dump_ports(int argc, char *argv[])
1620 struct ofpbuf *request;
1621 struct vconn *vconn;
1624 open_vconn(argv[1], &vconn);
1625 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1626 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1627 dump_stats_transaction(vconn, request);
1632 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1634 struct ofpbuf *request;
1635 struct vconn *vconn;
1638 open_vconn(argv[1], &vconn);
1639 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1640 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
1642 dump_stats_transaction(vconn, request);
1647 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1649 struct ofpbuf *request;
1650 struct vconn *vconn;
1651 struct ofpbuf *reply;
1653 open_vconn(argv[1], &vconn);
1654 request = make_echo_request(vconn_get_version(vconn));
1655 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1656 if (ofpbuf_size(reply) != sizeof(struct ofp_header)) {
1657 ovs_fatal(0, "reply does not match request");
1659 ofpbuf_delete(reply);
1664 ofctl_packet_out(int argc, char *argv[])
1666 enum ofputil_protocol protocol;
1667 struct ofputil_packet_out po;
1668 struct ofpbuf ofpacts;
1669 struct vconn *vconn;
1672 enum ofputil_protocol usable_protocols; /* XXX: Use in proto selection */
1674 ofpbuf_init(&ofpacts, 64);
1675 error = parse_ofpacts(argv[3], &ofpacts, &usable_protocols);
1677 ovs_fatal(0, "%s", error);
1680 po.buffer_id = UINT32_MAX;
1681 po.in_port = str_to_port_no(argv[1], argv[2]);
1682 po.ofpacts = ofpbuf_data(&ofpacts);
1683 po.ofpacts_len = ofpbuf_size(&ofpacts);
1685 protocol = open_vconn(argv[1], &vconn);
1686 for (i = 4; i < argc; i++) {
1687 struct ofpbuf *packet, *opo;
1688 const char *error_msg;
1690 error_msg = eth_from_hex(argv[i], &packet);
1692 ovs_fatal(0, "%s", error_msg);
1695 po.packet = ofpbuf_data(packet);
1696 po.packet_len = ofpbuf_size(packet);
1697 opo = ofputil_encode_packet_out(&po, protocol);
1698 transact_noreply(vconn, opo);
1699 ofpbuf_delete(packet);
1702 ofpbuf_uninit(&ofpacts);
1706 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1708 struct ofp_config_flag {
1709 const char *name; /* The flag's name. */
1710 enum ofputil_port_config bit; /* Bit to turn on or off. */
1711 bool on; /* Value to set the bit to. */
1713 static const struct ofp_config_flag flags[] = {
1714 { "up", OFPUTIL_PC_PORT_DOWN, false },
1715 { "down", OFPUTIL_PC_PORT_DOWN, true },
1716 { "stp", OFPUTIL_PC_NO_STP, false },
1717 { "receive", OFPUTIL_PC_NO_RECV, false },
1718 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1719 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1720 { "forward", OFPUTIL_PC_NO_FWD, false },
1721 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1724 const struct ofp_config_flag *flag;
1725 enum ofputil_protocol protocol;
1726 struct ofputil_port_mod pm;
1727 struct ofputil_phy_port pp;
1728 struct vconn *vconn;
1729 const char *command;
1732 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1734 pm.port_no = pp.port_no;
1735 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1740 if (!strncasecmp(argv[3], "no-", 3)) {
1741 command = argv[3] + 3;
1743 } else if (!strncasecmp(argv[3], "no", 2)) {
1744 command = argv[3] + 2;
1750 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1751 if (!strcasecmp(command, flag->name)) {
1752 pm.mask = flag->bit;
1753 pm.config = flag->on ^ not ? flag->bit : 0;
1757 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1760 protocol = open_vconn(argv[1], &vconn);
1761 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1766 ofctl_mod_table(int argc OVS_UNUSED, char *argv[])
1768 enum ofputil_protocol protocol, usable_protocols;
1769 struct ofputil_table_mod tm;
1770 struct vconn *vconn;
1774 error = parse_ofp_table_mod(&tm, argv[2], argv[3], &usable_protocols);
1776 ovs_fatal(0, "%s", error);
1779 protocol = open_vconn(argv[1], &vconn);
1780 if (!(protocol & usable_protocols)) {
1781 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1782 enum ofputil_protocol f = 1 << i;
1784 && f & usable_protocols
1785 && try_set_protocol(vconn, f, &protocol)) {
1792 if (!(protocol & usable_protocols)) {
1793 char *usable_s = ofputil_protocols_to_string(usable_protocols);
1794 ovs_fatal(0, "Switch does not support table mod message(%s)", usable_s);
1797 transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
1802 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1804 struct ofp_switch_config config;
1805 struct vconn *vconn;
1807 open_vconn(argv[1], &vconn);
1808 fetch_switch_config(vconn, &config);
1809 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1814 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1816 struct ofp_switch_config config;
1817 enum ofp_config_flags mode;
1818 struct vconn *vconn;
1821 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1822 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1825 open_vconn(argv[1], &vconn);
1826 fetch_switch_config(vconn, &config);
1827 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1828 if (flags != config.flags) {
1829 /* Set the configuration. */
1830 config.flags = flags;
1831 set_switch_config(vconn, &config);
1833 /* Then retrieve the configuration to see if it really took. OpenFlow
1834 * doesn't define error reporting for bad modes, so this is all we can
1836 fetch_switch_config(vconn, &config);
1837 if (flags != config.flags) {
1838 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1839 "switch probably doesn't support mode \"%s\")",
1840 argv[1], ofputil_frag_handling_to_string(mode));
1847 ofctl_ofp_parse(int argc OVS_UNUSED, char *argv[])
1849 const char *filename = argv[1];
1853 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1855 ovs_fatal(errno, "%s: open", filename);
1858 ofpbuf_init(&b, 65536);
1860 struct ofp_header *oh;
1861 size_t length, tail_len;
1866 oh = ofpbuf_put_uninit(&b, sizeof *oh);
1867 n = fread(oh, 1, sizeof *oh, file);
1870 } else if (n < sizeof *oh) {
1871 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1874 length = ntohs(oh->length);
1875 if (length < sizeof *oh) {
1876 ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
1880 tail_len = length - sizeof *oh;
1881 tail = ofpbuf_put_uninit(&b, tail_len);
1882 n = fread(tail, 1, tail_len, file);
1884 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1887 ofp_print(stdout, ofpbuf_data(&b), ofpbuf_size(&b), verbosity + 2);
1891 if (file != stdin) {
1897 is_openflow_port(ovs_be16 port_, char *ports[])
1899 uint16_t port = ntohs(port_);
1903 for (i = 0; ports[i]; i++) {
1904 if (port == atoi(ports[i])) {
1910 return port == OFP_PORT || port == OFP_OLD_PORT;
1915 ofctl_ofp_parse_pcap(int argc OVS_UNUSED, char *argv[])
1917 struct tcp_reader *reader;
1922 file = ovs_pcap_open(argv[1], "rb");
1924 ovs_fatal(errno, "%s: open failed", argv[1]);
1927 reader = tcp_reader_open();
1930 struct ofpbuf *packet;
1933 const struct pkt_metadata md = PKT_METADATA_INITIALIZER(ODPP_NONE);
1935 error = ovs_pcap_read(file, &packet, &when);
1939 flow_extract(packet, &md, &flow);
1940 if (flow.dl_type == htons(ETH_TYPE_IP)
1941 && flow.nw_proto == IPPROTO_TCP
1942 && (is_openflow_port(flow.tp_src, argv + 2) ||
1943 is_openflow_port(flow.tp_dst, argv + 2))) {
1944 struct ofpbuf *payload = tcp_reader_run(reader, &flow, packet);
1946 while (ofpbuf_size(payload) >= sizeof(struct ofp_header)) {
1947 const struct ofp_header *oh;
1948 void *data = ofpbuf_data(payload);
1951 /* Align OpenFlow on 8-byte boundary for safe access. */
1952 ofpbuf_shift(payload, -((intptr_t) data & 7));
1954 oh = ofpbuf_data(payload);
1955 length = ntohs(oh->length);
1956 if (ofpbuf_size(payload) < length) {
1966 char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
1971 printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
1972 IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
1973 IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
1974 ofp_print(stdout, ofpbuf_data(payload), length, verbosity + 1);
1975 ofpbuf_pull(payload, length);
1979 ofpbuf_delete(packet);
1981 tcp_reader_close(reader);
1985 ofctl_ping(int argc, char *argv[])
1987 size_t max_payload = 65535 - sizeof(struct ofp_header);
1988 unsigned int payload;
1989 struct vconn *vconn;
1992 payload = argc > 2 ? atoi(argv[2]) : 64;
1993 if (payload > max_payload) {
1994 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
1997 open_vconn(argv[1], &vconn);
1998 for (i = 0; i < 10; i++) {
1999 struct timeval start, end;
2000 struct ofpbuf *request, *reply;
2001 const struct ofp_header *rpy_hdr;
2004 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2005 vconn_get_version(vconn), payload);
2006 random_bytes(ofpbuf_put_uninit(request, payload), payload);
2008 xgettimeofday(&start);
2009 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2010 xgettimeofday(&end);
2012 rpy_hdr = ofpbuf_data(reply);
2013 if (ofptype_pull(&type, reply)
2014 || type != OFPTYPE_ECHO_REPLY
2015 || ofpbuf_size(reply) != payload
2016 || memcmp(ofpbuf_l3(request), ofpbuf_l3(reply), payload)) {
2017 printf("Reply does not match request. Request:\n");
2018 ofp_print(stdout, request, ofpbuf_size(request), verbosity + 2);
2020 ofp_print(stdout, reply, ofpbuf_size(reply), verbosity + 2);
2022 printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2023 ofpbuf_size(reply), argv[1], ntohl(rpy_hdr->xid),
2024 (1000*(double)(end.tv_sec - start.tv_sec))
2025 + (.001*(end.tv_usec - start.tv_usec)));
2026 ofpbuf_delete(request);
2027 ofpbuf_delete(reply);
2033 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
2035 size_t max_payload = 65535 - sizeof(struct ofp_header);
2036 struct timeval start, end;
2037 unsigned int payload_size, message_size;
2038 struct vconn *vconn;
2043 payload_size = atoi(argv[2]);
2044 if (payload_size > max_payload) {
2045 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2047 message_size = sizeof(struct ofp_header) + payload_size;
2049 count = atoi(argv[3]);
2051 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2052 count, message_size, count * message_size);
2054 open_vconn(argv[1], &vconn);
2055 xgettimeofday(&start);
2056 for (i = 0; i < count; i++) {
2057 struct ofpbuf *request, *reply;
2059 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2060 vconn_get_version(vconn), payload_size);
2061 ofpbuf_put_zeros(request, payload_size);
2062 run(vconn_transact(vconn, request, &reply), "transact");
2063 ofpbuf_delete(reply);
2065 xgettimeofday(&end);
2068 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2069 + (.001*(end.tv_usec - start.tv_usec)));
2070 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2071 duration, count / (duration / 1000.0),
2072 count * message_size / (duration / 1000.0));
2076 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2079 struct ofputil_group_mod *gm;
2080 struct ofpbuf *request;
2082 struct vconn *vconn;
2085 open_vconn(remote, &vconn);
2087 for (i = 0; i < n_gms; i++) {
2089 request = ofputil_encode_group_mod(vconn_get_version(vconn), gm);
2091 transact_noreply(vconn, request);
2101 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2103 struct ofputil_group_mod *gms = NULL;
2104 enum ofputil_protocol usable_protocols;
2108 error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2111 ovs_fatal(0, "%s", error);
2113 ofctl_group_mod__(argv[1], gms, n_gms);
2118 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2120 if (argc > 2 && !strcmp(argv[2], "-")) {
2121 ofctl_group_mod_file(argc, argv, command);
2123 enum ofputil_protocol usable_protocols;
2124 struct ofputil_group_mod gm;
2127 error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2130 ovs_fatal(0, "%s", error);
2132 ofctl_group_mod__(argv[1], &gm, 1);
2137 ofctl_add_group(int argc, char *argv[])
2139 ofctl_group_mod(argc, argv, OFPGC11_ADD);
2143 ofctl_add_groups(int argc, char *argv[])
2145 ofctl_group_mod_file(argc, argv, OFPGC11_ADD);
2149 ofctl_mod_group(int argc, char *argv[])
2151 ofctl_group_mod(argc, argv, OFPGC11_MODIFY);
2155 ofctl_del_groups(int argc, char *argv[])
2157 ofctl_group_mod(argc, argv, OFPGC11_DELETE);
2161 ofctl_dump_group_stats(int argc, char *argv[])
2163 enum ofputil_protocol usable_protocols;
2164 struct ofputil_group_mod gm;
2165 struct ofpbuf *request;
2166 struct vconn *vconn;
2170 memset(&gm, 0, sizeof gm);
2172 error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2173 argc > 2 ? argv[2] : "",
2176 ovs_fatal(0, "%s", error);
2179 group_id = gm.group_id;
2181 open_vconn(argv[1], &vconn);
2182 request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2185 dump_stats_transaction(vconn, request);
2192 ofctl_dump_group_desc(int argc OVS_UNUSED, char *argv[])
2194 struct ofpbuf *request;
2195 struct vconn *vconn;
2198 open_vconn(argv[1], &vconn);
2200 if (argc < 3 || !ofputil_group_from_string(argv[2], &group_id)) {
2201 group_id = OFPG11_ALL;
2204 request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2207 dump_stats_transaction(vconn, request);
2214 ofctl_dump_group_features(int argc OVS_UNUSED, char *argv[])
2216 struct ofpbuf *request;
2217 struct vconn *vconn;
2219 open_vconn(argv[1], &vconn);
2220 request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2222 dump_stats_transaction(vconn, request);
2229 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2234 /* replace-flows and diff-flows commands. */
2236 /* A flow table entry, possibly with two different versions. */
2238 struct cls_rule rule; /* Within a "struct classifier". */
2239 struct fte_version *versions[2];
2242 /* One version of a Flow Table Entry. */
2243 struct fte_version {
2245 uint16_t idle_timeout;
2246 uint16_t hard_timeout;
2248 struct ofpact *ofpacts;
2252 /* Frees 'version' and the data that it owns. */
2254 fte_version_free(struct fte_version *version)
2257 free(CONST_CAST(struct ofpact *, version->ofpacts));
2262 /* Returns true if 'a' and 'b' are the same, false if they differ.
2264 * Ignores differences in 'flags' because there's no way to retrieve flags from
2265 * an OpenFlow switch. We have to assume that they are the same. */
2267 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2269 return (a->cookie == b->cookie
2270 && a->idle_timeout == b->idle_timeout
2271 && a->hard_timeout == b->hard_timeout
2272 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2273 b->ofpacts, b->ofpacts_len));
2276 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2277 * 'index' into 's', followed by a new-line. */
2279 fte_version_format(const struct fte *fte, int index, struct ds *s)
2281 const struct fte_version *version = fte->versions[index];
2288 cls_rule_format(&fte->rule, s);
2289 if (version->cookie != htonll(0)) {
2290 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2292 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2293 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2295 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2296 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2299 ds_put_cstr(s, " actions=");
2300 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2302 ds_put_char(s, '\n');
2306 fte_from_cls_rule(const struct cls_rule *cls_rule)
2308 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2311 /* Frees 'fte' and its versions. */
2313 fte_free(struct fte *fte)
2316 fte_version_free(fte->versions[0]);
2317 fte_version_free(fte->versions[1]);
2318 cls_rule_destroy(&fte->rule);
2323 /* Frees all of the FTEs within 'cls'. */
2325 fte_free_all(struct classifier *cls)
2327 struct cls_cursor cursor;
2328 struct fte *fte, *next;
2330 fat_rwlock_wrlock(&cls->rwlock);
2331 cls_cursor_init(&cursor, cls, NULL);
2332 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
2333 classifier_remove(cls, &fte->rule);
2336 fat_rwlock_unlock(&cls->rwlock);
2337 classifier_destroy(cls);
2340 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
2341 * necessary. Sets 'version' as the version of that rule with the given
2342 * 'index', replacing any existing version, if any.
2344 * Takes ownership of 'version'. */
2346 fte_insert(struct classifier *cls, const struct match *match,
2347 unsigned int priority, struct fte_version *version, int index)
2349 struct fte *old, *fte;
2351 fte = xzalloc(sizeof *fte);
2352 cls_rule_init(&fte->rule, match, priority);
2353 fte->versions[index] = version;
2355 fat_rwlock_wrlock(&cls->rwlock);
2356 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
2357 fat_rwlock_unlock(&cls->rwlock);
2359 fte_version_free(old->versions[index]);
2360 fte->versions[!index] = old->versions[!index];
2361 cls_rule_destroy(&old->rule);
2366 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
2367 * with the specified 'index'. Returns the flow formats able to represent the
2368 * flows that were read. */
2369 static enum ofputil_protocol
2370 read_flows_from_file(const char *filename, struct classifier *cls, int index)
2372 enum ofputil_protocol usable_protocols;
2377 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2379 ovs_fatal(errno, "%s: open", filename);
2383 usable_protocols = OFPUTIL_P_ANY;
2385 while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2386 struct fte_version *version;
2387 struct ofputil_flow_mod fm;
2389 enum ofputil_protocol usable;
2391 error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2393 ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2395 usable_protocols &= usable;
2397 version = xmalloc(sizeof *version);
2398 version->cookie = fm.new_cookie;
2399 version->idle_timeout = fm.idle_timeout;
2400 version->hard_timeout = fm.hard_timeout;
2401 version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2402 | OFPUTIL_FF_EMERG);
2403 version->ofpacts = fm.ofpacts;
2404 version->ofpacts_len = fm.ofpacts_len;
2406 fte_insert(cls, &fm.match, fm.priority, version, index);
2410 if (file != stdin) {
2414 return usable_protocols;
2418 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2419 struct ofpbuf **replyp,
2420 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2422 struct ofpbuf *reply = *replyp;
2428 /* Get a flow stats reply message, if we don't already have one. */
2434 run(vconn_recv_block(vconn, &reply),
2435 "OpenFlow packet receive failed");
2436 } while (((struct ofp_header *) ofpbuf_data(reply))->xid != send_xid);
2438 error = ofptype_decode(&type, ofpbuf_data(reply));
2439 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2440 ovs_fatal(0, "received bad reply: %s",
2441 ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
2446 /* Pull an individual flow stats reply out of the message. */
2447 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2454 more = ofpmp_more(reply->frame);
2455 ofpbuf_delete(reply);
2464 ovs_fatal(0, "parse error in reply (%s)",
2465 ofperr_to_string(retval));
2470 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2471 * format 'protocol', and adds them as flow table entries in 'cls' for the
2472 * version with the specified 'index'. */
2474 read_flows_from_switch(struct vconn *vconn,
2475 enum ofputil_protocol protocol,
2476 struct classifier *cls, int index)
2478 struct ofputil_flow_stats_request fsr;
2479 struct ofputil_flow_stats fs;
2480 struct ofpbuf *request;
2481 struct ofpbuf ofpacts;
2482 struct ofpbuf *reply;
2485 fsr.aggregate = false;
2486 match_init_catchall(&fsr.match);
2487 fsr.out_port = OFPP_ANY;
2488 fsr.table_id = 0xff;
2489 fsr.cookie = fsr.cookie_mask = htonll(0);
2490 request = ofputil_encode_flow_stats_request(&fsr, protocol);
2491 send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
2492 send_openflow_buffer(vconn, request);
2495 ofpbuf_init(&ofpacts, 0);
2496 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2497 struct fte_version *version;
2499 version = xmalloc(sizeof *version);
2500 version->cookie = fs.cookie;
2501 version->idle_timeout = fs.idle_timeout;
2502 version->hard_timeout = fs.hard_timeout;
2504 version->ofpacts_len = fs.ofpacts_len;
2505 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2507 fte_insert(cls, &fs.match, fs.priority, version, index);
2509 ofpbuf_uninit(&ofpacts);
2513 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2514 enum ofputil_protocol protocol, struct list *packets)
2516 const struct fte_version *version = fte->versions[index];
2517 struct ofputil_flow_mod fm;
2520 minimatch_expand(&fte->rule.match, &fm.match);
2521 fm.priority = fte->rule.priority;
2522 fm.cookie = htonll(0);
2523 fm.cookie_mask = htonll(0);
2524 fm.new_cookie = version->cookie;
2525 fm.modify_cookie = true;
2527 fm.command = command;
2528 fm.idle_timeout = version->idle_timeout;
2529 fm.hard_timeout = version->hard_timeout;
2530 fm.buffer_id = UINT32_MAX;
2531 fm.out_port = OFPP_ANY;
2532 fm.flags = version->flags;
2533 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2534 command == OFPFC_MODIFY_STRICT) {
2535 fm.ofpacts = version->ofpacts;
2536 fm.ofpacts_len = version->ofpacts_len;
2542 ofm = ofputil_encode_flow_mod(&fm, protocol);
2543 list_push_back(packets, &ofm->list_node);
2547 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
2549 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2550 enum ofputil_protocol usable_protocols, protocol;
2551 struct cls_cursor cursor;
2552 struct classifier cls;
2553 struct list requests;
2554 struct vconn *vconn;
2557 classifier_init(&cls, NULL);
2558 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2560 protocol = open_vconn(argv[1], &vconn);
2561 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2563 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2565 list_init(&requests);
2567 /* Delete flows that exist on the switch but not in the file. */
2568 fat_rwlock_rdlock(&cls.rwlock);
2569 cls_cursor_init(&cursor, &cls, NULL);
2570 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2571 struct fte_version *file_ver = fte->versions[FILE_IDX];
2572 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2574 if (sw_ver && !file_ver) {
2575 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2576 protocol, &requests);
2580 /* Add flows that exist in the file but not on the switch.
2581 * Update flows that exist in both places but differ. */
2582 cls_cursor_init(&cursor, &cls, NULL);
2583 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2584 struct fte_version *file_ver = fte->versions[FILE_IDX];
2585 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2588 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2589 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2592 fat_rwlock_unlock(&cls.rwlock);
2593 transact_multiple_noreply(vconn, &requests);
2600 read_flows_from_source(const char *source, struct classifier *cls, int index)
2604 if (source[0] == '/' || source[0] == '.'
2605 || (!strchr(source, ':') && !stat(source, &s))) {
2606 read_flows_from_file(source, cls, index);
2608 enum ofputil_protocol protocol;
2609 struct vconn *vconn;
2611 protocol = open_vconn(source, &vconn);
2612 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2613 read_flows_from_switch(vconn, protocol, cls, index);
2619 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2621 bool differences = false;
2622 struct cls_cursor cursor;
2623 struct classifier cls;
2627 classifier_init(&cls, NULL);
2628 read_flows_from_source(argv[1], &cls, 0);
2629 read_flows_from_source(argv[2], &cls, 1);
2634 fat_rwlock_rdlock(&cls.rwlock);
2635 cls_cursor_init(&cursor, &cls, NULL);
2636 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2637 struct fte_version *a = fte->versions[0];
2638 struct fte_version *b = fte->versions[1];
2640 if (!a || !b || !fte_version_equals(a, b)) {
2641 fte_version_format(fte, 0, &a_s);
2642 fte_version_format(fte, 1, &b_s);
2643 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2645 printf("-%s", ds_cstr(&a_s));
2648 printf("+%s", ds_cstr(&b_s));
2654 fat_rwlock_unlock(&cls.rwlock);
2667 ofctl_meter_mod__(const char *bridge, const char *str, int command)
2669 struct ofputil_meter_mod mm;
2670 struct vconn *vconn;
2671 enum ofputil_protocol protocol;
2672 enum ofputil_protocol usable_protocols;
2673 enum ofp_version version;
2677 error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
2679 ovs_fatal(0, "%s", error);
2682 usable_protocols = OFPUTIL_P_OF13_UP;
2683 mm.command = command;
2684 mm.meter.meter_id = OFPM13_ALL;
2687 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2688 version = ofputil_protocol_to_ofp_version(protocol);
2689 transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
2694 ofctl_meter_request__(const char *bridge, const char *str,
2695 enum ofputil_meter_request_type type)
2697 struct ofputil_meter_mod mm;
2698 struct vconn *vconn;
2699 enum ofputil_protocol usable_protocols;
2700 enum ofputil_protocol protocol;
2701 enum ofp_version version;
2705 error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
2707 ovs_fatal(0, "%s", error);
2710 usable_protocols = OFPUTIL_P_OF13_UP;
2711 mm.meter.meter_id = OFPM13_ALL;
2714 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2715 version = ofputil_protocol_to_ofp_version(protocol);
2716 transact_noreply(vconn, ofputil_encode_meter_request(version,
2718 mm.meter.meter_id));
2724 ofctl_add_meter(int argc OVS_UNUSED, char *argv[])
2726 ofctl_meter_mod__(argv[1], argv[2], OFPMC13_ADD);
2730 ofctl_mod_meter(int argc OVS_UNUSED, char *argv[])
2732 ofctl_meter_mod__(argv[1], argv[2], OFPMC13_MODIFY);
2736 ofctl_del_meters(int argc, char *argv[])
2738 ofctl_meter_mod__(argv[1], argc > 2 ? argv[2] : NULL, OFPMC13_DELETE);
2742 ofctl_dump_meters(int argc, char *argv[])
2744 ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2745 OFPUTIL_METER_CONFIG);
2749 ofctl_meter_stats(int argc, char *argv[])
2751 ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2752 OFPUTIL_METER_STATS);
2756 ofctl_meter_features(int argc OVS_UNUSED, char *argv[])
2758 ofctl_meter_request__(argv[1], NULL, OFPUTIL_METER_FEATURES);
2762 /* Undocumented commands for unit testing. */
2765 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
2766 enum ofputil_protocol usable_protocols)
2768 enum ofputil_protocol protocol = 0;
2772 usable_s = ofputil_protocols_to_string(usable_protocols);
2773 printf("usable protocols: %s\n", usable_s);
2776 if (!(usable_protocols & allowed_protocols)) {
2777 ovs_fatal(0, "no usable protocol");
2779 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2781 if (protocol & usable_protocols & allowed_protocols) {
2785 ovs_assert(is_pow2(protocol));
2787 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2789 for (i = 0; i < n_fms; i++) {
2790 struct ofputil_flow_mod *fm = &fms[i];
2793 msg = ofputil_encode_flow_mod(fm, protocol);
2794 ofp_print(stdout, ofpbuf_data(msg), ofpbuf_size(msg), verbosity);
2797 free(CONST_CAST(struct ofpact *, fm->ofpacts));
2801 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2802 * it back to stdout. */
2804 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2806 enum ofputil_protocol usable_protocols;
2807 struct ofputil_flow_mod fm;
2810 error = parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, &usable_protocols);
2812 ovs_fatal(0, "%s", error);
2814 ofctl_parse_flows__(&fm, 1, usable_protocols);
2817 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2818 * add-flows) and prints each of the flows back to stdout. */
2820 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2822 enum ofputil_protocol usable_protocols;
2823 struct ofputil_flow_mod *fms = NULL;
2827 error = parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms,
2830 ovs_fatal(0, "%s", error);
2832 ofctl_parse_flows__(fms, n_fms, usable_protocols);
2837 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
2842 while (!ds_get_test_line(&in, stdin)) {
2843 struct ofpbuf nx_match;
2845 ovs_be64 cookie, cookie_mask;
2849 /* Convert string to nx_match. */
2850 ofpbuf_init(&nx_match, 0);
2852 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2854 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2857 /* Convert nx_match to match. */
2860 error = oxm_pull_match(&nx_match, &match);
2862 error = nx_pull_match(&nx_match, match_len, &match,
2863 &cookie, &cookie_mask);
2867 error = oxm_pull_match_loose(&nx_match, &match);
2869 error = nx_pull_match_loose(&nx_match, match_len, &match,
2870 &cookie, &cookie_mask);
2878 /* Convert match back to nx_match. */
2879 ofpbuf_uninit(&nx_match);
2880 ofpbuf_init(&nx_match, 0);
2882 match_len = oxm_put_match(&nx_match, &match, version);
2883 out = oxm_match_to_string(&nx_match, match_len);
2885 match_len = nx_put_match(&nx_match, &match,
2886 cookie, cookie_mask);
2887 out = nx_match_to_string(ofpbuf_data(&nx_match), match_len);
2893 printf("nx_pull_match() returned error %s\n",
2894 ofperr_get_name(error));
2897 ofpbuf_uninit(&nx_match);
2902 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2903 * stdin, does some internal fussing with them, and then prints them back as
2904 * strings on stdout. */
2906 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2908 return ofctl_parse_nxm__(false, 0);
2911 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
2912 * strings from stdin, does some internal fussing with them, and then prints
2913 * them back as strings on stdout. VERSION must specify an OpenFlow version,
2914 * e.g. "OpenFlow12". */
2916 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[])
2918 enum ofp_version version = ofputil_version_from_string(argv[1]);
2919 if (version < OFP12_VERSION) {
2920 ovs_fatal(0, "%s: not a valid version for OXM", argv[1]);
2923 return ofctl_parse_nxm__(true, version);
2927 print_differences(const char *prefix,
2928 const void *a_, size_t a_len,
2929 const void *b_, size_t b_len)
2931 const uint8_t *a = a_;
2932 const uint8_t *b = b_;
2935 for (i = 0; i < MIN(a_len, b_len); i++) {
2937 printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
2938 prefix, i, a[i], b[i]);
2941 for (i = a_len; i < b_len; i++) {
2942 printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2944 for (i = b_len; i < a_len; i++) {
2945 printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2949 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2950 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2951 * on stdout, and then converts them back to hex bytes and prints any
2952 * differences from the input. */
2954 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2959 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2960 struct ofpbuf of10_out;
2961 struct ofpbuf of10_in;
2962 struct ofpbuf ofpacts;
2967 /* Parse hex bytes. */
2968 ofpbuf_init(&of10_in, 0);
2969 if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2970 ovs_fatal(0, "Trailing garbage in hex data");
2973 /* Convert to ofpacts. */
2974 ofpbuf_init(&ofpacts, 0);
2975 size = ofpbuf_size(&of10_in);
2976 error = ofpacts_pull_openflow_actions(&of10_in, ofpbuf_size(&of10_in),
2977 OFP10_VERSION, &ofpacts);
2979 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2980 ofpbuf_uninit(&ofpacts);
2981 ofpbuf_uninit(&of10_in);
2984 ofpbuf_push_uninit(&of10_in, size);
2986 /* Print cls_rule. */
2988 ds_put_cstr(&s, "actions=");
2989 ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
2993 /* Convert back to ofp10 actions and print differences from input. */
2994 ofpbuf_init(&of10_out, 0);
2995 ofpacts_put_openflow_actions(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &of10_out,
2998 print_differences("", ofpbuf_data(&of10_in), ofpbuf_size(&of10_in),
2999 ofpbuf_data(&of10_out), ofpbuf_size(&of10_out));
3002 ofpbuf_uninit(&ofpacts);
3003 ofpbuf_uninit(&of10_in);
3004 ofpbuf_uninit(&of10_out);
3009 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3010 * bytes from stdin, converts them to cls_rules, prints them as strings on
3011 * stdout, and then converts them back to hex bytes and prints any differences
3014 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3015 * values are ignored in the input and will be set to zero when OVS converts
3016 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
3017 * it does the conversion to hex, to ensure that in fact they are ignored. */
3019 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3026 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3027 struct ofpbuf match_in, match_expout;
3028 struct ofp10_match match_out;
3029 struct ofp10_match match_normal;
3033 /* Parse hex bytes to use for expected output. */
3035 ds_put_cstr(&expout, ds_cstr(&in));
3036 for (p = ds_cstr(&expout); *p; p++) {
3041 ofpbuf_init(&match_expout, 0);
3042 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3043 ovs_fatal(0, "Trailing garbage in hex data");
3045 if (ofpbuf_size(&match_expout) != sizeof(struct ofp10_match)) {
3046 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3047 ofpbuf_size(&match_expout), sizeof(struct ofp10_match));
3050 /* Parse hex bytes for input. */
3051 for (p = ds_cstr(&in); *p; p++) {
3053 *p = "0123456789abcdef"[random_uint32() & 0xf];
3056 ofpbuf_init(&match_in, 0);
3057 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3058 ovs_fatal(0, "Trailing garbage in hex data");
3060 if (ofpbuf_size(&match_in) != sizeof(struct ofp10_match)) {
3061 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3062 ofpbuf_size(&match_in), sizeof(struct ofp10_match));
3065 /* Convert to cls_rule and print. */
3066 ofputil_match_from_ofp10_match(ofpbuf_data(&match_in), &match);
3067 match_print(&match);
3069 /* Convert back to ofp10_match and print differences from input. */
3070 ofputil_match_to_ofp10_match(&match, &match_out);
3071 print_differences("", ofpbuf_data(&match_expout), ofpbuf_size(&match_expout),
3072 &match_out, sizeof match_out);
3074 /* Normalize, then convert and compare again. */
3075 ofputil_normalize_match(&match);
3076 ofputil_match_to_ofp10_match(&match, &match_normal);
3077 print_differences("normal: ", &match_out, sizeof match_out,
3078 &match_normal, sizeof match_normal);
3081 ofpbuf_uninit(&match_in);
3082 ofpbuf_uninit(&match_expout);
3085 ds_destroy(&expout);
3088 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3089 * bytes from stdin, converts them to "struct match"es, prints them as strings
3090 * on stdout, and then converts them back to hex bytes and prints any
3091 * differences from the input. */
3093 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3098 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3099 struct ofpbuf match_in;
3100 struct ofp11_match match_out;
3104 /* Parse hex bytes. */
3105 ofpbuf_init(&match_in, 0);
3106 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3107 ovs_fatal(0, "Trailing garbage in hex data");
3109 if (ofpbuf_size(&match_in) != sizeof(struct ofp11_match)) {
3110 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3111 ofpbuf_size(&match_in), sizeof(struct ofp11_match));
3114 /* Convert to match. */
3115 error = ofputil_match_from_ofp11_match(ofpbuf_data(&match_in), &match);
3117 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3118 ofpbuf_uninit(&match_in);
3123 match_print(&match);
3125 /* Convert back to ofp11_match and print differences from input. */
3126 ofputil_match_to_ofp11_match(&match, &match_out);
3128 print_differences("", ofpbuf_data(&match_in), ofpbuf_size(&match_in),
3129 &match_out, sizeof match_out);
3132 ofpbuf_uninit(&match_in);
3137 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
3138 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
3139 * on stdout, and then converts them back to hex bytes and prints any
3140 * differences from the input. */
3142 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3147 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3148 struct ofpbuf of11_out;
3149 struct ofpbuf of11_in;
3150 struct ofpbuf ofpacts;
3155 /* Parse hex bytes. */
3156 ofpbuf_init(&of11_in, 0);
3157 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
3158 ovs_fatal(0, "Trailing garbage in hex data");
3161 /* Convert to ofpacts. */
3162 ofpbuf_init(&ofpacts, 0);
3163 size = ofpbuf_size(&of11_in);
3164 error = ofpacts_pull_openflow_actions(&of11_in, ofpbuf_size(&of11_in),
3165 OFP11_VERSION, &ofpacts);
3167 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
3168 ofpbuf_uninit(&ofpacts);
3169 ofpbuf_uninit(&of11_in);
3172 ofpbuf_push_uninit(&of11_in, size);
3174 /* Print cls_rule. */
3176 ds_put_cstr(&s, "actions=");
3177 ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
3181 /* Convert back to ofp11 actions and print differences from input. */
3182 ofpbuf_init(&of11_out, 0);
3183 ofpacts_put_openflow_actions(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &of11_out,
3186 print_differences("", ofpbuf_data(&of11_in), ofpbuf_size(&of11_in),
3187 ofpbuf_data(&of11_out), ofpbuf_size(&of11_out));
3190 ofpbuf_uninit(&ofpacts);
3191 ofpbuf_uninit(&of11_in);
3192 ofpbuf_uninit(&of11_out);
3197 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
3198 * specifications as hex bytes from stdin, converts them to ofpacts, prints
3199 * them as strings on stdout, and then converts them back to hex bytes and
3200 * prints any differences from the input. */
3202 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3207 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3208 struct ofpbuf of11_out;
3209 struct ofpbuf of11_in;
3210 struct ofpbuf ofpacts;
3214 const char *table_id;
3217 /* Parse table_id separated with the follow-up instructions by ",", if
3219 instructions = ds_cstr(&in);
3221 if (strstr(instructions, ",")) {
3222 table_id = strsep(&instructions, ",");
3225 /* Parse hex bytes. */
3226 ofpbuf_init(&of11_in, 0);
3227 if (ofpbuf_put_hex(&of11_in, instructions, NULL)[0] != '\0') {
3228 ovs_fatal(0, "Trailing garbage in hex data");
3231 /* Convert to ofpacts. */
3232 ofpbuf_init(&ofpacts, 0);
3233 size = ofpbuf_size(&of11_in);
3234 error = ofpacts_pull_openflow_instructions(&of11_in, ofpbuf_size(&of11_in),
3235 OFP11_VERSION, &ofpacts);
3237 /* Verify actions, enforce consistency. */
3239 memset(&flow, 0, sizeof flow);
3240 error = ofpacts_check_consistency(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts),
3242 table_id ? atoi(table_id) : 0,
3243 255, OFPUTIL_P_OF11_STD);
3246 printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
3247 ofpbuf_uninit(&ofpacts);
3248 ofpbuf_uninit(&of11_in);
3251 ofpbuf_push_uninit(&of11_in, size);
3253 /* Print cls_rule. */
3255 ds_put_cstr(&s, "actions=");
3256 ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
3260 /* Convert back to ofp11 instructions and print differences from
3262 ofpbuf_init(&of11_out, 0);
3263 ofpacts_put_openflow_instructions(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts),
3264 &of11_out, OFP13_VERSION);
3266 print_differences("", ofpbuf_data(&of11_in), ofpbuf_size(&of11_in),
3267 ofpbuf_data(&of11_out), ofpbuf_size(&of11_out));
3270 ofpbuf_uninit(&ofpacts);
3271 ofpbuf_uninit(&of11_in);
3272 ofpbuf_uninit(&of11_out);
3277 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3279 ofctl_parse_pcap(int argc OVS_UNUSED, char *argv[])
3283 pcap = ovs_pcap_open(argv[1], "rb");
3285 ovs_fatal(errno, "%s: open failed", argv[1]);
3289 struct ofpbuf *packet;
3291 const struct pkt_metadata md = PKT_METADATA_INITIALIZER(ODPP_NONE);
3294 error = ovs_pcap_read(pcap, &packet, NULL);
3298 ovs_fatal(error, "%s: read failed", argv[1]);
3301 flow_extract(packet, &md, &flow);
3302 flow_print(stdout, &flow);
3304 ofpbuf_delete(packet);
3308 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3309 * mask values to and from various formats and prints the results. */
3311 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
3316 struct ofputil_flow_mod fm;
3319 struct match nxm_match;
3323 struct ofp10_match of10_raw;
3324 struct match of10_match;
3326 struct ofp11_match of11_raw;
3327 struct match of11_match;
3332 enum ofputil_protocol usable_protocols; /* Unused for now. */
3334 match_init_catchall(&match);
3335 match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
3336 match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
3338 /* Convert to and from string. */
3339 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3340 printf("%s -> ", string_s);
3342 error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3344 ovs_fatal(0, "%s", error_s);
3346 printf("%04"PRIx16"/%04"PRIx16"\n",
3347 ntohs(fm.match.flow.vlan_tci),
3348 ntohs(fm.match.wc.masks.vlan_tci));
3351 /* Convert to and from NXM. */
3352 ofpbuf_init(&nxm, 0);
3353 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3354 nxm_s = nx_match_to_string(ofpbuf_data(&nxm), nxm_match_len);
3355 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3356 printf("NXM: %s -> ", nxm_s);
3358 printf("%s\n", ofperr_to_string(error));
3360 printf("%04"PRIx16"/%04"PRIx16"\n",
3361 ntohs(nxm_match.flow.vlan_tci),
3362 ntohs(nxm_match.wc.masks.vlan_tci));
3365 ofpbuf_uninit(&nxm);
3367 /* Convert to and from OXM. */
3368 ofpbuf_init(&nxm, 0);
3369 nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3370 nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3371 error = oxm_pull_match(&nxm, &nxm_match);
3372 printf("OXM: %s -> ", nxm_s);
3374 printf("%s\n", ofperr_to_string(error));
3376 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3377 (VLAN_VID_MASK | VLAN_CFI);
3378 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3379 (VLAN_VID_MASK | VLAN_CFI);
3381 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3382 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3383 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3389 ofpbuf_uninit(&nxm);
3391 /* Convert to and from OpenFlow 1.0. */
3392 ofputil_match_to_ofp10_match(&match, &of10_raw);
3393 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3394 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3395 ntohs(of10_raw.dl_vlan),
3396 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3397 of10_raw.dl_vlan_pcp,
3398 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3399 ntohs(of10_match.flow.vlan_tci),
3400 ntohs(of10_match.wc.masks.vlan_tci));
3402 /* Convert to and from OpenFlow 1.1. */
3403 ofputil_match_to_ofp11_match(&match, &of11_raw);
3404 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3405 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3406 ntohs(of11_raw.dl_vlan),
3407 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3408 of11_raw.dl_vlan_pcp,
3409 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3410 ntohs(of11_match.flow.vlan_tci),
3411 ntohs(of11_match.wc.masks.vlan_tci));
3414 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3417 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
3422 error = ofperr_from_name(argv[1]);
3424 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3427 for (version = 0; version <= UINT8_MAX; version++) {
3428 const char *name = ofperr_domain_get_name(version);
3430 int vendor = ofperr_get_vendor(error, version);
3431 int type = ofperr_get_type(error, version);
3432 int code = ofperr_get_code(error, version);
3434 if (vendor != -1 || type != -1 || code != -1) {
3435 printf("%s: vendor %#x, type %d, code %d\n",
3436 name, vendor, type, code);
3442 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3443 * error named ENUM and prints the error reply in hex. */
3445 ofctl_encode_error_reply(int argc OVS_UNUSED, char *argv[])
3447 const struct ofp_header *oh;
3448 struct ofpbuf request, *reply;
3451 error = ofperr_from_name(argv[1]);
3453 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3456 ofpbuf_init(&request, 0);
3457 if (ofpbuf_put_hex(&request, argv[2], NULL)[0] != '\0') {
3458 ovs_fatal(0, "Trailing garbage in hex data");
3460 if (ofpbuf_size(&request) < sizeof(struct ofp_header)) {
3461 ovs_fatal(0, "Request too short");
3464 oh = ofpbuf_data(&request);
3465 if (ofpbuf_size(&request) != ntohs(oh->length)) {
3466 ovs_fatal(0, "Request size inconsistent");
3469 reply = ofperr_encode_reply(error, ofpbuf_data(&request));
3470 ofpbuf_uninit(&request);
3472 ovs_hex_dump(stdout, ofpbuf_data(reply), ofpbuf_size(reply), 0, false);
3473 ofpbuf_delete(reply);
3476 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3477 * binary data, interpreting them as an OpenFlow message, and prints the
3478 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
3480 ofctl_ofp_print(int argc, char *argv[])
3482 struct ofpbuf packet;
3484 ofpbuf_init(&packet, strlen(argv[1]) / 2);
3485 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
3486 ovs_fatal(0, "trailing garbage following hex bytes");
3488 ofp_print(stdout, ofpbuf_data(&packet), ofpbuf_size(&packet), argc > 2 ? atoi(argv[2]) : 2);
3489 ofpbuf_uninit(&packet);
3492 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3493 * and dumps each message in hex. */
3495 ofctl_encode_hello(int argc OVS_UNUSED, char *argv[])
3497 uint32_t bitmap = strtol(argv[1], NULL, 0);
3498 struct ofpbuf *hello;
3500 hello = ofputil_encode_hello(bitmap);
3501 ovs_hex_dump(stdout, ofpbuf_data(hello), ofpbuf_size(hello), 0, false);
3502 ofp_print(stdout, ofpbuf_data(hello), ofpbuf_size(hello), verbosity);
3503 ofpbuf_delete(hello);
3506 static const struct command all_commands[] = {
3507 { "show", 1, 1, ofctl_show },
3508 { "monitor", 1, 3, ofctl_monitor },
3509 { "snoop", 1, 1, ofctl_snoop },
3510 { "dump-desc", 1, 1, ofctl_dump_desc },
3511 { "dump-tables", 1, 1, ofctl_dump_tables },
3512 { "dump-table-features", 1, 1, ofctl_dump_table_features },
3513 { "dump-flows", 1, 2, ofctl_dump_flows },
3514 { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
3515 { "queue-stats", 1, 3, ofctl_queue_stats },
3516 { "queue-get-config", 2, 2, ofctl_queue_get_config },
3517 { "add-flow", 2, 2, ofctl_add_flow },
3518 { "add-flows", 2, 2, ofctl_add_flows },
3519 { "mod-flows", 2, 2, ofctl_mod_flows },
3520 { "del-flows", 1, 2, ofctl_del_flows },
3521 { "replace-flows", 2, 2, ofctl_replace_flows },
3522 { "diff-flows", 2, 2, ofctl_diff_flows },
3523 { "add-meter", 2, 2, ofctl_add_meter },
3524 { "mod-meter", 2, 2, ofctl_mod_meter },
3525 { "del-meter", 2, 2, ofctl_del_meters },
3526 { "del-meters", 1, 1, ofctl_del_meters },
3527 { "dump-meter", 2, 2, ofctl_dump_meters },
3528 { "dump-meters", 1, 1, ofctl_dump_meters },
3529 { "meter-stats", 1, 2, ofctl_meter_stats },
3530 { "meter-features", 1, 1, ofctl_meter_features },
3531 { "packet-out", 4, INT_MAX, ofctl_packet_out },
3532 { "dump-ports", 1, 2, ofctl_dump_ports },
3533 { "dump-ports-desc", 1, 2, ofctl_dump_ports_desc },
3534 { "mod-port", 3, 3, ofctl_mod_port },
3535 { "mod-table", 3, 3, ofctl_mod_table },
3536 { "get-frags", 1, 1, ofctl_get_frags },
3537 { "set-frags", 2, 2, ofctl_set_frags },
3538 { "probe", 1, 1, ofctl_probe },
3539 { "ping", 1, 2, ofctl_ping },
3540 { "benchmark", 3, 3, ofctl_benchmark },
3542 { "ofp-parse", 1, 1, ofctl_ofp_parse },
3543 { "ofp-parse-pcap", 1, INT_MAX, ofctl_ofp_parse_pcap },
3545 { "add-group", 1, 2, ofctl_add_group },
3546 { "add-groups", 1, 2, ofctl_add_groups },
3547 { "mod-group", 1, 2, ofctl_mod_group },
3548 { "del-groups", 1, 2, ofctl_del_groups },
3549 { "dump-groups", 1, 2, ofctl_dump_group_desc },
3550 { "dump-group-stats", 1, 2, ofctl_dump_group_stats },
3551 { "dump-group-features", 1, 1, ofctl_dump_group_features },
3552 { "help", 0, INT_MAX, ofctl_help },
3554 /* Undocumented commands for testing. */
3555 { "parse-flow", 1, 1, ofctl_parse_flow },
3556 { "parse-flows", 1, 1, ofctl_parse_flows },
3557 { "parse-nx-match", 0, 0, ofctl_parse_nxm },
3558 { "parse-nxm", 0, 0, ofctl_parse_nxm },
3559 { "parse-oxm", 1, 1, ofctl_parse_oxm },
3560 { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
3561 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
3562 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
3563 { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
3564 { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
3565 { "parse-pcap", 1, 1, ofctl_parse_pcap },
3566 { "check-vlan", 2, 2, ofctl_check_vlan },
3567 { "print-error", 1, 1, ofctl_print_error },
3568 { "encode-error-reply", 2, 2, ofctl_encode_error_reply },
3569 { "ofp-print", 1, 2, ofctl_ofp_print },
3570 { "encode-hello", 1, 1, ofctl_encode_hello },
3572 { NULL, 0, 0, NULL },
3575 static const struct command *get_all_commands(void)
3577 return all_commands;