pintos-os.org Git - openvswitch/blob - 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     }
 446
 447     return NULL;
 448 }
 449
 450 static const char *
 451 ofputil_action_bitmap_to_name(uint32_t bit)
 452 {
 453     enum ofputil_action_bitmap action = bit;
 454
 455     switch (action) {
 456     case OFPUTIL_A_OUTPUT:         return "OUTPUT";
 457     case OFPUTIL_A_SET_VLAN_VID:   return "SET_VLAN_VID";
 458     case OFPUTIL_A_SET_VLAN_PCP:   return "SET_VLAN_PCP";
 459     case OFPUTIL_A_STRIP_VLAN:     return "STRIP_VLAN";
 460     case OFPUTIL_A_SET_DL_SRC:     return "SET_DL_SRC";
 461     case OFPUTIL_A_SET_DL_DST:     return "SET_DL_DST";
 462     case OFPUTIL_A_SET_NW_SRC:     return "SET_NW_SRC";
 463     case OFPUTIL_A_SET_NW_DST:     return "SET_NW_DST";
 464     case OFPUTIL_A_SET_NW_ECN:     return "SET_NW_ECN";
 465     case OFPUTIL_A_SET_NW_TOS:     return "SET_NW_TOS";
 466     case OFPUTIL_A_SET_TP_SRC:     return "SET_TP_SRC";
 467     case OFPUTIL_A_SET_TP_DST:     return "SET_TP_DST";
 468     case OFPUTIL_A_ENQUEUE:        return "ENQUEUE";
 469     case OFPUTIL_A_COPY_TTL_OUT:   return "COPY_TTL_OUT";
 470     case OFPUTIL_A_COPY_TTL_IN:    return "COPY_TTL_IN";
 471     case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
 472     case OFPUTIL_A_SET_MPLS_TC:    return "SET_MPLS_TC";
 473     case OFPUTIL_A_SET_MPLS_TTL:   return "SET_MPLS_TTL";
 474     case OFPUTIL_A_DEC_MPLS_TTL:   return "DEC_MPLS_TTL";
 475     case OFPUTIL_A_PUSH_VLAN:      return "PUSH_VLAN";
 476     case OFPUTIL_A_POP_VLAN:       return "POP_VLAN";
 477     case OFPUTIL_A_PUSH_MPLS:      return "PUSH_MPLS";
 478     case OFPUTIL_A_POP_MPLS:       return "POP_MPLS";
 479     case OFPUTIL_A_SET_QUEUE:      return "SET_QUEUE";
 480     case OFPUTIL_A_GROUP:          return "GROUP";
 481     case OFPUTIL_A_SET_NW_TTL:     return "SET_NW_TTL";
 482     case OFPUTIL_A_DEC_NW_TTL:     return "DEC_NW_TTL";
 483     }
 484
 485     return NULL;
 486 }
 487
 488 static void
 489 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
 490 {
 491     struct ofputil_switch_features features;
 492     enum ofperr error;
 493     struct ofpbuf b;
 494
 495     error = ofputil_decode_switch_features(oh, &features, &b);
 496     if (error) {
 497         ofp_print_error(string, error);
 498         return;
 499     }
 500
 501     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
 502     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32"\n",
 503                   features.n_tables, features.n_buffers);
 504
 505     ds_put_cstr(string, "capabilities: ");
 506     ofp_print_bit_names(string, features.capabilities,
 507                         ofputil_capabilities_to_name, ' ');
 508     ds_put_char(string, '\n');
 509
 510     ds_put_cstr(string, "actions: ");
 511     ofp_print_bit_names(string, features.actions,
 512                         ofputil_action_bitmap_to_name, ' ');
 513     ds_put_char(string, '\n');
 514
 515     ofp_print_phy_ports(string, oh->version, &b);
 516 }
 517
 518 static void
 519 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
 520 {
 521     enum ofp_config_flags flags;
 522
 523     flags = ntohs(osc->flags);
 524
 525     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
 526     flags &= ~OFPC_FRAG_MASK;
 527
 528     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
 529         ds_put_format(string, " invalid_ttl_to_controller");
 530         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
 531     }
 532
 533     if (flags) {
 534         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 535     }
 536
 537     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 538 }
 539
 540 static void print_wild(struct ds *string, const char *leader, int is_wild,
 541             int verbosity, const char *format, ...)
 542             __attribute__((format(printf, 5, 6)));
 543
 544 static void print_wild(struct ds *string, const char *leader, int is_wild,
 545                        int verbosity, const char *format, ...)
 546 {
 547     if (is_wild && verbosity < 2) {
 548         return;
 549     }
 550     ds_put_cstr(string, leader);
 551     if (!is_wild) {
 552         va_list args;
 553
 554         va_start(args, format);
 555         ds_put_format_valist(string, format, args);
 556         va_end(args);
 557     } else {
 558         ds_put_char(string, '*');
 559     }
 560     ds_put_char(string, ',');
 561 }
 562
 563 static void
 564 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
 565                  uint32_t wild_bits, int verbosity)
 566 {
 567     if (wild_bits >= 32 && verbosity < 2) {
 568         return;
 569     }
 570     ds_put_cstr(string, leader);
 571     if (wild_bits < 32) {
 572         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 573         if (wild_bits) {
 574             ds_put_format(string, "/%d", 32 - wild_bits);
 575         }
 576     } else {
 577         ds_put_char(string, '*');
 578     }
 579     ds_put_char(string, ',');
 580 }
 581
 582 void
 583 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
 584 {
 585     char *s = ofp10_match_to_string(om, verbosity);
 586     ds_put_cstr(f, s);
 587     free(s);
 588 }
 589
 590 char *
 591 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
 592 {
 593     struct ds f = DS_EMPTY_INITIALIZER;
 594     uint32_t w = ntohl(om->wildcards);
 595     bool skip_type = false;
 596     bool skip_proto = false;
 597
 598     if (!(w & OFPFW10_DL_TYPE)) {
 599         skip_type = true;
 600         if (om->dl_type == htons(ETH_TYPE_IP)) {
 601             if (!(w & OFPFW10_NW_PROTO)) {
 602                 skip_proto = true;
 603                 if (om->nw_proto == IPPROTO_ICMP) {
 604                     ds_put_cstr(&f, "icmp,");
 605                 } else if (om->nw_proto == IPPROTO_TCP) {
 606                     ds_put_cstr(&f, "tcp,");
 607                 } else if (om->nw_proto == IPPROTO_UDP) {
 608                     ds_put_cstr(&f, "udp,");
 609                 } else {
 610                     ds_put_cstr(&f, "ip,");
 611                     skip_proto = false;
 612                 }
 613             } else {
 614                 ds_put_cstr(&f, "ip,");
 615             }
 616         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 617             ds_put_cstr(&f, "arp,");
 618         } else {
 619             skip_type = false;
 620         }
 621     }
 622     print_wild(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
 623                "%d", ntohs(om->in_port));
 624     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
 625                "%d", ntohs(om->dl_vlan));
 626     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
 627                "%d", om->dl_vlan_pcp);
 628     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
 629                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 630     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
 631                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 632     if (!skip_type) {
 633         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
 634                    "0x%04x", ntohs(om->dl_type));
 635     }
 636     print_ip_netmask(&f, "nw_src=", om->nw_src,
 637                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
 638                      verbosity);
 639     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
 640                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
 641                      verbosity);
 642     if (!skip_proto) {
 643         if (om->dl_type == htons(ETH_TYPE_ARP)) {
 644             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
 645                        "%u", om->nw_proto);
 646         } else {
 647             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
 648                        "%u", om->nw_proto);
 649         }
 650     }
 651     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
 652                "%u", om->nw_tos);
 653     if (om->nw_proto == IPPROTO_ICMP) {
 654         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
 655                    "%d", ntohs(om->tp_src));
 656         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
 657                    "%d", ntohs(om->tp_dst));
 658     } else {
 659         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
 660                    "%d", ntohs(om->tp_src));
 661         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
 662                    "%d", ntohs(om->tp_dst));
 663     }
 664     if (ds_last(&f) == ',') {
 665         f.length--;
 666     }
 667     return ds_cstr(&f);
 668 }
 669
 670 static void
 671 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
 672 {
 673     struct ofputil_flow_mod fm;
 674     struct ofpbuf ofpacts;
 675     bool need_priority;
 676     enum ofperr error;
 677     enum ofpraw raw;
 678
 679     ofpbuf_init(&ofpacts, 64);
 680     error = ofputil_decode_flow_mod(&fm, oh, OFPUTIL_P_OF10_TID, &ofpacts);
 681     if (error) {
 682         ofpbuf_uninit(&ofpacts);
 683         ofp_print_error(s, error);
 684         return;
 685     }
 686
 687     ds_put_char(s, ' ');
 688     switch (fm.command) {
 689     case OFPFC_ADD:
 690         ds_put_cstr(s, "ADD");
 691         break;
 692     case OFPFC_MODIFY:
 693         ds_put_cstr(s, "MOD");
 694         break;
 695     case OFPFC_MODIFY_STRICT:
 696         ds_put_cstr(s, "MOD_STRICT");
 697         break;
 698     case OFPFC_DELETE:
 699         ds_put_cstr(s, "DEL");
 700         break;
 701     case OFPFC_DELETE_STRICT:
 702         ds_put_cstr(s, "DEL_STRICT");
 703         break;
 704     default:
 705         ds_put_format(s, "cmd:%d", fm.command);
 706     }
 707     if (fm.table_id != 0) {
 708         ds_put_format(s, " table:%d", fm.table_id);
 709     }
 710
 711     ds_put_char(s, ' ');
 712     ofpraw_decode(&raw, oh);
 713     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
 714         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
 715         ofp10_match_print(s, &ofm->match, verbosity);
 716
 717         /* ofp_print_match() doesn't print priority. */
 718         need_priority = true;
 719     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
 720         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
 721         const void *nxm = nfm + 1;
 722         char *nxm_s;
 723
 724         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 725         ds_put_cstr(s, nxm_s);
 726         free(nxm_s);
 727
 728         /* nx_match_to_string() doesn't print priority. */
 729         need_priority = true;
 730     } else {
 731         cls_rule_format(&fm.cr, s);
 732
 733         /* cls_rule_format() does print priority. */
 734         need_priority = false;
 735     }
 736
 737     if (ds_last(s) != ' ') {
 738         ds_put_char(s, ' ');
 739     }
 740     if (fm.new_cookie != htonll(0)) {
 741         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
 742     }
 743     if (fm.cookie_mask != htonll(0)) {
 744         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
 745                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
 746     }
 747     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 748         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 749     }
 750     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 751         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 752     }
 753     if (fm.cr.priority != OFP_DEFAULT_PRIORITY && need_priority) {
 754         ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
 755     }
 756     if (fm.buffer_id != UINT32_MAX) {
 757         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 758     }
 759     if (fm.out_port != OFPP_NONE) {
 760         ds_put_format(s, "out_port:");
 761         ofputil_format_port(fm.out_port, s);
 762         ds_put_char(s, ' ');
 763     }
 764     if (fm.flags != 0) {
 765         uint16_t flags = fm.flags;
 766
 767         if (flags & OFPFF_SEND_FLOW_REM) {
 768             ds_put_cstr(s, "send_flow_rem ");
 769         }
 770         if (flags & OFPFF_CHECK_OVERLAP) {
 771             ds_put_cstr(s, "check_overlap ");
 772         }
 773         if (flags & OFPFF10_EMERG) {
 774             ds_put_cstr(s, "emerg ");
 775         }
 776
 777         flags &= ~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF10_EMERG);
 778         if (flags) {
 779             ds_put_format(s, "flags:0x%"PRIx16" ", flags);
 780         }
 781     }
 782
 783     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
 784     ofpbuf_uninit(&ofpacts);
 785 }
 786
 787 static void
 788 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 789 {
 790     ds_put_format(string, "%u", sec);
 791     if (nsec > 0) {
 792         ds_put_format(string, ".%09u", nsec);
 793         while (string->string[string->length - 1] == '0') {
 794             string->length--;
 795         }
 796     }
 797     ds_put_char(string, 's');
 798 }
 799
 800 static const char *
 801 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason)
 802 {
 803     static char s[32];
 804
 805     switch (reason) {
 806     case OFPRR_IDLE_TIMEOUT:
 807         return "idle";
 808     case OFPRR_HARD_TIMEOUT:
 809         return "hard";
 810     case OFPRR_DELETE:
 811         return "delete";
 812     case OFPRR_GROUP_DELETE:
 813         return "group_delete";
 814     case OFPRR_EVICTION:
 815         return "eviction";
 816     default:
 817         sprintf(s, "%d", (int) reason);
 818         return s;
 819     }
 820 }
 821
 822 static void
 823 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 824 {
 825     struct ofputil_flow_removed fr;
 826     enum ofperr error;
 827
 828     error = ofputil_decode_flow_removed(&fr, oh);
 829     if (error) {
 830         ofp_print_error(string, error);
 831         return;
 832     }
 833
 834     ds_put_char(string, ' ');
 835     cls_rule_format(&fr.rule, string);
 836
 837     ds_put_format(string, " reason=%s",
 838                   ofp_flow_removed_reason_to_string(fr.reason));
 839
 840     if (fr.cookie != htonll(0)) {
 841         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 842     }
 843     ds_put_cstr(string, " duration");
 844     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 845     ds_put_format(string, " idle%"PRIu16" pkts%"PRIu64" bytes%"PRIu64"\n",
 846          fr.idle_timeout, fr.packet_count, fr.byte_count);
 847 }
 848
 849 static void
 850 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
 851 {
 852     struct ofputil_port_mod pm;
 853     enum ofperr error;
 854
 855     error = ofputil_decode_port_mod(oh, &pm);
 856     if (error) {
 857         ofp_print_error(string, error);
 858         return;
 859     }
 860
 861     ds_put_format(string, "port: %"PRIu16": addr:"ETH_ADDR_FMT"\n",
 862                   pm.port_no, ETH_ADDR_ARGS(pm.hw_addr));
 863
 864     ds_put_format(string, "     config: ");
 865     ofp_print_port_config(string, pm.config);
 866
 867     ds_put_format(string, "     mask:   ");
 868     ofp_print_port_config(string, pm.mask);
 869
 870     ds_put_format(string, "     advertise: ");
 871     if (pm.advertise) {
 872         ofp_print_port_features(string, pm.advertise);
 873     } else {
 874         ds_put_format(string, "UNCHANGED\n");
 875     }
 876 }
 877
 878 static void
 879 ofp_print_error(struct ds *string, enum ofperr error)
 880 {
 881     if (string->length) {
 882         ds_put_char(string, ' ');
 883     }
 884     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
 885 }
 886
 887 static void
 888 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
 889 {
 890     size_t len = ntohs(oh->length);
 891     struct ofpbuf payload;
 892     enum ofperr error;
 893     char *s;
 894
 895     error = ofperr_decode_msg(oh, &payload);
 896     if (!error) {
 897         ds_put_cstr(string, "***decode error***");
 898         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
 899         return;
 900     }
 901
 902     ds_put_format(string, " %s\n", ofperr_get_name(error));
 903
 904     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
 905         ds_put_printable(string, payload.data, payload.size);
 906     } else {
 907         s = ofp_to_string(payload.data, payload.size, 1);
 908         ds_put_cstr(string, s);
 909         free(s);
 910     }
 911 }
 912
 913 static void
 914 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
 915 {
 916     struct ofputil_port_status ps;
 917     enum ofperr error;
 918
 919     error = ofputil_decode_port_status(oh, &ps);
 920     if (error) {
 921         ofp_print_error(string, error);
 922         return;
 923     }
 924
 925     if (ps.reason == OFPPR_ADD) {
 926         ds_put_format(string, " ADD:");
 927     } else if (ps.reason == OFPPR_DELETE) {
 928         ds_put_format(string, " DEL:");
 929     } else if (ps.reason == OFPPR_MODIFY) {
 930         ds_put_format(string, " MOD:");
 931     }
 932
 933     ofp_print_phy_port(string, &ps.desc);
 934 }
 935
 936 static void
 937 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
 938 {
 939     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
 940
 941     ds_put_char(string, '\n');
 942     ds_put_format(string, "Manufacturer: %.*s\n",
 943             (int) sizeof ods->mfr_desc, ods->mfr_desc);
 944     ds_put_format(string, "Hardware: %.*s\n",
 945             (int) sizeof ods->hw_desc, ods->hw_desc);
 946     ds_put_format(string, "Software: %.*s\n",
 947             (int) sizeof ods->sw_desc, ods->sw_desc);
 948     ds_put_format(string, "Serial Num: %.*s\n",
 949             (int) sizeof ods->serial_num, ods->serial_num);
 950     ds_put_format(string, "DP Description: %.*s\n",
 951             (int) sizeof ods->dp_desc, ods->dp_desc);
 952 }
 953
 954 static void
 955 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
 956 {
 957     struct ofputil_flow_stats_request fsr;
 958     enum ofperr error;
 959
 960     error = ofputil_decode_flow_stats_request(&fsr, oh);
 961     if (error) {
 962         ofp_print_error(string, error);
 963         return;
 964     }
 965
 966     if (fsr.table_id != 0xff) {
 967         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
 968     }
 969
 970     if (fsr.out_port != OFPP_NONE) {
 971         ds_put_cstr(string, " out_port=");
 972         ofputil_format_port(fsr.out_port, string);
 973     }
 974
 975     /* A flow stats request doesn't include a priority, but cls_rule_format()
 976      * will print one unless it is OFP_DEFAULT_PRIORITY. */
 977     fsr.match.priority = OFP_DEFAULT_PRIORITY;
 978
 979     ds_put_char(string, ' ');
 980     cls_rule_format(&fsr.match, string);
 981 }
 982
 983 void
 984 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
 985 {
 986     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
 987                   ntohll(fs->cookie));
 988
 989     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
 990     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
 991     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
 992     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
 993     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
 994         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
 995     }
 996     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
 997         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
 998     }
 999     if (fs->idle_age >= 0) {
1000         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1001     }
1002     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1003         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1004     }
1005
1006     cls_rule_format(&fs->rule, string);
1007     if (string->string[string->length - 1] != ' ') {
1008         ds_put_char(string, ' ');
1009     }
1010
1011     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1012 }
1013
1014 static void
1015 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1016 {
1017     struct ofpbuf ofpacts;
1018     struct ofpbuf b;
1019
1020     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1021     ofpbuf_init(&ofpacts, 64);
1022     for (;;) {
1023         struct ofputil_flow_stats fs;
1024         int retval;
1025
1026         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1027         if (retval) {
1028             if (retval != EOF) {
1029                 ds_put_cstr(string, " ***parse error***");
1030             }
1031             break;
1032         }
1033         ds_put_char(string, '\n');
1034         ofp_print_flow_stats(string, &fs);
1035      }
1036 }
1037
1038 static void
1039 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1040 {
1041     struct ofputil_aggregate_stats as;
1042     enum ofperr error;
1043
1044     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1045     if (error) {
1046         ofp_print_error(string, error);
1047         return;
1048     }
1049
1050     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1051     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1052     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1053 }
1054
1055 static void print_port_stat(struct ds *string, const char *leader,
1056                             const ovs_32aligned_be64 *statp, int more)
1057 {
1058     uint64_t stat = ntohll(get_32aligned_be64(statp));
1059
1060     ds_put_cstr(string, leader);
1061     if (stat != UINT64_MAX) {
1062         ds_put_format(string, "%"PRIu64, stat);
1063     } else {
1064         ds_put_char(string, '?');
1065     }
1066     if (more) {
1067         ds_put_cstr(string, ", ");
1068     } else {
1069         ds_put_cstr(string, "\n");
1070     }
1071 }
1072
1073 static void
1074 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1075 {
1076     const struct ofp10_port_stats_request *psr = ofpmsg_body(oh);
1077     ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1078 }
1079
1080 static void
1081 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1082                            int verbosity)
1083 {
1084     struct ofp10_port_stats *ps;
1085     struct ofpbuf b;
1086     size_t n;
1087
1088     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1089     ofpraw_pull_assert(&b);
1090
1091     n = b.size / sizeof *ps;
1092     ds_put_format(string, " %zu ports\n", n);
1093     if (verbosity < 1) {
1094         return;
1095     }
1096
1097     for (;;) {
1098         ps = ofpbuf_try_pull(&b, sizeof *ps);
1099         if (!ps) {
1100             return;
1101         }
1102
1103         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
1104
1105         ds_put_cstr(string, "rx ");
1106         print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1107         print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1108         print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1109         print_port_stat(string, "errs=", &ps->rx_errors, 1);
1110         print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1111         print_port_stat(string, "over=", &ps->rx_over_err, 1);
1112         print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1113
1114         ds_put_cstr(string, "           tx ");
1115         print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1116         print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1117         print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1118         print_port_stat(string, "errs=", &ps->tx_errors, 1);
1119         print_port_stat(string, "coll=", &ps->collisions, 0);
1120     }
1121 }
1122
1123 static void
1124 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1125                             int verbosity)
1126 {
1127     struct ofp10_table_stats *ts;
1128     struct ofpbuf b;
1129     size_t n;
1130
1131     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1132     ofpraw_pull_assert(&b);
1133
1134     n = b.size / sizeof *ts;
1135     ds_put_format(string, " %zu tables\n", n);
1136     if (verbosity < 1) {
1137         return;
1138     }
1139
1140     for (;;) {
1141         char name[OFP_MAX_TABLE_NAME_LEN + 1];
1142
1143         ts = ofpbuf_try_pull(&b, sizeof *ts);
1144         if (!ts) {
1145             return;
1146         }
1147
1148         ovs_strlcpy(name, ts->name, sizeof name);
1149
1150         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
1151         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1152         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1153         ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1154         ds_put_cstr(string, "               ");
1155         ds_put_format(string, "lookup=%"PRIu64", ",
1156                       ntohll(get_32aligned_be64(&ts->lookup_count)));
1157         ds_put_format(string, "matched=%"PRIu64"\n",
1158                       ntohll(get_32aligned_be64(&ts->matched_count)));
1159      }
1160 }
1161
1162 static void
1163 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1164 {
1165     if (queue_id == OFPQ_ALL) {
1166         ds_put_cstr(string, "ALL");
1167     } else {
1168         ds_put_format(string, "%"PRIu32, queue_id);
1169     }
1170 }
1171
1172 static void
1173 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1174 {
1175     const struct ofp10_queue_stats_request *qsr = ofpmsg_body(oh);
1176
1177     ds_put_cstr(string, "port=");
1178     ofputil_format_port(ntohs(qsr->port_no), string);
1179
1180     ds_put_cstr(string, " queue=");
1181     ofp_print_queue_name(string, ntohl(qsr->queue_id));
1182 }
1183
1184 static void
1185 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1186                             int verbosity)
1187 {
1188     struct ofp10_queue_stats *qs;
1189     struct ofpbuf b;
1190     size_t n;
1191
1192     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1193     ofpraw_pull_assert(&b);
1194
1195     n = b.size / sizeof *qs;
1196     ds_put_format(string, " %zu queues\n", n);
1197     if (verbosity < 1) {
1198         return;
1199     }
1200
1201     for (;;) {
1202         qs = ofpbuf_try_pull(&b, sizeof *qs);
1203         if (!qs) {
1204             return;
1205         }
1206
1207         ds_put_cstr(string, "  port ");
1208         ofputil_format_port(ntohs(qs->port_no), string);
1209         ds_put_cstr(string, " queue ");
1210         ofp_print_queue_name(string, ntohl(qs->queue_id));
1211         ds_put_cstr(string, ": ");
1212
1213         print_port_stat(string, "bytes=", &qs->tx_bytes, 1);
1214         print_port_stat(string, "pkts=", &qs->tx_packets, 1);
1215         print_port_stat(string, "errors=", &qs->tx_errors, 0);
1216     }
1217 }
1218
1219 static void
1220 ofp_print_ofpst_port_desc_reply(struct ds *string,
1221                                 const struct ofp_header *oh)
1222 {
1223     struct ofpbuf b;
1224
1225     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1226     ofpraw_pull_assert(&b);
1227     ds_put_char(string, '\n');
1228     ofp_print_phy_ports(string, oh->version, &b);
1229 }
1230
1231 static void
1232 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1233 {
1234     uint16_t flags = ofpmp_flags(oh);
1235
1236     if (flags) {
1237         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1238     }
1239 }
1240
1241 static void
1242 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1243 {
1244     uint16_t flags = ofpmp_flags(oh);
1245
1246     if (flags) {
1247         ds_put_cstr(string, " flags=");
1248         if (flags & OFPSF_REPLY_MORE) {
1249             ds_put_cstr(string, "[more]");
1250             flags &= ~OFPSF_REPLY_MORE;
1251         }
1252         if (flags) {
1253             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1254                           flags);
1255         }
1256     }
1257 }
1258
1259 static void
1260 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1261 {
1262     size_t len = ntohs(oh->length);
1263
1264     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1265     if (verbosity > 1) {
1266         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1267     }
1268 }
1269
1270 static void
1271 ofp_print_nxt_role_message(struct ds *string,
1272                            const struct nx_role_request *nrr)
1273 {
1274     unsigned int role = ntohl(nrr->role);
1275
1276     ds_put_cstr(string, " role=");
1277     if (role == NX_ROLE_OTHER) {
1278         ds_put_cstr(string, "other");
1279     } else if (role == NX_ROLE_MASTER) {
1280         ds_put_cstr(string, "master");
1281     } else if (role == NX_ROLE_SLAVE) {
1282         ds_put_cstr(string, "slave");
1283     } else {
1284         ds_put_format(string, "%u", role);
1285     }
1286 }
1287
1288 static void
1289 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1290                                 const struct nx_flow_mod_table_id *nfmti)
1291 {
1292     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1293 }
1294
1295 static void
1296 ofp_print_nxt_set_flow_format(struct ds *string,
1297                               const struct nx_set_flow_format *nsff)
1298 {
1299     uint32_t format = ntohl(nsff->format);
1300
1301     ds_put_cstr(string, " format=");
1302     if (ofputil_nx_flow_format_is_valid(format)) {
1303         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1304     } else {
1305         ds_put_format(string, "%"PRIu32, format);
1306     }
1307 }
1308
1309 static void
1310 ofp_print_nxt_set_packet_in_format(struct ds *string,
1311                                    const struct nx_set_packet_in_format *nspf)
1312 {
1313     uint32_t format = ntohl(nspf->format);
1314
1315     ds_put_cstr(string, " format=");
1316     if (ofputil_packet_in_format_is_valid(format)) {
1317         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1318     } else {
1319         ds_put_format(string, "%"PRIu32, format);
1320     }
1321 }
1322
1323 static const char *
1324 ofp_port_reason_to_string(enum ofp_port_reason reason)
1325 {
1326     static char s[32];
1327
1328     switch (reason) {
1329     case OFPPR_ADD:
1330         return "add";
1331
1332     case OFPPR_DELETE:
1333         return "delete";
1334
1335     case OFPPR_MODIFY:
1336         return "modify";
1337
1338     default:
1339         sprintf(s, "%d", (int) reason);
1340         return s;
1341     }
1342 }
1343
1344 static void
1345 ofp_print_nxt_set_async_config(struct ds *string,
1346                                const struct nx_async_config *nac)
1347 {
1348     int i;
1349
1350     for (i = 0; i < 2; i++) {
1351         int j;
1352
1353         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1354
1355         ds_put_cstr(string, "       PACKET_IN:");
1356         for (j = 0; j < 32; j++) {
1357             if (nac->packet_in_mask[i] & htonl(1u << j)) {
1358                 ds_put_format(string, " %s",
1359                               ofputil_packet_in_reason_to_string(j));
1360             }
1361         }
1362         if (!nac->packet_in_mask[i]) {
1363             ds_put_cstr(string, " (off)");
1364         }
1365         ds_put_char(string, '\n');
1366
1367         ds_put_cstr(string, "     PORT_STATUS:");
1368         for (j = 0; j < 32; j++) {
1369             if (nac->port_status_mask[i] & htonl(1u << j)) {
1370                 ds_put_format(string, " %s", ofp_port_reason_to_string(j));
1371             }
1372         }
1373         if (!nac->port_status_mask[i]) {
1374             ds_put_cstr(string, " (off)");
1375         }
1376         ds_put_char(string, '\n');
1377
1378         ds_put_cstr(string, "    FLOW_REMOVED:");
1379         for (j = 0; j < 32; j++) {
1380             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1381                 ds_put_format(string, " %s",
1382                               ofp_flow_removed_reason_to_string(j));
1383             }
1384         }
1385         if (!nac->flow_removed_mask[i]) {
1386             ds_put_cstr(string, " (off)");
1387         }
1388         ds_put_char(string, '\n');
1389     }
1390 }
1391
1392 static void
1393 ofp_print_nxt_set_controller_id(struct ds *string,
1394                                 const struct nx_controller_id *nci)
1395 {
1396     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1397 }
1398
1399 static void
1400 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1401                                   const struct ofp_header *oh)
1402 {
1403     ds_put_format(string, " id=%"PRIu32,
1404                   ofputil_decode_flow_monitor_cancel(oh));
1405 }
1406
1407 static const char *
1408 nx_flow_monitor_flags_to_name(uint32_t bit)
1409 {
1410     enum nx_flow_monitor_flags fmf = bit;
1411
1412     switch (fmf) {
1413     case NXFMF_INITIAL: return "initial";
1414     case NXFMF_ADD: return "add";
1415     case NXFMF_DELETE: return "delete";
1416     case NXFMF_MODIFY: return "modify";
1417     case NXFMF_ACTIONS: return "actions";
1418     case NXFMF_OWN: return "own";
1419     }
1420
1421     return NULL;
1422 }
1423
1424 static void
1425 ofp_print_nxst_flow_monitor_request(struct ds *string,
1426                                     const struct ofp_header *oh)
1427 {
1428     struct ofpbuf b;
1429
1430     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1431     for (;;) {
1432         struct ofputil_flow_monitor_request request;
1433         int retval;
1434
1435         retval = ofputil_decode_flow_monitor_request(&request, &b);
1436         if (retval) {
1437             if (retval != EOF) {
1438                 ofp_print_error(string, retval);
1439             }
1440             return;
1441         }
1442
1443         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
1444         ofp_print_bit_names(string, request.flags,
1445                             nx_flow_monitor_flags_to_name, ',');
1446
1447         if (request.out_port != OFPP_NONE) {
1448             ds_put_cstr(string, " out_port=");
1449             ofputil_format_port(request.out_port, string);
1450         }
1451
1452         if (request.table_id != 0xff) {
1453             ds_put_format(string, " table=%"PRIu8, request.table_id);
1454         }
1455
1456         ds_put_char(string, ' ');
1457         cls_rule_format(&request.match, string);
1458         ds_chomp(string, ' ');
1459     }
1460 }
1461
1462 static void
1463 ofp_print_nxst_flow_monitor_reply(struct ds *string,
1464                                   const struct ofp_header *oh)
1465 {
1466     uint64_t ofpacts_stub[1024 / 8];
1467     struct ofpbuf ofpacts;
1468     struct ofpbuf b;
1469
1470     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1471     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1472     for (;;) {
1473         struct ofputil_flow_update update;
1474         struct cls_rule match;
1475         int retval;
1476
1477         update.match = &match;
1478         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
1479         if (retval) {
1480             if (retval != EOF) {
1481                 ofp_print_error(string, retval);
1482             }
1483             ofpbuf_uninit(&ofpacts);
1484             return;
1485         }
1486
1487         ds_put_cstr(string, "\n event=");
1488         switch (update.event) {
1489         case NXFME_ADDED:
1490             ds_put_cstr(string, "ADDED");
1491             break;
1492
1493         case NXFME_DELETED:
1494             ds_put_format(string, "DELETED reason=%s",
1495                           ofp_flow_removed_reason_to_string(update.reason));
1496             break;
1497
1498         case NXFME_MODIFIED:
1499             ds_put_cstr(string, "MODIFIED");
1500             break;
1501
1502         case NXFME_ABBREV:
1503             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
1504             continue;
1505         }
1506
1507         ds_put_format(string, " table=%"PRIu8, update.table_id);
1508         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
1509             ds_put_format(string, " idle_timeout=%"PRIu16,
1510                           update.idle_timeout);
1511         }
1512         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
1513             ds_put_format(string, " hard_timeout=%"PRIu16,
1514                           update.hard_timeout);
1515         }
1516         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
1517
1518         ds_put_char(string, ' ');
1519         cls_rule_format(update.match, string);
1520
1521         if (update.ofpacts_len) {
1522             if (string->string[string->length - 1] != ' ') {
1523                 ds_put_char(string, ' ');
1524             }
1525             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
1526         }
1527     }
1528 }
1529
1530 void
1531 ofp_print_version(const struct ofp_header *oh,
1532                   struct ds *string)
1533 {
1534     switch (oh->version) {
1535     case OFP10_VERSION:
1536         break;
1537     case OFP11_VERSION:
1538         ds_put_cstr(string, " (OF1.1)");
1539         break;
1540     case OFP12_VERSION:
1541         ds_put_cstr(string, " (OF1.2)");
1542         break;
1543     default:
1544         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
1545         break;
1546     }
1547     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
1548 }
1549
1550 static void
1551 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1552                        struct ds *string)
1553 {
1554     ds_put_cstr(string, ofpraw_get_name(raw));
1555     ofp_print_version(oh, string);
1556 }
1557
1558 static void
1559 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1560                 struct ds *string, int verbosity)
1561 {
1562     const void *msg = oh;
1563
1564     ofp_header_to_string__(oh, raw, string);
1565     switch (ofptype_from_ofpraw(raw)) {
1566     case OFPTYPE_HELLO:
1567         ds_put_char(string, '\n');
1568         ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1569                         0, true);
1570         break;
1571
1572     case OFPTYPE_ERROR:
1573         ofp_print_error_msg(string, oh);
1574         break;
1575
1576     case OFPTYPE_ECHO_REQUEST:
1577     case OFPTYPE_ECHO_REPLY:
1578         ofp_print_echo(string, oh, verbosity);
1579         break;
1580
1581     case OFPTYPE_FEATURES_REQUEST:
1582         break;
1583
1584     case OFPTYPE_FEATURES_REPLY:
1585         ofp_print_switch_features(string, oh);
1586         break;
1587
1588     case OFPTYPE_GET_CONFIG_REQUEST:
1589         break;
1590
1591     case OFPTYPE_GET_CONFIG_REPLY:
1592     case OFPTYPE_SET_CONFIG:
1593         ofp_print_switch_config(string, ofpmsg_body(oh));
1594         break;
1595
1596     case OFPTYPE_PACKET_IN:
1597         ofp_print_packet_in(string, oh, verbosity);
1598         break;
1599
1600     case OFPTYPE_FLOW_REMOVED:
1601         ofp_print_flow_removed(string, oh);
1602         break;
1603
1604     case OFPTYPE_PORT_STATUS:
1605         ofp_print_port_status(string, oh);
1606         break;
1607
1608     case OFPTYPE_PACKET_OUT:
1609         ofp_print_packet_out(string, oh, verbosity);
1610         break;
1611
1612     case OFPTYPE_FLOW_MOD:
1613         ofp_print_flow_mod(string, oh, verbosity);
1614         break;
1615
1616     case OFPTYPE_PORT_MOD:
1617         ofp_print_port_mod(string, oh);
1618         break;
1619
1620     case OFPTYPE_BARRIER_REQUEST:
1621     case OFPTYPE_BARRIER_REPLY:
1622         break;
1623
1624     case OFPTYPE_DESC_STATS_REQUEST:
1625     case OFPTYPE_PORT_DESC_STATS_REQUEST:
1626         ofp_print_stats_request(string, oh);
1627         break;
1628
1629     case OFPTYPE_FLOW_STATS_REQUEST:
1630     case OFPTYPE_AGGREGATE_STATS_REQUEST:
1631         ofp_print_stats_request(string, oh);
1632         ofp_print_flow_stats_request(string, oh);
1633         break;
1634
1635     case OFPTYPE_TABLE_STATS_REQUEST:
1636         ofp_print_stats_request(string, oh);
1637         break;
1638
1639     case OFPTYPE_PORT_STATS_REQUEST:
1640         ofp_print_stats_request(string, oh);
1641         ofp_print_ofpst_port_request(string, oh);
1642         break;
1643
1644     case OFPTYPE_QUEUE_STATS_REQUEST:
1645         ofp_print_stats_request(string, oh);
1646         ofp_print_ofpst_queue_request(string, oh);
1647         break;
1648
1649     case OFPTYPE_DESC_STATS_REPLY:
1650         ofp_print_stats_reply(string, oh);
1651         ofp_print_ofpst_desc_reply(string, oh);
1652         break;
1653
1654     case OFPTYPE_FLOW_STATS_REPLY:
1655         ofp_print_stats_reply(string, oh);
1656         ofp_print_flow_stats_reply(string, oh);
1657         break;
1658
1659     case OFPTYPE_QUEUE_STATS_REPLY:
1660         ofp_print_stats_reply(string, oh);
1661         ofp_print_ofpst_queue_reply(string, oh, verbosity);
1662         break;
1663
1664     case OFPTYPE_PORT_STATS_REPLY:
1665         ofp_print_stats_reply(string, oh);
1666         ofp_print_ofpst_port_reply(string, oh, verbosity);
1667         break;
1668
1669     case OFPTYPE_TABLE_STATS_REPLY:
1670         ofp_print_stats_reply(string, oh);
1671         ofp_print_ofpst_table_reply(string, oh, verbosity);
1672         break;
1673
1674     case OFPTYPE_AGGREGATE_STATS_REPLY:
1675         ofp_print_stats_reply(string, oh);
1676         ofp_print_aggregate_stats_reply(string, oh);
1677         break;
1678
1679     case OFPTYPE_PORT_DESC_STATS_REPLY:
1680         ofp_print_stats_reply(string, oh);
1681         ofp_print_ofpst_port_desc_reply(string, oh);
1682         break;
1683
1684     case OFPTYPE_ROLE_REQUEST:
1685     case OFPTYPE_ROLE_REPLY:
1686         ofp_print_nxt_role_message(string, ofpmsg_body(oh));
1687         break;
1688
1689     case OFPTYPE_FLOW_MOD_TABLE_ID:
1690         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
1691         break;
1692
1693     case OFPTYPE_SET_FLOW_FORMAT:
1694         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
1695         break;
1696
1697     case OFPTYPE_SET_PACKET_IN_FORMAT:
1698         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
1699         break;
1700
1701     case OFPTYPE_FLOW_AGE:
1702         break;
1703
1704     case OFPTYPE_SET_CONTROLLER_ID:
1705         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
1706         break;
1707
1708     case OFPTYPE_SET_ASYNC_CONFIG:
1709         ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
1710         break;
1711
1712     case OFPTYPE_FLOW_MONITOR_CANCEL:
1713         ofp_print_nxt_flow_monitor_cancel(string, msg);
1714         break;
1715
1716     case OFPTYPE_FLOW_MONITOR_PAUSED:
1717     case OFPTYPE_FLOW_MONITOR_RESUMED:
1718         break;
1719
1720     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1721         ofp_print_nxst_flow_monitor_request(string, msg);
1722         break;
1723
1724     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1725         ofp_print_nxst_flow_monitor_reply(string, msg);
1726         break;
1727     }
1728 }
1729
1730 /* Composes and returns a string representing the OpenFlow packet of 'len'
1731  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1732  * verbosity and higher numbers increase verbosity.  The caller is responsible
1733  * for freeing the string. */
1734 char *
1735 ofp_to_string(const void *oh_, size_t len, int verbosity)
1736 {
1737     struct ds string = DS_EMPTY_INITIALIZER;
1738     const struct ofp_header *oh = oh_;
1739
1740     if (!len) {
1741         ds_put_cstr(&string, "OpenFlow message is empty\n");
1742     } else if (len < sizeof(struct ofp_header)) {
1743         ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1744                       len);
1745     } else if (ntohs(oh->length) > len) {
1746         enum ofperr error;
1747         enum ofpraw raw;
1748
1749         error = ofpraw_decode_partial(&raw, oh, len);
1750         if (!error) {
1751             ofp_header_to_string__(oh, raw, &string);
1752             ds_put_char(&string, '\n');
1753         }
1754
1755         ds_put_format(&string,
1756                       "(***truncated to %zu bytes from %"PRIu16"***)\n",
1757                       len, ntohs(oh->length));
1758     } else if (ntohs(oh->length) < len) {
1759         ds_put_format(&string,
1760                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
1761                       ntohs(oh->length), len);
1762     } else {
1763         enum ofperr error;
1764         enum ofpraw raw;
1765
1766         error = ofpraw_decode(&raw, oh);
1767         if (!error) {
1768             ofp_to_string__(oh, raw, &string, verbosity);
1769             if (verbosity >= 5) {
1770                 if (ds_last(&string) != '\n') {
1771                     ds_put_char(&string, '\n');
1772                 }
1773                 ds_put_hex_dump(&string, oh, len, 0, true);
1774             }
1775             if (ds_last(&string) != '\n') {
1776                 ds_put_char(&string, '\n');
1777             }
1778             return ds_steal_cstr(&string);
1779         }
1780
1781         ofp_print_error(&string, error);
1782     }
1783     ds_put_hex_dump(&string, oh, len, 0, true);
1784     return ds_steal_cstr(&string);
1785 }
1786 \f
1787 static void
1788 print_and_free(FILE *stream, char *string)
1789 {
1790     fputs(string, stream);
1791     free(string);
1792 }
1793
1794 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1795  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1796  * numbers increase verbosity. */
1797 void
1798 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1799 {
1800     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1801 }
1802
1803 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1804  * 'data' to 'stream'. */
1805 void
1806 ofp_print_packet(FILE *stream, const void *data, size_t len)
1807 {
1808     print_and_free(stream, ofp_packet_to_string(data, len));
1809 }