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