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