lib/ofp-print.c

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