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_SET_FIELD: return "SET_FIELD";
461 case OFPUTIL_A_ENQUEUE: return "ENQUEUE";
462 case OFPUTIL_A_COPY_TTL_OUT: return "COPY_TTL_OUT";
463 case OFPUTIL_A_COPY_TTL_IN: return "COPY_TTL_IN";
464 case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
465 case OFPUTIL_A_SET_MPLS_TC: return "SET_MPLS_TC";
466 case OFPUTIL_A_SET_MPLS_TTL: return "SET_MPLS_TTL";
467 case OFPUTIL_A_DEC_MPLS_TTL: return "DEC_MPLS_TTL";
468 case OFPUTIL_A_PUSH_VLAN: return "PUSH_VLAN";
469 case OFPUTIL_A_POP_VLAN: return "POP_VLAN";
470 case OFPUTIL_A_PUSH_MPLS: return "PUSH_MPLS";
471 case OFPUTIL_A_POP_MPLS: return "POP_MPLS";
472 case OFPUTIL_A_SET_QUEUE: return "SET_QUEUE";
473 case OFPUTIL_A_GROUP: return "GROUP";
474 case OFPUTIL_A_SET_NW_TTL: return "SET_NW_TTL";
475 case OFPUTIL_A_DEC_NW_TTL: return "DEC_NW_TTL";
482 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
484 struct ofputil_switch_features features;
488 error = ofputil_decode_switch_features(oh, &features, &b);
490 ofp_print_error(string, error);
494 ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
495 ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32"\n",
496 features.n_tables, features.n_buffers);
498 ds_put_cstr(string, "capabilities: ");
499 ofp_print_bit_names(string, features.capabilities,
500 ofputil_capabilities_to_name, ' ');
501 ds_put_char(string, '\n');
503 switch ((enum ofp_version)oh->version) {
505 ds_put_cstr(string, "actions: ");
506 ofp_print_bit_names(string, features.actions,
507 ofputil_action_bitmap_to_name, ' ');
508 ds_put_char(string, '\n');
517 ofp_print_phy_ports(string, oh->version, &b);
521 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
523 enum ofp_config_flags flags;
525 flags = ntohs(osc->flags);
527 ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
528 flags &= ~OFPC_FRAG_MASK;
530 if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
531 ds_put_format(string, " invalid_ttl_to_controller");
532 flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
536 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
539 ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
542 static void print_wild(struct ds *string, const char *leader, int is_wild,
543 int verbosity, const char *format, ...)
544 __attribute__((format(printf, 5, 6)));
546 static void print_wild(struct ds *string, const char *leader, int is_wild,
547 int verbosity, const char *format, ...)
549 if (is_wild && verbosity < 2) {
552 ds_put_cstr(string, leader);
556 va_start(args, format);
557 ds_put_format_valist(string, format, args);
560 ds_put_char(string, '*');
562 ds_put_char(string, ',');
566 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
567 uint32_t wild_bits, int verbosity)
569 if (wild_bits >= 32 && verbosity < 2) {
572 ds_put_cstr(string, leader);
573 if (wild_bits < 32) {
574 ds_put_format(string, IP_FMT, IP_ARGS(&ip));
576 ds_put_format(string, "/%d", 32 - wild_bits);
579 ds_put_char(string, '*');
581 ds_put_char(string, ',');
585 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
587 char *s = ofp10_match_to_string(om, verbosity);
593 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
595 struct ds f = DS_EMPTY_INITIALIZER;
596 uint32_t w = ntohl(om->wildcards);
597 bool skip_type = false;
598 bool skip_proto = false;
600 if (!(w & OFPFW10_DL_TYPE)) {
602 if (om->dl_type == htons(ETH_TYPE_IP)) {
603 if (!(w & OFPFW10_NW_PROTO)) {
605 if (om->nw_proto == IPPROTO_ICMP) {
606 ds_put_cstr(&f, "icmp,");
607 } else if (om->nw_proto == IPPROTO_TCP) {
608 ds_put_cstr(&f, "tcp,");
609 } else if (om->nw_proto == IPPROTO_UDP) {
610 ds_put_cstr(&f, "udp,");
612 ds_put_cstr(&f, "ip,");
616 ds_put_cstr(&f, "ip,");
618 } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
619 ds_put_cstr(&f, "arp,");
624 print_wild(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
625 "%d", ntohs(om->in_port));
626 print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
627 "%d", ntohs(om->dl_vlan));
628 print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
629 "%d", om->dl_vlan_pcp);
630 print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
631 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
632 print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
633 ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
635 print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
636 "0x%04x", ntohs(om->dl_type));
638 print_ip_netmask(&f, "nw_src=", om->nw_src,
639 (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
641 print_ip_netmask(&f, "nw_dst=", om->nw_dst,
642 (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
645 if (om->dl_type == htons(ETH_TYPE_ARP)) {
646 print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
649 print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
653 print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
655 if (om->nw_proto == IPPROTO_ICMP) {
656 print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
657 "%d", ntohs(om->tp_src));
658 print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
659 "%d", ntohs(om->tp_dst));
661 print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
662 "%d", ntohs(om->tp_src));
663 print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
664 "%d", ntohs(om->tp_dst));
666 if (ds_last(&f) == ',') {
673 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
675 struct ofputil_flow_mod fm;
676 struct ofpbuf ofpacts;
680 enum ofputil_protocol protocol;
682 protocol = ofputil_protocol_from_ofp_version(oh->version);
683 protocol = ofputil_protocol_set_tid(protocol, true);
685 ofpbuf_init(&ofpacts, 64);
686 error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts);
688 ofpbuf_uninit(&ofpacts);
689 ofp_print_error(s, error);
694 switch (fm.command) {
696 ds_put_cstr(s, "ADD");
699 ds_put_cstr(s, "MOD");
701 case OFPFC_MODIFY_STRICT:
702 ds_put_cstr(s, "MOD_STRICT");
705 ds_put_cstr(s, "DEL");
707 case OFPFC_DELETE_STRICT:
708 ds_put_cstr(s, "DEL_STRICT");
711 ds_put_format(s, "cmd:%d", fm.command);
713 if (fm.table_id != 0) {
714 ds_put_format(s, " table:%d", fm.table_id);
718 ofpraw_decode(&raw, oh);
719 if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
720 const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
721 ofp10_match_print(s, &ofm->match, verbosity);
723 /* ofp_print_match() doesn't print priority. */
724 need_priority = true;
725 } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
726 const struct nx_flow_mod *nfm = ofpmsg_body(oh);
727 const void *nxm = nfm + 1;
730 nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
731 ds_put_cstr(s, nxm_s);
734 /* nx_match_to_string() doesn't print priority. */
735 need_priority = true;
737 match_format(&fm.match, s, fm.priority);
739 /* match_format() does print priority. */
740 need_priority = false;
743 if (ds_last(s) != ' ') {
746 if (fm.new_cookie != htonll(0)) {
747 ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
749 if (fm.cookie_mask != htonll(0)) {
750 ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
751 ntohll(fm.cookie), ntohll(fm.cookie_mask));
753 if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
754 ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
756 if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
757 ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
759 if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
760 ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
762 if (fm.buffer_id != UINT32_MAX) {
763 ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
765 if (fm.out_port != OFPP_NONE) {
766 ds_put_format(s, "out_port:");
767 ofputil_format_port(fm.out_port, s);
771 uint16_t flags = fm.flags;
773 if (flags & OFPFF_SEND_FLOW_REM) {
774 ds_put_cstr(s, "send_flow_rem ");
776 if (flags & OFPFF_CHECK_OVERLAP) {
777 ds_put_cstr(s, "check_overlap ");
779 if (flags & OFPFF10_EMERG) {
780 ds_put_cstr(s, "emerg ");
783 flags &= ~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF10_EMERG);
785 ds_put_format(s, "flags:0x%"PRIx16" ", flags);
789 ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
790 ofpbuf_uninit(&ofpacts);
794 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
796 ds_put_format(string, "%u", sec);
798 ds_put_format(string, ".%09u", nsec);
799 while (string->string[string->length - 1] == '0') {
803 ds_put_char(string, 's');
807 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason)
812 case OFPRR_IDLE_TIMEOUT:
814 case OFPRR_HARD_TIMEOUT:
818 case OFPRR_GROUP_DELETE:
819 return "group_delete";
823 sprintf(s, "%d", (int) reason);
829 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
831 struct ofputil_flow_removed fr;
834 error = ofputil_decode_flow_removed(&fr, oh);
836 ofp_print_error(string, error);
840 ds_put_char(string, ' ');
841 match_format(&fr.match, string, fr.priority);
843 ds_put_format(string, " reason=%s",
844 ofp_flow_removed_reason_to_string(fr.reason));
846 if (fr.cookie != htonll(0)) {
847 ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
849 ds_put_cstr(string, " duration");
850 ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
851 ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
852 if (fr.hard_timeout) {
853 /* The hard timeout was only added in OF1.2, so only print it if it is
854 * actually in use to avoid gratuitous change to the formatting. */
855 ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
857 ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
858 fr.packet_count, fr.byte_count);
862 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
864 struct ofputil_port_mod pm;
867 error = ofputil_decode_port_mod(oh, &pm);
869 ofp_print_error(string, error);
873 ds_put_format(string, "port: %"PRIu16": addr:"ETH_ADDR_FMT"\n",
874 pm.port_no, ETH_ADDR_ARGS(pm.hw_addr));
876 ds_put_format(string, " config: ");
877 ofp_print_port_config(string, pm.config);
879 ds_put_format(string, " mask: ");
880 ofp_print_port_config(string, pm.mask);
882 ds_put_format(string, " advertise: ");
884 ofp_print_port_features(string, pm.advertise);
886 ds_put_format(string, "UNCHANGED\n");
891 ofp_print_error(struct ds *string, enum ofperr error)
893 if (string->length) {
894 ds_put_char(string, ' ');
896 ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
900 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
902 size_t len = ntohs(oh->length);
903 struct ofpbuf payload;
907 error = ofperr_decode_msg(oh, &payload);
909 ds_put_cstr(string, "***decode error***");
910 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
914 ds_put_format(string, " %s\n", ofperr_get_name(error));
916 if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
917 ds_put_printable(string, payload.data, payload.size);
919 s = ofp_to_string(payload.data, payload.size, 1);
920 ds_put_cstr(string, s);
926 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
928 struct ofputil_port_status ps;
931 error = ofputil_decode_port_status(oh, &ps);
933 ofp_print_error(string, error);
937 if (ps.reason == OFPPR_ADD) {
938 ds_put_format(string, " ADD:");
939 } else if (ps.reason == OFPPR_DELETE) {
940 ds_put_format(string, " DEL:");
941 } else if (ps.reason == OFPPR_MODIFY) {
942 ds_put_format(string, " MOD:");
945 ofp_print_phy_port(string, &ps.desc);
949 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
951 const struct ofp_desc_stats *ods = ofpmsg_body(oh);
953 ds_put_char(string, '\n');
954 ds_put_format(string, "Manufacturer: %.*s\n",
955 (int) sizeof ods->mfr_desc, ods->mfr_desc);
956 ds_put_format(string, "Hardware: %.*s\n",
957 (int) sizeof ods->hw_desc, ods->hw_desc);
958 ds_put_format(string, "Software: %.*s\n",
959 (int) sizeof ods->sw_desc, ods->sw_desc);
960 ds_put_format(string, "Serial Num: %.*s\n",
961 (int) sizeof ods->serial_num, ods->serial_num);
962 ds_put_format(string, "DP Description: %.*s\n",
963 (int) sizeof ods->dp_desc, ods->dp_desc);
967 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
969 struct ofputil_flow_stats_request fsr;
972 error = ofputil_decode_flow_stats_request(&fsr, oh);
974 ofp_print_error(string, error);
978 if (fsr.table_id != 0xff) {
979 ds_put_format(string, " table=%"PRIu8, fsr.table_id);
982 if (fsr.out_port != OFPP_NONE) {
983 ds_put_cstr(string, " out_port=");
984 ofputil_format_port(fsr.out_port, string);
987 ds_put_char(string, ' ');
988 match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
992 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
994 ds_put_format(string, " cookie=0x%"PRIx64", duration=",
997 ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
998 ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
999 ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1000 ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1001 if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1002 ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1004 if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1005 ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1007 if (fs->idle_age >= 0) {
1008 ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1010 if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1011 ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1014 match_format(&fs->match, string, fs->priority);
1015 if (string->string[string->length - 1] != ' ') {
1016 ds_put_char(string, ' ');
1019 ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1023 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1025 struct ofpbuf ofpacts;
1028 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1029 ofpbuf_init(&ofpacts, 64);
1031 struct ofputil_flow_stats fs;
1034 retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1036 if (retval != EOF) {
1037 ds_put_cstr(string, " ***parse error***");
1041 ds_put_char(string, '\n');
1042 ofp_print_flow_stats(string, &fs);
1044 ofpbuf_uninit(&ofpacts);
1048 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1050 struct ofputil_aggregate_stats as;
1053 error = ofputil_decode_aggregate_stats_reply(&as, oh);
1055 ofp_print_error(string, error);
1059 ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1060 ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1061 ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1064 static void print_port_stat(struct ds *string, const char *leader,
1065 const ovs_32aligned_be64 *statp, int more)
1067 uint64_t stat = ntohll(get_32aligned_be64(statp));
1069 ds_put_cstr(string, leader);
1070 if (stat != UINT64_MAX) {
1071 ds_put_format(string, "%"PRIu64, stat);
1073 ds_put_char(string, '?');
1076 ds_put_cstr(string, ", ");
1078 ds_put_cstr(string, "\n");
1083 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1085 const struct ofp10_port_stats_request *psr = ofpmsg_body(oh);
1086 ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1090 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1093 struct ofp10_port_stats *ps;
1097 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1098 ofpraw_pull_assert(&b);
1100 n = b.size / sizeof *ps;
1101 ds_put_format(string, " %zu ports\n", n);
1102 if (verbosity < 1) {
1107 ps = ofpbuf_try_pull(&b, sizeof *ps);
1112 ds_put_format(string, " port %2"PRIu16": ", ntohs(ps->port_no));
1114 ds_put_cstr(string, "rx ");
1115 print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1116 print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1117 print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1118 print_port_stat(string, "errs=", &ps->rx_errors, 1);
1119 print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1120 print_port_stat(string, "over=", &ps->rx_over_err, 1);
1121 print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1123 ds_put_cstr(string, " tx ");
1124 print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1125 print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1126 print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1127 print_port_stat(string, "errs=", &ps->tx_errors, 1);
1128 print_port_stat(string, "coll=", &ps->collisions, 0);
1133 ofp_print_one_ofpst_table_reply(struct ds *string, enum ofp_version ofp_version,
1134 const char *name, struct ofp12_table_stats *ts)
1136 char name_[OFP_MAX_TABLE_NAME_LEN + 1];
1138 ovs_strlcpy(name_, name, sizeof name_);
1140 ds_put_format(string, " %d: %-8s: ", ts->table_id, name_);
1141 ds_put_format(string, "wild=0x%05"PRIx64", ", ntohll(ts->wildcards));
1142 ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1143 ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1144 ds_put_cstr(string, " ");
1145 ds_put_format(string, "lookup=%"PRIu64", ", ntohll(ts->lookup_count));
1146 ds_put_format(string, "matched=%"PRIu64"\n", ntohll(ts->matched_count));
1148 if (ofp_version < OFP11_VERSION) {
1152 ds_put_cstr(string, " ");
1153 ds_put_format(string, "match=0x%08"PRIx64", ", ntohll(ts->match));
1154 ds_put_format(string, "instructions=0x%08"PRIx32", ",
1155 ntohl(ts->instructions));
1156 ds_put_format(string, "config=0x%08"PRIx32"\n", ntohl(ts->config));
1157 ds_put_cstr(string, " ");
1158 ds_put_format(string, "write_actions=0x%08"PRIx32", ",
1159 ntohl(ts->write_actions));
1160 ds_put_format(string, "apply_actions=0x%08"PRIx32"\n",
1161 ntohl(ts->apply_actions));
1163 if (ofp_version < OFP12_VERSION) {
1167 ds_put_cstr(string, " ");
1168 ds_put_format(string, "write_setfields=0x%016"PRIx64"\n",
1169 ntohll(ts->write_setfields));
1170 ds_put_cstr(string, " ");
1171 ds_put_format(string, "apply_setfields=0x%016"PRIx64"\n",
1172 ntohll(ts->apply_setfields));
1173 ds_put_cstr(string, " ");
1174 ds_put_format(string, "metadata_match=0x%016"PRIx64"\n",
1175 ntohll(ts->metadata_match));
1176 ds_put_cstr(string, " ");
1177 ds_put_format(string, "metadata_write=0x%016"PRIx64"\n",
1178 ntohll(ts->metadata_write));
1182 ofp_print_ofpst_table_reply12(struct ds *string, const struct ofp_header *oh,
1185 struct ofp12_table_stats *ts;
1189 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1190 ofpraw_pull_assert(&b);
1192 n = b.size / sizeof *ts;
1193 ds_put_format(string, " %zu tables\n", n);
1194 if (verbosity < 1) {
1199 ts = ofpbuf_try_pull(&b, sizeof *ts);
1204 ofp_print_one_ofpst_table_reply(string, OFP12_VERSION, ts->name, ts);
1209 ofp_print_ofpst_table_reply11(struct ds *string, const struct ofp_header *oh,
1212 struct ofp11_table_stats *ts;
1216 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1217 ofpraw_pull_assert(&b);
1219 n = b.size / sizeof *ts;
1220 ds_put_format(string, " %zu tables\n", n);
1221 if (verbosity < 1) {
1226 struct ofp12_table_stats ts12;
1228 ts = ofpbuf_try_pull(&b, sizeof *ts);
1233 ts12.table_id = ts->table_id;
1234 ts12.wildcards = htonll(ntohl(ts->wildcards));
1235 ts12.max_entries = ts->max_entries;
1236 ts12.active_count = ts->active_count;
1237 ts12.lookup_count = ts->lookup_count;
1238 ts12.matched_count = ts->matched_count;
1239 ts12.match = htonll(ntohl(ts->match));
1240 ts12.instructions = ts->instructions;
1241 ts12.config = ts->config;
1242 ts12.write_actions = ts->write_actions;
1243 ts12.apply_actions = ts->apply_actions;
1244 ofp_print_one_ofpst_table_reply(string, OFP11_VERSION, ts->name, &ts12);
1249 ofp_print_ofpst_table_reply10(struct ds *string, const struct ofp_header *oh,
1252 struct ofp10_table_stats *ts;
1256 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1257 ofpraw_pull_assert(&b);
1259 n = b.size / sizeof *ts;
1260 ds_put_format(string, " %zu tables\n", n);
1261 if (verbosity < 1) {
1266 struct ofp12_table_stats ts12;
1268 ts = ofpbuf_try_pull(&b, sizeof *ts);
1273 ts12.table_id = ts->table_id;
1274 ts12.wildcards = htonll(ntohl(ts->wildcards));
1275 ts12.max_entries = ts->max_entries;
1276 ts12.active_count = ts->active_count;
1277 ts12.lookup_count = get_32aligned_be64(&ts->lookup_count);
1278 ts12.matched_count = get_32aligned_be64(&ts->matched_count);
1279 ofp_print_one_ofpst_table_reply(string, OFP10_VERSION, ts->name, &ts12);
1284 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1287 switch ((enum ofp_version)oh->version) {
1289 ofp_print_ofpst_table_reply12(string, oh, verbosity);
1293 ofp_print_ofpst_table_reply11(string, oh, verbosity);
1297 ofp_print_ofpst_table_reply10(string, oh, verbosity);
1306 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1308 if (queue_id == OFPQ_ALL) {
1309 ds_put_cstr(string, "ALL");
1311 ds_put_format(string, "%"PRIu32, queue_id);
1316 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1318 const struct ofp10_queue_stats_request *qsr = ofpmsg_body(oh);
1320 ds_put_cstr(string, "port=");
1321 ofputil_format_port(ntohs(qsr->port_no), string);
1323 ds_put_cstr(string, " queue=");
1324 ofp_print_queue_name(string, ntohl(qsr->queue_id));
1328 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1331 struct ofp10_queue_stats *qs;
1335 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1336 ofpraw_pull_assert(&b);
1338 n = b.size / sizeof *qs;
1339 ds_put_format(string, " %zu queues\n", n);
1340 if (verbosity < 1) {
1345 qs = ofpbuf_try_pull(&b, sizeof *qs);
1350 ds_put_cstr(string, " port ");
1351 ofputil_format_port(ntohs(qs->port_no), string);
1352 ds_put_cstr(string, " queue ");
1353 ofp_print_queue_name(string, ntohl(qs->queue_id));
1354 ds_put_cstr(string, ": ");
1356 print_port_stat(string, "bytes=", &qs->tx_bytes, 1);
1357 print_port_stat(string, "pkts=", &qs->tx_packets, 1);
1358 print_port_stat(string, "errors=", &qs->tx_errors, 0);
1363 ofp_print_ofpst_port_desc_reply(struct ds *string,
1364 const struct ofp_header *oh)
1368 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1369 ofpraw_pull_assert(&b);
1370 ds_put_char(string, '\n');
1371 ofp_print_phy_ports(string, oh->version, &b);
1375 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1377 uint16_t flags = ofpmp_flags(oh);
1380 ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1385 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1387 uint16_t flags = ofpmp_flags(oh);
1390 ds_put_cstr(string, " flags=");
1391 if (flags & OFPSF_REPLY_MORE) {
1392 ds_put_cstr(string, "[more]");
1393 flags &= ~OFPSF_REPLY_MORE;
1396 ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1403 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1405 size_t len = ntohs(oh->length);
1407 ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1408 if (verbosity > 1) {
1409 ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1414 ofp_print_nxt_role_message(struct ds *string,
1415 const struct nx_role_request *nrr)
1417 unsigned int role = ntohl(nrr->role);
1419 ds_put_cstr(string, " role=");
1420 if (role == NX_ROLE_OTHER) {
1421 ds_put_cstr(string, "other");
1422 } else if (role == NX_ROLE_MASTER) {
1423 ds_put_cstr(string, "master");
1424 } else if (role == NX_ROLE_SLAVE) {
1425 ds_put_cstr(string, "slave");
1427 ds_put_format(string, "%u", role);
1432 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1433 const struct nx_flow_mod_table_id *nfmti)
1435 ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1439 ofp_print_nxt_set_flow_format(struct ds *string,
1440 const struct nx_set_flow_format *nsff)
1442 uint32_t format = ntohl(nsff->format);
1444 ds_put_cstr(string, " format=");
1445 if (ofputil_nx_flow_format_is_valid(format)) {
1446 ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1448 ds_put_format(string, "%"PRIu32, format);
1453 ofp_print_nxt_set_packet_in_format(struct ds *string,
1454 const struct nx_set_packet_in_format *nspf)
1456 uint32_t format = ntohl(nspf->format);
1458 ds_put_cstr(string, " format=");
1459 if (ofputil_packet_in_format_is_valid(format)) {
1460 ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1462 ds_put_format(string, "%"PRIu32, format);
1467 ofp_port_reason_to_string(enum ofp_port_reason reason)
1482 sprintf(s, "%d", (int) reason);
1488 ofp_print_nxt_set_async_config(struct ds *string,
1489 const struct nx_async_config *nac)
1493 for (i = 0; i < 2; i++) {
1496 ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1498 ds_put_cstr(string, " PACKET_IN:");
1499 for (j = 0; j < 32; j++) {
1500 if (nac->packet_in_mask[i] & htonl(1u << j)) {
1501 ds_put_format(string, " %s",
1502 ofputil_packet_in_reason_to_string(j));
1505 if (!nac->packet_in_mask[i]) {
1506 ds_put_cstr(string, " (off)");
1508 ds_put_char(string, '\n');
1510 ds_put_cstr(string, " PORT_STATUS:");
1511 for (j = 0; j < 32; j++) {
1512 if (nac->port_status_mask[i] & htonl(1u << j)) {
1513 ds_put_format(string, " %s", ofp_port_reason_to_string(j));
1516 if (!nac->port_status_mask[i]) {
1517 ds_put_cstr(string, " (off)");
1519 ds_put_char(string, '\n');
1521 ds_put_cstr(string, " FLOW_REMOVED:");
1522 for (j = 0; j < 32; j++) {
1523 if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1524 ds_put_format(string, " %s",
1525 ofp_flow_removed_reason_to_string(j));
1528 if (!nac->flow_removed_mask[i]) {
1529 ds_put_cstr(string, " (off)");
1531 ds_put_char(string, '\n');
1536 ofp_print_nxt_set_controller_id(struct ds *string,
1537 const struct nx_controller_id *nci)
1539 ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1543 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1544 const struct ofp_header *oh)
1546 ds_put_format(string, " id=%"PRIu32,
1547 ofputil_decode_flow_monitor_cancel(oh));
1551 nx_flow_monitor_flags_to_name(uint32_t bit)
1553 enum nx_flow_monitor_flags fmf = bit;
1556 case NXFMF_INITIAL: return "initial";
1557 case NXFMF_ADD: return "add";
1558 case NXFMF_DELETE: return "delete";
1559 case NXFMF_MODIFY: return "modify";
1560 case NXFMF_ACTIONS: return "actions";
1561 case NXFMF_OWN: return "own";
1568 ofp_print_nxst_flow_monitor_request(struct ds *string,
1569 const struct ofp_header *oh)
1573 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1575 struct ofputil_flow_monitor_request request;
1578 retval = ofputil_decode_flow_monitor_request(&request, &b);
1580 if (retval != EOF) {
1581 ofp_print_error(string, retval);
1586 ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
1587 ofp_print_bit_names(string, request.flags,
1588 nx_flow_monitor_flags_to_name, ',');
1590 if (request.out_port != OFPP_NONE) {
1591 ds_put_cstr(string, " out_port=");
1592 ofputil_format_port(request.out_port, string);
1595 if (request.table_id != 0xff) {
1596 ds_put_format(string, " table=%"PRIu8, request.table_id);
1599 ds_put_char(string, ' ');
1600 match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
1601 ds_chomp(string, ' ');
1606 ofp_print_nxst_flow_monitor_reply(struct ds *string,
1607 const struct ofp_header *oh)
1609 uint64_t ofpacts_stub[1024 / 8];
1610 struct ofpbuf ofpacts;
1613 ofpbuf_use_const(&b, oh, ntohs(oh->length));
1614 ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
1616 struct ofputil_flow_update update;
1620 update.match = &match;
1621 retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
1623 if (retval != EOF) {
1624 ofp_print_error(string, retval);
1626 ofpbuf_uninit(&ofpacts);
1630 ds_put_cstr(string, "\n event=");
1631 switch (update.event) {
1633 ds_put_cstr(string, "ADDED");
1637 ds_put_format(string, "DELETED reason=%s",
1638 ofp_flow_removed_reason_to_string(update.reason));
1641 case NXFME_MODIFIED:
1642 ds_put_cstr(string, "MODIFIED");
1646 ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
1650 ds_put_format(string, " table=%"PRIu8, update.table_id);
1651 if (update.idle_timeout != OFP_FLOW_PERMANENT) {
1652 ds_put_format(string, " idle_timeout=%"PRIu16,
1653 update.idle_timeout);
1655 if (update.hard_timeout != OFP_FLOW_PERMANENT) {
1656 ds_put_format(string, " hard_timeout=%"PRIu16,
1657 update.hard_timeout);
1659 ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
1661 ds_put_char(string, ' ');
1662 match_format(update.match, string, OFP_DEFAULT_PRIORITY);
1664 if (update.ofpacts_len) {
1665 if (string->string[string->length - 1] != ' ') {
1666 ds_put_char(string, ' ');
1668 ofpacts_format(update.ofpacts, update.ofpacts_len, string);
1674 ofp_print_version(const struct ofp_header *oh,
1677 switch (oh->version) {
1681 ds_put_cstr(string, " (OF1.1)");
1684 ds_put_cstr(string, " (OF1.2)");
1687 ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
1690 ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
1694 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1697 ds_put_cstr(string, ofpraw_get_name(raw));
1698 ofp_print_version(oh, string);
1702 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
1703 struct ds *string, int verbosity)
1705 const void *msg = oh;
1707 ofp_header_to_string__(oh, raw, string);
1708 switch (ofptype_from_ofpraw(raw)) {
1710 ds_put_char(string, '\n');
1711 ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1716 ofp_print_error_msg(string, oh);
1719 case OFPTYPE_ECHO_REQUEST:
1720 case OFPTYPE_ECHO_REPLY:
1721 ofp_print_echo(string, oh, verbosity);
1724 case OFPTYPE_FEATURES_REQUEST:
1727 case OFPTYPE_FEATURES_REPLY:
1728 ofp_print_switch_features(string, oh);
1731 case OFPTYPE_GET_CONFIG_REQUEST:
1734 case OFPTYPE_GET_CONFIG_REPLY:
1735 case OFPTYPE_SET_CONFIG:
1736 ofp_print_switch_config(string, ofpmsg_body(oh));
1739 case OFPTYPE_PACKET_IN:
1740 ofp_print_packet_in(string, oh, verbosity);
1743 case OFPTYPE_FLOW_REMOVED:
1744 ofp_print_flow_removed(string, oh);
1747 case OFPTYPE_PORT_STATUS:
1748 ofp_print_port_status(string, oh);
1751 case OFPTYPE_PACKET_OUT:
1752 ofp_print_packet_out(string, oh, verbosity);
1755 case OFPTYPE_FLOW_MOD:
1756 ofp_print_flow_mod(string, oh, verbosity);
1759 case OFPTYPE_PORT_MOD:
1760 ofp_print_port_mod(string, oh);
1763 case OFPTYPE_BARRIER_REQUEST:
1764 case OFPTYPE_BARRIER_REPLY:
1767 case OFPTYPE_DESC_STATS_REQUEST:
1768 case OFPTYPE_PORT_DESC_STATS_REQUEST:
1769 ofp_print_stats_request(string, oh);
1772 case OFPTYPE_FLOW_STATS_REQUEST:
1773 case OFPTYPE_AGGREGATE_STATS_REQUEST:
1774 ofp_print_stats_request(string, oh);
1775 ofp_print_flow_stats_request(string, oh);
1778 case OFPTYPE_TABLE_STATS_REQUEST:
1779 ofp_print_stats_request(string, oh);
1782 case OFPTYPE_PORT_STATS_REQUEST:
1783 ofp_print_stats_request(string, oh);
1784 ofp_print_ofpst_port_request(string, oh);
1787 case OFPTYPE_QUEUE_STATS_REQUEST:
1788 ofp_print_stats_request(string, oh);
1789 ofp_print_ofpst_queue_request(string, oh);
1792 case OFPTYPE_DESC_STATS_REPLY:
1793 ofp_print_stats_reply(string, oh);
1794 ofp_print_ofpst_desc_reply(string, oh);
1797 case OFPTYPE_FLOW_STATS_REPLY:
1798 ofp_print_stats_reply(string, oh);
1799 ofp_print_flow_stats_reply(string, oh);
1802 case OFPTYPE_QUEUE_STATS_REPLY:
1803 ofp_print_stats_reply(string, oh);
1804 ofp_print_ofpst_queue_reply(string, oh, verbosity);
1807 case OFPTYPE_PORT_STATS_REPLY:
1808 ofp_print_stats_reply(string, oh);
1809 ofp_print_ofpst_port_reply(string, oh, verbosity);
1812 case OFPTYPE_TABLE_STATS_REPLY:
1813 ofp_print_stats_reply(string, oh);
1814 ofp_print_ofpst_table_reply(string, oh, verbosity);
1817 case OFPTYPE_AGGREGATE_STATS_REPLY:
1818 ofp_print_stats_reply(string, oh);
1819 ofp_print_aggregate_stats_reply(string, oh);
1822 case OFPTYPE_PORT_DESC_STATS_REPLY:
1823 ofp_print_stats_reply(string, oh);
1824 ofp_print_ofpst_port_desc_reply(string, oh);
1827 case OFPTYPE_ROLE_REQUEST:
1828 case OFPTYPE_ROLE_REPLY:
1829 ofp_print_nxt_role_message(string, ofpmsg_body(oh));
1832 case OFPTYPE_FLOW_MOD_TABLE_ID:
1833 ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
1836 case OFPTYPE_SET_FLOW_FORMAT:
1837 ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
1840 case OFPTYPE_SET_PACKET_IN_FORMAT:
1841 ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
1844 case OFPTYPE_FLOW_AGE:
1847 case OFPTYPE_SET_CONTROLLER_ID:
1848 ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
1851 case OFPTYPE_SET_ASYNC_CONFIG:
1852 ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
1855 case OFPTYPE_FLOW_MONITOR_CANCEL:
1856 ofp_print_nxt_flow_monitor_cancel(string, msg);
1859 case OFPTYPE_FLOW_MONITOR_PAUSED:
1860 case OFPTYPE_FLOW_MONITOR_RESUMED:
1863 case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
1864 ofp_print_nxst_flow_monitor_request(string, msg);
1867 case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
1868 ofp_print_nxst_flow_monitor_reply(string, msg);
1873 /* Composes and returns a string representing the OpenFlow packet of 'len'
1874 * bytes at 'oh' at the given 'verbosity' level. 0 is a minimal amount of
1875 * verbosity and higher numbers increase verbosity. The caller is responsible
1876 * for freeing the string. */
1878 ofp_to_string(const void *oh_, size_t len, int verbosity)
1880 struct ds string = DS_EMPTY_INITIALIZER;
1881 const struct ofp_header *oh = oh_;
1884 ds_put_cstr(&string, "OpenFlow message is empty\n");
1885 } else if (len < sizeof(struct ofp_header)) {
1886 ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1888 } else if (ntohs(oh->length) > len) {
1892 error = ofpraw_decode_partial(&raw, oh, len);
1894 ofp_header_to_string__(oh, raw, &string);
1895 ds_put_char(&string, '\n');
1898 ds_put_format(&string,
1899 "(***truncated to %zu bytes from %"PRIu16"***)\n",
1900 len, ntohs(oh->length));
1901 } else if (ntohs(oh->length) < len) {
1902 ds_put_format(&string,
1903 "(***only uses %"PRIu16" bytes out of %zu***)\n",
1904 ntohs(oh->length), len);
1909 error = ofpraw_decode(&raw, oh);
1911 ofp_to_string__(oh, raw, &string, verbosity);
1912 if (verbosity >= 5) {
1913 if (ds_last(&string) != '\n') {
1914 ds_put_char(&string, '\n');
1916 ds_put_hex_dump(&string, oh, len, 0, true);
1918 if (ds_last(&string) != '\n') {
1919 ds_put_char(&string, '\n');
1921 return ds_steal_cstr(&string);
1924 ofp_print_error(&string, error);
1926 ds_put_hex_dump(&string, oh, len, 0, true);
1927 return ds_steal_cstr(&string);
1931 print_and_free(FILE *stream, char *string)
1933 fputs(string, stream);
1937 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1938 * given 'verbosity' level. 0 is a minimal amount of verbosity and higher
1939 * numbers increase verbosity. */
1941 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1943 print_and_free(stream, ofp_to_string(oh, len, verbosity));
1946 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1947 * 'data' to 'stream'. */
1949 ofp_print_packet(FILE *stream, const void *data, size_t len)
1951 print_and_free(stream, ofp_packet_to_string(data, len));