2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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.
18 #include "ofp-print.h"
22 #include <sys/types.h>
23 #include <netinet/in.h>
30 #include "byte-order.h"
32 #include "dynamic-string.h"
35 #include "multipath.h"
36 #include "meta-flow.h"
39 #include "ofp-actions.h"
40 #include "ofp-errors.h"
44 #include "openflow/openflow.h"
45 #include "openflow/nicira-ext.h"
47 #include "type-props.h"
48 #include "unaligned.h"
52 static void ofp_print_queue_name(struct ds *string, uint32_t port);
53 static void ofp_print_error(struct ds *, enum ofperr);
54 static void ofp_print_table_features(struct ds *,
55 const struct ofputil_table_features *,
56 const struct ofputil_table_stats *);
58 /* Returns a string that represents the contents of the Ethernet frame in the
59 * 'len' bytes starting at 'data'. The caller must free the returned string.*/
61 ofp_packet_to_string(const void *data, size_t len)
63 struct ds ds = DS_EMPTY_INITIALIZER;
64 const struct pkt_metadata md = PKT_METADATA_INITIALIZER(0);
69 ofpbuf_use_const(&buf, data, len);
70 flow_extract(&buf, &md, &flow);
71 flow_format(&ds, &flow);
73 l4_size = ofpbuf_l4_size(&buf);
75 if (flow.nw_proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
76 struct tcp_header *th = ofpbuf_l4(&buf);
77 ds_put_format(&ds, " tcp_csum:%"PRIx16, ntohs(th->tcp_csum));
78 } else if (flow.nw_proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN) {
79 struct udp_header *uh = ofpbuf_l4(&buf);
80 ds_put_format(&ds, " udp_csum:%"PRIx16, ntohs(uh->udp_csum));
81 } else if (flow.nw_proto == IPPROTO_SCTP && l4_size >= SCTP_HEADER_LEN) {
82 struct sctp_header *sh = ofpbuf_l4(&buf);
83 ds_put_format(&ds, " sctp_csum:%"PRIx32,
84 ntohl(get_16aligned_be32(&sh->sctp_csum)));
85 } else if (flow.nw_proto == IPPROTO_ICMP && l4_size >= ICMP_HEADER_LEN) {
86 struct icmp_header *icmph = ofpbuf_l4(&buf);
87 ds_put_format(&ds, " icmp_csum:%"PRIx16,
88 ntohs(icmph->icmp_csum));
89 } else if (flow.nw_proto == IPPROTO_ICMPV6 && l4_size >= ICMP6_HEADER_LEN) {
90 struct icmp6_header *icmp6h = ofpbuf_l4(&buf);
91 ds_put_format(&ds, " icmp6_csum:%"PRIx16,
92 ntohs(icmp6h->icmp6_cksum));
95 ds_put_char(&ds, '\n');
101 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
104 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
105 struct ofputil_packet_in pin;
109 error = ofputil_decode_packet_in(&pin, oh);
111 ofp_print_error(string, error);
116 ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
119 if (pin.cookie != OVS_BE64_MAX) {
120 ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
123 ds_put_format(string, " total_len=%"PRIuSIZE" in_port=", pin.total_len);
124 ofputil_format_port(pin.fmd.in_port, string);
126 if (pin.fmd.tun_id != htonll(0)) {
127 ds_put_format(string, " tun_id=0x%"PRIx64, ntohll(pin.fmd.tun_id));
130 if (pin.fmd.tun_src != htonl(0)) {
131 ds_put_format(string, " tun_src="IP_FMT, IP_ARGS(pin.fmd.tun_src));
134 if (pin.fmd.tun_dst != htonl(0)) {
135 ds_put_format(string, " tun_dst="IP_FMT, IP_ARGS(pin.fmd.tun_dst));
138 if (pin.fmd.metadata != htonll(0)) {
139 ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
142 for (i = 0; i < FLOW_N_REGS; i++) {
143 if (pin.fmd.regs[i]) {
144 ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
148 if (pin.fmd.pkt_mark != 0) {
149 ds_put_format(string, " pkt_mark=0x%"PRIx32, pin.fmd.pkt_mark);
152 ds_put_format(string, " (via %s)",
153 ofputil_packet_in_reason_to_string(pin.reason, reasonbuf,
156 ds_put_format(string, " data_len=%"PRIuSIZE, pin.packet_len);
157 if (pin.buffer_id == UINT32_MAX) {
158 ds_put_format(string, " (unbuffered)");
159 if (pin.total_len != pin.packet_len) {
160 ds_put_format(string, " (***total_len != data_len***)");
163 ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
164 if (pin.total_len < pin.packet_len) {
165 ds_put_format(string, " (***total_len < data_len***)");
168 ds_put_char(string, '\n');
171 char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
172 ds_put_cstr(string, packet);
176 ds_put_hex_dump(string, pin.packet, pin.packet_len, 0, false);
181 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
184 struct ofputil_packet_out po;
185 struct ofpbuf ofpacts;
188 ofpbuf_init(&ofpacts, 64);
189 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
191 ofpbuf_uninit(&ofpacts);
192 ofp_print_error(string, error);
196 ds_put_cstr(string, " in_port=");
197 ofputil_format_port(po.in_port, string);
199 ds_put_cstr(string, " actions=");
200 ofpacts_format(po.ofpacts, po.ofpacts_len, string);
202 if (po.buffer_id == UINT32_MAX) {
203 ds_put_format(string, " data_len=%"PRIuSIZE, po.packet_len);
204 if (verbosity > 0 && po.packet_len > 0) {
205 char *packet = ofp_packet_to_string(po.packet, po.packet_len);
206 ds_put_char(string, '\n');
207 ds_put_cstr(string, packet);
211 ds_put_hex_dump(string, po.packet, po.packet_len, 0, false);
214 ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
217 ofpbuf_uninit(&ofpacts);
220 /* qsort comparison function. */
222 compare_ports(const void *a_, const void *b_)
224 const struct ofputil_phy_port *a = a_;
225 const struct ofputil_phy_port *b = b_;
226 uint16_t ap = ofp_to_u16(a->port_no);
227 uint16_t bp = ofp_to_u16(b->port_no);
229 return ap < bp ? -1 : ap > bp;
233 ofp_print_bit_names(struct ds *string, uint32_t bits,
234 const char *(*bit_to_name)(uint32_t bit),
241 ds_put_cstr(string, "0");
245 for (i = 0; i < 32; i++) {
246 uint32_t bit = UINT32_C(1) << i;
249 const char *name = bit_to_name(bit);
252 ds_put_char(string, separator);
254 ds_put_cstr(string, name);
262 ds_put_char(string, separator);
264 ds_put_format(string, "0x%"PRIx32, bits);
269 netdev_feature_to_name(uint32_t bit)
271 enum netdev_features f = bit;
274 case NETDEV_F_10MB_HD: return "10MB-HD";
275 case NETDEV_F_10MB_FD: return "10MB-FD";
276 case NETDEV_F_100MB_HD: return "100MB-HD";
277 case NETDEV_F_100MB_FD: return "100MB-FD";
278 case NETDEV_F_1GB_HD: return "1GB-HD";
279 case NETDEV_F_1GB_FD: return "1GB-FD";
280 case NETDEV_F_10GB_FD: return "10GB-FD";
281 case NETDEV_F_40GB_FD: return "40GB-FD";
282 case NETDEV_F_100GB_FD: return "100GB-FD";
283 case NETDEV_F_1TB_FD: return "1TB-FD";
284 case NETDEV_F_OTHER: return "OTHER";
285 case NETDEV_F_COPPER: return "COPPER";
286 case NETDEV_F_FIBER: return "FIBER";
287 case NETDEV_F_AUTONEG: return "AUTO_NEG";
288 case NETDEV_F_PAUSE: return "AUTO_PAUSE";
289 case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
296 ofp_print_port_features(struct ds *string, enum netdev_features features)
298 ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
299 ds_put_char(string, '\n');
303 ofputil_port_config_to_name(uint32_t bit)
305 enum ofputil_port_config pc = bit;
308 case OFPUTIL_PC_PORT_DOWN: return "PORT_DOWN";
309 case OFPUTIL_PC_NO_STP: return "NO_STP";
310 case OFPUTIL_PC_NO_RECV: return "NO_RECV";
311 case OFPUTIL_PC_NO_RECV_STP: return "NO_RECV_STP";
312 case OFPUTIL_PC_NO_FLOOD: return "NO_FLOOD";
313 case OFPUTIL_PC_NO_FWD: return "NO_FWD";
314 case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
321 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
323 ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
324 ds_put_char(string, '\n');
328 ofputil_port_state_to_name(uint32_t bit)
330 enum ofputil_port_state ps = bit;
333 case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
334 case OFPUTIL_PS_BLOCKED: return "BLOCKED";
335 case OFPUTIL_PS_LIVE: return "LIVE";
337 case OFPUTIL_PS_STP_LISTEN:
338 case OFPUTIL_PS_STP_LEARN:
339 case OFPUTIL_PS_STP_FORWARD:
340 case OFPUTIL_PS_STP_BLOCK:
341 /* Handled elsewhere. */
349 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
351 enum ofputil_port_state stp_state;
353 /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
354 * pattern. We have to special case it.
356 * OVS doesn't support STP, so this field will always be 0 if we are
357 * talking to OVS, so we'd always print STP_LISTEN in that case.
358 * Therefore, we don't print anything at all if the value is STP_LISTEN, to
359 * avoid confusing users. */
360 stp_state = state & OFPUTIL_PS_STP_MASK;
363 (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
364 : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
366 state &= ~OFPUTIL_PS_STP_MASK;
368 ofp_print_bit_names(string, state, ofputil_port_state_to_name,
372 ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
374 ds_put_char(string, '\n');
378 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
380 char name[sizeof port->name];
383 memcpy(name, port->name, sizeof name);
384 for (j = 0; j < sizeof name - 1; j++) {
385 if (!isprint((unsigned char) name[j])) {
391 ds_put_char(string, ' ');
392 ofputil_format_port(port->port_no, string);
393 ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
394 name, ETH_ADDR_ARGS(port->hw_addr));
396 ds_put_cstr(string, " config: ");
397 ofp_print_port_config(string, port->config);
399 ds_put_cstr(string, " state: ");
400 ofp_print_port_state(string, port->state);
403 ds_put_format(string, " current: ");
404 ofp_print_port_features(string, port->curr);
406 if (port->advertised) {
407 ds_put_format(string, " advertised: ");
408 ofp_print_port_features(string, port->advertised);
410 if (port->supported) {
411 ds_put_format(string, " supported: ");
412 ofp_print_port_features(string, port->supported);
415 ds_put_format(string, " peer: ");
416 ofp_print_port_features(string, port->peer);
418 ds_put_format(string, " speed: %"PRIu32" Mbps now, "
419 "%"PRIu32" Mbps max\n",
420 port->curr_speed / UINT32_C(1000),
421 port->max_speed / UINT32_C(1000));
424 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
425 * 'ofp_version', writes a detailed description of each port into
428 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
431 struct ofputil_phy_port *ports;
432 size_t allocated_ports, n_ports;
438 for (n_ports = 0; ; n_ports++) {
439 if (n_ports >= allocated_ports) {
440 ports = x2nrealloc(ports, &allocated_ports, sizeof *ports);
443 retval = ofputil_pull_phy_port(ofp_version, b, &ports[n_ports]);
449 qsort(ports, n_ports, sizeof *ports, compare_ports);
450 for (i = 0; i < n_ports; i++) {
451 ofp_print_phy_port(string, &ports[i]);
456 ofp_print_error(string, retval);
461 ofputil_capabilities_to_name(uint32_t bit)
463 enum ofputil_capabilities capabilities = bit;
465 switch (capabilities) {
466 case OFPUTIL_C_FLOW_STATS: return "FLOW_STATS";
467 case OFPUTIL_C_TABLE_STATS: return "TABLE_STATS";
468 case OFPUTIL_C_PORT_STATS: return "PORT_STATS";
469 case OFPUTIL_C_IP_REASM: return "IP_REASM";
470 case OFPUTIL_C_QUEUE_STATS: return "QUEUE_STATS";
471 case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
472 case OFPUTIL_C_STP: return "STP";
473 case OFPUTIL_C_GROUP_STATS: return "GROUP_STATS";
474 case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
481 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
483 struct ofputil_switch_features features;
487 error = ofputil_decode_switch_features(oh, &features, &b);
489 ofp_print_error(string, error);
493 ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
495 ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32,
496 features.n_tables, features.n_buffers);
497 if (features.auxiliary_id) {
498 ds_put_format(string, ", auxiliary_id:%"PRIu8, features.auxiliary_id);
500 ds_put_char(string, '\n');
502 ds_put_cstr(string, "capabilities: ");
503 ofp_print_bit_names(string, features.capabilities,
504 ofputil_capabilities_to_name, ' ');
505 ds_put_char(string, '\n');
507 switch ((enum ofp_version)oh->version) {
509 ds_put_cstr(string, "actions: ");
510 ofpact_bitmap_format(features.ofpacts, string);
511 ds_put_char(string, '\n');
519 return; /* no ports in ofp13_switch_features */
524 ofp_print_phy_ports(string, oh->version, &b);
528 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
530 enum ofp_config_flags flags;
532 flags = ntohs(osc->flags);
534 ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
535 flags &= ~OFPC_FRAG_MASK;
537 if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
538 ds_put_format(string, " invalid_ttl_to_controller");
539 flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
543 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
546 ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
549 static void print_wild(struct ds *string, const char *leader, int is_wild,
550 int verbosity, const char *format, ...)
551 OVS_PRINTF_FORMAT(5, 6);
553 static void print_wild(struct ds *string, const char *leader, int is_wild,
554 int verbosity, const char *format, ...)
556 if (is_wild && verbosity < 2) {
559 ds_put_cstr(string, leader);
563 va_start(args, format);
564 ds_put_format_valist(string, format, args);
567 ds_put_char(string, '*');
569 ds_put_char(string, ',');
573 print_wild_port(struct ds *string, const char *leader, int is_wild,
574 int verbosity, ofp_port_t port)
576 if (is_wild && verbosity < 2) {
579 ds_put_cstr(string, leader);
581 ofputil_format_port(port, string);
583 ds_put_char(string, '*');
585 ds_put_char(string, ',');
589 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
590 uint32_t wild_bits, int verbosity)
592 if (wild_bits >= 32 && verbosity < 2) {
595 ds_put_cstr(string, leader);
596 if (wild_bits < 32) {
597 ds_put_format(string, IP_FMT, IP_ARGS(ip));
599 ds_put_format(string, "/%d", 32 - wild_bits);
602 ds_put_char(string, '*');
604 ds_put_char(string, ',');
608 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
610 char *s = ofp10_match_to_string(om, verbosity);
616 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
618 struct ds f = DS_EMPTY_INITIALIZER;
619 uint32_t w = ntohl(om->wildcards);
620 bool skip_type = false;
621 bool skip_proto = false;
623 if (!(w & OFPFW10_DL_TYPE)) {
625 if (om->dl_type == htons(ETH_TYPE_IP)) {
626 if (!(w & OFPFW10_NW_PROTO)) {
628 if (om->nw_proto == IPPROTO_ICMP) {
629 ds_put_cstr(&f, "icmp,");
630 } else if (om->nw_proto == IPPROTO_TCP) {
631 ds_put_cstr(&f, "tcp,");
632 } else if (om->nw_proto == IPPROTO_UDP) {
633 ds_put_cstr(&f, "udp,");
634 } else if (om->nw_proto == IPPROTO_SCTP) {
635 ds_put_cstr(&f, "sctp,");
637 ds_put_cstr(&f, "ip,");
641 ds_put_cstr(&f, "ip,");
643 } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
644 ds_put_cstr(&f, "arp,");
645 } else if (om->dl_type == htons(ETH_TYPE_RARP)){
646 ds_put_cstr(&f, "rarp,");
647 } else if (om->dl_type == htons(ETH_TYPE_MPLS)) {
648 ds_put_cstr(&f, "mpls,");
649 } else if (om->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
650 ds_put_cstr(&f, "mplsm,");
655 print_wild_port(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
656 u16_to_ofp(ntohs(om->in_port)));
657 print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
658 "%d", ntohs(om->dl_vlan));
659 print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
660 "%d", om->dl_vlan_pcp);
661 print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
662 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
663 print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
664 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
666 print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
667 "0x%04x", ntohs(om->dl_type));
669 print_ip_netmask(&f, "nw_src=", om->nw_src,
670 (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
672 print_ip_netmask(&f, "nw_dst=", om->nw_dst,
673 (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
676 if (om->dl_type == htons(ETH_TYPE_ARP) ||
677 om->dl_type == htons(ETH_TYPE_RARP)) {
678 print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
681 print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
685 print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
687 if (om->nw_proto == IPPROTO_ICMP) {
688 print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
689 "%d", ntohs(om->tp_src));
690 print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
691 "%d", ntohs(om->tp_dst));
693 print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
694 "%d", ntohs(om->tp_src));
695 print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
696 "%d", ntohs(om->tp_dst));
703 ofp_print_flow_flags(struct ds *s, enum ofputil_flow_mod_flags flags)
705 if (flags & OFPUTIL_FF_SEND_FLOW_REM) {
706 ds_put_cstr(s, "send_flow_rem ");
708 if (flags & OFPUTIL_FF_CHECK_OVERLAP) {
709 ds_put_cstr(s, "check_overlap ");
711 if (flags & OFPUTIL_FF_RESET_COUNTS) {
712 ds_put_cstr(s, "reset_counts ");
714 if (flags & OFPUTIL_FF_NO_PKT_COUNTS) {
715 ds_put_cstr(s, "no_packet_counts ");
717 if (flags & OFPUTIL_FF_NO_BYT_COUNTS) {
718 ds_put_cstr(s, "no_byte_counts ");
720 if (flags & OFPUTIL_FF_HIDDEN_FIELDS) {
721 ds_put_cstr(s, "allow_hidden_fields ");
723 if (flags & OFPUTIL_FF_NO_READONLY) {
724 ds_put_cstr(s, "no_readonly_table ");
729 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
731 struct ofputil_flow_mod fm;
732 struct ofpbuf ofpacts;
736 enum ofputil_protocol protocol;
738 protocol = ofputil_protocol_from_ofp_version(oh->version);
739 protocol = ofputil_protocol_set_tid(protocol, true);
741 ofpbuf_init(&ofpacts, 64);
742 error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts,
745 ofpbuf_uninit(&ofpacts);
746 ofp_print_error(s, error);
751 switch (fm.command) {
753 ds_put_cstr(s, "ADD");
756 ds_put_cstr(s, "MOD");
758 case OFPFC_MODIFY_STRICT:
759 ds_put_cstr(s, "MOD_STRICT");
762 ds_put_cstr(s, "DEL");
764 case OFPFC_DELETE_STRICT:
765 ds_put_cstr(s, "DEL_STRICT");
768 ds_put_format(s, "cmd:%d", fm.command);
770 if (fm.table_id != 0) {
771 ds_put_format(s, " table:%d", fm.table_id);
775 ofpraw_decode(&raw, oh);
776 if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
777 const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
778 ofp10_match_print(s, &ofm->match, verbosity);
780 /* ofp_print_match() doesn't print priority. */
781 need_priority = true;
782 } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
783 const struct nx_flow_mod *nfm = ofpmsg_body(oh);
784 const void *nxm = nfm + 1;
787 nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
788 ds_put_cstr(s, nxm_s);
791 /* nx_match_to_string() doesn't print priority. */
792 need_priority = true;
794 match_format(&fm.match, s, fm.priority);
796 /* match_format() does print priority. */
797 need_priority = false;
800 if (ds_last(s) != ' ') {
803 if (fm.new_cookie != htonll(0) && fm.new_cookie != OVS_BE64_MAX) {
804 ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
806 if (fm.cookie_mask != htonll(0)) {
807 ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
808 ntohll(fm.cookie), ntohll(fm.cookie_mask));
810 if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
811 ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
813 if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
814 ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
816 if (fm.importance != 0) {
817 ds_put_format(s, "importance:%"PRIu16" ", fm.importance);
819 if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
820 ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
822 if (fm.buffer_id != UINT32_MAX) {
823 ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
825 if (fm.out_port != OFPP_ANY) {
826 ds_put_format(s, "out_port:");
827 ofputil_format_port(fm.out_port, s);
831 if (oh->version == OFP10_VERSION || oh->version == OFP11_VERSION) {
832 /* Don't print the reset_counts flag for OF1.0 and OF1.1 because those
833 * versions don't really have such a flag and printing one is likely to
835 fm.flags &= ~OFPUTIL_FF_RESET_COUNTS;
837 ofp_print_flow_flags(s, fm.flags);
839 ds_put_cstr(s, "actions=");
840 ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
841 ofpbuf_uninit(&ofpacts);
845 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
847 ds_put_format(string, "%u", sec);
849 /* If there are no fractional seconds, don't print any decimals.
851 * If the fractional seconds can be expressed exactly as milliseconds,
852 * print 3 decimals. Open vSwitch provides millisecond precision for most
853 * time measurements, so printing 3 decimals every time makes it easier to
854 * spot real changes in flow dumps that refresh themselves quickly.
856 * If the fractional seconds are more precise than milliseconds, print the
857 * number of decimals needed to express them exactly.
860 unsigned int msec = nsec / 1000000;
861 if (msec * 1000000 == nsec) {
862 ds_put_format(string, ".%03u", msec);
864 ds_put_format(string, ".%09u", nsec);
865 while (string->string[string->length - 1] == '0') {
870 ds_put_char(string, 's');
873 /* Returns a string form of 'reason'. The return value is either a statically
874 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
875 * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
876 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
878 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason,
879 char *reasonbuf, size_t bufsize)
882 case OFPRR_IDLE_TIMEOUT:
884 case OFPRR_HARD_TIMEOUT:
888 case OFPRR_GROUP_DELETE:
889 return "group_delete";
892 case OFPRR_METER_DELETE:
893 return "meter_delete";
895 snprintf(reasonbuf, bufsize, "%d", (int) reason);
901 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
903 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
904 struct ofputil_flow_removed fr;
907 error = ofputil_decode_flow_removed(&fr, oh);
909 ofp_print_error(string, error);
913 ds_put_char(string, ' ');
914 match_format(&fr.match, string, fr.priority);
916 ds_put_format(string, " reason=%s",
917 ofp_flow_removed_reason_to_string(fr.reason, reasonbuf,
920 if (fr.table_id != 255) {
921 ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
924 if (fr.cookie != htonll(0)) {
925 ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
927 ds_put_cstr(string, " duration");
928 ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
929 ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
930 if (fr.hard_timeout) {
931 /* The hard timeout was only added in OF1.2, so only print it if it is
932 * actually in use to avoid gratuitous change to the formatting. */
933 ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
935 ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
936 fr.packet_count, fr.byte_count);
940 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
942 struct ofputil_port_mod pm;
945 error = ofputil_decode_port_mod(oh, &pm, true);
947 ofp_print_error(string, error);
951 ds_put_cstr(string, "port: ");
952 ofputil_format_port(pm.port_no, string);
953 ds_put_format(string, ": addr:"ETH_ADDR_FMT"\n",
954 ETH_ADDR_ARGS(pm.hw_addr));
956 ds_put_cstr(string, " config: ");
957 ofp_print_port_config(string, pm.config);
959 ds_put_cstr(string, " mask: ");
960 ofp_print_port_config(string, pm.mask);
962 ds_put_cstr(string, " advertise: ");
964 ofp_print_port_features(string, pm.advertise);
966 ds_put_cstr(string, "UNCHANGED\n");
971 ofp_print_table_miss_config(struct ds *string, enum ofputil_table_miss miss)
974 case OFPUTIL_TABLE_MISS_CONTROLLER:
975 ds_put_cstr(string, "controller\n");
977 case OFPUTIL_TABLE_MISS_CONTINUE:
978 ds_put_cstr(string, "continue\n");
980 case OFPUTIL_TABLE_MISS_DROP:
981 ds_put_cstr(string, "drop\n");
983 case OFPUTIL_TABLE_MISS_DEFAULT:
985 ds_put_format(string, "Unknown (%d)\n", miss);
991 ofp_print_table_mod(struct ds *string, const struct ofp_header *oh)
993 struct ofputil_table_mod pm;
996 error = ofputil_decode_table_mod(oh, &pm);
998 ofp_print_error(string, error);
1002 if (pm.table_id == 0xff) {
1003 ds_put_cstr(string, " table_id: ALL_TABLES");
1005 ds_put_format(string, " table_id=%"PRIu8, pm.table_id);
1008 if (pm.miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
1009 ds_put_cstr(string, ", flow_miss_config=");
1010 ofp_print_table_miss_config(string, pm.miss_config);
1015 ofp_print_queue_get_config_request(struct ds *string,
1016 const struct ofp_header *oh)
1021 error = ofputil_decode_queue_get_config_request(oh, &port);
1023 ofp_print_error(string, error);
1027 ds_put_cstr(string, " port=");
1028 ofputil_format_port(port, string);
1032 print_queue_rate(struct ds *string, const char *name, unsigned int rate)
1035 ds_put_format(string, " %s:%u.%u%%", name, rate / 10, rate % 10);
1036 } else if (rate < UINT16_MAX) {
1037 ds_put_format(string, " %s:(disabled)", name);
1042 ofp_print_queue_get_config_reply(struct ds *string,
1043 const struct ofp_header *oh)
1049 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1050 error = ofputil_decode_queue_get_config_reply(&b, &port);
1052 ofp_print_error(string, error);
1056 ds_put_cstr(string, " port=");
1057 ofputil_format_port(port, string);
1058 ds_put_char(string, '\n');
1061 struct ofputil_queue_config queue;
1064 retval = ofputil_pull_queue_get_config_reply(&b, &queue);
1066 if (retval != EOF) {
1067 ofp_print_error(string, retval);
1072 ds_put_format(string, "queue %"PRIu32":", queue.queue_id);
1073 print_queue_rate(string, "min_rate", queue.min_rate);
1074 print_queue_rate(string, "max_rate", queue.max_rate);
1075 ds_put_char(string, '\n');
1080 ofp_print_meter_flags(struct ds *s, uint16_t flags)
1082 if (flags & OFPMF13_KBPS) {
1083 ds_put_cstr(s, "kbps ");
1085 if (flags & OFPMF13_PKTPS) {
1086 ds_put_cstr(s, "pktps ");
1088 if (flags & OFPMF13_BURST) {
1089 ds_put_cstr(s, "burst ");
1091 if (flags & OFPMF13_STATS) {
1092 ds_put_cstr(s, "stats ");
1095 flags &= ~(OFPMF13_KBPS | OFPMF13_PKTPS | OFPMF13_BURST | OFPMF13_STATS);
1097 ds_put_format(s, "flags:0x%"PRIx16" ", flags);
1102 ofp_print_meter_band(struct ds *s, uint16_t flags,
1103 const struct ofputil_meter_band *mb)
1105 ds_put_cstr(s, "\ntype=");
1108 ds_put_cstr(s, "drop");
1110 case OFPMBT13_DSCP_REMARK:
1111 ds_put_cstr(s, "dscp_remark");
1114 ds_put_format(s, "%u", mb->type);
1117 ds_put_format(s, " rate=%"PRIu32, mb->rate);
1119 if (flags & OFPMF13_BURST) {
1120 ds_put_format(s, " burst_size=%"PRIu32, mb->burst_size);
1122 if (mb->type == OFPMBT13_DSCP_REMARK) {
1123 ds_put_format(s, " prec_level=%"PRIu8, mb->prec_level);
1128 ofp_print_meter_stats(struct ds *s, const struct ofputil_meter_stats *ms)
1132 ds_put_format(s, "meter:%"PRIu32" ", ms->meter_id);
1133 ds_put_format(s, "flow_count:%"PRIu32" ", ms->flow_count);
1134 ds_put_format(s, "packet_in_count:%"PRIu64" ", ms->packet_in_count);
1135 ds_put_format(s, "byte_in_count:%"PRIu64" ", ms->byte_in_count);
1136 ds_put_cstr(s, "duration:");
1137 ofp_print_duration(s, ms->duration_sec, ms->duration_nsec);
1138 ds_put_char(s, ' ');
1140 ds_put_cstr(s, "bands:\n");
1141 for (i = 0; i < ms->n_bands; ++i) {
1142 ds_put_format(s, "%d: ", i);
1143 ds_put_format(s, "packet_count:%"PRIu64" ", ms->bands[i].packet_count);
1144 ds_put_format(s, "byte_count:%"PRIu64"\n", ms->bands[i].byte_count);
1149 ofp_print_meter_config(struct ds *s, const struct ofputil_meter_config *mc)
1153 ds_put_format(s, "meter=%"PRIu32" ", mc->meter_id);
1155 ofp_print_meter_flags(s, mc->flags);
1157 ds_put_cstr(s, "bands=");
1158 for (i = 0; i < mc->n_bands; ++i) {
1159 ofp_print_meter_band(s, mc->flags, &mc->bands[i]);
1161 ds_put_char(s, '\n');
1165 ofp_print_meter_mod(struct ds *s, const struct ofp_header *oh)
1167 struct ofputil_meter_mod mm;
1168 struct ofpbuf bands;
1171 ofpbuf_init(&bands, 64);
1172 error = ofputil_decode_meter_mod(oh, &mm, &bands);
1174 ofpbuf_uninit(&bands);
1175 ofp_print_error(s, error);
1179 switch (mm.command) {
1181 ds_put_cstr(s, " ADD ");
1183 case OFPMC13_MODIFY:
1184 ds_put_cstr(s, " MOD ");
1186 case OFPMC13_DELETE:
1187 ds_put_cstr(s, " DEL ");
1190 ds_put_format(s, " cmd:%d ", mm.command);
1193 ofp_print_meter_config(s, &mm.meter);
1194 ofpbuf_uninit(&bands);
1198 ofp_print_meter_stats_request(struct ds *s, const struct ofp_header *oh)
1202 ofputil_decode_meter_request(oh, &meter_id);
1204 ds_put_format(s, " meter=%"PRIu32, meter_id);
1208 ofputil_meter_capabilities_to_name(uint32_t bit)
1210 enum ofp13_meter_flags flag = bit;
1213 case OFPMF13_KBPS: return "kbps";
1214 case OFPMF13_PKTPS: return "pktps";
1215 case OFPMF13_BURST: return "burst";
1216 case OFPMF13_STATS: return "stats";
1223 ofputil_meter_band_types_to_name(uint32_t bit)
1226 case 1 << OFPMBT13_DROP: return "drop";
1227 case 1 << OFPMBT13_DSCP_REMARK: return "dscp_remark";
1234 ofp_print_meter_features_reply(struct ds *s, const struct ofp_header *oh)
1236 struct ofputil_meter_features mf;
1238 ofputil_decode_meter_features(oh, &mf);
1240 ds_put_format(s, "\nmax_meter:%"PRIu32, mf.max_meters);
1241 ds_put_format(s, " max_bands:%"PRIu8, mf.max_bands);
1242 ds_put_format(s, " max_color:%"PRIu8"\n", mf.max_color);
1244 ds_put_cstr(s, "band_types: ");
1245 ofp_print_bit_names(s, mf.band_types,
1246 ofputil_meter_band_types_to_name, ' ');
1247 ds_put_char(s, '\n');
1249 ds_put_cstr(s, "capabilities: ");
1250 ofp_print_bit_names(s, mf.capabilities,
1251 ofputil_meter_capabilities_to_name, ' ');
1252 ds_put_char(s, '\n');
1256 ofp_print_meter_config_reply(struct ds *s, const struct ofp_header *oh)
1258 struct ofpbuf bands;
1261 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1262 ofpbuf_init(&bands, 64);
1264 struct ofputil_meter_config mc;
1267 retval = ofputil_decode_meter_config(&b, &mc, &bands);
1269 if (retval != EOF) {
1270 ofp_print_error(s, retval);
1274 ds_put_char(s, '\n');
1275 ofp_print_meter_config(s, &mc);
1277 ofpbuf_uninit(&bands);
1281 ofp_print_meter_stats_reply(struct ds *s, const struct ofp_header *oh)
1283 struct ofpbuf bands;
1286 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1287 ofpbuf_init(&bands, 64);
1289 struct ofputil_meter_stats ms;
1292 retval = ofputil_decode_meter_stats(&b, &ms, &bands);
1294 if (retval != EOF) {
1295 ofp_print_error(s, retval);
1299 ds_put_char(s, '\n');
1300 ofp_print_meter_stats(s, &ms);
1302 ofpbuf_uninit(&bands);
1306 ofp_print_error(struct ds *string, enum ofperr error)
1308 if (string->length) {
1309 ds_put_char(string, ' ');
1311 ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1315 ofp_print_hello(struct ds *string, const struct ofp_header *oh)
1317 uint32_t allowed_versions;
1320 ok = ofputil_decode_hello(oh, &allowed_versions);
1322 ds_put_cstr(string, "\n version bitmap: ");
1323 ofputil_format_version_bitmap(string, allowed_versions);
1326 ds_put_cstr(string, "\n unknown data in hello:\n");
1327 ds_put_hex_dump(string, oh, ntohs(oh->length), 0, true);
1332 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
1334 size_t len = ntohs(oh->length);
1335 struct ofpbuf payload;
1339 error = ofperr_decode_msg(oh, &payload);
1341 ds_put_cstr(string, "***decode error***");
1342 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1346 ds_put_format(string, " %s\n", ofperr_get_name(error));
1348 if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
1349 ds_put_printable(string, ofpbuf_data(&payload), ofpbuf_size(&payload));
1351 s = ofp_to_string(ofpbuf_data(&payload), ofpbuf_size(&payload), 1);
1352 ds_put_cstr(string, s);
1355 ofpbuf_uninit(&payload);
1359 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
1361 struct ofputil_port_status ps;
1364 error = ofputil_decode_port_status(oh, &ps);
1366 ofp_print_error(string, error);
1370 if (ps.reason == OFPPR_ADD) {
1371 ds_put_format(string, " ADD:");
1372 } else if (ps.reason == OFPPR_DELETE) {
1373 ds_put_format(string, " DEL:");
1374 } else if (ps.reason == OFPPR_MODIFY) {
1375 ds_put_format(string, " MOD:");
1378 ofp_print_phy_port(string, &ps.desc);
1382 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1384 const struct ofp_desc_stats *ods = ofpmsg_body(oh);
1386 ds_put_char(string, '\n');
1387 ds_put_format(string, "Manufacturer: %.*s\n",
1388 (int) sizeof ods->mfr_desc, ods->mfr_desc);
1389 ds_put_format(string, "Hardware: %.*s\n",
1390 (int) sizeof ods->hw_desc, ods->hw_desc);
1391 ds_put_format(string, "Software: %.*s\n",
1392 (int) sizeof ods->sw_desc, ods->sw_desc);
1393 ds_put_format(string, "Serial Num: %.*s\n",
1394 (int) sizeof ods->serial_num, ods->serial_num);
1395 ds_put_format(string, "DP Description: %.*s\n",
1396 (int) sizeof ods->dp_desc, ods->dp_desc);
1400 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1402 struct ofputil_flow_stats_request fsr;
1405 error = ofputil_decode_flow_stats_request(&fsr, oh);
1407 ofp_print_error(string, error);
1411 if (fsr.table_id != 0xff) {
1412 ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1415 if (fsr.out_port != OFPP_ANY) {
1416 ds_put_cstr(string, " out_port=");
1417 ofputil_format_port(fsr.out_port, string);
1420 ds_put_char(string, ' ');
1421 match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
1425 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1427 ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1428 ntohll(fs->cookie));
1430 ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1431 ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1432 ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1433 ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1434 if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1435 ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1437 if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1438 ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1441 ofp_print_flow_flags(string, fs->flags);
1443 if (fs->importance != 0) {
1444 ds_put_format(string, "importance=%"PRIu16", ", fs->importance);
1446 if (fs->idle_age >= 0) {
1447 ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1449 if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1450 ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1453 match_format(&fs->match, string, fs->priority);
1454 if (string->string[string->length - 1] != ' ') {
1455 ds_put_char(string, ' ');
1458 ds_put_cstr(string, "actions=");
1459 ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1463 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1465 struct ofpbuf ofpacts;
1468 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1469 ofpbuf_init(&ofpacts, 64);
1471 struct ofputil_flow_stats fs;
1474 retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1476 if (retval != EOF) {
1477 ds_put_cstr(string, " ***parse error***");
1481 ds_put_char(string, '\n');
1482 ofp_print_flow_stats(string, &fs);
1484 ofpbuf_uninit(&ofpacts);
1488 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1490 struct ofputil_aggregate_stats as;
1493 error = ofputil_decode_aggregate_stats_reply(&as, oh);
1495 ofp_print_error(string, error);
1499 ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1500 ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1501 ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1505 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1507 ds_put_cstr(string, leader);
1508 if (stat != UINT64_MAX) {
1509 ds_put_format(string, "%"PRIu64, stat);
1511 ds_put_char(string, '?');
1514 ds_put_cstr(string, ", ");
1516 ds_put_cstr(string, "\n");
1521 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1523 ofp_port_t ofp10_port;
1526 error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1528 ofp_print_error(string, error);
1532 ds_put_cstr(string, " port_no=");
1533 ofputil_format_port(ofp10_port, string);
1537 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1542 ds_put_format(string, " %"PRIuSIZE" ports\n", ofputil_count_port_stats(oh));
1543 if (verbosity < 1) {
1547 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1549 struct ofputil_port_stats ps;
1552 retval = ofputil_decode_port_stats(&ps, &b);
1554 if (retval != EOF) {
1555 ds_put_cstr(string, " ***parse error***");
1560 ds_put_cstr(string, " port ");
1561 if (ofp_to_u16(ps.port_no) < 10) {
1562 ds_put_char(string, ' ');
1564 ofputil_format_port(ps.port_no, string);
1566 ds_put_cstr(string, ": rx ");
1567 print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1568 print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1569 print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1570 print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1571 print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1572 print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1573 print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1575 ds_put_cstr(string, " tx ");
1576 print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1577 print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1578 print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1579 print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1580 print_port_stat(string, "coll=", ps.stats.collisions, 0);
1582 if (ps.duration_sec != UINT32_MAX) {
1583 ds_put_cstr(string, " duration=");
1584 ofp_print_duration(string, ps.duration_sec, ps.duration_nsec);
1585 ds_put_char(string, '\n');
1591 ofp_print_table_stats_reply(struct ds *string, const struct ofp_header *oh)
1595 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1596 ofpraw_pull_assert(&b);
1599 struct ofputil_table_features features;
1600 struct ofputil_table_stats stats;
1603 retval = ofputil_decode_table_stats_reply(&b, &stats, &features);
1605 if (retval != EOF) {
1606 ofp_print_error(string, retval);
1611 ofp_print_table_features(string, &features, &stats);
1616 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1618 if (queue_id == OFPQ_ALL) {
1619 ds_put_cstr(string, "ALL");
1621 ds_put_format(string, "%"PRIu32, queue_id);
1626 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1628 struct ofputil_queue_stats_request oqsr;
1631 error = ofputil_decode_queue_stats_request(oh, &oqsr);
1633 ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1637 ds_put_cstr(string, "port=");
1638 ofputil_format_port(oqsr.port_no, string);
1640 ds_put_cstr(string, " queue=");
1641 ofp_print_queue_name(string, oqsr.queue_id);
1645 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1650 ds_put_format(string, " %"PRIuSIZE" queues\n", ofputil_count_queue_stats(oh));
1651 if (verbosity < 1) {
1655 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1657 struct ofputil_queue_stats qs;
1660 retval = ofputil_decode_queue_stats(&qs, &b);
1662 if (retval != EOF) {
1663 ds_put_cstr(string, " ***parse error***");
1668 ds_put_cstr(string, " port ");
1669 ofputil_format_port(qs.port_no, string);
1670 ds_put_cstr(string, " queue ");
1671 ofp_print_queue_name(string, qs.queue_id);
1672 ds_put_cstr(string, ": ");
1674 print_port_stat(string, "bytes=", qs.tx_bytes, 1);
1675 print_port_stat(string, "pkts=", qs.tx_packets, 1);
1676 print_port_stat(string, "errors=", qs.tx_errors, 1);
1678 ds_put_cstr(string, "duration=");
1679 if (qs.duration_sec != UINT32_MAX) {
1680 ofp_print_duration(string, qs.duration_sec, qs.duration_nsec);
1682 ds_put_char(string, '?');
1684 ds_put_char(string, '\n');
1689 ofp_print_ofpst_port_desc_request(struct ds *string,
1690 const struct ofp_header *oh)
1695 error = ofputil_decode_port_desc_stats_request(oh, &port);
1697 ofp_print_error(string, error);
1701 ds_put_cstr(string, " port=");
1702 ofputil_format_port(port, string);
1706 ofp_print_ofpst_port_desc_reply(struct ds *string,
1707 const struct ofp_header *oh)
1711 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1712 ofpraw_pull_assert(&b);
1713 ds_put_char(string, '\n');
1714 ofp_print_phy_ports(string, oh->version, &b);
1718 ofp_print_stats(struct ds *string, const struct ofp_header *oh)
1720 uint16_t flags = ofpmp_flags(oh);
1723 ds_put_cstr(string, " flags=");
1724 if ((!ofpmsg_is_stat_request(oh) || oh->version >= OFP13_VERSION)
1725 && (flags & OFPSF_REPLY_MORE)) {
1726 ds_put_cstr(string, "[more]");
1727 flags &= ~OFPSF_REPLY_MORE;
1730 ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1737 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1739 size_t len = ntohs(oh->length);
1741 ds_put_format(string, " %"PRIuSIZE" bytes of payload\n", len - sizeof *oh);
1742 if (verbosity > 1) {
1743 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1748 ofp_print_role_generic(struct ds *string, enum ofp12_controller_role role,
1749 uint64_t generation_id)
1751 ds_put_cstr(string, " role=");
1754 case OFPCR12_ROLE_NOCHANGE:
1755 ds_put_cstr(string, "nochange");
1757 case OFPCR12_ROLE_EQUAL:
1758 ds_put_cstr(string, "equal"); /* OF 1.2 wording */
1760 case OFPCR12_ROLE_MASTER:
1761 ds_put_cstr(string, "master");
1763 case OFPCR12_ROLE_SLAVE:
1764 ds_put_cstr(string, "slave");
1770 if (generation_id != UINT64_MAX) {
1771 ds_put_format(string, " generation_id=%"PRIu64, generation_id);
1776 ofp_print_role_message(struct ds *string, const struct ofp_header *oh)
1778 struct ofputil_role_request rr;
1781 error = ofputil_decode_role_message(oh, &rr);
1783 ofp_print_error(string, error);
1787 ofp_print_role_generic(string, rr.role, rr.have_generation_id ? rr.generation_id : UINT64_MAX);
1791 ofp_print_role_status_message(struct ds *string, const struct ofp_header *oh)
1793 struct ofputil_role_status rs;
1796 error = ofputil_decode_role_status(oh, &rs);
1798 ofp_print_error(string, error);
1802 ofp_print_role_generic(string, rs.role, rs.generation_id);
1804 ds_put_cstr(string, " reason=");
1806 switch (rs.reason) {
1807 case OFPCRR_MASTER_REQUEST:
1808 ds_put_cstr(string, "master_request");
1811 ds_put_cstr(string, "configuration_changed");
1813 case OFPCRR_EXPERIMENTER:
1814 ds_put_cstr(string, "experimenter_data_changed");
1822 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1823 const struct nx_flow_mod_table_id *nfmti)
1825 ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1829 ofp_print_nxt_set_flow_format(struct ds *string,
1830 const struct nx_set_flow_format *nsff)
1832 uint32_t format = ntohl(nsff->format);
1834 ds_put_cstr(string, " format=");
1835 if (ofputil_nx_flow_format_is_valid(format)) {
1836 ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1838 ds_put_format(string, "%"PRIu32, format);
1843 ofp_print_nxt_set_packet_in_format(struct ds *string,
1844 const struct nx_set_packet_in_format *nspf)
1846 uint32_t format = ntohl(nspf->format);
1848 ds_put_cstr(string, " format=");
1849 if (ofputil_packet_in_format_is_valid(format)) {
1850 ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1852 ds_put_format(string, "%"PRIu32, format);
1856 /* Returns a string form of 'reason'. The return value is either a statically
1857 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1858 * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
1859 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
1861 ofp_port_reason_to_string(enum ofp_port_reason reason,
1862 char *reasonbuf, size_t bufsize)
1875 snprintf(reasonbuf, bufsize, "%d", (int) reason);
1881 ofp_print_nxt_set_async_config(struct ds *string,
1882 const struct nx_async_config *nac)
1886 for (i = 0; i < 2; i++) {
1889 ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1891 ds_put_cstr(string, " PACKET_IN:");
1892 for (j = 0; j < 32; j++) {
1893 if (nac->packet_in_mask[i] & htonl(1u << j)) {
1894 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
1897 reason = ofputil_packet_in_reason_to_string(j, reasonbuf,
1899 ds_put_format(string, " %s", reason);
1902 if (!nac->packet_in_mask[i]) {
1903 ds_put_cstr(string, " (off)");
1905 ds_put_char(string, '\n');
1907 ds_put_cstr(string, " PORT_STATUS:");
1908 for (j = 0; j < 32; j++) {
1909 if (nac->port_status_mask[i] & htonl(1u << j)) {
1910 char reasonbuf[OFP_PORT_REASON_BUFSIZE];
1913 reason = ofp_port_reason_to_string(j, reasonbuf,
1915 ds_put_format(string, " %s", reason);
1918 if (!nac->port_status_mask[i]) {
1919 ds_put_cstr(string, " (off)");
1921 ds_put_char(string, '\n');
1923 ds_put_cstr(string, " FLOW_REMOVED:");
1924 for (j = 0; j < 32; j++) {
1925 if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1926 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
1929 reason = ofp_flow_removed_reason_to_string(j, reasonbuf,
1931 ds_put_format(string, " %s", reason);
1934 if (!nac->flow_removed_mask[i]) {
1935 ds_put_cstr(string, " (off)");
1937 ds_put_char(string, '\n');
1942 ofp_print_nxt_set_controller_id(struct ds *string,
1943 const struct nx_controller_id *nci)
1945 ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1949 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1950 const struct ofp_header *oh)
1952 ds_put_format(string, " id=%"PRIu32,
1953 ofputil_decode_flow_monitor_cancel(oh));
1957 nx_flow_monitor_flags_to_name(uint32_t bit)
1959 enum nx_flow_monitor_flags fmf = bit;
1962 case NXFMF_INITIAL: return "initial";
1963 case NXFMF_ADD: return "add";
1964 case NXFMF_DELETE: return "delete";
1965 case NXFMF_MODIFY: return "modify";
1966 case NXFMF_ACTIONS: return "actions";
1967 case NXFMF_OWN: return "own";
1974 ofp_print_nxst_flow_monitor_request(struct ds *string,
1975 const struct ofp_header *oh)
1979 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1981 struct ofputil_flow_monitor_request request;
1984 retval = ofputil_decode_flow_monitor_request(&request, &b);
1986 if (retval != EOF) {
1987 ofp_print_error(string, retval);
1992 ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
1993 ofp_print_bit_names(string, request.flags,
1994 nx_flow_monitor_flags_to_name, ',');
1996 if (request.out_port != OFPP_NONE) {
1997 ds_put_cstr(string, " out_port=");
1998 ofputil_format_port(request.out_port, string);
2001 if (request.table_id != 0xff) {
2002 ds_put_format(string, " table=%"PRIu8, request.table_id);
2005 ds_put_char(string, ' ');
2006 match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
2007 ds_chomp(string, ' ');
2012 ofp_print_nxst_flow_monitor_reply(struct ds *string,
2013 const struct ofp_header *oh)
2015 uint64_t ofpacts_stub[1024 / 8];
2016 struct ofpbuf ofpacts;
2019 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2020 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2022 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2023 struct ofputil_flow_update update;
2027 update.match = &match;
2028 retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
2030 if (retval != EOF) {
2031 ofp_print_error(string, retval);
2033 ofpbuf_uninit(&ofpacts);
2037 ds_put_cstr(string, "\n event=");
2038 switch (update.event) {
2040 ds_put_cstr(string, "ADDED");
2044 ds_put_format(string, "DELETED reason=%s",
2045 ofp_flow_removed_reason_to_string(update.reason,
2050 case NXFME_MODIFIED:
2051 ds_put_cstr(string, "MODIFIED");
2055 ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
2059 ds_put_format(string, " table=%"PRIu8, update.table_id);
2060 if (update.idle_timeout != OFP_FLOW_PERMANENT) {
2061 ds_put_format(string, " idle_timeout=%"PRIu16,
2062 update.idle_timeout);
2064 if (update.hard_timeout != OFP_FLOW_PERMANENT) {
2065 ds_put_format(string, " hard_timeout=%"PRIu16,
2066 update.hard_timeout);
2068 ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
2070 ds_put_char(string, ' ');
2071 match_format(update.match, string, OFP_DEFAULT_PRIORITY);
2073 if (update.ofpacts_len) {
2074 if (string->string[string->length - 1] != ' ') {
2075 ds_put_char(string, ' ');
2077 ds_put_cstr(string, "actions=");
2078 ofpacts_format(update.ofpacts, update.ofpacts_len, string);
2084 ofp_print_version(const struct ofp_header *oh,
2087 switch (oh->version) {
2091 ds_put_cstr(string, " (OF1.1)");
2094 ds_put_cstr(string, " (OF1.2)");
2097 ds_put_cstr(string, " (OF1.3)");
2100 ds_put_cstr(string, " (OF1.4)");
2103 ds_put_cstr(string, " (OF1.5)");
2106 ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
2109 ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
2113 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2116 ds_put_cstr(string, ofpraw_get_name(raw));
2117 ofp_print_version(oh, string);
2121 ofp_print_bucket_id(struct ds *s, const char *label, uint32_t bucket_id,
2122 enum ofp_version ofp_version)
2124 if (ofp_version < OFP15_VERSION) {
2128 ds_put_cstr(s, label);
2130 switch (bucket_id) {
2131 case OFPG15_BUCKET_FIRST:
2132 ds_put_cstr(s, "first");
2134 case OFPG15_BUCKET_LAST:
2135 ds_put_cstr(s, "last");
2137 case OFPG15_BUCKET_ALL:
2138 ds_put_cstr(s, "all");
2141 ds_put_format(s, "%"PRIu32, bucket_id);
2145 ds_put_char(s, ',');
2149 ofp_print_group(struct ds *s, uint32_t group_id, uint8_t type,
2150 struct ovs_list *p_buckets, enum ofp_version ofp_version,
2153 struct ofputil_bucket *bucket;
2155 ds_put_format(s, "group_id=%"PRIu32, group_id);
2157 if (!suppress_type) {
2158 static const char *type_str[] = { "all", "select", "indirect",
2160 ds_put_format(s, ",type=%s", type_str[type > 4 ? 4 : type]);
2167 ds_put_char(s, ',');
2169 LIST_FOR_EACH (bucket, list_node, p_buckets) {
2170 ds_put_cstr(s, "bucket=");
2172 ofp_print_bucket_id(s, "bucket_id:", bucket->bucket_id, ofp_version);
2173 if (bucket->weight != 1) {
2174 ds_put_format(s, "weight:%"PRIu16",", bucket->weight);
2176 if (bucket->watch_port != OFPP_NONE) {
2177 ds_put_format(s, "watch_port:%"PRIu32",", bucket->watch_port);
2179 if (bucket->watch_group != OFPG11_ANY) {
2180 ds_put_format(s, "watch_group:%"PRIu32",", bucket->watch_group);
2183 ds_put_cstr(s, "actions=");
2184 ofpacts_format(bucket->ofpacts, bucket->ofpacts_len, s);
2185 ds_put_char(s, ',');
2192 ofp_print_ofpst_group_desc_request(struct ds *string,
2193 const struct ofp_header *oh)
2195 uint32_t group_id = ofputil_decode_group_desc_request(oh);
2196 ds_put_cstr(string, " group_id=");
2197 ofputil_format_group(group_id, string);
2201 ofp_print_group_desc(struct ds *s, const struct ofp_header *oh)
2205 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2207 struct ofputil_group_desc gd;
2210 retval = ofputil_decode_group_desc_reply(&gd, &b, oh->version);
2212 if (retval != EOF) {
2213 ds_put_cstr(s, " ***parse error***");
2218 ds_put_char(s, '\n');
2219 ds_put_char(s, ' ');
2220 ofp_print_group(s, gd.group_id, gd.type, &gd.buckets, oh->version,
2222 ofputil_bucket_list_destroy(&gd.buckets);
2227 ofp_print_ofpst_group_request(struct ds *string, const struct ofp_header *oh)
2232 error = ofputil_decode_group_stats_request(oh, &group_id);
2234 ofp_print_error(string, error);
2238 ds_put_cstr(string, " group_id=");
2239 ofputil_format_group(group_id, string);
2243 ofp_print_group_stats(struct ds *s, const struct ofp_header *oh)
2248 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2251 struct ofputil_group_stats gs;
2254 retval = ofputil_decode_group_stats_reply(&b, &gs);
2256 if (retval != EOF) {
2257 ds_put_cstr(s, " ***parse error***");
2262 ds_put_char(s, '\n');
2264 ds_put_char(s, ' ');
2265 ds_put_format(s, "group_id=%"PRIu32",", gs.group_id);
2267 if (gs.duration_sec != UINT32_MAX) {
2268 ds_put_cstr(s, "duration=");
2269 ofp_print_duration(s, gs.duration_sec, gs.duration_nsec);
2270 ds_put_char(s, ',');
2272 ds_put_format(s, "ref_count=%"PRIu32",", gs.ref_count);
2273 ds_put_format(s, "packet_count=%"PRIu64",", gs.packet_count);
2274 ds_put_format(s, "byte_count=%"PRIu64"", gs.byte_count);
2276 for (bucket_i = 0; bucket_i < gs.n_buckets; bucket_i++) {
2277 if (gs.bucket_stats[bucket_i].packet_count != UINT64_MAX) {
2278 ds_put_format(s, ",bucket%"PRIu32":", bucket_i);
2279 ds_put_format(s, "packet_count=%"PRIu64",", gs.bucket_stats[bucket_i].packet_count);
2280 ds_put_format(s, "byte_count=%"PRIu64"", gs.bucket_stats[bucket_i].byte_count);
2284 free(gs.bucket_stats);
2289 group_type_to_string(enum ofp11_group_type type)
2292 case OFPGT11_ALL: return "all";
2293 case OFPGT11_SELECT: return "select";
2294 case OFPGT11_INDIRECT: return "indirect";
2295 case OFPGT11_FF: return "fast failover";
2296 default: OVS_NOT_REACHED();
2301 ofp_print_group_features(struct ds *string, const struct ofp_header *oh)
2303 struct ofputil_group_features features;
2306 ofputil_decode_group_features_reply(oh, &features);
2308 ds_put_format(string, "\n Group table:\n");
2309 ds_put_format(string, " Types: 0x%"PRIx32"\n", features.types);
2310 ds_put_format(string, " Capabilities: 0x%"PRIx32"\n",
2311 features.capabilities);
2313 for (i = 0; i < OFPGT12_N_TYPES; i++) {
2314 if (features.types & (1u << i)) {
2315 ds_put_format(string, " %s group:\n", group_type_to_string(i));
2316 ds_put_format(string, " max_groups=%#"PRIx32"\n",
2317 features.max_groups[i]);
2318 ds_put_format(string, " actions: ");
2319 ofpact_bitmap_format(features.ofpacts[i], string);
2320 ds_put_char(string, '\n');
2326 ofp_print_group_mod(struct ds *s, const struct ofp_header *oh)
2328 struct ofputil_group_mod gm;
2330 bool bucket_command = false;
2332 error = ofputil_decode_group_mod(oh, &gm);
2334 ofp_print_error(s, error);
2338 ds_put_char(s, '\n');
2340 ds_put_char(s, ' ');
2341 switch (gm.command) {
2343 ds_put_cstr(s, "ADD");
2346 case OFPGC11_MODIFY:
2347 ds_put_cstr(s, "MOD");
2350 case OFPGC11_DELETE:
2351 ds_put_cstr(s, "DEL");
2354 case OFPGC15_INSERT_BUCKET:
2355 ds_put_cstr(s, "INSERT_BUCKET");
2356 bucket_command = true;
2359 case OFPGC15_REMOVE_BUCKET:
2360 ds_put_cstr(s, "REMOVE_BUCKET");
2361 bucket_command = true;
2365 ds_put_format(s, "cmd:%"PRIu16"", gm.command);
2367 ds_put_char(s, ' ');
2369 if (bucket_command) {
2370 ofp_print_bucket_id(s, "command_bucket_id:",
2371 gm.command_bucket_id, oh->version);
2374 ofp_print_group(s, gm.group_id, gm.type, &gm.buckets, oh->version,
2376 ofputil_bucket_list_destroy(&gm.buckets);
2380 print_table_action_features(struct ds *s,
2381 const struct ofputil_table_action_features *taf)
2384 ds_put_cstr(s, " actions: ");
2385 ofpact_bitmap_format(taf->ofpacts, s);
2386 ds_put_char(s, '\n');
2389 if (!bitmap_is_all_zeros(taf->set_fields.bm, MFF_N_IDS)) {
2392 ds_put_cstr(s, " supported on Set-Field:");
2393 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, taf->set_fields.bm) {
2394 ds_put_format(s, " %s", mf_from_id(i)->name);
2396 ds_put_char(s, '\n');
2401 table_action_features_equal(const struct ofputil_table_action_features *a,
2402 const struct ofputil_table_action_features *b)
2404 return (a->ofpacts == b->ofpacts
2405 && bitmap_equal(a->set_fields.bm, b->set_fields.bm, MFF_N_IDS));
2409 table_action_features_empty(const struct ofputil_table_action_features *taf)
2411 return !taf->ofpacts && bitmap_is_all_zeros(taf->set_fields.bm, MFF_N_IDS);
2415 print_table_instruction_features(
2416 struct ds *s, const struct ofputil_table_instruction_features *tif)
2420 if (!bitmap_is_all_zeros(tif->next, 255)) {
2421 ds_put_cstr(s, " next tables: ");
2422 for (start = bitmap_scan(tif->next, 1, 0, 255); start < 255;
2423 start = bitmap_scan(tif->next, 1, end, 255)) {
2424 end = bitmap_scan(tif->next, 0, start + 1, 255);
2425 if (end == start + 1) {
2426 ds_put_format(s, "%d,", start);
2428 ds_put_format(s, "%d-%d,", start, end - 1);
2432 if (ds_last(s) == ' ') {
2433 ds_put_cstr(s, "none");
2435 ds_put_char(s, '\n');
2438 if (tif->instructions) {
2439 ds_put_cstr(s, " instructions: ");
2442 for (i = 0; i < 32; i++) {
2443 if (tif->instructions & (1u << i)) {
2444 ds_put_format(s, "%s,", ovs_instruction_name_from_type(i));
2448 ds_put_char(s, '\n');
2451 if (!table_action_features_equal(&tif->write, &tif->apply)) {
2452 ds_put_cstr(s, " Write-Actions features:\n");
2453 print_table_action_features(s, &tif->write);
2454 ds_put_cstr(s, " Apply-Actions features:\n");
2455 print_table_action_features(s, &tif->apply);
2456 } else if (tif->write.ofpacts
2457 || !bitmap_is_all_zeros(tif->write.set_fields.bm, MFF_N_IDS)) {
2458 ds_put_cstr(s, " Write-Actions and Apply-Actions features:\n");
2459 print_table_action_features(s, &tif->write);
2464 table_instruction_features_equal(
2465 const struct ofputil_table_instruction_features *a,
2466 const struct ofputil_table_instruction_features *b)
2468 return (bitmap_equal(a->next, b->next, 255)
2469 && a->instructions == b->instructions
2470 && table_action_features_equal(&a->write, &b->write)
2471 && table_action_features_equal(&a->apply, &b->apply));
2475 table_instruction_features_empty(
2476 const struct ofputil_table_instruction_features *tif)
2478 return (bitmap_is_all_zeros(tif->next, 255)
2479 && !tif->instructions
2480 && table_action_features_empty(&tif->write)
2481 && table_action_features_empty(&tif->apply));
2485 ofp_print_table_features(struct ds *s,
2486 const struct ofputil_table_features *features,
2487 const struct ofputil_table_stats *stats)
2491 ds_put_format(s, "\n table %"PRIu8, features->table_id);
2492 if (features->name[0]) {
2493 ds_put_format(s, " (\"%s\")", features->name);
2495 ds_put_cstr(s, ":\n");
2497 ds_put_format(s, " active=%"PRIu32", ", stats->active_count);
2498 ds_put_format(s, "lookup=%"PRIu64", ", stats->lookup_count);
2499 ds_put_format(s, "matched=%"PRIu64"\n", stats->matched_count);
2501 if (features->metadata_match || features->metadata_match) {
2502 ds_put_format(s, " metadata: match=%#"PRIx64" write=%#"PRIx64"\n",
2503 ntohll(features->metadata_match),
2504 ntohll(features->metadata_write));
2507 if (features->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
2508 ds_put_cstr(s, " config=");
2509 ofp_print_table_miss_config(s, features->miss_config);
2512 if (features->max_entries) {
2513 ds_put_format(s, " max_entries=%"PRIu32"\n", features->max_entries);
2516 if (!table_instruction_features_equal(&features->nonmiss,
2518 ds_put_cstr(s, " instructions (other than table miss):\n");
2519 print_table_instruction_features(s, &features->nonmiss);
2520 ds_put_cstr(s, " instructions (table miss):\n");
2521 print_table_instruction_features(s, &features->miss);
2522 } else if (!table_instruction_features_empty(&features->nonmiss)) {
2523 ds_put_cstr(s, " instructions (table miss and others):\n");
2524 print_table_instruction_features(s, &features->nonmiss);
2527 if (!bitmap_is_all_zeros(features->match.bm, MFF_N_IDS)){
2528 ds_put_cstr(s, " matching:\n");
2529 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, features->match.bm) {
2530 const struct mf_field *f = mf_from_id(i);
2531 bool mask = bitmap_is_set(features->mask.bm, i);
2532 bool wildcard = bitmap_is_set(features->wildcard.bm, i);
2534 ds_put_format(s, " %s: %s\n",
2536 (mask ? "arbitrary mask"
2537 : wildcard ? "exact match or wildcard"
2538 : "must exact match"));
2544 ofp_print_table_features_reply(struct ds *s, const struct ofp_header *oh)
2548 ofpbuf_use_const(&b, oh, ntohs(oh->length));
2551 struct ofputil_table_features tf;
2554 retval = ofputil_decode_table_features(&b, &tf, true);
2556 if (retval != EOF) {
2557 ofp_print_error(s, retval);
2561 ofp_print_table_features(s, &tf, NULL);
2566 bundle_flags_to_name(uint32_t bit)
2579 ofp_print_bundle_ctrl(struct ds *s, const struct ofp_header *oh)
2582 struct ofputil_bundle_ctrl_msg bctrl;
2584 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
2586 ofp_print_error(s, error);
2590 ds_put_char(s, '\n');
2592 ds_put_format(s, " bundle_id=%#"PRIx32" type=", bctrl.bundle_id);
2593 switch (bctrl.type) {
2594 case OFPBCT_OPEN_REQUEST:
2595 ds_put_cstr(s, "OPEN_REQUEST");
2597 case OFPBCT_OPEN_REPLY:
2598 ds_put_cstr(s, "OPEN_REPLY");
2600 case OFPBCT_CLOSE_REQUEST:
2601 ds_put_cstr(s, "CLOSE_REQUEST");
2603 case OFPBCT_CLOSE_REPLY:
2604 ds_put_cstr(s, "CLOSE_REPLY");
2606 case OFPBCT_COMMIT_REQUEST:
2607 ds_put_cstr(s, "COMMIT_REQUEST");
2609 case OFPBCT_COMMIT_REPLY:
2610 ds_put_cstr(s, "COMMIT_REPLY");
2612 case OFPBCT_DISCARD_REQUEST:
2613 ds_put_cstr(s, "DISCARD_REQUEST");
2615 case OFPBCT_DISCARD_REPLY:
2616 ds_put_cstr(s, "DISCARD_REPLY");
2620 ds_put_cstr(s, " flags=");
2621 ofp_print_bit_names(s, bctrl.flags, bundle_flags_to_name, ' ');
2625 ofp_print_bundle_add(struct ds *s, const struct ofp_header *oh, int verbosity)
2628 struct ofputil_bundle_add_msg badd;
2631 error = ofputil_decode_bundle_add(oh, &badd);
2633 ofp_print_error(s, error);
2637 ds_put_char(s, '\n');
2638 ds_put_format(s, " bundle_id=%#"PRIx32, badd.bundle_id);
2639 ds_put_cstr(s, " flags=");
2640 ofp_print_bit_names(s, badd.flags, bundle_flags_to_name, ' ');
2642 ds_put_char(s, '\n');
2643 msg = ofp_to_string(badd.msg, ntohs(badd.msg->length), verbosity);
2645 ds_put_cstr(s, msg);
2650 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2651 struct ds *string, int verbosity)
2653 const void *msg = oh;
2655 ofp_header_to_string__(oh, raw, string);
2656 switch (ofptype_from_ofpraw(raw)) {
2658 case OFPTYPE_GROUP_STATS_REQUEST:
2659 ofp_print_stats(string, oh);
2660 ofp_print_ofpst_group_request(string, oh);
2663 case OFPTYPE_GROUP_STATS_REPLY:
2664 ofp_print_group_stats(string, oh);
2667 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
2668 ofp_print_stats(string, oh);
2669 ofp_print_ofpst_group_desc_request(string, oh);
2672 case OFPTYPE_GROUP_DESC_STATS_REPLY:
2673 ofp_print_group_desc(string, oh);
2676 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
2677 ofp_print_stats(string, oh);
2680 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
2681 ofp_print_group_features(string, oh);
2684 case OFPTYPE_GROUP_MOD:
2685 ofp_print_group_mod(string, oh);
2688 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
2689 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
2690 ofp_print_table_features_reply(string, oh);
2694 ofp_print_hello(string, oh);
2698 ofp_print_error_msg(string, oh);
2701 case OFPTYPE_ECHO_REQUEST:
2702 case OFPTYPE_ECHO_REPLY:
2703 ofp_print_echo(string, oh, verbosity);
2706 case OFPTYPE_FEATURES_REQUEST:
2709 case OFPTYPE_FEATURES_REPLY:
2710 ofp_print_switch_features(string, oh);
2713 case OFPTYPE_GET_CONFIG_REQUEST:
2716 case OFPTYPE_GET_CONFIG_REPLY:
2717 case OFPTYPE_SET_CONFIG:
2718 ofp_print_switch_config(string, ofpmsg_body(oh));
2721 case OFPTYPE_PACKET_IN:
2722 ofp_print_packet_in(string, oh, verbosity);
2725 case OFPTYPE_FLOW_REMOVED:
2726 ofp_print_flow_removed(string, oh);
2729 case OFPTYPE_PORT_STATUS:
2730 ofp_print_port_status(string, oh);
2733 case OFPTYPE_PACKET_OUT:
2734 ofp_print_packet_out(string, oh, verbosity);
2737 case OFPTYPE_FLOW_MOD:
2738 ofp_print_flow_mod(string, oh, verbosity);
2741 case OFPTYPE_PORT_MOD:
2742 ofp_print_port_mod(string, oh);
2745 case OFPTYPE_TABLE_MOD:
2746 ofp_print_table_mod(string, oh);
2749 case OFPTYPE_METER_MOD:
2750 ofp_print_meter_mod(string, oh);
2753 case OFPTYPE_BARRIER_REQUEST:
2754 case OFPTYPE_BARRIER_REPLY:
2757 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
2758 ofp_print_queue_get_config_request(string, oh);
2761 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
2762 ofp_print_queue_get_config_reply(string, oh);
2765 case OFPTYPE_ROLE_REQUEST:
2766 case OFPTYPE_ROLE_REPLY:
2767 ofp_print_role_message(string, oh);
2769 case OFPTYPE_ROLE_STATUS:
2770 ofp_print_role_status_message(string, oh);
2773 case OFPTYPE_METER_STATS_REQUEST:
2774 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
2775 ofp_print_stats(string, oh);
2776 ofp_print_meter_stats_request(string, oh);
2779 case OFPTYPE_METER_STATS_REPLY:
2780 ofp_print_stats(string, oh);
2781 ofp_print_meter_stats_reply(string, oh);
2784 case OFPTYPE_METER_CONFIG_STATS_REPLY:
2785 ofp_print_stats(string, oh);
2786 ofp_print_meter_config_reply(string, oh);
2789 case OFPTYPE_METER_FEATURES_STATS_REPLY:
2790 ofp_print_stats(string, oh);
2791 ofp_print_meter_features_reply(string, oh);
2794 case OFPTYPE_DESC_STATS_REQUEST:
2795 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
2796 ofp_print_stats(string, oh);
2799 case OFPTYPE_FLOW_STATS_REQUEST:
2800 case OFPTYPE_AGGREGATE_STATS_REQUEST:
2801 ofp_print_stats(string, oh);
2802 ofp_print_flow_stats_request(string, oh);
2805 case OFPTYPE_TABLE_STATS_REQUEST:
2806 ofp_print_stats(string, oh);
2809 case OFPTYPE_PORT_STATS_REQUEST:
2810 ofp_print_stats(string, oh);
2811 ofp_print_ofpst_port_request(string, oh);
2814 case OFPTYPE_QUEUE_STATS_REQUEST:
2815 ofp_print_stats(string, oh);
2816 ofp_print_ofpst_queue_request(string, oh);
2819 case OFPTYPE_DESC_STATS_REPLY:
2820 ofp_print_stats(string, oh);
2821 ofp_print_ofpst_desc_reply(string, oh);
2824 case OFPTYPE_FLOW_STATS_REPLY:
2825 ofp_print_stats(string, oh);
2826 ofp_print_flow_stats_reply(string, oh);
2829 case OFPTYPE_QUEUE_STATS_REPLY:
2830 ofp_print_stats(string, oh);
2831 ofp_print_ofpst_queue_reply(string, oh, verbosity);
2834 case OFPTYPE_PORT_STATS_REPLY:
2835 ofp_print_stats(string, oh);
2836 ofp_print_ofpst_port_reply(string, oh, verbosity);
2839 case OFPTYPE_TABLE_STATS_REPLY:
2840 ofp_print_stats(string, oh);
2841 ofp_print_table_stats_reply(string, oh);
2844 case OFPTYPE_AGGREGATE_STATS_REPLY:
2845 ofp_print_stats(string, oh);
2846 ofp_print_aggregate_stats_reply(string, oh);
2849 case OFPTYPE_PORT_DESC_STATS_REQUEST:
2850 ofp_print_stats(string, oh);
2851 ofp_print_ofpst_port_desc_request(string, oh);
2854 case OFPTYPE_PORT_DESC_STATS_REPLY:
2855 ofp_print_stats(string, oh);
2856 ofp_print_ofpst_port_desc_reply(string, oh);
2859 case OFPTYPE_FLOW_MOD_TABLE_ID:
2860 ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
2863 case OFPTYPE_SET_FLOW_FORMAT:
2864 ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
2867 case OFPTYPE_SET_PACKET_IN_FORMAT:
2868 ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
2871 case OFPTYPE_FLOW_AGE:
2874 case OFPTYPE_SET_CONTROLLER_ID:
2875 ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
2878 case OFPTYPE_GET_ASYNC_REPLY:
2879 case OFPTYPE_SET_ASYNC_CONFIG:
2880 ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
2882 case OFPTYPE_GET_ASYNC_REQUEST:
2884 case OFPTYPE_FLOW_MONITOR_CANCEL:
2885 ofp_print_nxt_flow_monitor_cancel(string, msg);
2888 case OFPTYPE_FLOW_MONITOR_PAUSED:
2889 case OFPTYPE_FLOW_MONITOR_RESUMED:
2892 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
2893 ofp_print_nxst_flow_monitor_request(string, msg);
2896 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
2897 ofp_print_nxst_flow_monitor_reply(string, msg);
2900 case OFPTYPE_BUNDLE_CONTROL:
2901 ofp_print_bundle_ctrl(string, msg);
2904 case OFPTYPE_BUNDLE_ADD_MESSAGE:
2905 ofp_print_bundle_add(string, msg, verbosity);
2910 /* Composes and returns a string representing the OpenFlow packet of 'len'
2911 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
2912 * verbosity and higher numbers increase verbosity. The caller is responsible
2913 * for freeing the string. */
2915 ofp_to_string(const void *oh_, size_t len, int verbosity)
2917 struct ds string = DS_EMPTY_INITIALIZER;
2918 const struct ofp_header *oh = oh_;
2921 ds_put_cstr(&string, "OpenFlow message is empty\n");
2922 } else if (len < sizeof(struct ofp_header)) {
2923 ds_put_format(&string, "OpenFlow packet too short (only %"PRIuSIZE" bytes):\n",
2925 } else if (ntohs(oh->length) > len) {
2929 error = ofpraw_decode_partial(&raw, oh, len);
2931 ofp_header_to_string__(oh, raw, &string);
2932 ds_put_char(&string, '\n');
2935 ds_put_format(&string,
2936 "(***truncated to %"PRIuSIZE" bytes from %"PRIu16"***)\n",
2937 len, ntohs(oh->length));
2938 } else if (ntohs(oh->length) < len) {
2939 ds_put_format(&string,
2940 "(***only uses %"PRIu16" bytes out of %"PRIuSIZE"***)\n",
2941 ntohs(oh->length), len);
2946 error = ofpraw_decode(&raw, oh);
2948 ofp_to_string__(oh, raw, &string, verbosity);
2949 if (verbosity >= 5) {
2950 if (ds_last(&string) != '\n') {
2951 ds_put_char(&string, '\n');
2953 ds_put_hex_dump(&string, oh, len, 0, true);
2955 if (ds_last(&string) != '\n') {
2956 ds_put_char(&string, '\n');
2958 return ds_steal_cstr(&string);
2961 ofp_print_error(&string, error);
2963 ds_put_hex_dump(&string, oh, len, 0, true);
2964 return ds_steal_cstr(&string);
2968 print_and_free(FILE *stream, char *string)
2970 fputs(string, stream);
2974 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
2975 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
2976 * numbers increase verbosity. */
2978 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
2980 print_and_free(stream, ofp_to_string(oh, len, verbosity));
2983 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
2984 * 'data' to 'stream'. */
2986 ofp_print_packet(FILE *stream, const void *data, size_t len)
2988 print_and_free(stream, ofp_packet_to_string(data, len));