lib/ofp-print.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include "ofp-print.h"
  35 #include "xtoxll.h"
  36
  37 #include <errno.h>
  38 #include <inttypes.h>
  39 #include <netinet/in.h>
  40 #include <sys/wait.h>
  41 #include <stdarg.h>
  42 #include <stdlib.h>
  43 #include <ctype.h>
  44
  45 #include "compiler.h"
  46 #include "dynamic-string.h"
  47 #include "util.h"
  48 #include "openflow.h"
  49 #include "packets.h"
  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)
  61 {
  62     struct pcap_hdr {
  63         uint32_t magic_number;   /* magic number */
  64         uint16_t version_major;  /* major version number */
  65         uint16_t version_minor;  /* minor version number */
  66         int32_t thiszone;        /* GMT to local correction */
  67         uint32_t sigfigs;        /* accuracy of timestamps */
  68         uint32_t snaplen;        /* max length of captured packets */
  69         uint32_t network;        /* data link type */
  70     } PACKED;
  71
  72     struct pcaprec_hdr {
  73         uint32_t ts_sec;         /* timestamp seconds */
  74         uint32_t ts_usec;        /* timestamp microseconds */
  75         uint32_t incl_len;       /* number of octets of packet saved in file */
  76         uint32_t orig_len;       /* actual length of packet */
  77     } PACKED;
  78
  79     struct pcap_hdr ph;
  80     struct pcaprec_hdr prh;
  81
  82     struct ds ds = DS_EMPTY_INITIALIZER;
  83
  84     char command[128];
  85     FILE *pcap;
  86     FILE *tcpdump;
  87     int status;
  88     int c;
  89
  90     pcap = tmpfile();
  91     if (!pcap) {
  92         error(errno, "tmpfile");
  93         return xstrdup("<error>");
  94     }
  95
  96     /* The pcap reader is responsible for figuring out endianness based on the
  97      * magic number, so the lack of htonX calls here is intentional. */
  98     ph.magic_number = 0xa1b2c3d4;
  99     ph.version_major = 2;
 100     ph.version_minor = 4;
 101     ph.thiszone = 0;
 102     ph.sigfigs = 0;
 103     ph.snaplen = 1518;
 104     ph.network = 1;             /* Ethernet */
 105
 106     prh.ts_sec = 0;
 107     prh.ts_usec = 0;
 108     prh.incl_len = len;
 109     prh.orig_len = total_len;
 110
 111     fwrite(&ph, 1, sizeof ph, pcap);
 112     fwrite(&prh, 1, sizeof prh, pcap);
 113     fwrite(data, 1, len, pcap);
 114
 115     fflush(pcap);
 116     if (ferror(pcap)) {
 117         error(errno, "error writing temporary file");
 118     }
 119     rewind(pcap);
 120
 121     snprintf(command, sizeof command, "tcpdump -n -r /dev/fd/%d 2>/dev/null",
 122              fileno(pcap));
 123     tcpdump = popen(command, "r");
 124     fclose(pcap);
 125     if (!tcpdump) {
 126         error(errno, "exec(\"%s\")", command);
 127         return xstrdup("<error>");
 128     }
 129
 130     while ((c = getc(tcpdump)) != EOF) {
 131         ds_put_char(&ds, c);
 132     }
 133
 134     status = pclose(tcpdump);
 135     if (WIFEXITED(status)) {
 136         if (WEXITSTATUS(status))
 137             error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
 138     } else if (WIFSIGNALED(status)) {
 139         error(0, "tcpdump exited with signal %d", WTERMSIG(status));
 140     }
 141     return ds_cstr(&ds);
 142 }
 143
 144 /* Pretty-print the OFPT_PACKET_IN packet of 'len' bytes at 'oh' to 'stream'
 145  * at the given 'verbosity' level. */
 146 static void
 147 ofp_packet_in(struct ds *string, const void *oh, size_t len, int verbosity)
 148 {
 149     const struct ofp_packet_in *op = oh;
 150     size_t data_len;
 151
 152     ds_put_format(string, " total_len=%"PRIu16" in_port=%"PRIu8,
 153             ntohs(op->total_len), ntohs(op->in_port));
 154
 155     if (op->reason == OFPR_ACTION)
 156         ds_put_cstr(string, " (via action)");
 157     else if (op->reason != OFPR_NO_MATCH)
 158         ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
 159
 160     data_len = len - offsetof(struct ofp_packet_in, data);
 161     ds_put_format(string, " data_len=%zu", data_len);
 162     if (htonl(op->buffer_id) == UINT32_MAX) {
 163         ds_put_format(string, " (unbuffered)");
 164         if (ntohs(op->total_len) != data_len)
 165             ds_put_format(string, " (***total_len != data_len***)");
 166     } else {
 167         ds_put_format(string, " buffer=%08"PRIx32, ntohl(op->buffer_id));
 168         if (ntohs(op->total_len) < data_len)
 169             ds_put_format(string, " (***total_len < data_len***)");
 170     }
 171     ds_put_char(string, '\n');
 172
 173     if (verbosity > 0) {
 174         char *packet = ofp_packet_to_string(op->data, data_len,
 175                                             ntohs(op->total_len));
 176         ds_put_cstr(string, packet);
 177         free(packet);
 178     }
 179 }
 180
 181 static void ofp_print_port_name(struct ds *string, uint16_t port)
 182 {
 183     const char *name;
 184     switch (port) {
 185     case OFPP_TABLE:
 186         name = "TABLE";
 187         break;
 188     case OFPP_NORMAL:
 189         name = "NORMAL";
 190         break;
 191     case OFPP_FLOOD:
 192         name = "FLOOD";
 193         break;
 194     case OFPP_ALL:
 195         name = "ALL";
 196         break;
 197     case OFPP_CONTROLLER:
 198         name = "CONTROLLER";
 199         break;
 200     case OFPP_LOCAL:
 201         name = "LOCAL";
 202         break;
 203     case OFPP_NONE:
 204         name = "NONE";
 205         break;
 206     default:
 207         ds_put_format(string, "%"PRIu16, port);
 208         return;
 209     }
 210     ds_put_cstr(string, name);
 211 }
 212
 213 static void
 214 ofp_print_action(struct ds *string, const struct ofp_action *a)
 215 {
 216     switch (ntohs(a->type)) {
 217     case OFPAT_OUTPUT:
 218         ds_put_cstr(string, "output(");
 219         ofp_print_port_name(string, ntohs(a->arg.output.port));
 220         if (a->arg.output.port == htons(OFPP_CONTROLLER)) {
 221             ds_put_format(string, ", max %"PRIu16" bytes", ntohs(a->arg.output.max_len));
 222         }
 223         ds_put_cstr(string, ")");
 224         break;
 225
 226     default:
 227         ds_put_format(string, "(decoder %"PRIu16" not implemented)", ntohs(a->type));
 228         break;
 229     }
 230 }
 231
 232 static void ofp_print_actions(struct ds *string,
 233                               const struct ofp_action actions[],
 234                               size_t n_bytes)
 235 {
 236     size_t i;
 237
 238     ds_put_cstr(string, " actions[");
 239     for (i = 0; i < n_bytes / sizeof *actions; i++) {
 240         if (i) {
 241             ds_put_cstr(string, "; ");
 242         }
 243         ofp_print_action(string, &actions[i]);
 244     }
 245     if (n_bytes % sizeof *actions) {
 246         if (i) {
 247             ds_put_cstr(string, "; ");
 248         }
 249         ds_put_cstr(string, "; ***trailing garbage***");
 250     }
 251     ds_put_cstr(string, "]");
 252 }
 253
 254 /* Pretty-print the OFPT_PACKET_OUT packet of 'len' bytes at 'oh' to 'string'
 255  * at the given 'verbosity' level. */
 256 static void ofp_packet_out(struct ds *string, const void *oh, size_t len,
 257                            int verbosity)
 258 {
 259     const struct ofp_packet_out *opo = oh;
 260
 261     ds_put_cstr(string, " in_port=");
 262     ofp_print_port_name(string, ntohs(opo->in_port));
 263
 264     if (ntohl(opo->buffer_id) == UINT32_MAX) {
 265         ds_put_cstr(string, " out_port=");
 266         ofp_print_port_name(string, ntohs(opo->out_port));
 267         if (verbosity > 0 && len > sizeof *opo) {
 268             char *packet = ofp_packet_to_string(opo->u.data, len - sizeof *opo,
 269                                                 len - sizeof *opo);
 270             ds_put_cstr(string, packet);
 271             free(packet);
 272         }
 273     } else {
 274         ds_put_format(string, " buffer=%08"PRIx32, ntohl(opo->buffer_id));
 275         ofp_print_actions(string, opo->u.actions, len - sizeof *opo);
 276     }
 277     ds_put_char(string, '\n');
 278 }
 279
 280 /* qsort comparison function. */
 281 static int
 282 compare_ports(const void *a_, const void *b_)
 283 {
 284     const struct ofp_phy_port *a = a_;
 285     const struct ofp_phy_port *b = b_;
 286     uint16_t ap = ntohs(a->port_no);
 287     uint16_t bp = ntohs(b->port_no);
 288
 289     return ap < bp ? -1 : ap > bp;
 290 }
 291
 292 static void
 293 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
 294 {
 295     uint8_t name[OFP_MAX_PORT_NAME_LEN];
 296     int j;
 297
 298     memcpy(name, port->name, sizeof name);
 299     for (j = 0; j < sizeof name - 1; j++) {
 300         if (!isprint(name[j])) {
 301             break;
 302         }
 303     }
 304     name[j] = '\0';
 305
 306     ds_put_format(string, " %2d(%s): addr:"ETH_ADDR_FMT", speed:%d, flags:%#x, "
 307             "feat:%#x\n", ntohs(port->port_no), name,
 308             ETH_ADDR_ARGS(port->hw_addr), ntohl(port->speed),
 309             ntohl(port->flags), ntohl(port->features));
 310 }
 311
 312 /* Pretty-print the struct ofp_switch_features of 'len' bytes at 'oh' to
 313  * 'string' at the given 'verbosity' level. */
 314 static void
 315 ofp_print_switch_features(struct ds *string, const void *oh, size_t len,
 316                           int verbosity)
 317 {
 318     const struct ofp_switch_features *osf = oh;
 319     struct ofp_phy_port port_list[OFPP_MAX];
 320     int n_ports;
 321     int i;
 322
 323     ds_put_format(string, "dp id:%"PRIx64"\n", ntohll(osf->datapath_id));
 324     ds_put_format(string, "tables: exact:%d, compressed:%d, general:%d\n",
 325            ntohl(osf->n_exact),
 326            ntohl(osf->n_compression), ntohl(osf->n_general));
 327     ds_put_format(string, "buffers: size:%d, number:%d\n",
 328            ntohl(osf->buffer_mb), ntohl(osf->n_buffers));
 329     ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
 330            ntohl(osf->capabilities), ntohl(osf->actions));
 331
 332     if (ntohs(osf->header.length) >= sizeof *osf) {
 333         len = MIN(len, ntohs(osf->header.length));
 334     }
 335     n_ports = (len - sizeof *osf) / sizeof *osf->ports;
 336
 337     memcpy(port_list, osf->ports, (len - sizeof *osf));
 338     qsort(port_list, n_ports, sizeof port_list[0], compare_ports);
 339     for (i = 0; i < n_ports; i++) {
 340         ofp_print_phy_port(string, &port_list[i]);
 341     }
 342 }
 343
 344 /* Pretty-print the struct ofp_switch_config of 'len' bytes at 'oh' to 'string'
 345  * at the given 'verbosity' level. */
 346 static void
 347 ofp_print_switch_config(struct ds *string, const void *oh, size_t len,
 348                         int verbosity)
 349 {
 350     const struct ofp_switch_config *osc = oh;
 351     uint16_t flags;
 352
 353     flags = ntohs(osc->flags);
 354     if (flags & OFPC_SEND_FLOW_EXP) {
 355         flags &= ~OFPC_SEND_FLOW_EXP;
 356         ds_put_format(string, " (sending flow expirations)");
 357     }
 358     if (flags) {
 359         ds_put_format(string, " ***unknown flags %04"PRIx16"***", flags);
 360     }
 361
 362     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 363 }
 364
 365 static void print_wild(struct ds *string, const char *leader, int is_wild,
 366             const char *format, ...) __attribute__((format(printf, 4, 5)));
 367
 368 static void print_wild(struct ds *string, const char *leader, int is_wild,
 369                        const char *format, ...)
 370 {
 371     ds_put_cstr(string, leader);
 372     if (!is_wild) {
 373         va_list args;
 374
 375         va_start(args, format);
 376         ds_put_format_valist(string, format, args);
 377         va_end(args);
 378     } else {
 379         ds_put_char(string, '?');
 380     }
 381 }
 382
 383 /* Pretty-print the ofp_match structure */
 384 static void ofp_print_match(struct ds *f, const struct ofp_match *om)
 385 {
 386     uint16_t w = ntohs(om->wildcards);
 387
 388     print_wild(f, " inport", w & OFPFW_IN_PORT, "%d", ntohs(om->in_port));
 389     print_wild(f, ":vlan", w & OFPFW_DL_VLAN, "%04x", ntohs(om->dl_vlan));
 390     print_wild(f, " mac[", w & OFPFW_DL_SRC,
 391                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 392     print_wild(f, "->", w & OFPFW_DL_DST,
 393                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 394     print_wild(f, "] type", w & OFPFW_DL_TYPE, "%04x", ntohs(om->dl_type));
 395     print_wild(f, " ip[", w & OFPFW_NW_SRC, IP_FMT, IP_ARGS(&om->nw_src));
 396     print_wild(f, "->", w & OFPFW_NW_DST, IP_FMT, IP_ARGS(&om->nw_dst));
 397     print_wild(f, "] proto", w & OFPFW_NW_PROTO, "%u", om->nw_proto);
 398     print_wild(f, " tport[", w & OFPFW_TP_SRC, "%d", ntohs(om->tp_src));
 399     print_wild(f, "->", w & OFPFW_TP_DST, "%d", ntohs(om->tp_dst));
 400     ds_put_cstr(f, "]");
 401 }
 402
 403 /* Pretty-print the OFPT_FLOW_MOD packet of 'len' bytes at 'oh' to 'string'
 404  * at the given 'verbosity' level. */
 405 static void
 406 ofp_print_flow_mod(struct ds *string, const void *oh, size_t len,
 407                    int verbosity)
 408 {
 409     const struct ofp_flow_mod *ofm = oh;
 410
 411     ofp_print_match(string, &ofm->match);
 412     ds_put_format(string, " cmd:%d idle:%d pri:%d buf:%#x\n",
 413             ntohs(ofm->command), ntohs(ofm->max_idle),
 414             ofm->match.wildcards ? ntohs(ofm->priority) : (uint16_t)-1,
 415             ntohl(ofm->buffer_id));
 416 }
 417
 418 /* Pretty-print the OFPT_FLOW_EXPIRED packet of 'len' bytes at 'oh' to 'string'
 419  * at the given 'verbosity' level. */
 420 static void
 421 ofp_print_flow_expired(struct ds *string, const void *oh, size_t len,
 422                        int verbosity)
 423 {
 424     const struct ofp_flow_expired *ofe = oh;
 425
 426     ofp_print_match(string, &ofe->match);
 427     ds_put_format(string,
 428          " pri%"PRIu16" secs%"PRIu32" pkts%"PRIu64" bytes%"PRIu64"\n",
 429          ofe->match.wildcards ? ntohs(ofe->priority) : (uint16_t)-1,
 430          ntohl(ofe->duration), ntohll(ofe->packet_count),
 431          ntohll(ofe->byte_count));
 432 }
 433
 434 /* Pretty-print the OFPT_ERROR_MSG packet of 'len' bytes at 'oh' to 'string'
 435  * at the given 'verbosity' level. */
 436 static void
 437 ofp_print_error_msg(struct ds *string, const void *oh, size_t len,
 438                        int verbosity)
 439 {
 440     const struct ofp_error_msg *oem = oh;
 441
 442     ds_put_format(string,
 443          " type%d code%d\n", ntohs(oem->type), ntohs(oem->code));
 444 }
 445
 446 /* Pretty-print the OFPT_PORT_STATUS packet of 'len' bytes at 'oh' to 'string'
 447  * at the given 'verbosity' level. */
 448 static void
 449 ofp_print_port_status(struct ds *string, const void *oh, size_t len,
 450                       int verbosity)
 451 {
 452     const struct ofp_port_status *ops = oh;
 453
 454     if (ops->reason == OFPPR_ADD) {
 455         ds_put_format(string, "add:");
 456     } else if (ops->reason == OFPPR_DELETE) {
 457         ds_put_format(string, "del:");
 458     } else if (ops->reason == OFPPR_MOD) {
 459         ds_put_format(string, "mod:");
 460     } else {
 461         ds_put_format(string, "err:");
 462     }
 463
 464     ofp_print_phy_port(string, &ops->desc);
 465 }
 466
 467 static void
 468 ofp_flow_stats_request(struct ds *string, const void *oh, size_t len,
 469                       int verbosity)
 470 {
 471     const struct ofp_flow_stats_request *fsr = oh;
 472
 473     if (fsr->table_id == 0xff) {
 474         ds_put_format(string, " table_id=any, ");
 475     } else {
 476         ds_put_format(string, " table_id=%"PRIu8", ", fsr->table_id);
 477     }
 478
 479     ofp_print_match(string, &fsr->match);
 480 }
 481
 482 static void
 483 ofp_flow_stats_reply(struct ds *string, const void *body_, size_t len,
 484                      int verbosity)
 485 {
 486     const char *body = body_;
 487     const char *pos = body;
 488     for (;;) {
 489         const struct ofp_flow_stats *fs;
 490         ptrdiff_t bytes_left = body + len - pos;
 491         size_t length;
 492
 493         if (bytes_left < sizeof *fs) {
 494             if (bytes_left != 0) {
 495                 ds_put_format(string, " ***%td leftover bytes at end***",
 496                               bytes_left);
 497             }
 498             break;
 499         }
 500
 501         fs = (const void *) pos;
 502         length = ntohs(fs->length);
 503         if (length < sizeof *fs) {
 504             ds_put_format(string, " ***length=%zu shorter than minimum %zu***",
 505                           length, sizeof *fs);
 506             break;
 507         } else if (length > bytes_left) {
 508             ds_put_format(string,
 509                           " ***length=%zu but only %td bytes left***",
 510                           length, bytes_left);
 511             break;
 512         } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
 513             ds_put_format(string,
 514                           " ***length=%zu has %zu bytes leftover in "
 515                           "final action***",
 516                           length,
 517                           (length - sizeof *fs) % sizeof fs->actions[0]);
 518             break;
 519         }
 520
 521         ds_put_format(string, "  duration=%"PRIu32"s, ", ntohl(fs->duration));
 522         ds_put_format(string, "table_id=%"PRIu8", ", fs->table_id);
 523         ds_put_format(string, "priority=%"PRIu16", ",
 524                     fs->match.wildcards ? ntohs(fs->priority) : (uint16_t)-1);
 525         ds_put_format(string, "n_packets=%"PRIu64", ",
 526                     ntohll(fs->packet_count));
 527         ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
 528         ds_put_format(string, "max_idle=%"PRIu16",", ntohs(fs->max_idle));
 529         ofp_print_match(string, &fs->match);
 530         ofp_print_actions(string, fs->actions, length - sizeof *fs);
 531         ds_put_char(string, '\n');
 532
 533         pos += length;
 534      }
 535 }
 536
 537 static void
 538 ofp_aggregate_stats_request(struct ds *string, const void *oh, size_t len,
 539                             int verbosity)
 540 {
 541     const struct ofp_aggregate_stats_request *asr = oh;
 542
 543     if (asr->table_id == 0xff) {
 544         ds_put_format(string, " table_id=any, ");
 545     } else {
 546         ds_put_format(string, " table_id=%"PRIu8", ", asr->table_id);
 547     }
 548
 549     ofp_print_match(string, &asr->match);
 550 }
 551
 552 static void
 553 ofp_aggregate_stats_reply(struct ds *string, const void *body_, size_t len,
 554                           int verbosity)
 555 {
 556     const struct ofp_aggregate_stats_reply *asr = body_;
 557
 558     ds_put_format(string, " packet_count=%"PRIu64, ntohll(asr->packet_count));
 559     ds_put_format(string, " byte_count=%"PRIu64, ntohll(asr->byte_count));
 560     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
 561 }
 562
 563 static void
 564 ofp_port_stats_reply(struct ds *string, const void *body, size_t len,
 565                      int verbosity)
 566 {
 567     const struct ofp_port_stats *ps = body;
 568     size_t n = len / sizeof *ps;
 569     ds_put_format(string, " %zu ports\n", n);
 570     if (verbosity < 1) {
 571         return;
 572     }
 573
 574     for (; n--; ps++) {
 575         ds_put_format(string, "  port %"PRIu16": ", ntohs(ps->port_no));
 576         ds_put_format(string, "rx %"PRIu64", ", ntohll(ps->rx_count));
 577         ds_put_format(string, "tx %"PRIu64", ", ntohll(ps->tx_count));
 578         ds_put_format(string, "dropped %"PRIu64"\n", ntohll(ps->drop_count));
 579     }
 580 }
 581
 582 static void
 583 ofp_table_stats_reply(struct ds *string, const void *body, size_t len,
 584                      int verbosity)
 585 {
 586     const struct ofp_table_stats *ts = body;
 587     size_t n = len / sizeof *ts;
 588     ds_put_format(string, " %zu tables\n", n);
 589     if (verbosity < 1) {
 590         return;
 591     }
 592
 593     for (; n--; ts++) {
 594         char name[OFP_MAX_TABLE_NAME_LEN + 1];
 595         strncpy(name, ts->name, sizeof name);
 596         name[OFP_MAX_TABLE_NAME_LEN] = '\0';
 597
 598         ds_put_format(string, "  table %"PRIu8": ", ts->table_id);
 599         ds_put_format(string, "name %-8s, ", name);
 600         ds_put_format(string, "max %6"PRIu32", ", ntohl(ts->max_entries));
 601         ds_put_format(string, "active %6"PRIu32", ", ntohl(ts->active_count));
 602         ds_put_format(string, "matched %6"PRIu64"\n",
 603                       ntohll(ts->matched_count));
 604      }
 605 }
 606
 607 enum stats_direction {
 608     REQUEST,
 609     REPLY
 610 };
 611
 612 static void
 613 print_stats(struct ds *string, int type, const void *body, size_t body_len,
 614             int verbosity, enum stats_direction direction)
 615 {
 616     struct stats_msg {
 617         size_t min_body, max_body;
 618         void (*printer)(struct ds *, const void *, size_t len, int verbosity);
 619     };
 620
 621     struct stats_type {
 622         const char *name;
 623         struct stats_msg request;
 624         struct stats_msg reply;
 625     };
 626
 627     static const struct stats_type stats_types[] = {
 628         [OFPST_FLOW] = {
 629             "flow",
 630             { sizeof(struct ofp_flow_stats_request),
 631               sizeof(struct ofp_flow_stats_request),
 632               ofp_flow_stats_request },
 633             { 0, SIZE_MAX, ofp_flow_stats_reply },
 634         },
 635         [OFPST_AGGREGATE] = {
 636             "aggregate",
 637             { sizeof(struct ofp_aggregate_stats_request),
 638               sizeof(struct ofp_aggregate_stats_request),
 639               ofp_aggregate_stats_request },
 640             { sizeof(struct ofp_aggregate_stats_reply),
 641               sizeof(struct ofp_aggregate_stats_reply),
 642               ofp_aggregate_stats_reply },
 643         },
 644         [OFPST_TABLE] = {
 645             "table",
 646             { 0, 0, NULL },
 647             { 0, SIZE_MAX, ofp_table_stats_reply },
 648         },
 649         [OFPST_PORT] = {
 650             "port",
 651             { 0, 0, NULL, },
 652             { 0, SIZE_MAX, ofp_port_stats_reply },
 653         },
 654     };
 655
 656     const struct stats_type *s;
 657     const struct stats_msg *m;
 658
 659     if (type >= ARRAY_SIZE(stats_types) || !stats_types[type].name) {
 660         ds_put_format(string, " ***unknown type %d***", type);
 661         return;
 662     }
 663     s = &stats_types[type];
 664     ds_put_format(string, " type=%d(%s)\n", type, s->name);
 665
 666     m = direction == REQUEST ? &s->request : &s->reply;
 667     if (body_len < m->min_body || body_len > m->max_body) {
 668         ds_put_format(string, " ***body_len=%zu not in %zu...%zu***",
 669                       body_len, m->min_body, m->max_body);
 670         return;
 671     }
 672     if (m->printer) {
 673         m->printer(string, body, body_len, verbosity);
 674     }
 675 }
 676
 677 static void
 678 ofp_stats_request(struct ds *string, const void *oh, size_t len, int verbosity)
 679 {
 680     const struct ofp_stats_request *srq = oh;
 681
 682     if (srq->flags) {
 683         ds_put_format(string, " ***unknown flags %04"PRIx16"***",
 684                       ntohs(srq->flags));
 685     }
 686
 687     print_stats(string, ntohs(srq->type), srq->body,
 688                 len - offsetof(struct ofp_stats_request, body),
 689                 verbosity, REQUEST);
 690 }
 691
 692 static void
 693 ofp_stats_reply(struct ds *string, const void *oh, size_t len, int verbosity)
 694 {
 695     const struct ofp_stats_reply *srp = oh;
 696
 697     ds_put_cstr(string, " flags=");
 698     if (!srp->flags) {
 699         ds_put_cstr(string, "none");
 700     } else {
 701         uint16_t flags = ntohs(srp->flags);
 702         if (flags & OFPSF_REPLY_MORE) {
 703             ds_put_cstr(string, "[more]");
 704             flags &= ~OFPSF_REPLY_MORE;
 705         }
 706         if (flags) {
 707             ds_put_format(string, "[***unknown%04"PRIx16"***]", flags);
 708         }
 709     }
 710
 711     print_stats(string, ntohs(srp->type), srp->body,
 712                 len - offsetof(struct ofp_stats_reply, body),
 713                 verbosity, REPLY);
 714 }
 715
 716 struct openflow_packet {
 717     const char *name;
 718     size_t min_size;
 719     void (*printer)(struct ds *, const void *, size_t len, int verbosity);
 720 };
 721
 722 static const struct openflow_packet packets[] = {
 723     [OFPT_FEATURES_REQUEST] = {
 724         "features_request",
 725         sizeof (struct ofp_header),
 726         NULL,
 727     },
 728     [OFPT_FEATURES_REPLY] = {
 729         "features_reply",
 730         sizeof (struct ofp_switch_features),
 731         ofp_print_switch_features,
 732     },
 733     [OFPT_GET_CONFIG_REQUEST] = {
 734         "get_config_request",
 735         sizeof (struct ofp_header),
 736         NULL,
 737     },
 738     [OFPT_GET_CONFIG_REPLY] = {
 739         "get_config_reply",
 740         sizeof (struct ofp_switch_config),
 741         ofp_print_switch_config,
 742     },
 743     [OFPT_SET_CONFIG] = {
 744         "set_config",
 745         sizeof (struct ofp_switch_config),
 746         ofp_print_switch_config,
 747     },
 748     [OFPT_PACKET_IN] = {
 749         "packet_in",
 750         offsetof(struct ofp_packet_in, data),
 751         ofp_packet_in,
 752     },
 753     [OFPT_PACKET_OUT] = {
 754         "packet_out",
 755         sizeof (struct ofp_packet_out),
 756         ofp_packet_out,
 757     },
 758     [OFPT_FLOW_MOD] = {
 759         "flow_mod",
 760         sizeof (struct ofp_flow_mod),
 761         ofp_print_flow_mod,
 762     },
 763     [OFPT_FLOW_EXPIRED] = {
 764         "flow_expired",
 765         sizeof (struct ofp_flow_expired),
 766         ofp_print_flow_expired,
 767     },
 768     [OFPT_PORT_MOD] = {
 769         "port_mod",
 770         sizeof (struct ofp_port_mod),
 771         NULL,
 772     },
 773     [OFPT_PORT_STATUS] = {
 774         "port_status",
 775         sizeof (struct ofp_port_status),
 776         ofp_print_port_status
 777     },
 778     [OFPT_ERROR_MSG] = {
 779         "error_msg",
 780         sizeof (struct ofp_error_msg),
 781         ofp_print_error_msg,
 782     },
 783     [OFPT_STATS_REQUEST] = {
 784         "stats_request",
 785         sizeof (struct ofp_stats_request),
 786         ofp_stats_request,
 787     },
 788     [OFPT_STATS_REPLY] = {
 789         "stats_reply",
 790         sizeof (struct ofp_stats_reply),
 791         ofp_stats_reply,
 792     },
 793 };
 794
 795 /* Composes and returns a string representing the OpenFlow packet of 'len'
 796  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
 797  * verbosity and higher numbers increase verbosity.  The caller is responsible
 798  * for freeing the string. */
 799 char *
 800 ofp_to_string(const void *oh_, size_t len, int verbosity)
 801 {
 802     struct ds string = DS_EMPTY_INITIALIZER;
 803     const struct ofp_header *oh = oh_;
 804     const struct openflow_packet *pkt;
 805
 806     if (len < sizeof(struct ofp_header)) {
 807         ds_put_cstr(&string, "OpenFlow packet too short:\n");
 808         ds_put_hex_dump(&string, oh, len, 0, true);
 809         return ds_cstr(&string);
 810     } else if (oh->version != OFP_VERSION) {
 811         ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n", oh->version);
 812         ds_put_hex_dump(&string, oh, len, 0, true);
 813         return ds_cstr(&string);
 814     } else if (oh->type >= ARRAY_SIZE(packets) || !packets[oh->type].name) {
 815         ds_put_format(&string, "Unknown OpenFlow packet type %"PRIu8":\n",
 816                 oh->type);
 817         ds_put_hex_dump(&string, oh, len, 0, true);
 818         return ds_cstr(&string);
 819     }
 820
 821     pkt = &packets[oh->type];
 822     ds_put_format(&string, "%s (xid=%"PRIx32"):", pkt->name, oh->xid);
 823
 824     if (ntohs(oh->length) > len)
 825         ds_put_format(&string, " (***truncated to %zu bytes from %"PRIu16"***)",
 826                 len, ntohs(oh->length));
 827     else if (ntohs(oh->length) < len) {
 828         ds_put_format(&string, " (***only uses %"PRIu16" bytes out of %zu***)\n",
 829                 ntohs(oh->length), len);
 830         len = ntohs(oh->length);
 831     }
 832
 833     if (len < pkt->min_size) {
 834         ds_put_format(&string, " (***length=%zu < min_size=%zu***)\n",
 835                 len, pkt->min_size);
 836     } else if (!pkt->printer) {
 837         if (len > sizeof *oh) {
 838             ds_put_format(&string, " length=%"PRIu16" (decoder not implemented)\n",
 839                           ntohs(oh->length));
 840         }
 841     } else {
 842         pkt->printer(&string, oh, len, verbosity);
 843     }
 844     if (verbosity >= 3) {
 845         ds_put_hex_dump(&string, oh, len, 0, true);
 846     }
 847     if (string.string[string.length - 1] != '\n') {
 848         ds_put_char(&string, '\n');
 849     }
 850     return ds_cstr(&string);
 851 }
 852 \f
 853 static void
 854 print_and_free(FILE *stream, char *string)
 855 {
 856     fputs(string, stream);
 857     free(string);
 858 }
 859
 860 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
 861  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
 862  * numbers increase verbosity. */
 863 void
 864 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
 865 {
 866     print_and_free(stream, ofp_to_string(oh, len, verbosity));
 867 }
 868
 869 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
 870  * 'data' to 'stream' using tcpdump.  'total_len' specifies the full length of
 871  * the Ethernet frame (of which 'len' bytes were captured).
 872  *
 873  * This starts and kills a tcpdump subprocess so it's quite expensive. */
 874 void
 875 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
 876 {
 877     print_and_free(stream, ofp_packet_to_string(data, len, total_len));
 878 }