2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
22 #include <sys/socket.h>
28 #include <sys/fcntl.h>
32 #include "byte-order.h"
33 #include "classifier.h"
34 #include "command-line.h"
38 #include "dynamic-string.h"
41 #include "ofp-actions.h"
42 #include "ofp-errors.h"
44 #include "ofp-parse.h"
45 #include "ofp-print.h"
48 #include "ofproto/ofproto.h"
49 #include "openflow/nicira-ext.h"
50 #include "openflow/openflow.h"
52 #include "poll-loop.h"
54 #include "stream-ssl.h"
60 #include "meta-flow.h"
63 VLOG_DEFINE_THIS_MODULE(ofctl
);
65 /* --strict: Use strict matching for flow mod commands? Additionally governs
66 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
70 /* --readd: If true, on replace-flows, re-add even flows that have not changed
71 * (to reset flow counters). */
74 /* -F, --flow-format: Allowed protocols. By default, any protocol is
76 static enum ofputil_protocol allowed_protocols
= OFPUTIL_P_ANY
;
78 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
79 * commands. Either one of NXPIF_* to force a particular packet_in format, or
80 * -1 to let ovs-ofctl choose the default. */
81 static int preferred_packet_in_format
= -1;
83 /* -m, --more: Additional verbosity for ofp-print functions. */
86 /* --timestamp: Print a timestamp before each received packet on "monitor" and
88 static bool timestamp
;
90 /* --sort, --rsort: Sort order. */
91 enum sort_order
{ SORT_ASC
, SORT_DESC
};
92 struct sort_criterion
{
93 const struct mf_field
*field
; /* NULL means to sort by priority. */
94 enum sort_order order
;
96 static struct sort_criterion
*criteria
;
97 static size_t n_criteria
, allocated_criteria
;
99 static const struct command all_commands
[];
101 static void usage(void) NO_RETURN
;
102 static void parse_options(int argc
, char *argv
[]);
104 static bool recv_flow_stats_reply(struct vconn
*, ovs_be32 send_xid
,
105 struct ofpbuf
**replyp
,
106 struct ofputil_flow_stats
*,
107 struct ofpbuf
*ofpacts
);
109 main(int argc
, char *argv
[])
111 set_program_name(argv
[0]);
112 parse_options(argc
, argv
);
113 signal(SIGPIPE
, SIG_IGN
);
114 run_command(argc
- optind
, argv
+ optind
, all_commands
);
119 add_sort_criterion(enum sort_order order
, const char *field
)
121 struct sort_criterion
*sc
;
123 if (n_criteria
>= allocated_criteria
) {
124 criteria
= x2nrealloc(criteria
, &allocated_criteria
, sizeof *criteria
);
127 sc
= &criteria
[n_criteria
++];
128 if (!field
|| !strcasecmp(field
, "priority")) {
131 sc
->field
= mf_from_name(field
);
133 ovs_fatal(0, "%s: unknown field name", field
);
140 parse_options(int argc
, char *argv
[])
143 OPT_STRICT
= UCHAR_MAX
+ 1,
151 static struct option long_options
[] = {
152 {"timeout", required_argument
, NULL
, 't'},
153 {"strict", no_argument
, NULL
, OPT_STRICT
},
154 {"readd", no_argument
, NULL
, OPT_READD
},
155 {"flow-format", required_argument
, NULL
, 'F'},
156 {"packet-in-format", required_argument
, NULL
, 'P'},
157 {"more", no_argument
, NULL
, 'm'},
158 {"timestamp", no_argument
, NULL
, OPT_TIMESTAMP
},
159 {"sort", optional_argument
, NULL
, OPT_SORT
},
160 {"rsort", optional_argument
, NULL
, OPT_RSORT
},
161 {"help", no_argument
, NULL
, 'h'},
162 {"version", no_argument
, NULL
, 'V'},
165 STREAM_SSL_LONG_OPTIONS
,
168 char *short_options
= long_options_to_short_options(long_options
);
171 unsigned long int timeout
;
174 c
= getopt_long(argc
, argv
, short_options
, long_options
, NULL
);
181 timeout
= strtoul(optarg
, NULL
, 10);
183 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
191 allowed_protocols
= ofputil_protocols_from_string(optarg
);
192 if (!allowed_protocols
) {
193 ovs_fatal(0, "%s: invalid flow format(s)", optarg
);
198 preferred_packet_in_format
=
199 ofputil_packet_in_format_from_string(optarg
);
200 if (preferred_packet_in_format
< 0) {
201 ovs_fatal(0, "unknown packet-in format `%s'", optarg
);
213 ovs_print_version(OFP10_VERSION
, OFP10_VERSION
);
229 add_sort_criterion(SORT_ASC
, optarg
);
233 add_sort_criterion(SORT_DESC
, optarg
);
236 DAEMON_OPTION_HANDLERS
238 STREAM_SSL_OPTION_HANDLERS
249 /* Always do a final sort pass based on priority. */
250 add_sort_criterion(SORT_DESC
, "priority");
259 printf("%s: OpenFlow switch management utility\n"
260 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
261 "\nFor OpenFlow switches:\n"
262 " show SWITCH show OpenFlow information\n"
263 " dump-desc SWITCH print switch description\n"
264 " dump-tables SWITCH print table stats\n"
265 " mod-port SWITCH IFACE ACT modify port behavior\n"
266 " get-frags SWITCH print fragment handling behavior\n"
267 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
268 " dump-ports SWITCH [PORT] print port statistics\n"
269 " dump-ports-desc SWITCH print port descriptions\n"
270 " dump-flows SWITCH print all flow entries\n"
271 " dump-flows SWITCH FLOW print matching FLOWs\n"
272 " dump-aggregate SWITCH print aggregate flow statistics\n"
273 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
274 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
275 " add-flow SWITCH FLOW add flow described by FLOW\n"
276 " add-flows SWITCH FILE add flows from FILE\n"
277 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
278 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
279 " replace-flows SWITCH FILE replace flows with those in FILE\n"
280 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
281 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
282 " execute ACTIONS on PACKET\n"
283 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
284 " print packets received from SWITCH\n"
285 " snoop SWITCH snoop on SWITCH and its controller\n"
286 "\nFor OpenFlow switches and controllers:\n"
287 " probe TARGET probe whether TARGET is up\n"
288 " ping TARGET [N] latency of N-byte echos\n"
289 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
290 "where SWITCH or TARGET is an active OpenFlow connection method.\n",
291 program_name
, program_name
);
292 vconn_usage(true, false, false);
295 printf("\nOther options:\n"
296 " --strict use strict match for flow commands\n"
297 " --readd replace flows that haven't changed\n"
298 " -F, --flow-format=FORMAT force particular flow format\n"
299 " -P, --packet-in-format=FRMT force particular packet in format\n"
300 " -m, --more be more verbose printing OpenFlow\n"
301 " --timestamp (monitor, snoop) print timestamps\n"
302 " -t, --timeout=SECS give up after SECS seconds\n"
303 " --sort[=field] sort in ascending order\n"
304 " --rsort[=field] sort in descending order\n"
305 " -h, --help display this help message\n"
306 " -V, --version display version information\n");
311 ofctl_exit(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
312 const char *argv
[] OVS_UNUSED
, void *exiting_
)
314 bool *exiting
= exiting_
;
316 unixctl_command_reply(conn
, NULL
);
319 static void run(int retval
, const char *message
, ...)
322 static void run(int retval
, const char *message
, ...)
327 va_start(args
, message
);
328 ovs_fatal_valist(retval
, message
, args
);
332 /* Generic commands. */
335 open_vconn_socket(const char *name
, struct vconn
**vconnp
)
337 char *vconn_name
= xasprintf("unix:%s", name
);
338 VLOG_DBG("connecting to %s", vconn_name
);
339 run(vconn_open_block(vconn_name
, OFP10_VERSION
, vconnp
),
340 "connecting to %s", vconn_name
);
344 static enum ofputil_protocol
345 open_vconn__(const char *name
, const char *default_suffix
,
346 struct vconn
**vconnp
)
348 char *datapath_name
, *datapath_type
, *socket_name
;
349 enum ofputil_protocol protocol
;
354 bridge_path
= xasprintf("%s/%s.%s", ovs_rundir(), name
, default_suffix
);
356 ofproto_parse_name(name
, &datapath_name
, &datapath_type
);
357 socket_name
= xasprintf("%s/%s.%s",
358 ovs_rundir(), datapath_name
, default_suffix
);
362 if (strchr(name
, ':')) {
363 run(vconn_open_block(name
, OFP10_VERSION
, vconnp
),
364 "connecting to %s", name
);
365 } else if (!stat(name
, &s
) && S_ISSOCK(s
.st_mode
)) {
366 open_vconn_socket(name
, vconnp
);
367 } else if (!stat(bridge_path
, &s
) && S_ISSOCK(s
.st_mode
)) {
368 open_vconn_socket(bridge_path
, vconnp
);
369 } else if (!stat(socket_name
, &s
)) {
370 if (!S_ISSOCK(s
.st_mode
)) {
371 ovs_fatal(0, "cannot connect to %s: %s is not a socket",
374 open_vconn_socket(socket_name
, vconnp
);
376 ovs_fatal(0, "%s is not a bridge or a socket", name
);
382 ofp_version
= vconn_get_version(*vconnp
);
383 protocol
= ofputil_protocol_from_ofp_version(ofp_version
);
385 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
391 static enum ofputil_protocol
392 open_vconn(const char *name
, struct vconn
**vconnp
)
394 return open_vconn__(name
, "mgmt", vconnp
);
398 send_openflow_buffer(struct vconn
*vconn
, struct ofpbuf
*buffer
)
400 ofpmsg_update_length(buffer
);
401 run(vconn_send_block(vconn
, buffer
), "failed to send packet to switch");
405 dump_transaction(const char *vconn_name
, struct ofpbuf
*request
)
408 struct ofpbuf
*reply
;
410 ofpmsg_update_length(request
);
411 open_vconn(vconn_name
, &vconn
);
412 run(vconn_transact(vconn
, request
, &reply
), "talking to %s", vconn_name
);
413 ofp_print(stdout
, reply
->data
, reply
->size
, verbosity
+ 1);
414 ofpbuf_delete(reply
);
419 dump_trivial_transaction(const char *vconn_name
, enum ofpraw raw
)
421 struct ofpbuf
*request
;
422 request
= ofpraw_alloc(raw
, OFP10_VERSION
, 0);
423 dump_transaction(vconn_name
, request
);
427 dump_stats_transaction(struct vconn
*vconn
, struct ofpbuf
*request
)
429 const struct ofp_header
*request_oh
= request
->data
;
430 ovs_be32 send_xid
= request_oh
->xid
;
431 enum ofpraw request_raw
;
432 enum ofpraw reply_raw
;
435 ofpraw_decode_partial(&request_raw
, request
->data
, request
->size
);
436 reply_raw
= ofpraw_stats_request_to_reply(request_raw
,
437 request_oh
->version
);
439 send_openflow_buffer(vconn
, request
);
442 struct ofpbuf
*reply
;
444 run(vconn_recv_block(vconn
, &reply
), "OpenFlow packet receive failed");
445 recv_xid
= ((struct ofp_header
*) reply
->data
)->xid
;
446 if (send_xid
== recv_xid
) {
449 ofp_print(stdout
, reply
->data
, reply
->size
, verbosity
+ 1);
451 ofpraw_decode(&raw
, reply
->data
);
452 if (ofptype_from_ofpraw(raw
) == OFPTYPE_ERROR
) {
454 } else if (raw
== reply_raw
) {
455 done
= !ofpmp_more(reply
->data
);
457 ovs_fatal(0, "received bad reply: %s",
458 ofp_to_string(reply
->data
, reply
->size
,
462 VLOG_DBG("received reply with xid %08"PRIx32
" "
463 "!= expected %08"PRIx32
, recv_xid
, send_xid
);
465 ofpbuf_delete(reply
);
470 dump_trivial_stats_transaction(const char *vconn_name
, enum ofpraw raw
)
472 struct ofpbuf
*request
;
475 open_vconn(vconn_name
, &vconn
);
476 request
= ofpraw_alloc(raw
, vconn_get_version(vconn
), 0);
477 dump_stats_transaction(vconn
, request
);
481 /* Sends 'request', which should be a request that only has a reply if an error
482 * occurs, and waits for it to succeed or fail. If an error does occur, prints
483 * it and exits with an error.
485 * Destroys all of the 'requests'. */
487 transact_multiple_noreply(struct vconn
*vconn
, struct list
*requests
)
489 struct ofpbuf
*request
, *reply
;
491 LIST_FOR_EACH (request
, list_node
, requests
) {
492 ofpmsg_update_length(request
);
495 run(vconn_transact_multiple_noreply(vconn
, requests
, &reply
),
496 "talking to %s", vconn_get_name(vconn
));
498 ofp_print(stderr
, reply
->data
, reply
->size
, verbosity
+ 2);
501 ofpbuf_delete(reply
);
504 /* Sends 'request', which should be a request that only has a reply if an error
505 * occurs, and waits for it to succeed or fail. If an error does occur, prints
506 * it and exits with an error.
508 * Destroys 'request'. */
510 transact_noreply(struct vconn
*vconn
, struct ofpbuf
*request
)
512 struct list requests
;
514 list_init(&requests
);
515 list_push_back(&requests
, &request
->list_node
);
516 transact_multiple_noreply(vconn
, &requests
);
520 fetch_switch_config(struct vconn
*vconn
, struct ofp_switch_config
*config_
)
522 struct ofp_switch_config
*config
;
523 struct ofpbuf
*request
;
524 struct ofpbuf
*reply
;
527 request
= ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST
, OFP10_VERSION
, 0);
528 run(vconn_transact(vconn
, request
, &reply
),
529 "talking to %s", vconn_get_name(vconn
));
531 if (ofptype_pull(&type
, reply
) || type
!= OFPTYPE_GET_CONFIG_REPLY
) {
532 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn
));
535 config
= ofpbuf_pull(reply
, sizeof *config
);
538 ofpbuf_delete(reply
);
542 set_switch_config(struct vconn
*vconn
, const struct ofp_switch_config
*config
)
544 struct ofpbuf
*request
;
546 request
= ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG
, OFP10_VERSION
, 0);
547 ofpbuf_put(request
, config
, sizeof *config
);
549 transact_noreply(vconn
, request
);
553 ofctl_show(int argc OVS_UNUSED
, char *argv
[])
555 const char *vconn_name
= argv
[1];
557 struct ofpbuf
*request
;
558 struct ofpbuf
*reply
;
561 request
= ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST
, OFP10_VERSION
, 0);
562 open_vconn(vconn_name
, &vconn
);
563 run(vconn_transact(vconn
, request
, &reply
), "talking to %s", vconn_name
);
565 trunc
= ofputil_switch_features_ports_trunc(reply
);
566 ofp_print(stdout
, reply
->data
, reply
->size
, verbosity
+ 1);
568 ofpbuf_delete(reply
);
572 /* The Features Reply may not contain all the ports, so send a
573 * Port Description stats request, which doesn't have size
575 dump_trivial_stats_transaction(vconn_name
,
576 OFPRAW_OFPST_PORT_DESC_REQUEST
);
578 dump_trivial_transaction(vconn_name
, OFPRAW_OFPT_GET_CONFIG_REQUEST
);
582 ofctl_dump_desc(int argc OVS_UNUSED
, char *argv
[])
584 dump_trivial_stats_transaction(argv
[1], OFPRAW_OFPST_DESC_REQUEST
);
588 ofctl_dump_tables(int argc OVS_UNUSED
, char *argv
[])
590 dump_trivial_stats_transaction(argv
[1], OFPRAW_OFPST_TABLE_REQUEST
);
594 fetch_port_by_features(const char *vconn_name
,
595 const char *port_name
, unsigned int port_no
,
596 struct ofputil_phy_port
*pp
, bool *trunc
)
598 struct ofputil_switch_features features
;
599 const struct ofp_header
*oh
;
600 struct ofpbuf
*request
, *reply
;
607 /* Fetch the switch's ofp_switch_features. */
608 request
= ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST
, OFP10_VERSION
, 0);
609 open_vconn(vconn_name
, &vconn
);
610 run(vconn_transact(vconn
, request
, &reply
), "talking to %s", vconn_name
);
614 if (ofptype_decode(&type
, reply
->data
)
615 || type
!= OFPTYPE_FEATURES_REPLY
) {
616 ovs_fatal(0, "%s: received bad features reply", vconn_name
);
620 if (ofputil_switch_features_ports_trunc(reply
)) {
625 error
= ofputil_decode_switch_features(oh
, &features
, &b
);
627 ovs_fatal(0, "%s: failed to decode features reply (%s)",
628 vconn_name
, ofperr_to_string(error
));
631 while (!ofputil_pull_phy_port(oh
->version
, &b
, pp
)) {
632 if (port_no
!= UINT_MAX
633 ? port_no
== pp
->port_no
634 : !strcmp(pp
->name
, port_name
)) {
641 ofpbuf_delete(reply
);
646 fetch_port_by_stats(const char *vconn_name
,
647 const char *port_name
, unsigned int port_no
,
648 struct ofputil_phy_port
*pp
)
650 struct ofpbuf
*request
;
656 request
= ofpraw_alloc(OFPRAW_OFPST_PORT_DESC_REQUEST
, OFP10_VERSION
, 0);
657 send_xid
= ((struct ofp_header
*) request
->data
)->xid
;
659 open_vconn(vconn_name
, &vconn
);
660 send_openflow_buffer(vconn
, request
);
663 struct ofpbuf
*reply
;
665 run(vconn_recv_block(vconn
, &reply
), "OpenFlow packet receive failed");
666 recv_xid
= ((struct ofp_header
*) reply
->data
)->xid
;
667 if (send_xid
== recv_xid
) {
668 struct ofp_header
*oh
= reply
->data
;
673 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
674 if (ofptype_pull(&type
, &b
)
675 || type
!= OFPTYPE_PORT_DESC_STATS_REPLY
) {
676 ovs_fatal(0, "received bad reply: %s",
677 ofp_to_string(reply
->data
, reply
->size
,
681 flags
= ofpmp_flags(oh
);
682 done
= !(flags
& OFPSF_REPLY_MORE
);
685 /* We've already found the port, but we need to drain
686 * the queue of any other replies for this request. */
690 while (!ofputil_pull_phy_port(oh
->version
, &b
, pp
)) {
691 if (port_no
!= UINT_MAX
? port_no
== pp
->port_no
692 : !strcmp(pp
->name
, port_name
)) {
698 VLOG_DBG("received reply with xid %08"PRIx32
" "
699 "!= expected %08"PRIx32
, recv_xid
, send_xid
);
701 ofpbuf_delete(reply
);
709 /* Opens a connection to 'vconn_name', fetches the port structure for
710 * 'port_name' (which may be a port name or number), and copies it into
713 fetch_ofputil_phy_port(const char *vconn_name
, const char *port_name
,
714 struct ofputil_phy_port
*pp
)
716 unsigned int port_no
;
720 /* Try to interpret the argument as a port number. */
721 if (!str_to_uint(port_name
, 10, &port_no
)) {
725 /* Try to find the port based on the Features Reply. If it looks
726 * like the results may be truncated, then use the Port Description
727 * stats message introduced in OVS 1.7. */
728 found
= fetch_port_by_features(vconn_name
, port_name
, port_no
, pp
,
731 found
= fetch_port_by_stats(vconn_name
, port_name
, port_no
, pp
);
735 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name
, port_name
);
739 /* Returns the port number corresponding to 'port_name' (which may be a port
740 * name or number) within the switch 'vconn_name'. */
742 str_to_port_no(const char *vconn_name
, const char *port_name
)
744 uint16_t port_no
= ofputil_port_from_string(port_name
);
748 struct ofputil_phy_port pp
;
750 fetch_ofputil_phy_port(vconn_name
, port_name
, &pp
);
756 try_set_protocol(struct vconn
*vconn
, enum ofputil_protocol want
,
757 enum ofputil_protocol
*cur
)
760 struct ofpbuf
*request
, *reply
;
761 enum ofputil_protocol next
;
763 request
= ofputil_encode_set_protocol(*cur
, want
, &next
);
768 run(vconn_transact_noreply(vconn
, request
, &reply
),
769 "talking to %s", vconn_get_name(vconn
));
771 char *s
= ofp_to_string(reply
->data
, reply
->size
, 2);
772 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
773 vconn_get_name(vconn
), s
);
775 ofpbuf_delete(reply
);
783 static enum ofputil_protocol
784 set_protocol_for_flow_dump(struct vconn
*vconn
,
785 enum ofputil_protocol cur_protocol
,
786 enum ofputil_protocol usable_protocols
)
791 for (i
= 0; i
< ofputil_n_flow_dump_protocols
; i
++) {
792 enum ofputil_protocol f
= ofputil_flow_dump_protocols
[i
];
793 if (f
& usable_protocols
& allowed_protocols
794 && try_set_protocol(vconn
, f
, &cur_protocol
)) {
799 usable_s
= ofputil_protocols_to_string(usable_protocols
);
800 if (usable_protocols
& allowed_protocols
) {
801 ovs_fatal(0, "switch does not support any of the usable flow "
802 "formats (%s)", usable_s
);
804 char *allowed_s
= ofputil_protocols_to_string(allowed_protocols
);
805 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
806 "allowed flow formats (%s)", usable_s
, allowed_s
);
810 static struct vconn
*
811 prepare_dump_flows(int argc
, char *argv
[], bool aggregate
,
812 struct ofpbuf
**requestp
)
814 enum ofputil_protocol usable_protocols
, protocol
;
815 struct ofputil_flow_stats_request fsr
;
818 parse_ofp_flow_stats_request_str(&fsr
, aggregate
, argc
> 2 ? argv
[2] : "");
819 usable_protocols
= ofputil_flow_stats_request_usable_protocols(&fsr
);
821 protocol
= open_vconn(argv
[1], &vconn
);
822 protocol
= set_protocol_for_flow_dump(vconn
, protocol
, usable_protocols
);
823 *requestp
= ofputil_encode_flow_stats_request(&fsr
, protocol
);
828 ofctl_dump_flows__(int argc
, char *argv
[], bool aggregate
)
830 struct ofpbuf
*request
;
833 vconn
= prepare_dump_flows(argc
, argv
, aggregate
, &request
);
834 dump_stats_transaction(vconn
, request
);
839 compare_flows(const void *afs_
, const void *bfs_
)
841 const struct ofputil_flow_stats
*afs
= afs_
;
842 const struct ofputil_flow_stats
*bfs
= bfs_
;
843 const struct match
*a
= &afs
->match
;
844 const struct match
*b
= &bfs
->match
;
845 const struct sort_criterion
*sc
;
847 for (sc
= criteria
; sc
< &criteria
[n_criteria
]; sc
++) {
848 const struct mf_field
*f
= sc
->field
;
852 unsigned int a_pri
= afs
->priority
;
853 unsigned int b_pri
= bfs
->priority
;
854 ret
= a_pri
< b_pri
? -1 : a_pri
> b_pri
;
858 ina
= mf_are_prereqs_ok(f
, &a
->flow
) && !mf_is_all_wild(f
, &a
->wc
);
859 inb
= mf_are_prereqs_ok(f
, &b
->flow
) && !mf_is_all_wild(f
, &b
->wc
);
861 /* Skip the test for sc->order, so that missing fields always
862 * sort to the end whether we're sorting in ascending or
863 * descending order. */
866 union mf_value aval
, bval
;
868 mf_get_value(f
, &a
->flow
, &aval
);
869 mf_get_value(f
, &b
->flow
, &bval
);
870 ret
= memcmp(&aval
, &bval
, f
->n_bytes
);
875 return sc
->order
== SORT_ASC
? ret
: -ret
;
883 ofctl_dump_flows(int argc
, char *argv
[])
886 return ofctl_dump_flows__(argc
, argv
, false);
888 struct ofputil_flow_stats
*fses
;
889 size_t n_fses
, allocated_fses
;
890 struct ofpbuf
*request
;
891 struct ofpbuf ofpacts
;
892 struct ofpbuf
*reply
;
898 vconn
= prepare_dump_flows(argc
, argv
, false, &request
);
899 send_xid
= ((struct ofp_header
*) request
->data
)->xid
;
900 send_openflow_buffer(vconn
, request
);
903 n_fses
= allocated_fses
= 0;
905 ofpbuf_init(&ofpacts
, 0);
907 struct ofputil_flow_stats
*fs
;
909 if (n_fses
>= allocated_fses
) {
910 fses
= x2nrealloc(fses
, &allocated_fses
, sizeof *fses
);
914 if (!recv_flow_stats_reply(vconn
, send_xid
, &reply
, fs
,
918 fs
->ofpacts
= xmemdup(fs
->ofpacts
, fs
->ofpacts_len
);
921 ofpbuf_uninit(&ofpacts
);
923 qsort(fses
, n_fses
, sizeof *fses
, compare_flows
);
926 for (i
= 0; i
< n_fses
; i
++) {
928 ofp_print_flow_stats(&s
, &fses
[i
]);
933 for (i
= 0; i
< n_fses
; i
++) {
934 free(fses
[i
].ofpacts
);
943 ofctl_dump_aggregate(int argc
, char *argv
[])
945 return ofctl_dump_flows__(argc
, argv
, true);
949 ofctl_queue_stats(int argc
, char *argv
[])
951 struct ofp10_queue_stats_request
*req
;
952 struct ofpbuf
*request
;
955 open_vconn(argv
[1], &vconn
);
956 request
= ofpraw_alloc(OFPRAW_OFPST_QUEUE_REQUEST
,
957 vconn_get_version(vconn
), 0);
958 req
= ofpbuf_put_zeros(request
, sizeof *req
);
960 if (argc
> 2 && argv
[2][0] && strcasecmp(argv
[2], "all")) {
961 req
->port_no
= htons(str_to_port_no(argv
[1], argv
[2]));
963 req
->port_no
= htons(OFPP_ALL
);
965 if (argc
> 3 && argv
[3][0] && strcasecmp(argv
[3], "all")) {
966 req
->queue_id
= htonl(atoi(argv
[3]));
968 req
->queue_id
= htonl(OFPQ_ALL
);
971 memset(req
->pad
, 0, sizeof req
->pad
);
973 dump_stats_transaction(vconn
, request
);
977 static enum ofputil_protocol
978 open_vconn_for_flow_mod(const char *remote
,
979 const struct ofputil_flow_mod
*fms
, size_t n_fms
,
980 struct vconn
**vconnp
)
982 enum ofputil_protocol usable_protocols
;
983 enum ofputil_protocol cur_protocol
;
987 /* Figure out what flow formats will work. */
988 usable_protocols
= ofputil_flow_mod_usable_protocols(fms
, n_fms
);
989 if (!(usable_protocols
& allowed_protocols
)) {
990 char *allowed_s
= ofputil_protocols_to_string(allowed_protocols
);
991 usable_s
= ofputil_protocols_to_string(usable_protocols
);
992 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
993 "allowed flow formats (%s)", usable_s
, allowed_s
);
996 /* If the initial flow format is allowed and usable, keep it. */
997 cur_protocol
= open_vconn(remote
, vconnp
);
998 if (usable_protocols
& allowed_protocols
& cur_protocol
) {
1002 /* Otherwise try each flow format in turn. */
1003 for (i
= 0; i
< sizeof(enum ofputil_protocol
) * CHAR_BIT
; i
++) {
1004 enum ofputil_protocol f
= 1 << i
;
1006 if (f
!= cur_protocol
1007 && f
& usable_protocols
& allowed_protocols
1008 && try_set_protocol(*vconnp
, f
, &cur_protocol
)) {
1013 usable_s
= ofputil_protocols_to_string(usable_protocols
);
1014 ovs_fatal(0, "switch does not support any of the usable flow "
1015 "formats (%s)", usable_s
);
1019 ofctl_flow_mod__(const char *remote
, struct ofputil_flow_mod
*fms
,
1022 enum ofputil_protocol protocol
;
1023 struct vconn
*vconn
;
1026 protocol
= open_vconn_for_flow_mod(remote
, fms
, n_fms
, &vconn
);
1028 for (i
= 0; i
< n_fms
; i
++) {
1029 struct ofputil_flow_mod
*fm
= &fms
[i
];
1031 transact_noreply(vconn
, ofputil_encode_flow_mod(fm
, protocol
));
1038 ofctl_flow_mod_file(int argc OVS_UNUSED
, char *argv
[], uint16_t command
)
1040 struct ofputil_flow_mod
*fms
= NULL
;
1043 parse_ofp_flow_mod_file(argv
[2], command
, &fms
, &n_fms
);
1044 ofctl_flow_mod__(argv
[1], fms
, n_fms
);
1049 ofctl_flow_mod(int argc
, char *argv
[], uint16_t command
)
1051 if (argc
> 2 && !strcmp(argv
[2], "-")) {
1052 ofctl_flow_mod_file(argc
, argv
, command
);
1054 struct ofputil_flow_mod fm
;
1055 parse_ofp_flow_mod_str(&fm
, argc
> 2 ? argv
[2] : "", command
, false);
1056 ofctl_flow_mod__(argv
[1], &fm
, 1);
1061 ofctl_add_flow(int argc
, char *argv
[])
1063 ofctl_flow_mod(argc
, argv
, OFPFC_ADD
);
1067 ofctl_add_flows(int argc
, char *argv
[])
1069 ofctl_flow_mod_file(argc
, argv
, OFPFC_ADD
);
1073 ofctl_mod_flows(int argc
, char *argv
[])
1075 ofctl_flow_mod(argc
, argv
, strict
? OFPFC_MODIFY_STRICT
: OFPFC_MODIFY
);
1079 ofctl_del_flows(int argc
, char *argv
[])
1081 ofctl_flow_mod(argc
, argv
, strict
? OFPFC_DELETE_STRICT
: OFPFC_DELETE
);
1085 set_packet_in_format(struct vconn
*vconn
,
1086 enum nx_packet_in_format packet_in_format
)
1088 struct ofpbuf
*spif
;
1090 spif
= ofputil_make_set_packet_in_format(vconn_get_version(vconn
),
1092 transact_noreply(vconn
, spif
);
1093 VLOG_DBG("%s: using user-specified packet in format %s",
1094 vconn_get_name(vconn
),
1095 ofputil_packet_in_format_to_string(packet_in_format
));
1099 monitor_set_invalid_ttl_to_controller(struct vconn
*vconn
)
1101 struct ofp_switch_config config
;
1102 enum ofp_config_flags flags
;
1104 fetch_switch_config(vconn
, &config
);
1105 flags
= ntohs(config
.flags
);
1106 if (!(flags
& OFPC_INVALID_TTL_TO_CONTROLLER
)) {
1107 /* Set the invalid ttl config. */
1108 flags
|= OFPC_INVALID_TTL_TO_CONTROLLER
;
1110 config
.flags
= htons(flags
);
1111 set_switch_config(vconn
, &config
);
1113 /* Then retrieve the configuration to see if it really took. OpenFlow
1114 * doesn't define error reporting for bad modes, so this is all we can
1116 fetch_switch_config(vconn
, &config
);
1117 flags
= ntohs(config
.flags
);
1118 if (!(flags
& OFPC_INVALID_TTL_TO_CONTROLLER
)) {
1119 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1120 "switch probably doesn't support mode)");
1127 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1128 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1129 * an error message and stores NULL in '*msgp'. */
1131 openflow_from_hex(const char *hex
, struct ofpbuf
**msgp
)
1133 struct ofp_header
*oh
;
1136 msg
= ofpbuf_new(strlen(hex
) / 2);
1139 if (ofpbuf_put_hex(msg
, hex
, NULL
)[0] != '\0') {
1141 return "Trailing garbage in hex data";
1144 if (msg
->size
< sizeof(struct ofp_header
)) {
1146 return "Message too short for OpenFlow";
1150 if (msg
->size
!= ntohs(oh
->length
)) {
1152 return "Message size does not match length in OpenFlow header";
1160 ofctl_send(struct unixctl_conn
*conn
, int argc
,
1161 const char *argv
[], void *vconn_
)
1163 struct vconn
*vconn
= vconn_
;
1170 for (i
= 1; i
< argc
; i
++) {
1171 const char *error_msg
;
1175 error_msg
= openflow_from_hex(argv
[i
], &msg
);
1177 ds_put_format(&reply
, "%s\n", error_msg
);
1182 fprintf(stderr
, "send: ");
1183 ofp_print(stderr
, msg
->data
, msg
->size
, verbosity
);
1185 error
= vconn_send_block(vconn
, msg
);
1188 ds_put_format(&reply
, "%s\n", strerror(error
));
1191 ds_put_cstr(&reply
, "sent\n");
1196 unixctl_command_reply(conn
, ds_cstr(&reply
));
1198 unixctl_command_reply_error(conn
, ds_cstr(&reply
));
1203 struct barrier_aux
{
1204 struct vconn
*vconn
; /* OpenFlow connection for sending barrier. */
1205 struct unixctl_conn
*conn
; /* Connection waiting for barrier response. */
1209 ofctl_barrier(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1210 const char *argv
[] OVS_UNUSED
, void *aux_
)
1212 struct barrier_aux
*aux
= aux_
;
1217 unixctl_command_reply_error(conn
, "already waiting for barrier reply");
1221 msg
= ofputil_encode_barrier_request(vconn_get_version(aux
->vconn
));
1222 error
= vconn_send_block(aux
->vconn
, msg
);
1225 unixctl_command_reply_error(conn
, strerror(error
));
1232 ofctl_set_output_file(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1233 const char *argv
[], void *aux OVS_UNUSED
)
1237 fd
= open(argv
[1], O_CREAT
| O_TRUNC
| O_WRONLY
, 0666);
1239 unixctl_command_reply_error(conn
, strerror(errno
));
1244 dup2(fd
, STDERR_FILENO
);
1246 unixctl_command_reply(conn
, NULL
);
1250 ofctl_block(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1251 const char *argv
[] OVS_UNUSED
, void *blocked_
)
1253 bool *blocked
= blocked_
;
1257 unixctl_command_reply(conn
, NULL
);
1259 unixctl_command_reply(conn
, "already blocking");
1264 ofctl_unblock(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1265 const char *argv
[] OVS_UNUSED
, void *blocked_
)
1267 bool *blocked
= blocked_
;
1271 unixctl_command_reply(conn
, NULL
);
1273 unixctl_command_reply(conn
, "already unblocked");
1278 monitor_vconn(struct vconn
*vconn
)
1280 struct barrier_aux barrier_aux
= { vconn
, NULL
};
1281 struct unixctl_server
*server
;
1282 bool exiting
= false;
1283 bool blocked
= false;
1286 daemon_save_fd(STDERR_FILENO
);
1288 error
= unixctl_server_create(NULL
, &server
);
1290 ovs_fatal(error
, "failed to create unixctl server");
1292 unixctl_command_register("exit", "", 0, 0, ofctl_exit
, &exiting
);
1293 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX
,
1295 unixctl_command_register("ofctl/barrier", "", 0, 0,
1296 ofctl_barrier
, &barrier_aux
);
1297 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1298 ofctl_set_output_file
, NULL
);
1300 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block
, &blocked
);
1301 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock
,
1304 daemonize_complete();
1310 unixctl_server_run(server
);
1315 retval
= vconn_recv(vconn
, &b
);
1316 if (retval
== EAGAIN
) {
1319 run(retval
, "vconn_recv");
1322 time_t now
= time_wall();
1325 strftime(s
, sizeof s
, "%Y-%m-%d %H:%M:%S: ", gmtime(&now
));
1329 ofptype_decode(&type
, b
->data
);
1330 ofp_print(stderr
, b
->data
, b
->size
, verbosity
+ 2);
1333 if (barrier_aux
.conn
&& type
== OFPTYPE_BARRIER_REPLY
) {
1334 unixctl_command_reply(barrier_aux
.conn
, NULL
);
1335 barrier_aux
.conn
= NULL
;
1344 vconn_run_wait(vconn
);
1346 vconn_recv_wait(vconn
);
1348 unixctl_server_wait(server
);
1352 unixctl_server_destroy(server
);
1356 ofctl_monitor(int argc
, char *argv
[])
1358 struct vconn
*vconn
;
1361 open_vconn(argv
[1], &vconn
);
1362 for (i
= 2; i
< argc
; i
++) {
1363 const char *arg
= argv
[i
];
1365 if (isdigit((unsigned char) *arg
)) {
1366 struct ofp_switch_config config
;
1368 fetch_switch_config(vconn
, &config
);
1369 config
.miss_send_len
= htons(atoi(arg
));
1370 set_switch_config(vconn
, &config
);
1371 } else if (!strcmp(arg
, "invalid_ttl")) {
1372 monitor_set_invalid_ttl_to_controller(vconn
);
1373 } else if (!strncmp(arg
, "watch:", 6)) {
1374 struct ofputil_flow_monitor_request fmr
;
1377 parse_flow_monitor_request(&fmr
, arg
+ 6);
1379 msg
= ofpbuf_new(0);
1380 ofputil_append_flow_monitor_request(&fmr
, msg
);
1381 dump_stats_transaction(vconn
, msg
);
1383 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg
);
1387 if (preferred_packet_in_format
>= 0) {
1388 set_packet_in_format(vconn
, preferred_packet_in_format
);
1390 struct ofpbuf
*spif
, *reply
;
1392 spif
= ofputil_make_set_packet_in_format(vconn_get_version(vconn
),
1394 run(vconn_transact_noreply(vconn
, spif
, &reply
),
1395 "talking to %s", vconn_get_name(vconn
));
1397 char *s
= ofp_to_string(reply
->data
, reply
->size
, 2);
1398 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1399 " replied: %s. Falling back to the switch default.",
1400 vconn_get_name(vconn
), s
);
1402 ofpbuf_delete(reply
);
1406 monitor_vconn(vconn
);
1410 ofctl_snoop(int argc OVS_UNUSED
, char *argv
[])
1412 struct vconn
*vconn
;
1414 open_vconn__(argv
[1], "snoop", &vconn
);
1415 monitor_vconn(vconn
);
1419 ofctl_dump_ports(int argc
, char *argv
[])
1421 struct ofp10_port_stats_request
*req
;
1422 struct ofpbuf
*request
;
1423 struct vconn
*vconn
;
1426 open_vconn(argv
[1], &vconn
);
1427 request
= ofpraw_alloc(OFPRAW_OFPST_PORT_REQUEST
,
1428 vconn_get_version(vconn
), 0);
1429 req
= ofpbuf_put_zeros(request
, sizeof *req
);
1430 port
= argc
> 2 ? str_to_port_no(argv
[1], argv
[2]) : OFPP_NONE
;
1431 req
->port_no
= htons(port
);
1432 dump_stats_transaction(vconn
, request
);
1437 ofctl_dump_ports_desc(int argc OVS_UNUSED
, char *argv
[])
1439 dump_trivial_stats_transaction(argv
[1], OFPRAW_OFPST_PORT_DESC_REQUEST
);
1443 ofctl_probe(int argc OVS_UNUSED
, char *argv
[])
1445 struct ofpbuf
*request
;
1446 struct vconn
*vconn
;
1447 struct ofpbuf
*reply
;
1449 open_vconn(argv
[1], &vconn
);
1450 request
= make_echo_request(vconn_get_version(vconn
));
1451 run(vconn_transact(vconn
, request
, &reply
), "talking to %s", argv
[1]);
1452 if (reply
->size
!= sizeof(struct ofp_header
)) {
1453 ovs_fatal(0, "reply does not match request");
1455 ofpbuf_delete(reply
);
1460 ofctl_packet_out(int argc
, char *argv
[])
1462 enum ofputil_protocol protocol
;
1463 struct ofputil_packet_out po
;
1464 struct ofpbuf ofpacts
;
1465 struct vconn
*vconn
;
1468 ofpbuf_init(&ofpacts
, 64);
1469 parse_ofpacts(argv
[3], &ofpacts
);
1471 po
.buffer_id
= UINT32_MAX
;
1472 po
.in_port
= str_to_port_no(argv
[1], argv
[2]);
1473 po
.ofpacts
= ofpacts
.data
;
1474 po
.ofpacts_len
= ofpacts
.size
;
1476 protocol
= open_vconn(argv
[1], &vconn
);
1477 for (i
= 4; i
< argc
; i
++) {
1478 struct ofpbuf
*packet
, *opo
;
1479 const char *error_msg
;
1481 error_msg
= eth_from_hex(argv
[i
], &packet
);
1483 ovs_fatal(0, "%s", error_msg
);
1486 po
.packet
= packet
->data
;
1487 po
.packet_len
= packet
->size
;
1488 opo
= ofputil_encode_packet_out(&po
, protocol
);
1489 transact_noreply(vconn
, opo
);
1490 ofpbuf_delete(packet
);
1493 ofpbuf_uninit(&ofpacts
);
1497 ofctl_mod_port(int argc OVS_UNUSED
, char *argv
[])
1499 struct ofp_config_flag
{
1500 const char *name
; /* The flag's name. */
1501 enum ofputil_port_config bit
; /* Bit to turn on or off. */
1502 bool on
; /* Value to set the bit to. */
1504 static const struct ofp_config_flag flags
[] = {
1505 { "up", OFPUTIL_PC_PORT_DOWN
, false },
1506 { "down", OFPUTIL_PC_PORT_DOWN
, true },
1507 { "stp", OFPUTIL_PC_NO_STP
, false },
1508 { "receive", OFPUTIL_PC_NO_RECV
, false },
1509 { "receive-stp", OFPUTIL_PC_NO_RECV_STP
, false },
1510 { "flood", OFPUTIL_PC_NO_FLOOD
, false },
1511 { "forward", OFPUTIL_PC_NO_FWD
, false },
1512 { "packet-in", OFPUTIL_PC_NO_PACKET_IN
, false },
1515 const struct ofp_config_flag
*flag
;
1516 enum ofputil_protocol protocol
;
1517 struct ofputil_port_mod pm
;
1518 struct ofputil_phy_port pp
;
1519 struct vconn
*vconn
;
1520 const char *command
;
1523 fetch_ofputil_phy_port(argv
[1], argv
[2], &pp
);
1525 pm
.port_no
= pp
.port_no
;
1526 memcpy(pm
.hw_addr
, pp
.hw_addr
, ETH_ADDR_LEN
);
1531 if (!strncasecmp(argv
[3], "no-", 3)) {
1532 command
= argv
[3] + 3;
1534 } else if (!strncasecmp(argv
[3], "no", 2)) {
1535 command
= argv
[3] + 2;
1541 for (flag
= flags
; flag
< &flags
[ARRAY_SIZE(flags
)]; flag
++) {
1542 if (!strcasecmp(command
, flag
->name
)) {
1543 pm
.mask
= flag
->bit
;
1544 pm
.config
= flag
->on
^ not ? flag
->bit
: 0;
1548 ovs_fatal(0, "unknown mod-port command '%s'", argv
[3]);
1551 protocol
= open_vconn(argv
[1], &vconn
);
1552 transact_noreply(vconn
, ofputil_encode_port_mod(&pm
, protocol
));
1557 ofctl_get_frags(int argc OVS_UNUSED
, char *argv
[])
1559 struct ofp_switch_config config
;
1560 struct vconn
*vconn
;
1562 open_vconn(argv
[1], &vconn
);
1563 fetch_switch_config(vconn
, &config
);
1564 puts(ofputil_frag_handling_to_string(ntohs(config
.flags
)));
1569 ofctl_set_frags(int argc OVS_UNUSED
, char *argv
[])
1571 struct ofp_switch_config config
;
1572 enum ofp_config_flags mode
;
1573 struct vconn
*vconn
;
1576 if (!ofputil_frag_handling_from_string(argv
[2], &mode
)) {
1577 ovs_fatal(0, "%s: unknown fragment handling mode", argv
[2]);
1580 open_vconn(argv
[1], &vconn
);
1581 fetch_switch_config(vconn
, &config
);
1582 flags
= htons(mode
) | (config
.flags
& htons(~OFPC_FRAG_MASK
));
1583 if (flags
!= config
.flags
) {
1584 /* Set the configuration. */
1585 config
.flags
= flags
;
1586 set_switch_config(vconn
, &config
);
1588 /* Then retrieve the configuration to see if it really took. OpenFlow
1589 * doesn't define error reporting for bad modes, so this is all we can
1591 fetch_switch_config(vconn
, &config
);
1592 if (flags
!= config
.flags
) {
1593 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1594 "switch probably doesn't support mode \"%s\")",
1595 argv
[1], ofputil_frag_handling_to_string(mode
));
1602 ofctl_ping(int argc
, char *argv
[])
1604 size_t max_payload
= 65535 - sizeof(struct ofp_header
);
1605 unsigned int payload
;
1606 struct vconn
*vconn
;
1609 payload
= argc
> 2 ? atoi(argv
[2]) : 64;
1610 if (payload
> max_payload
) {
1611 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload
);
1614 open_vconn(argv
[1], &vconn
);
1615 for (i
= 0; i
< 10; i
++) {
1616 struct timeval start
, end
;
1617 struct ofpbuf
*request
, *reply
;
1618 const struct ofp_header
*rpy_hdr
;
1621 request
= ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST
, OFP10_VERSION
,
1623 random_bytes(ofpbuf_put_uninit(request
, payload
), payload
);
1625 xgettimeofday(&start
);
1626 run(vconn_transact(vconn
, ofpbuf_clone(request
), &reply
), "transact");
1627 xgettimeofday(&end
);
1629 rpy_hdr
= reply
->data
;
1630 if (ofptype_pull(&type
, reply
)
1631 || type
!= OFPTYPE_ECHO_REPLY
1632 || reply
->size
!= payload
1633 || memcmp(request
->l3
, reply
->l3
, payload
)) {
1634 printf("Reply does not match request. Request:\n");
1635 ofp_print(stdout
, request
, request
->size
, verbosity
+ 2);
1637 ofp_print(stdout
, reply
, reply
->size
, verbosity
+ 2);
1639 printf("%zu bytes from %s: xid=%08"PRIx32
" time=%.1f ms\n",
1640 reply
->size
, argv
[1], ntohl(rpy_hdr
->xid
),
1641 (1000*(double)(end
.tv_sec
- start
.tv_sec
))
1642 + (.001*(end
.tv_usec
- start
.tv_usec
)));
1643 ofpbuf_delete(request
);
1644 ofpbuf_delete(reply
);
1650 ofctl_benchmark(int argc OVS_UNUSED
, char *argv
[])
1652 size_t max_payload
= 65535 - sizeof(struct ofp_header
);
1653 struct timeval start
, end
;
1654 unsigned int payload_size
, message_size
;
1655 struct vconn
*vconn
;
1660 payload_size
= atoi(argv
[2]);
1661 if (payload_size
> max_payload
) {
1662 ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload
);
1664 message_size
= sizeof(struct ofp_header
) + payload_size
;
1666 count
= atoi(argv
[3]);
1668 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1669 count
, message_size
, count
* message_size
);
1671 open_vconn(argv
[1], &vconn
);
1672 xgettimeofday(&start
);
1673 for (i
= 0; i
< count
; i
++) {
1674 struct ofpbuf
*request
, *reply
;
1676 request
= ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST
, OFP10_VERSION
,
1678 ofpbuf_put_zeros(request
, payload_size
);
1679 run(vconn_transact(vconn
, request
, &reply
), "transact");
1680 ofpbuf_delete(reply
);
1682 xgettimeofday(&end
);
1685 duration
= ((1000*(double)(end
.tv_sec
- start
.tv_sec
))
1686 + (.001*(end
.tv_usec
- start
.tv_usec
)));
1687 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1688 duration
, count
/ (duration
/ 1000.0),
1689 count
* message_size
/ (duration
/ 1000.0));
1693 ofctl_help(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
1698 /* replace-flows and diff-flows commands. */
1700 /* A flow table entry, possibly with two different versions. */
1702 struct cls_rule rule
; /* Within a "struct classifier". */
1703 struct fte_version
*versions
[2];
1706 /* One version of a Flow Table Entry. */
1707 struct fte_version
{
1709 uint16_t idle_timeout
;
1710 uint16_t hard_timeout
;
1712 struct ofpact
*ofpacts
;
1716 /* Frees 'version' and the data that it owns. */
1718 fte_version_free(struct fte_version
*version
)
1721 free(version
->ofpacts
);
1726 /* Returns true if 'a' and 'b' are the same, false if they differ.
1728 * Ignores differences in 'flags' because there's no way to retrieve flags from
1729 * an OpenFlow switch. We have to assume that they are the same. */
1731 fte_version_equals(const struct fte_version
*a
, const struct fte_version
*b
)
1733 return (a
->cookie
== b
->cookie
1734 && a
->idle_timeout
== b
->idle_timeout
1735 && a
->hard_timeout
== b
->hard_timeout
1736 && ofpacts_equal(a
->ofpacts
, a
->ofpacts_len
,
1737 b
->ofpacts
, b
->ofpacts_len
));
1740 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
1741 * 'index' into 's', followed by a new-line. */
1743 fte_version_format(const struct fte
*fte
, int index
, struct ds
*s
)
1745 const struct fte_version
*version
= fte
->versions
[index
];
1752 cls_rule_format(&fte
->rule
, s
);
1753 if (version
->cookie
!= htonll(0)) {
1754 ds_put_format(s
, " cookie=0x%"PRIx64
, ntohll(version
->cookie
));
1756 if (version
->idle_timeout
!= OFP_FLOW_PERMANENT
) {
1757 ds_put_format(s
, " idle_timeout=%"PRIu16
, version
->idle_timeout
);
1759 if (version
->hard_timeout
!= OFP_FLOW_PERMANENT
) {
1760 ds_put_format(s
, " hard_timeout=%"PRIu16
, version
->hard_timeout
);
1763 ds_put_char(s
, ' ');
1764 ofpacts_format(version
->ofpacts
, version
->ofpacts_len
, s
);
1766 ds_put_char(s
, '\n');
1770 fte_from_cls_rule(const struct cls_rule
*cls_rule
)
1772 return cls_rule
? CONTAINER_OF(cls_rule
, struct fte
, rule
) : NULL
;
1775 /* Frees 'fte' and its versions. */
1777 fte_free(struct fte
*fte
)
1780 fte_version_free(fte
->versions
[0]);
1781 fte_version_free(fte
->versions
[1]);
1782 cls_rule_destroy(&fte
->rule
);
1787 /* Frees all of the FTEs within 'cls'. */
1789 fte_free_all(struct classifier
*cls
)
1791 struct cls_cursor cursor
;
1792 struct fte
*fte
, *next
;
1794 cls_cursor_init(&cursor
, cls
, NULL
);
1795 CLS_CURSOR_FOR_EACH_SAFE (fte
, next
, rule
, &cursor
) {
1796 classifier_remove(cls
, &fte
->rule
);
1799 classifier_destroy(cls
);
1802 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1803 * necessary. Sets 'version' as the version of that rule with the given
1804 * 'index', replacing any existing version, if any.
1806 * Takes ownership of 'version'. */
1808 fte_insert(struct classifier
*cls
, const struct match
*match
,
1809 unsigned int priority
, struct fte_version
*version
, int index
)
1811 struct fte
*old
, *fte
;
1813 fte
= xzalloc(sizeof *fte
);
1814 cls_rule_init(&fte
->rule
, match
, priority
);
1815 fte
->versions
[index
] = version
;
1817 old
= fte_from_cls_rule(classifier_replace(cls
, &fte
->rule
));
1819 fte_version_free(old
->versions
[index
]);
1820 fte
->versions
[!index
] = old
->versions
[!index
];
1821 cls_rule_destroy(&old
->rule
);
1826 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1827 * with the specified 'index'. Returns the flow formats able to represent the
1828 * flows that were read. */
1829 static enum ofputil_protocol
1830 read_flows_from_file(const char *filename
, struct classifier
*cls
, int index
)
1832 enum ofputil_protocol usable_protocols
;
1836 file
= !strcmp(filename
, "-") ? stdin
: fopen(filename
, "r");
1838 ovs_fatal(errno
, "%s: open", filename
);
1842 usable_protocols
= OFPUTIL_P_ANY
;
1843 while (!ds_get_preprocessed_line(&s
, file
)) {
1844 struct fte_version
*version
;
1845 struct ofputil_flow_mod fm
;
1847 parse_ofp_str(&fm
, OFPFC_ADD
, ds_cstr(&s
), true);
1849 version
= xmalloc(sizeof *version
);
1850 version
->cookie
= fm
.new_cookie
;
1851 version
->idle_timeout
= fm
.idle_timeout
;
1852 version
->hard_timeout
= fm
.hard_timeout
;
1853 version
->flags
= fm
.flags
& (OFPFF_SEND_FLOW_REM
| OFPFF10_EMERG
);
1854 version
->ofpacts
= fm
.ofpacts
;
1855 version
->ofpacts_len
= fm
.ofpacts_len
;
1857 usable_protocols
&= ofputil_usable_protocols(&fm
.match
);
1859 fte_insert(cls
, &fm
.match
, fm
.priority
, version
, index
);
1863 if (file
!= stdin
) {
1867 return usable_protocols
;
1871 recv_flow_stats_reply(struct vconn
*vconn
, ovs_be32 send_xid
,
1872 struct ofpbuf
**replyp
,
1873 struct ofputil_flow_stats
*fs
, struct ofpbuf
*ofpacts
)
1875 struct ofpbuf
*reply
= *replyp
;
1881 /* Get a flow stats reply message, if we don't already have one. */
1887 run(vconn_recv_block(vconn
, &reply
),
1888 "OpenFlow packet receive failed");
1889 } while (((struct ofp_header
*) reply
->data
)->xid
!= send_xid
);
1891 error
= ofptype_decode(&type
, reply
->data
);
1892 if (error
|| type
!= OFPTYPE_FLOW_STATS_REPLY
) {
1893 ovs_fatal(0, "received bad reply: %s",
1894 ofp_to_string(reply
->data
, reply
->size
,
1899 /* Pull an individual flow stats reply out of the message. */
1900 retval
= ofputil_decode_flow_stats_reply(fs
, reply
, false, ofpacts
);
1907 more
= ofpmp_more(reply
->l2
);
1908 ofpbuf_delete(reply
);
1917 ovs_fatal(0, "parse error in reply (%s)",
1918 ofperr_to_string(retval
));
1923 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1924 * format 'protocol', and adds them as flow table entries in 'cls' for the
1925 * version with the specified 'index'. */
1927 read_flows_from_switch(struct vconn
*vconn
,
1928 enum ofputil_protocol protocol
,
1929 struct classifier
*cls
, int index
)
1931 struct ofputil_flow_stats_request fsr
;
1932 struct ofputil_flow_stats fs
;
1933 struct ofpbuf
*request
;
1934 struct ofpbuf ofpacts
;
1935 struct ofpbuf
*reply
;
1938 fsr
.aggregate
= false;
1939 match_init_catchall(&fsr
.match
);
1940 fsr
.out_port
= OFPP_NONE
;
1941 fsr
.table_id
= 0xff;
1942 fsr
.cookie
= fsr
.cookie_mask
= htonll(0);
1943 request
= ofputil_encode_flow_stats_request(&fsr
, protocol
);
1944 send_xid
= ((struct ofp_header
*) request
->data
)->xid
;
1945 send_openflow_buffer(vconn
, request
);
1948 ofpbuf_init(&ofpacts
, 0);
1949 while (recv_flow_stats_reply(vconn
, send_xid
, &reply
, &fs
, &ofpacts
)) {
1950 struct fte_version
*version
;
1952 version
= xmalloc(sizeof *version
);
1953 version
->cookie
= fs
.cookie
;
1954 version
->idle_timeout
= fs
.idle_timeout
;
1955 version
->hard_timeout
= fs
.hard_timeout
;
1957 version
->ofpacts_len
= fs
.ofpacts_len
;
1958 version
->ofpacts
= xmemdup(fs
.ofpacts
, fs
.ofpacts_len
);
1960 fte_insert(cls
, &fs
.match
, fs
.priority
, version
, index
);
1962 ofpbuf_uninit(&ofpacts
);
1966 fte_make_flow_mod(const struct fte
*fte
, int index
, uint16_t command
,
1967 enum ofputil_protocol protocol
, struct list
*packets
)
1969 const struct fte_version
*version
= fte
->versions
[index
];
1970 struct ofputil_flow_mod fm
;
1973 minimatch_expand(&fte
->rule
.match
, &fm
.match
);
1974 fm
.priority
= fte
->rule
.priority
;
1975 fm
.cookie
= htonll(0);
1976 fm
.cookie_mask
= htonll(0);
1977 fm
.new_cookie
= version
->cookie
;
1979 fm
.command
= command
;
1980 fm
.idle_timeout
= version
->idle_timeout
;
1981 fm
.hard_timeout
= version
->hard_timeout
;
1982 fm
.buffer_id
= UINT32_MAX
;
1983 fm
.out_port
= OFPP_NONE
;
1984 fm
.flags
= version
->flags
;
1985 if (command
== OFPFC_ADD
|| command
== OFPFC_MODIFY
||
1986 command
== OFPFC_MODIFY_STRICT
) {
1987 fm
.ofpacts
= version
->ofpacts
;
1988 fm
.ofpacts_len
= version
->ofpacts_len
;
1994 ofm
= ofputil_encode_flow_mod(&fm
, protocol
);
1995 list_push_back(packets
, &ofm
->list_node
);
1999 ofctl_replace_flows(int argc OVS_UNUSED
, char *argv
[])
2001 enum { FILE_IDX
= 0, SWITCH_IDX
= 1 };
2002 enum ofputil_protocol usable_protocols
, protocol
;
2003 struct cls_cursor cursor
;
2004 struct classifier cls
;
2005 struct list requests
;
2006 struct vconn
*vconn
;
2009 classifier_init(&cls
);
2010 usable_protocols
= read_flows_from_file(argv
[2], &cls
, FILE_IDX
);
2012 protocol
= open_vconn(argv
[1], &vconn
);
2013 protocol
= set_protocol_for_flow_dump(vconn
, protocol
, usable_protocols
);
2015 read_flows_from_switch(vconn
, protocol
, &cls
, SWITCH_IDX
);
2017 list_init(&requests
);
2019 /* Delete flows that exist on the switch but not in the file. */
2020 cls_cursor_init(&cursor
, &cls
, NULL
);
2021 CLS_CURSOR_FOR_EACH (fte
, rule
, &cursor
) {
2022 struct fte_version
*file_ver
= fte
->versions
[FILE_IDX
];
2023 struct fte_version
*sw_ver
= fte
->versions
[SWITCH_IDX
];
2025 if (sw_ver
&& !file_ver
) {
2026 fte_make_flow_mod(fte
, SWITCH_IDX
, OFPFC_DELETE_STRICT
,
2027 protocol
, &requests
);
2031 /* Add flows that exist in the file but not on the switch.
2032 * Update flows that exist in both places but differ. */
2033 cls_cursor_init(&cursor
, &cls
, NULL
);
2034 CLS_CURSOR_FOR_EACH (fte
, rule
, &cursor
) {
2035 struct fte_version
*file_ver
= fte
->versions
[FILE_IDX
];
2036 struct fte_version
*sw_ver
= fte
->versions
[SWITCH_IDX
];
2039 && (readd
|| !sw_ver
|| !fte_version_equals(sw_ver
, file_ver
))) {
2040 fte_make_flow_mod(fte
, FILE_IDX
, OFPFC_ADD
, protocol
, &requests
);
2043 transact_multiple_noreply(vconn
, &requests
);
2050 read_flows_from_source(const char *source
, struct classifier
*cls
, int index
)
2054 if (source
[0] == '/' || source
[0] == '.'
2055 || (!strchr(source
, ':') && !stat(source
, &s
))) {
2056 read_flows_from_file(source
, cls
, index
);
2058 enum ofputil_protocol protocol
;
2059 struct vconn
*vconn
;
2061 protocol
= open_vconn(source
, &vconn
);
2062 protocol
= set_protocol_for_flow_dump(vconn
, protocol
, OFPUTIL_P_ANY
);
2063 read_flows_from_switch(vconn
, protocol
, cls
, index
);
2069 ofctl_diff_flows(int argc OVS_UNUSED
, char *argv
[])
2071 bool differences
= false;
2072 struct cls_cursor cursor
;
2073 struct classifier cls
;
2077 classifier_init(&cls
);
2078 read_flows_from_source(argv
[1], &cls
, 0);
2079 read_flows_from_source(argv
[2], &cls
, 1);
2084 cls_cursor_init(&cursor
, &cls
, NULL
);
2085 CLS_CURSOR_FOR_EACH (fte
, rule
, &cursor
) {
2086 struct fte_version
*a
= fte
->versions
[0];
2087 struct fte_version
*b
= fte
->versions
[1];
2089 if (!a
|| !b
|| !fte_version_equals(a
, b
)) {
2090 fte_version_format(fte
, 0, &a_s
);
2091 fte_version_format(fte
, 1, &b_s
);
2092 if (strcmp(ds_cstr(&a_s
), ds_cstr(&b_s
))) {
2094 printf("-%s", ds_cstr(&a_s
));
2097 printf("+%s", ds_cstr(&b_s
));
2114 /* Undocumented commands for unit testing. */
2117 ofctl_parse_flows__(struct ofputil_flow_mod
*fms
, size_t n_fms
)
2119 enum ofputil_protocol usable_protocols
;
2120 enum ofputil_protocol protocol
= 0;
2124 usable_protocols
= ofputil_flow_mod_usable_protocols(fms
, n_fms
);
2125 usable_s
= ofputil_protocols_to_string(usable_protocols
);
2126 printf("usable protocols: %s\n", usable_s
);
2129 if (!(usable_protocols
& allowed_protocols
)) {
2130 ovs_fatal(0, "no usable protocol");
2132 for (i
= 0; i
< sizeof(enum ofputil_protocol
) * CHAR_BIT
; i
++) {
2134 if (protocol
& usable_protocols
& allowed_protocols
) {
2138 assert(IS_POW2(protocol
));
2140 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol
));
2142 for (i
= 0; i
< n_fms
; i
++) {
2143 struct ofputil_flow_mod
*fm
= &fms
[i
];
2146 msg
= ofputil_encode_flow_mod(fm
, protocol
);
2147 ofp_print(stdout
, msg
->data
, msg
->size
, verbosity
);
2154 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2155 * it back to stdout. */
2157 ofctl_parse_flow(int argc OVS_UNUSED
, char *argv
[])
2159 struct ofputil_flow_mod fm
;
2161 parse_ofp_flow_mod_str(&fm
, argv
[1], OFPFC_ADD
, false);
2162 ofctl_parse_flows__(&fm
, 1);
2165 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2166 * add-flows) and prints each of the flows back to stdout. */
2168 ofctl_parse_flows(int argc OVS_UNUSED
, char *argv
[])
2170 struct ofputil_flow_mod
*fms
= NULL
;
2173 parse_ofp_flow_mod_file(argv
[1], OFPFC_ADD
, &fms
, &n_fms
);
2174 ofctl_parse_flows__(fms
, n_fms
);
2179 ofctl_parse_nxm__(bool oxm
)
2184 while (!ds_get_test_line(&in
, stdin
)) {
2185 struct ofpbuf nx_match
;
2187 ovs_be64 cookie
, cookie_mask
;
2191 /* Convert string to nx_match. */
2192 ofpbuf_init(&nx_match
, 0);
2194 match_len
= oxm_match_from_string(ds_cstr(&in
), &nx_match
);
2196 match_len
= nx_match_from_string(ds_cstr(&in
), &nx_match
);
2199 /* Convert nx_match to match. */
2202 error
= oxm_pull_match(&nx_match
, &match
);
2204 error
= nx_pull_match(&nx_match
, match_len
, &match
,
2205 &cookie
, &cookie_mask
);
2209 error
= oxm_pull_match_loose(&nx_match
, &match
);
2211 error
= nx_pull_match_loose(&nx_match
, match_len
, &match
,
2212 &cookie
, &cookie_mask
);
2220 /* Convert match back to nx_match. */
2221 ofpbuf_uninit(&nx_match
);
2222 ofpbuf_init(&nx_match
, 0);
2224 match_len
= oxm_put_match(&nx_match
, &match
);
2225 out
= oxm_match_to_string(nx_match
.data
, match_len
);
2227 match_len
= nx_put_match(&nx_match
, &match
,
2228 cookie
, cookie_mask
);
2229 out
= nx_match_to_string(nx_match
.data
, match_len
);
2235 printf("nx_pull_match() returned error %s\n",
2236 ofperr_get_name(error
));
2239 ofpbuf_uninit(&nx_match
);
2244 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2245 * stdin, does some internal fussing with them, and then prints them back as
2246 * strings on stdout. */
2248 ofctl_parse_nxm(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2250 return ofctl_parse_nxm__(false);
2253 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2254 * stdin, does some internal fussing with them, and then prints them back as
2255 * strings on stdout. */
2257 ofctl_parse_oxm(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2259 return ofctl_parse_nxm__(true);
2263 print_differences(const char *prefix
,
2264 const void *a_
, size_t a_len
,
2265 const void *b_
, size_t b_len
)
2267 const uint8_t *a
= a_
;
2268 const uint8_t *b
= b_
;
2271 for (i
= 0; i
< MIN(a_len
, b_len
); i
++) {
2273 printf("%s%2zu: %02"PRIx8
" -> %02"PRIx8
"\n",
2274 prefix
, i
, a
[i
], b
[i
]);
2277 for (i
= a_len
; i
< b_len
; i
++) {
2278 printf("%s%2zu: (none) -> %02"PRIx8
"\n", prefix
, i
, b
[i
]);
2280 for (i
= b_len
; i
< a_len
; i
++) {
2281 printf("%s%2zu: %02"PRIx8
" -> (none)\n", prefix
, i
, a
[i
]);
2285 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2286 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2287 * on stdout, and then converts them back to hex bytes and prints any
2288 * differences from the input. */
2290 ofctl_parse_ofp10_actions(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2295 while (!ds_get_preprocessed_line(&in
, stdin
)) {
2296 struct ofpbuf of10_out
;
2297 struct ofpbuf of10_in
;
2298 struct ofpbuf ofpacts
;
2303 /* Parse hex bytes. */
2304 ofpbuf_init(&of10_in
, 0);
2305 if (ofpbuf_put_hex(&of10_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
2306 ovs_fatal(0, "Trailing garbage in hex data");
2309 /* Convert to ofpacts. */
2310 ofpbuf_init(&ofpacts
, 0);
2311 size
= of10_in
.size
;
2312 error
= ofpacts_pull_openflow10(&of10_in
, of10_in
.size
, &ofpacts
);
2314 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error
));
2315 ofpbuf_uninit(&ofpacts
);
2316 ofpbuf_uninit(&of10_in
);
2319 ofpbuf_push_uninit(&of10_in
, size
);
2321 /* Print cls_rule. */
2323 ofpacts_format(ofpacts
.data
, ofpacts
.size
, &s
);
2327 /* Convert back to ofp10 actions and print differences from input. */
2328 ofpbuf_init(&of10_out
, 0);
2329 ofpacts_put_openflow10(ofpacts
.data
, ofpacts
.size
, &of10_out
);
2331 print_differences("", of10_in
.data
, of10_in
.size
,
2332 of10_out
.data
, of10_out
.size
);
2335 ofpbuf_uninit(&ofpacts
);
2336 ofpbuf_uninit(&of10_in
);
2337 ofpbuf_uninit(&of10_out
);
2342 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2343 * bytes from stdin, converts them to cls_rules, prints them as strings on
2344 * stdout, and then converts them back to hex bytes and prints any differences
2347 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
2348 * values are ignored in the input and will be set to zero when OVS converts
2349 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
2350 * it does the conversion to hex, to ensure that in fact they are ignored. */
2352 ofctl_parse_ofp10_match(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2359 while (!ds_get_preprocessed_line(&in
, stdin
)) {
2360 struct ofpbuf match_in
, match_expout
;
2361 struct ofp10_match match_out
;
2362 struct ofp10_match match_normal
;
2366 /* Parse hex bytes to use for expected output. */
2368 ds_put_cstr(&expout
, ds_cstr(&in
));
2369 for (p
= ds_cstr(&expout
); *p
; p
++) {
2374 ofpbuf_init(&match_expout
, 0);
2375 if (ofpbuf_put_hex(&match_expout
, ds_cstr(&expout
), NULL
)[0] != '\0') {
2376 ovs_fatal(0, "Trailing garbage in hex data");
2378 if (match_expout
.size
!= sizeof(struct ofp10_match
)) {
2379 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2380 match_expout
.size
, sizeof(struct ofp10_match
));
2383 /* Parse hex bytes for input. */
2384 for (p
= ds_cstr(&in
); *p
; p
++) {
2386 *p
= "0123456789abcdef"[random_uint32() & 0xf];
2389 ofpbuf_init(&match_in
, 0);
2390 if (ofpbuf_put_hex(&match_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
2391 ovs_fatal(0, "Trailing garbage in hex data");
2393 if (match_in
.size
!= sizeof(struct ofp10_match
)) {
2394 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2395 match_in
.size
, sizeof(struct ofp10_match
));
2398 /* Convert to cls_rule and print. */
2399 ofputil_match_from_ofp10_match(match_in
.data
, &match
);
2400 match_print(&match
);
2402 /* Convert back to ofp10_match and print differences from input. */
2403 ofputil_match_to_ofp10_match(&match
, &match_out
);
2404 print_differences("", match_expout
.data
, match_expout
.size
,
2405 &match_out
, sizeof match_out
);
2407 /* Normalize, then convert and compare again. */
2408 ofputil_normalize_match(&match
);
2409 ofputil_match_to_ofp10_match(&match
, &match_normal
);
2410 print_differences("normal: ", &match_out
, sizeof match_out
,
2411 &match_normal
, sizeof match_normal
);
2414 ofpbuf_uninit(&match_in
);
2415 ofpbuf_uninit(&match_expout
);
2418 ds_destroy(&expout
);
2421 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2422 * bytes from stdin, converts them to "struct match"es, prints them as strings
2423 * on stdout, and then converts them back to hex bytes and prints any
2424 * differences from the input. */
2426 ofctl_parse_ofp11_match(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2431 while (!ds_get_preprocessed_line(&in
, stdin
)) {
2432 struct ofpbuf match_in
;
2433 struct ofp11_match match_out
;
2437 /* Parse hex bytes. */
2438 ofpbuf_init(&match_in
, 0);
2439 if (ofpbuf_put_hex(&match_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
2440 ovs_fatal(0, "Trailing garbage in hex data");
2442 if (match_in
.size
!= sizeof(struct ofp11_match
)) {
2443 ovs_fatal(0, "Input is %zu bytes, expected %zu",
2444 match_in
.size
, sizeof(struct ofp11_match
));
2447 /* Convert to match. */
2448 error
= ofputil_match_from_ofp11_match(match_in
.data
, &match
);
2450 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error
));
2451 ofpbuf_uninit(&match_in
);
2456 match_print(&match
);
2458 /* Convert back to ofp11_match and print differences from input. */
2459 ofputil_match_to_ofp11_match(&match
, &match_out
);
2461 print_differences("", match_in
.data
, match_in
.size
,
2462 &match_out
, sizeof match_out
);
2465 ofpbuf_uninit(&match_in
);
2470 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2471 * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2472 * on stdout, and then converts them back to hex bytes and prints any
2473 * differences from the input. */
2475 ofctl_parse_ofp11_actions(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2480 while (!ds_get_preprocessed_line(&in
, stdin
)) {
2481 struct ofpbuf of11_out
;
2482 struct ofpbuf of11_in
;
2483 struct ofpbuf ofpacts
;
2488 /* Parse hex bytes. */
2489 ofpbuf_init(&of11_in
, 0);
2490 if (ofpbuf_put_hex(&of11_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
2491 ovs_fatal(0, "Trailing garbage in hex data");
2494 /* Convert to ofpacts. */
2495 ofpbuf_init(&ofpacts
, 0);
2496 size
= of11_in
.size
;
2497 error
= ofpacts_pull_openflow11_actions(&of11_in
, of11_in
.size
,
2500 printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error
));
2501 ofpbuf_uninit(&ofpacts
);
2502 ofpbuf_uninit(&of11_in
);
2505 ofpbuf_push_uninit(&of11_in
, size
);
2507 /* Print cls_rule. */
2509 ofpacts_format(ofpacts
.data
, ofpacts
.size
, &s
);
2513 /* Convert back to ofp11 actions and print differences from input. */
2514 ofpbuf_init(&of11_out
, 0);
2515 ofpacts_put_openflow11_actions(ofpacts
.data
, ofpacts
.size
, &of11_out
);
2517 print_differences("", of11_in
.data
, of11_in
.size
,
2518 of11_out
.data
, of11_out
.size
);
2521 ofpbuf_uninit(&ofpacts
);
2522 ofpbuf_uninit(&of11_in
);
2523 ofpbuf_uninit(&of11_out
);
2528 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
2529 * specifications as hex bytes from stdin, converts them to ofpacts, prints
2530 * them as strings on stdout, and then converts them back to hex bytes and
2531 * prints any differences from the input. */
2533 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED
, char *argv
[] OVS_UNUSED
)
2538 while (!ds_get_preprocessed_line(&in
, stdin
)) {
2539 struct ofpbuf of11_out
;
2540 struct ofpbuf of11_in
;
2541 struct ofpbuf ofpacts
;
2546 /* Parse hex bytes. */
2547 ofpbuf_init(&of11_in
, 0);
2548 if (ofpbuf_put_hex(&of11_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
2549 ovs_fatal(0, "Trailing garbage in hex data");
2552 /* Convert to ofpacts. */
2553 ofpbuf_init(&ofpacts
, 0);
2554 size
= of11_in
.size
;
2555 error
= ofpacts_pull_openflow11_instructions(&of11_in
, of11_in
.size
,
2558 printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error
));
2559 ofpbuf_uninit(&ofpacts
);
2560 ofpbuf_uninit(&of11_in
);
2563 ofpbuf_push_uninit(&of11_in
, size
);
2565 /* Print cls_rule. */
2567 ofpacts_format(ofpacts
.data
, ofpacts
.size
, &s
);
2571 /* Convert back to ofp11 instructions and print differences from
2573 ofpbuf_init(&of11_out
, 0);
2574 ofpacts_put_openflow11_instructions(ofpacts
.data
, ofpacts
.size
,
2577 print_differences("", of11_in
.data
, of11_in
.size
,
2578 of11_out
.data
, of11_out
.size
);
2581 ofpbuf_uninit(&ofpacts
);
2582 ofpbuf_uninit(&of11_in
);
2583 ofpbuf_uninit(&of11_out
);
2588 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
2589 * mask values to and from various formats and prints the results. */
2591 ofctl_check_vlan(int argc OVS_UNUSED
, char *argv
[])
2596 struct ofputil_flow_mod fm
;
2599 struct match nxm_match
;
2603 struct ofp10_match of10_raw
;
2604 struct match of10_match
;
2606 struct ofp11_match of11_raw
;
2607 struct match of11_match
;
2611 match_init_catchall(&match
);
2612 match
.flow
.vlan_tci
= htons(strtoul(argv
[1], NULL
, 16));
2613 match
.wc
.masks
.vlan_tci
= htons(strtoul(argv
[2], NULL
, 16));
2615 /* Convert to and from string. */
2616 string_s
= match_to_string(&match
, OFP_DEFAULT_PRIORITY
);
2617 printf("%s -> ", string_s
);
2619 parse_ofp_str(&fm
, -1, string_s
, false);
2620 printf("%04"PRIx16
"/%04"PRIx16
"\n",
2621 ntohs(fm
.match
.flow
.vlan_tci
),
2622 ntohs(fm
.match
.wc
.masks
.vlan_tci
));
2625 /* Convert to and from NXM. */
2626 ofpbuf_init(&nxm
, 0);
2627 nxm_match_len
= nx_put_match(&nxm
, &match
, htonll(0), htonll(0));
2628 nxm_s
= nx_match_to_string(nxm
.data
, nxm_match_len
);
2629 error
= nx_pull_match(&nxm
, nxm_match_len
, &nxm_match
, NULL
, NULL
);
2630 printf("NXM: %s -> ", nxm_s
);
2632 printf("%s\n", ofperr_to_string(error
));
2634 printf("%04"PRIx16
"/%04"PRIx16
"\n",
2635 ntohs(nxm_match
.flow
.vlan_tci
),
2636 ntohs(nxm_match
.wc
.masks
.vlan_tci
));
2639 ofpbuf_uninit(&nxm
);
2641 /* Convert to and from OXM. */
2642 ofpbuf_init(&nxm
, 0);
2643 nxm_match_len
= oxm_put_match(&nxm
, &match
);
2644 nxm_s
= oxm_match_to_string(nxm
.data
, nxm_match_len
);
2645 error
= oxm_pull_match(&nxm
, &nxm_match
);
2646 printf("OXM: %s -> ", nxm_s
);
2648 printf("%s\n", ofperr_to_string(error
));
2650 uint16_t vid
= ntohs(nxm_match
.flow
.vlan_tci
) &
2651 (VLAN_VID_MASK
| VLAN_CFI
);
2652 uint16_t mask
= ntohs(nxm_match
.wc
.masks
.vlan_tci
) &
2653 (VLAN_VID_MASK
| VLAN_CFI
);
2655 printf("%04"PRIx16
"/%04"PRIx16
",", vid
, mask
);
2656 if (vid
&& vlan_tci_to_pcp(nxm_match
.wc
.masks
.vlan_tci
)) {
2657 printf("%02"PRIx8
"\n", vlan_tci_to_pcp(nxm_match
.flow
.vlan_tci
));
2663 ofpbuf_uninit(&nxm
);
2665 /* Convert to and from OpenFlow 1.0. */
2666 ofputil_match_to_ofp10_match(&match
, &of10_raw
);
2667 ofputil_match_from_ofp10_match(&of10_raw
, &of10_match
);
2668 printf("OF1.0: %04"PRIx16
"/%d,%02"PRIx8
"/%d -> %04"PRIx16
"/%04"PRIx16
"\n",
2669 ntohs(of10_raw
.dl_vlan
),
2670 (of10_raw
.wildcards
& htonl(OFPFW10_DL_VLAN
)) != 0,
2671 of10_raw
.dl_vlan_pcp
,
2672 (of10_raw
.wildcards
& htonl(OFPFW10_DL_VLAN_PCP
)) != 0,
2673 ntohs(of10_match
.flow
.vlan_tci
),
2674 ntohs(of10_match
.wc
.masks
.vlan_tci
));
2676 /* Convert to and from OpenFlow 1.1. */
2677 ofputil_match_to_ofp11_match(&match
, &of11_raw
);
2678 ofputil_match_from_ofp11_match(&of11_raw
, &of11_match
);
2679 printf("OF1.1: %04"PRIx16
"/%d,%02"PRIx8
"/%d -> %04"PRIx16
"/%04"PRIx16
"\n",
2680 ntohs(of11_raw
.dl_vlan
),
2681 (of11_raw
.wildcards
& htonl(OFPFW11_DL_VLAN
)) != 0,
2682 of11_raw
.dl_vlan_pcp
,
2683 (of11_raw
.wildcards
& htonl(OFPFW11_DL_VLAN_PCP
)) != 0,
2684 ntohs(of11_match
.flow
.vlan_tci
),
2685 ntohs(of11_match
.wc
.masks
.vlan_tci
));
2688 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
2691 ofctl_print_error(int argc OVS_UNUSED
, char *argv
[])
2696 error
= ofperr_from_name(argv
[1]);
2698 ovs_fatal(0, "unknown error \"%s\"", argv
[1]);
2701 for (version
= 0; version
<= UINT8_MAX
; version
++) {
2702 const char *name
= ofperr_domain_get_name(version
);
2706 printf("%s: %d,%d\n",
2707 ofperr_domain_get_name(version
),
2708 ofperr_get_type(error
, version
),
2709 ofperr_get_code(error
, version
));
2713 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
2714 * binary data, interpreting them as an OpenFlow message, and prints the
2715 * OpenFlow message on stdout, at VERBOSITY (level 2 by default). */
2717 ofctl_ofp_print(int argc
, char *argv
[])
2719 struct ofpbuf packet
;
2721 ofpbuf_init(&packet
, strlen(argv
[1]) / 2);
2722 if (ofpbuf_put_hex(&packet
, argv
[1], NULL
)[0] != '\0') {
2723 ovs_fatal(0, "trailing garbage following hex bytes");
2725 ofp_print(stdout
, packet
.data
, packet
.size
, argc
> 2 ? atoi(argv
[2]) : 2);
2726 ofpbuf_uninit(&packet
);
2729 static const struct command all_commands
[] = {
2730 { "show", 1, 1, ofctl_show
},
2731 { "monitor", 1, 3, ofctl_monitor
},
2732 { "snoop", 1, 1, ofctl_snoop
},
2733 { "dump-desc", 1, 1, ofctl_dump_desc
},
2734 { "dump-tables", 1, 1, ofctl_dump_tables
},
2735 { "dump-flows", 1, 2, ofctl_dump_flows
},
2736 { "dump-aggregate", 1, 2, ofctl_dump_aggregate
},
2737 { "queue-stats", 1, 3, ofctl_queue_stats
},
2738 { "add-flow", 2, 2, ofctl_add_flow
},
2739 { "add-flows", 2, 2, ofctl_add_flows
},
2740 { "mod-flows", 2, 2, ofctl_mod_flows
},
2741 { "del-flows", 1, 2, ofctl_del_flows
},
2742 { "replace-flows", 2, 2, ofctl_replace_flows
},
2743 { "diff-flows", 2, 2, ofctl_diff_flows
},
2744 { "packet-out", 4, INT_MAX
, ofctl_packet_out
},
2745 { "dump-ports", 1, 2, ofctl_dump_ports
},
2746 { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc
},
2747 { "mod-port", 3, 3, ofctl_mod_port
},
2748 { "get-frags", 1, 1, ofctl_get_frags
},
2749 { "set-frags", 2, 2, ofctl_set_frags
},
2750 { "probe", 1, 1, ofctl_probe
},
2751 { "ping", 1, 2, ofctl_ping
},
2752 { "benchmark", 3, 3, ofctl_benchmark
},
2753 { "help", 0, INT_MAX
, ofctl_help
},
2755 /* Undocumented commands for testing. */
2756 { "parse-flow", 1, 1, ofctl_parse_flow
},
2757 { "parse-flows", 1, 1, ofctl_parse_flows
},
2758 { "parse-nx-match", 0, 0, ofctl_parse_nxm
},
2759 { "parse-nxm", 0, 0, ofctl_parse_nxm
},
2760 { "parse-oxm", 0, 0, ofctl_parse_oxm
},
2761 { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions
},
2762 { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match
},
2763 { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match
},
2764 { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions
},
2765 { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions
},
2766 { "check-vlan", 2, 2, ofctl_check_vlan
},
2767 { "print-error", 1, 1, ofctl_print_error
},
2768 { "ofp-print", 1, 2, ofctl_ofp_print
},
2770 { NULL
, 0, 0, NULL
},