1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
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:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
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
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.
34 #include "ofp-print.h"
39 #include <netinet/in.h>
46 #include "dynamic-string.h"
51 /* Returns a string that represents the contents of the Ethernet frame in the
52 * 'len' bytes starting at 'data' to 'stream' as output by tcpdump.
53 * 'total_len' specifies the full length of the Ethernet frame (of which 'len'
54 * bytes were captured).
56 * The caller must free the returned string.
58 * This starts and kills a tcpdump subprocess so it's quite expensive. */
60 ofp_packet_to_string(const void *data, size_t len, size_t total_len)
63 uint32_t magic_number; /* magic number */
64 uint16_t version_major; /* major version number */
65 uint16_t version_minor; /* minor version number */
66 int32_t thiszone; /* GMT to local correction */
67 uint32_t sigfigs; /* accuracy of timestamps */
68 uint32_t snaplen; /* max length of captured packets */
69 uint32_t network; /* data link type */
73 uint32_t ts_sec; /* timestamp seconds */
74 uint32_t ts_usec; /* timestamp microseconds */
75 uint32_t incl_len; /* number of octets of packet saved in file */
76 uint32_t orig_len; /* actual length of packet */
80 struct pcaprec_hdr prh;
82 struct ds ds = DS_EMPTY_INITIALIZER;
92 error(errno, "tmpfile");
93 return xstrdup("<error>");
96 /* The pcap reader is responsible for figuring out endianness based on the
97 * magic number, so the lack of htonX calls here is intentional. */
98 ph.magic_number = 0xa1b2c3d4;
100 ph.version_minor = 4;
104 ph.network = 1; /* Ethernet */
109 prh.orig_len = total_len;
111 fwrite(&ph, 1, sizeof ph, pcap);
112 fwrite(&prh, 1, sizeof prh, pcap);
113 fwrite(data, 1, len, pcap);
117 error(errno, "error writing temporary file");
121 snprintf(command, sizeof command, "tcpdump -n -r /dev/fd/%d 2>/dev/null",
123 tcpdump = popen(command, "r");
126 error(errno, "exec(\"%s\")", command);
127 return xstrdup("<error>");
130 while ((c = getc(tcpdump)) != EOF) {
134 status = pclose(tcpdump);
135 if (WIFEXITED(status)) {
136 if (WEXITSTATUS(status))
137 error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
138 } else if (WIFSIGNALED(status)) {
139 error(0, "tcpdump exited with signal %d", WTERMSIG(status));
144 /* Pretty-print the OFPT_PACKET_IN packet of 'len' bytes at 'oh' to 'stream'
145 * at the given 'verbosity' level. */
147 ofp_packet_in(struct ds *string, const void *oh, size_t len, int verbosity)
149 const struct ofp_packet_in *op = oh;
152 ds_put_format(string, " total_len=%"PRIu16" in_port=%"PRIu8,
153 ntohs(op->total_len), ntohs(op->in_port));
155 if (op->reason == OFPR_ACTION)
156 ds_put_cstr(string, " (via action)");
157 else if (op->reason != OFPR_NO_MATCH)
158 ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
160 data_len = len - offsetof(struct ofp_packet_in, data);
161 ds_put_format(string, " data_len=%zu", data_len);
162 if (htonl(op->buffer_id) == UINT32_MAX) {
163 ds_put_format(string, " (unbuffered)");
164 if (ntohs(op->total_len) != data_len)
165 ds_put_format(string, " (***total_len != data_len***)");
167 ds_put_format(string, " buffer=%08"PRIx32, ntohl(op->buffer_id));
168 if (ntohs(op->total_len) < data_len)
169 ds_put_format(string, " (***total_len < data_len***)");
171 ds_put_char(string, '\n');
174 char *packet = ofp_packet_to_string(op->data, data_len,
175 ntohs(op->total_len));
176 ds_put_cstr(string, packet);
181 static void ofp_print_port_name(struct ds *string, uint16_t port)
183 if (port == UINT16_MAX) {
184 ds_put_cstr(string, "none");
185 } else if (port == OFPP_FLOOD) {
186 ds_put_cstr(string, "flood");
187 } else if (port == OFPP_CONTROLLER) {
188 ds_put_cstr(string, "controller");
190 ds_put_format(string, "%"PRIu16, port);
195 ofp_print_action(struct ds *string, const struct ofp_action *a)
197 switch (ntohs(a->type)) {
199 ds_put_cstr(string, "output(");
200 ofp_print_port_name(string, ntohs(a->arg.output.port));
201 if (a->arg.output.port == htons(OFPP_CONTROLLER)) {
202 ds_put_format(string, ", max %"PRIu16" bytes", ntohs(a->arg.output.max_len));
204 ds_put_cstr(string, ")");
208 ds_put_format(string, "(decoder %"PRIu16" not implemented)", ntohs(a->type));
213 static void ofp_print_actions(struct ds *string,
214 const struct ofp_action actions[],
219 ds_put_cstr(string, " actions[");
220 for (i = 0; i < n_bytes / sizeof *actions; i++) {
222 ds_put_cstr(string, "; ");
224 ofp_print_action(string, &actions[i]);
226 if (n_bytes % sizeof *actions) {
228 ds_put_cstr(string, "; ");
230 ds_put_cstr(string, "; ***trailing garbage***");
232 ds_put_cstr(string, "]");
235 /* Pretty-print the OFPT_PACKET_OUT packet of 'len' bytes at 'oh' to 'string'
236 * at the given 'verbosity' level. */
237 static void ofp_packet_out(struct ds *string, const void *oh, size_t len,
240 const struct ofp_packet_out *opo = oh;
242 ds_put_cstr(string, " in_port=");
243 ofp_print_port_name(string, ntohs(opo->in_port));
245 if (ntohl(opo->buffer_id) == UINT32_MAX) {
246 ds_put_cstr(string, " out_port=");
247 ofp_print_port_name(string, ntohs(opo->out_port));
248 if (verbosity > 0 && len > sizeof *opo) {
249 char *packet = ofp_packet_to_string(opo->u.data, len - sizeof *opo,
251 ds_put_cstr(string, packet);
255 ds_put_format(string, " buffer=%08"PRIx32, ntohl(opo->buffer_id));
256 ofp_print_actions(string, opo->u.actions, len - sizeof *opo);
258 ds_put_char(string, '\n');
261 /* qsort comparison function. */
263 compare_ports(const void *a_, const void *b_)
265 const struct ofp_phy_port *a = a_;
266 const struct ofp_phy_port *b = b_;
267 uint16_t ap = ntohs(a->port_no);
268 uint16_t bp = ntohs(b->port_no);
270 return ap < bp ? -1 : ap > bp;
274 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
276 uint8_t name[OFP_MAX_PORT_NAME_LEN];
279 memcpy(name, port->name, sizeof name);
280 for (j = 0; j < sizeof name - 1; j++) {
281 if (!isprint(name[j])) {
287 ds_put_format(string, " %2d(%s): addr:"ETH_ADDR_FMT", speed:%d, flags:%#x, "
288 "feat:%#x\n", ntohs(port->port_no), name,
289 ETH_ADDR_ARGS(port->hw_addr), ntohl(port->speed),
290 ntohl(port->flags), ntohl(port->features));
293 /* Pretty-print the struct ofp_switch_features of 'len' bytes at 'oh' to
294 * 'string' at the given 'verbosity' level. */
296 ofp_print_switch_features(struct ds *string, const void *oh, size_t len,
299 const struct ofp_switch_features *osf = oh;
300 struct ofp_phy_port port_list[OFPP_MAX];
304 ds_put_format(string, "dp id:%"PRIx64"\n", ntohll(osf->datapath_id));
305 ds_put_format(string, "tables: exact:%d, mac:%d, compressed:%d, general:%d\n",
306 ntohl(osf->n_exact), ntohl(osf->n_mac_only),
307 ntohl(osf->n_compression), ntohl(osf->n_general));
308 ds_put_format(string, "buffers: size:%d, number:%d\n",
309 ntohl(osf->buffer_mb), ntohl(osf->n_buffers));
310 ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
311 ntohl(osf->capabilities), ntohl(osf->actions));
313 if (ntohs(osf->header.length) >= sizeof *osf) {
314 len = MIN(len, ntohs(osf->header.length));
316 n_ports = (len - sizeof *osf) / sizeof *osf->ports;
318 memcpy(port_list, osf->ports, (len - sizeof *osf));
319 qsort(port_list, n_ports, sizeof port_list[0], compare_ports);
320 for (i = 0; i < n_ports; i++) {
321 ofp_print_phy_port(string, &port_list[i]);
325 /* Pretty-print the struct ofp_switch_config of 'len' bytes at 'oh' to 'string'
326 * at the given 'verbosity' level. */
328 ofp_print_switch_config(struct ds *string, const void *oh, size_t len,
331 const struct ofp_switch_config *osc = oh;
334 flags = ntohs(osc->flags);
335 if (flags & OFPC_SEND_FLOW_EXP) {
336 flags &= ~OFPC_SEND_FLOW_EXP;
337 ds_put_format(string, " (sending flow expirations)");
340 ds_put_format(string, " ***unknown flags %04"PRIx16"***", flags);
343 ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
346 static void print_wild(struct ds *string, const char *leader, int is_wild,
347 const char *format, ...) __attribute__((format(printf, 4, 5)));
349 static void print_wild(struct ds *string, const char *leader, int is_wild,
350 const char *format, ...)
352 ds_put_cstr(string, leader);
356 va_start(args, format);
357 ds_put_format_valist(string, format, args);
360 ds_put_char(string, '?');
364 /* Pretty-print the ofp_match structure */
365 static void ofp_print_match(struct ds *f, const struct ofp_match *om)
367 uint16_t w = ntohs(om->wildcards);
369 print_wild(f, "inport", w & OFPFW_IN_PORT, "%04x", ntohs(om->in_port));
370 print_wild(f, ":vlan", w & OFPFW_DL_VLAN, "%04x", ntohs(om->dl_vlan));
371 print_wild(f, " mac[", w & OFPFW_DL_SRC,
372 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
373 print_wild(f, "->", w & OFPFW_DL_DST,
374 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
375 print_wild(f, "] type", w & OFPFW_DL_TYPE, "%04x", ntohs(om->dl_type));
376 print_wild(f, " ip[", w & OFPFW_NW_SRC, IP_FMT, IP_ARGS(&om->nw_src));
377 print_wild(f, "->", w & OFPFW_NW_DST, IP_FMT, IP_ARGS(&om->nw_dst));
378 print_wild(f, "] proto", w & OFPFW_NW_PROTO, "%u", om->nw_proto);
379 print_wild(f, " tport[", w & OFPFW_TP_SRC, "%d", ntohs(om->tp_src));
380 print_wild(f, "->", w & OFPFW_TP_DST, "%d", ntohs(om->tp_dst));
381 ds_put_cstr(f, "]\n");
384 /* Pretty-print the OFPT_FLOW_MOD packet of 'len' bytes at 'oh' to 'string'
385 * at the given 'verbosity' level. */
387 ofp_print_flow_mod(struct ds *string, const void *oh, size_t len,
390 const struct ofp_flow_mod *ofm = oh;
392 ofp_print_match(string, &ofm->match);
393 ds_put_format(string, " cmd:%d idle:%d buf:%#x grp:%d\n", ntohs(ofm->command),
394 ntohs(ofm->max_idle), ntohl(ofm->buffer_id), ntohl(ofm->group_id));
397 /* Pretty-print the OFPT_FLOW_EXPIRED packet of 'len' bytes at 'oh' to 'string'
398 * at the given 'verbosity' level. */
399 void ofp_print_flow_expired(struct ds *string, const void *oh, size_t len,
402 const struct ofp_flow_expired *ofe = oh;
404 ofp_print_match(string, &ofe->match);
405 ds_put_format(string,
406 " secs%d pkts%lld bytes%lld\n", ntohl(ofe->duration),
407 ntohll(ofe->packet_count), ntohll(ofe->byte_count));
410 /* Pretty-print the OFPT_PORT_STATUS packet of 'len' bytes at 'oh' to 'string'
411 * at the given 'verbosity' level. */
412 void ofp_print_port_status(struct ds *string, const void *oh, size_t len,
415 const struct ofp_port_status *ops = oh;
417 if (ops->reason == OFPPR_ADD) {
418 ds_put_format(string, "add:");
419 } else if (ops->reason == OFPPR_DELETE) {
420 ds_put_format(string, "del:");
421 } else if (ops->reason == OFPPR_MOD) {
422 ds_put_format(string, "mod:");
424 ds_put_format(string, "err:");
427 ofp_print_phy_port(string, &ops->desc);
431 ofp_flow_stat_request(struct ds *string, const void *oh, size_t len,
434 const struct ofp_flow_stat_request *fsr = oh;
436 if (fsr->table_id == htons(0xffff)) {
437 ds_put_format(string, " table_id=any, ");
439 ds_put_format(string, " table_id=%"PRIu16", ", ntohs(fsr->table_id));
442 if (fsr->type == OFPFS_INDIV) {
443 ds_put_cstr(string, " type=indiv, ");
444 } else if (fsr->type == OFPFS_AGGREGATE) {
445 ds_put_cstr(string, " type=aggregate, ");
447 ds_put_format(string, " ***type=%"PRIu8"***, ", fsr->type);
449 ofp_print_match(string, &fsr->match);
453 ofp_flow_stat_reply(struct ds *string, const void *oh, size_t len,
456 const struct ofp_flow_stat_reply *fsr = oh;
457 const struct ofp_flow_stats *fs;
460 n = (len - offsetof(struct ofp_flow_stat_reply, flows)) / sizeof *fs;
461 ds_put_format(string, " %zu flows\n", n);
466 for (fs = &fsr->flows[0]; fs < &fsr->flows[n]; fs++) {
467 ds_put_format(string, " duration=%"PRIu16" s, ", ntohs(fs->duration));
468 ds_put_format(string, "table_id=%"PRIu16", ", ntohs(fs->table_id));
469 ds_put_format(string, "n_packets=%"PRIu64", ",
470 ntohll(fs->packet_count));
471 ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
472 ofp_print_match(string, &fs->match);
477 ofp_port_stat_reply(struct ds *string, const void *oh, size_t len,
480 const struct ofp_port_stat_reply *psr = oh;
481 const struct ofp_port_stats *ps;
484 n = (len - offsetof(struct ofp_port_stat_reply, ports)) / sizeof *ps;
485 ds_put_format(string, " %zu ports\n", n);
490 for (ps = &psr->ports[0]; ps < &psr->ports[n]; ps++) {
491 ds_put_format(string, " port %"PRIu16": ", ntohs(ps->port_no));
492 ds_put_format(string, "rx %"PRIu64", ", ntohll(ps->rx_count));
493 ds_put_format(string, "tx %"PRIu64", ", ntohll(ps->tx_count));
494 ds_put_format(string, "dropped %"PRIu64"\n", ntohll(ps->drop_count));
499 ofp_table_stat_reply(struct ds *string, const void *oh, size_t len,
502 const struct ofp_table_stat_reply *tsr = oh;
503 const struct ofp_table_stats *ts;
506 n = (len - offsetof(struct ofp_table_stat_reply, tables)) / sizeof *ts;
507 ds_put_format(string, " %zu tables\n", n);
512 for (ts = &tsr->tables[0]; ts < &tsr->tables[n]; ts++) {
513 char name[OFP_MAX_TABLE_NAME_LEN + 1];
514 strncpy(name, ts->name, sizeof name);
515 name[OFP_MAX_TABLE_NAME_LEN] = '\0';
517 ds_put_format(string, " table %"PRIu16": ", ntohs(ts->table_id));
518 ds_put_format(string, "name %-8s, ", name);
519 ds_put_format(string, "max %6"PRIu32", ", ntohl(ts->max_entries));
520 ds_put_format(string, "active %6"PRIu32", ", ntohl(ts->active_count));
521 ds_put_format(string, "matched %6"PRIu64"\n",
522 ntohll(ts->matched_count));
526 struct openflow_packet {
529 void (*printer)(struct ds *, const void *, size_t len, int verbosity);
532 static const struct openflow_packet packets[] = {
533 [OFPT_FEATURES_REQUEST] = {
535 sizeof (struct ofp_header),
538 [OFPT_FEATURES_REPLY] = {
540 sizeof (struct ofp_switch_features),
541 ofp_print_switch_features,
543 [OFPT_GET_CONFIG_REQUEST] = {
544 "get_config_request",
545 sizeof (struct ofp_header),
548 [OFPT_GET_CONFIG_REPLY] = {
550 sizeof (struct ofp_switch_config),
551 ofp_print_switch_config,
553 [OFPT_SET_CONFIG] = {
555 sizeof (struct ofp_switch_config),
556 ofp_print_switch_config,
560 offsetof(struct ofp_packet_in, data),
563 [OFPT_PACKET_OUT] = {
565 sizeof (struct ofp_packet_out),
570 sizeof (struct ofp_flow_mod),
573 [OFPT_FLOW_EXPIRED] = {
575 sizeof (struct ofp_flow_expired),
576 ofp_print_flow_expired,
580 sizeof (struct ofp_port_mod),
583 [OFPT_PORT_STATUS] = {
585 sizeof (struct ofp_port_status),
586 ofp_print_port_status
588 [OFPT_FLOW_STAT_REQUEST] = {
590 sizeof (struct ofp_flow_stat_request),
591 ofp_flow_stat_request,
593 [OFPT_FLOW_STAT_REPLY] = {
595 sizeof (struct ofp_flow_stat_reply),
598 [OFPT_PORT_STAT_REQUEST] = {
600 sizeof (struct ofp_port_stat_request),
603 [OFPT_PORT_STAT_REPLY] = {
605 sizeof (struct ofp_port_stat_reply),
608 [OFPT_TABLE_STAT_REQUEST] = {
609 "table_stat_request",
610 sizeof (struct ofp_table_stat_request),
613 [OFPT_TABLE_STAT_REPLY] = {
615 sizeof (struct ofp_table_stat_reply),
616 ofp_table_stat_reply,
620 /* Composes and returns a string representing the OpenFlow packet of 'len'
621 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
622 * verbosity and higher numbers increase verbosity. The caller is responsible
623 * for freeing the string. */
625 ofp_to_string(const void *oh_, size_t len, int verbosity)
627 struct ds string = DS_EMPTY_INITIALIZER;
628 const struct ofp_header *oh = oh_;
629 const struct openflow_packet *pkt;
631 if (len < sizeof(struct ofp_header)) {
632 ds_put_cstr(&string, "OpenFlow packet too short:\n");
633 ds_put_hex_dump(&string, oh, len, 0, true);
634 return ds_cstr(&string);
635 } else if (oh->version != 1) {
636 ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n", oh->version);
637 ds_put_hex_dump(&string, oh, len, 0, true);
638 return ds_cstr(&string);
639 } else if (oh->type >= ARRAY_SIZE(packets) || !packets[oh->type].name) {
640 ds_put_format(&string, "Unknown OpenFlow packet type %"PRIu8":\n",
642 ds_put_hex_dump(&string, oh, len, 0, true);
643 return ds_cstr(&string);
646 pkt = &packets[oh->type];
647 ds_put_format(&string, "%s (xid=%"PRIx32"):", pkt->name, oh->xid);
649 if (ntohs(oh->length) > len)
650 ds_put_format(&string, " (***truncated to %zu bytes from %"PRIu16"***)",
651 len, ntohs(oh->length));
652 else if (ntohs(oh->length) < len) {
653 ds_put_format(&string, " (***only uses %"PRIu16" bytes out of %zu***)\n",
654 ntohs(oh->length), len);
655 len = ntohs(oh->length);
658 if (len < pkt->min_size) {
659 ds_put_format(&string, " (***length=%zu < min_size=%zu***)\n",
661 } else if (!pkt->printer) {
662 if (len > sizeof *oh) {
663 ds_put_format(&string, " length=%zu (decoder not implemented)\n",
667 pkt->printer(&string, oh, len, verbosity);
669 if (verbosity >= 3) {
670 ds_put_hex_dump(&string, oh, len, 0, true);
672 return ds_cstr(&string);
676 print_and_free(FILE *stream, char *string)
678 fputs(string, stream);
682 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
683 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
684 * numbers increase verbosity. */
686 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
688 print_and_free(stream, ofp_to_string(oh, len, verbosity));
691 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
692 * 'data' to 'stream' using tcpdump. 'total_len' specifies the full length of
693 * the Ethernet frame (of which 'len' bytes were captured).
695 * This starts and kills a tcpdump subprocess so it's quite expensive. */
697 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
699 print_and_free(stream, ofp_packet_to_string(data, len, total_len));