lib/ofp-print.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   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:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <sys/types.h>
  23 #include <netinet/in.h>
  24 #include <sys/wait.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <ctype.h>
  28
  29 #include "bundle.h"
  30 #include "byte-order.h"
  31 #include "compiler.h"
  32 #include "dynamic-string.h"
  33 #include "flow.h"
  34 #include "learn.h"
  35 #include "multipath.h"
  36 #include "meta-flow.h"
  37 #include "netdev.h"
  38 #include "nx-match.h"
  39 #include "ofp-actions.h"
  40 #include "ofp-errors.h"
  41 #include "ofp-msgs.h"
  42 #include "ofp-util.h"
  43 #include "ofpbuf.h"
  44 #include "openflow/openflow.h"
  45 #include "openflow/nicira-ext.h"
  46 #include "packets.h"
  47 #include "type-props.h"
  48 #include "unaligned.h"
  49 #include "odp-util.h"
  50 #include "util.h"
  51
  52 static void ofp_print_queue_name(struct ds *string, uint32_t port);
  53 static void ofp_print_error(struct ds *, enum ofperr);
  54
  55
  56 /* Returns a string that represents the contents of the Ethernet frame in the
  57  * 'len' bytes starting at 'data'.  The caller must free the returned string.*/
  58 char *
  59 ofp_packet_to_string(const void *data, size_t len)
  60 {
  61     struct ds ds = DS_EMPTY_INITIALIZER;
  62     const struct pkt_metadata md = PKT_METADATA_INITIALIZER(0);
  63     struct ofpbuf buf;
  64     struct flow flow;
  65     size_t l4_size;
  66
  67     ofpbuf_use_const(&buf, data, len);
  68     flow_extract(&buf, &md, &flow);
  69     flow_format(&ds, &flow);
  70
  71     l4_size = ofpbuf_l4_size(&buf);
  72
  73     if (flow.nw_proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
  74         struct tcp_header *th = ofpbuf_l4(&buf);
  75         ds_put_format(&ds, " tcp_csum:%"PRIx16, ntohs(th->tcp_csum));
  76     } else if (flow.nw_proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN) {
  77         struct udp_header *uh = ofpbuf_l4(&buf);
  78         ds_put_format(&ds, " udp_csum:%"PRIx16, ntohs(uh->udp_csum));
  79     } else if (flow.nw_proto == IPPROTO_SCTP && l4_size >= SCTP_HEADER_LEN) {
  80         struct sctp_header *sh = ofpbuf_l4(&buf);
  81         ds_put_format(&ds, " sctp_csum:%"PRIx32,
  82                       ntohl(get_16aligned_be32(&sh->sctp_csum)));
  83     }
  84
  85     ds_put_char(&ds, '\n');
  86
  87     return ds_cstr(&ds);
  88 }
  89
  90 static void
  91 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
  92                     int verbosity)
  93 {
  94     char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
  95     struct ofputil_packet_in pin;
  96     int error;
  97     int i;
  98
  99     error = ofputil_decode_packet_in(&pin, oh);
 100     if (error) {
 101         ofp_print_error(string, error);
 102         return;
 103     }
 104
 105     if (pin.table_id) {
 106         ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
 107     }
 108
 109     if (pin.cookie != OVS_BE64_MAX) {
 110         ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
 111     }
 112
 113     ds_put_format(string, " total_len=%"PRIuSIZE" in_port=", pin.total_len);
 114     ofputil_format_port(pin.fmd.in_port, string);
 115
 116     if (pin.fmd.tun_id != htonll(0)) {
 117         ds_put_format(string, " tun_id=0x%"PRIx64, ntohll(pin.fmd.tun_id));
 118     }
 119
 120     if (pin.fmd.tun_src != htonl(0)) {
 121         ds_put_format(string, " tun_src="IP_FMT, IP_ARGS(pin.fmd.tun_src));
 122     }
 123
 124     if (pin.fmd.tun_dst != htonl(0)) {
 125         ds_put_format(string, " tun_dst="IP_FMT, IP_ARGS(pin.fmd.tun_dst));
 126     }
 127
 128     if (pin.fmd.metadata != htonll(0)) {
 129         ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
 130     }
 131
 132     for (i = 0; i < FLOW_N_REGS; i++) {
 133         if (pin.fmd.regs[i]) {
 134             ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
 135         }
 136     }
 137
 138     if (pin.fmd.pkt_mark != 0) {
 139         ds_put_format(string, " pkt_mark=0x%"PRIx32, pin.fmd.pkt_mark);
 140     }
 141
 142     ds_put_format(string, " (via %s)",
 143                   ofputil_packet_in_reason_to_string(pin.reason, reasonbuf,
 144                                                      sizeof reasonbuf));
 145
 146     ds_put_format(string, " data_len=%"PRIuSIZE, pin.packet_len);
 147     if (pin.buffer_id == UINT32_MAX) {
 148         ds_put_format(string, " (unbuffered)");
 149         if (pin.total_len != pin.packet_len) {
 150             ds_put_format(string, " (***total_len != data_len***)");
 151         }
 152     } else {
 153         ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
 154         if (pin.total_len < pin.packet_len) {
 155             ds_put_format(string, " (***total_len < data_len***)");
 156         }
 157     }
 158     ds_put_char(string, '\n');
 159
 160     if (verbosity > 0) {
 161         char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
 162         ds_put_cstr(string, packet);
 163         free(packet);
 164     }
 165     if (verbosity > 2) {
 166         ds_put_hex_dump(string, pin.packet, pin.packet_len, 0, false);
 167     }
 168 }
 169
 170 static void
 171 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
 172                      int verbosity)
 173 {
 174     struct ofputil_packet_out po;
 175     struct ofpbuf ofpacts;
 176     enum ofperr error;
 177
 178     ofpbuf_init(&ofpacts, 64);
 179     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
 180     if (error) {
 181         ofpbuf_uninit(&ofpacts);
 182         ofp_print_error(string, error);
 183         return;
 184     }
 185
 186     ds_put_cstr(string, " in_port=");
 187     ofputil_format_port(po.in_port, string);
 188
 189     ds_put_cstr(string, " actions=");
 190     ofpacts_format(po.ofpacts, po.ofpacts_len, string);
 191
 192     if (po.buffer_id == UINT32_MAX) {
 193         ds_put_format(string, " data_len=%"PRIuSIZE, po.packet_len);
 194         if (verbosity > 0 && po.packet_len > 0) {
 195             char *packet = ofp_packet_to_string(po.packet, po.packet_len);
 196             ds_put_char(string, '\n');
 197             ds_put_cstr(string, packet);
 198             free(packet);
 199         }
 200         if (verbosity > 2) {
 201             ds_put_hex_dump(string, po.packet, po.packet_len, 0, false);
 202         }
 203     } else {
 204         ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
 205     }
 206
 207     ofpbuf_uninit(&ofpacts);
 208 }
 209
 210 /* qsort comparison function. */
 211 static int
 212 compare_ports(const void *a_, const void *b_)
 213 {
 214     const struct ofputil_phy_port *a = a_;
 215     const struct ofputil_phy_port *b = b_;
 216     uint16_t ap = ofp_to_u16(a->port_no);
 217     uint16_t bp = ofp_to_u16(b->port_no);
 218
 219     return ap < bp ? -1 : ap > bp;
 220 }
 221
 222 static void
 223 ofp_print_bit_names(struct ds *string, uint32_t bits,
 224                     const char *(*bit_to_name)(uint32_t bit),
 225                     char separator)
 226 {
 227     int n = 0;
 228     int i;
 229
 230     if (!bits) {
 231         ds_put_cstr(string, "0");
 232         return;
 233     }
 234
 235     for (i = 0; i < 32; i++) {
 236         uint32_t bit = UINT32_C(1) << i;
 237
 238         if (bits & bit) {
 239             const char *name = bit_to_name(bit);
 240             if (name) {
 241                 if (n++) {
 242                     ds_put_char(string, separator);
 243                 }
 244                 ds_put_cstr(string, name);
 245                 bits &= ~bit;
 246             }
 247         }
 248     }
 249
 250     if (bits) {
 251         if (n) {
 252             ds_put_char(string, separator);
 253         }
 254         ds_put_format(string, "0x%"PRIx32, bits);
 255     }
 256 }
 257
 258 static const char *
 259 netdev_feature_to_name(uint32_t bit)
 260 {
 261     enum netdev_features f = bit;
 262
 263     switch (f) {
 264     case NETDEV_F_10MB_HD:    return "10MB-HD";
 265     case NETDEV_F_10MB_FD:    return "10MB-FD";
 266     case NETDEV_F_100MB_HD:   return "100MB-HD";
 267     case NETDEV_F_100MB_FD:   return "100MB-FD";
 268     case NETDEV_F_1GB_HD:     return "1GB-HD";
 269     case NETDEV_F_1GB_FD:     return "1GB-FD";
 270     case NETDEV_F_10GB_FD:    return "10GB-FD";
 271     case NETDEV_F_40GB_FD:    return "40GB-FD";
 272     case NETDEV_F_100GB_FD:   return "100GB-FD";
 273     case NETDEV_F_1TB_FD:     return "1TB-FD";
 274     case NETDEV_F_OTHER:      return "OTHER";
 275     case NETDEV_F_COPPER:     return "COPPER";
 276     case NETDEV_F_FIBER:      return "FIBER";
 277     case NETDEV_F_AUTONEG:    return "AUTO_NEG";
 278     case NETDEV_F_PAUSE:      return "AUTO_PAUSE";
 279     case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
 280     }
 281
 282     return NULL;
 283 }
 284
 285 static void
 286 ofp_print_port_features(struct ds *string, enum netdev_features features)
 287 {
 288     ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
 289     ds_put_char(string, '\n');
 290 }
 291
 292 static const char *
 293 ofputil_port_config_to_name(uint32_t bit)
 294 {
 295     enum ofputil_port_config pc = bit;
 296
 297     switch (pc) {
 298     case OFPUTIL_PC_PORT_DOWN:    return "PORT_DOWN";
 299     case OFPUTIL_PC_NO_STP:       return "NO_STP";
 300     case OFPUTIL_PC_NO_RECV:      return "NO_RECV";
 301     case OFPUTIL_PC_NO_RECV_STP:  return "NO_RECV_STP";
 302     case OFPUTIL_PC_NO_FLOOD:     return "NO_FLOOD";
 303     case OFPUTIL_PC_NO_FWD:       return "NO_FWD";
 304     case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
 305     }
 306
 307     return NULL;
 308 }
 309
 310 static void
 311 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
 312 {
 313     ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
 314     ds_put_char(string, '\n');
 315 }
 316
 317 static const char *
 318 ofputil_port_state_to_name(uint32_t bit)
 319 {
 320     enum ofputil_port_state ps = bit;
 321
 322     switch (ps) {
 323     case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
 324     case OFPUTIL_PS_BLOCKED:   return "BLOCKED";
 325     case OFPUTIL_PS_LIVE:      return "LIVE";
 326
 327     case OFPUTIL_PS_STP_LISTEN:
 328     case OFPUTIL_PS_STP_LEARN:
 329     case OFPUTIL_PS_STP_FORWARD:
 330     case OFPUTIL_PS_STP_BLOCK:
 331         /* Handled elsewhere. */
 332         return NULL;
 333     }
 334
 335     return NULL;
 336 }
 337
 338 static void
 339 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
 340 {
 341     enum ofputil_port_state stp_state;
 342
 343     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
 344      * pattern.  We have to special case it.
 345      *
 346      * OVS doesn't support STP, so this field will always be 0 if we are
 347      * talking to OVS, so we'd always print STP_LISTEN in that case.
 348      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
 349      * avoid confusing users. */
 350     stp_state = state & OFPUTIL_PS_STP_MASK;
 351     if (stp_state) {
 352         ds_put_cstr(string,
 353                     (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
 354                      : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
 355                      : "STP_BLOCK"));
 356         state &= ~OFPUTIL_PS_STP_MASK;
 357         if (state) {
 358             ofp_print_bit_names(string, state, ofputil_port_state_to_name,
 359                                 ' ');
 360         }
 361     } else {
 362         ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
 363     }
 364     ds_put_char(string, '\n');
 365 }
 366
 367 static void
 368 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
 369 {
 370     char name[sizeof port->name];
 371     int j;
 372
 373     memcpy(name, port->name, sizeof name);
 374     for (j = 0; j < sizeof name - 1; j++) {
 375         if (!isprint((unsigned char) name[j])) {
 376             break;
 377         }
 378     }
 379     name[j] = '\0';
 380
 381     ds_put_char(string, ' ');
 382     ofputil_format_port(port->port_no, string);
 383     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
 384                   name, ETH_ADDR_ARGS(port->hw_addr));
 385
 386     ds_put_cstr(string, "     config:     ");
 387     ofp_print_port_config(string, port->config);
 388
 389     ds_put_cstr(string, "     state:      ");
 390     ofp_print_port_state(string, port->state);
 391
 392     if (port->curr) {
 393         ds_put_format(string, "     current:    ");
 394         ofp_print_port_features(string, port->curr);
 395     }
 396     if (port->advertised) {
 397         ds_put_format(string, "     advertised: ");
 398         ofp_print_port_features(string, port->advertised);
 399     }
 400     if (port->supported) {
 401         ds_put_format(string, "     supported:  ");
 402         ofp_print_port_features(string, port->supported);
 403     }
 404     if (port->peer) {
 405         ds_put_format(string, "     peer:       ");
 406         ofp_print_port_features(string, port->peer);
 407     }
 408     ds_put_format(string, "     speed: %"PRIu32" Mbps now, "
 409                   "%"PRIu32" Mbps max\n",
 410                   port->curr_speed / UINT32_C(1000),
 411                   port->max_speed / UINT32_C(1000));
 412 }
 413
 414 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
 415  * 'ofp_version', writes a detailed description of each port into
 416  * 'string'. */
 417 static void
 418 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
 419                     struct ofpbuf *b)
 420 {
 421     size_t n_ports;
 422     struct ofputil_phy_port *ports;
 423     enum ofperr error;
 424     size_t i;
 425
 426     n_ports = ofputil_count_phy_ports(ofp_version, b);
 427
 428     ports = xmalloc(n_ports * sizeof *ports);
 429     for (i = 0; i < n_ports; i++) {
 430         error = ofputil_pull_phy_port(ofp_version, b, &ports[i]);
 431         if (error) {
 432             ofp_print_error(string, error);
 433             goto exit;
 434         }
 435     }
 436     qsort(ports, n_ports, sizeof *ports, compare_ports);
 437     for (i = 0; i < n_ports; i++) {
 438         ofp_print_phy_port(string, &ports[i]);
 439     }
 440
 441 exit:
 442     free(ports);
 443 }
 444
 445 static const char *
 446 ofputil_capabilities_to_name(uint32_t bit)
 447 {
 448     enum ofputil_capabilities capabilities = bit;
 449
 450     switch (capabilities) {
 451     case OFPUTIL_C_FLOW_STATS:   return "FLOW_STATS";
 452     case OFPUTIL_C_TABLE_STATS:  return "TABLE_STATS";
 453     case OFPUTIL_C_PORT_STATS:   return "PORT_STATS";
 454     case OFPUTIL_C_IP_REASM:     return "IP_REASM";
 455     case OFPUTIL_C_QUEUE_STATS:  return "QUEUE_STATS";
 456     case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
 457     case OFPUTIL_C_STP:          return "STP";
 458     case OFPUTIL_C_GROUP_STATS:  return "GROUP_STATS";
 459     case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
 460     }
 461
 462     return NULL;
 463 }
 464
 465 static const char *
 466 ofputil_action_bitmap_to_name(uint32_t bit)
 467 {
 468     enum ofputil_action_bitmap action = bit;
 469
 470     switch (action) {
 471     case OFPUTIL_A_OUTPUT:         return "OUTPUT";
 472     case OFPUTIL_A_SET_VLAN_VID:   return "SET_VLAN_VID";
 473     case OFPUTIL_A_SET_VLAN_PCP:   return "SET_VLAN_PCP";
 474     case OFPUTIL_A_STRIP_VLAN:     return "STRIP_VLAN";
 475     case OFPUTIL_A_SET_DL_SRC:     return "SET_DL_SRC";
 476     case OFPUTIL_A_SET_DL_DST:     return "SET_DL_DST";
 477     case OFPUTIL_A_SET_NW_SRC:     return "SET_NW_SRC";
 478     case OFPUTIL_A_SET_NW_DST:     return "SET_NW_DST";
 479     case OFPUTIL_A_SET_NW_ECN:     return "SET_NW_ECN";
 480     case OFPUTIL_A_SET_NW_TOS:     return "SET_NW_TOS";
 481     case OFPUTIL_A_SET_TP_SRC:     return "SET_TP_SRC";
 482     case OFPUTIL_A_SET_TP_DST:     return "SET_TP_DST";
 483     case OFPUTIL_A_SET_FIELD:      return "SET_FIELD";
 484     case OFPUTIL_A_ENQUEUE:        return "ENQUEUE";
 485     case OFPUTIL_A_COPY_TTL_OUT:   return "COPY_TTL_OUT";
 486     case OFPUTIL_A_COPY_TTL_IN:    return "COPY_TTL_IN";
 487     case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
 488     case OFPUTIL_A_SET_MPLS_TC:    return "SET_MPLS_TC";
 489     case OFPUTIL_A_SET_MPLS_TTL:   return "SET_MPLS_TTL";
 490     case OFPUTIL_A_DEC_MPLS_TTL:   return "DEC_MPLS_TTL";
 491     case OFPUTIL_A_PUSH_VLAN:      return "PUSH_VLAN";
 492     case OFPUTIL_A_POP_VLAN:       return "POP_VLAN";
 493     case OFPUTIL_A_PUSH_MPLS:      return "PUSH_MPLS";
 494     case OFPUTIL_A_POP_MPLS:       return "POP_MPLS";
 495     case OFPUTIL_A_SET_QUEUE:      return "SET_QUEUE";
 496     case OFPUTIL_A_GROUP:          return "GROUP";
 497     case OFPUTIL_A_SET_NW_TTL:     return "SET_NW_TTL";
 498     case OFPUTIL_A_DEC_NW_TTL:     return "DEC_NW_TTL";
 499     }
 500
 501     return NULL;
 502 }
 503
 504 static void
 505 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
 506 {
 507     struct ofputil_switch_features features;
 508     enum ofperr error;
 509     struct ofpbuf b;
 510
 511     error = ofputil_decode_switch_features(oh, &features, &b);
 512     if (error) {
 513         ofp_print_error(string, error);
 514         return;
 515     }
 516
 517     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
 518
 519     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32,
 520                   features.n_tables, features.n_buffers);
 521     if (features.auxiliary_id) {
 522         ds_put_format(string, ", auxiliary_id:%"PRIu8, features.auxiliary_id);
 523     }
 524     ds_put_char(string, '\n');
 525
 526     ds_put_cstr(string, "capabilities: ");
 527     ofp_print_bit_names(string, features.capabilities,
 528                         ofputil_capabilities_to_name, ' ');
 529     ds_put_char(string, '\n');
 530
 531     switch ((enum ofp_version)oh->version) {
 532     case OFP10_VERSION:
 533         ds_put_cstr(string, "actions: ");
 534         ofp_print_bit_names(string, features.actions,
 535                             ofputil_action_bitmap_to_name, ' ');
 536         ds_put_char(string, '\n');
 537         break;
 538     case OFP11_VERSION:
 539     case OFP12_VERSION:
 540         break;
 541     case OFP13_VERSION:
 542     case OFP14_VERSION:
 543         return; /* no ports in ofp13_switch_features */
 544     default:
 545         OVS_NOT_REACHED();
 546     }
 547
 548     ofp_print_phy_ports(string, oh->version, &b);
 549 }
 550
 551 static void
 552 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
 553 {
 554     enum ofp_config_flags flags;
 555
 556     flags = ntohs(osc->flags);
 557
 558     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
 559     flags &= ~OFPC_FRAG_MASK;
 560
 561     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
 562         ds_put_format(string, " invalid_ttl_to_controller");
 563         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
 564     }
 565
 566     if (flags) {
 567         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 568     }
 569
 570     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 571 }
 572
 573 static void print_wild(struct ds *string, const char *leader, int is_wild,
 574             int verbosity, const char *format, ...)
 575             PRINTF_FORMAT(5, 6);
 576
 577 static void print_wild(struct ds *string, const char *leader, int is_wild,
 578                        int verbosity, const char *format, ...)
 579 {
 580     if (is_wild && verbosity < 2) {
 581         return;
 582     }
 583     ds_put_cstr(string, leader);
 584     if (!is_wild) {
 585         va_list args;
 586
 587         va_start(args, format);
 588         ds_put_format_valist(string, format, args);
 589         va_end(args);
 590     } else {
 591         ds_put_char(string, '*');
 592     }
 593     ds_put_char(string, ',');
 594 }
 595
 596 static void
 597 print_wild_port(struct ds *string, const char *leader, int is_wild,
 598                 int verbosity, ofp_port_t port)
 599 {
 600     if (is_wild && verbosity < 2) {
 601         return;
 602     }
 603     ds_put_cstr(string, leader);
 604     if (!is_wild) {
 605         ofputil_format_port(port, string);
 606     } else {
 607         ds_put_char(string, '*');
 608     }
 609     ds_put_char(string, ',');
 610 }
 611
 612 static void
 613 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
 614                  uint32_t wild_bits, int verbosity)
 615 {
 616     if (wild_bits >= 32 && verbosity < 2) {
 617         return;
 618     }
 619     ds_put_cstr(string, leader);
 620     if (wild_bits < 32) {
 621         ds_put_format(string, IP_FMT, IP_ARGS(ip));
 622         if (wild_bits) {
 623             ds_put_format(string, "/%d", 32 - wild_bits);
 624         }
 625     } else {
 626         ds_put_char(string, '*');
 627     }
 628     ds_put_char(string, ',');
 629 }
 630
 631 void
 632 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
 633 {
 634     char *s = ofp10_match_to_string(om, verbosity);
 635     ds_put_cstr(f, s);
 636     free(s);
 637 }
 638
 639 char *
 640 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
 641 {
 642     struct ds f = DS_EMPTY_INITIALIZER;
 643     uint32_t w = ntohl(om->wildcards);
 644     bool skip_type = false;
 645     bool skip_proto = false;
 646
 647     if (!(w & OFPFW10_DL_TYPE)) {
 648         skip_type = true;
 649         if (om->dl_type == htons(ETH_TYPE_IP)) {
 650             if (!(w & OFPFW10_NW_PROTO)) {
 651                 skip_proto = true;
 652                 if (om->nw_proto == IPPROTO_ICMP) {
 653                     ds_put_cstr(&f, "icmp,");
 654                 } else if (om->nw_proto == IPPROTO_TCP) {
 655                     ds_put_cstr(&f, "tcp,");
 656                 } else if (om->nw_proto == IPPROTO_UDP) {
 657                     ds_put_cstr(&f, "udp,");
 658                 } else if (om->nw_proto == IPPROTO_SCTP) {
 659                     ds_put_cstr(&f, "sctp,");
 660                 } else {
 661                     ds_put_cstr(&f, "ip,");
 662                     skip_proto = false;
 663                 }
 664             } else {
 665                 ds_put_cstr(&f, "ip,");
 666             }
 667         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 668             ds_put_cstr(&f, "arp,");
 669         } else if (om->dl_type == htons(ETH_TYPE_RARP)){
 670             ds_put_cstr(&f, "rarp,");
 671         } else if (om->dl_type == htons(ETH_TYPE_MPLS)) {
 672             ds_put_cstr(&f, "mpls,");
 673         } else if (om->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
 674             ds_put_cstr(&f, "mplsm,");
 675         } else {
 676             skip_type = false;
 677         }
 678     }
 679     print_wild_port(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
 680                     u16_to_ofp(ntohs(om->in_port)));
 681     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
 682                "%d", ntohs(om->dl_vlan));
 683     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
 684                "%d", om->dl_vlan_pcp);
 685     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
 686                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 687     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
 688                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 689     if (!skip_type) {
 690         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
 691                    "0x%04x", ntohs(om->dl_type));
 692     }
 693     print_ip_netmask(&f, "nw_src=", om->nw_src,
 694                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
 695                      verbosity);
 696     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
 697                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
 698                      verbosity);
 699     if (!skip_proto) {
 700         if (om->dl_type == htons(ETH_TYPE_ARP) ||
 701             om->dl_type == htons(ETH_TYPE_RARP)) {
 702             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
 703                        "%u", om->nw_proto);
 704         } else {
 705             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
 706                        "%u", om->nw_proto);
 707         }
 708     }
 709     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
 710                "%u", om->nw_tos);
 711     if (om->nw_proto == IPPROTO_ICMP) {
 712         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
 713                    "%d", ntohs(om->tp_src));
 714         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
 715                    "%d", ntohs(om->tp_dst));
 716     } else {
 717         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
 718                    "%d", ntohs(om->tp_src));
 719         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
 720                    "%d", ntohs(om->tp_dst));
 721     }
 722     if (ds_last(&f) == ',') {
 723         f.length--;
 724     }
 725     return ds_cstr(&f);
 726 }
 727
 728 static void
 729 ofp_print_flow_flags(struct ds *s, enum ofputil_flow_mod_flags flags)
 730 {
 731     if (flags & OFPUTIL_FF_SEND_FLOW_REM) {
 732         ds_put_cstr(s, "send_flow_rem ");
 733     }
 734     if (flags & OFPUTIL_FF_CHECK_OVERLAP) {
 735         ds_put_cstr(s, "check_overlap ");
 736     }
 737     if (flags & OFPUTIL_FF_RESET_COUNTS) {
 738         ds_put_cstr(s, "reset_counts ");
 739     }
 740     if (flags & OFPUTIL_FF_NO_PKT_COUNTS) {
 741         ds_put_cstr(s, "no_packet_counts ");
 742     }
 743     if (flags & OFPUTIL_FF_NO_BYT_COUNTS) {
 744         ds_put_cstr(s, "no_byte_counts ");
 745     }
 746 }
 747
 748 static void
 749 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
 750 {
 751     struct ofputil_flow_mod fm;
 752     struct ofpbuf ofpacts;
 753     bool need_priority;
 754     enum ofperr error;
 755     enum ofpraw raw;
 756     enum ofputil_protocol protocol;
 757
 758     protocol = ofputil_protocol_from_ofp_version(oh->version);
 759     protocol = ofputil_protocol_set_tid(protocol, true);
 760
 761     ofpbuf_init(&ofpacts, 64);
 762     error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts,
 763                                     OFPP_MAX, 255);
 764     if (error) {
 765         ofpbuf_uninit(&ofpacts);
 766         ofp_print_error(s, error);
 767         return;
 768     }
 769
 770     ds_put_char(s, ' ');
 771     switch (fm.command) {
 772     case OFPFC_ADD:
 773         ds_put_cstr(s, "ADD");
 774         break;
 775     case OFPFC_MODIFY:
 776         ds_put_cstr(s, "MOD");
 777         break;
 778     case OFPFC_MODIFY_STRICT:
 779         ds_put_cstr(s, "MOD_STRICT");
 780         break;
 781     case OFPFC_DELETE:
 782         ds_put_cstr(s, "DEL");
 783         break;
 784     case OFPFC_DELETE_STRICT:
 785         ds_put_cstr(s, "DEL_STRICT");
 786         break;
 787     default:
 788         ds_put_format(s, "cmd:%d", fm.command);
 789     }
 790     if (fm.table_id != 0) {
 791         ds_put_format(s, " table:%d", fm.table_id);
 792     }
 793
 794     ds_put_char(s, ' ');
 795     ofpraw_decode(&raw, oh);
 796     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
 797         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
 798         ofp10_match_print(s, &ofm->match, verbosity);
 799
 800         /* ofp_print_match() doesn't print priority. */
 801         need_priority = true;
 802     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
 803         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
 804         const void *nxm = nfm + 1;
 805         char *nxm_s;
 806
 807         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 808         ds_put_cstr(s, nxm_s);
 809         free(nxm_s);
 810
 811         /* nx_match_to_string() doesn't print priority. */
 812         need_priority = true;
 813     } else {
 814         match_format(&fm.match, s, fm.priority);
 815
 816         /* match_format() does print priority. */
 817         need_priority = false;
 818     }
 819
 820     if (ds_last(s) != ' ') {
 821         ds_put_char(s, ' ');
 822     }
 823     if (fm.new_cookie != htonll(0) && fm.new_cookie != OVS_BE64_MAX) {
 824         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
 825     }
 826     if (fm.cookie_mask != htonll(0)) {
 827         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
 828                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
 829     }
 830     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 831         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 832     }
 833     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 834         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 835     }
 836     if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
 837         ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
 838     }
 839     if (fm.buffer_id != UINT32_MAX) {
 840         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 841     }
 842     if (fm.out_port != OFPP_ANY) {
 843         ds_put_format(s, "out_port:");
 844         ofputil_format_port(fm.out_port, s);
 845         ds_put_char(s, ' ');
 846     }
 847
 848     if (oh->version == OFP10_VERSION || oh->version == OFP11_VERSION) {
 849         /* Don't print the reset_counts flag for OF1.0 and OF1.1 because those
 850          * versions don't really have such a flag and printing one is likely to
 851          * confuse people. */
 852         fm.flags &= ~OFPUTIL_FF_RESET_COUNTS;
 853     }
 854     ofp_print_flow_flags(s, fm.flags);
 855
 856     ds_put_cstr(s, "actions=");
 857     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
 858     ofpbuf_uninit(&ofpacts);
 859 }
 860
 861 static void
 862 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 863 {
 864     ds_put_format(string, "%u", sec);
 865
 866     /* If there are no fractional seconds, don't print any decimals.
 867      *
 868      * If the fractional seconds can be expressed exactly as milliseconds,
 869      * print 3 decimals.  Open vSwitch provides millisecond precision for most
 870      * time measurements, so printing 3 decimals every time makes it easier to
 871      * spot real changes in flow dumps that refresh themselves quickly.
 872      *
 873      * If the fractional seconds are more precise than milliseconds, print the
 874      * number of decimals needed to express them exactly.
 875      */
 876     if (nsec > 0) {
 877         unsigned int msec = nsec / 1000000;
 878         if (msec * 1000000 == nsec) {
 879             ds_put_format(string, ".%03u", msec);
 880         } else {
 881             ds_put_format(string, ".%09u", nsec);
 882             while (string->string[string->length - 1] == '0') {
 883                 string->length--;
 884             }
 885         }
 886     }
 887     ds_put_char(string, 's');
 888 }
 889
 890 /* Returns a string form of 'reason'.  The return value is either a statically
 891  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
 892  * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
 893 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
 894 static const char *
 895 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason,
 896                                   char *reasonbuf, size_t bufsize)
 897 {
 898     switch (reason) {
 899     case OFPRR_IDLE_TIMEOUT:
 900         return "idle";
 901     case OFPRR_HARD_TIMEOUT:
 902         return "hard";
 903     case OFPRR_DELETE:
 904         return "delete";
 905     case OFPRR_GROUP_DELETE:
 906         return "group_delete";
 907     case OFPRR_EVICTION:
 908         return "eviction";
 909     case OFPRR_METER_DELETE:
 910         return "meter_delete";
 911     default:
 912         snprintf(reasonbuf, bufsize, "%d", (int) reason);
 913         return reasonbuf;
 914     }
 915 }
 916
 917 static void
 918 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 919 {
 920     char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
 921     struct ofputil_flow_removed fr;
 922     enum ofperr error;
 923
 924     error = ofputil_decode_flow_removed(&fr, oh);
 925     if (error) {
 926         ofp_print_error(string, error);
 927         return;
 928     }
 929
 930     ds_put_char(string, ' ');
 931     match_format(&fr.match, string, fr.priority);
 932
 933     ds_put_format(string, " reason=%s",
 934                   ofp_flow_removed_reason_to_string(fr.reason, reasonbuf,
 935                                                     sizeof reasonbuf));
 936
 937     if (fr.table_id != 255) {
 938         ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
 939     }
 940
 941     if (fr.cookie != htonll(0)) {
 942         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 943     }
 944     ds_put_cstr(string, " duration");
 945     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 946     ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
 947     if (fr.hard_timeout) {
 948         /* The hard timeout was only added in OF1.2, so only print it if it is
 949          * actually in use to avoid gratuitous change to the formatting. */
 950         ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
 951     }
 952     ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
 953                   fr.packet_count, fr.byte_count);
 954 }
 955
 956 static void
 957 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
 958 {
 959     struct ofputil_port_mod pm;
 960     enum ofperr error;
 961
 962     error = ofputil_decode_port_mod(oh, &pm);
 963     if (error) {
 964         ofp_print_error(string, error);
 965         return;
 966     }
 967
 968     ds_put_cstr(string, "port: ");
 969     ofputil_format_port(pm.port_no, string);
 970     ds_put_format(string, ": addr:"ETH_ADDR_FMT"\n",
 971                   ETH_ADDR_ARGS(pm.hw_addr));
 972
 973     ds_put_cstr(string, "     config: ");
 974     ofp_print_port_config(string, pm.config);
 975
 976     ds_put_cstr(string, "     mask:   ");
 977     ofp_print_port_config(string, pm.mask);
 978
 979     ds_put_cstr(string, "     advertise: ");
 980     if (pm.advertise) {
 981         ofp_print_port_features(string, pm.advertise);
 982     } else {
 983         ds_put_cstr(string, "UNCHANGED\n");
 984     }
 985 }
 986
 987 static void
 988 ofp_print_table_miss_config(struct ds *string, const uint32_t config)
 989 {
 990     uint32_t table_miss_config = config & OFPTC11_TABLE_MISS_MASK;
 991
 992     switch (table_miss_config) {
 993     case OFPTC11_TABLE_MISS_CONTROLLER:
 994         ds_put_cstr(string, "controller\n");
 995         break;
 996     case OFPTC11_TABLE_MISS_CONTINUE:
 997         ds_put_cstr(string, "continue\n");
 998         break;
 999     case OFPTC11_TABLE_MISS_DROP:
1000         ds_put_cstr(string, "drop\n");
1001         break;
1002     default:
1003         ds_put_cstr(string, "Unknown\n");
1004         break;
1005     }
1006 }
1007
1008 static void
1009 ofp_print_table_mod(struct ds *string, const struct ofp_header *oh)
1010 {
1011     struct ofputil_table_mod pm;
1012     enum ofperr error;
1013
1014     error = ofputil_decode_table_mod(oh, &pm);
1015     if (error) {
1016         ofp_print_error(string, error);
1017         return;
1018     }
1019
1020     if (pm.table_id == 0xff) {
1021         ds_put_cstr(string, " table_id: ALL_TABLES");
1022     } else {
1023         ds_put_format(string, " table_id=%"PRIu8, pm.table_id);
1024     }
1025
1026     ds_put_cstr(string, ", flow_miss_config=");
1027     ofp_print_table_miss_config(string, pm.config);
1028 }
1029
1030 static void
1031 ofp_print_queue_get_config_request(struct ds *string,
1032                                    const struct ofp_header *oh)
1033 {
1034     enum ofperr error;
1035     ofp_port_t port;
1036
1037     error = ofputil_decode_queue_get_config_request(oh, &port);
1038     if (error) {
1039         ofp_print_error(string, error);
1040         return;
1041     }
1042
1043     ds_put_cstr(string, " port=");
1044     ofputil_format_port(port, string);
1045 }
1046
1047 static void
1048 print_queue_rate(struct ds *string, const char *name, unsigned int rate)
1049 {
1050     if (rate <= 1000) {
1051         ds_put_format(string, " %s:%u.%u%%", name, rate / 10, rate % 10);
1052     } else if (rate < UINT16_MAX) {
1053         ds_put_format(string, " %s:(disabled)", name);
1054     }
1055 }
1056
1057 static void
1058 ofp_print_queue_get_config_reply(struct ds *string,
1059                                  const struct ofp_header *oh)
1060 {
1061     enum ofperr error;
1062     struct ofpbuf b;
1063     ofp_port_t port;
1064
1065     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1066     error = ofputil_decode_queue_get_config_reply(&b, &port);
1067     if (error) {
1068         ofp_print_error(string, error);
1069         return;
1070     }
1071
1072     ds_put_cstr(string, " port=");
1073     ofputil_format_port(port, string);
1074     ds_put_char(string, '\n');
1075
1076     for (;;) {
1077         struct ofputil_queue_config queue;
1078         int retval;
1079
1080         retval = ofputil_pull_queue_get_config_reply(&b, &queue);
1081         if (retval) {
1082             if (retval != EOF) {
1083                 ofp_print_error(string, retval);
1084             }
1085             break;
1086         }
1087
1088         ds_put_format(string, "queue %"PRIu32":", queue.queue_id);
1089         print_queue_rate(string, "min_rate", queue.min_rate);
1090         print_queue_rate(string, "max_rate", queue.max_rate);
1091         ds_put_char(string, '\n');
1092     }
1093 }
1094
1095 static void
1096 ofp_print_meter_flags(struct ds *s, uint16_t flags)
1097 {
1098     if (flags & OFPMF13_KBPS) {
1099         ds_put_cstr(s, "kbps ");
1100     }
1101     if (flags & OFPMF13_PKTPS) {
1102         ds_put_cstr(s, "pktps ");
1103     }
1104     if (flags & OFPMF13_BURST) {
1105         ds_put_cstr(s, "burst ");
1106     }
1107     if (flags & OFPMF13_STATS) {
1108         ds_put_cstr(s, "stats ");
1109     }
1110
1111     flags &= ~(OFPMF13_KBPS | OFPMF13_PKTPS | OFPMF13_BURST | OFPMF13_STATS);
1112     if (flags) {
1113         ds_put_format(s, "flags:0x%"PRIx16" ", flags);
1114     }
1115 }
1116
1117 static void
1118 ofp_print_meter_band(struct ds *s, uint16_t flags,
1119                      const struct ofputil_meter_band *mb)
1120 {
1121     ds_put_cstr(s, "\ntype=");
1122     switch (mb->type) {
1123     case OFPMBT13_DROP:
1124         ds_put_cstr(s, "drop");
1125         break;
1126     case OFPMBT13_DSCP_REMARK:
1127         ds_put_cstr(s, "dscp_remark");
1128         break;
1129     default:
1130         ds_put_format(s, "%u", mb->type);
1131     }
1132
1133     ds_put_format(s, " rate=%"PRIu32, mb->rate);
1134
1135     if (flags & OFPMF13_BURST) {
1136         ds_put_format(s, " burst_size=%"PRIu32, mb->burst_size);
1137     }
1138     if (mb->type == OFPMBT13_DSCP_REMARK) {
1139         ds_put_format(s, " prec_level=%"PRIu8, mb->prec_level);
1140     }
1141 }
1142
1143 static void
1144 ofp_print_meter_stats(struct ds *s, const struct ofputil_meter_stats *ms)
1145 {
1146     uint16_t i;
1147
1148     ds_put_format(s, "meter:%"PRIu32" ", ms->meter_id);
1149     ds_put_format(s, "flow_count:%"PRIu32" ", ms->flow_count);
1150     ds_put_format(s, "packet_in_count:%"PRIu64" ", ms->packet_in_count);
1151     ds_put_format(s, "byte_in_count:%"PRIu64" ", ms->byte_in_count);
1152     ds_put_cstr(s, "duration:");
1153     ofp_print_duration(s, ms->duration_sec, ms->duration_nsec);
1154     ds_put_char(s, ' ');
1155
1156     ds_put_cstr(s, "bands:\n");
1157     for (i = 0; i < ms->n_bands; ++i) {
1158         ds_put_format(s, "%d: ", i);
1159         ds_put_format(s, "packet_count:%"PRIu64" ", ms->bands[i].packet_count);
1160         ds_put_format(s, "byte_count:%"PRIu64"\n", ms->bands[i].byte_count);
1161     }
1162 }
1163
1164 static void
1165 ofp_print_meter_config(struct ds *s, const struct ofputil_meter_config *mc)
1166 {
1167     uint16_t i;
1168
1169     ds_put_format(s, "meter=%"PRIu32" ", mc->meter_id);
1170
1171     ofp_print_meter_flags(s, mc->flags);
1172
1173     ds_put_cstr(s, "bands=");
1174     for (i = 0; i < mc->n_bands; ++i) {
1175         ofp_print_meter_band(s, mc->flags, &mc->bands[i]);
1176     }
1177     ds_put_char(s, '\n');
1178 }
1179
1180 static void
1181 ofp_print_meter_mod(struct ds *s, const struct ofp_header *oh)
1182 {
1183     struct ofputil_meter_mod mm;
1184     struct ofpbuf bands;
1185     enum ofperr error;
1186
1187     ofpbuf_init(&bands, 64);
1188     error = ofputil_decode_meter_mod(oh, &mm, &bands);
1189     if (error) {
1190         ofpbuf_uninit(&bands);
1191         ofp_print_error(s, error);
1192         return;
1193     }
1194
1195     switch (mm.command) {
1196     case OFPMC13_ADD:
1197         ds_put_cstr(s, " ADD ");
1198         break;
1199     case OFPMC13_MODIFY:
1200         ds_put_cstr(s, " MOD ");
1201         break;
1202     case OFPMC13_DELETE:
1203         ds_put_cstr(s, " DEL ");
1204         break;
1205     default:
1206         ds_put_format(s, " cmd:%d ", mm.command);
1207     }
1208
1209     ofp_print_meter_config(s, &mm.meter);
1210     ofpbuf_uninit(&bands);
1211 }
1212
1213 static void
1214 ofp_print_meter_stats_request(struct ds *s, const struct ofp_header *oh)
1215 {
1216     uint32_t meter_id;
1217
1218     ofputil_decode_meter_request(oh, &meter_id);
1219
1220     ds_put_format(s, " meter=%"PRIu32, meter_id);
1221 }
1222
1223 static const char *
1224 ofputil_meter_capabilities_to_name(uint32_t bit)
1225 {
1226     enum ofp13_meter_flags flag = bit;
1227
1228     switch (flag) {
1229     case OFPMF13_KBPS:    return "kbps";
1230     case OFPMF13_PKTPS:   return "pktps";
1231     case OFPMF13_BURST:   return "burst";
1232     case OFPMF13_STATS:   return "stats";
1233     }
1234
1235     return NULL;
1236 }
1237
1238 static const char *
1239 ofputil_meter_band_types_to_name(uint32_t bit)
1240 {
1241     switch (bit) {
1242     case 1 << OFPMBT13_DROP:          return "drop";
1243     case 1 << OFPMBT13_DSCP_REMARK:   return "dscp_remark";
1244     }
1245
1246     return NULL;
1247 }
1248
1249 static void
1250 ofp_print_meter_features_reply(struct ds *s, const struct ofp_header *oh)
1251 {
1252     struct ofputil_meter_features mf;
1253
1254     ofputil_decode_meter_features(oh, &mf);
1255
1256     ds_put_format(s, "\nmax_meter:%"PRIu32, mf.max_meters);
1257     ds_put_format(s, " max_bands:%"PRIu8, mf.max_bands);
1258     ds_put_format(s, " max_color:%"PRIu8"\n", mf.max_color);
1259
1260     ds_put_cstr(s, "band_types: ");
1261     ofp_print_bit_names(s, mf.band_types,
1262                         ofputil_meter_band_types_to_name, ' ');
1263     ds_put_char(s, '\n');
1264
1265     ds_put_cstr(s, "capabilities: ");
1266     ofp_print_bit_names(s, mf.capabilities,
1267                         ofputil_meter_capabilities_to_name, ' ');
1268     ds_put_char(s, '\n');
1269 }
1270
1271 static void
1272 ofp_print_meter_config_reply(struct ds *s, const struct ofp_header *oh)
1273 {
1274     struct ofpbuf bands;
1275     struct ofpbuf b;
1276
1277     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1278     ofpbuf_init(&bands, 64);
1279     for (;;) {
1280         struct ofputil_meter_config mc;
1281         int retval;
1282
1283         retval = ofputil_decode_meter_config(&b, &mc, &bands);
1284         if (retval) {
1285             if (retval != EOF) {
1286                 ofp_print_error(s, retval);
1287             }
1288             break;
1289         }
1290         ds_put_char(s, '\n');
1291         ofp_print_meter_config(s, &mc);
1292     }
1293     ofpbuf_uninit(&bands);
1294 }
1295
1296 static void
1297 ofp_print_meter_stats_reply(struct ds *s, const struct ofp_header *oh)
1298 {
1299     struct ofpbuf bands;
1300     struct ofpbuf b;
1301
1302     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1303     ofpbuf_init(&bands, 64);
1304     for (;;) {
1305         struct ofputil_meter_stats ms;
1306         int retval;
1307
1308         retval = ofputil_decode_meter_stats(&b, &ms, &bands);
1309         if (retval) {
1310             if (retval != EOF) {
1311                 ofp_print_error(s, retval);
1312             }
1313             break;
1314         }
1315         ds_put_char(s, '\n');
1316         ofp_print_meter_stats(s, &ms);
1317     }
1318     ofpbuf_uninit(&bands);
1319 }
1320
1321 static void
1322 ofp_print_error(struct ds *string, enum ofperr error)
1323 {
1324     if (string->length) {
1325         ds_put_char(string, ' ');
1326     }
1327     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1328 }
1329
1330 static void
1331 ofp_print_hello(struct ds *string, const struct ofp_header *oh)
1332 {
1333     uint32_t allowed_versions;
1334     bool ok;
1335
1336     ok = ofputil_decode_hello(oh, &allowed_versions);
1337
1338     ds_put_cstr(string, "\n version bitmap: ");
1339     ofputil_format_version_bitmap(string, allowed_versions);
1340
1341     if (!ok) {
1342         ds_put_cstr(string, "\n unknown data in hello:\n");
1343         ds_put_hex_dump(string, oh, ntohs(oh->length), 0, true);
1344     }
1345 }
1346
1347 static void
1348 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
1349 {
1350     size_t len = ntohs(oh->length);
1351     struct ofpbuf payload;
1352     enum ofperr error;
1353     char *s;
1354
1355     error = ofperr_decode_msg(oh, &payload);
1356     if (!error) {
1357         ds_put_cstr(string, "***decode error***");
1358         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1359         return;
1360     }
1361
1362     ds_put_format(string, " %s\n", ofperr_get_name(error));
1363
1364     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
1365         ds_put_printable(string, ofpbuf_data(&payload), ofpbuf_size(&payload));
1366     } else {
1367         s = ofp_to_string(ofpbuf_data(&payload), ofpbuf_size(&payload), 1);
1368         ds_put_cstr(string, s);
1369         free(s);
1370     }
1371 }
1372
1373 static void
1374 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
1375 {
1376     struct ofputil_port_status ps;
1377     enum ofperr error;
1378
1379     error = ofputil_decode_port_status(oh, &ps);
1380     if (error) {
1381         ofp_print_error(string, error);
1382         return;
1383     }
1384
1385     if (ps.reason == OFPPR_ADD) {
1386         ds_put_format(string, " ADD:");
1387     } else if (ps.reason == OFPPR_DELETE) {
1388         ds_put_format(string, " DEL:");
1389     } else if (ps.reason == OFPPR_MODIFY) {
1390         ds_put_format(string, " MOD:");
1391     }
1392
1393     ofp_print_phy_port(string, &ps.desc);
1394 }
1395
1396 static void
1397 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1398 {
1399     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
1400
1401     ds_put_char(string, '\n');
1402     ds_put_format(string, "Manufacturer: %.*s\n",
1403             (int) sizeof ods->mfr_desc, ods->mfr_desc);
1404     ds_put_format(string, "Hardware: %.*s\n",
1405             (int) sizeof ods->hw_desc, ods->hw_desc);
1406     ds_put_format(string, "Software: %.*s\n",
1407             (int) sizeof ods->sw_desc, ods->sw_desc);
1408     ds_put_format(string, "Serial Num: %.*s\n",
1409             (int) sizeof ods->serial_num, ods->serial_num);
1410     ds_put_format(string, "DP Description: %.*s\n",
1411             (int) sizeof ods->dp_desc, ods->dp_desc);
1412 }
1413
1414 static void
1415 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1416 {
1417     struct ofputil_flow_stats_request fsr;
1418     enum ofperr error;
1419
1420     error = ofputil_decode_flow_stats_request(&fsr, oh);
1421     if (error) {
1422         ofp_print_error(string, error);
1423         return;
1424     }
1425
1426     if (fsr.table_id != 0xff) {
1427         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1428     }
1429
1430     if (fsr.out_port != OFPP_ANY) {
1431         ds_put_cstr(string, " out_port=");
1432         ofputil_format_port(fsr.out_port, string);
1433     }
1434
1435     ds_put_char(string, ' ');
1436     match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
1437 }
1438
1439 void
1440 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1441 {
1442     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1443                   ntohll(fs->cookie));
1444
1445     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1446     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1447     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1448     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1449     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1450         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1451     }
1452     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1453         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1454     }
1455     if (fs->flags) {
1456         ofp_print_flow_flags(string, fs->flags);
1457     }
1458     if (fs->idle_age >= 0) {
1459         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1460     }
1461     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1462         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1463     }
1464
1465     match_format(&fs->match, string, fs->priority);
1466     if (string->string[string->length - 1] != ' ') {
1467         ds_put_char(string, ' ');
1468     }
1469
1470     ds_put_cstr(string, "actions=");
1471     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1472 }
1473
1474 static void
1475 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1476 {
1477     struct ofpbuf ofpacts;
1478     struct ofpbuf b;
1479
1480     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1481     ofpbuf_init(&ofpacts, 64);
1482     for (;;) {
1483         struct ofputil_flow_stats fs;
1484         int retval;
1485
1486         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1487         if (retval) {
1488             if (retval != EOF) {
1489                 ds_put_cstr(string, " ***parse error***");
1490             }
1491             break;
1492         }
1493         ds_put_char(string, '\n');
1494         ofp_print_flow_stats(string, &fs);
1495      }
1496     ofpbuf_uninit(&ofpacts);
1497 }
1498
1499 static void
1500 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1501 {
1502     struct ofputil_aggregate_stats as;
1503     enum ofperr error;
1504
1505     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1506     if (error) {
1507         ofp_print_error(string, error);
1508         return;
1509     }
1510
1511     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1512     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1513     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1514 }
1515
1516 static void
1517 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1518 {
1519     ds_put_cstr(string, leader);
1520     if (stat != UINT64_MAX) {
1521         ds_put_format(string, "%"PRIu64, stat);
1522     } else {
1523         ds_put_char(string, '?');
1524     }
1525     if (more) {
1526         ds_put_cstr(string, ", ");
1527     } else {
1528         ds_put_cstr(string, "\n");
1529     }
1530 }
1531
1532 static void
1533 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1534 {
1535     ofp_port_t ofp10_port;
1536     enum ofperr error;
1537
1538     error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1539     if (error) {
1540         ofp_print_error(string, error);
1541         return;
1542     }
1543
1544     ds_put_cstr(string, " port_no=");
1545     ofputil_format_port(ofp10_port, string);
1546 }
1547
1548 static void
1549 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1550                            int verbosity)
1551 {
1552     struct ofpbuf b;
1553
1554     ds_put_format(string, " %"PRIuSIZE" ports\n", ofputil_count_port_stats(oh));
1555     if (verbosity < 1) {
1556         return;
1557     }
1558
1559     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1560     for (;;) {
1561         struct ofputil_port_stats ps;
1562         int retval;
1563
1564         retval = ofputil_decode_port_stats(&ps, &b);
1565         if (retval) {
1566             if (retval != EOF) {
1567                 ds_put_cstr(string, " ***parse error***");
1568             }
1569             return;
1570         }
1571
1572         ds_put_cstr(string, "  port ");
1573         if (ofp_to_u16(ps.port_no) < 10) {
1574             ds_put_char(string, ' ');
1575         }
1576         ofputil_format_port(ps.port_no, string);
1577
1578         ds_put_cstr(string, ": rx ");
1579         print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1580         print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1581         print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1582         print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1583         print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1584         print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1585         print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1586
1587         ds_put_cstr(string, "           tx ");
1588         print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1589         print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1590         print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1591         print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1592         print_port_stat(string, "coll=", ps.stats.collisions, 0);
1593
1594         if (ps.duration_sec != UINT32_MAX) {
1595             ds_put_cstr(string, "           duration=");
1596             ofp_print_duration(string, ps.duration_sec, ps.duration_nsec);
1597             ds_put_char(string, '\n');
1598         }
1599     }
1600 }
1601
1602 static void
1603 ofp_print_one_ofpst_table_reply(struct ds *string, enum ofp_version ofp_version,
1604                                 const char *name, struct ofp12_table_stats *ts)
1605 {
1606     char name_[OFP_MAX_TABLE_NAME_LEN + 1];
1607
1608     /* ofp13_table_stats is different */
1609     if (ofp_version > OFP12_VERSION) {
1610         return;
1611     }
1612
1613     ovs_strlcpy(name_, name, sizeof name_);
1614
1615     ds_put_format(string, "  %d: %-8s: ", ts->table_id, name_);
1616     ds_put_format(string, "wild=0x%05"PRIx64", ", ntohll(ts->wildcards));
1617     ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1618     ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1619     ds_put_cstr(string, "               ");
1620     ds_put_format(string, "lookup=%"PRIu64", ", ntohll(ts->lookup_count));
1621     ds_put_format(string, "matched=%"PRIu64"\n", ntohll(ts->matched_count));
1622
1623     if (ofp_version < OFP11_VERSION) {
1624         return;
1625     }
1626
1627     ds_put_cstr(string, "               ");
1628     ds_put_format(string, "match=0x%08"PRIx64", ", ntohll(ts->match));
1629     ds_put_format(string, "instructions=0x%08"PRIx32", ",
1630                   ntohl(ts->instructions));
1631     ds_put_format(string, "config=0x%08"PRIx32"\n", ntohl(ts->config));
1632     ds_put_cstr(string, "               ");
1633     ds_put_format(string, "write_actions=0x%08"PRIx32", ",
1634                   ntohl(ts->write_actions));
1635     ds_put_format(string, "apply_actions=0x%08"PRIx32"\n",
1636                   ntohl(ts->apply_actions));
1637
1638     if (ofp_version < OFP12_VERSION) {
1639         return;
1640     }
1641
1642     ds_put_cstr(string, "               ");
1643     ds_put_format(string, "write_setfields=0x%016"PRIx64"\n",
1644                   ntohll(ts->write_setfields));
1645     ds_put_cstr(string, "               ");
1646     ds_put_format(string, "apply_setfields=0x%016"PRIx64"\n",
1647                   ntohll(ts->apply_setfields));
1648     ds_put_cstr(string, "               ");
1649     ds_put_format(string, "metadata_match=0x%016"PRIx64"\n",
1650                   ntohll(ts->metadata_match));
1651     ds_put_cstr(string, "               ");
1652     ds_put_format(string, "metadata_write=0x%016"PRIx64"\n",
1653                   ntohll(ts->metadata_write));
1654 }
1655
1656 static void
1657 ofp_print_ofpst_table_reply13(struct ds *string, const struct ofp_header *oh,
1658                               int verbosity)
1659 {
1660     struct ofp13_table_stats *ts;
1661     struct ofpbuf b;
1662     size_t n;
1663
1664     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1665     ofpraw_pull_assert(&b);
1666
1667     n = ofpbuf_size(&b) / sizeof *ts;
1668     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1669     if (verbosity < 1) {
1670         return;
1671     }
1672
1673     for (;;) {
1674         ts = ofpbuf_try_pull(&b, sizeof *ts);
1675         if (!ts) {
1676             return;
1677         }
1678         ds_put_format(string,
1679                       "  %d: active=%"PRIu32", lookup=%"PRIu64  \
1680                       ", matched=%"PRIu64"\n",
1681                       ts->table_id, ntohl(ts->active_count),
1682                       ntohll(ts->lookup_count), ntohll(ts->matched_count));
1683     }
1684 }
1685
1686 static void
1687 ofp_print_ofpst_table_reply12(struct ds *string, const struct ofp_header *oh,
1688                               int verbosity)
1689 {
1690     struct ofp12_table_stats *ts;
1691     struct ofpbuf b;
1692     size_t n;
1693
1694     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1695     ofpraw_pull_assert(&b);
1696
1697     n = ofpbuf_size(&b) / sizeof *ts;
1698     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1699     if (verbosity < 1) {
1700         return;
1701     }
1702
1703     for (;;) {
1704         ts = ofpbuf_try_pull(&b, sizeof *ts);
1705         if (!ts) {
1706             return;
1707         }
1708
1709         ofp_print_one_ofpst_table_reply(string, OFP12_VERSION, ts->name, ts);
1710      }
1711 }
1712
1713 static void
1714 ofp_print_ofpst_table_reply11(struct ds *string, const struct ofp_header *oh,
1715                               int verbosity)
1716 {
1717     struct ofp11_table_stats *ts;
1718     struct ofpbuf b;
1719     size_t n;
1720
1721     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1722     ofpraw_pull_assert(&b);
1723
1724     n = ofpbuf_size(&b) / sizeof *ts;
1725     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1726     if (verbosity < 1) {
1727         return;
1728     }
1729
1730     for (;;) {
1731         struct ofp12_table_stats ts12;
1732
1733         ts = ofpbuf_try_pull(&b, sizeof *ts);
1734         if (!ts) {
1735             return;
1736         }
1737
1738         ts12.table_id = ts->table_id;
1739         ts12.wildcards = htonll(ntohl(ts->wildcards));
1740         ts12.max_entries = ts->max_entries;
1741         ts12.active_count = ts->active_count;
1742         ts12.lookup_count = ts->lookup_count;
1743         ts12.matched_count = ts->matched_count;
1744         ts12.match = htonll(ntohl(ts->match));
1745         ts12.instructions = ts->instructions;
1746         ts12.config = ts->config;
1747         ts12.write_actions = ts->write_actions;
1748         ts12.apply_actions = ts->apply_actions;
1749         ofp_print_one_ofpst_table_reply(string, OFP11_VERSION, ts->name, &ts12);
1750      }
1751 }
1752
1753 static void
1754 ofp_print_ofpst_table_reply10(struct ds *string, const struct ofp_header *oh,
1755                               int verbosity)
1756 {
1757     struct ofp10_table_stats *ts;
1758     struct ofpbuf b;
1759     size_t n;
1760
1761     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1762     ofpraw_pull_assert(&b);
1763
1764     n = ofpbuf_size(&b) / sizeof *ts;
1765     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1766     if (verbosity < 1) {
1767         return;
1768     }
1769
1770     for (;;) {
1771         struct ofp12_table_stats ts12;
1772
1773         ts = ofpbuf_try_pull(&b, sizeof *ts);
1774         if (!ts) {
1775             return;
1776         }
1777
1778         ts12.table_id = ts->table_id;
1779         ts12.wildcards = htonll(ntohl(ts->wildcards));
1780         ts12.max_entries = ts->max_entries;
1781         ts12.active_count = ts->active_count;
1782         ts12.lookup_count = get_32aligned_be64(&ts->lookup_count);
1783         ts12.matched_count = get_32aligned_be64(&ts->matched_count);
1784         ofp_print_one_ofpst_table_reply(string, OFP10_VERSION, ts->name, &ts12);
1785      }
1786 }
1787
1788 static void
1789 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1790                             int verbosity)
1791 {
1792     switch ((enum ofp_version)oh->version) {
1793     case OFP14_VERSION:
1794     case OFP13_VERSION:
1795         ofp_print_ofpst_table_reply13(string, oh, verbosity);
1796         break;
1797
1798     case OFP12_VERSION:
1799         ofp_print_ofpst_table_reply12(string, oh, verbosity);
1800         break;
1801
1802     case OFP11_VERSION:
1803         ofp_print_ofpst_table_reply11(string, oh, verbosity);
1804         break;
1805
1806     case OFP10_VERSION:
1807         ofp_print_ofpst_table_reply10(string, oh, verbosity);
1808         break;
1809
1810     default:
1811         OVS_NOT_REACHED();
1812     }
1813 }
1814
1815 static void
1816 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1817 {
1818     if (queue_id == OFPQ_ALL) {
1819         ds_put_cstr(string, "ALL");
1820     } else {
1821         ds_put_format(string, "%"PRIu32, queue_id);
1822     }
1823 }
1824
1825 static void
1826 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1827 {
1828     struct ofputil_queue_stats_request oqsr;
1829     enum ofperr error;
1830
1831     error = ofputil_decode_queue_stats_request(oh, &oqsr);
1832     if (error) {
1833         ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1834         return;
1835     }
1836
1837     ds_put_cstr(string, "port=");
1838     ofputil_format_port(oqsr.port_no, string);
1839
1840     ds_put_cstr(string, " queue=");
1841     ofp_print_queue_name(string, oqsr.queue_id);
1842 }
1843
1844 static void
1845 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1846                             int verbosity)
1847 {
1848     struct ofpbuf b;
1849
1850     ds_put_format(string, " %"PRIuSIZE" queues\n", ofputil_count_queue_stats(oh));
1851     if (verbosity < 1) {
1852         return;
1853     }
1854
1855     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1856     for (;;) {
1857         struct ofputil_queue_stats qs;
1858         int retval;
1859
1860         retval = ofputil_decode_queue_stats(&qs, &b);
1861         if (retval) {
1862             if (retval != EOF) {
1863                 ds_put_cstr(string, " ***parse error***");
1864             }
1865             return;
1866         }
1867
1868         ds_put_cstr(string, "  port ");
1869         ofputil_format_port(qs.port_no, string);
1870         ds_put_cstr(string, " queue ");
1871         ofp_print_queue_name(string, qs.queue_id);
1872         ds_put_cstr(string, ": ");
1873
1874         print_port_stat(string, "bytes=", qs.tx_bytes, 1);
1875         print_port_stat(string, "pkts=", qs.tx_packets, 1);
1876         print_port_stat(string, "errors=", qs.tx_errors, 1);
1877
1878         ds_put_cstr(string, "duration=");
1879         if (qs.duration_sec != UINT32_MAX) {
1880             ofp_print_duration(string, qs.duration_sec, qs.duration_nsec);
1881         } else {
1882             ds_put_char(string, '?');
1883         }
1884         ds_put_char(string, '\n');
1885     }
1886 }
1887
1888 static void
1889 ofp_print_ofpst_port_desc_reply(struct ds *string,
1890                                 const struct ofp_header *oh)
1891 {
1892     struct ofpbuf b;
1893
1894     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1895     ofpraw_pull_assert(&b);
1896     ds_put_char(string, '\n');
1897     ofp_print_phy_ports(string, oh->version, &b);
1898 }
1899
1900 static void
1901 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1902 {
1903     uint16_t flags = ofpmp_flags(oh);
1904
1905     if (flags) {
1906         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1907     }
1908 }
1909
1910 static void
1911 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1912 {
1913     uint16_t flags = ofpmp_flags(oh);
1914
1915     if (flags) {
1916         ds_put_cstr(string, " flags=");
1917         if (flags & OFPSF_REPLY_MORE) {
1918             ds_put_cstr(string, "[more]");
1919             flags &= ~OFPSF_REPLY_MORE;
1920         }
1921         if (flags) {
1922             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1923                           flags);
1924         }
1925     }
1926 }
1927
1928 static void
1929 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1930 {
1931     size_t len = ntohs(oh->length);
1932
1933     ds_put_format(string, " %"PRIuSIZE" bytes of payload\n", len - sizeof *oh);
1934     if (verbosity > 1) {
1935         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1936     }
1937 }
1938
1939 static void
1940 ofp_print_role_generic(struct ds *string, enum ofp12_controller_role role,
1941                        uint64_t generation_id)
1942 {
1943     ds_put_cstr(string, " role=");
1944
1945     switch (role) {
1946     case OFPCR12_ROLE_NOCHANGE:
1947         ds_put_cstr(string, "nochange");
1948         break;
1949     case OFPCR12_ROLE_EQUAL:
1950         ds_put_cstr(string, "equal"); /* OF 1.2 wording */
1951         break;
1952     case OFPCR12_ROLE_MASTER:
1953         ds_put_cstr(string, "master");
1954         break;
1955     case OFPCR12_ROLE_SLAVE:
1956         ds_put_cstr(string, "slave");
1957         break;
1958     default:
1959         OVS_NOT_REACHED();
1960     }
1961
1962     if (generation_id != UINT64_MAX) {
1963         ds_put_format(string, " generation_id=%"PRIu64, generation_id);
1964     }
1965 }
1966
1967 static void
1968 ofp_print_role_message(struct ds *string, const struct ofp_header *oh)
1969 {
1970     struct ofputil_role_request rr;
1971     enum ofperr error;
1972
1973     error = ofputil_decode_role_message(oh, &rr);
1974     if (error) {
1975         ofp_print_error(string, error);
1976         return;
1977     }
1978
1979     ofp_print_role_generic(string, rr.role, rr.have_generation_id ? rr.generation_id : UINT64_MAX);
1980 }
1981
1982 static void
1983 ofp_print_role_status_message(struct ds *string, const struct ofp_header *oh)
1984 {
1985     struct ofputil_role_status rs;
1986     enum ofperr error;
1987
1988     error = ofputil_decode_role_status(oh, &rs);
1989     if (error) {
1990         ofp_print_error(string, error);
1991         return;
1992     }
1993
1994     ofp_print_role_generic(string, rs.role, rs.generation_id);
1995
1996     ds_put_cstr(string, " reason=");
1997
1998     switch (rs.reason) {
1999     case OFPCRR_MASTER_REQUEST:
2000         ds_put_cstr(string, "master_request");
2001         break;
2002     case OFPCRR_CONFIG:
2003         ds_put_cstr(string, "configuration_changed");
2004         break;
2005     case OFPCRR_EXPERIMENTER:
2006         ds_put_cstr(string, "experimenter_data_changed");
2007         break;
2008     default:
2009         OVS_NOT_REACHED();
2010     }
2011 }
2012
2013 static void
2014 ofp_print_nxt_flow_mod_table_id(struct ds *string,
2015                                 const struct nx_flow_mod_table_id *nfmti)
2016 {
2017     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
2018 }
2019
2020 static void
2021 ofp_print_nxt_set_flow_format(struct ds *string,
2022                               const struct nx_set_flow_format *nsff)
2023 {
2024     uint32_t format = ntohl(nsff->format);
2025
2026     ds_put_cstr(string, " format=");
2027     if (ofputil_nx_flow_format_is_valid(format)) {
2028         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
2029     } else {
2030         ds_put_format(string, "%"PRIu32, format);
2031     }
2032 }
2033
2034 static void
2035 ofp_print_nxt_set_packet_in_format(struct ds *string,
2036                                    const struct nx_set_packet_in_format *nspf)
2037 {
2038     uint32_t format = ntohl(nspf->format);
2039
2040     ds_put_cstr(string, " format=");
2041     if (ofputil_packet_in_format_is_valid(format)) {
2042         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
2043     } else {
2044         ds_put_format(string, "%"PRIu32, format);
2045     }
2046 }
2047
2048 /* Returns a string form of 'reason'.  The return value is either a statically
2049  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
2050  * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
2051 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
2052 static const char *
2053 ofp_port_reason_to_string(enum ofp_port_reason reason,
2054                           char *reasonbuf, size_t bufsize)
2055 {
2056     switch (reason) {
2057     case OFPPR_ADD:
2058         return "add";
2059
2060     case OFPPR_DELETE:
2061         return "delete";
2062
2063     case OFPPR_MODIFY:
2064         return "modify";
2065
2066     default:
2067         snprintf(reasonbuf, bufsize, "%d", (int) reason);
2068         return reasonbuf;
2069     }
2070 }
2071
2072 static void
2073 ofp_print_nxt_set_async_config(struct ds *string,
2074                                const struct nx_async_config *nac)
2075 {
2076     int i;
2077
2078     for (i = 0; i < 2; i++) {
2079         int j;
2080
2081         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
2082
2083         ds_put_cstr(string, "       PACKET_IN:");
2084         for (j = 0; j < 32; j++) {
2085             if (nac->packet_in_mask[i] & htonl(1u << j)) {
2086                 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
2087                 const char *reason;
2088
2089                 reason = ofputil_packet_in_reason_to_string(j, reasonbuf,
2090                                                             sizeof reasonbuf);
2091                 ds_put_format(string, " %s", reason);
2092             }
2093         }
2094         if (!nac->packet_in_mask[i]) {
2095             ds_put_cstr(string, " (off)");
2096         }
2097         ds_put_char(string, '\n');
2098
2099         ds_put_cstr(string, "     PORT_STATUS:");
2100         for (j = 0; j < 32; j++) {
2101             if (nac->port_status_mask[i] & htonl(1u << j)) {
2102                 char reasonbuf[OFP_PORT_REASON_BUFSIZE];
2103                 const char *reason;
2104
2105                 reason = ofp_port_reason_to_string(j, reasonbuf,
2106                                                    sizeof reasonbuf);
2107                 ds_put_format(string, " %s", reason);
2108             }
2109         }
2110         if (!nac->port_status_mask[i]) {
2111             ds_put_cstr(string, " (off)");
2112         }
2113         ds_put_char(string, '\n');
2114
2115         ds_put_cstr(string, "    FLOW_REMOVED:");
2116         for (j = 0; j < 32; j++) {
2117             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
2118                 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2119                 const char *reason;
2120
2121                 reason = ofp_flow_removed_reason_to_string(j, reasonbuf,
2122                                                            sizeof reasonbuf);
2123                 ds_put_format(string, " %s", reason);
2124             }
2125         }
2126         if (!nac->flow_removed_mask[i]) {
2127             ds_put_cstr(string, " (off)");
2128         }
2129         ds_put_char(string, '\n');
2130     }
2131 }
2132
2133 static void
2134 ofp_print_nxt_set_controller_id(struct ds *string,
2135                                 const struct nx_controller_id *nci)
2136 {
2137     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
2138 }
2139
2140 static void
2141 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
2142                                   const struct ofp_header *oh)
2143 {
2144     ds_put_format(string, " id=%"PRIu32,
2145                   ofputil_decode_flow_monitor_cancel(oh));
2146 }
2147
2148 static const char *
2149 nx_flow_monitor_flags_to_name(uint32_t bit)
2150 {
2151     enum nx_flow_monitor_flags fmf = bit;
2152
2153     switch (fmf) {
2154     case NXFMF_INITIAL: return "initial";
2155     case NXFMF_ADD: return "add";
2156     case NXFMF_DELETE: return "delete";
2157     case NXFMF_MODIFY: return "modify";
2158     case NXFMF_ACTIONS: return "actions";
2159     case NXFMF_OWN: return "own";
2160     }
2161
2162     return NULL;
2163 }
2164
2165 static void
2166 ofp_print_nxst_flow_monitor_request(struct ds *string,
2167                                     const struct ofp_header *oh)
2168 {
2169     struct ofpbuf b;
2170
2171     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2172     for (;;) {
2173         struct ofputil_flow_monitor_request request;
2174         int retval;
2175
2176         retval = ofputil_decode_flow_monitor_request(&request, &b);
2177         if (retval) {
2178             if (retval != EOF) {
2179                 ofp_print_error(string, retval);
2180             }
2181             return;
2182         }
2183
2184         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
2185         ofp_print_bit_names(string, request.flags,
2186                             nx_flow_monitor_flags_to_name, ',');
2187
2188         if (request.out_port != OFPP_NONE) {
2189             ds_put_cstr(string, " out_port=");
2190             ofputil_format_port(request.out_port, string);
2191         }
2192
2193         if (request.table_id != 0xff) {
2194             ds_put_format(string, " table=%"PRIu8, request.table_id);
2195         }
2196
2197         ds_put_char(string, ' ');
2198         match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
2199         ds_chomp(string, ' ');
2200     }
2201 }
2202
2203 static void
2204 ofp_print_nxst_flow_monitor_reply(struct ds *string,
2205                                   const struct ofp_header *oh)
2206 {
2207     uint64_t ofpacts_stub[1024 / 8];
2208     struct ofpbuf ofpacts;
2209     struct ofpbuf b;
2210
2211     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2212     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2213     for (;;) {
2214         char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2215         struct ofputil_flow_update update;
2216         struct match match;
2217         int retval;
2218
2219         update.match = &match;
2220         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
2221         if (retval) {
2222             if (retval != EOF) {
2223                 ofp_print_error(string, retval);
2224             }
2225             ofpbuf_uninit(&ofpacts);
2226             return;
2227         }
2228
2229         ds_put_cstr(string, "\n event=");
2230         switch (update.event) {
2231         case NXFME_ADDED:
2232             ds_put_cstr(string, "ADDED");
2233             break;
2234
2235         case NXFME_DELETED:
2236             ds_put_format(string, "DELETED reason=%s",
2237                           ofp_flow_removed_reason_to_string(update.reason,
2238                                                             reasonbuf,
2239                                                             sizeof reasonbuf));
2240             break;
2241
2242         case NXFME_MODIFIED:
2243             ds_put_cstr(string, "MODIFIED");
2244             break;
2245
2246         case NXFME_ABBREV:
2247             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
2248             continue;
2249         }
2250
2251         ds_put_format(string, " table=%"PRIu8, update.table_id);
2252         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
2253             ds_put_format(string, " idle_timeout=%"PRIu16,
2254                           update.idle_timeout);
2255         }
2256         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
2257             ds_put_format(string, " hard_timeout=%"PRIu16,
2258                           update.hard_timeout);
2259         }
2260         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
2261
2262         ds_put_char(string, ' ');
2263         match_format(update.match, string, OFP_DEFAULT_PRIORITY);
2264
2265         if (update.ofpacts_len) {
2266             if (string->string[string->length - 1] != ' ') {
2267                 ds_put_char(string, ' ');
2268             }
2269             ds_put_cstr(string, "actions=");
2270             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
2271         }
2272     }
2273 }
2274
2275 void
2276 ofp_print_version(const struct ofp_header *oh,
2277                   struct ds *string)
2278 {
2279     switch (oh->version) {
2280     case OFP10_VERSION:
2281         break;
2282     case OFP11_VERSION:
2283         ds_put_cstr(string, " (OF1.1)");
2284         break;
2285     case OFP12_VERSION:
2286         ds_put_cstr(string, " (OF1.2)");
2287         break;
2288     case OFP13_VERSION:
2289         ds_put_cstr(string, " (OF1.3)");
2290         break;
2291     default:
2292         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
2293         break;
2294     }
2295     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
2296 }
2297
2298 static void
2299 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2300                        struct ds *string)
2301 {
2302     ds_put_cstr(string, ofpraw_get_name(raw));
2303     ofp_print_version(oh, string);
2304 }
2305
2306 static void
2307 ofp_print_group(struct ds *s, uint32_t group_id, uint8_t type,
2308                 struct list *p_buckets)
2309 {
2310     static const char *type_str[] = { "all", "select", "indirect",
2311                                       "ff", "unknown" };
2312     struct ofputil_bucket *bucket;
2313
2314     ds_put_format(s, "group_id=%"PRIu32",type=%s",
2315                   group_id, type_str[type > 4 ? 4 : type]);
2316     if (!p_buckets) {
2317         return;
2318     }
2319
2320     LIST_FOR_EACH (bucket, list_node, p_buckets) {
2321         ds_put_cstr(s, ",bucket=");
2322
2323         if (bucket->weight != 1) {
2324             ds_put_format(s, "weight:%"PRIu16",", bucket->weight);
2325         }
2326         if (bucket->watch_port != OFPP_NONE) {
2327             ds_put_format(s, "watch_port:%"PRIu32",", bucket->watch_port);
2328         }
2329         if (bucket->watch_group != OFPG11_ANY) {
2330             ds_put_format(s, "watch_group:%"PRIu32",", bucket->watch_group);
2331         }
2332
2333         ds_put_cstr(s, "actions=");
2334         ofpacts_format(bucket->ofpacts, bucket->ofpacts_len, s);
2335     }
2336 }
2337
2338 static void
2339 ofp_print_group_desc(struct ds *s, const struct ofp_header *oh)
2340 {
2341     struct ofpbuf b;
2342
2343     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2344     for (;;) {
2345         struct ofputil_group_desc gd;
2346         int retval;
2347
2348         retval = ofputil_decode_group_desc_reply(&gd, &b, oh->version);
2349         if (retval) {
2350             if (retval != EOF) {
2351                 ds_put_cstr(s, " ***parse error***");
2352             }
2353             break;
2354         }
2355
2356         ds_put_char(s, '\n');
2357         ds_put_char(s, ' ');
2358         ofp_print_group(s, gd.group_id, gd.type, &gd.buckets);
2359      }
2360 }
2361
2362 static void
2363 ofp_print_ofpst_group_request(struct ds *string, const struct ofp_header *oh)
2364 {
2365     enum ofperr error;
2366     uint32_t group_id;
2367
2368     error = ofputil_decode_group_stats_request(oh, &group_id);
2369     if (error) {
2370         ofp_print_error(string, error);
2371         return;
2372     }
2373
2374     ds_put_cstr(string, " group_id=");
2375     ofputil_format_group(group_id, string);
2376 }
2377
2378 static void
2379 ofp_print_group_stats(struct ds *s, const struct ofp_header *oh)
2380 {
2381     struct ofpbuf b;
2382     uint32_t bucket_i;
2383
2384     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2385
2386     for (;;) {
2387         struct ofputil_group_stats gs;
2388         int retval;
2389
2390         retval = ofputil_decode_group_stats_reply(&b, &gs);
2391         if (retval) {
2392             if (retval != EOF) {
2393                 ds_put_cstr(s, " ***parse error***");
2394             }
2395             break;
2396         }
2397
2398         ds_put_char(s, '\n');
2399
2400         ds_put_char(s, ' ');
2401         ds_put_format(s, "group_id=%"PRIu32",", gs.group_id);
2402
2403         if (gs.duration_sec != UINT32_MAX) {
2404             ds_put_cstr(s, "duration=");
2405             ofp_print_duration(s, gs.duration_sec, gs.duration_nsec);
2406             ds_put_char(s, ',');
2407         }
2408         ds_put_format(s, "ref_count=%"PRIu32",", gs.ref_count);
2409         ds_put_format(s, "packet_count=%"PRIu64",", gs.packet_count);
2410         ds_put_format(s, "byte_count=%"PRIu64"", gs.byte_count);
2411
2412         for (bucket_i = 0; bucket_i < gs.n_buckets; bucket_i++) {
2413             if (gs.bucket_stats[bucket_i].packet_count != UINT64_MAX) {
2414                 ds_put_format(s, ",bucket%"PRIu32":", bucket_i);
2415                 ds_put_format(s, "packet_count=%"PRIu64",", gs.bucket_stats[bucket_i].packet_count);
2416                 ds_put_format(s, "byte_count=%"PRIu64"", gs.bucket_stats[bucket_i].byte_count);
2417             }
2418         }
2419
2420         free(gs.bucket_stats);
2421      }
2422 }
2423
2424 static void
2425 ofp_print_group_features(struct ds *string, const struct ofp_header *oh)
2426 {
2427     struct ofputil_group_features features;
2428
2429     ofputil_decode_group_features_reply(oh, &features);
2430
2431     ds_put_format(string, "\n Group table:\n");
2432     ds_put_format(string, "    Types:  0x%"PRIx32"\n", features.types);
2433     ds_put_format(string, "    Capabilities:  0x%"PRIx32"\n",
2434                   features.capabilities);
2435
2436     if (features.types & (1u << OFPGT11_ALL)) {
2437         ds_put_format(string, "    All group :\n");
2438         ds_put_format(string,
2439                       "        max_groups = %#"PRIx32" actions=0x%08"PRIx32"\n",
2440                       features.max_groups[0], features.actions[0]);
2441     }
2442
2443     if (features.types & (1u << OFPGT11_SELECT)) {
2444         ds_put_format(string, "    Select group :\n");
2445         ds_put_format(string, "        max_groups = %#"PRIx32" "
2446                       "actions=0x%08"PRIx32"\n",
2447                       features.max_groups[1], features.actions[1]);
2448     }
2449
2450     if (features.types & (1u << OFPGT11_INDIRECT)) {
2451         ds_put_format(string, "    Indirect group :\n");
2452         ds_put_format(string, "        max_groups = %#"PRIx32" "
2453                       "actions=0x%08"PRIx32"\n",
2454                       features.max_groups[2], features.actions[2]);
2455     }
2456
2457     if (features.types & (1u << OFPGT11_FF)) {
2458         ds_put_format(string, "    Fast Failover group :\n");
2459         ds_put_format(string, "        max_groups = %#"PRIx32" "
2460                       "actions=0x%08"PRIx32"\n",
2461                       features.max_groups[3], features.actions[3]);
2462     }
2463 }
2464
2465 static void
2466 ofp_print_group_mod(struct ds *s, const struct ofp_header *oh)
2467 {
2468     struct ofputil_group_mod gm;
2469     int error;
2470
2471     error = ofputil_decode_group_mod(oh, &gm);
2472     if (error) {
2473         ofp_print_error(s, error);
2474         return;
2475     }
2476
2477     ds_put_char(s, '\n');
2478
2479     ds_put_char(s, ' ');
2480     switch (gm.command) {
2481     case OFPGC11_ADD:
2482         ds_put_cstr(s, "ADD");
2483         break;
2484
2485     case OFPGC11_MODIFY:
2486         ds_put_cstr(s, "MOD");
2487         break;
2488
2489     case OFPGC11_DELETE:
2490         ds_put_cstr(s, "DEL");
2491         break;
2492
2493     default:
2494         ds_put_format(s, "cmd:%"PRIu16"", gm.command);
2495     }
2496     ds_put_char(s, ' ');
2497
2498     ofp_print_group(s, gm.group_id, gm.type, &gm.buckets);
2499 }
2500
2501 static const char *
2502 ofp13_action_to_string(uint32_t bit)
2503 {
2504     switch (bit) {
2505 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
2506         case 1u << ENUM: return NAME;
2507 #include "ofp-util.def"
2508     }
2509     return NULL;
2510 }
2511
2512 static void
2513 print_table_action_features(struct ds *s,
2514                             const struct ofputil_table_action_features *taf)
2515 {
2516     ds_put_cstr(s, "        actions: ");
2517     ofp_print_bit_names(s, taf->actions, ofp13_action_to_string, ',');
2518     ds_put_char(s, '\n');
2519
2520     ds_put_cstr(s, "        supported on Set-Field: ");
2521     if (taf->set_fields) {
2522         int i;
2523
2524         for (i = 0; i < MFF_N_IDS; i++) {
2525             uint64_t bit = UINT64_C(1) << i;
2526
2527             if (taf->set_fields & bit) {
2528                 ds_put_format(s, "%s,", mf_from_id(i)->name);
2529             }
2530         }
2531         ds_chomp(s, ',');
2532     } else {
2533         ds_put_cstr(s, "none");
2534     }
2535     ds_put_char(s, '\n');
2536 }
2537
2538 static bool
2539 table_action_features_equal(const struct ofputil_table_action_features *a,
2540                             const struct ofputil_table_action_features *b)
2541 {
2542     return a->actions == b->actions && a->set_fields == b->set_fields;
2543 }
2544
2545 static void
2546 print_table_instruction_features(
2547     struct ds *s, const struct ofputil_table_instruction_features *tif)
2548 {
2549     int start, end;
2550
2551     ds_put_cstr(s, "      next tables: ");
2552     for (start = bitmap_scan(tif->next, 1, 0, 255); start < 255;
2553          start = bitmap_scan(tif->next, 1, end, 255)) {
2554         end = bitmap_scan(tif->next, 0, start + 1, 255);
2555         if (end == start + 1) {
2556             ds_put_format(s, "%d,", start);
2557         } else {
2558             ds_put_format(s, "%d-%d,", start, end - 1);
2559         }
2560     }
2561     ds_chomp(s, ',');
2562     if (ds_last(s) == ' ') {
2563         ds_put_cstr(s, "none");
2564     }
2565     ds_put_char(s, '\n');
2566
2567     ds_put_cstr(s, "      instructions: ");
2568     if (tif->instructions) {
2569         int i;
2570
2571         for (i = 0; i < 32; i++) {
2572             if (tif->instructions & (1u << i)) {
2573                 ds_put_format(s, "%s,", ovs_instruction_name_from_type(i));
2574             }
2575         }
2576         ds_chomp(s, ',');
2577     } else {
2578         ds_put_cstr(s, "none");
2579     }
2580     ds_put_char(s, '\n');
2581
2582     if (table_action_features_equal(&tif->write, &tif->apply)) {
2583         ds_put_cstr(s, "      Write-Actions and Apply-Actions features:\n");
2584         print_table_action_features(s, &tif->write);
2585     } else {
2586         ds_put_cstr(s, "      Write-Actions features:\n");
2587         print_table_action_features(s, &tif->write);
2588         ds_put_cstr(s, "      Apply-Actions features:\n");
2589         print_table_action_features(s, &tif->apply);
2590     }
2591 }
2592
2593 static bool
2594 table_instruction_features_equal(
2595     const struct ofputil_table_instruction_features *a,
2596     const struct ofputil_table_instruction_features *b)
2597 {
2598     return (bitmap_equal(a->next, b->next, 255)
2599             && a->instructions == b->instructions
2600             && table_action_features_equal(&a->write, &b->write)
2601             && table_action_features_equal(&a->apply, &b->apply));
2602 }
2603
2604 static void
2605 ofp_print_table_features(struct ds *s, const struct ofp_header *oh)
2606 {
2607     struct ofpbuf b;
2608
2609     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2610
2611     for (;;) {
2612         struct ofputil_table_features tf;
2613         int retval;
2614         int i;
2615
2616         retval = ofputil_decode_table_features(&b, &tf, true);
2617         if (retval) {
2618             if (retval != EOF) {
2619                 ofp_print_error(s, retval);
2620             }
2621             return;
2622         }
2623
2624         ds_put_format(s, "\n  table %"PRIu8":\n", tf.table_id);
2625         ds_put_format(s, "    name=\"%s\"\n", tf.name);
2626         ds_put_format(s, "    metadata: match=%#"PRIx64" write=%#"PRIx64"\n",
2627                       ntohll(tf.metadata_match), ntohll(tf.metadata_write));
2628
2629         ds_put_cstr(s, "    config=");
2630         ofp_print_table_miss_config(s, tf.config);
2631
2632         ds_put_format(s, "    max_entries=%"PRIu32"\n", tf.max_entries);
2633
2634         if (table_instruction_features_equal(&tf.nonmiss, &tf.miss)) {
2635             ds_put_cstr(s, "    instructions (table miss and others):\n");
2636             print_table_instruction_features(s, &tf.nonmiss);
2637         } else {
2638             ds_put_cstr(s, "    instructions (other than table miss):\n");
2639             print_table_instruction_features(s, &tf.nonmiss);
2640             ds_put_cstr(s, "    instructions (table miss):\n");
2641             print_table_instruction_features(s, &tf.miss);
2642         }
2643
2644         ds_put_cstr(s, "    matching:\n");
2645         for (i = 0; i < MFF_N_IDS; i++) {
2646             uint64_t bit = UINT64_C(1) << i;
2647
2648             if (tf.match & bit) {
2649                 const struct mf_field *f = mf_from_id(i);
2650
2651                 ds_put_format(s, "      %s: %s\n",
2652                               f->name,
2653                               (tf.mask ? "arbitrary mask"
2654                                : tf.wildcard ? "exact match or wildcard"
2655                                : "must exact match"));
2656             }
2657         }
2658     }
2659 }
2660
2661 static void
2662 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2663                 struct ds *string, int verbosity)
2664 {
2665     const void *msg = oh;
2666
2667     ofp_header_to_string__(oh, raw, string);
2668     switch (ofptype_from_ofpraw(raw)) {
2669
2670     case OFPTYPE_GROUP_STATS_REQUEST:
2671         ofp_print_stats_request(string, oh);
2672         ofp_print_ofpst_group_request(string, oh);
2673         break;
2674
2675     case OFPTYPE_GROUP_STATS_REPLY:
2676         ofp_print_group_stats(string, oh);
2677         break;
2678
2679     case OFPTYPE_GROUP_DESC_STATS_REQUEST:
2680         ofp_print_stats_request(string, oh);
2681         break;
2682
2683     case OFPTYPE_GROUP_DESC_STATS_REPLY:
2684         ofp_print_group_desc(string, oh);
2685         break;
2686
2687     case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
2688         ofp_print_stats_request(string, oh);
2689         break;
2690
2691     case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
2692         ofp_print_group_features(string, oh);
2693         break;
2694
2695     case OFPTYPE_GROUP_MOD:
2696         ofp_print_group_mod(string, oh);
2697         break;
2698
2699     case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
2700     case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
2701         ofp_print_table_features(string, oh);
2702         break;
2703
2704     case OFPTYPE_HELLO:
2705         ofp_print_hello(string, oh);
2706         break;
2707
2708     case OFPTYPE_ERROR:
2709         ofp_print_error_msg(string, oh);
2710         break;
2711
2712     case OFPTYPE_ECHO_REQUEST:
2713     case OFPTYPE_ECHO_REPLY:
2714         ofp_print_echo(string, oh, verbosity);
2715         break;
2716
2717     case OFPTYPE_FEATURES_REQUEST:
2718         break;
2719
2720     case OFPTYPE_FEATURES_REPLY:
2721         ofp_print_switch_features(string, oh);
2722         break;
2723
2724     case OFPTYPE_GET_CONFIG_REQUEST:
2725         break;
2726
2727     case OFPTYPE_GET_CONFIG_REPLY:
2728     case OFPTYPE_SET_CONFIG:
2729         ofp_print_switch_config(string, ofpmsg_body(oh));
2730         break;
2731
2732     case OFPTYPE_PACKET_IN:
2733         ofp_print_packet_in(string, oh, verbosity);
2734         break;
2735
2736     case OFPTYPE_FLOW_REMOVED:
2737         ofp_print_flow_removed(string, oh);
2738         break;
2739
2740     case OFPTYPE_PORT_STATUS:
2741         ofp_print_port_status(string, oh);
2742         break;
2743
2744     case OFPTYPE_PACKET_OUT:
2745         ofp_print_packet_out(string, oh, verbosity);
2746         break;
2747
2748     case OFPTYPE_FLOW_MOD:
2749         ofp_print_flow_mod(string, oh, verbosity);
2750         break;
2751
2752     case OFPTYPE_PORT_MOD:
2753         ofp_print_port_mod(string, oh);
2754         break;
2755
2756     case OFPTYPE_TABLE_MOD:
2757         ofp_print_table_mod(string, oh);
2758         break;
2759
2760     case OFPTYPE_METER_MOD:
2761         ofp_print_meter_mod(string, oh);
2762         break;
2763
2764     case OFPTYPE_BARRIER_REQUEST:
2765     case OFPTYPE_BARRIER_REPLY:
2766         break;
2767
2768     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
2769         ofp_print_queue_get_config_request(string, oh);
2770         break;
2771
2772     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
2773         ofp_print_queue_get_config_reply(string, oh);
2774         break;
2775
2776     case OFPTYPE_ROLE_REQUEST:
2777     case OFPTYPE_ROLE_REPLY:
2778         ofp_print_role_message(string, oh);
2779         break;
2780     case OFPTYPE_ROLE_STATUS:
2781         ofp_print_role_status_message(string, oh);
2782         break;
2783
2784     case OFPTYPE_METER_STATS_REQUEST:
2785     case OFPTYPE_METER_CONFIG_STATS_REQUEST:
2786         ofp_print_stats_request(string, oh);
2787         ofp_print_meter_stats_request(string, oh);
2788         break;
2789
2790     case OFPTYPE_METER_STATS_REPLY:
2791         ofp_print_stats_reply(string, oh);
2792         ofp_print_meter_stats_reply(string, oh);
2793         break;
2794
2795     case OFPTYPE_METER_CONFIG_STATS_REPLY:
2796         ofp_print_stats_reply(string, oh);
2797         ofp_print_meter_config_reply(string, oh);
2798         break;
2799
2800     case OFPTYPE_METER_FEATURES_STATS_REPLY:
2801         ofp_print_stats_reply(string, oh);
2802         ofp_print_meter_features_reply(string, oh);
2803         break;
2804
2805     case OFPTYPE_DESC_STATS_REQUEST:
2806     case OFPTYPE_PORT_DESC_STATS_REQUEST:
2807     case OFPTYPE_METER_FEATURES_STATS_REQUEST:
2808         ofp_print_stats_request(string, oh);
2809         break;
2810
2811     case OFPTYPE_FLOW_STATS_REQUEST:
2812     case OFPTYPE_AGGREGATE_STATS_REQUEST:
2813         ofp_print_stats_request(string, oh);
2814         ofp_print_flow_stats_request(string, oh);
2815         break;
2816
2817     case OFPTYPE_TABLE_STATS_REQUEST:
2818         ofp_print_stats_request(string, oh);
2819         break;
2820
2821     case OFPTYPE_PORT_STATS_REQUEST:
2822         ofp_print_stats_request(string, oh);
2823         ofp_print_ofpst_port_request(string, oh);
2824         break;
2825
2826     case OFPTYPE_QUEUE_STATS_REQUEST:
2827         ofp_print_stats_request(string, oh);
2828         ofp_print_ofpst_queue_request(string, oh);
2829         break;
2830
2831     case OFPTYPE_DESC_STATS_REPLY:
2832         ofp_print_stats_reply(string, oh);
2833         ofp_print_ofpst_desc_reply(string, oh);
2834         break;
2835
2836     case OFPTYPE_FLOW_STATS_REPLY:
2837         ofp_print_stats_reply(string, oh);
2838         ofp_print_flow_stats_reply(string, oh);
2839         break;
2840
2841     case OFPTYPE_QUEUE_STATS_REPLY:
2842         ofp_print_stats_reply(string, oh);
2843         ofp_print_ofpst_queue_reply(string, oh, verbosity);
2844         break;
2845
2846     case OFPTYPE_PORT_STATS_REPLY:
2847         ofp_print_stats_reply(string, oh);
2848         ofp_print_ofpst_port_reply(string, oh, verbosity);
2849         break;
2850
2851     case OFPTYPE_TABLE_STATS_REPLY:
2852         ofp_print_stats_reply(string, oh);
2853         ofp_print_ofpst_table_reply(string, oh, verbosity);
2854         break;
2855
2856     case OFPTYPE_AGGREGATE_STATS_REPLY:
2857         ofp_print_stats_reply(string, oh);
2858         ofp_print_aggregate_stats_reply(string, oh);
2859         break;
2860
2861     case OFPTYPE_PORT_DESC_STATS_REPLY:
2862         ofp_print_stats_reply(string, oh);
2863         ofp_print_ofpst_port_desc_reply(string, oh);
2864         break;
2865
2866     case OFPTYPE_FLOW_MOD_TABLE_ID:
2867         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
2868         break;
2869
2870     case OFPTYPE_SET_FLOW_FORMAT:
2871         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
2872         break;
2873
2874     case OFPTYPE_SET_PACKET_IN_FORMAT:
2875         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
2876         break;
2877
2878     case OFPTYPE_FLOW_AGE:
2879         break;
2880
2881     case OFPTYPE_SET_CONTROLLER_ID:
2882         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
2883         break;
2884
2885     case OFPTYPE_GET_ASYNC_REPLY:
2886     case OFPTYPE_SET_ASYNC_CONFIG:
2887         ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
2888         break;
2889     case OFPTYPE_GET_ASYNC_REQUEST:
2890         break;
2891     case OFPTYPE_FLOW_MONITOR_CANCEL:
2892         ofp_print_nxt_flow_monitor_cancel(string, msg);
2893         break;
2894
2895     case OFPTYPE_FLOW_MONITOR_PAUSED:
2896     case OFPTYPE_FLOW_MONITOR_RESUMED:
2897         break;
2898
2899     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
2900         ofp_print_nxst_flow_monitor_request(string, msg);
2901         break;
2902
2903     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
2904         ofp_print_nxst_flow_monitor_reply(string, msg);
2905         break;
2906     }
2907 }
2908
2909 /* Composes and returns a string representing the OpenFlow packet of 'len'
2910  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
2911  * verbosity and higher numbers increase verbosity.  The caller is responsible
2912  * for freeing the string. */
2913 char *
2914 ofp_to_string(const void *oh_, size_t len, int verbosity)
2915 {
2916     struct ds string = DS_EMPTY_INITIALIZER;
2917     const struct ofp_header *oh = oh_;
2918
2919     if (!len) {
2920         ds_put_cstr(&string, "OpenFlow message is empty\n");
2921     } else if (len < sizeof(struct ofp_header)) {
2922         ds_put_format(&string, "OpenFlow packet too short (only %"PRIuSIZE" bytes):\n",
2923                       len);
2924     } else if (ntohs(oh->length) > len) {
2925         enum ofperr error;
2926         enum ofpraw raw;
2927
2928         error = ofpraw_decode_partial(&raw, oh, len);
2929         if (!error) {
2930             ofp_header_to_string__(oh, raw, &string);
2931             ds_put_char(&string, '\n');
2932         }
2933
2934         ds_put_format(&string,
2935                       "(***truncated to %"PRIuSIZE" bytes from %"PRIu16"***)\n",
2936                       len, ntohs(oh->length));
2937     } else if (ntohs(oh->length) < len) {
2938         ds_put_format(&string,
2939                       "(***only uses %"PRIu16" bytes out of %"PRIuSIZE"***)\n",
2940                       ntohs(oh->length), len);
2941     } else {
2942         enum ofperr error;
2943         enum ofpraw raw;
2944
2945         error = ofpraw_decode(&raw, oh);
2946         if (!error) {
2947             ofp_to_string__(oh, raw, &string, verbosity);
2948             if (verbosity >= 5) {
2949                 if (ds_last(&string) != '\n') {
2950                     ds_put_char(&string, '\n');
2951                 }
2952                 ds_put_hex_dump(&string, oh, len, 0, true);
2953             }
2954             if (ds_last(&string) != '\n') {
2955                 ds_put_char(&string, '\n');
2956             }
2957             return ds_steal_cstr(&string);
2958         }
2959
2960         ofp_print_error(&string, error);
2961     }
2962     ds_put_hex_dump(&string, oh, len, 0, true);
2963     return ds_steal_cstr(&string);
2964 }
2965 \f
2966 static void
2967 print_and_free(FILE *stream, char *string)
2968 {
2969     fputs(string, stream);
2970     free(string);
2971 }
2972
2973 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
2974  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
2975  * numbers increase verbosity. */
2976 void
2977 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
2978 {
2979     print_and_free(stream, ofp_to_string(oh, len, verbosity));
2980 }
2981
2982 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
2983  * 'data' to 'stream'. */
2984 void
2985 ofp_print_packet(FILE *stream, const void *data, size_t len)
2986 {
2987     print_and_free(stream, ofp_packet_to_string(data, len));
2988 }