2 * Copyright (c) 2008-2017 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>
32 #include "byte-order.h"
33 #include "classifier.h"
34 #include "command-line.h"
39 #include "dp-packet.h"
40 #include "fatal-signal.h"
43 #include "ofp-version-opt.h"
44 #include "ofproto/ofproto.h"
45 #include "openflow/nicira-ext.h"
46 #include "openflow/openflow.h"
47 #include "openvswitch/dynamic-string.h"
48 #include "openvswitch/meta-flow.h"
49 #include "openvswitch/ofp-actions.h"
50 #include "openvswitch/ofp-errors.h"
51 #include "openvswitch/ofp-msgs.h"
52 #include "openvswitch/ofp-print.h"
53 #include "openvswitch/ofp-util.h"
54 #include "openvswitch/ofp-parse.h"
55 #include "openvswitch/ofpbuf.h"
56 #include "openvswitch/shash.h"
57 #include "openvswitch/vconn.h"
58 #include "openvswitch/vlog.h"
60 #include "pcap-file.h"
61 #include "poll-loop.h"
64 #include "stream-ssl.h"
65 #include "socket-util.h"
70 VLOG_DEFINE_THIS_MODULE(ofctl
);
72 /* --bundle: Use OpenFlow 1.3+ bundle for making the flow table change atomic.
73 * NOTE: If OpenFlow 1.3 or higher is not selected with the '-O' option,
74 * OpenFlow 1.4 will be implicitly selected. Also the flow mod will use
75 * OpenFlow 1.4, so the semantics may be different (see the comment in
76 * parse_options() for details).
78 static bool bundle
= false;
80 /* --color: Use color markers. */
81 static bool enable_color
;
83 /* --read-only: Do not execute read only commands. */
84 static bool read_only
;
86 /* --strict: Use strict matching for flow mod commands? Additionally governs
87 * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
91 /* --may-create: If true, the mod-group command creates a group that does not
92 * yet exist; otherwise, such a command has no effect. */
93 static bool may_create
;
95 /* --readd: If true, on replace-flows, re-add even flows that have not changed
96 * (to reset flow counters). */
99 /* -F, --flow-format: Allowed protocols. By default, any protocol is
101 static enum ofputil_protocol allowed_protocols
= OFPUTIL_P_ANY
;
103 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
104 * commands. Either one of NXPIF_* to force a particular packet_in format, or
105 * -1 to let ovs-ofctl choose the default. */
106 static int preferred_packet_in_format
= -1;
108 /* -m, --more: Additional verbosity for ofp-print functions. */
109 static int verbosity
;
111 /* --timestamp: Print a timestamp before each received packet on "monitor" and
112 * "snoop" command? */
113 static bool timestamp
;
115 /* --unixctl-path: Path to use for unixctl server, for "monitor" and "snoop"
117 static char *unixctl_path
;
119 /* --sort, --rsort: Sort order. */
120 enum sort_order
{ SORT_ASC
, SORT_DESC
};
121 struct sort_criterion
{
122 const struct mf_field
*field
; /* NULL means to sort by priority. */
123 enum sort_order order
;
125 static struct sort_criterion
*criteria
;
126 static size_t n_criteria
, allocated_criteria
;
128 /* --names, --no-names: Show port names in output and accept port numbers in
129 * input. (When neither is specified, the default is to accept port numbers
130 * but, for backward compatibility, not to show them unless this is an
131 * interactive console session.) */
132 static int use_port_names
= -1;
133 static const struct ofputil_port_map
*ports_to_accept(const char *vconn_name
);
134 static const struct ofputil_port_map
*ports_to_show(const char *vconn_name
);
135 static bool should_accept_ports(void);
136 static bool should_show_ports(void);
138 /* --stats, --no-stats: Show statistics in flow dumps? */
139 static int show_stats
= 1;
141 static const struct ovs_cmdl_command
*get_all_commands(void);
143 OVS_NO_RETURN
static void usage(void);
144 static void parse_options(int argc
, char *argv
[]);
147 main(int argc
, char *argv
[])
149 struct ovs_cmdl_context ctx
= { .argc
= 0, };
150 set_program_name(argv
[0]);
151 service_start(&argc
, &argv
);
152 parse_options(argc
, argv
);
153 fatal_ignore_sigpipe();
154 ctx
.argc
= argc
- optind
;
155 ctx
.argv
= argv
+ optind
;
157 daemon_become_new_user(false);
159 ovs_cmdl_run_command_read_only(&ctx
, get_all_commands());
161 ovs_cmdl_run_command(&ctx
, get_all_commands());
167 add_sort_criterion(enum sort_order order
, const char *field
)
169 struct sort_criterion
*sc
;
171 if (n_criteria
>= allocated_criteria
) {
172 criteria
= x2nrealloc(criteria
, &allocated_criteria
, sizeof *criteria
);
175 sc
= &criteria
[n_criteria
++];
176 if (!field
|| !strcasecmp(field
, "priority")) {
179 sc
->field
= mf_from_name(field
);
181 ovs_fatal(0, "%s: unknown field name", field
);
188 parse_options(int argc
, char *argv
[])
191 OPT_STRICT
= UCHAR_MAX
+ 1,
202 OFP_VERSION_OPTION_ENUMS
,
206 static const struct option long_options
[] = {
207 {"timeout", required_argument
, NULL
, 't'},
208 {"strict", no_argument
, NULL
, OPT_STRICT
},
209 {"readd", no_argument
, NULL
, OPT_READD
},
210 {"flow-format", required_argument
, NULL
, 'F'},
211 {"packet-in-format", required_argument
, NULL
, 'P'},
212 {"more", no_argument
, NULL
, 'm'},
213 {"timestamp", no_argument
, NULL
, OPT_TIMESTAMP
},
214 {"sort", optional_argument
, NULL
, OPT_SORT
},
215 {"rsort", optional_argument
, NULL
, OPT_RSORT
},
216 {"names", no_argument
, &use_port_names
, 1},
217 {"no-names", no_argument
, &use_port_names
, 0},
218 {"stats", no_argument
, &show_stats
, 1},
219 {"no-stats", no_argument
, &show_stats
, 0},
220 {"unixctl", required_argument
, NULL
, OPT_UNIXCTL
},
221 {"help", no_argument
, NULL
, 'h'},
222 {"option", no_argument
, NULL
, 'o'},
223 {"bundle", no_argument
, NULL
, OPT_BUNDLE
},
224 {"color", optional_argument
, NULL
, OPT_COLOR
},
225 {"may-create", no_argument
, NULL
, OPT_MAY_CREATE
},
226 {"read-only", no_argument
, NULL
, OPT_READ_ONLY
},
228 OFP_VERSION_LONG_OPTIONS
,
230 STREAM_SSL_LONG_OPTIONS
,
233 char *short_options
= ovs_cmdl_long_options_to_short_options(long_options
);
235 enum ofputil_protocol version_protocols
;
237 /* For now, ovs-ofctl only enables OpenFlow 1.0 by default. This is
238 * because ovs-ofctl implements command such as "add-flow" as raw OpenFlow
239 * requests, but those requests have subtly different semantics in
240 * different OpenFlow versions. For example:
242 * - In OpenFlow 1.0, a "mod-flow" operation that does not find any
243 * existing flow to modify adds a new flow.
245 * - In OpenFlow 1.1, a "mod-flow" operation that does not find any
246 * existing flow to modify adds a new flow, but only if the mod-flow
247 * did not match on the flow cookie.
249 * - In OpenFlow 1.2 and a later, a "mod-flow" operation never adds a
252 set_allowed_ofp_versions("OpenFlow10");
255 unsigned long int timeout
;
258 c
= getopt_long(argc
, argv
, short_options
, long_options
, NULL
);
265 timeout
= strtoul(optarg
, NULL
, 10);
267 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
275 allowed_protocols
= ofputil_protocols_from_string(optarg
);
276 if (!allowed_protocols
) {
277 ovs_fatal(0, "%s: invalid flow format(s)", optarg
);
282 preferred_packet_in_format
=
283 ofputil_packet_in_format_from_string(optarg
);
284 if (preferred_packet_in_format
< 0) {
285 ovs_fatal(0, "unknown packet-in format `%s'", optarg
);
297 ovs_cmdl_print_options(long_options
);
321 add_sort_criterion(SORT_ASC
, optarg
);
325 add_sort_criterion(SORT_DESC
, optarg
);
329 unixctl_path
= optarg
;
334 if (!strcasecmp(optarg
, "always")
335 || !strcasecmp(optarg
, "yes")
336 || !strcasecmp(optarg
, "force")) {
338 } else if (!strcasecmp(optarg
, "never")
339 || !strcasecmp(optarg
, "no")
340 || !strcasecmp(optarg
, "none")) {
341 enable_color
= false;
342 } else if (!strcasecmp(optarg
, "auto")
343 || !strcasecmp(optarg
, "tty")
344 || !strcasecmp(optarg
, "if-tty")) {
345 /* Determine whether we need colors, i.e. whether standard
346 * output is a tty. */
347 enable_color
= is_stdout_a_tty();
349 ovs_fatal(0, "incorrect value `%s' for --color", optarg
);
352 enable_color
= is_stdout_a_tty();
360 DAEMON_OPTION_HANDLERS
361 OFP_VERSION_OPTION_HANDLERS
363 STREAM_SSL_OPTION_HANDLERS
377 /* Always do a final sort pass based on priority. */
378 add_sort_criterion(SORT_DESC
, "priority");
383 /* Implicit OpenFlow 1.4 with the '--bundle' option. */
384 if (bundle
&& !(get_allowed_ofp_versions() &
385 ofputil_protocols_to_version_bitmap(OFPUTIL_P_OF13_UP
))) {
386 /* Add implicit allowance for OpenFlow 1.4. */
387 add_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
388 OFPUTIL_P_OF14_OXM
));
389 /* Remove all versions that do not support bundles. */
390 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
393 versions
= get_allowed_ofp_versions();
394 version_protocols
= ofputil_protocols_from_version_bitmap(versions
);
395 if (!(allowed_protocols
& version_protocols
)) {
396 char *protocols
= ofputil_protocols_to_string(allowed_protocols
);
397 struct ds version_s
= DS_EMPTY_INITIALIZER
;
399 ofputil_format_version_bitmap_names(&version_s
, versions
);
400 ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
401 "any of the enabled flow formats (%s). (Use -O to enable "
402 "additional OpenFlow versions or -F to enable additional "
403 "flow formats.)", ds_cstr(&version_s
), protocols
);
405 allowed_protocols
&= version_protocols
;
406 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
409 colors_init(enable_color
);
415 printf("%s: OpenFlow switch management utility\n"
416 "usage: %s [OPTIONS] COMMAND [ARG...]\n"
417 "\nFor OpenFlow switches:\n"
418 " show SWITCH show OpenFlow information\n"
419 " dump-desc SWITCH print switch description\n"
420 " dump-tables SWITCH print table stats\n"
421 " dump-table-features SWITCH print table features\n"
422 " dump-table-desc SWITCH print table description (OF1.4+)\n"
423 " mod-port SWITCH IFACE ACT modify port behavior\n"
424 " mod-table SWITCH MOD modify flow table behavior\n"
425 " OF1.1/1.2 MOD: controller, continue, drop\n"
426 " OF1.4+ MOD: evict, noevict, vacancy:low,high, novacancy\n"
427 " get-frags SWITCH print fragment handling behavior\n"
428 " set-frags SWITCH FRAG_MODE set fragment handling behavior\n"
429 " FRAG_MODE: normal, drop, reassemble, nx-match\n"
430 " dump-ports SWITCH [PORT] print port statistics\n"
431 " dump-ports-desc SWITCH [PORT] print port descriptions\n"
432 " dump-flows SWITCH print all flow entries\n"
433 " dump-flows SWITCH FLOW print matching FLOWs\n"
434 " dump-aggregate SWITCH print aggregate flow statistics\n"
435 " dump-aggregate SWITCH FLOW print aggregate stats for FLOWs\n"
436 " queue-stats SWITCH [PORT [QUEUE]] dump queue stats\n"
437 " add-flow SWITCH FLOW add flow described by FLOW\n"
438 " add-flows SWITCH FILE add flows from FILE\n"
439 " mod-flows SWITCH FLOW modify actions of matching FLOWs\n"
440 " del-flows SWITCH [FLOW] delete matching FLOWs\n"
441 " replace-flows SWITCH FILE replace flows with those in FILE\n"
442 " diff-flows SOURCE1 SOURCE2 compare flows from two sources\n"
443 " packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
444 " execute ACTIONS on PACKET\n"
445 " monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
446 " print packets received from SWITCH\n"
447 " snoop SWITCH snoop on SWITCH and its controller\n"
448 " add-group SWITCH GROUP add group described by GROUP\n"
449 " add-groups SWITCH FILE add group from FILE\n"
450 " [--may-create] mod-group SWITCH GROUP modify specific group\n"
451 " del-groups SWITCH [GROUP] delete matching GROUPs\n"
452 " insert-buckets SWITCH [GROUP] add buckets to GROUP\n"
453 " remove-buckets SWITCH [GROUP] remove buckets from GROUP\n"
454 " dump-group-features SWITCH print group features\n"
455 " dump-groups SWITCH [GROUP] print group description\n"
456 " dump-group-stats SWITCH [GROUP] print group statistics\n"
457 " queue-get-config SWITCH [PORT] print queue config for PORT\n"
458 " add-meter SWITCH METER add meter described by METER\n"
459 " mod-meter SWITCH METER modify specific METER\n"
460 " del-meter SWITCH METER delete METER\n"
461 " del-meters SWITCH delete all meters\n"
462 " dump-meter SWITCH METER print METER configuration\n"
463 " dump-meters SWITCH print all meter configuration\n"
464 " meter-stats SWITCH [METER] print meter statistics\n"
465 " meter-features SWITCH print meter features\n"
466 " add-tlv-map SWITCH MAP add TLV option MAPpings\n"
467 " del-tlv-map SWITCH [MAP] delete TLV option MAPpings\n"
468 " dump-tlv-map SWITCH print TLV option mappings\n"
469 " dump-ipfix-bridge SWITCH print ipfix stats of bridge\n"
470 " dump-ipfix-flow SWITCH print flow ipfix of a bridge\n"
471 " ct-flush-zone SWITCH ZONE flush conntrack entries in ZONE\n"
472 "\nFor OpenFlow switches and controllers:\n"
473 " probe TARGET probe whether TARGET is up\n"
474 " ping TARGET [N] latency of N-byte echos\n"
475 " benchmark TARGET N COUNT bandwidth of COUNT N-byte echos\n"
476 "SWITCH or TARGET is an active OpenFlow connection method.\n"
477 "\nOther commands:\n"
478 " ofp-parse FILE print messages read from FILE\n"
479 " ofp-parse-pcap PCAP print OpenFlow read from PCAP\n",
480 program_name
, program_name
);
481 vconn_usage(true, false, false);
485 printf("\nOther options:\n"
486 " --strict use strict match for flow commands\n"
487 " --read-only do not execute read/write commands\n"
488 " --readd replace flows that haven't changed\n"
489 " -F, --flow-format=FORMAT force particular flow format\n"
490 " -P, --packet-in-format=FRMT force particular packet in format\n"
491 " -m, --more be more verbose printing OpenFlow\n"
492 " --timestamp (monitor, snoop) print timestamps\n"
493 " -t, --timeout=SECS give up after SECS seconds\n"
494 " --sort[=field] sort in ascending order\n"
495 " --rsort[=field] sort in descending order\n"
496 " --names show port names instead of numbers\n"
497 " --unixctl=SOCKET set control socket name\n"
498 " --color[=always|never|auto] control use of color in output\n"
499 " -h, --help display this help message\n"
500 " -V, --version display version information\n");
505 ofctl_exit(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
506 const char *argv
[] OVS_UNUSED
, void *exiting_
)
508 bool *exiting
= exiting_
;
510 unixctl_command_reply(conn
, NULL
);
513 static void run(int retval
, const char *message
, ...)
514 OVS_PRINTF_FORMAT(2, 3);
517 run(int retval
, const char *message
, ...)
522 va_start(args
, message
);
523 ovs_fatal_valist(retval
, message
, args
);
527 /* Generic commands. */
530 open_vconn_socket(const char *name
, struct vconn
**vconnp
)
532 char *vconn_name
= xasprintf("unix:%s", name
);
535 error
= vconn_open(vconn_name
, get_allowed_ofp_versions(), DSCP_DEFAULT
,
537 if (error
&& error
!= ENOENT
) {
538 ovs_fatal(0, "%s: failed to open socket (%s)", name
,
539 ovs_strerror(error
));
546 enum open_target
{ MGMT
, SNOOP
};
548 static enum ofputil_protocol
549 open_vconn__(const char *name
, enum open_target target
,
550 struct vconn
**vconnp
)
552 const char *suffix
= target
== MGMT
? "mgmt" : "snoop";
553 char *datapath_name
, *datapath_type
, *socket_name
;
554 enum ofputil_protocol protocol
;
559 bridge_path
= xasprintf("%s/%s.%s", ovs_rundir(), name
, suffix
);
561 ofproto_parse_name(name
, &datapath_name
, &datapath_type
);
562 socket_name
= xasprintf("%s/%s.%s", ovs_rundir(), datapath_name
, suffix
);
566 if (strchr(name
, ':')) {
567 run(vconn_open(name
, get_allowed_ofp_versions(), DSCP_DEFAULT
, vconnp
),
568 "connecting to %s", name
);
569 } else if (!open_vconn_socket(name
, vconnp
)) {
571 } else if (!open_vconn_socket(bridge_path
, vconnp
)) {
573 } else if (!open_vconn_socket(socket_name
, vconnp
)) {
576 ovs_fatal(0, "%s is not a bridge or a socket", name
);
579 if (target
== SNOOP
) {
580 vconn_set_recv_any_version(*vconnp
);
586 VLOG_DBG("connecting to %s", vconn_get_name(*vconnp
));
587 error
= vconn_connect_block(*vconnp
);
589 ovs_fatal(0, "%s: failed to connect to socket (%s)", name
,
590 ovs_strerror(error
));
593 ofp_version
= vconn_get_version(*vconnp
);
594 protocol
= ofputil_protocol_from_ofp_version(ofp_version
);
596 ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
602 static enum ofputil_protocol
603 open_vconn(const char *name
, struct vconn
**vconnp
)
605 return open_vconn__(name
, MGMT
, vconnp
);
609 send_openflow_buffer(struct vconn
*vconn
, struct ofpbuf
*buffer
)
611 run(vconn_send_block(vconn
, buffer
), "failed to send packet to switch");
615 dump_transaction(struct vconn
*vconn
, struct ofpbuf
*request
)
617 const struct ofp_header
*oh
= request
->data
;
618 if (ofpmsg_is_stat_request(oh
)) {
619 ovs_be32 send_xid
= oh
->xid
;
620 enum ofpraw request_raw
;
621 enum ofpraw reply_raw
;
624 ofpraw_decode_partial(&request_raw
, request
->data
, request
->size
);
625 reply_raw
= ofpraw_stats_request_to_reply(request_raw
, oh
->version
);
627 send_openflow_buffer(vconn
, request
);
630 struct ofpbuf
*reply
;
632 run(vconn_recv_block(vconn
, &reply
),
633 "OpenFlow packet receive failed");
634 recv_xid
= ((struct ofp_header
*) reply
->data
)->xid
;
635 if (send_xid
== recv_xid
) {
638 ofp_print(stdout
, reply
->data
, reply
->size
,
639 ports_to_show(vconn_get_name(vconn
)), verbosity
+ 1);
641 ofpraw_decode(&raw
, reply
->data
);
642 if (ofptype_from_ofpraw(raw
) == OFPTYPE_ERROR
) {
644 } else if (raw
== reply_raw
) {
645 done
= !ofpmp_more(reply
->data
);
647 ovs_fatal(0, "received bad reply: %s",
649 reply
->data
, reply
->size
,
650 ports_to_show(vconn_get_name(vconn
)),
654 VLOG_DBG("received reply with xid %08"PRIx32
" "
655 "!= expected %08"PRIx32
, recv_xid
, send_xid
);
657 ofpbuf_delete(reply
);
660 struct ofpbuf
*reply
;
662 run(vconn_transact(vconn
, request
, &reply
), "talking to %s",
663 vconn_get_name(vconn
));
664 ofp_print(stdout
, reply
->data
, reply
->size
,
665 ports_to_show(vconn_get_name(vconn
)), verbosity
+ 1);
666 ofpbuf_delete(reply
);
671 dump_trivial_transaction(const char *vconn_name
, enum ofpraw raw
)
673 struct ofpbuf
*request
;
676 open_vconn(vconn_name
, &vconn
);
677 request
= ofpraw_alloc(raw
, vconn_get_version(vconn
), 0);
678 dump_transaction(vconn
, request
);
682 /* Sends all of the 'requests', which should be requests that only have replies
683 * if an error occurs, and waits for them to succeed or fail. If an error does
684 * occur, prints it and exits with an error.
686 * Destroys all of the 'requests'. */
688 transact_multiple_noreply(struct vconn
*vconn
, struct ovs_list
*requests
)
690 struct ofpbuf
*reply
;
692 run(vconn_transact_multiple_noreply(vconn
, requests
, &reply
),
693 "talking to %s", vconn_get_name(vconn
));
695 ofp_print(stderr
, reply
->data
, reply
->size
,
696 ports_to_show(vconn_get_name(vconn
)), verbosity
+ 2);
699 ofpbuf_delete(reply
);
702 /* Frees the error messages as they are printed. */
704 bundle_print_errors(struct ovs_list
*errors
, struct ovs_list
*requests
,
705 const char *vconn_name
)
707 struct ofpbuf
*error
, *next
;
710 INIT_CONTAINER(bmsg
, requests
, list_node
);
712 LIST_FOR_EACH_SAFE (error
, next
, list_node
, errors
) {
713 const struct ofp_header
*error_oh
= error
->data
;
714 ovs_be32 error_xid
= error_oh
->xid
;
716 struct ofpbuf payload
;
718 ofperr
= ofperr_decode_msg(error_oh
, &payload
);
720 fprintf(stderr
, "***decode error***");
722 /* Default to the likely truncated message. */
723 const struct ofp_header
*ofp_msg
= payload
.data
;
724 size_t msg_len
= payload
.size
;
726 /* Find the failing message from the requests list to be able to
727 * dump the whole message. We assume the errors are returned in
728 * the same order as in which the messages are sent to get O(n)
729 * rather than O(n^2) processing here. If this heuristics fails we
730 * may print the truncated hexdumps instead. */
731 LIST_FOR_EACH_CONTINUE (bmsg
, list_node
, requests
) {
732 const struct ofp_header
*oh
= bmsg
->data
;
734 if (oh
->xid
== error_xid
) {
736 msg_len
= bmsg
->size
;
740 fprintf(stderr
, "Error %s for: ", ofperr_get_name(ofperr
));
741 ofp_print(stderr
, ofp_msg
, msg_len
, ports_to_show(vconn_name
),
744 ofpbuf_uninit(&payload
);
745 ofpbuf_delete(error
);
751 bundle_transact(struct vconn
*vconn
, struct ovs_list
*requests
, uint16_t flags
)
753 struct ovs_list errors
;
754 int retval
= vconn_bundle_transact(vconn
, requests
, flags
, &errors
);
756 bundle_print_errors(&errors
, requests
, vconn_get_name(vconn
));
759 ovs_fatal(retval
, "talking to %s", vconn_get_name(vconn
));
763 /* Sends 'request', which should be a request that only has a reply if an error
764 * occurs, and waits for it to succeed or fail. If an error does occur, prints
765 * it and exits with an error.
767 * Destroys 'request'. */
769 transact_noreply(struct vconn
*vconn
, struct ofpbuf
*request
)
771 struct ovs_list requests
;
773 ovs_list_init(&requests
);
774 ovs_list_push_back(&requests
, &request
->list_node
);
775 transact_multiple_noreply(vconn
, &requests
);
779 fetch_switch_config(struct vconn
*vconn
, struct ofputil_switch_config
*config
)
781 struct ofpbuf
*request
;
782 struct ofpbuf
*reply
;
785 request
= ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST
,
786 vconn_get_version(vconn
), 0);
787 run(vconn_transact(vconn
, request
, &reply
),
788 "talking to %s", vconn_get_name(vconn
));
790 if (ofptype_decode(&type
, reply
->data
)
791 || type
!= OFPTYPE_GET_CONFIG_REPLY
) {
792 ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn
));
794 ofputil_decode_get_config_reply(reply
->data
, config
);
795 ofpbuf_delete(reply
);
799 set_switch_config(struct vconn
*vconn
,
800 const struct ofputil_switch_config
*config
)
802 enum ofp_version version
= vconn_get_version(vconn
);
803 transact_noreply(vconn
, ofputil_encode_set_config(config
, version
));
807 ofctl_show(struct ovs_cmdl_context
*ctx
)
809 const char *vconn_name
= ctx
->argv
[1];
810 enum ofp_version version
;
812 struct ofpbuf
*request
;
813 struct ofpbuf
*reply
;
816 open_vconn(vconn_name
, &vconn
);
817 version
= vconn_get_version(vconn
);
818 request
= ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST
, version
, 0);
819 run(vconn_transact(vconn
, request
, &reply
), "talking to %s", vconn_name
);
821 has_ports
= ofputil_switch_features_has_ports(reply
);
822 ofp_print(stdout
, reply
->data
, reply
->size
, NULL
, verbosity
+ 1);
823 ofpbuf_delete(reply
);
826 request
= ofputil_encode_port_desc_stats_request(version
, OFPP_ANY
);
827 dump_transaction(vconn
, request
);
829 dump_trivial_transaction(vconn_name
, OFPRAW_OFPT_GET_CONFIG_REQUEST
);
834 ofctl_dump_desc(struct ovs_cmdl_context
*ctx
)
836 dump_trivial_transaction(ctx
->argv
[1], OFPRAW_OFPST_DESC_REQUEST
);
840 ofctl_dump_tables(struct ovs_cmdl_context
*ctx
)
842 dump_trivial_transaction(ctx
->argv
[1], OFPRAW_OFPST_TABLE_REQUEST
);
846 ofctl_dump_table_features(struct ovs_cmdl_context
*ctx
)
848 struct ofpbuf
*request
;
851 open_vconn(ctx
->argv
[1], &vconn
);
852 request
= ofputil_encode_table_features_request(vconn_get_version(vconn
));
854 /* The following is similar to dump_trivial_transaction(), but it
855 * maintains the previous 'ofputil_table_features' from one stats reply
856 * message to the next, which allows duplication to be eliminated in the
857 * output across messages. Otherwise the output is much larger and harder
858 * to read, because only 17 or so ofputil_table_features elements fit in a
859 * single 64 kB OpenFlow message and therefore you get a ton of repetition
860 * (every 17th element is printed in full instead of abbreviated). */
862 const struct ofp_header
*request_oh
= request
->data
;
863 ovs_be32 send_xid
= request_oh
->xid
;
866 struct ofputil_table_features prev
;
869 send_openflow_buffer(vconn
, request
);
872 struct ofpbuf
*reply
;
874 run(vconn_recv_block(vconn
, &reply
), "OpenFlow packet receive failed");
875 recv_xid
= ((struct ofp_header
*) reply
->data
)->xid
;
876 if (send_xid
== recv_xid
) {
879 error
= ofptype_decode(&type
, reply
->data
);
881 ovs_fatal(0, "decode error: %s", ofperr_get_name(error
));
882 } else if (type
== OFPTYPE_ERROR
) {
883 ofp_print(stdout
, reply
->data
, reply
->size
, NULL
,
886 } else if (type
== OFPTYPE_TABLE_FEATURES_STATS_REPLY
) {
887 done
= !ofpmp_more(reply
->data
);
889 struct ofputil_table_features tf
;
892 retval
= ofputil_decode_table_features(reply
, &tf
, true);
895 ovs_fatal(0, "decode error: %s",
896 ofperr_get_name(retval
));
901 struct ds s
= DS_EMPTY_INITIALIZER
;
902 ofp_print_table_features(&s
, &tf
, n
? &prev
: NULL
,
911 ovs_fatal(0, "received bad reply: %s",
912 ofp_to_string(reply
->data
, reply
->size
,
913 ports_to_show(ctx
->argv
[1]),
917 VLOG_DBG("received reply with xid %08"PRIx32
" "
918 "!= expected %08"PRIx32
, recv_xid
, send_xid
);
920 ofpbuf_delete(reply
);
927 ofctl_dump_table_desc(struct ovs_cmdl_context
*ctx
)
929 struct ofpbuf
*request
;
932 open_vconn(ctx
->argv
[1], &vconn
);
933 request
= ofputil_encode_table_desc_request(vconn_get_version(vconn
));
935 dump_transaction(vconn
, request
);
943 str_to_ofp(const char *s
, ofp_port_t
*ofp_port
)
948 ret
= str_to_uint(s
, 10, &port_
);
949 *ofp_port
= u16_to_ofp(port_
);
953 struct port_iterator
{
956 enum { PI_FEATURES
, PI_PORT_DESC
} variant
;
957 struct ofpbuf
*reply
;
963 port_iterator_fetch_port_desc(struct port_iterator
*pi
)
965 pi
->variant
= PI_PORT_DESC
;
968 struct ofpbuf
*rq
= ofputil_encode_port_desc_stats_request(
969 vconn_get_version(pi
->vconn
), OFPP_ANY
);
970 pi
->send_xid
= ((struct ofp_header
*) rq
->data
)->xid
;
971 send_openflow_buffer(pi
->vconn
, rq
);
975 port_iterator_fetch_features(struct port_iterator
*pi
)
977 pi
->variant
= PI_FEATURES
;
979 /* Fetch the switch's ofp_switch_features. */
980 enum ofp_version version
= vconn_get_version(pi
->vconn
);
981 struct ofpbuf
*rq
= ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST
, version
, 0);
982 run(vconn_transact(pi
->vconn
, rq
, &pi
->reply
),
983 "talking to %s", vconn_get_name(pi
->vconn
));
986 if (ofptype_decode(&type
, pi
->reply
->data
)
987 || type
!= OFPTYPE_FEATURES_REPLY
) {
988 ovs_fatal(0, "%s: received bad features reply",
989 vconn_get_name(pi
->vconn
));
991 if (!ofputil_switch_features_has_ports(pi
->reply
)) {
992 /* The switch features reply does not contain a complete list of ports.
993 * Probably, there are more ports than will fit into a single 64 kB
994 * OpenFlow message. Use OFPST_PORT_DESC to get a complete list of
996 ofpbuf_delete(pi
->reply
);
998 port_iterator_fetch_port_desc(pi
);
1002 struct ofputil_switch_features features
;
1003 enum ofperr error
= ofputil_pull_switch_features(pi
->reply
, &features
);
1005 ovs_fatal(0, "%s: failed to decode features reply (%s)",
1006 vconn_get_name(pi
->vconn
), ofperr_to_string(error
));
1010 /* Initializes 'pi' to prepare for iterating through all of the ports on the
1011 * OpenFlow switch to which 'vconn' is connected.
1013 * During iteration, the client should not make other use of 'vconn', because
1014 * that can cause other messages to be interleaved with the replies used by the
1015 * iterator and thus some ports may be missed or a hang can occur. */
1017 port_iterator_init(struct port_iterator
*pi
, struct vconn
*vconn
)
1019 memset(pi
, 0, sizeof *pi
);
1021 if (vconn_get_version(vconn
) < OFP13_VERSION
) {
1022 port_iterator_fetch_features(pi
);
1024 port_iterator_fetch_port_desc(pi
);
1028 /* Obtains the next port from 'pi'. On success, initializes '*pp' with the
1029 * port's details and returns true, otherwise (if all the ports have already
1030 * been seen), returns false. */
1032 port_iterator_next(struct port_iterator
*pi
, struct ofputil_phy_port
*pp
)
1036 int retval
= ofputil_pull_phy_port(vconn_get_version(pi
->vconn
),
1040 } else if (retval
!= EOF
) {
1041 ovs_fatal(0, "received bad reply: %s",
1042 ofp_to_string(pi
->reply
->data
, pi
->reply
->size
,
1043 NULL
, verbosity
+ 1));
1047 if (pi
->variant
== PI_FEATURES
|| !pi
->more
) {
1053 ofpbuf_delete(pi
->reply
);
1054 run(vconn_recv_block(pi
->vconn
, &pi
->reply
),
1055 "OpenFlow receive failed");
1056 recv_xid
= ((struct ofp_header
*) pi
->reply
->data
)->xid
;
1057 } while (pi
->send_xid
!= recv_xid
);
1059 struct ofp_header
*oh
= pi
->reply
->data
;
1061 if (ofptype_pull(&type
, pi
->reply
)
1062 || type
!= OFPTYPE_PORT_DESC_STATS_REPLY
) {
1063 ovs_fatal(0, "received bad reply: %s",
1064 ofp_to_string(pi
->reply
->data
, pi
->reply
->size
, NULL
,
1068 pi
->more
= (ofpmp_flags(oh
) & OFPSF_REPLY_MORE
) != 0;
1072 /* Destroys iterator 'pi'. */
1074 port_iterator_destroy(struct port_iterator
*pi
)
1077 while (pi
->variant
== PI_PORT_DESC
&& pi
->more
) {
1078 /* Drain vconn's queue of any other replies for this request. */
1079 struct ofputil_phy_port pp
;
1080 port_iterator_next(pi
, &pp
);
1083 ofpbuf_delete(pi
->reply
);
1087 /* Opens a connection to 'vconn_name', fetches the port structure for
1088 * 'port_name' (which may be a port name or number), and copies it into
1091 fetch_ofputil_phy_port(const char *vconn_name
, const char *port_name
,
1092 struct ofputil_phy_port
*pp
)
1094 struct vconn
*vconn
;
1098 /* Try to interpret the argument as a port number. */
1099 if (!str_to_ofp(port_name
, &port_no
)) {
1100 port_no
= OFPP_NONE
;
1103 /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
1104 * OFPT_FEATURES_REPLY message. OpenFlow 1.3 and later versions put it
1105 * into the OFPST_PORT_DESC reply. Try it the correct way. */
1106 open_vconn(vconn_name
, &vconn
);
1107 struct port_iterator pi
;
1108 for (port_iterator_init(&pi
, vconn
); port_iterator_next(&pi
, pp
); ) {
1109 if (port_no
!= OFPP_NONE
1110 ? port_no
== pp
->port_no
1111 : !strcmp(pp
->name
, port_name
)) {
1116 port_iterator_destroy(&pi
);
1120 ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name
, port_name
);
1124 static const struct ofputil_port_map
*
1125 get_port_map(const char *vconn_name
)
1127 static struct shash port_maps
= SHASH_INITIALIZER(&port_maps
);
1128 struct ofputil_port_map
*map
= shash_find_data(&port_maps
, vconn_name
);
1130 map
= xmalloc(sizeof *map
);
1131 ofputil_port_map_init(map
);
1132 shash_add(&port_maps
, vconn_name
, map
);
1134 if (!strchr(vconn_name
, ':') || !vconn_verify_name(vconn_name
)) {
1135 /* For an active vconn (which includes a vconn constructed from a
1136 * bridge name), connect to it and pull down the port name-number
1138 struct vconn
*vconn
;
1139 open_vconn(vconn_name
, &vconn
);
1141 struct port_iterator pi
;
1142 struct ofputil_phy_port pp
;
1143 for (port_iterator_init(&pi
, vconn
);
1144 port_iterator_next(&pi
, &pp
); ) {
1145 ofputil_port_map_put(map
, pp
.port_no
, pp
.name
);
1147 port_iterator_destroy(&pi
);
1151 /* Don't bother with passive vconns, since it could take a long
1152 * time for the remote to try to connect to us. Don't bother with
1153 * invalid vconn names either. */
1159 static const struct ofputil_port_map
*
1160 ports_to_accept(const char *vconn_name
)
1162 return should_accept_ports() ? get_port_map(vconn_name
) : NULL
;
1165 static const struct ofputil_port_map
*
1166 ports_to_show(const char *vconn_name
)
1168 return should_show_ports() ? get_port_map(vconn_name
) : NULL
;
1171 /* We accept port names unless the feature is turned off explicitly. */
1173 should_accept_ports(void)
1175 return use_port_names
!= 0;
1178 /* We show port names only if the feature is turned on explicitly, or if we're
1179 * interacting with a user on the console. */
1181 should_show_ports(void)
1183 static int interactive
= -1;
1184 if (interactive
== -1) {
1185 interactive
= isatty(STDOUT_FILENO
);
1188 return use_port_names
> 0 || (use_port_names
== -1 && interactive
);
1191 /* Returns the port number corresponding to 'port_name' (which may be a port
1192 * name or number) within the switch 'vconn_name'. */
1194 str_to_port_no(const char *vconn_name
, const char *port_name
)
1197 if (ofputil_port_from_string(port_name
, NULL
, &port_no
) ||
1198 ofputil_port_from_string(port_name
, ports_to_accept(vconn_name
),
1202 ovs_fatal(0, "%s: unknown port `%s'", vconn_name
, port_name
);
1206 try_set_protocol(struct vconn
*vconn
, enum ofputil_protocol want
,
1207 enum ofputil_protocol
*cur
)
1210 struct ofpbuf
*request
, *reply
;
1211 enum ofputil_protocol next
;
1213 request
= ofputil_encode_set_protocol(*cur
, want
, &next
);
1215 return *cur
== want
;
1218 run(vconn_transact_noreply(vconn
, request
, &reply
),
1219 "talking to %s", vconn_get_name(vconn
));
1221 char *s
= ofp_to_string(reply
->data
, reply
->size
, NULL
, 2);
1222 VLOG_DBG("%s: failed to set protocol, switch replied: %s",
1223 vconn_get_name(vconn
), s
);
1225 ofpbuf_delete(reply
);
1233 static enum ofputil_protocol
1234 set_protocol_for_flow_dump(struct vconn
*vconn
,
1235 enum ofputil_protocol cur_protocol
,
1236 enum ofputil_protocol usable_protocols
)
1241 for (i
= 0; i
< ofputil_n_flow_dump_protocols
; i
++) {
1242 enum ofputil_protocol f
= ofputil_flow_dump_protocols
[i
];
1243 if (f
& usable_protocols
& allowed_protocols
1244 && try_set_protocol(vconn
, f
, &cur_protocol
)) {
1249 usable_s
= ofputil_protocols_to_string(usable_protocols
);
1250 if (usable_protocols
& allowed_protocols
) {
1251 ovs_fatal(0, "switch does not support any of the usable flow "
1252 "formats (%s)", usable_s
);
1254 char *allowed_s
= ofputil_protocols_to_string(allowed_protocols
);
1255 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1256 "allowed flow formats (%s)", usable_s
, allowed_s
);
1260 static struct vconn
*
1261 prepare_dump_flows(int argc
, char *argv
[], bool aggregate
,
1262 struct ofputil_flow_stats_request
*fsr
,
1263 enum ofputil_protocol
*protocolp
)
1265 const char *vconn_name
= argv
[1];
1266 enum ofputil_protocol usable_protocols
, protocol
;
1267 struct vconn
*vconn
;
1270 const char *match
= argc
> 2 ? argv
[2] : "";
1271 const struct ofputil_port_map
*port_map
1272 = *match
? ports_to_accept(vconn_name
) : NULL
;
1273 error
= parse_ofp_flow_stats_request_str(fsr
, aggregate
, match
,
1274 port_map
, &usable_protocols
);
1276 ovs_fatal(0, "%s", error
);
1279 protocol
= open_vconn(vconn_name
, &vconn
);
1280 *protocolp
= set_protocol_for_flow_dump(vconn
, protocol
, usable_protocols
);
1285 ofctl_dump_flows__(int argc
, char *argv
[], bool aggregate
)
1287 struct ofputil_flow_stats_request fsr
;
1288 enum ofputil_protocol protocol
;
1289 struct vconn
*vconn
;
1291 vconn
= prepare_dump_flows(argc
, argv
, aggregate
, &fsr
, &protocol
);
1292 dump_transaction(vconn
, ofputil_encode_flow_stats_request(&fsr
, protocol
));
1297 get_match_field(const struct mf_field
*field
, const struct match
*match
,
1298 union mf_value
*value
)
1300 if (!match
->tun_md
.valid
|| (field
->id
< MFF_TUN_METADATA0
||
1301 field
->id
>= MFF_TUN_METADATA0
+
1302 TUN_METADATA_NUM_OPTS
)) {
1303 mf_get_value(field
, &match
->flow
, value
);
1305 const struct tun_metadata_loc
*loc
= &match
->tun_md
.entry
[field
->id
-
1306 MFF_TUN_METADATA0
].loc
;
1308 /* Since we don't have a tunnel mapping table, extract the value
1309 * from the locally allocated location in the match. */
1310 memset(value
, 0, field
->n_bytes
- loc
->len
);
1311 memcpy(value
->tun_metadata
+ field
->n_bytes
- loc
->len
,
1312 match
->flow
.tunnel
.metadata
.opts
.u8
+ loc
->c
.offset
, loc
->len
);
1317 compare_flows(const void *afs_
, const void *bfs_
)
1319 const struct ofputil_flow_stats
*afs
= afs_
;
1320 const struct ofputil_flow_stats
*bfs
= bfs_
;
1321 const struct match
*a
= &afs
->match
;
1322 const struct match
*b
= &bfs
->match
;
1323 const struct sort_criterion
*sc
;
1325 for (sc
= criteria
; sc
< &criteria
[n_criteria
]; sc
++) {
1326 const struct mf_field
*f
= sc
->field
;
1330 int a_pri
= afs
->priority
;
1331 int b_pri
= bfs
->priority
;
1332 ret
= a_pri
< b_pri
? -1 : a_pri
> b_pri
;
1336 ina
= mf_are_prereqs_ok(f
, &a
->flow
, NULL
)
1337 && !mf_is_all_wild(f
, &a
->wc
);
1338 inb
= mf_are_prereqs_ok(f
, &b
->flow
, NULL
)
1339 && !mf_is_all_wild(f
, &b
->wc
);
1341 /* Skip the test for sc->order, so that missing fields always
1342 * sort to the end whether we're sorting in ascending or
1343 * descending order. */
1344 return ina
? -1 : 1;
1346 union mf_value aval
, bval
;
1348 get_match_field(f
, a
, &aval
);
1349 get_match_field(f
, b
, &bval
);
1350 ret
= memcmp(&aval
, &bval
, f
->n_bytes
);
1355 return sc
->order
== SORT_ASC
? ret
: -ret
;
1363 ofctl_dump_flows(struct ovs_cmdl_context
*ctx
)
1365 if (!n_criteria
&& !should_show_ports() && show_stats
) {
1366 ofctl_dump_flows__(ctx
->argc
, ctx
->argv
, false);
1369 struct ofputil_flow_stats_request fsr
;
1370 enum ofputil_protocol protocol
;
1371 struct vconn
*vconn
;
1373 vconn
= prepare_dump_flows(ctx
->argc
, ctx
->argv
, false,
1376 struct ofputil_flow_stats
*fses
;
1378 run(vconn_dump_flows(vconn
, &fsr
, protocol
, &fses
, &n_fses
),
1381 qsort(fses
, n_fses
, sizeof *fses
, compare_flows
);
1383 struct ds s
= DS_EMPTY_INITIALIZER
;
1384 for (size_t i
= 0; i
< n_fses
; i
++) {
1386 ofp_print_flow_stats(&s
, &fses
[i
], ports_to_show(ctx
->argv
[1]),
1388 printf(" %s\n", ds_cstr(&s
));
1392 for (size_t i
= 0; i
< n_fses
; i
++) {
1393 free(CONST_CAST(struct ofpact
*, fses
[i
].ofpacts
));
1402 ofctl_dump_aggregate(struct ovs_cmdl_context
*ctx
)
1404 ofctl_dump_flows__(ctx
->argc
, ctx
->argv
, true);
1408 ofctl_queue_stats(struct ovs_cmdl_context
*ctx
)
1410 struct ofpbuf
*request
;
1411 struct vconn
*vconn
;
1412 struct ofputil_queue_stats_request oqs
;
1414 open_vconn(ctx
->argv
[1], &vconn
);
1416 if (ctx
->argc
> 2 && ctx
->argv
[2][0] && strcasecmp(ctx
->argv
[2], "all")) {
1417 oqs
.port_no
= str_to_port_no(ctx
->argv
[1], ctx
->argv
[2]);
1419 oqs
.port_no
= OFPP_ANY
;
1421 if (ctx
->argc
> 3 && ctx
->argv
[3][0] && strcasecmp(ctx
->argv
[3], "all")) {
1422 oqs
.queue_id
= atoi(ctx
->argv
[3]);
1424 oqs
.queue_id
= OFPQ_ALL
;
1427 request
= ofputil_encode_queue_stats_request(vconn_get_version(vconn
), &oqs
);
1428 dump_transaction(vconn
, request
);
1433 ofctl_queue_get_config(struct ovs_cmdl_context
*ctx
)
1435 const char *vconn_name
= ctx
->argv
[1];
1436 const char *port_name
= ctx
->argc
> 2 ? ctx
->argv
[2] : "any";
1437 ofp_port_t port
= str_to_port_no(vconn_name
, port_name
);
1438 const char *queue_name
= ctx
->argc
> 3 ? ctx
->argv
[3] : "all";
1439 uint32_t queue
= (!strcasecmp(queue_name
, "all")
1441 : atoi(queue_name
));
1442 struct vconn
*vconn
;
1444 enum ofputil_protocol protocol
= open_vconn(vconn_name
, &vconn
);
1445 enum ofp_version version
= ofputil_protocol_to_ofp_version(protocol
);
1446 if (port
== OFPP_ANY
&& version
== OFP10_VERSION
) {
1447 /* The user requested all queues on all ports. OpenFlow 1.0 only
1448 * supports getting queues for an individual port, so to implement the
1449 * user's request we have to get a list of all the ports.
1451 * We use a second vconn to avoid having to accumulate a list of all of
1453 struct vconn
*vconn2
;
1454 enum ofputil_protocol protocol2
= open_vconn(vconn_name
, &vconn2
);
1455 enum ofp_version version2
= ofputil_protocol_to_ofp_version(protocol2
);
1457 struct port_iterator pi
;
1458 struct ofputil_phy_port pp
;
1459 for (port_iterator_init(&pi
, vconn
); port_iterator_next(&pi
, &pp
); ) {
1460 if (ofp_to_u16(pp
.port_no
) < ofp_to_u16(OFPP_MAX
)) {
1461 dump_transaction(vconn2
,
1462 ofputil_encode_queue_get_config_request(
1463 version2
, pp
.port_no
, queue
));
1466 port_iterator_destroy(&pi
);
1467 vconn_close(vconn2
);
1469 dump_transaction(vconn
, ofputil_encode_queue_get_config_request(
1470 version
, port
, queue
));
1475 static enum ofputil_protocol
1476 open_vconn_for_flow_mod(const char *remote
, struct vconn
**vconnp
,
1477 enum ofputil_protocol usable_protocols
)
1479 enum ofputil_protocol cur_protocol
;
1483 if (!(usable_protocols
& allowed_protocols
)) {
1484 char *allowed_s
= ofputil_protocols_to_string(allowed_protocols
);
1485 usable_s
= ofputil_protocols_to_string(usable_protocols
);
1486 ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1487 "allowed flow formats (%s)", usable_s
, allowed_s
);
1490 /* If the initial flow format is allowed and usable, keep it. */
1491 cur_protocol
= open_vconn(remote
, vconnp
);
1492 if (usable_protocols
& allowed_protocols
& cur_protocol
) {
1493 return cur_protocol
;
1496 /* Otherwise try each flow format in turn. */
1497 for (i
= 0; i
< sizeof(enum ofputil_protocol
) * CHAR_BIT
; i
++) {
1498 enum ofputil_protocol f
= 1 << i
;
1500 if (f
!= cur_protocol
1501 && f
& usable_protocols
& allowed_protocols
1502 && try_set_protocol(*vconnp
, f
, &cur_protocol
)) {
1507 usable_s
= ofputil_protocols_to_string(usable_protocols
);
1508 ovs_fatal(0, "switch does not support any of the usable flow "
1509 "formats (%s)", usable_s
);
1513 bundle_flow_mod__(const char *remote
, struct ofputil_flow_mod
*fms
,
1514 size_t n_fms
, enum ofputil_protocol usable_protocols
)
1516 enum ofputil_protocol protocol
;
1517 struct vconn
*vconn
;
1518 struct ovs_list requests
;
1521 ovs_list_init(&requests
);
1523 /* Bundles need OpenFlow 1.3+. */
1524 usable_protocols
&= OFPUTIL_P_OF13_UP
;
1525 protocol
= open_vconn_for_flow_mod(remote
, &vconn
, usable_protocols
);
1527 for (i
= 0; i
< n_fms
; i
++) {
1528 struct ofputil_flow_mod
*fm
= &fms
[i
];
1529 struct ofpbuf
*request
= ofputil_encode_flow_mod(fm
, protocol
);
1531 ovs_list_push_back(&requests
, &request
->list_node
);
1532 free(CONST_CAST(struct ofpact
*, fm
->ofpacts
));
1535 bundle_transact(vconn
, &requests
, OFPBF_ORDERED
| OFPBF_ATOMIC
);
1536 ofpbuf_list_delete(&requests
);
1541 ofctl_flow_mod__(const char *remote
, struct ofputil_flow_mod
*fms
,
1542 size_t n_fms
, enum ofputil_protocol usable_protocols
)
1544 enum ofputil_protocol protocol
;
1545 struct vconn
*vconn
;
1549 bundle_flow_mod__(remote
, fms
, n_fms
, usable_protocols
);
1553 protocol
= open_vconn_for_flow_mod(remote
, &vconn
, usable_protocols
);
1555 for (i
= 0; i
< n_fms
; i
++) {
1556 struct ofputil_flow_mod
*fm
= &fms
[i
];
1558 transact_noreply(vconn
, ofputil_encode_flow_mod(fm
, protocol
));
1559 free(CONST_CAST(struct ofpact
*, fm
->ofpacts
));
1565 ofctl_flow_mod_file(int argc OVS_UNUSED
, char *argv
[], int command
)
1567 enum ofputil_protocol usable_protocols
;
1568 struct ofputil_flow_mod
*fms
= NULL
;
1572 if (command
== OFPFC_ADD
) {
1573 /* Allow the file to specify a mix of commands. If none specified at
1574 * the beginning of any given line, then the default is OFPFC_ADD, so
1575 * this is backwards compatible. */
1578 error
= parse_ofp_flow_mod_file(argv
[2], ports_to_accept(argv
[1]), command
,
1579 &fms
, &n_fms
, &usable_protocols
);
1581 ovs_fatal(0, "%s", error
);
1583 ofctl_flow_mod__(argv
[1], fms
, n_fms
, usable_protocols
);
1588 ofctl_flow_mod(int argc
, char *argv
[], uint16_t command
)
1590 if (argc
> 2 && !strcmp(argv
[2], "-")) {
1591 ofctl_flow_mod_file(argc
, argv
, command
);
1593 struct ofputil_flow_mod fm
;
1595 enum ofputil_protocol usable_protocols
;
1597 error
= parse_ofp_flow_mod_str(&fm
, argc
> 2 ? argv
[2] : "",
1598 ports_to_accept(argv
[1]), command
,
1601 ovs_fatal(0, "%s", error
);
1603 ofctl_flow_mod__(argv
[1], &fm
, 1, usable_protocols
);
1608 ofctl_add_flow(struct ovs_cmdl_context
*ctx
)
1610 ofctl_flow_mod(ctx
->argc
, ctx
->argv
, OFPFC_ADD
);
1614 ofctl_add_flows(struct ovs_cmdl_context
*ctx
)
1616 ofctl_flow_mod_file(ctx
->argc
, ctx
->argv
, OFPFC_ADD
);
1620 ofctl_mod_flows(struct ovs_cmdl_context
*ctx
)
1622 ofctl_flow_mod(ctx
->argc
, ctx
->argv
, strict
? OFPFC_MODIFY_STRICT
: OFPFC_MODIFY
);
1626 ofctl_del_flows(struct ovs_cmdl_context
*ctx
)
1628 ofctl_flow_mod(ctx
->argc
, ctx
->argv
, strict
? OFPFC_DELETE_STRICT
: OFPFC_DELETE
);
1632 set_packet_in_format(struct vconn
*vconn
,
1633 enum nx_packet_in_format packet_in_format
,
1636 struct ofpbuf
*spif
;
1638 spif
= ofputil_make_set_packet_in_format(vconn_get_version(vconn
),
1641 transact_noreply(vconn
, spif
);
1643 struct ofpbuf
*reply
;
1645 run(vconn_transact_noreply(vconn
, spif
, &reply
),
1646 "talking to %s", vconn_get_name(vconn
));
1648 char *s
= ofp_to_string(reply
->data
, reply
->size
, NULL
, 2);
1649 VLOG_DBG("%s: failed to set packet in format to nx_packet_in, "
1650 "controller replied: %s.",
1651 vconn_get_name(vconn
), s
);
1653 ofpbuf_delete(reply
);
1657 VLOG_DBG("%s: using user-specified packet in format %s",
1658 vconn_get_name(vconn
),
1659 ofputil_packet_in_format_to_string(packet_in_format
));
1666 monitor_set_invalid_ttl_to_controller(struct vconn
*vconn
)
1668 struct ofputil_switch_config config
;
1670 fetch_switch_config(vconn
, &config
);
1671 if (!config
.invalid_ttl_to_controller
) {
1672 config
.invalid_ttl_to_controller
= 1;
1673 set_switch_config(vconn
, &config
);
1675 /* Then retrieve the configuration to see if it really took. OpenFlow
1676 * has ill-defined error reporting for bad flags, so this is about the
1677 * best we can do. */
1678 fetch_switch_config(vconn
, &config
);
1679 if (!config
.invalid_ttl_to_controller
) {
1680 ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1681 "switch probably doesn't support this flag)");
1687 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'. The
1688 * caller must free '*msgp'. On success, returns NULL. On failure, returns
1689 * an error message and stores NULL in '*msgp'. */
1691 openflow_from_hex(const char *hex
, struct ofpbuf
**msgp
)
1693 struct ofp_header
*oh
;
1696 msg
= ofpbuf_new(strlen(hex
) / 2);
1699 if (ofpbuf_put_hex(msg
, hex
, NULL
)[0] != '\0') {
1701 return "Trailing garbage in hex data";
1704 if (msg
->size
< sizeof(struct ofp_header
)) {
1706 return "Message too short for OpenFlow";
1710 if (msg
->size
!= ntohs(oh
->length
)) {
1712 return "Message size does not match length in OpenFlow header";
1720 ofctl_send(struct unixctl_conn
*conn
, int argc
,
1721 const char *argv
[], void *vconn_
)
1723 struct vconn
*vconn
= vconn_
;
1730 for (i
= 1; i
< argc
; i
++) {
1731 const char *error_msg
;
1735 error_msg
= openflow_from_hex(argv
[i
], &msg
);
1737 ds_put_format(&reply
, "%s\n", error_msg
);
1742 fprintf(stderr
, "send: ");
1743 ofp_print(stderr
, msg
->data
, msg
->size
,
1744 ports_to_show(vconn_get_name(vconn
)), verbosity
);
1746 error
= vconn_send_block(vconn
, msg
);
1749 ds_put_format(&reply
, "%s\n", ovs_strerror(error
));
1752 ds_put_cstr(&reply
, "sent\n");
1757 unixctl_command_reply(conn
, ds_cstr(&reply
));
1759 unixctl_command_reply_error(conn
, ds_cstr(&reply
));
1765 unixctl_packet_out(struct unixctl_conn
*conn
, int OVS_UNUSED argc
,
1766 const char *argv
[], void *vconn_
)
1768 struct vconn
*vconn
= vconn_
;
1769 enum ofputil_protocol protocol
1770 = ofputil_protocol_from_ofp_version(vconn_get_version(vconn
));
1771 struct ds reply
= DS_EMPTY_INITIALIZER
;
1774 enum ofputil_protocol usable_protocols
;
1775 struct ofputil_packet_out po
;
1778 error_msg
= parse_ofp_packet_out_str(
1779 &po
, argv
[1], ports_to_accept(vconn_get_name(vconn
)),
1782 ds_put_format(&reply
, "%s\n", error_msg
);
1787 if (ok
&& !(usable_protocols
& protocol
)) {
1788 ds_put_format(&reply
, "PACKET_OUT actions are incompatible with the OpenFlow connection.\n");
1793 struct ofpbuf
*msg
= ofputil_encode_packet_out(&po
, protocol
);
1795 ofp_print(stderr
, msg
->data
, msg
->size
,
1796 ports_to_show(vconn_get_name(vconn
)), verbosity
);
1798 int error
= vconn_send_block(vconn
, msg
);
1801 ds_put_format(&reply
, "%s\n", ovs_strerror(error
));
1807 unixctl_command_reply(conn
, ds_cstr(&reply
));
1809 unixctl_command_reply_error(conn
, ds_cstr(&reply
));
1814 free(CONST_CAST(void *, po
.packet
));
1819 struct barrier_aux
{
1820 struct vconn
*vconn
; /* OpenFlow connection for sending barrier. */
1821 struct unixctl_conn
*conn
; /* Connection waiting for barrier response. */
1825 ofctl_barrier(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1826 const char *argv
[] OVS_UNUSED
, void *aux_
)
1828 struct barrier_aux
*aux
= aux_
;
1833 unixctl_command_reply_error(conn
, "already waiting for barrier reply");
1837 msg
= ofputil_encode_barrier_request(vconn_get_version(aux
->vconn
));
1838 error
= vconn_send_block(aux
->vconn
, msg
);
1841 unixctl_command_reply_error(conn
, ovs_strerror(error
));
1848 ofctl_set_output_file(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1849 const char *argv
[], void *aux OVS_UNUSED
)
1853 fd
= open(argv
[1], O_CREAT
| O_TRUNC
| O_WRONLY
, 0666);
1855 unixctl_command_reply_error(conn
, ovs_strerror(errno
));
1860 dup2(fd
, STDERR_FILENO
);
1862 unixctl_command_reply(conn
, NULL
);
1866 ofctl_block(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1867 const char *argv
[] OVS_UNUSED
, void *blocked_
)
1869 bool *blocked
= blocked_
;
1873 unixctl_command_reply(conn
, NULL
);
1875 unixctl_command_reply(conn
, "already blocking");
1880 ofctl_unblock(struct unixctl_conn
*conn
, int argc OVS_UNUSED
,
1881 const char *argv
[] OVS_UNUSED
, void *blocked_
)
1883 bool *blocked
= blocked_
;
1887 unixctl_command_reply(conn
, NULL
);
1889 unixctl_command_reply(conn
, "already unblocked");
1893 /* Prints to stderr all of the messages received on 'vconn'.
1895 * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1896 * received on 'vconn'.
1898 * If 'resume_continuations' is true, sends an NXT_RESUME in reply to any
1899 * NXT_PACKET_IN2 that includes a continuation. */
1901 monitor_vconn(struct vconn
*vconn
, bool reply_to_echo_requests
,
1902 bool resume_continuations
)
1904 struct barrier_aux barrier_aux
= { vconn
, NULL
};
1905 struct unixctl_server
*server
;
1906 bool exiting
= false;
1907 bool blocked
= false;
1910 daemon_save_fd(STDERR_FILENO
);
1911 daemonize_start(false);
1912 error
= unixctl_server_create(unixctl_path
, &server
);
1914 ovs_fatal(error
, "failed to create unixctl server");
1916 unixctl_command_register("exit", "", 0, 0, ofctl_exit
, &exiting
);
1917 unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX
,
1919 unixctl_command_register("ofctl/packet-out", "\"in_port=<port> packet=<hex data> actions=...\"", 1, 1,
1920 unixctl_packet_out
, vconn
);
1921 unixctl_command_register("ofctl/barrier", "", 0, 0,
1922 ofctl_barrier
, &barrier_aux
);
1923 unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1924 ofctl_set_output_file
, NULL
);
1926 unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block
, &blocked
);
1927 unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock
,
1930 daemonize_complete();
1932 enum ofp_version version
= vconn_get_version(vconn
);
1933 enum ofputil_protocol protocol
1934 = ofputil_protocol_from_ofp_version(version
);
1940 unixctl_server_run(server
);
1945 retval
= vconn_recv(vconn
, &b
);
1946 if (retval
== EAGAIN
) {
1949 run(retval
, "vconn_recv");
1952 char *s
= xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1953 time_wall_msec(), true);
1958 ofptype_decode(&type
, b
->data
);
1959 ofp_print(stderr
, b
->data
, b
->size
,
1960 ports_to_show(vconn_get_name(vconn
)), verbosity
+ 2);
1963 switch ((int) type
) {
1964 case OFPTYPE_BARRIER_REPLY
:
1965 if (barrier_aux
.conn
) {
1966 unixctl_command_reply(barrier_aux
.conn
, NULL
);
1967 barrier_aux
.conn
= NULL
;
1971 case OFPTYPE_ECHO_REQUEST
:
1972 if (reply_to_echo_requests
) {
1973 struct ofpbuf
*reply
;
1975 reply
= make_echo_reply(b
->data
);
1976 retval
= vconn_send_block(vconn
, reply
);
1978 ovs_fatal(retval
, "failed to send echo reply");
1983 case OFPTYPE_PACKET_IN
:
1984 if (resume_continuations
) {
1985 struct ofputil_packet_in pin
;
1986 struct ofpbuf continuation
;
1988 error
= ofputil_decode_packet_in(b
->data
, true, NULL
, NULL
,
1992 fprintf(stderr
, "decoding packet-in failed: %s",
1993 ofperr_to_string(error
));
1994 } else if (continuation
.size
) {
1995 struct ofpbuf
*reply
;
1997 reply
= ofputil_encode_resume(&pin
, &continuation
,
2000 fprintf(stderr
, "send: ");
2001 ofp_print(stderr
, reply
->data
, reply
->size
,
2002 ports_to_show(vconn_get_name(vconn
)),
2006 retval
= vconn_send_block(vconn
, reply
);
2008 ovs_fatal(retval
, "failed to send NXT_RESUME");
2022 vconn_run_wait(vconn
);
2024 vconn_recv_wait(vconn
);
2026 unixctl_server_wait(server
);
2030 unixctl_server_destroy(server
);
2034 ofctl_monitor(struct ovs_cmdl_context
*ctx
)
2036 struct vconn
*vconn
;
2038 enum ofputil_protocol usable_protocols
;
2040 /* If the user wants the invalid_ttl_to_controller feature, limit the
2041 * OpenFlow versions to those that support that feature. (Support in
2042 * OpenFlow 1.0 is an Open vSwitch extension.) */
2043 for (i
= 2; i
< ctx
->argc
; i
++) {
2044 if (!strcmp(ctx
->argv
[i
], "invalid_ttl")) {
2045 uint32_t usable_versions
= ((1u << OFP10_VERSION
) |
2046 (1u << OFP11_VERSION
) |
2047 (1u << OFP12_VERSION
));
2048 uint32_t allowed_versions
= get_allowed_ofp_versions();
2049 if (!(allowed_versions
& usable_versions
)) {
2050 struct ds versions
= DS_EMPTY_INITIALIZER
;
2051 ofputil_format_version_bitmap_names(&versions
,
2053 ovs_fatal(0, "invalid_ttl requires one of the OpenFlow "
2054 "versions %s but none is enabled (use -O)",
2055 ds_cstr(&versions
));
2057 mask_allowed_ofp_versions(usable_versions
);
2062 open_vconn(ctx
->argv
[1], &vconn
);
2063 bool resume_continuations
= false;
2064 for (i
= 2; i
< ctx
->argc
; i
++) {
2065 const char *arg
= ctx
->argv
[i
];
2067 if (isdigit((unsigned char) *arg
)) {
2068 struct ofputil_switch_config config
;
2070 fetch_switch_config(vconn
, &config
);
2071 config
.miss_send_len
= atoi(arg
);
2072 set_switch_config(vconn
, &config
);
2073 } else if (!strcmp(arg
, "invalid_ttl")) {
2074 monitor_set_invalid_ttl_to_controller(vconn
);
2075 } else if (!strncmp(arg
, "watch:", 6)) {
2076 struct ofputil_flow_monitor_request fmr
;
2080 error
= parse_flow_monitor_request(&fmr
, arg
+ 6,
2081 ports_to_accept(ctx
->argv
[1]),
2084 ovs_fatal(0, "%s", error
);
2087 msg
= ofpbuf_new(0);
2088 ofputil_append_flow_monitor_request(&fmr
, msg
);
2089 dump_transaction(vconn
, msg
);
2091 } else if (!strcmp(arg
, "resume")) {
2092 /* This option is intentionally undocumented because it is meant
2093 * only for testing. */
2094 resume_continuations
= true;
2096 /* Set miss_send_len to ensure that we get packet-ins. */
2097 struct ofputil_switch_config config
;
2098 fetch_switch_config(vconn
, &config
);
2099 config
.miss_send_len
= UINT16_MAX
;
2100 set_switch_config(vconn
, &config
);
2102 ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg
);
2106 if (preferred_packet_in_format
>= 0) {
2107 /* A particular packet-in format was requested, so we must set it. */
2108 set_packet_in_format(vconn
, preferred_packet_in_format
, true);
2110 /* Otherwise, we always prefer NXT_PACKET_IN2. */
2111 if (!set_packet_in_format(vconn
, NXPIF_NXT_PACKET_IN2
, false)) {
2112 /* We can't get NXT_PACKET_IN2. For OpenFlow 1.0 only, request
2113 * NXT_PACKET_IN. (Before 2.6, Open vSwitch will accept a request
2114 * for NXT_PACKET_IN with OF1.1+, but even after that it still
2115 * sends packet-ins in the OpenFlow native format.) */
2116 if (vconn_get_version(vconn
) == OFP10_VERSION
) {
2117 set_packet_in_format(vconn
, NXPIF_NXT_PACKET_IN
, false);
2122 monitor_vconn(vconn
, true, resume_continuations
);
2126 ofctl_snoop(struct ovs_cmdl_context
*ctx
)
2128 struct vconn
*vconn
;
2130 open_vconn__(ctx
->argv
[1], SNOOP
, &vconn
);
2131 monitor_vconn(vconn
, false, false);
2135 ofctl_dump_ports(struct ovs_cmdl_context
*ctx
)
2137 struct ofpbuf
*request
;
2138 struct vconn
*vconn
;
2141 open_vconn(ctx
->argv
[1], &vconn
);
2142 port
= ctx
->argc
> 2 ? str_to_port_no(ctx
->argv
[1], ctx
->argv
[2]) : OFPP_ANY
;
2143 request
= ofputil_encode_dump_ports_request(vconn_get_version(vconn
), port
);
2144 dump_transaction(vconn
, request
);
2149 ofctl_dump_ports_desc(struct ovs_cmdl_context
*ctx
)
2151 struct ofpbuf
*request
;
2152 struct vconn
*vconn
;
2155 open_vconn(ctx
->argv
[1], &vconn
);
2156 port
= ctx
->argc
> 2 ? str_to_port_no(ctx
->argv
[1], ctx
->argv
[2]) : OFPP_ANY
;
2157 request
= ofputil_encode_port_desc_stats_request(vconn_get_version(vconn
),
2159 dump_transaction(vconn
, request
);
2164 ofctl_probe(struct ovs_cmdl_context
*ctx
)
2166 struct ofpbuf
*request
;
2167 struct vconn
*vconn
;
2168 struct ofpbuf
*reply
;
2170 open_vconn(ctx
->argv
[1], &vconn
);
2171 request
= make_echo_request(vconn_get_version(vconn
));
2172 run(vconn_transact(vconn
, request
, &reply
), "talking to %s", ctx
->argv
[1]);
2173 if (reply
->size
!= sizeof(struct ofp_header
)) {
2174 ovs_fatal(0, "reply does not match request");
2176 ofpbuf_delete(reply
);
2181 ofctl_packet_out(struct ovs_cmdl_context
*ctx
)
2183 enum ofputil_protocol usable_protocols
;
2184 enum ofputil_protocol protocol
;
2185 struct ofputil_packet_out po
;
2186 struct vconn
*vconn
;
2190 match_init_catchall(&po
.flow_metadata
);
2191 /* Use the old syntax when more than 4 arguments are given. */
2192 if (ctx
->argc
> 4) {
2193 struct ofpbuf ofpacts
;
2196 ofpbuf_init(&ofpacts
, 64);
2197 error
= ofpacts_parse_actions(ctx
->argv
[3],
2198 ports_to_accept(ctx
->argv
[1]), &ofpacts
,
2201 ovs_fatal(0, "%s", error
);
2204 po
.buffer_id
= UINT32_MAX
;
2205 match_set_in_port(&po
.flow_metadata
,
2206 str_to_port_no(ctx
->argv
[1], ctx
->argv
[2]));
2207 po
.ofpacts
= ofpacts
.data
;
2208 po
.ofpacts_len
= ofpacts
.size
;
2209 po
.flow_metadata
.flow
.packet_type
= htonl(PT_ETH
);
2211 protocol
= open_vconn_for_flow_mod(ctx
->argv
[1], &vconn
,
2213 for (i
= 4; i
< ctx
->argc
; i
++) {
2214 struct dp_packet
*packet
;
2215 const char *error_msg
;
2217 error_msg
= eth_from_hex(ctx
->argv
[i
], &packet
);
2219 ovs_fatal(0, "%s", error_msg
);
2222 po
.packet
= dp_packet_data(packet
);
2223 po
.packet_len
= dp_packet_size(packet
);
2224 opo
= ofputil_encode_packet_out(&po
, protocol
);
2225 transact_noreply(vconn
, opo
);
2226 dp_packet_delete(packet
);
2229 ofpbuf_uninit(&ofpacts
);
2230 } else if (ctx
->argc
== 3) {
2231 error
= parse_ofp_packet_out_str(&po
, ctx
->argv
[2],
2232 ports_to_accept(ctx
->argv
[1]),
2235 ovs_fatal(0, "%s", error
);
2237 protocol
= open_vconn_for_flow_mod(ctx
->argv
[1], &vconn
,
2239 opo
= ofputil_encode_packet_out(&po
, protocol
);
2240 transact_noreply(vconn
, opo
);
2242 free(CONST_CAST(void *, po
.packet
));
2245 ovs_fatal(0, "Too many arguments (%d)", ctx
->argc
);
2250 ofctl_mod_port(struct ovs_cmdl_context
*ctx
)
2252 struct ofp_config_flag
{
2253 const char *name
; /* The flag's name. */
2254 enum ofputil_port_config bit
; /* Bit to turn on or off. */
2255 bool on
; /* Value to set the bit to. */
2257 static const struct ofp_config_flag flags
[] = {
2258 { "up", OFPUTIL_PC_PORT_DOWN
, false },
2259 { "down", OFPUTIL_PC_PORT_DOWN
, true },
2260 { "stp", OFPUTIL_PC_NO_STP
, false },
2261 { "receive", OFPUTIL_PC_NO_RECV
, false },
2262 { "receive-stp", OFPUTIL_PC_NO_RECV_STP
, false },
2263 { "flood", OFPUTIL_PC_NO_FLOOD
, false },
2264 { "forward", OFPUTIL_PC_NO_FWD
, false },
2265 { "packet-in", OFPUTIL_PC_NO_PACKET_IN
, false },
2268 const struct ofp_config_flag
*flag
;
2269 enum ofputil_protocol protocol
;
2270 struct ofputil_port_mod pm
;
2271 struct ofputil_phy_port pp
;
2272 struct vconn
*vconn
;
2273 const char *command
;
2276 fetch_ofputil_phy_port(ctx
->argv
[1], ctx
->argv
[2], &pp
);
2278 pm
.port_no
= pp
.port_no
;
2279 pm
.hw_addr
= pp
.hw_addr
;
2280 pm
.hw_addr64
= pp
.hw_addr64
;
2285 if (!strncasecmp(ctx
->argv
[3], "no-", 3)) {
2286 command
= ctx
->argv
[3] + 3;
2288 } else if (!strncasecmp(ctx
->argv
[3], "no", 2)) {
2289 command
= ctx
->argv
[3] + 2;
2292 command
= ctx
->argv
[3];
2295 for (flag
= flags
; flag
< &flags
[ARRAY_SIZE(flags
)]; flag
++) {
2296 if (!strcasecmp(command
, flag
->name
)) {
2297 pm
.mask
= flag
->bit
;
2298 pm
.config
= flag
->on
^ not ? flag
->bit
: 0;
2302 ovs_fatal(0, "unknown mod-port command '%s'", ctx
->argv
[3]);
2305 protocol
= open_vconn(ctx
->argv
[1], &vconn
);
2306 transact_noreply(vconn
, ofputil_encode_port_mod(&pm
, protocol
));
2310 /* This function uses OFPMP14_TABLE_DESC request to get the current
2311 * table configuration from switch. The function then modifies
2312 * only that table-config property, which has been requested. */
2314 fetch_table_desc(struct vconn
*vconn
, struct ofputil_table_mod
*tm
,
2315 struct ofputil_table_desc
*td
)
2317 struct ofpbuf
*request
;
2322 request
= ofputil_encode_table_desc_request(vconn_get_version(vconn
));
2323 send_xid
= ((struct ofp_header
*) request
->data
)->xid
;
2324 send_openflow_buffer(vconn
, request
);
2327 struct ofpbuf
*reply
;
2329 run(vconn_recv_block(vconn
, &reply
), "OpenFlow packet receive failed");
2330 recv_xid
= ((struct ofp_header
*) reply
->data
)->xid
;
2331 if (send_xid
== recv_xid
) {
2332 struct ofp_header
*oh
= reply
->data
;
2333 struct ofpbuf b
= ofpbuf_const_initializer(oh
, ntohs(oh
->length
));
2336 if (ofptype_pull(&type
, &b
)
2337 || type
!= OFPTYPE_TABLE_DESC_REPLY
) {
2338 ovs_fatal(0, "received bad reply: %s",
2339 ofp_to_string(reply
->data
, reply
->size
, NULL
,
2342 uint16_t flags
= ofpmp_flags(oh
);
2343 done
= !(flags
& OFPSF_REPLY_MORE
);
2345 /* We've already found the table desc consisting of current
2346 * table configuration, but we need to drain the queue of
2347 * any other replies for this request. */
2350 while (!ofputil_decode_table_desc(&b
, td
, oh
->version
)) {
2351 if (td
->table_id
== tm
->table_id
) {
2357 VLOG_DBG("received reply with xid %08"PRIx32
" "
2358 "!= expected %08"PRIx32
, recv_xid
, send_xid
);
2360 ofpbuf_delete(reply
);
2362 if (tm
->eviction
!= OFPUTIL_TABLE_EVICTION_DEFAULT
) {
2363 tm
->vacancy
= td
->vacancy
;
2364 tm
->table_vacancy
.vacancy_down
= td
->table_vacancy
.vacancy_down
;
2365 tm
->table_vacancy
.vacancy_up
= td
->table_vacancy
.vacancy_up
;
2366 } else if (tm
->vacancy
!= OFPUTIL_TABLE_VACANCY_DEFAULT
) {
2367 tm
->eviction
= td
->eviction
;
2368 tm
->eviction_flags
= td
->eviction_flags
;
2373 ofctl_mod_table(struct ovs_cmdl_context
*ctx
)
2375 uint32_t usable_versions
;
2376 struct ofputil_table_mod tm
;
2377 struct vconn
*vconn
;
2381 error
= parse_ofp_table_mod(&tm
, ctx
->argv
[2], ctx
->argv
[3],
2384 ovs_fatal(0, "%s", error
);
2387 uint32_t allowed_versions
= get_allowed_ofp_versions();
2388 if (!(allowed_versions
& usable_versions
)) {
2389 struct ds versions
= DS_EMPTY_INITIALIZER
;
2390 ofputil_format_version_bitmap_names(&versions
, usable_versions
);
2391 ovs_fatal(0, "table_mod '%s' requires one of the OpenFlow "
2393 ctx
->argv
[3], ds_cstr(&versions
));
2395 mask_allowed_ofp_versions(usable_versions
);
2396 enum ofputil_protocol protocol
= open_vconn(ctx
->argv
[1], &vconn
);
2398 /* For OpenFlow 1.4+, ovs-ofctl mod-table should not affect table-config
2399 * properties that the user didn't ask to change, so it is necessary to
2400 * restore the current configuration of table-config parameters using
2401 * OFPMP14_TABLE_DESC request. */
2402 if ((allowed_versions
& (1u << OFP14_VERSION
)) ||
2403 (allowed_versions
& (1u << OFP15_VERSION
))) {
2404 struct ofputil_table_desc td
;
2406 if (tm
.table_id
== OFPTT_ALL
) {
2407 for (i
= 0; i
< OFPTT_MAX
; i
++) {
2409 fetch_table_desc(vconn
, &tm
, &td
);
2410 transact_noreply(vconn
,
2411 ofputil_encode_table_mod(&tm
, protocol
));
2414 fetch_table_desc(vconn
, &tm
, &td
);
2415 transact_noreply(vconn
, ofputil_encode_table_mod(&tm
, protocol
));
2418 transact_noreply(vconn
, ofputil_encode_table_mod(&tm
, protocol
));
2424 ofctl_get_frags(struct ovs_cmdl_context
*ctx
)
2426 struct ofputil_switch_config config
;
2427 struct vconn
*vconn
;
2429 open_vconn(ctx
->argv
[1], &vconn
);
2430 fetch_switch_config(vconn
, &config
);
2431 puts(ofputil_frag_handling_to_string(config
.frag
));
2436 ofctl_set_frags(struct ovs_cmdl_context
*ctx
)
2438 struct ofputil_switch_config config
;
2439 enum ofputil_frag_handling frag
;
2440 struct vconn
*vconn
;
2442 if (!ofputil_frag_handling_from_string(ctx
->argv
[2], &frag
)) {
2443 ovs_fatal(0, "%s: unknown fragment handling mode", ctx
->argv
[2]);
2446 open_vconn(ctx
->argv
[1], &vconn
);
2447 fetch_switch_config(vconn
, &config
);
2448 if (frag
!= config
.frag
) {
2449 /* Set the configuration. */
2451 set_switch_config(vconn
, &config
);
2453 /* Then retrieve the configuration to see if it really took. OpenFlow
2454 * has ill-defined error reporting for bad flags, so this is about the
2455 * best we can do. */
2456 fetch_switch_config(vconn
, &config
);
2457 if (frag
!= config
.frag
) {
2458 ovs_fatal(0, "%s: setting fragment handling mode failed (this "
2459 "switch probably doesn't support mode \"%s\")",
2460 ctx
->argv
[1], ofputil_frag_handling_to_string(frag
));
2467 ofctl_ofp_parse(struct ovs_cmdl_context
*ctx
)
2469 const char *filename
= ctx
->argv
[1];
2473 file
= !strcmp(filename
, "-") ? stdin
: fopen(filename
, "r");
2475 ovs_fatal(errno
, "%s: open", filename
);
2478 ofpbuf_init(&b
, 65536);
2480 struct ofp_header
*oh
;
2481 size_t length
, tail_len
;
2486 oh
= ofpbuf_put_uninit(&b
, sizeof *oh
);
2487 n
= fread(oh
, 1, sizeof *oh
, file
);
2490 } else if (n
< sizeof *oh
) {
2491 ovs_fatal(0, "%s: unexpected end of file mid-message", filename
);
2494 length
= ntohs(oh
->length
);
2495 if (length
< sizeof *oh
) {
2496 ovs_fatal(0, "%s: %"PRIuSIZE
"-byte message is too short for OpenFlow",
2500 tail_len
= length
- sizeof *oh
;
2501 tail
= ofpbuf_put_uninit(&b
, tail_len
);
2502 n
= fread(tail
, 1, tail_len
, file
);
2504 ovs_fatal(0, "%s: unexpected end of file mid-message", filename
);
2507 ofp_print(stdout
, b
.data
, b
.size
, NULL
, verbosity
+ 2);
2511 if (file
!= stdin
) {
2517 is_openflow_port(ovs_be16 port_
, char *ports
[])
2519 uint16_t port
= ntohs(port_
);
2523 for (i
= 0; ports
[i
]; i
++) {
2524 if (port
== atoi(ports
[i
])) {
2530 return port
== OFP_PORT
|| port
== OFP_OLD_PORT
;
2535 ofctl_ofp_parse_pcap(struct ovs_cmdl_context
*ctx
)
2537 struct tcp_reader
*reader
;
2542 file
= ovs_pcap_open(ctx
->argv
[1], "rb");
2544 ovs_fatal(errno
, "%s: open failed", ctx
->argv
[1]);
2547 reader
= tcp_reader_open();
2550 struct dp_packet
*packet
;
2554 error
= ovs_pcap_read(file
, &packet
, &when
);
2558 pkt_metadata_init(&packet
->md
, ODPP_NONE
);
2559 flow_extract(packet
, &flow
);
2560 if (flow
.dl_type
== htons(ETH_TYPE_IP
)
2561 && flow
.nw_proto
== IPPROTO_TCP
2562 && (is_openflow_port(flow
.tp_src
, ctx
->argv
+ 2) ||
2563 is_openflow_port(flow
.tp_dst
, ctx
->argv
+ 2))) {
2564 struct dp_packet
*payload
= tcp_reader_run(reader
, &flow
, packet
);
2566 while (dp_packet_size(payload
) >= sizeof(struct ofp_header
)) {
2567 const struct ofp_header
*oh
;
2568 void *data
= dp_packet_data(payload
);
2571 /* Align OpenFlow on 8-byte boundary for safe access. */
2572 dp_packet_shift(payload
, -((intptr_t) data
& 7));
2574 oh
= dp_packet_data(payload
);
2575 length
= ntohs(oh
->length
);
2576 if (dp_packet_size(payload
) < length
) {
2586 char *s
= xastrftime_msec("%H:%M:%S.### ", when
, true);
2591 printf(IP_FMT
".%"PRIu16
" > "IP_FMT
".%"PRIu16
":\n",
2592 IP_ARGS(flow
.nw_src
), ntohs(flow
.tp_src
),
2593 IP_ARGS(flow
.nw_dst
), ntohs(flow
.tp_dst
));
2594 ofp_print(stdout
, dp_packet_data(payload
), length
,
2595 NULL
, verbosity
+ 1);
2596 dp_packet_pull(payload
, length
);
2600 dp_packet_delete(packet
);
2602 tcp_reader_close(reader
);
2607 ofctl_ping(struct ovs_cmdl_context
*ctx
)
2609 size_t max_payload
= 65535 - sizeof(struct ofp_header
);
2610 unsigned int payload
;
2611 struct vconn
*vconn
;
2614 payload
= ctx
->argc
> 2 ? atoi(ctx
->argv
[2]) : 64;
2615 if (payload
> max_payload
) {
2616 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE
" bytes", max_payload
);
2619 open_vconn(ctx
->argv
[1], &vconn
);
2620 for (i
= 0; i
< 10; i
++) {
2621 struct timeval start
, end
;
2622 struct ofpbuf
*request
, *reply
;
2623 const struct ofp_header
*rpy_hdr
;
2626 request
= ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST
,
2627 vconn_get_version(vconn
), payload
);
2628 random_bytes(ofpbuf_put_uninit(request
, payload
), payload
);
2630 xgettimeofday(&start
);
2631 run(vconn_transact(vconn
, ofpbuf_clone(request
), &reply
), "transact");
2632 xgettimeofday(&end
);
2634 rpy_hdr
= reply
->data
;
2635 if (ofptype_pull(&type
, reply
)
2636 || type
!= OFPTYPE_ECHO_REPLY
2637 || reply
->size
!= payload
2638 || memcmp(request
->msg
, reply
->msg
, payload
)) {
2639 printf("Reply does not match request. Request:\n");
2640 ofp_print(stdout
, request
, request
->size
, NULL
, verbosity
+ 2);
2642 ofp_print(stdout
, reply
, reply
->size
, NULL
, verbosity
+ 2);
2644 printf("%"PRIu32
" bytes from %s: xid=%08"PRIx32
" time=%.1f ms\n",
2645 reply
->size
, ctx
->argv
[1], ntohl(rpy_hdr
->xid
),
2646 (1000*(double)(end
.tv_sec
- start
.tv_sec
))
2647 + (.001*(end
.tv_usec
- start
.tv_usec
)));
2648 ofpbuf_delete(request
);
2649 ofpbuf_delete(reply
);
2655 ofctl_benchmark(struct ovs_cmdl_context
*ctx
)
2657 size_t max_payload
= 65535 - sizeof(struct ofp_header
);
2658 struct timeval start
, end
;
2659 unsigned int payload_size
, message_size
;
2660 struct vconn
*vconn
;
2665 payload_size
= atoi(ctx
->argv
[2]);
2666 if (payload_size
> max_payload
) {
2667 ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE
" bytes", max_payload
);
2669 message_size
= sizeof(struct ofp_header
) + payload_size
;
2671 count
= atoi(ctx
->argv
[3]);
2673 printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2674 count
, message_size
, count
* message_size
);
2676 open_vconn(ctx
->argv
[1], &vconn
);
2677 xgettimeofday(&start
);
2678 for (i
= 0; i
< count
; i
++) {
2679 struct ofpbuf
*request
, *reply
;
2681 request
= ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST
,
2682 vconn_get_version(vconn
), payload_size
);
2683 ofpbuf_put_zeros(request
, payload_size
);
2684 run(vconn_transact(vconn
, request
, &reply
), "transact");
2685 ofpbuf_delete(reply
);
2687 xgettimeofday(&end
);
2690 duration
= ((1000*(double)(end
.tv_sec
- start
.tv_sec
))
2691 + (.001*(end
.tv_usec
- start
.tv_usec
)));
2692 printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2693 duration
, count
/ (duration
/ 1000.0),
2694 count
* message_size
/ (duration
/ 1000.0));
2698 ofctl_dump_ipfix_bridge(struct ovs_cmdl_context
*ctx
)
2700 dump_trivial_transaction(ctx
->argv
[1], OFPRAW_NXST_IPFIX_BRIDGE_REQUEST
);
2704 ofctl_ct_flush_zone(struct ovs_cmdl_context
*ctx
)
2707 char *error
= str_to_u16(ctx
->argv
[2], "zone_id", &zone_id
);
2709 ovs_fatal(0, "%s", error
);
2712 struct vconn
*vconn
;
2713 open_vconn(ctx
->argv
[1], &vconn
);
2714 enum ofp_version version
= vconn_get_version(vconn
);
2716 struct ofpbuf
*msg
= ofpraw_alloc(OFPRAW_NXT_CT_FLUSH_ZONE
, version
, 0);
2717 struct nx_zone_id
*nzi
= ofpbuf_put_zeros(msg
, sizeof *nzi
);
2718 nzi
->zone_id
= htons(zone_id
);
2720 transact_noreply(vconn
, msg
);
2725 ofctl_dump_ipfix_flow(struct ovs_cmdl_context
*ctx
)
2727 dump_trivial_transaction(ctx
->argv
[1], OFPRAW_NXST_IPFIX_FLOW_REQUEST
);
2731 bundle_group_mod__(const char *remote
, struct ofputil_group_mod
*gms
,
2732 size_t n_gms
, enum ofputil_protocol usable_protocols
)
2734 enum ofputil_protocol protocol
;
2735 enum ofp_version version
;
2736 struct vconn
*vconn
;
2737 struct ovs_list requests
;
2740 ovs_list_init(&requests
);
2742 /* Bundles need OpenFlow 1.3+. */
2743 usable_protocols
&= OFPUTIL_P_OF13_UP
;
2744 protocol
= open_vconn_for_flow_mod(remote
, &vconn
, usable_protocols
);
2745 version
= ofputil_protocol_to_ofp_version(protocol
);
2747 for (i
= 0; i
< n_gms
; i
++) {
2748 struct ofputil_group_mod
*gm
= &gms
[i
];
2749 struct ofpbuf
*request
= ofputil_encode_group_mod(version
, gm
);
2751 ovs_list_push_back(&requests
, &request
->list_node
);
2752 ofputil_uninit_group_mod(gm
);
2755 bundle_transact(vconn
, &requests
, OFPBF_ORDERED
| OFPBF_ATOMIC
);
2756 ofpbuf_list_delete(&requests
);
2761 ofctl_group_mod__(const char *remote
, struct ofputil_group_mod
*gms
,
2762 size_t n_gms
, enum ofputil_protocol usable_protocols
)
2764 enum ofputil_protocol protocol
;
2765 struct ofputil_group_mod
*gm
;
2766 enum ofp_version version
;
2767 struct ofpbuf
*request
;
2769 struct vconn
*vconn
;
2773 bundle_group_mod__(remote
, gms
, n_gms
, usable_protocols
);
2777 protocol
= open_vconn_for_flow_mod(remote
, &vconn
, usable_protocols
);
2778 version
= ofputil_protocol_to_ofp_version(protocol
);
2780 for (i
= 0; i
< n_gms
; i
++) {
2782 request
= ofputil_encode_group_mod(version
, gm
);
2783 transact_noreply(vconn
, request
);
2784 ofputil_uninit_group_mod(gm
);
2791 ofctl_group_mod_file(int argc OVS_UNUSED
, char *argv
[], int command
)
2793 struct ofputil_group_mod
*gms
= NULL
;
2794 enum ofputil_protocol usable_protocols
;
2798 if (command
== OFPGC11_ADD
) {
2799 /* Allow the file to specify a mix of commands. If none specified at
2800 * the beginning of any given line, then the default is OFPGC11_ADD, so
2801 * this is backwards compatible. */
2804 error
= parse_ofp_group_mod_file(argv
[2], ports_to_accept(argv
[1]),
2805 command
, &gms
, &n_gms
, &usable_protocols
);
2807 ovs_fatal(0, "%s", error
);
2809 ofctl_group_mod__(argv
[1], gms
, n_gms
, usable_protocols
);
2814 ofctl_group_mod(int argc
, char *argv
[], uint16_t command
)
2816 if (argc
> 2 && !strcmp(argv
[2], "-")) {
2817 ofctl_group_mod_file(argc
, argv
, command
);
2819 enum ofputil_protocol usable_protocols
;
2820 struct ofputil_group_mod gm
;
2823 error
= parse_ofp_group_mod_str(&gm
, command
, argc
> 2 ? argv
[2] : "",
2824 ports_to_accept(argv
[1]),
2827 ovs_fatal(0, "%s", error
);
2829 ofctl_group_mod__(argv
[1], &gm
, 1, usable_protocols
);
2834 ofctl_add_group(struct ovs_cmdl_context
*ctx
)
2836 ofctl_group_mod(ctx
->argc
, ctx
->argv
, OFPGC11_ADD
);
2840 ofctl_add_groups(struct ovs_cmdl_context
*ctx
)
2842 ofctl_group_mod_file(ctx
->argc
, ctx
->argv
, OFPGC11_ADD
);
2846 ofctl_mod_group(struct ovs_cmdl_context
*ctx
)
2848 ofctl_group_mod(ctx
->argc
, ctx
->argv
,
2849 may_create
? OFPGC11_ADD_OR_MOD
: OFPGC11_MODIFY
);
2853 ofctl_del_groups(struct ovs_cmdl_context
*ctx
)
2855 ofctl_group_mod(ctx
->argc
, ctx
->argv
, OFPGC11_DELETE
);
2859 ofctl_insert_bucket(struct ovs_cmdl_context
*ctx
)
2861 ofctl_group_mod(ctx
->argc
, ctx
->argv
, OFPGC15_INSERT_BUCKET
);
2865 ofctl_remove_bucket(struct ovs_cmdl_context
*ctx
)
2867 ofctl_group_mod(ctx
->argc
, ctx
->argv
, OFPGC15_REMOVE_BUCKET
);
2871 ofctl_dump_group_stats(struct ovs_cmdl_context
*ctx
)
2873 enum ofputil_protocol usable_protocols
;
2874 struct ofputil_group_mod gm
;
2875 struct ofpbuf
*request
;
2876 struct vconn
*vconn
;
2880 memset(&gm
, 0, sizeof gm
);
2882 error
= parse_ofp_group_mod_str(&gm
, OFPGC11_DELETE
,
2883 ctx
->argc
> 2 ? ctx
->argv
[2] : "",
2884 ports_to_accept(ctx
->argv
[1]),
2887 ovs_fatal(0, "%s", error
);
2890 group_id
= gm
.group_id
;
2892 open_vconn(ctx
->argv
[1], &vconn
);
2893 request
= ofputil_encode_group_stats_request(vconn_get_version(vconn
),
2896 dump_transaction(vconn
, request
);
2903 ofctl_dump_group_desc(struct ovs_cmdl_context
*ctx
)
2905 struct ofpbuf
*request
;
2906 struct vconn
*vconn
;
2909 open_vconn(ctx
->argv
[1], &vconn
);
2911 if (ctx
->argc
< 3 || !ofputil_group_from_string(ctx
->argv
[2], &group_id
)) {
2912 group_id
= OFPG_ALL
;
2915 request
= ofputil_encode_group_desc_request(vconn_get_version(vconn
),
2918 dump_transaction(vconn
, request
);
2925 ofctl_dump_group_features(struct ovs_cmdl_context
*ctx
)
2927 struct ofpbuf
*request
;
2928 struct vconn
*vconn
;
2930 open_vconn(ctx
->argv
[1], &vconn
);
2931 request
= ofputil_encode_group_features_request(vconn_get_version(vconn
));
2933 dump_transaction(vconn
, request
);
2940 ofctl_bundle(struct ovs_cmdl_context
*ctx
)
2942 enum ofputil_protocol protocol
, usable_protocols
;
2943 struct ofputil_bundle_msg
*bms
;
2944 struct ovs_list requests
;
2945 struct vconn
*vconn
;
2949 error
= parse_ofp_bundle_file(ctx
->argv
[2], ports_to_accept(ctx
->argv
[1]),
2950 &bms
, &n_bms
, &usable_protocols
);
2952 ovs_fatal(0, "%s", error
);
2955 /* Implicit OpenFlow 1.4. */
2956 if (!(get_allowed_ofp_versions() &
2957 ofputil_protocols_to_version_bitmap(OFPUTIL_P_OF13_UP
))) {
2959 /* Add implicit allowance for OpenFlow 1.4. */
2960 add_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
2961 OFPUTIL_P_OF14_OXM
));
2962 /* Remove all versions that do not support bundles. */
2963 mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
2964 OFPUTIL_P_OF13_UP
));
2965 allowed_protocols
= ofputil_protocols_from_version_bitmap(
2966 get_allowed_ofp_versions());
2969 /* Bundles need OpenFlow 1.3+. */
2970 usable_protocols
&= OFPUTIL_P_OF13_UP
;
2971 protocol
= open_vconn_for_flow_mod(ctx
->argv
[1], &vconn
, usable_protocols
);
2973 ovs_list_init(&requests
);
2974 ofputil_encode_bundle_msgs(bms
, n_bms
, &requests
, protocol
);
2975 ofputil_free_bundle_msgs(bms
, n_bms
);
2976 bundle_transact(vconn
, &requests
, OFPBF_ORDERED
| OFPBF_ATOMIC
);
2977 ofpbuf_list_delete(&requests
);
2983 ofctl_tlv_mod(struct ovs_cmdl_context
*ctx
, uint16_t command
)
2985 enum ofputil_protocol usable_protocols
;
2986 enum ofputil_protocol protocol
;
2987 struct ofputil_tlv_table_mod ttm
;
2989 enum ofp_version version
;
2990 struct ofpbuf
*request
;
2991 struct vconn
*vconn
;
2993 error
= parse_ofp_tlv_table_mod_str(&ttm
, command
, ctx
->argc
> 2 ?
2997 ovs_fatal(0, "%s", error
);
3000 protocol
= open_vconn_for_flow_mod(ctx
->argv
[1], &vconn
, usable_protocols
);
3001 version
= ofputil_protocol_to_ofp_version(protocol
);
3003 request
= ofputil_encode_tlv_table_mod(version
, &ttm
);
3005 transact_noreply(vconn
, request
);
3009 ofputil_uninit_tlv_table(&ttm
.mappings
);
3013 ofctl_add_tlv_map(struct ovs_cmdl_context
*ctx
)
3015 ofctl_tlv_mod(ctx
, NXTTMC_ADD
);
3019 ofctl_del_tlv_map(struct ovs_cmdl_context
*ctx
)
3021 ofctl_tlv_mod(ctx
, ctx
->argc
> 2 ? NXTTMC_DELETE
: NXTTMC_CLEAR
);
3025 ofctl_dump_tlv_map(struct ovs_cmdl_context
*ctx
)
3027 dump_trivial_transaction(ctx
->argv
[1], OFPRAW_NXT_TLV_TABLE_REQUEST
);
3031 ofctl_help(struct ovs_cmdl_context
*ctx OVS_UNUSED
)
3037 ofctl_list_commands(struct ovs_cmdl_context
*ctx OVS_UNUSED
)
3039 ovs_cmdl_print_commands(get_all_commands());
3042 /* replace-flows and diff-flows commands. */
3044 struct flow_tables
{
3045 struct classifier tables
[OFPTT_MAX
+ 1];
3048 #define FOR_EACH_TABLE(CLS, TABLES) \
3049 for ((CLS) = (TABLES)->tables; \
3050 (CLS) < &(TABLES)->tables[ARRAY_SIZE((TABLES)->tables)]; \
3054 flow_tables_init(struct flow_tables
*tables
)
3056 struct classifier
*cls
;
3058 FOR_EACH_TABLE (cls
, tables
) {
3059 classifier_init(cls
, NULL
);
3064 flow_tables_defer(struct flow_tables
*tables
)
3066 struct classifier
*cls
;
3068 FOR_EACH_TABLE (cls
, tables
) {
3069 classifier_defer(cls
);
3074 flow_tables_publish(struct flow_tables
*tables
)
3076 struct classifier
*cls
;
3078 FOR_EACH_TABLE (cls
, tables
) {
3079 classifier_publish(cls
);
3083 /* A flow table entry, possibly with two different versions. */
3085 struct cls_rule rule
; /* Within a "struct classifier". */
3086 struct fte_version
*versions
[2];
3089 /* One version of a Flow Table Entry. */
3090 struct fte_version
{
3092 uint16_t idle_timeout
;
3093 uint16_t hard_timeout
;
3094 uint16_t importance
;
3096 struct ofpact
*ofpacts
;
3101 /* A FTE entry that has been queued for later insertion after all
3102 * flows have been scanned to correctly allocation tunnel metadata. */
3103 struct fte_pending
{
3104 struct match
*match
;
3106 struct fte_version
*version
;
3109 struct ovs_list list_node
;
3112 /* Processing state during two stage processing of flow table entries.
3113 * Tracks the maximum size seen for each tunnel metadata entry as well
3114 * as a list of the pending FTE entries. */
3116 int tun_metadata_size
[TUN_METADATA_NUM_OPTS
];
3117 struct ovs_list fte_pending_list
;
3119 /* The final metadata table that we have constructed. */
3120 struct tun_table
*tun_tab
;
3122 /* Port map. There is only one port map, not one per source, because it
3123 * only makes sense to display a single name for a given port number. */
3124 const struct ofputil_port_map
*port_map
;
3127 /* Frees 'version' and the data that it owns. */
3129 fte_version_free(struct fte_version
*version
)
3132 free(CONST_CAST(struct ofpact
*, version
->ofpacts
));
3137 /* Returns true if 'a' and 'b' are the same, false if they differ.
3139 * Ignores differences in 'flags' because there's no way to retrieve flags from
3140 * an OpenFlow switch. We have to assume that they are the same. */
3142 fte_version_equals(const struct fte_version
*a
, const struct fte_version
*b
)
3144 return (a
->cookie
== b
->cookie
3145 && a
->idle_timeout
== b
->idle_timeout
3146 && a
->hard_timeout
== b
->hard_timeout
3147 && a
->importance
== b
->importance
3148 && a
->table_id
== b
->table_id
3149 && ofpacts_equal_stringwise(a
->ofpacts
, a
->ofpacts_len
,
3150 b
->ofpacts
, b
->ofpacts_len
));
3153 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
3154 * 'index' into 's', followed by a new-line. */
3156 fte_version_format(const struct fte_state
*fte_state
, const struct fte
*fte
,
3157 int index
, struct ds
*s
)
3159 const struct fte_version
*version
= fte
->versions
[index
];
3166 if (version
->table_id
) {
3167 ds_put_format(s
, "table=%"PRIu8
" ", version
->table_id
);
3169 cls_rule_format(&fte
->rule
, fte_state
->tun_tab
, fte_state
->port_map
, s
);
3170 if (version
->cookie
!= htonll(0)) {
3171 ds_put_format(s
, " cookie=0x%"PRIx64
, ntohll(version
->cookie
));
3173 if (version
->idle_timeout
!= OFP_FLOW_PERMANENT
) {
3174 ds_put_format(s
, " idle_timeout=%"PRIu16
, version
->idle_timeout
);
3176 if (version
->hard_timeout
!= OFP_FLOW_PERMANENT
) {
3177 ds_put_format(s
, " hard_timeout=%"PRIu16
, version
->hard_timeout
);
3179 if (version
->importance
!= 0) {
3180 ds_put_format(s
, " importance=%"PRIu16
, version
->importance
);
3183 ds_put_cstr(s
, " actions=");
3184 ofpacts_format(version
->ofpacts
, version
->ofpacts_len
,
3185 fte_state
->port_map
, s
);
3187 ds_put_char(s
, '\n');
3191 fte_from_cls_rule(const struct cls_rule
*cls_rule
)
3193 return cls_rule
? CONTAINER_OF(cls_rule
, struct fte
, rule
) : NULL
;
3196 /* Frees 'fte' and its versions. */
3198 fte_free(struct fte
*fte
)
3201 fte_version_free(fte
->versions
[0]);
3202 fte_version_free(fte
->versions
[1]);
3203 cls_rule_destroy(&fte
->rule
);
3208 /* Frees all of the FTEs within 'tables'. */
3210 fte_free_all(struct flow_tables
*tables
)
3212 struct classifier
*cls
;
3214 FOR_EACH_TABLE (cls
, tables
) {
3217 classifier_defer(cls
);
3218 CLS_FOR_EACH (fte
, rule
, cls
) {
3219 classifier_remove(cls
, &fte
->rule
);
3220 ovsrcu_postpone(fte_free
, fte
);
3222 classifier_destroy(cls
);
3226 /* Searches 'tables' for an FTE matching 'rule', inserting a new one if
3227 * necessary. Sets 'version' as the version of that rule with the given
3228 * 'index', replacing any existing version, if any.
3230 * Takes ownership of 'version'. */
3232 fte_insert(struct flow_tables
*tables
, const struct match
*match
,
3233 int priority
, struct fte_version
*version
, int index
)
3235 struct classifier
*cls
= &tables
->tables
[version
->table_id
];
3236 struct fte
*old
, *fte
;
3238 fte
= xzalloc(sizeof *fte
);
3239 cls_rule_init(&fte
->rule
, match
, priority
);
3240 fte
->versions
[index
] = version
;
3242 old
= fte_from_cls_rule(classifier_replace(cls
, &fte
->rule
,
3243 OVS_VERSION_MIN
, NULL
, 0));
3245 fte
->versions
[!index
] = old
->versions
[!index
];
3246 old
->versions
[!index
] = NULL
;
3248 ovsrcu_postpone(fte_free
, old
);
3252 /* Given a list of the field sizes for each tunnel metadata entry, install
3253 * a mapping table for later operations. */
3255 generate_tun_metadata(struct fte_state
*state
)
3257 struct ofputil_tlv_table_mod ttm
;
3260 ttm
.command
= NXTTMC_ADD
;
3261 ovs_list_init(&ttm
.mappings
);
3263 for (i
= 0; i
< TUN_METADATA_NUM_OPTS
; i
++) {
3264 if (state
->tun_metadata_size
[i
] != -1) {
3265 struct ofputil_tlv_map
*map
= xmalloc(sizeof *map
);
3267 ovs_list_push_back(&ttm
.mappings
, &map
->list_node
);
3269 /* We don't care about the actual option class and type since there
3270 * won't be any lookup. We just need to make them unique. */
3271 map
->option_class
= i
/ UINT8_MAX
;
3272 map
->option_type
= i
;
3273 map
->option_len
= ROUND_UP(state
->tun_metadata_size
[i
], 4);
3278 tun_metadata_table_mod(&ttm
, NULL
, &state
->tun_tab
);
3279 ofputil_uninit_tlv_table(&ttm
.mappings
);
3282 /* Once we have created a tunnel mapping table with a consistent overall
3283 * allocation, we need to remap each flow to use this table from its own
3284 * allocation. Since the mapping table has already been installed, we
3285 * can just read the data from the match and rewrite it. On rewrite, it
3286 * will use the new table. */
3288 remap_match(struct fte_state
*state
, struct match
*match
)
3292 if (!match
->tun_md
.valid
) {
3296 struct tun_metadata flow
= match
->flow
.tunnel
.metadata
;
3297 struct tun_metadata flow_mask
= match
->wc
.masks
.tunnel
.metadata
;
3298 memset(&match
->flow
.tunnel
.metadata
, 0, sizeof match
->flow
.tunnel
.metadata
);
3299 memset(&match
->wc
.masks
.tunnel
.metadata
, 0,
3300 sizeof match
->wc
.masks
.tunnel
.metadata
);
3301 match
->tun_md
.valid
= false;
3303 match
->flow
.tunnel
.metadata
.tab
= state
->tun_tab
;
3304 match
->wc
.masks
.tunnel
.metadata
.tab
= match
->flow
.tunnel
.metadata
.tab
;
3306 ULLONG_FOR_EACH_1 (i
, flow_mask
.present
.map
) {
3307 const struct mf_field
*field
= mf_from_id(MFF_TUN_METADATA0
+ i
);
3308 int offset
= match
->tun_md
.entry
[i
].loc
.c
.offset
;
3309 int len
= match
->tun_md
.entry
[i
].loc
.len
;
3310 union mf_value value
, mask
;
3312 memset(&value
, 0, field
->n_bytes
- len
);
3313 memset(&mask
, match
->tun_md
.entry
[i
].masked
? 0 : 0xff,
3314 field
->n_bytes
- len
);
3316 memcpy(value
.tun_metadata
+ field
->n_bytes
- len
,
3317 flow
.opts
.u8
+ offset
, len
);
3318 memcpy(mask
.tun_metadata
+ field
->n_bytes
- len
,
3319 flow_mask
.opts
.u8
+ offset
, len
);
3320 mf_set(field
, &value
, &mask
, match
, NULL
);
3324 /* In order to correctly handle tunnel metadata, we need to have
3325 * two passes over the flows. This happens because tunnel metadata
3326 * doesn't have fixed locations in a flow entry but is instead dynamically
3327 * allocated space. In the case of flows coming from a file, we don't
3328 * even know the size of each field when we need to do the allocation.
3329 * When the flows come in, each flow has an individual allocation based
3330 * on its own fields. However, this allocation is not the same across
3331 * different flows and therefore fields are not directly comparable.
3333 * In the first pass, we record the maximum size of each tunnel metadata
3334 * field as well as queue FTE entries for later processing.
3336 * In the second pass, we use the metadata size information to create a
3337 * tunnel mapping table and set that through the tunnel metadata processing
3338 * code. We then remap all individual flows to use this common allocation
3339 * scheme. Finally, we load the queued entries into the classifier for
3342 * fte_state_init() should be called before processing any flows. */
3344 fte_state_init(struct fte_state
*state
)
3348 for (i
= 0; i
< TUN_METADATA_NUM_OPTS
; i
++) {
3349 state
->tun_metadata_size
[i
] = -1;
3352 ovs_list_init(&state
->fte_pending_list
);
3353 state
->tun_tab
= NULL
;
3354 state
->port_map
= NULL
;
3358 fte_state_destroy(struct fte_state
*state
)
3360 tun_metadata_free(state
->tun_tab
);
3363 /* The first pass of the processing described in the comment about
3364 * fte_state_init(). fte_queue() is the first pass to be called as each
3365 * flow is read from its source. */
3367 fte_queue(struct fte_state
*state
, const struct match
*match
,
3368 int priority
, struct fte_version
*version
, int index
)
3370 struct fte_pending
*pending
= xmalloc(sizeof *pending
);
3373 pending
->match
= xmemdup(match
, sizeof *match
);
3374 pending
->priority
= priority
;
3375 pending
->version
= version
;
3376 pending
->index
= index
;
3377 ovs_list_push_back(&state
->fte_pending_list
, &pending
->list_node
);
3379 if (!match
->tun_md
.valid
) {
3383 ULLONG_FOR_EACH_1 (i
, match
->wc
.masks
.tunnel
.metadata
.present
.map
) {
3384 if (match
->tun_md
.entry
[i
].loc
.len
> state
->tun_metadata_size
[i
]) {
3385 state
->tun_metadata_size
[i
] = match
->tun_md
.entry
[i
].loc
.len
;
3390 /* The second pass of the processing described in the comment about
3391 * fte_state_init(). This should be called once all flows (from both
3392 * sides of the comparison) have been added through fte_queue(). */
3394 fte_fill(struct fte_state
*state
, struct flow_tables
*tables
)
3396 struct fte_pending
*pending
;
3398 generate_tun_metadata(state
);
3400 flow_tables_init(tables
);
3401 flow_tables_defer(tables
);
3403 LIST_FOR_EACH_POP(pending
, list_node
, &state
->fte_pending_list
) {
3404 remap_match(state
, pending
->match
);
3405 fte_insert(tables
, pending
->match
, pending
->priority
, pending
->version
,
3407 free(pending
->match
);
3411 flow_tables_publish(tables
);
3414 /* Reads the flows in 'filename' as flow table entries in 'tables' for the
3415 * version with the specified 'index'. Returns the flow formats able to
3416 * represent the flows that were read. */
3417 static enum ofputil_protocol
3418 read_flows_from_file(const char *filename
, struct fte_state
*state
, int index
)
3420 enum ofputil_protocol usable_protocols
;
3425 file
= !strcmp(filename
, "-") ? stdin
: fopen(filename
, "r");
3427 ovs_fatal(errno
, "%s: open", filename
);
3431 usable_protocols
= OFPUTIL_P_ANY
;
3433 while (!ds_get_preprocessed_line(&s
, file
, &line_number
)) {
3434 struct fte_version
*version
;
3435 struct ofputil_flow_mod fm
;
3437 enum ofputil_protocol usable
;
3439 error
= parse_ofp_str(&fm
, OFPFC_ADD
, ds_cstr(&s
), state
->port_map
,
3442 ovs_fatal(0, "%s:%d: %s", filename
, line_number
, error
);
3444 usable_protocols
&= usable
;
3446 version
= xmalloc(sizeof *version
);
3447 version
->cookie
= fm
.new_cookie
;
3448 version
->idle_timeout
= fm
.idle_timeout
;
3449 version
->hard_timeout
= fm
.hard_timeout
;
3450 version
->importance
= fm
.importance
;
3451 version
->flags
= fm
.flags
& (OFPUTIL_FF_SEND_FLOW_REM
3452 | OFPUTIL_FF_EMERG
);
3453 version
->ofpacts
= fm
.ofpacts
;
3454 version
->ofpacts_len
= fm
.ofpacts_len
;
3455 version
->table_id
= fm
.table_id
!= OFPTT_ALL
? fm
.table_id
: 0;
3457 fte_queue(state
, &fm
.match
, fm
.priority
, version
, index
);
3461 if (file
!= stdin
) {
3465 return usable_protocols
;
3468 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
3469 * format 'protocol', and adds them as flow table entries in 'tables' for the
3470 * version with the specified 'index'. */
3472 read_flows_from_switch(struct vconn
*vconn
,
3473 enum ofputil_protocol protocol
,
3474 struct fte_state
*state
, int index
)
3476 struct ofputil_flow_stats_request fsr
;
3478 fsr
.aggregate
= false;
3479 match_init_catchall(&fsr
.match
);
3480 fsr
.out_port
= OFPP_ANY
;
3481 fsr
.out_group
= OFPG_ANY
;
3482 fsr
.table_id
= 0xff;
3483 fsr
.cookie
= fsr
.cookie_mask
= htonll(0);
3485 struct ofputil_flow_stats
*fses
;
3487 run(vconn_dump_flows(vconn
, &fsr
, protocol
, &fses
, &n_fses
),
3489 for (size_t i
= 0; i
< n_fses
; i
++) {
3490 const struct ofputil_flow_stats
*fs
= &fses
[i
];
3491 struct fte_version
*version
;
3493 version
= xmalloc(sizeof *version
);
3494 version
->cookie
= fs
->cookie
;
3495 version
->idle_timeout
= fs
->idle_timeout
;
3496 version
->hard_timeout
= fs
->hard_timeout
;
3497 version
->importance
= fs
->importance
;
3499 version
->ofpacts_len
= fs
->ofpacts_len
;
3500 version
->ofpacts
= xmemdup(fs
->ofpacts
, fs
->ofpacts_len
);
3501 version
->table_id
= fs
->table_id
;
3503 fte_queue(state
, &fs
->match
, fs
->priority
, version
, index
);
3506 for (size_t i
= 0; i
< n_fses
; i
++) {
3507 free(CONST_CAST(struct ofpact
*, fses
[i
].ofpacts
));
3513 fte_make_flow_mod(const struct fte
*fte
, int index
, uint16_t command
,
3514 enum ofputil_protocol protocol
, struct ovs_list
*packets
)
3516 const struct fte_version
*version
= fte
->versions
[index
];
3519 struct ofputil_flow_mod fm
= {
3520 .priority
= fte
->rule
.priority
,
3521 .new_cookie
= version
->cookie
,
3522 .modify_cookie
= true,
3523 .table_id
= version
->table_id
,
3525 .idle_timeout
= version
->idle_timeout
,
3526 .hard_timeout
= version
->hard_timeout
,
3527 .importance
= version
->importance
,
3528 .buffer_id
= UINT32_MAX
,
3529 .out_port
= OFPP_ANY
,
3530 .out_group
= OFPG_ANY
,
3531 .flags
= version
->flags
,
3533 minimatch_expand(&fte
->rule
.match
, &fm
.match
);
3534 if (command
== OFPFC_ADD
|| command
== OFPFC_MODIFY
||
3535 command
== OFPFC_MODIFY_STRICT
) {
3536 fm
.ofpacts
= version
->ofpacts
;
3537 fm
.ofpacts_len
= version
->ofpacts_len
;
3543 ofm
= ofputil_encode_flow_mod(&fm
, protocol
);
3544 ovs_list_push_back(packets
, &ofm
->list_node
);
3548 ofctl_replace_flows(struct ovs_cmdl_context
*ctx
)
3550 enum { FILE_IDX
= 0, SWITCH_IDX
= 1 };
3551 enum ofputil_protocol usable_protocols
, protocol
;
3552 struct fte_state fte_state
;
3553 struct flow_tables tables
;
3554 struct classifier
*cls
;
3555 struct ovs_list requests
;
3556 struct vconn
*vconn
;
3559 fte_state_init(&fte_state
);
3560 fte_state
.port_map
= ports_to_accept(ctx
->argv
[1]);
3561 usable_protocols
= read_flows_from_file(ctx
->argv
[2], &fte_state
, FILE_IDX
);
3563 protocol
= open_vconn(ctx
->argv
[1], &vconn
);
3564 protocol
= set_protocol_for_flow_dump(vconn
, protocol
, usable_protocols
);
3566 read_flows_from_switch(vconn
, protocol
, &fte_state
, SWITCH_IDX
);
3568 fte_fill(&fte_state
, &tables
);
3570 ovs_list_init(&requests
);
3572 FOR_EACH_TABLE (cls
, &tables
) {
3573 /* Delete flows that exist on the switch but not in the file. */
3574 CLS_FOR_EACH (fte
, rule
, cls
) {
3575 struct fte_version
*file_ver
= fte
->versions
[FILE_IDX
];
3576 struct fte_version
*sw_ver
= fte
->versions
[SWITCH_IDX
];
3578 if (sw_ver
&& !file_ver
) {
3579 fte_make_flow_mod(fte
, SWITCH_IDX
, OFPFC_DELETE_STRICT
,
3580 protocol
, &requests
);
3584 /* Add flows that exist in the file but not on the switch.
3585 * Update flows that exist in both places but differ. */
3586 CLS_FOR_EACH (fte
, rule
, cls
) {
3587 struct fte_version
*file_ver
= fte
->versions
[FILE_IDX
];
3588 struct fte_version
*sw_ver
= fte
->versions
[SWITCH_IDX
];
3591 (readd
|| !sw_ver
|| !fte_version_equals(sw_ver
, file_ver
))) {
3592 fte_make_flow_mod(fte
, FILE_IDX
, OFPFC_ADD
, protocol
,
3598 bundle_transact(vconn
, &requests
, OFPBF_ORDERED
| OFPBF_ATOMIC
);
3600 transact_multiple_noreply(vconn
, &requests
);
3603 ofpbuf_list_delete(&requests
);
3606 fte_free_all(&tables
);
3607 fte_state_destroy(&fte_state
);
3611 read_flows_from_source(const char *source
, struct fte_state
*state
, int index
)
3615 if (source
[0] == '/' || source
[0] == '.'
3616 || (!strchr(source
, ':') && !stat(source
, &s
))) {
3617 read_flows_from_file(source
, state
, index
);
3619 enum ofputil_protocol protocol
;
3620 struct vconn
*vconn
;
3622 protocol
= open_vconn(source
, &vconn
);
3623 protocol
= set_protocol_for_flow_dump(vconn
, protocol
, OFPUTIL_P_ANY
);
3624 read_flows_from_switch(vconn
, protocol
, state
, index
);
3627 if (!state
->port_map
) {
3628 state
->port_map
= ports_to_show(source
);
3634 ofctl_diff_flows(struct ovs_cmdl_context
*ctx
)
3636 bool differences
= false;
3637 struct fte_state fte_state
;
3638 struct flow_tables tables
;
3639 struct classifier
*cls
;
3643 fte_state_init(&fte_state
);
3644 read_flows_from_source(ctx
->argv
[1], &fte_state
, 0);
3645 read_flows_from_source(ctx
->argv
[2], &fte_state
, 1);
3646 fte_fill(&fte_state
, &tables
);
3651 FOR_EACH_TABLE (cls
, &tables
) {
3652 CLS_FOR_EACH (fte
, rule
, cls
) {
3653 struct fte_version
*a
= fte
->versions
[0];
3654 struct fte_version
*b
= fte
->versions
[1];
3656 if (!a
|| !b
|| !fte_version_equals(a
, b
)) {
3657 fte_version_format(&fte_state
, fte
, 0, &a_s
);
3658 fte_version_format(&fte_state
, fte
, 1, &b_s
);
3660 printf("-%s", ds_cstr(&a_s
));
3663 printf("+%s", ds_cstr(&b_s
));
3673 fte_free_all(&tables
);
3674 fte_state_destroy(&fte_state
);
3682 ofctl_meter_mod__(const char *bridge
, const char *str
, int command
)
3684 struct ofputil_meter_mod mm
;
3685 struct vconn
*vconn
;
3686 enum ofputil_protocol protocol
;
3687 enum ofputil_protocol usable_protocols
;
3688 enum ofp_version version
;
3692 error
= parse_ofp_meter_mod_str(&mm
, str
, command
, &usable_protocols
);
3694 ovs_fatal(0, "%s", error
);
3697 usable_protocols
= OFPUTIL_P_OF13_UP
;
3698 mm
.command
= command
;
3699 mm
.meter
.meter_id
= OFPM13_ALL
;
3700 mm
.meter
.bands
= NULL
;
3703 protocol
= open_vconn_for_flow_mod(bridge
, &vconn
, usable_protocols
);
3704 version
= ofputil_protocol_to_ofp_version(protocol
);
3705 transact_noreply(vconn
, ofputil_encode_meter_mod(version
, &mm
));
3706 free(mm
.meter
.bands
);
3711 ofctl_meter_request__(const char *bridge
, const char *str
,
3712 enum ofputil_meter_request_type type
)
3714 struct ofputil_meter_mod mm
;
3715 struct vconn
*vconn
;
3716 enum ofputil_protocol usable_protocols
;
3717 enum ofputil_protocol protocol
;
3718 enum ofp_version version
;
3722 error
= parse_ofp_meter_mod_str(&mm
, str
, -1, &usable_protocols
);
3724 ovs_fatal(0, "%s", error
);
3727 usable_protocols
= OFPUTIL_P_OF13_UP
;
3728 mm
.meter
.meter_id
= OFPM13_ALL
;
3729 mm
.meter
.bands
= NULL
;
3732 protocol
= open_vconn_for_flow_mod(bridge
, &vconn
, usable_protocols
);
3733 version
= ofputil_protocol_to_ofp_version(protocol
);
3734 dump_transaction(vconn
, ofputil_encode_meter_request(version
, type
,
3735 mm
.meter
.meter_id
));
3736 free(mm
.meter
.bands
);
3742 ofctl_add_meter(struct ovs_cmdl_context
*ctx
)
3744 ofctl_meter_mod__(ctx
->argv
[1], ctx
->argv
[2], OFPMC13_ADD
);
3748 ofctl_mod_meter(struct ovs_cmdl_context
*ctx
)
3750 ofctl_meter_mod__(ctx
->argv
[1], ctx
->argv
[2], OFPMC13_MODIFY
);
3754 ofctl_del_meters(struct ovs_cmdl_context
*ctx
)
3756 ofctl_meter_mod__(ctx
->argv
[1], ctx
->argc
> 2 ? ctx
->argv
[2] : NULL
, OFPMC13_DELETE
);
3760 ofctl_dump_meters(struct ovs_cmdl_context
*ctx
)
3762 ofctl_meter_request__(ctx
->argv
[1], ctx
->argc
> 2 ? ctx
->argv
[2] : NULL
,
3763 OFPUTIL_METER_CONFIG
);
3767 ofctl_meter_stats(struct ovs_cmdl_context
*ctx
)
3769 ofctl_meter_request__(ctx
->argv
[1], ctx
->argc
> 2 ? ctx
->argv
[2] : NULL
,
3770 OFPUTIL_METER_STATS
);
3774 ofctl_meter_features(struct ovs_cmdl_context
*ctx
)
3776 ofctl_meter_request__(ctx
->argv
[1], NULL
, OFPUTIL_METER_FEATURES
);
3780 /* Undocumented commands for unit testing. */
3783 ofctl_parse_flows__(struct ofputil_flow_mod
*fms
, size_t n_fms
,
3784 enum ofputil_protocol usable_protocols
)
3786 enum ofputil_protocol protocol
= 0;
3790 usable_s
= ofputil_protocols_to_string(usable_protocols
);
3791 printf("usable protocols: %s\n", usable_s
);
3794 if (!(usable_protocols
& allowed_protocols
)) {
3795 ovs_fatal(0, "no usable protocol");
3797 for (i
= 0; i
< sizeof(enum ofputil_protocol
) * CHAR_BIT
; i
++) {
3799 if (protocol
& usable_protocols
& allowed_protocols
) {
3803 ovs_assert(is_pow2(protocol
));
3805 printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol
));
3807 for (i
= 0; i
< n_fms
; i
++) {
3808 struct ofputil_flow_mod
*fm
= &fms
[i
];
3811 msg
= ofputil_encode_flow_mod(fm
, protocol
);
3812 ofp_print(stdout
, msg
->data
, msg
->size
, NULL
, verbosity
);
3815 free(CONST_CAST(struct ofpact
*, fm
->ofpacts
));
3819 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
3820 * it back to stdout. */
3822 ofctl_parse_flow(struct ovs_cmdl_context
*ctx
)
3824 enum ofputil_protocol usable_protocols
;
3825 struct ofputil_flow_mod fm
;
3828 error
= parse_ofp_flow_mod_str(&fm
, ctx
->argv
[1], NULL
,
3829 OFPFC_ADD
, &usable_protocols
);
3831 ovs_fatal(0, "%s", error
);
3833 ofctl_parse_flows__(&fm
, 1, usable_protocols
);
3836 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
3837 * add-flows) and prints each of the flows back to stdout. */
3839 ofctl_parse_flows(struct ovs_cmdl_context
*ctx
)
3841 enum ofputil_protocol usable_protocols
;
3842 struct ofputil_flow_mod
*fms
= NULL
;
3846 error
= parse_ofp_flow_mod_file(ctx
->argv
[1], NULL
, OFPFC_ADD
,
3847 &fms
, &n_fms
, &usable_protocols
);
3849 ovs_fatal(0, "%s", error
);
3851 ofctl_parse_flows__(fms
, n_fms
, usable_protocols
);
3856 ofctl_parse_nxm__(bool oxm
, enum ofp_version version
)
3861 while (!ds_get_test_line(&in
, stdin
)) {
3862 struct ofpbuf nx_match
;
3864 ovs_be64 cookie
, cookie_mask
;
3868 /* Convert string to nx_match. */
3869 ofpbuf_init(&nx_match
, 0);
3871 match_len
= oxm_match_from_string(ds_cstr(&in
), &nx_match
);
3873 match_len
= nx_match_from_string(ds_cstr(&in
), &nx_match
);
3876 /* Convert nx_match to match. */
3879 error
= oxm_pull_match(&nx_match
, false, NULL
, NULL
, &match
);
3881 error
= nx_pull_match(&nx_match
, match_len
, &match
, &cookie
,
3882 &cookie_mask
, false, NULL
, NULL
);
3886 error
= oxm_pull_match_loose(&nx_match
, false, NULL
, &match
);
3888 error
= nx_pull_match_loose(&nx_match
, match_len
, &match
,
3889 &cookie
, &cookie_mask
, false,
3898 /* Convert match back to nx_match. */
3899 ofpbuf_uninit(&nx_match
);
3900 ofpbuf_init(&nx_match
, 0);
3902 match_len
= oxm_put_match(&nx_match
, &match
, version
);
3903 out
= oxm_match_to_string(&nx_match
, match_len
);
3905 match_len
= nx_put_match(&nx_match
, &match
,
3906 cookie
, cookie_mask
);
3907 out
= nx_match_to_string(nx_match
.data
, match_len
);
3913 if (verbosity
> 0) {
3914 ovs_hex_dump(stdout
, nx_match
.data
, nx_match
.size
, 0, false);
3917 printf("nx_pull_match() returned error %s\n",
3918 ofperr_get_name(error
));
3921 ofpbuf_uninit(&nx_match
);
3926 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
3927 * stdin, does some internal fussing with them, and then prints them back as
3928 * strings on stdout. */
3930 ofctl_parse_nxm(struct ovs_cmdl_context
*ctx OVS_UNUSED
)
3932 ofctl_parse_nxm__(false, 0);
3935 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
3936 * strings from stdin, does some internal fussing with them, and then prints
3937 * them back as strings on stdout. VERSION must specify an OpenFlow version,
3938 * e.g. "OpenFlow12". */
3940 ofctl_parse_oxm(struct ovs_cmdl_context
*ctx
)
3942 enum ofp_version version
= ofputil_version_from_string(ctx
->argv
[1]);
3943 if (version
< OFP12_VERSION
) {
3944 ovs_fatal(0, "%s: not a valid version for OXM", ctx
->argv
[1]);
3947 ofctl_parse_nxm__(true, version
);
3951 print_differences(const char *prefix
,
3952 const void *a_
, size_t a_len
,
3953 const void *b_
, size_t b_len
)
3955 const uint8_t *a
= a_
;
3956 const uint8_t *b
= b_
;
3959 for (i
= 0; i
< MIN(a_len
, b_len
); i
++) {
3961 printf("%s%2"PRIuSIZE
": %02"PRIx8
" -> %02"PRIx8
"\n",
3962 prefix
, i
, a
[i
], b
[i
]);
3965 for (i
= a_len
; i
< b_len
; i
++) {
3966 printf("%s%2"PRIuSIZE
": (none) -> %02"PRIx8
"\n", prefix
, i
, b
[i
]);
3968 for (i
= b_len
; i
< a_len
; i
++) {
3969 printf("%s%2"PRIuSIZE
": %02"PRIx8
" -> (none)\n", prefix
, i
, a
[i
]);
3974 ofctl_parse_actions__(const char *version_s
, bool instructions
)
3976 enum ofp_version version
;
3979 version
= ofputil_version_from_string(version_s
);
3981 ovs_fatal(0, "%s: not a valid OpenFlow version", version_s
);
3985 while (!ds_get_preprocessed_line(&in
, stdin
, NULL
)) {
3986 struct ofpbuf of_out
;
3987 struct ofpbuf of_in
;
3988 struct ofpbuf ofpacts
;
3989 const char *table_id
;
3995 /* Parse table_id separated with the follow-up actions by ",", if
3997 actions
= ds_cstr(&in
);
3999 if (strstr(actions
, ",")) {
4000 table_id
= strsep(&actions
, ",");
4003 /* Parse hex bytes. */
4004 ofpbuf_init(&of_in
, 0);
4005 if (ofpbuf_put_hex(&of_in
, actions
, NULL
)[0] != '\0') {
4006 ovs_fatal(0, "Trailing garbage in hex data");
4009 /* Convert to ofpacts. */
4010 ofpbuf_init(&ofpacts
, 0);
4012 error
= (instructions
4013 ? ofpacts_pull_openflow_instructions
4014 : ofpacts_pull_openflow_actions
)(
4015 &of_in
, of_in
.size
, version
, NULL
, NULL
, &ofpacts
);
4016 if (!error
&& instructions
) {
4017 /* Verify actions, enforce consistency. */
4018 enum ofputil_protocol protocol
;
4021 memset(&match
, 0, sizeof match
);
4022 protocol
= ofputil_protocols_from_ofp_version(version
);
4023 error
= ofpacts_check_consistency(ofpacts
.data
, ofpacts
.size
,
4025 table_id
? atoi(table_id
) : 0,
4026 OFPTT_MAX
+ 1, protocol
);
4029 printf("bad %s %s: %s\n\n",
4030 version_s
, instructions
? "instructions" : "actions",
4031 ofperr_get_name(error
));
4032 ofpbuf_uninit(&ofpacts
);
4033 ofpbuf_uninit(&of_in
);
4036 ofpbuf_push_uninit(&of_in
, size
);
4038 /* Print cls_rule. */
4040 ds_put_cstr(&s
, "actions=");
4041 ofpacts_format(ofpacts
.data
, ofpacts
.size
, NULL
, &s
);
4045 /* Convert back to ofp10 actions and print differences from input. */
4046 ofpbuf_init(&of_out
, 0);
4048 ofpacts_put_openflow_instructions(ofpacts
.data
, ofpacts
.size
,
4051 ofpacts_put_openflow_actions(ofpacts
.data
, ofpacts
.size
,
4055 print_differences("", of_in
.data
, of_in
.size
,
4056 of_out
.data
, of_out
.size
);
4059 ofpbuf_uninit(&ofpacts
);
4060 ofpbuf_uninit(&of_in
);
4061 ofpbuf_uninit(&of_out
);
4066 /* "parse-actions VERSION": reads a series of action specifications for the
4067 * given OpenFlow VERSION as hex bytes from stdin, converts them to ofpacts,
4068 * prints them as strings on stdout, and then converts them back to hex bytes
4069 * and prints any differences from the input. */
4071 ofctl_parse_actions(struct ovs_cmdl_context
*ctx
)
4073 ofctl_parse_actions__(ctx
->argv
[1], false);
4076 /* "parse-actions VERSION": reads a series of instruction specifications for
4077 * the given OpenFlow VERSION as hex bytes from stdin, converts them to
4078 * ofpacts, prints them as strings on stdout, and then converts them back to
4079 * hex bytes and prints any differences from the input. */
4081 ofctl_parse_instructions(struct ovs_cmdl_context
*ctx
)
4083 ofctl_parse_actions__(ctx
->argv
[1], true);
4086 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
4087 * bytes from stdin, converts them to cls_rules, prints them as strings on
4088 * stdout, and then converts them back to hex bytes and prints any differences
4091 * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
4092 * values are ignored in the input and will be set to zero when OVS converts
4093 * them back to hex bytes. ovs-ofctl actually sets "x"s to random bits when
4094 * it does the conversion to hex, to ensure that in fact they are ignored. */
4096 ofctl_parse_ofp10_match(struct ovs_cmdl_context
*ctx OVS_UNUSED
)
4103 while (!ds_get_preprocessed_line(&in
, stdin
, NULL
)) {
4104 struct ofpbuf match_in
, match_expout
;
4105 struct ofp10_match match_out
;
4106 struct ofp10_match match_normal
;
4110 /* Parse hex bytes to use for expected output. */
4112 ds_put_cstr(&expout
, ds_cstr(&in
));
4113 for (p
= ds_cstr(&expout
); *p
; p
++) {
4118 ofpbuf_init(&match_expout
, 0);
4119 if (ofpbuf_put_hex(&match_expout
, ds_cstr(&expout
), NULL
)[0] != '\0') {
4120 ovs_fatal(0, "Trailing garbage in hex data");
4122 if (match_expout
.size
!= sizeof(struct ofp10_match
)) {
4123 ovs_fatal(0, "Input is %"PRIu32
" bytes, expected %"PRIuSIZE
,
4124 match_expout
.size
, sizeof(struct ofp10_match
));
4127 /* Parse hex bytes for input. */
4128 for (p
= ds_cstr(&in
); *p
; p
++) {
4130 *p
= "0123456789abcdef"[random_uint32() & 0xf];
4133 ofpbuf_init(&match_in
, 0);
4134 if (ofpbuf_put_hex(&match_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
4135 ovs_fatal(0, "Trailing garbage in hex data");
4137 if (match_in
.size
!= sizeof(struct ofp10_match
)) {
4138 ovs_fatal(0, "Input is %"PRIu32
" bytes, expected %"PRIuSIZE
,
4139 match_in
.size
, sizeof(struct ofp10_match
));
4142 /* Convert to cls_rule and print. */
4143 ofputil_match_from_ofp10_match(match_in
.data
, &match
);
4144 match_print(&match
, NULL
);
4146 /* Convert back to ofp10_match and print differences from input. */
4147 ofputil_match_to_ofp10_match(&match
, &match_out
);
4148 print_differences("", match_expout
.data
, match_expout
.size
,
4149 &match_out
, sizeof match_out
);
4151 /* Normalize, then convert and compare again. */
4152 ofputil_normalize_match(&match
);
4153 ofputil_match_to_ofp10_match(&match
, &match_normal
);
4154 print_differences("normal: ", &match_out
, sizeof match_out
,
4155 &match_normal
, sizeof match_normal
);
4158 ofpbuf_uninit(&match_in
);
4159 ofpbuf_uninit(&match_expout
);
4162 ds_destroy(&expout
);
4165 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
4166 * bytes from stdin, converts them to "struct match"es, prints them as strings
4167 * on stdout, and then converts them back to hex bytes and prints any
4168 * differences from the input. */
4170 ofctl_parse_ofp11_match(struct ovs_cmdl_context
*ctx OVS_UNUSED
)
4175 while (!ds_get_preprocessed_line(&in
, stdin
, NULL
)) {
4176 struct ofpbuf match_in
;
4177 struct ofp11_match match_out
;
4181 /* Parse hex bytes. */
4182 ofpbuf_init(&match_in
, 0);
4183 if (ofpbuf_put_hex(&match_in
, ds_cstr(&in
), NULL
)[0] != '\0') {
4184 ovs_fatal(0, "Trailing garbage in hex data");
4186 if (match_in
.size
!= sizeof(struct ofp11_match
)) {
4187 ovs_fatal(0, "Input is %"PRIu32
" bytes, expected %"PRIuSIZE
,
4188 match_in
.size
, sizeof(struct ofp11_match
));
4191 /* Convert to match. */
4192 error
= ofputil_match_from_ofp11_match(match_in
.data
, &match
);
4194 printf("bad ofp11_match: %s\n\n", ofperr_get_name(error
));
4195 ofpbuf_uninit(&match_in
);
4200 match_print(&match
, NULL
);
4202 /* Convert back to ofp11_match and print differences from input. */
4203 ofputil_match_to_ofp11_match(&match
, &match_out
);
4205 print_differences("", match_in
.data
, match_in
.size
,
4206 &match_out
, sizeof match_out
);
4209 ofpbuf_uninit(&match_in
);
4214 /* "parse-pcap PCAP...": read packets from each PCAP file and print their
4217 ofctl_parse_pcap(struct ovs_cmdl_context
*ctx
)
4220 for (int i
= 1; i
< ctx
->argc
; i
++) {
4221 const char *filename
= ctx
->argv
[i
];
4222 FILE *pcap
= ovs_pcap_open(filename
, "rb");
4225 ovs_error(error
, "%s: open failed", filename
);
4230 struct dp_packet
*packet
;
4234 retval
= ovs_pcap_read(pcap
, &packet
, NULL
);
4235 if (retval
== EOF
) {
4237 } else if (retval
) {
4239 ovs_error(error
, "%s: read failed", filename
);
4242 pkt_metadata_init(&packet
->md
, u32_to_odp(ofp_to_u16(OFPP_ANY
)));
4243 flow_extract(packet
, &flow
);
4244 flow_print(stdout
, &flow
, NULL
);
4246 dp_packet_delete(packet
);
4253 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
4254 * mask values to and from various formats and prints the results. */
4256 ofctl_check_vlan(struct ovs_cmdl_context
*ctx
)
4261 struct ofputil_flow_mod fm
;
4264 struct match nxm_match
;
4268 struct ofp10_match of10_raw
;
4269 struct match of10_match
;
4271 struct ofp11_match of11_raw
;
4272 struct match of11_match
;
4277 enum ofputil_protocol usable_protocols
; /* Unused for now. */
4279 match_init_catchall(&match
);
4280 match
.flow
.vlans
[0].tci
= htons(strtoul(ctx
->argv
[1], NULL
, 16));
4281 match
.wc
.masks
.vlans
[0].tci
= htons(strtoul(ctx
->argv
[2], NULL
, 16));
4283 /* Convert to and from string. */
4284 string_s
= match_to_string(&match
, NULL
, OFP_DEFAULT_PRIORITY
);
4285 printf("%s -> ", string_s
);
4287 error_s
= parse_ofp_str(&fm
, -1, string_s
, NULL
, &usable_protocols
);
4289 ovs_fatal(0, "%s", error_s
);
4291 printf("%04"PRIx16
"/%04"PRIx16
"\n",
4292 ntohs(fm
.match
.flow
.vlans
[0].tci
),
4293 ntohs(fm
.match
.wc
.masks
.vlans
[0].tci
));
4296 /* Convert to and from NXM. */
4297 ofpbuf_init(&nxm
, 0);
4298 nxm_match_len
= nx_put_match(&nxm
, &match
, htonll(0), htonll(0));
4299 nxm_s
= nx_match_to_string(nxm
.data
, nxm_match_len
);
4300 error
= nx_pull_match(&nxm
, nxm_match_len
, &nxm_match
, NULL
, NULL
, false,
4302 printf("NXM: %s -> ", nxm_s
);
4304 printf("%s\n", ofperr_to_string(error
));
4306 printf("%04"PRIx16
"/%04"PRIx16
"\n",
4307 ntohs(nxm_match
.flow
.vlans
[0].tci
),
4308 ntohs(nxm_match
.wc
.masks
.vlans
[0].tci
));
4311 ofpbuf_uninit(&nxm
);
4313 /* Convert to and from OXM. */
4314 ofpbuf_init(&nxm
, 0);
4315 nxm_match_len
= oxm_put_match(&nxm
, &match
, OFP12_VERSION
);
4316 nxm_s
= oxm_match_to_string(&nxm
, nxm_match_len
);
4317 error
= oxm_pull_match(&nxm
, false, NULL
, NULL
, &nxm_match
);
4318 printf("OXM: %s -> ", nxm_s
);
4320 printf("%s\n", ofperr_to_string(error
));
4322 uint16_t vid
= ntohs(nxm_match
.flow
.vlans
[0].tci
) &
4323 (VLAN_VID_MASK
| VLAN_CFI
);
4324 uint16_t mask
= ntohs(nxm_match
.wc
.masks
.vlans
[0].tci
) &
4325 (VLAN_VID_MASK
| VLAN_CFI
);
4327 printf("%04"PRIx16
"/%04"PRIx16
",", vid
, mask
);
4328 if (vid
&& vlan_tci_to_pcp(nxm_match
.wc
.masks
.vlans
[0].tci
)) {
4329 printf("%02d\n", vlan_tci_to_pcp(nxm_match
.flow
.vlans
[0].tci
));
4335 ofpbuf_uninit(&nxm
);
4337 /* Convert to and from OpenFlow 1.0. */
4338 ofputil_match_to_ofp10_match(&match
, &of10_raw
);
4339 ofputil_match_from_ofp10_match(&of10_raw
, &of10_match
);
4340 printf("OF1.0: %04"PRIx16
"/%d,%02"PRIx8
"/%d -> %04"PRIx16
"/%04"PRIx16
"\n",
4341 ntohs(of10_raw
.dl_vlan
),
4342 (of10_raw
.wildcards
& htonl(OFPFW10_DL_VLAN
)) != 0,
4343 of10_raw
.dl_vlan_pcp
,
4344 (of10_raw
.wildcards
& htonl(OFPFW10_DL_VLAN_PCP
)) != 0,
4345 ntohs(of10_match
.flow
.vlans
[0].tci
),
4346 ntohs(of10_match
.wc
.masks
.vlans
[0].tci
));
4348 /* Convert to and from OpenFlow 1.1. */
4349 ofputil_match_to_ofp11_match(&match
, &of11_raw
);
4350 ofputil_match_from_ofp11_match(&of11_raw
, &of11_match
);
4351 printf("OF1.1: %04"PRIx16
"/%d,%02"PRIx8
"/%d -> %04"PRIx16
"/%04"PRIx16
"\n",
4352 ntohs(of11_raw
.dl_vlan
),
4353 (of11_raw
.wildcards
& htonl(OFPFW11_DL_VLAN
)) != 0,
4354 of11_raw
.dl_vlan_pcp
,
4355 (of11_raw
.wildcards
& htonl(OFPFW11_DL_VLAN_PCP
)) != 0,
4356 ntohs(of11_match
.flow
.vlans
[0].tci
),
4357 ntohs(of11_match
.wc
.masks
.vlans
[0].tci
));
4360 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
4363 ofctl_print_error(struct ovs_cmdl_context
*ctx
)
4368 error
= ofperr_from_name(ctx
->argv
[1]);
4370 ovs_fatal(0, "unknown error \"%s\"", ctx
->argv
[1]);
4373 for (version
= 0; version
<= UINT8_MAX
; version
++) {
4374 const char *name
= ofperr_domain_get_name(version
);
4376 int vendor
= ofperr_get_vendor(error
, version
);
4377 int type
= ofperr_get_type(error
, version
);
4378 int code
= ofperr_get_code(error
, version
);
4380 if (vendor
!= -1 || type
!= -1 || code
!= -1) {
4381 printf("%s: vendor %#x, type %d, code %d\n",
4382 name
, vendor
, type
, code
);
4388 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
4389 * error named ENUM and prints the error reply in hex. */
4391 ofctl_encode_error_reply(struct ovs_cmdl_context
*ctx
)
4393 const struct ofp_header
*oh
;
4394 struct ofpbuf request
, *reply
;
4397 error
= ofperr_from_name(ctx
->argv
[1]);
4399 ovs_fatal(0, "unknown error \"%s\"", ctx
->argv
[1]);
4402 ofpbuf_init(&request
, 0);
4403 if (ofpbuf_put_hex(&request
, ctx
->argv
[2], NULL
)[0] != '\0') {
4404 ovs_fatal(0, "Trailing garbage in hex data");
4406 if (request
.size
< sizeof(struct ofp_header
)) {
4407 ovs_fatal(0, "Request too short");
4411 if (request
.size
!= ntohs(oh
->length
)) {
4412 ovs_fatal(0, "Request size inconsistent");
4415 reply
= ofperr_encode_reply(error
, request
.data
);
4416 ofpbuf_uninit(&request
);
4418 ovs_hex_dump(stdout
, reply
->data
, reply
->size
, 0, false);
4419 ofpbuf_delete(reply
);
4422 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
4423 * binary data, interpreting them as an OpenFlow message, and prints the
4424 * OpenFlow message on stdout, at VERBOSITY (level 2 by default).
4426 * Alternative usage: "ofp-print [VERBOSITY] - < HEXSTRING_FILE", where
4427 * HEXSTRING_FILE contains the HEXSTRING. */
4429 ofctl_ofp_print(struct ovs_cmdl_context
*ctx
)
4431 struct ofpbuf packet
;
4438 if (!strcmp(ctx
->argv
[ctx
->argc
-1], "-")) {
4439 if (ds_get_line(&line
, stdin
)) {
4440 VLOG_FATAL("Failed to read stdin");
4443 buffer
= line
.string
;
4444 verbosity
= ctx
->argc
> 2 ? atoi(ctx
->argv
[1]) : verbosity
;
4445 } else if (ctx
->argc
> 2) {
4446 buffer
= ctx
->argv
[1];
4447 verbosity
= atoi(ctx
->argv
[2]);
4449 buffer
= ctx
->argv
[1];
4452 ofpbuf_init(&packet
, strlen(buffer
) / 2);
4453 if (ofpbuf_put_hex(&packet
, buffer
, NULL
)[0] != '\0') {
4454 ovs_fatal(0, "trailing garbage following hex bytes");
4456 ofp_print(stdout
, packet
.data
, packet
.size
, NULL
, verbosity
);
4457 ofpbuf_uninit(&packet
);
4461 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
4462 * and dumps each message in hex. */
4464 ofctl_encode_hello(struct ovs_cmdl_context
*ctx
)
4466 uint32_t bitmap
= strtol(ctx
->argv
[1], NULL
, 0);
4467 struct ofpbuf
*hello
;
4469 hello
= ofputil_encode_hello(bitmap
);
4470 ovs_hex_dump(stdout
, hello
->data
, hello
->size
, 0, false);
4471 ofp_print(stdout
, hello
->data
, hello
->size
, NULL
, verbosity
);
4472 ofpbuf_delete(hello
);
4476 ofctl_parse_key_value(struct ovs_cmdl_context
*ctx
)
4478 for (size_t i
= 1; i
< ctx
->argc
; i
++) {
4479 char *s
= ctx
->argv
[i
];
4482 while (ofputil_parse_key_value(&s
, &key
, &value
)) {
4484 fputs(", ", stdout
);
4488 printf("=%s", value
);
4495 static const struct ovs_cmdl_command all_commands
[] = {
4497 1, 1, ofctl_show
, OVS_RO
},
4498 { "monitor", "switch [misslen] [invalid_ttl] [watch:[...]]",
4499 1, 3, ofctl_monitor
, OVS_RO
},
4500 { "snoop", "switch",
4501 1, 1, ofctl_snoop
, OVS_RO
},
4502 { "dump-desc", "switch",
4503 1, 1, ofctl_dump_desc
, OVS_RO
},
4504 { "dump-tables", "switch",
4505 1, 1, ofctl_dump_tables
, OVS_RO
},
4506 { "dump-table-features", "switch",
4507 1, 1, ofctl_dump_table_features
, OVS_RO
},
4508 { "dump-table-desc", "switch",
4509 1, 1, ofctl_dump_table_desc
, OVS_RO
},
4510 { "dump-flows", "switch",
4511 1, 2, ofctl_dump_flows
, OVS_RO
},
4512 { "dump-aggregate", "switch",
4513 1, 2, ofctl_dump_aggregate
, OVS_RO
},
4514 { "queue-stats", "switch [port [queue]]",
4515 1, 3, ofctl_queue_stats
, OVS_RO
},
4516 { "queue-get-config", "switch [port [queue]]",
4517 1, 3, ofctl_queue_get_config
, OVS_RO
},
4518 { "add-flow", "switch flow",
4519 2, 2, ofctl_add_flow
, OVS_RW
},
4520 { "add-flows", "switch file",
4521 2, 2, ofctl_add_flows
, OVS_RW
},
4522 { "mod-flows", "switch flow",
4523 2, 2, ofctl_mod_flows
, OVS_RW
},
4524 { "del-flows", "switch [flow]",
4525 1, 2, ofctl_del_flows
, OVS_RW
},
4526 { "replace-flows", "switch file",
4527 2, 2, ofctl_replace_flows
, OVS_RW
},
4528 { "diff-flows", "source1 source2",
4529 2, 2, ofctl_diff_flows
, OVS_RW
},
4530 { "add-meter", "switch meter",
4531 2, 2, ofctl_add_meter
, OVS_RW
},
4532 { "mod-meter", "switch meter",
4533 2, 2, ofctl_mod_meter
, OVS_RW
},
4534 { "del-meter", "switch meter",
4535 2, 2, ofctl_del_meters
, OVS_RW
},
4536 { "del-meters", "switch",
4537 1, 1, ofctl_del_meters
, OVS_RW
},
4538 { "dump-meter", "switch meter",
4539 2, 2, ofctl_dump_meters
, OVS_RO
},
4540 { "dump-meters", "switch",
4541 1, 1, ofctl_dump_meters
, OVS_RO
},
4542 { "meter-stats", "switch [meter]",
4543 1, 2, ofctl_meter_stats
, OVS_RO
},
4544 { "meter-features", "switch",
4545 1, 1, ofctl_meter_features
, OVS_RO
},
4546 { "packet-out", "switch \"in_port=<port> packet=<hex data> actions=...\"",
4547 2, INT_MAX
, ofctl_packet_out
, OVS_RW
},
4548 { "dump-ports", "switch [port]",
4549 1, 2, ofctl_dump_ports
, OVS_RO
},
4550 { "dump-ports-desc", "switch [port]",
4551 1, 2, ofctl_dump_ports_desc
, OVS_RO
},
4552 { "mod-port", "switch iface act",
4553 3, 3, ofctl_mod_port
, OVS_RW
},
4554 { "mod-table", "switch mod",
4555 3, 3, ofctl_mod_table
, OVS_RW
},
4556 { "get-frags", "switch",
4557 1, 1, ofctl_get_frags
, OVS_RO
},
4558 { "set-frags", "switch frag_mode",
4559 2, 2, ofctl_set_frags
, OVS_RW
},
4560 { "probe", "target",
4561 1, 1, ofctl_probe
, OVS_RO
},
4562 { "ping", "target [n]",
4563 1, 2, ofctl_ping
, OVS_RO
},
4564 { "benchmark", "target n count",
4565 3, 3, ofctl_benchmark
, OVS_RO
},
4567 { "dump-ipfix-bridge", "switch",
4568 1, 1, ofctl_dump_ipfix_bridge
, OVS_RO
},
4569 { "dump-ipfix-flow", "switch",
4570 1, 1, ofctl_dump_ipfix_flow
, OVS_RO
},
4572 { "ct-flush-zone", "switch zone",
4573 2, 2, ofctl_ct_flush_zone
, OVS_RO
},
4575 { "ofp-parse", "file",
4576 1, 1, ofctl_ofp_parse
, OVS_RW
},
4577 { "ofp-parse-pcap", "pcap",
4578 1, INT_MAX
, ofctl_ofp_parse_pcap
, OVS_RW
},
4580 { "add-group", "switch group",
4581 1, 2, ofctl_add_group
, OVS_RW
},
4582 { "add-groups", "switch file",
4583 1, 2, ofctl_add_groups
, OVS_RW
},
4584 { "mod-group", "switch group",
4585 1, 2, ofctl_mod_group
, OVS_RW
},
4586 { "del-groups", "switch [group]",
4587 1, 2, ofctl_del_groups
, OVS_RW
},
4588 { "insert-buckets", "switch [group]",
4589 1, 2, ofctl_insert_bucket
, OVS_RW
},
4590 { "remove-buckets", "switch [group]",
4591 1, 2, ofctl_remove_bucket
, OVS_RW
},
4592 { "dump-groups", "switch [group]",
4593 1, 2, ofctl_dump_group_desc
, OVS_RO
},
4594 { "dump-group-stats", "switch [group]",
4595 1, 2, ofctl_dump_group_stats
, OVS_RO
},
4596 { "dump-group-features", "switch",
4597 1, 1, ofctl_dump_group_features
, OVS_RO
},
4599 { "bundle", "switch file",
4600 2, 2, ofctl_bundle
, OVS_RW
},
4602 { "add-tlv-map", "switch map",
4603 2, 2, ofctl_add_tlv_map
, OVS_RO
},
4604 { "del-tlv-map", "switch [map]",
4605 1, 2, ofctl_del_tlv_map
, OVS_RO
},
4606 { "dump-tlv-map", "switch",
4607 1, 1, ofctl_dump_tlv_map
, OVS_RO
},
4608 { "help", NULL
, 0, INT_MAX
, ofctl_help
, OVS_RO
},
4609 { "list-commands", NULL
, 0, INT_MAX
, ofctl_list_commands
, OVS_RO
},
4611 /* Undocumented commands for testing. */
4612 { "parse-flow", NULL
, 1, 1, ofctl_parse_flow
, OVS_RW
},
4613 { "parse-flows", NULL
, 1, 1, ofctl_parse_flows
, OVS_RW
},
4614 { "parse-nx-match", NULL
, 0, 0, ofctl_parse_nxm
, OVS_RW
},
4615 { "parse-nxm", NULL
, 0, 0, ofctl_parse_nxm
, OVS_RW
},
4616 { "parse-oxm", NULL
, 1, 1, ofctl_parse_oxm
, OVS_RW
},
4617 { "parse-actions", NULL
, 1, 1, ofctl_parse_actions
, OVS_RW
},
4618 { "parse-instructions", NULL
, 1, 1, ofctl_parse_instructions
, OVS_RW
},
4619 { "parse-ofp10-match", NULL
, 0, 0, ofctl_parse_ofp10_match
, OVS_RW
},
4620 { "parse-ofp11-match", NULL
, 0, 0, ofctl_parse_ofp11_match
, OVS_RW
},
4621 { "parse-pcap", NULL
, 1, INT_MAX
, ofctl_parse_pcap
, OVS_RW
},
4622 { "check-vlan", NULL
, 2, 2, ofctl_check_vlan
, OVS_RW
},
4623 { "print-error", NULL
, 1, 1, ofctl_print_error
, OVS_RW
},
4624 { "encode-error-reply", NULL
, 2, 2, ofctl_encode_error_reply
, OVS_RW
},
4625 { "ofp-print", NULL
, 1, 2, ofctl_ofp_print
, OVS_RW
},
4626 { "encode-hello", NULL
, 1, 1, ofctl_encode_hello
, OVS_RW
},
4627 { "parse-key-value", NULL
, 1, INT_MAX
, ofctl_parse_key_value
, OVS_RW
},
4629 { NULL
, NULL
, 0, 0, NULL
, OVS_RO
},
4632 static const struct ovs_cmdl_command
*get_all_commands(void)
4634 return all_commands
;