ofp-print: Print out_port field in "flow_mod"s.
[sliver-openvswitch.git] / lib / ofp-print.c
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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-util.h"
42 #include "ofpbuf.h"
43 #include "openflow/openflow.h"
44 #include "openflow/nicira-ext.h"
45 #include "packets.h"
46 #include "pcap.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, 0, &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         }
78     }
79
80     ds_put_char(&ds, '\n');
81
82     return ds_cstr(&ds);
83 }
84
85 static void
86 ofp_print_packet_in(struct ds *string, const struct ofp_header *oh,
87                     int verbosity)
88 {
89     struct ofputil_packet_in pin;
90     int error;
91     int i;
92
93     error = ofputil_decode_packet_in(&pin, oh);
94     if (error) {
95         ofp_print_error(string, error);
96         return;
97     }
98
99     if (pin.table_id) {
100         ds_put_format(string, " table_id=%"PRIu8, pin.table_id);
101     }
102
103     if (pin.cookie) {
104         ds_put_format(string, " cookie=0x%"PRIx64, ntohll(pin.cookie));
105     }
106
107     ds_put_format(string, " total_len=%"PRIu16" in_port=", pin.total_len);
108     ofputil_format_port(pin.fmd.in_port, string);
109
110     if (pin.fmd.tun_id_mask) {
111         ds_put_format(string, " tun_id=0x%"PRIx64, ntohll(pin.fmd.tun_id));
112         if (pin.fmd.tun_id_mask != htonll(UINT64_MAX)) {
113             ds_put_format(string, "/0x%"PRIx64, ntohll(pin.fmd.tun_id_mask));
114         }
115     }
116
117     if (pin.fmd.metadata_mask) {
118         ds_put_format(string, " metadata=0x%"PRIx64, ntohll(pin.fmd.metadata));
119         if (pin.fmd.metadata_mask != htonll(UINT64_MAX)) {
120             ds_put_format(string, "/0x%"PRIx64, ntohll(pin.fmd.metadata_mask));
121         }
122     }
123
124     for (i = 0; i < FLOW_N_REGS; i++) {
125         if (pin.fmd.reg_masks[i]) {
126             ds_put_format(string, " reg%d=0x%"PRIx32, i, pin.fmd.regs[i]);
127             if (pin.fmd.reg_masks[i] != UINT32_MAX) {
128                 ds_put_format(string, "/0x%"PRIx32, pin.fmd.reg_masks[i]);
129             }
130         }
131     }
132
133     ds_put_format(string, " (via %s)",
134                   ofputil_packet_in_reason_to_string(pin.reason));
135
136     ds_put_format(string, " data_len=%zu", pin.packet_len);
137     if (pin.buffer_id == UINT32_MAX) {
138         ds_put_format(string, " (unbuffered)");
139         if (pin.total_len != pin.packet_len) {
140             ds_put_format(string, " (***total_len != data_len***)");
141         }
142     } else {
143         ds_put_format(string, " buffer=0x%08"PRIx32, pin.buffer_id);
144         if (pin.total_len < pin.packet_len) {
145             ds_put_format(string, " (***total_len < data_len***)");
146         }
147     }
148     ds_put_char(string, '\n');
149
150     if (verbosity > 0) {
151         char *packet = ofp_packet_to_string(pin.packet, pin.packet_len);
152         ds_put_cstr(string, packet);
153         free(packet);
154     }
155 }
156
157 static void
158 ofp_print_packet_out(struct ds *string, const struct ofp_packet_out *opo,
159                      int verbosity)
160 {
161     struct ofputil_packet_out po;
162     struct ofpbuf ofpacts;
163     enum ofperr error;
164
165     ofpbuf_init(&ofpacts, 64);
166     error = ofputil_decode_packet_out(&po, opo, &ofpacts);
167     if (error) {
168         ofpbuf_uninit(&ofpacts);
169         ofp_print_error(string, error);
170         return;
171     }
172
173     ds_put_cstr(string, " in_port=");
174     ofputil_format_port(po.in_port, string);
175
176     ds_put_char(string, ' ');
177     ofpacts_format(po.ofpacts, po.ofpacts_len, string);
178
179     if (po.buffer_id == UINT32_MAX) {
180         ds_put_format(string, " data_len=%zu", po.packet_len);
181         if (verbosity > 0 && po.packet_len > 0) {
182             char *packet = ofp_packet_to_string(po.packet, po.packet_len);
183             ds_put_char(string, '\n');
184             ds_put_cstr(string, packet);
185             free(packet);
186         }
187     } else {
188         ds_put_format(string, " buffer=0x%08"PRIx32, po.buffer_id);
189     }
190     ds_put_char(string, '\n');
191
192     ofpbuf_uninit(&ofpacts);
193 }
194
195 /* qsort comparison function. */
196 static int
197 compare_ports(const void *a_, const void *b_)
198 {
199     const struct ofputil_phy_port *a = a_;
200     const struct ofputil_phy_port *b = b_;
201     uint16_t ap = a->port_no;
202     uint16_t bp = b->port_no;
203
204     return ap < bp ? -1 : ap > bp;
205 }
206
207 static void
208 ofp_print_bit_names(struct ds *string, uint32_t bits,
209                     const char *(*bit_to_name)(uint32_t bit))
210 {
211     int n = 0;
212     int i;
213
214     if (!bits) {
215         ds_put_cstr(string, "0");
216         return;
217     }
218
219     for (i = 0; i < 32; i++) {
220         uint32_t bit = UINT32_C(1) << i;
221
222         if (bits & bit) {
223             const char *name = bit_to_name(bit);
224             if (name) {
225                 if (n++) {
226                     ds_put_char(string, ' ');
227                 }
228                 ds_put_cstr(string, name);
229                 bits &= ~bit;
230             }
231         }
232     }
233
234     if (bits) {
235         if (n) {
236             ds_put_char(string, ' ');
237         }
238         ds_put_format(string, "0x%"PRIx32, bits);
239     }
240 }
241
242 static const char *
243 netdev_feature_to_name(uint32_t bit)
244 {
245     enum netdev_features f = bit;
246
247     switch (f) {
248     case NETDEV_F_10MB_HD:    return "10MB-HD";
249     case NETDEV_F_10MB_FD:    return "10MB-FD";
250     case NETDEV_F_100MB_HD:   return "100MB-HD";
251     case NETDEV_F_100MB_FD:   return "100MB-FD";
252     case NETDEV_F_1GB_HD:     return "1GB-HD";
253     case NETDEV_F_1GB_FD:     return "1GB-FD";
254     case NETDEV_F_10GB_FD:    return "10GB-FD";
255     case NETDEV_F_40GB_FD:    return "40GB-FD";
256     case NETDEV_F_100GB_FD:   return "100GB-FD";
257     case NETDEV_F_1TB_FD:     return "1TB-FD";
258     case NETDEV_F_OTHER:      return "OTHER";
259     case NETDEV_F_COPPER:     return "COPPER";
260     case NETDEV_F_FIBER:      return "FIBER";
261     case NETDEV_F_AUTONEG:    return "AUTO_NEG";
262     case NETDEV_F_PAUSE:      return "AUTO_PAUSE";
263     case NETDEV_F_PAUSE_ASYM: return "AUTO_PAUSE_ASYM";
264     }
265
266     return NULL;
267 }
268
269 static void
270 ofp_print_port_features(struct ds *string, enum netdev_features features)
271 {
272     ofp_print_bit_names(string, features, netdev_feature_to_name);
273     ds_put_char(string, '\n');
274 }
275
276 static const char *
277 ofputil_port_config_to_name(uint32_t bit)
278 {
279     enum ofputil_port_config pc = bit;
280
281     switch (pc) {
282     case OFPUTIL_PC_PORT_DOWN:    return "PORT_DOWN";
283     case OFPUTIL_PC_NO_STP:       return "NO_STP";
284     case OFPUTIL_PC_NO_RECV:      return "NO_RECV";
285     case OFPUTIL_PC_NO_RECV_STP:  return "NO_RECV_STP";
286     case OFPUTIL_PC_NO_FLOOD:     return "NO_FLOOD";
287     case OFPUTIL_PC_NO_FWD:       return "NO_FWD";
288     case OFPUTIL_PC_NO_PACKET_IN: return "NO_PACKET_IN";
289     }
290
291     return NULL;
292 }
293
294 static void
295 ofp_print_port_config(struct ds *string, enum ofputil_port_config config)
296 {
297     ofp_print_bit_names(string, config, ofputil_port_config_to_name);
298     ds_put_char(string, '\n');
299 }
300
301 static const char *
302 ofputil_port_state_to_name(uint32_t bit)
303 {
304     enum ofputil_port_state ps = bit;
305
306     switch (ps) {
307     case OFPUTIL_PS_LINK_DOWN: return "LINK_DOWN";
308     case OFPUTIL_PS_BLOCKED:   return "BLOCKED";
309     case OFPUTIL_PS_LIVE:      return "LIVE";
310
311     case OFPUTIL_PS_STP_LISTEN:
312     case OFPUTIL_PS_STP_LEARN:
313     case OFPUTIL_PS_STP_FORWARD:
314     case OFPUTIL_PS_STP_BLOCK:
315         /* Handled elsewhere. */
316         return NULL;
317     }
318
319     return NULL;
320 }
321
322 static void
323 ofp_print_port_state(struct ds *string, enum ofputil_port_state state)
324 {
325     enum ofputil_port_state stp_state;
326
327     /* The STP state is a 2-bit field so it doesn't fit in with the bitmask
328      * pattern.  We have to special case it.
329      *
330      * OVS doesn't support STP, so this field will always be 0 if we are
331      * talking to OVS, so we'd always print STP_LISTEN in that case.
332      * Therefore, we don't print anything at all if the value is STP_LISTEN, to
333      * avoid confusing users. */
334     stp_state = state & OFPUTIL_PS_STP_MASK;
335     if (stp_state) {
336         ds_put_cstr(string,
337                     (stp_state == OFPUTIL_PS_STP_LEARN ? "STP_LEARN"
338                      : stp_state == OFPUTIL_PS_STP_FORWARD ? "STP_FORWARD"
339                      : "STP_BLOCK"));
340         state &= ~OFPUTIL_PS_STP_MASK;
341         if (state) {
342             ofp_print_bit_names(string, state, ofputil_port_state_to_name);
343         }
344     } else {
345         ofp_print_bit_names(string, state, ofputil_port_state_to_name);
346     }
347     ds_put_char(string, '\n');
348 }
349
350 static void
351 ofp_print_phy_port(struct ds *string, const struct ofputil_phy_port *port)
352 {
353     char name[sizeof port->name];
354     int j;
355
356     memcpy(name, port->name, sizeof name);
357     for (j = 0; j < sizeof name - 1; j++) {
358         if (!isprint((unsigned char) name[j])) {
359             break;
360         }
361     }
362     name[j] = '\0';
363
364     ds_put_char(string, ' ');
365     ofputil_format_port(port->port_no, string);
366     ds_put_format(string, "(%s): addr:"ETH_ADDR_FMT"\n",
367                   name, ETH_ADDR_ARGS(port->hw_addr));
368
369     ds_put_cstr(string, "     config:     ");
370     ofp_print_port_config(string, port->config);
371
372     ds_put_cstr(string, "     state:      ");
373     ofp_print_port_state(string, port->state);
374
375     if (port->curr) {
376         ds_put_format(string, "     current:    ");
377         ofp_print_port_features(string, port->curr);
378     }
379     if (port->advertised) {
380         ds_put_format(string, "     advertised: ");
381         ofp_print_port_features(string, port->advertised);
382     }
383     if (port->supported) {
384         ds_put_format(string, "     supported:  ");
385         ofp_print_port_features(string, port->supported);
386     }
387     if (port->peer) {
388         ds_put_format(string, "     peer:       ");
389         ofp_print_port_features(string, port->peer);
390     }
391     ds_put_format(string, "     speed: %"PRIu32" Mbps now, "
392                   "%"PRIu32" Mbps max\n",
393                   port->curr_speed / UINT32_C(1000),
394                   port->max_speed / UINT32_C(1000));
395 }
396
397 /* Given a buffer 'b' that contains an array of OpenFlow ports of type
398  * 'ofp_version', writes a detailed description of each port into
399  * 'string'. */
400 static void
401 ofp_print_phy_ports(struct ds *string, uint8_t ofp_version,
402                     struct ofpbuf *b)
403 {
404     size_t n_ports;
405     struct ofputil_phy_port *ports;
406     enum ofperr error;
407     size_t i;
408
409     n_ports = ofputil_count_phy_ports(ofp_version, b);
410
411     ports = xmalloc(n_ports * sizeof *ports);
412     for (i = 0; i < n_ports; i++) {
413         error = ofputil_pull_phy_port(ofp_version, b, &ports[i]);
414         if (error) {
415             ofp_print_error(string, error);
416             goto exit;
417         }
418     }
419     qsort(ports, n_ports, sizeof *ports, compare_ports);
420     for (i = 0; i < n_ports; i++) {
421         ofp_print_phy_port(string, &ports[i]);
422     }
423
424 exit:
425     free(ports);
426 }
427
428 static const char *
429 ofputil_capabilities_to_name(uint32_t bit)
430 {
431     enum ofputil_capabilities capabilities = bit;
432
433     switch (capabilities) {
434     case OFPUTIL_C_FLOW_STATS:   return "FLOW_STATS";
435     case OFPUTIL_C_TABLE_STATS:  return "TABLE_STATS";
436     case OFPUTIL_C_PORT_STATS:   return "PORT_STATS";
437     case OFPUTIL_C_IP_REASM:     return "IP_REASM";
438     case OFPUTIL_C_QUEUE_STATS:  return "QUEUE_STATS";
439     case OFPUTIL_C_ARP_MATCH_IP: return "ARP_MATCH_IP";
440     case OFPUTIL_C_STP:          return "STP";
441     case OFPUTIL_C_GROUP_STATS:  return "GROUP_STATS";
442     }
443
444     return NULL;
445 }
446
447 static const char *
448 ofputil_action_bitmap_to_name(uint32_t bit)
449 {
450     enum ofputil_action_bitmap action = bit;
451
452     switch (action) {
453     case OFPUTIL_A_OUTPUT:         return "OUTPUT";
454     case OFPUTIL_A_SET_VLAN_VID:   return "SET_VLAN_VID";
455     case OFPUTIL_A_SET_VLAN_PCP:   return "SET_VLAN_PCP";
456     case OFPUTIL_A_STRIP_VLAN:     return "STRIP_VLAN";
457     case OFPUTIL_A_SET_DL_SRC:     return "SET_DL_SRC";
458     case OFPUTIL_A_SET_DL_DST:     return "SET_DL_DST";
459     case OFPUTIL_A_SET_NW_SRC:     return "SET_NW_SRC";
460     case OFPUTIL_A_SET_NW_DST:     return "SET_NW_DST";
461     case OFPUTIL_A_SET_NW_ECN:     return "SET_NW_ECN";
462     case OFPUTIL_A_SET_NW_TOS:     return "SET_NW_TOS";
463     case OFPUTIL_A_SET_TP_SRC:     return "SET_TP_SRC";
464     case OFPUTIL_A_SET_TP_DST:     return "SET_TP_DST";
465     case OFPUTIL_A_ENQUEUE:        return "ENQUEUE";
466     case OFPUTIL_A_COPY_TTL_OUT:   return "COPY_TTL_OUT";
467     case OFPUTIL_A_COPY_TTL_IN:    return "COPY_TTL_IN";
468     case OFPUTIL_A_SET_MPLS_LABEL: return "SET_MPLS_LABEL";
469     case OFPUTIL_A_SET_MPLS_TC:    return "SET_MPLS_TC";
470     case OFPUTIL_A_SET_MPLS_TTL:   return "SET_MPLS_TTL";
471     case OFPUTIL_A_DEC_MPLS_TTL:   return "DEC_MPLS_TTL";
472     case OFPUTIL_A_PUSH_VLAN:      return "PUSH_VLAN";
473     case OFPUTIL_A_POP_VLAN:       return "POP_VLAN";
474     case OFPUTIL_A_PUSH_MPLS:      return "PUSH_MPLS";
475     case OFPUTIL_A_POP_MPLS:       return "POP_MPLS";
476     case OFPUTIL_A_SET_QUEUE:      return "SET_QUEUE";
477     case OFPUTIL_A_GROUP:          return "GROUP";
478     case OFPUTIL_A_SET_NW_TTL:     return "SET_NW_TTL";
479     case OFPUTIL_A_DEC_NW_TTL:     return "DEC_NW_TTL";
480     }
481
482     return NULL;
483 }
484
485 static void
486 ofp_print_switch_features(struct ds *string,
487                           const struct ofp_switch_features *osf)
488 {
489     struct ofputil_switch_features features;
490     enum ofperr error;
491     struct ofpbuf b;
492
493     error = ofputil_decode_switch_features(osf, &features, &b);
494     if (error) {
495         ofp_print_error(string, error);
496         return;
497     }
498
499     ds_put_format(string, " dpid:%016"PRIx64"\n", features.datapath_id);
500     ds_put_format(string, "n_tables:%"PRIu8", n_buffers:%"PRIu32"\n",
501                   features.n_tables, features.n_buffers);
502
503     ds_put_cstr(string, "capabilities: ");
504     ofp_print_bit_names(string, features.capabilities,
505                         ofputil_capabilities_to_name);
506     ds_put_char(string, '\n');
507
508     ds_put_cstr(string, "actions: ");
509     ofp_print_bit_names(string, features.actions,
510                         ofputil_action_bitmap_to_name);
511     ds_put_char(string, '\n');
512
513     ofp_print_phy_ports(string, osf->header.version, &b);
514 }
515
516 static void
517 ofp_print_switch_config(struct ds *string, const struct ofp_switch_config *osc)
518 {
519     enum ofp_config_flags flags;
520
521     flags = ntohs(osc->flags);
522
523     ds_put_format(string, " frags=%s", ofputil_frag_handling_to_string(flags));
524     flags &= ~OFPC_FRAG_MASK;
525
526     if (flags & OFPC_INVALID_TTL_TO_CONTROLLER) {
527         ds_put_format(string, " invalid_ttl_to_controller");
528         flags &= ~OFPC_INVALID_TTL_TO_CONTROLLER;
529     }
530
531     if (flags) {
532         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***", flags);
533     }
534
535     ds_put_format(string, " miss_send_len=%"PRIu16"\n", ntohs(osc->miss_send_len));
536 }
537
538 static void print_wild(struct ds *string, const char *leader, int is_wild,
539             int verbosity, const char *format, ...)
540             __attribute__((format(printf, 5, 6)));
541
542 static void print_wild(struct ds *string, const char *leader, int is_wild,
543                        int verbosity, const char *format, ...)
544 {
545     if (is_wild && verbosity < 2) {
546         return;
547     }
548     ds_put_cstr(string, leader);
549     if (!is_wild) {
550         va_list args;
551
552         va_start(args, format);
553         ds_put_format_valist(string, format, args);
554         va_end(args);
555     } else {
556         ds_put_char(string, '*');
557     }
558     ds_put_char(string, ',');
559 }
560
561 static void
562 print_ip_netmask(struct ds *string, const char *leader, ovs_be32 ip,
563                  uint32_t wild_bits, int verbosity)
564 {
565     if (wild_bits >= 32 && verbosity < 2) {
566         return;
567     }
568     ds_put_cstr(string, leader);
569     if (wild_bits < 32) {
570         ds_put_format(string, IP_FMT, IP_ARGS(&ip));
571         if (wild_bits) {
572             ds_put_format(string, "/%d", 32 - wild_bits);
573         }
574     } else {
575         ds_put_char(string, '*');
576     }
577     ds_put_char(string, ',');
578 }
579
580 void
581 ofp10_match_print(struct ds *f, const struct ofp10_match *om, int verbosity)
582 {
583     char *s = ofp10_match_to_string(om, verbosity);
584     ds_put_cstr(f, s);
585     free(s);
586 }
587
588 char *
589 ofp10_match_to_string(const struct ofp10_match *om, int verbosity)
590 {
591     struct ds f = DS_EMPTY_INITIALIZER;
592     uint32_t w = ntohl(om->wildcards);
593     bool skip_type = false;
594     bool skip_proto = false;
595
596     if (!(w & OFPFW10_DL_TYPE)) {
597         skip_type = true;
598         if (om->dl_type == htons(ETH_TYPE_IP)) {
599             if (!(w & OFPFW10_NW_PROTO)) {
600                 skip_proto = true;
601                 if (om->nw_proto == IPPROTO_ICMP) {
602                     ds_put_cstr(&f, "icmp,");
603                 } else if (om->nw_proto == IPPROTO_TCP) {
604                     ds_put_cstr(&f, "tcp,");
605                 } else if (om->nw_proto == IPPROTO_UDP) {
606                     ds_put_cstr(&f, "udp,");
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 {
617             skip_type = false;
618         }
619     }
620     print_wild(&f, "in_port=", w & OFPFW10_IN_PORT, verbosity,
621                "%d", ntohs(om->in_port));
622     print_wild(&f, "dl_vlan=", w & OFPFW10_DL_VLAN, verbosity,
623                "%d", ntohs(om->dl_vlan));
624     print_wild(&f, "dl_vlan_pcp=", w & OFPFW10_DL_VLAN_PCP, verbosity,
625                "%d", om->dl_vlan_pcp);
626     print_wild(&f, "dl_src=", w & OFPFW10_DL_SRC, verbosity,
627                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_src));
628     print_wild(&f, "dl_dst=", w & OFPFW10_DL_DST, verbosity,
629                ETH_ADDR_FMT, ETH_ADDR_ARGS(om->dl_dst));
630     if (!skip_type) {
631         print_wild(&f, "dl_type=", w & OFPFW10_DL_TYPE, verbosity,
632                    "0x%04x", ntohs(om->dl_type));
633     }
634     print_ip_netmask(&f, "nw_src=", om->nw_src,
635                      (w & OFPFW10_NW_SRC_MASK) >> OFPFW10_NW_SRC_SHIFT,
636                      verbosity);
637     print_ip_netmask(&f, "nw_dst=", om->nw_dst,
638                      (w & OFPFW10_NW_DST_MASK) >> OFPFW10_NW_DST_SHIFT,
639                      verbosity);
640     if (!skip_proto) {
641         if (om->dl_type == htons(ETH_TYPE_ARP)) {
642             print_wild(&f, "arp_op=", w & OFPFW10_NW_PROTO, verbosity,
643                        "%u", om->nw_proto);
644         } else {
645             print_wild(&f, "nw_proto=", w & OFPFW10_NW_PROTO, verbosity,
646                        "%u", om->nw_proto);
647         }
648     }
649     print_wild(&f, "nw_tos=", w & OFPFW10_NW_TOS, verbosity,
650                "%u", om->nw_tos);
651     if (om->nw_proto == IPPROTO_ICMP) {
652         print_wild(&f, "icmp_type=", w & OFPFW10_ICMP_TYPE, verbosity,
653                    "%d", ntohs(om->tp_src));
654         print_wild(&f, "icmp_code=", w & OFPFW10_ICMP_CODE, verbosity,
655                    "%d", ntohs(om->tp_dst));
656     } else {
657         print_wild(&f, "tp_src=", w & OFPFW10_TP_SRC, verbosity,
658                    "%d", ntohs(om->tp_src));
659         print_wild(&f, "tp_dst=", w & OFPFW10_TP_DST, verbosity,
660                    "%d", ntohs(om->tp_dst));
661     }
662     if (ds_last(&f) == ',') {
663         f.length--;
664     }
665     return ds_cstr(&f);
666 }
667
668 static void
669 ofp_print_flow_mod(struct ds *s, const struct ofp_header *oh,
670                    enum ofputil_msg_code code, int verbosity)
671 {
672     struct ofputil_flow_mod fm;
673     struct ofpbuf ofpacts;
674     bool need_priority;
675     enum ofperr error;
676
677     ofpbuf_init(&ofpacts, 64);
678     error = ofputil_decode_flow_mod(&fm, oh, OFPUTIL_P_OF10_TID, &ofpacts);
679     if (error) {
680         ofpbuf_uninit(&ofpacts);
681         ofp_print_error(s, error);
682         return;
683     }
684
685     ds_put_char(s, ' ');
686     switch (fm.command) {
687     case OFPFC_ADD:
688         ds_put_cstr(s, "ADD");
689         break;
690     case OFPFC_MODIFY:
691         ds_put_cstr(s, "MOD");
692         break;
693     case OFPFC_MODIFY_STRICT:
694         ds_put_cstr(s, "MOD_STRICT");
695         break;
696     case OFPFC_DELETE:
697         ds_put_cstr(s, "DEL");
698         break;
699     case OFPFC_DELETE_STRICT:
700         ds_put_cstr(s, "DEL_STRICT");
701         break;
702     default:
703         ds_put_format(s, "cmd:%d", fm.command);
704     }
705     if (fm.table_id != 0) {
706         ds_put_format(s, " table:%d", fm.table_id);
707     }
708
709     ds_put_char(s, ' ');
710     if (verbosity >= 3 && code == OFPUTIL_OFPT_FLOW_MOD) {
711         const struct ofp_flow_mod *ofm = (const struct ofp_flow_mod *) oh;
712         ofp10_match_print(s, &ofm->match, verbosity);
713
714         /* ofp_print_match() doesn't print priority. */
715         need_priority = true;
716     } else if (verbosity >= 3 && code == OFPUTIL_NXT_FLOW_MOD) {
717         const struct nx_flow_mod *nfm = (const struct nx_flow_mod *) oh;
718         const void *nxm = nfm + 1;
719         char *nxm_s;
720
721         nxm_s = nx_match_to_string(nxm, ntohs(nfm->match_len));
722         ds_put_cstr(s, nxm_s);
723         free(nxm_s);
724
725         /* nx_match_to_string() doesn't print priority. */
726         need_priority = true;
727     } else {
728         cls_rule_format(&fm.cr, s);
729
730         /* cls_rule_format() does print priority. */
731         need_priority = false;
732     }
733
734     if (ds_last(s) != ' ') {
735         ds_put_char(s, ' ');
736     }
737     if (fm.new_cookie != htonll(0)) {
738         ds_put_format(s, "cookie:0x%"PRIx64" ", ntohll(fm.new_cookie));
739     }
740     if (fm.cookie_mask != htonll(0)) {
741         ds_put_format(s, "cookie:0x%"PRIx64"/0x%"PRIx64" ",
742                 ntohll(fm.cookie), ntohll(fm.cookie_mask));
743     }
744     if (fm.idle_timeout != OFP_FLOW_PERMANENT) {
745         ds_put_format(s, "idle:%"PRIu16" ", fm.idle_timeout);
746     }
747     if (fm.hard_timeout != OFP_FLOW_PERMANENT) {
748         ds_put_format(s, "hard:%"PRIu16" ", fm.hard_timeout);
749     }
750     if (fm.cr.priority != OFP_DEFAULT_PRIORITY && need_priority) {
751         ds_put_format(s, "pri:%"PRIu16" ", fm.cr.priority);
752     }
753     if (fm.buffer_id != UINT32_MAX) {
754         ds_put_format(s, "buf:0x%"PRIx32" ", fm.buffer_id);
755     }
756     if (fm.out_port != OFPP_NONE) {
757         ds_put_format(s, "out_port:");
758         ofputil_format_port(fm.out_port, s);
759         ds_put_char(s, ' ');
760     }
761     if (fm.flags != 0) {
762         uint16_t flags = fm.flags;
763
764         if (flags & OFPFF_SEND_FLOW_REM) {
765             ds_put_cstr(s, "send_flow_rem ");
766         }
767         if (flags & OFPFF_CHECK_OVERLAP) {
768             ds_put_cstr(s, "check_overlap ");
769         }
770         if (flags & OFPFF_EMERG) {
771             ds_put_cstr(s, "emerg ");
772         }
773
774         flags &= ~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF_EMERG);
775         if (flags) {
776             ds_put_format(s, "flags:0x%"PRIx16" ", flags);
777         }
778     }
779
780     ofpacts_format(fm.ofpacts, fm.ofpacts_len, s);
781     ofpbuf_uninit(&ofpacts);
782 }
783
784 static void
785 ofp_print_duration(struct ds *string, unsigned int sec, unsigned int nsec)
786 {
787     ds_put_format(string, "%u", sec);
788     if (nsec > 0) {
789         ds_put_format(string, ".%09u", nsec);
790         while (string->string[string->length - 1] == '0') {
791             string->length--;
792         }
793     }
794     ds_put_char(string, 's');
795 }
796
797 static const char *
798 ofp_flow_removed_reason_to_string(enum ofp_flow_removed_reason reason)
799 {
800     static char s[32];
801
802     switch (reason) {
803     case OFPRR_IDLE_TIMEOUT:
804         return "idle";
805     case OFPRR_HARD_TIMEOUT:
806         return "hard";
807     case OFPRR_DELETE:
808         return "delete";
809     case OFPRR_GROUP_DELETE:
810         return "group_delete";
811     default:
812         sprintf(s, "%d", (int) reason);
813         return s;
814     }
815 }
816
817 static void
818 ofp_print_flow_removed(struct ds *string, const struct ofp_header *oh)
819 {
820     struct ofputil_flow_removed fr;
821     enum ofperr error;
822
823     error = ofputil_decode_flow_removed(&fr, oh);
824     if (error) {
825         ofp_print_error(string, error);
826         return;
827     }
828
829     ds_put_char(string, ' ');
830     cls_rule_format(&fr.rule, string);
831
832     ds_put_format(string, " reason=%s",
833                   ofp_flow_removed_reason_to_string(fr.reason));
834
835     if (fr.cookie != htonll(0)) {
836         ds_put_format(string, " cookie:0x%"PRIx64, ntohll(fr.cookie));
837     }
838     ds_put_cstr(string, " duration");
839     ofp_print_duration(string, fr.duration_sec, fr.duration_nsec);
840     ds_put_format(string, " idle%"PRIu16" pkts%"PRIu64" bytes%"PRIu64"\n",
841          fr.idle_timeout, fr.packet_count, fr.byte_count);
842 }
843
844 static void
845 ofp_print_port_mod(struct ds *string, const struct ofp_header *oh)
846 {
847     struct ofputil_port_mod pm;
848     enum ofperr error;
849
850     error = ofputil_decode_port_mod(oh, &pm);
851     if (error) {
852         ofp_print_error(string, error);
853         return;
854     }
855
856     ds_put_format(string, "port: %"PRIu16": addr:"ETH_ADDR_FMT"\n",
857                   pm.port_no, ETH_ADDR_ARGS(pm.hw_addr));
858
859     ds_put_format(string, "     config: ");
860     ofp_print_port_config(string, pm.config);
861
862     ds_put_format(string, "     mask:   ");
863     ofp_print_port_config(string, pm.mask);
864
865     ds_put_format(string, "     advertise: ");
866     if (pm.advertise) {
867         ofp_print_port_features(string, pm.advertise);
868     } else {
869         ds_put_format(string, "UNCHANGED\n");
870     }
871 }
872
873 static void
874 ofp_print_error(struct ds *string, enum ofperr error)
875 {
876     if (string->length) {
877         ds_put_char(string, ' ');
878     }
879     ds_put_format(string, "***decode error: %s***\n", ofperr_get_name(error));
880 }
881
882 static void
883 ofp_print_error_msg(struct ds *string, const struct ofp_error_msg *oem)
884 {
885     size_t len = ntohs(oem->header.length);
886     size_t payload_ofs, payload_len;
887     const void *payload;
888     enum ofperr error;
889     char *s;
890
891     error = ofperr_decode_msg(&oem->header, &payload_ofs);
892     if (!error) {
893         ds_put_cstr(string, "***decode error***");
894         ds_put_hex_dump(string, oem->data, len - sizeof *oem, 0, true);
895         return;
896     }
897
898     ds_put_format(string, " %s\n", ofperr_get_name(error));
899
900     payload = (const uint8_t *) oem + payload_ofs;
901     payload_len = len - payload_ofs;
902     if (error == OFPERR_OFPHFC_INCOMPATIBLE || error == OFPERR_OFPHFC_EPERM) {
903         ds_put_printable(string, payload, payload_len);
904     } else {
905         s = ofp_to_string(payload, payload_len, 1);
906         ds_put_cstr(string, s);
907         free(s);
908     }
909 }
910
911 static void
912 ofp_print_port_status(struct ds *string, const struct ofp_port_status *ops)
913 {
914     struct ofputil_port_status ps;
915     enum ofperr error;
916
917     error = ofputil_decode_port_status(ops, &ps);
918     if (error) {
919         ofp_print_error(string, error);
920         return;
921     }
922
923     if (ps.reason == OFPPR_ADD) {
924         ds_put_format(string, " ADD:");
925     } else if (ps.reason == OFPPR_DELETE) {
926         ds_put_format(string, " DEL:");
927     } else if (ps.reason == OFPPR_MODIFY) {
928         ds_put_format(string, " MOD:");
929     }
930
931     ofp_print_phy_port(string, &ps.desc);
932 }
933
934 static void
935 ofp_print_ofpst_desc_reply(struct ds *string, const struct ofp_desc_stats *ods)
936 {
937     ds_put_char(string, '\n');
938     ds_put_format(string, "Manufacturer: %.*s\n",
939             (int) sizeof ods->mfr_desc, ods->mfr_desc);
940     ds_put_format(string, "Hardware: %.*s\n",
941             (int) sizeof ods->hw_desc, ods->hw_desc);
942     ds_put_format(string, "Software: %.*s\n",
943             (int) sizeof ods->sw_desc, ods->sw_desc);
944     ds_put_format(string, "Serial Num: %.*s\n",
945             (int) sizeof ods->serial_num, ods->serial_num);
946     ds_put_format(string, "DP Description: %.*s\n",
947             (int) sizeof ods->dp_desc, ods->dp_desc);
948 }
949
950 static void
951 ofp_print_flow_stats_request(struct ds *string,
952                              const struct ofp_stats_msg *osm)
953 {
954     struct ofputil_flow_stats_request fsr;
955     enum ofperr error;
956
957     error = ofputil_decode_flow_stats_request(&fsr, &osm->header);
958     if (error) {
959         ofp_print_error(string, error);
960         return;
961     }
962
963     if (fsr.table_id != 0xff) {
964         ds_put_format(string, " table=%"PRIu8, fsr.table_id);
965     }
966
967     if (fsr.out_port != OFPP_NONE) {
968         ds_put_cstr(string, " out_port=");
969         ofputil_format_port(fsr.out_port, string);
970     }
971
972     /* A flow stats request doesn't include a priority, but cls_rule_format()
973      * will print one unless it is OFP_DEFAULT_PRIORITY. */
974     fsr.match.priority = OFP_DEFAULT_PRIORITY;
975
976     ds_put_char(string, ' ');
977     cls_rule_format(&fsr.match, string);
978 }
979
980 void
981 ofp_print_flow_stats(struct ds *string, struct ofputil_flow_stats *fs)
982 {
983     ds_put_format(string, " cookie=0x%"PRIx64", duration=",
984                   ntohll(fs->cookie));
985
986     ofp_print_duration(string, fs->duration_sec, fs->duration_nsec);
987     ds_put_format(string, ", table=%"PRIu8", ", fs->table_id);
988     ds_put_format(string, "n_packets=%"PRIu64", ", fs->packet_count);
989     ds_put_format(string, "n_bytes=%"PRIu64", ", fs->byte_count);
990     if (fs->idle_timeout != OFP_FLOW_PERMANENT) {
991         ds_put_format(string, "idle_timeout=%"PRIu16", ", fs->idle_timeout);
992     }
993     if (fs->hard_timeout != OFP_FLOW_PERMANENT) {
994         ds_put_format(string, "hard_timeout=%"PRIu16", ", fs->hard_timeout);
995     }
996     if (fs->idle_age >= 0) {
997         ds_put_format(string, "idle_age=%d, ", fs->idle_age);
998     }
999     if (fs->hard_age >= 0 && fs->hard_age != fs->duration_sec) {
1000         ds_put_format(string, "hard_age=%d, ", fs->hard_age);
1001     }
1002
1003     cls_rule_format(&fs->rule, string);
1004     if (string->string[string->length - 1] != ' ') {
1005         ds_put_char(string, ' ');
1006     }
1007
1008     ofpacts_format(fs->ofpacts, fs->ofpacts_len, string);
1009 }
1010
1011 static void
1012 ofp_print_flow_stats_reply(struct ds *string, const struct ofp_header *oh)
1013 {
1014     struct ofpbuf ofpacts;
1015     struct ofpbuf b;
1016
1017     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1018     ofpbuf_init(&ofpacts, 64);
1019     for (;;) {
1020         struct ofputil_flow_stats fs;
1021         int retval;
1022
1023         retval = ofputil_decode_flow_stats_reply(&fs, &b, true, &ofpacts);
1024         if (retval) {
1025             if (retval != EOF) {
1026                 ds_put_cstr(string, " ***parse error***");
1027             }
1028             break;
1029         }
1030         ds_put_char(string, '\n');
1031         ofp_print_flow_stats(string, &fs);
1032      }
1033 }
1034
1035 static void
1036 ofp_print_ofpst_aggregate_reply(struct ds *string,
1037                                 const struct ofp_aggregate_stats_reply *asr)
1038 {
1039     ds_put_format(string, " packet_count=%"PRIu64,
1040                   ntohll(get_32aligned_be64(&asr->packet_count)));
1041     ds_put_format(string, " byte_count=%"PRIu64,
1042                   ntohll(get_32aligned_be64(&asr->byte_count)));
1043     ds_put_format(string, " flow_count=%"PRIu32, ntohl(asr->flow_count));
1044 }
1045
1046 static void
1047 ofp_print_nxst_aggregate_reply(struct ds *string,
1048                                const struct nx_aggregate_stats_reply *nasr)
1049 {
1050     ds_put_format(string, " packet_count=%"PRIu64, ntohll(nasr->packet_count));
1051     ds_put_format(string, " byte_count=%"PRIu64, ntohll(nasr->byte_count));
1052     ds_put_format(string, " flow_count=%"PRIu32, ntohl(nasr->flow_count));
1053 }
1054
1055 static void print_port_stat(struct ds *string, const char *leader,
1056                             const ovs_32aligned_be64 *statp, int more)
1057 {
1058     uint64_t stat = ntohll(get_32aligned_be64(statp));
1059
1060     ds_put_cstr(string, leader);
1061     if (stat != UINT64_MAX) {
1062         ds_put_format(string, "%"PRIu64, stat);
1063     } else {
1064         ds_put_char(string, '?');
1065     }
1066     if (more) {
1067         ds_put_cstr(string, ", ");
1068     } else {
1069         ds_put_cstr(string, "\n");
1070     }
1071 }
1072
1073 static void
1074 ofp_print_ofpst_port_request(struct ds *string,
1075                              const struct ofp_port_stats_request *psr)
1076 {
1077     ds_put_format(string, " port_no=%"PRIu16, ntohs(psr->port_no));
1078 }
1079
1080 static void
1081 ofp_print_ofpst_port_reply(struct ds *string, const struct ofp_header *oh,
1082                            int verbosity)
1083 {
1084     const struct ofp_port_stats *ps = ofputil_stats_body(oh);
1085     size_t n = ofputil_stats_body_len(oh) / sizeof *ps;
1086     ds_put_format(string, " %zu ports\n", n);
1087     if (verbosity < 1) {
1088         return;
1089     }
1090
1091     for (; n--; ps++) {
1092         ds_put_format(string, "  port %2"PRIu16": ", ntohs(ps->port_no));
1093
1094         ds_put_cstr(string, "rx ");
1095         print_port_stat(string, "pkts=", &ps->rx_packets, 1);
1096         print_port_stat(string, "bytes=", &ps->rx_bytes, 1);
1097         print_port_stat(string, "drop=", &ps->rx_dropped, 1);
1098         print_port_stat(string, "errs=", &ps->rx_errors, 1);
1099         print_port_stat(string, "frame=", &ps->rx_frame_err, 1);
1100         print_port_stat(string, "over=", &ps->rx_over_err, 1);
1101         print_port_stat(string, "crc=", &ps->rx_crc_err, 0);
1102
1103         ds_put_cstr(string, "           tx ");
1104         print_port_stat(string, "pkts=", &ps->tx_packets, 1);
1105         print_port_stat(string, "bytes=", &ps->tx_bytes, 1);
1106         print_port_stat(string, "drop=", &ps->tx_dropped, 1);
1107         print_port_stat(string, "errs=", &ps->tx_errors, 1);
1108         print_port_stat(string, "coll=", &ps->collisions, 0);
1109     }
1110 }
1111
1112 static void
1113 ofp_print_ofpst_table_reply(struct ds *string, const struct ofp_header *oh,
1114                             int verbosity)
1115 {
1116     const struct ofp_table_stats *ts = ofputil_stats_body(oh);
1117     size_t n = ofputil_stats_body_len(oh) / sizeof *ts;
1118     ds_put_format(string, " %zu tables\n", n);
1119     if (verbosity < 1) {
1120         return;
1121     }
1122
1123     for (; n--; ts++) {
1124         char name[OFP_MAX_TABLE_NAME_LEN + 1];
1125         ovs_strlcpy(name, ts->name, sizeof name);
1126
1127         ds_put_format(string, "  %d: %-8s: ", ts->table_id, name);
1128         ds_put_format(string, "wild=0x%05"PRIx32", ", ntohl(ts->wildcards));
1129         ds_put_format(string, "max=%6"PRIu32", ", ntohl(ts->max_entries));
1130         ds_put_format(string, "active=%"PRIu32"\n", ntohl(ts->active_count));
1131         ds_put_cstr(string, "               ");
1132         ds_put_format(string, "lookup=%"PRIu64", ",
1133                       ntohll(get_32aligned_be64(&ts->lookup_count)));
1134         ds_put_format(string, "matched=%"PRIu64"\n",
1135                       ntohll(get_32aligned_be64(&ts->matched_count)));
1136      }
1137 }
1138
1139 static void
1140 ofp_print_queue_name(struct ds *string, uint32_t queue_id)
1141 {
1142     if (queue_id == OFPQ_ALL) {
1143         ds_put_cstr(string, "ALL");
1144     } else {
1145         ds_put_format(string, "%"PRIu32, queue_id);
1146     }
1147 }
1148
1149 static void
1150 ofp_print_ofpst_queue_request(struct ds *string,
1151                               const struct ofp_queue_stats_request *qsr)
1152 {
1153     ds_put_cstr(string, "port=");
1154     ofputil_format_port(ntohs(qsr->port_no), string);
1155
1156     ds_put_cstr(string, " queue=");
1157     ofp_print_queue_name(string, ntohl(qsr->queue_id));
1158 }
1159
1160 static void
1161 ofp_print_ofpst_queue_reply(struct ds *string, const struct ofp_header *oh,
1162                             int verbosity)
1163 {
1164     const struct ofp_queue_stats *qs = ofputil_stats_body(oh);
1165     size_t n = ofputil_stats_body_len(oh) / sizeof *qs;
1166     ds_put_format(string, " %zu queues\n", n);
1167     if (verbosity < 1) {
1168         return;
1169     }
1170
1171     for (; n--; qs++) {
1172         ds_put_cstr(string, "  port ");
1173         ofputil_format_port(ntohs(qs->port_no), string);
1174         ds_put_cstr(string, " queue ");
1175         ofp_print_queue_name(string, ntohl(qs->queue_id));
1176         ds_put_cstr(string, ": ");
1177
1178         print_port_stat(string, "bytes=", &qs->tx_bytes, 1);
1179         print_port_stat(string, "pkts=", &qs->tx_packets, 1);
1180         print_port_stat(string, "errors=", &qs->tx_errors, 0);
1181     }
1182 }
1183
1184 static void
1185 ofp_print_ofpst_port_desc_reply(struct ds *string,
1186                                 const struct ofp_header *oh)
1187 {
1188     struct ofpbuf b;
1189
1190     ofpbuf_use_const(&b, oh, ntohs(oh->length));
1191     ofpbuf_pull(&b, sizeof(struct ofp_stats_msg));
1192     ds_put_char(string, '\n');
1193     ofp_print_phy_ports(string, oh->version, &b);
1194 }
1195
1196 static void
1197 ofp_print_stats_request(struct ds *string, const struct ofp_header *oh)
1198 {
1199     const struct ofp_stats_msg *srq = (const struct ofp_stats_msg *) oh;
1200
1201     if (srq->flags) {
1202         ds_put_format(string, " ***unknown flags 0x%04"PRIx16"***",
1203                       ntohs(srq->flags));
1204     }
1205 }
1206
1207 static void
1208 ofp_print_stats_reply(struct ds *string, const struct ofp_header *oh)
1209 {
1210     const struct ofp_stats_msg *srp = (const struct ofp_stats_msg *) oh;
1211
1212     if (srp->flags) {
1213         uint16_t flags = ntohs(srp->flags);
1214
1215         ds_put_cstr(string, " flags=");
1216         if (flags & OFPSF_REPLY_MORE) {
1217             ds_put_cstr(string, "[more]");
1218             flags &= ~OFPSF_REPLY_MORE;
1219         }
1220         if (flags) {
1221             ds_put_format(string, "[***unknown flags 0x%04"PRIx16"***]",
1222                           flags);
1223         }
1224     }
1225 }
1226
1227 static void
1228 ofp_print_echo(struct ds *string, const struct ofp_header *oh, int verbosity)
1229 {
1230     size_t len = ntohs(oh->length);
1231
1232     ds_put_format(string, " %zu bytes of payload\n", len - sizeof *oh);
1233     if (verbosity > 1) {
1234         ds_put_hex_dump(string, oh + 1, len - sizeof *oh, 0, true);
1235     }
1236 }
1237
1238 static void
1239 ofp_print_nxt_role_message(struct ds *string,
1240                            const struct nx_role_request *nrr)
1241 {
1242     unsigned int role = ntohl(nrr->role);
1243
1244     ds_put_cstr(string, " role=");
1245     if (role == NX_ROLE_OTHER) {
1246         ds_put_cstr(string, "other");
1247     } else if (role == NX_ROLE_MASTER) {
1248         ds_put_cstr(string, "master");
1249     } else if (role == NX_ROLE_SLAVE) {
1250         ds_put_cstr(string, "slave");
1251     } else {
1252         ds_put_format(string, "%u", role);
1253     }
1254 }
1255
1256 static void
1257 ofp_print_nxt_flow_mod_table_id(struct ds *string,
1258                                 const struct nx_flow_mod_table_id *nfmti)
1259 {
1260     ds_put_format(string, " %s", nfmti->set ? "enable" : "disable");
1261 }
1262
1263 static void
1264 ofp_print_nxt_set_flow_format(struct ds *string,
1265                               const struct nx_set_flow_format *nsff)
1266 {
1267     uint32_t format = ntohl(nsff->format);
1268
1269     ds_put_cstr(string, " format=");
1270     if (ofputil_nx_flow_format_is_valid(format)) {
1271         ds_put_cstr(string, ofputil_nx_flow_format_to_string(format));
1272     } else {
1273         ds_put_format(string, "%"PRIu32, format);
1274     }
1275 }
1276
1277 static void
1278 ofp_print_nxt_set_packet_in_format(struct ds *string,
1279                                    const struct nx_set_packet_in_format *nspf)
1280 {
1281     uint32_t format = ntohl(nspf->format);
1282
1283     ds_put_cstr(string, " format=");
1284     if (ofputil_packet_in_format_is_valid(format)) {
1285         ds_put_cstr(string, ofputil_packet_in_format_to_string(format));
1286     } else {
1287         ds_put_format(string, "%"PRIu32, format);
1288     }
1289 }
1290
1291 static const char *
1292 ofp_port_reason_to_string(enum ofp_port_reason reason)
1293 {
1294     static char s[32];
1295
1296     switch (reason) {
1297     case OFPPR_ADD:
1298         return "add";
1299
1300     case OFPPR_DELETE:
1301         return "delete";
1302
1303     case OFPPR_MODIFY:
1304         return "modify";
1305
1306     default:
1307         sprintf(s, "%d", (int) reason);
1308         return s;
1309     }
1310 }
1311
1312 static void
1313 ofp_print_nxt_set_async_config(struct ds *string,
1314                                const struct nx_async_config *nac)
1315 {
1316     int i;
1317
1318     for (i = 0; i < 2; i++) {
1319         int j;
1320
1321         ds_put_format(string, "\n %s:\n", i == 0 ? "master" : "slave");
1322
1323         ds_put_cstr(string, "       PACKET_IN:");
1324         for (j = 0; j < 32; j++) {
1325             if (nac->packet_in_mask[i] & htonl(1u << j)) {
1326                 ds_put_format(string, " %s",
1327                               ofputil_packet_in_reason_to_string(j));
1328             }
1329         }
1330         if (!nac->packet_in_mask[i]) {
1331             ds_put_cstr(string, " (off)");
1332         }
1333         ds_put_char(string, '\n');
1334
1335         ds_put_cstr(string, "     PORT_STATUS:");
1336         for (j = 0; j < 32; j++) {
1337             if (nac->port_status_mask[i] & htonl(1u << j)) {
1338                 ds_put_format(string, " %s", ofp_port_reason_to_string(j));
1339             }
1340         }
1341         if (!nac->port_status_mask[i]) {
1342             ds_put_cstr(string, " (off)");
1343         }
1344         ds_put_char(string, '\n');
1345
1346         ds_put_cstr(string, "    FLOW_REMOVED:");
1347         for (j = 0; j < 32; j++) {
1348             if (nac->flow_removed_mask[i] & htonl(1u << j)) {
1349                 ds_put_format(string, " %s",
1350                               ofp_flow_removed_reason_to_string(j));
1351             }
1352         }
1353         if (!nac->flow_removed_mask[i]) {
1354             ds_put_cstr(string, " (off)");
1355         }
1356         ds_put_char(string, '\n');
1357     }
1358 }
1359
1360 static void
1361 ofp_print_nxt_set_controller_id(struct ds *string,
1362                                 const struct nx_controller_id *nci)
1363 {
1364     ds_put_format(string, " id=%"PRIu16, ntohs(nci->controller_id));
1365 }
1366
1367 void
1368 ofp_print_version(const struct ofp_header *oh,
1369                   struct ds *string)
1370 {
1371     switch (oh->version) {
1372     case OFP10_VERSION:
1373         break;
1374     case OFP11_VERSION:
1375         ds_put_cstr(string, " (OF1.1)");
1376         break;
1377     case OFP12_VERSION:
1378         ds_put_cstr(string, " (OF1.2)");
1379         break;
1380     default:
1381         ds_put_format(string, " (OF 0x%02"PRIx8")", oh->version);
1382         break;
1383     }
1384     ds_put_format(string, " (xid=0x%"PRIx32"):", ntohl(oh->xid));
1385 }
1386
1387 static void
1388 ofp_to_string__(const struct ofp_header *oh,
1389                 const struct ofputil_msg_type *type, struct ds *string,
1390                 int verbosity)
1391 {
1392     enum ofputil_msg_code code;
1393     const void *msg = oh;
1394
1395     ds_put_cstr(string, ofputil_msg_type_name(type));
1396     ofp_print_version(oh, string);
1397     code = ofputil_msg_type_code(type);
1398     switch (code) {
1399     case OFPUTIL_MSG_INVALID:
1400         break;
1401
1402     case OFPUTIL_OFPT_HELLO:
1403         ds_put_char(string, '\n');
1404         ds_put_hex_dump(string, oh + 1, ntohs(oh->length) - sizeof *oh,
1405                         0, true);
1406         break;
1407
1408     case OFPUTIL_OFPT_ERROR:
1409         ofp_print_error_msg(string, msg);
1410         break;
1411
1412     case OFPUTIL_OFPT_ECHO_REQUEST:
1413     case OFPUTIL_OFPT_ECHO_REPLY:
1414         ofp_print_echo(string, oh, verbosity);
1415         break;
1416
1417     case OFPUTIL_OFPT_FEATURES_REQUEST:
1418         break;
1419
1420     case OFPUTIL_OFPT_FEATURES_REPLY:
1421         ofp_print_switch_features(string, msg);
1422         break;
1423
1424     case OFPUTIL_OFPT_GET_CONFIG_REQUEST:
1425         break;
1426
1427     case OFPUTIL_OFPT_GET_CONFIG_REPLY:
1428     case OFPUTIL_OFPT_SET_CONFIG:
1429         ofp_print_switch_config(string, msg);
1430         break;
1431
1432     case OFPUTIL_OFPT_PACKET_IN:
1433     case OFPUTIL_NXT_PACKET_IN:
1434         ofp_print_packet_in(string, msg, verbosity);
1435         break;
1436
1437     case OFPUTIL_OFPT_FLOW_REMOVED:
1438     case OFPUTIL_NXT_FLOW_REMOVED:
1439         ofp_print_flow_removed(string, msg);
1440         break;
1441
1442     case OFPUTIL_OFPT_PORT_STATUS:
1443         ofp_print_port_status(string, msg);
1444         break;
1445
1446     case OFPUTIL_OFPT_PACKET_OUT:
1447         ofp_print_packet_out(string, msg, verbosity);
1448         break;
1449
1450     case OFPUTIL_OFPT_FLOW_MOD:
1451     case OFPUTIL_NXT_FLOW_MOD:
1452         ofp_print_flow_mod(string, msg, code, verbosity);
1453         break;
1454
1455     case OFPUTIL_OFPT_PORT_MOD:
1456         ofp_print_port_mod(string, msg);
1457         break;
1458
1459     case OFPUTIL_OFPT_BARRIER_REQUEST:
1460     case OFPUTIL_OFPT_BARRIER_REPLY:
1461         break;
1462
1463     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST:
1464     case OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY:
1465         /* XXX */
1466         break;
1467
1468     case OFPUTIL_OFPST_DESC_REQUEST:
1469     case OFPUTIL_OFPST_PORT_DESC_REQUEST:
1470         ofp_print_stats_request(string, oh);
1471         break;
1472
1473     case OFPUTIL_OFPST_FLOW_REQUEST:
1474     case OFPUTIL_NXST_FLOW_REQUEST:
1475     case OFPUTIL_OFPST_AGGREGATE_REQUEST:
1476     case OFPUTIL_NXST_AGGREGATE_REQUEST:
1477         ofp_print_stats_request(string, oh);
1478         ofp_print_flow_stats_request(string, msg);
1479         break;
1480
1481     case OFPUTIL_OFPST_TABLE_REQUEST:
1482         ofp_print_stats_request(string, oh);
1483         break;
1484
1485     case OFPUTIL_OFPST_PORT_REQUEST:
1486         ofp_print_stats_request(string, oh);
1487         ofp_print_ofpst_port_request(string, msg);
1488         break;
1489
1490     case OFPUTIL_OFPST_QUEUE_REQUEST:
1491         ofp_print_stats_request(string, oh);
1492         ofp_print_ofpst_queue_request(string, msg);
1493         break;
1494
1495     case OFPUTIL_OFPST_DESC_REPLY:
1496         ofp_print_stats_reply(string, oh);
1497         ofp_print_ofpst_desc_reply(string, msg);
1498         break;
1499
1500     case OFPUTIL_OFPST_FLOW_REPLY:
1501     case OFPUTIL_NXST_FLOW_REPLY:
1502         ofp_print_stats_reply(string, oh);
1503         ofp_print_flow_stats_reply(string, oh);
1504         break;
1505
1506     case OFPUTIL_OFPST_QUEUE_REPLY:
1507         ofp_print_stats_reply(string, oh);
1508         ofp_print_ofpst_queue_reply(string, oh, verbosity);
1509         break;
1510
1511     case OFPUTIL_OFPST_PORT_REPLY:
1512         ofp_print_stats_reply(string, oh);
1513         ofp_print_ofpst_port_reply(string, oh, verbosity);
1514         break;
1515
1516     case OFPUTIL_OFPST_TABLE_REPLY:
1517         ofp_print_stats_reply(string, oh);
1518         ofp_print_ofpst_table_reply(string, oh, verbosity);
1519         break;
1520
1521     case OFPUTIL_OFPST_AGGREGATE_REPLY:
1522         ofp_print_stats_reply(string, oh);
1523         ofp_print_ofpst_aggregate_reply(string, msg);
1524         break;
1525
1526     case OFPUTIL_OFPST_PORT_DESC_REPLY:
1527         ofp_print_stats_reply(string, oh);
1528         ofp_print_ofpst_port_desc_reply(string, oh);
1529         break;
1530
1531     case OFPUTIL_NXT_ROLE_REQUEST:
1532     case OFPUTIL_NXT_ROLE_REPLY:
1533         ofp_print_nxt_role_message(string, msg);
1534         break;
1535
1536     case OFPUTIL_NXT_FLOW_MOD_TABLE_ID:
1537         ofp_print_nxt_flow_mod_table_id(string, msg);
1538         break;
1539
1540     case OFPUTIL_NXT_SET_FLOW_FORMAT:
1541         ofp_print_nxt_set_flow_format(string, msg);
1542         break;
1543
1544     case OFPUTIL_NXT_SET_PACKET_IN_FORMAT:
1545         ofp_print_nxt_set_packet_in_format(string, msg);
1546         break;
1547
1548     case OFPUTIL_NXT_FLOW_AGE:
1549         break;
1550
1551     case OFPUTIL_NXT_SET_CONTROLLER_ID:
1552         ofp_print_nxt_set_controller_id(string, msg);
1553         break;
1554
1555     case OFPUTIL_NXT_SET_ASYNC_CONFIG:
1556         ofp_print_nxt_set_async_config(string, msg);
1557         break;
1558
1559     case OFPUTIL_NXST_AGGREGATE_REPLY:
1560         ofp_print_stats_reply(string, oh);
1561         ofp_print_nxst_aggregate_reply(string, msg);
1562         break;
1563     }
1564 }
1565
1566 /* Composes and returns a string representing the OpenFlow packet of 'len'
1567  * bytes at 'oh' at the given 'verbosity' level.  0 is a minimal amount of
1568  * verbosity and higher numbers increase verbosity.  The caller is responsible
1569  * for freeing the string. */
1570 char *
1571 ofp_to_string(const void *oh_, size_t len, int verbosity)
1572 {
1573     struct ds string = DS_EMPTY_INITIALIZER;
1574     const struct ofp_header *oh = oh_;
1575
1576     if (!len) {
1577         ds_put_cstr(&string, "OpenFlow message is empty\n");
1578     } else if (len < sizeof(struct ofp_header)) {
1579         ds_put_format(&string, "OpenFlow packet too short (only %zu bytes):\n",
1580                       len);
1581     } else if (ntohs(oh->length) > len) {
1582         ds_put_format(&string,
1583                       "(***truncated to %zu bytes from %"PRIu16"***)\n",
1584                       len, ntohs(oh->length));
1585     } else if (ntohs(oh->length) < len) {
1586         ds_put_format(&string,
1587                       "(***only uses %"PRIu16" bytes out of %zu***)\n",
1588                       ntohs(oh->length), len);
1589     } else {
1590         const struct ofputil_msg_type *type;
1591         enum ofperr error;
1592
1593         error = ofputil_decode_msg_type(oh, &type);
1594         if (!error) {
1595             ofp_to_string__(oh, type, &string, verbosity);
1596             if (verbosity >= 5) {
1597                 if (ds_last(&string) != '\n') {
1598                     ds_put_char(&string, '\n');
1599                 }
1600                 ds_put_hex_dump(&string, oh, len, 0, true);
1601             }
1602             if (ds_last(&string) != '\n') {
1603                 ds_put_char(&string, '\n');
1604             }
1605             return ds_steal_cstr(&string);
1606         }
1607
1608         ofp_print_error(&string, error);
1609     }
1610     ds_put_hex_dump(&string, oh, len, 0, true);
1611     return ds_steal_cstr(&string);
1612 }
1613 \f
1614 static void
1615 print_and_free(FILE *stream, char *string)
1616 {
1617     fputs(string, stream);
1618     free(string);
1619 }
1620
1621 /* Pretty-print the OpenFlow packet of 'len' bytes at 'oh' to 'stream' at the
1622  * given 'verbosity' level.  0 is a minimal amount of verbosity and higher
1623  * numbers increase verbosity. */
1624 void
1625 ofp_print(FILE *stream, const void *oh, size_t len, int verbosity)
1626 {
1627     print_and_free(stream, ofp_to_string(oh, len, verbosity));
1628 }
1629
1630 /* Dumps the contents of the Ethernet frame in the 'len' bytes starting at
1631  * 'data' to 'stream'. */
1632 void
1633 ofp_print_packet(FILE *stream, const void *data, size_t len)
1634 {
1635     print_and_free(stream, ofp_packet_to_string(data, len));
1636 }