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