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