2 * Copyright (c) 2008, 2009, 2010, 2011 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>
30 #include "byte-order.h"
31 #include "classifier.h"
32 #include "command-line.h"
35 #include "dynamic-string.h"
39 #include "ofp-parse.h"
40 #include "ofp-print.h"
43 #include "ofproto/ofproto.h"
44 #include "openflow/nicira-ext.h"
45 #include "openflow/openflow.h"
47 #include "stream-ssl.h"
53 VLOG_DEFINE_THIS_MODULE(ofctl);
55 /* --strict: Use strict matching for flow mod commands? */
58 /* -F, --flow-format: Flow format to use. Either one of NXFF_* to force a
59 * particular flow format or -1 to let ovs-ofctl choose intelligently. */
60 static int preferred_flow_format = -1;
62 /* -m, --more: Additional verbosity for ofp-print functions. */
65 static const struct command all_commands[];
67 static void usage(void) NO_RETURN;
68 static void parse_options(int argc, char *argv[]);
71 main(int argc, char *argv[])
73 set_program_name(argv[0]);
74 parse_options(argc, argv);
75 signal(SIGPIPE, SIG_IGN);
76 run_command(argc - optind, argv + optind, all_commands);
81 parse_options(int argc, char *argv[])
84 OPT_STRICT = UCHAR_MAX + 1,
87 static struct option long_options[] = {
88 {"timeout", required_argument, 0, 't'},
89 {"strict", no_argument, 0, OPT_STRICT},
90 {"flow-format", required_argument, 0, 'F'},
91 {"more", no_argument, 0, 'm'},
92 {"help", no_argument, 0, 'h'},
93 {"version", no_argument, 0, 'V'},
95 STREAM_SSL_LONG_OPTIONS
98 char *short_options = long_options_to_short_options(long_options);
101 unsigned long int timeout;
104 c = getopt_long(argc, argv, short_options, long_options, NULL);
111 timeout = strtoul(optarg, NULL, 10);
113 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
121 preferred_flow_format = ofputil_flow_format_from_string(optarg);
122 if (preferred_flow_format < 0) {
123 ovs_fatal(0, "unknown flow format `%s'", optarg);
135 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
143 STREAM_SSL_OPTION_HANDLERS
158 printf("%s: OpenFlow switch management utility\n"
159 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
160 "\nFor OpenFlow switches:\n"
161 " show SWITCH show OpenFlow information\n"
162 " dump-desc SWITCH print switch description\n"
163 " dump-tables SWITCH print table stats\n"
164 " mod-port SWITCH IFACE ACT modify port behavior\n"
165 " dump-ports SWITCH [PORT] print port statistics\n"
166 " dump-flows SWITCH print all flow entries\n"
167 " dump-flows SWITCH FLOW print matching FLOWs\n"
168 " dump-aggregate SWITCH print aggregate flow statistics\n"
169 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
170 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
171 " add-flow SWITCH FLOW add flow described by FLOW\n"
172 " add-flows SWITCH FILE add flows from FILE\n"
173 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
174 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
175 " monitor SWITCH [MISSLEN] print packets received from SWITCH\n"
176 "\nFor OpenFlow switches and controllers:\n"
177 " probe VCONN probe whether VCONN is up\n"
178 " ping VCONN [N] latency of N-byte echos\n"
179 " benchmark VCONN N COUNT bandwidth of COUNT N-byte echos\n"
180 "where each SWITCH is an active OpenFlow connection method.\n",
181 program_name, program_name);
182 vconn_usage(true, false, false);
184 printf("\nOther options:\n"
185 " --strict use strict match for flow commands\n"
186 " -F, --flow-format=FORMAT force particular flow format\n"
187 " -m, --more be more verbose printing OpenFlow\n"
188 " -t, --timeout=SECS give up after SECS seconds\n"
189 " -h, --help display this help message\n"
190 " -V, --version display version information\n");
194 static void run(int retval, const char *message, ...)
197 static void run(int retval, const char *message, ...)
202 va_start(args, message);
203 ovs_fatal_valist(retval, message, args);
207 /* Generic commands. */
210 open_vconn_socket(const char *name, struct vconn **vconnp)
212 char *vconn_name = xasprintf("unix:%s", name);
213 VLOG_DBG("connecting to %s", vconn_name);
214 run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
215 "connecting to %s", vconn_name);
220 open_vconn__(const char *name, const char *default_suffix,
221 struct vconn **vconnp)
223 char *datapath_name, *datapath_type, *socket_name;
227 bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
229 ofproto_parse_name(name, &datapath_name, &datapath_type);
230 socket_name = xasprintf("%s/%s.%s",
231 ovs_rundir(), datapath_name, default_suffix);
235 if (strstr(name, ":")) {
236 run(vconn_open_block(name, OFP_VERSION, vconnp),
237 "connecting to %s", name);
238 } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
239 open_vconn_socket(name, vconnp);
240 } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
241 open_vconn_socket(bridge_path, vconnp);
242 } else if (!stat(socket_name, &s)) {
243 if (!S_ISSOCK(s.st_mode)) {
244 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
247 open_vconn_socket(socket_name, vconnp);
249 ovs_fatal(0, "%s is not a valid connection method", name);
257 open_vconn(const char *name, struct vconn **vconnp)
259 return open_vconn__(name, "mgmt", vconnp);
263 alloc_stats_request(size_t body_len, uint16_t type, struct ofpbuf **bufferp)
265 struct ofp_stats_request *rq;
266 rq = make_openflow((offsetof(struct ofp_stats_request, body)
267 + body_len), OFPT_STATS_REQUEST, bufferp);
268 rq->type = htons(type);
269 rq->flags = htons(0);
274 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
276 update_openflow_length(buffer);
277 run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
281 dump_transaction(const char *vconn_name, struct ofpbuf *request)
284 struct ofpbuf *reply;
286 update_openflow_length(request);
287 open_vconn(vconn_name, &vconn);
288 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
289 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
294 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
296 struct ofpbuf *request;
297 make_openflow(sizeof(struct ofp_header), request_type, &request);
298 dump_transaction(vconn_name, request);
302 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
304 ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
308 open_vconn(vconn_name, &vconn);
309 send_openflow_buffer(vconn, request);
312 struct ofpbuf *reply;
314 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
315 recv_xid = ((struct ofp_header *) reply->data)->xid;
316 if (send_xid == recv_xid) {
317 struct ofp_stats_reply *osr;
319 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
321 osr = ofpbuf_at(reply, 0, sizeof *osr);
322 done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
324 VLOG_DBG("received reply with xid %08"PRIx32" "
325 "!= expected %08"PRIx32, recv_xid, send_xid);
327 ofpbuf_delete(reply);
333 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
335 struct ofpbuf *request;
336 alloc_stats_request(0, stats_type, &request);
337 dump_stats_transaction(vconn_name, request);
340 /* Sends 'request', which should be a request that only has a reply if an error
341 * occurs, and waits for it to succeed or fail. If an error does occur, prints
342 * it and exits with an error. */
344 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
346 struct ofpbuf *request, *reply;
348 LIST_FOR_EACH (request, list_node, requests) {
349 update_openflow_length(request);
352 run(vconn_transact_multiple_noreply(vconn, requests, &reply),
353 "talking to %s", vconn_get_name(vconn));
355 ofp_print(stderr, reply->data, reply->size, verbosity + 2);
358 ofpbuf_delete(reply);
361 /* Sends 'request', which should be a request that only has a reply if an error
362 * occurs, and waits for it to succeed or fail. If an error does occur, prints
363 * it and exits with an error. */
365 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
367 struct list requests;
369 list_init(&requests);
370 list_push_back(&requests, &request->list_node);
371 transact_multiple_noreply(vconn, &requests);
375 do_show(int argc OVS_UNUSED, char *argv[])
377 dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
378 dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
382 do_dump_desc(int argc OVS_UNUSED, char *argv[])
384 dump_trivial_stats_transaction(argv[1], OFPST_DESC);
388 do_dump_tables(int argc OVS_UNUSED, char *argv[])
390 dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
393 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
394 * 'port_name' (which may be a port name or number), and copies it into
397 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
398 struct ofp_phy_port *oppp)
400 struct ofpbuf *request, *reply;
401 struct ofp_switch_features *osf;
402 unsigned int port_no;
407 /* Try to interpret the argument as a port number. */
408 if (!str_to_uint(port_name, 10, &port_no)) {
412 /* Fetch the switch's ofp_switch_features. */
413 make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
414 open_vconn(vconn_name, &vconn);
415 run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
418 if (reply->size < sizeof *osf) {
419 ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
420 vconn_name, reply->size);
422 n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
424 for (port_idx = 0; port_idx < n_ports; port_idx++) {
425 const struct ofp_phy_port *opp = &osf->ports[port_idx];
427 if (port_no != UINT_MAX
428 ? htons(port_no) == opp->port_no
429 : !strncmp(opp->name, port_name, sizeof opp->name)) {
431 ofpbuf_delete(reply);
436 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
439 /* Returns the port number corresponding to 'port_name' (which may be a port
440 * name or number) within the switch 'vconn_name'. */
442 str_to_port_no(const char *vconn_name, const char *port_name)
444 unsigned int port_no;
446 if (str_to_uint(port_name, 10, &port_no)) {
449 struct ofp_phy_port opp;
451 fetch_ofp_phy_port(vconn_name, port_name, &opp);
452 return ntohs(opp.port_no);
457 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
459 struct ofpbuf *sff, *reply;
461 sff = ofputil_make_set_flow_format(flow_format);
462 run(vconn_transact_noreply(vconn, sff, &reply),
463 "talking to %s", vconn_get_name(vconn));
465 char *s = ofp_to_string(reply->data, reply->size, 2);
466 VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
467 vconn_get_name(vconn),
468 ofputil_flow_format_to_string(flow_format),
471 ofpbuf_delete(reply);
478 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
480 struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
481 transact_noreply(vconn, sff);
482 VLOG_DBG("%s: using user-specified flow format %s",
483 vconn_get_name(vconn),
484 ofputil_flow_format_to_string(flow_format));
487 static enum nx_flow_format
488 negotiate_highest_flow_format(struct vconn *vconn,
489 enum nx_flow_format min_format)
491 if (preferred_flow_format != -1) {
492 if (preferred_flow_format < min_format) {
493 ovs_fatal(0, "%s: cannot use requested flow format %s for "
494 "specified flow", vconn_get_name(vconn),
495 ofputil_flow_format_to_string(min_format));
498 set_flow_format(vconn, preferred_flow_format);
499 return preferred_flow_format;
501 enum nx_flow_format flow_format;
503 if (try_set_flow_format(vconn, NXFF_NXM)) {
504 flow_format = NXFF_NXM;
505 } else if (try_set_flow_format(vconn, NXFF_TUN_ID_FROM_COOKIE)) {
506 flow_format = NXFF_TUN_ID_FROM_COOKIE;
508 flow_format = NXFF_OPENFLOW10;
511 if (flow_format < min_format) {
512 ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
513 "%s for specified flow", vconn_get_name(vconn),
514 ofputil_flow_format_to_string(min_format));
517 VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
518 ofputil_flow_format_to_string(flow_format));
524 do_dump_flows__(int argc, char *argv[], bool aggregate)
526 enum nx_flow_format min_flow_format, flow_format;
527 struct flow_stats_request fsr;
528 struct ofpbuf *request;
531 parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
533 open_vconn(argv[1], &vconn);
534 min_flow_format = ofputil_min_flow_format(&fsr.match, false, 0);
535 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
536 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
537 dump_stats_transaction(argv[1], request);
542 do_dump_flows(int argc, char *argv[])
544 return do_dump_flows__(argc, argv, false);
548 do_dump_aggregate(int argc, char *argv[])
550 return do_dump_flows__(argc, argv, true);
554 do_queue_stats(int argc, char *argv[])
556 struct ofp_queue_stats_request *req;
557 struct ofpbuf *request;
559 req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
561 if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
562 req->port_no = htons(str_to_port_no(argv[1], argv[2]));
564 req->port_no = htons(OFPP_ALL);
566 if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
567 req->queue_id = htonl(atoi(argv[3]));
569 req->queue_id = htonl(OFPQ_ALL);
572 memset(req->pad, 0, sizeof req->pad);
574 dump_stats_transaction(argv[1], request);
577 /* Sets up the flow format for a vconn that will be used to modify the flow
578 * table. Returns the flow format used, after possibly adding an OpenFlow
579 * request to 'requests'.
581 * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
582 * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
583 * OpenFlow connection.
585 * If 'preferred_flow_format' is a specific format, adds a request to set that
586 * format to 'requests' and returns the format. */
587 static enum nx_flow_format
588 set_initial_format_for_flow_mod(struct list *requests)
590 if (preferred_flow_format < 0) {
591 return NXFF_OPENFLOW10;
595 sff = ofputil_make_set_flow_format(preferred_flow_format);
596 list_push_back(requests, &sff->list_node);
597 return preferred_flow_format;
601 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
602 * operation, given the global 'preferred_flow_format'. */
604 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
606 if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
607 ovs_fatal(0, "flow cannot be expressed in flow format %s "
608 "(flow format %s or better is required)",
609 ofputil_flow_format_to_string(preferred_flow_format),
610 ofputil_flow_format_to_string(flow_format));
615 do_flow_mod_file__(int argc OVS_UNUSED, char *argv[], uint16_t command)
617 enum nx_flow_format flow_format;
618 struct list requests;
622 file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
624 ovs_fatal(errno, "%s: open", argv[2]);
627 list_init(&requests);
628 flow_format = set_initial_format_for_flow_mod(&requests);
630 open_vconn(argv[1], &vconn);
631 while (parse_ofp_flow_mod_file(&requests, &flow_format, file, command)) {
632 check_final_format_for_flow_mod(flow_format);
633 transact_multiple_noreply(vconn, &requests);
643 do_flow_mod__(int argc, char *argv[], uint16_t command)
645 enum nx_flow_format flow_format;
646 struct list requests;
649 if (argc > 2 && !strcmp(argv[2], "-")) {
650 do_flow_mod_file__(argc, argv, command);
654 list_init(&requests);
655 flow_format = set_initial_format_for_flow_mod(&requests);
657 parse_ofp_flow_mod_str(&requests, &flow_format, argc > 2 ? argv[2] : "",
659 check_final_format_for_flow_mod(flow_format);
661 open_vconn(argv[1], &vconn);
662 transact_multiple_noreply(vconn, &requests);
667 do_add_flow(int argc, char *argv[])
669 do_flow_mod__(argc, argv, OFPFC_ADD);
673 do_add_flows(int argc, char *argv[])
675 do_flow_mod_file__(argc, argv, OFPFC_ADD);
679 do_mod_flows(int argc, char *argv[])
681 do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
685 do_del_flows(int argc, char *argv[])
687 do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
691 monitor_vconn(struct vconn *vconn)
695 run(vconn_recv_block(vconn, &b), "vconn_recv");
696 ofp_print(stderr, b->data, b->size, verbosity + 2);
702 do_monitor(int argc, char *argv[])
706 open_vconn(argv[1], &vconn);
708 int miss_send_len = atoi(argv[2]);
709 struct ofp_switch_config *osc;
712 osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
713 osc->miss_send_len = htons(miss_send_len);
714 transact_noreply(vconn, buf);
716 monitor_vconn(vconn);
720 do_snoop(int argc OVS_UNUSED, char *argv[])
724 open_vconn__(argv[1], "snoop", &vconn);
725 monitor_vconn(vconn);
729 do_dump_ports(int argc, char *argv[])
731 struct ofp_port_stats_request *req;
732 struct ofpbuf *request;
735 req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
736 port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
737 req->port_no = htons(port);
738 dump_stats_transaction(argv[1], request);
742 do_probe(int argc OVS_UNUSED, char *argv[])
744 struct ofpbuf *request;
746 struct ofpbuf *reply;
748 make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
749 open_vconn(argv[1], &vconn);
750 run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
751 if (reply->size != sizeof(struct ofp_header)) {
752 ovs_fatal(0, "reply does not match request");
754 ofpbuf_delete(reply);
759 do_mod_port(int argc OVS_UNUSED, char *argv[])
761 struct ofp_port_mod *opm;
762 struct ofp_phy_port opp;
763 struct ofpbuf *request;
766 fetch_ofp_phy_port(argv[1], argv[2], &opp);
768 opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
769 opm->port_no = opp.port_no;
770 memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
771 opm->config = htonl(0);
772 opm->mask = htonl(0);
773 opm->advertise = htonl(0);
775 if (!strcasecmp(argv[3], "up")) {
776 opm->mask |= htonl(OFPPC_PORT_DOWN);
777 } else if (!strcasecmp(argv[3], "down")) {
778 opm->mask |= htonl(OFPPC_PORT_DOWN);
779 opm->config |= htonl(OFPPC_PORT_DOWN);
780 } else if (!strcasecmp(argv[3], "flood")) {
781 opm->mask |= htonl(OFPPC_NO_FLOOD);
782 } else if (!strcasecmp(argv[3], "noflood")) {
783 opm->mask |= htonl(OFPPC_NO_FLOOD);
784 opm->config |= htonl(OFPPC_NO_FLOOD);
786 ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
789 open_vconn(argv[1], &vconn);
790 transact_noreply(vconn, request);
795 do_ping(int argc, char *argv[])
797 size_t max_payload = 65535 - sizeof(struct ofp_header);
798 unsigned int payload;
802 payload = argc > 2 ? atoi(argv[2]) : 64;
803 if (payload > max_payload) {
804 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
807 open_vconn(argv[1], &vconn);
808 for (i = 0; i < 10; i++) {
809 struct timeval start, end;
810 struct ofpbuf *request, *reply;
811 struct ofp_header *rq_hdr, *rpy_hdr;
813 rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
814 OFPT_ECHO_REQUEST, &request);
815 random_bytes(rq_hdr + 1, payload);
817 xgettimeofday(&start);
818 run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
821 rpy_hdr = reply->data;
822 if (reply->size != request->size
823 || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
824 || rpy_hdr->xid != rq_hdr->xid
825 || rpy_hdr->type != OFPT_ECHO_REPLY) {
826 printf("Reply does not match request. Request:\n");
827 ofp_print(stdout, request, request->size, verbosity + 2);
829 ofp_print(stdout, reply, reply->size, verbosity + 2);
831 printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
832 reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
833 (1000*(double)(end.tv_sec - start.tv_sec))
834 + (.001*(end.tv_usec - start.tv_usec)));
835 ofpbuf_delete(request);
836 ofpbuf_delete(reply);
842 do_benchmark(int argc OVS_UNUSED, char *argv[])
844 size_t max_payload = 65535 - sizeof(struct ofp_header);
845 struct timeval start, end;
846 unsigned int payload_size, message_size;
852 payload_size = atoi(argv[2]);
853 if (payload_size > max_payload) {
854 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
856 message_size = sizeof(struct ofp_header) + payload_size;
858 count = atoi(argv[3]);
860 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
861 count, message_size, count * message_size);
863 open_vconn(argv[1], &vconn);
864 xgettimeofday(&start);
865 for (i = 0; i < count; i++) {
866 struct ofpbuf *request, *reply;
867 struct ofp_header *rq_hdr;
869 rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
870 memset(rq_hdr + 1, 0, payload_size);
871 run(vconn_transact(vconn, request, &reply), "transact");
872 ofpbuf_delete(reply);
877 duration = ((1000*(double)(end.tv_sec - start.tv_sec))
878 + (.001*(end.tv_usec - start.tv_usec)));
879 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
880 duration, count / (duration / 1000.0),
881 count * message_size / (duration / 1000.0));
885 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
890 /* replace-flows and diff-flows commands. */
892 /* A flow table entry, possibly with two different versions. */
894 struct cls_rule rule; /* Within a "struct classifier". */
895 struct fte_version *versions[2];
898 /* One version of a Flow Table Entry. */
901 uint16_t idle_timeout;
902 uint16_t hard_timeout;
904 union ofp_action *actions;
908 /* Frees 'version' and the data that it owns. */
910 fte_version_free(struct fte_version *version)
913 free(version->actions);
918 /* Returns true if 'a' and 'b' are the same, false if they differ.
920 * Ignores differences in 'flags' because there's no way to retrieve flags from
921 * an OpenFlow switch. We have to assume that they are the same. */
923 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
925 return (a->cookie == b->cookie
926 && a->idle_timeout == b->idle_timeout
927 && a->hard_timeout == b->hard_timeout
928 && a->n_actions == b->n_actions
929 && !memcmp(a->actions, b->actions,
930 a->n_actions * sizeof *a->actions));
933 /* Prints 'version' on stdout. Expects the caller to have printed the rule
934 * associated with the version. */
936 fte_version_print(const struct fte_version *version)
940 if (version->cookie != htonll(0)) {
941 printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
943 if (version->idle_timeout != OFP_FLOW_PERMANENT) {
944 printf(" idle_timeout=%"PRIu16, version->idle_timeout);
946 if (version->hard_timeout != OFP_FLOW_PERMANENT) {
947 printf(" hard_timeout=%"PRIu16, version->hard_timeout);
951 ofp_print_actions(&s, (const struct ofp_action_header *) version->actions,
952 version->n_actions * sizeof *version->actions);
953 printf(" %s\n", ds_cstr(&s));
958 fte_from_cls_rule(const struct cls_rule *cls_rule)
960 return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
963 /* Frees 'fte' and its versions. */
965 fte_free(struct fte *fte)
968 fte_version_free(fte->versions[0]);
969 fte_version_free(fte->versions[1]);
974 /* Frees all of the FTEs within 'cls'. */
976 fte_free_all(struct classifier *cls)
978 struct cls_cursor cursor;
979 struct fte *fte, *next;
981 cls_cursor_init(&cursor, cls, NULL);
982 CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
983 classifier_remove(cls, &fte->rule);
988 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
989 * necessary. Sets 'version' as the version of that rule with the given
990 * 'index', replacing any existing version, if any.
992 * Takes ownership of 'version'. */
994 fte_insert(struct classifier *cls, const struct cls_rule *rule,
995 struct fte_version *version, int index)
997 struct fte *old, *fte;
999 fte = xzalloc(sizeof *fte);
1001 fte->versions[index] = version;
1003 old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1005 fte_version_free(old->versions[index]);
1006 fte->versions[!index] = old->versions[!index];
1011 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1012 * with the specified 'index'. Returns the minimum flow format required to
1013 * represent the flows that were read. */
1014 static enum nx_flow_format
1015 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1017 enum nx_flow_format min_flow_format;
1021 file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1023 ovs_fatal(errno, "%s: open", filename);
1027 min_flow_format = NXFF_OPENFLOW10;
1028 while (!ds_get_preprocessed_line(&s, file)) {
1029 struct fte_version *version;
1030 enum nx_flow_format min_ff;
1031 struct ofpbuf actions;
1035 ofpbuf_init(&actions, 64);
1036 parse_ofp_str(&fm, &table_idx, &actions, ds_cstr(&s));
1038 version = xmalloc(sizeof *version);
1039 version->cookie = fm.cookie;
1040 version->idle_timeout = fm.idle_timeout;
1041 version->hard_timeout = fm.hard_timeout;
1042 version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1043 version->n_actions = actions.size / sizeof *version->actions;
1044 version->actions = ofpbuf_steal_data(&actions);
1046 min_ff = ofputil_min_flow_format(&fm.cr, true, fm.cookie);
1047 min_flow_format = MAX(min_flow_format, min_ff);
1048 check_final_format_for_flow_mod(min_flow_format);
1050 fte_insert(cls, &fm.cr, version, index);
1054 if (file != stdin) {
1058 return min_flow_format;
1061 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1062 * format 'flow_format', and adds them as flow table entries in 'cls' for the
1063 * version with the specified 'index'. */
1065 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1066 struct classifier *cls, int index)
1068 struct flow_stats_request fsr;
1069 struct ofpbuf *request;
1073 fsr.aggregate = false;
1074 cls_rule_init_catchall(&fsr.match, 0);
1075 fsr.out_port = OFPP_NONE;
1076 fsr.table_id = 0xff;
1077 request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1078 send_xid = ((struct ofp_header *) request->data)->xid;
1079 send_openflow_buffer(vconn, request);
1084 struct ofpbuf *reply;
1086 run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1087 recv_xid = ((struct ofp_header *) reply->data)->xid;
1088 if (send_xid == recv_xid) {
1089 const struct ofputil_msg_type *type;
1090 const struct ofp_stats_reply *osr;
1091 enum ofputil_msg_code code;
1093 ofputil_decode_msg_type(reply->data, &type);
1094 code = ofputil_msg_type_code(type);
1095 if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1096 code != OFPUTIL_NXST_FLOW_REPLY) {
1097 ovs_fatal(0, "received bad reply: %s",
1098 ofp_to_string(reply->data, reply->size,
1103 if (!(osr->flags & htons(OFPSF_REPLY_MORE))) {
1108 struct fte_version *version;
1109 struct ofputil_flow_stats fs;
1112 retval = ofputil_decode_flow_stats_reply(&fs, reply,
1115 if (retval != EOF) {
1116 ovs_fatal(0, "parse error in reply");
1121 version = xmalloc(sizeof *version);
1122 version->cookie = fs.cookie;
1123 version->idle_timeout = fs.idle_timeout;
1124 version->hard_timeout = fs.hard_timeout;
1126 version->n_actions = fs.n_actions;
1127 version->actions = xmemdup(fs.actions,
1128 fs.n_actions * sizeof *fs.actions);
1130 fte_insert(cls, &fs.rule, version, index);
1133 VLOG_DBG("received reply with xid %08"PRIx32" "
1134 "!= expected %08"PRIx32, recv_xid, send_xid);
1136 ofpbuf_delete(reply);
1141 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1142 enum nx_flow_format flow_format, struct list *packets)
1144 const struct fte_version *version = fte->versions[index];
1149 fm.cookie = version->cookie;
1150 fm.command = command;
1151 fm.idle_timeout = version->idle_timeout;
1152 fm.hard_timeout = version->hard_timeout;
1153 fm.buffer_id = UINT32_MAX;
1154 fm.out_port = OFPP_NONE;
1155 fm.flags = version->flags;
1156 if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1157 command == OFPFC_MODIFY_STRICT) {
1158 fm.actions = version->actions;
1159 fm.n_actions = version->n_actions;
1165 ofm = ofputil_encode_flow_mod(&fm, flow_format);
1166 list_push_back(packets, &ofm->list_node);
1170 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1172 enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1173 enum nx_flow_format min_flow_format, flow_format;
1174 struct cls_cursor cursor;
1175 struct classifier cls;
1176 struct list requests;
1177 struct vconn *vconn;
1180 classifier_init(&cls);
1181 min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1183 open_vconn(argv[1], &vconn);
1184 flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1185 read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1187 list_init(&requests);
1189 /* Delete flows that exist on the switch but not in the file. */
1190 cls_cursor_init(&cursor, &cls, NULL);
1191 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1192 struct fte_version *file_ver = fte->versions[FILE_IDX];
1193 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1195 if (sw_ver && !file_ver) {
1196 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1197 flow_format, &requests);
1201 /* Add flows that exist in the file but not on the switch.
1202 * Update flows that exist in both places but differ. */
1203 cls_cursor_init(&cursor, &cls, NULL);
1204 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1205 struct fte_version *file_ver = fte->versions[FILE_IDX];
1206 struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1208 if (file_ver && (!sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1209 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1213 transact_multiple_noreply(vconn, &requests);
1220 read_flows_from_source(const char *source, struct classifier *cls, int index)
1224 if (source[0] == '/' || source[0] == '.'
1225 || (!strchr(source, ':') && !stat(source, &s))) {
1226 read_flows_from_file(source, cls, index);
1228 enum nx_flow_format flow_format;
1229 struct vconn *vconn;
1231 open_vconn(source, &vconn);
1232 flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1233 read_flows_from_switch(vconn, flow_format, cls, index);
1239 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1241 bool differences = false;
1242 struct cls_cursor cursor;
1243 struct classifier cls;
1246 classifier_init(&cls);
1247 read_flows_from_source(argv[1], &cls, 0);
1248 read_flows_from_source(argv[2], &cls, 1);
1250 cls_cursor_init(&cursor, &cls, NULL);
1251 CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1252 struct fte_version *a = fte->versions[0];
1253 struct fte_version *b = fte->versions[1];
1255 if (!a || !b || !fte_version_equals(a, b)) {
1256 char *rule_s = cls_rule_to_string(&fte->rule);
1258 printf("-%s", rule_s);
1259 fte_version_print(a);
1262 printf("+%s", rule_s);
1263 fte_version_print(b);
1278 /* Undocumented commands for unit testing. */
1281 print_packet_list(struct list *packets)
1283 struct ofpbuf *packet, *next;
1285 LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1286 ofp_print(stdout, packet->data, packet->size, verbosity);
1287 list_remove(&packet->list_node);
1288 ofpbuf_delete(packet);
1292 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1293 * it back to stdout. */
1295 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1297 enum nx_flow_format flow_format;
1298 struct list packets;
1300 flow_format = NXFF_OPENFLOW10;
1301 if (preferred_flow_format > 0) {
1302 flow_format = preferred_flow_format;
1305 list_init(&packets);
1306 parse_ofp_flow_mod_str(&packets, &flow_format, argv[1], OFPFC_ADD);
1307 print_packet_list(&packets);
1310 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1311 * add-flows) and prints each of the flows back to stdout. */
1313 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1315 enum nx_flow_format flow_format;
1316 struct list packets;
1319 file = fopen(argv[1], "r");
1321 ovs_fatal(errno, "%s: open", argv[2]);
1324 flow_format = NXFF_OPENFLOW10;
1325 if (preferred_flow_format > 0) {
1326 flow_format = preferred_flow_format;
1329 list_init(&packets);
1330 while (parse_ofp_flow_mod_file(&packets, &flow_format, file, OFPFC_ADD)) {
1331 print_packet_list(&packets);
1336 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1337 * stdin, does some internal fussing with them, and then prints them back as
1338 * strings on stdout. */
1340 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1345 while (!ds_get_line(&in, stdin)) {
1346 struct ofpbuf nx_match;
1347 struct cls_rule rule;
1352 /* Delete comments, skip blank lines. */
1358 if (strchr(s, '#')) {
1359 *strchr(s, '#') = '\0';
1361 if (s[strspn(s, " ")] == '\0') {
1366 /* Convert string to nx_match. */
1367 ofpbuf_init(&nx_match, 0);
1368 match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1370 /* Convert nx_match to cls_rule. */
1371 error = nx_pull_match(&nx_match, match_len, 0, &rule);
1375 /* Convert cls_rule back to nx_match. */
1376 ofpbuf_uninit(&nx_match);
1377 ofpbuf_init(&nx_match, 0);
1378 match_len = nx_put_match(&nx_match, &rule);
1380 /* Convert nx_match to string. */
1381 out = nx_match_to_string(nx_match.data, match_len);
1385 printf("nx_pull_match() returned error %x\n", error);
1388 ofpbuf_uninit(&nx_match);
1393 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1394 * binary data, interpreting them as an OpenFlow message, and prints the
1395 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
1397 do_ofp_print(int argc, char *argv[])
1399 struct ofpbuf packet;
1401 ofpbuf_init(&packet, strlen(argv[1]) / 2);
1402 if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1403 ovs_fatal(0, "trailing garbage following hex bytes");
1405 ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1406 ofpbuf_uninit(&packet);
1409 static const struct command all_commands[] = {
1410 { "show", 1, 1, do_show },
1411 { "monitor", 1, 2, do_monitor },
1412 { "snoop", 1, 1, do_snoop },
1413 { "dump-desc", 1, 1, do_dump_desc },
1414 { "dump-tables", 1, 1, do_dump_tables },
1415 { "dump-flows", 1, 2, do_dump_flows },
1416 { "dump-aggregate", 1, 2, do_dump_aggregate },
1417 { "queue-stats", 1, 3, do_queue_stats },
1418 { "add-flow", 2, 2, do_add_flow },
1419 { "add-flows", 2, 2, do_add_flows },
1420 { "mod-flows", 2, 2, do_mod_flows },
1421 { "del-flows", 1, 2, do_del_flows },
1422 { "replace-flows", 2, 2, do_replace_flows },
1423 { "diff-flows", 2, 2, do_diff_flows },
1424 { "dump-ports", 1, 2, do_dump_ports },
1425 { "mod-port", 3, 3, do_mod_port },
1426 { "probe", 1, 1, do_probe },
1427 { "ping", 1, 2, do_ping },
1428 { "benchmark", 3, 3, do_benchmark },
1429 { "help", 0, INT_MAX, do_help },
1431 /* Undocumented commands for testing. */
1432 { "parse-flow", 1, 1, do_parse_flow },
1433 { "parse-flows", 1, 1, do_parse_flows },
1434 { "parse-nx-match", 0, 0, do_parse_nx_match },
1435 { "ofp-print", 1, 2, do_ofp_print },
1437 { NULL, 0, 0, NULL },