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