lib/ofp-print.c

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