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
12 * Copyright (c) 2013 The TCPDUMP project
13 * All rights reserved.
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in the
22 * documentation and/or other materials provided with the distribution.
24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
27 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
29 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
30 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
31 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
34 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
42 #include <tcpdump-stdinc.h>
44 #include "interface.h"
46 #include "addrtoname.h"
47 #include "ethertype.h"
51 #define OFPT_HELLO 0x00
52 #define OFPT_ERROR 0x01
53 #define OFPT_ECHO_REQUEST 0x02
54 #define OFPT_ECHO_REPLY 0x03
55 #define OFPT_VENDOR 0x04
56 #define OFPT_FEATURES_REQUEST 0x05
57 #define OFPT_FEATURES_REPLY 0x06
58 #define OFPT_GET_CONFIG_REQUEST 0x07
59 #define OFPT_GET_CONFIG_REPLY 0x08
60 #define OFPT_SET_CONFIG 0x09
61 #define OFPT_PACKET_IN 0x0a
62 #define OFPT_FLOW_REMOVED 0x0b
63 #define OFPT_PORT_STATUS 0x0c
64 #define OFPT_PACKET_OUT 0x0d
65 #define OFPT_FLOW_MOD 0x0e
66 #define OFPT_PORT_MOD 0x0f
67 #define OFPT_STATS_REQUEST 0x10
68 #define OFPT_STATS_REPLY 0x11
69 #define OFPT_BARRIER_REQUEST 0x12
70 #define OFPT_BARRIER_REPLY 0x13
71 #define OFPT_QUEUE_GET_CONFIG_REQUEST 0x14
72 #define OFPT_QUEUE_GET_CONFIG_REPLY 0x15
73 static const struct tok ofpt_str
[] = {
74 { OFPT_HELLO
, "HELLO" },
75 { OFPT_ERROR
, "ERROR" },
76 { OFPT_ECHO_REQUEST
, "ECHO_REQUEST" },
77 { OFPT_ECHO_REPLY
, "ECHO_REPLY" },
78 { OFPT_VENDOR
, "VENDOR" },
79 { OFPT_FEATURES_REQUEST
, "FEATURES_REQUEST" },
80 { OFPT_FEATURES_REPLY
, "FEATURES_REPLY" },
81 { OFPT_GET_CONFIG_REQUEST
, "GET_CONFIG_REQUEST" },
82 { OFPT_GET_CONFIG_REPLY
, "GET_CONFIG_REPLY" },
83 { OFPT_SET_CONFIG
, "SET_CONFIG" },
84 { OFPT_PACKET_IN
, "PACKET_IN" },
85 { OFPT_FLOW_REMOVED
, "FLOW_REMOVED" },
86 { OFPT_PORT_STATUS
, "PORT_STATUS" },
87 { OFPT_PACKET_OUT
, "PACKET_OUT" },
88 { OFPT_FLOW_MOD
, "FLOW_MOD" },
89 { OFPT_PORT_MOD
, "PORT_MOD" },
90 { OFPT_STATS_REQUEST
, "STATS_REQUEST" },
91 { OFPT_STATS_REPLY
, "STATS_REPLY" },
92 { OFPT_BARRIER_REQUEST
, "BARRIER_REQUEST" },
93 { OFPT_BARRIER_REPLY
, "BARRIER_REPLY" },
94 { OFPT_QUEUE_GET_CONFIG_REQUEST
, "QUEUE_GET_CONFIG_REQUEST" },
95 { OFPT_QUEUE_GET_CONFIG_REPLY
, "QUEUE_GET_CONFIG_REPLY" },
99 #define OFPPC_PORT_DOWN (1 << 0)
100 #define OFPPC_NO_STP (1 << 1)
101 #define OFPPC_NO_RECV (1 << 2)
102 #define OFPPC_NO_RECV_STP (1 << 3)
103 #define OFPPC_NO_FLOOD (1 << 4)
104 #define OFPPC_NO_FWD (1 << 5)
105 #define OFPPC_NO_PACKET_IN (1 << 6)
106 static const struct tok ofppc_bm
[] = {
107 { OFPPC_PORT_DOWN
, "PORT_DOWN" },
108 { OFPPC_NO_STP
, "NO_STP" },
109 { OFPPC_NO_RECV
, "NO_RECV" },
110 { OFPPC_NO_RECV_STP
, "NO_RECV_STP" },
111 { OFPPC_NO_FLOOD
, "NO_FLOOD" },
112 { OFPPC_NO_FWD
, "NO_FWD" },
113 { OFPPC_NO_PACKET_IN
, "NO_PACKET_IN" },
116 #define OFPPC_U (~(OFPPC_PORT_DOWN | OFPPC_NO_STP | OFPPC_NO_RECV | \
117 OFPPC_NO_RECV_STP | OFPPC_NO_FLOOD | OFPPC_NO_FWD | \
120 #define OFPPS_LINK_DOWN (1 << 0)
121 #define OFPPS_STP_LISTEN (0 << 8)
122 #define OFPPS_STP_LEARN (1 << 8)
123 #define OFPPS_STP_FORWARD (2 << 8)
124 #define OFPPS_STP_BLOCK (3 << 8)
125 #define OFPPS_STP_MASK (3 << 8)
126 static const struct tok ofpps_bm
[] = {
127 { OFPPS_LINK_DOWN
, "LINK_DOWN" },
128 { OFPPS_STP_LISTEN
, "STP_LISTEN" },
129 { OFPPS_STP_LEARN
, "STP_LEARN" },
130 { OFPPS_STP_FORWARD
, "STP_FORWARD" },
131 { OFPPS_STP_BLOCK
, "STP_BLOCK" },
134 #define OFPPS_U (~(OFPPS_LINK_DOWN | OFPPS_STP_LISTEN | OFPPS_STP_LEARN | \
135 OFPPS_STP_FORWARD | OFPPS_STP_BLOCK))
137 #define OFPP_MAX 0xff00
138 #define OFPP_IN_PORT 0xfff8
139 #define OFPP_TABLE 0xfff9
140 #define OFPP_NORMAL 0xfffa
141 #define OFPP_FLOOD 0xfffb
142 #define OFPP_ALL 0xfffc
143 #define OFPP_CONTROLLER 0xfffd
144 #define OFPP_LOCAL 0xfffe
145 #define OFPP_NONE 0xffff
146 static const struct tok ofpp_str
[] = {
148 { OFPP_IN_PORT
, "IN_PORT" },
149 { OFPP_TABLE
, "TABLE" },
150 { OFPP_NORMAL
, "NORMAL" },
151 { OFPP_FLOOD
, "FLOOD" },
153 { OFPP_CONTROLLER
, "CONTROLLER" },
154 { OFPP_LOCAL
, "LOCAL" },
155 { OFPP_NONE
, "NONE" },
159 #define OFPPF_10MB_HD (1 << 0)
160 #define OFPPF_10MB_FD (1 << 1)
161 #define OFPPF_100MB_HD (1 << 2)
162 #define OFPPF_100MB_FD (1 << 3)
163 #define OFPPF_1GB_HD (1 << 4)
164 #define OFPPF_1GB_FD (1 << 5)
165 #define OFPPF_10GB_FD (1 << 6)
166 #define OFPPF_COPPER (1 << 7)
167 #define OFPPF_FIBER (1 << 8)
168 #define OFPPF_AUTONEG (1 << 9)
169 #define OFPPF_PAUSE (1 << 10)
170 #define OFPPF_PAUSE_ASYM (1 << 11)
171 static const struct tok ofppf_bm
[] = {
172 { OFPPF_10MB_HD
, "10MB_HD" },
173 { OFPPF_10MB_FD
, "10MB_FD" },
174 { OFPPF_100MB_HD
, "100MB_HD" },
175 { OFPPF_100MB_FD
, "100MB_FD" },
176 { OFPPF_1GB_HD
, "1GB_HD" },
177 { OFPPF_1GB_FD
, "1GB_FD" },
178 { OFPPF_10GB_FD
, "10GB_FD" },
179 { OFPPF_COPPER
, "COPPER" },
180 { OFPPF_FIBER
, "FIBER" },
181 { OFPPF_AUTONEG
, "AUTONEG" },
182 { OFPPF_PAUSE
, "PAUSE" },
183 { OFPPF_PAUSE_ASYM
, "PAUSE_ASYM" },
186 #define OFPPF_U (~(OFPPF_10MB_HD | OFPPF_10MB_FD | OFPPF_100MB_HD | \
187 OFPPF_100MB_FD | OFPPF_1GB_HD | OFPPF_1GB_FD | \
188 OFPPF_10GB_FD | OFPPF_COPPER | OFPPF_FIBER | \
189 OFPPF_AUTONEG | OFPPF_PAUSE | OFPPF_PAUSE_ASYM))
191 #define OFPQT_NONE 0x0000
192 #define OFPQT_MIN_RATE 0x0001
193 static const struct tok ofpqt_str
[] = {
194 { OFPQT_NONE
, "NONE" },
195 { OFPQT_MIN_RATE
, "MIN_RATE" },
199 #define OFPFW_IN_PORT (1 << 0)
200 #define OFPFW_DL_VLAN (1 << 1)
201 #define OFPFW_DL_SRC (1 << 2)
202 #define OFPFW_DL_DST (1 << 3)
203 #define OFPFW_DL_TYPE (1 << 4)
204 #define OFPFW_NW_PROTO (1 << 5)
205 #define OFPFW_TP_SRC (1 << 6)
206 #define OFPFW_TP_DST (1 << 7)
207 #define OFPFW_NW_SRC_SHIFT 8
208 #define OFPFW_NW_SRC_BITS 6
209 #define OFPFW_NW_SRC_MASK (((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT)
210 #define OFPFW_NW_DST_SHIFT 14
211 #define OFPFW_NW_DST_BITS 6
212 #define OFPFW_NW_DST_MASK (((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT)
213 #define OFPFW_DL_VLAN_PCP (1 << 20)
214 #define OFPFW_NW_TOS (1 << 21)
215 #define OFPFW_ALL ((1 << 22) - 1)
216 static const struct tok ofpfw_bm
[] = {
217 { OFPFW_IN_PORT
, "IN_PORT" },
218 { OFPFW_DL_VLAN
, "DL_VLAN" },
219 { OFPFW_DL_SRC
, "DL_SRC" },
220 { OFPFW_DL_DST
, "DL_DST" },
221 { OFPFW_DL_TYPE
, "DL_TYPE" },
222 { OFPFW_NW_PROTO
, "NW_PROTO" },
223 { OFPFW_TP_SRC
, "TP_SRC" },
224 { OFPFW_TP_DST
, "TP_DST" },
225 { OFPFW_DL_VLAN_PCP
, "DL_VLAN_PCP" },
226 { OFPFW_NW_TOS
, "NW_TOS" },
229 /* The above array does not include bits 8~13 (OFPFW_NW_SRC_*) and 14~19
230 * (OFPFW_NW_DST_*), which are not a part of the bitmap and require decoding
231 * other than that of tok2str(). The macro below includes these bits such that
232 * they are not reported as bogus in the decoding. */
233 #define OFPFW_U (~(OFPFW_ALL))
235 #define OFPAT_OUTPUT 0x0000
236 #define OFPAT_SET_VLAN_VID 0x0001
237 #define OFPAT_SET_VLAN_PCP 0x0002
238 #define OFPAT_STRIP_VLAN 0x0003
239 #define OFPAT_SET_DL_SRC 0x0004
240 #define OFPAT_SET_DL_DST 0x0005
241 #define OFPAT_SET_NW_SRC 0x0006
242 #define OFPAT_SET_NW_DST 0x0007
243 #define OFPAT_SET_NW_TOS 0x0008
244 #define OFPAT_SET_TP_SRC 0x0009
245 #define OFPAT_SET_TP_DST 0x000a
246 #define OFPAT_ENQUEUE 0x000b
247 #define OFPAT_VENDOR 0xffff
248 static const struct tok ofpat_str
[] = {
249 { OFPAT_OUTPUT
, "OUTPUT" },
250 { OFPAT_SET_VLAN_VID
, "SET_VLAN_VID" },
251 { OFPAT_SET_VLAN_PCP
, "SET_VLAN_PCP" },
252 { OFPAT_STRIP_VLAN
, "STRIP_VLAN" },
253 { OFPAT_SET_DL_SRC
, "SET_DL_SRC" },
254 { OFPAT_SET_DL_DST
, "SET_DL_DST" },
255 { OFPAT_SET_NW_SRC
, "SET_NW_SRC" },
256 { OFPAT_SET_NW_DST
, "SET_NW_DST" },
257 { OFPAT_SET_NW_TOS
, "SET_NW_TOS" },
258 { OFPAT_SET_TP_SRC
, "SET_TP_SRC" },
259 { OFPAT_SET_TP_DST
, "SET_TP_DST" },
260 { OFPAT_ENQUEUE
, "ENQUEUE" },
261 { OFPAT_VENDOR
, "VENDOR" },
265 /* bit-shifted, w/o vendor action */
266 static const struct tok ofpat_bm
[] = {
267 { 1 << OFPAT_OUTPUT
, "OUTPUT" },
268 { 1 << OFPAT_SET_VLAN_VID
, "SET_VLAN_VID" },
269 { 1 << OFPAT_SET_VLAN_PCP
, "SET_VLAN_PCP" },
270 { 1 << OFPAT_STRIP_VLAN
, "STRIP_VLAN" },
271 { 1 << OFPAT_SET_DL_SRC
, "SET_DL_SRC" },
272 { 1 << OFPAT_SET_DL_DST
, "SET_DL_DST" },
273 { 1 << OFPAT_SET_NW_SRC
, "SET_NW_SRC" },
274 { 1 << OFPAT_SET_NW_DST
, "SET_NW_DST" },
275 { 1 << OFPAT_SET_NW_TOS
, "SET_NW_TOS" },
276 { 1 << OFPAT_SET_TP_SRC
, "SET_TP_SRC" },
277 { 1 << OFPAT_SET_TP_DST
, "SET_TP_DST" },
278 { 1 << OFPAT_ENQUEUE
, "ENQUEUE" },
281 #define OFPAT_U (~(1 << OFPAT_OUTPUT | 1 << OFPAT_SET_VLAN_VID | \
282 1 << OFPAT_SET_VLAN_PCP | 1 << OFPAT_STRIP_VLAN | \
283 1 << OFPAT_SET_DL_SRC | 1 << OFPAT_SET_DL_DST | \
284 1 << OFPAT_SET_NW_SRC | 1 << OFPAT_SET_NW_DST | \
285 1 << OFPAT_SET_NW_TOS | 1 << OFPAT_SET_TP_SRC | \
286 1 << OFPAT_SET_TP_DST | 1 << OFPAT_ENQUEUE))
288 #define OFPC_FLOW_STATS (1 << 0)
289 #define OFPC_TABLE_STATS (1 << 1)
290 #define OFPC_PORT_STATS (1 << 2)
291 #define OFPC_STP (1 << 3)
292 #define OFPC_RESERVED (1 << 4)
293 #define OFPC_IP_REASM (1 << 5)
294 #define OFPC_QUEUE_STATS (1 << 6)
295 #define OFPC_ARP_MATCH_IP (1 << 7)
296 static const struct tok ofp_capabilities_bm
[] = {
297 { OFPC_FLOW_STATS
, "FLOW_STATS" },
298 { OFPC_TABLE_STATS
, "TABLE_STATS" },
299 { OFPC_PORT_STATS
, "PORT_STATS" },
301 { OFPC_RESERVED
, "RESERVED" }, /* not in the mask below */
302 { OFPC_IP_REASM
, "IP_REASM" },
303 { OFPC_QUEUE_STATS
, "QUEUE_STATS" },
304 { OFPC_ARP_MATCH_IP
, "ARP_MATCH_IP" },
307 #define OFPCAP_U (~(OFPC_FLOW_STATS | OFPC_TABLE_STATS | OFPC_PORT_STATS | \
308 OFPC_STP | OFPC_IP_REASM | OFPC_QUEUE_STATS | \
311 #define OFPC_FRAG_NORMAL 0x0000
312 #define OFPC_FRAG_DROP 0x0001
313 #define OFPC_FRAG_REASM 0x0002
314 #define OFPC_FRAG_MASK 0x0003
315 static const struct tok ofp_config_str
[] = {
316 { OFPC_FRAG_NORMAL
, "FRAG_NORMAL" },
317 { OFPC_FRAG_DROP
, "FRAG_DROP" },
318 { OFPC_FRAG_REASM
, "FRAG_REASM" },
322 #define OFPFC_ADD 0x0000
323 #define OFPFC_MODIFY 0x0001
324 #define OFPFC_MODIFY_STRICT 0x0002
325 #define OFPFC_DELETE 0x0003
326 #define OFPFC_DELETE_STRICT 0x0004
327 static const struct tok ofpfc_str
[] = {
328 { OFPFC_ADD
, "ADD" },
329 { OFPFC_MODIFY
, "MODIFY" },
330 { OFPFC_MODIFY_STRICT
, "MODIFY_STRICT" },
331 { OFPFC_DELETE
, "DELETE" },
332 { OFPFC_DELETE_STRICT
, "DELETE_STRICT" },
336 static const struct tok bufferid_str
[] = {
337 { 0xffffffff, "NONE" },
341 #define OFPFF_SEND_FLOW_REM (1 << 0)
342 #define OFPFF_CHECK_OVERLAP (1 << 1)
343 #define OFPFF_EMERG (1 << 2)
344 static const struct tok ofpff_bm
[] = {
345 { OFPFF_SEND_FLOW_REM
, "SEND_FLOW_REM" },
346 { OFPFF_CHECK_OVERLAP
, "CHECK_OVERLAP" },
347 { OFPFF_EMERG
, "EMERG" },
350 #define OFPFF_U (~(OFPFF_SEND_FLOW_REM | OFPFF_CHECK_OVERLAP | OFPFF_EMERG))
352 #define OFPST_DESC 0x0000
353 #define OFPST_FLOW 0x0001
354 #define OFPST_AGGREGATE 0x0002
355 #define OFPST_TABLE 0x0003
356 #define OFPST_PORT 0x0004
357 #define OFPST_QUEUE 0x0005
358 #define OFPST_VENDOR 0xffff
359 static const struct tok ofpst_str
[] = {
360 { OFPST_DESC
, "DESC" },
361 { OFPST_FLOW
, "FLOW" },
362 { OFPST_AGGREGATE
, "AGGREGATE" },
363 { OFPST_TABLE
, "TABLE" },
364 { OFPST_PORT
, "PORT" },
365 { OFPST_QUEUE
, "QUEUE" },
366 { OFPST_VENDOR
, "VENDOR" },
370 static const struct tok tableid_str
[] = {
376 #define OFPQ_ALL 0xffffffff
377 static const struct tok ofpq_str
[] = {
382 #define OFPSF_REPLY_MORE 0x0001
383 static const struct tok ofpsf_reply_bm
[] = {
384 { OFPSF_REPLY_MORE
, "MORE" },
387 #define OFPSF_REPLY_U (~(OFPSF_REPLY_MORE))
389 #define OFPR_NO_MATCH 0x00
390 #define OFPR_ACTION 0x01
391 static const struct tok ofpr_str
[] = {
392 { OFPR_NO_MATCH
, "NO_MATCH" },
393 { OFPR_ACTION
, "ACTION" },
397 #define OFPRR_IDLE_TIMEOUT 0x00
398 #define OFPRR_HARD_TIMEOUT 0x01
399 #define OFPRR_DELETE 0x02
400 static const struct tok ofprr_str
[] = {
401 { OFPRR_IDLE_TIMEOUT
, "IDLE_TIMEOUT" },
402 { OFPRR_HARD_TIMEOUT
, "HARD_TIMEOUT" },
403 { OFPRR_DELETE
, "DELETE" },
407 #define OFPPR_ADD 0x00
408 #define OFPPR_DELETE 0x01
409 #define OFPPR_MODIFY 0x02
410 static const struct tok ofppr_str
[] = {
411 { OFPPR_ADD
, "ADD" },
412 { OFPPR_DELETE
, "DELETE" },
413 { OFPPR_MODIFY
, "MODIFY" },
417 #define OFPET_HELLO_FAILED 0x0000
418 #define OFPET_BAD_REQUEST 0x0001
419 #define OFPET_BAD_ACTION 0x0002
420 #define OFPET_FLOW_MOD_FAILED 0x0003
421 #define OFPET_PORT_MOD_FAILED 0x0004
422 #define OFPET_QUEUE_OP_FAILED 0x0005
423 static const struct tok ofpet_str
[] = {
424 { OFPET_HELLO_FAILED
, "HELLO_FAILED" },
425 { OFPET_BAD_REQUEST
, "BAD_REQUEST" },
426 { OFPET_BAD_ACTION
, "BAD_ACTION" },
427 { OFPET_FLOW_MOD_FAILED
, "FLOW_MOD_FAILED" },
428 { OFPET_PORT_MOD_FAILED
, "PORT_MOD_FAILED" },
429 { OFPET_QUEUE_OP_FAILED
, "QUEUE_OP_FAILED" },
433 #define OFPHFC_INCOMPATIBLE 0x0000
434 #define OFPHFC_EPERM 0x0001
435 static const struct tok ofphfc_str
[] = {
436 { OFPHFC_INCOMPATIBLE
, "INCOMPATIBLE" },
437 { OFPHFC_EPERM
, "EPERM" },
441 #define OFPBRC_BAD_VERSION 0x0000
442 #define OFPBRC_BAD_TYPE 0x0001
443 #define OFPBRC_BAD_STAT 0x0002
444 #define OFPBRC_BAD_VENDOR 0x0003
445 #define OFPBRC_BAD_SUBTYPE 0x0004
446 #define OFPBRC_EPERM 0x0005
447 #define OFPBRC_BAD_LEN 0x0006
448 #define OFPBRC_BUFFER_EMPTY 0x0007
449 #define OFPBRC_BUFFER_UNKNOWN 0x0008
450 static const struct tok ofpbrc_str
[] = {
451 { OFPBRC_BAD_VERSION
, "BAD_VERSION" },
452 { OFPBRC_BAD_TYPE
, "BAD_TYPE" },
453 { OFPBRC_BAD_STAT
, "BAD_STAT" },
454 { OFPBRC_BAD_VENDOR
, "BAD_VENDOR" },
455 { OFPBRC_BAD_SUBTYPE
, "BAD_SUBTYPE" },
456 { OFPBRC_EPERM
, "EPERM" },
457 { OFPBRC_BAD_LEN
, "BAD_LEN" },
458 { OFPBRC_BUFFER_EMPTY
, "BUFFER_EMPTY" },
459 { OFPBRC_BUFFER_UNKNOWN
, "BUFFER_UNKNOWN" },
463 #define OFPBAC_BAD_TYPE 0x0000
464 #define OFPBAC_BAD_LEN 0x0001
465 #define OFPBAC_BAD_VENDOR 0x0002
466 #define OFPBAC_BAD_VENDOR_TYPE 0x0003
467 #define OFPBAC_BAD_OUT_PORT 0x0004
468 #define OFPBAC_BAD_ARGUMENT 0x0005
469 #define OFPBAC_EPERM 0x0006
470 #define OFPBAC_TOO_MANY 0x0007
471 #define OFPBAC_BAD_QUEUE 0x0008
472 static const struct tok ofpbac_str
[] = {
473 { OFPBAC_BAD_TYPE
, "BAD_TYPE" },
474 { OFPBAC_BAD_LEN
, "BAD_LEN" },
475 { OFPBAC_BAD_VENDOR
, "BAD_VENDOR" },
476 { OFPBAC_BAD_VENDOR_TYPE
, "BAD_VENDOR_TYPE" },
477 { OFPBAC_BAD_OUT_PORT
, "BAD_OUT_PORT" },
478 { OFPBAC_BAD_ARGUMENT
, "BAD_ARGUMENT" },
479 { OFPBAC_EPERM
, "EPERM" },
480 { OFPBAC_TOO_MANY
, "TOO_MANY" },
481 { OFPBAC_BAD_QUEUE
, "BAD_QUEUE" },
485 #define OFPFMFC_ALL_TABLES_FULL 0x0000
486 #define OFPFMFC_OVERLAP 0x0001
487 #define OFPFMFC_EPERM 0x0002
488 #define OFPFMFC_BAD_EMERG_TIMEOUT 0x0003
489 #define OFPFMFC_BAD_COMMAND 0x0004
490 #define OFPFMFC_UNSUPPORTED 0x0005
491 static const struct tok ofpfmfc_str
[] = {
492 { OFPFMFC_ALL_TABLES_FULL
, "ALL_TABLES_FULL" },
493 { OFPFMFC_OVERLAP
, "OVERLAP" },
494 { OFPFMFC_EPERM
, "EPERM" },
495 { OFPFMFC_BAD_EMERG_TIMEOUT
, "BAD_EMERG_TIMEOUT" },
496 { OFPFMFC_BAD_COMMAND
, "BAD_COMMAND" },
497 { OFPFMFC_UNSUPPORTED
, "UNSUPPORTED" },
501 #define OFPPMFC_BAD_PORT 0x0000
502 #define OFPPMFC_BAD_HW_ADDR 0x0001
503 static const struct tok ofppmfc_str
[] = {
504 { OFPPMFC_BAD_PORT
, "BAD_PORT" },
505 { OFPPMFC_BAD_HW_ADDR
, "BAD_HW_ADDR" },
509 #define OFPQOFC_BAD_PORT 0x0000
510 #define OFPQOFC_BAD_QUEUE 0x0001
511 #define OFPQOFC_EPERM 0x0002
512 static const struct tok ofpqofc_str
[] = {
513 { OFPQOFC_BAD_PORT
, "BAD_PORT" },
514 { OFPQOFC_BAD_QUEUE
, "BAD_QUEUE" },
515 { OFPQOFC_EPERM
, "EPERM" },
519 static const struct tok empty_str
[] = {
523 /* lengths (fixed or minimal) of particular protocol structures */
524 #define OF_SWITCH_CONFIG_LEN 12
525 #define OF_PHY_PORT_LEN 48
526 #define OF_SWITCH_FEATURES_LEN 32
527 #define OF_PORT_STATUS_LEN 64
528 #define OF_PORT_MOD_LEN 32
529 #define OF_PACKET_IN_LEN 20
530 #define OF_ACTION_OUTPUT_LEN 8
531 #define OF_ACTION_VLAN_VID_LEN 8
532 #define OF_ACTION_VLAN_PCP_LEN 8
533 #define OF_ACTION_DL_ADDR_LEN 16
534 #define OF_ACTION_NW_ADDR_LEN 8
535 #define OF_ACTION_TP_PORT_LEN 8
536 #define OF_ACTION_NW_TOS_LEN 8
537 #define OF_ACTION_VENDOR_HEADER_LEN 8
538 #define OF_ACTION_HEADER_LEN 8
539 #define OF_PACKET_OUT_LEN 16
540 #define OF_MATCH_LEN 40
541 #define OF_FLOW_MOD_LEN 72
542 #define OF_FLOW_REMOVED_LEN 88
543 #define OF_ERROR_MSG_LEN 12
544 #define OF_STATS_REQUEST_LEN 12
545 #define OF_STATS_REPLY_LEN 12
546 #define OF_DESC_STATS_LEN 1056
547 #define OF_FLOW_STATS_REQUEST_LEN 44
548 #define OF_FLOW_STATS_LEN 88
549 #define OF_AGGREGATE_STATS_REQUEST_LEN 44
550 #define OF_AGGREGATE_STATS_REPLY_LEN 24
551 #define OF_TABLE_STATS_LEN 64
552 #define OF_PORT_STATS_REQUEST_LEN 8
553 #define OF_PORT_STATS_LEN 104
554 #define OF_VENDOR_HEADER_LEN 12
555 #define OF_QUEUE_PROP_HEADER_LEN 8
556 #define OF_QUEUE_PROP_MIN_RATE_LEN 16
557 #define OF_PACKET_QUEUE_LEN 8
558 #define OF_QUEUE_GET_CONFIG_REQUEST_LEN 12
559 #define OF_QUEUE_GET_CONFIG_REPLY_LEN 16
560 #define OF_ACTION_ENQUEUE_LEN 16
561 #define OF_QUEUE_STATS_REQUEST_LEN 8
562 #define OF_QUEUE_STATS_LEN 32
564 /* miscellaneous constants from [OF10] */
565 #define OFP_MAX_TABLE_NAME_LEN 32
566 #define OFP_MAX_PORT_NAME_LEN 16
567 #define DESC_STR_LEN 256
568 #define SERIAL_NUM_LEN 32
569 #define OFP_ETH_ALEN 6
570 #define OFP_VLAN_NONE 0xffff
573 vlan_str(const uint16_t vid
) {
574 static char buf
[sizeof("65535 (bogus)")];
577 if (vid
== OFP_VLAN_NONE
)
579 fmt
= (vid
> 0 && vid
< 0x0fff) ? "%u" : "%u (bogus)";
580 snprintf(buf
, sizeof(buf
), fmt
, vid
);
585 pcp_str(const uint8_t pcp
) {
586 static char buf
[sizeof("255 (bogus)")];
587 snprintf(buf
, sizeof(buf
), pcp
<= 7 ? "%u" : "%u (bogus)", pcp
);
592 of10_bitmap_print(const struct tok
*t
, const uint32_t v
, const uint32_t u
) {
593 const char *sep
= " (";
598 for (; t
->s
!= NULL
; t
++)
600 printf("%s%s", sep
, t
->s
);
603 /* unassigned bits? */
604 printf(v
& u
? ") (bogus)" : ")");
607 static const u_char
*
608 of10_data_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
612 printf("\n\t data (%u octets)", len
);
615 hex_and_ascii_print("\n\t ", cp
, len
);
619 printf(" [|openflow]");
623 /* Vendor ID is mandatory, data is optional. */
624 static const u_char
*
625 of10_vendor_data_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
630 printf(", vendor 0x%08x", EXTRACT_32BITS(cp
));
633 return of10_data_print(cp
, ep
, len
- 4);
635 corrupt
: /* skip the undersized data */
636 printf(" (corrupt)");
640 printf(" [|openflow]");
644 /* [OF10] Section 5.2.1 */
645 static const u_char
*
646 of10_phy_ports_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
647 const u_char
*cp0
= cp
;
648 const u_int len0
= len
;
651 if (len
< OF_PHY_PORT_LEN
)
655 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
658 TCHECK2(*cp
, OFP_ETH_ALEN
);
659 printf(", hw_addr %s", etheraddr_string(cp
));
662 TCHECK2(*cp
, OFP_MAX_PORT_NAME_LEN
);
664 fn_print(cp
, cp
+ OFP_MAX_PORT_NAME_LEN
);
666 cp
+= OFP_MAX_PORT_NAME_LEN
;
675 printf("\n\t config 0x%08x", EXTRACT_32BITS(cp
));
676 of10_bitmap_print(ofppc_bm
, EXTRACT_32BITS(cp
), OFPPC_U
);
680 printf("\n\t state 0x%08x", EXTRACT_32BITS(cp
));
681 of10_bitmap_print(ofpps_bm
, EXTRACT_32BITS(cp
), OFPPS_U
);
685 printf("\n\t curr 0x%08x", EXTRACT_32BITS(cp
));
686 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
690 printf("\n\t advertised 0x%08x", EXTRACT_32BITS(cp
));
691 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
695 printf("\n\t supported 0x%08x", EXTRACT_32BITS(cp
));
696 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
700 printf("\n\t peer 0x%08x", EXTRACT_32BITS(cp
));
701 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
704 len
-= OF_PHY_PORT_LEN
;
708 corrupt
: /* skip the undersized trailing data */
709 printf(" (corrupt)");
713 printf(" [|openflow]");
717 /* [OF10] Section 5.2.2 */
718 static const u_char
*
719 of10_queue_props_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
720 const u_char
*cp0
= cp
;
721 const u_int len0
= len
;
722 uint16_t property
, plen
, rate
;
725 u_char plen_bogus
= 0, skip
= 0;
727 if (len
< OF_QUEUE_PROP_HEADER_LEN
)
731 property
= EXTRACT_16BITS(cp
);
733 printf("\n\t property %s", tok2str(ofpqt_str
, "invalid (0x%04x)", property
));
736 plen
= EXTRACT_16BITS(cp
);
738 printf(", len %u", plen
);
739 if (plen
< OF_QUEUE_PROP_HEADER_LEN
|| plen
> len
)
744 /* property-specific constraints and decoding */
747 plen_bogus
= plen
!= OF_QUEUE_PROP_HEADER_LEN
;
750 plen_bogus
= plen
!= OF_QUEUE_PROP_MIN_RATE_LEN
;
760 TCHECK2(*cp
, plen
- 4);
764 if (property
== OFPQT_MIN_RATE
) { /* the only case of property decoding */
767 rate
= EXTRACT_16BITS(cp
);
770 printf(", rate disabled");
772 printf(", rate %u.%u%%", rate
/ 10, rate
% 10);
782 corrupt
: /* skip the rest of queue properties */
783 printf(" (corrupt)");
787 printf(" [|openflow]");
792 static const u_char
*
793 of10_queues_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
794 const u_char
*cp0
= cp
;
795 const u_int len0
= len
;
799 if (len
< OF_PACKET_QUEUE_LEN
)
803 printf("\n\t queue_id %u", EXTRACT_32BITS(cp
));
807 desclen
= EXTRACT_16BITS(cp
);
809 printf(", len %u", desclen
);
810 if (desclen
< OF_PACKET_QUEUE_LEN
|| desclen
> len
)
817 TCHECK2(*cp
, desclen
- OF_PACKET_QUEUE_LEN
);
818 cp
+= desclen
- OF_PACKET_QUEUE_LEN
;
821 if (ep
== (cp
= of10_queue_props_print(cp
, ep
, desclen
- OF_PACKET_QUEUE_LEN
)))
822 return ep
; /* end of snapshot */
828 corrupt
: /* skip the rest of queues */
829 printf(" (corrupt)");
833 printf(" [|openflow]");
837 /* [OF10] Section 5.2.3 */
838 static const u_char
*
839 of10_match_print(const char *pfx
, const u_char
*cp
, const u_char
*ep
) {
844 const char *field_name
;
848 wildcards
= EXTRACT_32BITS(cp
);
849 if (wildcards
& OFPFW_U
)
850 printf("%swildcards 0x%08x (bogus)", pfx
, wildcards
);
854 if (! (wildcards
& OFPFW_IN_PORT
))
855 printf("%smatch in_port %s", pfx
, tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
858 TCHECK2(*cp
, OFP_ETH_ALEN
);
859 if (! (wildcards
& OFPFW_DL_SRC
))
860 printf("%smatch dl_src %s", pfx
, etheraddr_string(cp
));
863 TCHECK2(*cp
, OFP_ETH_ALEN
);
864 if (! (wildcards
& OFPFW_DL_DST
))
865 printf("%smatch dl_dst %s", pfx
, etheraddr_string(cp
));
869 if (! (wildcards
& OFPFW_DL_VLAN
))
870 printf("%smatch dl_vlan %s", pfx
, vlan_str(EXTRACT_16BITS(cp
)));
874 if (! (wildcards
& OFPFW_DL_VLAN_PCP
))
875 printf("%smatch dl_vlan_pcp %s", pfx
, pcp_str(*cp
));
882 dl_type
= EXTRACT_16BITS(cp
);
884 if (! (wildcards
& OFPFW_DL_TYPE
))
885 printf("%smatch dl_type 0x%04x", pfx
, dl_type
);
888 if (! (wildcards
& OFPFW_NW_TOS
))
889 printf("%smatch nw_tos 0x%02x", pfx
, *cp
);
895 if (! (wildcards
& OFPFW_NW_PROTO
)) {
896 field_name
= ! (wildcards
& OFPFW_DL_TYPE
) && dl_type
== ETHERTYPE_ARP
897 ? "arp_opcode" : "nw_proto";
898 printf("%smatch %s %u", pfx
, field_name
, nw_proto
);
905 nw_bits
= (wildcards
& OFPFW_NW_SRC_MASK
) >> OFPFW_NW_SRC_SHIFT
;
907 printf("%smatch nw_src %s/%u", pfx
, ipaddr_string(cp
), 32 - nw_bits
);
911 nw_bits
= (wildcards
& OFPFW_NW_DST_MASK
) >> OFPFW_NW_DST_SHIFT
;
913 printf("%smatch nw_dst %s/%u", pfx
, ipaddr_string(cp
), 32 - nw_bits
);
917 if (! (wildcards
& OFPFW_TP_SRC
)) {
918 field_name
= ! (wildcards
& OFPFW_DL_TYPE
) && dl_type
== ETHERTYPE_IP
919 && ! (wildcards
& OFPFW_NW_PROTO
) && nw_proto
== IPPROTO_ICMP
920 ? "icmp_type" : "tp_src";
921 printf("%smatch %s %u", pfx
, field_name
, EXTRACT_16BITS(cp
));
926 if (! (wildcards
& OFPFW_TP_DST
)) {
927 field_name
= ! (wildcards
& OFPFW_DL_TYPE
) && dl_type
== ETHERTYPE_IP
928 && ! (wildcards
& OFPFW_NW_PROTO
) && nw_proto
== IPPROTO_ICMP
929 ? "icmp_code" : "tp_dst";
930 printf("%smatch %s %u", pfx
, field_name
, EXTRACT_16BITS(cp
));
935 printf(" [|openflow]");
939 /* [OF10] Section 5.2.4 */
940 static const u_char
*
941 of10_actions_print(const char *pfx
, const u_char
*cp
, const u_char
*ep
,
943 const u_char
*cp0
= cp
;
944 const u_int len0
= len
;
945 uint16_t type
, alen
, output_port
;
948 u_char alen_bogus
= 0, skip
= 0;
950 if (len
< OF_ACTION_HEADER_LEN
)
954 type
= EXTRACT_16BITS(cp
);
956 printf("%saction type %s", pfx
, tok2str(ofpat_str
, "invalid (0x%04x)", type
));
959 alen
= EXTRACT_16BITS(cp
);
961 printf(", len %u", alen
);
962 /* On action size underrun/overrun skip the rest of the action list. */
963 if (alen
< OF_ACTION_HEADER_LEN
|| alen
> len
)
965 /* On action size inappropriate for the given type or invalid type just skip
966 * the current action, as the basic length constraint has been met. */
969 case OFPAT_SET_VLAN_VID
:
970 case OFPAT_SET_VLAN_PCP
:
971 case OFPAT_STRIP_VLAN
:
972 case OFPAT_SET_NW_SRC
:
973 case OFPAT_SET_NW_DST
:
974 case OFPAT_SET_NW_TOS
:
975 case OFPAT_SET_TP_SRC
:
976 case OFPAT_SET_TP_DST
:
977 alen_bogus
= alen
!= 8;
979 case OFPAT_SET_DL_SRC
:
980 case OFPAT_SET_DL_DST
:
982 alen_bogus
= alen
!= 16;
985 alen_bogus
= alen
% 8 != 0; /* already >= 8 so far */
995 TCHECK2(*cp
, alen
- 4);
999 /* OK to decode the rest of the action structure */
1004 output_port
= EXTRACT_16BITS(cp
);
1006 printf(", port %s", tok2str(ofpp_str
, "%u", output_port
));
1009 if (output_port
== OFPP_CONTROLLER
)
1010 printf(", max_len %u", EXTRACT_16BITS(cp
));
1013 case OFPAT_SET_VLAN_VID
:
1016 printf(", vlan_vid %s", vlan_str(EXTRACT_16BITS(cp
)));
1022 case OFPAT_SET_VLAN_PCP
:
1025 printf(", vlan_pcp %s", pcp_str(*cp
));
1031 case OFPAT_SET_DL_SRC
:
1032 case OFPAT_SET_DL_DST
:
1034 TCHECK2(*cp
, OFP_ETH_ALEN
);
1035 printf(", dl_addr %s", etheraddr_string(cp
));
1041 case OFPAT_SET_NW_SRC
:
1042 case OFPAT_SET_NW_DST
:
1045 printf(", nw_addr %s", ipaddr_string(cp
));
1048 case OFPAT_SET_NW_TOS
:
1051 printf(", nw_tos 0x%02x", *cp
);
1057 case OFPAT_SET_TP_SRC
:
1058 case OFPAT_SET_TP_DST
:
1061 printf(", tp_port %u", EXTRACT_16BITS(cp
));
1070 printf(", port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1077 printf(", queue_id %s", tok2str(ofpq_str
, "%u", EXTRACT_32BITS(cp
)));
1081 if (ep
== (cp
= of10_vendor_data_print(cp
, ep
, alen
- 4)))
1082 return ep
; /* end of snapshot */
1084 case OFPAT_STRIP_VLAN
:
1095 corrupt
: /* skip the rest of actions */
1096 printf(" (corrupt)");
1097 TCHECK2(*cp0
, len0
);
1100 printf(" [|openflow]");
1104 /* [OF10] Section 5.3.1 */
1105 static const u_char
*
1106 of10_features_reply_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1109 printf("\n\t dpid 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1113 printf(", n_buffers %u", EXTRACT_32BITS(cp
));
1117 printf(", n_tables %u", *cp
);
1124 printf("\n\t capabilities 0x%08x", EXTRACT_32BITS(cp
));
1125 of10_bitmap_print(ofp_capabilities_bm
, EXTRACT_32BITS(cp
), OFPCAP_U
);
1129 printf("\n\t actions 0x%08x", EXTRACT_32BITS(cp
));
1130 of10_bitmap_print(ofpat_bm
, EXTRACT_32BITS(cp
), OFPAT_U
);
1133 return of10_phy_ports_print(cp
, ep
, len
- OF_SWITCH_FEATURES_LEN
);
1136 printf(" [|openflow]");
1140 /* [OF10] Section 5.3.3 */
1141 static const u_char
*
1142 of10_flow_mod_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1146 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1147 return ep
; /* end of snapshot */
1150 printf("\n\t cookie 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1154 command
= EXTRACT_16BITS(cp
);
1155 printf(", command %s", tok2str(ofpfc_str
, "invalid (0x%04x)", command
));
1159 if (EXTRACT_16BITS(cp
))
1160 printf(", idle_timeout %u", EXTRACT_16BITS(cp
));
1164 if (EXTRACT_16BITS(cp
))
1165 printf(", hard_timeout %u", EXTRACT_16BITS(cp
));
1169 if (EXTRACT_16BITS(cp
))
1170 printf(", priority %u", EXTRACT_16BITS(cp
));
1174 if (command
== OFPFC_ADD
|| command
== OFPFC_MODIFY
||
1175 command
== OFPFC_MODIFY_STRICT
)
1176 printf(", buffer_id %s", tok2str(bufferid_str
, "0x%08x", EXTRACT_32BITS(cp
)));
1180 if (command
== OFPFC_DELETE
|| command
== OFPFC_DELETE_STRICT
)
1181 printf(", out_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1185 printf(", flags 0x%04x", EXTRACT_16BITS(cp
));
1186 of10_bitmap_print(ofpff_bm
, EXTRACT_16BITS(cp
), OFPFF_U
);
1189 return of10_actions_print("\n\t ", cp
, ep
, len
- OF_FLOW_MOD_LEN
);
1192 printf(" [|openflow]");
1197 static const u_char
*
1198 of10_port_mod_print(const u_char
*cp
, const u_char
*ep
) {
1201 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1204 TCHECK2(*cp
, OFP_ETH_ALEN
);
1205 printf(", hw_addr %s", etheraddr_string(cp
));
1209 printf("\n\t config 0x%08x", EXTRACT_32BITS(cp
));
1210 of10_bitmap_print(ofppc_bm
, EXTRACT_32BITS(cp
), OFPPC_U
);
1214 printf("\n\t mask 0x%08x", EXTRACT_32BITS(cp
));
1215 of10_bitmap_print(ofppc_bm
, EXTRACT_32BITS(cp
), OFPPC_U
);
1219 printf("\n\t advertise 0x%08x", EXTRACT_32BITS(cp
));
1220 of10_bitmap_print(ofppf_bm
, EXTRACT_32BITS(cp
), OFPPF_U
);
1227 printf(" [|openflow]");
1231 /* [OF10] Section 5.3.5 */
1232 static const u_char
*
1233 of10_stats_request_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1234 const u_char
*cp0
= cp
;
1235 const u_int len0
= len
;
1240 type
= EXTRACT_16BITS(cp
);
1242 printf("\n\t type %s", tok2str(ofpst_str
, "invalid (0x%04x)", type
));
1245 printf(", flags 0x%04x", EXTRACT_16BITS(cp
));
1246 if (EXTRACT_16BITS(cp
))
1249 /* type-specific body of one of fixed lengths */
1250 len
-= OF_STATS_REQUEST_LEN
;
1258 case OFPST_AGGREGATE
:
1259 if (len
!= OF_FLOW_STATS_REQUEST_LEN
)
1262 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1263 return ep
; /* end of snapshot */
1266 printf("\n\t table_id %s", tok2str(tableid_str
, "%u", *cp
));
1273 printf(", out_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1276 if (len
!= OF_PORT_STATS_REQUEST_LEN
)
1280 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1286 if (len
!= OF_QUEUE_STATS_REQUEST_LEN
)
1290 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1297 printf(", queue_id %s", tok2str(ofpq_str
, "%u", EXTRACT_32BITS(cp
)));
1300 return of10_vendor_data_print(cp
, ep
, len
);
1304 corrupt
: /* skip the message body */
1305 printf(" (corrupt)");
1306 TCHECK2(*cp0
, len0
);
1309 printf(" [|openflow]");
1314 static const u_char
*
1315 of10_desc_stats_reply_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1316 if (len
!= OF_DESC_STATS_LEN
)
1319 TCHECK2(*cp
, DESC_STR_LEN
);
1320 printf("\n\t mfr_desc '");
1321 fn_print(cp
, cp
+ DESC_STR_LEN
);
1325 TCHECK2(*cp
, DESC_STR_LEN
);
1326 printf("\n\t hw_desc '");
1327 fn_print(cp
, cp
+ DESC_STR_LEN
);
1331 TCHECK2(*cp
, DESC_STR_LEN
);
1332 printf("\n\t sw_desc '");
1333 fn_print(cp
, cp
+ DESC_STR_LEN
);
1337 TCHECK2(*cp
, SERIAL_NUM_LEN
);
1338 printf("\n\t serial_num '");
1339 fn_print(cp
, cp
+ SERIAL_NUM_LEN
);
1341 cp
+= SERIAL_NUM_LEN
;
1343 TCHECK2(*cp
, DESC_STR_LEN
);
1344 printf("\n\t dp_desc '");
1345 fn_print(cp
, cp
+ DESC_STR_LEN
);
1347 return cp
+ DESC_STR_LEN
;
1349 corrupt
: /* skip the message body */
1350 printf(" (corrupt)");
1354 printf(" [|openflow]");
1359 static const u_char
*
1360 of10_flow_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1361 const u_char
*cp0
= cp
;
1362 const u_int len0
= len
;
1366 if (len
< OF_FLOW_STATS_LEN
)
1370 entry_len
= EXTRACT_16BITS(cp
);
1371 printf("\n\t length %u", entry_len
);
1372 if (entry_len
< OF_FLOW_STATS_LEN
|| entry_len
> len
)
1377 printf(", table_id %s", tok2str(tableid_str
, "%u", *cp
));
1383 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1384 return ep
; /* end of snapshot */
1387 printf("\n\t duration_sec %u", EXTRACT_32BITS(cp
));
1391 printf(", duration_nsec %u", EXTRACT_32BITS(cp
));
1395 printf(", priority %u", EXTRACT_16BITS(cp
));
1399 printf(", idle_timeout %u", EXTRACT_16BITS(cp
));
1403 printf(", hard_timeout %u", EXTRACT_16BITS(cp
));
1410 printf(", cookie 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1414 printf(", packet_count %" PRIu64
, EXTRACT_64BITS(cp
));
1418 printf(", byte_count %" PRIu64
, EXTRACT_64BITS(cp
));
1421 if (ep
== (cp
= of10_actions_print("\n\t ", cp
, ep
, entry_len
- OF_FLOW_STATS_LEN
)))
1422 return ep
; /* end of snapshot */
1428 corrupt
: /* skip the rest of flow statistics entries */
1429 printf(" (corrupt)");
1430 TCHECK2(*cp0
, len0
);
1433 printf(" [|openflow]");
1438 static const u_char
*
1439 of10_aggregate_stats_reply_print(const u_char
*cp
, const u_char
*ep
,
1441 if (len
!= OF_AGGREGATE_STATS_REPLY_LEN
)
1445 printf("\n\t packet_count %" PRIu64
, EXTRACT_64BITS(cp
));
1449 printf(", byte_count %" PRIu64
, EXTRACT_64BITS(cp
));
1453 printf(", flow_count %u", EXTRACT_32BITS(cp
));
1459 corrupt
: /* skip the message body */
1460 printf(" (corrupt)");
1464 printf(" [|openflow]");
1469 static const u_char
*
1470 of10_table_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1471 const u_char
*cp0
= cp
;
1472 const u_int len0
= len
;
1475 if (len
< OF_TABLE_STATS_LEN
)
1479 printf("\n\t table_id %s", tok2str(tableid_str
, "%u", *cp
));
1485 TCHECK2(*cp
, OFP_MAX_TABLE_NAME_LEN
);
1487 fn_print(cp
, cp
+ OFP_MAX_TABLE_NAME_LEN
);
1489 cp
+= OFP_MAX_TABLE_NAME_LEN
;
1492 printf("\n\t wildcards 0x%08x", EXTRACT_32BITS(cp
));
1493 of10_bitmap_print(ofpfw_bm
, EXTRACT_32BITS(cp
), OFPFW_U
);
1497 printf("\n\t max_entries %u", EXTRACT_32BITS(cp
));
1501 printf(", active_count %u", EXTRACT_32BITS(cp
));
1505 printf(", lookup_count %" PRIu64
, EXTRACT_64BITS(cp
));
1509 printf(", matched_count %" PRIu64
, EXTRACT_64BITS(cp
));
1512 len
-= OF_TABLE_STATS_LEN
;
1516 corrupt
: /* skip the undersized trailing data */
1517 printf(" (corrupt)");
1518 TCHECK2(*cp0
, len0
);
1521 printf(" [|openflow]");
1526 static const u_char
*
1527 of10_port_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1528 const u_char
*cp0
= cp
;
1529 const u_int len0
= len
;
1532 if (len
< OF_PORT_STATS_LEN
)
1536 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1539 TCHECK2(*cp
, OF_PORT_STATS_LEN
- 2);
1540 cp
+= OF_PORT_STATS_LEN
- 2;
1548 printf(", rx_packets %" PRIu64
, EXTRACT_64BITS(cp
));
1552 printf(", tx_packets %" PRIu64
, EXTRACT_64BITS(cp
));
1556 printf(", rx_bytes %" PRIu64
, EXTRACT_64BITS(cp
));
1560 printf(", tx_bytes %" PRIu64
, EXTRACT_64BITS(cp
));
1564 printf(", rx_dropped %" PRIu64
, EXTRACT_64BITS(cp
));
1568 printf(", tx_dropped %" PRIu64
, EXTRACT_64BITS(cp
));
1572 printf(", rx_errors %" PRIu64
, EXTRACT_64BITS(cp
));
1576 printf(", tx_errors %" PRIu64
, EXTRACT_64BITS(cp
));
1580 printf(", rx_frame_err %" PRIu64
, EXTRACT_64BITS(cp
));
1584 printf(", rx_over_err %" PRIu64
, EXTRACT_64BITS(cp
));
1588 printf(", rx_crc_err %" PRIu64
, EXTRACT_64BITS(cp
));
1592 printf(", collisions %" PRIu64
, EXTRACT_64BITS(cp
));
1595 len
-= OF_PORT_STATS_LEN
;
1599 corrupt
: /* skip the undersized trailing data */
1600 printf(" (corrupt)");
1601 TCHECK2(*cp0
, len0
);
1604 printf(" [|openflow]");
1609 static const u_char
*
1610 of10_queue_stats_reply_print(const u_char
*cp
, const u_char
*ep
, u_int len
) {
1611 const u_char
*cp0
= cp
;
1612 const u_int len0
= len
;
1615 if (len
< OF_QUEUE_STATS_LEN
)
1619 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1626 printf(", queue_id %u", EXTRACT_32BITS(cp
));
1630 printf(", tx_bytes %" PRIu64
, EXTRACT_64BITS(cp
));
1634 printf(", tx_packets %" PRIu64
, EXTRACT_64BITS(cp
));
1638 printf(", tx_errors %" PRIu64
, EXTRACT_64BITS(cp
));
1641 len
-= OF_QUEUE_STATS_LEN
;
1645 corrupt
: /* skip the undersized trailing data */
1646 printf(" (corrupt)");
1647 TCHECK2(*cp0
, len0
);
1650 printf(" [|openflow]");
1655 static const u_char
*
1656 of10_stats_reply_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1657 const u_char
*cp0
= cp
;
1662 type
= EXTRACT_16BITS(cp
);
1663 printf("\n\t type %s", tok2str(ofpst_str
, "invalid (0x%04x)", type
));
1667 printf(", flags 0x%04x", EXTRACT_16BITS(cp
));
1668 of10_bitmap_print(ofpsf_reply_bm
, EXTRACT_16BITS(cp
), OFPSF_REPLY_U
);
1672 const u_char
*(*decoder
)(const u_char
*, const u_char
*, u_int
) =
1673 type
== OFPST_DESC
? of10_desc_stats_reply_print
:
1674 type
== OFPST_FLOW
? of10_flow_stats_reply_print
:
1675 type
== OFPST_AGGREGATE
? of10_aggregate_stats_reply_print
:
1676 type
== OFPST_TABLE
? of10_table_stats_reply_print
:
1677 type
== OFPST_PORT
? of10_port_stats_reply_print
:
1678 type
== OFPST_QUEUE
? of10_queue_stats_reply_print
:
1679 type
== OFPST_VENDOR
? of10_vendor_data_print
:
1681 if (decoder
!= NULL
)
1682 return decoder(cp
, ep
, len
- OF_STATS_REPLY_LEN
);
1688 printf(" [|openflow]");
1692 /* [OF10] Section 5.3.6 */
1693 static const u_char
*
1694 of10_packet_out_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1695 const u_char
*cp0
= cp
;
1696 const u_int len0
= len
;
1697 uint16_t actions_len
;
1701 printf("\n\t buffer_id 0x%08x", EXTRACT_32BITS(cp
));
1705 printf(", in_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1709 actions_len
= EXTRACT_16BITS(cp
);
1711 if (actions_len
> len
- OF_PACKET_OUT_LEN
)
1714 if (ep
== (cp
= of10_actions_print("\n\t ", cp
, ep
, actions_len
)))
1715 return ep
; /* end of snapshot */
1717 return of10_data_print(cp
, ep
, len
- OF_PACKET_OUT_LEN
- actions_len
);
1719 corrupt
: /* skip the rest of the message body */
1720 printf(" (corrupt)");
1721 TCHECK2(*cp0
, len0
);
1724 printf(" [|openflow]");
1728 /* [OF10] Section 5.4.1 */
1729 static const u_char
*
1730 of10_packet_in_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1733 printf("\n\t buffer_id %s", tok2str(bufferid_str
, "0x%08x", EXTRACT_32BITS(cp
)));
1737 printf(", total_len %u", EXTRACT_16BITS(cp
));
1741 printf(", in_port %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1745 printf(", reason %s", tok2str(ofpr_str
, "invalid (0x%02x)", *cp
));
1751 /* 2 mock octets count in OF_PACKET_IN_LEN but not in len */
1752 return of10_data_print(cp
, ep
, len
- (OF_PACKET_IN_LEN
- 2));
1755 printf(" [|openflow]");
1759 /* [OF10] Section 5.4.2 */
1760 static const u_char
*
1761 of10_flow_removed_print(const u_char
*cp
, const u_char
*ep
) {
1763 if (ep
== (cp
= of10_match_print("\n\t ", cp
, ep
)))
1764 return ep
; /* end of snapshot */
1767 printf("\n\t cookie 0x%016" PRIx64
, EXTRACT_64BITS(cp
));
1771 if (EXTRACT_16BITS(cp
))
1772 printf(", priority %u", EXTRACT_16BITS(cp
));
1776 printf(", reason %s", tok2str(ofprr_str
, "unknown (0x%02x)", *cp
));
1783 printf(", duration_sec %u", EXTRACT_32BITS(cp
));
1787 printf(", duration_nsec %u", EXTRACT_32BITS(cp
));
1791 if (EXTRACT_16BITS(cp
))
1792 printf(", idle_timeout %u", EXTRACT_16BITS(cp
));
1799 printf(", packet_count %" PRIu64
, EXTRACT_64BITS(cp
));
1803 printf(", byte_count %" PRIu64
, EXTRACT_64BITS(cp
));
1807 printf(" [|openflow]");
1811 /* [OF10] Section 5.4.4 */
1812 static const u_char
*
1813 of10_error_print(const u_char
*cp
, const u_char
*ep
, const u_int len
) {
1815 const struct tok
*code_str
;
1819 type
= EXTRACT_16BITS(cp
);
1821 printf("\n\t type %s", tok2str(ofpet_str
, "invalid (0x%04x)", type
));
1825 type
== OFPET_HELLO_FAILED
? ofphfc_str
:
1826 type
== OFPET_BAD_REQUEST
? ofpbrc_str
:
1827 type
== OFPET_BAD_ACTION
? ofpbac_str
:
1828 type
== OFPET_FLOW_MOD_FAILED
? ofpfmfc_str
:
1829 type
== OFPET_PORT_MOD_FAILED
? ofppmfc_str
:
1830 type
== OFPET_QUEUE_OP_FAILED
? ofpqofc_str
:
1832 printf(", code %s", tok2str(code_str
, "invalid (0x%04x)", EXTRACT_16BITS(cp
)));
1835 return of10_data_print(cp
, ep
, len
- OF_ERROR_MSG_LEN
);
1838 printf(" [|openflow]");
1843 of10_header_body_print(const u_char
*cp
, const u_char
*ep
, const uint8_t type
,
1844 const uint16_t len
, const uint32_t xid
) {
1845 const u_char
*cp0
= cp
;
1846 const u_int len0
= len
;
1847 /* Thus far message length is not less than the basic header size, but most
1848 * message types have additional assorted constraints on the length. Wherever
1849 * possible, check that message length meets the constraint, in remaining
1850 * cases check that the length is OK to begin decoding and leave any final
1851 * verification up to a lower-layer function. When the current message is
1852 * corrupt, proceed to the next message. */
1854 /* [OF10] Section 5.1 */
1855 printf("\n\tversion 1.0, type %s, length %u, xid 0x%08x",
1856 tok2str(ofpt_str
, "invalid (0x%02x)", type
), len
, xid
);
1858 /* OpenFlow header only. */
1859 case OFPT_FEATURES_REQUEST
: /* [OF10] Section 5.3.1 */
1860 case OFPT_GET_CONFIG_REQUEST
: /* [OF10] Section 5.3.2 */
1861 case OFPT_BARRIER_REQUEST
: /* [OF10] Section 5.3.7 */
1862 case OFPT_BARRIER_REPLY
: /* ibid */
1863 if (len
!= OF_HEADER_LEN
)
1867 /* OpenFlow header and fixed-size message body. */
1868 case OFPT_SET_CONFIG
: /* [OF10] Section 5.3.2 */
1869 case OFPT_GET_CONFIG_REPLY
: /* ibid */
1870 if (len
!= OF_SWITCH_CONFIG_LEN
)
1876 printf("\n\t flags %s", tok2str(ofp_config_str
, "invalid (0x%04x)", EXTRACT_16BITS(cp
)));
1880 printf(", miss_send_len %u", EXTRACT_16BITS(cp
));
1883 if (len
!= OF_PORT_MOD_LEN
)
1887 return of10_port_mod_print(cp
, ep
);
1888 case OFPT_QUEUE_GET_CONFIG_REQUEST
: /* [OF10] Section 5.3.4 */
1889 if (len
!= OF_QUEUE_GET_CONFIG_REQUEST_LEN
)
1895 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
1900 case OFPT_FLOW_REMOVED
:
1901 if (len
!= OF_FLOW_REMOVED_LEN
)
1905 return of10_flow_removed_print(cp
, ep
);
1906 case OFPT_PORT_STATUS
: /* [OF10] Section 5.4.3 */
1907 if (len
!= OF_PORT_STATUS_LEN
)
1913 printf("\n\t reason %s", tok2str(ofppr_str
, "invalid (0x%02x)", *cp
));
1919 return of10_phy_ports_print(cp
, ep
, OF_PHY_PORT_LEN
);
1921 /* OpenFlow header, fixed-size message body and n * fixed-size data units. */
1922 case OFPT_FEATURES_REPLY
:
1923 if (len
< OF_SWITCH_FEATURES_LEN
)
1927 return of10_features_reply_print(cp
, ep
, len
);
1929 /* OpenFlow header and variable-size data. */
1930 case OFPT_HELLO
: /* [OF10] Section 5.5.1 */
1931 case OFPT_ECHO_REQUEST
: /* [OF10] Section 5.5.2 */
1932 case OFPT_ECHO_REPLY
: /* [OF10] Section 5.5.3 */
1935 return of10_data_print(cp
, ep
, len
- OF_HEADER_LEN
);
1937 /* OpenFlow header, fixed-size message body and variable-size data. */
1939 if (len
< OF_ERROR_MSG_LEN
)
1943 return of10_error_print(cp
, ep
, len
);
1945 /* [OF10] Section 5.5.4 */
1946 if (len
< OF_VENDOR_HEADER_LEN
)
1950 return of10_vendor_data_print(cp
, ep
, len
- OF_HEADER_LEN
);
1951 case OFPT_PACKET_IN
:
1952 /* 2 mock octets count in OF_PACKET_IN_LEN but not in len */
1953 if (len
< OF_PACKET_IN_LEN
- 2)
1957 return of10_packet_in_print(cp
, ep
, len
);
1959 /* a. OpenFlow header. */
1960 /* b. OpenFlow header and one of the fixed-size message bodies. */
1961 /* c. OpenFlow header, fixed-size message body and variable-size data. */
1962 case OFPT_STATS_REQUEST
:
1963 if (len
< OF_STATS_REQUEST_LEN
)
1967 return of10_stats_request_print(cp
, ep
, len
);
1969 /* a. OpenFlow header and fixed-size message body. */
1970 /* b. OpenFlow header and n * fixed-size data units. */
1971 /* c. OpenFlow header and n * variable-size data units. */
1972 /* d. OpenFlow header, fixed-size message body and variable-size data. */
1973 case OFPT_STATS_REPLY
:
1974 if (len
< OF_STATS_REPLY_LEN
)
1978 return of10_stats_reply_print(cp
, ep
, len
);
1980 /* OpenFlow header and n * variable-size data units and variable-size data. */
1981 case OFPT_PACKET_OUT
:
1982 if (len
< OF_PACKET_OUT_LEN
)
1986 return of10_packet_out_print(cp
, ep
, len
);
1988 /* OpenFlow header, fixed-size message body and n * variable-size data units. */
1990 if (len
< OF_FLOW_MOD_LEN
)
1994 return of10_flow_mod_print(cp
, ep
, len
);
1996 /* OpenFlow header, fixed-size message body and n * variable-size data units. */
1997 case OFPT_QUEUE_GET_CONFIG_REPLY
: /* [OF10] Section 5.3.4 */
1998 if (len
< OF_QUEUE_GET_CONFIG_REPLY_LEN
)
2004 printf("\n\t port_no %s", tok2str(ofpp_str
, "%u", EXTRACT_16BITS(cp
)));
2010 return of10_queues_print(cp
, ep
, len
- OF_QUEUE_GET_CONFIG_REPLY_LEN
);
2011 } /* switch (type) */
2014 corrupt
: /* skip the message body */
2015 printf(" (corrupt)");
2017 TCHECK2(*cp0
, len0
- OF_HEADER_LEN
);
2018 return cp0
+ len0
- OF_HEADER_LEN
;
2020 printf(" [|openflow]");