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 "flow.h"
  49 #include "ofpbuf.h"
  50 #include "openflow.h"
  51 #include "packets.h"
  52 #include "util.h"
  53
  54 static void ofp_print_port_name(struct ds *string, uint16_t port);
  55 static void ofp_print_match(struct ds *, const struct ofp_match *,
  56                             int verbosity);
  57
  58 /* Returns a string that represents the contents of the Ethernet frame in the
  59  * 'len' bytes starting at 'data' to 'stream' as output by tcpdump.
  60  * 'total_len' specifies the full length of the Ethernet frame (of which 'len'
  61  * bytes were captured).
  62  *
  63  * The caller must free the returned string.
  64  *
  65  * This starts and kills a tcpdump subprocess so it's quite expensive. */
  66 char *
  67 ofp_packet_to_string(const void *data, size_t len, size_t total_len)
  68 {
  69     struct pcap_hdr {
  70         uint32_t magic_number;   /* magic number */
  71         uint16_t version_major;  /* major version number */
  72         uint16_t version_minor;  /* minor version number */
  73         int32_t thiszone;        /* GMT to local correction */
  74         uint32_t sigfigs;        /* accuracy of timestamps */
  75         uint32_t snaplen;        /* max length of captured packets */
  76         uint32_t network;        /* data link type */
  77     } PACKED;
  78
  79     struct pcaprec_hdr {
  80         uint32_t ts_sec;         /* timestamp seconds */
  81         uint32_t ts_usec;        /* timestamp microseconds */
  82         uint32_t incl_len;       /* number of octets of packet saved in file */
  83         uint32_t orig_len;       /* actual length of packet */
  84     } PACKED;
  85
  86     struct pcap_hdr ph;
  87     struct pcaprec_hdr prh;
  88
  89     struct ds ds = DS_EMPTY_INITIALIZER;
  90
  91     char command[128];
  92     FILE *pcap;
  93     FILE *tcpdump;
  94     int status;
  95     int c;
  96
  97     pcap = tmpfile();
  98     if (!pcap) {
  99         ofp_error(errno, "tmpfile");
 100         return xstrdup("<error>");
 101     }
 102
 103     /* The pcap reader is responsible for figuring out endianness based on the
 104      * magic number, so the lack of htonX calls here is intentional. */
 105     ph.magic_number = 0xa1b2c3d4;
 106     ph.version_major = 2;
 107     ph.version_minor = 4;
 108     ph.thiszone = 0;
 109     ph.sigfigs = 0;
 110     ph.snaplen = 1518;
 111     ph.network = 1;             /* Ethernet */
 112
 113     prh.ts_sec = 0;
 114     prh.ts_usec = 0;
 115     prh.incl_len = len;
 116     prh.orig_len = total_len;
 117
 118     fwrite(&ph, 1, sizeof ph, pcap);
 119     fwrite(&prh, 1, sizeof prh, pcap);
 120     fwrite(data, 1, len, pcap);
 121
 122     fflush(pcap);
 123     if (ferror(pcap)) {
 124         ofp_error(errno, "error writing temporary file");
 125     }
 126     rewind(pcap);
 127
 128     snprintf(command, sizeof command, "tcpdump -n -r /dev/fd/%d 2>/dev/null",
 129              fileno(pcap));
 130     tcpdump = popen(command, "r");
 131     fclose(pcap);
 132     if (!tcpdump) {
 133         ofp_error(errno, "exec(\"%s\")", command);
 134         return xstrdup("<error>");
 135     }
 136
 137     while ((c = getc(tcpdump)) != EOF) {
 138         ds_put_char(&ds, c);
 139     }
 140
 141     status = pclose(tcpdump);
 142     if (WIFEXITED(status)) {
 143         if (WEXITSTATUS(status))
 144             ofp_error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
 145     } else if (WIFSIGNALED(status)) {
 146         ofp_error(0, "tcpdump exited with signal %d", WTERMSIG(status));
 147     }
 148     return ds_cstr(&ds);
 149 }
 150
 151 /* Pretty-print the OFPT_PACKET_IN packet of 'len' bytes at 'oh' to 'stream'
 152  * at the given 'verbosity' level. */
 153 static void
 154 ofp_packet_in(struct ds *string, const void *oh, size_t len, int verbosity)
 155 {
 156     const struct ofp_packet_in *op = oh;
 157     size_t data_len;
 158
 159     ds_put_format(string, " total_len=%"PRIu16" in_port=",
 160                   ntohs(op->total_len));
 161     ofp_print_port_name(string, ntohs(op->in_port));
 162
 163     if (op->reason == OFPR_ACTION)
 164         ds_put_cstr(string, " (via action)");
 165     else if (op->reason != OFPR_NO_MATCH)
 166         ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
 167
 168     data_len = len - offsetof(struct ofp_packet_in, data);
 169     ds_put_format(string, " data_len=%zu", data_len);
 170     if (htonl(op->buffer_id) == UINT32_MAX) {
 171         ds_put_format(string, " (unbuffered)");
 172         if (ntohs(op->total_len) != data_len)
 173             ds_put_format(string, " (***total_len != data_len***)");
 174     } else {
 175         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(op->buffer_id));
 176         if (ntohs(op->total_len) < data_len)
 177             ds_put_format(string, " (***total_len < data_len***)");
 178     }
 179     ds_put_char(string, '\n');
 180
 181     if (verbosity > 0) {
 182         struct flow flow;
 183         struct ofpbuf packet;
 184         struct ofp_match match;
 185         packet.data = (void *) op->data;
 186         packet.size = data_len;
 187         flow_extract(&packet, ntohs(op->in_port), &flow);
 188         match.wildcards = 0;
 189         match.in_port = flow.in_port;
 190         memcpy(match.dl_src, flow.dl_src, ETH_ADDR_LEN);
 191         memcpy(match.dl_dst, flow.dl_dst, ETH_ADDR_LEN);
 192         match.dl_vlan = flow.dl_vlan;
 193         match.dl_type = flow.dl_type;
 194         match.nw_proto = flow.nw_proto;
 195         match.pad = 0;
 196         match.nw_src = flow.nw_src;
 197         match.nw_dst = flow.nw_dst;
 198         match.tp_src = flow.tp_src;
 199         match.tp_dst = flow.tp_dst;
 200         ofp_print_match(string, &match, verbosity);
 201         ds_put_char(string, '\n');
 202     }
 203     if (verbosity > 1) {
 204         char *packet = ofp_packet_to_string(op->data, data_len,
 205                                             ntohs(op->total_len));
 206         ds_put_cstr(string, packet);
 207         free(packet);
 208     }
 209 }
 210
 211 static void ofp_print_port_name(struct ds *string, uint16_t port)
 212 {
 213     const char *name;
 214     switch (port) {
 215     case OFPP_IN_PORT:
 216         name = "IN_PORT";
 217         break;
 218     case OFPP_TABLE:
 219         name = "TABLE";
 220         break;
 221     case OFPP_NORMAL:
 222         name = "NORMAL";
 223         break;
 224     case OFPP_FLOOD:
 225         name = "FLOOD";
 226         break;
 227     case OFPP_ALL:
 228         name = "ALL";
 229         break;
 230     case OFPP_CONTROLLER:
 231         name = "CONTROLLER";
 232         break;
 233     case OFPP_LOCAL:
 234         name = "LOCAL";
 235         break;
 236     case OFPP_NONE:
 237         name = "NONE";
 238         break;
 239     default:
 240         ds_put_format(string, "%"PRIu16, port);
 241         return;
 242     }
 243     ds_put_cstr(string, name);
 244 }
 245
 246 static void
 247 ofp_print_action(struct ds *string, const struct ofp_action *a)
 248 {
 249     switch (ntohs(a->type)) {
 250     case OFPAT_OUTPUT:
 251         {
 252             uint16_t port = ntohs(a->arg.output.port);
 253             if (port < OFPP_MAX) {
 254                 ds_put_format(string, "output:%"PRIu16, port);
 255             } else {
 256                 ofp_print_port_name(string, port);
 257                 if (port == OFPP_CONTROLLER) {
 258                     if (a->arg.output.max_len) {
 259                         ds_put_format(string, ":%"PRIu16,
 260                                 ntohs(a->arg.output.max_len));
 261                     } else {
 262                         ds_put_cstr(string, ":all");
 263                     }
 264                 }
 265             }
 266         }
 267         break;
 268
 269     case OFPAT_SET_DL_VLAN:
 270         ds_put_cstr(string, "mod_vlan:");
 271         if (ntohs(a->arg.vlan_id) == OFP_VLAN_NONE) {
 272             ds_put_cstr(string, "strip");
 273         } else {
 274             ds_put_format(string, "%"PRIu16, ntohs(a->arg.vlan_id));
 275         }
 276         break;
 277
 278     case OFPAT_SET_DL_SRC:
 279         ds_put_format(string, "mod_dl_src:"ETH_ADDR_FMT,
 280                 ETH_ADDR_ARGS(a->arg.dl_addr));
 281         break;
 282
 283     case OFPAT_SET_DL_DST:
 284         ds_put_format(string, "mod_dl_dst:"ETH_ADDR_FMT,
 285                 ETH_ADDR_ARGS(a->arg.dl_addr));
 286         break;
 287
 288     case OFPAT_SET_NW_SRC:
 289         ds_put_format(string, "mod_nw_src:"IP_FMT, IP_ARGS(&a->arg.nw_addr));
 290         break;
 291
 292     case OFPAT_SET_NW_DST:
 293         ds_put_format(string, "mod_nw_dst:"IP_FMT, IP_ARGS(&a->arg.nw_addr));
 294         break;
 295
 296     case OFPAT_SET_TP_SRC:
 297         ds_put_format(string, "mod_tp_src:%d", ntohs(a->arg.tp));
 298         break;
 299
 300     case OFPAT_SET_TP_DST:
 301         ds_put_format(string, "mod_tp_dst:%d", ntohs(a->arg.tp));
 302         break;
 303
 304     default:
 305         ds_put_format(string, "(decoder %"PRIu16" not implemented)",
 306                 ntohs(a->type));
 307         break;
 308     }
 309 }
 310
 311 static void ofp_print_actions(struct ds *string,
 312                               const struct ofp_action actions[],
 313                               size_t n_bytes)
 314 {
 315     size_t i;
 316     int n_actions = n_bytes / sizeof *actions;
 317
 318     ds_put_format(string, "action%s=", n_actions == 1 ? "" : "s");
 319     for (i = 0; i < n_actions; i++) {
 320         if (i) {
 321             ds_put_cstr(string, ",");
 322         }
 323         ofp_print_action(string, &actions[i]);
 324     }
 325     if (n_bytes % sizeof *actions) {
 326         if (i) {
 327             ds_put_cstr(string, ",");
 328         }
 329         ds_put_cstr(string, ", ***trailing garbage***");
 330     }
 331 }
 332
 333 /* Pretty-print the OFPT_PACKET_OUT packet of 'len' bytes at 'oh' to 'string'
 334  * at the given 'verbosity' level. */
 335 static void ofp_packet_out(struct ds *string, const void *oh, size_t len,
 336                            int verbosity)
 337 {
 338     const struct ofp_packet_out *opo = oh;
 339     int n_actions = ntohs(opo->n_actions);
 340     int act_len = n_actions * sizeof opo->actions[0];
 341
 342     ds_put_cstr(string, " in_port=");
 343     ofp_print_port_name(string, ntohs(opo->in_port));
 344
 345     ds_put_format(string, " n_actions=%d ", n_actions);
 346     if (act_len > (ntohs(opo->header.length) - sizeof *opo)) {
 347         ds_put_format(string, "***packet too short for number of actions***\n");
 348         return;
 349     }
 350     ofp_print_actions(string, opo->actions, act_len);
 351
 352     if (ntohl(opo->buffer_id) == UINT32_MAX) {
 353         int data_len = len - sizeof *opo - act_len;
 354         ds_put_format(string, " data_len=%d", data_len);
 355         if (verbosity > 0 && len > sizeof *opo) {
 356             char *packet = ofp_packet_to_string(&opo->actions[n_actions],
 357                                                 data_len, data_len);
 358             ds_put_char(string, '\n');
 359             ds_put_cstr(string, packet);
 360             free(packet);
 361         }
 362     } else {
 363         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(opo->buffer_id));
 364     }
 365     ds_put_char(string, '\n');
 366 }
 367
 368 /* qsort comparison function. */
 369 static int
 370 compare_ports(const void *a_, const void *b_)
 371 {
 372     const struct ofp_phy_port *a = a_;
 373     const struct ofp_phy_port *b = b_;
 374     uint16_t ap = ntohs(a->port_no);
 375     uint16_t bp = ntohs(b->port_no);
 376
 377     return ap < bp ? -1 : ap > bp;
 378 }
 379
 380 static void ofp_print_port_features(struct ds *string, uint32_t features)
 381 {
 382     if (features == 0) {
 383         ds_put_cstr(string, "Unsupported\n");
 384         return;
 385     }
 386     if (features & OFPPF_10MB_HD) {
 387         ds_put_cstr(string, "10MB-HD ");
 388     }
 389     if (features & OFPPF_10MB_FD) {
 390         ds_put_cstr(string, "10MB-FD ");
 391     }
 392     if (features & OFPPF_100MB_HD) {
 393         ds_put_cstr(string, "100MB-HD ");
 394     }
 395     if (features & OFPPF_100MB_FD) {
 396         ds_put_cstr(string, "100MB-FD ");
 397     }
 398     if (features & OFPPF_1GB_HD) {
 399         ds_put_cstr(string, "1GB-HD ");
 400     }
 401     if (features & OFPPF_1GB_FD) {
 402         ds_put_cstr(string, "1GB-FD ");
 403     }
 404     if (features & OFPPF_10GB_FD) {
 405         ds_put_cstr(string, "10GB-FD ");
 406     }
 407     if (features & OFPPF_COPPER) {
 408         ds_put_cstr(string, "COPPER ");
 409     }
 410     if (features & OFPPF_FIBER) {
 411         ds_put_cstr(string, "FIBER ");
 412     }
 413     if (features & OFPPF_AUTONEG) {
 414         ds_put_cstr(string, "AUTO_NEG ");
 415     }
 416     if (features & OFPPF_PAUSE) {
 417         ds_put_cstr(string, "AUTO_PAUSE ");
 418     }
 419     if (features & OFPPF_PAUSE_ASYM) {
 420         ds_put_cstr(string, "AUTO_PAUSE_ASYM ");
 421     }
 422     ds_put_char(string, '\n');
 423 }
 424
 425 static void
 426 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
 427 {
 428     uint8_t name[OFP_MAX_PORT_NAME_LEN];
 429     int j;
 430
 431     memcpy(name, port->name, sizeof name);
 432     for (j = 0; j < sizeof name - 1; j++) {
 433         if (!isprint(name[j])) {
 434             break;
 435         }
 436     }
 437     name[j] = '\0';
 438
 439     ds_put_char(string, ' ');
 440     ofp_print_port_name(string, ntohs(port->port_no));
 441     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT", config: %#x, state:%#x\n",
 442             name, ETH_ADDR_ARGS(port->hw_addr), ntohl(port->config),
 443             ntohl(port->state));
 444     if (port->curr) {
 445         ds_put_format(string, "     current:    ");
 446         ofp_print_port_features(string, ntohl(port->curr));
 447     }
 448     if (port->advertised) {
 449         ds_put_format(string, "     advertised: ");
 450         ofp_print_port_features(string, ntohl(port->advertised));
 451     }
 452     if (port->supported) {
 453         ds_put_format(string, "     supported:  ");
 454         ofp_print_port_features(string, ntohl(port->supported));
 455     }
 456     if (port->peer) {
 457         ds_put_format(string, "     peer:       ");
 458         ofp_print_port_features(string, ntohl(port->peer));
 459     }
 460 }
 461
 462 /* Pretty-print the struct ofp_switch_features of 'len' bytes at 'oh' to
 463  * 'string' at the given 'verbosity' level. */
 464 static void
 465 ofp_print_switch_features(struct ds *string, const void *oh, size_t len,
 466                           int verbosity)
 467 {
 468     const struct ofp_switch_features *osf = oh;
 469     struct ofp_phy_port port_list[OFPP_MAX];
 470     int n_ports;
 471     int i;
 472
 473     ds_put_format(string, "dp id:%"PRIx64"\n", ntohll(osf->datapath_id));
 474     ds_put_format(string, "n_tables:%d, n_buffers:%d\n", osf->n_tables,
 475             ntohl(osf->n_buffers));
 476     ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
 477            ntohl(osf->capabilities), ntohl(osf->actions));
 478
 479     if (ntohs(osf->header.length) >= sizeof *osf) {
 480         len = MIN(len, ntohs(osf->header.length));
 481     }
 482     n_ports = (len - sizeof *osf) / sizeof *osf->ports;
 483
 484     memcpy(port_list, osf->ports, (len - sizeof *osf));
 485     qsort(port_list, n_ports, sizeof port_list[0], compare_ports);
 486     for (i = 0; i < n_ports; i++) {
 487         ofp_print_phy_port(string, &port_list[i]);
 488     }
 489 }
 490
 491 /* Pretty-print the struct ofp_switch_config of 'len' bytes at 'oh' to 'string'
 492  * at the given 'verbosity' level. */
 493 static void
 494 ofp_print_switch_config(struct ds *string, const void *oh, size_t len,
 495                         int verbosity)
 496 {
 497     const struct ofp_switch_config *osc = oh;
 498     uint16_t flags;
 499
 500     flags = ntohs(osc->flags);
 501     if (flags & OFPC_SEND_FLOW_EXP) {
 502         flags &= ~OFPC_SEND_FLOW_EXP;
 503         ds_put_format(string, " (sending flow expirations)");
 504     }
 505     if (flags) {
 506         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 507     }
 508
 509     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 510 }
 511
 512 static void print_wild(struct ds *string, const char *leader, int is_wild,
 513             int verbosity, const char *format, ...)
 514             __attribute__((format(printf, 5, 6)));
 515
 516 static void print_wild(struct ds *string, const char *leader, int is_wild,
 517                        int verbosity, const char *format, ...)
 518 {
 519     if (is_wild && verbosity < 2) {
 520         return;
 521     }
 522     ds_put_cstr(string, leader);
 523     if (!is_wild) {
 524         va_list args;
 525
 526         va_start(args, format);
 527         ds_put_format_valist(string, format, args);
 528         va_end(args);
 529     } else {
 530         ds_put_char(string, '*');
 531     }
 532     ds_put_char(string, ',');
 533 }
 534
 535 static void
 536 print_ip_netmask(struct ds *string, const char *leader, uint32_t ip,
 537                  uint32_t wild_bits, int verbosity)
 538 {
 539     if (wild_bits >= 32 && verbosity < 2) {
 540         return;
 541     }
 542     ds_put_cstr(string, leader);
 543     if (wild_bits < 32) {
 544         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 545         if (wild_bits) {
 546             ds_put_format(string, "/%d", 32 - wild_bits);
 547         }
 548     } else {
 549         ds_put_char(string, '*');
 550     }
 551     ds_put_char(string, ',');
 552 }
 553
 554 /* Pretty-print the ofp_match structure */
 555 static void ofp_print_match(struct ds *f, const struct ofp_match *om,
 556         int verbosity)
 557 {
 558     uint32_t w = ntohl(om->wildcards);
 559     bool skip_type = false;
 560     bool skip_proto = false;
 561
 562     if (!(w & OFPFW_DL_TYPE)) {
 563         skip_type = true;
 564         if (om->dl_type == htons(ETH_TYPE_IP)) {
 565             if (!(w & OFPFW_NW_PROTO)) {
 566                 skip_proto = true;
 567                 if (om->nw_proto == IP_TYPE_ICMP) {
 568                     ds_put_cstr(f, "icmp,");
 569                 } else if (om->nw_proto == IP_TYPE_TCP) {
 570                     ds_put_cstr(f, "tcp,");
 571                 } else if (om->nw_proto == IP_TYPE_UDP) {
 572                     ds_put_cstr(f, "udp,");
 573                 } else {
 574                     ds_put_cstr(f, "ip,");
 575                     skip_proto = false;
 576                 }
 577             } else {
 578                 ds_put_cstr(f, "ip,");
 579             }
 580         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 581             ds_put_cstr(f, "arp,");
 582         } else {
 583             skip_type = false;
 584         }
 585     }
 586     print_wild(f, "in_port=", w & OFPFW_IN_PORT, verbosity,
 587                "%d", ntohs(om->in_port));
 588     print_wild(f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
 589                "0x%04x", ntohs(om->dl_vlan));
 590     print_wild(f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
 591                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 592     print_wild(f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
 593                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 594     if (!skip_type) {
 595         print_wild(f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
 596                    "0x%04x", ntohs(om->dl_type));
 597     }
 598     print_ip_netmask(f, "nw_src=", om->nw_src,
 599                      (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
 600     print_ip_netmask(f, "nw_dst=", om->nw_dst,
 601                      (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
 602     if (!skip_proto) {
 603         print_wild(f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
 604                    "%u", om->nw_proto);
 605     }
 606     print_wild(f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
 607                "%d", ntohs(om->tp_src));
 608     print_wild(f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
 609                "%d", ntohs(om->tp_dst));
 610 }
 611
 612 /* Pretty-print the OFPT_FLOW_MOD packet of 'len' bytes at 'oh' to 'string'
 613  * at the given 'verbosity' level. */
 614 static void
 615 ofp_print_flow_mod(struct ds *string, const void *oh, size_t len,
 616                    int verbosity)
 617 {
 618     const struct ofp_flow_mod *ofm = oh;
 619
 620     ofp_print_match(string, &ofm->match, verbosity);
 621     switch (ntohs(ofm->command)) {
 622     case OFPFC_ADD:
 623         ds_put_cstr(string, " ADD: ");
 624         break;
 625     case OFPFC_MODIFY:
 626         ds_put_cstr(string, " MOD: ");
 627         break;
 628     case OFPFC_MODIFY_STRICT:
 629         ds_put_cstr(string, " MOD_STRICT: ");
 630         break;
 631     case OFPFC_DELETE:
 632         ds_put_cstr(string, " DEL: ");
 633         break;
 634     case OFPFC_DELETE_STRICT:
 635         ds_put_cstr(string, " DEL_STRICT: ");
 636         break;
 637     default:
 638         ds_put_format(string, " cmd:%d ", ntohs(ofm->command));
 639     }
 640     ds_put_format(string, "idle:%d hard:%d pri:%d buf:%#x",
 641             ntohs(ofm->idle_timeout), ntohs(ofm->hard_timeout),
 642             ofm->match.wildcards ? ntohs(ofm->priority) : (uint16_t)-1,
 643             ntohl(ofm->buffer_id));
 644     ofp_print_actions(string, ofm->actions,
 645                       len - offsetof(struct ofp_flow_mod, actions));
 646     ds_put_char(string, '\n');
 647 }
 648
 649 /* Pretty-print the OFPT_FLOW_EXPIRED packet of 'len' bytes at 'oh' to 'string'
 650  * at the given 'verbosity' level. */
 651 static void
 652 ofp_print_flow_expired(struct ds *string, const void *oh, size_t len,
 653                        int verbosity)
 654 {
 655     const struct ofp_flow_expired *ofe = oh;
 656
 657     ofp_print_match(string, &ofe->match, verbosity);
 658     ds_put_cstr(string, " reason=");
 659     switch (ofe->reason) {
 660     case OFPER_IDLE_TIMEOUT:
 661         ds_put_cstr(string, "idle");
 662         break;
 663     case OFPER_HARD_TIMEOUT:
 664         ds_put_cstr(string, "hard");
 665         break;
 666     default:
 667         ds_put_format(string, "**%"PRIu8"**", ofe->reason);
 668         break;
 669     }
 670     ds_put_format(string,
 671          " pri%"PRIu16" secs%"PRIu32" pkts%"PRIu64" bytes%"PRIu64"\n",
 672          ofe->match.wildcards ? ntohs(ofe->priority) : (uint16_t)-1,
 673          ntohl(ofe->duration), ntohll(ofe->packet_count),
 674          ntohll(ofe->byte_count));
 675 }
 676
 677 struct error_type {
 678     int type;
 679     int code;
 680     const char *name;
 681 };
 682
 683 static const struct error_type error_types[] = {
 684 #define ERROR_TYPE(TYPE) {TYPE, -1, #TYPE}
 685 #define ERROR_CODE(TYPE, CODE) {TYPE, CODE, #CODE}
 686     ERROR_TYPE(OFPET_HELLO_FAILED),
 687     ERROR_CODE(OFPET_HELLO_FAILED, OFPHFC_INCOMPATIBLE),
 688
 689     ERROR_TYPE(OFPET_BAD_REQUEST),
 690     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VERSION),
 691     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE),
 692     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT),
 693     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VERSION),
 694 };
 695 #define N_ERROR_TYPES ARRAY_SIZE(error_types)
 696
 697 static const char *
 698 lookup_error_type(int type)
 699 {
 700     const struct error_type *t;
 701
 702     for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
 703         if (t->type == type && t->code == -1) {
 704             return t->name;
 705         }
 706     }
 707     return "?";
 708 }
 709
 710 static const char *
 711 lookup_error_code(int type, int code)
 712 {
 713     const struct error_type *t;
 714
 715     for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
 716         if (t->type == type && t->code == code) {
 717             return t->name;
 718         }
 719     }
 720     return "?";
 721 }
 722
 723 /* Pretty-print the OFPT_ERROR packet of 'len' bytes at 'oh' to 'string'
 724  * at the given 'verbosity' level. */
 725 static void
 726 ofp_print_error_msg(struct ds *string, const void *oh, size_t len,
 727                        int verbosity)
 728 {
 729     const struct ofp_error_msg *oem = oh;
 730     int type = ntohs(oem->type);
 731     int code = ntohs(oem->code);
 732     char *s;
 733
 734     ds_put_format(string, " type%d(%s) code%d(%s) payload:\n",
 735                   type, lookup_error_type(type),
 736                   code, lookup_error_code(type, code));
 737
 738     switch (type) {
 739     case OFPET_HELLO_FAILED:
 740         ds_put_printable(string, (char *) oem->data, len - sizeof *oem);
 741         break;
 742
 743     case OFPET_BAD_REQUEST:
 744         s = ofp_to_string(oem->data, len - sizeof *oem, 1);
 745         ds_put_cstr(string, s);
 746         free(s);
 747         break;
 748
 749     default:
 750         ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
 751         break;
 752     }
 753 }
 754
 755 /* Pretty-print the OFPT_PORT_STATUS packet of 'len' bytes at 'oh' to 'string'
 756  * at the given 'verbosity' level. */
 757 static void
 758 ofp_print_port_status(struct ds *string, const void *oh, size_t len,
 759                       int verbosity)
 760 {
 761     const struct ofp_port_status *ops = oh;
 762
 763     if (ops->reason == OFPPR_ADD) {
 764         ds_put_format(string, " ADD:");
 765     } else if (ops->reason == OFPPR_DELETE) {
 766         ds_put_format(string, " DEL:");
 767     } else if (ops->reason == OFPPR_MODIFY) {
 768         ds_put_format(string, " MOD:");
 769     }
 770
 771     ofp_print_phy_port(string, &ops->desc);
 772 }
 773
 774 static void
 775 ofp_desc_stats_reply(struct ds *string, const void *body, size_t len,
 776                      int verbosity)
 777 {
 778     const struct ofp_desc_stats *ods = body;
 779
 780     ds_put_format(string, "Manufacturer: %s\n", ods->mfr_desc);
 781     ds_put_format(string, "Hardware: %s\n", ods->hw_desc);
 782     ds_put_format(string, "Software: %s\n", ods->sw_desc);
 783     ds_put_format(string, "Serial Num: %s\n", ods->serial_num);
 784 }
 785
 786 static void
 787 ofp_flow_stats_request(struct ds *string, const void *oh, size_t len,
 788                       int verbosity)
 789 {
 790     const struct ofp_flow_stats_request *fsr = oh;
 791
 792     if (fsr->table_id == 0xff) {
 793         ds_put_format(string, " table_id=any, ");
 794     } else {
 795         ds_put_format(string, " table_id=%"PRIu8", ", fsr->table_id);
 796     }
 797
 798     ofp_print_match(string, &fsr->match, verbosity);
 799 }
 800
 801 static void
 802 ofp_flow_stats_reply(struct ds *string, const void *body_, size_t len,
 803                      int verbosity)
 804 {
 805     const char *body = body_;
 806     const char *pos = body;
 807     for (;;) {
 808         const struct ofp_flow_stats *fs;
 809         ptrdiff_t bytes_left = body + len - pos;
 810         size_t length;
 811
 812         if (bytes_left < sizeof *fs) {
 813             if (bytes_left != 0) {
 814                 ds_put_format(string, " ***%td leftover bytes at end***",
 815                               bytes_left);
 816             }
 817             break;
 818         }
 819
 820         fs = (const void *) pos;
 821         length = ntohs(fs->length);
 822         if (length < sizeof *fs) {
 823             ds_put_format(string, " ***length=%zu shorter than minimum %zu***",
 824                           length, sizeof *fs);
 825             break;
 826         } else if (length > bytes_left) {
 827             ds_put_format(string,
 828                           " ***length=%zu but only %td bytes left***",
 829                           length, bytes_left);
 830             break;
 831         } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
 832             ds_put_format(string,
 833                           " ***length=%zu has %zu bytes leftover in "
 834                           "final action***",
 835                           length,
 836                           (length - sizeof *fs) % sizeof fs->actions[0]);
 837             break;
 838         }
 839
 840         ds_put_format(string, "  duration=%"PRIu32"s, ", ntohl(fs->duration));
 841         ds_put_format(string, "table_id=%"PRIu8", ", fs->table_id);
 842         ds_put_format(string, "priority=%"PRIu16", ",
 843                     fs->match.wildcards ? ntohs(fs->priority) : (uint16_t)-1);
 844         ds_put_format(string, "n_packets=%"PRIu64", ",
 845                     ntohll(fs->packet_count));
 846         ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
 847         ds_put_format(string, "idle_timeout=%"PRIu16",",
 848                       ntohs(fs->idle_timeout));
 849         ds_put_format(string, "hard_timeout=%"PRIu16",",
 850                       ntohs(fs->hard_timeout));
 851         ofp_print_match(string, &fs->match, verbosity);
 852         ofp_print_actions(string, fs->actions, length - sizeof *fs);
 853         ds_put_char(string, '\n');
 854
 855         pos += length;
 856      }
 857 }
 858
 859 static void
 860 ofp_aggregate_stats_request(struct ds *string, const void *oh, size_t len,
 861                             int verbosity)
 862 {
 863     const struct ofp_aggregate_stats_request *asr = oh;
 864
 865     if (asr->table_id == 0xff) {
 866         ds_put_format(string, " table_id=any, ");
 867     } else {
 868         ds_put_format(string, " table_id=%"PRIu8", ", asr->table_id);
 869     }
 870
 871     ofp_print_match(string, &asr->match, verbosity);
 872 }
 873
 874 static void
 875 ofp_aggregate_stats_reply(struct ds *string, const void *body_, size_t len,
 876                           int verbosity)
 877 {
 878     const struct ofp_aggregate_stats_reply *asr = body_;
 879
 880     ds_put_format(string, " packet_count=%"PRIu64, ntohll(asr->packet_count));
 881     ds_put_format(string, " byte_count=%"PRIu64, ntohll(asr->byte_count));
 882     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
 883 }
 884
 885 static void print_port_stat(struct ds *string, const char *leader,
 886                             uint64_t stat, int more)
 887 {
 888     ds_put_cstr(string, leader);
 889     if (stat != -1) {
 890         ds_put_format(string, "%"PRIu64, stat);
 891     } else {
 892         ds_put_char(string, '?');
 893     }
 894     if (more) {
 895         ds_put_cstr(string, ", ");
 896     } else {
 897         ds_put_cstr(string, "\n");
 898     }
 899 }
 900
 901 static void
 902 ofp_port_stats_reply(struct ds *string, const void *body, size_t len,
 903                      int verbosity)
 904 {
 905     const struct ofp_port_stats *ps = body;
 906     size_t n = len / sizeof *ps;
 907     ds_put_format(string, " %zu ports\n", n);
 908     if (verbosity < 1) {
 909         return;
 910     }
 911
 912     for (; n--; ps++) {
 913         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
 914
 915         ds_put_cstr(string, "rx ");
 916         print_port_stat(string, "pkts=", ntohll(ps->rx_packets), 1);
 917         print_port_stat(string, "bytes=", ntohll(ps->rx_bytes), 1);
 918         print_port_stat(string, "drop=", ntohll(ps->rx_dropped), 1);
 919         print_port_stat(string, "errs=", ntohll(ps->rx_errors), 1);
 920         print_port_stat(string, "frame=", ntohll(ps->rx_frame_err), 1);
 921         print_port_stat(string, "over=", ntohll(ps->rx_over_err), 1);
 922         print_port_stat(string, "crc=", ntohll(ps->rx_crc_err), 0);
 923
 924         ds_put_cstr(string, "           tx ");
 925         print_port_stat(string, "pkts=", ntohll(ps->tx_packets), 1);
 926         print_port_stat(string, "bytes=", ntohll(ps->tx_bytes), 1);
 927         print_port_stat(string, "drop=", ntohll(ps->tx_dropped), 1);
 928         print_port_stat(string, "errs=", ntohll(ps->tx_errors), 1);
 929         print_port_stat(string, "coll=", ntohll(ps->collisions), 0);
 930     }
 931 }
 932
 933 static void
 934 ofp_table_stats_reply(struct ds *string, const void *body, size_t len,
 935                      int verbosity)
 936 {
 937     const struct ofp_table_stats *ts = body;
 938     size_t n = len / sizeof *ts;
 939     ds_put_format(string, " %zu tables\n", n);
 940     if (verbosity < 1) {
 941         return;
 942     }
 943
 944     for (; n--; ts++) {
 945         char name[OFP_MAX_TABLE_NAME_LEN + 1];
 946         strncpy(name, ts->name, sizeof name);
 947         name[OFP_MAX_TABLE_NAME_LEN] = '\0';
 948
 949         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
 950         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
 951         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
 952         ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
 953         ds_put_cstr(string, "               ");
 954         ds_put_format(string, "lookup=%"PRIu64", ",
 955                     ntohll(ts->lookup_count));
 956         ds_put_format(string, "matched=%"PRIu64"\n",
 957                     ntohll(ts->matched_count));
 958      }
 959 }
 960
 961 static void
 962 vendor_stat(struct ds *string, const void *body, size_t len,
 963             int verbosity UNUSED)
 964 {
 965     ds_put_format(string, " vendor=%08"PRIx32, ntohl(*(uint32_t *) body));
 966     ds_put_format(string, " %zu bytes additional data",
 967                   len - sizeof(uint32_t));
 968 }
 969
 970 enum stats_direction {
 971     REQUEST,
 972     REPLY
 973 };
 974
 975 static void
 976 print_stats(struct ds *string, int type, const void *body, size_t body_len,
 977             int verbosity, enum stats_direction direction)
 978 {
 979     struct stats_msg {
 980         size_t min_body, max_body;
 981         void (*printer)(struct ds *, const void *, size_t len, int verbosity);
 982     };
 983
 984     struct stats_type {
 985         int type;
 986         const char *name;
 987         struct stats_msg request;
 988         struct stats_msg reply;
 989     };
 990
 991     static const struct stats_type stats_types[] = {
 992         {
 993             OFPST_DESC,
 994             "description",
 995             { 0, 0, NULL },
 996             { 0, SIZE_MAX, ofp_desc_stats_reply },
 997         },
 998         {
 999             OFPST_FLOW,
1000             "flow",
1001             { sizeof(struct ofp_flow_stats_request),
1002               sizeof(struct ofp_flow_stats_request),
1003               ofp_flow_stats_request },
1004             { 0, SIZE_MAX, ofp_flow_stats_reply },
1005         },
1006         {
1007             OFPST_AGGREGATE,
1008             "aggregate",
1009             { sizeof(struct ofp_aggregate_stats_request),
1010               sizeof(struct ofp_aggregate_stats_request),
1011               ofp_aggregate_stats_request },
1012             { sizeof(struct ofp_aggregate_stats_reply),
1013               sizeof(struct ofp_aggregate_stats_reply),
1014               ofp_aggregate_stats_reply },
1015         },
1016         {
1017             OFPST_TABLE,
1018             "table",
1019             { 0, 0, NULL },
1020             { 0, SIZE_MAX, ofp_table_stats_reply },
1021         },
1022         {
1023             OFPST_PORT,
1024             "port",
1025             { 0, 0, NULL, },
1026             { 0, SIZE_MAX, ofp_port_stats_reply },
1027         },
1028         {
1029             OFPST_VENDOR,
1030             "vendor-specific",
1031             { sizeof(uint32_t), SIZE_MAX, vendor_stat },
1032             { sizeof(uint32_t), SIZE_MAX, vendor_stat },
1033         },
1034         {
1035             -1,
1036             "unknown",
1037             { 0, 0, NULL, },
1038             { 0, 0, NULL, },
1039         },
1040     };
1041
1042     const struct stats_type *s;
1043     const struct stats_msg *m;
1044
1045     if (type >= ARRAY_SIZE(stats_types) || !stats_types[type].name) {
1046         ds_put_format(string, " ***unknown type %d***", type);
1047         return;
1048     }
1049     for (s = stats_types; s->type >= 0; s++) {
1050         if (s->type == type) {
1051             break;
1052         }
1053     }
1054     ds_put_format(string, " type=%d(%s)\n", type, s->name);
1055
1056     m = direction == REQUEST ? &s->request : &s->reply;
1057     if (body_len < m->min_body || body_len > m->max_body) {
1058         ds_put_format(string, " ***body_len=%zu not in %zu...%zu***",
1059                       body_len, m->min_body, m->max_body);
1060         return;
1061     }
1062     if (m->printer) {
1063         m->printer(string, body, body_len, verbosity);
1064     }
1065 }
1066
1067 static void
1068 ofp_stats_request(struct ds *string, const void *oh, size_t len, int verbosity)
1069 {
1070     const struct ofp_stats_request *srq = oh;
1071
1072     if (srq->flags) {
1073         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
1074                       ntohs(srq->flags));
1075     }
1076
1077     print_stats(string, ntohs(srq->type), srq->body,
1078                 len - offsetof(struct ofp_stats_request, body),
1079                 verbosity, REQUEST);
1080 }
1081
1082 static void
1083 ofp_stats_reply(struct ds *string, const void *oh, size_t len, int verbosity)
1084 {
1085     const struct ofp_stats_reply *srp = oh;
1086
1087     ds_put_cstr(string, " flags=");
1088     if (!srp->flags) {
1089         ds_put_cstr(string, "none");
1090     } else {
1091         uint16_t flags = ntohs(srp->flags);
1092         if (flags & OFPSF_REPLY_MORE) {
1093             ds_put_cstr(string, "[more]");
1094             flags &= ~OFPSF_REPLY_MORE;
1095         }
1096         if (flags) {
1097             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]", flags);
1098         }
1099     }
1100
1101     print_stats(string, ntohs(srp->type), srp->body,
1102                 len - offsetof(struct ofp_stats_reply, body),
1103                 verbosity, REPLY);
1104 }
1105
1106 static void
1107 ofp_echo(struct ds *string, const void *oh, size_t len, int verbosity)
1108 {
1109     const struct ofp_header *hdr = oh;
1110
1111     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *hdr);
1112     if (verbosity > 1) {
1113         ds_put_hex_dump(string, hdr, len - sizeof *hdr, 0, true);
1114     }
1115 }
1116
1117 struct openflow_packet {
1118     uint8_t type;
1119     const char *name;
1120     size_t min_size;
1121     void (*printer)(struct ds *, const void *, size_t len, int verbosity);
1122 };
1123
1124 static const struct openflow_packet packets[] = {
1125     {
1126         OFPT_HELLO,
1127         "hello",
1128         sizeof (struct ofp_header),
1129         NULL,
1130     },
1131     {
1132         OFPT_FEATURES_REQUEST,
1133         "features_request",
1134         sizeof (struct ofp_header),
1135         NULL,
1136     },
1137     {
1138         OFPT_FEATURES_REPLY,
1139         "features_reply",
1140         sizeof (struct ofp_switch_features),
1141         ofp_print_switch_features,
1142     },
1143     {
1144         OFPT_GET_CONFIG_REQUEST,
1145         "get_config_request",
1146         sizeof (struct ofp_header),
1147         NULL,
1148     },
1149     {
1150         OFPT_GET_CONFIG_REPLY,
1151         "get_config_reply",
1152         sizeof (struct ofp_switch_config),
1153         ofp_print_switch_config,
1154     },
1155     {
1156         OFPT_SET_CONFIG,
1157         "set_config",
1158         sizeof (struct ofp_switch_config),
1159         ofp_print_switch_config,
1160     },
1161     {
1162         OFPT_PACKET_IN,
1163         "packet_in",
1164         offsetof(struct ofp_packet_in, data),
1165         ofp_packet_in,
1166     },
1167     {
1168         OFPT_PACKET_OUT,
1169         "packet_out",
1170         sizeof (struct ofp_packet_out),
1171         ofp_packet_out,
1172     },
1173     {
1174         OFPT_FLOW_MOD,
1175         "flow_mod",
1176         sizeof (struct ofp_flow_mod),
1177         ofp_print_flow_mod,
1178     },
1179     {
1180         OFPT_FLOW_EXPIRED,
1181         "flow_expired",
1182         sizeof (struct ofp_flow_expired),
1183         ofp_print_flow_expired,
1184     },
1185     {
1186         OFPT_PORT_MOD,
1187         "port_mod",
1188         sizeof (struct ofp_port_mod),
1189         NULL,
1190     },
1191     {
1192         OFPT_PORT_STATUS,
1193         "port_status",
1194         sizeof (struct ofp_port_status),
1195         ofp_print_port_status
1196     },
1197     {
1198         OFPT_ERROR,
1199         "error_msg",
1200         sizeof (struct ofp_error_msg),
1201         ofp_print_error_msg,
1202     },
1203     {
1204         OFPT_STATS_REQUEST,
1205         "stats_request",
1206         sizeof (struct ofp_stats_request),
1207         ofp_stats_request,
1208     },
1209     {
1210         OFPT_STATS_REPLY,
1211         "stats_reply",
1212         sizeof (struct ofp_stats_reply),
1213         ofp_stats_reply,
1214     },
1215     {
1216         OFPT_ECHO_REQUEST,
1217         "echo_request",
1218         sizeof (struct ofp_header),
1219         ofp_echo,
1220     },
1221     {
1222         OFPT_ECHO_REPLY,
1223         "echo_reply",
1224         sizeof (struct ofp_header),
1225         ofp_echo,
1226     },
1227 };
1228
1229 /* Composes and returns a string representing the OpenFlow packet of 'len'
1230  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1231  * verbosity and higher numbers increase verbosity.  The caller is responsible
1232  * for freeing the string. */
1233 char *
1234 ofp_to_string(const void *oh_, size_t len, int verbosity)
1235 {
1236     struct ds string = DS_EMPTY_INITIALIZER;
1237     const struct ofp_header *oh = oh_;
1238     const struct openflow_packet *pkt;
1239
1240     if (len < sizeof(struct ofp_header)) {
1241         ds_put_cstr(&string, "OpenFlow packet too short:\n");
1242         ds_put_hex_dump(&string, oh, len, 0, true);
1243         return ds_cstr(&string);
1244     } else if (oh->version != OFP_VERSION) {
1245         ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n", oh->version);
1246         ds_put_hex_dump(&string, oh, len, 0, true);
1247         return ds_cstr(&string);
1248     }
1249
1250     for (pkt = packets; ; pkt++) {
1251         if (pkt >= &packets[ARRAY_SIZE(packets)]) {
1252             ds_put_format(&string, "Unknown OpenFlow packet type %"PRIu8":\n",
1253                           oh->type);
1254             ds_put_hex_dump(&string, oh, len, 0, true);
1255             return ds_cstr(&string);
1256         } else if (oh->type == pkt->type) {
1257             break;
1258         }
1259     }
1260
1261     ds_put_format(&string, "%s (xid=0x%"PRIx32"):", pkt->name, oh->xid);
1262
1263     if (ntohs(oh->length) > len)
1264         ds_put_format(&string, " (***truncated to %zu bytes from %"PRIu16"***)",
1265                 len, ntohs(oh->length));
1266     else if (ntohs(oh->length) < len) {
1267         ds_put_format(&string, " (***only uses %"PRIu16" bytes out of %zu***)\n",
1268                 ntohs(oh->length), len);
1269         len = ntohs(oh->length);
1270     }
1271
1272     if (len < pkt->min_size) {
1273         ds_put_format(&string, " (***length=%zu < min_size=%zu***)\n",
1274                 len, pkt->min_size);
1275     } else if (!pkt->printer) {
1276         if (len > sizeof *oh) {
1277             ds_put_format(&string, " length=%"PRIu16" (decoder not implemented)\n",
1278                           ntohs(oh->length));
1279         }
1280     } else {
1281         pkt->printer(&string, oh, len, verbosity);
1282     }
1283     if (verbosity >= 3) {
1284         ds_put_hex_dump(&string, oh, len, 0, true);
1285     }
1286     if (string.string[string.length - 1] != '\n') {
1287         ds_put_char(&string, '\n');
1288     }
1289     return ds_cstr(&string);
1290 }
1291 \f
1292 static void
1293 print_and_free(FILE *stream, char *string)
1294 {
1295     fputs(string, stream);
1296     free(string);
1297 }
1298
1299 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1300  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1301  * numbers increase verbosity. */
1302 void
1303 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1304 {
1305     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1306 }
1307
1308 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1309  * 'data' to 'stream' using tcpdump.  'total_len' specifies the full length of
1310  * the Ethernet frame (of which 'len' bytes were captured).
1311  *
1312  * This starts and kills a tcpdump subprocess so it's quite expensive. */
1313 void
1314 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1315 {
1316     print_and_free(stream, ofp_packet_to_string(data, len, total_len));
1317 }