1 # Copyright (C) 2012,2013 Nippon Telegraph and Telephone Corporation.
2 # Copyright (C) 2012 Isaku Yamahata <yamahata at valinux co jp>
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
18 OpenFlow 1.5 definitions.
21 from ryu.lib import type_desc
22 from ryu.ofproto import nicira_ext
23 from ryu.ofproto import ofproto_utils
24 from ryu.ofproto import oxm_fields
25 from ryu.ofproto import oxs_fields
27 from struct import calcsize
31 # Port numbering. Ports are numbered starting from 1.
32 OFPP_MAX = 0xffffff00 # Maximum number of physical and logical
34 OFPP_UNSET = 0xfffffff7 # Output port not set in action-set.
35 # used only in OXM_OF_ACTSET_OUTPUT.
36 OFPP_IN_PORT = 0xfffffff8 # Send the packet out the input port. This
37 # reserved port must be explicitly used in
38 # order to send back out of the input port.
39 OFPP_TABLE = 0xfffffff9 # Submit the packet to the first flow table
40 # NB: This destination port can only be used
41 # in packet-out messages.
42 OFPP_NORMAL = 0xfffffffa # Forward using non-OpenFlow pipeline.
43 OFPP_FLOOD = 0xfffffffb # Flood using non-OpenFlow pipeline.
44 OFPP_ALL = 0xfffffffc # All standard ports except input port.
45 OFPP_CONTROLLER = 0xfffffffd # Send to controller.
46 OFPP_LOCAL = 0xfffffffe # Local openflow "port".
47 OFPP_ANY = 0xffffffff # Special value used in some requests when
48 # no port is specified (i.e. wildcarded).
53 OFPT_HELLO = 0 # Symmetric message
54 OFPT_ERROR = 1 # Symmetric message
55 OFPT_ECHO_REQUEST = 2 # Symmetric message
56 OFPT_ECHO_REPLY = 3 # Symmetric message
57 OFPT_EXPERIMENTER = 4 # Symmetric message
58 # Switch configuration messages.
59 OFPT_FEATURES_REQUEST = 5 # Controller/switch message
60 OFPT_FEATURES_REPLY = 6 # Controller/switch message
61 OFPT_GET_CONFIG_REQUEST = 7 # Controller/switch message
62 OFPT_GET_CONFIG_REPLY = 8 # Controller/switch message
63 OFPT_SET_CONFIG = 9 # Controller/switch message
64 # Asynchronous messages.
65 OFPT_PACKET_IN = 10 # Async message
66 OFPT_FLOW_REMOVED = 11 # Async message
67 OFPT_PORT_STATUS = 12 # Async message
68 # Controller command messages.
69 OFPT_PACKET_OUT = 13 # Controller/switch message
70 OFPT_FLOW_MOD = 14 # Controller/switch message
71 OFPT_GROUP_MOD = 15 # Controller/switch message
72 OFPT_PORT_MOD = 16 # Controller/switch message
73 OFPT_TABLE_MOD = 17 # Controller/switch message
75 OFPT_MULTIPART_REQUEST = 18 # Controller/switch message
76 OFPT_MULTIPART_REPLY = 19 # Controller/switch message
78 OFPT_BARRIER_REQUEST = 20 # Controller/switch message
79 OFPT_BARRIER_REPLY = 21 # Controller/switch message
80 # Controller role change request messages.
81 OFPT_ROLE_REQUEST = 24 # Controller/switch message
82 OFPT_ROLE_REPLY = 25 # Controller/switch message
83 # Asynchronous message configuration.
84 OFPT_GET_ASYNC_REQUEST = 26 # Controller/switch message
85 OFPT_GET_ASYNC_REPLY = 27 # Controller/switch message
86 OFPT_SET_ASYNC = 28 # Controller/switch message
87 # Meters and rate limiters configuration messages.
88 OFPT_METER_MOD = 29 # Controller/switch message
89 # Controller role change event messages.
90 OFPT_ROLE_STATUS = 30 # Async message
91 # Asynchronous messages.
92 OFPT_TABLE_STATUS = 31 # Async message
93 # Request forwarding by the switch.
94 OFPT_REQUESTFORWARD = 32 # Async message
95 # Bundle operations (multiple messages as a single operation).
96 OFPT_BUNDLE_CONTROL = 33 # Controller/switch message
97 OFPT_BUNDLE_ADD_MESSAGE = 34 # Controller/switch message
98 # Controller Status async message.
99 OFPT_CONTROLLER_STATUS = 35 # Async message
101 _OFP_HEADER_PACK_STR = 'BBHI'
102 OFP_HEADER_PACK_STR = '!' + _OFP_HEADER_PACK_STR
107 OFP_HELLO_HEADER_SIZE = 8
109 # struct ofp_hello_elem_header
110 OFP_HELLO_ELEM_HEADER_PACK_STR = '!HH'
111 OFP_HELLO_ELEM_HEADER_SIZE = 4
112 assert (calcsize(OFP_HELLO_ELEM_HEADER_PACK_STR) == OFP_HELLO_ELEM_HEADER_SIZE)
114 # enum ofp_hello_elem_type
116 OFPHET_VERSIONBITMAP = 1
118 # struct ofp_hello_elem_versionbitmap
119 OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_PACK_STR = '!HH'
120 OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_SIZE = 4
121 assert (calcsize(OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_PACK_STR) ==
122 OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_SIZE)
125 OFP_DEFAULT_MISS_SEND_LEN = 128
127 # enum ofp_config_flags
128 # Handling of IP fragments.
129 OFPC_FRAG_NORMAL = 0 # No special handling for fragments.
130 OFPC_FRAG_DROP = 1 << 0 # Drop fragments.
131 OFPC_FRAG_REASM = 1 << 1 # Reassemble (only if OFPC_IP_REASM set).
134 # struct ofp_switch_config
135 OFP_SWITCH_CONFIG_PACK_STR = '!HH'
136 OFP_SWITCH_CONFIG_SIZE = 12
137 assert (calcsize(OFP_SWITCH_CONFIG_PACK_STR) + OFP_HEADER_SIZE ==
138 OFP_SWITCH_CONFIG_SIZE)
142 OFPTT_MAX = 0xfe # Last usable table number.
143 OFPTT_ALL = 0xff # Wildcard table used for table config, flow stats
147 # enum ofp_table_config
148 OFPTC_DEPRECATED_MASK = 3 # Deprecated bits
149 OFPTC_EVICTION = 1 << 2 # Authorise table to evict flows.
150 OFPTC_VACANCY_EVENTS = 1 << 3 # Enable vacancy events.
152 # enum ofp_table_mod_prop_type
153 OFPTMPT_EVICTION = 0x2 # Eviction property.
154 OFPTMPT_VACANCY = 0x3 # Vacancy property.
155 OFPTMPT_EXPERIMENTER = 0xFFFF # Experimenter property.
157 # enum ofp_table_mod_prop_eviction_flag
158 OFPTMPEF_OTHER = 1 << 0 # Using other factors.
159 OFPTMPEF_IMPORTANCE = 1 << 1 # Using flow entry importance.
160 OFPTMPEF_LIFETIME = 1 << 2 # Using flow entry lifetime.
162 # struct ofp_table_mod_prop_eviction
163 OFP_TABLE_MOD_PROP_EVICTION_PACK_STR = '!HHI'
164 OFP_TABLE_MOD_PROP_EVICTION_SIZE = 8
165 assert(calcsize(OFP_TABLE_MOD_PROP_EVICTION_PACK_STR) ==
166 OFP_TABLE_MOD_PROP_EVICTION_SIZE)
168 # struct ofp_table_mod_prop_vacancy
169 OFP_TABLE_MOD_PROP_VACANCY_PACK_STR = '!HHBBBx'
170 OFP_TABLE_MOD_PROP_VACANCY_SIZE = 8
171 assert(calcsize(OFP_TABLE_MOD_PROP_VACANCY_PACK_STR) ==
172 OFP_TABLE_MOD_PROP_VACANCY_SIZE)
174 # struct ofp_table_mod_prop_experimenter
175 OFP_TABLE_MOD_PROP_EXPERIMENTER_PACK_STR = '!HHII'
176 OFP_TABLE_MOD_PROP_EXPERIMENTER_SIZE = 12
177 assert(calcsize(OFP_TABLE_MOD_PROP_EXPERIMENTER_PACK_STR) ==
178 OFP_TABLE_MOD_PROP_EXPERIMENTER_SIZE)
180 # struct ofp_table_mod
181 OFP_TABLE_MOD_PACK_STR = '!B3xI'
182 OFP_TABLE_MOD_SIZE = 16
183 assert (calcsize(OFP_TABLE_MOD_PACK_STR) + OFP_HEADER_SIZE ==
186 # enum ofp_capabilities
187 OFPC_FLOW_STATS = 1 << 0 # Flow statistics.
188 OFPC_TABLE_STATS = 1 << 1 # Table statistics.
189 OFPC_PORT_STATS = 1 << 2 # Port statistics.
190 OFPC_GROUP_STATS = 1 << 3 # Group statistics.
191 OFPC_IP_REASM = 1 << 5 # Can reassemble IP fragments.
192 OFPC_QUEUE_STATS = 1 << 6 # Queue statistics.
193 OFPC_PORT_BLOCKED = 1 << 8 # Switch will block looping ports.
194 OFPC_BUNDLES = 1 << 9 # Switch supports bundles.
195 OFPC_FLOW_MONITORING = 1 << 10 # Switch supports flow monitoring.
197 # enum ofp_port_config
198 OFPPC_PORT_DOWN = 1 << 0 # Port is administratively down.
199 OFPPC_NO_RECV = 1 << 2 # Drop all packets recieved by port.
200 OFPPC_NO_FWD = 1 << 5 # Drop packets forwarded to port.
201 OFPPC_NO_PACKET_IN = 1 << 6 # Do not send packet-in msgs for port.
203 # enum ofp_port_state
204 OFPPS_LINK_DOWN = 1 << 0 # No physical link present.
205 OFPPS_BLOCKED = 1 << 1 # Port is blocked
206 OFPPS_LIVE = 1 << 2 # Live for Fast Failover Group.
208 # enum ofp_port_features
209 OFPPF_10MB_HD = 1 << 0 # 10 Mb half-duplex rate support.
210 OFPPF_10MB_FD = 1 << 1 # 10 Mb full-duplex rate support.
211 OFPPF_100MB_HD = 1 << 2 # 100 Mb half-duplex rate support.
212 OFPPF_100MB_FD = 1 << 3 # 100 Mb full-duplex rate support.
213 OFPPF_1GB_HD = 1 << 4 # 1 Gb half-duplex rate support.
214 OFPPF_1GB_FD = 1 << 5 # 1 Gb full-duplex rate support.
215 OFPPF_10GB_FD = 1 << 6 # 10 Gb full-duplex rate support.
216 OFPPF_40GB_FD = 1 << 7 # 40 Gb full-duplex rate support.
217 OFPPF_100GB_FD = 1 << 8 # 100 Gb full-duplex rate support.
218 OFPPF_1TB_FD = 1 << 9 # 1 Tb full-duplex rate support.
219 OFPPF_OTHER = 1 << 10 # Other rate, not in the list.
220 OFPPF_COPPER = 1 << 11 # Copper medium.
221 OFPPF_FIBER = 1 << 12 # Fiber medium.
222 OFPPF_AUTONEG = 1 << 13 # Auto-negotiation.
223 OFPPF_PAUSE = 1 << 14 # Pause.
224 OFPPF_PAUSE_ASYM = 1 << 15 # Asymmetric pause.
226 # enum ofp_port_desc_prop_type
227 OFPPDPT_ETHERNET = 0 # Ethernet property.
228 OFPPDPT_OPTICAL = 1 # Optical property.
229 OFPPDPT_PIPELINE_INPUT = 2 # Ingress pipeline fields.
230 OFPPDPT_PIPELINE_OUTPUT = 3 # Egress pipeline fields.
231 OFPPDPT_RECIRCULATE = 4 # Recirculation property.
232 OFPPDPT_EXPERIMENTER = 0xFFFF # Experimenter property.
234 # struct ofp_port_desc_prop_ethernet
235 OFP_PORT_DESC_PROP_ETHERNET_PACK_STR = '!HH4xIIIIII'
236 OFP_PORT_DESC_PROP_ETHERNET_SIZE = 32
237 assert (calcsize(OFP_PORT_DESC_PROP_ETHERNET_PACK_STR) ==
238 OFP_PORT_DESC_PROP_ETHERNET_SIZE)
240 # enum ofp_optical_port_features
241 OFPOPF_RX_TUNE = 1 << 0 # Receiver is tunable
242 OFPOPF_TX_TUNE = 1 << 1 # Transmit is tunable
243 OFPOPF_TX_PWR = 1 << 2 # Power is configurable
244 OFPOPF_USE_FREQ = 1 << 3 # Use Frequency, not wavelength
246 # struct ofp_port_desc_prop_optical
247 OFP_PORT_DESC_PROP_OPTICAL_PACK_STR = '!HH4xIIIIIIIHH'
248 OFP_PORT_DESC_PROP_OPTICAL_SIZE = 40
249 assert (calcsize(OFP_PORT_DESC_PROP_OPTICAL_PACK_STR) ==
250 OFP_PORT_DESC_PROP_OPTICAL_SIZE)
252 # struct ofp_port_desc_prop_oxm
253 OFP_PORT_DESC_PROP_OXM_PACK_STR = '!HH'
254 OFP_PORT_DESC_PROP_OXM_SIZE = 4
255 assert (calcsize(OFP_PORT_DESC_PROP_OXM_PACK_STR) ==
256 OFP_PORT_DESC_PROP_OXM_SIZE)
258 # struct ofp_port_desc_prop_recirculate
259 OFP_PORT_DESC_PROP_RECIRCULATE_PACK_STR = '!HH'
260 OFP_PORT_DESC_PROP_RECIRCULATE_SIZE = 4
261 assert (calcsize(OFP_PORT_DESC_PROP_RECIRCULATE_PACK_STR) ==
262 OFP_PORT_DESC_PROP_RECIRCULATE_SIZE)
264 # struct ofp_port_desc_prop_experimenter
265 OFP_PORT_DESC_PROP_EXPERIMENTER_PACK_STR = '!HHII'
266 OFP_PORT_DESC_PROP_EXPERIMENTER_SIZE = 12
267 assert (calcsize(OFP_PORT_DESC_PROP_EXPERIMENTER_PACK_STR) ==
268 OFP_PORT_DESC_PROP_EXPERIMENTER_SIZE)
271 OFP_MAX_PORT_NAME_LEN = 16
273 OFP_ETH_ALEN_STR = str(OFP_ETH_ALEN)
274 _OFP_PORT_PACK_STR = 'IH2x' + OFP_ETH_ALEN_STR + 's' + '2x' + \
275 str(OFP_MAX_PORT_NAME_LEN) + 's' + 'II'
276 OFP_PORT_PACK_STR = '!' + _OFP_PORT_PACK_STR
278 assert (calcsize(OFP_PORT_PACK_STR) == OFP_PORT_SIZE)
280 # struct ofp_switch_features
281 OFP_SWITCH_FEATURES_PACK_STR = '!QIBB2xII'
282 OFP_SWITCH_FEATURES_SIZE = 32
283 assert (calcsize(OFP_SWITCH_FEATURES_PACK_STR) + OFP_HEADER_SIZE ==
284 OFP_SWITCH_FEATURES_SIZE)
286 # enum ofp_port_reason
287 OFPPR_ADD = 0 # The port was added.
288 OFPPR_DELETE = 1 # The port was removed.
289 OFPPR_MODIFY = 2 # Some attribute of the port has changed.
291 # struct ofp_port_status
292 OFP_PORT_STATUS_PACK_STR = '!B7x' + _OFP_PORT_PACK_STR
293 OFP_PORT_STATUS_SIZE = 56
294 assert (calcsize(OFP_PORT_STATUS_PACK_STR) + OFP_HEADER_SIZE ==
295 OFP_PORT_STATUS_SIZE)
297 # enum ofp_port_mod_prop_type
298 OFPPMPT_ETHERNET = 0 # Ethernet property.
299 OFPPMPT_OPTICAL = 1 # Optical property.
300 OFPPMPT_EXPERIMENTER = 0xFFFF # Experimenter property.
302 # struct ofp_port_mod_prop_ethernet
303 OFP_PORT_MOD_PROP_ETHERNET_PACK_STR = '!HHI'
304 OFP_PORT_MOD_PROP_ETHERNET_SIZE = 8
305 assert (calcsize(OFP_PORT_MOD_PROP_ETHERNET_PACK_STR) ==
306 OFP_PORT_MOD_PROP_ETHERNET_SIZE)
308 # struct ofp_port_mod_prop_optical
309 OFP_PORT_MOD_PROP_OPTICAL_PACK_STR = '!HHIIIII'
310 OFP_PORT_MOD_PROP_OPTICAL_SIZE = 24
311 assert (calcsize(OFP_PORT_MOD_PROP_OPTICAL_PACK_STR) ==
312 OFP_PORT_MOD_PROP_OPTICAL_SIZE)
314 # struct ofp_port_mod_prop_experimenter
315 OFP_PORT_MOD_PROP_EXPERIMENTER_PACK_STR = '!HHII'
316 OFP_PORT_MOD_PROP_EXPERIMENTER_SIZE = 12
317 assert (calcsize(OFP_PORT_MOD_PROP_EXPERIMENTER_PACK_STR) ==
318 OFP_PORT_MOD_PROP_EXPERIMENTER_SIZE)
320 # struct ofp_port_mod
321 OFP_PORT_MOD_PACK_STR = '!I4x' + OFP_ETH_ALEN_STR + 's2xII'
322 OFP_PORT_MOD_SIZE = 32
323 assert (calcsize(OFP_PORT_MOD_PACK_STR) + OFP_HEADER_SIZE ==
326 # enum ofp_header_type_namespaces
327 OFPHTN_ONF = 0 # ONF namespace.
328 OFPHTN_ETHERTYPE = 1 # ns_type is an Ethertype.
329 OFPHTN_IP_PROTO = 2 # ns_type is a IP protocol number.
330 OFPHTN_UDP_TCP_PORT = 3 # ns_type is a TCP or UDP port.
331 OFPHTN_IPV4_OPTION = 4 # ns_type is an IPv4 option number.
333 # enum ofp_header_type_onf
334 OFPHTO_ETHERNET = 0 # Ethernet (DIX or IEEE 802.3) - default.
335 OFPHTO_NO_HEADER = 1 # No header, ex. circuit switch.
336 OFPHTO_OXM_EXPERIMENTER = 0xFFFF # Use Experimenter OXM.
338 # struct ofp_header_type
339 OFP_HEADER_TYPE_PACK_STR = '!HH'
340 OFP_HEADER_TYPE_SIZE = 4
341 assert (calcsize(OFP_HEADER_TYPE_PACK_STR) ==
342 OFP_HEADER_TYPE_SIZE)
344 # enum ofp_match_type
345 OFPMT_STANDARD = 0 # Deprecated
346 OFPMT_OXM = 1 # OpenFlow Extensible Match
349 _OFP_MATCH_PACK_STR = 'HH4x'
350 OFP_MATCH_PACK_STR = '!' + _OFP_MATCH_PACK_STR
352 assert calcsize(OFP_MATCH_PACK_STR) == OFP_MATCH_SIZE
355 OFPXMC_NXM_0 = 0x0000 # Backward compatibility with NXM
356 OFPXMC_NXM_1 = 0x0001 # Backward compatibility with NXM
357 OFPXMC_OPENFLOW_BASIC = 0x8000 # Basic class for OpenFlow
358 OFPXMC_PACKET_REGS = 0x8001 # Packet registers (pipeline fields).
359 OFPXMC_EXPERIMENTER = 0xFFFF # Experimenter class
362 OFPVID_PRESENT = 0x1000 # bit that indicate that a VLAN id is set.
363 OFPVID_NONE = 0X0000 # No VLAN id was set.
366 def _oxm_tlv_header(class_, field, hasmask, length):
367 return (class_ << 16) | (field << 9) | (hasmask << 8) | length
370 def oxm_tlv_header(field, length):
371 return _oxm_tlv_header(OFPXMC_OPENFLOW_BASIC, field, 0, length)
374 def oxm_tlv_header_w(field, length):
375 return _oxm_tlv_header(OFPXMC_OPENFLOW_BASIC, field, 1, length * 2)
378 def oxm_tlv_header_extract_hasmask(header):
379 return (header >> 8) & 1
382 def oxm_tlv_header_extract_length(header):
383 if oxm_tlv_header_extract_hasmask(header):
384 length = (header & 0xff) // 2
386 length = header & 0xff
391 oxm_fields.OpenFlowBasic('in_port', 0, type_desc.Int4),
392 oxm_fields.OpenFlowBasic('in_phy_port', 1, type_desc.Int4),
393 oxm_fields.OpenFlowBasic('metadata', 2, type_desc.Int8),
394 oxm_fields.OpenFlowBasic('eth_dst', 3, type_desc.MacAddr),
395 oxm_fields.OpenFlowBasic('eth_src', 4, type_desc.MacAddr),
396 oxm_fields.OpenFlowBasic('eth_type', 5, type_desc.Int2),
397 oxm_fields.OpenFlowBasic('vlan_vid', 6, type_desc.Int2),
398 oxm_fields.OpenFlowBasic('vlan_pcp', 7, type_desc.Int1),
399 oxm_fields.OpenFlowBasic('ip_dscp', 8, type_desc.Int1),
400 oxm_fields.OpenFlowBasic('ip_ecn', 9, type_desc.Int1),
401 oxm_fields.OpenFlowBasic('ip_proto', 10, type_desc.Int1),
402 oxm_fields.OpenFlowBasic('ipv4_src', 11, type_desc.IPv4Addr),
403 oxm_fields.OpenFlowBasic('ipv4_dst', 12, type_desc.IPv4Addr),
404 oxm_fields.OpenFlowBasic('tcp_src', 13, type_desc.Int2),
405 oxm_fields.OpenFlowBasic('tcp_dst', 14, type_desc.Int2),
406 oxm_fields.OpenFlowBasic('udp_src', 15, type_desc.Int2),
407 oxm_fields.OpenFlowBasic('udp_dst', 16, type_desc.Int2),
408 oxm_fields.OpenFlowBasic('sctp_src', 17, type_desc.Int2),
409 oxm_fields.OpenFlowBasic('sctp_dst', 18, type_desc.Int2),
410 oxm_fields.OpenFlowBasic('icmpv4_type', 19, type_desc.Int1),
411 oxm_fields.OpenFlowBasic('icmpv4_code', 20, type_desc.Int1),
412 oxm_fields.OpenFlowBasic('arp_op', 21, type_desc.Int2),
413 oxm_fields.OpenFlowBasic('arp_spa', 22, type_desc.IPv4Addr),
414 oxm_fields.OpenFlowBasic('arp_tpa', 23, type_desc.IPv4Addr),
415 oxm_fields.OpenFlowBasic('arp_sha', 24, type_desc.MacAddr),
416 oxm_fields.OpenFlowBasic('arp_tha', 25, type_desc.MacAddr),
417 oxm_fields.OpenFlowBasic('ipv6_src', 26, type_desc.IPv6Addr),
418 oxm_fields.OpenFlowBasic('ipv6_dst', 27, type_desc.IPv6Addr),
419 oxm_fields.OpenFlowBasic('ipv6_flabel', 28, type_desc.Int4),
420 oxm_fields.OpenFlowBasic('icmpv6_type', 29, type_desc.Int1),
421 oxm_fields.OpenFlowBasic('icmpv6_code', 30, type_desc.Int1),
422 oxm_fields.OpenFlowBasic('ipv6_nd_target', 31, type_desc.IPv6Addr),
423 oxm_fields.OpenFlowBasic('ipv6_nd_sll', 32, type_desc.MacAddr),
424 oxm_fields.OpenFlowBasic('ipv6_nd_tll', 33, type_desc.MacAddr),
425 oxm_fields.OpenFlowBasic('mpls_label', 34, type_desc.Int4),
426 oxm_fields.OpenFlowBasic('mpls_tc', 35, type_desc.Int1),
427 oxm_fields.OpenFlowBasic('mpls_bos', 36, type_desc.Int1),
428 oxm_fields.OpenFlowBasic('pbb_isid', 37, type_desc.Int3),
429 oxm_fields.OpenFlowBasic('tunnel_id', 38, type_desc.Int8),
430 oxm_fields.OpenFlowBasic('ipv6_exthdr', 39, type_desc.Int2),
431 oxm_fields.OpenFlowBasic('pbb_uca', 41, type_desc.Int1),
432 oxm_fields.OpenFlowBasic('tcp_flags', 42, type_desc.Int2),
433 oxm_fields.OpenFlowBasic('actset_output', 43, type_desc.Int4),
434 oxm_fields.OpenFlowBasic('packet_type', 44, type_desc.Int4),
435 ] + nicira_ext.oxm_types
437 oxm_fields.generate(__name__)
440 _OFP_STATS_PACK_STR = 'HH4x'
441 OFP_STATS_PACK_STR = '!' + _OFP_STATS_PACK_STR
443 assert calcsize(OFP_STATS_PACK_STR) == OFP_STATS_SIZE
446 OFPXSC_OPENFLOW_BASIC = 0x8002 # Basic stats class for OpenFlow
447 OFPXSC_EXPERIMENTER = 0xFFFF # Experimenter class
450 def _oxs_tlv_header(class_, field, reserved, length):
451 return (class_ << 16) | (field << 9) | (reserved << 8) | length
454 def oxs_tlv_header(field, length):
455 return _oxs_tlv_header(OFPXSC_OPENFLOW_BASIC, field, 0, length)
458 def oxs_tlv_header_extract_length(header):
463 oxs_fields.OpenFlowBasic('duration', 0, type_desc.Int4Double),
464 oxs_fields.OpenFlowBasic('idle_time', 1, type_desc.Int4Double),
465 oxs_fields.OpenFlowBasic('flow_count', 3, type_desc.Int4),
466 oxs_fields.OpenFlowBasic('packet_count', 4, type_desc.Int8),
467 oxs_fields.OpenFlowBasic('byte_count', 5, type_desc.Int8),
470 oxs_fields.generate(__name__)
472 # enum ofp_action_type
473 OFPAT_OUTPUT = 0 # Output to switch port.
474 OFPAT_COPY_TTL_OUT = 11 # Copy TTL "outwards" -- from
475 # next-to-outermost to outermost
476 OFPAT_COPY_TTL_IN = 12 # Copy TTL "inwards" -- from outermost to
478 OFPAT_SET_MPLS_TTL = 15 # MPLS TTL.
479 OFPAT_DEC_MPLS_TTL = 16 # Decrement MPLS TTL
480 OFPAT_PUSH_VLAN = 17 # Push a new VLAN tag
481 OFPAT_POP_VLAN = 18 # Pop the outer VLAN tag
482 OFPAT_PUSH_MPLS = 19 # Push a new MPLS tag
483 OFPAT_POP_MPLS = 20 # Pop the outer MPLS tag
484 OFPAT_SET_QUEUE = 21 # Set queue id when outputting to a port
485 OFPAT_GROUP = 22 # Apply group
486 OFPAT_SET_NW_TTL = 23 # IP TTL.
487 OFPAT_DEC_NW_TTL = 24 # Decrement IP TTL.
488 OFPAT_SET_FIELD = 25 # Set a header field using OXM TLV format.
489 OFPAT_PUSH_PBB = 26 # Push a new PBB service tag (I-TAG)
490 OFPAT_POP_PBB = 27 # Pop the outer PBB service tag (I-TAG)
491 OFPAT_COPY_FIELD = 28 # Copy value between header and register.
492 OFPAT_METER = 29 # Apply meter (rate limiter)
493 OFPAT_EXPERIMENTER = 0xffff
496 # struct ofp_action_header
497 OFP_ACTION_HEADER_PACK_STR = '!HH4x'
498 OFP_ACTION_HEADER_SIZE = 8
499 assert calcsize(OFP_ACTION_HEADER_PACK_STR) == OFP_ACTION_HEADER_SIZE
501 # enum ofp_controller_max_len
502 OFPCML_MAX = 0xffe5 # maximum max_len value which can be used to
503 # request a specific byte length.
504 OFPCML_NO_BUFFER = 0xffff # indicates that no buffering should be
505 # applied and the whole packet is to be
506 # sent to the controller.
508 # struct ofp_action_output
509 OFP_ACTION_OUTPUT_PACK_STR = '!HHIH6x'
510 OFP_ACTION_OUTPUT_SIZE = 16
511 assert calcsize(OFP_ACTION_OUTPUT_PACK_STR) == OFP_ACTION_OUTPUT_SIZE
513 # struct ofp_action_generic
514 OFP_ACTION_GENERIC_PACK_STR = '!HH4x'
515 OFP_ACTION_GENERIC_SIZE = 8
516 assert (calcsize(OFP_ACTION_GENERIC_PACK_STR) == OFP_ACTION_GENERIC_SIZE)
518 # struct ofp_action_mpls_ttl
519 OFP_ACTION_MPLS_TTL_PACK_STR = '!HHB3x'
520 OFP_ACTION_MPLS_TTL_SIZE = 8
521 assert calcsize(OFP_ACTION_MPLS_TTL_PACK_STR) == OFP_ACTION_MPLS_TTL_SIZE
523 # struct ofp_action_push
524 OFP_ACTION_PUSH_PACK_STR = '!HHH2x'
525 OFP_ACTION_PUSH_SIZE = 8
526 assert calcsize(OFP_ACTION_PUSH_PACK_STR) == OFP_ACTION_PUSH_SIZE
528 # struct ofp_action_pop_mpls
529 OFP_ACTION_POP_MPLS_PACK_STR = '!HHH2x'
530 OFP_ACTION_POP_MPLS_SIZE = 8
531 assert calcsize(OFP_ACTION_POP_MPLS_PACK_STR) == OFP_ACTION_POP_MPLS_SIZE
533 # struct ofp_action_set_queue
534 OFP_ACTION_SET_QUEUE_PACK_STR = '!HHI'
535 OFP_ACTION_SET_QUEUE_SIZE = 8
536 assert calcsize(OFP_ACTION_SET_QUEUE_PACK_STR) == OFP_ACTION_SET_QUEUE_SIZE
538 # struct ofp_action_group
539 OFP_ACTION_GROUP_PACK_STR = '!HHI'
540 OFP_ACTION_GROUP_SIZE = 8
541 assert calcsize(OFP_ACTION_GROUP_PACK_STR) == OFP_ACTION_GROUP_SIZE
543 # struct ofp_action_nw_ttl
544 OFP_ACTION_NW_TTL_PACK_STR = '!HHB3x'
545 OFP_ACTION_NW_TTL_SIZE = 8
546 assert calcsize(OFP_ACTION_NW_TTL_PACK_STR) == OFP_ACTION_NW_TTL_SIZE
548 # struct ofp_action_set_field
549 OFP_ACTION_SET_FIELD_PACK_STR = '!HH4x'
550 OFP_ACTION_SET_FIELD_SIZE = 8
551 assert calcsize(OFP_ACTION_SET_FIELD_PACK_STR) == OFP_ACTION_SET_FIELD_SIZE
553 # struct ofp_action_copy_field
554 OFP_ACTION_COPY_FIELD_PACK_STR = '!HHHHH2x'
555 OFP_ACTION_COPY_FIELD_SIZE = 12
556 assert calcsize(OFP_ACTION_COPY_FIELD_PACK_STR) == OFP_ACTION_COPY_FIELD_SIZE
558 # struct ofp_action_meter
559 OFP_ACTION_METER_PACK_STR = '!HHI'
560 OFP_ACTION_METER_SIZE = 8
561 assert calcsize(OFP_ACTION_METER_PACK_STR) == OFP_ACTION_METER_SIZE
563 # struct ofp_action_experimenter_header
564 OFP_ACTION_EXPERIMENTER_HEADER_PACK_STR = '!HHI'
565 OFP_ACTION_EXPERIMENTER_HEADER_SIZE = 8
566 assert (calcsize(OFP_ACTION_EXPERIMENTER_HEADER_PACK_STR) ==
567 OFP_ACTION_EXPERIMENTER_HEADER_SIZE)
569 # enum ofp_instruction_type
570 OFPIT_GOTO_TABLE = 1 # Setup the next table in the lookup pipeline.
571 OFPIT_WRITE_METADATA = 2 # Setup the metadata field for use later in
573 OFPIT_WRITE_ACTIONS = 3 # Write the action(s) onto the datapath
575 OFPIT_APPLY_ACTIONS = 4 # Applies the action(s) immediately
576 OFPIT_CLEAR_ACTIONS = 5 # Clears all actions from the datapath action
578 OFPIT_DEPRECATED = 6 # Deprecated (was apply meter)
579 OFPIT_STAT_TRIGGER = 7 # Statistics triggers
580 OFPIT_EXPERIMENTER = 0xFFFF # Experimenter instruction
582 # struct ofp_instruction_goto_table
583 OFP_INSTRUCTION_GOTO_TABLE_PACK_STR = '!HHB3x'
584 OFP_INSTRUCTION_GOTO_TABLE_SIZE = 8
585 assert (calcsize(OFP_INSTRUCTION_GOTO_TABLE_PACK_STR) ==
586 OFP_INSTRUCTION_GOTO_TABLE_SIZE)
588 # struct ofp_instruction_write_metadata
589 OFP_INSTRUCTION_WRITE_METADATA_PACK_STR = '!HH4xQQ'
590 OFP_INSTRUCTION_WRITE_METADATA_SIZE = 24
591 assert (calcsize(OFP_INSTRUCTION_WRITE_METADATA_PACK_STR) ==
592 OFP_INSTRUCTION_WRITE_METADATA_SIZE)
594 # struct ofp_instruction_actions
595 OFP_INSTRUCTION_ACTIONS_PACK_STR = '!HH4x'
596 OFP_INSTRUCTION_ACTIONS_SIZE = 8
597 assert (calcsize(OFP_INSTRUCTION_ACTIONS_PACK_STR) ==
598 OFP_INSTRUCTION_ACTIONS_SIZE)
600 # enum ofp_stat_trigger_flags
601 OFPSTF_PERIODIC = 1 << 0 # Trigger for all multiples of thresholds.
602 OFPSTF_ONLY_FIRST = 1 << 1 # Trigger on only first reach threshold.
604 # struct ofp_instruction_stat_trigger
605 _OFP_INSTRUCTION_STAT_TRIGGER_PACK_STR0 = 'HHI'
606 OFP_INSTRUCTION_STAT_TRIGGER_PACK_STR = (
607 '!' + _OFP_INSTRUCTION_STAT_TRIGGER_PACK_STR0 + _OFP_STATS_PACK_STR)
608 OFP_INSTRUCTION_STAT_TRIGGER_PACK_STR0 = (
609 '!' + _OFP_INSTRUCTION_STAT_TRIGGER_PACK_STR0)
610 OFP_INSTRUCTION_STAT_TRIGGER_PACK_SIZE = 16
611 assert (calcsize(OFP_INSTRUCTION_STAT_TRIGGER_PACK_STR) ==
612 OFP_INSTRUCTION_STAT_TRIGGER_PACK_SIZE)
614 # struct ofp_instruction_experimenter_header
615 OFP_INSTRUCTION_EXPERIMENTER_HEADER_PACK_STR = '!HHI'
616 OFP_INSTRUCTION_EXPERIMENTER_HEADER_SIZE = 8
617 assert (calcsize(OFP_INSTRUCTION_EXPERIMENTER_HEADER_PACK_STR) ==
618 OFP_INSTRUCTION_EXPERIMENTER_HEADER_SIZE)
620 # enum ofp_flow_mod_command
621 OFPFC_ADD = 0 # New flow.
622 OFPFC_MODIFY = 1 # Modify all matching flows.
623 OFPFC_MODIFY_STRICT = 2 # Modify entry strictly matching wildcards
624 OFPFC_DELETE = 3 # Delete all matching flows.
625 OFPFC_DELETE_STRICT = 4 # Strictly match wildcards and priority.
627 # Value used in "idle_timeout" and "hard_timeout" to indicate that the
628 # entry is permanent. */
629 OFP_FLOW_PERMANENT = 0
631 # By default, choose a priority in the middle.
632 OFP_DEFAULT_PRIORITY = 0x8000
634 # enum ofp_flow_mod_flags
635 OFPFF_SEND_FLOW_REM = 1 << 0 # Send flow removed message when flow
636 # expires or is deleted.
637 OFPFF_CHECK_OVERLAP = 1 << 1 # Check for overlapping entries first.
638 OFPFF_RESET_COUNTS = 1 << 2 # Reset flow packet and byte counts.
639 OFPFF_NO_PKT_COUNTS = 1 << 3 # Don't keep track of packet count.
640 OFPFF_NO_BYT_COUNTS = 1 << 4 # Don't keep track of byte count.
642 # struct ofp_flow_mod
643 _OFP_FLOW_MOD_PACK_STR0 = 'QQBBHHHIIIHH'
644 OFP_FLOW_MOD_PACK_STR = '!' + _OFP_FLOW_MOD_PACK_STR0 + _OFP_MATCH_PACK_STR
645 OFP_FLOW_MOD_PACK_STR0 = '!' + _OFP_FLOW_MOD_PACK_STR0
646 OFP_FLOW_MOD_SIZE = 56
647 assert (calcsize(OFP_FLOW_MOD_PACK_STR) + OFP_HEADER_SIZE ==
651 OFPG_MAX = 0xffffff00 # Last usable group number.
652 OFPG_ALL = 0xfffffffc # Represents all groups for group delete commands.
653 OFPG_ANY = 0xffffffff # Special wildcard: no group specified.
655 # enum ofp_group_mod_command
656 OFPGC_ADD = 0 # New group.
657 OFPGC_MODIFY = 1 # Modify all matching groups.
658 OFPGC_DELETE = 2 # Delete all matching groups.
659 OFPGC_INSERT_BUCKET = 3 # Insert action buckets to the already available
660 # list of action buckets in a matching group
661 # OFPGC_??? = 4 # Reserved for future use.
662 OFPGC_REMOVE_BUCKET = 5 # Remove all action buckets or any specific action
663 # bucket from matching group
665 # enum ofp_group_bucket_prop_type
666 OFPGBPT_WEIGHT = 0 # Select groups only.
667 OFPGBPT_WATCH_PORT = 1 # Fast failover groups only.
668 OFPGBPT_WATCH_GROUP = 2 # Fast failover groups only.
669 OFPGBPT_EXPERIMENTER = 0xFFFF # Experimenter defined.
671 # struct ofp_group_bucket_prop_header
672 OFP_GROUP_BUCKET_PROP_HEADER_PACK_STR = '!HH'
673 OFP_GROUP_BUCKET_PROP_HEADER_SIZE = 4
674 assert (calcsize(OFP_GROUP_BUCKET_PROP_HEADER_PACK_STR) ==
675 OFP_GROUP_BUCKET_PROP_HEADER_SIZE)
677 # struct ofp_group_bucket_prop_weight
678 OFP_GROUP_BUCKET_PROP_WEIGHT_PACK_STR = '!HHH2x'
679 OFP_GROUP_BUCKET_PROP_WEIGHT_SIZE = 8
680 assert (calcsize(OFP_GROUP_BUCKET_PROP_WEIGHT_PACK_STR) ==
681 OFP_GROUP_BUCKET_PROP_WEIGHT_SIZE)
683 # struct ofp_group_bucket_prop_watch
684 OFP_GROUP_BUCKET_PROP_WATCH_PACK_STR = '!HHI'
685 OFP_GROUP_BUCKET_PROP_WATCH_SIZE = 8
686 assert (calcsize(OFP_GROUP_BUCKET_PROP_WATCH_PACK_STR) ==
687 OFP_GROUP_BUCKET_PROP_WATCH_SIZE)
689 # struct ofp_group_bucket_prop_experimenter
690 OFP_GROUP_BUCKET_PROP_EXPERIMENTER_PACK_STR = '!HHII'
691 OFP_GROUP_BUCKET_PROP_EXPERIMENTER_SIZE = 12
692 assert (calcsize(OFP_GROUP_BUCKET_PROP_EXPERIMENTER_PACK_STR) ==
693 OFP_GROUP_BUCKET_PROP_EXPERIMENTER_SIZE)
696 OFP_BUCKET_PACK_STR = '!HHI'
698 assert calcsize(OFP_BUCKET_PACK_STR) == OFP_BUCKET_SIZE
700 # enum ofp_group_bucket
701 OFPG_BUCKET_MAX = 0xffffff00 # Last usable bucket ID.
702 OFPG_BUCKET_FIRST = 0xfffffffd # First bucket ID in the list of action
703 # buckets of a group. This is applicable
704 # for OFPGC_INSERT_BUCKET and
705 # OFPGC_REMOVE_BUCKET commands.
706 OFPG_BUCKET_LAST = 0xfffffffe # Last bucket ID in the list of action
707 # buckets of a group. This is applicable
708 # for OFPGC_INSERT_BUCKET and
709 # OFPGC_REMOVE_BUCKET commands.
710 OFPG_BUCKET_ALL = 0xffffffff # All action buckets in a group,
711 # This is applicable for
712 # only OFPGC_REMOVE_BUCKET command.
714 # enum ofp_group_prop_type
715 OFPGPT_EXPERIMENTER = 0xFFFF # Experimenter defined.
717 # struct ofp_group_prop_header
718 OFP_GROUP_PROP_HEADER_PACK_STR = '!HH'
719 OFP_GROUP_PROP_HEADER_SIZE = 4
720 assert (calcsize(OFP_GROUP_PROP_HEADER_PACK_STR) ==
721 OFP_GROUP_PROP_HEADER_SIZE)
723 # struct ofp_group_prop_experimenter
724 OFP_GROUP_PROP_EXPERIMENTER_PACK_STR = '!HHII'
725 OFP_GROUP_PROP_EXPERIMENTER_SIZE = 12
726 assert (calcsize(OFP_GROUP_PROP_EXPERIMENTER_PACK_STR) ==
727 OFP_GROUP_PROP_EXPERIMENTER_SIZE)
729 # struct ofp_group_mod
730 OFP_GROUP_MOD_PACK_STR = '!HBxIH2xI'
731 OFP_GROUP_MOD_SIZE = 24
732 assert (calcsize(OFP_GROUP_MOD_PACK_STR) + OFP_HEADER_SIZE ==
735 # enum ofp_group_type
736 OFPGT_ALL = 0 # All (multicast/broadcast) group.
737 OFPGT_SELECT = 1 # Select group.
738 OFPGT_INDIRECT = 2 # Indirect group.
739 OFPGT_FF = 3 # Fast failover group.
742 OFP_NO_BUFFER = 0xffffffff # Special buffer-id to indicate 'no buffer'
744 # struct ofp_packet_out
745 OFP_PACKET_OUT_0_PACK_STR = '!IH2x'
746 OFP_PACKET_OUT_0_SIZE = 16
747 OFP_PACKET_OUT_SIZE = 24
748 assert (calcsize(OFP_PACKET_OUT_0_PACK_STR) + OFP_MATCH_SIZE + OFP_HEADER_SIZE ==
751 # enum ofp_packet_in_reason
752 OFPR_TABLE_MISS = 0 # No matching flow (table-miss flow entry).
753 OFPR_APPLY_ACTION = 1 # Output to controller in apply-actions.
754 OFPR_INVALID_TTL = 2 # Packet has invalid TTL.
755 OFPR_ACTION_SET = 3 # Output to controller in action set.
756 OFPR_GROUP = 4 # Output to controller in group bucket.
757 OFPR_PACKET_OUT = 5 # Output to controller in packet-out.
759 # struct ofp_packet_in
760 OFP_PACKET_IN_PACK_STR = '!IHBBQ'
761 OFP_PACKET_IN_SIZE = 32
762 assert (calcsize(OFP_PACKET_IN_PACK_STR) + OFP_MATCH_SIZE + OFP_HEADER_SIZE ==
765 # enum ofp_flow_removed_reason
766 OFPRR_IDLE_TIMEOUT = 0 # Flow idle time exceeded idle_timeout.
767 OFPRR_HARD_TIMEOUT = 1 # Time exceeded hard_timeout.
768 OFPRR_DELETE = 2 # Evicted by a DELETE flow mod.
769 OFPRR_GROUP_DELETE = 3 # Group was removed.
770 OFPRR_METER_DELETE = 4 # Meter was removed.
771 OFPRR_EVICTION = 5 # Switch eviction to free resources.
773 # struct ofp_port_status
774 OFP_PORT_STATUS_PACK_STR = '!B7x' + _OFP_PORT_PACK_STR
775 OFP_PORT_STATUS_DESC_OFFSET = OFP_HEADER_SIZE + 8
776 OFP_PORT_STATUS_SIZE = 56
777 assert (calcsize(OFP_PORT_STATUS_PACK_STR) + OFP_HEADER_SIZE ==
778 OFP_PORT_STATUS_SIZE)
780 # struct ofp_flow_removed
781 _OFP_FLOW_REMOVED_PACK_STR0 = 'BBHHHQ'
782 OFP_FLOW_REMOVED_PACK_STR = '!' + _OFP_FLOW_REMOVED_PACK_STR0 + \
784 OFP_FLOW_REMOVED_PACK_STR0 = '!' + _OFP_FLOW_REMOVED_PACK_STR0
785 OFP_FLOW_REMOVED_SIZE = 32
786 assert (calcsize(OFP_FLOW_REMOVED_PACK_STR) + OFP_HEADER_SIZE ==
787 OFP_FLOW_REMOVED_SIZE)
790 OFPM_MAX = 0xffff0000
791 OFPM_SLOWPATH = 0xfffffffd # Meter for slow datapath, if any.
792 OFPM_CONTROLLER = 0xfffffffe # Meter for controller connection.
793 OFPM_ALL = 0xffffffff # Represents all meters for stat requests
796 # enum ofp_meter_band_type
797 OFPMBT_DROP = 1 # Drop packet.
798 OFPMBT_DSCP_REMARK = 2 # Remark DSCP in the IP header.
799 OFPMBT_EXPERIMENTER = 0xFFFF # Experimenter meter band.
801 # struct ofp_meter_band_drop
802 OFP_METER_BAND_DROP_PACK_STR = '!HHII4x'
803 OFP_METER_BAND_DROP_SIZE = 16
804 assert (calcsize(OFP_METER_BAND_DROP_PACK_STR) ==
805 OFP_METER_BAND_DROP_SIZE)
807 # struct ofp_meter_band_dscp_remark
808 OFP_METER_BAND_DSCP_REMARK_PACK_STR = '!HHIIB3x'
809 OFP_METER_BAND_DSCP_REMARK_SIZE = 16
810 assert (calcsize(OFP_METER_BAND_DSCP_REMARK_PACK_STR) ==
811 OFP_METER_BAND_DSCP_REMARK_SIZE)
813 # struct ofp_meter_band_experimenter
814 OFP_METER_BAND_EXPERIMENTER_PACK_STR = '!HHIII'
815 OFP_METER_BAND_EXPERIMENTER_SIZE = 16
816 assert (calcsize(OFP_METER_BAND_EXPERIMENTER_PACK_STR) ==
817 OFP_METER_BAND_EXPERIMENTER_SIZE)
819 # enum ofp_meter_mod_command
820 OFPMC_ADD = 0 # New meter.
821 OFPMC_MODIFY = 1 # Modify specified meter.
822 OFPMC_DELETE = 2 # Delete specified meter.
824 # enum ofp_meter_flags
825 OFPMF_KBPS = 1 << 0 # Rate value in kb/s (kilo-bit per second).
826 OFPMF_PKTPS = 1 << 1 # Rate value in packet/sec.
827 OFPMF_BURST = 1 << 2 # Do burst size.
828 OFPMF_STATS = 1 << 3 # Collect statistics.
830 # struct ofp_meter_band_header
831 OFP_METER_BAND_HEADER_PACK_STR = '!HHII'
832 OFP_METER_BAND_HEADER_SIZE = 12
833 assert (calcsize(OFP_METER_BAND_HEADER_PACK_STR) ==
834 OFP_METER_BAND_HEADER_SIZE)
836 # struct ofp_meter_mod
837 OFP_METER_MOD_PACK_STR = '!HHI'
838 OFP_METER_MOD_SIZE = 16
839 assert (calcsize(OFP_METER_MOD_PACK_STR) + OFP_HEADER_SIZE ==
843 # enum ofp_error_type
844 OFPET_HELLO_FAILED = 0 # Hello protocol failed.
845 OFPET_BAD_REQUEST = 1 # Request was not understood.
846 OFPET_BAD_ACTION = 2 # Error in action description.
847 OFPET_BAD_INSTRUCTION = 3 # Error in instruction list.
848 OFPET_BAD_MATCH = 4 # Error in match.
849 OFPET_FLOW_MOD_FAILED = 5 # Problem modifying flow entry.
850 OFPET_GROUP_MOD_FAILED = 6 # Problem modifying group entry.
851 OFPET_PORT_MOD_FAILED = 7 # OFPT_PORT_MOD failed.
852 OFPET_TABLE_MOD_FAILED = 8 # Table mod request failed.
853 OFPET_QUEUE_OP_FAILED = 9 # Queue operation failed.
854 OFPET_SWITCH_CONFIG_FAILED = 10 # Switch config request failed.
855 OFPET_ROLE_REQUEST_FAILED = 11 # Controller Role request failed.
856 OFPET_METER_MOD_FAILED = 12 # Error in meter.
857 OFPET_TABLE_FEATURES_FAILED = 13 # Setting table features failed.
858 OFPET_BAD_PROPERTY = 14 # Some property is invalid.
859 OFPET_ASYNC_CONFIG_FAILED = 15 # Asynchronous config request failed.
860 OFPET_FLOW_MONITOR_FAILED = 16 # Setting flow monitor failed.
861 OFPET_BUNDLE_FAILED = 17 # Bundle operation failed.
862 OFPET_EXPERIMENTER = 0xffff # Experimenter error messages.
864 # enum ofp_hello_failed_code
865 OFPHFC_INCOMPATIBLE = 0 # No compatible version.
866 OFPHFC_EPERM = 1 # Permissions error.
868 # enum ofp_bad_request_code
869 OFPBRC_BAD_VERSION = 0 # ofp_header.version not supported.
870 OFPBRC_BAD_TYPE = 1 # ofp_header.type not supported.
871 OFPBRC_BAD_MULTIPART = 2 # ofp_multipart_request.type not
873 OFPBRC_BAD_EXPERIMENTER = 3 # Experimenter id not supported
874 # (in ofp_experimenter_header
875 # or ofp_multipart_request or
876 # ofp_multipart_reply).
877 OFPBRC_BAD_EXP_TYPE = 4 # Experimenter type not supported.
878 OFPBRC_EPERM = 5 # Permissions error.
879 OFPBRC_BAD_LEN = 6 # Wrong request length for type.
880 OFPBRC_BUFFER_EMPTY = 7 # Specified buffer has already been
882 OFPBRC_BUFFER_UNKNOWN = 8 # Specified buffer does not exist.
883 OFPBRC_BAD_TABLE_ID = 9 # Specified table-id invalid or does
885 OFPBRC_IS_SLAVE = 10 # Denied because controller is slave.
886 OFPBRC_BAD_PORT = 11 # Invalid port or missing port.
887 OFPBRC_BAD_PACKET = 12 # Invalid packet in packet-out
888 OFPBRC_MULTIPART_BUFFER_OVERFLOW = 13 # ofp_multipart_request
889 # overflowed the assigned buffer.
890 OFPBRC_MULTIPART_REQUEST_TIMEOUT = 14 # Timeout during multipart request.
891 OFPBRC_MULTIPART_REPLY_TIMEOUT = 15 # Timeout during multipart reply.
892 OFPBRC_MULTIPART_BAD_SCHED = 16 # Switch received a
893 # OFPMP_BUNDLE_FEATURES request and
894 # failed to update the scheduling
896 OFPBRC_PIPELINE_FIELDS_ONLY = 17 # Match fields must include only
898 OFPBRC_UNKNOWN = 18 # Unspecified error.
901 # enum ofp_bad_action_code
902 OFPBAC_BAD_TYPE = 0 # Unknown or unsupported action type.
903 OFPBAC_BAD_LEN = 1 # Length problem in actions.
904 OFPBAC_BAD_EXPERIMENTER = 2 # Unknown experimenter id specified.
905 OFPBAC_BAD_EXP_TYPE = 3 # Unknown action type for experimenter id.
906 OFPBAC_BAD_OUT_PORT = 4 # Problem validating output action.
907 OFPBAC_BAD_ARGUMENT = 5 # Bad action argument.
908 OFPBAC_EPERM = 6 # Permissions error.
909 OFPBAC_TOO_MANY = 7 # Can't handle this many actions.
910 OFPBAC_BAD_QUEUE = 8 # Problem validating output queue.
911 OFPBAC_BAD_OUT_GROUP = 9 # Invalid group id in forward action.
912 OFPBAC_MATCH_INCONSISTENT = 10 # Action can't apply for this match,
913 # or Set-Field missing prerequisite.
914 OFPBAC_UNSUPPORTED_ORDER = 11 # Action order is unsupported for
915 # the action list in an Apply-Actions
917 OFPBAC_BAD_TAG = 12 # Actions uses an unsupported tag/encap.
918 OFPBAC_BAD_SET_TYPE = 13 # Unsupported type in SET_FIELD action.
919 OFPBAC_BAD_SET_LEN = 14 # Length problem in SET_FIELD action.
920 OFPBAC_BAD_SET_ARGUMENT = 15 # Bad arguement in SET_FIELD action.
921 OFPBAC_BAD_SET_MASK = 16 # Bad mask in SET_FIELD action.
922 OFPBAC_BAD_METER = 17 # Invalid meter id in meter action.
924 # enum ofp_bad_instruction_code
925 OFPBIC_UNKNOWN_INST = 0 # Unknown instruction.
926 OFPBIC_UNSUP_INST = 1 # Switch or table does not support
928 OFPBIC_BAD_TABLE_ID = 2 # Invalid Table-Id specified
929 OFPBIC_UNSUP_METADATA = 3 # Metadata value unsupported by datapath.
930 OFPBIC_UNSUP_METADATA_MASK = 4 # Metadata mask value unsupported by
932 OFPBIC_BAD_EXPERIMENTER = 5 # Unknown experimenter id specified.
933 OFPBIC_BAD_EXP_TYPE = 6 # Unknown instruction for experimenter id.
934 OFPBIC_BAD_LEN = 7 # Length problem in instrucitons.
935 OFPBIC_EPERM = 8 # Permissions error.
936 OFPBIC_DUP_INST = 9 # Duplicate instruction.
938 # enum ofp_bad_match_code
939 OFPBMC_BAD_TYPE = 0 # Unsupported match type apecified by
941 OFPBMC_BAD_LEN = 1 # Length problem in math.
942 OFPBMC_BAD_TAG = 2 # Match uses an unsupported tag/encap.
943 OFPBMC_BAD_DL_ADDR_MASK = 3 # Unsupported datalink addr mask -
944 # switch does not support arbitrary
945 # datalink address mask.
946 OFPBMC_BAD_NW_ADDR_MASK = 4 # Unsupported network addr mask -
947 # switch does not support arbitrary
948 # network addres mask.
949 OFPBMC_BAD_WILDCARDS = 5 # Unsupported combination of fields
950 # masked or omitted in the match.
951 OFPBMC_BAD_FIELD = 6 # Unsupported field type in the match.
952 OFPBMC_BAD_VALUE = 7 # Unsupported value in a match field.
953 OFPBMC_BAD_MASK = 8 # Unsupported mask specified in the match.
954 OFPBMC_BAD_PREREQ = 9 # A prerequisite was not met.
955 OFPBMC_DUP_FIELD = 10 # A field type was duplicated.
956 OFPBMC_EPERM = 11 # Permissions error.
958 # enum ofp_flow_mod_failed_code
959 OFPFMFC_UNKNOWN = 0 # Unspecified error.
960 OFPFMFC_TABLE_FULL = 1 # Flow not added because table was full.
961 OFPFMFC_BAD_TABLE_ID = 2 # Table does not exist
962 OFPFMFC_OVERLAP = 3 # Attempted to add overlapping flow with
963 # CHECK_OVERLAP flag set.
964 OFPFMFC_EPERM = 4 # Permissions error.
965 OFPFMFC_BAD_TIMEOUT = 5 # Flow not added because of unsupported
967 OFPFMFC_BAD_COMMAND = 6 # Unsupported or unknown command.
968 OFPFMFC_BAD_FLAGS = 7 # Unsupported or unknown flags.
969 OFPFMFC_CANT_SYNC = 8 # Problem in table synchronisation.
970 OFPFMFC_BAD_PRIORITY = 9 # Unsupported priority value.
971 OFPFMFC_IS_SYNC = 10 # Synchronised flow entry is read only.
973 # enum ofp_group_mod_failed_code
974 OFPGMFC_GROUP_EXISTS = 0 # Group not added because a group ADD
975 # attempted to replace an already-present
977 OFPGMFC_INVALID_GROUP = 1 # Group not added because Group specified
979 OFPGMFC_WEIGHT_UNSUPPORTED = 2 # Switch does not support unequal load
980 # sharing with select groups.
981 OFPGMFC_OUT_OF_GROUPS = 3 # The group table is full.
982 OFPGMFC_OUT_OF_BUCKETS = 4 # The maximum number of action buckets
983 # for a group has been exceeded.
984 OFPGMFC_CHAINING_UNSUPPORTED = 5 # Switch does not support groups that
986 OFPGMFC_WATCH_UNSUPPORTED = 6 # This group cannot watch the
987 # watch_port or watch_group specified.
988 OFPGMFC_LOOP = 7 # Group entry would cause a loop.
989 OFPGMFC_UNKNOWN_GROUP = 8 # Group not modified because a group MODIFY
990 # attempted to modify a non-existent group.
991 OFPGMFC_CHAINED_GROUP = 9 # Group not deleted because another group
992 # is forwarding to it.
993 OFPGMFC_BAD_TYPE = 10 # Unsupported or unknown group type.
994 OFPGMFC_BAD_COMMAND = 11 # Unsupported or unknown command.
995 OFPGMFC_BAD_BUCKET = 12 # Error in bucket.
996 OFPGMFC_BAD_WATCH = 13 # Error in watch port/group.
997 OFPGMFC_EPERM = 14 # Permissions error.
998 OFPGMFC_UNKNOWN_BUCKET = 15 # Invalid bucket identifier used in
999 # INSERT BUCKET or REMOVE BUCKET command.
1000 OFPGMFC_BUCKET_EXISTS = 16 # Can't insert bucket because a bucket
1001 # already exist with that bucket-id.
1003 # enum ofp_port_mod_failed_code
1004 OFPPMFC_BAD_PORT = 0 # Specified port does not exist.
1005 OFPPMFC_BAD_HW_ADDR = 1 # Specified hardware address does not match
1007 OFPPMFC_BAD_CONFIG = 2 # Specified config is invalid.
1008 OFPPMFC_BAD_ADVERTISE = 3 # Specified advertise is invalid.
1009 OFPPMFC_EPERM = 4 # Permissions error.
1011 # enum ofp_table_mod_failed_code
1012 OFPTMFC_BAD_TABLE = 0 # Specified table does not exist.
1013 OFPTMFC_BAD_CONFIG = 1 # Specified config is invalid.
1014 OFPTMFC_EPERM = 2 # Permissions error
1016 # enum ofp_queue_op_failed_code
1017 OFPQOFC_BAD_PORT = 0 # Invalid port (or port does not exist).
1018 OFPQOFC_BAD_QUEUE = 1 # Queue does not exist.
1019 OFPQOFC_EPERM = 2 # Permissions error.
1021 # enum ofp_switch_config_failed_code
1022 OFPSCFC_BAD_FLAGS = 0 # Specified flags is invalid.
1023 OFPSCFC_BAD_LEN = 1 # Specified miss send len is invalid.
1024 OFPSCFC_EPERM = 2 # Permissions error.
1027 # enum ofp_role_request_failed_code
1028 OFPRRFC_STALE = 0 # Stale Message: old generation_id.
1029 OFPRRFC_UNSUP = 1 # Controller role change unsupported.
1030 OFPRRFC_BAD_ROLE = 2 # Invalid role.
1031 OFPRRFC_ID_UNSUP = 3 # Switch doesn't support changing ID.
1032 OFPRRFC_ID_IN_USE = 4 # Requested ID is in use.
1034 # enum ofp_meter_mod_failed_code
1035 OFPMMFC_UNKNOWN = 0 # Unspecified error.
1036 OFPMMFC_METER_EXISTS = 1 # Meter not added because a Meter ADD
1037 # attempted to replace an existing Meter.
1038 OFPMMFC_INVALID_METER = 2 # Meter not added because Meter specified
1039 # is invalid, or invalid meter in meter action.
1040 OFPMMFC_UNKNOWN_METER = 3 # Meter not modified because a Meter MODIFY
1041 # attempted to modify a non-existent Meter,
1042 # or bad meter in meter action.
1043 OFPMMFC_BAD_COMMAND = 4 # Unsupported or unknown command.
1044 OFPMMFC_BAD_FLAGS = 5 # Flag configuration unsupported.
1045 OFPMMFC_BAD_RATE = 6 # Rate unsupported.
1046 OFPMMFC_BAD_BURST = 7 # Burst size unsupported.
1047 OFPMMFC_BAD_BAND = 8 # Band unsupported.
1048 OFPMMFC_BAD_BAND_VALUE = 9 # Band value unsupported.
1049 OFPMMFC_OUT_OF_METERS = 10 # No more meters availabile.
1050 OFPMMFC_OUT_OF_BANDS = 11 # The maximum number of properties for a
1051 # meter has been exceeded.
1053 # enum ofp_table_features_failed_code
1054 OFPTFFC_BAD_TABLE = 0 # Specified table does not exist.
1055 OFPTFFC_BAD_METADATA = 1 # Invalid metadata mask.
1056 OFPTFFC_EPERM = 5 # Permissions error.
1057 OFPTFFC_BAD_CAP = 6 # Invalid capability field.
1058 OFPTFFC_BAD_MAX_ENT = 7 # Invalid max_entries field.
1059 OFPTFFC_BAD_FEATURES = 8 # Invalid features field.
1060 OFPTFFC_BAD_COMMAND = 9 # Invalid command.
1061 OFPTFFC_TOO_MANY = 10 # Can't handle this many flow tables.
1063 # enum ofp_bad_property_code
1064 OFPBPC_BAD_TYPE = 0 # Unknown or unsupported property type.
1065 OFPBPC_BAD_LEN = 1 # Length problem in property.
1066 OFPBPC_BAD_VALUE = 2 # Unsupported property value.
1067 OFPBPC_TOO_MANY = 3 # Can't handle this many properties.
1068 OFPBPC_DUP_TYPE = 4 # A property type was duplicated.
1069 OFPBPC_BAD_EXPERIMENTER = 5 # Unknown experimenter id specified.
1070 OFPBPC_BAD_EXP_TYPE = 6 # Unknown exp_type for experimenter id.
1071 OFPBPC_BAD_EXP_VALUE = 7 # Unknown value for experimenter id.
1072 OFPBPC_EPERM = 8 # Permissions error.
1074 # enum ofp_async_config_failed_code
1075 OFPACFC_INVALID = 0 # One mask is invalid.
1076 OFPACFC_UNSUPPORTED = 1 # Requested configuration not supported.
1077 OFPACFC_EPERM = 2 # Permissions error.
1079 # enum ofp_flow_monitor_failed_code
1080 OFPMOFC_UNKNOWN = 0 # Unspecified error.
1081 OFPMOFC_MONITOR_EXISTS = 1 # Monitor not added because a Monitor ADD
1082 # attempted to replace an existing
1084 OFPMOFC_INVALID_MONITOR = 2 # Monitor not added because Monitor
1085 # specified is invalid.
1086 OFPMOFC_UNKNOWN_MONITOR = 3 # Monitor not modified because a Monitor
1087 # MODIFY attempted to modify a non-existent
1089 OFPMOFC_BAD_COMMAND = 4 # Unsupported or unknown command.
1090 OFPMOFC_BAD_FLAGS = 5 # Flag configuration unsupported.
1091 OFPMOFC_BAD_TABLE_ID = 6 # Specified table does not exist.
1092 OFPMOFC_BAD_OUT = 7 # Error in output port/group.
1094 # enum ofp_bundle_failed_code
1095 OFPBFC_UNKNOWN = 0 # Unspecified error.
1096 OFPBFC_EPERM = 1 # Permissions error.
1097 OFPBFC_BAD_ID = 2 # Bundle ID doesn't exist.
1098 OFPBFC_BUNDLE_EXIST = 3 # Bundle ID already exist.
1099 OFPBFC_BUNDLE_CLOSED = 4 # Bundle ID is closed.
1100 OFPBFC_OUT_OF_BUNDLES = 5 # Too many bundles IDs.
1101 OFPBFC_BAD_TYPE = 6 # Unsupported or unknown message control type.
1102 OFPBFC_BAD_FLAGS = 7 # Unsupported, unknown, or inconsistent flags.
1103 OFPBFC_MSG_BAD_LEN = 8 # Length problem in included message.
1104 OFPBFC_MSG_BAD_XID = 9 # Inconsistent or duplicate XID.
1105 OFPBFC_MSG_UNSUP = 10 # Unsupported message in this bundle.
1106 OFPBFC_MSG_CONFLICT = 11 # Unsupported message combination in this
1108 OFPBFC_MSG_TOO_MANY = 12 # Can't handle this many messages in bundle.
1109 OFPBFC_MSG_FAILED = 13 # One message in bundle failed.
1110 OFPBFC_TIMEOUT = 14 # Bundle is taking too long.
1111 OFPBFC_BUNDLE_IN_PROGRESS = 15 # Bundle is locking the resource.
1112 OFPBFC_SCHED_NOT_SUPPORTED = 16 # Scheduled commit was received and
1113 # scheduling is not supported.
1114 OFPBFC_SCHED_FUTURE = 17 # Scheduled commit time exceeds upper bound.
1115 OFPBFC_SCHED_PAST = 18 # Scheduled commit time exceeds lower bound.
1117 # struct ofp_error_msg
1118 OFP_ERROR_MSG_PACK_STR = '!HH'
1119 OFP_ERROR_MSG_SIZE = 12
1120 assert (calcsize(OFP_ERROR_MSG_PACK_STR) + OFP_HEADER_SIZE ==
1123 # struct ofp_error_experimenter_msg
1124 OFP_ERROR_EXPERIMENTER_MSG_PACK_STR = '!HHI'
1125 OFP_ERROR_EXPERIMENTER_MSG_SIZE = 16
1126 assert (calcsize(OFP_ERROR_EXPERIMENTER_MSG_PACK_STR) +
1127 OFP_HEADER_SIZE) == OFP_ERROR_EXPERIMENTER_MSG_SIZE
1129 # struct ofp_experimenter_header
1130 OFP_EXPERIMENTER_HEADER_PACK_STR = '!II'
1131 OFP_EXPERIMENTER_HEADER_SIZE = 16
1132 assert (calcsize(OFP_EXPERIMENTER_HEADER_PACK_STR) + OFP_HEADER_SIZE
1133 == OFP_EXPERIMENTER_HEADER_SIZE)
1135 # enum ofp_multipart_type
1138 OFPMP_AGGREGATE_STATS = 2
1139 OFPMP_TABLE_STATS = 3
1140 OFPMP_PORT_STATS = 4
1141 OFPMP_QUEUE_STATS = 5
1142 OFPMP_GROUP_STATS = 6
1143 OFPMP_GROUP_DESC = 7
1144 OFPMP_GROUP_FEATURES = 8
1145 OFPMP_METER_STATS = 9
1146 OFPMP_METER_DESC = 10
1147 OFPMP_METER_FEATURES = 11
1148 OFPMP_TABLE_FEATURES = 12
1149 OFPMP_PORT_DESC = 13
1150 OFPMP_TABLE_DESC = 14
1151 OFPMP_QUEUE_DESC = 15
1152 OFPMP_FLOW_MONITOR = 16
1153 OFPMP_FLOW_STATS = 17
1154 OFPMP_CONTROLLER_STATUS = 18
1155 OFPMP_BUNDLE_FEATURES = 19
1156 OFPMP_EXPERIMENTER = 0xffff
1158 # struct ofp_multipart_request
1159 OFP_MULTIPART_REQUEST_PACK_STR = '!HH4x'
1160 OFP_MULTIPART_REQUEST_SIZE = 16
1161 assert (calcsize(OFP_MULTIPART_REQUEST_PACK_STR) + OFP_HEADER_SIZE ==
1162 OFP_MULTIPART_REQUEST_SIZE)
1164 # enum ofp_multipart_reply_flags
1165 OFPMPF_REPLY_MORE = 1 << 0 # More requests to follow.
1167 # struct ofp_multipart_reply
1168 OFP_MULTIPART_REPLY_PACK_STR = '!HH4x'
1169 OFP_MULTIPART_REPLY_SIZE = 16
1170 assert (calcsize(OFP_MULTIPART_REPLY_PACK_STR) + OFP_HEADER_SIZE ==
1171 OFP_MULTIPART_REPLY_SIZE)
1174 DESC_STR_LEN_STR = str(DESC_STR_LEN)
1176 SERIAL_NUM_LEN_STR = str(SERIAL_NUM_LEN)
1177 OFP_DESC_PACK_STR = '!' + \
1178 DESC_STR_LEN_STR + 's' + \
1179 DESC_STR_LEN_STR + 's' + \
1180 DESC_STR_LEN_STR + 's' + \
1181 SERIAL_NUM_LEN_STR + 's' + \
1182 DESC_STR_LEN_STR + 's'
1183 OFP_DESC_SIZE = 1056
1184 assert calcsize(OFP_DESC_PACK_STR) == OFP_DESC_SIZE
1186 # struct ofp_flow_stats_request
1187 _OFP_FLOW_STATS_REQUEST_0_PACK_STR = 'B3xII4xQQ'
1188 OFP_FLOW_STATS_REQUEST_0_PACK_STR = '!' + _OFP_FLOW_STATS_REQUEST_0_PACK_STR
1189 OFP_FLOW_STATS_REQUEST_0_SIZE = 32
1190 assert (calcsize(OFP_FLOW_STATS_REQUEST_0_PACK_STR) ==
1191 OFP_FLOW_STATS_REQUEST_0_SIZE)
1192 OFP_FLOW_STATS_REQUEST_PACK_STR = (OFP_FLOW_STATS_REQUEST_0_PACK_STR +
1193 _OFP_MATCH_PACK_STR)
1194 OFP_FLOW_STATS_REQUEST_SIZE = 40
1195 assert (calcsize(OFP_FLOW_STATS_REQUEST_PACK_STR) ==
1196 OFP_FLOW_STATS_REQUEST_SIZE)
1198 # struct ofp_flow_desc
1199 _OFP_FLOW_DESC_0_PACK_STR = 'H2xBxHHHHHQ'
1200 OFP_FLOW_DESC_0_PACK_STR = '!' + _OFP_FLOW_DESC_0_PACK_STR
1201 OFP_FLOW_DESC_0_SIZE = 24
1202 assert calcsize(OFP_FLOW_DESC_0_PACK_STR) == OFP_FLOW_DESC_0_SIZE
1203 OFP_FLOW_DESC_PACK_STR = OFP_FLOW_DESC_0_PACK_STR + _OFP_MATCH_PACK_STR
1204 OFP_FLOW_DESC_SIZE = 32
1205 assert calcsize(OFP_FLOW_DESC_PACK_STR) == OFP_FLOW_DESC_SIZE
1207 # enum ofp_flow_stats_reason
1208 OFPFSR_STATS_REQUEST = 0 # Reply to a OFPMP_FLOW_STATS request.
1209 OFPFSR_STAT_TRIGGER = 1 # Status generated by OFPIT_STAT_TRIGGER.
1211 # struct ofp_flow_stats
1212 _OFP_FLOW_STATS_0_PACK_STR = 'H2xBBH'
1213 OFP_FLOW_STATS_0_PACK_STR = '!' + _OFP_FLOW_STATS_0_PACK_STR
1214 OFP_FLOW_STATS_0_SIZE = 8
1215 assert calcsize(OFP_FLOW_STATS_0_PACK_STR) == OFP_FLOW_STATS_0_SIZE
1216 OFP_FLOW_STATS_PACK_STR = (OFP_FLOW_STATS_0_PACK_STR +
1217 _OFP_MATCH_PACK_STR)
1218 OFP_FLOW_STATS_SIZE = 16
1219 assert calcsize(OFP_FLOW_STATS_PACK_STR) == OFP_FLOW_STATS_SIZE
1221 # struct ofp_aggregate_stats_request
1222 OFP_AGGREGATE_STATS_REQUEST_PACK_STR = '!B3xII4xQQ' + _OFP_MATCH_PACK_STR
1223 OFP_AGGREGATE_STATS_REQUEST_SIZE = 40
1224 assert (calcsize(OFP_AGGREGATE_STATS_REQUEST_PACK_STR) ==
1225 OFP_AGGREGATE_STATS_REQUEST_SIZE)
1227 # struct ofp_aggregate_stats_reply
1228 OFP_AGGREGATE_STATS_REPLY_PACK_STR = OFP_STATS_PACK_STR
1229 OFP_AGGREGATE_STATS_REPLY_SIZE = OFP_STATS_SIZE
1230 assert (calcsize(OFP_AGGREGATE_STATS_REPLY_PACK_STR) ==
1231 OFP_AGGREGATE_STATS_REPLY_SIZE)
1234 # enum ofp_table_feature_prop_type
1235 OFPTFPT_INSTRUCTIONS = 0
1236 OFPTFPT_INSTRUCTIONS_MISS = 1
1237 OFPTFPT_NEXT_TABLES = 2
1238 OFPTFPT_NEXT_TABLES_MISS = 3
1239 OFPTFPT_WRITE_ACTIONS = 4
1240 OFPTFPT_WRITE_ACTIONS_MISS = 5
1241 OFPTFPT_APPLY_ACTIONS = 6
1242 OFPTFPT_APPLY_ACTIONS_MISS = 7
1244 OFPTFPT_WILDCARDS = 10
1245 OFPTFPT_WRITE_SETFIELD = 12
1246 OFPTFPT_WRITE_SETFIELD_MISS = 13
1247 OFPTFPT_APPLY_SETFIELD = 14
1248 OFPTFPT_APPLY_SETFIELD_MISS = 15
1249 OFPTFPT_TABLE_SYNC_FROM = 16
1250 OFPTFPT_WRITE_COPYFIELD = 18 # Write Copy-Field property.
1251 OFPTFPT_WRITE_COPYFIELD_MISS = 19 # Write Copy-Field for table-miss.
1252 OFPTFPT_APPLY_COPYFIELD = 20 # Apply Copy-Field property.
1253 OFPTFPT_APPLY_COPYFIELD_MISS = 21 # Apply Copy-Field for table-miss.
1254 OFPTFPT_PACKET_TYPES = 22 # Packet types property.
1255 OFPTFPT_EXPERIMENTER = 0xFFFE
1256 OFPTFPT_EXPERIMENTER_MISS = 0xFFFF
1258 # struct ofp_instruction_id
1259 OFP_INSTRUCTION_ID_PACK_STR = '!HH'
1260 OFP_INSTRUCTION_ID_SIZE = 4
1261 assert calcsize(OFP_INSTRUCTION_ID_PACK_STR) == OFP_INSTRUCTION_ID_SIZE
1263 # struct ofp_table_feature_prop_instructions
1264 OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_PACK_STR = '!HH'
1265 OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_SIZE = 4
1266 assert (calcsize(OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_PACK_STR) ==
1267 OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_SIZE)
1269 # struct ofp_table_feature_prop_actions
1270 OFP_TABLE_FEATURE_PROP_ACTIONS_PACK_STR = '!HH'
1271 OFP_TABLE_FEATURE_PROP_ACTIONS_SIZE = 4
1272 assert (calcsize(OFP_TABLE_FEATURE_PROP_ACTIONS_PACK_STR) ==
1273 OFP_TABLE_FEATURE_PROP_ACTIONS_SIZE)
1275 # struct ofp_table_feature_prop_oxm
1276 OFP_TABLE_FEATURE_PROP_OXM_PACK_STR = '!HH'
1277 OFP_TABLE_FEATURE_PROP_OXM_SIZE = 4
1278 assert (calcsize(OFP_TABLE_FEATURE_PROP_OXM_PACK_STR) ==
1279 OFP_TABLE_FEATURE_PROP_OXM_SIZE)
1281 # struct ofp_table_feature_prop_oxm_values
1282 OFP_TABLE_FEATURE_PROP_OXM_VALUES_PACK_STR = '!HH'
1283 OFP_TABLE_FEATURE_PROP_OXM_VALUES_SIZE = 4
1284 assert (calcsize(OFP_TABLE_FEATURE_PROP_OXM_VALUES_PACK_STR) ==
1285 OFP_TABLE_FEATURE_PROP_OXM_VALUES_SIZE)
1287 # struct ofp_table_feature_prop_experimenter
1288 OFP_TABLE_FEATURE_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1289 OFP_TABLE_FEATURE_PROP_EXPERIMENTER_SIZE = 12
1290 assert (calcsize(OFP_TABLE_FEATURE_PROP_EXPERIMENTER_PACK_STR) ==
1291 OFP_TABLE_FEATURE_PROP_EXPERIMENTER_SIZE)
1293 # enum ofp_table_feature_flag
1294 OFPTFF_INGRESS_TABLE = 1 << 0 # Can be configured as ingress table.
1295 OFPTFF_EGRESS_TABLE = 1 << 1 # Can be configured as egress table.
1296 OFPTFF_FIRST_EGRESS = 1 << 4 # Is the first egress table.
1298 # enum ofp_table_features_command
1299 OFPTFC_REPLACE = 0 # Replace full pipeline.
1300 OFPTFC_MODIFY = 1 # Modify flow tables capabilities.
1301 OFPTFC_ENABLE = 2 # Enable flow tables in the pipeline.
1302 OFPTFC_DISABLE = 3 # Disable flow tables in pipeline.
1304 # struct ofp_table_features
1305 OFP_MAX_TABLE_NAME_LEN = 32
1306 OFP_MAX_TABLE_NAME_LEN_STR = str(OFP_MAX_TABLE_NAME_LEN)
1307 OFP_TABLE_FEATURES_PACK_STR = '!HBBI' + OFP_MAX_TABLE_NAME_LEN_STR + \
1309 OFP_TABLE_FEATURES_SIZE = 64
1310 assert (calcsize(OFP_TABLE_FEATURES_PACK_STR) ==
1311 OFP_TABLE_FEATURES_SIZE)
1313 # struct ofp_table_stats
1314 OFP_TABLE_STATS_PACK_STR = '!B3xIQQ'
1315 OFP_TABLE_STATS_SIZE = 24
1316 assert calcsize(OFP_TABLE_STATS_PACK_STR) == OFP_TABLE_STATS_SIZE
1318 # struct ofp_table_desc
1319 _OFP_TABLE_DESC_PACK_STR = 'HBxI'
1320 OFP_TABLE_DESC_PACK_STR = '!' + _OFP_TABLE_DESC_PACK_STR
1321 OFP_TABLE_DESC_SIZE = 8
1322 assert calcsize(OFP_TABLE_DESC_PACK_STR) == OFP_TABLE_DESC_SIZE
1324 # struct ofp_port_multipart_request
1325 OFP_PORT_MULTIPART_REQUEST_PACK_STR = '!I4x'
1326 OFP_PORT_MULTIPART_REQUEST_SIZE = 8
1327 assert (calcsize(OFP_PORT_MULTIPART_REQUEST_PACK_STR) ==
1328 OFP_PORT_MULTIPART_REQUEST_SIZE)
1330 # enum ofp_port_stats_prop_type
1331 OFPPSPT_ETHERNET = 0 # Ethernet property.
1332 OFPPSPT_OPTICAL = 1 # Optical property.
1333 OFPPSPT_EXPERIMENTER = 0xFFFF # Experimenter property.
1335 # struct ofp_port_stats_prop_ethernet
1336 OFP_PORT_STATS_PROP_ETHERNET_PACK_STR = '!HH4xQQQQ'
1337 OFP_PORT_STATS_PROP_ETHERNET_SIZE = 40
1338 assert (calcsize(OFP_PORT_STATS_PROP_ETHERNET_PACK_STR) ==
1339 OFP_PORT_STATS_PROP_ETHERNET_SIZE)
1341 # struct ofp_port_stats_prop_optical
1342 OFP_PORT_STATS_PROP_OPTICAL_PACK_STR = '!HH4xIIIIIIIHHHH'
1343 OFP_PORT_STATS_PROP_OPTICAL_SIZE = 44
1344 assert (calcsize(OFP_PORT_STATS_PROP_OPTICAL_PACK_STR) ==
1345 OFP_PORT_STATS_PROP_OPTICAL_SIZE)
1347 # enum ofp_port_stats_optical_flags
1348 OFPOSF_RX_TUNE = 1 << 0 # Receiver tune info valid
1349 OFPOSF_TX_TUNE = 1 << 1 # Transmit tune info valid
1350 OFPOSF_TX_PWR = 1 << 2 # TX Power is valid
1351 OFPOSF_RX_PWR = 1 << 4 # RX power is valid
1352 OFPOSF_TX_BIAS = 1 << 5 # Transmit bias is valid
1353 OFPOSF_TX_TEMP = 1 << 6 # TX Temp is valid
1355 # struct ofp_port_stats_prop_experimenter
1356 OFP_PORT_STATS_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1357 OFP_PORT_STATS_PROP_EXPERIMENTER_SIZE = 12
1358 assert (calcsize(OFP_PORT_STATS_PROP_EXPERIMENTER_PACK_STR) ==
1359 OFP_PORT_STATS_PROP_EXPERIMENTER_SIZE)
1361 # struct ofp_port_stats
1362 OFP_PORT_STATS_PACK_STR = '!H2xIIIQQQQQQQQ'
1363 OFP_PORT_STATS_SIZE = 80
1364 assert calcsize(OFP_PORT_STATS_PACK_STR) == OFP_PORT_STATS_SIZE
1366 # struct ofp_group_multipart_request
1367 OFP_GROUP_MULTIPART_REQUEST_PACK_STR = '!I4x'
1368 OFP_GROUP_MULTIPART_REQUEST_SIZE = 8
1369 assert (calcsize(OFP_GROUP_MULTIPART_REQUEST_PACK_STR) ==
1370 OFP_GROUP_MULTIPART_REQUEST_SIZE)
1372 # struct ofp_bucket_counter
1373 OFP_BUCKET_COUNTER_PACK_STR = '!QQ'
1374 OFP_BUCKET_COUNTER_SIZE = 16
1375 assert calcsize(OFP_BUCKET_COUNTER_PACK_STR) == OFP_BUCKET_COUNTER_SIZE
1377 # struct ofp_group_stats
1378 OFP_GROUP_STATS_PACK_STR = '!H2xII4xQQII'
1379 OFP_GROUP_STATS_SIZE = 40
1380 assert calcsize(OFP_GROUP_STATS_PACK_STR) == OFP_GROUP_STATS_SIZE
1382 # struct ofp_group_desc
1383 OFP_GROUP_DESC_PACK_STR = '!HBxIH6x'
1384 OFP_GROUP_DESC_SIZE = 16
1385 assert calcsize(OFP_GROUP_DESC_PACK_STR) == OFP_GROUP_DESC_SIZE
1387 # struct ofp_group_desc_stats
1388 # Backward compatibility with 1.3.1 - avoid breaking the API.
1389 OFP_GROUP_DESC_STATS_PACK_STR = OFP_GROUP_DESC_PACK_STR
1390 OFP_GROUP_DESC_STATS_SIZE = OFP_GROUP_DESC_SIZE
1391 assert calcsize(OFP_GROUP_DESC_STATS_PACK_STR) == OFP_GROUP_DESC_STATS_SIZE
1393 # enum ofp_group_capabilities
1394 OFPGFC_SELECT_WEIGHT = 1 << 0 # Support weight for select groups.
1395 OFPGFC_SELECT_LIVENESS = 1 << 1 # Support liveness for select groups.
1396 OFPGFC_CHAINING = 1 << 2 # Support chaining groups.
1397 OFPGFC_CHAINING_CHECKS = 1 << 3 # Check chaining for loops and delete
1399 # struct ofp_group_features
1400 OFP_GROUP_FEATURES_PACK_STR = '!II4I4I'
1401 OFP_GROUP_FEATURES_SIZE = 40
1402 assert calcsize(OFP_GROUP_FEATURES_PACK_STR) == OFP_GROUP_FEATURES_SIZE
1404 # struct ofp_meter_multipart_request
1405 OFP_METER_MULTIPART_REQUEST_PACK_STR = '!I4x'
1406 OFP_METER_MULTIPART_REQUEST_SIZE = 8
1407 assert (calcsize(OFP_METER_MULTIPART_REQUEST_PACK_STR) ==
1408 OFP_METER_MULTIPART_REQUEST_SIZE)
1410 # struct ofp_meter_stats
1411 OFP_METER_STATS_PACK_STR = '!IH6xIQQII'
1412 OFP_METER_STATS_SIZE = 40
1413 assert calcsize(OFP_METER_STATS_PACK_STR) == OFP_METER_STATS_SIZE
1415 # struct ofp_meter_band_stats
1416 OFP_METER_BAND_STATS_PACK_STR = '!QQ'
1417 OFP_METER_BAND_STATS_SIZE = 16
1418 assert (calcsize(OFP_METER_BAND_STATS_PACK_STR) ==
1419 OFP_METER_BAND_STATS_SIZE)
1421 # struct ofp_meter_desc
1422 OFP_METER_DESC_PACK_STR = '!HHI'
1423 OFP_METER_DESC_SIZE = 8
1424 assert calcsize(OFP_METER_DESC_PACK_STR) == OFP_METER_DESC_SIZE
1426 # enum ofp_meter_feature_flags
1427 OFPMFF_ACTION_SET = 1 << 0 # Support meter action in action set.
1428 OFPMFF_ANY_POSITION = 1 << 1 # Support any position in action list.
1429 OFPMFF_MULTI_LIST = 1 << 2 # Support multiple actions in action list.
1431 # struct ofp_meter_features
1432 OFP_METER_FEATURES_PACK_STR = '!IIIBB2xI4x'
1433 OFP_METER_FEATURES_SIZE = 24
1434 assert (calcsize(OFP_METER_FEATURES_PACK_STR) ==
1435 OFP_METER_FEATURES_SIZE)
1437 # All ones is used to indicate all queues in a port (for stats retrieval).
1438 OFPQ_ALL = 0xffffffff
1440 # Min rate > 1000 means not configured.
1441 OFPQ_MIN_RATE_UNCFG = 0xffff
1443 # Max rate > 1000 means not configured.
1444 OFPQ_MAX_RATE_UNCFG = 0xffff
1446 # enum ofp_queue_desc_prop_type
1447 OFPQDPT_MIN_RATE = 1 # Minimum datarate guaranteed.
1448 OFPQDPT_MAX_RATE = 2 # Maximum datarate.
1449 OFPQDPT_EXPERIMENTER = 0xffff # Experimenter defined property.
1451 # struct ofp_queue_desc_prop_min_rate
1452 OFP_QUEUE_DESC_PROP_MIN_RATE_PACK_STR = '!HHH2x'
1453 OFP_QUEUE_DESC_PROP_MIN_RATE_SIZE = 8
1454 assert (calcsize(OFP_QUEUE_DESC_PROP_MIN_RATE_PACK_STR) ==
1455 OFP_QUEUE_DESC_PROP_MIN_RATE_SIZE)
1457 # ofp_queue_desc_prop_max_rate
1458 OFP_QUEUE_DESC_PROP_MAX_RATE_PACK_STR = '!HHH2x'
1459 OFP_QUEUE_DESC_PROP_MAX_RATE_SIZE = 8
1460 assert (calcsize(OFP_QUEUE_DESC_PROP_MAX_RATE_PACK_STR) ==
1461 OFP_QUEUE_DESC_PROP_MAX_RATE_SIZE)
1463 # struct ofp_queue_desc_prop_experimenter
1464 OFP_QUEUE_DESC_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1465 OFP_QUEUE_DESC_PROP_EXPERIMENTER_SIZE = 12
1466 assert (calcsize(OFP_QUEUE_DESC_PROP_EXPERIMENTER_PACK_STR) ==
1467 OFP_QUEUE_DESC_PROP_EXPERIMENTER_SIZE)
1469 # struct ofp_queue_multipart_request
1470 OFP_QUEUE_MULTIPART_REQUEST_PACK_STR = '!II'
1471 OFP_QUEUE_MULTIPART_REQUEST_SIZE = 8
1472 assert (calcsize(OFP_QUEUE_MULTIPART_REQUEST_PACK_STR) ==
1473 OFP_QUEUE_MULTIPART_REQUEST_SIZE)
1475 # struct ofp_queue_desc
1476 OFP_QUEUE_DESC_PACK_STR = '!IIH6x'
1477 OFP_QUEUE_DESC_SIZE = 16
1478 assert calcsize(OFP_QUEUE_DESC_PACK_STR) == OFP_QUEUE_DESC_SIZE
1480 # enum ofp_queue_stats_prop_type
1481 OFPQSPT_EXPERIMENTER = 0xffff # Experimenter defined property.
1483 # struct ofp_queue_stats_prop_experimenter
1484 OFP_QUEUE_STATS_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1485 OFP_QUEUE_STATS_PROP_EXPERIMENTER_SIZE = 12
1486 assert (calcsize(OFP_QUEUE_STATS_PROP_EXPERIMENTER_PACK_STR) ==
1487 OFP_QUEUE_STATS_PROP_EXPERIMENTER_SIZE)
1489 # struct ofp_queue_stats
1490 OFP_QUEUE_STATS_PACK_STR = '!H6xIIQQQII'
1491 OFP_QUEUE_STATS_SIZE = 48
1492 assert calcsize(OFP_QUEUE_STATS_PACK_STR) == OFP_QUEUE_STATS_SIZE
1494 # struct ofp_flow_monitor_request
1495 _OFP_FLOW_MONITOR_REQUEST_0_PACK_STR = 'IIIHBB'
1496 OFP_FLOW_MONITOR_REQUEST_0_PACK_STR = ('!' +
1497 _OFP_FLOW_MONITOR_REQUEST_0_PACK_STR)
1498 OFP_FLOW_MONITOR_REQUEST_0_SIZE = 16
1499 OFP_FLOW_MONITOR_REQUEST_PACK_STR = (OFP_FLOW_MONITOR_REQUEST_0_PACK_STR +
1500 _OFP_MATCH_PACK_STR)
1501 OFP_FLOW_MONITOR_REQUEST_SIZE = 24
1502 assert (calcsize(OFP_FLOW_MONITOR_REQUEST_PACK_STR) ==
1503 OFP_FLOW_MONITOR_REQUEST_SIZE)
1505 # enum ofp_flow_monitor_command
1506 OFPFMC_ADD = 0 # New flow monitor.
1507 OFPFMC_MODIFY = 1 # Modify existing flow monitor.
1508 OFPFMC_DELETE = 2 # Delete/cancel existing flow monitor.
1510 # enum ofp_flow_monitor_flags
1511 # When to send updates.
1512 OFPFMF_INITIAL = 1 << 0 # Initially matching flows.
1513 OFPFMF_ADD = 1 << 1 # New matching flows as they are added.
1514 OFPFMF_REMOVED = 1 << 2 # Old matching flows as they are removed.
1515 OFPFMF_MODIFY = 1 << 3 # Matching flows as they are changed.
1516 # What to include in updates.
1517 OFPFMF_INSTRUCTIONS = 1 << 4 # If set, instructions are included.
1518 OFPFMF_NO_ABBREV = 1 << 5 # If set, include own changes in full.
1519 OFPFMF_ONLY_OWN = 1 << 6 # If set, don't include other controllers.
1521 # struct ofp_flow_update_header
1522 OFP_FLOW_UPDATE_HEADER_PACK_STR = '!HH'
1523 OFP_FLOW_UPDATE_HEADER_SIZE = 4
1524 assert (calcsize(OFP_FLOW_UPDATE_HEADER_PACK_STR) ==
1525 OFP_FLOW_UPDATE_HEADER_SIZE)
1527 # enum ofp_flow_update_event
1528 # struct ofp_flow_update_full.
1529 OFPFME_INITIAL = 0 # Flow present when flow monitor created.
1530 OFPFME_ADDED = 1 # Flow was added.
1531 OFPFME_REMOVED = 2 # Flow was removed.
1532 OFPFME_MODIFIED = 3 # Flow instructions were changed.
1533 # struct ofp_flow_update_abbrev.
1534 OFPFME_ABBREV = 4 # Abbreviated reply.
1535 # struct ofp_flow_update_header.
1536 OFPFME_PAUSED = 5 # Monitoring paused (out of buffer space).
1537 OFPFME_RESUMED = 6 # Monitoring resumed.
1539 # struct ofp_flow_update_full
1540 _OFP_FLOW_UPDATE_FULL_0_PACK_STR = 'HHBBHHH4xQ'
1541 OFP_FLOW_UPDATE_FULL_0_PACK_STR = '!' + _OFP_FLOW_UPDATE_FULL_0_PACK_STR
1542 OFP_FLOW_UPDATE_FULL_0_SIZE = 24
1543 OFP_FLOW_UPDATE_FULL_PACK_STR = (OFP_FLOW_UPDATE_FULL_0_PACK_STR +
1544 _OFP_MATCH_PACK_STR)
1545 OFP_FLOW_UPDATE_FULL_SIZE = 32
1546 assert (calcsize(OFP_FLOW_UPDATE_FULL_PACK_STR) ==
1547 OFP_FLOW_UPDATE_FULL_SIZE)
1549 # struct ofp_flow_update_abbrev
1550 OFP_FLOW_UPDATE_ABBREV_PACK_STR = '!HHI'
1551 OFP_FLOW_UPDATE_ABBREV_SIZE = 8
1552 assert (calcsize(OFP_FLOW_UPDATE_ABBREV_PACK_STR) ==
1553 OFP_FLOW_UPDATE_ABBREV_SIZE)
1555 # struct ofp_flow_update_paused
1556 OFP_FLOW_UPDATE_PAUSED_PACK_STR = '!HH4x'
1557 OFP_FLOW_UPDATE_PAUSED_SIZE = 8
1558 assert (calcsize(OFP_FLOW_UPDATE_PAUSED_PACK_STR) ==
1559 OFP_FLOW_UPDATE_PAUSED_SIZE)
1561 # enum ofp_controller_status_prop_type
1562 OFPCSPT_URI = 0 # Connection URI property.
1563 OFPCSPT_EXPERIMENTER = 0xFFFF # Experimenter property.
1565 # struct ofp_controller_status_prop_header
1566 _OFP_CONTROLLER_STATUS_PROP_HEADER_PACK_STR = 'HH'
1567 OFP_CONTROLLER_STATUS_PROP_HEADER_PACK_STR = (
1568 '!' + _OFP_CONTROLLER_STATUS_PROP_HEADER_PACK_STR)
1569 OFP_CONTROLLER_STATUS_PROP_HEADER_SIZE = 4
1570 assert (calcsize(OFP_CONTROLLER_STATUS_PROP_HEADER_PACK_STR) ==
1571 OFP_CONTROLLER_STATUS_PROP_HEADER_SIZE)
1573 # struct ofp_controller_status_prop_uri
1574 OFP_CONTROLLER_STATUS_PROP_URI_PACK_STR = '!HH'
1575 OFP_CONTROLLER_STATUS_PROP_URI_SIZE = 4
1576 assert (calcsize(OFP_CONTROLLER_STATUS_PROP_URI_PACK_STR) ==
1577 OFP_CONTROLLER_STATUS_PROP_URI_SIZE)
1579 # struct ofp_controller_status_prop_experimenter
1580 OFP_CONTROLLER_STATUS_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1581 OFP_CONTROLLER_STATUS_PROP_EXPERIMENTER_SIZE = 12
1582 assert (calcsize(OFP_CONTROLLER_STATUS_PROP_EXPERIMENTER_PACK_STR) ==
1583 OFP_CONTROLLER_STATUS_PROP_EXPERIMENTER_SIZE)
1585 # enum ofp_controller_status_reason
1586 OFPCSR_REQUEST = 0 # Controller requested status.
1587 OFPCSR_CHANNEL_STATUS = 1 # Oper status of channel changed.
1588 OFPCSR_ROLE = 2 # Controller role changed.
1589 OFPCSR_CONTROLLER_ADDED = 3 # New controller added.
1590 OFPCSR_CONTROLLER_REMOVED = 4 # Controller removed from config.
1591 OFPCSR_SHORT_ID = 5 # Controller ID changed.
1592 OFPCSR_EXPERIMENTER = 6 # Experimenter data changed.
1594 # struct ofp_controller_status
1595 OFP_CONTROLLER_STATUS_PACK_STR = '!HHIBB6x'
1596 OFP_CONTROLLER_STATUS_SIZE = 16
1597 assert (calcsize(OFP_CONTROLLER_STATUS_PACK_STR) ==
1598 OFP_CONTROLLER_STATUS_SIZE)
1600 # struct ofp_controller_status_header
1601 OFP_CONTROLLER_STATUS_HEADER_PACK_STR = OFP_CONTROLLER_STATUS_PACK_STR
1602 OFP_CONTROLLER_STATUS_HEADER_SIZE = OFP_CONTROLLER_STATUS_SIZE + OFP_HEADER_SIZE
1604 # enum ofp_control_channel_status
1605 OFPCT_STATUS_UP = 0 # Control channel is operational.
1606 OFPCT_STATUS_DOWN = 1 # Control channel is not operational.
1608 # struct ofp_bundle_features_prop_header
1609 OFP_BUNDLE_FEATURES_PROP_HEADER_PACK_STR = '!HH'
1610 OFP_BUNDLE_FEATURES_PROP_HEADER_SIZE = 4
1611 assert (calcsize(OFP_BUNDLE_FEATURES_PROP_HEADER_PACK_STR) ==
1612 OFP_BUNDLE_FEATURES_PROP_HEADER_SIZE)
1614 # struct ofp_bundle_features_request
1615 OFP_BUNDLE_FEATURES_REQUEST_PACK_STR = '!I4x'
1616 OFP_BUNDLE_FEATURES_REQUEST_SIZE = 8
1617 assert (calcsize(OFP_BUNDLE_FEATURES_REQUEST_PACK_STR) ==
1618 OFP_BUNDLE_FEATURES_REQUEST_SIZE)
1620 # enum ofp_bundle_features_prop_type
1621 OFPTMPBF_TIME_CAPABILITY = 0x1 # Time feature property.
1622 OFPTMPBF_EXPERIMENTER = 0xFFFF # Experimenter property.
1625 _OFP_TIME_PACK_STR = 'QI4x'
1626 OFP_TIME_PACK_STR = '!' + _OFP_TIME_PACK_STR
1628 assert calcsize(OFP_TIME_PACK_STR) == OFP_TIME_SIZE
1630 # struct ofp_bundle_features_prop_time
1631 OFP_BUNDLE_FEATURES_PROP_TIME_0_PACK_STR = '!HH4x'
1632 OFP_BUNDLE_FEATURES_PROP_TIME_0_SIZE = 8
1633 OFP_BUNDLE_FEATURES_PROP_TIME_SIZE = 72
1634 assert (calcsize(OFP_BUNDLE_FEATURES_PROP_TIME_0_PACK_STR) +
1635 OFP_TIME_SIZE * 4 == OFP_BUNDLE_FEATURES_PROP_TIME_SIZE)
1637 # enum ofp_bundle_feature_flags
1638 OFPBF_TIMESTAMP = 1 << 0 # Request includes a timestamp.
1639 OFPBF_TIME_SET_SCHED = 1 << 1 # Request includes the sched_max_future and
1640 # sched_max_past parameters.
1642 # struct ofp_bundle_features
1643 OFP_BUNDLE_FEATURES_PACK_STR = '!H6x'
1644 OFP_BUNDLE_FEATURES_SIZE = 8
1645 assert (calcsize(OFP_BUNDLE_FEATURES_PACK_STR) ==
1646 OFP_BUNDLE_FEATURES_SIZE)
1648 # struct ofp_experimenter_multipart_header
1649 OFP_EXPERIMENTER_MULTIPART_HEADER_PACK_STR = '!II'
1650 OFP_EXPERIMENTER_MULTIPART_HEADER_SIZE = 8
1651 assert (calcsize(OFP_EXPERIMENTER_MULTIPART_HEADER_PACK_STR) ==
1652 OFP_EXPERIMENTER_MULTIPART_HEADER_SIZE)
1654 # struct ofp_experimenter_structure
1655 OFP_EXPERIMENTER_STRUCTURE_PACK_STR = '!II'
1656 OFP_EXPERIMENTER_STRUCTURE_SIZE = 8
1657 assert (calcsize(OFP_EXPERIMENTER_STRUCTURE_PACK_STR) ==
1658 OFP_EXPERIMENTER_STRUCTURE_SIZE)
1660 # struct ofp_error_experimenter_msg
1661 OFP_ERROR_EXPERIMENTER_MSG_PACK_STR = '!HHI'
1662 OFP_ERROR_EXPERIMENTER_MSG_SIZE = 16
1663 assert (calcsize(OFP_ERROR_EXPERIMENTER_MSG_PACK_STR) +
1664 OFP_HEADER_SIZE) == OFP_ERROR_EXPERIMENTER_MSG_SIZE
1666 # enum ofp_controller_role
1667 OFPCR_ROLE_NOCHANGE = 0 # Don't change current role.
1668 OFPCR_ROLE_EQUAL = 1 # Default role, full access.
1669 OFPCR_ROLE_MASTER = 2 # Full access, at most one master.
1670 OFPCR_ROLE_SLAVE = 3 # Read-only access.
1672 # If the switch has not requested an identifier, the short_id should be set to
1674 OFPCID_UNDEFINED = 0
1676 # struct ofp_role_request
1677 OFP_ROLE_REQUEST_PACK_STR = '!IH2xQ'
1678 OFP_ROLE_REQUEST_SIZE = 24
1679 assert (calcsize(OFP_ROLE_REQUEST_PACK_STR) + OFP_HEADER_SIZE ==
1680 OFP_ROLE_REQUEST_SIZE)
1682 # enum ofp_role_prop_type
1683 OFPRPT_EXPERIMENTER = 0xFFFF # Experimenter property.
1685 # struct ofp_role_prop_header
1686 _OFP_ROLE_PROP_HEADER_PACK_STR = 'HH'
1687 OFP_ROLE_PROP_HEADER_PACK_STR = '!' + _OFP_ROLE_PROP_HEADER_PACK_STR
1688 OFP_ROLE_PROP_HEADER_SIZE = 4
1689 assert (calcsize(OFP_ROLE_PROP_HEADER_PACK_STR) ==
1690 OFP_ROLE_PROP_HEADER_SIZE)
1692 # struct ofp_role_prop_experimenter
1693 OFP_ROLE_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1694 OFP_ROLE_PROP_EXPERIMENTER_SIZE = 12
1695 assert (calcsize(OFP_ROLE_PROP_EXPERIMENTER_PACK_STR) ==
1696 OFP_ROLE_PROP_EXPERIMENTER_SIZE)
1698 # enum ofp_controller_role_reason
1699 OFPCRR_MASTER_REQUEST = 0 # Another controller asked to be master.
1700 OFPCRR_CONFIG = 1 # Configuration changed on the switch.
1701 OFPCRR_EXPERIMENTER = 2 # Experimenter data changed.
1703 # struct ofp_role_status
1704 OFP_ROLE_STATUS_PACK_STR = '!IB3xQ'
1705 OFP_ROLE_STATUS_SIZE = 24
1706 assert (calcsize(OFP_ROLE_STATUS_PACK_STR) + OFP_HEADER_SIZE ==
1707 OFP_ROLE_STATUS_SIZE)
1709 # enum ofp_async_config_prop_type
1710 OFPACPT_PACKET_IN_SLAVE = 0 # Packet-in mask for slave.
1711 OFPACPT_PACKET_IN_MASTER = 1 # Packet-in mask for master.
1712 OFPACPT_PORT_STATUS_SLAVE = 2 # Port-status mask for slave.
1713 OFPACPT_PORT_STATUS_MASTER = 3 # Port-status mask for master.
1714 OFPACPT_FLOW_REMOVED_SLAVE = 4 # Flow removed mask for slave.
1715 OFPACPT_FLOW_REMOVED_MASTER = 5 # Flow removed mask for master.
1716 OFPACPT_ROLE_STATUS_SLAVE = 6 # Role status mask for slave.
1717 OFPACPT_ROLE_STATUS_MASTER = 7 # Role status mask for master.
1718 OFPACPT_TABLE_STATUS_SLAVE = 8 # Table status mask for slave.
1719 OFPACPT_TABLE_STATUS_MASTER = 9 # Table status mask for master.
1720 OFPACPT_REQUESTFORWARD_SLAVE = 10 # RequestForward mask for slave.
1721 OFPACPT_REQUESTFORWARD_MASTER = 11 # RequestForward mask for master.
1722 OFPACPT_FLOW_STATS_SLAVE = 12 # Flow stats mask for slave.
1723 OFPACPT_FLOW_STATS_MASTER = 13 # Flow stats mask for master.
1724 OFPACPT_CONT_STATUS_SLAVE = 14 # Controller status mask for slave.
1725 OFPACPT_CONT_STATUS_MASTER = 15 # Controller status mask for master.
1726 OFPACPT_EXPERIMENTER_SLAVE = 0xFFFE # Experimenter for slave.
1727 OFPACPT_EXPERIMENTER_MASTER = 0xFFFF # Experimenter for master.
1729 # struct ofp_async_config_prop_reasons
1730 OFP_ASYNC_CONFIG_PROP_REASONS_PACK_STR = '!HHI'
1731 OFP_ASYNC_CONFIG_PROP_REASONS_SIZE = 8
1732 assert (calcsize(OFP_ASYNC_CONFIG_PROP_REASONS_PACK_STR) ==
1733 OFP_ASYNC_CONFIG_PROP_REASONS_SIZE)
1735 # struct ofp_async_config_prop_experimenter
1736 OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1737 OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_SIZE = 12
1738 assert (calcsize(OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_PACK_STR) ==
1739 OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_SIZE)
1741 # enum ofp_table_reason
1742 OFPTR_VACANCY_DOWN = 3 # Vacancy down threshold event.
1743 OFPTR_VACANCY_UP = 4 # Vacancy up threshold event.
1745 # struct ofp_table_status
1746 _OFP_TABLE_STATUS_0_PACK_STR = 'B7x'
1747 OFP_TABLE_STATUS_0_PACK_STR = '!' + _OFP_TABLE_STATUS_0_PACK_STR
1748 OFP_TABLE_STATUS_0_SIZE = 16
1749 OFP_TABLE_STATUS_PACK_STR = (OFP_TABLE_STATUS_0_PACK_STR +
1750 _OFP_TABLE_DESC_PACK_STR)
1751 OFP_TABLE_STATUS_SIZE = 24
1752 assert (calcsize(OFP_TABLE_STATUS_PACK_STR) + OFP_HEADER_SIZE ==
1753 OFP_TABLE_STATUS_SIZE)
1755 # enum ofp_requestforward_reason
1756 OFPRFR_GROUP_MOD = 0 # Forward group mod requests.
1757 OFPRFR_METER_MOD = 1 # Forward meter mod requests.
1759 # enum ofp_bundle_prop_type
1760 OFPBPT_TIME = 1 # Time property.
1761 OFPBPT_EXPERIMENTER = 0xFFFF # Experimenter property.
1763 # struct ofp_bundle_prop_experimenter
1764 OFP_BUNDLE_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1765 OFP_BUNDLE_PROP_EXPERIMENTER_SIZE = 12
1766 assert (calcsize(OFP_BUNDLE_PROP_EXPERIMENTER_PACK_STR) ==
1767 OFP_BUNDLE_PROP_EXPERIMENTER_SIZE)
1769 # struct ofp_bundle_prop_time
1770 OFP_BUNDLE_PROP_TIME_PACK_STR0 = '!HH4x'
1771 OFP_BUNDLE_PROP_TIME_PACK_STR0_SIZE = 8
1772 assert (calcsize(OFP_BUNDLE_PROP_TIME_PACK_STR0) ==
1773 OFP_BUNDLE_PROP_TIME_PACK_STR0_SIZE)
1774 OFP_BUNDLE_PROP_TIME_PACK_STR = (OFP_BUNDLE_PROP_TIME_PACK_STR0 +
1776 OFP_BUNDLE_PROP_TIME_PACK_STR_SIZE = 24
1777 assert (calcsize(OFP_BUNDLE_PROP_TIME_PACK_STR) ==
1778 OFP_BUNDLE_PROP_TIME_PACK_STR_SIZE)
1780 # enum ofp_bundle_ctrl_type
1781 OFPBCT_OPEN_REQUEST = 0
1782 OFPBCT_OPEN_REPLY = 1
1783 OFPBCT_CLOSE_REQUEST = 2
1784 OFPBCT_CLOSE_REPLY = 3
1785 OFPBCT_COMMIT_REQUEST = 4
1786 OFPBCT_COMMIT_REPLY = 5
1787 OFPBCT_DISCARD_REQUEST = 6
1788 OFPBCT_DISCARD_REPLY = 7
1790 # enum ofp_bundle_flags
1791 OFPBF_ATOMIC = 1 << 0 # Execute atomically.
1792 OFPBF_ORDERED = 1 << 1 # Execute in specified order.
1793 OFPBF_TIME = 1 << 2 # Execute in specified time.
1795 # struct ofp_bundle_ctrl_msg
1796 OFP_BUNDLE_CTRL_MSG_PACK_STR = '!IHH'
1797 OFP_BUNDLE_CTRL_MSG_SIZE = 16
1798 assert (calcsize(OFP_BUNDLE_CTRL_MSG_PACK_STR) + OFP_HEADER_SIZE ==
1799 OFP_BUNDLE_CTRL_MSG_SIZE)
1801 # struct ofp_bundle_add_msg
1802 _OFP_BUNDLE_ADD_MSG_0_PACK_STR = 'I2xH'
1803 OFP_BUNDLE_ADD_MSG_0_PACK_STR = '!' + _OFP_BUNDLE_ADD_MSG_0_PACK_STR
1804 OFP_BUNDLE_ADD_MSG_PACK_STR = (OFP_BUNDLE_ADD_MSG_0_PACK_STR +
1805 _OFP_HEADER_PACK_STR)
1806 OFP_BUNDLE_ADD_MSG_SIZE = 24
1807 assert (calcsize(OFP_BUNDLE_ADD_MSG_PACK_STR) + OFP_HEADER_SIZE ==
1808 OFP_BUNDLE_ADD_MSG_SIZE)
1810 # Note: struct ofp_prop_experimenter is specific to this implementation.
1811 # It does not have a corresponding structure in the specification.
1812 # This structure defines common structure for ofp_*_prop_experimenter.
1813 # struct ofp_prop_experimenter
1814 OFP_PROP_EXPERIMENTER_PACK_STR = '!HHII'
1815 OFP_PROP_EXPERIMENTER_SIZE = 12
1816 assert (calcsize(OFP_PROP_EXPERIMENTER_PACK_STR) ==
1817 OFP_PROP_EXPERIMENTER_SIZE)
1819 # generate utility methods
1820 ofproto_utils.generate(__name__)
1826 MAX_XID = 0xffffffff