lib/ofp-print.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <sys/types.h>
  23 #include <netinet/in.h>
  24 #include <sys/wait.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <ctype.h>
  28
  29 #include "bundle.h"
  30 #include "byte-order.h"
  31 #include "compiler.h"
  32 #include "dynamic-string.h"
  33 #include "flow.h"
  34 #include "learn.h"
  35 #include "multipath.h"
  36 #include "meta-flow.h"
  37 #include "netdev.h"
  38 #include "nx-match.h"
  39 #include "ofp-actions.h"
  40 #include "ofp-errors.h"
  41 #include "ofp-msgs.h"
  42 #include "ofp-util.h"
  43 #include "ofpbuf.h"
  44 #include "openflow/openflow.h"
  45 #include "openflow/nicira-ext.h"
  46 #include "packets.h"
  47 #include "type-props.h"
  48 #include "unaligned.h"
  49 #include "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(get_16aligned_be32(&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=%"PRIuSIZE" 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=%"PRIuSIZE, 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=%"PRIuSIZE, 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         OVS_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                                     OFPP_MAX, 255);
 762     if (error) {
 763         ofpbuf_uninit(&ofpacts);
 764         ofp_print_error(s, error);
 765         return;
 766     }
 767
 768     ds_put_char(s, ' ');
 769     switch (fm.command) {
 770     case OFPFC_ADD:
 771         ds_put_cstr(s, "ADD");
 772         break;
 773     case OFPFC_MODIFY:
 774         ds_put_cstr(s, "MOD");
 775         break;
 776     case OFPFC_MODIFY_STRICT:
 777         ds_put_cstr(s, "MOD_STRICT");
 778         break;
 779     case OFPFC_DELETE:
 780         ds_put_cstr(s, "DEL");
 781         break;
 782     case OFPFC_DELETE_STRICT:
 783         ds_put_cstr(s, "DEL_STRICT");
 784         break;
 785     default:
 786         ds_put_format(s, "cmd:%d", fm.command);
 787     }
 788     if (fm.table_id != 0) {
 789         ds_put_format(s, " table:%d", fm.table_id);
 790     }
 791
 792     ds_put_char(s, ' ');
 793     ofpraw_decode(&raw, oh);
 794     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
 795         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
 796         ofp10_match_print(s, &ofm->match, verbosity);
 797
 798         /* ofp_print_match() doesn't print priority. */
 799         need_priority = true;
 800     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
 801         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
 802         const void *nxm = nfm + 1;
 803         char *nxm_s;
 804
 805         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 806         ds_put_cstr(s, nxm_s);
 807         free(nxm_s);
 808
 809         /* nx_match_to_string() doesn't print priority. */
 810         need_priority = true;
 811     } else {
 812         match_format(&fm.match, s, fm.priority);
 813
 814         /* match_format() does print priority. */
 815         need_priority = false;
 816     }
 817
 818     if (ds_last(s) != ' ') {
 819         ds_put_char(s, ' ');
 820     }
 821     if (fm.new_cookie != htonll(0) && fm.new_cookie != OVS_BE64_MAX) {
 822         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
 823     }
 824     if (fm.cookie_mask != htonll(0)) {
 825         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
 826                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
 827     }
 828     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 829         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 830     }
 831     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 832         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 833     }
 834     if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
 835         ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
 836     }
 837     if (fm.buffer_id != UINT32_MAX) {
 838         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 839     }
 840     if (fm.out_port != OFPP_ANY) {
 841         ds_put_format(s, "out_port:");
 842         ofputil_format_port(fm.out_port, s);
 843         ds_put_char(s, ' ');
 844     }
 845
 846     if (oh->version == OFP10_VERSION || oh->version == OFP11_VERSION) {
 847         /* Don't print the reset_counts flag for OF1.0 and OF1.1 because those
 848          * versions don't really have such a flag and printing one is likely to
 849          * confuse people. */
 850         fm.flags &= ~OFPUTIL_FF_RESET_COUNTS;
 851     }
 852     ofp_print_flow_flags(s, fm.flags);
 853
 854     ds_put_cstr(s, "actions=");
 855     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
 856     ofpbuf_uninit(&ofpacts);
 857 }
 858
 859 static void
 860 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 861 {
 862     ds_put_format(string, "%u", sec);
 863
 864     /* If there are no fractional seconds, don't print any decimals.
 865      *
 866      * If the fractional seconds can be expressed exactly as milliseconds,
 867      * print 3 decimals.  Open vSwitch provides millisecond precision for most
 868      * time measurements, so printing 3 decimals every time makes it easier to
 869      * spot real changes in flow dumps that refresh themselves quickly.
 870      *
 871      * If the fractional seconds are more precise than milliseconds, print the
 872      * number of decimals needed to express them exactly.
 873      */
 874     if (nsec > 0) {
 875         unsigned int msec = nsec / 1000000;
 876         if (msec * 1000000 == nsec) {
 877             ds_put_format(string, ".%03u", msec);
 878         } else {
 879             ds_put_format(string, ".%09u", nsec);
 880             while (string->string[string->length - 1] == '0') {
 881                 string->length--;
 882             }
 883         }
 884     }
 885     ds_put_char(string, 's');
 886 }
 887
 888 /* Returns a string form of 'reason'.  The return value is either a statically
 889  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
 890  * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
 891 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
 892 static const char *
 893 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason,
 894                                   char *reasonbuf, size_t bufsize)
 895 {
 896     switch (reason) {
 897     case OFPRR_IDLE_TIMEOUT:
 898         return "idle";
 899     case OFPRR_HARD_TIMEOUT:
 900         return "hard";
 901     case OFPRR_DELETE:
 902         return "delete";
 903     case OFPRR_GROUP_DELETE:
 904         return "group_delete";
 905     case OFPRR_EVICTION:
 906         return "eviction";
 907     case OFPRR_METER_DELETE:
 908         return "meter_delete";
 909     default:
 910         snprintf(reasonbuf, bufsize, "%d", (int) reason);
 911         return reasonbuf;
 912     }
 913 }
 914
 915 static void
 916 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 917 {
 918     char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
 919     struct ofputil_flow_removed fr;
 920     enum ofperr error;
 921
 922     error = ofputil_decode_flow_removed(&fr, oh);
 923     if (error) {
 924         ofp_print_error(string, error);
 925         return;
 926     }
 927
 928     ds_put_char(string, ' ');
 929     match_format(&fr.match, string, fr.priority);
 930
 931     ds_put_format(string, " reason=%s",
 932                   ofp_flow_removed_reason_to_string(fr.reason, reasonbuf,
 933                                                     sizeof reasonbuf));
 934
 935     if (fr.table_id != 255) {
 936         ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
 937     }
 938
 939     if (fr.cookie != htonll(0)) {
 940         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 941     }
 942     ds_put_cstr(string, " duration");
 943     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 944     ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
 945     if (fr.hard_timeout) {
 946         /* The hard timeout was only added in OF1.2, so only print it if it is
 947          * actually in use to avoid gratuitous change to the formatting. */
 948         ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
 949     }
 950     ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
 951                   fr.packet_count, fr.byte_count);
 952 }
 953
 954 static void
 955 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
 956 {
 957     struct ofputil_port_mod pm;
 958     enum ofperr error;
 959
 960     error = ofputil_decode_port_mod(oh, &pm);
 961     if (error) {
 962         ofp_print_error(string, error);
 963         return;
 964     }
 965
 966     ds_put_cstr(string, "port: ");
 967     ofputil_format_port(pm.port_no, string);
 968     ds_put_format(string, ": addr:"ETH_ADDR_FMT"\n",
 969                   ETH_ADDR_ARGS(pm.hw_addr));
 970
 971     ds_put_cstr(string, "     config: ");
 972     ofp_print_port_config(string, pm.config);
 973
 974     ds_put_cstr(string, "     mask:   ");
 975     ofp_print_port_config(string, pm.mask);
 976
 977     ds_put_cstr(string, "     advertise: ");
 978     if (pm.advertise) {
 979         ofp_print_port_features(string, pm.advertise);
 980     } else {
 981         ds_put_cstr(string, "UNCHANGED\n");
 982     }
 983 }
 984
 985 static void
 986 ofp_print_table_miss_config(struct ds *string, const uint32_t config)
 987 {
 988     uint32_t table_miss_config = config & OFPTC11_TABLE_MISS_MASK;
 989
 990     switch (table_miss_config) {
 991     case OFPTC11_TABLE_MISS_CONTROLLER:
 992         ds_put_cstr(string, "controller\n");
 993         break;
 994     case OFPTC11_TABLE_MISS_CONTINUE:
 995         ds_put_cstr(string, "continue\n");
 996         break;
 997     case OFPTC11_TABLE_MISS_DROP:
 998         ds_put_cstr(string, "drop\n");
 999         break;
1000     default:
1001         ds_put_cstr(string, "Unknown\n");
1002         break;
1003     }
1004 }
1005
1006 static void
1007 ofp_print_table_mod(struct ds *string, const struct ofp_header *oh)
1008 {
1009     struct ofputil_table_mod pm;
1010     enum ofperr error;
1011
1012     error = ofputil_decode_table_mod(oh, &pm);
1013     if (error) {
1014         ofp_print_error(string, error);
1015         return;
1016     }
1017
1018     if (pm.table_id == 0xff) {
1019         ds_put_cstr(string, " table_id: ALL_TABLES");
1020     } else {
1021         ds_put_format(string, " table_id=%"PRIu8, pm.table_id);
1022     }
1023
1024     ds_put_cstr(string, ", flow_miss_config=");
1025     ofp_print_table_miss_config(string, pm.config);
1026 }
1027
1028 static void
1029 ofp_print_queue_get_config_request(struct ds *string,
1030                                    const struct ofp_header *oh)
1031 {
1032     enum ofperr error;
1033     ofp_port_t port;
1034
1035     error = ofputil_decode_queue_get_config_request(oh, &port);
1036     if (error) {
1037         ofp_print_error(string, error);
1038         return;
1039     }
1040
1041     ds_put_cstr(string, " port=");
1042     ofputil_format_port(port, string);
1043 }
1044
1045 static void
1046 print_queue_rate(struct ds *string, const char *name, unsigned int rate)
1047 {
1048     if (rate <= 1000) {
1049         ds_put_format(string, " %s:%u.%u%%", name, rate / 10, rate % 10);
1050     } else if (rate < UINT16_MAX) {
1051         ds_put_format(string, " %s:(disabled)", name);
1052     }
1053 }
1054
1055 static void
1056 ofp_print_queue_get_config_reply(struct ds *string,
1057                                  const struct ofp_header *oh)
1058 {
1059     enum ofperr error;
1060     struct ofpbuf b;
1061     ofp_port_t port;
1062
1063     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1064     error = ofputil_decode_queue_get_config_reply(&b, &port);
1065     if (error) {
1066         ofp_print_error(string, error);
1067         return;
1068     }
1069
1070     ds_put_cstr(string, " port=");
1071     ofputil_format_port(port, string);
1072     ds_put_char(string, '\n');
1073
1074     for (;;) {
1075         struct ofputil_queue_config queue;
1076         int retval;
1077
1078         retval = ofputil_pull_queue_get_config_reply(&b, &queue);
1079         if (retval) {
1080             if (retval != EOF) {
1081                 ofp_print_error(string, retval);
1082             }
1083             break;
1084         }
1085
1086         ds_put_format(string, "queue %"PRIu32":", queue.queue_id);
1087         print_queue_rate(string, "min_rate", queue.min_rate);
1088         print_queue_rate(string, "max_rate", queue.max_rate);
1089         ds_put_char(string, '\n');
1090     }
1091 }
1092
1093 static void
1094 ofp_print_meter_flags(struct ds *s, uint16_t flags)
1095 {
1096     if (flags & OFPMF13_KBPS) {
1097         ds_put_cstr(s, "kbps ");
1098     }
1099     if (flags & OFPMF13_PKTPS) {
1100         ds_put_cstr(s, "pktps ");
1101     }
1102     if (flags & OFPMF13_BURST) {
1103         ds_put_cstr(s, "burst ");
1104     }
1105     if (flags & OFPMF13_STATS) {
1106         ds_put_cstr(s, "stats ");
1107     }
1108
1109     flags &= ~(OFPMF13_KBPS | OFPMF13_PKTPS | OFPMF13_BURST | OFPMF13_STATS);
1110     if (flags) {
1111         ds_put_format(s, "flags:0x%"PRIx16" ", flags);
1112     }
1113 }
1114
1115 static void
1116 ofp_print_meter_band(struct ds *s, uint16_t flags,
1117                      const struct ofputil_meter_band *mb)
1118 {
1119     ds_put_cstr(s, "\ntype=");
1120     switch (mb->type) {
1121     case OFPMBT13_DROP:
1122         ds_put_cstr(s, "drop");
1123         break;
1124     case OFPMBT13_DSCP_REMARK:
1125         ds_put_cstr(s, "dscp_remark");
1126         break;
1127     default:
1128         ds_put_format(s, "%u", mb->type);
1129     }
1130
1131     ds_put_format(s, " rate=%"PRIu32, mb->rate);
1132
1133     if (flags & OFPMF13_BURST) {
1134         ds_put_format(s, " burst_size=%"PRIu32, mb->burst_size);
1135     }
1136     if (mb->type == OFPMBT13_DSCP_REMARK) {
1137         ds_put_format(s, " prec_level=%"PRIu8, mb->prec_level);
1138     }
1139 }
1140
1141 static void
1142 ofp_print_meter_stats(struct ds *s, const struct ofputil_meter_stats *ms)
1143 {
1144     uint16_t i;
1145
1146     ds_put_format(s, "meter:%"PRIu32" ", ms->meter_id);
1147     ds_put_format(s, "flow_count:%"PRIu32" ", ms->flow_count);
1148     ds_put_format(s, "packet_in_count:%"PRIu64" ", ms->packet_in_count);
1149     ds_put_format(s, "byte_in_count:%"PRIu64" ", ms->byte_in_count);
1150     ds_put_cstr(s, "duration:");
1151     ofp_print_duration(s, ms->duration_sec, ms->duration_nsec);
1152     ds_put_char(s, ' ');
1153
1154     ds_put_cstr(s, "bands:\n");
1155     for (i = 0; i < ms->n_bands; ++i) {
1156         ds_put_format(s, "%d: ", i);
1157         ds_put_format(s, "packet_count:%"PRIu64" ", ms->bands[i].packet_count);
1158         ds_put_format(s, "byte_count:%"PRIu64"\n", ms->bands[i].byte_count);
1159     }
1160 }
1161
1162 static void
1163 ofp_print_meter_config(struct ds *s, const struct ofputil_meter_config *mc)
1164 {
1165     uint16_t i;
1166
1167     ds_put_format(s, "meter=%"PRIu32" ", mc->meter_id);
1168
1169     ofp_print_meter_flags(s, mc->flags);
1170
1171     ds_put_cstr(s, "bands=");
1172     for (i = 0; i < mc->n_bands; ++i) {
1173         ofp_print_meter_band(s, mc->flags, &mc->bands[i]);
1174     }
1175     ds_put_char(s, '\n');
1176 }
1177
1178 static void
1179 ofp_print_meter_mod(struct ds *s, const struct ofp_header *oh)
1180 {
1181     struct ofputil_meter_mod mm;
1182     struct ofpbuf bands;
1183     enum ofperr error;
1184
1185     ofpbuf_init(&bands, 64);
1186     error = ofputil_decode_meter_mod(oh, &mm, &bands);
1187     if (error) {
1188         ofpbuf_uninit(&bands);
1189         ofp_print_error(s, error);
1190         return;
1191     }
1192
1193     switch (mm.command) {
1194     case OFPMC13_ADD:
1195         ds_put_cstr(s, " ADD ");
1196         break;
1197     case OFPMC13_MODIFY:
1198         ds_put_cstr(s, " MOD ");
1199         break;
1200     case OFPMC13_DELETE:
1201         ds_put_cstr(s, " DEL ");
1202         break;
1203     default:
1204         ds_put_format(s, " cmd:%d ", mm.command);
1205     }
1206
1207     ofp_print_meter_config(s, &mm.meter);
1208     ofpbuf_uninit(&bands);
1209 }
1210
1211 static void
1212 ofp_print_meter_stats_request(struct ds *s, const struct ofp_header *oh)
1213 {
1214     uint32_t meter_id;
1215
1216     ofputil_decode_meter_request(oh, &meter_id);
1217
1218     ds_put_format(s, " meter=%"PRIu32, meter_id);
1219 }
1220
1221 static const char *
1222 ofputil_meter_capabilities_to_name(uint32_t bit)
1223 {
1224     enum ofp13_meter_flags flag = bit;
1225
1226     switch (flag) {
1227     case OFPMF13_KBPS:    return "kbps";
1228     case OFPMF13_PKTPS:   return "pktps";
1229     case OFPMF13_BURST:   return "burst";
1230     case OFPMF13_STATS:   return "stats";
1231     }
1232
1233     return NULL;
1234 }
1235
1236 static const char *
1237 ofputil_meter_band_types_to_name(uint32_t bit)
1238 {
1239     switch (bit) {
1240     case 1 << OFPMBT13_DROP:          return "drop";
1241     case 1 << OFPMBT13_DSCP_REMARK:   return "dscp_remark";
1242     }
1243
1244     return NULL;
1245 }
1246
1247 static void
1248 ofp_print_meter_features_reply(struct ds *s, const struct ofp_header *oh)
1249 {
1250     struct ofputil_meter_features mf;
1251
1252     ofputil_decode_meter_features(oh, &mf);
1253
1254     ds_put_format(s, "\nmax_meter:%"PRIu32, mf.max_meters);
1255     ds_put_format(s, " max_bands:%"PRIu8, mf.max_bands);
1256     ds_put_format(s, " max_color:%"PRIu8"\n", mf.max_color);
1257
1258     ds_put_cstr(s, "band_types: ");
1259     ofp_print_bit_names(s, mf.band_types,
1260                         ofputil_meter_band_types_to_name, ' ');
1261     ds_put_char(s, '\n');
1262
1263     ds_put_cstr(s, "capabilities: ");
1264     ofp_print_bit_names(s, mf.capabilities,
1265                         ofputil_meter_capabilities_to_name, ' ');
1266     ds_put_char(s, '\n');
1267 }
1268
1269 static void
1270 ofp_print_meter_config_reply(struct ds *s, const struct ofp_header *oh)
1271 {
1272     struct ofpbuf bands;
1273     struct ofpbuf b;
1274
1275     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1276     ofpbuf_init(&bands, 64);
1277     for (;;) {
1278         struct ofputil_meter_config mc;
1279         int retval;
1280
1281         retval = ofputil_decode_meter_config(&b, &mc, &bands);
1282         if (retval) {
1283             if (retval != EOF) {
1284                 ofp_print_error(s, retval);
1285             }
1286             break;
1287         }
1288         ds_put_char(s, '\n');
1289         ofp_print_meter_config(s, &mc);
1290     }
1291     ofpbuf_uninit(&bands);
1292 }
1293
1294 static void
1295 ofp_print_meter_stats_reply(struct ds *s, const struct ofp_header *oh)
1296 {
1297     struct ofpbuf bands;
1298     struct ofpbuf b;
1299
1300     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1301     ofpbuf_init(&bands, 64);
1302     for (;;) {
1303         struct ofputil_meter_stats ms;
1304         int retval;
1305
1306         retval = ofputil_decode_meter_stats(&b, &ms, &bands);
1307         if (retval) {
1308             if (retval != EOF) {
1309                 ofp_print_error(s, retval);
1310             }
1311             break;
1312         }
1313         ds_put_char(s, '\n');
1314         ofp_print_meter_stats(s, &ms);
1315     }
1316     ofpbuf_uninit(&bands);
1317 }
1318
1319 static void
1320 ofp_print_error(struct ds *string, enum ofperr error)
1321 {
1322     if (string->length) {
1323         ds_put_char(string, ' ');
1324     }
1325     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1326 }
1327
1328 static void
1329 ofp_print_hello(struct ds *string, const struct ofp_header *oh)
1330 {
1331     uint32_t allowed_versions;
1332     bool ok;
1333
1334     ok = ofputil_decode_hello(oh, &allowed_versions);
1335
1336     ds_put_cstr(string, "\n version bitmap: ");
1337     ofputil_format_version_bitmap(string, allowed_versions);
1338
1339     if (!ok) {
1340         ds_put_cstr(string, "\n unknown data in hello:\n");
1341         ds_put_hex_dump(string, oh, ntohs(oh->length), 0, true);
1342     }
1343 }
1344
1345 static void
1346 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
1347 {
1348     size_t len = ntohs(oh->length);
1349     struct ofpbuf payload;
1350     enum ofperr error;
1351     char *s;
1352
1353     error = ofperr_decode_msg(oh, &payload);
1354     if (!error) {
1355         ds_put_cstr(string, "***decode error***");
1356         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1357         return;
1358     }
1359
1360     ds_put_format(string, " %s\n", ofperr_get_name(error));
1361
1362     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
1363         ds_put_printable(string, payload.data, payload.size);
1364     } else {
1365         s = ofp_to_string(payload.data, payload.size, 1);
1366         ds_put_cstr(string, s);
1367         free(s);
1368     }
1369     ofpbuf_uninit(&payload);
1370 }
1371
1372 static void
1373 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
1374 {
1375     struct ofputil_port_status ps;
1376     enum ofperr error;
1377
1378     error = ofputil_decode_port_status(oh, &ps);
1379     if (error) {
1380         ofp_print_error(string, error);
1381         return;
1382     }
1383
1384     if (ps.reason == OFPPR_ADD) {
1385         ds_put_format(string, " ADD:");
1386     } else if (ps.reason == OFPPR_DELETE) {
1387         ds_put_format(string, " DEL:");
1388     } else if (ps.reason == OFPPR_MODIFY) {
1389         ds_put_format(string, " MOD:");
1390     }
1391
1392     ofp_print_phy_port(string, &ps.desc);
1393 }
1394
1395 static void
1396 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1397 {
1398     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
1399
1400     ds_put_char(string, '\n');
1401     ds_put_format(string, "Manufacturer: %.*s\n",
1402             (int) sizeof ods->mfr_desc, ods->mfr_desc);
1403     ds_put_format(string, "Hardware: %.*s\n",
1404             (int) sizeof ods->hw_desc, ods->hw_desc);
1405     ds_put_format(string, "Software: %.*s\n",
1406             (int) sizeof ods->sw_desc, ods->sw_desc);
1407     ds_put_format(string, "Serial Num: %.*s\n",
1408             (int) sizeof ods->serial_num, ods->serial_num);
1409     ds_put_format(string, "DP Description: %.*s\n",
1410             (int) sizeof ods->dp_desc, ods->dp_desc);
1411 }
1412
1413 static void
1414 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1415 {
1416     struct ofputil_flow_stats_request fsr;
1417     enum ofperr error;
1418
1419     error = ofputil_decode_flow_stats_request(&fsr, oh);
1420     if (error) {
1421         ofp_print_error(string, error);
1422         return;
1423     }
1424
1425     if (fsr.table_id != 0xff) {
1426         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1427     }
1428
1429     if (fsr.out_port != OFPP_ANY) {
1430         ds_put_cstr(string, " out_port=");
1431         ofputil_format_port(fsr.out_port, string);
1432     }
1433
1434     ds_put_char(string, ' ');
1435     match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
1436 }
1437
1438 void
1439 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1440 {
1441     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1442                   ntohll(fs->cookie));
1443
1444     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1445     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1446     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1447     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1448     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1449         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1450     }
1451     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1452         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1453     }
1454     if (fs->flags) {
1455         ofp_print_flow_flags(string, fs->flags);
1456     }
1457     if (fs->idle_age >= 0) {
1458         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1459     }
1460     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1461         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1462     }
1463
1464     match_format(&fs->match, string, fs->priority);
1465     if (string->string[string->length - 1] != ' ') {
1466         ds_put_char(string, ' ');
1467     }
1468
1469     ds_put_cstr(string, "actions=");
1470     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1471 }
1472
1473 static void
1474 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1475 {
1476     struct ofpbuf ofpacts;
1477     struct ofpbuf b;
1478
1479     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1480     ofpbuf_init(&ofpacts, 64);
1481     for (;;) {
1482         struct ofputil_flow_stats fs;
1483         int retval;
1484
1485         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1486         if (retval) {
1487             if (retval != EOF) {
1488                 ds_put_cstr(string, " ***parse error***");
1489             }
1490             break;
1491         }
1492         ds_put_char(string, '\n');
1493         ofp_print_flow_stats(string, &fs);
1494      }
1495     ofpbuf_uninit(&ofpacts);
1496 }
1497
1498 static void
1499 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1500 {
1501     struct ofputil_aggregate_stats as;
1502     enum ofperr error;
1503
1504     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1505     if (error) {
1506         ofp_print_error(string, error);
1507         return;
1508     }
1509
1510     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1511     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1512     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1513 }
1514
1515 static void
1516 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1517 {
1518     ds_put_cstr(string, leader);
1519     if (stat != UINT64_MAX) {
1520         ds_put_format(string, "%"PRIu64, stat);
1521     } else {
1522         ds_put_char(string, '?');
1523     }
1524     if (more) {
1525         ds_put_cstr(string, ", ");
1526     } else {
1527         ds_put_cstr(string, "\n");
1528     }
1529 }
1530
1531 static void
1532 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1533 {
1534     ofp_port_t ofp10_port;
1535     enum ofperr error;
1536
1537     error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1538     if (error) {
1539         ofp_print_error(string, error);
1540         return;
1541     }
1542
1543     ds_put_cstr(string, " port_no=");
1544     ofputil_format_port(ofp10_port, string);
1545 }
1546
1547 static void
1548 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1549                            int verbosity)
1550 {
1551     struct ofpbuf b;
1552
1553     ds_put_format(string, " %"PRIuSIZE" ports\n", ofputil_count_port_stats(oh));
1554     if (verbosity < 1) {
1555         return;
1556     }
1557
1558     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1559     for (;;) {
1560         struct ofputil_port_stats ps;
1561         int retval;
1562
1563         retval = ofputil_decode_port_stats(&ps, &b);
1564         if (retval) {
1565             if (retval != EOF) {
1566                 ds_put_cstr(string, " ***parse error***");
1567             }
1568             return;
1569         }
1570
1571         ds_put_cstr(string, "  port ");
1572         if (ofp_to_u16(ps.port_no) < 10) {
1573             ds_put_char(string, ' ');
1574         }
1575         ofputil_format_port(ps.port_no, string);
1576
1577         ds_put_cstr(string, ": rx ");
1578         print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1579         print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1580         print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1581         print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1582         print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1583         print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1584         print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1585
1586         ds_put_cstr(string, "           tx ");
1587         print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1588         print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1589         print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1590         print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1591         print_port_stat(string, "coll=", ps.stats.collisions, 0);
1592
1593         if (ps.duration_sec != UINT32_MAX) {
1594             ds_put_cstr(string, "           duration=");
1595             ofp_print_duration(string, ps.duration_sec, ps.duration_nsec);
1596             ds_put_char(string, '\n');
1597         }
1598     }
1599 }
1600
1601 static void
1602 ofp_print_one_ofpst_table_reply(struct ds *string, enum ofp_version ofp_version,
1603                                 const char *name, struct ofp12_table_stats *ts)
1604 {
1605     char name_[OFP_MAX_TABLE_NAME_LEN + 1];
1606
1607     /* ofp13_table_stats is different */
1608     if (ofp_version > OFP12_VERSION) {
1609         return;
1610     }
1611
1612     ovs_strlcpy(name_, name, sizeof name_);
1613
1614     ds_put_format(string, "  %d: %-8s: ", ts->table_id, name_);
1615     ds_put_format(string, "wild=0x%05"PRIx64", ", ntohll(ts->wildcards));
1616     ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1617     ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1618     ds_put_cstr(string, "               ");
1619     ds_put_format(string, "lookup=%"PRIu64", ", ntohll(ts->lookup_count));
1620     ds_put_format(string, "matched=%"PRIu64"\n", ntohll(ts->matched_count));
1621
1622     if (ofp_version < OFP11_VERSION) {
1623         return;
1624     }
1625
1626     ds_put_cstr(string, "               ");
1627     ds_put_format(string, "match=0x%08"PRIx64", ", ntohll(ts->match));
1628     ds_put_format(string, "instructions=0x%08"PRIx32", ",
1629                   ntohl(ts->instructions));
1630     ds_put_format(string, "config=0x%08"PRIx32"\n", ntohl(ts->config));
1631     ds_put_cstr(string, "               ");
1632     ds_put_format(string, "write_actions=0x%08"PRIx32", ",
1633                   ntohl(ts->write_actions));
1634     ds_put_format(string, "apply_actions=0x%08"PRIx32"\n",
1635                   ntohl(ts->apply_actions));
1636
1637     if (ofp_version < OFP12_VERSION) {
1638         return;
1639     }
1640
1641     ds_put_cstr(string, "               ");
1642     ds_put_format(string, "write_setfields=0x%016"PRIx64"\n",
1643                   ntohll(ts->write_setfields));
1644     ds_put_cstr(string, "               ");
1645     ds_put_format(string, "apply_setfields=0x%016"PRIx64"\n",
1646                   ntohll(ts->apply_setfields));
1647     ds_put_cstr(string, "               ");
1648     ds_put_format(string, "metadata_match=0x%016"PRIx64"\n",
1649                   ntohll(ts->metadata_match));
1650     ds_put_cstr(string, "               ");
1651     ds_put_format(string, "metadata_write=0x%016"PRIx64"\n",
1652                   ntohll(ts->metadata_write));
1653 }
1654
1655 static void
1656 ofp_print_ofpst_table_reply13(struct ds *string, const struct ofp_header *oh,
1657                               int verbosity)
1658 {
1659     struct ofp13_table_stats *ts;
1660     struct ofpbuf b;
1661     size_t n;
1662
1663     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1664     ofpraw_pull_assert(&b);
1665
1666     n = b.size / sizeof *ts;
1667     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1668     if (verbosity < 1) {
1669         return;
1670     }
1671
1672     for (;;) {
1673         ts = ofpbuf_try_pull(&b, sizeof *ts);
1674         if (!ts) {
1675             return;
1676         }
1677         ds_put_format(string,
1678                       "  %d: active=%"PRIu32", lookup=%"PRIu64  \
1679                       ", matched=%"PRIu64"\n",
1680                       ts->table_id, ntohl(ts->active_count),
1681                       ntohll(ts->lookup_count), ntohll(ts->matched_count));
1682     }
1683 }
1684
1685 static void
1686 ofp_print_ofpst_table_reply12(struct ds *string, const struct ofp_header *oh,
1687                               int verbosity)
1688 {
1689     struct ofp12_table_stats *ts;
1690     struct ofpbuf b;
1691     size_t n;
1692
1693     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1694     ofpraw_pull_assert(&b);
1695
1696     n = b.size / sizeof *ts;
1697     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1698     if (verbosity < 1) {
1699         return;
1700     }
1701
1702     for (;;) {
1703         ts = ofpbuf_try_pull(&b, sizeof *ts);
1704         if (!ts) {
1705             return;
1706         }
1707
1708         ofp_print_one_ofpst_table_reply(string, OFP12_VERSION, ts->name, ts);
1709      }
1710 }
1711
1712 static void
1713 ofp_print_ofpst_table_reply11(struct ds *string, const struct ofp_header *oh,
1714                               int verbosity)
1715 {
1716     struct ofp11_table_stats *ts;
1717     struct ofpbuf b;
1718     size_t n;
1719
1720     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1721     ofpraw_pull_assert(&b);
1722
1723     n = b.size / sizeof *ts;
1724     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1725     if (verbosity < 1) {
1726         return;
1727     }
1728
1729     for (;;) {
1730         struct ofp12_table_stats ts12;
1731
1732         ts = ofpbuf_try_pull(&b, sizeof *ts);
1733         if (!ts) {
1734             return;
1735         }
1736
1737         ts12.table_id = ts->table_id;
1738         ts12.wildcards = htonll(ntohl(ts->wildcards));
1739         ts12.max_entries = ts->max_entries;
1740         ts12.active_count = ts->active_count;
1741         ts12.lookup_count = ts->lookup_count;
1742         ts12.matched_count = ts->matched_count;
1743         ts12.match = htonll(ntohl(ts->match));
1744         ts12.instructions = ts->instructions;
1745         ts12.config = ts->config;
1746         ts12.write_actions = ts->write_actions;
1747         ts12.apply_actions = ts->apply_actions;
1748         ofp_print_one_ofpst_table_reply(string, OFP11_VERSION, ts->name, &ts12);
1749      }
1750 }
1751
1752 static void
1753 ofp_print_ofpst_table_reply10(struct ds *string, const struct ofp_header *oh,
1754                               int verbosity)
1755 {
1756     struct ofp10_table_stats *ts;
1757     struct ofpbuf b;
1758     size_t n;
1759
1760     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1761     ofpraw_pull_assert(&b);
1762
1763     n = b.size / sizeof *ts;
1764     ds_put_format(string, " %"PRIuSIZE" tables\n", n);
1765     if (verbosity < 1) {
1766         return;
1767     }
1768
1769     for (;;) {
1770         struct ofp12_table_stats ts12;
1771
1772         ts = ofpbuf_try_pull(&b, sizeof *ts);
1773         if (!ts) {
1774             return;
1775         }
1776
1777         ts12.table_id = ts->table_id;
1778         ts12.wildcards = htonll(ntohl(ts->wildcards));
1779         ts12.max_entries = ts->max_entries;
1780         ts12.active_count = ts->active_count;
1781         ts12.lookup_count = get_32aligned_be64(&ts->lookup_count);
1782         ts12.matched_count = get_32aligned_be64(&ts->matched_count);
1783         ofp_print_one_ofpst_table_reply(string, OFP10_VERSION, ts->name, &ts12);
1784      }
1785 }
1786
1787 static void
1788 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1789                             int verbosity)
1790 {
1791     switch ((enum ofp_version)oh->version) {
1792     case OFP13_VERSION:
1793         ofp_print_ofpst_table_reply13(string, oh, verbosity);
1794         break;
1795
1796     case OFP12_VERSION:
1797         ofp_print_ofpst_table_reply12(string, oh, verbosity);
1798         break;
1799
1800     case OFP11_VERSION:
1801         ofp_print_ofpst_table_reply11(string, oh, verbosity);
1802         break;
1803
1804     case OFP10_VERSION:
1805         ofp_print_ofpst_table_reply10(string, oh, verbosity);
1806         break;
1807
1808     default:
1809         OVS_NOT_REACHED();
1810     }
1811 }
1812
1813 static void
1814 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1815 {
1816     if (queue_id == OFPQ_ALL) {
1817         ds_put_cstr(string, "ALL");
1818     } else {
1819         ds_put_format(string, "%"PRIu32, queue_id);
1820     }
1821 }
1822
1823 static void
1824 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1825 {
1826     struct ofputil_queue_stats_request oqsr;
1827     enum ofperr error;
1828
1829     error = ofputil_decode_queue_stats_request(oh, &oqsr);
1830     if (error) {
1831         ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1832         return;
1833     }
1834
1835     ds_put_cstr(string, "port=");
1836     ofputil_format_port(oqsr.port_no, string);
1837
1838     ds_put_cstr(string, " queue=");
1839     ofp_print_queue_name(string, oqsr.queue_id);
1840 }
1841
1842 static void
1843 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1844                             int verbosity)
1845 {
1846     struct ofpbuf b;
1847
1848     ds_put_format(string, " %"PRIuSIZE" queues\n", ofputil_count_queue_stats(oh));
1849     if (verbosity < 1) {
1850         return;
1851     }
1852
1853     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1854     for (;;) {
1855         struct ofputil_queue_stats qs;
1856         int retval;
1857
1858         retval = ofputil_decode_queue_stats(&qs, &b);
1859         if (retval) {
1860             if (retval != EOF) {
1861                 ds_put_cstr(string, " ***parse error***");
1862             }
1863             return;
1864         }
1865
1866         ds_put_cstr(string, "  port ");
1867         ofputil_format_port(qs.port_no, string);
1868         ds_put_cstr(string, " queue ");
1869         ofp_print_queue_name(string, qs.queue_id);
1870         ds_put_cstr(string, ": ");
1871
1872         print_port_stat(string, "bytes=", qs.tx_bytes, 1);
1873         print_port_stat(string, "pkts=", qs.tx_packets, 1);
1874         print_port_stat(string, "errors=", qs.tx_errors, 1);
1875
1876         ds_put_cstr(string, "duration=");
1877         if (qs.duration_sec != UINT32_MAX) {
1878             ofp_print_duration(string, qs.duration_sec, qs.duration_nsec);
1879         } else {
1880             ds_put_char(string, '?');
1881         }
1882         ds_put_char(string, '\n');
1883     }
1884 }
1885
1886 static void
1887 ofp_print_ofpst_port_desc_reply(struct ds *string,
1888                                 const struct ofp_header *oh)
1889 {
1890     struct ofpbuf b;
1891
1892     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1893     ofpraw_pull_assert(&b);
1894     ds_put_char(string, '\n');
1895     ofp_print_phy_ports(string, oh->version, &b);
1896 }
1897
1898 static void
1899 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1900 {
1901     uint16_t flags = ofpmp_flags(oh);
1902
1903     if (flags) {
1904         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1905     }
1906 }
1907
1908 static void
1909 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1910 {
1911     uint16_t flags = ofpmp_flags(oh);
1912
1913     if (flags) {
1914         ds_put_cstr(string, " flags=");
1915         if (flags & OFPSF_REPLY_MORE) {
1916             ds_put_cstr(string, "[more]");
1917             flags &= ~OFPSF_REPLY_MORE;
1918         }
1919         if (flags) {
1920             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1921                           flags);
1922         }
1923     }
1924 }
1925
1926 static void
1927 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1928 {
1929     size_t len = ntohs(oh->length);
1930
1931     ds_put_format(string, " %"PRIuSIZE" bytes of payload\n", len - sizeof *oh);
1932     if (verbosity > 1) {
1933         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1934     }
1935 }
1936
1937 static void
1938 ofp_print_role_generic(struct ds *string, enum ofp12_controller_role role,
1939                        uint64_t generation_id)
1940 {
1941     ds_put_cstr(string, " role=");
1942
1943     switch (role) {
1944     case OFPCR12_ROLE_NOCHANGE:
1945         ds_put_cstr(string, "nochange");
1946         break;
1947     case OFPCR12_ROLE_EQUAL:
1948         ds_put_cstr(string, "equal"); /* OF 1.2 wording */
1949         break;
1950     case OFPCR12_ROLE_MASTER:
1951         ds_put_cstr(string, "master");
1952         break;
1953     case OFPCR12_ROLE_SLAVE:
1954         ds_put_cstr(string, "slave");
1955         break;
1956     default:
1957         OVS_NOT_REACHED();
1958     }
1959
1960     if (generation_id != UINT64_MAX) {
1961         ds_put_format(string, " generation_id=%"PRIu64, generation_id);
1962     }
1963 }
1964
1965 static void
1966 ofp_print_role_message(struct ds *string, const struct ofp_header *oh)
1967 {
1968     struct ofputil_role_request rr;
1969     enum ofperr error;
1970
1971     error = ofputil_decode_role_message(oh, &rr);
1972     if (error) {
1973         ofp_print_error(string, error);
1974         return;
1975     }
1976
1977     ofp_print_role_generic(string, rr.role, rr.have_generation_id ? rr.generation_id : UINT64_MAX);
1978 }
1979
1980 static void
1981 ofp_print_role_status_message(struct ds *string, const struct ofp_header *oh)
1982 {
1983     struct ofputil_role_status rs;
1984     enum ofperr error;
1985
1986     error = ofputil_decode_role_status(oh, &rs);
1987     if (error) {
1988         ofp_print_error(string, error);
1989         return;
1990     }
1991
1992     ofp_print_role_generic(string, rs.role, rs.generation_id);
1993
1994     ds_put_cstr(string, " reason=");
1995
1996     switch (rs.reason) {
1997     case OFPCRR_MASTER_REQUEST:
1998         ds_put_cstr(string, "master_request");
1999         break;
2000     case OFPCRR_CONFIG:
2001         ds_put_cstr(string, "configuration_changed");
2002         break;
2003     case OFPCRR_EXPERIMENTER:
2004         ds_put_cstr(string, "experimenter_data_changed");
2005         break;
2006     default:
2007         OVS_NOT_REACHED();
2008     }
2009 }
2010
2011 static void
2012 ofp_print_nxt_flow_mod_table_id(struct ds *string,
2013                                 const struct nx_flow_mod_table_id *nfmti)
2014 {
2015     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
2016 }
2017
2018 static void
2019 ofp_print_nxt_set_flow_format(struct ds *string,
2020                               const struct nx_set_flow_format *nsff)
2021 {
2022     uint32_t format = ntohl(nsff->format);
2023
2024     ds_put_cstr(string, " format=");
2025     if (ofputil_nx_flow_format_is_valid(format)) {
2026         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
2027     } else {
2028         ds_put_format(string, "%"PRIu32, format);
2029     }
2030 }
2031
2032 static void
2033 ofp_print_nxt_set_packet_in_format(struct ds *string,
2034                                    const struct nx_set_packet_in_format *nspf)
2035 {
2036     uint32_t format = ntohl(nspf->format);
2037
2038     ds_put_cstr(string, " format=");
2039     if (ofputil_packet_in_format_is_valid(format)) {
2040         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
2041     } else {
2042         ds_put_format(string, "%"PRIu32, format);
2043     }
2044 }
2045
2046 /* Returns a string form of 'reason'.  The return value is either a statically
2047  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
2048  * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
2049 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
2050 static const char *
2051 ofp_port_reason_to_string(enum ofp_port_reason reason,
2052                           char *reasonbuf, size_t bufsize)
2053 {
2054     switch (reason) {
2055     case OFPPR_ADD:
2056         return "add";
2057
2058     case OFPPR_DELETE:
2059         return "delete";
2060
2061     case OFPPR_MODIFY:
2062         return "modify";
2063
2064     default:
2065         snprintf(reasonbuf, bufsize, "%d", (int) reason);
2066         return reasonbuf;
2067     }
2068 }
2069
2070 static void
2071 ofp_print_nxt_set_async_config(struct ds *string,
2072                                const struct nx_async_config *nac)
2073 {
2074     int i;
2075
2076     for (i = 0; i < 2; i++) {
2077         int j;
2078
2079         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
2080
2081         ds_put_cstr(string, "       PACKET_IN:");
2082         for (j = 0; j < 32; j++) {
2083             if (nac->packet_in_mask[i] & htonl(1u << j)) {
2084                 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
2085                 const char *reason;
2086
2087                 reason = ofputil_packet_in_reason_to_string(j, reasonbuf,
2088                                                             sizeof reasonbuf);
2089                 ds_put_format(string, " %s", reason);
2090             }
2091         }
2092         if (!nac->packet_in_mask[i]) {
2093             ds_put_cstr(string, " (off)");
2094         }
2095         ds_put_char(string, '\n');
2096
2097         ds_put_cstr(string, "     PORT_STATUS:");
2098         for (j = 0; j < 32; j++) {
2099             if (nac->port_status_mask[i] & htonl(1u << j)) {
2100                 char reasonbuf[OFP_PORT_REASON_BUFSIZE];
2101                 const char *reason;
2102
2103                 reason = ofp_port_reason_to_string(j, reasonbuf,
2104                                                    sizeof reasonbuf);
2105                 ds_put_format(string, " %s", reason);
2106             }
2107         }
2108         if (!nac->port_status_mask[i]) {
2109             ds_put_cstr(string, " (off)");
2110         }
2111         ds_put_char(string, '\n');
2112
2113         ds_put_cstr(string, "    FLOW_REMOVED:");
2114         for (j = 0; j < 32; j++) {
2115             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
2116                 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2117                 const char *reason;
2118
2119                 reason = ofp_flow_removed_reason_to_string(j, reasonbuf,
2120                                                            sizeof reasonbuf);
2121                 ds_put_format(string, " %s", reason);
2122             }
2123         }
2124         if (!nac->flow_removed_mask[i]) {
2125             ds_put_cstr(string, " (off)");
2126         }
2127         ds_put_char(string, '\n');
2128     }
2129 }
2130
2131 static void
2132 ofp_print_nxt_set_controller_id(struct ds *string,
2133                                 const struct nx_controller_id *nci)
2134 {
2135     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
2136 }
2137
2138 static void
2139 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
2140                                   const struct ofp_header *oh)
2141 {
2142     ds_put_format(string, " id=%"PRIu32,
2143                   ofputil_decode_flow_monitor_cancel(oh));
2144 }
2145
2146 static const char *
2147 nx_flow_monitor_flags_to_name(uint32_t bit)
2148 {
2149     enum nx_flow_monitor_flags fmf = bit;
2150
2151     switch (fmf) {
2152     case NXFMF_INITIAL: return "initial";
2153     case NXFMF_ADD: return "add";
2154     case NXFMF_DELETE: return "delete";
2155     case NXFMF_MODIFY: return "modify";
2156     case NXFMF_ACTIONS: return "actions";
2157     case NXFMF_OWN: return "own";
2158     }
2159
2160     return NULL;
2161 }
2162
2163 static void
2164 ofp_print_nxst_flow_monitor_request(struct ds *string,
2165                                     const struct ofp_header *oh)
2166 {
2167     struct ofpbuf b;
2168
2169     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2170     for (;;) {
2171         struct ofputil_flow_monitor_request request;
2172         int retval;
2173
2174         retval = ofputil_decode_flow_monitor_request(&request, &b);
2175         if (retval) {
2176             if (retval != EOF) {
2177                 ofp_print_error(string, retval);
2178             }
2179             return;
2180         }
2181
2182         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
2183         ofp_print_bit_names(string, request.flags,
2184                             nx_flow_monitor_flags_to_name, ',');
2185
2186         if (request.out_port != OFPP_NONE) {
2187             ds_put_cstr(string, " out_port=");
2188             ofputil_format_port(request.out_port, string);
2189         }
2190
2191         if (request.table_id != 0xff) {
2192             ds_put_format(string, " table=%"PRIu8, request.table_id);
2193         }
2194
2195         ds_put_char(string, ' ');
2196         match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
2197         ds_chomp(string, ' ');
2198     }
2199 }
2200
2201 static void
2202 ofp_print_nxst_flow_monitor_reply(struct ds *string,
2203                                   const struct ofp_header *oh)
2204 {
2205     uint64_t ofpacts_stub[1024 / 8];
2206     struct ofpbuf ofpacts;
2207     struct ofpbuf b;
2208
2209     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2210     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2211     for (;;) {
2212         char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2213         struct ofputil_flow_update update;
2214         struct match match;
2215         int retval;
2216
2217         update.match = &match;
2218         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
2219         if (retval) {
2220             if (retval != EOF) {
2221                 ofp_print_error(string, retval);
2222             }
2223             ofpbuf_uninit(&ofpacts);
2224             return;
2225         }
2226
2227         ds_put_cstr(string, "\n event=");
2228         switch (update.event) {
2229         case NXFME_ADDED:
2230             ds_put_cstr(string, "ADDED");
2231             break;
2232
2233         case NXFME_DELETED:
2234             ds_put_format(string, "DELETED reason=%s",
2235                           ofp_flow_removed_reason_to_string(update.reason,
2236                                                             reasonbuf,
2237                                                             sizeof reasonbuf));
2238             break;
2239
2240         case NXFME_MODIFIED:
2241             ds_put_cstr(string, "MODIFIED");
2242             break;
2243
2244         case NXFME_ABBREV:
2245             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
2246             continue;
2247         }
2248
2249         ds_put_format(string, " table=%"PRIu8, update.table_id);
2250         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
2251             ds_put_format(string, " idle_timeout=%"PRIu16,
2252                           update.idle_timeout);
2253         }
2254         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
2255             ds_put_format(string, " hard_timeout=%"PRIu16,
2256                           update.hard_timeout);
2257         }
2258         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
2259
2260         ds_put_char(string, ' ');
2261         match_format(update.match, string, OFP_DEFAULT_PRIORITY);
2262
2263         if (update.ofpacts_len) {
2264             if (string->string[string->length - 1] != ' ') {
2265                 ds_put_char(string, ' ');
2266             }
2267             ds_put_cstr(string, "actions=");
2268             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
2269         }
2270     }
2271 }
2272
2273 void
2274 ofp_print_version(const struct ofp_header *oh,
2275                   struct ds *string)
2276 {
2277     switch (oh->version) {
2278     case OFP10_VERSION:
2279         break;
2280     case OFP11_VERSION:
2281         ds_put_cstr(string, " (OF1.1)");
2282         break;
2283     case OFP12_VERSION:
2284         ds_put_cstr(string, " (OF1.2)");
2285         break;
2286     case OFP13_VERSION:
2287         ds_put_cstr(string, " (OF1.3)");
2288         break;
2289     default:
2290         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
2291         break;
2292     }
2293     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
2294 }
2295
2296 static void
2297 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2298                        struct ds *string)
2299 {
2300     ds_put_cstr(string, ofpraw_get_name(raw));
2301     ofp_print_version(oh, string);
2302 }
2303
2304 static void
2305 ofp_print_not_implemented(struct ds *string)
2306 {
2307     ds_put_cstr(string, "NOT IMPLEMENTED YET!\n");
2308 }
2309
2310 static void
2311 ofp_print_group(struct ds *s, uint32_t group_id, uint8_t type,
2312                 struct list *p_buckets)
2313 {
2314     static const char *type_str[] = { "all", "select", "indirect",
2315                                       "ff", "unknown" };
2316     struct ofputil_bucket *bucket;
2317
2318     ds_put_format(s, "group_id=%"PRIu32",type=%s",
2319                   group_id, type_str[type > 4 ? 4 : type]);
2320     if (!p_buckets) {
2321         return;
2322     }
2323
2324     LIST_FOR_EACH (bucket, list_node, p_buckets) {
2325         ds_put_cstr(s, ",bucket=");
2326
2327         if (bucket->weight != 1) {
2328             ds_put_format(s, "weight:%"PRIu16",", bucket->weight);
2329         }
2330         if (bucket->watch_port != OFPP_NONE) {
2331             ds_put_format(s, "watch_port:%"PRIu32",", bucket->watch_port);
2332         }
2333         if (bucket->watch_group != OFPG11_ANY) {
2334             ds_put_format(s, "watch_group:%"PRIu32",", bucket->watch_group);
2335         }
2336
2337         ds_put_cstr(s, "actions=");
2338         ofpacts_format(bucket->ofpacts, bucket->ofpacts_len, s);
2339     }
2340 }
2341
2342 static void
2343 ofp_print_group_desc(struct ds *s, const struct ofp_header *oh)
2344 {
2345     struct ofpbuf b;
2346
2347     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2348     for (;;) {
2349         struct ofputil_group_desc gd;
2350         int retval;
2351
2352         retval = ofputil_decode_group_desc_reply(&gd, &b, oh->version);
2353         if (retval) {
2354             if (retval != EOF) {
2355                 ds_put_cstr(s, " ***parse error***");
2356             }
2357             break;
2358         }
2359
2360         ds_put_char(s, '\n');
2361         ds_put_char(s, ' ');
2362         ofp_print_group(s, gd.group_id, gd.type, &gd.buckets);
2363      }
2364 }
2365
2366 static void
2367 ofp_print_ofpst_group_request(struct ds *string, const struct ofp_header *oh)
2368 {
2369     enum ofperr error;
2370     uint32_t group_id;
2371
2372     error = ofputil_decode_group_stats_request(oh, &group_id);
2373     if (error) {
2374         ofp_print_error(string, error);
2375         return;
2376     }
2377
2378     ds_put_cstr(string, " group_id=");
2379     ofputil_format_group(group_id, string);
2380 }
2381
2382 static void
2383 ofp_print_group_stats(struct ds *s, const struct ofp_header *oh)
2384 {
2385     struct ofpbuf b;
2386     uint32_t bucket_i;
2387
2388     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2389
2390     for (;;) {
2391         struct ofputil_group_stats gs;
2392         int retval;
2393
2394         retval = ofputil_decode_group_stats_reply(&b, &gs);
2395         if (retval) {
2396             if (retval != EOF) {
2397                 ds_put_cstr(s, " ***parse error***");
2398             }
2399             break;
2400         }
2401
2402         ds_put_char(s, '\n');
2403
2404         ds_put_char(s, ' ');
2405         ds_put_format(s, "group_id=%"PRIu32",", gs.group_id);
2406
2407         if (gs.duration_sec != UINT32_MAX) {
2408             ds_put_cstr(s, "duration=");
2409             ofp_print_duration(s, gs.duration_sec, gs.duration_nsec);
2410             ds_put_char(s, ',');
2411         }
2412         ds_put_format(s, "ref_count=%"PRIu32",", gs.ref_count);
2413         ds_put_format(s, "packet_count=%"PRIu64",", gs.packet_count);
2414         ds_put_format(s, "byte_count=%"PRIu64"", gs.byte_count);
2415
2416         for (bucket_i = 0; bucket_i < gs.n_buckets; bucket_i++) {
2417             if (gs.bucket_stats[bucket_i].packet_count != UINT64_MAX) {
2418                 ds_put_format(s, ",bucket%"PRIu32":", bucket_i);
2419                 ds_put_format(s, "packet_count=%"PRIu64",", gs.bucket_stats[bucket_i].packet_count);
2420                 ds_put_format(s, "byte_count=%"PRIu64"", gs.bucket_stats[bucket_i].byte_count);
2421             }
2422         }
2423
2424         free(gs.bucket_stats);
2425      }
2426 }
2427
2428 static void
2429 ofp_print_group_features(struct ds *string, const struct ofp_header *oh)
2430 {
2431     struct ofputil_group_features features;
2432
2433     ofputil_decode_group_features_reply(oh, &features);
2434
2435     ds_put_format(string, "\n Group table:\n");
2436     ds_put_format(string, "    Types:  0x%"PRIx32"\n", features.types);
2437     ds_put_format(string, "    Capabilities:  0x%"PRIx32"\n",
2438                   features.capabilities);
2439
2440     if (features.types & (1u << OFPGT11_ALL)) {
2441         ds_put_format(string, "    All group :\n");
2442         ds_put_format(string,
2443                       "        max_groups = %#"PRIx32" actions=0x%08"PRIx32"\n",
2444                       features.max_groups[0], features.actions[0]);
2445     }
2446
2447     if (features.types & (1u << OFPGT11_SELECT)) {
2448         ds_put_format(string, "    Select group :\n");
2449         ds_put_format(string, "        max_groups = %#"PRIx32" "
2450                       "actions=0x%08"PRIx32"\n",
2451                       features.max_groups[1], features.actions[1]);
2452     }
2453
2454     if (features.types & (1u << OFPGT11_INDIRECT)) {
2455         ds_put_format(string, "    Indirect group :\n");
2456         ds_put_format(string, "        max_groups = %#"PRIx32" "
2457                       "actions=0x%08"PRIx32"\n",
2458                       features.max_groups[2], features.actions[2]);
2459     }
2460
2461     if (features.types & (1u << OFPGT11_FF)) {
2462         ds_put_format(string, "    Fast Failover group :\n");
2463         ds_put_format(string, "        max_groups = %#"PRIx32" "
2464                       "actions=0x%08"PRIx32"\n",
2465                       features.max_groups[3], features.actions[3]);
2466     }
2467 }
2468
2469 static void
2470 ofp_print_group_mod(struct ds *s, const struct ofp_header *oh)
2471 {
2472     struct ofputil_group_mod gm;
2473     int error;
2474
2475     error = ofputil_decode_group_mod(oh, &gm);
2476     if (error) {
2477         ofp_print_error(s, error);
2478         return;
2479     }
2480
2481     ds_put_char(s, '\n');
2482
2483     ds_put_char(s, ' ');
2484     switch (gm.command) {
2485     case OFPGC11_ADD:
2486         ds_put_cstr(s, "ADD");
2487         break;
2488
2489     case OFPGC11_MODIFY:
2490         ds_put_cstr(s, "MOD");
2491         break;
2492
2493     case OFPGC11_DELETE:
2494         ds_put_cstr(s, "DEL");
2495         break;
2496
2497     default:
2498         ds_put_format(s, "cmd:%"PRIu16"", gm.command);
2499     }
2500     ds_put_char(s, ' ');
2501
2502     ofp_print_group(s, gm.group_id, gm.type, &gm.buckets);
2503 }
2504
2505 static void
2506 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2507                 struct ds *string, int verbosity)
2508 {
2509     const void *msg = oh;
2510
2511     ofp_header_to_string__(oh, raw, string);
2512     switch (ofptype_from_ofpraw(raw)) {
2513
2514     case OFPTYPE_GROUP_STATS_REQUEST:
2515         ofp_print_stats_request(string, oh);
2516         ofp_print_ofpst_group_request(string, oh);
2517         break;
2518
2519     case OFPTYPE_GROUP_STATS_REPLY:
2520         ofp_print_group_stats(string, oh);
2521         break;
2522
2523     case OFPTYPE_GROUP_DESC_STATS_REQUEST:
2524         ofp_print_stats_request(string, oh);
2525         break;
2526
2527     case OFPTYPE_GROUP_DESC_STATS_REPLY:
2528         ofp_print_group_desc(string, oh);
2529         break;
2530
2531     case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
2532         ofp_print_stats_request(string, oh);
2533         break;
2534
2535     case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
2536         ofp_print_group_features(string, oh);
2537         break;
2538
2539     case OFPTYPE_GROUP_MOD:
2540         ofp_print_group_mod(string, oh);
2541         break;
2542
2543     case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
2544     case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
2545         ofp_print_not_implemented(string);
2546         break;
2547
2548     case OFPTYPE_HELLO:
2549         ofp_print_hello(string, oh);
2550         break;
2551
2552     case OFPTYPE_ERROR:
2553         ofp_print_error_msg(string, oh);
2554         break;
2555
2556     case OFPTYPE_ECHO_REQUEST:
2557     case OFPTYPE_ECHO_REPLY:
2558         ofp_print_echo(string, oh, verbosity);
2559         break;
2560
2561     case OFPTYPE_FEATURES_REQUEST:
2562         break;
2563
2564     case OFPTYPE_FEATURES_REPLY:
2565         ofp_print_switch_features(string, oh);
2566         break;
2567
2568     case OFPTYPE_GET_CONFIG_REQUEST:
2569         break;
2570
2571     case OFPTYPE_GET_CONFIG_REPLY:
2572     case OFPTYPE_SET_CONFIG:
2573         ofp_print_switch_config(string, ofpmsg_body(oh));
2574         break;
2575
2576     case OFPTYPE_PACKET_IN:
2577         ofp_print_packet_in(string, oh, verbosity);
2578         break;
2579
2580     case OFPTYPE_FLOW_REMOVED:
2581         ofp_print_flow_removed(string, oh);
2582         break;
2583
2584     case OFPTYPE_PORT_STATUS:
2585         ofp_print_port_status(string, oh);
2586         break;
2587
2588     case OFPTYPE_PACKET_OUT:
2589         ofp_print_packet_out(string, oh, verbosity);
2590         break;
2591
2592     case OFPTYPE_FLOW_MOD:
2593         ofp_print_flow_mod(string, oh, verbosity);
2594         break;
2595
2596     case OFPTYPE_PORT_MOD:
2597         ofp_print_port_mod(string, oh);
2598         break;
2599
2600     case OFPTYPE_TABLE_MOD:
2601         ofp_print_table_mod(string, oh);
2602         break;
2603
2604     case OFPTYPE_METER_MOD:
2605         ofp_print_meter_mod(string, oh);
2606         break;
2607
2608     case OFPTYPE_BARRIER_REQUEST:
2609     case OFPTYPE_BARRIER_REPLY:
2610         break;
2611
2612     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
2613         ofp_print_queue_get_config_request(string, oh);
2614         break;
2615
2616     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
2617         ofp_print_queue_get_config_reply(string, oh);
2618         break;
2619
2620     case OFPTYPE_ROLE_REQUEST:
2621     case OFPTYPE_ROLE_REPLY:
2622         ofp_print_role_message(string, oh);
2623         break;
2624     case OFPTYPE_ROLE_STATUS:
2625         ofp_print_role_status_message(string, oh);
2626         break;
2627
2628     case OFPTYPE_METER_STATS_REQUEST:
2629     case OFPTYPE_METER_CONFIG_STATS_REQUEST:
2630         ofp_print_stats_request(string, oh);
2631         ofp_print_meter_stats_request(string, oh);
2632         break;
2633
2634     case OFPTYPE_METER_STATS_REPLY:
2635         ofp_print_stats_reply(string, oh);
2636         ofp_print_meter_stats_reply(string, oh);
2637         break;
2638
2639     case OFPTYPE_METER_CONFIG_STATS_REPLY:
2640         ofp_print_stats_reply(string, oh);
2641         ofp_print_meter_config_reply(string, oh);
2642         break;
2643
2644     case OFPTYPE_METER_FEATURES_STATS_REPLY:
2645         ofp_print_stats_reply(string, oh);
2646         ofp_print_meter_features_reply(string, oh);
2647         break;
2648
2649     case OFPTYPE_DESC_STATS_REQUEST:
2650     case OFPTYPE_PORT_DESC_STATS_REQUEST:
2651     case OFPTYPE_METER_FEATURES_STATS_REQUEST:
2652         ofp_print_stats_request(string, oh);
2653         break;
2654
2655     case OFPTYPE_FLOW_STATS_REQUEST:
2656     case OFPTYPE_AGGREGATE_STATS_REQUEST:
2657         ofp_print_stats_request(string, oh);
2658         ofp_print_flow_stats_request(string, oh);
2659         break;
2660
2661     case OFPTYPE_TABLE_STATS_REQUEST:
2662         ofp_print_stats_request(string, oh);
2663         break;
2664
2665     case OFPTYPE_PORT_STATS_REQUEST:
2666         ofp_print_stats_request(string, oh);
2667         ofp_print_ofpst_port_request(string, oh);
2668         break;
2669
2670     case OFPTYPE_QUEUE_STATS_REQUEST:
2671         ofp_print_stats_request(string, oh);
2672         ofp_print_ofpst_queue_request(string, oh);
2673         break;
2674
2675     case OFPTYPE_DESC_STATS_REPLY:
2676         ofp_print_stats_reply(string, oh);
2677         ofp_print_ofpst_desc_reply(string, oh);
2678         break;
2679
2680     case OFPTYPE_FLOW_STATS_REPLY:
2681         ofp_print_stats_reply(string, oh);
2682         ofp_print_flow_stats_reply(string, oh);
2683         break;
2684
2685     case OFPTYPE_QUEUE_STATS_REPLY:
2686         ofp_print_stats_reply(string, oh);
2687         ofp_print_ofpst_queue_reply(string, oh, verbosity);
2688         break;
2689
2690     case OFPTYPE_PORT_STATS_REPLY:
2691         ofp_print_stats_reply(string, oh);
2692         ofp_print_ofpst_port_reply(string, oh, verbosity);
2693         break;
2694
2695     case OFPTYPE_TABLE_STATS_REPLY:
2696         ofp_print_stats_reply(string, oh);
2697         ofp_print_ofpst_table_reply(string, oh, verbosity);
2698         break;
2699
2700     case OFPTYPE_AGGREGATE_STATS_REPLY:
2701         ofp_print_stats_reply(string, oh);
2702         ofp_print_aggregate_stats_reply(string, oh);
2703         break;
2704
2705     case OFPTYPE_PORT_DESC_STATS_REPLY:
2706         ofp_print_stats_reply(string, oh);
2707         ofp_print_ofpst_port_desc_reply(string, oh);
2708         break;
2709
2710     case OFPTYPE_FLOW_MOD_TABLE_ID:
2711         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
2712         break;
2713
2714     case OFPTYPE_SET_FLOW_FORMAT:
2715         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
2716         break;
2717
2718     case OFPTYPE_SET_PACKET_IN_FORMAT:
2719         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
2720         break;
2721
2722     case OFPTYPE_FLOW_AGE:
2723         break;
2724
2725     case OFPTYPE_SET_CONTROLLER_ID:
2726         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
2727         break;
2728
2729     case OFPTYPE_GET_ASYNC_REPLY:
2730     case OFPTYPE_SET_ASYNC_CONFIG:
2731         ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
2732         break;
2733     case OFPTYPE_GET_ASYNC_REQUEST:
2734         break;
2735     case OFPTYPE_FLOW_MONITOR_CANCEL:
2736         ofp_print_nxt_flow_monitor_cancel(string, msg);
2737         break;
2738
2739     case OFPTYPE_FLOW_MONITOR_PAUSED:
2740     case OFPTYPE_FLOW_MONITOR_RESUMED:
2741         break;
2742
2743     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
2744         ofp_print_nxst_flow_monitor_request(string, msg);
2745         break;
2746
2747     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
2748         ofp_print_nxst_flow_monitor_reply(string, msg);
2749         break;
2750     }
2751 }
2752
2753 /* Composes and returns a string representing the OpenFlow packet of 'len'
2754  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
2755  * verbosity and higher numbers increase verbosity.  The caller is responsible
2756  * for freeing the string. */
2757 char *
2758 ofp_to_string(const void *oh_, size_t len, int verbosity)
2759 {
2760     struct ds string = DS_EMPTY_INITIALIZER;
2761     const struct ofp_header *oh = oh_;
2762
2763     if (!len) {
2764         ds_put_cstr(&string, "OpenFlow message is empty\n");
2765     } else if (len < sizeof(struct ofp_header)) {
2766         ds_put_format(&string, "OpenFlow packet too short (only %"PRIuSIZE" bytes):\n",
2767                       len);
2768     } else if (ntohs(oh->length) > len) {
2769         enum ofperr error;
2770         enum ofpraw raw;
2771
2772         error = ofpraw_decode_partial(&raw, oh, len);
2773         if (!error) {
2774             ofp_header_to_string__(oh, raw, &string);
2775             ds_put_char(&string, '\n');
2776         }
2777
2778         ds_put_format(&string,
2779                       "(***truncated to %"PRIuSIZE" bytes from %"PRIu16"***)\n",
2780                       len, ntohs(oh->length));
2781     } else if (ntohs(oh->length) < len) {
2782         ds_put_format(&string,
2783                       "(***only uses %"PRIu16" bytes out of %"PRIuSIZE"***)\n",
2784                       ntohs(oh->length), len);
2785     } else {
2786         enum ofperr error;
2787         enum ofpraw raw;
2788
2789         error = ofpraw_decode(&raw, oh);
2790         if (!error) {
2791             ofp_to_string__(oh, raw, &string, verbosity);
2792             if (verbosity >= 5) {
2793                 if (ds_last(&string) != '\n') {
2794                     ds_put_char(&string, '\n');
2795                 }
2796                 ds_put_hex_dump(&string, oh, len, 0, true);
2797             }
2798             if (ds_last(&string) != '\n') {
2799                 ds_put_char(&string, '\n');
2800             }
2801             return ds_steal_cstr(&string);
2802         }
2803
2804         ofp_print_error(&string, error);
2805     }
2806     ds_put_hex_dump(&string, oh, len, 0, true);
2807     return ds_steal_cstr(&string);
2808 }
2809 \f
2810 static void
2811 print_and_free(FILE *stream, char *string)
2812 {
2813     fputs(string, stream);
2814     free(string);
2815 }
2816
2817 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
2818  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
2819  * numbers increase verbosity. */
2820 void
2821 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
2822 {
2823     print_and_free(stream, ofp_to_string(oh, len, verbosity));
2824 }
2825
2826 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
2827  * 'data' to 'stream'. */
2828 void
2829 ofp_print_packet(FILE *stream, const void *data, size_t len)
2830 {
2831     print_and_free(stream, ofp_packet_to_string(data, len));
2832 }