2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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.
21 #include <sys/types.h>
22 #include <netinet/in.h>
29 #include "byte-order.h"
32 #include "dp-packet.h"
35 #include "multipath.h"
39 #include "openflow/nicira-ext.h"
40 #include "openflow/openflow.h"
41 #include "openvswitch/dynamic-string.h"
42 #include "openvswitch/meta-flow.h"
43 #include "openvswitch/ofp-actions.h"
44 #include "openvswitch/ofp-errors.h"
45 #include "openvswitch/ofp-msgs.h"
46 #include "openvswitch/ofp-print.h"
47 #include "openvswitch/ofp-util.h"
48 #include "openvswitch/ofpbuf.h"
49 #include "openvswitch/type-props.h"
51 #include "unaligned.h"
55 static void ofp_print_queue_name(struct ds *string, uint32_t port);
56 static void ofp_print_error(struct ds *, enum ofperr);
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;
68 dp_packet_use_const(&buf, data, len);
69 flow_extract(&buf, &flow);
70 flow_format(&ds, &flow);
72 l4_size = dp_packet_l4_size(&buf);
74 if (flow.nw_proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
75 struct tcp_header *th = dp_packet_l4(&buf);
76 ds_put_format(&ds, " tcp_csum:%"PRIx16, ntohs(th->tcp_csum));
77 } else if (flow.nw_proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN) {
78 struct udp_header *uh = dp_packet_l4(&buf);
79 ds_put_format(&ds, " udp_csum:%"PRIx16, ntohs(uh->udp_csum));
80 } else if (flow.nw_proto == IPPROTO_SCTP && l4_size >= SCTP_HEADER_LEN) {
81 struct sctp_header *sh = dp_packet_l4(&buf);
82 ds_put_format(&ds, " sctp_csum:%"PRIx32,
83 ntohl(get_16aligned_be32(&sh->sctp_csum)));
84 } else if (flow.nw_proto == IPPROTO_ICMP && l4_size >= ICMP_HEADER_LEN) {
85 struct icmp_header *icmph = dp_packet_l4(&buf);
86 ds_put_format(&ds, " icmp_csum:%"PRIx16,
87 ntohs(icmph->icmp_csum));
88 } else if (flow.nw_proto == IPPROTO_ICMPV6 && l4_size >= ICMP6_HEADER_LEN) {
89 struct icmp6_header *icmp6h = dp_packet_l4(&buf);
90 ds_put_format(&ds, " icmp6_csum:%"PRIx16,
91 ntohs(icmp6h->icmp6_cksum));
94 ds_put_char(&ds, '\n');
100 format_hex_arg(struct ds *s, const uint8_t *data, size_t len)
102 for (size_t i = 0; i < len; i++) {
106 ds_put_format(s, "%02"PRIx8, data[i]);
111 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
114 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
115 struct ofputil_packet_in_private pin;
116 const struct ofputil_packet_in *public = &pin.public;
121 error = ofputil_decode_packet_in_private(oh, true,
122 &pin, &total_len, &buffer_id);
124 ofp_print_error(string, error);
128 if (public->table_id) {
129 ds_put_format(string, " table_id=%"PRIu8, public->table_id);
132 if (public->cookie != OVS_BE64_MAX) {
133 ds_put_format(string, " cookie=0x%"PRIx64, ntohll(public->cookie));
136 ds_put_format(string, " total_len=%"PRIuSIZE" ", total_len);
138 match_format(&public->flow_metadata, string, OFP_DEFAULT_PRIORITY);
140 ds_put_format(string, " (via %s)",
141 ofputil_packet_in_reason_to_string(public->reason,
145 ds_put_format(string, " data_len=%"PRIuSIZE, public->packet_len);
146 if (buffer_id == UINT32_MAX) {
147 ds_put_format(string, " (unbuffered)");
148 if (total_len != public->packet_len) {
149 ds_put_format(string, " (***total_len != data_len***)");
152 ds_put_format(string, " buffer=0x%08"PRIx32, buffer_id);
153 if (total_len < public->packet_len) {
154 ds_put_format(string, " (***total_len < data_len***)");
157 ds_put_char(string, '\n');
159 if (public->userdata_len) {
160 ds_put_cstr(string, " userdata=");
161 format_hex_arg(string, pin.public.userdata, pin.public.userdata_len);
162 ds_put_char(string, '\n');
165 if (!uuid_is_zero(&pin.bridge)) {
166 ds_put_format(string, " continuation.bridge="UUID_FMT"\n",
167 UUID_ARGS(&pin.bridge));
171 ds_put_cstr(string, " continuation.stack=");
172 for (size_t i = 0; i < pin.n_stack; i++) {
174 ds_put_char(string, ' ');
176 mf_subvalue_format(&pin.stack[i], string);
181 ds_put_format(string, " continuation.mirrors=0x%"PRIx32"\n",
185 if (pin.conntracked) {
186 ds_put_cstr(string, " continuation.conntracked=true\n");
189 if (pin.actions_len) {
190 ds_put_cstr(string, " continuation.actions=");
191 ofpacts_format(pin.actions, pin.actions_len, string);
192 ds_put_char(string, '\n');
195 if (pin.action_set_len) {
196 ds_put_cstr(string, " continuation.action_set=");
197 ofpacts_format(pin.action_set, pin.action_set_len, string);
198 ds_put_char(string, '\n');
202 char *packet = ofp_packet_to_string(public->packet,
204 ds_put_cstr(string, packet);
208 ds_put_hex_dump(string, public->packet, public->packet_len, 0, false);
211 ofputil_packet_in_private_destroy(&pin);
215 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
218 struct ofputil_packet_out po;
219 struct ofpbuf ofpacts;
222 ofpbuf_init(&ofpacts, 64);
223 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
225 ofpbuf_uninit(&ofpacts);
226 ofp_print_error(string, error);
230 ds_put_cstr(string, " in_port=");
231 ofputil_format_port(po.in_port, string);
233 ds_put_cstr(string, " actions=");
234 ofpacts_format(po.ofpacts, po.ofpacts_len, string);
236 if (po.buffer_id == UINT32_MAX) {
237 ds_put_format(string, " data_len=%"PRIuSIZE, po.packet_len);
238 if (verbosity > 0 && po.packet_len > 0) {
239 char *packet = ofp_packet_to_string(po.packet, po.packet_len);
240 ds_put_char(string, '\n');
241 ds_put_cstr(string, packet);
245 ds_put_hex_dump(string, po.packet, po.packet_len, 0, false);
248 ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
251 ofpbuf_uninit(&ofpacts);
254 /* qsort comparison function. */
256 compare_ports(const void *a_, const void *b_)
258 const struct ofputil_phy_port *a = a_;
259 const struct ofputil_phy_port *b = b_;
260 uint16_t ap = ofp_to_u16(a->port_no);
261 uint16_t bp = ofp_to_u16(b->port_no);
263 return ap < bp ? -1 : ap > bp;
267 ofp_print_bit_names(struct ds *string, uint32_t bits,
268 const char *(*bit_to_name)(uint32_t bit),
275 ds_put_cstr(string, "0");
279 for (i = 0; i < 32; i++) {
280 uint32_t bit = UINT32_C(1) << i;
283 const char *name = bit_to_name(bit);
286 ds_put_char(string, separator);
288 ds_put_cstr(string, name);
296 ds_put_char(string, separator);
298 ds_put_format(string, "0x%"PRIx32, bits);
303 netdev_feature_to_name(uint32_t bit)
305 enum netdev_features f = bit;
308 case NETDEV_F_10MB_HD: return "10MB-HD";
309 case NETDEV_F_10MB_FD: return "10MB-FD";
310 case NETDEV_F_100MB_HD: return "100MB-HD";
311 case NETDEV_F_100MB_FD: return "100MB-FD";
312 case NETDEV_F_1GB_HD: return "1GB-HD";
313 case NETDEV_F_1GB_FD: return "1GB-FD";
314 case NETDEV_F_10GB_FD: return "10GB-FD";
315 case NETDEV_F_40GB_FD: return "40GB-FD";
316 case NETDEV_F_100GB_FD: return "100GB-FD";
317 case NETDEV_F_1TB_FD: return "1TB-FD";
318 case NETDEV_F_OTHER: return "OTHER";
319 case NETDEV_F_COPPER: return "COPPER";
320 case NETDEV_F_FIBER: return "FIBER";
321 case NETDEV_F_AUTONEG: return "AUTO_NEG";
322 case NETDEV_F_PAUSE: return "AUTO_PAUSE";
323 case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
330 ofp_print_port_features(struct ds *string, enum netdev_features features)
332 ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
333 ds_put_char(string, '\n');
337 ofputil_port_config_to_name(uint32_t bit)
339 enum ofputil_port_config pc = bit;
342 case OFPUTIL_PC_PORT_DOWN: return "PORT_DOWN";
343 case OFPUTIL_PC_NO_STP: return "NO_STP";
344 case OFPUTIL_PC_NO_RECV: return "NO_RECV";
345 case OFPUTIL_PC_NO_RECV_STP: return "NO_RECV_STP";
346 case OFPUTIL_PC_NO_FLOOD: return "NO_FLOOD";
347 case OFPUTIL_PC_NO_FWD: return "NO_FWD";
348 case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
355 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
357 ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
358 ds_put_char(string, '\n');
362 ofputil_port_state_to_name(uint32_t bit)
364 enum ofputil_port_state ps = bit;
367 case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
368 case OFPUTIL_PS_BLOCKED: return "BLOCKED";
369 case OFPUTIL_PS_LIVE: return "LIVE";
371 case OFPUTIL_PS_STP_LISTEN:
372 case OFPUTIL_PS_STP_LEARN:
373 case OFPUTIL_PS_STP_FORWARD:
374 case OFPUTIL_PS_STP_BLOCK:
375 /* Handled elsewhere. */
383 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
385 enum ofputil_port_state stp_state;
387 /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
388 * pattern. We have to special case it.
390 * OVS doesn't support STP, so this field will always be 0 if we are
391 * talking to OVS, so we'd always print STP_LISTEN in that case.
392 * Therefore, we don't print anything at all if the value is STP_LISTEN, to
393 * avoid confusing users. */
394 stp_state = state & OFPUTIL_PS_STP_MASK;
397 (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
398 : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
400 state &= ~OFPUTIL_PS_STP_MASK;
402 ofp_print_bit_names(string, state, ofputil_port_state_to_name,
406 ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
408 ds_put_char(string, '\n');
412 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
414 char name[sizeof port->name];
417 memcpy(name, port->name, sizeof name);
418 for (j = 0; j < sizeof name - 1; j++) {
419 if (!isprint((unsigned char) name[j])) {
425 ds_put_char(string, ' ');
426 ofputil_format_port(port->port_no, string);
427 ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
428 name, ETH_ADDR_ARGS(port->hw_addr));
430 ds_put_cstr(string, " config: ");
431 ofp_print_port_config(string, port->config);
433 ds_put_cstr(string, " state: ");
434 ofp_print_port_state(string, port->state);
437 ds_put_format(string, " current: ");
438 ofp_print_port_features(string, port->curr);
440 if (port->advertised) {
441 ds_put_format(string, " advertised: ");
442 ofp_print_port_features(string, port->advertised);
444 if (port->supported) {
445 ds_put_format(string, " supported: ");
446 ofp_print_port_features(string, port->supported);
449 ds_put_format(string, " peer: ");
450 ofp_print_port_features(string, port->peer);
452 ds_put_format(string, " speed: %"PRIu32" Mbps now, "
453 "%"PRIu32" Mbps max\n",
454 port->curr_speed / UINT32_C(1000),
455 port->max_speed / UINT32_C(1000));
458 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
459 * 'ofp_version', writes a detailed description of each port into
462 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
465 struct ofputil_phy_port *ports;
466 size_t allocated_ports, n_ports;
472 for (n_ports = 0; ; n_ports++) {
473 if (n_ports >= allocated_ports) {
474 ports = x2nrealloc(ports, &allocated_ports, sizeof *ports);
477 retval = ofputil_pull_phy_port(ofp_version, b, &ports[n_ports]);
483 qsort(ports, n_ports, sizeof *ports, compare_ports);
484 for (i = 0; i < n_ports; i++) {
485 ofp_print_phy_port(string, &ports[i]);
490 ofp_print_error(string, retval);
495 ofputil_capabilities_to_name(uint32_t bit)
497 enum ofputil_capabilities capabilities = bit;
499 switch (capabilities) {
500 case OFPUTIL_C_FLOW_STATS: return "FLOW_STATS";
501 case OFPUTIL_C_TABLE_STATS: return "TABLE_STATS";
502 case OFPUTIL_C_PORT_STATS: return "PORT_STATS";
503 case OFPUTIL_C_IP_REASM: return "IP_REASM";
504 case OFPUTIL_C_QUEUE_STATS: return "QUEUE_STATS";
505 case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
506 case OFPUTIL_C_STP: return "STP";
507 case OFPUTIL_C_GROUP_STATS: return "GROUP_STATS";
508 case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
515 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
517 struct ofputil_switch_features features;
518 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
519 enum ofperr error = ofputil_pull_switch_features(&b, &features);
521 ofp_print_error(string, error);
525 ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
527 ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32,
528 features.n_tables, features.n_buffers);
529 if (features.auxiliary_id) {
530 ds_put_format(string, ", auxiliary_id:%"PRIu8, features.auxiliary_id);
532 ds_put_char(string, '\n');
534 ds_put_cstr(string, "capabilities: ");
535 ofp_print_bit_names(string, features.capabilities,
536 ofputil_capabilities_to_name, ' ');
537 ds_put_char(string, '\n');
539 switch ((enum ofp_version)oh->version) {
541 ds_put_cstr(string, "actions: ");
542 ofpact_bitmap_format(features.ofpacts, string);
543 ds_put_char(string, '\n');
552 return; /* no ports in ofp13_switch_features */
557 ofp_print_phy_ports(string, oh->version, &b);
561 ofp_print_switch_config(struct ds *string,
562 const struct ofputil_switch_config *config)
564 ds_put_format(string, " frags=%s",
565 ofputil_frag_handling_to_string(config->frag));
567 if (config->invalid_ttl_to_controller > 0) {
568 ds_put_format(string, " invalid_ttl_to_controller");
571 ds_put_format(string, " miss_send_len=%"PRIu16"\n", config->miss_send_len);
575 ofp_print_set_config(struct ds *string, const struct ofp_header *oh)
577 struct ofputil_switch_config config;
580 error = ofputil_decode_set_config(oh, &config);
582 ofp_print_error(string, error);
585 ofp_print_switch_config(string, &config);
589 ofp_print_get_config_reply(struct ds *string, const struct ofp_header *oh)
591 struct ofputil_switch_config config;
592 ofputil_decode_get_config_reply(oh, &config);
593 ofp_print_switch_config(string, &config);
596 static void print_wild(struct ds *string, const char *leader, int is_wild,
597 int verbosity, const char *format, ...)
598 OVS_PRINTF_FORMAT(5, 6);
600 static void print_wild(struct ds *string, const char *leader, int is_wild,
601 int verbosity, const char *format, ...)
603 if (is_wild && verbosity < 2) {
606 ds_put_cstr(string, leader);
610 va_start(args, format);
611 ds_put_format_valist(string, format, args);
614 ds_put_char(string, '*');
616 ds_put_char(string, ',');
620 print_wild_port(struct ds *string, const char *leader, int is_wild,
621 int verbosity, ofp_port_t port)
623 if (is_wild && verbosity < 2) {
626 ds_put_cstr(string, leader);
628 ofputil_format_port(port, string);
630 ds_put_char(string, '*');
632 ds_put_char(string, ',');
636 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
637 uint32_t wild_bits, int verbosity)
639 if (wild_bits >= 32 && verbosity < 2) {
642 ds_put_cstr(string, leader);
643 if (wild_bits < 32) {
644 ds_put_format(string, IP_FMT, IP_ARGS(ip));
646 ds_put_format(string, "/%d", 32 - wild_bits);
649 ds_put_char(string, '*');
651 ds_put_char(string, ',');
655 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
657 char *s = ofp10_match_to_string(om, verbosity);
663 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
665 struct ds f = DS_EMPTY_INITIALIZER;
666 uint32_t w = ntohl(om->wildcards);
667 bool skip_type = false;
668 bool skip_proto = false;
670 if (!(w & OFPFW10_DL_TYPE)) {
672 if (om->dl_type == htons(ETH_TYPE_IP)) {
673 if (!(w & OFPFW10_NW_PROTO)) {
675 if (om->nw_proto == IPPROTO_ICMP) {
676 ds_put_cstr(&f, "icmp,");
677 } else if (om->nw_proto == IPPROTO_TCP) {
678 ds_put_cstr(&f, "tcp,");
679 } else if (om->nw_proto == IPPROTO_UDP) {
680 ds_put_cstr(&f, "udp,");
681 } else if (om->nw_proto == IPPROTO_SCTP) {
682 ds_put_cstr(&f, "sctp,");
684 ds_put_cstr(&f, "ip,");
688 ds_put_cstr(&f, "ip,");
690 } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
691 ds_put_cstr(&f, "arp,");
692 } else if (om->dl_type == htons(ETH_TYPE_RARP)){
693 ds_put_cstr(&f, "rarp,");
694 } else if (om->dl_type == htons(ETH_TYPE_MPLS)) {
695 ds_put_cstr(&f, "mpls,");
696 } else if (om->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
697 ds_put_cstr(&f, "mplsm,");
702 print_wild_port(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
703 u16_to_ofp(ntohs(om->in_port)));
704 print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
705 "%d", ntohs(om->dl_vlan));
706 print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
707 "%d", om->dl_vlan_pcp);
708 print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
709 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
710 print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
711 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
713 print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
714 "0x%04x", ntohs(om->dl_type));
716 print_ip_netmask(&f, "nw_src=", om->nw_src,
717 (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
719 print_ip_netmask(&f, "nw_dst=", om->nw_dst,
720 (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
723 if (om->dl_type == htons(ETH_TYPE_ARP) ||
724 om->dl_type == htons(ETH_TYPE_RARP)) {
725 print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
728 print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
732 print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
734 if (om->nw_proto == IPPROTO_ICMP) {
735 print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
736 "%d", ntohs(om->tp_src));
737 print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
738 "%d", ntohs(om->tp_dst));
740 print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
741 "%d", ntohs(om->tp_src));
742 print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
743 "%d", ntohs(om->tp_dst));
750 ofp_print_flow_flags(struct ds *s, enum ofputil_flow_mod_flags flags)
752 if (flags & OFPUTIL_FF_SEND_FLOW_REM) {
753 ds_put_cstr(s, "send_flow_rem ");
755 if (flags & OFPUTIL_FF_CHECK_OVERLAP) {
756 ds_put_cstr(s, "check_overlap ");
758 if (flags & OFPUTIL_FF_RESET_COUNTS) {
759 ds_put_cstr(s, "reset_counts ");
761 if (flags & OFPUTIL_FF_NO_PKT_COUNTS) {
762 ds_put_cstr(s, "no_packet_counts ");
764 if (flags & OFPUTIL_FF_NO_BYT_COUNTS) {
765 ds_put_cstr(s, "no_byte_counts ");
767 if (flags & OFPUTIL_FF_HIDDEN_FIELDS) {
768 ds_put_cstr(s, "allow_hidden_fields ");
770 if (flags & OFPUTIL_FF_NO_READONLY) {
771 ds_put_cstr(s, "no_readonly_table ");
776 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
778 struct ofputil_flow_mod fm;
779 struct ofpbuf ofpacts;
783 enum ofputil_protocol protocol;
785 protocol = ofputil_protocol_from_ofp_version(oh->version);
786 protocol = ofputil_protocol_set_tid(protocol, true);
788 ofpbuf_init(&ofpacts, 64);
789 error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts,
792 ofpbuf_uninit(&ofpacts);
793 ofp_print_error(s, error);
798 switch (fm.command) {
800 ds_put_cstr(s, "ADD");
803 ds_put_cstr(s, "MOD");
805 case OFPFC_MODIFY_STRICT:
806 ds_put_cstr(s, "MOD_STRICT");
809 ds_put_cstr(s, "DEL");
811 case OFPFC_DELETE_STRICT:
812 ds_put_cstr(s, "DEL_STRICT");
815 ds_put_format(s, "cmd:%d", fm.command);
817 if (fm.table_id != 0) {
818 ds_put_format(s, " table:%d", fm.table_id);
822 ofpraw_decode(&raw, oh);
823 if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
824 const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
825 ofp10_match_print(s, &ofm->match, verbosity);
827 /* ofp_print_match() doesn't print priority. */
828 need_priority = true;
829 } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
830 const struct nx_flow_mod *nfm = ofpmsg_body(oh);
831 const void *nxm = nfm + 1;
834 nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
835 ds_put_cstr(s, nxm_s);
838 /* nx_match_to_string() doesn't print priority. */
839 need_priority = true;
841 match_format(&fm.match, s, fm.priority);
843 /* match_format() does print priority. */
844 need_priority = false;
847 if (ds_last(s) != ' ') {
850 if (fm.new_cookie != htonll(0) && fm.new_cookie != OVS_BE64_MAX) {
851 ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
853 if (fm.cookie_mask != htonll(0)) {
854 ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
855 ntohll(fm.cookie), ntohll(fm.cookie_mask));
857 if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
858 ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
860 if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
861 ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
863 if (fm.importance != 0) {
864 ds_put_format(s, "importance:%"PRIu16" ", fm.importance);
866 if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
867 ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
869 if (fm.buffer_id != UINT32_MAX) {
870 ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
872 if (fm.out_port != OFPP_ANY) {
873 ds_put_format(s, "out_port:");
874 ofputil_format_port(fm.out_port, s);
878 if (oh->version == OFP10_VERSION || oh->version == OFP11_VERSION) {
879 /* Don't print the reset_counts flag for OF1.0 and OF1.1 because those
880 * versions don't really have such a flag and printing one is likely to
882 fm.flags &= ~OFPUTIL_FF_RESET_COUNTS;
884 ofp_print_flow_flags(s, fm.flags);
886 ds_put_cstr(s, "actions=");
887 ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
888 ofpbuf_uninit(&ofpacts);
892 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
894 ds_put_format(string, "%u", sec);
896 /* If there are no fractional seconds, don't print any decimals.
898 * If the fractional seconds can be expressed exactly as milliseconds,
899 * print 3 decimals. Open vSwitch provides millisecond precision for most
900 * time measurements, so printing 3 decimals every time makes it easier to
901 * spot real changes in flow dumps that refresh themselves quickly.
903 * If the fractional seconds are more precise than milliseconds, print the
904 * number of decimals needed to express them exactly.
907 unsigned int msec = nsec / 1000000;
908 if (msec * 1000000 == nsec) {
909 ds_put_format(string, ".%03u", msec);
911 ds_put_format(string, ".%09u", nsec);
912 while (string->string[string->length - 1] == '0') {
917 ds_put_char(string, 's');
920 /* Returns a string form of 'reason'. The return value is either a statically
921 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
922 * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
923 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
925 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason,
926 char *reasonbuf, size_t bufsize)
929 case OFPRR_IDLE_TIMEOUT:
931 case OFPRR_HARD_TIMEOUT:
935 case OFPRR_GROUP_DELETE:
936 return "group_delete";
939 case OFPRR_METER_DELETE:
940 return "meter_delete";
943 snprintf(reasonbuf, bufsize, "%d", (int) reason);
949 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
951 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
952 struct ofputil_flow_removed fr;
955 error = ofputil_decode_flow_removed(&fr, oh);
957 ofp_print_error(string, error);
961 ds_put_char(string, ' ');
962 match_format(&fr.match, string, fr.priority);
964 ds_put_format(string, " reason=%s",
965 ofp_flow_removed_reason_to_string(fr.reason, reasonbuf,
968 if (fr.table_id != 255) {
969 ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
972 if (fr.cookie != htonll(0)) {
973 ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
975 ds_put_cstr(string, " duration");
976 ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
977 ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
978 if (fr.hard_timeout) {
979 /* The hard timeout was only added in OF1.2, so only print it if it is
980 * actually in use to avoid gratuitous change to the formatting. */
981 ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
983 ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
984 fr.packet_count, fr.byte_count);
988 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
990 struct ofputil_port_mod pm;
993 error = ofputil_decode_port_mod(oh, &pm, true);
995 ofp_print_error(string, error);
999 ds_put_cstr(string, " port: ");
1000 ofputil_format_port(pm.port_no, string);
1001 ds_put_format(string, ": addr:"ETH_ADDR_FMT"\n",
1002 ETH_ADDR_ARGS(pm.hw_addr));
1004 ds_put_cstr(string, " config: ");
1005 ofp_print_port_config(string, pm.config);
1007 ds_put_cstr(string, " mask: ");
1008 ofp_print_port_config(string, pm.mask);
1010 ds_put_cstr(string, " advertise: ");
1012 ofp_print_port_features(string, pm.advertise);
1014 ds_put_cstr(string, "UNCHANGED\n");
1019 ofputil_table_miss_to_string(enum ofputil_table_miss miss)
1022 case OFPUTIL_TABLE_MISS_DEFAULT: return "default";
1023 case OFPUTIL_TABLE_MISS_CONTROLLER: return "controller";
1024 case OFPUTIL_TABLE_MISS_CONTINUE: return "continue";
1025 case OFPUTIL_TABLE_MISS_DROP: return "drop";
1026 default: return "***error***";
1031 ofputil_table_eviction_to_string(enum ofputil_table_eviction eviction)
1034 case OFPUTIL_TABLE_EVICTION_DEFAULT: return "default";
1035 case OFPUTIL_TABLE_EVICTION_ON: return "on";
1036 case OFPUTIL_TABLE_EVICTION_OFF: return "off";
1037 default: return "***error***";
1043 ofputil_eviction_flag_to_string(uint32_t bit)
1045 enum ofp14_table_mod_prop_eviction_flag eviction_flag = bit;
1047 switch (eviction_flag) {
1048 case OFPTMPEF14_OTHER: return "OTHER";
1049 case OFPTMPEF14_IMPORTANCE: return "IMPORTANCE";
1050 case OFPTMPEF14_LIFETIME: return "LIFETIME";
1056 /* Appends to 'string' a description of the bitmap of OFPTMPEF14_* values in
1057 * 'eviction_flags'. */
1059 ofputil_put_eviction_flags(struct ds *string, uint32_t eviction_flags)
1061 if (eviction_flags != UINT32_MAX) {
1062 ofp_print_bit_names(string, eviction_flags,
1063 ofputil_eviction_flag_to_string, '|');
1065 ds_put_cstr(string, "(default)");
1070 ofputil_table_vacancy_to_string(enum ofputil_table_vacancy vacancy)
1073 case OFPUTIL_TABLE_VACANCY_DEFAULT: return "default";
1074 case OFPUTIL_TABLE_VACANCY_ON: return "on";
1075 case OFPUTIL_TABLE_VACANCY_OFF: return "off";
1076 default: return "***error***";
1082 ofp_print_table_mod(struct ds *string, const struct ofp_header *oh)
1084 struct ofputil_table_mod pm;
1087 error = ofputil_decode_table_mod(oh, &pm);
1089 ofp_print_error(string, error);
1093 if (pm.table_id == 0xff) {
1094 ds_put_cstr(string, " table_id: ALL_TABLES");
1096 ds_put_format(string, " table_id=%"PRIu8, pm.table_id);
1099 if (pm.miss != OFPUTIL_TABLE_MISS_DEFAULT) {
1100 ds_put_format(string, ", flow_miss_config=%s",
1101 ofputil_table_miss_to_string(pm.miss));
1103 if (pm.eviction != OFPUTIL_TABLE_EVICTION_DEFAULT) {
1104 ds_put_format(string, ", eviction=%s",
1105 ofputil_table_eviction_to_string(pm.eviction));
1107 if (pm.eviction_flags != UINT32_MAX) {
1108 ds_put_cstr(string, "eviction_flags=");
1109 ofputil_put_eviction_flags(string, pm.eviction_flags);
1111 if (pm.vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
1112 ds_put_format(string, ", vacancy=%s",
1113 ofputil_table_vacancy_to_string(pm.vacancy));
1114 if (pm.vacancy == OFPUTIL_TABLE_VACANCY_ON) {
1115 ds_put_format(string, " vacancy:%"PRIu8""
1116 ",%"PRIu8"", pm.table_vacancy.vacancy_down,
1117 pm.table_vacancy.vacancy_up);
1122 /* This function will print the Table description properties. */
1124 ofp_print_table_desc(struct ds *string, const struct ofputil_table_desc *td)
1126 ds_put_format(string, "\n table %"PRIu8, td->table_id);
1127 ds_put_cstr(string, ":\n");
1128 ds_put_format(string, " eviction=%s eviction_flags=",
1129 ofputil_table_eviction_to_string(td->eviction));
1130 ofputil_put_eviction_flags(string, td->eviction_flags);
1131 ds_put_char(string, '\n');
1132 ds_put_format(string, " vacancy=%s",
1133 ofputil_table_vacancy_to_string(td->vacancy));
1134 if (td->vacancy == OFPUTIL_TABLE_VACANCY_ON) {
1135 ds_put_format(string, " vacancy_down=%"PRIu8"%%",
1136 td->table_vacancy.vacancy_down);
1137 ds_put_format(string, " vacancy_up=%"PRIu8"%%",
1138 td->table_vacancy.vacancy_up);
1139 ds_put_format(string, " vacancy=%"PRIu8"%%",
1140 td->table_vacancy.vacancy);
1142 ds_put_char(string, '\n');
1146 ofp_print_table_status_message(struct ds *string, const struct ofp_header *oh)
1148 struct ofputil_table_status ts;
1151 error = ofputil_decode_table_status(oh, &ts);
1153 ofp_print_error(string, error);
1157 if (ts.reason == OFPTR_VACANCY_DOWN) {
1158 ds_put_format(string, " reason=VACANCY_DOWN");
1159 } else if (ts.reason == OFPTR_VACANCY_UP) {
1160 ds_put_format(string, " reason=VACANCY_UP");
1163 ds_put_format(string, "\ntable_desc:-");
1164 ofp_print_table_desc(string, &ts.desc);
1168 ofp_print_queue_get_config_request(struct ds *string,
1169 const struct ofp_header *oh)
1175 error = ofputil_decode_queue_get_config_request(oh, &port, &queue);
1177 ofp_print_error(string, error);
1181 ds_put_cstr(string, " port=");
1182 ofputil_format_port(port, string);
1184 if (queue != OFPQ_ALL) {
1185 ds_put_cstr(string, " queue=");
1186 ofp_print_queue_name(string, queue);
1191 print_queue_rate(struct ds *string, const char *name, unsigned int rate)
1194 ds_put_format(string, " %s:%u.%u%%", name, rate / 10, rate % 10);
1195 } else if (rate < UINT16_MAX) {
1196 ds_put_format(string, " %s:(disabled)", name);
1201 ofp_print_queue_get_config_reply(struct ds *string,
1202 const struct ofp_header *oh)
1204 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1205 ofp_port_t port = 0;
1207 ds_put_char(string, ' ');
1209 struct ofputil_queue_config queue;
1212 retval = ofputil_pull_queue_get_config_reply(&b, &queue);
1214 if (retval != EOF) {
1215 ofp_print_error(string, retval);
1217 ds_chomp(string, ' ');
1221 if (queue.port != port) {
1224 ds_put_cstr(string, "port=");
1225 ofputil_format_port(port, string);
1226 ds_put_char(string, '\n');
1229 ds_put_format(string, "queue %"PRIu32":", queue.queue);
1230 print_queue_rate(string, "min_rate", queue.min_rate);
1231 print_queue_rate(string, "max_rate", queue.max_rate);
1232 ds_put_char(string, '\n');
1237 ofp_print_meter_flags(struct ds *s, uint16_t flags)
1239 if (flags & OFPMF13_KBPS) {
1240 ds_put_cstr(s, "kbps ");
1242 if (flags & OFPMF13_PKTPS) {
1243 ds_put_cstr(s, "pktps ");
1245 if (flags & OFPMF13_BURST) {
1246 ds_put_cstr(s, "burst ");
1248 if (flags & OFPMF13_STATS) {
1249 ds_put_cstr(s, "stats ");
1252 flags &= ~(OFPMF13_KBPS | OFPMF13_PKTPS | OFPMF13_BURST | OFPMF13_STATS);
1254 ds_put_format(s, "flags:0x%"PRIx16" ", flags);
1259 ofp_print_meter_band(struct ds *s, uint16_t flags,
1260 const struct ofputil_meter_band *mb)
1262 ds_put_cstr(s, "\ntype=");
1265 ds_put_cstr(s, "drop");
1267 case OFPMBT13_DSCP_REMARK:
1268 ds_put_cstr(s, "dscp_remark");
1271 ds_put_format(s, "%u", mb->type);
1274 ds_put_format(s, " rate=%"PRIu32, mb->rate);
1276 if (flags & OFPMF13_BURST) {
1277 ds_put_format(s, " burst_size=%"PRIu32, mb->burst_size);
1279 if (mb->type == OFPMBT13_DSCP_REMARK) {
1280 ds_put_format(s, " prec_level=%"PRIu8, mb->prec_level);
1285 ofp_print_meter_stats(struct ds *s, const struct ofputil_meter_stats *ms)
1289 ds_put_format(s, "meter:%"PRIu32" ", ms->meter_id);
1290 ds_put_format(s, "flow_count:%"PRIu32" ", ms->flow_count);
1291 ds_put_format(s, "packet_in_count:%"PRIu64" ", ms->packet_in_count);
1292 ds_put_format(s, "byte_in_count:%"PRIu64" ", ms->byte_in_count);
1293 ds_put_cstr(s, "duration:");
1294 ofp_print_duration(s, ms->duration_sec, ms->duration_nsec);
1295 ds_put_char(s, ' ');
1297 ds_put_cstr(s, "bands:\n");
1298 for (i = 0; i < ms->n_bands; ++i) {
1299 ds_put_format(s, "%d: ", i);
1300 ds_put_format(s, "packet_count:%"PRIu64" ", ms->bands[i].packet_count);
1301 ds_put_format(s, "byte_count:%"PRIu64"\n", ms->bands[i].byte_count);
1306 ofp_print_meter_config(struct ds *s, const struct ofputil_meter_config *mc)
1310 ds_put_format(s, "meter=%"PRIu32" ", mc->meter_id);
1312 ofp_print_meter_flags(s, mc->flags);
1314 ds_put_cstr(s, "bands=");
1315 for (i = 0; i < mc->n_bands; ++i) {
1316 ofp_print_meter_band(s, mc->flags, &mc->bands[i]);
1318 ds_put_char(s, '\n');
1322 ofp_print_meter_mod__(struct ds *s, const struct ofputil_meter_mod *mm)
1324 switch (mm->command) {
1326 ds_put_cstr(s, " ADD ");
1328 case OFPMC13_MODIFY:
1329 ds_put_cstr(s, " MOD ");
1331 case OFPMC13_DELETE:
1332 ds_put_cstr(s, " DEL ");
1335 ds_put_format(s, " cmd:%d ", mm->command);
1338 ofp_print_meter_config(s, &mm->meter);
1342 ofp_print_meter_mod(struct ds *s, const struct ofp_header *oh)
1344 struct ofputil_meter_mod mm;
1345 struct ofpbuf bands;
1348 ofpbuf_init(&bands, 64);
1349 error = ofputil_decode_meter_mod(oh, &mm, &bands);
1351 ofp_print_error(s, error);
1353 ofp_print_meter_mod__(s, &mm);
1355 ofpbuf_uninit(&bands);
1359 ofp_print_meter_stats_request(struct ds *s, const struct ofp_header *oh)
1363 ofputil_decode_meter_request(oh, &meter_id);
1365 ds_put_format(s, " meter=%"PRIu32, meter_id);
1369 ofputil_meter_capabilities_to_name(uint32_t bit)
1371 enum ofp13_meter_flags flag = bit;
1374 case OFPMF13_KBPS: return "kbps";
1375 case OFPMF13_PKTPS: return "pktps";
1376 case OFPMF13_BURST: return "burst";
1377 case OFPMF13_STATS: return "stats";
1384 ofputil_meter_band_types_to_name(uint32_t bit)
1387 case 1 << OFPMBT13_DROP: return "drop";
1388 case 1 << OFPMBT13_DSCP_REMARK: return "dscp_remark";
1395 ofp_print_meter_features_reply(struct ds *s, const struct ofp_header *oh)
1397 struct ofputil_meter_features mf;
1399 ofputil_decode_meter_features(oh, &mf);
1401 ds_put_format(s, "\nmax_meter:%"PRIu32, mf.max_meters);
1402 ds_put_format(s, " max_bands:%"PRIu8, mf.max_bands);
1403 ds_put_format(s, " max_color:%"PRIu8"\n", mf.max_color);
1405 ds_put_cstr(s, "band_types: ");
1406 ofp_print_bit_names(s, mf.band_types,
1407 ofputil_meter_band_types_to_name, ' ');
1408 ds_put_char(s, '\n');
1410 ds_put_cstr(s, "capabilities: ");
1411 ofp_print_bit_names(s, mf.capabilities,
1412 ofputil_meter_capabilities_to_name, ' ');
1413 ds_put_char(s, '\n');
1417 ofp_print_meter_config_reply(struct ds *s, const struct ofp_header *oh)
1419 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1420 struct ofpbuf bands;
1422 ofpbuf_init(&bands, 64);
1424 struct ofputil_meter_config mc;
1427 retval = ofputil_decode_meter_config(&b, &mc, &bands);
1429 if (retval != EOF) {
1430 ofp_print_error(s, retval);
1434 ds_put_char(s, '\n');
1435 ofp_print_meter_config(s, &mc);
1437 ofpbuf_uninit(&bands);
1441 ofp_print_meter_stats_reply(struct ds *s, const struct ofp_header *oh)
1443 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1444 struct ofpbuf bands;
1446 ofpbuf_init(&bands, 64);
1448 struct ofputil_meter_stats ms;
1451 retval = ofputil_decode_meter_stats(&b, &ms, &bands);
1453 if (retval != EOF) {
1454 ofp_print_error(s, retval);
1458 ds_put_char(s, '\n');
1459 ofp_print_meter_stats(s, &ms);
1461 ofpbuf_uninit(&bands);
1465 ofp_print_error(struct ds *string, enum ofperr error)
1467 if (string->length) {
1468 ds_put_char(string, ' ');
1470 ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1474 ofp_print_hello(struct ds *string, const struct ofp_header *oh)
1476 uint32_t allowed_versions;
1479 ok = ofputil_decode_hello(oh, &allowed_versions);
1481 ds_put_cstr(string, "\n version bitmap: ");
1482 ofputil_format_version_bitmap(string, allowed_versions);
1485 ds_put_cstr(string, "\n unknown data in hello:\n");
1486 ds_put_hex_dump(string, oh, ntohs(oh->length), 0, true);
1491 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
1493 size_t len = ntohs(oh->length);
1494 struct ofpbuf payload;
1498 error = ofperr_decode_msg(oh, &payload);
1500 ds_put_cstr(string, "***decode error***");
1501 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1505 ds_put_format(string, " %s\n", ofperr_get_name(error));
1507 if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
1508 ds_put_printable(string, payload.data, payload.size);
1510 s = ofp_to_string(payload.data, payload.size, 1);
1511 ds_put_cstr(string, s);
1514 ofpbuf_uninit(&payload);
1518 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
1520 struct ofputil_port_status ps;
1523 error = ofputil_decode_port_status(oh, &ps);
1525 ofp_print_error(string, error);
1529 if (ps.reason == OFPPR_ADD) {
1530 ds_put_format(string, " ADD:");
1531 } else if (ps.reason == OFPPR_DELETE) {
1532 ds_put_format(string, " DEL:");
1533 } else if (ps.reason == OFPPR_MODIFY) {
1534 ds_put_format(string, " MOD:");
1537 ofp_print_phy_port(string, &ps.desc);
1541 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1543 const struct ofp_desc_stats *ods = ofpmsg_body(oh);
1545 ds_put_char(string, '\n');
1546 ds_put_format(string, "Manufacturer: %.*s\n",
1547 (int) sizeof ods->mfr_desc, ods->mfr_desc);
1548 ds_put_format(string, "Hardware: %.*s\n",
1549 (int) sizeof ods->hw_desc, ods->hw_desc);
1550 ds_put_format(string, "Software: %.*s\n",
1551 (int) sizeof ods->sw_desc, ods->sw_desc);
1552 ds_put_format(string, "Serial Num: %.*s\n",
1553 (int) sizeof ods->serial_num, ods->serial_num);
1554 ds_put_format(string, "DP Description: %.*s\n",
1555 (int) sizeof ods->dp_desc, ods->dp_desc);
1559 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1561 struct ofputil_flow_stats_request fsr;
1564 error = ofputil_decode_flow_stats_request(&fsr, oh);
1566 ofp_print_error(string, error);
1570 if (fsr.table_id != 0xff) {
1571 ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1574 if (fsr.out_port != OFPP_ANY) {
1575 ds_put_cstr(string, " out_port=");
1576 ofputil_format_port(fsr.out_port, string);
1579 ds_put_char(string, ' ');
1580 match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
1584 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1586 ds_put_format(string, " %scookie=%s0x%"PRIx64", %sduration=%s",
1587 colors.param, colors.end, ntohll(fs->cookie),
1588 colors.param, colors.end);
1590 ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1591 ds_put_format(string, ", %stable=%s%"PRIu8", ",
1592 colors.special, colors.end, fs->table_id);
1593 ds_put_format(string, "%sn_packets=%s%"PRIu64", ",
1594 colors.param, colors.end, fs->packet_count);
1595 ds_put_format(string, "%sn_bytes=%s%"PRIu64", ",
1596 colors.param, colors.end, fs->byte_count);
1597 if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1598 ds_put_format(string, "%sidle_timeout=%s%"PRIu16", ",
1599 colors.param, colors.end, fs->idle_timeout);
1601 if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1602 ds_put_format(string, "%shard_timeout=%s%"PRIu16", ",
1603 colors.param, colors.end, fs->hard_timeout);
1606 ofp_print_flow_flags(string, fs->flags);
1608 if (fs->importance != 0) {
1609 ds_put_format(string, "%simportance=%s%"PRIu16", ",
1610 colors.param, colors.end, fs->importance);
1612 if (fs->idle_age >= 0) {
1613 ds_put_format(string, "%sidle_age=%s%d, ",
1614 colors.param, colors.end, fs->idle_age);
1616 if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1617 ds_put_format(string, "%shard_age=%s%d, ",
1618 colors.param, colors.end, fs->hard_age);
1621 match_format(&fs->match, string, fs->priority);
1622 if (string->string[string->length - 1] != ' ') {
1623 ds_put_char(string, ' ');
1626 ds_put_format(string, "%sactions=%s", colors.actions, colors.end);
1627 ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1631 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1633 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1634 struct ofpbuf ofpacts;
1636 ofpbuf_init(&ofpacts, 64);
1638 struct ofputil_flow_stats fs;
1641 retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1643 if (retval != EOF) {
1644 ds_put_cstr(string, " ***parse error***");
1648 ds_put_char(string, '\n');
1649 ofp_print_flow_stats(string, &fs);
1651 ofpbuf_uninit(&ofpacts);
1655 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1657 struct ofputil_aggregate_stats as;
1660 error = ofputil_decode_aggregate_stats_reply(&as, oh);
1662 ofp_print_error(string, error);
1666 ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1667 ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1668 ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1672 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1674 ds_put_cstr(string, leader);
1675 if (stat != UINT64_MAX) {
1676 ds_put_format(string, "%"PRIu64, stat);
1678 ds_put_char(string, '?');
1681 ds_put_cstr(string, ", ");
1683 ds_put_cstr(string, "\n");
1688 print_port_stat_cond(struct ds *string, const char *leader, uint64_t stat)
1690 if (stat != UINT64_MAX) {
1691 ds_put_format(string, "%s%"PRIu64", ", leader, stat);
1696 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1698 ofp_port_t ofp10_port;
1701 error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1703 ofp_print_error(string, error);
1707 ds_put_cstr(string, " port_no=");
1708 ofputil_format_port(ofp10_port, string);
1712 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1715 ds_put_format(string, " %"PRIuSIZE" ports\n", ofputil_count_port_stats(oh));
1716 if (verbosity < 1) {
1720 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1722 struct ofputil_port_stats ps;
1725 retval = ofputil_decode_port_stats(&ps, &b);
1727 if (retval != EOF) {
1728 ds_put_cstr(string, " ***parse error***");
1733 ds_put_cstr(string, " port ");
1734 if (ofp_to_u16(ps.port_no) < 10) {
1735 ds_put_char(string, ' ');
1737 ofputil_format_port(ps.port_no, string);
1739 ds_put_cstr(string, ": rx ");
1740 print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1741 print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1742 print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1743 print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1744 print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1745 print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1746 print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1748 ds_put_cstr(string, " tx ");
1749 print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1750 print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1751 print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1752 print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1753 print_port_stat(string, "coll=", ps.stats.collisions, 0);
1755 if (ps.duration_sec != UINT32_MAX) {
1756 ds_put_cstr(string, " duration=");
1757 ofp_print_duration(string, ps.duration_sec, ps.duration_nsec);
1758 ds_put_char(string, '\n');
1760 struct ds string_ext_stats = DS_EMPTY_INITIALIZER;
1762 ds_init(&string_ext_stats);
1764 print_port_stat_cond(&string_ext_stats, "1_to_64_packets=",
1765 ps.stats.rx_1_to_64_packets);
1766 print_port_stat_cond(&string_ext_stats, "65_to_127_packets=",
1767 ps.stats.rx_65_to_127_packets);
1768 print_port_stat_cond(&string_ext_stats, "128_to_255_packets=",
1769 ps.stats.rx_128_to_255_packets);
1770 print_port_stat_cond(&string_ext_stats, "256_to_511_packets=",
1771 ps.stats.rx_256_to_511_packets);
1772 print_port_stat_cond(&string_ext_stats, "512_to_1023_packets=",
1773 ps.stats.rx_512_to_1023_packets);
1774 print_port_stat_cond(&string_ext_stats, "1024_to_1522_packets=",
1775 ps.stats.rx_1024_to_1522_packets);
1776 print_port_stat_cond(&string_ext_stats, "1523_to_max_packets=",
1777 ps.stats.rx_1523_to_max_packets);
1778 print_port_stat_cond(&string_ext_stats, "broadcast_packets=",
1779 ps.stats.rx_broadcast_packets);
1780 print_port_stat_cond(&string_ext_stats, "undersized_errors=",
1781 ps.stats.rx_undersized_errors);
1782 print_port_stat_cond(&string_ext_stats, "oversize_errors=",
1783 ps.stats.rx_oversize_errors);
1784 print_port_stat_cond(&string_ext_stats, "rx_fragmented_errors=",
1785 ps.stats.rx_fragmented_errors);
1786 print_port_stat_cond(&string_ext_stats, "rx_jabber_errors=",
1787 ps.stats.rx_jabber_errors);
1789 if (string_ext_stats.length != 0) {
1790 /* If at least one statistics counter is reported: */
1791 ds_put_cstr(string, " rx rfc2819 ");
1792 ds_put_buffer(string, string_ext_stats.string,
1793 string_ext_stats.length);
1794 ds_put_cstr(string, "\n");
1795 ds_destroy(&string_ext_stats);
1798 ds_init(&string_ext_stats);
1800 print_port_stat_cond(&string_ext_stats, "1_to_64_packets=",
1801 ps.stats.tx_1_to_64_packets);
1802 print_port_stat_cond(&string_ext_stats, "65_to_127_packets=",
1803 ps.stats.tx_65_to_127_packets);
1804 print_port_stat_cond(&string_ext_stats, "128_to_255_packets=",
1805 ps.stats.tx_128_to_255_packets);
1806 print_port_stat_cond(&string_ext_stats, "256_to_511_packets=",
1807 ps.stats.tx_256_to_511_packets);
1808 print_port_stat_cond(&string_ext_stats, "512_to_1023_packets=",
1809 ps.stats.tx_512_to_1023_packets);
1810 print_port_stat_cond(&string_ext_stats, "1024_to_1522_packets=",
1811 ps.stats.tx_1024_to_1522_packets);
1812 print_port_stat_cond(&string_ext_stats, "1523_to_max_packets=",
1813 ps.stats.tx_1523_to_max_packets);
1814 print_port_stat_cond(&string_ext_stats, "multicast_packets=",
1815 ps.stats.tx_multicast_packets);
1816 print_port_stat_cond(&string_ext_stats, "broadcast_packets=",
1817 ps.stats.tx_broadcast_packets);
1819 if (string_ext_stats.length != 0) {
1820 /* If at least one statistics counter is reported: */
1821 ds_put_cstr(string, " tx rfc2819 ");
1822 ds_put_buffer(string, string_ext_stats.string,
1823 string_ext_stats.length);
1824 ds_put_cstr(string, "\n");
1825 ds_destroy(&string_ext_stats);
1831 ofp_print_table_stats_reply(struct ds *string, const struct ofp_header *oh)
1833 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1834 ofpraw_pull_assert(&b);
1836 struct ofputil_table_features prev_features;
1837 struct ofputil_table_stats prev_stats;
1838 for (int i = 0;; i++) {
1839 struct ofputil_table_features features;
1840 struct ofputil_table_stats stats;
1843 retval = ofputil_decode_table_stats_reply(&b, &stats, &features);
1845 if (retval != EOF) {
1846 ofp_print_error(string, retval);
1851 ds_put_char(string, '\n');
1852 ofp_print_table_features(string,
1853 &features, i ? &prev_features : NULL,
1854 &stats, i ? &prev_stats : NULL);
1855 prev_features = features;
1861 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1863 if (queue_id == OFPQ_ALL) {
1864 ds_put_cstr(string, "ALL");
1866 ds_put_format(string, "%"PRIu32, queue_id);
1871 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1873 struct ofputil_queue_stats_request oqsr;
1876 error = ofputil_decode_queue_stats_request(oh, &oqsr);
1878 ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1882 ds_put_cstr(string, " port=");
1883 ofputil_format_port(oqsr.port_no, string);
1885 ds_put_cstr(string, " queue=");
1886 ofp_print_queue_name(string, oqsr.queue_id);
1890 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1893 ds_put_format(string, " %"PRIuSIZE" queues\n", ofputil_count_queue_stats(oh));
1894 if (verbosity < 1) {
1898 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1900 struct ofputil_queue_stats qs;
1903 retval = ofputil_decode_queue_stats(&qs, &b);
1905 if (retval != EOF) {
1906 ds_put_cstr(string, " ***parse error***");
1911 ds_put_cstr(string, " port ");
1912 ofputil_format_port(qs.port_no, string);
1913 ds_put_cstr(string, " queue ");
1914 ofp_print_queue_name(string, qs.queue_id);
1915 ds_put_cstr(string, ": ");
1917 print_port_stat(string, "bytes=", qs.tx_bytes, 1);
1918 print_port_stat(string, "pkts=", qs.tx_packets, 1);
1919 print_port_stat(string, "errors=", qs.tx_errors, 1);
1921 ds_put_cstr(string, "duration=");
1922 if (qs.duration_sec != UINT32_MAX) {
1923 ofp_print_duration(string, qs.duration_sec, qs.duration_nsec);
1925 ds_put_char(string, '?');
1927 ds_put_char(string, '\n');
1932 ofp_print_ofpst_port_desc_request(struct ds *string,
1933 const struct ofp_header *oh)
1938 error = ofputil_decode_port_desc_stats_request(oh, &port);
1940 ofp_print_error(string, error);
1944 ds_put_cstr(string, " port=");
1945 ofputil_format_port(port, string);
1949 ofp_print_ofpst_port_desc_reply(struct ds *string,
1950 const struct ofp_header *oh)
1952 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1953 ofpraw_pull_assert(&b);
1954 ds_put_char(string, '\n');
1955 ofp_print_phy_ports(string, oh->version, &b);
1959 ofp_print_stats(struct ds *string, const struct ofp_header *oh)
1961 uint16_t flags = ofpmp_flags(oh);
1964 ds_put_cstr(string, " flags=");
1965 if ((!ofpmsg_is_stat_request(oh) || oh->version >= OFP13_VERSION)
1966 && (flags & OFPSF_REPLY_MORE)) {
1967 ds_put_cstr(string, "[more]");
1968 flags &= ~OFPSF_REPLY_MORE;
1971 ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1978 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1980 size_t len = ntohs(oh->length);
1982 ds_put_format(string, " %"PRIuSIZE" bytes of payload\n", len - sizeof *oh);
1983 if (verbosity > 1) {
1984 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1989 ofp_print_role_generic(struct ds *string, enum ofp12_controller_role role,
1990 uint64_t generation_id)
1992 ds_put_cstr(string, " role=");
1995 case OFPCR12_ROLE_NOCHANGE:
1996 ds_put_cstr(string, "nochange");
1998 case OFPCR12_ROLE_EQUAL:
1999 ds_put_cstr(string, "equal"); /* OF 1.2 wording */
2001 case OFPCR12_ROLE_MASTER:
2002 ds_put_cstr(string, "master");
2004 case OFPCR12_ROLE_SLAVE:
2005 ds_put_cstr(string, "slave");
2011 if (generation_id != UINT64_MAX) {
2012 ds_put_format(string, " generation_id=%"PRIu64, generation_id);
2017 ofp_print_role_message(struct ds *string, const struct ofp_header *oh)
2019 struct ofputil_role_request rr;
2022 error = ofputil_decode_role_message(oh, &rr);
2024 ofp_print_error(string, error);
2028 ofp_print_role_generic(string, rr.role, rr.have_generation_id ? rr.generation_id : UINT64_MAX);
2032 ofp_print_role_status_message(struct ds *string, const struct ofp_header *oh)
2034 struct ofputil_role_status rs;
2037 error = ofputil_decode_role_status(oh, &rs);
2039 ofp_print_error(string, error);
2043 ofp_print_role_generic(string, rs.role, rs.generation_id);
2045 ds_put_cstr(string, " reason=");
2047 switch (rs.reason) {
2048 case OFPCRR_MASTER_REQUEST:
2049 ds_put_cstr(string, "master_request");
2052 ds_put_cstr(string, "configuration_changed");
2054 case OFPCRR_EXPERIMENTER:
2055 ds_put_cstr(string, "experimenter_data_changed");
2057 case OFPCRR_N_REASONS:
2064 ofp_print_nxt_flow_mod_table_id(struct ds *string,
2065 const struct nx_flow_mod_table_id *nfmti)
2067 ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
2071 ofp_print_nxt_set_flow_format(struct ds *string,
2072 const struct nx_set_flow_format *nsff)
2074 uint32_t format = ntohl(nsff->format);
2076 ds_put_cstr(string, " format=");
2077 if (ofputil_nx_flow_format_is_valid(format)) {
2078 ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
2080 ds_put_format(string, "%"PRIu32, format);
2085 ofp_print_nxt_set_packet_in_format(struct ds *string,
2086 const struct nx_set_packet_in_format *nspf)
2088 uint32_t format = ntohl(nspf->format);
2090 ds_put_cstr(string, " format=");
2091 if (ofputil_packet_in_format_is_valid(format)) {
2092 ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
2094 ds_put_format(string, "%"PRIu32, format);
2098 /* Returns a string form of 'reason'. The return value is either a statically
2099 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
2100 * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
2101 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
2103 ofp_port_reason_to_string(enum ofp_port_reason reason,
2104 char *reasonbuf, size_t bufsize)
2116 case OFPPR_N_REASONS:
2118 snprintf(reasonbuf, bufsize, "%d", (int) reason);
2123 /* Returns a string form of 'reason'. The return value is either a statically
2124 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
2125 * 'bufsize' should be at least OFP_ASYNC_CONFIG_REASON_BUFSIZE. */
2127 ofp_role_reason_to_string(enum ofp14_controller_role_reason reason,
2128 char *reasonbuf, size_t bufsize)
2131 case OFPCRR_MASTER_REQUEST:
2132 return "master_request";
2135 return "configuration_changed";
2137 case OFPCRR_EXPERIMENTER:
2138 return "experimenter_data_changed";
2140 case OFPCRR_N_REASONS:
2142 snprintf(reasonbuf, bufsize, "%d", (int) reason);
2147 /* Returns a string form of 'reason'. The return value is either a statically
2148 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
2149 * 'bufsize' should be at least OFP_ASYNC_CONFIG_REASON_BUFSIZE. */
2151 ofp_table_reason_to_string(enum ofp14_table_reason reason,
2152 char *reasonbuf, size_t bufsize)
2155 case OFPTR_VACANCY_DOWN:
2156 return "vacancy_down";
2158 case OFPTR_VACANCY_UP:
2159 return "vacancy_up";
2162 snprintf(reasonbuf, bufsize, "%d", (int) reason);
2167 /* Returns a string form of 'reason'. The return value is either a statically
2168 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
2169 * 'bufsize' should be at least OFP_ASYNC_CONFIG_REASON_BUFSIZE. */
2171 ofp_requestforward_reason_to_string(enum ofp14_requestforward_reason reason,
2172 char *reasonbuf, size_t bufsize)
2175 case OFPRFR_GROUP_MOD:
2176 return "group_mod_request";
2178 case OFPRFR_METER_MOD:
2179 return "meter_mod_request";
2181 case OFPRFR_N_REASONS:
2183 snprintf(reasonbuf, bufsize, "%d", (int) reason);
2189 ofp_async_config_reason_to_string(uint32_t reason,
2190 enum ofputil_async_msg_type type,
2191 char *reasonbuf, size_t bufsize)
2195 return ofputil_packet_in_reason_to_string(reason, reasonbuf, bufsize);
2197 case OAM_PORT_STATUS:
2198 return ofp_port_reason_to_string(reason, reasonbuf, bufsize);
2200 case OAM_FLOW_REMOVED:
2201 return ofp_flow_removed_reason_to_string(reason, reasonbuf, bufsize);
2203 case OAM_ROLE_STATUS:
2204 return ofp_role_reason_to_string(reason, reasonbuf, bufsize);
2206 case OAM_TABLE_STATUS:
2207 return ofp_table_reason_to_string(reason, reasonbuf, bufsize);
2209 case OAM_REQUESTFORWARD:
2210 return ofp_requestforward_reason_to_string(reason, reasonbuf, bufsize);
2214 return "Unknown asynchronous configuration message type";
2219 #define OFP_ASYNC_CONFIG_REASON_BUFSIZE (INT_STRLEN(int) + 1)
2221 ofp_print_set_async_config(struct ds *string, const struct ofp_header *oh,
2224 struct ofputil_async_cfg basis = OFPUTIL_ASYNC_CFG_INIT;
2225 struct ofputil_async_cfg ac;
2227 bool is_reply = type == OFPTYPE_GET_ASYNC_REPLY;
2228 enum ofperr error = ofputil_decode_set_async_config(oh, is_reply,
2231 ofp_print_error(string, error);
2235 for (int i = 0; i < 2; i++) {
2236 ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
2237 for (uint32_t type = 0; type < OAM_N_TYPES; type++) {
2238 ds_put_format(string, "%16s:",
2239 ofputil_async_msg_type_to_string(type));
2241 uint32_t role = i == 0 ? ac.master[type] : ac.slave[type];
2242 for (int j = 0; j < 32; j++) {
2243 if (role & (1u << j)) {
2244 char reasonbuf[OFP_ASYNC_CONFIG_REASON_BUFSIZE];
2247 reason = ofp_async_config_reason_to_string(
2248 j, type, reasonbuf, sizeof reasonbuf);
2250 ds_put_format(string, " %s", reason);
2255 ds_put_cstr(string, " (off)");
2257 ds_put_char(string, '\n');
2263 ofp_print_nxt_set_controller_id(struct ds *string,
2264 const struct nx_controller_id *nci)
2266 ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
2270 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
2271 const struct ofp_header *oh)
2273 ds_put_format(string, " id=%"PRIu32,
2274 ofputil_decode_flow_monitor_cancel(oh));
2278 nx_flow_monitor_flags_to_name(uint32_t bit)
2280 enum nx_flow_monitor_flags fmf = bit;
2283 case NXFMF_INITIAL: return "initial";
2284 case NXFMF_ADD: return "add";
2285 case NXFMF_DELETE: return "delete";
2286 case NXFMF_MODIFY: return "modify";
2287 case NXFMF_ACTIONS: return "actions";
2288 case NXFMF_OWN: return "own";
2295 ofp_print_nxst_flow_monitor_request(struct ds *string,
2296 const struct ofp_header *oh)
2298 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2300 struct ofputil_flow_monitor_request request;
2303 retval = ofputil_decode_flow_monitor_request(&request, &b);
2305 if (retval != EOF) {
2306 ofp_print_error(string, retval);
2311 ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
2312 ofp_print_bit_names(string, request.flags,
2313 nx_flow_monitor_flags_to_name, ',');
2315 if (request.out_port != OFPP_NONE) {
2316 ds_put_cstr(string, " out_port=");
2317 ofputil_format_port(request.out_port, string);
2320 if (request.table_id != 0xff) {
2321 ds_put_format(string, " table=%"PRIu8, request.table_id);
2324 ds_put_char(string, ' ');
2325 match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
2326 ds_chomp(string, ' ');
2331 ofp_print_nxst_flow_monitor_reply(struct ds *string,
2332 const struct ofp_header *oh)
2334 uint64_t ofpacts_stub[1024 / 8];
2335 struct ofpbuf ofpacts = OFPBUF_STUB_INITIALIZER(ofpacts_stub);
2336 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2339 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2340 struct ofputil_flow_update update;
2344 update.match = &match;
2345 retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
2347 if (retval != EOF) {
2348 ofp_print_error(string, retval);
2350 ofpbuf_uninit(&ofpacts);
2354 ds_put_cstr(string, "\n event=");
2355 switch (update.event) {
2357 ds_put_cstr(string, "ADDED");
2361 ds_put_format(string, "DELETED reason=%s",
2362 ofp_flow_removed_reason_to_string(update.reason,
2367 case NXFME_MODIFIED:
2368 ds_put_cstr(string, "MODIFIED");
2372 ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
2376 ds_put_format(string, " table=%"PRIu8, update.table_id);
2377 if (update.idle_timeout != OFP_FLOW_PERMANENT) {
2378 ds_put_format(string, " idle_timeout=%"PRIu16,
2379 update.idle_timeout);
2381 if (update.hard_timeout != OFP_FLOW_PERMANENT) {
2382 ds_put_format(string, " hard_timeout=%"PRIu16,
2383 update.hard_timeout);
2385 ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
2387 ds_put_char(string, ' ');
2388 match_format(update.match, string, OFP_DEFAULT_PRIORITY);
2390 if (update.ofpacts_len) {
2391 if (string->string[string->length - 1] != ' ') {
2392 ds_put_char(string, ' ');
2394 ds_put_cstr(string, "actions=");
2395 ofpacts_format(update.ofpacts, update.ofpacts_len, string);
2401 ofp_print_version(const struct ofp_header *oh,
2404 switch (oh->version) {
2408 ds_put_cstr(string, " (OF1.1)");
2411 ds_put_cstr(string, " (OF1.2)");
2414 ds_put_cstr(string, " (OF1.3)");
2417 ds_put_cstr(string, " (OF1.4)");
2420 ds_put_cstr(string, " (OF1.5)");
2423 ds_put_cstr(string, " (OF1.6)");
2426 ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
2429 ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
2433 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2436 ds_put_cstr(string, ofpraw_get_name(raw));
2437 ofp_print_version(oh, string);
2441 ofp_print_bucket_id(struct ds *s, const char *label, uint32_t bucket_id,
2442 enum ofp_version ofp_version)
2444 if (ofp_version < OFP15_VERSION) {
2448 ds_put_cstr(s, label);
2450 switch (bucket_id) {
2451 case OFPG15_BUCKET_FIRST:
2452 ds_put_cstr(s, "first");
2454 case OFPG15_BUCKET_LAST:
2455 ds_put_cstr(s, "last");
2457 case OFPG15_BUCKET_ALL:
2458 ds_put_cstr(s, "all");
2461 ds_put_format(s, "%"PRIu32, bucket_id);
2465 ds_put_char(s, ',');
2469 ofp_print_group(struct ds *s, uint32_t group_id, uint8_t type,
2470 const struct ovs_list *p_buckets,
2471 const struct ofputil_group_props *props,
2472 enum ofp_version ofp_version, bool suppress_type)
2474 struct ofputil_bucket *bucket;
2476 ds_put_format(s, "group_id=%"PRIu32, group_id);
2478 if (!suppress_type) {
2479 static const char *type_str[] = { "all", "select", "indirect",
2481 ds_put_format(s, ",type=%s", type_str[type > 4 ? 4 : type]);
2484 if (props->selection_method[0]) {
2485 ds_put_format(s, ",selection_method=%s", props->selection_method);
2486 if (props->selection_method_param) {
2487 ds_put_format(s, ",selection_method_param=%"PRIu64,
2488 props->selection_method_param);
2491 size_t n = bitmap_count1(props->fields.used.bm, MFF_N_IDS);
2493 ds_put_cstr(s, ",fields=");
2494 oxm_format_field_array(s, &props->fields);
2496 ds_put_cstr(s, ",fields(");
2497 oxm_format_field_array(s, &props->fields);
2498 ds_put_char(s, ')');
2506 ds_put_char(s, ',');
2508 LIST_FOR_EACH (bucket, list_node, p_buckets) {
2509 ds_put_cstr(s, "bucket=");
2511 ofp_print_bucket_id(s, "bucket_id:", bucket->bucket_id, ofp_version);
2512 if (bucket->weight != (type == OFPGT11_SELECT ? 1 : 0)) {
2513 ds_put_format(s, "weight:%"PRIu16",", bucket->weight);
2515 if (bucket->watch_port != OFPP_NONE) {
2516 ds_put_format(s, "watch_port:%"PRIu32",", bucket->watch_port);
2518 if (bucket->watch_group != OFPG_ANY) {
2519 ds_put_format(s, "watch_group:%"PRIu32",", bucket->watch_group);
2522 ds_put_cstr(s, "actions=");
2523 ofpacts_format(bucket->ofpacts, bucket->ofpacts_len, s);
2524 ds_put_char(s, ',');
2531 ofp_print_ofpst_group_desc_request(struct ds *string,
2532 const struct ofp_header *oh)
2534 uint32_t group_id = ofputil_decode_group_desc_request(oh);
2535 ds_put_cstr(string, " group_id=");
2536 ofputil_format_group(group_id, string);
2540 ofp_print_group_desc(struct ds *s, const struct ofp_header *oh)
2542 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2544 struct ofputil_group_desc gd;
2547 retval = ofputil_decode_group_desc_reply(&gd, &b, oh->version);
2549 if (retval != EOF) {
2550 ds_put_cstr(s, " ***parse error***");
2555 ds_put_char(s, '\n');
2556 ds_put_char(s, ' ');
2557 ofp_print_group(s, gd.group_id, gd.type, &gd.buckets, &gd.props,
2558 oh->version, false);
2559 ofputil_bucket_list_destroy(&gd.buckets);
2564 ofp_print_ofpst_group_request(struct ds *string, const struct ofp_header *oh)
2569 error = ofputil_decode_group_stats_request(oh, &group_id);
2571 ofp_print_error(string, error);
2575 ds_put_cstr(string, " group_id=");
2576 ofputil_format_group(group_id, string);
2580 ofp_print_group_stats(struct ds *s, const struct ofp_header *oh)
2582 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2584 struct ofputil_group_stats gs;
2587 retval = ofputil_decode_group_stats_reply(&b, &gs);
2589 if (retval != EOF) {
2590 ds_put_cstr(s, " ***parse error***");
2595 ds_put_char(s, '\n');
2597 ds_put_char(s, ' ');
2598 ds_put_format(s, "group_id=%"PRIu32",", gs.group_id);
2600 if (gs.duration_sec != UINT32_MAX) {
2601 ds_put_cstr(s, "duration=");
2602 ofp_print_duration(s, gs.duration_sec, gs.duration_nsec);
2603 ds_put_char(s, ',');
2605 ds_put_format(s, "ref_count=%"PRIu32",", gs.ref_count);
2606 ds_put_format(s, "packet_count=%"PRIu64",", gs.packet_count);
2607 ds_put_format(s, "byte_count=%"PRIu64"", gs.byte_count);
2609 for (uint32_t bucket_i = 0; bucket_i < gs.n_buckets; bucket_i++) {
2610 if (gs.bucket_stats[bucket_i].packet_count != UINT64_MAX) {
2611 ds_put_format(s, ",bucket%"PRIu32":", bucket_i);
2612 ds_put_format(s, "packet_count=%"PRIu64",", gs.bucket_stats[bucket_i].packet_count);
2613 ds_put_format(s, "byte_count=%"PRIu64"", gs.bucket_stats[bucket_i].byte_count);
2617 free(gs.bucket_stats);
2622 group_type_to_string(enum ofp11_group_type type)
2625 case OFPGT11_ALL: return "all";
2626 case OFPGT11_SELECT: return "select";
2627 case OFPGT11_INDIRECT: return "indirect";
2628 case OFPGT11_FF: return "fast failover";
2629 default: OVS_NOT_REACHED();
2634 ofp_print_group_features(struct ds *string, const struct ofp_header *oh)
2636 struct ofputil_group_features features;
2639 ofputil_decode_group_features_reply(oh, &features);
2641 ds_put_format(string, "\n Group table:\n");
2642 ds_put_format(string, " Types: 0x%"PRIx32"\n", features.types);
2643 ds_put_format(string, " Capabilities: 0x%"PRIx32"\n",
2644 features.capabilities);
2646 for (i = 0; i < OFPGT12_N_TYPES; i++) {
2647 if (features.types & (1u << i)) {
2648 ds_put_format(string, " %s group:\n", group_type_to_string(i));
2649 ds_put_format(string, " max_groups=%#"PRIx32"\n",
2650 features.max_groups[i]);
2651 ds_put_format(string, " actions: ");
2652 ofpact_bitmap_format(features.ofpacts[i], string);
2653 ds_put_char(string, '\n');
2659 ofp_print_group_mod__(struct ds *s, enum ofp_version ofp_version,
2660 const struct ofputil_group_mod *gm)
2662 bool bucket_command = false;
2664 ds_put_char(s, '\n');
2666 ds_put_char(s, ' ');
2667 switch (gm->command) {
2669 ds_put_cstr(s, "ADD");
2672 case OFPGC11_MODIFY:
2673 ds_put_cstr(s, "MOD");
2676 case OFPGC11_DELETE:
2677 ds_put_cstr(s, "DEL");
2680 case OFPGC15_INSERT_BUCKET:
2681 ds_put_cstr(s, "INSERT_BUCKET");
2682 bucket_command = true;
2685 case OFPGC15_REMOVE_BUCKET:
2686 ds_put_cstr(s, "REMOVE_BUCKET");
2687 bucket_command = true;
2691 ds_put_format(s, "cmd:%"PRIu16"", gm->command);
2693 ds_put_char(s, ' ');
2695 if (bucket_command) {
2696 ofp_print_bucket_id(s, "command_bucket_id:",
2697 gm->command_bucket_id, ofp_version);
2700 ofp_print_group(s, gm->group_id, gm->type, &gm->buckets, &gm->props,
2701 ofp_version, bucket_command);
2705 ofp_print_group_mod(struct ds *s, const struct ofp_header *oh)
2707 struct ofputil_group_mod gm;
2710 error = ofputil_decode_group_mod(oh, &gm);
2712 ofp_print_error(s, error);
2715 ofp_print_group_mod__(s, oh->version, &gm);
2716 ofputil_bucket_list_destroy(&gm.buckets);
2720 print_table_action_features(struct ds *s,
2721 const struct ofputil_table_action_features *taf)
2724 ds_put_cstr(s, " actions: ");
2725 ofpact_bitmap_format(taf->ofpacts, s);
2726 ds_put_char(s, '\n');
2729 if (!bitmap_is_all_zeros(taf->set_fields.bm, MFF_N_IDS)) {
2732 ds_put_cstr(s, " supported on Set-Field:");
2733 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, taf->set_fields.bm) {
2734 ds_put_format(s, " %s", mf_from_id(i)->name);
2736 ds_put_char(s, '\n');
2741 table_action_features_equal(const struct ofputil_table_action_features *a,
2742 const struct ofputil_table_action_features *b)
2744 return (a->ofpacts == b->ofpacts
2745 && bitmap_equal(a->set_fields.bm, b->set_fields.bm, MFF_N_IDS));
2749 table_action_features_empty(const struct ofputil_table_action_features *taf)
2751 return !taf->ofpacts && bitmap_is_all_zeros(taf->set_fields.bm, MFF_N_IDS);
2755 print_table_instruction_features(
2757 const struct ofputil_table_instruction_features *tif,
2758 const struct ofputil_table_instruction_features *prev_tif)
2762 if (!bitmap_is_all_zeros(tif->next, 255)) {
2763 ds_put_cstr(s, " next tables: ");
2764 for (start = bitmap_scan(tif->next, 1, 0, 255); start < 255;
2765 start = bitmap_scan(tif->next, 1, end, 255)) {
2766 end = bitmap_scan(tif->next, 0, start + 1, 255);
2767 if (end == start + 1) {
2768 ds_put_format(s, "%d,", start);
2770 ds_put_format(s, "%d-%d,", start, end - 1);
2774 if (ds_last(s) == ' ') {
2775 ds_put_cstr(s, "none");
2777 ds_put_char(s, '\n');
2780 if (tif->instructions) {
2781 if (prev_tif && tif->instructions == prev_tif->instructions) {
2782 ds_put_cstr(s, " (same instructions)\n");
2784 ds_put_cstr(s, " instructions: ");
2787 for (i = 0; i < 32; i++) {
2788 if (tif->instructions & (1u << i)) {
2789 ds_put_format(s, "%s,", ovs_instruction_name_from_type(i));
2793 ds_put_char(s, '\n');
2798 && table_action_features_equal(&tif->write, &prev_tif->write)
2799 && table_action_features_equal(&tif->apply, &prev_tif->apply)
2800 && !bitmap_is_all_zeros(tif->write.set_fields.bm, MFF_N_IDS)) {
2801 ds_put_cstr(s, " (same actions)\n");
2802 } else if (!table_action_features_equal(&tif->write, &tif->apply)) {
2803 ds_put_cstr(s, " Write-Actions features:\n");
2804 print_table_action_features(s, &tif->write);
2805 ds_put_cstr(s, " Apply-Actions features:\n");
2806 print_table_action_features(s, &tif->apply);
2807 } else if (tif->write.ofpacts
2808 || !bitmap_is_all_zeros(tif->write.set_fields.bm, MFF_N_IDS)) {
2809 ds_put_cstr(s, " Write-Actions and Apply-Actions features:\n");
2810 print_table_action_features(s, &tif->write);
2815 table_instruction_features_equal(
2816 const struct ofputil_table_instruction_features *a,
2817 const struct ofputil_table_instruction_features *b)
2819 return (bitmap_equal(a->next, b->next, 255)
2820 && a->instructions == b->instructions
2821 && table_action_features_equal(&a->write, &b->write)
2822 && table_action_features_equal(&a->apply, &b->apply));
2826 table_instruction_features_empty(
2827 const struct ofputil_table_instruction_features *tif)
2829 return (bitmap_is_all_zeros(tif->next, 255)
2830 && !tif->instructions
2831 && table_action_features_empty(&tif->write)
2832 && table_action_features_empty(&tif->apply));
2836 table_features_equal(const struct ofputil_table_features *a,
2837 const struct ofputil_table_features *b)
2839 return (a->metadata_match == b->metadata_match
2840 && a->metadata_write == b->metadata_write
2841 && a->miss_config == b->miss_config
2842 && a->supports_eviction == b->supports_eviction
2843 && a->supports_vacancy_events == b->supports_vacancy_events
2844 && a->max_entries == b->max_entries
2845 && table_instruction_features_equal(&a->nonmiss, &b->nonmiss)
2846 && table_instruction_features_equal(&a->miss, &b->miss)
2847 && bitmap_equal(a->match.bm, b->match.bm, MFF_N_IDS));
2851 table_features_empty(const struct ofputil_table_features *tf)
2853 return (!tf->metadata_match
2854 && !tf->metadata_write
2855 && tf->miss_config == OFPUTIL_TABLE_MISS_DEFAULT
2856 && tf->supports_eviction < 0
2857 && tf->supports_vacancy_events < 0
2859 && table_instruction_features_empty(&tf->nonmiss)
2860 && table_instruction_features_empty(&tf->miss)
2861 && bitmap_is_all_zeros(tf->match.bm, MFF_N_IDS));
2865 table_stats_equal(const struct ofputil_table_stats *a,
2866 const struct ofputil_table_stats *b)
2868 return (a->active_count == b->active_count
2869 && a->lookup_count == b->lookup_count
2870 && a->matched_count == b->matched_count);
2874 ofp_print_table_features(struct ds *s,
2875 const struct ofputil_table_features *features,
2876 const struct ofputil_table_features *prev_features,
2877 const struct ofputil_table_stats *stats,
2878 const struct ofputil_table_stats *prev_stats)
2882 ds_put_format(s, " table %"PRIu8, features->table_id);
2883 if (features->name[0]) {
2884 ds_put_format(s, " (\"%s\")", features->name);
2886 ds_put_char(s, ':');
2888 bool same_stats = prev_stats && table_stats_equal(stats, prev_stats);
2889 bool same_features = prev_features && table_features_equal(features,
2891 if ((!stats || same_stats) && same_features) {
2892 ds_put_cstr(s, " ditto");
2895 ds_put_char(s, '\n');
2897 ds_put_format(s, " active=%"PRIu32", ", stats->active_count);
2898 ds_put_format(s, "lookup=%"PRIu64", ", stats->lookup_count);
2899 ds_put_format(s, "matched=%"PRIu64"\n", stats->matched_count);
2901 if (same_features) {
2902 if (!table_features_empty(features)) {
2903 ds_put_cstr(s, " (same features)\n");
2907 if (features->metadata_match || features->metadata_write) {
2908 ds_put_format(s, " metadata: match=%#"PRIx64" write=%#"PRIx64"\n",
2909 ntohll(features->metadata_match),
2910 ntohll(features->metadata_write));
2913 if (features->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
2914 ds_put_format(s, " config=%s\n",
2915 ofputil_table_miss_to_string(features->miss_config));
2918 if (features->supports_eviction >= 0) {
2919 ds_put_format(s, " eviction: %ssupported\n",
2920 features->supports_eviction ? "" : "not ");
2923 if (features->supports_vacancy_events >= 0) {
2924 ds_put_format(s, " vacancy events: %ssupported\n",
2925 features->supports_vacancy_events ? "" : "not ");
2929 if (features->max_entries) {
2930 ds_put_format(s, " max_entries=%"PRIu32"\n", features->max_entries);
2933 const struct ofputil_table_instruction_features *prev_nonmiss
2934 = prev_features ? &prev_features->nonmiss : NULL;
2935 const struct ofputil_table_instruction_features *prev_miss
2936 = prev_features ? &prev_features->miss : NULL;
2938 && table_instruction_features_equal(&features->nonmiss, prev_nonmiss)
2939 && table_instruction_features_equal(&features->miss, prev_miss)) {
2940 if (!table_instruction_features_empty(&features->nonmiss)) {
2941 ds_put_cstr(s, " (same instructions)\n");
2943 } else if (!table_instruction_features_equal(&features->nonmiss,
2945 ds_put_cstr(s, " instructions (other than table miss):\n");
2946 print_table_instruction_features(s, &features->nonmiss, prev_nonmiss);
2947 ds_put_cstr(s, " instructions (table miss):\n");
2948 print_table_instruction_features(s, &features->miss, prev_miss);
2949 } else if (!table_instruction_features_empty(&features->nonmiss)) {
2950 ds_put_cstr(s, " instructions (table miss and others):\n");
2951 print_table_instruction_features(s, &features->nonmiss, prev_nonmiss);
2954 if (!bitmap_is_all_zeros(features->match.bm, MFF_N_IDS)) {
2956 && bitmap_equal(features->match.bm, prev_features->match.bm,
2958 ds_put_cstr(s, " (same matching)\n");
2960 ds_put_cstr(s, " matching:\n");
2961 BITMAP_FOR_EACH_1 (i, MFF_N_IDS, features->match.bm) {
2962 const struct mf_field *f = mf_from_id(i);
2963 bool mask = bitmap_is_set(features->mask.bm, i);
2964 bool wildcard = bitmap_is_set(features->wildcard.bm, i);
2966 ds_put_format(s, " %s: %s\n",
2968 (mask ? "arbitrary mask"
2969 : wildcard ? "exact match or wildcard"
2970 : "must exact match"));
2977 ofp_print_table_features_reply(struct ds *s, const struct ofp_header *oh)
2979 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
2981 struct ofputil_table_features prev;
2982 for (int i = 0; ; i++) {
2983 struct ofputil_table_features tf;
2986 retval = ofputil_decode_table_features(&b, &tf, true);
2988 if (retval != EOF) {
2989 ofp_print_error(s, retval);
2994 ds_put_char(s, '\n');
2995 ofp_print_table_features(s, &tf, i ? &prev : NULL, NULL, NULL);
3001 ofp_print_table_desc_reply(struct ds *s, const struct ofp_header *oh)
3003 struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
3005 struct ofputil_table_desc td;
3008 retval = ofputil_decode_table_desc(&b, &td, oh->version);
3010 if (retval != EOF) {
3011 ofp_print_error(s, retval);
3015 ofp_print_table_desc(s, &td);
3020 bundle_flags_to_name(uint32_t bit)
3033 ofp_print_bundle_ctrl(struct ds *s, const struct ofp_header *oh)
3036 struct ofputil_bundle_ctrl_msg bctrl;
3038 error = ofputil_decode_bundle_ctrl(oh, &bctrl);
3040 ofp_print_error(s, error);
3044 ds_put_char(s, '\n');
3046 ds_put_format(s, " bundle_id=%#"PRIx32" type=", bctrl.bundle_id);
3047 switch (bctrl.type) {
3048 case OFPBCT_OPEN_REQUEST:
3049 ds_put_cstr(s, "OPEN_REQUEST");
3051 case OFPBCT_OPEN_REPLY:
3052 ds_put_cstr(s, "OPEN_REPLY");
3054 case OFPBCT_CLOSE_REQUEST:
3055 ds_put_cstr(s, "CLOSE_REQUEST");
3057 case OFPBCT_CLOSE_REPLY:
3058 ds_put_cstr(s, "CLOSE_REPLY");
3060 case OFPBCT_COMMIT_REQUEST:
3061 ds_put_cstr(s, "COMMIT_REQUEST");
3063 case OFPBCT_COMMIT_REPLY:
3064 ds_put_cstr(s, "COMMIT_REPLY");
3066 case OFPBCT_DISCARD_REQUEST:
3067 ds_put_cstr(s, "DISCARD_REQUEST");
3069 case OFPBCT_DISCARD_REPLY:
3070 ds_put_cstr(s, "DISCARD_REPLY");
3074 ds_put_cstr(s, " flags=");
3075 ofp_print_bit_names(s, bctrl.flags, bundle_flags_to_name, ' ');
3079 ofp_print_bundle_add(struct ds *s, const struct ofp_header *oh, int verbosity)
3082 struct ofputil_bundle_add_msg badd;
3084 error = ofputil_decode_bundle_add(oh, &badd, NULL);
3086 ofp_print_error(s, error);
3090 ds_put_char(s, '\n');
3091 ds_put_format(s, " bundle_id=%#"PRIx32, badd.bundle_id);
3092 ds_put_cstr(s, " flags=");
3093 ofp_print_bit_names(s, badd.flags, bundle_flags_to_name, ' ');
3095 ds_put_char(s, '\n');
3096 char *msg = ofp_to_string(badd.msg, ntohs(badd.msg->length), verbosity);
3097 ds_put_and_free_cstr(s, msg);
3101 print_tlv_table(struct ds *s, struct ovs_list *mappings)
3103 struct ofputil_tlv_map *map;
3105 ds_put_cstr(s, " mapping table:\n");
3106 ds_put_cstr(s, " class\ttype\tlength\tmatch field\n");
3107 ds_put_cstr(s, " -----\t----\t------\t-----------");
3109 LIST_FOR_EACH (map, list_node, mappings) {
3110 ds_put_char(s, '\n');
3111 ds_put_format(s, " 0x%"PRIx16"\t0x%"PRIx8"\t%"PRIu8"\ttun_metadata%"PRIu16,
3112 map->option_class, map->option_type, map->option_len,
3118 ofp_print_tlv_table_mod(struct ds *s, const struct ofp_header *oh)
3121 struct ofputil_tlv_table_mod ttm;
3123 error = ofputil_decode_tlv_table_mod(oh, &ttm);
3125 ofp_print_error(s, error);
3129 ds_put_cstr(s, "\n ");
3131 switch (ttm.command) {
3133 ds_put_cstr(s, "ADD");
3136 ds_put_cstr(s, "DEL");
3139 ds_put_cstr(s, "CLEAR");
3143 if (ttm.command != NXTTMC_CLEAR) {
3144 print_tlv_table(s, &ttm.mappings);
3147 ofputil_uninit_tlv_table(&ttm.mappings);
3151 ofp_print_tlv_table_reply(struct ds *s, const struct ofp_header *oh)
3154 struct ofputil_tlv_table_reply ttr;
3155 struct ofputil_tlv_map *map;
3156 int allocated_space = 0;
3158 error = ofputil_decode_tlv_table_reply(oh, &ttr);
3160 ofp_print_error(s, error);
3164 ds_put_char(s, '\n');
3166 LIST_FOR_EACH (map, list_node, &ttr.mappings) {
3167 allocated_space += map->option_len;
3170 ds_put_format(s, " max option space=%"PRIu32" max fields=%"PRIu16"\n",
3171 ttr.max_option_space, ttr.max_fields);
3172 ds_put_format(s, " allocated option space=%d\n", allocated_space);
3173 ds_put_char(s, '\n');
3174 print_tlv_table(s, &ttr.mappings);
3176 ofputil_uninit_tlv_table(&ttr.mappings);
3179 /* This function will print the request forward message. The reason for
3180 * request forward is taken from rf.request.type */
3182 ofp_print_requestforward(struct ds *string, const struct ofp_header *oh)
3184 struct ofputil_requestforward rf;
3187 error = ofputil_decode_requestforward(oh, &rf);
3189 ofp_print_error(string, error);
3193 ds_put_cstr(string, " reason=");
3195 switch (rf.reason) {
3196 case OFPRFR_GROUP_MOD:
3197 ds_put_cstr(string, "group_mod");
3198 ofp_print_group_mod__(string, oh->version, rf.group_mod);
3201 case OFPRFR_METER_MOD:
3202 ds_put_cstr(string, "meter_mod");
3203 ofp_print_meter_mod__(string, rf.meter_mod);
3206 case OFPRFR_N_REASONS:
3209 ofputil_destroy_requestforward(&rf);
3213 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
3214 struct ds *string, int verbosity)
3216 const void *msg = oh;
3218 ofp_header_to_string__(oh, raw, string);
3220 enum ofptype type = ofptype_from_ofpraw(raw);
3222 case OFPTYPE_GROUP_STATS_REQUEST:
3223 ofp_print_stats(string, oh);
3224 ofp_print_ofpst_group_request(string, oh);
3227 case OFPTYPE_GROUP_STATS_REPLY:
3228 ofp_print_group_stats(string, oh);
3231 case OFPTYPE_GROUP_DESC_STATS_REQUEST:
3232 ofp_print_stats(string, oh);
3233 ofp_print_ofpst_group_desc_request(string, oh);
3236 case OFPTYPE_GROUP_DESC_STATS_REPLY:
3237 ofp_print_group_desc(string, oh);
3240 case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
3241 ofp_print_stats(string, oh);
3244 case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
3245 ofp_print_group_features(string, oh);
3248 case OFPTYPE_GROUP_MOD:
3249 ofp_print_group_mod(string, oh);
3252 case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
3253 case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
3254 ofp_print_table_features_reply(string, oh);
3257 case OFPTYPE_TABLE_DESC_REQUEST:
3258 case OFPTYPE_TABLE_DESC_REPLY:
3259 ofp_print_table_desc_reply(string, oh);
3263 ofp_print_hello(string, oh);
3267 ofp_print_error_msg(string, oh);
3270 case OFPTYPE_ECHO_REQUEST:
3271 case OFPTYPE_ECHO_REPLY:
3272 ofp_print_echo(string, oh, verbosity);
3275 case OFPTYPE_FEATURES_REQUEST:
3278 case OFPTYPE_FEATURES_REPLY:
3279 ofp_print_switch_features(string, oh);
3282 case OFPTYPE_GET_CONFIG_REQUEST:
3285 case OFPTYPE_GET_CONFIG_REPLY:
3286 ofp_print_get_config_reply(string, oh);
3289 case OFPTYPE_SET_CONFIG:
3290 ofp_print_set_config(string, oh);
3293 case OFPTYPE_PACKET_IN:
3294 ofp_print_packet_in(string, oh, verbosity);
3297 case OFPTYPE_FLOW_REMOVED:
3298 ofp_print_flow_removed(string, oh);
3301 case OFPTYPE_PORT_STATUS:
3302 ofp_print_port_status(string, oh);
3305 case OFPTYPE_PACKET_OUT:
3306 ofp_print_packet_out(string, oh, verbosity);
3309 case OFPTYPE_FLOW_MOD:
3310 ofp_print_flow_mod(string, oh, verbosity);
3313 case OFPTYPE_PORT_MOD:
3314 ofp_print_port_mod(string, oh);
3317 case OFPTYPE_TABLE_MOD:
3318 ofp_print_table_mod(string, oh);
3321 case OFPTYPE_METER_MOD:
3322 ofp_print_meter_mod(string, oh);
3325 case OFPTYPE_BARRIER_REQUEST:
3326 case OFPTYPE_BARRIER_REPLY:
3329 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
3330 ofp_print_queue_get_config_request(string, oh);
3333 case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
3334 ofp_print_queue_get_config_reply(string, oh);
3337 case OFPTYPE_ROLE_REQUEST:
3338 case OFPTYPE_ROLE_REPLY:
3339 ofp_print_role_message(string, oh);
3341 case OFPTYPE_ROLE_STATUS:
3342 ofp_print_role_status_message(string, oh);
3345 case OFPTYPE_REQUESTFORWARD:
3346 ofp_print_requestforward(string, oh);
3349 case OFPTYPE_TABLE_STATUS:
3350 ofp_print_table_status_message(string, oh);
3353 case OFPTYPE_METER_STATS_REQUEST:
3354 case OFPTYPE_METER_CONFIG_STATS_REQUEST:
3355 ofp_print_stats(string, oh);
3356 ofp_print_meter_stats_request(string, oh);
3359 case OFPTYPE_METER_STATS_REPLY:
3360 ofp_print_stats(string, oh);
3361 ofp_print_meter_stats_reply(string, oh);
3364 case OFPTYPE_METER_CONFIG_STATS_REPLY:
3365 ofp_print_stats(string, oh);
3366 ofp_print_meter_config_reply(string, oh);
3369 case OFPTYPE_METER_FEATURES_STATS_REPLY:
3370 ofp_print_stats(string, oh);
3371 ofp_print_meter_features_reply(string, oh);
3374 case OFPTYPE_DESC_STATS_REQUEST:
3375 case OFPTYPE_METER_FEATURES_STATS_REQUEST:
3376 ofp_print_stats(string, oh);
3379 case OFPTYPE_FLOW_STATS_REQUEST:
3380 case OFPTYPE_AGGREGATE_STATS_REQUEST:
3381 ofp_print_stats(string, oh);
3382 ofp_print_flow_stats_request(string, oh);
3385 case OFPTYPE_TABLE_STATS_REQUEST:
3386 ofp_print_stats(string, oh);
3389 case OFPTYPE_PORT_STATS_REQUEST:
3390 ofp_print_stats(string, oh);
3391 ofp_print_ofpst_port_request(string, oh);
3394 case OFPTYPE_QUEUE_STATS_REQUEST:
3395 ofp_print_stats(string, oh);
3396 ofp_print_ofpst_queue_request(string, oh);
3399 case OFPTYPE_DESC_STATS_REPLY:
3400 ofp_print_stats(string, oh);
3401 ofp_print_ofpst_desc_reply(string, oh);
3404 case OFPTYPE_FLOW_STATS_REPLY:
3405 ofp_print_stats(string, oh);
3406 ofp_print_flow_stats_reply(string, oh);
3409 case OFPTYPE_QUEUE_STATS_REPLY:
3410 ofp_print_stats(string, oh);
3411 ofp_print_ofpst_queue_reply(string, oh, verbosity);
3414 case OFPTYPE_PORT_STATS_REPLY:
3415 ofp_print_stats(string, oh);
3416 ofp_print_ofpst_port_reply(string, oh, verbosity);
3419 case OFPTYPE_TABLE_STATS_REPLY:
3420 ofp_print_stats(string, oh);
3421 ofp_print_table_stats_reply(string, oh);
3424 case OFPTYPE_AGGREGATE_STATS_REPLY:
3425 ofp_print_stats(string, oh);
3426 ofp_print_aggregate_stats_reply(string, oh);
3429 case OFPTYPE_PORT_DESC_STATS_REQUEST:
3430 ofp_print_stats(string, oh);
3431 ofp_print_ofpst_port_desc_request(string, oh);
3434 case OFPTYPE_PORT_DESC_STATS_REPLY:
3435 ofp_print_stats(string, oh);
3436 ofp_print_ofpst_port_desc_reply(string, oh);
3439 case OFPTYPE_FLOW_MOD_TABLE_ID:
3440 ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
3443 case OFPTYPE_SET_FLOW_FORMAT:
3444 ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
3447 case OFPTYPE_SET_PACKET_IN_FORMAT:
3448 ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
3451 case OFPTYPE_FLOW_AGE:
3454 case OFPTYPE_SET_CONTROLLER_ID:
3455 ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
3458 case OFPTYPE_GET_ASYNC_REPLY:
3459 case OFPTYPE_SET_ASYNC_CONFIG:
3460 ofp_print_set_async_config(string, oh, type);
3462 case OFPTYPE_GET_ASYNC_REQUEST:
3464 case OFPTYPE_FLOW_MONITOR_CANCEL:
3465 ofp_print_nxt_flow_monitor_cancel(string, msg);
3468 case OFPTYPE_FLOW_MONITOR_PAUSED:
3469 case OFPTYPE_FLOW_MONITOR_RESUMED:
3472 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
3473 ofp_print_nxst_flow_monitor_request(string, msg);
3476 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
3477 ofp_print_nxst_flow_monitor_reply(string, msg);
3480 case OFPTYPE_BUNDLE_CONTROL:
3481 ofp_print_bundle_ctrl(string, msg);
3484 case OFPTYPE_BUNDLE_ADD_MESSAGE:
3485 ofp_print_bundle_add(string, msg, verbosity);
3488 case OFPTYPE_NXT_TLV_TABLE_MOD:
3489 ofp_print_tlv_table_mod(string, msg);
3492 case OFPTYPE_NXT_TLV_TABLE_REQUEST:
3495 case OFPTYPE_NXT_TLV_TABLE_REPLY:
3496 ofp_print_tlv_table_reply(string, msg);
3499 case OFPTYPE_NXT_RESUME:
3500 ofp_print_packet_in(string, msg, verbosity);
3505 /* Composes and returns a string representing the OpenFlow packet of 'len'
3506 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
3507 * verbosity and higher numbers increase verbosity. The caller is responsible
3508 * for freeing the string. */
3510 ofp_to_string(const void *oh_, size_t len, int verbosity)
3512 struct ds string = DS_EMPTY_INITIALIZER;
3513 const struct ofp_header *oh = oh_;
3516 ds_put_cstr(&string, "OpenFlow message is empty\n");
3517 } else if (len < sizeof(struct ofp_header)) {
3518 ds_put_format(&string, "OpenFlow packet too short (only %"PRIuSIZE" bytes):\n",
3520 } else if (ntohs(oh->length) > len) {
3524 error = ofpraw_decode_partial(&raw, oh, len);
3526 ofp_header_to_string__(oh, raw, &string);
3527 ds_put_char(&string, '\n');
3530 ds_put_format(&string,
3531 "(***truncated to %"PRIuSIZE" bytes from %"PRIu16"***)\n",
3532 len, ntohs(oh->length));
3533 } else if (ntohs(oh->length) < len) {
3534 ds_put_format(&string,
3535 "(***only uses %"PRIu16" bytes out of %"PRIuSIZE"***)\n",
3536 ntohs(oh->length), len);
3541 error = ofpraw_decode(&raw, oh);
3543 ofp_to_string__(oh, raw, &string, verbosity);
3544 if (verbosity >= 5) {
3545 if (ds_last(&string) != '\n') {
3546 ds_put_char(&string, '\n');
3548 ds_put_hex_dump(&string, oh, len, 0, true);
3550 if (ds_last(&string) != '\n') {
3551 ds_put_char(&string, '\n');
3553 return ds_steal_cstr(&string);
3556 ofp_print_error(&string, error);
3558 ds_put_hex_dump(&string, oh, len, 0, true);
3559 return ds_steal_cstr(&string);
3563 print_and_free(FILE *stream, char *string)
3565 fputs(string, stream);
3569 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
3570 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
3571 * numbers increase verbosity. */
3573 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
3575 print_and_free(stream, ofp_to_string(oh, len, verbosity));
3578 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
3579 * 'data' to 'stream'. */
3581 ofp_print_packet(FILE *stream, const void *data, size_t len)
3583 print_and_free(stream, ofp_packet_to_string(data, len));