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
 381 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
 382 {
 383     uint8_t name[OFP_MAX_PORT_NAME_LEN];
 384     int j;
 385
 386     memcpy(name, port->name, sizeof name);
 387     for (j = 0; j < sizeof name - 1; j++) {
 388         if (!isprint(name[j])) {
 389             break;
 390         }
 391     }
 392     name[j] = '\0';
 393
 394     ds_put_char(string, ' ');
 395     ofp_print_port_name(string, ntohs(port->port_no));
 396     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT", speed:%d, flags:%#x, "
 397             "feat:%#x\n", name,
 398             ETH_ADDR_ARGS(port->hw_addr), ntohl(port->speed),
 399             ntohl(port->flags), ntohl(port->features));
 400 }
 401
 402 /* Pretty-print the struct ofp_switch_features of 'len' bytes at 'oh' to
 403  * 'string' at the given 'verbosity' level. */
 404 static void
 405 ofp_print_switch_features(struct ds *string, const void *oh, size_t len,
 406                           int verbosity)
 407 {
 408     const struct ofp_switch_features *osf = oh;
 409     struct ofp_phy_port port_list[OFPP_MAX];
 410     int n_ports;
 411     int i;
 412
 413     ds_put_format(string, "dp id:%"PRIx64"\n", ntohll(osf->datapath_id));
 414     ds_put_format(string, "n_tables:%d, n_buffers:%d\n", osf->n_tables,
 415             ntohl(osf->n_buffers));
 416     ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
 417            ntohl(osf->capabilities), ntohl(osf->actions));
 418
 419     if (ntohs(osf->header.length) >= sizeof *osf) {
 420         len = MIN(len, ntohs(osf->header.length));
 421     }
 422     n_ports = (len - sizeof *osf) / sizeof *osf->ports;
 423
 424     memcpy(port_list, osf->ports, (len - sizeof *osf));
 425     qsort(port_list, n_ports, sizeof port_list[0], compare_ports);
 426     for (i = 0; i < n_ports; i++) {
 427         ofp_print_phy_port(string, &port_list[i]);
 428     }
 429 }
 430
 431 /* Pretty-print the struct ofp_switch_config of 'len' bytes at 'oh' to 'string'
 432  * at the given 'verbosity' level. */
 433 static void
 434 ofp_print_switch_config(struct ds *string, const void *oh, size_t len,
 435                         int verbosity)
 436 {
 437     const struct ofp_switch_config *osc = oh;
 438     uint16_t flags;
 439
 440     flags = ntohs(osc->flags);
 441     if (flags & OFPC_SEND_FLOW_EXP) {
 442         flags &= ~OFPC_SEND_FLOW_EXP;
 443         ds_put_format(string, " (sending flow expirations)");
 444     }
 445     if (flags) {
 446         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 447     }
 448
 449     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 450 }
 451
 452 static void print_wild(struct ds *string, const char *leader, int is_wild,
 453             int verbosity, const char *format, ...)
 454             __attribute__((format(printf, 5, 6)));
 455
 456 static void print_wild(struct ds *string, const char *leader, int is_wild,
 457                        int verbosity, const char *format, ...)
 458 {
 459     if (is_wild && verbosity < 2) {
 460         return;
 461     }
 462     ds_put_cstr(string, leader);
 463     if (!is_wild) {
 464         va_list args;
 465
 466         va_start(args, format);
 467         ds_put_format_valist(string, format, args);
 468         va_end(args);
 469     } else {
 470         ds_put_char(string, '*');
 471     }
 472     ds_put_char(string, ',');
 473 }
 474
 475 static void
 476 print_ip_netmask(struct ds *string, const char *leader, uint32_t ip,
 477                  uint32_t wild_bits, int verbosity)
 478 {
 479     if (wild_bits >= 32 && verbosity < 2) {
 480         return;
 481     }
 482     ds_put_cstr(string, leader);
 483     if (wild_bits < 32) {
 484         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 485         if (wild_bits) {
 486             ds_put_format(string, "/%d", 32 - wild_bits);
 487         }
 488     } else {
 489         ds_put_char(string, '*');
 490     }
 491     ds_put_char(string, ',');
 492 }
 493
 494 /* Pretty-print the ofp_match structure */
 495 static void ofp_print_match(struct ds *f, const struct ofp_match *om,
 496         int verbosity)
 497 {
 498     uint32_t w = ntohl(om->wildcards);
 499     bool skip_type = false;
 500     bool skip_proto = false;
 501
 502     if (!(w & OFPFW_DL_TYPE)) {
 503         skip_type = true;
 504         if (om->dl_type == htons(ETH_TYPE_IP)) {
 505             if (!(w & OFPFW_NW_PROTO)) {
 506                 skip_proto = true;
 507                 if (om->nw_proto == IP_TYPE_ICMP) {
 508                     ds_put_cstr(f, "icmp,");
 509                 } else if (om->nw_proto == IP_TYPE_TCP) {
 510                     ds_put_cstr(f, "tcp,");
 511                 } else if (om->nw_proto == IP_TYPE_UDP) {
 512                     ds_put_cstr(f, "udp,");
 513                 } else {
 514                     ds_put_cstr(f, "ip,");
 515                     skip_proto = false;
 516                 }
 517             } else {
 518                 ds_put_cstr(f, "ip,");
 519             }
 520         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 521             ds_put_cstr(f, "arp,");
 522         } else {
 523             skip_type = false;
 524         }
 525     }
 526     print_wild(f, "in_port=", w & OFPFW_IN_PORT, verbosity,
 527                "%d", ntohs(om->in_port));
 528     print_wild(f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
 529                "0x%04x", ntohs(om->dl_vlan));
 530     print_wild(f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
 531                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 532     print_wild(f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
 533                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 534     if (!skip_type) {
 535         print_wild(f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
 536                    "0x%04x", ntohs(om->dl_type));
 537     }
 538     print_ip_netmask(f, "nw_src=", om->nw_src,
 539                      (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
 540     print_ip_netmask(f, "nw_dst=", om->nw_dst,
 541                      (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
 542     if (!skip_proto) {
 543         print_wild(f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
 544                    "%u", om->nw_proto);
 545     }
 546     print_wild(f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
 547                "%d", ntohs(om->tp_src));
 548     print_wild(f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
 549                "%d", ntohs(om->tp_dst));
 550 }
 551
 552 /* Pretty-print the OFPT_FLOW_MOD packet of 'len' bytes at 'oh' to 'string'
 553  * at the given 'verbosity' level. */
 554 static void
 555 ofp_print_flow_mod(struct ds *string, const void *oh, size_t len,
 556                    int verbosity)
 557 {
 558     const struct ofp_flow_mod *ofm = oh;
 559
 560     ofp_print_match(string, &ofm->match, verbosity);
 561     ds_put_format(string, " cmd:%d idle:%d hard:%d pri:%d buf:%#x",
 562             ntohs(ofm->command), ntohs(ofm->idle_timeout),
 563             ntohs(ofm->hard_timeout),
 564             ofm->match.wildcards ? ntohs(ofm->priority) : (uint16_t)-1,
 565             ntohl(ofm->buffer_id));
 566     ofp_print_actions(string, ofm->actions,
 567                       len - offsetof(struct ofp_flow_mod, actions));
 568     ds_put_char(string, '\n');
 569 }
 570
 571 /* Pretty-print the OFPT_FLOW_EXPIRED packet of 'len' bytes at 'oh' to 'string'
 572  * at the given 'verbosity' level. */
 573 static void
 574 ofp_print_flow_expired(struct ds *string, const void *oh, size_t len,
 575                        int verbosity)
 576 {
 577     const struct ofp_flow_expired *ofe = oh;
 578
 579     ofp_print_match(string, &ofe->match, verbosity);
 580     ds_put_cstr(string, " reason=");
 581     switch (ofe->reason) {
 582     case OFPER_IDLE_TIMEOUT:
 583         ds_put_cstr(string, "idle");
 584         break;
 585     case OFPER_HARD_TIMEOUT:
 586         ds_put_cstr(string, "hard");
 587         break;
 588     default:
 589         ds_put_format(string, "**%"PRIu8"**", ofe->reason);
 590         break;
 591     }
 592     ds_put_format(string,
 593          " pri%"PRIu16" secs%"PRIu32" pkts%"PRIu64" bytes%"PRIu64"\n",
 594          ofe->match.wildcards ? ntohs(ofe->priority) : (uint16_t)-1,
 595          ntohl(ofe->duration), ntohll(ofe->packet_count),
 596          ntohll(ofe->byte_count));
 597 }
 598
 599 struct error_type {
 600     int type;
 601     int code;
 602     const char *name;
 603 };
 604
 605 static const struct error_type error_types[] = {
 606 #define ERROR_TYPE(TYPE) {TYPE, -1, #TYPE}
 607 #define ERROR_CODE(TYPE, CODE) {TYPE, CODE, #CODE}
 608     ERROR_TYPE(OFPET_HELLO_FAILED),
 609     ERROR_CODE(OFPET_HELLO_FAILED, OFPHFC_INCOMPATIBLE),
 610
 611     ERROR_TYPE(OFPET_BAD_REQUEST),
 612     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VERSION),
 613     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE),
 614     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT),
 615     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VERSION),
 616 };
 617 #define N_ERROR_TYPES ARRAY_SIZE(error_types)
 618
 619 static const char *
 620 lookup_error_type(int type)
 621 {
 622     const struct error_type *t;
 623
 624     for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
 625         if (t->type == type && t->code == -1) {
 626             return t->name;
 627         }
 628     }
 629     return "?";
 630 }
 631
 632 static const char *
 633 lookup_error_code(int type, int code)
 634 {
 635     const struct error_type *t;
 636
 637     for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
 638         if (t->type == type && t->code == code) {
 639             return t->name;
 640         }
 641     }
 642     return "?";
 643 }
 644
 645 /* Pretty-print the OFPT_ERROR packet of 'len' bytes at 'oh' to 'string'
 646  * at the given 'verbosity' level. */
 647 static void
 648 ofp_print_error_msg(struct ds *string, const void *oh, size_t len,
 649                        int verbosity)
 650 {
 651     const struct ofp_error_msg *oem = oh;
 652     int type = ntohs(oem->type);
 653     int code = ntohs(oem->code);
 654     char *s;
 655
 656     ds_put_format(string, " type%d(%s) code%d(%s) payload:\n",
 657                   type, lookup_error_type(type),
 658                   code, lookup_error_code(type, code));
 659
 660     switch (type) {
 661     case OFPET_HELLO_FAILED:
 662         ds_put_printable(string, (char *) oem->data, len - sizeof *oem);
 663         break;
 664
 665     case OFPET_BAD_REQUEST:
 666         s = ofp_to_string(oem->data, len - sizeof *oem, 1);
 667         ds_put_cstr(string, s);
 668         free(s);
 669         break;
 670
 671     default:
 672         ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
 673         break;
 674     }
 675 }
 676
 677 /* Pretty-print the OFPT_PORT_STATUS packet of 'len' bytes at 'oh' to 'string'
 678  * at the given 'verbosity' level. */
 679 static void
 680 ofp_print_port_status(struct ds *string, const void *oh, size_t len,
 681                       int verbosity)
 682 {
 683     const struct ofp_port_status *ops = oh;
 684
 685     if (ops->reason == OFPPR_ADD) {
 686         ds_put_format(string, "add:");
 687     } else if (ops->reason == OFPPR_DELETE) {
 688         ds_put_format(string, "del:");
 689     } else if (ops->reason == OFPPR_MOD) {
 690         ds_put_format(string, "mod:");
 691     } else {
 692         ds_put_format(string, "err:");
 693     }
 694
 695     ofp_print_phy_port(string, &ops->desc);
 696 }
 697
 698 static void
 699 ofp_desc_stats_reply(struct ds *string, const void *body, size_t len,
 700                      int verbosity)
 701 {
 702     const struct ofp_desc_stats *ods = body;
 703
 704     ds_put_format(string, "Manufacturer: %s\n", ods->mfr_desc);
 705     ds_put_format(string, "Hardware: %s\n", ods->hw_desc);
 706     ds_put_format(string, "Software: %s\n", ods->sw_desc);
 707     ds_put_format(string, "Serial Num: %s\n", ods->serial_num);
 708 }
 709
 710 static void
 711 ofp_flow_stats_request(struct ds *string, const void *oh, size_t len,
 712                       int verbosity)
 713 {
 714     const struct ofp_flow_stats_request *fsr = oh;
 715
 716     if (fsr->table_id == 0xff) {
 717         ds_put_format(string, " table_id=any, ");
 718     } else {
 719         ds_put_format(string, " table_id=%"PRIu8", ", fsr->table_id);
 720     }
 721
 722     ofp_print_match(string, &fsr->match, verbosity);
 723 }
 724
 725 static void
 726 ofp_flow_stats_reply(struct ds *string, const void *body_, size_t len,
 727                      int verbosity)
 728 {
 729     const char *body = body_;
 730     const char *pos = body;
 731     for (;;) {
 732         const struct ofp_flow_stats *fs;
 733         ptrdiff_t bytes_left = body + len - pos;
 734         size_t length;
 735
 736         if (bytes_left < sizeof *fs) {
 737             if (bytes_left != 0) {
 738                 ds_put_format(string, " ***%td leftover bytes at end***",
 739                               bytes_left);
 740             }
 741             break;
 742         }
 743
 744         fs = (const void *) pos;
 745         length = ntohs(fs->length);
 746         if (length < sizeof *fs) {
 747             ds_put_format(string, " ***length=%zu shorter than minimum %zu***",
 748                           length, sizeof *fs);
 749             break;
 750         } else if (length > bytes_left) {
 751             ds_put_format(string,
 752                           " ***length=%zu but only %td bytes left***",
 753                           length, bytes_left);
 754             break;
 755         } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
 756             ds_put_format(string,
 757                           " ***length=%zu has %zu bytes leftover in "
 758                           "final action***",
 759                           length,
 760                           (length - sizeof *fs) % sizeof fs->actions[0]);
 761             break;
 762         }
 763
 764         ds_put_format(string, "  duration=%"PRIu32"s, ", ntohl(fs->duration));
 765         ds_put_format(string, "table_id=%"PRIu8", ", fs->table_id);
 766         ds_put_format(string, "priority=%"PRIu16", ",
 767                     fs->match.wildcards ? ntohs(fs->priority) : (uint16_t)-1);
 768         ds_put_format(string, "n_packets=%"PRIu64", ",
 769                     ntohll(fs->packet_count));
 770         ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
 771         ds_put_format(string, "idle_timeout=%"PRIu16",",
 772                       ntohs(fs->idle_timeout));
 773         ds_put_format(string, "hard_timeout=%"PRIu16",",
 774                       ntohs(fs->hard_timeout));
 775         ofp_print_match(string, &fs->match, verbosity);
 776         ofp_print_actions(string, fs->actions, length - sizeof *fs);
 777         ds_put_char(string, '\n');
 778
 779         pos += length;
 780      }
 781 }
 782
 783 static void
 784 ofp_aggregate_stats_request(struct ds *string, const void *oh, size_t len,
 785                             int verbosity)
 786 {
 787     const struct ofp_aggregate_stats_request *asr = oh;
 788
 789     if (asr->table_id == 0xff) {
 790         ds_put_format(string, " table_id=any, ");
 791     } else {
 792         ds_put_format(string, " table_id=%"PRIu8", ", asr->table_id);
 793     }
 794
 795     ofp_print_match(string, &asr->match, verbosity);
 796 }
 797
 798 static void
 799 ofp_aggregate_stats_reply(struct ds *string, const void *body_, size_t len,
 800                           int verbosity)
 801 {
 802     const struct ofp_aggregate_stats_reply *asr = body_;
 803
 804     ds_put_format(string, " packet_count=%"PRIu64, ntohll(asr->packet_count));
 805     ds_put_format(string, " byte_count=%"PRIu64, ntohll(asr->byte_count));
 806     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
 807 }
 808
 809 static void print_port_stat(struct ds *string, const char *leader,
 810                             uint64_t stat, int more)
 811 {
 812     ds_put_cstr(string, leader);
 813     if (stat != -1) {
 814         ds_put_format(string, "%"PRIu64, stat);
 815     } else {
 816         ds_put_char(string, '?');
 817     }
 818     if (more) {
 819         ds_put_cstr(string, ", ");
 820     } else {
 821         ds_put_cstr(string, "\n");
 822     }
 823 }
 824
 825 static void
 826 ofp_port_stats_reply(struct ds *string, const void *body, size_t len,
 827                      int verbosity)
 828 {
 829     const struct ofp_port_stats *ps = body;
 830     size_t n = len / sizeof *ps;
 831     ds_put_format(string, " %zu ports\n", n);
 832     if (verbosity < 1) {
 833         return;
 834     }
 835
 836     for (; n--; ps++) {
 837         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
 838
 839         ds_put_cstr(string, "rx ");
 840         print_port_stat(string, "pkts=", ntohll(ps->rx_packets), 1);
 841         print_port_stat(string, "bytes=", ntohll(ps->rx_bytes), 1);
 842         print_port_stat(string, "drop=", ntohll(ps->rx_dropped), 1);
 843         print_port_stat(string, "errs=", ntohll(ps->rx_errors), 1);
 844         print_port_stat(string, "frame=", ntohll(ps->rx_frame_err), 1);
 845         print_port_stat(string, "over=", ntohll(ps->rx_over_err), 1);
 846         print_port_stat(string, "crc=", ntohll(ps->rx_crc_err), 0);
 847
 848         ds_put_cstr(string, "           tx ");
 849         print_port_stat(string, "pkts=", ntohll(ps->tx_packets), 1);
 850         print_port_stat(string, "bytes=", ntohll(ps->tx_bytes), 1);
 851         print_port_stat(string, "drop=", ntohll(ps->tx_dropped), 1);
 852         print_port_stat(string, "errs=", ntohll(ps->tx_errors), 1);
 853         print_port_stat(string, "coll=", ntohll(ps->collisions), 0);
 854     }
 855 }
 856
 857 static void
 858 ofp_table_stats_reply(struct ds *string, const void *body, size_t len,
 859                      int verbosity)
 860 {
 861     const struct ofp_table_stats *ts = body;
 862     size_t n = len / sizeof *ts;
 863     ds_put_format(string, " %zu tables\n", n);
 864     if (verbosity < 1) {
 865         return;
 866     }
 867
 868     for (; n--; ts++) {
 869         char name[OFP_MAX_TABLE_NAME_LEN + 1];
 870         strncpy(name, ts->name, sizeof name);
 871         name[OFP_MAX_TABLE_NAME_LEN] = '\0';
 872
 873         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
 874         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
 875         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
 876         ds_put_format(string, "active=%6"PRIu32", ", ntohl(ts->active_count));
 877         ds_put_format(string, "matched=%6"PRIu64"\n",
 878                       ntohll(ts->matched_count));
 879      }
 880 }
 881
 882 static void
 883 vendor_stat(struct ds *string, const void *body, size_t len,
 884             int verbosity UNUSED)
 885 {
 886     ds_put_format(string, " vendor=%08"PRIx32, ntohl(*(uint32_t *) body));
 887     ds_put_format(string, " %zu bytes additional data",
 888                   len - sizeof(uint32_t));
 889 }
 890
 891 enum stats_direction {
 892     REQUEST,
 893     REPLY
 894 };
 895
 896 static void
 897 print_stats(struct ds *string, int type, const void *body, size_t body_len,
 898             int verbosity, enum stats_direction direction)
 899 {
 900     struct stats_msg {
 901         size_t min_body, max_body;
 902         void (*printer)(struct ds *, const void *, size_t len, int verbosity);
 903     };
 904
 905     struct stats_type {
 906         int type;
 907         const char *name;
 908         struct stats_msg request;
 909         struct stats_msg reply;
 910     };
 911
 912     static const struct stats_type stats_types[] = {
 913         {
 914             OFPST_DESC,
 915             "description",
 916             { 0, 0, NULL },
 917             { 0, SIZE_MAX, ofp_desc_stats_reply },
 918         },
 919         {
 920             OFPST_FLOW,
 921             "flow",
 922             { sizeof(struct ofp_flow_stats_request),
 923               sizeof(struct ofp_flow_stats_request),
 924               ofp_flow_stats_request },
 925             { 0, SIZE_MAX, ofp_flow_stats_reply },
 926         },
 927         {
 928             OFPST_AGGREGATE,
 929             "aggregate",
 930             { sizeof(struct ofp_aggregate_stats_request),
 931               sizeof(struct ofp_aggregate_stats_request),
 932               ofp_aggregate_stats_request },
 933             { sizeof(struct ofp_aggregate_stats_reply),
 934               sizeof(struct ofp_aggregate_stats_reply),
 935               ofp_aggregate_stats_reply },
 936         },
 937         {
 938             OFPST_TABLE,
 939             "table",
 940             { 0, 0, NULL },
 941             { 0, SIZE_MAX, ofp_table_stats_reply },
 942         },
 943         {
 944             OFPST_PORT,
 945             "port",
 946             { 0, 0, NULL, },
 947             { 0, SIZE_MAX, ofp_port_stats_reply },
 948         },
 949         {
 950             OFPST_VENDOR,
 951             "vendor-specific",
 952             { sizeof(uint32_t), SIZE_MAX, vendor_stat },
 953             { sizeof(uint32_t), SIZE_MAX, vendor_stat },
 954         },
 955         {
 956             -1,
 957             "unknown",
 958             { 0, 0, NULL, },
 959             { 0, 0, NULL, },
 960         },
 961     };
 962
 963     const struct stats_type *s;
 964     const struct stats_msg *m;
 965
 966     if (type >= ARRAY_SIZE(stats_types) || !stats_types[type].name) {
 967         ds_put_format(string, " ***unknown type %d***", type);
 968         return;
 969     }
 970     for (s = stats_types; s->type >= 0; s++) {
 971         if (s->type == type) {
 972             break;
 973         }
 974     }
 975     ds_put_format(string, " type=%d(%s)\n", type, s->name);
 976
 977     m = direction == REQUEST ? &s->request : &s->reply;
 978     if (body_len < m->min_body || body_len > m->max_body) {
 979         ds_put_format(string, " ***body_len=%zu not in %zu...%zu***",
 980                       body_len, m->min_body, m->max_body);
 981         return;
 982     }
 983     if (m->printer) {
 984         m->printer(string, body, body_len, verbosity);
 985     }
 986 }
 987
 988 static void
 989 ofp_stats_request(struct ds *string, const void *oh, size_t len, int verbosity)
 990 {
 991     const struct ofp_stats_request *srq = oh;
 992
 993     if (srq->flags) {
 994         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
 995                       ntohs(srq->flags));
 996     }
 997
 998     print_stats(string, ntohs(srq->type), srq->body,
 999                 len - offsetof(struct ofp_stats_request, body),
1000                 verbosity, REQUEST);
1001 }
1002
1003 static void
1004 ofp_stats_reply(struct ds *string, const void *oh, size_t len, int verbosity)
1005 {
1006     const struct ofp_stats_reply *srp = oh;
1007
1008     ds_put_cstr(string, " flags=");
1009     if (!srp->flags) {
1010         ds_put_cstr(string, "none");
1011     } else {
1012         uint16_t flags = ntohs(srp->flags);
1013         if (flags & OFPSF_REPLY_MORE) {
1014             ds_put_cstr(string, "[more]");
1015             flags &= ~OFPSF_REPLY_MORE;
1016         }
1017         if (flags) {
1018             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]", flags);
1019         }
1020     }
1021
1022     print_stats(string, ntohs(srp->type), srp->body,
1023                 len - offsetof(struct ofp_stats_reply, body),
1024                 verbosity, REPLY);
1025 }
1026
1027 static void
1028 ofp_echo(struct ds *string, const void *oh, size_t len, int verbosity)
1029 {
1030     const struct ofp_header *hdr = oh;
1031
1032     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *hdr);
1033     if (verbosity > 1) {
1034         ds_put_hex_dump(string, hdr, len - sizeof *hdr, 0, true);
1035     }
1036 }
1037
1038 struct openflow_packet {
1039     uint8_t type;
1040     const char *name;
1041     size_t min_size;
1042     void (*printer)(struct ds *, const void *, size_t len, int verbosity);
1043 };
1044
1045 static const struct openflow_packet packets[] = {
1046     {
1047         OFPT_HELLO,
1048         "hello",
1049         sizeof (struct ofp_header),
1050         NULL,
1051     },
1052     {
1053         OFPT_FEATURES_REQUEST,
1054         "features_request",
1055         sizeof (struct ofp_header),
1056         NULL,
1057     },
1058     {
1059         OFPT_FEATURES_REPLY,
1060         "features_reply",
1061         sizeof (struct ofp_switch_features),
1062         ofp_print_switch_features,
1063     },
1064     {
1065         OFPT_GET_CONFIG_REQUEST,
1066         "get_config_request",
1067         sizeof (struct ofp_header),
1068         NULL,
1069     },
1070     {
1071         OFPT_GET_CONFIG_REPLY,
1072         "get_config_reply",
1073         sizeof (struct ofp_switch_config),
1074         ofp_print_switch_config,
1075     },
1076     {
1077         OFPT_SET_CONFIG,
1078         "set_config",
1079         sizeof (struct ofp_switch_config),
1080         ofp_print_switch_config,
1081     },
1082     {
1083         OFPT_PACKET_IN,
1084         "packet_in",
1085         offsetof(struct ofp_packet_in, data),
1086         ofp_packet_in,
1087     },
1088     {
1089         OFPT_PACKET_OUT,
1090         "packet_out",
1091         sizeof (struct ofp_packet_out),
1092         ofp_packet_out,
1093     },
1094     {
1095         OFPT_FLOW_MOD,
1096         "flow_mod",
1097         sizeof (struct ofp_flow_mod),
1098         ofp_print_flow_mod,
1099     },
1100     {
1101         OFPT_FLOW_EXPIRED,
1102         "flow_expired",
1103         sizeof (struct ofp_flow_expired),
1104         ofp_print_flow_expired,
1105     },
1106     {
1107         OFPT_PORT_MOD,
1108         "port_mod",
1109         sizeof (struct ofp_port_mod),
1110         NULL,
1111     },
1112     {
1113         OFPT_PORT_STATUS,
1114         "port_status",
1115         sizeof (struct ofp_port_status),
1116         ofp_print_port_status
1117     },
1118     {
1119         OFPT_ERROR,
1120         "error_msg",
1121         sizeof (struct ofp_error_msg),
1122         ofp_print_error_msg,
1123     },
1124     {
1125         OFPT_STATS_REQUEST,
1126         "stats_request",
1127         sizeof (struct ofp_stats_request),
1128         ofp_stats_request,
1129     },
1130     {
1131         OFPT_STATS_REPLY,
1132         "stats_reply",
1133         sizeof (struct ofp_stats_reply),
1134         ofp_stats_reply,
1135     },
1136     {
1137         OFPT_ECHO_REQUEST,
1138         "echo_request",
1139         sizeof (struct ofp_header),
1140         ofp_echo,
1141     },
1142     {
1143         OFPT_ECHO_REPLY,
1144         "echo_reply",
1145         sizeof (struct ofp_header),
1146         ofp_echo,
1147     },
1148 };
1149
1150 /* Composes and returns a string representing the OpenFlow packet of 'len'
1151  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1152  * verbosity and higher numbers increase verbosity.  The caller is responsible
1153  * for freeing the string. */
1154 char *
1155 ofp_to_string(const void *oh_, size_t len, int verbosity)
1156 {
1157     struct ds string = DS_EMPTY_INITIALIZER;
1158     const struct ofp_header *oh = oh_;
1159     const struct openflow_packet *pkt;
1160
1161     if (len < sizeof(struct ofp_header)) {
1162         ds_put_cstr(&string, "OpenFlow packet too short:\n");
1163         ds_put_hex_dump(&string, oh, len, 0, true);
1164         return ds_cstr(&string);
1165     } else if (oh->version != OFP_VERSION) {
1166         ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n", oh->version);
1167         ds_put_hex_dump(&string, oh, len, 0, true);
1168         return ds_cstr(&string);
1169     }
1170
1171     for (pkt = packets; ; pkt++) {
1172         if (pkt >= &packets[ARRAY_SIZE(packets)]) {
1173             ds_put_format(&string, "Unknown OpenFlow packet type %"PRIu8":\n",
1174                           oh->type);
1175             ds_put_hex_dump(&string, oh, len, 0, true);
1176             return ds_cstr(&string);
1177         } else if (oh->type == pkt->type) {
1178             break;
1179         }
1180     }
1181
1182     ds_put_format(&string, "%s (xid=0x%"PRIx32"):", pkt->name, oh->xid);
1183
1184     if (ntohs(oh->length) > len)
1185         ds_put_format(&string, " (***truncated to %zu bytes from %"PRIu16"***)",
1186                 len, ntohs(oh->length));
1187     else if (ntohs(oh->length) < len) {
1188         ds_put_format(&string, " (***only uses %"PRIu16" bytes out of %zu***)\n",
1189                 ntohs(oh->length), len);
1190         len = ntohs(oh->length);
1191     }
1192
1193     if (len < pkt->min_size) {
1194         ds_put_format(&string, " (***length=%zu < min_size=%zu***)\n",
1195                 len, pkt->min_size);
1196     } else if (!pkt->printer) {
1197         if (len > sizeof *oh) {
1198             ds_put_format(&string, " length=%"PRIu16" (decoder not implemented)\n",
1199                           ntohs(oh->length));
1200         }
1201     } else {
1202         pkt->printer(&string, oh, len, verbosity);
1203     }
1204     if (verbosity >= 3) {
1205         ds_put_hex_dump(&string, oh, len, 0, true);
1206     }
1207     if (string.string[string.length - 1] != '\n') {
1208         ds_put_char(&string, '\n');
1209     }
1210     return ds_cstr(&string);
1211 }
1212 \f
1213 static void
1214 print_and_free(FILE *stream, char *string)
1215 {
1216     fputs(string, stream);
1217     free(string);
1218 }
1219
1220 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1221  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1222  * numbers increase verbosity. */
1223 void
1224 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1225 {
1226     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1227 }
1228
1229 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1230  * 'data' to 'stream' using tcpdump.  'total_len' specifies the full length of
1231  * the Ethernet frame (of which 'len' bytes were captured).
1232  *
1233  * This starts and kills a tcpdump subprocess so it's quite expensive. */
1234 void
1235 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1236 {
1237     print_and_free(stream, ofp_packet_to_string(data, len, total_len));
1238 }