2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
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.
21 #include <sys/socket.h>
27 #include <sys/fcntl.h>
31 #include "byte-order.h"
32 #include "classifier.h"
33 #include "command-line.h"
37 #include "dynamic-string.h"
41 #include "ofp-errors.h"
42 #include "ofp-parse.h"
43 #include "ofp-print.h"
46 #include "ofproto/ofproto.h"
47 #include "openflow/nicira-ext.h"
48 #include "openflow/openflow.h"
50 #include "poll-loop.h"
52 #include "stream-ssl.h"
59 VLOG_DEFINE_THIS_MODULE(ofctl);
61 /* --strict: Use strict matching for flow mod commands? Additionally governs
62 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
66 /* --readd: If true, on replace-flows, re-add even flows that have not changed
67 * (to reset flow counters). */
70 /* -F, --flow-format: Flow format to use. Either one of NXFF_* to force a
71 * particular flow format or -1 to let ovs-ofctl choose intelligently. */
72 static int preferred_flow_format = -1;
74 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
75 * commands. Either one of NXPIF_* to force a particular packet_in format, or
76 * -1 to let ovs-ofctl choose the default. */
77 static int preferred_packet_in_format = -1;
79 /* -m, --more: Additional verbosity for ofp-print functions. */
82 /* --timestamp: Print a timestamp before each received packet on "monitor" and
84 static bool timestamp;
86 static const struct command all_commands[];
88 static void usage(void) NO_RETURN;
89 static void parse_options(int argc, char *argv[]);
92 main(int argc, char *argv[])
94 set_program_name(argv[0]);
95 parse_options(argc, argv);
96 signal(SIGPIPE, SIG_IGN);
97 run_command(argc - optind, argv + optind, all_commands);
102 parse_options(int argc, char *argv[])
105 OPT_STRICT = UCHAR_MAX + 1,
111 static struct option long_options[] = {
112 {"timeout", required_argument, NULL, 't'},
113 {"strict", no_argument, NULL, OPT_STRICT},
114 {"readd", no_argument, NULL, OPT_READD},
115 {"flow-format", required_argument, NULL, 'F'},
116 {"packet-in-format", required_argument, NULL, 'P'},
117 {"more", no_argument, NULL, 'm'},
118 {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
119 {"help", no_argument, NULL, 'h'},
120 {"version", no_argument, NULL, 'V'},
123 STREAM_SSL_LONG_OPTIONS,
126 char *short_options = long_options_to_short_options(long_options);
129 unsigned long int timeout;
132 c = getopt_long(argc, argv, short_options, long_options, NULL);
139 timeout = strtoul(optarg, NULL, 10);
141 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
149 preferred_flow_format = ofputil_flow_format_from_string(optarg);
150 if (preferred_flow_format < 0) {
151 ovs_fatal(0, "unknown flow format `%s'", optarg);
156 preferred_packet_in_format =
157 ofputil_packet_in_format_from_string(optarg);
158 if (preferred_packet_in_format < 0) {
159 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
171 ovs_print_version(OFP_VERSION, OFP_VERSION);
186 DAEMON_OPTION_HANDLERS
188 STREAM_SSL_OPTION_HANDLERS
203 printf("%s: OpenFlow switch management utility\n"
204 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
205 "\nFor OpenFlow switches:\n"
206 " show SWITCH show OpenFlow information\n"
207 " dump-desc SWITCH print switch description\n"
208 " dump-tables SWITCH print table stats\n"
209 " mod-port SWITCH IFACE ACT modify port behavior\n"
210 " get-frags SWITCH print fragment handling behavior\n"
211 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
212 " dump-ports SWITCH [PORT] print port statistics\n"
213 " dump-flows SWITCH print all flow entries\n"
214 " dump-flows SWITCH FLOW print matching FLOWs\n"
215 " dump-aggregate SWITCH print aggregate flow statistics\n"
216 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
217 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
218 " add-flow SWITCH FLOW add flow described by FLOW\n"
219 " add-flows SWITCH FILE add flows from FILE\n"
220 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
221 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
222 " replace-flows SWITCH FILE replace flows with those in FILE\n"
223 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
224 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
225 " execute ACTIONS on PACKET\n"
226 " monitor SWITCH [MISSLEN] [invalid_ttl]\n"
227 " print packets received from SWITCH\n"
228 " snoop SWITCH snoop on SWITCH and its controller\n"
229 "\nFor OpenFlow switches and controllers:\n"
230 " probe TARGET probe whether TARGET is up\n"
231 " ping TARGET [N] latency of N-byte echos\n"
232 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
233 "where SWITCH or TARGET is an active OpenFlow connection method.\n",
234 program_name, program_name);
235 vconn_usage(true, false, false);
238 printf("\nOther options:\n"
239 " --strict use strict match for flow commands\n"
240 " --readd replace flows that haven't changed\n"
241 " -F, --flow-format=FORMAT force particular flow format\n"
242 " -P, --packet-in-format=FRMT force particular packet in format\n"
243 " -m, --more be more verbose printing OpenFlow\n"
244 " --timestamp (monitor, snoop) print timestamps\n"
245 " -t, --timeout=SECS give up after SECS seconds\n"
246 " -h, --help display this help message\n"
247 " -V, --version display version information\n");
252 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
253 const char *argv[] OVS_UNUSED, void *exiting_)
255 bool *exiting = exiting_;
257 unixctl_command_reply(conn, NULL);
260 static void run(int retval, const char *message, ...)
263 static void run(int retval, const char *message, ...)
268 va_start(args, message);
269 ovs_fatal_valist(retval, message, args);
273 /* Generic commands. */
276 open_vconn_socket(const char *name, struct vconn **vconnp)
278 char *vconn_name = xasprintf("unix:%s", name);
279 VLOG_DBG("connecting to %s", vconn_name);
280 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
281 "connecting to %s", vconn_name);
286 open_vconn__(const char *name, const char *default_suffix,
287 struct vconn **vconnp)
289 char *datapath_name, *datapath_type, *socket_name;
293 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
295 ofproto_parse_name(name, &datapath_name, &datapath_type);
296 socket_name = xasprintf("%s/%s.%s",
297 ovs_rundir(), datapath_name, default_suffix);
301 if (strchr(name, ':')) {
302 run(vconn_open_block(name, OFP_VERSION, vconnp),
303 "connecting to %s", name);
304 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
305 open_vconn_socket(name, vconnp);
306 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
307 open_vconn_socket(bridge_path, vconnp);
308 } else if (!stat(socket_name, &s)) {
309 if (!S_ISSOCK(s.st_mode)) {
310 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
313 open_vconn_socket(socket_name, vconnp);
315 ovs_fatal(0, "%s is not a bridge or a socket", name);
323 open_vconn(const char *name, struct vconn **vconnp)
325 return open_vconn__(name, "mgmt", vconnp);
329 alloc_stats_request(size_t rq_len, uint16_t type, struct ofpbuf **bufferp)
331 struct ofp_stats_msg *rq;
333 rq = make_openflow(rq_len, OFPT_STATS_REQUEST, bufferp);
334 rq->type = htons(type);
335 rq->flags = htons(0);
340 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
342 update_openflow_length(buffer);
343 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
347 dump_transaction(const char *vconn_name, struct ofpbuf *request)
350 struct ofpbuf *reply;
352 update_openflow_length(request);
353 open_vconn(vconn_name, &vconn);
354 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
355 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
360 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
362 struct ofpbuf *request;
363 make_openflow(sizeof(struct ofp_header), request_type, &request);
364 dump_transaction(vconn_name, request);
368 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
370 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
374 open_vconn(vconn_name, &vconn);
375 send_openflow_buffer(vconn, request);
378 struct ofpbuf *reply;
380 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
381 recv_xid = ((struct ofp_header *) reply->data)->xid;
382 if (send_xid == recv_xid) {
383 struct ofp_stats_msg *osm;
385 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
387 osm = ofpbuf_at(reply, 0, sizeof *osm);
388 done = !osm || !(ntohs(osm->flags) & OFPSF_REPLY_MORE);
390 VLOG_DBG("received reply with xid %08"PRIx32" "
391 "!= expected %08"PRIx32, recv_xid, send_xid);
393 ofpbuf_delete(reply);
399 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
401 struct ofpbuf *request;
402 alloc_stats_request(sizeof(struct ofp_stats_msg), stats_type, &request);
403 dump_stats_transaction(vconn_name, request);
406 /* Sends 'request', which should be a request that only has a reply if an error
407 * occurs, and waits for it to succeed or fail. If an error does occur, prints
408 * it and exits with an error.
410 * Destroys all of the 'requests'. */
412 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
414 struct ofpbuf *request, *reply;
416 LIST_FOR_EACH (request, list_node, requests) {
417 update_openflow_length(request);
420 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
421 "talking to %s", vconn_get_name(vconn));
423 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
426 ofpbuf_delete(reply);
429 /* Sends 'request', which should be a request that only has a reply if an error
430 * occurs, and waits for it to succeed or fail. If an error does occur, prints
431 * it and exits with an error.
433 * Destroys 'request'. */
435 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
437 struct list requests;
439 list_init(&requests);
440 list_push_back(&requests, &request->list_node);
441 transact_multiple_noreply(vconn, &requests);
445 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
447 struct ofp_switch_config *config;
448 struct ofp_header *header;
449 struct ofpbuf *request;
450 struct ofpbuf *reply;
452 make_openflow(sizeof(struct ofp_header), OFPT_GET_CONFIG_REQUEST,
454 run(vconn_transact(vconn, request, &reply),
455 "talking to %s", vconn_get_name(vconn));
457 header = reply->data;
458 if (header->type != OFPT_GET_CONFIG_REPLY ||
459 header->length != htons(sizeof *config)) {
460 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
463 config = reply->data;
466 ofpbuf_delete(reply);
470 set_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
472 struct ofp_switch_config *config;
473 struct ofp_header save_header;
474 struct ofpbuf *request;
476 config = make_openflow(sizeof *config, OFPT_SET_CONFIG, &request);
477 save_header = config->header;
479 config->header = save_header;
481 transact_noreply(vconn, request);
485 do_show(int argc OVS_UNUSED, char *argv[])
487 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
488 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
492 do_dump_desc(int argc OVS_UNUSED, char *argv[])
494 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
498 do_dump_tables(int argc OVS_UNUSED, char *argv[])
500 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
503 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
504 * 'port_name' (which may be a port name or number), and copies it into
507 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
508 struct ofp_phy_port *oppp)
510 struct ofpbuf *request, *reply;
511 struct ofp_switch_features *osf;
512 unsigned int port_no;
517 /* Try to interpret the argument as a port number. */
518 if (!str_to_uint(port_name, 10, &port_no)) {
522 /* Fetch the switch's ofp_switch_features. */
523 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
524 open_vconn(vconn_name, &vconn);
525 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
528 if (reply->size < sizeof *osf) {
529 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
530 vconn_name, reply->size);
532 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
534 for (port_idx = 0; port_idx < n_ports; port_idx++) {
535 const struct ofp_phy_port *opp = &osf->ports[port_idx];
537 if (port_no != UINT_MAX
538 ? htons(port_no) == opp->port_no
539 : !strncmp(opp->name, port_name, sizeof opp->name)) {
541 ofpbuf_delete(reply);
546 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
549 /* Returns the port number corresponding to 'port_name' (which may be a port
550 * name or number) within the switch 'vconn_name'. */
552 str_to_port_no(const char *vconn_name, const char *port_name)
554 unsigned int port_no;
556 if (str_to_uint(port_name, 10, &port_no)) {
559 struct ofp_phy_port opp;
561 fetch_ofp_phy_port(vconn_name, port_name, &opp);
562 return ntohs(opp.port_no);
567 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
569 struct ofpbuf *sff, *reply;
571 sff = ofputil_make_set_flow_format(flow_format);
572 run(vconn_transact_noreply(vconn, sff, &reply),
573 "talking to %s", vconn_get_name(vconn));
575 char *s = ofp_to_string(reply->data, reply->size, 2);
576 VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
577 vconn_get_name(vconn),
578 ofputil_flow_format_to_string(flow_format),
581 ofpbuf_delete(reply);
588 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
590 struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
591 transact_noreply(vconn, sff);
592 VLOG_DBG("%s: using user-specified flow format %s",
593 vconn_get_name(vconn),
594 ofputil_flow_format_to_string(flow_format));
597 static enum nx_flow_format
598 negotiate_highest_flow_format(struct vconn *vconn,
599 enum nx_flow_format min_format)
601 if (preferred_flow_format != -1) {
602 if (preferred_flow_format < min_format) {
603 ovs_fatal(0, "%s: cannot use requested flow format %s for "
604 "specified flow", vconn_get_name(vconn),
605 ofputil_flow_format_to_string(min_format));
608 set_flow_format(vconn, preferred_flow_format);
609 return preferred_flow_format;
611 enum nx_flow_format flow_format;
613 if (try_set_flow_format(vconn, NXFF_NXM)) {
614 flow_format = NXFF_NXM;
616 flow_format = NXFF_OPENFLOW10;
619 if (flow_format < min_format) {
620 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
621 "%s for specified flow", vconn_get_name(vconn),
622 ofputil_flow_format_to_string(min_format));
625 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
626 ofputil_flow_format_to_string(flow_format));
632 do_dump_flows__(int argc, char *argv[], bool aggregate)
634 enum nx_flow_format min_flow_format, flow_format;
635 struct ofputil_flow_stats_request fsr;
636 struct ofpbuf *request;
639 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
641 open_vconn(argv[1], &vconn);
642 min_flow_format = ofputil_min_flow_format(&fsr.match);
643 if (fsr.cookie_mask != htonll(0)) {
644 min_flow_format = NXFF_NXM;
646 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
647 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
648 dump_stats_transaction(argv[1], request);
653 do_dump_flows(int argc, char *argv[])
655 return do_dump_flows__(argc, argv, false);
659 do_dump_aggregate(int argc, char *argv[])
661 return do_dump_flows__(argc, argv, true);
665 do_queue_stats(int argc, char *argv[])
667 struct ofp_queue_stats_request *req;
668 struct ofpbuf *request;
670 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
672 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
673 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
675 req->port_no = htons(OFPP_ALL);
677 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
678 req->queue_id = htonl(atoi(argv[3]));
680 req->queue_id = htonl(OFPQ_ALL);
683 memset(req->pad, 0, sizeof req->pad);
685 dump_stats_transaction(argv[1], request);
688 /* Sets up the flow format for a vconn that will be used to modify the flow
689 * table. Returns the flow format used, after possibly adding an OpenFlow
690 * request to 'requests'.
692 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
693 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
694 * OpenFlow connection.
696 * If 'preferred_flow_format' is a specific format, adds a request to set that
697 * format to 'requests' and returns the format. */
698 static enum nx_flow_format
699 set_initial_format_for_flow_mod(struct list *requests)
701 if (preferred_flow_format < 0) {
702 return NXFF_OPENFLOW10;
706 sff = ofputil_make_set_flow_format(preferred_flow_format);
707 list_push_back(requests, &sff->list_node);
708 return preferred_flow_format;
712 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
713 * operation, given the global 'preferred_flow_format'. */
715 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
717 if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
718 ovs_fatal(0, "flow cannot be expressed in flow format %s "
719 "(flow format %s or better is required)",
720 ofputil_flow_format_to_string(preferred_flow_format),
721 ofputil_flow_format_to_string(flow_format));
726 do_flow_mod_file__(int argc OVS_UNUSED, char *argv[], uint16_t command)
728 enum nx_flow_format flow_format;
729 bool flow_mod_table_id;
730 struct list requests;
734 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
736 ovs_fatal(errno, "%s: open", argv[2]);
739 list_init(&requests);
740 flow_format = set_initial_format_for_flow_mod(&requests);
741 flow_mod_table_id = false;
743 open_vconn(argv[1], &vconn);
744 while (parse_ofp_flow_mod_file(&requests, &flow_format, &flow_mod_table_id,
746 check_final_format_for_flow_mod(flow_format);
747 transact_multiple_noreply(vconn, &requests);
757 do_flow_mod__(int argc, char *argv[], uint16_t command)
759 enum nx_flow_format flow_format;
760 bool flow_mod_table_id;
761 struct list requests;
764 if (argc > 2 && !strcmp(argv[2], "-")) {
765 do_flow_mod_file__(argc, argv, command);
769 list_init(&requests);
770 flow_format = set_initial_format_for_flow_mod(&requests);
771 flow_mod_table_id = false;
773 parse_ofp_flow_mod_str(&requests, &flow_format, &flow_mod_table_id,
774 argc > 2 ? argv[2] : "", command, false);
775 check_final_format_for_flow_mod(flow_format);
777 open_vconn(argv[1], &vconn);
778 transact_multiple_noreply(vconn, &requests);
783 do_add_flow(int argc, char *argv[])
785 do_flow_mod__(argc, argv, OFPFC_ADD);
789 do_add_flows(int argc, char *argv[])
791 do_flow_mod_file__(argc, argv, OFPFC_ADD);
795 do_mod_flows(int argc, char *argv[])
797 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
801 do_del_flows(int argc, char *argv[])
803 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
807 set_packet_in_format(struct vconn *vconn,
808 enum nx_packet_in_format packet_in_format)
810 struct ofpbuf *spif = ofputil_make_set_packet_in_format(packet_in_format);
811 transact_noreply(vconn, spif);
812 VLOG_DBG("%s: using user-specified packet in format %s",
813 vconn_get_name(vconn),
814 ofputil_packet_in_format_to_string(packet_in_format));
818 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
820 struct ofp_switch_config config;
821 enum ofp_config_flags flags;
823 fetch_switch_config(vconn, &config);
824 flags = ntohs(config.flags);
825 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
826 /* Set the invalid ttl config. */
827 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
829 config.flags = htons(flags);
830 set_switch_config(vconn, &config);
832 /* Then retrieve the configuration to see if it really took. OpenFlow
833 * doesn't define error reporting for bad modes, so this is all we can
835 fetch_switch_config(vconn, &config);
836 flags = ntohs(config.flags);
837 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
838 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
839 "switch probably doesn't support mode)");
846 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
847 * caller must free '*msgp'. On success, returns NULL. On failure, returns
848 * an error message and stores NULL in '*msgp'. */
850 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
852 struct ofp_header *oh;
855 msg = ofpbuf_new(strlen(hex) / 2);
858 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
860 return "Trailing garbage in hex data";
863 if (msg->size < sizeof(struct ofp_header)) {
865 return "Message too short for OpenFlow";
869 if (msg->size != ntohs(oh->length)) {
871 return "Message size does not match length in OpenFlow header";
879 ofctl_send(struct unixctl_conn *conn, int argc,
880 const char *argv[], void *vconn_)
882 struct vconn *vconn = vconn_;
889 for (i = 1; i < argc; i++) {
890 const char *error_msg;
894 error_msg = openflow_from_hex(argv[i], &msg);
896 ds_put_format(&reply, "%s\n", error_msg);
901 fprintf(stderr, "send: ");
902 ofp_print(stderr, msg->data, msg->size, verbosity);
904 error = vconn_send_block(vconn, msg);
907 ds_put_format(&reply, "%s\n", strerror(error));
910 ds_put_cstr(&reply, "sent\n");
915 unixctl_command_reply(conn, ds_cstr(&reply));
917 unixctl_command_reply_error(conn, ds_cstr(&reply));
923 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
924 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
928 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
929 const char *argv[] OVS_UNUSED, void *aux_)
931 struct barrier_aux *aux = aux_;
936 unixctl_command_reply_error(conn, "already waiting for barrier reply");
940 msg = ofputil_encode_barrier_request();
941 fprintf(stderr, "send: ");
942 ofp_print(stderr, msg->data, msg->size, verbosity);
944 error = vconn_send_block(aux->vconn, msg);
947 unixctl_command_reply_error(conn, strerror(error));
954 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
955 const char *argv[], void *aux OVS_UNUSED)
959 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
961 unixctl_command_reply_error(conn, strerror(errno));
966 dup2(fd, STDERR_FILENO);
968 unixctl_command_reply(conn, NULL);
972 monitor_vconn(struct vconn *vconn)
974 struct barrier_aux barrier_aux = { vconn, NULL };
975 struct unixctl_server *server;
976 bool exiting = false;
979 daemon_save_fd(STDERR_FILENO);
981 error = unixctl_server_create(NULL, &server);
983 ovs_fatal(error, "failed to create unixctl server");
985 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
986 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
988 unixctl_command_register("ofctl/barrier", "", 0, 0,
989 ofctl_barrier, &barrier_aux);
990 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
991 ofctl_set_output_file, NULL);
992 daemonize_complete();
998 unixctl_server_run(server);
1003 retval = vconn_recv(vconn, &b);
1004 if (retval == EAGAIN) {
1007 msg_type = ((const struct ofp_header *) b->data)->type;
1009 run(retval, "vconn_recv");
1011 time_t now = time_wall();
1014 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S: ", localtime(&now));
1017 ofp_print(stderr, b->data, b->size, verbosity + 2);
1020 if (barrier_aux.conn && msg_type == OFPT_BARRIER_REPLY) {
1021 unixctl_command_reply(barrier_aux.conn, NULL);
1022 barrier_aux.conn = NULL;
1031 vconn_run_wait(vconn);
1032 vconn_recv_wait(vconn);
1033 unixctl_server_wait(server);
1037 unixctl_server_destroy(server);
1041 do_monitor(int argc, char *argv[])
1043 struct vconn *vconn;
1045 open_vconn(argv[1], &vconn);
1047 struct ofp_switch_config config;
1049 fetch_switch_config(vconn, &config);
1050 config.miss_send_len = htons(atoi(argv[2]));
1051 set_switch_config(vconn, &config);
1054 if (!strcmp(argv[3], "invalid_ttl")) {
1055 monitor_set_invalid_ttl_to_controller(vconn);
1058 if (preferred_packet_in_format >= 0) {
1059 set_packet_in_format(vconn, preferred_packet_in_format);
1061 struct ofpbuf *spif, *reply;
1063 spif = ofputil_make_set_packet_in_format(NXPIF_NXM);
1064 run(vconn_transact_noreply(vconn, spif, &reply),
1065 "talking to %s", vconn_get_name(vconn));
1067 char *s = ofp_to_string(reply->data, reply->size, 2);
1068 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1069 " replied: %s. Falling back to the switch default.",
1070 vconn_get_name(vconn), s);
1072 ofpbuf_delete(reply);
1076 monitor_vconn(vconn);
1080 do_snoop(int argc OVS_UNUSED, char *argv[])
1082 struct vconn *vconn;
1084 open_vconn__(argv[1], "snoop", &vconn);
1085 monitor_vconn(vconn);
1089 do_dump_ports(int argc, char *argv[])
1091 struct ofp_port_stats_request *req;
1092 struct ofpbuf *request;
1095 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
1096 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
1097 req->port_no = htons(port);
1098 dump_stats_transaction(argv[1], request);
1102 do_probe(int argc OVS_UNUSED, char *argv[])
1104 struct ofpbuf *request;
1105 struct vconn *vconn;
1106 struct ofpbuf *reply;
1108 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
1109 open_vconn(argv[1], &vconn);
1110 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1111 if (reply->size != sizeof(struct ofp_header)) {
1112 ovs_fatal(0, "reply does not match request");
1114 ofpbuf_delete(reply);
1119 do_packet_out(int argc, char *argv[])
1121 struct ofputil_packet_out po;
1122 struct ofpbuf actions;
1123 struct vconn *vconn;
1126 ofpbuf_init(&actions, sizeof(union ofp_action));
1127 parse_ofp_actions(argv[3], &actions);
1129 po.buffer_id = UINT32_MAX;
1130 po.in_port = (!strcasecmp(argv[2], "none") ? OFPP_NONE
1131 : !strcasecmp(argv[2], "local") ? OFPP_LOCAL
1132 : str_to_port_no(argv[1], argv[2]));
1133 po.actions = actions.data;
1134 po.n_actions = actions.size / sizeof(union ofp_action);
1136 open_vconn(argv[1], &vconn);
1137 for (i = 4; i < argc; i++) {
1138 struct ofpbuf *packet, *opo;
1139 const char *error_msg;
1141 error_msg = eth_from_hex(argv[i], &packet);
1143 ovs_fatal(0, "%s", error_msg);
1146 po.packet = packet->data;
1147 po.packet_len = packet->size;
1148 opo = ofputil_encode_packet_out(&po);
1149 transact_noreply(vconn, opo);
1150 ofpbuf_delete(packet);
1156 do_mod_port(int argc OVS_UNUSED, char *argv[])
1158 struct ofp_port_mod *opm;
1159 struct ofp_phy_port opp;
1160 struct ofpbuf *request;
1161 struct vconn *vconn;
1163 fetch_ofp_phy_port(argv[1], argv[2], &opp);
1165 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
1166 opm->port_no = opp.port_no;
1167 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
1168 opm->config = htonl(0);
1169 opm->mask = htonl(0);
1170 opm->advertise = htonl(0);
1172 if (!strcasecmp(argv[3], "up")) {
1173 opm->mask |= htonl(OFPPC_PORT_DOWN);
1174 } else if (!strcasecmp(argv[3], "down")) {
1175 opm->mask |= htonl(OFPPC_PORT_DOWN);
1176 opm->config |= htonl(OFPPC_PORT_DOWN);
1177 } else if (!strcasecmp(argv[3], "flood")) {
1178 opm->mask |= htonl(OFPPC_NO_FLOOD);
1179 } else if (!strcasecmp(argv[3], "noflood")) {
1180 opm->mask |= htonl(OFPPC_NO_FLOOD);
1181 opm->config |= htonl(OFPPC_NO_FLOOD);
1182 } else if (!strcasecmp(argv[3], "forward")) {
1183 opm->mask |= htonl(OFPPC_NO_FWD);
1184 } else if (!strcasecmp(argv[3], "noforward")) {
1185 opm->mask |= htonl(OFPPC_NO_FWD);
1186 opm->config |= htonl(OFPPC_NO_FWD);
1188 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1191 open_vconn(argv[1], &vconn);
1192 transact_noreply(vconn, request);
1197 do_get_frags(int argc OVS_UNUSED, char *argv[])
1199 struct ofp_switch_config config;
1200 struct vconn *vconn;
1202 open_vconn(argv[1], &vconn);
1203 fetch_switch_config(vconn, &config);
1204 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1209 do_set_frags(int argc OVS_UNUSED, char *argv[])
1211 struct ofp_switch_config config;
1212 enum ofp_config_flags mode;
1213 struct vconn *vconn;
1216 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1217 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1220 open_vconn(argv[1], &vconn);
1221 fetch_switch_config(vconn, &config);
1222 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1223 if (flags != config.flags) {
1224 /* Set the configuration. */
1225 config.flags = flags;
1226 set_switch_config(vconn, &config);
1228 /* Then retrieve the configuration to see if it really took. OpenFlow
1229 * doesn't define error reporting for bad modes, so this is all we can
1231 fetch_switch_config(vconn, &config);
1232 if (flags != config.flags) {
1233 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1234 "switch probably doesn't support mode \"%s\")",
1235 argv[1], ofputil_frag_handling_to_string(mode));
1242 do_ping(int argc, char *argv[])
1244 size_t max_payload = 65535 - sizeof(struct ofp_header);
1245 unsigned int payload;
1246 struct vconn *vconn;
1249 payload = argc > 2 ? atoi(argv[2]) : 64;
1250 if (payload > max_payload) {
1251 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1254 open_vconn(argv[1], &vconn);
1255 for (i = 0; i < 10; i++) {
1256 struct timeval start, end;
1257 struct ofpbuf *request, *reply;
1258 struct ofp_header *rq_hdr, *rpy_hdr;
1260 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1261 OFPT_ECHO_REQUEST, &request);
1262 random_bytes(rq_hdr + 1, payload);
1264 xgettimeofday(&start);
1265 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1266 xgettimeofday(&end);
1268 rpy_hdr = reply->data;
1269 if (reply->size != request->size
1270 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1271 || rpy_hdr->xid != rq_hdr->xid
1272 || rpy_hdr->type != OFPT_ECHO_REPLY) {
1273 printf("Reply does not match request. Request:\n");
1274 ofp_print(stdout, request, request->size, verbosity + 2);
1276 ofp_print(stdout, reply, reply->size, verbosity + 2);
1278 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1279 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
1280 (1000*(double)(end.tv_sec - start.tv_sec))
1281 + (.001*(end.tv_usec - start.tv_usec)));
1282 ofpbuf_delete(request);
1283 ofpbuf_delete(reply);
1289 do_benchmark(int argc OVS_UNUSED, char *argv[])
1291 size_t max_payload = 65535 - sizeof(struct ofp_header);
1292 struct timeval start, end;
1293 unsigned int payload_size, message_size;
1294 struct vconn *vconn;
1299 payload_size = atoi(argv[2]);
1300 if (payload_size > max_payload) {
1301 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1303 message_size = sizeof(struct ofp_header) + payload_size;
1305 count = atoi(argv[3]);
1307 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1308 count, message_size, count * message_size);
1310 open_vconn(argv[1], &vconn);
1311 xgettimeofday(&start);
1312 for (i = 0; i < count; i++) {
1313 struct ofpbuf *request, *reply;
1314 struct ofp_header *rq_hdr;
1316 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1317 memset(rq_hdr + 1, 0, payload_size);
1318 run(vconn_transact(vconn, request, &reply), "transact");
1319 ofpbuf_delete(reply);
1321 xgettimeofday(&end);
1324 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1325 + (.001*(end.tv_usec - start.tv_usec)));
1326 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1327 duration, count / (duration / 1000.0),
1328 count * message_size / (duration / 1000.0));
1332 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1337 /* replace-flows and diff-flows commands. */
1339 /* A flow table entry, possibly with two different versions. */
1341 struct cls_rule rule; /* Within a "struct classifier". */
1342 struct fte_version *versions[2];
1345 /* One version of a Flow Table Entry. */
1346 struct fte_version {
1348 uint16_t idle_timeout;
1349 uint16_t hard_timeout;
1351 union ofp_action *actions;
1355 /* Frees 'version' and the data that it owns. */
1357 fte_version_free(struct fte_version *version)
1360 free(version->actions);
1365 /* Returns true if 'a' and 'b' are the same, false if they differ.
1367 * Ignores differences in 'flags' because there's no way to retrieve flags from
1368 * an OpenFlow switch. We have to assume that they are the same. */
1370 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1372 return (a->cookie == b->cookie
1373 && a->idle_timeout == b->idle_timeout
1374 && a->hard_timeout == b->hard_timeout
1375 && a->n_actions == b->n_actions
1376 && !memcmp(a->actions, b->actions,
1377 a->n_actions * sizeof *a->actions));
1380 /* Prints 'version' on stdout. Expects the caller to have printed the rule
1381 * associated with the version. */
1383 fte_version_print(const struct fte_version *version)
1387 if (version->cookie != htonll(0)) {
1388 printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
1390 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1391 printf(" idle_timeout=%"PRIu16, version->idle_timeout);
1393 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1394 printf(" hard_timeout=%"PRIu16, version->hard_timeout);
1398 ofp_print_actions(&s, version->actions, version->n_actions);
1399 printf(" %s\n", ds_cstr(&s));
1404 fte_from_cls_rule(const struct cls_rule *cls_rule)
1406 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1409 /* Frees 'fte' and its versions. */
1411 fte_free(struct fte *fte)
1414 fte_version_free(fte->versions[0]);
1415 fte_version_free(fte->versions[1]);
1420 /* Frees all of the FTEs within 'cls'. */
1422 fte_free_all(struct classifier *cls)
1424 struct cls_cursor cursor;
1425 struct fte *fte, *next;
1427 cls_cursor_init(&cursor, cls, NULL);
1428 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1429 classifier_remove(cls, &fte->rule);
1434 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1435 * necessary. Sets 'version' as the version of that rule with the given
1436 * 'index', replacing any existing version, if any.
1438 * Takes ownership of 'version'. */
1440 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1441 struct fte_version *version, int index)
1443 struct fte *old, *fte;
1445 fte = xzalloc(sizeof *fte);
1447 fte->versions[index] = version;
1449 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1451 fte_version_free(old->versions[index]);
1452 fte->versions[!index] = old->versions[!index];
1457 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1458 * with the specified 'index'. Returns the minimum flow format required to
1459 * represent the flows that were read. */
1460 static enum nx_flow_format
1461 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1463 enum nx_flow_format min_flow_format;
1467 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1469 ovs_fatal(errno, "%s: open", filename);
1473 min_flow_format = NXFF_OPENFLOW10;
1474 while (!ds_get_preprocessed_line(&s, file)) {
1475 struct fte_version *version;
1476 struct ofputil_flow_mod fm;
1477 enum nx_flow_format min_ff;
1479 parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1481 version = xmalloc(sizeof *version);
1482 version->cookie = fm.cookie;
1483 version->idle_timeout = fm.idle_timeout;
1484 version->hard_timeout = fm.hard_timeout;
1485 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1486 version->actions = fm.actions;
1487 version->n_actions = fm.n_actions;
1489 min_ff = ofputil_min_flow_format(&fm.cr);
1490 min_flow_format = MAX(min_flow_format, min_ff);
1491 check_final_format_for_flow_mod(min_flow_format);
1493 fte_insert(cls, &fm.cr, version, index);
1497 if (file != stdin) {
1501 return min_flow_format;
1504 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1505 * format 'flow_format', and adds them as flow table entries in 'cls' for the
1506 * version with the specified 'index'. */
1508 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1509 struct classifier *cls, int index)
1511 struct ofputil_flow_stats_request fsr;
1512 struct ofpbuf *request;
1516 fsr.aggregate = false;
1517 cls_rule_init_catchall(&fsr.match, 0);
1518 fsr.out_port = OFPP_NONE;
1519 fsr.table_id = 0xff;
1520 fsr.cookie = fsr.cookie_mask = htonll(0);
1521 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1522 send_xid = ((struct ofp_header *) request->data)->xid;
1523 send_openflow_buffer(vconn, request);
1528 struct ofpbuf *reply;
1530 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1531 recv_xid = ((struct ofp_header *) reply->data)->xid;
1532 if (send_xid == recv_xid) {
1533 const struct ofputil_msg_type *type;
1534 const struct ofp_stats_msg *osm;
1535 enum ofputil_msg_code code;
1537 ofputil_decode_msg_type(reply->data, &type);
1538 code = ofputil_msg_type_code(type);
1539 if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1540 code != OFPUTIL_NXST_FLOW_REPLY) {
1541 ovs_fatal(0, "received bad reply: %s",
1542 ofp_to_string(reply->data, reply->size,
1547 if (!(osm->flags & htons(OFPSF_REPLY_MORE))) {
1552 struct fte_version *version;
1553 struct ofputil_flow_stats fs;
1556 retval = ofputil_decode_flow_stats_reply(&fs, reply, false);
1558 if (retval != EOF) {
1559 ovs_fatal(0, "parse error in reply");
1564 version = xmalloc(sizeof *version);
1565 version->cookie = fs.cookie;
1566 version->idle_timeout = fs.idle_timeout;
1567 version->hard_timeout = fs.hard_timeout;
1569 version->n_actions = fs.n_actions;
1570 version->actions = xmemdup(fs.actions,
1571 fs.n_actions * sizeof *fs.actions);
1573 fte_insert(cls, &fs.rule, version, index);
1576 VLOG_DBG("received reply with xid %08"PRIx32" "
1577 "!= expected %08"PRIx32, recv_xid, send_xid);
1579 ofpbuf_delete(reply);
1584 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1585 enum nx_flow_format flow_format, struct list *packets)
1587 const struct fte_version *version = fte->versions[index];
1588 struct ofputil_flow_mod fm;
1592 fm.cookie = version->cookie;
1594 fm.command = command;
1595 fm.idle_timeout = version->idle_timeout;
1596 fm.hard_timeout = version->hard_timeout;
1597 fm.buffer_id = UINT32_MAX;
1598 fm.out_port = OFPP_NONE;
1599 fm.flags = version->flags;
1600 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1601 command == OFPFC_MODIFY_STRICT) {
1602 fm.actions = version->actions;
1603 fm.n_actions = version->n_actions;
1609 ofm = ofputil_encode_flow_mod(&fm, flow_format, false);
1610 list_push_back(packets, &ofm->list_node);
1614 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1616 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1617 enum nx_flow_format min_flow_format, flow_format;
1618 struct cls_cursor cursor;
1619 struct classifier cls;
1620 struct list requests;
1621 struct vconn *vconn;
1624 classifier_init(&cls);
1625 min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1627 open_vconn(argv[1], &vconn);
1628 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1629 read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1631 list_init(&requests);
1633 /* Delete flows that exist on the switch but not in the file. */
1634 cls_cursor_init(&cursor, &cls, NULL);
1635 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1636 struct fte_version *file_ver = fte->versions[FILE_IDX];
1637 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1639 if (sw_ver && !file_ver) {
1640 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1641 flow_format, &requests);
1645 /* Add flows that exist in the file but not on the switch.
1646 * Update flows that exist in both places but differ. */
1647 cls_cursor_init(&cursor, &cls, NULL);
1648 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1649 struct fte_version *file_ver = fte->versions[FILE_IDX];
1650 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1653 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1654 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1658 transact_multiple_noreply(vconn, &requests);
1665 read_flows_from_source(const char *source, struct classifier *cls, int index)
1669 if (source[0] == '/' || source[0] == '.'
1670 || (!strchr(source, ':') && !stat(source, &s))) {
1671 read_flows_from_file(source, cls, index);
1673 enum nx_flow_format flow_format;
1674 struct vconn *vconn;
1676 open_vconn(source, &vconn);
1677 flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1678 read_flows_from_switch(vconn, flow_format, cls, index);
1684 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1686 bool differences = false;
1687 struct cls_cursor cursor;
1688 struct classifier cls;
1691 classifier_init(&cls);
1692 read_flows_from_source(argv[1], &cls, 0);
1693 read_flows_from_source(argv[2], &cls, 1);
1695 cls_cursor_init(&cursor, &cls, NULL);
1696 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1697 struct fte_version *a = fte->versions[0];
1698 struct fte_version *b = fte->versions[1];
1700 if (!a || !b || !fte_version_equals(a, b)) {
1701 char *rule_s = cls_rule_to_string(&fte->rule);
1703 printf("-%s", rule_s);
1704 fte_version_print(a);
1707 printf("+%s", rule_s);
1708 fte_version_print(b);
1723 /* Undocumented commands for unit testing. */
1726 print_packet_list(struct list *packets)
1728 struct ofpbuf *packet, *next;
1730 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1731 ofp_print(stdout, packet->data, packet->size, verbosity);
1732 list_remove(&packet->list_node);
1733 ofpbuf_delete(packet);
1737 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1738 * it back to stdout. */
1740 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1742 enum nx_flow_format flow_format;
1743 bool flow_mod_table_id;
1744 struct list packets;
1746 flow_format = NXFF_OPENFLOW10;
1747 if (preferred_flow_format > 0) {
1748 flow_format = preferred_flow_format;
1750 flow_mod_table_id = false;
1752 list_init(&packets);
1753 parse_ofp_flow_mod_str(&packets, &flow_format, &flow_mod_table_id,
1754 argv[1], OFPFC_ADD, false);
1755 print_packet_list(&packets);
1758 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1759 * add-flows) and prints each of the flows back to stdout. */
1761 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1763 enum nx_flow_format flow_format;
1764 bool flow_mod_table_id;
1765 struct list packets;
1768 file = fopen(argv[1], "r");
1770 ovs_fatal(errno, "%s: open", argv[1]);
1773 flow_format = NXFF_OPENFLOW10;
1774 if (preferred_flow_format > 0) {
1775 flow_format = preferred_flow_format;
1777 flow_mod_table_id = false;
1779 list_init(&packets);
1780 while (parse_ofp_flow_mod_file(&packets, &flow_format, &flow_mod_table_id,
1782 print_packet_list(&packets);
1787 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1788 * stdin, does some internal fussing with them, and then prints them back as
1789 * strings on stdout. */
1791 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1796 while (!ds_get_line(&in, stdin)) {
1797 struct ofpbuf nx_match;
1798 struct cls_rule rule;
1799 ovs_be64 cookie, cookie_mask;
1804 /* Delete comments, skip blank lines. */
1810 if (strchr(s, '#')) {
1811 *strchr(s, '#') = '\0';
1813 if (s[strspn(s, " ")] == '\0') {
1818 /* Convert string to nx_match. */
1819 ofpbuf_init(&nx_match, 0);
1820 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1822 /* Convert nx_match to cls_rule. */
1824 error = nx_pull_match(&nx_match, match_len, 0, &rule,
1825 &cookie, &cookie_mask);
1827 error = nx_pull_match_loose(&nx_match, match_len, 0, &rule,
1828 &cookie, &cookie_mask);
1834 /* Convert cls_rule back to nx_match. */
1835 ofpbuf_uninit(&nx_match);
1836 ofpbuf_init(&nx_match, 0);
1837 match_len = nx_put_match(&nx_match, &rule, cookie, cookie_mask);
1839 /* Convert nx_match to string. */
1840 out = nx_match_to_string(nx_match.data, match_len);
1844 printf("nx_pull_match() returned error %s\n",
1845 ofperr_get_name(error));
1848 ofpbuf_uninit(&nx_match);
1853 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1854 * binary data, interpreting them as an OpenFlow message, and prints the
1855 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1857 do_ofp_print(int argc, char *argv[])
1859 struct ofpbuf packet;
1861 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1862 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1863 ovs_fatal(0, "trailing garbage following hex bytes");
1865 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1866 ofpbuf_uninit(&packet);
1869 static const struct command all_commands[] = {
1870 { "show", 1, 1, do_show },
1871 { "monitor", 1, 3, do_monitor },
1872 { "snoop", 1, 1, do_snoop },
1873 { "dump-desc", 1, 1, do_dump_desc },
1874 { "dump-tables", 1, 1, do_dump_tables },
1875 { "dump-flows", 1, 2, do_dump_flows },
1876 { "dump-aggregate", 1, 2, do_dump_aggregate },
1877 { "queue-stats", 1, 3, do_queue_stats },
1878 { "add-flow", 2, 2, do_add_flow },
1879 { "add-flows", 2, 2, do_add_flows },
1880 { "mod-flows", 2, 2, do_mod_flows },
1881 { "del-flows", 1, 2, do_del_flows },
1882 { "replace-flows", 2, 2, do_replace_flows },
1883 { "diff-flows", 2, 2, do_diff_flows },
1884 { "packet-out", 4, INT_MAX, do_packet_out },
1885 { "dump-ports", 1, 2, do_dump_ports },
1886 { "mod-port", 3, 3, do_mod_port },
1887 { "get-frags", 1, 1, do_get_frags },
1888 { "set-frags", 2, 2, do_set_frags },
1889 { "probe", 1, 1, do_probe },
1890 { "ping", 1, 2, do_ping },
1891 { "benchmark", 3, 3, do_benchmark },
1892 { "help", 0, INT_MAX, do_help },
1894 /* Undocumented commands for testing. */
1895 { "parse-flow", 1, 1, do_parse_flow },
1896 { "parse-flows", 1, 1, do_parse_flows },
1897 { "parse-nx-match", 0, 0, do_parse_nx_match },
1898 { "ofp-print", 1, 2, do_ofp_print },
1900 { NULL, 0, 0, NULL },