2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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"
36 #include "meta-flow.h"
39 #include "ofp-actions.h"
40 #include "ofp-errors.h"
44 #include "openflow/openflow.h"
45 #include "openflow/nicira-ext.h"
47 #include "type-props.h"
48 #include "unaligned.h"
51 static void ofp_print_queue_name(struct ds
*string
, uint32_t port
);
52 static void ofp_print_error(struct ds
*, enum ofperr
);
55 /* Returns a string that represents the contents of the Ethernet frame in the
56 * 'len' bytes starting at 'data'. The caller must free the returned string.*/
58 ofp_packet_to_string(const void *data
, size_t len
)
60 struct ds ds
= DS_EMPTY_INITIALIZER
;
64 ofpbuf_use_const(&buf
, data
, len
);
65 flow_extract(&buf
, 0, 0, NULL
, NULL
, &flow
);
66 flow_format(&ds
, &flow
);
69 if (flow
.nw_proto
== IPPROTO_TCP
) {
70 struct tcp_header
*th
= buf
.l4
;
71 ds_put_format(&ds
, " tcp_csum:%"PRIx16
,
73 } else if (flow
.nw_proto
== IPPROTO_UDP
) {
74 struct udp_header
*uh
= buf
.l4
;
75 ds_put_format(&ds
, " udp_csum:%"PRIx16
,
80 ds_put_char(&ds
, '\n');
86 ofp_print_packet_in(struct ds
*string
, const struct ofp_header
*oh
,
89 char reasonbuf
[OFPUTIL_PACKET_IN_REASON_BUFSIZE
];
90 struct ofputil_packet_in pin
;
94 error
= ofputil_decode_packet_in(&pin
, oh
);
96 ofp_print_error(string
, error
);
101 ds_put_format(string
, " table_id=%"PRIu8
, pin
.table_id
);
105 ds_put_format(string
, " cookie=0x%"PRIx64
, ntohll(pin
.cookie
));
108 ds_put_format(string
, " total_len=%"PRIu16
" in_port=", pin
.total_len
);
109 ofputil_format_port(pin
.fmd
.in_port
, string
);
111 if (pin
.fmd
.tun_id
!= htonll(0)) {
112 ds_put_format(string
, " tun_id=0x%"PRIx64
, ntohll(pin
.fmd
.tun_id
));
115 if (pin
.fmd
.tun_src
!= htonl(0)) {
116 ds_put_format(string
, " tun_src="IP_FMT
, IP_ARGS(pin
.fmd
.tun_src
));
119 if (pin
.fmd
.tun_dst
!= htonl(0)) {
120 ds_put_format(string
, " tun_dst="IP_FMT
, IP_ARGS(pin
.fmd
.tun_dst
));
123 if (pin
.fmd
.metadata
!= htonll(0)) {
124 ds_put_format(string
, " metadata=0x%"PRIx64
, ntohll(pin
.fmd
.metadata
));
127 for (i
= 0; i
< FLOW_N_REGS
; i
++) {
128 if (pin
.fmd
.regs
[i
]) {
129 ds_put_format(string
, " reg%d=0x%"PRIx32
, i
, pin
.fmd
.regs
[i
]);
133 ds_put_format(string
, " (via %s)",
134 ofputil_packet_in_reason_to_string(pin
.reason
, reasonbuf
,
137 ds_put_format(string
, " data_len=%zu", pin
.packet_len
);
138 if (pin
.buffer_id
== UINT32_MAX
) {
139 ds_put_format(string
, " (unbuffered)");
140 if (pin
.total_len
!= pin
.packet_len
) {
141 ds_put_format(string
, " (***total_len != data_len***)");
144 ds_put_format(string
, " buffer=0x%08"PRIx32
, pin
.buffer_id
);
145 if (pin
.total_len
< pin
.packet_len
) {
146 ds_put_format(string
, " (***total_len < data_len***)");
149 ds_put_char(string
, '\n');
152 char *packet
= ofp_packet_to_string(pin
.packet
, pin
.packet_len
);
153 ds_put_cstr(string
, packet
);
157 ds_put_hex_dump(string
, pin
.packet
, pin
.packet_len
, 0, false);
162 ofp_print_packet_out(struct ds
*string
, const struct ofp_header
*oh
,
165 struct ofputil_packet_out po
;
166 struct ofpbuf ofpacts
;
169 ofpbuf_init(&ofpacts
, 64);
170 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
172 ofpbuf_uninit(&ofpacts
);
173 ofp_print_error(string
, error
);
177 ds_put_cstr(string
, " in_port=");
178 ofputil_format_port(po
.in_port
, string
);
180 ds_put_char(string
, ' ');
181 ofpacts_format(po
.ofpacts
, po
.ofpacts_len
, string
);
183 if (po
.buffer_id
== UINT32_MAX
) {
184 ds_put_format(string
, " data_len=%zu", po
.packet_len
);
185 if (verbosity
> 0 && po
.packet_len
> 0) {
186 char *packet
= ofp_packet_to_string(po
.packet
, po
.packet_len
);
187 ds_put_char(string
, '\n');
188 ds_put_cstr(string
, packet
);
192 ds_put_hex_dump(string
, po
.packet
, po
.packet_len
, 0, false);
195 ds_put_format(string
, " buffer=0x%08"PRIx32
, po
.buffer_id
);
198 ofpbuf_uninit(&ofpacts
);
201 /* qsort comparison function. */
203 compare_ports(const void *a_
, const void *b_
)
205 const struct ofputil_phy_port
*a
= a_
;
206 const struct ofputil_phy_port
*b
= b_
;
207 uint16_t ap
= ofp_to_u16(a
->port_no
);
208 uint16_t bp
= ofp_to_u16(b
->port_no
);
210 return ap
< bp
? -1 : ap
> bp
;
214 ofp_print_bit_names(struct ds
*string
, uint32_t bits
,
215 const char *(*bit_to_name
)(uint32_t bit
),
222 ds_put_cstr(string
, "0");
226 for (i
= 0; i
< 32; i
++) {
227 uint32_t bit
= UINT32_C(1) << i
;
230 const char *name
= bit_to_name(bit
);
233 ds_put_char(string
, separator
);
235 ds_put_cstr(string
, name
);
243 ds_put_char(string
, separator
);
245 ds_put_format(string
, "0x%"PRIx32
, bits
);
250 netdev_feature_to_name(uint32_t bit
)
252 enum netdev_features f
= bit
;
255 case NETDEV_F_10MB_HD
: return "10MB-HD";
256 case NETDEV_F_10MB_FD
: return "10MB-FD";
257 case NETDEV_F_100MB_HD
: return "100MB-HD";
258 case NETDEV_F_100MB_FD
: return "100MB-FD";
259 case NETDEV_F_1GB_HD
: return "1GB-HD";
260 case NETDEV_F_1GB_FD
: return "1GB-FD";
261 case NETDEV_F_10GB_FD
: return "10GB-FD";
262 case NETDEV_F_40GB_FD
: return "40GB-FD";
263 case NETDEV_F_100GB_FD
: return "100GB-FD";
264 case NETDEV_F_1TB_FD
: return "1TB-FD";
265 case NETDEV_F_OTHER
: return "OTHER";
266 case NETDEV_F_COPPER
: return "COPPER";
267 case NETDEV_F_FIBER
: return "FIBER";
268 case NETDEV_F_AUTONEG
: return "AUTO_NEG";
269 case NETDEV_F_PAUSE
: return "AUTO_PAUSE";
270 case NETDEV_F_PAUSE_ASYM
: return "AUTO_PAUSE_ASYM";
277 ofp_print_port_features(struct ds
*string
, enum netdev_features features
)
279 ofp_print_bit_names(string
, features
, netdev_feature_to_name
, ' ');
280 ds_put_char(string
, '\n');
284 ofputil_port_config_to_name(uint32_t bit
)
286 enum ofputil_port_config pc
= bit
;
289 case OFPUTIL_PC_PORT_DOWN
: return "PORT_DOWN";
290 case OFPUTIL_PC_NO_STP
: return "NO_STP";
291 case OFPUTIL_PC_NO_RECV
: return "NO_RECV";
292 case OFPUTIL_PC_NO_RECV_STP
: return "NO_RECV_STP";
293 case OFPUTIL_PC_NO_FLOOD
: return "NO_FLOOD";
294 case OFPUTIL_PC_NO_FWD
: return "NO_FWD";
295 case OFPUTIL_PC_NO_PACKET_IN
: return "NO_PACKET_IN";
302 ofp_print_port_config(struct ds
*string
, enum ofputil_port_config config
)
304 ofp_print_bit_names(string
, config
, ofputil_port_config_to_name
, ' ');
305 ds_put_char(string
, '\n');
309 ofputil_port_state_to_name(uint32_t bit
)
311 enum ofputil_port_state ps
= bit
;
314 case OFPUTIL_PS_LINK_DOWN
: return "LINK_DOWN";
315 case OFPUTIL_PS_BLOCKED
: return "BLOCKED";
316 case OFPUTIL_PS_LIVE
: return "LIVE";
318 case OFPUTIL_PS_STP_LISTEN
:
319 case OFPUTIL_PS_STP_LEARN
:
320 case OFPUTIL_PS_STP_FORWARD
:
321 case OFPUTIL_PS_STP_BLOCK
:
322 /* Handled elsewhere. */
330 ofp_print_port_state(struct ds
*string
, enum ofputil_port_state state
)
332 enum ofputil_port_state stp_state
;
334 /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
335 * pattern. We have to special case it.
337 * OVS doesn't support STP, so this field will always be 0 if we are
338 * talking to OVS, so we'd always print STP_LISTEN in that case.
339 * Therefore, we don't print anything at all if the value is STP_LISTEN, to
340 * avoid confusing users. */
341 stp_state
= state
& OFPUTIL_PS_STP_MASK
;
344 (stp_state
== OFPUTIL_PS_STP_LEARN
? "STP_LEARN"
345 : stp_state
== OFPUTIL_PS_STP_FORWARD
? "STP_FORWARD"
347 state
&= ~OFPUTIL_PS_STP_MASK
;
349 ofp_print_bit_names(string
, state
, ofputil_port_state_to_name
,
353 ofp_print_bit_names(string
, state
, ofputil_port_state_to_name
, ' ');
355 ds_put_char(string
, '\n');
359 ofp_print_phy_port(struct ds
*string
, const struct ofputil_phy_port
*port
)
361 char name
[sizeof port
->name
];
364 memcpy(name
, port
->name
, sizeof name
);
365 for (j
= 0; j
< sizeof name
- 1; j
++) {
366 if (!isprint((unsigned char) name
[j
])) {
372 ds_put_char(string
, ' ');
373 ofputil_format_port(port
->port_no
, string
);
374 ds_put_format(string
, "(%s): addr:"ETH_ADDR_FMT
"\n",
375 name
, ETH_ADDR_ARGS(port
->hw_addr
));
377 ds_put_cstr(string
, " config: ");
378 ofp_print_port_config(string
, port
->config
);
380 ds_put_cstr(string
, " state: ");
381 ofp_print_port_state(string
, port
->state
);
384 ds_put_format(string
, " current: ");
385 ofp_print_port_features(string
, port
->curr
);
387 if (port
->advertised
) {
388 ds_put_format(string
, " advertised: ");
389 ofp_print_port_features(string
, port
->advertised
);
391 if (port
->supported
) {
392 ds_put_format(string
, " supported: ");
393 ofp_print_port_features(string
, port
->supported
);
396 ds_put_format(string
, " peer: ");
397 ofp_print_port_features(string
, port
->peer
);
399 ds_put_format(string
, " speed: %"PRIu32
" Mbps now, "
400 "%"PRIu32
" Mbps max\n",
401 port
->curr_speed
/ UINT32_C(1000),
402 port
->max_speed
/ UINT32_C(1000));
405 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
406 * 'ofp_version', writes a detailed description of each port into
409 ofp_print_phy_ports(struct ds
*string
, uint8_t ofp_version
,
413 struct ofputil_phy_port
*ports
;
417 n_ports
= ofputil_count_phy_ports(ofp_version
, b
);
419 ports
= xmalloc(n_ports
* sizeof *ports
);
420 for (i
= 0; i
< n_ports
; i
++) {
421 error
= ofputil_pull_phy_port(ofp_version
, b
, &ports
[i
]);
423 ofp_print_error(string
, error
);
427 qsort(ports
, n_ports
, sizeof *ports
, compare_ports
);
428 for (i
= 0; i
< n_ports
; i
++) {
429 ofp_print_phy_port(string
, &ports
[i
]);
437 ofputil_capabilities_to_name(uint32_t bit
)
439 enum ofputil_capabilities capabilities
= bit
;
441 switch (capabilities
) {
442 case OFPUTIL_C_FLOW_STATS
: return "FLOW_STATS";
443 case OFPUTIL_C_TABLE_STATS
: return "TABLE_STATS";
444 case OFPUTIL_C_PORT_STATS
: return "PORT_STATS";
445 case OFPUTIL_C_IP_REASM
: return "IP_REASM";
446 case OFPUTIL_C_QUEUE_STATS
: return "QUEUE_STATS";
447 case OFPUTIL_C_ARP_MATCH_IP
: return "ARP_MATCH_IP";
448 case OFPUTIL_C_STP
: return "STP";
449 case OFPUTIL_C_GROUP_STATS
: return "GROUP_STATS";
450 case OFPUTIL_C_PORT_BLOCKED
: return "PORT_BLOCKED";
457 ofputil_action_bitmap_to_name(uint32_t bit
)
459 enum ofputil_action_bitmap action
= bit
;
462 case OFPUTIL_A_OUTPUT
: return "OUTPUT";
463 case OFPUTIL_A_SET_VLAN_VID
: return "SET_VLAN_VID";
464 case OFPUTIL_A_SET_VLAN_PCP
: return "SET_VLAN_PCP";
465 case OFPUTIL_A_STRIP_VLAN
: return "STRIP_VLAN";
466 case OFPUTIL_A_SET_DL_SRC
: return "SET_DL_SRC";
467 case OFPUTIL_A_SET_DL_DST
: return "SET_DL_DST";
468 case OFPUTIL_A_SET_NW_SRC
: return "SET_NW_SRC";
469 case OFPUTIL_A_SET_NW_DST
: return "SET_NW_DST";
470 case OFPUTIL_A_SET_NW_ECN
: return "SET_NW_ECN";
471 case OFPUTIL_A_SET_NW_TOS
: return "SET_NW_TOS";
472 case OFPUTIL_A_SET_TP_SRC
: return "SET_TP_SRC";
473 case OFPUTIL_A_SET_TP_DST
: return "SET_TP_DST";
474 case OFPUTIL_A_SET_FIELD
: return "SET_FIELD";
475 case OFPUTIL_A_ENQUEUE
: return "ENQUEUE";
476 case OFPUTIL_A_COPY_TTL_OUT
: return "COPY_TTL_OUT";
477 case OFPUTIL_A_COPY_TTL_IN
: return "COPY_TTL_IN";
478 case OFPUTIL_A_SET_MPLS_LABEL
: return "SET_MPLS_LABEL";
479 case OFPUTIL_A_SET_MPLS_TC
: return "SET_MPLS_TC";
480 case OFPUTIL_A_SET_MPLS_TTL
: return "SET_MPLS_TTL";
481 case OFPUTIL_A_DEC_MPLS_TTL
: return "DEC_MPLS_TTL";
482 case OFPUTIL_A_PUSH_VLAN
: return "PUSH_VLAN";
483 case OFPUTIL_A_POP_VLAN
: return "POP_VLAN";
484 case OFPUTIL_A_PUSH_MPLS
: return "PUSH_MPLS";
485 case OFPUTIL_A_POP_MPLS
: return "POP_MPLS";
486 case OFPUTIL_A_SET_QUEUE
: return "SET_QUEUE";
487 case OFPUTIL_A_GROUP
: return "GROUP";
488 case OFPUTIL_A_SET_NW_TTL
: return "SET_NW_TTL";
489 case OFPUTIL_A_DEC_NW_TTL
: return "DEC_NW_TTL";
496 ofp_print_switch_features(struct ds
*string
, const struct ofp_header
*oh
)
498 struct ofputil_switch_features features
;
502 error
= ofputil_decode_switch_features(oh
, &features
, &b
);
504 ofp_print_error(string
, error
);
508 ds_put_format(string
, " dpid:%016"PRIx64
"\n", features
.datapath_id
);
510 ds_put_format(string
, "n_tables:%"PRIu8
", n_buffers:%"PRIu32
,
511 features
.n_tables
, features
.n_buffers
);
512 if (features
.auxiliary_id
) {
513 ds_put_format(string
, ", auxiliary_id:%"PRIu8
, features
.auxiliary_id
);
515 ds_put_char(string
, '\n');
517 ds_put_cstr(string
, "capabilities: ");
518 ofp_print_bit_names(string
, features
.capabilities
,
519 ofputil_capabilities_to_name
, ' ');
520 ds_put_char(string
, '\n');
522 switch ((enum ofp_version
)oh
->version
) {
524 ds_put_cstr(string
, "actions: ");
525 ofp_print_bit_names(string
, features
.actions
,
526 ofputil_action_bitmap_to_name
, ' ');
527 ds_put_char(string
, '\n');
533 return; /* no ports in ofp13_switch_features */
538 ofp_print_phy_ports(string
, oh
->version
, &b
);
542 ofp_print_switch_config(struct ds
*string
, const struct ofp_switch_config
*osc
)
544 enum ofp_config_flags flags
;
546 flags
= ntohs(osc
->flags
);
548 ds_put_format(string
, " frags=%s", ofputil_frag_handling_to_string(flags
));
549 flags
&= ~OFPC_FRAG_MASK
;
551 if (flags
& OFPC_INVALID_TTL_TO_CONTROLLER
) {
552 ds_put_format(string
, " invalid_ttl_to_controller");
553 flags
&= ~OFPC_INVALID_TTL_TO_CONTROLLER
;
557 ds_put_format(string
, " ***unknown flags 0x%04"PRIx16
"***", flags
);
560 ds_put_format(string
, " miss_send_len=%"PRIu16
"\n", ntohs(osc
->miss_send_len
));
563 static void print_wild(struct ds
*string
, const char *leader
, int is_wild
,
564 int verbosity
, const char *format
, ...)
565 __attribute__((format(printf
, 5, 6)));
567 static void print_wild(struct ds
*string
, const char *leader
, int is_wild
,
568 int verbosity
, const char *format
, ...)
570 if (is_wild
&& verbosity
< 2) {
573 ds_put_cstr(string
, leader
);
577 va_start(args
, format
);
578 ds_put_format_valist(string
, format
, args
);
581 ds_put_char(string
, '*');
583 ds_put_char(string
, ',');
587 print_wild_port(struct ds
*string
, const char *leader
, int is_wild
,
588 int verbosity
, ofp_port_t port
)
590 if (is_wild
&& verbosity
< 2) {
593 ds_put_cstr(string
, leader
);
595 ofputil_format_port(port
, string
);
597 ds_put_char(string
, '*');
599 ds_put_char(string
, ',');
603 print_ip_netmask(struct ds
*string
, const char *leader
, ovs_be32 ip
,
604 uint32_t wild_bits
, int verbosity
)
606 if (wild_bits
>= 32 && verbosity
< 2) {
609 ds_put_cstr(string
, leader
);
610 if (wild_bits
< 32) {
611 ds_put_format(string
, IP_FMT
, IP_ARGS(ip
));
613 ds_put_format(string
, "/%d", 32 - wild_bits
);
616 ds_put_char(string
, '*');
618 ds_put_char(string
, ',');
622 ofp10_match_print(struct ds
*f
, const struct ofp10_match
*om
, int verbosity
)
624 char *s
= ofp10_match_to_string(om
, verbosity
);
630 ofp10_match_to_string(const struct ofp10_match
*om
, int verbosity
)
632 struct ds f
= DS_EMPTY_INITIALIZER
;
633 uint32_t w
= ntohl(om
->wildcards
);
634 bool skip_type
= false;
635 bool skip_proto
= false;
637 if (!(w
& OFPFW10_DL_TYPE
)) {
639 if (om
->dl_type
== htons(ETH_TYPE_IP
)) {
640 if (!(w
& OFPFW10_NW_PROTO
)) {
642 if (om
->nw_proto
== IPPROTO_ICMP
) {
643 ds_put_cstr(&f
, "icmp,");
644 } else if (om
->nw_proto
== IPPROTO_TCP
) {
645 ds_put_cstr(&f
, "tcp,");
646 } else if (om
->nw_proto
== IPPROTO_UDP
) {
647 ds_put_cstr(&f
, "udp,");
649 ds_put_cstr(&f
, "ip,");
653 ds_put_cstr(&f
, "ip,");
655 } else if (om
->dl_type
== htons(ETH_TYPE_ARP
)) {
656 ds_put_cstr(&f
, "arp,");
657 } else if (om
->dl_type
== htons(ETH_TYPE_RARP
)){
658 ds_put_cstr(&f
, "rarp,");
659 } else if (om
->dl_type
== htons(ETH_TYPE_MPLS
)) {
660 ds_put_cstr(&f
, "mpls,");
661 } else if (om
->dl_type
== htons(ETH_TYPE_MPLS_MCAST
)) {
662 ds_put_cstr(&f
, "mplsm,");
667 print_wild_port(&f
, "in_port=", w
& OFPFW10_IN_PORT
, verbosity
,
668 u16_to_ofp(ntohs(om
->in_port
)));
669 print_wild(&f
, "dl_vlan=", w
& OFPFW10_DL_VLAN
, verbosity
,
670 "%d", ntohs(om
->dl_vlan
));
671 print_wild(&f
, "dl_vlan_pcp=", w
& OFPFW10_DL_VLAN_PCP
, verbosity
,
672 "%d", om
->dl_vlan_pcp
);
673 print_wild(&f
, "dl_src=", w
& OFPFW10_DL_SRC
, verbosity
,
674 ETH_ADDR_FMT
, ETH_ADDR_ARGS(om
->dl_src
));
675 print_wild(&f
, "dl_dst=", w
& OFPFW10_DL_DST
, verbosity
,
676 ETH_ADDR_FMT
, ETH_ADDR_ARGS(om
->dl_dst
));
678 print_wild(&f
, "dl_type=", w
& OFPFW10_DL_TYPE
, verbosity
,
679 "0x%04x", ntohs(om
->dl_type
));
681 print_ip_netmask(&f
, "nw_src=", om
->nw_src
,
682 (w
& OFPFW10_NW_SRC_MASK
) >> OFPFW10_NW_SRC_SHIFT
,
684 print_ip_netmask(&f
, "nw_dst=", om
->nw_dst
,
685 (w
& OFPFW10_NW_DST_MASK
) >> OFPFW10_NW_DST_SHIFT
,
688 if (om
->dl_type
== htons(ETH_TYPE_ARP
) ||
689 om
->dl_type
== htons(ETH_TYPE_RARP
)) {
690 print_wild(&f
, "arp_op=", w
& OFPFW10_NW_PROTO
, verbosity
,
693 print_wild(&f
, "nw_proto=", w
& OFPFW10_NW_PROTO
, verbosity
,
697 print_wild(&f
, "nw_tos=", w
& OFPFW10_NW_TOS
, verbosity
,
699 if (om
->nw_proto
== IPPROTO_ICMP
) {
700 print_wild(&f
, "icmp_type=", w
& OFPFW10_ICMP_TYPE
, verbosity
,
701 "%d", ntohs(om
->tp_src
));
702 print_wild(&f
, "icmp_code=", w
& OFPFW10_ICMP_CODE
, verbosity
,
703 "%d", ntohs(om
->tp_dst
));
705 print_wild(&f
, "tp_src=", w
& OFPFW10_TP_SRC
, verbosity
,
706 "%d", ntohs(om
->tp_src
));
707 print_wild(&f
, "tp_dst=", w
& OFPFW10_TP_DST
, verbosity
,
708 "%d", ntohs(om
->tp_dst
));
710 if (ds_last(&f
) == ',') {
717 ofp_print_flow_flags(struct ds
*s
, uint16_t flags
)
719 if (flags
& OFPFF_SEND_FLOW_REM
) {
720 ds_put_cstr(s
, "send_flow_rem ");
722 if (flags
& OFPFF_CHECK_OVERLAP
) {
723 ds_put_cstr(s
, "check_overlap ");
725 if (flags
& OFPFF12_RESET_COUNTS
) {
726 ds_put_cstr(s
, "reset_counts ");
728 if (flags
& OFPFF13_NO_PKT_COUNTS
) {
729 ds_put_cstr(s
, "no_packet_counts ");
731 if (flags
& OFPFF13_NO_BYT_COUNTS
) {
732 ds_put_cstr(s
, "no_byte_counts ");
735 flags
&= ~(OFPFF_SEND_FLOW_REM
| OFPFF_CHECK_OVERLAP
736 | OFPFF12_RESET_COUNTS
737 | OFPFF13_NO_PKT_COUNTS
| OFPFF13_NO_BYT_COUNTS
);
739 ds_put_format(s
, "flags:0x%"PRIx16
" ", flags
);
744 ofp_print_flow_mod(struct ds
*s
, const struct ofp_header
*oh
, int verbosity
)
746 struct ofputil_flow_mod fm
;
747 struct ofpbuf ofpacts
;
751 enum ofputil_protocol protocol
;
753 protocol
= ofputil_protocol_from_ofp_version(oh
->version
);
754 protocol
= ofputil_protocol_set_tid(protocol
, true);
756 ofpbuf_init(&ofpacts
, 64);
757 error
= ofputil_decode_flow_mod(&fm
, oh
, protocol
, &ofpacts
);
759 ofpbuf_uninit(&ofpacts
);
760 ofp_print_error(s
, error
);
765 switch (fm
.command
) {
767 ds_put_cstr(s
, "ADD");
770 ds_put_cstr(s
, "MOD");
772 case OFPFC_MODIFY_STRICT
:
773 ds_put_cstr(s
, "MOD_STRICT");
776 ds_put_cstr(s
, "DEL");
778 case OFPFC_DELETE_STRICT
:
779 ds_put_cstr(s
, "DEL_STRICT");
782 ds_put_format(s
, "cmd:%d", fm
.command
);
784 if (fm
.table_id
!= 0) {
785 ds_put_format(s
, " table:%d", fm
.table_id
);
789 ofpraw_decode(&raw
, oh
);
790 if (verbosity
>= 3 && raw
== OFPRAW_OFPT10_FLOW_MOD
) {
791 const struct ofp10_flow_mod
*ofm
= ofpmsg_body(oh
);
792 ofp10_match_print(s
, &ofm
->match
, verbosity
);
794 /* ofp_print_match() doesn't print priority. */
795 need_priority
= true;
796 } else if (verbosity
>= 3 && raw
== OFPRAW_NXT_FLOW_MOD
) {
797 const struct nx_flow_mod
*nfm
= ofpmsg_body(oh
);
798 const void *nxm
= nfm
+ 1;
801 nxm_s
= nx_match_to_string(nxm
, ntohs(nfm
->match_len
));
802 ds_put_cstr(s
, nxm_s
);
805 /* nx_match_to_string() doesn't print priority. */
806 need_priority
= true;
808 match_format(&fm
.match
, s
, fm
.priority
);
810 /* match_format() does print priority. */
811 need_priority
= false;
814 if (ds_last(s
) != ' ') {
817 if (fm
.new_cookie
!= htonll(0) && fm
.new_cookie
!= htonll(UINT64_MAX
)) {
818 ds_put_format(s
, "cookie:0x%"PRIx64
" ", ntohll(fm
.new_cookie
));
820 if (fm
.cookie_mask
!= htonll(0)) {
821 ds_put_format(s
, "cookie:0x%"PRIx64
"/0x%"PRIx64
" ",
822 ntohll(fm
.cookie
), ntohll(fm
.cookie_mask
));
824 if (fm
.idle_timeout
!= OFP_FLOW_PERMANENT
) {
825 ds_put_format(s
, "idle:%"PRIu16
" ", fm
.idle_timeout
);
827 if (fm
.hard_timeout
!= OFP_FLOW_PERMANENT
) {
828 ds_put_format(s
, "hard:%"PRIu16
" ", fm
.hard_timeout
);
830 if (fm
.priority
!= OFP_DEFAULT_PRIORITY
&& need_priority
) {
831 ds_put_format(s
, "pri:%"PRIu16
" ", fm
.priority
);
833 if (fm
.buffer_id
!= UINT32_MAX
) {
834 ds_put_format(s
, "buf:0x%"PRIx32
" ", fm
.buffer_id
);
836 if (fm
.out_port
!= OFPP_ANY
) {
837 ds_put_format(s
, "out_port:");
838 ofputil_format_port(fm
.out_port
, s
);
842 ofp_print_flow_flags(s
, fm
.flags
);
845 ofpacts_format(fm
.ofpacts
, fm
.ofpacts_len
, s
);
846 ofpbuf_uninit(&ofpacts
);
850 ofp_print_duration(struct ds
*string
, unsigned int sec
, unsigned int nsec
)
852 ds_put_format(string
, "%u", sec
);
854 ds_put_format(string
, ".%09u", nsec
);
855 while (string
->string
[string
->length
- 1] == '0') {
859 ds_put_char(string
, 's');
862 /* Returns a string form of 'reason'. The return value is either a statically
863 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
864 * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
865 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
867 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason
,
868 char *reasonbuf
, size_t bufsize
)
871 case OFPRR_IDLE_TIMEOUT
:
873 case OFPRR_HARD_TIMEOUT
:
877 case OFPRR_GROUP_DELETE
:
878 return "group_delete";
882 snprintf(reasonbuf
, bufsize
, "%d", (int) reason
);
888 ofp_print_flow_removed(struct ds
*string
, const struct ofp_header
*oh
)
890 char reasonbuf
[OFP_FLOW_REMOVED_REASON_BUFSIZE
];
891 struct ofputil_flow_removed fr
;
894 error
= ofputil_decode_flow_removed(&fr
, oh
);
896 ofp_print_error(string
, error
);
900 ds_put_char(string
, ' ');
901 match_format(&fr
.match
, string
, fr
.priority
);
903 ds_put_format(string
, " reason=%s",
904 ofp_flow_removed_reason_to_string(fr
.reason
, reasonbuf
,
907 if (fr
.table_id
!= 255) {
908 ds_put_format(string
, " table_id=%"PRIu8
, fr
.table_id
);
911 if (fr
.cookie
!= htonll(0)) {
912 ds_put_format(string
, " cookie:0x%"PRIx64
, ntohll(fr
.cookie
));
914 ds_put_cstr(string
, " duration");
915 ofp_print_duration(string
, fr
.duration_sec
, fr
.duration_nsec
);
916 ds_put_format(string
, " idle%"PRIu16
, fr
.idle_timeout
);
917 if (fr
.hard_timeout
) {
918 /* The hard timeout was only added in OF1.2, so only print it if it is
919 * actually in use to avoid gratuitous change to the formatting. */
920 ds_put_format(string
, " hard%"PRIu16
, fr
.hard_timeout
);
922 ds_put_format(string
, " pkts%"PRIu64
" bytes%"PRIu64
"\n",
923 fr
.packet_count
, fr
.byte_count
);
927 ofp_print_port_mod(struct ds
*string
, const struct ofp_header
*oh
)
929 struct ofputil_port_mod pm
;
932 error
= ofputil_decode_port_mod(oh
, &pm
);
934 ofp_print_error(string
, error
);
938 ds_put_cstr(string
, "port: ");
939 ofputil_format_port(pm
.port_no
, string
);
940 ds_put_format(string
, ": addr:"ETH_ADDR_FMT
"\n",
941 ETH_ADDR_ARGS(pm
.hw_addr
));
943 ds_put_cstr(string
, " config: ");
944 ofp_print_port_config(string
, pm
.config
);
946 ds_put_cstr(string
, " mask: ");
947 ofp_print_port_config(string
, pm
.mask
);
949 ds_put_cstr(string
, " advertise: ");
951 ofp_print_port_features(string
, pm
.advertise
);
953 ds_put_cstr(string
, "UNCHANGED\n");
958 ofp_print_error(struct ds
*string
, enum ofperr error
)
960 if (string
->length
) {
961 ds_put_char(string
, ' ');
963 ds_put_format(string
, "***decode error: %s***\n", ofperr_get_name(error
));
967 ofp_print_hello(struct ds
*string
, const struct ofp_header
*oh
)
969 uint32_t allowed_versions
;
972 ok
= ofputil_decode_hello(oh
, &allowed_versions
);
974 ds_put_cstr(string
, "\n version bitmap: ");
975 ofputil_format_version_bitmap(string
, allowed_versions
);
978 ds_put_cstr(string
, "\n unknown data in hello:\n");
979 ds_put_hex_dump(string
, oh
, ntohs(oh
->length
), 0, true);
984 ofp_print_error_msg(struct ds
*string
, const struct ofp_header
*oh
)
986 size_t len
= ntohs(oh
->length
);
987 struct ofpbuf payload
;
991 error
= ofperr_decode_msg(oh
, &payload
);
993 ds_put_cstr(string
, "***decode error***");
994 ds_put_hex_dump(string
, oh
+ 1, len
- sizeof *oh
, 0, true);
998 ds_put_format(string
, " %s\n", ofperr_get_name(error
));
1000 if (error
== OFPERR_OFPHFC_INCOMPATIBLE
|| error
== OFPERR_OFPHFC_EPERM
) {
1001 ds_put_printable(string
, payload
.data
, payload
.size
);
1003 s
= ofp_to_string(payload
.data
, payload
.size
, 1);
1004 ds_put_cstr(string
, s
);
1010 ofp_print_port_status(struct ds
*string
, const struct ofp_header
*oh
)
1012 struct ofputil_port_status ps
;
1015 error
= ofputil_decode_port_status(oh
, &ps
);
1017 ofp_print_error(string
, error
);
1021 if (ps
.reason
== OFPPR_ADD
) {
1022 ds_put_format(string
, " ADD:");
1023 } else if (ps
.reason
== OFPPR_DELETE
) {
1024 ds_put_format(string
, " DEL:");
1025 } else if (ps
.reason
== OFPPR_MODIFY
) {
1026 ds_put_format(string
, " MOD:");
1029 ofp_print_phy_port(string
, &ps
.desc
);
1033 ofp_print_ofpst_desc_reply(struct ds
*string
, const struct ofp_header
*oh
)
1035 const struct ofp_desc_stats
*ods
= ofpmsg_body(oh
);
1037 ds_put_char(string
, '\n');
1038 ds_put_format(string
, "Manufacturer: %.*s\n",
1039 (int) sizeof ods
->mfr_desc
, ods
->mfr_desc
);
1040 ds_put_format(string
, "Hardware: %.*s\n",
1041 (int) sizeof ods
->hw_desc
, ods
->hw_desc
);
1042 ds_put_format(string
, "Software: %.*s\n",
1043 (int) sizeof ods
->sw_desc
, ods
->sw_desc
);
1044 ds_put_format(string
, "Serial Num: %.*s\n",
1045 (int) sizeof ods
->serial_num
, ods
->serial_num
);
1046 ds_put_format(string
, "DP Description: %.*s\n",
1047 (int) sizeof ods
->dp_desc
, ods
->dp_desc
);
1051 ofp_print_flow_stats_request(struct ds
*string
, const struct ofp_header
*oh
)
1053 struct ofputil_flow_stats_request fsr
;
1056 error
= ofputil_decode_flow_stats_request(&fsr
, oh
);
1058 ofp_print_error(string
, error
);
1062 if (fsr
.table_id
!= 0xff) {
1063 ds_put_format(string
, " table=%"PRIu8
, fsr
.table_id
);
1066 if (fsr
.out_port
!= OFPP_ANY
) {
1067 ds_put_cstr(string
, " out_port=");
1068 ofputil_format_port(fsr
.out_port
, string
);
1071 ds_put_char(string
, ' ');
1072 match_format(&fsr
.match
, string
, OFP_DEFAULT_PRIORITY
);
1076 ofp_print_flow_stats(struct ds
*string
, struct ofputil_flow_stats
*fs
)
1078 ds_put_format(string
, " cookie=0x%"PRIx64
", duration=",
1079 ntohll(fs
->cookie
));
1081 ofp_print_duration(string
, fs
->duration_sec
, fs
->duration_nsec
);
1082 ds_put_format(string
, ", table=%"PRIu8
", ", fs
->table_id
);
1083 ds_put_format(string
, "n_packets=%"PRIu64
", ", fs
->packet_count
);
1084 ds_put_format(string
, "n_bytes=%"PRIu64
", ", fs
->byte_count
);
1085 if (fs
->idle_timeout
!= OFP_FLOW_PERMANENT
) {
1086 ds_put_format(string
, "idle_timeout=%"PRIu16
", ", fs
->idle_timeout
);
1088 if (fs
->hard_timeout
!= OFP_FLOW_PERMANENT
) {
1089 ds_put_format(string
, "hard_timeout=%"PRIu16
", ", fs
->hard_timeout
);
1092 ofp_print_flow_flags(string
, fs
->flags
);
1094 if (fs
->idle_age
>= 0) {
1095 ds_put_format(string
, "idle_age=%d, ", fs
->idle_age
);
1097 if (fs
->hard_age
>= 0 && fs
->hard_age
!= fs
->duration_sec
) {
1098 ds_put_format(string
, "hard_age=%d, ", fs
->hard_age
);
1101 match_format(&fs
->match
, string
, fs
->priority
);
1102 if (string
->string
[string
->length
- 1] != ' ') {
1103 ds_put_char(string
, ' ');
1106 ofpacts_format(fs
->ofpacts
, fs
->ofpacts_len
, string
);
1110 ofp_print_flow_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1112 struct ofpbuf ofpacts
;
1115 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1116 ofpbuf_init(&ofpacts
, 64);
1118 struct ofputil_flow_stats fs
;
1121 retval
= ofputil_decode_flow_stats_reply(&fs
, &b
, true, &ofpacts
);
1123 if (retval
!= EOF
) {
1124 ds_put_cstr(string
, " ***parse error***");
1128 ds_put_char(string
, '\n');
1129 ofp_print_flow_stats(string
, &fs
);
1131 ofpbuf_uninit(&ofpacts
);
1135 ofp_print_aggregate_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1137 struct ofputil_aggregate_stats as
;
1140 error
= ofputil_decode_aggregate_stats_reply(&as
, oh
);
1142 ofp_print_error(string
, error
);
1146 ds_put_format(string
, " packet_count=%"PRIu64
, as
.packet_count
);
1147 ds_put_format(string
, " byte_count=%"PRIu64
, as
.byte_count
);
1148 ds_put_format(string
, " flow_count=%"PRIu32
, as
.flow_count
);
1152 print_port_stat(struct ds
*string
, const char *leader
, uint64_t stat
, int more
)
1154 ds_put_cstr(string
, leader
);
1155 if (stat
!= UINT64_MAX
) {
1156 ds_put_format(string
, "%"PRIu64
, stat
);
1158 ds_put_char(string
, '?');
1161 ds_put_cstr(string
, ", ");
1163 ds_put_cstr(string
, "\n");
1168 ofp_print_ofpst_port_request(struct ds
*string
, const struct ofp_header
*oh
)
1170 ofp_port_t ofp10_port
;
1173 error
= ofputil_decode_port_stats_request(oh
, &ofp10_port
);
1175 ofp_print_error(string
, error
);
1179 ds_put_cstr(string
, " port_no=");
1180 ofputil_format_port(ofp10_port
, string
);
1184 ofp_print_ofpst_port_reply(struct ds
*string
, const struct ofp_header
*oh
,
1189 ds_put_format(string
, " %zu ports\n", ofputil_count_port_stats(oh
));
1190 if (verbosity
< 1) {
1194 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1196 struct ofputil_port_stats ps
;
1199 retval
= ofputil_decode_port_stats(&ps
, &b
);
1201 if (retval
!= EOF
) {
1202 ds_put_cstr(string
, " ***parse error***");
1207 ds_put_cstr(string
, " port ");
1208 if (ofp_to_u16(ps
.port_no
) < 10) {
1209 ds_put_char(string
, ' ');
1211 ofputil_format_port(ps
.port_no
, string
);
1213 ds_put_cstr(string
, ": rx ");
1214 print_port_stat(string
, "pkts=", ps
.stats
.rx_packets
, 1);
1215 print_port_stat(string
, "bytes=", ps
.stats
.rx_bytes
, 1);
1216 print_port_stat(string
, "drop=", ps
.stats
.rx_dropped
, 1);
1217 print_port_stat(string
, "errs=", ps
.stats
.rx_errors
, 1);
1218 print_port_stat(string
, "frame=", ps
.stats
.rx_frame_errors
, 1);
1219 print_port_stat(string
, "over=", ps
.stats
.rx_over_errors
, 1);
1220 print_port_stat(string
, "crc=", ps
.stats
.rx_crc_errors
, 0);
1222 ds_put_cstr(string
, " tx ");
1223 print_port_stat(string
, "pkts=", ps
.stats
.tx_packets
, 1);
1224 print_port_stat(string
, "bytes=", ps
.stats
.tx_bytes
, 1);
1225 print_port_stat(string
, "drop=", ps
.stats
.tx_dropped
, 1);
1226 print_port_stat(string
, "errs=", ps
.stats
.tx_errors
, 1);
1227 print_port_stat(string
, "coll=", ps
.stats
.collisions
, 0);
1229 if (ps
.duration_sec
!= UINT32_MAX
) {
1230 ds_put_cstr(string
, " duration=");
1231 ofp_print_duration(string
, ps
.duration_sec
, ps
.duration_nsec
);
1232 ds_put_char(string
, '\n');
1238 ofp_print_one_ofpst_table_reply(struct ds
*string
, enum ofp_version ofp_version
,
1239 const char *name
, struct ofp12_table_stats
*ts
)
1241 char name_
[OFP_MAX_TABLE_NAME_LEN
+ 1];
1243 /* ofp13_table_stats is different */
1244 if (ofp_version
> OFP12_VERSION
) {
1248 ovs_strlcpy(name_
, name
, sizeof name_
);
1250 ds_put_format(string
, " %d: %-8s: ", ts
->table_id
, name_
);
1251 ds_put_format(string
, "wild=0x%05"PRIx64
", ", ntohll(ts
->wildcards
));
1252 ds_put_format(string
, "max=%6"PRIu32
", ", ntohl(ts
->max_entries
));
1253 ds_put_format(string
, "active=%"PRIu32
"\n", ntohl(ts
->active_count
));
1254 ds_put_cstr(string
, " ");
1255 ds_put_format(string
, "lookup=%"PRIu64
", ", ntohll(ts
->lookup_count
));
1256 ds_put_format(string
, "matched=%"PRIu64
"\n", ntohll(ts
->matched_count
));
1258 if (ofp_version
< OFP11_VERSION
) {
1262 ds_put_cstr(string
, " ");
1263 ds_put_format(string
, "match=0x%08"PRIx64
", ", ntohll(ts
->match
));
1264 ds_put_format(string
, "instructions=0x%08"PRIx32
", ",
1265 ntohl(ts
->instructions
));
1266 ds_put_format(string
, "config=0x%08"PRIx32
"\n", ntohl(ts
->config
));
1267 ds_put_cstr(string
, " ");
1268 ds_put_format(string
, "write_actions=0x%08"PRIx32
", ",
1269 ntohl(ts
->write_actions
));
1270 ds_put_format(string
, "apply_actions=0x%08"PRIx32
"\n",
1271 ntohl(ts
->apply_actions
));
1273 if (ofp_version
< OFP12_VERSION
) {
1277 ds_put_cstr(string
, " ");
1278 ds_put_format(string
, "write_setfields=0x%016"PRIx64
"\n",
1279 ntohll(ts
->write_setfields
));
1280 ds_put_cstr(string
, " ");
1281 ds_put_format(string
, "apply_setfields=0x%016"PRIx64
"\n",
1282 ntohll(ts
->apply_setfields
));
1283 ds_put_cstr(string
, " ");
1284 ds_put_format(string
, "metadata_match=0x%016"PRIx64
"\n",
1285 ntohll(ts
->metadata_match
));
1286 ds_put_cstr(string
, " ");
1287 ds_put_format(string
, "metadata_write=0x%016"PRIx64
"\n",
1288 ntohll(ts
->metadata_write
));
1292 ofp_print_ofpst_table_reply13(struct ds
*string
, const struct ofp_header
*oh
,
1295 struct ofp13_table_stats
*ts
;
1299 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1300 ofpraw_pull_assert(&b
);
1302 n
= b
.size
/ sizeof *ts
;
1303 ds_put_format(string
, " %zu tables\n", n
);
1304 if (verbosity
< 1) {
1309 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1313 ds_put_format(string
,
1314 " %d: active=%"PRIu32
", lookup=%"PRIu64 \
1315 ", matched=%"PRIu64
"\n",
1316 ts
->table_id
, ntohl(ts
->active_count
),
1317 ntohll(ts
->lookup_count
), ntohll(ts
->matched_count
));
1322 ofp_print_ofpst_table_reply12(struct ds
*string
, const struct ofp_header
*oh
,
1325 struct ofp12_table_stats
*ts
;
1329 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1330 ofpraw_pull_assert(&b
);
1332 n
= b
.size
/ sizeof *ts
;
1333 ds_put_format(string
, " %zu tables\n", n
);
1334 if (verbosity
< 1) {
1339 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1344 ofp_print_one_ofpst_table_reply(string
, OFP12_VERSION
, ts
->name
, ts
);
1349 ofp_print_ofpst_table_reply11(struct ds
*string
, const struct ofp_header
*oh
,
1352 struct ofp11_table_stats
*ts
;
1356 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1357 ofpraw_pull_assert(&b
);
1359 n
= b
.size
/ sizeof *ts
;
1360 ds_put_format(string
, " %zu tables\n", n
);
1361 if (verbosity
< 1) {
1366 struct ofp12_table_stats ts12
;
1368 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1373 ts12
.table_id
= ts
->table_id
;
1374 ts12
.wildcards
= htonll(ntohl(ts
->wildcards
));
1375 ts12
.max_entries
= ts
->max_entries
;
1376 ts12
.active_count
= ts
->active_count
;
1377 ts12
.lookup_count
= ts
->lookup_count
;
1378 ts12
.matched_count
= ts
->matched_count
;
1379 ts12
.match
= htonll(ntohl(ts
->match
));
1380 ts12
.instructions
= ts
->instructions
;
1381 ts12
.config
= ts
->config
;
1382 ts12
.write_actions
= ts
->write_actions
;
1383 ts12
.apply_actions
= ts
->apply_actions
;
1384 ofp_print_one_ofpst_table_reply(string
, OFP11_VERSION
, ts
->name
, &ts12
);
1389 ofp_print_ofpst_table_reply10(struct ds
*string
, const struct ofp_header
*oh
,
1392 struct ofp10_table_stats
*ts
;
1396 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1397 ofpraw_pull_assert(&b
);
1399 n
= b
.size
/ sizeof *ts
;
1400 ds_put_format(string
, " %zu tables\n", n
);
1401 if (verbosity
< 1) {
1406 struct ofp12_table_stats ts12
;
1408 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1413 ts12
.table_id
= ts
->table_id
;
1414 ts12
.wildcards
= htonll(ntohl(ts
->wildcards
));
1415 ts12
.max_entries
= ts
->max_entries
;
1416 ts12
.active_count
= ts
->active_count
;
1417 ts12
.lookup_count
= get_32aligned_be64(&ts
->lookup_count
);
1418 ts12
.matched_count
= get_32aligned_be64(&ts
->matched_count
);
1419 ofp_print_one_ofpst_table_reply(string
, OFP10_VERSION
, ts
->name
, &ts12
);
1424 ofp_print_ofpst_table_reply(struct ds
*string
, const struct ofp_header
*oh
,
1427 switch ((enum ofp_version
)oh
->version
) {
1429 ofp_print_ofpst_table_reply13(string
, oh
, verbosity
);
1433 ofp_print_ofpst_table_reply12(string
, oh
, verbosity
);
1437 ofp_print_ofpst_table_reply11(string
, oh
, verbosity
);
1441 ofp_print_ofpst_table_reply10(string
, oh
, verbosity
);
1450 ofp_print_queue_name(struct ds
*string
, uint32_t queue_id
)
1452 if (queue_id
== OFPQ_ALL
) {
1453 ds_put_cstr(string
, "ALL");
1455 ds_put_format(string
, "%"PRIu32
, queue_id
);
1460 ofp_print_ofpst_queue_request(struct ds
*string
, const struct ofp_header
*oh
)
1462 struct ofputil_queue_stats_request oqsr
;
1465 error
= ofputil_decode_queue_stats_request(oh
, &oqsr
);
1467 ds_put_format(string
, "***decode error: %s***\n", ofperr_get_name(error
));
1471 ds_put_cstr(string
, "port=");
1472 ofputil_format_port(oqsr
.port_no
, string
);
1474 ds_put_cstr(string
, " queue=");
1475 ofp_print_queue_name(string
, oqsr
.queue_id
);
1479 ofp_print_ofpst_queue_reply(struct ds
*string
, const struct ofp_header
*oh
,
1484 ds_put_format(string
, " %zu queues\n", ofputil_count_queue_stats(oh
));
1485 if (verbosity
< 1) {
1489 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1491 struct ofputil_queue_stats qs
;
1494 retval
= ofputil_decode_queue_stats(&qs
, &b
);
1496 if (retval
!= EOF
) {
1497 ds_put_cstr(string
, " ***parse error***");
1502 ds_put_cstr(string
, " port ");
1503 ofputil_format_port(qs
.port_no
, string
);
1504 ds_put_cstr(string
, " queue ");
1505 ofp_print_queue_name(string
, qs
.queue_id
);
1506 ds_put_cstr(string
, ": ");
1508 print_port_stat(string
, "bytes=", qs
.stats
.tx_bytes
, 1);
1509 print_port_stat(string
, "pkts=", qs
.stats
.tx_packets
, 1);
1510 print_port_stat(string
, "errors=", qs
.stats
.tx_errors
, 0);
1515 ofp_print_ofpst_port_desc_reply(struct ds
*string
,
1516 const struct ofp_header
*oh
)
1520 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1521 ofpraw_pull_assert(&b
);
1522 ds_put_char(string
, '\n');
1523 ofp_print_phy_ports(string
, oh
->version
, &b
);
1527 ofp_print_stats_request(struct ds
*string
, const struct ofp_header
*oh
)
1529 uint16_t flags
= ofpmp_flags(oh
);
1532 ds_put_format(string
, " ***unknown flags 0x%04"PRIx16
"***", flags
);
1537 ofp_print_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1539 uint16_t flags
= ofpmp_flags(oh
);
1542 ds_put_cstr(string
, " flags=");
1543 if (flags
& OFPSF_REPLY_MORE
) {
1544 ds_put_cstr(string
, "[more]");
1545 flags
&= ~OFPSF_REPLY_MORE
;
1548 ds_put_format(string
, "[***unknown flags 0x%04"PRIx16
"***]",
1555 ofp_print_echo(struct ds
*string
, const struct ofp_header
*oh
, int verbosity
)
1557 size_t len
= ntohs(oh
->length
);
1559 ds_put_format(string
, " %zu bytes of payload\n", len
- sizeof *oh
);
1560 if (verbosity
> 1) {
1561 ds_put_hex_dump(string
, oh
+ 1, len
- sizeof *oh
, 0, true);
1566 ofp_print_role_message(struct ds
*string
, const struct ofp_header
*oh
)
1568 struct ofputil_role_request rr
;
1571 error
= ofputil_decode_role_message(oh
, &rr
);
1573 ofp_print_error(string
, error
);
1577 ds_put_cstr(string
, " role=");
1580 case OFPCR12_ROLE_NOCHANGE
:
1581 ds_put_cstr(string
, "nochange");
1583 case OFPCR12_ROLE_EQUAL
:
1584 ds_put_cstr(string
, "equal"); /* OF 1.2 wording */
1586 case OFPCR12_ROLE_MASTER
:
1587 ds_put_cstr(string
, "master");
1589 case OFPCR12_ROLE_SLAVE
:
1590 ds_put_cstr(string
, "slave");
1596 if (rr
.have_generation_id
) {
1597 ds_put_format(string
, " generation_id=%"PRIu64
, rr
.generation_id
);
1602 ofp_print_nxt_flow_mod_table_id(struct ds
*string
,
1603 const struct nx_flow_mod_table_id
*nfmti
)
1605 ds_put_format(string
, " %s", nfmti
->set
? "enable" : "disable");
1609 ofp_print_nxt_set_flow_format(struct ds
*string
,
1610 const struct nx_set_flow_format
*nsff
)
1612 uint32_t format
= ntohl(nsff
->format
);
1614 ds_put_cstr(string
, " format=");
1615 if (ofputil_nx_flow_format_is_valid(format
)) {
1616 ds_put_cstr(string
, ofputil_nx_flow_format_to_string(format
));
1618 ds_put_format(string
, "%"PRIu32
, format
);
1623 ofp_print_nxt_set_packet_in_format(struct ds
*string
,
1624 const struct nx_set_packet_in_format
*nspf
)
1626 uint32_t format
= ntohl(nspf
->format
);
1628 ds_put_cstr(string
, " format=");
1629 if (ofputil_packet_in_format_is_valid(format
)) {
1630 ds_put_cstr(string
, ofputil_packet_in_format_to_string(format
));
1632 ds_put_format(string
, "%"PRIu32
, format
);
1636 /* Returns a string form of 'reason'. The return value is either a statically
1637 * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1638 * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
1639 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
1641 ofp_port_reason_to_string(enum ofp_port_reason reason
,
1642 char *reasonbuf
, size_t bufsize
)
1655 snprintf(reasonbuf
, bufsize
, "%d", (int) reason
);
1661 ofp_print_nxt_set_async_config(struct ds
*string
,
1662 const struct nx_async_config
*nac
)
1666 for (i
= 0; i
< 2; i
++) {
1669 ds_put_format(string
, "\n %s:\n", i
== 0 ? "master" : "slave");
1671 ds_put_cstr(string
, " PACKET_IN:");
1672 for (j
= 0; j
< 32; j
++) {
1673 if (nac
->packet_in_mask
[i
] & htonl(1u << j
)) {
1674 char reasonbuf
[OFPUTIL_PACKET_IN_REASON_BUFSIZE
];
1677 reason
= ofputil_packet_in_reason_to_string(j
, reasonbuf
,
1679 ds_put_format(string
, " %s", reason
);
1682 if (!nac
->packet_in_mask
[i
]) {
1683 ds_put_cstr(string
, " (off)");
1685 ds_put_char(string
, '\n');
1687 ds_put_cstr(string
, " PORT_STATUS:");
1688 for (j
= 0; j
< 32; j
++) {
1689 if (nac
->port_status_mask
[i
] & htonl(1u << j
)) {
1690 char reasonbuf
[OFP_PORT_REASON_BUFSIZE
];
1693 reason
= ofp_port_reason_to_string(j
, reasonbuf
,
1695 ds_put_format(string
, " %s", reason
);
1698 if (!nac
->port_status_mask
[i
]) {
1699 ds_put_cstr(string
, " (off)");
1701 ds_put_char(string
, '\n');
1703 ds_put_cstr(string
, " FLOW_REMOVED:");
1704 for (j
= 0; j
< 32; j
++) {
1705 if (nac
->flow_removed_mask
[i
] & htonl(1u << j
)) {
1706 char reasonbuf
[OFP_FLOW_REMOVED_REASON_BUFSIZE
];
1709 reason
= ofp_flow_removed_reason_to_string(j
, reasonbuf
,
1711 ds_put_format(string
, " %s", reason
);
1714 if (!nac
->flow_removed_mask
[i
]) {
1715 ds_put_cstr(string
, " (off)");
1717 ds_put_char(string
, '\n');
1722 ofp_print_nxt_set_controller_id(struct ds
*string
,
1723 const struct nx_controller_id
*nci
)
1725 ds_put_format(string
, " id=%"PRIu16
, ntohs(nci
->controller_id
));
1729 ofp_print_nxt_flow_monitor_cancel(struct ds
*string
,
1730 const struct ofp_header
*oh
)
1732 ds_put_format(string
, " id=%"PRIu32
,
1733 ofputil_decode_flow_monitor_cancel(oh
));
1737 nx_flow_monitor_flags_to_name(uint32_t bit
)
1739 enum nx_flow_monitor_flags fmf
= bit
;
1742 case NXFMF_INITIAL
: return "initial";
1743 case NXFMF_ADD
: return "add";
1744 case NXFMF_DELETE
: return "delete";
1745 case NXFMF_MODIFY
: return "modify";
1746 case NXFMF_ACTIONS
: return "actions";
1747 case NXFMF_OWN
: return "own";
1754 ofp_print_nxst_flow_monitor_request(struct ds
*string
,
1755 const struct ofp_header
*oh
)
1759 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1761 struct ofputil_flow_monitor_request request
;
1764 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
1766 if (retval
!= EOF
) {
1767 ofp_print_error(string
, retval
);
1772 ds_put_format(string
, "\n id=%"PRIu32
" flags=", request
.id
);
1773 ofp_print_bit_names(string
, request
.flags
,
1774 nx_flow_monitor_flags_to_name
, ',');
1776 if (request
.out_port
!= OFPP_NONE
) {
1777 ds_put_cstr(string
, " out_port=");
1778 ofputil_format_port(request
.out_port
, string
);
1781 if (request
.table_id
!= 0xff) {
1782 ds_put_format(string
, " table=%"PRIu8
, request
.table_id
);
1785 ds_put_char(string
, ' ');
1786 match_format(&request
.match
, string
, OFP_DEFAULT_PRIORITY
);
1787 ds_chomp(string
, ' ');
1792 ofp_print_nxst_flow_monitor_reply(struct ds
*string
,
1793 const struct ofp_header
*oh
)
1795 uint64_t ofpacts_stub
[1024 / 8];
1796 struct ofpbuf ofpacts
;
1799 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1800 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
1802 char reasonbuf
[OFP_FLOW_REMOVED_REASON_BUFSIZE
];
1803 struct ofputil_flow_update update
;
1807 update
.match
= &match
;
1808 retval
= ofputil_decode_flow_update(&update
, &b
, &ofpacts
);
1810 if (retval
!= EOF
) {
1811 ofp_print_error(string
, retval
);
1813 ofpbuf_uninit(&ofpacts
);
1817 ds_put_cstr(string
, "\n event=");
1818 switch (update
.event
) {
1820 ds_put_cstr(string
, "ADDED");
1824 ds_put_format(string
, "DELETED reason=%s",
1825 ofp_flow_removed_reason_to_string(update
.reason
,
1830 case NXFME_MODIFIED
:
1831 ds_put_cstr(string
, "MODIFIED");
1835 ds_put_format(string
, "ABBREV xid=0x%"PRIx32
, ntohl(update
.xid
));
1839 ds_put_format(string
, " table=%"PRIu8
, update
.table_id
);
1840 if (update
.idle_timeout
!= OFP_FLOW_PERMANENT
) {
1841 ds_put_format(string
, " idle_timeout=%"PRIu16
,
1842 update
.idle_timeout
);
1844 if (update
.hard_timeout
!= OFP_FLOW_PERMANENT
) {
1845 ds_put_format(string
, " hard_timeout=%"PRIu16
,
1846 update
.hard_timeout
);
1848 ds_put_format(string
, " cookie=%#"PRIx64
, ntohll(update
.cookie
));
1850 ds_put_char(string
, ' ');
1851 match_format(update
.match
, string
, OFP_DEFAULT_PRIORITY
);
1853 if (update
.ofpacts_len
) {
1854 if (string
->string
[string
->length
- 1] != ' ') {
1855 ds_put_char(string
, ' ');
1857 ofpacts_format(update
.ofpacts
, update
.ofpacts_len
, string
);
1863 ofp_print_version(const struct ofp_header
*oh
,
1866 switch (oh
->version
) {
1870 ds_put_cstr(string
, " (OF1.1)");
1873 ds_put_cstr(string
, " (OF1.2)");
1876 ds_put_cstr(string
, " (OF1.3)");
1879 ds_put_format(string
, " (OF 0x%02"PRIx8
")", oh
->version
);
1882 ds_put_format(string
, " (xid=0x%"PRIx32
"):", ntohl(oh
->xid
));
1886 ofp_header_to_string__(const struct ofp_header
*oh
, enum ofpraw raw
,
1889 ds_put_cstr(string
, ofpraw_get_name(raw
));
1890 ofp_print_version(oh
, string
);
1894 ofp_print_not_implemented(struct ds
*string
)
1896 ds_put_cstr(string
, "NOT IMPLEMENTED YET!\n");
1900 ofp_to_string__(const struct ofp_header
*oh
, enum ofpraw raw
,
1901 struct ds
*string
, int verbosity
)
1903 const void *msg
= oh
;
1905 ofp_header_to_string__(oh
, raw
, string
);
1906 switch (ofptype_from_ofpraw(raw
)) {
1908 /* FIXME: Change the following once they are implemented: */
1909 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
1910 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
1911 case OFPTYPE_GET_ASYNC_REQUEST
:
1912 case OFPTYPE_GET_ASYNC_REPLY
:
1913 case OFPTYPE_METER_MOD
:
1914 case OFPTYPE_GROUP_REQUEST
:
1915 case OFPTYPE_GROUP_REPLY
:
1916 case OFPTYPE_GROUP_DESC_REQUEST
:
1917 case OFPTYPE_GROUP_DESC_REPLY
:
1918 case OFPTYPE_GROUP_FEATURES_REQUEST
:
1919 case OFPTYPE_GROUP_FEATURES_REPLY
:
1920 case OFPTYPE_METER_REQUEST
:
1921 case OFPTYPE_METER_REPLY
:
1922 case OFPTYPE_METER_CONFIG_REQUEST
:
1923 case OFPTYPE_METER_CONFIG_REPLY
:
1924 case OFPTYPE_METER_FEATURES_REQUEST
:
1925 case OFPTYPE_METER_FEATURES_REPLY
:
1926 case OFPTYPE_TABLE_FEATURES_REQUEST
:
1927 case OFPTYPE_TABLE_FEATURES_REPLY
:
1928 ofp_print_not_implemented(string
);
1932 ofp_print_hello(string
, oh
);
1936 ofp_print_error_msg(string
, oh
);
1939 case OFPTYPE_ECHO_REQUEST
:
1940 case OFPTYPE_ECHO_REPLY
:
1941 ofp_print_echo(string
, oh
, verbosity
);
1944 case OFPTYPE_FEATURES_REQUEST
:
1947 case OFPTYPE_FEATURES_REPLY
:
1948 ofp_print_switch_features(string
, oh
);
1951 case OFPTYPE_GET_CONFIG_REQUEST
:
1954 case OFPTYPE_GET_CONFIG_REPLY
:
1955 case OFPTYPE_SET_CONFIG
:
1956 ofp_print_switch_config(string
, ofpmsg_body(oh
));
1959 case OFPTYPE_PACKET_IN
:
1960 ofp_print_packet_in(string
, oh
, verbosity
);
1963 case OFPTYPE_FLOW_REMOVED
:
1964 ofp_print_flow_removed(string
, oh
);
1967 case OFPTYPE_PORT_STATUS
:
1968 ofp_print_port_status(string
, oh
);
1971 case OFPTYPE_PACKET_OUT
:
1972 ofp_print_packet_out(string
, oh
, verbosity
);
1975 case OFPTYPE_FLOW_MOD
:
1976 ofp_print_flow_mod(string
, oh
, verbosity
);
1979 case OFPTYPE_PORT_MOD
:
1980 ofp_print_port_mod(string
, oh
);
1983 case OFPTYPE_BARRIER_REQUEST
:
1984 case OFPTYPE_BARRIER_REPLY
:
1987 case OFPTYPE_ROLE_REQUEST
:
1988 case OFPTYPE_ROLE_REPLY
:
1989 ofp_print_role_message(string
, oh
);
1992 case OFPTYPE_DESC_STATS_REQUEST
:
1993 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
1994 ofp_print_stats_request(string
, oh
);
1997 case OFPTYPE_FLOW_STATS_REQUEST
:
1998 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
1999 ofp_print_stats_request(string
, oh
);
2000 ofp_print_flow_stats_request(string
, oh
);
2003 case OFPTYPE_TABLE_STATS_REQUEST
:
2004 ofp_print_stats_request(string
, oh
);
2007 case OFPTYPE_PORT_STATS_REQUEST
:
2008 ofp_print_stats_request(string
, oh
);
2009 ofp_print_ofpst_port_request(string
, oh
);
2012 case OFPTYPE_QUEUE_STATS_REQUEST
:
2013 ofp_print_stats_request(string
, oh
);
2014 ofp_print_ofpst_queue_request(string
, oh
);
2017 case OFPTYPE_DESC_STATS_REPLY
:
2018 ofp_print_stats_reply(string
, oh
);
2019 ofp_print_ofpst_desc_reply(string
, oh
);
2022 case OFPTYPE_FLOW_STATS_REPLY
:
2023 ofp_print_stats_reply(string
, oh
);
2024 ofp_print_flow_stats_reply(string
, oh
);
2027 case OFPTYPE_QUEUE_STATS_REPLY
:
2028 ofp_print_stats_reply(string
, oh
);
2029 ofp_print_ofpst_queue_reply(string
, oh
, verbosity
);
2032 case OFPTYPE_PORT_STATS_REPLY
:
2033 ofp_print_stats_reply(string
, oh
);
2034 ofp_print_ofpst_port_reply(string
, oh
, verbosity
);
2037 case OFPTYPE_TABLE_STATS_REPLY
:
2038 ofp_print_stats_reply(string
, oh
);
2039 ofp_print_ofpst_table_reply(string
, oh
, verbosity
);
2042 case OFPTYPE_AGGREGATE_STATS_REPLY
:
2043 ofp_print_stats_reply(string
, oh
);
2044 ofp_print_aggregate_stats_reply(string
, oh
);
2047 case OFPTYPE_PORT_DESC_STATS_REPLY
:
2048 ofp_print_stats_reply(string
, oh
);
2049 ofp_print_ofpst_port_desc_reply(string
, oh
);
2052 case OFPTYPE_FLOW_MOD_TABLE_ID
:
2053 ofp_print_nxt_flow_mod_table_id(string
, ofpmsg_body(oh
));
2056 case OFPTYPE_SET_FLOW_FORMAT
:
2057 ofp_print_nxt_set_flow_format(string
, ofpmsg_body(oh
));
2060 case OFPTYPE_SET_PACKET_IN_FORMAT
:
2061 ofp_print_nxt_set_packet_in_format(string
, ofpmsg_body(oh
));
2064 case OFPTYPE_FLOW_AGE
:
2067 case OFPTYPE_SET_CONTROLLER_ID
:
2068 ofp_print_nxt_set_controller_id(string
, ofpmsg_body(oh
));
2071 case OFPTYPE_SET_ASYNC_CONFIG
:
2072 ofp_print_nxt_set_async_config(string
, ofpmsg_body(oh
));
2075 case OFPTYPE_FLOW_MONITOR_CANCEL
:
2076 ofp_print_nxt_flow_monitor_cancel(string
, msg
);
2079 case OFPTYPE_FLOW_MONITOR_PAUSED
:
2080 case OFPTYPE_FLOW_MONITOR_RESUMED
:
2083 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
2084 ofp_print_nxst_flow_monitor_request(string
, msg
);
2087 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
2088 ofp_print_nxst_flow_monitor_reply(string
, msg
);
2093 /* Composes and returns a string representing the OpenFlow packet of 'len'
2094 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
2095 * verbosity and higher numbers increase verbosity. The caller is responsible
2096 * for freeing the string. */
2098 ofp_to_string(const void *oh_
, size_t len
, int verbosity
)
2100 struct ds string
= DS_EMPTY_INITIALIZER
;
2101 const struct ofp_header
*oh
= oh_
;
2104 ds_put_cstr(&string
, "OpenFlow message is empty\n");
2105 } else if (len
< sizeof(struct ofp_header
)) {
2106 ds_put_format(&string
, "OpenFlow packet too short (only %zu bytes):\n",
2108 } else if (ntohs(oh
->length
) > len
) {
2112 error
= ofpraw_decode_partial(&raw
, oh
, len
);
2114 ofp_header_to_string__(oh
, raw
, &string
);
2115 ds_put_char(&string
, '\n');
2118 ds_put_format(&string
,
2119 "(***truncated to %zu bytes from %"PRIu16
"***)\n",
2120 len
, ntohs(oh
->length
));
2121 } else if (ntohs(oh
->length
) < len
) {
2122 ds_put_format(&string
,
2123 "(***only uses %"PRIu16
" bytes out of %zu***)\n",
2124 ntohs(oh
->length
), len
);
2129 error
= ofpraw_decode(&raw
, oh
);
2131 ofp_to_string__(oh
, raw
, &string
, verbosity
);
2132 if (verbosity
>= 5) {
2133 if (ds_last(&string
) != '\n') {
2134 ds_put_char(&string
, '\n');
2136 ds_put_hex_dump(&string
, oh
, len
, 0, true);
2138 if (ds_last(&string
) != '\n') {
2139 ds_put_char(&string
, '\n');
2141 return ds_steal_cstr(&string
);
2144 ofp_print_error(&string
, error
);
2146 ds_put_hex_dump(&string
, oh
, len
, 0, true);
2147 return ds_steal_cstr(&string
);
2151 print_and_free(FILE *stream
, char *string
)
2153 fputs(string
, stream
);
2157 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
2158 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
2159 * numbers increase verbosity. */
2161 ofp_print(FILE *stream
, const void *oh
, size_t len
, int verbosity
)
2163 print_and_free(stream
, ofp_to_string(oh
, len
, verbosity
));
2166 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
2167 * 'data' to 'stream'. */
2169 ofp_print_packet(FILE *stream
, const void *data
, size_t len
)
2171 print_and_free(stream
, ofp_packet_to_string(data
, len
));