2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
22 #include <sys/socket.h>
28 #include <sys/fcntl.h>
32 #include "byte-order.h"
33 #include "classifier.h"
34 #include "command-line.h"
38 #include "dynamic-string.h"
41 #include "ofp-actions.h"
42 #include "ofp-errors.h"
44 #include "ofp-parse.h"
45 #include "ofp-print.h"
47 #include "ofp-version-opt.h"
49 #include "ofproto/ofproto.h"
50 #include "openflow/nicira-ext.h"
51 #include "openflow/openflow.h"
53 #include "poll-loop.h"
55 #include "stream-ssl.h"
56 #include "socket-util.h"
62 #include "meta-flow.h"
65 VLOG_DEFINE_THIS_MODULE(ofctl);
67 /* --strict: Use strict matching for flow mod commands? Additionally governs
68 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
72 /* --readd: If true, on replace-flows, re-add even flows that have not changed
73 * (to reset flow counters). */
76 /* -F, --flow-format: Allowed protocols. By default, any protocol is
78 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
80 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
81 * commands. Either one of NXPIF_* to force a particular packet_in format, or
82 * -1 to let ovs-ofctl choose the default. */
83 static int preferred_packet_in_format = -1;
85 /* -m, --more: Additional verbosity for ofp-print functions. */
88 /* --timestamp: Print a timestamp before each received packet on "monitor" and
90 static bool timestamp;
92 /* --sort, --rsort: Sort order. */
93 enum sort_order { SORT_ASC, SORT_DESC };
94 struct sort_criterion {
95 const struct mf_field *field; /* NULL means to sort by priority. */
96 enum sort_order order;
98 static struct sort_criterion *criteria;
99 static size_t n_criteria, allocated_criteria;
101 static const struct command all_commands[];
103 static void usage(void) NO_RETURN;
104 static void parse_options(int argc, char *argv[]);
106 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
107 struct ofpbuf **replyp,
108 struct ofputil_flow_stats *,
109 struct ofpbuf *ofpacts);
111 main(int argc, char *argv[])
113 set_program_name(argv[0]);
114 parse_options(argc, argv);
115 signal(SIGPIPE, SIG_IGN);
116 run_command(argc - optind, argv + optind, all_commands);
121 add_sort_criterion(enum sort_order order, const char *field)
123 struct sort_criterion *sc;
125 if (n_criteria >= allocated_criteria) {
126 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
129 sc = &criteria[n_criteria++];
130 if (!field || !strcasecmp(field, "priority")) {
133 sc->field = mf_from_name(field);
135 ovs_fatal(0, "%s: unknown field name", field);
142 parse_options(int argc, char *argv[])
145 OPT_STRICT = UCHAR_MAX + 1,
151 OFP_VERSION_OPTION_ENUMS,
154 static struct option long_options[] = {
155 {"timeout", required_argument, NULL, 't'},
156 {"strict", no_argument, NULL, OPT_STRICT},
157 {"readd", no_argument, NULL, OPT_READD},
158 {"flow-format", required_argument, NULL, 'F'},
159 {"packet-in-format", required_argument, NULL, 'P'},
160 {"more", no_argument, NULL, 'm'},
161 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
162 {"sort", optional_argument, NULL, OPT_SORT},
163 {"rsort", optional_argument, NULL, OPT_RSORT},
164 {"help", no_argument, NULL, 'h'},
166 OFP_VERSION_LONG_OPTIONS,
168 STREAM_SSL_LONG_OPTIONS,
171 char *short_options = long_options_to_short_options(long_options);
173 enum ofputil_protocol version_protocols;
176 unsigned long int timeout;
179 c = getopt_long(argc, argv, short_options, long_options, NULL);
186 timeout = strtoul(optarg, NULL, 10);
188 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
196 allowed_protocols = ofputil_protocols_from_string(optarg);
197 if (!allowed_protocols) {
198 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
203 preferred_packet_in_format =
204 ofputil_packet_in_format_from_string(optarg);
205 if (preferred_packet_in_format < 0) {
206 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
230 add_sort_criterion(SORT_ASC, optarg);
234 add_sort_criterion(SORT_DESC, optarg);
237 DAEMON_OPTION_HANDLERS
238 OFP_VERSION_OPTION_HANDLERS
240 STREAM_SSL_OPTION_HANDLERS
251 /* Always do a final sort pass based on priority. */
252 add_sort_criterion(SORT_DESC, "priority");
257 versions = get_allowed_ofp_versions();
258 version_protocols = ofputil_protocols_from_version_bitmap(versions);
259 if (!(allowed_protocols & version_protocols)) {
260 char *protocols = ofputil_protocols_to_string(allowed_protocols);
261 struct ds version_s = DS_EMPTY_INITIALIZER;
263 ofputil_format_version_bitmap_names(&version_s, versions);
264 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
265 "any of the enabled flow formats (%s). (Use -O to enable "
266 "additional OpenFlow versions or -F to enable additional "
267 "flow formats.)", ds_cstr(&version_s), protocols);
269 allowed_protocols &= version_protocols;
270 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
277 printf("%s: OpenFlow switch management utility\n"
278 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
279 "\nFor OpenFlow switches:\n"
280 " show SWITCH show OpenFlow information\n"
281 " dump-desc SWITCH print switch description\n"
282 " dump-tables SWITCH print table stats\n"
283 " mod-port SWITCH IFACE ACT modify port behavior\n"
284 " get-frags SWITCH print fragment handling behavior\n"
285 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
286 " dump-ports SWITCH [PORT] print port statistics\n"
287 " dump-ports-desc SWITCH print port descriptions\n"
288 " dump-flows SWITCH print all flow entries\n"
289 " dump-flows SWITCH FLOW print matching FLOWs\n"
290 " dump-aggregate SWITCH print aggregate flow statistics\n"
291 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
292 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
293 " add-flow SWITCH FLOW add flow described by FLOW\n"
294 " add-flows SWITCH FILE add flows from FILE\n"
295 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
296 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
297 " replace-flows SWITCH FILE replace flows with those in FILE\n"
298 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
299 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
300 " execute ACTIONS on PACKET\n"
301 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
302 " print packets received from SWITCH\n"
303 " snoop SWITCH snoop on SWITCH and its controller\n"
304 "\nFor OpenFlow switches and controllers:\n"
305 " probe TARGET probe whether TARGET is up\n"
306 " ping TARGET [N] latency of N-byte echos\n"
307 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
308 "where SWITCH or TARGET is an active OpenFlow connection method.\n",
309 program_name, program_name);
310 vconn_usage(true, false, false);
314 printf("\nOther options:\n"
315 " --strict use strict match for flow commands\n"
316 " --readd replace flows that haven't changed\n"
317 " -F, --flow-format=FORMAT force particular flow format\n"
318 " -P, --packet-in-format=FRMT force particular packet in format\n"
319 " -m, --more be more verbose printing OpenFlow\n"
320 " --timestamp (monitor, snoop) print timestamps\n"
321 " -t, --timeout=SECS give up after SECS seconds\n"
322 " --sort[=field] sort in ascending order\n"
323 " --rsort[=field] sort in descending order\n"
324 " -h, --help display this help message\n"
325 " -V, --version display version information\n");
330 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
331 const char *argv[] OVS_UNUSED, void *exiting_)
333 bool *exiting = exiting_;
335 unixctl_command_reply(conn, NULL);
338 static void run(int retval, const char *message, ...)
342 run(int retval, const char *message, ...)
347 va_start(args, message);
348 ovs_fatal_valist(retval, message, args);
352 /* Generic commands. */
355 open_vconn_socket(const char *name, struct vconn **vconnp)
357 char *vconn_name = xasprintf("unix:%s", name);
360 error = vconn_open(vconn_name, get_allowed_ofp_versions(), vconnp,
362 if (error && error != ENOENT) {
363 ovs_fatal(0, "%s: failed to open socket (%s)", name,
371 static enum ofputil_protocol
372 open_vconn__(const char *name, const char *default_suffix,
373 struct vconn **vconnp)
375 char *datapath_name, *datapath_type, *socket_name;
376 enum ofputil_protocol protocol;
381 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
383 ofproto_parse_name(name, &datapath_name, &datapath_type);
384 socket_name = xasprintf("%s/%s.%s",
385 ovs_rundir(), datapath_name, default_suffix);
389 if (strchr(name, ':')) {
390 run(vconn_open_block(name, get_allowed_ofp_versions(), vconnp),
391 "connecting to %s", name);
392 } else if (!open_vconn_socket(name, vconnp)) {
394 } else if (!open_vconn_socket(bridge_path, vconnp)) {
396 } else if (!open_vconn_socket(socket_name, vconnp)) {
399 ovs_fatal(0, "%s is not a bridge or a socket", name);
405 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
406 error = vconn_connect_block(*vconnp);
408 ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
412 ofp_version = vconn_get_version(*vconnp);
413 protocol = ofputil_protocol_from_ofp_version(ofp_version);
415 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
421 static enum ofputil_protocol
422 open_vconn(const char *name, struct vconn **vconnp)
424 return open_vconn__(name, "mgmt", vconnp);
428 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
430 ofpmsg_update_length(buffer);
431 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
435 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
437 struct ofpbuf *reply;
439 ofpmsg_update_length(request);
440 run(vconn_transact(vconn, request, &reply), "talking to %s",
441 vconn_get_name(vconn));
442 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
443 ofpbuf_delete(reply);
447 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
449 struct ofpbuf *request;
452 open_vconn(vconn_name, &vconn);
453 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
454 dump_transaction(vconn, request);
459 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
461 const struct ofp_header *request_oh = request->data;
462 ovs_be32 send_xid = request_oh->xid;
463 enum ofpraw request_raw;
464 enum ofpraw reply_raw;
467 ofpraw_decode_partial(&request_raw, request->data, request->size);
468 reply_raw = ofpraw_stats_request_to_reply(request_raw,
469 request_oh->version);
471 send_openflow_buffer(vconn, request);
474 struct ofpbuf *reply;
476 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
477 recv_xid = ((struct ofp_header *) reply->data)->xid;
478 if (send_xid == recv_xid) {
481 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
483 ofpraw_decode(&raw, reply->data);
484 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
486 } else if (raw == reply_raw) {
487 done = !ofpmp_more(reply->data);
489 ovs_fatal(0, "received bad reply: %s",
490 ofp_to_string(reply->data, reply->size,
494 VLOG_DBG("received reply with xid %08"PRIx32" "
495 "!= expected %08"PRIx32, recv_xid, send_xid);
497 ofpbuf_delete(reply);
502 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
504 struct ofpbuf *request;
507 open_vconn(vconn_name, &vconn);
508 request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
509 dump_stats_transaction(vconn, request);
513 /* Sends 'request', which should be a request that only has a reply if an error
514 * occurs, and waits for it to succeed or fail. If an error does occur, prints
515 * it and exits with an error.
517 * Destroys all of the 'requests'. */
519 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
521 struct ofpbuf *request, *reply;
523 LIST_FOR_EACH (request, list_node, requests) {
524 ofpmsg_update_length(request);
527 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
528 "talking to %s", vconn_get_name(vconn));
530 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
533 ofpbuf_delete(reply);
536 /* Sends 'request', which should be a request that only has a reply if an error
537 * occurs, and waits for it to succeed or fail. If an error does occur, prints
538 * it and exits with an error.
540 * Destroys 'request'. */
542 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
544 struct list requests;
546 list_init(&requests);
547 list_push_back(&requests, &request->list_node);
548 transact_multiple_noreply(vconn, &requests);
552 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
554 struct ofp_switch_config *config;
555 struct ofpbuf *request;
556 struct ofpbuf *reply;
559 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
560 vconn_get_version(vconn), 0);
561 run(vconn_transact(vconn, request, &reply),
562 "talking to %s", vconn_get_name(vconn));
564 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
565 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
568 config = ofpbuf_pull(reply, sizeof *config);
571 ofpbuf_delete(reply);
575 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
577 struct ofpbuf *request;
579 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, vconn_get_version(vconn), 0);
580 ofpbuf_put(request, config, sizeof *config);
582 transact_noreply(vconn, request);
586 ofctl_show(int argc OVS_UNUSED, char *argv[])
588 const char *vconn_name = argv[1];
590 struct ofpbuf *request;
591 struct ofpbuf *reply;
594 open_vconn(vconn_name, &vconn);
595 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
596 vconn_get_version(vconn), 0);
597 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
599 trunc = ofputil_switch_features_ports_trunc(reply);
600 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
602 ofpbuf_delete(reply);
605 /* The Features Reply may not contain all the ports, so send a
606 * Port Description stats request, which doesn't have size
608 dump_trivial_stats_transaction(vconn_name,
609 OFPRAW_OFPST_PORT_DESC_REQUEST);
611 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
616 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
618 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
622 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
624 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
628 fetch_port_by_features(const char *vconn_name,
629 const char *port_name, unsigned int port_no,
630 struct ofputil_phy_port *pp, bool *trunc)
632 struct ofputil_switch_features features;
633 const struct ofp_header *oh;
634 struct ofpbuf *request, *reply;
641 /* Fetch the switch's ofp_switch_features. */
642 open_vconn(vconn_name, &vconn);
643 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST,
644 vconn_get_version(vconn), 0);
645 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
649 if (ofptype_decode(&type, reply->data)
650 || type != OFPTYPE_FEATURES_REPLY) {
651 ovs_fatal(0, "%s: received bad features reply", vconn_name);
655 if (ofputil_switch_features_ports_trunc(reply)) {
660 error = ofputil_decode_switch_features(oh, &features, &b);
662 ovs_fatal(0, "%s: failed to decode features reply (%s)",
663 vconn_name, ofperr_to_string(error));
666 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
667 if (port_no != UINT_MAX
668 ? port_no == pp->port_no
669 : !strcmp(pp->name, port_name)) {
676 ofpbuf_delete(reply);
681 fetch_port_by_stats(const char *vconn_name,
682 const char *port_name, unsigned int port_no,
683 struct ofputil_phy_port *pp)
685 struct ofpbuf *request;
691 request = ofpraw_alloc(OFPRAW_OFPST_PORT_DESC_REQUEST, OFP10_VERSION, 0);
692 send_xid = ((struct ofp_header *) request->data)->xid;
694 open_vconn(vconn_name, &vconn);
695 send_openflow_buffer(vconn, request);
698 struct ofpbuf *reply;
700 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
701 recv_xid = ((struct ofp_header *) reply->data)->xid;
702 if (send_xid == recv_xid) {
703 struct ofp_header *oh = reply->data;
708 ofpbuf_use_const(&b, oh, ntohs(oh->length));
709 if (ofptype_pull(&type, &b)
710 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
711 ovs_fatal(0, "received bad reply: %s",
712 ofp_to_string(reply->data, reply->size,
716 flags = ofpmp_flags(oh);
717 done = !(flags & OFPSF_REPLY_MORE);
720 /* We've already found the port, but we need to drain
721 * the queue of any other replies for this request. */
725 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
726 if (port_no != UINT_MAX ? port_no == pp->port_no
727 : !strcmp(pp->name, port_name)) {
733 VLOG_DBG("received reply with xid %08"PRIx32" "
734 "!= expected %08"PRIx32, recv_xid, send_xid);
736 ofpbuf_delete(reply);
744 /* Opens a connection to 'vconn_name', fetches the port structure for
745 * 'port_name' (which may be a port name or number), and copies it into
748 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
749 struct ofputil_phy_port *pp)
751 unsigned int port_no;
755 /* Try to interpret the argument as a port number. */
756 if (!str_to_uint(port_name, 10, &port_no)) {
760 /* Try to find the port based on the Features Reply. If it looks
761 * like the results may be truncated, then use the Port Description
762 * stats message introduced in OVS 1.7. */
763 found = fetch_port_by_features(vconn_name, port_name, port_no, pp,
766 found = fetch_port_by_stats(vconn_name, port_name, port_no, pp);
770 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
774 /* Returns the port number corresponding to 'port_name' (which may be a port
775 * name or number) within the switch 'vconn_name'. */
777 str_to_port_no(const char *vconn_name, const char *port_name)
781 if (ofputil_port_from_string(port_name, &port_no)) {
784 struct ofputil_phy_port pp;
786 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
792 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
793 enum ofputil_protocol *cur)
796 struct ofpbuf *request, *reply;
797 enum ofputil_protocol next;
799 request = ofputil_encode_set_protocol(*cur, want, &next);
804 run(vconn_transact_noreply(vconn, request, &reply),
805 "talking to %s", vconn_get_name(vconn));
807 char *s = ofp_to_string(reply->data, reply->size, 2);
808 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
809 vconn_get_name(vconn), s);
811 ofpbuf_delete(reply);
819 static enum ofputil_protocol
820 set_protocol_for_flow_dump(struct vconn *vconn,
821 enum ofputil_protocol cur_protocol,
822 enum ofputil_protocol usable_protocols)
827 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
828 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
829 if (f & usable_protocols & allowed_protocols
830 && try_set_protocol(vconn, f, &cur_protocol)) {
835 usable_s = ofputil_protocols_to_string(usable_protocols);
836 if (usable_protocols & allowed_protocols) {
837 ovs_fatal(0, "switch does not support any of the usable flow "
838 "formats (%s)", usable_s);
840 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
841 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
842 "allowed flow formats (%s)", usable_s, allowed_s);
846 static struct vconn *
847 prepare_dump_flows(int argc, char *argv[], bool aggregate,
848 struct ofpbuf **requestp)
850 enum ofputil_protocol usable_protocols, protocol;
851 struct ofputil_flow_stats_request fsr;
854 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
855 usable_protocols = ofputil_flow_stats_request_usable_protocols(&fsr);
857 protocol = open_vconn(argv[1], &vconn);
858 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
859 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
864 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
866 struct ofpbuf *request;
869 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
870 dump_stats_transaction(vconn, request);
875 compare_flows(const void *afs_, const void *bfs_)
877 const struct ofputil_flow_stats *afs = afs_;
878 const struct ofputil_flow_stats *bfs = bfs_;
879 const struct match *a = &afs->match;
880 const struct match *b = &bfs->match;
881 const struct sort_criterion *sc;
883 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
884 const struct mf_field *f = sc->field;
888 unsigned int a_pri = afs->priority;
889 unsigned int b_pri = bfs->priority;
890 ret = a_pri < b_pri ? -1 : a_pri > b_pri;
894 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
895 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
897 /* Skip the test for sc->order, so that missing fields always
898 * sort to the end whether we're sorting in ascending or
899 * descending order. */
902 union mf_value aval, bval;
904 mf_get_value(f, &a->flow, &aval);
905 mf_get_value(f, &b->flow, &bval);
906 ret = memcmp(&aval, &bval, f->n_bytes);
911 return sc->order == SORT_ASC ? ret : -ret;
919 ofctl_dump_flows(int argc, char *argv[])
922 return ofctl_dump_flows__(argc, argv, false);
924 struct ofputil_flow_stats *fses;
925 size_t n_fses, allocated_fses;
926 struct ofpbuf *request;
927 struct ofpbuf ofpacts;
928 struct ofpbuf *reply;
934 vconn = prepare_dump_flows(argc, argv, false, &request);
935 send_xid = ((struct ofp_header *) request->data)->xid;
936 send_openflow_buffer(vconn, request);
939 n_fses = allocated_fses = 0;
941 ofpbuf_init(&ofpacts, 0);
943 struct ofputil_flow_stats *fs;
945 if (n_fses >= allocated_fses) {
946 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
950 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
954 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
957 ofpbuf_uninit(&ofpacts);
959 qsort(fses, n_fses, sizeof *fses, compare_flows);
962 for (i = 0; i < n_fses; i++) {
964 ofp_print_flow_stats(&s, &fses[i]);
969 for (i = 0; i < n_fses; i++) {
970 free(fses[i].ofpacts);
979 ofctl_dump_aggregate(int argc, char *argv[])
981 return ofctl_dump_flows__(argc, argv, true);
985 ofctl_queue_stats(int argc, char *argv[])
987 struct ofpbuf *request;
989 struct ofputil_queue_stats_request oqs;
991 open_vconn(argv[1], &vconn);
993 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
994 oqs.port_no = str_to_port_no(argv[1], argv[2]);
996 oqs.port_no = OFPP_ANY;
998 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
999 oqs.queue_id = atoi(argv[3]);
1001 oqs.queue_id = OFPQ_ALL;
1004 request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1005 dump_stats_transaction(vconn, request);
1009 static enum ofputil_protocol
1010 open_vconn_for_flow_mod(const char *remote,
1011 const struct ofputil_flow_mod *fms, size_t n_fms,
1012 struct vconn **vconnp)
1014 enum ofputil_protocol usable_protocols;
1015 enum ofputil_protocol cur_protocol;
1019 /* Figure out what flow formats will work. */
1020 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
1021 if (!(usable_protocols & allowed_protocols)) {
1022 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1023 usable_s = ofputil_protocols_to_string(usable_protocols);
1024 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1025 "allowed flow formats (%s)", usable_s, allowed_s);
1028 /* If the initial flow format is allowed and usable, keep it. */
1029 cur_protocol = open_vconn(remote, vconnp);
1030 if (usable_protocols & allowed_protocols & cur_protocol) {
1031 return cur_protocol;
1034 /* Otherwise try each flow format in turn. */
1035 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1036 enum ofputil_protocol f = 1 << i;
1038 if (f != cur_protocol
1039 && f & usable_protocols & allowed_protocols
1040 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1045 usable_s = ofputil_protocols_to_string(usable_protocols);
1046 ovs_fatal(0, "switch does not support any of the usable flow "
1047 "formats (%s)", usable_s);
1051 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1054 enum ofputil_protocol protocol;
1055 struct vconn *vconn;
1058 protocol = open_vconn_for_flow_mod(remote, fms, n_fms, &vconn);
1060 for (i = 0; i < n_fms; i++) {
1061 struct ofputil_flow_mod *fm = &fms[i];
1063 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1070 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1072 struct ofputil_flow_mod *fms = NULL;
1075 parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms);
1076 ofctl_flow_mod__(argv[1], fms, n_fms);
1081 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1083 if (argc > 2 && !strcmp(argv[2], "-")) {
1084 ofctl_flow_mod_file(argc, argv, command);
1086 struct ofputil_flow_mod fm;
1087 parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command, false);
1088 ofctl_flow_mod__(argv[1], &fm, 1);
1093 ofctl_add_flow(int argc, char *argv[])
1095 ofctl_flow_mod(argc, argv, OFPFC_ADD);
1099 ofctl_add_flows(int argc, char *argv[])
1101 ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1105 ofctl_mod_flows(int argc, char *argv[])
1107 ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1111 ofctl_del_flows(int argc, char *argv[])
1113 ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1117 set_packet_in_format(struct vconn *vconn,
1118 enum nx_packet_in_format packet_in_format)
1120 struct ofpbuf *spif;
1122 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1124 transact_noreply(vconn, spif);
1125 VLOG_DBG("%s: using user-specified packet in format %s",
1126 vconn_get_name(vconn),
1127 ofputil_packet_in_format_to_string(packet_in_format));
1131 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1133 struct ofp_switch_config config;
1134 enum ofp_config_flags flags;
1136 fetch_switch_config(vconn, &config);
1137 flags = ntohs(config.flags);
1138 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1139 /* Set the invalid ttl config. */
1140 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1142 config.flags = htons(flags);
1143 set_switch_config(vconn, &config);
1145 /* Then retrieve the configuration to see if it really took. OpenFlow
1146 * doesn't define error reporting for bad modes, so this is all we can
1148 fetch_switch_config(vconn, &config);
1149 flags = ntohs(config.flags);
1150 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1151 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1152 "switch probably doesn't support mode)");
1159 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1160 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1161 * an error message and stores NULL in '*msgp'. */
1163 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1165 struct ofp_header *oh;
1168 msg = ofpbuf_new(strlen(hex) / 2);
1171 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1173 return "Trailing garbage in hex data";
1176 if (msg->size < sizeof(struct ofp_header)) {
1178 return "Message too short for OpenFlow";
1182 if (msg->size != ntohs(oh->length)) {
1184 return "Message size does not match length in OpenFlow header";
1192 ofctl_send(struct unixctl_conn *conn, int argc,
1193 const char *argv[], void *vconn_)
1195 struct vconn *vconn = vconn_;
1202 for (i = 1; i < argc; i++) {
1203 const char *error_msg;
1207 error_msg = openflow_from_hex(argv[i], &msg);
1209 ds_put_format(&reply, "%s\n", error_msg);
1214 fprintf(stderr, "send: ");
1215 ofp_print(stderr, msg->data, msg->size, verbosity);
1217 error = vconn_send_block(vconn, msg);
1220 ds_put_format(&reply, "%s\n", strerror(error));
1223 ds_put_cstr(&reply, "sent\n");
1228 unixctl_command_reply(conn, ds_cstr(&reply));
1230 unixctl_command_reply_error(conn, ds_cstr(&reply));
1235 struct barrier_aux {
1236 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1237 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1241 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1242 const char *argv[] OVS_UNUSED, void *aux_)
1244 struct barrier_aux *aux = aux_;
1249 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1253 msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1254 error = vconn_send_block(aux->vconn, msg);
1257 unixctl_command_reply_error(conn, strerror(error));
1264 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1265 const char *argv[], void *aux OVS_UNUSED)
1269 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1271 unixctl_command_reply_error(conn, strerror(errno));
1276 dup2(fd, STDERR_FILENO);
1278 unixctl_command_reply(conn, NULL);
1282 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1283 const char *argv[] OVS_UNUSED, void *blocked_)
1285 bool *blocked = blocked_;
1289 unixctl_command_reply(conn, NULL);
1291 unixctl_command_reply(conn, "already blocking");
1296 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1297 const char *argv[] OVS_UNUSED, void *blocked_)
1299 bool *blocked = blocked_;
1303 unixctl_command_reply(conn, NULL);
1305 unixctl_command_reply(conn, "already unblocked");
1310 monitor_vconn(struct vconn *vconn)
1312 struct barrier_aux barrier_aux = { vconn, NULL };
1313 struct unixctl_server *server;
1314 bool exiting = false;
1315 bool blocked = false;
1318 daemon_save_fd(STDERR_FILENO);
1320 error = unixctl_server_create(NULL, &server);
1322 ovs_fatal(error, "failed to create unixctl server");
1324 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1325 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1327 unixctl_command_register("ofctl/barrier", "", 0, 0,
1328 ofctl_barrier, &barrier_aux);
1329 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1330 ofctl_set_output_file, NULL);
1332 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1333 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1336 daemonize_complete();
1342 unixctl_server_run(server);
1347 retval = vconn_recv(vconn, &b);
1348 if (retval == EAGAIN) {
1351 run(retval, "vconn_recv");
1354 time_t now = time_wall();
1357 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S: ", gmtime(&now));
1361 ofptype_decode(&type, b->data);
1362 ofp_print(stderr, b->data, b->size, verbosity + 2);
1365 if (barrier_aux.conn && type == OFPTYPE_BARRIER_REPLY) {
1366 unixctl_command_reply(barrier_aux.conn, NULL);
1367 barrier_aux.conn = NULL;
1376 vconn_run_wait(vconn);
1378 vconn_recv_wait(vconn);
1380 unixctl_server_wait(server);
1384 unixctl_server_destroy(server);
1388 ofctl_monitor(int argc, char *argv[])
1390 struct vconn *vconn;
1393 open_vconn(argv[1], &vconn);
1394 for (i = 2; i < argc; i++) {
1395 const char *arg = argv[i];
1397 if (isdigit((unsigned char) *arg)) {
1398 struct ofp_switch_config config;
1400 fetch_switch_config(vconn, &config);
1401 config.miss_send_len = htons(atoi(arg));
1402 set_switch_config(vconn, &config);
1403 } else if (!strcmp(arg, "invalid_ttl")) {
1404 monitor_set_invalid_ttl_to_controller(vconn);
1405 } else if (!strncmp(arg, "watch:", 6)) {
1406 struct ofputil_flow_monitor_request fmr;
1409 parse_flow_monitor_request(&fmr, arg + 6);
1411 msg = ofpbuf_new(0);
1412 ofputil_append_flow_monitor_request(&fmr, msg);
1413 dump_stats_transaction(vconn, msg);
1415 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1419 if (preferred_packet_in_format >= 0) {
1420 set_packet_in_format(vconn, preferred_packet_in_format);
1422 enum ofp_version version = vconn_get_version(vconn);
1425 case OFP10_VERSION: {
1426 struct ofpbuf *spif, *reply;
1428 spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1430 run(vconn_transact_noreply(vconn, spif, &reply),
1431 "talking to %s", vconn_get_name(vconn));
1433 char *s = ofp_to_string(reply->data, reply->size, 2);
1434 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1435 " replied: %s. Falling back to the switch default.",
1436 vconn_get_name(vconn), s);
1438 ofpbuf_delete(reply);
1451 monitor_vconn(vconn);
1455 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1457 struct vconn *vconn;
1459 open_vconn__(argv[1], "snoop", &vconn);
1460 monitor_vconn(vconn);
1464 ofctl_dump_ports(int argc, char *argv[])
1466 struct ofpbuf *request;
1467 struct vconn *vconn;
1470 open_vconn(argv[1], &vconn);
1471 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1472 request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1473 dump_stats_transaction(vconn, request);
1478 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1480 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_PORT_DESC_REQUEST);
1484 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1486 struct ofpbuf *request;
1487 struct vconn *vconn;
1488 struct ofpbuf *reply;
1490 open_vconn(argv[1], &vconn);
1491 request = make_echo_request(vconn_get_version(vconn));
1492 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1493 if (reply->size != sizeof(struct ofp_header)) {
1494 ovs_fatal(0, "reply does not match request");
1496 ofpbuf_delete(reply);
1501 ofctl_packet_out(int argc, char *argv[])
1503 enum ofputil_protocol protocol;
1504 struct ofputil_packet_out po;
1505 struct ofpbuf ofpacts;
1506 struct vconn *vconn;
1509 ofpbuf_init(&ofpacts, 64);
1510 parse_ofpacts(argv[3], &ofpacts);
1512 po.buffer_id = UINT32_MAX;
1513 po.in_port = str_to_port_no(argv[1], argv[2]);
1514 po.ofpacts = ofpacts.data;
1515 po.ofpacts_len = ofpacts.size;
1517 protocol = open_vconn(argv[1], &vconn);
1518 for (i = 4; i < argc; i++) {
1519 struct ofpbuf *packet, *opo;
1520 const char *error_msg;
1522 error_msg = eth_from_hex(argv[i], &packet);
1524 ovs_fatal(0, "%s", error_msg);
1527 po.packet = packet->data;
1528 po.packet_len = packet->size;
1529 opo = ofputil_encode_packet_out(&po, protocol);
1530 transact_noreply(vconn, opo);
1531 ofpbuf_delete(packet);
1534 ofpbuf_uninit(&ofpacts);
1538 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1540 struct ofp_config_flag {
1541 const char *name; /* The flag's name. */
1542 enum ofputil_port_config bit; /* Bit to turn on or off. */
1543 bool on; /* Value to set the bit to. */
1545 static const struct ofp_config_flag flags[] = {
1546 { "up", OFPUTIL_PC_PORT_DOWN, false },
1547 { "down", OFPUTIL_PC_PORT_DOWN, true },
1548 { "stp", OFPUTIL_PC_NO_STP, false },
1549 { "receive", OFPUTIL_PC_NO_RECV, false },
1550 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1551 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1552 { "forward", OFPUTIL_PC_NO_FWD, false },
1553 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1556 const struct ofp_config_flag *flag;
1557 enum ofputil_protocol protocol;
1558 struct ofputil_port_mod pm;
1559 struct ofputil_phy_port pp;
1560 struct vconn *vconn;
1561 const char *command;
1564 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1566 pm.port_no = pp.port_no;
1567 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1572 if (!strncasecmp(argv[3], "no-", 3)) {
1573 command = argv[3] + 3;
1575 } else if (!strncasecmp(argv[3], "no", 2)) {
1576 command = argv[3] + 2;
1582 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1583 if (!strcasecmp(command, flag->name)) {
1584 pm.mask = flag->bit;
1585 pm.config = flag->on ^ not ? flag->bit : 0;
1589 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1592 protocol = open_vconn(argv[1], &vconn);
1593 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1598 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1600 struct ofp_switch_config config;
1601 struct vconn *vconn;
1603 open_vconn(argv[1], &vconn);
1604 fetch_switch_config(vconn, &config);
1605 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1610 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1612 struct ofp_switch_config config;
1613 enum ofp_config_flags mode;
1614 struct vconn *vconn;
1617 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1618 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1621 open_vconn(argv[1], &vconn);
1622 fetch_switch_config(vconn, &config);
1623 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1624 if (flags != config.flags) {
1625 /* Set the configuration. */
1626 config.flags = flags;
1627 set_switch_config(vconn, &config);
1629 /* Then retrieve the configuration to see if it really took. OpenFlow
1630 * doesn't define error reporting for bad modes, so this is all we can
1632 fetch_switch_config(vconn, &config);
1633 if (flags != config.flags) {
1634 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1635 "switch probably doesn't support mode \"%s\")",
1636 argv[1], ofputil_frag_handling_to_string(mode));
1643 ofctl_ping(int argc, char *argv[])
1645 size_t max_payload = 65535 - sizeof(struct ofp_header);
1646 unsigned int payload;
1647 struct vconn *vconn;
1650 payload = argc > 2 ? atoi(argv[2]) : 64;
1651 if (payload > max_payload) {
1652 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1655 open_vconn(argv[1], &vconn);
1656 for (i = 0; i < 10; i++) {
1657 struct timeval start, end;
1658 struct ofpbuf *request, *reply;
1659 const struct ofp_header *rpy_hdr;
1662 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1663 vconn_get_version(vconn), payload);
1664 random_bytes(ofpbuf_put_uninit(request, payload), payload);
1666 xgettimeofday(&start);
1667 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1668 xgettimeofday(&end);
1670 rpy_hdr = reply->data;
1671 if (ofptype_pull(&type, reply)
1672 || type != OFPTYPE_ECHO_REPLY
1673 || reply->size != payload
1674 || memcmp(request->l3, reply->l3, payload)) {
1675 printf("Reply does not match request. Request:\n");
1676 ofp_print(stdout, request, request->size, verbosity + 2);
1678 ofp_print(stdout, reply, reply->size, verbosity + 2);
1680 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1681 reply->size, argv[1], ntohl(rpy_hdr->xid),
1682 (1000*(double)(end.tv_sec - start.tv_sec))
1683 + (.001*(end.tv_usec - start.tv_usec)));
1684 ofpbuf_delete(request);
1685 ofpbuf_delete(reply);
1691 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
1693 size_t max_payload = 65535 - sizeof(struct ofp_header);
1694 struct timeval start, end;
1695 unsigned int payload_size, message_size;
1696 struct vconn *vconn;
1701 payload_size = atoi(argv[2]);
1702 if (payload_size > max_payload) {
1703 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1705 message_size = sizeof(struct ofp_header) + payload_size;
1707 count = atoi(argv[3]);
1709 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1710 count, message_size, count * message_size);
1712 open_vconn(argv[1], &vconn);
1713 xgettimeofday(&start);
1714 for (i = 0; i < count; i++) {
1715 struct ofpbuf *request, *reply;
1717 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1718 vconn_get_version(vconn), payload_size);
1719 ofpbuf_put_zeros(request, payload_size);
1720 run(vconn_transact(vconn, request, &reply), "transact");
1721 ofpbuf_delete(reply);
1723 xgettimeofday(&end);
1726 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1727 + (.001*(end.tv_usec - start.tv_usec)));
1728 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1729 duration, count / (duration / 1000.0),
1730 count * message_size / (duration / 1000.0));
1734 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1739 /* replace-flows and diff-flows commands. */
1741 /* A flow table entry, possibly with two different versions. */
1743 struct cls_rule rule; /* Within a "struct classifier". */
1744 struct fte_version *versions[2];
1747 /* One version of a Flow Table Entry. */
1748 struct fte_version {
1750 uint16_t idle_timeout;
1751 uint16_t hard_timeout;
1753 struct ofpact *ofpacts;
1757 /* Frees 'version' and the data that it owns. */
1759 fte_version_free(struct fte_version *version)
1762 free(version->ofpacts);
1767 /* Returns true if 'a' and 'b' are the same, false if they differ.
1769 * Ignores differences in 'flags' because there's no way to retrieve flags from
1770 * an OpenFlow switch. We have to assume that they are the same. */
1772 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1774 return (a->cookie == b->cookie
1775 && a->idle_timeout == b->idle_timeout
1776 && a->hard_timeout == b->hard_timeout
1777 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
1778 b->ofpacts, b->ofpacts_len));
1781 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
1782 * 'index' into 's', followed by a new-line. */
1784 fte_version_format(const struct fte *fte, int index, struct ds *s)
1786 const struct fte_version *version = fte->versions[index];
1793 cls_rule_format(&fte->rule, s);
1794 if (version->cookie != htonll(0)) {
1795 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
1797 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1798 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
1800 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1801 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
1804 ds_put_char(s, ' ');
1805 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
1807 ds_put_char(s, '\n');
1811 fte_from_cls_rule(const struct cls_rule *cls_rule)
1813 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1816 /* Frees 'fte' and its versions. */
1818 fte_free(struct fte *fte)
1821 fte_version_free(fte->versions[0]);
1822 fte_version_free(fte->versions[1]);
1823 cls_rule_destroy(&fte->rule);
1828 /* Frees all of the FTEs within 'cls'. */
1830 fte_free_all(struct classifier *cls)
1832 struct cls_cursor cursor;
1833 struct fte *fte, *next;
1835 cls_cursor_init(&cursor, cls, NULL);
1836 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1837 classifier_remove(cls, &fte->rule);
1840 classifier_destroy(cls);
1843 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1844 * necessary. Sets 'version' as the version of that rule with the given
1845 * 'index', replacing any existing version, if any.
1847 * Takes ownership of 'version'. */
1849 fte_insert(struct classifier *cls, const struct match *match,
1850 unsigned int priority, struct fte_version *version, int index)
1852 struct fte *old, *fte;
1854 fte = xzalloc(sizeof *fte);
1855 cls_rule_init(&fte->rule, match, priority);
1856 fte->versions[index] = version;
1858 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1860 fte_version_free(old->versions[index]);
1861 fte->versions[!index] = old->versions[!index];
1862 cls_rule_destroy(&old->rule);
1867 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1868 * with the specified 'index'. Returns the flow formats able to represent the
1869 * flows that were read. */
1870 static enum ofputil_protocol
1871 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1873 enum ofputil_protocol usable_protocols;
1877 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1879 ovs_fatal(errno, "%s: open", filename);
1883 usable_protocols = OFPUTIL_P_ANY;
1884 while (!ds_get_preprocessed_line(&s, file)) {
1885 struct fte_version *version;
1886 struct ofputil_flow_mod fm;
1888 parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1890 version = xmalloc(sizeof *version);
1891 version->cookie = fm.new_cookie;
1892 version->idle_timeout = fm.idle_timeout;
1893 version->hard_timeout = fm.hard_timeout;
1894 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF10_EMERG);
1895 version->ofpacts = fm.ofpacts;
1896 version->ofpacts_len = fm.ofpacts_len;
1898 usable_protocols &= ofputil_usable_protocols(&fm.match);
1900 fte_insert(cls, &fm.match, fm.priority, version, index);
1904 if (file != stdin) {
1908 return usable_protocols;
1912 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
1913 struct ofpbuf **replyp,
1914 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
1916 struct ofpbuf *reply = *replyp;
1922 /* Get a flow stats reply message, if we don't already have one. */
1928 run(vconn_recv_block(vconn, &reply),
1929 "OpenFlow packet receive failed");
1930 } while (((struct ofp_header *) reply->data)->xid != send_xid);
1932 error = ofptype_decode(&type, reply->data);
1933 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
1934 ovs_fatal(0, "received bad reply: %s",
1935 ofp_to_string(reply->data, reply->size,
1940 /* Pull an individual flow stats reply out of the message. */
1941 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
1948 more = ofpmp_more(reply->l2);
1949 ofpbuf_delete(reply);
1958 ovs_fatal(0, "parse error in reply (%s)",
1959 ofperr_to_string(retval));
1964 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1965 * format 'protocol', and adds them as flow table entries in 'cls' for the
1966 * version with the specified 'index'. */
1968 read_flows_from_switch(struct vconn *vconn,
1969 enum ofputil_protocol protocol,
1970 struct classifier *cls, int index)
1972 struct ofputil_flow_stats_request fsr;
1973 struct ofputil_flow_stats fs;
1974 struct ofpbuf *request;
1975 struct ofpbuf ofpacts;
1976 struct ofpbuf *reply;
1979 fsr.aggregate = false;
1980 match_init_catchall(&fsr.match);
1981 fsr.out_port = OFPP_ANY;
1982 fsr.table_id = 0xff;
1983 fsr.cookie = fsr.cookie_mask = htonll(0);
1984 request = ofputil_encode_flow_stats_request(&fsr, protocol);
1985 send_xid = ((struct ofp_header *) request->data)->xid;
1986 send_openflow_buffer(vconn, request);
1989 ofpbuf_init(&ofpacts, 0);
1990 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
1991 struct fte_version *version;
1993 version = xmalloc(sizeof *version);
1994 version->cookie = fs.cookie;
1995 version->idle_timeout = fs.idle_timeout;
1996 version->hard_timeout = fs.hard_timeout;
1998 version->ofpacts_len = fs.ofpacts_len;
1999 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2001 fte_insert(cls, &fs.match, fs.priority, version, index);
2003 ofpbuf_uninit(&ofpacts);
2007 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2008 enum ofputil_protocol protocol, struct list *packets)
2010 const struct fte_version *version = fte->versions[index];
2011 struct ofputil_flow_mod fm;
2014 minimatch_expand(&fte->rule.match, &fm.match);
2015 fm.priority = fte->rule.priority;
2016 fm.cookie = htonll(0);
2017 fm.cookie_mask = htonll(0);
2018 fm.new_cookie = version->cookie;
2020 fm.command = command;
2021 fm.idle_timeout = version->idle_timeout;
2022 fm.hard_timeout = version->hard_timeout;
2023 fm.buffer_id = UINT32_MAX;
2024 fm.out_port = OFPP_ANY;
2025 fm.flags = version->flags;
2026 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2027 command == OFPFC_MODIFY_STRICT) {
2028 fm.ofpacts = version->ofpacts;
2029 fm.ofpacts_len = version->ofpacts_len;
2035 ofm = ofputil_encode_flow_mod(&fm, protocol);
2036 list_push_back(packets, &ofm->list_node);
2040 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
2042 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2043 enum ofputil_protocol usable_protocols, protocol;
2044 struct cls_cursor cursor;
2045 struct classifier cls;
2046 struct list requests;
2047 struct vconn *vconn;
2050 classifier_init(&cls);
2051 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2053 protocol = open_vconn(argv[1], &vconn);
2054 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2056 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2058 list_init(&requests);
2060 /* Delete flows that exist on the switch but not in the file. */
2061 cls_cursor_init(&cursor, &cls, NULL);
2062 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2063 struct fte_version *file_ver = fte->versions[FILE_IDX];
2064 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2066 if (sw_ver && !file_ver) {
2067 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2068 protocol, &requests);
2072 /* Add flows that exist in the file but not on the switch.
2073 * Update flows that exist in both places but differ. */
2074 cls_cursor_init(&cursor, &cls, NULL);
2075 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2076 struct fte_version *file_ver = fte->versions[FILE_IDX];
2077 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2080 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2081 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2084 transact_multiple_noreply(vconn, &requests);
2091 read_flows_from_source(const char *source, struct classifier *cls, int index)
2095 if (source[0] == '/' || source[0] == '.'
2096 || (!strchr(source, ':') && !stat(source, &s))) {
2097 read_flows_from_file(source, cls, index);
2099 enum ofputil_protocol protocol;
2100 struct vconn *vconn;
2102 protocol = open_vconn(source, &vconn);
2103 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2104 read_flows_from_switch(vconn, protocol, cls, index);
2110 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2112 bool differences = false;
2113 struct cls_cursor cursor;
2114 struct classifier cls;
2118 classifier_init(&cls);
2119 read_flows_from_source(argv[1], &cls, 0);
2120 read_flows_from_source(argv[2], &cls, 1);
2125 cls_cursor_init(&cursor, &cls, NULL);
2126 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2127 struct fte_version *a = fte->versions[0];
2128 struct fte_version *b = fte->versions[1];
2130 if (!a || !b || !fte_version_equals(a, b)) {
2131 fte_version_format(fte, 0, &a_s);
2132 fte_version_format(fte, 1, &b_s);
2133 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2135 printf("-%s", ds_cstr(&a_s));
2138 printf("+%s", ds_cstr(&b_s));
2155 /* Undocumented commands for unit testing. */
2158 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms)
2160 enum ofputil_protocol usable_protocols;
2161 enum ofputil_protocol protocol = 0;
2165 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
2166 usable_s = ofputil_protocols_to_string(usable_protocols);
2167 printf("usable protocols: %s\n", usable_s);
2170 if (!(usable_protocols & allowed_protocols)) {
2171 ovs_fatal(0, "no usable protocol");
2173 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2175 if (protocol & usable_protocols & allowed_protocols) {
2179 assert(IS_POW2(protocol));
2181 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2183 for (i = 0; i < n_fms; i++) {
2184 struct ofputil_flow_mod *fm = &fms[i];
2187 msg = ofputil_encode_flow_mod(fm, protocol);
2188 ofp_print(stdout, msg->data, msg->size, verbosity);
2195 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2196 * it back to stdout. */
2198 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2200 struct ofputil_flow_mod fm;
2202 parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, false);
2203 ofctl_parse_flows__(&fm, 1);
2206 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2207 * add-flows) and prints each of the flows back to stdout. */
2209 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2211 struct ofputil_flow_mod *fms = NULL;
2214 parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms);
2215 ofctl_parse_flows__(fms, n_fms);
2220 ofctl_parse_nxm__(bool oxm)
2225 while (!ds_get_test_line(&in, stdin)) {
2226 struct ofpbuf nx_match;
2228 ovs_be64 cookie, cookie_mask;
2232 /* Convert string to nx_match. */
2233 ofpbuf_init(&nx_match, 0);
2235 match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2237 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2240 /* Convert nx_match to match. */
2243 error = oxm_pull_match(&nx_match, &match);
2245 error = nx_pull_match(&nx_match, match_len, &match,
2246 &cookie, &cookie_mask);
2250 error = oxm_pull_match_loose(&nx_match, &match);
2252 error = nx_pull_match_loose(&nx_match, match_len, &match,
2253 &cookie, &cookie_mask);
2261 /* Convert match back to nx_match. */
2262 ofpbuf_uninit(&nx_match);
2263 ofpbuf_init(&nx_match, 0);
2265 match_len = oxm_put_match(&nx_match, &match);
2266 out = oxm_match_to_string(nx_match.data, match_len);
2268 match_len = nx_put_match(&nx_match, &match,
2269 cookie, cookie_mask);
2270 out = nx_match_to_string(nx_match.data, match_len);
2276 printf("nx_pull_match() returned error %s\n",
2277 ofperr_get_name(error));
2280 ofpbuf_uninit(&nx_match);
2285 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2286 * stdin, does some internal fussing with them, and then prints them back as
2287 * strings on stdout. */
2289 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2291 return ofctl_parse_nxm__(false);
2294 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2295 * stdin, does some internal fussing with them, and then prints them back as
2296 * strings on stdout. */
2298 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2300 return ofctl_parse_nxm__(true);
2304 print_differences(const char *prefix,
2305 const void *a_, size_t a_len,
2306 const void *b_, size_t b_len)
2308 const uint8_t *a = a_;
2309 const uint8_t *b = b_;
2312 for (i = 0; i < MIN(a_len, b_len); i++) {
2314 printf("%s%2zu: %02"PRIx8" -> %02"PRIx8"\n",
2315 prefix, i, a[i], b[i]);
2318 for (i = a_len; i < b_len; i++) {
2319 printf("%s%2zu: (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2321 for (i = b_len; i < a_len; i++) {
2322 printf("%s%2zu: %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2326 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2327 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2328 * on stdout, and then converts them back to hex bytes and prints any
2329 * differences from the input. */
2331 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2336 while (!ds_get_preprocessed_line(&in, stdin)) {
2337 struct ofpbuf of10_out;
2338 struct ofpbuf of10_in;
2339 struct ofpbuf ofpacts;
2344 /* Parse hex bytes. */
2345 ofpbuf_init(&of10_in, 0);
2346 if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2347 ovs_fatal(0, "Trailing garbage in hex data");
2350 /* Convert to ofpacts. */
2351 ofpbuf_init(&ofpacts, 0);
2352 size = of10_in.size;
2353 error = ofpacts_pull_openflow10(&of10_in, of10_in.size, &ofpacts);
2355 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2356 ofpbuf_uninit(&ofpacts);
2357 ofpbuf_uninit(&of10_in);
2360 ofpbuf_push_uninit(&of10_in, size);
2362 /* Print cls_rule. */
2364 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2368 /* Convert back to ofp10 actions and print differences from input. */
2369 ofpbuf_init(&of10_out, 0);
2370 ofpacts_put_openflow10(ofpacts.data, ofpacts.size, &of10_out);
2372 print_differences("", of10_in.data, of10_in.size,
2373 of10_out.data, of10_out.size);
2376 ofpbuf_uninit(&ofpacts);
2377 ofpbuf_uninit(&of10_in);
2378 ofpbuf_uninit(&of10_out);
2383 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2384 * bytes from stdin, converts them to cls_rules, prints them as strings on
2385 * stdout, and then converts them back to hex bytes and prints any differences
2388 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
2389 * values are ignored in the input and will be set to zero when OVS converts
2390 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
2391 * it does the conversion to hex, to ensure that in fact they are ignored. */
2393 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2400 while (!ds_get_preprocessed_line(&in, stdin)) {
2401 struct ofpbuf match_in, match_expout;
2402 struct ofp10_match match_out;
2403 struct ofp10_match match_normal;
2407 /* Parse hex bytes to use for expected output. */
2409 ds_put_cstr(&expout, ds_cstr(&in));
2410 for (p = ds_cstr(&expout); *p; p++) {
2415 ofpbuf_init(&match_expout, 0);
2416 if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
2417 ovs_fatal(0, "Trailing garbage in hex data");
2419 if (match_expout.size != sizeof(struct ofp10_match)) {
2420 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2421 match_expout.size, sizeof(struct ofp10_match));
2424 /* Parse hex bytes for input. */
2425 for (p = ds_cstr(&in); *p; p++) {
2427 *p = "0123456789abcdef"[random_uint32() & 0xf];
2430 ofpbuf_init(&match_in, 0);
2431 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2432 ovs_fatal(0, "Trailing garbage in hex data");
2434 if (match_in.size != sizeof(struct ofp10_match)) {
2435 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2436 match_in.size, sizeof(struct ofp10_match));
2439 /* Convert to cls_rule and print. */
2440 ofputil_match_from_ofp10_match(match_in.data, &match);
2441 match_print(&match);
2443 /* Convert back to ofp10_match and print differences from input. */
2444 ofputil_match_to_ofp10_match(&match, &match_out);
2445 print_differences("", match_expout.data, match_expout.size,
2446 &match_out, sizeof match_out);
2448 /* Normalize, then convert and compare again. */
2449 ofputil_normalize_match(&match);
2450 ofputil_match_to_ofp10_match(&match, &match_normal);
2451 print_differences("normal: ", &match_out, sizeof match_out,
2452 &match_normal, sizeof match_normal);
2455 ofpbuf_uninit(&match_in);
2456 ofpbuf_uninit(&match_expout);
2459 ds_destroy(&expout);
2462 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2463 * bytes from stdin, converts them to "struct match"es, prints them as strings
2464 * on stdout, and then converts them back to hex bytes and prints any
2465 * differences from the input. */
2467 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2472 while (!ds_get_preprocessed_line(&in, stdin)) {
2473 struct ofpbuf match_in;
2474 struct ofp11_match match_out;
2478 /* Parse hex bytes. */
2479 ofpbuf_init(&match_in, 0);
2480 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2481 ovs_fatal(0, "Trailing garbage in hex data");
2483 if (match_in.size != sizeof(struct ofp11_match)) {
2484 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2485 match_in.size, sizeof(struct ofp11_match));
2488 /* Convert to match. */
2489 error = ofputil_match_from_ofp11_match(match_in.data, &match);
2491 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
2492 ofpbuf_uninit(&match_in);
2497 match_print(&match);
2499 /* Convert back to ofp11_match and print differences from input. */
2500 ofputil_match_to_ofp11_match(&match, &match_out);
2502 print_differences("", match_in.data, match_in.size,
2503 &match_out, sizeof match_out);
2506 ofpbuf_uninit(&match_in);
2511 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2512 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2513 * on stdout, and then converts them back to hex bytes and prints any
2514 * differences from the input. */
2516 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2521 while (!ds_get_preprocessed_line(&in, stdin)) {
2522 struct ofpbuf of11_out;
2523 struct ofpbuf of11_in;
2524 struct ofpbuf ofpacts;
2529 /* Parse hex bytes. */
2530 ofpbuf_init(&of11_in, 0);
2531 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2532 ovs_fatal(0, "Trailing garbage in hex data");
2535 /* Convert to ofpacts. */
2536 ofpbuf_init(&ofpacts, 0);
2537 size = of11_in.size;
2538 error = ofpacts_pull_openflow11_actions(&of11_in, of11_in.size,
2541 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2542 ofpbuf_uninit(&ofpacts);
2543 ofpbuf_uninit(&of11_in);
2546 ofpbuf_push_uninit(&of11_in, size);
2548 /* Print cls_rule. */
2550 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2554 /* Convert back to ofp11 actions and print differences from input. */
2555 ofpbuf_init(&of11_out, 0);
2556 ofpacts_put_openflow11_actions(ofpacts.data, ofpacts.size, &of11_out);
2558 print_differences("", of11_in.data, of11_in.size,
2559 of11_out.data, of11_out.size);
2562 ofpbuf_uninit(&ofpacts);
2563 ofpbuf_uninit(&of11_in);
2564 ofpbuf_uninit(&of11_out);
2569 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
2570 * specifications as hex bytes from stdin, converts them to ofpacts, prints
2571 * them as strings on stdout, and then converts them back to hex bytes and
2572 * prints any differences from the input. */
2574 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2579 while (!ds_get_preprocessed_line(&in, stdin)) {
2580 struct ofpbuf of11_out;
2581 struct ofpbuf of11_in;
2582 struct ofpbuf ofpacts;
2587 /* Parse hex bytes. */
2588 ofpbuf_init(&of11_in, 0);
2589 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2590 ovs_fatal(0, "Trailing garbage in hex data");
2593 /* Convert to ofpacts. */
2594 ofpbuf_init(&ofpacts, 0);
2595 size = of11_in.size;
2596 error = ofpacts_pull_openflow11_instructions(&of11_in, of11_in.size,
2599 printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
2600 ofpbuf_uninit(&ofpacts);
2601 ofpbuf_uninit(&of11_in);
2604 ofpbuf_push_uninit(&of11_in, size);
2606 /* Print cls_rule. */
2608 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2612 /* Convert back to ofp11 instructions and print differences from
2614 ofpbuf_init(&of11_out, 0);
2615 ofpacts_put_openflow11_instructions(ofpacts.data, ofpacts.size,
2618 print_differences("", of11_in.data, of11_in.size,
2619 of11_out.data, of11_out.size);
2622 ofpbuf_uninit(&ofpacts);
2623 ofpbuf_uninit(&of11_in);
2624 ofpbuf_uninit(&of11_out);
2629 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
2630 * mask values to and from various formats and prints the results. */
2632 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
2637 struct ofputil_flow_mod fm;
2640 struct match nxm_match;
2644 struct ofp10_match of10_raw;
2645 struct match of10_match;
2647 struct ofp11_match of11_raw;
2648 struct match of11_match;
2652 match_init_catchall(&match);
2653 match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
2654 match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
2656 /* Convert to and from string. */
2657 string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
2658 printf("%s -> ", string_s);
2660 parse_ofp_str(&fm, -1, string_s, false);
2661 printf("%04"PRIx16"/%04"PRIx16"\n",
2662 ntohs(fm.match.flow.vlan_tci),
2663 ntohs(fm.match.wc.masks.vlan_tci));
2666 /* Convert to and from NXM. */
2667 ofpbuf_init(&nxm, 0);
2668 nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
2669 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
2670 error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
2671 printf("NXM: %s -> ", nxm_s);
2673 printf("%s\n", ofperr_to_string(error));
2675 printf("%04"PRIx16"/%04"PRIx16"\n",
2676 ntohs(nxm_match.flow.vlan_tci),
2677 ntohs(nxm_match.wc.masks.vlan_tci));
2680 ofpbuf_uninit(&nxm);
2682 /* Convert to and from OXM. */
2683 ofpbuf_init(&nxm, 0);
2684 nxm_match_len = oxm_put_match(&nxm, &match);
2685 nxm_s = oxm_match_to_string(nxm.data, nxm_match_len);
2686 error = oxm_pull_match(&nxm, &nxm_match);
2687 printf("OXM: %s -> ", nxm_s);
2689 printf("%s\n", ofperr_to_string(error));
2691 uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
2692 (VLAN_VID_MASK | VLAN_CFI);
2693 uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
2694 (VLAN_VID_MASK | VLAN_CFI);
2696 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
2697 if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
2698 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
2704 ofpbuf_uninit(&nxm);
2706 /* Convert to and from OpenFlow 1.0. */
2707 ofputil_match_to_ofp10_match(&match, &of10_raw);
2708 ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
2709 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2710 ntohs(of10_raw.dl_vlan),
2711 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
2712 of10_raw.dl_vlan_pcp,
2713 (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
2714 ntohs(of10_match.flow.vlan_tci),
2715 ntohs(of10_match.wc.masks.vlan_tci));
2717 /* Convert to and from OpenFlow 1.1. */
2718 ofputil_match_to_ofp11_match(&match, &of11_raw);
2719 ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
2720 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2721 ntohs(of11_raw.dl_vlan),
2722 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
2723 of11_raw.dl_vlan_pcp,
2724 (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
2725 ntohs(of11_match.flow.vlan_tci),
2726 ntohs(of11_match.wc.masks.vlan_tci));
2729 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
2732 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
2737 error = ofperr_from_name(argv[1]);
2739 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2742 for (version = 0; version <= UINT8_MAX; version++) {
2743 const char *name = ofperr_domain_get_name(version);
2747 printf("%s: %d,%d\n",
2748 ofperr_domain_get_name(version),
2749 ofperr_get_type(error, version),
2750 ofperr_get_code(error, version));
2754 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
2755 * error named ENUM and prints the error reply in hex. */
2757 ofctl_encode_error_reply(int argc OVS_UNUSED, char *argv[])
2759 const struct ofp_header *oh;
2760 struct ofpbuf request, *reply;
2763 error = ofperr_from_name(argv[1]);
2765 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2768 ofpbuf_init(&request, 0);
2769 if (ofpbuf_put_hex(&request, argv[2], NULL)[0] != '\0') {
2770 ovs_fatal(0, "Trailing garbage in hex data");
2772 if (request.size < sizeof(struct ofp_header)) {
2773 ovs_fatal(0, "Request too short");
2777 if (request.size != ntohs(oh->length)) {
2778 ovs_fatal(0, "Request size inconsistent");
2781 reply = ofperr_encode_reply(error, request.data);
2782 ofpbuf_uninit(&request);
2784 ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
2785 ofpbuf_delete(reply);
2788 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
2789 * binary data, interpreting them as an OpenFlow message, and prints the
2790 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
2792 ofctl_ofp_print(int argc, char *argv[])
2794 struct ofpbuf packet;
2796 ofpbuf_init(&packet, strlen(argv[1]) / 2);
2797 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
2798 ovs_fatal(0, "trailing garbage following hex bytes");
2800 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
2801 ofpbuf_uninit(&packet);
2804 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
2805 * and dumps each message in hex. */
2807 ofctl_encode_hello(int argc OVS_UNUSED, char *argv[])
2809 uint32_t bitmap = strtol(argv[1], NULL, 0);
2810 struct ofpbuf *hello;
2812 hello = ofputil_encode_hello(bitmap);
2813 ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
2814 ofp_print(stdout, hello->data, hello->size, verbosity);
2815 ofpbuf_delete(hello);
2818 static const struct command all_commands[] = {
2819 { "show", 1, 1, ofctl_show },
2820 { "monitor", 1, 3, ofctl_monitor },
2821 { "snoop", 1, 1, ofctl_snoop },
2822 { "dump-desc", 1, 1, ofctl_dump_desc },
2823 { "dump-tables", 1, 1, ofctl_dump_tables },
2824 { "dump-flows", 1, 2, ofctl_dump_flows },
2825 { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
2826 { "queue-stats", 1, 3, ofctl_queue_stats },
2827 { "add-flow", 2, 2, ofctl_add_flow },
2828 { "add-flows", 2, 2, ofctl_add_flows },
2829 { "mod-flows", 2, 2, ofctl_mod_flows },
2830 { "del-flows", 1, 2, ofctl_del_flows },
2831 { "replace-flows", 2, 2, ofctl_replace_flows },
2832 { "diff-flows", 2, 2, ofctl_diff_flows },
2833 { "packet-out", 4, INT_MAX, ofctl_packet_out },
2834 { "dump-ports", 1, 2, ofctl_dump_ports },
2835 { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc },
2836 { "mod-port", 3, 3, ofctl_mod_port },
2837 { "get-frags", 1, 1, ofctl_get_frags },
2838 { "set-frags", 2, 2, ofctl_set_frags },
2839 { "probe", 1, 1, ofctl_probe },
2840 { "ping", 1, 2, ofctl_ping },
2841 { "benchmark", 3, 3, ofctl_benchmark },
2842 { "help", 0, INT_MAX, ofctl_help },
2844 /* Undocumented commands for testing. */
2845 { "parse-flow", 1, 1, ofctl_parse_flow },
2846 { "parse-flows", 1, 1, ofctl_parse_flows },
2847 { "parse-nx-match", 0, 0, ofctl_parse_nxm },
2848 { "parse-nxm", 0, 0, ofctl_parse_nxm },
2849 { "parse-oxm", 0, 0, ofctl_parse_oxm },
2850 { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
2851 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
2852 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
2853 { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
2854 { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
2855 { "check-vlan", 2, 2, ofctl_check_vlan },
2856 { "print-error", 1, 1, ofctl_print_error },
2857 { "encode-error-reply", 2, 2, ofctl_encode_error_reply },
2858 { "ofp-print", 1, 2, ofctl_ofp_print },
2859 { "encode-hello", 1, 1, ofctl_encode_hello },
2861 { NULL, 0, 0, NULL },