lib/ofp-print.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include "ofp-print.h"
  19
  20 #include <errno.h>
  21 #include <inttypes.h>
  22 #include <sys/types.h>
  23 #include <netinet/in.h>
  24 #include <sys/wait.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <ctype.h>
  28
  29 #include "byte-order.h"
  30 #include "compiler.h"
  31 #include "dynamic-string.h"
  32 #include "flow.h"
  33 #include "nx-match.h"
  34 #include "ofp-util.h"
  35 #include "ofpbuf.h"
  36 #include "openflow/openflow.h"
  37 #include "openflow/nicira-ext.h"
  38 #include "packets.h"
  39 #include "pcap.h"
  40 #include "type-props.h"
  41 #include "util.h"
  42
  43 static void ofp_print_port_name(struct ds *string, uint16_t port);
  44 static void ofp_print_queue_name(struct ds *string, uint32_t port);
  45 static void ofp_print_error(struct ds *, int error);
  46
  47
  48 /* Returns a string that represents the contents of the Ethernet frame in the
  49  * 'len' bytes starting at 'data' to 'stream' as output by tcpdump.
  50  * 'total_len' specifies the full length of the Ethernet frame (of which 'len'
  51  * bytes were captured).
  52  *
  53  * The caller must free the returned string.
  54  *
  55  * This starts and kills a tcpdump subprocess so it's quite expensive. */
  56 char *
  57 ofp_packet_to_string(const void *data, size_t len, size_t total_len OVS_UNUSED)
  58 {
  59     struct ds ds = DS_EMPTY_INITIALIZER;
  60     struct ofpbuf buf;
  61
  62     char command[128];
  63     FILE *pcap;
  64     FILE *tcpdump;
  65     int status;
  66     int c;
  67
  68     ofpbuf_use_const(&buf, data, len);
  69
  70     pcap = tmpfile();
  71     if (!pcap) {
  72         ovs_error(errno, "tmpfile");
  73         return xstrdup("<error>");
  74     }
  75     pcap_write_header(pcap);
  76     pcap_write(pcap, &buf);
  77     fflush(pcap);
  78     if (ferror(pcap)) {
  79         ovs_error(errno, "error writing temporary file");
  80     }
  81     rewind(pcap);
  82
  83     snprintf(command, sizeof command, "/usr/sbin/tcpdump -e -n -r /dev/fd/%d 2>/dev/null",
  84              fileno(pcap));
  85     tcpdump = popen(command, "r");
  86     fclose(pcap);
  87     if (!tcpdump) {
  88         ovs_error(errno, "exec(\"%s\")", command);
  89         return xstrdup("<error>");
  90     }
  91
  92     while ((c = getc(tcpdump)) != EOF) {
  93         ds_put_char(&ds, c);
  94     }
  95
  96     status = pclose(tcpdump);
  97     if (WIFEXITED(status)) {
  98         if (WEXITSTATUS(status))
  99             ovs_error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
 100     } else if (WIFSIGNALED(status)) {
 101         ovs_error(0, "tcpdump exited with signal %d", WTERMSIG(status));
 102     }
 103     return ds_cstr(&ds);
 104 }
 105
 106 static void
 107 ofp_print_packet_in(struct ds *string, const struct ofp_packet_in *op,
 108                     int verbosity)
 109 {
 110     size_t len = ntohs(op->header.length);
 111     size_t data_len;
 112
 113     ds_put_format(string, " total_len=%"PRIu16" in_port=",
 114                   ntohs(op->total_len));
 115     ofp_print_port_name(string, ntohs(op->in_port));
 116
 117     if (op->reason == OFPR_ACTION)
 118         ds_put_cstr(string, " (via action)");
 119     else if (op->reason != OFPR_NO_MATCH)
 120         ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
 121
 122     data_len = len - offsetof(struct ofp_packet_in, data);
 123     ds_put_format(string, " data_len=%zu", data_len);
 124     if (htonl(op->buffer_id) == UINT32_MAX) {
 125         ds_put_format(string, " (unbuffered)");
 126         if (ntohs(op->total_len) != data_len)
 127             ds_put_format(string, " (***total_len != data_len***)");
 128     } else {
 129         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(op->buffer_id));
 130         if (ntohs(op->total_len) < data_len)
 131             ds_put_format(string, " (***total_len < data_len***)");
 132     }
 133     ds_put_char(string, '\n');
 134
 135     if (verbosity > 0) {
 136         struct flow flow;
 137         struct ofpbuf packet;
 138
 139         ofpbuf_use_const(&packet, op->data, data_len);
 140         flow_extract(&packet, 0, ntohs(op->in_port), &flow);
 141         flow_format(string, &flow);
 142         ds_put_char(string, '\n');
 143     }
 144     if (verbosity > 1) {
 145         char *packet = ofp_packet_to_string(op->data, data_len,
 146                                             ntohs(op->total_len));
 147         ds_put_cstr(string, packet);
 148         free(packet);
 149     }
 150 }
 151
 152 static void ofp_print_port_name(struct ds *string, uint16_t port)
 153 {
 154     const char *name;
 155     switch (port) {
 156     case OFPP_IN_PORT:
 157         name = "IN_PORT";
 158         break;
 159     case OFPP_TABLE:
 160         name = "TABLE";
 161         break;
 162     case OFPP_NORMAL:
 163         name = "NORMAL";
 164         break;
 165     case OFPP_FLOOD:
 166         name = "FLOOD";
 167         break;
 168     case OFPP_ALL:
 169         name = "ALL";
 170         break;
 171     case OFPP_CONTROLLER:
 172         name = "CONTROLLER";
 173         break;
 174     case OFPP_LOCAL:
 175         name = "LOCAL";
 176         break;
 177     case OFPP_NONE:
 178         name = "NONE";
 179         break;
 180     default:
 181         ds_put_format(string, "%"PRIu16, port);
 182         return;
 183     }
 184     ds_put_cstr(string, name);
 185 }
 186
 187
 188 static void
 189 print_note(struct ds *string, const struct nx_action_note *nan)
 190 {
 191     size_t len;
 192     size_t i;
 193
 194     ds_put_cstr(string, "note:");
 195     len = ntohs(nan->len) - offsetof(struct nx_action_note, note);
 196     for (i = 0; i < len; i++) {
 197         if (i) {
 198             ds_put_char(string, '.');
 199         }
 200         ds_put_format(string, "%02"PRIx8, nan->note[i]);
 201     }
 202 }
 203
 204 static int
 205 nx_action_len(enum nx_action_subtype subtype)
 206 {
 207     switch (subtype) {
 208     case NXAST_SNAT__OBSOLETE: return -1;
 209     case NXAST_RESUBMIT: return sizeof(struct nx_action_resubmit);
 210     case NXAST_SET_TUNNEL: return sizeof(struct nx_action_set_tunnel);
 211     case NXAST_DROP_SPOOFED_ARP:
 212         return sizeof(struct nx_action_drop_spoofed_arp);
 213     case NXAST_SET_QUEUE: return sizeof(struct nx_action_set_queue);
 214     case NXAST_POP_QUEUE: return sizeof(struct nx_action_pop_queue);
 215     case NXAST_REG_MOVE: return sizeof(struct nx_action_reg_move);
 216     case NXAST_REG_LOAD: return sizeof(struct nx_action_reg_load);
 217     case NXAST_NOTE: return -1;
 218     case NXAST_SET_TUNNEL64: return sizeof(struct nx_action_set_tunnel64);
 219     default: return -1;
 220     }
 221 }
 222
 223 static void
 224 ofp_print_nx_action(struct ds *string, const struct nx_action_header *nah)
 225 {
 226     uint16_t subtype = ntohs(nah->subtype);
 227     int required_len = nx_action_len(subtype);
 228     int len = ntohs(nah->len);
 229
 230     if (required_len != -1 && required_len != len) {
 231         ds_put_format(string, "***Nicira action %"PRIu16" wrong length: %d***",
 232                       subtype, len);
 233         return;
 234     }
 235
 236     if (subtype <= TYPE_MAXIMUM(enum nx_action_subtype)) {
 237         const struct nx_action_set_tunnel64 *nast64;
 238         const struct nx_action_set_tunnel *nast;
 239         const struct nx_action_set_queue *nasq;
 240         const struct nx_action_resubmit *nar;
 241         const struct nx_action_reg_move *move;
 242         const struct nx_action_reg_load *load;
 243
 244         switch ((enum nx_action_subtype) subtype) {
 245         case NXAST_RESUBMIT:
 246             nar = (struct nx_action_resubmit *)nah;
 247             ds_put_format(string, "resubmit:");
 248             ofp_print_port_name(string, ntohs(nar->in_port));
 249             return;
 250
 251         case NXAST_SET_TUNNEL:
 252             nast = (struct nx_action_set_tunnel *)nah;
 253             ds_put_format(string, "set_tunnel:%#"PRIx32, ntohl(nast->tun_id));
 254             return;
 255
 256         case NXAST_DROP_SPOOFED_ARP:
 257             ds_put_cstr(string, "drop_spoofed_arp");
 258             return;
 259
 260         case NXAST_SET_QUEUE:
 261             nasq = (struct nx_action_set_queue *)nah;
 262             ds_put_format(string, "set_queue:%u", ntohl(nasq->queue_id));
 263             return;
 264
 265         case NXAST_POP_QUEUE:
 266             ds_put_cstr(string, "pop_queue");
 267             return;
 268
 269         case NXAST_NOTE:
 270             print_note(string, (const struct nx_action_note *) nah);
 271             return;
 272
 273         case NXAST_REG_MOVE:
 274             move = (const struct nx_action_reg_move *) nah;
 275             nxm_format_reg_move(move, string);
 276             return;
 277
 278         case NXAST_REG_LOAD:
 279             load = (const struct nx_action_reg_load *) nah;
 280             nxm_format_reg_load(load, string);
 281             return;
 282
 283         case NXAST_SET_TUNNEL64:
 284             nast64 = (struct nx_action_set_tunnel64 *) nah;
 285             ds_put_format(string, "set_tunnel64:%#"PRIx64,
 286                           ntohll(nast64->tun_id));
 287             return;
 288
 289         case NXAST_SNAT__OBSOLETE:
 290         default:
 291             break;
 292         }
 293     }
 294
 295     ds_put_format(string, "***unknown Nicira action:%"PRIu16"***", subtype);
 296 }
 297
 298 static int
 299 ofp_action_len(enum ofp_action_type type)
 300 {
 301     switch (type) {
 302     case OFPAT_OUTPUT: return sizeof(struct ofp_action_output);
 303     case OFPAT_SET_VLAN_VID: return sizeof(struct ofp_action_vlan_vid);
 304     case OFPAT_SET_VLAN_PCP: return sizeof(struct ofp_action_vlan_pcp);
 305     case OFPAT_STRIP_VLAN: return sizeof(struct ofp_action_header);
 306     case OFPAT_SET_DL_SRC: return sizeof(struct ofp_action_dl_addr);
 307     case OFPAT_SET_DL_DST: return sizeof(struct ofp_action_dl_addr);
 308     case OFPAT_SET_NW_SRC: return sizeof(struct ofp_action_nw_addr);
 309     case OFPAT_SET_NW_DST: return sizeof(struct ofp_action_nw_addr);
 310     case OFPAT_SET_NW_TOS: return sizeof(struct ofp_action_nw_tos);
 311     case OFPAT_SET_TP_SRC: return sizeof(struct ofp_action_tp_port);
 312     case OFPAT_SET_TP_DST: return sizeof(struct ofp_action_tp_port);
 313     case OFPAT_ENQUEUE: return sizeof(struct ofp_action_enqueue);
 314     case OFPAT_VENDOR: return -1;
 315     default: return -1;
 316     }
 317 }
 318
 319 static int
 320 ofp_print_action(struct ds *string, const struct ofp_action_header *ah,
 321         size_t actions_len)
 322 {
 323     enum ofp_action_type type;
 324     int required_len;
 325     size_t len;
 326
 327     if (actions_len < sizeof *ah) {
 328         ds_put_format(string, "***action array too short for next action***\n");
 329         return -1;
 330     }
 331
 332     type = ntohs(ah->type);
 333     len = ntohs(ah->len);
 334     if (actions_len < len) {
 335         ds_put_format(string, "***truncated action %d***\n", (int) type);
 336         return -1;
 337     }
 338
 339     if (!len) {
 340         ds_put_format(string, "***zero-length action***\n");
 341         return 8;
 342     }
 343
 344     if ((len % OFP_ACTION_ALIGN) != 0) {
 345         ds_put_format(string,
 346                       "***action %d length not a multiple of %d***\n",
 347                       (int) type, OFP_ACTION_ALIGN);
 348         return -1;
 349     }
 350
 351     required_len = ofp_action_len(type);
 352     if (required_len >= 0 && len != required_len) {
 353         ds_put_format(string,
 354                       "***action %d wrong length: %zu***\n", (int) type, len);
 355         return -1;
 356     }
 357
 358     switch (type) {
 359     case OFPAT_OUTPUT: {
 360         struct ofp_action_output *oa = (struct ofp_action_output *)ah;
 361         uint16_t port = ntohs(oa->port);
 362         if (port < OFPP_MAX) {
 363             ds_put_format(string, "output:%"PRIu16, port);
 364         } else {
 365             ofp_print_port_name(string, port);
 366             if (port == OFPP_CONTROLLER) {
 367                 if (oa->max_len) {
 368                     ds_put_format(string, ":%"PRIu16, ntohs(oa->max_len));
 369                 } else {
 370                     ds_put_cstr(string, ":all");
 371                 }
 372             }
 373         }
 374         break;
 375     }
 376
 377     case OFPAT_ENQUEUE: {
 378         struct ofp_action_enqueue *ea = (struct ofp_action_enqueue *)ah;
 379         unsigned int port = ntohs(ea->port);
 380         unsigned int queue_id = ntohl(ea->queue_id);
 381         ds_put_format(string, "enqueue:");
 382         if (port != OFPP_IN_PORT) {
 383             ds_put_format(string, "%u", port);
 384         } else {
 385             ds_put_cstr(string, "IN_PORT");
 386         }
 387         ds_put_format(string, "q%u", queue_id);
 388         break;
 389     }
 390
 391     case OFPAT_SET_VLAN_VID: {
 392         struct ofp_action_vlan_vid *va = (struct ofp_action_vlan_vid *)ah;
 393         ds_put_format(string, "mod_vlan_vid:%"PRIu16, ntohs(va->vlan_vid));
 394         break;
 395     }
 396
 397     case OFPAT_SET_VLAN_PCP: {
 398         struct ofp_action_vlan_pcp *va = (struct ofp_action_vlan_pcp *)ah;
 399         ds_put_format(string, "mod_vlan_pcp:%"PRIu8, va->vlan_pcp);
 400         break;
 401     }
 402
 403     case OFPAT_STRIP_VLAN:
 404         ds_put_cstr(string, "strip_vlan");
 405         break;
 406
 407     case OFPAT_SET_DL_SRC: {
 408         struct ofp_action_dl_addr *da = (struct ofp_action_dl_addr *)ah;
 409         ds_put_format(string, "mod_dl_src:"ETH_ADDR_FMT,
 410                 ETH_ADDR_ARGS(da->dl_addr));
 411         break;
 412     }
 413
 414     case OFPAT_SET_DL_DST: {
 415         struct ofp_action_dl_addr *da = (struct ofp_action_dl_addr *)ah;
 416         ds_put_format(string, "mod_dl_dst:"ETH_ADDR_FMT,
 417                 ETH_ADDR_ARGS(da->dl_addr));
 418         break;
 419     }
 420
 421     case OFPAT_SET_NW_SRC: {
 422         struct ofp_action_nw_addr *na = (struct ofp_action_nw_addr *)ah;
 423         ds_put_format(string, "mod_nw_src:"IP_FMT, IP_ARGS(&na->nw_addr));
 424         break;
 425     }
 426
 427     case OFPAT_SET_NW_DST: {
 428         struct ofp_action_nw_addr *na = (struct ofp_action_nw_addr *)ah;
 429         ds_put_format(string, "mod_nw_dst:"IP_FMT, IP_ARGS(&na->nw_addr));
 430         break;
 431     }
 432
 433     case OFPAT_SET_NW_TOS: {
 434         struct ofp_action_nw_tos *nt = (struct ofp_action_nw_tos *)ah;
 435         ds_put_format(string, "mod_nw_tos:%d", nt->nw_tos);
 436         break;
 437     }
 438
 439     case OFPAT_SET_TP_SRC: {
 440         struct ofp_action_tp_port *ta = (struct ofp_action_tp_port *)ah;
 441         ds_put_format(string, "mod_tp_src:%d", ntohs(ta->tp_port));
 442         break;
 443     }
 444
 445     case OFPAT_SET_TP_DST: {
 446         struct ofp_action_tp_port *ta = (struct ofp_action_tp_port *)ah;
 447         ds_put_format(string, "mod_tp_dst:%d", ntohs(ta->tp_port));
 448         break;
 449     }
 450
 451     case OFPAT_VENDOR: {
 452         struct ofp_action_vendor_header *avh
 453                 = (struct ofp_action_vendor_header *)ah;
 454         if (len < sizeof *avh) {
 455             ds_put_format(string, "***ofpat_vendor truncated***\n");
 456             return -1;
 457         }
 458         if (avh->vendor == htonl(NX_VENDOR_ID)) {
 459             ofp_print_nx_action(string, (struct nx_action_header *)avh);
 460         } else {
 461             ds_put_format(string, "vendor action:0x%x", ntohl(avh->vendor));
 462         }
 463         break;
 464     }
 465
 466     default:
 467         ds_put_format(string, "(decoder %d not implemented)", (int) type);
 468         break;
 469     }
 470
 471     return len;
 472 }
 473
 474 void
 475 ofp_print_actions(struct ds *string, const struct ofp_action_header *action,
 476                   size_t actions_len)
 477 {
 478     uint8_t *p = (uint8_t *)action;
 479     int len = 0;
 480
 481     ds_put_cstr(string, "actions=");
 482     if (!actions_len) {
 483         ds_put_cstr(string, "drop");
 484     }
 485     while (actions_len > 0) {
 486         if (len) {
 487             ds_put_cstr(string, ",");
 488         }
 489         len = ofp_print_action(string, (struct ofp_action_header *)p,
 490                 actions_len);
 491         if (len < 0) {
 492             return;
 493         }
 494         p += len;
 495         actions_len -= len;
 496     }
 497 }
 498
 499 static void
 500 ofp_print_packet_out(struct ds *string, const struct ofp_packet_out *opo,
 501                      int verbosity)
 502 {
 503     size_t len = ntohs(opo->header.length);
 504     size_t actions_len = ntohs(opo->actions_len);
 505
 506     ds_put_cstr(string, " in_port=");
 507     ofp_print_port_name(string, ntohs(opo->in_port));
 508
 509     ds_put_format(string, " actions_len=%zu ", actions_len);
 510     if (actions_len > (ntohs(opo->header.length) - sizeof *opo)) {
 511         ds_put_format(string, "***packet too short for action length***\n");
 512         return;
 513     }
 514     ofp_print_actions(string, opo->actions, actions_len);
 515
 516     if (ntohl(opo->buffer_id) == UINT32_MAX) {
 517         int data_len = len - sizeof *opo - actions_len;
 518         ds_put_format(string, " data_len=%d", data_len);
 519         if (verbosity > 0 && len > sizeof *opo) {
 520             char *packet = ofp_packet_to_string(
 521                     (uint8_t *)opo->actions + actions_len, data_len, data_len);
 522             ds_put_char(string, '\n');
 523             ds_put_cstr(string, packet);
 524             free(packet);
 525         }
 526     } else {
 527         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(opo->buffer_id));
 528     }
 529     ds_put_char(string, '\n');
 530 }
 531
 532 /* qsort comparison function. */
 533 static int
 534 compare_ports(const void *a_, const void *b_)
 535 {
 536     const struct ofp_phy_port *a = a_;
 537     const struct ofp_phy_port *b = b_;
 538     uint16_t ap = ntohs(a->port_no);
 539     uint16_t bp = ntohs(b->port_no);
 540
 541     return ap < bp ? -1 : ap > bp;
 542 }
 543
 544 static void ofp_print_port_features(struct ds *string, uint32_t features)
 545 {
 546     if (features == 0) {
 547         ds_put_cstr(string, "Unsupported\n");
 548         return;
 549     }
 550     if (features & OFPPF_10MB_HD) {
 551         ds_put_cstr(string, "10MB-HD ");
 552     }
 553     if (features & OFPPF_10MB_FD) {
 554         ds_put_cstr(string, "10MB-FD ");
 555     }
 556     if (features & OFPPF_100MB_HD) {
 557         ds_put_cstr(string, "100MB-HD ");
 558     }
 559     if (features & OFPPF_100MB_FD) {
 560         ds_put_cstr(string, "100MB-FD ");
 561     }
 562     if (features & OFPPF_1GB_HD) {
 563         ds_put_cstr(string, "1GB-HD ");
 564     }
 565     if (features & OFPPF_1GB_FD) {
 566         ds_put_cstr(string, "1GB-FD ");
 567     }
 568     if (features & OFPPF_10GB_FD) {
 569         ds_put_cstr(string, "10GB-FD ");
 570     }
 571     if (features & OFPPF_COPPER) {
 572         ds_put_cstr(string, "COPPER ");
 573     }
 574     if (features & OFPPF_FIBER) {
 575         ds_put_cstr(string, "FIBER ");
 576     }
 577     if (features & OFPPF_AUTONEG) {
 578         ds_put_cstr(string, "AUTO_NEG ");
 579     }
 580     if (features & OFPPF_PAUSE) {
 581         ds_put_cstr(string, "AUTO_PAUSE ");
 582     }
 583     if (features & OFPPF_PAUSE_ASYM) {
 584         ds_put_cstr(string, "AUTO_PAUSE_ASYM ");
 585     }
 586     ds_put_char(string, '\n');
 587 }
 588
 589 static void
 590 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
 591 {
 592     char name[OFP_MAX_PORT_NAME_LEN];
 593     int j;
 594
 595     memcpy(name, port->name, sizeof name);
 596     for (j = 0; j < sizeof name - 1; j++) {
 597         if (!isprint(name[j])) {
 598             break;
 599         }
 600     }
 601     name[j] = '\0';
 602
 603     ds_put_char(string, ' ');
 604     ofp_print_port_name(string, ntohs(port->port_no));
 605     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT", config: %#x, state:%#x\n",
 606             name, ETH_ADDR_ARGS(port->hw_addr), ntohl(port->config),
 607             ntohl(port->state));
 608     if (port->curr) {
 609         ds_put_format(string, "     current:    ");
 610         ofp_print_port_features(string, ntohl(port->curr));
 611     }
 612     if (port->advertised) {
 613         ds_put_format(string, "     advertised: ");
 614         ofp_print_port_features(string, ntohl(port->advertised));
 615     }
 616     if (port->supported) {
 617         ds_put_format(string, "     supported:  ");
 618         ofp_print_port_features(string, ntohl(port->supported));
 619     }
 620     if (port->peer) {
 621         ds_put_format(string, "     peer:       ");
 622         ofp_print_port_features(string, ntohl(port->peer));
 623     }
 624 }
 625
 626 static void
 627 ofp_print_switch_features(struct ds *string,
 628                           const struct ofp_switch_features *osf)
 629 {
 630     size_t len = ntohs(osf->header.length);
 631     struct ofp_phy_port *port_list;
 632     int n_ports;
 633     int i;
 634
 635     ds_put_format(string, " ver:0x%x, dpid:%016"PRIx64"\n",
 636             osf->header.version, ntohll(osf->datapath_id));
 637     ds_put_format(string, "n_tables:%d, n_buffers:%d\n", osf->n_tables,
 638             ntohl(osf->n_buffers));
 639     ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
 640            ntohl(osf->capabilities), ntohl(osf->actions));
 641
 642     n_ports = (len - sizeof *osf) / sizeof *osf->ports;
 643
 644     port_list = xmemdup(osf->ports, len - sizeof *osf);
 645     qsort(port_list, n_ports, sizeof *port_list, compare_ports);
 646     for (i = 0; i < n_ports; i++) {
 647         ofp_print_phy_port(string, &port_list[i]);
 648     }
 649     free(port_list);
 650 }
 651
 652 static void
 653 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
 654 {
 655     uint16_t flags;
 656
 657     flags = ntohs(osc->flags);
 658     if (flags) {
 659         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
 660     }
 661
 662     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
 663 }
 664
 665 static void print_wild(struct ds *string, const char *leader, int is_wild,
 666             int verbosity, const char *format, ...)
 667             __attribute__((format(printf, 5, 6)));
 668
 669 static void print_wild(struct ds *string, const char *leader, int is_wild,
 670                        int verbosity, const char *format, ...)
 671 {
 672     if (is_wild && verbosity < 2) {
 673         return;
 674     }
 675     ds_put_cstr(string, leader);
 676     if (!is_wild) {
 677         va_list args;
 678
 679         va_start(args, format);
 680         ds_put_format_valist(string, format, args);
 681         va_end(args);
 682     } else {
 683         ds_put_char(string, '*');
 684     }
 685     ds_put_char(string, ',');
 686 }
 687
 688 static void
 689 print_ip_netmask(struct ds *string, const char *leader, uint32_t ip,
 690                  uint32_t wild_bits, int verbosity)
 691 {
 692     if (wild_bits >= 32 && verbosity < 2) {
 693         return;
 694     }
 695     ds_put_cstr(string, leader);
 696     if (wild_bits < 32) {
 697         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
 698         if (wild_bits) {
 699             ds_put_format(string, "/%d", 32 - wild_bits);
 700         }
 701     } else {
 702         ds_put_char(string, '*');
 703     }
 704     ds_put_char(string, ',');
 705 }
 706
 707 void
 708 ofp_print_match(struct ds *f, const struct ofp_match *om, int verbosity)
 709 {
 710     char *s = ofp_match_to_string(om, verbosity);
 711     ds_put_cstr(f, s);
 712     free(s);
 713 }
 714
 715 char *
 716 ofp_match_to_string(const struct ofp_match *om, int verbosity)
 717 {
 718     struct ds f = DS_EMPTY_INITIALIZER;
 719     uint32_t w = ntohl(om->wildcards);
 720     bool skip_type = false;
 721     bool skip_proto = false;
 722
 723     if (!(w & OFPFW_DL_TYPE)) {
 724         skip_type = true;
 725         if (om->dl_type == htons(ETH_TYPE_IP)) {
 726             if (!(w & OFPFW_NW_PROTO)) {
 727                 skip_proto = true;
 728                 if (om->nw_proto == IP_TYPE_ICMP) {
 729                     ds_put_cstr(&f, "icmp,");
 730                 } else if (om->nw_proto == IP_TYPE_TCP) {
 731                     ds_put_cstr(&f, "tcp,");
 732                 } else if (om->nw_proto == IP_TYPE_UDP) {
 733                     ds_put_cstr(&f, "udp,");
 734                 } else {
 735                     ds_put_cstr(&f, "ip,");
 736                     skip_proto = false;
 737                 }
 738             } else {
 739                 ds_put_cstr(&f, "ip,");
 740             }
 741         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
 742             ds_put_cstr(&f, "arp,");
 743         } else {
 744             skip_type = false;
 745         }
 746     }
 747     if (w & NXFW_TUN_ID) {
 748         ds_put_cstr(&f, "tun_id_wild,");
 749     }
 750     print_wild(&f, "in_port=", w & OFPFW_IN_PORT, verbosity,
 751                "%d", ntohs(om->in_port));
 752     print_wild(&f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
 753                "%d", ntohs(om->dl_vlan));
 754     print_wild(&f, "dl_vlan_pcp=", w & OFPFW_DL_VLAN_PCP, verbosity,
 755                "%d", om->dl_vlan_pcp);
 756     print_wild(&f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
 757                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
 758     print_wild(&f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
 759                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
 760     if (!skip_type) {
 761         print_wild(&f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
 762                    "0x%04x", ntohs(om->dl_type));
 763     }
 764     print_ip_netmask(&f, "nw_src=", om->nw_src,
 765                      (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
 766     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
 767                      (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
 768     if (!skip_proto) {
 769         if (om->dl_type == htons(ETH_TYPE_ARP)) {
 770             print_wild(&f, "opcode=", w & OFPFW_NW_PROTO, verbosity,
 771                        "%u", om->nw_proto);
 772         } else {
 773             print_wild(&f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
 774                        "%u", om->nw_proto);
 775         }
 776     }
 777     print_wild(&f, "nw_tos=", w & OFPFW_NW_TOS, verbosity,
 778                "%u", om->nw_tos);
 779     if (om->nw_proto == IP_TYPE_ICMP) {
 780         print_wild(&f, "icmp_type=", w & OFPFW_ICMP_TYPE, verbosity,
 781                    "%d", ntohs(om->icmp_type));
 782         print_wild(&f, "icmp_code=", w & OFPFW_ICMP_CODE, verbosity,
 783                    "%d", ntohs(om->icmp_code));
 784     } else {
 785         print_wild(&f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
 786                    "%d", ntohs(om->tp_src));
 787         print_wild(&f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
 788                    "%d", ntohs(om->tp_dst));
 789     }
 790     if (ds_last(&f) == ',') {
 791         f.length--;
 792     }
 793     return ds_cstr(&f);
 794 }
 795
 796 static void
 797 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh,
 798                    enum ofputil_msg_code code, int verbosity)
 799 {
 800     struct flow_mod fm;
 801     int error;
 802
 803     error = ofputil_decode_flow_mod(&fm, oh, NXFF_OPENFLOW10);
 804     if (error) {
 805         ofp_print_error(s, error);
 806         return;
 807     }
 808
 809     ds_put_char(s, ' ');
 810     switch (fm.command) {
 811     case OFPFC_ADD:
 812         ds_put_cstr(s, "ADD");
 813         break;
 814     case OFPFC_MODIFY:
 815         ds_put_cstr(s, "MOD");
 816         break;
 817     case OFPFC_MODIFY_STRICT:
 818         ds_put_cstr(s, "MOD_STRICT");
 819         break;
 820     case OFPFC_DELETE:
 821         ds_put_cstr(s, "DEL");
 822         break;
 823     case OFPFC_DELETE_STRICT:
 824         ds_put_cstr(s, "DEL_STRICT");
 825         break;
 826     default:
 827         ds_put_format(s, "cmd:%d", fm.command);
 828     }
 829
 830     ds_put_char(s, ' ');
 831     if (verbosity >= 3 && code == OFPUTIL_OFPT_FLOW_MOD) {
 832         const struct ofp_flow_mod *ofm = (const struct ofp_flow_mod *) oh;
 833
 834         ofp_print_match(s, &ofm->match, verbosity);
 835     } else if (verbosity >= 3 && code == OFPUTIL_NXT_FLOW_MOD) {
 836         const struct nx_flow_mod *nfm = (const struct nx_flow_mod *) oh;
 837         const void *nxm = nfm + 1;
 838         char *nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
 839         ds_put_cstr(s, nxm_s);
 840         free(nxm_s);
 841     } else {
 842         cls_rule_format(&fm.cr, s);
 843     }
 844
 845     if (ds_last(s) != ' ') {
 846         ds_put_char(s, ' ');
 847     }
 848     if (fm.cookie != htonll(0)) {
 849         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.cookie));
 850     }
 851     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
 852         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
 853     }
 854     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
 855         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
 856     }
 857     if (fm.cr.priority != OFP_DEFAULT_PRIORITY && verbosity >= 3) {
 858         ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
 859     }
 860     if (fm.buffer_id != UINT32_MAX) {
 861         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
 862     }
 863     if (fm.flags != 0) {
 864         ds_put_format(s, "flags:0x%"PRIx16" ", fm.flags);
 865     }
 866
 867     ofp_print_actions(s, (const struct ofp_action_header *) fm.actions,
 868                       fm.n_actions * sizeof *fm.actions);
 869 }
 870
 871 static void
 872 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
 873 {
 874     ds_put_format(string, "%u", sec);
 875     if (nsec > 0) {
 876         ds_put_format(string, ".%09u", nsec);
 877         while (string->string[string->length - 1] == '0') {
 878             string->length--;
 879         }
 880     }
 881     ds_put_char(string, 's');
 882 }
 883
 884 static void
 885 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
 886 {
 887     struct ofputil_flow_removed fr;
 888     int error;
 889
 890     error = ofputil_decode_flow_removed(&fr, oh, NXFF_OPENFLOW10);
 891     if (error) {
 892         ofp_print_error(string, error);
 893         return;
 894     }
 895
 896     cls_rule_format(&fr.rule, string);
 897
 898     ds_put_cstr(string, " reason=");
 899     switch (fr.reason) {
 900     case OFPRR_IDLE_TIMEOUT:
 901         ds_put_cstr(string, "idle");
 902         break;
 903     case OFPRR_HARD_TIMEOUT:
 904         ds_put_cstr(string, "hard");
 905         break;
 906     case OFPRR_DELETE:
 907         ds_put_cstr(string, "delete");
 908         break;
 909     default:
 910         ds_put_format(string, "**%"PRIu8"**", fr.reason);
 911         break;
 912     }
 913
 914     if (fr.cookie != htonll(0)) {
 915         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
 916     }
 917     ds_put_cstr(string, " duration");
 918     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
 919     ds_put_format(string, " idle%"PRIu16" pkts%"PRIu64" bytes%"PRIu64"\n",
 920          fr.idle_timeout, fr.packet_count, fr.byte_count);
 921 }
 922
 923 static void
 924 ofp_print_port_mod(struct ds *string, const struct ofp_port_mod *opm)
 925 {
 926     ds_put_format(string, "port: %d: addr:"ETH_ADDR_FMT", config: %#x, mask:%#x\n",
 927             ntohs(opm->port_no), ETH_ADDR_ARGS(opm->hw_addr),
 928             ntohl(opm->config), ntohl(opm->mask));
 929     ds_put_format(string, "     advertise: ");
 930     if (opm->advertise) {
 931         ofp_print_port_features(string, ntohl(opm->advertise));
 932     } else {
 933         ds_put_format(string, "UNCHANGED\n");
 934     }
 935 }
 936
 937 struct error_type {
 938     int type;
 939     int code;
 940     const char *name;
 941 };
 942
 943 static const struct error_type error_types[] = {
 944 #define ERROR_TYPE(TYPE) {TYPE, -1, #TYPE}
 945 #define ERROR_CODE(TYPE, CODE) {TYPE, CODE, #CODE}
 946     ERROR_TYPE(OFPET_HELLO_FAILED),
 947     ERROR_CODE(OFPET_HELLO_FAILED, OFPHFC_INCOMPATIBLE),
 948     ERROR_CODE(OFPET_HELLO_FAILED, OFPHFC_EPERM),
 949
 950     ERROR_TYPE(OFPET_BAD_REQUEST),
 951     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VERSION),
 952     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE),
 953     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT),
 954     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR),
 955     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE),
 956     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_EPERM),
 957     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN),
 958     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BUFFER_EMPTY),
 959     ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BUFFER_UNKNOWN),
 960     /* Nicira error extensions. */
 961     ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_INVALID),
 962     ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_TYPE),
 963     ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_VALUE),
 964     ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_MASK),
 965     ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_PREREQ),
 966     ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_DUP_TYPE),
 967
 968     ERROR_TYPE(OFPET_BAD_ACTION),
 969     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE),
 970     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_LEN),
 971     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR),
 972     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE),
 973     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT),
 974     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT),
 975     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_EPERM),
 976     ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_TOO_MANY),
 977
 978     ERROR_TYPE(OFPET_FLOW_MOD_FAILED),
 979     ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL),
 980     ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP),
 981     ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_EPERM),
 982     ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_EMERG_TIMEOUT),
 983     ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND),
 984     /* Nicira error extenstions. */
 985     ERROR_CODE(OFPET_FLOW_MOD_FAILED, NXFMFC_HARDWARE),
 986     ERROR_CODE(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID),
 987
 988     ERROR_TYPE(OFPET_PORT_MOD_FAILED),
 989     ERROR_CODE(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT),
 990     ERROR_CODE(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR)
 991 };
 992 #define N_ERROR_TYPES ARRAY_SIZE(error_types)
 993
 994 static const char *
 995 lookup_error_type(int type)
 996 {
 997     const struct error_type *t;
 998
 999     for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
1000         if (t->type == type && t->code == -1) {
1001             return t->name;
1002         }
1003     }
1004     return "?";
1005 }
1006
1007 static const char *
1008 lookup_error_code(int type, int code)
1009 {
1010     const struct error_type *t;
1011
1012     for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
1013         if (t->type == type && t->code == code) {
1014             return t->name;
1015         }
1016     }
1017     return "?";
1018 }
1019
1020 static void
1021 ofp_print_error(struct ds *string, int error)
1022 {
1023     int type = get_ofp_err_type(error);
1024     int code = get_ofp_err_code(error);
1025     if (string->length) {
1026         ds_put_char(string, ' ');
1027     }
1028     ds_put_format(string, " ***decode error type:%d(%s) code:%d(%s)***",
1029                   type, lookup_error_type(type),
1030                   code, lookup_error_code(type, code));
1031 }
1032
1033 static void
1034 ofp_print_nx_error_msg(struct ds *string, const struct ofp_error_msg *oem)
1035 {
1036     size_t len = ntohs(oem->header.length);
1037     const struct nx_vendor_error *nve = (struct nx_vendor_error *)oem->data;
1038     int vendor = ntohl(nve->vendor);
1039     int type = ntohs(nve->type);
1040     int code = ntohs(nve->code);
1041
1042     ds_put_format(string, " vendor:%x type:%d(%s) code:%d(%s) payload:\n",
1043                   vendor,
1044                   type, lookup_error_type(type),
1045                   code, lookup_error_code(type, code));
1046
1047     ds_put_hex_dump(string, nve + 1, len - sizeof *oem - sizeof *nve,
1048                     0, true);
1049 }
1050
1051 static void
1052 ofp_print_error_msg(struct ds *string, const struct ofp_error_msg *oem)
1053 {
1054     size_t len = ntohs(oem->header.length);
1055     int type = ntohs(oem->type);
1056     int code = ntohs(oem->code);
1057     char *s;
1058
1059
1060     if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
1061         if (len < sizeof *oem + sizeof(struct nx_vendor_error)) {
1062             ds_put_format(string,
1063                           "(***truncated extended error message is %zu bytes "
1064                           "when it should be at least %zu***)\n",
1065                           len, sizeof(struct nx_vendor_error));
1066             return;
1067         }
1068
1069         return ofp_print_nx_error_msg(string, oem);
1070     }
1071
1072     ds_put_format(string, " type:%d(%s) code:%d(%s) payload:\n",
1073                   type, lookup_error_type(type),
1074                   code, lookup_error_code(type, code));
1075
1076     switch (type) {
1077     case OFPET_HELLO_FAILED:
1078         ds_put_printable(string, (char *) oem->data, len - sizeof *oem);
1079         break;
1080
1081     case OFPET_BAD_REQUEST:
1082         s = ofp_to_string(oem->data, len - sizeof *oem, 1);
1083         ds_put_cstr(string, s);
1084         free(s);
1085         break;
1086
1087     default:
1088         ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
1089         break;
1090     }
1091 }
1092
1093 static void
1094 ofp_print_port_status(struct ds *string, const struct ofp_port_status *ops)
1095 {
1096     if (ops->reason == OFPPR_ADD) {
1097         ds_put_format(string, " ADD:");
1098     } else if (ops->reason == OFPPR_DELETE) {
1099         ds_put_format(string, " DEL:");
1100     } else if (ops->reason == OFPPR_MODIFY) {
1101         ds_put_format(string, " MOD:");
1102     }
1103
1104     ofp_print_phy_port(string, &ops->desc);
1105 }
1106
1107 static void
1108 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1109 {
1110     const struct ofp_desc_stats *ods = ofputil_stats_body(oh);
1111
1112     ds_put_format(string, "Manufacturer: %.*s\n",
1113             (int) sizeof ods->mfr_desc, ods->mfr_desc);
1114     ds_put_format(string, "Hardware: %.*s\n",
1115             (int) sizeof ods->hw_desc, ods->hw_desc);
1116     ds_put_format(string, "Software: %.*s\n",
1117             (int) sizeof ods->sw_desc, ods->sw_desc);
1118     ds_put_format(string, "Serial Num: %.*s\n",
1119             (int) sizeof ods->serial_num, ods->serial_num);
1120     ds_put_format(string, "DP Description: %.*s\n",
1121             (int) sizeof ods->dp_desc, ods->dp_desc);
1122 }
1123
1124 static void
1125 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1126 {
1127     struct flow_stats_request fsr;
1128     int error;
1129
1130     error = ofputil_decode_flow_stats_request(&fsr, oh, NXFF_OPENFLOW10);
1131     if (error) {
1132         ofp_print_error(string, error);
1133         return;
1134     }
1135
1136     if (fsr.table_id != 0xff) {
1137         ds_put_format(string, " table_id=%"PRIu8, fsr.table_id);
1138     }
1139
1140     if (fsr.out_port != OFPP_NONE) {
1141         ds_put_cstr(string, " out_port=");
1142         ofp_print_port_name(string, fsr.out_port);
1143     }
1144
1145     ds_put_char(string, ' ');
1146     cls_rule_format(&fsr.match, string);
1147 }
1148
1149 static void
1150 ofp_print_ofpst_flow_reply(struct ds *string, const struct ofp_header *oh,
1151                            int verbosity)
1152 {
1153     size_t len = ofputil_stats_body_len(oh);
1154     const char *body = ofputil_stats_body(oh);
1155     const char *pos = body;
1156     for (;;) {
1157         const struct ofp_flow_stats *fs;
1158         ptrdiff_t bytes_left = body + len - pos;
1159         size_t length;
1160
1161         ds_put_char(string, '\n');
1162
1163         if (bytes_left < sizeof *fs) {
1164             if (bytes_left != 0) {
1165                 ds_put_format(string, " ***%td leftover bytes at end***",
1166                               bytes_left);
1167             }
1168             break;
1169         }
1170
1171         fs = (const void *) pos;
1172         length = ntohs(fs->length);
1173         if (length < sizeof *fs) {
1174             ds_put_format(string, " ***length=%zu shorter than minimum %zu***",
1175                           length, sizeof *fs);
1176             break;
1177         } else if (length > bytes_left) {
1178             ds_put_format(string,
1179                           " ***length=%zu but only %td bytes left***",
1180                           length, bytes_left);
1181             break;
1182         } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
1183             ds_put_format(string,
1184                           " ***length=%zu has %zu bytes leftover in "
1185                           "final action***",
1186                           length,
1187                           (length - sizeof *fs) % sizeof fs->actions[0]);
1188             break;
1189         }
1190
1191         ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1192                       ntohll(fs->cookie));
1193         ofp_print_duration(string, ntohl(fs->duration_sec),
1194                            ntohl(fs->duration_nsec));
1195         ds_put_format(string, ", table_id=%"PRIu8", ", fs->table_id);
1196         ds_put_format(string, "priority=%"PRIu16", ", ntohs(fs->priority));
1197         ds_put_format(string, "n_packets=%"PRIu64", ",
1198                     ntohll(fs->packet_count));
1199         ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
1200         if (fs->idle_timeout != htons(OFP_FLOW_PERMANENT)) {
1201             ds_put_format(string, "idle_timeout=%"PRIu16",",
1202                           ntohs(fs->idle_timeout));
1203         }
1204         if (fs->hard_timeout != htons(OFP_FLOW_PERMANENT)) {
1205             ds_put_format(string, "hard_timeout=%"PRIu16",",
1206                           ntohs(fs->hard_timeout));
1207         }
1208         ofp_print_match(string, &fs->match, verbosity);
1209         ds_put_char(string, ' ');
1210         ofp_print_actions(string, fs->actions, length - sizeof *fs);
1211
1212         pos += length;
1213      }
1214 }
1215
1216 static void
1217 ofp_print_nxst_flow_reply(struct ds *string, const struct ofp_header *oh)
1218 {
1219     struct ofpbuf b;
1220
1221     ofpbuf_use_const(&b, ofputil_nxstats_body(oh),
1222                      ofputil_nxstats_body_len(oh));
1223     while (b.size > 0) {
1224         const struct nx_flow_stats *fs;
1225         union ofp_action *actions;
1226         struct cls_rule rule;
1227         size_t actions_len, n_actions;
1228         size_t length;
1229         int match_len;
1230         int error;
1231
1232         ds_put_char(string, '\n');
1233
1234         fs = ofpbuf_try_pull(&b, sizeof *fs);
1235         if (!fs) {
1236             ds_put_format(string, " ***%td leftover bytes at end***", b.size);
1237             break;
1238         }
1239
1240         length = ntohs(fs->length);
1241         if (length < sizeof *fs) {
1242             ds_put_format(string, " ***nx_flow_stats claims length %zu***",
1243                           length);
1244             break;
1245         }
1246
1247         match_len = ntohs(fs->match_len);
1248         if (match_len > length - sizeof *fs) {
1249             ds_put_format(string, " ***length=%zu match_len=%d***",
1250                           length, match_len);
1251             break;
1252         }
1253
1254         ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1255                       ntohll(fs->cookie));
1256         ofp_print_duration(string, ntohl(fs->duration_sec),
1257                            ntohl(fs->duration_nsec));
1258         ds_put_format(string, ", table_id=%"PRIu8", ", fs->table_id);
1259         ds_put_format(string, "priority=%"PRIu16", ", ntohs(fs->priority));
1260         ds_put_format(string, "n_packets=%"PRIu64", ",
1261                     ntohll(fs->packet_count));
1262         ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
1263         if (fs->idle_timeout != htons(OFP_FLOW_PERMANENT)) {
1264             ds_put_format(string, "idle_timeout=%"PRIu16",",
1265                           ntohs(fs->idle_timeout));
1266         }
1267         if (fs->hard_timeout != htons(OFP_FLOW_PERMANENT)) {
1268             ds_put_format(string, "hard_timeout=%"PRIu16",",
1269                           ntohs(fs->hard_timeout));
1270         }
1271
1272         error = nx_pull_match(&b, match_len, ntohs(fs->priority), &rule);
1273         if (error) {
1274             ofp_print_error(string, error);
1275             break;
1276         }
1277
1278         actions_len = length - sizeof *fs - ROUND_UP(match_len, 8);
1279         error = ofputil_pull_actions(&b, actions_len, &actions, &n_actions);
1280         if (error) {
1281             ofp_print_error(string, error);
1282             break;
1283         }
1284
1285         cls_rule_format(&rule, string);
1286         ds_put_char(string, ' ');
1287         ofp_print_actions(string, (const struct ofp_action_header *) actions,
1288                           n_actions * sizeof *actions);
1289      }
1290 }
1291
1292 static void
1293 ofp_print_ofp_aggregate_stats_reply (
1294     struct ds *string, const struct ofp_aggregate_stats_reply *asr)
1295 {
1296     ds_put_format(string, " packet_count=%"PRIu64, ntohll(asr->packet_count));
1297     ds_put_format(string, " byte_count=%"PRIu64, ntohll(asr->byte_count));
1298     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
1299 }
1300
1301 static void
1302 ofp_print_ofpst_aggregate_reply(struct ds *string, const struct ofp_header *oh)
1303 {
1304     ofp_print_ofp_aggregate_stats_reply(string, ofputil_stats_body(oh));
1305 }
1306
1307 static void
1308 ofp_print_nxst_aggregate_reply(struct ds *string,
1309                                const struct nx_aggregate_stats_reply *nasr)
1310 {
1311     ofp_print_ofp_aggregate_stats_reply(string, &nasr->asr);
1312 }
1313
1314 static void print_port_stat(struct ds *string, const char *leader,
1315                             uint64_t stat, int more)
1316 {
1317     ds_put_cstr(string, leader);
1318     if (stat != -1) {
1319         ds_put_format(string, "%"PRIu64, stat);
1320     } else {
1321         ds_put_char(string, '?');
1322     }
1323     if (more) {
1324         ds_put_cstr(string, ", ");
1325     } else {
1326         ds_put_cstr(string, "\n");
1327     }
1328 }
1329
1330 static void
1331 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1332 {
1333     const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
1334     ds_put_format(string, "port_no=%"PRIu16, ntohs(psr->port_no));
1335 }
1336
1337 static void
1338 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1339                            int verbosity)
1340 {
1341     const struct ofp_port_stats *ps = ofputil_stats_body(oh);
1342     size_t n = ofputil_stats_body_len(oh) / sizeof *ps;
1343     ds_put_format(string, " %zu ports\n", n);
1344     if (verbosity < 1) {
1345         return;
1346     }
1347
1348     for (; n--; ps++) {
1349         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
1350
1351         ds_put_cstr(string, "rx ");
1352         print_port_stat(string, "pkts=", ntohll(ps->rx_packets), 1);
1353         print_port_stat(string, "bytes=", ntohll(ps->rx_bytes), 1);
1354         print_port_stat(string, "drop=", ntohll(ps->rx_dropped), 1);
1355         print_port_stat(string, "errs=", ntohll(ps->rx_errors), 1);
1356         print_port_stat(string, "frame=", ntohll(ps->rx_frame_err), 1);
1357         print_port_stat(string, "over=", ntohll(ps->rx_over_err), 1);
1358         print_port_stat(string, "crc=", ntohll(ps->rx_crc_err), 0);
1359
1360         ds_put_cstr(string, "           tx ");
1361         print_port_stat(string, "pkts=", ntohll(ps->tx_packets), 1);
1362         print_port_stat(string, "bytes=", ntohll(ps->tx_bytes), 1);
1363         print_port_stat(string, "drop=", ntohll(ps->tx_dropped), 1);
1364         print_port_stat(string, "errs=", ntohll(ps->tx_errors), 1);
1365         print_port_stat(string, "coll=", ntohll(ps->collisions), 0);
1366     }
1367 }
1368
1369 static void
1370 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1371                             int verbosity)
1372 {
1373     const struct ofp_table_stats *ts = ofputil_stats_body(oh);
1374     size_t n = ofputil_stats_body_len(oh) / sizeof *ts;
1375     ds_put_format(string, " %zu tables\n", n);
1376     if (verbosity < 1) {
1377         return;
1378     }
1379
1380     for (; n--; ts++) {
1381         char name[OFP_MAX_TABLE_NAME_LEN + 1];
1382         strncpy(name, ts->name, sizeof name);
1383         name[OFP_MAX_TABLE_NAME_LEN] = '\0';
1384
1385         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
1386         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1387         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1388         ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1389         ds_put_cstr(string, "               ");
1390         ds_put_format(string, "lookup=%"PRIu64", ",
1391                     ntohll(ts->lookup_count));
1392         ds_put_format(string, "matched=%"PRIu64"\n",
1393                     ntohll(ts->matched_count));
1394      }
1395 }
1396
1397 static void
1398 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1399 {
1400     if (queue_id == OFPQ_ALL) {
1401         ds_put_cstr(string, "ALL");
1402     } else {
1403         ds_put_format(string, "%"PRIu32, queue_id);
1404     }
1405 }
1406
1407 static void
1408 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1409 {
1410     const struct ofp_queue_stats_request *qsr = ofputil_stats_body(oh);
1411
1412     ds_put_cstr(string, "port=");
1413     ofp_print_port_name(string, ntohs(qsr->port_no));
1414
1415     ds_put_cstr(string, " queue=");
1416     ofp_print_queue_name(string, ntohl(qsr->queue_id));
1417 }
1418
1419 static void
1420 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1421                             int verbosity)
1422 {
1423     const struct ofp_queue_stats *qs = ofputil_stats_body(oh);
1424     size_t n = ofputil_stats_body_len(oh) / sizeof *qs;
1425     ds_put_format(string, " %zu queues\n", n);
1426     if (verbosity < 1) {
1427         return;
1428     }
1429
1430     for (; n--; qs++) {
1431         ds_put_cstr(string, "  port ");
1432         ofp_print_port_name(string, ntohs(qs->port_no));
1433         ds_put_cstr(string, " queue ");
1434         ofp_print_queue_name(string, ntohl(qs->queue_id));
1435         ds_put_cstr(string, ": ");
1436
1437         print_port_stat(string, "bytes=", ntohll(qs->tx_bytes), 1);
1438         print_port_stat(string, "pkts=", ntohll(qs->tx_packets), 1);
1439         print_port_stat(string, "errors=", ntohll(qs->tx_errors), 0);
1440     }
1441 }
1442
1443 static void
1444 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1445 {
1446     const struct ofp_stats_request *srq
1447         = (const struct ofp_stats_request *) oh;
1448
1449     if (srq->flags) {
1450         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
1451                       ntohs(srq->flags));
1452     }
1453 }
1454
1455 static void
1456 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1457 {
1458     const struct ofp_stats_reply *srp = (const struct ofp_stats_reply *) oh;
1459
1460     if (srp->flags) {
1461         uint16_t flags = ntohs(srp->flags);
1462
1463         ds_put_cstr(string, " flags=");
1464         if (flags & OFPSF_REPLY_MORE) {
1465             ds_put_cstr(string, "[more]");
1466             flags &= ~OFPSF_REPLY_MORE;
1467         }
1468         if (flags) {
1469             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1470                           flags);
1471         }
1472     }
1473 }
1474
1475 static void
1476 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1477 {
1478     size_t len = ntohs(oh->length);
1479
1480     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1481     if (verbosity > 1) {
1482         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1483     }
1484 }
1485
1486 static void
1487 ofp_print_nxt_status_message(struct ds *string, const struct ofp_header *oh)
1488 {
1489     struct ofpbuf b;
1490
1491     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1492     ofpbuf_pull(&b, sizeof *oh);
1493     ds_put_char(string, '"');
1494     ds_put_printable(string, b.data, b.size);
1495     ds_put_char(string, '"');
1496 }
1497
1498 static void
1499 ofp_print_nxt_tun_id_from_cookie(struct ds *string,
1500                                  const struct nxt_tun_id_cookie *ntic)
1501 {
1502     ds_put_format(string, " set=%"PRIu8, ntic->set);
1503 }
1504
1505 static void
1506 ofp_print_nxt_role_message(struct ds *string,
1507                            const struct nx_role_request *nrr)
1508 {
1509     unsigned int role = ntohl(nrr->role);
1510
1511     ds_put_cstr(string, " role=");
1512     if (role == NX_ROLE_OTHER) {
1513         ds_put_cstr(string, "other");
1514     } else if (role == NX_ROLE_MASTER) {
1515         ds_put_cstr(string, "master");
1516     } else if (role == NX_ROLE_SLAVE) {
1517         ds_put_cstr(string, "slave");
1518     } else {
1519         ds_put_format(string, "%u", role);
1520     }
1521 }
1522
1523 static void
1524 ofp_print_nxt_set_flow_format(struct ds *string,
1525                               const struct nxt_set_flow_format *nsff)
1526 {
1527     uint32_t format = ntohl(nsff->format);
1528
1529     ds_put_cstr(string, " format=");
1530     if (ofputil_flow_format_is_valid(format)) {
1531         ds_put_cstr(string, ofputil_flow_format_to_string(format));
1532     } else {
1533         ds_put_format(string, "%"PRIu32, format);
1534     }
1535 }
1536
1537 static void
1538 ofp_to_string__(const struct ofp_header *oh,
1539                 const struct ofputil_msg_type *type, struct ds *string,
1540                 int verbosity)
1541 {
1542     enum ofputil_msg_code code;
1543     const void *msg = oh;
1544
1545     ds_put_format(string, "%s (xid=0x%"PRIx32"):",
1546                   ofputil_msg_type_name(type), ntohl(oh->xid));
1547
1548     code = ofputil_msg_type_code(type);
1549     switch (code) {
1550     case OFPUTIL_INVALID:
1551         break;
1552
1553     case OFPUTIL_OFPT_HELLO:
1554         break;
1555
1556     case OFPUTIL_OFPT_ERROR:
1557         ofp_print_error_msg(string, msg);
1558         break;
1559
1560     case OFPUTIL_OFPT_ECHO_REQUEST:
1561     case OFPUTIL_OFPT_ECHO_REPLY:
1562         ofp_print_echo(string, oh, verbosity);
1563         break;
1564
1565     case OFPUTIL_OFPT_FEATURES_REQUEST:
1566         break;
1567
1568     case OFPUTIL_OFPT_FEATURES_REPLY:
1569         ofp_print_switch_features(string, msg);
1570         break;
1571
1572     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
1573         break;
1574
1575     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
1576     case OFPUTIL_OFPT_SET_CONFIG:
1577         ofp_print_switch_config(string, msg);
1578         break;
1579
1580     case OFPUTIL_OFPT_PACKET_IN:
1581         ofp_print_packet_in(string, msg, verbosity);
1582         break;
1583
1584     case OFPUTIL_OFPT_FLOW_REMOVED:
1585     case OFPUTIL_NXT_FLOW_REMOVED:
1586         ofp_print_flow_removed(string, msg);
1587         break;
1588
1589     case OFPUTIL_OFPT_PORT_STATUS:
1590         ofp_print_port_status(string, msg);
1591         break;
1592
1593     case OFPUTIL_OFPT_PACKET_OUT:
1594         ofp_print_packet_out(string, msg, verbosity);
1595         break;
1596
1597     case OFPUTIL_OFPT_FLOW_MOD:
1598         ofp_print_flow_mod(string, msg, code, verbosity);
1599         break;
1600
1601     case OFPUTIL_OFPT_PORT_MOD:
1602         ofp_print_port_mod(string, msg);
1603         break;
1604
1605     case OFPUTIL_OFPT_BARRIER_REQUEST:
1606     case OFPUTIL_OFPT_BARRIER_REPLY:
1607         break;
1608
1609     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
1610     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
1611         /* XXX */
1612         break;
1613
1614     case OFPUTIL_OFPST_DESC_REQUEST:
1615         ofp_print_stats_request(string, oh);
1616         break;
1617
1618     case OFPUTIL_OFPST_FLOW_REQUEST:
1619     case OFPUTIL_NXST_FLOW_REQUEST:
1620     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1621     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1622         ofp_print_stats_request(string, oh);
1623         ofp_print_flow_stats_request(string, oh);
1624         break;
1625
1626     case OFPUTIL_OFPST_TABLE_REQUEST:
1627         ofp_print_stats_request(string, oh);
1628         break;
1629
1630     case OFPUTIL_OFPST_PORT_REQUEST:
1631         ofp_print_stats_request(string, oh);
1632         ofp_print_ofpst_port_request(string, oh);
1633         break;
1634
1635     case OFPUTIL_OFPST_QUEUE_REQUEST:
1636         ofp_print_stats_request(string, oh);
1637         ofp_print_ofpst_queue_request(string, oh);
1638         break;
1639
1640     case OFPUTIL_OFPST_DESC_REPLY:
1641         ofp_print_stats_reply(string, oh);
1642         ofp_print_ofpst_desc_reply(string, oh);
1643         break;
1644
1645     case OFPUTIL_OFPST_FLOW_REPLY:
1646         ofp_print_stats_reply(string, oh);
1647         ofp_print_ofpst_flow_reply(string, oh, verbosity);
1648         break;
1649
1650     case OFPUTIL_OFPST_QUEUE_REPLY:
1651         ofp_print_stats_reply(string, oh);
1652         ofp_print_ofpst_queue_reply(string, oh, verbosity);
1653         break;
1654
1655     case OFPUTIL_OFPST_PORT_REPLY:
1656         ofp_print_stats_reply(string, oh);
1657         ofp_print_ofpst_port_reply(string, oh, verbosity);
1658         break;
1659
1660     case OFPUTIL_OFPST_TABLE_REPLY:
1661         ofp_print_stats_reply(string, oh);
1662         ofp_print_ofpst_table_reply(string, oh, verbosity);
1663         break;
1664
1665     case OFPUTIL_OFPST_AGGREGATE_REPLY:
1666         ofp_print_stats_reply(string, oh);
1667         ofp_print_ofpst_aggregate_reply(string, oh);
1668         break;
1669
1670     case OFPUTIL_NXT_STATUS_REQUEST:
1671     case OFPUTIL_NXT_STATUS_REPLY:
1672         ofp_print_nxt_status_message(string, oh);
1673         break;
1674
1675     case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
1676         ofp_print_nxt_tun_id_from_cookie(string, msg);
1677         break;
1678
1679     case OFPUTIL_NXT_ROLE_REQUEST:
1680     case OFPUTIL_NXT_ROLE_REPLY:
1681         ofp_print_nxt_role_message(string, msg);
1682         break;
1683
1684     case OFPUTIL_NXT_SET_FLOW_FORMAT:
1685         ofp_print_nxt_set_flow_format(string, msg);
1686         break;
1687
1688     case OFPUTIL_NXT_FLOW_MOD:
1689         ofp_print_flow_mod(string, msg, code, verbosity);
1690         break;
1691
1692     case OFPUTIL_NXST_FLOW_REPLY:
1693         ofp_print_nxst_flow_reply(string, oh);
1694         break;
1695
1696     case OFPUTIL_NXST_AGGREGATE_REPLY:
1697         ofp_print_stats_reply(string, oh);
1698         ofp_print_nxst_aggregate_reply(string, msg);
1699         break;
1700     }
1701 }
1702
1703 /* Composes and returns a string representing the OpenFlow packet of 'len'
1704  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1705  * verbosity and higher numbers increase verbosity.  The caller is responsible
1706  * for freeing the string. */
1707 char *
1708 ofp_to_string(const void *oh_, size_t len, int verbosity)
1709 {
1710     struct ds string = DS_EMPTY_INITIALIZER;
1711     const struct ofp_header *oh = oh_;
1712
1713     if (len < sizeof(struct ofp_header)) {
1714         ds_put_cstr(&string, "OpenFlow packet too short:\n");
1715     } else if (oh->version != OFP_VERSION) {
1716         ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n",
1717                       oh->version);
1718     } else if (ntohs(oh->length) > len) {
1719         ds_put_format(&string,
1720                       "(***truncated to %zu bytes from %"PRIu16"***)",
1721                       len, ntohs(oh->length));
1722     } else if (ntohs(oh->length) < len) {
1723         ds_put_format(&string,
1724                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
1725                       ntohs(oh->length), len);
1726     } else {
1727         const struct ofputil_msg_type *type;
1728         int error;
1729
1730         error = ofputil_decode_msg_type(oh, &type);
1731         if (!error) {
1732             ofp_to_string__(oh, type, &string, verbosity);
1733             if (verbosity >= 5) {
1734                 if (ds_last(&string) != '\n') {
1735                     ds_put_char(&string, '\n');
1736                 }
1737                 ds_put_hex_dump(&string, oh, len, 0, true);
1738             }
1739             if (ds_last(&string) != '\n') {
1740                 ds_put_char(&string, '\n');
1741             }
1742             return ds_steal_cstr(&string);
1743         }
1744
1745         ofp_print_error(&string, error);
1746     }
1747     ds_put_hex_dump(&string, oh, len, 0, true);
1748     return ds_steal_cstr(&string);
1749 }
1750
1751 /* Returns the name for the specified OpenFlow message type as a string,
1752  * e.g. "OFPT_FEATURES_REPLY".  If no name is known, the string returned is a
1753  * hex number, e.g. "0x55".
1754  *
1755  * The caller must free the returned string when it is no longer needed. */
1756 char *
1757 ofp_message_type_to_string(uint8_t type)
1758 {
1759     const char *name;
1760
1761     switch (type) {
1762     case OFPT_HELLO:
1763         name = "HELLO";
1764         break;
1765     case OFPT_ERROR:
1766         name = "ERROR";
1767         break;
1768     case OFPT_ECHO_REQUEST:
1769         name = "ECHO_REQUEST";
1770         break;
1771     case OFPT_ECHO_REPLY:
1772         name = "ECHO_REPLY";
1773         break;
1774     case OFPT_VENDOR:
1775         name = "VENDOR";
1776         break;
1777     case OFPT_FEATURES_REQUEST:
1778         name = "FEATURES_REQUEST";
1779         break;
1780     case OFPT_FEATURES_REPLY:
1781         name = "FEATURES_REPLY";
1782         break;
1783     case OFPT_GET_CONFIG_REQUEST:
1784         name = "GET_CONFIG_REQUEST";
1785         break;
1786     case OFPT_GET_CONFIG_REPLY:
1787         name = "GET_CONFIG_REPLY";
1788         break;
1789     case OFPT_SET_CONFIG:
1790         name = "SET_CONFIG";
1791         break;
1792     case OFPT_PACKET_IN:
1793         name = "PACKET_IN";
1794         break;
1795     case OFPT_FLOW_REMOVED:
1796         name = "FLOW_REMOVED";
1797         break;
1798     case OFPT_PORT_STATUS:
1799         name = "PORT_STATUS";
1800         break;
1801     case OFPT_PACKET_OUT:
1802         name = "PACKET_OUT";
1803         break;
1804     case OFPT_FLOW_MOD:
1805         name = "FLOW_MOD";
1806         break;
1807     case OFPT_PORT_MOD:
1808         name = "PORT_MOD";
1809         break;
1810     case OFPT_STATS_REQUEST:
1811         name = "STATS_REQUEST";
1812         break;
1813     case OFPT_STATS_REPLY:
1814         name = "STATS_REPLY";
1815         break;
1816     case OFPT_BARRIER_REQUEST:
1817         name = "BARRIER_REQUEST";
1818         break;
1819     case OFPT_BARRIER_REPLY:
1820         name = "BARRIER_REPLY";
1821         break;
1822     case OFPT_QUEUE_GET_CONFIG_REQUEST:
1823         name = "QUEUE_GET_CONFIG_REQUEST";
1824         break;
1825     case OFPT_QUEUE_GET_CONFIG_REPLY:
1826         name = "QUEUE_GET_CONFIG_REPLY";
1827         break;
1828     default:
1829         name = NULL;
1830         break;
1831     }
1832
1833     return name ? xasprintf("OFPT_%s", name) : xasprintf("0x%02"PRIx8, type);
1834 }
1835 \f
1836 static void
1837 print_and_free(FILE *stream, char *string)
1838 {
1839     fputs(string, stream);
1840     free(string);
1841 }
1842
1843 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1844  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1845  * numbers increase verbosity. */
1846 void
1847 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1848 {
1849     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1850 }
1851
1852 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1853  * 'data' to 'stream' using tcpdump.  'total_len' specifies the full length of
1854  * the Ethernet frame (of which 'len' bytes were captured).
1855  *
1856  * This starts and kills a tcpdump subprocess so it's quite expensive. */
1857 void
1858 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1859 {
1860     print_and_free(stream, ofp_packet_to_string(data, len, total_len));
1861 }