lib/ofp-print.c

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