lib/ofp-print.c

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