1# Copyright (C) 2012,2013 Nippon Telegraph and Telephone Corporation. 2# Copyright (C) 2012 Isaku Yamahata <yamahata at valinux co jp> 3# 4# Licensed under the Apache License, Version 2.0 (the "License"); 5# you may not use this file except in compliance with the License. 6# You may obtain a copy of the License at 7# 8# http://www.apache.org/licenses/LICENSE-2.0 9# 10# Unless required by applicable law or agreed to in writing, software 11# distributed under the License is distributed on an "AS IS" BASIS, 12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 13# implied. 14# See the License for the specific language governing permissions and 15# limitations under the License. 16 17""" 18OpenFlow 1.4 definitions. 19""" 20 21from ryu.lib import type_desc 22from ryu.ofproto import nicira_ext 23from ryu.ofproto import ofproto_utils 24from ryu.ofproto import oxm_fields 25 26from struct import calcsize 27 28 29# enum ofp_port_no 30# Port numbering. Ports are numbered starting from 1. 31OFPP_MAX = 0xffffff00 # Maximum number of physical and logical 32 # switch ports. 33OFPP_IN_PORT = 0xfffffff8 # Send the packet out the input port. This 34 # reserved port must be explicitly used in 35 # order to send back out of the input port. 36OFPP_TABLE = 0xfffffff9 # Submit the packet to the first flow table 37 # NB: This destination port can only be used 38 # in packet-out messages. 39OFPP_NORMAL = 0xfffffffa # Process with normal L2/L3 switching. 40OFPP_FLOOD = 0xfffffffb # All physical ports in VLAN, except input 41 # port and those blocked or link down. 42OFPP_ALL = 0xfffffffc # All physical ports except input port. 43OFPP_CONTROLLER = 0xfffffffd # Send to controller. 44OFPP_LOCAL = 0xfffffffe # Local openflow "port". 45OFPP_ANY = 0xffffffff # Wildcard port used only for flow mod 46 # (delete) and flow stats requests. Selects 47 # all flows regardless of output port 48 # (including flows with no output port). 49 50 51# enum ofp_type 52# Immutable messages. 53OFPT_HELLO = 0 # Symmetric message 54OFPT_ERROR = 1 # Symmetric message 55OFPT_ECHO_REQUEST = 2 # Symmetric message 56OFPT_ECHO_REPLY = 3 # Symmetric message 57OFPT_EXPERIMENTER = 4 # Symmetric message 58# Switch configuration messages. 59OFPT_FEATURES_REQUEST = 5 # Controller/switch message 60OFPT_FEATURES_REPLY = 6 # Controller/switch message 61OFPT_GET_CONFIG_REQUEST = 7 # Controller/switch message 62OFPT_GET_CONFIG_REPLY = 8 # Controller/switch message 63OFPT_SET_CONFIG = 9 # Controller/switch message 64# Asynchronous messages. 65OFPT_PACKET_IN = 10 # Async message 66OFPT_FLOW_REMOVED = 11 # Async message 67OFPT_PORT_STATUS = 12 # Async message 68# Controller command messages. 69OFPT_PACKET_OUT = 13 # Controller/switch message 70OFPT_FLOW_MOD = 14 # Controller/switch message 71OFPT_GROUP_MOD = 15 # Controller/switch message 72OFPT_PORT_MOD = 16 # Controller/switch message 73OFPT_TABLE_MOD = 17 # Controller/switch message 74# Multipart messages. 75OFPT_MULTIPART_REQUEST = 18 # Controller/switch message 76OFPT_MULTIPART_REPLY = 19 # Controller/switch message 77# Barrier messages. 78OFPT_BARRIER_REQUEST = 20 # Controller/switch message 79OFPT_BARRIER_REPLY = 21 # Controller/switch message 80# Controller role change request messages. 81OFPT_ROLE_REQUEST = 24 # Controller/switch message 82OFPT_ROLE_REPLY = 25 # Controller/switch message 83# Asynchronous message configuration. 84OFPT_GET_ASYNC_REQUEST = 26 # Controller/switch message 85OFPT_GET_ASYNC_REPLY = 27 # Controller/switch message 86OFPT_SET_ASYNC = 28 # Controller/switch message 87# Meters and rate limiters configuration messages. 88OFPT_METER_MOD = 29 # Controller/switch message 89# Controller role change event messages. 90OFPT_ROLE_STATUS = 30 # Async message 91# Asynchronous messages. 92OFPT_TABLE_STATUS = 31 # Async message 93# Request forwarding by the switch. 94OFPT_REQUESTFORWARD = 32 # Async message 95# Bundle operations (multiple messages as a single operation). 96OFPT_BUNDLE_CONTROL = 33 97OFPT_BUNDLE_ADD_MESSAGE = 34 98 99 100_OFP_HEADER_PACK_STR = 'BBHI' 101OFP_HEADER_PACK_STR = '!' + _OFP_HEADER_PACK_STR 102OFP_HEADER_SIZE = 8 103 104 105# struct ofp_hello 106OFP_HELLO_HEADER_SIZE = 8 107 108# struct ofp_hello_elem_header 109OFP_HELLO_ELEM_HEADER_PACK_STR = '!HH' 110OFP_HELLO_ELEM_HEADER_SIZE = 4 111assert (calcsize(OFP_HELLO_ELEM_HEADER_PACK_STR) == OFP_HELLO_ELEM_HEADER_SIZE) 112 113# enum ofp_hello_elem_type 114OFPHET_VERSIONBITMAP = 1 115 116# struct ofp_hello_elem_versionbitmap 117OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_PACK_STR = '!HH' 118OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_SIZE = 4 119assert (calcsize(OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_PACK_STR) == 120 OFP_HELLO_ELEM_VERSIONBITMAP_HEADER_SIZE) 121 122 123OFP_DEFAULT_MISS_SEND_LEN = 128 124 125# enum ofp_config_flags 126# Handling of IP fragments. 127OFPC_FRAG_NORMAL = 0 # No special handling for fragments. 128OFPC_FRAG_DROP = 1 << 0 # Drop fragments. 129OFPC_FRAG_REASM = 1 << 1 # Reassemble (only if OFPC_IP_REASM set). 130OFPC_FRAG_MASK = 3 131 132# struct ofp_switch_config 133OFP_SWITCH_CONFIG_PACK_STR = '!HH' 134OFP_SWITCH_CONFIG_SIZE = 12 135assert (calcsize(OFP_SWITCH_CONFIG_PACK_STR) + OFP_HEADER_SIZE == 136 OFP_SWITCH_CONFIG_SIZE) 137 138 139# enum ofp_table 140OFPTT_MAX = 0xfe # Last usable table number. 141OFPTT_ALL = 0xff # Wildcard table used for table config, flow stats 142 # and flow deletes. 143 144 145# enum ofp_table_config 146OFPTC_DEPRECATED_MASK = 3 # Deprecated bits 147OFPTC_EVICTION = 1 << 2 # Authorise table to evict flows. 148OFPTC_VACANCY_EVENTS = 1 << 3 # Enable vacancy events. 149 150# enum ofp_table_mod_prop_type 151OFPTMPT_EVICTION = 0x2 # Eviction property. 152OFPTMPT_VACANCY = 0x3 # Vacancy property. 153OFPTMPT_EXPERIMENTER = 0xFFFF # Experimenter property. 154 155# enum ofp_table_mod_prop_eviction_flag 156OFPTMPEF_OTHER = 1 << 0 # Using other factors. 157OFPTMPEF_IMPORTANCE = 1 << 1 # Using flow entry importance. 158OFPTMPEF_LIFETIME = 1 << 2 # Using flow entry lifetime. 159 160# struct ofp_table_mod_prop_eviction 161OFP_TABLE_MOD_PROP_EVICTION_PACK_STR = '!HHI' 162OFP_TABLE_MOD_PROP_EVICTION_SIZE = 8 163assert(calcsize(OFP_TABLE_MOD_PROP_EVICTION_PACK_STR) == 164 OFP_TABLE_MOD_PROP_EVICTION_SIZE) 165 166# struct ofp_table_mod_prop_vacancy 167OFP_TABLE_MOD_PROP_VACANCY_PACK_STR = '!HHBBBx' 168OFP_TABLE_MOD_PROP_VACANCY_SIZE = 8 169assert(calcsize(OFP_TABLE_MOD_PROP_VACANCY_PACK_STR) == 170 OFP_TABLE_MOD_PROP_VACANCY_SIZE) 171 172# struct ofp_table_mod_prop_experimenter 173OFP_TABLE_MOD_PROP_EXPERIMENTER_PACK_STR = '!HHII' 174OFP_TABLE_MOD_PROP_EXPERIMENTER_SIZE = 12 175assert(calcsize(OFP_TABLE_MOD_PROP_EXPERIMENTER_PACK_STR) == 176 OFP_TABLE_MOD_PROP_EXPERIMENTER_SIZE) 177 178# struct ofp_table_mod 179OFP_TABLE_MOD_PACK_STR = '!B3xI' 180OFP_TABLE_MOD_SIZE = 16 181assert (calcsize(OFP_TABLE_MOD_PACK_STR) + OFP_HEADER_SIZE == 182 OFP_TABLE_MOD_SIZE) 183 184# enum ofp_capabilities 185OFPC_FLOW_STATS = 1 << 0 # Flow statistics. 186OFPC_TABLE_STATS = 1 << 1 # Table statistics. 187OFPC_PORT_STATS = 1 << 2 # Port statistics. 188OFPC_GROUP_STATS = 1 << 3 # Group statistics. 189OFPC_IP_REASM = 1 << 5 # Can reassemble IP fragments. 190OFPC_QUEUE_STATS = 1 << 6 # Queue statistics. 191OFPC_PORT_BLOCKED = 1 << 8 # Switch will block looping ports. 192 193# enum ofp_port_config 194OFPPC_PORT_DOWN = 1 << 0 # Port is administratively down. 195OFPPC_NO_RECV = 1 << 2 # Drop all packets recieved by port. 196OFPPC_NO_FWD = 1 << 5 # Drop packets forwarded to port. 197OFPPC_NO_PACKET_IN = 1 << 6 # Do not send packet-in msgs for port. 198 199# enum ofp_port_state 200OFPPS_LINK_DOWN = 1 << 0 # No physical link present. 201OFPPS_BLOCKED = 1 << 1 # Port is blocked 202OFPPS_LIVE = 1 << 2 # Live for Fast Failover Group. 203 204# enum ofp_port_features 205OFPPF_10MB_HD = 1 << 0 # 10 Mb half-duplex rate support. 206OFPPF_10MB_FD = 1 << 1 # 10 Mb full-duplex rate support. 207OFPPF_100MB_HD = 1 << 2 # 100 Mb half-duplex rate support. 208OFPPF_100MB_FD = 1 << 3 # 100 Mb full-duplex rate support. 209OFPPF_1GB_HD = 1 << 4 # 1 Gb half-duplex rate support. 210OFPPF_1GB_FD = 1 << 5 # 1 Gb full-duplex rate support. 211OFPPF_10GB_FD = 1 << 6 # 10 Gb full-duplex rate support. 212OFPPF_40GB_FD = 1 << 7 # 40 Gb full-duplex rate support. 213OFPPF_100GB_FD = 1 << 8 # 100 Gb full-duplex rate support. 214OFPPF_1TB_FD = 1 << 9 # 1 Tb full-duplex rate support. 215OFPPF_OTHER = 1 << 10 # Other rate, not in the list. 216OFPPF_COPPER = 1 << 11 # Copper medium. 217OFPPF_FIBER = 1 << 12 # Fiber medium. 218OFPPF_AUTONEG = 1 << 13 # Auto-negotiation. 219OFPPF_PAUSE = 1 << 14 # Pause. 220OFPPF_PAUSE_ASYM = 1 << 15 # Asymmetric pause. 221 222# enum ofp_port_desc_prop_type 223OFPPDPT_ETHERNET = 0 # Ethernet property. 224OFPPDPT_OPTICAL = 1 # Optical property. 225OFPPDPT_EXPERIMENTER = 0xFFFF # Experimenter property. 226 227# struct ofp_port_desc_prop_ethernet 228OFP_PORT_DESC_PROP_ETHERNET_PACK_STR = '!HH4xIIIIII' 229OFP_PORT_DESC_PROP_ETHERNET_SIZE = 32 230assert (calcsize(OFP_PORT_DESC_PROP_ETHERNET_PACK_STR) == 231 OFP_PORT_DESC_PROP_ETHERNET_SIZE) 232 233# enum ofp_optical_port_features 234OFPOPF_RX_TUNE = 1 << 0 # Receiver is tunable 235OFPOPF_TX_TUNE = 1 << 1 # Transmit is tunable 236OFPOPF_TX_PWR = 1 << 2 # Power is configurable 237OFPOPF_USE_FREQ = 1 << 3 # Use Frequency, not wavelength 238 239# struct ofp_port_desc_prop_optical 240OFP_PORT_DESC_PROP_OPTICAL_PACK_STR = '!HH4xIIIIIIIHH' 241OFP_PORT_DESC_PROP_OPTICAL_SIZE = 40 242assert (calcsize(OFP_PORT_DESC_PROP_OPTICAL_PACK_STR) == 243 OFP_PORT_DESC_PROP_OPTICAL_SIZE) 244 245# struct ofp_port_desc_prop_experimenter 246OFP_PORT_DESC_PROP_EXPERIMENTER_PACK_STR = '!HHII' 247OFP_PORT_DESC_PROP_EXPERIMENTER_SIZE = 12 248assert (calcsize(OFP_PORT_DESC_PROP_EXPERIMENTER_PACK_STR) == 249 OFP_PORT_DESC_PROP_EXPERIMENTER_SIZE) 250 251# struct ofp_port 252OFP_MAX_PORT_NAME_LEN = 16 253OFP_ETH_ALEN = 6 254OFP_ETH_ALEN_STR = str(OFP_ETH_ALEN) 255_OFP_PORT_PACK_STR = 'IH2x' + OFP_ETH_ALEN_STR + 's' + '2x' + \ 256 str(OFP_MAX_PORT_NAME_LEN) + 's' + 'II' 257OFP_PORT_PACK_STR = '!' + _OFP_PORT_PACK_STR 258OFP_PORT_SIZE = 40 259assert (calcsize(OFP_PORT_PACK_STR) == OFP_PORT_SIZE) 260 261# struct ofp_switch_features 262OFP_SWITCH_FEATURES_PACK_STR = '!QIBB2xII' 263OFP_SWITCH_FEATURES_SIZE = 32 264assert (calcsize(OFP_SWITCH_FEATURES_PACK_STR) + OFP_HEADER_SIZE == 265 OFP_SWITCH_FEATURES_SIZE) 266 267# enum ofp_port_reason 268OFPPR_ADD = 0 # The port was added. 269OFPPR_DELETE = 1 # The port was removed. 270OFPPR_MODIFY = 2 # Some attribute of the port has changed. 271 272# struct ofp_port_status 273OFP_PORT_STATUS_PACK_STR = '!B7x' + _OFP_PORT_PACK_STR 274OFP_PORT_STATUS_SIZE = 56 275assert (calcsize(OFP_PORT_STATUS_PACK_STR) + OFP_HEADER_SIZE == 276 OFP_PORT_STATUS_SIZE) 277 278# enum ofp_port_mod_prop_type 279OFPPMPT_ETHERNET = 0 # Ethernet property. 280OFPPMPT_OPTICAL = 1 # Optical property. 281OFPPMPT_EXPERIMENTER = 0xFFFF # Experimenter property. 282 283# struct ofp_port_mod_prop_ethernet 284OFP_PORT_MOD_PROP_ETHERNET_PACK_STR = '!HHI' 285OFP_PORT_MOD_PROP_ETHERNET_SIZE = 8 286assert (calcsize(OFP_PORT_MOD_PROP_ETHERNET_PACK_STR) == 287 OFP_PORT_MOD_PROP_ETHERNET_SIZE) 288 289# struct ofp_port_mod_prop_optical 290OFP_PORT_MOD_PROP_OPTICAL_PACK_STR = '!HHIIIII' 291OFP_PORT_MOD_PROP_OPTICAL_SIZE = 24 292assert (calcsize(OFP_PORT_MOD_PROP_OPTICAL_PACK_STR) == 293 OFP_PORT_MOD_PROP_OPTICAL_SIZE) 294 295# struct ofp_port_mod_prop_experimenter 296OFP_PORT_MOD_PROP_EXPERIMENTER_PACK_STR = '!HHII' 297OFP_PORT_MOD_PROP_EXPERIMENTER_SIZE = 12 298assert (calcsize(OFP_PORT_MOD_PROP_EXPERIMENTER_PACK_STR) == 299 OFP_PORT_MOD_PROP_EXPERIMENTER_SIZE) 300 301# struct ofp_port_mod 302OFP_PORT_MOD_PACK_STR = '!I4x' + OFP_ETH_ALEN_STR + 's2xII' 303OFP_PORT_MOD_SIZE = 32 304assert (calcsize(OFP_PORT_MOD_PACK_STR) + OFP_HEADER_SIZE == 305 OFP_PORT_MOD_SIZE) 306 307 308# enum ofp_match_type 309OFPMT_STANDARD = 0 # Deprecated 310OFPMT_OXM = 1 # OpenFlow Extensible Match 311 312# struct ofp_match 313_OFP_MATCH_PACK_STR = 'HH4x' 314OFP_MATCH_PACK_STR = '!' + _OFP_MATCH_PACK_STR 315OFP_MATCH_SIZE = 8 316assert calcsize(OFP_MATCH_PACK_STR) == OFP_MATCH_SIZE 317 318# enum ofp_oxm_class 319OFPXMC_NXM_0 = 0x0000 # Backward compatibility with NXM 320OFPXMC_NXM_1 = 0x0001 # Backward compatibility with NXM 321OFPXMC_OPENFLOW_BASIC = 0x8000 # Basic class for OpenFlow 322OFPXMC_EXPERIMENTER = 0xFFFF # Experimenter class 323 324# enum ofp_vlan_id 325OFPVID_PRESENT = 0x1000 # bit that indicate that a VLAN id is set. 326OFPVID_NONE = 0X0000 # No VLAN id was set. 327 328 329def _oxm_tlv_header(class_, field, hasmask, length): 330 return (class_ << 16) | (field << 9) | (hasmask << 8) | length 331 332 333def oxm_tlv_header(field, length): 334 return _oxm_tlv_header(OFPXMC_OPENFLOW_BASIC, field, 0, length) 335 336 337def oxm_tlv_header_w(field, length): 338 return _oxm_tlv_header(OFPXMC_OPENFLOW_BASIC, field, 1, length * 2) 339 340 341def oxm_tlv_header_extract_hasmask(header): 342 return (header >> 8) & 1 343 344 345def oxm_tlv_header_extract_length(header): 346 if oxm_tlv_header_extract_hasmask(header): 347 length = (header & 0xff) // 2 348 else: 349 length = header & 0xff 350 return length 351 352 353oxm_types = [ 354 oxm_fields.OpenFlowBasic('in_port', 0, type_desc.Int4), 355 oxm_fields.OpenFlowBasic('in_phy_port', 1, type_desc.Int4), 356 oxm_fields.OpenFlowBasic('metadata', 2, type_desc.Int8), 357 oxm_fields.OpenFlowBasic('eth_dst', 3, type_desc.MacAddr), 358 oxm_fields.OpenFlowBasic('eth_src', 4, type_desc.MacAddr), 359 oxm_fields.OpenFlowBasic('eth_type', 5, type_desc.Int2), 360 oxm_fields.OpenFlowBasic('vlan_vid', 6, type_desc.Int2), 361 oxm_fields.OpenFlowBasic('vlan_pcp', 7, type_desc.Int1), 362 oxm_fields.OpenFlowBasic('ip_dscp', 8, type_desc.Int1), 363 oxm_fields.OpenFlowBasic('ip_ecn', 9, type_desc.Int1), 364 oxm_fields.OpenFlowBasic('ip_proto', 10, type_desc.Int1), 365 oxm_fields.OpenFlowBasic('ipv4_src', 11, type_desc.IPv4Addr), 366 oxm_fields.OpenFlowBasic('ipv4_dst', 12, type_desc.IPv4Addr), 367 oxm_fields.OpenFlowBasic('tcp_src', 13, type_desc.Int2), 368 oxm_fields.OpenFlowBasic('tcp_dst', 14, type_desc.Int2), 369 oxm_fields.OpenFlowBasic('udp_src', 15, type_desc.Int2), 370 oxm_fields.OpenFlowBasic('udp_dst', 16, type_desc.Int2), 371 oxm_fields.OpenFlowBasic('sctp_src', 17, type_desc.Int2), 372 oxm_fields.OpenFlowBasic('sctp_dst', 18, type_desc.Int2), 373 oxm_fields.OpenFlowBasic('icmpv4_type', 19, type_desc.Int1), 374 oxm_fields.OpenFlowBasic('icmpv4_code', 20, type_desc.Int1), 375 oxm_fields.OpenFlowBasic('arp_op', 21, type_desc.Int2), 376 oxm_fields.OpenFlowBasic('arp_spa', 22, type_desc.IPv4Addr), 377 oxm_fields.OpenFlowBasic('arp_tpa', 23, type_desc.IPv4Addr), 378 oxm_fields.OpenFlowBasic('arp_sha', 24, type_desc.MacAddr), 379 oxm_fields.OpenFlowBasic('arp_tha', 25, type_desc.MacAddr), 380 oxm_fields.OpenFlowBasic('ipv6_src', 26, type_desc.IPv6Addr), 381 oxm_fields.OpenFlowBasic('ipv6_dst', 27, type_desc.IPv6Addr), 382 oxm_fields.OpenFlowBasic('ipv6_flabel', 28, type_desc.Int4), 383 oxm_fields.OpenFlowBasic('icmpv6_type', 29, type_desc.Int1), 384 oxm_fields.OpenFlowBasic('icmpv6_code', 30, type_desc.Int1), 385 oxm_fields.OpenFlowBasic('ipv6_nd_target', 31, type_desc.IPv6Addr), 386 oxm_fields.OpenFlowBasic('ipv6_nd_sll', 32, type_desc.MacAddr), 387 oxm_fields.OpenFlowBasic('ipv6_nd_tll', 33, type_desc.MacAddr), 388 oxm_fields.OpenFlowBasic('mpls_label', 34, type_desc.Int4), 389 oxm_fields.OpenFlowBasic('mpls_tc', 35, type_desc.Int1), 390 oxm_fields.OpenFlowBasic('mpls_bos', 36, type_desc.Int1), 391 oxm_fields.OpenFlowBasic('pbb_isid', 37, type_desc.Int3), 392 oxm_fields.OpenFlowBasic('tunnel_id', 38, type_desc.Int8), 393 oxm_fields.OpenFlowBasic('ipv6_exthdr', 39, type_desc.Int2), 394 oxm_fields.OpenFlowBasic('pbb_uca', 41, type_desc.Int1), 395 # EXT-109 TCP flags match field Extension 396 oxm_fields.ONFExperimenter('tcp_flags', 42, type_desc.Int2), 397 # EXT-233 Output match Extension 398 # NOTE(yamamoto): The spec says uint64_t but I assume it's an error. 399 oxm_fields.ONFExperimenter('actset_output', 43, type_desc.Int4), 400] + nicira_ext.oxm_types 401 402oxm_fields.generate(__name__) 403 404 405# enum ofp_action_type 406OFPAT_OUTPUT = 0 # Output to switch port. 407OFPAT_COPY_TTL_OUT = 11 # Copy TTL "outwards" -- from 408 # next-to-outermost to outermost 409OFPAT_COPY_TTL_IN = 12 # Copy TTL "inwards" -- from outermost to 410 # next-to-outermost 411OFPAT_SET_MPLS_TTL = 15 # MPLS TTL. 412OFPAT_DEC_MPLS_TTL = 16 # Decrement MPLS TTL 413OFPAT_PUSH_VLAN = 17 # Push a new VLAN tag 414OFPAT_POP_VLAN = 18 # Pop the outer VLAN tag 415OFPAT_PUSH_MPLS = 19 # Push a new MPLS tag 416OFPAT_POP_MPLS = 20 # Pop the outer MPLS tag 417OFPAT_SET_QUEUE = 21 # Set queue id when outputting to a port 418OFPAT_GROUP = 22 # Apply group 419OFPAT_SET_NW_TTL = 23 # IP TTL. 420OFPAT_DEC_NW_TTL = 24 # Decrement IP TTL. 421OFPAT_SET_FIELD = 25 # Set a header field using OXM TLV format. 422OFPAT_PUSH_PBB = 26 # Push a new PBB service tag (I-TAG) 423OFPAT_POP_PBB = 27 # Pop the outer PBB service tag (I-TAG) 424OFPAT_EXPERIMENTER = 0xffff 425 426 427# struct ofp_action_header 428OFP_ACTION_HEADER_PACK_STR = '!HH4x' 429OFP_ACTION_HEADER_SIZE = 8 430assert calcsize(OFP_ACTION_HEADER_PACK_STR) == OFP_ACTION_HEADER_SIZE 431 432# enum ofp_controller_max_len 433OFPCML_MAX = 0xffe5 # maximum max_len value which can be used to 434 # request a specific byte length. 435OFPCML_NO_BUFFER = 0xffff # indicates that no buffering should be 436 # applied and the whole packet is to be 437 # sent to the controller. 438 439# struct ofp_action_output 440OFP_ACTION_OUTPUT_PACK_STR = '!HHIH6x' 441OFP_ACTION_OUTPUT_SIZE = 16 442assert calcsize(OFP_ACTION_OUTPUT_PACK_STR) == OFP_ACTION_OUTPUT_SIZE 443 444# struct ofp_action_generic 445OFP_ACTION_GENERIC_PACK_STR = '!HH4x' 446OFP_ACTION_GENERIC_SIZE = 8 447assert (calcsize(OFP_ACTION_GENERIC_PACK_STR) == OFP_ACTION_GENERIC_SIZE) 448 449# struct ofp_action_mpls_ttl 450OFP_ACTION_MPLS_TTL_PACK_STR = '!HHB3x' 451OFP_ACTION_MPLS_TTL_SIZE = 8 452assert calcsize(OFP_ACTION_MPLS_TTL_PACK_STR) == OFP_ACTION_MPLS_TTL_SIZE 453 454# struct ofp_action_push 455OFP_ACTION_PUSH_PACK_STR = '!HHH2x' 456OFP_ACTION_PUSH_SIZE = 8 457assert calcsize(OFP_ACTION_PUSH_PACK_STR) == OFP_ACTION_PUSH_SIZE 458 459# struct ofp_action_pop_mpls 460OFP_ACTION_POP_MPLS_PACK_STR = '!HHH2x' 461OFP_ACTION_POP_MPLS_SIZE = 8 462assert calcsize(OFP_ACTION_POP_MPLS_PACK_STR) == OFP_ACTION_POP_MPLS_SIZE 463 464# struct ofp_action_set_queue 465OFP_ACTION_SET_QUEUE_PACK_STR = '!HHI' 466OFP_ACTION_SET_QUEUE_SIZE = 8 467assert calcsize(OFP_ACTION_SET_QUEUE_PACK_STR) == OFP_ACTION_SET_QUEUE_SIZE 468 469# struct ofp_action_group 470OFP_ACTION_GROUP_PACK_STR = '!HHI' 471OFP_ACTION_GROUP_SIZE = 8 472assert calcsize(OFP_ACTION_GROUP_PACK_STR) == OFP_ACTION_GROUP_SIZE 473 474# struct ofp_action_nw_ttl 475OFP_ACTION_NW_TTL_PACK_STR = '!HHB3x' 476OFP_ACTION_NW_TTL_SIZE = 8 477assert calcsize(OFP_ACTION_NW_TTL_PACK_STR) == OFP_ACTION_NW_TTL_SIZE 478 479# struct ofp_action_set_field 480OFP_ACTION_SET_FIELD_PACK_STR = '!HH4x' 481OFP_ACTION_SET_FIELD_SIZE = 8 482assert calcsize(OFP_ACTION_SET_FIELD_PACK_STR) == OFP_ACTION_SET_FIELD_SIZE 483 484# struct ofp_action_experimenter_header 485OFP_ACTION_EXPERIMENTER_HEADER_PACK_STR = '!HHI' 486OFP_ACTION_EXPERIMENTER_HEADER_SIZE = 8 487assert (calcsize(OFP_ACTION_EXPERIMENTER_HEADER_PACK_STR) == 488 OFP_ACTION_EXPERIMENTER_HEADER_SIZE) 489 490# enum ofp_instruction_type 491OFPIT_GOTO_TABLE = 1 # Setup the next table in the lookup pipeline. 492OFPIT_WRITE_METADATA = 2 # Setup the metadata field for use later in 493 # pipeline. 494OFPIT_WRITE_ACTIONS = 3 # Write the action(s) onto the datapath 495 # action set 496OFPIT_APPLY_ACTIONS = 4 # Applies the action(s) immediately 497OFPIT_CLEAR_ACTIONS = 5 # Clears all actions from the datapath action 498 # set 499OFPIT_METER = 6 # Apply meter (rate limiter) 500OFPIT_EXPERIMENTER = 0xFFFF # Experimenter instruction 501 502# struct ofp_instruction_goto_table 503OFP_INSTRUCTION_GOTO_TABLE_PACK_STR = '!HHB3x' 504OFP_INSTRUCTION_GOTO_TABLE_SIZE = 8 505assert (calcsize(OFP_INSTRUCTION_GOTO_TABLE_PACK_STR) == 506 OFP_INSTRUCTION_GOTO_TABLE_SIZE) 507 508# struct ofp_instruction_write_metadata 509OFP_INSTRUCTION_WRITE_METADATA_PACK_STR = '!HH4xQQ' 510OFP_INSTRUCTION_WRITE_METADATA_SIZE = 24 511assert (calcsize(OFP_INSTRUCTION_WRITE_METADATA_PACK_STR) == 512 OFP_INSTRUCTION_WRITE_METADATA_SIZE) 513 514# struct ofp_instruction_actions 515OFP_INSTRUCTION_ACTIONS_PACK_STR = '!HH4x' 516OFP_INSTRUCTION_ACTIONS_SIZE = 8 517assert (calcsize(OFP_INSTRUCTION_ACTIONS_PACK_STR) == 518 OFP_INSTRUCTION_ACTIONS_SIZE) 519 520# struct ofp_instruction_meter 521OFP_INSTRUCTION_METER_PACK_STR = '!HHI' 522OFP_INSTRUCTION_METER_SIZE = 8 523assert calcsize(OFP_INSTRUCTION_METER_PACK_STR) == OFP_INSTRUCTION_METER_SIZE 524 525# struct ofp_instruction_experimenter_header 526OFP_INSTRUCTION_EXPERIMENTER_HEADER_PACK_STR = '!HHI' 527OFP_INSTRUCTION_EXPERIMENTER_HEADER_SIZE = 8 528assert (calcsize(OFP_INSTRUCTION_EXPERIMENTER_HEADER_PACK_STR) == 529 OFP_INSTRUCTION_EXPERIMENTER_HEADER_SIZE) 530 531# enum ofp_flow_mod_command 532OFPFC_ADD = 0 # New flow. 533OFPFC_MODIFY = 1 # Modify all matching flows. 534OFPFC_MODIFY_STRICT = 2 # Modify entry strictly matching wildcards 535OFPFC_DELETE = 3 # Delete all matching flows. 536OFPFC_DELETE_STRICT = 4 # Strictly match wildcards and priority. 537 538# Value used in "idle_timeout" and "hard_timeout" to indicate that the 539# entry is permanent. */ 540OFP_FLOW_PERMANENT = 0 541 542# By default, choose a priority in the middle. 543OFP_DEFAULT_PRIORITY = 0x8000 544 545# enum ofp_flow_mod_flags 546OFPFF_SEND_FLOW_REM = 1 << 0 # Send flow removed message when flow 547 # expires or is deleted. 548OFPFF_CHECK_OVERLAP = 1 << 1 # Check for overlapping entries first. 549OFPFF_RESET_COUNTS = 1 << 2 # Reset flow packet and byte counts. 550OFPFF_NO_PKT_COUNTS = 1 << 3 # Don't keep track of packet count. 551OFPFF_NO_BYT_COUNTS = 1 << 4 # Don't keep track of byte count. 552 553# struct ofp_flow_mod 554_OFP_FLOW_MOD_PACK_STR0 = 'QQBBHHHIIIHH' 555OFP_FLOW_MOD_PACK_STR = '!' + _OFP_FLOW_MOD_PACK_STR0 + _OFP_MATCH_PACK_STR 556OFP_FLOW_MOD_PACK_STR0 = '!' + _OFP_FLOW_MOD_PACK_STR0 557OFP_FLOW_MOD_SIZE = 56 558assert (calcsize(OFP_FLOW_MOD_PACK_STR) + OFP_HEADER_SIZE == 559 OFP_FLOW_MOD_SIZE) 560 561# enum ofp_group 562OFPG_MAX = 0xffffff00 # Last usable group number. 563OFPG_ALL = 0xfffffffc # Represents all groups for group delete commands. 564OFPG_ANY = 0xffffffff # Wildcard group used only for flow stats requests. 565 # Selects all flows regardless of group 566 # (including flows with no group). 567 568# enum ofp_group_mod_command 569OFPGC_ADD = 0 # New group. 570OFPGC_MODIFY = 1 # Modify all matching groups. 571OFPGC_DELETE = 2 # Delete all matching groups. 572 573# struct ofp_bucket 574OFP_BUCKET_PACK_STR = '!HHII4x' 575OFP_BUCKET_SIZE = 16 576assert calcsize(OFP_BUCKET_PACK_STR) == OFP_BUCKET_SIZE 577 578# struct ofp_group_mod 579OFP_GROUP_MOD_PACK_STR = '!HBxI' 580OFP_GROUP_MOD_SIZE = 16 581assert (calcsize(OFP_GROUP_MOD_PACK_STR) + OFP_HEADER_SIZE == 582 OFP_GROUP_MOD_SIZE) 583 584# enum ofp_group_type 585OFPGT_ALL = 0 # All (multicast/broadcast) group. 586OFPGT_SELECT = 1 # Select group. 587OFPGT_INDIRECT = 2 # Indirect group. 588OFPGT_FF = 3 # Fast failover group. 589 590 591OFP_NO_BUFFER = 0xffffffff # Special buffer-id to indicate 'no buffer' 592 593# struct ofp_packet_out 594OFP_PACKET_OUT_PACK_STR = '!IIH6x' 595OFP_PACKET_OUT_SIZE = 24 596assert (calcsize(OFP_PACKET_OUT_PACK_STR) + OFP_HEADER_SIZE == 597 OFP_PACKET_OUT_SIZE) 598 599# enum ofp_packet_in_reason 600OFPR_TABLE_MISS = 0 # No matching flow (table-miss flow entry). 601OFPR_APPLY_ACTION = 1 # Output to controller in apply-actions. 602OFPR_INVALID_TTL = 2 # Packet has invalid TTL. 603OFPR_ACTION_SET = 3 # Output to controller in action set. 604OFPR_GROUP = 4 # Output to controller in group bucket. 605OFPR_PACKET_OUT = 5 # Output to controller in packet-out. 606 607# struct ofp_packet_in 608OFP_PACKET_IN_PACK_STR = '!IHBBQ' 609OFP_PACKET_IN_SIZE = 32 610assert (calcsize(OFP_PACKET_IN_PACK_STR) + OFP_MATCH_SIZE + OFP_HEADER_SIZE == 611 OFP_PACKET_IN_SIZE) 612 613# enum ofp_flow_removed_reason 614OFPRR_IDLE_TIMEOUT = 0 # Flow idle time exceeded idle_timeout. 615OFPRR_HARD_TIMEOUT = 1 # Time exceeded hard_timeout. 616OFPRR_DELETE = 2 # Evicted by a DELETE flow mod. 617OFPRR_GROUP_DELETE = 3 # Group was removed. 618OFPRR_METER_DELETE = 4 # Meter was removed. 619OFPRR_EVICTION = 5 # Switch eviction to free resources. 620 621# struct ofp_port_status 622OFP_PORT_STATUS_PACK_STR = '!B7x' + _OFP_PORT_PACK_STR 623OFP_PORT_STATUS_DESC_OFFSET = OFP_HEADER_SIZE + 8 624OFP_PORT_STATUS_SIZE = 56 625assert (calcsize(OFP_PORT_STATUS_PACK_STR) + OFP_HEADER_SIZE == 626 OFP_PORT_STATUS_SIZE) 627 628# struct ofp_flow_removed 629_OFP_FLOW_REMOVED_PACK_STR0 = 'QHBBIIHHQQ' 630OFP_FLOW_REMOVED_PACK_STR = '!' + _OFP_FLOW_REMOVED_PACK_STR0 + \ 631 _OFP_MATCH_PACK_STR 632OFP_FLOW_REMOVED_PACK_STR0 = '!' + _OFP_FLOW_REMOVED_PACK_STR0 633OFP_FLOW_REMOVED_SIZE = 56 634assert (calcsize(OFP_FLOW_REMOVED_PACK_STR) + OFP_HEADER_SIZE == 635 OFP_FLOW_REMOVED_SIZE) 636 637# enum ofp_meter 638OFPM_MAX = 0xffff0000 639OFPM_SLOWPATH = 0xfffffffd # Meter for slow datapath, if any. 640OFPM_CONTROLLER = 0xfffffffe # Meter for controller connection. 641OFPM_ALL = 0xffffffff # Represents all meters for stat requests 642 # commands. 643 644# enum ofp_meter_band_type 645OFPMBT_DROP = 1 # Drop packet. 646OFPMBT_DSCP_REMARK = 2 # Remark DSCP in the IP header. 647OFPMBT_EXPERIMENTER = 0xFFFF # Experimenter meter band. 648 649# struct ofp_meter_band_drop 650OFP_METER_BAND_DROP_PACK_STR = '!HHII4x' 651OFP_METER_BAND_DROP_SIZE = 16 652assert (calcsize(OFP_METER_BAND_DROP_PACK_STR) == 653 OFP_METER_BAND_DROP_SIZE) 654 655# struct ofp_meter_band_dscp_remark 656OFP_METER_BAND_DSCP_REMARK_PACK_STR = '!HHIIB3x' 657OFP_METER_BAND_DSCP_REMARK_SIZE = 16 658assert (calcsize(OFP_METER_BAND_DSCP_REMARK_PACK_STR) == 659 OFP_METER_BAND_DSCP_REMARK_SIZE) 660 661# struct ofp_meter_band_experimenter 662OFP_METER_BAND_EXPERIMENTER_PACK_STR = '!HHIII' 663OFP_METER_BAND_EXPERIMENTER_SIZE = 16 664assert (calcsize(OFP_METER_BAND_EXPERIMENTER_PACK_STR) == 665 OFP_METER_BAND_EXPERIMENTER_SIZE) 666 667# enum ofp_meter_mod_command 668OFPMC_ADD = 0 # New meter. 669OFPMC_MODIFY = 1 # Modify specified meter. 670OFPMC_DELETE = 2 # Delete specified meter. 671 672# enum ofp_meter_flags 673OFPMF_KBPS = 1 << 0 # Rate value in kb/s (kilo-bit per second). 674OFPMF_PKTPS = 1 << 1 # Rate value in packet/sec. 675OFPMF_BURST = 1 << 2 # Do burst size. 676OFPMF_STATS = 1 << 3 # Collect statistics. 677 678# struct ofp_meter_band_header 679OFP_METER_BAND_HEADER_PACK_STR = '!HHII' 680OFP_METER_BAND_HEADER_SIZE = 12 681assert (calcsize(OFP_METER_BAND_HEADER_PACK_STR) == 682 OFP_METER_BAND_HEADER_SIZE) 683 684# struct ofp_meter_mod 685OFP_METER_MOD_PACK_STR = '!HHI' 686OFP_METER_MOD_SIZE = 16 687assert (calcsize(OFP_METER_MOD_PACK_STR) + OFP_HEADER_SIZE == 688 OFP_METER_MOD_SIZE) 689 690 691# enum ofp_error_type 692OFPET_HELLO_FAILED = 0 # Hello protocol failed. 693OFPET_BAD_REQUEST = 1 # Request was not understood. 694OFPET_BAD_ACTION = 2 # Error in action description. 695OFPET_BAD_INSTRUCTION = 3 # Error in instruction list. 696OFPET_BAD_MATCH = 4 # Error in match. 697OFPET_FLOW_MOD_FAILED = 5 # Problem modifying flow entry. 698OFPET_GROUP_MOD_FAILED = 6 # Problem modifying group entry. 699OFPET_PORT_MOD_FAILED = 7 # OFPT_PORT_MOD failed. 700OFPET_TABLE_MOD_FAILED = 8 # Table mod request failed. 701OFPET_QUEUE_OP_FAILED = 9 # Queue operation failed. 702OFPET_SWITCH_CONFIG_FAILED = 10 # Switch config request failed. 703OFPET_ROLE_REQUEST_FAILED = 11 # Controller Role request failed. 704OFPET_METER_MOD_FAILED = 12 # Error in meter. 705OFPET_TABLE_FEATURES_FAILED = 13 # Setting table features failed. 706OFPET_BAD_PROPERTY = 14 # Some property is invalid. 707OFPET_ASYNC_CONFIG_FAILED = 15 # Asynchronous config request failed. 708OFPET_FLOW_MONITOR_FAILED = 16 # Setting flow monitor failed. 709OFPET_BUNDLE_FAILED = 17 # Bundle operation failed. 710OFPET_EXPERIMENTER = 0xffff # Experimenter error messages. 711 712# enum ofp_hello_failed_code 713OFPHFC_INCOMPATIBLE = 0 # No compatible version. 714OFPHFC_EPERM = 1 # Permissions error. 715 716# enum ofp_bad_request_code 717OFPBRC_BAD_VERSION = 0 # ofp_header.version not supported. 718OFPBRC_BAD_TYPE = 1 # ofp_header.type not supported. 719OFPBRC_BAD_MULTIPART = 2 # ofp_multipart_request.type not 720 # supported. 721OFPBRC_BAD_EXPERIMENTER = 3 # Experimenter id not supported 722 # (in ofp_experimenter_header 723 # or ofp_multipart_request or 724 # ofp_multipart_reply). 725OFPBRC_BAD_EXP_TYPE = 4 # Experimenter type not supported. 726OFPBRC_EPERM = 5 # Permissions error. 727OFPBRC_BAD_LEN = 6 # Wrong request length for type. 728OFPBRC_BUFFER_EMPTY = 7 # Specified buffer has already been 729 # used. 730OFPBRC_BUFFER_UNKNOWN = 8 # Specified buffer does not exist. 731OFPBRC_BAD_TABLE_ID = 9 # Specified table-id invalid or does 732 # not exist. 733OFPBRC_IS_SLAVE = 10 # Denied because controller is slave. 734OFPBRC_BAD_PORT = 11 # Invalid port. 735OFPBRC_BAD_PACKET = 12 # Invalid packet in packet-out 736OFPBRC_MULTIPART_BUFFER_OVERFLOW = 13 # ofp_multipart_request 737 # overflowed the assigned buffer. 738OFPBRC_MULTIPART_REQUEST_TIMEOUT = 14 # Timeout during multipart request. 739OFPBRC_MULTIPART_REPLY_TIMEOUT = 15 # Timeout during multipart reply. 740 741 742# enum ofp_bad_action_code 743OFPBAC_BAD_TYPE = 0 # Unknown action type. 744OFPBAC_BAD_LEN = 1 # Length problem in actions. 745OFPBAC_BAD_EXPERIMENTER = 2 # Unknown experimenter id specified. 746OFPBAC_BAD_EXP_TYPE = 3 # Unknown action type for experimenter id. 747OFPBAC_BAD_OUT_PORT = 4 # Problem validating output action. 748OFPBAC_BAD_ARGUMENT = 5 # Bad action argument. 749OFPBAC_EPERM = 6 # Permissions error. 750OFPBAC_TOO_MANY = 7 # Can't handle this many actions. 751OFPBAC_BAD_QUEUE = 8 # Problem validating output queue. 752OFPBAC_BAD_OUT_GROUP = 9 # Invalid group id in forward action. 753OFPBAC_MATCH_INCONSISTENT = 10 # Action can't apply for this match, 754 # or Set-Field missing prerequisite. 755OFPBAC_UNSUPPORTED_ORDER = 11 # Action order is unsupported for 756 # the action list in an Apply-Actions 757 # instruction 758OFPBAC_BAD_TAG = 12 # Actions uses an unsupported tag/encap. 759OFPBAC_BAD_SET_TYPE = 13 # Unsupported type in SET_FIELD action. 760OFPBAC_BAD_SET_LEN = 14 # Length problem in SET_FIELD action. 761OFPBAC_BAD_SET_ARGUMENT = 15 # Bad arguement in SET_FIELD action. 762 763# enum ofp_bad_instruction_code 764OFPBIC_UNKNOWN_INST = 0 # Unknown instruction. 765OFPBIC_UNSUP_INST = 1 # Switch or table does not support 766 # the instruction. 767OFPBIC_BAD_TABLE_ID = 2 # Invalid Table-Id specified 768OFPBIC_UNSUP_METADATA = 3 # Metadata value unsupported by datapath. 769OFPBIC_UNSUP_METADATA_MASK = 4 # Metadata mask value unsupported by 770 # datapath. 771OFPBIC_BAD_EXPERIMENTER = 5 # Unknown experimenter id specified. 772OFPBIC_BAD_EXP_TYPE = 6 # Unknown instruction for experimenter id. 773OFPBIC_BAD_LEN = 7 # Length problem in instrucitons. 774OFPBIC_EPERM = 8 # Permissions error. 775OFPBIC_DUP_INST = 9 # Duplicate instruction. 776 777# enum ofp_bad_match_code 778OFPBMC_BAD_TYPE = 0 # Unsupported match type apecified by 779 # the match. 780OFPBMC_BAD_LEN = 1 # Length problem in math. 781OFPBMC_BAD_TAG = 2 # Match uses an unsupported tag/encap. 782OFPBMC_BAD_DL_ADDR_MASK = 3 # Unsupported datalink addr mask - 783 # switch does not support arbitrary 784 # datalink address mask. 785OFPBMC_BAD_NW_ADDR_MASK = 4 # Unsupported network addr mask - 786 # switch does not support arbitrary 787 # network addres mask. 788OFPBMC_BAD_WILDCARDS = 5 # Unsupported combination of fields 789 # masked or omitted in the match. 790OFPBMC_BAD_FIELD = 6 # Unsupported field type in the match. 791OFPBMC_BAD_VALUE = 7 # Unsupported value in a match field. 792OFPBMC_BAD_MASK = 8 # Unsupported mask specified in the 793 # match. 794OFPBMC_BAD_PREREQ = 9 # A prerequisite was not met. 795OFPBMC_DUP_FIELD = 10 # A field type was duplicated. 796OFPBMC_EPERM = 11 # Permissions error. 797 798# enum ofp_flow_mod_failed_code 799OFPFMFC_UNKNOWN = 0 # Unspecified error. 800OFPFMFC_TABLE_FULL = 1 # Flow not added because table was full. 801OFPFMFC_BAD_TABLE_ID = 2 # Table does not exist 802OFPFMFC_OVERLAP = 3 # Attempted to add overlapping flow with 803 # CHECK_OVERLAP flag set. 804OFPFMFC_EPERM = 4 # Permissions error. 805OFPFMFC_BAD_TIMEOUT = 5 # Flow not added because of unsupported 806 # idle/hard timeout. 807OFPFMFC_BAD_COMMAND = 6 # Unsupported or unknown command. 808OFPFMFC_BAD_FLAGS = 7 # Unsupported or unknown flags. 809OFPFMFC_CANT_SYNC = 8 # Problem in table synchronisation. 810OFPFMFC_BAD_PRIORITY = 9 # Unsupported priority value. 811 812# enum ofp_group_mod_failed_code 813OFPGMFC_GROUP_EXISTS = 0 # Group not added because a group ADD 814 # attempted to replace an already-present 815 # group. 816OFPGMFC_INVALID_GROUP = 1 # Group not added because Group specified 817 # is invalid. 818OFPGMFC_WEIGHT_UNSUPPORTED = 2 # Switch does not support unequal load 819 # sharing with select groups. 820OFPGMFC_OUT_OF_GROUPS = 3 # The group table is full. 821OFPGMFC_OUT_OF_BUCKETS = 4 # The maximum number of action buckets 822 # for a group has been exceeded. 823OFPGMFC_CHAINING_UNSUPPORTED = 5 # Switch does not support groups that 824 # forward to groups. 825OFPGMFC_WATCH_UNSUPPORTED = 6 # This group cannot watch the 826 # watch_port or watch_group specified. 827OFPGMFC_LOOP = 7 # Group entry would cause a loop. 828OFPGMFC_UNKNOWN_GROUP = 8 # Group not modified because a group MODIFY 829 # attempted to modify a non-existent group. 830OFPGMFC_CHAINED_GROUP = 9 # Group not deleted because another group 831 # is forwarding to it. 832OFPGMFC_BAD_TYPE = 10 # Unsupported or unknown group type. 833OFPGMFC_BAD_COMMAND = 11 # Unsupported or unknown command. 834OFPGMFC_BAD_BUCKET = 12 # Error in bucket. 835OFPGMFC_BAD_WATCH = 13 # Error in watch port/group. 836OFPGMFC_EPERM = 14 # Permissions error. 837 838# enum ofp_port_mod_failed_code 839OFPPMFC_BAD_PORT = 0 # Specified port does not exist. 840OFPPMFC_BAD_HW_ADDR = 1 # Specified hardware address does not match 841 # the port number. 842OFPPMFC_BAD_CONFIG = 2 # Specified config is invalid. 843OFPPMFC_BAD_ADVERTISE = 3 # Specified advertise is invalid. 844OFPPMFC_EPERM = 4 # Permissions error. 845 846# enum ofp_table_mod_failed_code 847OFPTMFC_BAD_TABLE = 0 # Specified table does not exist. 848OFPTMFC_BAD_CONFIG = 1 # Specified config is invalid. 849OFPTMFC_EPERM = 2 # Permissions error 850 851# enum ofp_queue_op_failed_code 852OFPQOFC_BAD_PORT = 0 # Invalid port (or port does not exist). 853OFPQOFC_BAD_QUEUE = 1 # Queue does not exist. 854OFPQOFC_EPERM = 2 # Permissions error. 855 856# enum ofp_switch_config_failed_code 857OFPSCFC_BAD_FLAGS = 0 # Specified flags is invalid. 858OFPSCFC_BAD_LEN = 1 # Specified len is invalid. 859OFPSCFC_EPERM = 2 # Permissions error. 860 861# enum ofp_role_request_failed_code 862OFPRRFC_STALE = 0 # Stale Message: old generation_id. 863OFPRRFC_UNSUP = 1 # Controller role change unsupported. 864OFPRRFC_BAD_ROLE = 2 # Invalid role. 865 866# enum ofp_meter_mod_failed_code 867OFPMMFC_UNKNOWN = 0 # Unspecified error. 868OFPMMFC_METER_EXISTS = 1 # Meter not added because a Meter ADD 869 # attempted to replace an existing Meter. 870OFPMMFC_INVALID_METER = 2 # Meter not added because Meter specified 871 # is invalid. 872OFPMMFC_UNKNOWN_METER = 3 # Meter not modified because a Meter MODIFY 873 # attempted to modify a non-existent Meter. 874OFPMMFC_BAD_COMMAND = 4 # Unsupported or unknown command. 875OFPMMFC_BAD_FLAGS = 5 # Flag configuration unsupported. 876OFPMMFC_BAD_RATE = 6 # Rate unsupported. 877OFPMMFC_BAD_BURST = 7 # Burst size unsupported. 878OFPMMFC_BAD_BAND = 8 # Band unsupported. 879OFPMMFC_BAD_BAND_VALUE = 9 # Band value unsupported. 880OFPMMFC_OUT_OF_METERS = 10 # No more meters availabile. 881OFPMMFC_OUT_OF_BANDS = 11 # The maximum number of properties for a 882 # meter has been exceeded. 883 884# enum ofp_table_features_failed_code 885OFPTFFC_BAD_TABLE = 0 # Specified table does not exist. 886OFPTFFC_BAD_METADATA = 1 # Invalid metadata mask. 887OFPTFFC_EPERM = 5 # Permissions error. 888 889# enum ofp_bad_property_code 890OFPBPC_BAD_TYPE = 0 # Unknown property type. 891OFPBPC_BAD_LEN = 1 # Length problem in property. 892OFPBPC_BAD_VALUE = 2 # Unsupported property value. 893OFPBPC_TOO_MANY = 3 # Can't handle this many properties. 894OFPBPC_DUP_TYPE = 4 # A property type was duplicated. 895OFPBPC_BAD_EXPERIMENTER = 5 # Unknown experimenter id specified. 896OFPBPC_BAD_EXP_TYPE = 6 # Unknown exp_type for experimenter id. 897OFPBPC_BAD_EXP_VALUE = 7 # Unknown value for experimenter id. 898OFPBPC_EPERM = 8 # Permissions error. 899 900# enum ofp_async_config_failed_code 901OFPACFC_INVALID = 0 # One mask is invalid. 902OFPACFC_UNSUPPORTED = 1 # Requested configuration not supported. 903OFPACFC_EPERM = 2 # Permissions error. 904 905# enum ofp_flow_monitor_failed_code 906OFPMOFC_UNKNOWN = 0 # Unspecified error. 907OFPMOFC_MONITOR_EXISTS = 1 # Monitor not added because a Monitor ADD 908 # attempted to replace an existing 909 # Monitor. 910OFPMOFC_INVALID_MONITOR = 2 # Monitor not added because Monitor 911 # specified is invalid. 912OFPMOFC_UNKNOWN_MONITOR = 3 # Monitor not modified because a Monitor 913 # MODIFY attempted to modify a non-existent 914 # Monitor. 915OFPMOFC_BAD_COMMAND = 4 # Unsupported or unknown command. 916OFPMOFC_BAD_FLAGS = 5 # Flag configuration unsupported. 917OFPMOFC_BAD_TABLE_ID = 6 # Specified table does not exist. 918OFPMOFC_BAD_OUT = 7 # Error in output port/group. 919 920# enum ofp_bundle_failed_code 921OFPBFC_UNKNOWN = 0 # Unspecified error. 922OFPBFC_EPERM = 1 # Permissions error. 923OFPBFC_BAD_ID = 2 # Bundle ID doesn't exist. 924OFPBFC_BUNDLE_EXIST = 3 # Bundle ID already exist. 925OFPBFC_BUNDLE_CLOSED = 4 # Bundle ID is closed. 926OFPBFC_OUT_OF_BUNDLES = 5 # Too many bundles IDs. 927OFPBFC_BAD_TYPE = 6 # Unsupported or unknown message control type. 928OFPBFC_BAD_FLAGS = 7 # Unsupported, unknown, or inconsistent flags. 929OFPBFC_MSG_BAD_LEN = 8 # Length problem in included message. 930OFPBFC_MSG_BAD_XID = 9 # Inconsistent or duplicate XID. 931OFPBFC_MSG_UNSUP = 10 # Unsupported message in this bundle. 932OFPBFC_MSG_CONFLICT = 11 # Unsupported message combination in this 933 # bundle. 934OFPBFC_MSG_TOO_MANY = 12 # Can't handle this many messages in bundle. 935OFPBFC_MSG_FAILED = 13 # One message in bundle failed. 936OFPBFC_TIMEOUT = 14 # Bundle is taking too long. 937OFPBFC_BUNDLE_IN_PROGRESS = 15 # Bundle is locking the resource. 938 939# struct ofp_error_msg 940OFP_ERROR_MSG_PACK_STR = '!HH' 941OFP_ERROR_MSG_SIZE = 12 942assert (calcsize(OFP_ERROR_MSG_PACK_STR) + OFP_HEADER_SIZE == 943 OFP_ERROR_MSG_SIZE) 944 945# struct ofp_error_experimenter_msg 946OFP_ERROR_EXPERIMENTER_MSG_PACK_STR = '!HHI' 947OFP_ERROR_EXPERIMENTER_MSG_SIZE = 16 948assert (calcsize(OFP_ERROR_EXPERIMENTER_MSG_PACK_STR) + 949 OFP_HEADER_SIZE) == OFP_ERROR_EXPERIMENTER_MSG_SIZE 950 951# struct ofp_experimenter_header 952OFP_EXPERIMENTER_HEADER_PACK_STR = '!II' 953OFP_EXPERIMENTER_HEADER_SIZE = 16 954assert (calcsize(OFP_EXPERIMENTER_HEADER_PACK_STR) + OFP_HEADER_SIZE 955 == OFP_EXPERIMENTER_HEADER_SIZE) 956 957# enum ofp_multipart_type 958OFPMP_DESC = 0 959OFPMP_FLOW = 1 960OFPMP_AGGREGATE = 2 961OFPMP_TABLE = 3 962OFPMP_PORT_STATS = 4 963OFPMP_QUEUE_STATS = 5 964OFPMP_GROUP = 6 965OFPMP_GROUP_DESC = 7 966OFPMP_GROUP_FEATURES = 8 967OFPMP_METER = 9 968OFPMP_METER_CONFIG = 10 969OFPMP_METER_FEATURES = 11 970OFPMP_TABLE_FEATURES = 12 971OFPMP_PORT_DESC = 13 972OFPMP_TABLE_DESC = 14 973OFPMP_QUEUE_DESC = 15 974OFPMP_FLOW_MONITOR = 16 975OFPMP_EXPERIMENTER = 0xffff 976 977# struct ofp_multipart_request 978OFP_MULTIPART_REQUEST_PACK_STR = '!HH4x' 979OFP_MULTIPART_REQUEST_SIZE = 16 980assert (calcsize(OFP_MULTIPART_REQUEST_PACK_STR) + OFP_HEADER_SIZE == 981 OFP_MULTIPART_REQUEST_SIZE) 982 983# enum ofp_multipart_reply_flags 984OFPMPF_REPLY_MORE = 1 << 0 # More requests to follow. 985 986# struct ofp_multipart_reply 987OFP_MULTIPART_REPLY_PACK_STR = '!HH4x' 988OFP_MULTIPART_REPLY_SIZE = 16 989assert (calcsize(OFP_MULTIPART_REPLY_PACK_STR) + OFP_HEADER_SIZE == 990 OFP_MULTIPART_REPLY_SIZE) 991 992DESC_STR_LEN = 256 993DESC_STR_LEN_STR = str(DESC_STR_LEN) 994SERIAL_NUM_LEN = 32 995SERIAL_NUM_LEN_STR = str(SERIAL_NUM_LEN) 996OFP_DESC_PACK_STR = '!' + \ 997 DESC_STR_LEN_STR + 's' + \ 998 DESC_STR_LEN_STR + 's' + \ 999 DESC_STR_LEN_STR + 's' + \ 1000 SERIAL_NUM_LEN_STR + 's' + \ 1001 DESC_STR_LEN_STR + 's' 1002OFP_DESC_SIZE = 1056 1003assert calcsize(OFP_DESC_PACK_STR) == OFP_DESC_SIZE 1004 1005# struct ofp_flow_stats_request 1006_OFP_FLOW_STATS_REQUEST_0_PACK_STR = 'B3xII4xQQ' 1007OFP_FLOW_STATS_REQUEST_0_PACK_STR = '!' + _OFP_FLOW_STATS_REQUEST_0_PACK_STR 1008OFP_FLOW_STATS_REQUEST_0_SIZE = 32 1009assert (calcsize(OFP_FLOW_STATS_REQUEST_0_PACK_STR) == 1010 OFP_FLOW_STATS_REQUEST_0_SIZE) 1011OFP_FLOW_STATS_REQUEST_PACK_STR = (OFP_FLOW_STATS_REQUEST_0_PACK_STR + 1012 _OFP_MATCH_PACK_STR) 1013OFP_FLOW_STATS_REQUEST_SIZE = 40 1014assert (calcsize(OFP_FLOW_STATS_REQUEST_PACK_STR) == 1015 OFP_FLOW_STATS_REQUEST_SIZE) 1016 1017# struct ofp_flow_stats 1018_OFP_FLOW_STATS_0_PACK_STR = 'HBxIIHHHHH2xQQQ' 1019OFP_FLOW_STATS_0_PACK_STR = '!' + _OFP_FLOW_STATS_0_PACK_STR 1020OFP_FLOW_STATS_0_SIZE = 48 1021assert calcsize(OFP_FLOW_STATS_0_PACK_STR) == OFP_FLOW_STATS_0_SIZE 1022OFP_FLOW_STATS_PACK_STR = (OFP_FLOW_STATS_0_PACK_STR + 1023 _OFP_MATCH_PACK_STR) 1024OFP_FLOW_STATS_SIZE = 56 1025assert calcsize(OFP_FLOW_STATS_PACK_STR) == OFP_FLOW_STATS_SIZE 1026 1027# struct ofp_aggregate_stats_request 1028OFP_AGGREGATE_STATS_REQUEST_PACK_STR = '!B3xII4xQQ' + _OFP_MATCH_PACK_STR 1029OFP_AGGREGATE_STATS_REQUEST_SIZE = 40 1030assert (calcsize(OFP_AGGREGATE_STATS_REQUEST_PACK_STR) == 1031 OFP_AGGREGATE_STATS_REQUEST_SIZE) 1032 1033# struct ofp_aggregate_stats_reply 1034OFP_AGGREGATE_STATS_REPLY_PACK_STR = '!QQI4x' 1035OFP_AGGREGATE_STATS_REPLY_SIZE = 24 1036assert (calcsize(OFP_AGGREGATE_STATS_REPLY_PACK_STR) == 1037 OFP_AGGREGATE_STATS_REPLY_SIZE) 1038 1039 1040# enum ofp_table_feature_prop_type 1041OFPTFPT_INSTRUCTIONS = 0 1042OFPTFPT_INSTRUCTIONS_MISS = 1 1043OFPTFPT_NEXT_TABLES = 2 1044OFPTFPT_NEXT_TABLES_MISS = 3 1045OFPTFPT_WRITE_ACTIONS = 4 1046OFPTFPT_WRITE_ACTIONS_MISS = 5 1047OFPTFPT_APPLY_ACTIONS = 6 1048OFPTFPT_APPLY_ACTIONS_MISS = 7 1049OFPTFPT_MATCH = 8 1050OFPTFPT_WILDCARDS = 10 1051OFPTFPT_WRITE_SETFIELD = 12 1052OFPTFPT_WRITE_SETFIELD_MISS = 13 1053OFPTFPT_APPLY_SETFIELD = 14 1054OFPTFPT_APPLY_SETFIELD_MISS = 15 1055OFPTFPT_TABLE_SYNC_FROM = 16 1056OFPTFPT_EXPERIMENTER = 0xFFFE 1057OFPTFPT_EXPERIMENTER_MISS = 0xFFFF 1058 1059# struct ofp_instruction_id 1060OFP_INSTRUCTION_ID_PACK_STR = '!HH' 1061OFP_INSTRUCTION_ID_SIZE = 4 1062assert calcsize(OFP_INSTRUCTION_ID_PACK_STR) == OFP_INSTRUCTION_ID_SIZE 1063 1064# struct ofp_table_feature_prop_instructions 1065OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_PACK_STR = '!HH' 1066OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_SIZE = 4 1067assert (calcsize(OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_PACK_STR) == 1068 OFP_TABLE_FEATURE_PROP_INSTRUCTIONS_SIZE) 1069 1070# struct ofp_table_feature_prop_actions 1071OFP_TABLE_FEATURE_PROP_ACTIONS_PACK_STR = '!HH' 1072OFP_TABLE_FEATURE_PROP_ACTIONS_SIZE = 4 1073assert (calcsize(OFP_TABLE_FEATURE_PROP_ACTIONS_PACK_STR) == 1074 OFP_TABLE_FEATURE_PROP_ACTIONS_SIZE) 1075 1076# struct ofp_table_feature_prop_oxm 1077OFP_TABLE_FEATURE_PROP_OXM_PACK_STR = '!HH' 1078OFP_TABLE_FEATURE_PROP_OXM_SIZE = 4 1079assert (calcsize(OFP_TABLE_FEATURE_PROP_OXM_PACK_STR) == 1080 OFP_TABLE_FEATURE_PROP_OXM_SIZE) 1081 1082# struct ofp_table_feature_prop_experimenter 1083OFP_TABLE_FEATURE_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1084OFP_TABLE_FEATURE_PROP_EXPERIMENTER_SIZE = 12 1085assert (calcsize(OFP_TABLE_FEATURE_PROP_EXPERIMENTER_PACK_STR) == 1086 OFP_TABLE_FEATURE_PROP_EXPERIMENTER_SIZE) 1087 1088 1089# struct ofp_table_features 1090OFP_MAX_TABLE_NAME_LEN = 32 1091OFP_MAX_TABLE_NAME_LEN_STR = str(OFP_MAX_TABLE_NAME_LEN) 1092OFP_TABLE_FEATURES_PACK_STR = '!HB5x' + OFP_MAX_TABLE_NAME_LEN_STR + \ 1093 's' + 'QQII' 1094OFP_TABLE_FEATURES_SIZE = 64 1095assert (calcsize(OFP_TABLE_FEATURES_PACK_STR) == 1096 OFP_TABLE_FEATURES_SIZE) 1097 1098# struct ofp_table_stats 1099OFP_TABLE_STATS_PACK_STR = '!B3xIQQ' 1100OFP_TABLE_STATS_SIZE = 24 1101assert calcsize(OFP_TABLE_STATS_PACK_STR) == OFP_TABLE_STATS_SIZE 1102 1103# struct ofp_table_desc 1104_OFP_TABLE_DESC_PACK_STR = 'HBxI' 1105OFP_TABLE_DESC_PACK_STR = '!' + _OFP_TABLE_DESC_PACK_STR 1106OFP_TABLE_DESC_SIZE = 8 1107assert calcsize(OFP_TABLE_DESC_PACK_STR) == OFP_TABLE_DESC_SIZE 1108 1109# struct ofp_port_stats_request 1110OFP_PORT_STATS_REQUEST_PACK_STR = '!I4x' 1111OFP_PORT_STATS_REQUEST_SIZE = 8 1112assert (calcsize(OFP_PORT_STATS_REQUEST_PACK_STR) == 1113 OFP_PORT_STATS_REQUEST_SIZE) 1114 1115# enum ofp_port_stats_prop_type 1116OFPPSPT_ETHERNET = 0 # Ethernet property. 1117OFPPSPT_OPTICAL = 1 # Optical property. 1118OFPPSPT_EXPERIMENTER = 0xFFFF # Experimenter property. 1119 1120# struct ofp_port_stats_prop_ethernet 1121OFP_PORT_STATS_PROP_ETHERNET_PACK_STR = '!HH4xQQQQ' 1122OFP_PORT_STATS_PROP_ETHERNET_SIZE = 40 1123assert (calcsize(OFP_PORT_STATS_PROP_ETHERNET_PACK_STR) == 1124 OFP_PORT_STATS_PROP_ETHERNET_SIZE) 1125 1126# struct ofp_port_stats_prop_optical 1127OFP_PORT_STATS_PROP_OPTICAL_PACK_STR = '!HH4xIIIIIIIHHHH' 1128OFP_PORT_STATS_PROP_OPTICAL_SIZE = 44 1129assert (calcsize(OFP_PORT_STATS_PROP_OPTICAL_PACK_STR) == 1130 OFP_PORT_STATS_PROP_OPTICAL_SIZE) 1131 1132# enum ofp_port_stats_optical_flags 1133OFPOSF_RX_TUNE = 1 << 0 # Receiver tune info valid 1134OFPOSF_TX_TUNE = 1 << 1 # Transmit tune info valid 1135OFPOSF_TX_PWR = 1 << 2 # TX Power is valid 1136OFPOSF_RX_PWR = 1 << 4 # RX power is valid 1137OFPOSF_TX_BIAS = 1 << 5 # Transmit bias is valid 1138OFPOSF_TX_TEMP = 1 << 6 # TX Temp is valid 1139 1140# struct ofp_port_stats_prop_experimenter 1141OFP_PORT_STATS_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1142OFP_PORT_STATS_PROP_EXPERIMENTER_SIZE = 12 1143assert (calcsize(OFP_PORT_STATS_PROP_EXPERIMENTER_PACK_STR) == 1144 OFP_PORT_STATS_PROP_EXPERIMENTER_SIZE) 1145 1146# struct ofp_port_stats 1147OFP_PORT_STATS_PACK_STR = '!H2xIIIQQQQQQQQ' 1148OFP_PORT_STATS_SIZE = 80 1149assert calcsize(OFP_PORT_STATS_PACK_STR) == OFP_PORT_STATS_SIZE 1150 1151# struct ofp_group_stats_request 1152OFP_GROUP_STATS_REQUEST_PACK_STR = '!I4x' 1153OFP_GROUP_STATS_REQUEST_SIZE = 8 1154assert (calcsize(OFP_GROUP_STATS_REQUEST_PACK_STR) == 1155 OFP_GROUP_STATS_REQUEST_SIZE) 1156 1157# struct ofp_bucket_counter 1158OFP_BUCKET_COUNTER_PACK_STR = '!QQ' 1159OFP_BUCKET_COUNTER_SIZE = 16 1160assert calcsize(OFP_BUCKET_COUNTER_PACK_STR) == OFP_BUCKET_COUNTER_SIZE 1161 1162# struct ofp_group_stats 1163OFP_GROUP_STATS_PACK_STR = '!H2xII4xQQII' 1164OFP_GROUP_STATS_SIZE = 40 1165assert calcsize(OFP_GROUP_STATS_PACK_STR) == OFP_GROUP_STATS_SIZE 1166 1167# struct ofp_group_desc 1168OFP_GROUP_DESC_PACK_STR = '!HBxI' 1169OFP_GROUP_DESC_SIZE = 8 1170assert calcsize(OFP_GROUP_DESC_PACK_STR) == OFP_GROUP_DESC_SIZE 1171 1172# struct ofp_group_desc_stats 1173# Backward compatibility with 1.3.1 - avoid breaking the API. 1174OFP_GROUP_DESC_STATS_PACK_STR = OFP_GROUP_DESC_PACK_STR 1175OFP_GROUP_DESC_STATS_SIZE = OFP_GROUP_DESC_SIZE 1176assert calcsize(OFP_GROUP_DESC_STATS_PACK_STR) == OFP_GROUP_DESC_STATS_SIZE 1177 1178# enum ofp_group_capabilities 1179OFPGFC_SELECT_WEIGHT = 1 << 0 # Support weight for select groups. 1180OFPGFC_SELECT_LIVENESS = 1 << 1 # Support liveness for select groups. 1181OFPGFC_CHAINING = 1 << 2 # Support chaining groups. 1182OFPGFC_CHAINING_CHECKS = 1 << 3 # Check chaining for loops and delete 1183 1184# struct ofp_group_features 1185OFP_GROUP_FEATURES_PACK_STR = '!II4I4I' 1186OFP_GROUP_FEATURES_SIZE = 40 1187assert calcsize(OFP_GROUP_FEATURES_PACK_STR) == OFP_GROUP_FEATURES_SIZE 1188 1189# struct ofp_meter_multipart_request 1190OFP_METER_MULTIPART_REQUEST_PACK_STR = '!I4x' 1191OFP_METER_MULTIPART_REQUEST_SIZE = 8 1192assert (calcsize(OFP_METER_MULTIPART_REQUEST_PACK_STR) == 1193 OFP_METER_MULTIPART_REQUEST_SIZE) 1194 1195# struct ofp_meter_stats 1196OFP_METER_STATS_PACK_STR = '!IH6xIQQII' 1197OFP_METER_STATS_SIZE = 40 1198assert calcsize(OFP_METER_STATS_PACK_STR) == OFP_METER_STATS_SIZE 1199 1200# struct ofp_meter_band_stats 1201OFP_METER_BAND_STATS_PACK_STR = '!QQ' 1202OFP_METER_BAND_STATS_SIZE = 16 1203assert (calcsize(OFP_METER_BAND_STATS_PACK_STR) == 1204 OFP_METER_BAND_STATS_SIZE) 1205 1206# struct ofp_meter_config 1207OFP_METER_CONFIG_PACK_STR = '!HHI' 1208OFP_METER_CONFIG_SIZE = 8 1209assert calcsize(OFP_METER_CONFIG_PACK_STR) == OFP_METER_CONFIG_SIZE 1210 1211# struct ofp_meter_features 1212OFP_METER_FEATURES_PACK_STR = '!IIIBB2x' 1213OFP_METER_FEATURES_SIZE = 16 1214assert (calcsize(OFP_METER_FEATURES_PACK_STR) == 1215 OFP_METER_FEATURES_SIZE) 1216 1217# All ones is used to indicate all queues in a port (for stats retrieval). 1218OFPQ_ALL = 0xffffffff 1219 1220# Min rate > 1000 means not configured. 1221OFPQ_MIN_RATE_UNCFG = 0xffff 1222 1223# Max rate > 1000 means not configured. 1224OFPQ_MAX_RATE_UNCFG = 0xffff 1225 1226# enum ofp_queue_desc_prop_type 1227OFPQDPT_MIN_RATE = 1 # Minimum datarate guaranteed. 1228OFPQDPT_MAX_RATE = 2 # Maximum datarate. 1229OFPQDPT_EXPERIMENTER = 0xffff # Experimenter defined property. 1230 1231# struct ofp_queue_desc_prop_min_rate 1232OFP_QUEUE_DESC_PROP_MIN_RATE_PACK_STR = '!HHH2x' 1233OFP_QUEUE_DESC_PROP_MIN_RATE_SIZE = 8 1234assert (calcsize(OFP_QUEUE_DESC_PROP_MIN_RATE_PACK_STR) == 1235 OFP_QUEUE_DESC_PROP_MIN_RATE_SIZE) 1236 1237# ofp_queue_desc_prop_max_rate 1238OFP_QUEUE_DESC_PROP_MAX_RATE_PACK_STR = '!HHH2x' 1239OFP_QUEUE_DESC_PROP_MAX_RATE_SIZE = 8 1240assert (calcsize(OFP_QUEUE_DESC_PROP_MAX_RATE_PACK_STR) == 1241 OFP_QUEUE_DESC_PROP_MAX_RATE_SIZE) 1242 1243# struct ofp_queue_desc_prop_experimenter 1244OFP_QUEUE_DESC_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1245OFP_QUEUE_DESC_PROP_EXPERIMENTER_SIZE = 12 1246assert (calcsize(OFP_QUEUE_DESC_PROP_EXPERIMENTER_PACK_STR) == 1247 OFP_QUEUE_DESC_PROP_EXPERIMENTER_SIZE) 1248 1249# struct ofp_queue_desc_request 1250OFP_QUEUE_DESC_REQUEST_PACK_STR = '!II' 1251OFP_QUEUE_DESC_REQUEST_SIZE = 8 1252assert (calcsize(OFP_QUEUE_DESC_REQUEST_PACK_STR) == 1253 OFP_QUEUE_DESC_REQUEST_SIZE) 1254 1255# struct ofp_queue_desc 1256OFP_QUEUE_DESC_PACK_STR = '!IIH6x' 1257OFP_QUEUE_DESC_SIZE = 16 1258assert calcsize(OFP_QUEUE_DESC_PACK_STR) == OFP_QUEUE_DESC_SIZE 1259 1260# struct ofp_queue_stats_request 1261OFP_QUEUE_STATS_REQUEST_PACK_STR = '!II' 1262OFP_QUEUE_STATS_REQUEST_SIZE = 8 1263assert (calcsize(OFP_QUEUE_STATS_REQUEST_PACK_STR) == 1264 OFP_QUEUE_STATS_REQUEST_SIZE) 1265 1266# enum ofp_queue_stats_prop_type 1267OFPQSPT_EXPERIMENTER = 0xffff # Experimenter defined property. 1268 1269# struct ofp_queue_stats_prop_experimenter 1270OFP_QUEUE_STATS_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1271OFP_QUEUE_STATS_PROP_EXPERIMENTER_SIZE = 12 1272assert (calcsize(OFP_QUEUE_STATS_PROP_EXPERIMENTER_PACK_STR) == 1273 OFP_QUEUE_STATS_PROP_EXPERIMENTER_SIZE) 1274 1275# struct ofp_queue_stats 1276OFP_QUEUE_STATS_PACK_STR = '!H6xIIQQQII' 1277OFP_QUEUE_STATS_SIZE = 48 1278assert calcsize(OFP_QUEUE_STATS_PACK_STR) == OFP_QUEUE_STATS_SIZE 1279 1280# struct ofp_flow_monitor_request 1281_OFP_FLOW_MONITOR_REQUEST_0_PACK_STR = 'IIIHBB' 1282OFP_FLOW_MONITOR_REQUEST_0_PACK_STR = ('!' + 1283 _OFP_FLOW_MONITOR_REQUEST_0_PACK_STR) 1284OFP_FLOW_MONITOR_REQUEST_0_SIZE = 16 1285OFP_FLOW_MONITOR_REQUEST_PACK_STR = (OFP_FLOW_MONITOR_REQUEST_0_PACK_STR + 1286 _OFP_MATCH_PACK_STR) 1287OFP_FLOW_MONITOR_REQUEST_SIZE = 24 1288assert (calcsize(OFP_FLOW_MONITOR_REQUEST_PACK_STR) == 1289 OFP_FLOW_MONITOR_REQUEST_SIZE) 1290 1291# enum ofp_flow_monitor_command 1292OFPFMC_ADD = 0 # New flow monitor. 1293OFPFMC_MODIFY = 1 # Modify existing flow monitor. 1294OFPFMC_DELETE = 2 # Delete/cancel existing flow monitor. 1295 1296# enum ofp_flow_monitor_flags 1297# When to send updates. 1298OFPFMF_INITIAL = 1 << 0 # Initially matching flows. 1299OFPFMF_ADD = 1 << 1 # New matching flows as they are added. 1300OFPFMF_REMOVED = 1 << 2 # Old matching flows as they are removed. 1301OFPFMF_MODIFY = 1 << 3 # Matching flows as they are changed. 1302# What to include in updates. 1303OFPFMF_INSTRUCTIONS = 1 << 4 # If set, instructions are included. 1304OFPFMF_NO_ABBREV = 1 << 5 # If set, include own changes in full. 1305OFPFMF_ONLY_OWN = 1 << 6 # If set, don't include other controllers. 1306 1307# struct ofp_flow_update_header 1308OFP_FLOW_UPDATE_HEADER_PACK_STR = '!HH' 1309OFP_FLOW_UPDATE_HEADER_SIZE = 4 1310assert (calcsize(OFP_FLOW_UPDATE_HEADER_PACK_STR) == 1311 OFP_FLOW_UPDATE_HEADER_SIZE) 1312 1313# enum ofp_flow_update_event 1314# struct ofp_flow_update_full. 1315OFPFME_INITIAL = 0 # Flow present when flow monitor created. 1316OFPFME_ADDED = 1 # Flow was added. 1317OFPFME_REMOVED = 2 # Flow was removed. 1318OFPFME_MODIFIED = 3 # Flow instructions were changed. 1319# struct ofp_flow_update_abbrev. 1320OFPFME_ABBREV = 4 # Abbreviated reply. 1321# struct ofp_flow_update_header. 1322OFPFME_PAUSED = 5 # Monitoring paused (out of buffer space). 1323OFPFME_RESUMED = 6 # Monitoring resumed. 1324 1325# struct ofp_flow_update_full 1326_OFP_FLOW_UPDATE_FULL_0_PACK_STR = 'HHBBHHH4xQ' 1327OFP_FLOW_UPDATE_FULL_0_PACK_STR = '!' + _OFP_FLOW_UPDATE_FULL_0_PACK_STR 1328OFP_FLOW_UPDATE_FULL_0_SIZE = 24 1329OFP_FLOW_UPDATE_FULL_PACK_STR = (OFP_FLOW_UPDATE_FULL_0_PACK_STR + 1330 _OFP_MATCH_PACK_STR) 1331OFP_FLOW_UPDATE_FULL_SIZE = 32 1332assert (calcsize(OFP_FLOW_UPDATE_FULL_PACK_STR) == 1333 OFP_FLOW_UPDATE_FULL_SIZE) 1334 1335# struct ofp_flow_update_abbrev 1336OFP_FLOW_UPDATE_ABBREV_PACK_STR = '!HHI' 1337OFP_FLOW_UPDATE_ABBREV_SIZE = 8 1338assert (calcsize(OFP_FLOW_UPDATE_ABBREV_PACK_STR) == 1339 OFP_FLOW_UPDATE_ABBREV_SIZE) 1340 1341# struct ofp_flow_update_paused 1342OFP_FLOW_UPDATE_PAUSED_PACK_STR = '!HH4x' 1343OFP_FLOW_UPDATE_PAUSED_SIZE = 8 1344assert (calcsize(OFP_FLOW_UPDATE_PAUSED_PACK_STR) == 1345 OFP_FLOW_UPDATE_PAUSED_SIZE) 1346 1347# struct ofp_experimenter_multipart_header 1348OFP_EXPERIMENTER_MULTIPART_HEADER_PACK_STR = '!II' 1349OFP_EXPERIMENTER_MULTIPART_HEADER_SIZE = 8 1350assert (calcsize(OFP_EXPERIMENTER_MULTIPART_HEADER_PACK_STR) == 1351 OFP_EXPERIMENTER_MULTIPART_HEADER_SIZE) 1352 1353# struct ofp_experimenter_structure 1354OFP_EXPERIMENTER_STRUCTURE_PACK_STR = '!II' 1355OFP_EXPERIMENTER_STRUCTURE_SIZE = 8 1356assert (calcsize(OFP_EXPERIMENTER_STRUCTURE_PACK_STR) == 1357 OFP_EXPERIMENTER_STRUCTURE_SIZE) 1358 1359# struct ofp_error_experimenter_msg 1360OFP_ERROR_EXPERIMENTER_MSG_PACK_STR = '!HHI' 1361OFP_ERROR_EXPERIMENTER_MSG_SIZE = 16 1362assert (calcsize(OFP_ERROR_EXPERIMENTER_MSG_PACK_STR) + 1363 OFP_HEADER_SIZE) == OFP_ERROR_EXPERIMENTER_MSG_SIZE 1364 1365# enum ofp_controller_role 1366OFPCR_ROLE_NOCHANGE = 0 # Don't change current role. 1367OFPCR_ROLE_EQUAL = 1 # Default role, full access. 1368OFPCR_ROLE_MASTER = 2 # Full access, at most one master. 1369OFPCR_ROLE_SLAVE = 3 # Read-only access. 1370 1371# struct ofp_role_request 1372OFP_ROLE_REQUEST_PACK_STR = '!I4xQ' 1373OFP_ROLE_REQUEST_SIZE = 24 1374assert (calcsize(OFP_ROLE_REQUEST_PACK_STR) + OFP_HEADER_SIZE == 1375 OFP_ROLE_REQUEST_SIZE) 1376 1377# enum ofp_role_prop_type 1378OFPRPT_EXPERIMENTER = 0xFFFF # Experimenter property. 1379 1380# struct ofp_role_prop_experimenter 1381OFP_ROLE_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1382OFP_ROLE_PROP_EXPERIMENTER_SIZE = 12 1383assert (calcsize(OFP_ROLE_PROP_EXPERIMENTER_PACK_STR) == 1384 OFP_ROLE_PROP_EXPERIMENTER_SIZE) 1385 1386# enum ofp_controller_role_reason 1387OFPCRR_MASTER_REQUEST = 0 # Another controller asked to be master. 1388OFPCRR_CONFIG = 1 # Configuration changed on the switch. 1389OFPCRR_EXPERIMENTER = 2 # Experimenter data changed. 1390 1391# struct ofp_role_status 1392OFP_ROLE_STATUS_PACK_STR = '!IB3xQ' 1393OFP_ROLE_STATUS_SIZE = 24 1394assert (calcsize(OFP_ROLE_STATUS_PACK_STR) + OFP_HEADER_SIZE == 1395 OFP_ROLE_STATUS_SIZE) 1396 1397# enum ofp_async_config_prop_type 1398OFPACPT_PACKET_IN_SLAVE = 0 # Packet-in mask for slave. 1399OFPACPT_PACKET_IN_MASTER = 1 # Packet-in mask for master. 1400OFPACPT_PORT_STATUS_SLAVE = 2 # Port-status mask for slave. 1401OFPACPT_PORT_STATUS_MASTER = 3 # Port-status mask for master. 1402OFPACPT_FLOW_REMOVED_SLAVE = 4 # Flow removed mask for slave. 1403OFPACPT_FLOW_REMOVED_MASTER = 5 # Flow removed mask for master. 1404OFPACPT_ROLE_STATUS_SLAVE = 6 # Role status mask for slave. 1405OFPACPT_ROLE_STATUS_MASTER = 7 # Role status mask for master. 1406OFPACPT_TABLE_STATUS_SLAVE = 8 # Table status mask for slave. 1407OFPACPT_TABLE_STATUS_MASTER = 9 # Table status mask for master. 1408OFPACPT_REQUESTFORWARD_SLAVE = 10 # RequestForward mask for slave. 1409OFPACPT_REQUESTFORWARD_MASTER = 11 # RequestForward mask for master. 1410OFPTFPT_EXPERIMENTER_SLAVE = 0xFFFE # Experimenter for slave (depracated). 1411OFPTFPT_EXPERIMENTER_MASTER = 0xFFFF # Experimenter for master (depracated). 1412 # New or updated Ryu applications shall use 1413 # OFPACPT_EXPERIMENTER_SLAVE and OFPACPT_EXPERIMENTER_MASTER. 1414 # The variable name is a typo of in specifications before v1.5.0. 1415OFPACPT_EXPERIMENTER_SLAVE = 0xFFFE # Experimenter for slave. 1416OFPACPT_EXPERIMENTER_MASTER = 0xFFFF # Experimenter for master. 1417 # Backporting from ofproto_v1_5 for consistency with 1418 # later OF specs. 1419 1420# struct ofp_async_config_prop_reasons 1421OFP_ASYNC_CONFIG_PROP_REASONS_PACK_STR = '!HHI' 1422OFP_ASYNC_CONFIG_PROP_REASONS_SIZE = 8 1423assert (calcsize(OFP_ASYNC_CONFIG_PROP_REASONS_PACK_STR) == 1424 OFP_ASYNC_CONFIG_PROP_REASONS_SIZE) 1425 1426# struct ofp_async_config_prop_experimenter 1427OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1428OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_SIZE = 12 1429assert (calcsize(OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_PACK_STR) == 1430 OFP_ASYNC_CONFIG_PROP_EXPERIMENTER_SIZE) 1431 1432# enum ofp_table_reason 1433OFPTR_VACANCY_DOWN = 3 # Vacancy down threshold event. 1434OFPTR_VACANCY_UP = 4 # Vacancy up threshold event. 1435 1436# struct ofp_table_status 1437_OFP_TABLE_STATUS_0_PACK_STR = 'B7x' 1438OFP_TABLE_STATUS_0_PACK_STR = '!' + _OFP_TABLE_STATUS_0_PACK_STR 1439OFP_TABLE_STATUS_0_SIZE = 16 1440OFP_TABLE_STATUS_PACK_STR = (OFP_TABLE_STATUS_0_PACK_STR + 1441 _OFP_TABLE_DESC_PACK_STR) 1442OFP_TABLE_STATUS_SIZE = 24 1443assert (calcsize(OFP_TABLE_STATUS_PACK_STR) + OFP_HEADER_SIZE == 1444 OFP_TABLE_STATUS_SIZE) 1445 1446# enum ofp_requestforward_reason 1447OFPRFR_GROUP_MOD = 0 # Forward group mod requests. 1448OFPRFR_METER_MOD = 1 # Forward meter mod requests. 1449 1450# enum ofp_bundle_prop_type 1451OFPBPT_EXPERIMENTER = 0xFFFF # Experimenter property. 1452 1453# struct ofp_bundle_prop_experimenter 1454OFP_BUNDLE_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1455OFP_BUNDLE_PROP_EXPERIMENTER_SIZE = 12 1456assert (calcsize(OFP_BUNDLE_PROP_EXPERIMENTER_PACK_STR) == 1457 OFP_BUNDLE_PROP_EXPERIMENTER_SIZE) 1458 1459# enum ofp_bundle_ctrl_type 1460OFPBCT_OPEN_REQUEST = 0 1461OFPBCT_OPEN_REPLY = 1 1462OFPBCT_CLOSE_REQUEST = 2 1463OFPBCT_CLOSE_REPLY = 3 1464OFPBCT_COMMIT_REQUEST = 4 1465OFPBCT_COMMIT_REPLY = 5 1466OFPBCT_DISCARD_REQUEST = 6 1467OFPBCT_DISCARD_REPLY = 7 1468 1469# enum ofp_bundle_flags 1470OFPBF_ATOMIC = 1 << 0 # Execute atomically. 1471OFPBF_ORDERED = 1 << 1 # Execute in specified order. 1472 1473# struct ofp_bundle_ctrl_msg 1474OFP_BUNDLE_CTRL_MSG_PACK_STR = '!IHH' 1475OFP_BUNDLE_CTRL_MSG_SIZE = 16 1476assert (calcsize(OFP_BUNDLE_CTRL_MSG_PACK_STR) + OFP_HEADER_SIZE == 1477 OFP_BUNDLE_CTRL_MSG_SIZE) 1478 1479# struct ofp_bundle_add_msg 1480_OFP_BUNDLE_ADD_MSG_0_PACK_STR = 'I2xH' 1481OFP_BUNDLE_ADD_MSG_0_PACK_STR = '!' + _OFP_BUNDLE_ADD_MSG_0_PACK_STR 1482OFP_BUNDLE_ADD_MSG_PACK_STR = (OFP_BUNDLE_ADD_MSG_0_PACK_STR + 1483 _OFP_HEADER_PACK_STR) 1484OFP_BUNDLE_ADD_MSG_SIZE = 24 1485assert (calcsize(OFP_BUNDLE_ADD_MSG_PACK_STR) + OFP_HEADER_SIZE == 1486 OFP_BUNDLE_ADD_MSG_SIZE) 1487 1488# Note: struct ofp_prop_experimenter is specific to this implementation. 1489# It does not have a corresponding structure in the specification. 1490# This structure defines common structure for ofp_*_prop_experimenter. 1491# struct ofp_prop_experimenter 1492OFP_PROP_EXPERIMENTER_PACK_STR = '!HHII' 1493OFP_PROP_EXPERIMENTER_SIZE = 12 1494assert (calcsize(OFP_PROP_EXPERIMENTER_PACK_STR) == 1495 OFP_PROP_EXPERIMENTER_SIZE) 1496 1497# generate utility methods 1498ofproto_utils.generate(__name__) 1499 1500# define constants 1501OFP_VERSION = 0x05 1502OFP_TCP_PORT = 6653 1503OFP_SSL_PORT = 6653 1504MAX_XID = 0xffffffff 1505