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;
134 daemon_become_new_user(false);
135 ovs_cmdl_run_command(&ctx, get_all_commands());
140 add_sort_criterion(enum sort_order order, const char *field)
142 struct sort_criterion *sc;
144 if (n_criteria >= allocated_criteria) {
145 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
148 sc = &criteria[n_criteria++];
149 if (!field || !strcasecmp(field, "priority")) {
152 sc->field = mf_from_name(field);
154 ovs_fatal(0, "%s: unknown field name", field);
161 parse_options(int argc, char *argv[])
164 OPT_STRICT = UCHAR_MAX + 1,
172 OFP_VERSION_OPTION_ENUMS,
175 static const struct option long_options[] = {
176 {"timeout", required_argument, NULL, 't'},
177 {"strict", no_argument, NULL, OPT_STRICT},
178 {"readd", no_argument, NULL, OPT_READD},
179 {"flow-format", required_argument, NULL, 'F'},
180 {"packet-in-format", required_argument, NULL, 'P'},
181 {"more", no_argument, NULL, 'm'},
182 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
183 {"sort", optional_argument, NULL, OPT_SORT},
184 {"rsort", optional_argument, NULL, OPT_RSORT},
185 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
186 {"help", no_argument, NULL, 'h'},
187 {"option", no_argument, NULL, 'o'},
188 {"bundle", no_argument, NULL, OPT_BUNDLE},
190 OFP_VERSION_LONG_OPTIONS,
192 STREAM_SSL_LONG_OPTIONS,
195 char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
197 enum ofputil_protocol version_protocols;
199 /* For now, ovs-ofctl only enables OpenFlow 1.0 by default. This is
200 * because ovs-ofctl implements command such as "add-flow" as raw OpenFlow
201 * requests, but those requests have subtly different semantics in
202 * different OpenFlow versions. For example:
204 * - In OpenFlow 1.0, a "mod-flow" operation that does not find any
205 * existing flow to modify adds a new flow.
207 * - In OpenFlow 1.1, a "mod-flow" operation that does not find any
208 * existing flow to modify adds a new flow, but only if the mod-flow
209 * did not match on the flow cookie.
211 * - In OpenFlow 1.2 and a later, a "mod-flow" operation never adds a
214 set_allowed_ofp_versions("OpenFlow10");
217 unsigned long int timeout;
220 c = getopt_long(argc, argv, short_options, long_options, NULL);
227 timeout = strtoul(optarg, NULL, 10);
229 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
237 allowed_protocols = ofputil_protocols_from_string(optarg);
238 if (!allowed_protocols) {
239 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
244 preferred_packet_in_format =
245 ofputil_packet_in_format_from_string(optarg);
246 if (preferred_packet_in_format < 0) {
247 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
259 ovs_cmdl_print_options(long_options);
279 add_sort_criterion(SORT_ASC, optarg);
283 add_sort_criterion(SORT_DESC, optarg);
287 unixctl_path = optarg;
290 DAEMON_OPTION_HANDLERS
291 OFP_VERSION_OPTION_HANDLERS
293 STREAM_SSL_OPTION_HANDLERS
304 /* Always do a final sort pass based on priority. */
305 add_sort_criterion(SORT_DESC, "priority");
310 /* Implicit OpenFlow 1.4 with the '--bundle' option. */
312 /* Add implicit allowance for OpenFlow 1.4. */
313 add_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
314 OFPUTIL_P_OF14_OXM));
316 versions = get_allowed_ofp_versions();
317 version_protocols = ofputil_protocols_from_version_bitmap(versions);
318 if (!(allowed_protocols & version_protocols)) {
319 char *protocols = ofputil_protocols_to_string(allowed_protocols);
320 struct ds version_s = DS_EMPTY_INITIALIZER;
322 ofputil_format_version_bitmap_names(&version_s, versions);
323 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
324 "any of the enabled flow formats (%s). (Use -O to enable "
325 "additional OpenFlow versions or -F to enable additional "
326 "flow formats.)", ds_cstr(&version_s), protocols);
328 allowed_protocols &= version_protocols;
329 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
336 printf("%s: OpenFlow switch management utility\n"
337 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
338 "\nFor OpenFlow switches:\n"
339 " show SWITCH show OpenFlow information\n"
340 " dump-desc SWITCH print switch description\n"
341 " dump-tables SWITCH print table stats\n"
342 " dump-table-features SWITCH print table features\n"
343 " dump-table-desc SWITCH print table description (OF1.4+)\n"
344 " mod-port SWITCH IFACE ACT modify port behavior\n"
345 " mod-table SWITCH MOD modify flow table behavior\n"
346 " OF1.1/1.2 MOD: controller, continue, drop\n"
347 " OF1.4+ MOD: evict, noevict\n"
348 " get-frags SWITCH print fragment handling behavior\n"
349 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
350 " FRAG_MODE: normal, drop, reassemble, nx-match\n"
351 " dump-ports SWITCH [PORT] print port statistics\n"
352 " dump-ports-desc SWITCH [PORT] print port descriptions\n"
353 " dump-flows SWITCH print all flow entries\n"
354 " dump-flows SWITCH FLOW print matching FLOWs\n"
355 " dump-aggregate SWITCH print aggregate flow statistics\n"
356 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
357 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
358 " add-flow SWITCH FLOW add flow described by FLOW\n"
359 " add-flows SWITCH FILE add flows from FILE\n"
360 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
361 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
362 " replace-flows SWITCH FILE replace flows with those in FILE\n"
363 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
364 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
365 " execute ACTIONS on PACKET\n"
366 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
367 " print packets received from SWITCH\n"
368 " snoop SWITCH snoop on SWITCH and its controller\n"
369 " add-group SWITCH GROUP add group described by GROUP\n"
370 " add-groups SWITCH FILE add group from FILE\n"
371 " mod-group SWITCH GROUP modify specific group\n"
372 " del-groups SWITCH [GROUP] delete matching GROUPs\n"
373 " insert-buckets SWITCH [GROUP] add buckets to GROUP\n"
374 " remove-buckets SWITCH [GROUP] remove buckets from GROUP\n"
375 " dump-group-features SWITCH print group features\n"
376 " dump-groups SWITCH [GROUP] print group description\n"
377 " dump-group-stats SWITCH [GROUP] print group statistics\n"
378 " queue-get-config SWITCH PORT print queue information for port\n"
379 " add-meter SWITCH METER add meter described by METER\n"
380 " mod-meter SWITCH METER modify specific METER\n"
381 " del-meter SWITCH METER delete METER\n"
382 " del-meters SWITCH delete all meters\n"
383 " dump-meter SWITCH METER print METER configuration\n"
384 " dump-meters SWITCH print all meter configuration\n"
385 " meter-stats SWITCH [METER] print meter statistics\n"
386 " meter-features SWITCH print meter features\n"
387 " add-geneve-map SWITCH MAP add Geneve option MAPpings\n"
388 " del-geneve-map SWITCH [MAP] delete Geneve option MAPpings\n"
389 " dump-geneve-map SWITCH print Geneve option mappings\n"
390 "\nFor OpenFlow switches and controllers:\n"
391 " probe TARGET probe whether TARGET is up\n"
392 " ping TARGET [N] latency of N-byte echos\n"
393 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
394 "SWITCH or TARGET is an active OpenFlow connection method.\n"
395 "\nOther commands:\n"
396 " ofp-parse FILE print messages read from FILE\n"
397 " ofp-parse-pcap PCAP print OpenFlow read from PCAP\n",
398 program_name, program_name);
399 vconn_usage(true, false, false);
403 printf("\nOther options:\n"
404 " --strict use strict match for flow commands\n"
405 " --readd replace flows that haven't changed\n"
406 " -F, --flow-format=FORMAT force particular flow format\n"
407 " -P, --packet-in-format=FRMT force particular packet in format\n"
408 " -m, --more be more verbose printing OpenFlow\n"
409 " --timestamp (monitor, snoop) print timestamps\n"
410 " -t, --timeout=SECS give up after SECS seconds\n"
411 " --sort[=field] sort in ascending order\n"
412 " --rsort[=field] sort in descending order\n"
413 " --unixctl=SOCKET set control socket name\n"
414 " -h, --help display this help message\n"
415 " -V, --version display version information\n");
420 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
421 const char *argv[] OVS_UNUSED, void *exiting_)
423 bool *exiting = exiting_;
425 unixctl_command_reply(conn, NULL);
428 static void run(int retval, const char *message, ...)
429 OVS_PRINTF_FORMAT(2, 3);
432 run(int retval, const char *message, ...)
437 va_start(args, message);
438 ovs_fatal_valist(retval, message, args);
442 /* Generic commands. */
445 open_vconn_socket(const char *name, struct vconn **vconnp)
447 char *vconn_name = xasprintf("unix:%s", name);
450 error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
452 if (error && error != ENOENT) {
453 ovs_fatal(0, "%s: failed to open socket (%s)", name,
454 ovs_strerror(error));
461 enum open_target { MGMT, SNOOP };
463 static enum ofputil_protocol
464 open_vconn__(const char *name, enum open_target target,
465 struct vconn **vconnp)
467 const char *suffix = target == MGMT ? "mgmt" : "snoop";
468 char *datapath_name, *datapath_type, *socket_name;
469 enum ofputil_protocol protocol;
474 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
476 ofproto_parse_name(name, &datapath_name, &datapath_type);
477 socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
481 if (strchr(name, ':')) {
482 run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
483 "connecting to %s", name);
484 } else if (!open_vconn_socket(name, vconnp)) {
486 } else if (!open_vconn_socket(bridge_path, vconnp)) {
488 } else if (!open_vconn_socket(socket_name, vconnp)) {
491 ovs_fatal(0, "%s is not a bridge or a socket", name);
494 if (target == SNOOP) {
495 vconn_set_recv_any_version(*vconnp);
501 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
502 error = vconn_connect_block(*vconnp);
504 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
505 ovs_strerror(error));
508 ofp_version = vconn_get_version(*vconnp);
509 protocol = ofputil_protocol_from_ofp_version(ofp_version);
511 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
517 static enum ofputil_protocol
518 open_vconn(const char *name, struct vconn **vconnp)
520 return open_vconn__(name, MGMT, vconnp);
524 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
526 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
530 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
532 struct ofpbuf *reply;
534 run(vconn_transact(vconn, request, &reply), "talking to %s",
535 vconn_get_name(vconn));
536 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
537 ofpbuf_delete(reply);
541 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
543 struct ofpbuf *request;
546 open_vconn(vconn_name, &vconn);
547 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
548 dump_transaction(vconn, request);
553 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
555 const struct ofp_header *request_oh = request->data;
556 ovs_be32 send_xid = request_oh->xid;
557 enum ofpraw request_raw;
558 enum ofpraw reply_raw;
561 ofpraw_decode_partial(&request_raw, request->data, request->size);
562 reply_raw = ofpraw_stats_request_to_reply(request_raw,
563 request_oh->version);
565 send_openflow_buffer(vconn, request);
568 struct ofpbuf *reply;
570 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
571 recv_xid = ((struct ofp_header *) reply->data)->xid;
572 if (send_xid == recv_xid) {
575 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
577 ofpraw_decode(&raw, reply->data);
578 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
580 } else if (raw == reply_raw) {
581 done = !ofpmp_more(reply->data);
583 ovs_fatal(0, "received bad reply: %s",
584 ofp_to_string(reply->data, reply->size,
588 VLOG_DBG("received reply with xid %08"PRIx32" "
589 "!= expected %08"PRIx32, recv_xid, send_xid);
591 ofpbuf_delete(reply);
596 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
598 struct ofpbuf *request;
601 open_vconn(vconn_name, &vconn);
602 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
603 dump_stats_transaction(vconn, request);
607 /* Sends all of the 'requests', which should be requests that only have replies
608 * if an error occurs, and waits for them to succeed or fail. If an error does
609 * occur, prints it and exits with an error.
611 * Destroys all of the 'requests'. */
613 transact_multiple_noreply(struct vconn *vconn, struct ovs_list *requests)
615 struct ofpbuf *reply;
617 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
618 "talking to %s", vconn_get_name(vconn));
620 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
623 ofpbuf_delete(reply);
627 bundle_error_reporter(const struct ofp_header *oh)
629 ofp_print(stderr, oh, ntohs(oh->length), verbosity + 1);
634 bundle_transact(struct vconn *vconn, struct ovs_list *requests, uint16_t flags)
636 run(vconn_bundle_transact(vconn, requests, flags, bundle_error_reporter),
637 "talking to %s", vconn_get_name(vconn));
640 /* Sends 'request', which should be a request that only has a reply if an error
641 * occurs, and waits for it to succeed or fail. If an error does occur, prints
642 * it and exits with an error.
644 * Destroys 'request'. */
646 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
648 struct ovs_list requests;
650 list_init(&requests);
651 list_push_back(&requests, &request->list_node);
652 transact_multiple_noreply(vconn, &requests);
656 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
658 struct ofp_switch_config *config;
659 struct ofpbuf *request;
660 struct ofpbuf *reply;
663 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
664 vconn_get_version(vconn), 0);
665 run(vconn_transact(vconn, request, &reply),
666 "talking to %s", vconn_get_name(vconn));
668 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
669 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
672 config = ofpbuf_pull(reply, sizeof *config);
675 ofpbuf_delete(reply);
679 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
681 struct ofpbuf *request;
683 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
684 ofpbuf_put(request, config, sizeof *config);
686 transact_noreply(vconn, request);
690 ofctl_show(struct ovs_cmdl_context *ctx)
692 const char *vconn_name = ctx->argv[1];
693 enum ofp_version version;
695 struct ofpbuf *request;
696 struct ofpbuf *reply;
699 open_vconn(vconn_name, &vconn);
700 version = vconn_get_version(vconn);
701 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, version, 0);
702 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
704 has_ports = ofputil_switch_features_has_ports(reply);
705 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
706 ofpbuf_delete(reply);
709 request = ofputil_encode_port_desc_stats_request(version, OFPP_ANY);
710 dump_stats_transaction(vconn, request);
712 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
717 ofctl_dump_desc(struct ovs_cmdl_context *ctx)
719 dump_trivial_stats_transaction(ctx->argv[1], OFPRAW_OFPST_DESC_REQUEST);
723 ofctl_dump_tables(struct ovs_cmdl_context *ctx)
725 dump_trivial_stats_transaction(ctx->argv[1], OFPRAW_OFPST_TABLE_REQUEST);
729 ofctl_dump_table_features(struct ovs_cmdl_context *ctx)
731 struct ofpbuf *request;
734 open_vconn(ctx->argv[1], &vconn);
735 request = ofputil_encode_table_features_request(vconn_get_version(vconn));
737 /* The following is similar to dump_trivial_stats_transaction(), but it
738 * maintains the previous 'ofputil_table_features' from one stats reply
739 * message to the next, which allows duplication to be eliminated in the
740 * output across messages. Otherwise the output is much larger and harder
741 * to read, because only 17 or so ofputil_table_features elements fit in a
742 * single 64 kB OpenFlow message and therefore you get a ton of repetition
743 * (every 17th element is printed in full instead of abbreviated). */
745 const struct ofp_header *request_oh = request->data;
746 ovs_be32 send_xid = request_oh->xid;
749 struct ofputil_table_features prev;
752 send_openflow_buffer(vconn, request);
755 struct ofpbuf *reply;
757 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
758 recv_xid = ((struct ofp_header *) reply->data)->xid;
759 if (send_xid == recv_xid) {
762 error = ofptype_decode(&type, reply->data);
764 ovs_fatal(0, "decode error: %s", ofperr_get_name(error));
765 } else if (type == OFPTYPE_ERROR) {
766 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
768 } else if (type == OFPTYPE_TABLE_FEATURES_STATS_REPLY) {
769 done = !ofpmp_more(reply->data);
771 struct ofputil_table_features tf;
774 retval = ofputil_decode_table_features(reply, &tf, true);
777 ovs_fatal(0, "decode error: %s",
778 ofperr_get_name(retval));
783 struct ds s = DS_EMPTY_INITIALIZER;
784 ofp_print_table_features(&s, &tf, n ? &prev : NULL,
793 ovs_fatal(0, "received bad reply: %s",
794 ofp_to_string(reply->data, reply->size,
798 VLOG_DBG("received reply with xid %08"PRIx32" "
799 "!= expected %08"PRIx32, recv_xid, send_xid);
801 ofpbuf_delete(reply);
808 ofctl_dump_table_desc(struct ovs_cmdl_context *ctx)
810 struct ofpbuf *request;
813 open_vconn(ctx->argv[1], &vconn);
814 request = ofputil_encode_table_desc_request(vconn_get_version(vconn));
816 dump_stats_transaction(vconn, request);
823 static bool fetch_port_by_stats(struct vconn *,
824 const char *port_name, ofp_port_t port_no,
825 struct ofputil_phy_port *);
827 /* Uses OFPT_FEATURES_REQUEST to attempt to fetch information about the port
828 * named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
829 * successful, false on failure.
831 * This is only appropriate for OpenFlow 1.0, 1.1, and 1.2, which include a
832 * list of ports in OFPT_FEATURES_REPLY. */
834 fetch_port_by_features(struct vconn *vconn,
835 const char *port_name, ofp_port_t port_no,
836 struct ofputil_phy_port *pp)
838 struct ofputil_switch_features features;
839 const struct ofp_header *oh;
840 struct ofpbuf *request, *reply;
846 /* Fetch the switch's ofp_switch_features. */
847 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
848 vconn_get_version(vconn), 0);
849 run(vconn_transact(vconn, request, &reply),
850 "talking to %s", vconn_get_name(vconn));
853 if (ofptype_decode(&type, reply->data)
854 || type != OFPTYPE_FEATURES_REPLY) {
855 ovs_fatal(0, "%s: received bad features reply", vconn_get_name(vconn));
857 if (!ofputil_switch_features_has_ports(reply)) {
858 /* The switch features reply does not contain a complete list of ports.
859 * Probably, there are more ports than will fit into a single 64 kB
860 * OpenFlow message. Use OFPST_PORT_DESC to get a complete list of
862 ofpbuf_delete(reply);
863 return fetch_port_by_stats(vconn, port_name, port_no, pp);
866 error = ofputil_decode_switch_features(oh, &features, &b);
868 ovs_fatal(0, "%s: failed to decode features reply (%s)",
869 vconn_get_name(vconn), ofperr_to_string(error));
872 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
873 if (port_no != OFPP_NONE
874 ? port_no == pp->port_no
875 : !strcmp(pp->name, port_name)) {
880 ofpbuf_delete(reply);
884 /* Uses a OFPST_PORT_DESC request to attempt to fetch information about the
885 * port named 'port_name' or numbered 'port_no' into '*pp'. Returns true if
886 * successful, false on failure.
888 * This is most appropriate for OpenFlow 1.3 and later. Open vSwitch 1.7 and
889 * later also implements OFPST_PORT_DESC, as an extension, for OpenFlow 1.0,
890 * 1.1, and 1.2, so this can be used as a fallback in those versions when there
891 * are too many ports than fit in an OFPT_FEATURES_REPLY. */
893 fetch_port_by_stats(struct vconn *vconn,
894 const char *port_name, ofp_port_t port_no,
895 struct ofputil_phy_port *pp)
897 struct ofpbuf *request;
902 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
904 send_xid = ((struct ofp_header *) request->data)->xid;
906 send_openflow_buffer(vconn, request);
909 struct ofpbuf *reply;
911 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
912 recv_xid = ((struct ofp_header *) reply->data)->xid;
913 if (send_xid == recv_xid) {
914 struct ofp_header *oh = reply->data;
919 ofpbuf_use_const(&b, oh, ntohs(oh->length));
920 if (ofptype_pull(&type, &b)
921 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
922 ovs_fatal(0, "received bad reply: %s",
923 ofp_to_string(reply->data, reply->size,
927 flags = ofpmp_flags(oh);
928 done = !(flags & OFPSF_REPLY_MORE);
931 /* We've already found the port, but we need to drain
932 * the queue of any other replies for this request. */
936 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
937 if (port_no != OFPP_NONE ? port_no == pp->port_no
938 : !strcmp(pp->name, port_name)) {
944 VLOG_DBG("received reply with xid %08"PRIx32" "
945 "!= expected %08"PRIx32, recv_xid, send_xid);
947 ofpbuf_delete(reply);
954 str_to_ofp(const char *s, ofp_port_t *ofp_port)
959 ret = str_to_uint(s, 10, &port_);
960 *ofp_port = u16_to_ofp(port_);
964 /* Opens a connection to 'vconn_name', fetches the port structure for
965 * 'port_name' (which may be a port name or number), and copies it into
968 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
969 struct ofputil_phy_port *pp)
975 /* Try to interpret the argument as a port number. */
976 if (!str_to_ofp(port_name, &port_no)) {
980 /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
981 * OFPT_FEATURES_REPLY message. OpenFlow 1.3 and later versions put it
982 * into the OFPST_PORT_DESC reply. Try it the correct way. */
983 open_vconn(vconn_name, &vconn);
984 found = (vconn_get_version(vconn) < OFP13_VERSION
985 ? fetch_port_by_features(vconn, port_name, port_no, pp)
986 : fetch_port_by_stats(vconn, port_name, port_no, pp));
990 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
994 /* Returns the port number corresponding to 'port_name' (which may be a port
995 * name or number) within the switch 'vconn_name'. */
997 str_to_port_no(const char *vconn_name, const char *port_name)
1001 if (ofputil_port_from_string(port_name, &port_no)) {
1004 struct ofputil_phy_port pp;
1006 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
1012 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
1013 enum ofputil_protocol *cur)
1016 struct ofpbuf *request, *reply;
1017 enum ofputil_protocol next;
1019 request = ofputil_encode_set_protocol(*cur, want, &next);
1021 return *cur == want;
1024 run(vconn_transact_noreply(vconn, request, &reply),
1025 "talking to %s", vconn_get_name(vconn));
1027 char *s = ofp_to_string(reply->data, reply->size, 2);
1028 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
1029 vconn_get_name(vconn), s);
1031 ofpbuf_delete(reply);
1039 static enum ofputil_protocol
1040 set_protocol_for_flow_dump(struct vconn *vconn,
1041 enum ofputil_protocol cur_protocol,
1042 enum ofputil_protocol usable_protocols)
1047 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
1048 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
1049 if (f & usable_protocols & allowed_protocols
1050 && try_set_protocol(vconn, f, &cur_protocol)) {
1055 usable_s = ofputil_protocols_to_string(usable_protocols);
1056 if (usable_protocols & allowed_protocols) {
1057 ovs_fatal(0, "switch does not support any of the usable flow "
1058 "formats (%s)", usable_s);
1060 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1061 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1062 "allowed flow formats (%s)", usable_s, allowed_s);
1066 static struct vconn *
1067 prepare_dump_flows(int argc, char *argv[], bool aggregate,
1068 struct ofpbuf **requestp)
1070 enum ofputil_protocol usable_protocols, protocol;
1071 struct ofputil_flow_stats_request fsr;
1072 struct vconn *vconn;
1075 error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
1076 argc > 2 ? argv[2] : "",
1079 ovs_fatal(0, "%s", error);
1082 protocol = open_vconn(argv[1], &vconn);
1083 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
1084 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
1089 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
1091 struct ofpbuf *request;
1092 struct vconn *vconn;
1094 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
1095 dump_stats_transaction(vconn, request);
1100 compare_flows(const void *afs_, const void *bfs_)
1102 const struct ofputil_flow_stats *afs = afs_;
1103 const struct ofputil_flow_stats *bfs = bfs_;
1104 const struct match *a = &afs->match;
1105 const struct match *b = &bfs->match;
1106 const struct sort_criterion *sc;
1108 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
1109 const struct mf_field *f = sc->field;
1113 int a_pri = afs->priority;
1114 int b_pri = bfs->priority;
1115 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
1119 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
1120 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
1122 /* Skip the test for sc->order, so that missing fields always
1123 * sort to the end whether we're sorting in ascending or
1124 * descending order. */
1125 return ina ? -1 : 1;
1127 union mf_value aval, bval;
1129 mf_get_value(f, &a->flow, &aval);
1130 mf_get_value(f, &b->flow, &bval);
1131 ret = memcmp(&aval, &bval, f->n_bytes);
1136 return sc->order == SORT_ASC ? ret : -ret;
1144 ofctl_dump_flows(struct ovs_cmdl_context *ctx)
1147 ofctl_dump_flows__(ctx->argc, ctx->argv, false);
1150 struct ofputil_flow_stats *fses;
1151 size_t n_fses, allocated_fses;
1152 struct ofpbuf *request;
1153 struct ofpbuf ofpacts;
1154 struct ofpbuf *reply;
1155 struct vconn *vconn;
1160 vconn = prepare_dump_flows(ctx->argc, ctx->argv, false, &request);
1161 send_xid = ((struct ofp_header *) request->data)->xid;
1162 send_openflow_buffer(vconn, request);
1165 n_fses = allocated_fses = 0;
1167 ofpbuf_init(&ofpacts, 0);
1169 struct ofputil_flow_stats *fs;
1171 if (n_fses >= allocated_fses) {
1172 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
1176 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
1180 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1183 ofpbuf_uninit(&ofpacts);
1185 qsort(fses, n_fses, sizeof *fses, compare_flows);
1188 for (i = 0; i < n_fses; i++) {
1190 ofp_print_flow_stats(&s, &fses[i]);
1195 for (i = 0; i < n_fses; i++) {
1196 free(CONST_CAST(struct ofpact *, fses[i].ofpacts));
1205 ofctl_dump_aggregate(struct ovs_cmdl_context *ctx)
1207 ofctl_dump_flows__(ctx->argc, ctx->argv, true);
1211 ofctl_queue_stats(struct ovs_cmdl_context *ctx)
1213 struct ofpbuf *request;
1214 struct vconn *vconn;
1215 struct ofputil_queue_stats_request oqs;
1217 open_vconn(ctx->argv[1], &vconn);
1219 if (ctx->argc > 2 && ctx->argv[2][0] && strcasecmp(ctx->argv[2], "all")) {
1220 oqs.port_no = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1222 oqs.port_no = OFPP_ANY;
1224 if (ctx->argc > 3 && ctx->argv[3][0] && strcasecmp(ctx->argv[3], "all")) {
1225 oqs.queue_id = atoi(ctx->argv[3]);
1227 oqs.queue_id = OFPQ_ALL;
1230 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1231 dump_stats_transaction(vconn, request);
1236 ofctl_queue_get_config(struct ovs_cmdl_context *ctx)
1238 const char *vconn_name = ctx->argv[1];
1239 const char *port_name = ctx->argv[2];
1240 enum ofputil_protocol protocol;
1241 enum ofp_version version;
1242 struct ofpbuf *request;
1243 struct vconn *vconn;
1246 port = str_to_port_no(vconn_name, port_name);
1248 protocol = open_vconn(vconn_name, &vconn);
1249 version = ofputil_protocol_to_ofp_version(protocol);
1250 request = ofputil_encode_queue_get_config_request(version, port);
1251 dump_transaction(vconn, request);
1255 static enum ofputil_protocol
1256 open_vconn_for_flow_mod(const char *remote, struct vconn **vconnp,
1257 enum ofputil_protocol usable_protocols)
1259 enum ofputil_protocol cur_protocol;
1263 if (!(usable_protocols & allowed_protocols)) {
1264 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1265 usable_s = ofputil_protocols_to_string(usable_protocols);
1266 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1267 "allowed flow formats (%s)", usable_s, allowed_s);
1270 /* If the initial flow format is allowed and usable, keep it. */
1271 cur_protocol = open_vconn(remote, vconnp);
1272 if (usable_protocols & allowed_protocols & cur_protocol) {
1273 return cur_protocol;
1276 /* Otherwise try each flow format in turn. */
1277 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1278 enum ofputil_protocol f = 1 << i;
1280 if (f != cur_protocol
1281 && f & usable_protocols & allowed_protocols
1282 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1287 usable_s = ofputil_protocols_to_string(usable_protocols);
1288 ovs_fatal(0, "switch does not support any of the usable flow "
1289 "formats (%s)", usable_s);
1293 bundle_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1294 size_t n_fms, enum ofputil_protocol usable_protocols)
1296 enum ofputil_protocol protocol;
1297 struct vconn *vconn;
1298 struct ovs_list requests;
1301 list_init(&requests);
1303 /* Bundles need OpenFlow 1.4+. */
1304 usable_protocols &= OFPUTIL_P_OF14_UP;
1305 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1307 for (i = 0; i < n_fms; i++) {
1308 struct ofputil_flow_mod *fm = &fms[i];
1309 struct ofpbuf *request = ofputil_encode_flow_mod(fm, protocol);
1311 list_push_back(&requests, &request->list_node);
1312 free(CONST_CAST(struct ofpact *, fm->ofpacts));
1315 bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
1320 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1321 size_t n_fms, enum ofputil_protocol usable_protocols)
1323 enum ofputil_protocol protocol;
1324 struct vconn *vconn;
1328 bundle_flow_mod__(remote, fms, n_fms, usable_protocols);
1332 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1334 for (i = 0; i < n_fms; i++) {
1335 struct ofputil_flow_mod *fm = &fms[i];
1337 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1338 free(CONST_CAST(struct ofpact *, fm->ofpacts));
1344 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], int command)
1346 enum ofputil_protocol usable_protocols;
1347 struct ofputil_flow_mod *fms = NULL;
1351 if (command == OFPFC_ADD) {
1352 /* Allow the file to specify a mix of commands. If none specified at
1353 * the beginning of any given line, then the default is OFPFC_ADD, so
1354 * this is backwards compatible. */
1357 error = parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms,
1360 ovs_fatal(0, "%s", error);
1362 ofctl_flow_mod__(argv[1], fms, n_fms, usable_protocols);
1367 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1369 if (argc > 2 && !strcmp(argv[2], "-")) {
1370 ofctl_flow_mod_file(argc, argv, command);
1372 struct ofputil_flow_mod fm;
1374 enum ofputil_protocol usable_protocols;
1376 error = parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command,
1379 ovs_fatal(0, "%s", error);
1381 ofctl_flow_mod__(argv[1], &fm, 1, usable_protocols);
1386 ofctl_add_flow(struct ovs_cmdl_context *ctx)
1388 ofctl_flow_mod(ctx->argc, ctx->argv, OFPFC_ADD);
1392 ofctl_add_flows(struct ovs_cmdl_context *ctx)
1394 ofctl_flow_mod_file(ctx->argc, ctx->argv, OFPFC_ADD);
1398 ofctl_mod_flows(struct ovs_cmdl_context *ctx)
1400 ofctl_flow_mod(ctx->argc, ctx->argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1404 ofctl_del_flows(struct ovs_cmdl_context *ctx)
1406 ofctl_flow_mod(ctx->argc, ctx->argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1410 set_packet_in_format(struct vconn *vconn,
1411 enum nx_packet_in_format packet_in_format)
1413 struct ofpbuf *spif;
1415 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1417 transact_noreply(vconn, spif);
1418 VLOG_DBG("%s: using user-specified packet in format %s",
1419 vconn_get_name(vconn),
1420 ofputil_packet_in_format_to_string(packet_in_format));
1424 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1426 struct ofp_switch_config config;
1427 enum ofp_config_flags flags;
1429 fetch_switch_config(vconn, &config);
1430 flags = ntohs(config.flags);
1431 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1432 /* Set the invalid ttl config. */
1433 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1435 config.flags = htons(flags);
1436 set_switch_config(vconn, &config);
1438 /* Then retrieve the configuration to see if it really took. OpenFlow
1439 * doesn't define error reporting for bad modes, so this is all we can
1441 fetch_switch_config(vconn, &config);
1442 flags = ntohs(config.flags);
1443 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1444 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1445 "switch probably doesn't support mode)");
1452 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1453 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1454 * an error message and stores NULL in '*msgp'. */
1456 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1458 struct ofp_header *oh;
1461 msg = ofpbuf_new(strlen(hex) / 2);
1464 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1466 return "Trailing garbage in hex data";
1469 if (msg->size < sizeof(struct ofp_header)) {
1471 return "Message too short for OpenFlow";
1475 if (msg->size != ntohs(oh->length)) {
1477 return "Message size does not match length in OpenFlow header";
1485 ofctl_send(struct unixctl_conn *conn, int argc,
1486 const char *argv[], void *vconn_)
1488 struct vconn *vconn = vconn_;
1495 for (i = 1; i < argc; i++) {
1496 const char *error_msg;
1500 error_msg = openflow_from_hex(argv[i], &msg);
1502 ds_put_format(&reply, "%s\n", error_msg);
1507 fprintf(stderr, "send: ");
1508 ofp_print(stderr, msg->data, msg->size, verbosity);
1510 error = vconn_send_block(vconn, msg);
1513 ds_put_format(&reply, "%s\n", ovs_strerror(error));
1516 ds_put_cstr(&reply, "sent\n");
1521 unixctl_command_reply(conn, ds_cstr(&reply));
1523 unixctl_command_reply_error(conn, ds_cstr(&reply));
1528 struct barrier_aux {
1529 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1530 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1534 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1535 const char *argv[] OVS_UNUSED, void *aux_)
1537 struct barrier_aux *aux = aux_;
1542 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1546 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1547 error = vconn_send_block(aux->vconn, msg);
1550 unixctl_command_reply_error(conn, ovs_strerror(error));
1557 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1558 const char *argv[], void *aux OVS_UNUSED)
1562 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1564 unixctl_command_reply_error(conn, ovs_strerror(errno));
1569 dup2(fd, STDERR_FILENO);
1571 unixctl_command_reply(conn, NULL);
1575 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1576 const char *argv[] OVS_UNUSED, void *blocked_)
1578 bool *blocked = blocked_;
1582 unixctl_command_reply(conn, NULL);
1584 unixctl_command_reply(conn, "already blocking");
1589 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1590 const char *argv[] OVS_UNUSED, void *blocked_)
1592 bool *blocked = blocked_;
1596 unixctl_command_reply(conn, NULL);
1598 unixctl_command_reply(conn, "already unblocked");
1602 /* Prints to stdout all of the messages received on 'vconn'.
1604 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1605 * received on 'vconn'. */
1607 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1609 struct barrier_aux barrier_aux = { vconn, NULL };
1610 struct unixctl_server *server;
1611 bool exiting = false;
1612 bool blocked = false;
1615 daemon_save_fd(STDERR_FILENO);
1616 daemonize_start(false);
1617 error = unixctl_server_create(unixctl_path, &server);
1619 ovs_fatal(error, "failed to create unixctl server");
1621 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1622 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1624 unixctl_command_register("ofctl/barrier", "", 0, 0,
1625 ofctl_barrier, &barrier_aux);
1626 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1627 ofctl_set_output_file, NULL);
1629 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1630 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1633 daemonize_complete();
1639 unixctl_server_run(server);
1644 retval = vconn_recv(vconn, &b);
1645 if (retval == EAGAIN) {
1648 run(retval, "vconn_recv");
1651 char *s = xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1652 time_wall_msec(), true);
1657 ofptype_decode(&type, b->data);
1658 ofp_print(stderr, b->data, b->size, verbosity + 2);
1661 switch ((int) type) {
1662 case OFPTYPE_BARRIER_REPLY:
1663 if (barrier_aux.conn) {
1664 unixctl_command_reply(barrier_aux.conn, NULL);
1665 barrier_aux.conn = NULL;
1669 case OFPTYPE_ECHO_REQUEST:
1670 if (reply_to_echo_requests) {
1671 struct ofpbuf *reply;
1673 reply = make_echo_reply(b->data);
1674 retval = vconn_send_block(vconn, reply);
1676 ovs_fatal(retval, "failed to send echo reply");
1689 vconn_run_wait(vconn);
1691 vconn_recv_wait(vconn);
1693 unixctl_server_wait(server);
1697 unixctl_server_destroy(server);
1701 ofctl_monitor(struct ovs_cmdl_context *ctx)
1703 struct vconn *vconn;
1705 enum ofputil_protocol usable_protocols;
1707 open_vconn(ctx->argv[1], &vconn);
1708 for (i = 2; i < ctx->argc; i++) {
1709 const char *arg = ctx->argv[i];
1711 if (isdigit((unsigned char) *arg)) {
1712 struct ofp_switch_config config;
1714 fetch_switch_config(vconn, &config);
1715 config.miss_send_len = htons(atoi(arg));
1716 set_switch_config(vconn, &config);
1717 } else if (!strcmp(arg, "invalid_ttl")) {
1718 monitor_set_invalid_ttl_to_controller(vconn);
1719 } else if (!strncmp(arg, "watch:", 6)) {
1720 struct ofputil_flow_monitor_request fmr;
1724 error = parse_flow_monitor_request(&fmr, arg + 6,
1727 ovs_fatal(0, "%s", error);
1730 msg = ofpbuf_new(0);
1731 ofputil_append_flow_monitor_request(&fmr, msg);
1732 dump_stats_transaction(vconn, msg);
1735 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1739 if (preferred_packet_in_format >= 0) {
1740 set_packet_in_format(vconn, preferred_packet_in_format);
1742 enum ofp_version version = vconn_get_version(vconn);
1745 case OFP10_VERSION: {
1746 struct ofpbuf *spif, *reply;
1748 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1750 run(vconn_transact_noreply(vconn, spif, &reply),
1751 "talking to %s", vconn_get_name(vconn));
1753 char *s = ofp_to_string(reply->data, reply->size, 2);
1754 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1755 " replied: %s. Falling back to the switch default.",
1756 vconn_get_name(vconn), s);
1758 ofpbuf_delete(reply);
1773 monitor_vconn(vconn, true);
1777 ofctl_snoop(struct ovs_cmdl_context *ctx)
1779 struct vconn *vconn;
1781 open_vconn__(ctx->argv[1], SNOOP, &vconn);
1782 monitor_vconn(vconn, false);
1786 ofctl_dump_ports(struct ovs_cmdl_context *ctx)
1788 struct ofpbuf *request;
1789 struct vconn *vconn;
1792 open_vconn(ctx->argv[1], &vconn);
1793 port = ctx->argc > 2 ? str_to_port_no(ctx->argv[1], ctx->argv[2]) : OFPP_ANY;
1794 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1795 dump_stats_transaction(vconn, request);
1800 ofctl_dump_ports_desc(struct ovs_cmdl_context *ctx)
1802 struct ofpbuf *request;
1803 struct vconn *vconn;
1806 open_vconn(ctx->argv[1], &vconn);
1807 port = ctx->argc > 2 ? str_to_port_no(ctx->argv[1], ctx->argv[2]) : OFPP_ANY;
1808 request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
1810 dump_stats_transaction(vconn, request);
1815 ofctl_probe(struct ovs_cmdl_context *ctx)
1817 struct ofpbuf *request;
1818 struct vconn *vconn;
1819 struct ofpbuf *reply;
1821 open_vconn(ctx->argv[1], &vconn);
1822 request = make_echo_request(vconn_get_version(vconn));
1823 run(vconn_transact(vconn, request, &reply), "talking to %s", ctx->argv[1]);
1824 if (reply->size != sizeof(struct ofp_header)) {
1825 ovs_fatal(0, "reply does not match request");
1827 ofpbuf_delete(reply);
1832 ofctl_packet_out(struct ovs_cmdl_context *ctx)
1834 enum ofputil_protocol protocol;
1835 struct ofputil_packet_out po;
1836 struct ofpbuf ofpacts;
1837 struct vconn *vconn;
1840 enum ofputil_protocol usable_protocols; /* XXX: Use in proto selection */
1842 ofpbuf_init(&ofpacts, 64);
1843 error = ofpacts_parse_actions(ctx->argv[3], &ofpacts, &usable_protocols);
1845 ovs_fatal(0, "%s", error);
1848 po.buffer_id = UINT32_MAX;
1849 po.in_port = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1850 po.ofpacts = ofpacts.data;
1851 po.ofpacts_len = ofpacts.size;
1853 protocol = open_vconn(ctx->argv[1], &vconn);
1854 for (i = 4; i < ctx->argc; i++) {
1855 struct dp_packet *packet;
1857 const char *error_msg;
1859 error_msg = eth_from_hex(ctx->argv[i], &packet);
1861 ovs_fatal(0, "%s", error_msg);
1864 po.packet = dp_packet_data(packet);
1865 po.packet_len = dp_packet_size(packet);
1866 opo = ofputil_encode_packet_out(&po, protocol);
1867 transact_noreply(vconn, opo);
1868 dp_packet_delete(packet);
1871 ofpbuf_uninit(&ofpacts);
1875 ofctl_mod_port(struct ovs_cmdl_context *ctx)
1877 struct ofp_config_flag {
1878 const char *name; /* The flag's name. */
1879 enum ofputil_port_config bit; /* Bit to turn on or off. */
1880 bool on; /* Value to set the bit to. */
1882 static const struct ofp_config_flag flags[] = {
1883 { "up", OFPUTIL_PC_PORT_DOWN, false },
1884 { "down", OFPUTIL_PC_PORT_DOWN, true },
1885 { "stp", OFPUTIL_PC_NO_STP, false },
1886 { "receive", OFPUTIL_PC_NO_RECV, false },
1887 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1888 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1889 { "forward", OFPUTIL_PC_NO_FWD, false },
1890 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1893 const struct ofp_config_flag *flag;
1894 enum ofputil_protocol protocol;
1895 struct ofputil_port_mod pm;
1896 struct ofputil_phy_port pp;
1897 struct vconn *vconn;
1898 const char *command;
1901 fetch_ofputil_phy_port(ctx->argv[1], ctx->argv[2], &pp);
1903 pm.port_no = pp.port_no;
1904 pm.hw_addr = pp.hw_addr;
1909 if (!strncasecmp(ctx->argv[3], "no-", 3)) {
1910 command = ctx->argv[3] + 3;
1912 } else if (!strncasecmp(ctx->argv[3], "no", 2)) {
1913 command = ctx->argv[3] + 2;
1916 command = ctx->argv[3];
1919 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1920 if (!strcasecmp(command, flag->name)) {
1921 pm.mask = flag->bit;
1922 pm.config = flag->on ^ not ? flag->bit : 0;
1926 ovs_fatal(0, "unknown mod-port command '%s'", ctx->argv[3]);
1929 protocol = open_vconn(ctx->argv[1], &vconn);
1930 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1935 ofctl_mod_table(struct ovs_cmdl_context *ctx)
1937 uint32_t usable_versions;
1938 struct ofputil_table_mod tm;
1939 struct vconn *vconn;
1942 error = parse_ofp_table_mod(&tm, ctx->argv[2], ctx->argv[3],
1945 ovs_fatal(0, "%s", error);
1948 uint32_t allowed_versions = get_allowed_ofp_versions();
1949 if (!(allowed_versions & usable_versions)) {
1950 struct ds versions = DS_EMPTY_INITIALIZER;
1951 ofputil_format_version_bitmap_names(&versions, allowed_versions);
1952 ovs_fatal(0, "table_mod '%s' requires one of the OpenFlow "
1953 "versions %s but none is enabled (use -O)",
1954 ctx->argv[3], ds_cstr(&versions));
1956 mask_allowed_ofp_versions(usable_versions);
1958 enum ofputil_protocol protocol = open_vconn(ctx->argv[1], &vconn);
1959 transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
1964 ofctl_get_frags(struct ovs_cmdl_context *ctx)
1966 struct ofp_switch_config config;
1967 struct vconn *vconn;
1969 open_vconn(ctx->argv[1], &vconn);
1970 fetch_switch_config(vconn, &config);
1971 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1976 ofctl_set_frags(struct ovs_cmdl_context *ctx)
1978 struct ofp_switch_config config;
1979 enum ofp_config_flags mode;
1980 struct vconn *vconn;
1983 if (!ofputil_frag_handling_from_string(ctx->argv[2], &mode)) {
1984 ovs_fatal(0, "%s: unknown fragment handling mode", ctx->argv[2]);
1987 open_vconn(ctx->argv[1], &vconn);
1988 fetch_switch_config(vconn, &config);
1989 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1990 if (flags != config.flags) {
1991 /* Set the configuration. */
1992 config.flags = flags;
1993 set_switch_config(vconn, &config);
1995 /* Then retrieve the configuration to see if it really took. OpenFlow
1996 * doesn't define error reporting for bad modes, so this is all we can
1998 fetch_switch_config(vconn, &config);
1999 if (flags != config.flags) {
2000 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
2001 "switch probably doesn't support mode \"%s\")",
2002 ctx->argv[1], ofputil_frag_handling_to_string(mode));
2009 ofctl_ofp_parse(struct ovs_cmdl_context *ctx)
2011 const char *filename = ctx->argv[1];
2015 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2017 ovs_fatal(errno, "%s: open", filename);
2020 ofpbuf_init(&b, 65536);
2022 struct ofp_header *oh;
2023 size_t length, tail_len;
2028 oh = ofpbuf_put_uninit(&b, sizeof *oh);
2029 n = fread(oh, 1, sizeof *oh, file);
2032 } else if (n < sizeof *oh) {
2033 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2036 length = ntohs(oh->length);
2037 if (length < sizeof *oh) {
2038 ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
2042 tail_len = length - sizeof *oh;
2043 tail = ofpbuf_put_uninit(&b, tail_len);
2044 n = fread(tail, 1, tail_len, file);
2046 ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2049 ofp_print(stdout, b.data, b.size, verbosity + 2);
2053 if (file != stdin) {
2059 is_openflow_port(ovs_be16 port_, char *ports[])
2061 uint16_t port = ntohs(port_);
2065 for (i = 0; ports[i]; i++) {
2066 if (port == atoi(ports[i])) {
2072 return port == OFP_PORT || port == OFP_OLD_PORT;
2077 ofctl_ofp_parse_pcap(struct ovs_cmdl_context *ctx)
2079 struct tcp_reader *reader;
2084 file = ovs_pcap_open(ctx->argv[1], "rb");
2086 ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
2089 reader = tcp_reader_open();
2092 struct dp_packet *packet;
2096 error = ovs_pcap_read(file, &packet, &when);
2100 pkt_metadata_init(&packet->md, ODPP_NONE);
2101 flow_extract(packet, &flow);
2102 if (flow.dl_type == htons(ETH_TYPE_IP)
2103 && flow.nw_proto == IPPROTO_TCP
2104 && (is_openflow_port(flow.tp_src, ctx->argv + 2) ||
2105 is_openflow_port(flow.tp_dst, ctx->argv + 2))) {
2106 struct dp_packet *payload = tcp_reader_run(reader, &flow, packet);
2108 while (dp_packet_size(payload) >= sizeof(struct ofp_header)) {
2109 const struct ofp_header *oh;
2110 void *data = dp_packet_data(payload);
2113 /* Align OpenFlow on 8-byte boundary for safe access. */
2114 dp_packet_shift(payload, -((intptr_t) data & 7));
2116 oh = dp_packet_data(payload);
2117 length = ntohs(oh->length);
2118 if (dp_packet_size(payload) < length) {
2128 char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
2133 printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
2134 IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
2135 IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
2136 ofp_print(stdout, dp_packet_data(payload), length, verbosity + 1);
2137 dp_packet_pull(payload, length);
2141 dp_packet_delete(packet);
2143 tcp_reader_close(reader);
2147 ofctl_ping(struct ovs_cmdl_context *ctx)
2149 size_t max_payload = 65535 - sizeof(struct ofp_header);
2150 unsigned int payload;
2151 struct vconn *vconn;
2154 payload = ctx->argc > 2 ? atoi(ctx->argv[2]) : 64;
2155 if (payload > max_payload) {
2156 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2159 open_vconn(ctx->argv[1], &vconn);
2160 for (i = 0; i < 10; i++) {
2161 struct timeval start, end;
2162 struct ofpbuf *request, *reply;
2163 const struct ofp_header *rpy_hdr;
2166 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2167 vconn_get_version(vconn), payload);
2168 random_bytes(ofpbuf_put_uninit(request, payload), payload);
2170 xgettimeofday(&start);
2171 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2172 xgettimeofday(&end);
2174 rpy_hdr = reply->data;
2175 if (ofptype_pull(&type, reply)
2176 || type != OFPTYPE_ECHO_REPLY
2177 || reply->size != payload
2178 || memcmp(request->msg, reply->msg, payload)) {
2179 printf("Reply does not match request. Request:\n");
2180 ofp_print(stdout, request, request->size, verbosity + 2);
2182 ofp_print(stdout, reply, reply->size, verbosity + 2);
2184 printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2185 reply->size, ctx->argv[1], ntohl(rpy_hdr->xid),
2186 (1000*(double)(end.tv_sec - start.tv_sec))
2187 + (.001*(end.tv_usec - start.tv_usec)));
2188 ofpbuf_delete(request);
2189 ofpbuf_delete(reply);
2195 ofctl_benchmark(struct ovs_cmdl_context *ctx)
2197 size_t max_payload = 65535 - sizeof(struct ofp_header);
2198 struct timeval start, end;
2199 unsigned int payload_size, message_size;
2200 struct vconn *vconn;
2205 payload_size = atoi(ctx->argv[2]);
2206 if (payload_size > max_payload) {
2207 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2209 message_size = sizeof(struct ofp_header) + payload_size;
2211 count = atoi(ctx->argv[3]);
2213 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2214 count, message_size, count * message_size);
2216 open_vconn(ctx->argv[1], &vconn);
2217 xgettimeofday(&start);
2218 for (i = 0; i < count; i++) {
2219 struct ofpbuf *request, *reply;
2221 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2222 vconn_get_version(vconn), payload_size);
2223 ofpbuf_put_zeros(request, payload_size);
2224 run(vconn_transact(vconn, request, &reply), "transact");
2225 ofpbuf_delete(reply);
2227 xgettimeofday(&end);
2230 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2231 + (.001*(end.tv_usec - start.tv_usec)));
2232 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2233 duration, count / (duration / 1000.0),
2234 count * message_size / (duration / 1000.0));
2238 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2239 size_t n_gms, enum ofputil_protocol usable_protocols)
2241 enum ofputil_protocol protocol;
2242 struct ofputil_group_mod *gm;
2243 enum ofp_version version;
2244 struct ofpbuf *request;
2246 struct vconn *vconn;
2249 protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
2250 version = ofputil_protocol_to_ofp_version(protocol);
2252 for (i = 0; i < n_gms; i++) {
2254 request = ofputil_encode_group_mod(version, gm);
2256 transact_noreply(vconn, request);
2266 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2268 struct ofputil_group_mod *gms = NULL;
2269 enum ofputil_protocol usable_protocols;
2274 error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2277 ovs_fatal(0, "%s", error);
2279 ofctl_group_mod__(argv[1], gms, n_gms, usable_protocols);
2280 for (i = 0; i < n_gms; i++) {
2281 ofputil_bucket_list_destroy(&gms[i].buckets);
2287 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2289 if (argc > 2 && !strcmp(argv[2], "-")) {
2290 ofctl_group_mod_file(argc, argv, command);
2292 enum ofputil_protocol usable_protocols;
2293 struct ofputil_group_mod gm;
2296 error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2299 ovs_fatal(0, "%s", error);
2301 ofctl_group_mod__(argv[1], &gm, 1, usable_protocols);
2302 ofputil_bucket_list_destroy(&gm.buckets);
2307 ofctl_add_group(struct ovs_cmdl_context *ctx)
2309 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_ADD);
2313 ofctl_add_groups(struct ovs_cmdl_context *ctx)
2315 ofctl_group_mod_file(ctx->argc, ctx->argv, OFPGC11_ADD);
2319 ofctl_mod_group(struct ovs_cmdl_context *ctx)
2321 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_MODIFY);
2325 ofctl_del_groups(struct ovs_cmdl_context *ctx)
2327 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_DELETE);
2331 ofctl_insert_bucket(struct ovs_cmdl_context *ctx)
2333 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_INSERT_BUCKET);
2337 ofctl_remove_bucket(struct ovs_cmdl_context *ctx)
2339 ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_REMOVE_BUCKET);
2343 ofctl_dump_group_stats(struct ovs_cmdl_context *ctx)
2345 enum ofputil_protocol usable_protocols;
2346 struct ofputil_group_mod gm;
2347 struct ofpbuf *request;
2348 struct vconn *vconn;
2352 memset(&gm, 0, sizeof gm);
2354 error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2355 ctx->argc > 2 ? ctx->argv[2] : "",
2358 ovs_fatal(0, "%s", error);
2361 group_id = gm.group_id;
2363 open_vconn(ctx->argv[1], &vconn);
2364 request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2367 dump_stats_transaction(vconn, request);
2374 ofctl_dump_group_desc(struct ovs_cmdl_context *ctx)
2376 struct ofpbuf *request;
2377 struct vconn *vconn;
2380 open_vconn(ctx->argv[1], &vconn);
2382 if (ctx->argc < 3 || !ofputil_group_from_string(ctx->argv[2], &group_id)) {
2383 group_id = OFPG11_ALL;
2386 request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2389 dump_stats_transaction(vconn, request);
2396 ofctl_dump_group_features(struct ovs_cmdl_context *ctx)
2398 struct ofpbuf *request;
2399 struct vconn *vconn;
2401 open_vconn(ctx->argv[1], &vconn);
2402 request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2404 dump_stats_transaction(vconn, request);
2411 ofctl_geneve_mod(struct ovs_cmdl_context *ctx, uint16_t command)
2413 enum ofputil_protocol usable_protocols;
2414 enum ofputil_protocol protocol;
2415 struct ofputil_geneve_table_mod gtm;
2417 enum ofp_version version;
2418 struct ofpbuf *request;
2419 struct vconn *vconn;
2421 error = parse_ofp_geneve_table_mod_str(>m, command, ctx->argc > 2 ?
2425 ovs_fatal(0, "%s", error);
2428 protocol = open_vconn_for_flow_mod(ctx->argv[1], &vconn, usable_protocols);
2429 version = ofputil_protocol_to_ofp_version(protocol);
2431 request = ofputil_encode_geneve_table_mod(version, >m);
2433 transact_noreply(vconn, request);
2437 ofputil_uninit_geneve_table(>m.mappings);
2441 ofctl_add_geneve_map(struct ovs_cmdl_context *ctx)
2443 ofctl_geneve_mod(ctx, NXGTMC_ADD);
2447 ofctl_del_geneve_map(struct ovs_cmdl_context *ctx)
2449 ofctl_geneve_mod(ctx, ctx->argc > 2 ? NXGTMC_DELETE : NXGTMC_CLEAR);
2453 ofctl_dump_geneve_map(struct ovs_cmdl_context *ctx)
2455 dump_trivial_transaction(ctx->argv[1], OFPRAW_NXT_GENEVE_TABLE_REQUEST);
2459 ofctl_help(struct ovs_cmdl_context *ctx OVS_UNUSED)
2465 ofctl_list_commands(struct ovs_cmdl_context *ctx OVS_UNUSED)
2467 ovs_cmdl_print_commands(get_all_commands());
2470 /* replace-flows and diff-flows commands. */
2472 /* A flow table entry, possibly with two different versions. */
2474 struct cls_rule rule; /* Within a "struct classifier". */
2475 struct fte_version *versions[2];
2478 /* One version of a Flow Table Entry. */
2479 struct fte_version {
2481 uint16_t idle_timeout;
2482 uint16_t hard_timeout;
2483 uint16_t importance;
2485 struct ofpact *ofpacts;
2489 /* Frees 'version' and the data that it owns. */
2491 fte_version_free(struct fte_version *version)
2494 free(CONST_CAST(struct ofpact *, version->ofpacts));
2499 /* Returns true if 'a' and 'b' are the same, false if they differ.
2501 * Ignores differences in 'flags' because there's no way to retrieve flags from
2502 * an OpenFlow switch. We have to assume that they are the same. */
2504 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2506 return (a->cookie == b->cookie
2507 && a->idle_timeout == b->idle_timeout
2508 && a->hard_timeout == b->hard_timeout
2509 && a->importance == b->importance
2510 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2511 b->ofpacts, b->ofpacts_len));
2514 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2515 * 'index' into 's', followed by a new-line. */
2517 fte_version_format(const struct fte *fte, int index, struct ds *s)
2519 const struct fte_version *version = fte->versions[index];
2526 cls_rule_format(&fte->rule, s);
2527 if (version->cookie != htonll(0)) {
2528 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2530 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2531 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2533 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2534 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2536 if (version->importance != 0) {
2537 ds_put_format(s, " importance=%"PRIu16, version->importance);
2540 ds_put_cstr(s, " actions=");
2541 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2543 ds_put_char(s, '\n');
2547 fte_from_cls_rule(const struct cls_rule *cls_rule)
2549 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2552 /* Frees 'fte' and its versions. */
2554 fte_free(struct fte *fte)
2557 fte_version_free(fte->versions[0]);
2558 fte_version_free(fte->versions[1]);
2559 cls_rule_destroy(&fte->rule);
2564 /* Frees all of the FTEs within 'cls'. */
2566 fte_free_all(struct classifier *cls)
2570 classifier_defer(cls);
2571 CLS_FOR_EACH (fte, rule, cls) {
2572 classifier_remove(cls, &fte->rule);
2573 ovsrcu_postpone(fte_free, fte);
2575 classifier_destroy(cls);
2578 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
2579 * necessary. Sets 'version' as the version of that rule with the given
2580 * 'index', replacing any existing version, if any.
2582 * Takes ownership of 'version'. */
2584 fte_insert(struct classifier *cls, const struct match *match,
2585 int priority, struct fte_version *version, int index)
2587 struct fte *old, *fte;
2589 fte = xzalloc(sizeof *fte);
2590 cls_rule_init(&fte->rule, match, priority);
2591 fte->versions[index] = version;
2593 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule,
2594 CLS_MIN_VERSION, NULL, 0));
2596 fte->versions[!index] = old->versions[!index];
2597 old->versions[!index] = NULL;
2599 ovsrcu_postpone(fte_free, old);
2603 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
2604 * with the specified 'index'. Returns the flow formats able to represent the
2605 * flows that were read. */
2606 static enum ofputil_protocol
2607 read_flows_from_file(const char *filename, struct classifier *cls, int index)
2609 enum ofputil_protocol usable_protocols;
2614 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2616 ovs_fatal(errno, "%s: open", filename);
2620 usable_protocols = OFPUTIL_P_ANY;
2622 classifier_defer(cls);
2623 while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2624 struct fte_version *version;
2625 struct ofputil_flow_mod fm;
2627 enum ofputil_protocol usable;
2629 error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2631 ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2633 usable_protocols &= usable;
2635 version = xmalloc(sizeof *version);
2636 version->cookie = fm.new_cookie;
2637 version->idle_timeout = fm.idle_timeout;
2638 version->hard_timeout = fm.hard_timeout;
2639 version->importance = fm.importance;
2640 version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2641 | OFPUTIL_FF_EMERG);
2642 version->ofpacts = fm.ofpacts;
2643 version->ofpacts_len = fm.ofpacts_len;
2645 fte_insert(cls, &fm.match, fm.priority, version, index);
2647 classifier_publish(cls);
2650 if (file != stdin) {
2654 return usable_protocols;
2658 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2659 struct ofpbuf **replyp,
2660 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2662 struct ofpbuf *reply = *replyp;
2668 /* Get a flow stats reply message, if we don't already have one. */
2674 run(vconn_recv_block(vconn, &reply),
2675 "OpenFlow packet receive failed");
2676 } while (((struct ofp_header *) reply->data)->xid != send_xid);
2678 error = ofptype_decode(&type, reply->data);
2679 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2680 ovs_fatal(0, "received bad reply: %s",
2681 ofp_to_string(reply->data, reply->size,
2686 /* Pull an individual flow stats reply out of the message. */
2687 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2694 more = ofpmp_more(reply->header);
2695 ofpbuf_delete(reply);
2704 ovs_fatal(0, "parse error in reply (%s)",
2705 ofperr_to_string(retval));
2710 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2711 * format 'protocol', and adds them as flow table entries in 'cls' for the
2712 * version with the specified 'index'. */
2714 read_flows_from_switch(struct vconn *vconn,
2715 enum ofputil_protocol protocol,
2716 struct classifier *cls, int index)
2718 struct ofputil_flow_stats_request fsr;
2719 struct ofputil_flow_stats fs;
2720 struct ofpbuf *request;
2721 struct ofpbuf ofpacts;
2722 struct ofpbuf *reply;
2725 fsr.aggregate = false;
2726 match_init_catchall(&fsr.match);
2727 fsr.out_port = OFPP_ANY;
2728 fsr.table_id = 0xff;
2729 fsr.cookie = fsr.cookie_mask = htonll(0);
2730 request = ofputil_encode_flow_stats_request(&fsr, protocol);
2731 send_xid = ((struct ofp_header *) request->data)->xid;
2732 send_openflow_buffer(vconn, request);
2735 ofpbuf_init(&ofpacts, 0);
2736 classifier_defer(cls);
2737 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2738 struct fte_version *version;
2740 version = xmalloc(sizeof *version);
2741 version->cookie = fs.cookie;
2742 version->idle_timeout = fs.idle_timeout;
2743 version->hard_timeout = fs.hard_timeout;
2744 version->importance = fs.importance;
2746 version->ofpacts_len = fs.ofpacts_len;
2747 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2749 fte_insert(cls, &fs.match, fs.priority, version, index);
2751 classifier_publish(cls);
2752 ofpbuf_uninit(&ofpacts);
2756 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2757 enum ofputil_protocol protocol, struct ovs_list *packets)
2759 const struct fte_version *version = fte->versions[index];
2760 struct ofputil_flow_mod fm;
2763 minimatch_expand(&fte->rule.match, &fm.match);
2764 fm.priority = fte->rule.priority;
2765 fm.cookie = htonll(0);
2766 fm.cookie_mask = htonll(0);
2767 fm.new_cookie = version->cookie;
2768 fm.modify_cookie = true;
2770 fm.command = command;
2771 fm.idle_timeout = version->idle_timeout;
2772 fm.hard_timeout = version->hard_timeout;
2773 fm.importance = version->importance;
2774 fm.buffer_id = UINT32_MAX;
2775 fm.out_port = OFPP_ANY;
2776 fm.flags = version->flags;
2777 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2778 command == OFPFC_MODIFY_STRICT) {
2779 fm.ofpacts = version->ofpacts;
2780 fm.ofpacts_len = version->ofpacts_len;
2785 fm.delete_reason = OFPRR_DELETE;
2787 ofm = ofputil_encode_flow_mod(&fm, protocol);
2788 list_push_back(packets, &ofm->list_node);
2792 ofctl_replace_flows(struct ovs_cmdl_context *ctx)
2794 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2795 enum ofputil_protocol usable_protocols, protocol;
2796 struct classifier cls;
2797 struct ovs_list requests;
2798 struct vconn *vconn;
2801 classifier_init(&cls, NULL);
2802 usable_protocols = read_flows_from_file(ctx->argv[2], &cls, FILE_IDX);
2804 protocol = open_vconn(ctx->argv[1], &vconn);
2805 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2807 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2809 list_init(&requests);
2811 /* Delete flows that exist on the switch but not in the file. */
2812 CLS_FOR_EACH (fte, rule, &cls) {
2813 struct fte_version *file_ver = fte->versions[FILE_IDX];
2814 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2816 if (sw_ver && !file_ver) {
2817 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2818 protocol, &requests);
2822 /* Add flows that exist in the file but not on the switch.
2823 * Update flows that exist in both places but differ. */
2824 CLS_FOR_EACH (fte, rule, &cls) {
2825 struct fte_version *file_ver = fte->versions[FILE_IDX];
2826 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2829 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2830 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2834 bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
2836 transact_multiple_noreply(vconn, &requests);
2844 read_flows_from_source(const char *source, struct classifier *cls, int index)
2848 if (source[0] == '/' || source[0] == '.'
2849 || (!strchr(source, ':') && !stat(source, &s))) {
2850 read_flows_from_file(source, cls, index);
2852 enum ofputil_protocol protocol;
2853 struct vconn *vconn;
2855 protocol = open_vconn(source, &vconn);
2856 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2857 read_flows_from_switch(vconn, protocol, cls, index);
2863 ofctl_diff_flows(struct ovs_cmdl_context *ctx)
2865 bool differences = false;
2866 struct classifier cls;
2870 classifier_init(&cls, NULL);
2871 read_flows_from_source(ctx->argv[1], &cls, 0);
2872 read_flows_from_source(ctx->argv[2], &cls, 1);
2877 CLS_FOR_EACH (fte, rule, &cls) {
2878 struct fte_version *a = fte->versions[0];
2879 struct fte_version *b = fte->versions[1];
2881 if (!a || !b || !fte_version_equals(a, b)) {
2882 fte_version_format(fte, 0, &a_s);
2883 fte_version_format(fte, 1, &b_s);
2884 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2886 printf("-%s", ds_cstr(&a_s));
2889 printf("+%s", ds_cstr(&b_s));
2907 ofctl_meter_mod__(const char *bridge, const char *str, int command)
2909 struct ofputil_meter_mod mm;
2910 struct vconn *vconn;
2911 enum ofputil_protocol protocol;
2912 enum ofputil_protocol usable_protocols;
2913 enum ofp_version version;
2917 error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
2919 ovs_fatal(0, "%s", error);
2922 usable_protocols = OFPUTIL_P_OF13_UP;
2923 mm.command = command;
2924 mm.meter.meter_id = OFPM13_ALL;
2927 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2928 version = ofputil_protocol_to_ofp_version(protocol);
2929 transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
2934 ofctl_meter_request__(const char *bridge, const char *str,
2935 enum ofputil_meter_request_type type)
2937 struct ofputil_meter_mod mm;
2938 struct vconn *vconn;
2939 enum ofputil_protocol usable_protocols;
2940 enum ofputil_protocol protocol;
2941 enum ofp_version version;
2945 error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
2947 ovs_fatal(0, "%s", error);
2950 usable_protocols = OFPUTIL_P_OF13_UP;
2951 mm.meter.meter_id = OFPM13_ALL;
2954 protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2955 version = ofputil_protocol_to_ofp_version(protocol);
2956 transact_noreply(vconn, ofputil_encode_meter_request(version,
2958 mm.meter.meter_id));
2964 ofctl_add_meter(struct ovs_cmdl_context *ctx)
2966 ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_ADD);
2970 ofctl_mod_meter(struct ovs_cmdl_context *ctx)
2972 ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_MODIFY);
2976 ofctl_del_meters(struct ovs_cmdl_context *ctx)
2978 ofctl_meter_mod__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL, OFPMC13_DELETE);
2982 ofctl_dump_meters(struct ovs_cmdl_context *ctx)
2984 ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
2985 OFPUTIL_METER_CONFIG);
2989 ofctl_meter_stats(struct ovs_cmdl_context *ctx)
2991 ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
2992 OFPUTIL_METER_STATS);
2996 ofctl_meter_features(struct ovs_cmdl_context *ctx)
2998 ofctl_meter_request__(ctx->argv[1], NULL, OFPUTIL_METER_FEATURES);
3002 /* Undocumented commands for unit testing. */
3005 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
3006 enum ofputil_protocol usable_protocols)
3008 enum ofputil_protocol protocol = 0;
3012 usable_s = ofputil_protocols_to_string(usable_protocols);
3013 printf("usable protocols: %s\n", usable_s);
3016 if (!(usable_protocols & allowed_protocols)) {
3017 ovs_fatal(0, "no usable protocol");
3019 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
3021 if (protocol & usable_protocols & allowed_protocols) {
3025 ovs_assert(is_pow2(protocol));
3027 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
3029 for (i = 0; i < n_fms; i++) {
3030 struct ofputil_flow_mod *fm = &fms[i];
3033 msg = ofputil_encode_flow_mod(fm, protocol);
3034 ofp_print(stdout, msg->data, msg->size, verbosity);
3037 free(CONST_CAST(struct ofpact *, fm->ofpacts));
3041 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
3042 * it back to stdout. */
3044 ofctl_parse_flow(struct ovs_cmdl_context *ctx)
3046 enum ofputil_protocol usable_protocols;
3047 struct ofputil_flow_mod fm;
3050 error = parse_ofp_flow_mod_str(&fm, ctx->argv[1], OFPFC_ADD, &usable_protocols);
3052 ovs_fatal(0, "%s", error);
3054 ofctl_parse_flows__(&fm, 1, usable_protocols);
3057 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
3058 * add-flows) and prints each of the flows back to stdout. */
3060 ofctl_parse_flows(struct ovs_cmdl_context *ctx)
3062 enum ofputil_protocol usable_protocols;
3063 struct ofputil_flow_mod *fms = NULL;
3067 error = parse_ofp_flow_mod_file(ctx->argv[1], OFPFC_ADD, &fms, &n_fms,
3070 ovs_fatal(0, "%s", error);
3072 ofctl_parse_flows__(fms, n_fms, usable_protocols);
3077 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
3082 while (!ds_get_test_line(&in, stdin)) {
3083 struct ofpbuf nx_match;
3085 ovs_be64 cookie, cookie_mask;
3089 /* Convert string to nx_match. */
3090 ofpbuf_init(&nx_match, 0);
3092 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
3094 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
3097 /* Convert nx_match to match. */
3100 error = oxm_pull_match(&nx_match, &match);
3102 error = nx_pull_match(&nx_match, match_len, &match,
3103 &cookie, &cookie_mask);
3107 error = oxm_pull_match_loose(&nx_match, &match);
3109 error = nx_pull_match_loose(&nx_match, match_len, &match,
3110 &cookie, &cookie_mask);
3118 /* Convert match back to nx_match. */
3119 ofpbuf_uninit(&nx_match);
3120 ofpbuf_init(&nx_match, 0);
3122 match_len = oxm_put_match(&nx_match, &match, version);
3123 out = oxm_match_to_string(&nx_match, match_len);
3125 match_len = nx_put_match(&nx_match, &match,
3126 cookie, cookie_mask);
3127 out = nx_match_to_string(nx_match.data, match_len);
3133 if (verbosity > 0) {
3134 ovs_hex_dump(stdout, nx_match.data, nx_match.size, 0, false);
3137 printf("nx_pull_match() returned error %s\n",
3138 ofperr_get_name(error));
3141 ofpbuf_uninit(&nx_match);
3146 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
3147 * stdin, does some internal fussing with them, and then prints them back as
3148 * strings on stdout. */
3150 ofctl_parse_nxm(struct ovs_cmdl_context *ctx OVS_UNUSED)
3152 ofctl_parse_nxm__(false, 0);
3155 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
3156 * strings from stdin, does some internal fussing with them, and then prints
3157 * them back as strings on stdout. VERSION must specify an OpenFlow version,
3158 * e.g. "OpenFlow12". */
3160 ofctl_parse_oxm(struct ovs_cmdl_context *ctx)
3162 enum ofp_version version = ofputil_version_from_string(ctx->argv[1]);
3163 if (version < OFP12_VERSION) {
3164 ovs_fatal(0, "%s: not a valid version for OXM", ctx->argv[1]);
3167 ofctl_parse_nxm__(true, version);
3171 print_differences(const char *prefix,
3172 const void *a_, size_t a_len,
3173 const void *b_, size_t b_len)
3175 const uint8_t *a = a_;
3176 const uint8_t *b = b_;
3179 for (i = 0; i < MIN(a_len, b_len); i++) {
3181 printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
3182 prefix, i, a[i], b[i]);
3185 for (i = a_len; i < b_len; i++) {
3186 printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
3188 for (i = b_len; i < a_len; i++) {
3189 printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
3194 ofctl_parse_actions__(const char *version_s, bool instructions)
3196 enum ofp_version version;
3199 version = ofputil_version_from_string(version_s);
3201 ovs_fatal(0, "%s: not a valid OpenFlow version", version_s);
3205 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3206 struct ofpbuf of_out;
3207 struct ofpbuf of_in;
3208 struct ofpbuf ofpacts;
3209 const char *table_id;
3215 /* Parse table_id separated with the follow-up actions by ",", if
3217 actions = ds_cstr(&in);
3219 if (strstr(actions, ",")) {
3220 table_id = strsep(&actions, ",");
3223 /* Parse hex bytes. */
3224 ofpbuf_init(&of_in, 0);
3225 if (ofpbuf_put_hex(&of_in, actions, NULL)[0] != '\0') {
3226 ovs_fatal(0, "Trailing garbage in hex data");
3229 /* Convert to ofpacts. */
3230 ofpbuf_init(&ofpacts, 0);
3232 error = (instructions
3233 ? ofpacts_pull_openflow_instructions
3234 : ofpacts_pull_openflow_actions)(
3235 &of_in, of_in.size, version, &ofpacts);
3236 if (!error && instructions) {
3237 /* Verify actions, enforce consistency. */
3238 enum ofputil_protocol protocol;
3241 memset(&flow, 0, sizeof flow);
3242 protocol = ofputil_protocols_from_ofp_version(version);
3243 error = ofpacts_check_consistency(ofpacts.data, ofpacts.size,
3245 table_id ? atoi(table_id) : 0,
3249 printf("bad %s %s: %s\n\n",
3250 version_s, instructions ? "instructions" : "actions",
3251 ofperr_get_name(error));
3252 ofpbuf_uninit(&ofpacts);
3253 ofpbuf_uninit(&of_in);
3256 ofpbuf_push_uninit(&of_in, size);
3258 /* Print cls_rule. */
3260 ds_put_cstr(&s, "actions=");
3261 ofpacts_format(ofpacts.data, ofpacts.size, &s);
3265 /* Convert back to ofp10 actions and print differences from input. */
3266 ofpbuf_init(&of_out, 0);
3268 ofpacts_put_openflow_instructions(ofpacts.data, ofpacts.size,
3271 ofpacts_put_openflow_actions(ofpacts.data, ofpacts.size,
3275 print_differences("", of_in.data, of_in.size,
3276 of_out.data, of_out.size);
3279 ofpbuf_uninit(&ofpacts);
3280 ofpbuf_uninit(&of_in);
3281 ofpbuf_uninit(&of_out);
3286 /* "parse-actions VERSION": reads a series of action specifications for the
3287 * given OpenFlow VERSION as hex bytes from stdin, converts them to ofpacts,
3288 * prints them as strings on stdout, and then converts them back to hex bytes
3289 * and prints any differences from the input. */
3291 ofctl_parse_actions(struct ovs_cmdl_context *ctx)
3293 ofctl_parse_actions__(ctx->argv[1], false);
3296 /* "parse-actions VERSION": reads a series of instruction specifications for
3297 * the given OpenFlow VERSION as hex bytes from stdin, converts them to
3298 * ofpacts, prints them as strings on stdout, and then converts them back to
3299 * hex bytes and prints any differences from the input. */
3301 ofctl_parse_instructions(struct ovs_cmdl_context *ctx)
3303 ofctl_parse_actions__(ctx->argv[1], true);
3306 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3307 * bytes from stdin, converts them to cls_rules, prints them as strings on
3308 * stdout, and then converts them back to hex bytes and prints any differences
3311 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3312 * values are ignored in the input and will be set to zero when OVS converts
3313 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
3314 * it does the conversion to hex, to ensure that in fact they are ignored. */
3316 ofctl_parse_ofp10_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3323 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3324 struct ofpbuf match_in, match_expout;
3325 struct ofp10_match match_out;
3326 struct ofp10_match match_normal;
3330 /* Parse hex bytes to use for expected output. */
3332 ds_put_cstr(&expout, ds_cstr(&in));
3333 for (p = ds_cstr(&expout); *p; p++) {
3338 ofpbuf_init(&match_expout, 0);
3339 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3340 ovs_fatal(0, "Trailing garbage in hex data");
3342 if (match_expout.size != sizeof(struct ofp10_match)) {
3343 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3344 match_expout.size, sizeof(struct ofp10_match));
3347 /* Parse hex bytes for input. */
3348 for (p = ds_cstr(&in); *p; p++) {
3350 *p = "0123456789abcdef"[random_uint32() & 0xf];
3353 ofpbuf_init(&match_in, 0);
3354 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3355 ovs_fatal(0, "Trailing garbage in hex data");
3357 if (match_in.size != sizeof(struct ofp10_match)) {
3358 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3359 match_in.size, sizeof(struct ofp10_match));
3362 /* Convert to cls_rule and print. */
3363 ofputil_match_from_ofp10_match(match_in.data, &match);
3364 match_print(&match);
3366 /* Convert back to ofp10_match and print differences from input. */
3367 ofputil_match_to_ofp10_match(&match, &match_out);
3368 print_differences("", match_expout.data, match_expout.size,
3369 &match_out, sizeof match_out);
3371 /* Normalize, then convert and compare again. */
3372 ofputil_normalize_match(&match);
3373 ofputil_match_to_ofp10_match(&match, &match_normal);
3374 print_differences("normal: ", &match_out, sizeof match_out,
3375 &match_normal, sizeof match_normal);
3378 ofpbuf_uninit(&match_in);
3379 ofpbuf_uninit(&match_expout);
3382 ds_destroy(&expout);
3385 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3386 * bytes from stdin, converts them to "struct match"es, prints them as strings
3387 * on stdout, and then converts them back to hex bytes and prints any
3388 * differences from the input. */
3390 ofctl_parse_ofp11_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3395 while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3396 struct ofpbuf match_in;
3397 struct ofp11_match match_out;
3401 /* Parse hex bytes. */
3402 ofpbuf_init(&match_in, 0);
3403 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3404 ovs_fatal(0, "Trailing garbage in hex data");
3406 if (match_in.size != sizeof(struct ofp11_match)) {
3407 ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3408 match_in.size, sizeof(struct ofp11_match));
3411 /* Convert to match. */
3412 error = ofputil_match_from_ofp11_match(match_in.data, &match);
3414 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3415 ofpbuf_uninit(&match_in);
3420 match_print(&match);
3422 /* Convert back to ofp11_match and print differences from input. */
3423 ofputil_match_to_ofp11_match(&match, &match_out);
3425 print_differences("", match_in.data, match_in.size,
3426 &match_out, sizeof match_out);
3429 ofpbuf_uninit(&match_in);
3434 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3436 ofctl_parse_pcap(struct ovs_cmdl_context *ctx)
3440 pcap = ovs_pcap_open(ctx->argv[1], "rb");
3442 ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
3446 struct dp_packet *packet;
3450 error = ovs_pcap_read(pcap, &packet, NULL);
3454 ovs_fatal(error, "%s: read failed", ctx->argv[1]);
3457 pkt_metadata_init(&packet->md, ODPP_NONE);
3458 flow_extract(packet, &flow);
3459 flow_print(stdout, &flow);
3461 dp_packet_delete(packet);
3465 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3466 * mask values to and from various formats and prints the results. */
3468 ofctl_check_vlan(struct ovs_cmdl_context *ctx)
3473 struct ofputil_flow_mod fm;
3476 struct match nxm_match;
3480 struct ofp10_match of10_raw;
3481 struct match of10_match;
3483 struct ofp11_match of11_raw;
3484 struct match of11_match;
3489 enum ofputil_protocol usable_protocols; /* Unused for now. */
3491 match_init_catchall(&match);
3492 match.flow.vlan_tci = htons(strtoul(ctx->argv[1], NULL, 16));
3493 match.wc.masks.vlan_tci = htons(strtoul(ctx->argv[2], NULL, 16));
3495 /* Convert to and from string. */
3496 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3497 printf("%s -> ", string_s);
3499 error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3501 ovs_fatal(0, "%s", error_s);
3503 printf("%04"PRIx16"/%04"PRIx16"\n",
3504 ntohs(fm.match.flow.vlan_tci),
3505 ntohs(fm.match.wc.masks.vlan_tci));
3508 /* Convert to and from NXM. */
3509 ofpbuf_init(&nxm, 0);
3510 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3511 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
3512 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3513 printf("NXM: %s -> ", nxm_s);
3515 printf("%s\n", ofperr_to_string(error));
3517 printf("%04"PRIx16"/%04"PRIx16"\n",
3518 ntohs(nxm_match.flow.vlan_tci),
3519 ntohs(nxm_match.wc.masks.vlan_tci));
3522 ofpbuf_uninit(&nxm);
3524 /* Convert to and from OXM. */
3525 ofpbuf_init(&nxm, 0);
3526 nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3527 nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3528 error = oxm_pull_match(&nxm, &nxm_match);
3529 printf("OXM: %s -> ", nxm_s);
3531 printf("%s\n", ofperr_to_string(error));
3533 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3534 (VLAN_VID_MASK | VLAN_CFI);
3535 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3536 (VLAN_VID_MASK | VLAN_CFI);
3538 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3539 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3540 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3546 ofpbuf_uninit(&nxm);
3548 /* Convert to and from OpenFlow 1.0. */
3549 ofputil_match_to_ofp10_match(&match, &of10_raw);
3550 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3551 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3552 ntohs(of10_raw.dl_vlan),
3553 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3554 of10_raw.dl_vlan_pcp,
3555 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3556 ntohs(of10_match.flow.vlan_tci),
3557 ntohs(of10_match.wc.masks.vlan_tci));
3559 /* Convert to and from OpenFlow 1.1. */
3560 ofputil_match_to_ofp11_match(&match, &of11_raw);
3561 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3562 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3563 ntohs(of11_raw.dl_vlan),
3564 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3565 of11_raw.dl_vlan_pcp,
3566 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3567 ntohs(of11_match.flow.vlan_tci),
3568 ntohs(of11_match.wc.masks.vlan_tci));
3571 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3574 ofctl_print_error(struct ovs_cmdl_context *ctx)
3579 error = ofperr_from_name(ctx->argv[1]);
3581 ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3584 for (version = 0; version <= UINT8_MAX; version++) {
3585 const char *name = ofperr_domain_get_name(version);
3587 int vendor = ofperr_get_vendor(error, version);
3588 int type = ofperr_get_type(error, version);
3589 int code = ofperr_get_code(error, version);
3591 if (vendor != -1 || type != -1 || code != -1) {
3592 printf("%s: vendor %#x, type %d, code %d\n",
3593 name, vendor, type, code);
3599 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3600 * error named ENUM and prints the error reply in hex. */
3602 ofctl_encode_error_reply(struct ovs_cmdl_context *ctx)
3604 const struct ofp_header *oh;
3605 struct ofpbuf request, *reply;
3608 error = ofperr_from_name(ctx->argv[1]);
3610 ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3613 ofpbuf_init(&request, 0);
3614 if (ofpbuf_put_hex(&request, ctx->argv[2], NULL)[0] != '\0') {
3615 ovs_fatal(0, "Trailing garbage in hex data");
3617 if (request.size < sizeof(struct ofp_header)) {
3618 ovs_fatal(0, "Request too short");
3622 if (request.size != ntohs(oh->length)) {
3623 ovs_fatal(0, "Request size inconsistent");
3626 reply = ofperr_encode_reply(error, request.data);
3627 ofpbuf_uninit(&request);
3629 ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
3630 ofpbuf_delete(reply);
3633 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3634 * binary data, interpreting them as an OpenFlow message, and prints the
3635 * OpenFlow message on stdout, at VERBOSITY (level 2 by default).
3637 * Alternative usage: "ofp-print [VERBOSITY] - < HEXSTRING_FILE", where
3638 * HEXSTRING_FILE contains the HEXSTRING. */
3640 ofctl_ofp_print(struct ovs_cmdl_context *ctx)
3642 struct ofpbuf packet;
3649 if (!strcmp(ctx->argv[ctx->argc-1], "-")) {
3650 if (ds_get_line(&line, stdin)) {
3651 VLOG_FATAL("Failed to read stdin");
3654 buffer = line.string;
3655 verbosity = ctx->argc > 2 ? atoi(ctx->argv[1]) : verbosity;
3656 } else if (ctx->argc > 2) {
3657 buffer = ctx->argv[1];
3658 verbosity = atoi(ctx->argv[2]);
3660 buffer = ctx->argv[1];
3663 ofpbuf_init(&packet, strlen(buffer) / 2);
3664 if (ofpbuf_put_hex(&packet, buffer, NULL)[0] != '\0') {
3665 ovs_fatal(0, "trailing garbage following hex bytes");
3667 ofp_print(stdout, packet.data, packet.size, verbosity);
3668 ofpbuf_uninit(&packet);
3672 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3673 * and dumps each message in hex. */
3675 ofctl_encode_hello(struct ovs_cmdl_context *ctx)
3677 uint32_t bitmap = strtol(ctx->argv[1], NULL, 0);
3678 struct ofpbuf *hello;
3680 hello = ofputil_encode_hello(bitmap);
3681 ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
3682 ofp_print(stdout, hello->data, hello->size, verbosity);
3683 ofpbuf_delete(hello);
3686 static const struct ovs_cmdl_command all_commands[] = {
3689 { "monitor", "switch [misslen] [invalid_ttl] [watch:[...]]",
3690 1, 3, ofctl_monitor },
3691 { "snoop", "switch",
3692 1, 1, ofctl_snoop },
3693 { "dump-desc", "switch",
3694 1, 1, ofctl_dump_desc },
3695 { "dump-tables", "switch",
3696 1, 1, ofctl_dump_tables },
3697 { "dump-table-features", "switch",
3698 1, 1, ofctl_dump_table_features },
3699 { "dump-table-desc", "switch",
3700 1, 1, ofctl_dump_table_desc },
3701 { "dump-flows", "switch",
3702 1, 2, ofctl_dump_flows },
3703 { "dump-aggregate", "switch",
3704 1, 2, ofctl_dump_aggregate },
3705 { "queue-stats", "switch [port [queue]]",
3706 1, 3, ofctl_queue_stats },
3707 { "queue-get-config", "switch port",
3708 2, 2, ofctl_queue_get_config },
3709 { "add-flow", "switch flow",
3710 2, 2, ofctl_add_flow },
3711 { "add-flows", "switch file",
3712 2, 2, ofctl_add_flows },
3713 { "mod-flows", "switch flow",
3714 2, 2, ofctl_mod_flows },
3715 { "del-flows", "switch [flow]",
3716 1, 2, ofctl_del_flows },
3717 { "replace-flows", "switch file",
3718 2, 2, ofctl_replace_flows },
3719 { "diff-flows", "source1 source2",
3720 2, 2, ofctl_diff_flows },
3721 { "add-meter", "switch meter",
3722 2, 2, ofctl_add_meter },
3723 { "mod-meter", "switch meter",
3724 2, 2, ofctl_mod_meter },
3725 { "del-meter", "switch meter",
3726 2, 2, ofctl_del_meters },
3727 { "del-meters", "switch",
3728 1, 1, ofctl_del_meters },
3729 { "dump-meter", "switch meter",
3730 2, 2, ofctl_dump_meters },
3731 { "dump-meters", "switch",
3732 1, 1, ofctl_dump_meters },
3733 { "meter-stats", "switch [meter]",
3734 1, 2, ofctl_meter_stats },
3735 { "meter-features", "switch",
3736 1, 1, ofctl_meter_features },
3737 { "packet-out", "switch in_port actions packet...",
3738 4, INT_MAX, ofctl_packet_out },
3739 { "dump-ports", "switch [port]",
3740 1, 2, ofctl_dump_ports },
3741 { "dump-ports-desc", "switch [port]",
3742 1, 2, ofctl_dump_ports_desc },
3743 { "mod-port", "switch iface act",
3744 3, 3, ofctl_mod_port },
3745 { "mod-table", "switch mod",
3746 3, 3, ofctl_mod_table },
3747 { "get-frags", "switch",
3748 1, 1, ofctl_get_frags },
3749 { "set-frags", "switch frag_mode",
3750 2, 2, ofctl_set_frags },
3751 { "probe", "target",
3752 1, 1, ofctl_probe },
3753 { "ping", "target [n]",
3755 { "benchmark", "target n count",
3756 3, 3, ofctl_benchmark },
3758 { "ofp-parse", "file",
3759 1, 1, ofctl_ofp_parse },
3760 { "ofp-parse-pcap", "pcap",
3761 1, INT_MAX, ofctl_ofp_parse_pcap },
3763 { "add-group", "switch group",
3764 1, 2, ofctl_add_group },
3765 { "add-groups", "switch file",
3766 1, 2, ofctl_add_groups },
3767 { "mod-group", "switch group",
3768 1, 2, ofctl_mod_group },
3769 { "del-groups", "switch [group]",
3770 1, 2, ofctl_del_groups },
3771 { "insert-buckets", "switch [group]",
3772 1, 2, ofctl_insert_bucket },
3773 { "remove-buckets", "switch [group]",
3774 1, 2, ofctl_remove_bucket },
3775 { "dump-groups", "switch [group]",
3776 1, 2, ofctl_dump_group_desc },
3777 { "dump-group-stats", "switch [group]",
3778 1, 2, ofctl_dump_group_stats },
3779 { "dump-group-features", "switch",
3780 1, 1, ofctl_dump_group_features },
3781 { "add-geneve-map", "switch map",
3782 2, 2, ofctl_add_geneve_map },
3783 { "del-geneve-map", "switch [map]",
3784 1, 2, ofctl_del_geneve_map },
3785 { "dump-geneve-map", "switch",
3786 1, 1, ofctl_dump_geneve_map },
3787 { "help", NULL, 0, INT_MAX, ofctl_help },
3788 { "list-commands", NULL, 0, INT_MAX, ofctl_list_commands },
3790 /* Undocumented commands for testing. */
3791 { "parse-flow", NULL, 1, 1, ofctl_parse_flow },
3792 { "parse-flows", NULL, 1, 1, ofctl_parse_flows },
3793 { "parse-nx-match", NULL, 0, 0, ofctl_parse_nxm },
3794 { "parse-nxm", NULL, 0, 0, ofctl_parse_nxm },
3795 { "parse-oxm", NULL, 1, 1, ofctl_parse_oxm },
3796 { "parse-actions", NULL, 1, 1, ofctl_parse_actions },
3797 { "parse-instructions", NULL, 1, 1, ofctl_parse_instructions },
3798 { "parse-ofp10-match", NULL, 0, 0, ofctl_parse_ofp10_match },
3799 { "parse-ofp11-match", NULL, 0, 0, ofctl_parse_ofp11_match },
3800 { "parse-pcap", NULL, 1, 1, ofctl_parse_pcap },
3801 { "check-vlan", NULL, 2, 2, ofctl_check_vlan },
3802 { "print-error", NULL, 1, 1, ofctl_print_error },
3803 { "encode-error-reply", NULL, 2, 2, ofctl_encode_error_reply },
3804 { "ofp-print", NULL, 1, 2, ofctl_ofp_print },
3805 { "encode-hello", NULL, 1, 1, ofctl_encode_hello },
3807 { NULL, NULL, 0, 0, NULL },
3810 static const struct ovs_cmdl_command *get_all_commands(void)
3812 return all_commands;