2 * Copyright (c) 2008, 2009, 2010 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"
36 #include "openflow/openflow.h"
37 #include "openflow/nicira-ext.h"
42 static void ofp_print_port_name(struct ds *string, uint16_t port);
43 static void ofp_print_queue_name(struct ds *string, uint32_t port);
44 static void ofp_print_error(struct ds *, int error);
47 /* Returns a string that represents the contents of the Ethernet frame in the
48 * 'len' bytes starting at 'data' to 'stream' as output by tcpdump.
49 * 'total_len' specifies the full length of the Ethernet frame (of which 'len'
50 * bytes were captured).
52 * The caller must free the returned string.
54 * This starts and kills a tcpdump subprocess so it's quite expensive. */
56 ofp_packet_to_string(const void *data, size_t len, size_t total_len OVS_UNUSED)
58 struct ds ds = DS_EMPTY_INITIALIZER;
67 ofpbuf_use_const(&buf, data, len);
71 ovs_error(errno, "tmpfile");
72 return xstrdup("<error>");
74 pcap_write_header(pcap);
75 pcap_write(pcap, &buf);
78 ovs_error(errno, "error writing temporary file");
82 snprintf(command, sizeof command, "/usr/sbin/tcpdump -e -n -r /dev/fd/%d 2>/dev/null",
84 tcpdump = popen(command, "r");
87 ovs_error(errno, "exec(\"%s\")", command);
88 return xstrdup("<error>");
91 while ((c = getc(tcpdump)) != EOF) {
95 status = pclose(tcpdump);
96 if (WIFEXITED(status)) {
97 if (WEXITSTATUS(status))
98 ovs_error(0, "tcpdump exited with status %d", WEXITSTATUS(status));
99 } else if (WIFSIGNALED(status)) {
100 ovs_error(0, "tcpdump exited with signal %d", WTERMSIG(status));
106 ofp_print_packet_in(struct ds *string, const struct ofp_packet_in *op,
109 size_t len = ntohs(op->header.length);
112 ds_put_format(string, " total_len=%"PRIu16" in_port=",
113 ntohs(op->total_len));
114 ofp_print_port_name(string, ntohs(op->in_port));
116 if (op->reason == OFPR_ACTION)
117 ds_put_cstr(string, " (via action)");
118 else if (op->reason != OFPR_NO_MATCH)
119 ds_put_format(string, " (***reason %"PRIu8"***)", op->reason);
121 data_len = len - offsetof(struct ofp_packet_in, data);
122 ds_put_format(string, " data_len=%zu", data_len);
123 if (htonl(op->buffer_id) == UINT32_MAX) {
124 ds_put_format(string, " (unbuffered)");
125 if (ntohs(op->total_len) != data_len)
126 ds_put_format(string, " (***total_len != data_len***)");
128 ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(op->buffer_id));
129 if (ntohs(op->total_len) < data_len)
130 ds_put_format(string, " (***total_len < data_len***)");
132 ds_put_char(string, '\n');
136 struct ofpbuf packet;
138 ofpbuf_use_const(&packet, op->data, data_len);
139 flow_extract(&packet, 0, ntohs(op->in_port), &flow);
140 flow_format(string, &flow);
141 ds_put_char(string, '\n');
144 char *packet = ofp_packet_to_string(op->data, data_len,
145 ntohs(op->total_len));
146 ds_put_cstr(string, packet);
151 static void ofp_print_port_name(struct ds *string, uint16_t port)
170 case OFPP_CONTROLLER:
180 ds_put_format(string, "%"PRIu16, port);
183 ds_put_cstr(string, name);
187 print_note(struct ds *string, const struct nx_action_note *nan)
192 ds_put_cstr(string, "note:");
193 len = ntohs(nan->len) - offsetof(struct nx_action_note, note);
194 for (i = 0; i < len; i++) {
196 ds_put_char(string, '.');
198 ds_put_format(string, "%02"PRIx8, nan->note[i]);
203 ofp_print_nx_action(struct ds *string, const struct nx_action_header *nah)
205 switch (ntohs(nah->subtype)) {
206 case NXAST_RESUBMIT: {
207 const struct nx_action_resubmit *nar = (struct nx_action_resubmit *)nah;
208 ds_put_format(string, "resubmit:");
209 ofp_print_port_name(string, ntohs(nar->in_port));
213 case NXAST_SET_TUNNEL: {
214 const struct nx_action_set_tunnel *nast =
215 (struct nx_action_set_tunnel *)nah;
216 ds_put_format(string, "set_tunnel:%#"PRIx32, ntohl(nast->tun_id));
220 case NXAST_DROP_SPOOFED_ARP:
221 ds_put_cstr(string, "drop_spoofed_arp");
224 case NXAST_SET_QUEUE: {
225 const struct nx_action_set_queue *nasq =
226 (struct nx_action_set_queue *)nah;
227 ds_put_format(string, "set_queue:%u", ntohl(nasq->queue_id));
231 case NXAST_POP_QUEUE:
232 ds_put_cstr(string, "pop_queue");
236 print_note(string, (const struct nx_action_note *) nah);
240 ds_put_format(string, "***unknown Nicira action:%d***",
241 ntohs(nah->subtype));
246 ofp_print_action(struct ds *string, const struct ofp_action_header *ah,
252 struct openflow_action {
257 const struct openflow_action of_actions[] = {
259 sizeof(struct ofp_action_output),
260 sizeof(struct ofp_action_output),
262 [OFPAT_SET_VLAN_VID] = {
263 sizeof(struct ofp_action_vlan_vid),
264 sizeof(struct ofp_action_vlan_vid),
266 [OFPAT_SET_VLAN_PCP] = {
267 sizeof(struct ofp_action_vlan_pcp),
268 sizeof(struct ofp_action_vlan_pcp),
270 [OFPAT_STRIP_VLAN] = {
271 sizeof(struct ofp_action_header),
272 sizeof(struct ofp_action_header),
274 [OFPAT_SET_DL_SRC] = {
275 sizeof(struct ofp_action_dl_addr),
276 sizeof(struct ofp_action_dl_addr),
278 [OFPAT_SET_DL_DST] = {
279 sizeof(struct ofp_action_dl_addr),
280 sizeof(struct ofp_action_dl_addr),
282 [OFPAT_SET_NW_SRC] = {
283 sizeof(struct ofp_action_nw_addr),
284 sizeof(struct ofp_action_nw_addr),
286 [OFPAT_SET_NW_DST] = {
287 sizeof(struct ofp_action_nw_addr),
288 sizeof(struct ofp_action_nw_addr),
290 [OFPAT_SET_NW_TOS] = {
291 sizeof(struct ofp_action_nw_tos),
292 sizeof(struct ofp_action_nw_tos),
294 [OFPAT_SET_TP_SRC] = {
295 sizeof(struct ofp_action_tp_port),
296 sizeof(struct ofp_action_tp_port),
298 [OFPAT_SET_TP_DST] = {
299 sizeof(struct ofp_action_tp_port),
300 sizeof(struct ofp_action_tp_port),
303 sizeof(struct ofp_action_enqueue),
304 sizeof(struct ofp_action_enqueue),
306 /* OFPAT_VENDOR is not here, since it would blow up the array size. */
309 if (actions_len < sizeof *ah) {
310 ds_put_format(string, "***action array too short for next action***\n");
314 type = ntohs(ah->type);
315 len = ntohs(ah->len);
316 if (actions_len < len) {
317 ds_put_format(string, "***truncated action %"PRIu16"***\n", type);
322 ds_put_format(string, "***zero-length action***\n");
326 if ((len % OFP_ACTION_ALIGN) != 0) {
327 ds_put_format(string,
328 "***action %"PRIu16" length not a multiple of %d***\n",
329 type, OFP_ACTION_ALIGN);
333 if (type < ARRAY_SIZE(of_actions)) {
334 const struct openflow_action *act = &of_actions[type];
335 if ((len < act->min_size) || (len > act->max_size)) {
336 ds_put_format(string,
337 "***action %"PRIu16" wrong length: %zu***\n", type, len);
344 struct ofp_action_output *oa = (struct ofp_action_output *)ah;
345 uint16_t port = ntohs(oa->port);
346 if (port < OFPP_MAX) {
347 ds_put_format(string, "output:%"PRIu16, port);
349 ofp_print_port_name(string, port);
350 if (port == OFPP_CONTROLLER) {
352 ds_put_format(string, ":%"PRIu16, ntohs(oa->max_len));
354 ds_put_cstr(string, ":all");
361 case OFPAT_ENQUEUE: {
362 struct ofp_action_enqueue *ea = (struct ofp_action_enqueue *)ah;
363 unsigned int port = ntohs(ea->port);
364 unsigned int queue_id = ntohl(ea->queue_id);
365 ds_put_format(string, "enqueue:");
366 if (port != OFPP_IN_PORT) {
367 ds_put_format(string, "%u", port);
369 ds_put_cstr(string, "IN_PORT");
371 ds_put_format(string, "q%u", queue_id);
375 case OFPAT_SET_VLAN_VID: {
376 struct ofp_action_vlan_vid *va = (struct ofp_action_vlan_vid *)ah;
377 ds_put_format(string, "mod_vlan_vid:%"PRIu16, ntohs(va->vlan_vid));
381 case OFPAT_SET_VLAN_PCP: {
382 struct ofp_action_vlan_pcp *va = (struct ofp_action_vlan_pcp *)ah;
383 ds_put_format(string, "mod_vlan_pcp:%"PRIu8, va->vlan_pcp);
387 case OFPAT_STRIP_VLAN:
388 ds_put_cstr(string, "strip_vlan");
391 case OFPAT_SET_DL_SRC: {
392 struct ofp_action_dl_addr *da = (struct ofp_action_dl_addr *)ah;
393 ds_put_format(string, "mod_dl_src:"ETH_ADDR_FMT,
394 ETH_ADDR_ARGS(da->dl_addr));
398 case OFPAT_SET_DL_DST: {
399 struct ofp_action_dl_addr *da = (struct ofp_action_dl_addr *)ah;
400 ds_put_format(string, "mod_dl_dst:"ETH_ADDR_FMT,
401 ETH_ADDR_ARGS(da->dl_addr));
405 case OFPAT_SET_NW_SRC: {
406 struct ofp_action_nw_addr *na = (struct ofp_action_nw_addr *)ah;
407 ds_put_format(string, "mod_nw_src:"IP_FMT, IP_ARGS(&na->nw_addr));
411 case OFPAT_SET_NW_DST: {
412 struct ofp_action_nw_addr *na = (struct ofp_action_nw_addr *)ah;
413 ds_put_format(string, "mod_nw_dst:"IP_FMT, IP_ARGS(&na->nw_addr));
417 case OFPAT_SET_NW_TOS: {
418 struct ofp_action_nw_tos *nt = (struct ofp_action_nw_tos *)ah;
419 ds_put_format(string, "mod_nw_tos:%d", nt->nw_tos);
423 case OFPAT_SET_TP_SRC: {
424 struct ofp_action_tp_port *ta = (struct ofp_action_tp_port *)ah;
425 ds_put_format(string, "mod_tp_src:%d", ntohs(ta->tp_port));
429 case OFPAT_SET_TP_DST: {
430 struct ofp_action_tp_port *ta = (struct ofp_action_tp_port *)ah;
431 ds_put_format(string, "mod_tp_dst:%d", ntohs(ta->tp_port));
436 struct ofp_action_vendor_header *avh
437 = (struct ofp_action_vendor_header *)ah;
438 if (len < sizeof *avh) {
439 ds_put_format(string, "***ofpat_vendor truncated***\n");
442 if (avh->vendor == htonl(NX_VENDOR_ID)) {
443 ofp_print_nx_action(string, (struct nx_action_header *)avh);
445 ds_put_format(string, "vendor action:0x%x", ntohl(avh->vendor));
451 ds_put_format(string, "(decoder %"PRIu16" not implemented)", type);
459 ofp_print_actions(struct ds *string, const struct ofp_action_header *action,
462 uint8_t *p = (uint8_t *)action;
465 ds_put_cstr(string, "actions=");
467 ds_put_cstr(string, "drop");
469 while (actions_len > 0) {
471 ds_put_cstr(string, ",");
473 len = ofp_print_action(string, (struct ofp_action_header *)p,
484 ofp_print_packet_out(struct ds *string, const struct ofp_packet_out *opo,
487 size_t len = ntohs(opo->header.length);
488 size_t actions_len = ntohs(opo->actions_len);
490 ds_put_cstr(string, " in_port=");
491 ofp_print_port_name(string, ntohs(opo->in_port));
493 ds_put_format(string, " actions_len=%zu ", actions_len);
494 if (actions_len > (ntohs(opo->header.length) - sizeof *opo)) {
495 ds_put_format(string, "***packet too short for action length***\n");
498 ofp_print_actions(string, opo->actions, actions_len);
500 if (ntohl(opo->buffer_id) == UINT32_MAX) {
501 int data_len = len - sizeof *opo - actions_len;
502 ds_put_format(string, " data_len=%d", data_len);
503 if (verbosity > 0 && len > sizeof *opo) {
504 char *packet = ofp_packet_to_string(
505 (uint8_t *)opo->actions + actions_len, data_len, data_len);
506 ds_put_char(string, '\n');
507 ds_put_cstr(string, packet);
511 ds_put_format(string, " buffer=0x%08"PRIx32, ntohl(opo->buffer_id));
513 ds_put_char(string, '\n');
516 /* qsort comparison function. */
518 compare_ports(const void *a_, const void *b_)
520 const struct ofp_phy_port *a = a_;
521 const struct ofp_phy_port *b = b_;
522 uint16_t ap = ntohs(a->port_no);
523 uint16_t bp = ntohs(b->port_no);
525 return ap < bp ? -1 : ap > bp;
528 static void ofp_print_port_features(struct ds *string, uint32_t features)
531 ds_put_cstr(string, "Unsupported\n");
534 if (features & OFPPF_10MB_HD) {
535 ds_put_cstr(string, "10MB-HD ");
537 if (features & OFPPF_10MB_FD) {
538 ds_put_cstr(string, "10MB-FD ");
540 if (features & OFPPF_100MB_HD) {
541 ds_put_cstr(string, "100MB-HD ");
543 if (features & OFPPF_100MB_FD) {
544 ds_put_cstr(string, "100MB-FD ");
546 if (features & OFPPF_1GB_HD) {
547 ds_put_cstr(string, "1GB-HD ");
549 if (features & OFPPF_1GB_FD) {
550 ds_put_cstr(string, "1GB-FD ");
552 if (features & OFPPF_10GB_FD) {
553 ds_put_cstr(string, "10GB-FD ");
555 if (features & OFPPF_COPPER) {
556 ds_put_cstr(string, "COPPER ");
558 if (features & OFPPF_FIBER) {
559 ds_put_cstr(string, "FIBER ");
561 if (features & OFPPF_AUTONEG) {
562 ds_put_cstr(string, "AUTO_NEG ");
564 if (features & OFPPF_PAUSE) {
565 ds_put_cstr(string, "AUTO_PAUSE ");
567 if (features & OFPPF_PAUSE_ASYM) {
568 ds_put_cstr(string, "AUTO_PAUSE_ASYM ");
570 ds_put_char(string, '\n');
574 ofp_print_phy_port(struct ds *string, const struct ofp_phy_port *port)
576 char name[OFP_MAX_PORT_NAME_LEN];
579 memcpy(name, port->name, sizeof name);
580 for (j = 0; j < sizeof name - 1; j++) {
581 if (!isprint(name[j])) {
587 ds_put_char(string, ' ');
588 ofp_print_port_name(string, ntohs(port->port_no));
589 ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT", config: %#x, state:%#x\n",
590 name, ETH_ADDR_ARGS(port->hw_addr), ntohl(port->config),
593 ds_put_format(string, " current: ");
594 ofp_print_port_features(string, ntohl(port->curr));
596 if (port->advertised) {
597 ds_put_format(string, " advertised: ");
598 ofp_print_port_features(string, ntohl(port->advertised));
600 if (port->supported) {
601 ds_put_format(string, " supported: ");
602 ofp_print_port_features(string, ntohl(port->supported));
605 ds_put_format(string, " peer: ");
606 ofp_print_port_features(string, ntohl(port->peer));
611 ofp_print_switch_features(struct ds *string,
612 const struct ofp_switch_features *osf)
614 size_t len = ntohs(osf->header.length);
615 struct ofp_phy_port *port_list;
619 ds_put_format(string, " ver:0x%x, dpid:%016"PRIx64"\n",
620 osf->header.version, ntohll(osf->datapath_id));
621 ds_put_format(string, "n_tables:%d, n_buffers:%d\n", osf->n_tables,
622 ntohl(osf->n_buffers));
623 ds_put_format(string, "features: capabilities:%#x, actions:%#x\n",
624 ntohl(osf->capabilities), ntohl(osf->actions));
626 n_ports = (len - sizeof *osf) / sizeof *osf->ports;
628 port_list = xmemdup(osf->ports, len - sizeof *osf);
629 qsort(port_list, n_ports, sizeof *port_list, compare_ports);
630 for (i = 0; i < n_ports; i++) {
631 ofp_print_phy_port(string, &port_list[i]);
637 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
641 flags = ntohs(osc->flags);
643 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
646 ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
649 static void print_wild(struct ds *string, const char *leader, int is_wild,
650 int verbosity, const char *format, ...)
651 __attribute__((format(printf, 5, 6)));
653 static void print_wild(struct ds *string, const char *leader, int is_wild,
654 int verbosity, const char *format, ...)
656 if (is_wild && verbosity < 2) {
659 ds_put_cstr(string, leader);
663 va_start(args, format);
664 ds_put_format_valist(string, format, args);
667 ds_put_char(string, '*');
669 ds_put_char(string, ',');
673 print_ip_netmask(struct ds *string, const char *leader, uint32_t ip,
674 uint32_t wild_bits, int verbosity)
676 if (wild_bits >= 32 && verbosity < 2) {
679 ds_put_cstr(string, leader);
680 if (wild_bits < 32) {
681 ds_put_format(string, IP_FMT, IP_ARGS(&ip));
683 ds_put_format(string, "/%d", 32 - wild_bits);
686 ds_put_char(string, '*');
688 ds_put_char(string, ',');
692 ofp_print_match(struct ds *f, const struct ofp_match *om, int verbosity)
694 char *s = ofp_match_to_string(om, verbosity);
700 ofp_match_to_string(const struct ofp_match *om, int verbosity)
702 struct ds f = DS_EMPTY_INITIALIZER;
703 uint32_t w = ntohl(om->wildcards);
704 bool skip_type = false;
705 bool skip_proto = false;
707 if (!(w & OFPFW_DL_TYPE)) {
709 if (om->dl_type == htons(ETH_TYPE_IP)) {
710 if (!(w & OFPFW_NW_PROTO)) {
712 if (om->nw_proto == IP_TYPE_ICMP) {
713 ds_put_cstr(&f, "icmp,");
714 } else if (om->nw_proto == IP_TYPE_TCP) {
715 ds_put_cstr(&f, "tcp,");
716 } else if (om->nw_proto == IP_TYPE_UDP) {
717 ds_put_cstr(&f, "udp,");
719 ds_put_cstr(&f, "ip,");
723 ds_put_cstr(&f, "ip,");
725 } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
726 ds_put_cstr(&f, "arp,");
731 if (w & NXFW_TUN_ID) {
732 ds_put_cstr(&f, "tun_id_wild,");
734 print_wild(&f, "in_port=", w & OFPFW_IN_PORT, verbosity,
735 "%d", ntohs(om->in_port));
736 print_wild(&f, "dl_vlan=", w & OFPFW_DL_VLAN, verbosity,
737 "%d", ntohs(om->dl_vlan));
738 print_wild(&f, "dl_vlan_pcp=", w & OFPFW_DL_VLAN_PCP, verbosity,
739 "%d", om->dl_vlan_pcp);
740 print_wild(&f, "dl_src=", w & OFPFW_DL_SRC, verbosity,
741 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
742 print_wild(&f, "dl_dst=", w & OFPFW_DL_DST, verbosity,
743 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
745 print_wild(&f, "dl_type=", w & OFPFW_DL_TYPE, verbosity,
746 "0x%04x", ntohs(om->dl_type));
748 print_ip_netmask(&f, "nw_src=", om->nw_src,
749 (w & OFPFW_NW_SRC_MASK) >> OFPFW_NW_SRC_SHIFT, verbosity);
750 print_ip_netmask(&f, "nw_dst=", om->nw_dst,
751 (w & OFPFW_NW_DST_MASK) >> OFPFW_NW_DST_SHIFT, verbosity);
753 if (om->dl_type == htons(ETH_TYPE_ARP)) {
754 print_wild(&f, "opcode=", w & OFPFW_NW_PROTO, verbosity,
757 print_wild(&f, "nw_proto=", w & OFPFW_NW_PROTO, verbosity,
761 print_wild(&f, "nw_tos=", w & OFPFW_NW_TOS, verbosity,
763 if (om->nw_proto == IP_TYPE_ICMP) {
764 print_wild(&f, "icmp_type=", w & OFPFW_ICMP_TYPE, verbosity,
765 "%d", ntohs(om->icmp_type));
766 print_wild(&f, "icmp_code=", w & OFPFW_ICMP_CODE, verbosity,
767 "%d", ntohs(om->icmp_code));
769 print_wild(&f, "tp_src=", w & OFPFW_TP_SRC, verbosity,
770 "%d", ntohs(om->tp_src));
771 print_wild(&f, "tp_dst=", w & OFPFW_TP_DST, verbosity,
772 "%d", ntohs(om->tp_dst));
774 if (ds_last(&f) == ',') {
781 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh,
782 enum ofputil_msg_code code, int verbosity)
787 error = ofputil_decode_flow_mod(&fm, oh, NXFF_OPENFLOW10);
789 ofp_print_error(s, error);
794 switch (fm.command) {
796 ds_put_cstr(s, "ADD");
799 ds_put_cstr(s, "MOD");
801 case OFPFC_MODIFY_STRICT:
802 ds_put_cstr(s, "MOD_STRICT");
805 ds_put_cstr(s, "DEL");
807 case OFPFC_DELETE_STRICT:
808 ds_put_cstr(s, "DEL_STRICT");
811 ds_put_format(s, "cmd:%d", fm.command);
815 if (verbosity >= 3 && code == OFPUTIL_OFPT_FLOW_MOD) {
816 const struct ofp_flow_mod *ofm = (const struct ofp_flow_mod *) oh;
818 ofp_print_match(s, &ofm->match, verbosity);
819 } else if (verbosity >= 3 && code == OFPUTIL_NXT_FLOW_MOD) {
820 const struct nx_flow_mod *nfm = (const struct nx_flow_mod *) oh;
821 const void *nxm = nfm + 1;
822 char *nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
823 ds_put_cstr(s, nxm_s);
826 cls_rule_format(&fm.cr, s);
829 if (ds_last(s) != ' ') {
832 if (fm.cookie != htonll(0)) {
833 ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.cookie));
835 if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
836 ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
838 if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
839 ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
841 if (fm.cr.priority != OFP_DEFAULT_PRIORITY && verbosity >= 3) {
842 ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
844 if (fm.buffer_id != UINT32_MAX) {
845 ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
848 ds_put_format(s, "flags:0x%"PRIx16" ", fm.flags);
851 ofp_print_actions(s, (const struct ofp_action_header *) fm.actions,
852 fm.n_actions * sizeof *fm.actions);
856 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
858 ds_put_format(string, "%u", sec);
860 ds_put_format(string, ".%09u", nsec);
861 while (string->string[string->length - 1] == '0') {
865 ds_put_char(string, 's');
869 ofp_print_flow_removed(struct ds *string, const struct ofp_flow_removed *ofr,
872 ofp_print_match(string, &ofr->match, verbosity);
873 ds_put_cstr(string, " reason=");
874 switch (ofr->reason) {
875 case OFPRR_IDLE_TIMEOUT:
876 ds_put_cstr(string, "idle");
878 case OFPRR_HARD_TIMEOUT:
879 ds_put_cstr(string, "hard");
882 ds_put_cstr(string, "delete");
885 ds_put_format(string, "**%"PRIu8"**", ofr->reason);
889 if (ofr->cookie != htonll(0)) {
890 ds_put_format(string, " cookie:0x%"PRIx64, ntohll(ofr->cookie));
892 if (ofr->priority != htons(32768)) {
893 ds_put_format(string, " pri:%"PRIu16, ntohs(ofr->priority));
895 ds_put_cstr(string, " duration");
896 ofp_print_duration(string,
897 ntohl(ofr->duration_sec), ntohl(ofr->duration_nsec));
898 ds_put_format(string, " idle%"PRIu16" pkts%"PRIu64" bytes%"PRIu64"\n",
899 ntohs(ofr->idle_timeout), ntohll(ofr->packet_count),
900 ntohll(ofr->byte_count));
904 ofp_print_port_mod(struct ds *string, const struct ofp_port_mod *opm)
906 ds_put_format(string, "port: %d: addr:"ETH_ADDR_FMT", config: %#x, mask:%#x\n",
907 ntohs(opm->port_no), ETH_ADDR_ARGS(opm->hw_addr),
908 ntohl(opm->config), ntohl(opm->mask));
909 ds_put_format(string, " advertise: ");
910 if (opm->advertise) {
911 ofp_print_port_features(string, ntohl(opm->advertise));
913 ds_put_format(string, "UNCHANGED\n");
923 static const struct error_type error_types[] = {
924 #define ERROR_TYPE(TYPE) {TYPE, -1, #TYPE}
925 #define ERROR_CODE(TYPE, CODE) {TYPE, CODE, #CODE}
926 ERROR_TYPE(OFPET_HELLO_FAILED),
927 ERROR_CODE(OFPET_HELLO_FAILED, OFPHFC_INCOMPATIBLE),
928 ERROR_CODE(OFPET_HELLO_FAILED, OFPHFC_EPERM),
930 ERROR_TYPE(OFPET_BAD_REQUEST),
931 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VERSION),
932 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_TYPE),
933 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_STAT),
934 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_VENDOR),
935 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_SUBTYPE),
936 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_EPERM),
937 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BAD_LEN),
938 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BUFFER_EMPTY),
939 ERROR_CODE(OFPET_BAD_REQUEST, OFPBRC_BUFFER_UNKNOWN),
940 /* Nicira error extensions. */
941 ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_INVALID),
942 ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_TYPE),
943 ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_VALUE),
944 ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_MASK),
945 ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_BAD_PREREQ),
946 ERROR_CODE(OFPET_BAD_REQUEST, NXBRC_NXM_DUP_TYPE),
948 ERROR_TYPE(OFPET_BAD_ACTION),
949 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_TYPE),
950 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_LEN),
951 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR),
952 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_VENDOR_TYPE),
953 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_OUT_PORT),
954 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_BAD_ARGUMENT),
955 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_EPERM),
956 ERROR_CODE(OFPET_BAD_ACTION, OFPBAC_TOO_MANY),
958 ERROR_TYPE(OFPET_FLOW_MOD_FAILED),
959 ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_ALL_TABLES_FULL),
960 ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_OVERLAP),
961 ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_EPERM),
962 ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_EMERG_TIMEOUT),
963 ERROR_CODE(OFPET_FLOW_MOD_FAILED, OFPFMFC_BAD_COMMAND),
964 /* Nicira error extenstions. */
965 ERROR_CODE(OFPET_FLOW_MOD_FAILED, NXFMFC_HARDWARE),
966 ERROR_CODE(OFPET_FLOW_MOD_FAILED, NXFMFC_BAD_TABLE_ID),
968 ERROR_TYPE(OFPET_PORT_MOD_FAILED),
969 ERROR_CODE(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_PORT),
970 ERROR_CODE(OFPET_PORT_MOD_FAILED, OFPPMFC_BAD_HW_ADDR)
972 #define N_ERROR_TYPES ARRAY_SIZE(error_types)
975 lookup_error_type(int type)
977 const struct error_type *t;
979 for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
980 if (t->type == type && t->code == -1) {
988 lookup_error_code(int type, int code)
990 const struct error_type *t;
992 for (t = error_types; t < &error_types[N_ERROR_TYPES]; t++) {
993 if (t->type == type && t->code == code) {
1001 ofp_print_error(struct ds *string, int error)
1003 int type = get_ofp_err_type(error);
1004 int code = get_ofp_err_code(error);
1005 if (string->length) {
1006 ds_put_char(string, ' ');
1008 ds_put_format(string, " ***decode error type:%d(%s) code:%d(%s)***",
1009 type, lookup_error_type(type),
1010 code, lookup_error_code(type, code));
1014 ofp_print_nx_error_msg(struct ds *string, const struct ofp_error_msg *oem)
1016 size_t len = ntohs(oem->header.length);
1017 const struct nx_vendor_error *nve = (struct nx_vendor_error *)oem->data;
1018 int vendor = ntohl(nve->vendor);
1019 int type = ntohs(nve->type);
1020 int code = ntohs(nve->code);
1022 ds_put_format(string, " vendor:%x type:%d(%s) code:%d(%s) payload:\n",
1024 type, lookup_error_type(type),
1025 code, lookup_error_code(type, code));
1027 ds_put_hex_dump(string, nve + 1, len - sizeof *oem - sizeof *nve,
1032 ofp_print_error_msg(struct ds *string, const struct ofp_error_msg *oem)
1034 size_t len = ntohs(oem->header.length);
1035 int type = ntohs(oem->type);
1036 int code = ntohs(oem->code);
1040 if (type == NXET_VENDOR && code == NXVC_VENDOR_ERROR) {
1041 if (len < sizeof *oem + sizeof(struct nx_vendor_error)) {
1042 ds_put_format(string,
1043 "(***truncated extended error message is %zu bytes "
1044 "when it should be at least %zu***)\n",
1045 len, sizeof(struct nx_vendor_error));
1049 return ofp_print_nx_error_msg(string, oem);
1052 ds_put_format(string, " type:%d(%s) code:%d(%s) payload:\n",
1053 type, lookup_error_type(type),
1054 code, lookup_error_code(type, code));
1057 case OFPET_HELLO_FAILED:
1058 ds_put_printable(string, (char *) oem->data, len - sizeof *oem);
1061 case OFPET_BAD_REQUEST:
1062 s = ofp_to_string(oem->data, len - sizeof *oem, 1);
1063 ds_put_cstr(string, s);
1068 ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
1074 ofp_print_port_status(struct ds *string, const struct ofp_port_status *ops)
1076 if (ops->reason == OFPPR_ADD) {
1077 ds_put_format(string, " ADD:");
1078 } else if (ops->reason == OFPPR_DELETE) {
1079 ds_put_format(string, " DEL:");
1080 } else if (ops->reason == OFPPR_MODIFY) {
1081 ds_put_format(string, " MOD:");
1084 ofp_print_phy_port(string, &ops->desc);
1088 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1090 const struct ofp_desc_stats *ods = ofputil_stats_body(oh);
1092 ds_put_format(string, "Manufacturer: %.*s\n",
1093 (int) sizeof ods->mfr_desc, ods->mfr_desc);
1094 ds_put_format(string, "Hardware: %.*s\n",
1095 (int) sizeof ods->hw_desc, ods->hw_desc);
1096 ds_put_format(string, "Software: %.*s\n",
1097 (int) sizeof ods->sw_desc, ods->sw_desc);
1098 ds_put_format(string, "Serial Num: %.*s\n",
1099 (int) sizeof ods->serial_num, ods->serial_num);
1100 ds_put_format(string, "DP Description: %.*s\n",
1101 (int) sizeof ods->dp_desc, ods->dp_desc);
1105 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1107 struct flow_stats_request fsr;
1110 error = ofputil_decode_flow_stats_request(&fsr, oh, NXFF_OPENFLOW10);
1112 ofp_print_error(string, error);
1116 if (fsr.table_id != 0xff) {
1117 ds_put_format(string, " table_id=%"PRIu8, fsr.table_id);
1120 if (fsr.out_port != OFPP_NONE) {
1121 ds_put_cstr(string, " out_port=");
1122 ofp_print_port_name(string, fsr.out_port);
1125 ds_put_char(string, ' ');
1126 cls_rule_format(&fsr.match, string);
1130 ofp_print_ofpst_flow_reply(struct ds *string, const struct ofp_header *oh,
1133 size_t len = ofputil_stats_body_len(oh);
1134 const char *body = ofputil_stats_body(oh);
1135 const char *pos = body;
1137 const struct ofp_flow_stats *fs;
1138 ptrdiff_t bytes_left = body + len - pos;
1141 ds_put_char(string, '\n');
1143 if (bytes_left < sizeof *fs) {
1144 if (bytes_left != 0) {
1145 ds_put_format(string, " ***%td leftover bytes at end***",
1151 fs = (const void *) pos;
1152 length = ntohs(fs->length);
1153 if (length < sizeof *fs) {
1154 ds_put_format(string, " ***length=%zu shorter than minimum %zu***",
1155 length, sizeof *fs);
1157 } else if (length > bytes_left) {
1158 ds_put_format(string,
1159 " ***length=%zu but only %td bytes left***",
1160 length, bytes_left);
1162 } else if ((length - sizeof *fs) % sizeof fs->actions[0]) {
1163 ds_put_format(string,
1164 " ***length=%zu has %zu bytes leftover in "
1167 (length - sizeof *fs) % sizeof fs->actions[0]);
1171 ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1172 ntohll(fs->cookie));
1173 ofp_print_duration(string, ntohl(fs->duration_sec),
1174 ntohl(fs->duration_nsec));
1175 ds_put_format(string, ", table_id=%"PRIu8", ", fs->table_id);
1176 ds_put_format(string, "priority=%"PRIu16", ", ntohs(fs->priority));
1177 ds_put_format(string, "n_packets=%"PRIu64", ",
1178 ntohll(fs->packet_count));
1179 ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
1180 if (fs->idle_timeout != htons(OFP_FLOW_PERMANENT)) {
1181 ds_put_format(string, "idle_timeout=%"PRIu16",",
1182 ntohs(fs->idle_timeout));
1184 if (fs->hard_timeout != htons(OFP_FLOW_PERMANENT)) {
1185 ds_put_format(string, "hard_timeout=%"PRIu16",",
1186 ntohs(fs->hard_timeout));
1188 ofp_print_match(string, &fs->match, verbosity);
1189 ds_put_char(string, ' ');
1190 ofp_print_actions(string, fs->actions, length - sizeof *fs);
1197 ofp_print_nxst_flow_reply(struct ds *string, const struct ofp_header *oh)
1201 ofpbuf_use_const(&b, ofputil_nxstats_body(oh),
1202 ofputil_nxstats_body_len(oh));
1203 while (b.size > 0) {
1204 const struct nx_flow_stats *fs;
1205 union ofp_action *actions;
1206 struct cls_rule rule;
1207 size_t actions_len, n_actions;
1212 fs = ofpbuf_try_pull(&b, sizeof *fs);
1214 ds_put_format(string, " ***%td leftover bytes at end***", b.size);
1218 length = ntohs(fs->length);
1219 if (length < sizeof *fs) {
1220 ds_put_format(string, " ***nx_flow_stats claims length %zu***",
1225 match_len = ntohs(fs->match_len);
1226 if (match_len > length - sizeof *fs) {
1227 ds_put_format(string, " ***length=%zu match_len=%d***",
1232 ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1233 ntohll(fs->cookie));
1234 ofp_print_duration(string, ntohl(fs->duration_sec),
1235 ntohl(fs->duration_nsec));
1236 ds_put_format(string, ", table_id=%"PRIu8", ", fs->table_id);
1237 ds_put_format(string, "priority=%"PRIu16", ", ntohs(fs->priority));
1238 ds_put_format(string, "n_packets=%"PRIu64", ",
1239 ntohll(fs->packet_count));
1240 ds_put_format(string, "n_bytes=%"PRIu64", ", ntohll(fs->byte_count));
1241 if (fs->idle_timeout != htons(OFP_FLOW_PERMANENT)) {
1242 ds_put_format(string, "idle_timeout=%"PRIu16",",
1243 ntohs(fs->idle_timeout));
1245 if (fs->hard_timeout != htons(OFP_FLOW_PERMANENT)) {
1246 ds_put_format(string, "hard_timeout=%"PRIu16",",
1247 ntohs(fs->hard_timeout));
1250 error = nx_pull_match(&b, match_len, ntohs(fs->priority), &rule);
1252 ofp_print_error(string, error);
1256 actions_len = length - sizeof *fs - ROUND_UP(match_len, 8);
1257 error = ofputil_pull_actions(&b, actions_len, &actions, &n_actions);
1259 ofp_print_error(string, error);
1263 cls_rule_format(&rule, string);
1264 ds_put_char(string, ' ');
1265 ofp_print_actions(string, (const struct ofp_action_header *) actions,
1266 n_actions * sizeof *actions);
1267 ds_put_char(string, '\n');
1272 ofp_print_ofp_aggregate_stats_reply (
1273 struct ds *string, const struct ofp_aggregate_stats_reply *asr)
1275 ds_put_format(string, " packet_count=%"PRIu64, ntohll(asr->packet_count));
1276 ds_put_format(string, " byte_count=%"PRIu64, ntohll(asr->byte_count));
1277 ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
1281 ofp_print_ofpst_aggregate_reply(struct ds *string, const struct ofp_header *oh)
1283 ofp_print_ofp_aggregate_stats_reply(string, ofputil_stats_body(oh));
1287 ofp_print_nxst_aggregate_reply(struct ds *string,
1288 const struct nx_aggregate_stats_reply *nasr)
1290 ofp_print_ofp_aggregate_stats_reply(string, &nasr->asr);
1293 static void print_port_stat(struct ds *string, const char *leader,
1294 uint64_t stat, int more)
1296 ds_put_cstr(string, leader);
1298 ds_put_format(string, "%"PRIu64, stat);
1300 ds_put_char(string, '?');
1303 ds_put_cstr(string, ", ");
1305 ds_put_cstr(string, "\n");
1310 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1312 const struct ofp_port_stats_request *psr = ofputil_stats_body(oh);
1313 ds_put_format(string, "port_no=%"PRIu16, ntohs(psr->port_no));
1317 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1320 const struct ofp_port_stats *ps = ofputil_stats_body(oh);
1321 size_t n = ofputil_stats_body_len(oh) / sizeof *ps;
1322 ds_put_format(string, " %zu ports\n", n);
1323 if (verbosity < 1) {
1328 ds_put_format(string, " port %2"PRIu16": ", ntohs(ps->port_no));
1330 ds_put_cstr(string, "rx ");
1331 print_port_stat(string, "pkts=", ntohll(ps->rx_packets), 1);
1332 print_port_stat(string, "bytes=", ntohll(ps->rx_bytes), 1);
1333 print_port_stat(string, "drop=", ntohll(ps->rx_dropped), 1);
1334 print_port_stat(string, "errs=", ntohll(ps->rx_errors), 1);
1335 print_port_stat(string, "frame=", ntohll(ps->rx_frame_err), 1);
1336 print_port_stat(string, "over=", ntohll(ps->rx_over_err), 1);
1337 print_port_stat(string, "crc=", ntohll(ps->rx_crc_err), 0);
1339 ds_put_cstr(string, " tx ");
1340 print_port_stat(string, "pkts=", ntohll(ps->tx_packets), 1);
1341 print_port_stat(string, "bytes=", ntohll(ps->tx_bytes), 1);
1342 print_port_stat(string, "drop=", ntohll(ps->tx_dropped), 1);
1343 print_port_stat(string, "errs=", ntohll(ps->tx_errors), 1);
1344 print_port_stat(string, "coll=", ntohll(ps->collisions), 0);
1349 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1352 const struct ofp_table_stats *ts = ofputil_stats_body(oh);
1353 size_t n = ofputil_stats_body_len(oh) / sizeof *ts;
1354 ds_put_format(string, " %zu tables\n", n);
1355 if (verbosity < 1) {
1360 char name[OFP_MAX_TABLE_NAME_LEN + 1];
1361 strncpy(name, ts->name, sizeof name);
1362 name[OFP_MAX_TABLE_NAME_LEN] = '\0';
1364 ds_put_format(string, " %d: %-8s: ", ts->table_id, name);
1365 ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1366 ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1367 ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1368 ds_put_cstr(string, " ");
1369 ds_put_format(string, "lookup=%"PRIu64", ",
1370 ntohll(ts->lookup_count));
1371 ds_put_format(string, "matched=%"PRIu64"\n",
1372 ntohll(ts->matched_count));
1377 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1379 if (queue_id == OFPQ_ALL) {
1380 ds_put_cstr(string, "ALL");
1382 ds_put_format(string, "%"PRIu32, queue_id);
1387 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1389 const struct ofp_queue_stats_request *qsr = ofputil_stats_body(oh);
1391 ds_put_cstr(string, "port=");
1392 ofp_print_port_name(string, ntohs(qsr->port_no));
1394 ds_put_cstr(string, " queue=");
1395 ofp_print_queue_name(string, ntohl(qsr->queue_id));
1399 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1402 const struct ofp_queue_stats *qs = ofputil_stats_body(oh);
1403 size_t n = ofputil_stats_body_len(oh) / sizeof *qs;
1404 ds_put_format(string, " %zu queues\n", n);
1405 if (verbosity < 1) {
1410 ds_put_cstr(string, " port ");
1411 ofp_print_port_name(string, ntohs(qs->port_no));
1412 ds_put_cstr(string, " queue ");
1413 ofp_print_queue_name(string, ntohl(qs->queue_id));
1414 ds_put_cstr(string, ": ");
1416 print_port_stat(string, "bytes=", ntohll(qs->tx_bytes), 1);
1417 print_port_stat(string, "pkts=", ntohll(qs->tx_packets), 1);
1418 print_port_stat(string, "errors=", ntohll(qs->tx_errors), 0);
1423 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1425 const struct ofp_stats_request *srq
1426 = (const struct ofp_stats_request *) oh;
1429 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
1435 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1437 const struct ofp_stats_reply *srp = (const struct ofp_stats_reply *) oh;
1440 uint16_t flags = ntohs(srp->flags);
1442 ds_put_cstr(string, " flags=");
1443 if (flags & OFPSF_REPLY_MORE) {
1444 ds_put_cstr(string, "[more]");
1445 flags &= ~OFPSF_REPLY_MORE;
1448 ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1455 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1457 size_t len = ntohs(oh->length);
1459 ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1460 if (verbosity > 1) {
1461 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1466 ofp_print_nxt_status_message(struct ds *string, const struct ofp_header *oh)
1470 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1471 ofpbuf_pull(&b, sizeof *oh);
1472 ds_put_char(string, '"');
1473 ds_put_printable(string, b.data, b.size);
1474 ds_put_char(string, '"');
1478 ofp_print_nxt_tun_id_from_cookie(struct ds *string,
1479 const struct nxt_tun_id_cookie *ntic)
1481 ds_put_format(string, " set=%"PRIu8, ntic->set);
1485 ofp_print_nxt_role_message(struct ds *string,
1486 const struct nx_role_request *nrr)
1488 unsigned int role = ntohl(nrr->role);
1490 ds_put_cstr(string, " role=");
1491 if (role == NX_ROLE_OTHER) {
1492 ds_put_cstr(string, "other");
1493 } else if (role == NX_ROLE_MASTER) {
1494 ds_put_cstr(string, "master");
1495 } else if (role == NX_ROLE_SLAVE) {
1496 ds_put_cstr(string, "slave");
1498 ds_put_format(string, "%u", role);
1503 ofp_print_nxt_set_flow_format(struct ds *string,
1504 const struct nxt_set_flow_format *nsff)
1506 uint32_t format = ntohl(nsff->format);
1508 ds_put_cstr(string, " format=");
1509 if (ofputil_flow_format_is_valid(format)) {
1510 ds_put_cstr(string, ofputil_flow_format_to_string(format));
1512 ds_put_format(string, "%"PRIu32, format);
1517 ofp_to_string__(const struct ofp_header *oh,
1518 const struct ofputil_msg_type *type, struct ds *string,
1521 enum ofputil_msg_code code;
1522 const void *msg = oh;
1524 ds_put_format(string, "%s (xid=0x%"PRIx32"):",
1525 ofputil_msg_type_name(type), ntohl(oh->xid));
1527 code = ofputil_msg_type_code(type);
1529 case OFPUTIL_INVALID:
1532 case OFPUTIL_OFPT_HELLO:
1535 case OFPUTIL_OFPT_ERROR:
1536 ofp_print_error_msg(string, msg);
1539 case OFPUTIL_OFPT_ECHO_REQUEST:
1540 case OFPUTIL_OFPT_ECHO_REPLY:
1541 ofp_print_echo(string, oh, verbosity);
1544 case OFPUTIL_OFPT_FEATURES_REQUEST:
1547 case OFPUTIL_OFPT_FEATURES_REPLY:
1548 ofp_print_switch_features(string, msg);
1551 case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
1554 case OFPUTIL_OFPT_GET_CONFIG_REPLY:
1555 case OFPUTIL_OFPT_SET_CONFIG:
1556 ofp_print_switch_config(string, msg);
1559 case OFPUTIL_OFPT_PACKET_IN:
1560 ofp_print_packet_in(string, msg, verbosity);
1563 case OFPUTIL_OFPT_FLOW_REMOVED:
1564 ofp_print_flow_removed(string, msg, verbosity);
1567 case OFPUTIL_OFPT_PORT_STATUS:
1568 ofp_print_port_status(string, msg);
1571 case OFPUTIL_OFPT_PACKET_OUT:
1572 ofp_print_packet_out(string, msg, verbosity);
1575 case OFPUTIL_OFPT_FLOW_MOD:
1576 ofp_print_flow_mod(string, msg, code, verbosity);
1579 case OFPUTIL_OFPT_PORT_MOD:
1580 ofp_print_port_mod(string, msg);
1583 case OFPUTIL_OFPT_BARRIER_REQUEST:
1584 case OFPUTIL_OFPT_BARRIER_REPLY:
1587 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
1588 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
1592 case OFPUTIL_OFPST_DESC_REQUEST:
1593 ofp_print_stats_request(string, oh);
1596 case OFPUTIL_OFPST_FLOW_REQUEST:
1597 case OFPUTIL_NXST_FLOW_REQUEST:
1598 case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1599 case OFPUTIL_NXST_AGGREGATE_REQUEST:
1600 ofp_print_stats_request(string, oh);
1601 ofp_print_flow_stats_request(string, oh);
1604 case OFPUTIL_OFPST_TABLE_REQUEST:
1605 ofp_print_stats_request(string, oh);
1608 case OFPUTIL_OFPST_PORT_REQUEST:
1609 ofp_print_stats_request(string, oh);
1610 ofp_print_ofpst_port_request(string, oh);
1613 case OFPUTIL_OFPST_QUEUE_REQUEST:
1614 ofp_print_stats_request(string, oh);
1615 ofp_print_ofpst_queue_request(string, oh);
1618 case OFPUTIL_OFPST_DESC_REPLY:
1619 ofp_print_stats_reply(string, oh);
1620 ofp_print_ofpst_desc_reply(string, oh);
1623 case OFPUTIL_OFPST_FLOW_REPLY:
1624 ofp_print_stats_reply(string, oh);
1625 ofp_print_ofpst_flow_reply(string, oh, verbosity);
1628 case OFPUTIL_OFPST_QUEUE_REPLY:
1629 ofp_print_stats_reply(string, oh);
1630 ofp_print_ofpst_queue_reply(string, oh, verbosity);
1633 case OFPUTIL_OFPST_PORT_REPLY:
1634 ofp_print_stats_reply(string, oh);
1635 ofp_print_ofpst_port_reply(string, oh, verbosity);
1638 case OFPUTIL_OFPST_TABLE_REPLY:
1639 ofp_print_stats_reply(string, oh);
1640 ofp_print_ofpst_table_reply(string, oh, verbosity);
1643 case OFPUTIL_OFPST_AGGREGATE_REPLY:
1644 ofp_print_stats_reply(string, oh);
1645 ofp_print_ofpst_aggregate_reply(string, oh);
1648 case OFPUTIL_NXT_STATUS_REQUEST:
1649 case OFPUTIL_NXT_STATUS_REPLY:
1650 ofp_print_nxt_status_message(string, oh);
1653 case OFPUTIL_NXT_TUN_ID_FROM_COOKIE:
1654 ofp_print_nxt_tun_id_from_cookie(string, msg);
1657 case OFPUTIL_NXT_ROLE_REQUEST:
1658 case OFPUTIL_NXT_ROLE_REPLY:
1659 ofp_print_nxt_role_message(string, msg);
1662 case OFPUTIL_NXT_SET_FLOW_FORMAT:
1663 ofp_print_nxt_set_flow_format(string, msg);
1666 case OFPUTIL_NXT_FLOW_MOD:
1667 ofp_print_flow_mod(string, msg, code, verbosity);
1670 case OFPUTIL_NXT_FLOW_REMOVED:
1674 case OFPUTIL_NXST_FLOW_REPLY:
1675 ofp_print_nxst_flow_reply(string, oh);
1678 case OFPUTIL_NXST_AGGREGATE_REPLY:
1679 ofp_print_stats_reply(string, oh);
1680 ofp_print_nxst_aggregate_reply(string, oh);
1685 /* Composes and returns a string representing the OpenFlow packet of 'len'
1686 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
1687 * verbosity and higher numbers increase verbosity. The caller is responsible
1688 * for freeing the string. */
1690 ofp_to_string(const void *oh_, size_t len, int verbosity)
1692 struct ds string = DS_EMPTY_INITIALIZER;
1693 const struct ofp_header *oh = oh_;
1695 if (len < sizeof(struct ofp_header)) {
1696 ds_put_cstr(&string, "OpenFlow packet too short:\n");
1697 } else if (oh->version != OFP_VERSION) {
1698 ds_put_format(&string, "Bad OpenFlow version %"PRIu8":\n",
1700 } else if (ntohs(oh->length) > len) {
1701 ds_put_format(&string,
1702 "(***truncated to %zu bytes from %"PRIu16"***)",
1703 len, ntohs(oh->length));
1704 } else if (ntohs(oh->length) < len) {
1705 ds_put_format(&string,
1706 "(***only uses %"PRIu16" bytes out of %zu***)\n",
1707 ntohs(oh->length), len);
1709 const struct ofputil_msg_type *type;
1712 error = ofputil_decode_msg_type(oh, &type);
1714 ofp_to_string__(oh, type, &string, verbosity);
1715 if (verbosity >= 5) {
1716 if (ds_last(&string) != '\n') {
1717 ds_put_char(&string, '\n');
1719 ds_put_hex_dump(&string, oh, len, 0, true);
1721 if (ds_last(&string) != '\n') {
1722 ds_put_char(&string, '\n');
1724 return ds_steal_cstr(&string);
1727 ofp_print_error(&string, error);
1729 ds_put_hex_dump(&string, oh, len, 0, true);
1730 return ds_steal_cstr(&string);
1733 /* Returns the name for the specified OpenFlow message type as a string,
1734 * e.g. "OFPT_FEATURES_REPLY". If no name is known, the string returned is a
1735 * hex number, e.g. "0x55".
1737 * The caller must free the returned string when it is no longer needed. */
1739 ofp_message_type_to_string(uint8_t type)
1750 case OFPT_ECHO_REQUEST:
1751 name = "ECHO_REQUEST";
1753 case OFPT_ECHO_REPLY:
1754 name = "ECHO_REPLY";
1759 case OFPT_FEATURES_REQUEST:
1760 name = "FEATURES_REQUEST";
1762 case OFPT_FEATURES_REPLY:
1763 name = "FEATURES_REPLY";
1765 case OFPT_GET_CONFIG_REQUEST:
1766 name = "GET_CONFIG_REQUEST";
1768 case OFPT_GET_CONFIG_REPLY:
1769 name = "GET_CONFIG_REPLY";
1771 case OFPT_SET_CONFIG:
1772 name = "SET_CONFIG";
1774 case OFPT_PACKET_IN:
1777 case OFPT_FLOW_REMOVED:
1778 name = "FLOW_REMOVED";
1780 case OFPT_PORT_STATUS:
1781 name = "PORT_STATUS";
1783 case OFPT_PACKET_OUT:
1784 name = "PACKET_OUT";
1792 case OFPT_STATS_REQUEST:
1793 name = "STATS_REQUEST";
1795 case OFPT_STATS_REPLY:
1796 name = "STATS_REPLY";
1798 case OFPT_BARRIER_REQUEST:
1799 name = "BARRIER_REQUEST";
1801 case OFPT_BARRIER_REPLY:
1802 name = "BARRIER_REPLY";
1804 case OFPT_QUEUE_GET_CONFIG_REQUEST:
1805 name = "QUEUE_GET_CONFIG_REQUEST";
1807 case OFPT_QUEUE_GET_CONFIG_REPLY:
1808 name = "QUEUE_GET_CONFIG_REPLY";
1815 return name ? xasprintf("OFPT_%s", name) : xasprintf("0x%02"PRIx8, type);
1819 print_and_free(FILE *stream, char *string)
1821 fputs(string, stream);
1825 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1826 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
1827 * numbers increase verbosity. */
1829 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1831 print_and_free(stream, ofp_to_string(oh, len, verbosity));
1834 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1835 * 'data' to 'stream' using tcpdump. 'total_len' specifies the full length of
1836 * the Ethernet frame (of which 'len' bytes were captured).
1838 * This starts and kills a tcpdump subprocess so it's quite expensive. */
1840 ofp_print_packet(FILE *stream, const void *data, size_t len, size_t total_len)
1842 print_and_free(stream, ofp_packet_to_string(data, len, total_len));