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 service_start(&argc, &argv);
121 parse_options(argc, argv);
122 fatal_ignore_sigpipe();
123 run_command(argc - optind, argv + optind, get_all_commands());
128 add_sort_criterion(enum sort_order order, const char *field)
130 struct sort_criterion *sc;
132 if (n_criteria >= allocated_criteria) {
133 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
136 sc = &criteria[n_criteria++];
137 if (!field || !strcasecmp(field, "priority")) {
140 sc->field = mf_from_name(field);
142 ovs_fatal(0, "%s: unknown field name", field);
149 parse_options(int argc, char *argv[])
152 OPT_STRICT = UCHAR_MAX + 1,
159 OFP_VERSION_OPTION_ENUMS,
162 static const struct option long_options[] = {
163 {"timeout", required_argument, NULL, 't'},
164 {"strict", no_argument, NULL, OPT_STRICT},
165 {"readd", no_argument, NULL, OPT_READD},
166 {"flow-format", required_argument, NULL, 'F'},
167 {"packet-in-format", required_argument, NULL, 'P'},
168 {"more", no_argument, NULL, 'm'},
169 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
170 {"sort", optional_argument, NULL, OPT_SORT},
171 {"rsort", optional_argument, NULL, OPT_RSORT},
172 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
173 {"help", no_argument, NULL, 'h'},
175 OFP_VERSION_LONG_OPTIONS,
177 STREAM_SSL_LONG_OPTIONS,
180 char *short_options = long_options_to_short_options(long_options);
182 enum ofputil_protocol version_protocols;
184 /* For now, ovs-ofctl only enables OpenFlow 1.0 by default. This is
185 * because ovs-ofctl implements command such as "add-flow" as raw OpenFlow
186 * requests, but those requests have subtly different semantics in
187 * different OpenFlow versions. For example:
189 * - In OpenFlow 1.0, a "mod-flow" operation that does not find any
190 * existing flow to modify adds a new flow.
192 * - In OpenFlow 1.1, a "mod-flow" operation that does not find any
193 * existing flow to modify adds a new flow, but only if the mod-flow
194 * did not match on the flow cookie.
196 * - In OpenFlow 1.2 and a later, a "mod-flow" operation never adds a
199 set_allowed_ofp_versions("OpenFlow10");
202 unsigned long int timeout;
205 c = getopt_long(argc, argv, short_options, long_options, NULL);
212 timeout = strtoul(optarg, NULL, 10);
214 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
222 allowed_protocols = ofputil_protocols_from_string(optarg);
223 if (!allowed_protocols) {
224 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
229 preferred_packet_in_format =
230 ofputil_packet_in_format_from_string(optarg);
231 if (preferred_packet_in_format < 0) {
232 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
256 add_sort_criterion(SORT_ASC, optarg);
260 add_sort_criterion(SORT_DESC, optarg);
264 unixctl_path = optarg;
267 DAEMON_OPTION_HANDLERS
268 OFP_VERSION_OPTION_HANDLERS
270 STREAM_SSL_OPTION_HANDLERS
281 /* Always do a final sort pass based on priority. */
282 add_sort_criterion(SORT_DESC, "priority");
287 versions = get_allowed_ofp_versions();
288 version_protocols = ofputil_protocols_from_version_bitmap(versions);
289 if (!(allowed_protocols & version_protocols)) {
290 char *protocols = ofputil_protocols_to_string(allowed_protocols);
291 struct ds version_s = DS_EMPTY_INITIALIZER;
293 ofputil_format_version_bitmap_names(&version_s, versions);
294 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
295 "any of the enabled flow formats (%s). (Use -O to enable "
296 "additional OpenFlow versions or -F to enable additional "
297 "flow formats.)", ds_cstr(&version_s), protocols);
299 allowed_protocols &= version_protocols;
300 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
307 printf("%s: OpenFlow switch management utility\n"
308 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
309 "\nFor OpenFlow switches:\n"
310 " show SWITCH show OpenFlow information\n"
311 " dump-desc SWITCH print switch description\n"
312 " dump-tables SWITCH print table stats\n"
313 " dump-table-features SWITCH print table features\n"
314 " mod-port SWITCH IFACE ACT modify port behavior\n"
315 " mod-table SWITCH MOD modify flow table behavior\n"
316 " get-frags SWITCH print fragment handling behavior\n"
317 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
318 " dump-ports SWITCH [PORT] print port statistics\n"
319 " dump-ports-desc SWITCH [PORT] print port descriptions\n"
320 " dump-flows SWITCH print all flow entries\n"
321 " dump-flows SWITCH FLOW print matching FLOWs\n"
322 " dump-aggregate SWITCH print aggregate flow statistics\n"
323 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
324 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
325 " add-flow SWITCH FLOW add flow described by FLOW\n"
326 " add-flows SWITCH FILE add flows from FILE\n"
327 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
328 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
329 " replace-flows SWITCH FILE replace flows with those in FILE\n"
330 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
331 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
332 " execute ACTIONS on PACKET\n"
333 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
334 " print packets received from SWITCH\n"
335 " snoop SWITCH snoop on SWITCH and its controller\n"
336 " add-group SWITCH GROUP add group described by GROUP\n"
337 " add-group SWITCH FILE add group from FILE\n"
338 " mod-group SWITCH GROUP modify specific group\n"
339 " del-groups SWITCH [GROUP] delete matching GROUPs\n"
340 " dump-group-features SWITCH print group features\n"
341 " dump-groups SWITCH [GROUP] print group description\n"
342 " dump-group-stats SWITCH [GROUP] print group statistics\n"
343 " queue-get-config SWITCH PORT print queue information for port\n"
344 " add-meter SWITCH METER add meter described by METER\n"
345 " mod-meter SWITCH METER modify specific METER\n"
346 " del-meter SWITCH METER delete METER\n"
347 " del-meters SWITCH delete all meters\n"
348 " dump-meter SWITCH METER print METER configuration\n"
349 " dump-meters SWITCH print all meter configuration\n"
350 " meter-stats SWITCH [METER] print meter statistics\n"
351 " meter-features SWITCH print meter features\n"
352 "\nFor OpenFlow switches and controllers:\n"
353 " probe TARGET probe whether TARGET is up\n"
354 " ping TARGET [N] latency of N-byte echos\n"
355 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
356 "SWITCH or TARGET is an active OpenFlow connection method.\n"
357 "\nOther commands:\n"
358 " ofp-parse FILE print messages read from FILE\n"
359 " ofp-parse-pcap PCAP print OpenFlow read from PCAP\n",
360 program_name, program_name);
361 vconn_usage(true, false, false);
365 printf("\nOther options:\n"
366 " --strict use strict match for flow commands\n"
367 " --readd replace flows that haven't changed\n"
368 " -F, --flow-format=FORMAT force particular flow format\n"
369 " -P, --packet-in-format=FRMT force particular packet in format\n"
370 " -m, --more be more verbose printing OpenFlow\n"
371 " --timestamp (monitor, snoop) print timestamps\n"
372 " -t, --timeout=SECS give up after SECS seconds\n"
373 " --sort[=field] sort in ascending order\n"
374 " --rsort[=field] sort in descending order\n"
375 " --unixctl=SOCKET set control socket name\n"
376 " -h, --help display this help message\n"
377 " -V, --version display version information\n");
382 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
383 const char *argv[] OVS_UNUSED, void *exiting_)
385 bool *exiting = exiting_;
387 unixctl_command_reply(conn, NULL);
390 static void run(int retval, const char *message, ...)
394 run(int retval, const char *message, ...)
399 va_start(args, message);
400 ovs_fatal_valist(retval, message, args);
404 /* Generic commands. */
407 open_vconn_socket(const char *name, struct vconn **vconnp)
409 char *vconn_name = xasprintf("unix:%s", name);
412 error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
414 if (error && error != ENOENT) {
415 ovs_fatal(0, "%s: failed to open socket (%s)", name,
416 ovs_strerror(error));
423 enum open_target { MGMT, SNOOP };
425 static enum ofputil_protocol
426 open_vconn__(const char *name, enum open_target target,
427 struct vconn **vconnp)
429 const char *suffix = target == MGMT ? "mgmt" : "snoop";
430 char *datapath_name, *datapath_type, *socket_name;
431 enum ofputil_protocol protocol;
436 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
438 ofproto_parse_name(name, &datapath_name, &datapath_type);
439 socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
443 if (strchr(name, ':')) {
444 run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
445 "connecting to %s", name);
446 } else if (!open_vconn_socket(name, vconnp)) {
448 } else if (!open_vconn_socket(bridge_path, vconnp)) {
450 } else if (!open_vconn_socket(socket_name, vconnp)) {
453 ovs_fatal(0, "%s is not a bridge or a socket", name);
456 if (target == SNOOP) {
457 vconn_set_recv_any_version(*vconnp);
463 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
464 error = vconn_connect_block(*vconnp);
466 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
467 ovs_strerror(error));
470 ofp_version = vconn_get_version(*vconnp);
471 protocol = ofputil_protocol_from_ofp_version(ofp_version);
473 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
479 static enum ofputil_protocol
480 open_vconn(const char *name, struct vconn **vconnp)
482 return open_vconn__(name, MGMT, vconnp);
486 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
488 ofpmsg_update_length(buffer);
489 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
493 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
495 struct ofpbuf *reply;
497 ofpmsg_update_length(request);
498 run(vconn_transact(vconn, request, &reply), "talking to %s",
499 vconn_get_name(vconn));
500 ofp_print(stdout, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 1);
501 ofpbuf_delete(reply);
505 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
507 struct ofpbuf *request;
510 open_vconn(vconn_name, &vconn);
511 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
512 dump_transaction(vconn, request);
517 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
519 const struct ofp_header *request_oh = ofpbuf_data(request);
520 ovs_be32 send_xid = request_oh->xid;
521 enum ofpraw request_raw;
522 enum ofpraw reply_raw;
525 ofpraw_decode_partial(&request_raw, ofpbuf_data(request), ofpbuf_size(request));
526 reply_raw = ofpraw_stats_request_to_reply(request_raw,
527 request_oh->version);
529 send_openflow_buffer(vconn, request);
532 struct ofpbuf *reply;
534 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
535 recv_xid = ((struct ofp_header *) ofpbuf_data(reply))->xid;
536 if (send_xid == recv_xid) {
539 ofp_print(stdout, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 1);
541 ofpraw_decode(&raw, ofpbuf_data(reply));
542 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
544 } else if (raw == reply_raw) {
545 done = !ofpmp_more(ofpbuf_data(reply));
547 ovs_fatal(0, "received bad reply: %s",
548 ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
552 VLOG_DBG("received reply with xid %08"PRIx32" "
553 "!= expected %08"PRIx32, recv_xid, send_xid);
555 ofpbuf_delete(reply);
560 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
562 struct ofpbuf *request;
565 open_vconn(vconn_name, &vconn);
566 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
567 dump_stats_transaction(vconn, request);
571 /* Sends all of the 'requests', which should be requests that only have replies
572 * if an error occurs, and waits for them to succeed or fail. If an error does
573 * occur, prints it and exits with an error.
575 * Destroys all of the 'requests'. */
577 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
579 struct ofpbuf *request, *reply;
581 LIST_FOR_EACH (request, list_node, requests) {
582 ofpmsg_update_length(request);
585 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
586 "talking to %s", vconn_get_name(vconn));
588 ofp_print(stderr, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 2);
591 ofpbuf_delete(reply);
594 /* Sends 'request', which should be a request that only has a reply if an error
595 * occurs, and waits for it to succeed or fail. If an error does occur, prints
596 * it and exits with an error.
598 * Destroys 'request'. */
600 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
602 struct list requests;
604 list_init(&requests);
605 list_push_back(&requests, &request->list_node);
606 transact_multiple_noreply(vconn, &requests);
610 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
612 struct ofp_switch_config *config;
613 struct ofpbuf *request;
614 struct ofpbuf *reply;
617 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
618 vconn_get_version(vconn), 0);
619 run(vconn_transact(vconn, request, &reply),
620 "talking to %s", vconn_get_name(vconn));
622 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
623 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
626 config = ofpbuf_pull(reply, sizeof *config);
629 ofpbuf_delete(reply);
633 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
635 struct ofpbuf *request;
637 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
638 ofpbuf_put(request, config, sizeof *config);
640 transact_noreply(vconn, request);
644 ofctl_show(int argc OVS_UNUSED, char *argv[])
646 const char *vconn_name = argv[1];
647 enum ofp_version version;
649 struct ofpbuf *request;
650 struct ofpbuf *reply;
653 open_vconn(vconn_name, &vconn);
654 version = vconn_get_version(vconn);
655 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, version, 0);
656 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
658 has_ports = ofputil_switch_features_has_ports(reply);
659 ofp_print(stdout, ofpbuf_data(reply), ofpbuf_size(reply), verbosity + 1);
660 ofpbuf_delete(reply);
663 request = ofputil_encode_port_desc_stats_request(version, OFPP_ANY);
664 dump_stats_transaction(vconn, request);
666 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
671 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
673 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
677 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
679 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
683 ofctl_dump_table_features(int argc OVS_UNUSED, char *argv[])
685 struct ofpbuf *request;
688 open_vconn(argv[1], &vconn);
689 request = ofputil_encode_table_features_request(vconn_get_version(vconn));
691 dump_stats_transaction(vconn, request);
697 static bool fetch_port_by_stats(struct vconn *,
698 const char *port_name, ofp_port_t port_no,
699 struct ofputil_phy_port *);
701 /* Uses OFPT_FEATURES_REQUEST to attempt to fetch information about the port
702 * named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
703 * successful, false on failure.
705 * This is only appropriate for OpenFlow 1.0, 1.1, and 1.2, which include a
706 * list of ports in OFPT_FEATURES_REPLY. */
708 fetch_port_by_features(struct vconn *vconn,
709 const char *port_name, ofp_port_t port_no,
710 struct ofputil_phy_port *pp)
712 struct ofputil_switch_features features;
713 const struct ofp_header *oh;
714 struct ofpbuf *request, *reply;
720 /* Fetch the switch's ofp_switch_features. */
721 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
722 vconn_get_version(vconn), 0);
723 run(vconn_transact(vconn, request, &reply),
724 "talking to %s", vconn_get_name(vconn));
726 oh = ofpbuf_data(reply);
727 if (ofptype_decode(&type, ofpbuf_data(reply))
728 || type != OFPTYPE_FEATURES_REPLY) {
729 ovs_fatal(0, "%s: received bad features reply", vconn_get_name(vconn));
731 if (!ofputil_switch_features_has_ports(reply)) {
732 /* The switch features reply does not contain a complete list of ports.
733 * Probably, there are more ports than will fit into a single 64 kB
734 * OpenFlow message. Use OFPST_PORT_DESC to get a complete list of
736 ofpbuf_delete(reply);
737 return fetch_port_by_stats(vconn, port_name, port_no, pp);
740 error = ofputil_decode_switch_features(oh, &features, &b);
742 ovs_fatal(0, "%s: failed to decode features reply (%s)",
743 vconn_get_name(vconn), ofperr_to_string(error));
746 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
747 if (port_no != OFPP_NONE
748 ? port_no == pp->port_no
749 : !strcmp(pp->name, port_name)) {
754 ofpbuf_delete(reply);
758 /* Uses a OFPST_PORT_DESC request to attempt to fetch information about the
759 * port named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
760 * successful, false on failure.
762 * This is most appropriate for OpenFlow 1.3 and later. Open vSwitch 1.7 and
763 * later also implements OFPST_PORT_DESC, as an extension, for OpenFlow 1.0,
764 * 1.1, and 1.2, so this can be used as a fallback in those versions when there
765 * are too many ports than fit in an OFPT_FEATURES_REPLY. */
767 fetch_port_by_stats(struct vconn *vconn,
768 const char *port_name, ofp_port_t port_no,
769 struct ofputil_phy_port *pp)
771 struct ofpbuf *request;
776 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
778 send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
780 send_openflow_buffer(vconn, request);
783 struct ofpbuf *reply;
785 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
786 recv_xid = ((struct ofp_header *) ofpbuf_data(reply))->xid;
787 if (send_xid == recv_xid) {
788 struct ofp_header *oh = ofpbuf_data(reply);
793 ofpbuf_use_const(&b, oh, ntohs(oh->length));
794 if (ofptype_pull(&type, &b)
795 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
796 ovs_fatal(0, "received bad reply: %s",
797 ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
801 flags = ofpmp_flags(oh);
802 done = !(flags & OFPSF_REPLY_MORE);
805 /* We've already found the port, but we need to drain
806 * the queue of any other replies for this request. */
810 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
811 if (port_no != OFPP_NONE ? port_no == pp->port_no
812 : !strcmp(pp->name, port_name)) {
818 VLOG_DBG("received reply with xid %08"PRIx32" "
819 "!= expected %08"PRIx32, recv_xid, send_xid);
821 ofpbuf_delete(reply);
828 str_to_ofp(const char *s, ofp_port_t *ofp_port)
833 ret = str_to_uint(s, 10, &port_);
834 *ofp_port = u16_to_ofp(port_);
838 /* Opens a connection to 'vconn_name', fetches the port structure for
839 * 'port_name' (which may be a port name or number), and copies it into
842 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
843 struct ofputil_phy_port *pp)
849 /* Try to interpret the argument as a port number. */
850 if (!str_to_ofp(port_name, &port_no)) {
854 /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
855 * OFPT_FEATURES_REPLY message. OpenFlow 1.3 and later versions put it
856 * into the OFPST_PORT_DESC reply. Try it the correct way. */
857 open_vconn(vconn_name, &vconn);
858 found = (vconn_get_version(vconn) < OFP13_VERSION
859 ? fetch_port_by_features(vconn, port_name, port_no, pp)
860 : fetch_port_by_stats(vconn, port_name, port_no, pp));
864 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
868 /* Returns the port number corresponding to 'port_name' (which may be a port
869 * name or number) within the switch 'vconn_name'. */
871 str_to_port_no(const char *vconn_name, const char *port_name)
875 if (ofputil_port_from_string(port_name, &port_no)) {
878 struct ofputil_phy_port pp;
880 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
886 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
887 enum ofputil_protocol *cur)
890 struct ofpbuf *request, *reply;
891 enum ofputil_protocol next;
893 request = ofputil_encode_set_protocol(*cur, want, &next);
898 run(vconn_transact_noreply(vconn, request, &reply),
899 "talking to %s", vconn_get_name(vconn));
901 char *s = ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply), 2);
902 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
903 vconn_get_name(vconn), s);
905 ofpbuf_delete(reply);
913 static enum ofputil_protocol
914 set_protocol_for_flow_dump(struct vconn *vconn,
915 enum ofputil_protocol cur_protocol,
916 enum ofputil_protocol usable_protocols)
921 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
922 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
923 if (f & usable_protocols & allowed_protocols
924 && try_set_protocol(vconn, f, &cur_protocol)) {
929 usable_s = ofputil_protocols_to_string(usable_protocols);
930 if (usable_protocols & allowed_protocols) {
931 ovs_fatal(0, "switch does not support any of the usable flow "
932 "formats (%s)", usable_s);
934 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
935 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
936 "allowed flow formats (%s)", usable_s, allowed_s);
940 static struct vconn *
941 prepare_dump_flows(int argc, char *argv[], bool aggregate,
942 struct ofpbuf **requestp)
944 enum ofputil_protocol usable_protocols, protocol;
945 struct ofputil_flow_stats_request fsr;
949 error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
950 argc > 2 ? argv[2] : "",
953 ovs_fatal(0, "%s", error);
956 protocol = open_vconn(argv[1], &vconn);
957 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
958 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
963 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
965 struct ofpbuf *request;
968 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
969 dump_stats_transaction(vconn, request);
974 compare_flows(const void *afs_, const void *bfs_)
976 const struct ofputil_flow_stats *afs = afs_;
977 const struct ofputil_flow_stats *bfs = bfs_;
978 const struct match *a = &afs->match;
979 const struct match *b = &bfs->match;
980 const struct sort_criterion *sc;
982 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
983 const struct mf_field *f = sc->field;
987 unsigned int a_pri = afs->priority;
988 unsigned int b_pri = bfs->priority;
989 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
993 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
994 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
996 /* Skip the test for sc->order, so that missing fields always
997 * sort to the end whether we're sorting in ascending or
998 * descending order. */
1001 union mf_value aval, bval;
1003 mf_get_value(f, &a->flow, &aval);
1004 mf_get_value(f, &b->flow, &bval);
1005 ret = memcmp(&aval, &bval, f->n_bytes);
1010 return sc->order == SORT_ASC ? ret : -ret;
1018 ofctl_dump_flows(int argc, char *argv[])
1021 ofctl_dump_flows__(argc, argv, false);
1024 struct ofputil_flow_stats *fses;
1025 size_t n_fses, allocated_fses;
1026 struct ofpbuf *request;
1027 struct ofpbuf ofpacts;
1028 struct ofpbuf *reply;
1029 struct vconn *vconn;
1034 vconn = prepare_dump_flows(argc, argv, false, &request);
1035 send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
1036 send_openflow_buffer(vconn, request);
1039 n_fses = allocated_fses = 0;
1041 ofpbuf_init(&ofpacts, 0);
1043 struct ofputil_flow_stats *fs;
1045 if (n_fses >= allocated_fses) {
1046 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
1050 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
1054 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1057 ofpbuf_uninit(&ofpacts);
1059 qsort(fses, n_fses, sizeof *fses, compare_flows);
1062 for (i = 0; i < n_fses; i++) {
1064 ofp_print_flow_stats(&s, &fses[i]);
1069 for (i = 0; i < n_fses; i++) {
1070 free(CONST_CAST(struct ofpact *, fses[i].ofpacts));
1079 ofctl_dump_aggregate(int argc, char *argv[])
1081 ofctl_dump_flows__(argc, argv, true);
1085 ofctl_queue_stats(int argc, char *argv[])
1087 struct ofpbuf *request;
1088 struct vconn *vconn;
1089 struct ofputil_queue_stats_request oqs;
1091 open_vconn(argv[1], &vconn);
1093 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
1094 oqs.port_no = str_to_port_no(argv[1], argv[2]);
1096 oqs.port_no = OFPP_ANY;
1098 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
1099 oqs.queue_id = atoi(argv[3]);
1101 oqs.queue_id = OFPQ_ALL;
1104 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1105 dump_stats_transaction(vconn, request);
1110 ofctl_queue_get_config(int argc OVS_UNUSED, char *argv[])
1112 const char *vconn_name = argv[1];
1113 const char *port_name = argv[2];
1114 enum ofputil_protocol protocol;
1115 enum ofp_version version;
1116 struct ofpbuf *request;
1117 struct vconn *vconn;
1120 port = str_to_port_no(vconn_name, port_name);
1122 protocol = open_vconn(vconn_name, &vconn);
1123 version = ofputil_protocol_to_ofp_version(protocol);
1124 request = ofputil_encode_queue_get_config_request(version, port);
1125 dump_transaction(vconn, request);
1129 static enum ofputil_protocol
1130 open_vconn_for_flow_mod(const char *remote, struct vconn **vconnp,
1131 enum ofputil_protocol usable_protocols)
1133 enum ofputil_protocol cur_protocol;
1137 if (!(usable_protocols & allowed_protocols)) {
1138 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1139 usable_s = ofputil_protocols_to_string(usable_protocols);
1140 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1141 "allowed flow formats (%s)", usable_s, allowed_s);
1144 /* If the initial flow format is allowed and usable, keep it. */
1145 cur_protocol = open_vconn(remote, vconnp);
1146 if (usable_protocols & allowed_protocols & cur_protocol) {
1147 return cur_protocol;
1150 /* Otherwise try each flow format in turn. */
1151 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1152 enum ofputil_protocol f = 1 << i;
1154 if (f != cur_protocol
1155 && f & usable_protocols & allowed_protocols
1156 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1161 usable_s = ofputil_protocols_to_string(usable_protocols);
1162 ovs_fatal(0, "switch does not support any of the usable flow "
1163 "formats (%s)", usable_s);
1167 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1168 size_t n_fms, enum ofputil_protocol usable_protocols)
1170 enum ofputil_protocol protocol;
1171 struct vconn *vconn;
1174 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1176 for (i = 0; i < n_fms; i++) {
1177 struct ofputil_flow_mod *fm = &fms[i];
1179 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1180 free(CONST_CAST(struct ofpact *, fm->ofpacts));
1186 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1188 enum ofputil_protocol usable_protocols;
1189 struct ofputil_flow_mod *fms = NULL;
1193 error = parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms,
1196 ovs_fatal(0, "%s", error);
1198 ofctl_flow_mod__(argv[1], fms, n_fms, usable_protocols);
1203 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1205 if (argc > 2 && !strcmp(argv[2], "-")) {
1206 ofctl_flow_mod_file(argc, argv, command);
1208 struct ofputil_flow_mod fm;
1210 enum ofputil_protocol usable_protocols;
1212 error = parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command,
1215 ovs_fatal(0, "%s", error);
1217 ofctl_flow_mod__(argv[1], &fm, 1, usable_protocols);
1222 ofctl_add_flow(int argc, char *argv[])
1224 ofctl_flow_mod(argc, argv, OFPFC_ADD);
1228 ofctl_add_flows(int argc, char *argv[])
1230 ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1234 ofctl_mod_flows(int argc, char *argv[])
1236 ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1240 ofctl_del_flows(int argc, char *argv[])
1242 ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1246 set_packet_in_format(struct vconn *vconn,
1247 enum nx_packet_in_format packet_in_format)
1249 struct ofpbuf *spif;
1251 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1253 transact_noreply(vconn, spif);
1254 VLOG_DBG("%s: using user-specified packet in format %s",
1255 vconn_get_name(vconn),
1256 ofputil_packet_in_format_to_string(packet_in_format));
1260 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1262 struct ofp_switch_config config;
1263 enum ofp_config_flags flags;
1265 fetch_switch_config(vconn, &config);
1266 flags = ntohs(config.flags);
1267 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1268 /* Set the invalid ttl config. */
1269 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1271 config.flags = htons(flags);
1272 set_switch_config(vconn, &config);
1274 /* Then retrieve the configuration to see if it really took. OpenFlow
1275 * doesn't define error reporting for bad modes, so this is all we can
1277 fetch_switch_config(vconn, &config);
1278 flags = ntohs(config.flags);
1279 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1280 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1281 "switch probably doesn't support mode)");
1288 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1289 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1290 * an error message and stores NULL in '*msgp'. */
1292 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1294 struct ofp_header *oh;
1297 msg = ofpbuf_new(strlen(hex) / 2);
1300 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1302 return "Trailing garbage in hex data";
1305 if (ofpbuf_size(msg) < sizeof(struct ofp_header)) {
1307 return "Message too short for OpenFlow";
1310 oh = ofpbuf_data(msg);
1311 if (ofpbuf_size(msg) != ntohs(oh->length)) {
1313 return "Message size does not match length in OpenFlow header";
1321 ofctl_send(struct unixctl_conn *conn, int argc,
1322 const char *argv[], void *vconn_)
1324 struct vconn *vconn = vconn_;
1331 for (i = 1; i < argc; i++) {
1332 const char *error_msg;
1336 error_msg = openflow_from_hex(argv[i], &msg);
1338 ds_put_format(&reply, "%s\n", error_msg);
1343 fprintf(stderr, "send: ");
1344 ofp_print(stderr, ofpbuf_data(msg), ofpbuf_size(msg), verbosity);
1346 error = vconn_send_block(vconn, msg);
1349 ds_put_format(&reply, "%s\n", ovs_strerror(error));
1352 ds_put_cstr(&reply, "sent\n");
1357 unixctl_command_reply(conn, ds_cstr(&reply));
1359 unixctl_command_reply_error(conn, ds_cstr(&reply));
1364 struct barrier_aux {
1365 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1366 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1370 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1371 const char *argv[] OVS_UNUSED, void *aux_)
1373 struct barrier_aux *aux = aux_;
1378 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1382 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1383 error = vconn_send_block(aux->vconn, msg);
1386 unixctl_command_reply_error(conn, ovs_strerror(error));
1393 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1394 const char *argv[], void *aux OVS_UNUSED)
1398 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1400 unixctl_command_reply_error(conn, ovs_strerror(errno));
1405 dup2(fd, STDERR_FILENO);
1407 unixctl_command_reply(conn, NULL);
1411 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1412 const char *argv[] OVS_UNUSED, void *blocked_)
1414 bool *blocked = blocked_;
1418 unixctl_command_reply(conn, NULL);
1420 unixctl_command_reply(conn, "already blocking");
1425 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1426 const char *argv[] OVS_UNUSED, void *blocked_)
1428 bool *blocked = blocked_;
1432 unixctl_command_reply(conn, NULL);
1434 unixctl_command_reply(conn, "already unblocked");
1438 /* Prints to stdout all of the messages received on 'vconn'.
1440 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1441 * received on 'vconn'. */
1443 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1445 struct barrier_aux barrier_aux = { vconn, NULL };
1446 struct unixctl_server *server;
1447 bool exiting = false;
1448 bool blocked = false;
1451 daemon_save_fd(STDERR_FILENO);
1453 error = unixctl_server_create(unixctl_path, &server);
1455 ovs_fatal(error, "failed to create unixctl server");
1457 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1458 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1460 unixctl_command_register("ofctl/barrier", "", 0, 0,
1461 ofctl_barrier, &barrier_aux);
1462 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1463 ofctl_set_output_file, NULL);
1465 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1466 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1469 daemonize_complete();
1475 unixctl_server_run(server);
1480 retval = vconn_recv(vconn, &b);
1481 if (retval == EAGAIN) {
1484 run(retval, "vconn_recv");
1487 char *s = xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1488 time_wall_msec(), true);
1493 ofptype_decode(&type, ofpbuf_data(b));
1494 ofp_print(stderr, ofpbuf_data(b), ofpbuf_size(b), verbosity + 2);
1497 switch ((int) type) {
1498 case OFPTYPE_BARRIER_REPLY:
1499 if (barrier_aux.conn) {
1500 unixctl_command_reply(barrier_aux.conn, NULL);
1501 barrier_aux.conn = NULL;
1505 case OFPTYPE_ECHO_REQUEST:
1506 if (reply_to_echo_requests) {
1507 struct ofpbuf *reply;
1509 reply = make_echo_reply(ofpbuf_data(b));
1510 retval = vconn_send_block(vconn, reply);
1512 ovs_fatal(retval, "failed to send echo reply");
1525 vconn_run_wait(vconn);
1527 vconn_recv_wait(vconn);
1529 unixctl_server_wait(server);
1533 unixctl_server_destroy(server);
1537 ofctl_monitor(int argc, char *argv[])
1539 struct vconn *vconn;
1541 enum ofputil_protocol usable_protocols;
1543 open_vconn(argv[1], &vconn);
1544 for (i = 2; i < argc; i++) {
1545 const char *arg = argv[i];
1547 if (isdigit((unsigned char) *arg)) {
1548 struct ofp_switch_config config;
1550 fetch_switch_config(vconn, &config);
1551 config.miss_send_len = htons(atoi(arg));
1552 set_switch_config(vconn, &config);
1553 } else if (!strcmp(arg, "invalid_ttl")) {
1554 monitor_set_invalid_ttl_to_controller(vconn);
1555 } else if (!strncmp(arg, "watch:", 6)) {
1556 struct ofputil_flow_monitor_request fmr;
1560 error = parse_flow_monitor_request(&fmr, arg + 6,
1563 ovs_fatal(0, "%s", error);
1566 msg = ofpbuf_new(0);
1567 ofputil_append_flow_monitor_request(&fmr, msg);
1568 dump_stats_transaction(vconn, msg);
1571 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1575 if (preferred_packet_in_format >= 0) {
1576 set_packet_in_format(vconn, preferred_packet_in_format);
1578 enum ofp_version version = vconn_get_version(vconn);
1581 case OFP10_VERSION: {
1582 struct ofpbuf *spif, *reply;
1584 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1586 run(vconn_transact_noreply(vconn, spif, &reply),
1587 "talking to %s", vconn_get_name(vconn));
1589 char *s = ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply), 2);
1590 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1591 " replied: %s. Falling back to the switch default.",
1592 vconn_get_name(vconn), s);
1594 ofpbuf_delete(reply);
1609 monitor_vconn(vconn, true);
1613 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1615 struct vconn *vconn;
1617 open_vconn__(argv[1], SNOOP, &vconn);
1618 monitor_vconn(vconn, false);
1622 ofctl_dump_ports(int argc, char *argv[])
1624 struct ofpbuf *request;
1625 struct vconn *vconn;
1628 open_vconn(argv[1], &vconn);
1629 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1630 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1631 dump_stats_transaction(vconn, request);
1636 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1638 struct ofpbuf *request;
1639 struct vconn *vconn;
1642 open_vconn(argv[1], &vconn);
1643 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1644 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
1646 dump_stats_transaction(vconn, request);
1651 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1653 struct ofpbuf *request;
1654 struct vconn *vconn;
1655 struct ofpbuf *reply;
1657 open_vconn(argv[1], &vconn);
1658 request = make_echo_request(vconn_get_version(vconn));
1659 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1660 if (ofpbuf_size(reply) != sizeof(struct ofp_header)) {
1661 ovs_fatal(0, "reply does not match request");
1663 ofpbuf_delete(reply);
1668 ofctl_packet_out(int argc, char *argv[])
1670 enum ofputil_protocol protocol;
1671 struct ofputil_packet_out po;
1672 struct ofpbuf ofpacts;
1673 struct vconn *vconn;
1676 enum ofputil_protocol usable_protocols; /* XXX: Use in proto selection */
1678 ofpbuf_init(&ofpacts, 64);
1679 error = ofpacts_parse_actions(argv[3], &ofpacts, &usable_protocols);
1681 ovs_fatal(0, "%s", error);
1684 po.buffer_id = UINT32_MAX;
1685 po.in_port = str_to_port_no(argv[1], argv[2]);
1686 po.ofpacts = ofpbuf_data(&ofpacts);
1687 po.ofpacts_len = ofpbuf_size(&ofpacts);
1689 protocol = open_vconn(argv[1], &vconn);
1690 for (i = 4; i < argc; i++) {
1691 struct ofpbuf *packet, *opo;
1692 const char *error_msg;
1694 error_msg = eth_from_hex(argv[i], &packet);
1696 ovs_fatal(0, "%s", error_msg);
1699 po.packet = ofpbuf_data(packet);
1700 po.packet_len = ofpbuf_size(packet);
1701 opo = ofputil_encode_packet_out(&po, protocol);
1702 transact_noreply(vconn, opo);
1703 ofpbuf_delete(packet);
1706 ofpbuf_uninit(&ofpacts);
1710 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1712 struct ofp_config_flag {
1713 const char *name; /* The flag's name. */
1714 enum ofputil_port_config bit; /* Bit to turn on or off. */
1715 bool on; /* Value to set the bit to. */
1717 static const struct ofp_config_flag flags[] = {
1718 { "up", OFPUTIL_PC_PORT_DOWN, false },
1719 { "down", OFPUTIL_PC_PORT_DOWN, true },
1720 { "stp", OFPUTIL_PC_NO_STP, false },
1721 { "receive", OFPUTIL_PC_NO_RECV, false },
1722 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1723 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1724 { "forward", OFPUTIL_PC_NO_FWD, false },
1725 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1728 const struct ofp_config_flag *flag;
1729 enum ofputil_protocol protocol;
1730 struct ofputil_port_mod pm;
1731 struct ofputil_phy_port pp;
1732 struct vconn *vconn;
1733 const char *command;
1736 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1738 pm.port_no = pp.port_no;
1739 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1744 if (!strncasecmp(argv[3], "no-", 3)) {
1745 command = argv[3] + 3;
1747 } else if (!strncasecmp(argv[3], "no", 2)) {
1748 command = argv[3] + 2;
1754 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1755 if (!strcasecmp(command, flag->name)) {
1756 pm.mask = flag->bit;
1757 pm.config = flag->on ^ not ? flag->bit : 0;
1761 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1764 protocol = open_vconn(argv[1], &vconn);
1765 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1770 ofctl_mod_table(int argc OVS_UNUSED, char *argv[])
1772 enum ofputil_protocol protocol, usable_protocols;
1773 struct ofputil_table_mod tm;
1774 struct vconn *vconn;
1778 error = parse_ofp_table_mod(&tm, argv[2], argv[3], &usable_protocols);
1780 ovs_fatal(0, "%s", error);
1783 protocol = open_vconn(argv[1], &vconn);
1784 if (!(protocol & usable_protocols)) {
1785 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1786 enum ofputil_protocol f = 1 << i;
1788 && f & usable_protocols
1789 && try_set_protocol(vconn, f, &protocol)) {
1796 if (!(protocol & usable_protocols)) {
1797 char *usable_s = ofputil_protocols_to_string(usable_protocols);
1798 ovs_fatal(0, "Switch does not support table mod message(%s)", usable_s);
1801 transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
1806 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1808 struct ofp_switch_config config;
1809 struct vconn *vconn;
1811 open_vconn(argv[1], &vconn);
1812 fetch_switch_config(vconn, &config);
1813 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1818 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1820 struct ofp_switch_config config;
1821 enum ofp_config_flags mode;
1822 struct vconn *vconn;
1825 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1826 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1829 open_vconn(argv[1], &vconn);
1830 fetch_switch_config(vconn, &config);
1831 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1832 if (flags != config.flags) {
1833 /* Set the configuration. */
1834 config.flags = flags;
1835 set_switch_config(vconn, &config);
1837 /* Then retrieve the configuration to see if it really took. OpenFlow
1838 * doesn't define error reporting for bad modes, so this is all we can
1840 fetch_switch_config(vconn, &config);
1841 if (flags != config.flags) {
1842 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1843 "switch probably doesn't support mode \"%s\")",
1844 argv[1], ofputil_frag_handling_to_string(mode));
1851 ofctl_ofp_parse(int argc OVS_UNUSED, char *argv[])
1853 const char *filename = argv[1];
1857 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1859 ovs_fatal(errno, "%s: open", filename);
1862 ofpbuf_init(&b, 65536);
1864 struct ofp_header *oh;
1865 size_t length, tail_len;
1870 oh = ofpbuf_put_uninit(&b, sizeof *oh);
1871 n = fread(oh, 1, sizeof *oh, file);
1874 } else if (n < sizeof *oh) {
1875 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1878 length = ntohs(oh->length);
1879 if (length < sizeof *oh) {
1880 ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
1884 tail_len = length - sizeof *oh;
1885 tail = ofpbuf_put_uninit(&b, tail_len);
1886 n = fread(tail, 1, tail_len, file);
1888 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1891 ofp_print(stdout, ofpbuf_data(&b), ofpbuf_size(&b), verbosity + 2);
1895 if (file != stdin) {
1901 is_openflow_port(ovs_be16 port_, char *ports[])
1903 uint16_t port = ntohs(port_);
1907 for (i = 0; ports[i]; i++) {
1908 if (port == atoi(ports[i])) {
1914 return port == OFP_PORT || port == OFP_OLD_PORT;
1919 ofctl_ofp_parse_pcap(int argc OVS_UNUSED, char *argv[])
1921 struct tcp_reader *reader;
1926 file = ovs_pcap_open(argv[1], "rb");
1928 ovs_fatal(errno, "%s: open failed", argv[1]);
1931 reader = tcp_reader_open();
1934 struct ofpbuf *packet;
1937 const struct pkt_metadata md = PKT_METADATA_INITIALIZER(ODPP_NONE);
1939 error = ovs_pcap_read(file, &packet, &when);
1943 flow_extract(packet, &md, &flow);
1944 if (flow.dl_type == htons(ETH_TYPE_IP)
1945 && flow.nw_proto == IPPROTO_TCP
1946 && (is_openflow_port(flow.tp_src, argv + 2) ||
1947 is_openflow_port(flow.tp_dst, argv + 2))) {
1948 struct ofpbuf *payload = tcp_reader_run(reader, &flow, packet);
1950 while (ofpbuf_size(payload) >= sizeof(struct ofp_header)) {
1951 const struct ofp_header *oh;
1952 void *data = ofpbuf_data(payload);
1955 /* Align OpenFlow on 8-byte boundary for safe access. */
1956 ofpbuf_shift(payload, -((intptr_t) data & 7));
1958 oh = ofpbuf_data(payload);
1959 length = ntohs(oh->length);
1960 if (ofpbuf_size(payload) < length) {
1970 char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
1975 printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
1976 IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
1977 IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
1978 ofp_print(stdout, ofpbuf_data(payload), length, verbosity + 1);
1979 ofpbuf_pull(payload, length);
1983 ofpbuf_delete(packet);
1985 tcp_reader_close(reader);
1989 ofctl_ping(int argc, char *argv[])
1991 size_t max_payload = 65535 - sizeof(struct ofp_header);
1992 unsigned int payload;
1993 struct vconn *vconn;
1996 payload = argc > 2 ? atoi(argv[2]) : 64;
1997 if (payload > max_payload) {
1998 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2001 open_vconn(argv[1], &vconn);
2002 for (i = 0; i < 10; i++) {
2003 struct timeval start, end;
2004 struct ofpbuf *request, *reply;
2005 const struct ofp_header *rpy_hdr;
2008 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2009 vconn_get_version(vconn), payload);
2010 random_bytes(ofpbuf_put_uninit(request, payload), payload);
2012 xgettimeofday(&start);
2013 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2014 xgettimeofday(&end);
2016 rpy_hdr = ofpbuf_data(reply);
2017 if (ofptype_pull(&type, reply)
2018 || type != OFPTYPE_ECHO_REPLY
2019 || ofpbuf_size(reply) != payload
2020 || memcmp(ofpbuf_l3(request), ofpbuf_l3(reply), payload)) {
2021 printf("Reply does not match request. Request:\n");
2022 ofp_print(stdout, request, ofpbuf_size(request), verbosity + 2);
2024 ofp_print(stdout, reply, ofpbuf_size(reply), verbosity + 2);
2026 printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2027 ofpbuf_size(reply), argv[1], ntohl(rpy_hdr->xid),
2028 (1000*(double)(end.tv_sec - start.tv_sec))
2029 + (.001*(end.tv_usec - start.tv_usec)));
2030 ofpbuf_delete(request);
2031 ofpbuf_delete(reply);
2037 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
2039 size_t max_payload = 65535 - sizeof(struct ofp_header);
2040 struct timeval start, end;
2041 unsigned int payload_size, message_size;
2042 struct vconn *vconn;
2047 payload_size = atoi(argv[2]);
2048 if (payload_size > max_payload) {
2049 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2051 message_size = sizeof(struct ofp_header) + payload_size;
2053 count = atoi(argv[3]);
2055 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2056 count, message_size, count * message_size);
2058 open_vconn(argv[1], &vconn);
2059 xgettimeofday(&start);
2060 for (i = 0; i < count; i++) {
2061 struct ofpbuf *request, *reply;
2063 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2064 vconn_get_version(vconn), payload_size);
2065 ofpbuf_put_zeros(request, payload_size);
2066 run(vconn_transact(vconn, request, &reply), "transact");
2067 ofpbuf_delete(reply);
2069 xgettimeofday(&end);
2072 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2073 + (.001*(end.tv_usec - start.tv_usec)));
2074 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2075 duration, count / (duration / 1000.0),
2076 count * message_size / (duration / 1000.0));
2080 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2083 struct ofputil_group_mod *gm;
2084 struct ofpbuf *request;
2086 struct vconn *vconn;
2089 open_vconn(remote, &vconn);
2091 for (i = 0; i < n_gms; i++) {
2093 request = ofputil_encode_group_mod(vconn_get_version(vconn), gm);
2095 transact_noreply(vconn, request);
2105 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2107 struct ofputil_group_mod *gms = NULL;
2108 enum ofputil_protocol usable_protocols;
2112 error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2115 ovs_fatal(0, "%s", error);
2117 ofctl_group_mod__(argv[1], gms, n_gms);
2122 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2124 if (argc > 2 && !strcmp(argv[2], "-")) {
2125 ofctl_group_mod_file(argc, argv, command);
2127 enum ofputil_protocol usable_protocols;
2128 struct ofputil_group_mod gm;
2131 error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2134 ovs_fatal(0, "%s", error);
2136 ofctl_group_mod__(argv[1], &gm, 1);
2141 ofctl_add_group(int argc, char *argv[])
2143 ofctl_group_mod(argc, argv, OFPGC11_ADD);
2147 ofctl_add_groups(int argc, char *argv[])
2149 ofctl_group_mod_file(argc, argv, OFPGC11_ADD);
2153 ofctl_mod_group(int argc, char *argv[])
2155 ofctl_group_mod(argc, argv, OFPGC11_MODIFY);
2159 ofctl_del_groups(int argc, char *argv[])
2161 ofctl_group_mod(argc, argv, OFPGC11_DELETE);
2165 ofctl_dump_group_stats(int argc, char *argv[])
2167 enum ofputil_protocol usable_protocols;
2168 struct ofputil_group_mod gm;
2169 struct ofpbuf *request;
2170 struct vconn *vconn;
2174 memset(&gm, 0, sizeof gm);
2176 error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2177 argc > 2 ? argv[2] : "",
2180 ovs_fatal(0, "%s", error);
2183 group_id = gm.group_id;
2185 open_vconn(argv[1], &vconn);
2186 request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2189 dump_stats_transaction(vconn, request);
2196 ofctl_dump_group_desc(int argc OVS_UNUSED, char *argv[])
2198 struct ofpbuf *request;
2199 struct vconn *vconn;
2202 open_vconn(argv[1], &vconn);
2204 if (argc < 3 || !ofputil_group_from_string(argv[2], &group_id)) {
2205 group_id = OFPG11_ALL;
2208 request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2211 dump_stats_transaction(vconn, request);
2218 ofctl_dump_group_features(int argc OVS_UNUSED, char *argv[])
2220 struct ofpbuf *request;
2221 struct vconn *vconn;
2223 open_vconn(argv[1], &vconn);
2224 request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2226 dump_stats_transaction(vconn, request);
2233 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2238 /* replace-flows and diff-flows commands. */
2240 /* A flow table entry, possibly with two different versions. */
2242 struct cls_rule rule; /* Within a "struct classifier". */
2243 struct fte_version *versions[2];
2246 /* One version of a Flow Table Entry. */
2247 struct fte_version {
2249 uint16_t idle_timeout;
2250 uint16_t hard_timeout;
2252 struct ofpact *ofpacts;
2256 /* Frees 'version' and the data that it owns. */
2258 fte_version_free(struct fte_version *version)
2261 free(CONST_CAST(struct ofpact *, version->ofpacts));
2266 /* Returns true if 'a' and 'b' are the same, false if they differ.
2268 * Ignores differences in 'flags' because there's no way to retrieve flags from
2269 * an OpenFlow switch. We have to assume that they are the same. */
2271 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2273 return (a->cookie == b->cookie
2274 && a->idle_timeout == b->idle_timeout
2275 && a->hard_timeout == b->hard_timeout
2276 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2277 b->ofpacts, b->ofpacts_len));
2280 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2281 * 'index' into 's', followed by a new-line. */
2283 fte_version_format(const struct fte *fte, int index, struct ds *s)
2285 const struct fte_version *version = fte->versions[index];
2292 cls_rule_format(&fte->rule, s);
2293 if (version->cookie != htonll(0)) {
2294 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2296 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2297 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2299 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2300 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2303 ds_put_cstr(s, " actions=");
2304 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2306 ds_put_char(s, '\n');
2310 fte_from_cls_rule(const struct cls_rule *cls_rule)
2312 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2315 /* Frees 'fte' and its versions. */
2317 fte_free(struct fte *fte)
2320 fte_version_free(fte->versions[0]);
2321 fte_version_free(fte->versions[1]);
2322 cls_rule_destroy(&fte->rule);
2327 /* Frees all of the FTEs within 'cls'. */
2329 fte_free_all(struct classifier *cls)
2333 CLS_FOR_EACH_SAFE (fte, rule, cls) {
2334 classifier_remove(cls, &fte->rule);
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 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
2357 fte_version_free(old->versions[index]);
2358 fte->versions[!index] = old->versions[!index];
2359 cls_rule_destroy(&old->rule);
2364 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
2365 * with the specified 'index'. Returns the flow formats able to represent the
2366 * flows that were read. */
2367 static enum ofputil_protocol
2368 read_flows_from_file(const char *filename, struct classifier *cls, int index)
2370 enum ofputil_protocol usable_protocols;
2375 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2377 ovs_fatal(errno, "%s: open", filename);
2381 usable_protocols = OFPUTIL_P_ANY;
2383 while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2384 struct fte_version *version;
2385 struct ofputil_flow_mod fm;
2387 enum ofputil_protocol usable;
2389 error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2391 ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2393 usable_protocols &= usable;
2395 version = xmalloc(sizeof *version);
2396 version->cookie = fm.new_cookie;
2397 version->idle_timeout = fm.idle_timeout;
2398 version->hard_timeout = fm.hard_timeout;
2399 version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2400 | OFPUTIL_FF_EMERG);
2401 version->ofpacts = fm.ofpacts;
2402 version->ofpacts_len = fm.ofpacts_len;
2404 fte_insert(cls, &fm.match, fm.priority, version, index);
2408 if (file != stdin) {
2412 return usable_protocols;
2416 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2417 struct ofpbuf **replyp,
2418 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2420 struct ofpbuf *reply = *replyp;
2426 /* Get a flow stats reply message, if we don't already have one. */
2432 run(vconn_recv_block(vconn, &reply),
2433 "OpenFlow packet receive failed");
2434 } while (((struct ofp_header *) ofpbuf_data(reply))->xid != send_xid);
2436 error = ofptype_decode(&type, ofpbuf_data(reply));
2437 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2438 ovs_fatal(0, "received bad reply: %s",
2439 ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
2444 /* Pull an individual flow stats reply out of the message. */
2445 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2452 more = ofpmp_more(reply->frame);
2453 ofpbuf_delete(reply);
2462 ovs_fatal(0, "parse error in reply (%s)",
2463 ofperr_to_string(retval));
2468 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2469 * format 'protocol', and adds them as flow table entries in 'cls' for the
2470 * version with the specified 'index'. */
2472 read_flows_from_switch(struct vconn *vconn,
2473 enum ofputil_protocol protocol,
2474 struct classifier *cls, int index)
2476 struct ofputil_flow_stats_request fsr;
2477 struct ofputil_flow_stats fs;
2478 struct ofpbuf *request;
2479 struct ofpbuf ofpacts;
2480 struct ofpbuf *reply;
2483 fsr.aggregate = false;
2484 match_init_catchall(&fsr.match);
2485 fsr.out_port = OFPP_ANY;
2486 fsr.table_id = 0xff;
2487 fsr.cookie = fsr.cookie_mask = htonll(0);
2488 request = ofputil_encode_flow_stats_request(&fsr, protocol);
2489 send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
2490 send_openflow_buffer(vconn, request);
2493 ofpbuf_init(&ofpacts, 0);
2494 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2495 struct fte_version *version;
2497 version = xmalloc(sizeof *version);
2498 version->cookie = fs.cookie;
2499 version->idle_timeout = fs.idle_timeout;
2500 version->hard_timeout = fs.hard_timeout;
2502 version->ofpacts_len = fs.ofpacts_len;
2503 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2505 fte_insert(cls, &fs.match, fs.priority, version, index);
2507 ofpbuf_uninit(&ofpacts);
2511 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2512 enum ofputil_protocol protocol, struct list *packets)
2514 const struct fte_version *version = fte->versions[index];
2515 struct ofputil_flow_mod fm;
2518 minimatch_expand(&fte->rule.match, &fm.match);
2519 fm.priority = fte->rule.priority;
2520 fm.cookie = htonll(0);
2521 fm.cookie_mask = htonll(0);
2522 fm.new_cookie = version->cookie;
2523 fm.modify_cookie = true;
2525 fm.command = command;
2526 fm.idle_timeout = version->idle_timeout;
2527 fm.hard_timeout = version->hard_timeout;
2528 fm.buffer_id = UINT32_MAX;
2529 fm.out_port = OFPP_ANY;
2530 fm.flags = version->flags;
2531 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2532 command == OFPFC_MODIFY_STRICT) {
2533 fm.ofpacts = version->ofpacts;
2534 fm.ofpacts_len = version->ofpacts_len;
2539 fm.delete_reason = OFPRR_DELETE;
2541 ofm = ofputil_encode_flow_mod(&fm, protocol);
2542 list_push_back(packets, &ofm->list_node);
2546 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
2548 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2549 enum ofputil_protocol usable_protocols, protocol;
2550 struct classifier cls;
2551 struct list requests;
2552 struct vconn *vconn;
2555 classifier_init(&cls, NULL);
2556 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2558 protocol = open_vconn(argv[1], &vconn);
2559 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2561 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2563 list_init(&requests);
2565 /* Delete flows that exist on the switch but not in the file. */
2566 CLS_FOR_EACH (fte, rule, &cls) {
2567 struct fte_version *file_ver = fte->versions[FILE_IDX];
2568 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2570 if (sw_ver && !file_ver) {
2571 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2572 protocol, &requests);
2576 /* Add flows that exist in the file but not on the switch.
2577 * Update flows that exist in both places but differ. */
2578 CLS_FOR_EACH (fte, rule, &cls) {
2579 struct fte_version *file_ver = fte->versions[FILE_IDX];
2580 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2583 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2584 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2587 transact_multiple_noreply(vconn, &requests);
2594 read_flows_from_source(const char *source, struct classifier *cls, int index)
2598 if (source[0] == '/' || source[0] == '.'
2599 || (!strchr(source, ':') && !stat(source, &s))) {
2600 read_flows_from_file(source, cls, index);
2602 enum ofputil_protocol protocol;
2603 struct vconn *vconn;
2605 protocol = open_vconn(source, &vconn);
2606 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2607 read_flows_from_switch(vconn, protocol, cls, index);
2613 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2615 bool differences = false;
2616 struct classifier cls;
2620 classifier_init(&cls, NULL);
2621 read_flows_from_source(argv[1], &cls, 0);
2622 read_flows_from_source(argv[2], &cls, 1);
2627 CLS_FOR_EACH (fte, rule, &cls) {
2628 struct fte_version *a = fte->versions[0];
2629 struct fte_version *b = fte->versions[1];
2631 if (!a || !b || !fte_version_equals(a, b)) {
2632 fte_version_format(fte, 0, &a_s);
2633 fte_version_format(fte, 1, &b_s);
2634 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2636 printf("-%s", ds_cstr(&a_s));
2639 printf("+%s", ds_cstr(&b_s));
2657 ofctl_meter_mod__(const char *bridge, const char *str, int command)
2659 struct ofputil_meter_mod mm;
2660 struct vconn *vconn;
2661 enum ofputil_protocol protocol;
2662 enum ofputil_protocol usable_protocols;
2663 enum ofp_version version;
2667 error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
2669 ovs_fatal(0, "%s", error);
2672 usable_protocols = OFPUTIL_P_OF13_UP;
2673 mm.command = command;
2674 mm.meter.meter_id = OFPM13_ALL;
2677 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2678 version = ofputil_protocol_to_ofp_version(protocol);
2679 transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
2684 ofctl_meter_request__(const char *bridge, const char *str,
2685 enum ofputil_meter_request_type type)
2687 struct ofputil_meter_mod mm;
2688 struct vconn *vconn;
2689 enum ofputil_protocol usable_protocols;
2690 enum ofputil_protocol protocol;
2691 enum ofp_version version;
2695 error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
2697 ovs_fatal(0, "%s", error);
2700 usable_protocols = OFPUTIL_P_OF13_UP;
2701 mm.meter.meter_id = OFPM13_ALL;
2704 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2705 version = ofputil_protocol_to_ofp_version(protocol);
2706 transact_noreply(vconn, ofputil_encode_meter_request(version,
2708 mm.meter.meter_id));
2714 ofctl_add_meter(int argc OVS_UNUSED, char *argv[])
2716 ofctl_meter_mod__(argv[1], argv[2], OFPMC13_ADD);
2720 ofctl_mod_meter(int argc OVS_UNUSED, char *argv[])
2722 ofctl_meter_mod__(argv[1], argv[2], OFPMC13_MODIFY);
2726 ofctl_del_meters(int argc, char *argv[])
2728 ofctl_meter_mod__(argv[1], argc > 2 ? argv[2] : NULL, OFPMC13_DELETE);
2732 ofctl_dump_meters(int argc, char *argv[])
2734 ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2735 OFPUTIL_METER_CONFIG);
2739 ofctl_meter_stats(int argc, char *argv[])
2741 ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2742 OFPUTIL_METER_STATS);
2746 ofctl_meter_features(int argc OVS_UNUSED, char *argv[])
2748 ofctl_meter_request__(argv[1], NULL, OFPUTIL_METER_FEATURES);
2752 /* Undocumented commands for unit testing. */
2755 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
2756 enum ofputil_protocol usable_protocols)
2758 enum ofputil_protocol protocol = 0;
2762 usable_s = ofputil_protocols_to_string(usable_protocols);
2763 printf("usable protocols: %s\n", usable_s);
2766 if (!(usable_protocols & allowed_protocols)) {
2767 ovs_fatal(0, "no usable protocol");
2769 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2771 if (protocol & usable_protocols & allowed_protocols) {
2775 ovs_assert(is_pow2(protocol));
2777 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2779 for (i = 0; i < n_fms; i++) {
2780 struct ofputil_flow_mod *fm = &fms[i];
2783 msg = ofputil_encode_flow_mod(fm, protocol);
2784 ofp_print(stdout, ofpbuf_data(msg), ofpbuf_size(msg), verbosity);
2787 free(CONST_CAST(struct ofpact *, fm->ofpacts));
2791 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2792 * it back to stdout. */
2794 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2796 enum ofputil_protocol usable_protocols;
2797 struct ofputil_flow_mod fm;
2800 error = parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, &usable_protocols);
2802 ovs_fatal(0, "%s", error);
2804 ofctl_parse_flows__(&fm, 1, usable_protocols);
2807 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2808 * add-flows) and prints each of the flows back to stdout. */
2810 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2812 enum ofputil_protocol usable_protocols;
2813 struct ofputil_flow_mod *fms = NULL;
2817 error = parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms,
2820 ovs_fatal(0, "%s", error);
2822 ofctl_parse_flows__(fms, n_fms, usable_protocols);
2827 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
2832 while (!ds_get_test_line(&in, stdin)) {
2833 struct ofpbuf nx_match;
2835 ovs_be64 cookie, cookie_mask;
2839 /* Convert string to nx_match. */
2840 ofpbuf_init(&nx_match, 0);
2842 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2844 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2847 /* Convert nx_match to match. */
2850 error = oxm_pull_match(&nx_match, &match);
2852 error = nx_pull_match(&nx_match, match_len, &match,
2853 &cookie, &cookie_mask);
2857 error = oxm_pull_match_loose(&nx_match, &match);
2859 error = nx_pull_match_loose(&nx_match, match_len, &match,
2860 &cookie, &cookie_mask);
2868 /* Convert match back to nx_match. */
2869 ofpbuf_uninit(&nx_match);
2870 ofpbuf_init(&nx_match, 0);
2872 match_len = oxm_put_match(&nx_match, &match, version);
2873 out = oxm_match_to_string(&nx_match, match_len);
2875 match_len = nx_put_match(&nx_match, &match,
2876 cookie, cookie_mask);
2877 out = nx_match_to_string(ofpbuf_data(&nx_match), match_len);
2883 printf("nx_pull_match() returned error %s\n",
2884 ofperr_get_name(error));
2887 ofpbuf_uninit(&nx_match);
2892 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2893 * stdin, does some internal fussing with them, and then prints them back as
2894 * strings on stdout. */
2896 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2898 ofctl_parse_nxm__(false, 0);
2901 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
2902 * strings from stdin, does some internal fussing with them, and then prints
2903 * them back as strings on stdout. VERSION must specify an OpenFlow version,
2904 * e.g. "OpenFlow12". */
2906 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[])
2908 enum ofp_version version = ofputil_version_from_string(argv[1]);
2909 if (version < OFP12_VERSION) {
2910 ovs_fatal(0, "%s: not a valid version for OXM", argv[1]);
2913 ofctl_parse_nxm__(true, version);
2917 print_differences(const char *prefix,
2918 const void *a_, size_t a_len,
2919 const void *b_, size_t b_len)
2921 const uint8_t *a = a_;
2922 const uint8_t *b = b_;
2925 for (i = 0; i < MIN(a_len, b_len); i++) {
2927 printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
2928 prefix, i, a[i], b[i]);
2931 for (i = a_len; i < b_len; i++) {
2932 printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2934 for (i = b_len; i < a_len; i++) {
2935 printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2940 ofctl_parse_actions__(const char *version_s, bool instructions)
2942 enum ofp_version version;
2945 version = ofputil_version_from_string(version_s);
2947 ovs_fatal(0, "%s: not a valid OpenFlow version", version_s);
2951 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2952 struct ofpbuf of_out;
2953 struct ofpbuf of_in;
2954 struct ofpbuf ofpacts;
2955 const char *table_id;
2961 /* Parse table_id separated with the follow-up actions by ",", if
2963 actions = ds_cstr(&in);
2965 if (strstr(actions, ",")) {
2966 table_id = strsep(&actions, ",");
2969 /* Parse hex bytes. */
2970 ofpbuf_init(&of_in, 0);
2971 if (ofpbuf_put_hex(&of_in, actions, NULL)[0] != '\0') {
2972 ovs_fatal(0, "Trailing garbage in hex data");
2975 /* Convert to ofpacts. */
2976 ofpbuf_init(&ofpacts, 0);
2977 size = ofpbuf_size(&of_in);
2978 error = (instructions
2979 ? ofpacts_pull_openflow_instructions
2980 : ofpacts_pull_openflow_actions)(
2981 &of_in, ofpbuf_size(&of_in), version, &ofpacts);
2982 if (!error && instructions) {
2983 /* Verify actions, enforce consistency. */
2984 enum ofputil_protocol protocol;
2987 memset(&flow, 0, sizeof flow);
2988 protocol = ofputil_protocols_from_ofp_version(version);
2989 error = ofpacts_check_consistency(ofpbuf_data(&ofpacts),
2990 ofpbuf_size(&ofpacts),
2992 table_id ? atoi(table_id) : 0,
2996 printf("bad %s %s: %s\n\n",
2997 version_s, instructions ? "instructions" : "actions",
2998 ofperr_get_name(error));
2999 ofpbuf_uninit(&ofpacts);
3000 ofpbuf_uninit(&of_in);
3003 ofpbuf_push_uninit(&of_in, size);
3005 /* Print cls_rule. */
3007 ds_put_cstr(&s, "actions=");
3008 ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
3012 /* Convert back to ofp10 actions and print differences from input. */
3013 ofpbuf_init(&of_out, 0);
3015 ofpacts_put_openflow_instructions( ofpbuf_data(&ofpacts),
3016 ofpbuf_size(&ofpacts),
3019 ofpacts_put_openflow_actions( ofpbuf_data(&ofpacts),
3020 ofpbuf_size(&ofpacts),
3024 print_differences("", ofpbuf_data(&of_in), ofpbuf_size(&of_in),
3025 ofpbuf_data(&of_out), ofpbuf_size(&of_out));
3028 ofpbuf_uninit(&ofpacts);
3029 ofpbuf_uninit(&of_in);
3030 ofpbuf_uninit(&of_out);
3035 /* "parse-actions VERSION": reads a series of action specifications for the
3036 * given OpenFlow VERSION as hex bytes from stdin, converts them to ofpacts,
3037 * prints them as strings on stdout, and then converts them back to hex bytes
3038 * and prints any differences from the input. */
3040 ofctl_parse_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3042 ofctl_parse_actions__(argv[1], false);
3045 /* "parse-actions VERSION": reads a series of instruction specifications for
3046 * the given OpenFlow VERSION as hex bytes from stdin, converts them to
3047 * ofpacts, prints them as strings on stdout, and then converts them back to
3048 * hex bytes and prints any differences from the input. */
3050 ofctl_parse_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3052 ofctl_parse_actions__(argv[1], true);
3055 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3056 * bytes from stdin, converts them to cls_rules, prints them as strings on
3057 * stdout, and then converts them back to hex bytes and prints any differences
3060 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3061 * values are ignored in the input and will be set to zero when OVS converts
3062 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
3063 * it does the conversion to hex, to ensure that in fact they are ignored. */
3065 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3072 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3073 struct ofpbuf match_in, match_expout;
3074 struct ofp10_match match_out;
3075 struct ofp10_match match_normal;
3079 /* Parse hex bytes to use for expected output. */
3081 ds_put_cstr(&expout, ds_cstr(&in));
3082 for (p = ds_cstr(&expout); *p; p++) {
3087 ofpbuf_init(&match_expout, 0);
3088 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3089 ovs_fatal(0, "Trailing garbage in hex data");
3091 if (ofpbuf_size(&match_expout) != sizeof(struct ofp10_match)) {
3092 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3093 ofpbuf_size(&match_expout), sizeof(struct ofp10_match));
3096 /* Parse hex bytes for input. */
3097 for (p = ds_cstr(&in); *p; p++) {
3099 *p = "0123456789abcdef"[random_uint32() & 0xf];
3102 ofpbuf_init(&match_in, 0);
3103 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3104 ovs_fatal(0, "Trailing garbage in hex data");
3106 if (ofpbuf_size(&match_in) != sizeof(struct ofp10_match)) {
3107 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3108 ofpbuf_size(&match_in), sizeof(struct ofp10_match));
3111 /* Convert to cls_rule and print. */
3112 ofputil_match_from_ofp10_match(ofpbuf_data(&match_in), &match);
3113 match_print(&match);
3115 /* Convert back to ofp10_match and print differences from input. */
3116 ofputil_match_to_ofp10_match(&match, &match_out);
3117 print_differences("", ofpbuf_data(&match_expout), ofpbuf_size(&match_expout),
3118 &match_out, sizeof match_out);
3120 /* Normalize, then convert and compare again. */
3121 ofputil_normalize_match(&match);
3122 ofputil_match_to_ofp10_match(&match, &match_normal);
3123 print_differences("normal: ", &match_out, sizeof match_out,
3124 &match_normal, sizeof match_normal);
3127 ofpbuf_uninit(&match_in);
3128 ofpbuf_uninit(&match_expout);
3131 ds_destroy(&expout);
3134 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3135 * bytes from stdin, converts them to "struct match"es, prints them as strings
3136 * on stdout, and then converts them back to hex bytes and prints any
3137 * differences from the input. */
3139 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3144 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3145 struct ofpbuf match_in;
3146 struct ofp11_match match_out;
3150 /* Parse hex bytes. */
3151 ofpbuf_init(&match_in, 0);
3152 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3153 ovs_fatal(0, "Trailing garbage in hex data");
3155 if (ofpbuf_size(&match_in) != sizeof(struct ofp11_match)) {
3156 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3157 ofpbuf_size(&match_in), sizeof(struct ofp11_match));
3160 /* Convert to match. */
3161 error = ofputil_match_from_ofp11_match(ofpbuf_data(&match_in), &match);
3163 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3164 ofpbuf_uninit(&match_in);
3169 match_print(&match);
3171 /* Convert back to ofp11_match and print differences from input. */
3172 ofputil_match_to_ofp11_match(&match, &match_out);
3174 print_differences("", ofpbuf_data(&match_in), ofpbuf_size(&match_in),
3175 &match_out, sizeof match_out);
3178 ofpbuf_uninit(&match_in);
3183 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3185 ofctl_parse_pcap(int argc OVS_UNUSED, char *argv[])
3189 pcap = ovs_pcap_open(argv[1], "rb");
3191 ovs_fatal(errno, "%s: open failed", argv[1]);
3195 struct ofpbuf *packet;
3197 const struct pkt_metadata md = PKT_METADATA_INITIALIZER(ODPP_NONE);
3200 error = ovs_pcap_read(pcap, &packet, NULL);
3204 ovs_fatal(error, "%s: read failed", argv[1]);
3207 flow_extract(packet, &md, &flow);
3208 flow_print(stdout, &flow);
3210 ofpbuf_delete(packet);
3214 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3215 * mask values to and from various formats and prints the results. */
3217 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
3222 struct ofputil_flow_mod fm;
3225 struct match nxm_match;
3229 struct ofp10_match of10_raw;
3230 struct match of10_match;
3232 struct ofp11_match of11_raw;
3233 struct match of11_match;
3238 enum ofputil_protocol usable_protocols; /* Unused for now. */
3240 match_init_catchall(&match);
3241 match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
3242 match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
3244 /* Convert to and from string. */
3245 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3246 printf("%s -> ", string_s);
3248 error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3250 ovs_fatal(0, "%s", error_s);
3252 printf("%04"PRIx16"/%04"PRIx16"\n",
3253 ntohs(fm.match.flow.vlan_tci),
3254 ntohs(fm.match.wc.masks.vlan_tci));
3257 /* Convert to and from NXM. */
3258 ofpbuf_init(&nxm, 0);
3259 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3260 nxm_s = nx_match_to_string(ofpbuf_data(&nxm), nxm_match_len);
3261 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3262 printf("NXM: %s -> ", nxm_s);
3264 printf("%s\n", ofperr_to_string(error));
3266 printf("%04"PRIx16"/%04"PRIx16"\n",
3267 ntohs(nxm_match.flow.vlan_tci),
3268 ntohs(nxm_match.wc.masks.vlan_tci));
3271 ofpbuf_uninit(&nxm);
3273 /* Convert to and from OXM. */
3274 ofpbuf_init(&nxm, 0);
3275 nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3276 nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3277 error = oxm_pull_match(&nxm, &nxm_match);
3278 printf("OXM: %s -> ", nxm_s);
3280 printf("%s\n", ofperr_to_string(error));
3282 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3283 (VLAN_VID_MASK | VLAN_CFI);
3284 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3285 (VLAN_VID_MASK | VLAN_CFI);
3287 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3288 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3289 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3295 ofpbuf_uninit(&nxm);
3297 /* Convert to and from OpenFlow 1.0. */
3298 ofputil_match_to_ofp10_match(&match, &of10_raw);
3299 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3300 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3301 ntohs(of10_raw.dl_vlan),
3302 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3303 of10_raw.dl_vlan_pcp,
3304 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3305 ntohs(of10_match.flow.vlan_tci),
3306 ntohs(of10_match.wc.masks.vlan_tci));
3308 /* Convert to and from OpenFlow 1.1. */
3309 ofputil_match_to_ofp11_match(&match, &of11_raw);
3310 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3311 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3312 ntohs(of11_raw.dl_vlan),
3313 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3314 of11_raw.dl_vlan_pcp,
3315 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3316 ntohs(of11_match.flow.vlan_tci),
3317 ntohs(of11_match.wc.masks.vlan_tci));
3320 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3323 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
3328 error = ofperr_from_name(argv[1]);
3330 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3333 for (version = 0; version <= UINT8_MAX; version++) {
3334 const char *name = ofperr_domain_get_name(version);
3336 int vendor = ofperr_get_vendor(error, version);
3337 int type = ofperr_get_type(error, version);
3338 int code = ofperr_get_code(error, version);
3340 if (vendor != -1 || type != -1 || code != -1) {
3341 printf("%s: vendor %#x, type %d, code %d\n",
3342 name, vendor, type, code);
3348 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3349 * error named ENUM and prints the error reply in hex. */
3351 ofctl_encode_error_reply(int argc OVS_UNUSED, char *argv[])
3353 const struct ofp_header *oh;
3354 struct ofpbuf request, *reply;
3357 error = ofperr_from_name(argv[1]);
3359 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3362 ofpbuf_init(&request, 0);
3363 if (ofpbuf_put_hex(&request, argv[2], NULL)[0] != '\0') {
3364 ovs_fatal(0, "Trailing garbage in hex data");
3366 if (ofpbuf_size(&request) < sizeof(struct ofp_header)) {
3367 ovs_fatal(0, "Request too short");
3370 oh = ofpbuf_data(&request);
3371 if (ofpbuf_size(&request) != ntohs(oh->length)) {
3372 ovs_fatal(0, "Request size inconsistent");
3375 reply = ofperr_encode_reply(error, ofpbuf_data(&request));
3376 ofpbuf_uninit(&request);
3378 ovs_hex_dump(stdout, ofpbuf_data(reply), ofpbuf_size(reply), 0, false);
3379 ofpbuf_delete(reply);
3382 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3383 * binary data, interpreting them as an OpenFlow message, and prints the
3384 * OpenFlow message on stdout, at VERBOSITY (level 2 by default).
3386 * Alternative usage: "ofp-print [VERBOSITY] - < HEXSTRING_FILE", where
3387 * HEXSTRING_FILE contains the HEXSTRING. */
3389 ofctl_ofp_print(int argc, char *argv[])
3391 struct ofpbuf packet;
3398 if (!strcmp(argv[argc-1], "-")) {
3399 if (ds_get_line(&line, stdin)) {
3400 VLOG_FATAL("Failed to read stdin");
3403 buffer = line.string;
3404 verbosity = argc > 2 ? atoi(argv[1]) : verbosity;
3405 } else if (argc > 2) {
3407 verbosity = atoi(argv[2]);
3412 ofpbuf_init(&packet, strlen(buffer) / 2);
3413 if (ofpbuf_put_hex(&packet, buffer, NULL)[0] != '\0') {
3414 ovs_fatal(0, "trailing garbage following hex bytes");
3416 ofp_print(stdout, ofpbuf_data(&packet), ofpbuf_size(&packet), verbosity);
3417 ofpbuf_uninit(&packet);
3421 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3422 * and dumps each message in hex. */
3424 ofctl_encode_hello(int argc OVS_UNUSED, char *argv[])
3426 uint32_t bitmap = strtol(argv[1], NULL, 0);
3427 struct ofpbuf *hello;
3429 hello = ofputil_encode_hello(bitmap);
3430 ovs_hex_dump(stdout, ofpbuf_data(hello), ofpbuf_size(hello), 0, false);
3431 ofp_print(stdout, ofpbuf_data(hello), ofpbuf_size(hello), verbosity);
3432 ofpbuf_delete(hello);
3435 static const struct command all_commands[] = {
3436 { "show", 1, 1, ofctl_show },
3437 { "monitor", 1, 3, ofctl_monitor },
3438 { "snoop", 1, 1, ofctl_snoop },
3439 { "dump-desc", 1, 1, ofctl_dump_desc },
3440 { "dump-tables", 1, 1, ofctl_dump_tables },
3441 { "dump-table-features", 1, 1, ofctl_dump_table_features },
3442 { "dump-flows", 1, 2, ofctl_dump_flows },
3443 { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
3444 { "queue-stats", 1, 3, ofctl_queue_stats },
3445 { "queue-get-config", 2, 2, ofctl_queue_get_config },
3446 { "add-flow", 2, 2, ofctl_add_flow },
3447 { "add-flows", 2, 2, ofctl_add_flows },
3448 { "mod-flows", 2, 2, ofctl_mod_flows },
3449 { "del-flows", 1, 2, ofctl_del_flows },
3450 { "replace-flows", 2, 2, ofctl_replace_flows },
3451 { "diff-flows", 2, 2, ofctl_diff_flows },
3452 { "add-meter", 2, 2, ofctl_add_meter },
3453 { "mod-meter", 2, 2, ofctl_mod_meter },
3454 { "del-meter", 2, 2, ofctl_del_meters },
3455 { "del-meters", 1, 1, ofctl_del_meters },
3456 { "dump-meter", 2, 2, ofctl_dump_meters },
3457 { "dump-meters", 1, 1, ofctl_dump_meters },
3458 { "meter-stats", 1, 2, ofctl_meter_stats },
3459 { "meter-features", 1, 1, ofctl_meter_features },
3460 { "packet-out", 4, INT_MAX, ofctl_packet_out },
3461 { "dump-ports", 1, 2, ofctl_dump_ports },
3462 { "dump-ports-desc", 1, 2, ofctl_dump_ports_desc },
3463 { "mod-port", 3, 3, ofctl_mod_port },
3464 { "mod-table", 3, 3, ofctl_mod_table },
3465 { "get-frags", 1, 1, ofctl_get_frags },
3466 { "set-frags", 2, 2, ofctl_set_frags },
3467 { "probe", 1, 1, ofctl_probe },
3468 { "ping", 1, 2, ofctl_ping },
3469 { "benchmark", 3, 3, ofctl_benchmark },
3471 { "ofp-parse", 1, 1, ofctl_ofp_parse },
3472 { "ofp-parse-pcap", 1, INT_MAX, ofctl_ofp_parse_pcap },
3474 { "add-group", 1, 2, ofctl_add_group },
3475 { "add-groups", 1, 2, ofctl_add_groups },
3476 { "mod-group", 1, 2, ofctl_mod_group },
3477 { "del-groups", 1, 2, ofctl_del_groups },
3478 { "dump-groups", 1, 2, ofctl_dump_group_desc },
3479 { "dump-group-stats", 1, 2, ofctl_dump_group_stats },
3480 { "dump-group-features", 1, 1, ofctl_dump_group_features },
3481 { "help", 0, INT_MAX, ofctl_help },
3483 /* Undocumented commands for testing. */
3484 { "parse-flow", 1, 1, ofctl_parse_flow },
3485 { "parse-flows", 1, 1, ofctl_parse_flows },
3486 { "parse-nx-match", 0, 0, ofctl_parse_nxm },
3487 { "parse-nxm", 0, 0, ofctl_parse_nxm },
3488 { "parse-oxm", 1, 1, ofctl_parse_oxm },
3489 { "parse-actions", 1, 1, ofctl_parse_actions },
3490 { "parse-instructions", 1, 1, ofctl_parse_instructions },
3491 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
3492 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
3493 { "parse-pcap", 1, 1, ofctl_parse_pcap },
3494 { "check-vlan", 2, 2, ofctl_check_vlan },
3495 { "print-error", 1, 1, ofctl_print_error },
3496 { "encode-error-reply", 2, 2, ofctl_encode_error_reply },
3497 { "ofp-print", 1, 2, ofctl_ofp_print },
3498 { "encode-hello", 1, 1, ofctl_encode_hello },
3500 { NULL, 0, 0, NULL },
3503 static const struct command *get_all_commands(void)
3505 return all_commands;