lib/ofp-print.c

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