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 = 0,
 129     NXT_STATUS_REPLY__OBSOLETE = 1,
 130     NXT_ACT_SET_CONFIG__OBSOLETE = 2,
 131     NXT_ACT_GET_CONFIG__OBSOLETE = 3,
 132     NXT_COMMAND_REQUEST__OBSOLETE = 4,
 133     NXT_COMMAND_REPLY__OBSOLETE = 5,
 134     NXT_FLOW_END_CONFIG__OBSOLETE = 6,
 135     NXT_FLOW_END__OBSOLETE = 7,
 136     NXT_MGMT__OBSOLETE = 8,
 137     NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
 138
 139     /* Controller role support.  The request body is struct nx_role_request.
 140      * The reply echos the request. */
 141     NXT_ROLE_REQUEST = 10,
 142     NXT_ROLE_REPLY = 11,
 143
 144     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 145     NXT_SET_FLOW_FORMAT = 12,   /* Set flow format. */
 146     NXT_FLOW_MOD = 13,          /* Analogous to OFPT_FLOW_MOD. */
 147     NXT_FLOW_REMOVED = 14,      /* Analogous to OFPT_FLOW_REMOVED. */
 148
 149     /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
 150      * designate the table to which a flow is to be added?  See the big comment
 151      * on struct nxt_flow_mod_table_id for more information. */
 152     NXT_FLOW_MOD_TABLE_ID = 15
 153 };
 154
 155 /* Header for Nicira vendor stats request and reply messages. */
 156 struct nicira_stats_msg {
 157     struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
 158     ovs_be32 subtype;           /* One of NXST_* below. */
 159     uint8_t pad[4];             /* Align to 64-bits. */
 160 };
 161 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
 162
 163 /* Values for the 'subtype' member of struct nicira_stats_msg. */
 164 enum nicira_stats_type {
 165     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
 166     NXST_FLOW,                  /* Analogous to OFPST_FLOW. */
 167     NXST_AGGREGATE              /* Analogous to OFPST_AGGREGATE. */
 168 };
 169
 170 /* Fields to use when hashing flows. */
 171 enum nx_hash_fields {
 172     /* Ethernet source address (NXM_OF_ETH_SRC) only. */
 173     NX_HASH_FIELDS_ETH_SRC,
 174
 175     /* L2 through L4, symmetric across src/dst.  Specifically, each of the
 176      * following fields, if present, is hashed (slashes separate symmetric
 177      * pairs):
 178      *
 179      *  - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
 180      *  - NXM_OF_ETH_TYPE
 181      *  - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
 182      *  - NXM_OF_IP_PROTO
 183      *  - NXM_OF_IP_SRC / NXM_OF_IP_DST
 184      *  - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
 185      */
 186     NX_HASH_FIELDS_SYMMETRIC_L4
 187 };
 188
 189 /* This command enables or disables an Open vSwitch extension that allows a
 190  * controller to specify the OpenFlow table to which a flow should be added,
 191  * instead of having the switch decide which table is most appropriate as
 192  * required by OpenFlow 1.0.  By default, the extension is disabled.
 193  *
 194  * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
 195  * 16-bit 'command' member as two separate fields.  The upper 8 bits are used
 196  * as the table ID, the lower 8 bits specify the command as usual.  A table ID
 197  * of 0xff is treated like a wildcarded table ID.
 198  *
 199  * The specific treatment of the table ID depends on the type of flow mod:
 200  *
 201  *    - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
 202  *      table.  If an identical flow already exists in that table only, then it
 203  *      is replaced.  If the flow cannot be placed in the specified table,
 204  *      either because the table is full or because the table cannot support
 205  *      flows of the given type, the switch replies with an
 206  *      OFPFMFC_ALL_TABLES_FULL error.  (A controller can distinguish these
 207  *      cases by comparing the current and maximum number of entries reported
 208  *      in ofp_table_stats.)
 209  *
 210  *      If the table ID is wildcarded, the switch picks an appropriate table
 211  *      itself.  If an identical flow already exist in the selected flow table,
 212  *      then it is replaced.  The choice of table might depend on the flows
 213  *      that are already in the switch; for example, if one table fills up then
 214  *      the switch might fall back to another one.
 215  *
 216  *    - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
 217  *      within that table are matched and modified or deleted.  If the table ID
 218  *      is wildcarded, flows within any table may be matched and modified or
 219  *      deleted.
 220  *
 221  *    - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
 222  *      only a flow within that table may be matched and modified or deleted.
 223  *      If the table ID is wildcarded and exactly one flow within any table
 224  *      matches, then it is modified or deleted; if flows in more than one
 225  *      table match, then none is modified or deleted.
 226  */
 227 struct nxt_flow_mod_table_id {
 228     struct ofp_header header;
 229     uint32_t vendor;            /* NX_VENDOR_ID. */
 230     uint32_t subtype;           /* NXT_FLOW_MOD_TABLE_ID. */
 231     uint8_t set;                /* Nonzero to enable, zero to disable. */
 232     uint8_t pad[7];
 233 };
 234 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
 235
 236 /* Configures the "role" of the sending controller.  The default role is:
 237  *
 238  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
 239  *      OpenFlow features.
 240  *
 241  * The other possible roles are a related pair:
 242  *
 243  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
 244  *      be at most one Master controller at a time: when a controller
 245  *      configures itself as Master, any existing Master is demoted to the
 246  *      Slave role.
 247  *
 248  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
 249  *      OpenFlow features.  In particular attempts to modify the flow table
 250  *      will be rejected with an OFPBRC_EPERM error.
 251  *
 252  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
 253  *      messages, but they do receive OFPT_PORT_STATUS messages.
 254  */
 255 struct nx_role_request {
 256     struct nicira_header nxh;
 257     ovs_be32 role;              /* One of NX_ROLE_*. */
 258 };
 259
 260 enum nx_role {
 261     NX_ROLE_OTHER,              /* Default role, full access. */
 262     NX_ROLE_MASTER,             /* Full access, at most one. */
 263     NX_ROLE_SLAVE               /* Read-only access. */
 264 };
 265 \f
 266 /* Nicira vendor flow actions. */
 267
 268 enum nx_action_subtype {
 269     NXAST_SNAT__OBSOLETE,       /* No longer used. */
 270     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
 271     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
 272     NXAST_DROP_SPOOFED_ARP__OBSOLETE,
 273     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
 274     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
 275     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
 276     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
 277     NXAST_NOTE,                 /* struct nx_action_note */
 278     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
 279     NXAST_MULTIPATH,            /* struct nx_action_multipath */
 280     NXAST_AUTOPATH,             /* struct nx_action_autopath */
 281     NXAST_BUNDLE,               /* struct nx_action_bundle */
 282     NXAST_BUNDLE_LOAD,          /* struct nx_action_bundle */
 283     NXAST_RESUBMIT_TABLE,       /* struct nx_action_resubmit */
 284     NXAST_OUTPUT_REG,           /* struct nx_action_output_reg */
 285     NXAST_LEARN                 /* struct nx_action_learn */
 286 };
 287
 288 /* Header for Nicira-defined actions. */
 289 struct nx_action_header {
 290     ovs_be16 type;                  /* OFPAT_VENDOR. */
 291     ovs_be16 len;                   /* Length is 16. */
 292     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 293     ovs_be16 subtype;               /* NXAST_*. */
 294     uint8_t pad[6];
 295 };
 296 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
 297
 298 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
 299  *
 300  * These actions search one of the switch's flow tables:
 301  *
 302  *    - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
 303  *      it specifies the table to search.
 304  *
 305  *    - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
 306  *      NXAST_RESUBMIT regardless of 'table'), it searches the current flow
 307  *      table, that is, the OpenFlow flow table that contains the flow from
 308  *      which this action was obtained.  If this action did not come from a
 309  *      flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
 310  *      is the current table.
 311  *
 312  * The flow table lookup uses a flow that may be slightly modified from the
 313  * original lookup:
 314  *
 315  *    - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
 316  *      is used as the flow's in_port.
 317  *
 318  *    - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
 319  *      then its value is used as the flow's in_port.  Otherwise, the original
 320  *      in_port is used.
 321  *
 322  *    - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
 323  *      resubmit action, then the flow is updated with the new values.
 324  *
 325  * Following the lookup, the original in_port is restored.
 326  *
 327  * If the modified flow matched in the flow table, then the corresponding
 328  * actions are executed.  Afterward, actions following the resubmit in the
 329  * original set of actions, if any, are executed; any changes made to the
 330  * packet (e.g. changes to VLAN) by secondary actions persist when those
 331  * actions are executed, although the original in_port is restored.
 332  *
 333  * Resubmit actions may be used any number of times within a set of actions.
 334  *
 335  * Resubmit actions may nest to an implementation-defined depth.  Beyond this
 336  * implementation-defined depth, further resubmit actions are simply ignored.
 337  *
 338  * NXAST_RESUBMIT ignores 'table' and 'pad'.  NXAST_RESUBMIT_TABLE requires
 339  * 'pad' to be all-bits-zero.
 340  *
 341  * Open vSwitch 1.0.1 and earlier did not support recursion.  Open vSwitch
 342  * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
 343  */
 344 struct nx_action_resubmit {
 345     ovs_be16 type;                  /* OFPAT_VENDOR. */
 346     ovs_be16 len;                   /* Length is 16. */
 347     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 348     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
 349     ovs_be16 in_port;               /* New in_port for checking flow table. */
 350     uint8_t table;                  /* NXAST_RESUBMIT_TABLE: table to use. */
 351     uint8_t pad[3];
 352 };
 353 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
 354
 355 /* Action structure for NXAST_SET_TUNNEL.
 356  *
 357  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
 358  * bits of the tunnel ID are set to 0. */
 359 struct nx_action_set_tunnel {
 360     ovs_be16 type;                  /* OFPAT_VENDOR. */
 361     ovs_be16 len;                   /* Length is 16. */
 362     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 363     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
 364     uint8_t pad[2];
 365     ovs_be32 tun_id;                /* Tunnel ID. */
 366 };
 367 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
 368
 369 /* Action structure for NXAST_SET_TUNNEL64.
 370  *
 371  * Sets the encapsulating tunnel ID to a 64-bit value. */
 372 struct nx_action_set_tunnel64 {
 373     ovs_be16 type;                  /* OFPAT_VENDOR. */
 374     ovs_be16 len;                   /* Length is 16. */
 375     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 376     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
 377     uint8_t pad[6];
 378     ovs_be64 tun_id;                /* Tunnel ID. */
 379 };
 380 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
 381
 382 /* Action structure for NXAST_SET_QUEUE.
 383  *
 384  * Set the queue that should be used when packets are output.  This is similar
 385  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
 386  * an argument.  This allows the queue to be defined before the port is
 387  * known. */
 388 struct nx_action_set_queue {
 389     ovs_be16 type;                  /* OFPAT_VENDOR. */
 390     ovs_be16 len;                   /* Length is 16. */
 391     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 392     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
 393     uint8_t pad[2];
 394     ovs_be32 queue_id;              /* Where to enqueue packets. */
 395 };
 396 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
 397
 398 /* Action structure for NXAST_POP_QUEUE.
 399  *
 400  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
 401  * were used.  Only the original queue can be restored this way; no stack is
 402  * maintained. */
 403 struct nx_action_pop_queue {
 404     ovs_be16 type;                  /* OFPAT_VENDOR. */
 405     ovs_be16 len;                   /* Length is 16. */
 406     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 407     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
 408     uint8_t pad[6];
 409 };
 410 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
 411
 412 /* Action structure for NXAST_REG_MOVE.
 413  *
 414  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
 415  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
 416  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
 417  * the next most significant bit, and so on.
 418  *
 419  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
 420  * sense to use nxm_hasmask=1 because the action does not do any kind of
 421  * matching; it uses the actual value of a field.)
 422  *
 423  * The following nxm_header values are potentially acceptable as 'src':
 424  *
 425  *   - NXM_OF_IN_PORT
 426  *   - NXM_OF_ETH_DST
 427  *   - NXM_OF_ETH_SRC
 428  *   - NXM_OF_ETH_TYPE
 429  *   - NXM_OF_VLAN_TCI
 430  *   - NXM_OF_IP_TOS
 431  *   - NXM_OF_IP_PROTO
 432  *   - NXM_OF_IP_SRC
 433  *   - NXM_OF_IP_DST
 434  *   - NXM_OF_TCP_SRC
 435  *   - NXM_OF_TCP_DST
 436  *   - NXM_OF_UDP_SRC
 437  *   - NXM_OF_UDP_DST
 438  *   - NXM_OF_ICMP_TYPE
 439  *   - NXM_OF_ICMP_CODE
 440  *   - NXM_OF_ARP_OP
 441  *   - NXM_OF_ARP_SPA
 442  *   - NXM_OF_ARP_TPA
 443  *   - NXM_NX_TUN_ID
 444  *   - NXM_NX_ARP_SHA
 445  *   - NXM_NX_ARP_THA
 446  *   - NXM_NX_ICMPV6_TYPE
 447  *   - NXM_NX_ICMPV6_CODE
 448  *   - NXM_NX_ND_SLL
 449  *   - NXM_NX_ND_TLL
 450  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 451  *
 452  * The following nxm_header values are potentially acceptable as 'dst':
 453  *
 454  *   - NXM_OF_ETH_DST
 455  *   - NXM_OF_ETH_SRC
 456  *   - NXM_OF_IP_TOS
 457  *   - NXM_OF_IP_SRC
 458  *   - NXM_OF_IP_DST
 459  *   - NXM_OF_TCP_SRC
 460  *   - NXM_OF_TCP_DST
 461  *   - NXM_OF_UDP_SRC
 462  *   - NXM_OF_UDP_DST
 463  *     Modifying any of the above fields changes the corresponding packet
 464  *     header.
 465  *
 466  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
 467  *
 468  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
 469  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
 470  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
 471  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
 472  *     to the field's new value (with the CFI bit masked out).
 473  *
 474  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
 475  *     packet's next tunnel encapsulation.
 476  *
 477  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
 478  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
 479  * used only if the flow's nx_match includes an nxm_entry that specifies
 480  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
 481  *
 482  * The switch will reject actions for which src_ofs+n_bits is greater than the
 483  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
 484  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 485  */
 486 struct nx_action_reg_move {
 487     ovs_be16 type;                  /* OFPAT_VENDOR. */
 488     ovs_be16 len;                   /* Length is 16. */
 489     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 490     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
 491     ovs_be16 n_bits;                /* Number of bits. */
 492     ovs_be16 src_ofs;               /* Starting bit offset in source. */
 493     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
 494     ovs_be32 src;                   /* Source register. */
 495     ovs_be32 dst;                   /* Destination register. */
 496 };
 497 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
 498
 499 /* Action structure for NXAST_REG_LOAD.
 500  *
 501  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
 502  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
 503  * starts at 0 for the least-significant bit, 1 for the next most significant
 504  * bit, and so on.
 505  *
 506  * 'dst' is an nxm_header with nxm_hasmask=0.  See the documentation for
 507  * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
 508  * loading them.
 509  *
 510  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
 511  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
 512  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
 513  * also stored as one less than its true value:
 514  *
 515  *  15                           6 5                0
 516  * +------------------------------+------------------+
 517  * |              ofs             |    n_bits - 1    |
 518  * +------------------------------+------------------+
 519  *
 520  * The switch will reject actions for which ofs+n_bits is greater than the
 521  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
 522  * greater are set to 1, with error type OFPET_BAD_ACTION, code
 523  * OFPBAC_BAD_ARGUMENT.
 524  */
 525 struct nx_action_reg_load {
 526     ovs_be16 type;                  /* OFPAT_VENDOR. */
 527     ovs_be16 len;                   /* Length is 16. */
 528     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 529     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
 530     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
 531     ovs_be32 dst;                   /* Destination register. */
 532     ovs_be64 value;                 /* Immediate value. */
 533 };
 534 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
 535
 536 /* Action structure for NXAST_NOTE.
 537  *
 538  * This action has no effect.  It is variable length.  The switch does not
 539  * attempt to interpret the user-defined 'note' data in any way.  A controller
 540  * can use this action to attach arbitrary metadata to a flow.
 541  *
 542  * This action might go away in the future.
 543  */
 544 struct nx_action_note {
 545     ovs_be16 type;                  /* OFPAT_VENDOR. */
 546     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
 547     ovs_be32 vendor;                /* NX_VENDOR_ID. */
 548     ovs_be16 subtype;               /* NXAST_NOTE. */
 549     uint8_t note[6];                /* Start of user-defined data. */
 550     /* Possibly followed by additional user-defined data. */
 551 };
 552 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
 553
 554 /* Action structure for NXAST_MULTIPATH.
 555  *
 556  * This action performs the following steps in sequence:
 557  *
 558  *    1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
 559  *       Refer to the definition of "enum nx_mp_fields" for details.
 560  *
 561  *       The 'basis' value is used as a universal hash parameter, that is,
 562  *       different values of 'basis' yield different hash functions.  The
 563  *       particular universal hash function used is implementation-defined.
 564  *
 565  *       The hashed fields' values are drawn from the current state of the
 566  *       flow, including all modifications that have been made by actions up to
 567  *       this point.
 568  *
 569  *    2. Applies the multipath link choice algorithm specified by 'algorithm',
 570  *       one of NX_MP_ALG_*.  Refer to the definition of "enum nx_mp_algorithm"
 571  *       for details.
 572  *
 573  *       The output of the algorithm is 'link', an unsigned integer less than
 574  *       or equal to 'max_link'.
 575  *
 576  *       Some algorithms use 'arg' as an additional argument.
 577  *
 578  *    3. Stores 'link' in dst[ofs:ofs+n_bits].  The format and semantics of
 579  *       'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
 580  *       action.
 581  *
 582  * The switch will reject actions that have an unknown 'fields', or an unknown
 583  * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
 584  * in which 'max_link' is greater than or equal to 2**n_bits, with error type
 585  * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 586  */
 587 struct nx_action_multipath {
 588     ovs_be16 type;              /* OFPAT_VENDOR. */
 589     ovs_be16 len;               /* Length is 32. */
 590     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 591     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
 592
 593     /* What fields to hash and how. */
 594     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
 595     ovs_be16 basis;             /* Universal hash parameter. */
 596     ovs_be16 pad0;
 597
 598     /* Multipath link choice algorithm to apply to hash value. */
 599     ovs_be16 algorithm;         /* One of NX_MP_ALG_*. */
 600     ovs_be16 max_link;          /* Number of output links, minus 1. */
 601     ovs_be32 arg;               /* Algorithm-specific argument. */
 602     ovs_be16 pad1;
 603
 604     /* Where to store the result. */
 605     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
 606     ovs_be32 dst;               /* Destination. */
 607 };
 608 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
 609
 610 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
 611  *
 612  * In the descriptions below, 'n_links' is max_link + 1. */
 613 enum nx_mp_algorithm {
 614     /* link = hash(flow) % n_links.
 615      *
 616      * Redistributes all traffic when n_links changes.  O(1) performance.  See
 617      * RFC 2992.
 618      *
 619      * Use UINT16_MAX for max_link to get a raw hash value. */
 620     NX_MP_ALG_MODULO_N,
 621
 622     /* link = hash(flow) / (MAX_HASH / n_links).
 623      *
 624      * Redistributes between one-quarter and one-half of traffic when n_links
 625      * changes.  O(1) performance.  See RFC 2992.
 626      */
 627     NX_MP_ALG_HASH_THRESHOLD,
 628
 629     /* for i in [0,n_links):
 630      *   weights[i] = hash(flow, i)
 631      * link = { i such that weights[i] >= weights[j] for all j != i }
 632      *
 633      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
 634      * performance.  If n_links is greater than a threshold (currently 64, but
 635      * subject to change), Open vSwitch will substitute another algorithm
 636      * automatically.  See RFC 2992. */
 637     NX_MP_ALG_HRW,              /* Highest Random Weight. */
 638
 639     /* i = 0
 640      * repeat:
 641      *     i = i + 1
 642      *     link = hash(flow, i) % arg
 643      * while link > max_link
 644      *
 645      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
 646      * performance when arg/max_link is bounded by a constant.
 647      *
 648      * Redistributes all traffic when arg changes.
 649      *
 650      * arg must be greater than max_link and for best performance should be no
 651      * more than approximately max_link * 2.  If arg is outside the acceptable
 652      * range, Open vSwitch will automatically substitute the least power of 2
 653      * greater than max_link.
 654      *
 655      * This algorithm is specific to Open vSwitch.
 656      */
 657     NX_MP_ALG_ITER_HASH         /* Iterative Hash. */
 658 };
 659 \f
 660 /* Action structure for NXAST_LEARN.
 661  *
 662  * This action adds or modifies a flow in an OpenFlow table, similar to
 663  * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'.  The new flow has the
 664  * specified idle timeout, hard timeout, priority, cookie, and flags.  The new
 665  * flow's match criteria and actions are built by applying each of the series
 666  * of flow_mod_spec elements included as part of the action.
 667  *
 668  * A flow_mod_spec starts with a 16-bit header.  A header that is all-bits-0 is
 669  * a no-op used for padding the action as a whole to a multiple of 8 bytes in
 670  * length.  Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
 671  * bits from a source to a destination.  In this case, the header contains
 672  * multiple fields:
 673  *
 674  *  15  14  13 12  11 10                              0
 675  * +------+---+------+---------------------------------+
 676  * |   0  |src|  dst |             n_bits              |
 677  * +------+---+------+---------------------------------+
 678  *
 679  * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'.  The
 680  * following table summarizes the meaning of each possible combination.
 681  * Details follow the table:
 682  *
 683  *   src dst  meaning
 684  *   --- ---  ----------------------------------------------------------
 685  *    0   0   Add match criteria based on value in a field.
 686  *    1   0   Add match criteria based on an immediate value.
 687  *    0   1   Add NXAST_REG_LOAD action to copy field into a different field.
 688  *    1   1   Add NXAST_REG_LOAD action to load immediate value into a field.
 689  *    0   2   Add OFPAT_OUTPUT action to output to port from specified field.
 690  *   All other combinations are undefined and not allowed.
 691  *
 692  * The flow_mod_spec header is followed by a source specification and a
 693  * destination specification.  The format and meaning of the source
 694  * specification depends on 'src':
 695  *
 696  *   - If 'src' is 0, the source bits are taken from a field in the flow to
 697  *     which this action is attached.  (This should be a wildcarded field.  If
 698  *     its value is fully specified then the source bits being copied have
 699  *     constant values.)
 700  *
 701  *     The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
 702  *     'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
 703  *     offset within that field.  The source bits are field[ofs:ofs+n_bits-1].
 704  *     'field' and 'ofs' are subject to the same restrictions as the source
 705  *     field in NXAST_REG_MOVE.
 706  *
 707  *   - If 'src' is 1, the source bits are a constant value.  The source
 708  *     specification is (n_bits+15)/16*2 bytes long.  Taking those bytes as a
 709  *     number in network order, the source bits are the 'n_bits'
 710  *     least-significant bits.  The switch will report an error if other bits
 711  *     in the constant are nonzero.
 712  *
 713  * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
 714  * ovs_be32 'field' and an ovs_be16 'ofs'.  'field' is an nxm_header with
 715  * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field.  The
 716  * meaning of the flow_mod_spec depends on 'dst':
 717  *
 718  *   - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
 719  *     flow.  The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
 720  *     packet equal the source bits.  'field' may be any nxm_header with
 721  *     nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
 722  *
 723  *     Order is significant.  Earlier flow_mod_specs must satisfy any
 724  *     prerequisites for matching fields specified later, by copying constant
 725  *     values into prerequisite fields.
 726  *
 727  *     The switch will reject flow_mod_specs that do not satisfy NXM masking
 728  *     restrictions.
 729  *
 730  *   - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
 731  *     the new flow.  The new flow copies the source bits into
 732  *     field[ofs:ofs+n_bits-1].  Actions are executed in the same order as the
 733  *     flow_mod_specs.
 734  *
 735  * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
 736  * empty.  It has the following meaning:
 737  *
 738  *   - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
 739  *     The new flow outputs to the OpenFlow port specified by the source field.
 740  *     Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
 741  *     OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported.  Other special ports
 742  *     may not be used.
 743  *
 744  * Resource Management
 745  * -------------------
 746  *
 747  * A switch has a finite amount of flow table space available for learning.
 748  * When this space is exhausted, no new learning table entries will be learned
 749  * until some existing flow table entries expire.  The controller should be
 750  * prepared to handle this by flooding (which can be implemented as a
 751  * low-priority flow).
 752  *
 753  * Examples
 754  * --------
 755  *
 756  * The following examples give a prose description of the flow_mod_specs along
 757  * with informal notation for how those would be represented and a hex dump of
 758  * the bytes that would be required.
 759  *
 760  * These examples could work with various nx_action_learn parameters.  Typical
 761  * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
 762  * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
 763  *
 764  * 1. Learn input port based on the source MAC, with lookup into
 765  *    NXM_NX_REG1[16:31] by resubmit to in_port=99:
 766  *
 767  *    Match on in_port=99:
 768  *       ovs_be16(src=1, dst=0, n_bits=16),               20 10
 769  *       ovs_be16(99),                                    00 63
 770  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
 771  *
 772  *    Match Ethernet destination on Ethernet source from packet:
 773  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
 774  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
 775  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
 776  *
 777  *    Set NXM_NX_REG1[16:31] to the packet's input port:
 778  *       ovs_be16(src=0, dst=1, n_bits=16),               08 10
 779  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
 780  *       ovs_be32(NXM_NX_REG1), ovs_be16(16)              00 01 02 04 00 10
 781  *
 782  *    Given a packet that arrived on port A with Ethernet source address B,
 783  *    this would set up the flow "in_port=99, dl_dst=B,
 784  *    actions=load:A->NXM_NX_REG1[16..31]".
 785  *
 786  *    In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
 787  *    NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
 788  *    load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
 789  *
 790  * 2. Output to input port based on the source MAC and VLAN VID, with lookup
 791  *    into NXM_NX_REG1[16:31]:
 792  *
 793  *    Match on same VLAN ID as packet:
 794  *       ovs_be16(src=0, dst=0, n_bits=12),               00 0c
 795  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
 796  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
 797  *
 798  *    Match Ethernet destination on Ethernet source from packet:
 799  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
 800  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
 801  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
 802  *
 803  *    Output to the packet's input port:
 804  *       ovs_be16(src=0, dst=2, n_bits=16),               10 10
 805  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
 806  *
 807  *    Given a packet that arrived on port A with Ethernet source address B in
 808  *    VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
 809  *    actions=output:A".
 810  *
 811  *    In syntax accepted by ovs-ofctl, this action is:
 812  *    learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
 813  *    output:NXM_OF_IN_PORT[])
 814  *
 815  * 3. Here's a recipe for a very simple-minded MAC learning switch.  It uses a
 816  *    10-second MAC expiration time to make it easier to see what's going on
 817  *
 818  *      ovs-vsctl del-controller br0
 819  *      ovs-ofctl del-flows br0
 820  *      ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
 821           hard_timeout=10, NXM_OF_VLAN_TCI[0..11],             \
 822           NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],                   \
 823           output:NXM_OF_IN_PORT[]), resubmit(,1)"
 824  *      ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
 825  *
 826  *    You can then dump the MAC learning table with:
 827  *
 828  *      ovs-ofctl dump-flows br0 table=1
 829  *
 830  * Usage Advice
 831  * ------------
 832  *
 833  * For best performance, segregate learned flows into a table that is not used
 834  * for any other flows except possibly for a lowest-priority "catch-all" flow
 835  * (a flow with no match criteria).  If different learning actions specify
 836  * different match criteria, use different tables for the learned flows.
 837  *
 838  * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
 839  * These timeouts apply to the flow that is added, which means that a flow with
 840  * an idle timeout will expire when no traffic has been sent *to* the learned
 841  * address.  This is not usually the intent in MAC learning; instead, we want
 842  * the MAC learn entry to expire when no traffic has been sent *from* the
 843  * learned address.  Use a hard timeout for that.
 844  */
 845 struct nx_action_learn {
 846     ovs_be16 type;              /* OFPAT_VENDOR. */
 847     ovs_be16 len;               /* At least 24. */
 848     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 849     ovs_be16 subtype;           /* NXAST_LEARN. */
 850     ovs_be16 idle_timeout;      /* Idle time before discarding (seconds). */
 851     ovs_be16 hard_timeout;      /* Max time before discarding (seconds). */
 852     ovs_be16 priority;          /* Priority level of flow entry. */
 853     ovs_be64 cookie;            /* Cookie for new flow. */
 854     ovs_be16 flags;             /* Either 0 or OFPFF_SEND_FLOW_REM. */
 855     uint8_t table_id;           /* Table to insert flow entry. */
 856     uint8_t pad[5];             /* Must be zero. */
 857     /* Followed by a sequence of flow_mod_spec elements, as described above,
 858      * until the end of the action is reached. */
 859 };
 860 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
 861
 862 #define NX_LEARN_N_BITS_MASK    0x3ff
 863
 864 #define NX_LEARN_SRC_FIELD     (0 << 13) /* Copy from field. */
 865 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
 866 #define NX_LEARN_SRC_MASK      (1 << 13)
 867
 868 #define NX_LEARN_DST_MATCH     (0 << 11) /* Add match criterion. */
 869 #define NX_LEARN_DST_LOAD      (1 << 11) /* Add NXAST_REG_LOAD action. */
 870 #define NX_LEARN_DST_OUTPUT    (2 << 11) /* Add OFPAT_OUTPUT action. */
 871 #define NX_LEARN_DST_RESERVED  (3 << 11) /* Not yet defined. */
 872 #define NX_LEARN_DST_MASK      (3 << 11)
 873 \f
 874 /* Action structure for NXAST_AUTOPATH.
 875  *
 876  * This action performs the following steps in sequence:
 877  *
 878  *    1. Hashes the flow using an implementation-defined hash function.
 879  *
 880  *       The hashed fields' values are drawn from the current state of the
 881  *       flow, including all modifications that have been made by actions up to
 882  *       this point.
 883  *
 884  *    2. Selects an OpenFlow 'port'.
 885  *
 886  *       'port' is selected in an implementation-defined manner, taking into
 887  *       account 'id' and the hash value calculated in step 1.
 888  *
 889  *       Generally a switch will have been configured with a set of ports that
 890  *       may be chosen given 'id'.  The switch may take into account any number
 891  *       of factors when choosing 'port' from its configured set.  Factors may
 892  *       include carrier, load, and the results of configuration protocols such
 893  *       as LACP.
 894  *
 895  *    3. Stores 'port' in dst[ofs:ofs+n_bits].
 896  *
 897  *       The format and semantics of 'dst' and 'ofs_nbits' are similar to those
 898  *       for the NXAST_REG_LOAD action.
 899  *
 900  * The switch will reject actions in which ofs+n_bits is greater than the width
 901  * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
 902  */
 903 struct nx_action_autopath {
 904     ovs_be16 type;              /* OFPAT_VENDOR. */
 905     ovs_be16 len;               /* Length is 20. */
 906     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 907     ovs_be16 subtype;           /* NXAST_AUTOPATH. */
 908
 909     /* Where to store the result. */
 910     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
 911     ovs_be32 dst;               /* Destination. */
 912
 913     ovs_be32 id;                /* Autopath ID. */
 914     ovs_be32 pad;
 915 };
 916 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
 917 \f
 918 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
 919  *
 920  * The bundle actions choose a slave from a supplied list of options.
 921  * NXAST_BUNDLE outputs to its selection.  NXAST_BUNDLE_LOAD writes its
 922  * selection to a register.
 923  *
 924  * The list of possible slaves follows the nx_action_bundle structure. The size
 925  * of each slave is governed by its type as indicated by the 'slave_type'
 926  * parameter. The list of slaves should be padded at its end with zeros to make
 927  * the total length of the action a multiple of 8.
 928  *
 929  * Switches infer from the 'slave_type' parameter the size of each slave.  All
 930  * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
 931  * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
 932  * 2 byte width.  Switches should reject actions which indicate unknown or
 933  * unsupported slave types.
 934  *
 935  * Switches use a strategy dictated by the 'algorithm' parameter to choose a
 936  * slave.  If the switch does not support the specified 'algorithm' parameter,
 937  * it should reject the action.
 938  *
 939  * Several algorithms take into account liveness when selecting slaves.  The
 940  * liveness of a slave is implementation defined (with one exception), but will
 941  * generally take into account things like its carrier status and the results
 942  * of any link monitoring protocols which happen to be running on it.  In order
 943  * to give controllers a place-holder value, the OFPP_NONE port is always
 944  * considered live.
 945  *
 946  * Some slave selection strategies require the use of a hash function, in which
 947  * case the 'fields' and 'basis' parameters should be populated.  The 'fields'
 948  * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
 949  * hash.  Refer to the definition of "enum nx_hash_fields" for details.  The
 950  * 'basis' parameter is used as a universal hash parameter.  Different values
 951  * of 'basis' yield different hash results.
 952  *
 953  * The 'zero' parameter at the end of the action structure is reserved for
 954  * future use.  Switches are required to reject actions which have nonzero
 955  * bytes in the 'zero' field.
 956  *
 957  * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed.  Switches
 958  * should reject actions which have nonzero bytes in either of these fields.
 959  *
 960  * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
 961  * dst[ofs:ofs+n_bits].  The format and semantics of 'dst' and 'ofs_nbits' are
 962  * similar to those for the NXAST_REG_LOAD action. */
 963 struct nx_action_bundle {
 964     ovs_be16 type;              /* OFPAT_VENDOR. */
 965     ovs_be16 len;               /* Length including slaves. */
 966     ovs_be32 vendor;            /* NX_VENDOR_ID. */
 967     ovs_be16 subtype;           /* NXAST_BUNDLE. */
 968
 969     /* Slave choice algorithm to apply to hash value. */
 970     ovs_be16 algorithm;         /* One of NX_BD_ALG_*. */
 971
 972     /* What fields to hash and how. */
 973     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
 974     ovs_be16 basis;             /* Universal hash parameter. */
 975
 976     ovs_be32 slave_type;        /* NXM_OF_IN_PORT. */
 977     ovs_be16 n_slaves;          /* Number of slaves. */
 978
 979     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
 980     ovs_be32 dst;               /* Destination. */
 981
 982     uint8_t zero[4];            /* Reserved. Must be zero. */
 983 };
 984 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
 985
 986 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
 987  *
 988  * In the descriptions below, 'slaves' is the list of possible slaves in the
 989  * order they appear in the OpenFlow action. */
 990 enum nx_bd_algorithm {
 991     /* Chooses the first live slave listed in the bundle.
 992      *
 993      * O(n_slaves) performance. */
 994     NX_BD_ALG_ACTIVE_BACKUP,
 995
 996     /* for i in [0,n_slaves):
 997      *   weights[i] = hash(flow, i)
 998      * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
 999      *
1000      * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1001      * O(n_slaves) performance.
1002      *
1003      * Uses the 'fields' and 'basis' parameters. */
1004     NX_BD_ALG_HRW /* Highest Random Weight. */
1005 };
1006 \f
1007 /* Action structure for NXAST_OUTPUT_REG.
1008  *
1009  * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1010  *
1011  * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1012  * the NXAST_REG_LOAD action.
1013  *
1014  * The acceptable nxm_header values for 'src' are the same as the acceptable
1015  * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1016  *
1017  * The 'max_len' field indicates the number of bytes to send when the chosen
1018  * port is OFPP_CONTROLLER.  Its semantics are equivalent to the 'max_len'
1019  * field of OFPAT_OUTPUT.
1020  *
1021  * The 'zero' field is required to be zeroed for forward compatibility. */
1022 struct nx_action_output_reg {
1023     ovs_be16 type;              /* OFPAT_VENDOR. */
1024     ovs_be16 len;               /* 24. */
1025     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1026     ovs_be16 subtype;           /* NXAST_OUTPUT_REG. */
1027
1028     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1029     ovs_be32 src;               /* Source. */
1030
1031     ovs_be16 max_len;           /* Max length to send to controller. */
1032
1033     uint8_t zero[6];            /* Reserved, must be zero. */
1034 };
1035 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1036 \f
1037 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1038  *
1039  * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches.  This
1040  * structure is fixed-length and hence difficult to extend.  This section
1041  * describes a more flexible, variable-length flow match, called "nx_match" for
1042  * short, that is also supported by Open vSwitch.  This section also defines a
1043  * replacement for each OpenFlow message that includes struct ofp_match.
1044  *
1045  *
1046  * Format
1047  * ======
1048  *
1049  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1050  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1051  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
1052  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1053  * "body".
1054  *
1055  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1056  *
1057  * |<-------------------- nxm_type ------------------>|
1058  * |                                                  |
1059  * |31                              16 15            9| 8 7                0
1060  * +----------------------------------+---------------+--+------------------+
1061  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
1062  * +----------------------------------+---------------+--+------------------+
1063  *
1064  * The most-significant 23 bits of the header are collectively "nxm_type".
1065  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
1066  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
1067  * designates a protocol header, such as the Ethernet type, but it can also
1068  * refer to packet metadata, such as the switch port on which a packet arrived.
1069  *
1070  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
1071  * of this bit is explained later.
1072  *
1073  * The least-significant 8 bits are "nxm_length", a positive integer.  The
1074  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1075  * bytes.
1076  *
1077  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1078  * constant.  It is included only to allow software to minimally parse
1079  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
1080  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1081  *
1082  *
1083  * Semantics
1084  * =========
1085  *
1086  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1087  *
1088  * An nxm_entry places a constraint on the packets matched by the nx_match:
1089  *
1090  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1091  *     field, called "nxm_value".  The nx_match matches only packets in which
1092  *     the field equals nxm_value.
1093  *
1094  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1095  *     field (nxm_value), followed by a bitmask of the same length as the
1096  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
1097  *     nx_match matches only packets for which bit J in the given field's value
1098  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
1099  *     corresponding bits in nxm_value and the field's value to be ignored.
1100  *     (The sense of the nxm_mask bits is the opposite of that used by the
1101  *     "wildcards" member of struct ofp_match.)
1102  *
1103  *     When nxm_hasmask is 1, nxm_length is always even.
1104  *
1105  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1106  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
1107  *     nxm_hasmask.
1108  *
1109  * When there are multiple "nxm_entry"s, all of the constraints must be met.
1110  *
1111  *
1112  * Mask Restrictions
1113  * =================
1114  *
1115  * Masks may be restricted:
1116  *
1117  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1118  *     must always be 0 when these fields are specified.  For example, the
1119  *     field that identifies the port on which a packet was received may not be
1120  *     masked.
1121  *
1122  *   - Some nxm_types that do support masked wildcards may only support certain
1123  *     nxm_mask patterns.  For example, fields that have IPv4 address values
1124  *     may be restricted to CIDR masks.
1125  *
1126  * These restrictions should be noted in specifications for individual fields.
1127  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1128  * disallows, if the switch correctly implements support for that nxm_hasmask
1129  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
1130  * contains a nxm_hasmask or nxm_mask value that it does not support.
1131  *
1132  *
1133  * Prerequisite Restrictions
1134  * =========================
1135  *
1136  * The presence of an nxm_entry with a given nxm_type may be restricted based
1137  * on the presence of or values of other "nxm_entry"s.  For example:
1138  *
1139  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1140  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1141  *     and nxm_value=0x0800.  That is, matching on the IP source address is
1142  *     allowed only if the Ethernet type is explicitly set to IP.
1143  *
1144  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1145  *     preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1146  *     nxm_value either 0x0800 or 0x86dd, and another with
1147  *     nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1148  *     That is, matching on the TCP source port is allowed only if the Ethernet
1149  *     type is IP or IPv6 and the IP protocol is TCP.
1150  *
1151  * These restrictions should be noted in specifications for individual fields.
1152  * A switch may implement relaxed versions of these restrictions.  A switch
1153  * must reject an attempt to set up a flow that violates its restrictions.
1154  *
1155  *
1156  * Ordering Restrictions
1157  * =====================
1158  *
1159  * An nxm_entry that has prerequisite restrictions must appear after the
1160  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
1161  * nx_match is not otherwise constrained.
1162  *
1163  * Any given nxm_type may appear in an nx_match at most once.
1164  *
1165  *
1166  * nxm_entry Examples
1167  * ==================
1168  *
1169  * These examples show the format of a single nxm_entry with particular
1170  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
1171  * numbers and byte indexes.
1172  *
1173  *
1174  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1175  *
1176  *  0          3  4   5
1177  * +------------+---+---+
1178  * |   header   | v | m |
1179  * +------------+---+---+
1180  *
1181  *
1182  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1183  *
1184  *  0          3 4    5
1185  * +------------+------+
1186  * |   header   | value|
1187  * +------------+------+
1188  *
1189  *
1190  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1191  *
1192  *  0          3 4           7
1193  * +------------+-------------+
1194  * |   header   |  nxm_value  |
1195  * +------------+-------------+
1196  *
1197  *
1198  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1199  *
1200  *  0          3 4                9
1201  * +------------+------------------+
1202  * |   header   |     nxm_value    |
1203  * +------------+------------------+
1204  *
1205  *
1206  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1207  *
1208  *  0          3 4                9 10              15
1209  * +------------+------------------+------------------+
1210  * |   header   |     nxm_value    |      nxm_mask    |
1211  * +------------+------------------+------------------+
1212  *
1213  *
1214  * Error Reporting
1215  * ===============
1216  *
1217  * A switch should report an error in an nx_match using error type
1218  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
1219  * should report a specific error code, if one is assigned for the particular
1220  * problem, but NXBRC_NXM_INVALID is also available to report a generic
1221  * nx_match error.
1222  */
1223
1224 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1225     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1226 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1227     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1228 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1229     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1230 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1231 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1232 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1233 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1234 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1235
1236 #define NXM_MAKE_WILD_HEADER(HEADER) \
1237         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1238
1239 /* ## ------------------------------- ## */
1240 /* ## OpenFlow 1.0-compatible fields. ## */
1241 /* ## ------------------------------- ## */
1242
1243 /* Physical or virtual port on which the packet was received.
1244  *
1245  * Prereqs: None.
1246  *
1247  * Format: 16-bit integer in network byte order.
1248  *
1249  * Masking: Not maskable. */
1250 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
1251
1252 /* Source or destination address in Ethernet header.
1253  *
1254  * Prereqs: None.
1255  *
1256  * Format: 48-bit Ethernet MAC address.
1257  *
1258  * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1259  *   be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1260  *   are all-0-bits or all-1-bits).  Support for other patterns and for masking
1261  *   of NXM_OF_ETH_SRC is optional. */
1262 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
1263 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
1264 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
1265
1266 /* Packet's Ethernet type.
1267  *
1268  * For an Ethernet II packet this is taken from the Ethernet header.  For an
1269  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1270  * A packet that has neither format has value 0x05ff
1271  * (OFP_DL_TYPE_NOT_ETH_TYPE).
1272  *
1273  * For a packet with an 802.1Q header, this is the type of the encapsulated
1274  * frame.
1275  *
1276  * Prereqs: None.
1277  *
1278  * Format: 16-bit integer in network byte order.
1279  *
1280  * Masking: Not maskable. */
1281 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
1282
1283 /* 802.1Q TCI.
1284  *
1285  * For a packet with an 802.1Q header, this is the Tag Control Information
1286  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
1287  * header, this has value 0.
1288  *
1289  * Prereqs: None.
1290  *
1291  * Format: 16-bit integer in network byte order.
1292  *
1293  * Masking: Arbitrary masks.
1294  *
1295  * This field can be used in various ways:
1296  *
1297  *   - If it is not constrained at all, the nx_match matches packets without
1298  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
1299  *
1300  *   - Testing for an exact match with 0 matches only packets without an
1301  *     802.1Q header.
1302  *
1303  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
1304  *     that have an 802.1Q header with a specified VID and PCP.
1305  *
1306  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
1307  *     not make sense.  The switch may reject this combination.
1308  *
1309  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1310  *     packets that have an 802.1Q header with that VID (and any PCP).
1311  *
1312  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1313  *     packets that have an 802.1Q header with that PCP (and any VID).
1314  *
1315  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1316  *     header or with an 802.1Q header with a VID of 0.
1317  *
1318  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1319  *     header or with an 802.1Q header with a PCP of 0.
1320  *
1321  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1322  *     header or with an 802.1Q header with both VID and PCP of 0.
1323  */
1324 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
1325 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
1326
1327 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1328  *
1329  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1330  *
1331  * Format: 8-bit integer with 2 least-significant bits forced to 0.
1332  *
1333  * Masking: Not maskable. */
1334 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
1335
1336 /* The "protocol" byte in the IP header.
1337  *
1338  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1339  *
1340  * Format: 8-bit integer.
1341  *
1342  * Masking: Not maskable. */
1343 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
1344
1345 /* The source or destination address in the IP header.
1346  *
1347  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1348  *
1349  * Format: 32-bit integer in network byte order.
1350  *
1351  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1352  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1353 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
1354 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
1355 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
1356 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
1357
1358 /* The source or destination port in the TCP header.
1359  *
1360  * Prereqs:
1361  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1362  *   NXM_OF_IP_PROTO must match 6 exactly.
1363  *
1364  * Format: 16-bit integer in network byte order.
1365  *
1366  * Masking: Not maskable. */
1367 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
1368 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
1369
1370 /* The source or destination port in the UDP header.
1371  *
1372  * Prereqs:
1373  *   NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1374  *   NXM_OF_IP_PROTO must match 17 exactly.
1375  *
1376  * Format: 16-bit integer in network byte order.
1377  *
1378  * Masking: Not maskable. */
1379 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
1380 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
1381
1382 /* The type or code in the ICMP header.
1383  *
1384  * Prereqs:
1385  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
1386  *   NXM_OF_IP_PROTO must match 1 exactly.
1387  *
1388  * Format: 8-bit integer.
1389  *
1390  * Masking: Not maskable. */
1391 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
1392 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
1393
1394 /* ARP opcode.
1395  *
1396  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1397  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1398  * matching.
1399  *
1400  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1401  *
1402  * Format: 16-bit integer in network byte order.
1403  *
1404  * Masking: Not maskable. */
1405 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
1406
1407 /* For an Ethernet+IP ARP packet, the source or target protocol address
1408  * in the ARP header.  Always 0 otherwise.
1409  *
1410  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1411  *
1412  * Format: 32-bit integer in network byte order.
1413  *
1414  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1415  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1416 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
1417 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
1418 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
1419 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
1420
1421 /* ## ------------------------ ## */
1422 /* ## Nicira match extensions. ## */
1423 /* ## ------------------------ ## */
1424
1425 /* Metadata registers.
1426  *
1427  * Registers initially have value 0.  Actions allow register values to be
1428  * manipulated.
1429  *
1430  * Prereqs: None.
1431  *
1432  * Format: Array of 32-bit integer registers.  Space is reserved for up to
1433  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
1434  *
1435  * Masking: Arbitrary masks. */
1436 #define NXM_NX_MAX_REGS 16
1437 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
1438 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1439 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1440 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1441 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1442 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
1443 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
1444 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
1445 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
1446 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
1447 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
1448 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
1449 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
1450 #define NXM_NX_REG4       NXM_HEADER  (0x0001, 4, 4)
1451 #define NXM_NX_REG4_W     NXM_HEADER_W(0x0001, 4, 4)
1452
1453 /* Tunnel ID.
1454  *
1455  * For a packet received via GRE tunnel including a (32-bit) key, the key is
1456  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
1457  * the value is 0.
1458  *
1459  * Prereqs: None.
1460  *
1461  * Format: 64-bit integer in network byte order.
1462  *
1463  * Masking: Arbitrary masks. */
1464 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
1465 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
1466
1467 /* For an Ethernet+IP ARP packet, the source or target hardware address
1468  * in the ARP header.  Always 0 otherwise.
1469  *
1470  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1471  *
1472  * Format: 48-bit Ethernet MAC address.
1473  *
1474  * Masking: Not maskable. */
1475 #define NXM_NX_ARP_SHA    NXM_HEADER  (0x0001, 17, 6)
1476 #define NXM_NX_ARP_THA    NXM_HEADER  (0x0001, 18, 6)
1477
1478 /* The source or destination address in the IPv6 header.
1479  *
1480  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1481  *
1482  * Format: 128-bit IPv6 address.
1483  *
1484  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1485  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1486 #define NXM_NX_IPV6_SRC    NXM_HEADER  (0x0001, 19, 16)
1487 #define NXM_NX_IPV6_SRC_W  NXM_HEADER_W(0x0001, 19, 16)
1488 #define NXM_NX_IPV6_DST    NXM_HEADER  (0x0001, 20, 16)
1489 #define NXM_NX_IPV6_DST_W  NXM_HEADER_W(0x0001, 20, 16)
1490
1491 /* The type or code in the ICMPv6 header.
1492  *
1493  * Prereqs:
1494  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1495  *   NXM_OF_IP_PROTO must match 58 exactly.
1496  *
1497  * Format: 8-bit integer.
1498  *
1499  * Masking: Not maskable. */
1500 #define NXM_NX_ICMPV6_TYPE NXM_HEADER  (0x0001, 21, 1)
1501 #define NXM_NX_ICMPV6_CODE NXM_HEADER  (0x0001, 22, 1)
1502
1503 /* The target address in an IPv6 Neighbor Discovery message.
1504  *
1505  * Prereqs:
1506  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1507  *   NXM_OF_IP_PROTO must match 58 exactly.
1508  *   NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1509  *
1510  * Format: 128-bit IPv6 address.
1511  *
1512  * Masking: Not maskable. */
1513 #define NXM_NX_ND_TARGET   NXM_HEADER  (0x0001, 23, 16)
1514
1515 /* The source link-layer address option in an IPv6 Neighbor Discovery
1516  * message.
1517  *
1518  * Prereqs:
1519  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1520  *   NXM_OF_IP_PROTO must match 58 exactly.
1521  *   NXM_OF_ICMPV6_TYPE must be exactly 135.
1522  *
1523  * Format: 48-bit Ethernet MAC address.
1524  *
1525  * Masking: Not maskable. */
1526 #define NXM_NX_ND_SLL      NXM_HEADER  (0x0001, 24, 6)
1527
1528 /* The target link-layer address option in an IPv6 Neighbor Discovery
1529  * message.
1530  *
1531  * Prereqs:
1532  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1533  *   NXM_OF_IP_PROTO must match 58 exactly.
1534  *   NXM_OF_ICMPV6_TYPE must be exactly 136.
1535  *
1536  * Format: 48-bit Ethernet MAC address.
1537  *
1538  * Masking: Not maskable. */
1539 #define NXM_NX_ND_TLL      NXM_HEADER  (0x0001, 25, 6)
1540
1541 /* IP fragment information.
1542  *
1543  * Prereqs:
1544  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1545  *
1546  * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1547  *
1548  * Masking: Fully maskable.
1549  *
1550  * This field has three possible values:
1551  *
1552  *   - A packet that is not an IP fragment has value 0.
1553  *
1554  *   - A packet that is an IP fragment with offset 0 (the first fragment) has
1555  *     bit 0 set and thus value 1.
1556  *
1557  *   - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1558  *     and thus value 3.
1559  *
1560  * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1561  * the meanings of bits 0 and 1.
1562  *
1563  * The switch may reject matches against values that can never appear.
1564  *
1565  * It is important to understand how this field interacts with the OpenFlow IP
1566  * fragment handling mode:
1567  *
1568  *   - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1569  *     before they reach the flow table, so every packet that is available for
1570  *     matching will have value 0 in this field.
1571  *
1572  *   - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1573  *     IP fragments would be reassembled before they reached the flow table and
1574  *     again every packet available for matching would always have value 0.
1575  *
1576  *   - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1577  *     1.0 says that fragments' transport ports are always 0, even for the
1578  *     first fragment, so this does not provide much extra information.
1579  *
1580  *   - In OFPC_FRAG_NX_MATCH mode, all three values are possible.  For
1581  *     fragments with offset 0, Open vSwitch makes L4 header information
1582  *     available.
1583  */
1584 #define NXM_NX_IP_FRAG     NXM_HEADER  (0x0001, 26, 1)
1585 #define NXM_NX_IP_FRAG_W   NXM_HEADER_W(0x0001, 26, 1)
1586
1587 /* Bits in the value of NXM_NX_IP_FRAG. */
1588 #define NX_IP_FRAG_ANY   (1 << 0) /* Is this a fragment? */
1589 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1590
1591 /* ## --------------------- ## */
1592 /* ## Requests and replies. ## */
1593 /* ## --------------------- ## */
1594
1595 enum nx_flow_format {
1596     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
1597     NXFF_NXM = 2                 /* Nicira extended match. */
1598 };
1599
1600 /* NXT_SET_FLOW_FORMAT request. */
1601 struct nxt_set_flow_format {
1602     struct ofp_header header;
1603     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1604     ovs_be32 subtype;           /* NXT_SET_FLOW_FORMAT. */
1605     ovs_be32 format;            /* One of NXFF_*. */
1606 };
1607 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1608
1609 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1610 struct nx_flow_mod {
1611     struct nicira_header nxh;
1612     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
1613     ovs_be16 command;             /* One of OFPFC_*. */
1614     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
1615     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
1616     ovs_be16 priority;            /* Priority level of flow entry. */
1617     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
1618                                      Not meaningful for OFPFC_DELETE*. */
1619     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
1620                                      matching entries to include this as an
1621                                      output port.  A value of OFPP_NONE
1622                                      indicates no restriction. */
1623     ovs_be16 flags;               /* One of OFPFF_*. */
1624     ovs_be16 match_len;           /* Size of nx_match. */
1625     uint8_t pad[6];               /* Align to 64-bits. */
1626     /* Followed by:
1627      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1628      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1629      *     all-zero bytes, then
1630      *   - Actions to fill out the remainder of the message length (always a
1631      *     multiple of 8).
1632      */
1633 };
1634 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1635
1636 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1637 struct nx_flow_removed {
1638     struct nicira_header nxh;
1639     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1640     ovs_be16 priority;        /* Priority level of flow entry. */
1641     uint8_t reason;           /* One of OFPRR_*. */
1642     uint8_t pad[1];           /* Align to 32-bits. */
1643     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
1644     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
1645                                  duration_sec. */
1646     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
1647     ovs_be16 match_len;       /* Size of nx_match. */
1648     ovs_be64 packet_count;
1649     ovs_be64 byte_count;
1650     /* Followed by:
1651      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1652      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1653      *     all-zero bytes. */
1654 };
1655 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1656
1657 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1658  * request). */
1659 struct nx_flow_stats_request {
1660     struct nicira_stats_msg nsm;
1661     ovs_be16 out_port;        /* Require matching entries to include this
1662                                  as an output port.  A value of OFPP_NONE
1663                                  indicates no restriction. */
1664     ovs_be16 match_len;       /* Length of nx_match. */
1665     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1666                                  or 0xff for all tables. */
1667     uint8_t pad[3];           /* Align to 64 bits. */
1668     /* Followed by:
1669      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1670      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1671      *     all-zero bytes, which must also exactly fill out the length of the
1672      *     message.
1673      */
1674 };
1675 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1676
1677 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1678  * OFPST_FLOW reply). */
1679 struct nx_flow_stats {
1680     ovs_be16 length;          /* Length of this entry. */
1681     uint8_t table_id;         /* ID of table flow came from. */
1682     uint8_t pad;
1683     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1684     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1685                                  beyond duration_sec. */
1686     ovs_be16 priority;        /* Priority of the entry. Only meaningful
1687                                  when this is not an exact-match entry. */
1688     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1689     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1690     ovs_be16 match_len;       /* Length of nx_match. */
1691     uint8_t pad2[4];          /* Align to 64 bits. */
1692     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1693     ovs_be64 packet_count;    /* Number of packets, UINT64_MAX if unknown. */
1694     ovs_be64 byte_count;      /* Number of bytes, UINT64_MAX if unknown. */
1695     /* Followed by:
1696      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1697      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1698      *     all-zero bytes, then
1699      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1700      *     of 8).
1701      */
1702 };
1703 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1704
1705 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1706  * OFPST_AGGREGATE request). */
1707 struct nx_aggregate_stats_request {
1708     struct nicira_stats_msg nsm;
1709     ovs_be16 out_port;        /* Require matching entries to include this
1710                                  as an output port.  A value of OFPP_NONE
1711                                  indicates no restriction. */
1712     ovs_be16 match_len;       /* Length of nx_match. */
1713     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1714                                  or 0xff for all tables. */
1715     uint8_t pad[3];           /* Align to 64 bits. */
1716     /* Followed by:
1717      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1718      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1719      *     all-zero bytes, which must also exactly fill out the length of the
1720      *     message.
1721      */
1722 };
1723 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1724
1725 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1726  * OFPST_AGGREGATE reply). */
1727 struct nx_aggregate_stats_reply {
1728     struct nicira_stats_msg nsm;
1729     ovs_be64 packet_count;     /* Number of packets, UINT64_MAX if unknown. */
1730     ovs_be64 byte_count;       /* Number of bytes, UINT64_MAX if unknown. */
1731     ovs_be32 flow_count;       /* Number of flows. */
1732     uint8_t pad[4];            /* Align to 64 bits. */
1733 };
1734 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1735
1736 #endif /* openflow/nicira-ext.h */