lib/ofp-print.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 "pcap.h"
  48 #include "type-props.h"
  49 #include "unaligned.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     struct ofpbuf buf;
  63     struct flow flow;
  64
  65     ofpbuf_use_const(&buf, data, len);
  66     flow_extract(&buf, 0, NULL, 0, &flow);
  67     flow_format(&ds, &flow);
  68
  69     if (buf.l7) {
  70         if (flow.nw_proto == IPPROTO_TCP) {
  71             struct tcp_header *th = buf.l4;
  72             ds_put_format(&ds, " tcp_csum:%"PRIx16,
  73                           ntohs(th->tcp_csum));
  74         } else if (flow.nw_proto == IPPROTO_UDP) {
  75             struct udp_header *uh = buf.l4;
  76             ds_put_format(&ds, " udp_csum:%"PRIx16,
  77                           ntohs(uh->udp_csum));
  78         }
  79     }
  80
  81     ds_put_char(&ds, '\n');
  82
  83     return ds_cstr(&ds);
  84 }
  85
  86 static void
  87 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
  88                     int verbosity)
  89 {
  90     struct ofputil_packet_in pin;
  91     int error;
  92     int i;
  93
  94     error = ofputil_decode_packet_in(&pin, oh);
  95     if (error) {
  96         ofp_print_error(string, error);
  97         return;
  98     }
  99
 100     if (pin.table_id) {
 101         ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
 102     }
 103
 104     if (pin.cookie) {
 105         ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
 106     }
 107
 108     ds_put_format(string, " total_len=%"PRIu16" in_port=", pin.total_len);
 109     ofputil_format_port(pin.fmd.in_port, string);
 110
 111     if (pin.fmd.tun_id != htonll(0)) {
 112         ds_put_format(string, " tun_id=0x%"PRIx64, ntohll(pin.fmd.tun_id));
 113     }
 114
 115     if (pin.fmd.metadata != htonll(0)) {
 116         ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
 117     }
 118
 119     for (i = 0; i < FLOW_N_REGS; i++) {
 120         if (pin.fmd.regs[i]) {
 121             ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
 122         }
 123     }
 124
 125     ds_put_format(string, " (via %s)",
 126                   ofputil_packet_in_reason_to_string(pin.reason));
 127
 128     ds_put_format(string, " data_len=%zu", pin.packet_len);
 129     if (pin.buffer_id == UINT32_MAX) {
 130         ds_put_format(string, " (unbuffered)");
 131         if (pin.total_len != pin.packet_len) {
 132             ds_put_format(string, " (***total_len != data_len***)");
 133         }
 134     } else {
 135         ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
 136         if (pin.total_len < pin.packet_len) {
 137             ds_put_format(string, " (***total_len < data_len***)");
 138         }
 139     }
 140     ds_put_char(string, '\n');
 141
 142     if (verbosity > 0) {
 143         char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
 144         ds_put_cstr(string, packet);
 145         free(packet);
 146     }
 147 }
 148
 149 static void
 150 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
 151                      int verbosity)
 152 {
 153     struct ofputil_packet_out po;
 154     struct ofpbuf ofpacts;
 155     enum ofperr error;
 156
 157     ofpbuf_init(&ofpacts, 64);
 158     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
 159     if (error) {
 160         ofpbuf_uninit(&ofpacts);
 161         ofp_print_error(string, error);
 162         return;
 163     }
 164
 165     ds_put_cstr(string, " in_port=");
 166     ofputil_format_port(po.in_port, string);
 167
 168     ds_put_char(string, ' ');
 169     ofpacts_format(po.ofpacts, po.ofpacts_len, string);
 170
 171     if (po.buffer_id == UINT32_MAX) {
 172         ds_put_format(string, " data_len=%zu", po.packet_len);
 173         if (verbosity > 0 && po.packet_len > 0) {
 174             char *packet = ofp_packet_to_string(po.packet, po.packet_len);
 175             ds_put_char(string, '\n');
 176             ds_put_cstr(string, packet);
 177             free(packet);
 178         }
 179     } else {
 180         ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
 181     }
 182     ds_put_char(string, '\n');
 183
 184     ofpbuf_uninit(&ofpacts);
 185 }
 186
 187 /* qsort comparison function. */
 188 static int
 189 compare_ports(const void *a_, const void *b_)
 190 {
 191     const struct ofputil_phy_port *a = a_;
 192     const struct ofputil_phy_port *b = b_;
 193     uint16_t ap = a->port_no;
 194     uint16_t bp = b->port_no;
 195
 196     return ap < bp ? -1 : ap > bp;
 197 }
 198
 199 static void
 200 ofp_print_bit_names(struct ds *string, uint32_t bits,
 201                     const char *(*bit_to_name)(uint32_t bit),
 202                     char separator)
 203 {
 204     int n = 0;
 205     int i;
 206
 207     if (!bits) {
 208         ds_put_cstr(string, "0");
 209         return;
 210     }
 211
 212     for (i = 0; i < 32; i++) {
 213         uint32_t bit = UINT32_C(1) << i;
 214
 215         if (bits & bit) {
 216             const char *name = bit_to_name(bit);
 217             if (name) {
 218                 if (n++) {
 219                     ds_put_char(string, separator);
 220                 }
 221                 ds_put_cstr(string, name);
 222                 bits &= ~bit;
 223             }
 224         }
 225     }
 226
 227     if (bits) {
 228         if (n) {
 229             ds_put_char(string, separator);
 230         }
 231         ds_put_format(string, "0x%"PRIx32, bits);
 232     }
 233 }
 234
 235 static const char *
 236 netdev_feature_to_name(uint32_t bit)
 237 {
 238     enum netdev_features f = bit;
 239
 240     switch (f) {
 241     case NETDEV_F_10MB_HD:    return "10MB-HD";
 242     case NETDEV_F_10MB_FD:    return "10MB-FD";
 243     case NETDEV_F_100MB_HD:   return "100MB-HD";
 244     case NETDEV_F_100MB_FD:   return "100MB-FD";
 245     case NETDEV_F_1GB_HD:     return "1GB-HD";
 246     case NETDEV_F_1GB_FD:     return "1GB-FD";
 247     case NETDEV_F_10GB_FD:    return "10GB-FD";
 248     case NETDEV_F_40GB_FD:    return "40GB-FD";
 249     case NETDEV_F_100GB_FD:   return "100GB-FD";
 250     case NETDEV_F_1TB_FD:     return "1TB-FD";
 251     case NETDEV_F_OTHER:      return "OTHER";
 252     case NETDEV_F_COPPER:     return "COPPER";
 253     case NETDEV_F_FIBER:      return "FIBER";
 254     case NETDEV_F_AUTONEG:    return "AUTO_NEG";
 255     case NETDEV_F_PAUSE:      return "AUTO_PAUSE";
 256     case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
 257     }
 258
 259     return NULL;
 260 }
 261
 262 static void
 263 ofp_print_port_features(struct ds *string, enum netdev_features features)
 264 {
 265     ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
 266     ds_put_char(string, '\n');
 267 }
 268
 269 static const char *
 270 ofputil_port_config_to_name(uint32_t bit)
 271 {
 272     enum ofputil_port_config pc = bit;
 273
 274     switch (pc) {
 275     case OFPUTIL_PC_PORT_DOWN:    return "PORT_DOWN";
 276     case OFPUTIL_PC_NO_STP:       return "NO_STP";
 277     case OFPUTIL_PC_NO_RECV:      return "NO_RECV";
 278     case OFPUTIL_PC_NO_RECV_STP:  return "NO_RECV_STP";
 279     case OFPUTIL_PC_NO_FLOOD:     return "NO_FLOOD";
 280     case OFPUTIL_PC_NO_FWD:       return "NO_FWD";
 281     case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
 282     }
 283
 284     return NULL;
 285 }
 286
 287 static void
 288 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
 289 {
 290     ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
 291     ds_put_char(string, '\n');
 292 }
 293
 294 static const char *
 295 ofputil_port_state_to_name(uint32_t bit)
 296 {
 297     enum ofputil_port_state ps = bit;
 298
 299     switch (ps) {
 300     case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
 301     case OFPUTIL_PS_BLOCKED:   return "BLOCKED";
 302     case OFPUTIL_PS_LIVE:      return "LIVE";
 303
 304     case OFPUTIL_PS_STP_LISTEN:
 305     case OFPUTIL_PS_STP_LEARN:
 306     case OFPUTIL_PS_STP_FORWARD:
 307     case OFPUTIL_PS_STP_BLOCK:
 308         /* Handled elsewhere. */
 309         return NULL;
 310     }
 311
 312     return NULL;
 313 }
 314
 315 static void
 316 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
 317 {
 318     enum ofputil_port_state stp_state;
 319
 320     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
 321      * pattern.  We have to special case it.
 322      *
 323      * OVS doesn't support STP, so this field will always be 0 if we are
 324      * talking to OVS, so we'd always print STP_LISTEN in that case.
 325      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
 326      * avoid confusing users. */
 327     stp_state = state & OFPUTIL_PS_STP_MASK;
 328     if (stp_state) {
 329         ds_put_cstr(string,
 330                     (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
 331                      : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
 332                      : "STP_BLOCK"));
 333         state &= ~OFPUTIL_PS_STP_MASK;
 334         if (state) {
 335             ofp_print_bit_names(string, state, ofputil_port_state_to_name,
 336                                 ' ');
 337         }
 338     } else {
 339         ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
 340     }
 341     ds_put_char(string, '\n');
 342 }
 343
 344 static void
 345 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
 346 {
 347     char name[sizeof port->name];
 348     int j;
 349
 350     memcpy(name, port->name, sizeof name);
 351     for (j = 0; j < sizeof name - 1; j++) {
 352         if (!isprint((unsigned char) name[j])) {
 353             break;
 354         }
 355     }
 356     name[j] = '\0';
 357
 358     ds_put_char(string, ' ');
 359     ofputil_format_port(port->port_no, string);
 360     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
 361                   name, ETH_ADDR_ARGS(port->hw_addr));
 362
 363     ds_put_cstr(string, "     config:     ");
 364     ofp_print_port_config(string, port->config);
 365
 366     ds_put_cstr(string, "     state:      ");
 367     ofp_print_port_state(string, port->state);
 368
 369     if (port->curr) {
 370         ds_put_format(string, "     current:    ");
 371         ofp_print_port_features(string, port->curr);
 372     }
 373     if (port->advertised) {
 374         ds_put_format(string, "     advertised: ");
 375         ofp_print_port_features(string, port->advertised);
 376     }
 377     if (port->supported) {
 378         ds_put_format(string, "     supported:  ");
 379         ofp_print_port_features(string, port->supported);
 380     }
 381     if (port->peer) {
 382         ds_put_format(string, "     peer:       ");
 383         ofp_print_port_features(string, port->peer);
 384     }
 385     ds_put_format(string, "     speed: %"PRIu32" Mbps now, "
 386                   "%"PRIu32" Mbps max\n",
 387                   port->curr_speed / UINT32_C(1000),
 388                   port->max_speed / UINT32_C(1000));
 389 }
 390
 391 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
 392  * 'ofp_version', writes a detailed description of each port into
 393  * 'string'. */
 394 static void
 395 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
 396                     struct ofpbuf *b)
 397 {
 398     size_t n_ports;
 399     struct ofputil_phy_port *ports;
 400     enum ofperr error;
 401     size_t i;
 402
 403     n_ports = ofputil_count_phy_ports(ofp_version, b);
 404
 405     ports = xmalloc(n_ports * sizeof *ports);
 406     for (i = 0; i < n_ports; i++) {
 407         error = ofputil_pull_phy_port(ofp_version, b, &ports[i]);
 408         if (error) {
 409             ofp_print_error(string, error);
 410             goto exit;
 411         }
 412     }
 413     qsort(ports, n_ports, sizeof *ports, compare_ports);
 414     for (i = 0; i < n_ports; i++) {
 415         ofp_print_phy_port(string, &ports[i]);
 416     }
 417
 418 exit:
 419     free(ports);
 420 }
 421
 422 static const char *
 423 ofputil_capabilities_to_name(uint32_t bit)
 424 {
 425     enum ofputil_capabilities capabilities = bit;
 426
 427     switch (capabilities) {
 428     case OFPUTIL_C_FLOW_STATS:   return "FLOW_STATS";
 429     case OFPUTIL_C_TABLE_STATS:  return "TABLE_STATS";
 430     case OFPUTIL_C_PORT_STATS:   return "PORT_STATS";
 431     case OFPUTIL_C_IP_REASM:     return "IP_REASM";
 432     case OFPUTIL_C_QUEUE_STATS:  return "QUEUE_STATS";
 433     case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
 434     case OFPUTIL_C_STP:          return "STP";
 435     case OFPUTIL_C_GROUP_STATS:  return "GROUP_STATS";
 436     case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
 437     }
 438
 439     return NULL;
 440 }
 441
 442 static const char *
 443 ofputil_action_bitmap_to_name(uint32_t bit)
 444 {
 445     enum ofputil_action_bitmap action = bit;
 446
 447     switch (action) {
 448     case OFPUTIL_A_OUTPUT:         return "OUTPUT";
 449     case OFPUTIL_A_SET_VLAN_VID:   return "SET_VLAN_VID";
 450     case OFPUTIL_A_SET_VLAN_PCP:   return "SET_VLAN_PCP";
 451     case OFPUTIL_A_STRIP_VLAN:     return "STRIP_VLAN";
 452     case OFPUTIL_A_SET_DL_SRC:     return "SET_DL_SRC";
 453     case OFPUTIL_A_SET_DL_DST:     return "SET_DL_DST";
 454     case OFPUTIL_A_SET_NW_SRC:     return "SET_NW_SRC";
 455     case OFPUTIL_A_SET_NW_DST:     return "SET_NW_DST";
 456     case OFPUTIL_A_SET_NW_ECN:     return "SET_NW_ECN";
 457     case OFPUTIL_A_SET_NW_TOS:     return "SET_NW_TOS";
 458     case OFPUTIL_A_SET_TP_SRC:     return "SET_TP_SRC";
 459     case OFPUTIL_A_SET_TP_DST:     return "SET_TP_DST";
 460     case OFPUTIL_A_SET_FIELD:      return "SET_FIELD";
 461     case OFPUTIL_A_ENQUEUE:        return "ENQUEUE";
 462     case OFPUTIL_A_COPY_TTL_OUT:   return "COPY_TTL_OUT";
 463     case OFPUTIL_A_COPY_TTL_IN:    return "COPY_TTL_IN";
 464     case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
 465     case OFPUTIL_A_SET_MPLS_TC:    return "SET_MPLS_TC";
 466     case OFPUTIL_A_SET_MPLS_TTL:   return "SET_MPLS_TTL";
 467     case OFPUTIL_A_DEC_MPLS_TTL:   return "DEC_MPLS_TTL";
 468     case OFPUTIL_A_PUSH_VLAN:      return "PUSH_VLAN";
 469     case OFPUTIL_A_POP_VLAN:       return "POP_VLAN";
 470     case OFPUTIL_A_PUSH_MPLS:      return "PUSH_MPLS";
 471     case OFPUTIL_A_POP_MPLS:       return "POP_MPLS";
 472     case OFPUTIL_A_SET_QUEUE:      return "SET_QUEUE";
 473     case OFPUTIL_A_GROUP:          return "GROUP";
 474     case OFPUTIL_A_SET_NW_TTL:     return "SET_NW_TTL";
 475     case OFPUTIL_A_DEC_NW_TTL:     return "DEC_NW_TTL";
 476     }
 477
 478     return NULL;
 479 }
 480
 481 static void
 482 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
 483 {
 484     struct ofputil_switch_features features;
 485     enum ofperr error;
 486     struct ofpbuf b;
 487
 488     error = ofputil_decode_switch_features(oh, &features, &b);
 489     if (error) {
 490         ofp_print_error(string, error);
 491         return;
 492     }
 493
 494     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
 495     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32"\n",
 496                   features.n_tables, features.n_buffers);
 497
 498     ds_put_cstr(string, "capabilities: ");
 499     ofp_print_bit_names(string, features.capabilities,
 500                         ofputil_capabilities_to_name, ' ');
 501     ds_put_char(string, '\n');
 502
 503     switch ((enum ofp_version)oh->version) {
 504     case OFP10_VERSION:
 505         ds_put_cstr(string, "actions: ");
 506         ofp_print_bit_names(string, features.actions,
 507                             ofputil_action_bitmap_to_name, ' ');
 508         ds_put_char(string, '\n');
 509         break;
 510     case OFP11_VERSION:
 511     case OFP12_VERSION:
 512         break;
 513     default:
 514         NOT_REACHED();
 515     }
 516
 517     ofp_print_phy_ports(string, oh->version, &b);
 518 }
 519
 520 static void
 521 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
 522 {
 523     enum ofp_config_flags flags;
 524
 525     flags = ntohs(osc->flags);
 526
 527     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
 528     flags &= ~OFPC_FRAG_MASK;
 529
 530     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
 531         ds_put_format(string, " invalid_ttl_to_controller");
 532         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
 533     }
 534
 535     if (flags) {
 536         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 537     }
 538
 539     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 540 }
 541
 542 static void print_wild(struct ds *string, const char *leader, int is_wild,
 543             int verbosity, const char *format, ...)
 544             __attribute__((format(printf, 5, 6)));
 545
 546 static void print_wild(struct ds *string, const char *leader, int is_wild,
 547                        int verbosity, const char *format, ...)
 548 {
 549     if (is_wild && verbosity < 2) {
 550         return;
 551     }
 552     ds_put_cstr(string, leader);
 553     if (!is_wild) {
 554         va_list args;
 555
 556         va_start(args, format);
 557         ds_put_format_valist(string, format, args);
 558         va_end(args);
 559     } else {
 560         ds_put_char(string, '*');
 561     }
 562     ds_put_char(string, ',');
 563 }
 564
 565 static void
 566 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
 567                  uint32_t wild_bits, int verbosity)
 568 {
 569     if (wild_bits >= 32 && verbosity < 2) {
 570         return;
 571     }
 572     ds_put_cstr(string, leader);
 573     if (wild_bits < 32) {
 574         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 575         if (wild_bits) {
 576             ds_put_format(string, "/%d", 32 - wild_bits);
 577         }
 578     } else {
 579         ds_put_char(string, '*');
 580     }
 581     ds_put_char(string, ',');
 582 }
 583
 584 void
 585 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
 586 {
 587     char *s = ofp10_match_to_string(om, verbosity);
 588     ds_put_cstr(f, s);
 589     free(s);
 590 }
 591
 592 char *
 593 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
 594 {
 595     struct ds f = DS_EMPTY_INITIALIZER;
 596     uint32_t w = ntohl(om->wildcards);
 597     bool skip_type = false;
 598     bool skip_proto = false;
 599
 600     if (!(w & OFPFW10_DL_TYPE)) {
 601         skip_type = true;
 602         if (om->dl_type == htons(ETH_TYPE_IP)) {
 603             if (!(w & OFPFW10_NW_PROTO)) {
 604                 skip_proto = true;
 605                 if (om->nw_proto == IPPROTO_ICMP) {
 606                     ds_put_cstr(&f, "icmp,");
 607                 } else if (om->nw_proto == IPPROTO_TCP) {
 608                     ds_put_cstr(&f, "tcp,");
 609                 } else if (om->nw_proto == IPPROTO_UDP) {
 610                     ds_put_cstr(&f, "udp,");
 611                 } else {
 612                     ds_put_cstr(&f, "ip,");
 613                     skip_proto = false;
 614                 }
 615             } else {
 616                 ds_put_cstr(&f, "ip,");
 617             }
 618         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 619             ds_put_cstr(&f, "arp,");
 620         } else {
 621             skip_type = false;
 622         }
 623     }
 624     print_wild(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
 625                "%d", ntohs(om->in_port));
 626     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
 627                "%d", ntohs(om->dl_vlan));
 628     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
 629                "%d", om->dl_vlan_pcp);
 630     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
 631                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 632     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
 633                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 634     if (!skip_type) {
 635         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
 636                    "0x%04x", ntohs(om->dl_type));
 637     }
 638     print_ip_netmask(&f, "nw_src=", om->nw_src,
 639                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
 640                      verbosity);
 641     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
 642                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
 643                      verbosity);
 644     if (!skip_proto) {
 645         if (om->dl_type == htons(ETH_TYPE_ARP)) {
 646             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
 647                        "%u", om->nw_proto);
 648         } else {
 649             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
 650                        "%u", om->nw_proto);
 651         }
 652     }
 653     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
 654                "%u", om->nw_tos);
 655     if (om->nw_proto == IPPROTO_ICMP) {
 656         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
 657                    "%d", ntohs(om->tp_src));
 658         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
 659                    "%d", ntohs(om->tp_dst));
 660     } else {
 661         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
 662                    "%d", ntohs(om->tp_src));
 663         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
 664                    "%d", ntohs(om->tp_dst));
 665     }
 666     if (ds_last(&f) == ',') {
 667         f.length--;
 668     }
 669     return ds_cstr(&f);
 670 }
 671
 672 static void
 673 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
 674 {
 675     struct ofputil_flow_mod fm;
 676     struct ofpbuf ofpacts;
 677     bool need_priority;
 678     enum ofperr error;
 679     enum ofpraw raw;
 680     enum ofputil_protocol protocol;
 681
 682     protocol = ofputil_protocol_from_ofp_version(oh->version);
 683     protocol = ofputil_protocol_set_tid(protocol, true);
 684
 685     ofpbuf_init(&ofpacts, 64);
 686     error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts);
 687     if (error) {
 688         ofpbuf_uninit(&ofpacts);
 689         ofp_print_error(s, error);
 690         return;
 691     }
 692
 693     ds_put_char(s, ' ');
 694     switch (fm.command) {
 695     case OFPFC_ADD:
 696         ds_put_cstr(s, "ADD");
 697         break;
 698     case OFPFC_MODIFY:
 699         ds_put_cstr(s, "MOD");
 700         break;
 701     case OFPFC_MODIFY_STRICT:
 702         ds_put_cstr(s, "MOD_STRICT");
 703         break;
 704     case OFPFC_DELETE:
 705         ds_put_cstr(s, "DEL");
 706         break;
 707     case OFPFC_DELETE_STRICT:
 708         ds_put_cstr(s, "DEL_STRICT");
 709         break;
 710     default:
 711         ds_put_format(s, "cmd:%d", fm.command);
 712     }
 713     if (fm.table_id != 0) {
 714         ds_put_format(s, " table:%d", fm.table_id);
 715     }
 716
 717     ds_put_char(s, ' ');
 718     ofpraw_decode(&raw, oh);
 719     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
 720         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
 721         ofp10_match_print(s, &ofm->match, verbosity);
 722
 723         /* ofp_print_match() doesn't print priority. */
 724         need_priority = true;
 725     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
 726         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
 727         const void *nxm = nfm + 1;
 728         char *nxm_s;
 729
 730         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 731         ds_put_cstr(s, nxm_s);
 732         free(nxm_s);
 733
 734         /* nx_match_to_string() doesn't print priority. */
 735         need_priority = true;
 736     } else {
 737         match_format(&fm.match, s, fm.priority);
 738
 739         /* match_format() does print priority. */
 740         need_priority = false;
 741     }
 742
 743     if (ds_last(s) != ' ') {
 744         ds_put_char(s, ' ');
 745     }
 746     if (fm.new_cookie != htonll(0) && fm.new_cookie != htonll(UINT64_MAX)) {
 747         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
 748     }
 749     if (fm.cookie_mask != htonll(0)) {
 750         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
 751                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
 752     }
 753     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 754         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 755     }
 756     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 757         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 758     }
 759     if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
 760         ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
 761     }
 762     if (fm.buffer_id != UINT32_MAX) {
 763         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 764     }
 765     if (fm.out_port != OFPP_NONE) {
 766         ds_put_format(s, "out_port:");
 767         ofputil_format_port(fm.out_port, s);
 768         ds_put_char(s, ' ');
 769     }
 770     if (fm.flags != 0) {
 771         uint16_t flags = fm.flags;
 772
 773         if (flags & OFPFF_SEND_FLOW_REM) {
 774             ds_put_cstr(s, "send_flow_rem ");
 775         }
 776         if (flags & OFPFF_CHECK_OVERLAP) {
 777             ds_put_cstr(s, "check_overlap ");
 778         }
 779         if (flags & OFPFF10_EMERG) {
 780             ds_put_cstr(s, "emerg ");
 781         }
 782
 783         flags &= ~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF10_EMERG);
 784         if (flags) {
 785             ds_put_format(s, "flags:0x%"PRIx16" ", flags);
 786         }
 787     }
 788
 789     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
 790     ofpbuf_uninit(&ofpacts);
 791 }
 792
 793 static void
 794 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 795 {
 796     ds_put_format(string, "%u", sec);
 797     if (nsec > 0) {
 798         ds_put_format(string, ".%09u", nsec);
 799         while (string->string[string->length - 1] == '0') {
 800             string->length--;
 801         }
 802     }
 803     ds_put_char(string, 's');
 804 }
 805
 806 static const char *
 807 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason)
 808 {
 809     static char s[32];
 810
 811     switch (reason) {
 812     case OFPRR_IDLE_TIMEOUT:
 813         return "idle";
 814     case OFPRR_HARD_TIMEOUT:
 815         return "hard";
 816     case OFPRR_DELETE:
 817         return "delete";
 818     case OFPRR_GROUP_DELETE:
 819         return "group_delete";
 820     case OFPRR_EVICTION:
 821         return "eviction";
 822     default:
 823         sprintf(s, "%d", (int) reason);
 824         return s;
 825     }
 826 }
 827
 828 static void
 829 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 830 {
 831     struct ofputil_flow_removed fr;
 832     enum ofperr error;
 833
 834     error = ofputil_decode_flow_removed(&fr, oh);
 835     if (error) {
 836         ofp_print_error(string, error);
 837         return;
 838     }
 839
 840     ds_put_char(string, ' ');
 841     match_format(&fr.match, string, fr.priority);
 842
 843     ds_put_format(string, " reason=%s",
 844                   ofp_flow_removed_reason_to_string(fr.reason));
 845
 846     if (fr.table_id != 255) {
 847         ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
 848     }
 849
 850     if (fr.cookie != htonll(0)) {
 851         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 852     }
 853     ds_put_cstr(string, " duration");
 854     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 855     ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
 856     if (fr.hard_timeout) {
 857         /* The hard timeout was only added in OF1.2, so only print it if it is
 858          * actually in use to avoid gratuitous change to the formatting. */
 859         ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
 860     }
 861     ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
 862                   fr.packet_count, fr.byte_count);
 863 }
 864
 865 static void
 866 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
 867 {
 868     struct ofputil_port_mod pm;
 869     enum ofperr error;
 870
 871     error = ofputil_decode_port_mod(oh, &pm);
 872     if (error) {
 873         ofp_print_error(string, error);
 874         return;
 875     }
 876
 877     ds_put_format(string, "port: %"PRIu16": addr:"ETH_ADDR_FMT"\n",
 878                   pm.port_no, ETH_ADDR_ARGS(pm.hw_addr));
 879
 880     ds_put_format(string, "     config: ");
 881     ofp_print_port_config(string, pm.config);
 882
 883     ds_put_format(string, "     mask:   ");
 884     ofp_print_port_config(string, pm.mask);
 885
 886     ds_put_format(string, "     advertise: ");
 887     if (pm.advertise) {
 888         ofp_print_port_features(string, pm.advertise);
 889     } else {
 890         ds_put_format(string, "UNCHANGED\n");
 891     }
 892 }
 893
 894 static void
 895 ofp_print_error(struct ds *string, enum ofperr error)
 896 {
 897     if (string->length) {
 898         ds_put_char(string, ' ');
 899     }
 900     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
 901 }
 902
 903 static void
 904 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
 905 {
 906     size_t len = ntohs(oh->length);
 907     struct ofpbuf payload;
 908     enum ofperr error;
 909     char *s;
 910
 911     error = ofperr_decode_msg(oh, &payload);
 912     if (!error) {
 913         ds_put_cstr(string, "***decode error***");
 914         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
 915         return;
 916     }
 917
 918     ds_put_format(string, " %s\n", ofperr_get_name(error));
 919
 920     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
 921         ds_put_printable(string, payload.data, payload.size);
 922     } else {
 923         s = ofp_to_string(payload.data, payload.size, 1);
 924         ds_put_cstr(string, s);
 925         free(s);
 926     }
 927 }
 928
 929 static void
 930 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
 931 {
 932     struct ofputil_port_status ps;
 933     enum ofperr error;
 934
 935     error = ofputil_decode_port_status(oh, &ps);
 936     if (error) {
 937         ofp_print_error(string, error);
 938         return;
 939     }
 940
 941     if (ps.reason == OFPPR_ADD) {
 942         ds_put_format(string, " ADD:");
 943     } else if (ps.reason == OFPPR_DELETE) {
 944         ds_put_format(string, " DEL:");
 945     } else if (ps.reason == OFPPR_MODIFY) {
 946         ds_put_format(string, " MOD:");
 947     }
 948
 949     ofp_print_phy_port(string, &ps.desc);
 950 }
 951
 952 static void
 953 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
 954 {
 955     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
 956
 957     ds_put_char(string, '\n');
 958     ds_put_format(string, "Manufacturer: %.*s\n",
 959             (int) sizeof ods->mfr_desc, ods->mfr_desc);
 960     ds_put_format(string, "Hardware: %.*s\n",
 961             (int) sizeof ods->hw_desc, ods->hw_desc);
 962     ds_put_format(string, "Software: %.*s\n",
 963             (int) sizeof ods->sw_desc, ods->sw_desc);
 964     ds_put_format(string, "Serial Num: %.*s\n",
 965             (int) sizeof ods->serial_num, ods->serial_num);
 966     ds_put_format(string, "DP Description: %.*s\n",
 967             (int) sizeof ods->dp_desc, ods->dp_desc);
 968 }
 969
 970 static void
 971 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
 972 {
 973     struct ofputil_flow_stats_request fsr;
 974     enum ofperr error;
 975
 976     error = ofputil_decode_flow_stats_request(&fsr, oh);
 977     if (error) {
 978         ofp_print_error(string, error);
 979         return;
 980     }
 981
 982     if (fsr.table_id != 0xff) {
 983         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
 984     }
 985
 986     if (fsr.out_port != OFPP_NONE) {
 987         ds_put_cstr(string, " out_port=");
 988         ofputil_format_port(fsr.out_port, string);
 989     }
 990
 991     ds_put_char(string, ' ');
 992     match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
 993 }
 994
 995 void
 996 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
 997 {
 998     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
 999                   ntohll(fs->cookie));
1000
1001     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1002     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1003     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1004     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1005     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1006         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1007     }
1008     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1009         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1010     }
1011     if (fs->idle_age >= 0) {
1012         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1013     }
1014     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1015         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1016     }
1017
1018     match_format(&fs->match, string, fs->priority);
1019     if (string->string[string->length - 1] != ' ') {
1020         ds_put_char(string, ' ');
1021     }
1022
1023     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1024 }
1025
1026 static void
1027 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1028 {
1029     struct ofpbuf ofpacts;
1030     struct ofpbuf b;
1031
1032     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1033     ofpbuf_init(&ofpacts, 64);
1034     for (;;) {
1035         struct ofputil_flow_stats fs;
1036         int retval;
1037
1038         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1039         if (retval) {
1040             if (retval != EOF) {
1041                 ds_put_cstr(string, " ***parse error***");
1042             }
1043             break;
1044         }
1045         ds_put_char(string, '\n');
1046         ofp_print_flow_stats(string, &fs);
1047      }
1048     ofpbuf_uninit(&ofpacts);
1049 }
1050
1051 static void
1052 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1053 {
1054     struct ofputil_aggregate_stats as;
1055     enum ofperr error;
1056
1057     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1058     if (error) {
1059         ofp_print_error(string, error);
1060         return;
1061     }
1062
1063     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1064     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1065     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1066 }
1067
1068 static void
1069 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1070 {
1071     ds_put_cstr(string, leader);
1072     if (stat != UINT64_MAX) {
1073         ds_put_format(string, "%"PRIu64, stat);
1074     } else {
1075         ds_put_char(string, '?');
1076     }
1077     if (more) {
1078         ds_put_cstr(string, ", ");
1079     } else {
1080         ds_put_cstr(string, "\n");
1081     }
1082 }
1083
1084 static void
1085 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1086 {
1087     uint16_t ofp10_port;
1088     enum ofperr error;
1089
1090     error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1091     if (error) {
1092         ofp_print_error(string, error);
1093         return;
1094     }
1095
1096     ds_put_format(string, " port_no=%2"PRIu16, ofp10_port);
1097 }
1098
1099 static void
1100 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1101                            int verbosity)
1102 {
1103     struct ofpbuf b;
1104
1105     ds_put_format(string, " %zu ports\n", ofputil_count_port_stats(oh));
1106     if (verbosity < 1) {
1107         return;
1108     }
1109
1110     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1111     for (;;) {
1112         struct ofputil_port_stats ps;
1113         int retval;
1114
1115         retval = ofputil_decode_port_stats(&ps, &b);
1116         if (retval) {
1117             if (retval != EOF) {
1118                 ds_put_cstr(string, " ***parse error***");
1119             }
1120             return;
1121         }
1122
1123         ds_put_format(string, "  port %2"PRIu16, ps.port_no);
1124
1125         ds_put_cstr(string, ": rx ");
1126         print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1127         print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1128         print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1129         print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1130         print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1131         print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1132         print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1133
1134         ds_put_cstr(string, "           tx ");
1135         print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1136         print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1137         print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1138         print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1139         print_port_stat(string, "coll=", ps.stats.collisions, 0);
1140     }
1141 }
1142
1143 static void
1144 ofp_print_one_ofpst_table_reply(struct ds *string, enum ofp_version ofp_version,
1145                                 const char *name, struct ofp12_table_stats *ts)
1146 {
1147     char name_[OFP_MAX_TABLE_NAME_LEN + 1];
1148
1149     ovs_strlcpy(name_, name, sizeof name_);
1150
1151     ds_put_format(string, "  %d: %-8s: ", ts->table_id, name_);
1152     ds_put_format(string, "wild=0x%05"PRIx64", ", ntohll(ts->wildcards));
1153     ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1154     ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1155     ds_put_cstr(string, "               ");
1156     ds_put_format(string, "lookup=%"PRIu64", ", ntohll(ts->lookup_count));
1157     ds_put_format(string, "matched=%"PRIu64"\n", ntohll(ts->matched_count));
1158
1159     if (ofp_version < OFP11_VERSION) {
1160         return;
1161     }
1162
1163     ds_put_cstr(string, "               ");
1164     ds_put_format(string, "match=0x%08"PRIx64", ", ntohll(ts->match));
1165     ds_put_format(string, "instructions=0x%08"PRIx32", ",
1166                   ntohl(ts->instructions));
1167     ds_put_format(string, "config=0x%08"PRIx32"\n", ntohl(ts->config));
1168     ds_put_cstr(string, "               ");
1169     ds_put_format(string, "write_actions=0x%08"PRIx32", ",
1170                   ntohl(ts->write_actions));
1171     ds_put_format(string, "apply_actions=0x%08"PRIx32"\n",
1172                   ntohl(ts->apply_actions));
1173
1174     if (ofp_version < OFP12_VERSION) {
1175         return;
1176     }
1177
1178     ds_put_cstr(string, "               ");
1179     ds_put_format(string, "write_setfields=0x%016"PRIx64"\n",
1180                   ntohll(ts->write_setfields));
1181     ds_put_cstr(string, "               ");
1182     ds_put_format(string, "apply_setfields=0x%016"PRIx64"\n",
1183                   ntohll(ts->apply_setfields));
1184     ds_put_cstr(string, "               ");
1185     ds_put_format(string, "metadata_match=0x%016"PRIx64"\n",
1186                   ntohll(ts->metadata_match));
1187     ds_put_cstr(string, "               ");
1188     ds_put_format(string, "metadata_write=0x%016"PRIx64"\n",
1189                   ntohll(ts->metadata_write));
1190 }
1191
1192 static void
1193 ofp_print_ofpst_table_reply12(struct ds *string, const struct ofp_header *oh,
1194                               int verbosity)
1195 {
1196     struct ofp12_table_stats *ts;
1197     struct ofpbuf b;
1198     size_t n;
1199
1200     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1201     ofpraw_pull_assert(&b);
1202
1203     n = b.size / sizeof *ts;
1204     ds_put_format(string, " %zu tables\n", n);
1205     if (verbosity < 1) {
1206         return;
1207     }
1208
1209     for (;;) {
1210         ts = ofpbuf_try_pull(&b, sizeof *ts);
1211         if (!ts) {
1212             return;
1213         }
1214
1215         ofp_print_one_ofpst_table_reply(string, OFP12_VERSION, ts->name, ts);
1216      }
1217 }
1218
1219 static void
1220 ofp_print_ofpst_table_reply11(struct ds *string, const struct ofp_header *oh,
1221                               int verbosity)
1222 {
1223     struct ofp11_table_stats *ts;
1224     struct ofpbuf b;
1225     size_t n;
1226
1227     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1228     ofpraw_pull_assert(&b);
1229
1230     n = b.size / sizeof *ts;
1231     ds_put_format(string, " %zu tables\n", n);
1232     if (verbosity < 1) {
1233         return;
1234     }
1235
1236     for (;;) {
1237         struct ofp12_table_stats ts12;
1238
1239         ts = ofpbuf_try_pull(&b, sizeof *ts);
1240         if (!ts) {
1241             return;
1242         }
1243
1244         ts12.table_id = ts->table_id;
1245         ts12.wildcards = htonll(ntohl(ts->wildcards));
1246         ts12.max_entries = ts->max_entries;
1247         ts12.active_count = ts->active_count;
1248         ts12.lookup_count = ts->lookup_count;
1249         ts12.matched_count = ts->matched_count;
1250         ts12.match = htonll(ntohl(ts->match));
1251         ts12.instructions = ts->instructions;
1252         ts12.config = ts->config;
1253         ts12.write_actions = ts->write_actions;
1254         ts12.apply_actions = ts->apply_actions;
1255         ofp_print_one_ofpst_table_reply(string, OFP11_VERSION, ts->name, &ts12);
1256      }
1257 }
1258
1259 static void
1260 ofp_print_ofpst_table_reply10(struct ds *string, const struct ofp_header *oh,
1261                               int verbosity)
1262 {
1263     struct ofp10_table_stats *ts;
1264     struct ofpbuf b;
1265     size_t n;
1266
1267     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1268     ofpraw_pull_assert(&b);
1269
1270     n = b.size / sizeof *ts;
1271     ds_put_format(string, " %zu tables\n", n);
1272     if (verbosity < 1) {
1273         return;
1274     }
1275
1276     for (;;) {
1277         struct ofp12_table_stats ts12;
1278
1279         ts = ofpbuf_try_pull(&b, sizeof *ts);
1280         if (!ts) {
1281             return;
1282         }
1283
1284         ts12.table_id = ts->table_id;
1285         ts12.wildcards = htonll(ntohl(ts->wildcards));
1286         ts12.max_entries = ts->max_entries;
1287         ts12.active_count = ts->active_count;
1288         ts12.lookup_count = get_32aligned_be64(&ts->lookup_count);
1289         ts12.matched_count = get_32aligned_be64(&ts->matched_count);
1290         ofp_print_one_ofpst_table_reply(string, OFP10_VERSION, ts->name, &ts12);
1291      }
1292 }
1293
1294 static void
1295 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1296                             int verbosity)
1297 {
1298     switch ((enum ofp_version)oh->version) {
1299     case OFP12_VERSION:
1300         ofp_print_ofpst_table_reply12(string, oh, verbosity);
1301         break;
1302
1303     case OFP11_VERSION:
1304         ofp_print_ofpst_table_reply11(string, oh, verbosity);
1305         break;
1306
1307     case OFP10_VERSION:
1308         ofp_print_ofpst_table_reply10(string, oh, verbosity);
1309         break;
1310
1311     default:
1312         NOT_REACHED();
1313     }
1314 }
1315
1316 static void
1317 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1318 {
1319     if (queue_id == OFPQ_ALL) {
1320         ds_put_cstr(string, "ALL");
1321     } else {
1322         ds_put_format(string, "%"PRIu32, queue_id);
1323     }
1324 }
1325
1326 static void
1327 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1328 {
1329     struct ofputil_queue_stats_request oqsr;
1330     enum ofperr error;
1331
1332     error = ofputil_decode_queue_stats_request(oh, &oqsr);
1333     if (error) {
1334         ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1335         return;
1336     }
1337
1338     ds_put_cstr(string, "port=");
1339     ofputil_format_port(oqsr.port_no, string);
1340
1341     ds_put_cstr(string, " queue=");
1342     ofp_print_queue_name(string, oqsr.queue_id);
1343 }
1344
1345 static void
1346 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1347                             int verbosity)
1348 {
1349     struct ofpbuf b;
1350
1351     ds_put_format(string, " %zu queues\n", ofputil_count_queue_stats(oh));
1352     if (verbosity < 1) {
1353         return;
1354     }
1355
1356     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1357     for (;;) {
1358         struct ofputil_queue_stats qs;
1359         int retval;
1360
1361         retval = ofputil_decode_queue_stats(&qs, &b);
1362         if (retval) {
1363             if (retval != EOF) {
1364                 ds_put_cstr(string, " ***parse error***");
1365             }
1366             return;
1367         }
1368
1369         ds_put_cstr(string, "  port ");
1370         ofputil_format_port(qs.port_no, string);
1371         ds_put_cstr(string, " queue ");
1372         ofp_print_queue_name(string, qs.queue_id);
1373         ds_put_cstr(string, ": ");
1374
1375         print_port_stat(string, "bytes=", qs.stats.tx_bytes, 1);
1376         print_port_stat(string, "pkts=", qs.stats.tx_packets, 1);
1377         print_port_stat(string, "errors=", qs.stats.tx_errors, 0);
1378     }
1379 }
1380
1381 static void
1382 ofp_print_ofpst_port_desc_reply(struct ds *string,
1383                                 const struct ofp_header *oh)
1384 {
1385     struct ofpbuf b;
1386
1387     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1388     ofpraw_pull_assert(&b);
1389     ds_put_char(string, '\n');
1390     ofp_print_phy_ports(string, oh->version, &b);
1391 }
1392
1393 static void
1394 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1395 {
1396     uint16_t flags = ofpmp_flags(oh);
1397
1398     if (flags) {
1399         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1400     }
1401 }
1402
1403 static void
1404 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1405 {
1406     uint16_t flags = ofpmp_flags(oh);
1407
1408     if (flags) {
1409         ds_put_cstr(string, " flags=");
1410         if (flags & OFPSF_REPLY_MORE) {
1411             ds_put_cstr(string, "[more]");
1412             flags &= ~OFPSF_REPLY_MORE;
1413         }
1414         if (flags) {
1415             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1416                           flags);
1417         }
1418     }
1419 }
1420
1421 static void
1422 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1423 {
1424     size_t len = ntohs(oh->length);
1425
1426     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1427     if (verbosity > 1) {
1428         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1429     }
1430 }
1431
1432 static void
1433 ofp_print_nxt_role_message(struct ds *string,
1434                            const struct nx_role_request *nrr)
1435 {
1436     unsigned int role = ntohl(nrr->role);
1437
1438     ds_put_cstr(string, " role=");
1439     if (role == NX_ROLE_OTHER) {
1440         ds_put_cstr(string, "other");
1441     } else if (role == NX_ROLE_MASTER) {
1442         ds_put_cstr(string, "master");
1443     } else if (role == NX_ROLE_SLAVE) {
1444         ds_put_cstr(string, "slave");
1445     } else {
1446         ds_put_format(string, "%u", role);
1447     }
1448 }
1449
1450 static void
1451 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1452                                 const struct nx_flow_mod_table_id *nfmti)
1453 {
1454     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1455 }
1456
1457 static void
1458 ofp_print_nxt_set_flow_format(struct ds *string,
1459                               const struct nx_set_flow_format *nsff)
1460 {
1461     uint32_t format = ntohl(nsff->format);
1462
1463     ds_put_cstr(string, " format=");
1464     if (ofputil_nx_flow_format_is_valid(format)) {
1465         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1466     } else {
1467         ds_put_format(string, "%"PRIu32, format);
1468     }
1469 }
1470
1471 static void
1472 ofp_print_nxt_set_packet_in_format(struct ds *string,
1473                                    const struct nx_set_packet_in_format *nspf)
1474 {
1475     uint32_t format = ntohl(nspf->format);
1476
1477     ds_put_cstr(string, " format=");
1478     if (ofputil_packet_in_format_is_valid(format)) {
1479         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1480     } else {
1481         ds_put_format(string, "%"PRIu32, format);
1482     }
1483 }
1484
1485 static const char *
1486 ofp_port_reason_to_string(enum ofp_port_reason reason)
1487 {
1488     static char s[32];
1489
1490     switch (reason) {
1491     case OFPPR_ADD:
1492         return "add";
1493
1494     case OFPPR_DELETE:
1495         return "delete";
1496
1497     case OFPPR_MODIFY:
1498         return "modify";
1499
1500     default:
1501         sprintf(s, "%d", (int) reason);
1502         return s;
1503     }
1504 }
1505
1506 static void
1507 ofp_print_nxt_set_async_config(struct ds *string,
1508                                const struct nx_async_config *nac)
1509 {
1510     int i;
1511
1512     for (i = 0; i < 2; i++) {
1513         int j;
1514
1515         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1516
1517         ds_put_cstr(string, "       PACKET_IN:");
1518         for (j = 0; j < 32; j++) {
1519             if (nac->packet_in_mask[i] & htonl(1u << j)) {
1520                 ds_put_format(string, " %s",
1521                               ofputil_packet_in_reason_to_string(j));
1522             }
1523         }
1524         if (!nac->packet_in_mask[i]) {
1525             ds_put_cstr(string, " (off)");
1526         }
1527         ds_put_char(string, '\n');
1528
1529         ds_put_cstr(string, "     PORT_STATUS:");
1530         for (j = 0; j < 32; j++) {
1531             if (nac->port_status_mask[i] & htonl(1u << j)) {
1532                 ds_put_format(string, " %s", ofp_port_reason_to_string(j));
1533             }
1534         }
1535         if (!nac->port_status_mask[i]) {
1536             ds_put_cstr(string, " (off)");
1537         }
1538         ds_put_char(string, '\n');
1539
1540         ds_put_cstr(string, "    FLOW_REMOVED:");
1541         for (j = 0; j < 32; j++) {
1542             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1543                 ds_put_format(string, " %s",
1544                               ofp_flow_removed_reason_to_string(j));
1545             }
1546         }
1547         if (!nac->flow_removed_mask[i]) {
1548             ds_put_cstr(string, " (off)");
1549         }
1550         ds_put_char(string, '\n');
1551     }
1552 }
1553
1554 static void
1555 ofp_print_nxt_set_controller_id(struct ds *string,
1556                                 const struct nx_controller_id *nci)
1557 {
1558     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1559 }
1560
1561 static void
1562 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1563                                   const struct ofp_header *oh)
1564 {
1565     ds_put_format(string, " id=%"PRIu32,
1566                   ofputil_decode_flow_monitor_cancel(oh));
1567 }
1568
1569 static const char *
1570 nx_flow_monitor_flags_to_name(uint32_t bit)
1571 {
1572     enum nx_flow_monitor_flags fmf = bit;
1573
1574     switch (fmf) {
1575     case NXFMF_INITIAL: return "initial";
1576     case NXFMF_ADD: return "add";
1577     case NXFMF_DELETE: return "delete";
1578     case NXFMF_MODIFY: return "modify";
1579     case NXFMF_ACTIONS: return "actions";
1580     case NXFMF_OWN: return "own";
1581     }
1582
1583     return NULL;
1584 }
1585
1586 static void
1587 ofp_print_nxst_flow_monitor_request(struct ds *string,
1588                                     const struct ofp_header *oh)
1589 {
1590     struct ofpbuf b;
1591
1592     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1593     for (;;) {
1594         struct ofputil_flow_monitor_request request;
1595         int retval;
1596
1597         retval = ofputil_decode_flow_monitor_request(&request, &b);
1598         if (retval) {
1599             if (retval != EOF) {
1600                 ofp_print_error(string, retval);
1601             }
1602             return;
1603         }
1604
1605         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
1606         ofp_print_bit_names(string, request.flags,
1607                             nx_flow_monitor_flags_to_name, ',');
1608
1609         if (request.out_port != OFPP_NONE) {
1610             ds_put_cstr(string, " out_port=");
1611             ofputil_format_port(request.out_port, string);
1612         }
1613
1614         if (request.table_id != 0xff) {
1615             ds_put_format(string, " table=%"PRIu8, request.table_id);
1616         }
1617
1618         ds_put_char(string, ' ');
1619         match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
1620         ds_chomp(string, ' ');
1621     }
1622 }
1623
1624 static void
1625 ofp_print_nxst_flow_monitor_reply(struct ds *string,
1626                                   const struct ofp_header *oh)
1627 {
1628     uint64_t ofpacts_stub[1024 / 8];
1629     struct ofpbuf ofpacts;
1630     struct ofpbuf b;
1631
1632     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1633     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1634     for (;;) {
1635         struct ofputil_flow_update update;
1636         struct match match;
1637         int retval;
1638
1639         update.match = &match;
1640         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
1641         if (retval) {
1642             if (retval != EOF) {
1643                 ofp_print_error(string, retval);
1644             }
1645             ofpbuf_uninit(&ofpacts);
1646             return;
1647         }
1648
1649         ds_put_cstr(string, "\n event=");
1650         switch (update.event) {
1651         case NXFME_ADDED:
1652             ds_put_cstr(string, "ADDED");
1653             break;
1654
1655         case NXFME_DELETED:
1656             ds_put_format(string, "DELETED reason=%s",
1657                           ofp_flow_removed_reason_to_string(update.reason));
1658             break;
1659
1660         case NXFME_MODIFIED:
1661             ds_put_cstr(string, "MODIFIED");
1662             break;
1663
1664         case NXFME_ABBREV:
1665             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
1666             continue;
1667         }
1668
1669         ds_put_format(string, " table=%"PRIu8, update.table_id);
1670         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
1671             ds_put_format(string, " idle_timeout=%"PRIu16,
1672                           update.idle_timeout);
1673         }
1674         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
1675             ds_put_format(string, " hard_timeout=%"PRIu16,
1676                           update.hard_timeout);
1677         }
1678         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
1679
1680         ds_put_char(string, ' ');
1681         match_format(update.match, string, OFP_DEFAULT_PRIORITY);
1682
1683         if (update.ofpacts_len) {
1684             if (string->string[string->length - 1] != ' ') {
1685                 ds_put_char(string, ' ');
1686             }
1687             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
1688         }
1689     }
1690 }
1691
1692 void
1693 ofp_print_version(const struct ofp_header *oh,
1694                   struct ds *string)
1695 {
1696     switch (oh->version) {
1697     case OFP10_VERSION:
1698         break;
1699     case OFP11_VERSION:
1700         ds_put_cstr(string, " (OF1.1)");
1701         break;
1702     case OFP12_VERSION:
1703         ds_put_cstr(string, " (OF1.2)");
1704         break;
1705     default:
1706         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
1707         break;
1708     }
1709     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
1710 }
1711
1712 static void
1713 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1714                        struct ds *string)
1715 {
1716     ds_put_cstr(string, ofpraw_get_name(raw));
1717     ofp_print_version(oh, string);
1718 }
1719
1720 static void
1721 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1722                 struct ds *string, int verbosity)
1723 {
1724     const void *msg = oh;
1725
1726     ofp_header_to_string__(oh, raw, string);
1727     switch (ofptype_from_ofpraw(raw)) {
1728     case OFPTYPE_HELLO:
1729         ds_put_char(string, '\n');
1730         ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1731                         0, true);
1732         break;
1733
1734     case OFPTYPE_ERROR:
1735         ofp_print_error_msg(string, oh);
1736         break;
1737
1738     case OFPTYPE_ECHO_REQUEST:
1739     case OFPTYPE_ECHO_REPLY:
1740         ofp_print_echo(string, oh, verbosity);
1741         break;
1742
1743     case OFPTYPE_FEATURES_REQUEST:
1744         break;
1745
1746     case OFPTYPE_FEATURES_REPLY:
1747         ofp_print_switch_features(string, oh);
1748         break;
1749
1750     case OFPTYPE_GET_CONFIG_REQUEST:
1751         break;
1752
1753     case OFPTYPE_GET_CONFIG_REPLY:
1754     case OFPTYPE_SET_CONFIG:
1755         ofp_print_switch_config(string, ofpmsg_body(oh));
1756         break;
1757
1758     case OFPTYPE_PACKET_IN:
1759         ofp_print_packet_in(string, oh, verbosity);
1760         break;
1761
1762     case OFPTYPE_FLOW_REMOVED:
1763         ofp_print_flow_removed(string, oh);
1764         break;
1765
1766     case OFPTYPE_PORT_STATUS:
1767         ofp_print_port_status(string, oh);
1768         break;
1769
1770     case OFPTYPE_PACKET_OUT:
1771         ofp_print_packet_out(string, oh, verbosity);
1772         break;
1773
1774     case OFPTYPE_FLOW_MOD:
1775         ofp_print_flow_mod(string, oh, verbosity);
1776         break;
1777
1778     case OFPTYPE_PORT_MOD:
1779         ofp_print_port_mod(string, oh);
1780         break;
1781
1782     case OFPTYPE_BARRIER_REQUEST:
1783     case OFPTYPE_BARRIER_REPLY:
1784         break;
1785
1786     case OFPTYPE_DESC_STATS_REQUEST:
1787     case OFPTYPE_PORT_DESC_STATS_REQUEST:
1788         ofp_print_stats_request(string, oh);
1789         break;
1790
1791     case OFPTYPE_FLOW_STATS_REQUEST:
1792     case OFPTYPE_AGGREGATE_STATS_REQUEST:
1793         ofp_print_stats_request(string, oh);
1794         ofp_print_flow_stats_request(string, oh);
1795         break;
1796
1797     case OFPTYPE_TABLE_STATS_REQUEST:
1798         ofp_print_stats_request(string, oh);
1799         break;
1800
1801     case OFPTYPE_PORT_STATS_REQUEST:
1802         ofp_print_stats_request(string, oh);
1803         ofp_print_ofpst_port_request(string, oh);
1804         break;
1805
1806     case OFPTYPE_QUEUE_STATS_REQUEST:
1807         ofp_print_stats_request(string, oh);
1808         ofp_print_ofpst_queue_request(string, oh);
1809         break;
1810
1811     case OFPTYPE_DESC_STATS_REPLY:
1812         ofp_print_stats_reply(string, oh);
1813         ofp_print_ofpst_desc_reply(string, oh);
1814         break;
1815
1816     case OFPTYPE_FLOW_STATS_REPLY:
1817         ofp_print_stats_reply(string, oh);
1818         ofp_print_flow_stats_reply(string, oh);
1819         break;
1820
1821     case OFPTYPE_QUEUE_STATS_REPLY:
1822         ofp_print_stats_reply(string, oh);
1823         ofp_print_ofpst_queue_reply(string, oh, verbosity);
1824         break;
1825
1826     case OFPTYPE_PORT_STATS_REPLY:
1827         ofp_print_stats_reply(string, oh);
1828         ofp_print_ofpst_port_reply(string, oh, verbosity);
1829         break;
1830
1831     case OFPTYPE_TABLE_STATS_REPLY:
1832         ofp_print_stats_reply(string, oh);
1833         ofp_print_ofpst_table_reply(string, oh, verbosity);
1834         break;
1835
1836     case OFPTYPE_AGGREGATE_STATS_REPLY:
1837         ofp_print_stats_reply(string, oh);
1838         ofp_print_aggregate_stats_reply(string, oh);
1839         break;
1840
1841     case OFPTYPE_PORT_DESC_STATS_REPLY:
1842         ofp_print_stats_reply(string, oh);
1843         ofp_print_ofpst_port_desc_reply(string, oh);
1844         break;
1845
1846     case OFPTYPE_ROLE_REQUEST:
1847     case OFPTYPE_ROLE_REPLY:
1848         ofp_print_nxt_role_message(string, ofpmsg_body(oh));
1849         break;
1850
1851     case OFPTYPE_FLOW_MOD_TABLE_ID:
1852         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
1853         break;
1854
1855     case OFPTYPE_SET_FLOW_FORMAT:
1856         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
1857         break;
1858
1859     case OFPTYPE_SET_PACKET_IN_FORMAT:
1860         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
1861         break;
1862
1863     case OFPTYPE_FLOW_AGE:
1864         break;
1865
1866     case OFPTYPE_SET_CONTROLLER_ID:
1867         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
1868         break;
1869
1870     case OFPTYPE_SET_ASYNC_CONFIG:
1871         ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
1872         break;
1873
1874     case OFPTYPE_FLOW_MONITOR_CANCEL:
1875         ofp_print_nxt_flow_monitor_cancel(string, msg);
1876         break;
1877
1878     case OFPTYPE_FLOW_MONITOR_PAUSED:
1879     case OFPTYPE_FLOW_MONITOR_RESUMED:
1880         break;
1881
1882     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1883         ofp_print_nxst_flow_monitor_request(string, msg);
1884         break;
1885
1886     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1887         ofp_print_nxst_flow_monitor_reply(string, msg);
1888         break;
1889     }
1890 }
1891
1892 /* Composes and returns a string representing the OpenFlow packet of 'len'
1893  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1894  * verbosity and higher numbers increase verbosity.  The caller is responsible
1895  * for freeing the string. */
1896 char *
1897 ofp_to_string(const void *oh_, size_t len, int verbosity)
1898 {
1899     struct ds string = DS_EMPTY_INITIALIZER;
1900     const struct ofp_header *oh = oh_;
1901
1902     if (!len) {
1903         ds_put_cstr(&string, "OpenFlow message is empty\n");
1904     } else if (len < sizeof(struct ofp_header)) {
1905         ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1906                       len);
1907     } else if (ntohs(oh->length) > len) {
1908         enum ofperr error;
1909         enum ofpraw raw;
1910
1911         error = ofpraw_decode_partial(&raw, oh, len);
1912         if (!error) {
1913             ofp_header_to_string__(oh, raw, &string);
1914             ds_put_char(&string, '\n');
1915         }
1916
1917         ds_put_format(&string,
1918                       "(***truncated to %zu bytes from %"PRIu16"***)\n",
1919                       len, ntohs(oh->length));
1920     } else if (ntohs(oh->length) < len) {
1921         ds_put_format(&string,
1922                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
1923                       ntohs(oh->length), len);
1924     } else {
1925         enum ofperr error;
1926         enum ofpraw raw;
1927
1928         error = ofpraw_decode(&raw, oh);
1929         if (!error) {
1930             ofp_to_string__(oh, raw, &string, verbosity);
1931             if (verbosity >= 5) {
1932                 if (ds_last(&string) != '\n') {
1933                     ds_put_char(&string, '\n');
1934                 }
1935                 ds_put_hex_dump(&string, oh, len, 0, true);
1936             }
1937             if (ds_last(&string) != '\n') {
1938                 ds_put_char(&string, '\n');
1939             }
1940             return ds_steal_cstr(&string);
1941         }
1942
1943         ofp_print_error(&string, error);
1944     }
1945     ds_put_hex_dump(&string, oh, len, 0, true);
1946     return ds_steal_cstr(&string);
1947 }
1948 \f
1949 static void
1950 print_and_free(FILE *stream, char *string)
1951 {
1952     fputs(string, stream);
1953     free(string);
1954 }
1955
1956 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1957  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1958  * numbers increase verbosity. */
1959 void
1960 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1961 {
1962     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1963 }
1964
1965 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1966  * 'data' to 'stream'. */
1967 void
1968 ofp_print_packet(FILE *stream, const void *data, size_t len)
1969 {
1970     print_and_free(stream, ofp_packet_to_string(data, len));
1971 }