lib/ofp-print.c

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