2 * This module implements decoding of OpenFlow protocol version 1.0 (wire
3 * protocol 0x01). The decoder implements terse (default), detailed (-v) and
4 * full (-vv) output formats and, as much as each format implies, detects and
5 * tries to work around sizing anomalies inside the messages. The decoder marks
6 * up bogus values of selected message fields and decodes partially captured
7 * messages up to the snapshot end. It is based on the specification below:
9 * [OF10] http://www.openflow.org/documents/openflow-spec-v1.0.0.pdf
11 * Decoding of Ethernet frames nested in OFPT_PACKET_IN and OFPT_PACKET_OUT
12 * messages is done only when the verbosity level set by command-line argument
13 * is "-vvv" or higher. In that case the verbosity level is temporarily
14 * decremented by 3 during the nested frame decoding. For example, running
15 * tcpdump with "-vvvv" will do full decoding of OpenFlow and "-v" decoding of
19 * Copyright (c) 2013 The TCPDUMP project
20 * All rights reserved.
22 * Redistribution and use in source and binary forms, with or without
23 * modification, are permitted provided that the following conditions
25 * 1. Redistributions of source code must retain the above copyright
26 * notice, this list of conditions and the following disclaimer.
27 * 2. Redistributions in binary form must reproduce the above copyright
28 * notice, this list of conditions and the following disclaimer in the
29 * documentation and/or other materials provided with the distribution.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
34 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
35 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
36 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
37 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
38 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
39 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
40 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
41 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGE.
49 #include <tcpdump-stdinc.h>
51 #include "interface.h"
53 #include "addrtoname.h"
55 #include "ethertype.h"
59 #define OFPT_HELLO 0x00
60 #define OFPT_ERROR 0x01
61 #define OFPT_ECHO_REQUEST 0x02
62 #define OFPT_ECHO_REPLY 0x03
63 #define OFPT_VENDOR 0x04
64 #define OFPT_FEATURES_REQUEST 0x05
65 #define OFPT_FEATURES_REPLY 0x06
66 #define OFPT_GET_CONFIG_REQUEST 0x07
67 #define OFPT_GET_CONFIG_REPLY 0x08
68 #define OFPT_SET_CONFIG 0x09
69 #define OFPT_PACKET_IN 0x0a
70 #define OFPT_FLOW_REMOVED 0x0b
71 #define OFPT_PORT_STATUS 0x0c
72 #define OFPT_PACKET_OUT 0x0d
73 #define OFPT_FLOW_MOD 0x0e
74 #define OFPT_PORT_MOD 0x0f
75 #define OFPT_STATS_REQUEST 0x10
76 #define OFPT_STATS_REPLY 0x11
77 #define OFPT_BARRIER_REQUEST 0x12
78 #define OFPT_BARRIER_REPLY 0x13
79 #define OFPT_QUEUE_GET_CONFIG_REQUEST 0x14
80 #define OFPT_QUEUE_GET_CONFIG_REPLY 0x15
81 static const struct tok ofpt_str
[] = {
82 { OFPT_HELLO
, "HELLO" },
83 { OFPT_ERROR
, "ERROR" },
84 { OFPT_ECHO_REQUEST
, "ECHO_REQUEST" },
85 { OFPT_ECHO_REPLY
, "ECHO_REPLY" },
86 { OFPT_VENDOR
, "VENDOR" },
87 { OFPT_FEATURES_REQUEST
, "FEATURES_REQUEST" },
88 { OFPT_FEATURES_REPLY
, "FEATURES_REPLY" },
89 { OFPT_GET_CONFIG_REQUEST
, "GET_CONFIG_REQUEST" },
90 { OFPT_GET_CONFIG_REPLY
, "GET_CONFIG_REPLY" },
91 { OFPT_SET_CONFIG
, "SET_CONFIG" },
92 { OFPT_PACKET_IN
, "PACKET_IN" },
93 { OFPT_FLOW_REMOVED
, "FLOW_REMOVED" },
94 { OFPT_PORT_STATUS
, "PORT_STATUS" },
95 { OFPT_PACKET_OUT
, "PACKET_OUT" },
96 { OFPT_FLOW_MOD
, "FLOW_MOD" },
97 { OFPT_PORT_MOD
, "PORT_MOD" },
98 { OFPT_STATS_REQUEST
, "STATS_REQUEST" },
99 { OFPT_STATS_REPLY
, "STATS_REPLY" },
100 { OFPT_BARRIER_REQUEST
, "BARRIER_REQUEST" },
101 { OFPT_BARRIER_REPLY
, "BARRIER_REPLY" },
102 { OFPT_QUEUE_GET_CONFIG_REQUEST
, "QUEUE_GET_CONFIG_REQUEST" },
103 { OFPT_QUEUE_GET_CONFIG_REPLY
, "QUEUE_GET_CONFIG_REPLY" },
107 #define OFPPC_PORT_DOWN (1 << 0)
108 #define OFPPC_NO_STP (1 << 1)
109 #define OFPPC_NO_RECV (1 << 2)
110 #define OFPPC_NO_RECV_STP (1 << 3)
111 #define OFPPC_NO_FLOOD (1 << 4)
112 #define OFPPC_NO_FWD (1 << 5)
113 #define OFPPC_NO_PACKET_IN (1 << 6)
114 static const struct tok ofppc_bm
[] = {
115 { OFPPC_PORT_DOWN
, "PORT_DOWN" },
116 { OFPPC_NO_STP
, "NO_STP" },
117 { OFPPC_NO_RECV
, "NO_RECV" },
118 { OFPPC_NO_RECV_STP
, "NO_RECV_STP" },
119 { OFPPC_NO_FLOOD
, "NO_FLOOD" },
120 { OFPPC_NO_FWD
, "NO_FWD" },
121 { OFPPC_NO_PACKET_IN
, "NO_PACKET_IN" },
124 #define OFPPC_U (~(OFPPC_PORT_DOWN | OFPPC_NO_STP | OFPPC_NO_RECV | \
125 OFPPC_NO_RECV_STP | OFPPC_NO_FLOOD | OFPPC_NO_FWD | \
128 #define OFPPS_LINK_DOWN (1 << 0)
129 #define OFPPS_STP_LISTEN (0 << 8)
130 #define OFPPS_STP_LEARN (1 << 8)
131 #define OFPPS_STP_FORWARD (2 << 8)
132 #define OFPPS_STP_BLOCK (3 << 8)
133 #define OFPPS_STP_MASK (3 << 8)
134 static const struct tok ofpps_bm
[] = {
135 { OFPPS_LINK_DOWN
, "LINK_DOWN" },
136 { OFPPS_STP_LISTEN
, "STP_LISTEN" },
137 { OFPPS_STP_LEARN
, "STP_LEARN" },
138 { OFPPS_STP_FORWARD
, "STP_FORWARD" },
139 { OFPPS_STP_BLOCK
, "STP_BLOCK" },
142 #define OFPPS_U (~(OFPPS_LINK_DOWN | OFPPS_STP_LISTEN | OFPPS_STP_LEARN | \
143 OFPPS_STP_FORWARD | OFPPS_STP_BLOCK))
145 #define OFPP_MAX 0xff00
146 #define OFPP_IN_PORT 0xfff8
147 #define OFPP_TABLE 0xfff9
148 #define OFPP_NORMAL 0xfffa
149 #define OFPP_FLOOD 0xfffb
150 #define OFPP_ALL 0xfffc
151 #define OFPP_CONTROLLER 0xfffd
152 #define OFPP_LOCAL 0xfffe
153 #define OFPP_NONE 0xffff
154 static const struct tok ofpp_str
[] = {
156 { OFPP_IN_PORT
, "IN_PORT" },
157 { OFPP_TABLE
, "TABLE" },
158 { OFPP_NORMAL
, "NORMAL" },
159 { OFPP_FLOOD
, "FLOOD" },
161 { OFPP_CONTROLLER
, "CONTROLLER" },
162 { OFPP_LOCAL
, "LOCAL" },
163 { OFPP_NONE
, "NONE" },
167 #define OFPPF_10MB_HD (1 << 0)
168 #define OFPPF_10MB_FD (1 << 1)
169 #define OFPPF_100MB_HD (1 << 2)
170 #define OFPPF_100MB_FD (1 << 3)
171 #define OFPPF_1GB_HD (1 << 4)
172 #define OFPPF_1GB_FD (1 << 5)
173 #define OFPPF_10GB_FD (1 << 6)
174 #define OFPPF_COPPER (1 << 7)
175 #define OFPPF_FIBER (1 << 8)
176 #define OFPPF_AUTONEG (1 << 9)
177 #define OFPPF_PAUSE (1 << 10)
178 #define OFPPF_PAUSE_ASYM (1 << 11)
179 static const struct tok ofppf_bm
[] = {
180 { OFPPF_10MB_HD
, "10MB_HD" },
181 { OFPPF_10MB_FD
, "10MB_FD" },
182 { OFPPF_100MB_HD
, "100MB_HD" },
183 { OFPPF_100MB_FD
, "100MB_FD" },
184 { OFPPF_1GB_HD
, "1GB_HD" },
185 { OFPPF_1GB_FD
, "1GB_FD" },
186 { OFPPF_10GB_FD
, "10GB_FD" },
187 { OFPPF_COPPER
, "COPPER" },
188 { OFPPF_FIBER
, "FIBER" },
189 { OFPPF_AUTONEG
, "AUTONEG" },
190 { OFPPF_PAUSE
, "PAUSE" },
191 { OFPPF_PAUSE_ASYM
, "PAUSE_ASYM" },
194 #define OFPPF_U (~(OFPPF_10MB_HD | OFPPF_10MB_FD | OFPPF_100MB_HD | \
195 OFPPF_100MB_FD | OFPPF_1GB_HD | OFPPF_1GB_FD | \
196 OFPPF_10GB_FD | OFPPF_COPPER | OFPPF_FIBER | \
197 OFPPF_AUTONEG | OFPPF_PAUSE | OFPPF_PAUSE_ASYM))
199 #define OFPQT_NONE 0x0000
200 #define OFPQT_MIN_RATE 0x0001
201 static const struct tok ofpqt_str
[] = {
202 { OFPQT_NONE
, "NONE" },
203 { OFPQT_MIN_RATE
, "MIN_RATE" },
207 #define OFPFW_IN_PORT (1 << 0)
208 #define OFPFW_DL_VLAN (1 << 1)
209 #define OFPFW_DL_SRC (1 << 2)
210 #define OFPFW_DL_DST (1 << 3)
211 #define OFPFW_DL_TYPE (1 << 4)
212 #define OFPFW_NW_PROTO (1 << 5)
213 #define OFPFW_TP_SRC (1 << 6)
214 #define OFPFW_TP_DST (1 << 7)
215 #define OFPFW_NW_SRC_SHIFT 8
216 #define OFPFW_NW_SRC_BITS 6
217 #define OFPFW_NW_SRC_MASK (((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT)
218 #define OFPFW_NW_DST_SHIFT 14
219 #define OFPFW_NW_DST_BITS 6
220 #define OFPFW_NW_DST_MASK (((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT)
221 #define OFPFW_DL_VLAN_PCP (1 << 20)
222 #define OFPFW_NW_TOS (1 << 21)
223 #define OFPFW_ALL ((1 << 22) - 1)
224 static const struct tok ofpfw_bm
[] = {
225 { OFPFW_IN_PORT
, "IN_PORT" },
226 { OFPFW_DL_VLAN
, "DL_VLAN" },
227 { OFPFW_DL_SRC
, "DL_SRC" },
228 { OFPFW_DL_DST
, "DL_DST" },
229 { OFPFW_DL_TYPE
, "DL_TYPE" },
230 { OFPFW_NW_PROTO
, "NW_PROTO" },
231 { OFPFW_TP_SRC
, "TP_SRC" },
232 { OFPFW_TP_DST
, "TP_DST" },
233 { OFPFW_DL_VLAN_PCP
, "DL_VLAN_PCP" },
234 { OFPFW_NW_TOS
, "NW_TOS" },
237 /* The above array does not include bits 8~13 (OFPFW_NW_SRC_*) and 14~19
238 * (OFPFW_NW_DST_*), which are not a part of the bitmap and require decoding
239 * other than that of tok2str(). The macro below includes these bits such that
240 * they are not reported as bogus in the decoding. */
241 #define OFPFW_U (~(OFPFW_ALL))
243 #define OFPAT_OUTPUT 0x0000
244 #define OFPAT_SET_VLAN_VID 0x0001
245 #define OFPAT_SET_VLAN_PCP 0x0002
246 #define OFPAT_STRIP_VLAN 0x0003
247 #define OFPAT_SET_DL_SRC 0x0004
248 #define OFPAT_SET_DL_DST 0x0005
249 #define OFPAT_SET_NW_SRC 0x0006
250 #define OFPAT_SET_NW_DST 0x0007
251 #define OFPAT_SET_NW_TOS 0x0008
252 #define OFPAT_SET_TP_SRC 0x0009
253 #define OFPAT_SET_TP_DST 0x000a
254 #define OFPAT_ENQUEUE 0x000b
255 #define OFPAT_VENDOR 0xffff
256 static const struct tok ofpat_str
[] = {
257 { OFPAT_OUTPUT
, "OUTPUT" },
258 { OFPAT_SET_VLAN_VID
, "SET_VLAN_VID" },
259 { OFPAT_SET_VLAN_PCP
, "SET_VLAN_PCP" },
260 { OFPAT_STRIP_VLAN
, "STRIP_VLAN" },
261 { OFPAT_SET_DL_SRC
, "SET_DL_SRC" },
262 { OFPAT_SET_DL_DST
, "SET_DL_DST" },
263 { OFPAT_SET_NW_SRC
, "SET_NW_SRC" },
264 { OFPAT_SET_NW_DST
, "SET_NW_DST" },
265 { OFPAT_SET_NW_TOS
, "SET_NW_TOS" },
266 { OFPAT_SET_TP_SRC
, "SET_TP_SRC" },
267 { OFPAT_SET_TP_DST
, "SET_TP_DST" },
268 { OFPAT_ENQUEUE
, "ENQUEUE" },
269 { OFPAT_VENDOR
, "VENDOR" },
273 /* bit-shifted, w/o vendor action */
274 static const struct tok ofpat_bm
[] = {
275 { 1 << OFPAT_OUTPUT
, "OUTPUT" },
276 { 1 << OFPAT_SET_VLAN_VID
, "SET_VLAN_VID" },
277 { 1 << OFPAT_SET_VLAN_PCP
, "SET_VLAN_PCP" },
278 { 1 << OFPAT_STRIP_VLAN
, "STRIP_VLAN" },
279 { 1 << OFPAT_SET_DL_SRC
, "SET_DL_SRC" },
280 { 1 << OFPAT_SET_DL_DST
, "SET_DL_DST" },
281 { 1 << OFPAT_SET_NW_SRC
, "SET_NW_SRC" },
282 { 1 << OFPAT_SET_NW_DST
, "SET_NW_DST" },
283 { 1 << OFPAT_SET_NW_TOS
, "SET_NW_TOS" },
284 { 1 << OFPAT_SET_TP_SRC
, "SET_TP_SRC" },
285 { 1 << OFPAT_SET_TP_DST
, "SET_TP_DST" },
286 { 1 << OFPAT_ENQUEUE
, "ENQUEUE" },
289 #define OFPAT_U (~(1 << OFPAT_OUTPUT | 1 << OFPAT_SET_VLAN_VID | \
290 1 << OFPAT_SET_VLAN_PCP | 1 << OFPAT_STRIP_VLAN | \
291 1 << OFPAT_SET_DL_SRC | 1 << OFPAT_SET_DL_DST | \
292 1 << OFPAT_SET_NW_SRC | 1 << OFPAT_SET_NW_DST | \
293 1 << OFPAT_SET_NW_TOS | 1 << OFPAT_SET_TP_SRC | \
294 1 << OFPAT_SET_TP_DST | 1 << OFPAT_ENQUEUE))
296 #define OFPC_FLOW_STATS (1 << 0)
297 #define OFPC_TABLE_STATS (1 << 1)
298 #define OFPC_PORT_STATS (1 << 2)
299 #define OFPC_STP (1 << 3)
300 #define OFPC_RESERVED (1 << 4)
301 #define OFPC_IP_REASM (1 << 5)
302 #define OFPC_QUEUE_STATS (1 << 6)
303 #define OFPC_ARP_MATCH_IP (1 << 7)
304 static const struct tok ofp_capabilities_bm
[] = {
305 { OFPC_FLOW_STATS
, "FLOW_STATS" },
306 { OFPC_TABLE_STATS
, "TABLE_STATS" },
307 { OFPC_PORT_STATS
, "PORT_STATS" },
309 { OFPC_RESERVED
, "RESERVED" }, /* not in the mask below */
310 { OFPC_IP_REASM
, "IP_REASM" },
311 { OFPC_QUEUE_STATS
, "QUEUE_STATS" },
312 { OFPC_ARP_MATCH_IP
, "ARP_MATCH_IP" },
315 #define OFPCAP_U (~(OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
316 OFPC_STP | OFPC_IP_REASM | OFPC_QUEUE_STATS | \
319 #define OFPC_FRAG_NORMAL 0x0000
320 #define OFPC_FRAG_DROP 0x0001
321 #define OFPC_FRAG_REASM 0x0002
322 #define OFPC_FRAG_MASK 0x0003
323 static const struct tok ofp_config_str
[] = {
324 { OFPC_FRAG_NORMAL
, "FRAG_NORMAL" },
325 { OFPC_FRAG_DROP
, "FRAG_DROP" },
326 { OFPC_FRAG_REASM
, "FRAG_REASM" },
330 #define OFPFC_ADD 0x0000
331 #define OFPFC_MODIFY 0x0001
332 #define OFPFC_MODIFY_STRICT 0x0002
333 #define OFPFC_DELETE 0x0003
334 #define OFPFC_DELETE_STRICT 0x0004
335 static const struct tok ofpfc_str
[] = {
336 { OFPFC_ADD
, "ADD" },
337 { OFPFC_MODIFY
, "MODIFY" },
338 { OFPFC_MODIFY_STRICT
, "MODIFY_STRICT" },
339 { OFPFC_DELETE
, "DELETE" },
340 { OFPFC_DELETE_STRICT
, "DELETE_STRICT" },
344 static const struct tok bufferid_str
[] = {
345 { 0xffffffff, "NONE" },
349 #define OFPFF_SEND_FLOW_REM (1 << 0)
350 #define OFPFF_CHECK_OVERLAP (1 << 1)
351 #define OFPFF_EMERG (1 << 2)
352 static const struct tok ofpff_bm
[] = {
353 { OFPFF_SEND_FLOW_REM
, "SEND_FLOW_REM" },
354 { OFPFF_CHECK_OVERLAP
, "CHECK_OVERLAP" },
355 { OFPFF_EMERG
, "EMERG" },
358 #define OFPFF_U (~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF_EMERG))
360 #define OFPST_DESC 0x0000
361 #define OFPST_FLOW 0x0001
362 #define OFPST_AGGREGATE 0x0002
363 #define OFPST_TABLE 0x0003
364 #define OFPST_PORT 0x0004
365 #define OFPST_QUEUE 0x0005
366 #define OFPST_VENDOR 0xffff
367 static const struct tok ofpst_str
[] = {
368 { OFPST_DESC
, "DESC" },
369 { OFPST_FLOW
, "FLOW" },
370 { OFPST_AGGREGATE
, "AGGREGATE" },
371 { OFPST_TABLE
, "TABLE" },
372 { OFPST_PORT
, "PORT" },
373 { OFPST_QUEUE
, "QUEUE" },
374 { OFPST_VENDOR
, "VENDOR" },
378 static const struct tok tableid_str
[] = {
384 #define OFPQ_ALL 0xffffffff
385 static const struct tok ofpq_str
[] = {
390 #define OFPSF_REPLY_MORE 0x0001
391 static const struct tok ofpsf_reply_bm
[] = {
392 { OFPSF_REPLY_MORE
, "MORE" },
395 #define OFPSF_REPLY_U (~(OFPSF_REPLY_MORE))
397 #define OFPR_NO_MATCH 0x00
398 #define OFPR_ACTION 0x01
399 static const struct tok ofpr_str
[] = {
400 { OFPR_NO_MATCH
, "NO_MATCH" },
401 { OFPR_ACTION
, "ACTION" },
405 #define OFPRR_IDLE_TIMEOUT 0x00
406 #define OFPRR_HARD_TIMEOUT 0x01
407 #define OFPRR_DELETE 0x02
408 static const struct tok ofprr_str
[] = {
409 { OFPRR_IDLE_TIMEOUT
, "IDLE_TIMEOUT" },
410 { OFPRR_HARD_TIMEOUT
, "HARD_TIMEOUT" },
411 { OFPRR_DELETE
, "DELETE" },
415 #define OFPPR_ADD 0x00
416 #define OFPPR_DELETE 0x01
417 #define OFPPR_MODIFY 0x02
418 static const struct tok ofppr_str
[] = {
419 { OFPPR_ADD
, "ADD" },
420 { OFPPR_DELETE
, "DELETE" },
421 { OFPPR_MODIFY
, "MODIFY" },
425 #define OFPET_HELLO_FAILED 0x0000
426 #define OFPET_BAD_REQUEST 0x0001
427 #define OFPET_BAD_ACTION 0x0002
428 #define OFPET_FLOW_MOD_FAILED 0x0003
429 #define OFPET_PORT_MOD_FAILED 0x0004
430 #define OFPET_QUEUE_OP_FAILED 0x0005
431 static const struct tok ofpet_str
[] = {
432 { OFPET_HELLO_FAILED
, "HELLO_FAILED" },
433 { OFPET_BAD_REQUEST
, "BAD_REQUEST" },
434 { OFPET_BAD_ACTION
, "BAD_ACTION" },
435 { OFPET_FLOW_MOD_FAILED
, "FLOW_MOD_FAILED" },
436 { OFPET_PORT_MOD_FAILED
, "PORT_MOD_FAILED" },
437 { OFPET_QUEUE_OP_FAILED
, "QUEUE_OP_FAILED" },
441 #define OFPHFC_INCOMPATIBLE 0x0000
442 #define OFPHFC_EPERM 0x0001
443 static const struct tok ofphfc_str
[] = {
444 { OFPHFC_INCOMPATIBLE
, "INCOMPATIBLE" },
445 { OFPHFC_EPERM
, "EPERM" },
449 #define OFPBRC_BAD_VERSION 0x0000
450 #define OFPBRC_BAD_TYPE 0x0001
451 #define OFPBRC_BAD_STAT 0x0002
452 #define OFPBRC_BAD_VENDOR 0x0003
453 #define OFPBRC_BAD_SUBTYPE 0x0004
454 #define OFPBRC_EPERM 0x0005
455 #define OFPBRC_BAD_LEN 0x0006
456 #define OFPBRC_BUFFER_EMPTY 0x0007
457 #define OFPBRC_BUFFER_UNKNOWN 0x0008
458 static const struct tok ofpbrc_str
[] = {
459 { OFPBRC_BAD_VERSION
, "BAD_VERSION" },
460 { OFPBRC_BAD_TYPE
, "BAD_TYPE" },
461 { OFPBRC_BAD_STAT
, "BAD_STAT" },
462 { OFPBRC_BAD_VENDOR
, "BAD_VENDOR" },
463 { OFPBRC_BAD_SUBTYPE
, "BAD_SUBTYPE" },
464 { OFPBRC_EPERM
, "EPERM" },
465 { OFPBRC_BAD_LEN
, "BAD_LEN" },
466 { OFPBRC_BUFFER_EMPTY
, "BUFFER_EMPTY" },
467 { OFPBRC_BUFFER_UNKNOWN
, "BUFFER_UNKNOWN" },
471 #define OFPBAC_BAD_TYPE 0x0000
472 #define OFPBAC_BAD_LEN 0x0001
473 #define OFPBAC_BAD_VENDOR 0x0002
474 #define OFPBAC_BAD_VENDOR_TYPE 0x0003
475 #define OFPBAC_BAD_OUT_PORT 0x0004
476 #define OFPBAC_BAD_ARGUMENT 0x0005
477 #define OFPBAC_EPERM 0x0006
478 #define OFPBAC_TOO_MANY 0x0007
479 #define OFPBAC_BAD_QUEUE 0x0008
480 static const struct tok ofpbac_str
[] = {
481 { OFPBAC_BAD_TYPE
, "BAD_TYPE" },
482 { OFPBAC_BAD_LEN
, "BAD_LEN" },
483 { OFPBAC_BAD_VENDOR
, "BAD_VENDOR" },
484 { OFPBAC_BAD_VENDOR_TYPE
, "BAD_VENDOR_TYPE" },
485 { OFPBAC_BAD_OUT_PORT
, "BAD_OUT_PORT" },
486 { OFPBAC_BAD_ARGUMENT
, "BAD_ARGUMENT" },
487 { OFPBAC_EPERM
, "EPERM" },
488 { OFPBAC_TOO_MANY
, "TOO_MANY" },
489 { OFPBAC_BAD_QUEUE
, "BAD_QUEUE" },
493 #define OFPFMFC_ALL_TABLES_FULL 0x0000
494 #define OFPFMFC_OVERLAP 0x0001
495 #define OFPFMFC_EPERM 0x0002
496 #define OFPFMFC_BAD_EMERG_TIMEOUT 0x0003
497 #define OFPFMFC_BAD_COMMAND 0x0004
498 #define OFPFMFC_UNSUPPORTED 0x0005
499 static const struct tok ofpfmfc_str
[] = {
500 { OFPFMFC_ALL_TABLES_FULL
, "ALL_TABLES_FULL" },
501 { OFPFMFC_OVERLAP
, "OVERLAP" },
502 { OFPFMFC_EPERM
, "EPERM" },
503 { OFPFMFC_BAD_EMERG_TIMEOUT
, "BAD_EMERG_TIMEOUT" },
504 { OFPFMFC_BAD_COMMAND
, "BAD_COMMAND" },
505 { OFPFMFC_UNSUPPORTED
, "UNSUPPORTED" },
509 #define OFPPMFC_BAD_PORT 0x0000
510 #define OFPPMFC_BAD_HW_ADDR 0x0001
511 static const struct tok ofppmfc_str
[] = {
512 { OFPPMFC_BAD_PORT
, "BAD_PORT" },
513 { OFPPMFC_BAD_HW_ADDR
, "BAD_HW_ADDR" },
517 #define OFPQOFC_BAD_PORT 0x0000
518 #define OFPQOFC_BAD_QUEUE 0x0001
519 #define OFPQOFC_EPERM 0x0002
520 static const struct tok ofpqofc_str
[] = {
521 { OFPQOFC_BAD_PORT
, "BAD_PORT" },
522 { OFPQOFC_BAD_QUEUE
, "BAD_QUEUE" },
523 { OFPQOFC_EPERM
, "EPERM" },
527 static const struct tok empty_str
[] = {
531 /* lengths (fixed or minimal) of particular protocol structures */
532 #define OF_SWITCH_CONFIG_LEN 12
533 #define OF_PHY_PORT_LEN 48
534 #define OF_SWITCH_FEATURES_LEN 32
535 #define OF_PORT_STATUS_LEN 64
536 #define OF_PORT_MOD_LEN 32
537 #define OF_PACKET_IN_LEN 20
538 #define OF_ACTION_OUTPUT_LEN 8
539 #define OF_ACTION_VLAN_VID_LEN 8
540 #define OF_ACTION_VLAN_PCP_LEN 8
541 #define OF_ACTION_DL_ADDR_LEN 16
542 #define OF_ACTION_NW_ADDR_LEN 8
543 #define OF_ACTION_TP_PORT_LEN 8
544 #define OF_ACTION_NW_TOS_LEN 8
545 #define OF_ACTION_VENDOR_HEADER_LEN 8
546 #define OF_ACTION_HEADER_LEN 8
547 #define OF_PACKET_OUT_LEN 16
548 #define OF_MATCH_LEN 40
549 #define OF_FLOW_MOD_LEN 72
550 #define OF_FLOW_REMOVED_LEN 88
551 #define OF_ERROR_MSG_LEN 12
552 #define OF_STATS_REQUEST_LEN 12
553 #define OF_STATS_REPLY_LEN 12
554 #define OF_DESC_STATS_LEN 1056
555 #define OF_FLOW_STATS_REQUEST_LEN 44
556 #define OF_FLOW_STATS_LEN 88
557 #define OF_AGGREGATE_STATS_REQUEST_LEN 44
558 #define OF_AGGREGATE_STATS_REPLY_LEN 24
559 #define OF_TABLE_STATS_LEN 64
560 #define OF_PORT_STATS_REQUEST_LEN 8
561 #define OF_PORT_STATS_LEN 104
562 #define OF_VENDOR_HEADER_LEN 12
563 #define OF_QUEUE_PROP_HEADER_LEN 8
564 #define OF_QUEUE_PROP_MIN_RATE_LEN 16
565 #define OF_PACKET_QUEUE_LEN 8
566 #define OF_QUEUE_GET_CONFIG_REQUEST_LEN 12
567 #define OF_QUEUE_GET_CONFIG_REPLY_LEN 16
568 #define OF_ACTION_ENQUEUE_LEN 16
569 #define OF_QUEUE_STATS_REQUEST_LEN 8
570 #define OF_QUEUE_STATS_LEN 32
572 /* miscellaneous constants from [OF10] */
573 #define OFP_MAX_TABLE_NAME_LEN 32
574 #define OFP_MAX_PORT_NAME_LEN 16
575 #define DESC_STR_LEN 256
576 #define SERIAL_NUM_LEN 32
577 #define OFP_VLAN_NONE 0xffff
580 vlan_str(const uint16_t vid
) {
581 static char buf
[sizeof("65535 (bogus)")];
584 if (vid
== OFP_VLAN_NONE
)
586 fmt
= (vid
> 0 && vid
< 0x0fff) ? "%u" : "%u (bogus)";
587 snprintf(buf
, sizeof(buf
), fmt
, vid
);
592 pcp_str(const uint8_t pcp
) {
593 static char buf
[sizeof("255 (bogus)")];
594 snprintf(buf
, sizeof(buf
), pcp
<= 7 ? "%u" : "%u (bogus)", pcp
);
599 of10_bitmap_print(const struct tok
*t
, const uint32_t v
, const uint32_t u
) {
600 const char *sep
= " (";
605 for (; t
->s
!= NULL
; t
++)
607 printf("%s%s", sep
, t
->s
);
610 /* unassigned bits? */
611 printf(v
& u
? ") (bogus)" : ")");
614 static const u_char
*
615 of10_data_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
619 printf("\n\t data (%u octets)", len
);
622 hex_and_ascii_print("\n\t ", cp
, len
);
626 printf(" [|openflow]");
630 /* Vendor ID is mandatory, data is optional. */
631 static const u_char
*
632 of10_vendor_data_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
637 printf(", vendor 0x%08x", EXTRACT_32BITS(cp
));
640 return of10_data_print(cp
, ep
, len
- 4);
642 corrupt
: /* skip the undersized data */
643 printf(" (corrupt)");
647 printf(" [|openflow]");
651 static const u_char
*
652 of10_packet_data_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
656 printf("\n\t data (%u octets)", len
);
661 printf(", frame decoding below\n");
662 ether_print(gndo
, cp
, len
, snapend
- cp
, NULL
, NULL
);
667 printf(" [|openflow]");
671 /* [OF10] Section 5.2.1 */
672 static const u_char
*
673 of10_phy_ports_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
674 const u_char
*cp0
= cp
;
675 const u_int len0
= len
;
678 if (len
< OF_PHY_PORT_LEN
)
682 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
685 TCHECK2(*cp
, ETHER_ADDR_LEN
);
686 printf(", hw_addr %s", etheraddr_string(cp
));
687 cp
+= ETHER_ADDR_LEN
;
689 TCHECK2(*cp
, OFP_MAX_PORT_NAME_LEN
);
691 fn_print(cp
, cp
+ OFP_MAX_PORT_NAME_LEN
);
693 cp
+= OFP_MAX_PORT_NAME_LEN
;
702 printf("\n\t config 0x%08x", EXTRACT_32BITS(cp
));
703 of10_bitmap_print(ofppc_bm
, EXTRACT_32BITS(cp
), OFPPC_U
);
707 printf("\n\t state 0x%08x", EXTRACT_32BITS(cp
));
708 of10_bitmap_print(ofpps_bm
, EXTRACT_32BITS(cp
), OFPPS_U
);
712 printf("\n\t curr 0x%08x", EXTRACT_32BITS(cp
));
713 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
717 printf("\n\t advertised 0x%08x", EXTRACT_32BITS(cp
));
718 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
722 printf("\n\t supported 0x%08x", EXTRACT_32BITS(cp
));
723 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
727 printf("\n\t peer 0x%08x", EXTRACT_32BITS(cp
));
728 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
731 len
-= OF_PHY_PORT_LEN
;
735 corrupt
: /* skip the undersized trailing data */
736 printf(" (corrupt)");
740 printf(" [|openflow]");
744 /* [OF10] Section 5.2.2 */
745 static const u_char
*
746 of10_queue_props_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
747 const u_char
*cp0
= cp
;
748 const u_int len0
= len
;
749 uint16_t property
, plen
, rate
;
752 u_char plen_bogus
= 0, skip
= 0;
754 if (len
< OF_QUEUE_PROP_HEADER_LEN
)
758 property
= EXTRACT_16BITS(cp
);
760 printf("\n\t property %s", tok2str(ofpqt_str
, "invalid (0x%04x)", property
));
763 plen
= EXTRACT_16BITS(cp
);
765 printf(", len %u", plen
);
766 if (plen
< OF_QUEUE_PROP_HEADER_LEN
|| plen
> len
)
771 /* property-specific constraints and decoding */
774 plen_bogus
= plen
!= OF_QUEUE_PROP_HEADER_LEN
;
777 plen_bogus
= plen
!= OF_QUEUE_PROP_MIN_RATE_LEN
;
787 TCHECK2(*cp
, plen
- 4);
791 if (property
== OFPQT_MIN_RATE
) { /* the only case of property decoding */
794 rate
= EXTRACT_16BITS(cp
);
797 printf(", rate disabled");
799 printf(", rate %u.%u%%", rate
/ 10, rate
% 10);
809 corrupt
: /* skip the rest of queue properties */
810 printf(" (corrupt)");
814 printf(" [|openflow]");
819 static const u_char
*
820 of10_queues_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
821 const u_char
*cp0
= cp
;
822 const u_int len0
= len
;
826 if (len
< OF_PACKET_QUEUE_LEN
)
830 printf("\n\t queue_id %u", EXTRACT_32BITS(cp
));
834 desclen
= EXTRACT_16BITS(cp
);
836 printf(", len %u", desclen
);
837 if (desclen
< OF_PACKET_QUEUE_LEN
|| desclen
> len
)
844 TCHECK2(*cp
, desclen
- OF_PACKET_QUEUE_LEN
);
845 cp
+= desclen
- OF_PACKET_QUEUE_LEN
;
848 if (ep
== (cp
= of10_queue_props_print(cp
, ep
, desclen
- OF_PACKET_QUEUE_LEN
)))
849 return ep
; /* end of snapshot */
855 corrupt
: /* skip the rest of queues */
856 printf(" (corrupt)");
860 printf(" [|openflow]");
864 /* [OF10] Section 5.2.3 */
865 static const u_char
*
866 of10_match_print(const char *pfx
, const u_char
*cp
, const u_char
*ep
) {
871 const char *field_name
;
875 wildcards
= EXTRACT_32BITS(cp
);
876 if (wildcards
& OFPFW_U
)
877 printf("%swildcards 0x%08x (bogus)", pfx
, wildcards
);
881 if (! (wildcards
& OFPFW_IN_PORT
))
882 printf("%smatch in_port %s", pfx
, tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
885 TCHECK2(*cp
, ETHER_ADDR_LEN
);
886 if (! (wildcards
& OFPFW_DL_SRC
))
887 printf("%smatch dl_src %s", pfx
, etheraddr_string(cp
));
888 cp
+= ETHER_ADDR_LEN
;
890 TCHECK2(*cp
, ETHER_ADDR_LEN
);
891 if (! (wildcards
& OFPFW_DL_DST
))
892 printf("%smatch dl_dst %s", pfx
, etheraddr_string(cp
));
893 cp
+= ETHER_ADDR_LEN
;
896 if (! (wildcards
& OFPFW_DL_VLAN
))
897 printf("%smatch dl_vlan %s", pfx
, vlan_str(EXTRACT_16BITS(cp
)));
901 if (! (wildcards
& OFPFW_DL_VLAN_PCP
))
902 printf("%smatch dl_vlan_pcp %s", pfx
, pcp_str(*cp
));
909 dl_type
= EXTRACT_16BITS(cp
);
911 if (! (wildcards
& OFPFW_DL_TYPE
))
912 printf("%smatch dl_type 0x%04x", pfx
, dl_type
);
915 if (! (wildcards
& OFPFW_NW_TOS
))
916 printf("%smatch nw_tos 0x%02x", pfx
, *cp
);
922 if (! (wildcards
& OFPFW_NW_PROTO
)) {
923 field_name
= ! (wildcards
& OFPFW_DL_TYPE
) && dl_type
== ETHERTYPE_ARP
924 ? "arp_opcode" : "nw_proto";
925 printf("%smatch %s %u", pfx
, field_name
, nw_proto
);
932 nw_bits
= (wildcards
& OFPFW_NW_SRC_MASK
) >> OFPFW_NW_SRC_SHIFT
;
934 printf("%smatch nw_src %s/%u", pfx
, ipaddr_string(cp
), 32 - nw_bits
);
938 nw_bits
= (wildcards
& OFPFW_NW_DST_MASK
) >> OFPFW_NW_DST_SHIFT
;
940 printf("%smatch nw_dst %s/%u", pfx
, ipaddr_string(cp
), 32 - nw_bits
);
944 if (! (wildcards
& OFPFW_TP_SRC
)) {
945 field_name
= ! (wildcards
& OFPFW_DL_TYPE
) && dl_type
== ETHERTYPE_IP
946 && ! (wildcards
& OFPFW_NW_PROTO
) && nw_proto
== IPPROTO_ICMP
947 ? "icmp_type" : "tp_src";
948 printf("%smatch %s %u", pfx
, field_name
, EXTRACT_16BITS(cp
));
953 if (! (wildcards
& OFPFW_TP_DST
)) {
954 field_name
= ! (wildcards
& OFPFW_DL_TYPE
) && dl_type
== ETHERTYPE_IP
955 && ! (wildcards
& OFPFW_NW_PROTO
) && nw_proto
== IPPROTO_ICMP
956 ? "icmp_code" : "tp_dst";
957 printf("%smatch %s %u", pfx
, field_name
, EXTRACT_16BITS(cp
));
962 printf(" [|openflow]");
966 /* [OF10] Section 5.2.4 */
967 static const u_char
*
968 of10_actions_print(const char *pfx
, const u_char
*cp
, const u_char
*ep
,
970 const u_char
*cp0
= cp
;
971 const u_int len0
= len
;
972 uint16_t type
, alen
, output_port
;
975 u_char alen_bogus
= 0, skip
= 0;
977 if (len
< OF_ACTION_HEADER_LEN
)
981 type
= EXTRACT_16BITS(cp
);
983 printf("%saction type %s", pfx
, tok2str(ofpat_str
, "invalid (0x%04x)", type
));
986 alen
= EXTRACT_16BITS(cp
);
988 printf(", len %u", alen
);
989 /* On action size underrun/overrun skip the rest of the action list. */
990 if (alen
< OF_ACTION_HEADER_LEN
|| alen
> len
)
992 /* On action size inappropriate for the given type or invalid type just skip
993 * the current action, as the basic length constraint has been met. */
996 case OFPAT_SET_VLAN_VID
:
997 case OFPAT_SET_VLAN_PCP
:
998 case OFPAT_STRIP_VLAN
:
999 case OFPAT_SET_NW_SRC
:
1000 case OFPAT_SET_NW_DST
:
1001 case OFPAT_SET_NW_TOS
:
1002 case OFPAT_SET_TP_SRC
:
1003 case OFPAT_SET_TP_DST
:
1004 alen_bogus
= alen
!= 8;
1006 case OFPAT_SET_DL_SRC
:
1007 case OFPAT_SET_DL_DST
:
1009 alen_bogus
= alen
!= 16;
1012 alen_bogus
= alen
% 8 != 0; /* already >= 8 so far */
1022 TCHECK2(*cp
, alen
- 4);
1026 /* OK to decode the rest of the action structure */
1031 output_port
= EXTRACT_16BITS(cp
);
1033 printf(", port %s", tok2str(ofpp_str
, "%u", output_port
));
1036 if (output_port
== OFPP_CONTROLLER
)
1037 printf(", max_len %u", EXTRACT_16BITS(cp
));
1040 case OFPAT_SET_VLAN_VID
:
1043 printf(", vlan_vid %s", vlan_str(EXTRACT_16BITS(cp
)));
1049 case OFPAT_SET_VLAN_PCP
:
1052 printf(", vlan_pcp %s", pcp_str(*cp
));
1058 case OFPAT_SET_DL_SRC
:
1059 case OFPAT_SET_DL_DST
:
1061 TCHECK2(*cp
, ETHER_ADDR_LEN
);
1062 printf(", dl_addr %s", etheraddr_string(cp
));
1063 cp
+= ETHER_ADDR_LEN
;
1068 case OFPAT_SET_NW_SRC
:
1069 case OFPAT_SET_NW_DST
:
1072 printf(", nw_addr %s", ipaddr_string(cp
));
1075 case OFPAT_SET_NW_TOS
:
1078 printf(", nw_tos 0x%02x", *cp
);
1084 case OFPAT_SET_TP_SRC
:
1085 case OFPAT_SET_TP_DST
:
1088 printf(", tp_port %u", EXTRACT_16BITS(cp
));
1097 printf(", port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1104 printf(", queue_id %s", tok2str(ofpq_str
, "%u", EXTRACT_32BITS(cp
)));
1108 if (ep
== (cp
= of10_vendor_data_print(cp
, ep
, alen
- 4)))
1109 return ep
; /* end of snapshot */
1111 case OFPAT_STRIP_VLAN
:
1122 corrupt
: /* skip the rest of actions */
1123 printf(" (corrupt)");
1124 TCHECK2(*cp0
, len0
);
1127 printf(" [|openflow]");
1131 /* [OF10] Section 5.3.1 */
1132 static const u_char
*
1133 of10_features_reply_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1136 printf("\n\t dpid 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1140 printf(", n_buffers %u", EXTRACT_32BITS(cp
));
1144 printf(", n_tables %u", *cp
);
1151 printf("\n\t capabilities 0x%08x", EXTRACT_32BITS(cp
));
1152 of10_bitmap_print(ofp_capabilities_bm
, EXTRACT_32BITS(cp
), OFPCAP_U
);
1156 printf("\n\t actions 0x%08x", EXTRACT_32BITS(cp
));
1157 of10_bitmap_print(ofpat_bm
, EXTRACT_32BITS(cp
), OFPAT_U
);
1160 return of10_phy_ports_print(cp
, ep
, len
- OF_SWITCH_FEATURES_LEN
);
1163 printf(" [|openflow]");
1167 /* [OF10] Section 5.3.3 */
1168 static const u_char
*
1169 of10_flow_mod_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1173 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1174 return ep
; /* end of snapshot */
1177 printf("\n\t cookie 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1181 command
= EXTRACT_16BITS(cp
);
1182 printf(", command %s", tok2str(ofpfc_str
, "invalid (0x%04x)", command
));
1186 if (EXTRACT_16BITS(cp
))
1187 printf(", idle_timeout %u", EXTRACT_16BITS(cp
));
1191 if (EXTRACT_16BITS(cp
))
1192 printf(", hard_timeout %u", EXTRACT_16BITS(cp
));
1196 if (EXTRACT_16BITS(cp
))
1197 printf(", priority %u", EXTRACT_16BITS(cp
));
1201 if (command
== OFPFC_ADD
|| command
== OFPFC_MODIFY
||
1202 command
== OFPFC_MODIFY_STRICT
)
1203 printf(", buffer_id %s", tok2str(bufferid_str
, "0x%08x", EXTRACT_32BITS(cp
)));
1207 if (command
== OFPFC_DELETE
|| command
== OFPFC_DELETE_STRICT
)
1208 printf(", out_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1212 printf(", flags 0x%04x", EXTRACT_16BITS(cp
));
1213 of10_bitmap_print(ofpff_bm
, EXTRACT_16BITS(cp
), OFPFF_U
);
1216 return of10_actions_print("\n\t ", cp
, ep
, len
- OF_FLOW_MOD_LEN
);
1219 printf(" [|openflow]");
1224 static const u_char
*
1225 of10_port_mod_print(const u_char
*cp
, const u_char
*ep
) {
1228 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1231 TCHECK2(*cp
, ETHER_ADDR_LEN
);
1232 printf(", hw_addr %s", etheraddr_string(cp
));
1233 cp
+= ETHER_ADDR_LEN
;
1236 printf("\n\t config 0x%08x", EXTRACT_32BITS(cp
));
1237 of10_bitmap_print(ofppc_bm
, EXTRACT_32BITS(cp
), OFPPC_U
);
1241 printf("\n\t mask 0x%08x", EXTRACT_32BITS(cp
));
1242 of10_bitmap_print(ofppc_bm
, EXTRACT_32BITS(cp
), OFPPC_U
);
1246 printf("\n\t advertise 0x%08x", EXTRACT_32BITS(cp
));
1247 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
1254 printf(" [|openflow]");
1258 /* [OF10] Section 5.3.5 */
1259 static const u_char
*
1260 of10_stats_request_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1261 const u_char
*cp0
= cp
;
1262 const u_int len0
= len
;
1267 type
= EXTRACT_16BITS(cp
);
1269 printf("\n\t type %s", tok2str(ofpst_str
, "invalid (0x%04x)", type
));
1272 printf(", flags 0x%04x", EXTRACT_16BITS(cp
));
1273 if (EXTRACT_16BITS(cp
))
1276 /* type-specific body of one of fixed lengths */
1277 len
-= OF_STATS_REQUEST_LEN
;
1285 case OFPST_AGGREGATE
:
1286 if (len
!= OF_FLOW_STATS_REQUEST_LEN
)
1289 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1290 return ep
; /* end of snapshot */
1293 printf("\n\t table_id %s", tok2str(tableid_str
, "%u", *cp
));
1300 printf(", out_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1303 if (len
!= OF_PORT_STATS_REQUEST_LEN
)
1307 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1313 if (len
!= OF_QUEUE_STATS_REQUEST_LEN
)
1317 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1324 printf(", queue_id %s", tok2str(ofpq_str
, "%u", EXTRACT_32BITS(cp
)));
1327 return of10_vendor_data_print(cp
, ep
, len
);
1331 corrupt
: /* skip the message body */
1332 printf(" (corrupt)");
1333 TCHECK2(*cp0
, len0
);
1336 printf(" [|openflow]");
1341 static const u_char
*
1342 of10_desc_stats_reply_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1343 if (len
!= OF_DESC_STATS_LEN
)
1346 TCHECK2(*cp
, DESC_STR_LEN
);
1347 printf("\n\t mfr_desc '");
1348 fn_print(cp
, cp
+ DESC_STR_LEN
);
1352 TCHECK2(*cp
, DESC_STR_LEN
);
1353 printf("\n\t hw_desc '");
1354 fn_print(cp
, cp
+ DESC_STR_LEN
);
1358 TCHECK2(*cp
, DESC_STR_LEN
);
1359 printf("\n\t sw_desc '");
1360 fn_print(cp
, cp
+ DESC_STR_LEN
);
1364 TCHECK2(*cp
, SERIAL_NUM_LEN
);
1365 printf("\n\t serial_num '");
1366 fn_print(cp
, cp
+ SERIAL_NUM_LEN
);
1368 cp
+= SERIAL_NUM_LEN
;
1370 TCHECK2(*cp
, DESC_STR_LEN
);
1371 printf("\n\t dp_desc '");
1372 fn_print(cp
, cp
+ DESC_STR_LEN
);
1374 return cp
+ DESC_STR_LEN
;
1376 corrupt
: /* skip the message body */
1377 printf(" (corrupt)");
1381 printf(" [|openflow]");
1386 static const u_char
*
1387 of10_flow_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1388 const u_char
*cp0
= cp
;
1389 const u_int len0
= len
;
1393 if (len
< OF_FLOW_STATS_LEN
)
1397 entry_len
= EXTRACT_16BITS(cp
);
1398 printf("\n\t length %u", entry_len
);
1399 if (entry_len
< OF_FLOW_STATS_LEN
|| entry_len
> len
)
1404 printf(", table_id %s", tok2str(tableid_str
, "%u", *cp
));
1410 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1411 return ep
; /* end of snapshot */
1414 printf("\n\t duration_sec %u", EXTRACT_32BITS(cp
));
1418 printf(", duration_nsec %u", EXTRACT_32BITS(cp
));
1422 printf(", priority %u", EXTRACT_16BITS(cp
));
1426 printf(", idle_timeout %u", EXTRACT_16BITS(cp
));
1430 printf(", hard_timeout %u", EXTRACT_16BITS(cp
));
1437 printf(", cookie 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1441 printf(", packet_count %" PRIu64
, EXTRACT_64BITS(cp
));
1445 printf(", byte_count %" PRIu64
, EXTRACT_64BITS(cp
));
1448 if (ep
== (cp
= of10_actions_print("\n\t ", cp
, ep
, entry_len
- OF_FLOW_STATS_LEN
)))
1449 return ep
; /* end of snapshot */
1455 corrupt
: /* skip the rest of flow statistics entries */
1456 printf(" (corrupt)");
1457 TCHECK2(*cp0
, len0
);
1460 printf(" [|openflow]");
1465 static const u_char
*
1466 of10_aggregate_stats_reply_print(const u_char
*cp
, const u_char
*ep
,
1468 if (len
!= OF_AGGREGATE_STATS_REPLY_LEN
)
1472 printf("\n\t packet_count %" PRIu64
, EXTRACT_64BITS(cp
));
1476 printf(", byte_count %" PRIu64
, EXTRACT_64BITS(cp
));
1480 printf(", flow_count %u", EXTRACT_32BITS(cp
));
1486 corrupt
: /* skip the message body */
1487 printf(" (corrupt)");
1491 printf(" [|openflow]");
1496 static const u_char
*
1497 of10_table_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1498 const u_char
*cp0
= cp
;
1499 const u_int len0
= len
;
1502 if (len
< OF_TABLE_STATS_LEN
)
1506 printf("\n\t table_id %s", tok2str(tableid_str
, "%u", *cp
));
1512 TCHECK2(*cp
, OFP_MAX_TABLE_NAME_LEN
);
1514 fn_print(cp
, cp
+ OFP_MAX_TABLE_NAME_LEN
);
1516 cp
+= OFP_MAX_TABLE_NAME_LEN
;
1519 printf("\n\t wildcards 0x%08x", EXTRACT_32BITS(cp
));
1520 of10_bitmap_print(ofpfw_bm
, EXTRACT_32BITS(cp
), OFPFW_U
);
1524 printf("\n\t max_entries %u", EXTRACT_32BITS(cp
));
1528 printf(", active_count %u", EXTRACT_32BITS(cp
));
1532 printf(", lookup_count %" PRIu64
, EXTRACT_64BITS(cp
));
1536 printf(", matched_count %" PRIu64
, EXTRACT_64BITS(cp
));
1539 len
-= OF_TABLE_STATS_LEN
;
1543 corrupt
: /* skip the undersized trailing data */
1544 printf(" (corrupt)");
1545 TCHECK2(*cp0
, len0
);
1548 printf(" [|openflow]");
1553 static const u_char
*
1554 of10_port_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1555 const u_char
*cp0
= cp
;
1556 const u_int len0
= len
;
1559 if (len
< OF_PORT_STATS_LEN
)
1563 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1566 TCHECK2(*cp
, OF_PORT_STATS_LEN
- 2);
1567 cp
+= OF_PORT_STATS_LEN
- 2;
1575 printf(", rx_packets %" PRIu64
, EXTRACT_64BITS(cp
));
1579 printf(", tx_packets %" PRIu64
, EXTRACT_64BITS(cp
));
1583 printf(", rx_bytes %" PRIu64
, EXTRACT_64BITS(cp
));
1587 printf(", tx_bytes %" PRIu64
, EXTRACT_64BITS(cp
));
1591 printf(", rx_dropped %" PRIu64
, EXTRACT_64BITS(cp
));
1595 printf(", tx_dropped %" PRIu64
, EXTRACT_64BITS(cp
));
1599 printf(", rx_errors %" PRIu64
, EXTRACT_64BITS(cp
));
1603 printf(", tx_errors %" PRIu64
, EXTRACT_64BITS(cp
));
1607 printf(", rx_frame_err %" PRIu64
, EXTRACT_64BITS(cp
));
1611 printf(", rx_over_err %" PRIu64
, EXTRACT_64BITS(cp
));
1615 printf(", rx_crc_err %" PRIu64
, EXTRACT_64BITS(cp
));
1619 printf(", collisions %" PRIu64
, EXTRACT_64BITS(cp
));
1622 len
-= OF_PORT_STATS_LEN
;
1626 corrupt
: /* skip the undersized trailing data */
1627 printf(" (corrupt)");
1628 TCHECK2(*cp0
, len0
);
1631 printf(" [|openflow]");
1636 static const u_char
*
1637 of10_queue_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1638 const u_char
*cp0
= cp
;
1639 const u_int len0
= len
;
1642 if (len
< OF_QUEUE_STATS_LEN
)
1646 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1653 printf(", queue_id %u", EXTRACT_32BITS(cp
));
1657 printf(", tx_bytes %" PRIu64
, EXTRACT_64BITS(cp
));
1661 printf(", tx_packets %" PRIu64
, EXTRACT_64BITS(cp
));
1665 printf(", tx_errors %" PRIu64
, EXTRACT_64BITS(cp
));
1668 len
-= OF_QUEUE_STATS_LEN
;
1672 corrupt
: /* skip the undersized trailing data */
1673 printf(" (corrupt)");
1674 TCHECK2(*cp0
, len0
);
1677 printf(" [|openflow]");
1682 static const u_char
*
1683 of10_stats_reply_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1684 const u_char
*cp0
= cp
;
1689 type
= EXTRACT_16BITS(cp
);
1690 printf("\n\t type %s", tok2str(ofpst_str
, "invalid (0x%04x)", type
));
1694 printf(", flags 0x%04x", EXTRACT_16BITS(cp
));
1695 of10_bitmap_print(ofpsf_reply_bm
, EXTRACT_16BITS(cp
), OFPSF_REPLY_U
);
1699 const u_char
*(*decoder
)(const u_char
*, const u_char
*, u_int
) =
1700 type
== OFPST_DESC
? of10_desc_stats_reply_print
:
1701 type
== OFPST_FLOW
? of10_flow_stats_reply_print
:
1702 type
== OFPST_AGGREGATE
? of10_aggregate_stats_reply_print
:
1703 type
== OFPST_TABLE
? of10_table_stats_reply_print
:
1704 type
== OFPST_PORT
? of10_port_stats_reply_print
:
1705 type
== OFPST_QUEUE
? of10_queue_stats_reply_print
:
1706 type
== OFPST_VENDOR
? of10_vendor_data_print
:
1708 if (decoder
!= NULL
)
1709 return decoder(cp
, ep
, len
- OF_STATS_REPLY_LEN
);
1715 printf(" [|openflow]");
1719 /* [OF10] Section 5.3.6 */
1720 static const u_char
*
1721 of10_packet_out_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1722 const u_char
*cp0
= cp
;
1723 const u_int len0
= len
;
1724 uint16_t actions_len
;
1728 printf("\n\t buffer_id 0x%08x", EXTRACT_32BITS(cp
));
1732 printf(", in_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1736 actions_len
= EXTRACT_16BITS(cp
);
1738 if (actions_len
> len
- OF_PACKET_OUT_LEN
)
1741 if (ep
== (cp
= of10_actions_print("\n\t ", cp
, ep
, actions_len
)))
1742 return ep
; /* end of snapshot */
1744 return of10_packet_data_print(cp
, ep
, len
- OF_PACKET_OUT_LEN
- actions_len
);
1746 corrupt
: /* skip the rest of the message body */
1747 printf(" (corrupt)");
1748 TCHECK2(*cp0
, len0
);
1751 printf(" [|openflow]");
1755 /* [OF10] Section 5.4.1 */
1756 static const u_char
*
1757 of10_packet_in_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1760 printf("\n\t buffer_id %s", tok2str(bufferid_str
, "0x%08x", EXTRACT_32BITS(cp
)));
1764 printf(", total_len %u", EXTRACT_16BITS(cp
));
1768 printf(", in_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1772 printf(", reason %s", tok2str(ofpr_str
, "invalid (0x%02x)", *cp
));
1778 /* 2 mock octets count in OF_PACKET_IN_LEN but not in len */
1779 return of10_packet_data_print(cp
, ep
, len
- (OF_PACKET_IN_LEN
- 2));
1782 printf(" [|openflow]");
1786 /* [OF10] Section 5.4.2 */
1787 static const u_char
*
1788 of10_flow_removed_print(const u_char
*cp
, const u_char
*ep
) {
1790 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1791 return ep
; /* end of snapshot */
1794 printf("\n\t cookie 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1798 if (EXTRACT_16BITS(cp
))
1799 printf(", priority %u", EXTRACT_16BITS(cp
));
1803 printf(", reason %s", tok2str(ofprr_str
, "unknown (0x%02x)", *cp
));
1810 printf(", duration_sec %u", EXTRACT_32BITS(cp
));
1814 printf(", duration_nsec %u", EXTRACT_32BITS(cp
));
1818 if (EXTRACT_16BITS(cp
))
1819 printf(", idle_timeout %u", EXTRACT_16BITS(cp
));
1826 printf(", packet_count %" PRIu64
, EXTRACT_64BITS(cp
));
1830 printf(", byte_count %" PRIu64
, EXTRACT_64BITS(cp
));
1834 printf(" [|openflow]");
1838 /* [OF10] Section 5.4.4 */
1839 static const u_char
*
1840 of10_error_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1842 const struct tok
*code_str
;
1846 type
= EXTRACT_16BITS(cp
);
1848 printf("\n\t type %s", tok2str(ofpet_str
, "invalid (0x%04x)", type
));
1852 type
== OFPET_HELLO_FAILED
? ofphfc_str
:
1853 type
== OFPET_BAD_REQUEST
? ofpbrc_str
:
1854 type
== OFPET_BAD_ACTION
? ofpbac_str
:
1855 type
== OFPET_FLOW_MOD_FAILED
? ofpfmfc_str
:
1856 type
== OFPET_PORT_MOD_FAILED
? ofppmfc_str
:
1857 type
== OFPET_QUEUE_OP_FAILED
? ofpqofc_str
:
1859 printf(", code %s", tok2str(code_str
, "invalid (0x%04x)", EXTRACT_16BITS(cp
)));
1862 return of10_data_print(cp
, ep
, len
- OF_ERROR_MSG_LEN
);
1865 printf(" [|openflow]");
1870 of10_header_body_print(const u_char
*cp
, const u_char
*ep
, const uint8_t type
,
1871 const uint16_t len
, const uint32_t xid
) {
1872 const u_char
*cp0
= cp
;
1873 const u_int len0
= len
;
1874 /* Thus far message length is not less than the basic header size, but most
1875 * message types have additional assorted constraints on the length. Wherever
1876 * possible, check that message length meets the constraint, in remaining
1877 * cases check that the length is OK to begin decoding and leave any final
1878 * verification up to a lower-layer function. When the current message is
1879 * corrupt, proceed to the next message. */
1881 /* [OF10] Section 5.1 */
1882 printf("\n\tversion 1.0, type %s, length %u, xid 0x%08x",
1883 tok2str(ofpt_str
, "invalid (0x%02x)", type
), len
, xid
);
1885 /* OpenFlow header only. */
1886 case OFPT_FEATURES_REQUEST
: /* [OF10] Section 5.3.1 */
1887 case OFPT_GET_CONFIG_REQUEST
: /* [OF10] Section 5.3.2 */
1888 case OFPT_BARRIER_REQUEST
: /* [OF10] Section 5.3.7 */
1889 case OFPT_BARRIER_REPLY
: /* ibid */
1890 if (len
!= OF_HEADER_LEN
)
1894 /* OpenFlow header and fixed-size message body. */
1895 case OFPT_SET_CONFIG
: /* [OF10] Section 5.3.2 */
1896 case OFPT_GET_CONFIG_REPLY
: /* ibid */
1897 if (len
!= OF_SWITCH_CONFIG_LEN
)
1903 printf("\n\t flags %s", tok2str(ofp_config_str
, "invalid (0x%04x)", EXTRACT_16BITS(cp
)));
1907 printf(", miss_send_len %u", EXTRACT_16BITS(cp
));
1910 if (len
!= OF_PORT_MOD_LEN
)
1914 return of10_port_mod_print(cp
, ep
);
1915 case OFPT_QUEUE_GET_CONFIG_REQUEST
: /* [OF10] Section 5.3.4 */
1916 if (len
!= OF_QUEUE_GET_CONFIG_REQUEST_LEN
)
1922 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1927 case OFPT_FLOW_REMOVED
:
1928 if (len
!= OF_FLOW_REMOVED_LEN
)
1932 return of10_flow_removed_print(cp
, ep
);
1933 case OFPT_PORT_STATUS
: /* [OF10] Section 5.4.3 */
1934 if (len
!= OF_PORT_STATUS_LEN
)
1940 printf("\n\t reason %s", tok2str(ofppr_str
, "invalid (0x%02x)", *cp
));
1946 return of10_phy_ports_print(cp
, ep
, OF_PHY_PORT_LEN
);
1948 /* OpenFlow header, fixed-size message body and n * fixed-size data units. */
1949 case OFPT_FEATURES_REPLY
:
1950 if (len
< OF_SWITCH_FEATURES_LEN
)
1954 return of10_features_reply_print(cp
, ep
, len
);
1956 /* OpenFlow header and variable-size data. */
1957 case OFPT_HELLO
: /* [OF10] Section 5.5.1 */
1958 case OFPT_ECHO_REQUEST
: /* [OF10] Section 5.5.2 */
1959 case OFPT_ECHO_REPLY
: /* [OF10] Section 5.5.3 */
1962 return of10_data_print(cp
, ep
, len
- OF_HEADER_LEN
);
1964 /* OpenFlow header, fixed-size message body and variable-size data. */
1966 if (len
< OF_ERROR_MSG_LEN
)
1970 return of10_error_print(cp
, ep
, len
);
1972 /* [OF10] Section 5.5.4 */
1973 if (len
< OF_VENDOR_HEADER_LEN
)
1977 return of10_vendor_data_print(cp
, ep
, len
- OF_HEADER_LEN
);
1978 case OFPT_PACKET_IN
:
1979 /* 2 mock octets count in OF_PACKET_IN_LEN but not in len */
1980 if (len
< OF_PACKET_IN_LEN
- 2)
1984 return of10_packet_in_print(cp
, ep
, len
);
1986 /* a. OpenFlow header. */
1987 /* b. OpenFlow header and one of the fixed-size message bodies. */
1988 /* c. OpenFlow header, fixed-size message body and variable-size data. */
1989 case OFPT_STATS_REQUEST
:
1990 if (len
< OF_STATS_REQUEST_LEN
)
1994 return of10_stats_request_print(cp
, ep
, len
);
1996 /* a. OpenFlow header and fixed-size message body. */
1997 /* b. OpenFlow header and n * fixed-size data units. */
1998 /* c. OpenFlow header and n * variable-size data units. */
1999 /* d. OpenFlow header, fixed-size message body and variable-size data. */
2000 case OFPT_STATS_REPLY
:
2001 if (len
< OF_STATS_REPLY_LEN
)
2005 return of10_stats_reply_print(cp
, ep
, len
);
2007 /* OpenFlow header and n * variable-size data units and variable-size data. */
2008 case OFPT_PACKET_OUT
:
2009 if (len
< OF_PACKET_OUT_LEN
)
2013 return of10_packet_out_print(cp
, ep
, len
);
2015 /* OpenFlow header, fixed-size message body and n * variable-size data units. */
2017 if (len
< OF_FLOW_MOD_LEN
)
2021 return of10_flow_mod_print(cp
, ep
, len
);
2023 /* OpenFlow header, fixed-size message body and n * variable-size data units. */
2024 case OFPT_QUEUE_GET_CONFIG_REPLY
: /* [OF10] Section 5.3.4 */
2025 if (len
< OF_QUEUE_GET_CONFIG_REPLY_LEN
)
2031 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
2037 return of10_queues_print(cp
, ep
, len
- OF_QUEUE_GET_CONFIG_REPLY_LEN
);
2038 } /* switch (type) */
2041 corrupt
: /* skip the message body */
2042 printf(" (corrupt)");
2044 TCHECK2(*cp0
, len0
- OF_HEADER_LEN
);
2045 return cp0
+ len0
- OF_HEADER_LEN
;
2047 printf(" [|openflow]");