b280a3738b833948e8e48dfd674334bad04ee17f
[sliver-openvswitch.git] / lib / ofp-print.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 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 "ofp-errors.h"
41 #include "ofp-msgs.h"
42 #include "ofp-util.h"
43 #include "ofpbuf.h"
44 #include "openflow/openflow.h"
45 #include "openflow/nicira-ext.h"
46 #include "packets.h"
47 #include "type-props.h"
48 #include "unaligned.h"
49 #include "util.h"
50
51 static void ofp_print_queue_name(struct ds *string, uint32_t port);
52 static void ofp_print_error(struct ds *, enum ofperr);
53
54
55 /* Returns a string that represents the contents of the Ethernet frame in the
56  * 'len' bytes starting at 'data'.  The caller must free the returned string.*/
57 char *
58 ofp_packet_to_string(const void *data, size_t len)
59 {
60     struct ds ds = DS_EMPTY_INITIALIZER;
61     struct ofpbuf buf;
62     struct flow flow;
63
64     ofpbuf_use_const(&buf, data, len);
65     flow_extract(&buf, 0, 0, NULL, NULL, &flow);
66     flow_format(&ds, &flow);
67
68     if (buf.l7) {
69         if (flow.nw_proto == IPPROTO_TCP) {
70             struct tcp_header *th = buf.l4;
71             ds_put_format(&ds, " tcp_csum:%"PRIx16,
72                           ntohs(th->tcp_csum));
73         } else if (flow.nw_proto == IPPROTO_UDP) {
74             struct udp_header *uh = buf.l4;
75             ds_put_format(&ds, " udp_csum:%"PRIx16,
76                           ntohs(uh->udp_csum));
77         } else if (flow.nw_proto == IPPROTO_SCTP) {
78             struct sctp_header *sh = buf.l4;
79             ds_put_format(&ds, " sctp_csum:%"PRIx32,
80                           ntohl(sh->sctp_csum));
81         }
82     }
83
84     ds_put_char(&ds, '\n');
85
86     return ds_cstr(&ds);
87 }
88
89 static void
90 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
91                     int verbosity)
92 {
93     char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
94     struct ofputil_packet_in pin;
95     int error;
96     int i;
97
98     error = ofputil_decode_packet_in(&pin, oh);
99     if (error) {
100         ofp_print_error(string, error);
101         return;
102     }
103
104     if (pin.table_id) {
105         ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
106     }
107
108     if (pin.cookie) {
109         ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
110     }
111
112     ds_put_format(string, " total_len=%"PRIu16" in_port=", pin.total_len);
113     ofputil_format_port(pin.fmd.in_port, string);
114
115     if (pin.fmd.tun_id != htonll(0)) {
116         ds_put_format(string, " tun_id=0x%"PRIx64, ntohll(pin.fmd.tun_id));
117     }
118
119     if (pin.fmd.tun_src != htonl(0)) {
120         ds_put_format(string, " tun_src="IP_FMT, IP_ARGS(pin.fmd.tun_src));
121     }
122
123     if (pin.fmd.tun_dst != htonl(0)) {
124         ds_put_format(string, " tun_dst="IP_FMT, IP_ARGS(pin.fmd.tun_dst));
125     }
126
127     if (pin.fmd.metadata != htonll(0)) {
128         ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
129     }
130
131     for (i = 0; i < FLOW_N_REGS; i++) {
132         if (pin.fmd.regs[i]) {
133             ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
134         }
135     }
136
137     if (pin.fmd.pkt_mark != 0) {
138         ds_put_format(string, " pkt_mark=0x%"PRIx32, pin.fmd.pkt_mark);
139     }
140
141     ds_put_format(string, " (via %s)",
142                   ofputil_packet_in_reason_to_string(pin.reason, reasonbuf,
143                                                      sizeof reasonbuf));
144
145     ds_put_format(string, " data_len=%zu", pin.packet_len);
146     if (pin.buffer_id == UINT32_MAX) {
147         ds_put_format(string, " (unbuffered)");
148         if (pin.total_len != pin.packet_len) {
149             ds_put_format(string, " (***total_len != data_len***)");
150         }
151     } else {
152         ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
153         if (pin.total_len < pin.packet_len) {
154             ds_put_format(string, " (***total_len < data_len***)");
155         }
156     }
157     ds_put_char(string, '\n');
158
159     if (verbosity > 0) {
160         char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
161         ds_put_cstr(string, packet);
162         free(packet);
163     }
164     if (verbosity > 2) {
165         ds_put_hex_dump(string, pin.packet, pin.packet_len, 0, false);
166     }
167 }
168
169 static void
170 ofp_print_packet_out(struct ds *string, const struct ofp_header *oh,
171                      int verbosity)
172 {
173     struct ofputil_packet_out po;
174     struct ofpbuf ofpacts;
175     enum ofperr error;
176
177     ofpbuf_init(&ofpacts, 64);
178     error = ofputil_decode_packet_out(&po, oh, &ofpacts);
179     if (error) {
180         ofpbuf_uninit(&ofpacts);
181         ofp_print_error(string, error);
182         return;
183     }
184
185     ds_put_cstr(string, " in_port=");
186     ofputil_format_port(po.in_port, string);
187
188     ds_put_char(string, ' ');
189     ofpacts_format(po.ofpacts, po.ofpacts_len, string);
190
191     if (po.buffer_id == UINT32_MAX) {
192         ds_put_format(string, " data_len=%zu", po.packet_len);
193         if (verbosity > 0 && po.packet_len > 0) {
194             char *packet = ofp_packet_to_string(po.packet, po.packet_len);
195             ds_put_char(string, '\n');
196             ds_put_cstr(string, packet);
197             free(packet);
198         }
199         if (verbosity > 2) {
200             ds_put_hex_dump(string, po.packet, po.packet_len, 0, false);
201         }
202     } else {
203         ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
204     }
205
206     ofpbuf_uninit(&ofpacts);
207 }
208
209 /* qsort comparison function. */
210 static int
211 compare_ports(const void *a_, const void *b_)
212 {
213     const struct ofputil_phy_port *a = a_;
214     const struct ofputil_phy_port *b = b_;
215     uint16_t ap = ofp_to_u16(a->port_no);
216     uint16_t bp = ofp_to_u16(b->port_no);
217
218     return ap < bp ? -1 : ap > bp;
219 }
220
221 static void
222 ofp_print_bit_names(struct ds *string, uint32_t bits,
223                     const char *(*bit_to_name)(uint32_t bit),
224                     char separator)
225 {
226     int n = 0;
227     int i;
228
229     if (!bits) {
230         ds_put_cstr(string, "0");
231         return;
232     }
233
234     for (i = 0; i < 32; i++) {
235         uint32_t bit = UINT32_C(1) << i;
236
237         if (bits & bit) {
238             const char *name = bit_to_name(bit);
239             if (name) {
240                 if (n++) {
241                     ds_put_char(string, separator);
242                 }
243                 ds_put_cstr(string, name);
244                 bits &= ~bit;
245             }
246         }
247     }
248
249     if (bits) {
250         if (n) {
251             ds_put_char(string, separator);
252         }
253         ds_put_format(string, "0x%"PRIx32, bits);
254     }
255 }
256
257 static const char *
258 netdev_feature_to_name(uint32_t bit)
259 {
260     enum netdev_features f = bit;
261
262     switch (f) {
263     case NETDEV_F_10MB_HD:    return "10MB-HD";
264     case NETDEV_F_10MB_FD:    return "10MB-FD";
265     case NETDEV_F_100MB_HD:   return "100MB-HD";
266     case NETDEV_F_100MB_FD:   return "100MB-FD";
267     case NETDEV_F_1GB_HD:     return "1GB-HD";
268     case NETDEV_F_1GB_FD:     return "1GB-FD";
269     case NETDEV_F_10GB_FD:    return "10GB-FD";
270     case NETDEV_F_40GB_FD:    return "40GB-FD";
271     case NETDEV_F_100GB_FD:   return "100GB-FD";
272     case NETDEV_F_1TB_FD:     return "1TB-FD";
273     case NETDEV_F_OTHER:      return "OTHER";
274     case NETDEV_F_COPPER:     return "COPPER";
275     case NETDEV_F_FIBER:      return "FIBER";
276     case NETDEV_F_AUTONEG:    return "AUTO_NEG";
277     case NETDEV_F_PAUSE:      return "AUTO_PAUSE";
278     case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
279     }
280
281     return NULL;
282 }
283
284 static void
285 ofp_print_port_features(struct ds *string, enum netdev_features features)
286 {
287     ofp_print_bit_names(string, features, netdev_feature_to_name, ' ');
288     ds_put_char(string, '\n');
289 }
290
291 static const char *
292 ofputil_port_config_to_name(uint32_t bit)
293 {
294     enum ofputil_port_config pc = bit;
295
296     switch (pc) {
297     case OFPUTIL_PC_PORT_DOWN:    return "PORT_DOWN";
298     case OFPUTIL_PC_NO_STP:       return "NO_STP";
299     case OFPUTIL_PC_NO_RECV:      return "NO_RECV";
300     case OFPUTIL_PC_NO_RECV_STP:  return "NO_RECV_STP";
301     case OFPUTIL_PC_NO_FLOOD:     return "NO_FLOOD";
302     case OFPUTIL_PC_NO_FWD:       return "NO_FWD";
303     case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
304     }
305
306     return NULL;
307 }
308
309 static void
310 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
311 {
312     ofp_print_bit_names(string, config, ofputil_port_config_to_name, ' ');
313     ds_put_char(string, '\n');
314 }
315
316 static const char *
317 ofputil_port_state_to_name(uint32_t bit)
318 {
319     enum ofputil_port_state ps = bit;
320
321     switch (ps) {
322     case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
323     case OFPUTIL_PS_BLOCKED:   return "BLOCKED";
324     case OFPUTIL_PS_LIVE:      return "LIVE";
325
326     case OFPUTIL_PS_STP_LISTEN:
327     case OFPUTIL_PS_STP_LEARN:
328     case OFPUTIL_PS_STP_FORWARD:
329     case OFPUTIL_PS_STP_BLOCK:
330         /* Handled elsewhere. */
331         return NULL;
332     }
333
334     return NULL;
335 }
336
337 static void
338 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
339 {
340     enum ofputil_port_state stp_state;
341
342     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
343      * pattern.  We have to special case it.
344      *
345      * OVS doesn't support STP, so this field will always be 0 if we are
346      * talking to OVS, so we'd always print STP_LISTEN in that case.
347      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
348      * avoid confusing users. */
349     stp_state = state & OFPUTIL_PS_STP_MASK;
350     if (stp_state) {
351         ds_put_cstr(string,
352                     (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
353                      : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
354                      : "STP_BLOCK"));
355         state &= ~OFPUTIL_PS_STP_MASK;
356         if (state) {
357             ofp_print_bit_names(string, state, ofputil_port_state_to_name,
358                                 ' ');
359         }
360     } else {
361         ofp_print_bit_names(string, state, ofputil_port_state_to_name, ' ');
362     }
363     ds_put_char(string, '\n');
364 }
365
366 static void
367 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
368 {
369     char name[sizeof port->name];
370     int j;
371
372     memcpy(name, port->name, sizeof name);
373     for (j = 0; j < sizeof name - 1; j++) {
374         if (!isprint((unsigned char) name[j])) {
375             break;
376         }
377     }
378     name[j] = '\0';
379
380     ds_put_char(string, ' ');
381     ofputil_format_port(port->port_no, string);
382     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
383                   name, ETH_ADDR_ARGS(port->hw_addr));
384
385     ds_put_cstr(string, "     config:     ");
386     ofp_print_port_config(string, port->config);
387
388     ds_put_cstr(string, "     state:      ");
389     ofp_print_port_state(string, port->state);
390
391     if (port->curr) {
392         ds_put_format(string, "     current:    ");
393         ofp_print_port_features(string, port->curr);
394     }
395     if (port->advertised) {
396         ds_put_format(string, "     advertised: ");
397         ofp_print_port_features(string, port->advertised);
398     }
399     if (port->supported) {
400         ds_put_format(string, "     supported:  ");
401         ofp_print_port_features(string, port->supported);
402     }
403     if (port->peer) {
404         ds_put_format(string, "     peer:       ");
405         ofp_print_port_features(string, port->peer);
406     }
407     ds_put_format(string, "     speed: %"PRIu32" Mbps now, "
408                   "%"PRIu32" Mbps max\n",
409                   port->curr_speed / UINT32_C(1000),
410                   port->max_speed / UINT32_C(1000));
411 }
412
413 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
414  * 'ofp_version', writes a detailed description of each port into
415  * 'string'. */
416 static void
417 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
418                     struct ofpbuf *b)
419 {
420     size_t n_ports;
421     struct ofputil_phy_port *ports;
422     enum ofperr error;
423     size_t i;
424
425     n_ports = ofputil_count_phy_ports(ofp_version, b);
426
427     ports = xmalloc(n_ports * sizeof *ports);
428     for (i = 0; i < n_ports; i++) {
429         error = ofputil_pull_phy_port(ofp_version, b, &ports[i]);
430         if (error) {
431             ofp_print_error(string, error);
432             goto exit;
433         }
434     }
435     qsort(ports, n_ports, sizeof *ports, compare_ports);
436     for (i = 0; i < n_ports; i++) {
437         ofp_print_phy_port(string, &ports[i]);
438     }
439
440 exit:
441     free(ports);
442 }
443
444 static const char *
445 ofputil_capabilities_to_name(uint32_t bit)
446 {
447     enum ofputil_capabilities capabilities = bit;
448
449     switch (capabilities) {
450     case OFPUTIL_C_FLOW_STATS:   return "FLOW_STATS";
451     case OFPUTIL_C_TABLE_STATS:  return "TABLE_STATS";
452     case OFPUTIL_C_PORT_STATS:   return "PORT_STATS";
453     case OFPUTIL_C_IP_REASM:     return "IP_REASM";
454     case OFPUTIL_C_QUEUE_STATS:  return "QUEUE_STATS";
455     case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
456     case OFPUTIL_C_STP:          return "STP";
457     case OFPUTIL_C_GROUP_STATS:  return "GROUP_STATS";
458     case OFPUTIL_C_PORT_BLOCKED: return "PORT_BLOCKED";
459     }
460
461     return NULL;
462 }
463
464 static const char *
465 ofputil_action_bitmap_to_name(uint32_t bit)
466 {
467     enum ofputil_action_bitmap action = bit;
468
469     switch (action) {
470     case OFPUTIL_A_OUTPUT:         return "OUTPUT";
471     case OFPUTIL_A_SET_VLAN_VID:   return "SET_VLAN_VID";
472     case OFPUTIL_A_SET_VLAN_PCP:   return "SET_VLAN_PCP";
473     case OFPUTIL_A_STRIP_VLAN:     return "STRIP_VLAN";
474     case OFPUTIL_A_SET_DL_SRC:     return "SET_DL_SRC";
475     case OFPUTIL_A_SET_DL_DST:     return "SET_DL_DST";
476     case OFPUTIL_A_SET_NW_SRC:     return "SET_NW_SRC";
477     case OFPUTIL_A_SET_NW_DST:     return "SET_NW_DST";
478     case OFPUTIL_A_SET_NW_ECN:     return "SET_NW_ECN";
479     case OFPUTIL_A_SET_NW_TOS:     return "SET_NW_TOS";
480     case OFPUTIL_A_SET_TP_SRC:     return "SET_TP_SRC";
481     case OFPUTIL_A_SET_TP_DST:     return "SET_TP_DST";
482     case OFPUTIL_A_SET_FIELD:      return "SET_FIELD";
483     case OFPUTIL_A_ENQUEUE:        return "ENQUEUE";
484     case OFPUTIL_A_COPY_TTL_OUT:   return "COPY_TTL_OUT";
485     case OFPUTIL_A_COPY_TTL_IN:    return "COPY_TTL_IN";
486     case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
487     case OFPUTIL_A_SET_MPLS_TC:    return "SET_MPLS_TC";
488     case OFPUTIL_A_SET_MPLS_TTL:   return "SET_MPLS_TTL";
489     case OFPUTIL_A_DEC_MPLS_TTL:   return "DEC_MPLS_TTL";
490     case OFPUTIL_A_PUSH_VLAN:      return "PUSH_VLAN";
491     case OFPUTIL_A_POP_VLAN:       return "POP_VLAN";
492     case OFPUTIL_A_PUSH_MPLS:      return "PUSH_MPLS";
493     case OFPUTIL_A_POP_MPLS:       return "POP_MPLS";
494     case OFPUTIL_A_SET_QUEUE:      return "SET_QUEUE";
495     case OFPUTIL_A_GROUP:          return "GROUP";
496     case OFPUTIL_A_SET_NW_TTL:     return "SET_NW_TTL";
497     case OFPUTIL_A_DEC_NW_TTL:     return "DEC_NW_TTL";
498     }
499
500     return NULL;
501 }
502
503 static void
504 ofp_print_switch_features(struct ds *string, const struct ofp_header *oh)
505 {
506     struct ofputil_switch_features features;
507     enum ofperr error;
508     struct ofpbuf b;
509
510     error = ofputil_decode_switch_features(oh, &features, &b);
511     if (error) {
512         ofp_print_error(string, error);
513         return;
514     }
515
516     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
517
518     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32,
519                   features.n_tables, features.n_buffers);
520     if (features.auxiliary_id) {
521         ds_put_format(string, ", auxiliary_id:%"PRIu8, features.auxiliary_id);
522     }
523     ds_put_char(string, '\n');
524
525     ds_put_cstr(string, "capabilities: ");
526     ofp_print_bit_names(string, features.capabilities,
527                         ofputil_capabilities_to_name, ' ');
528     ds_put_char(string, '\n');
529
530     switch ((enum ofp_version)oh->version) {
531     case OFP10_VERSION:
532         ds_put_cstr(string, "actions: ");
533         ofp_print_bit_names(string, features.actions,
534                             ofputil_action_bitmap_to_name, ' ');
535         ds_put_char(string, '\n');
536         break;
537     case OFP11_VERSION:
538     case OFP12_VERSION:
539         break;
540     case OFP13_VERSION:
541         return; /* no ports in ofp13_switch_features */
542     default:
543         NOT_REACHED();
544     }
545
546     ofp_print_phy_ports(string, oh->version, &b);
547 }
548
549 static void
550 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
551 {
552     enum ofp_config_flags flags;
553
554     flags = ntohs(osc->flags);
555
556     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
557     flags &= ~OFPC_FRAG_MASK;
558
559     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
560         ds_put_format(string, " invalid_ttl_to_controller");
561         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
562     }
563
564     if (flags) {
565         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
566     }
567
568     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
569 }
570
571 static void print_wild(struct ds *string, const char *leader, int is_wild,
572             int verbosity, const char *format, ...)
573             __attribute__((format(printf, 5, 6)));
574
575 static void print_wild(struct ds *string, const char *leader, int is_wild,
576                        int verbosity, const char *format, ...)
577 {
578     if (is_wild && verbosity < 2) {
579         return;
580     }
581     ds_put_cstr(string, leader);
582     if (!is_wild) {
583         va_list args;
584
585         va_start(args, format);
586         ds_put_format_valist(string, format, args);
587         va_end(args);
588     } else {
589         ds_put_char(string, '*');
590     }
591     ds_put_char(string, ',');
592 }
593
594 static void
595 print_wild_port(struct ds *string, const char *leader, int is_wild,
596                 int verbosity, ofp_port_t port)
597 {
598     if (is_wild && verbosity < 2) {
599         return;
600     }
601     ds_put_cstr(string, leader);
602     if (!is_wild) {
603         ofputil_format_port(port, string);
604     } else {
605         ds_put_char(string, '*');
606     }
607     ds_put_char(string, ',');
608 }
609
610 static void
611 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
612                  uint32_t wild_bits, int verbosity)
613 {
614     if (wild_bits >= 32 && verbosity < 2) {
615         return;
616     }
617     ds_put_cstr(string, leader);
618     if (wild_bits < 32) {
619         ds_put_format(string, IP_FMT, IP_ARGS(ip));
620         if (wild_bits) {
621             ds_put_format(string, "/%d", 32 - wild_bits);
622         }
623     } else {
624         ds_put_char(string, '*');
625     }
626     ds_put_char(string, ',');
627 }
628
629 void
630 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
631 {
632     char *s = ofp10_match_to_string(om, verbosity);
633     ds_put_cstr(f, s);
634     free(s);
635 }
636
637 char *
638 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
639 {
640     struct ds f = DS_EMPTY_INITIALIZER;
641     uint32_t w = ntohl(om->wildcards);
642     bool skip_type = false;
643     bool skip_proto = false;
644
645     if (!(w & OFPFW10_DL_TYPE)) {
646         skip_type = true;
647         if (om->dl_type == htons(ETH_TYPE_IP)) {
648             if (!(w & OFPFW10_NW_PROTO)) {
649                 skip_proto = true;
650                 if (om->nw_proto == IPPROTO_ICMP) {
651                     ds_put_cstr(&f, "icmp,");
652                 } else if (om->nw_proto == IPPROTO_TCP) {
653                     ds_put_cstr(&f, "tcp,");
654                 } else if (om->nw_proto == IPPROTO_UDP) {
655                     ds_put_cstr(&f, "udp,");
656                 } else if (om->nw_proto == IPPROTO_SCTP) {
657                     ds_put_cstr(&f, "sctp,");
658                 } else {
659                     ds_put_cstr(&f, "ip,");
660                     skip_proto = false;
661                 }
662             } else {
663                 ds_put_cstr(&f, "ip,");
664             }
665         } else if (om->dl_type == htons(ETH_TYPE_ARP)) {
666             ds_put_cstr(&f, "arp,");
667         } else if (om->dl_type == htons(ETH_TYPE_RARP)){
668             ds_put_cstr(&f, "rarp,");
669         } else if (om->dl_type == htons(ETH_TYPE_MPLS)) {
670             ds_put_cstr(&f, "mpls,");
671         } else if (om->dl_type == htons(ETH_TYPE_MPLS_MCAST)) {
672             ds_put_cstr(&f, "mplsm,");
673         } else {
674             skip_type = false;
675         }
676     }
677     print_wild_port(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
678                     u16_to_ofp(ntohs(om->in_port)));
679     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
680                "%d", ntohs(om->dl_vlan));
681     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
682                "%d", om->dl_vlan_pcp);
683     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
684                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
685     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
686                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
687     if (!skip_type) {
688         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
689                    "0x%04x", ntohs(om->dl_type));
690     }
691     print_ip_netmask(&f, "nw_src=", om->nw_src,
692                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
693                      verbosity);
694     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
695                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
696                      verbosity);
697     if (!skip_proto) {
698         if (om->dl_type == htons(ETH_TYPE_ARP) ||
699             om->dl_type == htons(ETH_TYPE_RARP)) {
700             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
701                        "%u", om->nw_proto);
702         } else {
703             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
704                        "%u", om->nw_proto);
705         }
706     }
707     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
708                "%u", om->nw_tos);
709     if (om->nw_proto == IPPROTO_ICMP) {
710         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
711                    "%d", ntohs(om->tp_src));
712         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
713                    "%d", ntohs(om->tp_dst));
714     } else {
715         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
716                    "%d", ntohs(om->tp_src));
717         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
718                    "%d", ntohs(om->tp_dst));
719     }
720     if (ds_last(&f) == ',') {
721         f.length--;
722     }
723     return ds_cstr(&f);
724 }
725
726 static void
727 ofp_print_flow_flags(struct ds *s, enum ofputil_flow_mod_flags flags)
728 {
729     if (flags & OFPUTIL_FF_SEND_FLOW_REM) {
730         ds_put_cstr(s, "send_flow_rem ");
731     }
732     if (flags & OFPUTIL_FF_CHECK_OVERLAP) {
733         ds_put_cstr(s, "check_overlap ");
734     }
735     if (flags & OFPUTIL_FF_RESET_COUNTS) {
736         ds_put_cstr(s, "reset_counts ");
737     }
738     if (flags & OFPUTIL_FF_NO_PKT_COUNTS) {
739         ds_put_cstr(s, "no_packet_counts ");
740     }
741     if (flags & OFPUTIL_FF_NO_BYT_COUNTS) {
742         ds_put_cstr(s, "no_byte_counts ");
743     }
744 }
745
746 static void
747 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh, int verbosity)
748 {
749     struct ofputil_flow_mod fm;
750     struct ofpbuf ofpacts;
751     bool need_priority;
752     enum ofperr error;
753     enum ofpraw raw;
754     enum ofputil_protocol protocol;
755
756     protocol = ofputil_protocol_from_ofp_version(oh->version);
757     protocol = ofputil_protocol_set_tid(protocol, true);
758
759     ofpbuf_init(&ofpacts, 64);
760     error = ofputil_decode_flow_mod(&fm, oh, protocol, &ofpacts);
761     if (error) {
762         ofpbuf_uninit(&ofpacts);
763         ofp_print_error(s, error);
764         return;
765     }
766
767     ds_put_char(s, ' ');
768     switch (fm.command) {
769     case OFPFC_ADD:
770         ds_put_cstr(s, "ADD");
771         break;
772     case OFPFC_MODIFY:
773         ds_put_cstr(s, "MOD");
774         break;
775     case OFPFC_MODIFY_STRICT:
776         ds_put_cstr(s, "MOD_STRICT");
777         break;
778     case OFPFC_DELETE:
779         ds_put_cstr(s, "DEL");
780         break;
781     case OFPFC_DELETE_STRICT:
782         ds_put_cstr(s, "DEL_STRICT");
783         break;
784     default:
785         ds_put_format(s, "cmd:%d", fm.command);
786     }
787     if (fm.table_id != 0) {
788         ds_put_format(s, " table:%d", fm.table_id);
789     }
790
791     ds_put_char(s, ' ');
792     ofpraw_decode(&raw, oh);
793     if (verbosity >= 3 && raw == OFPRAW_OFPT10_FLOW_MOD) {
794         const struct ofp10_flow_mod *ofm = ofpmsg_body(oh);
795         ofp10_match_print(s, &ofm->match, verbosity);
796
797         /* ofp_print_match() doesn't print priority. */
798         need_priority = true;
799     } else if (verbosity >= 3 && raw == OFPRAW_NXT_FLOW_MOD) {
800         const struct nx_flow_mod *nfm = ofpmsg_body(oh);
801         const void *nxm = nfm + 1;
802         char *nxm_s;
803
804         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
805         ds_put_cstr(s, nxm_s);
806         free(nxm_s);
807
808         /* nx_match_to_string() doesn't print priority. */
809         need_priority = true;
810     } else {
811         match_format(&fm.match, s, fm.priority);
812
813         /* match_format() does print priority. */
814         need_priority = false;
815     }
816
817     if (ds_last(s) != ' ') {
818         ds_put_char(s, ' ');
819     }
820     if (fm.new_cookie != htonll(0) && fm.new_cookie != htonll(UINT64_MAX)) {
821         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
822     }
823     if (fm.cookie_mask != htonll(0)) {
824         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
825                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
826     }
827     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
828         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
829     }
830     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
831         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
832     }
833     if (fm.priority != OFP_DEFAULT_PRIORITY && need_priority) {
834         ds_put_format(s, "pri:%"PRIu16" ", fm.priority);
835     }
836     if (fm.buffer_id != UINT32_MAX) {
837         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
838     }
839     if (fm.out_port != OFPP_ANY) {
840         ds_put_format(s, "out_port:");
841         ofputil_format_port(fm.out_port, s);
842         ds_put_char(s, ' ');
843     }
844
845     if (oh->version == OFP10_VERSION || oh->version == OFP11_VERSION) {
846         /* Don't print the reset_counts flag for OF1.0 and OF1.1 because those
847          * versions don't really have such a flag and printing one is likely to
848          * confuse people. */
849         fm.flags &= ~OFPUTIL_FF_RESET_COUNTS;
850     }
851     ofp_print_flow_flags(s, fm.flags);
852
853     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
854     ofpbuf_uninit(&ofpacts);
855 }
856
857 static void
858 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
859 {
860     ds_put_format(string, "%u", sec);
861     if (nsec > 0) {
862         ds_put_format(string, ".%09u", nsec);
863         while (string->string[string->length - 1] == '0') {
864             string->length--;
865         }
866     }
867     ds_put_char(string, 's');
868 }
869
870 /* Returns a string form of 'reason'.  The return value is either a statically
871  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
872  * 'bufsize' should be at least OFP_FLOW_REMOVED_REASON_BUFSIZE. */
873 #define OFP_FLOW_REMOVED_REASON_BUFSIZE (INT_STRLEN(int) + 1)
874 static const char *
875 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason,
876                                   char *reasonbuf, size_t bufsize)
877 {
878     switch (reason) {
879     case OFPRR_IDLE_TIMEOUT:
880         return "idle";
881     case OFPRR_HARD_TIMEOUT:
882         return "hard";
883     case OFPRR_DELETE:
884         return "delete";
885     case OFPRR_GROUP_DELETE:
886         return "group_delete";
887     case OFPRR_EVICTION:
888         return "eviction";
889     case OFPRR_METER_DELETE:
890         return "meter_delete";
891     default:
892         snprintf(reasonbuf, bufsize, "%d", (int) reason);
893         return reasonbuf;
894     }
895 }
896
897 static void
898 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
899 {
900     char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
901     struct ofputil_flow_removed fr;
902     enum ofperr error;
903
904     error = ofputil_decode_flow_removed(&fr, oh);
905     if (error) {
906         ofp_print_error(string, error);
907         return;
908     }
909
910     ds_put_char(string, ' ');
911     match_format(&fr.match, string, fr.priority);
912
913     ds_put_format(string, " reason=%s",
914                   ofp_flow_removed_reason_to_string(fr.reason, reasonbuf,
915                                                     sizeof reasonbuf));
916
917     if (fr.table_id != 255) {
918         ds_put_format(string, " table_id=%"PRIu8, fr.table_id);
919     }
920
921     if (fr.cookie != htonll(0)) {
922         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
923     }
924     ds_put_cstr(string, " duration");
925     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
926     ds_put_format(string, " idle%"PRIu16, fr.idle_timeout);
927     if (fr.hard_timeout) {
928         /* The hard timeout was only added in OF1.2, so only print it if it is
929          * actually in use to avoid gratuitous change to the formatting. */
930         ds_put_format(string, " hard%"PRIu16, fr.hard_timeout);
931     }
932     ds_put_format(string, " pkts%"PRIu64" bytes%"PRIu64"\n",
933                   fr.packet_count, fr.byte_count);
934 }
935
936 static void
937 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
938 {
939     struct ofputil_port_mod pm;
940     enum ofperr error;
941
942     error = ofputil_decode_port_mod(oh, &pm);
943     if (error) {
944         ofp_print_error(string, error);
945         return;
946     }
947
948     ds_put_cstr(string, "port: ");
949     ofputil_format_port(pm.port_no, string);
950     ds_put_format(string, ": addr:"ETH_ADDR_FMT"\n",
951                   ETH_ADDR_ARGS(pm.hw_addr));
952
953     ds_put_cstr(string, "     config: ");
954     ofp_print_port_config(string, pm.config);
955
956     ds_put_cstr(string, "     mask:   ");
957     ofp_print_port_config(string, pm.mask);
958
959     ds_put_cstr(string, "     advertise: ");
960     if (pm.advertise) {
961         ofp_print_port_features(string, pm.advertise);
962     } else {
963         ds_put_cstr(string, "UNCHANGED\n");
964     }
965 }
966
967 static void
968 ofp_print_meter_flags(struct ds *s, uint16_t flags)
969 {
970     if (flags & OFPMF13_KBPS) {
971         ds_put_cstr(s, "kbps ");
972     }
973     if (flags & OFPMF13_PKTPS) {
974         ds_put_cstr(s, "pktps ");
975     }
976     if (flags & OFPMF13_BURST) {
977         ds_put_cstr(s, "burst ");
978     }
979     if (flags & OFPMF13_STATS) {
980         ds_put_cstr(s, "stats ");
981     }
982
983     flags &= ~(OFPMF13_KBPS | OFPMF13_PKTPS | OFPMF13_BURST | OFPMF13_STATS);
984     if (flags) {
985         ds_put_format(s, "flags:0x%"PRIx16" ", flags);
986     }
987 }
988
989 static void
990 ofp_print_meter_band(struct ds *s, uint16_t flags,
991                      const struct ofputil_meter_band *mb)
992 {
993     ds_put_cstr(s, "\ntype=");
994     switch (mb->type) {
995     case OFPMBT13_DROP:
996         ds_put_cstr(s, "drop");
997         break;
998     case OFPMBT13_DSCP_REMARK:
999         ds_put_cstr(s, "dscp_remark");
1000         break;
1001     default:
1002         ds_put_format(s, "%u", mb->type);
1003     }
1004
1005     ds_put_format(s, " rate=%"PRIu32, mb->rate);
1006
1007     if (flags & OFPMF13_BURST) {
1008         ds_put_format(s, " burst_size=%"PRIu32, mb->burst_size);
1009     }
1010     if (mb->type == OFPMBT13_DSCP_REMARK) {
1011         ds_put_format(s, " prec_level=%"PRIu8, mb->prec_level);
1012     }
1013 }
1014
1015 static void
1016 ofp_print_meter_stats(struct ds *s, const struct ofputil_meter_stats *ms)
1017 {
1018     uint16_t i;
1019
1020     ds_put_format(s, "meter:%"PRIu32" ", ms->meter_id);
1021     ds_put_format(s, "flow_count:%"PRIu32" ", ms->flow_count);
1022     ds_put_format(s, "packet_in_count:%"PRIu64" ", ms->packet_in_count);
1023     ds_put_format(s, "byte_in_count:%"PRIu64" ", ms->byte_in_count);
1024     ds_put_cstr(s, "duration:");
1025     ofp_print_duration(s, ms->duration_sec, ms->duration_nsec);
1026     ds_put_char(s, ' ');
1027
1028     ds_put_cstr(s, "bands:\n");
1029     for (i = 0; i < ms->n_bands; ++i) {
1030         ds_put_format(s, "%d: ", i);
1031         ds_put_format(s, "packet_count:%"PRIu64" ", ms->bands[i].packet_count);
1032         ds_put_format(s, "byte_count:%"PRIu64"\n", ms->bands[i].byte_count);
1033     }
1034 }
1035
1036 static void
1037 ofp_print_meter_config(struct ds *s, const struct ofputil_meter_config *mc)
1038 {
1039     uint16_t i;
1040
1041     ds_put_format(s, "meter=%"PRIu32" ", mc->meter_id);
1042
1043     ofp_print_meter_flags(s, mc->flags);
1044
1045     ds_put_cstr(s, "bands=");
1046     for (i = 0; i < mc->n_bands; ++i) {
1047         ofp_print_meter_band(s, mc->flags, &mc->bands[i]);
1048     }
1049     ds_put_char(s, '\n');
1050 }
1051
1052 static void
1053 ofp_print_meter_mod(struct ds *s, const struct ofp_header *oh)
1054 {
1055     struct ofputil_meter_mod mm;
1056     struct ofpbuf bands;
1057     enum ofperr error;
1058
1059     ofpbuf_init(&bands, 64);
1060     error = ofputil_decode_meter_mod(oh, &mm, &bands);
1061     if (error) {
1062         ofpbuf_uninit(&bands);
1063         ofp_print_error(s, error);
1064         return;
1065     }
1066
1067     switch (mm.command) {
1068     case OFPMC13_ADD:
1069         ds_put_cstr(s, " ADD ");
1070         break;
1071     case OFPMC13_MODIFY:
1072         ds_put_cstr(s, " MOD ");
1073         break;
1074     case OFPMC13_DELETE:
1075         ds_put_cstr(s, " DEL ");
1076         break;
1077     default:
1078         ds_put_format(s, " cmd:%d ", mm.command);
1079     }
1080
1081     ofp_print_meter_config(s, &mm.meter);
1082     ofpbuf_uninit(&bands);
1083 }
1084
1085 static void
1086 ofp_print_meter_stats_request(struct ds *s, const struct ofp_header *oh)
1087 {
1088     uint32_t meter_id;
1089
1090     ofputil_decode_meter_request(oh, &meter_id);
1091
1092     ds_put_format(s, " meter=%"PRIu32, meter_id);
1093 }
1094
1095 static const char *
1096 ofputil_meter_capabilities_to_name(uint32_t bit)
1097 {
1098     enum ofp13_meter_flags flag = bit;
1099
1100     switch (flag) {
1101     case OFPMF13_KBPS:    return "kbps";
1102     case OFPMF13_PKTPS:   return "pktps";
1103     case OFPMF13_BURST:   return "burst";
1104     case OFPMF13_STATS:   return "stats";
1105     }
1106
1107     return NULL;
1108 }
1109
1110 static const char *
1111 ofputil_meter_band_types_to_name(uint32_t bit)
1112 {
1113     switch (bit) {
1114     case 1 << OFPMBT13_DROP:          return "drop";
1115     case 1 << OFPMBT13_DSCP_REMARK:   return "dscp_remark";
1116     }
1117
1118     return NULL;
1119 }
1120
1121 static void
1122 ofp_print_meter_features_reply(struct ds *s, const struct ofp_header *oh)
1123 {
1124     struct ofputil_meter_features mf;
1125
1126     ofputil_decode_meter_features(oh, &mf);
1127
1128     ds_put_format(s, "\nmax_meter:%"PRIu32, mf.max_meters);
1129     ds_put_format(s, " max_bands:%"PRIu8, mf.max_bands);
1130     ds_put_format(s, " max_color:%"PRIu8"\n", mf.max_color);
1131
1132     ds_put_cstr(s, "band_types: ");
1133     ofp_print_bit_names(s, mf.band_types,
1134                         ofputil_meter_band_types_to_name, ' ');
1135     ds_put_char(s, '\n');
1136
1137     ds_put_cstr(s, "capabilities: ");
1138     ofp_print_bit_names(s, mf.capabilities,
1139                         ofputil_meter_capabilities_to_name, ' ');
1140     ds_put_char(s, '\n');
1141 }
1142
1143 static void
1144 ofp_print_meter_config_reply(struct ds *s, const struct ofp_header *oh)
1145 {
1146     struct ofpbuf bands;
1147     struct ofpbuf b;
1148
1149     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1150     ofpbuf_init(&bands, 64);
1151     for (;;) {
1152         struct ofputil_meter_config mc;
1153         int retval;
1154
1155         retval = ofputil_decode_meter_config(&b, &mc, &bands);
1156         if (retval) {
1157             if (retval != EOF) {
1158                 ofp_print_error(s, retval);
1159             }
1160             break;
1161         }
1162         ds_put_char(s, '\n');
1163         ofp_print_meter_config(s, &mc);
1164     }
1165     ofpbuf_uninit(&bands);
1166 }
1167
1168 static void
1169 ofp_print_meter_stats_reply(struct ds *s, const struct ofp_header *oh)
1170 {
1171     struct ofpbuf bands;
1172     struct ofpbuf b;
1173
1174     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1175     ofpbuf_init(&bands, 64);
1176     for (;;) {
1177         struct ofputil_meter_stats ms;
1178         int retval;
1179
1180         retval = ofputil_decode_meter_stats(&b, &ms, &bands);
1181         if (retval) {
1182             if (retval != EOF) {
1183                 ofp_print_error(s, retval);
1184             }
1185             break;
1186         }
1187         ds_put_char(s, '\n');
1188         ofp_print_meter_stats(s, &ms);
1189     }
1190     ofpbuf_uninit(&bands);
1191 }
1192
1193 static void
1194 ofp_print_error(struct ds *string, enum ofperr error)
1195 {
1196     if (string->length) {
1197         ds_put_char(string, ' ');
1198     }
1199     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1200 }
1201
1202 static void
1203 ofp_print_hello(struct ds *string, const struct ofp_header *oh)
1204 {
1205     uint32_t allowed_versions;
1206     bool ok;
1207
1208     ok = ofputil_decode_hello(oh, &allowed_versions);
1209
1210     ds_put_cstr(string, "\n version bitmap: ");
1211     ofputil_format_version_bitmap(string, allowed_versions);
1212
1213     if (!ok) {
1214         ds_put_cstr(string, "\n unknown data in hello:\n");
1215         ds_put_hex_dump(string, oh, ntohs(oh->length), 0, true);
1216     }
1217 }
1218
1219 static void
1220 ofp_print_error_msg(struct ds *string, const struct ofp_header *oh)
1221 {
1222     size_t len = ntohs(oh->length);
1223     struct ofpbuf payload;
1224     enum ofperr error;
1225     char *s;
1226
1227     error = ofperr_decode_msg(oh, &payload);
1228     if (!error) {
1229         ds_put_cstr(string, "***decode error***");
1230         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1231         return;
1232     }
1233
1234     ds_put_format(string, " %s\n", ofperr_get_name(error));
1235
1236     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
1237         ds_put_printable(string, payload.data, payload.size);
1238     } else {
1239         s = ofp_to_string(payload.data, payload.size, 1);
1240         ds_put_cstr(string, s);
1241         free(s);
1242     }
1243 }
1244
1245 static void
1246 ofp_print_port_status(struct ds *string, const struct ofp_header *oh)
1247 {
1248     struct ofputil_port_status ps;
1249     enum ofperr error;
1250
1251     error = ofputil_decode_port_status(oh, &ps);
1252     if (error) {
1253         ofp_print_error(string, error);
1254         return;
1255     }
1256
1257     if (ps.reason == OFPPR_ADD) {
1258         ds_put_format(string, " ADD:");
1259     } else if (ps.reason == OFPPR_DELETE) {
1260         ds_put_format(string, " DEL:");
1261     } else if (ps.reason == OFPPR_MODIFY) {
1262         ds_put_format(string, " MOD:");
1263     }
1264
1265     ofp_print_phy_port(string, &ps.desc);
1266 }
1267
1268 static void
1269 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_header *oh)
1270 {
1271     const struct ofp_desc_stats *ods = ofpmsg_body(oh);
1272
1273     ds_put_char(string, '\n');
1274     ds_put_format(string, "Manufacturer: %.*s\n",
1275             (int) sizeof ods->mfr_desc, ods->mfr_desc);
1276     ds_put_format(string, "Hardware: %.*s\n",
1277             (int) sizeof ods->hw_desc, ods->hw_desc);
1278     ds_put_format(string, "Software: %.*s\n",
1279             (int) sizeof ods->sw_desc, ods->sw_desc);
1280     ds_put_format(string, "Serial Num: %.*s\n",
1281             (int) sizeof ods->serial_num, ods->serial_num);
1282     ds_put_format(string, "DP Description: %.*s\n",
1283             (int) sizeof ods->dp_desc, ods->dp_desc);
1284 }
1285
1286 static void
1287 ofp_print_flow_stats_request(struct ds *string, const struct ofp_header *oh)
1288 {
1289     struct ofputil_flow_stats_request fsr;
1290     enum ofperr error;
1291
1292     error = ofputil_decode_flow_stats_request(&fsr, oh);
1293     if (error) {
1294         ofp_print_error(string, error);
1295         return;
1296     }
1297
1298     if (fsr.table_id != 0xff) {
1299         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
1300     }
1301
1302     if (fsr.out_port != OFPP_ANY) {
1303         ds_put_cstr(string, " out_port=");
1304         ofputil_format_port(fsr.out_port, string);
1305     }
1306
1307     ds_put_char(string, ' ');
1308     match_format(&fsr.match, string, OFP_DEFAULT_PRIORITY);
1309 }
1310
1311 void
1312 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
1313 {
1314     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
1315                   ntohll(fs->cookie));
1316
1317     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
1318     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
1319     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
1320     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
1321     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
1322         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
1323     }
1324     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
1325         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
1326     }
1327     if (fs->flags) {
1328         ofp_print_flow_flags(string, fs->flags);
1329     }
1330     if (fs->idle_age >= 0) {
1331         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
1332     }
1333     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1334         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1335     }
1336
1337     match_format(&fs->match, string, fs->priority);
1338     if (string->string[string->length - 1] != ' ') {
1339         ds_put_char(string, ' ');
1340     }
1341
1342     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1343 }
1344
1345 static void
1346 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1347 {
1348     struct ofpbuf ofpacts;
1349     struct ofpbuf b;
1350
1351     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1352     ofpbuf_init(&ofpacts, 64);
1353     for (;;) {
1354         struct ofputil_flow_stats fs;
1355         int retval;
1356
1357         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1358         if (retval) {
1359             if (retval != EOF) {
1360                 ds_put_cstr(string, " ***parse error***");
1361             }
1362             break;
1363         }
1364         ds_put_char(string, '\n');
1365         ofp_print_flow_stats(string, &fs);
1366      }
1367     ofpbuf_uninit(&ofpacts);
1368 }
1369
1370 static void
1371 ofp_print_aggregate_stats_reply(struct ds *string, const struct ofp_header *oh)
1372 {
1373     struct ofputil_aggregate_stats as;
1374     enum ofperr error;
1375
1376     error = ofputil_decode_aggregate_stats_reply(&as, oh);
1377     if (error) {
1378         ofp_print_error(string, error);
1379         return;
1380     }
1381
1382     ds_put_format(string, " packet_count=%"PRIu64, as.packet_count);
1383     ds_put_format(string, " byte_count=%"PRIu64, as.byte_count);
1384     ds_put_format(string, " flow_count=%"PRIu32, as.flow_count);
1385 }
1386
1387 static void
1388 print_port_stat(struct ds *string, const char *leader, uint64_t stat, int more)
1389 {
1390     ds_put_cstr(string, leader);
1391     if (stat != UINT64_MAX) {
1392         ds_put_format(string, "%"PRIu64, stat);
1393     } else {
1394         ds_put_char(string, '?');
1395     }
1396     if (more) {
1397         ds_put_cstr(string, ", ");
1398     } else {
1399         ds_put_cstr(string, "\n");
1400     }
1401 }
1402
1403 static void
1404 ofp_print_ofpst_port_request(struct ds *string, const struct ofp_header *oh)
1405 {
1406     ofp_port_t ofp10_port;
1407     enum ofperr error;
1408
1409     error = ofputil_decode_port_stats_request(oh, &ofp10_port);
1410     if (error) {
1411         ofp_print_error(string, error);
1412         return;
1413     }
1414
1415     ds_put_cstr(string, " port_no=");
1416     ofputil_format_port(ofp10_port, string);
1417 }
1418
1419 static void
1420 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1421                            int verbosity)
1422 {
1423     struct ofpbuf b;
1424
1425     ds_put_format(string, " %zu ports\n", ofputil_count_port_stats(oh));
1426     if (verbosity < 1) {
1427         return;
1428     }
1429
1430     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1431     for (;;) {
1432         struct ofputil_port_stats ps;
1433         int retval;
1434
1435         retval = ofputil_decode_port_stats(&ps, &b);
1436         if (retval) {
1437             if (retval != EOF) {
1438                 ds_put_cstr(string, " ***parse error***");
1439             }
1440             return;
1441         }
1442
1443         ds_put_cstr(string, "  port ");
1444         if (ofp_to_u16(ps.port_no) < 10) {
1445             ds_put_char(string, ' ');
1446         }
1447         ofputil_format_port(ps.port_no, string);
1448
1449         ds_put_cstr(string, ": rx ");
1450         print_port_stat(string, "pkts=", ps.stats.rx_packets, 1);
1451         print_port_stat(string, "bytes=", ps.stats.rx_bytes, 1);
1452         print_port_stat(string, "drop=", ps.stats.rx_dropped, 1);
1453         print_port_stat(string, "errs=", ps.stats.rx_errors, 1);
1454         print_port_stat(string, "frame=", ps.stats.rx_frame_errors, 1);
1455         print_port_stat(string, "over=", ps.stats.rx_over_errors, 1);
1456         print_port_stat(string, "crc=", ps.stats.rx_crc_errors, 0);
1457
1458         ds_put_cstr(string, "           tx ");
1459         print_port_stat(string, "pkts=", ps.stats.tx_packets, 1);
1460         print_port_stat(string, "bytes=", ps.stats.tx_bytes, 1);
1461         print_port_stat(string, "drop=", ps.stats.tx_dropped, 1);
1462         print_port_stat(string, "errs=", ps.stats.tx_errors, 1);
1463         print_port_stat(string, "coll=", ps.stats.collisions, 0);
1464
1465         if (ps.duration_sec != UINT32_MAX) {
1466             ds_put_cstr(string, "           duration=");
1467             ofp_print_duration(string, ps.duration_sec, ps.duration_nsec);
1468             ds_put_char(string, '\n');
1469         }
1470     }
1471 }
1472
1473 static void
1474 ofp_print_one_ofpst_table_reply(struct ds *string, enum ofp_version ofp_version,
1475                                 const char *name, struct ofp12_table_stats *ts)
1476 {
1477     char name_[OFP_MAX_TABLE_NAME_LEN + 1];
1478
1479     /* ofp13_table_stats is different */
1480     if (ofp_version > OFP12_VERSION) {
1481         return;
1482     }
1483
1484     ovs_strlcpy(name_, name, sizeof name_);
1485
1486     ds_put_format(string, "  %d: %-8s: ", ts->table_id, name_);
1487     ds_put_format(string, "wild=0x%05"PRIx64", ", ntohll(ts->wildcards));
1488     ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1489     ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1490     ds_put_cstr(string, "               ");
1491     ds_put_format(string, "lookup=%"PRIu64", ", ntohll(ts->lookup_count));
1492     ds_put_format(string, "matched=%"PRIu64"\n", ntohll(ts->matched_count));
1493
1494     if (ofp_version < OFP11_VERSION) {
1495         return;
1496     }
1497
1498     ds_put_cstr(string, "               ");
1499     ds_put_format(string, "match=0x%08"PRIx64", ", ntohll(ts->match));
1500     ds_put_format(string, "instructions=0x%08"PRIx32", ",
1501                   ntohl(ts->instructions));
1502     ds_put_format(string, "config=0x%08"PRIx32"\n", ntohl(ts->config));
1503     ds_put_cstr(string, "               ");
1504     ds_put_format(string, "write_actions=0x%08"PRIx32", ",
1505                   ntohl(ts->write_actions));
1506     ds_put_format(string, "apply_actions=0x%08"PRIx32"\n",
1507                   ntohl(ts->apply_actions));
1508
1509     if (ofp_version < OFP12_VERSION) {
1510         return;
1511     }
1512
1513     ds_put_cstr(string, "               ");
1514     ds_put_format(string, "write_setfields=0x%016"PRIx64"\n",
1515                   ntohll(ts->write_setfields));
1516     ds_put_cstr(string, "               ");
1517     ds_put_format(string, "apply_setfields=0x%016"PRIx64"\n",
1518                   ntohll(ts->apply_setfields));
1519     ds_put_cstr(string, "               ");
1520     ds_put_format(string, "metadata_match=0x%016"PRIx64"\n",
1521                   ntohll(ts->metadata_match));
1522     ds_put_cstr(string, "               ");
1523     ds_put_format(string, "metadata_write=0x%016"PRIx64"\n",
1524                   ntohll(ts->metadata_write));
1525 }
1526
1527 static void
1528 ofp_print_ofpst_table_reply13(struct ds *string, const struct ofp_header *oh,
1529                               int verbosity)
1530 {
1531     struct ofp13_table_stats *ts;
1532     struct ofpbuf b;
1533     size_t n;
1534
1535     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1536     ofpraw_pull_assert(&b);
1537
1538     n = b.size / sizeof *ts;
1539     ds_put_format(string, " %zu tables\n", n);
1540     if (verbosity < 1) {
1541         return;
1542     }
1543
1544     for (;;) {
1545         ts = ofpbuf_try_pull(&b, sizeof *ts);
1546         if (!ts) {
1547             return;
1548         }
1549         ds_put_format(string,
1550                       "  %d: active=%"PRIu32", lookup=%"PRIu64  \
1551                       ", matched=%"PRIu64"\n",
1552                       ts->table_id, ntohl(ts->active_count),
1553                       ntohll(ts->lookup_count), ntohll(ts->matched_count));
1554     }
1555 }
1556
1557 static void
1558 ofp_print_ofpst_table_reply12(struct ds *string, const struct ofp_header *oh,
1559                               int verbosity)
1560 {
1561     struct ofp12_table_stats *ts;
1562     struct ofpbuf b;
1563     size_t n;
1564
1565     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1566     ofpraw_pull_assert(&b);
1567
1568     n = b.size / sizeof *ts;
1569     ds_put_format(string, " %zu tables\n", n);
1570     if (verbosity < 1) {
1571         return;
1572     }
1573
1574     for (;;) {
1575         ts = ofpbuf_try_pull(&b, sizeof *ts);
1576         if (!ts) {
1577             return;
1578         }
1579
1580         ofp_print_one_ofpst_table_reply(string, OFP12_VERSION, ts->name, ts);
1581      }
1582 }
1583
1584 static void
1585 ofp_print_ofpst_table_reply11(struct ds *string, const struct ofp_header *oh,
1586                               int verbosity)
1587 {
1588     struct ofp11_table_stats *ts;
1589     struct ofpbuf b;
1590     size_t n;
1591
1592     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1593     ofpraw_pull_assert(&b);
1594
1595     n = b.size / sizeof *ts;
1596     ds_put_format(string, " %zu tables\n", n);
1597     if (verbosity < 1) {
1598         return;
1599     }
1600
1601     for (;;) {
1602         struct ofp12_table_stats ts12;
1603
1604         ts = ofpbuf_try_pull(&b, sizeof *ts);
1605         if (!ts) {
1606             return;
1607         }
1608
1609         ts12.table_id = ts->table_id;
1610         ts12.wildcards = htonll(ntohl(ts->wildcards));
1611         ts12.max_entries = ts->max_entries;
1612         ts12.active_count = ts->active_count;
1613         ts12.lookup_count = ts->lookup_count;
1614         ts12.matched_count = ts->matched_count;
1615         ts12.match = htonll(ntohl(ts->match));
1616         ts12.instructions = ts->instructions;
1617         ts12.config = ts->config;
1618         ts12.write_actions = ts->write_actions;
1619         ts12.apply_actions = ts->apply_actions;
1620         ofp_print_one_ofpst_table_reply(string, OFP11_VERSION, ts->name, &ts12);
1621      }
1622 }
1623
1624 static void
1625 ofp_print_ofpst_table_reply10(struct ds *string, const struct ofp_header *oh,
1626                               int verbosity)
1627 {
1628     struct ofp10_table_stats *ts;
1629     struct ofpbuf b;
1630     size_t n;
1631
1632     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1633     ofpraw_pull_assert(&b);
1634
1635     n = b.size / sizeof *ts;
1636     ds_put_format(string, " %zu tables\n", n);
1637     if (verbosity < 1) {
1638         return;
1639     }
1640
1641     for (;;) {
1642         struct ofp12_table_stats ts12;
1643
1644         ts = ofpbuf_try_pull(&b, sizeof *ts);
1645         if (!ts) {
1646             return;
1647         }
1648
1649         ts12.table_id = ts->table_id;
1650         ts12.wildcards = htonll(ntohl(ts->wildcards));
1651         ts12.max_entries = ts->max_entries;
1652         ts12.active_count = ts->active_count;
1653         ts12.lookup_count = get_32aligned_be64(&ts->lookup_count);
1654         ts12.matched_count = get_32aligned_be64(&ts->matched_count);
1655         ofp_print_one_ofpst_table_reply(string, OFP10_VERSION, ts->name, &ts12);
1656      }
1657 }
1658
1659 static void
1660 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1661                             int verbosity)
1662 {
1663     switch ((enum ofp_version)oh->version) {
1664     case OFP13_VERSION:
1665         ofp_print_ofpst_table_reply13(string, oh, verbosity);
1666         break;
1667
1668     case OFP12_VERSION:
1669         ofp_print_ofpst_table_reply12(string, oh, verbosity);
1670         break;
1671
1672     case OFP11_VERSION:
1673         ofp_print_ofpst_table_reply11(string, oh, verbosity);
1674         break;
1675
1676     case OFP10_VERSION:
1677         ofp_print_ofpst_table_reply10(string, oh, verbosity);
1678         break;
1679
1680     default:
1681         NOT_REACHED();
1682     }
1683 }
1684
1685 static void
1686 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1687 {
1688     if (queue_id == OFPQ_ALL) {
1689         ds_put_cstr(string, "ALL");
1690     } else {
1691         ds_put_format(string, "%"PRIu32, queue_id);
1692     }
1693 }
1694
1695 static void
1696 ofp_print_ofpst_queue_request(struct ds *string, const struct ofp_header *oh)
1697 {
1698     struct ofputil_queue_stats_request oqsr;
1699     enum ofperr error;
1700
1701     error = ofputil_decode_queue_stats_request(oh, &oqsr);
1702     if (error) {
1703         ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
1704         return;
1705     }
1706
1707     ds_put_cstr(string, "port=");
1708     ofputil_format_port(oqsr.port_no, string);
1709
1710     ds_put_cstr(string, " queue=");
1711     ofp_print_queue_name(string, oqsr.queue_id);
1712 }
1713
1714 static void
1715 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1716                             int verbosity)
1717 {
1718     struct ofpbuf b;
1719
1720     ds_put_format(string, " %zu queues\n", ofputil_count_queue_stats(oh));
1721     if (verbosity < 1) {
1722         return;
1723     }
1724
1725     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1726     for (;;) {
1727         struct ofputil_queue_stats qs;
1728         int retval;
1729
1730         retval = ofputil_decode_queue_stats(&qs, &b);
1731         if (retval) {
1732             if (retval != EOF) {
1733                 ds_put_cstr(string, " ***parse error***");
1734             }
1735             return;
1736         }
1737
1738         ds_put_cstr(string, "  port ");
1739         ofputil_format_port(qs.port_no, string);
1740         ds_put_cstr(string, " queue ");
1741         ofp_print_queue_name(string, qs.queue_id);
1742         ds_put_cstr(string, ": ");
1743
1744         print_port_stat(string, "bytes=", qs.tx_bytes, 1);
1745         print_port_stat(string, "pkts=", qs.tx_packets, 1);
1746         print_port_stat(string, "errors=", qs.tx_errors, 1);
1747
1748         ds_put_cstr(string, "duration=");
1749         if (qs.duration_sec != UINT32_MAX) {
1750             ofp_print_duration(string, qs.duration_sec, qs.duration_nsec);
1751         } else {
1752             ds_put_char(string, '?');
1753         }
1754         ds_put_char(string, '\n');
1755     }
1756 }
1757
1758 static void
1759 ofp_print_ofpst_port_desc_reply(struct ds *string,
1760                                 const struct ofp_header *oh)
1761 {
1762     struct ofpbuf b;
1763
1764     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1765     ofpraw_pull_assert(&b);
1766     ds_put_char(string, '\n');
1767     ofp_print_phy_ports(string, oh->version, &b);
1768 }
1769
1770 static void
1771 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1772 {
1773     uint16_t flags = ofpmp_flags(oh);
1774
1775     if (flags) {
1776         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
1777     }
1778 }
1779
1780 static void
1781 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1782 {
1783     uint16_t flags = ofpmp_flags(oh);
1784
1785     if (flags) {
1786         ds_put_cstr(string, " flags=");
1787         if (flags & OFPSF_REPLY_MORE) {
1788             ds_put_cstr(string, "[more]");
1789             flags &= ~OFPSF_REPLY_MORE;
1790         }
1791         if (flags) {
1792             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1793                           flags);
1794         }
1795     }
1796 }
1797
1798 static void
1799 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1800 {
1801     size_t len = ntohs(oh->length);
1802
1803     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1804     if (verbosity > 1) {
1805         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1806     }
1807 }
1808
1809 static void
1810 ofp_print_role_message(struct ds *string, const struct ofp_header *oh)
1811 {
1812     struct ofputil_role_request rr;
1813     enum ofperr error;
1814
1815     error = ofputil_decode_role_message(oh, &rr);
1816     if (error) {
1817         ofp_print_error(string, error);
1818         return;
1819     }
1820
1821     ds_put_cstr(string, " role=");
1822
1823     switch (rr.role) {
1824     case OFPCR12_ROLE_NOCHANGE:
1825         ds_put_cstr(string, "nochange");
1826         break;
1827     case OFPCR12_ROLE_EQUAL:
1828         ds_put_cstr(string, "equal"); /* OF 1.2 wording */
1829         break;
1830     case OFPCR12_ROLE_MASTER:
1831         ds_put_cstr(string, "master");
1832         break;
1833     case OFPCR12_ROLE_SLAVE:
1834         ds_put_cstr(string, "slave");
1835         break;
1836     default:
1837         NOT_REACHED();
1838     }
1839
1840     if (rr.have_generation_id) {
1841         ds_put_format(string, " generation_id=%"PRIu64, rr.generation_id);
1842     }
1843 }
1844
1845 static void
1846 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1847                                 const struct nx_flow_mod_table_id *nfmti)
1848 {
1849     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1850 }
1851
1852 static void
1853 ofp_print_nxt_set_flow_format(struct ds *string,
1854                               const struct nx_set_flow_format *nsff)
1855 {
1856     uint32_t format = ntohl(nsff->format);
1857
1858     ds_put_cstr(string, " format=");
1859     if (ofputil_nx_flow_format_is_valid(format)) {
1860         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1861     } else {
1862         ds_put_format(string, "%"PRIu32, format);
1863     }
1864 }
1865
1866 static void
1867 ofp_print_nxt_set_packet_in_format(struct ds *string,
1868                                    const struct nx_set_packet_in_format *nspf)
1869 {
1870     uint32_t format = ntohl(nspf->format);
1871
1872     ds_put_cstr(string, " format=");
1873     if (ofputil_packet_in_format_is_valid(format)) {
1874         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1875     } else {
1876         ds_put_format(string, "%"PRIu32, format);
1877     }
1878 }
1879
1880 /* Returns a string form of 'reason'.  The return value is either a statically
1881  * allocated constant string or the 'bufsize'-byte buffer 'reasonbuf'.
1882  * 'bufsize' should be at least OFP_PORT_REASON_BUFSIZE. */
1883 #define OFP_PORT_REASON_BUFSIZE (INT_STRLEN(int) + 1)
1884 static const char *
1885 ofp_port_reason_to_string(enum ofp_port_reason reason,
1886                           char *reasonbuf, size_t bufsize)
1887 {
1888     switch (reason) {
1889     case OFPPR_ADD:
1890         return "add";
1891
1892     case OFPPR_DELETE:
1893         return "delete";
1894
1895     case OFPPR_MODIFY:
1896         return "modify";
1897
1898     default:
1899         snprintf(reasonbuf, bufsize, "%d", (int) reason);
1900         return reasonbuf;
1901     }
1902 }
1903
1904 static void
1905 ofp_print_nxt_set_async_config(struct ds *string,
1906                                const struct nx_async_config *nac)
1907 {
1908     int i;
1909
1910     for (i = 0; i < 2; i++) {
1911         int j;
1912
1913         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1914
1915         ds_put_cstr(string, "       PACKET_IN:");
1916         for (j = 0; j < 32; j++) {
1917             if (nac->packet_in_mask[i] & htonl(1u << j)) {
1918                 char reasonbuf[OFPUTIL_PACKET_IN_REASON_BUFSIZE];
1919                 const char *reason;
1920
1921                 reason = ofputil_packet_in_reason_to_string(j, reasonbuf,
1922                                                             sizeof reasonbuf);
1923                 ds_put_format(string, " %s", reason);
1924             }
1925         }
1926         if (!nac->packet_in_mask[i]) {
1927             ds_put_cstr(string, " (off)");
1928         }
1929         ds_put_char(string, '\n');
1930
1931         ds_put_cstr(string, "     PORT_STATUS:");
1932         for (j = 0; j < 32; j++) {
1933             if (nac->port_status_mask[i] & htonl(1u << j)) {
1934                 char reasonbuf[OFP_PORT_REASON_BUFSIZE];
1935                 const char *reason;
1936
1937                 reason = ofp_port_reason_to_string(j, reasonbuf,
1938                                                    sizeof reasonbuf);
1939                 ds_put_format(string, " %s", reason);
1940             }
1941         }
1942         if (!nac->port_status_mask[i]) {
1943             ds_put_cstr(string, " (off)");
1944         }
1945         ds_put_char(string, '\n');
1946
1947         ds_put_cstr(string, "    FLOW_REMOVED:");
1948         for (j = 0; j < 32; j++) {
1949             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1950                 char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
1951                 const char *reason;
1952
1953                 reason = ofp_flow_removed_reason_to_string(j, reasonbuf,
1954                                                            sizeof reasonbuf);
1955                 ds_put_format(string, " %s", reason);
1956             }
1957         }
1958         if (!nac->flow_removed_mask[i]) {
1959             ds_put_cstr(string, " (off)");
1960         }
1961         ds_put_char(string, '\n');
1962     }
1963 }
1964
1965 static void
1966 ofp_print_nxt_set_controller_id(struct ds *string,
1967                                 const struct nx_controller_id *nci)
1968 {
1969     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1970 }
1971
1972 static void
1973 ofp_print_nxt_flow_monitor_cancel(struct ds *string,
1974                                   const struct ofp_header *oh)
1975 {
1976     ds_put_format(string, " id=%"PRIu32,
1977                   ofputil_decode_flow_monitor_cancel(oh));
1978 }
1979
1980 static const char *
1981 nx_flow_monitor_flags_to_name(uint32_t bit)
1982 {
1983     enum nx_flow_monitor_flags fmf = bit;
1984
1985     switch (fmf) {
1986     case NXFMF_INITIAL: return "initial";
1987     case NXFMF_ADD: return "add";
1988     case NXFMF_DELETE: return "delete";
1989     case NXFMF_MODIFY: return "modify";
1990     case NXFMF_ACTIONS: return "actions";
1991     case NXFMF_OWN: return "own";
1992     }
1993
1994     return NULL;
1995 }
1996
1997 static void
1998 ofp_print_nxst_flow_monitor_request(struct ds *string,
1999                                     const struct ofp_header *oh)
2000 {
2001     struct ofpbuf b;
2002
2003     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2004     for (;;) {
2005         struct ofputil_flow_monitor_request request;
2006         int retval;
2007
2008         retval = ofputil_decode_flow_monitor_request(&request, &b);
2009         if (retval) {
2010             if (retval != EOF) {
2011                 ofp_print_error(string, retval);
2012             }
2013             return;
2014         }
2015
2016         ds_put_format(string, "\n id=%"PRIu32" flags=", request.id);
2017         ofp_print_bit_names(string, request.flags,
2018                             nx_flow_monitor_flags_to_name, ',');
2019
2020         if (request.out_port != OFPP_NONE) {
2021             ds_put_cstr(string, " out_port=");
2022             ofputil_format_port(request.out_port, string);
2023         }
2024
2025         if (request.table_id != 0xff) {
2026             ds_put_format(string, " table=%"PRIu8, request.table_id);
2027         }
2028
2029         ds_put_char(string, ' ');
2030         match_format(&request.match, string, OFP_DEFAULT_PRIORITY);
2031         ds_chomp(string, ' ');
2032     }
2033 }
2034
2035 static void
2036 ofp_print_nxst_flow_monitor_reply(struct ds *string,
2037                                   const struct ofp_header *oh)
2038 {
2039     uint64_t ofpacts_stub[1024 / 8];
2040     struct ofpbuf ofpacts;
2041     struct ofpbuf b;
2042
2043     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2044     ofpbuf_use_stub(&ofpacts, ofpacts_stub, sizeof ofpacts_stub);
2045     for (;;) {
2046         char reasonbuf[OFP_FLOW_REMOVED_REASON_BUFSIZE];
2047         struct ofputil_flow_update update;
2048         struct match match;
2049         int retval;
2050
2051         update.match = &match;
2052         retval = ofputil_decode_flow_update(&update, &b, &ofpacts);
2053         if (retval) {
2054             if (retval != EOF) {
2055                 ofp_print_error(string, retval);
2056             }
2057             ofpbuf_uninit(&ofpacts);
2058             return;
2059         }
2060
2061         ds_put_cstr(string, "\n event=");
2062         switch (update.event) {
2063         case NXFME_ADDED:
2064             ds_put_cstr(string, "ADDED");
2065             break;
2066
2067         case NXFME_DELETED:
2068             ds_put_format(string, "DELETED reason=%s",
2069                           ofp_flow_removed_reason_to_string(update.reason,
2070                                                             reasonbuf,
2071                                                             sizeof reasonbuf));
2072             break;
2073
2074         case NXFME_MODIFIED:
2075             ds_put_cstr(string, "MODIFIED");
2076             break;
2077
2078         case NXFME_ABBREV:
2079             ds_put_format(string, "ABBREV xid=0x%"PRIx32, ntohl(update.xid));
2080             continue;
2081         }
2082
2083         ds_put_format(string, " table=%"PRIu8, update.table_id);
2084         if (update.idle_timeout != OFP_FLOW_PERMANENT) {
2085             ds_put_format(string, " idle_timeout=%"PRIu16,
2086                           update.idle_timeout);
2087         }
2088         if (update.hard_timeout != OFP_FLOW_PERMANENT) {
2089             ds_put_format(string, " hard_timeout=%"PRIu16,
2090                           update.hard_timeout);
2091         }
2092         ds_put_format(string, " cookie=%#"PRIx64, ntohll(update.cookie));
2093
2094         ds_put_char(string, ' ');
2095         match_format(update.match, string, OFP_DEFAULT_PRIORITY);
2096
2097         if (update.ofpacts_len) {
2098             if (string->string[string->length - 1] != ' ') {
2099                 ds_put_char(string, ' ');
2100             }
2101             ofpacts_format(update.ofpacts, update.ofpacts_len, string);
2102         }
2103     }
2104 }
2105
2106 void
2107 ofp_print_version(const struct ofp_header *oh,
2108                   struct ds *string)
2109 {
2110     switch (oh->version) {
2111     case OFP10_VERSION:
2112         break;
2113     case OFP11_VERSION:
2114         ds_put_cstr(string, " (OF1.1)");
2115         break;
2116     case OFP12_VERSION:
2117         ds_put_cstr(string, " (OF1.2)");
2118         break;
2119     case OFP13_VERSION:
2120         ds_put_cstr(string, " (OF1.3)");
2121         break;
2122     default:
2123         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
2124         break;
2125     }
2126     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
2127 }
2128
2129 static void
2130 ofp_header_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2131                        struct ds *string)
2132 {
2133     ds_put_cstr(string, ofpraw_get_name(raw));
2134     ofp_print_version(oh, string);
2135 }
2136
2137 static void
2138 ofp_print_not_implemented(struct ds *string)
2139 {
2140     ds_put_cstr(string, "NOT IMPLEMENTED YET!\n");
2141 }
2142
2143 static void
2144 ofp_print_group(struct ds *s, uint32_t group_id, uint8_t type,
2145                 struct list *p_buckets)
2146 {
2147     static const char *type_str[] = { "all", "select", "indirect",
2148                                       "ff", "unknown" };
2149     struct ofputil_bucket *bucket;
2150
2151     ds_put_format(s, "group_id=%"PRIu32",type=%s",
2152                   group_id, type_str[type > 4 ? 4 : type]);
2153     if (!p_buckets) {
2154         return;
2155     }
2156
2157     LIST_FOR_EACH (bucket, list_node, p_buckets) {
2158         ds_put_cstr(s, ",bucket=");
2159
2160         if (bucket->weight != 1) {
2161             ds_put_format(s, "weight:%"PRIu16",", bucket->weight);
2162         }
2163         if (bucket->watch_port != OFPP_NONE) {
2164             ds_put_format(s, "watch_port:%"PRIu32",", bucket->watch_port);
2165         }
2166         if (bucket->watch_group != OFPG11_ANY) {
2167             ds_put_format(s, "watch_group:%"PRIu32",", bucket->watch_group);
2168         }
2169
2170         ofpacts_format(bucket->ofpacts, bucket->ofpacts_len, s);
2171     }
2172 }
2173
2174 static void
2175 ofp_print_group_desc(struct ds *s, const struct ofp_header *oh)
2176 {
2177     struct ofpbuf b;
2178
2179     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2180     for (;;) {
2181         struct ofputil_group_desc gd;
2182         int retval;
2183
2184         retval = ofputil_decode_group_desc_reply(&gd, &b);
2185         if (retval) {
2186             if (retval != EOF) {
2187                 ds_put_cstr(s, " ***parse error***");
2188             }
2189             break;
2190         }
2191
2192         ds_put_char(s, '\n');
2193         ds_put_char(s, ' ');
2194         ofp_print_group(s, gd.group_id, gd.type, &gd.buckets);
2195      }
2196 }
2197
2198 static void
2199 ofp_print_ofpst_group_request(struct ds *string, const struct ofp_header *oh)
2200 {
2201     enum ofperr error;
2202     uint32_t group_id;
2203
2204     error = ofputil_decode_group_stats_request(oh, &group_id);
2205     if (error) {
2206         ofp_print_error(string, error);
2207         return;
2208     }
2209
2210     ds_put_cstr(string, " group_id=");
2211     ofputil_format_group(group_id, string);
2212 }
2213
2214 static void
2215 ofp_print_group_stats(struct ds *s, const struct ofp_header *oh)
2216 {
2217     struct ofpbuf b;
2218     uint32_t bucket_i;
2219
2220     ofpbuf_use_const(&b, oh, ntohs(oh->length));
2221
2222     for (;;) {
2223         struct ofputil_group_stats gs;
2224         int retval;
2225
2226         retval = ofputil_decode_group_stats_reply(&b, &gs);
2227         if (retval) {
2228             if (retval != EOF) {
2229                 ds_put_cstr(s, " ***parse error***");
2230             }
2231             break;
2232         }
2233
2234         ds_put_char(s, '\n');
2235
2236         ds_put_char(s, ' ');
2237         ds_put_format(s, "group_id=%"PRIu32",", gs.group_id);
2238
2239         if (gs.duration_sec != UINT32_MAX) {
2240             ds_put_cstr(s, "duration=");
2241             ofp_print_duration(s, gs.duration_sec, gs.duration_nsec);
2242             ds_put_char(s, ',');
2243         }
2244         ds_put_format(s, "ref_count=%"PRIu32",", gs.ref_count);
2245         ds_put_format(s, "packet_count=%"PRIu64",", gs.packet_count);
2246         ds_put_format(s, "byte_count=%"PRIu64"", gs.byte_count);
2247
2248         for (bucket_i = 0; bucket_i < gs.n_buckets; bucket_i++) {
2249             if (gs.bucket_stats[bucket_i].packet_count != UINT64_MAX) {
2250                 ds_put_format(s, ",bucket%"PRIu32":", bucket_i);
2251                 ds_put_format(s, "packet_count=%"PRIu64",", gs.bucket_stats[bucket_i].packet_count);
2252                 ds_put_format(s, "byte_count=%"PRIu64"", gs.bucket_stats[bucket_i].byte_count);
2253             }
2254         }
2255
2256         free(gs.bucket_stats);
2257      }
2258 }
2259
2260 static void
2261 ofp_print_group_features(struct ds *string, const struct ofp_header *oh)
2262 {
2263     struct ofputil_group_features features;
2264
2265     ofputil_decode_group_features_reply(oh, &features);
2266
2267     ds_put_format(string, "\n Group table:\n");
2268     ds_put_format(string, "    Types:  0x%"PRIx32"\n", features.types);
2269     ds_put_format(string, "    Capabilities:  0x%"PRIx32"\n",
2270                   features.capabilities);
2271
2272     if (features.types & (1u << OFPGT11_ALL)) {
2273         ds_put_format(string, "    All group :\n");
2274         ds_put_format(string,
2275                       "        max_groups = %#"PRIx32" actions=0x%08"PRIx32"\n",
2276                       features.max_groups[0], features.actions[0]);
2277     }
2278
2279     if (features.types & (1u << OFPGT11_SELECT)) {
2280         ds_put_format(string, "    Select group :\n");
2281         ds_put_format(string, "        max_groups = %#"PRIx32" "
2282                       "actions=0x%08"PRIx32"\n",
2283                       features.max_groups[1], features.actions[1]);
2284     }
2285
2286     if (features.types & (1u << OFPGT11_INDIRECT)) {
2287         ds_put_format(string, "    Indirect group :\n");
2288         ds_put_format(string, "        max_groups = %#"PRIx32" "
2289                       "actions=0x%08"PRIx32"\n",
2290                       features.max_groups[2], features.actions[2]);
2291     }
2292
2293     if (features.types & (1u << OFPGT11_FF)) {
2294         ds_put_format(string, "    Fast Failover group :\n");
2295         ds_put_format(string, "        max_groups = %#"PRIx32" "
2296                       "actions=0x%08"PRIx32"\n",
2297                       features.max_groups[3], features.actions[3]);
2298     }
2299 }
2300
2301 static void
2302 ofp_print_group_mod(struct ds *s, const struct ofp_header *oh)
2303 {
2304     struct ofputil_group_mod gm;
2305     int error;
2306
2307     error = ofputil_decode_group_mod(oh, &gm);
2308     if (error) {
2309         ofp_print_error(s, error);
2310         return;
2311     }
2312
2313     ds_put_char(s, '\n');
2314
2315     ds_put_char(s, ' ');
2316     switch (gm.command) {
2317     case OFPGC11_ADD:
2318         ds_put_cstr(s, "ADD");
2319         break;
2320
2321     case OFPGC11_MODIFY:
2322         ds_put_cstr(s, "MOD");
2323         break;
2324
2325     case OFPGC11_DELETE:
2326         ds_put_cstr(s, "DEL");
2327         break;
2328
2329     default:
2330         ds_put_format(s, "cmd:%"PRIu16"", gm.command);
2331     }
2332     ds_put_char(s, ' ');
2333
2334     ofp_print_group(s, gm.group_id, gm.type, &gm.buckets);
2335 }
2336
2337 static void
2338 ofp_to_string__(const struct ofp_header *oh, enum ofpraw raw,
2339                 struct ds *string, int verbosity)
2340 {
2341     const void *msg = oh;
2342
2343     ofp_header_to_string__(oh, raw, string);
2344     switch (ofptype_from_ofpraw(raw)) {
2345
2346     case OFPTYPE_GROUP_STATS_REQUEST:
2347         ofp_print_stats_request(string, oh);
2348         ofp_print_ofpst_group_request(string, oh);
2349         break;
2350
2351     case OFPTYPE_GROUP_STATS_REPLY:
2352         ofp_print_group_stats(string, oh);
2353         break;
2354
2355     case OFPTYPE_GROUP_DESC_STATS_REQUEST:
2356         ofp_print_stats_request(string, oh);
2357         break;
2358
2359     case OFPTYPE_GROUP_DESC_STATS_REPLY:
2360         ofp_print_group_desc(string, oh);
2361         break;
2362
2363     case OFPTYPE_GROUP_FEATURES_STATS_REQUEST:
2364         ofp_print_stats_request(string, oh);
2365         break;
2366
2367     case OFPTYPE_GROUP_FEATURES_STATS_REPLY:
2368         ofp_print_group_features(string, oh);
2369         break;
2370
2371     case OFPTYPE_GROUP_MOD:
2372         ofp_print_group_mod(string, oh);
2373         break;
2374
2375     case OFPTYPE_QUEUE_GET_CONFIG_REQUEST:
2376     case OFPTYPE_QUEUE_GET_CONFIG_REPLY:
2377     case OFPTYPE_TABLE_FEATURES_STATS_REQUEST:
2378     case OFPTYPE_TABLE_FEATURES_STATS_REPLY:
2379         ofp_print_not_implemented(string);
2380         break;
2381
2382     case OFPTYPE_HELLO:
2383         ofp_print_hello(string, oh);
2384         break;
2385
2386     case OFPTYPE_ERROR:
2387         ofp_print_error_msg(string, oh);
2388         break;
2389
2390     case OFPTYPE_ECHO_REQUEST:
2391     case OFPTYPE_ECHO_REPLY:
2392         ofp_print_echo(string, oh, verbosity);
2393         break;
2394
2395     case OFPTYPE_FEATURES_REQUEST:
2396         break;
2397
2398     case OFPTYPE_FEATURES_REPLY:
2399         ofp_print_switch_features(string, oh);
2400         break;
2401
2402     case OFPTYPE_GET_CONFIG_REQUEST:
2403         break;
2404
2405     case OFPTYPE_GET_CONFIG_REPLY:
2406     case OFPTYPE_SET_CONFIG:
2407         ofp_print_switch_config(string, ofpmsg_body(oh));
2408         break;
2409
2410     case OFPTYPE_PACKET_IN:
2411         ofp_print_packet_in(string, oh, verbosity);
2412         break;
2413
2414     case OFPTYPE_FLOW_REMOVED:
2415         ofp_print_flow_removed(string, oh);
2416         break;
2417
2418     case OFPTYPE_PORT_STATUS:
2419         ofp_print_port_status(string, oh);
2420         break;
2421
2422     case OFPTYPE_PACKET_OUT:
2423         ofp_print_packet_out(string, oh, verbosity);
2424         break;
2425
2426     case OFPTYPE_FLOW_MOD:
2427         ofp_print_flow_mod(string, oh, verbosity);
2428         break;
2429
2430     case OFPTYPE_PORT_MOD:
2431         ofp_print_port_mod(string, oh);
2432         break;
2433
2434     case OFPTYPE_METER_MOD:
2435         ofp_print_meter_mod(string, oh);
2436         break;
2437
2438     case OFPTYPE_BARRIER_REQUEST:
2439     case OFPTYPE_BARRIER_REPLY:
2440         break;
2441
2442     case OFPTYPE_ROLE_REQUEST:
2443     case OFPTYPE_ROLE_REPLY:
2444         ofp_print_role_message(string, oh);
2445         break;
2446
2447     case OFPTYPE_METER_STATS_REQUEST:
2448     case OFPTYPE_METER_CONFIG_STATS_REQUEST:
2449         ofp_print_stats_request(string, oh);
2450         ofp_print_meter_stats_request(string, oh);
2451         break;
2452
2453     case OFPTYPE_METER_STATS_REPLY:
2454         ofp_print_stats_reply(string, oh);
2455         ofp_print_meter_stats_reply(string, oh);
2456         break;
2457
2458     case OFPTYPE_METER_CONFIG_STATS_REPLY:
2459         ofp_print_stats_reply(string, oh);
2460         ofp_print_meter_config_reply(string, oh);
2461         break;
2462
2463     case OFPTYPE_METER_FEATURES_STATS_REPLY:
2464         ofp_print_stats_reply(string, oh);
2465         ofp_print_meter_features_reply(string, oh);
2466         break;
2467
2468     case OFPTYPE_DESC_STATS_REQUEST:
2469     case OFPTYPE_PORT_DESC_STATS_REQUEST:
2470     case OFPTYPE_METER_FEATURES_STATS_REQUEST:
2471         ofp_print_stats_request(string, oh);
2472         break;
2473
2474     case OFPTYPE_FLOW_STATS_REQUEST:
2475     case OFPTYPE_AGGREGATE_STATS_REQUEST:
2476         ofp_print_stats_request(string, oh);
2477         ofp_print_flow_stats_request(string, oh);
2478         break;
2479
2480     case OFPTYPE_TABLE_STATS_REQUEST:
2481         ofp_print_stats_request(string, oh);
2482         break;
2483
2484     case OFPTYPE_PORT_STATS_REQUEST:
2485         ofp_print_stats_request(string, oh);
2486         ofp_print_ofpst_port_request(string, oh);
2487         break;
2488
2489     case OFPTYPE_QUEUE_STATS_REQUEST:
2490         ofp_print_stats_request(string, oh);
2491         ofp_print_ofpst_queue_request(string, oh);
2492         break;
2493
2494     case OFPTYPE_DESC_STATS_REPLY:
2495         ofp_print_stats_reply(string, oh);
2496         ofp_print_ofpst_desc_reply(string, oh);
2497         break;
2498
2499     case OFPTYPE_FLOW_STATS_REPLY:
2500         ofp_print_stats_reply(string, oh);
2501         ofp_print_flow_stats_reply(string, oh);
2502         break;
2503
2504     case OFPTYPE_QUEUE_STATS_REPLY:
2505         ofp_print_stats_reply(string, oh);
2506         ofp_print_ofpst_queue_reply(string, oh, verbosity);
2507         break;
2508
2509     case OFPTYPE_PORT_STATS_REPLY:
2510         ofp_print_stats_reply(string, oh);
2511         ofp_print_ofpst_port_reply(string, oh, verbosity);
2512         break;
2513
2514     case OFPTYPE_TABLE_STATS_REPLY:
2515         ofp_print_stats_reply(string, oh);
2516         ofp_print_ofpst_table_reply(string, oh, verbosity);
2517         break;
2518
2519     case OFPTYPE_AGGREGATE_STATS_REPLY:
2520         ofp_print_stats_reply(string, oh);
2521         ofp_print_aggregate_stats_reply(string, oh);
2522         break;
2523
2524     case OFPTYPE_PORT_DESC_STATS_REPLY:
2525         ofp_print_stats_reply(string, oh);
2526         ofp_print_ofpst_port_desc_reply(string, oh);
2527         break;
2528
2529     case OFPTYPE_FLOW_MOD_TABLE_ID:
2530         ofp_print_nxt_flow_mod_table_id(string, ofpmsg_body(oh));
2531         break;
2532
2533     case OFPTYPE_SET_FLOW_FORMAT:
2534         ofp_print_nxt_set_flow_format(string, ofpmsg_body(oh));
2535         break;
2536
2537     case OFPTYPE_SET_PACKET_IN_FORMAT:
2538         ofp_print_nxt_set_packet_in_format(string, ofpmsg_body(oh));
2539         break;
2540
2541     case OFPTYPE_FLOW_AGE:
2542         break;
2543
2544     case OFPTYPE_SET_CONTROLLER_ID:
2545         ofp_print_nxt_set_controller_id(string, ofpmsg_body(oh));
2546         break;
2547
2548     case OFPTYPE_GET_ASYNC_REPLY:
2549     case OFPTYPE_SET_ASYNC_CONFIG:
2550         ofp_print_nxt_set_async_config(string, ofpmsg_body(oh));
2551         break;
2552     case OFPTYPE_GET_ASYNC_REQUEST:
2553         break;
2554     case OFPTYPE_FLOW_MONITOR_CANCEL:
2555         ofp_print_nxt_flow_monitor_cancel(string, msg);
2556         break;
2557
2558     case OFPTYPE_FLOW_MONITOR_PAUSED:
2559     case OFPTYPE_FLOW_MONITOR_RESUMED:
2560         break;
2561
2562     case OFPTYPE_FLOW_MONITOR_STATS_REQUEST:
2563         ofp_print_nxst_flow_monitor_request(string, msg);
2564         break;
2565
2566     case OFPTYPE_FLOW_MONITOR_STATS_REPLY:
2567         ofp_print_nxst_flow_monitor_reply(string, msg);
2568         break;
2569     }
2570 }
2571
2572 /* Composes and returns a string representing the OpenFlow packet of 'len'
2573  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
2574  * verbosity and higher numbers increase verbosity.  The caller is responsible
2575  * for freeing the string. */
2576 char *
2577 ofp_to_string(const void *oh_, size_t len, int verbosity)
2578 {
2579     struct ds string = DS_EMPTY_INITIALIZER;
2580     const struct ofp_header *oh = oh_;
2581
2582     if (!len) {
2583         ds_put_cstr(&string, "OpenFlow message is empty\n");
2584     } else if (len < sizeof(struct ofp_header)) {
2585         ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
2586                       len);
2587     } else if (ntohs(oh->length) > len) {
2588         enum ofperr error;
2589         enum ofpraw raw;
2590
2591         error = ofpraw_decode_partial(&raw, oh, len);
2592         if (!error) {
2593             ofp_header_to_string__(oh, raw, &string);
2594             ds_put_char(&string, '\n');
2595         }
2596
2597         ds_put_format(&string,
2598                       "(***truncated to %zu bytes from %"PRIu16"***)\n",
2599                       len, ntohs(oh->length));
2600     } else if (ntohs(oh->length) < len) {
2601         ds_put_format(&string,
2602                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
2603                       ntohs(oh->length), len);
2604     } else {
2605         enum ofperr error;
2606         enum ofpraw raw;
2607
2608         error = ofpraw_decode(&raw, oh);
2609         if (!error) {
2610             ofp_to_string__(oh, raw, &string, verbosity);
2611             if (verbosity >= 5) {
2612                 if (ds_last(&string) != '\n') {
2613                     ds_put_char(&string, '\n');
2614                 }
2615                 ds_put_hex_dump(&string, oh, len, 0, true);
2616             }
2617             if (ds_last(&string) != '\n') {
2618                 ds_put_char(&string, '\n');
2619             }
2620             return ds_steal_cstr(&string);
2621         }
2622
2623         ofp_print_error(&string, error);
2624     }
2625     ds_put_hex_dump(&string, oh, len, 0, true);
2626     return ds_steal_cstr(&string);
2627 }
2628 \f
2629 static void
2630 print_and_free(FILE *stream, char *string)
2631 {
2632     fputs(string, stream);
2633     free(string);
2634 }
2635
2636 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
2637  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
2638  * numbers increase verbosity. */
2639 void
2640 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
2641 {
2642     print_and_free(stream, ofp_to_string(oh, len, verbosity));
2643 }
2644
2645 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
2646  * 'data' to 'stream'. */
2647 void
2648 ofp_print_packet(FILE *stream, const void *data, size_t len)
2649 {
2650     print_and_free(stream, ofp_packet_to_string(data, len));
2651 }