1f22dd75332f0481e14b4b3ba843093bb9c147b7
[cascardo/ovs.git] / lib / ofp-print.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #include <config.h>
18 #include "ofp-print.h"
19
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <sys/types.h>
23 #include <netinet/in.h>
24 #include <sys/wait.h>
25 #include <stdarg.h>
26 #include <stdlib.h>
27 #include <ctype.h>
28
29 #include "bundle.h"
30 #include "byte-order.h"
31 #include "compiler.h"
32 #include "dynamic-string.h"
33 #include "flow.h"
34 #include "learn.h"
35 #include "multipath.h"
36 #include "meta-flow.h"
37 #include "netdev.h"
38 #include "nx-match.h"
39 #include "ofp-actions.h"
40 #include "ofpbuf.h"
41 #include "ofp-errors.h"
42 #include "ofp-msgs.h"
43 #include "ofp-util.h"
44 #include "openflow/openflow.h"
45 #include "openflow/nicira-ext.h"
46 #include "packets.h"
47 #include "dp-packet.h"
48 #include "type-props.h"
49 #include "unaligned.h"
50 #include "odp-util.h"
51 #include "util.h"
52
53 static void ofp_print_queue_name(struct ds *string, uint32_t port);
54 static void ofp_print_error(struct ds *, enum ofperr);
55
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.*/
58 char *
59 ofp_packet_to_string(const void *data, size_t len)
60 {
61     struct ds ds = DS_EMPTY_INITIALIZER;
62     struct dp_packet buf;
63     struct flow flow;
64     size_t l4_size;
65
66     dp_packet_use_const(&buf, data, len);
67     flow_extract(&buf, &flow);
68     flow_format(&ds, &flow);
69
70     l4_size = dp_packet_l4_size(&buf);
71
72     if (flow.nw_proto == IPPROTO_TCP && l4_size >= TCP_HEADER_LEN) {
73         struct tcp_header *th = dp_packet_l4(&buf);
74         ds_put_format(&ds, " tcp_csum:%"PRIx16, ntohs(th->tcp_csum));
75     } else if (flow.nw_proto == IPPROTO_UDP && l4_size >= UDP_HEADER_LEN) {
76         struct udp_header *uh = dp_packet_l4(&buf);
77         ds_put_format(&ds, " udp_csum:%"PRIx16, ntohs(uh->udp_csum));
78     } else if (flow.nw_proto == IPPROTO_SCTP && l4_size >= SCTP_HEADER_LEN) {
79         struct sctp_header *sh = dp_packet_l4(&buf);
80         ds_put_format(&ds, " sctp_csum:%"PRIx32,
81                       ntohl(get_16aligned_be32(&sh->sctp_csum)));
82     } else if (flow.nw_proto == IPPROTO_ICMP && l4_size >= ICMP_HEADER_LEN) {
83         struct icmp_header *icmph = dp_packet_l4(&buf);
84         ds_put_format(&ds, " icmp_csum:%"PRIx16,
85                       ntohs(icmph->icmp_csum));
86     } else if (flow.nw_proto == IPPROTO_ICMPV6 && l4_size >= ICMP6_HEADER_LEN) {
87         struct icmp6_header *icmp6h = dp_packet_l4(&buf);
88         ds_put_format(&ds, " icmp6_csum:%"PRIx16,
89                       ntohs(icmp6h->icmp6_cksum));
90     }
91
92     ds_put_char(&ds, '\n');
93
94     return ds_cstr(&ds);
95 }
96
97 static void
98 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
99                     int verbosity)
100 {
101     char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
102     struct ofputil_packet_in pin;
103     int error;
104
105     error = ofputil_decode_packet_in(&pin, oh);
106     if (error) {
107         ofp_print_error(string, error);
108         return;
109     }
110
111     if (pin.table_id) {
112         ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
113     }
114
115     if (pin.cookie != OVS_BE64_MAX) {
116         ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
117     }
118
119     ds_put_format(string, " total_len=%"PRIuSIZE" ", pin.total_len);
120
121     match_format(&pin.flow_metadata, string, OFP_DEFAULT_PRIORITY);
122
123     ds_put_format(string, " (via %s)",
124                   ofputil_packet_in_reason_to_string(pin.reason, reasonbuf,
125                                                      sizeof reasonbuf));
126
127     ds_put_format(string, " data_len=%"PRIuSIZE, pin.packet_len);
128     if (pin.buffer_id == UINT32_MAX) {
129         ds_put_format(string, " (unbuffered)");
130         if (pin.total_len != pin.packet_len) {
131             ds_put_format(string, " (***total_len != data_len***)");
132         }
133     } else {
134         ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
135         if (pin.total_len < pin.packet_len) {
136             ds_put_format(string, " (***total_len < data_len***)");
137         }
138     }
139     ds_put_char(string, '\n');
140
141     if (verbosity > 0) {
142         char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
143         ds_put_cstr(string, packet);
144         free(packet);
145     }
146     if (verbosity > 2) {
147         ds_put_hex_dump(string, pin.packet, pin.packet_len, 0, false);
148     }
149 }
150
151 static void
152 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
153                      int verbosity)
154 {
155     struct ofputil_packet_out po;
156     struct ofpbuf ofpacts;
157     enum ofperr error;
158
159     ofpbuf_init(&ofpacts, 64);
160     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
161     if (error) {
162         ofpbuf_uninit(&ofpacts);
163         ofp_print_error(string, error);
164         return;
165     }
166
167     ds_put_cstr(string, " in_port=");
168     ofputil_format_port(po.in_port, string);
169
170     ds_put_cstr(string, " actions=");
171     ofpacts_format(po.ofpacts, po.ofpacts_len, string);
172
173     if (po.buffer_id == UINT32_MAX) {
174         ds_put_format(string, " data_len=%"PRIuSIZE, po.packet_len);
175         if (verbosity > 0 && po.packet_len > 0) {
176             char *packet = ofp_packet_to_string(po.packet, po.packet_len);
177             ds_put_char(string, '\n');
178             ds_put_cstr(string, packet);
179             free(packet);
180         }
181         if (verbosity > 2) {
182             ds_put_hex_dump(string, po.packet, po.packet_len, 0, false);
183         }
184     } else {
185         ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
186     }
187
188     ofpbuf_uninit(&ofpacts);
189 }
190
191 /* qsort comparison function. */
192 static int
193 compare_ports(const void *a_, const void *b_)
194 {
195     const struct ofputil_phy_port *a = a_;
196     const struct ofputil_phy_port *b = b_;
197     uint16_t ap = ofp_to_u16(a->port_no);
198     uint16_t bp = ofp_to_u16(b->port_no);
199
200     return ap < bp ? -1 : ap > bp;
201 }
202
203 static void
204 ofp_print_bit_names(struct ds *string, uint32_t bits,
205                     const char *(*bit_to_name)(uint32_t bit),
206                     char separator)
207 {
208     int n = 0;
209     int i;
210
211     if (!bits) {
212         ds_put_cstr(string, "0");
213         return;
214     }
215
216     for (i = 0; i < 32; i++) {
217         uint32_t bit = UINT32_C(1) << i;
218
219         if (bits & bit) {
220             const char *name = bit_to_name(bit);
221             if (name) {
222                 if (n++) {
223                     ds_put_char(string, separator);
224                 }
225                 ds_put_cstr(string, name);
226                 bits &= ~bit;
227             }
228         }
229     }
230
231     if (bits) {
232         if (n) {
233             ds_put_char(string, separator);
234         }
235         ds_put_format(string, "0x%"PRIx32, bits);
236     }
237 }
238
239 static const char *
240 netdev_feature_to_name(uint32_t bit)
241 {
242     enum netdev_features f = bit;
243
244     switch (f) {
245     case NETDEV_F_10MB_HD:    return "10MB-HD";
246     case NETDEV_F_10MB_FD:    return "10MB-FD";
247     case NETDEV_F_100MB_HD:   return "100MB-HD";
248     case NETDEV_F_100MB_FD:   return "100MB-FD";
249     case NETDEV_F_1GB_HD:     return "1GB-HD";
250     case NETDEV_F_1GB_FD:     return "1GB-FD";
251     case NETDEV_F_10GB_FD:    return "10GB-FD";
252     case NETDEV_F_40GB_FD:    return "40GB-FD";
253     case NETDEV_F_100GB_FD:   return "100GB-FD";
254     case NETDEV_F_1TB_FD:     return "1TB-FD";
255     case NETDEV_F_OTHER:      return "OTHER";
256     case NETDEV_F_COPPER:     return "COPPER";
257     case NETDEV_F_FIBER:      return "FIBER";
258     case NETDEV_F_AUTONEG:    return "AUTO_NEG";
259     case NETDEV_F_PAUSE:      return "AUTO_PAUSE";
260     case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
261     }
262
263     return NULL;
264 }
265
266 static void
267 ofp_print_port_features(struct ds *string, enum netdev_features features)
268 {
269     ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
270     ds_put_char(string, '\n');
271 }
272
273 static const char *
274 ofputil_port_config_to_name(uint32_t bit)
275 {
276     enum ofputil_port_config pc = bit;
277
278     switch (pc) {
279     case OFPUTIL_PC_PORT_DOWN:    return "PORT_DOWN";
280     case OFPUTIL_PC_NO_STP:       return "NO_STP";
281     case OFPUTIL_PC_NO_RECV:      return "NO_RECV";
282     case OFPUTIL_PC_NO_RECV_STP:  return "NO_RECV_STP";
283     case OFPUTIL_PC_NO_FLOOD:     return "NO_FLOOD";
284     case OFPUTIL_PC_NO_FWD:       return "NO_FWD";
285     case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
286     }
287
288     return NULL;
289 }
290
291 static void
292 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
293 {
294     ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
295     ds_put_char(string, '\n');
296 }
297
298 static const char *
299 ofputil_port_state_to_name(uint32_t bit)
300 {
301     enum ofputil_port_state ps = bit;
302
303     switch (ps) {
304     case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
305     case OFPUTIL_PS_BLOCKED:   return "BLOCKED";
306     case OFPUTIL_PS_LIVE:      return "LIVE";
307
308     case OFPUTIL_PS_STP_LISTEN:
309     case OFPUTIL_PS_STP_LEARN:
310     case OFPUTIL_PS_STP_FORWARD:
311     case OFPUTIL_PS_STP_BLOCK:
312         /* Handled elsewhere. */
313         return NULL;
314     }
315
316     return NULL;
317 }
318
319 static void
320 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
321 {
322     enum ofputil_port_state stp_state;
323
324     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
325      * pattern.  We have to special case it.
326      *
327      * OVS doesn't support STP, so this field will always be 0 if we are
328      * talking to OVS, so we'd always print STP_LISTEN in that case.
329      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
330      * avoid confusing users. */
331     stp_state = state & OFPUTIL_PS_STP_MASK;
332     if (stp_state) {
333         ds_put_cstr(string,
334                     (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
335                      : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
336                      : "STP_BLOCK"));
337         state &= ~OFPUTIL_PS_STP_MASK;
338         if (state) {
339             ofp_print_bit_names(string, state, ofputil_port_state_to_name,
340                                 ' ');
341         }
342     } else {
343         ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
344     }
345     ds_put_char(string, '\n');
346 }
347
348 static void
349 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
350 {
351     char name[sizeof port->name];
352     int j;
353
354     memcpy(name, port->name, sizeof name);
355     for (j = 0; j < sizeof name - 1; j++) {
356         if (!isprint((unsigned char) name[j])) {
357             break;
358         }
359     }
360     name[j] = '\0';
361
362     ds_put_char(string, ' ');
363     ofputil_format_port(port->port_no, string);
364     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
365                   name, ETH_ADDR_ARGS(port->hw_addr));
366
367     ds_put_cstr(string, "     config:     ");
368     ofp_print_port_config(string, port->config);
369
370     ds_put_cstr(string, "     state:      ");
371     ofp_print_port_state(string, port->state);
372
373     if (port->curr) {
374         ds_put_format(string, "     current:    ");
375         ofp_print_port_features(string, port->curr);
376     }
377     if (port->advertised) {
378         ds_put_format(string, "     advertised: ");
379         ofp_print_port_features(string, port->advertised);
380     }
381     if (port->supported) {
382         ds_put_format(string, "     supported:  ");
383         ofp_print_port_features(string, port->supported);
384     }
385     if (port->peer) {
386         ds_put_format(string, "     peer:       ");
387         ofp_print_port_features(string, port->peer);
388     }
389     ds_put_format(string, "     speed: %"PRIu32" Mbps now, "
390                   "%"PRIu32" Mbps max\n",
391                   port->curr_speed / UINT32_C(1000),
392                   port->max_speed / UINT32_C(1000));
393 }
394
395 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
396  * 'ofp_version', writes a detailed description of each port into
397  * 'string'. */
398 static void
399 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
400                     struct ofpbuf *b)
401 {
402     struct ofputil_phy_port *ports;
403     size_t allocated_ports, n_ports;
404     int retval;
405     size_t i;
406
407     ports = NULL;
408     allocated_ports = 0;
409     for (n_ports = 0; ; n_ports++) {
410         if (n_ports >= allocated_ports) {
411             ports = x2nrealloc(ports, &allocated_ports, sizeof *ports);
412         }
413
414         retval = ofputil_pull_phy_port(ofp_version, b, &ports[n_ports]);
415         if (retval) {
416             break;
417         }
418     }
419
420     qsort(ports, n_ports, sizeof *ports, compare_ports);
421     for (i = 0; i < n_ports; i++) {
422         ofp_print_phy_port(string, &ports[i]);
423     }
424     free(ports);
425
426     if (retval != EOF) {
427         ofp_print_error(string, retval);
428     }
429 }
430
431 static const char *
432 ofputil_capabilities_to_name(uint32_t bit)
433 {
434     enum ofputil_capabilities capabilities = bit;
435
436     switch (capabilities) {
437     case OFPUTIL_C_FLOW_STATS:   return "FLOW_STATS";
438     case OFPUTIL_C_TABLE_STATS:  return "TABLE_STATS";
439     case OFPUTIL_C_PORT_STATS:   return "PORT_STATS";
440     case OFPUTIL_C_IP_REASM:     return "IP_REASM";
441     case OFPUTIL_C_QUEUE_STATS:  return "QUEUE_STATS";
442     case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
443     case OFPUTIL_C_STP:          return "STP";
444     case OFPUTIL_C_GROUP_STATS:  return "GROUP_STATS";
445     case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
446     }
447
448     return NULL;
449 }
450
451 static void
452 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
453 {
454     struct ofputil_switch_features features;
455     enum ofperr error;
456     struct ofpbuf b;
457
458     error = ofputil_decode_switch_features(oh, &features, &b);
459     if (error) {
460         ofp_print_error(string, error);
461         return;
462     }
463
464     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
465
466     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32,
467                   features.n_tables, features.n_buffers);
468     if (features.auxiliary_id) {
469         ds_put_format(string, ", auxiliary_id:%"PRIu8, features.auxiliary_id);
470     }
471     ds_put_char(string, '\n');
472
473     ds_put_cstr(string, "capabilities: ");
474     ofp_print_bit_names(string, features.capabilities,
475                         ofputil_capabilities_to_name, ' ');
476     ds_put_char(string, '\n');
477
478     switch ((enum ofp_version)oh->version) {
479     case OFP10_VERSION:
480         ds_put_cstr(string, "actions: ");
481         ofpact_bitmap_format(features.ofpacts, string);
482         ds_put_char(string, '\n');
483         break;
484     case OFP11_VERSION:
485     case OFP12_VERSION:
486         break;
487     case OFP13_VERSION:
488     case OFP14_VERSION:
489     case OFP15_VERSION:
490         return; /* no ports in ofp13_switch_features */
491     default:
492         OVS_NOT_REACHED();
493     }
494
495     ofp_print_phy_ports(string, oh->version, &b);
496 }
497
498 static void
499 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
500 {
501     enum ofp_config_flags flags;
502
503     flags = ntohs(osc->flags);
504
505     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
506     flags &= ~OFPC_FRAG_MASK;
507
508     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
509         ds_put_format(string, " invalid_ttl_to_controller");
510         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
511     }
512
513     if (flags) {
514         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
515     }
516
517     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
518 }
519
520 static void print_wild(struct ds *string, const char *leader, int is_wild,
521             int verbosity, const char *format, ...)
522             OVS_PRINTF_FORMAT(5, 6);
523
524 static void print_wild(struct ds *string, const char *leader, int is_wild,
525                        int verbosity, const char *format, ...)
526 {
527     if (is_wild && verbosity < 2) {
528         return;
529     }
530     ds_put_cstr(string, leader);
531     if (!is_wild) {
532         va_list args;
533
534         va_start(args, format);
535         ds_put_format_valist(string, format, args);
536         va_end(args);
537     } else {
538         ds_put_char(string, '*');
539     }
540     ds_put_char(string, ',');
541 }
542
543 static void
544 print_wild_port(struct ds *string, const char *leader, int is_wild,
545                 int verbosity, ofp_port_t port)
546 {
547     if (is_wild && verbosity < 2) {
548         return;
549     }
550     ds_put_cstr(string, leader);
551     if (!is_wild) {
552         ofputil_format_port(port, string);
553     } else {
554         ds_put_char(string, '*');
555     }
556     ds_put_char(string, ',');
557 }
558
559 static void
560 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
561                  uint32_t wild_bits, int verbosity)
562 {
563     if (wild_bits >= 32 && verbosity < 2) {
564         return;
565     }
566     ds_put_cstr(string, leader);
567     if (wild_bits < 32) {
568         ds_put_format(string, IP_FMT, IP_ARGS(ip));
569         if (wild_bits) {
570             ds_put_format(string, "/%d", 32 - wild_bits);
571         }
572     } else {
573         ds_put_char(string, '*');
574     }
575     ds_put_char(string, ',');
576 }
577
578 void
579 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
580 {
581     char *s = ofp10_match_to_string(om, verbosity);
582     ds_put_cstr(f, s);
583     free(s);
584 }
585
586 char *
587 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
588 {
589     struct ds f = DS_EMPTY_INITIALIZER;
590     uint32_t w = ntohl(om->wildcards);
591     bool skip_type = false;
592     bool skip_proto = false;
593
594     if (!(w & OFPFW10_DL_TYPE)) {
595         skip_type = true;
596         if (om->dl_type == htons(ETH_TYPE_IP)) {
597             if (!(w & OFPFW10_NW_PROTO)) {
598                 skip_proto = true;
599                 if (om->nw_proto == IPPROTO_ICMP) {
600                     ds_put_cstr(&f, "icmp,");
601                 } else if (om->nw_proto == IPPROTO_TCP) {
602                     ds_put_cstr(&f, "tcp,");
603                 } else if (om->nw_proto == IPPROTO_UDP) {
604                     ds_put_cstr(&f, "udp,");
605                 } else if (om->nw_proto == IPPROTO_SCTP) {
606                     ds_put_cstr(&f, "sctp,");
607                 } else {
608                     ds_put_cstr(&f, "ip,");
609                     skip_proto = false;
610                 }
611             } else {
612                 ds_put_cstr(&f, "ip,");
613             }
614         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
615             ds_put_cstr(&f, "arp,");
616         } else if (om->dl_type == htons(ETH_TYPE_RARP)){
617             ds_put_cstr(&f, "rarp,");
618         } else if (om->dl_type == htons(ETH_TYPE_MPLS)) {
619             ds_put_cstr(&f, "mpls,");
620         } else if (om->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
621             ds_put_cstr(&f, "mplsm,");
622         } else {
623             skip_type = false;
624         }
625     }
626     print_wild_port(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
627                     u16_to_ofp(ntohs(om->in_port)));
628     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
629                "%d", ntohs(om->dl_vlan));
630     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
631                "%d", om->dl_vlan_pcp);
632     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
633                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
634     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
635                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
636     if (!skip_type) {
637         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
638                    "0x%04x", ntohs(om->dl_type));
639     }
640     print_ip_netmask(&f, "nw_src=", om->nw_src,
641                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
642                      verbosity);
643     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
644                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
645                      verbosity);
646     if (!skip_proto) {
647         if (om->dl_type == htons(ETH_TYPE_ARP) ||
648             om->dl_type == htons(ETH_TYPE_RARP)) {
649             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
650                        "%u", om->nw_proto);
651         } else {
652             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
653                        "%u", om->nw_proto);
654         }
655     }
656     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
657                "%u", om->nw_tos);
658     if (om->nw_proto == IPPROTO_ICMP) {
659         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
660                    "%d", ntohs(om->tp_src));
661         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
662                    "%d", ntohs(om->tp_dst));
663     } else {
664         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
665                    "%d", ntohs(om->tp_src));
666         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
667                    "%d", ntohs(om->tp_dst));
668     }
669     ds_chomp(&f, ',');
670     return ds_cstr(&f);
671 }
672
673 static void
674 ofp_print_flow_flags(struct ds *s, enum ofputil_flow_mod_flags flags)
675 {
676     if (flags & OFPUTIL_FF_SEND_FLOW_REM) {
677         ds_put_cstr(s, "send_flow_rem ");
678     }
679     if (flags & OFPUTIL_FF_CHECK_OVERLAP) {
680         ds_put_cstr(s, "check_overlap ");
681     }
682     if (flags & OFPUTIL_FF_RESET_COUNTS) {
683         ds_put_cstr(s, "reset_counts ");
684     }
685     if (flags & OFPUTIL_FF_NO_PKT_COUNTS) {
686         ds_put_cstr(s, "no_packet_counts ");
687     }
688     if (flags & OFPUTIL_FF_NO_BYT_COUNTS) {
689         ds_put_cstr(s, "no_byte_counts ");
690     }
691     if (flags & OFPUTIL_FF_HIDDEN_FIELDS) {
692         ds_put_cstr(s, "allow_hidden_fields ");
693     }
694     if (flags & OFPUTIL_FF_NO_READONLY) {
695         ds_put_cstr(s, "no_readonly_table ");
696     }
697 }
698
699 static void
700 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
701 {
702     struct ofputil_flow_mod fm;
703     struct ofpbuf ofpacts;
704     bool need_priority;
705     enum ofperr error;
706     enum ofpraw raw;
707     enum ofputil_protocol protocol;
708
709     protocol = ofputil_protocol_from_ofp_version(oh->version);
710     protocol = ofputil_protocol_set_tid(protocol, true);
711
712     ofpbuf_init(&ofpacts, 64);
713     error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts,
714                                     OFPP_MAX, 255);
715     if (error) {
716         ofpbuf_uninit(&ofpacts);
717         ofp_print_error(s, error);
718         return;
719     }
720
721     ds_put_char(s, ' ');
722     switch (fm.command) {
723     case OFPFC_ADD:
724         ds_put_cstr(s, "ADD");
725         break;
726     case OFPFC_MODIFY:
727         ds_put_cstr(s, "MOD");
728         break;
729     case OFPFC_MODIFY_STRICT:
730         ds_put_cstr(s, "MOD_STRICT");
731         break;
732     case OFPFC_DELETE:
733         ds_put_cstr(s, "DEL");
734         break;
735     case OFPFC_DELETE_STRICT:
736         ds_put_cstr(s, "DEL_STRICT");
737         break;
738     default:
739         ds_put_format(s, "cmd:%d", fm.command);
740     }
741     if (fm.table_id != 0) {
742         ds_put_format(s, " table:%d", fm.table_id);
743     }
744
745     ds_put_char(s, ' ');
746     ofpraw_decode(&raw, oh);
747     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
748         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
749         ofp10_match_print(s, &ofm->match, verbosity);
750
751         /* ofp_print_match() doesn't print priority. */
752         need_priority = true;
753     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
754         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
755         const void *nxm = nfm + 1;
756         char *nxm_s;
757
758         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
759         ds_put_cstr(s, nxm_s);
760         free(nxm_s);
761
762         /* nx_match_to_string() doesn't print priority. */
763         need_priority = true;
764     } else {
765         match_format(&fm.match, s, fm.priority);
766
767         /* match_format() does print priority. */
768         need_priority = false;
769     }
770
771     if (ds_last(s) != ' ') {
772         ds_put_char(s, ' ');
773     }
774     if (fm.new_cookie != htonll(0) && fm.new_cookie != OVS_BE64_MAX) {
775         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
776     }
777     if (fm.cookie_mask != htonll(0)) {
778         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
779                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
780     }
781     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
782         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
783     }
784     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
785         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
786     }
787     if (fm.importance != 0) {
788         ds_put_format(s, "importance:%"PRIu16" ", fm.importance);
789     }
790     if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
791         ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
792     }
793     if (fm.buffer_id != UINT32_MAX) {
794         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
795     }
796     if (fm.out_port != OFPP_ANY) {
797         ds_put_format(s, "out_port:");
798         ofputil_format_port(fm.out_port, s);
799         ds_put_char(s, ' ');
800     }
801
802     if (oh->version == OFP10_VERSION || oh->version == OFP11_VERSION) {
803         /* Don't print the reset_counts flag for OF1.0 and OF1.1 because those
804          * versions don't really have such a flag and printing one is likely to
805          * confuse people. */
806         fm.flags &= ~OFPUTIL_FF_RESET_COUNTS;
807     }
808     ofp_print_flow_flags(s, fm.flags);
809
810     ds_put_cstr(s, "actions=");
811     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
812     ofpbuf_uninit(&ofpacts);
813 }
814
815 static void
816 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
817 {
818     ds_put_format(string, "%u", sec);
819
820     /* If there are no fractional seconds, don't print any decimals.
821      *
822      * If the fractional seconds can be expressed exactly as milliseconds,
823      * print 3 decimals.  Open vSwitch provides millisecond precision for most
824      * time measurements, so printing 3 decimals every time makes it easier to
825      * spot real changes in flow dumps that refresh themselves quickly.
826      *
827      * If the fractional seconds are more precise than milliseconds, print the
828      * number of decimals needed to express them exactly.
829      */
830     if (nsec > 0) {
831         unsigned int msec = nsec / 1000000;
832         if (msec * 1000000 == nsec) {
833             ds_put_format(string, ".%03u", msec);
834         } else {
835             ds_put_format(string, ".%09u", nsec);
836             while (string->string[string->length - 1] == '0') {
837                 string->length--;
838             }
839         }
840     }
841     ds_put_char(string, 's');
842 }
843
844 /* Returns a string form of 'reason'.  The return value is either a statically
845  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
846  * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
847 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
848 static const char *
849 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason,
850                                   char *reasonbuf, size_t bufsize)
851 {
852     switch (reason) {
853     case OFPRR_IDLE_TIMEOUT:
854         return "idle";
855     case OFPRR_HARD_TIMEOUT:
856         return "hard";
857     case OFPRR_DELETE:
858         return "delete";
859     case OFPRR_GROUP_DELETE:
860         return "group_delete";
861     case OFPRR_EVICTION:
862         return "eviction";
863     case OFPRR_METER_DELETE:
864         return "meter_delete";
865     case OVS_OFPRR_NONE:
866     default:
867         snprintf(reasonbuf, bufsize, "%d", (int) reason);
868         return reasonbuf;
869     }
870 }
871
872 static void
873 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
874 {
875     char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
876     struct ofputil_flow_removed fr;
877     enum ofperr error;
878
879     error = ofputil_decode_flow_removed(&fr, oh);
880     if (error) {
881         ofp_print_error(string, error);
882         return;
883     }
884
885     ds_put_char(string, ' ');
886     match_format(&fr.match, string, fr.priority);
887
888     ds_put_format(string, " reason=%s",
889                   ofp_flow_removed_reason_to_string(fr.reason, reasonbuf,
890                                                     sizeof reasonbuf));
891
892     if (fr.table_id != 255) {
893         ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
894     }
895
896     if (fr.cookie != htonll(0)) {
897         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
898     }
899     ds_put_cstr(string, " duration");
900     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
901     ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
902     if (fr.hard_timeout) {
903         /* The hard timeout was only added in OF1.2, so only print it if it is
904          * actually in use to avoid gratuitous change to the formatting. */
905         ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
906     }
907     ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
908                   fr.packet_count, fr.byte_count);
909 }
910
911 static void
912 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
913 {
914     struct ofputil_port_mod pm;
915     enum ofperr error;
916
917     error = ofputil_decode_port_mod(oh, &pm, true);
918     if (error) {
919         ofp_print_error(string, error);
920         return;
921     }
922
923     ds_put_cstr(string, "port: ");
924     ofputil_format_port(pm.port_no, string);
925     ds_put_format(string, ": addr:"ETH_ADDR_FMT"\n",
926                   ETH_ADDR_ARGS(pm.hw_addr));
927
928     ds_put_cstr(string, "     config: ");
929     ofp_print_port_config(string, pm.config);
930
931     ds_put_cstr(string, "     mask:   ");
932     ofp_print_port_config(string, pm.mask);
933
934     ds_put_cstr(string, "     advertise: ");
935     if (pm.advertise) {
936         ofp_print_port_features(string, pm.advertise);
937     } else {
938         ds_put_cstr(string, "UNCHANGED\n");
939     }
940 }
941
942 static const char *
943 ofputil_table_miss_to_string(enum ofputil_table_miss miss)
944 {
945     switch (miss) {
946     case OFPUTIL_TABLE_MISS_DEFAULT: return "default";
947     case OFPUTIL_TABLE_MISS_CONTROLLER: return "controller";
948     case OFPUTIL_TABLE_MISS_CONTINUE: return "continue";
949     case OFPUTIL_TABLE_MISS_DROP: return "drop";
950     default: return "***error***";
951     }
952 }
953
954 static const char *
955 ofputil_table_eviction_to_string(enum ofputil_table_eviction eviction)
956 {
957     switch (eviction) {
958     case OFPUTIL_TABLE_EVICTION_DEFAULT: return "default";
959     case OFPUTIL_TABLE_EVICTION_ON: return "on";
960     case OFPUTIL_TABLE_EVICTION_OFF: return "off";
961     default: return "***error***";
962     }
963
964 }
965
966 static const char *
967 ofputil_eviction_flag_to_string(uint32_t bit)
968 {
969     enum ofp14_table_mod_prop_eviction_flag eviction_flag = bit;
970
971     switch (eviction_flag) {
972     case OFPTMPEF14_OTHER:      return "OTHER";
973     case OFPTMPEF14_IMPORTANCE: return "IMPORTANCE";
974     case OFPTMPEF14_LIFETIME:   return "LIFETIME";
975     }
976
977     return NULL;
978 }
979
980 /* Appends to 'string' a description of the bitmap of OFPTMPEF14_* values in
981  * 'eviction_flags'. */
982 static void
983 ofputil_put_eviction_flags(struct ds *string, uint32_t eviction_flags)
984 {
985     if (eviction_flags != UINT32_MAX) {
986         ofp_print_bit_names(string, eviction_flags,
987                             ofputil_eviction_flag_to_string, '|');
988     } else {
989         ds_put_cstr(string, "(default)");
990     }
991 }
992
993 static const char *
994 ofputil_table_vacancy_to_string(enum ofputil_table_vacancy vacancy)
995 {
996     switch (vacancy) {
997     case OFPUTIL_TABLE_VACANCY_DEFAULT: return "default";
998     case OFPUTIL_TABLE_VACANCY_ON: return "on";
999     case OFPUTIL_TABLE_VACANCY_OFF: return "off";
1000     default: return "***error***";
1001     }
1002
1003 }
1004
1005 static void
1006 ofp_print_table_mod(struct ds *string, const struct ofp_header *oh)
1007 {
1008     struct ofputil_table_mod pm;
1009     enum ofperr error;
1010
1011     error = ofputil_decode_table_mod(oh, &pm);
1012     if (error) {
1013         ofp_print_error(string, error);
1014         return;
1015     }
1016
1017     if (pm.table_id == 0xff) {
1018         ds_put_cstr(string, " table_id: ALL_TABLES");
1019     } else {
1020         ds_put_format(string, " table_id=%"PRIu8, pm.table_id);
1021     }
1022
1023     if (pm.miss != OFPUTIL_TABLE_MISS_DEFAULT) {
1024         ds_put_format(string, ", flow_miss_config=%s",
1025                       ofputil_table_miss_to_string(pm.miss));
1026     }
1027     if (pm.eviction != OFPUTIL_TABLE_EVICTION_DEFAULT) {
1028         ds_put_format(string, ", eviction=%s",
1029                       ofputil_table_eviction_to_string(pm.eviction));
1030     }
1031     if (pm.eviction_flags != UINT32_MAX) {
1032         ds_put_cstr(string, "eviction_flags=");
1033         ofputil_put_eviction_flags(string, pm.eviction_flags);
1034     }
1035     if (pm.vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
1036         ds_put_format(string, ", vacancy=%s",
1037                       ofputil_table_vacancy_to_string(pm.vacancy));
1038         if (pm.vacancy == OFPUTIL_TABLE_VACANCY_ON) {
1039             ds_put_format(string, " vacancy:%"PRIu8""
1040                           ",%"PRIu8"", pm.table_vacancy.vacancy_down,
1041                           pm.table_vacancy.vacancy_up);
1042         }
1043     }
1044 }
1045
1046 /* This function will print the Table description properties. */
1047 static void
1048 ofp_print_table_desc(struct ds *string, const struct ofputil_table_desc *td)
1049 {
1050     ds_put_format(string, "\n  table %"PRIu8, td->table_id);
1051     ds_put_cstr(string, ":\n");
1052     ds_put_format(string, "   eviction=%s eviction_flags=",
1053                   ofputil_table_eviction_to_string(td->eviction));
1054     ofputil_put_eviction_flags(string, td->eviction_flags);
1055     ds_put_char(string, '\n');
1056 }
1057
1058 static void
1059 ofp_print_queue_get_config_request(struct ds *string,
1060                                    const struct ofp_header *oh)
1061 {
1062     enum ofperr error;
1063     ofp_port_t port;
1064
1065     error = ofputil_decode_queue_get_config_request(oh, &port);
1066     if (error) {
1067         ofp_print_error(string, error);
1068         return;
1069     }
1070
1071     ds_put_cstr(string, " port=");
1072     ofputil_format_port(port, string);
1073 }
1074
1075 static void
1076 print_queue_rate(struct ds *string, const char *name, unsigned int rate)
1077 {
1078     if (rate <= 1000) {
1079         ds_put_format(string, " %s:%u.%u%%", name, rate / 10, rate % 10);
1080     } else if (rate < UINT16_MAX) {
1081         ds_put_format(string, " %s:(disabled)", name);
1082     }
1083 }
1084
1085 static void
1086 ofp_print_queue_get_config_reply(struct ds *string,
1087                                  const struct ofp_header *oh)
1088 {
1089     enum ofperr error;
1090     struct ofpbuf b;
1091     ofp_port_t port;
1092
1093     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1094     error = ofputil_decode_queue_get_config_reply(&b, &port);
1095     if (error) {
1096         ofp_print_error(string, error);
1097         return;
1098     }
1099
1100     ds_put_cstr(string, " port=");
1101     ofputil_format_port(port, string);
1102     ds_put_char(string, '\n');
1103
1104     for (;;) {
1105         struct ofputil_queue_config queue;
1106         int retval;
1107
1108         retval = ofputil_pull_queue_get_config_reply(&b, &queue);
1109         if (retval) {
1110             if (retval != EOF) {
1111                 ofp_print_error(string, retval);
1112             }
1113             break;
1114         }
1115
1116         ds_put_format(string, "queue %"PRIu32":", queue.queue_id);
1117         print_queue_rate(string, "min_rate", queue.min_rate);
1118         print_queue_rate(string, "max_rate", queue.max_rate);
1119         ds_put_char(string, '\n');
1120     }
1121 }
1122
1123 static void
1124 ofp_print_meter_flags(struct ds *s, uint16_t flags)
1125 {
1126     if (flags & OFPMF13_KBPS) {
1127         ds_put_cstr(s, "kbps ");
1128     }
1129     if (flags & OFPMF13_PKTPS) {
1130         ds_put_cstr(s, "pktps ");
1131     }
1132     if (flags & OFPMF13_BURST) {
1133         ds_put_cstr(s, "burst ");
1134     }
1135     if (flags & OFPMF13_STATS) {
1136         ds_put_cstr(s, "stats ");
1137     }
1138
1139     flags &= ~(OFPMF13_KBPS | OFPMF13_PKTPS | OFPMF13_BURST | OFPMF13_STATS);
1140     if (flags) {
1141         ds_put_format(s, "flags:0x%"PRIx16" ", flags);
1142     }
1143 }
1144
1145 static void
1146 ofp_print_meter_band(struct ds *s, uint16_t flags,
1147                      const struct ofputil_meter_band *mb)
1148 {
1149     ds_put_cstr(s, "\ntype=");
1150     switch (mb->type) {
1151     case OFPMBT13_DROP:
1152         ds_put_cstr(s, "drop");
1153         break;
1154     case OFPMBT13_DSCP_REMARK:
1155         ds_put_cstr(s, "dscp_remark");
1156         break;
1157     default:
1158         ds_put_format(s, "%u", mb->type);
1159     }
1160
1161     ds_put_format(s, " rate=%"PRIu32, mb->rate);
1162
1163     if (flags & OFPMF13_BURST) {
1164         ds_put_format(s, " burst_size=%"PRIu32, mb->burst_size);
1165     }
1166     if (mb->type == OFPMBT13_DSCP_REMARK) {
1167         ds_put_format(s, " prec_level=%"PRIu8, mb->prec_level);
1168     }
1169 }
1170
1171 static void
1172 ofp_print_meter_stats(struct ds *s, const struct ofputil_meter_stats *ms)
1173 {
1174     uint16_t i;
1175
1176     ds_put_format(s, "meter:%"PRIu32" ", ms->meter_id);
1177     ds_put_format(s, "flow_count:%"PRIu32" ", ms->flow_count);
1178     ds_put_format(s, "packet_in_count:%"PRIu64" ", ms->packet_in_count);
1179     ds_put_format(s, "byte_in_count:%"PRIu64" ", ms->byte_in_count);
1180     ds_put_cstr(s, "duration:");
1181     ofp_print_duration(s, ms->duration_sec, ms->duration_nsec);
1182     ds_put_char(s, ' ');
1183
1184     ds_put_cstr(s, "bands:\n");
1185     for (i = 0; i < ms->n_bands; ++i) {
1186         ds_put_format(s, "%d: ", i);
1187         ds_put_format(s, "packet_count:%"PRIu64" ", ms->bands[i].packet_count);
1188         ds_put_format(s, "byte_count:%"PRIu64"\n", ms->bands[i].byte_count);
1189     }
1190 }
1191
1192 static void
1193 ofp_print_meter_config(struct ds *s, const struct ofputil_meter_config *mc)
1194 {
1195     uint16_t i;
1196
1197     ds_put_format(s, "meter=%"PRIu32" ", mc->meter_id);
1198
1199     ofp_print_meter_flags(s, mc->flags);
1200
1201     ds_put_cstr(s, "bands=");
1202     for (i = 0; i < mc->n_bands; ++i) {
1203         ofp_print_meter_band(s, mc->flags, &mc->bands[i]);
1204     }
1205     ds_put_char(s, '\n');
1206 }
1207
1208 static void
1209 ofp_print_meter_mod__(struct ds *s, const struct ofputil_meter_mod *mm)
1210 {
1211     switch (mm->command) {
1212     case OFPMC13_ADD:
1213         ds_put_cstr(s, " ADD ");
1214         break;
1215     case OFPMC13_MODIFY:
1216         ds_put_cstr(s, " MOD ");
1217         break;
1218     case OFPMC13_DELETE:
1219         ds_put_cstr(s, " DEL ");
1220         break;
1221     default:
1222         ds_put_format(s, " cmd:%d ", mm->command);
1223     }
1224
1225     ofp_print_meter_config(s, &mm->meter);
1226 }
1227
1228 static void
1229 ofp_print_meter_mod(struct ds *s, const struct ofp_header *oh)
1230 {
1231     struct ofputil_meter_mod mm;
1232     struct ofpbuf bands;
1233     enum ofperr error;
1234
1235     ofpbuf_init(&bands, 64);
1236     error = ofputil_decode_meter_mod(oh, &mm, &bands);
1237     if (error) {
1238         ofp_print_error(s, error);
1239     } else {
1240         ofp_print_meter_mod__(s, &mm);
1241     }
1242     ofpbuf_uninit(&bands);
1243 }
1244
1245 static void
1246 ofp_print_meter_stats_request(struct ds *s, const struct ofp_header *oh)
1247 {
1248     uint32_t meter_id;
1249
1250     ofputil_decode_meter_request(oh, &meter_id);
1251
1252     ds_put_format(s, " meter=%"PRIu32, meter_id);
1253 }
1254
1255 static const char *
1256 ofputil_meter_capabilities_to_name(uint32_t bit)
1257 {
1258     enum ofp13_meter_flags flag = bit;
1259
1260     switch (flag) {
1261     case OFPMF13_KBPS:    return "kbps";
1262     case OFPMF13_PKTPS:   return "pktps";
1263     case OFPMF13_BURST:   return "burst";
1264     case OFPMF13_STATS:   return "stats";
1265     }
1266
1267     return NULL;
1268 }
1269
1270 static const char *
1271 ofputil_meter_band_types_to_name(uint32_t bit)
1272 {
1273     switch (bit) {
1274     case 1 << OFPMBT13_DROP:          return "drop";
1275     case 1 << OFPMBT13_DSCP_REMARK:   return "dscp_remark";
1276     }
1277
1278     return NULL;
1279 }
1280
1281 static void
1282 ofp_print_meter_features_reply(struct ds *s, const struct ofp_header *oh)
1283 {
1284     struct ofputil_meter_features mf;
1285
1286     ofputil_decode_meter_features(oh, &mf);
1287
1288     ds_put_format(s, "\nmax_meter:%"PRIu32, mf.max_meters);
1289     ds_put_format(s, " max_bands:%"PRIu8, mf.max_bands);
1290     ds_put_format(s, " max_color:%"PRIu8"\n", mf.max_color);
1291
1292     ds_put_cstr(s, "band_types: ");
1293     ofp_print_bit_names(s, mf.band_types,
1294                         ofputil_meter_band_types_to_name, ' ');
1295     ds_put_char(s, '\n');
1296
1297     ds_put_cstr(s, "capabilities: ");
1298     ofp_print_bit_names(s, mf.capabilities,
1299                         ofputil_meter_capabilities_to_name, ' ');
1300     ds_put_char(s, '\n');
1301 }
1302
1303 static void
1304 ofp_print_meter_config_reply(struct ds *s, const struct ofp_header *oh)
1305 {
1306     struct ofpbuf bands;
1307     struct ofpbuf b;
1308
1309     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1310     ofpbuf_init(&bands, 64);
1311     for (;;) {
1312         struct ofputil_meter_config mc;
1313         int retval;
1314
1315         retval = ofputil_decode_meter_config(&b, &mc, &bands);
1316         if (retval) {
1317             if (retval != EOF) {
1318                 ofp_print_error(s, retval);
1319             }
1320             break;
1321         }
1322         ds_put_char(s, '\n');
1323         ofp_print_meter_config(s, &mc);
1324     }
1325     ofpbuf_uninit(&bands);
1326 }
1327
1328 static void
1329 ofp_print_meter_stats_reply(struct ds *s, const struct ofp_header *oh)
1330 {
1331     struct ofpbuf bands;
1332     struct ofpbuf b;
1333
1334     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1335     ofpbuf_init(&bands, 64);
1336     for (;;) {
1337         struct ofputil_meter_stats ms;
1338         int retval;
1339
1340         retval = ofputil_decode_meter_stats(&b, &ms, &bands);
1341         if (retval) {
1342             if (retval != EOF) {
1343                 ofp_print_error(s, retval);
1344             }
1345             break;
1346         }
1347         ds_put_char(s, '\n');
1348         ofp_print_meter_stats(s, &ms);
1349     }
1350     ofpbuf_uninit(&bands);
1351 }
1352
1353 static void
1354 ofp_print_error(struct ds *string, enum ofperr error)
1355 {
1356     if (string->length) {
1357         ds_put_char(string, ' ');
1358     }
1359     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1360 }
1361
1362 static void
1363 ofp_print_hello(struct ds *string, const struct ofp_header *oh)
1364 {
1365     uint32_t allowed_versions;
1366     bool ok;
1367
1368     ok = ofputil_decode_hello(oh, &allowed_versions);
1369
1370     ds_put_cstr(string, "\n version bitmap: ");
1371     ofputil_format_version_bitmap(string, allowed_versions);
1372
1373     if (!ok) {
1374         ds_put_cstr(string, "\n unknown data in hello:\n");
1375         ds_put_hex_dump(string, oh, ntohs(oh->length), 0, true);
1376     }
1377 }
1378
1379 static void
1380 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
1381 {
1382     size_t len = ntohs(oh->length);
1383     struct ofpbuf payload;
1384     enum ofperr error;
1385     char *s;
1386
1387     error = ofperr_decode_msg(oh, &payload);
1388     if (!error) {
1389         ds_put_cstr(string, "***decode error***");
1390         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1391         return;
1392     }
1393
1394     ds_put_format(string, " %s\n", ofperr_get_name(error));
1395
1396     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
1397         ds_put_printable(string, payload.data, payload.size);
1398     } else {
1399         s = ofp_to_string(payload.data, payload.size, 1);
1400         ds_put_cstr(string, s);
1401         free(s);
1402     }
1403     ofpbuf_uninit(&payload);
1404 }
1405
1406 static void
1407 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
1408 {
1409     struct ofputil_port_status ps;
1410     enum ofperr error;
1411
1412     error = ofputil_decode_port_status(oh, &ps);
1413     if (error) {
1414         ofp_print_error(string, error);
1415         return;
1416     }
1417
1418     if (ps.reason == OFPPR_ADD) {
1419         ds_put_format(string, " ADD:");
1420     } else if (ps.reason == OFPPR_DELETE) {
1421         ds_put_format(string, " DEL:");
1422     } else if (ps.reason == OFPPR_MODIFY) {
1423         ds_put_format(string, " MOD:");
1424     }
1425
1426     ofp_print_phy_port(string, &ps.desc);
1427 }
1428
1429 static void
1430 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1431 {
1432     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
1433
1434     ds_put_char(string, '\n');
1435     ds_put_format(string, "Manufacturer: %.*s\n",
1436             (int) sizeof ods->mfr_desc, ods->mfr_desc);
1437     ds_put_format(string, "Hardware: %.*s\n",
1438             (int) sizeof ods->hw_desc, ods->hw_desc);
1439     ds_put_format(string, "Software: %.*s\n",
1440             (int) sizeof ods->sw_desc, ods->sw_desc);
1441     ds_put_format(string, "Serial Num: %.*s\n",
1442             (int) sizeof ods->serial_num, ods->serial_num);
1443     ds_put_format(string, "DP Description: %.*s\n",
1444             (int) sizeof ods->dp_desc, ods->dp_desc);
1445 }
1446
1447 static void
1448 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1449 {
1450     struct ofputil_flow_stats_request fsr;
1451     enum ofperr error;
1452
1453     error = ofputil_decode_flow_stats_request(&fsr, oh);
1454     if (error) {
1455         ofp_print_error(string, error);
1456         return;
1457     }
1458
1459     if (fsr.table_id != 0xff) {
1460         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1461     }
1462
1463     if (fsr.out_port != OFPP_ANY) {
1464         ds_put_cstr(string, " out_port=");
1465         ofputil_format_port(fsr.out_port, string);
1466     }
1467
1468     ds_put_char(string, ' ');
1469     match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
1470 }
1471
1472 void
1473 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1474 {
1475     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1476                   ntohll(fs->cookie));
1477
1478     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1479     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1480     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1481     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1482     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1483         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1484     }
1485     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1486         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1487     }
1488     if (fs->flags) {
1489         ofp_print_flow_flags(string, fs->flags);
1490     }
1491     if (fs->importance != 0) {
1492         ds_put_format(string, "importance=%"PRIu16", ", fs->importance);
1493     }
1494     if (fs->idle_age >= 0) {
1495         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1496     }
1497     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1498         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1499     }
1500
1501     match_format(&fs->match, string, fs->priority);
1502     if (string->string[string->length - 1] != ' ') {
1503         ds_put_char(string, ' ');
1504     }
1505
1506     ds_put_cstr(string, "actions=");
1507     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1508 }
1509
1510 static void
1511 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1512 {
1513     struct ofpbuf ofpacts;
1514     struct ofpbuf b;
1515
1516     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1517     ofpbuf_init(&ofpacts, 64);
1518     for (;;) {
1519         struct ofputil_flow_stats fs;
1520         int retval;
1521
1522         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1523         if (retval) {
1524             if (retval != EOF) {
1525                 ds_put_cstr(string, " ***parse error***");
1526             }
1527             break;
1528         }
1529         ds_put_char(string, '\n');
1530         ofp_print_flow_stats(string, &fs);
1531      }
1532     ofpbuf_uninit(&ofpacts);
1533 }
1534
1535 static void
1536 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1537 {
1538     struct ofputil_aggregate_stats as;
1539     enum ofperr error;
1540
1541     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1542     if (error) {
1543         ofp_print_error(string, error);
1544         return;
1545     }
1546
1547     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1548     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1549     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1550 }
1551
1552 static void
1553 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1554 {
1555     ds_put_cstr(string, leader);
1556     if (stat != UINT64_MAX) {
1557         ds_put_format(string, "%"PRIu64, stat);
1558     } else {
1559         ds_put_char(string, '?');
1560     }
1561     if (more) {
1562         ds_put_cstr(string, ", ");
1563     } else {
1564         ds_put_cstr(string, "\n");
1565     }
1566 }
1567
1568 static void
1569 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1570 {
1571     ofp_port_t ofp10_port;
1572     enum ofperr error;
1573
1574     error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1575     if (error) {
1576         ofp_print_error(string, error);
1577         return;
1578     }
1579
1580     ds_put_cstr(string, " port_no=");
1581     ofputil_format_port(ofp10_port, string);
1582 }
1583
1584 static void
1585 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1586                            int verbosity)
1587 {
1588     struct ofpbuf b;
1589
1590     ds_put_format(string, " %"PRIuSIZE" ports\n", ofputil_count_port_stats(oh));
1591     if (verbosity < 1) {
1592         return;
1593     }
1594
1595     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1596     for (;;) {
1597         struct ofputil_port_stats ps;
1598         int retval;
1599
1600         retval = ofputil_decode_port_stats(&ps, &b);
1601         if (retval) {
1602             if (retval != EOF) {
1603                 ds_put_cstr(string, " ***parse error***");
1604             }
1605             return;
1606         }
1607
1608         ds_put_cstr(string, "  port ");
1609         if (ofp_to_u16(ps.port_no) < 10) {
1610             ds_put_char(string, ' ');
1611         }
1612         ofputil_format_port(ps.port_no, string);
1613
1614         ds_put_cstr(string, ": rx ");
1615         print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1616         print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1617         print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1618         print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1619         print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1620         print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1621         print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1622
1623         ds_put_cstr(string, "           tx ");
1624         print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1625         print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1626         print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1627         print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1628         print_port_stat(string, "coll=", ps.stats.collisions, 0);
1629
1630         if (ps.duration_sec != UINT32_MAX) {
1631             ds_put_cstr(string, "           duration=");
1632             ofp_print_duration(string, ps.duration_sec, ps.duration_nsec);
1633             ds_put_char(string, '\n');
1634         }
1635     }
1636 }
1637
1638 static void
1639 ofp_print_table_stats_reply(struct ds *string, const struct ofp_header *oh)
1640 {
1641     struct ofpbuf b;
1642
1643     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1644     ofpraw_pull_assert(&b);
1645
1646     struct ofputil_table_features prev_features;
1647     struct ofputil_table_stats prev_stats;
1648     for (int i = 0;; i++) {
1649         struct ofputil_table_features features;
1650         struct ofputil_table_stats stats;
1651         int retval;
1652
1653         retval = ofputil_decode_table_stats_reply(&b, &stats, &features);
1654         if (retval) {
1655             if (retval != EOF) {
1656                 ofp_print_error(string, retval);
1657             }
1658             return;
1659         }
1660
1661         ds_put_char(string, '\n');
1662         ofp_print_table_features(string,
1663                                  &features, i ? &prev_features : NULL,
1664                                  &stats, i ? &prev_stats : NULL);
1665         prev_features = features;
1666         prev_stats = stats;
1667     }
1668 }
1669
1670 static void
1671 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1672 {
1673     if (queue_id == OFPQ_ALL) {
1674         ds_put_cstr(string, "ALL");
1675     } else {
1676         ds_put_format(string, "%"PRIu32, queue_id);
1677     }
1678 }
1679
1680 static void
1681 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1682 {
1683     struct ofputil_queue_stats_request oqsr;
1684     enum ofperr error;
1685
1686     error = ofputil_decode_queue_stats_request(oh, &oqsr);
1687     if (error) {
1688         ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1689         return;
1690     }
1691
1692     ds_put_cstr(string, "port=");
1693     ofputil_format_port(oqsr.port_no, string);
1694
1695     ds_put_cstr(string, " queue=");
1696     ofp_print_queue_name(string, oqsr.queue_id);
1697 }
1698
1699 static void
1700 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1701                             int verbosity)
1702 {
1703     struct ofpbuf b;
1704
1705     ds_put_format(string, " %"PRIuSIZE" queues\n", ofputil_count_queue_stats(oh));
1706     if (verbosity < 1) {
1707         return;
1708     }
1709
1710     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1711     for (;;) {
1712         struct ofputil_queue_stats qs;
1713         int retval;
1714
1715         retval = ofputil_decode_queue_stats(&qs, &b);
1716         if (retval) {
1717             if (retval != EOF) {
1718                 ds_put_cstr(string, " ***parse error***");
1719             }
1720             return;
1721         }
1722
1723         ds_put_cstr(string, "  port ");
1724         ofputil_format_port(qs.port_no, string);
1725         ds_put_cstr(string, " queue ");
1726         ofp_print_queue_name(string, qs.queue_id);
1727         ds_put_cstr(string, ": ");
1728
1729         print_port_stat(string, "bytes=", qs.tx_bytes, 1);
1730         print_port_stat(string, "pkts=", qs.tx_packets, 1);
1731         print_port_stat(string, "errors=", qs.tx_errors, 1);
1732
1733         ds_put_cstr(string, "duration=");
1734         if (qs.duration_sec != UINT32_MAX) {
1735             ofp_print_duration(string, qs.duration_sec, qs.duration_nsec);
1736         } else {
1737             ds_put_char(string, '?');
1738         }
1739         ds_put_char(string, '\n');
1740     }
1741 }
1742
1743 static void
1744 ofp_print_ofpst_port_desc_request(struct ds *string,
1745                                   const struct ofp_header *oh)
1746 {
1747     enum ofperr error;
1748     ofp_port_t port;
1749
1750     error = ofputil_decode_port_desc_stats_request(oh, &port);
1751     if (error) {
1752         ofp_print_error(string, error);
1753         return;
1754     }
1755
1756     ds_put_cstr(string, " port=");
1757     ofputil_format_port(port, string);
1758 }
1759
1760 static void
1761 ofp_print_ofpst_port_desc_reply(struct ds *string,
1762                                 const struct ofp_header *oh)
1763 {
1764     struct ofpbuf b;
1765
1766     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1767     ofpraw_pull_assert(&b);
1768     ds_put_char(string, '\n');
1769     ofp_print_phy_ports(string, oh->version, &b);
1770 }
1771
1772 static void
1773 ofp_print_stats(struct ds *string, const struct ofp_header *oh)
1774 {
1775     uint16_t flags = ofpmp_flags(oh);
1776
1777     if (flags) {
1778         ds_put_cstr(string, " flags=");
1779         if ((!ofpmsg_is_stat_request(oh) || oh->version >= OFP13_VERSION)
1780             && (flags & OFPSF_REPLY_MORE)) {
1781             ds_put_cstr(string, "[more]");
1782             flags &= ~OFPSF_REPLY_MORE;
1783         }
1784         if (flags) {
1785             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1786                           flags);
1787         }
1788     }
1789 }
1790
1791 static void
1792 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1793 {
1794     size_t len = ntohs(oh->length);
1795
1796     ds_put_format(string, " %"PRIuSIZE" bytes of payload\n", len - sizeof *oh);
1797     if (verbosity > 1) {
1798         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1799     }
1800 }
1801
1802 static void
1803 ofp_print_role_generic(struct ds *string, enum ofp12_controller_role role,
1804                        uint64_t generation_id)
1805 {
1806     ds_put_cstr(string, " role=");
1807
1808     switch (role) {
1809     case OFPCR12_ROLE_NOCHANGE:
1810         ds_put_cstr(string, "nochange");
1811         break;
1812     case OFPCR12_ROLE_EQUAL:
1813         ds_put_cstr(string, "equal"); /* OF 1.2 wording */
1814         break;
1815     case OFPCR12_ROLE_MASTER:
1816         ds_put_cstr(string, "master");
1817         break;
1818     case OFPCR12_ROLE_SLAVE:
1819         ds_put_cstr(string, "slave");
1820         break;
1821     default:
1822         OVS_NOT_REACHED();
1823     }
1824
1825     if (generation_id != UINT64_MAX) {
1826         ds_put_format(string, " generation_id=%"PRIu64, generation_id);
1827     }
1828 }
1829
1830 static void
1831 ofp_print_role_message(struct ds *string, const struct ofp_header *oh)
1832 {
1833     struct ofputil_role_request rr;
1834     enum ofperr error;
1835
1836     error = ofputil_decode_role_message(oh, &rr);
1837     if (error) {
1838         ofp_print_error(string, error);
1839         return;
1840     }
1841
1842     ofp_print_role_generic(string, rr.role, rr.have_generation_id ? rr.generation_id : UINT64_MAX);
1843 }
1844
1845 static void
1846 ofp_print_role_status_message(struct ds *string, const struct ofp_header *oh)
1847 {
1848     struct ofputil_role_status rs;
1849     enum ofperr error;
1850
1851     error = ofputil_decode_role_status(oh, &rs);
1852     if (error) {
1853         ofp_print_error(string, error);
1854         return;
1855     }
1856
1857     ofp_print_role_generic(string, rs.role, rs.generation_id);
1858
1859     ds_put_cstr(string, " reason=");
1860
1861     switch (rs.reason) {
1862     case OFPCRR_MASTER_REQUEST:
1863         ds_put_cstr(string, "master_request");
1864         break;
1865     case OFPCRR_CONFIG:
1866         ds_put_cstr(string, "configuration_changed");
1867         break;
1868     case OFPCRR_EXPERIMENTER:
1869         ds_put_cstr(string, "experimenter_data_changed");
1870         break;
1871     default:
1872         OVS_NOT_REACHED();
1873     }
1874 }
1875
1876 static void
1877 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1878                                 const struct nx_flow_mod_table_id *nfmti)
1879 {
1880     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1881 }
1882
1883 static void
1884 ofp_print_nxt_set_flow_format(struct ds *string,
1885                               const struct nx_set_flow_format *nsff)
1886 {
1887     uint32_t format = ntohl(nsff->format);
1888
1889     ds_put_cstr(string, " format=");
1890     if (ofputil_nx_flow_format_is_valid(format)) {
1891         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1892     } else {
1893         ds_put_format(string, "%"PRIu32, format);
1894     }
1895 }
1896
1897 static void
1898 ofp_print_nxt_set_packet_in_format(struct ds *string,
1899                                    const struct nx_set_packet_in_format *nspf)
1900 {
1901     uint32_t format = ntohl(nspf->format);
1902
1903     ds_put_cstr(string, " format=");
1904     if (ofputil_packet_in_format_is_valid(format)) {
1905         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1906     } else {
1907         ds_put_format(string, "%"PRIu32, format);
1908     }
1909 }
1910
1911 /* Returns a string form of 'reason'.  The return value is either a statically
1912  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1913  * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
1914 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
1915 static const char *
1916 ofp_port_reason_to_string(enum ofp_port_reason reason,
1917                           char *reasonbuf, size_t bufsize)
1918 {
1919     switch (reason) {
1920     case OFPPR_ADD:
1921         return "add";
1922
1923     case OFPPR_DELETE:
1924         return "delete";
1925
1926     case OFPPR_MODIFY:
1927         return "modify";
1928
1929     default:
1930         snprintf(reasonbuf, bufsize, "%d", (int) reason);
1931         return reasonbuf;
1932     }
1933 }
1934
1935 /* Returns a string form of 'reason'.  The return value is either a statically
1936  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1937  * 'bufsize' should be at least OFP_ASYNC_CONFIG_REASON_BUFSIZE. */
1938 static const char*
1939 ofp_role_reason_to_string(enum ofp14_controller_role_reason reason,
1940                           char *reasonbuf, size_t bufsize)
1941 {
1942     switch (reason) {
1943     case OFPCRR_MASTER_REQUEST:
1944         return "master_request";
1945
1946     case OFPCRR_CONFIG:
1947         return "configuration_changed";
1948
1949     case OFPCRR_EXPERIMENTER:
1950         return "experimenter_data_changed";
1951
1952     default:
1953         snprintf(reasonbuf, bufsize, "%d", (int) reason);
1954         return reasonbuf;
1955     }
1956 }
1957
1958 /* Returns a string form of 'reason'.  The return value is either a statically
1959  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1960  * 'bufsize' should be at least OFP_ASYNC_CONFIG_REASON_BUFSIZE. */
1961 static const char*
1962 ofp_table_reason_to_string(enum ofp14_table_reason reason,
1963                            char *reasonbuf, size_t bufsize)
1964 {
1965     switch (reason) {
1966     case OFPTR_VACANCY_DOWN:
1967         return "vacancy_down";
1968
1969     case OFPTR_VACANCY_UP:
1970         return "vacancy_up";
1971
1972     default:
1973         snprintf(reasonbuf, bufsize, "%d", (int) reason);
1974         return reasonbuf;
1975     }
1976 }
1977
1978 /* Returns a string form of 'reason'.  The return value is either a statically
1979  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1980  * 'bufsize' should be at least OFP_ASYNC_CONFIG_REASON_BUFSIZE. */
1981 static const char*
1982 ofp_requestforward_reason_to_string(enum ofp14_requestforward_reason reason,
1983                                     char *reasonbuf, size_t bufsize)
1984 {
1985     switch (reason) {
1986     case OFPRFR_GROUP_MOD:
1987         return "group_mod_request";
1988
1989     case OFPRFR_METER_MOD:
1990         return "meter_mod_request";
1991
1992     default:
1993         snprintf(reasonbuf, bufsize, "%d", (int) reason);
1994         return reasonbuf;
1995     }
1996 }
1997
1998 static const char *
1999 ofp_async_config_reason_to_string(uint32_t reason,
2000                                   enum ofputil_async_msg_type type,
2001                                   char *reasonbuf, size_t bufsize)
2002 {
2003     switch (type) {
2004     case OAM_PACKET_IN:
2005         return ofputil_packet_in_reason_to_string(reason, reasonbuf, bufsize);
2006
2007     case OAM_PORT_STATUS:
2008         return ofp_port_reason_to_string(reason, reasonbuf, bufsize);
2009
2010     case OAM_FLOW_REMOVED:
2011         return ofp_flow_removed_reason_to_string(reason, reasonbuf, bufsize);
2012
2013     case OAM_ROLE_STATUS:
2014         return ofp_role_reason_to_string(reason, reasonbuf, bufsize);
2015
2016     case OAM_TABLE_STATUS:
2017         return ofp_table_reason_to_string(reason, reasonbuf, bufsize);
2018
2019     case OAM_REQUESTFORWARD:
2020         return ofp_requestforward_reason_to_string(reason, reasonbuf, bufsize);
2021
2022     case OAM_N_TYPES:
2023     default:
2024         return "Unknown asynchronous configuration message type";
2025     }
2026 }
2027
2028
2029 #define OFP_ASYNC_CONFIG_REASON_BUFSIZE (INT_STRLEN(int) + 1)
2030 static void
2031 ofp_print_nxt_set_async_config(struct ds *string,
2032                                const struct ofp_header *oh)
2033 {
2034     int i, j;
2035     enum ofpraw raw;
2036
2037     ofpraw_decode(&raw, oh);
2038
2039     if (raw == OFPRAW_OFPT13_SET_ASYNC ||
2040         raw == OFPRAW_NXT_SET_ASYNC_CONFIG ||
2041         raw == OFPRAW_OFPT13_GET_ASYNC_REPLY) {
2042         const struct nx_async_config *nac = ofpmsg_body(oh);
2043
2044         for (i = 0; i < 2; i++) {
2045
2046             ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
2047
2048             ds_put_cstr(string, "       PACKET_IN:");
2049             for (j = 0; j < 32; j++) {
2050                 if (nac->packet_in_mask[i] & htonl(1u << j)) {
2051                     char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
2052                     const char *reason;
2053
2054                     reason = ofputil_packet_in_reason_to_string(j, reasonbuf,
2055                                                             sizeof reasonbuf);
2056                     ds_put_format(string, " %s", reason);
2057                 }
2058             }
2059             if (!nac->packet_in_mask[i]) {
2060                 ds_put_cstr(string, " (off)");
2061             }
2062             ds_put_char(string, '\n');
2063
2064             ds_put_cstr(string, "     PORT_STATUS:");
2065             for (j = 0; j < 32; j++) {
2066                 if (nac->port_status_mask[i] & htonl(1u << j)) {
2067                     char reasonbuf[OFP_PORT_REASON_BUFSIZE];
2068                     const char *reason;
2069
2070                     reason = ofp_port_reason_to_string(j, reasonbuf,
2071                                                        sizeof reasonbuf);
2072                     ds_put_format(string, " %s", reason);
2073                 }
2074             }
2075             if (!nac->port_status_mask[i]) {
2076                 ds_put_cstr(string, " (off)");
2077             }
2078             ds_put_char(string, '\n');
2079
2080             ds_put_cstr(string, "    FLOW_REMOVED:");
2081             for (j = 0; j < 32; j++) {
2082                 if (nac->flow_removed_mask[i] & htonl(1u << j)) {
2083                     char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2084                     const char *reason;
2085
2086                     reason = ofp_flow_removed_reason_to_string(j, reasonbuf,
2087                                                            sizeof reasonbuf);
2088                     ds_put_format(string, " %s", reason);
2089                 }
2090             }
2091             if (!nac->flow_removed_mask[i]) {
2092                 ds_put_cstr(string, " (off)");
2093             }
2094             ds_put_char(string, '\n');
2095         }
2096     } else if (raw == OFPRAW_OFPT14_SET_ASYNC ||
2097                raw == OFPRAW_OFPT14_GET_ASYNC_REPLY) {
2098         uint32_t role[2][OAM_N_TYPES] = {{0}};
2099         uint32_t type;
2100
2101         ofputil_decode_set_async_config(oh, role[0], role[1], true);
2102         for (i = 0; i < 2; i++) {
2103
2104             ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
2105             for (type = 0; type < OAM_N_TYPES; type++) {
2106                 switch (type) {
2107                 case OAM_PACKET_IN:
2108                     ds_put_cstr(string, "       PACKET_IN:");
2109                     break;
2110
2111                 case OAM_PORT_STATUS:
2112                     ds_put_cstr(string, "     PORT_STATUS:");
2113                     break;
2114
2115                 case OAM_FLOW_REMOVED:
2116                     ds_put_cstr(string, "    FLOW_REMOVED:");
2117                     break;
2118
2119                 case OAM_ROLE_STATUS:
2120                     ds_put_cstr(string, "     ROLE_STATUS:");
2121                     break;
2122
2123                 case OAM_TABLE_STATUS:
2124                     ds_put_cstr(string, "    TABLE_STATUS:");
2125                     break;
2126
2127                 case OAM_REQUESTFORWARD:
2128                     ds_put_cstr(string, "  REQUESTFORWARD:");
2129                     break;
2130                 }
2131
2132                 for (j = 0; j < 32; j++) {
2133                     if (role[i][type] & (1u << j)) {
2134                         char reasonbuf[OFP_ASYNC_CONFIG_REASON_BUFSIZE];
2135                         const char *reason;
2136
2137                         reason = ofp_async_config_reason_to_string(j, type,
2138                                                                    reasonbuf,
2139                                                            sizeof reasonbuf);
2140                         ds_put_format(string, " %s", reason);
2141                     }
2142                 }
2143                 if (!role[i][type]) {
2144                     ds_put_cstr(string, " (off)");
2145                 }
2146                 ds_put_char(string, '\n');
2147             }
2148         }
2149     }
2150 }
2151
2152 static void
2153 ofp_print_nxt_set_controller_id(struct ds *string,
2154                                 const struct nx_controller_id *nci)
2155 {
2156     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
2157 }
2158
2159 static void
2160 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
2161                                   const struct ofp_header *oh)
2162 {
2163     ds_put_format(string, " id=%"PRIu32,
2164                   ofputil_decode_flow_monitor_cancel(oh));
2165 }
2166
2167 static const char *
2168 nx_flow_monitor_flags_to_name(uint32_t bit)
2169 {
2170     enum nx_flow_monitor_flags fmf = bit;
2171
2172     switch (fmf) {
2173     case NXFMF_INITIAL: return "initial";
2174     case NXFMF_ADD: return "add";
2175     case NXFMF_DELETE: return "delete";
2176     case NXFMF_MODIFY: return "modify";
2177     case NXFMF_ACTIONS: return "actions";
2178     case NXFMF_OWN: return "own";
2179     }
2180
2181     return NULL;
2182 }
2183
2184 static void
2185 ofp_print_nxst_flow_monitor_request(struct ds *string,
2186                                     const struct ofp_header *oh)
2187 {
2188     struct ofpbuf b;
2189
2190     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2191     for (;;) {
2192         struct ofputil_flow_monitor_request request;
2193         int retval;
2194
2195         retval = ofputil_decode_flow_monitor_request(&request, &b);
2196         if (retval) {
2197             if (retval != EOF) {
2198                 ofp_print_error(string, retval);
2199             }
2200             return;
2201         }
2202
2203         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
2204         ofp_print_bit_names(string, request.flags,
2205                             nx_flow_monitor_flags_to_name, ',');
2206
2207         if (request.out_port != OFPP_NONE) {
2208             ds_put_cstr(string, " out_port=");
2209             ofputil_format_port(request.out_port, string);
2210         }
2211
2212         if (request.table_id != 0xff) {
2213             ds_put_format(string, " table=%"PRIu8, request.table_id);
2214         }
2215
2216         ds_put_char(string, ' ');
2217         match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
2218         ds_chomp(string, ' ');
2219     }
2220 }
2221
2222 static void
2223 ofp_print_nxst_flow_monitor_reply(struct ds *string,
2224                                   const struct ofp_header *oh)
2225 {
2226     uint64_t ofpacts_stub[1024 / 8];
2227     struct ofpbuf ofpacts;
2228     struct ofpbuf b;
2229
2230     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2231     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2232     for (;;) {
2233         char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2234         struct ofputil_flow_update update;
2235         struct match match;
2236         int retval;
2237
2238         update.match = &match;
2239         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
2240         if (retval) {
2241             if (retval != EOF) {
2242                 ofp_print_error(string, retval);
2243             }
2244             ofpbuf_uninit(&ofpacts);
2245             return;
2246         }
2247
2248         ds_put_cstr(string, "\n event=");
2249         switch (update.event) {
2250         case NXFME_ADDED:
2251             ds_put_cstr(string, "ADDED");
2252             break;
2253
2254         case NXFME_DELETED:
2255             ds_put_format(string, "DELETED reason=%s",
2256                           ofp_flow_removed_reason_to_string(update.reason,
2257                                                             reasonbuf,
2258                                                             sizeof reasonbuf));
2259             break;
2260
2261         case NXFME_MODIFIED:
2262             ds_put_cstr(string, "MODIFIED");
2263             break;
2264
2265         case NXFME_ABBREV:
2266             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
2267             continue;
2268         }
2269
2270         ds_put_format(string, " table=%"PRIu8, update.table_id);
2271         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
2272             ds_put_format(string, " idle_timeout=%"PRIu16,
2273                           update.idle_timeout);
2274         }
2275         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
2276             ds_put_format(string, " hard_timeout=%"PRIu16,
2277                           update.hard_timeout);
2278         }
2279         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
2280
2281         ds_put_char(string, ' ');
2282         match_format(update.match, string, OFP_DEFAULT_PRIORITY);
2283
2284         if (update.ofpacts_len) {
2285             if (string->string[string->length - 1] != ' ') {
2286                 ds_put_char(string, ' ');
2287             }
2288             ds_put_cstr(string, "actions=");
2289             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
2290         }
2291     }
2292 }
2293
2294 void
2295 ofp_print_version(const struct ofp_header *oh,
2296                   struct ds *string)
2297 {
2298     switch (oh->version) {
2299     case OFP10_VERSION:
2300         break;
2301     case OFP11_VERSION:
2302         ds_put_cstr(string, " (OF1.1)");
2303         break;
2304     case OFP12_VERSION:
2305         ds_put_cstr(string, " (OF1.2)");
2306         break;
2307     case OFP13_VERSION:
2308         ds_put_cstr(string, " (OF1.3)");
2309         break;
2310     case OFP14_VERSION:
2311         ds_put_cstr(string, " (OF1.4)");
2312         break;
2313     case OFP15_VERSION:
2314         ds_put_cstr(string, " (OF1.5)");
2315         break;
2316     default:
2317         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
2318         break;
2319     }
2320     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
2321 }
2322
2323 static void
2324 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2325                        struct ds *string)
2326 {
2327     ds_put_cstr(string, ofpraw_get_name(raw));
2328     ofp_print_version(oh, string);
2329 }
2330
2331 static void
2332 ofp_print_bucket_id(struct ds *s, const char *label, uint32_t bucket_id,
2333                     enum ofp_version ofp_version)
2334 {
2335     if (ofp_version < OFP15_VERSION) {
2336         return;
2337     }
2338
2339     ds_put_cstr(s, label);
2340
2341     switch (bucket_id) {
2342     case OFPG15_BUCKET_FIRST:
2343         ds_put_cstr(s, "first");
2344         break;
2345     case OFPG15_BUCKET_LAST:
2346         ds_put_cstr(s, "last");
2347         break;
2348     case OFPG15_BUCKET_ALL:
2349         ds_put_cstr(s, "all");
2350         break;
2351     default:
2352         ds_put_format(s, "%"PRIu32, bucket_id);
2353         break;
2354     }
2355
2356     ds_put_char(s, ',');
2357 }
2358
2359 static void
2360 ofp_print_group(struct ds *s, uint32_t group_id, uint8_t type,
2361                 const struct ovs_list *p_buckets,
2362                 const struct ofputil_group_props *props,
2363                 enum ofp_version ofp_version, bool suppress_type)
2364 {
2365     struct ofputil_bucket *bucket;
2366
2367     ds_put_format(s, "group_id=%"PRIu32, group_id);
2368
2369     if (!suppress_type) {
2370         static const char *type_str[] = { "all", "select", "indirect",
2371                                           "ff", "unknown" };
2372         ds_put_format(s, ",type=%s", type_str[type > 4 ? 4 : type]);
2373     }
2374
2375     if (props->selection_method[0]) {
2376         ds_put_format(s, ",selection_method=%s", props->selection_method);
2377         if (props->selection_method_param) {
2378             ds_put_format(s, ",selection_method_param=%"PRIu64,
2379                           props->selection_method_param);
2380         }
2381
2382         size_t n = bitmap_count1(props->fields.used.bm, MFF_N_IDS);
2383         if (n == 1) {
2384             ds_put_cstr(s, ",fields=");
2385             oxm_format_field_array(s, &props->fields);
2386         } else if (n > 1) {
2387             ds_put_cstr(s, ",fields(");
2388             oxm_format_field_array(s, &props->fields);
2389             ds_put_char(s, ')');
2390         }
2391     }
2392
2393     if (!p_buckets) {
2394         return;
2395     }
2396
2397     ds_put_char(s, ',');
2398
2399     LIST_FOR_EACH (bucket, list_node, p_buckets) {
2400         ds_put_cstr(s, "bucket=");
2401
2402         ofp_print_bucket_id(s, "bucket_id:", bucket->bucket_id, ofp_version);
2403         if (bucket->weight != (type == OFPGT11_SELECT ? 1 : 0)) {
2404             ds_put_format(s, "weight:%"PRIu16",", bucket->weight);
2405         }
2406         if (bucket->watch_port != OFPP_NONE) {
2407             ds_put_format(s, "watch_port:%"PRIu32",", bucket->watch_port);
2408         }
2409         if (bucket->watch_group != OFPG_ANY) {
2410             ds_put_format(s, "watch_group:%"PRIu32",", bucket->watch_group);
2411         }
2412
2413         ds_put_cstr(s, "actions=");
2414         ofpacts_format(bucket->ofpacts, bucket->ofpacts_len, s);
2415         ds_put_char(s, ',');
2416     }
2417
2418     ds_chomp(s, ',');
2419 }
2420
2421 static void
2422 ofp_print_ofpst_group_desc_request(struct ds *string,
2423                                    const struct ofp_header *oh)
2424 {
2425     uint32_t group_id = ofputil_decode_group_desc_request(oh);
2426     ds_put_cstr(string, " group_id=");
2427     ofputil_format_group(group_id, string);
2428 }
2429
2430 static void
2431 ofp_print_group_desc(struct ds *s, const struct ofp_header *oh)
2432 {
2433     struct ofpbuf b;
2434
2435     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2436     for (;;) {
2437         struct ofputil_group_desc gd;
2438         int retval;
2439
2440         retval = ofputil_decode_group_desc_reply(&gd, &b, oh->version);
2441         if (retval) {
2442             if (retval != EOF) {
2443                 ds_put_cstr(s, " ***parse error***");
2444             }
2445             break;
2446         }
2447
2448         ds_put_char(s, '\n');
2449         ds_put_char(s, ' ');
2450         ofp_print_group(s, gd.group_id, gd.type, &gd.buckets, &gd.props,
2451                         oh->version, false);
2452         ofputil_bucket_list_destroy(&gd.buckets);
2453      }
2454 }
2455
2456 static void
2457 ofp_print_ofpst_group_request(struct ds *string, const struct ofp_header *oh)
2458 {
2459     enum ofperr error;
2460     uint32_t group_id;
2461
2462     error = ofputil_decode_group_stats_request(oh, &group_id);
2463     if (error) {
2464         ofp_print_error(string, error);
2465         return;
2466     }
2467
2468     ds_put_cstr(string, " group_id=");
2469     ofputil_format_group(group_id, string);
2470 }
2471
2472 static void
2473 ofp_print_group_stats(struct ds *s, const struct ofp_header *oh)
2474 {
2475     struct ofpbuf b;
2476     uint32_t bucket_i;
2477
2478     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2479
2480     for (;;) {
2481         struct ofputil_group_stats gs;
2482         int retval;
2483
2484         retval = ofputil_decode_group_stats_reply(&b, &gs);
2485         if (retval) {
2486             if (retval != EOF) {
2487                 ds_put_cstr(s, " ***parse error***");
2488             }
2489             break;
2490         }
2491
2492         ds_put_char(s, '\n');
2493
2494         ds_put_char(s, ' ');
2495         ds_put_format(s, "group_id=%"PRIu32",", gs.group_id);
2496
2497         if (gs.duration_sec != UINT32_MAX) {
2498             ds_put_cstr(s, "duration=");
2499             ofp_print_duration(s, gs.duration_sec, gs.duration_nsec);
2500             ds_put_char(s, ',');
2501         }
2502         ds_put_format(s, "ref_count=%"PRIu32",", gs.ref_count);
2503         ds_put_format(s, "packet_count=%"PRIu64",", gs.packet_count);
2504         ds_put_format(s, "byte_count=%"PRIu64"", gs.byte_count);
2505
2506         for (bucket_i = 0; bucket_i < gs.n_buckets; bucket_i++) {
2507             if (gs.bucket_stats[bucket_i].packet_count != UINT64_MAX) {
2508                 ds_put_format(s, ",bucket%"PRIu32":", bucket_i);
2509                 ds_put_format(s, "packet_count=%"PRIu64",", gs.bucket_stats[bucket_i].packet_count);
2510                 ds_put_format(s, "byte_count=%"PRIu64"", gs.bucket_stats[bucket_i].byte_count);
2511             }
2512         }
2513
2514         free(gs.bucket_stats);
2515      }
2516 }
2517
2518 static const char *
2519 group_type_to_string(enum ofp11_group_type type)
2520 {
2521     switch (type) {
2522     case OFPGT11_ALL: return "all";
2523     case OFPGT11_SELECT: return "select";
2524     case OFPGT11_INDIRECT: return "indirect";
2525     case OFPGT11_FF: return "fast failover";
2526     default: OVS_NOT_REACHED();
2527     }
2528 }
2529
2530 static void
2531 ofp_print_group_features(struct ds *string, const struct ofp_header *oh)
2532 {
2533     struct ofputil_group_features features;
2534     int i;
2535
2536     ofputil_decode_group_features_reply(oh, &features);
2537
2538     ds_put_format(string, "\n Group table:\n");
2539     ds_put_format(string, "    Types:  0x%"PRIx32"\n", features.types);
2540     ds_put_format(string, "    Capabilities:  0x%"PRIx32"\n",
2541                   features.capabilities);
2542
2543     for (i = 0; i < OFPGT12_N_TYPES; i++) {
2544         if (features.types & (1u << i)) {
2545             ds_put_format(string, "    %s group:\n", group_type_to_string(i));
2546             ds_put_format(string, "       max_groups=%#"PRIx32"\n",
2547                           features.max_groups[i]);
2548             ds_put_format(string, "       actions: ");
2549             ofpact_bitmap_format(features.ofpacts[i], string);
2550             ds_put_char(string, '\n');
2551         }
2552     }
2553 }
2554
2555 static void
2556 ofp_print_group_mod__(struct ds *s, enum ofp_version ofp_version,
2557                       const struct ofputil_group_mod *gm)
2558 {
2559     bool bucket_command = false;
2560
2561     ds_put_char(s, '\n');
2562
2563     ds_put_char(s, ' ');
2564     switch (gm->command) {
2565     case OFPGC11_ADD:
2566         ds_put_cstr(s, "ADD");
2567         break;
2568
2569     case OFPGC11_MODIFY:
2570         ds_put_cstr(s, "MOD");
2571         break;
2572
2573     case OFPGC11_DELETE:
2574         ds_put_cstr(s, "DEL");
2575         break;
2576
2577     case OFPGC15_INSERT_BUCKET:
2578         ds_put_cstr(s, "INSERT_BUCKET");
2579         bucket_command = true;
2580         break;
2581
2582     case OFPGC15_REMOVE_BUCKET:
2583         ds_put_cstr(s, "REMOVE_BUCKET");
2584         bucket_command = true;
2585         break;
2586
2587     default:
2588         ds_put_format(s, "cmd:%"PRIu16"", gm->command);
2589     }
2590     ds_put_char(s, ' ');
2591
2592     if (bucket_command) {
2593         ofp_print_bucket_id(s, "command_bucket_id:",
2594                             gm->command_bucket_id, ofp_version);
2595     }
2596
2597     ofp_print_group(s, gm->group_id, gm->type, &gm->buckets, &gm->props,
2598                     ofp_version, bucket_command);
2599 }
2600
2601 static void
2602 ofp_print_group_mod(struct ds *s, const struct ofp_header *oh)
2603 {
2604     struct ofputil_group_mod gm;
2605     int error;
2606
2607     error = ofputil_decode_group_mod(oh, &gm);
2608     if (error) {
2609         ofp_print_error(s, error);
2610         return;
2611     }
2612     ofp_print_group_mod__(s, oh->version, &gm);
2613     ofputil_bucket_list_destroy(&gm.buckets);
2614 }
2615
2616 static void
2617 print_table_action_features(struct ds *s,
2618                             const struct ofputil_table_action_features *taf)
2619 {
2620     if (taf->ofpacts) {
2621         ds_put_cstr(s, "        actions: ");
2622         ofpact_bitmap_format(taf->ofpacts, s);
2623         ds_put_char(s, '\n');
2624     }
2625
2626     if (!bitmap_is_all_zeros(taf->set_fields.bm, MFF_N_IDS)) {
2627         int i;
2628
2629         ds_put_cstr(s, "        supported on Set-Field:");
2630         BITMAP_FOR_EACH_1 (i, MFF_N_IDS, taf->set_fields.bm) {
2631             ds_put_format(s, " %s", mf_from_id(i)->name);
2632         }
2633         ds_put_char(s, '\n');
2634     }
2635 }
2636
2637 static bool
2638 table_action_features_equal(const struct ofputil_table_action_features *a,
2639                             const struct ofputil_table_action_features *b)
2640 {
2641     return (a->ofpacts == b->ofpacts
2642             && bitmap_equal(a->set_fields.bm, b->set_fields.bm, MFF_N_IDS));
2643 }
2644
2645 static bool
2646 table_action_features_empty(const struct ofputil_table_action_features *taf)
2647 {
2648     return !taf->ofpacts && bitmap_is_all_zeros(taf->set_fields.bm, MFF_N_IDS);
2649 }
2650
2651 static void
2652 print_table_instruction_features(
2653     struct ds *s,
2654     const struct ofputil_table_instruction_features *tif,
2655     const struct ofputil_table_instruction_features *prev_tif)
2656 {
2657     int start, end;
2658
2659     if (!bitmap_is_all_zeros(tif->next, 255)) {
2660         ds_put_cstr(s, "      next tables: ");
2661         for (start = bitmap_scan(tif->next, 1, 0, 255); start < 255;
2662              start = bitmap_scan(tif->next, 1, end, 255)) {
2663             end = bitmap_scan(tif->next, 0, start + 1, 255);
2664             if (end == start + 1) {
2665                 ds_put_format(s, "%d,", start);
2666             } else {
2667                 ds_put_format(s, "%d-%d,", start, end - 1);
2668             }
2669         }
2670         ds_chomp(s, ',');
2671         if (ds_last(s) == ' ') {
2672             ds_put_cstr(s, "none");
2673         }
2674         ds_put_char(s, '\n');
2675     }
2676
2677     if (tif->instructions) {
2678         if (prev_tif && tif->instructions == prev_tif->instructions) {
2679             ds_put_cstr(s, "      (same instructions)\n");
2680         } else {
2681             ds_put_cstr(s, "      instructions: ");
2682             int i;
2683
2684             for (i = 0; i < 32; i++) {
2685                 if (tif->instructions & (1u << i)) {
2686                     ds_put_format(s, "%s,", ovs_instruction_name_from_type(i));
2687                 }
2688             }
2689             ds_chomp(s, ',');
2690             ds_put_char(s, '\n');
2691         }
2692     }
2693
2694     if (prev_tif
2695         && table_action_features_equal(&tif->write, &prev_tif->write)
2696         && table_action_features_equal(&tif->apply, &prev_tif->apply)
2697         && !bitmap_is_all_zeros(tif->write.set_fields.bm, MFF_N_IDS)) {
2698         ds_put_cstr(s, "      (same actions)\n");
2699     } else if (!table_action_features_equal(&tif->write, &tif->apply)) {
2700         ds_put_cstr(s, "      Write-Actions features:\n");
2701         print_table_action_features(s, &tif->write);
2702         ds_put_cstr(s, "      Apply-Actions features:\n");
2703         print_table_action_features(s, &tif->apply);
2704     } else if (tif->write.ofpacts
2705                || !bitmap_is_all_zeros(tif->write.set_fields.bm, MFF_N_IDS)) {
2706         ds_put_cstr(s, "      Write-Actions and Apply-Actions features:\n");
2707         print_table_action_features(s, &tif->write);
2708     }
2709 }
2710
2711 static bool
2712 table_instruction_features_equal(
2713     const struct ofputil_table_instruction_features *a,
2714     const struct ofputil_table_instruction_features *b)
2715 {
2716     return (bitmap_equal(a->next, b->next, 255)
2717             && a->instructions == b->instructions
2718             && table_action_features_equal(&a->write, &b->write)
2719             && table_action_features_equal(&a->apply, &b->apply));
2720 }
2721
2722 static bool
2723 table_instruction_features_empty(
2724     const struct ofputil_table_instruction_features *tif)
2725 {
2726     return (bitmap_is_all_zeros(tif->next, 255)
2727             && !tif->instructions
2728             && table_action_features_empty(&tif->write)
2729             && table_action_features_empty(&tif->apply));
2730 }
2731
2732 static bool
2733 table_features_equal(const struct ofputil_table_features *a,
2734                      const struct ofputil_table_features *b)
2735 {
2736     return (a->metadata_match == b->metadata_match
2737             && a->metadata_write == b->metadata_write
2738             && a->miss_config == b->miss_config
2739             && a->supports_eviction == b->supports_eviction
2740             && a->supports_vacancy_events == b->supports_vacancy_events
2741             && a->max_entries == b->max_entries
2742             && table_instruction_features_equal(&a->nonmiss, &b->nonmiss)
2743             && table_instruction_features_equal(&a->miss, &b->miss)
2744             && bitmap_equal(a->match.bm, b->match.bm, MFF_N_IDS));
2745 }
2746
2747 static bool
2748 table_features_empty(const struct ofputil_table_features *tf)
2749 {
2750     return (!tf->metadata_match
2751             && !tf->metadata_write
2752             && tf->miss_config == OFPUTIL_TABLE_MISS_DEFAULT
2753             && tf->supports_eviction < 0
2754             && tf->supports_vacancy_events < 0
2755             && !tf->max_entries
2756             && table_instruction_features_empty(&tf->nonmiss)
2757             && table_instruction_features_empty(&tf->miss)
2758             && bitmap_is_all_zeros(tf->match.bm, MFF_N_IDS));
2759 }
2760
2761 static bool
2762 table_stats_equal(const struct ofputil_table_stats *a,
2763                   const struct ofputil_table_stats *b)
2764 {
2765     return (a->active_count == b->active_count
2766             && a->lookup_count == b->lookup_count
2767             && a->matched_count == b->matched_count);
2768 }
2769
2770 void
2771 ofp_print_table_features(struct ds *s,
2772                          const struct ofputil_table_features *features,
2773                          const struct ofputil_table_features *prev_features,
2774                          const struct ofputil_table_stats *stats,
2775                          const struct ofputil_table_stats *prev_stats)
2776 {
2777     int i;
2778
2779     ds_put_format(s, "  table %"PRIu8, features->table_id);
2780     if (features->name[0]) {
2781         ds_put_format(s, " (\"%s\")", features->name);
2782     }
2783     ds_put_char(s, ':');
2784
2785     bool same_stats = prev_stats && table_stats_equal(stats, prev_stats);
2786     bool same_features = prev_features && table_features_equal(features,
2787                                                                prev_features);
2788     if ((!stats || same_stats) && same_features) {
2789         ds_put_cstr(s, " ditto");
2790         return;
2791     }
2792     ds_put_char(s, '\n');
2793     if (stats) {
2794         ds_put_format(s, "    active=%"PRIu32", ", stats->active_count);
2795         ds_put_format(s, "lookup=%"PRIu64", ", stats->lookup_count);
2796         ds_put_format(s, "matched=%"PRIu64"\n", stats->matched_count);
2797     }
2798     if (same_features) {
2799         if (!table_features_empty(features)) {
2800             ds_put_cstr(s, "    (same features)\n");
2801         }
2802         return;
2803     }
2804     if (features->metadata_match || features->metadata_write) {
2805         ds_put_format(s, "    metadata: match=%#"PRIx64" write=%#"PRIx64"\n",
2806                       ntohll(features->metadata_match),
2807                       ntohll(features->metadata_write));
2808     }
2809
2810     if (features->miss_config != OFPUTIL_TABLE_MISS_DEFAULT) {
2811         ds_put_format(s, "    config=%s\n",
2812                       ofputil_table_miss_to_string(features->miss_config));
2813     }
2814
2815     if (features->supports_eviction >= 0) {
2816         ds_put_format(s, "    eviction: %ssupported\n",
2817                       features->supports_eviction ? "" : "not ");
2818
2819     }
2820     if (features->supports_vacancy_events >= 0) {
2821         ds_put_format(s, "    vacancy events: %ssupported\n",
2822                       features->supports_vacancy_events ? "" : "not ");
2823
2824     }
2825
2826     if (features->max_entries) {
2827         ds_put_format(s, "    max_entries=%"PRIu32"\n", features->max_entries);
2828     }
2829
2830     const struct ofputil_table_instruction_features *prev_nonmiss
2831         = prev_features ? &prev_features->nonmiss : NULL;
2832     const struct ofputil_table_instruction_features *prev_miss
2833         = prev_features ? &prev_features->miss : NULL;
2834     if (prev_features
2835         && table_instruction_features_equal(&features->nonmiss, prev_nonmiss)
2836         && table_instruction_features_equal(&features->miss, prev_miss)) {
2837         if (!table_instruction_features_empty(&features->nonmiss)) {
2838             ds_put_cstr(s, "    (same instructions)\n");
2839         }
2840     } else if (!table_instruction_features_equal(&features->nonmiss,
2841                                                  &features->miss)) {
2842         ds_put_cstr(s, "    instructions (other than table miss):\n");
2843         print_table_instruction_features(s, &features->nonmiss, prev_nonmiss);
2844         ds_put_cstr(s, "    instructions (table miss):\n");
2845         print_table_instruction_features(s, &features->miss, prev_miss);
2846     } else if (!table_instruction_features_empty(&features->nonmiss)) {
2847         ds_put_cstr(s, "    instructions (table miss and others):\n");
2848         print_table_instruction_features(s, &features->nonmiss, prev_nonmiss);
2849     }
2850
2851     if (!bitmap_is_all_zeros(features->match.bm, MFF_N_IDS)) {
2852         if (prev_features
2853             && bitmap_equal(features->match.bm, prev_features->match.bm,
2854                             MFF_N_IDS)) {
2855             ds_put_cstr(s, "    (same matching)\n");
2856         } else {
2857             ds_put_cstr(s, "    matching:\n");
2858             BITMAP_FOR_EACH_1 (i, MFF_N_IDS, features->match.bm) {
2859                 const struct mf_field *f = mf_from_id(i);
2860                 bool mask = bitmap_is_set(features->mask.bm, i);
2861                 bool wildcard = bitmap_is_set(features->wildcard.bm, i);
2862
2863                 ds_put_format(s, "      %s: %s\n",
2864                               f->name,
2865                               (mask ? "arbitrary mask"
2866                                : wildcard ? "exact match or wildcard"
2867                                : "must exact match"));
2868             }
2869         }
2870     }
2871 }
2872
2873 static void
2874 ofp_print_table_features_reply(struct ds *s, const struct ofp_header *oh)
2875 {
2876     struct ofpbuf b;
2877
2878     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2879
2880     struct ofputil_table_features prev;
2881     for (int i = 0; ; i++) {
2882         struct ofputil_table_features tf;
2883         int retval;
2884
2885         retval = ofputil_decode_table_features(&b, &tf, true);
2886         if (retval) {
2887             if (retval != EOF) {
2888                 ofp_print_error(s, retval);
2889             }
2890             return;
2891         }
2892
2893         ds_put_char(s, '\n');
2894         ofp_print_table_features(s, &tf, i ? &prev : NULL, NULL, NULL);
2895         prev = tf;
2896     }
2897 }
2898
2899 static void
2900 ofp_print_table_desc_reply(struct ds *s, const struct ofp_header *oh)
2901 {
2902     struct ofpbuf b;
2903
2904     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2905
2906     for (;;) {
2907         struct ofputil_table_desc td;
2908         int retval;
2909
2910         retval = ofputil_decode_table_desc(&b, &td, oh->version);
2911         if (retval) {
2912             if (retval != EOF) {
2913                 ofp_print_error(s, retval);
2914             }
2915             return;
2916         }
2917         ofp_print_table_desc(s, &td);
2918     }
2919 }
2920
2921 static const char *
2922 bundle_flags_to_name(uint32_t bit)
2923 {
2924     switch (bit) {
2925     case OFPBF_ATOMIC:
2926         return "atomic";
2927     case OFPBF_ORDERED:
2928         return "ordered";
2929     default:
2930         return NULL;
2931     }
2932 }
2933
2934 static void
2935 ofp_print_bundle_ctrl(struct ds *s, const struct ofp_header *oh)
2936 {
2937     int error;
2938     struct ofputil_bundle_ctrl_msg bctrl;
2939
2940     error = ofputil_decode_bundle_ctrl(oh, &bctrl);
2941     if (error) {
2942         ofp_print_error(s, error);
2943         return;
2944     }
2945
2946     ds_put_char(s, '\n');
2947
2948     ds_put_format(s, " bundle_id=%#"PRIx32" type=",  bctrl.bundle_id);
2949     switch (bctrl.type) {
2950     case OFPBCT_OPEN_REQUEST:
2951         ds_put_cstr(s, "OPEN_REQUEST");
2952         break;
2953     case OFPBCT_OPEN_REPLY:
2954         ds_put_cstr(s, "OPEN_REPLY");
2955         break;
2956     case OFPBCT_CLOSE_REQUEST:
2957         ds_put_cstr(s, "CLOSE_REQUEST");
2958         break;
2959     case OFPBCT_CLOSE_REPLY:
2960         ds_put_cstr(s, "CLOSE_REPLY");
2961         break;
2962     case OFPBCT_COMMIT_REQUEST:
2963         ds_put_cstr(s, "COMMIT_REQUEST");
2964         break;
2965     case OFPBCT_COMMIT_REPLY:
2966         ds_put_cstr(s, "COMMIT_REPLY");
2967         break;
2968     case OFPBCT_DISCARD_REQUEST:
2969         ds_put_cstr(s, "DISCARD_REQUEST");
2970         break;
2971     case OFPBCT_DISCARD_REPLY:
2972         ds_put_cstr(s, "DISCARD_REPLY");
2973         break;
2974     }
2975
2976     ds_put_cstr(s, " flags=");
2977     ofp_print_bit_names(s, bctrl.flags, bundle_flags_to_name, ' ');
2978 }
2979
2980 static void
2981 ofp_print_bundle_add(struct ds *s, const struct ofp_header *oh, int verbosity)
2982 {
2983     int error;
2984     struct ofputil_bundle_add_msg badd;
2985     char *msg;
2986
2987     error = ofputil_decode_bundle_add(oh, &badd, NULL);
2988     if (error) {
2989         ofp_print_error(s, error);
2990         return;
2991     }
2992
2993     ds_put_char(s, '\n');
2994     ds_put_format(s, " bundle_id=%#"PRIx32,  badd.bundle_id);
2995     ds_put_cstr(s, " flags=");
2996     ofp_print_bit_names(s, badd.flags, bundle_flags_to_name, ' ');
2997
2998     ds_put_char(s, '\n');
2999     msg = ofp_to_string(badd.msg, ntohs(badd.msg->length), verbosity);
3000     if (msg) {
3001         ds_put_cstr(s, msg);
3002     }
3003 }
3004
3005 static void
3006 print_geneve_table(struct ds *s, struct ovs_list *mappings)
3007 {
3008     struct ofputil_geneve_map *map;
3009
3010     ds_put_cstr(s, " mapping table:\n");
3011     ds_put_cstr(s, " class\ttype\tlength\tmatch field\n");
3012     ds_put_cstr(s, " -----\t----\t------\t-----------");
3013
3014     LIST_FOR_EACH (map, list_node, mappings) {
3015         ds_put_char(s, '\n');
3016         ds_put_format(s, " 0x%"PRIx16"\t0x%"PRIx8"\t%"PRIu8"\ttun_metadata%"PRIu16,
3017                       map->option_class, map->option_type, map->option_len,
3018                       map->index);
3019     }
3020 }
3021
3022 static void
3023 ofp_print_geneve_table_mod(struct ds *s, const struct ofp_header *oh)
3024 {
3025     int error;
3026     struct ofputil_geneve_table_mod gtm;
3027
3028     error = ofputil_decode_geneve_table_mod(oh, &gtm);
3029     if (error) {
3030         ofp_print_error(s, error);
3031         return;
3032     }
3033
3034     ds_put_cstr(s, "\n ");
3035
3036     switch (gtm.command) {
3037     case NXGTMC_ADD:
3038         ds_put_cstr(s, "ADD");
3039         break;
3040     case NXGTMC_DELETE:
3041         ds_put_cstr(s, "DEL");
3042         break;
3043     case NXGTMC_CLEAR:
3044         ds_put_cstr(s, "CLEAR");
3045         break;
3046     }
3047
3048     if (gtm.command != NXGTMC_CLEAR) {
3049         print_geneve_table(s, &gtm.mappings);
3050     }
3051
3052     ofputil_uninit_geneve_table(&gtm.mappings);
3053 }
3054
3055 static void
3056 ofp_print_geneve_table_reply(struct ds *s, const struct ofp_header *oh)
3057 {
3058     int error;
3059     struct ofputil_geneve_table_reply gtr;
3060     struct ofputil_geneve_map *map;
3061     int allocated_space = 0;
3062
3063     error = ofputil_decode_geneve_table_reply(oh, &gtr);
3064     if (error) {
3065         ofp_print_error(s, error);
3066         return;
3067     }
3068
3069     ds_put_char(s, '\n');
3070
3071     LIST_FOR_EACH (map, list_node, &gtr.mappings) {
3072         allocated_space += map->option_len;
3073     }
3074
3075     ds_put_format(s, " max option space=%"PRIu32" max fields=%"PRIu16"\n",
3076                   gtr.max_option_space, gtr.max_fields);
3077     ds_put_format(s, " allocated option space=%d\n", allocated_space);
3078     ds_put_char(s, '\n');
3079     print_geneve_table(s, &gtr.mappings);
3080
3081     ofputil_uninit_geneve_table(&gtr.mappings);
3082 }
3083
3084 /* This function will print the request forward message. The reason for
3085  * request forward is taken from rf.request.type */
3086 static void
3087 ofp_print_requestforward(struct ds *string, const struct ofp_header *oh)
3088 {
3089     struct ofputil_requestforward rf;
3090     enum ofperr error;
3091
3092     error = ofputil_decode_requestforward(oh, &rf);
3093     if (error) {
3094         ofp_print_error(string, error);
3095         return;
3096     }
3097
3098     ds_put_cstr(string, " reason=");
3099
3100     switch (rf.reason) {
3101     case OFPRFR_GROUP_MOD:
3102         ds_put_cstr(string, "group_mod");
3103         ofp_print_group_mod__(string, oh->version, rf.group_mod);
3104         break;
3105
3106     case OFPRFR_METER_MOD:
3107         ds_put_cstr(string, "meter_mod");
3108         ofp_print_meter_mod__(string, rf.meter_mod);
3109         break;
3110     }
3111     ofputil_destroy_requestforward(&rf);
3112 }
3113
3114 static void
3115 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
3116                 struct ds *string, int verbosity)
3117 {
3118     const void *msg = oh;
3119
3120     ofp_header_to_string__(oh, raw, string);
3121     switch (ofptype_from_ofpraw(raw)) {
3122
3123     case OFPTYPE_GROUP_STATS_REQUEST:
3124         ofp_print_stats(string, oh);
3125         ofp_print_ofpst_group_request(string, oh);
3126         break;
3127
3128     case OFPTYPE_GROUP_STATS_REPLY:
3129         ofp_print_group_stats(string, oh);
3130         break;
3131
3132     case OFPTYPE_GROUP_DESC_STATS_REQUEST:
3133         ofp_print_stats(string, oh);
3134         ofp_print_ofpst_group_desc_request(string, oh);
3135         break;
3136
3137     case OFPTYPE_GROUP_DESC_STATS_REPLY:
3138         ofp_print_group_desc(string, oh);
3139         break;
3140
3141     case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
3142         ofp_print_stats(string, oh);
3143         break;
3144
3145     case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
3146         ofp_print_group_features(string, oh);
3147         break;
3148
3149     case OFPTYPE_GROUP_MOD:
3150         ofp_print_group_mod(string, oh);
3151         break;
3152
3153     case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
3154     case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
3155         ofp_print_table_features_reply(string, oh);
3156         break;
3157
3158     case OFPTYPE_TABLE_DESC_REQUEST:
3159     case OFPTYPE_TABLE_DESC_REPLY:
3160         ofp_print_table_desc_reply(string, oh);
3161         break;
3162
3163     case OFPTYPE_HELLO:
3164         ofp_print_hello(string, oh);
3165         break;
3166
3167     case OFPTYPE_ERROR:
3168         ofp_print_error_msg(string, oh);
3169         break;
3170
3171     case OFPTYPE_ECHO_REQUEST:
3172     case OFPTYPE_ECHO_REPLY:
3173         ofp_print_echo(string, oh, verbosity);
3174         break;
3175
3176     case OFPTYPE_FEATURES_REQUEST:
3177         break;
3178
3179     case OFPTYPE_FEATURES_REPLY:
3180         ofp_print_switch_features(string, oh);
3181         break;
3182
3183     case OFPTYPE_GET_CONFIG_REQUEST:
3184         break;
3185
3186     case OFPTYPE_GET_CONFIG_REPLY:
3187     case OFPTYPE_SET_CONFIG:
3188         ofp_print_switch_config(string, ofpmsg_body(oh));
3189         break;
3190
3191     case OFPTYPE_PACKET_IN:
3192         ofp_print_packet_in(string, oh, verbosity);
3193         break;
3194
3195     case OFPTYPE_FLOW_REMOVED:
3196         ofp_print_flow_removed(string, oh);
3197         break;
3198
3199     case OFPTYPE_PORT_STATUS:
3200         ofp_print_port_status(string, oh);
3201         break;
3202
3203     case OFPTYPE_PACKET_OUT:
3204         ofp_print_packet_out(string, oh, verbosity);
3205         break;
3206
3207     case OFPTYPE_FLOW_MOD:
3208         ofp_print_flow_mod(string, oh, verbosity);
3209         break;
3210
3211     case OFPTYPE_PORT_MOD:
3212         ofp_print_port_mod(string, oh);
3213         break;
3214
3215     case OFPTYPE_TABLE_MOD:
3216         ofp_print_table_mod(string, oh);
3217         break;
3218
3219     case OFPTYPE_METER_MOD:
3220         ofp_print_meter_mod(string, oh);
3221         break;
3222
3223     case OFPTYPE_BARRIER_REQUEST:
3224     case OFPTYPE_BARRIER_REPLY:
3225         break;
3226
3227     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
3228         ofp_print_queue_get_config_request(string, oh);
3229         break;
3230
3231     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
3232         ofp_print_queue_get_config_reply(string, oh);
3233         break;
3234
3235     case OFPTYPE_ROLE_REQUEST:
3236     case OFPTYPE_ROLE_REPLY:
3237         ofp_print_role_message(string, oh);
3238         break;
3239     case OFPTYPE_ROLE_STATUS:
3240         ofp_print_role_status_message(string, oh);
3241         break;
3242
3243     case OFPTYPE_REQUESTFORWARD:
3244         ofp_print_requestforward(string, oh);
3245         break;
3246
3247     case OFPTYPE_METER_STATS_REQUEST:
3248     case OFPTYPE_METER_CONFIG_STATS_REQUEST:
3249         ofp_print_stats(string, oh);
3250         ofp_print_meter_stats_request(string, oh);
3251         break;
3252
3253     case OFPTYPE_METER_STATS_REPLY:
3254         ofp_print_stats(string, oh);
3255         ofp_print_meter_stats_reply(string, oh);
3256         break;
3257
3258     case OFPTYPE_METER_CONFIG_STATS_REPLY:
3259         ofp_print_stats(string, oh);
3260         ofp_print_meter_config_reply(string, oh);
3261         break;
3262
3263     case OFPTYPE_METER_FEATURES_STATS_REPLY:
3264         ofp_print_stats(string, oh);
3265         ofp_print_meter_features_reply(string, oh);
3266         break;
3267
3268     case OFPTYPE_DESC_STATS_REQUEST:
3269     case OFPTYPE_METER_FEATURES_STATS_REQUEST:
3270         ofp_print_stats(string, oh);
3271         break;
3272
3273     case OFPTYPE_FLOW_STATS_REQUEST:
3274     case OFPTYPE_AGGREGATE_STATS_REQUEST:
3275         ofp_print_stats(string, oh);
3276         ofp_print_flow_stats_request(string, oh);
3277         break;
3278
3279     case OFPTYPE_TABLE_STATS_REQUEST:
3280         ofp_print_stats(string, oh);
3281         break;
3282
3283     case OFPTYPE_PORT_STATS_REQUEST:
3284         ofp_print_stats(string, oh);
3285         ofp_print_ofpst_port_request(string, oh);
3286         break;
3287
3288     case OFPTYPE_QUEUE_STATS_REQUEST:
3289         ofp_print_stats(string, oh);
3290         ofp_print_ofpst_queue_request(string, oh);
3291         break;
3292
3293     case OFPTYPE_DESC_STATS_REPLY:
3294         ofp_print_stats(string, oh);
3295         ofp_print_ofpst_desc_reply(string, oh);
3296         break;
3297
3298     case OFPTYPE_FLOW_STATS_REPLY:
3299         ofp_print_stats(string, oh);
3300         ofp_print_flow_stats_reply(string, oh);
3301         break;
3302
3303     case OFPTYPE_QUEUE_STATS_REPLY:
3304         ofp_print_stats(string, oh);
3305         ofp_print_ofpst_queue_reply(string, oh, verbosity);
3306         break;
3307
3308     case OFPTYPE_PORT_STATS_REPLY:
3309         ofp_print_stats(string, oh);
3310         ofp_print_ofpst_port_reply(string, oh, verbosity);
3311         break;
3312
3313     case OFPTYPE_TABLE_STATS_REPLY:
3314         ofp_print_stats(string, oh);
3315         ofp_print_table_stats_reply(string, oh);
3316         break;
3317
3318     case OFPTYPE_AGGREGATE_STATS_REPLY:
3319         ofp_print_stats(string, oh);
3320         ofp_print_aggregate_stats_reply(string, oh);
3321         break;
3322
3323     case OFPTYPE_PORT_DESC_STATS_REQUEST:
3324         ofp_print_stats(string, oh);
3325         ofp_print_ofpst_port_desc_request(string, oh);
3326         break;
3327
3328     case OFPTYPE_PORT_DESC_STATS_REPLY:
3329         ofp_print_stats(string, oh);
3330         ofp_print_ofpst_port_desc_reply(string, oh);
3331         break;
3332
3333     case OFPTYPE_FLOW_MOD_TABLE_ID:
3334         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
3335         break;
3336
3337     case OFPTYPE_SET_FLOW_FORMAT:
3338         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
3339         break;
3340
3341     case OFPTYPE_SET_PACKET_IN_FORMAT:
3342         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
3343         break;
3344
3345     case OFPTYPE_FLOW_AGE:
3346         break;
3347
3348     case OFPTYPE_SET_CONTROLLER_ID:
3349         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
3350         break;
3351
3352     case OFPTYPE_GET_ASYNC_REPLY:
3353     case OFPTYPE_SET_ASYNC_CONFIG:
3354         ofp_print_nxt_set_async_config(string, oh);
3355         break;
3356     case OFPTYPE_GET_ASYNC_REQUEST:
3357         break;
3358     case OFPTYPE_FLOW_MONITOR_CANCEL:
3359         ofp_print_nxt_flow_monitor_cancel(string, msg);
3360         break;
3361
3362     case OFPTYPE_FLOW_MONITOR_PAUSED:
3363     case OFPTYPE_FLOW_MONITOR_RESUMED:
3364         break;
3365
3366     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
3367         ofp_print_nxst_flow_monitor_request(string, msg);
3368         break;
3369
3370     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
3371         ofp_print_nxst_flow_monitor_reply(string, msg);
3372         break;
3373
3374     case OFPTYPE_BUNDLE_CONTROL:
3375         ofp_print_bundle_ctrl(string, msg);
3376         break;
3377
3378     case OFPTYPE_BUNDLE_ADD_MESSAGE:
3379         ofp_print_bundle_add(string, msg, verbosity);
3380         break;
3381
3382     case OFPTYPE_NXT_GENEVE_TABLE_MOD:
3383         ofp_print_geneve_table_mod(string, msg);
3384         break;
3385
3386     case OFPTYPE_NXT_GENEVE_TABLE_REQUEST:
3387         break;
3388
3389     case OFPTYPE_NXT_GENEVE_TABLE_REPLY:
3390         ofp_print_geneve_table_reply(string, msg);
3391         break;
3392
3393     }
3394 }
3395
3396 /* Composes and returns a string representing the OpenFlow packet of 'len'
3397  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
3398  * verbosity and higher numbers increase verbosity.  The caller is responsible
3399  * for freeing the string. */
3400 char *
3401 ofp_to_string(const void *oh_, size_t len, int verbosity)
3402 {
3403     struct ds string = DS_EMPTY_INITIALIZER;
3404     const struct ofp_header *oh = oh_;
3405
3406     if (!len) {
3407         ds_put_cstr(&string, "OpenFlow message is empty\n");
3408     } else if (len < sizeof(struct ofp_header)) {
3409         ds_put_format(&string, "OpenFlow packet too short (only %"PRIuSIZE" bytes):\n",
3410                       len);
3411     } else if (ntohs(oh->length) > len) {
3412         enum ofperr error;
3413         enum ofpraw raw;
3414
3415         error = ofpraw_decode_partial(&raw, oh, len);
3416         if (!error) {
3417             ofp_header_to_string__(oh, raw, &string);
3418             ds_put_char(&string, '\n');
3419         }
3420
3421         ds_put_format(&string,
3422                       "(***truncated to %"PRIuSIZE" bytes from %"PRIu16"***)\n",
3423                       len, ntohs(oh->length));
3424     } else if (ntohs(oh->length) < len) {
3425         ds_put_format(&string,
3426                       "(***only uses %"PRIu16" bytes out of %"PRIuSIZE"***)\n",
3427                       ntohs(oh->length), len);
3428     } else {
3429         enum ofperr error;
3430         enum ofpraw raw;
3431
3432         error = ofpraw_decode(&raw, oh);
3433         if (!error) {
3434             ofp_to_string__(oh, raw, &string, verbosity);
3435             if (verbosity >= 5) {
3436                 if (ds_last(&string) != '\n') {
3437                     ds_put_char(&string, '\n');
3438                 }
3439                 ds_put_hex_dump(&string, oh, len, 0, true);
3440             }
3441             if (ds_last(&string) != '\n') {
3442                 ds_put_char(&string, '\n');
3443             }
3444             return ds_steal_cstr(&string);
3445         }
3446
3447         ofp_print_error(&string, error);
3448     }
3449     ds_put_hex_dump(&string, oh, len, 0, true);
3450     return ds_steal_cstr(&string);
3451 }
3452 \f
3453 static void
3454 print_and_free(FILE *stream, char *string)
3455 {
3456     fputs(string, stream);
3457     free(string);
3458 }
3459
3460 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
3461  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
3462  * numbers increase verbosity. */
3463 void
3464 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
3465 {
3466     print_and_free(stream, ofp_to_string(oh, len, verbosity));
3467 }
3468
3469 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
3470  * 'data' to 'stream'. */
3471 void
3472 ofp_print_packet(FILE *stream, const void *data, size_t len)
3473 {
3474     print_and_free(stream, ofp_packet_to_string(data, len));
3475 }