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: Allowed protocols. By default, any protocol is
72 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
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 allowed_protocols = ofputil_protocols_from_string(optarg);
150 if (!allowed_protocols) {
151 ovs_fatal(0, "%s: invalid 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(OFP10_VERSION, OFP10_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, OFP10_VERSION, vconnp),
281 "connecting to %s", vconn_name);
285 static enum ofputil_protocol
286 open_vconn__(const char *name, const char *default_suffix,
287 struct vconn **vconnp)
289 char *datapath_name, *datapath_type, *socket_name;
290 enum ofputil_protocol protocol;
295 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
297 ofproto_parse_name(name, &datapath_name, &datapath_type);
298 socket_name = xasprintf("%s/%s.%s",
299 ovs_rundir(), datapath_name, default_suffix);
303 if (strchr(name, ':')) {
304 run(vconn_open_block(name, OFP10_VERSION, vconnp),
305 "connecting to %s", name);
306 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
307 open_vconn_socket(name, vconnp);
308 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
309 open_vconn_socket(bridge_path, vconnp);
310 } else if (!stat(socket_name, &s)) {
311 if (!S_ISSOCK(s.st_mode)) {
312 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
315 open_vconn_socket(socket_name, vconnp);
317 ovs_fatal(0, "%s is not a bridge or a socket", name);
323 ofp_version = vconn_get_version(*vconnp);
324 protocol = ofputil_protocol_from_ofp_version(ofp_version);
326 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
332 static enum ofputil_protocol
333 open_vconn(const char *name, struct vconn **vconnp)
335 return open_vconn__(name, "mgmt", vconnp);
339 alloc_stats_request(size_t rq_len, uint16_t type, struct ofpbuf **bufferp)
341 struct ofp_stats_msg *rq;
343 rq = make_openflow(rq_len, OFPT10_STATS_REQUEST, bufferp);
344 rq->type = htons(type);
345 rq->flags = htons(0);
350 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
352 update_openflow_length(buffer);
353 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
357 dump_transaction(const char *vconn_name, struct ofpbuf *request)
360 struct ofpbuf *reply;
362 update_openflow_length(request);
363 open_vconn(vconn_name, &vconn);
364 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
365 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
370 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
372 struct ofpbuf *request;
373 make_openflow(sizeof(struct ofp_header), request_type, &request);
374 dump_transaction(vconn_name, request);
378 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
380 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
384 open_vconn(vconn_name, &vconn);
385 send_openflow_buffer(vconn, request);
388 struct ofpbuf *reply;
390 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
391 recv_xid = ((struct ofp_header *) reply->data)->xid;
392 if (send_xid == recv_xid) {
393 struct ofp_stats_msg *osm;
395 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
397 osm = ofpbuf_at(reply, 0, sizeof *osm);
398 done = !osm || !(ntohs(osm->flags) & OFPSF_REPLY_MORE);
400 VLOG_DBG("received reply with xid %08"PRIx32" "
401 "!= expected %08"PRIx32, recv_xid, send_xid);
403 ofpbuf_delete(reply);
409 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
411 struct ofpbuf *request;
412 alloc_stats_request(sizeof(struct ofp_stats_msg), stats_type, &request);
413 dump_stats_transaction(vconn_name, request);
416 /* Sends 'request', which should be a request that only has a reply if an error
417 * occurs, and waits for it to succeed or fail. If an error does occur, prints
418 * it and exits with an error.
420 * Destroys all of the 'requests'. */
422 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
424 struct ofpbuf *request, *reply;
426 LIST_FOR_EACH (request, list_node, requests) {
427 update_openflow_length(request);
430 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
431 "talking to %s", vconn_get_name(vconn));
433 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
436 ofpbuf_delete(reply);
439 /* Sends 'request', which should be a request that only has a reply if an error
440 * occurs, and waits for it to succeed or fail. If an error does occur, prints
441 * it and exits with an error.
443 * Destroys 'request'. */
445 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
447 struct list requests;
449 list_init(&requests);
450 list_push_back(&requests, &request->list_node);
451 transact_multiple_noreply(vconn, &requests);
455 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
457 struct ofp_switch_config *config;
458 struct ofp_header *header;
459 struct ofpbuf *request;
460 struct ofpbuf *reply;
462 make_openflow(sizeof(struct ofp_header), OFPT_GET_CONFIG_REQUEST,
464 run(vconn_transact(vconn, request, &reply),
465 "talking to %s", vconn_get_name(vconn));
467 header = reply->data;
468 if (header->type != OFPT_GET_CONFIG_REPLY ||
469 header->length != htons(sizeof *config)) {
470 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
473 config = reply->data;
476 ofpbuf_delete(reply);
480 set_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
482 struct ofp_switch_config *config;
483 struct ofp_header save_header;
484 struct ofpbuf *request;
486 config = make_openflow(sizeof *config, OFPT_SET_CONFIG, &request);
487 save_header = config->header;
489 config->header = save_header;
491 transact_noreply(vconn, request);
495 do_show(int argc OVS_UNUSED, char *argv[])
497 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
498 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
502 do_dump_desc(int argc OVS_UNUSED, char *argv[])
504 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
508 do_dump_tables(int argc OVS_UNUSED, char *argv[])
510 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
513 /* Opens a connection to 'vconn_name', fetches the port structure for
514 * 'port_name' (which may be a port name or number), and copies it into
517 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
518 struct ofputil_phy_port *pp)
520 struct ofputil_switch_features features;
521 const struct ofp_switch_features *osf;
522 struct ofpbuf *request, *reply;
523 unsigned int port_no;
528 /* Try to interpret the argument as a port number. */
529 if (!str_to_uint(port_name, 10, &port_no)) {
533 /* Fetch the switch's ofp_switch_features. */
534 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
535 open_vconn(vconn_name, &vconn);
536 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
539 if (reply->size < sizeof *osf) {
540 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
541 vconn_name, reply->size);
543 error = ofputil_decode_switch_features(osf, &features, &b);
545 ovs_fatal(0, "%s: failed to decode features reply (%s)",
546 vconn_name, ofperr_to_string(error));
549 while (!ofputil_pull_switch_features_port(&b, pp)) {
550 if (port_no != UINT_MAX
551 ? port_no == pp->port_no
552 : !strcmp(pp->name, port_name)) {
553 ofpbuf_delete(reply);
558 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
561 /* Returns the port number corresponding to 'port_name' (which may be a port
562 * name or number) within the switch 'vconn_name'. */
564 str_to_port_no(const char *vconn_name, const char *port_name)
566 unsigned int port_no;
568 if (str_to_uint(port_name, 10, &port_no)) {
571 struct ofputil_phy_port pp;
573 fetch_ofputil_phy_port(vconn_name, port_name, &pp);
579 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
580 enum ofputil_protocol *cur)
583 struct ofpbuf *request, *reply;
584 enum ofputil_protocol next;
586 request = ofputil_encode_set_protocol(*cur, want, &next);
591 run(vconn_transact_noreply(vconn, request, &reply),
592 "talking to %s", vconn_get_name(vconn));
594 char *s = ofp_to_string(reply->data, reply->size, 2);
595 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
596 vconn_get_name(vconn), s);
598 ofpbuf_delete(reply);
606 static enum ofputil_protocol
607 set_protocol_for_flow_dump(struct vconn *vconn,
608 enum ofputil_protocol cur_protocol,
609 enum ofputil_protocol usable_protocols)
614 for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
615 enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
616 if (f & usable_protocols & allowed_protocols
617 && try_set_protocol(vconn, f, &cur_protocol)) {
622 usable_s = ofputil_protocols_to_string(usable_protocols);
623 if (usable_protocols & allowed_protocols) {
624 ovs_fatal(0, "switch does not support any of the usable flow "
625 "formats (%s)", usable_s);
627 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
628 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
629 "allowed flow formats (%s)", usable_s, allowed_s);
634 do_dump_flows__(int argc, char *argv[], bool aggregate)
636 enum ofputil_protocol usable_protocols, protocol;
637 struct ofputil_flow_stats_request fsr;
638 struct ofpbuf *request;
641 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
642 usable_protocols = ofputil_flow_stats_request_usable_protocols(&fsr);
644 protocol = open_vconn(argv[1], &vconn);
645 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
646 request = ofputil_encode_flow_stats_request(&fsr, protocol);
647 dump_stats_transaction(argv[1], request);
652 do_dump_flows(int argc, char *argv[])
654 return do_dump_flows__(argc, argv, false);
658 do_dump_aggregate(int argc, char *argv[])
660 return do_dump_flows__(argc, argv, true);
664 do_queue_stats(int argc, char *argv[])
666 struct ofp_queue_stats_request *req;
667 struct ofpbuf *request;
669 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
671 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
672 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
674 req->port_no = htons(OFPP_ALL);
676 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
677 req->queue_id = htonl(atoi(argv[3]));
679 req->queue_id = htonl(OFPQ_ALL);
682 memset(req->pad, 0, sizeof req->pad);
684 dump_stats_transaction(argv[1], request);
687 static enum ofputil_protocol
688 open_vconn_for_flow_mod(const char *remote,
689 const struct ofputil_flow_mod *fms, size_t n_fms,
690 struct vconn **vconnp)
692 enum ofputil_protocol usable_protocols;
693 enum ofputil_protocol cur_protocol;
697 /* Figure out what flow formats will work. */
698 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
699 if (!(usable_protocols & allowed_protocols)) {
700 char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
701 usable_s = ofputil_protocols_to_string(usable_protocols);
702 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
703 "allowed flow formats (%s)", usable_s, allowed_s);
706 /* If the initial flow format is allowed and usable, keep it. */
707 cur_protocol = open_vconn(remote, vconnp);
708 if (usable_protocols & allowed_protocols & cur_protocol) {
712 /* Otherwise try each flow format in turn. */
713 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
714 enum ofputil_protocol f = 1 << i;
716 if (f != cur_protocol
717 && f & usable_protocols & allowed_protocols
718 && try_set_protocol(*vconnp, f, &cur_protocol)) {
723 usable_s = ofputil_protocols_to_string(usable_protocols);
724 ovs_fatal(0, "switch does not support any of the usable flow "
725 "formats (%s)", usable_s);
729 do_flow_mod__(const char *remote, struct ofputil_flow_mod *fms, size_t n_fms)
731 enum ofputil_protocol protocol;
735 protocol = open_vconn_for_flow_mod(remote, fms, n_fms, &vconn);
737 for (i = 0; i < n_fms; i++) {
738 struct ofputil_flow_mod *fm = &fms[i];
740 transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
747 do_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
749 struct ofputil_flow_mod *fms = NULL;
752 parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms);
753 do_flow_mod__(argv[1], fms, n_fms);
758 do_flow_mod(int argc, char *argv[], uint16_t command)
760 if (argc > 2 && !strcmp(argv[2], "-")) {
761 do_flow_mod_file(argc, argv, command);
763 struct ofputil_flow_mod fm;
764 parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command, false);
765 do_flow_mod__(argv[1], &fm, 1);
770 do_add_flow(int argc, char *argv[])
772 do_flow_mod(argc, argv, OFPFC_ADD);
776 do_add_flows(int argc, char *argv[])
778 do_flow_mod_file(argc, argv, OFPFC_ADD);
782 do_mod_flows(int argc, char *argv[])
784 do_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
788 do_del_flows(int argc, char *argv[])
790 do_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
794 set_packet_in_format(struct vconn *vconn,
795 enum nx_packet_in_format packet_in_format)
797 struct ofpbuf *spif = ofputil_make_set_packet_in_format(packet_in_format);
798 transact_noreply(vconn, spif);
799 VLOG_DBG("%s: using user-specified packet in format %s",
800 vconn_get_name(vconn),
801 ofputil_packet_in_format_to_string(packet_in_format));
805 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
807 struct ofp_switch_config config;
808 enum ofp_config_flags flags;
810 fetch_switch_config(vconn, &config);
811 flags = ntohs(config.flags);
812 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
813 /* Set the invalid ttl config. */
814 flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
816 config.flags = htons(flags);
817 set_switch_config(vconn, &config);
819 /* Then retrieve the configuration to see if it really took. OpenFlow
820 * doesn't define error reporting for bad modes, so this is all we can
822 fetch_switch_config(vconn, &config);
823 flags = ntohs(config.flags);
824 if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
825 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
826 "switch probably doesn't support mode)");
833 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
834 * caller must free '*msgp'. On success, returns NULL. On failure, returns
835 * an error message and stores NULL in '*msgp'. */
837 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
839 struct ofp_header *oh;
842 msg = ofpbuf_new(strlen(hex) / 2);
845 if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
847 return "Trailing garbage in hex data";
850 if (msg->size < sizeof(struct ofp_header)) {
852 return "Message too short for OpenFlow";
856 if (msg->size != ntohs(oh->length)) {
858 return "Message size does not match length in OpenFlow header";
866 ofctl_send(struct unixctl_conn *conn, int argc,
867 const char *argv[], void *vconn_)
869 struct vconn *vconn = vconn_;
876 for (i = 1; i < argc; i++) {
877 const char *error_msg;
881 error_msg = openflow_from_hex(argv[i], &msg);
883 ds_put_format(&reply, "%s\n", error_msg);
888 fprintf(stderr, "send: ");
889 ofp_print(stderr, msg->data, msg->size, verbosity);
891 error = vconn_send_block(vconn, msg);
894 ds_put_format(&reply, "%s\n", strerror(error));
897 ds_put_cstr(&reply, "sent\n");
902 unixctl_command_reply(conn, ds_cstr(&reply));
904 unixctl_command_reply_error(conn, ds_cstr(&reply));
910 struct vconn *vconn; /* OpenFlow connection for sending barrier. */
911 struct unixctl_conn *conn; /* Connection waiting for barrier response. */
915 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
916 const char *argv[] OVS_UNUSED, void *aux_)
918 struct barrier_aux *aux = aux_;
923 unixctl_command_reply_error(conn, "already waiting for barrier reply");
927 msg = ofputil_encode_barrier_request();
928 error = vconn_send_block(aux->vconn, msg);
931 unixctl_command_reply_error(conn, strerror(error));
938 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
939 const char *argv[], void *aux OVS_UNUSED)
943 fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
945 unixctl_command_reply_error(conn, strerror(errno));
950 dup2(fd, STDERR_FILENO);
952 unixctl_command_reply(conn, NULL);
956 monitor_vconn(struct vconn *vconn)
958 struct barrier_aux barrier_aux = { vconn, NULL };
959 struct unixctl_server *server;
960 bool exiting = false;
963 daemon_save_fd(STDERR_FILENO);
965 error = unixctl_server_create(NULL, &server);
967 ovs_fatal(error, "failed to create unixctl server");
969 unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
970 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
972 unixctl_command_register("ofctl/barrier", "", 0, 0,
973 ofctl_barrier, &barrier_aux);
974 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
975 ofctl_set_output_file, NULL);
976 daemonize_complete();
982 unixctl_server_run(server);
987 retval = vconn_recv(vconn, &b);
988 if (retval == EAGAIN) {
991 run(retval, "vconn_recv");
994 time_t now = time_wall();
997 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S: ", localtime(&now));
1001 msg_type = ((const struct ofp_header *) b->data)->type;
1002 ofp_print(stderr, b->data, b->size, verbosity + 2);
1005 if (barrier_aux.conn && msg_type == OFPT10_BARRIER_REPLY) {
1006 unixctl_command_reply(barrier_aux.conn, NULL);
1007 barrier_aux.conn = NULL;
1016 vconn_run_wait(vconn);
1017 vconn_recv_wait(vconn);
1018 unixctl_server_wait(server);
1022 unixctl_server_destroy(server);
1026 do_monitor(int argc, char *argv[])
1028 struct vconn *vconn;
1030 open_vconn(argv[1], &vconn);
1032 struct ofp_switch_config config;
1034 fetch_switch_config(vconn, &config);
1035 config.miss_send_len = htons(atoi(argv[2]));
1036 set_switch_config(vconn, &config);
1039 if (!strcmp(argv[3], "invalid_ttl")) {
1040 monitor_set_invalid_ttl_to_controller(vconn);
1043 if (preferred_packet_in_format >= 0) {
1044 set_packet_in_format(vconn, preferred_packet_in_format);
1046 struct ofpbuf *spif, *reply;
1048 spif = ofputil_make_set_packet_in_format(NXPIF_NXM);
1049 run(vconn_transact_noreply(vconn, spif, &reply),
1050 "talking to %s", vconn_get_name(vconn));
1052 char *s = ofp_to_string(reply->data, reply->size, 2);
1053 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1054 " replied: %s. Falling back to the switch default.",
1055 vconn_get_name(vconn), s);
1057 ofpbuf_delete(reply);
1061 monitor_vconn(vconn);
1065 do_snoop(int argc OVS_UNUSED, char *argv[])
1067 struct vconn *vconn;
1069 open_vconn__(argv[1], "snoop", &vconn);
1070 monitor_vconn(vconn);
1074 do_dump_ports(int argc, char *argv[])
1076 struct ofp_port_stats_request *req;
1077 struct ofpbuf *request;
1080 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
1081 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
1082 req->port_no = htons(port);
1083 dump_stats_transaction(argv[1], request);
1087 do_probe(int argc OVS_UNUSED, char *argv[])
1089 struct ofpbuf *request;
1090 struct vconn *vconn;
1091 struct ofpbuf *reply;
1093 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
1094 open_vconn(argv[1], &vconn);
1095 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1096 if (reply->size != sizeof(struct ofp_header)) {
1097 ovs_fatal(0, "reply does not match request");
1099 ofpbuf_delete(reply);
1104 do_packet_out(int argc, char *argv[])
1106 struct ofputil_packet_out po;
1107 struct ofpbuf actions;
1108 struct vconn *vconn;
1111 ofpbuf_init(&actions, sizeof(union ofp_action));
1112 parse_ofp_actions(argv[3], &actions);
1114 po.buffer_id = UINT32_MAX;
1115 po.in_port = (!strcasecmp(argv[2], "none") ? OFPP_NONE
1116 : !strcasecmp(argv[2], "local") ? OFPP_LOCAL
1117 : str_to_port_no(argv[1], argv[2]));
1118 po.actions = actions.data;
1119 po.n_actions = actions.size / sizeof(union ofp_action);
1121 open_vconn(argv[1], &vconn);
1122 for (i = 4; i < argc; i++) {
1123 struct ofpbuf *packet, *opo;
1124 const char *error_msg;
1126 error_msg = eth_from_hex(argv[i], &packet);
1128 ovs_fatal(0, "%s", error_msg);
1131 po.packet = packet->data;
1132 po.packet_len = packet->size;
1133 opo = ofputil_encode_packet_out(&po);
1134 transact_noreply(vconn, opo);
1135 ofpbuf_delete(packet);
1141 do_mod_port(int argc OVS_UNUSED, char *argv[])
1143 enum ofputil_protocol protocol;
1144 struct ofputil_port_mod pm;
1145 struct ofputil_phy_port pp;
1146 struct vconn *vconn;
1148 fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1150 pm.port_no = pp.port_no;
1151 memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1156 if (!strcasecmp(argv[3], "up")) {
1157 pm.mask |= OFPUTIL_PC_PORT_DOWN;
1158 } else if (!strcasecmp(argv[3], "down")) {
1159 pm.mask |= OFPUTIL_PC_PORT_DOWN;
1160 pm.config |= OFPUTIL_PC_PORT_DOWN;
1161 } else if (!strcasecmp(argv[3], "flood")) {
1162 pm.mask |= OFPUTIL_PC_NO_FLOOD;
1163 } else if (!strcasecmp(argv[3], "noflood")) {
1164 pm.mask |= OFPUTIL_PC_NO_FLOOD;
1165 pm.config |= OFPUTIL_PC_NO_FLOOD;
1166 } else if (!strcasecmp(argv[3], "forward")) {
1167 pm.mask |= OFPUTIL_PC_NO_FWD;
1168 } else if (!strcasecmp(argv[3], "noforward")) {
1169 pm.mask |= OFPUTIL_PC_NO_FWD;
1170 pm.config |= OFPUTIL_PC_NO_FWD;
1172 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1175 protocol = open_vconn(argv[1], &vconn);
1176 transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1181 do_get_frags(int argc OVS_UNUSED, char *argv[])
1183 struct ofp_switch_config config;
1184 struct vconn *vconn;
1186 open_vconn(argv[1], &vconn);
1187 fetch_switch_config(vconn, &config);
1188 puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1193 do_set_frags(int argc OVS_UNUSED, char *argv[])
1195 struct ofp_switch_config config;
1196 enum ofp_config_flags mode;
1197 struct vconn *vconn;
1200 if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1201 ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1204 open_vconn(argv[1], &vconn);
1205 fetch_switch_config(vconn, &config);
1206 flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1207 if (flags != config.flags) {
1208 /* Set the configuration. */
1209 config.flags = flags;
1210 set_switch_config(vconn, &config);
1212 /* Then retrieve the configuration to see if it really took. OpenFlow
1213 * doesn't define error reporting for bad modes, so this is all we can
1215 fetch_switch_config(vconn, &config);
1216 if (flags != config.flags) {
1217 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1218 "switch probably doesn't support mode \"%s\")",
1219 argv[1], ofputil_frag_handling_to_string(mode));
1226 do_ping(int argc, char *argv[])
1228 size_t max_payload = 65535 - sizeof(struct ofp_header);
1229 unsigned int payload;
1230 struct vconn *vconn;
1233 payload = argc > 2 ? atoi(argv[2]) : 64;
1234 if (payload > max_payload) {
1235 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1238 open_vconn(argv[1], &vconn);
1239 for (i = 0; i < 10; i++) {
1240 struct timeval start, end;
1241 struct ofpbuf *request, *reply;
1242 struct ofp_header *rq_hdr, *rpy_hdr;
1244 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1245 OFPT_ECHO_REQUEST, &request);
1246 random_bytes(rq_hdr + 1, payload);
1248 xgettimeofday(&start);
1249 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1250 xgettimeofday(&end);
1252 rpy_hdr = reply->data;
1253 if (reply->size != request->size
1254 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1255 || rpy_hdr->xid != rq_hdr->xid
1256 || rpy_hdr->type != OFPT_ECHO_REPLY) {
1257 printf("Reply does not match request. Request:\n");
1258 ofp_print(stdout, request, request->size, verbosity + 2);
1260 ofp_print(stdout, reply, reply->size, verbosity + 2);
1262 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1263 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
1264 (1000*(double)(end.tv_sec - start.tv_sec))
1265 + (.001*(end.tv_usec - start.tv_usec)));
1266 ofpbuf_delete(request);
1267 ofpbuf_delete(reply);
1273 do_benchmark(int argc OVS_UNUSED, char *argv[])
1275 size_t max_payload = 65535 - sizeof(struct ofp_header);
1276 struct timeval start, end;
1277 unsigned int payload_size, message_size;
1278 struct vconn *vconn;
1283 payload_size = atoi(argv[2]);
1284 if (payload_size > max_payload) {
1285 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1287 message_size = sizeof(struct ofp_header) + payload_size;
1289 count = atoi(argv[3]);
1291 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1292 count, message_size, count * message_size);
1294 open_vconn(argv[1], &vconn);
1295 xgettimeofday(&start);
1296 for (i = 0; i < count; i++) {
1297 struct ofpbuf *request, *reply;
1298 struct ofp_header *rq_hdr;
1300 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1301 memset(rq_hdr + 1, 0, payload_size);
1302 run(vconn_transact(vconn, request, &reply), "transact");
1303 ofpbuf_delete(reply);
1305 xgettimeofday(&end);
1308 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1309 + (.001*(end.tv_usec - start.tv_usec)));
1310 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1311 duration, count / (duration / 1000.0),
1312 count * message_size / (duration / 1000.0));
1316 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1321 /* replace-flows and diff-flows commands. */
1323 /* A flow table entry, possibly with two different versions. */
1325 struct cls_rule rule; /* Within a "struct classifier". */
1326 struct fte_version *versions[2];
1329 /* One version of a Flow Table Entry. */
1330 struct fte_version {
1332 uint16_t idle_timeout;
1333 uint16_t hard_timeout;
1335 union ofp_action *actions;
1339 /* Frees 'version' and the data that it owns. */
1341 fte_version_free(struct fte_version *version)
1344 free(version->actions);
1349 /* Returns true if 'a' and 'b' are the same, false if they differ.
1351 * Ignores differences in 'flags' because there's no way to retrieve flags from
1352 * an OpenFlow switch. We have to assume that they are the same. */
1354 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1356 return (a->cookie == b->cookie
1357 && a->idle_timeout == b->idle_timeout
1358 && a->hard_timeout == b->hard_timeout
1359 && a->n_actions == b->n_actions
1360 && !memcmp(a->actions, b->actions,
1361 a->n_actions * sizeof *a->actions));
1364 /* Prints 'version' on stdout. Expects the caller to have printed the rule
1365 * associated with the version. */
1367 fte_version_print(const struct fte_version *version)
1371 if (version->cookie != htonll(0)) {
1372 printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
1374 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1375 printf(" idle_timeout=%"PRIu16, version->idle_timeout);
1377 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1378 printf(" hard_timeout=%"PRIu16, version->hard_timeout);
1382 ofp_print_actions(&s, version->actions, version->n_actions);
1383 printf(" %s\n", ds_cstr(&s));
1388 fte_from_cls_rule(const struct cls_rule *cls_rule)
1390 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1393 /* Frees 'fte' and its versions. */
1395 fte_free(struct fte *fte)
1398 fte_version_free(fte->versions[0]);
1399 fte_version_free(fte->versions[1]);
1404 /* Frees all of the FTEs within 'cls'. */
1406 fte_free_all(struct classifier *cls)
1408 struct cls_cursor cursor;
1409 struct fte *fte, *next;
1411 cls_cursor_init(&cursor, cls, NULL);
1412 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1413 classifier_remove(cls, &fte->rule);
1418 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1419 * necessary. Sets 'version' as the version of that rule with the given
1420 * 'index', replacing any existing version, if any.
1422 * Takes ownership of 'version'. */
1424 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1425 struct fte_version *version, int index)
1427 struct fte *old, *fte;
1429 fte = xzalloc(sizeof *fte);
1431 fte->versions[index] = version;
1433 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1435 fte_version_free(old->versions[index]);
1436 fte->versions[!index] = old->versions[!index];
1441 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1442 * with the specified 'index'. Returns the flow formats able to represent the
1443 * flows that were read. */
1444 static enum ofputil_protocol
1445 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1447 enum ofputil_protocol usable_protocols;
1451 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1453 ovs_fatal(errno, "%s: open", filename);
1457 usable_protocols = OFPUTIL_P_ANY;
1458 while (!ds_get_preprocessed_line(&s, file)) {
1459 struct fte_version *version;
1460 struct ofputil_flow_mod fm;
1462 parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1464 version = xmalloc(sizeof *version);
1465 version->cookie = fm.cookie;
1466 version->idle_timeout = fm.idle_timeout;
1467 version->hard_timeout = fm.hard_timeout;
1468 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1469 version->actions = fm.actions;
1470 version->n_actions = fm.n_actions;
1472 usable_protocols &= ofputil_usable_protocols(&fm.cr);
1474 fte_insert(cls, &fm.cr, version, index);
1478 if (file != stdin) {
1482 return usable_protocols;
1485 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1486 * format 'protocol', and adds them as flow table entries in 'cls' for the
1487 * version with the specified 'index'. */
1489 read_flows_from_switch(struct vconn *vconn,
1490 enum ofputil_protocol protocol,
1491 struct classifier *cls, int index)
1493 struct ofputil_flow_stats_request fsr;
1494 struct ofpbuf *request;
1498 fsr.aggregate = false;
1499 cls_rule_init_catchall(&fsr.match, 0);
1500 fsr.out_port = OFPP_NONE;
1501 fsr.table_id = 0xff;
1502 fsr.cookie = fsr.cookie_mask = htonll(0);
1503 request = ofputil_encode_flow_stats_request(&fsr, protocol);
1504 send_xid = ((struct ofp_header *) request->data)->xid;
1505 send_openflow_buffer(vconn, request);
1510 struct ofpbuf *reply;
1512 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1513 recv_xid = ((struct ofp_header *) reply->data)->xid;
1514 if (send_xid == recv_xid) {
1515 const struct ofputil_msg_type *type;
1516 const struct ofp_stats_msg *osm;
1517 enum ofputil_msg_code code;
1519 ofputil_decode_msg_type(reply->data, &type);
1520 code = ofputil_msg_type_code(type);
1521 if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1522 code != OFPUTIL_NXST_FLOW_REPLY) {
1523 ovs_fatal(0, "received bad reply: %s",
1524 ofp_to_string(reply->data, reply->size,
1529 if (!(osm->flags & htons(OFPSF_REPLY_MORE))) {
1534 struct fte_version *version;
1535 struct ofputil_flow_stats fs;
1538 retval = ofputil_decode_flow_stats_reply(&fs, reply, false);
1540 if (retval != EOF) {
1541 ovs_fatal(0, "parse error in reply");
1546 version = xmalloc(sizeof *version);
1547 version->cookie = fs.cookie;
1548 version->idle_timeout = fs.idle_timeout;
1549 version->hard_timeout = fs.hard_timeout;
1551 version->n_actions = fs.n_actions;
1552 version->actions = xmemdup(fs.actions,
1553 fs.n_actions * sizeof *fs.actions);
1555 fte_insert(cls, &fs.rule, version, index);
1558 VLOG_DBG("received reply with xid %08"PRIx32" "
1559 "!= expected %08"PRIx32, recv_xid, send_xid);
1561 ofpbuf_delete(reply);
1566 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1567 enum ofputil_protocol protocol, struct list *packets)
1569 const struct fte_version *version = fte->versions[index];
1570 struct ofputil_flow_mod fm;
1574 fm.cookie = version->cookie;
1576 fm.command = command;
1577 fm.idle_timeout = version->idle_timeout;
1578 fm.hard_timeout = version->hard_timeout;
1579 fm.buffer_id = UINT32_MAX;
1580 fm.out_port = OFPP_NONE;
1581 fm.flags = version->flags;
1582 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1583 command == OFPFC_MODIFY_STRICT) {
1584 fm.actions = version->actions;
1585 fm.n_actions = version->n_actions;
1591 ofm = ofputil_encode_flow_mod(&fm, protocol);
1592 list_push_back(packets, &ofm->list_node);
1596 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1598 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1599 enum ofputil_protocol usable_protocols, protocol;
1600 struct cls_cursor cursor;
1601 struct classifier cls;
1602 struct list requests;
1603 struct vconn *vconn;
1606 classifier_init(&cls);
1607 usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
1609 protocol = open_vconn(argv[1], &vconn);
1610 protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
1612 read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
1614 list_init(&requests);
1616 /* Delete flows that exist on the switch but not in the file. */
1617 cls_cursor_init(&cursor, &cls, NULL);
1618 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1619 struct fte_version *file_ver = fte->versions[FILE_IDX];
1620 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1622 if (sw_ver && !file_ver) {
1623 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1624 protocol, &requests);
1628 /* Add flows that exist in the file but not on the switch.
1629 * Update flows that exist in both places but differ. */
1630 cls_cursor_init(&cursor, &cls, NULL);
1631 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1632 struct fte_version *file_ver = fte->versions[FILE_IDX];
1633 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1636 && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1637 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
1640 transact_multiple_noreply(vconn, &requests);
1647 read_flows_from_source(const char *source, struct classifier *cls, int index)
1651 if (source[0] == '/' || source[0] == '.'
1652 || (!strchr(source, ':') && !stat(source, &s))) {
1653 read_flows_from_file(source, cls, index);
1655 enum ofputil_protocol protocol;
1656 struct vconn *vconn;
1658 protocol = open_vconn(source, &vconn);
1659 protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
1660 read_flows_from_switch(vconn, protocol, cls, index);
1666 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1668 bool differences = false;
1669 struct cls_cursor cursor;
1670 struct classifier cls;
1673 classifier_init(&cls);
1674 read_flows_from_source(argv[1], &cls, 0);
1675 read_flows_from_source(argv[2], &cls, 1);
1677 cls_cursor_init(&cursor, &cls, NULL);
1678 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1679 struct fte_version *a = fte->versions[0];
1680 struct fte_version *b = fte->versions[1];
1682 if (!a || !b || !fte_version_equals(a, b)) {
1683 char *rule_s = cls_rule_to_string(&fte->rule);
1685 printf("-%s", rule_s);
1686 fte_version_print(a);
1689 printf("+%s", rule_s);
1690 fte_version_print(b);
1705 /* Undocumented commands for unit testing. */
1708 do_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms)
1710 enum ofputil_protocol usable_protocols;
1711 enum ofputil_protocol protocol = 0;
1715 usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
1716 usable_s = ofputil_protocols_to_string(usable_protocols);
1717 printf("usable protocols: %s\n", usable_s);
1720 if (!(usable_protocols & allowed_protocols)) {
1721 ovs_fatal(0, "no usable protocol");
1723 for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1725 if (protocol & usable_protocols & allowed_protocols) {
1729 assert(IS_POW2(protocol));
1731 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
1733 for (i = 0; i < n_fms; i++) {
1734 struct ofputil_flow_mod *fm = &fms[i];
1737 msg = ofputil_encode_flow_mod(fm, protocol);
1738 ofp_print(stdout, msg->data, msg->size, verbosity);
1745 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1746 * it back to stdout. */
1748 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1750 struct ofputil_flow_mod fm;
1752 parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, false);
1753 do_parse_flows__(&fm, 1);
1756 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1757 * add-flows) and prints each of the flows back to stdout. */
1759 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1761 struct ofputil_flow_mod *fms = NULL;
1764 parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms);
1765 do_parse_flows__(fms, n_fms);
1769 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1770 * stdin, does some internal fussing with them, and then prints them back as
1771 * strings on stdout. */
1773 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1778 while (!ds_get_line(&in, stdin)) {
1779 struct ofpbuf nx_match;
1780 struct cls_rule rule;
1781 ovs_be64 cookie, cookie_mask;
1786 /* Delete comments, skip blank lines. */
1792 if (strchr(s, '#')) {
1793 *strchr(s, '#') = '\0';
1795 if (s[strspn(s, " ")] == '\0') {
1800 /* Convert string to nx_match. */
1801 ofpbuf_init(&nx_match, 0);
1802 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1804 /* Convert nx_match to cls_rule. */
1806 error = nx_pull_match(&nx_match, match_len, 0, &rule,
1807 &cookie, &cookie_mask);
1809 error = nx_pull_match_loose(&nx_match, match_len, 0, &rule,
1810 &cookie, &cookie_mask);
1816 /* Convert cls_rule back to nx_match. */
1817 ofpbuf_uninit(&nx_match);
1818 ofpbuf_init(&nx_match, 0);
1819 match_len = nx_put_match(&nx_match, &rule, cookie, cookie_mask);
1821 /* Convert nx_match to string. */
1822 out = nx_match_to_string(nx_match.data, match_len);
1826 printf("nx_pull_match() returned error %s\n",
1827 ofperr_get_name(error));
1830 ofpbuf_uninit(&nx_match);
1835 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1836 * binary data, interpreting them as an OpenFlow message, and prints the
1837 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1839 do_ofp_print(int argc, char *argv[])
1841 struct ofpbuf packet;
1843 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1844 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1845 ovs_fatal(0, "trailing garbage following hex bytes");
1847 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1848 ofpbuf_uninit(&packet);
1851 static const struct command all_commands[] = {
1852 { "show", 1, 1, do_show },
1853 { "monitor", 1, 3, do_monitor },
1854 { "snoop", 1, 1, do_snoop },
1855 { "dump-desc", 1, 1, do_dump_desc },
1856 { "dump-tables", 1, 1, do_dump_tables },
1857 { "dump-flows", 1, 2, do_dump_flows },
1858 { "dump-aggregate", 1, 2, do_dump_aggregate },
1859 { "queue-stats", 1, 3, do_queue_stats },
1860 { "add-flow", 2, 2, do_add_flow },
1861 { "add-flows", 2, 2, do_add_flows },
1862 { "mod-flows", 2, 2, do_mod_flows },
1863 { "del-flows", 1, 2, do_del_flows },
1864 { "replace-flows", 2, 2, do_replace_flows },
1865 { "diff-flows", 2, 2, do_diff_flows },
1866 { "packet-out", 4, INT_MAX, do_packet_out },
1867 { "dump-ports", 1, 2, do_dump_ports },
1868 { "mod-port", 3, 3, do_mod_port },
1869 { "get-frags", 1, 1, do_get_frags },
1870 { "set-frags", 2, 2, do_set_frags },
1871 { "probe", 1, 1, do_probe },
1872 { "ping", 1, 2, do_ping },
1873 { "benchmark", 3, 3, do_benchmark },
1874 { "help", 0, INT_MAX, do_help },
1876 /* Undocumented commands for testing. */
1877 { "parse-flow", 1, 1, do_parse_flow },
1878 { "parse-flows", 1, 1, do_parse_flows },
1879 { "parse-nx-match", 0, 0, do_parse_nx_match },
1880 { "ofp-print", 1, 2, do_ofp_print },
1882 { NULL, 0, 0, NULL },