2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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"
48 #include "type-props.h"
49 #include "unaligned.h"
52 static void ofp_print_queue_name(struct ds *string, uint32_t port);
53 static void ofp_print_error(struct ds *, enum ofperr);
56 /* Returns a string that represents the contents of the Ethernet frame in the
57 * 'len' bytes starting at 'data'. The caller must free the returned string.*/
59 ofp_packet_to_string(const void *data, size_t len)
61 struct ds ds = DS_EMPTY_INITIALIZER;
65 ofpbuf_use_const(&buf, data, len);
66 flow_extract(&buf, 0, 0, 0, &flow);
67 flow_format(&ds, &flow);
70 if (flow.nw_proto == IPPROTO_TCP) {
71 struct tcp_header *th = buf.l4;
72 ds_put_format(&ds, " tcp_csum:%"PRIx16,
74 } else if (flow.nw_proto == IPPROTO_UDP) {
75 struct udp_header *uh = buf.l4;
76 ds_put_format(&ds, " udp_csum:%"PRIx16,
81 ds_put_char(&ds, '\n');
87 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
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.metadata != htonll(0)) {
116 ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
119 for (i = 0; i < FLOW_N_REGS; i++) {
120 if (pin.fmd.regs[i]) {
121 ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
125 ds_put_format(string, " (via %s)",
126 ofputil_packet_in_reason_to_string(pin.reason));
128 ds_put_format(string, " data_len=%zu", pin.packet_len);
129 if (pin.buffer_id == UINT32_MAX) {
130 ds_put_format(string, " (unbuffered)");
131 if (pin.total_len != pin.packet_len) {
132 ds_put_format(string, " (***total_len != data_len***)");
135 ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
136 if (pin.total_len < pin.packet_len) {
137 ds_put_format(string, " (***total_len < data_len***)");
140 ds_put_char(string, '\n');
143 char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
144 ds_put_cstr(string, packet);
150 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
153 struct ofputil_packet_out po;
154 struct ofpbuf ofpacts;
157 ofpbuf_init(&ofpacts, 64);
158 error = ofputil_decode_packet_out(&po, oh, &ofpacts);
160 ofpbuf_uninit(&ofpacts);
161 ofp_print_error(string, error);
165 ds_put_cstr(string, " in_port=");
166 ofputil_format_port(po.in_port, string);
168 ds_put_char(string, ' ');
169 ofpacts_format(po.ofpacts, po.ofpacts_len, string);
171 if (po.buffer_id == UINT32_MAX) {
172 ds_put_format(string, " data_len=%zu", po.packet_len);
173 if (verbosity > 0 && po.packet_len > 0) {
174 char *packet = ofp_packet_to_string(po.packet, po.packet_len);
175 ds_put_char(string, '\n');
176 ds_put_cstr(string, packet);
180 ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
182 ds_put_char(string, '\n');
184 ofpbuf_uninit(&ofpacts);
187 /* qsort comparison function. */
189 compare_ports(const void *a_, const void *b_)
191 const struct ofputil_phy_port *a = a_;
192 const struct ofputil_phy_port *b = b_;
193 uint16_t ap = a->port_no;
194 uint16_t bp = b->port_no;
196 return ap < bp ? -1 : ap > bp;
200 ofp_print_bit_names(struct ds *string, uint32_t bits,
201 const char *(*bit_to_name)(uint32_t bit),
208 ds_put_cstr(string, "0");
212 for (i = 0; i < 32; i++) {
213 uint32_t bit = UINT32_C(1) << i;
216 const char *name = bit_to_name(bit);
219 ds_put_char(string, separator);
221 ds_put_cstr(string, name);
229 ds_put_char(string, separator);
231 ds_put_format(string, "0x%"PRIx32, bits);
236 netdev_feature_to_name(uint32_t bit)
238 enum netdev_features f = bit;
241 case NETDEV_F_10MB_HD: return "10MB-HD";
242 case NETDEV_F_10MB_FD: return "10MB-FD";
243 case NETDEV_F_100MB_HD: return "100MB-HD";
244 case NETDEV_F_100MB_FD: return "100MB-FD";
245 case NETDEV_F_1GB_HD: return "1GB-HD";
246 case NETDEV_F_1GB_FD: return "1GB-FD";
247 case NETDEV_F_10GB_FD: return "10GB-FD";
248 case NETDEV_F_40GB_FD: return "40GB-FD";
249 case NETDEV_F_100GB_FD: return "100GB-FD";
250 case NETDEV_F_1TB_FD: return "1TB-FD";
251 case NETDEV_F_OTHER: return "OTHER";
252 case NETDEV_F_COPPER: return "COPPER";
253 case NETDEV_F_FIBER: return "FIBER";
254 case NETDEV_F_AUTONEG: return "AUTO_NEG";
255 case NETDEV_F_PAUSE: return "AUTO_PAUSE";
256 case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
263 ofp_print_port_features(struct ds *string, enum netdev_features features)
265 ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
266 ds_put_char(string, '\n');
270 ofputil_port_config_to_name(uint32_t bit)
272 enum ofputil_port_config pc = bit;
275 case OFPUTIL_PC_PORT_DOWN: return "PORT_DOWN";
276 case OFPUTIL_PC_NO_STP: return "NO_STP";
277 case OFPUTIL_PC_NO_RECV: return "NO_RECV";
278 case OFPUTIL_PC_NO_RECV_STP: return "NO_RECV_STP";
279 case OFPUTIL_PC_NO_FLOOD: return "NO_FLOOD";
280 case OFPUTIL_PC_NO_FWD: return "NO_FWD";
281 case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
288 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
290 ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
291 ds_put_char(string, '\n');
295 ofputil_port_state_to_name(uint32_t bit)
297 enum ofputil_port_state ps = bit;
300 case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
301 case OFPUTIL_PS_BLOCKED: return "BLOCKED";
302 case OFPUTIL_PS_LIVE: return "LIVE";
304 case OFPUTIL_PS_STP_LISTEN:
305 case OFPUTIL_PS_STP_LEARN:
306 case OFPUTIL_PS_STP_FORWARD:
307 case OFPUTIL_PS_STP_BLOCK:
308 /* Handled elsewhere. */
316 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
318 enum ofputil_port_state stp_state;
320 /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
321 * pattern. We have to special case it.
323 * OVS doesn't support STP, so this field will always be 0 if we are
324 * talking to OVS, so we'd always print STP_LISTEN in that case.
325 * Therefore, we don't print anything at all if the value is STP_LISTEN, to
326 * avoid confusing users. */
327 stp_state = state & OFPUTIL_PS_STP_MASK;
330 (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
331 : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
333 state &= ~OFPUTIL_PS_STP_MASK;
335 ofp_print_bit_names(string, state, ofputil_port_state_to_name,
339 ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
341 ds_put_char(string, '\n');
345 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
347 char name[sizeof port->name];
350 memcpy(name, port->name, sizeof name);
351 for (j = 0; j < sizeof name - 1; j++) {
352 if (!isprint((unsigned char) name[j])) {
358 ds_put_char(string, ' ');
359 ofputil_format_port(port->port_no, string);
360 ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
361 name, ETH_ADDR_ARGS(port->hw_addr));
363 ds_put_cstr(string, " config: ");
364 ofp_print_port_config(string, port->config);
366 ds_put_cstr(string, " state: ");
367 ofp_print_port_state(string, port->state);
370 ds_put_format(string, " current: ");
371 ofp_print_port_features(string, port->curr);
373 if (port->advertised) {
374 ds_put_format(string, " advertised: ");
375 ofp_print_port_features(string, port->advertised);
377 if (port->supported) {
378 ds_put_format(string, " supported: ");
379 ofp_print_port_features(string, port->supported);
382 ds_put_format(string, " peer: ");
383 ofp_print_port_features(string, port->peer);
385 ds_put_format(string, " speed: %"PRIu32" Mbps now, "
386 "%"PRIu32" Mbps max\n",
387 port->curr_speed / UINT32_C(1000),
388 port->max_speed / UINT32_C(1000));
391 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
392 * 'ofp_version', writes a detailed description of each port into
395 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
399 struct ofputil_phy_port *ports;
403 n_ports = ofputil_count_phy_ports(ofp_version, b);
405 ports = xmalloc(n_ports * sizeof *ports);
406 for (i = 0; i < n_ports; i++) {
407 error = ofputil_pull_phy_port(ofp_version, b, &ports[i]);
409 ofp_print_error(string, error);
413 qsort(ports, n_ports, sizeof *ports, compare_ports);
414 for (i = 0; i < n_ports; i++) {
415 ofp_print_phy_port(string, &ports[i]);
423 ofputil_capabilities_to_name(uint32_t bit)
425 enum ofputil_capabilities capabilities = bit;
427 switch (capabilities) {
428 case OFPUTIL_C_FLOW_STATS: return "FLOW_STATS";
429 case OFPUTIL_C_TABLE_STATS: return "TABLE_STATS";
430 case OFPUTIL_C_PORT_STATS: return "PORT_STATS";
431 case OFPUTIL_C_IP_REASM: return "IP_REASM";
432 case OFPUTIL_C_QUEUE_STATS: return "QUEUE_STATS";
433 case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
434 case OFPUTIL_C_STP: return "STP";
435 case OFPUTIL_C_GROUP_STATS: return "GROUP_STATS";
436 case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
443 ofputil_action_bitmap_to_name(uint32_t bit)
445 enum ofputil_action_bitmap action = bit;
448 case OFPUTIL_A_OUTPUT: return "OUTPUT";
449 case OFPUTIL_A_SET_VLAN_VID: return "SET_VLAN_VID";
450 case OFPUTIL_A_SET_VLAN_PCP: return "SET_VLAN_PCP";
451 case OFPUTIL_A_STRIP_VLAN: return "STRIP_VLAN";
452 case OFPUTIL_A_SET_DL_SRC: return "SET_DL_SRC";
453 case OFPUTIL_A_SET_DL_DST: return "SET_DL_DST";
454 case OFPUTIL_A_SET_NW_SRC: return "SET_NW_SRC";
455 case OFPUTIL_A_SET_NW_DST: return "SET_NW_DST";
456 case OFPUTIL_A_SET_NW_ECN: return "SET_NW_ECN";
457 case OFPUTIL_A_SET_NW_TOS: return "SET_NW_TOS";
458 case OFPUTIL_A_SET_TP_SRC: return "SET_TP_SRC";
459 case OFPUTIL_A_SET_TP_DST: return "SET_TP_DST";
460 case OFPUTIL_A_ENQUEUE: return "ENQUEUE";
461 case OFPUTIL_A_COPY_TTL_OUT: return "COPY_TTL_OUT";
462 case OFPUTIL_A_COPY_TTL_IN: return "COPY_TTL_IN";
463 case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
464 case OFPUTIL_A_SET_MPLS_TC: return "SET_MPLS_TC";
465 case OFPUTIL_A_SET_MPLS_TTL: return "SET_MPLS_TTL";
466 case OFPUTIL_A_DEC_MPLS_TTL: return "DEC_MPLS_TTL";
467 case OFPUTIL_A_PUSH_VLAN: return "PUSH_VLAN";
468 case OFPUTIL_A_POP_VLAN: return "POP_VLAN";
469 case OFPUTIL_A_PUSH_MPLS: return "PUSH_MPLS";
470 case OFPUTIL_A_POP_MPLS: return "POP_MPLS";
471 case OFPUTIL_A_SET_QUEUE: return "SET_QUEUE";
472 case OFPUTIL_A_GROUP: return "GROUP";
473 case OFPUTIL_A_SET_NW_TTL: return "SET_NW_TTL";
474 case OFPUTIL_A_DEC_NW_TTL: return "DEC_NW_TTL";
481 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
483 struct ofputil_switch_features features;
487 error = ofputil_decode_switch_features(oh, &features, &b);
489 ofp_print_error(string, error);
493 ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
494 ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32"\n",
495 features.n_tables, features.n_buffers);
497 ds_put_cstr(string, "capabilities: ");
498 ofp_print_bit_names(string, features.capabilities,
499 ofputil_capabilities_to_name, ' ');
500 ds_put_char(string, '\n');
502 switch ((enum ofp_version)oh->version) {
504 ds_put_cstr(string, "actions: ");
505 ofp_print_bit_names(string, features.actions,
506 ofputil_action_bitmap_to_name, ' ');
507 ds_put_char(string, '\n');
516 ofp_print_phy_ports(string, oh->version, &b);
520 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
522 enum ofp_config_flags flags;
524 flags = ntohs(osc->flags);
526 ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
527 flags &= ~OFPC_FRAG_MASK;
529 if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
530 ds_put_format(string, " invalid_ttl_to_controller");
531 flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
535 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
538 ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
541 static void print_wild(struct ds *string, const char *leader, int is_wild,
542 int verbosity, const char *format, ...)
543 __attribute__((format(printf, 5, 6)));
545 static void print_wild(struct ds *string, const char *leader, int is_wild,
546 int verbosity, const char *format, ...)
548 if (is_wild && verbosity < 2) {
551 ds_put_cstr(string, leader);
555 va_start(args, format);
556 ds_put_format_valist(string, format, args);
559 ds_put_char(string, '*');
561 ds_put_char(string, ',');
565 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
566 uint32_t wild_bits, int verbosity)
568 if (wild_bits >= 32 && verbosity < 2) {
571 ds_put_cstr(string, leader);
572 if (wild_bits < 32) {
573 ds_put_format(string, IP_FMT, IP_ARGS(&ip));
575 ds_put_format(string, "/%d", 32 - wild_bits);
578 ds_put_char(string, '*');
580 ds_put_char(string, ',');
584 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
586 char *s = ofp10_match_to_string(om, verbosity);
592 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
594 struct ds f = DS_EMPTY_INITIALIZER;
595 uint32_t w = ntohl(om->wildcards);
596 bool skip_type = false;
597 bool skip_proto = false;
599 if (!(w & OFPFW10_DL_TYPE)) {
601 if (om->dl_type == htons(ETH_TYPE_IP)) {
602 if (!(w & OFPFW10_NW_PROTO)) {
604 if (om->nw_proto == IPPROTO_ICMP) {
605 ds_put_cstr(&f, "icmp,");
606 } else if (om->nw_proto == IPPROTO_TCP) {
607 ds_put_cstr(&f, "tcp,");
608 } else if (om->nw_proto == IPPROTO_UDP) {
609 ds_put_cstr(&f, "udp,");
611 ds_put_cstr(&f, "ip,");
615 ds_put_cstr(&f, "ip,");
617 } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
618 ds_put_cstr(&f, "arp,");
623 print_wild(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
624 "%d", ntohs(om->in_port));
625 print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
626 "%d", ntohs(om->dl_vlan));
627 print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
628 "%d", om->dl_vlan_pcp);
629 print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
630 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
631 print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
632 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
634 print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
635 "0x%04x", ntohs(om->dl_type));
637 print_ip_netmask(&f, "nw_src=", om->nw_src,
638 (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
640 print_ip_netmask(&f, "nw_dst=", om->nw_dst,
641 (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
644 if (om->dl_type == htons(ETH_TYPE_ARP)) {
645 print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
648 print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
652 print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
654 if (om->nw_proto == IPPROTO_ICMP) {
655 print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
656 "%d", ntohs(om->tp_src));
657 print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
658 "%d", ntohs(om->tp_dst));
660 print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
661 "%d", ntohs(om->tp_src));
662 print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
663 "%d", ntohs(om->tp_dst));
665 if (ds_last(&f) == ',') {
672 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
674 struct ofputil_flow_mod fm;
675 struct ofpbuf ofpacts;
679 enum ofputil_protocol protocol;
681 protocol = ofputil_protocol_from_ofp_version(oh->version);
682 protocol = ofputil_protocol_set_tid(protocol, true);
684 ofpbuf_init(&ofpacts, 64);
685 error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts);
687 ofpbuf_uninit(&ofpacts);
688 ofp_print_error(s, error);
693 switch (fm.command) {
695 ds_put_cstr(s, "ADD");
698 ds_put_cstr(s, "MOD");
700 case OFPFC_MODIFY_STRICT:
701 ds_put_cstr(s, "MOD_STRICT");
704 ds_put_cstr(s, "DEL");
706 case OFPFC_DELETE_STRICT:
707 ds_put_cstr(s, "DEL_STRICT");
710 ds_put_format(s, "cmd:%d", fm.command);
712 if (fm.table_id != 0) {
713 ds_put_format(s, " table:%d", fm.table_id);
717 ofpraw_decode(&raw, oh);
718 if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
719 const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
720 ofp10_match_print(s, &ofm->match, verbosity);
722 /* ofp_print_match() doesn't print priority. */
723 need_priority = true;
724 } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
725 const struct nx_flow_mod *nfm = ofpmsg_body(oh);
726 const void *nxm = nfm + 1;
729 nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
730 ds_put_cstr(s, nxm_s);
733 /* nx_match_to_string() doesn't print priority. */
734 need_priority = true;
736 match_format(&fm.match, s, fm.priority);
738 /* match_format() does print priority. */
739 need_priority = false;
742 if (ds_last(s) != ' ') {
745 if (fm.new_cookie != htonll(0)) {
746 ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
748 if (fm.cookie_mask != htonll(0)) {
749 ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
750 ntohll(fm.cookie), ntohll(fm.cookie_mask));
752 if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
753 ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
755 if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
756 ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
758 if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
759 ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
761 if (fm.buffer_id != UINT32_MAX) {
762 ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
764 if (fm.out_port != OFPP_NONE) {
765 ds_put_format(s, "out_port:");
766 ofputil_format_port(fm.out_port, s);
770 uint16_t flags = fm.flags;
772 if (flags & OFPFF_SEND_FLOW_REM) {
773 ds_put_cstr(s, "send_flow_rem ");
775 if (flags & OFPFF_CHECK_OVERLAP) {
776 ds_put_cstr(s, "check_overlap ");
778 if (flags & OFPFF10_EMERG) {
779 ds_put_cstr(s, "emerg ");
782 flags &= ~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF10_EMERG);
784 ds_put_format(s, "flags:0x%"PRIx16" ", flags);
788 ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
789 ofpbuf_uninit(&ofpacts);
793 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
795 ds_put_format(string, "%u", sec);
797 ds_put_format(string, ".%09u", nsec);
798 while (string->string[string->length - 1] == '0') {
802 ds_put_char(string, 's');
806 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason)
811 case OFPRR_IDLE_TIMEOUT:
813 case OFPRR_HARD_TIMEOUT:
817 case OFPRR_GROUP_DELETE:
818 return "group_delete";
822 sprintf(s, "%d", (int) reason);
828 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
830 struct ofputil_flow_removed fr;
833 error = ofputil_decode_flow_removed(&fr, oh);
835 ofp_print_error(string, error);
839 ds_put_char(string, ' ');
840 match_format(&fr.match, string, fr.priority);
842 ds_put_format(string, " reason=%s",
843 ofp_flow_removed_reason_to_string(fr.reason));
845 if (fr.cookie != htonll(0)) {
846 ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
848 ds_put_cstr(string, " duration");
849 ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
850 ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
851 if (fr.hard_timeout) {
852 /* The hard timeout was only added in OF1.2, so only print it if it is
853 * actually in use to avoid gratuitous change to the formatting. */
854 ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
856 ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
857 fr.packet_count, fr.byte_count);
861 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
863 struct ofputil_port_mod pm;
866 error = ofputil_decode_port_mod(oh, &pm);
868 ofp_print_error(string, error);
872 ds_put_format(string, "port: %"PRIu16": addr:"ETH_ADDR_FMT"\n",
873 pm.port_no, ETH_ADDR_ARGS(pm.hw_addr));
875 ds_put_format(string, " config: ");
876 ofp_print_port_config(string, pm.config);
878 ds_put_format(string, " mask: ");
879 ofp_print_port_config(string, pm.mask);
881 ds_put_format(string, " advertise: ");
883 ofp_print_port_features(string, pm.advertise);
885 ds_put_format(string, "UNCHANGED\n");
890 ofp_print_error(struct ds *string, enum ofperr error)
892 if (string->length) {
893 ds_put_char(string, ' ');
895 ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
899 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
901 size_t len = ntohs(oh->length);
902 struct ofpbuf payload;
906 error = ofperr_decode_msg(oh, &payload);
908 ds_put_cstr(string, "***decode error***");
909 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
913 ds_put_format(string, " %s\n", ofperr_get_name(error));
915 if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
916 ds_put_printable(string, payload.data, payload.size);
918 s = ofp_to_string(payload.data, payload.size, 1);
919 ds_put_cstr(string, s);
925 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
927 struct ofputil_port_status ps;
930 error = ofputil_decode_port_status(oh, &ps);
932 ofp_print_error(string, error);
936 if (ps.reason == OFPPR_ADD) {
937 ds_put_format(string, " ADD:");
938 } else if (ps.reason == OFPPR_DELETE) {
939 ds_put_format(string, " DEL:");
940 } else if (ps.reason == OFPPR_MODIFY) {
941 ds_put_format(string, " MOD:");
944 ofp_print_phy_port(string, &ps.desc);
948 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
950 const struct ofp_desc_stats *ods = ofpmsg_body(oh);
952 ds_put_char(string, '\n');
953 ds_put_format(string, "Manufacturer: %.*s\n",
954 (int) sizeof ods->mfr_desc, ods->mfr_desc);
955 ds_put_format(string, "Hardware: %.*s\n",
956 (int) sizeof ods->hw_desc, ods->hw_desc);
957 ds_put_format(string, "Software: %.*s\n",
958 (int) sizeof ods->sw_desc, ods->sw_desc);
959 ds_put_format(string, "Serial Num: %.*s\n",
960 (int) sizeof ods->serial_num, ods->serial_num);
961 ds_put_format(string, "DP Description: %.*s\n",
962 (int) sizeof ods->dp_desc, ods->dp_desc);
966 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
968 struct ofputil_flow_stats_request fsr;
971 error = ofputil_decode_flow_stats_request(&fsr, oh);
973 ofp_print_error(string, error);
977 if (fsr.table_id != 0xff) {
978 ds_put_format(string, " table=%"PRIu8, fsr.table_id);
981 if (fsr.out_port != OFPP_NONE) {
982 ds_put_cstr(string, " out_port=");
983 ofputil_format_port(fsr.out_port, string);
986 ds_put_char(string, ' ');
987 match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
991 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
993 ds_put_format(string, " cookie=0x%"PRIx64", duration=",
996 ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
997 ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
998 ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
999 ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1000 if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1001 ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1003 if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1004 ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1006 if (fs->idle_age >= 0) {
1007 ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1009 if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1010 ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1013 match_format(&fs->match, string, fs->priority);
1014 if (string->string[string->length - 1] != ' ') {
1015 ds_put_char(string, ' ');
1018 ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1022 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1024 struct ofpbuf ofpacts;
1027 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1028 ofpbuf_init(&ofpacts, 64);
1030 struct ofputil_flow_stats fs;
1033 retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1035 if (retval != EOF) {
1036 ds_put_cstr(string, " ***parse error***");
1040 ds_put_char(string, '\n');
1041 ofp_print_flow_stats(string, &fs);
1043 ofpbuf_uninit(&ofpacts);
1047 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1049 struct ofputil_aggregate_stats as;
1052 error = ofputil_decode_aggregate_stats_reply(&as, oh);
1054 ofp_print_error(string, error);
1058 ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1059 ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1060 ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1063 static void print_port_stat(struct ds *string, const char *leader,
1064 const ovs_32aligned_be64 *statp, int more)
1066 uint64_t stat = ntohll(get_32aligned_be64(statp));
1068 ds_put_cstr(string, leader);
1069 if (stat != UINT64_MAX) {
1070 ds_put_format(string, "%"PRIu64, stat);
1072 ds_put_char(string, '?');
1075 ds_put_cstr(string, ", ");
1077 ds_put_cstr(string, "\n");
1082 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1084 const struct ofp10_port_stats_request *psr = ofpmsg_body(oh);
1085 ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1089 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1092 struct ofp10_port_stats *ps;
1096 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1097 ofpraw_pull_assert(&b);
1099 n = b.size / sizeof *ps;
1100 ds_put_format(string, " %zu ports\n", n);
1101 if (verbosity < 1) {
1106 ps = ofpbuf_try_pull(&b, sizeof *ps);
1111 ds_put_format(string, " port %2"PRIu16": ", ntohs(ps->port_no));
1113 ds_put_cstr(string, "rx ");
1114 print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1115 print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1116 print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1117 print_port_stat(string, "errs=", &ps->rx_errors, 1);
1118 print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1119 print_port_stat(string, "over=", &ps->rx_over_err, 1);
1120 print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1122 ds_put_cstr(string, " tx ");
1123 print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1124 print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1125 print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1126 print_port_stat(string, "errs=", &ps->tx_errors, 1);
1127 print_port_stat(string, "coll=", &ps->collisions, 0);
1132 ofp_print_one_ofpst_table_reply(struct ds *string, enum ofp_version ofp_version,
1133 const char *name, struct ofp12_table_stats *ts)
1135 char name_[OFP_MAX_TABLE_NAME_LEN + 1];
1137 ovs_strlcpy(name_, name, sizeof name_);
1139 ds_put_format(string, " %d: %-8s: ", ts->table_id, name_);
1140 ds_put_format(string, "wild=0x%05"PRIx64", ", ntohll(ts->wildcards));
1141 ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1142 ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1143 ds_put_cstr(string, " ");
1144 ds_put_format(string, "lookup=%"PRIu64", ", ntohll(ts->lookup_count));
1145 ds_put_format(string, "matched=%"PRIu64"\n", ntohll(ts->matched_count));
1147 if (ofp_version < OFP11_VERSION) {
1151 ds_put_cstr(string, " ");
1152 ds_put_format(string, "match=0x%08"PRIx64", ", ntohll(ts->match));
1153 ds_put_format(string, "instructions=0x%08"PRIx32", ",
1154 ntohl(ts->instructions));
1155 ds_put_format(string, "config=0x%08"PRIx32"\n", ntohl(ts->config));
1156 ds_put_cstr(string, " ");
1157 ds_put_format(string, "write_actions=0x%08"PRIx32", ",
1158 ntohl(ts->write_actions));
1159 ds_put_format(string, "apply_actions=0x%08"PRIx32"\n",
1160 ntohl(ts->apply_actions));
1162 if (ofp_version < OFP12_VERSION) {
1166 ds_put_cstr(string, " ");
1167 ds_put_format(string, "write_setfields=0x%016"PRIx64"\n",
1168 ntohll(ts->write_setfields));
1169 ds_put_cstr(string, " ");
1170 ds_put_format(string, "apply_setfields=0x%016"PRIx64"\n",
1171 ntohll(ts->apply_setfields));
1172 ds_put_cstr(string, " ");
1173 ds_put_format(string, "metadata_match=0x%016"PRIx64"\n",
1174 ntohll(ts->metadata_match));
1175 ds_put_cstr(string, " ");
1176 ds_put_format(string, "metadata_write=0x%016"PRIx64"\n",
1177 ntohll(ts->metadata_write));
1181 ofp_print_ofpst_table_reply12(struct ds *string, const struct ofp_header *oh,
1184 struct ofp12_table_stats *ts;
1188 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1189 ofpraw_pull_assert(&b);
1191 n = b.size / sizeof *ts;
1192 ds_put_format(string, " %zu tables\n", n);
1193 if (verbosity < 1) {
1198 ts = ofpbuf_try_pull(&b, sizeof *ts);
1203 ofp_print_one_ofpst_table_reply(string, OFP12_VERSION, ts->name, ts);
1208 ofp_print_ofpst_table_reply11(struct ds *string, const struct ofp_header *oh,
1211 struct ofp11_table_stats *ts;
1215 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1216 ofpraw_pull_assert(&b);
1218 n = b.size / sizeof *ts;
1219 ds_put_format(string, " %zu tables\n", n);
1220 if (verbosity < 1) {
1225 struct ofp12_table_stats ts12;
1227 ts = ofpbuf_try_pull(&b, sizeof *ts);
1232 ts12.table_id = ts->table_id;
1233 ts12.wildcards = htonll(ntohl(ts->wildcards));
1234 ts12.max_entries = ts->max_entries;
1235 ts12.active_count = ts->active_count;
1236 ts12.lookup_count = ts->lookup_count;
1237 ts12.matched_count = ts->matched_count;
1238 ts12.match = htonll(ntohl(ts->match));
1239 ts12.instructions = ts->instructions;
1240 ts12.config = ts->config;
1241 ts12.write_actions = ts->write_actions;
1242 ts12.apply_actions = ts->apply_actions;
1243 ofp_print_one_ofpst_table_reply(string, OFP11_VERSION, ts->name, &ts12);
1248 ofp_print_ofpst_table_reply10(struct ds *string, const struct ofp_header *oh,
1251 struct ofp10_table_stats *ts;
1255 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1256 ofpraw_pull_assert(&b);
1258 n = b.size / sizeof *ts;
1259 ds_put_format(string, " %zu tables\n", n);
1260 if (verbosity < 1) {
1265 struct ofp12_table_stats ts12;
1267 ts = ofpbuf_try_pull(&b, sizeof *ts);
1272 ts12.table_id = ts->table_id;
1273 ts12.wildcards = htonll(ntohl(ts->wildcards));
1274 ts12.max_entries = ts->max_entries;
1275 ts12.active_count = ts->active_count;
1276 ts12.lookup_count = get_32aligned_be64(&ts->lookup_count);
1277 ts12.matched_count = get_32aligned_be64(&ts->matched_count);
1278 ofp_print_one_ofpst_table_reply(string, OFP10_VERSION, ts->name, &ts12);
1283 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1286 switch ((enum ofp_version)oh->version) {
1288 ofp_print_ofpst_table_reply12(string, oh, verbosity);
1292 ofp_print_ofpst_table_reply11(string, oh, verbosity);
1296 ofp_print_ofpst_table_reply10(string, oh, verbosity);
1305 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1307 if (queue_id == OFPQ_ALL) {
1308 ds_put_cstr(string, "ALL");
1310 ds_put_format(string, "%"PRIu32, queue_id);
1315 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1317 const struct ofp10_queue_stats_request *qsr = ofpmsg_body(oh);
1319 ds_put_cstr(string, "port=");
1320 ofputil_format_port(ntohs(qsr->port_no), string);
1322 ds_put_cstr(string, " queue=");
1323 ofp_print_queue_name(string, ntohl(qsr->queue_id));
1327 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1330 struct ofp10_queue_stats *qs;
1334 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1335 ofpraw_pull_assert(&b);
1337 n = b.size / sizeof *qs;
1338 ds_put_format(string, " %zu queues\n", n);
1339 if (verbosity < 1) {
1344 qs = ofpbuf_try_pull(&b, sizeof *qs);
1349 ds_put_cstr(string, " port ");
1350 ofputil_format_port(ntohs(qs->port_no), string);
1351 ds_put_cstr(string, " queue ");
1352 ofp_print_queue_name(string, ntohl(qs->queue_id));
1353 ds_put_cstr(string, ": ");
1355 print_port_stat(string, "bytes=", &qs->tx_bytes, 1);
1356 print_port_stat(string, "pkts=", &qs->tx_packets, 1);
1357 print_port_stat(string, "errors=", &qs->tx_errors, 0);
1362 ofp_print_ofpst_port_desc_reply(struct ds *string,
1363 const struct ofp_header *oh)
1367 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1368 ofpraw_pull_assert(&b);
1369 ds_put_char(string, '\n');
1370 ofp_print_phy_ports(string, oh->version, &b);
1374 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1376 uint16_t flags = ofpmp_flags(oh);
1379 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1384 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1386 uint16_t flags = ofpmp_flags(oh);
1389 ds_put_cstr(string, " flags=");
1390 if (flags & OFPSF_REPLY_MORE) {
1391 ds_put_cstr(string, "[more]");
1392 flags &= ~OFPSF_REPLY_MORE;
1395 ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1402 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1404 size_t len = ntohs(oh->length);
1406 ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1407 if (verbosity > 1) {
1408 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1413 ofp_print_nxt_role_message(struct ds *string,
1414 const struct nx_role_request *nrr)
1416 unsigned int role = ntohl(nrr->role);
1418 ds_put_cstr(string, " role=");
1419 if (role == NX_ROLE_OTHER) {
1420 ds_put_cstr(string, "other");
1421 } else if (role == NX_ROLE_MASTER) {
1422 ds_put_cstr(string, "master");
1423 } else if (role == NX_ROLE_SLAVE) {
1424 ds_put_cstr(string, "slave");
1426 ds_put_format(string, "%u", role);
1431 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1432 const struct nx_flow_mod_table_id *nfmti)
1434 ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1438 ofp_print_nxt_set_flow_format(struct ds *string,
1439 const struct nx_set_flow_format *nsff)
1441 uint32_t format = ntohl(nsff->format);
1443 ds_put_cstr(string, " format=");
1444 if (ofputil_nx_flow_format_is_valid(format)) {
1445 ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1447 ds_put_format(string, "%"PRIu32, format);
1452 ofp_print_nxt_set_packet_in_format(struct ds *string,
1453 const struct nx_set_packet_in_format *nspf)
1455 uint32_t format = ntohl(nspf->format);
1457 ds_put_cstr(string, " format=");
1458 if (ofputil_packet_in_format_is_valid(format)) {
1459 ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1461 ds_put_format(string, "%"PRIu32, format);
1466 ofp_port_reason_to_string(enum ofp_port_reason reason)
1481 sprintf(s, "%d", (int) reason);
1487 ofp_print_nxt_set_async_config(struct ds *string,
1488 const struct nx_async_config *nac)
1492 for (i = 0; i < 2; i++) {
1495 ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1497 ds_put_cstr(string, " PACKET_IN:");
1498 for (j = 0; j < 32; j++) {
1499 if (nac->packet_in_mask[i] & htonl(1u << j)) {
1500 ds_put_format(string, " %s",
1501 ofputil_packet_in_reason_to_string(j));
1504 if (!nac->packet_in_mask[i]) {
1505 ds_put_cstr(string, " (off)");
1507 ds_put_char(string, '\n');
1509 ds_put_cstr(string, " PORT_STATUS:");
1510 for (j = 0; j < 32; j++) {
1511 if (nac->port_status_mask[i] & htonl(1u << j)) {
1512 ds_put_format(string, " %s", ofp_port_reason_to_string(j));
1515 if (!nac->port_status_mask[i]) {
1516 ds_put_cstr(string, " (off)");
1518 ds_put_char(string, '\n');
1520 ds_put_cstr(string, " FLOW_REMOVED:");
1521 for (j = 0; j < 32; j++) {
1522 if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1523 ds_put_format(string, " %s",
1524 ofp_flow_removed_reason_to_string(j));
1527 if (!nac->flow_removed_mask[i]) {
1528 ds_put_cstr(string, " (off)");
1530 ds_put_char(string, '\n');
1535 ofp_print_nxt_set_controller_id(struct ds *string,
1536 const struct nx_controller_id *nci)
1538 ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1542 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1543 const struct ofp_header *oh)
1545 ds_put_format(string, " id=%"PRIu32,
1546 ofputil_decode_flow_monitor_cancel(oh));
1550 nx_flow_monitor_flags_to_name(uint32_t bit)
1552 enum nx_flow_monitor_flags fmf = bit;
1555 case NXFMF_INITIAL: return "initial";
1556 case NXFMF_ADD: return "add";
1557 case NXFMF_DELETE: return "delete";
1558 case NXFMF_MODIFY: return "modify";
1559 case NXFMF_ACTIONS: return "actions";
1560 case NXFMF_OWN: return "own";
1567 ofp_print_nxst_flow_monitor_request(struct ds *string,
1568 const struct ofp_header *oh)
1572 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1574 struct ofputil_flow_monitor_request request;
1577 retval = ofputil_decode_flow_monitor_request(&request, &b);
1579 if (retval != EOF) {
1580 ofp_print_error(string, retval);
1585 ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
1586 ofp_print_bit_names(string, request.flags,
1587 nx_flow_monitor_flags_to_name, ',');
1589 if (request.out_port != OFPP_NONE) {
1590 ds_put_cstr(string, " out_port=");
1591 ofputil_format_port(request.out_port, string);
1594 if (request.table_id != 0xff) {
1595 ds_put_format(string, " table=%"PRIu8, request.table_id);
1598 ds_put_char(string, ' ');
1599 match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
1600 ds_chomp(string, ' ');
1605 ofp_print_nxst_flow_monitor_reply(struct ds *string,
1606 const struct ofp_header *oh)
1608 uint64_t ofpacts_stub[1024 / 8];
1609 struct ofpbuf ofpacts;
1612 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1613 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1615 struct ofputil_flow_update update;
1619 update.match = &match;
1620 retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
1622 if (retval != EOF) {
1623 ofp_print_error(string, retval);
1625 ofpbuf_uninit(&ofpacts);
1629 ds_put_cstr(string, "\n event=");
1630 switch (update.event) {
1632 ds_put_cstr(string, "ADDED");
1636 ds_put_format(string, "DELETED reason=%s",
1637 ofp_flow_removed_reason_to_string(update.reason));
1640 case NXFME_MODIFIED:
1641 ds_put_cstr(string, "MODIFIED");
1645 ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
1649 ds_put_format(string, " table=%"PRIu8, update.table_id);
1650 if (update.idle_timeout != OFP_FLOW_PERMANENT) {
1651 ds_put_format(string, " idle_timeout=%"PRIu16,
1652 update.idle_timeout);
1654 if (update.hard_timeout != OFP_FLOW_PERMANENT) {
1655 ds_put_format(string, " hard_timeout=%"PRIu16,
1656 update.hard_timeout);
1658 ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
1660 ds_put_char(string, ' ');
1661 match_format(update.match, string, OFP_DEFAULT_PRIORITY);
1663 if (update.ofpacts_len) {
1664 if (string->string[string->length - 1] != ' ') {
1665 ds_put_char(string, ' ');
1667 ofpacts_format(update.ofpacts, update.ofpacts_len, string);
1673 ofp_print_version(const struct ofp_header *oh,
1676 switch (oh->version) {
1680 ds_put_cstr(string, " (OF1.1)");
1683 ds_put_cstr(string, " (OF1.2)");
1686 ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
1689 ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
1693 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1696 ds_put_cstr(string, ofpraw_get_name(raw));
1697 ofp_print_version(oh, string);
1701 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1702 struct ds *string, int verbosity)
1704 const void *msg = oh;
1706 ofp_header_to_string__(oh, raw, string);
1707 switch (ofptype_from_ofpraw(raw)) {
1709 ds_put_char(string, '\n');
1710 ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1715 ofp_print_error_msg(string, oh);
1718 case OFPTYPE_ECHO_REQUEST:
1719 case OFPTYPE_ECHO_REPLY:
1720 ofp_print_echo(string, oh, verbosity);
1723 case OFPTYPE_FEATURES_REQUEST:
1726 case OFPTYPE_FEATURES_REPLY:
1727 ofp_print_switch_features(string, oh);
1730 case OFPTYPE_GET_CONFIG_REQUEST:
1733 case OFPTYPE_GET_CONFIG_REPLY:
1734 case OFPTYPE_SET_CONFIG:
1735 ofp_print_switch_config(string, ofpmsg_body(oh));
1738 case OFPTYPE_PACKET_IN:
1739 ofp_print_packet_in(string, oh, verbosity);
1742 case OFPTYPE_FLOW_REMOVED:
1743 ofp_print_flow_removed(string, oh);
1746 case OFPTYPE_PORT_STATUS:
1747 ofp_print_port_status(string, oh);
1750 case OFPTYPE_PACKET_OUT:
1751 ofp_print_packet_out(string, oh, verbosity);
1754 case OFPTYPE_FLOW_MOD:
1755 ofp_print_flow_mod(string, oh, verbosity);
1758 case OFPTYPE_PORT_MOD:
1759 ofp_print_port_mod(string, oh);
1762 case OFPTYPE_BARRIER_REQUEST:
1763 case OFPTYPE_BARRIER_REPLY:
1766 case OFPTYPE_DESC_STATS_REQUEST:
1767 case OFPTYPE_PORT_DESC_STATS_REQUEST:
1768 ofp_print_stats_request(string, oh);
1771 case OFPTYPE_FLOW_STATS_REQUEST:
1772 case OFPTYPE_AGGREGATE_STATS_REQUEST:
1773 ofp_print_stats_request(string, oh);
1774 ofp_print_flow_stats_request(string, oh);
1777 case OFPTYPE_TABLE_STATS_REQUEST:
1778 ofp_print_stats_request(string, oh);
1781 case OFPTYPE_PORT_STATS_REQUEST:
1782 ofp_print_stats_request(string, oh);
1783 ofp_print_ofpst_port_request(string, oh);
1786 case OFPTYPE_QUEUE_STATS_REQUEST:
1787 ofp_print_stats_request(string, oh);
1788 ofp_print_ofpst_queue_request(string, oh);
1791 case OFPTYPE_DESC_STATS_REPLY:
1792 ofp_print_stats_reply(string, oh);
1793 ofp_print_ofpst_desc_reply(string, oh);
1796 case OFPTYPE_FLOW_STATS_REPLY:
1797 ofp_print_stats_reply(string, oh);
1798 ofp_print_flow_stats_reply(string, oh);
1801 case OFPTYPE_QUEUE_STATS_REPLY:
1802 ofp_print_stats_reply(string, oh);
1803 ofp_print_ofpst_queue_reply(string, oh, verbosity);
1806 case OFPTYPE_PORT_STATS_REPLY:
1807 ofp_print_stats_reply(string, oh);
1808 ofp_print_ofpst_port_reply(string, oh, verbosity);
1811 case OFPTYPE_TABLE_STATS_REPLY:
1812 ofp_print_stats_reply(string, oh);
1813 ofp_print_ofpst_table_reply(string, oh, verbosity);
1816 case OFPTYPE_AGGREGATE_STATS_REPLY:
1817 ofp_print_stats_reply(string, oh);
1818 ofp_print_aggregate_stats_reply(string, oh);
1821 case OFPTYPE_PORT_DESC_STATS_REPLY:
1822 ofp_print_stats_reply(string, oh);
1823 ofp_print_ofpst_port_desc_reply(string, oh);
1826 case OFPTYPE_ROLE_REQUEST:
1827 case OFPTYPE_ROLE_REPLY:
1828 ofp_print_nxt_role_message(string, ofpmsg_body(oh));
1831 case OFPTYPE_FLOW_MOD_TABLE_ID:
1832 ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
1835 case OFPTYPE_SET_FLOW_FORMAT:
1836 ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
1839 case OFPTYPE_SET_PACKET_IN_FORMAT:
1840 ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
1843 case OFPTYPE_FLOW_AGE:
1846 case OFPTYPE_SET_CONTROLLER_ID:
1847 ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
1850 case OFPTYPE_SET_ASYNC_CONFIG:
1851 ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
1854 case OFPTYPE_FLOW_MONITOR_CANCEL:
1855 ofp_print_nxt_flow_monitor_cancel(string, msg);
1858 case OFPTYPE_FLOW_MONITOR_PAUSED:
1859 case OFPTYPE_FLOW_MONITOR_RESUMED:
1862 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1863 ofp_print_nxst_flow_monitor_request(string, msg);
1866 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1867 ofp_print_nxst_flow_monitor_reply(string, msg);
1872 /* Composes and returns a string representing the OpenFlow packet of 'len'
1873 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
1874 * verbosity and higher numbers increase verbosity. The caller is responsible
1875 * for freeing the string. */
1877 ofp_to_string(const void *oh_, size_t len, int verbosity)
1879 struct ds string = DS_EMPTY_INITIALIZER;
1880 const struct ofp_header *oh = oh_;
1883 ds_put_cstr(&string, "OpenFlow message is empty\n");
1884 } else if (len < sizeof(struct ofp_header)) {
1885 ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1887 } else if (ntohs(oh->length) > len) {
1891 error = ofpraw_decode_partial(&raw, oh, len);
1893 ofp_header_to_string__(oh, raw, &string);
1894 ds_put_char(&string, '\n');
1897 ds_put_format(&string,
1898 "(***truncated to %zu bytes from %"PRIu16"***)\n",
1899 len, ntohs(oh->length));
1900 } else if (ntohs(oh->length) < len) {
1901 ds_put_format(&string,
1902 "(***only uses %"PRIu16" bytes out of %zu***)\n",
1903 ntohs(oh->length), len);
1908 error = ofpraw_decode(&raw, oh);
1910 ofp_to_string__(oh, raw, &string, verbosity);
1911 if (verbosity >= 5) {
1912 if (ds_last(&string) != '\n') {
1913 ds_put_char(&string, '\n');
1915 ds_put_hex_dump(&string, oh, len, 0, true);
1917 if (ds_last(&string) != '\n') {
1918 ds_put_char(&string, '\n');
1920 return ds_steal_cstr(&string);
1923 ofp_print_error(&string, error);
1925 ds_put_hex_dump(&string, oh, len, 0, true);
1926 return ds_steal_cstr(&string);
1930 print_and_free(FILE *stream, char *string)
1932 fputs(string, stream);
1936 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1937 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
1938 * numbers increase verbosity. */
1940 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1942 print_and_free(stream, ofp_to_string(oh, len, verbosity));
1945 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1946 * 'data' to 'stream'. */
1948 ofp_print_packet(FILE *stream, const void *data, size_t len)
1950 print_and_free(stream, ofp_packet_to_string(data, len));