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"
48 #include "ofproto/ofproto.h"
49 #include "openflow/nicira-ext.h"
50 #include "openflow/openflow.h"
52 #include "poll-loop.h"
54 #include "stream-ssl.h"
60 #include "meta-flow.h"
63 VLOG_DEFINE_THIS_MODULE(ofctl);
65 /* --strict: Use strict matching for flow mod commands? Additionally governs
66 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
70 /* --readd: If true, on replace-flows, re-add even flows that have not changed
71 * (to reset flow counters). */
74 /* -F, --flow-format: Allowed protocols. By default, any protocol is
76 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
78 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
79 * commands. Either one of NXPIF_* to force a particular packet_in format, or
80 * -1 to let ovs-ofctl choose the default. */
81 static int preferred_packet_in_format = -1;
83 /* -m, --more: Additional verbosity for ofp-print functions. */
86 /* --timestamp: Print a timestamp before each received packet on "monitor" and
88 static bool timestamp;
90 /* --sort, --rsort: Sort order. */
91 enum sort_order { SORT_ASC, SORT_DESC };
92 struct sort_criterion {
93 const struct mf_field *field; /* NULL means to sort by priority. */
94 enum sort_order order;
96 static struct sort_criterion *criteria;
97 static size_t n_criteria, allocated_criteria;
99 static const struct command all_commands[];
101 static void usage(void) NO_RETURN;
102 static void parse_options(int argc, char *argv[]);
104 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
105 struct ofpbuf **replyp,
106 struct ofputil_flow_stats *,
107 struct ofpbuf *ofpacts);
109 main(int argc, char *argv[])
111 set_program_name(argv[0]);
112 parse_options(argc, argv);
113 signal(SIGPIPE, SIG_IGN);
114 run_command(argc - optind, argv + optind, all_commands);
119 add_sort_criterion(enum sort_order order, const char *field)
121 struct sort_criterion *sc;
123 if (n_criteria >= allocated_criteria) {
124 criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
127 sc = &criteria[n_criteria++];
128 if (!field || !strcasecmp(field, "priority")) {
131 sc->field = mf_from_name(field);
133 ovs_fatal(0, "%s: unknown field name", field);
140 parse_options(int argc, char *argv[])
143 OPT_STRICT = UCHAR_MAX + 1,
151 static struct option long_options[] = {
152 {"timeout", required_argument, NULL, 't'},
153 {"strict", no_argument, NULL, OPT_STRICT},
154 {"readd", no_argument, NULL, OPT_READD},
155 {"flow-format", required_argument, NULL, 'F'},
156 {"packet-in-format", required_argument, NULL, 'P'},
157 {"more", no_argument, NULL, 'm'},
158 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
159 {"sort", optional_argument, NULL, OPT_SORT},
160 {"rsort", optional_argument, NULL, OPT_RSORT},
161 {"help", no_argument, NULL, 'h'},
162 {"version", no_argument, NULL, 'V'},
165 STREAM_SSL_LONG_OPTIONS,
168 char *short_options = long_options_to_short_options(long_options);
171 unsigned long int timeout;
174 c = getopt_long(argc, argv, short_options, long_options, NULL);
181 timeout = strtoul(optarg, NULL, 10);
183 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
191 allowed_protocols = ofputil_protocols_from_string(optarg);
192 if (!allowed_protocols) {
193 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
198 preferred_packet_in_format =
199 ofputil_packet_in_format_from_string(optarg);
200 if (preferred_packet_in_format < 0) {
201 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
213 ovs_print_version(OFP10_VERSION, OFP10_VERSION);
229 add_sort_criterion(SORT_ASC, optarg);
233 add_sort_criterion(SORT_DESC, optarg);
236 DAEMON_OPTION_HANDLERS
238 STREAM_SSL_OPTION_HANDLERS
249 /* Always do a final sort pass based on priority. */
250 add_sort_criterion(SORT_DESC, "priority");
259 printf("%s: OpenFlow switch management utility\n"
260 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
261 "\nFor OpenFlow switches:\n"
262 " show SWITCH show OpenFlow information\n"
263 " dump-desc SWITCH print switch description\n"
264 " dump-tables SWITCH print table stats\n"
265 " mod-port SWITCH IFACE ACT modify port behavior\n"
266 " get-frags SWITCH print fragment handling behavior\n"
267 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
268 " dump-ports SWITCH [PORT] print port statistics\n"
269 " dump-ports-desc SWITCH print port descriptions\n"
270 " dump-flows SWITCH print all flow entries\n"
271 " dump-flows SWITCH FLOW print matching FLOWs\n"
272 " dump-aggregate SWITCH print aggregate flow statistics\n"
273 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
274 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
275 " add-flow SWITCH FLOW add flow described by FLOW\n"
276 " add-flows SWITCH FILE add flows from FILE\n"
277 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
278 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
279 " replace-flows SWITCH FILE replace flows with those in FILE\n"
280 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
281 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
282 " execute ACTIONS on PACKET\n"
283 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
284 " print packets received from SWITCH\n"
285 " snoop SWITCH snoop on SWITCH and its controller\n"
286 "\nFor OpenFlow switches and controllers:\n"
287 " probe TARGET probe whether TARGET is up\n"
288 " ping TARGET [N] latency of N-byte echos\n"
289 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
290 "where SWITCH or TARGET is an active OpenFlow connection method.\n",
291 program_name, program_name);
292 vconn_usage(true, false, false);
295 printf("\nOther options:\n"
296 " --strict use strict match for flow commands\n"
297 " --readd replace flows that haven't changed\n"
298 " -F, --flow-format=FORMAT force particular flow format\n"
299 " -P, --packet-in-format=FRMT force particular packet in format\n"
300 " -m, --more be more verbose printing OpenFlow\n"
301 " --timestamp (monitor, snoop) print timestamps\n"
302 " -t, --timeout=SECS give up after SECS seconds\n"
303 " --sort[=field] sort in ascending order\n"
304 " --rsort[=field] sort in descending order\n"
305 " -h, --help display this help message\n"
306 " -V, --version display version information\n");
311 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
312 const char *argv[] OVS_UNUSED, void *exiting_)
314 bool *exiting = exiting_;
316 unixctl_command_reply(conn, NULL);
319 static void run(int retval, const char *message, ...)
322 static void run(int retval, const char *message, ...)
327 va_start(args, message);
328 ovs_fatal_valist(retval, message, args);
332 /* Generic commands. */
335 open_vconn_socket(const char *name, struct vconn **vconnp)
337 char *vconn_name = xasprintf("unix:%s", name);
338 VLOG_DBG("connecting to %s", vconn_name);
339 run(vconn_open_block(vconn_name, OFP10_VERSION, vconnp),
340 "connecting to %s", vconn_name);
344 static enum ofputil_protocol
345 open_vconn__(const char *name, const char *default_suffix,
346 struct vconn **vconnp)
348 char *datapath_name, *datapath_type, *socket_name;
349 enum ofputil_protocol protocol;
354 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
356 ofproto_parse_name(name, &datapath_name, &datapath_type);
357 socket_name = xasprintf("%s/%s.%s",
358 ovs_rundir(), datapath_name, default_suffix);
362 if (strchr(name, ':')) {
363 run(vconn_open_block(name, OFP10_VERSION, vconnp),
364 "connecting to %s", name);
365 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
366 open_vconn_socket(name, vconnp);
367 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
368 open_vconn_socket(bridge_path, vconnp);
369 } else if (!stat(socket_name, &s)) {
370 if (!S_ISSOCK(s.st_mode)) {
371 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
374 open_vconn_socket(socket_name, vconnp);
376 ovs_fatal(0, "%s is not a bridge or a socket", name);
382 ofp_version = vconn_get_version(*vconnp);
383 protocol = ofputil_protocol_from_ofp_version(ofp_version);
385 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
391 static enum ofputil_protocol
392 open_vconn(const char *name, struct vconn **vconnp)
394 return open_vconn__(name, "mgmt", vconnp);
398 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
400 ofpmsg_update_length(buffer);
401 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
405 dump_transaction(const char *vconn_name, struct ofpbuf *request)
408 struct ofpbuf *reply;
410 ofpmsg_update_length(request);
411 open_vconn(vconn_name, &vconn);
412 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
413 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
414 ofpbuf_delete(reply);
419 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
421 struct ofpbuf *request;
422 request = ofpraw_alloc(raw, OFP10_VERSION, 0);
423 dump_transaction(vconn_name, request);
427 dump_stats_transaction__(struct vconn *vconn, struct ofpbuf *request)
429 const struct ofp_header *request_oh = request->data;
430 ovs_be32 send_xid = request_oh->xid;
431 enum ofpraw request_raw;
432 enum ofpraw reply_raw;
435 ofpraw_decode_partial(&request_raw, request->data, request->size);
436 reply_raw = ofpraw_stats_request_to_reply(request_raw,
437 request_oh->version);
439 send_openflow_buffer(vconn, request);
442 struct ofpbuf *reply;
444 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
445 recv_xid = ((struct ofp_header *) reply->data)->xid;
446 if (send_xid == recv_xid) {
449 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
451 ofpraw_decode(&raw, reply->data);
452 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
454 } else if (raw == reply_raw) {
455 done = !ofpmp_more(reply->data);
457 ovs_fatal(0, "received bad reply: %s",
458 ofp_to_string(reply->data, reply->size,
462 VLOG_DBG("received reply with xid %08"PRIx32" "
463 "!= expected %08"PRIx32, recv_xid, send_xid);
465 ofpbuf_delete(reply);
470 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
474 open_vconn(vconn_name, &vconn);
475 dump_stats_transaction__(vconn, request);
480 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
482 struct ofpbuf *request;
484 request = ofpraw_alloc(raw, OFP10_VERSION, 0);
485 dump_stats_transaction(vconn_name, request);
488 /* Sends 'request', which should be a request that only has a reply if an error
489 * occurs, and waits for it to succeed or fail. If an error does occur, prints
490 * it and exits with an error.
492 * Destroys all of the 'requests'. */
494 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
496 struct ofpbuf *request, *reply;
498 LIST_FOR_EACH (request, list_node, requests) {
499 ofpmsg_update_length(request);
502 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
503 "talking to %s", vconn_get_name(vconn));
505 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
508 ofpbuf_delete(reply);
511 /* Sends 'request', which should be a request that only has a reply if an error
512 * occurs, and waits for it to succeed or fail. If an error does occur, prints
513 * it and exits with an error.
515 * Destroys 'request'. */
517 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
519 struct list requests;
521 list_init(&requests);
522 list_push_back(&requests, &request->list_node);
523 transact_multiple_noreply(vconn, &requests);
527 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
529 struct ofp_switch_config *config;
530 struct ofpbuf *request;
531 struct ofpbuf *reply;
534 request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION, 0);
535 run(vconn_transact(vconn, request, &reply),
536 "talking to %s", vconn_get_name(vconn));
538 if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
539 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
542 config = ofpbuf_pull(reply, sizeof *config);
545 ofpbuf_delete(reply);
549 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
551 struct ofpbuf *request;
553 request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, OFP10_VERSION, 0);
554 ofpbuf_put(request, config, sizeof *config);
556 transact_noreply(vconn, request);
560 ofctl_show(int argc OVS_UNUSED, char *argv[])
562 const char *vconn_name = argv[1];
564 struct ofpbuf *request;
565 struct ofpbuf *reply;
568 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, OFP10_VERSION, 0);
569 open_vconn(vconn_name, &vconn);
570 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
572 trunc = ofputil_switch_features_ports_trunc(reply);
573 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
575 ofpbuf_delete(reply);
579 /* The Features Reply may not contain all the ports, so send a
580 * Port Description stats request, which doesn't have size
582 dump_trivial_stats_transaction(vconn_name,
583 OFPRAW_OFPST_PORT_DESC_REQUEST);
585 dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
589 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
591 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
595 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
597 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
601 fetch_port_by_features(const char *vconn_name,
602 const char *port_name, unsigned int port_no,
603 struct ofputil_phy_port *pp, bool *trunc)
605 struct ofputil_switch_features features;
606 const struct ofp_header *oh;
607 struct ofpbuf *request, *reply;
614 /* Fetch the switch's ofp_switch_features. */
615 request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, OFP10_VERSION, 0);
616 open_vconn(vconn_name, &vconn);
617 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
621 if (ofptype_decode(&type, reply->data)
622 || type != OFPTYPE_FEATURES_REPLY) {
623 ovs_fatal(0, "%s: received bad features reply", vconn_name);
627 if (ofputil_switch_features_ports_trunc(reply)) {
632 error = ofputil_decode_switch_features(oh, &features, &b);
634 ovs_fatal(0, "%s: failed to decode features reply (%s)",
635 vconn_name, ofperr_to_string(error));
638 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
639 if (port_no != UINT_MAX
640 ? port_no == pp->port_no
641 : !strcmp(pp->name, port_name)) {
648 ofpbuf_delete(reply);
653 fetch_port_by_stats(const char *vconn_name,
654 const char *port_name, unsigned int port_no,
655 struct ofputil_phy_port *pp)
657 struct ofpbuf *request;
663 request = ofpraw_alloc(OFPRAW_OFPST_PORT_DESC_REQUEST, OFP10_VERSION, 0);
664 send_xid = ((struct ofp_header *) request->data)->xid;
666 open_vconn(vconn_name, &vconn);
667 send_openflow_buffer(vconn, request);
670 struct ofpbuf *reply;
672 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
673 recv_xid = ((struct ofp_header *) reply->data)->xid;
674 if (send_xid == recv_xid) {
675 struct ofp_header *oh = reply->data;
680 ofpbuf_use_const(&b, oh, ntohs(oh->length));
681 if (ofptype_pull(&type, &b)
682 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
683 ovs_fatal(0, "received bad reply: %s",
684 ofp_to_string(reply->data, reply->size,
688 flags = ofpmp_flags(oh);
689 done = !(flags & OFPSF_REPLY_MORE);
692 /* We've already found the port, but we need to drain
693 * the queue of any other replies for this request. */
697 while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
698 if (port_no != UINT_MAX ? port_no == pp->port_no
699 : !strcmp(pp->name, port_name)) {
705 VLOG_DBG("received reply with xid %08"PRIx32" "
706 "!= expected %08"PRIx32, recv_xid, send_xid);
708 ofpbuf_delete(reply);
716 /* Opens a connection to 'vconn_name', fetches the port structure for
717 * 'port_name' (which may be a port name or number), and copies it into
720 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
721 struct ofputil_phy_port *pp)
723 unsigned int port_no;
727 /* Try to interpret the argument as a port number. */
728 if (!str_to_uint(port_name, 10, &port_no)) {
732 /* Try to find the port based on the Features Reply. If it looks
733 * like the results may be truncated, then use the Port Description
734 * stats message introduced in OVS 1.7. */
735 found = fetch_port_by_features(vconn_name, port_name, port_no, pp,
738 found = fetch_port_by_stats(vconn_name, port_name, port_no, pp);
742 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
746 /* Returns the port number corresponding to 'port_name' (which may be a port
747 * name or number) within the switch 'vconn_name'. */
749 str_to_port_no(const char *vconn_name, const char *port_name)
751 unsigned int port_no;
753 if (str_to_uint(port_name, 10, &port_no)) {
756 struct ofputil_phy_port pp;
758 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
764 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
765 enum ofputil_protocol *cur)
768 struct ofpbuf *request, *reply;
769 enum ofputil_protocol next;
771 request = ofputil_encode_set_protocol(*cur, want, &next);
776 run(vconn_transact_noreply(vconn, request, &reply),
777 "talking to %s", vconn_get_name(vconn));
779 char *s = ofp_to_string(reply->data, reply->size, 2);
780 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
781 vconn_get_name(vconn), s);
783 ofpbuf_delete(reply);
791 static enum ofputil_protocol
792 set_protocol_for_flow_dump(struct vconn *vconn,
793 enum ofputil_protocol cur_protocol,
794 enum ofputil_protocol usable_protocols)
799 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
800 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
801 if (f & usable_protocols & allowed_protocols
802 && try_set_protocol(vconn, f, &cur_protocol)) {
807 usable_s = ofputil_protocols_to_string(usable_protocols);
808 if (usable_protocols & allowed_protocols) {
809 ovs_fatal(0, "switch does not support any of the usable flow "
810 "formats (%s)", usable_s);
812 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
813 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
814 "allowed flow formats (%s)", usable_s, allowed_s);
818 static struct vconn *
819 prepare_dump_flows(int argc, char *argv[], bool aggregate,
820 struct ofpbuf **requestp)
822 enum ofputil_protocol usable_protocols, protocol;
823 struct ofputil_flow_stats_request fsr;
826 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
827 usable_protocols = ofputil_flow_stats_request_usable_protocols(&fsr);
829 protocol = open_vconn(argv[1], &vconn);
830 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
831 *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
836 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
838 struct ofpbuf *request;
841 vconn = prepare_dump_flows(argc, argv, aggregate, &request);
842 dump_stats_transaction__(vconn, request);
847 compare_flows(const void *afs_, const void *bfs_)
849 const struct ofputil_flow_stats *afs = afs_;
850 const struct ofputil_flow_stats *bfs = bfs_;
851 const struct cls_rule *a = &afs->rule;
852 const struct cls_rule *b = &bfs->rule;
853 const struct sort_criterion *sc;
855 for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
856 const struct mf_field *f = sc->field;
860 ret = a->priority < b->priority ? -1 : a->priority > b->priority;
864 ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
865 inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
867 /* Skip the test for sc->order, so that missing fields always
868 * sort to the end whether we're sorting in ascending or
869 * descending order. */
872 union mf_value aval, bval;
874 mf_get_value(f, &a->flow, &aval);
875 mf_get_value(f, &b->flow, &bval);
876 ret = memcmp(&aval, &bval, f->n_bytes);
881 return sc->order == SORT_ASC ? ret : -ret;
889 ofctl_dump_flows(int argc, char *argv[])
892 return ofctl_dump_flows__(argc, argv, false);
894 struct ofputil_flow_stats *fses;
895 size_t n_fses, allocated_fses;
896 struct ofpbuf *request;
897 struct ofpbuf ofpacts;
898 struct ofpbuf *reply;
904 vconn = prepare_dump_flows(argc, argv, false, &request);
905 send_xid = ((struct ofp_header *) request->data)->xid;
906 send_openflow_buffer(vconn, request);
909 n_fses = allocated_fses = 0;
911 ofpbuf_init(&ofpacts, 0);
913 struct ofputil_flow_stats *fs;
915 if (n_fses >= allocated_fses) {
916 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
920 if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
924 fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
927 ofpbuf_uninit(&ofpacts);
929 qsort(fses, n_fses, sizeof *fses, compare_flows);
932 for (i = 0; i < n_fses; i++) {
934 ofp_print_flow_stats(&s, &fses[i]);
939 for (i = 0; i < n_fses; i++) {
940 free(fses[i].ofpacts);
949 ofctl_dump_aggregate(int argc, char *argv[])
951 return ofctl_dump_flows__(argc, argv, true);
955 ofctl_queue_stats(int argc, char *argv[])
957 struct ofp10_queue_stats_request *req;
958 struct ofpbuf *request;
960 request = ofpraw_alloc(OFPRAW_OFPST_QUEUE_REQUEST, OFP10_VERSION, 0);
961 req = ofpbuf_put_zeros(request, sizeof *req);
963 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
964 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
966 req->port_no = htons(OFPP_ALL);
968 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
969 req->queue_id = htonl(atoi(argv[3]));
971 req->queue_id = htonl(OFPQ_ALL);
974 memset(req->pad, 0, sizeof req->pad);
976 dump_stats_transaction(argv[1], request);
979 static enum ofputil_protocol
980 open_vconn_for_flow_mod(const char *remote,
981 const struct ofputil_flow_mod *fms, size_t n_fms,
982 struct vconn **vconnp)
984 enum ofputil_protocol usable_protocols;
985 enum ofputil_protocol cur_protocol;
989 /* Figure out what flow formats will work. */
990 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
991 if (!(usable_protocols & allowed_protocols)) {
992 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
993 usable_s = ofputil_protocols_to_string(usable_protocols);
994 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
995 "allowed flow formats (%s)", usable_s, allowed_s);
998 /* If the initial flow format is allowed and usable, keep it. */
999 cur_protocol = open_vconn(remote, vconnp);
1000 if (usable_protocols & allowed_protocols & cur_protocol) {
1001 return cur_protocol;
1004 /* Otherwise try each flow format in turn. */
1005 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1006 enum ofputil_protocol f = 1 << i;
1008 if (f != cur_protocol
1009 && f & usable_protocols & allowed_protocols
1010 && try_set_protocol(*vconnp, f, &cur_protocol)) {
1015 usable_s = ofputil_protocols_to_string(usable_protocols);
1016 ovs_fatal(0, "switch does not support any of the usable flow "
1017 "formats (%s)", usable_s);
1021 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1024 enum ofputil_protocol protocol;
1025 struct vconn *vconn;
1028 protocol = open_vconn_for_flow_mod(remote, fms, n_fms, &vconn);
1030 for (i = 0; i < n_fms; i++) {
1031 struct ofputil_flow_mod *fm = &fms[i];
1033 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1040 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1042 struct ofputil_flow_mod *fms = NULL;
1045 parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms);
1046 ofctl_flow_mod__(argv[1], fms, n_fms);
1051 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1053 if (argc > 2 && !strcmp(argv[2], "-")) {
1054 ofctl_flow_mod_file(argc, argv, command);
1056 struct ofputil_flow_mod fm;
1057 parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command, false);
1058 ofctl_flow_mod__(argv[1], &fm, 1);
1063 ofctl_add_flow(int argc, char *argv[])
1065 ofctl_flow_mod(argc, argv, OFPFC_ADD);
1069 ofctl_add_flows(int argc, char *argv[])
1071 ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1075 ofctl_mod_flows(int argc, char *argv[])
1077 ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1081 ofctl_del_flows(int argc, char *argv[])
1083 ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1087 set_packet_in_format(struct vconn *vconn,
1088 enum nx_packet_in_format packet_in_format)
1090 struct ofpbuf *spif = ofputil_make_set_packet_in_format(packet_in_format);
1091 transact_noreply(vconn, spif);
1092 VLOG_DBG("%s: using user-specified packet in format %s",
1093 vconn_get_name(vconn),
1094 ofputil_packet_in_format_to_string(packet_in_format));
1098 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1100 struct ofp_switch_config config;
1101 enum ofp_config_flags flags;
1103 fetch_switch_config(vconn, &config);
1104 flags = ntohs(config.flags);
1105 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1106 /* Set the invalid ttl config. */
1107 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1109 config.flags = htons(flags);
1110 set_switch_config(vconn, &config);
1112 /* Then retrieve the configuration to see if it really took. OpenFlow
1113 * doesn't define error reporting for bad modes, so this is all we can
1115 fetch_switch_config(vconn, &config);
1116 flags = ntohs(config.flags);
1117 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1118 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1119 "switch probably doesn't support mode)");
1126 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1127 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1128 * an error message and stores NULL in '*msgp'. */
1130 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1132 struct ofp_header *oh;
1135 msg = ofpbuf_new(strlen(hex) / 2);
1138 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1140 return "Trailing garbage in hex data";
1143 if (msg->size < sizeof(struct ofp_header)) {
1145 return "Message too short for OpenFlow";
1149 if (msg->size != ntohs(oh->length)) {
1151 return "Message size does not match length in OpenFlow header";
1159 ofctl_send(struct unixctl_conn *conn, int argc,
1160 const char *argv[], void *vconn_)
1162 struct vconn *vconn = vconn_;
1169 for (i = 1; i < argc; i++) {
1170 const char *error_msg;
1174 error_msg = openflow_from_hex(argv[i], &msg);
1176 ds_put_format(&reply, "%s\n", error_msg);
1181 fprintf(stderr, "send: ");
1182 ofp_print(stderr, msg->data, msg->size, verbosity);
1184 error = vconn_send_block(vconn, msg);
1187 ds_put_format(&reply, "%s\n", strerror(error));
1190 ds_put_cstr(&reply, "sent\n");
1195 unixctl_command_reply(conn, ds_cstr(&reply));
1197 unixctl_command_reply_error(conn, ds_cstr(&reply));
1202 struct barrier_aux {
1203 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
1204 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
1208 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1209 const char *argv[] OVS_UNUSED, void *aux_)
1211 struct barrier_aux *aux = aux_;
1216 unixctl_command_reply_error(conn, "already waiting for barrier reply");
1220 msg = ofputil_encode_barrier_request();
1221 error = vconn_send_block(aux->vconn, msg);
1224 unixctl_command_reply_error(conn, strerror(error));
1231 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1232 const char *argv[], void *aux OVS_UNUSED)
1236 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1238 unixctl_command_reply_error(conn, strerror(errno));
1243 dup2(fd, STDERR_FILENO);
1245 unixctl_command_reply(conn, NULL);
1249 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1250 const char *argv[] OVS_UNUSED, void *blocked_)
1252 bool *blocked = blocked_;
1256 unixctl_command_reply(conn, NULL);
1258 unixctl_command_reply(conn, "already blocking");
1263 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1264 const char *argv[] OVS_UNUSED, void *blocked_)
1266 bool *blocked = blocked_;
1270 unixctl_command_reply(conn, NULL);
1272 unixctl_command_reply(conn, "already unblocked");
1277 monitor_vconn(struct vconn *vconn)
1279 struct barrier_aux barrier_aux = { vconn, NULL };
1280 struct unixctl_server *server;
1281 bool exiting = false;
1282 bool blocked = false;
1285 daemon_save_fd(STDERR_FILENO);
1287 error = unixctl_server_create(NULL, &server);
1289 ovs_fatal(error, "failed to create unixctl server");
1291 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1292 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1294 unixctl_command_register("ofctl/barrier", "", 0, 0,
1295 ofctl_barrier, &barrier_aux);
1296 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1297 ofctl_set_output_file, NULL);
1299 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1300 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1303 daemonize_complete();
1309 unixctl_server_run(server);
1314 retval = vconn_recv(vconn, &b);
1315 if (retval == EAGAIN) {
1318 run(retval, "vconn_recv");
1321 time_t now = time_wall();
1324 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S: ", gmtime(&now));
1328 ofptype_decode(&type, b->data);
1329 ofp_print(stderr, b->data, b->size, verbosity + 2);
1332 if (barrier_aux.conn && type == OFPTYPE_BARRIER_REPLY) {
1333 unixctl_command_reply(barrier_aux.conn, NULL);
1334 barrier_aux.conn = NULL;
1343 vconn_run_wait(vconn);
1345 vconn_recv_wait(vconn);
1347 unixctl_server_wait(server);
1351 unixctl_server_destroy(server);
1355 ofctl_monitor(int argc, char *argv[])
1357 struct vconn *vconn;
1360 open_vconn(argv[1], &vconn);
1361 for (i = 2; i < argc; i++) {
1362 const char *arg = argv[i];
1364 if (isdigit((unsigned char) *arg)) {
1365 struct ofp_switch_config config;
1367 fetch_switch_config(vconn, &config);
1368 config.miss_send_len = htons(atoi(arg));
1369 set_switch_config(vconn, &config);
1370 } else if (!strcmp(arg, "invalid_ttl")) {
1371 monitor_set_invalid_ttl_to_controller(vconn);
1372 } else if (!strncmp(arg, "watch:", 6)) {
1373 struct ofputil_flow_monitor_request fmr;
1376 parse_flow_monitor_request(&fmr, arg + 6);
1378 msg = ofpbuf_new(0);
1379 ofputil_append_flow_monitor_request(&fmr, msg);
1380 dump_stats_transaction__(vconn, msg);
1382 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1386 if (preferred_packet_in_format >= 0) {
1387 set_packet_in_format(vconn, preferred_packet_in_format);
1389 struct ofpbuf *spif, *reply;
1391 spif = ofputil_make_set_packet_in_format(NXPIF_NXM);
1392 run(vconn_transact_noreply(vconn, spif, &reply),
1393 "talking to %s", vconn_get_name(vconn));
1395 char *s = ofp_to_string(reply->data, reply->size, 2);
1396 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1397 " replied: %s. Falling back to the switch default.",
1398 vconn_get_name(vconn), s);
1400 ofpbuf_delete(reply);
1404 monitor_vconn(vconn);
1408 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1410 struct vconn *vconn;
1412 open_vconn__(argv[1], "snoop", &vconn);
1413 monitor_vconn(vconn);
1417 ofctl_dump_ports(int argc, char *argv[])
1419 struct ofp10_port_stats_request *req;
1420 struct ofpbuf *request;
1423 request = ofpraw_alloc(OFPRAW_OFPST_PORT_REQUEST, OFP10_VERSION, 0);
1424 req = ofpbuf_put_zeros(request, sizeof *req);
1425 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
1426 req->port_no = htons(port);
1427 dump_stats_transaction(argv[1], request);
1431 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1433 dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_PORT_DESC_REQUEST);
1437 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1439 struct ofpbuf *request;
1440 struct vconn *vconn;
1441 struct ofpbuf *reply;
1443 request = make_echo_request();
1444 open_vconn(argv[1], &vconn);
1445 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1446 if (reply->size != sizeof(struct ofp_header)) {
1447 ovs_fatal(0, "reply does not match request");
1449 ofpbuf_delete(reply);
1454 ofctl_packet_out(int argc, char *argv[])
1456 struct ofputil_packet_out po;
1457 struct ofpbuf ofpacts;
1458 struct vconn *vconn;
1461 ofpbuf_init(&ofpacts, 64);
1462 parse_ofpacts(argv[3], &ofpacts);
1464 po.buffer_id = UINT32_MAX;
1465 po.in_port = (!strcasecmp(argv[2], "none") ? OFPP_NONE
1466 : !strcasecmp(argv[2], "local") ? OFPP_LOCAL
1467 : str_to_port_no(argv[1], argv[2]));
1468 po.ofpacts = ofpacts.data;
1469 po.ofpacts_len = ofpacts.size;
1471 open_vconn(argv[1], &vconn);
1472 for (i = 4; i < argc; i++) {
1473 struct ofpbuf *packet, *opo;
1474 const char *error_msg;
1476 error_msg = eth_from_hex(argv[i], &packet);
1478 ovs_fatal(0, "%s", error_msg);
1481 po.packet = packet->data;
1482 po.packet_len = packet->size;
1483 opo = ofputil_encode_packet_out(&po);
1484 transact_noreply(vconn, opo);
1485 ofpbuf_delete(packet);
1488 ofpbuf_uninit(&ofpacts);
1492 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1494 struct ofp_config_flag {
1495 const char *name; /* The flag's name. */
1496 enum ofputil_port_config bit; /* Bit to turn on or off. */
1497 bool on; /* Value to set the bit to. */
1499 static const struct ofp_config_flag flags[] = {
1500 { "up", OFPUTIL_PC_PORT_DOWN, false },
1501 { "down", OFPUTIL_PC_PORT_DOWN, true },
1502 { "stp", OFPUTIL_PC_NO_STP, false },
1503 { "receive", OFPUTIL_PC_NO_RECV, false },
1504 { "receive-stp", OFPUTIL_PC_NO_RECV_STP, false },
1505 { "flood", OFPUTIL_PC_NO_FLOOD, false },
1506 { "forward", OFPUTIL_PC_NO_FWD, false },
1507 { "packet-in", OFPUTIL_PC_NO_PACKET_IN, false },
1510 const struct ofp_config_flag *flag;
1511 enum ofputil_protocol protocol;
1512 struct ofputil_port_mod pm;
1513 struct ofputil_phy_port pp;
1514 struct vconn *vconn;
1515 const char *command;
1518 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1520 pm.port_no = pp.port_no;
1521 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1526 if (!strncasecmp(argv[3], "no-", 3)) {
1527 command = argv[3] + 3;
1529 } else if (!strncasecmp(argv[3], "no", 2)) {
1530 command = argv[3] + 2;
1536 for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1537 if (!strcasecmp(command, flag->name)) {
1538 pm.mask = flag->bit;
1539 pm.config = flag->on ^ not ? flag->bit : 0;
1543 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1546 protocol = open_vconn(argv[1], &vconn);
1547 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1552 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1554 struct ofp_switch_config config;
1555 struct vconn *vconn;
1557 open_vconn(argv[1], &vconn);
1558 fetch_switch_config(vconn, &config);
1559 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1564 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1566 struct ofp_switch_config config;
1567 enum ofp_config_flags mode;
1568 struct vconn *vconn;
1571 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1572 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1575 open_vconn(argv[1], &vconn);
1576 fetch_switch_config(vconn, &config);
1577 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1578 if (flags != config.flags) {
1579 /* Set the configuration. */
1580 config.flags = flags;
1581 set_switch_config(vconn, &config);
1583 /* Then retrieve the configuration to see if it really took. OpenFlow
1584 * doesn't define error reporting for bad modes, so this is all we can
1586 fetch_switch_config(vconn, &config);
1587 if (flags != config.flags) {
1588 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1589 "switch probably doesn't support mode \"%s\")",
1590 argv[1], ofputil_frag_handling_to_string(mode));
1597 ofctl_ping(int argc, char *argv[])
1599 size_t max_payload = 65535 - sizeof(struct ofp_header);
1600 unsigned int payload;
1601 struct vconn *vconn;
1604 payload = argc > 2 ? atoi(argv[2]) : 64;
1605 if (payload > max_payload) {
1606 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1609 open_vconn(argv[1], &vconn);
1610 for (i = 0; i < 10; i++) {
1611 struct timeval start, end;
1612 struct ofpbuf *request, *reply;
1613 const struct ofp_header *rpy_hdr;
1616 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
1618 random_bytes(ofpbuf_put_uninit(request, payload), payload);
1620 xgettimeofday(&start);
1621 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1622 xgettimeofday(&end);
1624 rpy_hdr = reply->data;
1625 if (ofptype_pull(&type, reply)
1626 || type != OFPTYPE_ECHO_REPLY
1627 || reply->size != payload
1628 || memcmp(request->l3, reply->l3, payload)) {
1629 printf("Reply does not match request. Request:\n");
1630 ofp_print(stdout, request, request->size, verbosity + 2);
1632 ofp_print(stdout, reply, reply->size, verbosity + 2);
1634 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1635 reply->size, argv[1], ntohl(rpy_hdr->xid),
1636 (1000*(double)(end.tv_sec - start.tv_sec))
1637 + (.001*(end.tv_usec - start.tv_usec)));
1638 ofpbuf_delete(request);
1639 ofpbuf_delete(reply);
1645 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
1647 size_t max_payload = 65535 - sizeof(struct ofp_header);
1648 struct timeval start, end;
1649 unsigned int payload_size, message_size;
1650 struct vconn *vconn;
1655 payload_size = atoi(argv[2]);
1656 if (payload_size > max_payload) {
1657 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1659 message_size = sizeof(struct ofp_header) + payload_size;
1661 count = atoi(argv[3]);
1663 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1664 count, message_size, count * message_size);
1666 open_vconn(argv[1], &vconn);
1667 xgettimeofday(&start);
1668 for (i = 0; i < count; i++) {
1669 struct ofpbuf *request, *reply;
1671 request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
1673 ofpbuf_put_zeros(request, payload_size);
1674 run(vconn_transact(vconn, request, &reply), "transact");
1675 ofpbuf_delete(reply);
1677 xgettimeofday(&end);
1680 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1681 + (.001*(end.tv_usec - start.tv_usec)));
1682 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1683 duration, count / (duration / 1000.0),
1684 count * message_size / (duration / 1000.0));
1688 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1693 /* replace-flows and diff-flows commands. */
1695 /* A flow table entry, possibly with two different versions. */
1697 struct cls_rule rule; /* Within a "struct classifier". */
1698 struct fte_version *versions[2];
1701 /* One version of a Flow Table Entry. */
1702 struct fte_version {
1704 uint16_t idle_timeout;
1705 uint16_t hard_timeout;
1707 struct ofpact *ofpacts;
1711 /* Frees 'version' and the data that it owns. */
1713 fte_version_free(struct fte_version *version)
1716 free(version->ofpacts);
1721 /* Returns true if 'a' and 'b' are the same, false if they differ.
1723 * Ignores differences in 'flags' because there's no way to retrieve flags from
1724 * an OpenFlow switch. We have to assume that they are the same. */
1726 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1728 return (a->cookie == b->cookie
1729 && a->idle_timeout == b->idle_timeout
1730 && a->hard_timeout == b->hard_timeout
1731 && ofpacts_equal(a->ofpacts, a->ofpacts_len,
1732 b->ofpacts, b->ofpacts_len));
1735 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
1736 * 'index' into 's', followed by a new-line. */
1738 fte_version_format(const struct fte *fte, int index, struct ds *s)
1740 const struct fte_version *version = fte->versions[index];
1747 cls_rule_format(&fte->rule, s);
1748 if (version->cookie != htonll(0)) {
1749 ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
1751 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1752 ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
1754 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1755 ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
1758 ds_put_char(s, ' ');
1759 ofpacts_format(version->ofpacts, version->ofpacts_len, s);
1761 ds_put_char(s, '\n');
1765 fte_from_cls_rule(const struct cls_rule *cls_rule)
1767 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1770 /* Frees 'fte' and its versions. */
1772 fte_free(struct fte *fte)
1775 fte_version_free(fte->versions[0]);
1776 fte_version_free(fte->versions[1]);
1781 /* Frees all of the FTEs within 'cls'. */
1783 fte_free_all(struct classifier *cls)
1785 struct cls_cursor cursor;
1786 struct fte *fte, *next;
1788 cls_cursor_init(&cursor, cls, NULL);
1789 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1790 classifier_remove(cls, &fte->rule);
1793 classifier_destroy(cls);
1796 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1797 * necessary. Sets 'version' as the version of that rule with the given
1798 * 'index', replacing any existing version, if any.
1800 * Takes ownership of 'version'. */
1802 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1803 struct fte_version *version, int index)
1805 struct fte *old, *fte;
1807 fte = xzalloc(sizeof *fte);
1809 fte->versions[index] = version;
1811 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1813 fte_version_free(old->versions[index]);
1814 fte->versions[!index] = old->versions[!index];
1819 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1820 * with the specified 'index'. Returns the flow formats able to represent the
1821 * flows that were read. */
1822 static enum ofputil_protocol
1823 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1825 enum ofputil_protocol usable_protocols;
1829 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1831 ovs_fatal(errno, "%s: open", filename);
1835 usable_protocols = OFPUTIL_P_ANY;
1836 while (!ds_get_preprocessed_line(&s, file)) {
1837 struct fte_version *version;
1838 struct ofputil_flow_mod fm;
1840 parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1842 version = xmalloc(sizeof *version);
1843 version->cookie = fm.new_cookie;
1844 version->idle_timeout = fm.idle_timeout;
1845 version->hard_timeout = fm.hard_timeout;
1846 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF10_EMERG);
1847 version->ofpacts = fm.ofpacts;
1848 version->ofpacts_len = fm.ofpacts_len;
1850 usable_protocols &= ofputil_usable_protocols(&fm.cr);
1852 fte_insert(cls, &fm.cr, version, index);
1856 if (file != stdin) {
1860 return usable_protocols;
1864 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
1865 struct ofpbuf **replyp,
1866 struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
1868 struct ofpbuf *reply = *replyp;
1874 /* Get a flow stats reply message, if we don't already have one. */
1880 run(vconn_recv_block(vconn, &reply),
1881 "OpenFlow packet receive failed");
1882 } while (((struct ofp_header *) reply->data)->xid != send_xid);
1884 error = ofptype_decode(&type, reply->data);
1885 if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
1886 ovs_fatal(0, "received bad reply: %s",
1887 ofp_to_string(reply->data, reply->size,
1892 /* Pull an individual flow stats reply out of the message. */
1893 retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
1900 more = ofpmp_more(reply->l2);
1901 ofpbuf_delete(reply);
1910 ovs_fatal(0, "parse error in reply (%s)",
1911 ofperr_to_string(retval));
1916 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1917 * format 'protocol', and adds them as flow table entries in 'cls' for the
1918 * version with the specified 'index'. */
1920 read_flows_from_switch(struct vconn *vconn,
1921 enum ofputil_protocol protocol,
1922 struct classifier *cls, int index)
1924 struct ofputil_flow_stats_request fsr;
1925 struct ofputil_flow_stats fs;
1926 struct ofpbuf *request;
1927 struct ofpbuf ofpacts;
1928 struct ofpbuf *reply;
1931 fsr.aggregate = false;
1932 cls_rule_init_catchall(&fsr.match, 0);
1933 fsr.out_port = OFPP_NONE;
1934 fsr.table_id = 0xff;
1935 fsr.cookie = fsr.cookie_mask = htonll(0);
1936 request = ofputil_encode_flow_stats_request(&fsr, protocol);
1937 send_xid = ((struct ofp_header *) request->data)->xid;
1938 send_openflow_buffer(vconn, request);
1941 ofpbuf_init(&ofpacts, 0);
1942 while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
1943 struct fte_version *version;
1945 version = xmalloc(sizeof *version);
1946 version->cookie = fs.cookie;
1947 version->idle_timeout = fs.idle_timeout;
1948 version->hard_timeout = fs.hard_timeout;
1950 version->ofpacts_len = fs.ofpacts_len;
1951 version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
1953 fte_insert(cls, &fs.rule, version, index);
1955 ofpbuf_uninit(&ofpacts);
1959 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1960 enum ofputil_protocol protocol, struct list *packets)
1962 const struct fte_version *version = fte->versions[index];
1963 struct ofputil_flow_mod fm;
1967 fm.cookie = htonll(0);
1968 fm.cookie_mask = htonll(0);
1969 fm.new_cookie = version->cookie;
1971 fm.command = command;
1972 fm.idle_timeout = version->idle_timeout;
1973 fm.hard_timeout = version->hard_timeout;
1974 fm.buffer_id = UINT32_MAX;
1975 fm.out_port = OFPP_NONE;
1976 fm.flags = version->flags;
1977 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1978 command == OFPFC_MODIFY_STRICT) {
1979 fm.ofpacts = version->ofpacts;
1980 fm.ofpacts_len = version->ofpacts_len;
1986 ofm = ofputil_encode_flow_mod(&fm, protocol);
1987 list_push_back(packets, &ofm->list_node);
1991 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
1993 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1994 enum ofputil_protocol usable_protocols, protocol;
1995 struct cls_cursor cursor;
1996 struct classifier cls;
1997 struct list requests;
1998 struct vconn *vconn;
2001 classifier_init(&cls);
2002 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2004 protocol = open_vconn(argv[1], &vconn);
2005 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2007 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2009 list_init(&requests);
2011 /* Delete flows that exist on the switch but not in the file. */
2012 cls_cursor_init(&cursor, &cls, NULL);
2013 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2014 struct fte_version *file_ver = fte->versions[FILE_IDX];
2015 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2017 if (sw_ver && !file_ver) {
2018 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2019 protocol, &requests);
2023 /* Add flows that exist in the file but not on the switch.
2024 * Update flows that exist in both places but differ. */
2025 cls_cursor_init(&cursor, &cls, NULL);
2026 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2027 struct fte_version *file_ver = fte->versions[FILE_IDX];
2028 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2031 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2032 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2035 transact_multiple_noreply(vconn, &requests);
2042 read_flows_from_source(const char *source, struct classifier *cls, int index)
2046 if (source[0] == '/' || source[0] == '.'
2047 || (!strchr(source, ':') && !stat(source, &s))) {
2048 read_flows_from_file(source, cls, index);
2050 enum ofputil_protocol protocol;
2051 struct vconn *vconn;
2053 protocol = open_vconn(source, &vconn);
2054 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2055 read_flows_from_switch(vconn, protocol, cls, index);
2061 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2063 bool differences = false;
2064 struct cls_cursor cursor;
2065 struct classifier cls;
2069 classifier_init(&cls);
2070 read_flows_from_source(argv[1], &cls, 0);
2071 read_flows_from_source(argv[2], &cls, 1);
2076 cls_cursor_init(&cursor, &cls, NULL);
2077 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2078 struct fte_version *a = fte->versions[0];
2079 struct fte_version *b = fte->versions[1];
2081 if (!a || !b || !fte_version_equals(a, b)) {
2082 fte_version_format(fte, 0, &a_s);
2083 fte_version_format(fte, 1, &b_s);
2084 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2086 printf("-%s", ds_cstr(&a_s));
2089 printf("+%s", ds_cstr(&b_s));
2106 /* Undocumented commands for unit testing. */
2109 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms)
2111 enum ofputil_protocol usable_protocols;
2112 enum ofputil_protocol protocol = 0;
2116 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
2117 usable_s = ofputil_protocols_to_string(usable_protocols);
2118 printf("usable protocols: %s\n", usable_s);
2121 if (!(usable_protocols & allowed_protocols)) {
2122 ovs_fatal(0, "no usable protocol");
2124 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2126 if (protocol & usable_protocols & allowed_protocols) {
2130 assert(IS_POW2(protocol));
2132 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2134 for (i = 0; i < n_fms; i++) {
2135 struct ofputil_flow_mod *fm = &fms[i];
2138 msg = ofputil_encode_flow_mod(fm, protocol);
2139 ofp_print(stdout, msg->data, msg->size, verbosity);
2146 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2147 * it back to stdout. */
2149 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2151 struct ofputil_flow_mod fm;
2153 parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, false);
2154 ofctl_parse_flows__(&fm, 1);
2157 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2158 * add-flows) and prints each of the flows back to stdout. */
2160 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2162 struct ofputil_flow_mod *fms = NULL;
2165 parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms);
2166 ofctl_parse_flows__(fms, n_fms);
2171 ofctl_parse_nxm__(bool oxm)
2176 while (!ds_get_test_line(&in, stdin)) {
2177 struct ofpbuf nx_match;
2178 struct cls_rule rule;
2179 ovs_be64 cookie, cookie_mask;
2183 /* Convert string to nx_match. */
2184 ofpbuf_init(&nx_match, 0);
2185 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2187 /* Convert nx_match to cls_rule. */
2189 error = nx_pull_match(&nx_match, match_len, 0, &rule,
2190 &cookie, &cookie_mask);
2192 error = nx_pull_match_loose(&nx_match, match_len, 0, &rule,
2193 &cookie, &cookie_mask);
2199 /* Convert cls_rule back to nx_match. */
2200 ofpbuf_uninit(&nx_match);
2201 ofpbuf_init(&nx_match, 0);
2202 match_len = nx_put_match(&nx_match, oxm, &rule,
2203 cookie, cookie_mask);
2205 /* Convert nx_match to string. */
2206 out = nx_match_to_string(nx_match.data, match_len);
2210 printf("nx_pull_match() returned error %s\n",
2211 ofperr_get_name(error));
2214 ofpbuf_uninit(&nx_match);
2219 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2220 * stdin, does some internal fussing with them, and then prints them back as
2221 * strings on stdout. */
2223 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2225 return ofctl_parse_nxm__(false);
2228 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2229 * stdin, does some internal fussing with them, and then prints them back as
2230 * strings on stdout. */
2232 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2234 return ofctl_parse_nxm__(true);
2238 print_differences(const char *prefix,
2239 const void *a_, size_t a_len,
2240 const void *b_, size_t b_len)
2242 const uint8_t *a = a_;
2243 const uint8_t *b = b_;
2246 for (i = 0; i < MIN(a_len, b_len); i++) {
2248 printf("%s%2zu: %02"PRIx8" -> %02"PRIx8"\n",
2249 prefix, i, a[i], b[i]);
2252 for (i = a_len; i < b_len; i++) {
2253 printf("%s%2zu: (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2255 for (i = b_len; i < a_len; i++) {
2256 printf("%s%2zu: %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2260 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2261 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2262 * on stdout, and then converts them back to hex bytes and prints any
2263 * differences from the input. */
2265 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2270 while (!ds_get_preprocessed_line(&in, stdin)) {
2271 struct ofpbuf of10_out;
2272 struct ofpbuf of10_in;
2273 struct ofpbuf ofpacts;
2278 /* Parse hex bytes. */
2279 ofpbuf_init(&of10_in, 0);
2280 if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2281 ovs_fatal(0, "Trailing garbage in hex data");
2284 /* Convert to ofpacts. */
2285 ofpbuf_init(&ofpacts, 0);
2286 size = of10_in.size;
2287 error = ofpacts_pull_openflow10(&of10_in, of10_in.size, &ofpacts);
2289 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2290 ofpbuf_uninit(&ofpacts);
2291 ofpbuf_uninit(&of10_in);
2294 ofpbuf_push_uninit(&of10_in, size);
2296 /* Print cls_rule. */
2298 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2302 /* Convert back to ofp10 actions and print differences from input. */
2303 ofpbuf_init(&of10_out, 0);
2304 ofpacts_put_openflow10(ofpacts.data, ofpacts.size, &of10_out);
2306 print_differences("", of10_in.data, of10_in.size,
2307 of10_out.data, of10_out.size);
2310 ofpbuf_uninit(&ofpacts);
2311 ofpbuf_uninit(&of10_in);
2312 ofpbuf_uninit(&of10_out);
2317 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2318 * bytes from stdin, converts them to cls_rules, prints them as strings on
2319 * stdout, and then converts them back to hex bytes and prints any differences
2320 * from the input. */
2322 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2327 while (!ds_get_preprocessed_line(&in, stdin)) {
2328 struct ofpbuf match_in;
2329 struct ofp10_match match_out;
2330 struct ofp10_match match_normal;
2331 struct cls_rule rule;
2333 /* Parse hex bytes. */
2334 ofpbuf_init(&match_in, 0);
2335 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2336 ovs_fatal(0, "Trailing garbage in hex data");
2338 if (match_in.size != sizeof(struct ofp10_match)) {
2339 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2340 match_in.size, sizeof(struct ofp10_match));
2343 /* Convert to cls_rule and print. */
2344 ofputil_cls_rule_from_ofp10_match(match_in.data, OFP_DEFAULT_PRIORITY,
2346 cls_rule_print(&rule);
2348 /* Convert back to ofp10_match and print differences from input. */
2349 ofputil_cls_rule_to_ofp10_match(&rule, &match_out);
2350 print_differences("", match_in.data, match_in.size,
2351 &match_out, sizeof match_out);
2353 /* Normalize, then convert and compare again. */
2354 ofputil_normalize_rule(&rule);
2355 ofputil_cls_rule_to_ofp10_match(&rule, &match_normal);
2356 print_differences("normal: ", &match_out, sizeof match_out,
2357 &match_normal, sizeof match_normal);
2360 ofpbuf_uninit(&match_in);
2365 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2366 * bytes from stdin, converts them to cls_rules, prints them as strings on
2367 * stdout, and then converts them back to hex bytes and prints any differences
2368 * from the input. */
2370 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2375 while (!ds_get_preprocessed_line(&in, stdin)) {
2376 struct ofpbuf match_in;
2377 struct ofp11_match match_out;
2378 struct cls_rule rule;
2381 /* Parse hex bytes. */
2382 ofpbuf_init(&match_in, 0);
2383 if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2384 ovs_fatal(0, "Trailing garbage in hex data");
2386 if (match_in.size != sizeof(struct ofp11_match)) {
2387 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2388 match_in.size, sizeof(struct ofp11_match));
2391 /* Convert to cls_rule. */
2392 error = ofputil_cls_rule_from_ofp11_match(match_in.data,
2393 OFP_DEFAULT_PRIORITY, &rule);
2395 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
2396 ofpbuf_uninit(&match_in);
2400 /* Print cls_rule. */
2401 cls_rule_print(&rule);
2403 /* Convert back to ofp11_match and print differences from input. */
2404 ofputil_cls_rule_to_ofp11_match(&rule, &match_out);
2406 print_differences("", match_in.data, match_in.size,
2407 &match_out, sizeof match_out);
2410 ofpbuf_uninit(&match_in);
2415 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2416 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2417 * on stdout, and then converts them back to hex bytes and prints any
2418 * differences from the input. */
2420 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2425 while (!ds_get_preprocessed_line(&in, stdin)) {
2426 struct ofpbuf of11_out;
2427 struct ofpbuf of11_in;
2428 struct ofpbuf ofpacts;
2433 /* Parse hex bytes. */
2434 ofpbuf_init(&of11_in, 0);
2435 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2436 ovs_fatal(0, "Trailing garbage in hex data");
2439 /* Convert to ofpacts. */
2440 ofpbuf_init(&ofpacts, 0);
2441 size = of11_in.size;
2442 error = ofpacts_pull_openflow11_actions(&of11_in, of11_in.size,
2445 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2446 ofpbuf_uninit(&ofpacts);
2447 ofpbuf_uninit(&of11_in);
2450 ofpbuf_push_uninit(&of11_in, size);
2452 /* Print cls_rule. */
2454 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2458 /* Convert back to ofp11 actions and print differences from input. */
2459 ofpbuf_init(&of11_out, 0);
2460 ofpacts_put_openflow11_actions(ofpacts.data, ofpacts.size, &of11_out);
2462 print_differences("", of11_in.data, of11_in.size,
2463 of11_out.data, of11_out.size);
2466 ofpbuf_uninit(&ofpacts);
2467 ofpbuf_uninit(&of11_in);
2468 ofpbuf_uninit(&of11_out);
2473 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
2474 * specifications as hex bytes from stdin, converts them to ofpacts, prints
2475 * them as strings on stdout, and then converts them back to hex bytes and
2476 * prints any differences from the input. */
2478 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2483 while (!ds_get_preprocessed_line(&in, stdin)) {
2484 struct ofpbuf of11_out;
2485 struct ofpbuf of11_in;
2486 struct ofpbuf ofpacts;
2491 /* Parse hex bytes. */
2492 ofpbuf_init(&of11_in, 0);
2493 if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2494 ovs_fatal(0, "Trailing garbage in hex data");
2497 /* Convert to ofpacts. */
2498 ofpbuf_init(&ofpacts, 0);
2499 size = of11_in.size;
2500 error = ofpacts_pull_openflow11_instructions(&of11_in, of11_in.size,
2503 printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
2504 ofpbuf_uninit(&ofpacts);
2505 ofpbuf_uninit(&of11_in);
2508 ofpbuf_push_uninit(&of11_in, size);
2510 /* Print cls_rule. */
2512 ofpacts_format(ofpacts.data, ofpacts.size, &s);
2516 /* Convert back to ofp11 instructions and print differences from
2518 ofpbuf_init(&of11_out, 0);
2519 ofpacts_put_openflow11_instructions(ofpacts.data, ofpacts.size,
2522 print_differences("", of11_in.data, of11_in.size,
2523 of11_out.data, of11_out.size);
2526 ofpbuf_uninit(&ofpacts);
2527 ofpbuf_uninit(&of11_in);
2528 ofpbuf_uninit(&of11_out);
2533 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
2534 * mask values to and from various formats and prints the results. */
2536 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
2538 struct cls_rule rule;
2541 struct ofputil_flow_mod fm;
2544 struct cls_rule nxm_rule;
2548 struct ofp10_match of10_match;
2549 struct cls_rule of10_rule;
2551 struct ofp11_match of11_match;
2552 struct cls_rule of11_rule;
2556 cls_rule_init_catchall(&rule, OFP_DEFAULT_PRIORITY);
2557 rule.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
2558 rule.wc.vlan_tci_mask = htons(strtoul(argv[2], NULL, 16));
2560 /* Convert to and from string. */
2561 string_s = cls_rule_to_string(&rule);
2562 printf("%s -> ", string_s);
2564 parse_ofp_str(&fm, -1, string_s, false);
2565 printf("%04"PRIx16"/%04"PRIx16"\n",
2566 ntohs(fm.cr.flow.vlan_tci),
2567 ntohs(fm.cr.wc.vlan_tci_mask));
2569 /* Convert to and from NXM. */
2570 ofpbuf_init(&nxm, 0);
2571 nxm_match_len = nx_put_match(&nxm, false, &rule, htonll(0), htonll(0));
2572 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
2573 error = nx_pull_match(&nxm, nxm_match_len, 0, &nxm_rule, NULL, NULL);
2574 printf("NXM: %s -> ", nxm_s);
2576 printf("%s\n", ofperr_to_string(error));
2578 printf("%04"PRIx16"/%04"PRIx16"\n",
2579 ntohs(nxm_rule.flow.vlan_tci),
2580 ntohs(nxm_rule.wc.vlan_tci_mask));
2583 ofpbuf_uninit(&nxm);
2585 /* Convert to and from OXM. */
2586 ofpbuf_init(&nxm, 0);
2587 nxm_match_len = nx_put_match(&nxm, true, &rule, htonll(0), htonll(0));
2588 nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
2589 error = nx_pull_match(&nxm, nxm_match_len, 0, &nxm_rule, NULL, NULL);
2590 printf("OXM: %s -> ", nxm_s);
2592 printf("%s\n", ofperr_to_string(error));
2594 uint16_t vid = ntohs(nxm_rule.flow.vlan_tci) &
2595 (VLAN_VID_MASK | VLAN_CFI);
2596 uint16_t mask = ntohs(nxm_rule.wc.vlan_tci_mask) &
2597 (VLAN_VID_MASK | VLAN_CFI);
2599 printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
2600 if (vid && vlan_tci_to_pcp(nxm_rule.wc.vlan_tci_mask)) {
2601 printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_rule.flow.vlan_tci));
2607 ofpbuf_uninit(&nxm);
2609 /* Convert to and from OpenFlow 1.0. */
2610 ofputil_cls_rule_to_ofp10_match(&rule, &of10_match);
2611 ofputil_cls_rule_from_ofp10_match(&of10_match, 0, &of10_rule);
2612 printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2613 ntohs(of10_match.dl_vlan),
2614 (of10_match.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
2615 of10_match.dl_vlan_pcp,
2616 (of10_match.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
2617 ntohs(of10_rule.flow.vlan_tci),
2618 ntohs(of10_rule.wc.vlan_tci_mask));
2620 /* Convert to and from OpenFlow 1.1. */
2621 ofputil_cls_rule_to_ofp11_match(&rule, &of11_match);
2622 ofputil_cls_rule_from_ofp11_match(&of11_match, 0, &of11_rule);
2623 printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2624 ntohs(of11_match.dl_vlan),
2625 (of11_match.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
2626 of11_match.dl_vlan_pcp,
2627 (of11_match.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
2628 ntohs(of11_rule.flow.vlan_tci),
2629 ntohs(of11_rule.wc.vlan_tci_mask));
2632 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
2635 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
2640 error = ofperr_from_name(argv[1]);
2642 ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2645 for (version = 0; version <= UINT8_MAX; version++) {
2646 const struct ofperr_domain *domain;
2648 domain = ofperr_domain_from_version(version);
2653 printf("%s: %d,%d\n",
2654 ofperr_domain_get_name(domain),
2655 ofperr_get_type(error, domain),
2656 ofperr_get_code(error, domain));
2660 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
2661 * binary data, interpreting them as an OpenFlow message, and prints the
2662 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
2664 ofctl_ofp_print(int argc, char *argv[])
2666 struct ofpbuf packet;
2668 ofpbuf_init(&packet, strlen(argv[1]) / 2);
2669 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
2670 ovs_fatal(0, "trailing garbage following hex bytes");
2672 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
2673 ofpbuf_uninit(&packet);
2676 static const struct command all_commands[] = {
2677 { "show", 1, 1, ofctl_show },
2678 { "monitor", 1, 3, ofctl_monitor },
2679 { "snoop", 1, 1, ofctl_snoop },
2680 { "dump-desc", 1, 1, ofctl_dump_desc },
2681 { "dump-tables", 1, 1, ofctl_dump_tables },
2682 { "dump-flows", 1, 2, ofctl_dump_flows },
2683 { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
2684 { "queue-stats", 1, 3, ofctl_queue_stats },
2685 { "add-flow", 2, 2, ofctl_add_flow },
2686 { "add-flows", 2, 2, ofctl_add_flows },
2687 { "mod-flows", 2, 2, ofctl_mod_flows },
2688 { "del-flows", 1, 2, ofctl_del_flows },
2689 { "replace-flows", 2, 2, ofctl_replace_flows },
2690 { "diff-flows", 2, 2, ofctl_diff_flows },
2691 { "packet-out", 4, INT_MAX, ofctl_packet_out },
2692 { "dump-ports", 1, 2, ofctl_dump_ports },
2693 { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc },
2694 { "mod-port", 3, 3, ofctl_mod_port },
2695 { "get-frags", 1, 1, ofctl_get_frags },
2696 { "set-frags", 2, 2, ofctl_set_frags },
2697 { "probe", 1, 1, ofctl_probe },
2698 { "ping", 1, 2, ofctl_ping },
2699 { "benchmark", 3, 3, ofctl_benchmark },
2700 { "help", 0, INT_MAX, ofctl_help },
2702 /* Undocumented commands for testing. */
2703 { "parse-flow", 1, 1, ofctl_parse_flow },
2704 { "parse-flows", 1, 1, ofctl_parse_flows },
2705 { "parse-nx-match", 0, 0, ofctl_parse_nxm },
2706 { "parse-nxm", 0, 0, ofctl_parse_nxm },
2707 { "parse-oxm", 0, 0, ofctl_parse_oxm },
2708 { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
2709 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
2710 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
2711 { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
2712 { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
2713 { "check-vlan", 2, 2, ofctl_check_vlan },
2714 { "print-error", 1, 1, ofctl_print_error },
2715 { "ofp-print", 1, 2, ofctl_ofp_print },
2717 { NULL, 0, 0, NULL },