2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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>
28 #include <sys/fcntl.h>
32 #include "byte-order.h"
33 #include "classifier.h"
34 #include "command-line.h"
38 #include "dynamic-string.h"
41 #include "ofp-actions.h"
42 #include "ofp-errors.h"
44 #include "ofp-parse.h"
45 #include "ofp-print.h"
47 #include "ofp-version-opt.h"
49 #include "ofproto/ofproto.h"
50 #include "openflow/nicira-ext.h"
51 #include "openflow/openflow.h"
53 #include "pcap-file.h"
54 #include "poll-loop.h"
56 #include "stream-ssl.h"
57 #include "socket-util.h"
63 #include "meta-flow.h"
66 VLOG_DEFINE_THIS_MODULE(ofctl);
68 /* --strict: Use strict matching for flow mod commands? Additionally governs
69 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
73 /* --readd: If true, on replace-flows, re-add even flows that have not changed
74 * (to reset flow counters). */
77 /* -F, --flow-format: Allowed protocols. By default, any protocol is
79 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
81 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
82 * commands. Either one of NXPIF_* to force a particular packet_in format, or
83 * -1 to let ovs-ofctl choose the default. */
84 static int preferred_packet_in_format = -1;
86 /* -m, --more: Additional verbosity for ofp-print functions. */
89 /* --timestamp: Print a timestamp before each received packet on "monitor" and
91 static bool timestamp;
93 /* --sort, --rsort: Sort order. */
94 enum sort_order { SORT_ASC, SORT_DESC };
95 struct sort_criterion {
96 const struct mf_field *field; /* NULL means to sort by priority. */
97 enum sort_order order;
99 static struct sort_criterion *criteria;
100 static size_t n_criteria, allocated_criteria;
102 static const struct command *get_all_commands(void);
104 static void usage(void) NO_RETURN;
105 static void parse_options(int argc, char *argv[]);
107 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
108 struct ofpbuf **replyp,
109 struct ofputil_flow_stats *,
110 struct ofpbuf *ofpacts);
112 main(int argc, char *argv[])
114 set_program_name(argv[0]);
115 parse_options(argc, argv);
116 signal(SIGPIPE, SIG_IGN);
117 run_command(argc - optind, argv + optind, get_all_commands());
122 add_sort_criterion(enum sort_order order, const char *field)
124 struct sort_criterion *sc;
126 if (n_criteria >= allocated_criteria) {
127 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
130 sc = &criteria[n_criteria++];
131 if (!field || !strcasecmp(field, "priority")) {
134 sc->field = mf_from_name(field);
136 ovs_fatal(0, "%s: unknown field name", field);
143 parse_options(int argc, char *argv[])
146 OPT_STRICT = UCHAR_MAX + 1,
152 OFP_VERSION_OPTION_ENUMS,
155 static const struct option long_options[] = {
156 {"timeout", required_argument, NULL, 't'},
157 {"strict", no_argument, NULL, OPT_STRICT},
158 {"readd", no_argument, NULL, OPT_READD},
159 {"flow-format", required_argument, NULL, 'F'},
160 {"packet-in-format", required_argument, NULL, 'P'},
161 {"more", no_argument, NULL, 'm'},
162 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
163 {"sort", optional_argument, NULL, OPT_SORT},
164 {"rsort", optional_argument, NULL, OPT_RSORT},
165 {"help", no_argument, NULL, 'h'},
167 OFP_VERSION_LONG_OPTIONS,
169 STREAM_SSL_LONG_OPTIONS,
172 char *short_options = long_options_to_short_options(long_options);
174 enum ofputil_protocol version_protocols;
177 unsigned long int timeout;
180 c = getopt_long(argc, argv, short_options, long_options, NULL);
187 timeout = strtoul(optarg, NULL, 10);
189 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
197 allowed_protocols = ofputil_protocols_from_string(optarg);
198 if (!allowed_protocols) {
199 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
204 preferred_packet_in_format =
205 ofputil_packet_in_format_from_string(optarg);
206 if (preferred_packet_in_format < 0) {
207 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
231 add_sort_criterion(SORT_ASC, optarg);
235 add_sort_criterion(SORT_DESC, optarg);
238 DAEMON_OPTION_HANDLERS
239 OFP_VERSION_OPTION_HANDLERS
241 STREAM_SSL_OPTION_HANDLERS
252 /* Always do a final sort pass based on priority. */
253 add_sort_criterion(SORT_DESC, "priority");
258 versions = get_allowed_ofp_versions();
259 version_protocols = ofputil_protocols_from_version_bitmap(versions);
260 if (!(allowed_protocols & version_protocols)) {
261 char *protocols = ofputil_protocols_to_string(allowed_protocols);
262 struct ds version_s = DS_EMPTY_INITIALIZER;
264 ofputil_format_version_bitmap_names(&version_s, versions);
265 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
266 "any of the enabled flow formats (%s). (Use -O to enable "
267 "additional OpenFlow versions or -F to enable additional "
268 "flow formats.)", ds_cstr(&version_s), protocols);
270 allowed_protocols &= version_protocols;
271 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
278 printf("%s: OpenFlow switch management utility\n"
279 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
280 "\nFor OpenFlow switches:\n"
281 " show SWITCH show OpenFlow information\n"
282 " dump-desc SWITCH print switch description\n"
283 " dump-tables SWITCH print table stats\n"
284 " mod-port SWITCH IFACE ACT modify port behavior\n"
285 " mod-table SWITCH MOD modify flow table behavior\n"
286 " get-frags SWITCH print fragment handling behavior\n"
287 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
288 " dump-ports SWITCH [PORT] print port statistics\n"
289 " dump-ports-desc SWITCH print port descriptions\n"
290 " dump-flows SWITCH print all flow entries\n"
291 " dump-flows SWITCH FLOW print matching FLOWs\n"
292 " dump-aggregate SWITCH print aggregate flow statistics\n"
293 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
294 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
295 " add-flow SWITCH FLOW add flow described by FLOW\n"
296 " add-flows SWITCH FILE add flows from FILE\n"
297 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
298 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
299 " replace-flows SWITCH FILE replace flows with those in FILE\n"
300 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
301 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
302 " execute ACTIONS on PACKET\n"
303 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
304 " print packets received from SWITCH\n"
305 " snoop SWITCH snoop on SWITCH and its controller\n"
306 " add-group SWITCH GROUP add group described by GROUP\n"
307 " add-group SWITCH FILE add group from FILE\n"
308 " mod-group SWITCH GROUP modify specific group\n"
309 " del-groups SWITCH [GROUP] delete matching GROUPs\n"
310 " dump-group-features SWITCH print group features\n"
311 " dump-groups SWITCH print group description\n"
312 " dump-group-stats SWITCH [GROUP] print group statistics\n"
313 " queue-get-config SWITCH PORT print queue information for port\n"
314 " add-meter SWITCH METER add meter described by METER\n"
315 " mod-meter SWITCH METER modify specific METER\n"
316 " del-meter SWITCH METER delete METER\n"
317 " del-meters SWITCH delete all meters\n"
318 " dump-meter SWITCH METER print METER configuration\n"
319 " dump-meters SWITCH print all meter configuration\n"
320 " meter-stats SWITCH [METER] print meter statistics\n"
321 " meter-features SWITCH print meter features\n"
322 "\nFor OpenFlow switches and controllers:\n"
323 " probe TARGET probe whether TARGET is up\n"
324 " ping TARGET [N] latency of N-byte echos\n"
325 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
326 "SWITCH or TARGET is an active OpenFlow connection method.\n"
327 "\nOther commands:\n"
328 " ofp-parse FILE print messages read from FILE\n",
329 program_name, program_name);
330 vconn_usage(true, false, false);
334 printf("\nOther options:\n"
335 " --strict use strict match for flow commands\n"
336 " --readd replace flows that haven't changed\n"
337 " -F, --flow-format=FORMAT force particular flow format\n"
338 " -P, --packet-in-format=FRMT force particular packet in format\n"
339 " -m, --more be more verbose printing OpenFlow\n"
340 " --timestamp (monitor, snoop) print timestamps\n"
341 " -t, --timeout=SECS give up after SECS seconds\n"
342 " --sort[=field] sort in ascending order\n"
343 " --rsort[=field] sort in descending order\n"
344 " -h, --help display this help message\n"
345 " -V, --version display version information\n");
350 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
351 const char *argv[] OVS_UNUSED, void *exiting_)
353 bool *exiting = exiting_;
355 unixctl_command_reply(conn, NULL);
358 static void run(int retval, const char *message, ...)
362 run(int retval, const char *message, ...)
367 va_start(args, message);
368 ovs_fatal_valist(retval, message, args);
372 /* Generic commands. */
375 open_vconn_socket(const char *name, struct vconn **vconnp)
377 char *vconn_name = xasprintf("unix:%s", name);
380 error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
382 if (error && error != ENOENT) {
383 ovs_fatal(0, "%s: failed to open socket (%s)", name,
384 ovs_strerror(error));
391 enum open_target { MGMT, SNOOP };
393 static enum ofputil_protocol
394 open_vconn__(const char *name, enum open_target target,
395 struct vconn **vconnp)
397 const char *suffix = target == MGMT ? "mgmt" : "snoop";
398 char *datapath_name, *datapath_type, *socket_name;
399 enum ofputil_protocol protocol;
404 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
406 ofproto_parse_name(name, &datapath_name, &datapath_type);
407 socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
411 if (strchr(name, ':')) {
412 run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
413 "connecting to %s", name);
414 } else if (!open_vconn_socket(name, vconnp)) {
416 } else if (!open_vconn_socket(bridge_path, vconnp)) {
418 } else if (!open_vconn_socket(socket_name, vconnp)) {
421 ovs_fatal(0, "%s is not a bridge or a socket", name);
424 if (target == SNOOP) {
425 vconn_set_recv_any_version(*vconnp);
431 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
432 error = vconn_connect_block(*vconnp);
434 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
435 ovs_strerror(error));
438 ofp_version = vconn_get_version(*vconnp);
439 protocol = ofputil_protocol_from_ofp_version(ofp_version);
441 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
447 static enum ofputil_protocol
448 open_vconn(const char *name, struct vconn **vconnp)
450 return open_vconn__(name, MGMT, vconnp);
454 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
456 ofpmsg_update_length(buffer);
457 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
461 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
463 struct ofpbuf *reply;
465 ofpmsg_update_length(request);
466 run(vconn_transact(vconn, request, &reply), "talking to %s",
467 vconn_get_name(vconn));
468 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
469 ofpbuf_delete(reply);
473 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
475 struct ofpbuf *request;
478 open_vconn(vconn_name, &vconn);
479 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
480 dump_transaction(vconn, request);
485 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
487 const struct ofp_header *request_oh = request->data;
488 ovs_be32 send_xid = request_oh->xid;
489 enum ofpraw request_raw;
490 enum ofpraw reply_raw;
493 ofpraw_decode_partial(&request_raw, request->data, request->size);
494 reply_raw = ofpraw_stats_request_to_reply(request_raw,
495 request_oh->version);
497 send_openflow_buffer(vconn, request);
500 struct ofpbuf *reply;
502 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
503 recv_xid = ((struct ofp_header *) reply->data)->xid;
504 if (send_xid == recv_xid) {
507 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
509 ofpraw_decode(&raw, reply->data);
510 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
512 } else if (raw == reply_raw) {
513 done = !ofpmp_more(reply->data);
515 ovs_fatal(0, "received bad reply: %s",
516 ofp_to_string(reply->data, reply->size,
520 VLOG_DBG("received reply with xid %08"PRIx32" "
521 "!= expected %08"PRIx32, recv_xid, send_xid);
523 ofpbuf_delete(reply);
528 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
530 struct ofpbuf *request;
533 open_vconn(vconn_name, &vconn);
534 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
535 dump_stats_transaction(vconn, request);
539 /* Sends all of the 'requests', which should be requests that only have replies
540 * if an error occurs, and waits for them to succeed or fail. If an error does
541 * occur, prints it and exits with an error.
543 * Destroys all of the 'requests'. */
545 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
547 struct ofpbuf *request, *reply;
549 LIST_FOR_EACH (request, list_node, requests) {
550 ofpmsg_update_length(request);
553 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
554 "talking to %s", vconn_get_name(vconn));
556 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
559 ofpbuf_delete(reply);
562 /* Sends 'request', which should be a request that only has a reply if an error
563 * occurs, and waits for it to succeed or fail. If an error does occur, prints
564 * it and exits with an error.
566 * Destroys 'request'. */
568 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
570 struct list requests;
572 list_init(&requests);
573 list_push_back(&requests, &request->list_node);
574 transact_multiple_noreply(vconn, &requests);
578 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
580 struct ofp_switch_config *config;
581 struct ofpbuf *request;
582 struct ofpbuf *reply;
585 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
586 vconn_get_version(vconn), 0);
587 run(vconn_transact(vconn, request, &reply),
588 "talking to %s", vconn_get_name(vconn));
590 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
591 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
594 config = ofpbuf_pull(reply, sizeof *config);
597 ofpbuf_delete(reply);
601 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
603 struct ofpbuf *request;
605 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
606 ofpbuf_put(request, config, sizeof *config);
608 transact_noreply(vconn, request);
612 ofctl_show(int argc OVS_UNUSED, char *argv[])
614 const char *vconn_name = argv[1];
616 struct ofpbuf *request;
617 struct ofpbuf *reply;
620 open_vconn(vconn_name, &vconn);
621 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
622 vconn_get_version(vconn), 0);
623 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
625 trunc = ofputil_switch_features_ports_trunc(reply);
626 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
628 ofpbuf_delete(reply);
631 /* The Features Reply may not contain all the ports, so send a
632 * Port Description stats request, which doesn't have size
634 dump_trivial_stats_transaction(vconn_name,
635 OFPRAW_OFPST_PORT_DESC_REQUEST);
637 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
642 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
644 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
648 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
650 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
654 fetch_port_by_features(const char *vconn_name,
655 const char *port_name, ofp_port_t port_no,
656 struct ofputil_phy_port *pp, bool *trunc)
658 struct ofputil_switch_features features;
659 const struct ofp_header *oh;
660 struct ofpbuf *request, *reply;
667 /* Fetch the switch's ofp_switch_features. */
668 open_vconn(vconn_name, &vconn);
669 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
670 vconn_get_version(vconn), 0);
671 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
675 if (ofptype_decode(&type, reply->data)
676 || type != OFPTYPE_FEATURES_REPLY) {
677 ovs_fatal(0, "%s: received bad features reply", vconn_name);
681 if (ofputil_switch_features_ports_trunc(reply)) {
686 error = ofputil_decode_switch_features(oh, &features, &b);
688 ovs_fatal(0, "%s: failed to decode features reply (%s)",
689 vconn_name, ofperr_to_string(error));
692 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
693 if (port_no != OFPP_NONE
694 ? port_no == pp->port_no
695 : !strcmp(pp->name, port_name)) {
702 ofpbuf_delete(reply);
707 fetch_port_by_stats(const char *vconn_name,
708 const char *port_name, ofp_port_t port_no,
709 struct ofputil_phy_port *pp)
711 struct ofpbuf *request;
717 request = ofpraw_alloc(OFPRAW_OFPST_PORT_DESC_REQUEST, OFP10_VERSION, 0);
718 send_xid = ((struct ofp_header *) request->data)->xid;
720 open_vconn(vconn_name, &vconn);
721 send_openflow_buffer(vconn, request);
724 struct ofpbuf *reply;
726 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
727 recv_xid = ((struct ofp_header *) reply->data)->xid;
728 if (send_xid == recv_xid) {
729 struct ofp_header *oh = reply->data;
734 ofpbuf_use_const(&b, oh, ntohs(oh->length));
735 if (ofptype_pull(&type, &b)
736 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
737 ovs_fatal(0, "received bad reply: %s",
738 ofp_to_string(reply->data, reply->size,
742 flags = ofpmp_flags(oh);
743 done = !(flags & OFPSF_REPLY_MORE);
746 /* We've already found the port, but we need to drain
747 * the queue of any other replies for this request. */
751 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
752 if (port_no != OFPP_NONE ? port_no == pp->port_no
753 : !strcmp(pp->name, port_name)) {
759 VLOG_DBG("received reply with xid %08"PRIx32" "
760 "!= expected %08"PRIx32, recv_xid, send_xid);
762 ofpbuf_delete(reply);
770 str_to_ofp(const char *s, ofp_port_t *ofp_port)
775 ret = str_to_uint(s, 10, &port_);
776 *ofp_port = u16_to_ofp(port_);
780 /* Opens a connection to 'vconn_name', fetches the port structure for
781 * 'port_name' (which may be a port name or number), and copies it into
784 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
785 struct ofputil_phy_port *pp)
791 /* Try to interpret the argument as a port number. */
792 if (!str_to_ofp(port_name, &port_no)) {
796 /* Try to find the port based on the Features Reply. If it looks
797 * like the results may be truncated, then use the Port Description
798 * stats message introduced in OVS 1.7. */
799 found = fetch_port_by_features(vconn_name, port_name, port_no, pp,
802 found = fetch_port_by_stats(vconn_name, port_name, port_no, pp);
806 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
810 /* Returns the port number corresponding to 'port_name' (which may be a port
811 * name or number) within the switch 'vconn_name'. */
813 str_to_port_no(const char *vconn_name, const char *port_name)
817 if (ofputil_port_from_string(port_name, &port_no)) {
820 struct ofputil_phy_port pp;
822 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
828 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
829 enum ofputil_protocol *cur)
832 struct ofpbuf *request, *reply;
833 enum ofputil_protocol next;
835 request = ofputil_encode_set_protocol(*cur, want, &next);
840 run(vconn_transact_noreply(vconn, request, &reply),
841 "talking to %s", vconn_get_name(vconn));
843 char *s = ofp_to_string(reply->data, reply->size, 2);
844 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
845 vconn_get_name(vconn), s);
847 ofpbuf_delete(reply);
855 static enum ofputil_protocol
856 set_protocol_for_flow_dump(struct vconn *vconn,
857 enum ofputil_protocol cur_protocol,
858 enum ofputil_protocol usable_protocols)
863 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
864 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
865 if (f & usable_protocols & allowed_protocols
866 && try_set_protocol(vconn, f, &cur_protocol)) {
871 usable_s = ofputil_protocols_to_string(usable_protocols);
872 if (usable_protocols & allowed_protocols) {
873 ovs_fatal(0, "switch does not support any of the usable flow "
874 "formats (%s)", usable_s);
876 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
877 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
878 "allowed flow formats (%s)", usable_s, allowed_s);
882 static struct vconn *
883 prepare_dump_flows(int argc, char *argv[], bool aggregate,
884 struct ofpbuf **requestp)
886 enum ofputil_protocol usable_protocols, protocol;
887 struct ofputil_flow_stats_request fsr;
891 error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
892 argc > 2 ? argv[2] : "",
895 & OFPUTIL_P_OF10_ANY));
897 ovs_fatal(0, "%s", error);
900 protocol = open_vconn(argv[1], &vconn);
901 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
902 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
907 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
909 struct ofpbuf *request;
912 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
913 dump_stats_transaction(vconn, request);
918 compare_flows(const void *afs_, const void *bfs_)
920 const struct ofputil_flow_stats *afs = afs_;
921 const struct ofputil_flow_stats *bfs = bfs_;
922 const struct match *a = &afs->match;
923 const struct match *b = &bfs->match;
924 const struct sort_criterion *sc;
926 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
927 const struct mf_field *f = sc->field;
931 unsigned int a_pri = afs->priority;
932 unsigned int b_pri = bfs->priority;
933 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
937 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
938 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
940 /* Skip the test for sc->order, so that missing fields always
941 * sort to the end whether we're sorting in ascending or
942 * descending order. */
945 union mf_value aval, bval;
947 mf_get_value(f, &a->flow, &aval);
948 mf_get_value(f, &b->flow, &bval);
949 ret = memcmp(&aval, &bval, f->n_bytes);
954 return sc->order == SORT_ASC ? ret : -ret;
962 ofctl_dump_flows(int argc, char *argv[])
965 return ofctl_dump_flows__(argc, argv, false);
967 struct ofputil_flow_stats *fses;
968 size_t n_fses, allocated_fses;
969 struct ofpbuf *request;
970 struct ofpbuf ofpacts;
971 struct ofpbuf *reply;
977 vconn = prepare_dump_flows(argc, argv, false, &request);
978 send_xid = ((struct ofp_header *) request->data)->xid;
979 send_openflow_buffer(vconn, request);
982 n_fses = allocated_fses = 0;
984 ofpbuf_init(&ofpacts, 0);
986 struct ofputil_flow_stats *fs;
988 if (n_fses >= allocated_fses) {
989 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
993 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
997 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1000 ofpbuf_uninit(&ofpacts);
1002 qsort(fses, n_fses, sizeof *fses, compare_flows);
1005 for (i = 0; i < n_fses; i++) {
1007 ofp_print_flow_stats(&s, &fses[i]);
1012 for (i = 0; i < n_fses; i++) {
1013 free(fses[i].ofpacts);
1022 ofctl_dump_aggregate(int argc, char *argv[])
1024 return ofctl_dump_flows__(argc, argv, true);
1028 ofctl_queue_stats(int argc, char *argv[])
1030 struct ofpbuf *request;
1031 struct vconn *vconn;
1032 struct ofputil_queue_stats_request oqs;
1034 open_vconn(argv[1], &vconn);
1036 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
1037 oqs.port_no = str_to_port_no(argv[1], argv[2]);
1039 oqs.port_no = OFPP_ANY;
1041 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
1042 oqs.queue_id = atoi(argv[3]);
1044 oqs.queue_id = OFPQ_ALL;
1047 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1048 dump_stats_transaction(vconn, request);
1053 ofctl_queue_get_config(int argc OVS_UNUSED, char *argv[])
1055 const char *vconn_name = argv[1];
1056 const char *port_name = argv[2];
1057 enum ofputil_protocol protocol;
1058 enum ofp_version version;
1059 struct ofpbuf *request;
1060 struct vconn *vconn;
1063 port = str_to_port_no(vconn_name, port_name);
1065 protocol = open_vconn(vconn_name, &vconn);
1066 version = ofputil_protocol_to_ofp_version(protocol);
1067 request = ofputil_encode_queue_get_config_request(version, port);
1068 dump_transaction(vconn, request);
1072 static enum ofputil_protocol
1073 open_vconn_for_flow_mod(const char *remote, struct vconn **vconnp,
1074 enum ofputil_protocol usable_protocols)
1076 enum ofputil_protocol cur_protocol;
1080 if (!(usable_protocols & allowed_protocols)) {
1081 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1082 usable_s = ofputil_protocols_to_string(usable_protocols);
1083 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1084 "allowed flow formats (%s)", usable_s, allowed_s);
1087 /* If the initial flow format is allowed and usable, keep it. */
1088 cur_protocol = open_vconn(remote, vconnp);
1089 if (usable_protocols & allowed_protocols & cur_protocol) {
1090 return cur_protocol;
1093 /* Otherwise try each flow format in turn. */
1094 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1095 enum ofputil_protocol f = 1 << i;
1097 if (f != cur_protocol
1098 && f & usable_protocols & allowed_protocols
1099 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1104 usable_s = ofputil_protocols_to_string(usable_protocols);
1105 ovs_fatal(0, "switch does not support any of the usable flow "
1106 "formats (%s)", usable_s);
1110 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1111 size_t n_fms, enum ofputil_protocol usable_protocols)
1113 enum ofputil_protocol protocol;
1114 struct vconn *vconn;
1117 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1119 for (i = 0; i < n_fms; i++) {
1120 struct ofputil_flow_mod *fm = &fms[i];
1122 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1129 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1131 enum ofputil_protocol usable_protocols;
1132 struct ofputil_flow_mod *fms = NULL;
1136 error = parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms,
1138 !(allowed_protocols & OFPUTIL_P_OF10_ANY));
1140 ovs_fatal(0, "%s", error);
1142 ofctl_flow_mod__(argv[1], fms, n_fms, usable_protocols);
1147 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1149 if (argc > 2 && !strcmp(argv[2], "-")) {
1150 ofctl_flow_mod_file(argc, argv, command);
1152 struct ofputil_flow_mod fm;
1154 enum ofputil_protocol usable_protocols;
1156 error = parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command,
1159 & OFPUTIL_P_OF10_ANY));
1161 ovs_fatal(0, "%s", error);
1163 ofctl_flow_mod__(argv[1], &fm, 1, usable_protocols);
1168 ofctl_add_flow(int argc, char *argv[])
1170 ofctl_flow_mod(argc, argv, OFPFC_ADD);
1174 ofctl_add_flows(int argc, char *argv[])
1176 ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1180 ofctl_mod_flows(int argc, char *argv[])
1182 ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1186 ofctl_del_flows(int argc, char *argv[])
1188 ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1192 set_packet_in_format(struct vconn *vconn,
1193 enum nx_packet_in_format packet_in_format)
1195 struct ofpbuf *spif;
1197 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1199 transact_noreply(vconn, spif);
1200 VLOG_DBG("%s: using user-specified packet in format %s",
1201 vconn_get_name(vconn),
1202 ofputil_packet_in_format_to_string(packet_in_format));
1206 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1208 struct ofp_switch_config config;
1209 enum ofp_config_flags flags;
1211 fetch_switch_config(vconn, &config);
1212 flags = ntohs(config.flags);
1213 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1214 /* Set the invalid ttl config. */
1215 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1217 config.flags = htons(flags);
1218 set_switch_config(vconn, &config);
1220 /* Then retrieve the configuration to see if it really took. OpenFlow
1221 * doesn't define error reporting for bad modes, so this is all we can
1223 fetch_switch_config(vconn, &config);
1224 flags = ntohs(config.flags);
1225 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1226 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1227 "switch probably doesn't support mode)");
1234 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1235 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1236 * an error message and stores NULL in '*msgp'. */
1238 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1240 struct ofp_header *oh;
1243 msg = ofpbuf_new(strlen(hex) / 2);
1246 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1248 return "Trailing garbage in hex data";
1251 if (msg->size < sizeof(struct ofp_header)) {
1253 return "Message too short for OpenFlow";
1257 if (msg->size != ntohs(oh->length)) {
1259 return "Message size does not match length in OpenFlow header";
1267 ofctl_send(struct unixctl_conn *conn, int argc,
1268 const char *argv[], void *vconn_)
1270 struct vconn *vconn = vconn_;
1277 for (i = 1; i < argc; i++) {
1278 const char *error_msg;
1282 error_msg = openflow_from_hex(argv[i], &msg);
1284 ds_put_format(&reply, "%s\n", error_msg);
1289 fprintf(stderr, "send: ");
1290 ofp_print(stderr, msg->data, msg->size, verbosity);
1292 error = vconn_send_block(vconn, msg);
1295 ds_put_format(&reply, "%s\n", ovs_strerror(error));
1298 ds_put_cstr(&reply, "sent\n");
1303 unixctl_command_reply(conn, ds_cstr(&reply));
1305 unixctl_command_reply_error(conn, ds_cstr(&reply));
1310 struct barrier_aux {
1311 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1312 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1316 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1317 const char *argv[] OVS_UNUSED, void *aux_)
1319 struct barrier_aux *aux = aux_;
1324 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1328 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1329 error = vconn_send_block(aux->vconn, msg);
1332 unixctl_command_reply_error(conn, ovs_strerror(error));
1339 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1340 const char *argv[], void *aux OVS_UNUSED)
1344 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1346 unixctl_command_reply_error(conn, ovs_strerror(errno));
1351 dup2(fd, STDERR_FILENO);
1353 unixctl_command_reply(conn, NULL);
1357 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1358 const char *argv[] OVS_UNUSED, void *blocked_)
1360 bool *blocked = blocked_;
1364 unixctl_command_reply(conn, NULL);
1366 unixctl_command_reply(conn, "already blocking");
1371 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1372 const char *argv[] OVS_UNUSED, void *blocked_)
1374 bool *blocked = blocked_;
1378 unixctl_command_reply(conn, NULL);
1380 unixctl_command_reply(conn, "already unblocked");
1384 /* Prints to stdout all of the messages received on 'vconn'.
1386 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1387 * received on 'vconn'. */
1389 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1391 struct barrier_aux barrier_aux = { vconn, NULL };
1392 struct unixctl_server *server;
1393 bool exiting = false;
1394 bool blocked = false;
1397 daemon_save_fd(STDERR_FILENO);
1399 error = unixctl_server_create(NULL, &server);
1401 ovs_fatal(error, "failed to create unixctl server");
1403 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1404 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1406 unixctl_command_register("ofctl/barrier", "", 0, 0,
1407 ofctl_barrier, &barrier_aux);
1408 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1409 ofctl_set_output_file, NULL);
1411 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1412 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1415 daemonize_complete();
1421 unixctl_server_run(server);
1426 retval = vconn_recv(vconn, &b);
1427 if (retval == EAGAIN) {
1430 run(retval, "vconn_recv");
1433 char *s = xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1434 time_wall_msec(), true);
1439 ofptype_decode(&type, b->data);
1440 ofp_print(stderr, b->data, b->size, verbosity + 2);
1442 switch ((int) type) {
1443 case OFPTYPE_BARRIER_REPLY:
1444 if (barrier_aux.conn) {
1445 unixctl_command_reply(barrier_aux.conn, NULL);
1446 barrier_aux.conn = NULL;
1450 case OFPTYPE_ECHO_REQUEST:
1451 if (reply_to_echo_requests) {
1452 struct ofpbuf *reply;
1454 reply = make_echo_reply(b->data);
1455 retval = vconn_send_block(vconn, reply);
1457 ovs_fatal(retval, "failed to send echo reply");
1470 vconn_run_wait(vconn);
1472 vconn_recv_wait(vconn);
1474 unixctl_server_wait(server);
1478 unixctl_server_destroy(server);
1482 ofctl_monitor(int argc, char *argv[])
1484 struct vconn *vconn;
1486 enum ofputil_protocol usable_protocols;
1488 open_vconn(argv[1], &vconn);
1489 for (i = 2; i < argc; i++) {
1490 const char *arg = argv[i];
1492 if (isdigit((unsigned char) *arg)) {
1493 struct ofp_switch_config config;
1495 fetch_switch_config(vconn, &config);
1496 config.miss_send_len = htons(atoi(arg));
1497 set_switch_config(vconn, &config);
1498 } else if (!strcmp(arg, "invalid_ttl")) {
1499 monitor_set_invalid_ttl_to_controller(vconn);
1500 } else if (!strncmp(arg, "watch:", 6)) {
1501 struct ofputil_flow_monitor_request fmr;
1505 error = parse_flow_monitor_request(&fmr, arg + 6,
1508 ovs_fatal(0, "%s", error);
1511 msg = ofpbuf_new(0);
1512 ofputil_append_flow_monitor_request(&fmr, msg);
1513 dump_stats_transaction(vconn, msg);
1515 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1519 if (preferred_packet_in_format >= 0) {
1520 set_packet_in_format(vconn, preferred_packet_in_format);
1522 enum ofp_version version = vconn_get_version(vconn);
1525 case OFP10_VERSION: {
1526 struct ofpbuf *spif, *reply;
1528 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1530 run(vconn_transact_noreply(vconn, spif, &reply),
1531 "talking to %s", vconn_get_name(vconn));
1533 char *s = ofp_to_string(reply->data, reply->size, 2);
1534 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1535 " replied: %s. Falling back to the switch default.",
1536 vconn_get_name(vconn), s);
1538 ofpbuf_delete(reply);
1551 monitor_vconn(vconn, true);
1555 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1557 struct vconn *vconn;
1559 open_vconn__(argv[1], SNOOP, &vconn);
1560 monitor_vconn(vconn, false);
1564 ofctl_dump_ports(int argc, char *argv[])
1566 struct ofpbuf *request;
1567 struct vconn *vconn;
1570 open_vconn(argv[1], &vconn);
1571 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1572 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1573 dump_stats_transaction(vconn, request);
1578 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1580 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_PORT_DESC_REQUEST);
1584 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1586 struct ofpbuf *request;
1587 struct vconn *vconn;
1588 struct ofpbuf *reply;
1590 open_vconn(argv[1], &vconn);
1591 request = make_echo_request(vconn_get_version(vconn));
1592 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1593 if (reply->size != sizeof(struct ofp_header)) {
1594 ovs_fatal(0, "reply does not match request");
1596 ofpbuf_delete(reply);
1601 ofctl_packet_out(int argc, char *argv[])
1603 enum ofputil_protocol protocol;
1604 struct ofputil_packet_out po;
1605 struct ofpbuf ofpacts;
1606 struct vconn *vconn;
1609 enum ofputil_protocol usable_protocols; /* TODO: Use in proto selection */
1611 ofpbuf_init(&ofpacts, 64);
1612 error = parse_ofpacts(argv[3], &ofpacts, &usable_protocols);
1614 ovs_fatal(0, "%s", error);
1617 po.buffer_id = UINT32_MAX;
1618 po.in_port = str_to_port_no(argv[1], argv[2]);
1619 po.ofpacts = ofpacts.data;
1620 po.ofpacts_len = ofpacts.size;
1622 protocol = open_vconn(argv[1], &vconn);
1623 for (i = 4; i < argc; i++) {
1624 struct ofpbuf *packet, *opo;
1625 const char *error_msg;
1627 error_msg = eth_from_hex(argv[i], &packet);
1629 ovs_fatal(0, "%s", error_msg);
1632 po.packet = packet->data;
1633 po.packet_len = packet->size;
1634 opo = ofputil_encode_packet_out(&po, protocol);
1635 transact_noreply(vconn, opo);
1636 ofpbuf_delete(packet);
1639 ofpbuf_uninit(&ofpacts);
1643 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1645 struct ofp_config_flag {
1646 const char *name; /* The flag's name. */
1647 enum ofputil_port_config bit; /* Bit to turn on or off. */
1648 bool on; /* Value to set the bit to. */
1650 static const struct ofp_config_flag flags[] = {
1651 { "up", OFPUTIL_PC_PORT_DOWN, false },
1652 { "down", OFPUTIL_PC_PORT_DOWN, true },
1653 { "stp", OFPUTIL_PC_NO_STP, false },
1654 { "receive", OFPUTIL_PC_NO_RECV, false },
1655 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1656 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1657 { "forward", OFPUTIL_PC_NO_FWD, false },
1658 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1661 const struct ofp_config_flag *flag;
1662 enum ofputil_protocol protocol;
1663 struct ofputil_port_mod pm;
1664 struct ofputil_phy_port pp;
1665 struct vconn *vconn;
1666 const char *command;
1669 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1671 pm.port_no = pp.port_no;
1672 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1677 if (!strncasecmp(argv[3], "no-", 3)) {
1678 command = argv[3] + 3;
1680 } else if (!strncasecmp(argv[3], "no", 2)) {
1681 command = argv[3] + 2;
1687 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1688 if (!strcasecmp(command, flag->name)) {
1689 pm.mask = flag->bit;
1690 pm.config = flag->on ^ not ? flag->bit : 0;
1694 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1697 protocol = open_vconn(argv[1], &vconn);
1698 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1703 ofctl_mod_table(int argc OVS_UNUSED, char *argv[])
1705 enum ofputil_protocol protocol, usable_protocols;
1706 struct ofputil_table_mod tm;
1707 struct vconn *vconn;
1711 error = parse_ofp_table_mod(&tm, argv[2], argv[3], &usable_protocols);
1713 ovs_fatal(0, "%s", error);
1716 protocol = open_vconn(argv[1], &vconn);
1717 if (!(protocol & usable_protocols)) {
1718 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1719 enum ofputil_protocol f = 1 << i;
1721 && f & usable_protocols
1722 && try_set_protocol(vconn, f, &protocol)) {
1729 if (!(protocol & usable_protocols)) {
1730 char *usable_s = ofputil_protocols_to_string(usable_protocols);
1731 ovs_fatal(0, "Switch does not support table mod message(%s)", usable_s);
1734 transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
1739 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1741 struct ofp_switch_config config;
1742 struct vconn *vconn;
1744 open_vconn(argv[1], &vconn);
1745 fetch_switch_config(vconn, &config);
1746 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1751 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1753 struct ofp_switch_config config;
1754 enum ofp_config_flags mode;
1755 struct vconn *vconn;
1758 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1759 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1762 open_vconn(argv[1], &vconn);
1763 fetch_switch_config(vconn, &config);
1764 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1765 if (flags != config.flags) {
1766 /* Set the configuration. */
1767 config.flags = flags;
1768 set_switch_config(vconn, &config);
1770 /* Then retrieve the configuration to see if it really took. OpenFlow
1771 * doesn't define error reporting for bad modes, so this is all we can
1773 fetch_switch_config(vconn, &config);
1774 if (flags != config.flags) {
1775 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1776 "switch probably doesn't support mode \"%s\")",
1777 argv[1], ofputil_frag_handling_to_string(mode));
1784 ofctl_ofp_parse(int argc OVS_UNUSED, char *argv[])
1786 const char *filename = argv[1];
1790 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1792 ovs_fatal(errno, "%s: open", filename);
1795 ofpbuf_init(&b, 65536);
1797 struct ofp_header *oh;
1798 size_t length, tail_len;
1803 oh = ofpbuf_put_uninit(&b, sizeof *oh);
1804 n = fread(oh, 1, sizeof *oh, file);
1807 } else if (n < sizeof *oh) {
1808 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1811 length = ntohs(oh->length);
1812 if (length < sizeof *oh) {
1813 ovs_fatal(0, "%s: %zu-byte message is too short for OpenFlow",
1817 tail_len = length - sizeof *oh;
1818 tail = ofpbuf_put_uninit(&b, tail_len);
1819 n = fread(tail, 1, tail_len, file);
1821 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1824 ofp_print(stdout, b.data, b.size, verbosity + 2);
1828 if (file != stdin) {
1834 ofctl_ping(int argc, char *argv[])
1836 size_t max_payload = 65535 - sizeof(struct ofp_header);
1837 unsigned int payload;
1838 struct vconn *vconn;
1841 payload = argc > 2 ? atoi(argv[2]) : 64;
1842 if (payload > max_payload) {
1843 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1846 open_vconn(argv[1], &vconn);
1847 for (i = 0; i < 10; i++) {
1848 struct timeval start, end;
1849 struct ofpbuf *request, *reply;
1850 const struct ofp_header *rpy_hdr;
1853 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1854 vconn_get_version(vconn), payload);
1855 random_bytes(ofpbuf_put_uninit(request, payload), payload);
1857 xgettimeofday(&start);
1858 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1859 xgettimeofday(&end);
1861 rpy_hdr = reply->data;
1862 if (ofptype_pull(&type, reply)
1863 || type != OFPTYPE_ECHO_REPLY
1864 || reply->size != payload
1865 || memcmp(request->l3, reply->l3, payload)) {
1866 printf("Reply does not match request. Request:\n");
1867 ofp_print(stdout, request, request->size, verbosity + 2);
1869 ofp_print(stdout, reply, reply->size, verbosity + 2);
1871 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1872 reply->size, argv[1], ntohl(rpy_hdr->xid),
1873 (1000*(double)(end.tv_sec - start.tv_sec))
1874 + (.001*(end.tv_usec - start.tv_usec)));
1875 ofpbuf_delete(request);
1876 ofpbuf_delete(reply);
1882 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
1884 size_t max_payload = 65535 - sizeof(struct ofp_header);
1885 struct timeval start, end;
1886 unsigned int payload_size, message_size;
1887 struct vconn *vconn;
1892 payload_size = atoi(argv[2]);
1893 if (payload_size > max_payload) {
1894 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1896 message_size = sizeof(struct ofp_header) + payload_size;
1898 count = atoi(argv[3]);
1900 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1901 count, message_size, count * message_size);
1903 open_vconn(argv[1], &vconn);
1904 xgettimeofday(&start);
1905 for (i = 0; i < count; i++) {
1906 struct ofpbuf *request, *reply;
1908 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1909 vconn_get_version(vconn), payload_size);
1910 ofpbuf_put_zeros(request, payload_size);
1911 run(vconn_transact(vconn, request, &reply), "transact");
1912 ofpbuf_delete(reply);
1914 xgettimeofday(&end);
1917 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1918 + (.001*(end.tv_usec - start.tv_usec)));
1919 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1920 duration, count / (duration / 1000.0),
1921 count * message_size / (duration / 1000.0));
1925 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
1928 struct ofputil_group_mod *gm;
1929 struct ofpbuf *request;
1931 struct vconn *vconn;
1934 open_vconn(remote, &vconn);
1936 for (i = 0; i < n_gms; i++) {
1938 request = ofputil_encode_group_mod(vconn_get_version(vconn), gm);
1940 transact_noreply(vconn, request);
1950 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1952 struct ofputil_group_mod *gms = NULL;
1953 enum ofputil_protocol usable_protocols;
1957 error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
1960 ovs_fatal(0, "%s", error);
1962 ofctl_group_mod__(argv[1], gms, n_gms);
1967 ofctl_group_mod(int argc, char *argv[], uint16_t command)
1969 if (argc > 2 && !strcmp(argv[2], "-")) {
1970 ofctl_group_mod_file(argc, argv, command);
1972 enum ofputil_protocol usable_protocols;
1973 struct ofputil_group_mod gm;
1976 error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
1979 ovs_fatal(0, "%s", error);
1981 ofctl_group_mod__(argv[1], &gm, 1);
1986 ofctl_add_group(int argc, char *argv[])
1988 ofctl_group_mod(argc, argv, OFPGC11_ADD);
1992 ofctl_add_groups(int argc, char *argv[])
1994 ofctl_group_mod_file(argc, argv, OFPGC11_ADD);
1998 ofctl_mod_group(int argc, char *argv[])
2000 ofctl_group_mod(argc, argv, OFPGC11_MODIFY);
2004 ofctl_del_groups(int argc, char *argv[])
2006 ofctl_group_mod(argc, argv, OFPGC11_DELETE);
2010 ofctl_dump_group_stats(int argc, char *argv[])
2012 enum ofputil_protocol usable_protocols;
2013 struct ofputil_group_mod gm;
2014 struct ofpbuf *request;
2015 struct vconn *vconn;
2019 memset(&gm, 0, sizeof gm);
2021 error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2022 argc > 2 ? argv[2] : "",
2025 ovs_fatal(0, "%s", error);
2028 group_id = gm.group_id;
2030 open_vconn(argv[1], &vconn);
2031 request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2034 dump_stats_transaction(vconn, request);
2041 ofctl_dump_group_desc(int argc OVS_UNUSED, char *argv[])
2043 struct ofpbuf *request;
2044 struct vconn *vconn;
2046 open_vconn(argv[1], &vconn);
2048 request = ofputil_encode_group_desc_request(vconn_get_version(vconn));
2050 dump_stats_transaction(vconn, request);
2057 ofctl_dump_group_features(int argc OVS_UNUSED, char *argv[])
2059 struct ofpbuf *request;
2060 struct vconn *vconn;
2062 open_vconn(argv[1], &vconn);
2063 request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2065 dump_stats_transaction(vconn, request);
2072 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2077 /* replace-flows and diff-flows commands. */
2079 /* A flow table entry, possibly with two different versions. */
2081 struct cls_rule rule; /* Within a "struct classifier". */
2082 struct fte_version *versions[2];
2085 /* One version of a Flow Table Entry. */
2086 struct fte_version {
2088 uint16_t idle_timeout;
2089 uint16_t hard_timeout;
2091 struct ofpact *ofpacts;
2095 /* Frees 'version' and the data that it owns. */
2097 fte_version_free(struct fte_version *version)
2100 free(version->ofpacts);
2105 /* Returns true if 'a' and 'b' are the same, false if they differ.
2107 * Ignores differences in 'flags' because there's no way to retrieve flags from
2108 * an OpenFlow switch. We have to assume that they are the same. */
2110 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2112 return (a->cookie == b->cookie
2113 && a->idle_timeout == b->idle_timeout
2114 && a->hard_timeout == b->hard_timeout
2115 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2116 b->ofpacts, b->ofpacts_len));
2119 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2120 * 'index' into 's', followed by a new-line. */
2122 fte_version_format(const struct fte *fte, int index, struct ds *s)
2124 const struct fte_version *version = fte->versions[index];
2131 cls_rule_format(&fte->rule, s);
2132 if (version->cookie != htonll(0)) {
2133 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2135 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2136 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2138 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2139 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2142 ds_put_cstr(s, " actions=");
2143 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2145 ds_put_char(s, '\n');
2149 fte_from_cls_rule(const struct cls_rule *cls_rule)
2151 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2154 /* Frees 'fte' and its versions. */
2156 fte_free(struct fte *fte)
2159 fte_version_free(fte->versions[0]);
2160 fte_version_free(fte->versions[1]);
2161 cls_rule_destroy(&fte->rule);
2166 /* Frees all of the FTEs within 'cls'. */
2168 fte_free_all(struct classifier *cls)
2170 struct cls_cursor cursor;
2171 struct fte *fte, *next;
2173 ovs_rwlock_wrlock(&cls->rwlock);
2174 cls_cursor_init(&cursor, cls, NULL);
2175 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
2176 classifier_remove(cls, &fte->rule);
2179 ovs_rwlock_unlock(&cls->rwlock);
2180 classifier_destroy(cls);
2183 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
2184 * necessary. Sets 'version' as the version of that rule with the given
2185 * 'index', replacing any existing version, if any.
2187 * Takes ownership of 'version'. */
2189 fte_insert(struct classifier *cls, const struct match *match,
2190 unsigned int priority, struct fte_version *version, int index)
2192 struct fte *old, *fte;
2194 fte = xzalloc(sizeof *fte);
2195 cls_rule_init(&fte->rule, match, priority);
2196 fte->versions[index] = version;
2198 ovs_rwlock_wrlock(&cls->rwlock);
2199 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
2200 ovs_rwlock_unlock(&cls->rwlock);
2202 fte_version_free(old->versions[index]);
2203 fte->versions[!index] = old->versions[!index];
2204 cls_rule_destroy(&old->rule);
2209 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
2210 * with the specified 'index'. Returns the flow formats able to represent the
2211 * flows that were read. */
2212 static enum ofputil_protocol
2213 read_flows_from_file(const char *filename, struct classifier *cls, int index)
2215 enum ofputil_protocol usable_protocols;
2220 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2222 ovs_fatal(errno, "%s: open", filename);
2226 usable_protocols = OFPUTIL_P_ANY;
2228 while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2229 struct fte_version *version;
2230 struct ofputil_flow_mod fm;
2232 enum ofputil_protocol usable;
2234 error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable,
2235 !(allowed_protocols & OFPUTIL_P_OF10_ANY));
2237 ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2239 usable_protocols &= usable;
2241 version = xmalloc(sizeof *version);
2242 version->cookie = fm.new_cookie;
2243 version->idle_timeout = fm.idle_timeout;
2244 version->hard_timeout = fm.hard_timeout;
2245 version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2246 | OFPUTIL_FF_EMERG);
2247 version->ofpacts = fm.ofpacts;
2248 version->ofpacts_len = fm.ofpacts_len;
2250 fte_insert(cls, &fm.match, fm.priority, version, index);
2254 if (file != stdin) {
2258 return usable_protocols;
2262 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2263 struct ofpbuf **replyp,
2264 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2266 struct ofpbuf *reply = *replyp;
2272 /* Get a flow stats reply message, if we don't already have one. */
2278 run(vconn_recv_block(vconn, &reply),
2279 "OpenFlow packet receive failed");
2280 } while (((struct ofp_header *) reply->data)->xid != send_xid);
2282 error = ofptype_decode(&type, reply->data);
2283 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2284 ovs_fatal(0, "received bad reply: %s",
2285 ofp_to_string(reply->data, reply->size,
2290 /* Pull an individual flow stats reply out of the message. */
2291 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2298 more = ofpmp_more(reply->l2);
2299 ofpbuf_delete(reply);
2308 ovs_fatal(0, "parse error in reply (%s)",
2309 ofperr_to_string(retval));
2314 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2315 * format 'protocol', and adds them as flow table entries in 'cls' for the
2316 * version with the specified 'index'. */
2318 read_flows_from_switch(struct vconn *vconn,
2319 enum ofputil_protocol protocol,
2320 struct classifier *cls, int index)
2322 struct ofputil_flow_stats_request fsr;
2323 struct ofputil_flow_stats fs;
2324 struct ofpbuf *request;
2325 struct ofpbuf ofpacts;
2326 struct ofpbuf *reply;
2329 fsr.aggregate = false;
2330 match_init_catchall(&fsr.match);
2331 fsr.out_port = OFPP_ANY;
2332 fsr.table_id = 0xff;
2333 fsr.cookie = fsr.cookie_mask = htonll(0);
2334 request = ofputil_encode_flow_stats_request(&fsr, protocol);
2335 send_xid = ((struct ofp_header *) request->data)->xid;
2336 send_openflow_buffer(vconn, request);
2339 ofpbuf_init(&ofpacts, 0);
2340 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2341 struct fte_version *version;
2343 version = xmalloc(sizeof *version);
2344 version->cookie = fs.cookie;
2345 version->idle_timeout = fs.idle_timeout;
2346 version->hard_timeout = fs.hard_timeout;
2348 version->ofpacts_len = fs.ofpacts_len;
2349 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2351 fte_insert(cls, &fs.match, fs.priority, version, index);
2353 ofpbuf_uninit(&ofpacts);
2357 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2358 enum ofputil_protocol protocol, struct list *packets)
2360 const struct fte_version *version = fte->versions[index];
2361 struct ofputil_flow_mod fm;
2364 minimatch_expand(&fte->rule.match, &fm.match);
2365 fm.priority = fte->rule.priority;
2366 fm.cookie = htonll(0);
2367 fm.cookie_mask = htonll(0);
2368 fm.new_cookie = version->cookie;
2369 fm.modify_cookie = true;
2371 fm.command = command;
2372 fm.idle_timeout = version->idle_timeout;
2373 fm.hard_timeout = version->hard_timeout;
2374 fm.buffer_id = UINT32_MAX;
2375 fm.out_port = OFPP_ANY;
2376 fm.flags = version->flags;
2377 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2378 command == OFPFC_MODIFY_STRICT) {
2379 fm.ofpacts = version->ofpacts;
2380 fm.ofpacts_len = version->ofpacts_len;
2386 ofm = ofputil_encode_flow_mod(&fm, protocol);
2387 list_push_back(packets, &ofm->list_node);
2391 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
2393 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2394 enum ofputil_protocol usable_protocols, protocol;
2395 struct cls_cursor cursor;
2396 struct classifier cls;
2397 struct list requests;
2398 struct vconn *vconn;
2401 classifier_init(&cls);
2402 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2404 protocol = open_vconn(argv[1], &vconn);
2405 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2407 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2409 list_init(&requests);
2411 /* Delete flows that exist on the switch but not in the file. */
2412 ovs_rwlock_rdlock(&cls.rwlock);
2413 cls_cursor_init(&cursor, &cls, NULL);
2414 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2415 struct fte_version *file_ver = fte->versions[FILE_IDX];
2416 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2418 if (sw_ver && !file_ver) {
2419 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2420 protocol, &requests);
2424 /* Add flows that exist in the file but not on the switch.
2425 * Update flows that exist in both places but differ. */
2426 cls_cursor_init(&cursor, &cls, NULL);
2427 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2428 struct fte_version *file_ver = fte->versions[FILE_IDX];
2429 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2432 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2433 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2436 ovs_rwlock_unlock(&cls.rwlock);
2437 transact_multiple_noreply(vconn, &requests);
2444 read_flows_from_source(const char *source, struct classifier *cls, int index)
2448 if (source[0] == '/' || source[0] == '.'
2449 || (!strchr(source, ':') && !stat(source, &s))) {
2450 read_flows_from_file(source, cls, index);
2452 enum ofputil_protocol protocol;
2453 struct vconn *vconn;
2455 protocol = open_vconn(source, &vconn);
2456 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2457 read_flows_from_switch(vconn, protocol, cls, index);
2463 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2465 bool differences = false;
2466 struct cls_cursor cursor;
2467 struct classifier cls;
2471 classifier_init(&cls);
2472 read_flows_from_source(argv[1], &cls, 0);
2473 read_flows_from_source(argv[2], &cls, 1);
2478 ovs_rwlock_rdlock(&cls.rwlock);
2479 cls_cursor_init(&cursor, &cls, NULL);
2480 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2481 struct fte_version *a = fte->versions[0];
2482 struct fte_version *b = fte->versions[1];
2484 if (!a || !b || !fte_version_equals(a, b)) {
2485 fte_version_format(fte, 0, &a_s);
2486 fte_version_format(fte, 1, &b_s);
2487 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2489 printf("-%s", ds_cstr(&a_s));
2492 printf("+%s", ds_cstr(&b_s));
2498 ovs_rwlock_unlock(&cls.rwlock);
2511 ofctl_meter_mod__(const char *bridge, const char *str, int command)
2513 struct ofputil_meter_mod mm;
2514 struct vconn *vconn;
2515 enum ofputil_protocol protocol;
2516 enum ofputil_protocol usable_protocols;
2517 enum ofp_version version;
2521 error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
2523 ovs_fatal(0, "%s", error);
2526 usable_protocols = OFPUTIL_P_OF13_UP;
2527 mm.command = command;
2528 mm.meter.meter_id = OFPM13_ALL;
2531 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2532 version = ofputil_protocol_to_ofp_version(protocol);
2533 transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
2538 ofctl_meter_request__(const char *bridge, const char *str,
2539 enum ofputil_meter_request_type type)
2541 struct ofputil_meter_mod mm;
2542 struct vconn *vconn;
2543 enum ofputil_protocol usable_protocols;
2544 enum ofputil_protocol protocol;
2545 enum ofp_version version;
2549 error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
2551 ovs_fatal(0, "%s", error);
2554 usable_protocols = OFPUTIL_P_OF13_UP;
2555 mm.meter.meter_id = OFPM13_ALL;
2558 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2559 version = ofputil_protocol_to_ofp_version(protocol);
2560 transact_noreply(vconn, ofputil_encode_meter_request(version,
2562 mm.meter.meter_id));
2568 ofctl_add_meter(int argc OVS_UNUSED, char *argv[])
2570 ofctl_meter_mod__(argv[1], argv[2], OFPMC13_ADD);
2574 ofctl_mod_meter(int argc OVS_UNUSED, char *argv[])
2576 ofctl_meter_mod__(argv[1], argv[2], OFPMC13_MODIFY);
2580 ofctl_del_meters(int argc, char *argv[])
2582 ofctl_meter_mod__(argv[1], argc > 2 ? argv[2] : NULL, OFPMC13_DELETE);
2586 ofctl_dump_meters(int argc, char *argv[])
2588 ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2589 OFPUTIL_METER_CONFIG);
2593 ofctl_meter_stats(int argc, char *argv[])
2595 ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2596 OFPUTIL_METER_STATS);
2600 ofctl_meter_features(int argc OVS_UNUSED, char *argv[])
2602 ofctl_meter_request__(argv[1], NULL, OFPUTIL_METER_FEATURES);
2606 /* Undocumented commands for unit testing. */
2609 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
2610 enum ofputil_protocol usable_protocols)
2612 enum ofputil_protocol protocol = 0;
2616 usable_s = ofputil_protocols_to_string(usable_protocols);
2617 printf("usable protocols: %s\n", usable_s);
2620 if (!(usable_protocols & allowed_protocols)) {
2621 ovs_fatal(0, "no usable protocol");
2623 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2625 if (protocol & usable_protocols & allowed_protocols) {
2629 ovs_assert(is_pow2(protocol));
2631 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2633 for (i = 0; i < n_fms; i++) {
2634 struct ofputil_flow_mod *fm = &fms[i];
2637 msg = ofputil_encode_flow_mod(fm, protocol);
2638 ofp_print(stdout, msg->data, msg->size, verbosity);
2645 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2646 * it back to stdout. */
2648 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2650 enum ofputil_protocol usable_protocols;
2651 struct ofputil_flow_mod fm;
2654 error = parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, &usable_protocols,
2655 !(allowed_protocols & OFPUTIL_P_OF10_ANY));
2657 ovs_fatal(0, "%s", error);
2659 ofctl_parse_flows__(&fm, 1, usable_protocols);
2662 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2663 * add-flows) and prints each of the flows back to stdout. */
2665 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2667 enum ofputil_protocol usable_protocols;
2668 struct ofputil_flow_mod *fms = NULL;
2672 error = parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms,
2674 !(allowed_protocols & OFPUTIL_P_OF10_ANY));
2676 ovs_fatal(0, "%s", error);
2678 ofctl_parse_flows__(fms, n_fms, usable_protocols);
2683 ofctl_parse_nxm__(bool oxm)
2688 while (!ds_get_test_line(&in, stdin)) {
2689 struct ofpbuf nx_match;
2691 ovs_be64 cookie, cookie_mask;
2695 /* Convert string to nx_match. */
2696 ofpbuf_init(&nx_match, 0);
2698 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2700 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2703 /* Convert nx_match to match. */
2706 error = oxm_pull_match(&nx_match, &match);
2708 error = nx_pull_match(&nx_match, match_len, &match,
2709 &cookie, &cookie_mask);
2713 error = oxm_pull_match_loose(&nx_match, &match);
2715 error = nx_pull_match_loose(&nx_match, match_len, &match,
2716 &cookie, &cookie_mask);
2724 /* Convert match back to nx_match. */
2725 ofpbuf_uninit(&nx_match);
2726 ofpbuf_init(&nx_match, 0);
2728 match_len = oxm_put_match(&nx_match, &match);
2729 out = oxm_match_to_string(&nx_match, match_len);
2731 match_len = nx_put_match(&nx_match, &match,
2732 cookie, cookie_mask);
2733 out = nx_match_to_string(nx_match.data, match_len);
2739 printf("nx_pull_match() returned error %s\n",
2740 ofperr_get_name(error));
2743 ofpbuf_uninit(&nx_match);
2748 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2749 * stdin, does some internal fussing with them, and then prints them back as
2750 * strings on stdout. */
2752 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2754 return ofctl_parse_nxm__(false);
2757 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2758 * stdin, does some internal fussing with them, and then prints them back as
2759 * strings on stdout. */
2761 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2763 return ofctl_parse_nxm__(true);
2767 print_differences(const char *prefix,
2768 const void *a_, size_t a_len,
2769 const void *b_, size_t b_len)
2771 const uint8_t *a = a_;
2772 const uint8_t *b = b_;
2775 for (i = 0; i < MIN(a_len, b_len); i++) {
2777 printf("%s%2zu: %02"PRIx8" -> %02"PRIx8"\n",
2778 prefix, i, a[i], b[i]);
2781 for (i = a_len; i < b_len; i++) {
2782 printf("%s%2zu: (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2784 for (i = b_len; i < a_len; i++) {
2785 printf("%s%2zu: %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2789 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2790 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2791 * on stdout, and then converts them back to hex bytes and prints any
2792 * differences from the input. */
2794 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2799 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2800 struct ofpbuf of10_out;
2801 struct ofpbuf of10_in;
2802 struct ofpbuf ofpacts;
2807 /* Parse hex bytes. */
2808 ofpbuf_init(&of10_in, 0);
2809 if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2810 ovs_fatal(0, "Trailing garbage in hex data");
2813 /* Convert to ofpacts. */
2814 ofpbuf_init(&ofpacts, 0);
2815 size = of10_in.size;
2816 error = ofpacts_pull_openflow_actions(&of10_in, of10_in.size,
2817 OFP10_VERSION, &ofpacts);
2819 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2820 ofpbuf_uninit(&ofpacts);
2821 ofpbuf_uninit(&of10_in);
2824 ofpbuf_push_uninit(&of10_in, size);
2826 /* Print cls_rule. */
2828 ds_put_cstr(&s, "actions=");
2829 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2833 /* Convert back to ofp10 actions and print differences from input. */
2834 ofpbuf_init(&of10_out, 0);
2835 ofpacts_put_openflow_actions(ofpacts.data, ofpacts.size, &of10_out,
2838 print_differences("", of10_in.data, of10_in.size,
2839 of10_out.data, of10_out.size);
2842 ofpbuf_uninit(&ofpacts);
2843 ofpbuf_uninit(&of10_in);
2844 ofpbuf_uninit(&of10_out);
2849 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2850 * bytes from stdin, converts them to cls_rules, prints them as strings on
2851 * stdout, and then converts them back to hex bytes and prints any differences
2854 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
2855 * values are ignored in the input and will be set to zero when OVS converts
2856 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
2857 * it does the conversion to hex, to ensure that in fact they are ignored. */
2859 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2866 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2867 struct ofpbuf match_in, match_expout;
2868 struct ofp10_match match_out;
2869 struct ofp10_match match_normal;
2873 /* Parse hex bytes to use for expected output. */
2875 ds_put_cstr(&expout, ds_cstr(&in));
2876 for (p = ds_cstr(&expout); *p; p++) {
2881 ofpbuf_init(&match_expout, 0);
2882 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
2883 ovs_fatal(0, "Trailing garbage in hex data");
2885 if (match_expout.size != sizeof(struct ofp10_match)) {
2886 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2887 match_expout.size, sizeof(struct ofp10_match));
2890 /* Parse hex bytes for input. */
2891 for (p = ds_cstr(&in); *p; p++) {
2893 *p = "0123456789abcdef"[random_uint32() & 0xf];
2896 ofpbuf_init(&match_in, 0);
2897 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2898 ovs_fatal(0, "Trailing garbage in hex data");
2900 if (match_in.size != sizeof(struct ofp10_match)) {
2901 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2902 match_in.size, sizeof(struct ofp10_match));
2905 /* Convert to cls_rule and print. */
2906 ofputil_match_from_ofp10_match(match_in.data, &match);
2907 match_print(&match);
2909 /* Convert back to ofp10_match and print differences from input. */
2910 ofputil_match_to_ofp10_match(&match, &match_out);
2911 print_differences("", match_expout.data, match_expout.size,
2912 &match_out, sizeof match_out);
2914 /* Normalize, then convert and compare again. */
2915 ofputil_normalize_match(&match);
2916 ofputil_match_to_ofp10_match(&match, &match_normal);
2917 print_differences("normal: ", &match_out, sizeof match_out,
2918 &match_normal, sizeof match_normal);
2921 ofpbuf_uninit(&match_in);
2922 ofpbuf_uninit(&match_expout);
2925 ds_destroy(&expout);
2928 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2929 * bytes from stdin, converts them to "struct match"es, prints them as strings
2930 * on stdout, and then converts them back to hex bytes and prints any
2931 * differences from the input. */
2933 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2938 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2939 struct ofpbuf match_in;
2940 struct ofp11_match match_out;
2944 /* Parse hex bytes. */
2945 ofpbuf_init(&match_in, 0);
2946 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2947 ovs_fatal(0, "Trailing garbage in hex data");
2949 if (match_in.size != sizeof(struct ofp11_match)) {
2950 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2951 match_in.size, sizeof(struct ofp11_match));
2954 /* Convert to match. */
2955 error = ofputil_match_from_ofp11_match(match_in.data, &match);
2957 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
2958 ofpbuf_uninit(&match_in);
2963 match_print(&match);
2965 /* Convert back to ofp11_match and print differences from input. */
2966 ofputil_match_to_ofp11_match(&match, &match_out);
2968 print_differences("", match_in.data, match_in.size,
2969 &match_out, sizeof match_out);
2972 ofpbuf_uninit(&match_in);
2977 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2978 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2979 * on stdout, and then converts them back to hex bytes and prints any
2980 * differences from the input. */
2982 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2987 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2988 struct ofpbuf of11_out;
2989 struct ofpbuf of11_in;
2990 struct ofpbuf ofpacts;
2995 /* Parse hex bytes. */
2996 ofpbuf_init(&of11_in, 0);
2997 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2998 ovs_fatal(0, "Trailing garbage in hex data");
3001 /* Convert to ofpacts. */
3002 ofpbuf_init(&ofpacts, 0);
3003 size = of11_in.size;
3004 error = ofpacts_pull_openflow_actions(&of11_in, of11_in.size,
3005 OFP11_VERSION, &ofpacts);
3007 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
3008 ofpbuf_uninit(&ofpacts);
3009 ofpbuf_uninit(&of11_in);
3012 ofpbuf_push_uninit(&of11_in, size);
3014 /* Print cls_rule. */
3016 ds_put_cstr(&s, "actions=");
3017 ofpacts_format(ofpacts.data, ofpacts.size, &s);
3021 /* Convert back to ofp11 actions and print differences from input. */
3022 ofpbuf_init(&of11_out, 0);
3023 ofpacts_put_openflow_actions(ofpacts.data, ofpacts.size, &of11_out,
3026 print_differences("", of11_in.data, of11_in.size,
3027 of11_out.data, of11_out.size);
3030 ofpbuf_uninit(&ofpacts);
3031 ofpbuf_uninit(&of11_in);
3032 ofpbuf_uninit(&of11_out);
3037 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
3038 * specifications as hex bytes from stdin, converts them to ofpacts, prints
3039 * them as strings on stdout, and then converts them back to hex bytes and
3040 * prints any differences from the input. */
3042 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3047 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3048 struct ofpbuf of11_out;
3049 struct ofpbuf of11_in;
3050 struct ofpbuf ofpacts;
3054 const char *table_id;
3057 /* Parse table_id separated with the follow-up instructions by ",", if
3059 instructions = ds_cstr(&in);
3061 if (strstr(instructions, ",")) {
3062 table_id = strsep(&instructions, ",");
3065 /* Parse hex bytes. */
3066 ofpbuf_init(&of11_in, 0);
3067 if (ofpbuf_put_hex(&of11_in, instructions, NULL)[0] != '\0') {
3068 ovs_fatal(0, "Trailing garbage in hex data");
3071 /* Convert to ofpacts. */
3072 ofpbuf_init(&ofpacts, 0);
3073 size = of11_in.size;
3074 error = ofpacts_pull_openflow_instructions(&of11_in, of11_in.size,
3075 OFP11_VERSION, &ofpacts);
3077 /* Verify actions, enforce consistency. */
3079 memset(&flow, 0, sizeof flow);
3080 error = ofpacts_check(ofpacts.data, ofpacts.size, &flow,
3082 table_id ? atoi(table_id) : 0, 255);
3085 printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
3086 ofpbuf_uninit(&ofpacts);
3087 ofpbuf_uninit(&of11_in);
3090 ofpbuf_push_uninit(&of11_in, size);
3092 /* Print cls_rule. */
3094 ds_put_cstr(&s, "actions=");
3095 ofpacts_format(ofpacts.data, ofpacts.size, &s);
3099 /* Convert back to ofp11 instructions and print differences from
3101 ofpbuf_init(&of11_out, 0);
3102 ofpacts_put_openflow_instructions(ofpacts.data, ofpacts.size,
3103 &of11_out, OFP13_VERSION);
3105 print_differences("", of11_in.data, of11_in.size,
3106 of11_out.data, of11_out.size);
3109 ofpbuf_uninit(&ofpacts);
3110 ofpbuf_uninit(&of11_in);
3111 ofpbuf_uninit(&of11_out);
3116 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3118 ofctl_parse_pcap(int argc OVS_UNUSED, char *argv[])
3122 pcap = pcap_open(argv[1], "rb");
3124 ovs_fatal(errno, "%s: open failed", argv[1]);
3128 struct ofpbuf *packet;
3132 error = pcap_read(pcap, &packet);
3136 ovs_fatal(error, "%s: read failed", argv[1]);
3139 flow_extract(packet, 0, 0, NULL, NULL, &flow);
3140 flow_print(stdout, &flow);
3142 ofpbuf_delete(packet);
3146 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3147 * mask values to and from various formats and prints the results. */
3149 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
3154 struct ofputil_flow_mod fm;
3157 struct match nxm_match;
3161 struct ofp10_match of10_raw;
3162 struct match of10_match;
3164 struct ofp11_match of11_raw;
3165 struct match of11_match;
3170 enum ofputil_protocol usable_protocols; /* Unused for now. */
3172 match_init_catchall(&match);
3173 match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
3174 match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
3176 /* Convert to and from string. */
3177 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3178 printf("%s -> ", string_s);
3180 error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols,
3181 !(allowed_protocols & OFPUTIL_P_OF10_ANY));
3183 ovs_fatal(0, "%s", error_s);
3185 printf("%04"PRIx16"/%04"PRIx16"\n",
3186 ntohs(fm.match.flow.vlan_tci),
3187 ntohs(fm.match.wc.masks.vlan_tci));
3190 /* Convert to and from NXM. */
3191 ofpbuf_init(&nxm, 0);
3192 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3193 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
3194 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3195 printf("NXM: %s -> ", nxm_s);
3197 printf("%s\n", ofperr_to_string(error));
3199 printf("%04"PRIx16"/%04"PRIx16"\n",
3200 ntohs(nxm_match.flow.vlan_tci),
3201 ntohs(nxm_match.wc.masks.vlan_tci));
3204 ofpbuf_uninit(&nxm);
3206 /* Convert to and from OXM. */
3207 ofpbuf_init(&nxm, 0);
3208 nxm_match_len = oxm_put_match(&nxm, &match);
3209 nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3210 error = oxm_pull_match(&nxm, &nxm_match);
3211 printf("OXM: %s -> ", nxm_s);
3213 printf("%s\n", ofperr_to_string(error));
3215 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3216 (VLAN_VID_MASK | VLAN_CFI);
3217 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3218 (VLAN_VID_MASK | VLAN_CFI);
3220 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3221 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3222 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3228 ofpbuf_uninit(&nxm);
3230 /* Convert to and from OpenFlow 1.0. */
3231 ofputil_match_to_ofp10_match(&match, &of10_raw);
3232 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3233 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3234 ntohs(of10_raw.dl_vlan),
3235 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3236 of10_raw.dl_vlan_pcp,
3237 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3238 ntohs(of10_match.flow.vlan_tci),
3239 ntohs(of10_match.wc.masks.vlan_tci));
3241 /* Convert to and from OpenFlow 1.1. */
3242 ofputil_match_to_ofp11_match(&match, &of11_raw);
3243 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3244 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3245 ntohs(of11_raw.dl_vlan),
3246 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3247 of11_raw.dl_vlan_pcp,
3248 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3249 ntohs(of11_match.flow.vlan_tci),
3250 ntohs(of11_match.wc.masks.vlan_tci));
3253 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3256 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
3261 error = ofperr_from_name(argv[1]);
3263 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3266 for (version = 0; version <= UINT8_MAX; version++) {
3267 const char *name = ofperr_domain_get_name(version);
3269 int vendor = ofperr_get_vendor(error, version);
3270 int type = ofperr_get_type(error, version);
3271 int code = ofperr_get_code(error, version);
3273 if (vendor != -1 || type != -1 || code != -1) {
3274 printf("%s: vendor %#x, type %d, code %d\n",
3275 name, vendor, type, code);
3281 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3282 * error named ENUM and prints the error reply in hex. */
3284 ofctl_encode_error_reply(int argc OVS_UNUSED, char *argv[])
3286 const struct ofp_header *oh;
3287 struct ofpbuf request, *reply;
3290 error = ofperr_from_name(argv[1]);
3292 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3295 ofpbuf_init(&request, 0);
3296 if (ofpbuf_put_hex(&request, argv[2], NULL)[0] != '\0') {
3297 ovs_fatal(0, "Trailing garbage in hex data");
3299 if (request.size < sizeof(struct ofp_header)) {
3300 ovs_fatal(0, "Request too short");
3304 if (request.size != ntohs(oh->length)) {
3305 ovs_fatal(0, "Request size inconsistent");
3308 reply = ofperr_encode_reply(error, request.data);
3309 ofpbuf_uninit(&request);
3311 ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
3312 ofpbuf_delete(reply);
3315 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3316 * binary data, interpreting them as an OpenFlow message, and prints the
3317 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
3319 ofctl_ofp_print(int argc, char *argv[])
3321 struct ofpbuf packet;
3323 ofpbuf_init(&packet, strlen(argv[1]) / 2);
3324 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
3325 ovs_fatal(0, "trailing garbage following hex bytes");
3327 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
3328 ofpbuf_uninit(&packet);
3331 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3332 * and dumps each message in hex. */
3334 ofctl_encode_hello(int argc OVS_UNUSED, char *argv[])
3336 uint32_t bitmap = strtol(argv[1], NULL, 0);
3337 struct ofpbuf *hello;
3339 hello = ofputil_encode_hello(bitmap);
3340 ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
3341 ofp_print(stdout, hello->data, hello->size, verbosity);
3342 ofpbuf_delete(hello);
3345 static const struct command all_commands[] = {
3346 { "show", 1, 1, ofctl_show },
3347 { "monitor", 1, 3, ofctl_monitor },
3348 { "snoop", 1, 1, ofctl_snoop },
3349 { "dump-desc", 1, 1, ofctl_dump_desc },
3350 { "dump-tables", 1, 1, ofctl_dump_tables },
3351 { "dump-flows", 1, 2, ofctl_dump_flows },
3352 { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
3353 { "queue-stats", 1, 3, ofctl_queue_stats },
3354 { "queue-get-config", 2, 2, ofctl_queue_get_config },
3355 { "add-flow", 2, 2, ofctl_add_flow },
3356 { "add-flows", 2, 2, ofctl_add_flows },
3357 { "mod-flows", 2, 2, ofctl_mod_flows },
3358 { "del-flows", 1, 2, ofctl_del_flows },
3359 { "replace-flows", 2, 2, ofctl_replace_flows },
3360 { "diff-flows", 2, 2, ofctl_diff_flows },
3361 { "add-meter", 2, 2, ofctl_add_meter },
3362 { "mod-meter", 2, 2, ofctl_mod_meter },
3363 { "del-meter", 2, 2, ofctl_del_meters },
3364 { "del-meters", 1, 1, ofctl_del_meters },
3365 { "dump-meter", 2, 2, ofctl_dump_meters },
3366 { "dump-meters", 1, 1, ofctl_dump_meters },
3367 { "meter-stats", 1, 2, ofctl_meter_stats },
3368 { "meter-features", 1, 1, ofctl_meter_features },
3369 { "packet-out", 4, INT_MAX, ofctl_packet_out },
3370 { "dump-ports", 1, 2, ofctl_dump_ports },
3371 { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc },
3372 { "mod-port", 3, 3, ofctl_mod_port },
3373 { "mod-table", 3, 3, ofctl_mod_table },
3374 { "get-frags", 1, 1, ofctl_get_frags },
3375 { "set-frags", 2, 2, ofctl_set_frags },
3376 { "ofp-parse", 1, 1, ofctl_ofp_parse },
3377 { "probe", 1, 1, ofctl_probe },
3378 { "ping", 1, 2, ofctl_ping },
3379 { "benchmark", 3, 3, ofctl_benchmark },
3381 { "add-group", 1, 2, ofctl_add_group },
3382 { "add-groups", 1, 2, ofctl_add_groups },
3383 { "mod-group", 1, 2, ofctl_mod_group },
3384 { "del-groups", 1, 2, ofctl_del_groups },
3385 { "dump-groups", 1, 1, ofctl_dump_group_desc },
3386 { "dump-group-stats", 1, 2, ofctl_dump_group_stats },
3387 { "dump-group-features", 1, 1, ofctl_dump_group_features },
3388 { "help", 0, INT_MAX, ofctl_help },
3390 /* Undocumented commands for testing. */
3391 { "parse-flow", 1, 1, ofctl_parse_flow },
3392 { "parse-flows", 1, 1, ofctl_parse_flows },
3393 { "parse-nx-match", 0, 0, ofctl_parse_nxm },
3394 { "parse-nxm", 0, 0, ofctl_parse_nxm },
3395 { "parse-oxm", 0, 0, ofctl_parse_oxm },
3396 { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
3397 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
3398 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
3399 { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
3400 { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
3401 { "parse-pcap", 1, 1, ofctl_parse_pcap },
3402 { "check-vlan", 2, 2, ofctl_check_vlan },
3403 { "print-error", 1, 1, ofctl_print_error },
3404 { "encode-error-reply", 2, 2, ofctl_encode_error_reply },
3405 { "ofp-print", 1, 2, ofctl_ofp_print },
3406 { "encode-hello", 1, 1, ofctl_encode_hello },
3408 { NULL, 0, 0, NULL },
3411 static const struct command *get_all_commands(void)
3413 return all_commands;