lib/ofp-print.c

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