lib/ofp-print.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <sys/types.h>
  23 #include <netinet/in.h>
  24 #include <sys/wait.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <ctype.h>
  28
  29 #include "bundle.h"
  30 #include "byte-order.h"
  31 #include "compiler.h"
  32 #include "dynamic-string.h"
  33 #include "flow.h"
  34 #include "learn.h"
  35 #include "multipath.h"
  36 #include "meta-flow.h"
  37 #include "netdev.h"
  38 #include "nx-match.h"
  39 #include "ofp-actions.h"
  40 #include "ofp-errors.h"
  41 #include "ofp-msgs.h"
  42 #include "ofp-util.h"
  43 #include "ofpbuf.h"
  44 #include "openflow/openflow.h"
  45 #include "openflow/nicira-ext.h"
  46 #include "packets.h"
  47 #include "pcap.h"
  48 #include "type-props.h"
  49 #include "unaligned.h"
  50 #include "util.h"
  51
  52 static void ofp_print_queue_name(struct ds *string, uint32_t port);
  53 static void ofp_print_error(struct ds *, enum ofperr);
  54
  55
  56 /* Returns a string that represents the contents of the Ethernet frame in the
  57  * 'len' bytes starting at 'data'.  The caller must free the returned string.*/
  58 char *
  59 ofp_packet_to_string(const void *data, size_t len)
  60 {
  61     struct ds ds = DS_EMPTY_INITIALIZER;
  62     struct ofpbuf buf;
  63     struct flow flow;
  64
  65     ofpbuf_use_const(&buf, data, len);
  66     flow_extract(&buf, 0, 0, 0, &flow);
  67     flow_format(&ds, &flow);
  68
  69     if (buf.l7) {
  70         if (flow.nw_proto == IPPROTO_TCP) {
  71             struct tcp_header *th = buf.l4;
  72             ds_put_format(&ds, " tcp_csum:%"PRIx16,
  73                           ntohs(th->tcp_csum));
  74         } else if (flow.nw_proto == IPPROTO_UDP) {
  75             struct udp_header *uh = buf.l4;
  76             ds_put_format(&ds, " udp_csum:%"PRIx16,
  77                           ntohs(uh->udp_csum));
  78         }
  79     }
  80
  81     ds_put_char(&ds, '\n');
  82
  83     return ds_cstr(&ds);
  84 }
  85
  86 static void
  87 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
  88                     int verbosity)
  89 {
  90     struct ofputil_packet_in pin;
  91     int error;
  92     int i;
  93
  94     error = ofputil_decode_packet_in(&pin, oh);
  95     if (error) {
  96         ofp_print_error(string, error);
  97         return;
  98     }
  99
 100     if (pin.table_id) {
 101         ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
 102     }
 103
 104     if (pin.cookie) {
 105         ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
 106     }
 107
 108     ds_put_format(string, " total_len=%"PRIu16" in_port=", pin.total_len);
 109     ofputil_format_port(pin.fmd.in_port, string);
 110
 111     if (pin.fmd.tun_id_mask) {
 112         ds_put_format(string, " tun_id=0x%"PRIx64, ntohll(pin.fmd.tun_id));
 113         if (pin.fmd.tun_id_mask != htonll(UINT64_MAX)) {
 114             ds_put_format(string, "/0x%"PRIx64, ntohll(pin.fmd.tun_id_mask));
 115         }
 116     }
 117
 118     if (pin.fmd.metadata_mask) {
 119         ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
 120         if (pin.fmd.metadata_mask != htonll(UINT64_MAX)) {
 121             ds_put_format(string, "/0x%"PRIx64, ntohll(pin.fmd.metadata_mask));
 122         }
 123     }
 124
 125     for (i = 0; i < FLOW_N_REGS; i++) {
 126         if (pin.fmd.reg_masks[i]) {
 127             ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
 128             if (pin.fmd.reg_masks[i] != UINT32_MAX) {
 129                 ds_put_format(string, "/0x%"PRIx32, pin.fmd.reg_masks[i]);
 130             }
 131         }
 132     }
 133
 134     ds_put_format(string, " (via %s)",
 135                   ofputil_packet_in_reason_to_string(pin.reason));
 136
 137     ds_put_format(string, " data_len=%zu", pin.packet_len);
 138     if (pin.buffer_id == UINT32_MAX) {
 139         ds_put_format(string, " (unbuffered)");
 140         if (pin.total_len != pin.packet_len) {
 141             ds_put_format(string, " (***total_len != data_len***)");
 142         }
 143     } else {
 144         ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
 145         if (pin.total_len < pin.packet_len) {
 146             ds_put_format(string, " (***total_len < data_len***)");
 147         }
 148     }
 149     ds_put_char(string, '\n');
 150
 151     if (verbosity > 0) {
 152         char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
 153         ds_put_cstr(string, packet);
 154         free(packet);
 155     }
 156 }
 157
 158 static void
 159 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
 160                      int verbosity)
 161 {
 162     struct ofputil_packet_out po;
 163     struct ofpbuf ofpacts;
 164     enum ofperr error;
 165
 166     ofpbuf_init(&ofpacts, 64);
 167     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
 168     if (error) {
 169         ofpbuf_uninit(&ofpacts);
 170         ofp_print_error(string, error);
 171         return;
 172     }
 173
 174     ds_put_cstr(string, " in_port=");
 175     ofputil_format_port(po.in_port, string);
 176
 177     ds_put_char(string, ' ');
 178     ofpacts_format(po.ofpacts, po.ofpacts_len, string);
 179
 180     if (po.buffer_id == UINT32_MAX) {
 181         ds_put_format(string, " data_len=%zu", po.packet_len);
 182         if (verbosity > 0 && po.packet_len > 0) {
 183             char *packet = ofp_packet_to_string(po.packet, po.packet_len);
 184             ds_put_char(string, '\n');
 185             ds_put_cstr(string, packet);
 186             free(packet);
 187         }
 188     } else {
 189         ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
 190     }
 191     ds_put_char(string, '\n');
 192
 193     ofpbuf_uninit(&ofpacts);
 194 }
 195
 196 /* qsort comparison function. */
 197 static int
 198 compare_ports(const void *a_, const void *b_)
 199 {
 200     const struct ofputil_phy_port *a = a_;
 201     const struct ofputil_phy_port *b = b_;
 202     uint16_t ap = a->port_no;
 203     uint16_t bp = b->port_no;
 204
 205     return ap < bp ? -1 : ap > bp;
 206 }
 207
 208 static void
 209 ofp_print_bit_names(struct ds *string, uint32_t bits,
 210                     const char *(*bit_to_name)(uint32_t bit),
 211                     char separator)
 212 {
 213     int n = 0;
 214     int i;
 215
 216     if (!bits) {
 217         ds_put_cstr(string, "0");
 218         return;
 219     }
 220
 221     for (i = 0; i < 32; i++) {
 222         uint32_t bit = UINT32_C(1) << i;
 223
 224         if (bits & bit) {
 225             const char *name = bit_to_name(bit);
 226             if (name) {
 227                 if (n++) {
 228                     ds_put_char(string, separator);
 229                 }
 230                 ds_put_cstr(string, name);
 231                 bits &= ~bit;
 232             }
 233         }
 234     }
 235
 236     if (bits) {
 237         if (n) {
 238             ds_put_char(string, separator);
 239         }
 240         ds_put_format(string, "0x%"PRIx32, bits);
 241     }
 242 }
 243
 244 static const char *
 245 netdev_feature_to_name(uint32_t bit)
 246 {
 247     enum netdev_features f = bit;
 248
 249     switch (f) {
 250     case NETDEV_F_10MB_HD:    return "10MB-HD";
 251     case NETDEV_F_10MB_FD:    return "10MB-FD";
 252     case NETDEV_F_100MB_HD:   return "100MB-HD";
 253     case NETDEV_F_100MB_FD:   return "100MB-FD";
 254     case NETDEV_F_1GB_HD:     return "1GB-HD";
 255     case NETDEV_F_1GB_FD:     return "1GB-FD";
 256     case NETDEV_F_10GB_FD:    return "10GB-FD";
 257     case NETDEV_F_40GB_FD:    return "40GB-FD";
 258     case NETDEV_F_100GB_FD:   return "100GB-FD";
 259     case NETDEV_F_1TB_FD:     return "1TB-FD";
 260     case NETDEV_F_OTHER:      return "OTHER";
 261     case NETDEV_F_COPPER:     return "COPPER";
 262     case NETDEV_F_FIBER:      return "FIBER";
 263     case NETDEV_F_AUTONEG:    return "AUTO_NEG";
 264     case NETDEV_F_PAUSE:      return "AUTO_PAUSE";
 265     case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
 266     }
 267
 268     return NULL;
 269 }
 270
 271 static void
 272 ofp_print_port_features(struct ds *string, enum netdev_features features)
 273 {
 274     ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
 275     ds_put_char(string, '\n');
 276 }
 277
 278 static const char *
 279 ofputil_port_config_to_name(uint32_t bit)
 280 {
 281     enum ofputil_port_config pc = bit;
 282
 283     switch (pc) {
 284     case OFPUTIL_PC_PORT_DOWN:    return "PORT_DOWN";
 285     case OFPUTIL_PC_NO_STP:       return "NO_STP";
 286     case OFPUTIL_PC_NO_RECV:      return "NO_RECV";
 287     case OFPUTIL_PC_NO_RECV_STP:  return "NO_RECV_STP";
 288     case OFPUTIL_PC_NO_FLOOD:     return "NO_FLOOD";
 289     case OFPUTIL_PC_NO_FWD:       return "NO_FWD";
 290     case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
 291     }
 292
 293     return NULL;
 294 }
 295
 296 static void
 297 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
 298 {
 299     ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
 300     ds_put_char(string, '\n');
 301 }
 302
 303 static const char *
 304 ofputil_port_state_to_name(uint32_t bit)
 305 {
 306     enum ofputil_port_state ps = bit;
 307
 308     switch (ps) {
 309     case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
 310     case OFPUTIL_PS_BLOCKED:   return "BLOCKED";
 311     case OFPUTIL_PS_LIVE:      return "LIVE";
 312
 313     case OFPUTIL_PS_STP_LISTEN:
 314     case OFPUTIL_PS_STP_LEARN:
 315     case OFPUTIL_PS_STP_FORWARD:
 316     case OFPUTIL_PS_STP_BLOCK:
 317         /* Handled elsewhere. */
 318         return NULL;
 319     }
 320
 321     return NULL;
 322 }
 323
 324 static void
 325 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
 326 {
 327     enum ofputil_port_state stp_state;
 328
 329     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
 330      * pattern.  We have to special case it.
 331      *
 332      * OVS doesn't support STP, so this field will always be 0 if we are
 333      * talking to OVS, so we'd always print STP_LISTEN in that case.
 334      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
 335      * avoid confusing users. */
 336     stp_state = state & OFPUTIL_PS_STP_MASK;
 337     if (stp_state) {
 338         ds_put_cstr(string,
 339                     (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
 340                      : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
 341                      : "STP_BLOCK"));
 342         state &= ~OFPUTIL_PS_STP_MASK;
 343         if (state) {
 344             ofp_print_bit_names(string, state, ofputil_port_state_to_name,
 345                                 ' ');
 346         }
 347     } else {
 348         ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
 349     }
 350     ds_put_char(string, '\n');
 351 }
 352
 353 static void
 354 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
 355 {
 356     char name[sizeof port->name];
 357     int j;
 358
 359     memcpy(name, port->name, sizeof name);
 360     for (j = 0; j < sizeof name - 1; j++) {
 361         if (!isprint((unsigned char) name[j])) {
 362             break;
 363         }
 364     }
 365     name[j] = '\0';
 366
 367     ds_put_char(string, ' ');
 368     ofputil_format_port(port->port_no, string);
 369     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
 370                   name, ETH_ADDR_ARGS(port->hw_addr));
 371
 372     ds_put_cstr(string, "     config:     ");
 373     ofp_print_port_config(string, port->config);
 374
 375     ds_put_cstr(string, "     state:      ");
 376     ofp_print_port_state(string, port->state);
 377
 378     if (port->curr) {
 379         ds_put_format(string, "     current:    ");
 380         ofp_print_port_features(string, port->curr);
 381     }
 382     if (port->advertised) {
 383         ds_put_format(string, "     advertised: ");
 384         ofp_print_port_features(string, port->advertised);
 385     }
 386     if (port->supported) {
 387         ds_put_format(string, "     supported:  ");
 388         ofp_print_port_features(string, port->supported);
 389     }
 390     if (port->peer) {
 391         ds_put_format(string, "     peer:       ");
 392         ofp_print_port_features(string, port->peer);
 393     }
 394     ds_put_format(string, "     speed: %"PRIu32" Mbps now, "
 395                   "%"PRIu32" Mbps max\n",
 396                   port->curr_speed / UINT32_C(1000),
 397                   port->max_speed / UINT32_C(1000));
 398 }
 399
 400 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
 401  * 'ofp_version', writes a detailed description of each port into
 402  * 'string'. */
 403 static void
 404 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
 405                     struct ofpbuf *b)
 406 {
 407     size_t n_ports;
 408     struct ofputil_phy_port *ports;
 409     enum ofperr error;
 410     size_t i;
 411
 412     n_ports = ofputil_count_phy_ports(ofp_version, b);
 413
 414     ports = xmalloc(n_ports * sizeof *ports);
 415     for (i = 0; i < n_ports; i++) {
 416         error = ofputil_pull_phy_port(ofp_version, b, &ports[i]);
 417         if (error) {
 418             ofp_print_error(string, error);
 419             goto exit;
 420         }
 421     }
 422     qsort(ports, n_ports, sizeof *ports, compare_ports);
 423     for (i = 0; i < n_ports; i++) {
 424         ofp_print_phy_port(string, &ports[i]);
 425     }
 426
 427 exit:
 428     free(ports);
 429 }
 430
 431 static const char *
 432 ofputil_capabilities_to_name(uint32_t bit)
 433 {
 434     enum ofputil_capabilities capabilities = bit;
 435
 436     switch (capabilities) {
 437     case OFPUTIL_C_FLOW_STATS:   return "FLOW_STATS";
 438     case OFPUTIL_C_TABLE_STATS:  return "TABLE_STATS";
 439     case OFPUTIL_C_PORT_STATS:   return "PORT_STATS";
 440     case OFPUTIL_C_IP_REASM:     return "IP_REASM";
 441     case OFPUTIL_C_QUEUE_STATS:  return "QUEUE_STATS";
 442     case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
 443     case OFPUTIL_C_STP:          return "STP";
 444     case OFPUTIL_C_GROUP_STATS:  return "GROUP_STATS";
 445     case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
 446     }
 447
 448     return NULL;
 449 }
 450
 451 static const char *
 452 ofputil_action_bitmap_to_name(uint32_t bit)
 453 {
 454     enum ofputil_action_bitmap action = bit;
 455
 456     switch (action) {
 457     case OFPUTIL_A_OUTPUT:         return "OUTPUT";
 458     case OFPUTIL_A_SET_VLAN_VID:   return "SET_VLAN_VID";
 459     case OFPUTIL_A_SET_VLAN_PCP:   return "SET_VLAN_PCP";
 460     case OFPUTIL_A_STRIP_VLAN:     return "STRIP_VLAN";
 461     case OFPUTIL_A_SET_DL_SRC:     return "SET_DL_SRC";
 462     case OFPUTIL_A_SET_DL_DST:     return "SET_DL_DST";
 463     case OFPUTIL_A_SET_NW_SRC:     return "SET_NW_SRC";
 464     case OFPUTIL_A_SET_NW_DST:     return "SET_NW_DST";
 465     case OFPUTIL_A_SET_NW_ECN:     return "SET_NW_ECN";
 466     case OFPUTIL_A_SET_NW_TOS:     return "SET_NW_TOS";
 467     case OFPUTIL_A_SET_TP_SRC:     return "SET_TP_SRC";
 468     case OFPUTIL_A_SET_TP_DST:     return "SET_TP_DST";
 469     case OFPUTIL_A_ENQUEUE:        return "ENQUEUE";
 470     case OFPUTIL_A_COPY_TTL_OUT:   return "COPY_TTL_OUT";
 471     case OFPUTIL_A_COPY_TTL_IN:    return "COPY_TTL_IN";
 472     case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
 473     case OFPUTIL_A_SET_MPLS_TC:    return "SET_MPLS_TC";
 474     case OFPUTIL_A_SET_MPLS_TTL:   return "SET_MPLS_TTL";
 475     case OFPUTIL_A_DEC_MPLS_TTL:   return "DEC_MPLS_TTL";
 476     case OFPUTIL_A_PUSH_VLAN:      return "PUSH_VLAN";
 477     case OFPUTIL_A_POP_VLAN:       return "POP_VLAN";
 478     case OFPUTIL_A_PUSH_MPLS:      return "PUSH_MPLS";
 479     case OFPUTIL_A_POP_MPLS:       return "POP_MPLS";
 480     case OFPUTIL_A_SET_QUEUE:      return "SET_QUEUE";
 481     case OFPUTIL_A_GROUP:          return "GROUP";
 482     case OFPUTIL_A_SET_NW_TTL:     return "SET_NW_TTL";
 483     case OFPUTIL_A_DEC_NW_TTL:     return "DEC_NW_TTL";
 484     }
 485
 486     return NULL;
 487 }
 488
 489 static void
 490 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
 491 {
 492     struct ofputil_switch_features features;
 493     enum ofperr error;
 494     struct ofpbuf b;
 495
 496     error = ofputil_decode_switch_features(oh, &features, &b);
 497     if (error) {
 498         ofp_print_error(string, error);
 499         return;
 500     }
 501
 502     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
 503     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32"\n",
 504                   features.n_tables, features.n_buffers);
 505
 506     ds_put_cstr(string, "capabilities: ");
 507     ofp_print_bit_names(string, features.capabilities,
 508                         ofputil_capabilities_to_name, ' ');
 509     ds_put_char(string, '\n');
 510
 511     switch ((enum ofp_version)oh->version) {
 512     case OFP10_VERSION:
 513         ds_put_cstr(string, "actions: ");
 514         ofp_print_bit_names(string, features.actions,
 515                             ofputil_action_bitmap_to_name, ' ');
 516         ds_put_char(string, '\n');
 517         break;
 518     case OFP11_VERSION:
 519     case OFP12_VERSION:
 520         break;
 521     default:
 522         NOT_REACHED();
 523     }
 524
 525     ofp_print_phy_ports(string, oh->version, &b);
 526 }
 527
 528 static void
 529 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
 530 {
 531     enum ofp_config_flags flags;
 532
 533     flags = ntohs(osc->flags);
 534
 535     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
 536     flags &= ~OFPC_FRAG_MASK;
 537
 538     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
 539         ds_put_format(string, " invalid_ttl_to_controller");
 540         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
 541     }
 542
 543     if (flags) {
 544         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 545     }
 546
 547     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 548 }
 549
 550 static void print_wild(struct ds *string, const char *leader, int is_wild,
 551             int verbosity, const char *format, ...)
 552             __attribute__((format(printf, 5, 6)));
 553
 554 static void print_wild(struct ds *string, const char *leader, int is_wild,
 555                        int verbosity, const char *format, ...)
 556 {
 557     if (is_wild && verbosity < 2) {
 558         return;
 559     }
 560     ds_put_cstr(string, leader);
 561     if (!is_wild) {
 562         va_list args;
 563
 564         va_start(args, format);
 565         ds_put_format_valist(string, format, args);
 566         va_end(args);
 567     } else {
 568         ds_put_char(string, '*');
 569     }
 570     ds_put_char(string, ',');
 571 }
 572
 573 static void
 574 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
 575                  uint32_t wild_bits, int verbosity)
 576 {
 577     if (wild_bits >= 32 && verbosity < 2) {
 578         return;
 579     }
 580     ds_put_cstr(string, leader);
 581     if (wild_bits < 32) {
 582         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 583         if (wild_bits) {
 584             ds_put_format(string, "/%d", 32 - wild_bits);
 585         }
 586     } else {
 587         ds_put_char(string, '*');
 588     }
 589     ds_put_char(string, ',');
 590 }
 591
 592 void
 593 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
 594 {
 595     char *s = ofp10_match_to_string(om, verbosity);
 596     ds_put_cstr(f, s);
 597     free(s);
 598 }
 599
 600 char *
 601 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
 602 {
 603     struct ds f = DS_EMPTY_INITIALIZER;
 604     uint32_t w = ntohl(om->wildcards);
 605     bool skip_type = false;
 606     bool skip_proto = false;
 607
 608     if (!(w & OFPFW10_DL_TYPE)) {
 609         skip_type = true;
 610         if (om->dl_type == htons(ETH_TYPE_IP)) {
 611             if (!(w & OFPFW10_NW_PROTO)) {
 612                 skip_proto = true;
 613                 if (om->nw_proto == IPPROTO_ICMP) {
 614                     ds_put_cstr(&f, "icmp,");
 615                 } else if (om->nw_proto == IPPROTO_TCP) {
 616                     ds_put_cstr(&f, "tcp,");
 617                 } else if (om->nw_proto == IPPROTO_UDP) {
 618                     ds_put_cstr(&f, "udp,");
 619                 } else {
 620                     ds_put_cstr(&f, "ip,");
 621                     skip_proto = false;
 622                 }
 623             } else {
 624                 ds_put_cstr(&f, "ip,");
 625             }
 626         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 627             ds_put_cstr(&f, "arp,");
 628         } else {
 629             skip_type = false;
 630         }
 631     }
 632     print_wild(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
 633                "%d", ntohs(om->in_port));
 634     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
 635                "%d", ntohs(om->dl_vlan));
 636     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
 637                "%d", om->dl_vlan_pcp);
 638     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
 639                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 640     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
 641                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 642     if (!skip_type) {
 643         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
 644                    "0x%04x", ntohs(om->dl_type));
 645     }
 646     print_ip_netmask(&f, "nw_src=", om->nw_src,
 647                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
 648                      verbosity);
 649     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
 650                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
 651                      verbosity);
 652     if (!skip_proto) {
 653         if (om->dl_type == htons(ETH_TYPE_ARP)) {
 654             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
 655                        "%u", om->nw_proto);
 656         } else {
 657             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
 658                        "%u", om->nw_proto);
 659         }
 660     }
 661     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
 662                "%u", om->nw_tos);
 663     if (om->nw_proto == IPPROTO_ICMP) {
 664         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
 665                    "%d", ntohs(om->tp_src));
 666         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
 667                    "%d", ntohs(om->tp_dst));
 668     } else {
 669         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
 670                    "%d", ntohs(om->tp_src));
 671         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
 672                    "%d", ntohs(om->tp_dst));
 673     }
 674     if (ds_last(&f) == ',') {
 675         f.length--;
 676     }
 677     return ds_cstr(&f);
 678 }
 679
 680 static void
 681 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
 682 {
 683     struct ofputil_flow_mod fm;
 684     struct ofpbuf ofpacts;
 685     bool need_priority;
 686     enum ofperr error;
 687     enum ofpraw raw;
 688     enum ofputil_protocol protocol;
 689
 690     protocol = ofputil_protocol_from_ofp_version(oh->version);
 691     protocol = ofputil_protocol_set_tid(protocol, true);
 692
 693     ofpbuf_init(&ofpacts, 64);
 694     error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts);
 695     if (error) {
 696         ofpbuf_uninit(&ofpacts);
 697         ofp_print_error(s, error);
 698         return;
 699     }
 700
 701     ds_put_char(s, ' ');
 702     switch (fm.command) {
 703     case OFPFC_ADD:
 704         ds_put_cstr(s, "ADD");
 705         break;
 706     case OFPFC_MODIFY:
 707         ds_put_cstr(s, "MOD");
 708         break;
 709     case OFPFC_MODIFY_STRICT:
 710         ds_put_cstr(s, "MOD_STRICT");
 711         break;
 712     case OFPFC_DELETE:
 713         ds_put_cstr(s, "DEL");
 714         break;
 715     case OFPFC_DELETE_STRICT:
 716         ds_put_cstr(s, "DEL_STRICT");
 717         break;
 718     default:
 719         ds_put_format(s, "cmd:%d", fm.command);
 720     }
 721     if (fm.table_id != 0) {
 722         ds_put_format(s, " table:%d", fm.table_id);
 723     }
 724
 725     ds_put_char(s, ' ');
 726     ofpraw_decode(&raw, oh);
 727     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
 728         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
 729         ofp10_match_print(s, &ofm->match, verbosity);
 730
 731         /* ofp_print_match() doesn't print priority. */
 732         need_priority = true;
 733     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
 734         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
 735         const void *nxm = nfm + 1;
 736         char *nxm_s;
 737
 738         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 739         ds_put_cstr(s, nxm_s);
 740         free(nxm_s);
 741
 742         /* nx_match_to_string() doesn't print priority. */
 743         need_priority = true;
 744     } else {
 745         cls_rule_format(&fm.cr, s);
 746
 747         /* cls_rule_format() does print priority. */
 748         need_priority = false;
 749     }
 750
 751     if (ds_last(s) != ' ') {
 752         ds_put_char(s, ' ');
 753     }
 754     if (fm.new_cookie != htonll(0)) {
 755         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
 756     }
 757     if (fm.cookie_mask != htonll(0)) {
 758         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
 759                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
 760     }
 761     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 762         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 763     }
 764     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 765         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 766     }
 767     if (fm.cr.priority != OFP_DEFAULT_PRIORITY && need_priority) {
 768         ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
 769     }
 770     if (fm.buffer_id != UINT32_MAX) {
 771         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 772     }
 773     if (fm.out_port != OFPP_NONE) {
 774         ds_put_format(s, "out_port:");
 775         ofputil_format_port(fm.out_port, s);
 776         ds_put_char(s, ' ');
 777     }
 778     if (fm.flags != 0) {
 779         uint16_t flags = fm.flags;
 780
 781         if (flags & OFPFF_SEND_FLOW_REM) {
 782             ds_put_cstr(s, "send_flow_rem ");
 783         }
 784         if (flags & OFPFF_CHECK_OVERLAP) {
 785             ds_put_cstr(s, "check_overlap ");
 786         }
 787         if (flags & OFPFF10_EMERG) {
 788             ds_put_cstr(s, "emerg ");
 789         }
 790
 791         flags &= ~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF10_EMERG);
 792         if (flags) {
 793             ds_put_format(s, "flags:0x%"PRIx16" ", flags);
 794         }
 795     }
 796
 797     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
 798     ofpbuf_uninit(&ofpacts);
 799 }
 800
 801 static void
 802 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 803 {
 804     ds_put_format(string, "%u", sec);
 805     if (nsec > 0) {
 806         ds_put_format(string, ".%09u", nsec);
 807         while (string->string[string->length - 1] == '0') {
 808             string->length--;
 809         }
 810     }
 811     ds_put_char(string, 's');
 812 }
 813
 814 static const char *
 815 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason)
 816 {
 817     static char s[32];
 818
 819     switch (reason) {
 820     case OFPRR_IDLE_TIMEOUT:
 821         return "idle";
 822     case OFPRR_HARD_TIMEOUT:
 823         return "hard";
 824     case OFPRR_DELETE:
 825         return "delete";
 826     case OFPRR_GROUP_DELETE:
 827         return "group_delete";
 828     case OFPRR_EVICTION:
 829         return "eviction";
 830     default:
 831         sprintf(s, "%d", (int) reason);
 832         return s;
 833     }
 834 }
 835
 836 static void
 837 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 838 {
 839     struct ofputil_flow_removed fr;
 840     enum ofperr error;
 841
 842     error = ofputil_decode_flow_removed(&fr, oh);
 843     if (error) {
 844         ofp_print_error(string, error);
 845         return;
 846     }
 847
 848     ds_put_char(string, ' ');
 849     cls_rule_format(&fr.rule, string);
 850
 851     ds_put_format(string, " reason=%s",
 852                   ofp_flow_removed_reason_to_string(fr.reason));
 853
 854     if (fr.cookie != htonll(0)) {
 855         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 856     }
 857     ds_put_cstr(string, " duration");
 858     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 859     ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
 860     if (fr.hard_timeout) {
 861         /* The hard timeout was only added in OF1.2, so only print it if it is
 862          * actually in use to avoid gratuitous change to the formatting. */
 863         ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
 864     }
 865     ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
 866                   fr.packet_count, fr.byte_count);
 867 }
 868
 869 static void
 870 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
 871 {
 872     struct ofputil_port_mod pm;
 873     enum ofperr error;
 874
 875     error = ofputil_decode_port_mod(oh, &pm);
 876     if (error) {
 877         ofp_print_error(string, error);
 878         return;
 879     }
 880
 881     ds_put_format(string, "port: %"PRIu16": addr:"ETH_ADDR_FMT"\n",
 882                   pm.port_no, ETH_ADDR_ARGS(pm.hw_addr));
 883
 884     ds_put_format(string, "     config: ");
 885     ofp_print_port_config(string, pm.config);
 886
 887     ds_put_format(string, "     mask:   ");
 888     ofp_print_port_config(string, pm.mask);
 889
 890     ds_put_format(string, "     advertise: ");
 891     if (pm.advertise) {
 892         ofp_print_port_features(string, pm.advertise);
 893     } else {
 894         ds_put_format(string, "UNCHANGED\n");
 895     }
 896 }
 897
 898 static void
 899 ofp_print_error(struct ds *string, enum ofperr error)
 900 {
 901     if (string->length) {
 902         ds_put_char(string, ' ');
 903     }
 904     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
 905 }
 906
 907 static void
 908 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
 909 {
 910     size_t len = ntohs(oh->length);
 911     struct ofpbuf payload;
 912     enum ofperr error;
 913     char *s;
 914
 915     error = ofperr_decode_msg(oh, &payload);
 916     if (!error) {
 917         ds_put_cstr(string, "***decode error***");
 918         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
 919         return;
 920     }
 921
 922     ds_put_format(string, " %s\n", ofperr_get_name(error));
 923
 924     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
 925         ds_put_printable(string, payload.data, payload.size);
 926     } else {
 927         s = ofp_to_string(payload.data, payload.size, 1);
 928         ds_put_cstr(string, s);
 929         free(s);
 930     }
 931 }
 932
 933 static void
 934 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
 935 {
 936     struct ofputil_port_status ps;
 937     enum ofperr error;
 938
 939     error = ofputil_decode_port_status(oh, &ps);
 940     if (error) {
 941         ofp_print_error(string, error);
 942         return;
 943     }
 944
 945     if (ps.reason == OFPPR_ADD) {
 946         ds_put_format(string, " ADD:");
 947     } else if (ps.reason == OFPPR_DELETE) {
 948         ds_put_format(string, " DEL:");
 949     } else if (ps.reason == OFPPR_MODIFY) {
 950         ds_put_format(string, " MOD:");
 951     }
 952
 953     ofp_print_phy_port(string, &ps.desc);
 954 }
 955
 956 static void
 957 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
 958 {
 959     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
 960
 961     ds_put_char(string, '\n');
 962     ds_put_format(string, "Manufacturer: %.*s\n",
 963             (int) sizeof ods->mfr_desc, ods->mfr_desc);
 964     ds_put_format(string, "Hardware: %.*s\n",
 965             (int) sizeof ods->hw_desc, ods->hw_desc);
 966     ds_put_format(string, "Software: %.*s\n",
 967             (int) sizeof ods->sw_desc, ods->sw_desc);
 968     ds_put_format(string, "Serial Num: %.*s\n",
 969             (int) sizeof ods->serial_num, ods->serial_num);
 970     ds_put_format(string, "DP Description: %.*s\n",
 971             (int) sizeof ods->dp_desc, ods->dp_desc);
 972 }
 973
 974 static void
 975 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
 976 {
 977     struct ofputil_flow_stats_request fsr;
 978     enum ofperr error;
 979
 980     error = ofputil_decode_flow_stats_request(&fsr, oh);
 981     if (error) {
 982         ofp_print_error(string, error);
 983         return;
 984     }
 985
 986     if (fsr.table_id != 0xff) {
 987         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
 988     }
 989
 990     if (fsr.out_port != OFPP_NONE) {
 991         ds_put_cstr(string, " out_port=");
 992         ofputil_format_port(fsr.out_port, string);
 993     }
 994
 995     /* A flow stats request doesn't include a priority, but cls_rule_format()
 996      * will print one unless it is OFP_DEFAULT_PRIORITY. */
 997     fsr.match.priority = OFP_DEFAULT_PRIORITY;
 998
 999     ds_put_char(string, ' ');
1000     cls_rule_format(&fsr.match, string);
1001 }
1002
1003 void
1004 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1005 {
1006     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1007                   ntohll(fs->cookie));
1008
1009     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1010     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1011     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1012     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1013     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1014         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1015     }
1016     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1017         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1018     }
1019     if (fs->idle_age >= 0) {
1020         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1021     }
1022     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1023         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1024     }
1025
1026     cls_rule_format(&fs->rule, string);
1027     if (string->string[string->length - 1] != ' ') {
1028         ds_put_char(string, ' ');
1029     }
1030
1031     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1032 }
1033
1034 static void
1035 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1036 {
1037     struct ofpbuf ofpacts;
1038     struct ofpbuf b;
1039
1040     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1041     ofpbuf_init(&ofpacts, 64);
1042     for (;;) {
1043         struct ofputil_flow_stats fs;
1044         int retval;
1045
1046         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1047         if (retval) {
1048             if (retval != EOF) {
1049                 ds_put_cstr(string, " ***parse error***");
1050             }
1051             break;
1052         }
1053         ds_put_char(string, '\n');
1054         ofp_print_flow_stats(string, &fs);
1055      }
1056 }
1057
1058 static void
1059 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1060 {
1061     struct ofputil_aggregate_stats as;
1062     enum ofperr error;
1063
1064     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1065     if (error) {
1066         ofp_print_error(string, error);
1067         return;
1068     }
1069
1070     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1071     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1072     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1073 }
1074
1075 static void print_port_stat(struct ds *string, const char *leader,
1076                             const ovs_32aligned_be64 *statp, int more)
1077 {
1078     uint64_t stat = ntohll(get_32aligned_be64(statp));
1079
1080     ds_put_cstr(string, leader);
1081     if (stat != UINT64_MAX) {
1082         ds_put_format(string, "%"PRIu64, stat);
1083     } else {
1084         ds_put_char(string, '?');
1085     }
1086     if (more) {
1087         ds_put_cstr(string, ", ");
1088     } else {
1089         ds_put_cstr(string, "\n");
1090     }
1091 }
1092
1093 static void
1094 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1095 {
1096     const struct ofp10_port_stats_request *psr = ofpmsg_body(oh);
1097     ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1098 }
1099
1100 static void
1101 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1102                            int verbosity)
1103 {
1104     struct ofp10_port_stats *ps;
1105     struct ofpbuf b;
1106     size_t n;
1107
1108     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1109     ofpraw_pull_assert(&b);
1110
1111     n = b.size / sizeof *ps;
1112     ds_put_format(string, " %zu ports\n", n);
1113     if (verbosity < 1) {
1114         return;
1115     }
1116
1117     for (;;) {
1118         ps = ofpbuf_try_pull(&b, sizeof *ps);
1119         if (!ps) {
1120             return;
1121         }
1122
1123         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
1124
1125         ds_put_cstr(string, "rx ");
1126         print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1127         print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1128         print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1129         print_port_stat(string, "errs=", &ps->rx_errors, 1);
1130         print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1131         print_port_stat(string, "over=", &ps->rx_over_err, 1);
1132         print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1133
1134         ds_put_cstr(string, "           tx ");
1135         print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1136         print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1137         print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1138         print_port_stat(string, "errs=", &ps->tx_errors, 1);
1139         print_port_stat(string, "coll=", &ps->collisions, 0);
1140     }
1141 }
1142
1143 static void
1144 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1145                             int verbosity)
1146 {
1147     struct ofp10_table_stats *ts;
1148     struct ofpbuf b;
1149     size_t n;
1150
1151     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1152     ofpraw_pull_assert(&b);
1153
1154     n = b.size / sizeof *ts;
1155     ds_put_format(string, " %zu tables\n", n);
1156     if (verbosity < 1) {
1157         return;
1158     }
1159
1160     for (;;) {
1161         char name[OFP_MAX_TABLE_NAME_LEN + 1];
1162
1163         ts = ofpbuf_try_pull(&b, sizeof *ts);
1164         if (!ts) {
1165             return;
1166         }
1167
1168         ovs_strlcpy(name, ts->name, sizeof name);
1169
1170         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
1171         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1172         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1173         ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1174         ds_put_cstr(string, "               ");
1175         ds_put_format(string, "lookup=%"PRIu64", ",
1176                       ntohll(get_32aligned_be64(&ts->lookup_count)));
1177         ds_put_format(string, "matched=%"PRIu64"\n",
1178                       ntohll(get_32aligned_be64(&ts->matched_count)));
1179      }
1180 }
1181
1182 static void
1183 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1184 {
1185     if (queue_id == OFPQ_ALL) {
1186         ds_put_cstr(string, "ALL");
1187     } else {
1188         ds_put_format(string, "%"PRIu32, queue_id);
1189     }
1190 }
1191
1192 static void
1193 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1194 {
1195     const struct ofp10_queue_stats_request *qsr = ofpmsg_body(oh);
1196
1197     ds_put_cstr(string, "port=");
1198     ofputil_format_port(ntohs(qsr->port_no), string);
1199
1200     ds_put_cstr(string, " queue=");
1201     ofp_print_queue_name(string, ntohl(qsr->queue_id));
1202 }
1203
1204 static void
1205 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1206                             int verbosity)
1207 {
1208     struct ofp10_queue_stats *qs;
1209     struct ofpbuf b;
1210     size_t n;
1211
1212     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1213     ofpraw_pull_assert(&b);
1214
1215     n = b.size / sizeof *qs;
1216     ds_put_format(string, " %zu queues\n", n);
1217     if (verbosity < 1) {
1218         return;
1219     }
1220
1221     for (;;) {
1222         qs = ofpbuf_try_pull(&b, sizeof *qs);
1223         if (!qs) {
1224             return;
1225         }
1226
1227         ds_put_cstr(string, "  port ");
1228         ofputil_format_port(ntohs(qs->port_no), string);
1229         ds_put_cstr(string, " queue ");
1230         ofp_print_queue_name(string, ntohl(qs->queue_id));
1231         ds_put_cstr(string, ": ");
1232
1233         print_port_stat(string, "bytes=", &qs->tx_bytes, 1);
1234         print_port_stat(string, "pkts=", &qs->tx_packets, 1);
1235         print_port_stat(string, "errors=", &qs->tx_errors, 0);
1236     }
1237 }
1238
1239 static void
1240 ofp_print_ofpst_port_desc_reply(struct ds *string,
1241                                 const struct ofp_header *oh)
1242 {
1243     struct ofpbuf b;
1244
1245     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1246     ofpraw_pull_assert(&b);
1247     ds_put_char(string, '\n');
1248     ofp_print_phy_ports(string, oh->version, &b);
1249 }
1250
1251 static void
1252 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1253 {
1254     uint16_t flags = ofpmp_flags(oh);
1255
1256     if (flags) {
1257         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1258     }
1259 }
1260
1261 static void
1262 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1263 {
1264     uint16_t flags = ofpmp_flags(oh);
1265
1266     if (flags) {
1267         ds_put_cstr(string, " flags=");
1268         if (flags & OFPSF_REPLY_MORE) {
1269             ds_put_cstr(string, "[more]");
1270             flags &= ~OFPSF_REPLY_MORE;
1271         }
1272         if (flags) {
1273             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1274                           flags);
1275         }
1276     }
1277 }
1278
1279 static void
1280 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1281 {
1282     size_t len = ntohs(oh->length);
1283
1284     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1285     if (verbosity > 1) {
1286         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1287     }
1288 }
1289
1290 static void
1291 ofp_print_nxt_role_message(struct ds *string,
1292                            const struct nx_role_request *nrr)
1293 {
1294     unsigned int role = ntohl(nrr->role);
1295
1296     ds_put_cstr(string, " role=");
1297     if (role == NX_ROLE_OTHER) {
1298         ds_put_cstr(string, "other");
1299     } else if (role == NX_ROLE_MASTER) {
1300         ds_put_cstr(string, "master");
1301     } else if (role == NX_ROLE_SLAVE) {
1302         ds_put_cstr(string, "slave");
1303     } else {
1304         ds_put_format(string, "%u", role);
1305     }
1306 }
1307
1308 static void
1309 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1310                                 const struct nx_flow_mod_table_id *nfmti)
1311 {
1312     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1313 }
1314
1315 static void
1316 ofp_print_nxt_set_flow_format(struct ds *string,
1317                               const struct nx_set_flow_format *nsff)
1318 {
1319     uint32_t format = ntohl(nsff->format);
1320
1321     ds_put_cstr(string, " format=");
1322     if (ofputil_nx_flow_format_is_valid(format)) {
1323         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1324     } else {
1325         ds_put_format(string, "%"PRIu32, format);
1326     }
1327 }
1328
1329 static void
1330 ofp_print_nxt_set_packet_in_format(struct ds *string,
1331                                    const struct nx_set_packet_in_format *nspf)
1332 {
1333     uint32_t format = ntohl(nspf->format);
1334
1335     ds_put_cstr(string, " format=");
1336     if (ofputil_packet_in_format_is_valid(format)) {
1337         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1338     } else {
1339         ds_put_format(string, "%"PRIu32, format);
1340     }
1341 }
1342
1343 static const char *
1344 ofp_port_reason_to_string(enum ofp_port_reason reason)
1345 {
1346     static char s[32];
1347
1348     switch (reason) {
1349     case OFPPR_ADD:
1350         return "add";
1351
1352     case OFPPR_DELETE:
1353         return "delete";
1354
1355     case OFPPR_MODIFY:
1356         return "modify";
1357
1358     default:
1359         sprintf(s, "%d", (int) reason);
1360         return s;
1361     }
1362 }
1363
1364 static void
1365 ofp_print_nxt_set_async_config(struct ds *string,
1366                                const struct nx_async_config *nac)
1367 {
1368     int i;
1369
1370     for (i = 0; i < 2; i++) {
1371         int j;
1372
1373         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1374
1375         ds_put_cstr(string, "       PACKET_IN:");
1376         for (j = 0; j < 32; j++) {
1377             if (nac->packet_in_mask[i] & htonl(1u << j)) {
1378                 ds_put_format(string, " %s",
1379                               ofputil_packet_in_reason_to_string(j));
1380             }
1381         }
1382         if (!nac->packet_in_mask[i]) {
1383             ds_put_cstr(string, " (off)");
1384         }
1385         ds_put_char(string, '\n');
1386
1387         ds_put_cstr(string, "     PORT_STATUS:");
1388         for (j = 0; j < 32; j++) {
1389             if (nac->port_status_mask[i] & htonl(1u << j)) {
1390                 ds_put_format(string, " %s", ofp_port_reason_to_string(j));
1391             }
1392         }
1393         if (!nac->port_status_mask[i]) {
1394             ds_put_cstr(string, " (off)");
1395         }
1396         ds_put_char(string, '\n');
1397
1398         ds_put_cstr(string, "    FLOW_REMOVED:");
1399         for (j = 0; j < 32; j++) {
1400             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1401                 ds_put_format(string, " %s",
1402                               ofp_flow_removed_reason_to_string(j));
1403             }
1404         }
1405         if (!nac->flow_removed_mask[i]) {
1406             ds_put_cstr(string, " (off)");
1407         }
1408         ds_put_char(string, '\n');
1409     }
1410 }
1411
1412 static void
1413 ofp_print_nxt_set_controller_id(struct ds *string,
1414                                 const struct nx_controller_id *nci)
1415 {
1416     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1417 }
1418
1419 static void
1420 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1421                                   const struct ofp_header *oh)
1422 {
1423     ds_put_format(string, " id=%"PRIu32,
1424                   ofputil_decode_flow_monitor_cancel(oh));
1425 }
1426
1427 static const char *
1428 nx_flow_monitor_flags_to_name(uint32_t bit)
1429 {
1430     enum nx_flow_monitor_flags fmf = bit;
1431
1432     switch (fmf) {
1433     case NXFMF_INITIAL: return "initial";
1434     case NXFMF_ADD: return "add";
1435     case NXFMF_DELETE: return "delete";
1436     case NXFMF_MODIFY: return "modify";
1437     case NXFMF_ACTIONS: return "actions";
1438     case NXFMF_OWN: return "own";
1439     }
1440
1441     return NULL;
1442 }
1443
1444 static void
1445 ofp_print_nxst_flow_monitor_request(struct ds *string,
1446                                     const struct ofp_header *oh)
1447 {
1448     struct ofpbuf b;
1449
1450     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1451     for (;;) {
1452         struct ofputil_flow_monitor_request request;
1453         int retval;
1454
1455         retval = ofputil_decode_flow_monitor_request(&request, &b);
1456         if (retval) {
1457             if (retval != EOF) {
1458                 ofp_print_error(string, retval);
1459             }
1460             return;
1461         }
1462
1463         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
1464         ofp_print_bit_names(string, request.flags,
1465                             nx_flow_monitor_flags_to_name, ',');
1466
1467         if (request.out_port != OFPP_NONE) {
1468             ds_put_cstr(string, " out_port=");
1469             ofputil_format_port(request.out_port, string);
1470         }
1471
1472         if (request.table_id != 0xff) {
1473             ds_put_format(string, " table=%"PRIu8, request.table_id);
1474         }
1475
1476         ds_put_char(string, ' ');
1477         cls_rule_format(&request.match, string);
1478         ds_chomp(string, ' ');
1479     }
1480 }
1481
1482 static void
1483 ofp_print_nxst_flow_monitor_reply(struct ds *string,
1484                                   const struct ofp_header *oh)
1485 {
1486     uint64_t ofpacts_stub[1024 / 8];
1487     struct ofpbuf ofpacts;
1488     struct ofpbuf b;
1489
1490     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1491     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1492     for (;;) {
1493         struct ofputil_flow_update update;
1494         struct cls_rule match;
1495         int retval;
1496
1497         update.match = &match;
1498         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
1499         if (retval) {
1500             if (retval != EOF) {
1501                 ofp_print_error(string, retval);
1502             }
1503             ofpbuf_uninit(&ofpacts);
1504             return;
1505         }
1506
1507         ds_put_cstr(string, "\n event=");
1508         switch (update.event) {
1509         case NXFME_ADDED:
1510             ds_put_cstr(string, "ADDED");
1511             break;
1512
1513         case NXFME_DELETED:
1514             ds_put_format(string, "DELETED reason=%s",
1515                           ofp_flow_removed_reason_to_string(update.reason));
1516             break;
1517
1518         case NXFME_MODIFIED:
1519             ds_put_cstr(string, "MODIFIED");
1520             break;
1521
1522         case NXFME_ABBREV:
1523             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
1524             continue;
1525         }
1526
1527         ds_put_format(string, " table=%"PRIu8, update.table_id);
1528         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
1529             ds_put_format(string, " idle_timeout=%"PRIu16,
1530                           update.idle_timeout);
1531         }
1532         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
1533             ds_put_format(string, " hard_timeout=%"PRIu16,
1534                           update.hard_timeout);
1535         }
1536         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
1537
1538         ds_put_char(string, ' ');
1539         cls_rule_format(update.match, string);
1540
1541         if (update.ofpacts_len) {
1542             if (string->string[string->length - 1] != ' ') {
1543                 ds_put_char(string, ' ');
1544             }
1545             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
1546         }
1547     }
1548 }
1549
1550 void
1551 ofp_print_version(const struct ofp_header *oh,
1552                   struct ds *string)
1553 {
1554     switch (oh->version) {
1555     case OFP10_VERSION:
1556         break;
1557     case OFP11_VERSION:
1558         ds_put_cstr(string, " (OF1.1)");
1559         break;
1560     case OFP12_VERSION:
1561         ds_put_cstr(string, " (OF1.2)");
1562         break;
1563     default:
1564         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
1565         break;
1566     }
1567     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
1568 }
1569
1570 static void
1571 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1572                        struct ds *string)
1573 {
1574     ds_put_cstr(string, ofpraw_get_name(raw));
1575     ofp_print_version(oh, string);
1576 }
1577
1578 static void
1579 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1580                 struct ds *string, int verbosity)
1581 {
1582     const void *msg = oh;
1583
1584     ofp_header_to_string__(oh, raw, string);
1585     switch (ofptype_from_ofpraw(raw)) {
1586     case OFPTYPE_HELLO:
1587         ds_put_char(string, '\n');
1588         ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1589                         0, true);
1590         break;
1591
1592     case OFPTYPE_ERROR:
1593         ofp_print_error_msg(string, oh);
1594         break;
1595
1596     case OFPTYPE_ECHO_REQUEST:
1597     case OFPTYPE_ECHO_REPLY:
1598         ofp_print_echo(string, oh, verbosity);
1599         break;
1600
1601     case OFPTYPE_FEATURES_REQUEST:
1602         break;
1603
1604     case OFPTYPE_FEATURES_REPLY:
1605         ofp_print_switch_features(string, oh);
1606         break;
1607
1608     case OFPTYPE_GET_CONFIG_REQUEST:
1609         break;
1610
1611     case OFPTYPE_GET_CONFIG_REPLY:
1612     case OFPTYPE_SET_CONFIG:
1613         ofp_print_switch_config(string, ofpmsg_body(oh));
1614         break;
1615
1616     case OFPTYPE_PACKET_IN:
1617         ofp_print_packet_in(string, oh, verbosity);
1618         break;
1619
1620     case OFPTYPE_FLOW_REMOVED:
1621         ofp_print_flow_removed(string, oh);
1622         break;
1623
1624     case OFPTYPE_PORT_STATUS:
1625         ofp_print_port_status(string, oh);
1626         break;
1627
1628     case OFPTYPE_PACKET_OUT:
1629         ofp_print_packet_out(string, oh, verbosity);
1630         break;
1631
1632     case OFPTYPE_FLOW_MOD:
1633         ofp_print_flow_mod(string, oh, verbosity);
1634         break;
1635
1636     case OFPTYPE_PORT_MOD:
1637         ofp_print_port_mod(string, oh);
1638         break;
1639
1640     case OFPTYPE_BARRIER_REQUEST:
1641     case OFPTYPE_BARRIER_REPLY:
1642         break;
1643
1644     case OFPTYPE_DESC_STATS_REQUEST:
1645     case OFPTYPE_PORT_DESC_STATS_REQUEST:
1646         ofp_print_stats_request(string, oh);
1647         break;
1648
1649     case OFPTYPE_FLOW_STATS_REQUEST:
1650     case OFPTYPE_AGGREGATE_STATS_REQUEST:
1651         ofp_print_stats_request(string, oh);
1652         ofp_print_flow_stats_request(string, oh);
1653         break;
1654
1655     case OFPTYPE_TABLE_STATS_REQUEST:
1656         ofp_print_stats_request(string, oh);
1657         break;
1658
1659     case OFPTYPE_PORT_STATS_REQUEST:
1660         ofp_print_stats_request(string, oh);
1661         ofp_print_ofpst_port_request(string, oh);
1662         break;
1663
1664     case OFPTYPE_QUEUE_STATS_REQUEST:
1665         ofp_print_stats_request(string, oh);
1666         ofp_print_ofpst_queue_request(string, oh);
1667         break;
1668
1669     case OFPTYPE_DESC_STATS_REPLY:
1670         ofp_print_stats_reply(string, oh);
1671         ofp_print_ofpst_desc_reply(string, oh);
1672         break;
1673
1674     case OFPTYPE_FLOW_STATS_REPLY:
1675         ofp_print_stats_reply(string, oh);
1676         ofp_print_flow_stats_reply(string, oh);
1677         break;
1678
1679     case OFPTYPE_QUEUE_STATS_REPLY:
1680         ofp_print_stats_reply(string, oh);
1681         ofp_print_ofpst_queue_reply(string, oh, verbosity);
1682         break;
1683
1684     case OFPTYPE_PORT_STATS_REPLY:
1685         ofp_print_stats_reply(string, oh);
1686         ofp_print_ofpst_port_reply(string, oh, verbosity);
1687         break;
1688
1689     case OFPTYPE_TABLE_STATS_REPLY:
1690         ofp_print_stats_reply(string, oh);
1691         ofp_print_ofpst_table_reply(string, oh, verbosity);
1692         break;
1693
1694     case OFPTYPE_AGGREGATE_STATS_REPLY:
1695         ofp_print_stats_reply(string, oh);
1696         ofp_print_aggregate_stats_reply(string, oh);
1697         break;
1698
1699     case OFPTYPE_PORT_DESC_STATS_REPLY:
1700         ofp_print_stats_reply(string, oh);
1701         ofp_print_ofpst_port_desc_reply(string, oh);
1702         break;
1703
1704     case OFPTYPE_ROLE_REQUEST:
1705     case OFPTYPE_ROLE_REPLY:
1706         ofp_print_nxt_role_message(string, ofpmsg_body(oh));
1707         break;
1708
1709     case OFPTYPE_FLOW_MOD_TABLE_ID:
1710         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
1711         break;
1712
1713     case OFPTYPE_SET_FLOW_FORMAT:
1714         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
1715         break;
1716
1717     case OFPTYPE_SET_PACKET_IN_FORMAT:
1718         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
1719         break;
1720
1721     case OFPTYPE_FLOW_AGE:
1722         break;
1723
1724     case OFPTYPE_SET_CONTROLLER_ID:
1725         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
1726         break;
1727
1728     case OFPTYPE_SET_ASYNC_CONFIG:
1729         ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
1730         break;
1731
1732     case OFPTYPE_FLOW_MONITOR_CANCEL:
1733         ofp_print_nxt_flow_monitor_cancel(string, msg);
1734         break;
1735
1736     case OFPTYPE_FLOW_MONITOR_PAUSED:
1737     case OFPTYPE_FLOW_MONITOR_RESUMED:
1738         break;
1739
1740     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1741         ofp_print_nxst_flow_monitor_request(string, msg);
1742         break;
1743
1744     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1745         ofp_print_nxst_flow_monitor_reply(string, msg);
1746         break;
1747     }
1748 }
1749
1750 /* Composes and returns a string representing the OpenFlow packet of 'len'
1751  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1752  * verbosity and higher numbers increase verbosity.  The caller is responsible
1753  * for freeing the string. */
1754 char *
1755 ofp_to_string(const void *oh_, size_t len, int verbosity)
1756 {
1757     struct ds string = DS_EMPTY_INITIALIZER;
1758     const struct ofp_header *oh = oh_;
1759
1760     if (!len) {
1761         ds_put_cstr(&string, "OpenFlow message is empty\n");
1762     } else if (len < sizeof(struct ofp_header)) {
1763         ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1764                       len);
1765     } else if (ntohs(oh->length) > len) {
1766         enum ofperr error;
1767         enum ofpraw raw;
1768
1769         error = ofpraw_decode_partial(&raw, oh, len);
1770         if (!error) {
1771             ofp_header_to_string__(oh, raw, &string);
1772             ds_put_char(&string, '\n');
1773         }
1774
1775         ds_put_format(&string,
1776                       "(***truncated to %zu bytes from %"PRIu16"***)\n",
1777                       len, ntohs(oh->length));
1778     } else if (ntohs(oh->length) < len) {
1779         ds_put_format(&string,
1780                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
1781                       ntohs(oh->length), len);
1782     } else {
1783         enum ofperr error;
1784         enum ofpraw raw;
1785
1786         error = ofpraw_decode(&raw, oh);
1787         if (!error) {
1788             ofp_to_string__(oh, raw, &string, verbosity);
1789             if (verbosity >= 5) {
1790                 if (ds_last(&string) != '\n') {
1791                     ds_put_char(&string, '\n');
1792                 }
1793                 ds_put_hex_dump(&string, oh, len, 0, true);
1794             }
1795             if (ds_last(&string) != '\n') {
1796                 ds_put_char(&string, '\n');
1797             }
1798             return ds_steal_cstr(&string);
1799         }
1800
1801         ofp_print_error(&string, error);
1802     }
1803     ds_put_hex_dump(&string, oh, len, 0, true);
1804     return ds_steal_cstr(&string);
1805 }
1806 \f
1807 static void
1808 print_and_free(FILE *stream, char *string)
1809 {
1810     fputs(string, stream);
1811     free(string);
1812 }
1813
1814 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1815  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1816  * numbers increase verbosity. */
1817 void
1818 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1819 {
1820     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1821 }
1822
1823 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1824  * 'data' to 'stream'. */
1825 void
1826 ofp_print_packet(FILE *stream, const void *data, size_t len)
1827 {
1828     print_and_free(stream, ofp_packet_to_string(data, len));
1829 }