pintos-os.org Git - openvswitch/blob - lib/ofp-print.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   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 "multipath.h"
  35 #include "nx-match.h"
  36 #include "ofp-util.h"
  37 #include "ofpbuf.h"
  38 #include "openflow/openflow.h"
  39 #include "openflow/nicira-ext.h"
  40 #include "packets.h"
  41 #include "pcap.h"
  42 #include "type-props.h"
  43 #include "unaligned.h"
  44 #include "util.h"
  45
  46 static void ofp_print_port_name(struct ds *string, uint16_t port);
  47 static void ofp_print_queue_name(struct ds *string, uint32_t port);
  48 static void ofp_print_error(struct ds *, int error);
  49
  50
  51 /* Returns a string that represents the contents of the Ethernet frame in the
  52  * 'len' bytes starting at 'data' to 'stream' as output by tcpdump.
  53  * 'total_len' specifies the full length of the Ethernet frame (of which 'len'
  54  * bytes were captured).
  55  *
  56  * The caller must free the returned string.
  57  *
  58  * This starts and kills a tcpdump subprocess so it's quite expensive. */
  59 char *
  60 ofp_packet_to_string(const void *data, size_t len, size_t total_len OVS_UNUSED)
  61 {
  62     struct ds ds = DS_EMPTY_INITIALIZER;
  63     struct ofpbuf buf;
  64
  65     char command[128];
  66     FILE *pcap;
  67     FILE *tcpdump;
  68     int status;
  69     int c;
  70
  71     ofpbuf_use_const(&buf, data, len);
  72
  73     pcap = tmpfile();
  74     if (!pcap) {
  75         ovs_error(errno, "tmpfile");
  76         return xstrdup("<error>");
  77     }
  78     pcap_write_header(pcap);
  79     pcap_write(pcap, &buf);
  80     fflush(pcap);
  81     if (ferror(pcap)) {
  82         ovs_error(errno, "error writing temporary file");
  83     }
  84     rewind(pcap);
  85
  86     snprintf(command, sizeof command, "/usr/sbin/tcpdump -t -e -n -r /dev/fd/%d 2>/dev/null",
  87              fileno(pcap));
  88     tcpdump = popen(command, "r");
  89     fclose(pcap);
  90     if (!tcpdump) {
  91         ovs_error(errno, "exec(\"%s\")", command);
  92         return xstrdup("<error>");
  93     }
  94
  95     while ((c = getc(tcpdump)) != EOF) {
  96         ds_put_char(&ds, c);
  97     }
  98
  99     status = pclose(tcpdump);
 100     if (WIFEXITED(status)) {
 101         if (WEXITSTATUS(status))
 102             ovs_error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
 103     } else if (WIFSIGNALED(status)) {
 104         ovs_error(0, "tcpdump exited with signal %d", WTERMSIG(status));
 105     }
 106     return ds_cstr(&ds);
 107 }
 108
 109 static void
 110 ofp_print_packet_in(struct ds *string, const struct ofp_packet_in *op,
 111                     int verbosity)
 112 {
 113     size_t len = ntohs(op->header.length);
 114     size_t data_len;
 115
 116     ds_put_format(string, " total_len=%"PRIu16" in_port=",
 117                   ntohs(op->total_len));
 118     ofp_print_port_name(string, ntohs(op->in_port));
 119
 120     if (op->reason == OFPR_ACTION)
 121         ds_put_cstr(string, " (via action)");
 122     else if (op->reason != OFPR_NO_MATCH)
 123         ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
 124
 125     data_len = len - offsetof(struct ofp_packet_in, data);
 126     ds_put_format(string, " data_len=%zu", data_len);
 127     if (op->buffer_id == htonl(UINT32_MAX)) {
 128         ds_put_format(string, " (unbuffered)");
 129         if (ntohs(op->total_len) != data_len)
 130             ds_put_format(string, " (***total_len != data_len***)");
 131     } else {
 132         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(op->buffer_id));
 133         if (ntohs(op->total_len) < data_len)
 134             ds_put_format(string, " (***total_len < data_len***)");
 135     }
 136     ds_put_char(string, '\n');
 137
 138     if (verbosity > 0) {
 139         struct flow flow;
 140         struct ofpbuf packet;
 141
 142         ofpbuf_use_const(&packet, op->data, data_len);
 143         flow_extract(&packet, 0, ntohs(op->in_port), &flow);
 144         flow_format(string, &flow);
 145         ds_put_char(string, '\n');
 146     }
 147     if (verbosity > 1) {
 148         char *packet = ofp_packet_to_string(op->data, data_len,
 149                                             ntohs(op->total_len));
 150         ds_put_cstr(string, packet);
 151         free(packet);
 152     }
 153 }
 154
 155 static void ofp_print_port_name(struct ds *string, uint16_t port)
 156 {
 157     const char *name;
 158     switch (port) {
 159     case OFPP_IN_PORT:
 160         name = "IN_PORT";
 161         break;
 162     case OFPP_TABLE:
 163         name = "TABLE";
 164         break;
 165     case OFPP_NORMAL:
 166         name = "NORMAL";
 167         break;
 168     case OFPP_FLOOD:
 169         name = "FLOOD";
 170         break;
 171     case OFPP_ALL:
 172         name = "ALL";
 173         break;
 174     case OFPP_CONTROLLER:
 175         name = "CONTROLLER";
 176         break;
 177     case OFPP_LOCAL:
 178         name = "LOCAL";
 179         break;
 180     case OFPP_NONE:
 181         name = "NONE";
 182         break;
 183     default:
 184         ds_put_format(string, "%"PRIu16, port);
 185         return;
 186     }
 187     ds_put_cstr(string, name);
 188 }
 189
 190
 191 static void
 192 print_note(struct ds *string, const struct nx_action_note *nan)
 193 {
 194     size_t len;
 195     size_t i;
 196
 197     ds_put_cstr(string, "note:");
 198     len = ntohs(nan->len) - offsetof(struct nx_action_note, note);
 199     for (i = 0; i < len; i++) {
 200         if (i) {
 201             ds_put_char(string, '.');
 202         }
 203         ds_put_format(string, "%02"PRIx8, nan->note[i]);
 204     }
 205 }
 206
 207 static void
 208 ofp_print_action(struct ds *s, const union ofp_action *a,
 209                  enum ofputil_action_code code)
 210 {
 211     const struct ofp_action_enqueue *oae;
 212     const struct ofp_action_dl_addr *oada;
 213     const struct nx_action_set_tunnel64 *nast64;
 214     const struct nx_action_set_tunnel *nast;
 215     const struct nx_action_set_queue *nasq;
 216     const struct nx_action_resubmit *nar;
 217     const struct nx_action_reg_move *move;
 218     const struct nx_action_reg_load *load;
 219     const struct nx_action_multipath *nam;
 220     const struct nx_action_autopath *naa;
 221     const struct nx_action_output_reg *naor;
 222     uint16_t port;
 223
 224     switch (code) {
 225     case OFPUTIL_OFPAT_OUTPUT:
 226         port = ntohs(a->output.port);
 227         if (port < OFPP_MAX) {
 228             ds_put_format(s, "output:%"PRIu16, port);
 229         } else {
 230             ofp_print_port_name(s, port);
 231             if (port == OFPP_CONTROLLER) {
 232                 if (a->output.max_len != htons(0)) {
 233                     ds_put_format(s, ":%"PRIu16, ntohs(a->output.max_len));
 234                 } else {
 235                     ds_put_cstr(s, ":all");
 236                 }
 237             }
 238         }
 239         break;
 240
 241     case OFPUTIL_OFPAT_ENQUEUE:
 242         oae = (const struct ofp_action_enqueue *) a;
 243         ds_put_format(s, "enqueue:");
 244         ofp_print_port_name(s, ntohs(oae->port));
 245         ds_put_format(s, "q%"PRIu32, ntohl(oae->queue_id));
 246         break;
 247
 248     case OFPUTIL_OFPAT_SET_VLAN_VID:
 249         ds_put_format(s, "mod_vlan_vid:%"PRIu16,
 250                       ntohs(a->vlan_vid.vlan_vid));
 251         break;
 252
 253     case OFPUTIL_OFPAT_SET_VLAN_PCP:
 254         ds_put_format(s, "mod_vlan_pcp:%"PRIu8, a->vlan_pcp.vlan_pcp);
 255         break;
 256
 257     case OFPUTIL_OFPAT_STRIP_VLAN:
 258         ds_put_cstr(s, "strip_vlan");
 259         break;
 260
 261     case OFPUTIL_OFPAT_SET_DL_SRC:
 262         oada = (const struct ofp_action_dl_addr *) a;
 263         ds_put_format(s, "mod_dl_src:"ETH_ADDR_FMT,
 264                       ETH_ADDR_ARGS(oada->dl_addr));
 265         break;
 266
 267     case OFPUTIL_OFPAT_SET_DL_DST:
 268         oada = (const struct ofp_action_dl_addr *) a;
 269         ds_put_format(s, "mod_dl_dst:"ETH_ADDR_FMT,
 270                       ETH_ADDR_ARGS(oada->dl_addr));
 271         break;
 272
 273     case OFPUTIL_OFPAT_SET_NW_SRC:
 274         ds_put_format(s, "mod_nw_src:"IP_FMT, IP_ARGS(&a->nw_addr.nw_addr));
 275         break;
 276
 277     case OFPUTIL_OFPAT_SET_NW_DST:
 278         ds_put_format(s, "mod_nw_dst:"IP_FMT, IP_ARGS(&a->nw_addr.nw_addr));
 279         break;
 280
 281     case OFPUTIL_OFPAT_SET_NW_TOS:
 282         ds_put_format(s, "mod_nw_tos:%d", a->nw_tos.nw_tos);
 283         break;
 284
 285     case OFPUTIL_OFPAT_SET_TP_SRC:
 286         ds_put_format(s, "mod_tp_src:%d", ntohs(a->tp_port.tp_port));
 287         break;
 288
 289     case OFPUTIL_OFPAT_SET_TP_DST:
 290         ds_put_format(s, "mod_tp_dst:%d", ntohs(a->tp_port.tp_port));
 291         break;
 292
 293     case OFPUTIL_NXAST_RESUBMIT:
 294         nar = (struct nx_action_resubmit *)a;
 295         ds_put_format(s, "resubmit:");
 296         ofp_print_port_name(s, ntohs(nar->in_port));
 297         break;
 298
 299     case OFPUTIL_NXAST_RESUBMIT_TABLE:
 300         nar = (struct nx_action_resubmit *)a;
 301         ds_put_format(s, "resubmit(");
 302         if (nar->in_port != htons(OFPP_IN_PORT)) {
 303             ofp_print_port_name(s, ntohs(nar->in_port));
 304         }
 305         ds_put_char(s, ',');
 306         if (nar->table != 255) {
 307             ds_put_format(s, "%"PRIu8, nar->table);
 308         }
 309         ds_put_char(s, ')');
 310         break;
 311
 312     case OFPUTIL_NXAST_SET_TUNNEL:
 313         nast = (struct nx_action_set_tunnel *)a;
 314         ds_put_format(s, "set_tunnel:%#"PRIx32, ntohl(nast->tun_id));
 315         break;
 316
 317     case OFPUTIL_NXAST_SET_QUEUE:
 318         nasq = (struct nx_action_set_queue *)a;
 319         ds_put_format(s, "set_queue:%u", ntohl(nasq->queue_id));
 320         break;
 321
 322     case OFPUTIL_NXAST_POP_QUEUE:
 323         ds_put_cstr(s, "pop_queue");
 324         break;
 325
 326     case OFPUTIL_NXAST_NOTE:
 327         print_note(s, (const struct nx_action_note *) a);
 328         break;
 329
 330     case OFPUTIL_NXAST_REG_MOVE:
 331         move = (const struct nx_action_reg_move *) a;
 332         nxm_format_reg_move(move, s);
 333         break;
 334
 335     case OFPUTIL_NXAST_REG_LOAD:
 336         load = (const struct nx_action_reg_load *) a;
 337         nxm_format_reg_load(load, s);
 338         break;
 339
 340     case OFPUTIL_NXAST_SET_TUNNEL64:
 341         nast64 = (const struct nx_action_set_tunnel64 *) a;
 342         ds_put_format(s, "set_tunnel64:%#"PRIx64,
 343                       ntohll(nast64->tun_id));
 344         break;
 345
 346     case OFPUTIL_NXAST_MULTIPATH:
 347         nam = (const struct nx_action_multipath *) a;
 348         multipath_format(nam, s);
 349         break;
 350
 351     case OFPUTIL_NXAST_AUTOPATH:
 352         naa = (const struct nx_action_autopath *)a;
 353         ds_put_format(s, "autopath(%u,", ntohl(naa->id));
 354         nxm_format_field_bits(s, ntohl(naa->dst),
 355                               nxm_decode_ofs(naa->ofs_nbits),
 356                               nxm_decode_n_bits(naa->ofs_nbits));
 357         ds_put_char(s, ')');
 358         break;
 359
 360     case OFPUTIL_NXAST_BUNDLE:
 361     case OFPUTIL_NXAST_BUNDLE_LOAD:
 362         bundle_format((const struct nx_action_bundle *) a, s);
 363         break;
 364
 365     case OFPUTIL_NXAST_OUTPUT_REG:
 366         naor = (const struct nx_action_output_reg *) a;
 367         ds_put_cstr(s, "output:");
 368         nxm_format_field_bits(s, ntohl(naor->src),
 369                               nxm_decode_ofs(naor->ofs_nbits),
 370                               nxm_decode_n_bits(naor->ofs_nbits));
 371         break;
 372
 373     default:
 374         break;
 375     }
 376 }
 377
 378 void
 379 ofp_print_actions(struct ds *string, const union ofp_action *actions,
 380                   size_t n_actions)
 381 {
 382     const union ofp_action *a;
 383     size_t left;
 384
 385     ds_put_cstr(string, "actions=");
 386     if (!n_actions) {
 387         ds_put_cstr(string, "drop");
 388     }
 389
 390     OFPUTIL_ACTION_FOR_EACH (a, left, actions, n_actions) {
 391         int code = ofputil_decode_action(a);
 392         if (code >= 0) {
 393             if (a != actions) {
 394                 ds_put_cstr(string, ",");
 395             }
 396             ofp_print_action(string, a, code);
 397         } else {
 398             ofp_print_error(string, -code);
 399         }
 400     }
 401     if (left > 0) {
 402         ds_put_format(string, " ***%zu leftover bytes following actions",
 403                       left * sizeof *a);
 404     }
 405 }
 406
 407 static void
 408 ofp_print_packet_out(struct ds *string, const struct ofp_packet_out *opo,
 409                      int verbosity)
 410 {
 411     size_t len = ntohs(opo->header.length);
 412     size_t actions_len = ntohs(opo->actions_len);
 413
 414     ds_put_cstr(string, " in_port=");
 415     ofp_print_port_name(string, ntohs(opo->in_port));
 416
 417     ds_put_format(string, " actions_len=%zu ", actions_len);
 418     if (actions_len > (ntohs(opo->header.length) - sizeof *opo)) {
 419         ds_put_format(string, "***packet too short for action length***\n");
 420         return;
 421     }
 422     if (actions_len % sizeof(union ofp_action)) {
 423         ds_put_format(string, "***action length not a multiple of %zu***\n",
 424                       sizeof(union ofp_action));
 425     }
 426     ofp_print_actions(string, (const union ofp_action *) opo->actions,
 427                       actions_len / sizeof(union ofp_action));
 428
 429     if (ntohl(opo->buffer_id) == UINT32_MAX) {
 430         int data_len = len - sizeof *opo - actions_len;
 431         ds_put_format(string, " data_len=%d", data_len);
 432         if (verbosity > 0 && len > sizeof *opo) {
 433             char *packet = ofp_packet_to_string(
 434                     (uint8_t *)opo->actions + actions_len, data_len, data_len);
 435             ds_put_char(string, '\n');
 436             ds_put_cstr(string, packet);
 437             free(packet);
 438         }
 439     } else {
 440         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(opo->buffer_id));
 441     }
 442     ds_put_char(string, '\n');
 443 }
 444
 445 /* qsort comparison function. */
 446 static int
 447 compare_ports(const void *a_, const void *b_)
 448 {
 449     const struct ofp_phy_port *a = a_;
 450     const struct ofp_phy_port *b = b_;
 451     uint16_t ap = ntohs(a->port_no);
 452     uint16_t bp = ntohs(b->port_no);
 453
 454     return ap < bp ? -1 : ap > bp;
 455 }
 456
 457 struct bit_name {
 458     uint32_t bit;
 459     const char *name;
 460 };
 461
 462 static void
 463 ofp_print_bit_names(struct ds *string, uint32_t bits,
 464                     const struct bit_name bit_names[])
 465 {
 466     int n = 0;
 467
 468     if (!bits) {
 469         ds_put_cstr(string, "0");
 470         return;
 471     }
 472
 473     for (; bits && bit_names->name; bit_names++) {
 474         if (bits & bit_names->bit) {
 475             if (n++) {
 476                 ds_put_char(string, ' ');
 477             }
 478             ds_put_cstr(string, bit_names->name);
 479             bits &= ~bit_names->bit;
 480         }
 481     }
 482
 483     if (bits) {
 484         if (n++) {
 485             ds_put_char(string, ' ');
 486         }
 487         ds_put_format(string, "0x%"PRIx32, bits);
 488     }
 489 }
 490
 491 static void
 492 ofp_print_port_features(struct ds *string, uint32_t features)
 493 {
 494     static const struct bit_name feature_bits[] = {
 495         { OFPPF_10MB_HD,    "10MB-HD" },
 496         { OFPPF_10MB_FD,    "10MB-FD" },
 497         { OFPPF_100MB_HD,   "100MB-HD" },
 498         { OFPPF_100MB_FD,   "100MB-FD" },
 499         { OFPPF_1GB_HD,     "1GB-HD" },
 500         { OFPPF_1GB_FD,     "1GB-FD" },
 501         { OFPPF_10GB_FD,    "10GB-FD" },
 502         { OFPPF_COPPER,     "COPPER" },
 503         { OFPPF_FIBER,      "FIBER" },
 504         { OFPPF_AUTONEG,    "AUTO_NEG" },
 505         { OFPPF_PAUSE,      "AUTO_PAUSE" },
 506         { OFPPF_PAUSE_ASYM, "AUTO_PAUSE_ASYM" },
 507         { 0,                NULL },
 508     };
 509
 510     ofp_print_bit_names(string, features, feature_bits);
 511     ds_put_char(string, '\n');
 512 }
 513
 514 static void
 515 ofp_print_port_config(struct ds *string, uint32_t config)
 516 {
 517     static const struct bit_name config_bits[] = {
 518         { OFPPC_PORT_DOWN,    "PORT_DOWN" },
 519         { OFPPC_NO_STP,       "NO_STP" },
 520         { OFPPC_NO_RECV,      "NO_RECV" },
 521         { OFPPC_NO_RECV_STP,  "NO_RECV_STP" },
 522         { OFPPC_NO_FLOOD,     "NO_FLOOD" },
 523         { OFPPC_NO_FWD,       "NO_FWD" },
 524         { OFPPC_NO_PACKET_IN, "NO_PACKET_IN" },
 525         { 0,                  NULL },
 526     };
 527
 528     ofp_print_bit_names(string, config, config_bits);
 529     ds_put_char(string, '\n');
 530 }
 531
 532 static void
 533 ofp_print_port_state(struct ds *string, uint32_t state)
 534 {
 535     static const struct bit_name state_bits[] = {
 536         { OFPPS_LINK_DOWN, "LINK_DOWN" },
 537         { 0,               NULL },
 538     };
 539     uint32_t stp_state;
 540
 541     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
 542      * pattern.  We have to special case it.
 543      *
 544      * OVS doesn't support STP, so this field will always be 0 if we are
 545      * talking to OVS, so we'd always print STP_LISTEN in that case.
 546      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
 547      * avoid confusing users. */
 548     stp_state = state & OFPPS_STP_MASK;
 549     if (stp_state) {
 550         ds_put_cstr(string, (stp_state == OFPPS_STP_LEARN ? "STP_LEARN"
 551                              : stp_state == OFPPS_STP_FORWARD ? "STP_FORWARD"
 552                              : "STP_BLOCK"));
 553         state &= ~OFPPS_STP_MASK;
 554         if (state) {
 555             ofp_print_bit_names(string, state, state_bits);
 556         }
 557     } else {
 558         ofp_print_bit_names(string, state, state_bits);
 559     }
 560     ds_put_char(string, '\n');
 561 }
 562
 563 static void
 564 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
 565 {
 566     char name[OFP_MAX_PORT_NAME_LEN];
 567     int j;
 568
 569     memcpy(name, port->name, sizeof name);
 570     for (j = 0; j < sizeof name - 1; j++) {
 571         if (!isprint((unsigned char) name[j])) {
 572             break;
 573         }
 574     }
 575     name[j] = '\0';
 576
 577     ds_put_char(string, ' ');
 578     ofp_print_port_name(string, ntohs(port->port_no));
 579     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
 580                   name, ETH_ADDR_ARGS(port->hw_addr));
 581
 582     ds_put_cstr(string, "     config:     ");
 583     ofp_print_port_config(string, ntohl(port->config));
 584
 585     ds_put_cstr(string, "     state:      ");
 586     ofp_print_port_state(string, ntohl(port->state));
 587
 588     if (port->curr) {
 589         ds_put_format(string, "     current:    ");
 590         ofp_print_port_features(string, ntohl(port->curr));
 591     }
 592     if (port->advertised) {
 593         ds_put_format(string, "     advertised: ");
 594         ofp_print_port_features(string, ntohl(port->advertised));
 595     }
 596     if (port->supported) {
 597         ds_put_format(string, "     supported:  ");
 598         ofp_print_port_features(string, ntohl(port->supported));
 599     }
 600     if (port->peer) {
 601         ds_put_format(string, "     peer:       ");
 602         ofp_print_port_features(string, ntohl(port->peer));
 603     }
 604 }
 605
 606 static void
 607 ofp_print_switch_features(struct ds *string,
 608                           const struct ofp_switch_features *osf)
 609 {
 610     size_t len = ntohs(osf->header.length);
 611     struct ofp_phy_port *port_list;
 612     int n_ports;
 613     int i;
 614
 615     ds_put_format(string, " ver:0x%x, dpid:%016"PRIx64"\n",
 616             osf->header.version, ntohll(osf->datapath_id));
 617     ds_put_format(string, "n_tables:%d, n_buffers:%d\n", osf->n_tables,
 618             ntohl(osf->n_buffers));
 619     ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
 620            ntohl(osf->capabilities), ntohl(osf->actions));
 621
 622     n_ports = (len - sizeof *osf) / sizeof *osf->ports;
 623
 624     port_list = xmemdup(osf->ports, len - sizeof *osf);
 625     qsort(port_list, n_ports, sizeof *port_list, compare_ports);
 626     for (i = 0; i < n_ports; i++) {
 627         ofp_print_phy_port(string, &port_list[i]);
 628     }
 629     free(port_list);
 630 }
 631
 632 static void
 633 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
 634 {
 635     uint16_t flags;
 636
 637     flags = ntohs(osc->flags);
 638
 639     ds_put_cstr(string, " frags=");
 640     switch (flags & OFPC_FRAG_MASK) {
 641     case OFPC_FRAG_NORMAL:
 642         ds_put_cstr(string, "normal");
 643         flags &= ~OFPC_FRAG_MASK;
 644         break;
 645     case OFPC_FRAG_DROP:
 646         ds_put_cstr(string, "drop");
 647         flags &= ~OFPC_FRAG_MASK;
 648         break;
 649     case OFPC_FRAG_REASM:
 650         ds_put_cstr(string, "reassemble");
 651         flags &= ~OFPC_FRAG_MASK;
 652         break;
 653     }
 654     if (flags) {
 655         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 656     }
 657
 658     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 659 }
 660
 661 static void print_wild(struct ds *string, const char *leader, int is_wild,
 662             int verbosity, const char *format, ...)
 663             __attribute__((format(printf, 5, 6)));
 664
 665 static void print_wild(struct ds *string, const char *leader, int is_wild,
 666                        int verbosity, const char *format, ...)
 667 {
 668     if (is_wild && verbosity < 2) {
 669         return;
 670     }
 671     ds_put_cstr(string, leader);
 672     if (!is_wild) {
 673         va_list args;
 674
 675         va_start(args, format);
 676         ds_put_format_valist(string, format, args);
 677         va_end(args);
 678     } else {
 679         ds_put_char(string, '*');
 680     }
 681     ds_put_char(string, ',');
 682 }
 683
 684 static void
 685 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
 686                  uint32_t wild_bits, int verbosity)
 687 {
 688     if (wild_bits >= 32 && verbosity < 2) {
 689         return;
 690     }
 691     ds_put_cstr(string, leader);
 692     if (wild_bits < 32) {
 693         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 694         if (wild_bits) {
 695             ds_put_format(string, "/%d", 32 - wild_bits);
 696         }
 697     } else {
 698         ds_put_char(string, '*');
 699     }
 700     ds_put_char(string, ',');
 701 }
 702
 703 void
 704 ofp_print_match(struct ds *f, const struct ofp_match *om, int verbosity)
 705 {
 706     char *s = ofp_match_to_string(om, verbosity);
 707     ds_put_cstr(f, s);
 708     free(s);
 709 }
 710
 711 char *
 712 ofp_match_to_string(const struct ofp_match *om, int verbosity)
 713 {
 714     struct ds f = DS_EMPTY_INITIALIZER;
 715     uint32_t w = ntohl(om->wildcards);
 716     bool skip_type = false;
 717     bool skip_proto = false;
 718
 719     if (!(w & OFPFW_DL_TYPE)) {
 720         skip_type = true;
 721         if (om->dl_type == htons(ETH_TYPE_IP)) {
 722             if (!(w & OFPFW_NW_PROTO)) {
 723                 skip_proto = true;
 724                 if (om->nw_proto == IPPROTO_ICMP) {
 725                     ds_put_cstr(&f, "icmp,");
 726                 } else if (om->nw_proto == IPPROTO_TCP) {
 727                     ds_put_cstr(&f, "tcp,");
 728                 } else if (om->nw_proto == IPPROTO_UDP) {
 729                     ds_put_cstr(&f, "udp,");
 730                 } else {
 731                     ds_put_cstr(&f, "ip,");
 732                     skip_proto = false;
 733                 }
 734             } else {
 735                 ds_put_cstr(&f, "ip,");
 736             }
 737         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 738             ds_put_cstr(&f, "arp,");
 739         } else {
 740             skip_type = false;
 741         }
 742     }
 743     print_wild(&f, "in_port=", w & OFPFW_IN_PORT, verbosity,
 744                "%d", ntohs(om->in_port));
 745     print_wild(&f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
 746                "%d", ntohs(om->dl_vlan));
 747     print_wild(&f, "dl_vlan_pcp=", w & OFPFW_DL_VLAN_PCP, verbosity,
 748                "%d", om->dl_vlan_pcp);
 749     print_wild(&f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
 750                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 751     print_wild(&f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
 752                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 753     if (!skip_type) {
 754         print_wild(&f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
 755                    "0x%04x", ntohs(om->dl_type));
 756     }
 757     print_ip_netmask(&f, "nw_src=", om->nw_src,
 758                      (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
 759     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
 760                      (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
 761     if (!skip_proto) {
 762         if (om->dl_type == htons(ETH_TYPE_ARP)) {
 763             print_wild(&f, "arp_op=", w & OFPFW_NW_PROTO, verbosity,
 764                        "%u", om->nw_proto);
 765         } else {
 766             print_wild(&f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
 767                        "%u", om->nw_proto);
 768         }
 769     }
 770     print_wild(&f, "nw_tos=", w & OFPFW_NW_TOS, verbosity,
 771                "%u", om->nw_tos);
 772     if (om->nw_proto == IPPROTO_ICMP) {
 773         print_wild(&f, "icmp_type=", w & OFPFW_ICMP_TYPE, verbosity,
 774                    "%d", ntohs(om->icmp_type));
 775         print_wild(&f, "icmp_code=", w & OFPFW_ICMP_CODE, verbosity,
 776                    "%d", ntohs(om->icmp_code));
 777     } else {
 778         print_wild(&f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
 779                    "%d", ntohs(om->tp_src));
 780         print_wild(&f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
 781                    "%d", ntohs(om->tp_dst));
 782     }
 783     if (ds_last(&f) == ',') {
 784         f.length--;
 785     }
 786     return ds_cstr(&f);
 787 }
 788
 789 static void
 790 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh,
 791                    enum ofputil_msg_code code, int verbosity)
 792 {
 793     struct ofputil_flow_mod fm;
 794     bool need_priority;
 795     int error;
 796
 797     error = ofputil_decode_flow_mod(&fm, oh, true);
 798     if (error) {
 799         ofp_print_error(s, error);
 800         return;
 801     }
 802
 803     ds_put_char(s, ' ');
 804     switch (fm.command) {
 805     case OFPFC_ADD:
 806         ds_put_cstr(s, "ADD");
 807         break;
 808     case OFPFC_MODIFY:
 809         ds_put_cstr(s, "MOD");
 810         break;
 811     case OFPFC_MODIFY_STRICT:
 812         ds_put_cstr(s, "MOD_STRICT");
 813         break;
 814     case OFPFC_DELETE:
 815         ds_put_cstr(s, "DEL");
 816         break;
 817     case OFPFC_DELETE_STRICT:
 818         ds_put_cstr(s, "DEL_STRICT");
 819         break;
 820     default:
 821         ds_put_format(s, "cmd:%d", fm.command);
 822     }
 823     if (fm.table_id != 0) {
 824         ds_put_format(s, " table:%d", fm.table_id);
 825     }
 826
 827     ds_put_char(s, ' ');
 828     if (verbosity >= 3 && code == OFPUTIL_OFPT_FLOW_MOD) {
 829         const struct ofp_flow_mod *ofm = (const struct ofp_flow_mod *) oh;
 830         ofp_print_match(s, &ofm->match, verbosity);
 831
 832         /* ofp_print_match() doesn't print priority. */
 833         need_priority = true;
 834     } else if (verbosity >= 3 && code == OFPUTIL_NXT_FLOW_MOD) {
 835         const struct nx_flow_mod *nfm = (const struct nx_flow_mod *) oh;
 836         const void *nxm = nfm + 1;
 837         char *nxm_s;
 838
 839         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 840         ds_put_cstr(s, nxm_s);
 841         free(nxm_s);
 842
 843         /* nx_match_to_string() doesn't print priority. */
 844         need_priority = true;
 845     } else {
 846         cls_rule_format(&fm.cr, s);
 847
 848         /* cls_rule_format() does print priority. */
 849         need_priority = false;
 850     }
 851
 852     if (ds_last(s) != ' ') {
 853         ds_put_char(s, ' ');
 854     }
 855     if (fm.cookie != htonll(0)) {
 856         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.cookie));
 857     }
 858     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 859         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 860     }
 861     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 862         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 863     }
 864     if (fm.cr.priority != OFP_DEFAULT_PRIORITY && need_priority) {
 865         ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
 866     }
 867     if (fm.buffer_id != UINT32_MAX) {
 868         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 869     }
 870     if (fm.flags != 0) {
 871         ds_put_format(s, "flags:0x%"PRIx16" ", fm.flags);
 872     }
 873
 874     ofp_print_actions(s, fm.actions, fm.n_actions);
 875 }
 876
 877 static void
 878 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 879 {
 880     ds_put_format(string, "%u", sec);
 881     if (nsec > 0) {
 882         ds_put_format(string, ".%09u", nsec);
 883         while (string->string[string->length - 1] == '0') {
 884             string->length--;
 885         }
 886     }
 887     ds_put_char(string, 's');
 888 }
 889
 890 static void
 891 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 892 {
 893     struct ofputil_flow_removed fr;
 894     int 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     cls_rule_format(&fr.rule, string);
 904
 905     ds_put_cstr(string, " reason=");
 906     switch (fr.reason) {
 907     case OFPRR_IDLE_TIMEOUT:
 908         ds_put_cstr(string, "idle");
 909         break;
 910     case OFPRR_HARD_TIMEOUT:
 911         ds_put_cstr(string, "hard");
 912         break;
 913     case OFPRR_DELETE:
 914         ds_put_cstr(string, "delete");
 915         break;
 916     default:
 917         ds_put_format(string, "**%"PRIu8"**", fr.reason);
 918         break;
 919     }
 920
 921     if (fr.cookie != htonll(0)) {
 922         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 923     }
 924     ds_put_cstr(string, " duration");
 925     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 926     ds_put_format(string, " idle%"PRIu16" pkts%"PRIu64" bytes%"PRIu64"\n",
 927          fr.idle_timeout, fr.packet_count, fr.byte_count);
 928 }
 929
 930 static void
 931 ofp_print_port_mod(struct ds *string, const struct ofp_port_mod *opm)
 932 {
 933     ds_put_format(string, "port: %d: addr:"ETH_ADDR_FMT", config: %#x, mask:%#x\n",
 934             ntohs(opm->port_no), ETH_ADDR_ARGS(opm->hw_addr),
 935             ntohl(opm->config), ntohl(opm->mask));
 936     ds_put_format(string, "     advertise: ");
 937     if (opm->advertise) {
 938         ofp_print_port_features(string, ntohl(opm->advertise));
 939     } else {
 940         ds_put_format(string, "UNCHANGED\n");
 941     }
 942 }
 943
 944 static void
 945 ofp_print_error(struct ds *string, int error)
 946 {
 947     if (string->length) {
 948         ds_put_char(string, ' ');
 949     }
 950     ds_put_cstr(string, "***decode error: ");
 951     ofputil_format_error(string, error);
 952     ds_put_cstr(string, "***\n");
 953 }
 954
 955 static void
 956 ofp_print_error_msg(struct ds *string, const struct ofp_error_msg *oem)
 957 {
 958     size_t len = ntohs(oem->header.length);
 959     size_t payload_ofs, payload_len;
 960     const void *payload;
 961     int error;
 962     char *s;
 963
 964     error = ofputil_decode_error_msg(&oem->header, &payload_ofs);
 965     if (!is_ofp_error(error)) {
 966         ofp_print_error(string, error);
 967         ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
 968         return;
 969     }
 970
 971     ds_put_char(string, ' ');
 972     ofputil_format_error(string, error);
 973     ds_put_char(string, '\n');
 974
 975     payload = (const uint8_t *) oem + payload_ofs;
 976     payload_len = len - payload_ofs;
 977     switch (get_ofp_err_type(error)) {
 978     case OFPET_HELLO_FAILED:
 979         ds_put_printable(string, payload, payload_len);
 980         break;
 981
 982     case OFPET_BAD_REQUEST:
 983         s = ofp_to_string(payload, payload_len, 1);
 984         ds_put_cstr(string, s);
 985         free(s);
 986         break;
 987
 988     default:
 989         ds_put_hex_dump(string, payload, payload_len, 0, true);
 990         break;
 991     }
 992 }
 993
 994 static void
 995 ofp_print_port_status(struct ds *string, const struct ofp_port_status *ops)
 996 {
 997     if (ops->reason == OFPPR_ADD) {
 998         ds_put_format(string, " ADD:");
 999     } else if (ops->reason == OFPPR_DELETE) {
1000         ds_put_format(string, " DEL:");
1001     } else if (ops->reason == OFPPR_MODIFY) {
1002         ds_put_format(string, " MOD:");
1003     }
1004
1005     ofp_print_phy_port(string, &ops->desc);
1006 }
1007
1008 static void
1009 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_desc_stats *ods)
1010 {
1011     ds_put_char(string, '\n');
1012     ds_put_format(string, "Manufacturer: %.*s\n",
1013             (int) sizeof ods->mfr_desc, ods->mfr_desc);
1014     ds_put_format(string, "Hardware: %.*s\n",
1015             (int) sizeof ods->hw_desc, ods->hw_desc);
1016     ds_put_format(string, "Software: %.*s\n",
1017             (int) sizeof ods->sw_desc, ods->sw_desc);
1018     ds_put_format(string, "Serial Num: %.*s\n",
1019             (int) sizeof ods->serial_num, ods->serial_num);
1020     ds_put_format(string, "DP Description: %.*s\n",
1021             (int) sizeof ods->dp_desc, ods->dp_desc);
1022 }
1023
1024 static void
1025 ofp_print_flow_stats_request(struct ds *string,
1026                              const struct ofp_stats_msg *osm)
1027 {
1028     struct ofputil_flow_stats_request fsr;
1029     int error;
1030
1031     error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
1032     if (error) {
1033         ofp_print_error(string, error);
1034         return;
1035     }
1036
1037     if (fsr.table_id != 0xff) {
1038         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1039     }
1040
1041     if (fsr.out_port != OFPP_NONE) {
1042         ds_put_cstr(string, " out_port=");
1043         ofp_print_port_name(string, fsr.out_port);
1044     }
1045
1046     /* A flow stats request doesn't include a priority, but cls_rule_format()
1047      * will print one unless it is OFP_DEFAULT_PRIORITY. */
1048     fsr.match.priority = OFP_DEFAULT_PRIORITY;
1049
1050     ds_put_char(string, ' ');
1051     cls_rule_format(&fsr.match, string);
1052 }
1053
1054 static void
1055 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1056 {
1057     struct ofpbuf b;
1058
1059     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1060     for (;;) {
1061         struct ofputil_flow_stats fs;
1062         int retval;
1063
1064         retval = ofputil_decode_flow_stats_reply(&fs, &b);
1065         if (retval) {
1066             if (retval != EOF) {
1067                 ds_put_cstr(string, " ***parse error***");
1068             }
1069             break;
1070         }
1071
1072         ds_put_char(string, '\n');
1073
1074         ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1075                       ntohll(fs.cookie));
1076         ofp_print_duration(string, fs.duration_sec, fs.duration_nsec);
1077         ds_put_format(string, ", table=%"PRIu8", ", fs.table_id);
1078         ds_put_format(string, "n_packets=%"PRIu64", ", fs.packet_count);
1079         ds_put_format(string, "n_bytes=%"PRIu64", ", fs.byte_count);
1080         if (fs.idle_timeout != OFP_FLOW_PERMANENT) {
1081             ds_put_format(string, "idle_timeout=%"PRIu16",", fs.idle_timeout);
1082         }
1083         if (fs.hard_timeout != OFP_FLOW_PERMANENT) {
1084             ds_put_format(string, "hard_timeout=%"PRIu16",", fs.hard_timeout);
1085         }
1086
1087         cls_rule_format(&fs.rule, string);
1088         ds_put_char(string, ' ');
1089         ofp_print_actions(string, fs.actions, fs.n_actions);
1090      }
1091 }
1092
1093 static void
1094 ofp_print_ofpst_aggregate_reply(struct ds *string,
1095                                 const struct ofp_aggregate_stats_reply *asr)
1096 {
1097     ds_put_format(string, " packet_count=%"PRIu64,
1098                   ntohll(get_32aligned_be64(&asr->packet_count)));
1099     ds_put_format(string, " byte_count=%"PRIu64,
1100                   ntohll(get_32aligned_be64(&asr->byte_count)));
1101     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
1102 }
1103
1104 static void
1105 ofp_print_nxst_aggregate_reply(struct ds *string,
1106                                const struct nx_aggregate_stats_reply *nasr)
1107 {
1108     ds_put_format(string, " packet_count=%"PRIu64, ntohll(nasr->packet_count));
1109     ds_put_format(string, " byte_count=%"PRIu64, ntohll(nasr->byte_count));
1110     ds_put_format(string, " flow_count=%"PRIu32, ntohl(nasr->flow_count));
1111 }
1112
1113 static void print_port_stat(struct ds *string, const char *leader,
1114                             const ovs_32aligned_be64 *statp, int more)
1115 {
1116     uint64_t stat = ntohll(get_32aligned_be64(statp));
1117
1118     ds_put_cstr(string, leader);
1119     if (stat != UINT64_MAX) {
1120         ds_put_format(string, "%"PRIu64, stat);
1121     } else {
1122         ds_put_char(string, '?');
1123     }
1124     if (more) {
1125         ds_put_cstr(string, ", ");
1126     } else {
1127         ds_put_cstr(string, "\n");
1128     }
1129 }
1130
1131 static void
1132 ofp_print_ofpst_port_request(struct ds *string,
1133                              const struct ofp_port_stats_request *psr)
1134 {
1135     ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1136 }
1137
1138 static void
1139 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1140                            int verbosity)
1141 {
1142     const struct ofp_port_stats *ps = ofputil_stats_body(oh);
1143     size_t n = ofputil_stats_body_len(oh) / sizeof *ps;
1144     ds_put_format(string, " %zu ports\n", n);
1145     if (verbosity < 1) {
1146         return;
1147     }
1148
1149     for (; n--; ps++) {
1150         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
1151
1152         ds_put_cstr(string, "rx ");
1153         print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1154         print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1155         print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1156         print_port_stat(string, "errs=", &ps->rx_errors, 1);
1157         print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1158         print_port_stat(string, "over=", &ps->rx_over_err, 1);
1159         print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1160
1161         ds_put_cstr(string, "           tx ");
1162         print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1163         print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1164         print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1165         print_port_stat(string, "errs=", &ps->tx_errors, 1);
1166         print_port_stat(string, "coll=", &ps->collisions, 0);
1167     }
1168 }
1169
1170 static void
1171 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1172                             int verbosity)
1173 {
1174     const struct ofp_table_stats *ts = ofputil_stats_body(oh);
1175     size_t n = ofputil_stats_body_len(oh) / sizeof *ts;
1176     ds_put_format(string, " %zu tables\n", n);
1177     if (verbosity < 1) {
1178         return;
1179     }
1180
1181     for (; n--; ts++) {
1182         char name[OFP_MAX_TABLE_NAME_LEN + 1];
1183         ovs_strlcpy(name, ts->name, sizeof name);
1184
1185         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
1186         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1187         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1188         ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1189         ds_put_cstr(string, "               ");
1190         ds_put_format(string, "lookup=%"PRIu64", ",
1191                       ntohll(get_32aligned_be64(&ts->lookup_count)));
1192         ds_put_format(string, "matched=%"PRIu64"\n",
1193                       ntohll(get_32aligned_be64(&ts->matched_count)));
1194      }
1195 }
1196
1197 static void
1198 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1199 {
1200     if (queue_id == OFPQ_ALL) {
1201         ds_put_cstr(string, "ALL");
1202     } else {
1203         ds_put_format(string, "%"PRIu32, queue_id);
1204     }
1205 }
1206
1207 static void
1208 ofp_print_ofpst_queue_request(struct ds *string,
1209                               const struct ofp_queue_stats_request *qsr)
1210 {
1211     ds_put_cstr(string, "port=");
1212     ofp_print_port_name(string, ntohs(qsr->port_no));
1213
1214     ds_put_cstr(string, " queue=");
1215     ofp_print_queue_name(string, ntohl(qsr->queue_id));
1216 }
1217
1218 static void
1219 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1220                             int verbosity)
1221 {
1222     const struct ofp_queue_stats *qs = ofputil_stats_body(oh);
1223     size_t n = ofputil_stats_body_len(oh) / sizeof *qs;
1224     ds_put_format(string, " %zu queues\n", n);
1225     if (verbosity < 1) {
1226         return;
1227     }
1228
1229     for (; n--; qs++) {
1230         ds_put_cstr(string, "  port ");
1231         ofp_print_port_name(string, ntohs(qs->port_no));
1232         ds_put_cstr(string, " queue ");
1233         ofp_print_queue_name(string, ntohl(qs->queue_id));
1234         ds_put_cstr(string, ": ");
1235
1236         print_port_stat(string, "bytes=", &qs->tx_bytes, 1);
1237         print_port_stat(string, "pkts=", &qs->tx_packets, 1);
1238         print_port_stat(string, "errors=", &qs->tx_errors, 0);
1239     }
1240 }
1241
1242 static void
1243 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1244 {
1245     const struct ofp_stats_msg *srq = (const struct ofp_stats_msg *) oh;
1246
1247     if (srq->flags) {
1248         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
1249                       ntohs(srq->flags));
1250     }
1251 }
1252
1253 static void
1254 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1255 {
1256     const struct ofp_stats_msg *srp = (const struct ofp_stats_msg *) oh;
1257
1258     if (srp->flags) {
1259         uint16_t flags = ntohs(srp->flags);
1260
1261         ds_put_cstr(string, " flags=");
1262         if (flags & OFPSF_REPLY_MORE) {
1263             ds_put_cstr(string, "[more]");
1264             flags &= ~OFPSF_REPLY_MORE;
1265         }
1266         if (flags) {
1267             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1268                           flags);
1269         }
1270     }
1271 }
1272
1273 static void
1274 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1275 {
1276     size_t len = ntohs(oh->length);
1277
1278     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1279     if (verbosity > 1) {
1280         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1281     }
1282 }
1283
1284 static void
1285 ofp_print_nxt_role_message(struct ds *string,
1286                            const struct nx_role_request *nrr)
1287 {
1288     unsigned int role = ntohl(nrr->role);
1289
1290     ds_put_cstr(string, " role=");
1291     if (role == NX_ROLE_OTHER) {
1292         ds_put_cstr(string, "other");
1293     } else if (role == NX_ROLE_MASTER) {
1294         ds_put_cstr(string, "master");
1295     } else if (role == NX_ROLE_SLAVE) {
1296         ds_put_cstr(string, "slave");
1297     } else {
1298         ds_put_format(string, "%u", role);
1299     }
1300 }
1301
1302 static void
1303 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1304                                 const struct nxt_flow_mod_table_id *nfmti)
1305 {
1306     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1307 }
1308
1309 static void
1310 ofp_print_nxt_set_flow_format(struct ds *string,
1311                               const struct nxt_set_flow_format *nsff)
1312 {
1313     uint32_t format = ntohl(nsff->format);
1314
1315     ds_put_cstr(string, " format=");
1316     if (ofputil_flow_format_is_valid(format)) {
1317         ds_put_cstr(string, ofputil_flow_format_to_string(format));
1318     } else {
1319         ds_put_format(string, "%"PRIu32, format);
1320     }
1321 }
1322
1323 static void
1324 ofp_to_string__(const struct ofp_header *oh,
1325                 const struct ofputil_msg_type *type, struct ds *string,
1326                 int verbosity)
1327 {
1328     enum ofputil_msg_code code;
1329     const void *msg = oh;
1330
1331     ds_put_format(string, "%s (xid=0x%"PRIx32"):",
1332                   ofputil_msg_type_name(type), ntohl(oh->xid));
1333
1334     code = ofputil_msg_type_code(type);
1335     switch (code) {
1336     case OFPUTIL_MSG_INVALID:
1337         break;
1338
1339     case OFPUTIL_OFPT_HELLO:
1340         ds_put_char(string, '\n');
1341         ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1342                         0, true);
1343         break;
1344
1345     case OFPUTIL_OFPT_ERROR:
1346         ofp_print_error_msg(string, msg);
1347         break;
1348
1349     case OFPUTIL_OFPT_ECHO_REQUEST:
1350     case OFPUTIL_OFPT_ECHO_REPLY:
1351         ofp_print_echo(string, oh, verbosity);
1352         break;
1353
1354     case OFPUTIL_OFPT_FEATURES_REQUEST:
1355         break;
1356
1357     case OFPUTIL_OFPT_FEATURES_REPLY:
1358         ofp_print_switch_features(string, msg);
1359         break;
1360
1361     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
1362         break;
1363
1364     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
1365     case OFPUTIL_OFPT_SET_CONFIG:
1366         ofp_print_switch_config(string, msg);
1367         break;
1368
1369     case OFPUTIL_OFPT_PACKET_IN:
1370         ofp_print_packet_in(string, msg, verbosity);
1371         break;
1372
1373     case OFPUTIL_OFPT_FLOW_REMOVED:
1374     case OFPUTIL_NXT_FLOW_REMOVED:
1375         ofp_print_flow_removed(string, msg);
1376         break;
1377
1378     case OFPUTIL_OFPT_PORT_STATUS:
1379         ofp_print_port_status(string, msg);
1380         break;
1381
1382     case OFPUTIL_OFPT_PACKET_OUT:
1383         ofp_print_packet_out(string, msg, verbosity);
1384         break;
1385
1386     case OFPUTIL_OFPT_FLOW_MOD:
1387         ofp_print_flow_mod(string, msg, code, verbosity);
1388         break;
1389
1390     case OFPUTIL_OFPT_PORT_MOD:
1391         ofp_print_port_mod(string, msg);
1392         break;
1393
1394     case OFPUTIL_OFPT_BARRIER_REQUEST:
1395     case OFPUTIL_OFPT_BARRIER_REPLY:
1396         break;
1397
1398     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
1399     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
1400         /* XXX */
1401         break;
1402
1403     case OFPUTIL_OFPST_DESC_REQUEST:
1404         ofp_print_stats_request(string, oh);
1405         break;
1406
1407     case OFPUTIL_OFPST_FLOW_REQUEST:
1408     case OFPUTIL_NXST_FLOW_REQUEST:
1409     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1410     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1411         ofp_print_stats_request(string, oh);
1412         ofp_print_flow_stats_request(string, msg);
1413         break;
1414
1415     case OFPUTIL_OFPST_TABLE_REQUEST:
1416         ofp_print_stats_request(string, oh);
1417         break;
1418
1419     case OFPUTIL_OFPST_PORT_REQUEST:
1420         ofp_print_stats_request(string, oh);
1421         ofp_print_ofpst_port_request(string, msg);
1422         break;
1423
1424     case OFPUTIL_OFPST_QUEUE_REQUEST:
1425         ofp_print_stats_request(string, oh);
1426         ofp_print_ofpst_queue_request(string, msg);
1427         break;
1428
1429     case OFPUTIL_OFPST_DESC_REPLY:
1430         ofp_print_stats_reply(string, oh);
1431         ofp_print_ofpst_desc_reply(string, msg);
1432         break;
1433
1434     case OFPUTIL_OFPST_FLOW_REPLY:
1435     case OFPUTIL_NXST_FLOW_REPLY:
1436         ofp_print_stats_reply(string, oh);
1437         ofp_print_flow_stats_reply(string, oh);
1438         break;
1439
1440     case OFPUTIL_OFPST_QUEUE_REPLY:
1441         ofp_print_stats_reply(string, oh);
1442         ofp_print_ofpst_queue_reply(string, oh, verbosity);
1443         break;
1444
1445     case OFPUTIL_OFPST_PORT_REPLY:
1446         ofp_print_stats_reply(string, oh);
1447         ofp_print_ofpst_port_reply(string, oh, verbosity);
1448         break;
1449
1450     case OFPUTIL_OFPST_TABLE_REPLY:
1451         ofp_print_stats_reply(string, oh);
1452         ofp_print_ofpst_table_reply(string, oh, verbosity);
1453         break;
1454
1455     case OFPUTIL_OFPST_AGGREGATE_REPLY:
1456         ofp_print_stats_reply(string, oh);
1457         ofp_print_ofpst_aggregate_reply(string, msg);
1458         break;
1459
1460     case OFPUTIL_NXT_ROLE_REQUEST:
1461     case OFPUTIL_NXT_ROLE_REPLY:
1462         ofp_print_nxt_role_message(string, msg);
1463         break;
1464
1465     case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
1466         ofp_print_nxt_flow_mod_table_id(string, msg);
1467         break;
1468
1469     case OFPUTIL_NXT_SET_FLOW_FORMAT:
1470         ofp_print_nxt_set_flow_format(string, msg);
1471         break;
1472
1473     case OFPUTIL_NXT_FLOW_MOD:
1474         ofp_print_flow_mod(string, msg, code, verbosity);
1475         break;
1476
1477     case OFPUTIL_NXST_AGGREGATE_REPLY:
1478         ofp_print_stats_reply(string, oh);
1479         ofp_print_nxst_aggregate_reply(string, msg);
1480         break;
1481     }
1482 }
1483
1484 /* Composes and returns a string representing the OpenFlow packet of 'len'
1485  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1486  * verbosity and higher numbers increase verbosity.  The caller is responsible
1487  * for freeing the string. */
1488 char *
1489 ofp_to_string(const void *oh_, size_t len, int verbosity)
1490 {
1491     struct ds string = DS_EMPTY_INITIALIZER;
1492     const struct ofp_header *oh = oh_;
1493
1494     if (!len) {
1495         ds_put_cstr(&string, "OpenFlow message is empty\n");
1496     } else if (len < sizeof(struct ofp_header)) {
1497         ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1498                       len);
1499     } else if (oh->version != OFP_VERSION) {
1500         ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n",
1501                       oh->version);
1502     } else if (ntohs(oh->length) > len) {
1503         ds_put_format(&string,
1504                       "(***truncated to %zu bytes from %"PRIu16"***)\n",
1505                       len, ntohs(oh->length));
1506     } else if (ntohs(oh->length) < len) {
1507         ds_put_format(&string,
1508                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
1509                       ntohs(oh->length), len);
1510     } else {
1511         const struct ofputil_msg_type *type;
1512         int error;
1513
1514         error = ofputil_decode_msg_type(oh, &type);
1515         if (!error) {
1516             ofp_to_string__(oh, type, &string, verbosity);
1517             if (verbosity >= 5) {
1518                 if (ds_last(&string) != '\n') {
1519                     ds_put_char(&string, '\n');
1520                 }
1521                 ds_put_hex_dump(&string, oh, len, 0, true);
1522             }
1523             if (ds_last(&string) != '\n') {
1524                 ds_put_char(&string, '\n');
1525             }
1526             return ds_steal_cstr(&string);
1527         }
1528
1529         ofp_print_error(&string, error);
1530     }
1531     ds_put_hex_dump(&string, oh, len, 0, true);
1532     return ds_steal_cstr(&string);
1533 }
1534
1535 /* Returns the name for the specified OpenFlow message type as a string,
1536  * e.g. "OFPT_FEATURES_REPLY".  If no name is known, the string returned is a
1537  * hex number, e.g. "0x55".
1538  *
1539  * The caller must free the returned string when it is no longer needed. */
1540 char *
1541 ofp_message_type_to_string(uint8_t type)
1542 {
1543     const char *name;
1544
1545     switch (type) {
1546     case OFPT_HELLO:
1547         name = "HELLO";
1548         break;
1549     case OFPT_ERROR:
1550         name = "ERROR";
1551         break;
1552     case OFPT_ECHO_REQUEST:
1553         name = "ECHO_REQUEST";
1554         break;
1555     case OFPT_ECHO_REPLY:
1556         name = "ECHO_REPLY";
1557         break;
1558     case OFPT_VENDOR:
1559         name = "VENDOR";
1560         break;
1561     case OFPT_FEATURES_REQUEST:
1562         name = "FEATURES_REQUEST";
1563         break;
1564     case OFPT_FEATURES_REPLY:
1565         name = "FEATURES_REPLY";
1566         break;
1567     case OFPT_GET_CONFIG_REQUEST:
1568         name = "GET_CONFIG_REQUEST";
1569         break;
1570     case OFPT_GET_CONFIG_REPLY:
1571         name = "GET_CONFIG_REPLY";
1572         break;
1573     case OFPT_SET_CONFIG:
1574         name = "SET_CONFIG";
1575         break;
1576     case OFPT_PACKET_IN:
1577         name = "PACKET_IN";
1578         break;
1579     case OFPT_FLOW_REMOVED:
1580         name = "FLOW_REMOVED";
1581         break;
1582     case OFPT_PORT_STATUS:
1583         name = "PORT_STATUS";
1584         break;
1585     case OFPT_PACKET_OUT:
1586         name = "PACKET_OUT";
1587         break;
1588     case OFPT_FLOW_MOD:
1589         name = "FLOW_MOD";
1590         break;
1591     case OFPT_PORT_MOD:
1592         name = "PORT_MOD";
1593         break;
1594     case OFPT_STATS_REQUEST:
1595         name = "STATS_REQUEST";
1596         break;
1597     case OFPT_STATS_REPLY:
1598         name = "STATS_REPLY";
1599         break;
1600     case OFPT_BARRIER_REQUEST:
1601         name = "BARRIER_REQUEST";
1602         break;
1603     case OFPT_BARRIER_REPLY:
1604         name = "BARRIER_REPLY";
1605         break;
1606     case OFPT_QUEUE_GET_CONFIG_REQUEST:
1607         name = "QUEUE_GET_CONFIG_REQUEST";
1608         break;
1609     case OFPT_QUEUE_GET_CONFIG_REPLY:
1610         name = "QUEUE_GET_CONFIG_REPLY";
1611         break;
1612     default:
1613         name = NULL;
1614         break;
1615     }
1616
1617     return name ? xasprintf("OFPT_%s", name) : xasprintf("0x%02"PRIx8, type);
1618 }
1619 \f
1620 static void
1621 print_and_free(FILE *stream, char *string)
1622 {
1623     fputs(string, stream);
1624     free(string);
1625 }
1626
1627 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1628  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1629  * numbers increase verbosity. */
1630 void
1631 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1632 {
1633     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1634 }
1635
1636 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1637  * 'data' to 'stream' using tcpdump.  'total_len' specifies the full length of
1638  * the Ethernet frame (of which 'len' bytes were captured).
1639  *
1640  * This starts and kills a tcpdump subprocess so it's quite expensive. */
1641 void
1642 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1643 {
1644     print_and_free(stream, ofp_packet_to_string(data, len, total_len));
1645 }