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
, 0, &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 struct ofputil_packet_in pin
;
93 error
= ofputil_decode_packet_in(&pin
, oh
);
95 ofp_print_error(string
, error
);
100 ds_put_format(string
, " table_id=%"PRIu8
, pin
.table_id
);
104 ds_put_format(string
, " cookie=0x%"PRIx64
, ntohll(pin
.cookie
));
107 ds_put_format(string
, " total_len=%"PRIu16
" in_port=", pin
.total_len
);
108 ofputil_format_port(pin
.fmd
.in_port
, string
);
110 if (pin
.fmd
.tun_id
!= htonll(0)) {
111 ds_put_format(string
, " tun_id=0x%"PRIx64
, ntohll(pin
.fmd
.tun_id
));
114 if (pin
.fmd
.tun_src
!= htonl(0)) {
115 ds_put_format(string
, " tun_src="IP_FMT
, IP_ARGS(pin
.fmd
.tun_src
));
118 if (pin
.fmd
.tun_dst
!= htonl(0)) {
119 ds_put_format(string
, " tun_dst="IP_FMT
, IP_ARGS(pin
.fmd
.tun_dst
));
122 if (pin
.fmd
.metadata
!= htonll(0)) {
123 ds_put_format(string
, " metadata=0x%"PRIx64
, ntohll(pin
.fmd
.metadata
));
126 for (i
= 0; i
< FLOW_N_REGS
; i
++) {
127 if (pin
.fmd
.regs
[i
]) {
128 ds_put_format(string
, " reg%d=0x%"PRIx32
, i
, pin
.fmd
.regs
[i
]);
132 ds_put_format(string
, " (via %s)",
133 ofputil_packet_in_reason_to_string(pin
.reason
));
135 ds_put_format(string
, " data_len=%zu", pin
.packet_len
);
136 if (pin
.buffer_id
== UINT32_MAX
) {
137 ds_put_format(string
, " (unbuffered)");
138 if (pin
.total_len
!= pin
.packet_len
) {
139 ds_put_format(string
, " (***total_len != data_len***)");
142 ds_put_format(string
, " buffer=0x%08"PRIx32
, pin
.buffer_id
);
143 if (pin
.total_len
< pin
.packet_len
) {
144 ds_put_format(string
, " (***total_len < data_len***)");
147 ds_put_char(string
, '\n');
150 char *packet
= ofp_packet_to_string(pin
.packet
, pin
.packet_len
);
151 ds_put_cstr(string
, packet
);
157 ofp_print_packet_out(struct ds
*string
, const struct ofp_header
*oh
,
160 struct ofputil_packet_out po
;
161 struct ofpbuf ofpacts
;
164 ofpbuf_init(&ofpacts
, 64);
165 error
= ofputil_decode_packet_out(&po
, oh
, &ofpacts
);
167 ofpbuf_uninit(&ofpacts
);
168 ofp_print_error(string
, error
);
172 ds_put_cstr(string
, " in_port=");
173 ofputil_format_port(po
.in_port
, string
);
175 ds_put_char(string
, ' ');
176 ofpacts_format(po
.ofpacts
, po
.ofpacts_len
, string
);
178 if (po
.buffer_id
== UINT32_MAX
) {
179 ds_put_format(string
, " data_len=%zu", po
.packet_len
);
180 if (verbosity
> 0 && po
.packet_len
> 0) {
181 char *packet
= ofp_packet_to_string(po
.packet
, po
.packet_len
);
182 ds_put_char(string
, '\n');
183 ds_put_cstr(string
, packet
);
187 ds_put_format(string
, " buffer=0x%08"PRIx32
, po
.buffer_id
);
190 ofpbuf_uninit(&ofpacts
);
193 /* qsort comparison function. */
195 compare_ports(const void *a_
, const void *b_
)
197 const struct ofputil_phy_port
*a
= a_
;
198 const struct ofputil_phy_port
*b
= b_
;
199 uint16_t ap
= a
->port_no
;
200 uint16_t bp
= b
->port_no
;
202 return ap
< bp
? -1 : ap
> bp
;
206 ofp_print_bit_names(struct ds
*string
, uint32_t bits
,
207 const char *(*bit_to_name
)(uint32_t bit
),
214 ds_put_cstr(string
, "0");
218 for (i
= 0; i
< 32; i
++) {
219 uint32_t bit
= UINT32_C(1) << i
;
222 const char *name
= bit_to_name(bit
);
225 ds_put_char(string
, separator
);
227 ds_put_cstr(string
, name
);
235 ds_put_char(string
, separator
);
237 ds_put_format(string
, "0x%"PRIx32
, bits
);
242 netdev_feature_to_name(uint32_t bit
)
244 enum netdev_features f
= bit
;
247 case NETDEV_F_10MB_HD
: return "10MB-HD";
248 case NETDEV_F_10MB_FD
: return "10MB-FD";
249 case NETDEV_F_100MB_HD
: return "100MB-HD";
250 case NETDEV_F_100MB_FD
: return "100MB-FD";
251 case NETDEV_F_1GB_HD
: return "1GB-HD";
252 case NETDEV_F_1GB_FD
: return "1GB-FD";
253 case NETDEV_F_10GB_FD
: return "10GB-FD";
254 case NETDEV_F_40GB_FD
: return "40GB-FD";
255 case NETDEV_F_100GB_FD
: return "100GB-FD";
256 case NETDEV_F_1TB_FD
: return "1TB-FD";
257 case NETDEV_F_OTHER
: return "OTHER";
258 case NETDEV_F_COPPER
: return "COPPER";
259 case NETDEV_F_FIBER
: return "FIBER";
260 case NETDEV_F_AUTONEG
: return "AUTO_NEG";
261 case NETDEV_F_PAUSE
: return "AUTO_PAUSE";
262 case NETDEV_F_PAUSE_ASYM
: return "AUTO_PAUSE_ASYM";
269 ofp_print_port_features(struct ds
*string
, enum netdev_features features
)
271 ofp_print_bit_names(string
, features
, netdev_feature_to_name
, ' ');
272 ds_put_char(string
, '\n');
276 ofputil_port_config_to_name(uint32_t bit
)
278 enum ofputil_port_config pc
= bit
;
281 case OFPUTIL_PC_PORT_DOWN
: return "PORT_DOWN";
282 case OFPUTIL_PC_NO_STP
: return "NO_STP";
283 case OFPUTIL_PC_NO_RECV
: return "NO_RECV";
284 case OFPUTIL_PC_NO_RECV_STP
: return "NO_RECV_STP";
285 case OFPUTIL_PC_NO_FLOOD
: return "NO_FLOOD";
286 case OFPUTIL_PC_NO_FWD
: return "NO_FWD";
287 case OFPUTIL_PC_NO_PACKET_IN
: return "NO_PACKET_IN";
294 ofp_print_port_config(struct ds
*string
, enum ofputil_port_config config
)
296 ofp_print_bit_names(string
, config
, ofputil_port_config_to_name
, ' ');
297 ds_put_char(string
, '\n');
301 ofputil_port_state_to_name(uint32_t bit
)
303 enum ofputil_port_state ps
= bit
;
306 case OFPUTIL_PS_LINK_DOWN
: return "LINK_DOWN";
307 case OFPUTIL_PS_BLOCKED
: return "BLOCKED";
308 case OFPUTIL_PS_LIVE
: return "LIVE";
310 case OFPUTIL_PS_STP_LISTEN
:
311 case OFPUTIL_PS_STP_LEARN
:
312 case OFPUTIL_PS_STP_FORWARD
:
313 case OFPUTIL_PS_STP_BLOCK
:
314 /* Handled elsewhere. */
322 ofp_print_port_state(struct ds
*string
, enum ofputil_port_state state
)
324 enum ofputil_port_state stp_state
;
326 /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
327 * pattern. We have to special case it.
329 * OVS doesn't support STP, so this field will always be 0 if we are
330 * talking to OVS, so we'd always print STP_LISTEN in that case.
331 * Therefore, we don't print anything at all if the value is STP_LISTEN, to
332 * avoid confusing users. */
333 stp_state
= state
& OFPUTIL_PS_STP_MASK
;
336 (stp_state
== OFPUTIL_PS_STP_LEARN
? "STP_LEARN"
337 : stp_state
== OFPUTIL_PS_STP_FORWARD
? "STP_FORWARD"
339 state
&= ~OFPUTIL_PS_STP_MASK
;
341 ofp_print_bit_names(string
, state
, ofputil_port_state_to_name
,
345 ofp_print_bit_names(string
, state
, ofputil_port_state_to_name
, ' ');
347 ds_put_char(string
, '\n');
351 ofp_print_phy_port(struct ds
*string
, const struct ofputil_phy_port
*port
)
353 char name
[sizeof port
->name
];
356 memcpy(name
, port
->name
, sizeof name
);
357 for (j
= 0; j
< sizeof name
- 1; j
++) {
358 if (!isprint((unsigned char) name
[j
])) {
364 ds_put_char(string
, ' ');
365 ofputil_format_port(port
->port_no
, string
);
366 ds_put_format(string
, "(%s): addr:"ETH_ADDR_FMT
"\n",
367 name
, ETH_ADDR_ARGS(port
->hw_addr
));
369 ds_put_cstr(string
, " config: ");
370 ofp_print_port_config(string
, port
->config
);
372 ds_put_cstr(string
, " state: ");
373 ofp_print_port_state(string
, port
->state
);
376 ds_put_format(string
, " current: ");
377 ofp_print_port_features(string
, port
->curr
);
379 if (port
->advertised
) {
380 ds_put_format(string
, " advertised: ");
381 ofp_print_port_features(string
, port
->advertised
);
383 if (port
->supported
) {
384 ds_put_format(string
, " supported: ");
385 ofp_print_port_features(string
, port
->supported
);
388 ds_put_format(string
, " peer: ");
389 ofp_print_port_features(string
, port
->peer
);
391 ds_put_format(string
, " speed: %"PRIu32
" Mbps now, "
392 "%"PRIu32
" Mbps max\n",
393 port
->curr_speed
/ UINT32_C(1000),
394 port
->max_speed
/ UINT32_C(1000));
397 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
398 * 'ofp_version', writes a detailed description of each port into
401 ofp_print_phy_ports(struct ds
*string
, uint8_t ofp_version
,
405 struct ofputil_phy_port
*ports
;
409 n_ports
= ofputil_count_phy_ports(ofp_version
, b
);
411 ports
= xmalloc(n_ports
* sizeof *ports
);
412 for (i
= 0; i
< n_ports
; i
++) {
413 error
= ofputil_pull_phy_port(ofp_version
, b
, &ports
[i
]);
415 ofp_print_error(string
, error
);
419 qsort(ports
, n_ports
, sizeof *ports
, compare_ports
);
420 for (i
= 0; i
< n_ports
; i
++) {
421 ofp_print_phy_port(string
, &ports
[i
]);
429 ofputil_capabilities_to_name(uint32_t bit
)
431 enum ofputil_capabilities capabilities
= bit
;
433 switch (capabilities
) {
434 case OFPUTIL_C_FLOW_STATS
: return "FLOW_STATS";
435 case OFPUTIL_C_TABLE_STATS
: return "TABLE_STATS";
436 case OFPUTIL_C_PORT_STATS
: return "PORT_STATS";
437 case OFPUTIL_C_IP_REASM
: return "IP_REASM";
438 case OFPUTIL_C_QUEUE_STATS
: return "QUEUE_STATS";
439 case OFPUTIL_C_ARP_MATCH_IP
: return "ARP_MATCH_IP";
440 case OFPUTIL_C_STP
: return "STP";
441 case OFPUTIL_C_GROUP_STATS
: return "GROUP_STATS";
442 case OFPUTIL_C_PORT_BLOCKED
: return "PORT_BLOCKED";
449 ofputil_action_bitmap_to_name(uint32_t bit
)
451 enum ofputil_action_bitmap action
= bit
;
454 case OFPUTIL_A_OUTPUT
: return "OUTPUT";
455 case OFPUTIL_A_SET_VLAN_VID
: return "SET_VLAN_VID";
456 case OFPUTIL_A_SET_VLAN_PCP
: return "SET_VLAN_PCP";
457 case OFPUTIL_A_STRIP_VLAN
: return "STRIP_VLAN";
458 case OFPUTIL_A_SET_DL_SRC
: return "SET_DL_SRC";
459 case OFPUTIL_A_SET_DL_DST
: return "SET_DL_DST";
460 case OFPUTIL_A_SET_NW_SRC
: return "SET_NW_SRC";
461 case OFPUTIL_A_SET_NW_DST
: return "SET_NW_DST";
462 case OFPUTIL_A_SET_NW_ECN
: return "SET_NW_ECN";
463 case OFPUTIL_A_SET_NW_TOS
: return "SET_NW_TOS";
464 case OFPUTIL_A_SET_TP_SRC
: return "SET_TP_SRC";
465 case OFPUTIL_A_SET_TP_DST
: return "SET_TP_DST";
466 case OFPUTIL_A_SET_FIELD
: return "SET_FIELD";
467 case OFPUTIL_A_ENQUEUE
: return "ENQUEUE";
468 case OFPUTIL_A_COPY_TTL_OUT
: return "COPY_TTL_OUT";
469 case OFPUTIL_A_COPY_TTL_IN
: return "COPY_TTL_IN";
470 case OFPUTIL_A_SET_MPLS_LABEL
: return "SET_MPLS_LABEL";
471 case OFPUTIL_A_SET_MPLS_TC
: return "SET_MPLS_TC";
472 case OFPUTIL_A_SET_MPLS_TTL
: return "SET_MPLS_TTL";
473 case OFPUTIL_A_DEC_MPLS_TTL
: return "DEC_MPLS_TTL";
474 case OFPUTIL_A_PUSH_VLAN
: return "PUSH_VLAN";
475 case OFPUTIL_A_POP_VLAN
: return "POP_VLAN";
476 case OFPUTIL_A_PUSH_MPLS
: return "PUSH_MPLS";
477 case OFPUTIL_A_POP_MPLS
: return "POP_MPLS";
478 case OFPUTIL_A_SET_QUEUE
: return "SET_QUEUE";
479 case OFPUTIL_A_GROUP
: return "GROUP";
480 case OFPUTIL_A_SET_NW_TTL
: return "SET_NW_TTL";
481 case OFPUTIL_A_DEC_NW_TTL
: return "DEC_NW_TTL";
488 ofp_print_switch_features(struct ds
*string
, const struct ofp_header
*oh
)
490 struct ofputil_switch_features features
;
494 error
= ofputil_decode_switch_features(oh
, &features
, &b
);
496 ofp_print_error(string
, error
);
500 ds_put_format(string
, " dpid:%016"PRIx64
"\n", features
.datapath_id
);
502 ds_put_format(string
, "n_tables:%"PRIu8
", n_buffers:%"PRIu32
,
503 features
.n_tables
, features
.n_buffers
);
504 if (features
.auxiliary_id
) {
505 ds_put_format(string
, ", auxiliary_id:%"PRIu8
, features
.auxiliary_id
);
507 ds_put_char(string
, '\n');
509 ds_put_cstr(string
, "capabilities: ");
510 ofp_print_bit_names(string
, features
.capabilities
,
511 ofputil_capabilities_to_name
, ' ');
512 ds_put_char(string
, '\n');
514 switch ((enum ofp_version
)oh
->version
) {
516 ds_put_cstr(string
, "actions: ");
517 ofp_print_bit_names(string
, features
.actions
,
518 ofputil_action_bitmap_to_name
, ' ');
519 ds_put_char(string
, '\n');
525 return; /* no ports in ofp13_switch_features */
530 ofp_print_phy_ports(string
, oh
->version
, &b
);
534 ofp_print_switch_config(struct ds
*string
, const struct ofp_switch_config
*osc
)
536 enum ofp_config_flags flags
;
538 flags
= ntohs(osc
->flags
);
540 ds_put_format(string
, " frags=%s", ofputil_frag_handling_to_string(flags
));
541 flags
&= ~OFPC_FRAG_MASK
;
543 if (flags
& OFPC_INVALID_TTL_TO_CONTROLLER
) {
544 ds_put_format(string
, " invalid_ttl_to_controller");
545 flags
&= ~OFPC_INVALID_TTL_TO_CONTROLLER
;
549 ds_put_format(string
, " ***unknown flags 0x%04"PRIx16
"***", flags
);
552 ds_put_format(string
, " miss_send_len=%"PRIu16
"\n", ntohs(osc
->miss_send_len
));
555 static void print_wild(struct ds
*string
, const char *leader
, int is_wild
,
556 int verbosity
, const char *format
, ...)
557 __attribute__((format(printf
, 5, 6)));
559 static void print_wild(struct ds
*string
, const char *leader
, int is_wild
,
560 int verbosity
, const char *format
, ...)
562 if (is_wild
&& verbosity
< 2) {
565 ds_put_cstr(string
, leader
);
569 va_start(args
, format
);
570 ds_put_format_valist(string
, format
, args
);
573 ds_put_char(string
, '*');
575 ds_put_char(string
, ',');
579 print_wild_port(struct ds
*string
, const char *leader
, int is_wild
,
580 int verbosity
, uint16_t port
)
582 if (is_wild
&& verbosity
< 2) {
585 ds_put_cstr(string
, leader
);
587 ofputil_format_port(port
, string
);
589 ds_put_char(string
, '*');
591 ds_put_char(string
, ',');
595 print_ip_netmask(struct ds
*string
, const char *leader
, ovs_be32 ip
,
596 uint32_t wild_bits
, int verbosity
)
598 if (wild_bits
>= 32 && verbosity
< 2) {
601 ds_put_cstr(string
, leader
);
602 if (wild_bits
< 32) {
603 ds_put_format(string
, IP_FMT
, IP_ARGS(ip
));
605 ds_put_format(string
, "/%d", 32 - wild_bits
);
608 ds_put_char(string
, '*');
610 ds_put_char(string
, ',');
614 ofp10_match_print(struct ds
*f
, const struct ofp10_match
*om
, int verbosity
)
616 char *s
= ofp10_match_to_string(om
, verbosity
);
622 ofp10_match_to_string(const struct ofp10_match
*om
, int verbosity
)
624 struct ds f
= DS_EMPTY_INITIALIZER
;
625 uint32_t w
= ntohl(om
->wildcards
);
626 bool skip_type
= false;
627 bool skip_proto
= false;
629 if (!(w
& OFPFW10_DL_TYPE
)) {
631 if (om
->dl_type
== htons(ETH_TYPE_IP
)) {
632 if (!(w
& OFPFW10_NW_PROTO
)) {
634 if (om
->nw_proto
== IPPROTO_ICMP
) {
635 ds_put_cstr(&f
, "icmp,");
636 } else if (om
->nw_proto
== IPPROTO_TCP
) {
637 ds_put_cstr(&f
, "tcp,");
638 } else if (om
->nw_proto
== IPPROTO_UDP
) {
639 ds_put_cstr(&f
, "udp,");
641 ds_put_cstr(&f
, "ip,");
645 ds_put_cstr(&f
, "ip,");
647 } else if (om
->dl_type
== htons(ETH_TYPE_ARP
)) {
648 ds_put_cstr(&f
, "arp,");
649 } else if (om
->dl_type
== htons(ETH_TYPE_RARP
)){
650 ds_put_cstr(&f
, "rarp,");
651 } else if (om
->dl_type
== htons(ETH_TYPE_MPLS
)) {
652 ds_put_cstr(&f
, "mpls,");
653 } else if (om
->dl_type
== htons(ETH_TYPE_MPLS_MCAST
)) {
654 ds_put_cstr(&f
, "mplsm,");
659 print_wild_port(&f
, "in_port=", w
& OFPFW10_IN_PORT
, verbosity
,
661 print_wild(&f
, "dl_vlan=", w
& OFPFW10_DL_VLAN
, verbosity
,
662 "%d", ntohs(om
->dl_vlan
));
663 print_wild(&f
, "dl_vlan_pcp=", w
& OFPFW10_DL_VLAN_PCP
, verbosity
,
664 "%d", om
->dl_vlan_pcp
);
665 print_wild(&f
, "dl_src=", w
& OFPFW10_DL_SRC
, verbosity
,
666 ETH_ADDR_FMT
, ETH_ADDR_ARGS(om
->dl_src
));
667 print_wild(&f
, "dl_dst=", w
& OFPFW10_DL_DST
, verbosity
,
668 ETH_ADDR_FMT
, ETH_ADDR_ARGS(om
->dl_dst
));
670 print_wild(&f
, "dl_type=", w
& OFPFW10_DL_TYPE
, verbosity
,
671 "0x%04x", ntohs(om
->dl_type
));
673 print_ip_netmask(&f
, "nw_src=", om
->nw_src
,
674 (w
& OFPFW10_NW_SRC_MASK
) >> OFPFW10_NW_SRC_SHIFT
,
676 print_ip_netmask(&f
, "nw_dst=", om
->nw_dst
,
677 (w
& OFPFW10_NW_DST_MASK
) >> OFPFW10_NW_DST_SHIFT
,
680 if (om
->dl_type
== htons(ETH_TYPE_ARP
) ||
681 om
->dl_type
== htons(ETH_TYPE_RARP
)) {
682 print_wild(&f
, "arp_op=", w
& OFPFW10_NW_PROTO
, verbosity
,
685 print_wild(&f
, "nw_proto=", w
& OFPFW10_NW_PROTO
, verbosity
,
689 print_wild(&f
, "nw_tos=", w
& OFPFW10_NW_TOS
, verbosity
,
691 if (om
->nw_proto
== IPPROTO_ICMP
) {
692 print_wild(&f
, "icmp_type=", w
& OFPFW10_ICMP_TYPE
, verbosity
,
693 "%d", ntohs(om
->tp_src
));
694 print_wild(&f
, "icmp_code=", w
& OFPFW10_ICMP_CODE
, verbosity
,
695 "%d", ntohs(om
->tp_dst
));
697 print_wild(&f
, "tp_src=", w
& OFPFW10_TP_SRC
, verbosity
,
698 "%d", ntohs(om
->tp_src
));
699 print_wild(&f
, "tp_dst=", w
& OFPFW10_TP_DST
, verbosity
,
700 "%d", ntohs(om
->tp_dst
));
702 if (ds_last(&f
) == ',') {
709 ofp_print_flow_flags(struct ds
*s
, uint16_t flags
)
711 if (flags
& OFPFF_SEND_FLOW_REM
) {
712 ds_put_cstr(s
, "send_flow_rem ");
714 if (flags
& OFPFF_CHECK_OVERLAP
) {
715 ds_put_cstr(s
, "check_overlap ");
717 if (flags
& OFPFF12_RESET_COUNTS
) {
718 ds_put_cstr(s
, "reset_counts ");
720 if (flags
& OFPFF13_NO_PKT_COUNTS
) {
721 ds_put_cstr(s
, "no_packet_counts ");
723 if (flags
& OFPFF13_NO_BYT_COUNTS
) {
724 ds_put_cstr(s
, "no_byte_counts ");
727 flags
&= ~(OFPFF_SEND_FLOW_REM
| OFPFF_CHECK_OVERLAP
728 | OFPFF12_RESET_COUNTS
729 | OFPFF13_NO_PKT_COUNTS
| OFPFF13_NO_BYT_COUNTS
);
731 ds_put_format(s
, "flags:0x%"PRIx16
" ", flags
);
736 ofp_print_flow_mod(struct ds
*s
, const struct ofp_header
*oh
, int verbosity
)
738 struct ofputil_flow_mod fm
;
739 struct ofpbuf ofpacts
;
743 enum ofputil_protocol protocol
;
745 protocol
= ofputil_protocol_from_ofp_version(oh
->version
);
746 protocol
= ofputil_protocol_set_tid(protocol
, true);
748 ofpbuf_init(&ofpacts
, 64);
749 error
= ofputil_decode_flow_mod(&fm
, oh
, protocol
, &ofpacts
);
751 ofpbuf_uninit(&ofpacts
);
752 ofp_print_error(s
, error
);
757 switch (fm
.command
) {
759 ds_put_cstr(s
, "ADD");
762 ds_put_cstr(s
, "MOD");
764 case OFPFC_MODIFY_STRICT
:
765 ds_put_cstr(s
, "MOD_STRICT");
768 ds_put_cstr(s
, "DEL");
770 case OFPFC_DELETE_STRICT
:
771 ds_put_cstr(s
, "DEL_STRICT");
774 ds_put_format(s
, "cmd:%d", fm
.command
);
776 if (fm
.table_id
!= 0) {
777 ds_put_format(s
, " table:%d", fm
.table_id
);
781 ofpraw_decode(&raw
, oh
);
782 if (verbosity
>= 3 && raw
== OFPRAW_OFPT10_FLOW_MOD
) {
783 const struct ofp10_flow_mod
*ofm
= ofpmsg_body(oh
);
784 ofp10_match_print(s
, &ofm
->match
, verbosity
);
786 /* ofp_print_match() doesn't print priority. */
787 need_priority
= true;
788 } else if (verbosity
>= 3 && raw
== OFPRAW_NXT_FLOW_MOD
) {
789 const struct nx_flow_mod
*nfm
= ofpmsg_body(oh
);
790 const void *nxm
= nfm
+ 1;
793 nxm_s
= nx_match_to_string(nxm
, ntohs(nfm
->match_len
));
794 ds_put_cstr(s
, nxm_s
);
797 /* nx_match_to_string() doesn't print priority. */
798 need_priority
= true;
800 match_format(&fm
.match
, s
, fm
.priority
);
802 /* match_format() does print priority. */
803 need_priority
= false;
806 if (ds_last(s
) != ' ') {
809 if (fm
.new_cookie
!= htonll(0) && fm
.new_cookie
!= htonll(UINT64_MAX
)) {
810 ds_put_format(s
, "cookie:0x%"PRIx64
" ", ntohll(fm
.new_cookie
));
812 if (fm
.cookie_mask
!= htonll(0)) {
813 ds_put_format(s
, "cookie:0x%"PRIx64
"/0x%"PRIx64
" ",
814 ntohll(fm
.cookie
), ntohll(fm
.cookie_mask
));
816 if (fm
.idle_timeout
!= OFP_FLOW_PERMANENT
) {
817 ds_put_format(s
, "idle:%"PRIu16
" ", fm
.idle_timeout
);
819 if (fm
.hard_timeout
!= OFP_FLOW_PERMANENT
) {
820 ds_put_format(s
, "hard:%"PRIu16
" ", fm
.hard_timeout
);
822 if (fm
.priority
!= OFP_DEFAULT_PRIORITY
&& need_priority
) {
823 ds_put_format(s
, "pri:%"PRIu16
" ", fm
.priority
);
825 if (fm
.buffer_id
!= UINT32_MAX
) {
826 ds_put_format(s
, "buf:0x%"PRIx32
" ", fm
.buffer_id
);
828 if (fm
.out_port
!= OFPP_ANY
) {
829 ds_put_format(s
, "out_port:");
830 ofputil_format_port(fm
.out_port
, s
);
834 ofp_print_flow_flags(s
, fm
.flags
);
837 ofpacts_format(fm
.ofpacts
, fm
.ofpacts_len
, s
);
838 ofpbuf_uninit(&ofpacts
);
842 ofp_print_duration(struct ds
*string
, unsigned int sec
, unsigned int nsec
)
844 ds_put_format(string
, "%u", sec
);
846 ds_put_format(string
, ".%09u", nsec
);
847 while (string
->string
[string
->length
- 1] == '0') {
851 ds_put_char(string
, 's');
855 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason
)
860 case OFPRR_IDLE_TIMEOUT
:
862 case OFPRR_HARD_TIMEOUT
:
866 case OFPRR_GROUP_DELETE
:
867 return "group_delete";
871 sprintf(s
, "%d", (int) reason
);
877 ofp_print_flow_removed(struct ds
*string
, const struct ofp_header
*oh
)
879 struct ofputil_flow_removed fr
;
882 error
= ofputil_decode_flow_removed(&fr
, oh
);
884 ofp_print_error(string
, error
);
888 ds_put_char(string
, ' ');
889 match_format(&fr
.match
, string
, fr
.priority
);
891 ds_put_format(string
, " reason=%s",
892 ofp_flow_removed_reason_to_string(fr
.reason
));
894 if (fr
.table_id
!= 255) {
895 ds_put_format(string
, " table_id=%"PRIu8
, fr
.table_id
);
898 if (fr
.cookie
!= htonll(0)) {
899 ds_put_format(string
, " cookie:0x%"PRIx64
, ntohll(fr
.cookie
));
901 ds_put_cstr(string
, " duration");
902 ofp_print_duration(string
, fr
.duration_sec
, fr
.duration_nsec
);
903 ds_put_format(string
, " idle%"PRIu16
, fr
.idle_timeout
);
904 if (fr
.hard_timeout
) {
905 /* The hard timeout was only added in OF1.2, so only print it if it is
906 * actually in use to avoid gratuitous change to the formatting. */
907 ds_put_format(string
, " hard%"PRIu16
, fr
.hard_timeout
);
909 ds_put_format(string
, " pkts%"PRIu64
" bytes%"PRIu64
"\n",
910 fr
.packet_count
, fr
.byte_count
);
914 ofp_print_port_mod(struct ds
*string
, const struct ofp_header
*oh
)
916 struct ofputil_port_mod pm
;
919 error
= ofputil_decode_port_mod(oh
, &pm
);
921 ofp_print_error(string
, error
);
925 ds_put_cstr(string
, "port: ");
926 ofputil_format_port(pm
.port_no
, string
);
927 ds_put_format(string
, ": addr:"ETH_ADDR_FMT
"\n",
928 ETH_ADDR_ARGS(pm
.hw_addr
));
930 ds_put_cstr(string
, " config: ");
931 ofp_print_port_config(string
, pm
.config
);
933 ds_put_cstr(string
, " mask: ");
934 ofp_print_port_config(string
, pm
.mask
);
936 ds_put_cstr(string
, " advertise: ");
938 ofp_print_port_features(string
, pm
.advertise
);
940 ds_put_cstr(string
, "UNCHANGED\n");
945 ofp_print_error(struct ds
*string
, enum ofperr error
)
947 if (string
->length
) {
948 ds_put_char(string
, ' ');
950 ds_put_format(string
, "***decode error: %s***\n", ofperr_get_name(error
));
954 ofp_print_hello(struct ds
*string
, const struct ofp_header
*oh
)
956 uint32_t allowed_versions
;
959 ok
= ofputil_decode_hello(oh
, &allowed_versions
);
961 ds_put_cstr(string
, "\n version bitmap: ");
962 ofputil_format_version_bitmap(string
, allowed_versions
);
965 ds_put_cstr(string
, "\n unknown data in hello:\n");
966 ds_put_hex_dump(string
, oh
, ntohs(oh
->length
), 0, true);
971 ofp_print_error_msg(struct ds
*string
, const struct ofp_header
*oh
)
973 size_t len
= ntohs(oh
->length
);
974 struct ofpbuf payload
;
978 error
= ofperr_decode_msg(oh
, &payload
);
980 ds_put_cstr(string
, "***decode error***");
981 ds_put_hex_dump(string
, oh
+ 1, len
- sizeof *oh
, 0, true);
985 ds_put_format(string
, " %s\n", ofperr_get_name(error
));
987 if (error
== OFPERR_OFPHFC_INCOMPATIBLE
|| error
== OFPERR_OFPHFC_EPERM
) {
988 ds_put_printable(string
, payload
.data
, payload
.size
);
990 s
= ofp_to_string(payload
.data
, payload
.size
, 1);
991 ds_put_cstr(string
, s
);
997 ofp_print_port_status(struct ds
*string
, const struct ofp_header
*oh
)
999 struct ofputil_port_status ps
;
1002 error
= ofputil_decode_port_status(oh
, &ps
);
1004 ofp_print_error(string
, error
);
1008 if (ps
.reason
== OFPPR_ADD
) {
1009 ds_put_format(string
, " ADD:");
1010 } else if (ps
.reason
== OFPPR_DELETE
) {
1011 ds_put_format(string
, " DEL:");
1012 } else if (ps
.reason
== OFPPR_MODIFY
) {
1013 ds_put_format(string
, " MOD:");
1016 ofp_print_phy_port(string
, &ps
.desc
);
1020 ofp_print_ofpst_desc_reply(struct ds
*string
, const struct ofp_header
*oh
)
1022 const struct ofp_desc_stats
*ods
= ofpmsg_body(oh
);
1024 ds_put_char(string
, '\n');
1025 ds_put_format(string
, "Manufacturer: %.*s\n",
1026 (int) sizeof ods
->mfr_desc
, ods
->mfr_desc
);
1027 ds_put_format(string
, "Hardware: %.*s\n",
1028 (int) sizeof ods
->hw_desc
, ods
->hw_desc
);
1029 ds_put_format(string
, "Software: %.*s\n",
1030 (int) sizeof ods
->sw_desc
, ods
->sw_desc
);
1031 ds_put_format(string
, "Serial Num: %.*s\n",
1032 (int) sizeof ods
->serial_num
, ods
->serial_num
);
1033 ds_put_format(string
, "DP Description: %.*s\n",
1034 (int) sizeof ods
->dp_desc
, ods
->dp_desc
);
1038 ofp_print_flow_stats_request(struct ds
*string
, const struct ofp_header
*oh
)
1040 struct ofputil_flow_stats_request fsr
;
1043 error
= ofputil_decode_flow_stats_request(&fsr
, oh
);
1045 ofp_print_error(string
, error
);
1049 if (fsr
.table_id
!= 0xff) {
1050 ds_put_format(string
, " table=%"PRIu8
, fsr
.table_id
);
1053 if (fsr
.out_port
!= OFPP_ANY
) {
1054 ds_put_cstr(string
, " out_port=");
1055 ofputil_format_port(fsr
.out_port
, string
);
1058 ds_put_char(string
, ' ');
1059 match_format(&fsr
.match
, string
, OFP_DEFAULT_PRIORITY
);
1063 ofp_print_flow_stats(struct ds
*string
, struct ofputil_flow_stats
*fs
)
1065 ds_put_format(string
, " cookie=0x%"PRIx64
", duration=",
1066 ntohll(fs
->cookie
));
1068 ofp_print_duration(string
, fs
->duration_sec
, fs
->duration_nsec
);
1069 ds_put_format(string
, ", table=%"PRIu8
", ", fs
->table_id
);
1070 ds_put_format(string
, "n_packets=%"PRIu64
", ", fs
->packet_count
);
1071 ds_put_format(string
, "n_bytes=%"PRIu64
", ", fs
->byte_count
);
1072 if (fs
->idle_timeout
!= OFP_FLOW_PERMANENT
) {
1073 ds_put_format(string
, "idle_timeout=%"PRIu16
", ", fs
->idle_timeout
);
1075 if (fs
->hard_timeout
!= OFP_FLOW_PERMANENT
) {
1076 ds_put_format(string
, "hard_timeout=%"PRIu16
", ", fs
->hard_timeout
);
1079 ofp_print_flow_flags(string
, fs
->flags
);
1081 if (fs
->idle_age
>= 0) {
1082 ds_put_format(string
, "idle_age=%d, ", fs
->idle_age
);
1084 if (fs
->hard_age
>= 0 && fs
->hard_age
!= fs
->duration_sec
) {
1085 ds_put_format(string
, "hard_age=%d, ", fs
->hard_age
);
1088 match_format(&fs
->match
, string
, fs
->priority
);
1089 if (string
->string
[string
->length
- 1] != ' ') {
1090 ds_put_char(string
, ' ');
1093 ofpacts_format(fs
->ofpacts
, fs
->ofpacts_len
, string
);
1097 ofp_print_flow_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1099 struct ofpbuf ofpacts
;
1102 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1103 ofpbuf_init(&ofpacts
, 64);
1105 struct ofputil_flow_stats fs
;
1108 retval
= ofputil_decode_flow_stats_reply(&fs
, &b
, true, &ofpacts
);
1110 if (retval
!= EOF
) {
1111 ds_put_cstr(string
, " ***parse error***");
1115 ds_put_char(string
, '\n');
1116 ofp_print_flow_stats(string
, &fs
);
1118 ofpbuf_uninit(&ofpacts
);
1122 ofp_print_aggregate_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1124 struct ofputil_aggregate_stats as
;
1127 error
= ofputil_decode_aggregate_stats_reply(&as
, oh
);
1129 ofp_print_error(string
, error
);
1133 ds_put_format(string
, " packet_count=%"PRIu64
, as
.packet_count
);
1134 ds_put_format(string
, " byte_count=%"PRIu64
, as
.byte_count
);
1135 ds_put_format(string
, " flow_count=%"PRIu32
, as
.flow_count
);
1139 print_port_stat(struct ds
*string
, const char *leader
, uint64_t stat
, int more
)
1141 ds_put_cstr(string
, leader
);
1142 if (stat
!= UINT64_MAX
) {
1143 ds_put_format(string
, "%"PRIu64
, stat
);
1145 ds_put_char(string
, '?');
1148 ds_put_cstr(string
, ", ");
1150 ds_put_cstr(string
, "\n");
1155 ofp_print_ofpst_port_request(struct ds
*string
, const struct ofp_header
*oh
)
1157 uint16_t ofp10_port
;
1160 error
= ofputil_decode_port_stats_request(oh
, &ofp10_port
);
1162 ofp_print_error(string
, error
);
1166 ds_put_cstr(string
, " port_no=");
1167 ofputil_format_port(ofp10_port
, string
);
1171 ofp_print_ofpst_port_reply(struct ds
*string
, const struct ofp_header
*oh
,
1176 ds_put_format(string
, " %zu ports\n", ofputil_count_port_stats(oh
));
1177 if (verbosity
< 1) {
1181 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1183 struct ofputil_port_stats ps
;
1186 retval
= ofputil_decode_port_stats(&ps
, &b
);
1188 if (retval
!= EOF
) {
1189 ds_put_cstr(string
, " ***parse error***");
1194 ds_put_cstr(string
, " port ");
1195 if (ps
.port_no
< 10) {
1196 ds_put_char(string
, ' ');
1198 ofputil_format_port(ps
.port_no
, string
);
1200 ds_put_cstr(string
, ": rx ");
1201 print_port_stat(string
, "pkts=", ps
.stats
.rx_packets
, 1);
1202 print_port_stat(string
, "bytes=", ps
.stats
.rx_bytes
, 1);
1203 print_port_stat(string
, "drop=", ps
.stats
.rx_dropped
, 1);
1204 print_port_stat(string
, "errs=", ps
.stats
.rx_errors
, 1);
1205 print_port_stat(string
, "frame=", ps
.stats
.rx_frame_errors
, 1);
1206 print_port_stat(string
, "over=", ps
.stats
.rx_over_errors
, 1);
1207 print_port_stat(string
, "crc=", ps
.stats
.rx_crc_errors
, 0);
1209 ds_put_cstr(string
, " tx ");
1210 print_port_stat(string
, "pkts=", ps
.stats
.tx_packets
, 1);
1211 print_port_stat(string
, "bytes=", ps
.stats
.tx_bytes
, 1);
1212 print_port_stat(string
, "drop=", ps
.stats
.tx_dropped
, 1);
1213 print_port_stat(string
, "errs=", ps
.stats
.tx_errors
, 1);
1214 print_port_stat(string
, "coll=", ps
.stats
.collisions
, 0);
1219 ofp_print_one_ofpst_table_reply(struct ds
*string
, enum ofp_version ofp_version
,
1220 const char *name
, struct ofp12_table_stats
*ts
)
1222 char name_
[OFP_MAX_TABLE_NAME_LEN
+ 1];
1224 /* ofp13_table_stats is different */
1225 if (ofp_version
> OFP12_VERSION
) {
1229 ovs_strlcpy(name_
, name
, sizeof name_
);
1231 ds_put_format(string
, " %d: %-8s: ", ts
->table_id
, name_
);
1232 ds_put_format(string
, "wild=0x%05"PRIx64
", ", ntohll(ts
->wildcards
));
1233 ds_put_format(string
, "max=%6"PRIu32
", ", ntohl(ts
->max_entries
));
1234 ds_put_format(string
, "active=%"PRIu32
"\n", ntohl(ts
->active_count
));
1235 ds_put_cstr(string
, " ");
1236 ds_put_format(string
, "lookup=%"PRIu64
", ", ntohll(ts
->lookup_count
));
1237 ds_put_format(string
, "matched=%"PRIu64
"\n", ntohll(ts
->matched_count
));
1239 if (ofp_version
< OFP11_VERSION
) {
1243 ds_put_cstr(string
, " ");
1244 ds_put_format(string
, "match=0x%08"PRIx64
", ", ntohll(ts
->match
));
1245 ds_put_format(string
, "instructions=0x%08"PRIx32
", ",
1246 ntohl(ts
->instructions
));
1247 ds_put_format(string
, "config=0x%08"PRIx32
"\n", ntohl(ts
->config
));
1248 ds_put_cstr(string
, " ");
1249 ds_put_format(string
, "write_actions=0x%08"PRIx32
", ",
1250 ntohl(ts
->write_actions
));
1251 ds_put_format(string
, "apply_actions=0x%08"PRIx32
"\n",
1252 ntohl(ts
->apply_actions
));
1254 if (ofp_version
< OFP12_VERSION
) {
1258 ds_put_cstr(string
, " ");
1259 ds_put_format(string
, "write_setfields=0x%016"PRIx64
"\n",
1260 ntohll(ts
->write_setfields
));
1261 ds_put_cstr(string
, " ");
1262 ds_put_format(string
, "apply_setfields=0x%016"PRIx64
"\n",
1263 ntohll(ts
->apply_setfields
));
1264 ds_put_cstr(string
, " ");
1265 ds_put_format(string
, "metadata_match=0x%016"PRIx64
"\n",
1266 ntohll(ts
->metadata_match
));
1267 ds_put_cstr(string
, " ");
1268 ds_put_format(string
, "metadata_write=0x%016"PRIx64
"\n",
1269 ntohll(ts
->metadata_write
));
1273 ofp_print_ofpst_table_reply13(struct ds
*string
, const struct ofp_header
*oh
,
1276 struct ofp13_table_stats
*ts
;
1280 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1281 ofpraw_pull_assert(&b
);
1283 n
= b
.size
/ sizeof *ts
;
1284 ds_put_format(string
, " %zu tables\n", n
);
1285 if (verbosity
< 1) {
1290 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1294 ds_put_format(string
,
1295 " %d: active=%"PRIu32
", lookup=%"PRIu64 \
1296 ", matched=%"PRIu64
"\n",
1297 ts
->table_id
, ntohl(ts
->active_count
),
1298 ntohll(ts
->lookup_count
), ntohll(ts
->matched_count
));
1303 ofp_print_ofpst_table_reply12(struct ds
*string
, const struct ofp_header
*oh
,
1306 struct ofp12_table_stats
*ts
;
1310 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1311 ofpraw_pull_assert(&b
);
1313 n
= b
.size
/ sizeof *ts
;
1314 ds_put_format(string
, " %zu tables\n", n
);
1315 if (verbosity
< 1) {
1320 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1325 ofp_print_one_ofpst_table_reply(string
, OFP12_VERSION
, ts
->name
, ts
);
1330 ofp_print_ofpst_table_reply11(struct ds
*string
, const struct ofp_header
*oh
,
1333 struct ofp11_table_stats
*ts
;
1337 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1338 ofpraw_pull_assert(&b
);
1340 n
= b
.size
/ sizeof *ts
;
1341 ds_put_format(string
, " %zu tables\n", n
);
1342 if (verbosity
< 1) {
1347 struct ofp12_table_stats ts12
;
1349 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1354 ts12
.table_id
= ts
->table_id
;
1355 ts12
.wildcards
= htonll(ntohl(ts
->wildcards
));
1356 ts12
.max_entries
= ts
->max_entries
;
1357 ts12
.active_count
= ts
->active_count
;
1358 ts12
.lookup_count
= ts
->lookup_count
;
1359 ts12
.matched_count
= ts
->matched_count
;
1360 ts12
.match
= htonll(ntohl(ts
->match
));
1361 ts12
.instructions
= ts
->instructions
;
1362 ts12
.config
= ts
->config
;
1363 ts12
.write_actions
= ts
->write_actions
;
1364 ts12
.apply_actions
= ts
->apply_actions
;
1365 ofp_print_one_ofpst_table_reply(string
, OFP11_VERSION
, ts
->name
, &ts12
);
1370 ofp_print_ofpst_table_reply10(struct ds
*string
, const struct ofp_header
*oh
,
1373 struct ofp10_table_stats
*ts
;
1377 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1378 ofpraw_pull_assert(&b
);
1380 n
= b
.size
/ sizeof *ts
;
1381 ds_put_format(string
, " %zu tables\n", n
);
1382 if (verbosity
< 1) {
1387 struct ofp12_table_stats ts12
;
1389 ts
= ofpbuf_try_pull(&b
, sizeof *ts
);
1394 ts12
.table_id
= ts
->table_id
;
1395 ts12
.wildcards
= htonll(ntohl(ts
->wildcards
));
1396 ts12
.max_entries
= ts
->max_entries
;
1397 ts12
.active_count
= ts
->active_count
;
1398 ts12
.lookup_count
= get_32aligned_be64(&ts
->lookup_count
);
1399 ts12
.matched_count
= get_32aligned_be64(&ts
->matched_count
);
1400 ofp_print_one_ofpst_table_reply(string
, OFP10_VERSION
, ts
->name
, &ts12
);
1405 ofp_print_ofpst_table_reply(struct ds
*string
, const struct ofp_header
*oh
,
1408 switch ((enum ofp_version
)oh
->version
) {
1410 ofp_print_ofpst_table_reply13(string
, oh
, verbosity
);
1414 ofp_print_ofpst_table_reply12(string
, oh
, verbosity
);
1418 ofp_print_ofpst_table_reply11(string
, oh
, verbosity
);
1422 ofp_print_ofpst_table_reply10(string
, oh
, verbosity
);
1431 ofp_print_queue_name(struct ds
*string
, uint32_t queue_id
)
1433 if (queue_id
== OFPQ_ALL
) {
1434 ds_put_cstr(string
, "ALL");
1436 ds_put_format(string
, "%"PRIu32
, queue_id
);
1441 ofp_print_ofpst_queue_request(struct ds
*string
, const struct ofp_header
*oh
)
1443 struct ofputil_queue_stats_request oqsr
;
1446 error
= ofputil_decode_queue_stats_request(oh
, &oqsr
);
1448 ds_put_format(string
, "***decode error: %s***\n", ofperr_get_name(error
));
1452 ds_put_cstr(string
, "port=");
1453 ofputil_format_port(oqsr
.port_no
, string
);
1455 ds_put_cstr(string
, " queue=");
1456 ofp_print_queue_name(string
, oqsr
.queue_id
);
1460 ofp_print_ofpst_queue_reply(struct ds
*string
, const struct ofp_header
*oh
,
1465 ds_put_format(string
, " %zu queues\n", ofputil_count_queue_stats(oh
));
1466 if (verbosity
< 1) {
1470 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1472 struct ofputil_queue_stats qs
;
1475 retval
= ofputil_decode_queue_stats(&qs
, &b
);
1477 if (retval
!= EOF
) {
1478 ds_put_cstr(string
, " ***parse error***");
1483 ds_put_cstr(string
, " port ");
1484 ofputil_format_port(qs
.port_no
, string
);
1485 ds_put_cstr(string
, " queue ");
1486 ofp_print_queue_name(string
, qs
.queue_id
);
1487 ds_put_cstr(string
, ": ");
1489 print_port_stat(string
, "bytes=", qs
.stats
.tx_bytes
, 1);
1490 print_port_stat(string
, "pkts=", qs
.stats
.tx_packets
, 1);
1491 print_port_stat(string
, "errors=", qs
.stats
.tx_errors
, 0);
1496 ofp_print_ofpst_port_desc_reply(struct ds
*string
,
1497 const struct ofp_header
*oh
)
1501 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1502 ofpraw_pull_assert(&b
);
1503 ds_put_char(string
, '\n');
1504 ofp_print_phy_ports(string
, oh
->version
, &b
);
1508 ofp_print_stats_request(struct ds
*string
, const struct ofp_header
*oh
)
1510 uint16_t flags
= ofpmp_flags(oh
);
1513 ds_put_format(string
, " ***unknown flags 0x%04"PRIx16
"***", flags
);
1518 ofp_print_stats_reply(struct ds
*string
, const struct ofp_header
*oh
)
1520 uint16_t flags
= ofpmp_flags(oh
);
1523 ds_put_cstr(string
, " flags=");
1524 if (flags
& OFPSF_REPLY_MORE
) {
1525 ds_put_cstr(string
, "[more]");
1526 flags
&= ~OFPSF_REPLY_MORE
;
1529 ds_put_format(string
, "[***unknown flags 0x%04"PRIx16
"***]",
1536 ofp_print_echo(struct ds
*string
, const struct ofp_header
*oh
, int verbosity
)
1538 size_t len
= ntohs(oh
->length
);
1540 ds_put_format(string
, " %zu bytes of payload\n", len
- sizeof *oh
);
1541 if (verbosity
> 1) {
1542 ds_put_hex_dump(string
, oh
+ 1, len
- sizeof *oh
, 0, true);
1547 ofp_print_role_message(struct ds
*string
, const struct ofp_header
*oh
)
1549 struct ofputil_role_request rr
;
1552 error
= ofputil_decode_role_message(oh
, &rr
);
1554 ofp_print_error(string
, error
);
1558 ds_put_cstr(string
, " role=");
1561 case OFPCR12_ROLE_NOCHANGE
:
1562 ds_put_cstr(string
, "nochange");
1564 case OFPCR12_ROLE_EQUAL
:
1565 ds_put_cstr(string
, "equal"); /* OF 1.2 wording */
1567 case OFPCR12_ROLE_MASTER
:
1568 ds_put_cstr(string
, "master");
1570 case OFPCR12_ROLE_SLAVE
:
1571 ds_put_cstr(string
, "slave");
1577 if (rr
.have_generation_id
) {
1578 ds_put_format(string
, " generation_id=%"PRIu64
, rr
.generation_id
);
1583 ofp_print_nxt_flow_mod_table_id(struct ds
*string
,
1584 const struct nx_flow_mod_table_id
*nfmti
)
1586 ds_put_format(string
, " %s", nfmti
->set
? "enable" : "disable");
1590 ofp_print_nxt_set_flow_format(struct ds
*string
,
1591 const struct nx_set_flow_format
*nsff
)
1593 uint32_t format
= ntohl(nsff
->format
);
1595 ds_put_cstr(string
, " format=");
1596 if (ofputil_nx_flow_format_is_valid(format
)) {
1597 ds_put_cstr(string
, ofputil_nx_flow_format_to_string(format
));
1599 ds_put_format(string
, "%"PRIu32
, format
);
1604 ofp_print_nxt_set_packet_in_format(struct ds
*string
,
1605 const struct nx_set_packet_in_format
*nspf
)
1607 uint32_t format
= ntohl(nspf
->format
);
1609 ds_put_cstr(string
, " format=");
1610 if (ofputil_packet_in_format_is_valid(format
)) {
1611 ds_put_cstr(string
, ofputil_packet_in_format_to_string(format
));
1613 ds_put_format(string
, "%"PRIu32
, format
);
1618 ofp_port_reason_to_string(enum ofp_port_reason reason
)
1633 sprintf(s
, "%d", (int) reason
);
1639 ofp_print_nxt_set_async_config(struct ds
*string
,
1640 const struct nx_async_config
*nac
)
1644 for (i
= 0; i
< 2; i
++) {
1647 ds_put_format(string
, "\n %s:\n", i
== 0 ? "master" : "slave");
1649 ds_put_cstr(string
, " PACKET_IN:");
1650 for (j
= 0; j
< 32; j
++) {
1651 if (nac
->packet_in_mask
[i
] & htonl(1u << j
)) {
1652 ds_put_format(string
, " %s",
1653 ofputil_packet_in_reason_to_string(j
));
1656 if (!nac
->packet_in_mask
[i
]) {
1657 ds_put_cstr(string
, " (off)");
1659 ds_put_char(string
, '\n');
1661 ds_put_cstr(string
, " PORT_STATUS:");
1662 for (j
= 0; j
< 32; j
++) {
1663 if (nac
->port_status_mask
[i
] & htonl(1u << j
)) {
1664 ds_put_format(string
, " %s", ofp_port_reason_to_string(j
));
1667 if (!nac
->port_status_mask
[i
]) {
1668 ds_put_cstr(string
, " (off)");
1670 ds_put_char(string
, '\n');
1672 ds_put_cstr(string
, " FLOW_REMOVED:");
1673 for (j
= 0; j
< 32; j
++) {
1674 if (nac
->flow_removed_mask
[i
] & htonl(1u << j
)) {
1675 ds_put_format(string
, " %s",
1676 ofp_flow_removed_reason_to_string(j
));
1679 if (!nac
->flow_removed_mask
[i
]) {
1680 ds_put_cstr(string
, " (off)");
1682 ds_put_char(string
, '\n');
1687 ofp_print_nxt_set_controller_id(struct ds
*string
,
1688 const struct nx_controller_id
*nci
)
1690 ds_put_format(string
, " id=%"PRIu16
, ntohs(nci
->controller_id
));
1694 ofp_print_nxt_flow_monitor_cancel(struct ds
*string
,
1695 const struct ofp_header
*oh
)
1697 ds_put_format(string
, " id=%"PRIu32
,
1698 ofputil_decode_flow_monitor_cancel(oh
));
1702 nx_flow_monitor_flags_to_name(uint32_t bit
)
1704 enum nx_flow_monitor_flags fmf
= bit
;
1707 case NXFMF_INITIAL
: return "initial";
1708 case NXFMF_ADD
: return "add";
1709 case NXFMF_DELETE
: return "delete";
1710 case NXFMF_MODIFY
: return "modify";
1711 case NXFMF_ACTIONS
: return "actions";
1712 case NXFMF_OWN
: return "own";
1719 ofp_print_nxst_flow_monitor_request(struct ds
*string
,
1720 const struct ofp_header
*oh
)
1724 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1726 struct ofputil_flow_monitor_request request
;
1729 retval
= ofputil_decode_flow_monitor_request(&request
, &b
);
1731 if (retval
!= EOF
) {
1732 ofp_print_error(string
, retval
);
1737 ds_put_format(string
, "\n id=%"PRIu32
" flags=", request
.id
);
1738 ofp_print_bit_names(string
, request
.flags
,
1739 nx_flow_monitor_flags_to_name
, ',');
1741 if (request
.out_port
!= OFPP_NONE
) {
1742 ds_put_cstr(string
, " out_port=");
1743 ofputil_format_port(request
.out_port
, string
);
1746 if (request
.table_id
!= 0xff) {
1747 ds_put_format(string
, " table=%"PRIu8
, request
.table_id
);
1750 ds_put_char(string
, ' ');
1751 match_format(&request
.match
, string
, OFP_DEFAULT_PRIORITY
);
1752 ds_chomp(string
, ' ');
1757 ofp_print_nxst_flow_monitor_reply(struct ds
*string
,
1758 const struct ofp_header
*oh
)
1760 uint64_t ofpacts_stub
[1024 / 8];
1761 struct ofpbuf ofpacts
;
1764 ofpbuf_use_const(&b
, oh
, ntohs(oh
->length
));
1765 ofpbuf_use_stub(&ofpacts
, ofpacts_stub
, sizeof ofpacts_stub
);
1767 struct ofputil_flow_update update
;
1771 update
.match
= &match
;
1772 retval
= ofputil_decode_flow_update(&update
, &b
, &ofpacts
);
1774 if (retval
!= EOF
) {
1775 ofp_print_error(string
, retval
);
1777 ofpbuf_uninit(&ofpacts
);
1781 ds_put_cstr(string
, "\n event=");
1782 switch (update
.event
) {
1784 ds_put_cstr(string
, "ADDED");
1788 ds_put_format(string
, "DELETED reason=%s",
1789 ofp_flow_removed_reason_to_string(update
.reason
));
1792 case NXFME_MODIFIED
:
1793 ds_put_cstr(string
, "MODIFIED");
1797 ds_put_format(string
, "ABBREV xid=0x%"PRIx32
, ntohl(update
.xid
));
1801 ds_put_format(string
, " table=%"PRIu8
, update
.table_id
);
1802 if (update
.idle_timeout
!= OFP_FLOW_PERMANENT
) {
1803 ds_put_format(string
, " idle_timeout=%"PRIu16
,
1804 update
.idle_timeout
);
1806 if (update
.hard_timeout
!= OFP_FLOW_PERMANENT
) {
1807 ds_put_format(string
, " hard_timeout=%"PRIu16
,
1808 update
.hard_timeout
);
1810 ds_put_format(string
, " cookie=%#"PRIx64
, ntohll(update
.cookie
));
1812 ds_put_char(string
, ' ');
1813 match_format(update
.match
, string
, OFP_DEFAULT_PRIORITY
);
1815 if (update
.ofpacts_len
) {
1816 if (string
->string
[string
->length
- 1] != ' ') {
1817 ds_put_char(string
, ' ');
1819 ofpacts_format(update
.ofpacts
, update
.ofpacts_len
, string
);
1825 ofp_print_version(const struct ofp_header
*oh
,
1828 switch (oh
->version
) {
1832 ds_put_cstr(string
, " (OF1.1)");
1835 ds_put_cstr(string
, " (OF1.2)");
1838 ds_put_cstr(string
, " (OF1.3)");
1841 ds_put_format(string
, " (OF 0x%02"PRIx8
")", oh
->version
);
1844 ds_put_format(string
, " (xid=0x%"PRIx32
"):", ntohl(oh
->xid
));
1848 ofp_header_to_string__(const struct ofp_header
*oh
, enum ofpraw raw
,
1851 ds_put_cstr(string
, ofpraw_get_name(raw
));
1852 ofp_print_version(oh
, string
);
1856 ofp_print_not_implemented(struct ds
*string
)
1858 ds_put_cstr(string
, "NOT IMPLEMENTED YET!\n");
1862 ofp_to_string__(const struct ofp_header
*oh
, enum ofpraw raw
,
1863 struct ds
*string
, int verbosity
)
1865 const void *msg
= oh
;
1867 ofp_header_to_string__(oh
, raw
, string
);
1868 switch (ofptype_from_ofpraw(raw
)) {
1870 /* FIXME: Change the following once they are implemented: */
1871 case OFPTYPE_QUEUE_GET_CONFIG_REQUEST
:
1872 case OFPTYPE_QUEUE_GET_CONFIG_REPLY
:
1873 case OFPTYPE_GET_ASYNC_REQUEST
:
1874 case OFPTYPE_GET_ASYNC_REPLY
:
1875 case OFPTYPE_METER_MOD
:
1876 case OFPTYPE_GROUP_REQUEST
:
1877 case OFPTYPE_GROUP_REPLY
:
1878 case OFPTYPE_GROUP_DESC_REQUEST
:
1879 case OFPTYPE_GROUP_DESC_REPLY
:
1880 case OFPTYPE_GROUP_FEATURES_REQUEST
:
1881 case OFPTYPE_GROUP_FEATURES_REPLY
:
1882 case OFPTYPE_METER_REQUEST
:
1883 case OFPTYPE_METER_REPLY
:
1884 case OFPTYPE_METER_CONFIG_REQUEST
:
1885 case OFPTYPE_METER_CONFIG_REPLY
:
1886 case OFPTYPE_METER_FEATURES_REQUEST
:
1887 case OFPTYPE_METER_FEATURES_REPLY
:
1888 case OFPTYPE_TABLE_FEATURES_REQUEST
:
1889 case OFPTYPE_TABLE_FEATURES_REPLY
:
1890 ofp_print_not_implemented(string
);
1894 ofp_print_hello(string
, oh
);
1898 ofp_print_error_msg(string
, oh
);
1901 case OFPTYPE_ECHO_REQUEST
:
1902 case OFPTYPE_ECHO_REPLY
:
1903 ofp_print_echo(string
, oh
, verbosity
);
1906 case OFPTYPE_FEATURES_REQUEST
:
1909 case OFPTYPE_FEATURES_REPLY
:
1910 ofp_print_switch_features(string
, oh
);
1913 case OFPTYPE_GET_CONFIG_REQUEST
:
1916 case OFPTYPE_GET_CONFIG_REPLY
:
1917 case OFPTYPE_SET_CONFIG
:
1918 ofp_print_switch_config(string
, ofpmsg_body(oh
));
1921 case OFPTYPE_PACKET_IN
:
1922 ofp_print_packet_in(string
, oh
, verbosity
);
1925 case OFPTYPE_FLOW_REMOVED
:
1926 ofp_print_flow_removed(string
, oh
);
1929 case OFPTYPE_PORT_STATUS
:
1930 ofp_print_port_status(string
, oh
);
1933 case OFPTYPE_PACKET_OUT
:
1934 ofp_print_packet_out(string
, oh
, verbosity
);
1937 case OFPTYPE_FLOW_MOD
:
1938 ofp_print_flow_mod(string
, oh
, verbosity
);
1941 case OFPTYPE_PORT_MOD
:
1942 ofp_print_port_mod(string
, oh
);
1945 case OFPTYPE_BARRIER_REQUEST
:
1946 case OFPTYPE_BARRIER_REPLY
:
1949 case OFPTYPE_ROLE_REQUEST
:
1950 case OFPTYPE_ROLE_REPLY
:
1951 ofp_print_role_message(string
, oh
);
1954 case OFPTYPE_DESC_STATS_REQUEST
:
1955 case OFPTYPE_PORT_DESC_STATS_REQUEST
:
1956 ofp_print_stats_request(string
, oh
);
1959 case OFPTYPE_FLOW_STATS_REQUEST
:
1960 case OFPTYPE_AGGREGATE_STATS_REQUEST
:
1961 ofp_print_stats_request(string
, oh
);
1962 ofp_print_flow_stats_request(string
, oh
);
1965 case OFPTYPE_TABLE_STATS_REQUEST
:
1966 ofp_print_stats_request(string
, oh
);
1969 case OFPTYPE_PORT_STATS_REQUEST
:
1970 ofp_print_stats_request(string
, oh
);
1971 ofp_print_ofpst_port_request(string
, oh
);
1974 case OFPTYPE_QUEUE_STATS_REQUEST
:
1975 ofp_print_stats_request(string
, oh
);
1976 ofp_print_ofpst_queue_request(string
, oh
);
1979 case OFPTYPE_DESC_STATS_REPLY
:
1980 ofp_print_stats_reply(string
, oh
);
1981 ofp_print_ofpst_desc_reply(string
, oh
);
1984 case OFPTYPE_FLOW_STATS_REPLY
:
1985 ofp_print_stats_reply(string
, oh
);
1986 ofp_print_flow_stats_reply(string
, oh
);
1989 case OFPTYPE_QUEUE_STATS_REPLY
:
1990 ofp_print_stats_reply(string
, oh
);
1991 ofp_print_ofpst_queue_reply(string
, oh
, verbosity
);
1994 case OFPTYPE_PORT_STATS_REPLY
:
1995 ofp_print_stats_reply(string
, oh
);
1996 ofp_print_ofpst_port_reply(string
, oh
, verbosity
);
1999 case OFPTYPE_TABLE_STATS_REPLY
:
2000 ofp_print_stats_reply(string
, oh
);
2001 ofp_print_ofpst_table_reply(string
, oh
, verbosity
);
2004 case OFPTYPE_AGGREGATE_STATS_REPLY
:
2005 ofp_print_stats_reply(string
, oh
);
2006 ofp_print_aggregate_stats_reply(string
, oh
);
2009 case OFPTYPE_PORT_DESC_STATS_REPLY
:
2010 ofp_print_stats_reply(string
, oh
);
2011 ofp_print_ofpst_port_desc_reply(string
, oh
);
2014 case OFPTYPE_FLOW_MOD_TABLE_ID
:
2015 ofp_print_nxt_flow_mod_table_id(string
, ofpmsg_body(oh
));
2018 case OFPTYPE_SET_FLOW_FORMAT
:
2019 ofp_print_nxt_set_flow_format(string
, ofpmsg_body(oh
));
2022 case OFPTYPE_SET_PACKET_IN_FORMAT
:
2023 ofp_print_nxt_set_packet_in_format(string
, ofpmsg_body(oh
));
2026 case OFPTYPE_FLOW_AGE
:
2029 case OFPTYPE_SET_CONTROLLER_ID
:
2030 ofp_print_nxt_set_controller_id(string
, ofpmsg_body(oh
));
2033 case OFPTYPE_SET_ASYNC_CONFIG
:
2034 ofp_print_nxt_set_async_config(string
, ofpmsg_body(oh
));
2037 case OFPTYPE_FLOW_MONITOR_CANCEL
:
2038 ofp_print_nxt_flow_monitor_cancel(string
, msg
);
2041 case OFPTYPE_FLOW_MONITOR_PAUSED
:
2042 case OFPTYPE_FLOW_MONITOR_RESUMED
:
2045 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST
:
2046 ofp_print_nxst_flow_monitor_request(string
, msg
);
2049 case OFPTYPE_FLOW_MONITOR_STATS_REPLY
:
2050 ofp_print_nxst_flow_monitor_reply(string
, msg
);
2055 /* Composes and returns a string representing the OpenFlow packet of 'len'
2056 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
2057 * verbosity and higher numbers increase verbosity. The caller is responsible
2058 * for freeing the string. */
2060 ofp_to_string(const void *oh_
, size_t len
, int verbosity
)
2062 struct ds string
= DS_EMPTY_INITIALIZER
;
2063 const struct ofp_header
*oh
= oh_
;
2066 ds_put_cstr(&string
, "OpenFlow message is empty\n");
2067 } else if (len
< sizeof(struct ofp_header
)) {
2068 ds_put_format(&string
, "OpenFlow packet too short (only %zu bytes):\n",
2070 } else if (ntohs(oh
->length
) > len
) {
2074 error
= ofpraw_decode_partial(&raw
, oh
, len
);
2076 ofp_header_to_string__(oh
, raw
, &string
);
2077 ds_put_char(&string
, '\n');
2080 ds_put_format(&string
,
2081 "(***truncated to %zu bytes from %"PRIu16
"***)\n",
2082 len
, ntohs(oh
->length
));
2083 } else if (ntohs(oh
->length
) < len
) {
2084 ds_put_format(&string
,
2085 "(***only uses %"PRIu16
" bytes out of %zu***)\n",
2086 ntohs(oh
->length
), len
);
2091 error
= ofpraw_decode(&raw
, oh
);
2093 ofp_to_string__(oh
, raw
, &string
, verbosity
);
2094 if (verbosity
>= 5) {
2095 if (ds_last(&string
) != '\n') {
2096 ds_put_char(&string
, '\n');
2098 ds_put_hex_dump(&string
, oh
, len
, 0, true);
2100 if (ds_last(&string
) != '\n') {
2101 ds_put_char(&string
, '\n');
2103 return ds_steal_cstr(&string
);
2106 ofp_print_error(&string
, error
);
2108 ds_put_hex_dump(&string
, oh
, len
, 0, true);
2109 return ds_steal_cstr(&string
);
2113 print_and_free(FILE *stream
, char *string
)
2115 fputs(string
, stream
);
2119 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
2120 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
2121 * numbers increase verbosity. */
2123 ofp_print(FILE *stream
, const void *oh
, size_t len
, int verbosity
)
2125 print_and_free(stream
, ofp_to_string(oh
, len
, verbosity
));
2128 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
2129 * 'data' to 'stream'. */
2131 ofp_print_packet(FILE *stream
, const void *data
, size_t len
)
2133 print_and_free(stream
, ofp_packet_to_string(data
, len
));