2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 #include "ofp-print.h"
22 #include <sys/types.h>
23 #include <netinet/in.h>
29 #include "byte-order.h"
31 #include "dynamic-string.h"
33 #include "multipath.h"
37 #include "openflow/openflow.h"
38 #include "openflow/nicira-ext.h"
41 #include "type-props.h"
42 #include "unaligned.h"
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);
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).
55 * The caller must free the returned string.
57 * This starts and kills a tcpdump subprocess so it's quite expensive. */
59 ofp_packet_to_string(const void *data, size_t len, size_t total_len OVS_UNUSED)
61 struct ds ds = DS_EMPTY_INITIALIZER;
70 ofpbuf_use_const(&buf, data, len);
74 ovs_error(errno, "tmpfile");
75 return xstrdup("<error>");
77 pcap_write_header(pcap);
78 pcap_write(pcap, &buf);
81 ovs_error(errno, "error writing temporary file");
85 snprintf(command, sizeof command, "/usr/sbin/tcpdump -t -e -n -r /dev/fd/%d 2>/dev/null",
87 tcpdump = popen(command, "r");
90 ovs_error(errno, "exec(\"%s\")", command);
91 return xstrdup("<error>");
94 while ((c = getc(tcpdump)) != EOF) {
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));
109 ofp_print_packet_in(struct ds *string, const struct ofp_packet_in *op,
112 size_t len = ntohs(op->header.length);
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));
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);
124 data_len = len - offsetof(struct ofp_packet_in, data);
125 ds_put_format(string, " data_len=%zu", data_len);
126 if (htonl(op->buffer_id) == 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***)");
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***)");
135 ds_put_char(string, '\n');
139 struct ofpbuf packet;
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');
147 char *packet = ofp_packet_to_string(op->data, data_len,
148 ntohs(op->total_len));
149 ds_put_cstr(string, packet);
154 static void ofp_print_port_name(struct ds *string, uint16_t port)
173 case OFPP_CONTROLLER:
183 ds_put_format(string, "%"PRIu16, port);
186 ds_put_cstr(string, name);
191 print_note(struct ds *string, const struct nx_action_note *nan)
196 ds_put_cstr(string, "note:");
197 len = ntohs(nan->len) - offsetof(struct nx_action_note, note);
198 for (i = 0; i < len; i++) {
200 ds_put_char(string, '.');
202 ds_put_format(string, "%02"PRIx8, nan->note[i]);
207 nx_action_len(enum nx_action_subtype 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:
214 return sizeof(struct nx_action_drop_spoofed_arp);
215 case NXAST_SET_QUEUE: return sizeof(struct nx_action_set_queue);
216 case NXAST_POP_QUEUE: return sizeof(struct nx_action_pop_queue);
217 case NXAST_REG_MOVE: return sizeof(struct nx_action_reg_move);
218 case NXAST_REG_LOAD: return sizeof(struct nx_action_reg_load);
219 case NXAST_NOTE: return -1;
220 case NXAST_SET_TUNNEL64: return sizeof(struct nx_action_set_tunnel64);
221 case NXAST_MULTIPATH: return sizeof(struct nx_action_multipath);
227 ofp_print_nx_action(struct ds *string, const struct nx_action_header *nah)
229 uint16_t subtype = ntohs(nah->subtype);
230 int required_len = nx_action_len(subtype);
231 int len = ntohs(nah->len);
233 if (required_len != -1 && required_len != len) {
234 ds_put_format(string, "***Nicira action %"PRIu16" wrong length: %d***",
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;
248 switch ((enum nx_action_subtype) subtype) {
250 nar = (struct nx_action_resubmit *)nah;
251 ds_put_format(string, "resubmit:");
252 ofp_print_port_name(string, ntohs(nar->in_port));
255 case NXAST_SET_TUNNEL:
256 nast = (struct nx_action_set_tunnel *)nah;
257 ds_put_format(string, "set_tunnel:%#"PRIx32, ntohl(nast->tun_id));
260 case NXAST_DROP_SPOOFED_ARP:
261 ds_put_cstr(string, "drop_spoofed_arp");
264 case NXAST_SET_QUEUE:
265 nasq = (struct nx_action_set_queue *)nah;
266 ds_put_format(string, "set_queue:%u", ntohl(nasq->queue_id));
269 case NXAST_POP_QUEUE:
270 ds_put_cstr(string, "pop_queue");
274 print_note(string, (const struct nx_action_note *) nah);
278 move = (const struct nx_action_reg_move *) nah;
279 nxm_format_reg_move(move, string);
283 load = (const struct nx_action_reg_load *) nah;
284 nxm_format_reg_load(load, string);
287 case NXAST_SET_TUNNEL64:
288 nast64 = (const struct nx_action_set_tunnel64 *) nah;
289 ds_put_format(string, "set_tunnel64:%#"PRIx64,
290 ntohll(nast64->tun_id));
293 case NXAST_MULTIPATH:
294 nam = (const struct nx_action_multipath *) nah;
295 multipath_format(nam, string);
298 case NXAST_SNAT__OBSOLETE:
304 ds_put_format(string, "***unknown Nicira action:%"PRIu16"***", subtype);
308 ofp_action_len(enum ofp_action_type type)
311 case OFPAT_OUTPUT: return sizeof(struct ofp_action_output);
312 case OFPAT_SET_VLAN_VID: return sizeof(struct ofp_action_vlan_vid);
313 case OFPAT_SET_VLAN_PCP: return sizeof(struct ofp_action_vlan_pcp);
314 case OFPAT_STRIP_VLAN: return sizeof(struct ofp_action_header);
315 case OFPAT_SET_DL_SRC: return sizeof(struct ofp_action_dl_addr);
316 case OFPAT_SET_DL_DST: return sizeof(struct ofp_action_dl_addr);
317 case OFPAT_SET_NW_SRC: return sizeof(struct ofp_action_nw_addr);
318 case OFPAT_SET_NW_DST: return sizeof(struct ofp_action_nw_addr);
319 case OFPAT_SET_NW_TOS: return sizeof(struct ofp_action_nw_tos);
320 case OFPAT_SET_TP_SRC: return sizeof(struct ofp_action_tp_port);
321 case OFPAT_SET_TP_DST: return sizeof(struct ofp_action_tp_port);
322 case OFPAT_ENQUEUE: return sizeof(struct ofp_action_enqueue);
323 case OFPAT_VENDOR: return -1;
329 ofp_print_action(struct ds *string, const struct ofp_action_header *ah,
332 enum ofp_action_type type;
336 if (actions_len < sizeof *ah) {
337 ds_put_format(string, "***action array too short for next action***\n");
341 type = ntohs(ah->type);
342 len = ntohs(ah->len);
343 if (actions_len < len) {
344 ds_put_format(string, "***truncated action %d***\n", (int) type);
349 ds_put_format(string, "***zero-length action***\n");
353 if ((len % OFP_ACTION_ALIGN) != 0) {
354 ds_put_format(string,
355 "***action %d length not a multiple of %d***\n",
356 (int) type, OFP_ACTION_ALIGN);
360 required_len = ofp_action_len(type);
361 if (required_len >= 0 && len != required_len) {
362 ds_put_format(string,
363 "***action %d wrong length: %zu***\n", (int) type, len);
369 struct ofp_action_output *oa = (struct ofp_action_output *)ah;
370 uint16_t port = ntohs(oa->port);
371 if (port < OFPP_MAX) {
372 ds_put_format(string, "output:%"PRIu16, port);
374 ofp_print_port_name(string, port);
375 if (port == OFPP_CONTROLLER) {
377 ds_put_format(string, ":%"PRIu16, ntohs(oa->max_len));
379 ds_put_cstr(string, ":all");
386 case OFPAT_ENQUEUE: {
387 struct ofp_action_enqueue *ea = (struct ofp_action_enqueue *)ah;
388 unsigned int port = ntohs(ea->port);
389 unsigned int queue_id = ntohl(ea->queue_id);
390 ds_put_format(string, "enqueue:");
391 if (port != OFPP_IN_PORT) {
392 ds_put_format(string, "%u", port);
394 ds_put_cstr(string, "IN_PORT");
396 ds_put_format(string, "q%u", queue_id);
400 case OFPAT_SET_VLAN_VID: {
401 struct ofp_action_vlan_vid *va = (struct ofp_action_vlan_vid *)ah;
402 ds_put_format(string, "mod_vlan_vid:%"PRIu16, ntohs(va->vlan_vid));
406 case OFPAT_SET_VLAN_PCP: {
407 struct ofp_action_vlan_pcp *va = (struct ofp_action_vlan_pcp *)ah;
408 ds_put_format(string, "mod_vlan_pcp:%"PRIu8, va->vlan_pcp);
412 case OFPAT_STRIP_VLAN:
413 ds_put_cstr(string, "strip_vlan");
416 case OFPAT_SET_DL_SRC: {
417 struct ofp_action_dl_addr *da = (struct ofp_action_dl_addr *)ah;
418 ds_put_format(string, "mod_dl_src:"ETH_ADDR_FMT,
419 ETH_ADDR_ARGS(da->dl_addr));
423 case OFPAT_SET_DL_DST: {
424 struct ofp_action_dl_addr *da = (struct ofp_action_dl_addr *)ah;
425 ds_put_format(string, "mod_dl_dst:"ETH_ADDR_FMT,
426 ETH_ADDR_ARGS(da->dl_addr));
430 case OFPAT_SET_NW_SRC: {
431 struct ofp_action_nw_addr *na = (struct ofp_action_nw_addr *)ah;
432 ds_put_format(string, "mod_nw_src:"IP_FMT, IP_ARGS(&na->nw_addr));
436 case OFPAT_SET_NW_DST: {
437 struct ofp_action_nw_addr *na = (struct ofp_action_nw_addr *)ah;
438 ds_put_format(string, "mod_nw_dst:"IP_FMT, IP_ARGS(&na->nw_addr));
442 case OFPAT_SET_NW_TOS: {
443 struct ofp_action_nw_tos *nt = (struct ofp_action_nw_tos *)ah;
444 ds_put_format(string, "mod_nw_tos:%d", nt->nw_tos);
448 case OFPAT_SET_TP_SRC: {
449 struct ofp_action_tp_port *ta = (struct ofp_action_tp_port *)ah;
450 ds_put_format(string, "mod_tp_src:%d", ntohs(ta->tp_port));
454 case OFPAT_SET_TP_DST: {
455 struct ofp_action_tp_port *ta = (struct ofp_action_tp_port *)ah;
456 ds_put_format(string, "mod_tp_dst:%d", ntohs(ta->tp_port));
461 struct ofp_action_vendor_header *avh
462 = (struct ofp_action_vendor_header *)ah;
463 if (len < sizeof *avh) {
464 ds_put_format(string, "***ofpat_vendor truncated***\n");
467 if (avh->vendor == htonl(NX_VENDOR_ID)) {
468 ofp_print_nx_action(string, (struct nx_action_header *)avh);
470 ds_put_format(string, "vendor action:0x%x", ntohl(avh->vendor));
476 ds_put_format(string, "(decoder %d not implemented)", (int) type);
484 ofp_print_actions(struct ds *string, const struct ofp_action_header *action,
487 uint8_t *p = (uint8_t *)action;
490 ds_put_cstr(string, "actions=");
492 ds_put_cstr(string, "drop");
494 while (actions_len > 0) {
496 ds_put_cstr(string, ",");
498 len = ofp_print_action(string, (struct ofp_action_header *)p,
509 ofp_print_packet_out(struct ds *string, const struct ofp_packet_out *opo,
512 size_t len = ntohs(opo->header.length);
513 size_t actions_len = ntohs(opo->actions_len);
515 ds_put_cstr(string, " in_port=");
516 ofp_print_port_name(string, ntohs(opo->in_port));
518 ds_put_format(string, " actions_len=%zu ", actions_len);
519 if (actions_len > (ntohs(opo->header.length) - sizeof *opo)) {
520 ds_put_format(string, "***packet too short for action length***\n");
523 ofp_print_actions(string, opo->actions, actions_len);
525 if (ntohl(opo->buffer_id) == UINT32_MAX) {
526 int data_len = len - sizeof *opo - actions_len;
527 ds_put_format(string, " data_len=%d", data_len);
528 if (verbosity > 0 && len > sizeof *opo) {
529 char *packet = ofp_packet_to_string(
530 (uint8_t *)opo->actions + actions_len, data_len, data_len);
531 ds_put_char(string, '\n');
532 ds_put_cstr(string, packet);
536 ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(opo->buffer_id));
538 ds_put_char(string, '\n');
541 /* qsort comparison function. */
543 compare_ports(const void *a_, const void *b_)
545 const struct ofp_phy_port *a = a_;
546 const struct ofp_phy_port *b = b_;
547 uint16_t ap = ntohs(a->port_no);
548 uint16_t bp = ntohs(b->port_no);
550 return ap < bp ? -1 : ap > bp;
553 static void ofp_print_port_features(struct ds *string, uint32_t features)
556 ds_put_cstr(string, "Unsupported\n");
559 if (features & OFPPF_10MB_HD) {
560 ds_put_cstr(string, "10MB-HD ");
562 if (features & OFPPF_10MB_FD) {
563 ds_put_cstr(string, "10MB-FD ");
565 if (features & OFPPF_100MB_HD) {
566 ds_put_cstr(string, "100MB-HD ");
568 if (features & OFPPF_100MB_FD) {
569 ds_put_cstr(string, "100MB-FD ");
571 if (features & OFPPF_1GB_HD) {
572 ds_put_cstr(string, "1GB-HD ");
574 if (features & OFPPF_1GB_FD) {
575 ds_put_cstr(string, "1GB-FD ");
577 if (features & OFPPF_10GB_FD) {
578 ds_put_cstr(string, "10GB-FD ");
580 if (features & OFPPF_COPPER) {
581 ds_put_cstr(string, "COPPER ");
583 if (features & OFPPF_FIBER) {
584 ds_put_cstr(string, "FIBER ");
586 if (features & OFPPF_AUTONEG) {
587 ds_put_cstr(string, "AUTO_NEG ");
589 if (features & OFPPF_PAUSE) {
590 ds_put_cstr(string, "AUTO_PAUSE ");
592 if (features & OFPPF_PAUSE_ASYM) {
593 ds_put_cstr(string, "AUTO_PAUSE_ASYM ");
595 ds_put_char(string, '\n');
599 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
601 char name[OFP_MAX_PORT_NAME_LEN];
604 memcpy(name, port->name, sizeof name);
605 for (j = 0; j < sizeof name - 1; j++) {
606 if (!isprint(name[j])) {
612 ds_put_char(string, ' ');
613 ofp_print_port_name(string, ntohs(port->port_no));
614 ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT", config: %#x, state:%#x\n",
615 name, ETH_ADDR_ARGS(port->hw_addr), ntohl(port->config),
618 ds_put_format(string, " current: ");
619 ofp_print_port_features(string, ntohl(port->curr));
621 if (port->advertised) {
622 ds_put_format(string, " advertised: ");
623 ofp_print_port_features(string, ntohl(port->advertised));
625 if (port->supported) {
626 ds_put_format(string, " supported: ");
627 ofp_print_port_features(string, ntohl(port->supported));
630 ds_put_format(string, " peer: ");
631 ofp_print_port_features(string, ntohl(port->peer));
636 ofp_print_switch_features(struct ds *string,
637 const struct ofp_switch_features *osf)
639 size_t len = ntohs(osf->header.length);
640 struct ofp_phy_port *port_list;
644 ds_put_format(string, " ver:0x%x, dpid:%016"PRIx64"\n",
645 osf->header.version, ntohll(osf->datapath_id));
646 ds_put_format(string, "n_tables:%d, n_buffers:%d\n", osf->n_tables,
647 ntohl(osf->n_buffers));
648 ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
649 ntohl(osf->capabilities), ntohl(osf->actions));
651 n_ports = (len - sizeof *osf) / sizeof *osf->ports;
653 port_list = xmemdup(osf->ports, len - sizeof *osf);
654 qsort(port_list, n_ports, sizeof *port_list, compare_ports);
655 for (i = 0; i < n_ports; i++) {
656 ofp_print_phy_port(string, &port_list[i]);
662 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
666 flags = ntohs(osc->flags);
668 ds_put_cstr(string, " frags=");
669 switch (flags & OFPC_FRAG_MASK) {
670 case OFPC_FRAG_NORMAL:
671 ds_put_cstr(string, "normal");
672 flags &= ~OFPC_FRAG_MASK;
675 ds_put_cstr(string, "drop");
676 flags &= ~OFPC_FRAG_MASK;
678 case OFPC_FRAG_REASM:
679 ds_put_cstr(string, "reassemble");
680 flags &= ~OFPC_FRAG_MASK;
684 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
687 ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
690 static void print_wild(struct ds *string, const char *leader, int is_wild,
691 int verbosity, const char *format, ...)
692 __attribute__((format(printf, 5, 6)));
694 static void print_wild(struct ds *string, const char *leader, int is_wild,
695 int verbosity, const char *format, ...)
697 if (is_wild && verbosity < 2) {
700 ds_put_cstr(string, leader);
704 va_start(args, format);
705 ds_put_format_valist(string, format, args);
708 ds_put_char(string, '*');
710 ds_put_char(string, ',');
714 print_ip_netmask(struct ds *string, const char *leader, uint32_t ip,
715 uint32_t wild_bits, int verbosity)
717 if (wild_bits >= 32 && verbosity < 2) {
720 ds_put_cstr(string, leader);
721 if (wild_bits < 32) {
722 ds_put_format(string, IP_FMT, IP_ARGS(&ip));
724 ds_put_format(string, "/%d", 32 - wild_bits);
727 ds_put_char(string, '*');
729 ds_put_char(string, ',');
733 ofp_print_match(struct ds *f, const struct ofp_match *om, int verbosity)
735 char *s = ofp_match_to_string(om, verbosity);
741 ofp_match_to_string(const struct ofp_match *om, int verbosity)
743 struct ds f = DS_EMPTY_INITIALIZER;
744 uint32_t w = ntohl(om->wildcards);
745 bool skip_type = false;
746 bool skip_proto = false;
748 if (!(w & OFPFW_DL_TYPE)) {
750 if (om->dl_type == htons(ETH_TYPE_IP)) {
751 if (!(w & OFPFW_NW_PROTO)) {
753 if (om->nw_proto == IPPROTO_ICMP) {
754 ds_put_cstr(&f, "icmp,");
755 } else if (om->nw_proto == IPPROTO_TCP) {
756 ds_put_cstr(&f, "tcp,");
757 } else if (om->nw_proto == IPPROTO_UDP) {
758 ds_put_cstr(&f, "udp,");
760 ds_put_cstr(&f, "ip,");
764 ds_put_cstr(&f, "ip,");
766 } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
767 ds_put_cstr(&f, "arp,");
772 if (w & NXFW_TUN_ID) {
773 ds_put_cstr(&f, "tun_id_wild,");
775 print_wild(&f, "in_port=", w & OFPFW_IN_PORT, verbosity,
776 "%d", ntohs(om->in_port));
777 print_wild(&f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
778 "%d", ntohs(om->dl_vlan));
779 print_wild(&f, "dl_vlan_pcp=", w & OFPFW_DL_VLAN_PCP, verbosity,
780 "%d", om->dl_vlan_pcp);
781 print_wild(&f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
782 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
783 print_wild(&f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
784 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
786 print_wild(&f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
787 "0x%04x", ntohs(om->dl_type));
789 print_ip_netmask(&f, "nw_src=", om->nw_src,
790 (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
791 print_ip_netmask(&f, "nw_dst=", om->nw_dst,
792 (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
794 if (om->dl_type == htons(ETH_TYPE_ARP)) {
795 print_wild(&f, "opcode=", w & OFPFW_NW_PROTO, verbosity,
798 print_wild(&f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
802 print_wild(&f, "nw_tos=", w & OFPFW_NW_TOS, verbosity,
804 if (om->nw_proto == IPPROTO_ICMP) {
805 print_wild(&f, "icmp_type=", w & OFPFW_ICMP_TYPE, verbosity,
806 "%d", ntohs(om->icmp_type));
807 print_wild(&f, "icmp_code=", w & OFPFW_ICMP_CODE, verbosity,
808 "%d", ntohs(om->icmp_code));
810 print_wild(&f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
811 "%d", ntohs(om->tp_src));
812 print_wild(&f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
813 "%d", ntohs(om->tp_dst));
815 if (ds_last(&f) == ',') {
822 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh,
823 enum ofputil_msg_code code, int verbosity)
829 error = ofputil_decode_flow_mod(&fm, oh, NXFF_OPENFLOW10);
831 ofp_print_error(s, error);
836 switch (fm.command) {
838 ds_put_cstr(s, "ADD");
841 ds_put_cstr(s, "MOD");
843 case OFPFC_MODIFY_STRICT:
844 ds_put_cstr(s, "MOD_STRICT");
847 ds_put_cstr(s, "DEL");
849 case OFPFC_DELETE_STRICT:
850 ds_put_cstr(s, "DEL_STRICT");
853 ds_put_format(s, "cmd:%d", fm.command);
857 if (verbosity >= 3 && code == OFPUTIL_OFPT_FLOW_MOD) {
858 const struct ofp_flow_mod *ofm = (const struct ofp_flow_mod *) oh;
859 ofp_print_match(s, &ofm->match, verbosity);
861 /* ofp_print_match() doesn't print priority. */
862 need_priority = true;
863 } else if (verbosity >= 3 && code == OFPUTIL_NXT_FLOW_MOD) {
864 const struct nx_flow_mod *nfm = (const struct nx_flow_mod *) oh;
865 const void *nxm = nfm + 1;
868 nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
869 ds_put_cstr(s, nxm_s);
872 /* nx_match_to_string() doesn't print priority. */
873 need_priority = true;
875 cls_rule_format(&fm.cr, s);
877 /* cls_rule_format() does print priority. */
878 need_priority = false;
881 if (ds_last(s) != ' ') {
884 if (fm.cookie != htonll(0)) {
885 ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.cookie));
887 if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
888 ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
890 if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
891 ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
893 if (fm.cr.priority != OFP_DEFAULT_PRIORITY && need_priority) {
894 ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
896 if (fm.buffer_id != UINT32_MAX) {
897 ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
900 ds_put_format(s, "flags:0x%"PRIx16" ", fm.flags);
903 ofp_print_actions(s, (const struct ofp_action_header *) fm.actions,
904 fm.n_actions * sizeof *fm.actions);
908 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
910 ds_put_format(string, "%u", sec);
912 ds_put_format(string, ".%09u", nsec);
913 while (string->string[string->length - 1] == '0') {
917 ds_put_char(string, 's');
921 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
923 struct ofputil_flow_removed fr;
926 error = ofputil_decode_flow_removed(&fr, oh, NXFF_OPENFLOW10);
928 ofp_print_error(string, error);
932 ds_put_char(string, ' ');
933 cls_rule_format(&fr.rule, string);
935 ds_put_cstr(string, " reason=");
937 case OFPRR_IDLE_TIMEOUT:
938 ds_put_cstr(string, "idle");
940 case OFPRR_HARD_TIMEOUT:
941 ds_put_cstr(string, "hard");
944 ds_put_cstr(string, "delete");
947 ds_put_format(string, "**%"PRIu8"**", fr.reason);
951 if (fr.cookie != htonll(0)) {
952 ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
954 ds_put_cstr(string, " duration");
955 ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
956 ds_put_format(string, " idle%"PRIu16" pkts%"PRIu64" bytes%"PRIu64"\n",
957 fr.idle_timeout, fr.packet_count, fr.byte_count);
961 ofp_print_port_mod(struct ds *string, const struct ofp_port_mod *opm)
963 ds_put_format(string, "port: %d: addr:"ETH_ADDR_FMT", config: %#x, mask:%#x\n",
964 ntohs(opm->port_no), ETH_ADDR_ARGS(opm->hw_addr),
965 ntohl(opm->config), ntohl(opm->mask));
966 ds_put_format(string, " advertise: ");
967 if (opm->advertise) {
968 ofp_print_port_features(string, ntohl(opm->advertise));
970 ds_put_format(string, "UNCHANGED\n");
975 ofp_print_error(struct ds *string, int error)
977 if (string->length) {
978 ds_put_char(string, ' ');
980 ds_put_cstr(string, "***decode error: ");
981 ofputil_format_error(string, error);
982 ds_put_cstr(string, "***\n");
986 ofp_print_error_msg(struct ds *string, const struct ofp_error_msg *oem)
988 size_t len = ntohs(oem->header.length);
989 size_t payload_ofs, payload_len;
994 error = ofputil_decode_error_msg(&oem->header, &payload_ofs);
995 if (!is_ofp_error(error)) {
996 ofp_print_error(string, error);
997 ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
1001 ds_put_char(string, ' ');
1002 ofputil_format_error(string, error);
1003 ds_put_char(string, '\n');
1005 payload = (const uint8_t *) oem + payload_ofs;
1006 payload_len = len - payload_ofs;
1007 switch (get_ofp_err_type(error)) {
1008 case OFPET_HELLO_FAILED:
1009 ds_put_printable(string, payload, payload_len);
1012 case OFPET_BAD_REQUEST:
1013 s = ofp_to_string(payload, payload_len, 1);
1014 ds_put_cstr(string, s);
1019 ds_put_hex_dump(string, payload, payload_len, 0, true);
1025 ofp_print_port_status(struct ds *string, const struct ofp_port_status *ops)
1027 if (ops->reason == OFPPR_ADD) {
1028 ds_put_format(string, " ADD:");
1029 } else if (ops->reason == OFPPR_DELETE) {
1030 ds_put_format(string, " DEL:");
1031 } else if (ops->reason == OFPPR_MODIFY) {
1032 ds_put_format(string, " MOD:");
1035 ofp_print_phy_port(string, &ops->desc);
1039 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1041 const struct ofp_desc_stats *ods = ofputil_stats_body(oh);
1043 ds_put_char(string, '\n');
1044 ds_put_format(string, "Manufacturer: %.*s\n",
1045 (int) sizeof ods->mfr_desc, ods->mfr_desc);
1046 ds_put_format(string, "Hardware: %.*s\n",
1047 (int) sizeof ods->hw_desc, ods->hw_desc);
1048 ds_put_format(string, "Software: %.*s\n",
1049 (int) sizeof ods->sw_desc, ods->sw_desc);
1050 ds_put_format(string, "Serial Num: %.*s\n",
1051 (int) sizeof ods->serial_num, ods->serial_num);
1052 ds_put_format(string, "DP Description: %.*s\n",
1053 (int) sizeof ods->dp_desc, ods->dp_desc);
1057 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1059 struct flow_stats_request fsr;
1062 error = ofputil_decode_flow_stats_request(&fsr, oh, NXFF_OPENFLOW10);
1064 ofp_print_error(string, error);
1068 if (fsr.table_id != 0xff) {
1069 ds_put_format(string, " table_id=%"PRIu8, fsr.table_id);
1072 if (fsr.out_port != OFPP_NONE) {
1073 ds_put_cstr(string, " out_port=");
1074 ofp_print_port_name(string, fsr.out_port);
1077 /* A flow stats request doesn't include a priority, but cls_rule_format()
1078 * will print one unless it is OFP_DEFAULT_PRIORITY. */
1079 fsr.match.priority = OFP_DEFAULT_PRIORITY;
1081 ds_put_char(string, ' ');
1082 cls_rule_format(&fsr.match, string);
1086 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1090 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1092 struct ofputil_flow_stats fs;
1095 retval = ofputil_decode_flow_stats_reply(&fs, &b, NXFF_OPENFLOW10);
1097 if (retval != EOF) {
1098 ds_put_cstr(string, " ***parse error***");
1103 ds_put_char(string, '\n');
1105 ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1107 ofp_print_duration(string, fs.duration_sec, fs.duration_nsec);
1108 ds_put_format(string, ", table_id=%"PRIu8", ", fs.table_id);
1109 ds_put_format(string, "n_packets=%"PRIu64", ", fs.packet_count);
1110 ds_put_format(string, "n_bytes=%"PRIu64", ", fs.byte_count);
1111 if (fs.idle_timeout != OFP_FLOW_PERMANENT) {
1112 ds_put_format(string, "idle_timeout=%"PRIu16",", fs.idle_timeout);
1114 if (fs.hard_timeout != OFP_FLOW_PERMANENT) {
1115 ds_put_format(string, "hard_timeout=%"PRIu16",", fs.hard_timeout);
1118 cls_rule_format(&fs.rule, string);
1119 ds_put_char(string, ' ');
1120 ofp_print_actions(string,
1121 (const struct ofp_action_header *) fs.actions,
1122 fs.n_actions * sizeof *fs.actions);
1127 ofp_print_ofp_aggregate_stats_reply (
1128 struct ds *string, const struct ofp_aggregate_stats_reply *asr)
1130 ds_put_format(string, " packet_count=%"PRIu64,
1131 ntohll(get_32aligned_be64(&asr->packet_count)));
1132 ds_put_format(string, " byte_count=%"PRIu64,
1133 ntohll(get_32aligned_be64(&asr->byte_count)));
1134 ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
1138 ofp_print_ofpst_aggregate_reply(struct ds *string, const struct ofp_header *oh)
1140 ofp_print_ofp_aggregate_stats_reply(string, ofputil_stats_body(oh));
1144 ofp_print_nxst_aggregate_reply(struct ds *string,
1145 const struct nx_aggregate_stats_reply *nasr)
1147 ofp_print_ofp_aggregate_stats_reply(string, &nasr->asr);
1150 static void print_port_stat(struct ds *string, const char *leader,
1151 const ovs_32aligned_be64 *statp, int more)
1153 uint64_t stat = ntohll(get_32aligned_be64(statp));
1155 ds_put_cstr(string, leader);
1156 if (stat != UINT64_MAX) {
1157 ds_put_format(string, "%"PRIu64, stat);
1159 ds_put_char(string, '?');
1162 ds_put_cstr(string, ", ");
1164 ds_put_cstr(string, "\n");
1169 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1171 const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
1172 ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1176 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1179 const struct ofp_port_stats *ps = ofputil_stats_body(oh);
1180 size_t n = ofputil_stats_body_len(oh) / sizeof *ps;
1181 ds_put_format(string, " %zu ports\n", n);
1182 if (verbosity < 1) {
1187 ds_put_format(string, " port %2"PRIu16": ", ntohs(ps->port_no));
1189 ds_put_cstr(string, "rx ");
1190 print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1191 print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1192 print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1193 print_port_stat(string, "errs=", &ps->rx_errors, 1);
1194 print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1195 print_port_stat(string, "over=", &ps->rx_over_err, 1);
1196 print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1198 ds_put_cstr(string, " tx ");
1199 print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1200 print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1201 print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1202 print_port_stat(string, "errs=", &ps->tx_errors, 1);
1203 print_port_stat(string, "coll=", &ps->collisions, 0);
1208 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1211 const struct ofp_table_stats *ts = ofputil_stats_body(oh);
1212 size_t n = ofputil_stats_body_len(oh) / sizeof *ts;
1213 ds_put_format(string, " %zu tables\n", n);
1214 if (verbosity < 1) {
1219 char name[OFP_MAX_TABLE_NAME_LEN + 1];
1220 ovs_strlcpy(name, ts->name, sizeof name);
1222 ds_put_format(string, " %d: %-8s: ", ts->table_id, name);
1223 ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1224 ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1225 ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1226 ds_put_cstr(string, " ");
1227 ds_put_format(string, "lookup=%"PRIu64", ",
1228 ntohll(get_32aligned_be64(&ts->lookup_count)));
1229 ds_put_format(string, "matched=%"PRIu64"\n",
1230 ntohll(get_32aligned_be64(&ts->matched_count)));
1235 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1237 if (queue_id == OFPQ_ALL) {
1238 ds_put_cstr(string, "ALL");
1240 ds_put_format(string, "%"PRIu32, queue_id);
1245 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1247 const struct ofp_queue_stats_request *qsr = ofputil_stats_body(oh);
1249 ds_put_cstr(string, "port=");
1250 ofp_print_port_name(string, ntohs(qsr->port_no));
1252 ds_put_cstr(string, " queue=");
1253 ofp_print_queue_name(string, ntohl(qsr->queue_id));
1257 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
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) {
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, ": ");
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);
1281 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1283 const struct ofp_stats_request *srq
1284 = (const struct ofp_stats_request *) oh;
1287 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
1293 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1295 const struct ofp_stats_reply *srp = (const struct ofp_stats_reply *) oh;
1298 uint16_t flags = ntohs(srp->flags);
1300 ds_put_cstr(string, " flags=");
1301 if (flags & OFPSF_REPLY_MORE) {
1302 ds_put_cstr(string, "[more]");
1303 flags &= ~OFPSF_REPLY_MORE;
1306 ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1313 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1315 size_t len = ntohs(oh->length);
1317 ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1318 if (verbosity > 1) {
1319 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1324 ofp_print_nxt_status_message(struct ds *string, const struct ofp_header *oh)
1328 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1329 ofpbuf_pull(&b, sizeof(struct nicira_header));
1330 ds_put_cstr(string, " \"");
1331 ds_put_printable(string, b.data, b.size);
1332 ds_put_char(string, '"');
1336 ofp_print_nxt_tun_id_from_cookie(struct ds *string,
1337 const struct nxt_tun_id_cookie *ntic)
1339 ds_put_format(string, " set=%"PRIu8, ntic->set);
1343 ofp_print_nxt_role_message(struct ds *string,
1344 const struct nx_role_request *nrr)
1346 unsigned int role = ntohl(nrr->role);
1348 ds_put_cstr(string, " role=");
1349 if (role == NX_ROLE_OTHER) {
1350 ds_put_cstr(string, "other");
1351 } else if (role == NX_ROLE_MASTER) {
1352 ds_put_cstr(string, "master");
1353 } else if (role == NX_ROLE_SLAVE) {
1354 ds_put_cstr(string, "slave");
1356 ds_put_format(string, "%u", role);
1361 ofp_print_nxt_set_flow_format(struct ds *string,
1362 const struct nxt_set_flow_format *nsff)
1364 uint32_t format = ntohl(nsff->format);
1366 ds_put_cstr(string, " format=");
1367 if (ofputil_flow_format_is_valid(format)) {
1368 ds_put_cstr(string, ofputil_flow_format_to_string(format));
1370 ds_put_format(string, "%"PRIu32, format);
1375 ofp_to_string__(const struct ofp_header *oh,
1376 const struct ofputil_msg_type *type, struct ds *string,
1379 enum ofputil_msg_code code;
1380 const void *msg = oh;
1382 ds_put_format(string, "%s (xid=0x%"PRIx32"):",
1383 ofputil_msg_type_name(type), ntohl(oh->xid));
1385 code = ofputil_msg_type_code(type);
1387 case OFPUTIL_INVALID:
1390 case OFPUTIL_OFPT_HELLO:
1391 ds_put_char(string, '\n');
1392 ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1396 case OFPUTIL_OFPT_ERROR:
1397 ofp_print_error_msg(string, msg);
1400 case OFPUTIL_OFPT_ECHO_REQUEST:
1401 case OFPUTIL_OFPT_ECHO_REPLY:
1402 ofp_print_echo(string, oh, verbosity);
1405 case OFPUTIL_OFPT_FEATURES_REQUEST:
1408 case OFPUTIL_OFPT_FEATURES_REPLY:
1409 ofp_print_switch_features(string, msg);
1412 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
1415 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
1416 case OFPUTIL_OFPT_SET_CONFIG:
1417 ofp_print_switch_config(string, msg);
1420 case OFPUTIL_OFPT_PACKET_IN:
1421 ofp_print_packet_in(string, msg, verbosity);
1424 case OFPUTIL_OFPT_FLOW_REMOVED:
1425 case OFPUTIL_NXT_FLOW_REMOVED:
1426 ofp_print_flow_removed(string, msg);
1429 case OFPUTIL_OFPT_PORT_STATUS:
1430 ofp_print_port_status(string, msg);
1433 case OFPUTIL_OFPT_PACKET_OUT:
1434 ofp_print_packet_out(string, msg, verbosity);
1437 case OFPUTIL_OFPT_FLOW_MOD:
1438 ofp_print_flow_mod(string, msg, code, verbosity);
1441 case OFPUTIL_OFPT_PORT_MOD:
1442 ofp_print_port_mod(string, msg);
1445 case OFPUTIL_OFPT_BARRIER_REQUEST:
1446 case OFPUTIL_OFPT_BARRIER_REPLY:
1449 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
1450 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
1454 case OFPUTIL_OFPST_DESC_REQUEST:
1455 ofp_print_stats_request(string, oh);
1458 case OFPUTIL_OFPST_FLOW_REQUEST:
1459 case OFPUTIL_NXST_FLOW_REQUEST:
1460 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1461 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1462 ofp_print_stats_request(string, oh);
1463 ofp_print_flow_stats_request(string, oh);
1466 case OFPUTIL_OFPST_TABLE_REQUEST:
1467 ofp_print_stats_request(string, oh);
1470 case OFPUTIL_OFPST_PORT_REQUEST:
1471 ofp_print_stats_request(string, oh);
1472 ofp_print_ofpst_port_request(string, oh);
1475 case OFPUTIL_OFPST_QUEUE_REQUEST:
1476 ofp_print_stats_request(string, oh);
1477 ofp_print_ofpst_queue_request(string, oh);
1480 case OFPUTIL_OFPST_DESC_REPLY:
1481 ofp_print_stats_reply(string, oh);
1482 ofp_print_ofpst_desc_reply(string, oh);
1485 case OFPUTIL_OFPST_FLOW_REPLY:
1486 case OFPUTIL_NXST_FLOW_REPLY:
1487 ofp_print_stats_reply(string, oh);
1488 ofp_print_flow_stats_reply(string, oh);
1491 case OFPUTIL_OFPST_QUEUE_REPLY:
1492 ofp_print_stats_reply(string, oh);
1493 ofp_print_ofpst_queue_reply(string, oh, verbosity);
1496 case OFPUTIL_OFPST_PORT_REPLY:
1497 ofp_print_stats_reply(string, oh);
1498 ofp_print_ofpst_port_reply(string, oh, verbosity);
1501 case OFPUTIL_OFPST_TABLE_REPLY:
1502 ofp_print_stats_reply(string, oh);
1503 ofp_print_ofpst_table_reply(string, oh, verbosity);
1506 case OFPUTIL_OFPST_AGGREGATE_REPLY:
1507 ofp_print_stats_reply(string, oh);
1508 ofp_print_ofpst_aggregate_reply(string, oh);
1511 case OFPUTIL_NXT_STATUS_REQUEST:
1512 case OFPUTIL_NXT_STATUS_REPLY:
1513 ofp_print_nxt_status_message(string, oh);
1516 case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
1517 ofp_print_nxt_tun_id_from_cookie(string, msg);
1520 case OFPUTIL_NXT_ROLE_REQUEST:
1521 case OFPUTIL_NXT_ROLE_REPLY:
1522 ofp_print_nxt_role_message(string, msg);
1525 case OFPUTIL_NXT_SET_FLOW_FORMAT:
1526 ofp_print_nxt_set_flow_format(string, msg);
1529 case OFPUTIL_NXT_FLOW_MOD:
1530 ofp_print_flow_mod(string, msg, code, verbosity);
1533 case OFPUTIL_NXST_AGGREGATE_REPLY:
1534 ofp_print_stats_reply(string, oh);
1535 ofp_print_nxst_aggregate_reply(string, msg);
1540 /* Composes and returns a string representing the OpenFlow packet of 'len'
1541 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
1542 * verbosity and higher numbers increase verbosity. The caller is responsible
1543 * for freeing the string. */
1545 ofp_to_string(const void *oh_, size_t len, int verbosity)
1547 struct ds string = DS_EMPTY_INITIALIZER;
1548 const struct ofp_header *oh = oh_;
1551 ds_put_cstr(&string, "OpenFlow message is empty\n");
1552 } else if (len < sizeof(struct ofp_header)) {
1553 ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1555 } else if (oh->version != OFP_VERSION) {
1556 ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n",
1558 } else if (ntohs(oh->length) > len) {
1559 ds_put_format(&string,
1560 "(***truncated to %zu bytes from %"PRIu16"***)\n",
1561 len, ntohs(oh->length));
1562 } else if (ntohs(oh->length) < len) {
1563 ds_put_format(&string,
1564 "(***only uses %"PRIu16" bytes out of %zu***)\n",
1565 ntohs(oh->length), len);
1567 const struct ofputil_msg_type *type;
1570 error = ofputil_decode_msg_type(oh, &type);
1572 ofp_to_string__(oh, type, &string, verbosity);
1573 if (verbosity >= 5) {
1574 if (ds_last(&string) != '\n') {
1575 ds_put_char(&string, '\n');
1577 ds_put_hex_dump(&string, oh, len, 0, true);
1579 if (ds_last(&string) != '\n') {
1580 ds_put_char(&string, '\n');
1582 return ds_steal_cstr(&string);
1585 ofp_print_error(&string, error);
1587 ds_put_hex_dump(&string, oh, len, 0, true);
1588 return ds_steal_cstr(&string);
1591 /* Returns the name for the specified OpenFlow message type as a string,
1592 * e.g. "OFPT_FEATURES_REPLY". If no name is known, the string returned is a
1593 * hex number, e.g. "0x55".
1595 * The caller must free the returned string when it is no longer needed. */
1597 ofp_message_type_to_string(uint8_t type)
1608 case OFPT_ECHO_REQUEST:
1609 name = "ECHO_REQUEST";
1611 case OFPT_ECHO_REPLY:
1612 name = "ECHO_REPLY";
1617 case OFPT_FEATURES_REQUEST:
1618 name = "FEATURES_REQUEST";
1620 case OFPT_FEATURES_REPLY:
1621 name = "FEATURES_REPLY";
1623 case OFPT_GET_CONFIG_REQUEST:
1624 name = "GET_CONFIG_REQUEST";
1626 case OFPT_GET_CONFIG_REPLY:
1627 name = "GET_CONFIG_REPLY";
1629 case OFPT_SET_CONFIG:
1630 name = "SET_CONFIG";
1632 case OFPT_PACKET_IN:
1635 case OFPT_FLOW_REMOVED:
1636 name = "FLOW_REMOVED";
1638 case OFPT_PORT_STATUS:
1639 name = "PORT_STATUS";
1641 case OFPT_PACKET_OUT:
1642 name = "PACKET_OUT";
1650 case OFPT_STATS_REQUEST:
1651 name = "STATS_REQUEST";
1653 case OFPT_STATS_REPLY:
1654 name = "STATS_REPLY";
1656 case OFPT_BARRIER_REQUEST:
1657 name = "BARRIER_REQUEST";
1659 case OFPT_BARRIER_REPLY:
1660 name = "BARRIER_REPLY";
1662 case OFPT_QUEUE_GET_CONFIG_REQUEST:
1663 name = "QUEUE_GET_CONFIG_REQUEST";
1665 case OFPT_QUEUE_GET_CONFIG_REPLY:
1666 name = "QUEUE_GET_CONFIG_REPLY";
1673 return name ? xasprintf("OFPT_%s", name) : xasprintf("0x%02"PRIx8, type);
1677 print_and_free(FILE *stream, char *string)
1679 fputs(string, stream);
1683 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1684 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
1685 * numbers increase verbosity. */
1687 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1689 print_and_free(stream, ofp_to_string(oh, len, verbosity));
1692 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1693 * 'data' to 'stream' using tcpdump. 'total_len' specifies the full length of
1694 * the Ethernet frame (of which 'len' bytes were captured).
1696 * This starts and kills a tcpdump subprocess so it's quite expensive. */
1698 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1700 print_and_free(stream, ofp_packet_to_string(data, len, total_len));