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