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 "poll-loop.h"
55 #include "stream-ssl.h"
56 #include "socket-util.h"
62 #include "meta-flow.h"
65 VLOG_DEFINE_THIS_MODULE(ofctl);
67 /* --strict: Use strict matching for flow mod commands? Additionally governs
68 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
72 /* --readd: If true, on replace-flows, re-add even flows that have not changed
73 * (to reset flow counters). */
76 /* -F, --flow-format: Allowed protocols. By default, any protocol is
78 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
80 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
81 * commands. Either one of NXPIF_* to force a particular packet_in format, or
82 * -1 to let ovs-ofctl choose the default. */
83 static int preferred_packet_in_format = -1;
85 /* -m, --more: Additional verbosity for ofp-print functions. */
88 /* --timestamp: Print a timestamp before each received packet on "monitor" and
90 static bool timestamp;
92 /* --sort, --rsort: Sort order. */
93 enum sort_order { SORT_ASC, SORT_DESC };
94 struct sort_criterion {
95 const struct mf_field *field; /* NULL means to sort by priority. */
96 enum sort_order order;
98 static struct sort_criterion *criteria;
99 static size_t n_criteria, allocated_criteria;
101 static const struct command all_commands[];
103 static void usage(void) NO_RETURN;
104 static void parse_options(int argc, char *argv[]);
106 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
107 struct ofpbuf **replyp,
108 struct ofputil_flow_stats *,
109 struct ofpbuf *ofpacts);
111 main(int argc, char *argv[])
113 set_program_name(argv[0]);
114 parse_options(argc, argv);
115 signal(SIGPIPE, SIG_IGN);
116 run_command(argc - optind, argv + optind, all_commands);
121 add_sort_criterion(enum sort_order order, const char *field)
123 struct sort_criterion *sc;
125 if (n_criteria >= allocated_criteria) {
126 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
129 sc = &criteria[n_criteria++];
130 if (!field || !strcasecmp(field, "priority")) {
133 sc->field = mf_from_name(field);
135 ovs_fatal(0, "%s: unknown field name", field);
142 parse_options(int argc, char *argv[])
145 OPT_STRICT = UCHAR_MAX + 1,
151 OFP_VERSION_OPTION_ENUMS,
154 static const struct option long_options[] = {
155 {"timeout", required_argument, NULL, 't'},
156 {"strict", no_argument, NULL, OPT_STRICT},
157 {"readd", no_argument, NULL, OPT_READD},
158 {"flow-format", required_argument, NULL, 'F'},
159 {"packet-in-format", required_argument, NULL, 'P'},
160 {"more", no_argument, NULL, 'm'},
161 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
162 {"sort", optional_argument, NULL, OPT_SORT},
163 {"rsort", optional_argument, NULL, OPT_RSORT},
164 {"help", no_argument, NULL, 'h'},
166 OFP_VERSION_LONG_OPTIONS,
168 STREAM_SSL_LONG_OPTIONS,
171 char *short_options = long_options_to_short_options(long_options);
173 enum ofputil_protocol version_protocols;
176 unsigned long int timeout;
179 c = getopt_long(argc, argv, short_options, long_options, NULL);
186 timeout = strtoul(optarg, NULL, 10);
188 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
196 allowed_protocols = ofputil_protocols_from_string(optarg);
197 if (!allowed_protocols) {
198 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
203 preferred_packet_in_format =
204 ofputil_packet_in_format_from_string(optarg);
205 if (preferred_packet_in_format < 0) {
206 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
230 add_sort_criterion(SORT_ASC, optarg);
234 add_sort_criterion(SORT_DESC, optarg);
237 DAEMON_OPTION_HANDLERS
238 OFP_VERSION_OPTION_HANDLERS
240 STREAM_SSL_OPTION_HANDLERS
251 /* Always do a final sort pass based on priority. */
252 add_sort_criterion(SORT_DESC, "priority");
257 versions = get_allowed_ofp_versions();
258 version_protocols = ofputil_protocols_from_version_bitmap(versions);
259 if (!(allowed_protocols & version_protocols)) {
260 char *protocols = ofputil_protocols_to_string(allowed_protocols);
261 struct ds version_s = DS_EMPTY_INITIALIZER;
263 ofputil_format_version_bitmap_names(&version_s, versions);
264 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
265 "any of the enabled flow formats (%s). (Use -O to enable "
266 "additional OpenFlow versions or -F to enable additional "
267 "flow formats.)", ds_cstr(&version_s), protocols);
269 allowed_protocols &= version_protocols;
270 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
277 printf("%s: OpenFlow switch management utility\n"
278 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
279 "\nFor OpenFlow switches:\n"
280 " show SWITCH show OpenFlow information\n"
281 " dump-desc SWITCH print switch description\n"
282 " dump-tables SWITCH print table stats\n"
283 " mod-port SWITCH IFACE ACT modify port behavior\n"
284 " get-frags SWITCH print fragment handling behavior\n"
285 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
286 " dump-ports SWITCH [PORT] print port statistics\n"
287 " dump-ports-desc SWITCH print port descriptions\n"
288 " dump-flows SWITCH print all flow entries\n"
289 " dump-flows SWITCH FLOW print matching FLOWs\n"
290 " dump-aggregate SWITCH print aggregate flow statistics\n"
291 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
292 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
293 " add-flow SWITCH FLOW add flow described by FLOW\n"
294 " add-flows SWITCH FILE add flows from FILE\n"
295 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
296 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
297 " replace-flows SWITCH FILE replace flows with those in FILE\n"
298 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
299 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
300 " execute ACTIONS on PACKET\n"
301 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
302 " print packets received from SWITCH\n"
303 " snoop SWITCH snoop on SWITCH and its controller\n"
304 "\nFor OpenFlow switches and controllers:\n"
305 " probe TARGET probe whether TARGET is up\n"
306 " ping TARGET [N] latency of N-byte echos\n"
307 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
308 "where SWITCH or TARGET is an active OpenFlow connection method.\n",
309 program_name, program_name);
310 vconn_usage(true, false, false);
314 printf("\nOther options:\n"
315 " --strict use strict match for flow commands\n"
316 " --readd replace flows that haven't changed\n"
317 " -F, --flow-format=FORMAT force particular flow format\n"
318 " -P, --packet-in-format=FRMT force particular packet in format\n"
319 " -m, --more be more verbose printing OpenFlow\n"
320 " --timestamp (monitor, snoop) print timestamps\n"
321 " -t, --timeout=SECS give up after SECS seconds\n"
322 " --sort[=field] sort in ascending order\n"
323 " --rsort[=field] sort in descending order\n"
324 " -h, --help display this help message\n"
325 " -V, --version display version information\n");
330 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
331 const char *argv[] OVS_UNUSED, void *exiting_)
333 bool *exiting = exiting_;
335 unixctl_command_reply(conn, NULL);
338 static void run(int retval, const char *message, ...)
342 run(int retval, const char *message, ...)
347 va_start(args, message);
348 ovs_fatal_valist(retval, message, args);
352 /* Generic commands. */
355 open_vconn_socket(const char *name, struct vconn **vconnp)
357 char *vconn_name = xasprintf("unix:%s", name);
360 error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
362 if (error && error != ENOENT) {
363 ovs_fatal(0, "%s: failed to open socket (%s)", name,
364 ovs_strerror(error));
371 enum open_target { MGMT, SNOOP };
373 static enum ofputil_protocol
374 open_vconn__(const char *name, enum open_target target,
375 struct vconn **vconnp)
377 const char *suffix = target == MGMT ? "mgmt" : "snoop";
378 char *datapath_name, *datapath_type, *socket_name;
379 enum ofputil_protocol protocol;
384 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
386 ofproto_parse_name(name, &datapath_name, &datapath_type);
387 socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
391 if (strchr(name, ':')) {
392 run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
393 "connecting to %s", name);
394 } else if (!open_vconn_socket(name, vconnp)) {
396 } else if (!open_vconn_socket(bridge_path, vconnp)) {
398 } else if (!open_vconn_socket(socket_name, vconnp)) {
401 ovs_fatal(0, "%s is not a bridge or a socket", name);
404 if (target == SNOOP) {
405 vconn_set_recv_any_version(*vconnp);
411 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
412 error = vconn_connect_block(*vconnp);
414 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
415 ovs_strerror(error));
418 ofp_version = vconn_get_version(*vconnp);
419 protocol = ofputil_protocol_from_ofp_version(ofp_version);
421 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
427 static enum ofputil_protocol
428 open_vconn(const char *name, struct vconn **vconnp)
430 return open_vconn__(name, MGMT, vconnp);
434 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
436 ofpmsg_update_length(buffer);
437 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
441 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
443 struct ofpbuf *reply;
445 ofpmsg_update_length(request);
446 run(vconn_transact(vconn, request, &reply), "talking to %s",
447 vconn_get_name(vconn));
448 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
449 ofpbuf_delete(reply);
453 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
455 struct ofpbuf *request;
458 open_vconn(vconn_name, &vconn);
459 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
460 dump_transaction(vconn, request);
465 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
467 const struct ofp_header *request_oh = request->data;
468 ovs_be32 send_xid = request_oh->xid;
469 enum ofpraw request_raw;
470 enum ofpraw reply_raw;
473 ofpraw_decode_partial(&request_raw, request->data, request->size);
474 reply_raw = ofpraw_stats_request_to_reply(request_raw,
475 request_oh->version);
477 send_openflow_buffer(vconn, request);
480 struct ofpbuf *reply;
482 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
483 recv_xid = ((struct ofp_header *) reply->data)->xid;
484 if (send_xid == recv_xid) {
487 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
489 ofpraw_decode(&raw, reply->data);
490 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
492 } else if (raw == reply_raw) {
493 done = !ofpmp_more(reply->data);
495 ovs_fatal(0, "received bad reply: %s",
496 ofp_to_string(reply->data, reply->size,
500 VLOG_DBG("received reply with xid %08"PRIx32" "
501 "!= expected %08"PRIx32, recv_xid, send_xid);
503 ofpbuf_delete(reply);
508 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
510 struct ofpbuf *request;
513 open_vconn(vconn_name, &vconn);
514 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
515 dump_stats_transaction(vconn, request);
519 /* Sends all of the 'requests', which should be requests that only have replies
520 * if an error occurs, and waits for them to succeed or fail. If an error does
521 * occur, prints it and exits with an error.
523 * Destroys all of the 'requests'. */
525 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
527 struct ofpbuf *request, *reply;
529 LIST_FOR_EACH (request, list_node, requests) {
530 ofpmsg_update_length(request);
533 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
534 "talking to %s", vconn_get_name(vconn));
536 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
539 ofpbuf_delete(reply);
542 /* Sends 'request', which should be a request that only has a reply if an error
543 * occurs, and waits for it to succeed or fail. If an error does occur, prints
544 * it and exits with an error.
546 * Destroys 'request'. */
548 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
550 struct list requests;
552 list_init(&requests);
553 list_push_back(&requests, &request->list_node);
554 transact_multiple_noreply(vconn, &requests);
558 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
560 struct ofp_switch_config *config;
561 struct ofpbuf *request;
562 struct ofpbuf *reply;
565 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
566 vconn_get_version(vconn), 0);
567 run(vconn_transact(vconn, request, &reply),
568 "talking to %s", vconn_get_name(vconn));
570 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
571 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
574 config = ofpbuf_pull(reply, sizeof *config);
577 ofpbuf_delete(reply);
581 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
583 struct ofpbuf *request;
585 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
586 ofpbuf_put(request, config, sizeof *config);
588 transact_noreply(vconn, request);
592 ofctl_show(int argc OVS_UNUSED, char *argv[])
594 const char *vconn_name = argv[1];
596 struct ofpbuf *request;
597 struct ofpbuf *reply;
600 open_vconn(vconn_name, &vconn);
601 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
602 vconn_get_version(vconn), 0);
603 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
605 trunc = ofputil_switch_features_ports_trunc(reply);
606 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
608 ofpbuf_delete(reply);
611 /* The Features Reply may not contain all the ports, so send a
612 * Port Description stats request, which doesn't have size
614 dump_trivial_stats_transaction(vconn_name,
615 OFPRAW_OFPST_PORT_DESC_REQUEST);
617 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
622 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
624 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
628 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
630 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
634 fetch_port_by_features(const char *vconn_name,
635 const char *port_name, ofp_port_t port_no,
636 struct ofputil_phy_port *pp, bool *trunc)
638 struct ofputil_switch_features features;
639 const struct ofp_header *oh;
640 struct ofpbuf *request, *reply;
647 /* Fetch the switch's ofp_switch_features. */
648 open_vconn(vconn_name, &vconn);
649 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
650 vconn_get_version(vconn), 0);
651 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
655 if (ofptype_decode(&type, reply->data)
656 || type != OFPTYPE_FEATURES_REPLY) {
657 ovs_fatal(0, "%s: received bad features reply", vconn_name);
661 if (ofputil_switch_features_ports_trunc(reply)) {
666 error = ofputil_decode_switch_features(oh, &features, &b);
668 ovs_fatal(0, "%s: failed to decode features reply (%s)",
669 vconn_name, ofperr_to_string(error));
672 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
673 if (port_no != OFPP_NONE
674 ? port_no == pp->port_no
675 : !strcmp(pp->name, port_name)) {
682 ofpbuf_delete(reply);
687 fetch_port_by_stats(const char *vconn_name,
688 const char *port_name, ofp_port_t port_no,
689 struct ofputil_phy_port *pp)
691 struct ofpbuf *request;
697 request = ofpraw_alloc(OFPRAW_OFPST_PORT_DESC_REQUEST, OFP10_VERSION, 0);
698 send_xid = ((struct ofp_header *) request->data)->xid;
700 open_vconn(vconn_name, &vconn);
701 send_openflow_buffer(vconn, request);
704 struct ofpbuf *reply;
706 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
707 recv_xid = ((struct ofp_header *) reply->data)->xid;
708 if (send_xid == recv_xid) {
709 struct ofp_header *oh = reply->data;
714 ofpbuf_use_const(&b, oh, ntohs(oh->length));
715 if (ofptype_pull(&type, &b)
716 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
717 ovs_fatal(0, "received bad reply: %s",
718 ofp_to_string(reply->data, reply->size,
722 flags = ofpmp_flags(oh);
723 done = !(flags & OFPSF_REPLY_MORE);
726 /* We've already found the port, but we need to drain
727 * the queue of any other replies for this request. */
731 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
732 if (port_no != OFPP_NONE ? port_no == pp->port_no
733 : !strcmp(pp->name, port_name)) {
739 VLOG_DBG("received reply with xid %08"PRIx32" "
740 "!= expected %08"PRIx32, recv_xid, send_xid);
742 ofpbuf_delete(reply);
750 str_to_ofp(const char *s, ofp_port_t *ofp_port)
755 ret = str_to_uint(s, 10, &port_);
756 *ofp_port = u16_to_ofp(port_);
760 /* Opens a connection to 'vconn_name', fetches the port structure for
761 * 'port_name' (which may be a port name or number), and copies it into
764 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
765 struct ofputil_phy_port *pp)
771 /* Try to interpret the argument as a port number. */
772 if (!str_to_ofp(port_name, &port_no)) {
776 /* Try to find the port based on the Features Reply. If it looks
777 * like the results may be truncated, then use the Port Description
778 * stats message introduced in OVS 1.7. */
779 found = fetch_port_by_features(vconn_name, port_name, port_no, pp,
782 found = fetch_port_by_stats(vconn_name, port_name, port_no, pp);
786 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
790 /* Returns the port number corresponding to 'port_name' (which may be a port
791 * name or number) within the switch 'vconn_name'. */
793 str_to_port_no(const char *vconn_name, const char *port_name)
797 if (ofputil_port_from_string(port_name, &port_no)) {
800 struct ofputil_phy_port pp;
802 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
808 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
809 enum ofputil_protocol *cur)
812 struct ofpbuf *request, *reply;
813 enum ofputil_protocol next;
815 request = ofputil_encode_set_protocol(*cur, want, &next);
820 run(vconn_transact_noreply(vconn, request, &reply),
821 "talking to %s", vconn_get_name(vconn));
823 char *s = ofp_to_string(reply->data, reply->size, 2);
824 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
825 vconn_get_name(vconn), s);
827 ofpbuf_delete(reply);
835 static enum ofputil_protocol
836 set_protocol_for_flow_dump(struct vconn *vconn,
837 enum ofputil_protocol cur_protocol,
838 enum ofputil_protocol usable_protocols)
843 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
844 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
845 if (f & usable_protocols & allowed_protocols
846 && try_set_protocol(vconn, f, &cur_protocol)) {
851 usable_s = ofputil_protocols_to_string(usable_protocols);
852 if (usable_protocols & allowed_protocols) {
853 ovs_fatal(0, "switch does not support any of the usable flow "
854 "formats (%s)", usable_s);
856 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
857 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
858 "allowed flow formats (%s)", usable_s, allowed_s);
862 static struct vconn *
863 prepare_dump_flows(int argc, char *argv[], bool aggregate,
864 struct ofpbuf **requestp)
866 enum ofputil_protocol usable_protocols, protocol;
867 struct ofputil_flow_stats_request fsr;
870 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
871 usable_protocols = ofputil_flow_stats_request_usable_protocols(&fsr);
873 protocol = open_vconn(argv[1], &vconn);
874 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
875 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
880 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
882 struct ofpbuf *request;
885 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
886 dump_stats_transaction(vconn, request);
891 compare_flows(const void *afs_, const void *bfs_)
893 const struct ofputil_flow_stats *afs = afs_;
894 const struct ofputil_flow_stats *bfs = bfs_;
895 const struct match *a = &afs->match;
896 const struct match *b = &bfs->match;
897 const struct sort_criterion *sc;
899 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
900 const struct mf_field *f = sc->field;
904 unsigned int a_pri = afs->priority;
905 unsigned int b_pri = bfs->priority;
906 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
910 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
911 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
913 /* Skip the test for sc->order, so that missing fields always
914 * sort to the end whether we're sorting in ascending or
915 * descending order. */
918 union mf_value aval, bval;
920 mf_get_value(f, &a->flow, &aval);
921 mf_get_value(f, &b->flow, &bval);
922 ret = memcmp(&aval, &bval, f->n_bytes);
927 return sc->order == SORT_ASC ? ret : -ret;
935 ofctl_dump_flows(int argc, char *argv[])
938 return ofctl_dump_flows__(argc, argv, false);
940 struct ofputil_flow_stats *fses;
941 size_t n_fses, allocated_fses;
942 struct ofpbuf *request;
943 struct ofpbuf ofpacts;
944 struct ofpbuf *reply;
950 vconn = prepare_dump_flows(argc, argv, false, &request);
951 send_xid = ((struct ofp_header *) request->data)->xid;
952 send_openflow_buffer(vconn, request);
955 n_fses = allocated_fses = 0;
957 ofpbuf_init(&ofpacts, 0);
959 struct ofputil_flow_stats *fs;
961 if (n_fses >= allocated_fses) {
962 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
966 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
970 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
973 ofpbuf_uninit(&ofpacts);
975 qsort(fses, n_fses, sizeof *fses, compare_flows);
978 for (i = 0; i < n_fses; i++) {
980 ofp_print_flow_stats(&s, &fses[i]);
985 for (i = 0; i < n_fses; i++) {
986 free(fses[i].ofpacts);
995 ofctl_dump_aggregate(int argc, char *argv[])
997 return ofctl_dump_flows__(argc, argv, true);
1001 ofctl_queue_stats(int argc, char *argv[])
1003 struct ofpbuf *request;
1004 struct vconn *vconn;
1005 struct ofputil_queue_stats_request oqs;
1007 open_vconn(argv[1], &vconn);
1009 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
1010 oqs.port_no = str_to_port_no(argv[1], argv[2]);
1012 oqs.port_no = OFPP_ANY;
1014 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
1015 oqs.queue_id = atoi(argv[3]);
1017 oqs.queue_id = OFPQ_ALL;
1020 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1021 dump_stats_transaction(vconn, request);
1025 static enum ofputil_protocol
1026 open_vconn_for_flow_mod(const char *remote,
1027 const struct ofputil_flow_mod *fms, size_t n_fms,
1028 struct vconn **vconnp)
1030 enum ofputil_protocol usable_protocols;
1031 enum ofputil_protocol cur_protocol;
1035 /* Figure out what flow formats will work. */
1036 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
1037 if (!(usable_protocols & allowed_protocols)) {
1038 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1039 usable_s = ofputil_protocols_to_string(usable_protocols);
1040 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1041 "allowed flow formats (%s)", usable_s, allowed_s);
1044 /* If the initial flow format is allowed and usable, keep it. */
1045 cur_protocol = open_vconn(remote, vconnp);
1046 if (usable_protocols & allowed_protocols & cur_protocol) {
1047 return cur_protocol;
1050 /* Otherwise try each flow format in turn. */
1051 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1052 enum ofputil_protocol f = 1 << i;
1054 if (f != cur_protocol
1055 && f & usable_protocols & allowed_protocols
1056 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1061 usable_s = ofputil_protocols_to_string(usable_protocols);
1062 ovs_fatal(0, "switch does not support any of the usable flow "
1063 "formats (%s)", usable_s);
1067 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1070 enum ofputil_protocol protocol;
1071 struct vconn *vconn;
1074 protocol = open_vconn_for_flow_mod(remote, fms, n_fms, &vconn);
1076 for (i = 0; i < n_fms; i++) {
1077 struct ofputil_flow_mod *fm = &fms[i];
1079 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1086 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1088 struct ofputil_flow_mod *fms = NULL;
1091 parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms);
1092 ofctl_flow_mod__(argv[1], fms, n_fms);
1097 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1099 if (argc > 2 && !strcmp(argv[2], "-")) {
1100 ofctl_flow_mod_file(argc, argv, command);
1102 struct ofputil_flow_mod fm;
1103 parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command, false);
1104 ofctl_flow_mod__(argv[1], &fm, 1);
1109 ofctl_add_flow(int argc, char *argv[])
1111 ofctl_flow_mod(argc, argv, OFPFC_ADD);
1115 ofctl_add_flows(int argc, char *argv[])
1117 ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1121 ofctl_mod_flows(int argc, char *argv[])
1123 ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1127 ofctl_del_flows(int argc, char *argv[])
1129 ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1133 set_packet_in_format(struct vconn *vconn,
1134 enum nx_packet_in_format packet_in_format)
1136 struct ofpbuf *spif;
1138 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1140 transact_noreply(vconn, spif);
1141 VLOG_DBG("%s: using user-specified packet in format %s",
1142 vconn_get_name(vconn),
1143 ofputil_packet_in_format_to_string(packet_in_format));
1147 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1149 struct ofp_switch_config config;
1150 enum ofp_config_flags flags;
1152 fetch_switch_config(vconn, &config);
1153 flags = ntohs(config.flags);
1154 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1155 /* Set the invalid ttl config. */
1156 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1158 config.flags = htons(flags);
1159 set_switch_config(vconn, &config);
1161 /* Then retrieve the configuration to see if it really took. OpenFlow
1162 * doesn't define error reporting for bad modes, so this is all we can
1164 fetch_switch_config(vconn, &config);
1165 flags = ntohs(config.flags);
1166 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1167 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1168 "switch probably doesn't support mode)");
1175 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1176 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1177 * an error message and stores NULL in '*msgp'. */
1179 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1181 struct ofp_header *oh;
1184 msg = ofpbuf_new(strlen(hex) / 2);
1187 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1189 return "Trailing garbage in hex data";
1192 if (msg->size < sizeof(struct ofp_header)) {
1194 return "Message too short for OpenFlow";
1198 if (msg->size != ntohs(oh->length)) {
1200 return "Message size does not match length in OpenFlow header";
1208 ofctl_send(struct unixctl_conn *conn, int argc,
1209 const char *argv[], void *vconn_)
1211 struct vconn *vconn = vconn_;
1218 for (i = 1; i < argc; i++) {
1219 const char *error_msg;
1223 error_msg = openflow_from_hex(argv[i], &msg);
1225 ds_put_format(&reply, "%s\n", error_msg);
1230 fprintf(stderr, "send: ");
1231 ofp_print(stderr, msg->data, msg->size, verbosity);
1233 error = vconn_send_block(vconn, msg);
1236 ds_put_format(&reply, "%s\n", ovs_strerror(error));
1239 ds_put_cstr(&reply, "sent\n");
1244 unixctl_command_reply(conn, ds_cstr(&reply));
1246 unixctl_command_reply_error(conn, ds_cstr(&reply));
1251 struct barrier_aux {
1252 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1253 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1257 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1258 const char *argv[] OVS_UNUSED, void *aux_)
1260 struct barrier_aux *aux = aux_;
1265 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1269 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1270 error = vconn_send_block(aux->vconn, msg);
1273 unixctl_command_reply_error(conn, ovs_strerror(error));
1280 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1281 const char *argv[], void *aux OVS_UNUSED)
1285 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1287 unixctl_command_reply_error(conn, ovs_strerror(errno));
1292 dup2(fd, STDERR_FILENO);
1294 unixctl_command_reply(conn, NULL);
1298 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1299 const char *argv[] OVS_UNUSED, void *blocked_)
1301 bool *blocked = blocked_;
1305 unixctl_command_reply(conn, NULL);
1307 unixctl_command_reply(conn, "already blocking");
1312 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1313 const char *argv[] OVS_UNUSED, void *blocked_)
1315 bool *blocked = blocked_;
1319 unixctl_command_reply(conn, NULL);
1321 unixctl_command_reply(conn, "already unblocked");
1325 /* Prints to stdout all of the messages received on 'vconn'.
1327 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1328 * received on 'vconn'. */
1330 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1332 struct barrier_aux barrier_aux = { vconn, NULL };
1333 struct unixctl_server *server;
1334 bool exiting = false;
1335 bool blocked = false;
1338 daemon_save_fd(STDERR_FILENO);
1340 error = unixctl_server_create(NULL, &server);
1342 ovs_fatal(error, "failed to create unixctl server");
1344 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1345 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1347 unixctl_command_register("ofctl/barrier", "", 0, 0,
1348 ofctl_barrier, &barrier_aux);
1349 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1350 ofctl_set_output_file, NULL);
1352 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1353 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1356 daemonize_complete();
1362 unixctl_server_run(server);
1367 retval = vconn_recv(vconn, &b);
1368 if (retval == EAGAIN) {
1371 run(retval, "vconn_recv");
1374 char *s = xastrftime("%Y-%m-%d %H:%M:%S: ", time_wall(), true);
1379 ofptype_decode(&type, b->data);
1380 ofp_print(stderr, b->data, b->size, verbosity + 2);
1382 switch ((int) type) {
1383 case OFPTYPE_BARRIER_REPLY:
1384 if (barrier_aux.conn) {
1385 unixctl_command_reply(barrier_aux.conn, NULL);
1386 barrier_aux.conn = NULL;
1390 case OFPTYPE_ECHO_REQUEST:
1391 if (reply_to_echo_requests) {
1392 struct ofpbuf *reply;
1394 reply = make_echo_reply(b->data);
1395 retval = vconn_send_block(vconn, reply);
1397 ovs_fatal(retval, "failed to send echo reply");
1410 vconn_run_wait(vconn);
1412 vconn_recv_wait(vconn);
1414 unixctl_server_wait(server);
1418 unixctl_server_destroy(server);
1422 ofctl_monitor(int argc, char *argv[])
1424 struct vconn *vconn;
1427 open_vconn(argv[1], &vconn);
1428 for (i = 2; i < argc; i++) {
1429 const char *arg = argv[i];
1431 if (isdigit((unsigned char) *arg)) {
1432 struct ofp_switch_config config;
1434 fetch_switch_config(vconn, &config);
1435 config.miss_send_len = htons(atoi(arg));
1436 set_switch_config(vconn, &config);
1437 } else if (!strcmp(arg, "invalid_ttl")) {
1438 monitor_set_invalid_ttl_to_controller(vconn);
1439 } else if (!strncmp(arg, "watch:", 6)) {
1440 struct ofputil_flow_monitor_request fmr;
1443 parse_flow_monitor_request(&fmr, arg + 6);
1445 msg = ofpbuf_new(0);
1446 ofputil_append_flow_monitor_request(&fmr, msg);
1447 dump_stats_transaction(vconn, msg);
1449 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1453 if (preferred_packet_in_format >= 0) {
1454 set_packet_in_format(vconn, preferred_packet_in_format);
1456 enum ofp_version version = vconn_get_version(vconn);
1459 case OFP10_VERSION: {
1460 struct ofpbuf *spif, *reply;
1462 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1464 run(vconn_transact_noreply(vconn, spif, &reply),
1465 "talking to %s", vconn_get_name(vconn));
1467 char *s = ofp_to_string(reply->data, reply->size, 2);
1468 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1469 " replied: %s. Falling back to the switch default.",
1470 vconn_get_name(vconn), s);
1472 ofpbuf_delete(reply);
1485 monitor_vconn(vconn, true);
1489 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1491 struct vconn *vconn;
1493 open_vconn__(argv[1], SNOOP, &vconn);
1494 monitor_vconn(vconn, false);
1498 ofctl_dump_ports(int argc, char *argv[])
1500 struct ofpbuf *request;
1501 struct vconn *vconn;
1504 open_vconn(argv[1], &vconn);
1505 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1506 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1507 dump_stats_transaction(vconn, request);
1512 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1514 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_PORT_DESC_REQUEST);
1518 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1520 struct ofpbuf *request;
1521 struct vconn *vconn;
1522 struct ofpbuf *reply;
1524 open_vconn(argv[1], &vconn);
1525 request = make_echo_request(vconn_get_version(vconn));
1526 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1527 if (reply->size != sizeof(struct ofp_header)) {
1528 ovs_fatal(0, "reply does not match request");
1530 ofpbuf_delete(reply);
1535 ofctl_packet_out(int argc, char *argv[])
1537 enum ofputil_protocol protocol;
1538 struct ofputil_packet_out po;
1539 struct ofpbuf ofpacts;
1540 struct vconn *vconn;
1543 ofpbuf_init(&ofpacts, 64);
1544 parse_ofpacts(argv[3], &ofpacts);
1546 po.buffer_id = UINT32_MAX;
1547 po.in_port = str_to_port_no(argv[1], argv[2]);
1548 po.ofpacts = ofpacts.data;
1549 po.ofpacts_len = ofpacts.size;
1551 protocol = open_vconn(argv[1], &vconn);
1552 for (i = 4; i < argc; i++) {
1553 struct ofpbuf *packet, *opo;
1554 const char *error_msg;
1556 error_msg = eth_from_hex(argv[i], &packet);
1558 ovs_fatal(0, "%s", error_msg);
1561 po.packet = packet->data;
1562 po.packet_len = packet->size;
1563 opo = ofputil_encode_packet_out(&po, protocol);
1564 transact_noreply(vconn, opo);
1565 ofpbuf_delete(packet);
1568 ofpbuf_uninit(&ofpacts);
1572 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1574 struct ofp_config_flag {
1575 const char *name; /* The flag's name. */
1576 enum ofputil_port_config bit; /* Bit to turn on or off. */
1577 bool on; /* Value to set the bit to. */
1579 static const struct ofp_config_flag flags[] = {
1580 { "up", OFPUTIL_PC_PORT_DOWN, false },
1581 { "down", OFPUTIL_PC_PORT_DOWN, true },
1582 { "stp", OFPUTIL_PC_NO_STP, false },
1583 { "receive", OFPUTIL_PC_NO_RECV, false },
1584 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1585 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1586 { "forward", OFPUTIL_PC_NO_FWD, false },
1587 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1590 const struct ofp_config_flag *flag;
1591 enum ofputil_protocol protocol;
1592 struct ofputil_port_mod pm;
1593 struct ofputil_phy_port pp;
1594 struct vconn *vconn;
1595 const char *command;
1598 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1600 pm.port_no = pp.port_no;
1601 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1606 if (!strncasecmp(argv[3], "no-", 3)) {
1607 command = argv[3] + 3;
1609 } else if (!strncasecmp(argv[3], "no", 2)) {
1610 command = argv[3] + 2;
1616 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1617 if (!strcasecmp(command, flag->name)) {
1618 pm.mask = flag->bit;
1619 pm.config = flag->on ^ not ? flag->bit : 0;
1623 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1626 protocol = open_vconn(argv[1], &vconn);
1627 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1632 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1634 struct ofp_switch_config config;
1635 struct vconn *vconn;
1637 open_vconn(argv[1], &vconn);
1638 fetch_switch_config(vconn, &config);
1639 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1644 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1646 struct ofp_switch_config config;
1647 enum ofp_config_flags mode;
1648 struct vconn *vconn;
1651 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1652 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1655 open_vconn(argv[1], &vconn);
1656 fetch_switch_config(vconn, &config);
1657 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1658 if (flags != config.flags) {
1659 /* Set the configuration. */
1660 config.flags = flags;
1661 set_switch_config(vconn, &config);
1663 /* Then retrieve the configuration to see if it really took. OpenFlow
1664 * doesn't define error reporting for bad modes, so this is all we can
1666 fetch_switch_config(vconn, &config);
1667 if (flags != config.flags) {
1668 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1669 "switch probably doesn't support mode \"%s\")",
1670 argv[1], ofputil_frag_handling_to_string(mode));
1677 ofctl_ping(int argc, char *argv[])
1679 size_t max_payload = 65535 - sizeof(struct ofp_header);
1680 unsigned int payload;
1681 struct vconn *vconn;
1684 payload = argc > 2 ? atoi(argv[2]) : 64;
1685 if (payload > max_payload) {
1686 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1689 open_vconn(argv[1], &vconn);
1690 for (i = 0; i < 10; i++) {
1691 struct timeval start, end;
1692 struct ofpbuf *request, *reply;
1693 const struct ofp_header *rpy_hdr;
1696 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1697 vconn_get_version(vconn), payload);
1698 random_bytes(ofpbuf_put_uninit(request, payload), payload);
1700 xgettimeofday(&start);
1701 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1702 xgettimeofday(&end);
1704 rpy_hdr = reply->data;
1705 if (ofptype_pull(&type, reply)
1706 || type != OFPTYPE_ECHO_REPLY
1707 || reply->size != payload
1708 || memcmp(request->l3, reply->l3, payload)) {
1709 printf("Reply does not match request. Request:\n");
1710 ofp_print(stdout, request, request->size, verbosity + 2);
1712 ofp_print(stdout, reply, reply->size, verbosity + 2);
1714 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1715 reply->size, argv[1], ntohl(rpy_hdr->xid),
1716 (1000*(double)(end.tv_sec - start.tv_sec))
1717 + (.001*(end.tv_usec - start.tv_usec)));
1718 ofpbuf_delete(request);
1719 ofpbuf_delete(reply);
1725 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
1727 size_t max_payload = 65535 - sizeof(struct ofp_header);
1728 struct timeval start, end;
1729 unsigned int payload_size, message_size;
1730 struct vconn *vconn;
1735 payload_size = atoi(argv[2]);
1736 if (payload_size > max_payload) {
1737 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1739 message_size = sizeof(struct ofp_header) + payload_size;
1741 count = atoi(argv[3]);
1743 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1744 count, message_size, count * message_size);
1746 open_vconn(argv[1], &vconn);
1747 xgettimeofday(&start);
1748 for (i = 0; i < count; i++) {
1749 struct ofpbuf *request, *reply;
1751 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1752 vconn_get_version(vconn), payload_size);
1753 ofpbuf_put_zeros(request, payload_size);
1754 run(vconn_transact(vconn, request, &reply), "transact");
1755 ofpbuf_delete(reply);
1757 xgettimeofday(&end);
1760 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1761 + (.001*(end.tv_usec - start.tv_usec)));
1762 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1763 duration, count / (duration / 1000.0),
1764 count * message_size / (duration / 1000.0));
1768 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1773 /* replace-flows and diff-flows commands. */
1775 /* A flow table entry, possibly with two different versions. */
1777 struct cls_rule rule; /* Within a "struct classifier". */
1778 struct fte_version *versions[2];
1781 /* One version of a Flow Table Entry. */
1782 struct fte_version {
1784 uint16_t idle_timeout;
1785 uint16_t hard_timeout;
1787 struct ofpact *ofpacts;
1791 /* Frees 'version' and the data that it owns. */
1793 fte_version_free(struct fte_version *version)
1796 free(version->ofpacts);
1801 /* Returns true if 'a' and 'b' are the same, false if they differ.
1803 * Ignores differences in 'flags' because there's no way to retrieve flags from
1804 * an OpenFlow switch. We have to assume that they are the same. */
1806 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1808 return (a->cookie == b->cookie
1809 && a->idle_timeout == b->idle_timeout
1810 && a->hard_timeout == b->hard_timeout
1811 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
1812 b->ofpacts, b->ofpacts_len));
1815 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
1816 * 'index' into 's', followed by a new-line. */
1818 fte_version_format(const struct fte *fte, int index, struct ds *s)
1820 const struct fte_version *version = fte->versions[index];
1827 cls_rule_format(&fte->rule, s);
1828 if (version->cookie != htonll(0)) {
1829 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
1831 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1832 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
1834 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1835 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
1838 ds_put_char(s, ' ');
1839 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
1841 ds_put_char(s, '\n');
1845 fte_from_cls_rule(const struct cls_rule *cls_rule)
1847 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1850 /* Frees 'fte' and its versions. */
1852 fte_free(struct fte *fte)
1855 fte_version_free(fte->versions[0]);
1856 fte_version_free(fte->versions[1]);
1857 cls_rule_destroy(&fte->rule);
1862 /* Frees all of the FTEs within 'cls'. */
1864 fte_free_all(struct classifier *cls)
1866 struct cls_cursor cursor;
1867 struct fte *fte, *next;
1869 cls_cursor_init(&cursor, cls, NULL);
1870 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1871 classifier_remove(cls, &fte->rule);
1874 classifier_destroy(cls);
1877 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1878 * necessary. Sets 'version' as the version of that rule with the given
1879 * 'index', replacing any existing version, if any.
1881 * Takes ownership of 'version'. */
1883 fte_insert(struct classifier *cls, const struct match *match,
1884 unsigned int priority, struct fte_version *version, int index)
1886 struct fte *old, *fte;
1888 fte = xzalloc(sizeof *fte);
1889 cls_rule_init(&fte->rule, match, priority);
1890 fte->versions[index] = version;
1892 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1894 fte_version_free(old->versions[index]);
1895 fte->versions[!index] = old->versions[!index];
1896 cls_rule_destroy(&old->rule);
1901 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1902 * with the specified 'index'. Returns the flow formats able to represent the
1903 * flows that were read. */
1904 static enum ofputil_protocol
1905 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1907 enum ofputil_protocol usable_protocols;
1911 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1913 ovs_fatal(errno, "%s: open", filename);
1917 usable_protocols = OFPUTIL_P_ANY;
1918 while (!ds_get_preprocessed_line(&s, file)) {
1919 struct fte_version *version;
1920 struct ofputil_flow_mod fm;
1922 parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1924 version = xmalloc(sizeof *version);
1925 version->cookie = fm.new_cookie;
1926 version->idle_timeout = fm.idle_timeout;
1927 version->hard_timeout = fm.hard_timeout;
1928 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF10_EMERG);
1929 version->ofpacts = fm.ofpacts;
1930 version->ofpacts_len = fm.ofpacts_len;
1932 usable_protocols &= ofputil_usable_protocols(&fm.match);
1934 fte_insert(cls, &fm.match, fm.priority, version, index);
1938 if (file != stdin) {
1942 return usable_protocols;
1946 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
1947 struct ofpbuf **replyp,
1948 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
1950 struct ofpbuf *reply = *replyp;
1956 /* Get a flow stats reply message, if we don't already have one. */
1962 run(vconn_recv_block(vconn, &reply),
1963 "OpenFlow packet receive failed");
1964 } while (((struct ofp_header *) reply->data)->xid != send_xid);
1966 error = ofptype_decode(&type, reply->data);
1967 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
1968 ovs_fatal(0, "received bad reply: %s",
1969 ofp_to_string(reply->data, reply->size,
1974 /* Pull an individual flow stats reply out of the message. */
1975 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
1982 more = ofpmp_more(reply->l2);
1983 ofpbuf_delete(reply);
1992 ovs_fatal(0, "parse error in reply (%s)",
1993 ofperr_to_string(retval));
1998 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1999 * format 'protocol', and adds them as flow table entries in 'cls' for the
2000 * version with the specified 'index'. */
2002 read_flows_from_switch(struct vconn *vconn,
2003 enum ofputil_protocol protocol,
2004 struct classifier *cls, int index)
2006 struct ofputil_flow_stats_request fsr;
2007 struct ofputil_flow_stats fs;
2008 struct ofpbuf *request;
2009 struct ofpbuf ofpacts;
2010 struct ofpbuf *reply;
2013 fsr.aggregate = false;
2014 match_init_catchall(&fsr.match);
2015 fsr.out_port = OFPP_ANY;
2016 fsr.table_id = 0xff;
2017 fsr.cookie = fsr.cookie_mask = htonll(0);
2018 request = ofputil_encode_flow_stats_request(&fsr, protocol);
2019 send_xid = ((struct ofp_header *) request->data)->xid;
2020 send_openflow_buffer(vconn, request);
2023 ofpbuf_init(&ofpacts, 0);
2024 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2025 struct fte_version *version;
2027 version = xmalloc(sizeof *version);
2028 version->cookie = fs.cookie;
2029 version->idle_timeout = fs.idle_timeout;
2030 version->hard_timeout = fs.hard_timeout;
2032 version->ofpacts_len = fs.ofpacts_len;
2033 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2035 fte_insert(cls, &fs.match, fs.priority, version, index);
2037 ofpbuf_uninit(&ofpacts);
2041 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2042 enum ofputil_protocol protocol, struct list *packets)
2044 const struct fte_version *version = fte->versions[index];
2045 struct ofputil_flow_mod fm;
2048 minimatch_expand(&fte->rule.match, &fm.match);
2049 fm.priority = fte->rule.priority;
2050 fm.cookie = htonll(0);
2051 fm.cookie_mask = htonll(0);
2052 fm.new_cookie = version->cookie;
2054 fm.command = command;
2055 fm.idle_timeout = version->idle_timeout;
2056 fm.hard_timeout = version->hard_timeout;
2057 fm.buffer_id = UINT32_MAX;
2058 fm.out_port = OFPP_ANY;
2059 fm.flags = version->flags;
2060 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2061 command == OFPFC_MODIFY_STRICT) {
2062 fm.ofpacts = version->ofpacts;
2063 fm.ofpacts_len = version->ofpacts_len;
2069 ofm = ofputil_encode_flow_mod(&fm, protocol);
2070 list_push_back(packets, &ofm->list_node);
2074 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
2076 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2077 enum ofputil_protocol usable_protocols, protocol;
2078 struct cls_cursor cursor;
2079 struct classifier cls;
2080 struct list requests;
2081 struct vconn *vconn;
2084 classifier_init(&cls);
2085 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2087 protocol = open_vconn(argv[1], &vconn);
2088 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2090 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2092 list_init(&requests);
2094 /* Delete flows that exist on the switch but not in the file. */
2095 cls_cursor_init(&cursor, &cls, NULL);
2096 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2097 struct fte_version *file_ver = fte->versions[FILE_IDX];
2098 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2100 if (sw_ver && !file_ver) {
2101 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2102 protocol, &requests);
2106 /* Add flows that exist in the file but not on the switch.
2107 * Update flows that exist in both places but differ. */
2108 cls_cursor_init(&cursor, &cls, NULL);
2109 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2110 struct fte_version *file_ver = fte->versions[FILE_IDX];
2111 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2114 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2115 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2118 transact_multiple_noreply(vconn, &requests);
2125 read_flows_from_source(const char *source, struct classifier *cls, int index)
2129 if (source[0] == '/' || source[0] == '.'
2130 || (!strchr(source, ':') && !stat(source, &s))) {
2131 read_flows_from_file(source, cls, index);
2133 enum ofputil_protocol protocol;
2134 struct vconn *vconn;
2136 protocol = open_vconn(source, &vconn);
2137 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2138 read_flows_from_switch(vconn, protocol, cls, index);
2144 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2146 bool differences = false;
2147 struct cls_cursor cursor;
2148 struct classifier cls;
2152 classifier_init(&cls);
2153 read_flows_from_source(argv[1], &cls, 0);
2154 read_flows_from_source(argv[2], &cls, 1);
2159 cls_cursor_init(&cursor, &cls, NULL);
2160 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2161 struct fte_version *a = fte->versions[0];
2162 struct fte_version *b = fte->versions[1];
2164 if (!a || !b || !fte_version_equals(a, b)) {
2165 fte_version_format(fte, 0, &a_s);
2166 fte_version_format(fte, 1, &b_s);
2167 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2169 printf("-%s", ds_cstr(&a_s));
2172 printf("+%s", ds_cstr(&b_s));
2189 /* Undocumented commands for unit testing. */
2192 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms)
2194 enum ofputil_protocol usable_protocols;
2195 enum ofputil_protocol protocol = 0;
2199 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
2200 usable_s = ofputil_protocols_to_string(usable_protocols);
2201 printf("usable protocols: %s\n", usable_s);
2204 if (!(usable_protocols & allowed_protocols)) {
2205 ovs_fatal(0, "no usable protocol");
2207 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2209 if (protocol & usable_protocols & allowed_protocols) {
2213 ovs_assert(is_pow2(protocol));
2215 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2217 for (i = 0; i < n_fms; i++) {
2218 struct ofputil_flow_mod *fm = &fms[i];
2221 msg = ofputil_encode_flow_mod(fm, protocol);
2222 ofp_print(stdout, msg->data, msg->size, verbosity);
2229 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2230 * it back to stdout. */
2232 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2234 struct ofputil_flow_mod fm;
2236 parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, false);
2237 ofctl_parse_flows__(&fm, 1);
2240 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2241 * add-flows) and prints each of the flows back to stdout. */
2243 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2245 struct ofputil_flow_mod *fms = NULL;
2248 parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms);
2249 ofctl_parse_flows__(fms, n_fms);
2254 ofctl_parse_nxm__(bool oxm)
2259 while (!ds_get_test_line(&in, stdin)) {
2260 struct ofpbuf nx_match;
2262 ovs_be64 cookie, cookie_mask;
2266 /* Convert string to nx_match. */
2267 ofpbuf_init(&nx_match, 0);
2269 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2271 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2274 /* Convert nx_match to match. */
2277 error = oxm_pull_match(&nx_match, &match);
2279 error = nx_pull_match(&nx_match, match_len, &match,
2280 &cookie, &cookie_mask);
2284 error = oxm_pull_match_loose(&nx_match, &match);
2286 error = nx_pull_match_loose(&nx_match, match_len, &match,
2287 &cookie, &cookie_mask);
2295 /* Convert match back to nx_match. */
2296 ofpbuf_uninit(&nx_match);
2297 ofpbuf_init(&nx_match, 0);
2299 match_len = oxm_put_match(&nx_match, &match);
2300 out = oxm_match_to_string(nx_match.data, match_len);
2302 match_len = nx_put_match(&nx_match, &match,
2303 cookie, cookie_mask);
2304 out = nx_match_to_string(nx_match.data, match_len);
2310 printf("nx_pull_match() returned error %s\n",
2311 ofperr_get_name(error));
2314 ofpbuf_uninit(&nx_match);
2319 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2320 * stdin, does some internal fussing with them, and then prints them back as
2321 * strings on stdout. */
2323 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2325 return ofctl_parse_nxm__(false);
2328 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2329 * stdin, does some internal fussing with them, and then prints them back as
2330 * strings on stdout. */
2332 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2334 return ofctl_parse_nxm__(true);
2338 print_differences(const char *prefix,
2339 const void *a_, size_t a_len,
2340 const void *b_, size_t b_len)
2342 const uint8_t *a = a_;
2343 const uint8_t *b = b_;
2346 for (i = 0; i < MIN(a_len, b_len); i++) {
2348 printf("%s%2zu: %02"PRIx8" -> %02"PRIx8"\n",
2349 prefix, i, a[i], b[i]);
2352 for (i = a_len; i < b_len; i++) {
2353 printf("%s%2zu: (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2355 for (i = b_len; i < a_len; i++) {
2356 printf("%s%2zu: %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2360 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2361 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2362 * on stdout, and then converts them back to hex bytes and prints any
2363 * differences from the input. */
2365 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2370 while (!ds_get_preprocessed_line(&in, stdin)) {
2371 struct ofpbuf of10_out;
2372 struct ofpbuf of10_in;
2373 struct ofpbuf ofpacts;
2378 /* Parse hex bytes. */
2379 ofpbuf_init(&of10_in, 0);
2380 if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2381 ovs_fatal(0, "Trailing garbage in hex data");
2384 /* Convert to ofpacts. */
2385 ofpbuf_init(&ofpacts, 0);
2386 size = of10_in.size;
2387 error = ofpacts_pull_openflow10(&of10_in, of10_in.size, &ofpacts);
2389 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2390 ofpbuf_uninit(&ofpacts);
2391 ofpbuf_uninit(&of10_in);
2394 ofpbuf_push_uninit(&of10_in, size);
2396 /* Print cls_rule. */
2398 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2402 /* Convert back to ofp10 actions and print differences from input. */
2403 ofpbuf_init(&of10_out, 0);
2404 ofpacts_put_openflow10(ofpacts.data, ofpacts.size, &of10_out);
2406 print_differences("", of10_in.data, of10_in.size,
2407 of10_out.data, of10_out.size);
2410 ofpbuf_uninit(&ofpacts);
2411 ofpbuf_uninit(&of10_in);
2412 ofpbuf_uninit(&of10_out);
2417 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2418 * bytes from stdin, converts them to cls_rules, prints them as strings on
2419 * stdout, and then converts them back to hex bytes and prints any differences
2422 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
2423 * values are ignored in the input and will be set to zero when OVS converts
2424 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
2425 * it does the conversion to hex, to ensure that in fact they are ignored. */
2427 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2434 while (!ds_get_preprocessed_line(&in, stdin)) {
2435 struct ofpbuf match_in, match_expout;
2436 struct ofp10_match match_out;
2437 struct ofp10_match match_normal;
2441 /* Parse hex bytes to use for expected output. */
2443 ds_put_cstr(&expout, ds_cstr(&in));
2444 for (p = ds_cstr(&expout); *p; p++) {
2449 ofpbuf_init(&match_expout, 0);
2450 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
2451 ovs_fatal(0, "Trailing garbage in hex data");
2453 if (match_expout.size != sizeof(struct ofp10_match)) {
2454 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2455 match_expout.size, sizeof(struct ofp10_match));
2458 /* Parse hex bytes for input. */
2459 for (p = ds_cstr(&in); *p; p++) {
2461 *p = "0123456789abcdef"[random_uint32() & 0xf];
2464 ofpbuf_init(&match_in, 0);
2465 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2466 ovs_fatal(0, "Trailing garbage in hex data");
2468 if (match_in.size != sizeof(struct ofp10_match)) {
2469 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2470 match_in.size, sizeof(struct ofp10_match));
2473 /* Convert to cls_rule and print. */
2474 ofputil_match_from_ofp10_match(match_in.data, &match);
2475 match_print(&match);
2477 /* Convert back to ofp10_match and print differences from input. */
2478 ofputil_match_to_ofp10_match(&match, &match_out);
2479 print_differences("", match_expout.data, match_expout.size,
2480 &match_out, sizeof match_out);
2482 /* Normalize, then convert and compare again. */
2483 ofputil_normalize_match(&match);
2484 ofputil_match_to_ofp10_match(&match, &match_normal);
2485 print_differences("normal: ", &match_out, sizeof match_out,
2486 &match_normal, sizeof match_normal);
2489 ofpbuf_uninit(&match_in);
2490 ofpbuf_uninit(&match_expout);
2493 ds_destroy(&expout);
2496 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2497 * bytes from stdin, converts them to "struct match"es, prints them as strings
2498 * on stdout, and then converts them back to hex bytes and prints any
2499 * differences from the input. */
2501 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2506 while (!ds_get_preprocessed_line(&in, stdin)) {
2507 struct ofpbuf match_in;
2508 struct ofp11_match match_out;
2512 /* Parse hex bytes. */
2513 ofpbuf_init(&match_in, 0);
2514 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2515 ovs_fatal(0, "Trailing garbage in hex data");
2517 if (match_in.size != sizeof(struct ofp11_match)) {
2518 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2519 match_in.size, sizeof(struct ofp11_match));
2522 /* Convert to match. */
2523 error = ofputil_match_from_ofp11_match(match_in.data, &match);
2525 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
2526 ofpbuf_uninit(&match_in);
2531 match_print(&match);
2533 /* Convert back to ofp11_match and print differences from input. */
2534 ofputil_match_to_ofp11_match(&match, &match_out);
2536 print_differences("", match_in.data, match_in.size,
2537 &match_out, sizeof match_out);
2540 ofpbuf_uninit(&match_in);
2545 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2546 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2547 * on stdout, and then converts them back to hex bytes and prints any
2548 * differences from the input. */
2550 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2555 while (!ds_get_preprocessed_line(&in, stdin)) {
2556 struct ofpbuf of11_out;
2557 struct ofpbuf of11_in;
2558 struct ofpbuf ofpacts;
2563 /* Parse hex bytes. */
2564 ofpbuf_init(&of11_in, 0);
2565 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2566 ovs_fatal(0, "Trailing garbage in hex data");
2569 /* Convert to ofpacts. */
2570 ofpbuf_init(&ofpacts, 0);
2571 size = of11_in.size;
2572 error = ofpacts_pull_openflow11_actions(&of11_in, of11_in.size,
2575 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2576 ofpbuf_uninit(&ofpacts);
2577 ofpbuf_uninit(&of11_in);
2580 ofpbuf_push_uninit(&of11_in, size);
2582 /* Print cls_rule. */
2584 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2588 /* Convert back to ofp11 actions and print differences from input. */
2589 ofpbuf_init(&of11_out, 0);
2590 ofpacts_put_openflow11_actions(ofpacts.data, ofpacts.size, &of11_out);
2592 print_differences("", of11_in.data, of11_in.size,
2593 of11_out.data, of11_out.size);
2596 ofpbuf_uninit(&ofpacts);
2597 ofpbuf_uninit(&of11_in);
2598 ofpbuf_uninit(&of11_out);
2603 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
2604 * specifications as hex bytes from stdin, converts them to ofpacts, prints
2605 * them as strings on stdout, and then converts them back to hex bytes and
2606 * prints any differences from the input. */
2608 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2613 while (!ds_get_preprocessed_line(&in, stdin)) {
2614 struct ofpbuf of11_out;
2615 struct ofpbuf of11_in;
2616 struct ofpbuf ofpacts;
2620 const char *table_id;
2623 /* Parse table_id separated with the follow-up instructions by ",", if
2625 instructions = ds_cstr(&in);
2627 if (strstr(instructions, ",")) {
2628 table_id = strsep(&instructions, ",");
2631 /* Parse hex bytes. */
2632 ofpbuf_init(&of11_in, 0);
2633 if (ofpbuf_put_hex(&of11_in, instructions, NULL)[0] != '\0') {
2634 ovs_fatal(0, "Trailing garbage in hex data");
2637 /* Convert to ofpacts. */
2638 ofpbuf_init(&ofpacts, 0);
2639 size = of11_in.size;
2640 error = ofpacts_pull_openflow11_instructions(&of11_in, of11_in.size,
2643 /* Verify actions. */
2645 memset(&flow, 0, sizeof flow);
2646 error = ofpacts_check(ofpacts.data, ofpacts.size, &flow, OFPP_MAX,
2647 table_id ? atoi(table_id) : 0);
2650 printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
2651 ofpbuf_uninit(&ofpacts);
2652 ofpbuf_uninit(&of11_in);
2655 ofpbuf_push_uninit(&of11_in, size);
2657 /* Print cls_rule. */
2659 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2663 /* Convert back to ofp11 instructions and print differences from
2665 ofpbuf_init(&of11_out, 0);
2666 ofpacts_put_openflow11_instructions(ofpacts.data, ofpacts.size,
2669 print_differences("", of11_in.data, of11_in.size,
2670 of11_out.data, of11_out.size);
2673 ofpbuf_uninit(&ofpacts);
2674 ofpbuf_uninit(&of11_in);
2675 ofpbuf_uninit(&of11_out);
2680 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
2681 * mask values to and from various formats and prints the results. */
2683 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
2688 struct ofputil_flow_mod fm;
2691 struct match nxm_match;
2695 struct ofp10_match of10_raw;
2696 struct match of10_match;
2698 struct ofp11_match of11_raw;
2699 struct match of11_match;
2703 match_init_catchall(&match);
2704 match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
2705 match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
2707 /* Convert to and from string. */
2708 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
2709 printf("%s -> ", string_s);
2711 parse_ofp_str(&fm, -1, string_s, false);
2712 printf("%04"PRIx16"/%04"PRIx16"\n",
2713 ntohs(fm.match.flow.vlan_tci),
2714 ntohs(fm.match.wc.masks.vlan_tci));
2717 /* Convert to and from NXM. */
2718 ofpbuf_init(&nxm, 0);
2719 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
2720 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
2721 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
2722 printf("NXM: %s -> ", nxm_s);
2724 printf("%s\n", ofperr_to_string(error));
2726 printf("%04"PRIx16"/%04"PRIx16"\n",
2727 ntohs(nxm_match.flow.vlan_tci),
2728 ntohs(nxm_match.wc.masks.vlan_tci));
2731 ofpbuf_uninit(&nxm);
2733 /* Convert to and from OXM. */
2734 ofpbuf_init(&nxm, 0);
2735 nxm_match_len = oxm_put_match(&nxm, &match);
2736 nxm_s = oxm_match_to_string(nxm.data, nxm_match_len);
2737 error = oxm_pull_match(&nxm, &nxm_match);
2738 printf("OXM: %s -> ", nxm_s);
2740 printf("%s\n", ofperr_to_string(error));
2742 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
2743 (VLAN_VID_MASK | VLAN_CFI);
2744 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
2745 (VLAN_VID_MASK | VLAN_CFI);
2747 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
2748 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
2749 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
2755 ofpbuf_uninit(&nxm);
2757 /* Convert to and from OpenFlow 1.0. */
2758 ofputil_match_to_ofp10_match(&match, &of10_raw);
2759 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
2760 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2761 ntohs(of10_raw.dl_vlan),
2762 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
2763 of10_raw.dl_vlan_pcp,
2764 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
2765 ntohs(of10_match.flow.vlan_tci),
2766 ntohs(of10_match.wc.masks.vlan_tci));
2768 /* Convert to and from OpenFlow 1.1. */
2769 ofputil_match_to_ofp11_match(&match, &of11_raw);
2770 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
2771 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2772 ntohs(of11_raw.dl_vlan),
2773 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
2774 of11_raw.dl_vlan_pcp,
2775 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
2776 ntohs(of11_match.flow.vlan_tci),
2777 ntohs(of11_match.wc.masks.vlan_tci));
2780 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
2783 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
2788 error = ofperr_from_name(argv[1]);
2790 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2793 for (version = 0; version <= UINT8_MAX; version++) {
2794 const char *name = ofperr_domain_get_name(version);
2796 int vendor = ofperr_get_vendor(error, version);
2797 int type = ofperr_get_type(error, version);
2798 int code = ofperr_get_code(error, version);
2800 if (vendor != -1 || type != -1 || code != -1) {
2801 printf("%s: vendor %#x, type %d, code %d\n",
2802 name, vendor, type, code);
2808 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
2809 * error named ENUM and prints the error reply in hex. */
2811 ofctl_encode_error_reply(int argc OVS_UNUSED, char *argv[])
2813 const struct ofp_header *oh;
2814 struct ofpbuf request, *reply;
2817 error = ofperr_from_name(argv[1]);
2819 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2822 ofpbuf_init(&request, 0);
2823 if (ofpbuf_put_hex(&request, argv[2], NULL)[0] != '\0') {
2824 ovs_fatal(0, "Trailing garbage in hex data");
2826 if (request.size < sizeof(struct ofp_header)) {
2827 ovs_fatal(0, "Request too short");
2831 if (request.size != ntohs(oh->length)) {
2832 ovs_fatal(0, "Request size inconsistent");
2835 reply = ofperr_encode_reply(error, request.data);
2836 ofpbuf_uninit(&request);
2838 ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
2839 ofpbuf_delete(reply);
2842 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
2843 * binary data, interpreting them as an OpenFlow message, and prints the
2844 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
2846 ofctl_ofp_print(int argc, char *argv[])
2848 struct ofpbuf packet;
2850 ofpbuf_init(&packet, strlen(argv[1]) / 2);
2851 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
2852 ovs_fatal(0, "trailing garbage following hex bytes");
2854 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
2855 ofpbuf_uninit(&packet);
2858 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
2859 * and dumps each message in hex. */
2861 ofctl_encode_hello(int argc OVS_UNUSED, char *argv[])
2863 uint32_t bitmap = strtol(argv[1], NULL, 0);
2864 struct ofpbuf *hello;
2866 hello = ofputil_encode_hello(bitmap);
2867 ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
2868 ofp_print(stdout, hello->data, hello->size, verbosity);
2869 ofpbuf_delete(hello);
2872 static const struct command all_commands[] = {
2873 { "show", 1, 1, ofctl_show },
2874 { "monitor", 1, 3, ofctl_monitor },
2875 { "snoop", 1, 1, ofctl_snoop },
2876 { "dump-desc", 1, 1, ofctl_dump_desc },
2877 { "dump-tables", 1, 1, ofctl_dump_tables },
2878 { "dump-flows", 1, 2, ofctl_dump_flows },
2879 { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
2880 { "queue-stats", 1, 3, ofctl_queue_stats },
2881 { "add-flow", 2, 2, ofctl_add_flow },
2882 { "add-flows", 2, 2, ofctl_add_flows },
2883 { "mod-flows", 2, 2, ofctl_mod_flows },
2884 { "del-flows", 1, 2, ofctl_del_flows },
2885 { "replace-flows", 2, 2, ofctl_replace_flows },
2886 { "diff-flows", 2, 2, ofctl_diff_flows },
2887 { "packet-out", 4, INT_MAX, ofctl_packet_out },
2888 { "dump-ports", 1, 2, ofctl_dump_ports },
2889 { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc },
2890 { "mod-port", 3, 3, ofctl_mod_port },
2891 { "get-frags", 1, 1, ofctl_get_frags },
2892 { "set-frags", 2, 2, ofctl_set_frags },
2893 { "probe", 1, 1, ofctl_probe },
2894 { "ping", 1, 2, ofctl_ping },
2895 { "benchmark", 3, 3, ofctl_benchmark },
2896 { "help", 0, INT_MAX, ofctl_help },
2898 /* Undocumented commands for testing. */
2899 { "parse-flow", 1, 1, ofctl_parse_flow },
2900 { "parse-flows", 1, 1, ofctl_parse_flows },
2901 { "parse-nx-match", 0, 0, ofctl_parse_nxm },
2902 { "parse-nxm", 0, 0, ofctl_parse_nxm },
2903 { "parse-oxm", 0, 0, ofctl_parse_oxm },
2904 { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
2905 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
2906 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
2907 { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
2908 { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
2909 { "check-vlan", 2, 2, ofctl_check_vlan },
2910 { "print-error", 1, 1, ofctl_print_error },
2911 { "encode-error-reply", 2, 2, ofctl_encode_error_reply },
2912 { "ofp-print", 1, 2, ofctl_ofp_print },
2913 { "encode-hello", 1, 1, ofctl_encode_hello },
2915 { NULL, 0, 0, NULL },