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>
30 #include "byte-order.h"
32 #include "dynamic-string.h"
35 #include "multipath.h"
39 #include "openflow/openflow.h"
40 #include "openflow/nicira-ext.h"
43 #include "type-props.h"
44 #include "unaligned.h"
47 static void ofp_print_queue_name(struct ds
*string
, uint32_t port
);
48 static void ofp_print_error(struct ds
*, int error
);
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 OVS_UNUSED
)
62 struct ds ds
= DS_EMPTY_INITIALIZER
;
71 ofpbuf_use_const(&buf
, data
, len
);
75 ovs_error(errno
, "tmpfile");
76 return xstrdup("<error>");
78 pcap_write_header(pcap
);
79 pcap_write(pcap
, &buf
);
82 ovs_error(errno
, "error writing temporary file");
86 snprintf(command
, sizeof command
, "/usr/sbin/tcpdump -t -e -n -r /dev/fd/%d 2>/dev/null",
88 tcpdump
= popen(command
, "r");
91 ovs_error(errno
, "exec(\"%s\")", command
);
92 return xstrdup("<error>");
95 while ((c
= getc(tcpdump
)) != EOF
) {
99 status
= pclose(tcpdump
);
100 if (WIFEXITED(status
)) {
101 if (WEXITSTATUS(status
))
102 ovs_error(0, "tcpdump exited with status %d", WEXITSTATUS(status
));
103 } else if (WIFSIGNALED(status
)) {
104 ovs_error(0, "tcpdump exited with signal %d", WTERMSIG(status
));
110 ofp_print_packet_in(struct ds
*string
, const struct ofp_packet_in
*op
,
113 size_t len
= ntohs(op
->header
.length
);
116 ds_put_format(string
, " total_len=%"PRIu16
" in_port=",
117 ntohs(op
->total_len
));
118 ofputil_format_port(ntohs(op
->in_port
), string
);
120 if (op
->reason
== OFPR_ACTION
)
121 ds_put_cstr(string
, " (via action)");
122 else if (op
->reason
!= OFPR_NO_MATCH
)
123 ds_put_format(string
, " (***reason %"PRIu8
"***)", op
->reason
);
125 data_len
= len
- offsetof(struct ofp_packet_in
, data
);
126 ds_put_format(string
, " data_len=%zu", data_len
);
127 if (op
->buffer_id
== htonl(UINT32_MAX
)) {
128 ds_put_format(string
, " (unbuffered)");
129 if (ntohs(op
->total_len
) != data_len
)
130 ds_put_format(string
, " (***total_len != data_len***)");
132 ds_put_format(string
, " buffer=0x%08"PRIx32
, ntohl(op
->buffer_id
));
133 if (ntohs(op
->total_len
) < data_len
)
134 ds_put_format(string
, " (***total_len < data_len***)");
136 ds_put_char(string
, '\n');
140 struct ofpbuf packet
;
142 ofpbuf_use_const(&packet
, op
->data
, data_len
);
143 flow_extract(&packet
, 0, ntohs(op
->in_port
), &flow
);
144 flow_format(string
, &flow
);
145 ds_put_char(string
, '\n');
148 char *packet
= ofp_packet_to_string(op
->data
, data_len
,
149 ntohs(op
->total_len
));
150 ds_put_cstr(string
, packet
);
156 print_note(struct ds
*string
, const struct nx_action_note
*nan
)
161 ds_put_cstr(string
, "note:");
162 len
= ntohs(nan
->len
) - offsetof(struct nx_action_note
, note
);
163 for (i
= 0; i
< len
; i
++) {
165 ds_put_char(string
, '.');
167 ds_put_format(string
, "%02"PRIx8
, nan
->note
[i
]);
172 ofp_print_action(struct ds
*s
, const union ofp_action
*a
,
173 enum ofputil_action_code code
)
175 const struct ofp_action_enqueue
*oae
;
176 const struct ofp_action_dl_addr
*oada
;
177 const struct nx_action_set_tunnel64
*nast64
;
178 const struct nx_action_set_tunnel
*nast
;
179 const struct nx_action_set_queue
*nasq
;
180 const struct nx_action_resubmit
*nar
;
181 const struct nx_action_reg_move
*move
;
182 const struct nx_action_reg_load
*load
;
183 const struct nx_action_multipath
*nam
;
184 const struct nx_action_autopath
*naa
;
185 const struct nx_action_output_reg
*naor
;
189 case OFPUTIL_OFPAT_OUTPUT
:
190 port
= ntohs(a
->output
.port
);
191 if (port
< OFPP_MAX
) {
192 ds_put_format(s
, "output:%"PRIu16
, port
);
194 ofputil_format_port(port
, s
);
195 if (port
== OFPP_CONTROLLER
) {
196 if (a
->output
.max_len
!= htons(0)) {
197 ds_put_format(s
, ":%"PRIu16
, ntohs(a
->output
.max_len
));
199 ds_put_cstr(s
, ":all");
205 case OFPUTIL_OFPAT_ENQUEUE
:
206 oae
= (const struct ofp_action_enqueue
*) a
;
207 ds_put_format(s
, "enqueue:");
208 ofputil_format_port(ntohs(oae
->port
), s
);
209 ds_put_format(s
, "q%"PRIu32
, ntohl(oae
->queue_id
));
212 case OFPUTIL_OFPAT_SET_VLAN_VID
:
213 ds_put_format(s
, "mod_vlan_vid:%"PRIu16
,
214 ntohs(a
->vlan_vid
.vlan_vid
));
217 case OFPUTIL_OFPAT_SET_VLAN_PCP
:
218 ds_put_format(s
, "mod_vlan_pcp:%"PRIu8
, a
->vlan_pcp
.vlan_pcp
);
221 case OFPUTIL_OFPAT_STRIP_VLAN
:
222 ds_put_cstr(s
, "strip_vlan");
225 case OFPUTIL_OFPAT_SET_DL_SRC
:
226 oada
= (const struct ofp_action_dl_addr
*) a
;
227 ds_put_format(s
, "mod_dl_src:"ETH_ADDR_FMT
,
228 ETH_ADDR_ARGS(oada
->dl_addr
));
231 case OFPUTIL_OFPAT_SET_DL_DST
:
232 oada
= (const struct ofp_action_dl_addr
*) a
;
233 ds_put_format(s
, "mod_dl_dst:"ETH_ADDR_FMT
,
234 ETH_ADDR_ARGS(oada
->dl_addr
));
237 case OFPUTIL_OFPAT_SET_NW_SRC
:
238 ds_put_format(s
, "mod_nw_src:"IP_FMT
, IP_ARGS(&a
->nw_addr
.nw_addr
));
241 case OFPUTIL_OFPAT_SET_NW_DST
:
242 ds_put_format(s
, "mod_nw_dst:"IP_FMT
, IP_ARGS(&a
->nw_addr
.nw_addr
));
245 case OFPUTIL_OFPAT_SET_NW_TOS
:
246 ds_put_format(s
, "mod_nw_tos:%d", a
->nw_tos
.nw_tos
);
249 case OFPUTIL_OFPAT_SET_TP_SRC
:
250 ds_put_format(s
, "mod_tp_src:%d", ntohs(a
->tp_port
.tp_port
));
253 case OFPUTIL_OFPAT_SET_TP_DST
:
254 ds_put_format(s
, "mod_tp_dst:%d", ntohs(a
->tp_port
.tp_port
));
257 case OFPUTIL_NXAST_RESUBMIT
:
258 nar
= (struct nx_action_resubmit
*)a
;
259 ds_put_format(s
, "resubmit:");
260 ofputil_format_port(ntohs(nar
->in_port
), s
);
263 case OFPUTIL_NXAST_RESUBMIT_TABLE
:
264 nar
= (struct nx_action_resubmit
*)a
;
265 ds_put_format(s
, "resubmit(");
266 if (nar
->in_port
!= htons(OFPP_IN_PORT
)) {
267 ofputil_format_port(ntohs(nar
->in_port
), s
);
270 if (nar
->table
!= 255) {
271 ds_put_format(s
, "%"PRIu8
, nar
->table
);
276 case OFPUTIL_NXAST_SET_TUNNEL
:
277 nast
= (struct nx_action_set_tunnel
*)a
;
278 ds_put_format(s
, "set_tunnel:%#"PRIx32
, ntohl(nast
->tun_id
));
281 case OFPUTIL_NXAST_SET_QUEUE
:
282 nasq
= (struct nx_action_set_queue
*)a
;
283 ds_put_format(s
, "set_queue:%u", ntohl(nasq
->queue_id
));
286 case OFPUTIL_NXAST_POP_QUEUE
:
287 ds_put_cstr(s
, "pop_queue");
290 case OFPUTIL_NXAST_NOTE
:
291 print_note(s
, (const struct nx_action_note
*) a
);
294 case OFPUTIL_NXAST_REG_MOVE
:
295 move
= (const struct nx_action_reg_move
*) a
;
296 nxm_format_reg_move(move
, s
);
299 case OFPUTIL_NXAST_REG_LOAD
:
300 load
= (const struct nx_action_reg_load
*) a
;
301 nxm_format_reg_load(load
, s
);
304 case OFPUTIL_NXAST_SET_TUNNEL64
:
305 nast64
= (const struct nx_action_set_tunnel64
*) a
;
306 ds_put_format(s
, "set_tunnel64:%#"PRIx64
,
307 ntohll(nast64
->tun_id
));
310 case OFPUTIL_NXAST_MULTIPATH
:
311 nam
= (const struct nx_action_multipath
*) a
;
312 multipath_format(nam
, s
);
315 case OFPUTIL_NXAST_AUTOPATH
:
316 naa
= (const struct nx_action_autopath
*)a
;
317 ds_put_format(s
, "autopath(%u,", ntohl(naa
->id
));
318 nxm_format_field_bits(s
, ntohl(naa
->dst
),
319 nxm_decode_ofs(naa
->ofs_nbits
),
320 nxm_decode_n_bits(naa
->ofs_nbits
));
324 case OFPUTIL_NXAST_BUNDLE
:
325 case OFPUTIL_NXAST_BUNDLE_LOAD
:
326 bundle_format((const struct nx_action_bundle
*) a
, s
);
329 case OFPUTIL_NXAST_OUTPUT_REG
:
330 naor
= (const struct nx_action_output_reg
*) a
;
331 ds_put_cstr(s
, "output:");
332 nxm_format_field_bits(s
, ntohl(naor
->src
),
333 nxm_decode_ofs(naor
->ofs_nbits
),
334 nxm_decode_n_bits(naor
->ofs_nbits
));
337 case OFPUTIL_NXAST_LEARN
:
338 learn_format((const struct nx_action_learn
*) a
, s
);
347 ofp_print_actions(struct ds
*string
, const union ofp_action
*actions
,
350 const union ofp_action
*a
;
353 ds_put_cstr(string
, "actions=");
355 ds_put_cstr(string
, "drop");
358 OFPUTIL_ACTION_FOR_EACH (a
, left
, actions
, n_actions
) {
359 int code
= ofputil_decode_action(a
);
362 ds_put_cstr(string
, ",");
364 ofp_print_action(string
, a
, code
);
366 ofp_print_error(string
, -code
);
370 ds_put_format(string
, " ***%zu leftover bytes following actions",
376 ofp_print_packet_out(struct ds
*string
, const struct ofp_packet_out
*opo
,
379 size_t len
= ntohs(opo
->header
.length
);
380 size_t actions_len
= ntohs(opo
->actions_len
);
382 ds_put_cstr(string
, " in_port=");
383 ofputil_format_port(ntohs(opo
->in_port
), string
);
385 ds_put_format(string
, " actions_len=%zu ", actions_len
);
386 if (actions_len
> (ntohs(opo
->header
.length
) - sizeof *opo
)) {
387 ds_put_format(string
, "***packet too short for action length***\n");
390 if (actions_len
% sizeof(union ofp_action
)) {
391 ds_put_format(string
, "***action length not a multiple of %zu***\n",
392 sizeof(union ofp_action
));
394 ofp_print_actions(string
, (const union ofp_action
*) opo
->actions
,
395 actions_len
/ sizeof(union ofp_action
));
397 if (ntohl(opo
->buffer_id
) == UINT32_MAX
) {
398 int data_len
= len
- sizeof *opo
- actions_len
;
399 ds_put_format(string
, " data_len=%d", data_len
);
400 if (verbosity
> 0 && len
> sizeof *opo
) {
401 char *packet
= ofp_packet_to_string(
402 (uint8_t *)opo
->actions
+ actions_len
, data_len
, data_len
);
403 ds_put_char(string
, '\n');
404 ds_put_cstr(string
, packet
);
408 ds_put_format(string
, " buffer=0x%08"PRIx32
, ntohl(opo
->buffer_id
));
410 ds_put_char(string
, '\n');
413 /* qsort comparison function. */
415 compare_ports(const void *a_
, const void *b_
)
417 const struct ofp_phy_port
*a
= a_
;
418 const struct ofp_phy_port
*b
= b_
;
419 uint16_t ap
= ntohs(a
->port_no
);
420 uint16_t bp
= ntohs(b
->port_no
);
422 return ap
< bp
? -1 : ap
> bp
;
431 ofp_print_bit_names(struct ds
*string
, uint32_t bits
,
432 const struct bit_name bit_names
[])
437 ds_put_cstr(string
, "0");
441 for (; bits
&& bit_names
->name
; bit_names
++) {
442 if (bits
& bit_names
->bit
) {
444 ds_put_char(string
, ' ');
446 ds_put_cstr(string
, bit_names
->name
);
447 bits
&= ~bit_names
->bit
;
453 ds_put_char(string
, ' ');
455 ds_put_format(string
, "0x%"PRIx32
, bits
);
460 ofp_print_port_features(struct ds
*string
, uint32_t features
)
462 static const struct bit_name feature_bits
[] = {
463 { OFPPF_10MB_HD
, "10MB-HD" },
464 { OFPPF_10MB_FD
, "10MB-FD" },
465 { OFPPF_100MB_HD
, "100MB-HD" },
466 { OFPPF_100MB_FD
, "100MB-FD" },
467 { OFPPF_1GB_HD
, "1GB-HD" },
468 { OFPPF_1GB_FD
, "1GB-FD" },
469 { OFPPF_10GB_FD
, "10GB-FD" },
470 { OFPPF_COPPER
, "COPPER" },
471 { OFPPF_FIBER
, "FIBER" },
472 { OFPPF_AUTONEG
, "AUTO_NEG" },
473 { OFPPF_PAUSE
, "AUTO_PAUSE" },
474 { OFPPF_PAUSE_ASYM
, "AUTO_PAUSE_ASYM" },
478 ofp_print_bit_names(string
, features
, feature_bits
);
479 ds_put_char(string
, '\n');
483 ofp_print_port_config(struct ds
*string
, uint32_t config
)
485 static const struct bit_name config_bits
[] = {
486 { OFPPC_PORT_DOWN
, "PORT_DOWN" },
487 { OFPPC_NO_STP
, "NO_STP" },
488 { OFPPC_NO_RECV
, "NO_RECV" },
489 { OFPPC_NO_RECV_STP
, "NO_RECV_STP" },
490 { OFPPC_NO_FLOOD
, "NO_FLOOD" },
491 { OFPPC_NO_FWD
, "NO_FWD" },
492 { OFPPC_NO_PACKET_IN
, "NO_PACKET_IN" },
496 ofp_print_bit_names(string
, config
, config_bits
);
497 ds_put_char(string
, '\n');
501 ofp_print_port_state(struct ds
*string
, uint32_t state
)
503 static const struct bit_name state_bits
[] = {
504 { OFPPS_LINK_DOWN
, "LINK_DOWN" },
509 /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
510 * pattern. We have to special case it.
512 * OVS doesn't support STP, so this field will always be 0 if we are
513 * talking to OVS, so we'd always print STP_LISTEN in that case.
514 * Therefore, we don't print anything at all if the value is STP_LISTEN, to
515 * avoid confusing users. */
516 stp_state
= state
& OFPPS_STP_MASK
;
518 ds_put_cstr(string
, (stp_state
== OFPPS_STP_LEARN
? "STP_LEARN"
519 : stp_state
== OFPPS_STP_FORWARD
? "STP_FORWARD"
521 state
&= ~OFPPS_STP_MASK
;
523 ofp_print_bit_names(string
, state
, state_bits
);
526 ofp_print_bit_names(string
, state
, state_bits
);
528 ds_put_char(string
, '\n');
532 ofp_print_phy_port(struct ds
*string
, const struct ofp_phy_port
*port
)
534 char name
[OFP_MAX_PORT_NAME_LEN
];
537 memcpy(name
, port
->name
, sizeof name
);
538 for (j
= 0; j
< sizeof name
- 1; j
++) {
539 if (!isprint((unsigned char) name
[j
])) {
545 ds_put_char(string
, ' ');
546 ofputil_format_port(ntohs(port
->port_no
), string
);
547 ds_put_format(string
, "(%s): addr:"ETH_ADDR_FMT
"\n",
548 name
, ETH_ADDR_ARGS(port
->hw_addr
));
550 ds_put_cstr(string
, " config: ");
551 ofp_print_port_config(string
, ntohl(port
->config
));
553 ds_put_cstr(string
, " state: ");
554 ofp_print_port_state(string
, ntohl(port
->state
));
557 ds_put_format(string
, " current: ");
558 ofp_print_port_features(string
, ntohl(port
->curr
));
560 if (port
->advertised
) {
561 ds_put_format(string
, " advertised: ");
562 ofp_print_port_features(string
, ntohl(port
->advertised
));
564 if (port
->supported
) {
565 ds_put_format(string
, " supported: ");
566 ofp_print_port_features(string
, ntohl(port
->supported
));
569 ds_put_format(string
, " peer: ");
570 ofp_print_port_features(string
, ntohl(port
->peer
));
575 ofp_print_switch_features(struct ds
*string
,
576 const struct ofp_switch_features
*osf
)
578 size_t len
= ntohs(osf
->header
.length
);
579 struct ofp_phy_port
*port_list
;
583 ds_put_format(string
, " ver:0x%x, dpid:%016"PRIx64
"\n",
584 osf
->header
.version
, ntohll(osf
->datapath_id
));
585 ds_put_format(string
, "n_tables:%d, n_buffers:%d\n", osf
->n_tables
,
586 ntohl(osf
->n_buffers
));
587 ds_put_format(string
, "features: capabilities:%#x, actions:%#x\n",
588 ntohl(osf
->capabilities
), ntohl(osf
->actions
));
590 n_ports
= (len
- sizeof *osf
) / sizeof *osf
->ports
;
592 port_list
= xmemdup(osf
->ports
, len
- sizeof *osf
);
593 qsort(port_list
, n_ports
, sizeof *port_list
, compare_ports
);
594 for (i
= 0; i
< n_ports
; i
++) {
595 ofp_print_phy_port(string
, &port_list
[i
]);
601 ofp_print_switch_config(struct ds
*string
, const struct ofp_switch_config
*osc
)
605 flags
= ntohs(osc
->flags
);
607 ds_put_cstr(string
, " frags=");
608 switch (flags
& OFPC_FRAG_MASK
) {
609 case OFPC_FRAG_NORMAL
:
610 ds_put_cstr(string
, "normal");
611 flags
&= ~OFPC_FRAG_MASK
;
614 ds_put_cstr(string
, "drop");
615 flags
&= ~OFPC_FRAG_MASK
;
617 case OFPC_FRAG_REASM
:
618 ds_put_cstr(string
, "reassemble");
619 flags
&= ~OFPC_FRAG_MASK
;
623 ds_put_format(string
, " ***unknown flags 0x%04"PRIx16
"***", flags
);
626 ds_put_format(string
, " miss_send_len=%"PRIu16
"\n", ntohs(osc
->miss_send_len
));
629 static void print_wild(struct ds
*string
, const char *leader
, int is_wild
,
630 int verbosity
, const char *format
, ...)
631 __attribute__((format(printf
, 5, 6)));
633 static void print_wild(struct ds
*string
, const char *leader
, int is_wild
,
634 int verbosity
, const char *format
, ...)
636 if (is_wild
&& verbosity
< 2) {
639 ds_put_cstr(string
, leader
);
643 va_start(args
, format
);
644 ds_put_format_valist(string
, format
, args
);
647 ds_put_char(string
, '*');
649 ds_put_char(string
, ',');
653 print_ip_netmask(struct ds
*string
, const char *leader
, ovs_be32 ip
,
654 uint32_t wild_bits
, int verbosity
)
656 if (wild_bits
>= 32 && verbosity
< 2) {
659 ds_put_cstr(string
, leader
);
660 if (wild_bits
< 32) {
661 ds_put_format(string
, IP_FMT
, IP_ARGS(&ip
));
663 ds_put_format(string
, "/%d", 32 - wild_bits
);
666 ds_put_char(string
, '*');
668 ds_put_char(string
, ',');
672 ofp_print_match(struct ds
*f
, const struct ofp_match
*om
, int verbosity
)
674 char *s
= ofp_match_to_string(om
, verbosity
);
680 ofp_match_to_string(const struct ofp_match
*om
, int verbosity
)
682 struct ds f
= DS_EMPTY_INITIALIZER
;
683 uint32_t w
= ntohl(om
->wildcards
);
684 bool skip_type
= false;
685 bool skip_proto
= false;
687 if (!(w
& OFPFW_DL_TYPE
)) {
689 if (om
->dl_type
== htons(ETH_TYPE_IP
)) {
690 if (!(w
& OFPFW_NW_PROTO
)) {
692 if (om
->nw_proto
== IPPROTO_ICMP
) {
693 ds_put_cstr(&f
, "icmp,");
694 } else if (om
->nw_proto
== IPPROTO_TCP
) {
695 ds_put_cstr(&f
, "tcp,");
696 } else if (om
->nw_proto
== IPPROTO_UDP
) {
697 ds_put_cstr(&f
, "udp,");
699 ds_put_cstr(&f
, "ip,");
703 ds_put_cstr(&f
, "ip,");
705 } else if (om
->dl_type
== htons(ETH_TYPE_ARP
)) {
706 ds_put_cstr(&f
, "arp,");
711 print_wild(&f
, "in_port=", w
& OFPFW_IN_PORT
, verbosity
,
712 "%d", ntohs(om
->in_port
));
713 print_wild(&f
, "dl_vlan=", w
& OFPFW_DL_VLAN
, verbosity
,
714 "%d", ntohs(om
->dl_vlan
));
715 print_wild(&f
, "dl_vlan_pcp=", w
& OFPFW_DL_VLAN_PCP
, verbosity
,
716 "%d", om
->dl_vlan_pcp
);
717 print_wild(&f
, "dl_src=", w
& OFPFW_DL_SRC
, verbosity
,
718 ETH_ADDR_FMT
, ETH_ADDR_ARGS(om
->dl_src
));
719 print_wild(&f
, "dl_dst=", w
& OFPFW_DL_DST
, verbosity
,
720 ETH_ADDR_FMT
, ETH_ADDR_ARGS(om
->dl_dst
));
722 print_wild(&f
, "dl_type=", w
& OFPFW_DL_TYPE
, verbosity
,
723 "0x%04x", ntohs(om
->dl_type
));
725 print_ip_netmask(&f
, "nw_src=", om
->nw_src
,
726 (w
& OFPFW_NW_SRC_MASK
) >> OFPFW_NW_SRC_SHIFT
, verbosity
);
727 print_ip_netmask(&f
, "nw_dst=", om
->nw_dst
,
728 (w
& OFPFW_NW_DST_MASK
) >> OFPFW_NW_DST_SHIFT
, verbosity
);
730 if (om
->dl_type
== htons(ETH_TYPE_ARP
)) {
731 print_wild(&f
, "arp_op=", w
& OFPFW_NW_PROTO
, verbosity
,
734 print_wild(&f
, "nw_proto=", w
& OFPFW_NW_PROTO
, verbosity
,
738 print_wild(&f
, "nw_tos=", w
& OFPFW_NW_TOS
, verbosity
,
740 if (om
->nw_proto
== IPPROTO_ICMP
) {
741 print_wild(&f
, "icmp_type=", w
& OFPFW_ICMP_TYPE
, verbosity
,
742 "%d", ntohs(om
->icmp_type
));
743 print_wild(&f
, "icmp_code=", w
& OFPFW_ICMP_CODE
, verbosity
,
744 "%d", ntohs(om
->icmp_code
));
746 print_wild(&f
, "tp_src=", w
& OFPFW_TP_SRC
, verbosity
,
747 "%d", ntohs(om
->tp_src
));
748 print_wild(&f
, "tp_dst=", w
& OFPFW_TP_DST
, verbosity
,
749 "%d", ntohs(om
->tp_dst
));
751 if (ds_last(&f
) == ',') {
758 ofp_print_flow_mod(struct ds
*s
, const struct ofp_header
*oh
,
759 enum ofputil_msg_code code
, int verbosity
)
761 struct ofputil_flow_mod fm
;
765 error
= ofputil_decode_flow_mod(&fm
, oh
, true);
767 ofp_print_error(s
, error
);
772 switch (fm
.command
) {
774 ds_put_cstr(s
, "ADD");
777 ds_put_cstr(s
, "MOD");
779 case OFPFC_MODIFY_STRICT
:
780 ds_put_cstr(s
, "MOD_STRICT");
783 ds_put_cstr(s
, "DEL");
785 case OFPFC_DELETE_STRICT
:
786 ds_put_cstr(s
, "DEL_STRICT");
789 ds_put_format(s
, "cmd:%d", fm
.command
);
791 if (fm
.table_id
!= 0) {
792 ds_put_format(s
, " table:%d", fm
.table_id
);
796 if (verbosity
>= 3 && code
== OFPUTIL_OFPT_FLOW_MOD
) {
797 const struct ofp_flow_mod
*ofm
= (const struct ofp_flow_mod
*) oh
;
798 ofp_print_match(s
, &ofm
->match
, verbosity
);
800 /* ofp_print_match() doesn't print priority. */
801 need_priority
= true;
802 } else if (verbosity
>= 3 && code
== OFPUTIL_NXT_FLOW_MOD
) {
803 const struct nx_flow_mod
*nfm
= (const struct nx_flow_mod
*) oh
;
804 const void *nxm
= nfm
+ 1;
807 nxm_s
= nx_match_to_string(nxm
, ntohs(nfm
->match_len
));
808 ds_put_cstr(s
, nxm_s
);
811 /* nx_match_to_string() doesn't print priority. */
812 need_priority
= true;
814 cls_rule_format(&fm
.cr
, s
);
816 /* cls_rule_format() does print priority. */
817 need_priority
= false;
820 if (ds_last(s
) != ' ') {
823 if (fm
.cookie
!= htonll(0)) {
824 ds_put_format(s
, "cookie:0x%"PRIx64
" ", ntohll(fm
.cookie
));
826 if (fm
.idle_timeout
!= OFP_FLOW_PERMANENT
) {
827 ds_put_format(s
, "idle:%"PRIu16
" ", fm
.idle_timeout
);
829 if (fm
.hard_timeout
!= OFP_FLOW_PERMANENT
) {
830 ds_put_format(s
, "hard:%"PRIu16
" ", fm
.hard_timeout
);
832 if (fm
.cr
.priority
!= OFP_DEFAULT_PRIORITY
&& need_priority
) {
833 ds_put_format(s
, "pri:%"PRIu16
" ", fm
.cr
.priority
);
835 if (fm
.buffer_id
!= UINT32_MAX
) {
836 ds_put_format(s
, "buf:0x%"PRIx32
" ", fm
.buffer_id
);
839 ds_put_format(s
, "flags:0x%"PRIx16
" ", fm
.flags
);
842 ofp_print_actions(s
, fm
.actions
, fm
.n_actions
);
846 ofp_print_duration(struct ds
*string
, unsigned int sec
, unsigned int nsec
)
848 ds_put_format(string
, "%u", sec
);
850 ds_put_format(string
, ".%09u", nsec
);
851 while (string
->string
[string
->length
- 1] == '0') {
855 ds_put_char(string
, 's');
859 ofp_print_flow_removed(struct ds
*string
, const struct ofp_header
*oh
)
861 struct ofputil_flow_removed fr
;
864 error
= ofputil_decode_flow_removed(&fr
, oh
);
866 ofp_print_error(string
, error
);
870 ds_put_char(string
, ' ');
871 cls_rule_format(&fr
.rule
, string
);
873 ds_put_cstr(string
, " 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
"**", fr
.reason
);
889 if (fr
.cookie
!= htonll(0)) {
890 ds_put_format(string
, " cookie:0x%"PRIx64
, ntohll(fr
.cookie
));
892 ds_put_cstr(string
, " duration");
893 ofp_print_duration(string
, fr
.duration_sec
, fr
.duration_nsec
);
894 ds_put_format(string
, " idle%"PRIu16
" pkts%"PRIu64
" bytes%"PRIu64
"\n",
895 fr
.idle_timeout
, fr
.packet_count
, fr
.byte_count
);
899 ofp_print_port_mod(struct ds
*string
, const struct ofp_port_mod
*opm
)
901 ds_put_format(string
, "port: %d: addr:"ETH_ADDR_FMT
", config: %#x, mask:%#x\n",
902 ntohs(opm
->port_no
), ETH_ADDR_ARGS(opm
->hw_addr
),
903 ntohl(opm
->config
), ntohl(opm
->mask
));
904 ds_put_format(string
, " advertise: ");
905 if (opm
->advertise
) {
906 ofp_print_port_features(string
, ntohl(opm
->advertise
));
908 ds_put_format(string
, "UNCHANGED\n");
913 ofp_print_error(struct ds
*string
, int error
)
915 if (string
->length
) {
916 ds_put_char(string
, ' ');
918 ds_put_cstr(string
, "***decode error: ");
919 ofputil_format_error(string
, error
);
920 ds_put_cstr(string
, "***\n");
924 ofp_print_error_msg(struct ds
*string
, const struct ofp_error_msg
*oem
)
926 size_t len
= ntohs(oem
->header
.length
);
927 size_t payload_ofs
, payload_len
;
932 error
= ofputil_decode_error_msg(&oem
->header
, &payload_ofs
);
933 if (!is_ofp_error(error
)) {
934 ofp_print_error(string
, error
);
935 ds_put_hex_dump(string
, oem
->data
, len
- sizeof *oem
, 0, true);
939 ds_put_char(string
, ' ');
940 ofputil_format_error(string
, error
);
941 ds_put_char(string
, '\n');
943 payload
= (const uint8_t *) oem
+ payload_ofs
;
944 payload_len
= len
- payload_ofs
;
945 switch (get_ofp_err_type(error
)) {
946 case OFPET_HELLO_FAILED
:
947 ds_put_printable(string
, payload
, payload_len
);
950 case OFPET_BAD_REQUEST
:
951 s
= ofp_to_string(payload
, payload_len
, 1);
952 ds_put_cstr(string
, s
);
957 ds_put_hex_dump(string
, payload
, payload_len
, 0, true);
963 ofp_print_port_status(struct ds
*string
, const struct ofp_port_status
*ops
)
965 if (ops
->reason
== OFPPR_ADD
) {
966 ds_put_format(string
, " ADD:");
967 } else if (ops
->reason
== OFPPR_DELETE
) {
968 ds_put_format(string
, " DEL:");
969 } else if (ops
->reason
== OFPPR_MODIFY
) {
970 ds_put_format(string
, " MOD:");
973 ofp_print_phy_port(string
, &ops
->desc
);
977 ofp_print_ofpst_desc_reply(struct ds
*string
, const struct ofp_desc_stats
*ods
)
979 ds_put_char(string
, '\n');
980 ds_put_format(string
, "Manufacturer: %.*s\n",
981 (int) sizeof ods
->mfr_desc
, ods
->mfr_desc
);
982 ds_put_format(string
, "Hardware: %.*s\n",
983 (int) sizeof ods
->hw_desc
, ods
->hw_desc
);
984 ds_put_format(string
, "Software: %.*s\n",
985 (int) sizeof ods
->sw_desc
, ods
->sw_desc
);
986 ds_put_format(string
, "Serial Num: %.*s\n",
987 (int) sizeof ods
->serial_num
, ods
->serial_num
);
988 ds_put_format(string
, "DP Description: %.*s\n",
989 (int) sizeof ods
->dp_desc
, ods
->dp_desc
);
993 ofp_print_flow_stats_request(struct ds
*string
,
994 const struct ofp_stats_msg
*osm
)
996 struct ofputil_flow_stats_request fsr
;
999 error
= ofputil_decode_flow_stats_request(&fsr
, &osm
->header
);
1001 ofp_print_error(string
, error
);
1005 if (fsr
.table_id
!= 0xff) {
1006 ds_put_format(string
, " table=%"PRIu8
, fsr
.table_id
);
1009 if (fsr
.out_port
!= OFPP_NONE
) {
1010 ds_put_cstr(string
, " out_port=");
1011 ofputil_format_port(fsr
.out_port
, string
);
1014 /* A flow stats request doesn't include a priority, but cls_rule_format()
1015 * will print one unless it is OFP_DEFAULT_PRIORITY. */
1016 fsr
.match
.priority
= OFP_DEFAULT_PRIORITY
;
1018 ds_put_char(string
, ' ');
1019 cls_rule_format(&fsr
.match
, string
);
1023 ofp_print_flow_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1027 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1029 struct ofputil_flow_stats fs
;
1032 retval
= ofputil_decode_flow_stats_reply(&fs
, &b
);
1034 if (retval
!= EOF
) {
1035 ds_put_cstr(string
, " ***parse error***");
1040 ds_put_char(string
, '\n');
1042 ds_put_format(string
, " cookie=0x%"PRIx64
", duration=",
1044 ofp_print_duration(string
, fs
.duration_sec
, fs
.duration_nsec
);
1045 ds_put_format(string
, ", table=%"PRIu8
", ", fs
.table_id
);
1046 ds_put_format(string
, "n_packets=%"PRIu64
", ", fs
.packet_count
);
1047 ds_put_format(string
, "n_bytes=%"PRIu64
", ", fs
.byte_count
);
1048 if (fs
.idle_timeout
!= OFP_FLOW_PERMANENT
) {
1049 ds_put_format(string
, "idle_timeout=%"PRIu16
",", fs
.idle_timeout
);
1051 if (fs
.hard_timeout
!= OFP_FLOW_PERMANENT
) {
1052 ds_put_format(string
, "hard_timeout=%"PRIu16
",", fs
.hard_timeout
);
1055 cls_rule_format(&fs
.rule
, string
);
1056 if (string
->string
[string
->length
- 1] != ' ') {
1057 ds_put_char(string
, ' ');
1059 ofp_print_actions(string
, fs
.actions
, fs
.n_actions
);
1064 ofp_print_ofpst_aggregate_reply(struct ds
*string
,
1065 const struct ofp_aggregate_stats_reply
*asr
)
1067 ds_put_format(string
, " packet_count=%"PRIu64
,
1068 ntohll(get_32aligned_be64(&asr
->packet_count
)));
1069 ds_put_format(string
, " byte_count=%"PRIu64
,
1070 ntohll(get_32aligned_be64(&asr
->byte_count
)));
1071 ds_put_format(string
, " flow_count=%"PRIu32
, ntohl(asr
->flow_count
));
1075 ofp_print_nxst_aggregate_reply(struct ds
*string
,
1076 const struct nx_aggregate_stats_reply
*nasr
)
1078 ds_put_format(string
, " packet_count=%"PRIu64
, ntohll(nasr
->packet_count
));
1079 ds_put_format(string
, " byte_count=%"PRIu64
, ntohll(nasr
->byte_count
));
1080 ds_put_format(string
, " flow_count=%"PRIu32
, ntohl(nasr
->flow_count
));
1083 static void print_port_stat(struct ds
*string
, const char *leader
,
1084 const ovs_32aligned_be64
*statp
, int more
)
1086 uint64_t stat
= ntohll(get_32aligned_be64(statp
));
1088 ds_put_cstr(string
, leader
);
1089 if (stat
!= UINT64_MAX
) {
1090 ds_put_format(string
, "%"PRIu64
, stat
);
1092 ds_put_char(string
, '?');
1095 ds_put_cstr(string
, ", ");
1097 ds_put_cstr(string
, "\n");
1102 ofp_print_ofpst_port_request(struct ds
*string
,
1103 const struct ofp_port_stats_request
*psr
)
1105 ds_put_format(string
, " port_no=%"PRIu16
, ntohs(psr
->port_no
));
1109 ofp_print_ofpst_port_reply(struct ds
*string
, const struct ofp_header
*oh
,
1112 const struct ofp_port_stats
*ps
= ofputil_stats_body(oh
);
1113 size_t n
= ofputil_stats_body_len(oh
) / sizeof *ps
;
1114 ds_put_format(string
, " %zu ports\n", n
);
1115 if (verbosity
< 1) {
1120 ds_put_format(string
, " port %2"PRIu16
": ", ntohs(ps
->port_no
));
1122 ds_put_cstr(string
, "rx ");
1123 print_port_stat(string
, "pkts=", &ps
->rx_packets
, 1);
1124 print_port_stat(string
, "bytes=", &ps
->rx_bytes
, 1);
1125 print_port_stat(string
, "drop=", &ps
->rx_dropped
, 1);
1126 print_port_stat(string
, "errs=", &ps
->rx_errors
, 1);
1127 print_port_stat(string
, "frame=", &ps
->rx_frame_err
, 1);
1128 print_port_stat(string
, "over=", &ps
->rx_over_err
, 1);
1129 print_port_stat(string
, "crc=", &ps
->rx_crc_err
, 0);
1131 ds_put_cstr(string
, " tx ");
1132 print_port_stat(string
, "pkts=", &ps
->tx_packets
, 1);
1133 print_port_stat(string
, "bytes=", &ps
->tx_bytes
, 1);
1134 print_port_stat(string
, "drop=", &ps
->tx_dropped
, 1);
1135 print_port_stat(string
, "errs=", &ps
->tx_errors
, 1);
1136 print_port_stat(string
, "coll=", &ps
->collisions
, 0);
1141 ofp_print_ofpst_table_reply(struct ds
*string
, const struct ofp_header
*oh
,
1144 const struct ofp_table_stats
*ts
= ofputil_stats_body(oh
);
1145 size_t n
= ofputil_stats_body_len(oh
) / sizeof *ts
;
1146 ds_put_format(string
, " %zu tables\n", n
);
1147 if (verbosity
< 1) {
1152 char name
[OFP_MAX_TABLE_NAME_LEN
+ 1];
1153 ovs_strlcpy(name
, ts
->name
, sizeof name
);
1155 ds_put_format(string
, " %d: %-8s: ", ts
->table_id
, name
);
1156 ds_put_format(string
, "wild=0x%05"PRIx32
", ", ntohl(ts
->wildcards
));
1157 ds_put_format(string
, "max=%6"PRIu32
", ", ntohl(ts
->max_entries
));
1158 ds_put_format(string
, "active=%"PRIu32
"\n", ntohl(ts
->active_count
));
1159 ds_put_cstr(string
, " ");
1160 ds_put_format(string
, "lookup=%"PRIu64
", ",
1161 ntohll(get_32aligned_be64(&ts
->lookup_count
)));
1162 ds_put_format(string
, "matched=%"PRIu64
"\n",
1163 ntohll(get_32aligned_be64(&ts
->matched_count
)));
1168 ofp_print_queue_name(struct ds
*string
, uint32_t queue_id
)
1170 if (queue_id
== OFPQ_ALL
) {
1171 ds_put_cstr(string
, "ALL");
1173 ds_put_format(string
, "%"PRIu32
, queue_id
);
1178 ofp_print_ofpst_queue_request(struct ds
*string
,
1179 const struct ofp_queue_stats_request
*qsr
)
1181 ds_put_cstr(string
, "port=");
1182 ofputil_format_port(ntohs(qsr
->port_no
), string
);
1184 ds_put_cstr(string
, " queue=");
1185 ofp_print_queue_name(string
, ntohl(qsr
->queue_id
));
1189 ofp_print_ofpst_queue_reply(struct ds
*string
, const struct ofp_header
*oh
,
1192 const struct ofp_queue_stats
*qs
= ofputil_stats_body(oh
);
1193 size_t n
= ofputil_stats_body_len(oh
) / sizeof *qs
;
1194 ds_put_format(string
, " %zu queues\n", n
);
1195 if (verbosity
< 1) {
1200 ds_put_cstr(string
, " port ");
1201 ofputil_format_port(ntohs(qs
->port_no
), string
);
1202 ds_put_cstr(string
, " queue ");
1203 ofp_print_queue_name(string
, ntohl(qs
->queue_id
));
1204 ds_put_cstr(string
, ": ");
1206 print_port_stat(string
, "bytes=", &qs
->tx_bytes
, 1);
1207 print_port_stat(string
, "pkts=", &qs
->tx_packets
, 1);
1208 print_port_stat(string
, "errors=", &qs
->tx_errors
, 0);
1213 ofp_print_stats_request(struct ds
*string
, const struct ofp_header
*oh
)
1215 const struct ofp_stats_msg
*srq
= (const struct ofp_stats_msg
*) oh
;
1218 ds_put_format(string
, " ***unknown flags 0x%04"PRIx16
"***",
1224 ofp_print_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1226 const struct ofp_stats_msg
*srp
= (const struct ofp_stats_msg
*) oh
;
1229 uint16_t flags
= ntohs(srp
->flags
);
1231 ds_put_cstr(string
, " flags=");
1232 if (flags
& OFPSF_REPLY_MORE
) {
1233 ds_put_cstr(string
, "[more]");
1234 flags
&= ~OFPSF_REPLY_MORE
;
1237 ds_put_format(string
, "[***unknown flags 0x%04"PRIx16
"***]",
1244 ofp_print_echo(struct ds
*string
, const struct ofp_header
*oh
, int verbosity
)
1246 size_t len
= ntohs(oh
->length
);
1248 ds_put_format(string
, " %zu bytes of payload\n", len
- sizeof *oh
);
1249 if (verbosity
> 1) {
1250 ds_put_hex_dump(string
, oh
+ 1, len
- sizeof *oh
, 0, true);
1255 ofp_print_nxt_role_message(struct ds
*string
,
1256 const struct nx_role_request
*nrr
)
1258 unsigned int role
= ntohl(nrr
->role
);
1260 ds_put_cstr(string
, " role=");
1261 if (role
== NX_ROLE_OTHER
) {
1262 ds_put_cstr(string
, "other");
1263 } else if (role
== NX_ROLE_MASTER
) {
1264 ds_put_cstr(string
, "master");
1265 } else if (role
== NX_ROLE_SLAVE
) {
1266 ds_put_cstr(string
, "slave");
1268 ds_put_format(string
, "%u", role
);
1273 ofp_print_nxt_flow_mod_table_id(struct ds
*string
,
1274 const struct nxt_flow_mod_table_id
*nfmti
)
1276 ds_put_format(string
, " %s", nfmti
->set
? "enable" : "disable");
1280 ofp_print_nxt_set_flow_format(struct ds
*string
,
1281 const struct nxt_set_flow_format
*nsff
)
1283 uint32_t format
= ntohl(nsff
->format
);
1285 ds_put_cstr(string
, " format=");
1286 if (ofputil_flow_format_is_valid(format
)) {
1287 ds_put_cstr(string
, ofputil_flow_format_to_string(format
));
1289 ds_put_format(string
, "%"PRIu32
, format
);
1294 ofp_to_string__(const struct ofp_header
*oh
,
1295 const struct ofputil_msg_type
*type
, struct ds
*string
,
1298 enum ofputil_msg_code code
;
1299 const void *msg
= oh
;
1301 ds_put_format(string
, "%s (xid=0x%"PRIx32
"):",
1302 ofputil_msg_type_name(type
), ntohl(oh
->xid
));
1304 code
= ofputil_msg_type_code(type
);
1306 case OFPUTIL_MSG_INVALID
:
1309 case OFPUTIL_OFPT_HELLO
:
1310 ds_put_char(string
, '\n');
1311 ds_put_hex_dump(string
, oh
+ 1, ntohs(oh
->length
) - sizeof *oh
,
1315 case OFPUTIL_OFPT_ERROR
:
1316 ofp_print_error_msg(string
, msg
);
1319 case OFPUTIL_OFPT_ECHO_REQUEST
:
1320 case OFPUTIL_OFPT_ECHO_REPLY
:
1321 ofp_print_echo(string
, oh
, verbosity
);
1324 case OFPUTIL_OFPT_FEATURES_REQUEST
:
1327 case OFPUTIL_OFPT_FEATURES_REPLY
:
1328 ofp_print_switch_features(string
, msg
);
1331 case OFPUTIL_OFPT_GET_CONFIG_REQUEST
:
1334 case OFPUTIL_OFPT_GET_CONFIG_REPLY
:
1335 case OFPUTIL_OFPT_SET_CONFIG
:
1336 ofp_print_switch_config(string
, msg
);
1339 case OFPUTIL_OFPT_PACKET_IN
:
1340 ofp_print_packet_in(string
, msg
, verbosity
);
1343 case OFPUTIL_OFPT_FLOW_REMOVED
:
1344 case OFPUTIL_NXT_FLOW_REMOVED
:
1345 ofp_print_flow_removed(string
, msg
);
1348 case OFPUTIL_OFPT_PORT_STATUS
:
1349 ofp_print_port_status(string
, msg
);
1352 case OFPUTIL_OFPT_PACKET_OUT
:
1353 ofp_print_packet_out(string
, msg
, verbosity
);
1356 case OFPUTIL_OFPT_FLOW_MOD
:
1357 ofp_print_flow_mod(string
, msg
, code
, verbosity
);
1360 case OFPUTIL_OFPT_PORT_MOD
:
1361 ofp_print_port_mod(string
, msg
);
1364 case OFPUTIL_OFPT_BARRIER_REQUEST
:
1365 case OFPUTIL_OFPT_BARRIER_REPLY
:
1368 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST
:
1369 case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY
:
1373 case OFPUTIL_OFPST_DESC_REQUEST
:
1374 ofp_print_stats_request(string
, oh
);
1377 case OFPUTIL_OFPST_FLOW_REQUEST
:
1378 case OFPUTIL_NXST_FLOW_REQUEST
:
1379 case OFPUTIL_OFPST_AGGREGATE_REQUEST
:
1380 case OFPUTIL_NXST_AGGREGATE_REQUEST
:
1381 ofp_print_stats_request(string
, oh
);
1382 ofp_print_flow_stats_request(string
, msg
);
1385 case OFPUTIL_OFPST_TABLE_REQUEST
:
1386 ofp_print_stats_request(string
, oh
);
1389 case OFPUTIL_OFPST_PORT_REQUEST
:
1390 ofp_print_stats_request(string
, oh
);
1391 ofp_print_ofpst_port_request(string
, msg
);
1394 case OFPUTIL_OFPST_QUEUE_REQUEST
:
1395 ofp_print_stats_request(string
, oh
);
1396 ofp_print_ofpst_queue_request(string
, msg
);
1399 case OFPUTIL_OFPST_DESC_REPLY
:
1400 ofp_print_stats_reply(string
, oh
);
1401 ofp_print_ofpst_desc_reply(string
, msg
);
1404 case OFPUTIL_OFPST_FLOW_REPLY
:
1405 case OFPUTIL_NXST_FLOW_REPLY
:
1406 ofp_print_stats_reply(string
, oh
);
1407 ofp_print_flow_stats_reply(string
, oh
);
1410 case OFPUTIL_OFPST_QUEUE_REPLY
:
1411 ofp_print_stats_reply(string
, oh
);
1412 ofp_print_ofpst_queue_reply(string
, oh
, verbosity
);
1415 case OFPUTIL_OFPST_PORT_REPLY
:
1416 ofp_print_stats_reply(string
, oh
);
1417 ofp_print_ofpst_port_reply(string
, oh
, verbosity
);
1420 case OFPUTIL_OFPST_TABLE_REPLY
:
1421 ofp_print_stats_reply(string
, oh
);
1422 ofp_print_ofpst_table_reply(string
, oh
, verbosity
);
1425 case OFPUTIL_OFPST_AGGREGATE_REPLY
:
1426 ofp_print_stats_reply(string
, oh
);
1427 ofp_print_ofpst_aggregate_reply(string
, msg
);
1430 case OFPUTIL_NXT_ROLE_REQUEST
:
1431 case OFPUTIL_NXT_ROLE_REPLY
:
1432 ofp_print_nxt_role_message(string
, msg
);
1435 case OFPUTIL_NXT_FLOW_MOD_TABLE_ID
:
1436 ofp_print_nxt_flow_mod_table_id(string
, msg
);
1439 case OFPUTIL_NXT_SET_FLOW_FORMAT
:
1440 ofp_print_nxt_set_flow_format(string
, msg
);
1443 case OFPUTIL_NXT_FLOW_MOD
:
1444 ofp_print_flow_mod(string
, msg
, code
, verbosity
);
1447 case OFPUTIL_NXST_AGGREGATE_REPLY
:
1448 ofp_print_stats_reply(string
, oh
);
1449 ofp_print_nxst_aggregate_reply(string
, msg
);
1454 /* Composes and returns a string representing the OpenFlow packet of 'len'
1455 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
1456 * verbosity and higher numbers increase verbosity. The caller is responsible
1457 * for freeing the string. */
1459 ofp_to_string(const void *oh_
, size_t len
, int verbosity
)
1461 struct ds string
= DS_EMPTY_INITIALIZER
;
1462 const struct ofp_header
*oh
= oh_
;
1465 ds_put_cstr(&string
, "OpenFlow message is empty\n");
1466 } else if (len
< sizeof(struct ofp_header
)) {
1467 ds_put_format(&string
, "OpenFlow packet too short (only %zu bytes):\n",
1469 } else if (oh
->version
!= OFP_VERSION
) {
1470 ds_put_format(&string
, "Bad OpenFlow version %"PRIu8
":\n",
1472 } else if (ntohs(oh
->length
) > len
) {
1473 ds_put_format(&string
,
1474 "(***truncated to %zu bytes from %"PRIu16
"***)\n",
1475 len
, ntohs(oh
->length
));
1476 } else if (ntohs(oh
->length
) < len
) {
1477 ds_put_format(&string
,
1478 "(***only uses %"PRIu16
" bytes out of %zu***)\n",
1479 ntohs(oh
->length
), len
);
1481 const struct ofputil_msg_type
*type
;
1484 error
= ofputil_decode_msg_type(oh
, &type
);
1486 ofp_to_string__(oh
, type
, &string
, verbosity
);
1487 if (verbosity
>= 5) {
1488 if (ds_last(&string
) != '\n') {
1489 ds_put_char(&string
, '\n');
1491 ds_put_hex_dump(&string
, oh
, len
, 0, true);
1493 if (ds_last(&string
) != '\n') {
1494 ds_put_char(&string
, '\n');
1496 return ds_steal_cstr(&string
);
1499 ofp_print_error(&string
, error
);
1501 ds_put_hex_dump(&string
, oh
, len
, 0, true);
1502 return ds_steal_cstr(&string
);
1505 /* Returns the name for the specified OpenFlow message type as a string,
1506 * e.g. "OFPT_FEATURES_REPLY". If no name is known, the string returned is a
1507 * hex number, e.g. "0x55".
1509 * The caller must free the returned string when it is no longer needed. */
1511 ofp_message_type_to_string(uint8_t type
)
1522 case OFPT_ECHO_REQUEST
:
1523 name
= "ECHO_REQUEST";
1525 case OFPT_ECHO_REPLY
:
1526 name
= "ECHO_REPLY";
1531 case OFPT_FEATURES_REQUEST
:
1532 name
= "FEATURES_REQUEST";
1534 case OFPT_FEATURES_REPLY
:
1535 name
= "FEATURES_REPLY";
1537 case OFPT_GET_CONFIG_REQUEST
:
1538 name
= "GET_CONFIG_REQUEST";
1540 case OFPT_GET_CONFIG_REPLY
:
1541 name
= "GET_CONFIG_REPLY";
1543 case OFPT_SET_CONFIG
:
1544 name
= "SET_CONFIG";
1546 case OFPT_PACKET_IN
:
1549 case OFPT_FLOW_REMOVED
:
1550 name
= "FLOW_REMOVED";
1552 case OFPT_PORT_STATUS
:
1553 name
= "PORT_STATUS";
1555 case OFPT_PACKET_OUT
:
1556 name
= "PACKET_OUT";
1564 case OFPT_STATS_REQUEST
:
1565 name
= "STATS_REQUEST";
1567 case OFPT_STATS_REPLY
:
1568 name
= "STATS_REPLY";
1570 case OFPT_BARRIER_REQUEST
:
1571 name
= "BARRIER_REQUEST";
1573 case OFPT_BARRIER_REPLY
:
1574 name
= "BARRIER_REPLY";
1576 case OFPT_QUEUE_GET_CONFIG_REQUEST
:
1577 name
= "QUEUE_GET_CONFIG_REQUEST";
1579 case OFPT_QUEUE_GET_CONFIG_REPLY
:
1580 name
= "QUEUE_GET_CONFIG_REPLY";
1587 return name
? xasprintf("OFPT_%s", name
) : xasprintf("0x%02"PRIx8
, type
);
1591 print_and_free(FILE *stream
, char *string
)
1593 fputs(string
, stream
);
1597 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1598 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
1599 * numbers increase verbosity. */
1601 ofp_print(FILE *stream
, const void *oh
, size_t len
, int verbosity
)
1603 print_and_free(stream
, ofp_to_string(oh
, len
, verbosity
));
1606 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1607 * 'data' to 'stream' using tcpdump. 'total_len' specifies the full length of
1608 * the Ethernet frame (of which 'len' bytes were captured).
1610 * This starts and kills a tcpdump subprocess so it's quite expensive. */
1612 ofp_print_packet(FILE *stream
, const void *data
, size_t len
, size_t total_len
)
1614 print_and_free(stream
, ofp_packet_to_string(data
, len
, total_len
));