include/openflow/nicira-ext.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
   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 implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OPENFLOW_NICIRA_EXT_H
  18 #define OPENFLOW_NICIRA_EXT_H 1
  19
  20 #include "openflow/openflow.h"
  21 #include "openvswitch/types.h"
  22
  23 /* The following vendor extensions, proposed by Nicira Networks, are not yet
  24  * standardized, so they are not included in openflow.h.  Some of them may be
  25  * suitable for standardization; others we never expect to standardize. */
  26
  27 #define NX_VENDOR_ID 0x00002320
  28 \f
  29 /* Nicira vendor-specific error messages extension.
  30  *
  31  * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
  32  * are specific to each type).  It does not have any provision for
  33  * vendor-specific error codes, and it does not even provide "generic" error
  34  * codes that can apply to problems not anticipated by the OpenFlow
  35  * specification authors.
  36  *
  37  * This extension attempts to address the problem by adding a generic "error
  38  * vendor extension".  The extension works as follows: use NXET_VENDOR as type
  39  * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
  40  * vendor-specific details, followed by at least 64 bytes of the failed
  41  * request.
  42  *
  43  * It would be better to have a type-specific vendor extension, e.g. so that
  44  * OFPET_BAD_ACTION could be used with vendor-specific code values.  But
  45  * OFPET_BAD_ACTION and most other standardized types already specify that
  46  * their 'data' values are (the start of) the OpenFlow message being replied
  47  * to, so there is no room to insert a vendor ID.
  48  *
  49  * Currently this extension is only implemented by Open vSwitch, but it seems
  50  * like a reasonable candidate for future standardization.
  51  */
  52
  53 /* This is a random number to avoid accidental collision with any other
  54  * vendor's extension. */
  55 #define NXET_VENDOR 0xb0c2
  56
  57 /* ofp_error msg 'code' values for NXET_VENDOR. */
  58 enum nx_vendor_code {
  59     NXVC_VENDOR_ERROR           /* 'data' contains struct nx_vendor_error. */
  60 };
  61
  62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
  63 struct nx_vendor_error {
  64     ovs_be32 vendor;            /* Vendor ID as in struct ofp_vendor_header. */
  65     ovs_be16 type;              /* Vendor-defined type. */
  66     ovs_be16 code;              /* Vendor-defined subtype. */
  67     /* Followed by at least the first 64 bytes of the failed request. */
  68 };
  69 \f
  70 /* Specific Nicira extension error numbers.
  71  *
  72  * These are the "code" values used in nx_vendor_error.  So far, the "type"
  73  * values in nx_vendor_error are the same as those in ofp_error_msg.  That is,
  74  * at Nicira so far we've only needed additional vendor-specific 'code' values,
  75  * so we're using the existing 'type' values to avoid having to invent new ones
  76  * that duplicate the current ones' meanings. */
  77
  78 /* Additional "code" values for OFPET_BAD_REQUEST. */
  79 enum nx_bad_request_code {
  80 /* Nicira Extended Match (NXM) errors. */
  81
  82     /* Generic error code used when there is an error in an NXM sent to the
  83      * switch.  The switch may use one of the more specific error codes below,
  84      * if there is an appropriate one, to simplify debugging, but it is not
  85      * required to do so. */
  86     NXBRC_NXM_INVALID = 0x100,
  87
  88     /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or
  89      * nxm_length or both, is invalid or not implemented. */
  90     NXBRC_NXM_BAD_TYPE = 0x101,
  91
  92     /* Invalid nxm_value. */
  93     NXBRC_NXM_BAD_VALUE = 0x102,
  94
  95     /* Invalid nxm_mask. */
  96     NXBRC_NXM_BAD_MASK = 0x103,
  97
  98     /* A prerequisite was not met. */
  99     NXBRC_NXM_BAD_PREREQ = 0x104,
 100
 101     /* A given nxm_type was specified more than once. */
 102     NXBRC_NXM_DUP_TYPE = 0x105
 103 };
 104
 105 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
 106 enum nx_flow_mod_failed_code {
 107     /* Generic hardware error. */
 108     NXFMFC_HARDWARE = 0x100,
 109
 110     /* A nonexistent table ID was specified in the "command" field of struct
 111      * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
 112     NXFMFC_BAD_TABLE_ID = 0x101
 113 };
 114 \f
 115 /* Nicira vendor requests and replies. */
 116
 117 /* Header for Nicira vendor requests and replies. */
 118 struct nicira_header {
 119     struct ofp_header header;
 120     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 121     ovs_be32 subtype;           /* One of NXT_* below. */
 122 };
 123 OFP_ASSERT(sizeof(struct nicira_header) == 16);
 124
 125 /* Values for the 'subtype' member of struct nicira_header. */
 126 enum nicira_type {
 127     /* No longer used. */
 128     NXT_STATUS_REQUEST__OBSOLETE,
 129     NXT_STATUS_REPLY__OBSOLETE,
 130     NXT_ACT_SET_CONFIG__OBSOLETE,
 131     NXT_ACT_GET_CONFIG__OBSOLETE,
 132     NXT_COMMAND_REQUEST__OBSOLETE,
 133     NXT_COMMAND_REPLY__OBSOLETE,
 134     NXT_FLOW_END_CONFIG__OBSOLETE,
 135     NXT_FLOW_END__OBSOLETE,
 136     NXT_MGMT__OBSOLETE,
 137
 138     /* Use the high 32 bits of the cookie field as the tunnel ID in the flow
 139      * match. */
 140     NXT_TUN_ID_FROM_COOKIE,
 141
 142     /* Controller role support.  The request body is struct nx_role_request.
 143      * The reply echos the request. */
 144     NXT_ROLE_REQUEST,
 145     NXT_ROLE_REPLY,
 146
 147     /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
 148      * designate the table to which a flow is to be added?  See the big comment
 149      * on struct nxt_flow_mod_table_id for more information.
 150      *
 151      * A screwup caused this extension to be assigned the same value as
 152      * NXT_SET_FLOW_FORMAT (see below).  The two extensions do have different
 153      * lengths, so they can still be distinguished. */
 154     NXT_FLOW_MOD_TABLE_ID,
 155
 156     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 157     NXT_SET_FLOW_FORMAT = NXT_FLOW_MOD_TABLE_ID, /* Set flow format. */
 158     NXT_FLOW_MOD,               /* Analogous to OFPT_FLOW_MOD. */
 159     NXT_FLOW_REMOVED            /* Analogous to OFPT_FLOW_REMOVED. */
 160 };
 161
 162 /* Header for Nicira vendor stats request and reply messages. */
 163 struct nicira_stats_msg {
 164     struct ofp_header header;   /* OFPT_STATS_REQUEST or OFPT_STATS_REPLY. */
 165     ovs_be16 type;              /* OFPST_VENDOR. */
 166     ovs_be16 flags;             /* OFPSF_{REQ,REPLY}_*. */
 167     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 168     ovs_be32 subtype;           /* One of NXST_* below. */
 169     uint8_t pad[4];             /* Align to 64-bits. */
 170 };
 171 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
 172
 173 /* Values for the 'subtype' member of struct nicira_stats_msg. */
 174 enum nicira_stats_type {
 175     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 176     NXST_FLOW,                  /* Analogous to OFPST_FLOW. */
 177     NXST_AGGREGATE              /* Analogous to OFPST_AGGREGATE. */
 178 };
 179
 180 /* NXT_TUN_ID_FROM_COOKIE request. */
 181 struct nxt_tun_id_cookie {
 182     struct ofp_header header;
 183     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 184     ovs_be32 subtype;           /* NXT_TUN_ID_FROM_COOKIE */
 185     uint8_t set;                /* Nonzero to enable, zero to disable. */
 186     uint8_t pad[7];
 187 };
 188 OFP_ASSERT(sizeof(struct nxt_tun_id_cookie) == 24);
 189
 190 /* This command enables or disables an Open vSwitch extension that allows a
 191  * controller to specify the OpenFlow table to which a flow should be added,
 192  * instead of having the switch decide which table is most appropriate as
 193  * required by OpenFlow 1.0.  By default, the extension is disabled.
 194  *
 195  * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
 196  * 16-bit 'command' member as two separate fields.  The upper 8 bits are used
 197  * as the table ID, the lower 8 bits specify the command as usual.  A table ID
 198  * of 0xff is treated like a wildcarded table ID.
 199  *
 200  * The specific treatment of the table ID depends on the type of flow mod:
 201  *
 202  *    - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
 203  *      table.  If an identical flow already exists in that table only, then it
 204  *      is replaced.  If the flow cannot be placed in the specified table,
 205  *      either because the table is full or because the table cannot support
 206  *      flows of the given type, the switch replies with an
 207  *      OFPFMFC_ALL_TABLES_FULL error.  (A controller can distinguish these
 208  *      cases by comparing the current and maximum number of entries reported
 209  *      in ofp_table_stats.)
 210  *
 211  *      If the table ID is wildcarded, the switch picks an appropriate table
 212  *      itself.  If an identical flow already exist in the selected flow table,
 213  *      then it is replaced.  The choice of table might depend on the flows
 214  *      that are already in the switch; for example, if one table fills up then
 215  *      the switch might fall back to another one.
 216  *
 217  *    - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
 218  *      within that table are matched and modified or deleted.  If the table ID
 219  *      is wildcarded, flows within any table may be matched and modified or
 220  *      deleted.
 221  *
 222  *    - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
 223  *      only a flow within that table may be matched and modified or deleted.
 224  *      If the table ID is wildcarded and exactly one flow within any table
 225  *      matches, then it is modified or deleted; if flows in more than one
 226  *      table match, then none is modified or deleted.
 227  */
 228 struct nxt_flow_mod_table_id {
 229     struct ofp_header header;
 230     uint32_t vendor;            /* NX_VENDOR_ID. */
 231     uint32_t subtype;           /* NXT_FLOW_MOD_TABLE_ID. */
 232     uint8_t set;                /* Nonzero to enable, zero to disable. */
 233     uint8_t pad[7];
 234 };
 235 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
 236
 237 /* Configures the "role" of the sending controller.  The default role is:
 238  *
 239  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
 240  *      OpenFlow features.
 241  *
 242  * The other possible roles are a related pair:
 243  *
 244  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
 245  *      be at most one Master controller at a time: when a controller
 246  *      configures itself as Master, any existing Master is demoted to the
 247  *      Slave role.
 248  *
 249  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
 250  *      OpenFlow features.  In particular attempts to modify the flow table
 251  *      will be rejected with an OFPBRC_EPERM error.
 252  *
 253  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
 254  *      messages, but they do receive OFPT_PORT_STATUS messages.
 255  */
 256 struct nx_role_request {
 257     struct nicira_header nxh;
 258     ovs_be32 role;              /* One of NX_ROLE_*. */
 259 };
 260
 261 enum nx_role {
 262     NX_ROLE_OTHER,              /* Default role, full access. */
 263     NX_ROLE_MASTER,             /* Full access, at most one. */
 264     NX_ROLE_SLAVE               /* Read-only access. */
 265 };
 266 \f
 267 /* Nicira vendor flow actions. */
 268
 269 enum nx_action_subtype {
 270     NXAST_SNAT__OBSOLETE,       /* No longer used. */
 271     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
 272     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
 273     NXAST_DROP_SPOOFED_ARP,     /* struct nx_action_drop_spoofed_arp */
 274     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
 275     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
 276     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
 277     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
 278     NXAST_NOTE,                 /* struct nx_action_note */
 279     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
 280     NXAST_MULTIPATH,            /* struct nx_action_multipath */
 281     NXAST_AUTOPATH              /* struct nx_action_autopath */
 282 };
 283
 284 /* Header for Nicira-defined actions. */
 285 struct nx_action_header {
 286     ovs_be16 type;                  /* OFPAT_VENDOR. */
 287     ovs_be16 len;                   /* Length is 16. */
 288     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 289     ovs_be16 subtype;               /* NXAST_*. */
 290     uint8_t pad[6];
 291 };
 292 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
 293
 294 /* Action structure for NXAST_RESUBMIT.
 295  *
 296  * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
 297  * modified from the original lookup:
 298  *
 299  *    - The 'in_port' member of struct nx_action_resubmit is used as the flow's
 300  *      in_port.
 301  *
 302  *    - If NXAST_RESUBMIT is preceded by actions that affect the flow
 303  *      (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
 304  *      values.
 305  *
 306  * Following the lookup, the original in_port is restored.
 307  *
 308  * If the modified flow matched in the flow table, then the corresponding
 309  * actions are executed.  Afterward, actions following NXAST_RESUBMIT in the
 310  * original set of actions, if any, are executed; any changes made to the
 311  * packet (e.g. changes to VLAN) by secondary actions persist when those
 312  * actions are executed, although the original in_port is restored.
 313  *
 314  * NXAST_RESUBMIT may be used any number of times within a set of actions.
 315  *
 316  * NXAST_RESUBMIT may nest to an implementation-defined depth.  Beyond this
 317  * implementation-defined depth, further NXAST_RESUBMIT actions are simply
 318  * ignored.  (Open vSwitch 1.0.1 and earlier did not support recursion.)
 319  */
 320 struct nx_action_resubmit {
 321     ovs_be16 type;                  /* OFPAT_VENDOR. */
 322     ovs_be16 len;                   /* Length is 16. */
 323     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 324     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
 325     ovs_be16 in_port;               /* New in_port for checking flow table. */
 326     uint8_t pad[4];
 327 };
 328 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
 329
 330 /* Action structure for NXAST_SET_TUNNEL.
 331  *
 332  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
 333  * bits of the tunnel ID are set to 0. */
 334 struct nx_action_set_tunnel {
 335     ovs_be16 type;                  /* OFPAT_VENDOR. */
 336     ovs_be16 len;                   /* Length is 16. */
 337     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 338     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
 339     uint8_t pad[2];
 340     ovs_be32 tun_id;                /* Tunnel ID. */
 341 };
 342 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
 343
 344 /* Action structure for NXAST_SET_TUNNEL64.
 345  *
 346  * Sets the encapsulating tunnel ID to a 64-bit value. */
 347 struct nx_action_set_tunnel64 {
 348     ovs_be16 type;                  /* OFPAT_VENDOR. */
 349     ovs_be16 len;                   /* Length is 16. */
 350     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 351     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
 352     uint8_t pad[6];
 353     ovs_be64 tun_id;                /* Tunnel ID. */
 354 };
 355 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
 356
 357 /* Action structure for NXAST_DROP_SPOOFED_ARP.
 358  *
 359  * Stops processing further actions, if the packet being processed is an
 360  * Ethernet+IPv4 ARP packet for which the source Ethernet address inside the
 361  * ARP packet differs from the source Ethernet address in the Ethernet header.
 362  *
 363  * (This  action  is  deprecated in  favor of defining flows using the
 364  * NXM_NX_ARP_SHA flow match and will likely be removed in a future version
 365  * of Open vSwitch.) */
 366 struct nx_action_drop_spoofed_arp {
 367     ovs_be16 type;                  /* OFPAT_VENDOR. */
 368     ovs_be16 len;                   /* Length is 16. */
 369     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 370     ovs_be16 subtype;               /* NXAST_DROP_SPOOFED_ARP. */
 371     uint8_t pad[6];
 372 };
 373 OFP_ASSERT(sizeof(struct nx_action_drop_spoofed_arp) == 16);
 374
 375 /* Action structure for NXAST_SET_QUEUE.
 376  *
 377  * Set the queue that should be used when packets are output.  This is similar
 378  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
 379  * an argument.  This allows the queue to be defined before the port is
 380  * known. */
 381 struct nx_action_set_queue {
 382     ovs_be16 type;                  /* OFPAT_VENDOR. */
 383     ovs_be16 len;                   /* Length is 16. */
 384     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 385     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
 386     uint8_t pad[2];
 387     ovs_be32 queue_id;              /* Where to enqueue packets. */
 388 };
 389 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
 390
 391 /* Action structure for NXAST_POP_QUEUE.
 392  *
 393  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
 394  * were used.  Only the original queue can be restored this way; no stack is
 395  * maintained. */
 396 struct nx_action_pop_queue {
 397     ovs_be16 type;                  /* OFPAT_VENDOR. */
 398     ovs_be16 len;                   /* Length is 16. */
 399     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 400     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
 401     uint8_t pad[6];
 402 };
 403 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
 404
 405 /* Action structure for NXAST_REG_MOVE.
 406  *
 407  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
 408  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
 409  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
 410  * the next most significant bit, and so on.
 411  *
 412  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
 413  * sense to use nxm_hasmask=1 because the action does not do any kind of
 414  * matching; it uses the actual value of a field.)
 415  *
 416  * The following nxm_header values are potentially acceptable as 'src':
 417  *
 418  *   - NXM_OF_IN_PORT
 419  *   - NXM_OF_ETH_DST
 420  *   - NXM_OF_ETH_SRC
 421  *   - NXM_OF_ETH_TYPE
 422  *   - NXM_OF_VLAN_TCI
 423  *   - NXM_OF_IP_TOS
 424  *   - NXM_OF_IP_PROTO
 425  *   - NXM_OF_IP_SRC
 426  *   - NXM_OF_IP_DST
 427  *   - NXM_OF_TCP_SRC
 428  *   - NXM_OF_TCP_DST
 429  *   - NXM_OF_UDP_SRC
 430  *   - NXM_OF_UDP_DST
 431  *   - NXM_OF_ICMP_TYPE
 432  *   - NXM_OF_ICMP_CODE
 433  *   - NXM_OF_ARP_OP
 434  *   - NXM_OF_ARP_SPA
 435  *   - NXM_OF_ARP_TPA
 436  *   - NXM_NX_TUN_ID
 437  *   - NXM_NX_ARP_SHA
 438  *   - NXM_NX_ARP_THA
 439  *   - NXM_NX_ICMPV6_TYPE
 440  *   - NXM_NX_ICMPV6_CODE
 441  *   - NXM_NX_ND_SLL
 442  *   - NXM_NX_ND_TLL
 443  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 444  *
 445  * The following nxm_header values are potentially acceptable as 'dst':
 446  *
 447  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 448  *
 449  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
 450  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
 451  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
 452  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
 453  *     to the field's new value (with the CFI bit masked out).
 454  *
 455  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
 456  *     packet's next tunnel encapsulation.
 457  *
 458  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
 459  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
 460  * used only if the flow's nx_match includes an nxm_entry that specifies
 461  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
 462  *
 463  * The switch will reject actions for which src_ofs+n_bits is greater than the
 464  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
 465  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 466  */
 467 struct nx_action_reg_move {
 468     ovs_be16 type;                  /* OFPAT_VENDOR. */
 469     ovs_be16 len;                   /* Length is 16. */
 470     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 471     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
 472     ovs_be16 n_bits;                /* Number of bits. */
 473     ovs_be16 src_ofs;               /* Starting bit offset in source. */
 474     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
 475     ovs_be32 src;                   /* Source register. */
 476     ovs_be32 dst;                   /* Destination register. */
 477 };
 478 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
 479
 480 /* Action structure for NXAST_REG_LOAD.
 481  *
 482  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
 483  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
 484  * starts at 0 for the least-significant bit, 1 for the next most significant
 485  * bit, and so on.
 486  *
 487  * 'dst' is an nxm_header with nxm_hasmask=0.  See the documentation for
 488  * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
 489  * loading them.
 490  *
 491  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
 492  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
 493  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
 494  * also stored as one less than its true value:
 495  *
 496  *  15                           6 5                0
 497  * +------------------------------+------------------+
 498  * |              ofs             |    n_bits - 1    |
 499  * +------------------------------+------------------+
 500  *
 501  * The switch will reject actions for which ofs+n_bits is greater than the
 502  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
 503  * greater are set to 1, with error type OFPET_BAD_ACTION, code
 504  * OFPBAC_BAD_ARGUMENT.
 505  */
 506 struct nx_action_reg_load {
 507     ovs_be16 type;                  /* OFPAT_VENDOR. */
 508     ovs_be16 len;                   /* Length is 16. */
 509     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 510     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
 511     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
 512     ovs_be32 dst;                   /* Destination register. */
 513     ovs_be64 value;                 /* Immediate value. */
 514 };
 515 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
 516
 517 /* Action structure for NXAST_NOTE.
 518  *
 519  * This action has no effect.  It is variable length.  The switch does not
 520  * attempt to interpret the user-defined 'note' data in any way.  A controller
 521  * can use this action to attach arbitrary metadata to a flow.
 522  *
 523  * This action might go away in the future.
 524  */
 525 struct nx_action_note {
 526     ovs_be16 type;                  /* OFPAT_VENDOR. */
 527     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
 528     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 529     ovs_be16 subtype;               /* NXAST_NOTE. */
 530     uint8_t note[6];                /* Start of user-defined data. */
 531     /* Possibly followed by additional user-defined data. */
 532 };
 533 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
 534
 535 /* Action structure for NXAST_MULTIPATH.
 536  *
 537  * This action performs the following steps in sequence:
 538  *
 539  *    1. Hashes the fields designated by 'fields', one of NX_MP_FIELDS_*.
 540  *       Refer to the definition of "enum nx_mp_fields" for details.
 541  *
 542  *       The 'basis' value is used as a universal hash parameter, that is,
 543  *       different values of 'basis' yield different hash functions.  The
 544  *       particular universal hash function used is implementation-defined.
 545  *
 546  *       The hashed fields' values are drawn from the current state of the
 547  *       flow, including all modifications that have been made by actions up to
 548  *       this point.
 549  *
 550  *    2. Applies the multipath link choice algorithm specified by 'algorithm',
 551  *       one of NX_MP_ALG_*.  Refer to the definition of "enum nx_mp_algorithm"
 552  *       for details.
 553  *
 554  *       The output of the algorithm is 'link', an unsigned integer less than
 555  *       or equal to 'max_link'.
 556  *
 557  *       Some algorithms use 'arg' as an additional argument.
 558  *
 559  *    3. Stores 'link' in dst[ofs:ofs+n_bits].  The format and semantics of
 560  *       'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
 561  *       action, except that 'dst' must be NXM_NX_REG(idx) for 'idx' in the
 562  *       switch's supported range.
 563  *
 564  * The switch will reject actions that have an unknown 'fields', or an unknown
 565  * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
 566  * in which 'max_link' is greater than or equal to 2**n_bits, with error type
 567  * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 568  */
 569 struct nx_action_multipath {
 570     ovs_be16 type;              /* OFPAT_VENDOR. */
 571     ovs_be16 len;               /* Length is 32. */
 572     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 573     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
 574
 575     /* What fields to hash and how. */
 576     ovs_be16 fields;            /* One of NX_MP_FIELDS_*. */
 577     ovs_be16 basis;             /* Universal hash parameter. */
 578     ovs_be16 pad0;
 579
 580     /* Multipath link choice algorithm to apply to hash value. */
 581     ovs_be16 algorithm;         /* One of NX_MP_ALG_*. */
 582     ovs_be16 max_link;          /* Number of output links, minus 1. */
 583     ovs_be32 arg;               /* Algorithm-specific argument. */
 584     ovs_be16 pad1;
 585
 586     /* Where to store the result. */
 587     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
 588     ovs_be32 dst;               /* Destination register. */
 589 };
 590 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
 591
 592 /* NXAST_MULTIPATH: Fields to hash. */
 593 enum nx_mp_fields {
 594     /* Ethernet source address (NXM_OF_ETH_SRC) only. */
 595     NX_MP_FIELDS_ETH_SRC,
 596
 597     /* L2 through L4, symmetric across src/dst.  Specifically, each of the
 598      * following fields, if present, is hashed (slashes separate symmetric
 599      * pairs):
 600      *
 601      *  - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
 602      *  - NXM_OF_ETH_TYPE
 603      *  - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
 604      *  - NXM_OF_IP_PROTO
 605      *  - NXM_OF_IP_SRC / NXM_OF_IP_DST
 606      *  - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
 607      *  - NXM_OF_UDP_SRC / NXM_OF_UDP_DST
 608      */
 609     NX_MP_FIELDS_SYMMETRIC_L4
 610 };
 611
 612 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
 613  *
 614  * In the descriptions below, 'n_links' is max_link + 1. */
 615 enum nx_mp_algorithm {
 616     /* link = hash(flow) % n_links.
 617      *
 618      * Redistributes all traffic when n_links changes.  O(1) performance.  See
 619      * RFC 2992.
 620      *
 621      * Use UINT16_MAX for max_link to get a raw hash value. */
 622     NX_MP_ALG_MODULO_N,
 623
 624     /* link = hash(flow) / (MAX_HASH / n_links).
 625      *
 626      * Redistributes between one-quarter and one-half of traffic when n_links
 627      * changes.  O(1) performance.  See RFC 2992.
 628      */
 629     NX_MP_ALG_HASH_THRESHOLD,
 630
 631     /* for i in [0,n_links):
 632      *   weights[i] = hash(flow, i)
 633      * link = { i such that weights[i] >= weights[j] for all j != i }
 634      *
 635      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
 636      * performance.  If n_links is greater than a threshold (currently 64, but
 637      * subject to change), Open vSwitch will substitute another algorithm
 638      * automatically.  See RFC 2992. */
 639     NX_MP_ALG_HRW,              /* Highest Random Weight. */
 640
 641     /* i = 0
 642      * repeat:
 643      *     i = i + 1
 644      *     link = hash(flow, i) % arg
 645      * while link > max_link
 646      *
 647      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
 648      * performance when arg/max_link is bounded by a constant.
 649      *
 650      * Redistributes all traffic when arg changes.
 651      *
 652      * arg must be greater than max_link and for best performance should be no
 653      * more than approximately max_link * 2.  If arg is outside the acceptable
 654      * range, Open vSwitch will automatically substitute the least power of 2
 655      * greater than max_link.
 656      *
 657      * This algorithm is specific to Open vSwitch.
 658      */
 659     NX_MP_ALG_ITER_HASH         /* Iterative Hash. */
 660 };
 661
 662 /* Wildcard for tunnel ID. */
 663 #define NXFW_TUN_ID  (1 << 25)
 664
 665 #define NXFW_ALL NXFW_TUN_ID
 666 #define OVSFW_ALL (OFPFW_ALL | NXFW_ALL)
 667 \f
 668 /* Action structure for NXAST_AUTOPATH.
 669  *
 670  * This action performs the following steps in sequence:
 671  *
 672  *    1. Hashes the flow using an implementation-defined hash function.
 673  *
 674  *       The hashed fields' values are drawn from the current state of the
 675  *       flow, including all modifications that have been made by actions up to
 676  *       this point.
 677  *
 678  *    2. Selects an OpenFlow 'port'.
 679  *
 680  *       'port' is selected in an implementation-defined manner, taking into
 681  *       account 'id' and the hash value calculated in step 1.
 682  *
 683  *       Generally a switch will have been configured with a set of ports that
 684  *       may be chosen given 'id'.  The switch may take into account any number
 685  *       of factors when choosing 'port' from its configured set.  Factors may
 686  *       include carrier, load, and the results of configuration protocols such
 687  *       as LACP.
 688  *
 689  *    3. Stores 'port' in dst[ofs:ofs+n_bits].
 690  *
 691  *       The format and semantics of 'dst' and 'ofs_nbits' are similar to those
 692  *       for the NXAST_REG_LOAD action, except that 'dst' must be
 693  *       NXM_NX_REG(idx) for 'idx' in the switch's supported range.
 694  *
 695  * The switch will reject actions in which ofs+n_bits is greater than the width
 696  * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 697  */
 698 struct nx_action_autopath {
 699     ovs_be16 type;              /* OFPAT_VENDOR. */
 700     ovs_be16 len;               /* Length is 20. */
 701     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 702     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
 703
 704     /* Where to store the result. */
 705     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
 706     ovs_be32 dst;               /* Destination register. */
 707
 708     ovs_be32 id;                /* Autopath ID. */
 709     ovs_be32 pad;
 710 };
 711 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
 712 \f
 713 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
 714  *
 715  * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches.  This
 716  * structure is fixed-length and hence difficult to extend.  This section
 717  * describes a more flexible, variable-length flow match, called "nx_match" for
 718  * short, that is also supported by Open vSwitch.  This section also defines a
 719  * replacement for each OpenFlow message that includes struct ofp_match.
 720  *
 721  *
 722  * Format
 723  * ======
 724  *
 725  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
 726  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
 727  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
 728  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
 729  * "body".
 730  *
 731  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
 732  *
 733  * |<-------------------- nxm_type ------------------>|
 734  * |                                                  |
 735  * |31                              16 15            9| 8 7                0
 736  * +----------------------------------+---------------+--+------------------+
 737  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
 738  * +----------------------------------+---------------+--+------------------+
 739  *
 740  * The most-significant 23 bits of the header are collectively "nxm_type".
 741  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
 742  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
 743  * designates a protocol header, such as the Ethernet type, but it can also
 744  * refer to packet metadata, such as the switch port on which a packet arrived.
 745  *
 746  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
 747  * of this bit is explained later.
 748  *
 749  * The least-significant 8 bits are "nxm_length", a positive integer.  The
 750  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
 751  * bytes.
 752  *
 753  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
 754  * constant.  It is included only to allow software to minimally parse
 755  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
 756  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
 757  *
 758  *
 759  * Semantics
 760  * =========
 761  *
 762  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
 763  *
 764  * An nxm_entry places a constraint on the packets matched by the nx_match:
 765  *
 766  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
 767  *     field, called "nxm_value".  The nx_match matches only packets in which
 768  *     the field equals nxm_value.
 769  *
 770  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
 771  *     field (nxm_value), followed by a bitmask of the same length as the
 772  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
 773  *     nx_match matches only packets for which bit J in the given field's value
 774  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
 775  *     corresponding bits in nxm_value and the field's value to be ignored.
 776  *     (The sense of the nxm_mask bits is the opposite of that used by the
 777  *     "wildcards" member of struct ofp_match.)
 778  *
 779  *     When nxm_hasmask is 1, nxm_length is always even.
 780  *
 781  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
 782  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
 783  *     nxm_hasmask.
 784  *
 785  * When there are multiple "nxm_entry"s, all of the constraints must be met.
 786  *
 787  *
 788  * Mask Restrictions
 789  * =================
 790  *
 791  * Masks may be restricted:
 792  *
 793  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
 794  *     must always be 0 when these fields are specified.  For example, the
 795  *     field that identifies the port on which a packet was received may not be
 796  *     masked.
 797  *
 798  *   - Some nxm_types that do support masked wildcards may only support certain
 799  *     nxm_mask patterns.  For example, fields that have IPv4 address values
 800  *     may be restricted to CIDR masks.
 801  *
 802  * These restrictions should be noted in specifications for individual fields.
 803  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
 804  * disallows, if the switch correctly implements support for that nxm_hasmask
 805  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
 806  * contains a nxm_hasmask or nxm_mask value that it does not support.
 807  *
 808  *
 809  * Prerequisite Restrictions
 810  * =========================
 811  *
 812  * The presence of an nxm_entry with a given nxm_type may be restricted based
 813  * on the presence of or values of other "nxm_entry"s.  For example:
 814  *
 815  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
 816  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
 817  *     and nxm_value=0x0800.  That is, matching on the IP source address is
 818  *     allowed only if the Ethernet type is explicitly set to IP.
 819  *
 820  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
 821  *     by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
 822  *     nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
 823  *     nxm_hasmask=0, nxm_value=6, in that order.  That is, matching on the TCP
 824  *     source port is allowed only if the Ethernet type is IP and the IP
 825  *     protocol is TCP.
 826  *
 827  * These restrictions should be noted in specifications for individual fields.
 828  * A switch may implement relaxed versions of these restrictions.  A switch
 829  * must reject an attempt to set up a flow that violates its restrictions.
 830  *
 831  *
 832  * Ordering Restrictions
 833  * =====================
 834  *
 835  * An nxm_entry that has prerequisite restrictions must appear after the
 836  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
 837  * nx_match is not otherwise constrained.
 838  *
 839  * Any given nxm_type may appear in an nx_match at most once.
 840  *
 841  *
 842  * nxm_entry Examples
 843  * ==================
 844  *
 845  * These examples show the format of a single nxm_entry with particular
 846  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
 847  * numbers and byte indexes.
 848  *
 849  *
 850  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
 851  *
 852  *  0          3  4   5
 853  * +------------+---+---+
 854  * |   header   | v | m |
 855  * +------------+---+---+
 856  *
 857  *
 858  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
 859  *
 860  *  0          3 4    5
 861  * +------------+------+
 862  * |   header   | value|
 863  * +------------+------+
 864  *
 865  *
 866  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
 867  *
 868  *  0          3 4           7
 869  * +------------+-------------+
 870  * |   header   |  nxm_value  |
 871  * +------------+-------------+
 872  *
 873  *
 874  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
 875  *
 876  *  0          3 4                9
 877  * +------------+------------------+
 878  * |   header   |     nxm_value    |
 879  * +------------+------------------+
 880  *
 881  *
 882  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
 883  *
 884  *  0          3 4                9 10              15
 885  * +------------+------------------+------------------+
 886  * |   header   |     nxm_value    |      nxm_mask    |
 887  * +------------+------------------+------------------+
 888  *
 889  *
 890  * Error Reporting
 891  * ===============
 892  *
 893  * A switch should report an error in an nx_match using error type
 894  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
 895  * should report a specific error code, if one is assigned for the particular
 896  * problem, but NXBRC_NXM_INVALID is also available to report a generic
 897  * nx_match error.
 898  */
 899
 900 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
 901     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
 902 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
 903     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
 904 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
 905     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
 906 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
 907 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
 908 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
 909 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
 910 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
 911
 912 #define NXM_MAKE_WILD_HEADER(HEADER) \
 913         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
 914
 915 /* ## ------------------------------- ## */
 916 /* ## OpenFlow 1.0-compatible fields. ## */
 917 /* ## ------------------------------- ## */
 918
 919 /* Physical or virtual port on which the packet was received.
 920  *
 921  * Prereqs: None.
 922  *
 923  * Format: 16-bit integer in network byte order.
 924  *
 925  * Masking: Not maskable. */
 926 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
 927
 928 /* Source or destination address in Ethernet header.
 929  *
 930  * Prereqs: None.
 931  *
 932  * Format: 48-bit Ethernet MAC address.
 933  *
 934  * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
 935  *   be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
 936  *   are all-0-bits or all-1-bits).  Support for other patterns and for masking
 937  *   of NXM_OF_ETH_SRC is optional. */
 938 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
 939 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
 940 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
 941
 942 /* Packet's Ethernet type.
 943  *
 944  * For an Ethernet II packet this is taken from the Ethernet header.  For an
 945  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
 946  * A packet that has neither format has value 0x05ff
 947  * (OFP_DL_TYPE_NOT_ETH_TYPE).
 948  *
 949  * For a packet with an 802.1Q header, this is the type of the encapsulated
 950  * frame.
 951  *
 952  * Prereqs: None.
 953  *
 954  * Format: 16-bit integer in network byte order.
 955  *
 956  * Masking: Not maskable. */
 957 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
 958
 959 /* 802.1Q TCI.
 960  *
 961  * For a packet with an 802.1Q header, this is the Tag Control Information
 962  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
 963  * header, this has value 0.
 964  *
 965  * Prereqs: None.
 966  *
 967  * Format: 16-bit integer in network byte order.
 968  *
 969  * Masking: Arbitrary masks.
 970  *
 971  * This field can be used in various ways:
 972  *
 973  *   - If it is not constrained at all, the nx_match matches packets without
 974  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
 975  *
 976  *   - Testing for an exact match with 0 matches only packets without an
 977  *     802.1Q header.
 978  *
 979  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
 980  *     that have an 802.1Q header with a specified VID and PCP.
 981  *
 982  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
 983  *     not make sense.  The switch may reject this combination.
 984  *
 985  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
 986  *     packets that have an 802.1Q header with that VID (and any PCP).
 987  *
 988  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
 989  *     packets that have an 802.1Q header with that PCP (and any VID).
 990  *
 991  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
 992  *     header or with an 802.1Q header with a VID of 0.
 993  *
 994  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
 995  *     header or with an 802.1Q header with a PCP of 0.
 996  *
 997  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
 998  *     header or with an 802.1Q header with both VID and PCP of 0.
 999  */
1000 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
1001 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
1002
1003 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1004  *
1005  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1006  *
1007  * Format: 8-bit integer with 2 least-significant bits forced to 0.
1008  *
1009  * Masking: Not maskable. */
1010 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
1011
1012 /* The "protocol" byte in the IP header.
1013  *
1014  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1015  *
1016  * Format: 8-bit integer.
1017  *
1018  * Masking: Not maskable. */
1019 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
1020
1021 /* The source or destination address in the IP header.
1022  *
1023  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1024  *
1025  * Format: 32-bit integer in network byte order.
1026  *
1027  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1028  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1029 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
1030 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
1031 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
1032 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
1033
1034 /* The source or destination port in the TCP header.
1035  *
1036  * Prereqs:
1037  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1038  *   NXM_OF_IP_PROTO must match 6 exactly.
1039  *
1040  * Format: 16-bit integer in network byte order.
1041  *
1042  * Masking: Not maskable. */
1043 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
1044 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
1045
1046 /* The source or destination port in the UDP header.
1047  *
1048  * Prereqs:
1049  *   NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1050  *   NXM_OF_IP_PROTO must match 17 exactly.
1051  *
1052  * Format: 16-bit integer in network byte order.
1053  *
1054  * Masking: Not maskable. */
1055 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
1056 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
1057
1058 /* The type or code in the ICMP header.
1059  *
1060  * Prereqs:
1061  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
1062  *   NXM_OF_IP_PROTO must match 1 exactly.
1063  *
1064  * Format: 8-bit integer.
1065  *
1066  * Masking: Not maskable. */
1067 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
1068 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
1069
1070 /* ARP opcode.
1071  *
1072  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1073  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1074  * matching.
1075  *
1076  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1077  *
1078  * Format: 16-bit integer in network byte order.
1079  *
1080  * Masking: Not maskable. */
1081 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
1082
1083 /* For an Ethernet+IP ARP packet, the source or target protocol address
1084  * in the ARP header.  Always 0 otherwise.
1085  *
1086  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1087  *
1088  * Format: 32-bit integer in network byte order.
1089  *
1090  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1091  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1092 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
1093 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
1094 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
1095 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
1096
1097 /* ## ------------------------ ## */
1098 /* ## Nicira match extensions. ## */
1099 /* ## ------------------------ ## */
1100
1101 /* Metadata registers.
1102  *
1103  * Registers initially have value 0.  Actions allow register values to be
1104  * manipulated.
1105  *
1106  * Prereqs: None.
1107  *
1108  * Format: Array of 32-bit integer registers.  Space is reserved for up to
1109  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
1110  *
1111  * Masking: Arbitrary masks. */
1112 #define NXM_NX_MAX_REGS 16
1113 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
1114 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1115 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1116 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1117 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1118 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
1119 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
1120 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
1121 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
1122 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
1123 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
1124 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
1125 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
1126
1127 /* Tunnel ID.
1128  *
1129  * For a packet received via GRE tunnel including a (32-bit) key, the key is
1130  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
1131  * the value is 0.
1132  *
1133  * Prereqs: None.
1134  *
1135  * Format: 64-bit integer in network byte order.
1136  *
1137  * Masking: Arbitrary masks. */
1138 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
1139 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
1140
1141 /* For an Ethernet+IP ARP packet, the source or target hardware address
1142  * in the ARP header.  Always 0 otherwise.
1143  *
1144  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1145  *
1146  * Format: 48-bit Ethernet MAC address.
1147  *
1148  * Masking: Not maskable. */
1149 #define NXM_NX_ARP_SHA    NXM_HEADER  (0x0001, 17, 6)
1150 #define NXM_NX_ARP_THA    NXM_HEADER  (0x0001, 18, 6)
1151
1152 /* The source or destination address in the IPv6 header.
1153  *
1154  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1155  *
1156  * Format: 128-bit IPv6 address.
1157  *
1158  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1159  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1160 #define NXM_NX_IPV6_SRC    NXM_HEADER  (0x0001, 19, 16)
1161 #define NXM_NX_IPV6_SRC_W  NXM_HEADER_W(0x0001, 19, 16)
1162 #define NXM_NX_IPV6_DST    NXM_HEADER  (0x0001, 20, 16)
1163 #define NXM_NX_IPV6_DST_W  NXM_HEADER_W(0x0001, 20, 16)
1164
1165 /* The type or code in the ICMPv6 header.
1166  *
1167  * Prereqs:
1168  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1169  *   NXM_OF_IP_PROTO must match 58 exactly.
1170  *
1171  * Format: 8-bit integer.
1172  *
1173  * Masking: Not maskable. */
1174 #define NXM_NX_ICMPV6_TYPE NXM_HEADER  (0x0001, 21, 1)
1175 #define NXM_NX_ICMPV6_CODE NXM_HEADER  (0x0001, 22, 1)
1176
1177 /* The target address in an IPv6 Neighbor Discovery message.
1178  *
1179  * Prereqs:
1180  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1181  *   NXM_OF_IP_PROTO must match 58 exactly.
1182  *   NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1183  *
1184  * Format: 128-bit IPv6 address.
1185  *
1186  * Masking: Not maskable. */
1187 #define NXM_NX_ND_TARGET   NXM_HEADER  (0x0001, 23, 16)
1188
1189 /* The source link-layer address option in an IPv6 Neighbor Discovery
1190  * message.
1191  *
1192  * Prereqs:
1193  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1194  *   NXM_OF_IP_PROTO must match 58 exactly.
1195  *   NXM_OF_ICMPV6_TYPE must be exactly 135.
1196  *
1197  * Format: 48-bit Ethernet MAC address.
1198  *
1199  * Masking: Not maskable. */
1200 #define NXM_NX_ND_SLL      NXM_HEADER  (0x0001, 24, 6)
1201
1202 /* The target link-layer address option in an IPv6 Neighbor Discovery
1203  * message.
1204  *
1205  * Prereqs:
1206  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1207  *   NXM_OF_IP_PROTO must match 58 exactly.
1208  *   NXM_OF_ICMPV6_TYPE must be exactly 136.
1209  *
1210  * Format: 48-bit Ethernet MAC address.
1211  *
1212  * Masking: Not maskable. */
1213 #define NXM_NX_ND_TLL      NXM_HEADER  (0x0001, 25, 6)
1214
1215
1216 /* ## --------------------- ## */
1217 /* ## Requests and replies. ## */
1218 /* ## --------------------- ## */
1219
1220 enum nx_flow_format {
1221     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
1222     NXFF_TUN_ID_FROM_COOKIE = 1, /* OpenFlow 1.0, plus obtain tunnel ID from
1223                                   * cookie. */
1224     NXFF_NXM = 2                 /* Nicira extended match. */
1225 };
1226
1227 /* NXT_SET_FLOW_FORMAT request. */
1228 struct nxt_set_flow_format {
1229     struct ofp_header header;
1230     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1231     ovs_be32 subtype;           /* NXT_SET_FLOW_FORMAT. */
1232     ovs_be32 format;            /* One of NXFF_*. */
1233 };
1234 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1235
1236 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1237 struct nx_flow_mod {
1238     struct nicira_header nxh;
1239     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
1240     ovs_be16 command;             /* One of OFPFC_*. */
1241     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
1242     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
1243     ovs_be16 priority;            /* Priority level of flow entry. */
1244     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
1245                                      Not meaningful for OFPFC_DELETE*. */
1246     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
1247                                      matching entries to include this as an
1248                                      output port.  A value of OFPP_NONE
1249                                      indicates no restriction. */
1250     ovs_be16 flags;               /* One of OFPFF_*. */
1251     ovs_be16 match_len;           /* Size of nx_match. */
1252     uint8_t pad[6];               /* Align to 64-bits. */
1253     /* Followed by:
1254      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1255      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1256      *     all-zero bytes, then
1257      *   - Actions to fill out the remainder of the message length (always a
1258      *     multiple of 8).
1259      */
1260 };
1261 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1262
1263 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1264 struct nx_flow_removed {
1265     struct nicira_header nxh;
1266     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1267     ovs_be16 priority;        /* Priority level of flow entry. */
1268     uint8_t reason;           /* One of OFPRR_*. */
1269     uint8_t pad[1];           /* Align to 32-bits. */
1270     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
1271     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
1272                                  duration_sec. */
1273     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
1274     ovs_be16 match_len;       /* Size of nx_match. */
1275     ovs_be64 packet_count;
1276     ovs_be64 byte_count;
1277     /* Followed by:
1278      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1279      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1280      *     all-zero bytes. */
1281 };
1282 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1283
1284 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1285  * request). */
1286 struct nx_flow_stats_request {
1287     struct nicira_stats_msg nsm;
1288     ovs_be16 out_port;        /* Require matching entries to include this
1289                                  as an output port.  A value of OFPP_NONE
1290                                  indicates no restriction. */
1291     ovs_be16 match_len;       /* Length of nx_match. */
1292     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1293                                  or 0xff for all tables. */
1294     uint8_t pad[3];           /* Align to 64 bits. */
1295     /* Followed by:
1296      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1297      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1298      *     all-zero bytes, which must also exactly fill out the length of the
1299      *     message.
1300      */
1301 };
1302 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1303
1304 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1305  * OFPST_FLOW reply). */
1306 struct nx_flow_stats {
1307     ovs_be16 length;          /* Length of this entry. */
1308     uint8_t table_id;         /* ID of table flow came from. */
1309     uint8_t pad;
1310     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1311     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1312                                  beyond duration_sec. */
1313     ovs_be16 priority;        /* Priority of the entry. Only meaningful
1314                                  when this is not an exact-match entry. */
1315     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1316     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1317     ovs_be16 match_len;       /* Length of nx_match. */
1318     uint8_t pad2[4];          /* Align to 64 bits. */
1319     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1320     ovs_be64 packet_count;    /* Number of packets in flow. */
1321     ovs_be64 byte_count;      /* Number of bytes in flow. */
1322     /* Followed by:
1323      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1324      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1325      *     all-zero bytes, then
1326      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1327      *     of 8).
1328      */
1329 };
1330 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1331
1332 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1333  * OFPST_AGGREGATE request). */
1334 struct nx_aggregate_stats_request {
1335     struct nicira_stats_msg nsm;
1336     ovs_be16 out_port;        /* Require matching entries to include this
1337                                  as an output port.  A value of OFPP_NONE
1338                                  indicates no restriction. */
1339     ovs_be16 match_len;       /* Length of nx_match. */
1340     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1341                                  or 0xff for all tables. */
1342     uint8_t pad[3];           /* Align to 64 bits. */
1343     /* Followed by:
1344      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1345      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1346      *     all-zero bytes, which must also exactly fill out the length of the
1347      *     message.
1348      */
1349 };
1350 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1351
1352 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1353  * OFPST_AGGREGATE reply).
1354  *
1355  * ofp_aggregate_stats_reply does not contain an ofp_match structure, so we
1356  * reuse it entirely.  (It would be very odd to use OFPST_AGGREGATE to reply to
1357  * an NXST_AGGREGATE request, so we don't do that.) */
1358 struct nx_aggregate_stats_reply {
1359     struct nicira_stats_msg nsm;
1360     struct ofp_aggregate_stats_reply asr;
1361 };
1362 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1363
1364 #endif /* openflow/nicira-ext.h */