lib/ofp-print.c

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