c8d8ad3198665e583384f405dd72b453f9524857
[sliver-openvswitch.git] / lib / ofp-print.c
1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
2  * Junior University
3  * 
4  * We are making the OpenFlow specification and associated documentation
5  * (Software) available for public use and benefit with the expectation
6  * that others will use, modify and enhance the Software and contribute
7  * those enhancements back to the community. However, since we would
8  * like to make the Software available for broadest use, with as few
9  * restrictions as possible permission is hereby granted, free of
10  * charge, to any person obtaining a copy of this Software to deal in
11  * the Software under the copyrights without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE.
28  * 
29  * The name and trademarks of copyright holder(s) may NOT be used in
30  * advertising or publicity pertaining to the Software or any
31  * derivatives without specific, written prior permission.
32  */
33
34 #include <config.h>
35 #include "ofp-print.h"
36 #include "xtoxll.h"
37
38 #include <errno.h>
39 #include <inttypes.h>
40 #include <netinet/in.h>
41 #include <sys/wait.h>
42 #include <stdarg.h>
43 #include <stdlib.h>
44 #include <ctype.h>
45
46 #include "buffer.h"
47 #include "compiler.h"
48 #include "dynamic-string.h"
49 #include "flow.h"
50 #include "util.h"
51 #include "openflow.h"
52 #include "packets.h"
53
54 static void ofp_print_port_name(struct ds *string, uint16_t port);
55 static void ofp_print_match(struct ds *, const struct ofp_match *,
56                             int verbosity);
57
58 /* Returns a string that represents the contents of the Ethernet frame in the
59  * 'len' bytes starting at 'data' to 'stream' as output by tcpdump.
60  * 'total_len' specifies the full length of the Ethernet frame (of which 'len'
61  * bytes were captured).
62  *
63  * The caller must free the returned string.
64  *
65  * This starts and kills a tcpdump subprocess so it's quite expensive. */
66 char *
67 ofp_packet_to_string(const void *data, size_t len, size_t total_len)
68 {
69     struct pcap_hdr {
70         uint32_t magic_number;   /* magic number */
71         uint16_t version_major;  /* major version number */
72         uint16_t version_minor;  /* minor version number */
73         int32_t thiszone;        /* GMT to local correction */
74         uint32_t sigfigs;        /* accuracy of timestamps */
75         uint32_t snaplen;        /* max length of captured packets */
76         uint32_t network;        /* data link type */
77     } PACKED;
78
79     struct pcaprec_hdr {
80         uint32_t ts_sec;         /* timestamp seconds */
81         uint32_t ts_usec;        /* timestamp microseconds */
82         uint32_t incl_len;       /* number of octets of packet saved in file */
83         uint32_t orig_len;       /* actual length of packet */
84     } PACKED;
85
86     struct pcap_hdr ph;
87     struct pcaprec_hdr prh;
88
89     struct ds ds = DS_EMPTY_INITIALIZER;
90
91     char command[128];
92     FILE *pcap;
93     FILE *tcpdump;
94     int status;
95     int c;
96
97     pcap = tmpfile();
98     if (!pcap) {
99         error(errno, "tmpfile");
100         return xstrdup("<error>");
101     }
102
103     /* The pcap reader is responsible for figuring out endianness based on the
104      * magic number, so the lack of htonX calls here is intentional. */
105     ph.magic_number = 0xa1b2c3d4;
106     ph.version_major = 2;
107     ph.version_minor = 4;
108     ph.thiszone = 0;
109     ph.sigfigs = 0;
110     ph.snaplen = 1518;
111     ph.network = 1;             /* Ethernet */
112
113     prh.ts_sec = 0;
114     prh.ts_usec = 0;
115     prh.incl_len = len;
116     prh.orig_len = total_len;
117
118     fwrite(&ph, 1, sizeof ph, pcap);
119     fwrite(&prh, 1, sizeof prh, pcap);
120     fwrite(data, 1, len, pcap);
121
122     fflush(pcap);
123     if (ferror(pcap)) {
124         error(errno, "error writing temporary file");
125     }
126     rewind(pcap);
127
128     snprintf(command, sizeof command, "tcpdump -n -r /dev/fd/%d 2>/dev/null",
129              fileno(pcap));
130     tcpdump = popen(command, "r");
131     fclose(pcap);
132     if (!tcpdump) {
133         error(errno, "exec(\"%s\")", command);
134         return xstrdup("<error>");
135     }
136
137     while ((c = getc(tcpdump)) != EOF) {
138         ds_put_char(&ds, c);
139     }
140
141     status = pclose(tcpdump);
142     if (WIFEXITED(status)) {
143         if (WEXITSTATUS(status))
144             error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
145     } else if (WIFSIGNALED(status)) {
146         error(0, "tcpdump exited with signal %d", WTERMSIG(status)); 
147     }
148     return ds_cstr(&ds);
149 }
150
151 /* Pretty-print the OFPT_PACKET_IN packet of 'len' bytes at 'oh' to 'stream'
152  * at the given 'verbosity' level. */
153 static void
154 ofp_packet_in(struct ds *string, const void *oh, size_t len, int verbosity)
155 {
156     const struct ofp_packet_in *op = oh;
157     size_t data_len;
158
159     ds_put_format(string, " total_len=%"PRIu16" in_port=",
160                   ntohs(op->total_len));
161     ofp_print_port_name(string, ntohs(op->in_port));
162
163     if (op->reason == OFPR_ACTION)
164         ds_put_cstr(string, " (via action)");
165     else if (op->reason != OFPR_NO_MATCH)
166         ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
167
168     data_len = len - offsetof(struct ofp_packet_in, data);
169     ds_put_format(string, " data_len=%zu", data_len);
170     if (htonl(op->buffer_id) == UINT32_MAX) {
171         ds_put_format(string, " (unbuffered)");
172         if (ntohs(op->total_len) != data_len)
173             ds_put_format(string, " (***total_len != data_len***)");
174     } else {
175         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(op->buffer_id));
176         if (ntohs(op->total_len) < data_len)
177             ds_put_format(string, " (***total_len < data_len***)");
178     }
179     ds_put_char(string, '\n');
180
181     if (verbosity > 0) {
182         struct flow flow;
183         struct buffer packet;
184         struct ofp_match match;
185         packet.data = (void *) op->data;
186         packet.size = data_len;
187         flow_extract(&packet, ntohs(op->in_port), &flow);
188         match.wildcards = 0;
189         match.in_port = flow.in_port;
190         memcpy(match.dl_src, flow.dl_src, ETH_ADDR_LEN);
191         memcpy(match.dl_dst, flow.dl_dst, ETH_ADDR_LEN);
192         match.dl_vlan = flow.dl_vlan;
193         match.dl_type = flow.dl_type;
194         match.nw_proto = flow.nw_proto;
195         match.pad = 0;
196         match.nw_src = flow.nw_src;
197         match.nw_dst = flow.nw_dst;
198         match.tp_src = flow.tp_src;
199         match.tp_dst = flow.tp_dst;
200         ofp_print_match(string, &match, verbosity);
201         ds_put_char(string, '\n');
202     }
203     if (verbosity > 1) {
204         char *packet = ofp_packet_to_string(op->data, data_len,
205                                             ntohs(op->total_len)); 
206         ds_put_cstr(string, packet);
207         free(packet);
208     }
209 }
210
211 static void ofp_print_port_name(struct ds *string, uint16_t port) 
212 {
213     const char *name;
214     switch (port) {
215     case OFPP_IN_PORT:
216         name = "IN_PORT";
217         break;
218     case OFPP_TABLE:
219         name = "TABLE";
220         break;
221     case OFPP_NORMAL:
222         name = "NORMAL";
223         break;
224     case OFPP_FLOOD:
225         name = "FLOOD";
226         break;
227     case OFPP_ALL:
228         name = "ALL";
229         break;
230     case OFPP_CONTROLLER:
231         name = "CONTROLLER";
232         break;
233     case OFPP_LOCAL:
234         name = "LOCAL";
235         break;
236     case OFPP_NONE:
237         name = "NONE";
238         break;
239     default:
240         ds_put_format(string, "%"PRIu16, port);
241         return;
242     }
243     ds_put_cstr(string, name);
244 }
245
246 static void
247 ofp_print_action(struct ds *string, const struct ofp_action *a) 
248 {
249     switch (ntohs(a->type)) {
250     case OFPAT_OUTPUT:
251         {
252             uint16_t port = ntohs(a->arg.output.port); 
253             if (port < OFPP_MAX) {
254                 ds_put_format(string, "output:%"PRIu16, port);
255             } else {
256                 ofp_print_port_name(string, port);
257                 if (port == OFPP_CONTROLLER) {
258                     if (a->arg.output.max_len) {
259                         ds_put_format(string, ":%"PRIu16, 
260                                 ntohs(a->arg.output.max_len));
261                     } else {
262                         ds_put_cstr(string, ":all");
263                     }
264                 }
265             }
266         }
267         break;
268
269     case OFPAT_SET_DL_VLAN:
270         ds_put_cstr(string, "mod_vlan:");
271         if (ntohs(a->arg.vlan_id) == OFP_VLAN_NONE) {
272             ds_put_cstr(string, "strip");
273         } else {
274             ds_put_format(string, "%"PRIu16, ntohs(a->arg.vlan_id));
275         }
276         break;
277
278     case OFPAT_SET_DL_SRC:
279         ds_put_format(string, "mod_dl_src:"ETH_ADDR_FMT, 
280                 ETH_ADDR_ARGS(a->arg.dl_addr));
281         break;
282
283     case OFPAT_SET_DL_DST:
284         ds_put_format(string, "mod_dl_dst:"ETH_ADDR_FMT, 
285                 ETH_ADDR_ARGS(a->arg.dl_addr));
286         break;
287
288     case OFPAT_SET_NW_SRC:
289         ds_put_format(string, "mod_nw_src:"IP_FMT, IP_ARGS(&a->arg.nw_addr));
290         break;
291
292     case OFPAT_SET_NW_DST:
293         ds_put_format(string, "mod_nw_dst:"IP_FMT, IP_ARGS(&a->arg.nw_addr));
294         break;
295
296     case OFPAT_SET_TP_SRC:
297         ds_put_format(string, "mod_tp_src:%d", ntohs(a->arg.tp));
298         break;
299
300     case OFPAT_SET_TP_DST:
301         ds_put_format(string, "mod_tp_dst:%d", ntohs(a->arg.tp));
302         break;
303
304     default:
305         ds_put_format(string, "(decoder %"PRIu16" not implemented)", 
306                 ntohs(a->type));
307         break;
308     }
309 }
310
311 static void ofp_print_actions(struct ds *string,
312                               const struct ofp_action actions[],
313                               size_t n_bytes) 
314 {
315     size_t i;
316     int n_actions = n_bytes / sizeof *actions;
317
318     ds_put_format(string, "action%s=", n_actions == 1 ? "" : "s");
319     for (i = 0; i < n_actions; i++) {
320         if (i) {
321             ds_put_cstr(string, ",");
322         }
323         ofp_print_action(string, &actions[i]);
324     }
325     if (n_bytes % sizeof *actions) {
326         if (i) {
327             ds_put_cstr(string, ",");
328         }
329         ds_put_cstr(string, ", ***trailing garbage***");
330     }
331 }
332
333 /* Pretty-print the OFPT_PACKET_OUT packet of 'len' bytes at 'oh' to 'string'
334  * at the given 'verbosity' level. */
335 static void ofp_packet_out(struct ds *string, const void *oh, size_t len,
336                            int verbosity) 
337 {
338     const struct ofp_packet_out *opo = oh;
339     int n_actions = ntohs(opo->n_actions);
340     int act_len = n_actions * sizeof opo->actions[0];
341
342     ds_put_cstr(string, " in_port=");
343     ofp_print_port_name(string, ntohs(opo->in_port));
344
345     ds_put_format(string, " n_actions=%d ", n_actions);
346     if (act_len > (ntohs(opo->header.length) - sizeof *opo)) {
347         ds_put_format(string, "***packet too short for number of actions***\n");
348         return;
349     }
350     ofp_print_actions(string, opo->actions, act_len);
351
352     if (ntohl(opo->buffer_id) == UINT32_MAX) {
353         int data_len = len - sizeof *opo - act_len;
354         ds_put_format(string, " data_len=%d", data_len);
355         if (verbosity > 0 && len > sizeof *opo) {
356             char *packet = ofp_packet_to_string(&opo->actions[n_actions], 
357                                                 data_len, data_len);
358             ds_put_char(string, '\n');
359             ds_put_cstr(string, packet);
360             free(packet);
361         }
362     } else {
363         ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(opo->buffer_id));
364     }
365     ds_put_char(string, '\n');
366 }
367
368 /* qsort comparison function. */
369 static int
370 compare_ports(const void *a_, const void *b_)
371 {
372     const struct ofp_phy_port *a = a_;
373     const struct ofp_phy_port *b = b_;
374     uint16_t ap = ntohs(a->port_no);
375     uint16_t bp = ntohs(b->port_no);
376
377     return ap < bp ? -1 : ap > bp;
378 }
379
380 static void
381 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
382 {
383     uint8_t name[OFP_MAX_PORT_NAME_LEN];
384     int j;
385
386     memcpy(name, port->name, sizeof name);
387     for (j = 0; j < sizeof name - 1; j++) {
388         if (!isprint(name[j])) {
389             break;
390         }
391     }
392     name[j] = '\0';
393
394     ds_put_char(string, ' ');
395     ofp_print_port_name(string, ntohs(port->port_no));
396     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT", speed:%d, flags:%#x, "
397             "feat:%#x\n", name, 
398             ETH_ADDR_ARGS(port->hw_addr), ntohl(port->speed),
399             ntohl(port->flags), ntohl(port->features));
400 }
401
402 /* Pretty-print the struct ofp_switch_features of 'len' bytes at 'oh' to
403  * 'string' at the given 'verbosity' level. */
404 static void
405 ofp_print_switch_features(struct ds *string, const void *oh, size_t len,
406                           int verbosity)
407 {
408     const struct ofp_switch_features *osf = oh;
409     struct ofp_phy_port port_list[OFPP_MAX];
410     int n_ports;
411     int i;
412
413     ds_put_format(string, "dp id:%"PRIx64"\n", ntohll(osf->datapath_id));
414     ds_put_format(string, "tables: exact:%d, compressed:%d, general:%d\n",
415            ntohl(osf->n_exact), 
416            ntohl(osf->n_compression), ntohl(osf->n_general));
417     ds_put_format(string, "buffers: size:%d, number:%d\n",
418            ntohl(osf->buffer_mb), ntohl(osf->n_buffers));
419     ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
420            ntohl(osf->capabilities), ntohl(osf->actions));
421
422     if (ntohs(osf->header.length) >= sizeof *osf) {
423         len = MIN(len, ntohs(osf->header.length));
424     }
425     n_ports = (len - sizeof *osf) / sizeof *osf->ports;
426
427     memcpy(port_list, osf->ports, (len - sizeof *osf));
428     qsort(port_list, n_ports, sizeof port_list[0], compare_ports);
429     for (i = 0; i < n_ports; i++) {
430         ofp_print_phy_port(string, &port_list[i]);
431     }
432 }
433
434 /* Pretty-print the struct ofp_switch_config of 'len' bytes at 'oh' to 'string'
435  * at the given 'verbosity' level. */
436 static void
437 ofp_print_switch_config(struct ds *string, const void *oh, size_t len,
438                         int verbosity)
439 {
440     const struct ofp_switch_config *osc = oh;
441     uint16_t flags;
442
443     flags = ntohs(osc->flags);
444     if (flags & OFPC_SEND_FLOW_EXP) {
445         flags &= ~OFPC_SEND_FLOW_EXP;
446         ds_put_format(string, " (sending flow expirations)");
447     }
448     if (flags) {
449         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
450     }
451
452     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
453 }
454
455 static void print_wild(struct ds *string, const char *leader, int is_wild,
456             int verbosity, const char *format, ...) 
457             __attribute__((format(printf, 5, 6)));
458
459 static void print_wild(struct ds *string, const char *leader, int is_wild,
460                        int verbosity, const char *format, ...) 
461 {
462     if (is_wild && verbosity < 2) {
463         return;
464     }
465     ds_put_cstr(string, leader);
466     if (!is_wild) {
467         va_list args;
468
469         va_start(args, format);
470         ds_put_format_valist(string, format, args);
471         va_end(args);
472     } else {
473         ds_put_char(string, '*');
474     }
475     ds_put_char(string, ',');
476 }
477
478 static void
479 print_ip_netmask(struct ds *string, const char *leader, uint32_t ip,
480                  uint32_t wild_bits, int verbosity)
481 {
482     if (wild_bits >= 32 && verbosity < 2) {
483         return;
484     }
485     ds_put_cstr(string, leader);
486     if (wild_bits < 32) {
487         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
488         if (wild_bits) {
489             ds_put_format(string, "/%d", 32 - wild_bits);
490         }
491     } else {
492         ds_put_char(string, '*');
493     }
494     ds_put_char(string, ',');
495 }
496
497 /* Pretty-print the ofp_match structure */
498 static void ofp_print_match(struct ds *f, const struct ofp_match *om, 
499         int verbosity)
500 {
501     uint32_t w = ntohl(om->wildcards);
502     bool skip_type = false;
503     bool skip_proto = false;
504
505     if (!(w & OFPFW_DL_TYPE) &&om->dl_type == htons(ETH_TYPE_IP)) {
506         skip_type = true;
507         if (!(w & OFPFW_NW_PROTO)) {
508             skip_proto = true;
509             if (om->nw_proto == IP_TYPE_ICMP) {
510                 ds_put_cstr(f, "icmp,");
511             } else if (om->nw_proto == IP_TYPE_TCP) {
512                 ds_put_cstr(f, "tcp,");
513             } else if (om->nw_proto == IP_TYPE_UDP) {
514                 ds_put_cstr(f, "udp,");
515             } else {
516                 ds_put_cstr(f, "ip,");
517                 skip_proto = false;
518             }
519         } else {
520             ds_put_cstr(f, "ip,");
521         }
522     }
523     print_wild(f, "in_port=", w & OFPFW_IN_PORT, verbosity,
524                "%d", ntohs(om->in_port));
525     print_wild(f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
526                "0x%04x", ntohs(om->dl_vlan));
527     print_wild(f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
528                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
529     print_wild(f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
530                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
531     if (!skip_type) {
532         print_wild(f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
533                    "0x%04x", ntohs(om->dl_type));
534     }
535     print_ip_netmask(f, "nw_src=", om->nw_src,
536                      (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
537     print_ip_netmask(f, "nw_dst=", om->nw_dst,
538                      (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
539     if (!skip_proto) {
540         print_wild(f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
541                    "%u", om->nw_proto);
542     }
543     print_wild(f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
544                "%d", ntohs(om->tp_src));
545     print_wild(f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
546                "%d", ntohs(om->tp_dst));
547 }
548
549 /* Pretty-print the OFPT_FLOW_MOD packet of 'len' bytes at 'oh' to 'string'
550  * at the given 'verbosity' level. */
551 static void
552 ofp_print_flow_mod(struct ds *string, const void *oh, size_t len, 
553                    int verbosity)
554 {
555     const struct ofp_flow_mod *ofm = oh;
556
557     ofp_print_match(string, &ofm->match, verbosity);
558     ds_put_format(string, " cmd:%d idle:%d hard:%d pri:%d buf:%#x", 
559             ntohs(ofm->command), ntohs(ofm->idle_timeout),
560             ntohs(ofm->hard_timeout),
561             ofm->match.wildcards ? ntohs(ofm->priority) : (uint16_t)-1,
562             ntohl(ofm->buffer_id));
563     ofp_print_actions(string, ofm->actions,
564                       len - offsetof(struct ofp_flow_mod, actions));
565     ds_put_char(string, '\n');
566 }
567
568 /* Pretty-print the OFPT_FLOW_EXPIRED packet of 'len' bytes at 'oh' to 'string'
569  * at the given 'verbosity' level. */
570 static void
571 ofp_print_flow_expired(struct ds *string, const void *oh, size_t len, 
572                        int verbosity)
573 {
574     const struct ofp_flow_expired *ofe = oh;
575
576     ofp_print_match(string, &ofe->match, verbosity);
577     ds_put_cstr(string, " reason=");
578     switch (ofe->reason) {
579     case OFPER_IDLE_TIMEOUT:
580         ds_put_cstr(string, "idle");
581         break;
582     case OFPER_HARD_TIMEOUT:
583         ds_put_cstr(string, "hard");
584         break;
585     default:
586         ds_put_format(string, "**%"PRIu8"**", ofe->reason);
587         break;
588     }
589     ds_put_format(string, 
590          " pri%"PRIu16" secs%"PRIu32" pkts%"PRIu64" bytes%"PRIu64"\n", 
591          ofe->match.wildcards ? ntohs(ofe->priority) : (uint16_t)-1,
592          ntohl(ofe->duration), ntohll(ofe->packet_count), 
593          ntohll(ofe->byte_count));
594 }
595
596 /* Pretty-print the OFPT_ERROR_MSG packet of 'len' bytes at 'oh' to 'string'
597  * at the given 'verbosity' level. */
598 static void
599 ofp_print_error_msg(struct ds *string, const void *oh, size_t len, 
600                        int verbosity)
601 {
602     const struct ofp_error_msg *oem = oh;
603
604     ds_put_format(string, 
605          " type%d code%d\n", ntohs(oem->type), ntohs(oem->code));
606 }
607
608 /* Pretty-print the OFPT_PORT_STATUS packet of 'len' bytes at 'oh' to 'string'
609  * at the given 'verbosity' level. */
610 static void
611 ofp_print_port_status(struct ds *string, const void *oh, size_t len, 
612                       int verbosity)
613 {
614     const struct ofp_port_status *ops = oh;
615
616     if (ops->reason == OFPPR_ADD) {
617         ds_put_format(string, "add:");
618     } else if (ops->reason == OFPPR_DELETE) {
619         ds_put_format(string, "del:");
620     } else if (ops->reason == OFPPR_MOD) {
621         ds_put_format(string, "mod:");
622     } else {
623         ds_put_format(string, "err:");
624     }
625
626     ofp_print_phy_port(string, &ops->desc);
627 }
628
629 static void
630 ofp_version_stats_reply(struct ds *string, const void *body, size_t len,
631                      int verbosity)
632 {
633     const struct ofp_version_stats *vs = body;
634
635     ds_put_format(string, "Manufacturer: %s\n", vs->mfr_desc);
636     ds_put_format(string, "Hardware: %s\n", vs->hw_desc);
637     ds_put_format(string, "Software: %s\n", vs->sw_desc);
638 }
639
640 static void
641 ofp_flow_stats_request(struct ds *string, const void *oh, size_t len,
642                       int verbosity) 
643 {
644     const struct ofp_flow_stats_request *fsr = oh;
645
646     if (fsr->table_id == 0xff) {
647         ds_put_format(string, " table_id=any, ");
648     } else {
649         ds_put_format(string, " table_id=%"PRIu8", ", fsr->table_id);
650     }
651
652     ofp_print_match(string, &fsr->match, verbosity);
653 }
654
655 static void
656 ofp_flow_stats_reply(struct ds *string, const void *body_, size_t len,
657                      int verbosity)
658 {
659     const char *body = body_;
660     const char *pos = body;
661     for (;;) {
662         const struct ofp_flow_stats *fs;
663         ptrdiff_t bytes_left = body + len - pos;
664         size_t length;
665
666         if (bytes_left < sizeof *fs) {
667             if (bytes_left != 0) {
668                 ds_put_format(string, " ***%td leftover bytes at end***",
669                               bytes_left);
670             }
671             break;
672         }
673
674         fs = (const void *) pos;
675         length = ntohs(fs->length);
676         if (length < sizeof *fs) {
677             ds_put_format(string, " ***length=%zu shorter than minimum %zu***",
678                           length, sizeof *fs);
679             break;
680         } else if (length > bytes_left) {
681             ds_put_format(string,
682                           " ***length=%zu but only %td bytes left***",
683                           length, bytes_left);
684             break;
685         } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
686             ds_put_format(string,
687                           " ***length=%zu has %zu bytes leftover in "
688                           "final action***",
689                           length,
690                           (length - sizeof *fs) % sizeof fs->actions[0]);
691             break;
692         }
693
694         ds_put_format(string, "  duration=%"PRIu32"s, ", ntohl(fs->duration));
695         ds_put_format(string, "table_id=%"PRIu8", ", fs->table_id);
696         ds_put_format(string, "priority=%"PRIu16", ", 
697                     fs->match.wildcards ? ntohs(fs->priority) : (uint16_t)-1);
698         ds_put_format(string, "n_packets=%"PRIu64", ",
699                     ntohll(fs->packet_count));
700         ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
701         ds_put_format(string, "idle_timeout=%"PRIu16",",
702                       ntohs(fs->idle_timeout));
703         ds_put_format(string, "hard_timeout=%"PRIu16",",
704                       ntohs(fs->hard_timeout));
705         ofp_print_match(string, &fs->match, verbosity);
706         ofp_print_actions(string, fs->actions, length - sizeof *fs);
707         ds_put_char(string, '\n');
708
709         pos += length;
710      }
711 }
712
713 static void
714 ofp_aggregate_stats_request(struct ds *string, const void *oh, size_t len,
715                             int verbosity) 
716 {
717     const struct ofp_aggregate_stats_request *asr = oh;
718
719     if (asr->table_id == 0xff) {
720         ds_put_format(string, " table_id=any, ");
721     } else {
722         ds_put_format(string, " table_id=%"PRIu8", ", asr->table_id);
723     }
724
725     ofp_print_match(string, &asr->match, verbosity);
726 }
727
728 static void
729 ofp_aggregate_stats_reply(struct ds *string, const void *body_, size_t len,
730                           int verbosity)
731 {
732     const struct ofp_aggregate_stats_reply *asr = body_;
733
734     ds_put_format(string, " packet_count=%"PRIu64, ntohll(asr->packet_count));
735     ds_put_format(string, " byte_count=%"PRIu64, ntohll(asr->byte_count));
736     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
737 }
738
739 static void print_port_stat(struct ds *string, const char *leader, 
740                             uint64_t stat, int more)
741 {
742     ds_put_cstr(string, leader);
743     if (stat != -1) {
744         ds_put_format(string, "%"PRIu64, stat);
745     } else {
746         ds_put_char(string, '?');
747     }
748     if (more) {
749         ds_put_cstr(string, ", ");
750     } else {
751         ds_put_cstr(string, "\n");
752     }
753 }
754
755 static void
756 ofp_port_stats_reply(struct ds *string, const void *body, size_t len,
757                      int verbosity)
758 {
759     const struct ofp_port_stats *ps = body;
760     size_t n = len / sizeof *ps;
761     ds_put_format(string, " %zu ports\n", n);
762     if (verbosity < 1) {
763         return;
764     }
765
766     for (; n--; ps++) {
767         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
768
769         ds_put_cstr(string, "rx ");
770         print_port_stat(string, "pkts=", ntohll(ps->rx_packets), 1);
771         print_port_stat(string, "bytes=", ntohll(ps->rx_bytes), 1);
772         print_port_stat(string, "drop=", ntohll(ps->rx_dropped), 1);
773         print_port_stat(string, "errs=", ntohll(ps->rx_errors), 1);
774         print_port_stat(string, "frame=", ntohll(ps->rx_frame_err), 1);
775         print_port_stat(string, "over=", ntohll(ps->rx_over_err), 1);
776         print_port_stat(string, "crc=", ntohll(ps->rx_crc_err), 0);
777
778         ds_put_cstr(string, "           tx ");
779         print_port_stat(string, "pkts=", ntohll(ps->tx_packets), 1);
780         print_port_stat(string, "bytes=", ntohll(ps->tx_bytes), 1);
781         print_port_stat(string, "drop=", ntohll(ps->tx_dropped), 1);
782         print_port_stat(string, "errs=", ntohll(ps->tx_errors), 1);
783         print_port_stat(string, "coll=", ntohll(ps->collisions), 0);
784     }
785 }
786
787 static void
788 ofp_table_stats_reply(struct ds *string, const void *body, size_t len,
789                      int verbosity)
790 {
791     const struct ofp_table_stats *ts = body;
792     size_t n = len / sizeof *ts;
793     ds_put_format(string, " %zu tables\n", n);
794     if (verbosity < 1) {
795         return;
796     }
797
798     for (; n--; ts++) {
799         char name[OFP_MAX_TABLE_NAME_LEN + 1];
800         strncpy(name, ts->name, sizeof name);
801         name[OFP_MAX_TABLE_NAME_LEN] = '\0';
802
803         ds_put_format(string, "  table %"PRIu8": ", ts->table_id);
804         ds_put_format(string, "name %-8s, ", name);
805         ds_put_format(string, "max %6"PRIu32", ", ntohl(ts->max_entries));
806         ds_put_format(string, "active %6"PRIu32", ", ntohl(ts->active_count));
807         ds_put_format(string, "matched %6"PRIu64"\n",
808                       ntohll(ts->matched_count));
809      }
810 }
811
812 enum stats_direction {
813     REQUEST,
814     REPLY
815 };
816
817 static void
818 print_stats(struct ds *string, int type, const void *body, size_t body_len,
819             int verbosity, enum stats_direction direction)
820 {
821     struct stats_msg {
822         size_t min_body, max_body;
823         void (*printer)(struct ds *, const void *, size_t len, int verbosity);
824     };
825
826     struct stats_type {
827         const char *name;
828         struct stats_msg request;
829         struct stats_msg reply;
830     };
831
832     static const struct stats_type stats_types[] = {
833         [OFPST_VERSION] = {
834             "version",
835             { 0, 0, NULL },
836             { 0, SIZE_MAX, ofp_version_stats_reply },
837         },
838         [OFPST_FLOW] = {
839             "flow",
840             { sizeof(struct ofp_flow_stats_request),
841               sizeof(struct ofp_flow_stats_request),
842               ofp_flow_stats_request },
843             { 0, SIZE_MAX, ofp_flow_stats_reply },
844         },
845         [OFPST_AGGREGATE] = {
846             "aggregate",
847             { sizeof(struct ofp_aggregate_stats_request),
848               sizeof(struct ofp_aggregate_stats_request),
849               ofp_aggregate_stats_request },
850             { sizeof(struct ofp_aggregate_stats_reply),
851               sizeof(struct ofp_aggregate_stats_reply),
852               ofp_aggregate_stats_reply },
853         },
854         [OFPST_TABLE] = {
855             "table",
856             { 0, 0, NULL },
857             { 0, SIZE_MAX, ofp_table_stats_reply },
858         },
859         [OFPST_PORT] = {
860             "port",
861             { 0, 0, NULL, },
862             { 0, SIZE_MAX, ofp_port_stats_reply },
863         },
864     };
865
866     const struct stats_type *s;
867     const struct stats_msg *m;
868
869     if (type >= ARRAY_SIZE(stats_types) || !stats_types[type].name) {
870         ds_put_format(string, " ***unknown type %d***", type);
871         return;
872     }
873     s = &stats_types[type];
874     ds_put_format(string, " type=%d(%s)\n", type, s->name);
875
876     m = direction == REQUEST ? &s->request : &s->reply;
877     if (body_len < m->min_body || body_len > m->max_body) {
878         ds_put_format(string, " ***body_len=%zu not in %zu...%zu***",
879                       body_len, m->min_body, m->max_body);
880         return;
881     }
882     if (m->printer) {
883         m->printer(string, body, body_len, verbosity);
884     }
885 }
886
887 static void
888 ofp_stats_request(struct ds *string, const void *oh, size_t len, int verbosity)
889 {
890     const struct ofp_stats_request *srq = oh;
891
892     if (srq->flags) {
893         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
894                       ntohs(srq->flags));
895     }
896
897     print_stats(string, ntohs(srq->type), srq->body,
898                 len - offsetof(struct ofp_stats_request, body),
899                 verbosity, REQUEST);
900 }
901
902 static void
903 ofp_stats_reply(struct ds *string, const void *oh, size_t len, int verbosity)
904 {
905     const struct ofp_stats_reply *srp = oh;
906
907     ds_put_cstr(string, " flags=");
908     if (!srp->flags) {
909         ds_put_cstr(string, "none");
910     } else {
911         uint16_t flags = ntohs(srp->flags);
912         if (flags & OFPSF_REPLY_MORE) {
913             ds_put_cstr(string, "[more]");
914             flags &= ~OFPSF_REPLY_MORE;
915         }
916         if (flags) {
917             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]", flags);
918         }
919     }
920
921     print_stats(string, ntohs(srp->type), srp->body,
922                 len - offsetof(struct ofp_stats_reply, body),
923                 verbosity, REPLY);
924 }
925
926 static void
927 ofp_echo(struct ds *string, const void *oh, size_t len, int verbosity)
928 {
929     const struct ofp_header *hdr = oh;
930
931     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *hdr);
932     if (verbosity > 1) {
933         ds_put_hex_dump(string, hdr, len - sizeof *hdr, 0, true); 
934     }
935 }
936
937 struct openflow_packet {
938     const char *name;
939     size_t min_size;
940     void (*printer)(struct ds *, const void *, size_t len, int verbosity);
941 };
942
943 static const struct openflow_packet packets[] = {
944     [OFPT_FEATURES_REQUEST] = {
945         "features_request",
946         sizeof (struct ofp_header),
947         NULL,
948     },
949     [OFPT_FEATURES_REPLY] = {
950         "features_reply",
951         sizeof (struct ofp_switch_features),
952         ofp_print_switch_features,
953     },
954     [OFPT_GET_CONFIG_REQUEST] = {
955         "get_config_request",
956         sizeof (struct ofp_header),
957         NULL,
958     },
959     [OFPT_GET_CONFIG_REPLY] = {
960         "get_config_reply",
961         sizeof (struct ofp_switch_config),
962         ofp_print_switch_config,
963     },
964     [OFPT_SET_CONFIG] = {
965         "set_config",
966         sizeof (struct ofp_switch_config),
967         ofp_print_switch_config,
968     },
969     [OFPT_PACKET_IN] = {
970         "packet_in",
971         offsetof(struct ofp_packet_in, data),
972         ofp_packet_in,
973     },
974     [OFPT_PACKET_OUT] = {
975         "packet_out",
976         sizeof (struct ofp_packet_out),
977         ofp_packet_out,
978     },
979     [OFPT_FLOW_MOD] = {
980         "flow_mod",
981         sizeof (struct ofp_flow_mod),
982         ofp_print_flow_mod,
983     },
984     [OFPT_FLOW_EXPIRED] = {
985         "flow_expired",
986         sizeof (struct ofp_flow_expired),
987         ofp_print_flow_expired,
988     },
989     [OFPT_PORT_MOD] = {
990         "port_mod",
991         sizeof (struct ofp_port_mod),
992         NULL,
993     },
994     [OFPT_PORT_STATUS] = {
995         "port_status",
996         sizeof (struct ofp_port_status),
997         ofp_print_port_status
998     },
999     [OFPT_ERROR_MSG] = {
1000         "error_msg",
1001         sizeof (struct ofp_error_msg),
1002         ofp_print_error_msg,
1003     },
1004     [OFPT_STATS_REQUEST] = {
1005         "stats_request",
1006         sizeof (struct ofp_stats_request),
1007         ofp_stats_request,
1008     },
1009     [OFPT_STATS_REPLY] = {
1010         "stats_reply",
1011         sizeof (struct ofp_stats_reply),
1012         ofp_stats_reply,
1013     },
1014     [OFPT_ECHO_REQUEST] = {
1015         "echo_request",
1016         sizeof (struct ofp_header),
1017         ofp_echo,
1018     },
1019     [OFPT_ECHO_REPLY] = {
1020         "echo_reply",
1021         sizeof (struct ofp_header),
1022         ofp_echo,
1023     },
1024 };
1025
1026 /* Composes and returns a string representing the OpenFlow packet of 'len'
1027  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1028  * verbosity and higher numbers increase verbosity.  The caller is responsible
1029  * for freeing the string. */
1030 char *
1031 ofp_to_string(const void *oh_, size_t len, int verbosity)
1032 {
1033     struct ds string = DS_EMPTY_INITIALIZER;
1034     const struct ofp_header *oh = oh_;
1035     const struct openflow_packet *pkt;
1036
1037     if (len < sizeof(struct ofp_header)) {
1038         ds_put_cstr(&string, "OpenFlow packet too short:\n");
1039         ds_put_hex_dump(&string, oh, len, 0, true);
1040         return ds_cstr(&string);
1041     } else if (oh->version != OFP_VERSION) {
1042         ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n", oh->version);
1043         ds_put_hex_dump(&string, oh, len, 0, true);
1044         return ds_cstr(&string);
1045     } else if (oh->type >= ARRAY_SIZE(packets) || !packets[oh->type].name) {
1046         ds_put_format(&string, "Unknown OpenFlow packet type %"PRIu8":\n",
1047                 oh->type);
1048         ds_put_hex_dump(&string, oh, len, 0, true);
1049         return ds_cstr(&string);
1050     }
1051
1052     pkt = &packets[oh->type];
1053     ds_put_format(&string, "%s (xid=0x%"PRIx32"):", pkt->name, oh->xid);
1054
1055     if (ntohs(oh->length) > len)
1056         ds_put_format(&string, " (***truncated to %zu bytes from %"PRIu16"***)",
1057                 len, ntohs(oh->length));
1058     else if (ntohs(oh->length) < len) {
1059         ds_put_format(&string, " (***only uses %"PRIu16" bytes out of %zu***)\n",
1060                 ntohs(oh->length), len);
1061         len = ntohs(oh->length);
1062     }
1063
1064     if (len < pkt->min_size) {
1065         ds_put_format(&string, " (***length=%zu < min_size=%zu***)\n",
1066                 len, pkt->min_size);
1067     } else if (!pkt->printer) {
1068         if (len > sizeof *oh) {
1069             ds_put_format(&string, " length=%"PRIu16" (decoder not implemented)\n",
1070                           ntohs(oh->length)); 
1071         }
1072     } else {
1073         pkt->printer(&string, oh, len, verbosity);
1074     }
1075     if (verbosity >= 3) {
1076         ds_put_hex_dump(&string, oh, len, 0, true);
1077     }
1078     if (string.string[string.length - 1] != '\n') {
1079         ds_put_char(&string, '\n');
1080     }
1081     return ds_cstr(&string);
1082 }
1083 \f
1084 static void
1085 print_and_free(FILE *stream, char *string) 
1086 {
1087     fputs(string, stream);
1088     free(string);
1089 }
1090
1091 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1092  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1093  * numbers increase verbosity. */
1094 void
1095 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1096 {
1097     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1098 }
1099
1100 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1101  * 'data' to 'stream' using tcpdump.  'total_len' specifies the full length of
1102  * the Ethernet frame (of which 'len' bytes were captured).
1103  *
1104  * This starts and kills a tcpdump subprocess so it's quite expensive. */
1105 void
1106 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1107 {
1108     print_and_free(stream, ofp_packet_to_string(data, len, total_len));
1109 }