2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
22 #include <sys/socket.h>
32 #include "byte-order.h"
33 #include "classifier.h"
34 #include "command-line.h"
38 #include "dynamic-string.h"
39 #include "fatal-signal.h"
42 #include "ofp-actions.h"
43 #include "ofp-errors.h"
45 #include "ofp-parse.h"
46 #include "ofp-print.h"
48 #include "ofp-version-opt.h"
50 #include "ofproto/ofproto.h"
51 #include "openflow/nicira-ext.h"
52 #include "openflow/openflow.h"
53 #include "dp-packet.h"
55 #include "pcap-file.h"
56 #include "poll-loop.h"
58 #include "stream-ssl.h"
59 #include "socket-util.h"
63 #include "openvswitch/vconn.h"
64 #include "openvswitch/vlog.h"
65 #include "meta-flow.h"
68 VLOG_DEFINE_THIS_MODULE(ofctl);
70 /* --bundle: Use OpenFlow 1.4 bundle for making the flow table change atomic.
71 * NOTE: Also the flow mod will use OpenFlow 1.4, so the semantics may be
72 * different (see the comment in parse_options() for details).
74 static bool bundle = false;
76 /* --strict: Use strict matching for flow mod commands? Additionally governs
77 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
81 /* --readd: If true, on replace-flows, re-add even flows that have not changed
82 * (to reset flow counters). */
85 /* -F, --flow-format: Allowed protocols. By default, any protocol is
87 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
89 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
90 * commands. Either one of NXPIF_* to force a particular packet_in format, or
91 * -1 to let ovs-ofctl choose the default. */
92 static int preferred_packet_in_format = -1;
94 /* -m, --more: Additional verbosity for ofp-print functions. */
97 /* --timestamp: Print a timestamp before each received packet on "monitor" and
99 static bool timestamp;
101 /* --unixctl-path: Path to use for unixctl server, for "monitor" and "snoop"
103 static char *unixctl_path;
105 /* --sort, --rsort: Sort order. */
106 enum sort_order { SORT_ASC, SORT_DESC };
107 struct sort_criterion {
108 const struct mf_field *field; /* NULL means to sort by priority. */
109 enum sort_order order;
111 static struct sort_criterion *criteria;
112 static size_t n_criteria, allocated_criteria;
114 static const struct ovs_cmdl_command *get_all_commands(void);
116 OVS_NO_RETURN static void usage(void);
117 static void parse_options(int argc, char *argv[]);
119 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
120 struct ofpbuf **replyp,
121 struct ofputil_flow_stats *,
122 struct ofpbuf *ofpacts);
124 main(int argc, char *argv[])
126 struct ovs_cmdl_context ctx = { .argc = 0, };
127 set_program_name(argv[0]);
128 service_start(&argc, &argv);
129 parse_options(argc, argv);
130 fatal_ignore_sigpipe();
131 ctx.argc = argc - optind;
132 ctx.argv = argv + optind;
133 ovs_cmdl_run_command(&ctx, get_all_commands());
138 add_sort_criterion(enum sort_order order, const char *field)
140 struct sort_criterion *sc;
142 if (n_criteria >= allocated_criteria) {
143 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
146 sc = &criteria[n_criteria++];
147 if (!field || !strcasecmp(field, "priority")) {
150 sc->field = mf_from_name(field);
152 ovs_fatal(0, "%s: unknown field name", field);
159 parse_options(int argc, char *argv[])
162 OPT_STRICT = UCHAR_MAX + 1,
170 OFP_VERSION_OPTION_ENUMS,
173 static const struct option long_options[] = {
174 {"timeout", required_argument, NULL, 't'},
175 {"strict", no_argument, NULL, OPT_STRICT},
176 {"readd", no_argument, NULL, OPT_READD},
177 {"flow-format", required_argument, NULL, 'F'},
178 {"packet-in-format", required_argument, NULL, 'P'},
179 {"more", no_argument, NULL, 'm'},
180 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
181 {"sort", optional_argument, NULL, OPT_SORT},
182 {"rsort", optional_argument, NULL, OPT_RSORT},
183 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
184 {"help", no_argument, NULL, 'h'},
185 {"option", no_argument, NULL, 'o'},
186 {"bundle", no_argument, NULL, OPT_BUNDLE},
188 OFP_VERSION_LONG_OPTIONS,
190 STREAM_SSL_LONG_OPTIONS,
193 char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
195 enum ofputil_protocol version_protocols;
197 /* For now, ovs-ofctl only enables OpenFlow 1.0 by default. This is
198 * because ovs-ofctl implements command such as "add-flow" as raw OpenFlow
199 * requests, but those requests have subtly different semantics in
200 * different OpenFlow versions. For example:
202 * - In OpenFlow 1.0, a "mod-flow" operation that does not find any
203 * existing flow to modify adds a new flow.
205 * - In OpenFlow 1.1, a "mod-flow" operation that does not find any
206 * existing flow to modify adds a new flow, but only if the mod-flow
207 * did not match on the flow cookie.
209 * - In OpenFlow 1.2 and a later, a "mod-flow" operation never adds a
212 set_allowed_ofp_versions("OpenFlow10");
215 unsigned long int timeout;
218 c = getopt_long(argc, argv, short_options, long_options, NULL);
225 timeout = strtoul(optarg, NULL, 10);
227 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
235 allowed_protocols = ofputil_protocols_from_string(optarg);
236 if (!allowed_protocols) {
237 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
242 preferred_packet_in_format =
243 ofputil_packet_in_format_from_string(optarg);
244 if (preferred_packet_in_format < 0) {
245 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
257 ovs_cmdl_print_options(long_options);
277 add_sort_criterion(SORT_ASC, optarg);
281 add_sort_criterion(SORT_DESC, optarg);
285 unixctl_path = optarg;
288 DAEMON_OPTION_HANDLERS
289 OFP_VERSION_OPTION_HANDLERS
291 STREAM_SSL_OPTION_HANDLERS
302 /* Always do a final sort pass based on priority. */
303 add_sort_criterion(SORT_DESC, "priority");
308 /* Implicit OpenFlow 1.4 with the '--bundle' option. */
310 /* Add implicit allowance for OpenFlow 1.4. */
311 add_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
312 OFPUTIL_P_OF14_OXM));
314 versions = get_allowed_ofp_versions();
315 version_protocols = ofputil_protocols_from_version_bitmap(versions);
316 if (!(allowed_protocols & version_protocols)) {
317 char *protocols = ofputil_protocols_to_string(allowed_protocols);
318 struct ds version_s = DS_EMPTY_INITIALIZER;
320 ofputil_format_version_bitmap_names(&version_s, versions);
321 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
322 "any of the enabled flow formats (%s). (Use -O to enable "
323 "additional OpenFlow versions or -F to enable additional "
324 "flow formats.)", ds_cstr(&version_s), protocols);
326 allowed_protocols &= version_protocols;
327 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
334 printf("%s: OpenFlow switch management utility\n"
335 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
336 "\nFor OpenFlow switches:\n"
337 " show SWITCH show OpenFlow information\n"
338 " dump-desc SWITCH print switch description\n"
339 " dump-tables SWITCH print table stats\n"
340 " dump-table-features SWITCH print table features\n"
341 " dump-table-desc SWITCH print table description (OF1.4+)\n"
342 " mod-port SWITCH IFACE ACT modify port behavior\n"
343 " mod-table SWITCH MOD modify flow table behavior\n"
344 " OF1.1/1.2 MOD: controller, continue, drop\n"
345 " OF1.4+ MOD: evict, noevict\n"
346 " get-frags SWITCH print fragment handling behavior\n"
347 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
348 " FRAG_MODE: normal, drop, reassemble, nx-match\n"
349 " dump-ports SWITCH [PORT] print port statistics\n"
350 " dump-ports-desc SWITCH [PORT] print port descriptions\n"
351 " dump-flows SWITCH print all flow entries\n"
352 " dump-flows SWITCH FLOW print matching FLOWs\n"
353 " dump-aggregate SWITCH print aggregate flow statistics\n"
354 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
355 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
356 " add-flow SWITCH FLOW add flow described by FLOW\n"
357 " add-flows SWITCH FILE add flows from FILE\n"
358 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
359 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
360 " replace-flows SWITCH FILE replace flows with those in FILE\n"
361 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
362 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
363 " execute ACTIONS on PACKET\n"
364 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
365 " print packets received from SWITCH\n"
366 " snoop SWITCH snoop on SWITCH and its controller\n"
367 " add-group SWITCH GROUP add group described by GROUP\n"
368 " add-groups SWITCH FILE add group from FILE\n"
369 " mod-group SWITCH GROUP modify specific group\n"
370 " del-groups SWITCH [GROUP] delete matching GROUPs\n"
371 " insert-buckets SWITCH [GROUP] add buckets to GROUP\n"
372 " remove-buckets SWITCH [GROUP] remove buckets from GROUP\n"
373 " dump-group-features SWITCH print group features\n"
374 " dump-groups SWITCH [GROUP] print group description\n"
375 " dump-group-stats SWITCH [GROUP] print group statistics\n"
376 " queue-get-config SWITCH PORT print queue information for port\n"
377 " add-meter SWITCH METER add meter described by METER\n"
378 " mod-meter SWITCH METER modify specific METER\n"
379 " del-meter SWITCH METER delete METER\n"
380 " del-meters SWITCH delete all meters\n"
381 " dump-meter SWITCH METER print METER configuration\n"
382 " dump-meters SWITCH print all meter configuration\n"
383 " meter-stats SWITCH [METER] print meter statistics\n"
384 " meter-features SWITCH print meter features\n"
385 " add-geneve-map SWITCH MAP add Geneve option MAPpings\n"
386 " del-geneve-map SWITCH [MAP] delete Geneve option MAPpings\n"
387 " dump-geneve-map SWITCH print Geneve option mappings\n"
388 "\nFor OpenFlow switches and controllers:\n"
389 " probe TARGET probe whether TARGET is up\n"
390 " ping TARGET [N] latency of N-byte echos\n"
391 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
392 "SWITCH or TARGET is an active OpenFlow connection method.\n"
393 "\nOther commands:\n"
394 " ofp-parse FILE print messages read from FILE\n"
395 " ofp-parse-pcap PCAP print OpenFlow read from PCAP\n",
396 program_name, program_name);
397 vconn_usage(true, false, false);
401 printf("\nOther options:\n"
402 " --strict use strict match for flow commands\n"
403 " --readd replace flows that haven't changed\n"
404 " -F, --flow-format=FORMAT force particular flow format\n"
405 " -P, --packet-in-format=FRMT force particular packet in format\n"
406 " -m, --more be more verbose printing OpenFlow\n"
407 " --timestamp (monitor, snoop) print timestamps\n"
408 " -t, --timeout=SECS give up after SECS seconds\n"
409 " --sort[=field] sort in ascending order\n"
410 " --rsort[=field] sort in descending order\n"
411 " --unixctl=SOCKET set control socket name\n"
412 " -h, --help display this help message\n"
413 " -V, --version display version information\n");
418 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
419 const char *argv[] OVS_UNUSED, void *exiting_)
421 bool *exiting = exiting_;
423 unixctl_command_reply(conn, NULL);
426 static void run(int retval, const char *message, ...)
427 OVS_PRINTF_FORMAT(2, 3);
430 run(int retval, const char *message, ...)
435 va_start(args, message);
436 ovs_fatal_valist(retval, message, args);
440 /* Generic commands. */
443 open_vconn_socket(const char *name, struct vconn **vconnp)
445 char *vconn_name = xasprintf("unix:%s", name);
448 error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
450 if (error && error != ENOENT) {
451 ovs_fatal(0, "%s: failed to open socket (%s)", name,
452 ovs_strerror(error));
459 enum open_target { MGMT, SNOOP };
461 static enum ofputil_protocol
462 open_vconn__(const char *name, enum open_target target,
463 struct vconn **vconnp)
465 const char *suffix = target == MGMT ? "mgmt" : "snoop";
466 char *datapath_name, *datapath_type, *socket_name;
467 enum ofputil_protocol protocol;
472 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
474 ofproto_parse_name(name, &datapath_name, &datapath_type);
475 socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
479 if (strchr(name, ':')) {
480 run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
481 "connecting to %s", name);
482 } else if (!open_vconn_socket(name, vconnp)) {
484 } else if (!open_vconn_socket(bridge_path, vconnp)) {
486 } else if (!open_vconn_socket(socket_name, vconnp)) {
489 ovs_fatal(0, "%s is not a bridge or a socket", name);
492 if (target == SNOOP) {
493 vconn_set_recv_any_version(*vconnp);
499 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
500 error = vconn_connect_block(*vconnp);
502 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
503 ovs_strerror(error));
506 ofp_version = vconn_get_version(*vconnp);
507 protocol = ofputil_protocol_from_ofp_version(ofp_version);
509 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
515 static enum ofputil_protocol
516 open_vconn(const char *name, struct vconn **vconnp)
518 return open_vconn__(name, MGMT, vconnp);
522 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
524 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
528 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
530 struct ofpbuf *reply;
532 run(vconn_transact(vconn, request, &reply), "talking to %s",
533 vconn_get_name(vconn));
534 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
535 ofpbuf_delete(reply);
539 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
541 struct ofpbuf *request;
544 open_vconn(vconn_name, &vconn);
545 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
546 dump_transaction(vconn, request);
551 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
553 const struct ofp_header *request_oh = request->data;
554 ovs_be32 send_xid = request_oh->xid;
555 enum ofpraw request_raw;
556 enum ofpraw reply_raw;
559 ofpraw_decode_partial(&request_raw, request->data, request->size);
560 reply_raw = ofpraw_stats_request_to_reply(request_raw,
561 request_oh->version);
563 send_openflow_buffer(vconn, request);
566 struct ofpbuf *reply;
568 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
569 recv_xid = ((struct ofp_header *) reply->data)->xid;
570 if (send_xid == recv_xid) {
573 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
575 ofpraw_decode(&raw, reply->data);
576 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
578 } else if (raw == reply_raw) {
579 done = !ofpmp_more(reply->data);
581 ovs_fatal(0, "received bad reply: %s",
582 ofp_to_string(reply->data, reply->size,
586 VLOG_DBG("received reply with xid %08"PRIx32" "
587 "!= expected %08"PRIx32, recv_xid, send_xid);
589 ofpbuf_delete(reply);
594 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
596 struct ofpbuf *request;
599 open_vconn(vconn_name, &vconn);
600 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
601 dump_stats_transaction(vconn, request);
605 /* Sends all of the 'requests', which should be requests that only have replies
606 * if an error occurs, and waits for them to succeed or fail. If an error does
607 * occur, prints it and exits with an error.
609 * Destroys all of the 'requests'. */
611 transact_multiple_noreply(struct vconn *vconn, struct ovs_list *requests)
613 struct ofpbuf *reply;
615 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
616 "talking to %s", vconn_get_name(vconn));
618 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
621 ofpbuf_delete(reply);
625 bundle_error_reporter(const struct ofp_header *oh)
627 ofp_print(stderr, oh, ntohs(oh->length), verbosity + 1);
632 bundle_transact(struct vconn *vconn, struct ovs_list *requests, uint16_t flags)
634 run(vconn_bundle_transact(vconn, requests, flags, bundle_error_reporter),
635 "talking to %s", vconn_get_name(vconn));
638 /* Sends 'request', which should be a request that only has a reply if an error
639 * occurs, and waits for it to succeed or fail. If an error does occur, prints
640 * it and exits with an error.
642 * Destroys 'request'. */
644 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
646 struct ovs_list requests;
648 list_init(&requests);
649 list_push_back(&requests, &request->list_node);
650 transact_multiple_noreply(vconn, &requests);
654 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
656 struct ofp_switch_config *config;
657 struct ofpbuf *request;
658 struct ofpbuf *reply;
661 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
662 vconn_get_version(vconn), 0);
663 run(vconn_transact(vconn, request, &reply),
664 "talking to %s", vconn_get_name(vconn));
666 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
667 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
670 config = ofpbuf_pull(reply, sizeof *config);
673 ofpbuf_delete(reply);
677 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
679 struct ofpbuf *request;
681 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
682 ofpbuf_put(request, config, sizeof *config);
684 transact_noreply(vconn, request);
688 ofctl_show(struct ovs_cmdl_context *ctx)
690 const char *vconn_name = ctx->argv[1];
691 enum ofp_version version;
693 struct ofpbuf *request;
694 struct ofpbuf *reply;
697 open_vconn(vconn_name, &vconn);
698 version = vconn_get_version(vconn);
699 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, version, 0);
700 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
702 has_ports = ofputil_switch_features_has_ports(reply);
703 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
704 ofpbuf_delete(reply);
707 request = ofputil_encode_port_desc_stats_request(version, OFPP_ANY);
708 dump_stats_transaction(vconn, request);
710 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
715 ofctl_dump_desc(struct ovs_cmdl_context *ctx)
717 dump_trivial_stats_transaction(ctx->argv[1], OFPRAW_OFPST_DESC_REQUEST);
721 ofctl_dump_tables(struct ovs_cmdl_context *ctx)
723 dump_trivial_stats_transaction(ctx->argv[1], OFPRAW_OFPST_TABLE_REQUEST);
727 ofctl_dump_table_features(struct ovs_cmdl_context *ctx)
729 struct ofpbuf *request;
732 open_vconn(ctx->argv[1], &vconn);
733 request = ofputil_encode_table_features_request(vconn_get_version(vconn));
735 /* The following is similar to dump_trivial_stats_transaction(), but it
736 * maintains the previous 'ofputil_table_features' from one stats reply
737 * message to the next, which allows duplication to be eliminated in the
738 * output across messages. Otherwise the output is much larger and harder
739 * to read, because only 17 or so ofputil_table_features elements fit in a
740 * single 64 kB OpenFlow message and therefore you get a ton of repetition
741 * (every 17th element is printed in full instead of abbreviated). */
743 const struct ofp_header *request_oh = request->data;
744 ovs_be32 send_xid = request_oh->xid;
747 struct ofputil_table_features prev;
750 send_openflow_buffer(vconn, request);
753 struct ofpbuf *reply;
755 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
756 recv_xid = ((struct ofp_header *) reply->data)->xid;
757 if (send_xid == recv_xid) {
760 error = ofptype_decode(&type, reply->data);
762 ovs_fatal(0, "decode error: %s", ofperr_get_name(error));
763 } else if (type == OFPTYPE_ERROR) {
764 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
766 } else if (type == OFPTYPE_TABLE_FEATURES_STATS_REPLY) {
767 done = !ofpmp_more(reply->data);
769 struct ofputil_table_features tf;
772 retval = ofputil_decode_table_features(reply, &tf, true);
775 ovs_fatal(0, "decode error: %s",
776 ofperr_get_name(retval));
781 struct ds s = DS_EMPTY_INITIALIZER;
782 ofp_print_table_features(&s, &tf, n ? &prev : NULL,
791 ovs_fatal(0, "received bad reply: %s",
792 ofp_to_string(reply->data, reply->size,
796 VLOG_DBG("received reply with xid %08"PRIx32" "
797 "!= expected %08"PRIx32, recv_xid, send_xid);
799 ofpbuf_delete(reply);
806 ofctl_dump_table_desc(struct ovs_cmdl_context *ctx)
808 struct ofpbuf *request;
811 open_vconn(ctx->argv[1], &vconn);
812 request = ofputil_encode_table_desc_request(vconn_get_version(vconn));
814 dump_stats_transaction(vconn, request);
821 static bool fetch_port_by_stats(struct vconn *,
822 const char *port_name, ofp_port_t port_no,
823 struct ofputil_phy_port *);
825 /* Uses OFPT_FEATURES_REQUEST to attempt to fetch information about the port
826 * named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
827 * successful, false on failure.
829 * This is only appropriate for OpenFlow 1.0, 1.1, and 1.2, which include a
830 * list of ports in OFPT_FEATURES_REPLY. */
832 fetch_port_by_features(struct vconn *vconn,
833 const char *port_name, ofp_port_t port_no,
834 struct ofputil_phy_port *pp)
836 struct ofputil_switch_features features;
837 const struct ofp_header *oh;
838 struct ofpbuf *request, *reply;
844 /* Fetch the switch's ofp_switch_features. */
845 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
846 vconn_get_version(vconn), 0);
847 run(vconn_transact(vconn, request, &reply),
848 "talking to %s", vconn_get_name(vconn));
851 if (ofptype_decode(&type, reply->data)
852 || type != OFPTYPE_FEATURES_REPLY) {
853 ovs_fatal(0, "%s: received bad features reply", vconn_get_name(vconn));
855 if (!ofputil_switch_features_has_ports(reply)) {
856 /* The switch features reply does not contain a complete list of ports.
857 * Probably, there are more ports than will fit into a single 64 kB
858 * OpenFlow message. Use OFPST_PORT_DESC to get a complete list of
860 ofpbuf_delete(reply);
861 return fetch_port_by_stats(vconn, port_name, port_no, pp);
864 error = ofputil_decode_switch_features(oh, &features, &b);
866 ovs_fatal(0, "%s: failed to decode features reply (%s)",
867 vconn_get_name(vconn), ofperr_to_string(error));
870 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
871 if (port_no != OFPP_NONE
872 ? port_no == pp->port_no
873 : !strcmp(pp->name, port_name)) {
878 ofpbuf_delete(reply);
882 /* Uses a OFPST_PORT_DESC request to attempt to fetch information about the
883 * port named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
884 * successful, false on failure.
886 * This is most appropriate for OpenFlow 1.3 and later. Open vSwitch 1.7 and
887 * later also implements OFPST_PORT_DESC, as an extension, for OpenFlow 1.0,
888 * 1.1, and 1.2, so this can be used as a fallback in those versions when there
889 * are too many ports than fit in an OFPT_FEATURES_REPLY. */
891 fetch_port_by_stats(struct vconn *vconn,
892 const char *port_name, ofp_port_t port_no,
893 struct ofputil_phy_port *pp)
895 struct ofpbuf *request;
900 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
902 send_xid = ((struct ofp_header *) request->data)->xid;
904 send_openflow_buffer(vconn, request);
907 struct ofpbuf *reply;
909 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
910 recv_xid = ((struct ofp_header *) reply->data)->xid;
911 if (send_xid == recv_xid) {
912 struct ofp_header *oh = reply->data;
917 ofpbuf_use_const(&b, oh, ntohs(oh->length));
918 if (ofptype_pull(&type, &b)
919 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
920 ovs_fatal(0, "received bad reply: %s",
921 ofp_to_string(reply->data, reply->size,
925 flags = ofpmp_flags(oh);
926 done = !(flags & OFPSF_REPLY_MORE);
929 /* We've already found the port, but we need to drain
930 * the queue of any other replies for this request. */
934 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
935 if (port_no != OFPP_NONE ? port_no == pp->port_no
936 : !strcmp(pp->name, port_name)) {
942 VLOG_DBG("received reply with xid %08"PRIx32" "
943 "!= expected %08"PRIx32, recv_xid, send_xid);
945 ofpbuf_delete(reply);
952 str_to_ofp(const char *s, ofp_port_t *ofp_port)
957 ret = str_to_uint(s, 10, &port_);
958 *ofp_port = u16_to_ofp(port_);
962 /* Opens a connection to 'vconn_name', fetches the port structure for
963 * 'port_name' (which may be a port name or number), and copies it into
966 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
967 struct ofputil_phy_port *pp)
973 /* Try to interpret the argument as a port number. */
974 if (!str_to_ofp(port_name, &port_no)) {
978 /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
979 * OFPT_FEATURES_REPLY message. OpenFlow 1.3 and later versions put it
980 * into the OFPST_PORT_DESC reply. Try it the correct way. */
981 open_vconn(vconn_name, &vconn);
982 found = (vconn_get_version(vconn) < OFP13_VERSION
983 ? fetch_port_by_features(vconn, port_name, port_no, pp)
984 : fetch_port_by_stats(vconn, port_name, port_no, pp));
988 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
992 /* Returns the port number corresponding to 'port_name' (which may be a port
993 * name or number) within the switch 'vconn_name'. */
995 str_to_port_no(const char *vconn_name, const char *port_name)
999 if (ofputil_port_from_string(port_name, &port_no)) {
1002 struct ofputil_phy_port pp;
1004 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
1010 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
1011 enum ofputil_protocol *cur)
1014 struct ofpbuf *request, *reply;
1015 enum ofputil_protocol next;
1017 request = ofputil_encode_set_protocol(*cur, want, &next);
1019 return *cur == want;
1022 run(vconn_transact_noreply(vconn, request, &reply),
1023 "talking to %s", vconn_get_name(vconn));
1025 char *s = ofp_to_string(reply->data, reply->size, 2);
1026 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
1027 vconn_get_name(vconn), s);
1029 ofpbuf_delete(reply);
1037 static enum ofputil_protocol
1038 set_protocol_for_flow_dump(struct vconn *vconn,
1039 enum ofputil_protocol cur_protocol,
1040 enum ofputil_protocol usable_protocols)
1045 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
1046 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
1047 if (f & usable_protocols & allowed_protocols
1048 && try_set_protocol(vconn, f, &cur_protocol)) {
1053 usable_s = ofputil_protocols_to_string(usable_protocols);
1054 if (usable_protocols & allowed_protocols) {
1055 ovs_fatal(0, "switch does not support any of the usable flow "
1056 "formats (%s)", usable_s);
1058 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1059 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1060 "allowed flow formats (%s)", usable_s, allowed_s);
1064 static struct vconn *
1065 prepare_dump_flows(int argc, char *argv[], bool aggregate,
1066 struct ofpbuf **requestp)
1068 enum ofputil_protocol usable_protocols, protocol;
1069 struct ofputil_flow_stats_request fsr;
1070 struct vconn *vconn;
1073 error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
1074 argc > 2 ? argv[2] : "",
1077 ovs_fatal(0, "%s", error);
1080 protocol = open_vconn(argv[1], &vconn);
1081 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
1082 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
1087 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
1089 struct ofpbuf *request;
1090 struct vconn *vconn;
1092 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
1093 dump_stats_transaction(vconn, request);
1098 compare_flows(const void *afs_, const void *bfs_)
1100 const struct ofputil_flow_stats *afs = afs_;
1101 const struct ofputil_flow_stats *bfs = bfs_;
1102 const struct match *a = &afs->match;
1103 const struct match *b = &bfs->match;
1104 const struct sort_criterion *sc;
1106 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
1107 const struct mf_field *f = sc->field;
1111 int a_pri = afs->priority;
1112 int b_pri = bfs->priority;
1113 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
1117 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
1118 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
1120 /* Skip the test for sc->order, so that missing fields always
1121 * sort to the end whether we're sorting in ascending or
1122 * descending order. */
1123 return ina ? -1 : 1;
1125 union mf_value aval, bval;
1127 mf_get_value(f, &a->flow, &aval);
1128 mf_get_value(f, &b->flow, &bval);
1129 ret = memcmp(&aval, &bval, f->n_bytes);
1134 return sc->order == SORT_ASC ? ret : -ret;
1142 ofctl_dump_flows(struct ovs_cmdl_context *ctx)
1145 ofctl_dump_flows__(ctx->argc, ctx->argv, false);
1148 struct ofputil_flow_stats *fses;
1149 size_t n_fses, allocated_fses;
1150 struct ofpbuf *request;
1151 struct ofpbuf ofpacts;
1152 struct ofpbuf *reply;
1153 struct vconn *vconn;
1158 vconn = prepare_dump_flows(ctx->argc, ctx->argv, false, &request);
1159 send_xid = ((struct ofp_header *) request->data)->xid;
1160 send_openflow_buffer(vconn, request);
1163 n_fses = allocated_fses = 0;
1165 ofpbuf_init(&ofpacts, 0);
1167 struct ofputil_flow_stats *fs;
1169 if (n_fses >= allocated_fses) {
1170 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
1174 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
1178 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1181 ofpbuf_uninit(&ofpacts);
1183 qsort(fses, n_fses, sizeof *fses, compare_flows);
1186 for (i = 0; i < n_fses; i++) {
1188 ofp_print_flow_stats(&s, &fses[i]);
1193 for (i = 0; i < n_fses; i++) {
1194 free(CONST_CAST(struct ofpact *, fses[i].ofpacts));
1203 ofctl_dump_aggregate(struct ovs_cmdl_context *ctx)
1205 ofctl_dump_flows__(ctx->argc, ctx->argv, true);
1209 ofctl_queue_stats(struct ovs_cmdl_context *ctx)
1211 struct ofpbuf *request;
1212 struct vconn *vconn;
1213 struct ofputil_queue_stats_request oqs;
1215 open_vconn(ctx->argv[1], &vconn);
1217 if (ctx->argc > 2 && ctx->argv[2][0] && strcasecmp(ctx->argv[2], "all")) {
1218 oqs.port_no = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1220 oqs.port_no = OFPP_ANY;
1222 if (ctx->argc > 3 && ctx->argv[3][0] && strcasecmp(ctx->argv[3], "all")) {
1223 oqs.queue_id = atoi(ctx->argv[3]);
1225 oqs.queue_id = OFPQ_ALL;
1228 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1229 dump_stats_transaction(vconn, request);
1234 ofctl_queue_get_config(struct ovs_cmdl_context *ctx)
1236 const char *vconn_name = ctx->argv[1];
1237 const char *port_name = ctx->argv[2];
1238 enum ofputil_protocol protocol;
1239 enum ofp_version version;
1240 struct ofpbuf *request;
1241 struct vconn *vconn;
1244 port = str_to_port_no(vconn_name, port_name);
1246 protocol = open_vconn(vconn_name, &vconn);
1247 version = ofputil_protocol_to_ofp_version(protocol);
1248 request = ofputil_encode_queue_get_config_request(version, port);
1249 dump_transaction(vconn, request);
1253 static enum ofputil_protocol
1254 open_vconn_for_flow_mod(const char *remote, struct vconn **vconnp,
1255 enum ofputil_protocol usable_protocols)
1257 enum ofputil_protocol cur_protocol;
1261 if (!(usable_protocols & allowed_protocols)) {
1262 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1263 usable_s = ofputil_protocols_to_string(usable_protocols);
1264 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1265 "allowed flow formats (%s)", usable_s, allowed_s);
1268 /* If the initial flow format is allowed and usable, keep it. */
1269 cur_protocol = open_vconn(remote, vconnp);
1270 if (usable_protocols & allowed_protocols & cur_protocol) {
1271 return cur_protocol;
1274 /* Otherwise try each flow format in turn. */
1275 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1276 enum ofputil_protocol f = 1 << i;
1278 if (f != cur_protocol
1279 && f & usable_protocols & allowed_protocols
1280 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1285 usable_s = ofputil_protocols_to_string(usable_protocols);
1286 ovs_fatal(0, "switch does not support any of the usable flow "
1287 "formats (%s)", usable_s);
1291 bundle_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1292 size_t n_fms, enum ofputil_protocol usable_protocols)
1294 enum ofputil_protocol protocol;
1295 struct vconn *vconn;
1296 struct ovs_list requests;
1299 list_init(&requests);
1301 /* Bundles need OpenFlow 1.4+. */
1302 usable_protocols &= OFPUTIL_P_OF14_UP;
1303 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1305 for (i = 0; i < n_fms; i++) {
1306 struct ofputil_flow_mod *fm = &fms[i];
1307 struct ofpbuf *request = ofputil_encode_flow_mod(fm, protocol);
1309 list_push_back(&requests, &request->list_node);
1310 free(CONST_CAST(struct ofpact *, fm->ofpacts));
1313 bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
1318 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1319 size_t n_fms, enum ofputil_protocol usable_protocols)
1321 enum ofputil_protocol protocol;
1322 struct vconn *vconn;
1326 bundle_flow_mod__(remote, fms, n_fms, usable_protocols);
1330 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1332 for (i = 0; i < n_fms; i++) {
1333 struct ofputil_flow_mod *fm = &fms[i];
1335 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1336 free(CONST_CAST(struct ofpact *, fm->ofpacts));
1342 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], int command)
1344 enum ofputil_protocol usable_protocols;
1345 struct ofputil_flow_mod *fms = NULL;
1349 if (command == OFPFC_ADD) {
1350 /* Allow the file to specify a mix of commands. If none specified at
1351 * the beginning of any given line, then the default is OFPFC_ADD, so
1352 * this is backwards compatible. */
1355 error = parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms,
1358 ovs_fatal(0, "%s", error);
1360 ofctl_flow_mod__(argv[1], fms, n_fms, usable_protocols);
1365 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1367 if (argc > 2 && !strcmp(argv[2], "-")) {
1368 ofctl_flow_mod_file(argc, argv, command);
1370 struct ofputil_flow_mod fm;
1372 enum ofputil_protocol usable_protocols;
1374 error = parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command,
1377 ovs_fatal(0, "%s", error);
1379 ofctl_flow_mod__(argv[1], &fm, 1, usable_protocols);
1384 ofctl_add_flow(struct ovs_cmdl_context *ctx)
1386 ofctl_flow_mod(ctx->argc, ctx->argv, OFPFC_ADD);
1390 ofctl_add_flows(struct ovs_cmdl_context *ctx)
1392 ofctl_flow_mod_file(ctx->argc, ctx->argv, OFPFC_ADD);
1396 ofctl_mod_flows(struct ovs_cmdl_context *ctx)
1398 ofctl_flow_mod(ctx->argc, ctx->argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1402 ofctl_del_flows(struct ovs_cmdl_context *ctx)
1404 ofctl_flow_mod(ctx->argc, ctx->argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1408 set_packet_in_format(struct vconn *vconn,
1409 enum nx_packet_in_format packet_in_format)
1411 struct ofpbuf *spif;
1413 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1415 transact_noreply(vconn, spif);
1416 VLOG_DBG("%s: using user-specified packet in format %s",
1417 vconn_get_name(vconn),
1418 ofputil_packet_in_format_to_string(packet_in_format));
1422 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1424 struct ofp_switch_config config;
1425 enum ofp_config_flags flags;
1427 fetch_switch_config(vconn, &config);
1428 flags = ntohs(config.flags);
1429 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1430 /* Set the invalid ttl config. */
1431 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1433 config.flags = htons(flags);
1434 set_switch_config(vconn, &config);
1436 /* Then retrieve the configuration to see if it really took. OpenFlow
1437 * doesn't define error reporting for bad modes, so this is all we can
1439 fetch_switch_config(vconn, &config);
1440 flags = ntohs(config.flags);
1441 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1442 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1443 "switch probably doesn't support mode)");
1450 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1451 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1452 * an error message and stores NULL in '*msgp'. */
1454 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1456 struct ofp_header *oh;
1459 msg = ofpbuf_new(strlen(hex) / 2);
1462 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1464 return "Trailing garbage in hex data";
1467 if (msg->size < sizeof(struct ofp_header)) {
1469 return "Message too short for OpenFlow";
1473 if (msg->size != ntohs(oh->length)) {
1475 return "Message size does not match length in OpenFlow header";
1483 ofctl_send(struct unixctl_conn *conn, int argc,
1484 const char *argv[], void *vconn_)
1486 struct vconn *vconn = vconn_;
1493 for (i = 1; i < argc; i++) {
1494 const char *error_msg;
1498 error_msg = openflow_from_hex(argv[i], &msg);
1500 ds_put_format(&reply, "%s\n", error_msg);
1505 fprintf(stderr, "send: ");
1506 ofp_print(stderr, msg->data, msg->size, verbosity);
1508 error = vconn_send_block(vconn, msg);
1511 ds_put_format(&reply, "%s\n", ovs_strerror(error));
1514 ds_put_cstr(&reply, "sent\n");
1519 unixctl_command_reply(conn, ds_cstr(&reply));
1521 unixctl_command_reply_error(conn, ds_cstr(&reply));
1526 struct barrier_aux {
1527 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1528 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1532 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1533 const char *argv[] OVS_UNUSED, void *aux_)
1535 struct barrier_aux *aux = aux_;
1540 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1544 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1545 error = vconn_send_block(aux->vconn, msg);
1548 unixctl_command_reply_error(conn, ovs_strerror(error));
1555 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1556 const char *argv[], void *aux OVS_UNUSED)
1560 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1562 unixctl_command_reply_error(conn, ovs_strerror(errno));
1567 dup2(fd, STDERR_FILENO);
1569 unixctl_command_reply(conn, NULL);
1573 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1574 const char *argv[] OVS_UNUSED, void *blocked_)
1576 bool *blocked = blocked_;
1580 unixctl_command_reply(conn, NULL);
1582 unixctl_command_reply(conn, "already blocking");
1587 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1588 const char *argv[] OVS_UNUSED, void *blocked_)
1590 bool *blocked = blocked_;
1594 unixctl_command_reply(conn, NULL);
1596 unixctl_command_reply(conn, "already unblocked");
1600 /* Prints to stdout all of the messages received on 'vconn'.
1602 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1603 * received on 'vconn'. */
1605 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1607 struct barrier_aux barrier_aux = { vconn, NULL };
1608 struct unixctl_server *server;
1609 bool exiting = false;
1610 bool blocked = false;
1613 daemon_save_fd(STDERR_FILENO);
1615 error = unixctl_server_create(unixctl_path, &server);
1617 ovs_fatal(error, "failed to create unixctl server");
1619 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1620 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1622 unixctl_command_register("ofctl/barrier", "", 0, 0,
1623 ofctl_barrier, &barrier_aux);
1624 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1625 ofctl_set_output_file, NULL);
1627 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1628 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1631 daemonize_complete();
1637 unixctl_server_run(server);
1642 retval = vconn_recv(vconn, &b);
1643 if (retval == EAGAIN) {
1646 run(retval, "vconn_recv");
1649 char *s = xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1650 time_wall_msec(), true);
1655 ofptype_decode(&type, b->data);
1656 ofp_print(stderr, b->data, b->size, verbosity + 2);
1659 switch ((int) type) {
1660 case OFPTYPE_BARRIER_REPLY:
1661 if (barrier_aux.conn) {
1662 unixctl_command_reply(barrier_aux.conn, NULL);
1663 barrier_aux.conn = NULL;
1667 case OFPTYPE_ECHO_REQUEST:
1668 if (reply_to_echo_requests) {
1669 struct ofpbuf *reply;
1671 reply = make_echo_reply(b->data);
1672 retval = vconn_send_block(vconn, reply);
1674 ovs_fatal(retval, "failed to send echo reply");
1687 vconn_run_wait(vconn);
1689 vconn_recv_wait(vconn);
1691 unixctl_server_wait(server);
1695 unixctl_server_destroy(server);
1699 ofctl_monitor(struct ovs_cmdl_context *ctx)
1701 struct vconn *vconn;
1703 enum ofputil_protocol usable_protocols;
1705 open_vconn(ctx->argv[1], &vconn);
1706 for (i = 2; i < ctx->argc; i++) {
1707 const char *arg = ctx->argv[i];
1709 if (isdigit((unsigned char) *arg)) {
1710 struct ofp_switch_config config;
1712 fetch_switch_config(vconn, &config);
1713 config.miss_send_len = htons(atoi(arg));
1714 set_switch_config(vconn, &config);
1715 } else if (!strcmp(arg, "invalid_ttl")) {
1716 monitor_set_invalid_ttl_to_controller(vconn);
1717 } else if (!strncmp(arg, "watch:", 6)) {
1718 struct ofputil_flow_monitor_request fmr;
1722 error = parse_flow_monitor_request(&fmr, arg + 6,
1725 ovs_fatal(0, "%s", error);
1728 msg = ofpbuf_new(0);
1729 ofputil_append_flow_monitor_request(&fmr, msg);
1730 dump_stats_transaction(vconn, msg);
1733 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1737 if (preferred_packet_in_format >= 0) {
1738 set_packet_in_format(vconn, preferred_packet_in_format);
1740 enum ofp_version version = vconn_get_version(vconn);
1743 case OFP10_VERSION: {
1744 struct ofpbuf *spif, *reply;
1746 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1748 run(vconn_transact_noreply(vconn, spif, &reply),
1749 "talking to %s", vconn_get_name(vconn));
1751 char *s = ofp_to_string(reply->data, reply->size, 2);
1752 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1753 " replied: %s. Falling back to the switch default.",
1754 vconn_get_name(vconn), s);
1756 ofpbuf_delete(reply);
1771 monitor_vconn(vconn, true);
1775 ofctl_snoop(struct ovs_cmdl_context *ctx)
1777 struct vconn *vconn;
1779 open_vconn__(ctx->argv[1], SNOOP, &vconn);
1780 monitor_vconn(vconn, false);
1784 ofctl_dump_ports(struct ovs_cmdl_context *ctx)
1786 struct ofpbuf *request;
1787 struct vconn *vconn;
1790 open_vconn(ctx->argv[1], &vconn);
1791 port = ctx->argc > 2 ? str_to_port_no(ctx->argv[1], ctx->argv[2]) : OFPP_ANY;
1792 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1793 dump_stats_transaction(vconn, request);
1798 ofctl_dump_ports_desc(struct ovs_cmdl_context *ctx)
1800 struct ofpbuf *request;
1801 struct vconn *vconn;
1804 open_vconn(ctx->argv[1], &vconn);
1805 port = ctx->argc > 2 ? str_to_port_no(ctx->argv[1], ctx->argv[2]) : OFPP_ANY;
1806 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
1808 dump_stats_transaction(vconn, request);
1813 ofctl_probe(struct ovs_cmdl_context *ctx)
1815 struct ofpbuf *request;
1816 struct vconn *vconn;
1817 struct ofpbuf *reply;
1819 open_vconn(ctx->argv[1], &vconn);
1820 request = make_echo_request(vconn_get_version(vconn));
1821 run(vconn_transact(vconn, request, &reply), "talking to %s", ctx->argv[1]);
1822 if (reply->size != sizeof(struct ofp_header)) {
1823 ovs_fatal(0, "reply does not match request");
1825 ofpbuf_delete(reply);
1830 ofctl_packet_out(struct ovs_cmdl_context *ctx)
1832 enum ofputil_protocol protocol;
1833 struct ofputil_packet_out po;
1834 struct ofpbuf ofpacts;
1835 struct vconn *vconn;
1838 enum ofputil_protocol usable_protocols; /* XXX: Use in proto selection */
1840 ofpbuf_init(&ofpacts, 64);
1841 error = ofpacts_parse_actions(ctx->argv[3], &ofpacts, &usable_protocols);
1843 ovs_fatal(0, "%s", error);
1846 po.buffer_id = UINT32_MAX;
1847 po.in_port = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1848 po.ofpacts = ofpacts.data;
1849 po.ofpacts_len = ofpacts.size;
1851 protocol = open_vconn(ctx->argv[1], &vconn);
1852 for (i = 4; i < ctx->argc; i++) {
1853 struct dp_packet *packet;
1855 const char *error_msg;
1857 error_msg = eth_from_hex(ctx->argv[i], &packet);
1859 ovs_fatal(0, "%s", error_msg);
1862 po.packet = dp_packet_data(packet);
1863 po.packet_len = dp_packet_size(packet);
1864 opo = ofputil_encode_packet_out(&po, protocol);
1865 transact_noreply(vconn, opo);
1866 dp_packet_delete(packet);
1869 ofpbuf_uninit(&ofpacts);
1873 ofctl_mod_port(struct ovs_cmdl_context *ctx)
1875 struct ofp_config_flag {
1876 const char *name; /* The flag's name. */
1877 enum ofputil_port_config bit; /* Bit to turn on or off. */
1878 bool on; /* Value to set the bit to. */
1880 static const struct ofp_config_flag flags[] = {
1881 { "up", OFPUTIL_PC_PORT_DOWN, false },
1882 { "down", OFPUTIL_PC_PORT_DOWN, true },
1883 { "stp", OFPUTIL_PC_NO_STP, false },
1884 { "receive", OFPUTIL_PC_NO_RECV, false },
1885 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1886 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1887 { "forward", OFPUTIL_PC_NO_FWD, false },
1888 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1891 const struct ofp_config_flag *flag;
1892 enum ofputil_protocol protocol;
1893 struct ofputil_port_mod pm;
1894 struct ofputil_phy_port pp;
1895 struct vconn *vconn;
1896 const char *command;
1899 fetch_ofputil_phy_port(ctx->argv[1], ctx->argv[2], &pp);
1901 pm.port_no = pp.port_no;
1902 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1907 if (!strncasecmp(ctx->argv[3], "no-", 3)) {
1908 command = ctx->argv[3] + 3;
1910 } else if (!strncasecmp(ctx->argv[3], "no", 2)) {
1911 command = ctx->argv[3] + 2;
1914 command = ctx->argv[3];
1917 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1918 if (!strcasecmp(command, flag->name)) {
1919 pm.mask = flag->bit;
1920 pm.config = flag->on ^ not ? flag->bit : 0;
1924 ovs_fatal(0, "unknown mod-port command '%s'", ctx->argv[3]);
1927 protocol = open_vconn(ctx->argv[1], &vconn);
1928 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1933 ofctl_mod_table(struct ovs_cmdl_context *ctx)
1935 uint32_t usable_versions;
1936 struct ofputil_table_mod tm;
1937 struct vconn *vconn;
1940 error = parse_ofp_table_mod(&tm, ctx->argv[2], ctx->argv[3],
1943 ovs_fatal(0, "%s", error);
1946 uint32_t allowed_versions = get_allowed_ofp_versions();
1947 if (!(allowed_versions & usable_versions)) {
1948 struct ds versions = DS_EMPTY_INITIALIZER;
1949 ofputil_format_version_bitmap_names(&versions, allowed_versions);
1950 ovs_fatal(0, "table_mod '%s' requires one of the OpenFlow "
1951 "versions %s but none is enabled (use -O)",
1952 ctx->argv[3], ds_cstr(&versions));
1954 mask_allowed_ofp_versions(usable_versions);
1956 enum ofputil_protocol protocol = open_vconn(ctx->argv[1], &vconn);
1957 transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
1962 ofctl_get_frags(struct ovs_cmdl_context *ctx)
1964 struct ofp_switch_config config;
1965 struct vconn *vconn;
1967 open_vconn(ctx->argv[1], &vconn);
1968 fetch_switch_config(vconn, &config);
1969 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1974 ofctl_set_frags(struct ovs_cmdl_context *ctx)
1976 struct ofp_switch_config config;
1977 enum ofp_config_flags mode;
1978 struct vconn *vconn;
1981 if (!ofputil_frag_handling_from_string(ctx->argv[2], &mode)) {
1982 ovs_fatal(0, "%s: unknown fragment handling mode", ctx->argv[2]);
1985 open_vconn(ctx->argv[1], &vconn);
1986 fetch_switch_config(vconn, &config);
1987 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1988 if (flags != config.flags) {
1989 /* Set the configuration. */
1990 config.flags = flags;
1991 set_switch_config(vconn, &config);
1993 /* Then retrieve the configuration to see if it really took. OpenFlow
1994 * doesn't define error reporting for bad modes, so this is all we can
1996 fetch_switch_config(vconn, &config);
1997 if (flags != config.flags) {
1998 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1999 "switch probably doesn't support mode \"%s\")",
2000 ctx->argv[1], ofputil_frag_handling_to_string(mode));
2007 ofctl_ofp_parse(struct ovs_cmdl_context *ctx)
2009 const char *filename = ctx->argv[1];
2013 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2015 ovs_fatal(errno, "%s: open", filename);
2018 ofpbuf_init(&b, 65536);
2020 struct ofp_header *oh;
2021 size_t length, tail_len;
2026 oh = ofpbuf_put_uninit(&b, sizeof *oh);
2027 n = fread(oh, 1, sizeof *oh, file);
2030 } else if (n < sizeof *oh) {
2031 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2034 length = ntohs(oh->length);
2035 if (length < sizeof *oh) {
2036 ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
2040 tail_len = length - sizeof *oh;
2041 tail = ofpbuf_put_uninit(&b, tail_len);
2042 n = fread(tail, 1, tail_len, file);
2044 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2047 ofp_print(stdout, b.data, b.size, verbosity + 2);
2051 if (file != stdin) {
2057 is_openflow_port(ovs_be16 port_, char *ports[])
2059 uint16_t port = ntohs(port_);
2063 for (i = 0; ports[i]; i++) {
2064 if (port == atoi(ports[i])) {
2070 return port == OFP_PORT || port == OFP_OLD_PORT;
2075 ofctl_ofp_parse_pcap(struct ovs_cmdl_context *ctx)
2077 struct tcp_reader *reader;
2082 file = ovs_pcap_open(ctx->argv[1], "rb");
2084 ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
2087 reader = tcp_reader_open();
2090 struct dp_packet *packet;
2094 error = ovs_pcap_read(file, &packet, &when);
2098 pkt_metadata_init(&packet->md, ODPP_NONE);
2099 flow_extract(packet, &flow);
2100 if (flow.dl_type == htons(ETH_TYPE_IP)
2101 && flow.nw_proto == IPPROTO_TCP
2102 && (is_openflow_port(flow.tp_src, ctx->argv + 2) ||
2103 is_openflow_port(flow.tp_dst, ctx->argv + 2))) {
2104 struct dp_packet *payload = tcp_reader_run(reader, &flow, packet);
2106 while (dp_packet_size(payload) >= sizeof(struct ofp_header)) {
2107 const struct ofp_header *oh;
2108 void *data = dp_packet_data(payload);
2111 /* Align OpenFlow on 8-byte boundary for safe access. */
2112 dp_packet_shift(payload, -((intptr_t) data & 7));
2114 oh = dp_packet_data(payload);
2115 length = ntohs(oh->length);
2116 if (dp_packet_size(payload) < length) {
2126 char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
2131 printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
2132 IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
2133 IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
2134 ofp_print(stdout, dp_packet_data(payload), length, verbosity + 1);
2135 dp_packet_pull(payload, length);
2139 dp_packet_delete(packet);
2141 tcp_reader_close(reader);
2145 ofctl_ping(struct ovs_cmdl_context *ctx)
2147 size_t max_payload = 65535 - sizeof(struct ofp_header);
2148 unsigned int payload;
2149 struct vconn *vconn;
2152 payload = ctx->argc > 2 ? atoi(ctx->argv[2]) : 64;
2153 if (payload > max_payload) {
2154 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2157 open_vconn(ctx->argv[1], &vconn);
2158 for (i = 0; i < 10; i++) {
2159 struct timeval start, end;
2160 struct ofpbuf *request, *reply;
2161 const struct ofp_header *rpy_hdr;
2164 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2165 vconn_get_version(vconn), payload);
2166 random_bytes(ofpbuf_put_uninit(request, payload), payload);
2168 xgettimeofday(&start);
2169 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2170 xgettimeofday(&end);
2172 rpy_hdr = reply->data;
2173 if (ofptype_pull(&type, reply)
2174 || type != OFPTYPE_ECHO_REPLY
2175 || reply->size != payload
2176 || memcmp(request->msg, reply->msg, payload)) {
2177 printf("Reply does not match request. Request:\n");
2178 ofp_print(stdout, request, request->size, verbosity + 2);
2180 ofp_print(stdout, reply, reply->size, verbosity + 2);
2182 printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2183 reply->size, ctx->argv[1], ntohl(rpy_hdr->xid),
2184 (1000*(double)(end.tv_sec - start.tv_sec))
2185 + (.001*(end.tv_usec - start.tv_usec)));
2186 ofpbuf_delete(request);
2187 ofpbuf_delete(reply);
2193 ofctl_benchmark(struct ovs_cmdl_context *ctx)
2195 size_t max_payload = 65535 - sizeof(struct ofp_header);
2196 struct timeval start, end;
2197 unsigned int payload_size, message_size;
2198 struct vconn *vconn;
2203 payload_size = atoi(ctx->argv[2]);
2204 if (payload_size > max_payload) {
2205 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2207 message_size = sizeof(struct ofp_header) + payload_size;
2209 count = atoi(ctx->argv[3]);
2211 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2212 count, message_size, count * message_size);
2214 open_vconn(ctx->argv[1], &vconn);
2215 xgettimeofday(&start);
2216 for (i = 0; i < count; i++) {
2217 struct ofpbuf *request, *reply;
2219 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2220 vconn_get_version(vconn), payload_size);
2221 ofpbuf_put_zeros(request, payload_size);
2222 run(vconn_transact(vconn, request, &reply), "transact");
2223 ofpbuf_delete(reply);
2225 xgettimeofday(&end);
2228 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2229 + (.001*(end.tv_usec - start.tv_usec)));
2230 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2231 duration, count / (duration / 1000.0),
2232 count * message_size / (duration / 1000.0));
2236 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2237 size_t n_gms, enum ofputil_protocol usable_protocols)
2239 enum ofputil_protocol protocol;
2240 struct ofputil_group_mod *gm;
2241 enum ofp_version version;
2242 struct ofpbuf *request;
2244 struct vconn *vconn;
2247 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
2248 version = ofputil_protocol_to_ofp_version(protocol);
2250 for (i = 0; i < n_gms; i++) {
2252 request = ofputil_encode_group_mod(version, gm);
2254 transact_noreply(vconn, request);
2264 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2266 struct ofputil_group_mod *gms = NULL;
2267 enum ofputil_protocol usable_protocols;
2272 error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2275 ovs_fatal(0, "%s", error);
2277 ofctl_group_mod__(argv[1], gms, n_gms, usable_protocols);
2278 for (i = 0; i < n_gms; i++) {
2279 ofputil_bucket_list_destroy(&gms[i].buckets);
2285 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2287 if (argc > 2 && !strcmp(argv[2], "-")) {
2288 ofctl_group_mod_file(argc, argv, command);
2290 enum ofputil_protocol usable_protocols;
2291 struct ofputil_group_mod gm;
2294 error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2297 ovs_fatal(0, "%s", error);
2299 ofctl_group_mod__(argv[1], &gm, 1, usable_protocols);
2300 ofputil_bucket_list_destroy(&gm.buckets);
2305 ofctl_add_group(struct ovs_cmdl_context *ctx)
2307 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_ADD);
2311 ofctl_add_groups(struct ovs_cmdl_context *ctx)
2313 ofctl_group_mod_file(ctx->argc, ctx->argv, OFPGC11_ADD);
2317 ofctl_mod_group(struct ovs_cmdl_context *ctx)
2319 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_MODIFY);
2323 ofctl_del_groups(struct ovs_cmdl_context *ctx)
2325 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_DELETE);
2329 ofctl_insert_bucket(struct ovs_cmdl_context *ctx)
2331 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_INSERT_BUCKET);
2335 ofctl_remove_bucket(struct ovs_cmdl_context *ctx)
2337 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_REMOVE_BUCKET);
2341 ofctl_dump_group_stats(struct ovs_cmdl_context *ctx)
2343 enum ofputil_protocol usable_protocols;
2344 struct ofputil_group_mod gm;
2345 struct ofpbuf *request;
2346 struct vconn *vconn;
2350 memset(&gm, 0, sizeof gm);
2352 error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2353 ctx->argc > 2 ? ctx->argv[2] : "",
2356 ovs_fatal(0, "%s", error);
2359 group_id = gm.group_id;
2361 open_vconn(ctx->argv[1], &vconn);
2362 request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2365 dump_stats_transaction(vconn, request);
2372 ofctl_dump_group_desc(struct ovs_cmdl_context *ctx)
2374 struct ofpbuf *request;
2375 struct vconn *vconn;
2378 open_vconn(ctx->argv[1], &vconn);
2380 if (ctx->argc < 3 || !ofputil_group_from_string(ctx->argv[2], &group_id)) {
2381 group_id = OFPG11_ALL;
2384 request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2387 dump_stats_transaction(vconn, request);
2394 ofctl_dump_group_features(struct ovs_cmdl_context *ctx)
2396 struct ofpbuf *request;
2397 struct vconn *vconn;
2399 open_vconn(ctx->argv[1], &vconn);
2400 request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2402 dump_stats_transaction(vconn, request);
2409 ofctl_geneve_mod(struct ovs_cmdl_context *ctx, uint16_t command)
2411 enum ofputil_protocol usable_protocols;
2412 enum ofputil_protocol protocol;
2413 struct ofputil_geneve_table_mod gtm;
2415 enum ofp_version version;
2416 struct ofpbuf *request;
2417 struct vconn *vconn;
2419 error = parse_ofp_geneve_table_mod_str(>m, command, ctx->argc > 2 ?
2423 ovs_fatal(0, "%s", error);
2426 protocol = open_vconn_for_flow_mod(ctx->argv[1], &vconn, usable_protocols);
2427 version = ofputil_protocol_to_ofp_version(protocol);
2429 request = ofputil_encode_geneve_table_mod(version, >m);
2431 transact_noreply(vconn, request);
2435 ofputil_uninit_geneve_table(>m.mappings);
2439 ofctl_add_geneve_map(struct ovs_cmdl_context *ctx)
2441 ofctl_geneve_mod(ctx, NXGTMC_ADD);
2445 ofctl_del_geneve_map(struct ovs_cmdl_context *ctx)
2447 ofctl_geneve_mod(ctx, ctx->argc > 2 ? NXGTMC_DELETE : NXGTMC_CLEAR);
2451 ofctl_dump_geneve_map(struct ovs_cmdl_context *ctx)
2453 dump_trivial_transaction(ctx->argv[1], OFPRAW_NXT_GENEVE_TABLE_REQUEST);
2457 ofctl_help(struct ovs_cmdl_context *ctx OVS_UNUSED)
2463 ofctl_list_commands(struct ovs_cmdl_context *ctx OVS_UNUSED)
2465 ovs_cmdl_print_commands(get_all_commands());
2468 /* replace-flows and diff-flows commands. */
2470 /* A flow table entry, possibly with two different versions. */
2472 struct cls_rule rule; /* Within a "struct classifier". */
2473 struct fte_version *versions[2];
2476 /* One version of a Flow Table Entry. */
2477 struct fte_version {
2479 uint16_t idle_timeout;
2480 uint16_t hard_timeout;
2481 uint16_t importance;
2483 struct ofpact *ofpacts;
2487 /* Frees 'version' and the data that it owns. */
2489 fte_version_free(struct fte_version *version)
2492 free(CONST_CAST(struct ofpact *, version->ofpacts));
2497 /* Returns true if 'a' and 'b' are the same, false if they differ.
2499 * Ignores differences in 'flags' because there's no way to retrieve flags from
2500 * an OpenFlow switch. We have to assume that they are the same. */
2502 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2504 return (a->cookie == b->cookie
2505 && a->idle_timeout == b->idle_timeout
2506 && a->hard_timeout == b->hard_timeout
2507 && a->importance == b->importance
2508 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2509 b->ofpacts, b->ofpacts_len));
2512 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2513 * 'index' into 's', followed by a new-line. */
2515 fte_version_format(const struct fte *fte, int index, struct ds *s)
2517 const struct fte_version *version = fte->versions[index];
2524 cls_rule_format(&fte->rule, s);
2525 if (version->cookie != htonll(0)) {
2526 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2528 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2529 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2531 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2532 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2534 if (version->importance != 0) {
2535 ds_put_format(s, " importance=%"PRIu16, version->importance);
2538 ds_put_cstr(s, " actions=");
2539 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2541 ds_put_char(s, '\n');
2545 fte_from_cls_rule(const struct cls_rule *cls_rule)
2547 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2550 /* Frees 'fte' and its versions. */
2552 fte_free(struct fte *fte)
2555 fte_version_free(fte->versions[0]);
2556 fte_version_free(fte->versions[1]);
2557 cls_rule_destroy(&fte->rule);
2562 /* Frees all of the FTEs within 'cls'. */
2564 fte_free_all(struct classifier *cls)
2568 classifier_defer(cls);
2569 CLS_FOR_EACH (fte, rule, cls) {
2570 classifier_remove(cls, &fte->rule);
2571 ovsrcu_postpone(fte_free, fte);
2573 classifier_destroy(cls);
2576 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
2577 * necessary. Sets 'version' as the version of that rule with the given
2578 * 'index', replacing any existing version, if any.
2580 * Takes ownership of 'version'. */
2582 fte_insert(struct classifier *cls, const struct match *match,
2583 int priority, struct fte_version *version, int index)
2585 struct fte *old, *fte;
2587 fte = xzalloc(sizeof *fte);
2588 cls_rule_init(&fte->rule, match, priority);
2589 fte->versions[index] = version;
2591 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule,
2592 CLS_MIN_VERSION, NULL, 0));
2594 fte->versions[!index] = old->versions[!index];
2595 old->versions[!index] = NULL;
2597 ovsrcu_postpone(fte_free, old);
2601 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
2602 * with the specified 'index'. Returns the flow formats able to represent the
2603 * flows that were read. */
2604 static enum ofputil_protocol
2605 read_flows_from_file(const char *filename, struct classifier *cls, int index)
2607 enum ofputil_protocol usable_protocols;
2612 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2614 ovs_fatal(errno, "%s: open", filename);
2618 usable_protocols = OFPUTIL_P_ANY;
2620 classifier_defer(cls);
2621 while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2622 struct fte_version *version;
2623 struct ofputil_flow_mod fm;
2625 enum ofputil_protocol usable;
2627 error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2629 ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2631 usable_protocols &= usable;
2633 version = xmalloc(sizeof *version);
2634 version->cookie = fm.new_cookie;
2635 version->idle_timeout = fm.idle_timeout;
2636 version->hard_timeout = fm.hard_timeout;
2637 version->importance = fm.importance;
2638 version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2639 | OFPUTIL_FF_EMERG);
2640 version->ofpacts = fm.ofpacts;
2641 version->ofpacts_len = fm.ofpacts_len;
2643 fte_insert(cls, &fm.match, fm.priority, version, index);
2645 classifier_publish(cls);
2648 if (file != stdin) {
2652 return usable_protocols;
2656 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2657 struct ofpbuf **replyp,
2658 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2660 struct ofpbuf *reply = *replyp;
2666 /* Get a flow stats reply message, if we don't already have one. */
2672 run(vconn_recv_block(vconn, &reply),
2673 "OpenFlow packet receive failed");
2674 } while (((struct ofp_header *) reply->data)->xid != send_xid);
2676 error = ofptype_decode(&type, reply->data);
2677 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2678 ovs_fatal(0, "received bad reply: %s",
2679 ofp_to_string(reply->data, reply->size,
2684 /* Pull an individual flow stats reply out of the message. */
2685 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2692 more = ofpmp_more(reply->header);
2693 ofpbuf_delete(reply);
2702 ovs_fatal(0, "parse error in reply (%s)",
2703 ofperr_to_string(retval));
2708 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2709 * format 'protocol', and adds them as flow table entries in 'cls' for the
2710 * version with the specified 'index'. */
2712 read_flows_from_switch(struct vconn *vconn,
2713 enum ofputil_protocol protocol,
2714 struct classifier *cls, int index)
2716 struct ofputil_flow_stats_request fsr;
2717 struct ofputil_flow_stats fs;
2718 struct ofpbuf *request;
2719 struct ofpbuf ofpacts;
2720 struct ofpbuf *reply;
2723 fsr.aggregate = false;
2724 match_init_catchall(&fsr.match);
2725 fsr.out_port = OFPP_ANY;
2726 fsr.table_id = 0xff;
2727 fsr.cookie = fsr.cookie_mask = htonll(0);
2728 request = ofputil_encode_flow_stats_request(&fsr, protocol);
2729 send_xid = ((struct ofp_header *) request->data)->xid;
2730 send_openflow_buffer(vconn, request);
2733 ofpbuf_init(&ofpacts, 0);
2734 classifier_defer(cls);
2735 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2736 struct fte_version *version;
2738 version = xmalloc(sizeof *version);
2739 version->cookie = fs.cookie;
2740 version->idle_timeout = fs.idle_timeout;
2741 version->hard_timeout = fs.hard_timeout;
2742 version->importance = fs.importance;
2744 version->ofpacts_len = fs.ofpacts_len;
2745 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2747 fte_insert(cls, &fs.match, fs.priority, version, index);
2749 classifier_publish(cls);
2750 ofpbuf_uninit(&ofpacts);
2754 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2755 enum ofputil_protocol protocol, struct ovs_list *packets)
2757 const struct fte_version *version = fte->versions[index];
2758 struct ofputil_flow_mod fm;
2761 minimatch_expand(&fte->rule.match, &fm.match);
2762 fm.priority = fte->rule.priority;
2763 fm.cookie = htonll(0);
2764 fm.cookie_mask = htonll(0);
2765 fm.new_cookie = version->cookie;
2766 fm.modify_cookie = true;
2768 fm.command = command;
2769 fm.idle_timeout = version->idle_timeout;
2770 fm.hard_timeout = version->hard_timeout;
2771 fm.importance = version->importance;
2772 fm.buffer_id = UINT32_MAX;
2773 fm.out_port = OFPP_ANY;
2774 fm.flags = version->flags;
2775 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2776 command == OFPFC_MODIFY_STRICT) {
2777 fm.ofpacts = version->ofpacts;
2778 fm.ofpacts_len = version->ofpacts_len;
2783 fm.delete_reason = OFPRR_DELETE;
2785 ofm = ofputil_encode_flow_mod(&fm, protocol);
2786 list_push_back(packets, &ofm->list_node);
2790 ofctl_replace_flows(struct ovs_cmdl_context *ctx)
2792 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2793 enum ofputil_protocol usable_protocols, protocol;
2794 struct classifier cls;
2795 struct ovs_list requests;
2796 struct vconn *vconn;
2799 classifier_init(&cls, NULL);
2800 usable_protocols = read_flows_from_file(ctx->argv[2], &cls, FILE_IDX);
2802 protocol = open_vconn(ctx->argv[1], &vconn);
2803 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2805 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2807 list_init(&requests);
2809 /* Delete flows that exist on the switch but not in the file. */
2810 CLS_FOR_EACH (fte, rule, &cls) {
2811 struct fte_version *file_ver = fte->versions[FILE_IDX];
2812 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2814 if (sw_ver && !file_ver) {
2815 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2816 protocol, &requests);
2820 /* Add flows that exist in the file but not on the switch.
2821 * Update flows that exist in both places but differ. */
2822 CLS_FOR_EACH (fte, rule, &cls) {
2823 struct fte_version *file_ver = fte->versions[FILE_IDX];
2824 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2827 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2828 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2832 bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
2834 transact_multiple_noreply(vconn, &requests);
2842 read_flows_from_source(const char *source, struct classifier *cls, int index)
2846 if (source[0] == '/' || source[0] == '.'
2847 || (!strchr(source, ':') && !stat(source, &s))) {
2848 read_flows_from_file(source, cls, index);
2850 enum ofputil_protocol protocol;
2851 struct vconn *vconn;
2853 protocol = open_vconn(source, &vconn);
2854 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2855 read_flows_from_switch(vconn, protocol, cls, index);
2861 ofctl_diff_flows(struct ovs_cmdl_context *ctx)
2863 bool differences = false;
2864 struct classifier cls;
2868 classifier_init(&cls, NULL);
2869 read_flows_from_source(ctx->argv[1], &cls, 0);
2870 read_flows_from_source(ctx->argv[2], &cls, 1);
2875 CLS_FOR_EACH (fte, rule, &cls) {
2876 struct fte_version *a = fte->versions[0];
2877 struct fte_version *b = fte->versions[1];
2879 if (!a || !b || !fte_version_equals(a, b)) {
2880 fte_version_format(fte, 0, &a_s);
2881 fte_version_format(fte, 1, &b_s);
2882 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2884 printf("-%s", ds_cstr(&a_s));
2887 printf("+%s", ds_cstr(&b_s));
2905 ofctl_meter_mod__(const char *bridge, const char *str, int command)
2907 struct ofputil_meter_mod mm;
2908 struct vconn *vconn;
2909 enum ofputil_protocol protocol;
2910 enum ofputil_protocol usable_protocols;
2911 enum ofp_version version;
2915 error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
2917 ovs_fatal(0, "%s", error);
2920 usable_protocols = OFPUTIL_P_OF13_UP;
2921 mm.command = command;
2922 mm.meter.meter_id = OFPM13_ALL;
2925 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2926 version = ofputil_protocol_to_ofp_version(protocol);
2927 transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
2932 ofctl_meter_request__(const char *bridge, const char *str,
2933 enum ofputil_meter_request_type type)
2935 struct ofputil_meter_mod mm;
2936 struct vconn *vconn;
2937 enum ofputil_protocol usable_protocols;
2938 enum ofputil_protocol protocol;
2939 enum ofp_version version;
2943 error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
2945 ovs_fatal(0, "%s", error);
2948 usable_protocols = OFPUTIL_P_OF13_UP;
2949 mm.meter.meter_id = OFPM13_ALL;
2952 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2953 version = ofputil_protocol_to_ofp_version(protocol);
2954 transact_noreply(vconn, ofputil_encode_meter_request(version,
2956 mm.meter.meter_id));
2962 ofctl_add_meter(struct ovs_cmdl_context *ctx)
2964 ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_ADD);
2968 ofctl_mod_meter(struct ovs_cmdl_context *ctx)
2970 ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_MODIFY);
2974 ofctl_del_meters(struct ovs_cmdl_context *ctx)
2976 ofctl_meter_mod__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL, OFPMC13_DELETE);
2980 ofctl_dump_meters(struct ovs_cmdl_context *ctx)
2982 ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
2983 OFPUTIL_METER_CONFIG);
2987 ofctl_meter_stats(struct ovs_cmdl_context *ctx)
2989 ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
2990 OFPUTIL_METER_STATS);
2994 ofctl_meter_features(struct ovs_cmdl_context *ctx)
2996 ofctl_meter_request__(ctx->argv[1], NULL, OFPUTIL_METER_FEATURES);
3000 /* Undocumented commands for unit testing. */
3003 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
3004 enum ofputil_protocol usable_protocols)
3006 enum ofputil_protocol protocol = 0;
3010 usable_s = ofputil_protocols_to_string(usable_protocols);
3011 printf("usable protocols: %s\n", usable_s);
3014 if (!(usable_protocols & allowed_protocols)) {
3015 ovs_fatal(0, "no usable protocol");
3017 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
3019 if (protocol & usable_protocols & allowed_protocols) {
3023 ovs_assert(is_pow2(protocol));
3025 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
3027 for (i = 0; i < n_fms; i++) {
3028 struct ofputil_flow_mod *fm = &fms[i];
3031 msg = ofputil_encode_flow_mod(fm, protocol);
3032 ofp_print(stdout, msg->data, msg->size, verbosity);
3035 free(CONST_CAST(struct ofpact *, fm->ofpacts));
3039 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
3040 * it back to stdout. */
3042 ofctl_parse_flow(struct ovs_cmdl_context *ctx)
3044 enum ofputil_protocol usable_protocols;
3045 struct ofputil_flow_mod fm;
3048 error = parse_ofp_flow_mod_str(&fm, ctx->argv[1], OFPFC_ADD, &usable_protocols);
3050 ovs_fatal(0, "%s", error);
3052 ofctl_parse_flows__(&fm, 1, usable_protocols);
3055 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
3056 * add-flows) and prints each of the flows back to stdout. */
3058 ofctl_parse_flows(struct ovs_cmdl_context *ctx)
3060 enum ofputil_protocol usable_protocols;
3061 struct ofputil_flow_mod *fms = NULL;
3065 error = parse_ofp_flow_mod_file(ctx->argv[1], OFPFC_ADD, &fms, &n_fms,
3068 ovs_fatal(0, "%s", error);
3070 ofctl_parse_flows__(fms, n_fms, usable_protocols);
3075 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
3080 while (!ds_get_test_line(&in, stdin)) {
3081 struct ofpbuf nx_match;
3083 ovs_be64 cookie, cookie_mask;
3087 /* Convert string to nx_match. */
3088 ofpbuf_init(&nx_match, 0);
3090 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
3092 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
3095 /* Convert nx_match to match. */
3098 error = oxm_pull_match(&nx_match, &match);
3100 error = nx_pull_match(&nx_match, match_len, &match,
3101 &cookie, &cookie_mask);
3105 error = oxm_pull_match_loose(&nx_match, &match);
3107 error = nx_pull_match_loose(&nx_match, match_len, &match,
3108 &cookie, &cookie_mask);
3116 /* Convert match back to nx_match. */
3117 ofpbuf_uninit(&nx_match);
3118 ofpbuf_init(&nx_match, 0);
3120 match_len = oxm_put_match(&nx_match, &match, version);
3121 out = oxm_match_to_string(&nx_match, match_len);
3123 match_len = nx_put_match(&nx_match, &match,
3124 cookie, cookie_mask);
3125 out = nx_match_to_string(nx_match.data, match_len);
3131 if (verbosity > 0) {
3132 ovs_hex_dump(stdout, nx_match.data, nx_match.size, 0, false);
3135 printf("nx_pull_match() returned error %s\n",
3136 ofperr_get_name(error));
3139 ofpbuf_uninit(&nx_match);
3144 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
3145 * stdin, does some internal fussing with them, and then prints them back as
3146 * strings on stdout. */
3148 ofctl_parse_nxm(struct ovs_cmdl_context *ctx OVS_UNUSED)
3150 ofctl_parse_nxm__(false, 0);
3153 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
3154 * strings from stdin, does some internal fussing with them, and then prints
3155 * them back as strings on stdout. VERSION must specify an OpenFlow version,
3156 * e.g. "OpenFlow12". */
3158 ofctl_parse_oxm(struct ovs_cmdl_context *ctx)
3160 enum ofp_version version = ofputil_version_from_string(ctx->argv[1]);
3161 if (version < OFP12_VERSION) {
3162 ovs_fatal(0, "%s: not a valid version for OXM", ctx->argv[1]);
3165 ofctl_parse_nxm__(true, version);
3169 print_differences(const char *prefix,
3170 const void *a_, size_t a_len,
3171 const void *b_, size_t b_len)
3173 const uint8_t *a = a_;
3174 const uint8_t *b = b_;
3177 for (i = 0; i < MIN(a_len, b_len); i++) {
3179 printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
3180 prefix, i, a[i], b[i]);
3183 for (i = a_len; i < b_len; i++) {
3184 printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
3186 for (i = b_len; i < a_len; i++) {
3187 printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
3192 ofctl_parse_actions__(const char *version_s, bool instructions)
3194 enum ofp_version version;
3197 version = ofputil_version_from_string(version_s);
3199 ovs_fatal(0, "%s: not a valid OpenFlow version", version_s);
3203 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3204 struct ofpbuf of_out;
3205 struct ofpbuf of_in;
3206 struct ofpbuf ofpacts;
3207 const char *table_id;
3213 /* Parse table_id separated with the follow-up actions by ",", if
3215 actions = ds_cstr(&in);
3217 if (strstr(actions, ",")) {
3218 table_id = strsep(&actions, ",");
3221 /* Parse hex bytes. */
3222 ofpbuf_init(&of_in, 0);
3223 if (ofpbuf_put_hex(&of_in, actions, NULL)[0] != '\0') {
3224 ovs_fatal(0, "Trailing garbage in hex data");
3227 /* Convert to ofpacts. */
3228 ofpbuf_init(&ofpacts, 0);
3230 error = (instructions
3231 ? ofpacts_pull_openflow_instructions
3232 : ofpacts_pull_openflow_actions)(
3233 &of_in, of_in.size, version, &ofpacts);
3234 if (!error && instructions) {
3235 /* Verify actions, enforce consistency. */
3236 enum ofputil_protocol protocol;
3239 memset(&flow, 0, sizeof flow);
3240 protocol = ofputil_protocols_from_ofp_version(version);
3241 error = ofpacts_check_consistency(ofpacts.data, ofpacts.size,
3243 table_id ? atoi(table_id) : 0,
3247 printf("bad %s %s: %s\n\n",
3248 version_s, instructions ? "instructions" : "actions",
3249 ofperr_get_name(error));
3250 ofpbuf_uninit(&ofpacts);
3251 ofpbuf_uninit(&of_in);
3254 ofpbuf_push_uninit(&of_in, size);
3256 /* Print cls_rule. */
3258 ds_put_cstr(&s, "actions=");
3259 ofpacts_format(ofpacts.data, ofpacts.size, &s);
3263 /* Convert back to ofp10 actions and print differences from input. */
3264 ofpbuf_init(&of_out, 0);
3266 ofpacts_put_openflow_instructions(ofpacts.data, ofpacts.size,
3269 ofpacts_put_openflow_actions(ofpacts.data, ofpacts.size,
3273 print_differences("", of_in.data, of_in.size,
3274 of_out.data, of_out.size);
3277 ofpbuf_uninit(&ofpacts);
3278 ofpbuf_uninit(&of_in);
3279 ofpbuf_uninit(&of_out);
3284 /* "parse-actions VERSION": reads a series of action specifications for the
3285 * given OpenFlow VERSION as hex bytes from stdin, converts them to ofpacts,
3286 * prints them as strings on stdout, and then converts them back to hex bytes
3287 * and prints any differences from the input. */
3289 ofctl_parse_actions(struct ovs_cmdl_context *ctx)
3291 ofctl_parse_actions__(ctx->argv[1], false);
3294 /* "parse-actions VERSION": reads a series of instruction specifications for
3295 * the given OpenFlow VERSION as hex bytes from stdin, converts them to
3296 * ofpacts, prints them as strings on stdout, and then converts them back to
3297 * hex bytes and prints any differences from the input. */
3299 ofctl_parse_instructions(struct ovs_cmdl_context *ctx)
3301 ofctl_parse_actions__(ctx->argv[1], true);
3304 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3305 * bytes from stdin, converts them to cls_rules, prints them as strings on
3306 * stdout, and then converts them back to hex bytes and prints any differences
3309 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3310 * values are ignored in the input and will be set to zero when OVS converts
3311 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
3312 * it does the conversion to hex, to ensure that in fact they are ignored. */
3314 ofctl_parse_ofp10_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3321 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3322 struct ofpbuf match_in, match_expout;
3323 struct ofp10_match match_out;
3324 struct ofp10_match match_normal;
3328 /* Parse hex bytes to use for expected output. */
3330 ds_put_cstr(&expout, ds_cstr(&in));
3331 for (p = ds_cstr(&expout); *p; p++) {
3336 ofpbuf_init(&match_expout, 0);
3337 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3338 ovs_fatal(0, "Trailing garbage in hex data");
3340 if (match_expout.size != sizeof(struct ofp10_match)) {
3341 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3342 match_expout.size, sizeof(struct ofp10_match));
3345 /* Parse hex bytes for input. */
3346 for (p = ds_cstr(&in); *p; p++) {
3348 *p = "0123456789abcdef"[random_uint32() & 0xf];
3351 ofpbuf_init(&match_in, 0);
3352 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3353 ovs_fatal(0, "Trailing garbage in hex data");
3355 if (match_in.size != sizeof(struct ofp10_match)) {
3356 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3357 match_in.size, sizeof(struct ofp10_match));
3360 /* Convert to cls_rule and print. */
3361 ofputil_match_from_ofp10_match(match_in.data, &match);
3362 match_print(&match);
3364 /* Convert back to ofp10_match and print differences from input. */
3365 ofputil_match_to_ofp10_match(&match, &match_out);
3366 print_differences("", match_expout.data, match_expout.size,
3367 &match_out, sizeof match_out);
3369 /* Normalize, then convert and compare again. */
3370 ofputil_normalize_match(&match);
3371 ofputil_match_to_ofp10_match(&match, &match_normal);
3372 print_differences("normal: ", &match_out, sizeof match_out,
3373 &match_normal, sizeof match_normal);
3376 ofpbuf_uninit(&match_in);
3377 ofpbuf_uninit(&match_expout);
3380 ds_destroy(&expout);
3383 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3384 * bytes from stdin, converts them to "struct match"es, prints them as strings
3385 * on stdout, and then converts them back to hex bytes and prints any
3386 * differences from the input. */
3388 ofctl_parse_ofp11_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3393 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3394 struct ofpbuf match_in;
3395 struct ofp11_match match_out;
3399 /* Parse hex bytes. */
3400 ofpbuf_init(&match_in, 0);
3401 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3402 ovs_fatal(0, "Trailing garbage in hex data");
3404 if (match_in.size != sizeof(struct ofp11_match)) {
3405 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3406 match_in.size, sizeof(struct ofp11_match));
3409 /* Convert to match. */
3410 error = ofputil_match_from_ofp11_match(match_in.data, &match);
3412 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3413 ofpbuf_uninit(&match_in);
3418 match_print(&match);
3420 /* Convert back to ofp11_match and print differences from input. */
3421 ofputil_match_to_ofp11_match(&match, &match_out);
3423 print_differences("", match_in.data, match_in.size,
3424 &match_out, sizeof match_out);
3427 ofpbuf_uninit(&match_in);
3432 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3434 ofctl_parse_pcap(struct ovs_cmdl_context *ctx)
3438 pcap = ovs_pcap_open(ctx->argv[1], "rb");
3440 ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
3444 struct dp_packet *packet;
3448 error = ovs_pcap_read(pcap, &packet, NULL);
3452 ovs_fatal(error, "%s: read failed", ctx->argv[1]);
3455 pkt_metadata_init(&packet->md, ODPP_NONE);
3456 flow_extract(packet, &flow);
3457 flow_print(stdout, &flow);
3459 dp_packet_delete(packet);
3463 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3464 * mask values to and from various formats and prints the results. */
3466 ofctl_check_vlan(struct ovs_cmdl_context *ctx)
3471 struct ofputil_flow_mod fm;
3474 struct match nxm_match;
3478 struct ofp10_match of10_raw;
3479 struct match of10_match;
3481 struct ofp11_match of11_raw;
3482 struct match of11_match;
3487 enum ofputil_protocol usable_protocols; /* Unused for now. */
3489 match_init_catchall(&match);
3490 match.flow.vlan_tci = htons(strtoul(ctx->argv[1], NULL, 16));
3491 match.wc.masks.vlan_tci = htons(strtoul(ctx->argv[2], NULL, 16));
3493 /* Convert to and from string. */
3494 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3495 printf("%s -> ", string_s);
3497 error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3499 ovs_fatal(0, "%s", error_s);
3501 printf("%04"PRIx16"/%04"PRIx16"\n",
3502 ntohs(fm.match.flow.vlan_tci),
3503 ntohs(fm.match.wc.masks.vlan_tci));
3506 /* Convert to and from NXM. */
3507 ofpbuf_init(&nxm, 0);
3508 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3509 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
3510 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3511 printf("NXM: %s -> ", nxm_s);
3513 printf("%s\n", ofperr_to_string(error));
3515 printf("%04"PRIx16"/%04"PRIx16"\n",
3516 ntohs(nxm_match.flow.vlan_tci),
3517 ntohs(nxm_match.wc.masks.vlan_tci));
3520 ofpbuf_uninit(&nxm);
3522 /* Convert to and from OXM. */
3523 ofpbuf_init(&nxm, 0);
3524 nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3525 nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3526 error = oxm_pull_match(&nxm, &nxm_match);
3527 printf("OXM: %s -> ", nxm_s);
3529 printf("%s\n", ofperr_to_string(error));
3531 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3532 (VLAN_VID_MASK | VLAN_CFI);
3533 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3534 (VLAN_VID_MASK | VLAN_CFI);
3536 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3537 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3538 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3544 ofpbuf_uninit(&nxm);
3546 /* Convert to and from OpenFlow 1.0. */
3547 ofputil_match_to_ofp10_match(&match, &of10_raw);
3548 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3549 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3550 ntohs(of10_raw.dl_vlan),
3551 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3552 of10_raw.dl_vlan_pcp,
3553 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3554 ntohs(of10_match.flow.vlan_tci),
3555 ntohs(of10_match.wc.masks.vlan_tci));
3557 /* Convert to and from OpenFlow 1.1. */
3558 ofputil_match_to_ofp11_match(&match, &of11_raw);
3559 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3560 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3561 ntohs(of11_raw.dl_vlan),
3562 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3563 of11_raw.dl_vlan_pcp,
3564 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3565 ntohs(of11_match.flow.vlan_tci),
3566 ntohs(of11_match.wc.masks.vlan_tci));
3569 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3572 ofctl_print_error(struct ovs_cmdl_context *ctx)
3577 error = ofperr_from_name(ctx->argv[1]);
3579 ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3582 for (version = 0; version <= UINT8_MAX; version++) {
3583 const char *name = ofperr_domain_get_name(version);
3585 int vendor = ofperr_get_vendor(error, version);
3586 int type = ofperr_get_type(error, version);
3587 int code = ofperr_get_code(error, version);
3589 if (vendor != -1 || type != -1 || code != -1) {
3590 printf("%s: vendor %#x, type %d, code %d\n",
3591 name, vendor, type, code);
3597 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3598 * error named ENUM and prints the error reply in hex. */
3600 ofctl_encode_error_reply(struct ovs_cmdl_context *ctx)
3602 const struct ofp_header *oh;
3603 struct ofpbuf request, *reply;
3606 error = ofperr_from_name(ctx->argv[1]);
3608 ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3611 ofpbuf_init(&request, 0);
3612 if (ofpbuf_put_hex(&request, ctx->argv[2], NULL)[0] != '\0') {
3613 ovs_fatal(0, "Trailing garbage in hex data");
3615 if (request.size < sizeof(struct ofp_header)) {
3616 ovs_fatal(0, "Request too short");
3620 if (request.size != ntohs(oh->length)) {
3621 ovs_fatal(0, "Request size inconsistent");
3624 reply = ofperr_encode_reply(error, request.data);
3625 ofpbuf_uninit(&request);
3627 ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
3628 ofpbuf_delete(reply);
3631 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3632 * binary data, interpreting them as an OpenFlow message, and prints the
3633 * OpenFlow message on stdout, at VERBOSITY (level 2 by default).
3635 * Alternative usage: "ofp-print [VERBOSITY] - < HEXSTRING_FILE", where
3636 * HEXSTRING_FILE contains the HEXSTRING. */
3638 ofctl_ofp_print(struct ovs_cmdl_context *ctx)
3640 struct ofpbuf packet;
3647 if (!strcmp(ctx->argv[ctx->argc-1], "-")) {
3648 if (ds_get_line(&line, stdin)) {
3649 VLOG_FATAL("Failed to read stdin");
3652 buffer = line.string;
3653 verbosity = ctx->argc > 2 ? atoi(ctx->argv[1]) : verbosity;
3654 } else if (ctx->argc > 2) {
3655 buffer = ctx->argv[1];
3656 verbosity = atoi(ctx->argv[2]);
3658 buffer = ctx->argv[1];
3661 ofpbuf_init(&packet, strlen(buffer) / 2);
3662 if (ofpbuf_put_hex(&packet, buffer, NULL)[0] != '\0') {
3663 ovs_fatal(0, "trailing garbage following hex bytes");
3665 ofp_print(stdout, packet.data, packet.size, verbosity);
3666 ofpbuf_uninit(&packet);
3670 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3671 * and dumps each message in hex. */
3673 ofctl_encode_hello(struct ovs_cmdl_context *ctx)
3675 uint32_t bitmap = strtol(ctx->argv[1], NULL, 0);
3676 struct ofpbuf *hello;
3678 hello = ofputil_encode_hello(bitmap);
3679 ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
3680 ofp_print(stdout, hello->data, hello->size, verbosity);
3681 ofpbuf_delete(hello);
3684 static const struct ovs_cmdl_command all_commands[] = {
3687 { "monitor", "switch [misslen] [invalid_ttl] [watch:[...]]",
3688 1, 3, ofctl_monitor },
3689 { "snoop", "switch",
3690 1, 1, ofctl_snoop },
3691 { "dump-desc", "switch",
3692 1, 1, ofctl_dump_desc },
3693 { "dump-tables", "switch",
3694 1, 1, ofctl_dump_tables },
3695 { "dump-table-features", "switch",
3696 1, 1, ofctl_dump_table_features },
3697 { "dump-table-desc", "switch",
3698 1, 1, ofctl_dump_table_desc },
3699 { "dump-flows", "switch",
3700 1, 2, ofctl_dump_flows },
3701 { "dump-aggregate", "switch",
3702 1, 2, ofctl_dump_aggregate },
3703 { "queue-stats", "switch [port [queue]]",
3704 1, 3, ofctl_queue_stats },
3705 { "queue-get-config", "switch port",
3706 2, 2, ofctl_queue_get_config },
3707 { "add-flow", "switch flow",
3708 2, 2, ofctl_add_flow },
3709 { "add-flows", "switch file",
3710 2, 2, ofctl_add_flows },
3711 { "mod-flows", "switch flow",
3712 2, 2, ofctl_mod_flows },
3713 { "del-flows", "switch [flow]",
3714 1, 2, ofctl_del_flows },
3715 { "replace-flows", "switch file",
3716 2, 2, ofctl_replace_flows },
3717 { "diff-flows", "source1 source2",
3718 2, 2, ofctl_diff_flows },
3719 { "add-meter", "switch meter",
3720 2, 2, ofctl_add_meter },
3721 { "mod-meter", "switch meter",
3722 2, 2, ofctl_mod_meter },
3723 { "del-meter", "switch meter",
3724 2, 2, ofctl_del_meters },
3725 { "del-meters", "switch",
3726 1, 1, ofctl_del_meters },
3727 { "dump-meter", "switch meter",
3728 2, 2, ofctl_dump_meters },
3729 { "dump-meters", "switch",
3730 1, 1, ofctl_dump_meters },
3731 { "meter-stats", "switch [meter]",
3732 1, 2, ofctl_meter_stats },
3733 { "meter-features", "switch",
3734 1, 1, ofctl_meter_features },
3735 { "packet-out", "switch in_port actions packet...",
3736 4, INT_MAX, ofctl_packet_out },
3737 { "dump-ports", "switch [port]",
3738 1, 2, ofctl_dump_ports },
3739 { "dump-ports-desc", "switch [port]",
3740 1, 2, ofctl_dump_ports_desc },
3741 { "mod-port", "switch iface act",
3742 3, 3, ofctl_mod_port },
3743 { "mod-table", "switch mod",
3744 3, 3, ofctl_mod_table },
3745 { "get-frags", "switch",
3746 1, 1, ofctl_get_frags },
3747 { "set-frags", "switch frag_mode",
3748 2, 2, ofctl_set_frags },
3749 { "probe", "target",
3750 1, 1, ofctl_probe },
3751 { "ping", "target [n]",
3753 { "benchmark", "target n count",
3754 3, 3, ofctl_benchmark },
3756 { "ofp-parse", "file",
3757 1, 1, ofctl_ofp_parse },
3758 { "ofp-parse-pcap", "pcap",
3759 1, INT_MAX, ofctl_ofp_parse_pcap },
3761 { "add-group", "switch group",
3762 1, 2, ofctl_add_group },
3763 { "add-groups", "switch file",
3764 1, 2, ofctl_add_groups },
3765 { "mod-group", "switch group",
3766 1, 2, ofctl_mod_group },
3767 { "del-groups", "switch [group]",
3768 1, 2, ofctl_del_groups },
3769 { "insert-buckets", "switch [group]",
3770 1, 2, ofctl_insert_bucket },
3771 { "remove-buckets", "switch [group]",
3772 1, 2, ofctl_remove_bucket },
3773 { "dump-groups", "switch [group]",
3774 1, 2, ofctl_dump_group_desc },
3775 { "dump-group-stats", "switch [group]",
3776 1, 2, ofctl_dump_group_stats },
3777 { "dump-group-features", "switch",
3778 1, 1, ofctl_dump_group_features },
3779 { "add-geneve-map", "switch map",
3780 2, 2, ofctl_add_geneve_map },
3781 { "del-geneve-map", "switch [map]",
3782 1, 2, ofctl_del_geneve_map },
3783 { "dump-geneve-map", "switch",
3784 1, 1, ofctl_dump_geneve_map },
3785 { "help", NULL, 0, INT_MAX, ofctl_help },
3786 { "list-commands", NULL, 0, INT_MAX, ofctl_list_commands },
3788 /* Undocumented commands for testing. */
3789 { "parse-flow", NULL, 1, 1, ofctl_parse_flow },
3790 { "parse-flows", NULL, 1, 1, ofctl_parse_flows },
3791 { "parse-nx-match", NULL, 0, 0, ofctl_parse_nxm },
3792 { "parse-nxm", NULL, 0, 0, ofctl_parse_nxm },
3793 { "parse-oxm", NULL, 1, 1, ofctl_parse_oxm },
3794 { "parse-actions", NULL, 1, 1, ofctl_parse_actions },
3795 { "parse-instructions", NULL, 1, 1, ofctl_parse_instructions },
3796 { "parse-ofp10-match", NULL, 0, 0, ofctl_parse_ofp10_match },
3797 { "parse-ofp11-match", NULL, 0, 0, ofctl_parse_ofp11_match },
3798 { "parse-pcap", NULL, 1, 1, ofctl_parse_pcap },
3799 { "check-vlan", NULL, 2, 2, ofctl_check_vlan },
3800 { "print-error", NULL, 1, 1, ofctl_print_error },
3801 { "encode-error-reply", NULL, 2, 2, ofctl_encode_error_reply },
3802 { "ofp-print", NULL, 1, 2, ofctl_ofp_print },
3803 { "encode-hello", NULL, 1, 1, ofctl_encode_hello },
3805 { NULL, NULL, 0, 0, NULL },
3808 static const struct ovs_cmdl_command *get_all_commands(void)
3810 return all_commands;