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